@aws-amplify/ui-react-storage 3.17.2 → 3.18.0

package/dist/types/components/StorageBrowser/views/LocationActionView/DownloadView/utils.d.ts

@@ -0,0 +1,99 @@
+import type { ActionInputConfig, DownloadHandlerData, LocationItemData } from '../../../actions';
+/**
+ * Hard cap on the combined number of files a single download may contain,
+ * counted across every folder (and loose file) in the selection. Folder
+ * expansion stops paginating as soon as the running total would exceed this
+ * value and throws {@link FileLimitError}; the view then surfaces a blocked
+ * state instead of downloading a truncated set (silent truncation would be
+ * data loss). Mirrors the 5000 threshold DeleteView uses for its file count.
+ */
+export declare const LARGE_DOWNLOAD_FILE_COUNT = 5000;
+/**
+ * Thrown by {@link expandFolderToFiles} when the combined expanded file count
+ * of the selection exceeds {@link LARGE_DOWNLOAD_FILE_COUNT}. Callers use it
+ * to distinguish the over-limit state from enumeration failures.
+ */
+export declare class FileLimitError extends Error {
+    constructor();
+}
+/**
+ * Mutable running total of files expanded so far across the ENTIRE selection.
+ * A single instance is shared by every `expandFolderToFiles` call in one
+ * enumeration run so the {@link LARGE_DOWNLOAD_FILE_COUNT} cap applies to the
+ * combined selection, not per folder.
+ */
+export interface FileCounter {
+    count: number;
+}
+/**
+ * Computes the base name for a multi-file zip archive from the flat list of
+ * file keys being zipped. Used for file-only, multi-item, and mixed
+ * selections; a selection of exactly one folder is named after that folder
+ * instead (see {@link resolveArchiveName}).
+ *
+ * Rule: the name is the last path segment of the LONGEST COMMON ANCESTOR
+ * DIRECTORY of all files. For each key the directory segments are
+ * `key.split('/')` without the final basename; the longest common prefix of
+ * those segment arrays is taken, and its last element is the name. When the
+ * common prefix is empty (root-level files or files with no shared ancestor)
+ * this falls back to `'download'`.
+ *
+ * Examples:
+ * - ['public/nested/one/pic.jpg', 'public/nested/two/pic.jpg'] -> 'nested'
+ * - ['public/nested/a.jpg', 'public/images/b.jpg', 'public/c.jpg'] -> 'public'
+ * - ['photos/a.jpg', 'photos/b.jpg'] -> 'photos'
+ * - ['a.jpg', 'b.jpg'] -> 'download'
+ * - ['public/x.jpg', 'other/y.jpg'] -> 'download'
+ * - [] -> 'download'
+ *
+ * Pure/synchronous; the base name only — the handler appends `.zip`.
+ */
+export declare const getArchiveName: (fileKeys: string[]) => string;
+/**
+ * Resolves the zip archive base name for the current SELECTION.
+ *
+ * When the selection consists of exactly ONE FOLDER (no other items), the
+ * archive is named after that folder (basename of `folder.key`, trailing
+ * slash stripped): the download was initiated from that folder, so selecting
+ * `photos/` yields `photos.zip` even when every file lives in a deeper
+ * subfolder like `photos/vacation/`. Every other selection shape (file-only,
+ * multi-folder, mixed) falls back to the longest-common-ancestor rule of
+ * {@link getArchiveName}.
+ */
+export declare const resolveArchiveName: (dataItems: LocationItemData[], fileKeys: string[]) => string;
+export interface ExpandFolderToFilesOptions {
+    /** S3 key of the folder to expand (ends in `'/'`). */
+    folderKey: string;
+    /** Storage action config. */
+    config: ActionInputConfig;
+    /**
+     * Current browse-location prefix `P`; each file's `relativePath` is
+     * computed as `key.slice(P.length)`.
+     */
+    locationPrefix: string;
+    /**
+     * Optional abort signal; when aborted between pages the loop throws an
+     * `AbortError` and no items are returned.
+     */
+    signal?: AbortSignal;
+    /**
+     * Shared running total of files expanded so far across the selection (see
+     * {@link FileCounter}). Callers expanding multiple folders MUST pass the
+     * same instance to every call so the cap applies to the combined selection.
+     * Defaults to a fresh counter (single-folder cap still enforced).
+     */
+    fileCounter?: FileCounter;
+}
+/**
+ * Recursively expands a folder into the flat list of downloadable files it
+ * contains, preserving each file's folder-relative zip path.
+ *
+ * Clones the pagination loop from DeleteView's `countFilesInFolder`, but:
+ * - collects {@link DownloadHandlerData} items instead of counting,
+ * - stops paginating and throws {@link FileLimitError} once the shared
+ *   `fileCounter` would exceed {@link LARGE_DOWNLOAD_FILE_COUNT} (the caller
+ *   surfaces a blocked state; a truncated zip is never produced),
+ * - filters out directory markers (keys ending in `'/'`),
+ * - is cancellable via `signal`, checked between `list()` pages.
+ */
+export declare const expandFolderToFiles: ({ folderKey, config, locationPrefix, signal, fileCounter, }: ExpandFolderToFilesOptions) => Promise<DownloadHandlerData[]>;

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

@@ -4,7 +4,7 @@ export type { CreateFolderViewProps, CreateFolderViewType, CreateFolderViewState
 export { CreateFolderView, useCreateFolderView } from './CreateFolderView';
 export type { DeleteViewProps, DeleteViewType, DeleteViewState, } from './DeleteView';
 export { DeleteView, useDeleteView } from './DeleteView';
-export type { DownloadViewProps, DownloadViewType, DownloadViewState, } from './DownloadView';
+export type { DownloadEnumerationStatus, DownloadViewProps, DownloadViewType, DownloadViewState, } from './DownloadView';
 export { DownloadView, useDownloadView } from './DownloadView';
 export { LocationActionView } from './LocationActionView';
 export type { UploadViewProps, UploadViewType, UploadViewState, } from './UploadView';

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "3.17.2";
+export declare const VERSION = "3.18.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-storage",
-  "version": "3.17.2",
+  "version": "3.18.0",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -20,6 +20,9 @@
     "./styles.css": "./dist/styles.css"
   },
   "types": "dist/types/index.d.ts",
+  "bin": {
+    "copy-serviceworker": "./bin/copy-serviceworker.js"
+  },
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -28,6 +31,7 @@
   },
   "files": [
     "dist",
+    "bin",
     "LICENSE",
     "browser"
   ],
@@ -43,17 +47,17 @@
     "size": "yarn size-limit",
     "test": "jest",
     "test:watch": "yarn test --watch",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit && tsc --project tsconfig.sw.json --noEmit"
   },
   "dependencies": {
-    "@aws-amplify/ui": "6.15.3",
-    "@aws-amplify/ui-react": "6.15.3",
-    "@aws-amplify/ui-react-core": "3.6.3",
+    "@aws-amplify/ui": "6.15.5",
+    "@aws-amplify/ui-react": "6.15.5",
+    "@aws-amplify/ui-react-core": "3.6.5",
     "tslib": "^2.5.2",
     "@zip.js/zip.js": "^2.7.53"
   },
   "peerDependencies": {
-    "aws-amplify": "^6.16.0",
+    "aws-amplify": "^6.17.0",
     "react": "^16.14 || ^17 || ^18 || ^19",
     "react-dom": "^16.14 || ^17 || ^18 || ^19"
   },
@@ -69,7 +73,7 @@
       "name": "createStorageBrowser",
       "path": "dist/esm/browser.mjs",
       "import": "{ createStorageBrowser }",
-      "limit": "130 kB",
+      "limit": "133 kB",
       "ignore": [
         "@aws-amplify/storage"
       ]
@@ -78,7 +82,7 @@
       "name": "StorageBrowser",
       "path": "dist/esm/index.mjs",
       "import": "{ StorageBrowser }",
-      "limit": "154 kB"
+      "limit": "157 kB"
     },
     {
       "name": "FileUploader",