@openvtc/trust-tasks 0.28.13 → 0.28.15

package/src/vtc/boards/delete/0.1/payload.ts

@@ -0,0 +1,293 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/boards/delete/0.1/payload.schema.json
+ */
+
+import type { BoardId, Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * A board manager deletes a closed board: its ideas, notes and each election's content are removed, and each election keeps only a tombstone for the community's tombstone retention. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCBoardsDeletePayload {
+  boardId: BoardId;
+  /**
+   * Why, recorded with the deletion in the community's audit trail.
+   */
+  reason: string;
+  ext?: Ext;
+}
+/**
+ * The success response to a vtc/boards/delete/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/delete/0.1#response.
+ */
+export interface VTCBoardsDeleteResponsePayload {
+  boardId: BoardId;
+  ideasRemoved: number;
+  notesRemoved: number;
+  /**
+   * Elections whose content the community removed. Each keeps a tombstone unless the retention is zero.
+   */
+  electionsRemoved: number;
+  /**
+   * What the community keeps of the board's elections (VTI-BRD-007, VTI-BRD-008).
+   */
+  tombstones: {
+    /**
+     * Tombstones kept: each an election's identifier, manifest digest and the board heads the community kept. Zero when the retention is zero.
+     */
+    kept: number;
+    /**
+     * When they are removed. Absent when the retention is unbounded, or when none was kept.
+     */
+    removeAt?: string;
+  };
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { BoardId, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/boards/delete/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 = VTCBoardsDeletePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/boards/delete/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCBoardsDeleteResponsePayload;
+
+/**
+ * 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/delete/0.1",
+  "title": "VTC Boards — Delete — payload",
+  "description": "A board manager deletes a closed board: its ideas, notes and each election's content are removed, and each election keeps only a tombstone for the community's tombstone retention. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "boardId",
+    "reason"
+  ],
+  "properties": {
+    "boardId": {
+      "$ref": "#/$defs/BoardId"
+    },
+    "reason": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "description": "Why, recorded with the deletion in the community's audit trail."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Boards — Delete — response payload",
+      "description": "The success response to a vtc/boards/delete/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/delete/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "boardId",
+        "ideasRemoved",
+        "notesRemoved",
+        "electionsRemoved",
+        "tombstones"
+      ],
+      "properties": {
+        "boardId": {
+          "$ref": "#/$defs/BoardId"
+        },
+        "ideasRemoved": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "notesRemoved": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "electionsRemoved": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Elections whose content the community removed. Each keeps a tombstone unless the retention is zero."
+        },
+        "tombstones": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "kept"
+          ],
+          "description": "What the community keeps of the board's elections (VTI-BRD-007, VTI-BRD-008).",
+          "properties": {
+            "kept": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Tombstones kept: each an election's identifier, manifest digest and the board heads the community kept. Zero when the retention is zero."
+            },
+            "removeAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "When they are removed. Absent when the retention is unbounded, or when none was kept."
+            }
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "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 — Delete — response payload",
+      "description": "The success response to a vtc/boards/delete/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/delete/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "boardId",
+        "ideasRemoved",
+        "notesRemoved",
+        "electionsRemoved",
+        "tombstones"
+      ],
+      "properties": {
+        "boardId": {
+          "$ref": "#/$defs/BoardId"
+        },
+        "ideasRemoved": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "notesRemoved": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "electionsRemoved": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Elections whose content the community removed. Each keeps a tombstone unless the retention is zero."
+        },
+        "tombstones": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "kept"
+          ],
+          "description": "What the community keeps of the board's elections (VTI-BRD-007, VTI-BRD-008).",
+          "properties": {
+            "kept": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Tombstones kept: each an election's identifier, manifest digest and the board heads the community kept. Zero when the retention is zero."
+            },
+            "removeAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "When they are removed. Absent when the retention is unbounded, or when none was kept."
+            }
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "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;

package/src/vtc/boards/update/0.1/payload.ts

@@ -3,7 +3,7 @@
  * Source: specs/vtc/boards/update/0.1/payload.schema.json
  */
 
-import type { Board, BoardAudience, BoardDescription, BoardId, BoardStatus, BoardTitle, BoardVisibility, ChoiceQuestion, ElectionTemplate, Ext, GroupId, IdeaFormat, Key_VotingV0_1 as Key, Question, QuestionOption, RankingQuestion, Revote, ScoreQuestion, SecrecyLevel, Slot_VtcBoardsV0_1 as Slot, TextQuestion, Topic_VtcBoardsV0_1 as Topic, Trustees, Window } from "../../../../_shared/components.js";
+import type { Board, BoardAudience, BoardDescription, BoardId, BoardStatus, BoardTitle, BoardVisibility, ChoiceQuestion, ElectionTemplate, Ext, GroupId, IdeaFormat, IdeaId, Key_VotingV0_1 as Key, Question, QuestionOption, RankingQuestion, Revote, ScoreQuestion, SecrecyLevel, Slot_VtcBoardsV0_1 as Slot, TextQuestion, Topic_VtcBoardsV0_1 as Topic, Trustees, Window } from "../../../../_shared/components.js";
 
 
 /**
@@ -157,11 +157,28 @@ export interface VTCBoardsUpdatePayload {
  */
 export interface VTCBoardsUpdateResponsePayload {
   board: Board;
+  /**
+   * Present when this update closed the board: how its voting was ended (VTI-BRD-006). Counts the requests made; the ballot box answers them after this response.
+   */
+  closing?: {
+    /**
+     * Elections open for voting that were closed early; each is counted as it stood, and the count is final.
+     */
+    closedEarly: number;
+    /**
+     * Elections not yet open for voting, or not yet registered, that were cancelled; their ideas are not selected.
+     */
+    cancelled: number;
+    /**
+     * Ideas whose election does not allow closing early and closes when its manifest says.
+     */
+    runningToClose: IdeaId[];
+  };
   ext?: Ext;
 }
 
 /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
-export type { Board, BoardAudience, BoardDescription, BoardId, BoardStatus, BoardTitle, BoardVisibility, ChoiceQuestion, ElectionTemplate, Ext, GroupId, IdeaFormat, Key, Question, QuestionOption, RankingQuestion, Revote, ScoreQuestion, SecrecyLevel, Slot, TextQuestion, Topic, Trustees, Window };
+export type { Board, BoardAudience, BoardDescription, BoardId, BoardStatus, BoardTitle, BoardVisibility, ChoiceQuestion, ElectionTemplate, Ext, GroupId, IdeaFormat, IdeaId, Key, Question, QuestionOption, RankingQuestion, Revote, ScoreQuestion, SecrecyLevel, Slot, TextQuestion, Topic, Trustees, Window };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/boards/update/0.1" as const;
@@ -291,6 +308,36 @@ export const PAYLOAD_SCHEMA = {
         "board": {
           "$ref": "#/$defs/Board"
         },
+        "closing": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "closedEarly",
+            "cancelled",
+            "runningToClose"
+          ],
+          "description": "Present when this update closed the board: how its voting was ended (VTI-BRD-006). Counts the requests made; the ballot box answers them after this response.",
+          "properties": {
+            "closedEarly": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Elections open for voting that were closed early; each is counted as it stood, and the count is final."
+            },
+            "cancelled": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Elections not yet open for voting, or not yet registered, that were cancelled; their ideas are not selected."
+            },
+            "runningToClose": {
+              "type": "array",
+              "items": {
+                "$ref": "#/$defs/IdeaId"
+              },
+              "uniqueItems": true,
+              "description": "Ideas whose election does not allow closing early and closes when its manifest says."
+            }
+          }
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
@@ -306,6 +353,12 @@ export const PAYLOAD_SCHEMA = {
         "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
       }
     },
+    "IdeaId": {
+      "title": "IdeaId",
+      "description": "Opaque identifier of an idea: `ida_` followed by 16 to 64 base64url characters. Random and unique within the community.",
+      "type": "string",
+      "pattern": "^ida_[A-Za-z0-9_-]{16,64}$"
+    },
     "Board": {
       "title": "Board",
       "description": "A board as one caller may see it.",
@@ -904,6 +957,36 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "board": {
           "$ref": "#/$defs/Board"
         },
+        "closing": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "closedEarly",
+            "cancelled",
+            "runningToClose"
+          ],
+          "description": "Present when this update closed the board: how its voting was ended (VTI-BRD-006). Counts the requests made; the ballot box answers them after this response.",
+          "properties": {
+            "closedEarly": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Elections open for voting that were closed early; each is counted as it stood, and the count is final."
+            },
+            "cancelled": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Elections not yet open for voting, or not yet registered, that were cancelled; their ideas are not selected."
+            },
+            "runningToClose": {
+              "type": "array",
+              "items": {
+                "$ref": "#/$defs/IdeaId"
+              },
+              "uniqueItems": true,
+              "description": "Ideas whose election does not allow closing early and closes when its manifest says."
+            }
+          }
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
@@ -919,6 +1002,12 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
       }
     },
+    "IdeaId": {
+      "title": "IdeaId",
+      "description": "Opaque identifier of an idea: `ida_` followed by 16 to 64 base64url characters. Random and unique within the community.",
+      "type": "string",
+      "pattern": "^ida_[A-Za-z0-9_-]{16,64}$"
+    },
     "Board": {
       "title": "Board",
       "description": "A board as one caller may see it.",

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

@@ -20,7 +20,7 @@ export type RegistrarState =
   | "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.
+ * 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), nor one whose credential roll names a group the community has deleted to any caller but an administrator (VTI-VOT-029). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
  */
 export interface VTCElectionsListPayload {
   state?: RegistrarState;
@@ -114,7 +114,7 @@ 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.",
+  "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), nor one whose credential roll names a group the community has deleted to any caller but an administrator (VTI-VOT-029). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
   "type": "object",
   "additionalProperties": false,
   "properties": {

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

@@ -25,7 +25,7 @@ export type RegistrarState =
 export interface VTCElectionsShowPayload {
   electionId: ElectionId;
   /**
-   * Only where the reader means to read an election whose `credential` roll (voting/_shared/0.4 `RollRule`) names a member party — a party other than the community and its groups — and the community's records do not otherwise admit them: the reader's presentation of its membership credential for the party `roll.memberOf` names, made by the credential's subject — who signs this document — and bound to this document (VTI-VOT-015, checked as VTI-VOT-025 requires). The community verifies it before, and without reference to, the election the request names, answering `indeterminate` whatever the election where a status list, a trust registry or the issuer's DID document cannot be obtained; it uses the outcome only for such an election, and discards the presentation once it has decided. Without one that passes, such an election is answered `electionUnknown`.
+   * Only where the reader means to read an election whose `credential` roll (voting/_shared/0.4 `RollRule`) names a member party — a party other than the community and its groups that is itself a member of the community, never a group the community has since deleted (VTI-VOT-029) — and the community's records do not otherwise admit them: the reader's presentation of its membership credential for the party `roll.memberOf` names, made by the credential's subject — who signs this document — and bound to this document (VTI-VOT-015, checked as VTI-VOT-025 requires). The community verifies it before, and without reference to, the election the request names, answering `indeterminate` whatever the election where a status list, a trust registry or the issuer's DID document cannot be obtained; it uses the outcome only for such an election, and discards the presentation once it has decided. Without one that passes, such an election is answered `electionUnknown`.
    */
   presentation?: {} | string;
   ext?: Ext;
@@ -146,7 +146,7 @@ export const PAYLOAD_SCHEMA = {
       "$ref": "#/$defs/ElectionId"
     },
     "presentation": {
-      "description": "Only where the reader means to read an election whose `credential` roll (voting/_shared/0.4 `RollRule`) names a member party — a party other than the community and its groups — and the community's records do not otherwise admit them: the reader's presentation of its membership credential for the party `roll.memberOf` names, made by the credential's subject — who signs this document — and bound to this document (VTI-VOT-015, checked as VTI-VOT-025 requires). The community verifies it before, and without reference to, the election the request names, answering `indeterminate` whatever the election where a status list, a trust registry or the issuer's DID document cannot be obtained; it uses the outcome only for such an election, and discards the presentation once it has decided. Without one that passes, such an election is answered `electionUnknown`.",
+      "description": "Only where the reader means to read an election whose `credential` roll (voting/_shared/0.4 `RollRule`) names a member party — a party other than the community and its groups that is itself a member of the community, never a group the community has since deleted (VTI-VOT-029) — and the community's records do not otherwise admit them: the reader's presentation of its membership credential for the party `roll.memberOf` names, made by the credential's subject — who signs this document — and bound to this document (VTI-VOT-015, checked as VTI-VOT-025 requires). The community verifies it before, and without reference to, the election the request names, answering `indeterminate` whatever the election where a status list, a trust registry or the issuer's DID document cannot be obtained; it uses the outcome only for such an election, and discards the presentation once it has decided. Without one that passes, such an election is answered `electionUnknown`.",
       "anyOf": [
         {
           "type": "object",