feat: add contact-changed event listener

Author: codebytere

.prettierrc

@@ -3,6 +3,5 @@
   "tabWidth": 2,
   "semi": false,
   "singleQuote": true,
-  "printWidth": 100,
   "endOfLine": "lf"
 }

README.md

@@ -22,7 +22,7 @@ In your app, you should put the reason you're requesting to manipulate user's co
 
 ## API
 
-### contacts.getAuthStatus()
+### `contacts.getAuthStatus()`
 
 Returns `String` - Can be one of 'Not Determined', 'Denied', 'Authorized', or 'Restricted'.
 
@@ -46,7 +46,7 @@ console.log(`Authorization access to contacts is: ${authStatus}`)
 */
 ```
 
-### contacts.getAllContacts([extraProperties])
+### `contacts.getAllContacts([extraProperties])`
 
 * `extraProperties` string[] (optional) - an array of extra contact properties to fetch that can be any of: `jobTitle`, `departmentName`, `organizationName`, `middleName`, `note`, `contactImage`, `contactThumbnailImage`, `instantMessageAddresses`, or `socialProfiles`.
 
@@ -94,7 +94,7 @@ console.log(allContacts[0])
 */
 ```
 
-### contacts.getContactsByName(name[, extraProperties])
+### `contacts.getContactsByName(name[, extraProperties])`
 
 * `extraProperties` string[] (optional) - an array of extra contact properties to fetch that can be any of: `jobTitle`, `departmentName`, `organizationName`, `middleName`, `note`, `contactImage`, `contactThumbnailImage`, `instantMessageAddresses`, or `socialProfiles`.
 
@@ -144,7 +144,7 @@ console.log(contacts)
 */
 ```
 
-### contacts.addNewContact(contact)
+### `contacts.addNewContact(contact)`
 
 * `contact` Object
   * `firstName` String (required) - The first name of the contact.
@@ -175,7 +175,7 @@ const success = contacts.addNewContact({
 console.log(`New contact was ${success ? 'saved' : 'not saved'}.`)
 ```
 
-### contacts.deleteContact(name)
+### `contacts.deleteContact(name)`
 
 * `name` String (required) - The first, last, or full name of a contact.
 
@@ -197,7 +197,7 @@ const deleted = contacts.deleteContact(name)
 console.log(`Contact ${name} was ${deleted ? 'deleted' : 'not deleted'}.`)
 ```
 
-### contacts.updateContact(contact)
+### `contacts.updateContact(contact)`
 
 * `contact` Object
   * `firstName` String (required) - The first name of the contact.
@@ -227,3 +227,26 @@ const updated = contacts.updateContact({
 
 console.log(`Contact was ${updated ? 'updated' : 'not updated'}.`)
 ```
+
+### `contacts.listener`
+
+This module exposes an `EventEmitter`, which can be used to listen to potential changes to the `CNContactStore`. When a contact is changed either with methods contained in this module, or manually by a user, the `contact-changed` event will be emitted.
+
+Example:
+
+```js
+const { listener, addNewContact } = require('node-mac-contacts')
+
+addNewContact({
+  firstName: 'William',
+  lastName: 'Grapeseed',
+  nickname: 'Billy',
+  birthday: '1990-09-09',
+  phoneNumbers: ['+1234567890'],
+  emailAddresses: ['billy@grapeseed.com'],
+})
+
+listener.on('contact-changed', () => {
+  console.log('A contact was changed!')
+})
+```

contacts.mm

@@ -1,6 +1,8 @@
 #import <Contacts/Contacts.h>
 #include <napi.h>
 
+Napi::ThreadSafeFunction ts_fn;
+
 /***** HELPERS *****/
 
 // Parses and returns an array of email addresses as strings.
@@ -468,7 +470,7 @@ CNAuthorizationStatus AuthStatus() {
 }
 
 // Removes a CNContact from the CNContactStore.
-Napi::Value DeleteContact(const Napi::CallbackInfo &info) {
+Napi::Boolean DeleteContact(const Napi::CallbackInfo &info) {
   Napi::Env env = info.Env();
 
   if (AuthStatus() != CNAuthorizationStatusAuthorized)
@@ -488,7 +490,7 @@ CNAuthorizationStatus AuthStatus() {
 }
 
 // Updates an existing CNContact in the CNContactStore.
-Napi::Value UpdateContact(const Napi::CallbackInfo &info) {
+Napi::Boolean UpdateContact(const Napi::CallbackInfo &info) {
   Napi::Env env = info.Env();
 
   if (AuthStatus() != CNAuthorizationStatusAuthorized)
@@ -506,8 +508,31 @@ CNAuthorizationStatus AuthStatus() {
   return Napi::Boolean::New(env, success);
 }
 
+Napi::Boolean HandleEmit(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+  ts_fn = Napi::ThreadSafeFunction::New(env, info[0].As<Napi::Function>(),
+                                        "emitCallback", 0, 1);
+
+  [[NSNotificationCenter defaultCenter]
+      addObserverForName:CNContactStoreDidChangeNotification
+                  object:nil
+                   queue:[NSOperationQueue mainQueue]
+              usingBlock:^(NSNotification *note) {
+                auto callback = [](Napi::Env env, Napi::Function js_cb,
+                                   const char *value) {
+                  js_cb.Call({Napi::String::New(env, value)});
+                };
+                ts_fn.BlockingCall("contact-changed", callback);
+                ts_fn.Release();
+              }];
+
+  return Napi::Boolean::New(env, true);
+}
+
 // Initializes all functions exposed to JS.
 Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  exports.Set(Napi::String::New(env, "handleEmit"),
+              Napi::Function::New(env, HandleEmit));
   exports.Set(Napi::String::New(env, "getAuthStatus"),
               Napi::Function::New(env, GetAuthStatus));
   exports.Set(Napi::String::New(env, "getAllContacts"),

index.js

@@ -1,5 +1,10 @@
 const contacts = require('bindings')('contacts.node')
 
+const { EventEmitter } = require('events')
+
+const listener = new EventEmitter()
+contacts.handleEmit(listener.emit.bind(listener))
+
 const validProperties = [
   'jobTitle',
   'departmentName',
@@ -19,7 +24,9 @@ function getAllContacts(extraProperties = []) {
 
   if (!extraProperties.every((p) => validProperties.includes(p))) {
     throw new TypeError(
-      `properties in extraProperties must be one of ${validProperties.join(', ')}`,
+      `properties in extraProperties must be one of ${validProperties.join(
+        ', ',
+      )}`,
     )
   }
 
@@ -37,7 +44,9 @@ function getContactsByName(name, extraProperties = []) {
 
   if (!extraProperties.every((p) => validProperties.includes(p))) {
     throw new TypeError(
-      `properties in extraProperties must be one of ${validProperties.join(', ')}`,
+      `properties in extraProperties must be one of ${validProperties.join(
+        ', ',
+      )}`,
     )
   }
 
@@ -141,6 +150,7 @@ function deleteContact(name) {
 }
 
 module.exports = {
+  listener,
   getAuthStatus: contacts.getAuthStatus,
   getAllContacts,
   getContactsByName,

test/module.spec.js

@@ -6,6 +6,7 @@ const {
   addNewContact,
   deleteContact,
   updateContact,
+  listener,
 } = require('../index')
 
 describe('node-mac-contacts', () => {
@@ -170,4 +171,21 @@ describe('node-mac-contacts', () => {
       }).to.throw(/emailAddresses must be an array/)
     })
   })
+
+  describe('listener', () => {
+    it('emits an event when the contact is changed', (done) => {
+      addNewContact({
+        firstName: 'William',
+        lastName: 'Grapeseed',
+        nickname: 'Billy',
+        birthday: '1990-09-09',
+        phoneNumbers: ['+1234567890'],
+        emailAddresses: ['billy@grapeseed.com'],
+      })
+
+      listener.once('contact-changed', () => {
+        done()
+      })
+    })
+  })
 })