@openvtc/trust-tasks 0.28.8 → 0.28.10

package/src/vtc/elections/list/0.5/payload.ts

@@ -0,0 +1,387 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/elections/list/0.5/payload.schema.json
+ */
+
+import type { ElectionId, Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * An election's state as its registrar holds it: the ballot box's `ElectionState` once the ballot box has registered the election, or, before that, `pendingRegistration` (the community is still delivering the registration) or `registrationRefused` (the ballot box refused it on a later delivery, and only a cancellation clears it). The first six values are the ballot box's `ElectionState` (voting/_shared/0.1).
+ */
+export type RegistrarState =
+  | "registered"
+  | "registration"
+  | "voting"
+  | "closed"
+  | "tallied"
+  | "cancelled"
+  | "pendingRegistration"
+  | "registrationRefused";
+
+/**
+ * A member or an administrator pages through the community's elections that the caller may see. A list never carries a presentation, and never shows an election whose credential roll names a member party to a caller who would need one to read it (vtc/elections/show). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCElectionsListPayload {
+  state?: RegistrarState;
+  /**
+   * An opaque continuation token from a previous response's `nextCursor`, bound to the caller and to `state`; a responder MUST NOT accept a cursor it did not issue.
+   */
+  cursor?: string;
+  /**
+   * The most items to return; the responder chooses a default and MAY return fewer.
+   */
+  limit?: number;
+  ext?: Ext;
+}
+/**
+ * Success response to vtc/elections/list/0.5: one page of the elections the caller may see.
+ */
+export interface VTCElectionsListResponsePayload {
+  /**
+   * @maxItems 100
+   */
+  elections: ElectionListItem[];
+  /**
+   * Continuation token for the next page; pass it as `cursor`. Absent on the last page — never `null`.
+   */
+  nextCursor?: string;
+  ext?: Ext;
+}
+/**
+ * One election as a list shows it. vtc/elections/show reads it whole.
+ */
+export interface ElectionListItem {
+  electionId: ElectionId;
+  /**
+   * The manifest's `title`, when it has one.
+   */
+  title?: string;
+  state: RegistrarState;
+  votingOpensAt: string;
+  votingClosesAt: string;
+  /**
+   * The manifest's `binding`.
+   */
+  binding: boolean;
+  /**
+   * Whether the community has issued a ticket for this election to the caller. About the caller only, never anyone else.
+   */
+  ticketHeld: boolean;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ElectionId, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/elections/list/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 = "0.4";
+
+/**
+ * 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 = VTCElectionsListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/elections/list/0.5#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCElectionsListResponsePayload;
+
+/**
+ * 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/list/0.5",
+  "title": "VTC Elections — List — payload",
+  "description": "A member or an administrator pages through the community's elections that the caller may see. A list never carries a presentation, and never shows an election whose credential roll names a member party to a caller who would need one to read it (vtc/elections/show). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "state": {
+      "$ref": "#/$defs/RegistrarState"
+    },
+    "cursor": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "An opaque continuation token from a previous response's `nextCursor`, bound to the caller and to `state`; a responder MUST NOT accept a cursor it did not issue."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 100,
+      "description": "The most items to return; the responder chooses a default and MAY return fewer."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "RegistrarState": {
+      "title": "RegistrarState",
+      "description": "An election's state as its registrar holds it: the ballot box's `ElectionState` once the ballot box has registered the election, or, before that, `pendingRegistration` (the community is still delivering the registration) or `registrationRefused` (the ballot box refused it on a later delivery, and only a cancellation clears it). The first six values are the ballot box's `ElectionState` (voting/_shared/0.1).",
+      "type": "string",
+      "enum": [
+        "registered",
+        "registration",
+        "voting",
+        "closed",
+        "tallied",
+        "cancelled",
+        "pendingRegistration",
+        "registrationRefused"
+      ]
+    },
+    "ElectionListItem": {
+      "title": "ElectionListItem",
+      "description": "One election as a list shows it. vtc/elections/show reads it whole.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "electionId",
+        "state",
+        "votingOpensAt",
+        "votingClosesAt",
+        "binding",
+        "ticketHeld"
+      ],
+      "properties": {
+        "electionId": {
+          "$ref": "#/$defs/ElectionId"
+        },
+        "title": {
+          "type": "string",
+          "maxLength": 512,
+          "description": "The manifest's `title`, when it has one."
+        },
+        "state": {
+          "$ref": "#/$defs/RegistrarState"
+        },
+        "votingOpensAt": {
+          "type": "string",
+          "format": "date-time",
+          "maxLength": 64
+        },
+        "votingClosesAt": {
+          "type": "string",
+          "format": "date-time",
+          "maxLength": 64
+        },
+        "binding": {
+          "type": "boolean",
+          "description": "The manifest's `binding`."
+        },
+        "ticketHeld": {
+          "type": "boolean",
+          "description": "Whether the community has issued a ticket for this election to the caller. About the caller only, never anyone else."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Elections — List — response payload",
+      "description": "Success response to vtc/elections/list/0.5: one page of the elections the caller may see.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "elections"
+      ],
+      "properties": {
+        "elections": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/$defs/ElectionListItem"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "Continuation token for the next page; pass it as `cursor`. Absent on the last page — never `null`."
+        },
+        "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-]+)+$"
+      }
+    },
+    "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": {
+    "RegistrarState": {
+      "title": "RegistrarState",
+      "description": "An election's state as its registrar holds it: the ballot box's `ElectionState` once the ballot box has registered the election, or, before that, `pendingRegistration` (the community is still delivering the registration) or `registrationRefused` (the ballot box refused it on a later delivery, and only a cancellation clears it). The first six values are the ballot box's `ElectionState` (voting/_shared/0.1).",
+      "type": "string",
+      "enum": [
+        "registered",
+        "registration",
+        "voting",
+        "closed",
+        "tallied",
+        "cancelled",
+        "pendingRegistration",
+        "registrationRefused"
+      ]
+    },
+    "ElectionListItem": {
+      "title": "ElectionListItem",
+      "description": "One election as a list shows it. vtc/elections/show reads it whole.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "electionId",
+        "state",
+        "votingOpensAt",
+        "votingClosesAt",
+        "binding",
+        "ticketHeld"
+      ],
+      "properties": {
+        "electionId": {
+          "$ref": "#/$defs/ElectionId"
+        },
+        "title": {
+          "type": "string",
+          "maxLength": 512,
+          "description": "The manifest's `title`, when it has one."
+        },
+        "state": {
+          "$ref": "#/$defs/RegistrarState"
+        },
+        "votingOpensAt": {
+          "type": "string",
+          "format": "date-time",
+          "maxLength": 64
+        },
+        "votingClosesAt": {
+          "type": "string",
+          "format": "date-time",
+          "maxLength": 64
+        },
+        "binding": {
+          "type": "boolean",
+          "description": "The manifest's `binding`."
+        },
+        "ticketHeld": {
+          "type": "boolean",
+          "description": "Whether the community has issued a ticket for this election to the caller. About the caller only, never anyone else."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Elections — List — response payload",
+      "description": "Success response to vtc/elections/list/0.5: one page of the elections the caller may see.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "elections"
+      ],
+      "properties": {
+        "elections": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/$defs/ElectionListItem"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "Continuation token for the next page; pass it as `cursor`. Absent on the last page — never `null`."
+        },
+        "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-]+)+$"
+      }
+    },
+    "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: 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;

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

@@ -22,7 +22,7 @@ export type RegistrarState =
 /**
  * A member or an administrator reads one election of the community whole: its manifest, state, voting parameters, disclosure, the board checkpoints the community kept and, once certified, the certified result. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
  *
- * @deprecated superseded by vtc/elections/show/0.3
+ * @deprecated superseded by vtc/elections/show/0.6
  */
 export interface VTCElectionsShowPayload {
   electionId: ElectionId;
@@ -31,7 +31,7 @@ export interface VTCElectionsShowPayload {
 /**
  * Success response to vtc/elections/show/0.1: one election, whole.
  *
- * @deprecated superseded by vtc/elections/show/0.3
+ * @deprecated superseded by vtc/elections/show/0.6
  */
 export interface VTCElectionsShowResponsePayload {
   manifest: Manifest;
@@ -111,12 +111,12 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = "superseded by vtc/elections/show/0.3";
+export const DEPRECATION: string | null = "superseded by vtc/elections/show/0.6";
 
 /**
  * Stable alias for this specification's request payload shape.
  *
- * @deprecated superseded by vtc/elections/show/0.3
+ * @deprecated superseded by vtc/elections/show/0.6
  */
 export type Payload = VTCElectionsShowPayload;
 
@@ -126,7 +126,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/elections/show
 /**
  * Stable alias for this specification's success-response payload shape.
  *
- * @deprecated superseded by vtc/elections/show/0.3
+ * @deprecated superseded by vtc/elections/show/0.6
  */
 export type Response = VTCElectionsShowResponsePayload;
 

package/src/vtc/elections/show/0.2/payload.ts

@@ -22,7 +22,7 @@ export type RegistrarState =
 /**
  * A member or an administrator reads one election of the community whole: its manifest, state, voting parameters, disclosure, the board checkpoints the community kept and, once certified, the certified result. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
  *
- * @deprecated superseded by vtc/elections/show/0.3
+ * @deprecated superseded by vtc/elections/show/0.6
  */
 export interface VTCElectionsShowPayload {
   electionId: ElectionId;
@@ -31,7 +31,7 @@ export interface VTCElectionsShowPayload {
 /**
  * Success response to vtc/elections/show/0.1: one election, whole.
  *
- * @deprecated superseded by vtc/elections/show/0.3
+ * @deprecated superseded by vtc/elections/show/0.6
  */
 export interface VTCElectionsShowResponsePayload {
   manifest: Manifest;
@@ -111,12 +111,12 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = "superseded by vtc/elections/show/0.3";
+export const DEPRECATION: string | null = "superseded by vtc/elections/show/0.6";
 
 /**
  * Stable alias for this specification's request payload shape.
  *
- * @deprecated superseded by vtc/elections/show/0.3
+ * @deprecated superseded by vtc/elections/show/0.6
  */
 export type Payload = VTCElectionsShowPayload;
 
@@ -126,7 +126,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/elections/show
 /**
  * Stable alias for this specification's success-response payload shape.
  *
- * @deprecated superseded by vtc/elections/show/0.3
+ * @deprecated superseded by vtc/elections/show/0.6
  */
 export type Response = VTCElectionsShowResponsePayload;
 

package/src/vtc/elections/show/0.3/payload.ts

@@ -21,6 +21,8 @@ export type RegistrarState =
 
 /**
  * A member or an administrator reads one election of the community whole: its manifest, state, voting parameters, disclosure, the board checkpoints the community kept and, once certified, the certified result. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ *
+ * @deprecated superseded by vtc/elections/show/0.6
  */
 export interface VTCElectionsShowPayload {
   electionId: ElectionId;
@@ -28,6 +30,8 @@ export interface VTCElectionsShowPayload {
 }
 /**
  * Success response to vtc/elections/show/0.1: one election, whole.
+ *
+ * @deprecated superseded by vtc/elections/show/0.6
  */
 export interface VTCElectionsShowResponsePayload {
   manifest: Manifest;
@@ -107,15 +111,23 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = null;
+export const DEPRECATION: string | null = "superseded by vtc/elections/show/0.6";
 
-/** Stable alias for this specification's request payload shape. */
+/**
+ * Stable alias for this specification's request payload shape.
+ *
+ * @deprecated superseded by vtc/elections/show/0.6
+ */
 export type Payload = VTCElectionsShowPayload;
 
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/elections/show/0.3#response" as const;
 
-/** Stable alias for this specification's success-response payload shape. */
+/**
+ * Stable alias for this specification's success-response payload shape.
+ *
+ * @deprecated superseded by vtc/elections/show/0.6
+ */
 export type Response = VTCElectionsShowResponsePayload;
 
 /**