@react-native-documents/picker 9.3.1

package/src/fileTypes.ts

@@ -0,0 +1,92 @@
+import { Platform } from 'react-native'
+
+// TODO split this into platform-specific files, and / or topic-specific files
+
+const mimeTypes = Object.freeze({
+  allFiles: '*/*',
+  audio: 'audio/*',
+  csv: ['text/csv', 'text/comma-separated-values'],
+  doc: 'application/msword',
+  docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+  images: 'image/*',
+  pdf: 'application/pdf',
+  plainText: 'text/plain',
+  json: 'application/json',
+  ppt: 'application/vnd.ms-powerpoint',
+  pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+  video: 'video/*',
+  xls: 'application/vnd.ms-excel',
+  xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+  zip: 'application/zip',
+} as const) //satisfies TypeOfFileTypes
+
+const utis = Object.freeze({
+  allFiles: 'public.item',
+  audio: 'public.audio',
+  csv: 'public.comma-separated-values-text',
+  doc: 'com.microsoft.word.doc',
+  docx: 'org.openxmlformats.wordprocessingml.document',
+  images: 'public.image',
+  pdf: 'com.adobe.pdf',
+  plainText: 'public.plain-text',
+  json: 'public.json',
+  ppt: 'com.microsoft.powerpoint.ppt',
+  pptx: 'org.openxmlformats.presentationml.presentation',
+  video: 'public.movie',
+  xls: 'com.microsoft.excel.xls',
+  xlsx: 'org.openxmlformats.spreadsheetml.sheet',
+  zip: 'public.zip-archive',
+} as const) // satisfies TypeOfFileTypes
+
+const perPlatformTypes = {
+  android: mimeTypes,
+  ios: utis,
+  // unsupported, but added to make TS happy
+  macos: utis,
+  windows: mimeTypes,
+  web: mimeTypes,
+}
+
+/**
+ * @hidden
+ * */
+export const types = perPlatformTypes[Platform.OS]
+
+type ValuesOf<T> = T[keyof T]
+type Flatten<T> = T extends Array<infer U> ? U : T
+
+type AllMimeTypes = Flatten<ValuesOf<typeof mimeTypes>>
+type AllAppleUTIs = ValuesOf<typeof utis>
+
+/**
+ * You'd rarely use this type directly.
+ * It represents the predefined file types which are exported as `types` and can be used to limit the kinds of files that can be picked.
+ *
+ * @example
+ * ```ts
+ * import {
+ *   pick,
+ *   types,
+ * } from '@react-native-documents/picker'
+ * // ...
+ * const result = await pick({
+ *   type: [types.pdf, types.docx],
+ * })
+ * ```
+ * */
+export type PredefinedFileTypes = Flatten<AllMimeTypes> | AllAppleUTIs
+
+// export type PlatformTypes = typeof perPlatformTypes
+
+// ensure shapes of platformTypes are the same: https://stackoverflow.com/a/67027347/2070942
+// let me know if there's a nicer way
+
+type AssertEqualKeys<T1 extends object, T2 extends object> = [
+  keyof T1 extends keyof T2 ? 1 : 0,
+  keyof T2 extends keyof T1 ? 1 : 0,
+] extends [1, 1]
+  ? true
+  : false
+
+const mimesAndUtisAreEqual: AssertEqualKeys<typeof mimeTypes, typeof utis> = true
+export const typesAreEqual = mimesAndUtisAreEqual

package/src/index.ts

@@ -0,0 +1,47 @@
+export { isKnownType, type IsKnownTypeResponse, type IsKnownTypeOptions } from './isKnownType'
+export {
+  keepLocalCopy,
+  type KeepLocalCopyOptions,
+  type KeepLocalCopyResponse,
+  type FileToCopy,
+} from './keepLocalCopy'
+
+// TODO expose from /fileTypes?
+export { types, type PredefinedFileTypes } from './fileTypes'
+export { errorCodes, isErrorWithCode } from './errors'
+export { pickDirectory } from './pickDirectory'
+export type {
+  PickDirectoryResponse,
+  DirectoryPickerOptions,
+  DirectoryPickerOptionsLongTerm,
+  DirectoryPickerResponse,
+  DirectoryPickerResponseLongTerm,
+  DirectoryPickerOptionsBase,
+} from './pickDirectory'
+export { pick, type DocumentPickerOptionsBase } from './pick'
+export {
+  saveDocuments,
+  type SaveDocumentsResponse,
+  type SaveDocumentsOptions,
+} from './saveDocuments'
+export type {
+  NonEmptyArray,
+  TransitionStyle,
+  BookmarkingResponse,
+  DocumentPickerResponse,
+  PresentationStyle,
+  VirtualFileMeta,
+} from './types'
+export type {
+  DocumentPickerOptions,
+  DocumentPickerOptionsImport,
+  DocumentPickerOptionsOpenOnce,
+  DocumentPickerOptionsOpenLongTerm,
+  DocumentPickerResponseOpenLongTerm,
+} from './pick'
+export type { LocalCopyResponse } from './spec/NativeDocumentPicker'
+export {
+  releaseLongTermAccess,
+  releaseSecureAccess,
+  type ReleaseLongTermAccessResult,
+} from './release'

package/src/isKnownType.ts

@@ -0,0 +1,48 @@
+import { NativeDocumentPicker } from './spec/NativeDocumentPicker'
+
+/**
+ * The result of calling {@link isKnownType}
+ * */
+export type IsKnownTypeResponse = {
+  /**
+   * On iOS, this is true if the type is known to the device. That means it can be used with the document picker to filter what files can be picked.
+   * On Android, this is true if the internal mime type database contains the given value.
+   * */
+  isKnown: boolean
+  /**
+   * the preferred filename extension for the given value, if any
+   * */
+  preferredFilenameExtension: string | null
+  /**
+   * the mime type for the given value, if any
+   * */
+  mimeType: string | null
+  /**
+   * the UTType identifier for the given value, if any
+   * */
+  UTType: string | null
+}
+
+export type IsKnownTypeOptions = {
+  /**
+   * the kind of value you're passing
+   * */
+  kind: 'UTType' | 'mimeType' | 'extension'
+  /**
+   * the value you're checking, for example: application/pdf, com.adobe.pdf, pdf
+   * */
+  value: string
+}
+
+/**
+ *
+ * Checks if the given value (which can be a file extension, UTType identifier or mime) is known to the system.
+ * Also returns the mime type which you can use to filter files on Android.
+ *
+ * @group DocumentPicker
+ * */
+export function isKnownType(options: IsKnownTypeOptions): IsKnownTypeResponse {
+  const { kind, value } = options
+  const result = NativeDocumentPicker.isKnownType(kind, value) as IsKnownTypeResponse
+  return result
+}

package/src/keepLocalCopy.ts

@@ -0,0 +1,51 @@
+import type { NonEmptyArray } from './types'
+import { type LocalCopyResponse, NativeDocumentPicker } from './spec/NativeDocumentPicker'
+
+/**
+ * Parameter of {@link keepLocalCopy}. Object type representing the file(s) whose copy should be kept in the app's storage.
+ * */
+export type FileToCopy = {
+  /**
+   * The uri to keep a local copy of. This would be a `content://` uri (Android), or a `file://` uri (iOS) that the user has previously picked.
+   * */
+  uri: string
+  /**
+   * The name of the resulting file, with the file extension. You can use the `name` field from the response of the `pick()` method.
+   *
+   * Example: someFile.pdf
+   *
+   * */
+  fileName: string
+  /**
+   * Only for Android virtual files: the type of the file to export to. For example, `application/pdf` or `text/plain`.
+   * Use one of the values from `convertibleToMimeTypes` from the response of the `pick()` method: {@link DocumentPickerResponse}.
+   * */
+  convertVirtualFileToType?: string
+}
+/**
+ * options for {@link keepLocalCopy}
+ *
+ * */
+export type KeepLocalCopyOptions = {
+  files: NonEmptyArray<FileToCopy>
+  destination: 'cachesDirectory' | 'documentDirectory'
+}
+
+/**
+ * Result of the call to {@link keepLocalCopy}. Please note the promise always resolves, even if there was an error processing any uri(s) (as indicated by the `status` field, and `copyError` field).
+ * */
+export type KeepLocalCopyResponse = NonEmptyArray<LocalCopyResponse>
+
+/**
+ * Makes the file available in the app's storage. The behavior is different on iOS and Android, and for simple use cases (such as uploading file to remote server), you may not need to call this method at all.
+ *
+ * On Android, it can be used to "convert" a `content://` Uri into a local file. It also "exports" virtual files (such as Google docs or sheets) into local files.
+ *
+ * However, note that for some use cases, such as uploading the picked file to a server, you may not need to call `keepLocalCopy` at all. React Native's `fetch` can handle `content://` uris.
+ *
+ * @group DocumentPicker
+ * */
+export function keepLocalCopy(options: KeepLocalCopyOptions): Promise<KeepLocalCopyResponse> {
+  const response = NativeDocumentPicker.keepLocalCopy(options)
+  return response as Promise<KeepLocalCopyResponse>
+}

package/src/pick.ts

@@ -0,0 +1,151 @@
+import { NativeDocumentPicker } from './spec/NativeDocumentPicker'
+
+import { PredefinedFileTypes, types } from './fileTypes'
+import type {
+  BookmarkingResponse,
+  DocumentPickerResponse,
+  NonEmptyArray,
+  TransitionStyle,
+  PresentationStyle,
+} from './types'
+import { Platform } from 'react-native'
+import { safeValidate } from './validateTypes'
+
+/**
+ * Base options object for the document picker.
+ * You'd rarely use this type directly, but instead use one of
+ *
+ * {@link DocumentPickerOptionsImport}, {@link DocumentPickerOptionsOpenOnce} or {@link DocumentPickerOptionsOpenLongTerm}
+ *
+ * which extend this type
+ * @group pick() types
+ */
+export type DocumentPickerOptionsBase = {
+  /**
+   * Specify file type(s) that you want to pick. Use `types` for some predefined values.
+   * */
+  type?: string | PredefinedFileTypes | Array<PredefinedFileTypes | string>
+
+  // TODO: implement these
+  // initialDirectoryUrl?: string
+  // showFileExtensions?: boolean
+  // localOnly?: boolean
+  /**
+   * Whether to allow multiple files to be picked. False by default.
+   * */
+  allowMultiSelection?: boolean
+  // allowVirtualFiles is available for ACTION_OPEN_DOCUMENT only (or so it seems)
+  // https://developer.android.com/reference/android/content/Intent#ACTION_OPEN_DOCUMENT
+  // https://developer.android.com/reference/android/content/Intent#ACTION_GET_CONTENT
+  /**
+   * Android only - Whether to allow virtual files (such as Google docs or sheets) to be picked. False by default.
+   * */
+  allowVirtualFiles?: boolean
+  /**
+   * iOS only - Controls how the picker is presented, e.g. on an iPad you may want to present it fullscreen. Defaults to `pageSheet`.
+   * */
+  presentationStyle?: PresentationStyle
+  /**
+   * iOS only - Configures the transition style of the picker. Defaults to coverVertical, when the picker is presented, its view slides up from the bottom of the screen.
+   * */
+  transitionStyle?: TransitionStyle
+}
+
+/**
+ * Present the document picker in import mode.
+ *
+ * @group pick() types
+ */
+export type DocumentPickerOptionsImport = DocumentPickerOptionsBase & {
+  mode?: 'import'
+  requestLongTermAccess?: never
+}
+/**
+ * Present the document picker in open mode, with permissions to access the file for a limited time (until the app terminates).
+ *
+ * @group pick() types
+ */
+export type DocumentPickerOptionsOpenOnce = DocumentPickerOptionsBase & {
+  mode: 'open'
+  requestLongTermAccess?: false
+}
+/**
+ * Present the document picker in open mode, with long-term permissions to access the opened file.
+ *
+ * @group pick() types
+ */
+export type DocumentPickerOptionsOpenLongTerm = DocumentPickerOptionsBase & {
+  mode: 'open'
+  requestLongTermAccess: true
+}
+
+type DocumentPickerOptionsOpen = DocumentPickerOptionsOpenOnce | DocumentPickerOptionsOpenLongTerm
+/**
+ * @hidden
+ */
+export type DocumentPickerOptions = DocumentPickerOptionsImport | DocumentPickerOptionsOpen
+
+/**
+ * The result of calling {@link pick} with `mode: 'open'` and `requestLongTermAccess: true`
+ *
+ * @group pick() types
+ */
+export type DocumentPickerResponseOpenLongTerm = DocumentPickerResponse & BookmarkingResponse
+
+// TODO not entirely sure this is a good idea but let's try
+type PickResponse<O extends DocumentPickerOptions> = Promise<
+  O extends DocumentPickerOptionsOpenLongTerm
+    ? NonEmptyArray<DocumentPickerResponseOpenLongTerm>
+    : NonEmptyArray<DocumentPickerResponse>
+>
+
+type DoPickOptions = DocumentPickerOptionsBase & { mode: 'import' | 'open'; type: string[] }
+
+/**
+ * The method for picking a file, both for `import` and `open` modes.
+ *
+ * For result types, see {@link DocumentPickerResponse} or {@link DocumentPickerResponseOpenLongTerm}.
+ *
+ * For options, see {@link DocumentPickerOptionsImport}, {@link DocumentPickerOptionsOpenOnce} or {@link DocumentPickerOptionsOpenLongTerm}.
+ *
+ * @group DocumentPicker
+ * */
+export async function pick<O extends DocumentPickerOptions>(options?: O): PickResponse<O> {
+  const type: string[] = (() => {
+    if (!options?.type) {
+      return [types.allFiles]
+    }
+    const newType = Array.isArray(options.type) ? options.type : [options.type]
+    return newType.flat().map((it) => it.trim())
+  })()
+  const newOpts: DoPickOptions = {
+    mode: 'import',
+    // allowMultiSelection must be false to maintain old (v5) behavior
+    allowMultiSelection: false,
+    allowVirtualFiles: false,
+    ...options,
+    type,
+  }
+
+  if (!newOpts.type.every((it: unknown) => typeof it === 'string')) {
+    throw new TypeError(
+      `Unexpected type option in ${newOpts.type}, did you try using a DocumentPicker.types.* that does not exist?`,
+    )
+  }
+
+  if ('mode' in newOpts && !['import', 'open'].includes(newOpts.mode)) {
+    throw new TypeError('Invalid mode option: ' + newOpts.mode)
+  }
+
+  const response: Promise<DocumentPickerResponse[]> = NativeDocumentPicker.pick(newOpts)
+  const awaitedResult = await response
+  for (const res of awaitedResult) {
+    if (Platform.OS === 'android') {
+      res.hasRequestedType = safeValidate(newOpts.type, res)
+    } else {
+      res.hasRequestedType = true
+    }
+  }
+
+  return awaitedResult as unknown as PickResponse<O>
+}

package/src/pickDirectory.ts

@@ -0,0 +1,93 @@
+import { BookmarkingResponse, PresentationStyle, type TransitionStyle } from './types'
+import { Platform } from 'react-native'
+import { NativeDocumentPicker } from './spec/NativeDocumentPicker'
+
+/**
+ * Base options object for the directory picker. They only slightly influence the appearance of the picker modal on iOS.
+ * You'd rarely use this type directly, but instead use {@link DirectoryPickerOptions}
+ *
+ * which extend this type
+ * @group pickDirectory() types
+ */
+export type DirectoryPickerOptionsBase = {
+  /**
+   * iOS only - Controls how the picker is presented, e.g. on an iPad you may want to present it fullscreen. Defaults to `pageSheet`.
+   * */
+  presentationStyle?: PresentationStyle
+  /**
+   * iOS only - Configures the transition style of the picker. Defaults to coverVertical, when the picker is presented, its view slides up from the bottom of the screen.
+   * */
+  transitionStyle?: TransitionStyle
+}
+/**
+ * @hidden
+ * */
+export type DirectoryPickerOptionsLongTerm = DirectoryPickerOptionsBase & {
+  requestLongTermAccess: true
+}
+/**
+ * Options for {@link pickDirectory}.
+ *
+ * @group pickDirectory() types
+ * */
+export type DirectoryPickerOptions = DirectoryPickerOptionsBase & { requestLongTermAccess: boolean }
+
+/**
+ * This object represents the response from the directory picker, when long-term access was not requested.
+ *
+ * @group pickDirectory() types
+ * */
+export type DirectoryPickerResponse = {
+  /**
+   * The (percent-encoded) directory selected by user.
+   * */
+  uri: string
+}
+/**
+ * This object represents the response from the directory picker, when long-term access was requested.
+ *
+ * @group pickDirectory() types
+ * */
+export type DirectoryPickerResponseLongTerm = DirectoryPickerResponse & BookmarkingResponse
+
+// TODO not entirely sure this is a good idea but let's try
+/**
+ * You likely won't use this type directly, but instead use {@link DirectoryPickerResponse} or {@link DirectoryPickerResponseLongTerm}.
+ *
+ * @group pickDirectory() types
+ * */
+export type PickDirectoryResponse<O extends DirectoryPickerOptions> = Promise<
+  O extends DirectoryPickerOptionsLongTerm
+    ? DirectoryPickerResponseLongTerm
+    : DirectoryPickerResponse
+>
+
+/**
+ * Opens a directory picker.
+ *
+ * @group DocumentPicker
+ * */
+export async function pickDirectory<O extends DirectoryPickerOptions>(
+  options?: O,
+): PickDirectoryResponse<O> {
+  const optionsOverride = (() => {
+    if (Platform.OS === 'ios') {
+      return {
+        ...options,
+        mode: 'open',
+        allowMultiSelection: false,
+        type: ['public.folder'],
+      }
+    } else {
+      return {
+        // technically, "mode" is ignored here, and we shouldn't need to specify anything but the PickOptions data class
+        // requires mode to be set
+        mode: 'open',
+        ...options,
+      }
+    }
+  })()
+  return NativeDocumentPicker.pickDirectory(optionsOverride) as unknown as Promise<
+    PickDirectoryResponse<O>
+  >
+}

package/src/release.ts

@@ -0,0 +1,36 @@
+import { NativeDocumentPicker } from './spec/NativeDocumentPicker'
+
+/**
+ * For each uri whose release was requested, the result will contain an object with the uri and a status.
+ * */
+export type ReleaseLongTermAccessResult = Array<
+  | {
+      uri: string
+      status: 'success'
+    }
+  | {
+      uri: string
+      status: 'error'
+      errorMessage: string
+    }
+>
+
+/**
+ * Android only - Releases long-term access to the given URIs. There's no need to call this method on iOS - there's no iOS equivalent.
+ *
+ * See [Android documentation](https://developer.android.com/reference/android/content/ContentResolver#releasePersistableUriPermission(android.net.Uri,%20int)) for more information.
+ */
+export const releaseLongTermAccess = async (
+  uris: string[],
+): Promise<ReleaseLongTermAccessResult> => {
+  return NativeDocumentPicker.releaseLongTermAccess(uris) as Promise<ReleaseLongTermAccessResult>
+}
+
+/**
+ * iOS only - Releases (stops) secure access to the given URIs. Use with URIs obtained with Open mode or with the Directory Picker.
+ * See [iOS documentation](https://developer.apple.com/documentation/foundation/nsurl/1413736-stopaccessingsecurityscopedresou) for more information.
+ * There's no need to call this method on Android - there's no equivalent method on Android.
+ * */
+export const releaseSecureAccess = async (uris: string[]): Promise<null> => {
+  return NativeDocumentPicker.releaseSecureAccess(uris)
+}

package/src/saveDocuments.ts

@@ -0,0 +1,99 @@
+import { NativeDocumentPicker } from './spec/NativeDocumentPicker'
+
+import type { DocumentPickerResponse, NonEmptyArray } from './types'
+import { Platform } from 'react-native'
+
+/**
+ * Options object for the {@link saveDocuments} method. `sourceUris` is the only required field.
+ *
+ * @group saveDocuments() types
+ */
+export type SaveDocumentsOptions = {
+  /**
+   * The source URIs of the files to save, percentage-encoded. Android only allows to save one file at a time, iOS allows multiple.
+   * */
+  sourceUris: string[]
+  /**
+   * Android-only: The MIME type of the file to be stored.
+   * It is recommended to provide this value, otherwise the system will try to infer it from the sourceUri using ContentResolver.
+   * */
+  mimeType?: string
+  /**
+   * Android-only: The suggested title of the file to be stored, which will be pre-filled in the UI.
+   * On iOS, the target name is taken from the source uri, and is changeable only when exactly one file is being saved.
+   * */
+  fileName?: string
+  /**
+   * iOS-only: Whether to copy the file to a new location, or move it (default).
+   * On Android, file is always copied.
+   * */
+  copy?: boolean
+  // initialUri?: string
+}
+
+/**
+ * The result of calling {@link saveDocuments}. It is very unlikely that the metadata fields would be `null`, but in theory, it can happen.
+ *
+ * @group saveDocuments() types
+ */
+export type SaveDocumentsResponse = {
+  /**
+   * The target URI - the one user saved to. This is a percent-encoded `content://` uri (Android), or a `file://` uri (iOS).
+   * */
+  uri: string
+  /**
+   * The name of the file that user entered, including extension.
+   * */
+  name: string | null
+  /**
+   * Error in case the file could not be written or some metadata could not be obtained.
+   * */
+  error: string | null
+
+  // type: string | null
+  // nativeType: string | null
+
+  // later if needed; iOS doesn't allow to read the info from the target file
+  // should be the same as the source anyway
+  // size: number | null
+}
+
+/**
+ * The method for opening a "save as" dialog and saving source file(s) to a new location.
+ *
+ * On Android, only one file can be saved at a time.
+ *
+ * @group DocumentPicker
+ * */
+export async function saveDocuments(
+  options: SaveDocumentsOptions,
+): Promise<NonEmptyArray<SaveDocumentsResponse>> {
+  const writeDocumentResponse = await (async () => {
+    if (Platform.OS === 'android') {
+      const length = options.sourceUris.length
+      if (length > 1) {
+        console.warn(`DocumentPicker.saveDocuments: Android only allows to save one file at a time.\n
+      You provided an array with ${length} entries.`)
+      }
+      // making this division into 2 calls might be an overkill... but who knows
+      const objectWithSingleUri = await NativeDocumentPicker.saveDocument(options)
+      const response = await NativeDocumentPicker.writeDocuments(objectWithSingleUri)
+      return response as NonEmptyArray<DocumentPickerResponse>
+    } else {
+      return NativeDocumentPicker.writeDocuments(options) as Promise<
+        NonEmptyArray<DocumentPickerResponse>
+      >
+    }
+  })()
+  return writeDocumentResponse.map(keepOnlySpecifiedFields) as NonEmptyArray<SaveDocumentsResponse>
+}
+
+function keepOnlySpecifiedFields(source: DocumentPickerResponse): SaveDocumentsResponse {
+  return {
+    uri: source.uri,
+    name: source.name,
+    error: source.error,
+    // type: source.type,
+    // nativeType: source.nativeType,
+  }
+}

package/src/spec/NativeDocumentPicker.ts

@@ -0,0 +1,31 @@
+import type { TurboModule } from 'react-native'
+import { TurboModuleRegistry } from 'react-native'
+import { DocumentPickerResponse } from '../types'
+
+/**
+ * Indicates, for each Uri that was passed to {@link keepLocalCopy}, whether the local copy was successfully created or not.
+ *
+ * If the copy was successful, the status field is `success` and `localUri` contains the local Uri.
+ * If the copy was not successful, the status field is `error` and `copyError` field contains the error message.
+ * */
+export type LocalCopyResponse =
+  | {
+      status: 'success'
+      sourceUri: string
+      localUri: string
+    }
+  | { status: 'error'; sourceUri: string; copyError: string }
+
+export interface Spec extends TurboModule {
+  // we use "Object" to have backward compatibility with old arch
+  pick(options: Object): Promise<DocumentPickerResponse[]>
+  saveDocument(options: Object): Promise<Object>
+  writeDocuments(options: Object): Promise<Object[]>
+  pickDirectory(options: Object): Promise<Object>
+  keepLocalCopy(options: Object): Promise<LocalCopyResponse[]>
+  isKnownType(kind: string, value: string): Object
+  releaseSecureAccess(uris: string[]): Promise<null>
+  releaseLongTermAccess(uris: string[]): Promise<Object>
+}
+
+export const NativeDocumentPicker = TurboModuleRegistry.getEnforcing<Spec>('RNDocumentPicker')