feat: allow deleting contacts by identifier (#12)

This PR makes it possible to delete contacts by identifier which is less error prone than by predicate when you want to delete a single contact.

Author: KishanBagaria

README.md

@@ -180,13 +180,14 @@ const success = contacts.addNewContact({
 console.log(`New contact was ${success ? 'saved' : 'not saved'}.`)
 ```
 
-### `contacts.deleteContact(name)`
+### `contacts.deleteContact({ identifier, name })`
 
-* `name` String (required) - The first, middle, last, or full name of a contact.
+* `identifier` String (optional) - The contact's unique identifier.
+* `name` String (optional) - The first, middle, last, or full name of a contact.
 
 Returns `Boolean` - whether the contact was deleted successfully.
 
-Deletes a contact to the user's contacts database.
+Deletes a contact from 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.

contacts.mm

@@ -324,6 +324,22 @@ CNAuthorizationStatus AuthStatus() {
                                               error:nil];
 }
 
+// Returns all contacts in the CNContactStore matching an identifier
+NSArray *FindContactsWithIdentifier(const std::string &identifier_string, Napi::Array extra_keys) {
+  CNContactStore *addressBook = [[CNContactStore alloc] init];
+
+  NSString *identifier = [NSString stringWithUTF8String:identifier_string.c_str()];
+
+  NSArray *identifiers = @[identifier];
+
+  NSPredicate *predicate = [CNContact predicateForContactsWithIdentifiers:identifiers];
+
+  return
+      [addressBook unifiedContactsMatchingPredicate:predicate
+                                        keysToFetch:GetContactKeys(extra_keys)
+                                              error:nil];
+}
+
 // Creates a new CNContact in order to update, delete, or add it to the
 // CNContactStore.
 CNMutableContact *CreateCNMutableContact(Napi::Object contact_data) {
@@ -472,8 +488,20 @@ CNAuthorizationStatus AuthStatus() {
   if (AuthStatus() != CNAuthorizationStatusAuthorized)
     return Napi::Boolean::New(env, false);
 
-  const std::string name_string = info[0].As<Napi::String>().Utf8Value();
-  NSArray *cncontacts = FindContacts(name_string, Napi::Array::New(env));
+  Napi::Object contact_data = info[0].As<Napi::Object>();
+
+  NSArray *cncontacts;
+  if (contact_data.Has("identifier")) {
+    const std::string identifier =
+        contact_data.Get("identifier").As<Napi::String>().Utf8Value();
+    cncontacts = FindContactsWithIdentifier(identifier, Napi::Array::New(env));
+  } else if (contact_data.Has("name")) {
+    const std::string name_string =
+        contact_data.Get("name").As<Napi::String>().Utf8Value();
+    cncontacts = FindContacts(name_string, Napi::Array::New(env));
+  } else {
+    return Napi::Boolean::New(env, false);
+  }
 
   CNContact *contact = (CNContact *)[cncontacts objectAtIndex:0];
   CNSaveRequest *request = [[CNSaveRequest alloc] init];

index.js

@@ -150,12 +150,23 @@ function updateContact(contact) {
   return contacts.updateContact.call(this, contact)
 }
 
-function deleteContact(name) {
-  if (typeof name !== 'string') {
+function deleteContact(contact) {
+  if (!contact || Object.keys(contact).length === 0) {
+    throw new TypeError('contact must be a non-empty object')
+  }
+
+  const hasIdentifier = contact.hasOwnProperty('identifier')
+  const hasName = contact.hasOwnProperty('name')
+
+  if (hasIdentifier && typeof contact.identifier !== 'string') {
+    throw new TypeError('identifier must be a string')
+  }
+
+  if (hasName && typeof contact.name !== 'string') {
     throw new TypeError('name must be a string')
   }
 
-  return contacts.deleteContact.call(this, name)
+  return contacts.deleteContact.call(this, contact)
 }
 
 module.exports = {

test/module.spec.js

@@ -150,12 +150,17 @@ describe('node-mac-contacts', () => {
     })
   })
 
-  describe('deleteContact(name)', () => {
+  describe('deleteContact({ name, identifier })', () => {
     it('should throw if name is not a string', () => {
       expect(() => {
-        deleteContact(12345)
+        deleteContact({ name: 12345 })
       }).to.throw(/name must be a string/)
     })
+    it('should throw if identifier is not a string', () => {
+      expect(() => {
+        deleteContact({ identifier: 12345 })
+      }).to.throw(/identifier must be a string/)
+    })
   })
 
   describe('updateContact(contact)', () => {