@openvtc/trust-tasks 0.26.1 → 0.26.3

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

@@ -0,0 +1,451 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/rooms/offers/list/0.1/payload.schema.json
+ */
+
+import type { Ext, MemberAction, MemberActions, Offer, OfferCredentials, RoomLabel, Visibility } from "../../../../../_shared/components.js";
+
+
+export interface VTCRoomsOffersListPayload {
+  /**
+   * 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;
+}
+/**
+ * Success response to vtc/rooms/offers/list. Type https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response. The offers addressed to the caller, and no one else's.
+ */
+export interface VTCRoomsOffersListResponsePayload {
+  /**
+   * @maxItems 100
+   */
+  items: Offer[];
+  /**
+   * Present when more remain; pass it as `cursor`.
+   */
+  nextCursor?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, MemberAction, MemberActions, Offer, OfferCredentials, RoomLabel, Visibility };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/rooms/offers/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRoomsOffersListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRoomsOffersListResponsePayload;
+
+/**
+ * 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/offers/list/0.1",
+  "title": "VTC Rooms Offers List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "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": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Rooms Offers List — response payload",
+      "description": "Success response to vtc/rooms/offers/list. Type https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response. The offers addressed to the caller, and no one else's.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items"
+      ],
+      "properties": {
+        "items": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/$defs/Offer"
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "Offer": {
+      "title": "Offer",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "roomId",
+        "host",
+        "label",
+        "visibility",
+        "actions",
+        "validUntil",
+        "offeredAt",
+        "state",
+        "credentials"
+      ],
+      "description": "A community's offer of admission to a room it owns, as the member it is addressed to sees it.",
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
+        },
+        "host": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The room's host: this community."
+        },
+        "label": {
+          "$ref": "#/$defs/RoomLabel"
+        },
+        "visibility": {
+          "$ref": "#/$defs/Visibility"
+        },
+        "actions": {
+          "$ref": "#/$defs/MemberActions"
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "offeredAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "open",
+            "accepted"
+          ],
+          "description": "`open`: not yet accepted. `accepted`: accepted, kept listed while a repeated accept can still be answered."
+        },
+        "credentials": {
+          "$ref": "#/$defs/OfferCredentials"
+        }
+      }
+    },
+    "OfferCredentials": {
+      "title": "OfferCredentials",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "invitation",
+        "membership",
+        "authority"
+      ],
+      "description": "The three credentials the room issued to the member, serialized as rooms/owner/{invite,issue-membership,issue-authority} return them. None is a secret: each names its subject, and a presentation of it must be signed by that subject. The member stores them in their own key holder's vault.",
+      "properties": {
+        "invitation": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 65536,
+          "description": "The Verifiable Invitation Credential. On a sealed tier the member's key holder needs it to mint a KeyPackage (rooms/keys/key-package) and to accept the Welcome (rooms/keys/welcome)."
+        },
+        "membership": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 65536,
+          "description": "The Verifiable Membership Credential."
+        },
+        "authority": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 65536,
+          "description": "The Verifiable Authority Credential granting `actions` until `validUntil`."
+        }
+      }
+    },
+    "MemberActions": {
+      "title": "MemberActions",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 3,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/MemberAction"
+      },
+      "description": "The actions granted, at least one. An empty list confers nothing rather than everything, and a schema that allowed it would make the more dangerous reading available to a careless consumer."
+    },
+    "MemberAction": {
+      "title": "MemberAction",
+      "type": "string",
+      "enum": [
+        "read",
+        "write",
+        "curate"
+      ],
+      "description": "What a member of a community-owned room may do there. `admin` is not among them: minting epochs, admitting and removing members are the community's, as the room's owner, and are exercised through the vtc/rooms/community/* tasks rather than by any member's credential. `curate` is not implied by `write`."
+    },
+    "RoomLabel": {
+      "title": "RoomLabel",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "A name for the room, chosen by an administrator: shown to administrators and to the members a room is offered to. Not part of the room's identity and not sent to the room's host path. MUST NOT carry personal data."
+    },
+    "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": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Rooms Offers List — response payload",
+      "description": "Success response to vtc/rooms/offers/list. Type https://trusttasks.org/spec/vtc/rooms/offers/list/0.1#response. The offers addressed to the caller, and no one else's.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "items"
+      ],
+      "properties": {
+        "items": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/$defs/Offer"
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "Offer": {
+      "title": "Offer",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "roomId",
+        "host",
+        "label",
+        "visibility",
+        "actions",
+        "validUntil",
+        "offeredAt",
+        "state",
+        "credentials"
+      ],
+      "description": "A community's offer of admission to a room it owns, as the member it is addressed to sees it.",
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
+        },
+        "host": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The room's host: this community."
+        },
+        "label": {
+          "$ref": "#/$defs/RoomLabel"
+        },
+        "visibility": {
+          "$ref": "#/$defs/Visibility"
+        },
+        "actions": {
+          "$ref": "#/$defs/MemberActions"
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "offeredAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "open",
+            "accepted"
+          ],
+          "description": "`open`: not yet accepted. `accepted`: accepted, kept listed while a repeated accept can still be answered."
+        },
+        "credentials": {
+          "$ref": "#/$defs/OfferCredentials"
+        }
+      }
+    },
+    "OfferCredentials": {
+      "title": "OfferCredentials",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "invitation",
+        "membership",
+        "authority"
+      ],
+      "description": "The three credentials the room issued to the member, serialized as rooms/owner/{invite,issue-membership,issue-authority} return them. None is a secret: each names its subject, and a presentation of it must be signed by that subject. The member stores them in their own key holder's vault.",
+      "properties": {
+        "invitation": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 65536,
+          "description": "The Verifiable Invitation Credential. On a sealed tier the member's key holder needs it to mint a KeyPackage (rooms/keys/key-package) and to accept the Welcome (rooms/keys/welcome)."
+        },
+        "membership": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 65536,
+          "description": "The Verifiable Membership Credential."
+        },
+        "authority": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 65536,
+          "description": "The Verifiable Authority Credential granting `actions` until `validUntil`."
+        }
+      }
+    },
+    "MemberActions": {
+      "title": "MemberActions",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 3,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/MemberAction"
+      },
+      "description": "The actions granted, at least one. An empty list confers nothing rather than everything, and a schema that allowed it would make the more dangerous reading available to a careless consumer."
+    },
+    "MemberAction": {
+      "title": "MemberAction",
+      "type": "string",
+      "enum": [
+        "read",
+        "write",
+        "curate"
+      ],
+      "description": "What a member of a community-owned room may do there. `admin` is not among them: minting epochs, admitting and removing members are the community's, as the room's owner, and are exercised through the vtc/rooms/community/* tasks rather than by any member's credential. `curate` is not implied by `write`."
+    },
+    "RoomLabel": {
+      "title": "RoomLabel",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "A name for the room, chosen by an administrator: shown to administrators and to the members a room is offered to. Not part of the room's identity and not sent to the room's host path. MUST NOT carry personal data."
+    },
+    "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: 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;