@openvtc/trust-tasks 0.28.15 → 0.28.17

package/src/vtc/boards/facilitators/list/0.1/payload.ts

@@ -0,0 +1,306 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/boards/facilitators/list/0.1/payload.schema.json
+ */
+
+import type { BoardId, EntryId, Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * A facilitator of a board reads who is appointed to facilitate it (VTI-BRD-093). The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCBoardsFacilitatorsListPayload {
+  boardId: BoardId;
+  ext?: Ext;
+}
+/**
+ * The success response to a vtc/boards/facilitators/list/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/facilitators/list/0.1#response. The board's appointed facilitators.
+ */
+export interface VTCBoardsFacilitatorsListResponsePayload {
+  boardId: BoardId;
+  /**
+   * The board's appointments, by entry, oldest first. Holders of `vtc.boards.manage` unqualified or through a role are not listed: they facilitate every board.
+   *
+   * @maxItems 256
+   */
+  facilitators: Appointment[];
+  ext?: Ext;
+}
+/**
+ * One member's appointment to facilitate the board: a resource grant of `vtc.boards.manage` qualified to it.
+ */
+export interface Appointment {
+  /**
+   * The appointed facilitator.
+   */
+  entryId: EntryId;
+  /**
+   * When the grant was written, or last re-affirmed under a new granter.
+   */
+  appointedAt: string;
+  /**
+   * The granter, by entry. Absent when the granter holds no directory entry — an administrator who is not a member, or one who has departed.
+   */
+  appointedBy?: EntryId;
+  /**
+   * Present while the appointment is under review because its granter departed or no longer facilitates the board: it is withdrawn at this time unless an administrator who facilitates the board re-affirms it (VTI-BRD-092).
+   */
+  reviewEndsAt?: string;
+}
+
+/** 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/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 = VTCBoardsFacilitatorsListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/boards/facilitators/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCBoardsFacilitatorsListResponsePayload;
+
+/**
+ * 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/list/0.1",
+  "title": "VTC Boards — Facilitators — List — payload",
+  "description": "A facilitator of a board reads who is appointed to facilitate it (VTI-BRD-093). The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "boardId"
+  ],
+  "properties": {
+    "boardId": {
+      "$ref": "#/$defs/BoardId"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Boards — Facilitators — List — response payload",
+      "description": "The success response to a vtc/boards/facilitators/list/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/facilitators/list/0.1#response. The board's appointed facilitators.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "boardId",
+        "facilitators"
+      ],
+      "properties": {
+        "boardId": {
+          "$ref": "#/$defs/BoardId"
+        },
+        "facilitators": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "$ref": "#/$defs/Appointment"
+          },
+          "description": "The board's appointments, by entry, oldest first. Holders of `vtc.boards.manage` unqualified or through a role are not listed: they facilitate every board."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Appointment": {
+      "title": "Appointment",
+      "description": "One member's appointment to facilitate the board: a resource grant of `vtc.boards.manage` qualified to it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entryId",
+        "appointedAt"
+      ],
+      "properties": {
+        "entryId": {
+          "$ref": "#/$defs/EntryId",
+          "description": "The appointed facilitator."
+        },
+        "appointedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the grant was written, or last re-affirmed under a new granter."
+        },
+        "appointedBy": {
+          "$ref": "#/$defs/EntryId",
+          "description": "The granter, by entry. Absent when the granter holds no directory entry — an administrator who is not a member, or one who has departed."
+        },
+        "reviewEndsAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present while the appointment is under review because its granter departed or no longer facilitates the board: it is withdrawn at this time unless an administrator who facilitates the board re-affirms it (VTI-BRD-092)."
+        }
+      }
+    },
+    "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}$"
+    },
+    "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 — Facilitators — List — response payload",
+      "description": "The success response to a vtc/boards/facilitators/list/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/facilitators/list/0.1#response. The board's appointed facilitators.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "boardId",
+        "facilitators"
+      ],
+      "properties": {
+        "boardId": {
+          "$ref": "#/$defs/BoardId"
+        },
+        "facilitators": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "$ref": "#/$defs/Appointment"
+          },
+          "description": "The board's appointments, by entry, oldest first. Holders of `vtc.boards.manage` unqualified or through a role are not listed: they facilitate every board."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Appointment": {
+      "title": "Appointment",
+      "description": "One member's appointment to facilitate the board: a resource grant of `vtc.boards.manage` qualified to it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entryId",
+        "appointedAt"
+      ],
+      "properties": {
+        "entryId": {
+          "$ref": "#/$defs/EntryId",
+          "description": "The appointed facilitator."
+        },
+        "appointedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the grant was written, or last re-affirmed under a new granter."
+        },
+        "appointedBy": {
+          "$ref": "#/$defs/EntryId",
+          "description": "The granter, by entry. Absent when the granter holds no directory entry — an administrator who is not a member, or one who has departed."
+        },
+        "reviewEndsAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present while the appointment is under review because its granter departed or no longer facilitates the board: it is withdrawn at this time unless an administrator who facilitates the board re-affirms it (VTI-BRD-092)."
+        }
+      }
+    },
+    "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}$"
+    },
+    "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: false,
+  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/remove/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/remove/0.1/payload.schema.json
+ */
+
+import type { BoardId, EntryId, Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * A facilitator steps down, or a holder of `vtc.boards.manage` unqualified ends another member's appointment as a board's facilitator (VTI-BRD-091). The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCBoardsFacilitatorsRemovePayload {
+  boardId: BoardId;
+  /**
+   * The facilitator whose appointment ends.
+   */
+  entryId: EntryId;
+  /**
+   * Why, recorded with the change. Plain text.
+   */
+  reason?: string;
+  ext?: Ext;
+}
+/**
+ * The success response to a vtc/boards/facilitators/remove/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/facilitators/remove/0.1#response. The board's appointed facilitators after the removal.
+ */
+export interface VTCBoardsFacilitatorsRemoveResponsePayload {
+  boardId: BoardId;
+  /**
+   * The board's appointed facilitators after the removal, 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/remove/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 = VTCBoardsFacilitatorsRemovePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/boards/facilitators/remove/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCBoardsFacilitatorsRemoveResponsePayload;
+
+/**
+ * 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/remove/0.1",
+  "title": "VTC Boards — Facilitators — Remove — payload",
+  "description": "A facilitator steps down, or a holder of `vtc.boards.manage` unqualified ends another member's appointment as a board's facilitator (VTI-BRD-091). 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 facilitator whose appointment ends."
+    },
+    "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 — Remove — response payload",
+      "description": "The success response to a vtc/boards/facilitators/remove/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/facilitators/remove/0.1#response. The board's appointed facilitators after the removal.",
+      "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 removal, 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 — Remove — response payload",
+      "description": "The success response to a vtc/boards/facilitators/remove/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/boards/facilitators/remove/0.1#response. The board's appointed facilitators after the removal.",
+      "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 removal, 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;