@aws-amplify/ui-react-storage 3.0.18 → 3.1.0

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

@@ -1,6 +1,6 @@
-import { UploadDataOutput } from 'aws-amplify/storage';
 import { StorageFiles, FileStatus, DefaultFile } from '../../types';
 import { GetFileErrorMessage } from './types';
+import { TaskHandler } from '../../utils';
 export interface UseStorageManager {
     addFiles: (params: {
         files: File[];
@@ -9,10 +9,7 @@ export interface UseStorageManager {
     }) => void;
     clearFiles: () => void;
     queueFiles: () => void;
-    setUploadingFile: (params: {
-        id: string;
-        uploadTask?: UploadDataOutput;
-    }) => void;
+    setUploadingFile: TaskHandler;
     setUploadProgress: (params: {
         id: string;
         progress: number;

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

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

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

@@ -1,8 +1,7 @@
 import * as React from 'react';
-import type { UploadDataOutput } from 'aws-amplify/storage';
 import type { StorageAccessLevel } from '@aws-amplify/core';
 import { ContainerProps, DropZoneProps, FileListHeaderProps, FileListFooterProps, FileListProps, FilePickerProps } from './ui';
-import { StorageManagerDisplayText } from './utils';
+import { StorageManagerDisplayText, PathCallback, UploadTask } from './utils';
 export declare enum FileStatus {
     ADDED = "added",
     QUEUED = "queued",
@@ -16,14 +15,17 @@ export interface StorageFile {
     file?: File;
     status: FileStatus;
     progress: number;
-    uploadTask?: UploadDataOutput;
+    uploadTask?: UploadTask;
     key: string;
     error: string;
     isImage: boolean;
 }
 export type StorageFiles = StorageFile[];
 export type DefaultFile = Pick<StorageFile, 'key'>;
-export type ProcessFileParams = Required<Pick<StorageFile, 'file' | 'key'>> & Record<string, any>;
+export interface ProcessFileParams extends Record<string, any> {
+    file: File;
+    key: string;
+}
 export type ProcessFile = (params: ProcessFileParams) => Promise<ProcessFileParams> | ProcessFileParams;
 export interface StorageManagerHandle {
     clearFiles: () => void;
@@ -107,9 +109,17 @@ export interface StorageManagerProps {
      */
     showThumbnails?: boolean;
     /**
-     * A path to put files in the s3 bucket.
-     * This will be prepended to the key sent to
-     * s3 for each file.
+     * Provided value is prefixed to the file `key` for each file
      */
     path?: string;
 }
+export interface StorageManagerPathProps extends Omit<StorageManagerProps, 'accessLevel' | 'path'> {
+    /**
+     * S3 bucket key, allows either a `string` or a `PathCallback`:
+     * - `string`: `path` is prefixed to the file `key` for each file
+     * - `PathCallback`: callback provided an input containing the current `identityId`,
+     *    resolved value is prefixed to the file `key` for each file
+     */
+    path: string | PathCallback;
+    accessLevel?: never;
+}

package/dist/types/components/StorageManager/ui/FileList/types.d.ts

@@ -1,25 +1,15 @@
-import { UploadDataOutput } from 'aws-amplify/storage';
-import { StorageManagerDisplayTextDefault } from '../../utils';
+import { StorageManagerDisplayTextDefault, TaskHandler } from '../../utils';
 import { FileStatus, StorageFile } from '../../types';
 export interface FileListProps {
     displayText: StorageManagerDisplayTextDefault;
     files: StorageFile[];
     isResumable: boolean;
-    onCancelUpload: (params: {
-        id: string;
-        uploadTask: UploadDataOutput;
-    }) => void;
+    onCancelUpload: TaskHandler;
     onDeleteUpload: (params: {
         id: string;
     }) => void;
-    onPause: (params: {
-        id: string;
-        uploadTask: UploadDataOutput;
-    }) => void;
-    onResume: (params: {
-        id: string;
-        uploadTask: UploadDataOutput;
-    }) => void;
+    onPause: TaskHandler;
+    onResume: TaskHandler;
     showThumbnails: boolean;
     hasMaxFilesError: boolean;
     maxFileCount: number;

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

@@ -0,0 +1,13 @@
+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;
+    onProgress: NonNullable<UploadDataWithPathInput['options']>['onProgress'];
+    path: string | PathCallback | undefined;
+    processFile: ProcessFile | undefined;
+}
+export declare const getInput: ({ accessLevel, file, key, onProgress, path, processFile, }: GetInputParams) => () => Promise<PathInput | UploadDataInput>;

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

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

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

@@ -0,0 +1,9 @@
+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,13 +1,32 @@
-import { StorageAccessLevel } from '@aws-amplify/core';
-import { TransferProgressEvent, UploadDataOutput } from 'aws-amplify/storage';
-export type UploadFileProps = {
-    file: File;
-    key: string;
-    level: StorageAccessLevel;
-    progressCallback: (event: TransferProgressEvent) => void;
-    errorCallback: (error: string) => void;
-    completeCallback: (event: {
-        key: string | undefined;
+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;
-} & Record<string, any>;
-export declare function uploadFile({ file, key, level, progressCallback: onProgress, errorCallback, completeCallback, ...rest }: UploadFileProps): UploadDataOutput;
+    onStart?: (event: {
+        key: string;
+        uploadTask: UploadTask;
+    }) => void;
+}
+export declare function uploadFile({ input, onError, onStart, onComplete, }: UploadFileProps): Promise<UploadDataWithPathOutput | UploadDataOutput>;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "3.0.18";
+export declare const VERSION = "3.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-storage",
-  "version": "3.0.18",
+  "version": "3.1.0",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -39,14 +39,14 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@aws-amplify/ui": "6.0.13",
-    "@aws-amplify/ui-react": "6.1.8",
-    "@aws-amplify/ui-react-core": "3.0.13",
+    "@aws-amplify/ui": "6.0.14",
+    "@aws-amplify/ui-react": "6.1.9",
+    "@aws-amplify/ui-react-core": "3.0.14",
     "lodash": "4.17.21",
     "tslib": "^2.5.2"
   },
   "peerDependencies": {
-    "aws-amplify": "^6.0.26",
+    "aws-amplify": "^6.2.0",
     "react": "^16.14.0 || ^17.0 || ^18.0",
     "react-dom": "^16.14.0 || ^17.0 || ^18.0"
   },
@@ -58,7 +58,7 @@
       "name": "StorageManager",
       "path": "dist/esm/index.mjs",
       "import": "{ StorageManager }",
-      "limit": "25 kB"
+      "limit": "25.5 kB"
     }
   ]
 }

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

@@ -1,10 +0,0 @@
-import { ProcessFileParams, StorageManagerProps } from '../../types';
-interface ResolveFileParams extends Pick<StorageManagerProps, 'processFile'>, ProcessFileParams {
-}
-/**
- * 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, file, key, }: ResolveFileParams) => Promise<ProcessFileParams>;
-export {};