firebase-admin-edge 1.1.0 → 2.0.0

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

@@ -0,0 +1,251 @@
+import type { FirebaseEdgeError } from '../auth/errors.js';
+import type { CRC32CValidatorGenerator } from './storage-checksum.js';
+export type StorageResult<T> = {
+    error: null;
+    data: T;
+} | {
+    error: FirebaseEdgeError;
+    data: null;
+};
+/** Cloud Storage object metadata. Large integer fields stay as strings. */
+export interface StorageFileMetadata {
+    name: string;
+    bucket: string;
+    generation: string;
+    metageneration?: string;
+    size: string;
+    contentType?: string;
+    cacheControl?: string;
+    contentDisposition?: string;
+    contentEncoding?: string;
+    contentLanguage?: string;
+    timeCreated?: string;
+    updated?: string;
+    md5Hash?: string;
+    crc32c?: string;
+    metadata?: Record<string, string>;
+    restoreToken?: string;
+    softDeleteTime?: string;
+    hardDeleteTime?: string;
+    storageClass?: string;
+    componentCount?: number;
+    retentionExpirationTime?: string;
+}
+export type StorageUploadData = string | Blob | Uint8Array<ArrayBuffer> | ArrayBuffer;
+export interface StoragePreconditions {
+    userProject?: string;
+    ifGenerationMatch?: string;
+    ifGenerationNotMatch?: string;
+    ifMetagenerationMatch?: string;
+    ifMetagenerationNotMatch?: string;
+}
+export interface StorageReadOptions extends StoragePreconditions {
+    softDeleted?: boolean;
+    restoreToken?: string;
+    generation?: string;
+}
+export interface StorageDownloadOptions extends StorageReadOptions {
+    crc32cGenerator?: CRC32CValidatorGenerator;
+    checksumAlgorithm?: 'crc32c' | 'md5';
+    /** Inclusive byte offsets. */
+    start?: number;
+    end?: number;
+    verifyChecksum?: boolean;
+}
+export interface StorageTransferProgress {
+    bytesTransferred: number;
+    totalBytes?: number;
+    complete: boolean;
+}
+export type StorageProgressCallback = (progress: StorageTransferProgress) => void | Promise<void>;
+export interface StorageUploadOptions extends StoragePreconditions {
+    crc32cGenerator?: CRC32CValidatorGenerator;
+    predefinedAcl?: string;
+    kmsKeyName?: string;
+    md5Hash?: 'auto' | string;
+    metadata?: StorageMetadataUpdate;
+    contentType?: string;
+    /** Use "0" to create only if the object does not already exist. */
+    ifGenerationMatch?: string;
+    crc32c?: 'auto' | string;
+    onProgress?: StorageProgressCallback;
+}
+export interface StorageDeleteOptions extends StorageReadOptions {
+    ifGenerationMatch?: string;
+}
+export interface StorageMetadataUpdate {
+    retention?: {
+        mode: 'Locked' | 'Unlocked';
+        retainUntilTime: string;
+    } | null;
+    acl?: import('./storage-special-types.js').StorageAclEntry[] | null;
+    storageClass?: string;
+    temporaryHold?: boolean;
+    eventBasedHold?: boolean;
+    customTime?: string;
+    contentType?: string | null;
+    cacheControl?: string | null;
+    contentDisposition?: string | null;
+    contentEncoding?: string | null;
+    contentLanguage?: string | null;
+    /** Null removes all custom metadata; null values remove individual keys. */
+    metadata?: Record<string, string | number | boolean | null> | null;
+}
+export interface StorageMetadataOptions extends StorageDeleteOptions {
+    overrideUnlockedRetention?: boolean;
+    ifMetagenerationMatch?: string;
+}
+export interface StorageCopyOptions extends StoragePreconditions {
+    predefinedAcl?: string;
+    token?: string;
+    metadata?: StorageMetadataUpdate;
+    destinationKmsKeyName?: string;
+    destinationEncryptionKey?: string | Uint8Array<ArrayBuffer>;
+    destinationBucket?: string;
+    sourceGeneration?: string;
+    ifSourceGenerationMatch?: string;
+    ifSourceMetagenerationMatch?: string;
+}
+export interface StorageResumableOptions extends Omit<StorageUploadOptions, 'crc32c' | 'md5Hash' | 'onProgress' | 'crc32cGenerator'> {
+    md5Hash?: string;
+    origin?: string;
+    metadata?: StorageMetadataUpdate;
+    size?: number;
+    crc32c?: string;
+}
+export interface StorageChunkOptions {
+    md5Hash?: string;
+    offset: number;
+    /** Omit for a non-final chunk when the total size is not known yet. */
+    totalSize?: number;
+    /** Whole-object checksum, supplied only on the final chunk. */
+    crc32c?: string;
+    onProgress?: StorageProgressCallback;
+}
+export type StorageUploadProgress = {
+    complete: false;
+    nextOffset: number;
+} | {
+    complete: true;
+    metadata: StorageFileMetadata;
+};
+export interface StorageComposeSource {
+    name: string;
+    generation?: string;
+    objectPreconditions?: {
+        ifGenerationMatch: string;
+    };
+}
+export interface StorageComposeOptions extends StoragePreconditions {
+    kmsKeyName?: string;
+    destinationPredefinedAcl?: string;
+    metadata?: StorageMetadataUpdate;
+}
+export interface StorageRestoreOptions extends StoragePreconditions {
+    projection?: 'full' | 'noAcl';
+    generation: string;
+    restoreToken?: string;
+    copySourceAcl?: boolean;
+}
+export interface StorageDeleteTarget extends StorageDeleteOptions {
+    name: string;
+}
+export interface StorageBatchDeleteOptions {
+    concurrency?: number;
+    ignoreNotFound?: boolean;
+}
+export interface StorageBatchDeleteResult {
+    results: Array<{
+        name: string;
+        generation?: string;
+        error: FirebaseEdgeError | null;
+    }>;
+}
+export interface StorageSignedUrlOptions {
+    action: 'read' | 'write';
+    /** Integer lifetime from 1 to 604800 seconds. Defaults to 900. */
+    expiresInSeconds?: number;
+    /** For write URLs, the caller must send this exact Content-Type. */
+    contentType?: string;
+}
+export interface StorageListOptions {
+    userProject?: string;
+    fields?: string;
+    includeFoldersAsPrefixes?: boolean;
+    includeTrailingDelimiter?: boolean;
+    projection?: 'full' | 'noAcl';
+    prefix?: string;
+    delimiter?: string;
+    maxResults?: number;
+    pageToken?: string;
+    versions?: boolean;
+    softDeleted?: boolean;
+    startOffset?: string;
+    endOffset?: string;
+    matchGlob?: string;
+}
+export interface StorageListResult {
+    files: StorageFileMetadata[];
+    prefixes: string[];
+    nextPageToken?: string;
+}
+/** @internal */
+export type StorageOperation = {
+    kind: 'upload';
+    name: string;
+    body: StorageUploadData;
+    options: StorageUploadOptions;
+} | {
+    kind: 'download' | 'stream';
+    name: string;
+    options?: StorageDownloadOptions;
+} | {
+    kind: 'metadata';
+    name: string;
+    options?: StorageReadOptions;
+} | {
+    kind: 'resumable';
+    name: string;
+    options: StorageResumableOptions;
+} | {
+    kind: 'compose';
+    name: string;
+    sources: StorageComposeSource[];
+    options: StorageComposeOptions;
+} | {
+    kind: 'restore';
+    name: string;
+    options: StorageRestoreOptions;
+} | {
+    kind: 'delete';
+    name: string;
+    options: StorageDeleteOptions;
+} | {
+    kind: 'updateMetadata';
+    name: string;
+    metadata: StorageMetadataUpdate;
+    options: StorageMetadataOptions;
+} | {
+    kind: 'copy';
+    name: string;
+    destination: string;
+    options: StorageCopyOptions;
+} | {
+    kind: 'list';
+    options: StorageListOptions;
+};
+/** @internal */
+export interface StorageResponses {
+    upload: StorageFileMetadata;
+    download: Uint8Array<ArrayBuffer>;
+    metadata: StorageFileMetadata;
+    delete: void;
+    list: StorageListResult;
+    updateMetadata: StorageFileMetadata;
+    copy: StorageFileMetadata;
+    stream: Response;
+    resumable: string;
+    compose: StorageFileMetadata;
+    restore: StorageFileMetadata;
+}
+//# sourceMappingURL=storage-types.d.ts.map

package/dist/storage/storage-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-types.d.ts","sourceRoot":"","sources":["../../src/storage/storage-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAEtE,MAAM,MAAM,aAAa,CAAC,CAAC,IACrB;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GACxB;IAAE,KAAK,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC;AAE/C,2EAA2E;AAC3E,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,MAAM,iBAAiB,GACvB,MAAM,GACN,IAAI,GACJ,UAAU,CAAC,WAAW,CAAC,GACvB,WAAW,CAAC;AAElB,MAAM,WAAW,oBAAoB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC5D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB;IAC9D,eAAe,CAAC,EAAE,wBAAwB,CAAC;IAC3C,iBAAiB,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;IACrC,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,MAAM,uBAAuB,GAAG,CAClC,QAAQ,EAAE,uBAAuB,KAChC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1B,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAC9D,eAAe,CAAC,EAAE,wBAAwB,CAAC;IAC3C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,uBAAuB,CAAC;CACxC;AAED,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC5D,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB;IAClC,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;QAAC,eAAe,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC5E,GAAG,CAAC,EAAE,OAAO,4BAA4B,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IACpE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;CACtE;AAED,MAAM,WAAW,sBAAuB,SAAQ,oBAAoB;IAChE,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC5D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,wBAAwB,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;IAC5D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,2BAA2B,CAAC,EAAE,MAAM,CAAC;CACxC;AAED,MAAM,WAAW,uBACb,SAAQ,IAAI,CACR,oBAAoB,EACpB,QAAQ,GAAG,SAAS,GAAG,YAAY,GAAG,iBAAiB,CAC1D;IACD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,uEAAuE;IACvE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,uBAAuB,CAAC;CACxC;AAED,MAAM,MAAM,qBAAqB,GAC3B;IAAE,QAAQ,EAAE,KAAK,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GACvC;IAAE,QAAQ,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAExD,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB,CAAC,EAAE;QAAE,iBAAiB,EAAE,MAAM,CAAA;KAAE,CAAC;CACvD;AAED,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;CACpC;AAED,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IAC/D,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC7D,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,yBAAyB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACrC,OAAO,EAAE,KAAK,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAC;KACnC,CAAC,CAAC;CACN;AAED,MAAM,WAAW,uBAAuB;IACpC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IACzB,kEAAkE;IAClE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oEAAoE;IACpE,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GACtB;IACI,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,iBAAiB,CAAC;IACxB,OAAO,EAAE,oBAAoB,CAAC;CACjC,GACD;IACI,IAAI,EAAE,UAAU,GAAG,QAAQ,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,sBAAsB,CAAC;CACpC,GACD;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,kBAAkB,CAAA;CAAE,GAChE;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,uBAAuB,CAAA;CAAE,GACrE;IACI,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,OAAO,EAAE,qBAAqB,CAAC;CAClC,GACD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,qBAAqB,CAAA;CAAE,GACjE;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,oBAAoB,CAAA;CAAE,GAC/D;IACI,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,qBAAqB,CAAC;IAChC,OAAO,EAAE,sBAAsB,CAAC;CACnC,GACD;IACI,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,kBAAkB,CAAC;CAC/B,GACD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,kBAAkB,CAAA;CAAE,CAAC;AAEpD,gBAAgB;AAChB,MAAM,WAAW,gBAAgB;IAC7B,MAAM,EAAE,mBAAmB,CAAC;IAC5B,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAClC,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,MAAM,EAAE,IAAI,CAAC;IACb,IAAI,EAAE,iBAAiB,CAAC;IACxB,cAAc,EAAE,mBAAmB,CAAC;IACpC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,MAAM,EAAE,QAAQ,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,OAAO,EAAE,mBAAmB,CAAC;CAChC"}

package/dist/storage/storage-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=storage-types.js.map

package/dist/storage/storage-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-types.js","sourceRoot":"","sources":["../../src/storage/storage-types.ts"],"names":[],"mappings":""}

package/dist/storage/storage-upload-stream.d.ts

@@ -0,0 +1,41 @@
+import type { CRC32CValidatorGenerator } from './storage-checksum.js';
+import type { StorageUploadData, StorageResumableOptions, StorageChunkOptions, StorageUploadProgress, StorageFileMetadata, StorageResult, StorageProgressCallback } from './storage-types.js';
+export interface StorageUploadStreamOptions extends Omit<StorageResumableOptions, 'crc32c' | 'md5Hash'> {
+    md5Hash?: string | 'auto';
+    isPartialUpload?: boolean;
+    crc32cGenerator?: CRC32CValidatorGenerator;
+    /** The input starts at this session offset; supply the preceding CRC32C when validating. */
+    offset?: number;
+    resumeCRC32C?: string | number;
+    /** Multiple of 256 KiB, up to 64 MiB. Defaults to 8 MiB. */
+    chunkSize?: number;
+    /** Recovery attempts per chunk. Defaults to 2. */
+    maxResumeAttempts?: number;
+    verifyChecksum?: boolean;
+    sessionUri?: string;
+    /** Automatic CRC32C is computed incrementally and verified on completion. */
+    crc32c?: string | 'auto';
+    onProgress?: StorageProgressCallback;
+    onSession?: (sessionUri: string) => void | Promise<void>;
+}
+export interface StoragePartialUpload {
+    complete: false;
+    sessionUri: string;
+    nextOffset: number;
+    crc32c?: string;
+}
+/** @internal Public Storage methods supply authentication and endpoint handling. */
+export interface StorageUploadTransport {
+    createResumableUpload(name: string, options: StorageResumableOptions): Promise<StorageResult<string>>;
+    uploadChunk(session: string, body: StorageUploadData, options: StorageChunkOptions): Promise<StorageResult<StorageUploadProgress>>;
+    getUploadStatus(session: string, totalSize?: number): Promise<StorageResult<StorageUploadProgress>>;
+}
+/** @internal Retain the current chunk while reconciling uncertain acknowledgements. */
+export declare function uploadStorageStream(transport: StorageUploadTransport, name: string, input: StorageUploadData | ReadableStream<Uint8Array>, options: StorageUploadStreamOptions & {
+    isPartialUpload: true;
+}): Promise<StoragePartialUpload>;
+export declare function uploadStorageStream(transport: StorageUploadTransport, name: string, input: StorageUploadData | ReadableStream<Uint8Array>, options?: StorageUploadStreamOptions & {
+    isPartialUpload?: false;
+}): Promise<StorageFileMetadata>;
+export declare function uploadStorageStream(transport: StorageUploadTransport, name: string, input: StorageUploadData | ReadableStream<Uint8Array>, options: StorageUploadStreamOptions): Promise<StorageFileMetadata | StoragePartialUpload>;
+//# sourceMappingURL=storage-upload-stream.d.ts.map

package/dist/storage/storage-upload-stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-upload-stream.d.ts","sourceRoot":"","sources":["../../src/storage/storage-upload-stream.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAGtE,OAAO,KAAK,EACR,iBAAiB,EACjB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,EACb,uBAAuB,EAC1B,MAAM,oBAAoB,CAAC;AAE5B,MAAM,WAAW,0BACb,SAAQ,IAAI,CAAC,uBAAuB,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC3D,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,eAAe,CAAC,EAAE,wBAAwB,CAAC;IAC3C,4FAA4F;IAC5F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/B,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,6EAA6E;IAC7E,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,uBAAuB,CAAC;IACrC,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,oBAAoB;IACjC,QAAQ,EAAE,KAAK,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,oFAAoF;AACpF,MAAM,WAAW,sBAAsB;IACnC,qBAAqB,CACjB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,uBAAuB,GACjC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAClC,WAAW,CACP,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,iBAAiB,EACvB,OAAO,EAAE,mBAAmB,GAC7B,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACjD,eAAe,CACX,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC;CACpD;AAgDD,uFAAuF;AACvF,wBAAgB,mBAAmB,CAC/B,SAAS,EAAE,sBAAsB,EACjC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,iBAAiB,GAAG,cAAc,CAAC,UAAU,CAAC,EACrD,OAAO,EAAE,0BAA0B,GAAG;IAAE,eAAe,EAAE,IAAI,CAAA;CAAE,GAChE,OAAO,CAAC,oBAAoB,CAAC,CAAC;AACjC,wBAAgB,mBAAmB,CAC/B,SAAS,EAAE,sBAAsB,EACjC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,iBAAiB,GAAG,cAAc,CAAC,UAAU,CAAC,EACrD,OAAO,CAAC,EAAE,0BAA0B,GAAG;IAAE,eAAe,CAAC,EAAE,KAAK,CAAA;CAAE,GACnE,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAChC,wBAAgB,mBAAmB,CAC/B,SAAS,EAAE,sBAAsB,EACjC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,iBAAiB,GAAG,cAAc,CAAC,UAAU,CAAC,EACrD,OAAO,EAAE,0BAA0B,GACpC,OAAO,CAAC,mBAAmB,GAAG,oBAAoB,CAAC,CAAC"}

package/dist/storage/storage-upload-stream.js

@@ -0,0 +1,335 @@
+import { FirebaseEdgeError } from '../auth/errors.js';
+import { StorageMd5 } from './storage-md5.js';
+import { createStorageCrc32c, storageUploadBlob, validateStorageCrc32c, validateStorageMd5, verifyStorageUpload } from './storage-checksum.js';
+import { reportStorageProgress } from './storage-progress.js';
+import { validateSessionUri } from './storage-resumable.js';
+/** @internal Split a byte stream without accumulating the whole upload. */
+async function* storageChunks(source, chunkSize) {
+    const reader = source.getReader();
+    let buffer = new Uint8Array(chunkSize);
+    let used = 0;
+    let finished = false;
+    try {
+        for (;;) {
+            const { done, value } = await reader.read();
+            if (done) {
+                finished = true;
+                break;
+            }
+            if (!(value instanceof Uint8Array)) {
+                throw new FirebaseEdgeError({
+                    code: 'storage/invalid-argument',
+                    message: 'Upload streams must contain Uint8Array chunks.'
+                });
+            }
+            let offset = 0;
+            while (offset < value.length) {
+                const count = Math.min(chunkSize - used, value.length - offset);
+                buffer.set(value.subarray(offset, offset + count), used);
+                used += count;
+                offset += count;
+                if (used === chunkSize) {
+                    yield buffer;
+                    buffer = new Uint8Array(chunkSize);
+                    used = 0;
+                }
+            }
+        }
+        if (used > 0) {
+            yield buffer.slice(0, used);
+        }
+    }
+    finally {
+        if (!finished) {
+            await reader.cancel().catch(() => { });
+        }
+        reader.releaseLock();
+    }
+}
+export async function uploadStorageStream(transport, name, input, options = {}) {
+    if (!options || typeof options !== 'object' || Array.isArray(options)) {
+        throw new FirebaseEdgeError({
+            code: 'storage/invalid-argument',
+            message: 'Upload options must be an object.'
+        });
+    }
+    const { chunkSize = 8388608, maxResumeAttempts = 2, verifyChecksum = true, sessionUri, crc32c = 'auto', md5Hash, offset: initialOffset = 0, resumeCRC32C, isPartialUpload = false, crc32cGenerator, onProgress, onSession, ...sessionOptions } = options;
+    if (typeof isPartialUpload !== 'boolean' ||
+        (isPartialUpload &&
+            (options.chunkSize === undefined || md5Hash !== undefined))) {
+        throw new FirebaseEdgeError({
+            code: 'storage/invalid-argument',
+            message: 'Partial uploads require chunkSize and cannot validate whole-object MD5.'
+        });
+    }
+    if (!Number.isSafeInteger(chunkSize) ||
+        chunkSize < 262144 ||
+        chunkSize > 67108864 ||
+        chunkSize % 262144 !== 0 ||
+        !Number.isInteger(maxResumeAttempts) ||
+        maxResumeAttempts < 0 ||
+        maxResumeAttempts > 10 ||
+        typeof verifyChecksum !== 'boolean' ||
+        (onProgress !== undefined && typeof onProgress !== 'function') ||
+        (onSession !== undefined && typeof onSession !== 'function')) {
+        throw new FirebaseEdgeError({
+            code: 'storage/invalid-argument',
+            message: 'Invalid chunk size, recovery limit, or upload callback.'
+        });
+    }
+    if (crc32c !== 'auto') {
+        validateStorageCrc32c(crc32c);
+    }
+    if (!Number.isSafeInteger(initialOffset) ||
+        initialOffset < 0 ||
+        (initialOffset > 0 &&
+            (!sessionUri ||
+                md5Hash !== undefined ||
+                (verifyChecksum && resumeCRC32C === undefined))) ||
+        (initialOffset === 0 && resumeCRC32C !== undefined)) {
+        throw new FirebaseEdgeError({
+            code: 'storage/invalid-argument',
+            message: 'Resuming a sliced input requires a session URI, a valid offset, and the preceding CRC32C when validation is enabled; MD5 requires the full input.'
+        });
+    }
+    const checksum = createStorageCrc32c(verifyChecksum || isPartialUpload ? crc32cGenerator : undefined, resumeCRC32C);
+    if (md5Hash !== undefined && md5Hash !== 'auto') {
+        validateStorageMd5(md5Hash);
+    }
+    if (sessionUri !== undefined) {
+        validateSessionUri(sessionUri);
+    }
+    const blob = input instanceof ReadableStream ? undefined : storageUploadBlob(input);
+    const source = blob ? blob.stream() : input;
+    if (source.locked) {
+        throw new FirebaseEdgeError({
+            code: 'storage/invalid-argument',
+            message: 'Upload stream is already locked.'
+        });
+    }
+    const declaredSize = sessionOptions.size ??
+        (blob && !isPartialUpload ? blob.size + initialOffset : undefined);
+    if (isPartialUpload &&
+        blob &&
+        (blob.size === 0 || blob.size % 262144 !== 0)) {
+        throw new FirebaseEdgeError({
+            code: 'storage/invalid-argument',
+            message: 'Partial input must contain a positive multiple of 256 KiB.'
+        });
+    }
+    if (declaredSize !== undefined &&
+        (!Number.isSafeInteger(declaredSize) ||
+            declaredSize < 0 ||
+            (blob &&
+                (isPartialUpload
+                    ? declaredSize <= blob.size + initialOffset
+                    : declaredSize !== blob.size + initialOffset)))) {
+        throw new FirebaseEdgeError({
+            code: 'storage/invalid-argument',
+            message: 'Upload size must match the input.'
+        });
+    }
+    let session = sessionUri;
+    let persisted = 0;
+    if (!session) {
+        const { error, data } = await transport.createResumableUpload(name, {
+            ...sessionOptions,
+            size: declaredSize,
+            ...(crc32c !== 'auto' && { crc32c }),
+            ...(md5Hash !== undefined && md5Hash !== 'auto' && { md5Hash })
+        });
+        if (error) {
+            throw error;
+        }
+        session = data;
+    }
+    await onSession?.(session);
+    if (sessionUri) {
+        const { error, data } = await transport.getUploadStatus(session, declaredSize);
+        if (error) {
+            throw error;
+        }
+        if (data.complete) {
+            if (isPartialUpload) {
+                throw new FirebaseEdgeError({
+                    code: 'storage/invalid-argument',
+                    message: 'The partial upload session is already complete.'
+                });
+            }
+            const md5 = md5Hash !== undefined ? new StorageMd5() : undefined;
+            let size = initialOffset;
+            for await (const bytes of storageChunks(source, chunkSize)) {
+                checksum.update(bytes);
+                md5?.update(bytes);
+                size += bytes.length;
+            }
+            if (String(size) !== data.metadata.size ||
+                (declaredSize !== undefined && size !== declaredSize)) {
+                throw new FirebaseEdgeError({
+                    code: 'storage/invalid-argument',
+                    message: 'Input size differs from the completed session.'
+                });
+            }
+            verifyStorageUpload(verifyChecksum
+                ? crc32c === 'auto'
+                    ? checksum.digest()
+                    : crc32c
+                : undefined, data.metadata, md5Hash === 'auto' ? md5?.digest() : md5Hash);
+            await reportStorageProgress(onProgress, {
+                bytesTransferred: Number(data.metadata.size),
+                totalBytes: Number(data.metadata.size),
+                complete: true
+            });
+            return data.metadata;
+        }
+        persisted = data.nextOffset;
+        if (persisted < initialOffset) {
+            throw new FirebaseEdgeError({
+                code: 'storage/invalid-argument',
+                message: 'The supplied source begins after the acknowledged upload offset.'
+            });
+        }
+    }
+    const chunks = storageChunks(source, chunkSize);
+    const md5 = md5Hash !== undefined ? new StorageMd5() : undefined;
+    let offset = initialOffset;
+    try {
+        let current = await chunks.next();
+        for (;;) {
+            const bytes = current.done ? new Uint8Array() : current.value;
+            const next = current.done ? current : await chunks.next();
+            const sourceEnded = !!next.done;
+            const final = sourceEnded && !isPartialUpload;
+            const end = offset + bytes.length;
+            if (!Number.isSafeInteger(end) ||
+                (declaredSize !== undefined &&
+                    (end > declaredSize ||
+                        (final && end !== declaredSize) ||
+                        (isPartialUpload && end >= declaredSize))) ||
+                (sourceEnded && persisted > end) ||
+                (isPartialUpload &&
+                    (bytes.length === 0 || bytes.length % 262144 !== 0))) {
+                throw new FirebaseEdgeError({
+                    code: 'storage/invalid-argument',
+                    message: 'Input size does not match the upload session.'
+                });
+            }
+            checksum.update(bytes);
+            md5?.update(bytes);
+            const expectedMd5 = final
+                ? md5Hash === 'auto'
+                    ? md5?.digest()
+                    : md5Hash
+                : undefined;
+            const expected = final && verifyChecksum
+                ? crc32c === 'auto'
+                    ? checksum.digest()
+                    : crc32c
+                : undefined;
+            if (persisted < end || final) {
+                let attempts = 0;
+                for (;;) {
+                    // Google ignores persisted overlap; replay from a 256 KiB boundary for a valid non-final chunk.
+                    const start = final
+                        ? Math.max(offset, persisted)
+                        : offset +
+                            Math.floor((Math.max(offset, persisted) - offset) / 262144) *
+                                262144;
+                    const { error, data } = await transport.uploadChunk(session, bytes.slice(start - offset), {
+                        offset: start,
+                        totalSize: isPartialUpload
+                            ? undefined
+                            : final
+                                ? end
+                                : declaredSize,
+                        ...(expected !== undefined && { crc32c: expected }),
+                        ...(expectedMd5 !== undefined && {
+                            md5Hash: expectedMd5
+                        })
+                    });
+                    const recoverable = error &&
+                        (error.cause instanceof TypeError ||
+                            [408, 429, 500, 502, 503, 504].includes(Number(error.context &&
+                                typeof error.context === 'object' &&
+                                'status' in error.context
+                                ? error.context.status
+                                : undefined)));
+                    if (error && !recoverable) {
+                        throw error;
+                    }
+                    let progress = data;
+                    if (error) {
+                        if (attempts >= maxResumeAttempts) {
+                            throw error;
+                        }
+                        const { error: statusError, data: status } = await transport.getUploadStatus(session, final ? end : declaredSize);
+                        if (statusError) {
+                            throw statusError;
+                        }
+                        progress = status;
+                    }
+                    if (!progress) {
+                        throw new FirebaseEdgeError({
+                            code: 'storage/internal-error',
+                            message: 'Missing upload progress response.'
+                        });
+                    }
+                    if (progress.complete) {
+                        if (!final) {
+                            throw new FirebaseEdgeError({
+                                code: 'storage/internal-error',
+                                message: 'Upload completed before the input ended.'
+                            });
+                        }
+                        verifyStorageUpload(expected, progress.metadata, expectedMd5);
+                        await reportStorageProgress(onProgress, {
+                            bytesTransferred: end,
+                            totalBytes: end,
+                            complete: true
+                        });
+                        return progress.metadata;
+                    }
+                    const nextOffset = progress.nextOffset;
+                    if (nextOffset < Math.max(offset, persisted) ||
+                        nextOffset > end) {
+                        throw new FirebaseEdgeError({
+                            code: 'storage/internal-error',
+                            message: 'Upload acknowledgement falls outside the retained chunk.'
+                        });
+                    }
+                    persisted = nextOffset;
+                    await reportStorageProgress(onProgress, {
+                        bytesTransferred: persisted,
+                        totalBytes: declaredSize,
+                        complete: false
+                    });
+                    if (persisted === end && !final) {
+                        break;
+                    }
+                    if (attempts++ >= maxResumeAttempts) {
+                        throw new FirebaseEdgeError({
+                            code: 'storage/retry-limit-exceeded',
+                            message: 'Upload did not finish within the recovery limit.'
+                        });
+                    }
+                }
+            }
+            if (sourceEnded && isPartialUpload) {
+                return {
+                    complete: false,
+                    sessionUri: session,
+                    nextOffset: end,
+                    ...(initialOffset === 0 || resumeCRC32C !== undefined
+                        ? { crc32c: checksum.digest() }
+                        : {})
+                };
+            }
+            offset = end;
+            current = next;
+        }
+    }
+    finally {
+        await chunks.return(undefined);
+    }
+}
+//# sourceMappingURL=storage-upload-stream.js.map