@x12i/memorix-service 3.12.4 → 3.14.0

package/dist/writes/content-write.d.ts

@@ -0,0 +1,207 @@
+import { type DatasourceWriteInput, type LogicalV2Record, type MemorixRecordDraft, type WriterMetadataCatalog } from "@x12i/memorix-data";
+import { ServiceError } from "../errors.js";
+import type { MemorixScope } from "../scope.js";
+import { type FailureShape } from "./error-shape.js";
+import { type ReceiptError, type StoredContentWrite, type WriteOperation, type WriteReceipt, type WriteReceiptRow, type WriteReceiptStore } from "./receipt-store.js";
+export declare const CONTENT_BATCH_LIMIT = 500;
+export type ContentWriteBody = {
+    objectType?: string;
+    contentType?: string;
+    record?: Record<string, unknown>;
+    precondition?: unknown;
+    expectedRevision?: number;
+    op?: "add" | "upsert" | "patch" | "replace" | "remove";
+    patch?: unknown;
+    datasource?: unknown;
+    suppressHooks?: unknown;
+    discriminatorValue?: string;
+    writeId?: unknown;
+    subject?: unknown;
+    /** `true` accepts the row into the durable queue and returns before the document is written. */
+    queue?: unknown;
+};
+export type ContentWritePorts = {
+    writer: {
+        add(req: {
+            scope: MemorixScope;
+            precondition: {
+                kind: "absent";
+            };
+            record: MemorixRecordDraft;
+            datasource?: DatasourceWriteInput;
+            suppressHooks?: boolean;
+        }): Promise<{
+            record: LogicalV2Record;
+            created: boolean;
+            unchanged?: boolean;
+        }>;
+        upsert(req: {
+            scope: MemorixScope;
+            precondition: {
+                kind: "absent";
+            } | {
+                kind: "revision";
+                revision: number;
+            } | {
+                kind: "none";
+            };
+            record: MemorixRecordDraft;
+            datasource?: DatasourceWriteInput;
+            suppressHooks?: boolean;
+        }): Promise<{
+            record: LogicalV2Record;
+            created: boolean;
+            unchanged?: boolean;
+        }>;
+        replace(req: {
+            scope: MemorixScope;
+            precondition: {
+                kind: "revision";
+                revision: number;
+            };
+            record: MemorixRecordDraft;
+            datasource?: DatasourceWriteInput;
+            suppressHooks?: boolean;
+        }): Promise<{
+            record: LogicalV2Record;
+            created: boolean;
+            unchanged?: boolean;
+        }>;
+        patch(req: {
+            scope: MemorixScope;
+            precondition: {
+                kind: "revision";
+                revision: number;
+            };
+            objectType: string;
+            contentType: string;
+            recordId: string;
+            discriminatorValue?: string;
+            ops: unknown;
+            datasource?: DatasourceWriteInput;
+            suppressHooks?: boolean;
+        }): Promise<{
+            record: LogicalV2Record;
+            created: boolean;
+            unchanged?: boolean;
+        }>;
+        remove(req: {
+            scope: MemorixScope;
+            objectType: string;
+            contentType: string;
+            recordId: string;
+            discriminatorValue?: string;
+            precondition: {
+                kind: "revision";
+                revision: number;
+            };
+            datasource?: DatasourceWriteInput;
+            suppressHooks?: boolean;
+        }): Promise<{
+            recordId: string;
+            objectType: string;
+            contentType: string;
+            removed: true;
+            previousRevision: number;
+        }>;
+    };
+    reader: {
+        getContent(scope: MemorixScope, address: {
+            objectType: string;
+            contentType: string;
+            recordId: string;
+            discriminatorValue?: string;
+        }): Promise<LogicalV2Record>;
+    };
+    catalog: WriterMetadataCatalog;
+    publications: {
+        list(): Promise<Array<{
+            status: string;
+            publicationId: string;
+            members: Array<{
+                recordId: string;
+                objectType: string;
+                contentType: string;
+            }>;
+        }>>;
+    };
+};
+export type CommittedWrite = {
+    operation: WriteOperation;
+    objectType: string;
+    contentType: string;
+    recordId: string;
+    revision: number;
+    data?: Record<string, unknown>;
+    hooks?: {
+        queued: number;
+        subscriptionIds: string[];
+        failed?: boolean;
+    };
+};
+export type ContentWriteDeps = {
+    scope: MemorixScope;
+    caller: string;
+    datasource: DatasourceWriteInput;
+    ports: ContentWritePorts;
+    receipts: WriteReceiptStore;
+    now?: () => string;
+    onCommitted?: (event: CommittedWrite) => Promise<unknown>;
+    /** Rejects the prepared write before a receipt is opened (patch guards). */
+    checkWrite?: (request: StoredContentWrite) => Promise<void>;
+};
+/** The 202 body of a queued write. */
+export type QueuedAcceptBody = {
+    receiptId: string;
+    status: "queued";
+    storageKey: WriteReceipt["storageKey"];
+    runId: string;
+    stepId: string;
+};
+export type ContentWriteOutcome = {
+    kind: "stored";
+    httpStatus: 200;
+    body: Record<string, unknown>;
+} | {
+    kind: "pending";
+    httpStatus: 202;
+    body: {
+        receiptId: string;
+        status: "pending";
+        retryAfterMs: number;
+    };
+} | {
+    kind: "queued";
+    httpStatus: 202;
+    body: QueuedAcceptBody;
+} | {
+    kind: "rejected";
+    error: ServiceError;
+};
+export type PreparedWrite = {
+    request: StoredContentWrite;
+    contentHash: string;
+    writeId?: string;
+    wirePrecondition: unknown;
+};
+export declare function runContentWrite(deps: ContentWriteDeps, body: ContentWriteBody, replay?: WriteReceiptRow): Promise<ContentWriteOutcome>;
+export declare function runContentBatch(deps: ContentWriteDeps, body: unknown, datasourceFor: (body: ContentWriteBody) => DatasourceWriteInput): Promise<{
+    results: unknown[];
+}>;
+/** A queued row that cannot be applied after this many tries is rejected, so it cannot block its key forever. */
+export declare const QUEUE_MAX_ATTEMPTS = 50;
+export declare function queuedBody(row: WriteReceiptRow): QueuedAcceptBody;
+export declare function prepareWrite(deps: ContentWriteDeps, body: ContentWriteBody, now: string): PreparedWrite;
+export declare function storageKey(request: StoredContentWrite, recordId: string): WriteReceipt["storageKey"];
+export declare function asServiceError(err: unknown): ServiceError;
+export declare function publicError(error: ServiceError, shape: FailureShape): ReceiptError;
+export declare function batchError(err: unknown): {
+    error: {
+        code: string;
+        field: string | null;
+        message: string;
+        retryable: boolean;
+        retryAfterMs?: number;
+    };
+};
+//# sourceMappingURL=content-write.d.ts.map

package/dist/writes/content-write.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-write.d.ts","sourceRoot":"","sources":["../../src/writes/content-write.ts"],"names":[],"mappings":"AAIA,OAAO,EAIL,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAkB,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAGhD,OAAO,EAAmB,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAIL,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,eAAO,MAAM,mBAAmB,MAAM,CAAC;AAEvC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,EAAE,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;IACvD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gGAAgG;IAChG,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE;QACN,GAAG,CAAC,GAAG,EAAE;YACP,KAAK,EAAE,YAAY,CAAC;YACpB,YAAY,EAAE;gBAAE,IAAI,EAAE,QAAQ,CAAA;aAAE,CAAC;YACjC,MAAM,EAAE,kBAAkB,CAAC;YAC3B,UAAU,CAAC,EAAE,oBAAoB,CAAC;YAClC,aAAa,CAAC,EAAE,OAAO,CAAC;SACzB,GAAG,OAAO,CAAC;YAAE,MAAM,EAAE,eAAe,CAAC;YAAC,OAAO,EAAE,OAAO,CAAC;YAAC,SAAS,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QAChF,MAAM,CAAC,GAAG,EAAE;YACV,KAAK,EAAE,YAAY,CAAC;YACpB,YAAY,EAAE;gBAAE,IAAI,EAAE,QAAQ,CAAA;aAAE,GAAG;gBAAE,IAAI,EAAE,UAAU,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAA;aAAE,GAAG;gBAAE,IAAI,EAAE,MAAM,CAAA;aAAE,CAAC;YAC7F,MAAM,EAAE,kBAAkB,CAAC;YAC3B,UAAU,CAAC,EAAE,oBAAoB,CAAC;YAClC,aAAa,CAAC,EAAE,OAAO,CAAC;SACzB,GAAG,OAAO,CAAC;YAAE,MAAM,EAAE,eAAe,CAAC;YAAC,OAAO,EAAE,OAAO,CAAC;YAAC,SAAS,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QAChF,OAAO,CAAC,GAAG,EAAE;YACX,KAAK,EAAE,YAAY,CAAC;YACpB,YAAY,EAAE;gBAAE,IAAI,EAAE,UAAU,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAA;aAAE,CAAC;YACrD,MAAM,EAAE,kBAAkB,CAAC;YAC3B,UAAU,CAAC,EAAE,oBAAoB,CAAC;YAClC,aAAa,CAAC,EAAE,OAAO,CAAC;SACzB,GAAG,OAAO,CAAC;YAAE,MAAM,EAAE,eAAe,CAAC;YAAC,OAAO,EAAE,OAAO,CAAC;YAAC,SAAS,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QAChF,KAAK,CAAC,GAAG,EAAE;YACT,KAAK,EAAE,YAAY,CAAC;YACpB,YAAY,EAAE;gBAAE,IAAI,EAAE,UAAU,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAA;aAAE,CAAC;YACrD,UAAU,EAAE,MAAM,CAAC;YACnB,WAAW,EAAE,MAAM,CAAC;YACpB,QAAQ,EAAE,MAAM,CAAC;YACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAC5B,GAAG,EAAE,OAAO,CAAC;YACb,UAAU,CAAC,EAAE,oBAAoB,CAAC;YAClC,aAAa,CAAC,EAAE,OAAO,CAAC;SACzB,GAAG,OAAO,CAAC;YAAE,MAAM,EAAE,eAAe,CAAC;YAAC,OAAO,EAAE,OAAO,CAAC;YAAC,SAAS,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QAChF,MAAM,CAAC,GAAG,EAAE;YACV,KAAK,EAAE,YAAY,CAAC;YACpB,UAAU,EAAE,MAAM,CAAC;YACnB,WAAW,EAAE,MAAM,CAAC;YACpB,QAAQ,EAAE,MAAM,CAAC;YACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAC5B,YAAY,EAAE;gBAAE,IAAI,EAAE,UAAU,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAA;aAAE,CAAC;YACrD,UAAU,CAAC,EAAE,oBAAoB,CAAC;YAClC,aAAa,CAAC,EAAE,OAAO,CAAC;SACzB,GAAG,OAAO,CAAC;YACV,QAAQ,EAAE,MAAM,CAAC;YACjB,UAAU,EAAE,MAAM,CAAC;YACnB,WAAW,EAAE,MAAM,CAAC;YACpB,OAAO,EAAE,IAAI,CAAC;YACd,gBAAgB,EAAE,MAAM,CAAC;SAC1B,CAAC,CAAC;KACJ,CAAC;IACF,MAAM,EAAE;QACN,UAAU,CACR,KAAK,EAAE,YAAY,EACnB,OAAO,EAAE;YACP,UAAU,EAAE,MAAM,CAAC;YACnB,WAAW,EAAE,MAAM,CAAC;YACpB,QAAQ,EAAE,MAAM,CAAC;YACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;SAC7B,GACA,OAAO,CAAC,eAAe,CAAC,CAAC;KAC7B,CAAC;IACF,OAAO,EAAE,qBAAqB,CAAC;IAC/B,YAAY,EAAE;QACZ,IAAI,IAAI,OAAO,CACb,KAAK,CAAC;YACJ,MAAM,EAAE,MAAM,CAAC;YACf,aAAa,EAAE,MAAM,CAAC;YACtB,OAAO,EAAE,KAAK,CAAC;gBAAE,QAAQ,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAC;gBAAC,WAAW,EAAE,MAAM,CAAA;aAAE,CAAC,CAAC;SAC/E,CAAC,CACH,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,cAAc,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CACzE,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,YAAY,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,oBAAoB,CAAC;IACjC,KAAK,EAAE,iBAAiB,CAAC;IACzB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1D,4EAA4E;IAC5E,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D,CAAC;AAEF,sCAAsC;AACtC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,QAAQ,CAAC;IACjB,UAAU,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAC3B;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,UAAU,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,GAClE;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,GAAG,CAAC;IAChB,IAAI,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,SAAS,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;CACtE,GACD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,UAAU,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,gBAAgB,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,KAAK,EAAE,YAAY,CAAA;CAAE,CAAC;AAE9C,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,kBAAkB,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,wBAAsB,eAAe,CACnC,IAAI,EAAE,gBAAgB,EACtB,IAAI,EAAE,gBAAgB,EACtB,MAAM,CAAC,EAAE,eAAe,GACvB,OAAO,CAAC,mBAAmB,CAAC,CAmC9B;AAED,wBAAsB,eAAe,CACnC,IAAI,EAAE,gBAAgB,EACtB,IAAI,EAAE,OAAO,EACb,aAAa,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,oBAAoB,GAC9D,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,EAAE,CAAA;CAAE,CAAC,CAoDjC;AA4ED,iHAAiH;AACjH,eAAO,MAAM,kBAAkB,KAAK,CAAC;AA4CrC,wBAAgB,UAAU,CAAC,GAAG,EAAE,eAAe,GAAG,gBAAgB,CAUjE;AAsHD,wBAAgB,YAAY,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,GAAG,aAAa,CA8FvG;AA0KD,wBAAgB,UAAU,CAAC,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,GAAG,YAAY,CAAC,YAAY,CAAC,CAOpG;AAsDD,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,YAAY,CAczD;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,YAAY,CASlF;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG;IAAE,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAItJ"}