@openvtc/trust-tasks 0.21.11 → 0.21.13

package/src/vtc/rooms/list/0.1/payload.ts

@@ -0,0 +1,449 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/rooms/list/0.1/payload.schema.json
+ */
+
+import type { Ext, RetentionPolicy, Visibility } from "../../../../_shared/components.js";
+
+
+/**
+ * Where a room sits on the hosting lifecycle clock, computed at the time of the read from its epoch expiry and retention: `live`, `lapsed`, `dormant` or `reclaimable`. Computed, never stored — minting an epoch is the renewal.
+ */
+export type RoomLifecycle = "live" | "lapsed" | "dormant" | "reclaimable";
+
+/**
+ * A community administrator pages through the data rooms this community hosts, as their host can honestly describe them. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCRoomsListPayload {
+  lifecycle?: RoomLifecycle;
+  /**
+   * Opaque continuation token from a previous page's `nextCursor`.
+   */
+  cursor?: string;
+  /**
+   * Page size. The community chooses when absent (50 in the reference implementation).
+   */
+  limit?: number;
+  ext?: Ext;
+}
+export interface VTCRoomsListResponsePayload {
+  /**
+   * @maxItems 100
+   */
+  items: HostedRoom[];
+  /**
+   * Present when more remain; pass it as `cursor`.
+   */
+  nextCursor?: string;
+  ext?: Ext;
+}
+/**
+ * One room, as its host holds it: who is accountable for it, its tier, its epoch and its place on the lifecycle clock. Nothing derived from the room's contents, and no member list — the host has none.
+ */
+export interface HostedRoom {
+  /**
+   * The room's identifier, as its owner minted it.
+   */
+  roomId: string;
+  /**
+   * The accountable party — visible at every tier, including `private`, because it is who the host must reach about quota, abuse and reclamation.
+   */
+  ownerDid: string;
+  visibility: Visibility;
+  retentionPolicy: RetentionPolicy;
+  /**
+   * The room's current epoch.
+   */
+  epoch: number;
+  lifecycle: RoomLifecycle;
+  /**
+   * When the current epoch expires, in seconds since the Unix epoch. Absent means the room never lapses.
+   */
+  epochExpiresAt?: number;
+  /**
+   * How long the host keeps the room after it lapses, in days.
+   */
+  retentionDays: number;
+  /**
+   * Present when this host serves a read-only copy, naming the primary it pulls from.
+   */
+  mirrorOf?: string;
+  /**
+   * When the room was created here, in seconds since the Unix epoch — the encoding the rooms family uses.
+   */
+  createdAt: number;
+  /**
+   * When the room's host record last changed, in seconds since the Unix epoch.
+   */
+  updatedAt: number;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, RetentionPolicy, Visibility };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/rooms/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRoomsListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/rooms/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRoomsListResponsePayload;
+
+/**
+ * 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/rooms/list/0.1",
+  "title": "VTC Rooms — List — payload",
+  "description": "A community administrator pages through the data rooms this community hosts, as their host can honestly describe them. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "lifecycle": {
+      "$ref": "#/$defs/RoomLifecycle"
+    },
+    "cursor": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "description": "Opaque continuation token from a previous page's `nextCursor`."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 100,
+      "description": "Page size. The community chooses when absent (50 in the reference implementation)."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "RoomLifecycle": {
+      "title": "RoomLifecycle",
+      "type": "string",
+      "enum": [
+        "live",
+        "lapsed",
+        "dormant",
+        "reclaimable"
+      ],
+      "description": "Where a room sits on the hosting lifecycle clock, computed at the time of the read from its epoch expiry and retention: `live`, `lapsed`, `dormant` or `reclaimable`. Computed, never stored — minting an epoch is the renewal."
+    },
+    "HostedRoom": {
+      "title": "HostedRoom",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "roomId",
+        "ownerDid",
+        "visibility",
+        "retentionPolicy",
+        "epoch",
+        "lifecycle",
+        "retentionDays",
+        "createdAt",
+        "updatedAt"
+      ],
+      "description": "One room, as its host holds it: who is accountable for it, its tier, its epoch and its place on the lifecycle clock. Nothing derived from the room's contents, and no member list — the host has none.",
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "The room's identifier, as its owner minted it."
+        },
+        "ownerDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The accountable party — visible at every tier, including `private`, because it is who the host must reach about quota, abuse and reclamation."
+        },
+        "visibility": {
+          "$ref": "#/$defs/Visibility"
+        },
+        "retentionPolicy": {
+          "$ref": "#/$defs/RetentionPolicy"
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The room's current epoch."
+        },
+        "lifecycle": {
+          "$ref": "#/$defs/RoomLifecycle"
+        },
+        "epochExpiresAt": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "When the current epoch expires, in seconds since the Unix epoch. Absent means the room never lapses."
+        },
+        "retentionDays": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How long the host keeps the room after it lapses, in days."
+        },
+        "mirrorOf": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "Present when this host serves a read-only copy, naming the primary it pulls from."
+        },
+        "createdAt": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "When the room was created here, in seconds since the Unix epoch — the encoding the rooms family uses."
+        },
+        "updatedAt": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "When the room's host record last changed, in seconds since the Unix epoch."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Rooms — List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items"
+      ],
+      "properties": {
+        "items": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/$defs/HostedRoom"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024,
+          "description": "Present when more remain; pass it as `cursor`."
+        },
+        "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-]+)+$"
+      }
+    },
+    "RetentionPolicy": {
+      "title": "RetentionPolicy",
+      "type": "string",
+      "enum": [
+        "chained",
+        "fromJoin"
+      ],
+      "description": "Whether a room keeps its history readable across a membership change, fixed at creation and immutable thereafter — like `Visibility`, and for the same reason: the rungs of an epoch key chain either exist for an epoch or they do not, and no later change of mind can seal key material that was never sealed or unseal what was already severed. `chained`: each advance produces an `EpochLink`, so every member reads the room's whole retained history however long they have been in it — what a **library** wants, at the cost of post-compromise security for record content, since a compromised current key then reaches every retained epoch. `fromJoin`: no rungs are produced, so a member reads only from the epoch their group state is at — what a **stream** wants, and what a room under a strict forward-secrecy obligation wants, at the cost that a joining member finds an empty-looking room and nobody can reread a record once their group state has moved past the epoch it was sealed under. Absent means `chained`; see the prose on why the absent case is the readable one.",
+      "$comment": "Deliberately no JSON Schema `default`. A declared default is materialised by the generated bindings — the member becomes non-optional with a serde default — so an absent value would reappear as an explicit one on re-serialisation and break round-trip idempotence for every document written before this member existed. The meaning of absence is stated in prose, where a binding cannot act on it."
+    },
+    "Visibility": {
+      "title": "Visibility",
+      "type": "string",
+      "enum": [
+        "open",
+        "attributed",
+        "private"
+      ],
+      "description": "How much of a room its host can see, fixed at creation and immutable thereafter. `open`: records are cleartext, searchable and fully audited. `attributed`: record content is sealed, and the host still learns which member acted. `private`: content is sealed and membership is presented in zero knowledge, so the host verifies that a member acted without learning which. Immutable because a downgrade cannot un-see cleartext and an upgrade would protect only what came after while presenting as though it protected everything."
+    }
+  }
+} 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": {
+    "RoomLifecycle": {
+      "title": "RoomLifecycle",
+      "type": "string",
+      "enum": [
+        "live",
+        "lapsed",
+        "dormant",
+        "reclaimable"
+      ],
+      "description": "Where a room sits on the hosting lifecycle clock, computed at the time of the read from its epoch expiry and retention: `live`, `lapsed`, `dormant` or `reclaimable`. Computed, never stored — minting an epoch is the renewal."
+    },
+    "HostedRoom": {
+      "title": "HostedRoom",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "roomId",
+        "ownerDid",
+        "visibility",
+        "retentionPolicy",
+        "epoch",
+        "lifecycle",
+        "retentionDays",
+        "createdAt",
+        "updatedAt"
+      ],
+      "description": "One room, as its host holds it: who is accountable for it, its tier, its epoch and its place on the lifecycle clock. Nothing derived from the room's contents, and no member list — the host has none.",
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "The room's identifier, as its owner minted it."
+        },
+        "ownerDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The accountable party — visible at every tier, including `private`, because it is who the host must reach about quota, abuse and reclamation."
+        },
+        "visibility": {
+          "$ref": "#/$defs/Visibility"
+        },
+        "retentionPolicy": {
+          "$ref": "#/$defs/RetentionPolicy"
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The room's current epoch."
+        },
+        "lifecycle": {
+          "$ref": "#/$defs/RoomLifecycle"
+        },
+        "epochExpiresAt": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "When the current epoch expires, in seconds since the Unix epoch. Absent means the room never lapses."
+        },
+        "retentionDays": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How long the host keeps the room after it lapses, in days."
+        },
+        "mirrorOf": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "Present when this host serves a read-only copy, naming the primary it pulls from."
+        },
+        "createdAt": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "When the room was created here, in seconds since the Unix epoch — the encoding the rooms family uses."
+        },
+        "updatedAt": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "When the room's host record last changed, in seconds since the Unix epoch."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Rooms — List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items"
+      ],
+      "properties": {
+        "items": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/$defs/HostedRoom"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024,
+          "description": "Present when more remain; pass it as `cursor`."
+        },
+        "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-]+)+$"
+      }
+    },
+    "RetentionPolicy": {
+      "title": "RetentionPolicy",
+      "type": "string",
+      "enum": [
+        "chained",
+        "fromJoin"
+      ],
+      "description": "Whether a room keeps its history readable across a membership change, fixed at creation and immutable thereafter — like `Visibility`, and for the same reason: the rungs of an epoch key chain either exist for an epoch or they do not, and no later change of mind can seal key material that was never sealed or unseal what was already severed. `chained`: each advance produces an `EpochLink`, so every member reads the room's whole retained history however long they have been in it — what a **library** wants, at the cost of post-compromise security for record content, since a compromised current key then reaches every retained epoch. `fromJoin`: no rungs are produced, so a member reads only from the epoch their group state is at — what a **stream** wants, and what a room under a strict forward-secrecy obligation wants, at the cost that a joining member finds an empty-looking room and nobody can reread a record once their group state has moved past the epoch it was sealed under. Absent means `chained`; see the prose on why the absent case is the readable one.",
+      "$comment": "Deliberately no JSON Schema `default`. A declared default is materialised by the generated bindings — the member becomes non-optional with a serde default — so an absent value would reappear as an explicit one on re-serialisation and break round-trip idempotence for every document written before this member existed. The meaning of absence is stated in prose, where a binding cannot act on it."
+    },
+    "Visibility": {
+      "title": "Visibility",
+      "type": "string",
+      "enum": [
+        "open",
+        "attributed",
+        "private"
+      ],
+      "description": "How much of a room its host can see, fixed at creation and immutable thereafter. `open`: records are cleartext, searchable and fully audited. `attributed`: record content is sealed, and the host still learns which member acted. `private`: content is sealed and membership is presented in zero knowledge, so the host verifies that a member acted without learning which. Immutable because a downgrade cannot un-see cleartext and an upgrade would protect only what came after while presenting as though it protected everything."
+    }
+  }
+} 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/schemas/accepts/delete/0.1/payload.ts

@@ -0,0 +1,170 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/schemas/accepts/delete/0.1/payload.schema.json
+ */
+
+import type { AcceptsCriterionId, Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * Remove one Accepts criterion. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCSchemasAcceptsDeletePayload {
+  id: AcceptsCriterionId;
+  ext?: Ext;
+}
+export interface VTCSchemasAcceptsDeleteResponsePayload {
+  id: AcceptsCriterionId;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AcceptsCriterionId, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/schemas/accepts/delete/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCSchemasAcceptsDeletePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/schemas/accepts/delete/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCSchemasAcceptsDeleteResponsePayload;
+
+/**
+ * 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/schemas/accepts/delete/0.1",
+  "title": "VTC Schemas — Accepts — Delete — payload",
+  "description": "Remove one Accepts criterion. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "$ref": "#/$defs/AcceptsCriterionId"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Schemas — Accepts — Delete — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/AcceptsCriterionId"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AcceptsCriterionId": {
+      "title": "AcceptsCriterionId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "An Accepts criterion's identifier, chosen by the registering administrator — a ceremony purpose or a named manifest criterion, e.g. `membership`. Compared as an exact string after surrounding whitespace is trimmed. Bounded at 128 characters, the bound vtc/join-requests/manifest/0.2 places on the criterion `id` it publishes."
+    }
+  }
+} 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 Schemas — Accepts — Delete — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/AcceptsCriterionId"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AcceptsCriterionId": {
+      "title": "AcceptsCriterionId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "An Accepts criterion's identifier, chosen by the registering administrator — a ceremony purpose or a named manifest criterion, e.g. `membership`. Compared as an exact string after surrounding whitespace is trimmed. Bounded at 128 characters, the bound vtc/join-requests/manifest/0.2 places on the criterion `id` it publishes."
+    }
+  }
+} 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;