@aws-amplify/ui-react-storage 3.4.0 → 3.5.0

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

@@ -1,11 +1,14 @@
-import { FileDataItem, TaskHandler, TaskHandlerInput, TaskHandlerOptions, TaskHandlerOutput } from './types';
-export interface DownloadHandlerData extends FileDataItem {
+import { TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOptions, TaskHandlerOutput } from './types';
+export interface DownloadHandlerData extends TaskData {
+    fileKey: string;
 }
 export interface DownloadHandlerOptions extends TaskHandlerOptions {
 }
 export interface DownloadHandlerInput extends TaskHandlerInput<DownloadHandlerData, DownloadHandlerOptions> {
 }
-export interface DownloadHandlerOutput extends TaskHandlerOutput {
+export interface DownloadHandlerOutput extends TaskHandlerOutput<{
+    url: URL;
+}> {
 }
 export interface DownloadHandler extends TaskHandler<DownloadHandlerInput, DownloadHandlerOutput> {
 }

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

@@ -64,22 +64,31 @@ export interface TaskData {
     key: string;
     id: string;
 }
-export interface TaskHandlerOptions {
+export interface TaskHandlerOptions<V = any> {
     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> {
     config: ActionInputConfig;
     data: T;
     options?: K;
 }
-export interface TaskHandlerOutput {
+export interface TaskHandlerOutput<K = any> {
     cancel?: () => void;
     result: Promise<{
         message?: string;
         status: 'CANCELED' | 'COMPLETE' | 'FAILED' | 'OVERWRITE_PREVENTED';
+        value?: K;
     }>;
 }
 export type TaskHandler<T = any, K = any> = (input: T) => K;

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

@@ -1,18 +1,22 @@
 import { TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOutput, TaskHandlerOptions } from './types';
-export interface UploadHandlerOptions extends TaskHandlerOptions {
-    preventOverwrite?: boolean;
+export interface UploadHandlerOptions extends TaskHandlerOptions<{
+    key: string;
+}> {
 }
 export interface UploadHandlerData extends TaskData {
     file: File;
+    preventOverwrite?: boolean;
 }
 export interface UploadHandlerInput extends TaskHandlerInput<UploadHandlerData, UploadHandlerOptions> {
-    destinationPrefix: string;
 }
-export interface UploadHandlerOutput extends TaskHandlerOutput {
+export interface UploadHandlerOutput extends TaskHandlerOutput<{
+    key: string;
+}> {
 }
 export interface UploadHandler extends TaskHandler<UploadHandlerInput, UploadHandlerOutput> {
 }
 export declare const MULTIPART_UPLOAD_THRESHOLD_BYTES: number;
+export declare const DEFAULT_CHECKSUM_ALGORITHM = "crc-32";
 export declare const UNDEFINED_CALLBACKS: {
     cancel: undefined;
     pause: undefined;

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

@@ -11,7 +11,6 @@ export declare const shouldExcludeLocation: ({ permissions, type }: LocationData
 export declare const getFilteredLocations: (locations: AccessGrantLocation[], exclude?: ListLocationsExcludeOptions) => LocationData[];
 export declare const getFileKey: (key: string) => string;
 export declare const createFileDataItem: (data: FileData) => FileDataItem;
-export declare const createFileDataItemFromLocation: (data: LocationData) => 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;

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

@@ -1,4 +1,2 @@
-export { ActionConfigs, ActionConfigsProvider, ActionConfigsProviderProps, ComponentName, defaultActionConfigs, DefaultActionConfigs, defaultActionViewConfigs, DefaultActionKey, isDefaultActionViewType, SelectionType, TaskActionConfig, useActionConfig, } from './configs';
-export { ActionInputConfig, copyHandler, CopyHandler, CopyHandlerData, CopyHandlerInput, CopyHandlerOutput, createFileDataItemFromLocation, 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, LocationPermissions, LocationType, TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOptions, TaskHandlerOutput, uploadHandler, UploadHandler, UploadHandlerData, UploadHandlerInput, UploadHandlerOptions, UploadHandlerOutput, } from './handlers';
-export { ActionState } from './types';
-export { useListLocations, UseListLocationsState } from './useAction';
+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 { ExtendedActionConfigs, ActionViewConfig, ActionViewConfigs, ActionConfigsProvider, ActionConfigsProviderProps, ActionHandler, CustomActionConfigs, defaultActionConfigs, DefaultActionConfigs, defaultActionViewConfigs, getActionConfigs, isDefaultActionViewType, useActionConfigs, } from './configs';

package/dist/types/components/StorageBrowser/adapters/permissionParsers.d.ts

@@ -1,4 +1,4 @@
-import { LocationPermissions } from '../actions/handlers/types';
+import { LocationPermissions } from '../actions';
 import { Permission, StorageAccess } from '../storage-internal';
 export declare const parseAccessGrantPermission: (accessGrantPermission: Permission) => LocationPermissions;
 export declare const toAccessGrantPermission: (permission: StorageAccess[]) => Permission;

package/dist/types/components/StorageBrowser/composables/ActionsList.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { StorageBrowserIconType } from '../context/elements';
-export interface ActionsListItem {
+export interface ActionListItem {
     isDisabled?: boolean;
     isHidden?: boolean;
     icon?: StorageBrowserIconType;
@@ -9,7 +9,7 @@ export interface ActionsListItem {
 }
 export interface ActionsListProps {
     isDisabled?: boolean;
-    items: ActionsListItem[];
+    items: ActionListItem[];
     onActionSelect?: (id: string) => void;
 }
 export declare const ActionsList: ({ isDisabled, items, onActionSelect, }: ActionsListProps) => React.JSX.Element;

package/dist/types/components/StorageBrowser/controls/SearchFieldControl.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const SearchFieldControl: () => React.JSX.Element;

package/dist/types/components/StorageBrowser/controls/hooks/usePagination.d.ts

@@ -0,0 +1,2 @@
+import { PaginationProps } from '../../composables/Pagination';
+export declare const usePagination: () => PaginationProps;

package/dist/types/components/StorageBrowser/controls/hooks/useSearchField.d.ts

@@ -0,0 +1,2 @@
+import { SearchFieldProps } from '../../composables/SearchField';
+export declare const useSearchField: () => SearchFieldProps;

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

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { LocationData } from '../actions';
-import { ActionsListItem } from '../composables/ActionsList';
+import { ActionListItem } from '../composables/ActionsList';
 import { DataTableSortHeader, DataTableProps } from '../composables/DataTable';
 import { MessageProps } from '../composables/Message';
 import { Composables } from '../composables/types';
@@ -20,12 +20,11 @@ interface TableData {
 interface PaginationData {
     hasNextPage: boolean;
     highestPageVisited: number;
-    onPaginate: (page: number) => void;
     page: number;
 }
 export interface ControlsContext {
     data: {
-        actions?: ActionsListItem[];
+        actions?: ActionListItem[];
         actionCancelLabel?: string;
         actionDestinationLabel?: string;
         actionExitLabel?: string;
@@ -78,6 +77,7 @@ export interface ControlsContext {
     onFolderNameChange?: (value: string) => void;
     onNavigate?: (location: LocationData, path?: string) => void;
     onNavigateHome?: () => void;
+    onPaginate?: (page: number) => void;
     onRefresh?: () => void;
     onSearch?: () => void;
     onSearchClear?: () => void;

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

@@ -1,7 +1,3 @@
-import { defaultActionConfigs } from './actions';
-import { createUseView } from './views/createUseView';
-import { CreateStorageBrowserInput, StorageBrowserType } from './types';
-export declare function createStorageBrowser(input: CreateStorageBrowserInput): {
-    StorageBrowser: StorageBrowserType<keyof Omit<typeof defaultActionConfigs, 'listLocationItems' | 'listLocations'>>;
-    useView: ReturnType<typeof createUseView<typeof defaultActionConfigs>>;
-};
+import { ExtendedActionConfigs } from './actions';
+import { CreateStorageBrowserInput, CreateStorageBrowserOutput } from './types';
+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,3 @@
 export { DisplayTextProvider, useDisplayText } from './context';
-export { DEFAULT_STORAGE_BROWSER_DISPLAY_TEXT } from './libraries';
+export { DEFAULT_STORAGE_BROWSER_DISPLAY_TEXT as DefaultStorageBrowserDisplayText } from './libraries';
 export { LocationDetailViewDisplayText, LocationsViewDisplayText, CreateFolderViewDisplayText, CopyViewDisplayText, UploadViewDisplayText, DeleteViewDisplayText, StorageBrowserDisplayText, } from './types';

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

@@ -21,7 +21,7 @@ interface ListMessageData {
     isLoading?: boolean;
 }
 interface ListLocationsMessageData extends ListMessageData {
-    locations: LocationData[] | undefined;
+    items: LocationData[] | undefined;
 }
 export interface DefaultLocationsViewDisplayText extends DefaultListViewDisplayText {
     getListLocationsResultMessage: (data?: ListLocationsMessageData) => {

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

@@ -1,4 +1,6 @@
 export { componentsDefault } from './componentsDefault';
 export { createStorageBrowser } from './createStorageBrowser';
+export { ActionViewConfig, ActionHandler, FileDataItem, ExtendedActionConfigs, } from './actions';
 export { createAmplifyAuthAdapter, createManagedAuthAdapter, CreateManagedAuthAdapterInput, StorageBrowserAuthAdapter, } from './adapters';
-export { CreateStorageBrowserInput, StorageBrowserType } from './types';
+export { CreateStorageBrowserInput, StorageBrowserType, DerivedActionViewType, DerivedActionViews, } from './types';
+export { DefaultStorageBrowserDisplayText } from './displayText';

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

@@ -1,4 +1,4 @@
-export { useGetActionInput } from './context';
 export { createConfigurationProvider } from './createConfigurationProvider';
+export { useGetActionInput } from './context';
 export { CredentialsProviderProps, RegisterAuthListener } from './credentials';
 export { GetActionInput } from './types';

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { ActionInputConfig, ActionConfigsProviderProps, LocationData } from '../../actions';
+import { ActionInputConfig, LocationData } from '../../actions';
 import { CredentialsProviderProps } from './credentials';
 export type GetActionInput = (location?: LocationData) => ActionInputConfig;
 export interface GetActionInputProviderProps {
@@ -8,7 +8,7 @@ export interface GetActionInputProviderProps {
     region: string;
     customEndpoint?: string;
 }
-export interface CreateConfigurationProviderInput<T extends React.ComponentType<any>> extends ActionConfigsProviderProps, GetActionInputProviderProps, CredentialsProviderProps {
+export interface CreateConfigurationProviderInput<T extends React.ComponentType<any>> extends GetActionInputProviderProps, CredentialsProviderProps {
     ChildComponent?: T;
     displayName: string;
     region: string;

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

@@ -1,5 +1,14 @@
 /// <reference types="react" />
-import { SelectionType, TaskData } from '../../../actions';
+import { LocationItemType, TaskData } from '../../../actions';
+/**
+ * native OS file picker type. to restrict selectable file types, define the picker types
+ * followed by accepted file types as strings
+ * @example
+ * ```ts
+ * type JPEGOnly = ['FOLDER', '.jpeg'];
+ * ```
+ */
+export type SelectionType = LocationItemType | [LocationItemType, ...string[]];
 export type FilesActionType = {
     type: 'ADD_FILE_ITEMS';
     files?: File[];

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

@@ -1,6 +1,5 @@
 import React from 'react';
-import { SelectionType } from '../../../actions/configs';
-import { FileItems, FilesActionType } from './types';
+import { FileItems, FilesActionType, SelectionType } from './types';
 export declare const resolveFiles: (prevItems: FileItems, files: File[] | undefined) => FileItems;
 export declare const filesReducer: React.Reducer<FileItems, Exclude<FilesActionType, {
     type: 'SELECT_FILES';

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

@@ -1,30 +1,33 @@
 import { TaskHandlerInput, TaskData } from '../actions';
 export type TaskStatus = 'CANCELED' | 'FAILED' | 'COMPLETE' | 'OVERWRITE_PREVENTED' | 'QUEUED' | 'PENDING';
 export type StatusCounts = Record<TaskStatus | 'TOTAL', number>;
-export interface ProcessTasksOptions<T extends TaskData = TaskData, U extends number | never = never> {
+export interface ProcessTasksOptions<T extends TaskData = TaskData, V = any, U extends number | never = never> {
     concurrency?: U;
     onTaskCancel?: (data: Task<T>) => void;
     onTaskComplete?: (data: Task<T>) => void;
     onTaskError?: (data: Task<T>, error: Error | undefined) => void;
     onTaskProgress?: (data: Task<T>, progress: number | undefined) => void;
-    onTaskSuccess?: (data: Task<T>) => void;
+    onTaskSuccess?: (data: Task<T>, value: V | undefined) => void;
     onTaskRemove?: (data: Task<T>) => void;
 }
-export interface Task<T extends TaskData = TaskData> {
+export interface Task<T extends TaskData = TaskData, V = any> {
     data: T;
     message: string | undefined;
     progress: number | undefined;
     status: TaskStatus;
     cancel?: () => void;
+    value?: V;
 }
-export type Tasks<T extends TaskData> = Task<T>[];
-export type HandleProcessTasks<T extends TaskData, K, U> = (input: U extends T[] ? Omit<TaskHandlerInput<T> & K, 'data'> : TaskHandlerInput<T> & K) => void;
-export type UseProcessTasksState<T extends TaskData, K, D> = [
-    {
-        isProcessing: boolean;
-        isProcessingComplete: boolean;
-        statusCounts: StatusCounts;
-        tasks: Tasks<T>;
-    },
-    HandleProcessTasks<T, K, D>
+export type Tasks<T extends TaskData, V = any> = Task<T, V>[];
+export type HandleProcessTasks<T extends TaskData, U> = (input: U extends T[] ? Omit<TaskHandlerInput<T>, 'data'> : TaskHandlerInput<T>) => void;
+export interface TasksState<T extends TaskData = TaskData> {
+    isProcessing: boolean;
+    isProcessingComplete: boolean;
+    reset: () => void;
+    statusCounts: StatusCounts;
+    tasks: Tasks<T>;
+}
+export type UseProcessTasksState<T extends TaskData, D> = [
+    TasksState<T>,
+    HandleProcessTasks<T, D>
 ];

package/dist/types/components/StorageBrowser/tasks/useProcessTasks.d.ts

@@ -1,4 +1,3 @@
-import { TaskHandlerInput, TaskData, TaskHandlerOutput, TaskHandler } from '../actions';
+import { ActionHandler, TaskData } from '../actions';
 import { ProcessTasksOptions, UseProcessTasksState } from './types';
-export type UseProcessTasks = <T extends TaskData, K, D extends T[] | undefined>(handler: TaskHandler<TaskHandlerInput<T> & K, TaskHandlerOutput>, items?: D, options?: ProcessTasksOptions<T, D extends T[] ? number : never>) => UseProcessTasksState<T, K, D>;
-export declare const useProcessTasks: UseProcessTasks;
+export declare const useProcessTasks: <TData extends TaskData = TaskData, RValue = any, D extends TData[] | undefined = undefined>(handler: ActionHandler<TData, RValue>, items?: D | undefined, options?: ProcessTasksOptions<TData, RValue, D extends TData[] ? number : never> | undefined) => UseProcessTasksState<TData, D>;

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

@@ -1,10 +1,12 @@
 import React from 'react';
-import { ListLocations } from './actions';
+import { CustomActionConfigs, DefaultActionConfigs, ExtendedActionConfigs, ListLocations } from './actions';
+import { GetLocationCredentials } from './credentials/types';
+import { UseView } from './views/useView';
 import { Components } from './ComponentsProvider';
 import { RegisterAuthListener, StoreProviderProps } from './providers';
-import { CopyViewType, CreateFolderViewType, DeleteViewType, UploadViewType, LocationActionViewProps, LocationDetailViewType, LocationsViewType, Views } from './views';
-import { GetLocationCredentials } from './credentials/types';
+import { CopyViewType, CreateFolderViewType, DeleteViewType, UploadViewType, LocationActionViewType, LocationDetailViewType, LocationsViewType, Views } from './views';
 import { StorageBrowserDisplayText } from './displayText';
+import { DerivedActionHandlers, UseAction } from './useAction';
 export interface Config {
     accountId?: string;
     customEndpoint?: string;
@@ -13,27 +15,55 @@ export interface Config {
     registerAuthListener: RegisterAuthListener;
     region: string;
 }
+export interface StorageBrowserActions {
+    default?: DefaultActionConfigs;
+    custom?: CustomActionConfigs;
+}
 export interface CreateStorageBrowserInput {
+    actions?: StorageBrowserActions;
     config: Config;
     components?: Components;
 }
-export interface StorageBrowserProps<T = string> {
-    views?: Views<T>;
+export interface StorageBrowserProps<K = string, V = {}> {
     displayText?: StorageBrowserDisplayText;
+    views?: Views<K, V>;
 }
-export interface StorageBrowserType<T = string, K = {}> {
-    (props: StorageBrowserProps & Exclude<K, keyof StorageBrowserProps>): React.JSX.Element;
+export interface StorageBrowserProviderProps<V = {}> extends StoreProviderProps {
+    displayText?: StorageBrowserDisplayText;
+    views?: V;
+}
+export interface StorageBrowserType<K = string, V = {}> {
+    (props: StorageBrowserProps<K, V>): React.JSX.Element;
     displayName: string;
-    Provider: (props: StorageBrowserProviderProps) => React.JSX.Element;
+    Provider: (props: StorageBrowserProviderProps<V>) => React.JSX.Element;
     CopyView: CopyViewType;
     CreateFolderView: CreateFolderViewType;
     DeleteView: DeleteViewType;
     UploadView: UploadViewType;
-    LocationActionView: (props: LocationActionViewProps<T>) => React.JSX.Element | null;
+    LocationActionView: LocationActionViewType<K>;
     LocationDetailView: LocationDetailViewType;
     LocationsView: LocationsViewType;
 }
-export type ActionViewName<T = string> = Exclude<T, 'listLocationItems' | 'listLocations'>;
-export interface StorageBrowserProviderProps extends StoreProviderProps {
-    displayText?: StorageBrowserDisplayText;
+type DefaultActionType<T = string> = Exclude<T, keyof DefaultActionConfigs>;
+/**
+ * @internal @unstable
+ */
+export type DerivedActionViews<T extends StorageBrowserActions> = {
+    [K in keyof T['custom'] as K extends DefaultActionType<K> ? T['custom'][K] extends {
+        viewName: `${string}View`;
+    } ? T['custom'][K]['viewName'] : never : never]?: () => React.JSX.Element | null;
+};
+/**
+ * @internal @unstable
+ */
+export type DerivedActionViewType<T extends StorageBrowserActions> = keyof {
+    [K in keyof T['custom'] as K extends DefaultActionType<K> ? T['custom'][K] extends {
+        viewName: `${string}View`;
+    } ? K : never : never]?: any;
+} | Exclude<keyof DefaultActionConfigs, 'download'>;
+export interface CreateStorageBrowserOutput<C extends ExtendedActionConfigs = ExtendedActionConfigs> {
+    StorageBrowser: StorageBrowserType<DerivedActionViewType<C>, DerivedActionViews<C>>;
+    useAction: UseAction<DerivedActionHandlers<C>>;
+    useView: UseView;
 }
+export {};

package/dist/types/components/StorageBrowser/useAction/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const DEFAULT_ACTION_CONCURRENCY = 4;
+export declare const USE_ACTION_ERROR_MESSAGE = "`useAction` must be called from within `StorageBrowser.Provider`";
+export declare const USE_LIST_ERROR_MESSAGE = "`useList` must be called from within `StorageBrowser.Provider`";

package/dist/types/components/StorageBrowser/useAction/context.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { ActionHandlersContext } from './types';
+export declare const ActionHandlersProvider: import("react").ComponentType<import("react").PropsWithChildren<ActionHandlersContext>>, useActionHandlers: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => ActionHandlersContext;

package/dist/types/components/StorageBrowser/{actions/useAction → useAction}/createEnhancedListHandler.d.ts

@@ -1,5 +1,5 @@
 import { AsyncDataAction } from '@aws-amplify/ui-react-core';
-import { ListHandler, ListHandlerOptions, ListHandlerInput, ListHandlerOutput } from '../handlers';
+import { ListHandler, ListHandlerOptions, ListHandlerInput, ListHandlerOutput } from '../actions';
 type KeyWithStringValue<T> = keyof {
     [P in keyof T as T[P] extends string ? P : never]: T[P];
 };
@@ -27,12 +27,12 @@ export interface SearchOutput {
 export interface EnhancedListHandlerOutput<T> extends ListHandlerOutput<T> {
     search?: SearchOutput;
 }
-export interface EnhancedListHandlerInput<T, K> extends ListHandlerInput<EnhancedListHandlerOptions<T, K>> {
+export interface EnhancedListHandlerInput<T, K> extends Omit<ListHandlerInput<EnhancedListHandlerOptions<T, K>>, 'config'> {
 }
 export interface EnhancedListHandler<T, K> extends AsyncDataAction<EnhancedListHandlerOutput<T>, EnhancedListHandlerInput<T, K>> {
 }
 type ListItem<Action> = Action extends ListHandler<any, ListHandlerOutput<infer T>> ? T : never;
-type Options<Action> = Action extends ListHandler<ListHandlerInput<ListHandlerOptions<infer E>>> ? E : never;
+type Options<Action> = Action extends ListHandler<Omit<ListHandlerInput<ListHandlerOptions<infer E>>, 'config'>> ? E : never;
 export declare const SEARCH_LIMIT = 10000;
 export declare const SEARCH_PAGE_SIZE = 1000;
 interface Search<T> {

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

@@ -0,0 +1,6 @@
+export { ActionHandlersProvider } from './context';
+export { createEnhancedListHandler } from './createEnhancedListHandler';
+export { ActionHandlersProviderProps, DefaultActionHandlers, DerivedActionHandlers, UseAction, } from './types';
+export { useAction } from './useAction';
+export { useList } from './useList';
+export { getActionHandlers } from './utils';

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

@@ -0,0 +1,76 @@
+import React from 'react';
+import { DataState } from '@aws-amplify/ui-react-core';
+import { ActionHandler, ExtendedActionConfigs, CopyHandler, CreateFolderHandler, DeleteHandler, DownloadHandler, ListLocationItemsHandler, ListLocations, LocationData, TaskData, UploadHandler } from '../actions';
+import { StatusCounts, Task, Tasks } from '../tasks';
+export type ListActionState<T = any, K = any> = [
+    state: DataState<T>,
+    handleAction: (...input: K[]) => void
+];
+export interface DefaultActionHandlers {
+    upload: UploadHandler;
+    download: DownloadHandler;
+    copy: CopyHandler;
+    createFolder: CreateFolderHandler;
+    delete: DeleteHandler;
+}
+export type ActionHandlers = Record<string, ActionHandler | ListLocationItemsHandler | ListLocations>;
+export interface ActionHandlersContext {
+    handlers: ActionHandlers;
+}
+export interface ActionHandlersProviderProps extends ActionHandlersContext {
+    children?: React.ReactNode;
+}
+type DerivedCustomActions<T> = T extends {
+    custom?: infer U;
+} ? U : {};
+export type ResolveHandlerType<T> = T extends {
+    handler: infer X;
+} | infer X ? X : never;
+export type DerivedActionHandlers<C extends ExtendedActionConfigs = ExtendedActionConfigs, D extends DerivedCustomActions<C> = DerivedCustomActions<C>> = DefaultActionHandlers & {
+    [K in keyof D]: ResolveHandlerType<D[K]>;
+};
+export interface HandleTasksOptions<U extends TaskData = TaskData> {
+    items: U[];
+    onTaskSuccess?: (task: Task<U>) => void;
+}
+interface HandleTasksInput {
+    location?: LocationData;
+}
+export interface HandleTaskInput<T, K> {
+    data: T;
+    location?: LocationData;
+    options?: {
+        onSuccess?: (data: {
+            id: string;
+            key: string;
+        }, value: K) => void;
+        onError?: (data: {
+            id: string;
+            key: string;
+        }, message: string | undefined) => void;
+    };
+}
+export type HandlerInput<T extends TaskData, K, U = undefined> = U extends undefined ? HandleTaskInput<T, K> : HandleTasksInput;
+export interface TasksState<T extends TaskData, V = any> {
+    isProcessing: boolean;
+    isProcessingComplete: boolean;
+    reset: () => void;
+    statusCounts: StatusCounts;
+    tasks: Tasks<T, V>;
+}
+export type HandleTasks = (input?: HandleTasksInput) => void;
+export type UseTasksState<T extends TaskData, V = any> = [
+    TasksState<T, V>,
+    HandleTasks
+];
+export type HandleTask<T, K> = (input: HandleTaskInput<T, K>) => void;
+export type UseTaskState<T extends TaskData, R> = [
+    {
+        task: Task<T, R> | undefined;
+        isProcessing: boolean;
+    },
+    HandleTask<T, R>
+];
+export type UseHandlerState<T extends TaskData, R, U = undefined> = U extends undefined ? UseTaskState<T, R> : UseTasksState<T, R>;
+export type UseAction<V extends Record<keyof V, ActionHandler>> = <K extends keyof V, TData extends V[K] extends ActionHandler<infer D> ? D & TaskData : never, TOptions extends HandleTasksOptions<TData>, U extends TOptions | undefined = undefined>(key: K, options?: U) => UseHandlerState<TData, V[K] extends ActionHandler<any, infer R> ? R : never, U>;
+export {};

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

@@ -0,0 +1,3 @@
+import { DefaultActionHandlers, UseAction } from './types';
+export declare const ERROR_MESSAGE = "`useAction` must be called from within `StorageBrowser.Provider`";
+export declare const useAction: UseAction<DefaultActionHandlers>;

package/dist/types/components/StorageBrowser/useAction/useHandler.d.ts

@@ -0,0 +1,3 @@
+import { TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOutput } from '../actions';
+import { HandleTasksOptions, UseHandlerState } from './types';
+export declare const useHandler: <TData extends TaskData, RValue, TOptions extends HandleTasksOptions<TData>, U extends TOptions | undefined = undefined>(action: TaskHandler<TaskHandlerInput<TData, import("../actions").TaskHandlerOptions<any>>, TaskHandlerOutput<RValue>>, options?: U | undefined) => UseHandlerState<TData, RValue, U>;

package/dist/types/components/StorageBrowser/useAction/useList.d.ts

@@ -0,0 +1,9 @@
+declare const LIST_ACTION_HOOKS: {
+    folderItems: () => import("./useListFolderItems").UseListFolderItemsState;
+    locationItems: () => import("./useListLocationItems").UseListLocationItemsState;
+    locations: () => import("./useListLocations").UseListLocationsState;
+};
+type ListActionHooks = typeof LIST_ACTION_HOOKS;
+export type UseList = <K extends keyof ListActionHooks, S extends ListActionHooks[K]>(type: K) => ReturnType<S>;
+export declare const useList: UseList;
+export {};

package/dist/types/components/StorageBrowser/useAction/useListFolderItems.d.ts

@@ -0,0 +1,13 @@
+import { LocationItemType, FolderData, ListLocationItemsHandlerInput, ListHandlerOutput } from '../actions';
+import { EnhancedListHandlerInput, EnhancedListHandlerOutput } from './createEnhancedListHandler';
+import { ListActionState } from './types';
+type RemoveConfig<T> = Omit<T, 'config'>;
+interface EnhancedInput extends RemoveConfig<EnhancedListHandlerInput<FolderData, LocationItemType>> {
+}
+export interface UseListLocationItemsState extends ListActionState<EnhancedListHandlerOutput<FolderData>, EnhancedInput> {
+}
+export type ListFolderItemsAction = (input: ListLocationItemsHandlerInput) => Promise<ListHandlerOutput<FolderData>>;
+export interface UseListFolderItemsState extends ListActionState<EnhancedListHandlerOutput<FolderData>, EnhancedListHandlerInput<FolderData, LocationItemType>> {
+}
+export declare const useListFolderItems: () => UseListFolderItemsState;
+export {};

package/dist/types/components/StorageBrowser/useAction/useListLocationItems.d.ts

@@ -0,0 +1,10 @@
+import { LocationItemType, LocationItemData } from '../actions';
+import { EnhancedListHandlerInput, EnhancedListHandlerOutput } from './createEnhancedListHandler';
+import { ListActionState } from './types';
+type RemoveConfig<T> = Omit<T, 'config'>;
+interface EnhancedInput extends RemoveConfig<EnhancedListHandlerInput<LocationItemData, LocationItemType>> {
+}
+export interface UseListLocationItemsState extends ListActionState<EnhancedListHandlerOutput<LocationItemData>, EnhancedInput> {
+}
+export declare const useListLocationItems: () => UseListLocationItemsState;
+export {};

package/dist/types/components/StorageBrowser/useAction/useListLocations.d.ts

@@ -0,0 +1,8 @@
+import { LocationData, ListLocationsExcludeOptions } from '../actions';
+import { EnhancedListHandlerInput, EnhancedListHandlerOutput } from './createEnhancedListHandler';
+import { ListActionState } from './types';
+type RemoveConfigAndPrefix<T> = Omit<T, 'prefix' | 'config'>;
+export interface UseListLocationsState extends ListActionState<EnhancedListHandlerOutput<LocationData>, RemoveConfigAndPrefix<EnhancedListHandlerInput<LocationData, ListLocationsExcludeOptions>>> {
+}
+export declare const useListLocations: () => UseListLocationsState;
+export {};

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

@@ -0,0 +1,6 @@
+import { CustomActionConfigs, ExtendedActionConfigs } from '../actions';
+import { ActionHandlers } from './types';
+export declare const getActionHandlers: <T extends {
+    default: Required<ExtendedActionConfigs>['default'];
+    custom?: CustomActionConfigs | undefined;
+}>(configs: T) => ActionHandlers;

package/dist/types/components/StorageBrowser/views/LocationActionView/CopyView/useFolders.d.ts

@@ -1,13 +1,10 @@
-import { FolderData } from '../../../actions';
-import { ListLocationItemsHandlerInput, ListHandlerOutput } from '../../../actions';
-import { FoldersState } from './types';
 import { LocationState } from '../../../providers/store/location';
+import { FoldersState } from './types';
 export declare const DEFAULT_LIST_OPTIONS: {
     pageSize: number;
     delimiter: string;
     exclude: "FILE";
 };
-export type ListFoldersAction = (input: ListLocationItemsHandlerInput) => Promise<ListHandlerOutput<FolderData>>;
 interface UseFoldersInput {
     destination: LocationState;
     setDestination: (destination: LocationState) => void;

package/dist/types/components/StorageBrowser/views/LocationActionView/CreateFolderView/types.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { CopyHandlerData, CreateFolderHandlerData, LocationData } from '../../../actions';
+import { CreateFolderHandlerData, LocationData } from '../../../actions';
 import { ActionViewType, ActionViewState, ActionViewProps } from '../types';
 export interface CreateFolderViewState extends Omit<ActionViewState<CreateFolderHandlerData>, 'onActionCancel'> {
     folderName: string;
@@ -11,7 +11,7 @@ export interface CreateFolderViewProps extends ActionViewProps, Partial<CreateFo
 export interface CreateFolderViewProviderProps extends CreateFolderViewState {
     children?: React.ReactNode;
 }
-export interface CreateFolderViewType extends ActionViewType<CopyHandlerData, CreateFolderViewProps> {
+export interface CreateFolderViewType extends ActionViewType<CreateFolderHandlerData, CreateFolderViewProps> {
     Provider: (props: CreateFolderViewProviderProps) => React.JSX.Element;
     Exit: () => React.JSX.Element | null;
     NameField: () => React.JSX.Element | null;