feat: implement calendar/reminder requests

Author: codebytere

README.md

@@ -18,15 +18,15 @@ This native Node.js module allows you to manage an app's access to:
 
 * `type` String - The type of system component to which you are requesting access. Can be one of 'contacts', 'full-disk-access', 'photos', 'reminders', or 'calendar'.
 
-Returns `String` - Can be one of 'Not Determined', 'Denied', 'Authorized', or 'Restricted'.
+Returns `String` - Can be one of 'not determined', 'denied', 'authorized', or 'restricted'.
 
 Checks the authorization status of the application to access `type` on macOS.
 
 Return Value Descriptions: 
-* 'Not Determined' - The user has not yet made a choice regarding whether the application may access `type` data.
-* 'Not Authorized' - The application is not authorized to access `type` data. The user cannot change this application’s status, possibly due to active restrictions such as parental controls being in place.
-* 'Denied' - The user explicitly denied access to `type` data for the application.
-* 'Authorized' - The application is authorized to access `type` data.
+* 'not determined' - The user has not yet made a choice regarding whether the application may access `type` data.
+* 'restricted' - The application is not authorized to access `type` data. The user cannot change this application’s status, possibly due to active restrictions such as parental controls being in place.
+* 'denied' - The user explicitly denied access to `type` data for the application.
+* 'authorized' - The application is authorized to access `type` data.
 
 **Note:** Access to 'contacts' will always return a status of 'Authorized' prior to macOS 10.13 High Sierra, as access to contacts was unilaterally allowed until that version.
 
@@ -36,7 +36,7 @@ Return Value Descriptions:
   * `error` String | null - An error in performing the request, if one occurred.
   * `status` String - Whether or not the request succeeded or failed; can be 'authorized' or 'denied'.
 
-In your app, you should put the reason you're requesting to manipulate user's contacts database in your `Info.plist` like so:
+Your app’s `Info.plist` file must provide a value for the `NSContactsUsageDescription` key that explains to the user why your app is requesting Contacts access.
 
 ```
 <key>NSContactsUsageDescription</key>
@@ -47,6 +47,34 @@ In your app, you should put the reason you're requesting to manipulate user's co
 const { askForContactsAccess } = require('node-mac-permissions')
 
 askForContactsAccess((err, status) => {
-  console.log(`Access to Contacts was ${status}`)
+  console.log(`Access to Contacts is ${status}`)
+})
+```
+
+## `permissions.askForCalendarAccess(callback)`
+
+* `callback` Function
+  * `error` String | null - An error in performing the request, if one occurred.
+  * `status` String - Whether or not the request succeeded or failed; can be 'authorized' or 'denied'.
+
+```js
+const { askForCalendarAccess } = require('node-mac-permissions')
+
+askForCalendarAccess((err, status) => {
+  console.log(`Access to Calendar is ${status}`)
+})
+```
+
+## `permissions.askForRemindersAccess(callback)`
+
+* `callback` Function
+  * `error` String | null - An error in performing the request, if one occurred.
+  * `status` String - Whether or not the request succeeded or failed; can be 'authorized' or 'denied'.
+
+```js
+const { askForRemindersAccess } = require('node-mac-permissions')
+
+askForRemindersAccess((err, status) => {
+  console.log(`Access to Reminders is ${status}`)
 })
 ```

index.js

@@ -1,7 +1,7 @@
 const permissions = require('bindings')('permissions.node')
 
 function getAuthStatus(type) {
-  const validTypes = ['contacts', 'calendar', 'reminders', 'photos', 'full-disk-access']
+  const validTypes = ['contacts', 'calendar', 'reminders', 'full-disk-access']
   if (!validTypes.includes(type)) {
     throw new TypeError(`${type} is not a valid type`)
   }
@@ -11,5 +11,7 @@ function getAuthStatus(type) {
 
 module.exports = {
   getAuthStatus,
-  askForContactsAccess: permissions.askForContactsAccess
+  askForContactsAccess: permissions.askForContactsAccess,
+  askForCalendarAccess: permissions.askForCalendarAccess,
+  askForRemindersAccess: permissions.askForRemindersAccess
 }

permissions.mm

@@ -27,60 +27,40 @@
 
 // Returns a status indicating whether or not the user has authorized Contacts access
 std::string ContactAuthStatus() {
-  std::string auth_status = "Not Determined";
+  std::string auth_status = "not determined";
 
   CNEntityType entityType = CNEntityTypeContacts;
   CNAuthorizationStatus status = [CNContactStore authorizationStatusForEntityType:entityType];
 
   if (status == CNAuthorizationStatusAuthorized)
-    auth_status = "Authorized";
+    auth_status = "authorized";
   else if (status == CNAuthorizationStatusDenied)
-    auth_status = "Denied";
+    auth_status = "denied";
   else if (status == CNAuthorizationStatusRestricted)
-    auth_status = "Restricted";
+    auth_status = "restricted";
 
   return auth_status;
 }
 
 // Returns a status indicating whether or not the user has authorized Calendar/Reminders access
 std::string EventAuthStatus(std::string type) {
-  std::string auth_status = "Not Determined";
+  std::string auth_status = "not determined";
 
   EKEntityType entityType = (type == "calendar") ? EKEntityTypeEvent : EKEntityTypeReminder;
   EKAuthorizationStatus status = [EKEventStore authorizationStatusForEntityType:entityType];
 
   if (status == EKAuthorizationStatusAuthorized)
-    auth_status = "Authorized";
+    auth_status = "authorized";
   else if (status == EKAuthorizationStatusDenied)
-    auth_status = "Denied";
+    auth_status = "denied";
   else if (status == EKAuthorizationStatusRestricted)
-    auth_status = "Restricted";
-
-  return auth_status;
-}
-
-// Returns a status indicating whether or not the user has authorized Photos access
-std::string PhotosAuthStatus() {
-  std::string auth_status = "Not Determined";
-  
-  if (@available(macOS 10.13, *)) {
-    PHAuthorizationStatus status = [PHPhotoLibrary authorizationStatus];
-
-    if (status == PHAuthorizationStatusAuthorized)
-      auth_status = "Authorized";
-    else if (status == PHAuthorizationStatusDenied)
-      auth_status = "Denied";
-    else if (status == PHAuthorizationStatusRestricted)
-      auth_status = "Restricted";
-  } else {
-    auth_status = "Authorized";
-  }
+    auth_status = "restricted";
 
   return auth_status;
 }
 
 std::string FDAAuthStatus() {
-  std::string auth_status = "Not Determined";
+  std::string auth_status = "not determined";
   NSString *path;
   NSString* home_folder = GetUserHomeFolderPath();
 
@@ -94,9 +74,9 @@
   BOOL file_exists = [manager fileExistsAtPath:path];
   NSData *data = [NSData dataWithContentsOfFile:path];
   if (data == nil && file_exists) {
-    auth_status = "Denied";
+    auth_status = "denied";
   } else if (file_exists) {
-    auth_status = "Authorized";
+    auth_status = "authorized";
   }
 
   return auth_status;
@@ -114,8 +94,6 @@
     auth_status = ContactAuthStatus();
   } else if (type == "calendar") {
     auth_status = EventAuthStatus("calendar");
-  } else if (type == "photos") {
-    auth_status = PhotosAuthStatus();
   }  else if (type == "reminders") {
     auth_status = EventAuthStatus("reminders");
   } else if (type == "full-disk-access") {
@@ -145,6 +123,34 @@ void AskForContactsAccess(const Napi::CallbackInfo &info) {
   }
 }
 
+// Request access to Calendar.
+void AskForCalendarAccess(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+  Napi::ThreadSafeFunction ts_fn = Napi::ThreadSafeFunction::New(env, info[0].As<Napi::Function>(),
+                                                                "Resource Name", 0, 1, [](Napi::Env){});
+
+  [[EKEventStore new] requestAccessToEntityType:EKEntityTypeEvent completion:^(BOOL granted, NSError * error) {
+    auto callback = [](Napi::Env env, Napi::Function js_cb, const char* granted) {
+      js_cb.Call({Napi::String::New(env, granted)});
+    };
+    ts_fn.BlockingCall(granted ? "authorized" : "denied", callback);
+  }];
+}
+
+// Request access to Reminders.
+void AskForRemindersAccess(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+  Napi::ThreadSafeFunction ts_fn = Napi::ThreadSafeFunction::New(env, info[0].As<Napi::Function>(),
+                                                                "Resource Name", 0, 1, [](Napi::Env){});
+
+  [[EKEventStore new] requestAccessToEntityType:EKEntityTypeReminder completion:^(BOOL granted, NSError * error) {
+    auto callback = [](Napi::Env env, Napi::Function js_cb, const char* granted) {
+      js_cb.Call({Napi::String::New(env, granted)});
+    };
+    ts_fn.BlockingCall(granted ? "authorized" : "denied", callback);
+  }];
+}
+
 // Initializes all functions exposed to JS
 Napi::Object Init(Napi::Env env, Napi::Object exports) {
   exports.Set(
@@ -153,6 +159,12 @@ void AskForContactsAccess(const Napi::CallbackInfo &info) {
   exports.Set(
     Napi::String::New(env, "askForContactsAccess"), Napi::Function::New(env, AskForContactsAccess)
   );
+  exports.Set(
+    Napi::String::New(env, "askForCalendarAccess"), Napi::Function::New(env, AskForCalendarAccess)
+  );
+  exports.Set(
+    Napi::String::New(env, "askForRemindersAccess"), Napi::Function::New(env, AskForRemindersAccess)
+  );
 
   return exports;
 }

test/module.spec.js

@@ -12,8 +12,8 @@ describe('node-mac-permissions', () => {
     })
 
     it('should return a string', () => {
-      const types = ['contacts', 'calendar', 'reminders', 'photos', 'full-disk-access']
-      const statuses = ['Not Determined', 'Denied', 'Authorized', 'Restricted']
+      const types = ['contacts', 'calendar', 'reminders', 'full-disk-access']
+      const statuses = ['not determined', 'denied', 'authorized', 'restricted']
       for (const type of types) {
         const status = getAuthStatus(type)
         expect(statuses).to.contain(status)