@powerhousedao/reactor-attachments 6.2.3-dev.5 → 6.2.3-dev.51

package/dist/null-attachment-transport-dg7vi6F4.d.ts

@@ -0,0 +1,327 @@
+import { C as AttachmentUploadResult, D as ReserveAttachmentOptions, E as Reservation, O as TransportFetchResult, _ as AttachmentResponse, a as IAttachmentTransport, c as IAttachmentUploadFactory, f as AttachmentDownloadOptions, h as AttachmentHeader, l as IReservationStore, m as AttachmentDownloadTargetOptions, n as IAttachmentReader, p as AttachmentDownloadTarget, r as IAttachmentService, s as IAttachmentUpload, t as IAttachmentBackend, v as AttachmentSendOptions, w as AttachmentUploadTarget, y as AttachmentStatOptions } from "./interfaces-jHW9JXv1.js";
+import { AttachmentHash, AttachmentRef, JwtHandler } from "@powerhousedao/reactor";
+//#region src/errors.d.ts
+/**
+ * Thrown when an attachment ref or hash is not known to the store.
+ */
+declare class AttachmentNotFound extends Error {
+  constructor(identifier: string);
+}
+/**
+ * Thrown when a reservation ID is not found in the reservation store.
+ */
+declare class ReservationNotFound extends Error {
+  constructor(reservationId: string);
+}
+/**
+ * Thrown when an attachment ref string does not match the expected format.
+ */
+declare class InvalidAttachmentRef extends Error {
+  constructor(ref: string);
+}
+/** The reserve metadata field that failed validation. */
+type AttachmentMetadataField = "mimeType" | "fileName" | "extension";
+/**
+ * Thrown when reserve metadata (MIME type, file name or extension) is not
+ * acceptable. Route handlers should map this to HTTP 400 Bad Request.
+ */
+declare class InvalidAttachmentMetadata extends Error {
+  readonly field: AttachmentMetadataField;
+  constructor(field: AttachmentMetadataField);
+}
+/**
+ * Thrown when an upload exceeds the configured maximum byte cap.
+ * Route handlers should map this to HTTP 413 Payload Too Large.
+ */
+declare class UploadTooLarge extends Error {
+  readonly maxBytes: number;
+  constructor(maxBytes: number);
+}
+/**
+ * Thrown by reserve() when the claimed hash is already available in the store.
+ * The caller should use err.ref directly and upload nothing -- this is the
+ * dedup fast path: duplicate content never leaves the client.
+ */
+declare class AttachmentAlreadyExists extends Error {
+  readonly hash: AttachmentHash;
+  readonly ref: AttachmentRef;
+  constructor(hash: AttachmentHash, ref: AttachmentRef);
+}
+/**
+ * Thrown by send() when the server-computed hash of the uploaded bytes
+ * does not match the hash claimed at reservation time. Nothing is committed;
+ * the reservation is retained so the client can retry with correct bytes.
+ */
+declare class HashMismatch extends Error {
+  readonly claimed: AttachmentHash;
+  readonly actual: AttachmentHash;
+  constructor(claimed: AttachmentHash, actual: AttachmentHash);
+}
+/**
+ * Thrown by send() when the uploaded byte count does not equal the
+ * sizeBytes declared at reservation time. The handle may reject
+ * mid-stream as soon as the count exceeds the declaration.
+ * Nothing is committed; the reservation is retained for retry.
+ *
+ * "actual" is the byte count received from the stream before aborting --
+ * it includes the chunk that crossed the declaration and can exceed bytes
+ * persisted. On mid-stream aborts the true total is unknown; at least
+ * "actual" bytes were sent.
+ */
+declare class SizeMismatch extends Error {
+  readonly declared: number;
+  readonly actual: number;
+  constructor(declared: number, actual: number);
+}
+/**
+ * Thrown by get() when the hash is reserved by an in-flight upload and
+ * bytes are not yet available anywhere. Deliberately NOT a subclass of
+ * AttachmentNotFound -- callers must distinguish "retry later" from "unknown".
+ * After expiresAtUtc has passed the hash reads as not found.
+ *
+ * metadata is populated when the reservation is local and its fields are
+ * known (mimeType, fileName, sizeBytes). It is undefined when the pending
+ * state is learned from a remote transport that did not supply the full
+ * Attachment-Pending header (transport-pending / degraded wire case).
+ */
+type AttachmentTransferStage = "download-target" | "switchboard-get" | "presigned-get" | "presigned-put";
+/**
+ * Thrown when a remote transfer step fails. Identifies the stage only; it
+ * intentionally carries no URL, signature query, bucket key, or bearer
+ * material so it is always safe to log or surface.
+ */
+declare class AttachmentTransferError extends Error {
+  readonly stage: AttachmentTransferStage;
+  readonly status: number | undefined;
+  constructor(stage: AttachmentTransferStage, status?: number);
+}
+declare class AttachmentPending extends Error {
+  readonly hash: AttachmentHash;
+  readonly expiresAtUtc: string;
+  readonly metadata: {
+    readonly mimeType: string;
+    readonly fileName: string;
+    readonly sizeBytes: number;
+  } | undefined;
+  constructor(hash: AttachmentHash, expiresAtUtc: string, meta?: {
+    mimeType: string;
+    fileName: string;
+    sizeBytes: number;
+  });
+}
+//#endregion
+//#region src/targets.d.ts
+declare function parseAttachmentUploadTarget(value: unknown): AttachmentUploadTarget;
+declare function parseAttachmentDownloadTarget(value: unknown): AttachmentDownloadTarget;
+//#endregion
+//#region src/attachment-service.d.ts
+declare class AttachmentService implements IAttachmentService {
+  private readonly store;
+  private readonly reservations;
+  private readonly uploadFactory;
+  private readonly backend?;
+  constructor(store: IAttachmentReader, reservations: IReservationStore, uploadFactory: IAttachmentUploadFactory, backend?: IAttachmentBackend | undefined);
+  reserve(options: ReserveAttachmentOptions): Promise<IAttachmentUpload>;
+  stat(ref: AttachmentRef, options?: AttachmentStatOptions): Promise<AttachmentHeader>;
+  get(ref: AttachmentRef, options?: AbortSignal | AttachmentDownloadOptions): Promise<AttachmentResponse>;
+  getDownloadTarget(ref: AttachmentRef, options: AttachmentDownloadTargetOptions): Promise<AttachmentDownloadTarget>;
+  private reserveHashFirst;
+}
+//#endregion
+//#region src/ref.d.ts
+type ParsedRef = {
+  version: number;
+  hash: AttachmentHash;
+};
+declare function parseRef(ref: AttachmentRef): ParsedRef;
+declare function createRef(hash: AttachmentHash, version?: number): AttachmentRef;
+//#endregion
+//#region src/switchboard/switchboard-attachment-transport.d.ts
+type SwitchboardTransportConfig = {
+  remoteUrl: string;
+  jwtHandler?: JwtHandler;
+  fetchFn?: typeof fetch;
+};
+declare class SwitchboardAttachmentTransport implements IAttachmentTransport {
+  private readonly remoteUrl;
+  private readonly jwtHandler?;
+  private readonly fetchFn;
+  constructor(config: SwitchboardTransportConfig);
+  fetch(hash: AttachmentHash, documentId: string, signal?: AbortSignal): Promise<TransportFetchResult>;
+  announce(_hash: AttachmentHash): Promise<void>;
+  push(hash: AttachmentHash, remote: string, data: ReadableStream<Uint8Array>): Promise<void>;
+  private parsePendingExpiry;
+  private parseMetadataHeaders;
+}
+//#endregion
+//#region src/switchboard/upload-transport.d.ts
+/**
+ * The seam every attachment upload PUT goes through.
+ *
+ * It exists because `fetch` cannot report upload-side progress: there is no
+ * event between "request issued" and "response received". Naming the transport
+ * lets an implementation that *can* count bytes (see
+ * `createXhrUploadTransport`) be substituted without the upload code knowing
+ * which one it holds — and it is also the right seam for a future multipart
+ * upload, which needs one request per part.
+ */
+/**
+ * Headers are forwarded VERBATIM. A presigned target's headers are part of a
+ * signature: normalizing their casing, or adding so much as one header,
+ * invalidates it.
+ */
+type AttachmentUploadRequest = {
+  url: string;
+  method: "PUT";
+  headers: Record<string, string>;
+  body: Blob;
+  /** Called with cumulative bytes handed to the socket, when observable. */
+  onProgress?: (loaded: number, total: number) => void;
+  signal?: AbortSignal;
+};
+/**
+ * The only response surface the upload code reads. A real `Response`
+ * satisfies this structurally, which is what lets the fetch transport be an
+ * identity pass-through rather than an adapter.
+ */
+type AttachmentUploadResponse = {
+  readonly status: number;
+  readonly statusText: string;
+  readonly ok: boolean;
+  json(): Promise<unknown>;
+};
+type AttachmentUploadTransport = (request: AttachmentUploadRequest) => Promise<AttachmentUploadResponse>;
+/**
+ * The default transport. Ignores `onProgress` — fetch has no upload-side
+ * progress event, and silence is how a transport reports that bytes are
+ * unobservable.
+ */
+declare function createFetchUploadTransport(fetchFn: typeof fetch): AttachmentUploadTransport;
+//#endregion
+//#region src/switchboard/xhr-upload-transport.d.ts
+type XhrUploadTransportOptions = {
+  /**
+   * Used where `XMLHttpRequest` does not exist (Node). Defaults to the global
+   * fetch, resolved at call time.
+   */
+  fetchFn?: typeof fetch;
+};
+/**
+ * Upload transport backed by `XMLHttpRequest`, the only browser API that
+ * reports upload-side byte progress (`xhr.upload.onprogress`). Everything else
+ * about the request is identical to the fetch path.
+ *
+ * Capability detection happens **inside** the returned function, never at
+ * module load: this module is reachable from the client entry, which is
+ * executed in Node by the entrypoint tests, and Node has no
+ * `XMLHttpRequest`. Detecting per call also means a test can install a fake on
+ * `globalThis` without any module-registry reset.
+ */
+declare function createXhrUploadTransport(options?: XhrUploadTransportOptions): AttachmentUploadTransport;
+//#endregion
+//#region src/switchboard/remote-reservation-store.d.ts
+type SwitchboardClientConfig = {
+  remoteUrl: string;
+  jwtHandler?: JwtHandler;
+  fetchFn?: typeof fetch;
+  /**
+   * Transport for upload PUTs only, so a browser host can opt into
+   * XMLHttpRequest and get real upload progress.
+   *
+   * An explicit `fetchFn` always wins over this. The precedence is
+   * one-directional on purpose: under this rule, adding `uploadTransport` to a
+   * config that already pins `fetchFn` is a provable no-op, whereas the
+   * reverse rule would let `{ ...config, uploadTransport }` silently route the
+   * largest request in the system around a test's mock and onto the network.
+   */
+  uploadTransport?: AttachmentUploadTransport;
+};
+declare class RemoteReservationStore implements IReservationStore {
+  private readonly remoteUrl;
+  private readonly jwtHandler?;
+  private readonly fetchFn;
+  constructor(config: SwitchboardClientConfig);
+  create(options: ReserveAttachmentOptions): Promise<Reservation>;
+  get(reservationId: string): Promise<Reservation>;
+  delete(reservationId: string): Promise<void>;
+  deleteExpired(): Promise<number>;
+}
+//#endregion
+//#region src/switchboard/remote-attachment-upload.d.ts
+declare class RemoteAttachmentUpload implements IAttachmentUpload {
+  readonly reservationId: string;
+  readonly ref: AttachmentRef | null;
+  readonly expiresAtUtc: string;
+  readonly uploadTarget?: AttachmentUploadTarget;
+  private readonly reservation;
+  private readonly remoteUrl;
+  private readonly jwtHandler?;
+  private readonly uploadTransport;
+  constructor(reservation: Reservation, config: SwitchboardClientConfig);
+  send(data: ReadableStream<Uint8Array>, options?: AttachmentSendOptions): Promise<AttachmentUploadResult>;
+  /**
+   * Direct provider upload: PUT the bytes to the presigned URL with exactly
+   * the returned headers — never the Switchboard JWT — and treat any 2xx as
+   * final success with no follow-up control request. The result is
+   * synthesized from the hash-first reservation, which is the only path that
+   * can produce a presigned target.
+   */
+  private sendPresigned;
+}
+//#endregion
+//#region src/switchboard/remote-attachment-upload-factory.d.ts
+declare class RemoteAttachmentUploadFactory implements IAttachmentUploadFactory {
+  private readonly config;
+  constructor(config: SwitchboardClientConfig);
+  createUpload(reservation: Reservation): IAttachmentUpload;
+}
+//#endregion
+//#region src/switchboard/remote-attachment-store.d.ts
+declare class RemoteAttachmentStore implements IAttachmentReader {
+  private readonly remoteUrl;
+  private readonly jwtHandler?;
+  private readonly fetchFn;
+  constructor(config: SwitchboardClientConfig);
+  /**
+   * Get attachment metadata. Normally returns a pending AttachmentHeader
+   * (status: 'pending') when the server responds 202 with a full
+   * Attachment-Pending header. When only expiresAtUtc is present in the
+   * header (degraded wire), throws AttachmentPending instead -- the
+   * AttachmentPending throw is the degraded-wire case.
+   */
+  stat(hash: AttachmentHash, documentId?: string): Promise<AttachmentHeader>;
+  get(hash: AttachmentHash, signal?: AbortSignal, documentId?: string): Promise<AttachmentResponse>;
+  /**
+   * Asks Switchboard for an authorized download target. The request carries
+   * the JWT; the response is runtime-validated before any byte transfer.
+   * Public so callers can mint direct URLs (previews, share links) without
+   * transferring bytes; `expiresIn` requests a caller-chosen lifetime.
+   */
+  getDownloadTarget(hash: AttachmentHash, options: AttachmentDownloadTargetOptions): Promise<AttachmentDownloadTarget>;
+  /**
+   * Executes a presigned GET with exactly the returned headers and no JWT.
+   * A provider 404 means the object is missing despite available metadata
+   * (the accepted abandoned-upload trade-off) and surfaces as the same typed
+   * not-found error callers already handle.
+   */
+  private fetchPresigned;
+  private fetchAttachment;
+}
+//#endregion
+//#region src/switchboard/create-remote-attachment-service.d.ts
+declare function createRemoteAttachmentService(config: SwitchboardClientConfig): IAttachmentService;
+//#endregion
+//#region src/null-attachment-transport.d.ts
+/**
+ * No-op transport for deployments without remote sync.
+ * fetch() always returns not-found, announce() and push() are no-ops.
+ */
+declare class NullAttachmentTransport implements IAttachmentTransport {
+  fetch(): Promise<TransportFetchResult>;
+  announce(): Promise<void>;
+  push(): Promise<void>;
+}
+//#endregion
+export { InvalidAttachmentRef as A, AttachmentMetadataField as C, AttachmentTransferStage as D, AttachmentTransferError as E, SizeMismatch as M, UploadTooLarge as N, HashMismatch as O, AttachmentAlreadyExists as S, AttachmentPending as T, createRef as _, RemoteAttachmentUpload as a, parseAttachmentDownloadTarget as b, XhrUploadTransportOptions as c, AttachmentUploadResponse as d, AttachmentUploadTransport as f, ParsedRef as g, SwitchboardTransportConfig as h, RemoteAttachmentUploadFactory as i, ReservationNotFound as j, InvalidAttachmentMetadata as k, createXhrUploadTransport as l, SwitchboardAttachmentTransport as m, createRemoteAttachmentService as n, RemoteReservationStore as o, createFetchUploadTransport as p, RemoteAttachmentStore as r, SwitchboardClientConfig as s, NullAttachmentTransport as t, AttachmentUploadRequest as u, parseRef as v, AttachmentNotFound as w, parseAttachmentUploadTarget as x, AttachmentService as y };
+export {};
+//# sourceMappingURL=null-attachment-transport-dg7vi6F4.d.ts.map

package/dist/null-attachment-transport-dg7vi6F4.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"null-attachment-transport-dg7vi6F4.d.ts","names":[],"sources":["../src/errors.ts","../src/targets.ts","../src/attachment-service.ts","../src/ref.ts","../src/switchboard/switchboard-attachment-transport.ts","../src/switchboard/upload-transport.ts","../src/switchboard/xhr-upload-transport.ts","../src/switchboard/remote-reservation-store.ts","../src/switchboard/remote-attachment-upload.ts","../src/switchboard/remote-attachment-upload-factory.ts","../src/switchboard/remote-attachment-store.ts","../src/switchboard/create-remote-attachment-service.ts","../src/null-attachment-transport.ts"],"mappings":";;;;;;cAKa,2BAA2B;EACtC,YAAY;;;;;cASD,4BAA4B;EACvC,YAAY;;;;;cASD,6BAA6B;EACxC,YAAY;;;KAOF;;;;;cAMC,kCAAkC;WACpC,OAAO;EAChB,YAAY,OAAO;;;;;;cAWR,uBAAuB;WACzB;EACT,YAAY;;;;;;;cAYD,gCAAgC;WAClC,MAAM;WACN,KAAK;EACd,YAAY,MAAM,gBAAgB,KAAK;;;;;;;cAa5B,qBAAqB;WACvB,SAAS;WACT,QAAQ;EACjB,YAAY,SAAS,gBAAgB,QAAQ;;;;;;;;;;;;;cAmBlC,qBAAqB;WACvB;WACA;EACT,YAAY,kBAAkB;;;;;;;;;;;;;KAmBpB;;;;;;cAWC,gCAAgC;WAClC,OAAO;WACP;EAET,YAAY,OAAO,yBAAyB;;cAYjC,0BAA0B;WAC5B,MAAM;WACN;WACA;aAEM;aACA;aACA;;EAIf,YACE,MAAM,gBACN,sBACA;IAAS;IAAkB;IAAkB;;;;;iBCzEjC,4BACd,iBACC;iBAoCa,8BACd,iBACC;;;cC3GU,6BAA6B;mBAErB;mBACA;mBACA;mBACA;EAJnB,YACmB,OAAO,mBACP,cAAc,mBACd,eAAe,0BACf,UAAU;EAGvB,QAAQ,SAAS,2BAA2B,QAAQ;EAWpD,KACJ,KAAK,eACL,UAAU,wBACT,QAAQ;EAOL,IACJ,KAAK,eACL,UAAU,cAAc,4BACvB,QAAQ;EAWX,kBACE,KAAK,eACL,SAAS,kCACR,QAAQ;UAaG;;;;KChFJ;EACV;EACA,MAAM;;iBAGQ,SAAS,KAAK,gBAAgB;iBAW9B,UACd,MAAM,gBACN,mBACC;;;KClBS;EACV;EACA,aAAa;EACb,iBAAiB;;cAGN,0CAA0C;mBACpC;mBACA;mBACA;EAEjB,YAAY,QAAQ;EAMd,MACJ,MAAM,gBACN,oBACA,SAAS,cACR,QAAQ;EAoCL,SAAS,OAAO,iBAAiB;EAIjC,KACJ,MAAM,gBACN,gBACA,MAAM,eAAe,cACpB;UAmBK;UAaA;;;;;;;;;;;;;;;;;;;KCxFE;EACV;EACA;EACA,SAAS;EACT,MAAM;;EAEN,cAAc,gBAAgB;EAC9B,SAAS;;;;;;;KAQC;WACD;WACA;WACA;EACT,QAAQ;;KAGE,6BACV,SAAS,4BACN,QAAQ;;;;;;iBAOG,2BACd,gBAAgB,QACf;;;KC1CS;;;;;EAKV,iBAAiB;;;;;;;;;;;;;iBAcH,yBACd,UAAU,4BACT;;;KCnBS;EACV;EACA,aAAa;EACb,iBAAiB;;;;;;;;;;;EAWjB,kBAAkB;;cAsDP,kCAAkC;mBAC5B;mBACA;mBACA;EAEjB,YAAY,QAAQ;EAMd,OAAO,SAAS,2BAA2B,QAAQ;EA0GnD,IAAI,wBAAwB,QAAQ;EA4CpC,OAAO,wBAAwB;EAmBrC,iBAAiB;;;;cCpON,kCAAkC;WACpC;WACA,KAAK;WACL;WACA,eAAe;mBACP;mBACA;mBACA;mBACA;EAEjB,YAAY,aAAa,aAAa,QAAQ;EAoBxC,KACJ,MAAM,eAAe,aACrB,UAAU,wBACT,QAAQ;;;;;;;;UAgFG;;;;cCtIH,yCAAyC;mBACvB;EAA7B,YAA6B,QAAQ;EAErC,aAAa,aAAa,cAAc;;;;cC8K7B,iCAAiC;mBAC3B;mBACA;mBACA;EAEjB,YAAY,QAAQ;;;;;;;;EAad,KACJ,MAAM,gBACN,sBACC,QAAQ;EAyCL,IACJ,MAAM,gBACN,SAAS,aACT,sBACC,QAAQ;;;;;;;EAiBL,kBACJ,MAAM,gBACN,SAAS,kCACR,QAAQ;;;;;;;UAgCG;UAsBA;;;;iBC5TA,8BACd,QAAQ,0BACP;;;;;;;cCJU,mCAAmC;EAC9C,SAAS,QAAQ;EAIjB,YAAY;EAIZ,QAAQ"}