feat: add socialProfiles 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`, or `contactThumbnailImage`.
+* `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`.
 
 Returns `Array<Object>` - Returns an array of contact objects.
 
@@ -68,6 +68,7 @@ The returned objects will take the following format:
 * `note` String (optional) - The note associated with the contact.
 * `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.
 
 This method will return an empty array (`[]`) if access to Contacts has not been granted.
 
@@ -77,7 +78,7 @@ Example:
 const allContacts = contacts.getAllContacts()
 
 console.log(allContacts[0])
-/* prints
+/* Prints:
 [
   { 
     firstName: 'Jonathan',
@@ -94,7 +95,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`, or `contactThumbnailImage`.
+* `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`.
 
 Returns `Array<Object>` - Returns an array of contact objects where either the first or last name of the contact matches `name`.
 
@@ -116,6 +117,7 @@ The returned object will take the following format:
 * `note` String (optional) - The note associated with the contact.
 * `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.
 
 This method will return an empty array (`[]`) if access to Contacts has not been granted.
 
@@ -125,7 +127,7 @@ Example:
 const contacts = contacts.getContactsByName('Appleseed')
 
 console.log(contacts)
-/* prints
+/* Prints:
 [
   { 
     firstName: 'Jonathan',

contacts.mm

@@ -52,6 +52,35 @@
   return postal_addresses;
 }
 
+// Parses and returns an array of social profiles as objects.
+Napi::Array GetSocialProfiles(Napi::Env env, CNContact *cncontact) {
+  int num_social_profiles = [[cncontact socialProfiles] count];
+  Napi::Array social_profiles = Napi::Array::New(env, num_social_profiles);
+
+  NSArray *profiles =
+      (NSArray *)[[cncontact socialProfiles] valueForKey:@"value"];
+  for (int i = 0; i < num_social_profiles; i++) {
+    Napi::Object profile = Napi::Object::New(env);
+    CNSocialProfile *social_profile = [profiles objectAtIndex:i];
+
+    profile.Set("service",
+                std::string([social_profile service]
+                                ? [[social_profile service] UTF8String]
+                                : ""));
+    profile.Set("username",
+                std::string([social_profile username]
+                                ? [[social_profile username] UTF8String]
+                                : ""));
+    profile.Set("url", std::string([social_profile urlString]
+                                       ? [[social_profile urlString] UTF8String]
+                                       : ""));
+
+    social_profiles[i] = profile;
+  }
+
+  return social_profiles;
+}
+
 // Parses and returns birthdays as strings in YYYY-MM-DD format.
 std::string GetBirthday(CNContact *cncontact) {
   std::string result;
@@ -137,6 +166,10 @@
     contact.Set("middleName", std::string([[cncontact middleName] UTF8String]));
   }
 
+  if ([cncontact isKeyAvailable:CNContactSocialProfilesKey]) {
+    contact.Set("socialProfiles", GetSocialProfiles(env, cncontact));
+  }
+
   return contact;
 }
 
@@ -232,6 +265,12 @@ CNAuthorizationStatus AuthStatus() {
         [keys addObject:CNContactNoteKey];
       } else if (key == "middleName") {
         [keys addObject:CNContactMiddleNameKey];
+      } else if (key == "socialProfiles") {
+        [keys addObjectsFromArray:@[
+          CNContactSocialProfilesKey, CNSocialProfileServiceKey,
+          CNSocialProfileURLStringKey, CNSocialProfileUsernameKey,
+          CNSocialProfileUserIdentifierKey
+        ]];
       }
     }
   }

package.json

@@ -4,10 +4,13 @@
   "description": "A native module that allows you to access and manipulate macOS contacts",
   "main": "index.js",
   "scripts": {
-    "build": "node-gyp rebuild",
+    "build": "node-gyp build",
+    "build:dev": "node-gyp build --debug",
     "clean": "node-gyp clean",
     "lint": "prettier --check index.js",
     "format": "clang-format -i contacts.mm && prettier --write index.js",
+    "rebuild": "node-gyp rebuild",
+    "rebuild:dev": "node-gyp rebuild --debug",
     "test": "./node_modules/.bin/mocha --reporter spec"
   },
   "repository": {