@aws-amplify/ui-react-storage 0.0.0-studio-console-80bb2e2-20230921222703 → 0.0.0-theming-v2-f8422a3-20240627193426

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

@@ -1,3 +1,7 @@
 /// <reference types="react" />
-import type { StorageImageProps } from './types';
-export declare const StorageImage: ({ accessLevel, className, fallbackSrc, identityId, imgKey, onStorageGetError, ...rest }: StorageImageProps) => JSX.Element;
+import type { StorageImageProps, StorageImagePathProps } from './types';
+export declare const MISSING_REQUIRED_PROP_MESSAGE = "`StorageImage` requires either an `imgKey` or `path` prop.";
+export declare const HAS_DEPRECATED_PROPS_MESSAGE = "`imgKey`, `accessLevel`, and `identityId` will be replaced with `path` in a future major version. See https://ui.docs.amplify.aws/react/connected-components/storage/storageimage#props";
+export declare const HAS_PATH_AND_KEY_MESSAGE = "`imgKey` is ignored when both `imgKey` and `path` props are provided.";
+export declare const HAS_PATH_AND_UNSUPPORTED_OPTIONS_MESSAGE = "`accessLevel` and `identityId` are ignored when the `path` prop is provided.";
+export declare const StorageImage: ({ accessLevel, className, fallbackSrc, identityId, imgKey, path, onStorageGetError, onGetUrlError, validateObjectExistence, ...rest }: StorageImageProps | StorageImagePathProps) => JSX.Element;

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

@@ -1,9 +1,40 @@
-import type { StorageAccessLevel } from '@aws-amplify/storage';
-import type { ImageProps } from '@aws-amplify/ui-react';
+import { StorageAccessLevel } from '@aws-amplify/core';
+import { ImageProps } from '@aws-amplify/ui-react';
 export interface StorageImageProps extends Omit<ImageProps, 'src'> {
+    /**
+     * @deprecated
+     * `imgKey` will be replaced with `path` in a future major version of Amplify UI. See https://ui.docs.amplify.aws/react/connected-components/storage/storageimage#props
+     */
     imgKey: string;
+    /**
+     * @deprecated
+     * `accessLevel` will be replaced with `path` in a future major version of Amplify UI. See https://ui.docs.amplify.aws/react/connected-components/storage/storageimage#props
+     */
     accessLevel: StorageAccessLevel;
+    /**
+     * @deprecated
+     * `identityId` will be replaced with `path` in a future major version of Amplify UI. See https://ui.docs.amplify.aws/react/connected-components/storage/storageimage#props
+     */
     identityId?: string;
     fallbackSrc?: string;
+    validateObjectExistence?: boolean;
+    /**
+     * @deprecated use `onGetUrlError`
+     *
+     * `onStorageGetError` will be replaced with `onGetUrlError` in a future major version of Amplify UI. See https://ui.docs.amplify.aws/react/connected-components/storage/storageimage#props
+     */
     onStorageGetError?: (error: Error) => void;
+    onGetUrlError?: (error: Error) => void;
+    path?: never;
 }
+type OmittedPropKey = 'accessLevel' | 'imgKey' | 'identityId' | 'onStorageGetError' | 'path';
+export interface StorageImagePathProps extends Omit<StorageImageProps, OmittedPropKey> {
+    path: string | ((input: {
+        identityId?: string;
+    }) => string);
+    imgKey?: never;
+    accessLevel?: never;
+    identityId?: never;
+    onStorageGetError?: never;
+}
+export {};

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

@@ -1,7 +1,10 @@
 import * as React from 'react';
-import { StorageManagerProps, StorageManagerHandle } from './types';
+import { StorageManagerProps, StorageManagerPathProps, StorageManagerHandle } from './types';
 import { Container, DropZone, FileList, FileListHeader, FileListFooter, FilePicker } from './ui';
-declare const StorageManager: React.ForwardRefExoticComponent<StorageManagerProps & React.RefAttributes<StorageManagerHandle>> & {
+export declare const MISSING_REQUIRED_PROPS_MESSAGE = "`StorageManager` requires a `maxFileCount` prop to be provided.";
+export declare const ACCESS_LEVEL_WITH_PATH_CALLBACK_MESSAGE = "`StorageManager` does not allow usage of a `path` callback prop with an `accessLevel` prop.";
+export declare const ACCESS_LEVEL_DEPRECATION_MESSAGE = "`accessLevel` has been deprecated and will be removed in a future major version. See migration notes at https://ui.docs.amplify.aws/react/connected-components/storage/storagemanager";
+declare const StorageManager: React.ForwardRefExoticComponent<(StorageManagerProps | StorageManagerPathProps) & React.RefAttributes<StorageManagerHandle>> & {
     Container: typeof Container;
     DropZone: typeof DropZone;
     FileList: typeof FileList;

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

@@ -1,13 +1,10 @@
-import { UploadTask } from '@aws-amplify/storage';
 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 setUploadingFileAction: ({ id, uploadTask, }: {
-    id: string;
-    uploadTask: UploadTask | undefined;
-}) => Action;
+export declare const setUploadingFileAction: ({ id, uploadTask, }: TaskEvent) => Action;
 export declare const setUploadProgressAction: ({ id, progress, }: {
     id: string;
     progress: number;

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

@@ -1,5 +1,5 @@
-import type { UploadTask } from '@aws-amplify/storage';
 import { FileStatus, StorageFiles } from '../../types';
+import { UploadTask } from '../../utils';
 export interface UseStorageManagerState {
     files: StorageFiles;
 }

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

@@ -1,6 +1,6 @@
-import { UploadTask } 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?: UploadTask;
-    }) => 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' | 'provider' | '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, provider, path, }: UseUploadFilesProps): void;
+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,7 +1,7 @@
 import * as React from 'react';
-import type { StorageAccessLevel, UploadTask } 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",
@@ -22,7 +22,10 @@ export interface StorageFile {
 }
 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;
@@ -60,7 +63,7 @@ export interface StorageManagerProps {
     /**
      * Overrides default display text
      */
-    displayText?: Partial<StorageManagerDisplayText>;
+    displayText?: StorageManagerDisplayText;
     /**
      * Determines if upload can be paused / resumed
      */
@@ -106,14 +109,17 @@ export interface StorageManagerProps {
      */
     showThumbnails?: boolean;
     /**
-     * Storage provider name
-     * @see https://docs.amplify.aws/lib/storage/custom-plugin/q/platform/js/
+     * Provided value is prefixed to the file `key` for each file
      */
-    provider?: string;
+    path?: string;
+}
+export interface StorageManagerPathProps extends Omit<StorageManagerProps, 'accessLevel' | 'path'> {
     /**
-     * A path to put files in the s3 bucket.
-     * This will be prepended to the key sent to
-     * s3 for each file.
+     * 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;
+    path: string | PathCallback;
+    accessLevel?: never;
 }

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

@@ -1,31 +1,21 @@
-import type { UploadTask } from '@aws-amplify/storage';
-import { StorageManagerDisplayText } from '../../utils/displayText';
+import { StorageManagerDisplayTextDefault, TaskHandler } from '../../utils';
 import { FileStatus, StorageFile } from '../../types';
 export interface FileListProps {
-    displayText: StorageManagerDisplayText;
+    displayText: StorageManagerDisplayTextDefault;
     files: StorageFile[];
     isResumable: boolean;
-    onCancelUpload: (params: {
-        id: string;
-        uploadTask: UploadTask;
-    }) => void;
+    onCancelUpload: TaskHandler;
     onDeleteUpload: (params: {
         id: string;
     }) => void;
-    onPause: (params: {
-        id: string;
-        uploadTask: UploadTask;
-    }) => void;
-    onResume: (params: {
-        id: string;
-        uploadTask: UploadTask;
-    }) => void;
+    onPause: TaskHandler;
+    onResume: TaskHandler;
     showThumbnails: boolean;
     hasMaxFilesError: boolean;
     maxFileCount: number;
 }
 export interface FileControlProps {
-    displayText: StorageManagerDisplayText;
+    displayText: StorageManagerDisplayTextDefault;
     displayName: string;
     errorMessage: string;
     isImage: boolean;
@@ -41,7 +31,7 @@ export interface FileControlProps {
     status: FileStatus;
     thumbnailUrl: string;
 }
-export interface FileStatusMessageProps extends Pick<StorageManagerDisplayText, 'getUploadingText' | 'getPausedText' | 'uploadSuccessfulText'> {
+export interface FileStatusMessageProps extends Pick<StorageManagerDisplayTextDefault, 'getUploadingText' | 'getPausedText' | 'uploadSuccessfulText'> {
     status: FileStatus;
     errorMessage: string;
     percentage: number;

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

@@ -1,8 +1,8 @@
 /// <reference types="react" />
-import { StorageManagerDisplayText } from '../../utils';
+import { StorageManagerDisplayTextDefault } from '../../utils';
 export interface FileListFooterProps {
     remainingFilesCount: number;
-    displayText: StorageManagerDisplayText;
+    displayText: StorageManagerDisplayTextDefault;
     onClearAll: () => void;
     onUploadAll: () => void;
 }

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

@@ -1,8 +1,8 @@
 /// <reference types="react" />
-import { StorageManagerDisplayText } from '../../utils/displayText';
+import { StorageManagerDisplayTextDefault } from '../../utils';
 export interface FileListHeaderProps {
     allUploadsSuccessful: boolean;
-    displayText: StorageManagerDisplayText;
+    displayText: StorageManagerDisplayTextDefault;
     fileCount: number;
     remainingFilesCount: number;
     selectedFilesCount?: number;

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

@@ -1,20 +1,22 @@
-export declare const defaultStorageManagerDisplayText: {
-    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;
-    pauseText: string;
-    resumeText: string;
-    uploadSuccessfulText: string;
-    getPausedText(percentage: number): string;
-};
-export type StorageManagerDisplayText = typeof defaultStorageManagerDisplayText;
+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/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

@@ -1,5 +1,6 @@
 export { checkMaxFileSize } from './checkMaxFileSize';
-export { defaultStorageManagerDisplayText, StorageManagerDisplayText, } from './displayText';
+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,19 +1,32 @@
-import type { StorageAccessLevel, UploadTask } from '@aws-amplify/storage';
-export type UploadFileProps = {
-    file: File;
-    key: string;
-    level: StorageAccessLevel;
-    isResumable?: boolean;
-    progressCallback: (progress: {
-        loaded: number;
-        total: number;
+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;
-    errorCallback: (error: string) => void;
-    completeCallback: (event: {
-        key: string | undefined;
+    onStart?: (event: {
+        key: string;
+        uploadTask: UploadTask;
     }) => void;
-    provider?: string;
-} & Record<string, any>;
-type UploadFile = Promise<void> | UploadTask;
-export declare function uploadFile({ file, key, level, progressCallback, errorCallback, completeCallback, isResumable, provider, ...rest }: UploadFileProps): UploadFile;
-export {};
+}
+export declare function uploadFile({ input, onError, onStart, onComplete, }: UploadFileProps): Promise<UploadDataWithPathOutput | UploadDataOutput>;

package/dist/types/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "3.1.3";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-storage",
-  "version": "0.0.0-studio-console-80bb2e2-20230921222703",
+  "version": "0.0.0-theming-v2-f8422a3-20240627193426",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -35,51 +35,20 @@
     "prebuild": "rimraf dist",
     "size": "yarn size-limit",
     "test": "jest",
-    "test:ci": "yarn test && yarn check:esm",
     "test:watch": "yarn test --watch",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@aws-amplify/ui": "0.0.0-studio-console-80bb2e2-20230921222703",
-    "@aws-amplify/ui-react": "0.0.0-studio-console-80bb2e2-20230921222703",
-    "@aws-amplify/ui-react-core": "0.0.0-studio-console-80bb2e2-20230921222703",
-    "classnames": "2.3.1",
+    "@aws-amplify/ui": "0.0.0-theming-v2-f8422a3-20240627193426",
+    "@aws-amplify/ui-react": "0.0.0-theming-v2-f8422a3-20240627193426",
+    "@aws-amplify/ui-react-core": "0.0.0-theming-v2-f8422a3-20240627193426",
     "lodash": "4.17.21",
-    "tslib": "2.4.1"
+    "tslib": "^2.5.2"
   },
   "peerDependencies": {
-    "aws-amplify": "^5.0.1",
-    "react": ">= 16.14.0",
-    "react-dom": ">= 16.14.0"
-  },
-  "peerDependenciesMeta": {
-    "aws-amplify": {
-      "optional": true
-    }
-  },
-  "devDependencies": {
-    "@aws-amplify/eslint-config-amplify-ui": "0.0.0",
-    "@rollup/plugin-typescript": "^8.3.1",
-    "@size-limit/preset-big-lib": "^8.2.6",
-    "@testing-library/jest-dom": "^5.14.1",
-    "@testing-library/react": "^12.0.0",
-    "@testing-library/react-hooks": "^7.0.1",
-    "@testing-library/user-event": "^13.2.1",
-    "@types/jest": "^26.0.23",
-    "@types/react": "^17.0.2",
-    "@types/testing-library__jest-dom": "^5.14.1",
-    "eslint": "^8.44.0",
-    "jest": "^27.0.4",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.70.0",
-    "rollup-plugin-node-externals": "^4.1.1",
-    "rollup-plugin-styles": "^4.0.0",
-    "rollup-plugin-terser": "^7.0.2",
-    "size-limit": "^8.2.6",
-    "ts-jest": "^27.0.3",
-    "ts-morph": "^12.0.0"
+    "aws-amplify": "^6.3.2",
+    "react": "^16.14.0 || ^17.0 || ^18.0",
+    "react-dom": "^16.14.0 || ^17.0 || ^18.0"
   },
   "sideEffects": [
     "dist/**/*.css"
@@ -89,7 +58,7 @@
       "name": "StorageManager",
       "path": "dist/esm/index.mjs",
       "import": "{ StorageManager }",
-      "limit": "120 kB"
+      "limit": "25.5 kB"
     }
   ]
 }

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

@@ -1 +0,0 @@
-import{isFunction as e}from"@aws-amplify/ui";const i=({processFile:i,file:o,key:s})=>new Promise(((t,c)=>{const f=e(i)?i({file:o,key:s}):{file:o,key:s};f instanceof Promise?f.then(t).catch(c):t(f)}));export{i as resolveFile};

package/dist/types/components/StorageImage/_tests_/StorageImage.test.d.ts

@@ -1 +0,0 @@
-export {};

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 {};