@aws-amplify/ui-react-storage 3.3.2 → 3.3.4

package/dist/esm/components/StorageManager/hooks/useStorageManager/useStorageManager.mjs

@@ -1,62 +0,0 @@
-import React__default from 'react';
-import { isObject } from '@aws-amplify/ui';
-import { FileStatus } from '../../types.mjs';
-import { storageManagerStateReducer } from './reducer.mjs';
-import { addFilesAction, clearFilesAction, queueFilesAction, setUploadingFileAction, setProcessedKeyAction, setUploadProgressAction, setUploadStatusAction, removeUploadAction } from './actions.mjs';
-
-const isDefaultFile = (file) => !!(isObject(file) && file.key);
-const createFileFromDefault = (file) => isDefaultFile(file)
-    ? { ...file, id: file.key, status: FileStatus.UPLOADED }
-    : undefined;
-function useStorageManager(defaultFiles = []) {
-    const [{ files }, dispatch] = React__default.useReducer(storageManagerStateReducer, {
-        files: (Array.isArray(defaultFiles)
-            ? defaultFiles.map(createFileFromDefault).filter((file) => !!file)
-            : []),
-    });
-    const addFiles = ({ files, status, getFileErrorMessage, }) => {
-        dispatch(addFilesAction({ files, status, getFileErrorMessage }));
-    };
-    const clearFiles = () => {
-        dispatch(clearFilesAction());
-    };
-    const queueFiles = () => {
-        dispatch(queueFilesAction());
-    };
-    const setUploadingFile = ({ uploadTask, id, }) => {
-        dispatch(setUploadingFileAction({ id, uploadTask }));
-    };
-    const setProcessedKey = (input) => {
-        dispatch(setProcessedKeyAction(input));
-    };
-    const setUploadProgress = ({ progress, id, }) => {
-        dispatch(setUploadProgressAction({ id, progress }));
-    };
-    const setUploadSuccess = ({ id }) => {
-        dispatch(setUploadStatusAction({ id, status: FileStatus.UPLOADED }));
-    };
-    const setUploadPaused = ({ id }) => {
-        dispatch(setUploadStatusAction({ id, status: FileStatus.PAUSED }));
-    };
-    const setUploadResumed = ({ id }) => {
-        dispatch(setUploadStatusAction({ id, status: FileStatus.UPLOADING }));
-    };
-    const removeUpload = ({ id }) => {
-        dispatch(removeUploadAction({ id }));
-    };
-    return {
-        removeUpload,
-        setProcessedKey,
-        setUploadPaused,
-        setUploadProgress,
-        setUploadResumed,
-        setUploadSuccess,
-        setUploadingFile,
-        queueFiles,
-        addFiles,
-        clearFiles,
-        files,
-    };
-}
-
-export { useStorageManager };

package/dist/esm/components/StorageManager/hooks/useUploadFiles/useUploadFiles.mjs

@@ -1,79 +0,0 @@
-import * as React from 'react';
-import { isFunction } from '@aws-amplify/ui';
-import { getInput } from '../../utils/getInput.mjs';
-import { uploadFile } from '../../utils/uploadFile.mjs';
-import { FileStatus } from '../../types.mjs';
-
-function useUploadFiles({ accessLevel, files, isResumable, maxFileCount, onProcessFileSuccess, onUploadError, onUploadStart, onUploadSuccess, path, processFile, setUploadingFile, setUploadProgress, setUploadSuccess, useAccelerateEndpoint, }) {
-    React.useEffect(() => {
-        const filesReadyToUpload = files.filter((file) => file.status === FileStatus.QUEUED);
-        if (filesReadyToUpload.length > maxFileCount) {
-            return;
-        }
-        for (const { file, key, id } of filesReadyToUpload) {
-            const onProgress = (event) => {
-                /**
-                 * When a file is zero bytes, the progress.total will equal zero.
-                 * Therefore, this will prevent a divide by zero error.
-                 */
-                const progress = event.totalBytes === undefined || event.totalBytes === 0
-                    ? 100
-                    : Math.floor((event.transferredBytes / event.totalBytes) * 100);
-                setUploadProgress({ id, progress });
-            };
-            if (file) {
-                const handleProcessFileSuccess = (input) => onProcessFileSuccess({ id, ...input });
-                const input = getInput({
-                    accessLevel,
-                    file,
-                    key,
-                    onProcessFileSuccess: handleProcessFileSuccess,
-                    onProgress,
-                    path,
-                    processFile,
-                    useAccelerateEndpoint,
-                });
-                uploadFile({
-                    input,
-                    onComplete: (event) => {
-                        if (isFunction(onUploadSuccess)) {
-                            onUploadSuccess({
-                                key: event.key ??
-                                    event.path,
-                            });
-                        }
-                        setUploadSuccess({ id });
-                    },
-                    onError: ({ key, error }) => {
-                        if (isFunction(onUploadError)) {
-                            onUploadError(error.message, { key });
-                        }
-                    },
-                    onStart: ({ key, uploadTask }) => {
-                        if (isFunction(onUploadStart)) {
-                            onUploadStart({ key });
-                        }
-                        setUploadingFile({ id, uploadTask });
-                    },
-                });
-            }
-        }
-    }, [
-        files,
-        accessLevel,
-        isResumable,
-        setUploadProgress,
-        setUploadingFile,
-        onUploadError,
-        onProcessFileSuccess,
-        onUploadSuccess,
-        onUploadStart,
-        maxFileCount,
-        setUploadSuccess,
-        processFile,
-        path,
-        useAccelerateEndpoint,
-    ]);
-}
-
-export { useUploadFiles };

package/dist/esm/components/StorageManager/types.mjs

@@ -1,11 +0,0 @@
-var FileStatus;
-(function (FileStatus) {
-    FileStatus["ADDED"] = "added";
-    FileStatus["QUEUED"] = "queued";
-    FileStatus["UPLOADING"] = "uploading";
-    FileStatus["PAUSED"] = "paused";
-    FileStatus["ERROR"] = "error";
-    FileStatus["UPLOADED"] = "uploaded";
-})(FileStatus || (FileStatus = {}));
-
-export { FileStatus };

package/dist/esm/components/StorageManager/utils/checkMaxFileSize.mjs

@@ -1,12 +0,0 @@
-import { humanFileSize } from '@aws-amplify/ui';
-
-const checkMaxFileSize = ({ file, getFileSizeErrorText, maxFileSize, }) => {
-    if (maxFileSize === undefined)
-        return '';
-    if (file.size > maxFileSize) {
-        return getFileSizeErrorText(humanFileSize(maxFileSize, true));
-    }
-    return '';
-};
-
-export { checkMaxFileSize };

package/dist/esm/components/StorageManager/utils/displayText.mjs

@@ -1,39 +0,0 @@
-const defaultStorageManagerDisplayText = {
-    getFilesUploadedText(count) {
-        return `${count} ${count === 1 ? 'file uploaded' : 'files uploaded'}`;
-    },
-    getFileSizeErrorText(sizeText) {
-        return `File size must be below ${sizeText}`;
-    },
-    getRemainingFilesText(count) {
-        return `${count} ${count === 1 ? 'file' : 'files'} uploading`;
-    },
-    getSelectedFilesText(count) {
-        return `${count} ${count === 1 ? 'file' : 'files'} selected`;
-    },
-    getUploadingText(percentage) {
-        return `Uploading${percentage > 0 ? `: ${percentage}%` : ''}`;
-    },
-    getUploadButtonText(count) {
-        return `Upload ${count} ${count === 1 ? 'file' : 'files'}`;
-    },
-    getMaxFilesErrorText(count) {
-        return `Cannot choose more than ${count} ${count === 1 ? 'file' : 'files'}. Remove files before updating`;
-    },
-    getErrorText(message) {
-        return message;
-    },
-    doneButtonText: 'Done',
-    clearAllButtonText: 'Clear all',
-    extensionNotAllowedText: 'Extension not allowed',
-    browseFilesText: 'Browse files',
-    dropFilesText: 'Drop files here or',
-    pauseButtonText: 'Pause',
-    resumeButtonText: 'Resume',
-    uploadSuccessfulText: 'Uploaded',
-    getPausedText(percentage) {
-        return `Paused: ${percentage}%`;
-    },
-};
-
-export { defaultStorageManagerDisplayText };

package/dist/esm/components/StorageManager/utils/filterAllowedFiles.mjs

@@ -1,27 +0,0 @@
-const filterAllowedFiles = (files, acceptedFileTypes) => {
-    // Allow any files if acceptedFileTypes is undefined, empty array, or contains '*'
-    if (!acceptedFileTypes ||
-        acceptedFileTypes.length === 0 ||
-        acceptedFileTypes.includes('*')) {
-        return files;
-    }
-    // Remove any files that are not in the accepted file list
-    return files.filter((file) => {
-        const fileName = file.name || '';
-        const mimeType = (file.type || '').toLowerCase();
-        const baseMimeType = mimeType.replace(/\/.*$/, '');
-        return acceptedFileTypes.some((type) => {
-            const validType = type.trim().toLowerCase();
-            if (validType.charAt(0) === '.') {
-                return fileName.toLowerCase().endsWith(validType);
-            }
-            else if (validType.endsWith('/*')) {
-                // This is something like a image/* mime type
-                return baseMimeType === validType.replace(/\/.*$/, '');
-            }
-            return mimeType === validType;
-        });
-    });
-};
-
-export { filterAllowedFiles };

package/dist/esm/components/StorageManager/utils/getInput.mjs

@@ -1,39 +0,0 @@
-import { fetchAuthSession } from 'aws-amplify/auth';
-import { isTypedFunction, isString } from '@aws-amplify/ui';
-import { resolveFile } from './resolveFile.mjs';
-
-const getInput = ({ accessLevel, file, key, onProcessFileSuccess, onProgress, path, processFile, useAccelerateEndpoint, }) => {
-    return async () => {
-        const hasCallbackPath = isTypedFunction(path);
-        const hasStringPath = isString(path);
-        const hasKeyInput = !!accessLevel && !hasCallbackPath;
-        const { file: data, key: processedKey, ...rest } = await resolveFile({ file, key, processFile });
-        const contentType = file.type || 'binary/octet-stream';
-        // IMPORTANT: always pass `...rest` here for backwards compatibility
-        const options = { contentType, onProgress, useAccelerateEndpoint, ...rest };
-        let inputResult;
-        if (hasKeyInput) {
-            // legacy handling of `path` is to prefix to `fileKey`
-            const resolvedKey = hasStringPath
-                ? `${path}${processedKey}`
-                : processedKey;
-            inputResult = {
-                data,
-                key: resolvedKey,
-                options: { ...options, accessLevel },
-            };
-        }
-        else {
-            const { identityId } = await fetchAuthSession();
-            const resolvedPath = `${hasCallbackPath ? path({ identityId }) : path}${processedKey}`;
-            inputResult = { data: file, path: resolvedPath, options };
-        }
-        if (processFile) {
-            // provide post-processing value of target `key`
-            onProcessFileSuccess({ processedKey });
-        }
-        return inputResult;
-    };
-};
-
-export { getInput };

package/dist/esm/components/StorageManager/utils/resolveFile.mjs

@@ -1,20 +0,0 @@
-import { isFunction } from '@aws-amplify/ui';
-
-/**
- * Utility function that takes the processFile prop, along with a file a key
- * and returns a Promise that resolves to { file, key, ..rest }
- * regardless if processFile is defined and if it is sync or async
- */
-const resolveFile = ({ processFile, ...input }) => {
-    return new Promise((resolve, reject) => {
-        const result = isFunction(processFile) ? processFile(input) : input;
-        if (result instanceof Promise) {
-            result.then(resolve).catch(reject);
-        }
-        else {
-            resolve(result);
-        }
-    });
-};
-
-export { resolveFile };

package/dist/esm/components/StorageManager/utils/uploadFile.mjs

@@ -1,26 +0,0 @@
-import { uploadData } from 'aws-amplify/storage';
-import { isFunction } from '@aws-amplify/ui';
-
-async function uploadFile({ input, onError, onStart, onComplete, }) {
-    const resolvedInput = await input();
-    const uploadTask = uploadData(resolvedInput);
-    const key = resolvedInput?.key ??
-        resolvedInput?.path;
-    if (isFunction(onStart)) {
-        onStart({ key, uploadTask });
-    }
-    uploadTask.result
-        .then((result) => {
-        if (isFunction(onComplete) && uploadTask.state === 'SUCCESS') {
-            onComplete(result);
-        }
-    })
-        .catch((error) => {
-        if (isFunction(onError)) {
-            onError({ key, error });
-        }
-    });
-    return uploadTask;
-}
-
-export { uploadFile };

package/dist/types/components/StorageManager/hooks/index.d.ts

@@ -1,2 +0,0 @@
-export { useStorageManager, UseStorageManager } from './useStorageManager';
-export { useUploadFiles } from './useUploadFiles';

package/dist/types/components/StorageManager/hooks/useStorageManager/actions.d.ts

@@ -1,22 +0,0 @@
-import { FileStatus } from '../../types';
-import { Action, AddFilesActionParams } from './types';
-import { TaskEvent } from '../../utils';
-export declare const addFilesAction: ({ files, status, getFileErrorMessage, }: AddFilesActionParams) => Action;
-export declare const clearFilesAction: () => Action;
-export declare const queueFilesAction: () => Action;
-export declare const setProcessedKeyAction: (input: {
-    id: string;
-    processedKey: string;
-}) => Action;
-export declare const setUploadingFileAction: ({ id, uploadTask, }: TaskEvent) => Action;
-export declare const setUploadProgressAction: ({ id, progress, }: {
-    id: string;
-    progress: number;
-}) => Action;
-export declare const setUploadStatusAction: ({ id, status, }: {
-    id: string;
-    status: FileStatus;
-}) => Action;
-export declare const removeUploadAction: ({ id }: {
-    id: string;
-}) => Action;

package/dist/types/components/StorageManager/hooks/useStorageManager/index.d.ts

@@ -1 +0,0 @@
-export { useStorageManager, UseStorageManager } from './useStorageManager';

package/dist/types/components/StorageManager/hooks/useStorageManager/reducer.d.ts

@@ -1,2 +0,0 @@
-import { Action, UseStorageManagerState } from './types';
-export declare function storageManagerStateReducer(state: UseStorageManagerState, action: Action): UseStorageManagerState;

package/dist/types/components/StorageManager/hooks/useStorageManager/types.d.ts

@@ -1,50 +0,0 @@
-import { FileStatus, StorageFiles } from '../../types';
-import { UploadTask } from '../../utils';
-export interface UseStorageManagerState {
-    files: StorageFiles;
-}
-export declare enum StorageManagerActionTypes {
-    ADD_FILES = "ADD_FILES",
-    CLEAR_FILES = "CLEAR_FILES",
-    QUEUE_FILES = "QUEUE_FILES",
-    SET_STATUS = "SET_STATUS",
-    SET_PROCESSED_FILE_KEY = "SET_PROCESSED_FILE_KEY",
-    SET_STATUS_UPLOADING = "SET_STATUS_UPLOADING",
-    SET_UPLOAD_PROGRESS = "SET_UPLOAD_PROGRESS",
-    REMOVE_UPLOAD = "REMOVE_UPLOAD"
-}
-export type GetFileErrorMessage = (file: File) => string;
-export type Action = {
-    type: StorageManagerActionTypes.ADD_FILES;
-    files: File[];
-    status: FileStatus;
-    getFileErrorMessage: GetFileErrorMessage;
-} | {
-    type: StorageManagerActionTypes.CLEAR_FILES;
-} | {
-    type: StorageManagerActionTypes.SET_STATUS;
-    id: string;
-    status: FileStatus;
-} | {
-    type: StorageManagerActionTypes.QUEUE_FILES;
-} | {
-    type: StorageManagerActionTypes.SET_STATUS_UPLOADING;
-    id: string;
-    uploadTask?: UploadTask;
-} | {
-    type: StorageManagerActionTypes.SET_UPLOAD_PROGRESS;
-    id: string;
-    progress: number;
-} | {
-    type: StorageManagerActionTypes.SET_PROCESSED_FILE_KEY;
-    id: string;
-    processedKey: string;
-} | {
-    type: StorageManagerActionTypes.REMOVE_UPLOAD;
-    id: string;
-};
-export interface AddFilesActionParams {
-    files: File[];
-    status: FileStatus;
-    getFileErrorMessage: GetFileErrorMessage;
-}

package/dist/types/components/StorageManager/hooks/useStorageManager/useStorageManager.d.ts

@@ -1,35 +0,0 @@
-import { StorageFiles, FileStatus, DefaultFile } from '../../types';
-import { GetFileErrorMessage } from './types';
-import { TaskHandler } from '../../utils';
-export interface UseStorageManager {
-    addFiles: (params: {
-        files: File[];
-        status: FileStatus;
-        getFileErrorMessage: GetFileErrorMessage;
-    }) => void;
-    clearFiles: () => void;
-    queueFiles: () => void;
-    setUploadingFile: TaskHandler;
-    setProcessedKey: (params: {
-        id: string;
-        processedKey: string;
-    }) => void;
-    setUploadProgress: (params: {
-        id: string;
-        progress: number;
-    }) => void;
-    setUploadSuccess: (params: {
-        id: string;
-    }) => void;
-    setUploadResumed: (params: {
-        id: string;
-    }) => void;
-    setUploadPaused: (params: {
-        id: string;
-    }) => void;
-    removeUpload: (params: {
-        id: string;
-    }) => void;
-    files: StorageFiles;
-}
-export declare function useStorageManager(defaultFiles?: Array<DefaultFile>): UseStorageManager;

package/dist/types/components/StorageManager/hooks/useUploadFiles/index.d.ts

@@ -1 +0,0 @@
-export { useUploadFiles, UseUploadFilesProps } from './useUploadFiles';

package/dist/types/components/StorageManager/hooks/useUploadFiles/useUploadFiles.d.ts

@@ -1,12 +0,0 @@
-import { PathCallback } from '../../utils';
-import { StorageManagerProps } from '../../types';
-import { UseStorageManager } from '../useStorageManager';
-export interface UseUploadFilesProps extends Pick<StorageManagerProps, 'isResumable' | 'onUploadSuccess' | 'onUploadError' | 'onUploadStart' | 'maxFileCount' | 'processFile' | 'useAccelerateEndpoint'>, Pick<UseStorageManager, 'setUploadingFile' | 'setUploadProgress' | 'setUploadSuccess' | 'files'> {
-    accessLevel?: StorageManagerProps['accessLevel'];
-    onProcessFileSuccess: (input: {
-        id: string;
-        processedKey: string;
-    }) => void;
-    path?: string | PathCallback;
-}
-export declare function useUploadFiles({ accessLevel, files, isResumable, maxFileCount, onProcessFileSuccess, onUploadError, onUploadStart, onUploadSuccess, path, processFile, setUploadingFile, setUploadProgress, setUploadSuccess, useAccelerateEndpoint, }: UseUploadFilesProps): void;

package/dist/types/components/StorageManager/utils/checkMaxFileSize.d.ts

@@ -1,5 +0,0 @@
-export declare const checkMaxFileSize: ({ file, getFileSizeErrorText, maxFileSize, }: {
-    file: File;
-    getFileSizeErrorText: (sizeText: string) => string;
-    maxFileSize?: number | undefined;
-}) => string;

package/dist/types/components/StorageManager/utils/displayText.d.ts

@@ -1,22 +0,0 @@
-import { DisplayTextTemplate } from '@aws-amplify/ui';
-export type StorageManagerDisplayText = DisplayTextTemplate<{
-    getFilesUploadedText?: (count: number) => string;
-    getFileSizeErrorText?: (sizeText: string) => string;
-    getRemainingFilesText?: (count: number) => string;
-    getSelectedFilesText?: (count: number) => string;
-    getUploadingText?: (percentage: number) => string;
-    getUploadButtonText?: (count: number) => string;
-    getMaxFilesErrorText?: (count: number) => string;
-    getErrorText?: (message: string) => string;
-    doneButtonText?: string;
-    clearAllButtonText?: string;
-    extensionNotAllowedText?: string;
-    browseFilesText?: string;
-    dropFilesText?: string;
-    pauseButtonText?: string;
-    resumeButtonText?: string;
-    uploadSuccessfulText?: string;
-    getPausedText?: (percentage: number) => string;
-}>;
-export type StorageManagerDisplayTextDefault = Required<StorageManagerDisplayText>;
-export declare const defaultStorageManagerDisplayText: StorageManagerDisplayTextDefault;

package/dist/types/components/StorageManager/utils/filterAllowedFiles.d.ts

@@ -1 +0,0 @@
-export declare const filterAllowedFiles: (files: File[], acceptedFileTypes?: string[]) => File[];

package/dist/types/components/StorageManager/utils/getInput.d.ts

@@ -1,17 +0,0 @@
-import { StorageAccessLevel } from '@aws-amplify/core';
-import { UploadDataWithPathInput, UploadDataInput } from 'aws-amplify/storage';
-import { ProcessFile } from '../types';
-import { PathCallback, PathInput } from './uploadFile';
-export interface GetInputParams {
-    accessLevel: StorageAccessLevel | undefined;
-    file: File;
-    key: string;
-    onProcessFileSuccess: (input: {
-        processedKey: string;
-    }) => void;
-    onProgress: NonNullable<UploadDataWithPathInput['options']>['onProgress'];
-    path: string | PathCallback | undefined;
-    processFile: ProcessFile | undefined;
-    useAccelerateEndpoint?: boolean;
-}
-export declare const getInput: ({ accessLevel, file, key, onProcessFileSuccess, onProgress, path, processFile, useAccelerateEndpoint, }: GetInputParams) => () => Promise<PathInput | UploadDataInput>;

package/dist/types/components/StorageManager/utils/index.d.ts

@@ -1,5 +0,0 @@
-export { checkMaxFileSize } from './checkMaxFileSize';
-export { defaultStorageManagerDisplayText, StorageManagerDisplayText, StorageManagerDisplayTextDefault, } from './displayText';
-export { filterAllowedFiles } from './filterAllowedFiles';
-export { getInput } from './getInput';
-export { PathCallback, TaskEvent, TaskHandler, uploadFile, UploadTask, } from './uploadFile';

package/dist/types/components/StorageManager/utils/resolveFile.d.ts

@@ -1,9 +0,0 @@
-import { ProcessFile, ProcessFileParams } from '../types';
-/**
- * Utility function that takes the processFile prop, along with a file a key
- * and returns a Promise that resolves to { file, key, ..rest }
- * regardless if processFile is defined and if it is sync or async
- */
-export declare const resolveFile: ({ processFile, ...input }: ProcessFileParams & {
-    processFile?: ProcessFile | undefined;
-}) => Promise<ProcessFileParams>;

package/dist/types/components/StorageManager/utils/uploadFile.d.ts

@@ -1,32 +0,0 @@
-import { UploadDataInput, UploadDataWithPathOutput, UploadDataWithPathInput, UploadDataOutput } from 'aws-amplify/storage';
-/**
- * Callback provided an input containing the current `identityId`
- *
- * @param {{identityId: string | undefined}} input - Input parameters
- * @returns target S3 bucket key
- */
-export type PathCallback = (input: {
-    identityId: string | undefined;
-}) => string;
-export type UploadTask = UploadDataOutput | UploadDataWithPathOutput;
-export interface TaskEvent {
-    id: string;
-    uploadTask: UploadTask;
-}
-export type PathInput = Omit<UploadDataWithPathInput, 'path'> & {
-    path: string;
-};
-export type TaskHandler = (event: TaskEvent) => void;
-export interface UploadFileProps {
-    input: () => Promise<PathInput | UploadDataInput>;
-    onComplete?: (result: Awaited<(UploadDataWithPathOutput | UploadDataOutput)['result']>) => void;
-    onError?: (event: {
-        key: string;
-        error: Error;
-    }) => void;
-    onStart?: (event: {
-        key: string;
-        uploadTask: UploadTask;
-    }) => void;
-}
-export declare function uploadFile({ input, onError, onStart, onComplete, }: UploadFileProps): Promise<UploadDataWithPathOutput | UploadDataOutput>;