expo-document-picker 10.0.0 → 10.1.0

package/CHANGELOG.md

@@ -10,6 +10,16 @@
 
 ### 💡 Others
 
+## 10.1.0 — 2021-12-03
+
+### 🎉 New features
+
+- [plugin] Added `iCloudContainerEnvironment` prop for setting the `com.apple.developer.icloud-container-environment` entitlement ([#14885](https://github.com/expo/expo/pull/14885) by [@EvanBacon](https://github.com/EvanBacon))
+
+## 10.0.1 — 2021-10-01
+
+_This version does not introduce any user-facing changes._
+
 ## 10.0.0 — 2021-09-28
 
 ### 🛠 Breaking changes

package/README.md

@@ -13,7 +13,7 @@ For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-
 
 # Installation in bare React Native projects
 
-For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/expo/expo/tree/master/packages/react-native-unimodules) before continuing.
+For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
 
 ### Add the package to your npm dependencies
 

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven'
 
 group = 'host.exp.exponent'
-version = '10.0.0'
+version = '10.1.0'
 
 buildscript {
   // Simple helper that allows the root project to override versions declared by this library.
@@ -61,7 +61,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 30)
     versionCode 17
-    versionName '10.0.0'
+    versionName '10.1.0'
   }
   lintOptions {
     abortOnError false

package/build/types.d.ts

@@ -6,7 +6,7 @@ export declare type DocumentPickerOptions = {
      * The [MIME type(s)](https://en.wikipedia.org/wiki/Media_type) of the documents that are available
      * to be picked. Is also supports wildcards like `'image/*'` to choose any image. To allow any type
      * of document you can use `'*/*'`.
-     * @default `'*/*'`
+     * @default '*/*'
      */
     type?: string | string[];
     /**
@@ -14,12 +14,13 @@ export declare type DocumentPickerOptions = {
      * which allows other Expo APIs to read the file immediately. This may impact performance for
      * large files, so you should consider setting this to `false` if you expect users to pick
      * particularly large files and your app does not need immediate read access.
-     * @default `true`
+     * @default true
      */
     copyToCacheDirectory?: boolean;
     /**
-     * __Web Only.__ Allows multiple files to be selected from the system UI.
-     * @default `false`
+     * Allows multiple files to be selected from the system UI.
+     * @default false
+     * @platform web
      */
     multiple?: boolean;
 };

package/build/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["// @needsAudit\n/**\n *\n */\nexport type DocumentPickerOptions = {\n  /**\n   * The [MIME type(s)](https://en.wikipedia.org/wiki/Media_type) of the documents that are available\n   * to be picked. Is also supports wildcards like `'image/*'` to choose any image. To allow any type\n   * of document you can use `'*/*'`.\n   * @default `'*/*'`\n   */\n  type?: string | string[];\n  /**\n   * If `true`, the picked file is copied to [`FileSystem.CacheDirectory`](filesystem.md#filesystemcachedirectory),\n   * which allows other Expo APIs to read the file immediately. This may impact performance for\n   * large files, so you should consider setting this to `false` if you expect users to pick\n   * particularly large files and your app does not need immediate read access.\n   * @default `true`\n   */\n  copyToCacheDirectory?: boolean;\n  /**\n   * __Web Only.__ Allows multiple files to be selected from the system UI.\n   * @default `false`\n   */\n  multiple?: boolean;\n};\n\n// @needsAudit @docsMissing\nexport type DocumentResult =\n  | { type: 'cancel' }\n  | {\n      type: 'success';\n      /**\n       * Document original name.\n       */\n      name: string;\n      /**\n       * Document size in bytes.\n       */\n      size?: number;\n      /**\n       * An URI to the local document file.\n       */\n      uri: string;\n      /**\n       * Document MIME type.\n       */\n      mimeType?: string;\n      lastModified?: number;\n      file?: File;\n      output?: FileList | null;\n    };\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["// @needsAudit\n/**\n *\n */\nexport type DocumentPickerOptions = {\n  /**\n   * The [MIME type(s)](https://en.wikipedia.org/wiki/Media_type) of the documents that are available\n   * to be picked. Is also supports wildcards like `'image/*'` to choose any image. To allow any type\n   * of document you can use `'*/*'`.\n   * @default '*/*'\n   */\n  type?: string | string[];\n  /**\n   * If `true`, the picked file is copied to [`FileSystem.CacheDirectory`](filesystem.md#filesystemcachedirectory),\n   * which allows other Expo APIs to read the file immediately. This may impact performance for\n   * large files, so you should consider setting this to `false` if you expect users to pick\n   * particularly large files and your app does not need immediate read access.\n   * @default true\n   */\n  copyToCacheDirectory?: boolean;\n  /**\n   * Allows multiple files to be selected from the system UI.\n   * @default false\n   * @platform web\n   */\n  multiple?: boolean;\n};\n\n// @needsAudit @docsMissing\nexport type DocumentResult =\n  | { type: 'cancel' }\n  | {\n      type: 'success';\n      /**\n       * Document original name.\n       */\n      name: string;\n      /**\n       * Document size in bytes.\n       */\n      size?: number;\n      /**\n       * An URI to the local document file.\n       */\n      uri: string;\n      /**\n       * Document MIME type.\n       */\n      mimeType?: string;\n      lastModified?: number;\n      file?: File;\n      output?: FileList | null;\n    };\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-document-picker",
-  "version": "10.0.0",
+  "version": "10.1.0",
   "description": "Provides access to the system's UI for selecting documents from the available providers on the user's device.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -32,15 +32,17 @@
   "license": "MIT",
   "homepage": "https://docs.expo.dev/versions/latest/sdk/document-picker/",
   "jest": {
-    "preset": "expo-module-scripts/ios"
+    "preset": "expo-module-scripts"
   },
   "dependencies": {
-    "@expo/config-plugins": "^3.1.0",
-    "expo-modules-core": "~0.4.0",
+    "@expo/config-plugins": "^4.0.2",
     "uuid": "^3.3.2"
   },
   "devDependencies": {
     "expo-module-scripts": "^2.0.0"
   },
-  "gitHead": "1fffde73411ee7a642b98f1506a8de921805d52b"
+  "peerDependencies": {
+    "expo": "*"
+  },
+  "gitHead": "2e5c6983b86d5ecfca028ba64002897d8adc2cc4"
 }

package/plugin/build/withDocumentPicker.d.ts

@@ -1,5 +1,4 @@
 import { ConfigPlugin } from '@expo/config-plugins';
-declare const _default: ConfigPlugin<void | {
-    appleTeamId?: string | undefined;
-}>;
+import { IosProps } from './withDocumentPickerIOS';
+declare const _default: ConfigPlugin<void | IosProps>;
 export default _default;

package/plugin/build/withDocumentPicker.js

@@ -4,7 +4,7 @@ const config_plugins_1 = require("@expo/config-plugins");
 const withDocumentPickerIOS_1 = require("./withDocumentPickerIOS");
 const pkg = require('expo-document-picker/package.json');
 const withDocumentPicker = (config, { appleTeamId = process.env.EXPO_APPLE_TEAM_ID } = {}) => {
-    config = withDocumentPickerIOS_1.withDocumentPickerIOS(config, { appleTeamId });
+    config = (0, withDocumentPickerIOS_1.withDocumentPickerIOS)(config, { appleTeamId });
     return config;
 };
-exports.default = config_plugins_1.createRunOncePlugin(withDocumentPicker, pkg.name, pkg.version);
+exports.default = (0, config_plugins_1.createRunOncePlugin)(withDocumentPicker, pkg.name, pkg.version);

package/plugin/build/withDocumentPickerIOS.d.ts

@@ -1,6 +1,14 @@
 import { ConfigPlugin } from '@expo/config-plugins';
 import { ExpoConfig } from '@expo/config-types';
-export declare const withDocumentPickerIOS: ConfigPlugin<{
+export declare type IosProps = {
     appleTeamId?: string;
-}>;
-export declare function setICloudEntitlments(config: Pick<ExpoConfig, 'ios'>, appleTeamId: string, entitlements: Record<string, any>): Record<string, any>;
+    /**
+     * Sets the `com.apple.developer.icloud-container-environment` entitlement which is read by EAS CLI to set
+     * the `iCloudContainerEnvironment` in the `xcodebuild` `exportOptionsPlist`.
+     *
+     * Available options: https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_icloud-container-environment
+     */
+    iCloudContainerEnvironment?: 'Development' | 'Production';
+};
+export declare const withDocumentPickerIOS: ConfigPlugin<IosProps>;
+export declare function setICloudEntitlements(config: Pick<ExpoConfig, 'ios'>, { appleTeamId, iCloudContainerEnvironment }: IosProps, { 'com.apple.developer.icloud-container-environment': _env, ...entitlements }: Record<string, any>): Record<string, any>;

package/plugin/build/withDocumentPickerIOS.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setICloudEntitlments = exports.withDocumentPickerIOS = void 0;
+exports.setICloudEntitlements = exports.withDocumentPickerIOS = void 0;
 const config_plugins_1 = require("@expo/config-plugins");
-const withDocumentPickerIOS = (config, { appleTeamId }) => {
-    return config_plugins_1.withEntitlementsPlist(config, (config) => {
+const withDocumentPickerIOS = (config, { appleTeamId, iCloudContainerEnvironment }) => {
+    return (0, config_plugins_1.withEntitlementsPlist)(config, (config) => {
         if (appleTeamId) {
-            config.modResults = setICloudEntitlments(config, appleTeamId, config.modResults);
+            config.modResults = setICloudEntitlements(config, { appleTeamId, iCloudContainerEnvironment }, config.modResults);
         }
         else {
             config_plugins_1.WarningAggregator.addWarningIOS('expo-document-picker', 'Cannot configure iOS entitlements because neither the appleTeamId property, nor the environment variable EXPO_APPLE_TEAM_ID were defined.');
@@ -14,9 +14,12 @@ const withDocumentPickerIOS = (config, { appleTeamId }) => {
     });
 };
 exports.withDocumentPickerIOS = withDocumentPickerIOS;
-function setICloudEntitlments(config, appleTeamId, entitlements) {
+function setICloudEntitlements(config, { appleTeamId, iCloudContainerEnvironment }, { 'com.apple.developer.icloud-container-environment': _env, ...entitlements }) {
     var _a;
     if ((_a = config.ios) === null || _a === void 0 ? void 0 : _a.usesIcloudStorage) {
+        // Used for AdHoc iOS builds: https://github.com/expo/eas-cli/issues/693
+        // https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_icloud-container-environment
+        entitlements['com.apple.developer.icloud-container-environment'] = iCloudContainerEnvironment;
         entitlements['com.apple.developer.icloud-container-identifiers'] = [
             'iCloud.' + config.ios.bundleIdentifier,
         ];
@@ -29,4 +32,4 @@ function setICloudEntitlments(config, appleTeamId, entitlements) {
     }
     return entitlements;
 }
-exports.setICloudEntitlments = setICloudEntitlments;
+exports.setICloudEntitlements = setICloudEntitlements;

package/plugin/src/withDocumentPicker.ts

@@ -1,10 +1,10 @@
 import { ConfigPlugin, createRunOncePlugin } from '@expo/config-plugins';
 
-import { withDocumentPickerIOS } from './withDocumentPickerIOS';
+import { withDocumentPickerIOS, IosProps } from './withDocumentPickerIOS';
 
 const pkg = require('expo-document-picker/package.json');
 
-const withDocumentPicker: ConfigPlugin<{ appleTeamId?: string } | void> = (
+const withDocumentPicker: ConfigPlugin<IosProps | void> = (
   config,
   { appleTeamId = process.env.EXPO_APPLE_TEAM_ID } = {}
 ) => {

package/plugin/src/withDocumentPickerIOS.ts

@@ -1,13 +1,28 @@
 import { ConfigPlugin, WarningAggregator, withEntitlementsPlist } from '@expo/config-plugins';
 import { ExpoConfig } from '@expo/config-types';
 
-export const withDocumentPickerIOS: ConfigPlugin<{ appleTeamId?: string }> = (
+export type IosProps = {
+  appleTeamId?: string;
+  /**
+   * Sets the `com.apple.developer.icloud-container-environment` entitlement which is read by EAS CLI to set
+   * the `iCloudContainerEnvironment` in the `xcodebuild` `exportOptionsPlist`.
+   *
+   * Available options: https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_icloud-container-environment
+   */
+  iCloudContainerEnvironment?: 'Development' | 'Production';
+};
+
+export const withDocumentPickerIOS: ConfigPlugin<IosProps> = (
   config,
-  { appleTeamId }
+  { appleTeamId, iCloudContainerEnvironment }
 ) => {
   return withEntitlementsPlist(config, (config) => {
     if (appleTeamId) {
-      config.modResults = setICloudEntitlments(config, appleTeamId, config.modResults);
+      config.modResults = setICloudEntitlements(
+        config,
+        { appleTeamId, iCloudContainerEnvironment },
+        config.modResults
+      );
     } else {
       WarningAggregator.addWarningIOS(
         'expo-document-picker',
@@ -18,12 +33,16 @@ export const withDocumentPickerIOS: ConfigPlugin<{ appleTeamId?: string }> = (
   });
 };
 
-export function setICloudEntitlments(
+export function setICloudEntitlements(
   config: Pick<ExpoConfig, 'ios'>,
-  appleTeamId: string,
-  entitlements: Record<string, any>
+  { appleTeamId, iCloudContainerEnvironment }: IosProps,
+  { 'com.apple.developer.icloud-container-environment': _env, ...entitlements }: Record<string, any>
 ): Record<string, any> {
   if (config.ios?.usesIcloudStorage) {
+    // Used for AdHoc iOS builds: https://github.com/expo/eas-cli/issues/693
+    // https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_icloud-container-environment
+    entitlements['com.apple.developer.icloud-container-environment'] = iCloudContainerEnvironment;
+
     entitlements['com.apple.developer.icloud-container-identifiers'] = [
       'iCloud.' + config.ios.bundleIdentifier,
     ];

package/src/types.ts

@@ -7,7 +7,7 @@ export type DocumentPickerOptions = {
    * The [MIME type(s)](https://en.wikipedia.org/wiki/Media_type) of the documents that are available
    * to be picked. Is also supports wildcards like `'image/*'` to choose any image. To allow any type
    * of document you can use `'*/*'`.
-   * @default `'*/*'`
+   * @default '*/*'
    */
   type?: string | string[];
   /**
@@ -15,12 +15,13 @@ export type DocumentPickerOptions = {
    * which allows other Expo APIs to read the file immediately. This may impact performance for
    * large files, so you should consider setting this to `false` if you expect users to pick
    * particularly large files and your app does not need immediate read access.
-   * @default `true`
+   * @default true
    */
   copyToCacheDirectory?: boolean;
   /**
-   * __Web Only.__ Allows multiple files to be selected from the system UI.
-   * @default `false`
+   * Allows multiple files to be selected from the system UI.
+   * @default false
+   * @platform web
    */
   multiple?: boolean;
 };