@openvtc/trust-tasks 0.26.20 → 0.26.21

package/src/vtc/elections/close/0.1/payload.ts

@@ -0,0 +1,222 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/elections/close/0.1/payload.schema.json
+ */
+
+import type { ElectionId, ElectionState, Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * An administrator closes voting in an election early, where its manifest allows it; the community has the ballot box close the board. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCElectionsClosePayload {
+  electionId: ElectionId;
+  /**
+   * Why voting is closed early, for the community's audit trail and its members.
+   */
+  reason?: string;
+  ext?: Ext;
+}
+/**
+ * Success response to vtc/elections/close/0.1: the election's state once the ballot box closed it.
+ */
+export interface VTCElectionsCloseResponsePayload {
+  electionId: ElectionId;
+  /**
+   * `closed`, or `tallied` where the ballot box tallied in the same step.
+   */
+  state: ElectionState;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ElectionId, ElectionState, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/elections/close/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCElectionsClosePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/elections/close/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCElectionsCloseResponsePayload;
+
+/**
+ * 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/close/0.1",
+  "title": "VTC Elections — Close — payload",
+  "description": "An administrator closes voting in an election early, where its manifest allows it; the community has the ballot box close the board. 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"
+  ],
+  "properties": {
+    "electionId": {
+      "$ref": "#/$defs/ElectionId"
+    },
+    "reason": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "pattern": "\\S",
+      "description": "Why voting is closed early, for the community's audit trail and its members."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Elections — Close — response payload",
+      "description": "Success response to vtc/elections/close/0.1: the election's state once the ballot box closed it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "electionId",
+        "state"
+      ],
+      "properties": {
+        "electionId": {
+          "$ref": "#/$defs/ElectionId"
+        },
+        "state": {
+          "$ref": "#/$defs/ElectionState",
+          "description": "`closed`, or `tallied` where the ballot box tallied in the same step."
+        },
+        "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-]+)+$"
+      }
+    },
+    "ElectionState": {
+      "title": "ElectionState",
+      "type": "string",
+      "enum": [
+        "registered",
+        "registration",
+        "voting",
+        "closed",
+        "tallied",
+        "cancelled"
+      ]
+    },
+    "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}$"
+    }
+  }
+} 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": "VTC Elections — Close — response payload",
+      "description": "Success response to vtc/elections/close/0.1: the election's state once the ballot box closed it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "electionId",
+        "state"
+      ],
+      "properties": {
+        "electionId": {
+          "$ref": "#/$defs/ElectionId"
+        },
+        "state": {
+          "$ref": "#/$defs/ElectionState",
+          "description": "`closed`, or `tallied` where the ballot box tallied in the same step."
+        },
+        "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-]+)+$"
+      }
+    },
+    "ElectionState": {
+      "title": "ElectionState",
+      "type": "string",
+      "enum": [
+        "registered",
+        "registration",
+        "voting",
+        "closed",
+        "tallied",
+        "cancelled"
+      ]
+    },
+    "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}$"
+    }
+  }
+} 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;