feat: implement deleteContactByName(name)

Author: codebytere

README.md

@@ -125,3 +125,23 @@ console.log(`New contact was ${success ? 'saved' : 'not saved'}.`)
 ```
 
 This method will return `false` if access to Contacts has not been granted.
+
+### contacts.deleteContactByName(name)
+
+* `name` String (required) - The first, last, or full name of a contact.
+
+Returns `Boolean` - whether the contact was deleted successfully.
+
+Deletes a contact to the user's contacts database.
+
+If a contact's full name is 'Shelley Vohr', I could pass 'Shelley', 'Vohr', or 'Shelley Vohr' as `name`.
+However, you should take care to specify `name` to such a degree that you can be confident the first contact to be returned from a predicate search is the contact you intend to delete.
+
+```js
+const name = 'Jonathan Appleseed'
+const deleted = contacts.deleteContactByName(name)
+
+console.log(`Contact ${name} was ${deleted ? 'deleted' : 'not deleted'}.`)
+```
+
+This method will return `false` if access to Contacts has not been granted.

contacts.mm

@@ -132,6 +132,20 @@ CNAuthorizationStatus AuthStatus() {
   return [CNContactStore authorizationStatusForEntityType:entityType];
 }
 
+NSArray* GetContactKeys() {
+  NSArray *keys = @[
+    CNContactGivenNameKey,
+    CNContactFamilyNameKey,
+    CNContactPhoneNumbersKey,
+    CNContactEmailAddressesKey,
+    CNContactNicknameKey,
+    CNContactPostalAddressesKey,
+    CNContactBirthdayKey
+  ];
+
+  return keys;
+}
+
 /***** EXPORTED FUNCTIONS *****/
 
 Napi::Value GetAuthStatus(const Napi::CallbackInfo &info) {
@@ -158,18 +172,10 @@ CNAuthorizationStatus AuthStatus() {
   if (AuthStatus() != CNAuthorizationStatusAuthorized)
     return contacts;
 
-  NSArray *keys = @[
-    CNContactGivenNameKey,
-    CNContactFamilyNameKey,
-    CNContactPhoneNumbersKey,
-    CNContactEmailAddressesKey,
-    CNContactNicknameKey,
-    CNContactPostalAddressesKey,
-    CNContactBirthdayKey
-  ];
-
   NSPredicate *predicate = [CNContact predicateForContactsInContainerWithIdentifier:addressBook.defaultContainerIdentifier];
-	NSArray *cncontacts = [addressBook unifiedContactsMatchingPredicate:predicate keysToFetch:keys error:nil];
+	NSArray *cncontacts = [addressBook unifiedContactsMatchingPredicate:predicate 
+                                                    keysToFetch:GetContactKeys() 
+                                                                      error:nil];
 
   int num_contacts = [cncontacts count];
   for (int i = 0; i < num_contacts; i++) {
@@ -188,22 +194,12 @@ CNAuthorizationStatus AuthStatus() {
   if (AuthStatus() != CNAuthorizationStatusAuthorized)
     return contacts;
 
-  NSArray *keys = @[
-    CNContactGivenNameKey,
-    CNContactFamilyNameKey,
-    CNContactPhoneNumbersKey,
-    CNContactEmailAddressesKey,
-    CNContactNicknameKey,
-    CNContactPostalAddressesKey,
-    CNContactBirthdayKey
-  ];
-
   std::string name_string = info[0].As<Napi::String>().Utf8Value();
   NSString *name = [NSString stringWithUTF8String:name_string.c_str()];
   NSPredicate *predicate = [CNContact predicateForContactsMatchingName:name];
 
   NSArray *cncontacts = [addressBook unifiedContactsMatchingPredicate:predicate
-                                                                keysToFetch:keys
+                                                    keysToFetch:GetContactKeys()
                                                                       error:nil];
 
   int num_contacts = [cncontacts count];
@@ -237,7 +233,7 @@ CNAuthorizationStatus AuthStatus() {
 
   if (contact_data.Has("nickname")) {
     std::string nick_name = contact_data.Get("nickname").As<Napi::String>().Utf8Value();
-    [contact setFamilyName:[NSString stringWithUTF8String:nick_name.c_str()]];
+    [contact setNickname:[NSString stringWithUTF8String:nick_name.c_str()]];
   }
 
   if (contact_data.Has("birthday")) {
@@ -265,6 +261,33 @@ CNAuthorizationStatus AuthStatus() {
   return Napi::Boolean::New(env, success);
 }
 
+Napi::Value DeleteContactByName(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+  CNContactStore *addressBook = [[CNContactStore alloc] init];
+
+  if (AuthStatus() != CNAuthorizationStatusAuthorized)
+    return Napi::Boolean::New(env, false);
+
+  std::string name_string = info[0].As<Napi::String>().Utf8Value();
+  NSString *name = [NSString stringWithUTF8String:name_string.c_str()];
+  NSPredicate *predicate = [CNContact predicateForContactsMatchingName:name];
+
+  NSArray *cncontacts = [addressBook unifiedContactsMatchingPredicate:predicate
+                                                                keysToFetch:GetContactKeys()
+                                                                      error:nil];
+  
+  // Place the burden on end-users to specify name enough that
+  // the first contact to be returned from a predicate search would
+  // be the person they want to delete
+  CNContact *contact = (CNContact*)[cncontacts objectAtIndex:0];
+  CNSaveRequest *request = [[CNSaveRequest alloc] init];
+  [request deleteContact:[contact mutableCopy]];
+  
+  bool success = [addressBook executeSaveRequest:request error:nil];
+
+  return Napi::Boolean::New(env, success);
+}
+
 Napi::Object Init(Napi::Env env, Napi::Object exports) {
   exports.Set(
     Napi::String::New(env, "getAuthStatus"), Napi::Function::New(env, GetAuthStatus)
@@ -278,6 +301,9 @@ CNAuthorizationStatus AuthStatus() {
   exports.Set(
     Napi::String::New(env, "addNewContact"), Napi::Function::New(env, AddNewContact)
   );
+  exports.Set(
+    Napi::String::New(env, "deleteContactByName"), Napi::Function::New(env, DeleteContactByName)
+  );
 
   return exports;
 }

index.js

@@ -36,9 +36,16 @@ function addNewContact(contact) {
   return contacts.addNewContact.call(this, contact)
 }
 
+function deleteContactByName(name) {
+  if (typeof name !== 'string') throw new TypeError('name must be a string')
+
+  return contacts.deleteContactByName.call(this, name)
+}
+
 module.exports = {
   getAuthStatus: contacts.getAuthStatus,
   getAllContacts: contacts.getAllContacts,
   getContactsByName,
-  addNewContact
+  addNewContact,
+  deleteContactByName
 }

package-lock.json

@@ -3,7 +3,8 @@ const {
   getAuthStatus,
   getContactsByName,
   getAllContacts,
-  addNewContact
+  addNewContact,
+  deleteContactByName
 } = require('../index')
 
 describe('node-mac-contacts', () => {
@@ -80,4 +81,12 @@ describe('node-mac-contacts', () => {
       }).to.throw(/emailAddresses must be an array/)
     })
   })
+
+  describe('deleteContactByName(name)', () => {
+    it('should throw if name is not a string', () => {
+      expect(() => {
+        deleteContactByName(12345)
+      }).to.throw(/name must be a string/)
+    })
+  })
 })