expo-image-picker 13.0.1 → 13.1.0

package/CHANGELOG.md

@@ -10,6 +10,12 @@
 
 ### 💡 Others
 
+## 13.1.0 — 2022-04-25
+
+### 🎉 New features
+
+- [plugin] Added ability to disable permissions. ([#17168](https://github.com/expo/expo/pull/17168) by [@EvanBacon](https://github.com/EvanBacon))
+
 ## 13.0.1 — 2022-04-20
 
 _This version does not introduce any user-facing changes._

package/README.md

@@ -23,6 +23,8 @@ expo install expo-image-picker
 
 ### Configure for iOS
 
+> This is only required for usage in bare React Native apps.
+
 Add `NSPhotoLibraryUsageDescription`, `NSCameraUsageDescription`, and `NSMicrophoneUsageDescription` keys to your `Info.plist`:
 
 ```xml
@@ -38,6 +40,8 @@ Run `npx pod-install` after installing the npm package.
 
 ### Configure for Android
 
+> This is only required for usage in bare React Native apps.
+
 This package automatically adds the `CAMERA`, `READ_EXTERNAL_STORAGE`, and `WRITE_EXTERNAL_STORAGE` permissions. They are used when picking images from the camera directly, or from the camera roll.
 
 ```xml
@@ -47,13 +51,49 @@ This package automatically adds the `CAMERA`, `READ_EXTERNAL_STORAGE`, and `WRIT
 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
 ```
 
-In `AndroidManifest.xml` add the following `activity` within `application`:
+## Config Plugin
 
-```xml
-<activity
-  android:name="com.canhub.cropper.CropImageActivity"
-  android:theme="@style/Base.Theme.AppCompat">
-</activity>
+> This plugin is applied automatically in EAS Build, only add the config plugin if you want to pass in extra properties.
+
+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": ["expo-image-picker"]
+  }
+}
+```
+
+Next, rebuild your app as described in the ["Adding custom native code"](https://docs.expo.io/workflow/customizing/) guide.
+
+### API
+
+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.
+
+- `photosPermission` (_string | false_): Sets the iOS `NSPhotoLibraryUsageDescription` permission message to the `Info.plist`. Setting `false` will skip adding the permission on iOS and **does not** skip the permission on Android. Defaults to `Allow $(PRODUCT_NAME) to access your photos`.
+- `cameraPermission` (_string | false_): Sets the iOS `NSCameraUsageDescription` permission message to the `Info.plist`. Setting `false` will skip adding the permission on iOS and **does not** skip the permission on Android. Defaults to `Allow $(PRODUCT_NAME) to access your camera`.
+- `microphonePermission` (_string | false_): Sets the iOS `NSCameraUsageDescription` permission message to the `Info.plist`. Setting `false` will skip adding the permission on iOS and skips adding the `android.permission.RECORD_AUDIO` Android permission. Defaults to `Allow $(PRODUCT_NAME) to access your photos`.
+
+### Example
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "expo-image-picker",
+        {
+          "photosPermission": "custom photos permission",
+          "cameraPermission": "Allow $(PRODUCT_NAME) to open the camera",
+
+          "//": "Disables the microphone permission",
+          "microphonePermission": false
+        }
+      ]
+    ]
+  }
+}
 ```
 
 # Contributing

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '13.0.1'
+version = '13.1.0'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -74,7 +74,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 31)
     versionCode 22
-    versionName "13.0.1"
+    versionName "13.1.0"
   }
   lintOptions {
     abortOnError false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-image-picker",
-  "version": "13.0.1",
+  "version": "13.1.0",
   "description": "Provides access to the system's UI for selecting images and videos from the phone's library or taking a photo with the camera.",
   "main": "build/ImagePicker.js",
   "types": "build/ImagePicker.d.ts",
@@ -46,5 +46,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "2b35d9008fef42cb53473331c37693ca12e9bf12"
+  "gitHead": "8fa7ceccfeab2f5090019403d6472fb80d6d7eaf"
 }

package/plugin/build/withImagePicker.d.ts

@@ -1,8 +1,10 @@
-import { ConfigPlugin, AndroidConfig } from '@expo/config-plugins';
-export declare function setImagePickerManifestActivity(androidManifest: AndroidConfig.Manifest.AndroidManifest): AndroidConfig.Manifest.AndroidManifest;
-declare const _default: ConfigPlugin<void | {
-    photosPermission?: string | undefined;
-    cameraPermission?: string | undefined;
-    microphonePermission?: string | undefined;
-}>;
+import { ConfigPlugin, InfoPlist } from '@expo/config-plugins';
+declare type Props = {
+    photosPermission?: string | false;
+    cameraPermission?: string | false;
+    microphonePermission?: string | false;
+};
+export declare function setImagePickerInfoPlist(infoPlist: InfoPlist, { cameraPermission, microphonePermission, photosPermission }: Props): InfoPlist;
+export declare const withAndroidImagePickerPermissions: ConfigPlugin<Props | void>;
+declare const _default: ConfigPlugin<void | Props>;
 export default _default;

package/plugin/build/withImagePicker.js

@@ -1,56 +1,71 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setImagePickerManifestActivity = void 0;
+exports.withAndroidImagePickerPermissions = exports.setImagePickerInfoPlist = void 0;
 const config_plugins_1 = require("@expo/config-plugins");
 const pkg = require('expo-image-picker/package.json');
 const CAMERA_USAGE = 'Allow $(PRODUCT_NAME) to access your camera';
 const MICROPHONE_USAGE = 'Allow $(PRODUCT_NAME) to access your microphone';
 const READ_PHOTOS_USAGE = 'Allow $(PRODUCT_NAME) to access your photos';
-function setImagePickerManifestActivity(androidManifest) {
-    const app = config_plugins_1.AndroidConfig.Manifest.getMainApplicationOrThrow(androidManifest);
-    if (!app.activity) {
-        app.activity = [];
-    }
-    if (!app.activity.find(({ $ }) => $['android:name'] === 'com.canhub.cropper.CropImageActivity')) {
-        app.activity.push({
-            $: {
-                'android:name': 'com.canhub.cropper.CropImageActivity',
-                'android:theme': '@style/Base.Theme.AppCompat',
-            },
-        });
+function setImagePickerInfoPlist(infoPlist, { cameraPermission, microphonePermission, photosPermission }) {
+    if (photosPermission === false) {
+        delete infoPlist.NSPhotoLibraryUsageDescription;
+    }
+    else {
+        infoPlist.NSPhotoLibraryUsageDescription =
+            photosPermission || infoPlist.NSPhotoLibraryUsageDescription || READ_PHOTOS_USAGE;
+    }
+    if (cameraPermission === false) {
+        delete infoPlist.NSCameraUsageDescription;
+    }
+    else {
+        infoPlist.NSCameraUsageDescription =
+            cameraPermission || infoPlist.NSCameraUsageDescription || CAMERA_USAGE;
     }
-    return androidManifest;
+    if (microphonePermission === false) {
+        delete infoPlist.NSMicrophoneUsageDescription;
+    }
+    else {
+        infoPlist.NSMicrophoneUsageDescription =
+            microphonePermission || infoPlist.NSMicrophoneUsageDescription || MICROPHONE_USAGE;
+    }
+    return infoPlist;
 }
-exports.setImagePickerManifestActivity = setImagePickerManifestActivity;
-const withImagePickerManifestActivity = (config) => {
-    // This plugin has no ability to remove the activity that it adds.
-    return (0, config_plugins_1.withAndroidManifest)(config, async (config) => {
-        config.modResults = setImagePickerManifestActivity(config.modResults);
-        return config;
-    });
+exports.setImagePickerInfoPlist = setImagePickerInfoPlist;
+const withAndroidImagePickerPermissions = (config, { cameraPermission, microphonePermission } = {}) => {
+    if (microphonePermission !== false) {
+        config = config_plugins_1.AndroidConfig.Permissions.withPermissions(config, ['android.permission.RECORD_AUDIO']);
+    }
+    // If the user manually sets any of the permissions to `false`, then we should block the permissions to ensure no
+    // package can add them.
+    config = config_plugins_1.AndroidConfig.Permissions.withBlockedPermissions(config, [
+        microphonePermission === false && 'android.permission.RECORD_AUDIO',
+        cameraPermission === false && 'android.permission.CAMERA',
+    ].filter(Boolean));
+    // NOTE(EvanBacon): It's unclear if we should block the WRITE_EXTERNAL_STORAGE/READ_EXTERNAL_STORAGE permissions since
+    // they're used for many other things besides image picker.
+    return config;
 };
+exports.withAndroidImagePickerPermissions = withAndroidImagePickerPermissions;
 const withImagePicker = (config, { photosPermission, cameraPermission, microphonePermission } = {}) => {
-    if (!config.ios)
-        config.ios = {};
-    if (!config.ios.infoPlist)
-        config.ios.infoPlist = {};
-    config.ios.infoPlist.NSPhotoLibraryUsageDescription =
-        photosPermission || config.ios.infoPlist.NSPhotoLibraryUsageDescription || READ_PHOTOS_USAGE;
-    config.ios.infoPlist.NSCameraUsageDescription =
-        cameraPermission || config.ios.infoPlist.NSCameraUsageDescription || CAMERA_USAGE;
-    config.ios.infoPlist.NSMicrophoneUsageDescription =
-        microphonePermission || config.ios.infoPlist.NSMicrophoneUsageDescription || MICROPHONE_USAGE;
-    return (0, config_plugins_1.withPlugins)(config, [
-        [
-            config_plugins_1.AndroidConfig.Permissions.withPermissions,
-            [
-                'android.permission.CAMERA',
-                'android.permission.READ_EXTERNAL_STORAGE',
-                'android.permission.WRITE_EXTERNAL_STORAGE',
-                'android.permission.RECORD_AUDIO',
-            ],
-        ],
-        withImagePickerManifestActivity,
-    ]);
+    config = (0, config_plugins_1.withInfoPlist)(config, (config) => {
+        config.modResults = setImagePickerInfoPlist(config.modResults, {
+            photosPermission,
+            cameraPermission,
+            microphonePermission,
+        });
+        return config;
+    });
+    if (microphonePermission !== false) {
+        config = config_plugins_1.AndroidConfig.Permissions.withPermissions(config, ['android.permission.RECORD_AUDIO']);
+    }
+    // If the user manually sets any of the permissions to `false`, then we should block the permissions to ensure no
+    // package can add them.
+    config = config_plugins_1.AndroidConfig.Permissions.withBlockedPermissions(config, [
+        microphonePermission === false && 'android.permission.RECORD_AUDIO',
+        cameraPermission === false && 'android.permission.CAMERA',
+    ].filter(Boolean));
+    // NOTE(EvanBacon): It's unclear if we should block the WRITE_EXTERNAL_STORAGE/READ_EXTERNAL_STORAGE permissions since
+    // they're used for many other things besides image picker.
+    return config;
 };
 exports.default = (0, config_plugins_1.createRunOncePlugin)(withImagePicker, pkg.name, pkg.version);

package/plugin/src/withImagePicker.ts

@@ -1,9 +1,9 @@
 import {
+  AndroidConfig,
   ConfigPlugin,
   createRunOncePlugin,
-  withAndroidManifest,
-  withPlugins,
-  AndroidConfig,
+  InfoPlist,
+  withInfoPlist,
 } from '@expo/config-plugins';
 
 const pkg = require('expo-image-picker/package.json');
@@ -12,60 +12,92 @@ const CAMERA_USAGE = 'Allow $(PRODUCT_NAME) to access your camera';
 const MICROPHONE_USAGE = 'Allow $(PRODUCT_NAME) to access your microphone';
 const READ_PHOTOS_USAGE = 'Allow $(PRODUCT_NAME) to access your photos';
 
-export function setImagePickerManifestActivity(
-  androidManifest: AndroidConfig.Manifest.AndroidManifest
-): AndroidConfig.Manifest.AndroidManifest {
-  const app = AndroidConfig.Manifest.getMainApplicationOrThrow(androidManifest);
-  if (!app.activity) {
-    app.activity = [];
+type Props = {
+  photosPermission?: string | false;
+  cameraPermission?: string | false;
+  microphonePermission?: string | false;
+};
+
+export function setImagePickerInfoPlist(
+  infoPlist: InfoPlist,
+  { cameraPermission, microphonePermission, photosPermission }: Props
+): InfoPlist {
+  if (photosPermission === false) {
+    delete infoPlist.NSPhotoLibraryUsageDescription;
+  } else {
+    infoPlist.NSPhotoLibraryUsageDescription =
+      photosPermission || infoPlist.NSPhotoLibraryUsageDescription || READ_PHOTOS_USAGE;
   }
-  if (!app.activity.find(({ $ }) => $['android:name'] === 'com.canhub.cropper.CropImageActivity')) {
-    app.activity.push({
-      $: {
-        'android:name': 'com.canhub.cropper.CropImageActivity',
-        'android:theme': '@style/Base.Theme.AppCompat',
-      },
-    });
+  if (cameraPermission === false) {
+    delete infoPlist.NSCameraUsageDescription;
+  } else {
+    infoPlist.NSCameraUsageDescription =
+      cameraPermission || infoPlist.NSCameraUsageDescription || CAMERA_USAGE;
   }
-  return androidManifest;
+  if (microphonePermission === false) {
+    delete infoPlist.NSMicrophoneUsageDescription;
+  } else {
+    infoPlist.NSMicrophoneUsageDescription =
+      microphonePermission || infoPlist.NSMicrophoneUsageDescription || MICROPHONE_USAGE;
+  }
+  return infoPlist;
 }
 
-const withImagePickerManifestActivity: ConfigPlugin = (config) => {
-  // This plugin has no ability to remove the activity that it adds.
-  return withAndroidManifest(config, async (config) => {
-    config.modResults = setImagePickerManifestActivity(config.modResults);
+export const withAndroidImagePickerPermissions: ConfigPlugin<Props | void> = (
+  config,
+  { cameraPermission, microphonePermission } = {}
+) => {
+  if (microphonePermission !== false) {
+    config = AndroidConfig.Permissions.withPermissions(config, ['android.permission.RECORD_AUDIO']);
+  }
+
+  // If the user manually sets any of the permissions to `false`, then we should block the permissions to ensure no
+  // package can add them.
+  config = AndroidConfig.Permissions.withBlockedPermissions(
+    config,
+    [
+      microphonePermission === false && 'android.permission.RECORD_AUDIO',
+      cameraPermission === false && 'android.permission.CAMERA',
+    ].filter(Boolean) as string[]
+  );
+
+  // NOTE(EvanBacon): It's unclear if we should block the WRITE_EXTERNAL_STORAGE/READ_EXTERNAL_STORAGE permissions since
+  // they're used for many other things besides image picker.
+
+  return config;
+};
+
+const withImagePicker: ConfigPlugin<Props | void> = (
+  config,
+  { photosPermission, cameraPermission, microphonePermission } = {}
+) => {
+  config = withInfoPlist(config, (config) => {
+    config.modResults = setImagePickerInfoPlist(config.modResults, {
+      photosPermission,
+      cameraPermission,
+      microphonePermission,
+    });
     return config;
   });
-};
 
-const withImagePicker: ConfigPlugin<
-  {
-    photosPermission?: string;
-    cameraPermission?: string;
-    microphonePermission?: string;
-  } | void
-> = (config, { photosPermission, cameraPermission, microphonePermission } = {}) => {
-  if (!config.ios) config.ios = {};
-  if (!config.ios.infoPlist) config.ios.infoPlist = {};
-  config.ios.infoPlist.NSPhotoLibraryUsageDescription =
-    photosPermission || config.ios.infoPlist.NSPhotoLibraryUsageDescription || READ_PHOTOS_USAGE;
-  config.ios.infoPlist.NSCameraUsageDescription =
-    cameraPermission || config.ios.infoPlist.NSCameraUsageDescription || CAMERA_USAGE;
-  config.ios.infoPlist.NSMicrophoneUsageDescription =
-    microphonePermission || config.ios.infoPlist.NSMicrophoneUsageDescription || MICROPHONE_USAGE;
+  if (microphonePermission !== false) {
+    config = AndroidConfig.Permissions.withPermissions(config, ['android.permission.RECORD_AUDIO']);
+  }
 
-  return withPlugins(config, [
+  // If the user manually sets any of the permissions to `false`, then we should block the permissions to ensure no
+  // package can add them.
+  config = AndroidConfig.Permissions.withBlockedPermissions(
+    config,
     [
-      AndroidConfig.Permissions.withPermissions,
-      [
-        'android.permission.CAMERA',
-        'android.permission.READ_EXTERNAL_STORAGE',
-        'android.permission.WRITE_EXTERNAL_STORAGE',
-        'android.permission.RECORD_AUDIO',
-      ],
-    ],
-    withImagePickerManifestActivity,
-  ]);
+      microphonePermission === false && 'android.permission.RECORD_AUDIO',
+      cameraPermission === false && 'android.permission.CAMERA',
+    ].filter(Boolean) as string[]
+  );
+
+  // NOTE(EvanBacon): It's unclear if we should block the WRITE_EXTERNAL_STORAGE/READ_EXTERNAL_STORAGE permissions since
+  // they're used for many other things besides image picker.
+
+  return config;
 };
 
 export default createRunOncePlugin(withImagePicker, pkg.name, pkg.version);