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

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

@@ -0,0 +1,151 @@
+import { StatusCounts, Tasks } 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';
+import { FileItems } from '../providers';
+/**
+ * Common list view display text values
+ */
+export interface DefaultListViewDisplayText {
+    loadingIndicatorLabel: string;
+    searchPlaceholder: string;
+    searchSubmitLabel: string;
+    searchClearLabel: string;
+    getDateDisplayValue: (date: Date) => string;
+}
+interface ListMessageData {
+    hasError?: boolean;
+    message?: string;
+    hasExhaustedSearch?: boolean;
+    query?: string;
+    isLoading?: boolean;
+}
+interface ListLocationsMessageData extends ListMessageData {
+    locations: LocationData[] | undefined;
+}
+export interface DefaultLocationsViewDisplayText extends DefaultListViewDisplayText {
+    getListLocationsResultMessage: (data?: ListLocationsMessageData) => {
+        content?: string;
+        type?: MessageType;
+    } | undefined;
+    getDownloadLabel: (fileName: string) => string;
+    getPermissionName: (permissions: LocationPermissions) => string;
+    tableColumnActionsHeader: string;
+    tableColumnBucketHeader: string;
+    tableColumnFolderHeader: string;
+    tableColumnPermissionsHeader: string;
+    title: string;
+}
+interface ListItemsMessageData extends ListMessageData {
+    items: LocationItemData[] | undefined;
+}
+export interface DefaultLocationDetailViewDisplayText extends DefaultListViewDisplayText {
+    getListItemsResultMessage: (data: ListItemsMessageData) => {
+        content?: string;
+        type?: MessageType;
+    } | undefined;
+    searchSubfoldersToggleLabel: string;
+    selectFileLabel: string;
+    selectAllFilesLabel: string;
+    tableColumnLastModifiedHeader: string;
+    tableColumnNameHeader: string;
+    tableColumnSizeHeader: string;
+    tableColumnTypeHeader: string;
+    getActionListItemLabel: (key: string | undefined) => string;
+    getTitle: (location: LocationState) => string;
+}
+/**
+ * Action view display text values
+ */
+/**
+ * Common display text values available on each action view (e.g. upload, copy, etc)
+ */
+export interface DefaultActionViewDisplayText<T extends TaskData = TaskData> {
+    actionCancelLabel: string;
+    actionDestinationLabel: string;
+    actionExitLabel: string;
+    actionStartLabel: string;
+    getActionCompleteMessage: (data?: {
+        counts?: StatusCounts;
+        tasks?: Tasks<T>;
+    }) => {
+        content?: string;
+        type?: MessageType;
+    } | undefined;
+    statusDisplayCanceledLabel: string;
+    statusDisplayCompletedLabel: string;
+    statusDisplayFailedLabel: string;
+    statusDisplayInProgressLabel: string;
+    statusDisplayQueuedLabel: string;
+    statusDisplayTotalLabel: string;
+    title: string;
+    tableColumnCancelHeader: string;
+    tableColumnStatusHeader: string;
+    tableColumnFolderHeader: string;
+    tableColumnNameHeader: string;
+    tableColumnTypeHeader: string;
+    tableColumnSizeHeader: string;
+    tableColumnProgressHeader: string;
+}
+export interface DefaultCreateFolderViewDisplayText extends Omit<DefaultActionViewDisplayText<CreateFolderHandlerData>, `${'tableColumn' | 'statusDisplay'}${string}`> {
+    folderNameLabel: string;
+    folderNamePlaceholder: string;
+    getValidationMessage: (folderName: string) => string | undefined;
+}
+interface ListFoldersMessageData extends ListMessageData {
+    folders: FolderData[] | undefined;
+}
+export interface DefaultCopyViewDisplayText extends DefaultActionViewDisplayText<CopyHandlerData> {
+    getListFoldersResultsMessage: (data: ListFoldersMessageData) => {
+        content?: string;
+        type?: MessageType;
+    } | undefined;
+    loadingIndicatorLabel: 'Loading';
+    overwriteWarningMessage: string;
+    searchPlaceholder: string;
+    searchSubmitLabel: string;
+    searchClearLabel: string;
+}
+export interface DefaultDeleteViewDisplayText extends DefaultActionViewDisplayText<DeleteHandlerData> {
+}
+export interface DefaultUploadViewDisplayText extends DefaultActionViewDisplayText<UploadHandlerData> {
+    addFilesLabel: string;
+    addFolderLabel: string;
+    statusDisplayOverwritePreventedLabel: string;
+    overwriteToggleLabel: string;
+    getFilesValidationMessage: (data?: {
+        invalidFiles?: FileItems;
+    }) => {
+        content?: string;
+        type?: MessageType;
+    } | undefined;
+}
+export interface DefaultStorageBrowserDisplayText {
+    CopyView: DefaultCopyViewDisplayText;
+    CreateFolderView: DefaultCreateFolderViewDisplayText;
+    DeleteView: DefaultDeleteViewDisplayText;
+    LocationsView: DefaultLocationsViewDisplayText;
+    LocationDetailView: DefaultLocationDetailViewDisplayText;
+    UploadView: DefaultUploadViewDisplayText;
+}
+export interface CreateFolderViewDisplayText extends Partial<DefaultCreateFolderViewDisplayText> {
+}
+export interface CopyViewDisplayText extends Partial<DefaultCopyViewDisplayText> {
+}
+export interface DeleteViewDisplayText extends Partial<DefaultDeleteViewDisplayText> {
+}
+export interface LocationsViewDisplayText extends Partial<DefaultLocationsViewDisplayText> {
+}
+export interface LocationDetailViewDisplayText extends Partial<DefaultLocationDetailViewDisplayText> {
+}
+export interface UploadViewDisplayText extends Partial<DefaultUploadViewDisplayText> {
+}
+export interface StorageBrowserDisplayText {
+    LocationsView?: LocationsViewDisplayText;
+    LocationDetailView?: LocationDetailViewDisplayText;
+    UploadView?: UploadViewDisplayText;
+    DeleteView?: DeleteViewDisplayText;
+    CopyView?: CopyViewDisplayText;
+    CreateFolderView?: CreateFolderViewDisplayText;
+}
+export {};

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

@@ -0,0 +1,4 @@
+export { componentsDefault } from './componentsDefault';
+export { createStorageBrowser } from './createStorageBrowser';
+export { createAmplifyAuthAdapter, createManagedAuthAdapter, CreateManagedAuthAdapterInput, StorageBrowserAuthAdapter, } from './adapters';
+export { CreateStorageBrowserInput, StorageBrowserType } from './types';

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

@@ -0,0 +1,6 @@
+import React from 'react';
+import { GetActionInputProviderProps, GetActionInput } from './types';
+export declare const useGetActionInput: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => GetActionInput, GetActionInputContext: React.Context<GetActionInput>;
+export declare function GetActionInputProvider({ accountId, children, customEndpoint, region, }: GetActionInputProviderProps): React.JSX.Element;

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

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

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

@@ -0,0 +1,6 @@
+import React from 'react';
+import { CredentialsProviderProps, CredentialsStore } from './types';
+export declare const useCredentials: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => CredentialsStore, CredentialsContext: React.Context<CredentialsStore>;
+export declare function CredentialsProvider({ children, ...props }: CredentialsProviderProps): React.JSX.Element;

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

@@ -0,0 +1,2 @@
+export { CredentialsProvider, useCredentials } from './context';
+export * from './types';

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

@@ -0,0 +1,20 @@
+import React from 'react';
+import { LocationPermissions } from '../../../actions';
+import { LocationCredentialsProvider } from '../../../storage-internal';
+import { CreateLocationCredentialsStoreInput, GetLocationCredentials, LocationCredentialsStore } from '../../../credentials/types';
+export type RegisterAuthListener = (onStateChange: () => void) => void;
+export type GetCredentials = (input: {
+    scope: string;
+    permissions: LocationPermissions;
+}) => LocationCredentialsProvider;
+export interface CredentialsStore extends Omit<LocationCredentialsStore, 'getProvider'> {
+    getCredentials: GetCredentials;
+}
+export interface CreateCredentialsStoreInput extends CreateLocationCredentialsStoreInput {
+}
+export interface CredentialsProviderProps {
+    children?: React.ReactNode;
+    getLocationCredentials: GetLocationCredentials;
+    onDestroy?: () => void;
+    registerAuthListener: RegisterAuthListener;
+}

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

@@ -0,0 +1,8 @@
+import { CredentialsStore, RegisterAuthListener } from './types';
+import { GetLocationCredentials } from '../../../credentials/types';
+export declare function useCredentialsStore({ getLocationCredentials: handler, initialValue, onDestroy, registerAuthListener, }: {
+    getLocationCredentials: GetLocationCredentials;
+    initialValue?: CredentialsStore;
+    onDestroy?: () => void;
+    registerAuthListener: RegisterAuthListener;
+}): CredentialsStore;

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

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

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

@@ -0,0 +1,19 @@
+import React from 'react';
+import { ActionInputConfig, ActionConfigsProviderProps, LocationData } from '../../actions';
+import { CredentialsProviderProps } from './credentials';
+export type GetActionInput = (location?: LocationData) => ActionInputConfig;
+export interface GetActionInputProviderProps {
+    accountId?: string;
+    children?: React.ReactNode;
+    region: string;
+    customEndpoint?: string;
+}
+export interface CreateConfigurationProviderInput<T extends React.ComponentType<any>> extends ActionConfigsProviderProps, GetActionInputProviderProps, CredentialsProviderProps {
+    ChildComponent?: T;
+    displayName: string;
+    region: string;
+}
+export interface ConfigurationProviderComponent<T extends React.ComponentType<any>> {
+    (props: React.ComponentProps<T>): React.JSX.Element;
+    displayName: string;
+}

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

@@ -0,0 +1,7 @@
+import { GetActionInput } from './types';
+export declare const getErrorMessage: (propertyName: string) => string;
+export declare function useGetActionInputCallback({ accountId, customEndpoint, region, }: {
+    accountId?: string;
+    customEndpoint?: string;
+    region: string;
+}): GetActionInput;

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

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

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

@@ -0,0 +1,8 @@
+import React from 'react';
+import { LocationProviderProps } from './location';
+import { FilesProviderProps } from './files';
+import { ActionTypeProviderProps } from './actionType';
+import { LocationItemsProviderProps } from './locationItems';
+export interface StoreProviderProps extends ActionTypeProviderProps, FilesProviderProps, LocationProviderProps, LocationItemsProviderProps {
+}
+export declare function StoreProvider(props: StoreProviderProps): React.JSX.Element;

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

@@ -0,0 +1,6 @@
+import React from 'react';
+import { ActionTypeProviderProps, ActionTypeStateContext } from './types';
+export declare const ActionTypeContext: React.Context<ActionTypeStateContext>, useActionType: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => ActionTypeStateContext;
+export declare function ActionTypeProvider({ actionType, children, }: ActionTypeProviderProps): React.JSX.Element;

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

@@ -0,0 +1,2 @@
+export { ActionTypeProvider, useActionType } from './context';
+export * from './types';

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

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+export type ActionTypeAction = {
+    type: 'SET_ACTION_TYPE';
+    actionType: string;
+} | {
+    type: 'RESET_ACTION_TYPE';
+};
+export type HandleActionTypeAction = (event: ActionTypeAction) => void;
+export type ActionTypeStateContext = [
+    string | undefined,
+    HandleActionTypeAction
+];
+export interface ActionTypeProviderProps {
+    actionType?: string;
+    children?: React.ReactNode;
+}

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

@@ -0,0 +1,2 @@
+import { ActionTypeStateContext } from './types';
+export declare function useActionTypeState(initialState?: string): ActionTypeStateContext;

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

@@ -0,0 +1,6 @@
+import React from 'react';
+import { FilesContextType, FilesProviderProps } from './types';
+export declare const FilesContext: React.Context<FilesContextType>, useFiles: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => FilesContextType;
+export declare function FilesProvider({ children, }: FilesProviderProps): React.JSX.Element;

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

@@ -0,0 +1,2 @@
+export { FilesProvider, FilesContext, useFiles } from './context';
+export * from './types';

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

@@ -0,0 +1,23 @@
+/// <reference types="react" />
+import { SelectionType, TaskData } from '../../../actions';
+export type FilesActionType = {
+    type: 'ADD_FILE_ITEMS';
+    files?: File[];
+} | {
+    type: 'REMOVE_FILE_ITEM';
+    id: string;
+} | {
+    type: 'SELECT_FILES';
+    selectionType?: SelectionType;
+} | {
+    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 {
+    children?: React.ReactNode;
+}

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

@@ -0,0 +1,8 @@
+import React from 'react';
+import { SelectionType } from '../../../actions/configs';
+import { FileItems, FilesActionType } from './types';
+export declare const resolveFiles: (prevItems: FileItems, files: File[] | undefined) => FileItems;
+export declare const filesReducer: React.Reducer<FileItems, Exclude<FilesActionType, {
+    type: 'SELECT_FILES';
+}>>;
+export declare const parseFileSelectParams: (value?: SelectionType) => [selectType: import("@aws-amplify/ui-react/dist/types/components/FileSelect/FileSelect").SelectType, options?: import("@aws-amplify/ui-react/internal").FileSelectOptions | undefined];

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

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

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

@@ -0,0 +1,58 @@
+import React from 'react';
+import { LocationData } from '../../../actions';
+export declare const ERROR_MESSAGE = "Invalid `location` value provided as initial value to `LocationProvider.";
+export declare const DEFAULT_STATE: LocationState;
+export type LocationActionType = {
+    type: 'NAVIGATE';
+    location: LocationData;
+    path?: string;
+} | {
+    type: 'RESET_LOCATION';
+};
+/**
+ * Stores current `location` and nested `path` values set on
+ * navigate events.
+ *
+ * @example
+ *`"s3://my-bucket/my/prefix/a-path/a-nested-path/"`
+ *
+ * ```
+ * const state: LocationState = {
+ *   location: {
+ *     bucket: 'my-bucket',
+ *     permisson: 'READWRITE',
+ *     prefix: 'my/prefix/',
+ *     type: 'PREFIX',
+ *   },
+ *   path: 'a-path/a-nested-path/',
+ *   key: 'my/prefix/a-path/a-nested-path/',
+ * }
+ *
+ */
+export interface LocationState {
+    /**
+     * current `location` metadata
+     */
+    current: LocationData | undefined;
+    /**
+     * current `location` subpath within a `location`
+     */
+    path: string;
+    /**
+     * fully qualified string consisting of `location` prefix and path
+     */
+    key: string;
+}
+export type LocationStateContext = [
+    LocationState,
+    (action: LocationActionType) => void
+];
+export interface LocationProviderProps {
+    children?: React.ReactNode;
+    location?: LocationData;
+    path?: string;
+}
+export declare const LocationContext: React.Context<LocationStateContext>, useLocation: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => LocationStateContext;
+export declare function LocationProvider({ children, location, path, }: LocationProviderProps): React.JSX.Element;

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

@@ -0,0 +1 @@
+export { LocationActionType, LocationProviderProps, LocationState, LocationProvider, useLocation, } from './context';

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

@@ -0,0 +1,27 @@
+import React from 'react';
+import { FileData, FileDataItem } from '../../../actions';
+export declare const DEFAULT_STATE: LocationItemsState;
+export type LocationItemsAction = {
+    type: 'SET_LOCATION_ITEMS';
+    items?: FileData[];
+} | {
+    type: 'REMOVE_LOCATION_ITEM';
+    id: string;
+} | {
+    type: 'RESET_LOCATION_ITEMS';
+};
+export interface LocationItemsState {
+    fileDataItems: FileDataItem[] | undefined;
+}
+export type HandleLocationItemsAction = (event: LocationItemsAction) => void;
+export type LocationItemStateContext = [
+    LocationItemsState,
+    HandleLocationItemsAction
+];
+export interface LocationItemsProviderProps {
+    children?: React.ReactNode;
+}
+export declare const LocationItemsContext: React.Context<LocationItemStateContext>, useLocationItems: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => LocationItemStateContext;
+export declare function LocationItemsProvider({ children, }: LocationItemsProviderProps): React.JSX.Element;

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

@@ -0,0 +1 @@
+export { LocationItemsAction, LocationItemsProvider, LocationItemsProviderProps, LocationItemsState, useLocationItems, } from './context';

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

@@ -0,0 +1,12 @@
+import { ActionTypeAction } from './actionType';
+import { FileItems, FilesActionType } from './files';
+import { LocationActionType, LocationState } from './location';
+import { LocationItemsAction, LocationItemsState } from './locationItems';
+export interface UseStoreState {
+    actionType: string | undefined;
+    files: FileItems | undefined;
+    location: LocationState;
+    locationItems: LocationItemsState;
+}
+export type HandleStoreAction = (action: ActionTypeAction | FilesActionType | LocationActionType | LocationItemsAction) => void;
+export declare function useStore(): [UseStoreState, HandleStoreAction];

package/dist/types/components/StorageBrowser/storage-internal.d.ts

@@ -0,0 +1 @@
+export { AWSTemporaryCredentials, CopyInput, CredentialsLocation, CredentialsProvider, GetUrlInput, ListLocations, ListLocationsOutput, ListOutput, ListPaginateInput, LocationAccess, LocationCredentials, LocationCredentialsProvider, Permission, RemoveInput, StorageAccess, StorageSubpathStrategy, StorageValidationErrorCode, UploadDataInput, ListPathsOutput, assertValidationError, copy, getDataAccess, getUrl, list, listCallerAccessGrants, listPaths, remove, uploadData, validationErrorMap, } from '@aws-amplify/storage/internals';

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

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

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

@@ -0,0 +1,3 @@
+export { INITIAL_STATUS_COUNTS } from './constants';
+export { useProcessTasks } from './useProcessTasks';
+export { StatusCounts, Task, Tasks, TaskStatus } from './types';

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

@@ -0,0 +1,30 @@
+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> {
+    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;
+    onTaskRemove?: (data: Task<T>) => void;
+}
+export interface Task<T extends TaskData = TaskData> {
+    data: T;
+    message: string | undefined;
+    progress: number | undefined;
+    status: TaskStatus;
+    cancel?: () => void;
+}
+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>
+];

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

@@ -0,0 +1,4 @@
+import { TaskHandlerInput, TaskData, TaskHandlerOutput, TaskHandler } 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;

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

@@ -0,0 +1,4 @@
+import { StatusCounts, Task } from './types';
+export declare const getStatusCounts: (tasks?: Task[]) => StatusCounts;
+export declare const isProcessingTasks: (statusCounts: StatusCounts) => boolean;
+export declare const hasCompletedProcessingTasks: (statusCounts: StatusCounts) => boolean;

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

@@ -0,0 +1,39 @@
+import React from 'react';
+import { ListLocations } from './actions';
+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 { StorageBrowserDisplayText } from './displayText';
+export interface Config {
+    accountId?: string;
+    customEndpoint?: string;
+    getLocationCredentials: GetLocationCredentials;
+    listLocations: ListLocations;
+    registerAuthListener: RegisterAuthListener;
+    region: string;
+}
+export interface CreateStorageBrowserInput {
+    config: Config;
+    components?: Components;
+}
+export interface StorageBrowserProps<T = string> {
+    views?: Views<T>;
+    displayText?: StorageBrowserDisplayText;
+}
+export interface StorageBrowserType<T = string, K = {}> {
+    (props: StorageBrowserProps & Exclude<K, keyof StorageBrowserProps>): React.JSX.Element;
+    displayName: string;
+    Provider: (props: StorageBrowserProviderProps) => React.JSX.Element;
+    CopyView: CopyViewType;
+    CreateFolderView: CreateFolderViewType;
+    DeleteView: DeleteViewType;
+    UploadView: UploadViewType;
+    LocationActionView: (props: LocationActionViewProps<T>) => React.JSX.Element | null;
+    LocationDetailView: LocationDetailViewType;
+    LocationsView: LocationsViewType;
+}
+export type ActionViewName<T = string> = Exclude<T, 'listLocationItems' | 'listLocations'>;
+export interface StorageBrowserProviderProps extends StoreProviderProps {
+    displayText?: StorageBrowserDisplayText;
+}

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

@@ -0,0 +1 @@
+export declare function assertAccountId(value: string | undefined): asserts value is string;

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

@@ -0,0 +1,3 @@
+import { LocationData } from '../actions';
+export declare function assertLocationData(value: LocationData | undefined, message?: string): asserts value is LocationData;
+export declare function assertPrefix(value: string | undefined, message?: string): asserts value is string;

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

@@ -0,0 +1,2 @@
+import { RegisterAuthListener } from '../providers';
+export declare function assertRegisterAuthListener(value: unknown): asserts value is RegisterAuthListener;

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

@@ -0,0 +1,4 @@
+export { assertLocationData } from './assertLocationData';
+export { assertRegisterAuthListener } from './assertRegisterAuthListener';
+export { assertAccountId } from './assertAccountId';
+export { isFileTooBig } from './isFileTooBig';

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

@@ -0,0 +1,2 @@
+export declare const UPLOAD_FILE_SIZE_LIMIT: number;
+export declare const isFileTooBig: (file: File) => boolean;

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

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

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

@@ -0,0 +1,3 @@
+import React from 'react';
+import { CopyViewProviderProps } from './types';
+export declare function CopyViewProvider({ children, ...props }: CopyViewProviderProps): React.JSX.Element;

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

@@ -0,0 +1,16 @@
+import React from 'react';
+import { FolderData } from '../../../actions';
+export interface FoldersMessageProps {
+    hasError?: boolean;
+    message?: string;
+    folders?: FolderData[];
+    query?: string;
+    hasExhaustedSearch?: boolean;
+}
+export declare const useFoldersMessage: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => FoldersMessageProps, FoldersMessageProvider: React.ComponentType<React.PropsWithChildren<FoldersMessageProps>>;
+export declare const FoldersMessageControl: {
+    (): React.JSX.Element;
+    displayName: string;
+};

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

@@ -0,0 +1,9 @@
+import React from 'react';
+import { PaginationProps } from '../../../composables/Pagination';
+export declare const FoldersPaginationProvider: React.ComponentType<React.PropsWithChildren<PaginationProps>>, useFoldersPagination: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => PaginationProps;
+export declare const FoldersPaginationControl: {
+    (): React.JSX.Element;
+    displayName: string;
+};

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

@@ -0,0 +1,15 @@
+import React from 'react';
+import { FolderData } from '../../../actions';
+import { LocationState } from '../../../providers/store/location';
+export interface FoldersTableProps {
+    destination?: LocationState;
+    folders?: FolderData[];
+    onSelectFolder?: (id: string, folderLocationPath: string) => void;
+}
+export declare const useFoldersTable: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => FoldersTableProps, FoldersTableProvider: React.ComponentType<React.PropsWithChildren<FoldersTableProps>>;
+export declare const FoldersTableControl: {
+    (): React.JSX.Element;
+    displayName: string;
+};