feat: setup expo config plugin for ios permissions setup (#834)

Author: fobos531

.eslintignore

@@ -6,3 +6,4 @@ fetchWindowsCapabilites.js
 mock.js
 node_modules
 react-native.config.js
+app.plugin.js

.eslintrc.js

@@ -11,7 +11,7 @@ module.exports = {
   },
 
   parserOptions: {
-    project: './tsconfig.json',
+    project: ['./tsconfig.json', './plugin/tsconfig.json'],
     ecmaFeatures: {jsx: true},
     ecmaVersion: 2018,
     sourceType: 'module',

README.md

@@ -93,6 +93,25 @@ setup_permissions([
 ```
 
 3. Then execute `pod install` _(📌  Note that it must be re-executed each time you update this config)_.
+
+Tip: If you use Expo and Expo CNG (Continuous Native Generation), you can utilize the built-in Expo Config plugin to perform the work outlined in steps 1 & 2 for you (supported on React Native 0.72+).
+To use the plugin, simply specify the array of the permissions which you want to set up as outlined in step 2 - for example:
+
+```json
+{
+  "name": "my app",
+  "plugins": [
+    [
+      "react-native-permissions",
+      {
+        // ...
+        "iosPermissions": ["Bluetooth"]
+      }
+    ]
+  ]
+}
+```
+
 4. Finally, update your `Info.plist` with the wanted permissions usage descriptions:
 
 ```xml

app.plugin.js

@@ -0,0 +1 @@
+module.exports = require('./dist/commonjs/expo-plugin/index');

package.json

@@ -30,7 +30,8 @@
     "/src",
     "/*.podspec",
     "react-native.config.js",
-    "mock.js"
+    "mock.js",
+    "app.plugin.js"
   ],
   "scripts": {
     "format": "prettier '**/*' -u -w",
@@ -69,6 +70,7 @@
   "devDependencies": {
     "@babel/core": "^7.20.0",
     "@babel/preset-env": "^7.20.0",
+    "@expo/config-plugins": "^7.2.5",
     "@types/react": "^18.2.47",
     "@typescript-eslint/eslint-plugin": "^6.18.0",
     "@typescript-eslint/parser": "^6.18.0",

src/expo-plugin/index.ts

@@ -0,0 +1,69 @@
+import {ConfigPlugin, withDangerousMod} from '@expo/config-plugins';
+import {mergeContents} from '@expo/config-plugins/build/utils/generateCode';
+
+const fs = require('fs');
+const path = require('path');
+
+type Props = {
+  iosPermissions?: Array<
+    | 'AppTrackingTransparency'
+    | 'Bluetooth'
+    | 'Calendars'
+    | 'CalendarsWriteOnly'
+    | 'Camera'
+    | 'Contacts'
+    | 'FaceID'
+    | 'LocationAccuracy'
+    | 'LocationAlways'
+    | 'LocationWhileInUse'
+    | 'MediaLibrary'
+    | 'Microphone'
+    | 'Motion'
+    | 'Notifications'
+    | 'PhotoLibrary'
+    | 'PhotoLibraryAddOnly'
+    | 'Reminders'
+    | 'Siri'
+    | 'SpeechRecognition'
+    | 'StoreKit'
+  >;
+};
+
+const plugin: ConfigPlugin<Props> = (config, {iosPermissions}) => {
+  if (iosPermissions == null || iosPermissions.length === 0) {
+    return config;
+  }
+
+  return withDangerousMod(config, [
+    'ios',
+    async (config) => {
+      const file = path.join(config.modRequest.platformProjectRoot, 'Podfile');
+      let contents = await fs.promises.readFile(file, 'utf8');
+
+      contents = mergeContents({
+        tag: 'node-require-function',
+        src: contents,
+        newSrc: `def node_require(script)\n\t# Resolve script with node to allow for hoisting\n\trequire Pod::Executable.execute_command('node', ['-p',\n\t\t"require.resolve(\n\t\t\t'#{script}',\n\t\t\t {paths: [process.argv[1]]},\n\t\t)", __dir__]).strip\nend\n\nnode_require('react-native-permissions/scripts/setup.rb')`,
+        anchor: /scripts\/react_native_pods/,
+        offset: 1,
+        comment: '#',
+      }).contents;
+
+      contents = mergeContents({
+        tag: 'permissions-array',
+        src: contents,
+        newSrc: `setup_permissions([${iosPermissions
+          .map((permission) => `'${permission}'`)
+          .join(',')}])`,
+        anchor: /prepare_react_native_project!/,
+        offset: 1,
+        comment: '#',
+      }).contents;
+
+      await fs.promises.writeFile(file, contents, 'utf-8');
+      return config;
+    },
+  ]);
+};
+
+export default plugin;