feat: implement askForSpeechRecognitionAccess()

Author: codebytere

README.md

@@ -100,6 +100,33 @@ askForCalendarAccess().then(status => {
 })
 ```
 
+## `permissions.askForSpeechRecognitionAccess()`
+
+Returns `Promise<String>` - Whether or not the request succeeded or failed; can be `authorized` or `denied`.
+
+Checks the authorization status for Speech Recognition access. If the status check returns:
+
+* `not determined` - The Speech Recognition access authorization will prompt the user to authorize or deny. The Promise is resolved after the user selection with either `authorized` or `denied`.
+* `denied` - The `Security & Privacy` System Preferences window is opened with the Speech Recognition privacy key highlighted. On open of the `Security & Privacy` window, the Promise is resolved as `denied`.
+
+Your app must provide an explanation for its use of Speech Recognition using the `NSSpeechRecognitionUsageDescription` `Info.plist` key;
+
+```
+<key>NSSpeechRecognitionUsageDescription</key>
+<string>Your reason for wanting to access Speech Recognition</string>
+```
+
+Example:
+```js
+const { askForSpeechRecognitionAccess } = require('node-mac-permissions')
+
+askForSpeechRecognitionAccess().then(status => {
+  console.log(`Access to Speech Recognition is ${status}`)
+})
+```
+
+**Note:** `status` will be resolved back as `authorized` prior to macOS 10.15, where the underlying API was introduced.
+
 ## `permissions.askForRemindersAccess()`
 
 Returns `Promise<String>` - Whether or not the request succeeded or failed; can be `authorized` or `denied`.

index.js

@@ -30,6 +30,7 @@ module.exports = {
   askForCameraAccess: permissions.askForCameraAccess,
   askForMicrophoneAccess: permissions.askForMicrophoneAccess,
   askForPhotosAccess: permissions.askForPhotosAccess,
+  askForSpeechRecognitionAccess: permissions.askForSpeechRecognitionAccess,
   askForScreenCaptureAccess: permissions.askForScreenCaptureAccess,
   askForAccessibilityAccess: permissions.askForAccessibilityAccess,
   getAuthStatus,

permissions.mm

@@ -355,7 +355,7 @@ void AskForFullDiskAccess(const Napi::CallbackInfo &info) {
   Napi::Env env = info.Env();
   Napi::Promise::Deferred deferred = Napi::Promise::Deferred::New(env);
   Napi::ThreadSafeFunction ts_fn = Napi::ThreadSafeFunction::New(
-      env, Napi::Function::New(env, NoOp), "cameraAccessCallback", 0, 1);
+      env, Napi::Function::New(env, NoOp), "cameraCallback", 0, 1);
 
   if (@available(macOS 10.14, *)) {
     std::string auth_status = MediaAuthStatus("camera");
@@ -395,6 +395,52 @@ void AskForFullDiskAccess(const Napi::CallbackInfo &info) {
   return deferred.Promise();
 }
 
+// Request Speech Recognition access.
+Napi::Promise AskForSpeechRecognitionAccess(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+  Napi::Promise::Deferred deferred = Napi::Promise::Deferred::New(env);
+  Napi::ThreadSafeFunction ts_fn = Napi::ThreadSafeFunction::New(
+      env, Napi::Function::New(env, NoOp), "speechRecognitionCallback", 0, 1);
+
+  if (@available(macOS 10.15, *)) {
+    std::string auth_status = SpeechRecognitionAuthStatus();
+
+    if (auth_status == "not determined") {
+      __block Napi::ThreadSafeFunction tsfn = ts_fn;
+      [SFSpeechRecognizer
+          requestAuthorization:^(SFSpeechRecognizerAuthorizationStatus status) {
+            auto callback = [=](Napi::Env env, Napi::Function js_cb,
+                                const char *granted) {
+              deferred.Resolve(Napi::String::New(env, granted));
+            };
+            tsfn.BlockingCall(
+                status == SFSpeechRecognizerAuthorizationStatusAuthorized
+                    ? "authorized"
+                    : "denied",
+                callback);
+            tsfn.Release();
+          }];
+    } else if (auth_status == "denied") {
+      NSWorkspace *workspace = [[NSWorkspace alloc] init];
+      NSString *pref_string = @"x-apple.systempreferences:com.apple.preference."
+                              @"security?Privacy_SpeechRecognition";
+
+      [workspace openURL:[NSURL URLWithString:pref_string]];
+
+      ts_fn.Release();
+      deferred.Resolve(Napi::String::New(env, "denied"));
+    } else {
+      ts_fn.Release();
+      deferred.Resolve(Napi::String::New(env, auth_status));
+    }
+  } else {
+    ts_fn.Release();
+    deferred.Resolve(Napi::String::New(env, "authorized"));
+  }
+
+  return deferred.Promise();
+}
+
 // Request Photos access.
 Napi::Promise AskForPhotosAccess(const Napi::CallbackInfo &info) {
   Napi::Env env = info.Env();
@@ -443,7 +489,7 @@ void AskForFullDiskAccess(const Napi::CallbackInfo &info) {
   Napi::Env env = info.Env();
   Napi::Promise::Deferred deferred = Napi::Promise::Deferred::New(env);
   Napi::ThreadSafeFunction ts_fn = Napi::ThreadSafeFunction::New(
-      env, Napi::Function::New(env, NoOp), "microphoneAccessCallback", 0, 1);
+      env, Napi::Function::New(env, NoOp), "microphoneCallback", 0, 1);
 
   if (@available(macOS 10.14, *)) {
     std::string auth_status = MediaAuthStatus("microphone");
@@ -534,6 +580,8 @@ void AskForAccessibilityAccess(const Napi::CallbackInfo &info) {
               Napi::Function::New(env, AskForCameraAccess));
   exports.Set(Napi::String::New(env, "askForMicrophoneAccess"),
               Napi::Function::New(env, AskForMicrophoneAccess));
+  exports.Set(Napi::String::New(env, "askForSpeechRecognitionAccess"),
+              Napi::Function::New(env, AskForSpeechRecognitionAccess));
   exports.Set(Napi::String::New(env, "askForPhotosAccess"),
               Napi::Function::New(env, AskForPhotosAccess));
   exports.Set(Napi::String::New(env, "askForScreenCaptureAccess"),