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

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

@@ -0,0 +1,77 @@
+/// <reference types="react" />
+import { FileData, FileDataItem, LocationData, LocationItemData } from '../../actions';
+import { ActionsListItem } from '../../composables/ActionsList';
+import { LocationState } from '../../providers/store/location';
+import { ListViewProps } from '../types';
+export interface LocationDetailViewState {
+    actions: ActionsListItem[];
+    hasError: boolean;
+    hasNextPage: boolean;
+    hasDownloadError: boolean;
+    highestPageVisited: number;
+    isLoading: boolean;
+    isSearchingSubfolders: boolean;
+    location: LocationState;
+    areAllFilesSelected: boolean;
+    fileDataItems: FileDataItem[] | undefined;
+    hasFiles: boolean;
+    message: string | undefined;
+    downloadErrorMessage: string | undefined;
+    shouldShowEmptyMessage: boolean;
+    searchQuery: string;
+    hasExhaustedSearch: boolean;
+    pageItems: LocationItemData[];
+    page: number;
+    onActionSelect: (actionType: string) => void;
+    onDropFiles: (files: File[]) => void;
+    onRefresh: () => void;
+    onNavigate: (location: LocationData, path?: string) => void;
+    onNavigateHome: () => void;
+    onPaginate: (page: number) => void;
+    onDownload: (fileItem: FileDataItem) => void;
+    onSelect: (isSelected: boolean, fileItem: FileData) => void;
+    onSelectAll: () => void;
+    onSearch: () => void;
+    onSearchClear: () => void;
+    onSearchQueryChange: (value: string) => void;
+    onToggleSearchSubfolders: () => void;
+}
+export interface LocationDetailViewProps extends ListViewProps {
+    onActionSelect?: (type: string) => void;
+    onExit?: () => void;
+}
+export interface LocationDetailViewProviderProps extends LocationDetailViewState {
+    children?: React.ReactNode;
+}
+export interface LocationDetailViewType {
+    (props: {
+        children?: React.ReactNode;
+        className?: string;
+    } & LocationDetailViewProps): React.JSX.Element | null;
+    displayName: string;
+    Provider: (props: LocationDetailViewProviderProps) => React.JSX.Element;
+    ActionsList: () => React.JSX.Element | null;
+    DropZone: (props: {
+        children: React.ReactNode;
+    }) => React.JSX.Element | null;
+    LoadingIndicator: () => React.JSX.Element | null;
+    LocationItemsTable: () => React.JSX.Element | null;
+    Message: () => React.JSX.Element | null;
+    Navigation: () => React.JSX.Element | null;
+    Pagination: () => React.JSX.Element | null;
+    Refresh: () => React.JSX.Element | null;
+    Search: () => React.JSX.Element | null;
+    SearchSubfoldersToggle: () => React.JSX.Element | null;
+    Title: () => React.JSX.Element | null;
+}
+interface InitialValues {
+    pageSize?: number;
+    delimiter?: string;
+}
+export interface UseLocationDetailViewOptions {
+    initialValues?: InitialValues;
+    onActionSelect?: (actionType: string) => void;
+    onExit?: () => void;
+    onNavigate?: (location: LocationData, path?: string) => void;
+}
+export {};

package/dist/types/components/StorageBrowser/views/LocationDetailView/useLocationDetailView.d.ts

@@ -0,0 +1,6 @@
+import { LocationDetailViewState, UseLocationDetailViewOptions } from './types';
+export declare const DEFAULT_LIST_OPTIONS: {
+    delimiter: string;
+    pageSize: number;
+};
+export declare const useLocationDetailView: (options?: UseLocationDetailViewOptions) => LocationDetailViewState;

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

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

package/dist/types/components/StorageBrowser/views/LocationsView/LocationsViewProvider.d.ts

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

package/dist/types/components/StorageBrowser/views/LocationsView/getLocationsViewTableData/getHeaders.d.ts

@@ -0,0 +1,8 @@
+import { LocationViewHeaders } from './types';
+export declare const getHeaders: ({ hasObjectLocations, tableColumnActionsHeader, tableColumnBucketHeader, tableColumnFolderHeader, tableColumnPermissionsHeader, }: {
+    hasObjectLocations: boolean;
+    tableColumnActionsHeader: string;
+    tableColumnBucketHeader: string;
+    tableColumnFolderHeader: string;
+    tableColumnPermissionsHeader: string;
+}) => LocationViewHeaders;

package/dist/types/components/StorageBrowser/views/LocationsView/getLocationsViewTableData/getLocationsViewTableData.d.ts

@@ -0,0 +1,9 @@
+import { DataTableProps } from '../../../composables/DataTable';
+import { LocationData } from '../../../actions';
+import { DefaultLocationsViewDisplayText } from '../../../displayText/types';
+export declare const getLocationsViewTableData: ({ displayText, pageItems, onNavigate, onDownload, }: {
+    displayText: DefaultLocationsViewDisplayText;
+    pageItems: LocationData[];
+    onNavigate: (location: LocationData) => void;
+    onDownload: (location: LocationData) => void;
+}) => DataTableProps;

package/dist/types/components/StorageBrowser/views/LocationsView/getLocationsViewTableData/index.d.ts

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

package/dist/types/components/StorageBrowser/views/LocationsView/getLocationsViewTableData/types.d.ts

@@ -0,0 +1,4 @@
+import { WithKey } from '../../../components/types';
+import { DataTableProps } from '../../../composables/DataTable';
+export type HeaderKeys = 'folder' | 'bucket' | 'permission' | 'action';
+export type LocationViewHeaders = WithKey<DataTableProps['headers'][number], HeaderKeys>[];

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

@@ -0,0 +1,3 @@
+export { LocationsView } from './LocationsView';
+export { LocationsViewProps, LocationsViewType } from './types';
+export { useLocationsView } from './useLocationsView';

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

@@ -0,0 +1,50 @@
+/// <reference types="react" />
+import { LocationData } from '../../actions';
+import { ListViewProps } from '../types';
+export interface LocationsViewState {
+    hasNextPage: boolean;
+    hasError: boolean;
+    highestPageVisited: number;
+    isLoading: boolean;
+    message: string | undefined;
+    shouldShowEmptyMessage: boolean;
+    pageItems: LocationData[];
+    page: number;
+    searchQuery: string;
+    hasExhaustedSearch: boolean;
+    onDownload: (item: LocationData) => void;
+    onNavigate: (location: LocationData) => void;
+    onRefresh: () => void;
+    onPaginate: (page: number) => void;
+    onSearch: () => void;
+    onSearchQueryChange: (value: string) => void;
+    onSearchClear: () => void;
+}
+export interface LocationsViewProps extends ListViewProps {
+}
+export interface LocationsViewProviderProps extends LocationsViewState {
+    children?: React.ReactNode;
+}
+export interface LocationsViewType {
+    (props: {
+        children?: React.ReactNode;
+        className?: string;
+    } & LocationsViewProps): React.JSX.Element | null;
+    displayName: string;
+    Provider: (props: LocationsViewProviderProps) => React.JSX.Element;
+    LoadingIndicator: () => React.JSX.Element | null;
+    LocationsTable: () => React.JSX.Element | null;
+    Message: () => React.JSX.Element | null;
+    Pagination: () => React.JSX.Element | null;
+    Refresh: () => React.JSX.Element | null;
+    Search: () => React.JSX.Element | null;
+    Title: () => React.JSX.Element | null;
+}
+interface InitialValues {
+    pageSize?: number;
+}
+export interface UseLocationsViewOptions {
+    initialValues?: InitialValues;
+    onNavigate?: (location: LocationData) => void;
+}
+export {};

package/dist/types/components/StorageBrowser/views/LocationsView/useLocationsView.d.ts

@@ -0,0 +1,7 @@
+import { ListLocationsExcludeOptions } from '../../actions';
+import { LocationsViewState, UseLocationsViewOptions } from './types';
+export declare const DEFAULT_LIST_OPTIONS: {
+    exclude: ListLocationsExcludeOptions;
+    pageSize: number;
+};
+export declare const useLocationsView: (options?: UseLocationsViewOptions) => LocationsViewState;

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

@@ -0,0 +1,16 @@
+import React from 'react';
+import { LocationActionViewProps } from './LocationActionView';
+import { LocationDetailViewProps } from './LocationDetailView';
+import { LocationsViewProps } from './LocationsView';
+export interface DefaultViews<T = string> {
+    LocationActionView: (props: LocationActionViewProps<T>) => React.JSX.Element | null;
+    LocationDetailView: (props: LocationDetailViewProps) => React.JSX.Element | null;
+    LocationsView: (props: LocationsViewProps) => React.JSX.Element | null;
+}
+export interface Views<T = string> extends Partial<DefaultViews<T>> {
+}
+export declare function ViewsProvider({ children, views, }: {
+    children?: React.ReactNode;
+    views?: Views;
+}): React.JSX.Element;
+export declare function useViews(): DefaultViews;

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

@@ -0,0 +1,19 @@
+import { ActionConfigs } from '../actions';
+import { ActionViewState } from './LocationActionView';
+declare const DEFAULT_USE_VIEWS: {
+    readonly CopyView: (options?: import("./LocationActionView/CopyView").UseCopyViewOptions | undefined) => import("./LocationActionView").CopyViewState;
+    readonly CreateFolderView: (options?: import("./LocationActionView/CreateFolderView").UseCreateFolderViewOptions | undefined) => import("./LocationActionView").CreateFolderViewState;
+    readonly DeleteView: (options?: import("./LocationActionView/DeleteView").UseDeleteViewOptions | undefined) => import("./LocationActionView").DeleteViewState;
+    readonly LocationDetailView: (options?: import("./LocationDetailView/types").UseLocationDetailViewOptions | undefined) => import("./LocationDetailView/types").LocationDetailViewState;
+    readonly LocationsView: (options?: import("./LocationsView/types").UseLocationsViewOptions | undefined) => import("./LocationsView/types").LocationsViewState;
+    readonly UploadView: (options?: import("./LocationActionView/UploadView").UseUploadViewOptions | undefined) => import("./LocationActionView").UploadViewState;
+};
+type DefaultUseViews = typeof DEFAULT_USE_VIEWS;
+export type ViewKey<T extends ActionConfigs> = T extends Record<string, {
+    componentName: `${infer U}View`;
+}> ? U : never;
+type UseViewState<T extends string> = `${T}View` extends keyof DefaultUseViews ? ReturnType<DefaultUseViews[`${T}View`]> : ActionViewState;
+type UseView<T extends ActionConfigs = ActionConfigs> = <K extends ViewKey<T>>(type: K) => UseViewState<K>;
+type CreateUseView = <T extends ActionConfigs>(configs: T) => UseView<T>;
+export declare const createUseView: CreateUseView;
+export {};

package/dist/types/components/StorageBrowser/views/hooks/usePaginate.d.ts

@@ -0,0 +1,15 @@
+interface UsePaginate<T> {
+    currentPage: number;
+    highestPageVisited: number;
+    onPaginate: (page: number) => void;
+    handleReset: () => void;
+    pageItems: T[];
+}
+interface UsePaginateProps<T> {
+    hasNextToken: boolean;
+    items: T[];
+    paginateCallback?: () => void;
+    pageSize: number;
+}
+export declare const usePaginate: <T>({ hasNextToken, items, paginateCallback, pageSize, }: UsePaginateProps<T>) => UsePaginate<T>;
+export {};

package/dist/types/components/StorageBrowser/views/hooks/useSearch.d.ts

@@ -0,0 +1,13 @@
+interface UseSearchResult {
+    searchQuery: string;
+    isSearchingSubfolders: boolean;
+    onSearchQueryChange: (query: string) => void;
+    onSearchSubmit: () => void;
+    onToggleSearchSubfolders: () => void;
+    resetSearch: () => void;
+}
+interface UseSearchProps {
+    onSearch?: (query: string, includeSubfolders?: boolean) => void;
+}
+export declare function useSearch(props: UseSearchProps): UseSearchResult;
+export {};

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

@@ -0,0 +1,4 @@
+export { CopyView, CopyViewType, CreateFolderView, CreateFolderViewType, DeleteView, DeleteViewType, LocationActionView, LocationActionViewProps, UploadView, UploadViewType, } from './LocationActionView';
+export { LocationDetailView, LocationDetailViewProps, LocationDetailViewType, } from './LocationDetailView';
+export { LocationsView, LocationsViewProps, LocationsViewType, } from './LocationsView';
+export * from './context';

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

@@ -0,0 +1,12 @@
+import { LocationData } from '../actions';
+export interface ActionViewProps {
+    className?: string;
+}
+export interface ListViewState<T = any> {
+    onNavigate: (location: LocationData, path?: string) => void;
+    onPaginate: (page: number) => void;
+    page: number;
+    pageItems: T[];
+}
+export interface ListViewProps extends ActionViewProps, Partial<ListViewState> {
+}

package/dist/types/index.d.ts

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

package/dist/types/styles/storage-browser-styles.d.ts

@@ -0,0 +1 @@
+import './storage-browser.css';

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "3.3.9";
+export declare const VERSION = "3.4.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-storage",
-  "version": "3.3.9",
+  "version": "3.4.0",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -9,10 +9,17 @@
       "import": "./dist/esm/index.mjs",
       "require": "./dist/index.js"
     },
-    "./styles.css": "./dist/styles.css"
+    "./browser": {
+      "main": "./dist/browser.js",
+      "types": "./dist/types/components/StorageBrowser/index.d.ts",
+      "import": "./dist/esm/browser.mjs"
+    },
+    "./styles.css": "./dist/styles.css",
+    "./storage-browser-styles.css": "./dist/storage-browser-styles.css"
   },
   "browser": {
-    "./styles.css": "./dist/styles.css"
+    "./styles.css": "./dist/styles.css",
+    "./storage-browser-styles.css": "./dist/storage-browser-styles.css"
   },
   "types": "dist/types/index.d.ts",
   "license": "Apache-2.0",
@@ -23,7 +30,8 @@
   },
   "files": [
     "dist",
-    "LICENSE"
+    "LICENSE",
+    "browser"
   ],
   "scripts": {
     "build": "yarn build:rollup",
@@ -39,26 +47,39 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@aws-amplify/ui": "6.6.5",
-    "@aws-amplify/ui-react": "6.5.5",
-    "@aws-amplify/ui-react-core": "3.0.29",
-    "lodash": "4.17.21",
+    "@aws-amplify/ui": "6.7.0",
+    "@aws-amplify/ui-react": "6.7.0",
+    "@aws-amplify/ui-react-core": "3.1.0",
     "tslib": "^2.5.2"
   },
   "peerDependencies": {
-    "aws-amplify": "^6.6.5",
+    "aws-amplify": "^6.9.0",
     "react": "^16.14.0 || ^17.0 || ^18.0",
     "react-dom": "^16.14.0 || ^17.0 || ^18.0"
   },
+  "devDependencies": {
+    "jest-tsd": "^0.2.2",
+    "@tsd/typescript": "^5.1.6",
+    "@types/node": "^18.19.50"
+  },
   "sideEffects": [
     "dist/**/*.css"
   ],
   "size-limit": [
+    {
+      "name": "createStorageBrowser",
+      "path": "dist/esm/browser.mjs",
+      "import": "{ createStorageBrowser }",
+      "limit": "60 kB",
+      "ignore": [
+        "@aws-amplify/storage"
+      ]
+    },
     {
       "name": "FileUploader",
       "path": "dist/esm/index.mjs",
       "import": "{ FileUploader }",
-      "limit": "21.5 kB"
+      "limit": "22 kB"
     },
     {
       "name": "StorageImage",
@@ -70,7 +91,7 @@
       "name": "StorageManager",
       "path": "dist/esm/index.mjs",
       "import": "{ StorageManager }",
-      "limit": "21.5 kB"
+      "limit": "22 kB"
     }
   ]
 }