@openvtc/trust-tasks 0.23.7 → 0.23.9

package/src/rooms/usage/0.1/payload.ts

@@ -0,0 +1,499 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/rooms/usage/0.1/payload.schema.json
+ */
+
+import type { AuthorityPresentation, Ext, ScopeLimits, Usage } from "../../../_shared/components.js";
+
+
+/**
+ * A room's owner reads how much each member who has added files is using, against their allowance. Authorized by the room's own credentials: a chain conferring `admin` at the room's scope.
+ */
+export interface RoomsUsagePayload {
+  /**
+   * The room's identifier. The host verifies the presentation against credentials issued by this identifier.
+   */
+  roomId: string;
+  /**
+   * Must confer the `admin` action at this room's scope.
+   */
+  presentation: AuthorityPresentation;
+  /**
+   * Opaque continuation from a previous response's `nextCursor`. Omit for the first page.
+   */
+  cursor?: string;
+  /**
+   * Most entries to return. The host chooses when omitted, and may return fewer.
+   */
+  limit?: number;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * Success response to rooms/usage. Type https://trusttasks.org/spec/rooms/usage/0.1#response.
+ */
+export interface RoomsUsageResponsePayload {
+  /**
+   * The room this describes.
+   */
+  roomId: string;
+  /**
+   * One entry per member who holds or has reserved storage in the room, or holds an override. Not a roster: a member who has never added a file does not appear, because the host has never been told about them.
+   *
+   * @maxItems 500
+   */
+  members: MemberUsage[];
+  /**
+   * Present exactly when more entries remain.
+   */
+  nextCursor?: string;
+  ext?: Ext;
+}
+export interface MemberUsage {
+  /**
+   * The member's DID: the subject at the room end of the chains they presented when uploading. Uploads by a member's agents are counted here, under the member.
+   */
+  member: string;
+  usage: Usage;
+  /**
+   * The limits that apply to this member in this room: their override if one is set, else the room's per-member default.
+   */
+  limits: ScopeLimits;
+  /**
+   * True when `limits` is an override set for this member rather than the room's default.
+   */
+  overridden?: boolean;
+  /**
+   * When this member last committed a blob in the room.
+   */
+  lastUploadAt?: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AuthorityPresentation, Ext, ScopeLimits, Usage };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/rooms/usage/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = RoomsUsagePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/usage/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RoomsUsageResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/rooms/usage/0.1",
+  "title": "Rooms Usage — payload",
+  "description": "A room's owner reads how much each member who has added files is using, against their allowance. Authorized by the room's own credentials: a chain conferring `admin` at the room's scope.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "roomId",
+    "presentation"
+  ],
+  "properties": {
+    "roomId": {
+      "type": "string",
+      "description": "The room's identifier. The host verifies the presentation against credentials issued by this identifier."
+    },
+    "presentation": {
+      "$ref": "#/$defs/AuthorityPresentation",
+      "description": "Must confer the `admin` action at this room's scope."
+    },
+    "cursor": {
+      "type": "string",
+      "maxLength": 512,
+      "description": "Opaque continuation from a previous response's `nextCursor`. Omit for the first page."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 500,
+      "description": "Most entries to return. The host chooses when omitted, and may return fewer."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "MemberUsage": {
+      "title": "MemberUsage",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "member",
+        "usage",
+        "limits"
+      ],
+      "properties": {
+        "member": {
+          "type": "string",
+          "pattern": "^did:[a-z0-9]+:.+$",
+          "maxLength": 2048,
+          "description": "The member's DID: the subject at the room end of the chains they presented when uploading. Uploads by a member's agents are counted here, under the member."
+        },
+        "usage": {
+          "$ref": "#/$defs/Usage"
+        },
+        "limits": {
+          "$ref": "#/$defs/ScopeLimits",
+          "description": "The limits that apply to this member in this room: their override if one is set, else the room's per-member default."
+        },
+        "overridden": {
+          "type": "boolean",
+          "description": "True when `limits` is an override set for this member rather than the room's default."
+        },
+        "lastUploadAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When this member last committed a blob in the room."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "Rooms Usage — response payload",
+      "description": "Success response to rooms/usage. Type https://trusttasks.org/spec/rooms/usage/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "roomId",
+        "members"
+      ],
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "description": "The room this describes."
+        },
+        "members": {
+          "type": "array",
+          "maxItems": 500,
+          "items": {
+            "$ref": "#/$defs/MemberUsage"
+          },
+          "description": "One entry per member who holds or has reserved storage in the room, or holds an override. Not a roster: a member who has never added a file does not appear, because the host has never been told about them."
+        },
+        "nextCursor": {
+          "type": "string",
+          "maxLength": 512,
+          "description": "Present exactly when more entries remain."
+        },
+        "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-]+)+$"
+      }
+    },
+    "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."
+        }
+      }
+    },
+    "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`."
+        }
+      }
+    },
+    "AuthorityPresentation": {
+      "title": "AuthorityPresentation",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "membership",
+        "authority"
+      ],
+      "description": "What a party presents to act on a room. Carries the whole authority chain: a host MUST NOT dereference an authority credential's `parent` to fetch a link it was not given. Resolving over the network would make verification depend on availability, turn every identifier into a request the host can be induced to make against an address the holder chooses, and signal credential use to whoever hosts the identifier. A host MUST bind the presenter to the chain's leaf. A chain that verifies is evidence that authority was conferred on somebody; it is not evidence that the party presenting it is that somebody. The leaf's subject MUST equal the party the host authenticated for this request — an identity the transport established or a document `proof` proved, never one named in a payload. A host that omits this check authorizes every captured presentation, and the omission is silent, because the chain still verifies.",
+      "properties": {
+        "membership": {
+          "type": "string",
+          "description": "The presenter's membership credential for this room, or — on a `private` room — a zero-knowledge presentation of it. Serialized per the governing profile."
+        },
+        "authority": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 8,
+          "items": {
+            "type": "string"
+          },
+          "description": "The authority chain, LEAF FIRST: the first element is the credential being relied on and the last MUST be one issued by the room itself. Every link the presenter relies on is present, because the host will not fetch one. Capped at 8: verification is linear in chain length and runs on every operation, so an unbounded chain is a denial-of-service surface against the host. The known uses need 2 to 3 — a person attenuating to an agent, and that agent to a sub-agent."
+        },
+        "subjectBinding": {
+          "type": "string",
+          "description": "REQUIRED on a `private` room, where the subject identifier is withheld: a proof that the membership credential and the authority chain's leaf describe the SAME subject. Without it two parties pool credentials — one contributes membership, the other authority — and the combination verifies as a single party holding both. A host MUST refuse a private-room presentation that omits this."
+        }
+      }
+    }
+  }
+} 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": {
+    "MemberUsage": {
+      "title": "MemberUsage",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "member",
+        "usage",
+        "limits"
+      ],
+      "properties": {
+        "member": {
+          "type": "string",
+          "pattern": "^did:[a-z0-9]+:.+$",
+          "maxLength": 2048,
+          "description": "The member's DID: the subject at the room end of the chains they presented when uploading. Uploads by a member's agents are counted here, under the member."
+        },
+        "usage": {
+          "$ref": "#/$defs/Usage"
+        },
+        "limits": {
+          "$ref": "#/$defs/ScopeLimits",
+          "description": "The limits that apply to this member in this room: their override if one is set, else the room's per-member default."
+        },
+        "overridden": {
+          "type": "boolean",
+          "description": "True when `limits` is an override set for this member rather than the room's default."
+        },
+        "lastUploadAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When this member last committed a blob in the room."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "Rooms Usage — response payload",
+      "description": "Success response to rooms/usage. Type https://trusttasks.org/spec/rooms/usage/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "roomId",
+        "members"
+      ],
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "description": "The room this describes."
+        },
+        "members": {
+          "type": "array",
+          "maxItems": 500,
+          "items": {
+            "$ref": "#/$defs/MemberUsage"
+          },
+          "description": "One entry per member who holds or has reserved storage in the room, or holds an override. Not a roster: a member who has never added a file does not appear, because the host has never been told about them."
+        },
+        "nextCursor": {
+          "type": "string",
+          "maxLength": 512,
+          "description": "Present exactly when more entries remain."
+        },
+        "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-]+)+$"
+      }
+    },
+    "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."
+        }
+      }
+    },
+    "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`."
+        }
+      }
+    },
+    "AuthorityPresentation": {
+      "title": "AuthorityPresentation",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "membership",
+        "authority"
+      ],
+      "description": "What a party presents to act on a room. Carries the whole authority chain: a host MUST NOT dereference an authority credential's `parent` to fetch a link it was not given. Resolving over the network would make verification depend on availability, turn every identifier into a request the host can be induced to make against an address the holder chooses, and signal credential use to whoever hosts the identifier. A host MUST bind the presenter to the chain's leaf. A chain that verifies is evidence that authority was conferred on somebody; it is not evidence that the party presenting it is that somebody. The leaf's subject MUST equal the party the host authenticated for this request — an identity the transport established or a document `proof` proved, never one named in a payload. A host that omits this check authorizes every captured presentation, and the omission is silent, because the chain still verifies.",
+      "properties": {
+        "membership": {
+          "type": "string",
+          "description": "The presenter's membership credential for this room, or — on a `private` room — a zero-knowledge presentation of it. Serialized per the governing profile."
+        },
+        "authority": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 8,
+          "items": {
+            "type": "string"
+          },
+          "description": "The authority chain, LEAF FIRST: the first element is the credential being relied on and the last MUST be one issued by the room itself. Every link the presenter relies on is present, because the host will not fetch one. Capped at 8: verification is linear in chain length and runs on every operation, so an unbounded chain is a denial-of-service surface against the host. The known uses need 2 to 3 — a person attenuating to an agent, and that agent to a sub-agent."
+        },
+        "subjectBinding": {
+          "type": "string",
+          "description": "REQUIRED on a `private` room, where the subject identifier is withheld: a proof that the membership credential and the authority chain's leaf describe the SAME subject. Without it two parties pool credentials — one contributes membership, the other authority — and the combination verifies as a single party holding both. A host MUST refuse a private-room presentation that omits this."
+        }
+      }
+    }
+  }
+} 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/_shared/0.1/room-storage.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/_shared/0.1/room-storage.schema.json
+ */
+
+/**
+ * Shared types for the host-side administration of files in the data rooms a community hosts: the vtc/storage/configs/*, vtc/storage/credentials/set, vtc/rooms/get, vtc/rooms/limits/set, vtc/rooms/usage and vtc/rooms/storage/* tasks. A storage config is one named backend — a local directory, an S3-compatible bucket, a Google Cloud Storage bucket or Walrus — with its own account and credentials. Every room is assigned to exactly one config, which receives its new uploads; one config serves any number of rooms; every blob remembers the config it was written to, so reassigning a room strands nothing. Limits, usage and blob shapes come from rooms/_shared/0.1/blobs.schema.json. No member of any type here carries a secret: a credential is referred to by mode, account and fingerprint, never by value. Not itself a Trust Task specification (the `_shared` folder is skipped by the registry build and the codegen).
+ */
+export interface VTCSharedRoomStorageDefinitions {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { ConfigState, CredentialState, EffectiveLimits, ExternalAccountId, GcsSettings, HostedRoom, LimitSource, LimitTarget, LocalSettings, ObjectPrefix, S3Settings, StorageAuth, StorageConfig, StorageConfigFacts, StorageConfigId, StorageHealth, StorageKind, StorageSettings, WalrusSettings } from "../../../_shared/components.js";