@aws-amplify/ui-react-storage 3.9.1 → 3.9.2

package/dist/esm/components/StorageBrowser/views/utils/tableResolvers/uploadResolvers.mjs

@@ -0,0 +1,112 @@
+import { capitalize } from '@aws-amplify/ui';
+import { STATUS_ICONS, STATUS_LABELS } from './constants.mjs';
+import { getCellName, getUploadCellFolder, getFileType, getFileSize, getUploadCellProgress } from './utils.mjs';
+
+const UPLOAD_TABLE_KEYS = [
+    'name',
+    'folder',
+    'type',
+    'size',
+    'status',
+    'progress',
+    'cancel',
+];
+const getUploadCellKey = ({ key, item, }) => `${key}-${item.data.id}`;
+const name = (data) => {
+    const key = getUploadCellKey(data);
+    const { item } = data;
+    const icon = STATUS_ICONS[item.status];
+    const text = getCellName(item.data.key);
+    return { key, type: 'text', content: { icon, text } };
+};
+const folder = (data) => {
+    const key = getUploadCellKey(data);
+    const text = getUploadCellFolder(data.item);
+    return { key, type: 'text', content: { text } };
+};
+const type = (data) => {
+    const key = getUploadCellKey(data);
+    const { item } = data;
+    const text = getFileType(getCellName(item.data.key));
+    return { key, type: 'text', content: { text } };
+};
+const size = (data) => {
+    const key = getUploadCellKey(data);
+    const { size: value } = data.item.data.file;
+    const displayValue = getFileSize(value);
+    return { key, type: 'number', content: { value, displayValue } };
+};
+const status = (data) => {
+    const key = getUploadCellKey(data);
+    const { item: { status }, props: { displayText }, } = data;
+    const text = displayText[STATUS_LABELS[status]];
+    return { key, type: 'text', content: { text } };
+};
+const progress = (data) => {
+    const key = getUploadCellKey(data);
+    const content = getUploadCellProgress(data.item);
+    return { key, type: 'number', content };
+};
+const cancel = (data) => {
+    const key = getUploadCellKey(data);
+    const { item, props } = data;
+    const { cancel, data: taskData, status, progress } = item;
+    const { isMultipartUpload, isProcessing, onTaskRemove } = props;
+    const isQueued = status === 'QUEUED';
+    const isPending = status === 'PENDING';
+    // cancelability is dependent on differing conditions for multipart and single part uploads
+    let isCancelable;
+    if (isMultipartUpload(taskData.file)) {
+        // signals MPU complete has been reached
+        const hasUploadedAllBytes = progress === 1;
+        // MPU allows cancel when tasks processing has begun and task is queued or
+        // pending but not yet reached MPU complete
+        isCancelable =
+            isProcessing && (isQueued || isPending) && !hasUploadedAllBytes;
+    }
+    else {
+        // single part upload allows cancel when processing has begun and task is queued
+        isCancelable = isProcessing && isQueued;
+    }
+    // all uploads are removable prior to processing start. Including `isQueued`
+    // ensures that `isRemovable` is `false` on all tasks processing complete
+    const isRemovable = !isProcessing && isQueued;
+    const isDisabled = !isRemovable && !isCancelable;
+    const ariaLabel = `${isRemovable ? 'Remove' : 'Cancel'} item: ${getCellName(item.data.key)}`;
+    // resolve to `undefined` if not cancelable or removable
+    const onClick = !isCancelable && !isRemovable
+        ? undefined
+        : () => {
+            if (isRemovable) {
+                onTaskRemove?.(item);
+                // do not run cancel handler on remove
+                return;
+            }
+            if (!!cancel && isCancelable)
+                cancel();
+        };
+    const content = { ariaLabel, isDisabled, onClick, icon: 'cancel' };
+    return { key, type: 'button', content };
+};
+const UPLOAD_CELL_RESOLVERS = {
+    cancel,
+    folder,
+    name,
+    progress,
+    size,
+    status,
+    type,
+};
+const UPLOAD_TABLE_RESOLVERS = {
+    getCell: (data) => UPLOAD_CELL_RESOLVERS[data.key](data),
+    getHeader: ({ key, props: { displayText } }) => {
+        const text = displayText[`tableColumn${capitalize(key)}Header`];
+        if (key === 'cancel') {
+            return { key, type: 'text', content: { text } };
+        }
+        return { key, type: 'sort', content: { label: text } };
+    },
+    getRowKey: ({ item }) => item.data.id,
+};
+
+export { UPLOAD_TABLE_KEYS, UPLOAD_TABLE_RESOLVERS };

package/dist/esm/components/StorageBrowser/views/utils/tableResolvers/utils.mjs

@@ -0,0 +1,49 @@
+import { humanFileSize } from '@aws-amplify/ui';
+
+const getFileType = (value, fallback = '') => value.lastIndexOf('.') !== -1
+    ? value.slice(value.lastIndexOf('.') + 1)
+    : fallback;
+const getCellName = (value) => 
+// `value.split` always returns an array with at least one entry
+// ensruing `.pop()` will always return a string
+value.split('/').pop();
+const getUploadCellFolder = ({ data: { file: { webkitRelativePath }, }, }, fallback = '-') => webkitRelativePath
+    ? webkitRelativePath.slice(0, webkitRelativePath.lastIndexOf('/') + 1)
+    : fallback;
+const getCopyCellFolder = ({ data: { fileKey, sourceKey }, }) => sourceKey.slice(0, -fileKey.length);
+const getDeleteCellFolder = ({ data: { fileKey, key }, }) => key.slice(0, -fileKey.length);
+const getUploadCellProgress = ({ progress, status, }) => {
+    // prefer `progress` if available, 1 if status is complete, default 0
+    const value = progress ?? (status === 'COMPLETE' ? 1 : 0);
+    const displayValue = `${Math.round(value * 100)}%`;
+    return { displayValue, value };
+};
+const getFileSize = (value, fallback = '-') => (!value ? fallback : humanFileSize(value, true));
+const getCopyOrDeleteCancelCellContent = (data) => {
+    const { item, props } = data;
+    const { cancel, status } = item;
+    const { isProcessing, onTaskRemove } = props;
+    const isQueued = status === 'QUEUED';
+    // a task is removable prior to processing start. Including `isQueued` ensures
+    // that `isRemovable` is `false` on all tasks processing complete
+    const isRemovable = isQueued && !isProcessing;
+    // a task is cancelable while processing is true, and the task has a cancel handler
+    const isCancelable = isProcessing && !!cancel;
+    const ariaLabel = `${isRemovable ? 'Remove' : 'Cancel'} item: ${getCellName(item.data.fileKey)}`;
+    const isDisabled = !isRemovable && !isCancelable;
+    // resolve to `undefined` if not cancelable or removable
+    const onClick = !isCancelable && !isRemovable
+        ? undefined
+        : () => {
+            if (isRemovable) {
+                onTaskRemove?.(item);
+                // do not run cancel handler on remove
+                return;
+            }
+            if (isCancelable)
+                cancel();
+        };
+    return { ariaLabel, isDisabled, onClick, icon: 'cancel' };
+};
+
+export { getCellName, getCopyCellFolder, getCopyOrDeleteCancelCellContent, getDeleteCellFolder, getFileSize, getFileType, getUploadCellFolder, getUploadCellProgress };

package/dist/esm/version.mjs

@@ -1,3 +1,3 @@
-const VERSION = '3.9.1';
+const VERSION = '3.9.2';
 
 export { VERSION };

package/dist/index.js

@@ -9,7 +9,7 @@ var uiReactCore = require('@aws-amplify/ui-react-core');
 var auth = require('aws-amplify/auth');
 var storage = require('aws-amplify/storage');
 var internal = require('@aws-amplify/ui-react/internal');
-var createAmplifyAuthAdapter = require('./createAmplifyAuthAdapter-Cf4yJo1e.js');
+var createAmplifyAuthAdapter = require('./createAmplifyAuthAdapter-BJjOYxQA.js');
 require('@aws-amplify/storage/internals');
 require('@aws-amplify/ui-react-core/elements');
 require('aws-amplify');

package/dist/types/components/StorageBrowser/ComponentsProvider.d.ts

@@ -1,7 +1,10 @@
 import React from 'react';
 import { Composables } from './composables';
 import { StorageBrowserElements } from './context/elements';
-export interface Components extends Partial<Composables> {
+/**
+ * Override/Custom component slots
+ */
+export interface StorageBrowserComponents extends Partial<Composables> {
 }
 export interface ComponentsProviderProps {
     children?: React.ReactNode;

package/dist/types/components/StorageBrowser/actions/configs/types.d.ts

@@ -1,9 +1,44 @@
 import { StorageBrowserIconType } from '../../context/elements';
 import { CopyHandler, CreateFolderHandler, DeleteHandler, DownloadHandler, ListLocationItemsHandler, ListLocations, LocationItemData, LocationPermissions, TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOutput, UploadHandler } from '../handlers';
-export type ActionHandler<TData = any, RValue = any> = TaskHandler<TaskHandlerInput<TData & TaskData>, TaskHandlerOutput<RValue>>;
+/**
+ * Utility type representing the function signature of `StorageBrowser` action handlers. First
+ * positional generic adds additional properties to `data` parameter, second positional
+ * generic specifies optional return value provided to `options.onSuccess` callback and
+ * `Task.value`.
+ *
+ * @example
+ * ```ts
+ * interface MyData {
+ *   user: {
+ *     name: string
+ *     id: string
+ *   };
+ * }
+ *
+ * interface MyReturnValue {
+ *   link: string;
+ * }
+ *
+ * type CreateDownloadLink = ActionHandler<MyData, MyReturnValue>;
+ *
+ * const createDownloadLink: CreateDownloadLink = (input) => {
+ *   // `config` is provided to handler, includes location data, credentials
+ *   const { config, data } = input;
+ *   const { user } = data;
+ *
+ *   const result = generatePresignedUrl(user, credentials).then((res) => ({
+ *     status: 'COMPLETE' as const,
+ *     value: { link: res.url.toString() },
+ *   }));
+ *
+ *   return { result };
+ * }
+ * ```
+ */
+export type ActionHandler<TData = any, TValue = any> = TaskHandler<TaskHandlerInput<TData & TaskData>, TaskHandlerOutput<TValue>>;
 type StringWithoutSpaces<T extends string> = Exclude<T, ` ${string}` | `${string} ` | `${string} ${string}`>;
 export type ViewName = Capitalize<`${string}View`>;
-export type ActionName<T extends string = string> = StringWithoutSpaces<T>;
+export type ActionName<K extends string = string> = StringWithoutSpaces<K>;
 export interface ActionListItemConfig {
     /**
      * conditionally disable item selection based on currently selected values
@@ -69,6 +104,10 @@ export interface DefaultActionConfigs {
 export interface ExtendedDefaultActionConfigs extends Required<DefaultActionConfigs> {
     listLocations: ListLocations;
 }
+/**
+ * Accepts either an `ActionViewConfig` for creation of an action list item and corresponding
+ * view slot or an action handler for standalone action usage
+ */
 export type CustomActionConfigs = Record<ActionName, ActionViewConfig | ActionHandler>;
 /**
  * @internal @unstable

package/dist/types/components/StorageBrowser/actions/handlers/constants.d.ts

@@ -1 +1,2 @@
 export declare const DEFAULT_CHECKSUM_ALGORITHM = "crc-32";
+export declare const MULTIPART_UPLOAD_THRESHOLD_BYTES: number;

package/dist/types/components/StorageBrowser/actions/handlers/copy.d.ts

@@ -1,13 +1,10 @@
-import { TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOptions, TaskHandlerOutput } from './types';
-export interface CopyHandlerData extends TaskData {
-    sourceKey: string;
-    eTag?: string;
+import { OptionalFileData, TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOptions, TaskHandlerOutput } from './types';
+export interface CopyHandlerData extends OptionalFileData, TaskData {
     fileKey: string;
     lastModified: Date;
+    sourceKey: string;
 }
-export interface CopyHandlerInput extends TaskHandlerInput<CopyHandlerData, TaskHandlerOptions<{
-    key: string;
-}>> {
+export interface CopyHandlerInput extends TaskHandlerInput<CopyHandlerData, TaskHandlerOptions> {
 }
 export interface CopyHandlerOutput extends TaskHandlerOutput<{
     key: string;

package/dist/types/components/StorageBrowser/actions/handlers/createFolder.d.ts

@@ -2,9 +2,7 @@ import { TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOutput, TaskHandler
 export interface CreateFolderHandlerData extends TaskData {
     preventOverwrite?: boolean;
 }
-export interface CreateFolderHandlerOptions extends TaskHandlerOptions<{
-    key: string;
-}> {
+export interface CreateFolderHandlerOptions extends TaskHandlerOptions {
 }
 export interface CreateFolderHandlerInput extends TaskHandlerInput<CreateFolderHandlerData, CreateFolderHandlerOptions> {
 }

package/dist/types/components/StorageBrowser/actions/handlers/defaults.d.ts

@@ -0,0 +1,15 @@
+import { CopyHandler } from './copy';
+import { CreateFolderHandler } from './createFolder';
+import { DeleteHandler } from './delete';
+import { DownloadHandler } from './download';
+import { ListLocationItemsHandler } from './listLocationItems';
+import { UploadHandler } from './upload';
+export interface DefaultHandlers {
+    copy: CopyHandler;
+    createFolder: CreateFolderHandler;
+    delete: DeleteHandler;
+    download: DownloadHandler;
+    listLocationItems: ListLocationItemsHandler;
+    upload: UploadHandler;
+}
+export declare const defaultHandlers: DefaultHandlers;

package/dist/types/components/StorageBrowser/actions/handlers/delete.d.ts

@@ -1,7 +1,7 @@
-import { TaskHandler, TaskHandlerOptions, TaskHandlerInput, TaskHandlerOutput, TaskData } from './types';
+import { OptionalFileData, TaskHandler, TaskHandlerOptions, TaskHandlerInput, TaskHandlerOutput, TaskData } from './types';
 export interface DeleteHandlerOptions extends TaskHandlerOptions {
 }
-export interface DeleteHandlerData extends TaskData {
+export interface DeleteHandlerData extends OptionalFileData, TaskData {
     fileKey: string;
 }
 export interface DeleteHandlerInput extends TaskHandlerInput<DeleteHandlerData, DeleteHandlerOptions> {

package/dist/types/components/StorageBrowser/actions/handlers/index.d.ts

@@ -1,5 +1,6 @@
 export * from './copy';
 export * from './createFolder';
+export * from './defaults';
 export * from './delete';
 export * from './download';
 export * from './listLocationItems';

package/dist/types/components/StorageBrowser/actions/handlers/listLocations.d.ts

@@ -1,5 +1,4 @@
-import { LocationCredentialsProvider } from '../../storage-internal';
-import { ListHandlerOptions, ListHandler, ListLocationsExcludeOptions, LocationData } from './types';
+import { ListHandlerOptions, ListHandler, ListLocationsExcludeOptions, LocationData, ActionInputConfig } from './types';
 export interface ListLocationsOptions extends ListLocationsHandlerOptions {
 }
 export interface ListLocationsInput {
@@ -15,16 +14,9 @@ export interface ListLocationsHandlerOptions extends ListHandlerOptions<ListLoca
 }
 export interface ListLocationsHandlerInput {
     options?: ListLocationsHandlerOptions;
-    config: {
-        accountId?: string;
-        credentials: LocationCredentialsProvider;
-        customEndpoint?: string;
-        region: string;
-    };
-}
-export interface ListLocationsHandlerOutput {
-    items: LocationData[];
-    nextToken: string | undefined;
+    config: Omit<ActionInputConfig, 'bucket'>;
+}
+export interface ListLocationsHandlerOutput extends ListLocationsOutput {
 }
 export interface ListLocationsHandler extends ListHandler<ListLocationsHandlerInput, ListLocationsHandlerOutput> {
 }

package/dist/types/components/StorageBrowser/actions/handlers/types.d.ts

@@ -48,6 +48,8 @@ export interface FileDataItem extends FileData, TaskData {
 export interface FileItem extends TaskData {
     file: File;
 }
+export interface OptionalFileData extends Partial<Omit<FileData, 'id' | 'key'>> {
+}
 export interface ActionInputConfig {
     accountId?: string;
     bucket: string;
@@ -64,32 +66,39 @@ export interface TaskData {
     key: string;
     id: string;
 }
-export interface TaskHandlerOptions<V = any> {
+export interface TaskHandlerOptions {
     onProgress?: (data: {
         key: string;
         id: string;
     }, progress: number | undefined) => void;
-    onSuccess?: (data: {
-        key: string;
-        id: string;
-    }, value: V) => void;
-    onError?: (data: {
-        key: string;
-        id: string;
-    }, message: string | undefined) => void;
 }
-export interface TaskHandlerInput<T extends TaskData = TaskData, K extends TaskHandlerOptions = TaskHandlerOptions> {
+export interface TaskHandlerInput<TData extends TaskData = TaskData, TOptions extends TaskHandlerOptions = TaskHandlerOptions> {
     config: ActionInputConfig;
-    data: T;
-    options?: K;
+    data: TData;
+    options?: TOptions;
+}
+export type TaskResultStatus = 'CANCELED' | 'COMPLETE' | 'FAILED' | 'OVERWRITE_PREVENTED';
+export interface TaskResult<TStatus, TValue> {
+    /**
+     * result error (if any)
+     */
+    error?: Error;
+    /**
+     * result message (if any)
+     */
+    message?: string;
+    /**
+     * task result status
+     */
+    status: TStatus;
+    /**
+     * task result value (if any)
+     */
+    value?: TValue;
 }
 export interface TaskHandlerOutput<K = any> {
     cancel?: () => void;
-    result: Promise<{
-        message?: string;
-        status: 'CANCELED' | 'COMPLETE' | 'FAILED' | 'OVERWRITE_PREVENTED';
-        value?: K;
-    }>;
+    result: Promise<TaskResult<TaskResultStatus, K>>;
 }
 export type TaskHandler<T = any, K = any> = (input: T) => K;
 export interface ListHandlerOptions<T = never> {

package/dist/types/components/StorageBrowser/actions/handlers/upload.d.ts

@@ -1,7 +1,5 @@
 import { TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOutput, TaskHandlerOptions } from './types';
-export interface UploadHandlerOptions extends TaskHandlerOptions<{
-    key: string;
-}> {
+export interface UploadHandlerOptions extends TaskHandlerOptions {
 }
 export interface UploadHandlerData extends TaskData {
     file: File;
@@ -15,7 +13,6 @@ export interface UploadHandlerOutput extends TaskHandlerOutput<{
 }
 export interface UploadHandler extends TaskHandler<UploadHandlerInput, UploadHandlerOutput> {
 }
-export declare const MULTIPART_UPLOAD_THRESHOLD_BYTES: number;
 export declare const UNDEFINED_CALLBACKS: {
     cancel: undefined;
     pause: undefined;

package/dist/types/components/StorageBrowser/actions/handlers/utils.d.ts

@@ -1,7 +1,6 @@
 import { TransferProgressEvent } from 'aws-amplify/storage';
 import { LocationAccess as AccessGrantLocation } from '../../storage-internal';
-import { ListLocationsExcludeOptions } from './types';
-import { ActionInputConfig, FileData, FileDataItem, FileItem, LocationData } from './types';
+import { ActionInputConfig, FileData, FileDataItem, FileItem, ListLocationsExcludeOptions, LocationData } from './types';
 export declare const constructBucket: ({ bucket: bucketName, region, }: Pick<ActionInputConfig, 'bucket' | 'region'>) => {
     bucketName: string;
     region: string;
@@ -14,3 +13,4 @@ export declare const createFileDataItem: (data: FileData) => FileDataItem;
 export declare const isFileItem: (value: unknown) => value is FileItem;
 export declare const isFileDataItem: (item: unknown) => item is FileDataItem;
 export declare const getProgress: ({ totalBytes, transferredBytes, }: TransferProgressEvent) => number | undefined;
+export declare const isMultipartUpload: (file: File) => boolean;

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

@@ -1,2 +1,2 @@
-export { ActionInputConfig, copyHandler, CopyHandler, CopyHandlerData, CopyHandlerInput, CopyHandlerOutput, createFileDataItem, createFolderHandler, CreateFolderHandler, CreateFolderHandlerData, CreateFolderHandlerInput, CreateFolderHandlerOptions, CreateFolderHandlerOutput, downloadHandler, DownloadHandler, DownloadHandlerData, DownloadHandlerInput, DownloadHandlerOptions, DownloadHandlerOutput, DeleteHandler, DeleteHandlerData, DeleteHandlerInput, DeleteHandlerOptions, DeleteHandlerOutput, FileData, FileDataItem, FileItem, FolderData, isFileDataItem, isFileItem, ListHandler, ListHandlerInput, ListHandlerOptions, ListHandlerOutput, listLocationItemsHandler, ListLocationItemsHandler, ListLocationItemsHandlerInput, ListLocationItemsHandlerOptions, ListLocationItemsHandlerOutput, ListLocationsExcludeOptions, ListLocations, ListLocationsInput, ListLocationsOutput, listLocationsHandler, ListLocationsHandler, ListLocationsHandlerInput, ListLocationsHandlerOptions, ListLocationsHandlerOutput, LocationData, LocationItemData, LocationItemType, LocationPermissions, LocationType, TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOptions, TaskHandlerOutput, uploadHandler, UploadHandler, UploadHandlerData, UploadHandlerInput, UploadHandlerOptions, UploadHandlerOutput, } from './handlers';
+export { ActionInputConfig, copyHandler, CopyHandler, CopyHandlerData, CopyHandlerInput, CopyHandlerOutput, createFileDataItem, createFolderHandler, CreateFolderHandler, CreateFolderHandlerData, CreateFolderHandlerInput, CreateFolderHandlerOptions, CreateFolderHandlerOutput, defaultHandlers, DefaultHandlers, downloadHandler, DownloadHandler, DownloadHandlerData, DownloadHandlerInput, DownloadHandlerOptions, DownloadHandlerOutput, DeleteHandler, DeleteHandlerData, DeleteHandlerInput, DeleteHandlerOptions, DeleteHandlerOutput, FileData, FileDataItem, FileItem, FolderData, isFileDataItem, isFileItem, isMultipartUpload, ListHandler, ListHandlerInput, ListHandlerOptions, ListHandlerOutput, listLocationItemsHandler, ListLocationItemsHandler, ListLocationItemsHandlerInput, ListLocationItemsHandlerOptions, ListLocationItemsHandlerOutput, ListLocationsExcludeOptions, ListLocations, ListLocationsInput, ListLocationsOutput, listLocationsHandler, ListLocationsHandler, ListLocationsHandlerInput, ListLocationsHandlerOptions, ListLocationsHandlerOutput, LocationData, LocationItemData, LocationItemType, LocationPermissions, LocationType, TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOptions, TaskHandlerOutput, TaskResult, TaskResultStatus, uploadHandler, UploadHandler, UploadHandlerData, UploadHandlerInput, UploadHandlerOptions, UploadHandlerOutput, } from './handlers';
 export { ExtendedActionConfigs, ActionViewConfig, ActionViewConfigs, ActionConfigsProvider, ActionConfigsProviderProps, ActionHandler, CustomActionConfigs, defaultActionConfigs, DefaultActionConfigs, defaultActionViewConfigs, getActionConfigs, isDefaultActionViewType, useActionConfigs, } from './configs';

package/dist/types/components/StorageBrowser/componentsDefault.d.ts

@@ -1,2 +1,2 @@
-import { Components } from './ComponentsProvider';
-export declare const componentsDefault: Components;
+import { StorageBrowserComponents } from './ComponentsProvider';
+export declare const componentsDefault: StorageBrowserComponents;

package/dist/types/components/StorageBrowser/createStorageBrowser.d.ts

@@ -1,3 +1,9 @@
 import { ExtendedActionConfigs } from './actions';
 import { CreateStorageBrowserInput, CreateStorageBrowserOutput } from './types';
+/**
+ * Creates a `StorageBrowser` component and utility hooks from provided configuration `input`.
+ *
+ * @param input - `StorageBrowser` auth, actions and ui configuration values
+ * @returns `StorageBrowser` component, `useAction` and `useView` hooks
+ */
 export declare function createStorageBrowser<Input extends CreateStorageBrowserInput, RInput extends Input['actions'] extends ExtendedActionConfigs ? Input['actions'] : ExtendedActionConfigs>(input: Input): CreateStorageBrowserOutput<RInput>;

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

@@ -1,3 +1,4 @@
 export { DisplayTextProvider, useDisplayText } from './context';
 export { DEFAULT_STORAGE_BROWSER_DISPLAY_TEXT as DefaultStorageBrowserDisplayText } from './libraries';
 export { LocationDetailViewDisplayText, LocationsViewDisplayText, CreateFolderViewDisplayText, CopyViewDisplayText, UploadViewDisplayText, DeleteViewDisplayText, StorageBrowserDisplayText, } from './types';
+export { isCopyViewDisplayTextKey, isDeleteViewDisplayTextKey } from './utils';

package/dist/types/components/StorageBrowser/displayText/types.d.ts

@@ -1,4 +1,4 @@
-import { StatusCounts, Tasks } from '../tasks';
+import { StatusCounts, Task } from '../tasks';
 import { CopyHandlerData, CreateFolderHandlerData, DeleteHandlerData, FolderData, LocationData, LocationItemData, TaskData, UploadHandlerData, LocationPermissions } from '../actions';
 import { LocationState } from '../providers/store/location';
 import { MessageType } from '../composables/Message';
@@ -67,7 +67,7 @@ export interface DefaultActionViewDisplayText<T extends TaskData = TaskData> {
     actionStartLabel: string;
     getActionCompleteMessage: (data?: {
         counts?: StatusCounts;
-        tasks?: Tasks<T>;
+        tasks?: Task<T>[];
     }) => {
         content?: string;
         type?: MessageType;
@@ -85,7 +85,6 @@ export interface DefaultActionViewDisplayText<T extends TaskData = TaskData> {
     tableColumnNameHeader: string;
     tableColumnTypeHeader: string;
     tableColumnSizeHeader: string;
-    tableColumnProgressHeader: string;
 }
 export interface DefaultCreateFolderViewDisplayText extends Omit<DefaultActionViewDisplayText<CreateFolderHandlerData>, `${'tableColumn' | 'statusDisplay'}${string}`> {
     folderNameLabel: string;
@@ -105,20 +104,29 @@ export interface DefaultCopyViewDisplayText extends DefaultActionViewDisplayText
     searchPlaceholder: string;
     searchSubmitLabel: string;
     searchClearLabel: string;
+    /**
+     * @deprecated `CopyView` does not render a "progress" header
+     */
+    tableColumnProgressHeader?: string;
 }
 export interface DefaultDeleteViewDisplayText extends DefaultActionViewDisplayText<DeleteHandlerData> {
+    /**
+     * @deprecated `DeleteView` does not render a "progress" header
+     */
+    tableColumnProgressHeader?: string;
 }
 export interface DefaultUploadViewDisplayText extends DefaultActionViewDisplayText<UploadHandlerData> {
     addFilesLabel: string;
     addFolderLabel: string;
-    statusDisplayOverwritePreventedLabel: string;
-    overwriteToggleLabel: string;
     getFilesValidationMessage: (data?: {
         invalidFiles?: FileItems;
     }) => {
         content?: string;
         type?: MessageType;
     } | undefined;
+    overwriteToggleLabel: string;
+    statusDisplayOverwritePreventedLabel: string;
+    tableColumnProgressHeader: string;
 }
 export interface DefaultStorageBrowserDisplayText {
     CopyView: DefaultCopyViewDisplayText;
@@ -140,6 +148,9 @@ export interface LocationDetailViewDisplayText extends Partial<DefaultLocationDe
 }
 export interface UploadViewDisplayText extends Partial<DefaultUploadViewDisplayText> {
 }
+/**
+ * `StorageBrowser` display text strings/resolver functions
+ */
 export interface StorageBrowserDisplayText {
     LocationsView?: LocationsViewDisplayText;
     LocationDetailView?: LocationDetailViewDisplayText;

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

@@ -0,0 +1,3 @@
+import { CopyViewDisplayText, DeleteViewDisplayText } from './types';
+export declare const isCopyViewDisplayTextKey: (value: string) => value is keyof CopyViewDisplayText;
+export declare const isDeleteViewDisplayTextKey: (value: string) => value is keyof DeleteViewDisplayText;

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

@@ -1,7 +1,8 @@
 export { componentsDefault } from './componentsDefault';
 export { createStorageBrowser } from './createStorageBrowser';
-export { ActionViewConfig, ActionHandler, FileDataItem, ExtendedActionConfigs, } from './actions';
+export { ActionHandler, ActionViewConfig, CopyHandlerInput, CopyHandlerOutput, CreateFolderHandlerInput, CreateFolderHandlerOutput, defaultActionConfigs, defaultHandlers, DefaultHandlers, DeleteHandlerInput, DeleteHandlerOutput, DownloadHandlerInput, DownloadHandlerOutput, ExtendedActionConfigs, ListLocations, ListLocationsInput, ListLocationsOutput, LocationData, ListLocationItemsHandlerInput, ListLocationItemsHandlerOutput, ListLocationsHandlerInput, ListLocationsHandlerOutput, UploadHandlerInput, UploadHandlerOutput, } from './actions';
 export { createAmplifyAuthAdapter, createManagedAuthAdapter, CreateManagedAuthAdapterInput, StorageBrowserAuthAdapter, } from './adapters';
-export { DefaultStorageBrowserDisplayText } from './displayText';
-export { CreateStorageBrowserInput, StorageBrowserType, DerivedActionViewType, DerivedActionViews, } from './types';
+export { StorageBrowserComponents } from './ComponentsProvider';
+export { DefaultStorageBrowserDisplayText, StorageBrowserDisplayText, } from './displayText';
+export { CreateStorageBrowserInput, CreateStorageBrowserOutput, DerivedActionViews, DerivedActionViewType, StorageBrowserConfig, StorageBrowserProps, StorageBrowserProviderProps, StorageBrowserType, } from './types';
 export { UseView } from './views';

package/dist/types/components/StorageBrowser/providers/configuration/createConfigurationProvider.d.ts

@@ -1,3 +1,3 @@
 import React from 'react';
 import { CreateConfigurationProviderInput, ConfigurationProviderComponent } from './types';
-export declare function createConfigurationProvider<T extends React.ComponentType<any>>(input: CreateConfigurationProviderInput<T>): ConfigurationProviderComponent<T>;
+export declare function createConfigurationProvider<T extends React.ComponentType<any>, P extends React.ComponentProps<T>>(input: CreateConfigurationProviderInput<T>): ConfigurationProviderComponent<P>;

package/dist/types/components/StorageBrowser/providers/configuration/types.d.ts

@@ -8,12 +8,12 @@ export interface GetActionInputProviderProps {
     region: string;
     customEndpoint?: string;
 }
-export interface CreateConfigurationProviderInput<T extends React.ComponentType<any>> extends GetActionInputProviderProps, CredentialsProviderProps {
+export interface CreateConfigurationProviderInput<T> extends GetActionInputProviderProps, CredentialsProviderProps {
     ChildComponent?: T;
     displayName: string;
     region: string;
 }
-export interface ConfigurationProviderComponent<T extends React.ComponentType<any>> {
-    (props: React.ComponentProps<T>): React.JSX.Element;
+export interface ConfigurationProviderComponent<P> {
+    (props: P): React.JSX.Element;
     displayName: string;
 }

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

@@ -1,2 +1,2 @@
 export { createConfigurationProvider, CredentialsProviderProps, RegisterAuthListener, } from './configuration';
-export { FileItem, FileItems, StoreProviderProps, StoreProvider, } from './store';
+export { FileItems, StoreProviderProps, StoreProvider } from './store';

package/dist/types/components/StorageBrowser/providers/store/actionType/types.d.ts

@@ -10,6 +10,10 @@ export type ActionTypeStateContext = [
     HandleActionTypeAction
 ];
 export interface ActionTypeProviderProps {
+    /**
+     *  Sets initial `actionType`. Provide to initialize the `StorageBrowser` with an initial
+     * `actionType`
+     */
     actionType?: string;
     children?: React.ReactNode;
 }

package/dist/types/components/StorageBrowser/providers/store/files/types.d.ts

@@ -1,4 +1,4 @@
-import { LocationItemType, TaskData } from '../../../actions';
+import { FileItem, LocationItemType } from '../../../actions';
 /**
  * native OS file picker type. to restrict selectable file types, define the picker types
  * followed by accepted file types as strings
@@ -21,9 +21,6 @@ export type FilesActionType = {
     type: 'RESET_FILE_ITEMS';
 };
 export type HandleFilesAction = (input: FilesActionType) => void;
-export interface FileItem extends TaskData {
-    file: File;
-}
 export type FileItems = FileItem[];
 export type FilesContextType = [FileItems | undefined, HandleFilesAction];
 export interface FilesProviderProps {

package/dist/types/components/StorageBrowser/providers/store/index.d.ts

@@ -1,3 +1,3 @@
-export { FileItem, FileItems } from './files';
+export { FileItems } from './files';
 export { StoreProvider, StoreProviderProps } from './StoreProvider';
 export { useStore, UseStoreState } from './useStore';

package/dist/types/components/StorageBrowser/providers/store/location/context.d.ts

@@ -49,7 +49,13 @@ export type LocationStateContext = [
 ];
 export interface LocationProviderProps {
     children?: React.ReactNode;
+    /**
+     * Sets initial `location` data
+     */
     location?: LocationData;
+    /**
+     * Sets initial `location` subpath to establish initial navigation state
+     */
     path?: string;
 }
 export declare const LocationContext: React.Context<LocationStateContext>, useLocation: (params?: {