@openvtc/trust-tasks 0.28.15 → 0.28.17

package/src/vta/pcs/voter/receipts/list/0.1/payload.ts

@@ -0,0 +1,255 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/voter/receipts/list/0.1/payload.schema.json
+ */
+
+import type { ElectionId, Ext } from "../../../../../../_shared/components.js";
+
+
+/**
+ * A voter's client asks its VTA for the receipts it keeps for one election, whole and exactly as received, so that after voting closes the client can fetch each cast's inclusion proof from the ballot box and hand it, with the head the community kept at close, to vta/pcs/voter/receipt (VTI-VOT-053). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTAPCSVoterReceiptsListPayload {
+  /**
+   * The context the voter belongs to.
+   */
+  contextId: string;
+  /**
+   * The community's DID.
+   */
+  community: string;
+  electionId: ElectionId;
+  ext?: Ext;
+}
+/**
+ * The success response to a vta/pcs/voter/receipts/list/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/pcs/voter/receipts/list/0.1#response.
+ */
+export interface VTAPCSVoterReceiptsListResponsePayload {
+  electionId: ElectionId;
+  /**
+   * The ballot box the engine recorded at vta/pcs/voter/register: the DID every receipt is signed by, and the one to ask for each cast's inclusion proof.
+   */
+  ballotBox: string;
+  /**
+   * Every receipt the engine keeps for the election, in the order it kept them: one per cast the ballot box admitted, a revote's beside the cast it replaced. Each is the ballot box's signed voting/ballot/cast/0.1 or voting/ballot/cast-encrypted/0.1 #response document, whole and exactly as received — its `receiptToken` included, which on a private board is what authorizes the inclusion read. Empty when no receipt was kept.
+   *
+   * @maxItems 64
+   */
+  receipts: {}[];
+  ext?: Ext;
+}
+
+/** 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/vta/pcs/voter/receipts/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 = VTAPCSVoterReceiptsListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/voter/receipts/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAPCSVoterReceiptsListResponsePayload;
+
+/**
+ * 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/receipts/list/0.1",
+  "title": "VTA PCS — Voter Receipts — List — payload",
+  "description": "A voter's client asks its VTA for the receipts it keeps for one election, whole and exactly as received, so that after voting closes the client can fetch each cast's inclusion proof from the ballot box and hand it, with the head the community kept at close, to vta/pcs/voter/receipt (VTI-VOT-053). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "community",
+    "electionId"
+  ],
+  "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."
+    },
+    "electionId": {
+      "$ref": "#/$defs/ElectionId"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Voter Receipts — List — response payload",
+      "description": "The success response to a vta/pcs/voter/receipts/list/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/pcs/voter/receipts/list/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "electionId",
+        "ballotBox",
+        "receipts"
+      ],
+      "properties": {
+        "electionId": {
+          "$ref": "#/$defs/ElectionId"
+        },
+        "ballotBox": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "pattern": "^did:",
+          "description": "The ballot box the engine recorded at vta/pcs/voter/register: the DID every receipt is signed by, and the one to ask for each cast's inclusion proof."
+        },
+        "receipts": {
+          "type": "array",
+          "maxItems": 64,
+          "description": "Every receipt the engine keeps for the election, in the order it kept them: one per cast the ballot box admitted, a revote's beside the cast it replaced. Each is the ballot box's signed voting/ballot/cast/0.1 or voting/ballot/cast-encrypted/0.1 #response document, whole and exactly as received — its `receiptToken` included, which on a private board is what authorizes the inclusion read. Empty when no receipt was kept.",
+          "items": {
+            "type": "object"
+          }
+        },
+        "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": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Voter Receipts — List — response payload",
+      "description": "The success response to a vta/pcs/voter/receipts/list/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/pcs/voter/receipts/list/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "electionId",
+        "ballotBox",
+        "receipts"
+      ],
+      "properties": {
+        "electionId": {
+          "$ref": "#/$defs/ElectionId"
+        },
+        "ballotBox": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "pattern": "^did:",
+          "description": "The ballot box the engine recorded at vta/pcs/voter/register: the DID every receipt is signed by, and the one to ask for each cast's inclusion proof."
+        },
+        "receipts": {
+          "type": "array",
+          "maxItems": 64,
+          "description": "Every receipt the engine keeps for the election, in the order it kept them: one per cast the ballot box admitted, a revote's beside the cast it replaced. Each is the ballot box's signed voting/ballot/cast/0.1 or voting/ballot/cast-encrypted/0.1 #response document, whole and exactly as received — its `receiptToken` included, which on a private board is what authorizes the inclusion read. Empty when no receipt was kept.",
+          "items": {
+            "type": "object"
+          }
+        },
+        "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: true,
+  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/boards/facilitators/add/0.1/payload.ts

@@ -0,0 +1,246 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/boards/facilitators/add/0.1/payload.schema.json
+ */
+
+import type { BoardId, EntryId, Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * A facilitator of a board appoints an active member a facilitator of that board: an access-control resource grant of `vtc.boards.manage` qualified to the board (VTI-BRD-090). The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCBoardsFacilitatorsAddPayload {
+  boardId: BoardId;
+  /**
+   * The member appointed.
+   */
+  entryId: EntryId;
+  /**
+   * Why, recorded with the change. Plain text.
+   */
+  reason?: string;
+  ext?: Ext;
+}
+/**
+ * The success response to a vtc/boards/facilitators/add/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/facilitators/add/0.1#response. The board's appointed facilitators after the appointment.
+ */
+export interface VTCBoardsFacilitatorsAddResponsePayload {
+  boardId: BoardId;
+  /**
+   * The board's appointed facilitators after the change, by entry: entries holding `vtc.boards.manage` qualified to this board, read from the access-control list. Holders of the capability unqualified or through a role are not listed (VTI-BRD-093).
+   *
+   * @maxItems 256
+   */
+  facilitators: EntryId[];
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { BoardId, EntryId, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/boards/facilitators/add/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 = VTCBoardsFacilitatorsAddPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/boards/facilitators/add/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCBoardsFacilitatorsAddResponsePayload;
+
+/**
+ * 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/boards/facilitators/add/0.1",
+  "title": "VTC Boards — Facilitators — Add — payload",
+  "description": "A facilitator of a board appoints an active member a facilitator of that board: an access-control resource grant of `vtc.boards.manage` qualified to the board (VTI-BRD-090). The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "boardId",
+    "entryId"
+  ],
+  "properties": {
+    "boardId": {
+      "$ref": "#/$defs/BoardId"
+    },
+    "entryId": {
+      "$ref": "#/$defs/EntryId",
+      "description": "The member appointed."
+    },
+    "reason": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "description": "Why, recorded with the change. Plain text."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Boards — Facilitators — Add — response payload",
+      "description": "The success response to a vtc/boards/facilitators/add/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/facilitators/add/0.1#response. The board's appointed facilitators after the appointment.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "boardId",
+        "facilitators"
+      ],
+      "properties": {
+        "boardId": {
+          "$ref": "#/$defs/BoardId"
+        },
+        "facilitators": {
+          "type": "array",
+          "maxItems": 256,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/EntryId"
+          },
+          "description": "The board's appointed facilitators after the change, by entry: entries holding `vtc.boards.manage` qualified to this board, read from the access-control list. Holders of the capability unqualified or through a role are not listed (VTI-BRD-093)."
+        },
+        "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-]+)+$"
+      }
+    },
+    "EntryId": {
+      "title": "EntryId",
+      "description": "Opaque identifier of one directory entry: `dir_` followed by 16 to 64 base64url characters. Random, scoped to one community, and stable for the life of the membership — it survives a rotation of the member's DID, which is why groups, notes and cards are keyed by it. It MUST NOT be derived from, and MUST NOT reveal, any DID of the member, and the same person's entries in two communities MUST NOT share one. Compared by exact string equality.",
+      "type": "string",
+      "pattern": "^dir_[A-Za-z0-9_-]{16,64}$"
+    },
+    "BoardId": {
+      "title": "BoardId",
+      "description": "Opaque identifier of a board: `brd_` followed by 16 to 64 base64url characters. Random, community-scoped, never reused (VTI-BRD-001).",
+      "type": "string",
+      "pattern": "^brd_[A-Za-z0-9_-]{16,64}$"
+    }
+  }
+} 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 Boards — Facilitators — Add — response payload",
+      "description": "The success response to a vtc/boards/facilitators/add/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/facilitators/add/0.1#response. The board's appointed facilitators after the appointment.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "boardId",
+        "facilitators"
+      ],
+      "properties": {
+        "boardId": {
+          "$ref": "#/$defs/BoardId"
+        },
+        "facilitators": {
+          "type": "array",
+          "maxItems": 256,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/EntryId"
+          },
+          "description": "The board's appointed facilitators after the change, by entry: entries holding `vtc.boards.manage` qualified to this board, read from the access-control list. Holders of the capability unqualified or through a role are not listed (VTI-BRD-093)."
+        },
+        "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-]+)+$"
+      }
+    },
+    "EntryId": {
+      "title": "EntryId",
+      "description": "Opaque identifier of one directory entry: `dir_` followed by 16 to 64 base64url characters. Random, scoped to one community, and stable for the life of the membership — it survives a rotation of the member's DID, which is why groups, notes and cards are keyed by it. It MUST NOT be derived from, and MUST NOT reveal, any DID of the member, and the same person's entries in two communities MUST NOT share one. Compared by exact string equality.",
+      "type": "string",
+      "pattern": "^dir_[A-Za-z0-9_-]{16,64}$"
+    },
+    "BoardId": {
+      "title": "BoardId",
+      "description": "Opaque identifier of a board: `brd_` followed by 16 to 64 base64url characters. Random, community-scoped, never reused (VTI-BRD-001).",
+      "type": "string",
+      "pattern": "^brd_[A-Za-z0-9_-]{16,64}$"
+    }
+  }
+} 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;