@gaozh1024/photo-picker 0.1.1

package/dist/index.d.mts

@@ -0,0 +1,218 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare const MEDIA_PICKER_ROUTES: {
+    readonly PHOTO_ALBUM: "PhotoAlbum";
+    readonly PHOTO_CROP: "PhotoCrop";
+};
+declare const mediaPickerColors: {
+    readonly primary: {
+        readonly 500: "#3b82f6";
+    };
+    readonly slate: {
+        readonly 50: "#f8fafc";
+        readonly 100: "#f1f5f9";
+        readonly 200: "#e2e8f0";
+        readonly 700: "#334155";
+        readonly 800: "#1e293b";
+        readonly 900: "#0f172a";
+        readonly 950: "#020617";
+    };
+};
+
+type PhotoAlbumMediaType = 'photo' | 'video';
+type PhotoAlbumOpenMediaType = PhotoAlbumMediaType | 'all';
+type PickerSource = 'android-photo-picker' | 'android-open-document';
+interface PickerBackend {
+    source: PickerSource;
+    action: string;
+}
+type PhotoPickerNativeErrorCode = 'PICKER_BUSY' | 'PICKER_LAUNCH_FAILED' | 'PICKER_SELECTION_LIMIT_UNSUPPORTED';
+interface PhotoPickerNativeError extends Error {
+    code: PhotoPickerNativeErrorCode;
+}
+interface PhotoAlbumCropOptions {
+    aspect?: [number, number];
+    shape?: 'rect' | 'circle';
+    quality?: number;
+}
+interface PickerMetadata {
+    capturedAt?: string;
+    gpsLatitude?: number;
+    gpsLongitude?: number;
+    gpsAltitude?: number;
+    cameraMake?: string;
+    cameraModel?: string;
+    exifOrientation?: number;
+}
+/**
+ * A media descriptor owned by this package. It deliberately does not extend
+ * expo-media-library Asset so callers never need broad media-library access.
+ */
+interface PhotoAlbumItem {
+    id: string;
+    uri: string;
+    originalUri?: string;
+    localUri?: string;
+    filename?: string;
+    fileName?: string;
+    mediaType: PhotoAlbumMediaType;
+    mimeType?: string | null;
+    fileSize?: number;
+    width: number;
+    height: number;
+    /** Seconds, retained for compatibility with the old package. */
+    duration?: number;
+    /** Milliseconds, preferred by new code. */
+    durationMs?: number;
+    source?: PickerSource;
+    metadata?: PickerMetadata;
+    selected?: boolean;
+    selectedIndex?: number;
+    edited?: boolean;
+    crop?: PhotoAlbumCropOptions & {
+        width: number;
+        height: number;
+    };
+}
+interface PhotoAlbumOpenOptions {
+    maxSelection?: number;
+    mediaType?: PhotoAlbumOpenMediaType;
+    allowsMultipleSelection?: boolean;
+    maxVideoDuration?: number;
+    quality?: number;
+    crop?: PhotoAlbumCropOptions;
+    uiConfig?: PhotoAlbumUiConfig;
+}
+interface PhotoPickerOptions {
+    mediaType?: PhotoAlbumOpenMediaType;
+    maxSelection?: number;
+    allowsMultipleSelection?: boolean;
+    cacheMode?: 'copy';
+}
+interface PhotoPickerResult {
+    cancelled: boolean;
+    assets: PhotoAlbumItem[];
+    source?: PickerSource;
+    action?: string;
+}
+interface PhotoAlbumUiTexts {
+    albumTitle?: string;
+    cropTitle?: string;
+    cropConfirmButton?: string;
+    cropSavingButton?: string;
+    cropCircleHint?: string;
+    cropRectHint?: string;
+    cropMissingPhoto?: string;
+    durationLimitAlertTitle?: string;
+    durationLimitAlertMessage?: string;
+    openAlbumError?: string;
+    permissionAllowButton?: string;
+    permissionOpenSettingsButton?: string;
+    permissionSettingsAlertTitle?: string;
+    permissionSettingsAlertMessage?: string;
+    permissionSettingsAlertCancelButton?: string;
+    permissionSettingsAlertConfirmButton?: string;
+}
+interface PhotoAlbumUiTheme {
+    permissionButtonBackgroundColor?: string;
+    permissionButtonTextColor?: string;
+    permissionSettingsButtonBackgroundColor?: string;
+    permissionSettingsButtonTextColor?: string;
+}
+interface PhotoAlbumUiConfig {
+    texts?: PhotoAlbumUiTexts;
+    theme?: PhotoAlbumUiTheme;
+    /** Retained as a no-op compatibility shape. The system picker requests no media permission. */
+    permission?: {
+        openSettingsMode?: 'confirm' | 'direct' | 'disabled';
+    };
+}
+interface MediaPickerRouteNames {
+    photoAlbum: string;
+    photoCrop: string;
+}
+interface PhotoAlbumRouteParams {
+    callbackId?: string;
+    options?: PhotoAlbumOpenOptions;
+    maxSelection?: number;
+    allowsMultipleSelection?: boolean;
+    mediaTypes?: PhotoAlbumMediaType[];
+    routeNames?: Partial<MediaPickerRouteNames>;
+    uiConfig?: PhotoAlbumUiConfig;
+}
+interface PhotoCropRouteParams {
+    photo?: PhotoAlbumItem;
+    crop?: PhotoAlbumCropOptions;
+    quality?: number;
+    callbackId?: string;
+    routeNames?: Partial<MediaPickerRouteNames>;
+    uiConfig?: PhotoAlbumUiConfig;
+}
+interface PhotoAlbumScreenProps {
+    route?: {
+        params?: PhotoAlbumRouteParams;
+    };
+    navigation?: {
+        goBack: () => void;
+        navigate?: (name: string, params?: Record<string, unknown>) => void;
+        pop?: (count?: number) => void;
+    };
+}
+interface PhotoCropScreenProps {
+    route?: {
+        params?: PhotoCropRouteParams;
+    };
+    navigation?: {
+        goBack: () => void;
+        pop?: (count?: number) => void;
+    };
+}
+
+/**
+ * Compatibility route for applications that previously navigated to PhotoAlbum.
+ * It immediately opens the system picker; the app never enumerates the device library.
+ */
+declare function PhotoAlbumScreen({ route, navigation }: PhotoAlbumScreenProps): react_jsx_runtime.JSX.Element;
+
+declare function PhotoCropScreen({ route, navigation }: PhotoCropScreenProps): react_jsx_runtime.JSX.Element;
+
+declare function pickMedia(options?: PhotoPickerOptions): Promise<PhotoPickerResult>;
+declare function isPhotoPickerNativeError(error: unknown, code?: PhotoPickerNativeErrorCode): error is PhotoPickerNativeError;
+declare function releaseMedia(uris: string[]): Promise<void>;
+declare function clearPickerCache(): Promise<void>;
+
+type PhotoPickerCompleteCallback = (photos: PhotoAlbumItem[]) => void;
+declare function registerPhotoAlbumCompleteCallback(callback: PhotoPickerCompleteCallback): string;
+declare function getPhotoAlbumCompleteCallback(callbackId?: string | null): PhotoPickerCompleteCallback | undefined;
+declare function clearPhotoAlbumCompleteCallback(callbackId?: string | null): void;
+
+declare function normalizeOpenOptions(options?: PhotoAlbumOpenOptions): Required<Pick<PhotoAlbumOpenOptions, 'maxSelection' | 'mediaType' | 'allowsMultipleSelection'>> & PhotoAlbumOpenOptions;
+declare function resolvePhotoPickerUiConfig(uiConfig?: PhotoAlbumUiConfig): {
+    texts: {
+        albumTitle: string;
+        cropTitle: string;
+        cropConfirmButton: string;
+        cropSavingButton: string;
+        cropCircleHint: string;
+        cropRectHint: string;
+        cropMissingPhoto: string;
+        durationLimitAlertTitle: string;
+        durationLimitAlertMessage: string;
+        openAlbumError: string;
+        permissionAllowButton?: string;
+        permissionOpenSettingsButton?: string;
+        permissionSettingsAlertTitle?: string;
+        permissionSettingsAlertMessage?: string;
+        permissionSettingsAlertCancelButton?: string;
+        permissionSettingsAlertConfirmButton?: string;
+    };
+};
+declare function formatPhotoPickerText(template: string, variables: Record<string, string | number>): string;
+declare function createCroppedPhotoAlbumItem(photo: PhotoAlbumItem, manipulated: {
+    uri: string;
+    width: number;
+    height: number;
+}, crop?: PhotoAlbumCropOptions): PhotoAlbumItem;
+declare function normalizePickerMediaType(mediaType?: PhotoAlbumOpenMediaType): PhotoAlbumOpenMediaType;
+
+export { MEDIA_PICKER_ROUTES, type MediaPickerRouteNames, type PhotoAlbumCropOptions, type PhotoAlbumItem, type PhotoAlbumOpenMediaType, type PhotoAlbumOpenOptions, PhotoAlbumScreen, type PhotoAlbumScreenProps, type PhotoAlbumUiConfig, type PhotoAlbumUiTexts, type PhotoAlbumUiTheme, PhotoCropScreen, type PhotoCropScreenProps, type PhotoPickerNativeError, type PhotoPickerNativeErrorCode, type PhotoPickerOptions, type PhotoPickerResult, type PickerBackend, type PickerMetadata, type PickerSource, clearPhotoAlbumCompleteCallback, clearPickerCache, createCroppedPhotoAlbumItem, formatPhotoPickerText, getPhotoAlbumCompleteCallback, isPhotoPickerNativeError, mediaPickerColors, normalizeOpenOptions, normalizePickerMediaType, pickMedia, registerPhotoAlbumCompleteCallback, releaseMedia, resolvePhotoPickerUiConfig };

package/dist/index.d.ts

@@ -0,0 +1,218 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare const MEDIA_PICKER_ROUTES: {
+    readonly PHOTO_ALBUM: "PhotoAlbum";
+    readonly PHOTO_CROP: "PhotoCrop";
+};
+declare const mediaPickerColors: {
+    readonly primary: {
+        readonly 500: "#3b82f6";
+    };
+    readonly slate: {
+        readonly 50: "#f8fafc";
+        readonly 100: "#f1f5f9";
+        readonly 200: "#e2e8f0";
+        readonly 700: "#334155";
+        readonly 800: "#1e293b";
+        readonly 900: "#0f172a";
+        readonly 950: "#020617";
+    };
+};
+
+type PhotoAlbumMediaType = 'photo' | 'video';
+type PhotoAlbumOpenMediaType = PhotoAlbumMediaType | 'all';
+type PickerSource = 'android-photo-picker' | 'android-open-document';
+interface PickerBackend {
+    source: PickerSource;
+    action: string;
+}
+type PhotoPickerNativeErrorCode = 'PICKER_BUSY' | 'PICKER_LAUNCH_FAILED' | 'PICKER_SELECTION_LIMIT_UNSUPPORTED';
+interface PhotoPickerNativeError extends Error {
+    code: PhotoPickerNativeErrorCode;
+}
+interface PhotoAlbumCropOptions {
+    aspect?: [number, number];
+    shape?: 'rect' | 'circle';
+    quality?: number;
+}
+interface PickerMetadata {
+    capturedAt?: string;
+    gpsLatitude?: number;
+    gpsLongitude?: number;
+    gpsAltitude?: number;
+    cameraMake?: string;
+    cameraModel?: string;
+    exifOrientation?: number;
+}
+/**
+ * A media descriptor owned by this package. It deliberately does not extend
+ * expo-media-library Asset so callers never need broad media-library access.
+ */
+interface PhotoAlbumItem {
+    id: string;
+    uri: string;
+    originalUri?: string;
+    localUri?: string;
+    filename?: string;
+    fileName?: string;
+    mediaType: PhotoAlbumMediaType;
+    mimeType?: string | null;
+    fileSize?: number;
+    width: number;
+    height: number;
+    /** Seconds, retained for compatibility with the old package. */
+    duration?: number;
+    /** Milliseconds, preferred by new code. */
+    durationMs?: number;
+    source?: PickerSource;
+    metadata?: PickerMetadata;
+    selected?: boolean;
+    selectedIndex?: number;
+    edited?: boolean;
+    crop?: PhotoAlbumCropOptions & {
+        width: number;
+        height: number;
+    };
+}
+interface PhotoAlbumOpenOptions {
+    maxSelection?: number;
+    mediaType?: PhotoAlbumOpenMediaType;
+    allowsMultipleSelection?: boolean;
+    maxVideoDuration?: number;
+    quality?: number;
+    crop?: PhotoAlbumCropOptions;
+    uiConfig?: PhotoAlbumUiConfig;
+}
+interface PhotoPickerOptions {
+    mediaType?: PhotoAlbumOpenMediaType;
+    maxSelection?: number;
+    allowsMultipleSelection?: boolean;
+    cacheMode?: 'copy';
+}
+interface PhotoPickerResult {
+    cancelled: boolean;
+    assets: PhotoAlbumItem[];
+    source?: PickerSource;
+    action?: string;
+}
+interface PhotoAlbumUiTexts {
+    albumTitle?: string;
+    cropTitle?: string;
+    cropConfirmButton?: string;
+    cropSavingButton?: string;
+    cropCircleHint?: string;
+    cropRectHint?: string;
+    cropMissingPhoto?: string;
+    durationLimitAlertTitle?: string;
+    durationLimitAlertMessage?: string;
+    openAlbumError?: string;
+    permissionAllowButton?: string;
+    permissionOpenSettingsButton?: string;
+    permissionSettingsAlertTitle?: string;
+    permissionSettingsAlertMessage?: string;
+    permissionSettingsAlertCancelButton?: string;
+    permissionSettingsAlertConfirmButton?: string;
+}
+interface PhotoAlbumUiTheme {
+    permissionButtonBackgroundColor?: string;
+    permissionButtonTextColor?: string;
+    permissionSettingsButtonBackgroundColor?: string;
+    permissionSettingsButtonTextColor?: string;
+}
+interface PhotoAlbumUiConfig {
+    texts?: PhotoAlbumUiTexts;
+    theme?: PhotoAlbumUiTheme;
+    /** Retained as a no-op compatibility shape. The system picker requests no media permission. */
+    permission?: {
+        openSettingsMode?: 'confirm' | 'direct' | 'disabled';
+    };
+}
+interface MediaPickerRouteNames {
+    photoAlbum: string;
+    photoCrop: string;
+}
+interface PhotoAlbumRouteParams {
+    callbackId?: string;
+    options?: PhotoAlbumOpenOptions;
+    maxSelection?: number;
+    allowsMultipleSelection?: boolean;
+    mediaTypes?: PhotoAlbumMediaType[];
+    routeNames?: Partial<MediaPickerRouteNames>;
+    uiConfig?: PhotoAlbumUiConfig;
+}
+interface PhotoCropRouteParams {
+    photo?: PhotoAlbumItem;
+    crop?: PhotoAlbumCropOptions;
+    quality?: number;
+    callbackId?: string;
+    routeNames?: Partial<MediaPickerRouteNames>;
+    uiConfig?: PhotoAlbumUiConfig;
+}
+interface PhotoAlbumScreenProps {
+    route?: {
+        params?: PhotoAlbumRouteParams;
+    };
+    navigation?: {
+        goBack: () => void;
+        navigate?: (name: string, params?: Record<string, unknown>) => void;
+        pop?: (count?: number) => void;
+    };
+}
+interface PhotoCropScreenProps {
+    route?: {
+        params?: PhotoCropRouteParams;
+    };
+    navigation?: {
+        goBack: () => void;
+        pop?: (count?: number) => void;
+    };
+}
+
+/**
+ * Compatibility route for applications that previously navigated to PhotoAlbum.
+ * It immediately opens the system picker; the app never enumerates the device library.
+ */
+declare function PhotoAlbumScreen({ route, navigation }: PhotoAlbumScreenProps): react_jsx_runtime.JSX.Element;
+
+declare function PhotoCropScreen({ route, navigation }: PhotoCropScreenProps): react_jsx_runtime.JSX.Element;
+
+declare function pickMedia(options?: PhotoPickerOptions): Promise<PhotoPickerResult>;
+declare function isPhotoPickerNativeError(error: unknown, code?: PhotoPickerNativeErrorCode): error is PhotoPickerNativeError;
+declare function releaseMedia(uris: string[]): Promise<void>;
+declare function clearPickerCache(): Promise<void>;
+
+type PhotoPickerCompleteCallback = (photos: PhotoAlbumItem[]) => void;
+declare function registerPhotoAlbumCompleteCallback(callback: PhotoPickerCompleteCallback): string;
+declare function getPhotoAlbumCompleteCallback(callbackId?: string | null): PhotoPickerCompleteCallback | undefined;
+declare function clearPhotoAlbumCompleteCallback(callbackId?: string | null): void;
+
+declare function normalizeOpenOptions(options?: PhotoAlbumOpenOptions): Required<Pick<PhotoAlbumOpenOptions, 'maxSelection' | 'mediaType' | 'allowsMultipleSelection'>> & PhotoAlbumOpenOptions;
+declare function resolvePhotoPickerUiConfig(uiConfig?: PhotoAlbumUiConfig): {
+    texts: {
+        albumTitle: string;
+        cropTitle: string;
+        cropConfirmButton: string;
+        cropSavingButton: string;
+        cropCircleHint: string;
+        cropRectHint: string;
+        cropMissingPhoto: string;
+        durationLimitAlertTitle: string;
+        durationLimitAlertMessage: string;
+        openAlbumError: string;
+        permissionAllowButton?: string;
+        permissionOpenSettingsButton?: string;
+        permissionSettingsAlertTitle?: string;
+        permissionSettingsAlertMessage?: string;
+        permissionSettingsAlertCancelButton?: string;
+        permissionSettingsAlertConfirmButton?: string;
+    };
+};
+declare function formatPhotoPickerText(template: string, variables: Record<string, string | number>): string;
+declare function createCroppedPhotoAlbumItem(photo: PhotoAlbumItem, manipulated: {
+    uri: string;
+    width: number;
+    height: number;
+}, crop?: PhotoAlbumCropOptions): PhotoAlbumItem;
+declare function normalizePickerMediaType(mediaType?: PhotoAlbumOpenMediaType): PhotoAlbumOpenMediaType;
+
+export { MEDIA_PICKER_ROUTES, type MediaPickerRouteNames, type PhotoAlbumCropOptions, type PhotoAlbumItem, type PhotoAlbumOpenMediaType, type PhotoAlbumOpenOptions, PhotoAlbumScreen, type PhotoAlbumScreenProps, type PhotoAlbumUiConfig, type PhotoAlbumUiTexts, type PhotoAlbumUiTheme, PhotoCropScreen, type PhotoCropScreenProps, type PhotoPickerNativeError, type PhotoPickerNativeErrorCode, type PhotoPickerOptions, type PhotoPickerResult, type PickerBackend, type PickerMetadata, type PickerSource, clearPhotoAlbumCompleteCallback, clearPickerCache, createCroppedPhotoAlbumItem, formatPhotoPickerText, getPhotoAlbumCompleteCallback, isPhotoPickerNativeError, mediaPickerColors, normalizeOpenOptions, normalizePickerMediaType, pickMedia, registerPhotoAlbumCompleteCallback, releaseMedia, resolvePhotoPickerUiConfig };