@openvtc/trust-tasks 0.26.11 → 0.26.13

package/src/vta/_shared/0.6/witness-party.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/_shared/0.6/witness-party.schema.json
+ */
+
+/**
+ * A VTA can act as the participating party of a witnessed session (witness/session/0.2, witness/session/submit/0.2) for its principal: it builds and signs, as the principal's relationship DID, every document the party sends, and verifies and stores what the witness returns. The client carries the documents between the VTA and the witness. The normative rules (the session binding, custody, authorization, retries) are in CONVENTIONS.md beside this file. The outcome evidence vta/witness/accept returns is the witness family's shared OutcomeEvidence (witness/_shared/0.1/outcome-evidence), which a holder also ships to a verifier. Not itself a Trust Task specification: the `_shared` folder is skipped by the registry build and the codegen.
+ */
+export interface WitnessedPartySharedDefinitionsForTheVtaWitness02Tasks {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { CarriedDocument, SessionId } from "../../../_shared/components.js";

package/src/vta/witness/accept/0.2/payload.ts

@@ -0,0 +1,330 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/witness/accept/0.2/payload.schema.json
+ */
+
+import type { CarriedDocument, DigestMultibase, EvidenceDocument, Ext, OutcomeEvidence, SessionId } from "../../../../_shared/components.js";
+
+
+/**
+ * A client hands its VTA the witness's answer to the submission; the VTA verifies the Verifiable Witness Credential it carries against the session, and stores it in the credential vault with its evidence.
+ */
+export interface VTAWitnessAcceptPayload {
+  sessionId: SessionId;
+  /**
+   * The witness/session/submit/0.2 #response the witness returned, exactly as received, under the witness's proof. It carries the VWC and its vwcDigestMultibase.
+   */
+  response: CarriedDocument;
+  ext?: Ext;
+}
+/**
+ * The stored VWC's vault handle, its digest, and the evidence documents that carry it. Sent only once the VWC is verified and stored.
+ */
+export interface VTAWitnessAcceptResponsePayload {
+  sessionId: SessionId;
+  /**
+   * The credential-vault handle the VWC is now stored under, with its evidence.
+   */
+  credentialId: string;
+  /**
+   * The witness that issued the VWC: the session's witness, since a VWC issued by any other party is refused, not stored.
+   */
+  witness: string;
+  /**
+   * The digest the witness returned for the VWC, which the VTA has checked against the VWC it stored: over the RFC 8785 canonicalization of the VWC, proof included.
+   */
+  vwcDigestMultibase: DigestMultibase;
+  /**
+   * The two documents a holder ships with the VWC so a verifier can pair it with the session that produced it: `session`, the witness/session/0.2 document as the VTA built it, and `outcome`, the witness/session/submit/0.2 #response as received, which carries the VWC. Each is carried exactly as sent or received, never re-serialised.
+   */
+  evidence: OutcomeEvidence;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CarriedDocument, DigestMultibase, EvidenceDocument, Ext, OutcomeEvidence, SessionId };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/witness/accept/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWitnessAcceptPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/witness/accept/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAWitnessAcceptResponsePayload;
+
+/**
+ * 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/witness/accept/0.2",
+  "title": "VTA Witness — Accept — payload",
+  "description": "A client hands its VTA the witness's answer to the submission; the VTA verifies the Verifiable Witness Credential it carries against the session, and stores it in the credential vault with its evidence.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "sessionId",
+    "response"
+  ],
+  "properties": {
+    "sessionId": {
+      "$ref": "#/$defs/SessionId"
+    },
+    "response": {
+      "$ref": "#/$defs/CarriedDocument",
+      "description": "The witness/session/submit/0.2 #response the witness returned, exactly as received, under the witness's proof. It carries the VWC and its vwcDigestMultibase."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Witness — Accept — response payload",
+      "description": "The stored VWC's vault handle, its digest, and the evidence documents that carry it. Sent only once the VWC is verified and stored.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sessionId",
+        "credentialId",
+        "witness",
+        "vwcDigestMultibase",
+        "evidence"
+      ],
+      "properties": {
+        "sessionId": {
+          "$ref": "#/$defs/SessionId"
+        },
+        "credentialId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The credential-vault handle the VWC is now stored under, with its evidence."
+        },
+        "witness": {
+          "type": "string",
+          "pattern": "^did:",
+          "description": "The witness that issued the VWC: the session's witness, since a VWC issued by any other party is refused, not stored."
+        },
+        "vwcDigestMultibase": {
+          "$ref": "#/$defs/DigestMultibase",
+          "description": "The digest the witness returned for the VWC, which the VTA has checked against the VWC it stored: over the RFC 8785 canonicalization of the VWC, proof included."
+        },
+        "evidence": {
+          "$ref": "#/$defs/OutcomeEvidence",
+          "description": "The two documents a holder ships with the VWC so a verifier can pair it with the session that produced it: `session`, the witness/session/0.2 document as the VTA built it, and `outcome`, the witness/session/submit/0.2 #response as received, which carries the VWC. Each is carried exactly as sent or received, never re-serialised."
+        },
+        "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-]+)+$"
+      }
+    },
+    "OutcomeEvidence": {
+      "title": "OutcomeEvidence",
+      "description": "One witnessing session's outcome evidence. `session` is the initiating witness/session document; `outcome` is the terminal witness/session/submit #response that the initiating document's own specification declares as its outcome evidence, under the witness's proof, delivering the VWC and its vwcDigestMultibase. A consumer pairs them with a presented VWC by SPEC §4.9.4's four checks and the witnessing checks of witness/session/submit (This response is the outcome evidence).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "session",
+        "outcome"
+      ],
+      "properties": {
+        "session": {
+          "$ref": "#/$defs/EvidenceDocument",
+          "description": "The witness/session document that opened the session. The VWC's taskContext is its id and its taskDigestMultibase is computed over it (SPEC §4.9.3)."
+        },
+        "outcome": {
+          "$ref": "#/$defs/EvidenceDocument",
+          "description": "The witness/session/submit #response that closed the session, under the witness's proof. It carries the VWC and its vwcDigestMultibase."
+        }
+      }
+    },
+    "EvidenceDocument": {
+      "title": "EvidenceDocument",
+      "description": "A whole Trust Task document — `id`, `type`, `payload` and every other member, `proof` included — carried exactly as it was sent or received, never re-serialised: a task digest and a proof are taken over its members, and a re-serialised copy reproduces neither reliably. Typed as an open object so every member survives; the checks that give it meaning belong to the task that reads it.",
+      "type": "object",
+      "minProperties": 1
+    },
+    "DigestMultibase": {
+      "title": "DigestMultibase",
+      "description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
+      "type": "string",
+      "minLength": 16,
+      "pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$",
+      "examples": [
+        "zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
+      ]
+    },
+    "SessionId": {
+      "title": "SessionId",
+      "description": "The id of the witness/session document the VTA built in vta/witness/open: the session's name, the thread every document of the session is on, and the value the VWC carries as taskContext. The VTA keys its state for the session by it.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    },
+    "CarriedDocument": {
+      "title": "CarriedDocument",
+      "description": "A whole Trust Task document — `id`, `type`, `payload` and every other member, `proof` included — carried between the VTA and the witness by the client: one the VTA built and signed for the client to send, or one the witness returned for the client to hand back. Typed as an open object so every member survives a round trip: carried exactly as built or received, never re-serialised, because its proof is over itself. Its envelope is checked by the VTA against the session record (CONVENTIONS.md §3), not by this schema.",
+      "type": "object",
+      "minProperties": 1
+    }
+  }
+} as const;
+
+/** 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": "VTA Witness — Accept — response payload",
+      "description": "The stored VWC's vault handle, its digest, and the evidence documents that carry it. Sent only once the VWC is verified and stored.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sessionId",
+        "credentialId",
+        "witness",
+        "vwcDigestMultibase",
+        "evidence"
+      ],
+      "properties": {
+        "sessionId": {
+          "$ref": "#/$defs/SessionId"
+        },
+        "credentialId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The credential-vault handle the VWC is now stored under, with its evidence."
+        },
+        "witness": {
+          "type": "string",
+          "pattern": "^did:",
+          "description": "The witness that issued the VWC: the session's witness, since a VWC issued by any other party is refused, not stored."
+        },
+        "vwcDigestMultibase": {
+          "$ref": "#/$defs/DigestMultibase",
+          "description": "The digest the witness returned for the VWC, which the VTA has checked against the VWC it stored: over the RFC 8785 canonicalization of the VWC, proof included."
+        },
+        "evidence": {
+          "$ref": "#/$defs/OutcomeEvidence",
+          "description": "The two documents a holder ships with the VWC so a verifier can pair it with the session that produced it: `session`, the witness/session/0.2 document as the VTA built it, and `outcome`, the witness/session/submit/0.2 #response as received, which carries the VWC. Each is carried exactly as sent or received, never re-serialised."
+        },
+        "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-]+)+$"
+      }
+    },
+    "OutcomeEvidence": {
+      "title": "OutcomeEvidence",
+      "description": "One witnessing session's outcome evidence. `session` is the initiating witness/session document; `outcome` is the terminal witness/session/submit #response that the initiating document's own specification declares as its outcome evidence, under the witness's proof, delivering the VWC and its vwcDigestMultibase. A consumer pairs them with a presented VWC by SPEC §4.9.4's four checks and the witnessing checks of witness/session/submit (This response is the outcome evidence).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "session",
+        "outcome"
+      ],
+      "properties": {
+        "session": {
+          "$ref": "#/$defs/EvidenceDocument",
+          "description": "The witness/session document that opened the session. The VWC's taskContext is its id and its taskDigestMultibase is computed over it (SPEC §4.9.3)."
+        },
+        "outcome": {
+          "$ref": "#/$defs/EvidenceDocument",
+          "description": "The witness/session/submit #response that closed the session, under the witness's proof. It carries the VWC and its vwcDigestMultibase."
+        }
+      }
+    },
+    "EvidenceDocument": {
+      "title": "EvidenceDocument",
+      "description": "A whole Trust Task document — `id`, `type`, `payload` and every other member, `proof` included — carried exactly as it was sent or received, never re-serialised: a task digest and a proof are taken over its members, and a re-serialised copy reproduces neither reliably. Typed as an open object so every member survives; the checks that give it meaning belong to the task that reads it.",
+      "type": "object",
+      "minProperties": 1
+    },
+    "DigestMultibase": {
+      "title": "DigestMultibase",
+      "description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
+      "type": "string",
+      "minLength": 16,
+      "pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$",
+      "examples": [
+        "zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
+      ]
+    },
+    "SessionId": {
+      "title": "SessionId",
+      "description": "The id of the witness/session document the VTA built in vta/witness/open: the session's name, the thread every document of the session is on, and the value the VWC carries as taskContext. The VTA keys its state for the session by it.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    },
+    "CarriedDocument": {
+      "title": "CarriedDocument",
+      "description": "A whole Trust Task document — `id`, `type`, `payload` and every other member, `proof` included — carried between the VTA and the witness by the client: one the VTA built and signed for the client to send, or one the witness returned for the client to hand back. Typed as an open object so every member survives a round trip: carried exactly as built or received, never re-serialised, because its proof is over itself. Its envelope is checked by the VTA against the session record (CONVENTIONS.md §3), not by this schema.",
+      "type": "object",
+      "minProperties": 1
+    }
+  }
+} as const;
+
+/**
+ * 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, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;