#15 Add a 'requestPermissions' method

.travis.yml

@@ -34,5 +34,5 @@ before_script:
 
 script:
     - npm run setup
-    - npm run demo.android
-    - npm run test.android
+    - npm run tslint
+    - npm run demo.android

CHANGELOG.md

@@ -7,6 +7,7 @@
 * ability to receive partial results on Android ([d971d3e](https://github.com/EddyVerbruggen/nativescript-speech-recognition/commit/d971d3e))
 * Added YouTube link to an Angular video ([ee45704](https://github.com/EddyVerbruggen/nativescript-speech-recognition/commit/ee45704))
 * bump ([7603a65](https://github.com/EddyVerbruggen/nativescript-speech-recognition/commit/7603a65))
+* changelog ([d804b5b](https://github.com/EddyVerbruggen/nativescript-speech-recognition/commit/d804b5b))
 * Device or Emulator? #9 ([4de4425](https://github.com/EddyVerbruggen/nativescript-speech-recognition/commit/4de4425))
 * ignore some more ([0c37443](https://github.com/EddyVerbruggen/nativescript-speech-recognition/commit/0c37443))
 

README.md

@@ -55,17 +55,28 @@ speechRecognition.available().then(
 // import the plugin
 import { SpeechRecognition } from "nativescript-speech-recognition";
 
-// instantiate the plugin (assuming the code below is inside a Class)
-private speechRecognition = new SpeechRecognition();
-
-public checkAvailability(): void {
-  this.speechRecognition.available().then(
-    (available: boolean) => console.log(available ? "YES!" : "NO"),
-    (err: string) => console.log(err)
-  );
+class SomeClass {
+  private speechRecognition = new SpeechRecognition();
+
+  public checkAvailability(): void {
+    this.speechRecognition.available().then(
+      (available: boolean) => console.log(available ? "YES!" : "NO"),
+      (err: string) => console.log(err)
+    );
+  }
 }
 ```
 
+### `requestPermission`
+You can either let `startListening` handle permissions when needed, but if you want to have more control
+over when the permission popups are shown, you can use this function:
+
+```typescript
+this.speechRecognition.requestPermission().then((granted: boolean) => {
+  console.log("Granted? " + granted);
+});
+```
+
 ### `startListening`
 
 On iOS this will trigger two prompts:

demo/app/app.ts

@@ -1,2 +1,2 @@
-import * as application from 'application';
+import * as application from "tns-core-modules/application";
 application.start({ moduleName: "main-page" });

demo/app/main-page.ts

@@ -1,6 +1,6 @@
-import * as observable from 'data/observable';
-import * as pages from 'ui/page';
-import {HelloWorldModel} from './main-view-model';
+import * as observable from "tns-core-modules/data/observable";
+import * as pages from "tns-core-modules/ui/page";
+import {HelloWorldModel} from "./main-view-model";
 
 // Event handler for Page 'loaded' event attached in main-page.xml
 export function pageLoaded(args: observable.EventData) {

demo/app/main-view-model.ts

@@ -1,4 +1,4 @@
-import { Observable } from "data/observable";
+import { Observable } from "tns-core-modules/data/observable";
 import { SpeechRecognition, SpeechRecognitionTranscription } from "nativescript-speech-recognition";
 
 export class HelloWorldModel extends Observable {
@@ -10,6 +10,9 @@ export class HelloWorldModel extends Observable {
   constructor() {
     super();
     this.speechRecognition = new SpeechRecognition();
+
+    // Testing manual persmission. You don't need to do this.
+    setTimeout(() => this.requestPermission(), 1500);
   }
 
   public startListeningNL(): void {
@@ -55,4 +58,11 @@ export class HelloWorldModel extends Observable {
       console.log(`Error while trying to stop listening: ${errorMessage}`);
     });
   }
+
+  public requestPermission(): void {
+    let that = this;
+    this.speechRecognition.requestPermission().then((granted: boolean) => {
+      console.log("Granted? " + granted);
+    });
+  }
 }

demo/package.json

@@ -2,17 +2,17 @@
   "nativescript": {
     "id": "org.nativescript.speechrecognition",
     "tns-ios": {
-      "version": "3.0.1"
+      "version": "3.1.0"
     },
     "tns-android": {
-      "version": "3.0.0"
+      "version": "3.1.1"
     }
   },
   "dependencies": {
     "nativescript-speech-recognition": "file:../",
     "nativescript-theme-core": "^1.0.4",
     "nativescript-unit-test-runner": "^0.3.4",
-    "tns-core-modules": "^3.0.1"
+    "tns-core-modules": "^3.1.0"
   },
   "devDependencies": {
     "babel-traverse": "6.12.0",
@@ -24,7 +24,7 @@
     "karma-jasmine": "^1.0.2",
     "karma-nativescript-launcher": "^0.4.0",
     "lazy": "1.0.11",
-    "nativescript-dev-typescript": "^0.4.0",
-    "typescript": "^2.3.0"
+    "nativescript-dev-typescript": "libs",
+    "typescript": "~2.3.0"
   }
 }

demo/tsconfig.json

@@ -8,8 +8,8 @@
         "emitDecoratorMetadata": true,
         "experimentalDecorators": true,
         "lib": [
-            "dom",
-            "es6"
+            "es6",
+            "dom"
         ],
         "pretty": true,
         "allowUnreachableCode": false,
@@ -20,15 +20,9 @@
         "noImplicitReturns": true,
         "noImplicitUseStrict": false,
         "noFallthroughCasesInSwitch": true,
-        "typeRoots": [
-            "./node_modules/@types",
-            "./node_modules"
-        ],
-        "types": [],
         "baseUrl": ".",
         "paths": {
             "*": [
-                "./node_modules/tns-core-modules/*",
                 "./node_modules/*"
             ]
         }
@@ -38,4 +32,4 @@
         "platforms"
     ],
     "compileOnSave": false
-}
+}

index.d.ts

@@ -1,3 +1,3 @@
-export * from './speech-recognition.ios';
+export * from "./speech-recognition.ios";
 
-export * from './speech-recognition.common';
+export * from "./speech-recognition.common";

package.json

@@ -11,7 +11,7 @@
     }
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -skipLibCheck",
     "demo.ios": "npm run preparedemo && cd demo && tns run ios --emulator",
     "demo.ios.device": "npm run preparedemo && cd demo && tns run ios",
     "demo.android": "npm run preparedemo && cd demo && tns run android",
@@ -22,7 +22,8 @@
     "setup": "npm i && cd demo && npm i && cd .. && npm run build && cd demo && tns plugin add .. && cd ..",
     "changelog": "conventional-changelog -i CHANGELOG.md -s -r 0",
     "changelog:add": "git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md'",
-    "prepublish": "npm run build"
+    "prepublishOnly": "npm run build",
+    "tslint": "tslint \"**/*.ts\" --config tslint.json --exclude \"**/node_modules/**\" --exclude \"demo/platforms/**\""
   },
   "repository": {
     "type": "git",
@@ -56,11 +57,10 @@
   "homepage": "https://github.com/EddyVerbruggen/nativescript-speech-recognition",
   "readmeFilename": "README.md",
   "devDependencies": {
-    "conventional-changelog-cli": "^1.2.0",
-    "prompt": "^1.0.0",
-    "rimraf": "^2.5.0",
-    "tns-core-modules": "^2.5.0",
-    "tns-platform-declarations": "^2.5.0",
-    "typescript": "^2.1.0"
+    "conventional-changelog-cli": "^1.3.2",
+    "tns-core-modules": "^3.1.0",
+    "tns-platform-declarations": "^3.1.0",
+    "tslint": "^5.0.0",
+    "typescript": "~2.3.0"
   }
 }

platforms/ios/Info.plist

@@ -3,8 +3,8 @@
 <plist version="1.0">
   <dict>
     <key>NSSpeechRecognitionUsageDescription</key>
-    <string/>
+    <string> </string>
     <key>NSMicrophoneUsageDescription</key>
-    <string/>
+    <string> </string>
   </dict>
 </plist>

references.d.ts

@@ -1,4 +1,2 @@
-/// <reference path="./node_modules/tns-core-modules/tns-core-modules.es2016.d.ts" />
-
 /// <reference path="./node_modules/tns-platform-declarations/ios.d.ts" />
 /// <reference path="./node_modules/tns-platform-declarations/android.d.ts" />

speech-recognition.android.ts

@@ -1,6 +1,6 @@
 import { SpeechRecognitionApi, SpeechRecognitionOptions } from "./speech-recognition.common";
-import * as application from "application";
-import * as utils from "utils/utils";
+import * as application from "tns-core-modules/application";
+import * as utils from "tns-core-modules/utils/utils";
 
 declare let android: any;
 
@@ -39,7 +39,16 @@ export class SpeechRecognition implements SpeechRecognitionApi {
     return new Promise((resolve, reject) => {
       resolve(android.speech.SpeechRecognizer.isRecognitionAvailable(application.android.context));
     });
-  };
+  }
+
+  requestPermission(): Promise<boolean> {
+    console.log(">> requestPermission");
+    return new Promise((resolve, reject) => {
+      this._requestPermission(
+          () => resolve(true),
+          () => resolve(false));
+    });
+  }
 
   startListening(options: SpeechRecognitionOptions): Promise<boolean> {
     return new Promise((resolve, reject) => {
@@ -124,7 +133,7 @@ export class SpeechRecognition implements SpeechRecognitionApi {
                     text: transcripts.get(0), // the first one has the highest confidence
                     // confidence: confidences[0],
                     finished: true
-                  })
+                  });
                 }
               },
 
@@ -161,7 +170,7 @@ export class SpeechRecognition implements SpeechRecognitionApi {
       };
 
       if (!this.wasPermissionGranted()) {
-        this.requestPermission(onPermissionGranted, reject);
+        this._requestPermission(onPermissionGranted, reject);
         return;
       }
 
@@ -198,9 +207,9 @@ export class SpeechRecognition implements SpeechRecognitionApi {
               android.Manifest.permission.RECORD_AUDIO);
     }
     return hasPermission;
-  };
+  }
 
-  private requestPermission(onPermissionGranted: Function, reject): void {
+  private _requestPermission(onPermissionGranted: Function, reject): void {
     this.onPermissionGranted = onPermissionGranted;
     this.onPermissionRejected = reject;
     android.support.v4.app.ActivityCompat.requestPermissions(

speech-recognition.common.ts

@@ -25,6 +25,7 @@ export interface SpeechRecognitionOptions {
 
 export interface SpeechRecognitionApi {
   available(): Promise<boolean>;
+  requestPermission(): Promise<boolean>;
   startListening(options: SpeechRecognitionOptions): Promise<boolean>;
   stopListening(): Promise<any>;
 }

speech-recognition.ios.ts

@@ -17,7 +17,21 @@ export class SpeechRecognition implements SpeechRecognitionApi {
     return new Promise((resolve, reject) => {
       resolve(SFSpeechRecognizer.new().available);
     });
-  };
+  }
+
+  requestPermission(): Promise<boolean> {
+    return new Promise((resolve, reject) => {
+      SFSpeechRecognizer.requestAuthorization((status: SFSpeechRecognizerAuthorizationStatus) => {
+        if (status !== SFSpeechRecognizerAuthorizationStatus.Authorized) {
+          resolve(false);
+          return;
+        }
+        AVAudioSession.sharedInstance().requestRecordPermission((granted: boolean) => {
+          resolve(granted);
+        });
+      });
+    });
+  }
 
   startListening(options: SpeechRecognitionOptions): Promise<boolean> {
     return new Promise((resolve, reject) => {

tsconfig.json

@@ -7,9 +7,7 @@
         "noLib": false,
         "emitDecoratorMetadata": true,
         "experimentalDecorators": true,
-        "lib": [
-            "es2016"
-        ],
+        "lib": ["es6", "dom"],
         "sourceMap": true,
         "pretty": true,
         "allowUnreachableCode": false,
@@ -19,17 +17,13 @@
         "noImplicitAny": false,
         "noImplicitReturns": true,
         "noImplicitUseStrict": false,
-        "noFallthroughCasesInSwitch": true,
-        "typeRoots": [
-            "./node_modules/@types",
-            "./node_modules"
-        ],
-        "types": [
-        ]
+        "noFallthroughCasesInSwitch": true
     },
     "exclude": [
-        "demo",
-        "node_modules"
+        "demo/node_modules",
+        "demo/platforms",
+        "node_modules",
+        "platforms"
     ],
     "compileOnSave": false
 }