@aws-amplify/ui-react-storage 3.2.1 → 3.3.1

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

@@ -0,0 +1,51 @@
+import { FileUploaderDisplayTextDefault, TaskHandler } from '../../utils';
+import { FileStatus, StorageFile } from '../../types';
+export interface FileListProps {
+    displayText: FileUploaderDisplayTextDefault;
+    files: StorageFile[];
+    isResumable: boolean;
+    onCancelUpload: TaskHandler;
+    onDeleteUpload: (params: {
+        id: string;
+    }) => void;
+    onPause: TaskHandler;
+    onResume: TaskHandler;
+    showThumbnails: boolean;
+    hasMaxFilesError: boolean;
+    maxFileCount: number;
+}
+export interface FileControlProps {
+    displayText: FileUploaderDisplayTextDefault;
+    displayName: string;
+    errorMessage: string;
+    isImage: boolean;
+    isResumable: boolean;
+    isUploading: boolean;
+    loaderIsDeterminate: boolean;
+    onRemove: () => void;
+    onPause: () => void;
+    onResume: () => void;
+    progress: number;
+    showThumbnails: boolean;
+    size?: number;
+    status: FileStatus;
+    thumbnailUrl: string;
+}
+export interface FileStatusMessageProps extends Pick<FileUploaderDisplayTextDefault, 'getUploadingText' | 'getPausedText' | 'uploadSuccessfulText'> {
+    status: FileStatus;
+    errorMessage: string;
+    percentage: number;
+}
+export interface UploadDetailsProps {
+    displayName: string;
+    fileSize?: number;
+}
+export interface FileThumbnailProps {
+    isImage: boolean;
+    fileName: string;
+    url: string;
+}
+export interface FileRemoveButtonProps {
+    altText: string;
+    onClick: () => void;
+}

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

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { FileUploaderDisplayTextDefault } from '../../utils';
+export interface FileListFooterProps {
+    remainingFilesCount: number;
+    displayText: FileUploaderDisplayTextDefault;
+    onClearAll: () => void;
+    onUploadAll: () => void;
+}
+export declare function FileListFooter({ displayText, remainingFilesCount, onClearAll, onUploadAll, }: FileListFooterProps): JSX.Element;

package/dist/types/components/FileUploader/ui/FileListFooter/index.d.ts

@@ -0,0 +1 @@
+export { FileListFooter, FileListFooterProps } from './FileListFooter';

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

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { FileUploaderDisplayTextDefault } from '../../utils';
+export interface FileListHeaderProps {
+    allUploadsSuccessful: boolean;
+    displayText: FileUploaderDisplayTextDefault;
+    fileCount: number;
+    remainingFilesCount: number;
+    selectedFilesCount?: number;
+}
+export declare function FileListHeader({ allUploadsSuccessful, displayText, fileCount, remainingFilesCount, selectedFilesCount, }: FileListHeaderProps): JSX.Element;

package/dist/types/components/FileUploader/ui/FileListHeader/index.d.ts

@@ -0,0 +1 @@
+export { FileListHeader, FileListHeaderProps } from './FileListHeader';

package/dist/types/components/FileUploader/ui/FilePicker/FilePicker.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { ButtonProps } from '@aws-amplify/ui-react';
+export type FilePickerProps = ButtonProps;
+export declare function FilePicker({ children, className, size, ...props }: FilePickerProps): JSX.Element;

package/dist/types/components/FileUploader/ui/FilePicker/index.d.ts

@@ -0,0 +1 @@
+export { FilePicker, FilePickerProps } from './FilePicker';

package/dist/types/components/FileUploader/ui/index.d.ts

@@ -0,0 +1,6 @@
+export { Container, ContainerProps } from './Container';
+export { DropZone, DropZoneProps } from './DropZone';
+export { FileList, FileListProps } from './FileList';
+export { FileListHeader, FileListHeaderProps } from './FileListHeader';
+export { FileListFooter, FileListFooterProps } from './FileListFooter';
+export { FilePicker, FilePickerProps } from './FilePicker';

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

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

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

@@ -0,0 +1,22 @@
+import { DisplayTextTemplate } from '@aws-amplify/ui';
+export type FileUploaderDisplayText = 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 FileUploaderDisplayTextDefault = Required<FileUploaderDisplayText>;
+export declare const defaultFileUploaderDisplayText: FileUploaderDisplayTextDefault;

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

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

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

@@ -0,0 +1,17 @@
+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/FileUploader/utils/index.d.ts

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

package/dist/types/components/FileUploader/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/FileUploader/utils/uploadFile.d.ts

@@ -0,0 +1,32 @@
+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>;

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

@@ -1,2 +1,3 @@
+export { FileUploader, FileUploaderProps } from './FileUploader';
 export { StorageImage, StorageImageProps } from './StorageImage';
 export { StorageManager, StorageManagerProps, DropZoneProps, ContainerProps, FileListProps, FilePickerProps, FileListHeaderProps, FileListFooterProps, } from './StorageManager';

package/dist/types/index.d.ts

@@ -1 +1 @@
-export { StorageImage, StorageImageProps, StorageManager, StorageManagerProps, DropZoneProps, ContainerProps, FileListProps, FilePickerProps, FileListHeaderProps, FileListFooterProps, } from './components';
+export { FileUploader, FileUploaderProps, StorageImage, StorageImageProps, StorageManager, StorageManagerProps, DropZoneProps, ContainerProps, FileListProps, FilePickerProps, FileListHeaderProps, FileListFooterProps, } from './components';

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "3.2.1";
+export declare const VERSION = "3.3.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-storage",
-  "version": "3.2.1",
+  "version": "3.3.1",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -39,9 +39,9 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@aws-amplify/ui": "6.2.0",
-    "@aws-amplify/ui-react": "6.2.1",
-    "@aws-amplify/ui-react-core": "3.0.19",
+    "@aws-amplify/ui": "6.4.0",
+    "@aws-amplify/ui-react": "6.3.0",
+    "@aws-amplify/ui-react-core": "3.0.21",
     "lodash": "4.17.21",
     "tslib": "^2.5.2"
   },
@@ -54,11 +54,23 @@
     "dist/**/*.css"
   ],
   "size-limit": [
+    {
+      "name": "FileUploader",
+      "path": "dist/esm/index.mjs",
+      "import": "{ FileUploader }",
+      "limit": "25 kB"
+    },
+    {
+      "name": "StorageImage",
+      "path": "dist/esm/index.mjs",
+      "import": "{ StorageImage }",
+      "limit": "17 kB"
+    },
     {
       "name": "StorageManager",
       "path": "dist/esm/index.mjs",
       "import": "{ StorageManager }",
-      "limit": "25.5 kB"
+      "limit": "25 kB"
     }
   ]
 }