@box/uploads-manager 1.13.1

package/dist/types/lib/types.d.ts

@@ -0,0 +1,141 @@
+/**
+ * Status of an individual upload item.
+ *
+ * - `pending` — queued, upload has not started yet
+ * - `uploading` — actively transferring data
+ * - `staged` — commit phase after upload completes (brief, transient)
+ * - `complete` — upload finished successfully
+ * - `error` — upload failed
+ * - `canceled` — user canceled the upload; item remains visible
+ */
+export type UploadItemStatus = 'pending' | 'uploading' | 'staged' | 'complete' | 'error' | 'canceled';
+/**
+ * Aggregate status of all uploads, derived by the parent from the items array.
+ * Drives the header icon, title, subtitle, and action button.
+ */
+export type UploadsStatus = 'idle' | 'uploading' | 'success' | 'error' | 'canceled';
+/**
+ * Represents a single upload item in the uploads manager.
+ *
+ * This is a decoupled, primitive-based type. The consuming app is responsible
+ * for mapping its internal upload objects to this shape.
+ */
+export interface UploadItem {
+    /** Unique identifier for this upload */
+    id: string;
+    /** Display name of the file or folder */
+    name: string;
+    /**
+     * File extension used to determine the file-type icon (e.g. `"pdf"`, `"docx"`).
+     * Empty string for folders.
+     */
+    extension: string;
+    /**
+     * Upload progress percentage (0–100).
+     * Only meaningful when status is `uploading` or `staged`.
+     */
+    progress: number;
+    /** Current status of this upload item */
+    status: UploadItemStatus;
+    /**
+     * Whether this item represents a folder rather than a file.
+     * Folder items display a folder icon and have limited actions.
+     *
+     * @default false
+     */
+    isFolder?: boolean;
+    /**
+     * Human-readable error message to display when `status` is `'error'`.
+     * The consuming app resolves error codes to localized strings before passing them here.
+     */
+    errorMessage?: string;
+    /**
+     * Version label for completed uploads that created a new file version (e.g. `"V2"`).
+     * Displayed as a badge next to the file name.
+     */
+    versionNumber?: string;
+    /**
+     * Whether retry is available for this errored item.
+     * Set to `false` for non-retryable errors (e.g. item-name-in-use conflicts).
+     * Ignored when status is not `'error'`.
+     *
+     * @default true
+     */
+    isRetryable?: boolean;
+}
+export interface UploadsItemActionCallbacks {
+    /**
+     * Cancel a single upload item.
+     * For `pending` items: removes from queue.
+     * For `uploading` items: transitions to `canceled` status.
+     */
+    onItemCancel?: (itemId: string) => void;
+    /**
+     * Retry a single errored or canceled item.
+     * Always labeled "Retry" in the UI — the handler internally determines
+     * whether to resume from the last chunk or restart from scratch.
+     */
+    onItemRetry?: (itemId: string) => void;
+    /** Remove a completed, errored, or canceled item from the list */
+    onItemRemove?: (itemId: string) => void;
+    /**
+     * Open file preview for a completed item.
+     * When not provided, the "Open" action button is not rendered.
+     */
+    onItemOpen?: (itemId: string) => void;
+    /**
+     * Share a completed item via link.
+     * When not provided, the "Share" action button is not rendered.
+     */
+    onItemShare?: (itemId: string) => void;
+}
+/**
+ * Props for the UploadsManager shared feature component (Approach B).
+ *
+ * The component receives an `items` array and derives header state
+ * (overall progress, status text, counts) internally. The consuming app
+ * passes items and action callbacks — no data fetching or external
+ * context dependencies (except `IntlProvider`).
+ */
+export interface UploadsManagerProps extends UploadsItemActionCallbacks {
+    /**
+     * Controlled: whether the panel is expanded (item list visible).
+     * When omitted, the component is uncontrolled and manages its own
+     * expanded state (see `defaultExpanded`).
+     */
+    isExpanded?: boolean;
+    /**
+     * Called when the expand/collapse state changes (both controlled and
+     * uncontrolled modes).
+     *
+     * In controlled mode, the parent is responsible for updating
+     * `isExpanded` in response. In uncontrolled mode, this callback fires
+     * for observation only.
+     */
+    onToggle?: () => void;
+    /**
+     * Uncontrolled initial expanded state.
+     * Ignored when `isExpanded` is provided.
+     *
+     * @default true
+     */
+    defaultExpanded?: boolean;
+    /**
+     * The list of upload items to display.
+     * The component derives overall progress, status, and counts from this array.
+     */
+    items: UploadItem[];
+    /**
+     * Cancel all pending and in-progress uploads.
+     * Completed items are not affected. When provided, a "Cancel All" button
+     * appears in the header during active uploads.
+     */
+    onCancelAll?: () => void;
+    /**
+     * Retry all errored items. Always labeled "Retry All" in the UI
+     * (covers both failed and resumable uploads per PRD-QA decision).
+     * When provided, a "Retry All" button appears in the header when
+     * errors exist and no uploads are active.
+     */
+    onRetryAll?: () => void;
+}

package/dist/types/lib/uploads-header/index.d.ts

@@ -0,0 +1,2 @@
+export * from './uploads-header';
+export { default } from './uploads-header';

package/dist/types/lib/uploads-header/uploads-header.d.ts

@@ -0,0 +1,19 @@
+import { UploadsStatus } from '../types';
+export interface UploadsHeaderProps {
+    status: UploadsStatus;
+    /** Upload progress percentage (0–100). Pre-computed by the parent. */
+    progress: number;
+    totalCount: number;
+    completedCount: number;
+    failedCount: number;
+    /** Included for completeness; not currently used in header rendering. */
+    canceledCount: number;
+    isExpanded: boolean;
+    onToggle: () => void;
+    /** At most one of onCancelAll / onRetryAll is provided at a time. */
+    onCancelAll?: () => void;
+    /** At most one of onCancelAll / onRetryAll is provided at a time. */
+    onRetryAll?: () => void;
+}
+export declare function UploadsHeader({ status, progress, totalCount, completedCount, failedCount, isExpanded, onToggle, onCancelAll, onRetryAll, }: Readonly<UploadsHeaderProps>): import("react/jsx-runtime").JSX.Element;
+export default UploadsHeader;

package/dist/types/lib/uploads-header/uploads-header.messages.d.ts

@@ -0,0 +1,83 @@
+declare const _default: {
+    titleDragAndDrop: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    titleUploading: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    titleComplete: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    titleCanceled: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    titleErrorAllFailed: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    subtitleProgress: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    subtitleErrors: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    cancelAll: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    retryAll: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    toggleExpand: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    toggleCollapse: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    progressAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    statusIconPending: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    statusIconComplete: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    statusIconError: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    statusIconCanceled: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export default _default;

package/dist/types/lib/uploads-item/components/action-buttons.d.ts

@@ -0,0 +1,5 @@
+import { UploadItem, UploadsItemActionCallbacks } from '../../types';
+export interface ActionButtonsProps extends UploadsItemActionCallbacks {
+    item: UploadItem;
+}
+export declare function ActionButtons({ item, onItemCancel, onItemRetry, onItemRemove, onItemOpen, onItemShare }: Readonly<ActionButtonsProps>): import("react/jsx-runtime").JSX.Element | null;

package/dist/types/lib/uploads-item/components/index.d.ts

@@ -0,0 +1,3 @@
+export { ItemRowIcon } from './item-row-icon';
+export { StatusLine } from './status-line';
+export { ActionButtons, type ActionButtonsProps } from './action-buttons';

package/dist/types/lib/uploads-item/components/item-row-icon.d.ts

@@ -0,0 +1,4 @@
+import { UploadItem } from '../../types';
+export declare function ItemRowIcon({ item }: Readonly<{
+    item: UploadItem;
+}>): import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/uploads-item/components/status-line.d.ts

@@ -0,0 +1,4 @@
+import { UploadItem } from '../../types';
+export declare function StatusLine({ item }: Readonly<{
+    item: UploadItem;
+}>): import("react/jsx-runtime").JSX.Element | null;

package/dist/types/lib/uploads-item/index.d.ts

@@ -0,0 +1 @@
+export { UploadsItem, type UploadsItemProps } from './uploads-item';

package/dist/types/lib/uploads-item/uploads-item.d.ts

@@ -0,0 +1,6 @@
+import { UploadItem, UploadsItemActionCallbacks } from '../types';
+export interface UploadsItemProps extends UploadsItemActionCallbacks {
+    item: UploadItem;
+}
+export declare function UploadsItem({ item, onItemCancel, onItemRetry, onItemRemove, onItemOpen, onItemShare }: Readonly<UploadsItemProps>): import("react/jsx-runtime").JSX.Element;
+export default UploadsItem;

package/dist/types/lib/uploads-item/uploads-item.messages.d.ts

@@ -0,0 +1,88 @@
+declare const _default: {
+    itemStatusUploading: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemStatusCompleted: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemStatusCompletedWithVersion: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemStatusVersionSuffix: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemStatusCanceled: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemStatusError: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemProgressAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemActionCancel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemActionCancelAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemActionRetry: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemActionRetryAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemActionRemove: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemActionRemoveAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemActionOpen: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemActionOpenAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemActionShare: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    itemActionShareAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export default _default;

package/dist/types/lib/uploads-item-list/index.d.ts

@@ -0,0 +1 @@
+export { UploadsItemList, type UploadsItemListProps } from './uploads-item-list';

package/dist/types/lib/uploads-item-list/uploads-item-list.d.ts

@@ -0,0 +1,6 @@
+import { UploadItem, UploadsItemActionCallbacks } from '../types';
+export interface UploadsItemListProps extends UploadsItemActionCallbacks {
+    items: UploadItem[];
+}
+export declare function UploadsItemList({ items, onItemCancel, onItemRetry, onItemRemove, onItemOpen, onItemShare, }: Readonly<UploadsItemListProps>): import("react/jsx-runtime").JSX.Element;
+export default UploadsItemList;

package/dist/types/lib/uploads-item-list/uploads-item-list.messages.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    listAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export default _default;

package/dist/types/lib/uploads-manager.d.ts

@@ -0,0 +1,3 @@
+import { UploadsManagerProps } from './types';
+export declare function UploadsManager({ isExpanded: isExpandedProp, defaultExpanded, onToggle: onToggleProp, items, onCancelAll, onRetryAll, onItemCancel, onItemRetry, onItemRemove, onItemOpen, onItemShare, }: Readonly<UploadsManagerProps>): import("react/jsx-runtime").JSX.Element;
+export default UploadsManager;

package/dist/types/lib/utils/getProgress.d.ts

@@ -0,0 +1,2 @@
+import { UploadItem } from '../types';
+export declare function getProgress(items: UploadItem[]): number;

package/dist/types/lib/utils/getStatus.d.ts

@@ -0,0 +1,2 @@
+import { UploadItem, UploadsStatus } from '../types';
+export declare function getStatus(items: UploadItem[]): UploadsStatus;

package/package.json

@@ -0,0 +1,51 @@
+{
+    "name": "@box/uploads-manager",
+    "version": "1.13.1",
+    "license": "SEE LICENSE IN LICENSE",
+    "peerDependencies": {
+        "@box/blueprint-web": "^14.30.0",
+        "@box/blueprint-web-assets": "^4.117.2",
+        "@box/item-icon": "^2.35.3",
+        "react": "^18.0.0",
+        "react-aria-components": "1.16.0",
+        "react-dom": "^18.0.0",
+        "react-intl": "^6.4.2"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "devDependencies": {
+        "@box/blueprint-web": "^14.30.0",
+        "@box/blueprint-web-assets": "^4.117.2",
+        "@box/eslint-plugin-blueprint": "1.2.0",
+        "@box/item-icon": "^2.35.3",
+        "@box/storybook-utils": "0.19.2",
+        "react-aria-components": "1.16.0",
+        "react-intl": "^6.4.2"
+    },
+    "files": [
+        "dist"
+    ],
+    "main": "./dist/esm/index.js",
+    "module": "./dist/esm/index.js",
+    "types": "./dist/types/index.d.ts",
+    "exports": {
+        ".": {
+            "require": "./dist/esm/index.js",
+            "import": "./dist/esm/index.js",
+            "types": "./dist/types/index.d.ts"
+        },
+        "./*": {
+            "require": "./dist/esm/*",
+            "import": "./dist/esm/*",
+            "types": "./dist/types/*"
+        },
+        "./i18n/*": {
+            "require": "./dist/i18n/*",
+            "import": "./dist/i18n/*"
+        }
+    },
+    "sideEffects": [
+        "**/*.css"
+    ]
+}