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

package/dist/types/components/StorageBrowser/{StorageBrowserDefault.d.ts → createStorageBrowser/StorageBrowserDefault.d.ts}

@@ -5,4 +5,4 @@ import React from 'react';
  * - render `LocationDetailView` on location selection
  * - render `ActionView` on action selection
  */
-export declare function StorageBrowserDefault(): React.JSX.Element;
+export default function StorageBrowserDefault(): React.JSX.Element;

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

@@ -0,0 +1,3 @@
+import React from 'react';
+import { CreateStorageBrowserInput, StorageBrowserProviderProps } from './types';
+export default function createProvider({ actions, components, config, }: CreateStorageBrowserInput): (props: StorageBrowserProviderProps) => React.JSX.Element;

package/dist/types/components/StorageBrowser/{createStorageBrowser.d.ts → createStorageBrowser/createStorageBrowser.d.ts}

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

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

@@ -0,0 +1,2 @@
+export { default as createStorageBrowser } from './createStorageBrowser';
+export { CreateStorageBrowserInput, CreateStorageBrowserOutput, DerivedActionViews, DerivedActionViewType, StorageBrowserActions, StorageBrowserConfig, StorageBrowserProps, StorageBrowserProviderProps, StorageBrowserType, } from './types';

package/dist/types/components/StorageBrowser/{types.d.ts → createStorageBrowser/types.d.ts}

@@ -1,39 +1,37 @@
 import React from 'react';
-import { CustomActionConfigs, DefaultActionConfigs, ExtendedActionConfigs, ListLocations, LocationData } from './actions';
-import { GetLocationCredentials } from './credentials/types';
-import { ErrorBoundaryType } from './ErrorBoundary';
-import { StorageBrowserComponents } from './ComponentsProvider';
-import { RegisterAuthListener, StoreProviderProps } from './providers';
-import { CopyViewType, CreateFolderViewType, DeleteViewType, UploadViewType, LocationActionViewType, LocationDetailViewType, LocationsViewType, UseView, StorageBrowserViews } from './views';
-import { StorageBrowserDisplayText } from './displayText';
-import { DerivedActionHandlers, UseAction } from './useAction';
+import { CustomActionConfigs, DefaultActionConfigs, ExtendedActionConfigs, ListLocations, LocationData } from '../actions';
+import { StorageBrowserComponents } from '../components';
+import { GetLocationCredentials, RegisterAuthListener } from '../credentials';
+import { StorageBrowserDisplayText } from '../displayText';
+import { ErrorBoundaryType } from '../ErrorBoundary';
+import { StorageBrowserEventValue, StorageBrowserValue, StoreProviderProps } from '../store';
+import { DerivedActionHandlers, UseAction } from '../useAction';
+import { CopyViewType, CreateFolderViewType, DeleteViewType, UploadViewType, LocationActionViewType, LocationDetailViewType, LocationsViewType, UseView, StorageBrowserViews } from '../views';
 /**
- * Configuration properties
+ * @description configuration properties
  */
 export interface StorageBrowserConfig {
     /**
-     * AWS account Id
+     * @description AWS account Id
      */
     accountId?: string;
     /**
-     * Custom S3 endpoint used in action handler calls
+     * @description custom S3 endpoint used in action handler calls
      */
     customEndpoint?: string;
     /**
-     * Location credentials retrieval handler
+     * @description location credentials retrieval handler
      */
     getLocationCredentials: GetLocationCredentials;
     /**
+     * @description locations list handler
      * @required
-     *
-     * Locations list handler
      */
     listLocations: ListLocations;
     /**
-     * @required
      *
-     * Provided handler receives an `onStateChange` callback to be called from
-     * the consumer on auth status changes to clear in-memory credentials
+     * @description provided handler receives an `onStateChange` callback to be called from the consumer on auth status changes to clear in-memory credentials
+     * @required
      *
      * @example
      * ```tsx
@@ -63,7 +61,7 @@ export interface StorageBrowserConfig {
      *   createManagedAuthAdapter
      * } from '@aws-amplify/ui-react-storage/browser';
      *
-     * import { myAuth } from './auth.ts';
+     * import { myAuth } from '../auth.ts';
      *
      * const managedAuthAdapter = createManagedAuthAdapter({
      *   accountId: myAuth.accountId,
@@ -79,9 +77,8 @@ export interface StorageBrowserConfig {
      */
     registerAuthListener: RegisterAuthListener;
     /**
+     * @description AWS account region
      * @required
-     *
-     * AWS account region
      */
     region: string;
 }
@@ -90,24 +87,24 @@ export interface StorageBrowserActions {
     custom?: CustomActionConfigs;
 }
 /**
- * Configuration and options for `createStorageBrowser`
+ * @description configuration and options for `createStorageBrowser`
  */
 export interface CreateStorageBrowserInput {
     /**
-     * Override and default `StorageBrowser` actions and action view configs
+     * @description override and default `StorageBrowser` actions and action view configs
      */
     actions?: StorageBrowserActions;
     /**
-     * `StorageBrowser` configuration properties
+     * @description `StorageBrowser` configuration properties
+     * @required
      */
     config: StorageBrowserConfig;
     /**
-     * Custom ErrorBoundary class. If omitted, a default ErrorBoundary is provided.
-     * To disable ErrorBoundary, set to `null`.
+     * @description custom ErrorBoundary class. If omitted, a default ErrorBoundary is provided. To disable ErrorBoundary, set to `null`.
      */
     ErrorBoundary?: ErrorBoundaryType | null;
     /**
-     * Overrides default `components` used within `StorageBrowser`
+     * @description Overrides default `components` used within `StorageBrowser`
      */
     components?: StorageBrowserComponents;
 }
@@ -116,9 +113,19 @@ export interface CreateStorageBrowserInput {
  */
 export interface StorageBrowserProps<K = string, V = {}> {
     /**
-     * Overrides default display string values. Supports resolving of static and dynamic text
-     * values and error messages
-     *
+     * @description provide to initialize the `StorageBrowser` with a default location, `actionType` or pagination values as an uncontrolled component
+     */
+    defaultValue?: StorageBrowserValue | null;
+    /**
+     * @description called on location and action change events. Provide with `value` prop for controlled component behavior or as a standalone prop
+     */
+    onValueChange?: (value: StorageBrowserEventValue) => void;
+    /**
+     * @description provide with `onValueChange` to use the `StorageBrowser` as a controlled component
+     */
+    value?: StorageBrowserValue | null;
+    /**
+     * @description Overrides default display string values. Supports resolving of static and dynamic text values and error messages
      * @example
      * ```tsx
      * const myDisplayText = {
@@ -139,35 +146,42 @@ export interface StorageBrowserProps<K = string, V = {}> {
      */
     displayText?: StorageBrowserDisplayText;
     /**
-     * Accepts default top level `views` overrides and custom `views` defined by the `actions`
-     * parameter of `createStorageBrowser`
+     * @description accepts default top level `views` overrides and custom `views` defined by the `actions` parameter of `createStorageBrowser`
      */
     views?: StorageBrowserViews<K, V>;
 }
 /**
- * `StorageBrowser.Provider` component properties
+ * @description `StorageBrowser.Provider` component properties
  */
-export interface StorageBrowserProviderProps<V = {}> extends StoreProviderProps, Pick<StorageBrowserProps, 'displayText'> {
+export interface StorageBrowserProviderProps<V = {}> extends StoreProviderProps, Pick<StorageBrowserProps, 'defaultValue' | 'displayText' | 'onValueChange' | 'value'> {
     /**
-     * Accepts custom action views rendered by `LocationActionView`
+     * @description accepts custom action views rendered by `LocationActionView`
      */
     views?: V;
     /**
-     * Sets initial `location` data. Provide to initialize the `StorageBrowser` with an initial
-     * `location`
+     * @deprecated will be removed in a future major verison. Prefer `value` for controlled behavior or `defaultValue` for initializng `actionType`
+     * @description initial `actionType`, does not update
+     */
+    actionType?: string;
+    /**
+     * @deprecated will be removed in a future major verison. Prefer `value` for controlled behavior or `defaultValue` for initializng `actionType`
+     * @description initial `location` data, does not update
      */
     location?: LocationData;
+    /**
+     * @deprecated will be removed in a future major verison. Prefer `value` for controlled behavior or `defaultValue` for initializng `actionType`
+     * @description initial `location` subpath to establish navigation state, does not update
+     */
+    path?: string;
 }
 /**
- * `StorageBrowser` component, provider and view components
+ * @description `StorageBrowser` component, provider and view components
  */
 export interface StorageBrowserType<K = string, V = {}> {
     (props: StorageBrowserProps<K, V>): React.JSX.Element;
     displayName: string;
     /**
-     * `StorageBrowser` React.Context provider. Composed `StorageBrowser` components
-     * must be a descendant of a `Provider` element
-     *
+     * @description `StorageBrowser` React.Context provider. Composed `StorageBrowser` components must be a descendant of a `Provider` element
      * @example
      * ```tsx
      * <StorageBrowser.Provider>
@@ -177,9 +191,7 @@ export interface StorageBrowserType<K = string, V = {}> {
      */
     Provider: (props: StorageBrowserProviderProps<V>) => React.JSX.Element;
     /**
-     * Utility view aggregating all action views. Can be used to render a standalone
-     * action view
-     *
+     * @description utility view aggregating all action views. Can be used to render a standalone action view
      * @example
      * ```tsx
      * <StorageBrowser.LocationActionView type="copy" />
@@ -187,16 +199,15 @@ export interface StorageBrowserType<K = string, V = {}> {
      */
     LocationActionView: LocationActionViewType<K>;
     /**
-     * Displays data related to the selected or provided `location` and action
-     * selection
+     * @description displays data related to the selected or provided `location` and action selection
      */
     LocationDetailView: LocationDetailViewType;
     /**
-     * Entry point view displaying `locations` returned from `listLocations`
+     * @description entry point view displaying `locations` returned from `listLocations`
      */
     LocationsView: LocationsViewType;
     /**
-     * Standalone composable default action view components
+     * @description standalone composable default action view components
      */
     CopyView: CopyViewType;
     CreateFolderView: CreateFolderViewType;
@@ -205,9 +216,9 @@ export interface StorageBrowserType<K = string, V = {}> {
 }
 type DefaultActionType<T = string> = Exclude<T, keyof DefaultActionConfigs>;
 /**
- * @internal @unstable interface subject to change, not recommended for public use
- *
- * Utility type resolving available custom action view component slots
+ * @internal
+ * @unstable interface subject to change, not recommended for public use
+ * @description utility type resolving available custom action view component slots
  */
 export type DerivedActionViews<T extends StorageBrowserActions> = {
     [K in keyof T['custom'] as K extends DefaultActionType<K> ? T['custom'][K] extends {
@@ -216,14 +227,12 @@ export type DerivedActionViews<T extends StorageBrowserActions> = {
 };
 /**
  * @internal @unstable interface subject to change, not recommended for public use
- *
- * Utility type of excluded action keys that do not have a corresponding action view
+ * @description utility type of excluded action keys that do not have a corresponding action view
  */
 type DefaultActionWithoutViewType = 'download';
 /**
  * @internal @unstable interface subject to change, not recommended for public use
- *
- * Utility type resolving available location action view types
+ * @description utility type resolving available location action view types
  */
 export type DerivedActionViewType<T extends StorageBrowserActions> = keyof {
     [K in keyof T['custom'] as K extends DefaultActionType<K> ? T['custom'][K] extends {
@@ -231,19 +240,19 @@ export type DerivedActionViewType<T extends StorageBrowserActions> = keyof {
     } ? K : never : never]?: any;
 } | Exclude<keyof DefaultActionConfigs, DefaultActionWithoutViewType>;
 /**
- * Return values of `createStorageBrowser`
+ * @description return values of `createStorageBrowser`
  */
 export interface CreateStorageBrowserOutput<C extends ExtendedActionConfigs = ExtendedActionConfigs> {
     /**
-     * `StorageBrowser` component and subcomponents
+     * @description `StorageBrowser` component and subcomponents
      */
     StorageBrowser: StorageBrowserType<DerivedActionViewType<C>, DerivedActionViews<C>>;
     /**
-     * Action handler utility hook
+     * @description action handler utility hook
      */
     useAction: UseAction<DerivedActionHandlers<C>>;
     /**
-     * View state utility hook
+     * @description view state utility hook
      */
     useView: UseView;
 }

package/dist/types/components/StorageBrowser/credentials/{store → credentialsStore}/create.d.ts

@@ -1,2 +1,2 @@
-import { CreateLocationCredentialsStoreInput, LocationCredentialsStore } from '../types';
+import { CreateLocationCredentialsStoreInput, LocationCredentialsStore } from './types';
 export declare const createLocationCredentialsStore: (input: CreateLocationCredentialsStoreInput) => LocationCredentialsStore;

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

@@ -0,0 +1,2 @@
+export { createLocationCredentialsStore } from './create';
+export { GetLocationCredentials, GetLocationCredentialsInput, CredentialsLocation, CreateLocationCredentialsStoreInput, LocationCredentialsStore, } from './types';

package/dist/types/components/StorageBrowser/credentials/{store → credentialsStore}/registry.d.ts

@@ -1,5 +1,5 @@
 import { AWSTemporaryCredentials } from '../../storage-internal';
-import { GetLocationCredentials, CredentialsLocation } from '../types';
+import { GetLocationCredentials, CredentialsLocation } from './types';
 interface StoreRegistrySymbol {
     readonly value: symbol;
 }

package/dist/types/components/StorageBrowser/credentials/credentialsStore/store.d.ts

@@ -0,0 +1,15 @@
+import { AWSTemporaryCredentials } from '../../storage-internal';
+import { CredentialsLocation, GetLocationCredentials, LruLocationCredentialsStore } from './types';
+/**
+ * @internal
+ */
+export declare const initStore: (refreshHandler: GetLocationCredentials, size?: number) => LruLocationCredentialsStore;
+export declare const getCacheValue: (store: LruLocationCredentialsStore, location: CredentialsLocation) => AWSTemporaryCredentials | null;
+/**
+ * Fetch new credentials value with refresh handler and cache the result in
+ * LRU cache.
+ * @internal
+ */
+export declare const fetchNewValue: (store: LruLocationCredentialsStore, location: CredentialsLocation) => Promise<{
+    credentials: AWSTemporaryCredentials;
+}>;

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

@@ -0,0 +1,44 @@
+import { LocationPermissions } from '../../actions';
+import { AWSTemporaryCredentials, LocationCredentialsProvider, LocationCredentials } from '../../storage-internal';
+export interface CredentialsLocation {
+    scope: string;
+    permissions: LocationPermissions;
+}
+export interface CreateLocationCredentialsStoreInput {
+    handler: GetLocationCredentials;
+}
+export interface LocationCredentialsStore {
+    /**
+     * Get location-specific credentials. It uses a cache internally to optimize performance when
+     * getting credentials for the same location. It will refresh credentials if they expire or
+     * when forced to.
+     */
+    getProvider(option: CredentialsLocation): LocationCredentialsProvider;
+    /**
+     * Invalidate cached credentials and force subsequent calls to get location-specific
+     * credentials to throw. It also makes subsequent calls to `getCredentialsProviderForLocation`
+     * to throw.
+     */
+    destroy(): void;
+}
+export type GetLocationCredentialsInput = CredentialsLocation;
+export type GetLocationCredentialsOutput = LocationCredentials;
+export type GetLocationCredentials = (input: GetLocationCredentialsInput) => Promise<GetLocationCredentialsOutput>;
+export interface CredentialsStoreValue extends CredentialsLocation {
+    credentials?: AWSTemporaryCredentials;
+    inflightCredentials?: Promise<{
+        credentials: AWSTemporaryCredentials;
+    }>;
+}
+export type CacheKey = `${string}_${string}`;
+/**
+ * LRU implementation for Location Credentials Store
+ * O(n) for get and set for simplicity.
+ *
+ * @internal
+ */
+export interface LruLocationCredentialsStore {
+    capacity: number;
+    refreshHandler: GetLocationCredentials;
+    values: Map<CacheKey, CredentialsStoreValue>;
+}

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

@@ -0,0 +1,3 @@
+export { CredentialsProvider, useCredentials } from './context';
+export { createLocationCredentialsStore, GetLocationCredentials, GetLocationCredentialsInput, CredentialsLocation, CreateLocationCredentialsStoreInput, LocationCredentialsStore, } from './credentialsStore';
+export { CredentialsProviderProps, GetCredentials, RegisterAuthListener, } from './types';

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

@@ -1,26 +1,20 @@
+import React from 'react';
 import { LocationPermissions } from '../actions';
-import { LocationCredentialsProvider, LocationCredentials } from '../storage-internal';
-export interface CredentialsLocation {
+import { LocationCredentialsProvider } from '../storage-internal';
+import { CreateLocationCredentialsStoreInput, GetLocationCredentials, LocationCredentialsStore } from './credentialsStore';
+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 CreateLocationCredentialsStoreInput {
-    handler: GetLocationCredentials;
+export interface CreateCredentialsStoreInput extends CreateLocationCredentialsStoreInput {
 }
-export interface LocationCredentialsStore {
-    /**
-     * Get location-specific credentials. It uses a cache internally to optimize performance when
-     * getting credentials for the same location. It will refresh credentials if they expire or
-     * when forced to.
-     */
-    getProvider(option: CredentialsLocation): LocationCredentialsProvider;
-    /**
-     * Invalidate cached credentials and force subsequent calls to get location-specific
-     * credentials to throw. It also makes subsequent calls to `getCredentialsProviderForLocation`
-     * to throw.
-     */
-    destroy(): void;
+export interface CredentialsProviderProps {
+    children?: React.ReactNode;
+    getLocationCredentials: GetLocationCredentials;
+    onDestroy?: () => void;
+    registerAuthListener: RegisterAuthListener;
 }
-export type GetLocationCredentialsInput = CredentialsLocation;
-export type GetLocationCredentialsOutput = LocationCredentials;
-export type GetLocationCredentials = (input: GetLocationCredentialsInput) => Promise<GetLocationCredentialsOutput>;

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

@@ -1,5 +1,5 @@
+import { GetLocationCredentials } from './credentialsStore';
 import { CredentialsStore, RegisterAuthListener } from './types';
-import { GetLocationCredentials } from '../../../credentials/types';
 export declare function useCredentialsStore({ getLocationCredentials: handler, initialValue, onDestroy, registerAuthListener, }: {
     getLocationCredentials: GetLocationCredentials;
     initialValue?: CredentialsStore;

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

@@ -1,8 +1,8 @@
 import { StatusCounts, Task } from '../tasks';
 import { CopyHandlerData, CreateFolderHandlerData, DeleteHandlerData, FolderData, LocationData, LocationItemData, TaskData, UploadHandlerData, LocationPermissions } from '../actions';
-import { LocationState } from '../providers/store/location';
-import { MessageType } from '../composables/Message';
-import { FileItems } from '../providers';
+import { MessageType } from '../components';
+import { FileItems } from '../files';
+import { LocationState } from '../store';
 /**
  * Common list view display text values
  */

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

@@ -1,4 +1,4 @@
-import { FileItem, LocationItemType } from '../../../actions';
+import { FileItem, LocationItemType } from '../actions';
 /**
  * native OS file picker type. to restrict selectable file types, define the picker types
  * followed by accepted file types as strings

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

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

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { FileData, FileDataItem } from '../../../actions';
+import { FileData, FileDataItem } from '../actions';
 export declare const DEFAULT_STATE: LocationItemsState;
 export type LocationItemsAction = {
     type: 'SET_LOCATION_ITEMS';

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

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

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

@@ -0,0 +1,6 @@
+import React from 'react';
+import { StoreProviderProps, StoreContextType } from './types';
+export declare const StoreContext: React.Context<StoreContextType>, useStore: (params?: {
+    errorMessage?: string | undefined;
+} | undefined) => StoreContextType;
+export declare function StoreProvider({ children, ...props }: StoreProviderProps): React.JSX.Element;

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

@@ -0,0 +1,2 @@
+export { StoreProvider, useStore } from './context';
+export { LocationEventValue, LocationState, LocationValue, StorageBrowserEventValue, StorageBrowserValue, StoreProviderProps, StoreState, } from './types';

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

@@ -0,0 +1,2 @@
+import { StoreActionType, StoreState } from './types';
+export default function storeReducer(state: StoreState, action: StoreActionType): StoreState;

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

@@ -0,0 +1,108 @@
+import React from 'react';
+import { LocationData, LocationType } from '../actions';
+/**
+ * @see {@link LocationData}
+ */
+export interface LocationValue extends Pick<LocationData, 'bucket' | 'permissions' | 'prefix'> {
+    /**
+     * @see {@link LocationData.id} defaults to auto-generated uuid
+     */
+    id?: LocationData['id'];
+    /**
+     * @description string following `location.prefix` in forming an object key. defaults to empty string
+     * @example
+     * ```ts
+     * const path = "my-path/my-nested-path/";
+     *
+     * const prefix = "my-prefix/";
+     * const bucket = "my-bucket";
+     *
+     * // "my-bucket/my-prefix/my-path/my-nested-path/"
+     * const key = `${bucket}/${prefix}${path}`
+     *```
+     */
+    path?: string;
+    /**
+     * @see {@link LocationType}
+     */
+    type?: LocationType;
+}
+export interface StorageBrowserValue {
+    actionType?: string;
+    location?: LocationValue;
+}
+export interface LocationEventValue extends Required<LocationValue> {
+}
+export interface StorageBrowserEventValue {
+    actionType: string | undefined;
+    location: LocationEventValue | undefined;
+}
+export interface StoreProviderProps {
+    children?: React.ReactNode;
+    defaultValue?: StorageBrowserValue | null;
+    value?: StorageBrowserValue | null;
+    onValueChange?: (event: StorageBrowserEventValue) => void;
+    /**
+     * @deprecated
+     */
+    actionType?: string;
+    /**
+     * @deprecated
+     */
+    location?: LocationData;
+    /**
+     * @deprecated
+     */
+    path?: string;
+}
+export type StoreActionType = {
+    type: 'CHANGE_ACTION_TYPE';
+    actionType: string;
+} | {
+    type: 'RESET_ACTION_TYPE';
+} | {
+    type: 'CHANGE_LOCATION';
+    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 interface StoreState {
+    actionType: string | undefined;
+    location: LocationState;
+}
+export type StoreContextType = [StoreState, React.Dispatch<StoreActionType>];

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

@@ -0,0 +1,2 @@
+import { StoreProviderProps, StoreContextType } from './types';
+export default function useStoreReducer(props: StoreProviderProps): StoreContextType;

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

@@ -0,0 +1,6 @@
+import { LocationData } from '../actions';
+import { LocationValue, StorageBrowserValue, StoreProviderProps, StoreState } from './types';
+export declare const parseLocationType: ({ prefix, }: LocationData | LocationValue) => LocationData['type'];
+export declare function getLocationData(location?: LocationData | LocationValue): LocationData | undefined;
+export declare function getState(value: StorageBrowserValue | null | undefined): StoreState;
+export declare function getInitialState(defaultValue: StorageBrowserValue | null | undefined, legacyProps?: Pick<StoreProviderProps, 'actionType' | 'location' | 'path'>): StoreState;

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

@@ -0,0 +1,9 @@
+import { StoreProviderProps } from './types';
+export declare const CONLICTING_PROPS = "`StorageBrowser` has been been provided with both `value` and `defaultValue` props. StorageBrowser must be either controlled or uncontrolled (specify either the `value` prop, or the `defaultValue` prop, but not both). Decide between using a controlled or uncontrolled `StorageBrowser` and remove one of these props.";
+export declare const READONLY = "A `value` prop has been provided to `StorageBrowser` without `onValueChange`. This will render a read-only `StorageBrowser`. If the `StorageBrowser` should be mutable use `defaultValue`, otherwise set `onValueChange`.";
+export declare const MISSING_REQUIRED = "A `value` prop has been provided to `StorageBrowser` without all required `location` parameters. `StorageBrowser` will ignore the provided `location`. Missing `location` parameters: %s.";
+export declare const DEPRECATED_SUFFIX = "`actionType`, `location` and `path` props have been deprecated and will be removed in a future major version. Provide the `value` prop for controlled behavior or the `defaultValue` prop for uncontrolled behavior.";
+export declare const DEPRECATED_PROPS = "`StorageBrowser` has been provided with one or more deprecated props: %s. %s";
+export declare const DEPRECATED_PROPS_AND_CONFLICTING = "`StorageBrowser` has been provided with deprecated props of %s that conflict with the `value` and `defaultValue` props. %s";
+export declare const CHANGED_MODE = "`StorageBrowser` has changed from controlled to uncontrolled due to the `value` prop resolving to type `%s`. Switching between controlled and uncontrolled behaviors is not supported and may lead to unexpected behaviors.";
+export default function validateStoreProps(props: StoreProviderProps): void;