@symbiote-native/image-picker 0.1.0

package/src/core/types.ts

@@ -0,0 +1,145 @@
+import type { PermissionResponse } from 'expo-modules-core';
+
+export type ICameraPermissionResponse = PermissionResponse;
+
+export type IMediaLibraryPermissionResponse = PermissionResponse & {
+  /** `'all'` | `'limited'` (Android 13+/iOS 14+) | `'none'`. */
+  accessPrivileges?: 'all' | 'limited' | 'none';
+};
+
+/** @deprecated use an array of `IMediaType` instead. */
+export enum MediaTypeOptions {
+  All = 'All',
+  Videos = 'Videos',
+  Images = 'Images',
+}
+
+export type IMediaType = 'images' | 'videos' | 'livePhotos';
+
+/** Android only. */
+export type IDefaultTab = 'photos' | 'albums';
+
+export enum VideoExportPreset {
+  Passthrough = 0,
+  LowQuality = 1,
+  MediumQuality = 2,
+  HighestQuality = 3,
+  H264_640x480 = 4,
+  H264_960x540 = 5,
+  H264_1280x720 = 6,
+  H264_1920x1080 = 7,
+  H264_3840x2160 = 8,
+  HEVC_1920x1080 = 9,
+  HEVC_3840x2160 = 10,
+}
+
+export enum UIImagePickerControllerQualityType {
+  High = 0,
+  Medium = 1,
+  Low = 2,
+  VGA640x480 = 3,
+  IFrame1280x720 = 4,
+  IFrame960x540 = 5,
+}
+
+/** iOS only — maps to `UIModalPresentationStyle`. */
+export enum UIImagePickerPresentationStyle {
+  FULL_SCREEN = 'fullScreen',
+  PAGE_SHEET = 'pageSheet',
+  FORM_SHEET = 'formSheet',
+  CURRENT_CONTEXT = 'currentContext',
+  OVER_FULL_SCREEN = 'overFullScreen',
+  OVER_CURRENT_CONTEXT = 'overCurrentContext',
+  POPOVER = 'popover',
+  AUTOMATIC = 'automatic',
+}
+
+/** iOS only — maps to `PHPickerConfigurationAssetRepresentationMode`. */
+export enum UIImagePickerPreferredAssetRepresentationMode {
+  Automatic = 'automatic',
+  Compatible = 'compatible',
+  Current = 'current',
+}
+
+export enum CameraType {
+  back = 'back',
+  front = 'front',
+}
+
+export type IImagePickerAsset = {
+  uri: string;
+  /** Usable with `@symbiote-native/media-library`. Null if unavailable or access is limited. */
+  assetId?: string | null;
+  width: number;
+  height: number;
+  type?: 'image' | 'video' | 'livePhoto' | 'pairedVideo' | null;
+  fileName?: string | null;
+  fileSize?: number;
+  exif?: Record<string, unknown> | null;
+  /** Base64 JPEG data — set only when the `base64` option is truthy. */
+  base64?: string | null;
+  duration?: number | null;
+  mimeType?: string;
+  /** Set only when `livePhotos` was requested and a live photo was picked. iOS only. */
+  pairedVideoAsset?: IImagePickerAsset | null;
+};
+
+export type IImagePickerErrorResult = {
+  code: string;
+  message: string;
+  exception?: string;
+};
+
+export type IImagePickerSuccessResult = {
+  canceled: false;
+  assets: IImagePickerAsset[];
+};
+
+export type IImagePickerCanceledResult = {
+  canceled: true;
+  assets: null;
+};
+
+export type IImagePickerResult =
+  IImagePickerSuccessResult | IImagePickerCanceledResult;
+
+export type ICropShape = 'rectangle' | 'oval';
+
+export type IImagePickerOptions = {
+  /** Crop/rotate after picking. Exclusive with `allowsMultipleSelection`. Default `false`. */
+  allowsEditing?: boolean;
+  /** `[x, y]` crop aspect ratio. Android only. */
+  aspect?: [number, number];
+  /** Android only. Default `'rectangle'`. */
+  shape?: ICropShape;
+  /** `0`–`1`. Default `1.0`. */
+  quality?: number;
+  /** Default `'images'`. */
+  mediaTypes?: IMediaType | IMediaType[] | MediaTypeOptions;
+  exif?: boolean;
+  base64?: boolean;
+  /** @deprecated iOS 11+ only. */
+  videoExportPreset?: VideoExportPreset;
+  /** iOS only. Default `High`. */
+  videoQuality?: UIImagePickerControllerQualityType;
+  /** Ignored when `allowsEditing` is set. Default `false`. */
+  allowsMultipleSelection?: boolean;
+  /** `0` = system maximum. Android + iOS 14+. Default `0`. */
+  selectionLimit?: number;
+  /** iOS 15+ only. Default `false`. */
+  orderedSelection?: boolean;
+  /** Android only. Default `'photos'`. */
+  defaultTab?: IDefaultTab;
+  /** Seconds. `0` = no limit (default). No effect on web. */
+  videoMaxDuration?: number;
+  /** iOS only. Default `AUTOMATIC`. */
+  presentationStyle?: UIImagePickerPresentationStyle;
+  /** Default `back`. */
+  cameraType?: CameraType;
+  /** iOS 14+ only. Default `Automatic`. */
+  preferredAssetRepresentationMode?: UIImagePickerPreferredAssetRepresentationMode;
+  /** Android only — allows picking from outside the photo library. Default `false`. */
+  legacy?: boolean;
+  /** iOS only — download from iCloud if not stored locally. Default `false`. */
+  shouldDownloadFromNetwork?: boolean;
+};

package/src/core/utils.ts

@@ -0,0 +1,36 @@
+import { MediaTypeOptions } from './types';
+import type { IImagePickerOptions, IMediaType } from './types';
+
+const DEPRECATED_MEDIA_TYPE_MAP: Record<MediaTypeOptions, IMediaType[]> = {
+  [MediaTypeOptions.Images]: ['images'],
+  [MediaTypeOptions.Videos]: ['videos'],
+  [MediaTypeOptions.All]: ['images', 'videos'],
+};
+
+export function parseMediaTypes(
+  mediaTypes: MediaTypeOptions | IMediaType | IMediaType[],
+): IMediaType[] {
+  if (
+    mediaTypes === MediaTypeOptions.Images ||
+    mediaTypes === MediaTypeOptions.Videos ||
+    mediaTypes === MediaTypeOptions.All
+  ) {
+    console.warn(
+      '[image-picker] `MediaTypeOptions` is deprecated. Use `IMediaType` or an array of it instead.',
+    );
+    return DEPRECATED_MEDIA_TYPE_MAP[mediaTypes];
+  }
+  if (typeof mediaTypes === 'string') {
+    return [mediaTypes];
+  }
+  return mediaTypes;
+}
+
+export function mapDeprecatedOptions(
+  options: IImagePickerOptions,
+): IImagePickerOptions {
+  if (!options.mediaTypes) {
+    return options;
+  }
+  return { ...options, mediaTypes: parseMediaTypes(options.mediaTypes) };
+}

package/src/react/index.ts

@@ -0,0 +1,6 @@
+export * from '../core';
+export { useCameraPermissions } from './use-camera-permissions';
+export {
+  useMediaLibraryPermissions,
+  type IUseMediaLibraryPermissionsOptions,
+} from './use-media-library-permissions';

package/src/react/use-camera-permissions.ts

@@ -0,0 +1,25 @@
+import { createPermissionHook } from '@symbiote-native/react';
+import {
+  getCameraPermissionsAsync,
+  requestCameraPermissionsAsync,
+} from '../core';
+import type { ICameraPermissionResponse } from '../core';
+import type { IPermissionHookBehavior } from '@symbiote-native/engine';
+
+export type IUseCameraPermissionsResult = [
+  ICameraPermissionResponse | null,
+  () => Promise<ICameraPermissionResponse>,
+  () => Promise<ICameraPermissionResponse>,
+];
+
+const usePermission = createPermissionHook({
+  getMethod: getCameraPermissionsAsync,
+  requestMethod: requestCameraPermissionsAsync,
+});
+
+// React twin of `expo-image-picker`'s `useCameraPermissions`
+export function useCameraPermissions(
+  options?: IPermissionHookBehavior,
+): IUseCameraPermissionsResult {
+  return usePermission(options);
+}

package/src/react/use-media-library-permissions.ts

@@ -0,0 +1,26 @@
+import { createPermissionHook } from '@symbiote-native/react';
+import type { IMediaLibraryPermissionResponse } from '../core';
+import {
+  mediaLibraryPermissionMethods,
+  splitMediaLibraryPermissionOptions,
+  type IMediaLibraryPermissionMethodOptions,
+} from '../core/media-library-permission-api';
+import type { IPermissionHookOptions } from '@symbiote-native/engine';
+
+export type IUseMediaLibraryPermissionsOptions =
+  IMediaLibraryPermissionMethodOptions;
+
+export type IUseMediaLibraryPermissionsResult = [
+  IMediaLibraryPermissionResponse | null,
+  () => Promise<IMediaLibraryPermissionResponse>,
+  () => Promise<IMediaLibraryPermissionResponse>,
+];
+
+const usePermission = createPermissionHook(mediaLibraryPermissionMethods);
+
+// React twin of `expo-image-picker`'s `useMediaLibraryPermissions`
+export function useMediaLibraryPermissions(
+  options?: IPermissionHookOptions<IUseMediaLibraryPermissionsOptions>,
+): IUseMediaLibraryPermissionsResult {
+  return usePermission(...splitMediaLibraryPermissionOptions(options));
+}

package/src/solid/index.ts

@@ -0,0 +1,6 @@
+export * from '../core';
+export { useCameraPermissions } from './use-camera-permissions';
+export {
+  useMediaLibraryPermissions,
+  type IUseMediaLibraryPermissionsOptions,
+} from './use-media-library-permissions';

package/src/solid/use-camera-permissions.ts

@@ -0,0 +1,26 @@
+import { createPermissionHook } from '@symbiote-native/solid';
+import {
+  getCameraPermissionsAsync,
+  requestCameraPermissionsAsync,
+} from '../core';
+import type { ICameraPermissionResponse } from '../core';
+import type { IPermissionHookBehavior } from '@symbiote-native/engine';
+import type { Accessor } from 'solid-js';
+
+export type IUseCameraPermissionsResult = [
+  Accessor<ICameraPermissionResponse | null>,
+  () => Promise<ICameraPermissionResponse>,
+  () => Promise<ICameraPermissionResponse>,
+];
+
+const usePermission = createPermissionHook({
+  getMethod: getCameraPermissionsAsync,
+  requestMethod: requestCameraPermissionsAsync,
+});
+
+// Solid twin of `../react`'s `useCameraPermissions`
+export function useCameraPermissions(
+  options?: IPermissionHookBehavior,
+): IUseCameraPermissionsResult {
+  return usePermission(options);
+}

package/src/solid/use-media-library-permissions.ts

@@ -0,0 +1,27 @@
+import { createPermissionHook } from '@symbiote-native/solid';
+import type { IMediaLibraryPermissionResponse } from '../core';
+import {
+  mediaLibraryPermissionMethods,
+  splitMediaLibraryPermissionOptions,
+  type IMediaLibraryPermissionMethodOptions,
+} from '../core/media-library-permission-api';
+import type { IPermissionHookOptions } from '@symbiote-native/engine';
+import type { Accessor } from 'solid-js';
+
+export type IUseMediaLibraryPermissionsOptions =
+  IMediaLibraryPermissionMethodOptions;
+
+export type IUseMediaLibraryPermissionsResult = [
+  Accessor<IMediaLibraryPermissionResponse | null>,
+  () => Promise<IMediaLibraryPermissionResponse>,
+  () => Promise<IMediaLibraryPermissionResponse>,
+];
+
+const usePermission = createPermissionHook(mediaLibraryPermissionMethods);
+
+// Solid twin of `../react`'s `useMediaLibraryPermissions`
+export function useMediaLibraryPermissions(
+  options?: IPermissionHookOptions<IUseMediaLibraryPermissionsOptions>,
+): IUseMediaLibraryPermissionsResult {
+  return usePermission(...splitMediaLibraryPermissionOptions(options));
+}

package/src/svelte/index.ts

@@ -0,0 +1,6 @@
+export * from '../core';
+export { useCameraPermissions } from './use-camera-permissions.svelte';
+export {
+  useMediaLibraryPermissions,
+  type IUseMediaLibraryPermissionsOptions,
+} from './use-media-library-permissions.svelte';

package/src/svelte/svelte-ambient.d.ts

@@ -0,0 +1,3 @@
+// Pulls svelte's ambient globals ($state/$effect/...) into this package's tsc program,
+// same fix as `packages/navigation/src/svelte/svelte-ambient.d.ts`
+/// <reference types="svelte" />

package/src/svelte/svelte-compile.test-helper.ts

@@ -0,0 +1,7 @@
+// Re-exports the existing harness instead of a third copy (packages/sqlite and
+// packages/navigation already carry one, not part of either package's public exports)
+export {
+  createSvelteHarness,
+  loadComponent,
+  type ISvelteHarness,
+} from '../../../sqlite/src/svelte/svelte-compile.test-helper';

package/src/svelte/use-camera-permissions.svelte.ts

@@ -0,0 +1,25 @@
+import { createPermissionHook } from '@symbiote-native/svelte/runes/create-permission-hook';
+import {
+  getCameraPermissionsAsync,
+  requestCameraPermissionsAsync,
+} from '../core';
+import type { ICameraPermissionResponse } from '../core';
+import type { IPermissionHookBehavior } from '@symbiote-native/engine';
+
+export type IUseCameraPermissionsResult = {
+  readonly status: ICameraPermissionResponse | null;
+  requestPermission: () => Promise<ICameraPermissionResponse>;
+  getPermission: () => Promise<ICameraPermissionResponse>;
+};
+
+const usePermission = createPermissionHook({
+  getMethod: getCameraPermissionsAsync,
+  requestMethod: requestCameraPermissionsAsync,
+});
+
+// Svelte twin of `../react`'s `useCameraPermissions`
+export function useCameraPermissions(
+  behavior?: IPermissionHookBehavior,
+): IUseCameraPermissionsResult {
+  return usePermission(behavior);
+}

package/src/svelte/use-media-library-permissions.svelte.ts

@@ -0,0 +1,26 @@
+import { createPermissionHook } from '@symbiote-native/svelte/runes/create-permission-hook';
+import {
+  mediaLibraryPermissionMethods,
+  splitMediaLibraryPermissionOptions,
+  type IMediaLibraryPermissionMethodOptions,
+} from '../core/media-library-permission-api';
+import type { IMediaLibraryPermissionResponse } from '../core';
+import type { IPermissionHookOptions } from '@symbiote-native/engine';
+
+export type IUseMediaLibraryPermissionsOptions =
+  IMediaLibraryPermissionMethodOptions;
+
+export type IUseMediaLibraryPermissionsResult = {
+  readonly status: IMediaLibraryPermissionResponse | null;
+  requestPermission: () => Promise<IMediaLibraryPermissionResponse>;
+  getPermission: () => Promise<IMediaLibraryPermissionResponse>;
+};
+
+const usePermission = createPermissionHook(mediaLibraryPermissionMethods);
+
+// Svelte twin of `../react`'s `useMediaLibraryPermissions`
+export function useMediaLibraryPermissions(
+  options?: IPermissionHookOptions<IUseMediaLibraryPermissionsOptions>,
+): IUseMediaLibraryPermissionsResult {
+  return usePermission(...splitMediaLibraryPermissionOptions(options));
+}

package/src/vue/index.ts

@@ -0,0 +1,6 @@
+export * from '../core';
+export { useCameraPermissions } from './use-camera-permissions';
+export {
+  useMediaLibraryPermissions,
+  type IUseMediaLibraryPermissionsOptions,
+} from './use-media-library-permissions';

package/src/vue/use-camera-permissions.ts

@@ -0,0 +1,26 @@
+import { createPermissionHook } from '@symbiote-native/vue';
+import {
+  getCameraPermissionsAsync,
+  requestCameraPermissionsAsync,
+} from '../core';
+import type { ICameraPermissionResponse } from '../core';
+import type { IPermissionHookBehavior } from '@symbiote-native/engine';
+import type { Ref } from '@vue/runtime-core';
+
+export type IUseCameraPermissionsResult = [
+  Ref<ICameraPermissionResponse | null>,
+  () => Promise<ICameraPermissionResponse>,
+  () => Promise<ICameraPermissionResponse>,
+];
+
+const usePermission = createPermissionHook({
+  getMethod: getCameraPermissionsAsync,
+  requestMethod: requestCameraPermissionsAsync,
+});
+
+// Vue twin of `../react`'s `useCameraPermissions`
+export function useCameraPermissions(
+  options?: IPermissionHookBehavior,
+): IUseCameraPermissionsResult {
+  return usePermission(options);
+}

package/src/vue/use-media-library-permissions.ts

@@ -0,0 +1,27 @@
+import { createPermissionHook } from '@symbiote-native/vue';
+import type { IMediaLibraryPermissionResponse } from '../core';
+import {
+  mediaLibraryPermissionMethods,
+  splitMediaLibraryPermissionOptions,
+  type IMediaLibraryPermissionMethodOptions,
+} from '../core/media-library-permission-api';
+import type { IPermissionHookOptions } from '@symbiote-native/engine';
+import type { Ref } from '@vue/runtime-core';
+
+export type IUseMediaLibraryPermissionsOptions =
+  IMediaLibraryPermissionMethodOptions;
+
+export type IUseMediaLibraryPermissionsResult = [
+  Ref<IMediaLibraryPermissionResponse | null>,
+  () => Promise<IMediaLibraryPermissionResponse>,
+  () => Promise<IMediaLibraryPermissionResponse>,
+];
+
+const usePermission = createPermissionHook(mediaLibraryPermissionMethods);
+
+// Vue twin of `../react`'s `useMediaLibraryPermissions`
+export function useMediaLibraryPermissions(
+  options?: IPermissionHookOptions<IUseMediaLibraryPermissionsOptions>,
+): IUseMediaLibraryPermissionsResult {
+  return usePermission(...splitMediaLibraryPermissionOptions(options));
+}