@substrat-run/engine-protocol 0.7.3 → 0.9.0

package/dist/schemas.js

@@ -0,0 +1,136 @@
+/**
+ * The shapes this engine PUBLISHES — what a composing vertical returns from an
+ * operation it has bound, and what reaches its API document.
+ *
+ * These existed only as TypeScript interfaces, which is enough to implement
+ * against and not enough to DECLARE against: `defineOperations` takes a schema,
+ * so without these a vertical binding `protocol/get` had nothing to point at.
+ *
+ * **Each one is asserted against its interface, in both directions.** A schema
+ * that drifts from the shape the handler actually returns is worse than no
+ * schema — it publishes a contract nobody honours, which is exactly the defect
+ * #695 found eleven times. The assertions below fail to compile if either side
+ * gains, loses or retypes a field.
+ */
+import { z } from '@substrat-run/contracts';
+import { protocolInstanceRow } from './entities.js';
+import { contentUnion } from './inputs.js';
+export const protocolTemplateRow = z.object({
+    id: z.string(),
+    key: z.string(),
+    version: z.number(),
+    title: z.string(),
+    content_json: z.string(),
+    created_at: z.string(),
+});
+export const protocolResponseRow = z.object({
+    id: z.string(),
+    instance_id: z.string(),
+    item_key: z.string(),
+    value_json: z.string(),
+    note: z.string().nullable(),
+    responded_by: z.string(),
+    responded_at: z.string(),
+});
+export const protocolSignatureRow = z.object({
+    id: z.string(),
+    instance_id: z.string(),
+    signed_by: z.string(),
+    kind: z.enum(['primary', 'counter']),
+    method: z.string(),
+    content_hash: z.string(),
+    evidence_ref: z.string().nullable(),
+    signed_at: z.string(),
+    request_id: z.string().nullable(),
+    signatory_kind: z.enum(['principal', 'external']),
+    signatory_label: z.string().nullable(),
+});
+export const protocolSignatureRequestRow = z.object({
+    id: z.string(),
+    instance_id: z.string(),
+    party_label: z.string(),
+    party_kind: z.enum(['principal', 'external']),
+    party_ref: z.string().nullable(),
+    signature_kind: z.enum(['primary', 'counter']),
+    method: z.string(),
+    auth_level: z.enum(['basic', 'strong']).nullable(),
+    contact_key_id: z.string().nullable(),
+    contact_ciphertext: z.string().nullable(),
+    status: z.enum(['pending', 'signed', 'declined', 'expired', 'cancelled']),
+    content_hash: z.string(),
+    external_ref: z.string().nullable(),
+    resolved_note: z.string().nullable(),
+    requested_by: z.string(),
+    requested_at: z.string(),
+    resolved_at: z.string().nullable(),
+});
+/**
+ * The COMPOSITE returns — what the operations answer with, as opposed to the
+ * rows above.
+ *
+ * These existed only as interfaces, and an interface is exactly as much as an
+ * operation cannot be declared against. `output` on a declared operation is a
+ * Zod schema, so without these four `protocol/get` and `protocol/sign` had
+ * nothing to point at and the engine could declare only the half of its surface
+ * that happens to return one row.
+ *
+ * They are assembled from the row schemas rather than restating their fields,
+ * so a column added to a row reaches every projection that carries it.
+ */
+export const signResult = z.object({
+    instance: protocolInstanceRow,
+    signature: protocolSignatureRow,
+});
+export const requestSignaturesResult = z.object({
+    instance: protocolInstanceRow,
+    contentHash: z.string(),
+    requests: z.array(protocolSignatureRequestRow),
+});
+export const protocolDetail = z.object({
+    instance: protocolInstanceRow,
+    template: z.object({
+        key: z.string(),
+        version: z.number(),
+        title: z.string(),
+        content: contentUnion,
+    }),
+    /** The full append-only history — every edit, in order. */
+    responses: z.array(protocolResponseRow),
+    /** Per item, last append wins — the current answers. */
+    latest: z.record(z.string(), protocolResponseRow),
+    /** The primary (issuing) signature, or null while unsigned. */
+    signature: protocolSignatureRow.nullable(),
+    /** Every row: the primary plus any counter-signatures. */
+    signatures: z.array(protocolSignatureRow),
+    requests: z.array(protocolSignatureRequestRow),
+});
+export const protocolSummary = z.object({
+    instance: protocolInstanceRow,
+    title: z.string(),
+    contentKind: z.enum(['checklist', 'document']),
+    answered: z.number(),
+    total: z.number(),
+    signedBy: z.string().nullable(),
+    signedAt: z.string().nullable(),
+    countersignedBy: z.string().nullable(),
+    countersignedAt: z.string().nullable(),
+    /** How many requested signatures are still outstanding. */
+    pendingSignatures: z.number(),
+});
+const _templateRow = true;
+const _responseRow = true;
+const _signatureRow = true;
+const _requestRow = true;
+const _signResult = true;
+const _requestResult = true;
+const _detail = true;
+const _summary = true;
+void _templateRow;
+void _responseRow;
+void _signatureRow;
+void _requestRow;
+void _signResult;
+void _requestResult;
+void _detail;
+void _summary;
+//# sourceMappingURL=schemas.js.map

package/dist/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAY3C,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;CACvB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACpC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACjD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IAC7C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC9C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClD,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;IACzE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,QAAQ,EAAE,mBAAmB;IAC7B,SAAS,EAAE,oBAAoB;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,QAAQ,EAAE,mBAAmB;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC;CAC/C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,QAAQ,EAAE,mBAAmB;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC;QACjB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;QACf,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,YAAY;KACtB,CAAC;IACF,2DAA2D;IAC3D,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;IACvC,wDAAwD;IACxD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC;IACjD,+DAA+D;IAC/D,SAAS,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IAC1C,0DAA0D;IAC1D,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;IACzC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC;CAC/C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,QAAQ,EAAE,mBAAmB;IAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IAC9C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,2DAA2D;IAC3D,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;CAC9B,CAAC,CAAC;AAQH,MAAM,YAAY,GAAoE,IAAI,CAAC;AAC3F,MAAM,YAAY,GAAoE,IAAI,CAAC;AAC3F,MAAM,aAAa,GAAsE,IAAI,CAAC;AAC9F,MAAM,WAAW,GAGb,IAAI,CAAC;AACT,MAAM,WAAW,GAAkD,IAAI,CAAC;AACxE,MAAM,cAAc,GAClB,IAAI,CAAC;AACP,MAAM,OAAO,GAA0D,IAAI,CAAC;AAC5E,MAAM,QAAQ,GAA4D,IAAI,CAAC;AAE/E,KAAK,YAAY,CAAC;AAClB,KAAK,YAAY,CAAC;AAClB,KAAK,aAAa,CAAC;AACnB,KAAK,WAAW,CAAC;AACjB,KAAK,WAAW,CAAC;AACjB,KAAK,cAAc,CAAC;AACpB,KAAK,OAAO,CAAC;AACb,KAAK,QAAQ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@substrat-run/engine-protocol",
-  "version": "0.7.3",
+  "version": "0.9.0",
   "description": "Substrat engine: protocols, checklists and signed documents with the freeze → immutable invariant — versioned templates, append-only responses, verifiable content hash, counter-signatures on frozen content, and asynchronous multi-party signatures by external (non-principal) signatories",
   "license": "AGPL-3.0-only",
   "repository": {
@@ -25,16 +25,20 @@
     "access": "public"
   },
   "dependencies": {
-    "zod": "^4.4.3",
-    "@substrat-run/contracts": "^0.71.0",
-    "@substrat-run/kernel": "^0.71.0"
+    "@substrat-run/contracts": "^0.73.0",
+    "@substrat-run/kernel": "^0.73.0"
   },
   "devDependencies": {
     "typescript": "^7.0.0",
-    "vitest": "^3.0.0",
-    "@substrat-run/model-emit": "0.1.0",
-    "@substrat-run/adapter-sqlite": "^0.71.0",
-    "@substrat-run/engine-test-kit": "^0.1.3"
+    "vitest": "^3.2.7",
+    "zod": "^4.4.3",
+    "@substrat-run/contract-tests": "^0.73.0",
+    "@substrat-run/model-emit": "0.3.0",
+    "@substrat-run/engine-test-kit": "^0.3.0",
+    "@substrat-run/adapter-sqlite": "^0.73.0"
+  },
+  "peerDependencies": {
+    "zod": "^4.4.0"
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",