@openvtc/trust-tasks 0.8.2 → 0.9.0

package/dist/vta/webvh/dids/update/1.0/payload.d.ts

@@ -84,16 +84,294 @@ export type Payload = WebVHDIDUpdatePayload;
 export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/webvh/dids/update/1.0#response";
 /** Stable alias for this specification's success-response payload shape. */
 export type Response = WebVHDIDUpdateResponsePayload;
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vta/webvh/dids/update/1.0";
+    readonly title: "WebVH DID Update — payload";
+    readonly description: "Ask a Verifiable Trust Agent to publish a new entry in a did:webvh log it holds the update key for. The agent decides whether to do so; the caller proposes.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["did"];
+    readonly properties: {
+        readonly did: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "The did:webvh being updated. The agent MUST verify it speaks for this subject.";
+        };
+        readonly document: {
+            readonly type: "object";
+            readonly description: "The new DID document. Omit to leave it unchanged. Supplying this ROTATES the DID's update key and refreshes its pre-rotation commitments, as a parallel consequence of the change — a consequence not visible anywhere in this payload, because it lives in the executing handler's semantics. A consent surface MUST therefore render effects the executor computed, and MUST NOT derive them from this document.";
+        };
+        readonly preRotationCount: {
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly description: "Number of pre-rotation commitments to publish. Omit to keep the current count; `0` disables pre-rotation going forward.";
+        };
+        readonly witnesses: {
+            readonly description: "New witness configuration. Omit to keep the current one.";
+        };
+        readonly watchers: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+            readonly description: "New watcher URLs. Omit to keep the current set; an empty array removes them.";
+        };
+        readonly ttl: {
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly description: "New TTL in seconds. Omit to keep the current value.";
+        };
+        readonly label: {
+            readonly type: "string";
+            readonly description: "Operator-facing audit label.";
+        };
+        readonly expectedVersionId: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "Optimistic-concurrency precondition: the versionId the caller based this edit on. The agent MUST refuse the update if the DID's latest entry no longer matches. Without it a `get -> edit -> save` cycle silently overwrites a concurrent edit with a chain that is structurally valid, verifies perfectly, and is based on a stale read. Where a human approves the update the window is minutes wide, so this is a routine race rather than an exotic one. OPTIONAL because a scripted caller with no concurrent writers has nothing to protect against; not optional for anything a person looked at.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "WebVH DID Update — response payload";
+            readonly description: "The published entry. camelCase per the framework convention — note the counts are the state AFTER the update, including the rotation the caller did not ask for.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["did", "newVersionId"];
+            readonly properties: {
+                readonly did: {
+                    readonly type: "string";
+                };
+                readonly newVersionId: {
+                    readonly type: "string";
+                    readonly description: "versionId of the entry just appended. A caller intending a further edit SHOULD pass this back as the next request's `expectedVersionId`.";
+                };
+                readonly newScid: {
+                    readonly type: "string";
+                };
+                readonly newLogEntry: {
+                    readonly type: "string";
+                    readonly description: "The appended log entry, as JSON text.";
+                };
+                readonly updateKeysCount: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Update keys authorized AFTER this entry. Where `document` was supplied these are new keys — the previous ones no longer authorize anything.";
+                };
+                readonly preRotationKeyCount: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Pre-rotation commitments published by this entry.";
+                };
+                readonly serverless: {
+                    readonly type: "boolean";
+                    readonly description: "True when the agent holds the log itself and no hosting server was published to — the operator must fetch and redeploy `did.jsonl`.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly description: "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "WebVH DID Update — response payload";
+            readonly description: "The published entry. camelCase per the framework convention — note the counts are the state AFTER the update, including the rotation the caller did not ask for.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["did", "newVersionId"];
+            readonly properties: {
+                readonly did: {
+                    readonly type: "string";
+                };
+                readonly newVersionId: {
+                    readonly type: "string";
+                    readonly description: "versionId of the entry just appended. A caller intending a further edit SHOULD pass this back as the next request's `expectedVersionId`.";
+                };
+                readonly newScid: {
+                    readonly type: "string";
+                };
+                readonly newLogEntry: {
+                    readonly type: "string";
+                    readonly description: "The appended log entry, as JSON text.";
+                };
+                readonly updateKeysCount: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Update keys authorized AFTER this entry. Where `document` was supplied these are new keys — the previous ones no longer authorize anything.";
+                };
+                readonly preRotationKeyCount: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Pre-rotation commitments published by this entry.";
+                };
+                readonly serverless: {
+                    readonly type: "boolean";
+                    readonly description: "True when the agent holds the log itself and no hosting server was published to — the operator must fetch and redeploy `did.jsonl`.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly description: "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+    };
+};
 /**
  * SPEC.md §7.2 policy for the request variant, from this specification's
  * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
- * per-specification and cannot be derived from the document alone.
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
  */
 export declare const SPEC: {
     readonly typeUri: "https://trusttasks.org/spec/vta/webvh/dids/update/1.0";
     readonly isBearer: false;
     readonly isProofRequired: true;
     readonly isRecipientRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vta/webvh/dids/update/1.0";
+        readonly title: "WebVH DID Update — payload";
+        readonly description: "Ask a Verifiable Trust Agent to publish a new entry in a did:webvh log it holds the update key for. The agent decides whether to do so; the caller proposes.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["did"];
+        readonly properties: {
+            readonly did: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "The did:webvh being updated. The agent MUST verify it speaks for this subject.";
+            };
+            readonly document: {
+                readonly type: "object";
+                readonly description: "The new DID document. Omit to leave it unchanged. Supplying this ROTATES the DID's update key and refreshes its pre-rotation commitments, as a parallel consequence of the change — a consequence not visible anywhere in this payload, because it lives in the executing handler's semantics. A consent surface MUST therefore render effects the executor computed, and MUST NOT derive them from this document.";
+            };
+            readonly preRotationCount: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly description: "Number of pre-rotation commitments to publish. Omit to keep the current count; `0` disables pre-rotation going forward.";
+            };
+            readonly witnesses: {
+                readonly description: "New witness configuration. Omit to keep the current one.";
+            };
+            readonly watchers: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "New watcher URLs. Omit to keep the current set; an empty array removes them.";
+            };
+            readonly ttl: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly description: "New TTL in seconds. Omit to keep the current value.";
+            };
+            readonly label: {
+                readonly type: "string";
+                readonly description: "Operator-facing audit label.";
+            };
+            readonly expectedVersionId: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "Optimistic-concurrency precondition: the versionId the caller based this edit on. The agent MUST refuse the update if the DID's latest entry no longer matches. Without it a `get -> edit -> save` cycle silently overwrites a concurrent edit with a chain that is structurally valid, verifies perfectly, and is based on a stale read. Where a human approves the update the window is minutes wide, so this is a routine race rather than an exotic one. OPTIONAL because a scripted caller with no concurrent writers has nothing to protect against; not optional for anything a person looked at.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "WebVH DID Update — response payload";
+                readonly description: "The published entry. camelCase per the framework convention — note the counts are the state AFTER the update, including the rotation the caller did not ask for.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["did", "newVersionId"];
+                readonly properties: {
+                    readonly did: {
+                        readonly type: "string";
+                    };
+                    readonly newVersionId: {
+                        readonly type: "string";
+                        readonly description: "versionId of the entry just appended. A caller intending a further edit SHOULD pass this back as the next request's `expectedVersionId`.";
+                    };
+                    readonly newScid: {
+                        readonly type: "string";
+                    };
+                    readonly newLogEntry: {
+                        readonly type: "string";
+                        readonly description: "The appended log entry, as JSON text.";
+                    };
+                    readonly updateKeysCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Update keys authorized AFTER this entry. Where `document` was supplied these are new keys — the previous ones no longer authorize anything.";
+                    };
+                    readonly preRotationKeyCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Pre-rotation commitments published by this entry.";
+                    };
+                    readonly serverless: {
+                        readonly type: "boolean";
+                        readonly description: "True when the agent holds the log itself and no hosting server was published to — the operator must fetch and redeploy `did.jsonl`.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly description: "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+        };
+    };
 };
 /**
  * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
@@ -105,5 +383,62 @@ export declare const RESPONSE_SPEC: {
     readonly isBearer: false;
     readonly isProofRequired: true;
     readonly isRecipientRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "WebVH DID Update — response payload";
+                readonly description: "The published entry. camelCase per the framework convention — note the counts are the state AFTER the update, including the rotation the caller did not ask for.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["did", "newVersionId"];
+                readonly properties: {
+                    readonly did: {
+                        readonly type: "string";
+                    };
+                    readonly newVersionId: {
+                        readonly type: "string";
+                        readonly description: "versionId of the entry just appended. A caller intending a further edit SHOULD pass this back as the next request's `expectedVersionId`.";
+                    };
+                    readonly newScid: {
+                        readonly type: "string";
+                    };
+                    readonly newLogEntry: {
+                        readonly type: "string";
+                        readonly description: "The appended log entry, as JSON text.";
+                    };
+                    readonly updateKeysCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Update keys authorized AFTER this entry. Where `document` was supplied these are new keys — the previous ones no longer authorize anything.";
+                    };
+                    readonly preRotationKeyCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Pre-rotation commitments published by this entry.";
+                    };
+                    readonly serverless: {
+                        readonly type: "boolean";
+                        readonly description: "True when the agent holds the log itself and no hosting server was published to — the operator must fetch and redeploy `did.jsonl`.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly description: "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+        };
+    };
 };
 //# sourceMappingURL=payload.d.ts.map

package/dist/vta/webvh/dids/update/1.0/payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vta/webvh/dids/update/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,CAAC;IACd;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;KAClC,CAAC;IACF;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAClC;AACD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,uDAAgE,CAAC;AAEzF,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,qBAAqB,CAAC;AAE5C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,gEAAyE,CAAC;AAE3G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,6BAA6B,CAAC;AAErD;;;;GAIG;AACH,eAAO,MAAM,IAAI;;;;;CAKP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;CAKhB,CAAC"}
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vta/webvh/dids/update/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,CAAC;IACd;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;KAClC,CAAC;IACF;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CAClC;AACD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,uDAAgE,CAAC;AAEzF,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,qBAAqB,CAAC;AAE5C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,gEAAyE,CAAC;AAE3G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,6BAA6B,CAAC;AAErD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6GjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2D1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAMP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAMhB,CAAC"}

package/dist/vta/webvh/dids/update/1.0/payload.js

@@ -6,16 +6,198 @@
 export const TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/update/1.0";
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/update/1.0#response";
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://trusttasks.org/spec/vta/webvh/dids/update/1.0",
+    "title": "WebVH DID Update — payload",
+    "description": "Ask a Verifiable Trust Agent to publish a new entry in a did:webvh log it holds the update key for. The agent decides whether to do so; the caller proposes.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "did"
+    ],
+    "properties": {
+        "did": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The did:webvh being updated. The agent MUST verify it speaks for this subject."
+        },
+        "document": {
+            "type": "object",
+            "description": "The new DID document. Omit to leave it unchanged. Supplying this ROTATES the DID's update key and refreshes its pre-rotation commitments, as a parallel consequence of the change — a consequence not visible anywhere in this payload, because it lives in the executing handler's semantics. A consent surface MUST therefore render effects the executor computed, and MUST NOT derive them from this document."
+        },
+        "preRotationCount": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Number of pre-rotation commitments to publish. Omit to keep the current count; `0` disables pre-rotation going forward."
+        },
+        "witnesses": {
+            "description": "New witness configuration. Omit to keep the current one."
+        },
+        "watchers": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "New watcher URLs. Omit to keep the current set; an empty array removes them."
+        },
+        "ttl": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "New TTL in seconds. Omit to keep the current value."
+        },
+        "label": {
+            "type": "string",
+            "description": "Operator-facing audit label."
+        },
+        "expectedVersionId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Optimistic-concurrency precondition: the versionId the caller based this edit on. The agent MUST refuse the update if the DID's latest entry no longer matches. Without it a `get -> edit -> save` cycle silently overwrites a concurrent edit with a chain that is structurally valid, verifies perfectly, and is based on a stale read. Where a human approves the update the window is minutes wide, so this is a routine race rather than an exotic one. OPTIONAL because a scripted caller with no concurrent writers has nothing to protect against; not optional for anything a person looked at."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "WebVH DID Update — response payload",
+            "description": "The published entry. camelCase per the framework convention — note the counts are the state AFTER the update, including the rotation the caller did not ask for.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "did",
+                "newVersionId"
+            ],
+            "properties": {
+                "did": {
+                    "type": "string"
+                },
+                "newVersionId": {
+                    "type": "string",
+                    "description": "versionId of the entry just appended. A caller intending a further edit SHOULD pass this back as the next request's `expectedVersionId`."
+                },
+                "newScid": {
+                    "type": "string"
+                },
+                "newLogEntry": {
+                    "type": "string",
+                    "description": "The appended log entry, as JSON text."
+                },
+                "updateKeysCount": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Update keys authorized AFTER this entry. Where `document` was supplied these are new keys — the previous ones no longer authorize anything."
+                },
+                "preRotationKeyCount": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Pre-rotation commitments published by this entry."
+                },
+                "serverless": {
+                    "type": "boolean",
+                    "description": "True when the agent holds the log itself and no hosting server was published to — the operator must fetch and redeploy `did.jsonl`."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "Ext": {
+            "title": "Ext",
+            "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": true,
+            "propertyNames": {
+                "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+            }
+        }
+    }
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$ref": "#/$defs/Response",
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "WebVH DID Update — response payload",
+            "description": "The published entry. camelCase per the framework convention — note the counts are the state AFTER the update, including the rotation the caller did not ask for.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "did",
+                "newVersionId"
+            ],
+            "properties": {
+                "did": {
+                    "type": "string"
+                },
+                "newVersionId": {
+                    "type": "string",
+                    "description": "versionId of the entry just appended. A caller intending a further edit SHOULD pass this back as the next request's `expectedVersionId`."
+                },
+                "newScid": {
+                    "type": "string"
+                },
+                "newLogEntry": {
+                    "type": "string",
+                    "description": "The appended log entry, as JSON text."
+                },
+                "updateKeysCount": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Update keys authorized AFTER this entry. Where `document` was supplied these are new keys — the previous ones no longer authorize anything."
+                },
+                "preRotationKeyCount": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Pre-rotation commitments published by this entry."
+                },
+                "serverless": {
+                    "type": "boolean",
+                    "description": "True when the agent holds the log itself and no hosting server was published to — the operator must fetch and redeploy `did.jsonl`."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "Ext": {
+            "title": "Ext",
+            "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": true,
+            "propertyNames": {
+                "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+            }
+        }
+    }
+};
 /**
  * SPEC.md §7.2 policy for the request variant, from this specification's
  * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
- * per-specification and cannot be derived from the document alone.
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
  */
 export const SPEC = {
     typeUri: TYPE_URI,
     isBearer: false,
     isProofRequired: true,
     isRecipientRequired: true,
+    payloadSchema: PAYLOAD_SCHEMA,
 };
 /**
  * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
@@ -27,5 +209,6 @@ export const RESPONSE_SPEC = {
     isBearer: false,
     isProofRequired: true,
     isRecipientRequired: true,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 };
 //# sourceMappingURL=payload.js.map

package/dist/vta/webvh/dids/update/1.0/payload.js.map

@@ -1 +1 @@
-{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vta/webvh/dids/update/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA6EH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,uDAAgE,CAAC;AAKzF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,gEAAyE,CAAC;AAK3G;;;;GAIG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;CACjB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;CACjB,CAAC"}
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vta/webvh/dids/update/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA6EH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,uDAAgE,CAAC;AAKzF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,gEAAyE,CAAC;AAK3G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,uDAAuD;IAC9D,OAAO,EAAE,4BAA4B;IACrC,aAAa,EAAE,8JAA8J;IAC7K,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,KAAK;KACN;IACD,YAAY,EAAE;QACZ,KAAK,EAAE;YACL,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,gFAAgF;SAChG;QACD,UAAU,EAAE;YACV,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,oZAAoZ;SACpa;QACD,kBAAkB,EAAE;YAClB,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,aAAa,EAAE,yHAAyH;SACzI;QACD,WAAW,EAAE;YACX,aAAa,EAAE,0DAA0D;SAC1E;QACD,UAAU,EAAE;YACV,MAAM,EAAE,OAAO;YACf,OAAO,EAAE;gBACP,MAAM,EAAE,QAAQ;aACjB;YACD,aAAa,EAAE,8EAA8E;SAC9F;QACD,KAAK,EAAE;YACL,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,aAAa,EAAE,qDAAqD;SACrE;QACD,OAAO,EAAE;YACP,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,8BAA8B;SAC9C;QACD,mBAAmB,EAAE;YACnB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,0kBAA0kB;SAC1lB;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,qCAAqC;YAC9C,aAAa,EAAE,kKAAkK;YACjL,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,KAAK;gBACL,cAAc;aACf;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE;oBACL,MAAM,EAAE,QAAQ;iBACjB;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,0IAA0I;iBAC1J;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,QAAQ;iBACjB;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,uCAAuC;iBACvD;gBACD,iBAAiB,EAAE;oBACjB,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,6IAA6I;iBAC7J;gBACD,qBAAqB,EAAE;oBACrB,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,mDAAmD;iBACnE;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,qIAAqI;iBACrJ;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,qCAAqC;YAC9C,aAAa,EAAE,kKAAkK;YACjL,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,KAAK;gBACL,cAAc;aACf;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE;oBACL,MAAM,EAAE,QAAQ;iBACjB;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,0IAA0I;iBAC1J;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,QAAQ;iBACjB;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,uCAAuC;iBACvD;gBACD,iBAAiB,EAAE;oBACjB,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,6IAA6I;iBAC7J;gBACD,qBAAqB,EAAE;oBACrB,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,mDAAmD;iBACnE;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,qIAAqI;iBACrJ;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}