@ttt-productions/media-processing-core 0.8.16 → 0.8.18

package/dist/server/storage-ops.d.ts

@@ -1,17 +1,10 @@
-import type { getStorage } from "firebase-admin/storage";
-import { R2StorageError } from "./r2-retry.js";
-export { R2StorageError };
-/**
- * A copy found an object at its destination key that is not this copy's result, and
- * wrote nothing; that object is untouched. The key is a PROPERTY, never message text, so
- * an escaping error never carries an object key to monitoring.
- */
+import type { getStorage } from 'firebase-admin/storage';
 export declare class ObjectAlreadyExistsError extends Error {
     readonly key: string;
     constructor(key: string);
 }
-/** Firebase Admin Storage Bucket — inferred to avoid @google-cloud/storage dep. */
-export type Bucket = ReturnType<ReturnType<typeof getStorage>["bucket"]>;
+/** Inferred from usage so the package takes no @google-cloud/storage dependency. */
+export type Bucket = ReturnType<ReturnType<typeof getStorage>['bucket']>;
 export interface ObjectWriteResult {
     key: string;
     sizeBytes: number;
@@ -23,71 +16,25 @@ export interface ObjectReadResult {
 }
 export interface ObjectCopyResult {
     key: string;
-    /**
-     * `true` when the destination already held this copy's result — the same source version,
-     * committed by an earlier attempt whose answer was lost or by a concurrent identical
-     * copy; `false` when this call committed it.
-     */
     alreadyPresent: boolean;
 }
-/**
- * What `deleteCopy` found at the destination: `deleted` — a copy of the source, now removed;
- * `absent` — no object; `notThisCopy` — an object this package did not copy from that
- * source, left untouched.
- */
-export type DeleteCopyResult = "deleted" | "absent" | "notThisCopy";
+export type DeleteCopyResult = 'deleted' | 'absent' | 'notThisCopy';
 export interface MediaObjectStore {
-    /**
-     * Upload a local file to the store at `key`. Objects are written with a
-     * one-year `immutable` cache-control, so keys are write-once: a replacement is
-     * written under a NEW key and the app repoints its reference to it. Overwriting
-     * an existing key would keep serving the old bytes from caches for up to a year.
-     */
+    /** Objects carry a one-year `immutable` cache-control, so a key is write-once: an overwrite keeps serving the old bytes from caches. */
     putFile(args: {
         localPath: string;
         key: string;
         contentType?: string;
     }): Promise<ObjectWriteResult>;
-    /**
-     * Server-side copy within the store. It never overwrites and is idempotent: it commits
-     * only when `toKey` holds no object, in one call that writes the destination fully
-     * formed (the source version's bytes and content headers, its provenance, and this
-     * store's token policy). When `toKey` already holds this copy's result — a retry of
-     * the same copy of the same source version — it resolves with `alreadyPresent: true`;
-     * when it holds anything else, it throws `ObjectAlreadyExistsError` and leaves that
-     * object untouched. It never deletes anything.
-     */
     copy(args: {
         fromKey: string;
         toKey: string;
     }): Promise<ObjectCopyResult>;
-    /**
-     * Download an object's bytes from the store to a local file (streamed, so a
-     * large video never sits fully in memory). Used by safety evidence capture to
-     * pull final media — which may live in a different backend (R2) — before
-     * writing it into the separate (GCS) evidence vault: capture is inherently
-     * read-here-then-write, NOT a server-side copy, because source and vault can
-     * be different backends.
-     */
     readToFile(args: {
         key: string;
         localPath: string;
     }): Promise<ObjectReadResult>;
-    /** Delete an object. Missing objects are a no-op, not an error. */
     delete(key: string): Promise<void>;
-    /**
-     * Delete `toKey` only when the object there is a copy of `fromKey` this package made: its
-     * own recorded provenance must name `fromKey` as its source. Only the destination is read,
-     * so this works after the source is gone. Any other object — a copy of another source, or
-     * one with no provenance — is left untouched and answers `notThisCopy`.
-     *
-     * Firebase Storage deletes only the generation it checked; an object replaced after the
-     * check is checked again, never deleted blind. R2's DeleteObject takes no precondition, so
-     * there the delete follows the check unconditioned. That gap is harmless only under the key
-     * contract: keys are write-once and a copy never replaces an object, so in the gap the
-     * checked object can only be removed; and a copy's key is derived from its source, so the
-     * only object that can land there afterwards is another copy of the same source.
-     */
     deleteCopy(args: {
         fromKey: string;
         toKey: string;
@@ -98,29 +45,20 @@ export interface CreateR2ObjectStoreArgs {
     accessKeyId: string;
     secretAccessKey: string;
     bucket: string;
-    /** Override for tests; defaults to the real R2 S3 endpoint. */
     endpoint?: string;
-    /** Override fetch for tests. */
     fetchImpl?: typeof fetch;
-    /** Test seam: override the retry sleep (defaults to real `setTimeout`). */
     sleepImpl?: (ms: number) => Promise<void>;
-    /** Test seam: override the backoff jitter source (defaults to `Math.random`). */
     randomImpl?: () => number;
-    /** Test seam: override the clock used for HTTP-date `Retry-After` (defaults to `Date.now`). */
     nowImpl?: () => number;
 }
 export declare function createR2ObjectStore(args: CreateR2ObjectStoreArgs): MediaObjectStore;
 export interface CreateFirebaseStorageObjectStoreArgs {
     bucket: Bucket;
 }
-/** Firebase Storage store for deployed environments. Token-free (see header). */
 export declare function createFirebaseStorageObjectStore(args: CreateFirebaseStorageObjectStoreArgs): MediaObjectStore;
 export interface CreateEmulatorObjectStoreArgs extends CreateFirebaseStorageObjectStoreArgs {
-    /** Fixed token attached to every object so deterministic emulator URLs work
-     * (token URLs bypass rules in the emulator). Pass the app's constant. */
     downloadToken: string;
 }
-/** Local dev / tests only: the Firebase Storage store plus a fixed download token. */
 export declare function createFirebaseEmulatorObjectStore(args: CreateEmulatorObjectStoreArgs): MediaObjectStore;
 export declare function getMimeFromExt(ext: string): string;
 //# sourceMappingURL=storage-ops.d.ts.map

package/dist/server/storage-ops.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-ops.d.ts","sourceRoot":"","sources":["../../src/server/storage-ops.ts"],"names":[],"mappings":"AAyBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAGzD,OAAO,EAGL,cAAc,EAEf,MAAM,eAAe,CAAC;AAKvB,OAAO,EAAE,cAAc,EAAE,CAAC;AAE1B;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;aACrB,GAAG,EAAE,MAAM;gBAAX,GAAG,EAAE,MAAM;CAIxC;AAED,mFAAmF;AACnF,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEzE,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,aAAa,CAAC;AA+CpE,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,OAAO,CAAC,IAAI,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACpG;;;;;;;;OAQG;IACH,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC1E;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAChF,mEAAmE;IACnE,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CACjF;AAQD,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;IACzB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,iFAAiF;IACjF,UAAU,CAAC,EAAE,MAAM,MAAM,CAAC;IAC1B,+FAA+F;IAC/F,OAAO,CAAC,EAAE,MAAM,MAAM,CAAC;CACxB;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,uBAAuB,GAAG,gBAAgB,CAoNnF;AAwBD,MAAM,WAAW,oCAAoC;IACnD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,iFAAiF;AACjF,wBAAgB,gCAAgC,CAAC,IAAI,EAAE,oCAAoC,GAAG,gBAAgB,CAE7G;AAED,MAAM,WAAW,6BAA8B,SAAQ,oCAAoC;IACzF;6EACyE;IACzE,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,sFAAsF;AACtF,wBAAgB,iCAAiC,CAAC,IAAI,EAAE,6BAA6B,GAAG,gBAAgB,CAEvG;AAuHD,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAsBlD"}
+{"version":3,"file":"storage-ops.d.ts","sourceRoot":"","sources":["../../src/server/storage-ops.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAczD,qBAAa,wBAAyB,SAAQ,KAAK;aACrB,GAAG,EAAE,MAAM;gBAAX,GAAG,EAAE,MAAM;CAIxC;AAED,oFAAoF;AACpF,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEzE,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,aAAa,CAAC;AA2CpE,MAAM,WAAW,gBAAgB;IAC/B,wIAAwI;IACxI,OAAO,CAAC,IAAI,EAAE;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC/B,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC1E,UAAU,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAChF,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,UAAU,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CACjF;AAID,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;IACzB,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,UAAU,CAAC,EAAE,MAAM,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,MAAM,CAAC;CACxB;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,uBAAuB,GAAG,gBAAgB,CAwMnF;AAcD,MAAM,WAAW,oCAAoC;IACnD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,gCAAgC,CAC9C,IAAI,EAAE,oCAAoC,GACzC,gBAAgB,CAElB;AAED,MAAM,WAAW,6BAA8B,SAAQ,oCAAoC;IACzF,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,wBAAgB,iCAAiC,CAC/C,IAAI,EAAE,6BAA6B,GAClC,gBAAgB,CAElB;AAsHD,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAsBlD"}