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

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

@@ -0,0 +1,11 @@
+import React from 'react';
+import { Composables } from './composables';
+import { StorageBrowserElements } from './context/elements';
+export interface Components extends Partial<Composables> {
+}
+export interface ComponentsProviderProps {
+    children?: React.ReactNode;
+    composables?: Composables;
+    elements?: Partial<StorageBrowserElements>;
+}
+export declare function ComponentsProvider(props: ComponentsProviderProps): React.JSX.Element;

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

@@ -0,0 +1,13 @@
+import React from 'react';
+interface ErrorBoundaryProps {
+    children: React.ReactNode;
+}
+interface ErrorBoundaryState {
+    hasError: boolean;
+}
+export declare class ErrorBoundary extends React.Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    constructor(props: ErrorBoundaryProps);
+    static getDerivedStateFromError(_error: Error): ErrorBoundaryState;
+    render(): React.ReactNode;
+}
+export {};

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

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

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

@@ -0,0 +1,5 @@
+import React from 'react';
+import { StorageBrowserProps as StorageBrowserPropsBase } from './types';
+export interface StorageBrowserProps extends StorageBrowserPropsBase {
+}
+export declare const StorageBrowser: ({ views, displayText, }: StorageBrowserProps) => React.JSX.Element;

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

@@ -0,0 +1,8 @@
+import React from 'react';
+/**
+ * Handles default `StorageBrowser` behavior:
+ * - render `LocationsView` on init
+ * - render `LocationDetailView` on location selection
+ * - render `ActionView` on action selection
+ */
+export declare function StorageBrowserDefault(): React.JSX.Element;

package/dist/types/components/StorageBrowser/actions/__testUtils__/permissions.d.ts

@@ -0,0 +1,3 @@
+import { LocationPermissions } from '../handlers';
+export declare const generateCombinations: <T>(values: T[]) => T[][];
+export declare const LOCATION_PERMISSION_VALUES: LocationPermissions;

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

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+import { ActionConfigs } from './types';
+export interface ActionConfigsProviderProps {
+    actions?: ActionConfigs;
+    children?: React.ReactNode;
+}
+export declare const useActionConfigs: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => {
+    actions?: ActionConfigs | undefined;
+}, ActionConfigsProvider: import("react").ComponentType<import("react").PropsWithChildren<{
+    actions?: ActionConfigs | undefined;
+}>>;
+export declare function useActionConfig<T extends keyof ActionConfigs>(type?: T): ActionConfigs[T];

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

@@ -0,0 +1,24 @@
+import { CopyActionConfig, CreateFolderActionConfig, DeleteActionConfig, ListLocationItemsActionConfig, ListLocationsActionConfig, UploadActionConfig } from './types';
+export declare const copyActionConfig: CopyActionConfig;
+export declare const deleteActionConfig: DeleteActionConfig;
+export declare const createFolderActionConfig: CreateFolderActionConfig;
+export declare const listLocationItemsActionConfig: ListLocationItemsActionConfig;
+export declare const listLocationsActionConfig: ListLocationsActionConfig;
+export declare const uploadActionConfig: UploadActionConfig;
+export declare const defaultActionViewConfigs: {
+    copy: CopyActionConfig;
+    createFolder: CreateFolderActionConfig;
+    delete: DeleteActionConfig;
+    upload: UploadActionConfig;
+};
+export type DefaultActionViewType = keyof typeof defaultActionViewConfigs;
+export declare const DEFAULT_ACTION_VIEW_TYPES: ("upload" | "copy" | "delete" | "createFolder")[];
+export declare const isDefaultActionViewType: (value?: string) => value is "upload" | "copy" | "delete" | "createFolder";
+export declare const defaultActionConfigs: {
+    listLocationItems: ListLocationItemsActionConfig;
+    listLocations: ListLocationsActionConfig;
+    copy: CopyActionConfig;
+    createFolder: CreateFolderActionConfig;
+    delete: DeleteActionConfig;
+    upload: UploadActionConfig;
+};

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

@@ -0,0 +1,3 @@
+export { ActionConfigsProvider, ActionConfigsProviderProps, useActionConfig, } from './context';
+export { defaultActionConfigs, defaultActionViewConfigs, isDefaultActionViewType, } from './defaults';
+export * from './types';

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

@@ -0,0 +1,111 @@
+import { StorageBrowserIconType } from '../../context/elements';
+import { LocationPermissions } from '../../actions';
+import { ListLocationsHandler, ListLocationItemsHandler, LocationItemData, LocationItemType, UploadHandler, CreateFolderHandler, DeleteHandler, CopyHandler, TaskHandler } from '../handlers';
+type StringWithoutSpaces<T extends string> = Exclude<T, ` ${string}` | `${string} ` | `${string} ${string}`>;
+export type ComponentName = Capitalize<`${string}View`>;
+type ActionName = StringWithoutSpaces<string>;
+/**
+ * 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 interface ActionConfigTemplate<T> {
+    /**
+     * The name of the component associated with the action
+     */
+    componentName: ComponentName;
+    /**
+     * action handler
+     */
+    handler: T;
+}
+export interface ActionListItemConfig {
+    /**
+     * conditionally disable item selection based on currently selected values
+     * @default false
+     */
+    disable?: (selectedValues: LocationItemData[] | undefined) => boolean;
+    /**
+     * open native OS file picker with associated selection type on item select
+     */
+    fileSelection?: SelectionType;
+    /**
+     * conditionally render list item based on location permission
+     * @default false
+     */
+    hide?: (permissions: LocationPermissions) => boolean;
+    /**
+     * list item icon
+     */
+    icon: StorageBrowserIconType;
+    /**
+     * list item label
+     */
+    label: string;
+}
+/**
+ * defines an action to be included in the actions list of the `LocationDetailView` with
+ * a dedicated subcomponent of the `LocationActionView`
+ */
+export interface TaskActionConfig<T extends TaskHandler = TaskHandler> extends ActionConfigTemplate<T> {
+    /**
+     * configure action list item behavior. provide multiple configs
+     * to create additional list items for a single action
+     */
+    actionsListItemConfig?: ActionListItemConfig;
+    /**
+     * whether the provided `handler` allow inflight cancellation
+     * @default false
+     */
+    isCancelable?: boolean;
+    /**
+     * show per task progress in the action task table
+     * @default false
+     */
+    includeProgress?: boolean;
+    /**
+     * default display name value displayed on action view
+     */
+    displayName: string;
+}
+export interface ListActionConfig<T> extends ActionConfigTemplate<T> {
+}
+export interface UploadActionConfig extends TaskActionConfig<UploadHandler> {
+    componentName: 'UploadView';
+}
+export interface DeleteActionConfig extends TaskActionConfig<DeleteHandler> {
+    componentName: 'DeleteView';
+}
+export interface CopyActionConfig extends TaskActionConfig<CopyHandler> {
+    componentName: 'CopyView';
+}
+export interface CreateFolderActionConfig extends TaskActionConfig<CreateFolderHandler> {
+    componentName: 'CreateFolderView';
+}
+export interface ListLocationsActionConfig extends ListActionConfig<ListLocationsHandler> {
+    componentName: 'LocationsView';
+    displayName: string;
+}
+export interface ListLocationItemsActionConfig extends ListActionConfig<ListLocationItemsHandler> {
+    componentName: 'LocationDetailView';
+    displayName: (bucket: string | undefined, prefix: string | undefined) => string;
+}
+export interface DefaultActionConfigs {
+    ListLocationItems: ListLocationItemsActionConfig;
+    ListLocations: ListLocationsActionConfig;
+    CreateFolder: CreateFolderActionConfig;
+    Upload: UploadActionConfig;
+    Delete: DeleteActionConfig;
+    Copy: CopyActionConfig;
+}
+export type DefaultActionKey = keyof DefaultActionConfigs;
+export type ActionConfigs<ActionsKeys extends ActionName = ActionName> = Record<ActionsKeys, ListLocationItemsActionConfig | ListLocationsActionConfig | CreateFolderActionConfig | UploadActionConfig | TaskActionConfig>;
+export type ResolveActionHandler<T> = T extends TaskActionConfig<infer K> | ListActionConfig<infer K> ? K : never;
+export type ResolveActionHandlers<T> = {
+    [K in keyof T]: ResolveActionHandler<T[K]>;
+};
+export {};

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

@@ -0,0 +1,2 @@
+import { CreateUseAction } from './types';
+export declare const createUseAction: CreateUseAction;

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

@@ -0,0 +1,11 @@
+import { FileDataItem, TaskHandler, TaskHandlerInput, TaskHandlerOptions, TaskHandlerOutput } from './types';
+export interface CopyHandlerData extends FileDataItem {
+}
+export interface CopyHandlerInput extends TaskHandlerInput<CopyHandlerData, TaskHandlerOptions> {
+    destinationPrefix: string;
+}
+export interface CopyHandlerOutput extends TaskHandlerOutput {
+}
+export interface CopyHandler extends TaskHandler<CopyHandlerInput, CopyHandlerOutput> {
+}
+export declare const copyHandler: CopyHandler;

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

@@ -0,0 +1,14 @@
+import { TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOutput, TaskHandlerOptions } from './types';
+export interface CreateFolderHandlerData extends TaskData {
+}
+export interface CreateFolderHandlerOptions extends TaskHandlerOptions {
+    preventOverwrite?: boolean;
+}
+export interface CreateFolderHandlerInput extends TaskHandlerInput<CreateFolderHandlerData, CreateFolderHandlerOptions> {
+    destinationPrefix: string;
+}
+export interface CreateFolderHandlerOutput extends TaskHandlerOutput {
+}
+export interface CreateFolderHandler extends TaskHandler<CreateFolderHandlerInput, CreateFolderHandlerOutput> {
+}
+export declare const createFolderHandler: CreateFolderHandler;

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

@@ -0,0 +1,12 @@
+import { TaskHandler, TaskHandlerOptions, TaskHandlerInput, TaskHandlerOutput, FileDataItem } from './types';
+export interface DeleteHandlerOptions extends TaskHandlerOptions {
+}
+export interface DeleteHandlerData extends FileDataItem {
+}
+export interface DeleteHandlerInput extends TaskHandlerInput<DeleteHandlerData, DeleteHandlerOptions> {
+}
+export interface DeleteHandlerOutput extends TaskHandlerOutput {
+}
+export interface DeleteHandler extends TaskHandler<DeleteHandlerInput, DeleteHandlerOutput> {
+}
+export declare const deleteHandler: DeleteHandler;

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

@@ -0,0 +1,12 @@
+import { FileDataItem, TaskHandler, TaskHandlerInput, TaskHandlerOptions, TaskHandlerOutput } from './types';
+export interface DownloadHandlerData extends FileDataItem {
+}
+export interface DownloadHandlerOptions extends TaskHandlerOptions {
+}
+export interface DownloadHandlerInput extends TaskHandlerInput<DownloadHandlerData, DownloadHandlerOptions> {
+}
+export interface DownloadHandlerOutput extends TaskHandlerOutput {
+}
+export interface DownloadHandler extends TaskHandler<DownloadHandlerInput, DownloadHandlerOutput> {
+}
+export declare const downloadHandler: DownloadHandler;

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

@@ -0,0 +1,9 @@
+export * from './copy';
+export * from './createFolder';
+export * from './delete';
+export * from './download';
+export * from './listLocationItems';
+export * from './listLocations';
+export * from './upload';
+export * from './utils';
+export * from './types';

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

@@ -0,0 +1,16 @@
+import { ListOutput } from '../../storage-internal';
+import { ListHandler, ListHandlerInput, ListHandlerOptions, ListHandlerOutput, LocationItemData } from './types';
+export type LocationItemType = LocationItemData['type'];
+export interface ListLocationItemsHandlerOptions extends ListHandlerOptions<LocationItemType> {
+    delimiter?: string;
+    query?: string;
+}
+export interface ListLocationItemsHandlerInput extends ListHandlerInput<ListLocationItemsHandlerOptions> {
+}
+export interface ListLocationItemsHandlerOutput extends ListHandlerOutput<LocationItemData> {
+}
+export interface ListLocationItemsHandler extends ListHandler<ListLocationItemsHandlerInput, ListLocationItemsHandlerOutput> {
+}
+export declare const filterDotItems: (items: LocationItemData[], prefix: string) => LocationItemData[];
+export declare const parseResult: ({ excludedSubpaths, items }: ListOutput, prefix: string) => LocationItemData[];
+export declare const listLocationItemsHandler: ListLocationItemsHandler;

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

@@ -0,0 +1,31 @@
+import { LocationCredentialsProvider } from '../../storage-internal';
+import { ListHandlerOptions, ListHandler, ListLocationsExcludeOptions, LocationData } from './types';
+export interface ListLocationsOptions extends ListLocationsHandlerOptions {
+}
+export interface ListLocationsInput {
+    options?: ListLocationsOptions;
+}
+export interface ListLocationsOutput {
+    items: LocationData[];
+    nextToken: string | undefined;
+}
+export interface ListLocations extends ListHandler<ListLocationsInput, ListLocationsOutput> {
+}
+export interface ListLocationsHandlerOptions extends ListHandlerOptions<ListLocationsExcludeOptions> {
+}
+export interface ListLocationsHandlerInput {
+    options?: ListLocationsHandlerOptions;
+    config: {
+        accountId?: string;
+        credentials: LocationCredentialsProvider;
+        customEndpoint?: string;
+        region: string;
+    };
+}
+export interface ListLocationsHandlerOutput {
+    items: LocationData[];
+    nextToken: string | undefined;
+}
+export interface ListLocationsHandler extends ListHandler<ListLocationsHandlerInput, ListLocationsHandlerOutput> {
+}
+export declare const listLocationsHandler: ListLocationsHandler;

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

@@ -0,0 +1,102 @@
+import { LocationCredentialsProvider } from '../../storage-internal';
+export type LocationType = 'OBJECT' | 'PREFIX' | 'BUCKET';
+export type LocationPermissions = ('delete' | 'get' | 'list' | 'write')[];
+/**
+ * `location` metadata
+ */
+export interface LocationData {
+    /**
+     * `location` s3 bucket
+     */
+    bucket: string;
+    /**
+     * Unique identifier
+     */
+    id: string;
+    /**
+     * `location` permission granted to user
+     */
+    permissions: LocationPermissions;
+    /**
+     * `location` base prefix, delimited by `'/'`. Empty string indicates bucket root
+     */
+    prefix: string;
+    /**
+     * `location` grant scope
+     *
+     * @type "OBJECT" | "PREFIX" | "BUCKET"
+     */
+    type: LocationType;
+}
+export interface FolderData {
+    key: string;
+    id: string;
+    type: 'FOLDER';
+}
+export interface FileData {
+    eTag?: string;
+    key: string;
+    lastModified: Date;
+    id: string;
+    size: number;
+    type: 'FILE';
+}
+export type LocationItemData = FileData | FolderData;
+export interface FileDataItem extends FileData, TaskData {
+    fileKey: string;
+}
+export interface FileItem extends TaskData {
+    file: File;
+}
+export interface ActionInputConfig {
+    accountId?: string;
+    bucket: string;
+    credentials: LocationCredentialsProvider;
+    customEndpoint?: string;
+    region: string;
+}
+interface ActionInput<T = any> {
+    config: ActionInputConfig;
+    prefix: string;
+    options?: T;
+}
+export interface TaskData {
+    key: string;
+    id: string;
+}
+export interface TaskHandlerOptions {
+    onProgress?: (data: {
+        key: string;
+        id: string;
+    }, progress: number | undefined) => void;
+}
+export interface TaskHandlerInput<T extends TaskData = TaskData, K extends TaskHandlerOptions = TaskHandlerOptions> {
+    config: ActionInputConfig;
+    data: T;
+    options?: K;
+}
+export interface TaskHandlerOutput {
+    cancel?: () => void;
+    result: Promise<{
+        message?: string;
+        status: 'CANCELED' | 'COMPLETE' | 'FAILED' | 'OVERWRITE_PREVENTED';
+    }>;
+}
+export type TaskHandler<T = any, K = any> = (input: T) => K;
+export interface ListHandlerOptions<T = never> {
+    exclude?: T;
+    nextToken?: string;
+    pageSize?: number;
+}
+export interface ListHandlerInput<T = any> extends ActionInput<T> {
+}
+export interface ListHandlerOutput<T = any> {
+    nextToken: string | undefined;
+    items: T[];
+}
+export type ListHandler<T = any, K = any> = (input: T) => Promise<K>;
+export interface ListLocationsExcludeOptions {
+    exactPermissions?: LocationPermissions;
+    type?: LocationType | LocationType[];
+}
+export {};

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

@@ -0,0 +1,21 @@
+import { TaskData, TaskHandler, TaskHandlerInput, TaskHandlerOutput, TaskHandlerOptions } from './types';
+export interface UploadHandlerOptions extends TaskHandlerOptions {
+    preventOverwrite?: boolean;
+}
+export interface UploadHandlerData extends TaskData {
+    file: File;
+}
+export interface UploadHandlerInput extends TaskHandlerInput<UploadHandlerData, UploadHandlerOptions> {
+    destinationPrefix: string;
+}
+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;
+    resume: undefined;
+};
+export declare const uploadHandler: UploadHandler;

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

@@ -0,0 +1,17 @@
+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';
+export declare const constructBucket: ({ bucket: bucketName, region, }: Pick<ActionInputConfig, 'bucket' | 'region'>) => {
+    bucketName: string;
+    region: string;
+};
+export declare const parseAccessGrantLocation: (location: AccessGrantLocation) => LocationData;
+export declare const shouldExcludeLocation: ({ permissions, type }: LocationData, exclude?: ListLocationsExcludeOptions) => boolean;
+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

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

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

@@ -0,0 +1,8 @@
+import { DataState } from '@aws-amplify/ui-react-core';
+import { ListHandler, TaskHandler } from './handlers';
+export type ActionState<T = any, K = any> = [
+    state: DataState<T>,
+    handleAction: (...input: K[]) => void
+];
+export type UseAction<T> = T extends ListHandler<infer K, infer U> | TaskHandler<infer K, infer U> ? ActionState<U, K> : never;
+export type CreateUseAction = <T>(actions: T) => <K extends keyof T>(key: K) => UseAction<T[K]>;

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

@@ -0,0 +1,45 @@
+import { AsyncDataAction } from '@aws-amplify/ui-react-core';
+import { ListHandler, ListHandlerOptions, ListHandlerInput, ListHandlerOutput } from '../handlers';
+type KeyWithStringValue<T> = keyof {
+    [P in keyof T as T[P] extends string ? P : never]: T[P];
+};
+interface SearchOptions<T> {
+    query: string;
+    /**
+     * The key of the object in the list to filter by, which must have a string value.
+     * Also accepts a function which takes an item and returns the appropriate key.
+     * This determines where the `query` will be searched.
+     */
+    filterBy: KeyWithStringValue<T> | ((item: T) => KeyWithStringValue<T>);
+    /**
+     * Optional delimiter to group item keys.
+     */
+    groupBy?: string;
+}
+export interface EnhancedListHandlerOptions<T, K> extends ListHandlerOptions<K> {
+    refresh?: boolean;
+    reset?: boolean;
+    search?: SearchOptions<T>;
+}
+export interface SearchOutput {
+    hasExhaustedSearch: boolean;
+}
+export interface EnhancedListHandlerOutput<T> extends ListHandlerOutput<T> {
+    search?: SearchOutput;
+}
+export interface EnhancedListHandlerInput<T, K> extends ListHandlerInput<EnhancedListHandlerOptions<T, K>> {
+}
+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;
+export declare const SEARCH_LIMIT = 10000;
+export declare const SEARCH_PAGE_SIZE = 1000;
+interface Search<T> {
+    prefix?: string;
+    list: T[];
+    options: SearchOptions<T>;
+}
+export declare function searchItems<T>({ prefix, list, options }: Search<T>): T[];
+export declare const createEnhancedListHandler: <Action extends ListHandler>(action: Action) => EnhancedListHandler<ListItem<Action>, Options<Action>>;
+export {};

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

@@ -0,0 +1 @@
+export { useListLocations, UseListLocationsState } from './useListLocations';

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

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

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

@@ -0,0 +1,5 @@
+import { StorageBrowserAuthAdapter } from '../types';
+export declare const MISSING_BUCKET_OR_REGION_ERROR = "Amplify Storage configuration not found. Did you run `Amplify.configure` from your project root?";
+export declare const MISSING_IDENTITY_ID_ERROR = "`identityId` not found.";
+export declare const MISSING_TEMPORARY_CREDENTIALS_ERROR = "Temporary Auth `credentials` not found.";
+export declare const createAmplifyAuthAdapter: () => StorageBrowserAuthAdapter;

package/dist/types/components/StorageBrowser/adapters/createAmplifyAuthAdapter/createAmplifyListLocationsHandler.d.ts

@@ -0,0 +1,2 @@
+import { ListLocations } from '../../actions';
+export declare const createAmplifyListLocationsHandler: () => ListLocations;

package/dist/types/components/StorageBrowser/adapters/createAmplifyAuthAdapter/getPaginatedLocations.d.ts

@@ -0,0 +1,6 @@
+import { ListLocationsHandlerOutput, LocationData } from '../../actions';
+export declare const getPaginatedLocations: ({ items, pageSize, nextToken, }: {
+    items: LocationData[];
+    pageSize?: number | undefined;
+    nextToken?: string | undefined;
+}) => ListLocationsHandlerOutput;

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

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

package/dist/types/components/StorageBrowser/adapters/createManagedAuthAdapter/createLocationCredentialsHandler.d.ts

@@ -0,0 +1,10 @@
+import { GetLocationCredentials } from '../../credentials/types';
+import { CredentialsProvider } from '../../storage-internal';
+interface CreateLocationCredentialsHandlerInput {
+    accountId: string;
+    credentialsProvider: CredentialsProvider;
+    region: string;
+    customEndpoint?: string;
+}
+export declare const createLocationCredentialsHandler: (handlerInput: CreateLocationCredentialsHandlerInput) => GetLocationCredentials;
+export {};

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

@@ -0,0 +1,9 @@
+import { StorageBrowserAuthAdapter, CreateManagedAuthAdapterInput } from '../types';
+/**
+ * Create configuration including handlers to call S3 Access Grant APIs to list and get
+ * credentials for different locations.
+ *
+ * @param options - Configuration options for the adapter.
+ * @returns - An object containing the handlers to call S3 Access Grant APIs and region
+ */
+export declare const createManagedAuthAdapter: ({ accountId, credentialsProvider, customEndpoint, region, registerAuthListener, }: CreateManagedAuthAdapterInput) => StorageBrowserAuthAdapter;

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

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

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

@@ -0,0 +1,3 @@
+export { createAmplifyAuthAdapter } from './createAmplifyAuthAdapter';
+export { createManagedAuthAdapter } from './createManagedAuthAdapter';
+export { CreateManagedAuthAdapterInput, StorageBrowserAuthAdapter, } from './types';

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

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

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

@@ -0,0 +1,27 @@
+import { RegisterAuthListener } from '../providers';
+import { GetLocationCredentials, CredentialsLocation } from '../credentials/types';
+import { CredentialsProvider } from '../storage-internal';
+import { LocationType, ListLocations } from '../actions';
+export interface LocationAccess extends CredentialsLocation {
+    /**
+     * Parse location type parsed from scope format:
+     * * BUCKET: `'s3://<bucket>/*'`
+     * * PREFIX: `'s3://<bucket>/<prefix-with-path>*'`
+     * * OBJECT: `'s3://<bucket>/<prefix-with-path>/<object>'`
+     */
+    readonly type: LocationType;
+}
+export interface CreateManagedAuthAdapterInput {
+    accountId: string;
+    region: string;
+    credentialsProvider: CredentialsProvider;
+    registerAuthListener: RegisterAuthListener;
+    customEndpoint?: string;
+}
+export interface StorageBrowserAuthAdapter {
+    accountId?: string;
+    listLocations: ListLocations;
+    getLocationCredentials: GetLocationCredentials;
+    region: string;
+    registerAuthListener: RegisterAuthListener;
+}