@sequenceholdings/storage 0.1.1 → 0.1.3

package/README.md

@@ -1,7 +1,7 @@
 # Atlas storage client
 
 Typed Workspaces V2 metadata and direct-to-GCS sequential resumable transfers.
-Initial release is pending publication and public-contract review.
+Preview. See the public Workspaces V2 developer documentation.
 
 ```ts
 import { createStorageClient } from '@sequenceholdings/storage'
@@ -102,3 +102,11 @@ host and `storage.googleapis.com`. Delegation expires shortly after the function
 For local integration use the normal local Atlas environment, `seq-studio storage`
 and `functions deploy -e local`. File references in ORM remain application-owned;
 there is no automatic row-to-file authorization or deletion cascade.
+
+## Shared Platform runtime
+
+`@sequenceholdings/storage` retains its existing runtime exports as compatibility adapters over
+`@sequenceholdings/platform/storage`. Runtime contracts, clients and transport live in the shared
+package; primitive authoring/build responsibilities remain here. The coordinated
+release is prepared and unpublished. Build and publish Platform before this
+package and update downstream consumer lockfiles together.

package/dist/client.d.ts

@@ -1,529 +1,2 @@
-import { z } from 'zod';
-import { type CompleteStorageUpload, type StartStorageUpload, type StorageOperationScope, type WorkspaceManifest, type updateNodeSchema, type updateStorageAccessSchema } from './contracts.js';
-import { type StorageUploadSource, type StorageTransferOptions } from './transfer.js';
-export declare const STORAGE_TOKEN_HEADER = "x-sequence-storage-token";
-export declare const STORAGE_SERVICE_TOKEN_HEADER = "x-sequence-storage-token-service";
-export interface StorageTransport {
-    request(method: string, path: string, body?: unknown): Promise<unknown>;
-}
-export interface StorageListOptions {
-    cursor?: string;
-    limit?: number;
-    q?: string;
-    sort?: 'name' | 'newest';
-}
-export declare class StorageApiError extends Error {
-    readonly status: number;
-    readonly code: string;
-    constructor(status: number, code: string, message: string);
-}
-/** Backoff for replay-safe requests (see `replayable`). */
-export interface StoragePermissionsRetry {
-    /** Total attempts including the first; 1 disables retrying. */
-    attempts?: number;
-    /** Ceiling of the first backoff; each later retry doubles it. */
-    baseDelayMs?: number;
-}
-export declare const storageDownloadSchema: z.ZodObject<{
-    url: z.ZodURL;
-    expiresAt: z.ZodString;
-    preview: z.ZodBoolean;
-}, z.core.$strip>;
-/** Supply a transport for an Artifact bridge, or use createStorageClient for HTTP. */
-export declare function storageClient(transport: StorageTransport, { permissionsRetry, }?: {
-    permissionsRetry?: StoragePermissionsRetry;
-}): {
-    capabilities: () => Promise<{
-        canProvision: boolean;
-        uploadMethods: string[];
-        pendingUploads: {
-            perPrincipal: number;
-            perWorkspace: number;
-        };
-        uploadBatchLimit: number;
-        importConcurrency: {
-            default: number;
-            max: number;
-        };
-    }>;
-    list: (options?: StorageListOptions) => Promise<{
-        items: {
-            id: string;
-            name: string;
-            description: string;
-            environment: string;
-            state: "active" | "trashed" | "purging";
-            revision: number;
-            createdAt: string;
-            role: "viewer" | "editor" | "admin" | "owner";
-            quotaBytes: number;
-            usedBytes: number;
-            reservedBytes: number;
-        }[];
-        nextCursor: string | null;
-    }>;
-    shared: (options?: StorageListOptions & {
-        trash?: boolean;
-    }) => Promise<{
-        items: {
-            id: string;
-            workspaceId: string;
-            parentId: string | null;
-            name: string;
-            kind: "file" | "folder";
-            state: "active" | "trashed" | "purging";
-            restricted: boolean;
-            revision: number;
-            currentVersionId: string | null;
-            metadata: Record<string, string>;
-            createdAt: string;
-            updatedAt: string;
-            role: "viewer" | "editor" | "admin";
-            size: number | null;
-            contentType: string | null;
-        }[];
-        nextCursor: string | null;
-    }>;
-    apply: (manifest: WorkspaceManifest) => Promise<{
-        id: string;
-        name: string;
-        description: string;
-        environment: string;
-        state: "active" | "trashed" | "purging";
-        revision: number;
-        createdAt: string;
-        role: "viewer" | "editor" | "admin" | "owner";
-        quotaBytes: number;
-        usedBytes: number;
-        reservedBytes: number;
-    }>;
-    workspace(id: string): {
-        get: () => Promise<{
-            id: string;
-            name: string;
-            description: string;
-            environment: string;
-            state: "active" | "trashed" | "purging";
-            revision: number;
-            createdAt: string;
-            role: "viewer" | "editor" | "admin" | "owner";
-            quotaBytes: number;
-            usedBytes: number;
-            reservedBytes: number;
-        }>;
-        delete: (expectedRevision: number) => Promise<{
-            id: string;
-            workspaceId: string;
-            targetId: string | null;
-            kind: "purge" | "delete_version";
-            status: "queued" | "running" | "succeeded" | "failed";
-            completed: number;
-            total: number;
-            error: string | null;
-            createdAt: string;
-            updatedAt: string;
-            canRetry: boolean;
-        }>;
-        list: (options?: StorageListOptions & {
-            parentId?: string | null;
-            trash?: boolean;
-        }) => Promise<{
-            items: {
-                id: string;
-                workspaceId: string;
-                parentId: string | null;
-                name: string;
-                kind: "file" | "folder";
-                state: "active" | "trashed" | "purging";
-                restricted: boolean;
-                revision: number;
-                currentVersionId: string | null;
-                metadata: Record<string, string>;
-                createdAt: string;
-                updatedAt: string;
-                role: "viewer" | "editor" | "admin";
-                size: number | null;
-                contentType: string | null;
-            }[];
-            nextCursor: string | null;
-        }>;
-        getNode: (id: string) => Promise<{
-            id: string;
-            workspaceId: string;
-            parentId: string | null;
-            name: string;
-            kind: "file" | "folder";
-            state: "active" | "trashed" | "purging";
-            restricted: boolean;
-            revision: number;
-            currentVersionId: string | null;
-            metadata: Record<string, string>;
-            createdAt: string;
-            updatedAt: string;
-            role: "viewer" | "editor" | "admin";
-            size: number | null;
-            contentType: string | null;
-        }>;
-        /**
-         * Keyed like upload start, so every resend (storage_busy,
-         * permissions_pending, a lost reply) returns the one folder it made.
-         * Pass `idempotencyKey` to extend that across your own retries.
-         */
-        createFolder: (name: string, parentId?: string | null, { idempotencyKey, }?: {
-            idempotencyKey?: string;
-        }) => Promise<{
-            id: string;
-            workspaceId: string;
-            parentId: string | null;
-            name: string;
-            kind: "file" | "folder";
-            state: "active" | "trashed" | "purging";
-            restricted: boolean;
-            revision: number;
-            currentVersionId: string | null;
-            metadata: Record<string, string>;
-            createdAt: string;
-            updatedAt: string;
-            role: "viewer" | "editor" | "admin";
-            size: number | null;
-            contentType: string | null;
-        }>;
-        update: (id: string, input: z.input<typeof updateNodeSchema>) => Promise<{
-            id: string;
-            workspaceId: string;
-            parentId: string | null;
-            name: string;
-            kind: "file" | "folder";
-            state: "active" | "trashed" | "purging";
-            restricted: boolean;
-            revision: number;
-            currentVersionId: string | null;
-            metadata: Record<string, string>;
-            createdAt: string;
-            updatedAt: string;
-            role: "viewer" | "editor" | "admin";
-            size: number | null;
-            contentType: string | null;
-        }>;
-        trash: (id: string, expectedRevision: number) => Promise<{
-            id: string;
-            workspaceId: string;
-            parentId: string | null;
-            name: string;
-            kind: "file" | "folder";
-            state: "active" | "trashed" | "purging";
-            restricted: boolean;
-            revision: number;
-            currentVersionId: string | null;
-            metadata: Record<string, string>;
-            createdAt: string;
-            updatedAt: string;
-            role: "viewer" | "editor" | "admin";
-            size: number | null;
-            contentType: string | null;
-        }>;
-        restore: (id: string, expectedRevision: number) => Promise<{
-            id: string;
-            workspaceId: string;
-            parentId: string | null;
-            name: string;
-            kind: "file" | "folder";
-            state: "active" | "trashed" | "purging";
-            restricted: boolean;
-            revision: number;
-            currentVersionId: string | null;
-            metadata: Record<string, string>;
-            createdAt: string;
-            updatedAt: string;
-            role: "viewer" | "editor" | "admin";
-            size: number | null;
-            contentType: string | null;
-        }>;
-        purge: (id: string, expectedRevision: number) => Promise<{
-            id: string;
-            workspaceId: string;
-            targetId: string | null;
-            kind: "purge" | "delete_version";
-            status: "queued" | "running" | "succeeded" | "failed";
-            completed: number;
-            total: number;
-            error: string | null;
-            createdAt: string;
-            updatedAt: string;
-            canRetry: boolean;
-        }>;
-        download: (id: string, options?: {
-            versionId?: string;
-            preview?: boolean;
-        }) => Promise<{
-            url: string;
-            expiresAt: string;
-            preview: boolean;
-        }>;
-        versions: (id: string, options?: {
-            before?: number;
-            limit?: number;
-        }) => Promise<{
-            items: {
-                id: string;
-                fileId: string;
-                revision: number;
-                size: number;
-                checksum: string;
-                contentType: string;
-                createdAt: string;
-                createdBy: string;
-                state: "active" | "purging";
-            }[];
-            nextRevision: number | null;
-        }>;
-        restoreVersion: (id: string, versionId: string, expectedRevision: number) => Promise<{
-            id: string;
-            fileId: string;
-            revision: number;
-            size: number;
-            checksum: string;
-            contentType: string;
-            createdAt: string;
-            createdBy: string;
-            state: "active" | "purging";
-        }>;
-        deleteVersion: (id: string, versionId: string, expectedRevision: number) => Promise<{
-            id: string;
-            workspaceId: string;
-            targetId: string | null;
-            kind: "purge" | "delete_version";
-            status: "queued" | "running" | "succeeded" | "failed";
-            completed: number;
-            total: number;
-            error: string | null;
-            createdAt: string;
-            updatedAt: string;
-            canRetry: boolean;
-        }>;
-        access: (id?: string) => Promise<{
-            revision: number;
-            restricted: boolean;
-            grants: {
-                type: "user" | "group" | "organization" | "service_account";
-                id: string;
-                role: "viewer" | "editor" | "admin";
-            }[];
-            owner: string | null;
-            inherited: boolean;
-            workspaceAdminOverride: true;
-            displayNames: Record<string, string>;
-        }>;
-        setAccess: (input: z.input<typeof updateStorageAccessSchema>, id?: string) => Promise<{
-            revision: number;
-            restricted: boolean;
-            grants: {
-                type: "user" | "group" | "organization" | "service_account";
-                id: string;
-                role: "viewer" | "editor" | "admin";
-            }[];
-            owner: string | null;
-            inherited: boolean;
-            workspaceAdminOverride: true;
-            displayNames: Record<string, string>;
-        }>;
-        transferOwner: (principal: {
-            type: "user" | "service_account";
-            id: string;
-        }, expectedRevision: number) => Promise<{
-            revision: number;
-            restricted: boolean;
-            grants: {
-                type: "user" | "group" | "organization" | "service_account";
-                id: string;
-                role: "viewer" | "editor" | "admin";
-            }[];
-            owner: string | null;
-            inherited: boolean;
-            workspaceAdminOverride: true;
-            displayNames: Record<string, string>;
-        }>;
-        operations: (options?: {
-            before?: string;
-            limit?: number;
-            scope?: StorageOperationScope;
-        }) => Promise<{
-            items: {
-                id: string;
-                workspaceId: string;
-                targetId: string | null;
-                kind: "purge" | "delete_version";
-                status: "queued" | "running" | "succeeded" | "failed";
-                completed: number;
-                total: number;
-                error: string | null;
-                createdAt: string;
-                updatedAt: string;
-                canRetry: boolean;
-            }[];
-            nextCursor: string | null;
-        }>;
-        retryOperation: (id: string) => Promise<{
-            id: string;
-            workspaceId: string;
-            targetId: string | null;
-            kind: "purge" | "delete_version";
-            status: "queued" | "running" | "succeeded" | "failed";
-            completed: number;
-            total: number;
-            error: string | null;
-            createdAt: string;
-            updatedAt: string;
-            canRetry: boolean;
-        }>;
-        uploads: {
-            start: (input: StartStorageUpload) => Promise<{
-                id: string;
-                fileId: string;
-                uploadUrl: string | null;
-                expiresAt: string;
-                state: "pending" | "complete" | "aborted";
-                versionId: string | null;
-                maxBytes: number;
-            }>;
-            get: (id: string) => Promise<{
-                id: string;
-                fileId: string;
-                uploadUrl: string | null;
-                expiresAt: string;
-                state: "pending" | "complete" | "aborted";
-                versionId: string | null;
-                maxBytes: number;
-            }>;
-            /** `resume` passes the CRC32C it computed; pass your own when transferring bytes yourself. */
-            complete: (id: string, input?: CompleteStorageUpload) => Promise<{
-                id: string;
-                fileId: string;
-                uploadUrl: string | null;
-                expiresAt: string;
-                state: "pending" | "complete" | "aborted";
-                versionId: string | null;
-                maxBytes: number;
-            }>;
-            abort: (id: string) => Promise<{
-                id: string;
-                fileId: string;
-                uploadUrl: string | null;
-                expiresAt: string;
-                state: "pending" | "complete" | "aborted";
-                versionId: string | null;
-                maxBytes: number;
-            }>;
-            startBatch: (items: StartStorageUpload[]) => Promise<{
-                items: {
-                    id: string;
-                    fileId: string;
-                    uploadUrl: string | null;
-                    expiresAt: string;
-                    state: "pending" | "complete" | "aborted";
-                    versionId: string | null;
-                    maxBytes: number;
-                }[];
-            }>;
-            list: () => Promise<{
-                items: {
-                    id: string;
-                    fileId: string;
-                    name: string;
-                    state: "pending" | "complete" | "aborted";
-                    expiresAt: string;
-                    maxBytes: number;
-                    expectedSize: number | null;
-                    versionId: string | null;
-                }[];
-                limits: {
-                    perPrincipal: number;
-                    perWorkspace: number;
-                };
-            }>;
-            reconcile: (input?: {
-                abortIncomplete?: boolean;
-            }) => Promise<{
-                completed: {
-                    id: string;
-                    fileId: string;
-                    name: string;
-                    state: "pending" | "complete" | "aborted";
-                    expiresAt: string;
-                    maxBytes: number;
-                    expectedSize: number | null;
-                    versionId: string | null;
-                    code: string;
-                    message: string;
-                }[];
-                aborted: {
-                    id: string;
-                    fileId: string;
-                    name: string;
-                    state: "pending" | "complete" | "aborted";
-                    expiresAt: string;
-                    maxBytes: number;
-                    expectedSize: number | null;
-                    versionId: string | null;
-                    code: string;
-                    message: string;
-                }[];
-                pending: {
-                    id: string;
-                    fileId: string;
-                    name: string;
-                    state: "pending" | "complete" | "aborted";
-                    expiresAt: string;
-                    maxBytes: number;
-                    expectedSize: number | null;
-                    versionId: string | null;
-                    code: string;
-                    message: string;
-                }[];
-            }>;
-            resume(id: string, source: StorageUploadSource, options?: StorageTransferOptions & {
-                size?: number;
-            }): Promise<{
-                id: string;
-                fileId: string;
-                uploadUrl: string | null;
-                expiresAt: string;
-                state: "pending" | "complete" | "aborted";
-                versionId: string | null;
-                maxBytes: number;
-            }>;
-            /**
-             * Start, transfer and complete in one call. A failure after the session
-             * starts aborts it (best effort) to release its reservation; pass
-             * `keepSessionOnFailure` to keep it for a manual `resume`.
-             */
-            put(input: Omit<StartStorageUpload, "idempotencyKey"> & {
-                /** Defaults to a fresh key per put, reused across its start retries. */
-                idempotencyKey?: string;
-            }, source: StorageUploadSource, { keepSessionOnFailure, ...options }?: StorageTransferOptions & {
-                keepSessionOnFailure?: boolean;
-            }): Promise<{
-                id: string;
-                fileId: string;
-                uploadUrl: string | null;
-                expiresAt: string;
-                state: "pending" | "complete" | "aborted";
-                versionId: string | null;
-                maxBytes: number;
-            }>;
-        };
-    };
-};
-export type StorageClient = ReturnType<typeof storageClient>;
-export declare function createStorageClient({ baseUrl, getToken, getHeaders, fetch: fetcher, permissionsRetry, requestTimeoutMs, }: {
-    baseUrl: string;
-    getToken?: () => string | Promise<string>;
-    getHeaders?: () => Record<string, string> | Promise<Record<string, string>>;
-    fetch?: typeof fetch;
-    permissionsRetry?: StoragePermissionsRetry;
-    /**
-     * Per metadata request, including reading the reply; 0 disables it. Byte
-     * transfer goes to the provider directly and is not bounded by this.
-     */
-    requestTimeoutMs?: number;
-}): StorageClient;
+/** Runtime compatibility export; implementation lives in the platform SDK. */
+export * from "@sequenceholdings/platform/storage";