@openvtc/trust-tasks 0.28.4 → 0.28.6

package/src/vtc/elections/ballot-boxes/list/0.1/payload.ts

@@ -0,0 +1,260 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/elections/ballot-boxes/list/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * An administrator reads the voting services the community will register an election with — its trusted ballot boxes — so that a manifest names one the community accepts. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCElectionsBallotBoxesListPayload {
+  ext?: Ext;
+}
+/**
+ * Success response to vtc/elections/ballot-boxes/list/0.1: every voting service the community trusts, as it trusts them now.
+ */
+export interface VTCElectionsBallotBoxesListResponsePayload {
+  /**
+   * Every trusted ballot box, in the community's own order. Empty when the community trusts none, and so can create no election.
+   *
+   * @maxItems 256
+   */
+  ballotBoxes: TrustedBallotBox[];
+  ext?: Ext;
+}
+/**
+ * One voting service the community trusts (VTI-VOT-082), with what its members are told about it when an election names it (VTI-VOT-090).
+ */
+export interface TrustedBallotBox {
+  /**
+   * The ballot box's DID, exactly as a manifest names it in `ballotBox`.
+   */
+  did: string;
+  /**
+   * Who operates it, as the community names them — the `ballotBoxOperator` a member is shown.
+   */
+  operator: string;
+  /**
+   * Whether the party operating the community's VTC also operates this ballot box — the `sameOperator` a member is shown.
+   */
+  sameOperator: boolean;
+}
+
+/** 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/vtc/elections/ballot-boxes/list/0.1" 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 = VTCElectionsBallotBoxesListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/elections/ballot-boxes/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCElectionsBallotBoxesListResponsePayload;
+
+/**
+ * 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/ballot-boxes/list/0.1",
+  "title": "VTC Elections — Ballot Boxes — List — payload",
+  "description": "An administrator reads the voting services the community will register an election with — its trusted ballot boxes — so that a manifest names one the community accepts. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "TrustedBallotBox": {
+      "title": "TrustedBallotBox",
+      "description": "One voting service the community trusts (VTI-VOT-082), with what its members are told about it when an election names it (VTI-VOT-090).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "operator",
+        "sameOperator"
+      ],
+      "properties": {
+        "did": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The ballot box's DID, exactly as a manifest names it in `ballotBox`."
+        },
+        "operator": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "Who operates it, as the community names them — the `ballotBoxOperator` a member is shown."
+        },
+        "sameOperator": {
+          "type": "boolean",
+          "description": "Whether the party operating the community's VTC also operates this ballot box — the `sameOperator` a member is shown."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Elections — Ballot Boxes — List — response payload",
+      "description": "Success response to vtc/elections/ballot-boxes/list/0.1: every voting service the community trusts, as it trusts them now.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ballotBoxes"
+      ],
+      "properties": {
+        "ballotBoxes": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "$ref": "#/$defs/TrustedBallotBox"
+          },
+          "description": "Every trusted ballot box, in the community's own order. Empty when the community trusts none, and so can create no election."
+        },
+        "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": {
+    "TrustedBallotBox": {
+      "title": "TrustedBallotBox",
+      "description": "One voting service the community trusts (VTI-VOT-082), with what its members are told about it when an election names it (VTI-VOT-090).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "operator",
+        "sameOperator"
+      ],
+      "properties": {
+        "did": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The ballot box's DID, exactly as a manifest names it in `ballotBox`."
+        },
+        "operator": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "Who operates it, as the community names them — the `ballotBoxOperator` a member is shown."
+        },
+        "sameOperator": {
+          "type": "boolean",
+          "description": "Whether the party operating the community's VTC also operates this ballot box — the `sameOperator` a member is shown."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Elections — Ballot Boxes — List — response payload",
+      "description": "Success response to vtc/elections/ballot-boxes/list/0.1: every voting service the community trusts, as it trusts them now.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ballotBoxes"
+      ],
+      "properties": {
+        "ballotBoxes": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "$ref": "#/$defs/TrustedBallotBox"
+          },
+          "description": "Every trusted ballot box, in the community's own order. Empty when the community trusts none, and so can create no election."
+        },
+        "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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  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: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;