@openvtc/trust-tasks 0.26.1 → 0.26.2

package/src/rooms/owner/group/remove/0.1/payload.ts

@@ -0,0 +1,242 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/rooms/owner/group/remove/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+export interface RoomsOwnerGroupRemovePayload {
+  /**
+   * The room whose group loses a member. The recipient MUST hold its group.
+   */
+  roomId: string;
+  /**
+   * The room's host, as a DID: where the room's epoch advances.
+   */
+  host: string;
+  /**
+   * The DID whose leaf is removed. Never the recipient's own leaf.
+   */
+  member: string;
+  /**
+   * Why, carried to the host's epoch advance. Untrusted and attributed to its author: it MUST NOT carry personal data or a credential.
+   */
+  reason?: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * Success response to rooms/owner/group/remove. Type https://trusttasks.org/spec/rooms/owner/group/remove/0.1#response. The room's new epoch, which the removed member holds no key for.
+ */
+export interface RoomsOwnerGroupRemoveResponsePayload {
+  /**
+   * The room.
+   */
+  roomId: string;
+  /**
+   * Who was removed.
+   */
+  member: string;
+  /**
+   * The room epoch after the removal, as the host recorded it.
+   */
+  epoch: number;
+  ext?: Ext;
+}
+
+/** 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/rooms/owner/group/remove/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = RoomsOwnerGroupRemovePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/owner/group/remove/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RoomsOwnerGroupRemoveResponsePayload;
+
+/**
+ * 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/rooms/owner/group/remove/0.1",
+  "title": "Rooms Owner Group Remove — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "roomId",
+    "host",
+    "member"
+  ],
+  "properties": {
+    "roomId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "The room whose group loses a member. The recipient MUST hold its group."
+    },
+    "host": {
+      "type": "string",
+      "pattern": "^did:",
+      "maxLength": 2048,
+      "description": "The room's host, as a DID: where the room's epoch advances."
+    },
+    "member": {
+      "type": "string",
+      "pattern": "^did:",
+      "maxLength": 2048,
+      "description": "The DID whose leaf is removed. Never the recipient's own leaf."
+    },
+    "reason": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "Why, carried to the host's epoch advance. Untrusted and attributed to its author: it MUST NOT carry personal data or a credential."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Rooms Owner Group Remove — response payload",
+      "description": "Success response to rooms/owner/group/remove. Type https://trusttasks.org/spec/rooms/owner/group/remove/0.1#response. The room's new epoch, which the removed member holds no key for.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "roomId",
+        "member",
+        "epoch"
+      ],
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "The room."
+        },
+        "member": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "Who was removed."
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 2,
+          "description": "The room epoch after the removal, as the host recorded it."
+        },
+        "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": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Rooms Owner Group Remove — response payload",
+      "description": "Success response to rooms/owner/group/remove. Type https://trusttasks.org/spec/rooms/owner/group/remove/0.1#response. The room's new epoch, which the removed member holds no key for.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "roomId",
+        "member",
+        "epoch"
+      ],
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "The room."
+        },
+        "member": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "Who was removed."
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 2,
+          "description": "The room epoch after the removal, as the host recorded it."
+        },
+        "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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/rooms/owner/register/0.1/payload.ts

@@ -20,7 +20,7 @@ export interface RoomsOwnerRegisterPayload {
    */
   visibility: Visibility;
   /**
-   * The accountable party. Absent means the caller — a registration is normally made by the owner it names, and defaulting saves a surface repeating the DID it just authenticated as. Present and different is legitimate: an operator registering on behalf of the party who will answer for the room.
+   * The accountable party, and the issuer of the rooms/create document the recipient sends on its behalf: the recipient signs it with a key of this DID that it holds, never as itself. Absent means the caller — a registration is normally made by the owner it names. A recipient holding no key for it refuses with permissionDenied before contacting the host.
    */
   ownerDid?: string;
   /**
@@ -102,7 +102,7 @@ export const PAYLOAD_SCHEMA = {
     },
     "ownerDid": {
       "type": "string",
-      "description": "The accountable party. Absent means the caller — a registration is normally made by the owner it names, and defaulting saves a surface repeating the DID it just authenticated as. Present and different is legitimate: an operator registering on behalf of the party who will answer for the room."
+      "description": "The accountable party, and the issuer of the rooms/create document the recipient sends on its behalf: the recipient signs it with a key of this DID that it holds, never as itself. Absent means the caller — a registration is normally made by the owner it names. A recipient holding no key for it refuses with permissionDenied before contacting the host."
     },
     "retentionPolicy": {
       "$ref": "#/$defs/RetentionPolicy",

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

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/_shared/0.1/community-room.schema.json
+ */
+
+/**
+ * Shared types for rooms a community owns rather than merely hosts: the vtc/rooms/community/* tasks an administrator runs them with, and the vtc/rooms/offers/* tasks a member collects and accepts an admission with. The community is the room's owner; the community's own VTA holds the room's signing key and, on a sealed tier, the community's place in its MLS group. The community holds no room key and no group secret. What it records here is the owner's own record of whom it admitted — never read when the community serves the room as its host, where authorization is the room's credential chain and nothing else. Not itself a Trust Task specification (the `_shared` folder is skipped by the registry build and the codegen).
+ */
+export interface VTCSharedCommunityOwnedRoomDefinitions {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { CommunityRoom, MemberAction, MemberActions, MemberState, Offer, OfferCredentials, Reason, RoomLabel, RoomMember } from "../../../_shared/components.js";

package/src/vtc/admin/events/_shared/0.1/topic.ts

@@ -25,4 +25,4 @@ export interface VTCAdminEventsSharedDefinitions {
  * The definitions this shared schema publishes, hoisted to one declaration each.
  * See "../../../../../_shared/components.js".
  */
-export type { ResumeToken, Topic } from "../../../../../_shared/components.js";
+export type { ResumeToken, Topic_VtcAdminEventsV0_1 as Topic } from "../../../../../_shared/components.js";

package/src/vtc/admin/events/_shared/0.2/topic.ts

@@ -0,0 +1,29 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/admin/events/_shared/0.2/topic.schema.json
+ */
+
+/**
+ * Shared shapes for a Verifiable Trust Community's live administrative console events: a hint-only channel that tells an administrator's console WHEN to re-read, never WHAT changed.
+ *
+ * THE MODEL. A console subscribes once per session with `vtc/admin/events/subscribe`, naming the topics it renders. The community answers with a stream of `vtc/admin/events/event` documents, each naming one topic and, for a count topic, the caller's current count. An event carries no record and no personal data. The console reacts by re-fetching the topic's own signed read, so the read stays the only place authorization is decided and the only place data leaves the community: the stream can neither leak a record nor grant a read. Polling those reads remains the fallback whenever the stream is down.
+ *
+ * TOPICS AND THEIR READS. Each topic names one read. A community sends a topic's events only to a caller it would answer on that read.
+ *
+ * - `actions` — the caller's visible administrative actions (`vtc/admin/actions/list`). Count topic: the caller's `waitingForMe` count.
+ * - `acknowledgements` — the acknowledge-category actions awaiting the caller (`vtc/admin/actions/list`). Count topic: the open acknowledge actions the caller has not yet acknowledged.
+ * - `joinRequests` — the community's join requests (`vtc/join-requests/list`). Count topic: the join requests awaiting a decision.
+ * - `members` — the community's members (`vtc/members/list`). No count.
+ * - `singleAdminMode` — whether single-administrator mode is in effect. Every administrator may read it. No count.
+ * - `config` — the community's stored configuration (`vtc/config/export`). No count.
+ * - `rooms` — the rooms this community hosts and where their files are kept (`vtc/rooms/list`, `vtc/rooms/usage`, `vtc/storage/configs/list`), for holders of `vtc.rooms.admin`. No count. Added in 0.2.
+ */
+export interface VTCAdminEventsSharedDefinitions {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../../../_shared/components.js".
+ */
+export type { ResumeToken, Topic_VtcAdminEventsV0_2 as Topic } from "../../../../../_shared/components.js";

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

@@ -3,7 +3,7 @@
  * Source: specs/vtc/admin/events/event/0.1/payload.schema.json
  */
 
-import type { Ext, ResumeToken, Topic } from "../../../../../_shared/components.js";
+import type { Ext, ResumeToken, Topic_VtcAdminEventsV0_1 as Topic } from "../../../../../_shared/components.js";
 
 
 /**

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

@@ -0,0 +1,134 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/admin/events/event/0.2/payload.schema.json
+ */
+
+import type { Ext, ResumeToken, Topic_VtcAdminEventsV0_2 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.
+   */
+  at: string;
+  /**
+   * Only on a count topic (`actions`, `acknowledgements`, `joinRequests`): the caller's current count for that topic as of `at` — 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.2" 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.2",
+  "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",
+    "at",
+    "resumeToken"
+  ],
+  "properties": {
+    "topic": {
+      "$ref": "#/$defs/Topic",
+      "description": "What changed. Always one of the effective topics the subscribe response named."
+    },
+    "at": {
+      "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 `at` — 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"
+      ]
+    }
+  }
+} 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.1/payload.ts

@@ -3,7 +3,7 @@
  * Source: specs/vtc/admin/events/subscribe/0.1/payload.schema.json
  */
 
-import type { Ext, ResumeToken, Topic } from "../../../../../_shared/components.js";
+import type { Ext, ResumeToken, Topic_VtcAdminEventsV0_1 as Topic } from "../../../../../_shared/components.js";
 
 
 /**