@spacefast/common 0.0.24 → 0.2.1

package/dist/contracts/content-sync.d.ts

@@ -0,0 +1,290 @@
+import { z } from "zod";
+export declare const syncLedgerV1Schema: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+    source: z.ZodString;
+    baseMarkdown: z.ZodString;
+    markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    blocksDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    wordpressRevisionId: z.ZodNumber;
+    serializerVersion: z.ZodLiteral<1>;
+    revision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    lastDirection: z.ZodEnum<{
+        push: "push";
+        pull: "pull";
+    }>;
+}, z.core.$strict>;
+export type SyncLedgerV1 = z.infer<typeof syncLedgerV1Schema>;
+export declare const syncReconcileInputV1Schema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    state: z.ZodLiteral<"initial">;
+    bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+    source: z.ZodString;
+    markdown: z.ZodString;
+    observedSourceRevision: z.ZodString;
+    operationId: z.ZodTemplateLiteral<`op_${string}`>;
+}, z.core.$strict>, z.ZodObject<{
+    state: z.ZodLiteral<"bound">;
+    baseRevision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+    source: z.ZodString;
+    markdown: z.ZodString;
+    observedSourceRevision: z.ZodString;
+    operationId: z.ZodTemplateLiteral<`op_${string}`>;
+}, z.core.$strict>], "state">;
+export type SyncReconcileInputV1 = z.infer<typeof syncReconcileInputV1Schema>;
+export declare const syncReceiptV1Schema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    status: z.ZodLiteral<"created">;
+    format: z.ZodLiteral<"spacefast.markdown-sync">;
+    version: z.ZodLiteral<1>;
+    operationId: z.ZodTemplateLiteral<`op_${string}`>;
+    ledger: z.ZodObject<{
+        version: z.ZodLiteral<1>;
+        bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+        source: z.ZodString;
+        baseMarkdown: z.ZodString;
+        markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        blocksDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        wordpressRevisionId: z.ZodNumber;
+        serializerVersion: z.ZodLiteral<1>;
+        revision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        lastDirection: z.ZodEnum<{
+            push: "push";
+            pull: "pull";
+        }>;
+    }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    status: z.ZodLiteral<"unchanged">;
+    format: z.ZodLiteral<"spacefast.markdown-sync">;
+    version: z.ZodLiteral<1>;
+    operationId: z.ZodTemplateLiteral<`op_${string}`>;
+    ledger: z.ZodObject<{
+        version: z.ZodLiteral<1>;
+        bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+        source: z.ZodString;
+        baseMarkdown: z.ZodString;
+        markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        blocksDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        wordpressRevisionId: z.ZodNumber;
+        serializerVersion: z.ZodLiteral<1>;
+        revision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        lastDirection: z.ZodEnum<{
+            push: "push";
+            pull: "pull";
+        }>;
+    }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    status: z.ZodLiteral<"pushed">;
+    format: z.ZodLiteral<"spacefast.markdown-sync">;
+    version: z.ZodLiteral<1>;
+    operationId: z.ZodTemplateLiteral<`op_${string}`>;
+    ledger: z.ZodObject<{
+        version: z.ZodLiteral<1>;
+        bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+        source: z.ZodString;
+        baseMarkdown: z.ZodString;
+        markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        blocksDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        wordpressRevisionId: z.ZodNumber;
+        serializerVersion: z.ZodLiteral<1>;
+        revision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        lastDirection: z.ZodEnum<{
+            push: "push";
+            pull: "pull";
+        }>;
+    }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    status: z.ZodLiteral<"pulled">;
+    sourceWrite: z.ZodObject<{
+        state: z.ZodLiteral<"prepared">;
+        source: z.ZodString;
+        expectedSourceRevision: z.ZodString;
+        markdown: z.ZodString;
+        markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    }, z.core.$strict>;
+    format: z.ZodLiteral<"spacefast.markdown-sync">;
+    version: z.ZodLiteral<1>;
+    operationId: z.ZodTemplateLiteral<`op_${string}`>;
+    ledger: z.ZodObject<{
+        version: z.ZodLiteral<1>;
+        bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+        source: z.ZodString;
+        baseMarkdown: z.ZodString;
+        markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        blocksDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        wordpressRevisionId: z.ZodNumber;
+        serializerVersion: z.ZodLiteral<1>;
+        revision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        lastDirection: z.ZodEnum<{
+            push: "push";
+            pull: "pull";
+        }>;
+    }, z.core.$strict>;
+}, z.core.$strict>], "status">;
+export type SyncReceiptV1 = z.infer<typeof syncReceiptV1Schema>;
+export declare const syncReconciliationExchangeV1Schema: z.ZodObject<{
+    request: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        state: z.ZodLiteral<"initial">;
+        bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+        source: z.ZodString;
+        markdown: z.ZodString;
+        observedSourceRevision: z.ZodString;
+        operationId: z.ZodTemplateLiteral<`op_${string}`>;
+    }, z.core.$strict>, z.ZodObject<{
+        state: z.ZodLiteral<"bound">;
+        baseRevision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+        source: z.ZodString;
+        markdown: z.ZodString;
+        observedSourceRevision: z.ZodString;
+        operationId: z.ZodTemplateLiteral<`op_${string}`>;
+    }, z.core.$strict>], "state">;
+    receipt: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        status: z.ZodLiteral<"created">;
+        format: z.ZodLiteral<"spacefast.markdown-sync">;
+        version: z.ZodLiteral<1>;
+        operationId: z.ZodTemplateLiteral<`op_${string}`>;
+        ledger: z.ZodObject<{
+            version: z.ZodLiteral<1>;
+            bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+            source: z.ZodString;
+            baseMarkdown: z.ZodString;
+            markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            blocksDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            wordpressRevisionId: z.ZodNumber;
+            serializerVersion: z.ZodLiteral<1>;
+            revision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            lastDirection: z.ZodEnum<{
+                push: "push";
+                pull: "pull";
+            }>;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        status: z.ZodLiteral<"unchanged">;
+        format: z.ZodLiteral<"spacefast.markdown-sync">;
+        version: z.ZodLiteral<1>;
+        operationId: z.ZodTemplateLiteral<`op_${string}`>;
+        ledger: z.ZodObject<{
+            version: z.ZodLiteral<1>;
+            bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+            source: z.ZodString;
+            baseMarkdown: z.ZodString;
+            markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            blocksDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            wordpressRevisionId: z.ZodNumber;
+            serializerVersion: z.ZodLiteral<1>;
+            revision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            lastDirection: z.ZodEnum<{
+                push: "push";
+                pull: "pull";
+            }>;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        status: z.ZodLiteral<"pushed">;
+        format: z.ZodLiteral<"spacefast.markdown-sync">;
+        version: z.ZodLiteral<1>;
+        operationId: z.ZodTemplateLiteral<`op_${string}`>;
+        ledger: z.ZodObject<{
+            version: z.ZodLiteral<1>;
+            bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+            source: z.ZodString;
+            baseMarkdown: z.ZodString;
+            markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            blocksDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            wordpressRevisionId: z.ZodNumber;
+            serializerVersion: z.ZodLiteral<1>;
+            revision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            lastDirection: z.ZodEnum<{
+                push: "push";
+                pull: "pull";
+            }>;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        status: z.ZodLiteral<"pulled">;
+        sourceWrite: z.ZodObject<{
+            state: z.ZodLiteral<"prepared">;
+            source: z.ZodString;
+            expectedSourceRevision: z.ZodString;
+            markdown: z.ZodString;
+            markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        }, z.core.$strict>;
+        format: z.ZodLiteral<"spacefast.markdown-sync">;
+        version: z.ZodLiteral<1>;
+        operationId: z.ZodTemplateLiteral<`op_${string}`>;
+        ledger: z.ZodObject<{
+            version: z.ZodLiteral<1>;
+            bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+            source: z.ZodString;
+            baseMarkdown: z.ZodString;
+            markdownDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            blocksDigest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            wordpressRevisionId: z.ZodNumber;
+            serializerVersion: z.ZodLiteral<1>;
+            revision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            lastDirection: z.ZodEnum<{
+                push: "push";
+                pull: "pull";
+            }>;
+        }, z.core.$strict>;
+    }, z.core.$strict>], "status">;
+}, z.core.$strict>;
+export type SyncReconciliationExchangeV1 = z.infer<typeof syncReconciliationExchangeV1Schema>;
+export declare const syncSourceAcknowledgementV1Schema: z.ZodObject<{
+    format: z.ZodLiteral<"spacefast.markdown-sync-ack">;
+    version: z.ZodLiteral<1>;
+    bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+    operationId: z.ZodTemplateLiteral<`op_${string}`>;
+    sourceRevision: z.ZodString;
+    baseRevision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+}, z.core.$strict>;
+export type SyncSourceAcknowledgementV1 = z.infer<typeof syncSourceAcknowledgementV1Schema>;
+export declare const contentMarkdownConflictDetailsSchema: z.ZodObject<{
+    bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+    base: z.ZodObject<{
+        markdown: z.ZodString;
+        digest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        revision: z.ZodString;
+    }, z.core.$strict>;
+    source: z.ZodObject<{
+        markdown: z.ZodString;
+        digest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        revision: z.ZodString;
+    }, z.core.$strict>;
+    wordpress: z.ZodObject<{
+        markdown: z.ZodString;
+        digest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        revision: z.ZodString;
+        wordpressRevisionId: z.ZodNumber;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export type ContentMarkdownConflictDetails = z.infer<typeof contentMarkdownConflictDetailsSchema>;
+export declare const contentMarkdownConflictProblemSchema: z.ZodObject<{
+    type: z.ZodString;
+    title: z.ZodString;
+    detail: z.ZodString;
+    pointer: z.ZodOptional<z.ZodString>;
+    suggestions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    next: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    requestId: z.ZodString;
+    status: z.ZodLiteral<409>;
+    code: z.ZodLiteral<"content_markdown_conflict">;
+    details: z.ZodObject<{
+        bindingId: z.core.$ZodBranded<z.ZodString, "ContentSyncBindingId", "out">;
+        base: z.ZodObject<{
+            markdown: z.ZodString;
+            digest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            revision: z.ZodString;
+        }, z.core.$strict>;
+        source: z.ZodObject<{
+            markdown: z.ZodString;
+            digest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            revision: z.ZodString;
+        }, z.core.$strict>;
+        wordpress: z.ZodObject<{
+            markdown: z.ZodString;
+            digest: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+            revision: z.ZodString;
+            wordpressRevisionId: z.ZodNumber;
+        }, z.core.$strict>;
+    }, z.core.$strict>;
+}, z.core.$strip>;
+export type ContentMarkdownConflictProblem = z.infer<typeof contentMarkdownConflictProblemSchema>;

package/dist/contracts/content-sync.js

@@ -0,0 +1,167 @@
+import { z } from "zod";
+import { ProblemDetailsSchema } from "./common.js";
+import { contentProgramSha256Schema, contentSyncBindingIdSchema, contentSyncSourcePathSchema, } from "./content-program.js";
+import { registeredIdSchema } from "./ids.js";
+const syncMarkdownSchema = z.string().max(1_000_000);
+const contentSyncSourceRevisionSchema = z.string().min(1).max(512);
+export const syncLedgerV1Schema = z
+    .object({
+    version: z.literal(1),
+    bindingId: contentSyncBindingIdSchema,
+    source: contentSyncSourcePathSchema,
+    baseMarkdown: syncMarkdownSchema,
+    markdownDigest: contentProgramSha256Schema,
+    blocksDigest: contentProgramSha256Schema,
+    wordpressRevisionId: z.number().int().positive(),
+    serializerVersion: z.literal(1),
+    revision: contentProgramSha256Schema,
+    lastDirection: z.enum(["push", "pull"]),
+})
+    .strict();
+const syncReconcileInputFields = {
+    bindingId: contentSyncBindingIdSchema,
+    source: contentSyncSourcePathSchema,
+    markdown: syncMarkdownSchema,
+    observedSourceRevision: contentSyncSourceRevisionSchema,
+    operationId: registeredIdSchema("op"),
+};
+export const syncReconcileInputV1Schema = z.discriminatedUnion("state", [
+    z.object({ ...syncReconcileInputFields, state: z.literal("initial") }).strict(),
+    z
+        .object({
+        ...syncReconcileInputFields,
+        state: z.literal("bound"),
+        baseRevision: contentProgramSha256Schema,
+    })
+        .strict(),
+]);
+const syncReceiptFields = {
+    format: z.literal("spacefast.markdown-sync"),
+    version: z.literal(1),
+    operationId: registeredIdSchema("op"),
+    ledger: syncLedgerV1Schema,
+};
+export const syncReceiptV1Schema = z
+    .discriminatedUnion("status", [
+    z.object({ ...syncReceiptFields, status: z.literal("created") }).strict(),
+    z.object({ ...syncReceiptFields, status: z.literal("unchanged") }).strict(),
+    z.object({ ...syncReceiptFields, status: z.literal("pushed") }).strict(),
+    z
+        .object({
+        ...syncReceiptFields,
+        status: z.literal("pulled"),
+        sourceWrite: z
+            .object({
+            state: z.literal("prepared"),
+            source: contentSyncSourcePathSchema,
+            expectedSourceRevision: contentSyncSourceRevisionSchema,
+            markdown: syncMarkdownSchema,
+            markdownDigest: contentProgramSha256Schema,
+        })
+            .strict(),
+    })
+        .strict(),
+])
+    .superRefine((receipt, context) => {
+    if ((receipt.status === "pushed" && receipt.ledger.lastDirection !== "push") ||
+        (receipt.status === "pulled" && receipt.ledger.lastDirection !== "pull")) {
+        context.addIssue({
+            code: "custom",
+            path: ["ledger", "lastDirection"],
+            message: `${receipt.status} receipts require a ${receipt.status === "pushed" ? "push" : "pull"} ledger direction`,
+        });
+    }
+    if (receipt.status !== "pulled")
+        return;
+    if (receipt.sourceWrite.source !== receipt.ledger.source) {
+        context.addIssue({
+            code: "custom",
+            path: ["sourceWrite", "source"],
+            message: "prepared source write must target the ledger source",
+        });
+    }
+    if (receipt.sourceWrite.markdown !== receipt.ledger.baseMarkdown) {
+        context.addIssue({
+            code: "custom",
+            path: ["sourceWrite", "markdown"],
+            message: "prepared source write must contain the reconciled ledger markdown",
+        });
+    }
+    if (receipt.sourceWrite.markdownDigest !== receipt.ledger.markdownDigest) {
+        context.addIssue({
+            code: "custom",
+            path: ["sourceWrite", "markdownDigest"],
+            message: "prepared source write digest must match the ledger markdown digest",
+        });
+    }
+});
+export const syncReconciliationExchangeV1Schema = z
+    .object({
+    request: syncReconcileInputV1Schema,
+    receipt: syncReceiptV1Schema,
+})
+    .strict()
+    .superRefine((exchange, context) => {
+    if (exchange.receipt.operationId !== exchange.request.operationId) {
+        context.addIssue({
+            code: "custom",
+            path: ["receipt", "operationId"],
+            message: "sync receipt must bind the request operation",
+        });
+    }
+    if (exchange.receipt.ledger.bindingId !== exchange.request.bindingId) {
+        context.addIssue({
+            code: "custom",
+            path: ["receipt", "ledger", "bindingId"],
+            message: "sync receipt must bind the requested document",
+        });
+    }
+    if (exchange.receipt.ledger.source !== exchange.request.source) {
+        context.addIssue({
+            code: "custom",
+            path: ["receipt", "ledger", "source"],
+            message: "sync receipt ledger must bind the requested source",
+        });
+    }
+    if (exchange.receipt.status === "pulled" &&
+        exchange.receipt.sourceWrite.expectedSourceRevision !==
+            exchange.request.observedSourceRevision) {
+        context.addIssue({
+            code: "custom",
+            path: ["receipt", "sourceWrite", "expectedSourceRevision"],
+            message: "prepared source writes must compare-and-swap the observed source revision",
+        });
+    }
+});
+export const syncSourceAcknowledgementV1Schema = z
+    .object({
+    format: z.literal("spacefast.markdown-sync-ack"),
+    version: z.literal(1),
+    bindingId: contentSyncBindingIdSchema,
+    operationId: registeredIdSchema("op"),
+    sourceRevision: contentSyncSourceRevisionSchema,
+    baseRevision: contentProgramSha256Schema,
+})
+    .strict();
+const syncConflictRepresentationSchema = z
+    .object({
+    markdown: syncMarkdownSchema,
+    digest: contentProgramSha256Schema,
+    revision: z.string().min(1).max(512),
+})
+    .strict();
+export const contentMarkdownConflictDetailsSchema = z
+    .object({
+    bindingId: contentSyncBindingIdSchema,
+    base: syncConflictRepresentationSchema,
+    source: syncConflictRepresentationSchema,
+    wordpress: syncConflictRepresentationSchema.extend({
+        wordpressRevisionId: z.number().int().positive(),
+    }),
+})
+    .strict();
+export const contentMarkdownConflictProblemSchema = ProblemDetailsSchema.extend({
+    status: z.literal(409),
+    code: z.literal("content_markdown_conflict"),
+    details: contentMarkdownConflictDetailsSchema,
+});