@openvtc/trust-tasks 0.26.23 → 0.26.25

package/src/vta/pcs/voter/read/0.1/payload.ts

@@ -0,0 +1,347 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/voter/read/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * A voter's client asks its VTA for a vtc/elections/list or vtc/elections/show request signed as the voter's membership DID, so the client can read the community's elections as the member without holding the member's key.
+ */
+export interface VTAPCSVoterReadPayload {
+  /**
+   * The context the voter belongs to.
+   */
+  contextId: string;
+  /**
+   * The community's DID: the recipient of the signed request.
+   */
+  community: string;
+  /**
+   * The voter's membership DID at the community. MUST be a DID the engine holds an authentication key of that the caller may act as.
+   */
+  member: string;
+  /**
+   * Which read to sign: vtc/elections/list/0.1 or vtc/elections/show/0.1.
+   */
+  read: "list" | "show";
+  /**
+   * The request payload of that task, validated against its own schema.
+   */
+  payload: {};
+  ext?: Ext;
+}
+/**
+ * The signed read, to send to the community.
+ */
+export interface VTAPCSVoterReadResponsePayload {
+  document: ReadDocument;
+  ext?: Ext;
+}
+/**
+ * A complete, signed vtc/elections/list/0.1 or vtc/elections/show/0.1 request document, ready to send to the community unchanged.
+ */
+export interface ReadDocument {
+  id: string;
+  type: "https://trusttasks.org/spec/vtc/elections/list/0.1" | "https://trusttasks.org/spec/vtc/elections/show/0.1";
+  /**
+   * The request's `member`.
+   */
+  issuer: string;
+  /**
+   * The request's `community`.
+   */
+  recipient: string;
+  issuedAt: string;
+  expiresAt?: string;
+  /**
+   * The request's `payload`, exactly.
+   */
+  payload: {};
+  /**
+   * A Data Integrity proof by an `authentication` key of `issuer`.
+   */
+  proof: {};
+}
+
+/** 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/vta/pcs/voter/read/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAPCSVoterReadPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/voter/read/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAPCSVoterReadResponsePayload;
+
+/**
+ * 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/read/0.1",
+  "title": "VTA PCS — Voter Read — payload",
+  "description": "A voter's client asks its VTA for a vtc/elections/list or vtc/elections/show request signed as the voter's membership DID, so the client can read the community's elections as the member without holding the member's key.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "community",
+    "member",
+    "read",
+    "payload"
+  ],
+  "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: the recipient of the signed request."
+    },
+    "member": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2048,
+      "pattern": "^did:",
+      "description": "The voter's membership DID at the community. MUST be a DID the engine holds an authentication key of that the caller may act as."
+    },
+    "read": {
+      "type": "string",
+      "enum": [
+        "list",
+        "show"
+      ],
+      "description": "Which read to sign: vtc/elections/list/0.1 or vtc/elections/show/0.1."
+    },
+    "payload": {
+      "type": "object",
+      "description": "The request payload of that task, validated against its own schema."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "ReadDocument": {
+      "title": "ReadDocument",
+      "description": "A complete, signed vtc/elections/list/0.1 or vtc/elections/show/0.1 request document, ready to send to the community unchanged.",
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "issuer",
+        "recipient",
+        "issuedAt",
+        "payload",
+        "proof"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "https://trusttasks.org/spec/vtc/elections/list/0.1",
+            "https://trusttasks.org/spec/vtc/elections/show/0.1"
+          ]
+        },
+        "issuer": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `member`."
+        },
+        "recipient": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `community`."
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "payload": {
+          "type": "object",
+          "description": "The request's `payload`, exactly."
+        },
+        "proof": {
+          "type": "object",
+          "description": "A Data Integrity proof by an `authentication` key of `issuer`."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Voter Read — response payload",
+      "description": "The signed read, to send to the community.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "document"
+      ],
+      "properties": {
+        "document": {
+          "$ref": "#/$defs/ReadDocument"
+        },
+        "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": {
+    "ReadDocument": {
+      "title": "ReadDocument",
+      "description": "A complete, signed vtc/elections/list/0.1 or vtc/elections/show/0.1 request document, ready to send to the community unchanged.",
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "issuer",
+        "recipient",
+        "issuedAt",
+        "payload",
+        "proof"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "https://trusttasks.org/spec/vtc/elections/list/0.1",
+            "https://trusttasks.org/spec/vtc/elections/show/0.1"
+          ]
+        },
+        "issuer": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `member`."
+        },
+        "recipient": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `community`."
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "payload": {
+          "type": "object",
+          "description": "The request's `payload`, exactly."
+        },
+        "proof": {
+          "type": "object",
+          "description": "A Data Integrity proof by an `authentication` key of `issuer`."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Voter Read — response payload",
+      "description": "The signed read, to send to the community.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "document"
+      ],
+      "properties": {
+        "document": {
+          "$ref": "#/$defs/ReadDocument"
+        },
+        "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: 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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vta/pcs/voter/register/0.1/payload.ts

@@ -31,10 +31,14 @@ export interface VTAPCSVoterRegisterPayload {
    * The election's manifest, exactly as the community published it. The engine computes its digest itself.
    */
   manifest: Manifest;
+  /**
+   * The DID the election's roll admits the voter as — their membership DID at the community. When given, the engine also returns `ticketDocument`: the request to the community, signed as this DID. It MUST be a DID the engine holds an authentication key of that the caller may act as.
+   */
+  member?: string;
   ext?: Ext;
 }
 /**
- * Exactly the vtc/elections/tickets/issue/0.1 request payload, without its ext: what the client sends the community.
+ * Exactly the vtc/elections/tickets/issue/0.1 request payload, without its ext — and, when the request named `member`, that request as a document signed as the member.
  */
 export interface VTAPCSVoterRegisterResponsePayload {
   electionId: ElectionId;
@@ -43,6 +47,7 @@ export interface VTAPCSVoterRegisterResponsePayload {
    */
   manifestDigest: DigestMultibase;
   request: TicketRequest;
+  ticketDocument?: TicketDocument;
   ext?: Ext;
 }
 /**
@@ -66,6 +71,31 @@ export interface TicketRequest {
     proof: string;
   };
 }
+/**
+ * A complete, signed vtc/elections/tickets/issue/0.1 request document, ready to send to the community unchanged. Its payload is validated by that specification's schema; the members fixed here are the ones this task guarantees.
+ */
+export interface TicketDocument {
+  id: string;
+  type: "https://trusttasks.org/spec/vtc/elections/tickets/issue/0.1";
+  /**
+   * The request's `member`.
+   */
+  issuer: string;
+  /**
+   * The request's `community`.
+   */
+  recipient: string;
+  issuedAt: string;
+  expiresAt?: string;
+  /**
+   * The vtc/elections/tickets/issue/0.1 request payload: `electionId`, `manifestDigest` and `request`, exactly as this response carries them.
+   */
+  payload: {};
+  /**
+   * A Data Integrity proof by an `authentication` key of `issuer`.
+   */
+  proof: {};
+}
 
 /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
 export type { BoardVisibility, ChoiceQuestion, DigestMultibase, ElectionId, Ext, Key, Manifest, Multibase, Question, QuestionOption, RankingQuestion, Revote, RollRule, ScoreQuestion, SecrecyLevel, TextQuestion, Trustees, VotingParameters };
@@ -125,6 +155,13 @@ export const PAYLOAD_SCHEMA = {
       "$ref": "#/$defs/Manifest",
       "description": "The election's manifest, exactly as the community published it. The engine computes its digest itself."
     },
+    "member": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2048,
+      "pattern": "^did:",
+      "description": "The DID the election's roll admits the voter as — their membership DID at the community. When given, the engine also returns `ticketDocument`: the request to the community, signed as this DID. It MUST be a DID the engine holds an authentication key of that the caller may act as."
+    },
     "ext": {
       "$ref": "#/$defs/Ext"
     }
@@ -184,7 +221,7 @@ export const PAYLOAD_SCHEMA = {
     "Response": {
       "$anchor": "response",
       "title": "VTA PCS — Voter Register — response payload",
-      "description": "Exactly the vtc/elections/tickets/issue/0.1 request payload, without its ext: what the client sends the community.",
+      "description": "Exactly the vtc/elections/tickets/issue/0.1 request payload, without its ext — and, when the request named `member`, that request as a document signed as the member.",
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -203,11 +240,65 @@ export const PAYLOAD_SCHEMA = {
         "request": {
           "$ref": "#/$defs/TicketRequest"
         },
+        "ticketDocument": {
+          "$ref": "#/$defs/TicketDocument"
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
       }
     },
+    "TicketDocument": {
+      "title": "TicketDocument",
+      "description": "A complete, signed vtc/elections/tickets/issue/0.1 request document, ready to send to the community unchanged. Its payload is validated by that specification's schema; the members fixed here are the ones this task guarantees.",
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "issuer",
+        "recipient",
+        "issuedAt",
+        "payload",
+        "proof"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "type": {
+          "const": "https://trusttasks.org/spec/vtc/elections/tickets/issue/0.1"
+        },
+        "issuer": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `member`."
+        },
+        "recipient": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `community`."
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "payload": {
+          "type": "object",
+          "description": "The vtc/elections/tickets/issue/0.1 request payload: `electionId`, `manifestDigest` and `request`, exactly as this response carries them."
+        },
+        "proof": {
+          "type": "object",
+          "description": "A Data Integrity proof by an `authentication` key of `issuer`."
+        }
+      }
+    },
     "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.",
@@ -712,7 +803,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
     "Response": {
       "$anchor": "response",
       "title": "VTA PCS — Voter Register — response payload",
-      "description": "Exactly the vtc/elections/tickets/issue/0.1 request payload, without its ext: what the client sends the community.",
+      "description": "Exactly the vtc/elections/tickets/issue/0.1 request payload, without its ext — and, when the request named `member`, that request as a document signed as the member.",
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -731,11 +822,65 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "request": {
           "$ref": "#/$defs/TicketRequest"
         },
+        "ticketDocument": {
+          "$ref": "#/$defs/TicketDocument"
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
       }
     },
+    "TicketDocument": {
+      "title": "TicketDocument",
+      "description": "A complete, signed vtc/elections/tickets/issue/0.1 request document, ready to send to the community unchanged. Its payload is validated by that specification's schema; the members fixed here are the ones this task guarantees.",
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "issuer",
+        "recipient",
+        "issuedAt",
+        "payload",
+        "proof"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "type": {
+          "const": "https://trusttasks.org/spec/vtc/elections/tickets/issue/0.1"
+        },
+        "issuer": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `member`."
+        },
+        "recipient": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "The request's `community`."
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "payload": {
+          "type": "object",
+          "description": "The vtc/elections/tickets/issue/0.1 request payload: `electionId`, `manifestDigest` and `request`, exactly as this response carries them."
+        },
+        "proof": {
+          "type": "object",
+          "description": "A Data Integrity proof by an `authentication` key of `issuer`."
+        }
+      }
+    },
     "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.",

package/src/vtc/_shared/0.1/community-room.ts

@@ -14,4 +14,4 @@ export interface VTCSharedCommunityOwnedRoomDefinitions {
  * The definitions this shared schema publishes, hoisted to one declaration each.
  * See "../../../_shared/components.js".
  */
-export type { CommunityRoom, CommunityRoomV2, MemberAction, MemberActions, MemberState, Offer, OfferCredentials, OfferV2, Reason, RoomDescription, RoomLabel, RoomMember, RoomMembership, RoomTag, RoomTags } from "../../../_shared/components.js";
+export type { CommunityRoom, CommunityRoomV2, MemberAction, MemberActions, MemberState, Offer, OfferCredentials, OfferV2, Reason, Renewal, RenewalCredentials, RoomDescription, RoomLabel, RoomMember, RoomMembership, RoomTag, RoomTags } from "../../../_shared/components.js";

package/src/vtc/groups/bindings/add/0.1/payload.ts

@@ -244,7 +244,7 @@ export const PAYLOAD_SCHEMA = {
     },
     "RoomBindingSpec": {
       "title": "RoomBindingSpec",
-      "description": "Links a room the community owns to the group: joining the group offers the member admission to the room with `actions`, valid for `validFor`; leaving removes them unless another source still covers them.",
+      "description": "Links a room the community owns to the group: joining the group offers the member admission to the room with `actions`, valid for `validFor`, renewed while they stay in the group (collected with vtc/rooms/offers/list at 0.3 or later); leaving removes them unless another source still covers them.",
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -478,7 +478,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
     },
     "RoomBindingSpec": {
       "title": "RoomBindingSpec",
-      "description": "Links a room the community owns to the group: joining the group offers the member admission to the room with `actions`, valid for `validFor`; leaving removes them unless another source still covers them.",
+      "description": "Links a room the community owns to the group: joining the group offers the member admission to the room with `actions`, valid for `validFor`, renewed while they stay in the group (collected with vtc/rooms/offers/list at 0.3 or later); leaving removes them unless another source still covers them.",
       "type": "object",
       "additionalProperties": false,
       "required": [

package/src/vtc/groups/bindings/list/0.1/payload.ts

@@ -235,7 +235,7 @@ export const PAYLOAD_SCHEMA = {
     },
     "RoomBindingSpec": {
       "title": "RoomBindingSpec",
-      "description": "Links a room the community owns to the group: joining the group offers the member admission to the room with `actions`, valid for `validFor`; leaving removes them unless another source still covers them.",
+      "description": "Links a room the community owns to the group: joining the group offers the member admission to the room with `actions`, valid for `validFor`, renewed while they stay in the group (collected with vtc/rooms/offers/list at 0.3 or later); leaving removes them unless another source still covers them.",
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -473,7 +473,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
     },
     "RoomBindingSpec": {
       "title": "RoomBindingSpec",
-      "description": "Links a room the community owns to the group: joining the group offers the member admission to the room with `actions`, valid for `validFor`; leaving removes them unless another source still covers them.",
+      "description": "Links a room the community owns to the group: joining the group offers the member admission to the room with `actions`, valid for `validFor`, renewed while they stay in the group (collected with vtc/rooms/offers/list at 0.3 or later); leaving removes them unless another source still covers them.",
       "type": "object",
       "additionalProperties": false,
       "required": [