@openvtc/trust-tasks 0.23.8 → 0.24.0

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

@@ -0,0 +1,1275 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/rooms/get/0.1/payload.schema.json
+ */
+
+import type { EffectiveLimits, Ext, HostedRoom, LimitSource, RetentionPolicy, RoomLimits, ScopeLimits, StorageConfigId, Usage, Visibility } from "../../../../_shared/components.js";
+
+
+/**
+ * A room-hosting administrator reads one hosted room's host record, storage placement, limits and usage. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCRoomsGetPayload {
+  /**
+   * The room's identifier, as its owner minted it.
+   */
+  roomId: string;
+  ext?: Ext;
+}
+export interface VTCRoomsGetResponsePayload {
+  room: HostedRoom;
+  /**
+   * Where the room's blobs are.
+   */
+  storage: {
+    configId: StorageConfigId;
+    /**
+     * @maxItems 64
+     */
+    earlierConfigs: ConfigHoldings[];
+    migration?: MigrationProgress;
+  };
+  limits: EffectiveLimits;
+  usage: {
+    room: Usage;
+    /**
+     * Blobs no record names, awaiting deletion after the grace window.
+     */
+    orphans: {
+      files: number;
+      bytes: number;
+      oldestOrphanedAt?: string;
+    };
+  };
+  /**
+   * The room's largest committed blobs, by size only.
+   *
+   * @maxItems 10
+   */
+  largestBlobs?:
+    | []
+    | [
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        }
+      ]
+    | [
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        }
+      ]
+    | [
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        }
+      ]
+    | [
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        }
+      ]
+    | [
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        }
+      ]
+    | [
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        }
+      ]
+    | [
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        }
+      ]
+    | [
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        }
+      ]
+    | [
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        }
+      ]
+    | [
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        },
+        {
+          size: number;
+          configId: StorageConfigId;
+          createdAt: string;
+        }
+      ];
+  /**
+   * On an `attributed` room only: how many members have added files. Absent on `open` and `private` rooms.
+   */
+  membersWithUsage?: number;
+  ext?: Ext;
+}
+/**
+ * A config holding some of this room's blobs, other than the one it is assigned to.
+ */
+export interface ConfigHoldings {
+  configId: StorageConfigId;
+  files: number;
+  bytes: number;
+}
+/**
+ * Progress of the room's migration, as vtc/rooms/storage/migrate reports it.
+ */
+export interface MigrationProgress {
+  migrationId: string;
+  /**
+   * `paused`: halted by a capacity or backend failure and resumable by issuing vtc/rooms/storage/migrate again. `failed`: halted on a blob whose copy did not verify; the blob stays where it was.
+   */
+  state: "running" | "paused" | "complete" | "failed";
+  totalFiles: number;
+  totalBytes: number;
+  doneFiles: number;
+  doneBytes: number;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { EffectiveLimits, Ext, HostedRoom, LimitSource, RetentionPolicy, RoomLimits, ScopeLimits, StorageConfigId, Usage, Visibility };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/rooms/get/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRoomsGetPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/rooms/get/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRoomsGetResponsePayload;
+
+/**
+ * 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/get/0.1",
+  "title": "VTC Rooms — Get — payload",
+  "description": "A room-hosting administrator reads one hosted room's host record, storage placement, limits and usage. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "roomId"
+  ],
+  "properties": {
+    "roomId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "The room's identifier, as its owner minted it."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "ConfigHoldings": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "A config holding some of this room's blobs, other than the one it is assigned to.",
+      "required": [
+        "configId",
+        "files",
+        "bytes"
+      ],
+      "properties": {
+        "configId": {
+          "$ref": "#/$defs/StorageConfigId"
+        },
+        "files": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "MigrationProgress": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Progress of the room's migration, as vtc/rooms/storage/migrate reports it.",
+      "required": [
+        "migrationId",
+        "state",
+        "totalFiles",
+        "totalBytes",
+        "doneFiles",
+        "doneBytes"
+      ],
+      "properties": {
+        "migrationId": {
+          "type": "string",
+          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "running",
+            "paused",
+            "complete",
+            "failed"
+          ],
+          "description": "`paused`: halted by a capacity or backend failure and resumable by issuing vtc/rooms/storage/migrate again. `failed`: halted on a blob whose copy did not verify; the blob stays where it was."
+        },
+        "totalFiles": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "totalBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "doneFiles": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "doneBytes": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Rooms — Get — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "room",
+        "storage",
+        "limits",
+        "usage"
+      ],
+      "properties": {
+        "room": {
+          "$ref": "#/$defs/HostedRoom"
+        },
+        "storage": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Where the room's blobs are.",
+          "required": [
+            "configId",
+            "earlierConfigs"
+          ],
+          "properties": {
+            "configId": {
+              "$ref": "#/$defs/StorageConfigId"
+            },
+            "earlierConfigs": {
+              "type": "array",
+              "maxItems": 64,
+              "items": {
+                "$ref": "#/$defs/ConfigHoldings"
+              }
+            },
+            "migration": {
+              "$ref": "#/$defs/MigrationProgress"
+            }
+          }
+        },
+        "limits": {
+          "$ref": "#/$defs/EffectiveLimits"
+        },
+        "usage": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "room",
+            "orphans"
+          ],
+          "properties": {
+            "room": {
+              "$ref": "#/$defs/Usage"
+            },
+            "orphans": {
+              "type": "object",
+              "additionalProperties": false,
+              "description": "Blobs no record names, awaiting deletion after the grace window.",
+              "required": [
+                "files",
+                "bytes"
+              ],
+              "properties": {
+                "files": {
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "bytes": {
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "oldestOrphanedAt": {
+                  "type": "string",
+                  "format": "date-time"
+                }
+              }
+            }
+          }
+        },
+        "largestBlobs": {
+          "type": "array",
+          "maxItems": 10,
+          "description": "The room's largest committed blobs, by size only.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "size",
+              "configId",
+              "createdAt"
+            ],
+            "properties": {
+              "size": {
+                "type": "integer",
+                "minimum": 1
+              },
+              "configId": {
+                "$ref": "#/$defs/StorageConfigId"
+              },
+              "createdAt": {
+                "type": "string",
+                "format": "date-time"
+              }
+            }
+          }
+        },
+        "membersWithUsage": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "On an `attributed` room only: how many members have added files. Absent on `open` and `private` rooms."
+        },
+        "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-]+)+$"
+      }
+    },
+    "StorageConfigId": {
+      "title": "StorageConfigId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$",
+      "description": "A storage config's identifier, chosen by the administrator who creates it and immutable thereafter: lowercase letters, digits and inner hyphens, at most 64 characters (`eu-s3-primary`, `walrus-main`). Unique within the community. Never reused after a config is retired, because blobs name their config by this value."
+    },
+    "Usage": {
+      "title": "Usage",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "files",
+        "bytes",
+        "reservedBytes"
+      ],
+      "description": "What one scope holds now. Ciphertext bytes throughout.",
+      "properties": {
+        "files": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Committed blobs that are not orphaned."
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Their total size. A blob stops counting the moment it is orphaned (its last record dropped it or was retracted), not when the host finally deletes it, so a member who deletes a file has the room back at once."
+        },
+        "reservedBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Bytes reserved by uploads begun and not yet committed, aborted or expired. Counted against `maxBytes`, so two concurrent uploads cannot both fit under a limit only one of them fits."
+        },
+        "reservedFiles": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Uploads begun and not yet committed, aborted or expired. Counted against `maxFiles`."
+        }
+      }
+    },
+    "EffectiveLimits": {
+      "title": "EffectiveLimits",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "limits",
+        "roomSource",
+        "memberSource"
+      ],
+      "description": "The limits a room is enforced against now, with where each scope's came from.",
+      "properties": {
+        "limits": {
+          "$ref": "#/$defs/RoomLimits"
+        },
+        "roomSource": {
+          "$ref": "#/$defs/LimitSource"
+        },
+        "memberSource": {
+          "$ref": "#/$defs/LimitSource"
+        },
+        "hostCeilingBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1073741824,
+          "description": "The host-wide largest-file ceiling, which no room or member limit can exceed."
+        }
+      }
+    },
+    "LimitSource": {
+      "title": "LimitSource",
+      "type": "string",
+      "enum": [
+        "policy",
+        "override",
+        "default"
+      ],
+      "description": "Where an effective limit came from. `policy`: the community's rooms policy at the room's creation. `override`: an administrator's vtc/rooms/limits/set. `default`: the community's configured defaults, where neither applies. The host-wide ceiling bounds all three."
+    },
+    "RoomLimits": {
+      "title": "RoomLimits",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "filesEnabled"
+      ],
+      "description": "How much a host is willing to store for one room, at the room and per member. A hosting decision, set by the host and never by anything in the room's credentials. An upload must fit every scope at once: the object against the smallest `maxFileBytes` that applies, and the member and the room with the file added.",
+      "properties": {
+        "filesEnabled": {
+          "type": "boolean",
+          "description": "False refuses every rooms/blobs/* upload for the room. Reads of blobs already stored continue."
+        },
+        "room": {
+          "$ref": "#/$defs/ScopeLimits",
+          "description": "Limits on the room as a whole."
+        },
+        "member": {
+          "$ref": "#/$defs/ScopeLimits",
+          "description": "Limits on each member's own uploads in this room, unless that member has an override. A member is the subject at the root of the authority chain they present, never the key that signed, so an agent acting on an attenuated chain spends its member's allowance. Not applied on a `private` room, where the host cannot tell members apart; the room and object limits still hold there."
+        }
+      }
+    },
+    "ScopeLimits": {
+      "title": "ScopeLimits",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Limits at one scope. Every member is optional: an absent member means the scope sets no limit of that kind, and the next wider scope's limit, or the host's ceiling, governs. All sizes are ciphertext bytes.",
+      "properties": {
+        "maxFiles": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The number of committed blobs the scope may hold. 0 refuses every upload at this scope."
+        },
+        "maxFileBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1073741824,
+          "description": "The largest single blob the scope accepts. Never above 1 GiB, the transfer ceiling (BlobManifest)."
+        },
+        "maxBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The total size of the committed and reserved blobs the scope may hold."
+        }
+      }
+    },
+    "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 — member for member the `HostedRoom` of vtc/rooms/list/0.1, which defines it inside its own payload schema. Nothing derived from the room's contents, and no member list: the host has none.",
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
+        },
+        "ownerDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048
+        },
+        "visibility": {
+          "$ref": "#/$defs/Visibility"
+        },
+        "retentionPolicy": {
+          "$ref": "#/$defs/RetentionPolicy"
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "lifecycle": {
+          "type": "string",
+          "enum": [
+            "live",
+            "lapsed",
+            "dormant",
+            "reclaimable"
+          ]
+        },
+        "epochExpiresAt": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "retentionDays": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "mirrorOf": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048
+        },
+        "createdAt": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "updatedAt": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "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": {
+    "ConfigHoldings": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "A config holding some of this room's blobs, other than the one it is assigned to.",
+      "required": [
+        "configId",
+        "files",
+        "bytes"
+      ],
+      "properties": {
+        "configId": {
+          "$ref": "#/$defs/StorageConfigId"
+        },
+        "files": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "MigrationProgress": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Progress of the room's migration, as vtc/rooms/storage/migrate reports it.",
+      "required": [
+        "migrationId",
+        "state",
+        "totalFiles",
+        "totalBytes",
+        "doneFiles",
+        "doneBytes"
+      ],
+      "properties": {
+        "migrationId": {
+          "type": "string",
+          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "running",
+            "paused",
+            "complete",
+            "failed"
+          ],
+          "description": "`paused`: halted by a capacity or backend failure and resumable by issuing vtc/rooms/storage/migrate again. `failed`: halted on a blob whose copy did not verify; the blob stays where it was."
+        },
+        "totalFiles": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "totalBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "doneFiles": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "doneBytes": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Rooms — Get — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "room",
+        "storage",
+        "limits",
+        "usage"
+      ],
+      "properties": {
+        "room": {
+          "$ref": "#/$defs/HostedRoom"
+        },
+        "storage": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Where the room's blobs are.",
+          "required": [
+            "configId",
+            "earlierConfigs"
+          ],
+          "properties": {
+            "configId": {
+              "$ref": "#/$defs/StorageConfigId"
+            },
+            "earlierConfigs": {
+              "type": "array",
+              "maxItems": 64,
+              "items": {
+                "$ref": "#/$defs/ConfigHoldings"
+              }
+            },
+            "migration": {
+              "$ref": "#/$defs/MigrationProgress"
+            }
+          }
+        },
+        "limits": {
+          "$ref": "#/$defs/EffectiveLimits"
+        },
+        "usage": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "room",
+            "orphans"
+          ],
+          "properties": {
+            "room": {
+              "$ref": "#/$defs/Usage"
+            },
+            "orphans": {
+              "type": "object",
+              "additionalProperties": false,
+              "description": "Blobs no record names, awaiting deletion after the grace window.",
+              "required": [
+                "files",
+                "bytes"
+              ],
+              "properties": {
+                "files": {
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "bytes": {
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "oldestOrphanedAt": {
+                  "type": "string",
+                  "format": "date-time"
+                }
+              }
+            }
+          }
+        },
+        "largestBlobs": {
+          "type": "array",
+          "maxItems": 10,
+          "description": "The room's largest committed blobs, by size only.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "size",
+              "configId",
+              "createdAt"
+            ],
+            "properties": {
+              "size": {
+                "type": "integer",
+                "minimum": 1
+              },
+              "configId": {
+                "$ref": "#/$defs/StorageConfigId"
+              },
+              "createdAt": {
+                "type": "string",
+                "format": "date-time"
+              }
+            }
+          }
+        },
+        "membersWithUsage": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "On an `attributed` room only: how many members have added files. Absent on `open` and `private` rooms."
+        },
+        "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-]+)+$"
+      }
+    },
+    "StorageConfigId": {
+      "title": "StorageConfigId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$",
+      "description": "A storage config's identifier, chosen by the administrator who creates it and immutable thereafter: lowercase letters, digits and inner hyphens, at most 64 characters (`eu-s3-primary`, `walrus-main`). Unique within the community. Never reused after a config is retired, because blobs name their config by this value."
+    },
+    "Usage": {
+      "title": "Usage",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "files",
+        "bytes",
+        "reservedBytes"
+      ],
+      "description": "What one scope holds now. Ciphertext bytes throughout.",
+      "properties": {
+        "files": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Committed blobs that are not orphaned."
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Their total size. A blob stops counting the moment it is orphaned (its last record dropped it or was retracted), not when the host finally deletes it, so a member who deletes a file has the room back at once."
+        },
+        "reservedBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Bytes reserved by uploads begun and not yet committed, aborted or expired. Counted against `maxBytes`, so two concurrent uploads cannot both fit under a limit only one of them fits."
+        },
+        "reservedFiles": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Uploads begun and not yet committed, aborted or expired. Counted against `maxFiles`."
+        }
+      }
+    },
+    "EffectiveLimits": {
+      "title": "EffectiveLimits",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "limits",
+        "roomSource",
+        "memberSource"
+      ],
+      "description": "The limits a room is enforced against now, with where each scope's came from.",
+      "properties": {
+        "limits": {
+          "$ref": "#/$defs/RoomLimits"
+        },
+        "roomSource": {
+          "$ref": "#/$defs/LimitSource"
+        },
+        "memberSource": {
+          "$ref": "#/$defs/LimitSource"
+        },
+        "hostCeilingBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1073741824,
+          "description": "The host-wide largest-file ceiling, which no room or member limit can exceed."
+        }
+      }
+    },
+    "LimitSource": {
+      "title": "LimitSource",
+      "type": "string",
+      "enum": [
+        "policy",
+        "override",
+        "default"
+      ],
+      "description": "Where an effective limit came from. `policy`: the community's rooms policy at the room's creation. `override`: an administrator's vtc/rooms/limits/set. `default`: the community's configured defaults, where neither applies. The host-wide ceiling bounds all three."
+    },
+    "RoomLimits": {
+      "title": "RoomLimits",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "filesEnabled"
+      ],
+      "description": "How much a host is willing to store for one room, at the room and per member. A hosting decision, set by the host and never by anything in the room's credentials. An upload must fit every scope at once: the object against the smallest `maxFileBytes` that applies, and the member and the room with the file added.",
+      "properties": {
+        "filesEnabled": {
+          "type": "boolean",
+          "description": "False refuses every rooms/blobs/* upload for the room. Reads of blobs already stored continue."
+        },
+        "room": {
+          "$ref": "#/$defs/ScopeLimits",
+          "description": "Limits on the room as a whole."
+        },
+        "member": {
+          "$ref": "#/$defs/ScopeLimits",
+          "description": "Limits on each member's own uploads in this room, unless that member has an override. A member is the subject at the root of the authority chain they present, never the key that signed, so an agent acting on an attenuated chain spends its member's allowance. Not applied on a `private` room, where the host cannot tell members apart; the room and object limits still hold there."
+        }
+      }
+    },
+    "ScopeLimits": {
+      "title": "ScopeLimits",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Limits at one scope. Every member is optional: an absent member means the scope sets no limit of that kind, and the next wider scope's limit, or the host's ceiling, governs. All sizes are ciphertext bytes.",
+      "properties": {
+        "maxFiles": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The number of committed blobs the scope may hold. 0 refuses every upload at this scope."
+        },
+        "maxFileBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1073741824,
+          "description": "The largest single blob the scope accepts. Never above 1 GiB, the transfer ceiling (BlobManifest)."
+        },
+        "maxBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The total size of the committed and reserved blobs the scope may hold."
+        }
+      }
+    },
+    "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 — member for member the `HostedRoom` of vtc/rooms/list/0.1, which defines it inside its own payload schema. Nothing derived from the room's contents, and no member list: the host has none.",
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
+        },
+        "ownerDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048
+        },
+        "visibility": {
+          "$ref": "#/$defs/Visibility"
+        },
+        "retentionPolicy": {
+          "$ref": "#/$defs/RetentionPolicy"
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "lifecycle": {
+          "type": "string",
+          "enum": [
+            "live",
+            "lapsed",
+            "dormant",
+            "reclaimable"
+          ]
+        },
+        "epochExpiresAt": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "retentionDays": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "mirrorOf": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048
+        },
+        "createdAt": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "updatedAt": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "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;