feat(Expo): Added Expo config plugin (#317)

* Created config plugin

* Updated example

* Updated docs

* Improved prepare script

* Remove empty testing

* fixed up package.json

* Update README.md

* Fixed prop names

* Bump config-plugins

* Updated docs

* Update README.md

* Revert example

* clean up lock

* Pull ems out

Author: EvanBacon

.gitignore

@@ -16,3 +16,5 @@ VoiceModule.iml
 yarn-error.log
 
 dist
+
+plugin/build

README.md

@@ -11,7 +11,7 @@
 ```sh
 yarn add @react-native-voice/voice
 
-# or 
+# or
 
 npm i @react-native-voice/voice --save
 ```
@@ -27,6 +27,7 @@ npx pod-install
 - [Linking](#linking)
   - [Manually Link Android](#manually-link-android)
   - [Manually Link iOS](#manually-link-ios)
+- [Prebuild Plugin](#prebuild-plugin)
 - [Usage](#usage)
   - [Example](#example)
 - [API](#api)
@@ -93,6 +94,45 @@ public class MainActivity extends Activity implements ReactApplication {
 
 - Click on your main project file (the one that represents the .xcodeproj) select Build Phases and drag the static library, lib.Voice.a, from the Libraries/Voice.xcodeproj/Products folder to Link Binary With Libraries
 
+<h2 align="center">Prebuild Plugin</h2>
+
+> This package cannot be used in the "Expo Go" app because [it requires custom native code](https://docs.expo.io/workflow/customizing/).
+
+After installing this npm package, add the [config plugin](https://docs.expo.io/guides/config-plugins/) to the [`plugins`](https://docs.expo.io/versions/latest/config/app/#plugins) array of your `app.json` or `app.config.js`:
+
+```json
+{
+  "expo": {
+    "plugins": ["@react-native-voice/voice"]
+  }
+}
+```
+
+Next, rebuild your app as described in the ["Adding custom native code"](https://docs.expo.io/workflow/customizing/) guide.
+
+### Props
+
+The plugin provides props for extra customization. Every time you change the props or plugins, you'll need to rebuild (and `prebuild`) the native app. If no extra properties are added, defaults will be used.
+
+- `speechRecognition` (_string | false_): Sets the message for the `NSSpeechRecognitionUsageDescription` key in the `Info.plist` message. When undefined, a default permission message will be used. When `false`, the permission will be skipped.
+- `microphone` (_string | false_): Sets the message for the `NSMicrophoneUsageDescription` key in the `Info.plist`. When undefined, a default permission message will be used. When `false`, the `android.permission.RECORD_AUDIO` will not be added to the `AndroidManifest.xml` and the iOS permission will be skipped.
+
+### Example
+
+```json
+{
+  "plugins": [
+    [
+      "@react-native-voice/voice",
+      {
+        "microphonePermission": "CUSTOM: Allow $(PRODUCT_NAME) to access the microphone",
+        "speechRecognitionPermission": "CUSTOM: Allow $(PRODUCT_NAME) to securely recognize user speech"
+      }
+    ]
+  ]
+}
+```
+
 <h2 align="center">Usage</h2>
 
 <p align="center"><a href="https://github.com/react-native-voice/voice/blob/master/example/src/VoiceTest.tsx">Full example for Android and iOS.</a></p>

app.plugin.js

@@ -0,0 +1 @@
+module.exports = require('./plugin/build/withVoice');

package.json

@@ -8,6 +8,7 @@
   "devDependencies": {
     "@react-native-community/eslint-config": "^0.0.7",
     "@semantic-release/git": "^9.0.0",
+    "@tsconfig/node10": "^1.0.7",
     "@types/invariant": "^2.2.31",
     "@types/react-native": "0.61.17",
     "eslint": "^6.8.0",
@@ -30,6 +31,7 @@
   "peerDependencies": {
     "react-native": ">= 0.60.2"
   },
+ 
   "repository": {
     "type": "git",
     "url": "git://github.com/react-native-voice/voice.git"
@@ -40,12 +42,15 @@
     "start": "yarn --cwd example start",
     "ios": "yarn --cwd example ios",
     "android": "yarn --cwd example android",
-    "prepare": "yarn build",
+    "prepare": "yarn build && yarn build:plugin",
     "build": "tsc",
+    "dev-sync": "cp -r ./dist example/node_modules/@react-native-voice/voice",
     "type-check": "tsc -noEmit",
-    "dev-sync": "cp -r ./dist example/node_modules/@react-native-voice/voice"
+    "build:plugin": "tsc --build plugin",
+    "lint:plugin": "eslint plugin/src/*"
   },
   "dependencies": {
-    "invariant": "^2.2.4"
+    "invariant": "^2.2.4",
+    "@expo/config-plugins": "^2.0.0"
   }
 }

plugin/src/withVoice.ts

@@ -0,0 +1,74 @@
+import {
+  AndroidConfig,
+  ConfigPlugin,
+  createRunOncePlugin,
+  withInfoPlist,
+} from '@expo/config-plugins';
+
+const pkg = require('@react-native-voice/voice/package.json');
+
+const MICROPHONE = 'Allow $(PRODUCT_NAME) to access the microphone';
+
+const SPEECH_RECOGNITION =
+  'Allow $(PRODUCT_NAME) to securely recognize user speech';
+
+export type Props = {
+  /**
+   * `NSSpeechRecognitionUsageDescription` message.
+   */
+  speechRecognitionPermission?: string | false;
+
+  /**
+   * `NSMicrophoneUsageDescription` message.
+   */
+  microphonePermission?: string | false;
+};
+
+/**
+ * Adds `NSMicrophoneUsageDescription` and `NSSpeechRecognitionUsageDescription` to the `Info.plist`.
+ *
+ * @param props.speechRecognitionPermission speech recognition message
+ * @param props.microphonePermission microphone permission message
+ * @returns
+ */
+const withIosPermissions: ConfigPlugin<Props> = (
+  c,
+  { microphonePermission, speechRecognitionPermission } = {},
+) => {
+  return withInfoPlist(c, config => {
+    if (microphonePermission !== false) {
+      config.modResults.NSMicrophoneUsageDescription =
+        microphonePermission ||
+        config.modResults.NSMicrophoneUsageDescription ||
+        MICROPHONE;
+    }
+    if (speechRecognitionPermission !== false) {
+      config.modResults.NSSpeechRecognitionUsageDescription =
+        speechRecognitionPermission ||
+        config.modResults.NSSpeechRecognitionUsageDescription ||
+        SPEECH_RECOGNITION;
+    }
+
+    return config;
+  });
+};
+
+/**
+ * Adds the following to the `AndroidManifest.xml`: `<uses-permission android:name="android.permission.RECORD_AUDIO" />`
+ */
+const withAndroidPermissions: ConfigPlugin = config => {
+  return AndroidConfig.Permissions.withPermissions(config, [
+    'android.permission.RECORD_AUDIO',
+  ]);
+};
+
+const withVoice: ConfigPlugin<Props | void> = (config, props = {}) => {
+  const _props = props ? props : {};
+  config = withIosPermissions(config, _props);
+  if (_props.microphonePermission !== false) {
+    config = withAndroidPermissions(config);
+  }
+  return config;
+};
+
+export default createRunOncePlugin(withVoice, pkg.name, pkg.version);

plugin/tsconfig.json

@@ -0,0 +1,11 @@
+{
+    "extends": "@tsconfig/node10/tsconfig.json",
+    "compilerOptions": {
+      "outDir": "build",
+      "rootDir": "src",
+      "declaration": true
+    },
+    "include": ["./src"],
+    "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+  }
+