feat: add instantMessageAddresses optional property

Author: codebytere

README.md

@@ -48,7 +48,7 @@ console.log(`Authorization access to contacts is: ${authStatus}`)
 
 ### 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`, or `socialProfiles`.
+* `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`.
 
 Returns `Array<Object>` - Returns an array of contact objects.
 
@@ -69,6 +69,7 @@ The returned objects will take the following format:
 * `contactImage` Buffer (optional) - a Buffer representation of the contact's profile picture.
 * `contactThumbnailImage` Buffer (optional) - a Buffer representation of The thumbnail version of the contact’s profile picture.
 * `socialProfiles` Object[] (optional) - An array of labeled social profiles for a contact.
+* `instantMessageAddresses` Object[]  (optional) - An array of labeled IM addresses for the contact.
 
 This method will return an empty array (`[]`) if access to Contacts has not been granted.
 
@@ -95,7 +96,7 @@ console.log(allContacts[0])
 
 ### 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`, or `socialProfiles`.
+* `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`.
 
 Returns `Array<Object>` - Returns an array of contact objects where either the first or last name of the contact matches `name`.
 
@@ -118,6 +119,7 @@ The returned object will take the following format:
 * `contactImage` Buffer (optional) - a Buffer representation of the contact's profile picture.
 * `contactThumbnailImage` Buffer (optional) - a Buffer representation of The thumbnail version of the contact’s profile picture.
 * `socialProfiles` Object[] (optional) - An array of labeled social profiles for a contact.
+* `instantMessageAddresses` Object[]  (optional) - An array of labeled IM addresses for the contact.
 
 This method will return an empty array (`[]`) if access to Contacts has not been granted.
 

contacts.mm

@@ -81,6 +81,30 @@
   return social_profiles;
 }
 
+// Parses and returns an array of instant message addresses as objects.
+Napi::Array GetInstantMessageAddresses(Napi::Env env, CNContact *cncontact) {
+  int num_im_addresses = [[cncontact instantMessageAddresses] count];
+  Napi::Array im_addresses = Napi::Array::New(env, num_im_addresses);
+
+  NSArray *addresses =
+      (NSArray *)[[cncontact instantMessageAddresses] valueForKey:@"value"];
+  for (int i = 0; i < num_im_addresses; i++) {
+    Napi::Object address = Napi::Object::New(env);
+    CNSocialProfile *im_address = [addresses objectAtIndex:i];
+
+    address.Set("service", std::string([im_address service]
+                                           ? [[im_address service] UTF8String]
+                                           : ""));
+    address.Set("username", std::string([im_address username]
+                                            ? [[im_address username] UTF8String]
+                                            : ""));
+
+    im_addresses[i] = address;
+  }
+
+  return im_addresses;
+}
+
 // Parses and returns birthdays as strings in YYYY-MM-DD format.
 std::string GetBirthday(CNContact *cncontact) {
   std::string result;
@@ -166,6 +190,11 @@
     contact.Set("middleName", std::string([[cncontact middleName] UTF8String]));
   }
 
+  if ([cncontact isKeyAvailable:CNContactInstantMessageAddressesKey]) {
+    contact.Set("instantMessageAddresses",
+                GetInstantMessageAddresses(env, cncontact));
+  }
+
   if ([cncontact isKeyAvailable:CNContactSocialProfilesKey]) {
     contact.Set("socialProfiles", GetSocialProfiles(env, cncontact));
   }
@@ -265,6 +294,11 @@ CNAuthorizationStatus AuthStatus() {
         [keys addObject:CNContactNoteKey];
       } else if (key == "middleName") {
         [keys addObject:CNContactMiddleNameKey];
+      } else if (key == "instantMessageAddresses") {
+        [keys addObjectsFromArray:@[
+          CNContactInstantMessageAddressesKey,
+          CNInstantMessageAddressServiceKey, CNInstantMessageAddressUsernameKey
+        ]];
       } else if (key == "socialProfiles") {
         [keys addObjectsFromArray:@[
           CNContactSocialProfilesKey, CNSocialProfileServiceKey,

index.js

@@ -1,7 +1,7 @@
 const contacts = require('bindings')('contacts.node')
 
 function getAllContacts(extraProperties = []) {
-  if (Array.isArray(extraProperties)) {
+  if (!Array.isArray(extraProperties)) {
     throw new TypeError('extraProperties must be an array')
   }
 
@@ -13,7 +13,7 @@ function getContactsByName(name, extraProperties = []) {
     throw new TypeError('name must be a string')
   }
 
-  if (Array.isArray(extraProperties)) {
+  if (!Array.isArray(extraProperties)) {
     throw new TypeError('extraProperties must be an array')
   }