@openvtc/trust-tasks 0.28.8 → 0.28.10

package/src/vta/pcs/voter/read/0.5/payload.ts

@@ -0,0 +1,394 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/voter/read/0.5/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * A voter's client asks its VTA for a vtc/elections/list or vtc/elections/show request signed as the voter's membership DID, so the client can read the community's elections as the member without holding the member's key. For a show of an election put to the members of a party that is itself a member of the community, the VTA can present the member's credential for that party from its vault, bound to the read it signs.
+ *
+ * @deprecated superseded by vta/pcs/voter/read/0.6
+ */
+export interface VTAPCSVoterReadPayload {
+  /**
+   * The context the voter belongs to.
+   */
+  contextId: string;
+  /**
+   * The community's DID: the recipient of the signed request.
+   */
+  community: string;
+  /**
+   * The voter's membership DID at the community. MUST be a DID the engine holds an authentication key of that the caller may act as.
+   */
+  member: string;
+  /**
+   * Which read to sign: vtc/elections/list/0.5 or vtc/elections/show/0.5.
+   */
+  read: "list" | "show";
+  /**
+   * The request payload of that task, validated against its own schema.
+   */
+  payload: {};
+  /**
+   * Only with `read` `show`, and only to read an election whose `credential` roll names a member party (vtc/elections/show/0.5, VTI-VOT-015): the vault's local handle (vault/credentials/query) of the membership credential the member chose to present for it, whose subject is `member`. The engine presents it in the `show` request it signs, bound to that document and the community. Opaque; never derived or guessed.
+   */
+  membershipCredential?: string;
+  ext?: Ext;
+}
+/**
+ * The signed read, to send to the community.
+ *
+ * @deprecated superseded by vta/pcs/voter/read/0.6
+ */
+export interface VTAPCSVoterReadResponsePayload {
+  document: ReadDocument;
+  ext?: Ext;
+}
+/**
+ * A complete, signed vtc/elections/list/0.5 or vtc/elections/show/0.5 request document, ready to send to the community unchanged.
+ */
+export interface ReadDocument {
+  id: string;
+  type: "https://trusttasks.org/spec/vtc/elections/list/0.5" | "https://trusttasks.org/spec/vtc/elections/show/0.5";
+  /**
+   * The request's `member`.
+   */
+  issuer: string;
+  /**
+   * The request's `community`.
+   */
+  recipient: string;
+  issuedAt: string;
+  expiresAt?: string;
+  /**
+   * The request's `payload`, exactly — and, where the request named `membershipCredential`, with `presentation` added: the engine's presentation of that credential, bound to this document.
+   */
+  payload: {};
+  /**
+   * A Data Integrity proof by an `authentication` key of `issuer`.
+   */
+  proof: {};
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/pcs/voter/read/0.5" 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 = "superseded by vta/pcs/voter/read/0.6";
+
+/**
+ * Stable alias for this specification's request payload shape.
+ *
+ * @deprecated superseded by vta/pcs/voter/read/0.6
+ */
+export type Payload = VTAPCSVoterReadPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/voter/read/0.5#response" as const;
+
+/**
+ * Stable alias for this specification's success-response payload shape.
+ *
+ * @deprecated superseded by vta/pcs/voter/read/0.6
+ */
+export type Response = VTAPCSVoterReadResponsePayload;
+
+/**
+ * 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/pcs/voter/read/0.5",
+  "title": "VTA PCS — Voter Read — payload",
+  "description": "A voter's client asks its VTA for a vtc/elections/list or vtc/elections/show request signed as the voter's membership DID, so the client can read the community's elections as the member without holding the member's key. For a show of an election put to the members of a party that is itself a member of the community, the VTA can present the member's credential for that party from its vault, bound to the read it signs.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "community",
+    "member",
+    "read",
+    "payload"
+  ],
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "The context the voter belongs to."
+    },
+    "community": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2048,
+      "description": "The community's DID: the recipient of the signed request."
+    },
+    "member": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2048,
+      "pattern": "^did:",
+      "description": "The voter's membership DID at the community. MUST be a DID the engine holds an authentication key of that the caller may act as."
+    },
+    "read": {
+      "type": "string",
+      "enum": [
+        "list",
+        "show"
+      ],
+      "description": "Which read to sign: vtc/elections/list/0.5 or vtc/elections/show/0.5."
+    },
+    "payload": {
+      "type": "object",
+      "description": "The request payload of that task, validated against its own schema."
+    },
+    "membershipCredential": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "Only with `read` `show`, and only to read an election whose `credential` roll names a member party (vtc/elections/show/0.5, VTI-VOT-015): the vault's local handle (vault/credentials/query) of the membership credential the member chose to present for it, whose subject is `member`. The engine presents it in the `show` request it signs, bound to that document and the community. Opaque; never derived or guessed."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "dependentSchemas": {
+    "membershipCredential": {
+      "properties": {
+        "read": {
+          "const": "show"
+        }
+      }
+    }
+  },
+  "$defs": {
+    "ReadDocument": {
+      "title": "ReadDocument",
+      "description": "A complete, signed vtc/elections/list/0.5 or vtc/elections/show/0.5 request document, ready to send to the community unchanged.",
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "issuer",
+        "recipient",
+        "issuedAt",
+        "payload",
+        "proof"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "https://trusttasks.org/spec/vtc/elections/list/0.5",
+            "https://trusttasks.org/spec/vtc/elections/show/0.5"
+          ]
+        },
+        "issuer": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `member`."
+        },
+        "recipient": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `community`."
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "payload": {
+          "type": "object",
+          "description": "The request's `payload`, exactly — and, where the request named `membershipCredential`, with `presentation` added: the engine's presentation of that credential, bound to this document."
+        },
+        "proof": {
+          "type": "object",
+          "description": "A Data Integrity proof by an `authentication` key of `issuer`."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Voter Read — response payload",
+      "description": "The signed read, to send to the community.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "document"
+      ],
+      "properties": {
+        "document": {
+          "$ref": "#/$defs/ReadDocument"
+        },
+        "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 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": {
+    "ReadDocument": {
+      "title": "ReadDocument",
+      "description": "A complete, signed vtc/elections/list/0.5 or vtc/elections/show/0.5 request document, ready to send to the community unchanged.",
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "issuer",
+        "recipient",
+        "issuedAt",
+        "payload",
+        "proof"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "https://trusttasks.org/spec/vtc/elections/list/0.5",
+            "https://trusttasks.org/spec/vtc/elections/show/0.5"
+          ]
+        },
+        "issuer": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `member`."
+        },
+        "recipient": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `community`."
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "payload": {
+          "type": "object",
+          "description": "The request's `payload`, exactly — and, where the request named `membershipCredential`, with `presentation` added: the engine's presentation of that credential, bound to this document."
+        },
+        "proof": {
+          "type": "object",
+          "description": "A Data Integrity proof by an `authentication` key of `issuer`."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Voter Read — response payload",
+      "description": "The signed read, to send to the community.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "document"
+      ],
+      "properties": {
+        "document": {
+          "$ref": "#/$defs/ReadDocument"
+        },
+        "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 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;