@openvtc/trust-tasks 0.27.4 → 0.27.5

package/src/vtc/admin/events/event/0.5/payload.ts

@@ -0,0 +1,137 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/admin/events/event/0.5/payload.schema.json
+ */
+
+import type { Ext, ResumeToken, Topic_VtcAdminEventsV0_4 as Topic } from "../../../../../_shared/components.js";
+
+
+/**
+ * One hint, sent by a Verifiable Trust Community down an administrator console's live channel: something under `topic` changed, re-read it. It never carries the record that changed. Fire-and-forget: there is no response. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCAdminEventsEventPayload {
+  /**
+   * What changed. Always one of the effective topics the subscribe response named.
+   */
+  topic: Topic;
+  /**
+   * When the community observed the change. Where it coalesced several changes into this hint, the latest of them.
+   */
+  observedAt: string;
+  /**
+   * Only on a count topic (`actions`, `acknowledgements`, `joinRequests`): the caller's current count for that topic as of `observedAt` — what a console badge shows. Absent on every other topic. A console MAY show it until its re-fetch returns, and MUST prefer the read's own count once it does.
+   */
+  count?: number;
+  /**
+   * The stream position after this hint. A console keeps the latest one and passes it back as `since` when it re-subscribes.
+   */
+  resumeToken: ResumeToken;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, ResumeToken, Topic };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/admin/events/event/0.5" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCAdminEventsEventPayload;
+
+/**
+ * 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/admin/events/event/0.5",
+  "title": "VTC Admin Events — Event — payload",
+  "description": "One hint, sent by a Verifiable Trust Community down an administrator console's live channel: something under `topic` changed, re-read it. It never carries the record that changed. Fire-and-forget: there is no response. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "topic",
+    "observedAt",
+    "resumeToken"
+  ],
+  "properties": {
+    "topic": {
+      "$ref": "#/$defs/Topic",
+      "description": "What changed. Always one of the effective topics the subscribe response named."
+    },
+    "observedAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the community observed the change. Where it coalesced several changes into this hint, the latest of them."
+    },
+    "count": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Only on a count topic (`actions`, `acknowledgements`, `joinRequests`): the caller's current count for that topic as of `observedAt` — what a console badge shows. Absent on every other topic. A console MAY show it until its re-fetch returns, and MUST prefer the read's own count once it does."
+    },
+    "resumeToken": {
+      "$ref": "#/$defs/ResumeToken",
+      "description": "The stream position after this hint. A console keeps the latest one and passes it back as `since` when it re-subscribes."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "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-]+)+$"
+      }
+    },
+    "ResumeToken": {
+      "title": "ResumeToken",
+      "description": "Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "^[A-Za-z0-9._~-]+$"
+    },
+    "Topic": {
+      "title": "Topic",
+      "description": "One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.",
+      "type": "string",
+      "enum": [
+        "actions",
+        "acknowledgements",
+        "joinRequests",
+        "members",
+        "singleAdminMode",
+        "config",
+        "rooms",
+        "directory",
+        "groups",
+        "communityRooms"
+      ]
+    }
+  }
+} 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;

package/src/vtc/admin/events/subscribe/0.6/payload.ts

@@ -0,0 +1,318 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/admin/events/subscribe/0.6/payload.schema.json
+ */
+
+import type { Ext, ResumeToken, Topic_VtcAdminEventsV0_4 as Topic } from "../../../../../_shared/components.js";
+
+
+/**
+ * Open an administrator console's live channel of hint-only events. The success response is the first document on a stream that then carries vtc/admin/events/event/0.5 documents; over HTTPS that stream is the streamed response of bindings/https/0.3 §2.1. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCAdminEventsSubscribePayload {
+  /**
+   * The topics the console renders. The community narrows this to the topics the caller may read and reports the result as the response's `topics`.
+   *
+   * @minItems 1
+   * @maxItems 10
+   */
+  topics:
+    | [Topic]
+    | [Topic, Topic]
+    | [Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic];
+  /**
+   * The last `resumeToken` the console received on an earlier stream, to resume from (named `since` before 0.5). A token the community does not recognise, has expired, or minted for another caller is not an error: the stream starts fresh and the response says `resumed: false`.
+   */
+  resumeToken?: ResumeToken;
+  ext?: Ext;
+}
+/**
+ * The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.
+ */
+export interface VTCAdminEventsSubscribeResponsePayload {
+  /**
+   * The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live.
+   *
+   * @minItems 1
+   * @maxItems 10
+   */
+  topics:
+    | [Topic]
+    | [Topic, Topic]
+    | [Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic]
+    | [Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic, Topic];
+  /**
+   * The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead.
+   */
+  heartbeatSeconds: number;
+  /**
+   * `true` when the community recognised the request's `resumeToken` and will send a hint for every effective topic that changed after it. `false` when no `resumeToken` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes.
+   */
+  resumed: boolean;
+  /**
+   * The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from.
+   */
+  resumeToken: ResumeToken;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, ResumeToken, Topic };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/admin/events/subscribe/0.6" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCAdminEventsSubscribePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/admin/events/subscribe/0.6#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCAdminEventsSubscribeResponsePayload;
+
+/**
+ * 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/admin/events/subscribe/0.6",
+  "title": "VTC Admin Events — Subscribe — payload",
+  "description": "Open an administrator console's live channel of hint-only events. The success response is the first document on a stream that then carries vtc/admin/events/event/0.5 documents; over HTTPS that stream is the streamed response of bindings/https/0.3 §2.1. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "topics"
+  ],
+  "properties": {
+    "topics": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 10,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/Topic"
+      },
+      "description": "The topics the console renders. The community narrows this to the topics the caller may read and reports the result as the response's `topics`."
+    },
+    "resumeToken": {
+      "$ref": "#/$defs/ResumeToken",
+      "description": "The last `resumeToken` the console received on an earlier stream, to resume from (named `since` before 0.5). A token the community does not recognise, has expired, or minted for another caller is not an error: the stream starts fresh and the response says `resumed: false`."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Admin Events — Subscribe — response payload",
+      "description": "The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "topics",
+        "heartbeatSeconds",
+        "resumed",
+        "resumeToken"
+      ],
+      "properties": {
+        "topics": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 10,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Topic"
+          },
+          "description": "The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live."
+        },
+        "heartbeatSeconds": {
+          "type": "integer",
+          "minimum": 5,
+          "maximum": 60,
+          "description": "The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead."
+        },
+        "resumed": {
+          "type": "boolean",
+          "description": "`true` when the community recognised the request's `resumeToken` and will send a hint for every effective topic that changed after it. `false` when no `resumeToken` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes."
+        },
+        "resumeToken": {
+          "$ref": "#/$defs/ResumeToken",
+          "description": "The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from."
+        },
+        "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-]+)+$"
+      }
+    },
+    "ResumeToken": {
+      "title": "ResumeToken",
+      "description": "Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "^[A-Za-z0-9._~-]+$"
+    },
+    "Topic": {
+      "title": "Topic",
+      "description": "One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.",
+      "type": "string",
+      "enum": [
+        "actions",
+        "acknowledgements",
+        "joinRequests",
+        "members",
+        "singleAdminMode",
+        "config",
+        "rooms",
+        "directory",
+        "groups",
+        "communityRooms"
+      ]
+    }
+  }
+} 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 Admin Events — Subscribe — response payload",
+      "description": "The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "topics",
+        "heartbeatSeconds",
+        "resumed",
+        "resumeToken"
+      ],
+      "properties": {
+        "topics": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 10,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Topic"
+          },
+          "description": "The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live."
+        },
+        "heartbeatSeconds": {
+          "type": "integer",
+          "minimum": 5,
+          "maximum": 60,
+          "description": "The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead."
+        },
+        "resumed": {
+          "type": "boolean",
+          "description": "`true` when the community recognised the request's `resumeToken` and will send a hint for every effective topic that changed after it. `false` when no `resumeToken` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes."
+        },
+        "resumeToken": {
+          "$ref": "#/$defs/ResumeToken",
+          "description": "The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from."
+        },
+        "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-]+)+$"
+      }
+    },
+    "ResumeToken": {
+      "title": "ResumeToken",
+      "description": "Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "^[A-Za-z0-9._~-]+$"
+    },
+    "Topic": {
+      "title": "Topic",
+      "description": "One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.",
+      "type": "string",
+      "enum": [
+        "actions",
+        "acknowledgements",
+        "joinRequests",
+        "members",
+        "singleAdminMode",
+        "config",
+        "rooms",
+        "directory",
+        "groups",
+        "communityRooms"
+      ]
+    }
+  }
+} 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/vtc/elections/create/0.1/payload.ts

@@ -3,7 +3,7 @@
  * Source: specs/vtc/elections/create/0.1/payload.schema.json
  */
 
-import type { ActionId, BoardVisibility, ChoiceQuestion, DigestMultibase, ElectionId, Ext, Key_VotingV0_1 as Key, Manifest, Question, QuestionOption, RankingQuestion, Revote, RollRule, ScoreQuestion, SecrecyLevel, TextQuestion, Trustees } from "../../../../_shared/components.js";
+import type { ActionId, BoardVisibility, ChoiceQuestion, DigestMultibase, ElectionId, Ext, Key_VotingV0_1 as Key, Manifest_VotingV0_1 as Manifest, Question, QuestionOption, RankingQuestion, Revote, RollRule, ScoreQuestion, SecrecyLevel, TextQuestion, Trustees } from "../../../../_shared/components.js";
 
 
 /**