@openvtc/trust-tasks 0.28.7 → 0.28.9

package/src/vtc/elections/tickets/issue/0.3/payload.ts

@@ -0,0 +1,429 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/elections/tickets/issue/0.3/payload.schema.json
+ */
+
+import type { DigestMultibase, ElectionId, Ext, Multibase_VotingV0_1 as Multibase } from "../../../../../_shared/components.js";
+
+
+/**
+ * An eligible party asks the community to blind-issue its ticket for one election: the community checks eligibility against its own records and signs a commitment it cannot open, so the ticket its voter's agent unblinds is one the community has never seen. Under a credential roll the party also presents its membership credential for the party the roll names, which the community checks at that moment. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCElectionsTicketsIssuePayload {
+  electionId: ElectionId;
+  /**
+   * The digest of the manifest the requester read (vtc/elections/show) and its agent bound the request to. A ticket is only ever asked for under the manifest the voter saw.
+   */
+  manifestDigest: DigestMultibase;
+  request: TicketRequest;
+  /**
+   * Under a `credential` roll (voting/_shared/0.4 `RollRule`), and only then: the requester's presentation of its membership credential for the party `roll.memberOf` names, made by the credential's subject — who signs this document — and bound to this document (VTI-VOT-025). Required when the election's roll rule is `credential`, refused under any other rule. The community verifies it before, and without reference to, the election the request names, so an outage of a status list or a verification method it depends on is answered `indeterminate` whatever the election; it checks it as it stands at the moment of issuance and discards it once it has decided.
+   */
+  presentation?: {} | string;
+  ext?: Ext;
+}
+/**
+ * The blinded root request for the election's ticket class, as the voter's VTA built it (vta/pcs/voter/register). The community verifies it under its voting parameters and learns nothing else from it.
+ */
+export interface TicketRequest {
+  /**
+   * The ticket class label, `voter/<electionId>` (CONVENTIONS §3.2). It MUST name the election `electionId` names.
+   */
+  label: string;
+  /**
+   * The voter's PCS identifier for this election, derived from the election's voter key, which is allocated for this election alone (VTI-VOT-023).
+   */
+  id: Multibase;
+  request: RootRequest;
+}
+/**
+ * The suite's blinded root request, serialised as vtc/vetting/vetters/pcs-root carries one. Opaque to the community beyond verifying it under its voting parameters.
+ */
+export interface RootRequest {
+  /**
+   * The issuance encoding the suite carries.
+   */
+  encoding?: string;
+  /**
+   * The request's tag under the root context.
+   */
+  t0?: string;
+  /**
+   * The proof that the commitment is well formed and the requester holds its secret.
+   */
+  proof: string;
+}
+/**
+ * Success response to vtc/elections/tickets/issue/0.3: the blind pre-credential. The voter's VTA unblinds it into a ticket the community has never seen (vta/pcs/voter/accept).
+ */
+export interface VTCElectionsTicketsIssueResponsePayload {
+  electionId: ElectionId;
+  /**
+   * The label signed under — the one asked for.
+   */
+  label: string;
+  /**
+   * The pre-credential, under the community's voting key. Useless to anyone but the holder of the request's blinding state.
+   */
+  preCredential: Multibase;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { DigestMultibase, ElectionId, Ext, Multibase };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/elections/tickets/issue/0.3" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCElectionsTicketsIssuePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/elections/tickets/issue/0.3#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCElectionsTicketsIssueResponsePayload;
+
+/**
+ * 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/vtc/elections/tickets/issue/0.3",
+  "title": "VTC Elections — Tickets — Issue — payload",
+  "description": "An eligible party asks the community to blind-issue its ticket for one election: the community checks eligibility against its own records and signs a commitment it cannot open, so the ticket its voter's agent unblinds is one the community has never seen. Under a credential roll the party also presents its membership credential for the party the roll names, which the community checks at that moment. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "electionId",
+    "manifestDigest",
+    "request"
+  ],
+  "properties": {
+    "electionId": {
+      "$ref": "#/$defs/ElectionId"
+    },
+    "manifestDigest": {
+      "$ref": "#/$defs/DigestMultibase",
+      "description": "The digest of the manifest the requester read (vtc/elections/show) and its agent bound the request to. A ticket is only ever asked for under the manifest the voter saw."
+    },
+    "request": {
+      "$ref": "#/$defs/TicketRequest"
+    },
+    "presentation": {
+      "description": "Under a `credential` roll (voting/_shared/0.4 `RollRule`), and only then: the requester's presentation of its membership credential for the party `roll.memberOf` names, made by the credential's subject — who signs this document — and bound to this document (VTI-VOT-025). Required when the election's roll rule is `credential`, refused under any other rule. The community verifies it before, and without reference to, the election the request names, so an outage of a status list or a verification method it depends on is answered `indeterminate` whatever the election; it checks it as it stands at the moment of issuance and discards it once it has decided.",
+      "anyOf": [
+        {
+          "type": "object",
+          "description": "A W3C Verifiable Presentation whose `nonce` is this document's `id` and whose `domain` is the community's DID, both signed by its holder's Data Integrity proof."
+        },
+        {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 65536,
+          "description": "A compact presentation: an SD-JWT with a key-binding JWT whose `nonce` is this document's `id` and `aud` the community's DID."
+        }
+      ]
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "TicketRequest": {
+      "title": "TicketRequest",
+      "description": "The blinded root request for the election's ticket class, as the voter's VTA built it (vta/pcs/voter/register). The community verifies it under its voting parameters and learns nothing else from it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "label",
+        "id",
+        "request"
+      ],
+      "properties": {
+        "label": {
+          "type": "string",
+          "pattern": "^voter/[A-Za-z0-9._-]{1,128}$",
+          "maxLength": 134,
+          "description": "The ticket class label, `voter/<electionId>` (CONVENTIONS §3.2). It MUST name the election `electionId` names."
+        },
+        "id": {
+          "$ref": "#/$defs/Multibase",
+          "description": "The voter's PCS identifier for this election, derived from the election's voter key, which is allocated for this election alone (VTI-VOT-023)."
+        },
+        "request": {
+          "$ref": "#/$defs/RootRequest"
+        }
+      }
+    },
+    "RootRequest": {
+      "title": "RootRequest",
+      "description": "The suite's blinded root request, serialised as vtc/vetting/vetters/pcs-root carries one. Opaque to the community beyond verifying it under its voting parameters.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "proof"
+      ],
+      "properties": {
+        "encoding": {
+          "type": "string",
+          "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+          "maxLength": 4096,
+          "description": "The issuance encoding the suite carries."
+        },
+        "t0": {
+          "type": "string",
+          "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+          "maxLength": 4096,
+          "description": "The request's tag under the root context."
+        },
+        "proof": {
+          "type": "string",
+          "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+          "maxLength": 8192,
+          "description": "The proof that the commitment is well formed and the requester holds its secret."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Elections — Tickets — Issue — response payload",
+      "description": "Success response to vtc/elections/tickets/issue/0.3: the blind pre-credential. The voter's VTA unblinds it into a ticket the community has never seen (vta/pcs/voter/accept).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "electionId",
+        "label",
+        "preCredential"
+      ],
+      "properties": {
+        "electionId": {
+          "$ref": "#/$defs/ElectionId"
+        },
+        "label": {
+          "type": "string",
+          "pattern": "^voter/[A-Za-z0-9._-]{1,128}$",
+          "maxLength": 134,
+          "description": "The label signed under — the one asked for."
+        },
+        "preCredential": {
+          "$ref": "#/$defs/Multibase",
+          "description": "The pre-credential, under the community's voting key. Useless to anyone but the holder of the request's blinding state."
+        },
+        "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-]+)+$"
+      }
+    },
+    "Multibase": {
+      "title": "Multibase",
+      "description": "A binary value, multibase base58btc over the suite's canonical (compressed) encoding.",
+      "type": "string",
+      "maxLength": 16384,
+      "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$"
+    },
+    "ElectionId": {
+      "title": "ElectionId",
+      "description": "An election's identifier, unique within its community. A closed alphabet: it appears in the ticket class label `voter/<electionId>` and is framed into every hash a cast is bound to.",
+      "type": "string",
+      "pattern": "^[A-Za-z0-9._-]{1,128}$"
+    },
+    "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"
+      ]
+    }
+  }
+} 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": {
+    "TicketRequest": {
+      "title": "TicketRequest",
+      "description": "The blinded root request for the election's ticket class, as the voter's VTA built it (vta/pcs/voter/register). The community verifies it under its voting parameters and learns nothing else from it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "label",
+        "id",
+        "request"
+      ],
+      "properties": {
+        "label": {
+          "type": "string",
+          "pattern": "^voter/[A-Za-z0-9._-]{1,128}$",
+          "maxLength": 134,
+          "description": "The ticket class label, `voter/<electionId>` (CONVENTIONS §3.2). It MUST name the election `electionId` names."
+        },
+        "id": {
+          "$ref": "#/$defs/Multibase",
+          "description": "The voter's PCS identifier for this election, derived from the election's voter key, which is allocated for this election alone (VTI-VOT-023)."
+        },
+        "request": {
+          "$ref": "#/$defs/RootRequest"
+        }
+      }
+    },
+    "RootRequest": {
+      "title": "RootRequest",
+      "description": "The suite's blinded root request, serialised as vtc/vetting/vetters/pcs-root carries one. Opaque to the community beyond verifying it under its voting parameters.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "proof"
+      ],
+      "properties": {
+        "encoding": {
+          "type": "string",
+          "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+          "maxLength": 4096,
+          "description": "The issuance encoding the suite carries."
+        },
+        "t0": {
+          "type": "string",
+          "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+          "maxLength": 4096,
+          "description": "The request's tag under the root context."
+        },
+        "proof": {
+          "type": "string",
+          "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+          "maxLength": 8192,
+          "description": "The proof that the commitment is well formed and the requester holds its secret."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Elections — Tickets — Issue — response payload",
+      "description": "Success response to vtc/elections/tickets/issue/0.3: the blind pre-credential. The voter's VTA unblinds it into a ticket the community has never seen (vta/pcs/voter/accept).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "electionId",
+        "label",
+        "preCredential"
+      ],
+      "properties": {
+        "electionId": {
+          "$ref": "#/$defs/ElectionId"
+        },
+        "label": {
+          "type": "string",
+          "pattern": "^voter/[A-Za-z0-9._-]{1,128}$",
+          "maxLength": 134,
+          "description": "The label signed under — the one asked for."
+        },
+        "preCredential": {
+          "$ref": "#/$defs/Multibase",
+          "description": "The pre-credential, under the community's voting key. Useless to anyone but the holder of the request's blinding state."
+        },
+        "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-]+)+$"
+      }
+    },
+    "Multibase": {
+      "title": "Multibase",
+      "description": "A binary value, multibase base58btc over the suite's canonical (compressed) encoding.",
+      "type": "string",
+      "maxLength": 16384,
+      "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$"
+    },
+    "ElectionId": {
+      "title": "ElectionId",
+      "description": "An election's identifier, unique within its community. A closed alphabet: it appears in the ticket class label `voter/<electionId>` and is framed into every hash a cast is bound to.",
+      "type": "string",
+      "pattern": "^[A-Za-z0-9._-]{1,128}$"
+    },
+    "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"
+      ]
+    }
+  }
+} 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;