@openvtc/trust-tasks 0.23.8 → 0.24.0

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

@@ -0,0 +1,568 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/rooms/usage/0.1/payload.schema.json
+ */
+
+import type { Ext, ScopeLimits, StorageConfigId } from "../../../../_shared/components.js";
+
+
+/**
+ * A room-hosting administrator reports the storage and activity of the community's hosted rooms, grouped by room, member, storage config or day. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCRoomsUsagePayload {
+  /**
+   * What each row describes. `day` is the daily history of whatever the filter selects.
+   */
+  groupBy: "room" | "member" | "storageConfig" | "day";
+  /**
+   * Every member optional; all given apply together.
+   */
+  filter?: {
+    /**
+     * The room's identifier, as its owner minted it.
+     */
+    roomId?: string;
+    /**
+     * One member's figures, across the `attributed` rooms selected.
+     */
+    member?: string;
+    storageConfig?: StorageConfigId;
+    /**
+     * First UTC day of the range. Default: 29 days before `to`.
+     */
+    from?: string;
+    /**
+     * Last UTC day of the range, inclusive. Default: today.
+     */
+    to?: string;
+  };
+  sort?: {
+    by: "bytes" | "files" | "uploads" | "downloads" | "egressBytes" | "date";
+    order?: "asc" | "desc";
+  };
+  /**
+   * 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 VTCRoomsUsageResponsePayload {
+  asOf: string;
+  from: string;
+  to: string;
+  /**
+   * @maxItems 100
+   */
+  items: UsageRow[];
+  /**
+   * Present when more remain; pass it as `cursor`.
+   */
+  nextCursor?: string;
+  ext?: Ext;
+}
+/**
+ * One group's figures. Holdings as of the read (or the end of the day, on a `day` row); activity over the range (or the day).
+ */
+export interface UsageRow {
+  /**
+   * Present on a `room` row.
+   */
+  roomId?: string;
+  /**
+   * Present on a `member` row.
+   */
+  member?: string;
+  /**
+   * Present on a `storageConfig` row, and on a `room` row as the room's assigned config.
+   */
+  storageConfig?: StorageConfigId;
+  /**
+   * Present on a `day` row.
+   */
+  date?: string;
+  files: number;
+  bytes: number;
+  reservedBytes: number;
+  uploads: number;
+  downloads: number;
+  egressBytes: number;
+  /**
+   * On a `room` row the room's limits, on a `member` row (one room selected) that member's.
+   */
+  limits?: ScopeLimits;
+  /**
+   * On a `storageConfig` row, the config's capacity when it has one.
+   */
+  capacityBytes?: number;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, ScopeLimits, StorageConfigId };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/rooms/usage/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRoomsUsagePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/rooms/usage/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRoomsUsageResponsePayload;
+
+/**
+ * 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/usage/0.1",
+  "title": "VTC Rooms — Usage — payload",
+  "description": "A room-hosting administrator reports the storage and activity of the community's hosted rooms, grouped by room, member, storage config or day. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "groupBy"
+  ],
+  "properties": {
+    "groupBy": {
+      "type": "string",
+      "enum": [
+        "room",
+        "member",
+        "storageConfig",
+        "day"
+      ],
+      "description": "What each row describes. `day` is the daily history of whatever the filter selects."
+    },
+    "filter": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Every member optional; all given apply together.",
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "The room's identifier, as its owner minted it."
+        },
+        "member": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "One member's figures, across the `attributed` rooms selected."
+        },
+        "storageConfig": {
+          "$ref": "#/$defs/StorageConfigId"
+        },
+        "from": {
+          "type": "string",
+          "format": "date",
+          "description": "First UTC day of the range. Default: 29 days before `to`."
+        },
+        "to": {
+          "type": "string",
+          "format": "date",
+          "description": "Last UTC day of the range, inclusive. Default: today."
+        }
+      }
+    },
+    "sort": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "by"
+      ],
+      "properties": {
+        "by": {
+          "type": "string",
+          "enum": [
+            "bytes",
+            "files",
+            "uploads",
+            "downloads",
+            "egressBytes",
+            "date"
+          ]
+        },
+        "order": {
+          "type": "string",
+          "enum": [
+            "asc",
+            "desc"
+          ]
+        }
+      }
+    },
+    "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": {
+    "UsageRow": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "One group's figures. Holdings as of the read (or the end of the day, on a `day` row); activity over the range (or the day).",
+      "required": [
+        "files",
+        "bytes",
+        "reservedBytes",
+        "uploads",
+        "downloads",
+        "egressBytes"
+      ],
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "Present on a `room` row."
+        },
+        "member": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "Present on a `member` row."
+        },
+        "storageConfig": {
+          "$ref": "#/$defs/StorageConfigId",
+          "description": "Present on a `storageConfig` row, and on a `room` row as the room's assigned config."
+        },
+        "date": {
+          "type": "string",
+          "format": "date",
+          "description": "Present on a `day` row."
+        },
+        "files": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "reservedBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "uploads": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "downloads": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "egressBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "limits": {
+          "$ref": "#/$defs/ScopeLimits",
+          "description": "On a `room` row the room's limits, on a `member` row (one room selected) that member's."
+        },
+        "capacityBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "On a `storageConfig` row, the config's capacity when it has one."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Rooms — Usage — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "asOf",
+        "from",
+        "to",
+        "items"
+      ],
+      "properties": {
+        "asOf": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "from": {
+          "type": "string",
+          "format": "date"
+        },
+        "to": {
+          "type": "string",
+          "format": "date"
+        },
+        "items": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/$defs/UsageRow"
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "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."
+        }
+      }
+    },
+    "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."
+    }
+  }
+} 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": {
+    "UsageRow": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "One group's figures. Holdings as of the read (or the end of the day, on a `day` row); activity over the range (or the day).",
+      "required": [
+        "files",
+        "bytes",
+        "reservedBytes",
+        "uploads",
+        "downloads",
+        "egressBytes"
+      ],
+      "properties": {
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "Present on a `room` row."
+        },
+        "member": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "Present on a `member` row."
+        },
+        "storageConfig": {
+          "$ref": "#/$defs/StorageConfigId",
+          "description": "Present on a `storageConfig` row, and on a `room` row as the room's assigned config."
+        },
+        "date": {
+          "type": "string",
+          "format": "date",
+          "description": "Present on a `day` row."
+        },
+        "files": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "reservedBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "uploads": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "downloads": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "egressBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "limits": {
+          "$ref": "#/$defs/ScopeLimits",
+          "description": "On a `room` row the room's limits, on a `member` row (one room selected) that member's."
+        },
+        "capacityBytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "On a `storageConfig` row, the config's capacity when it has one."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Rooms — Usage — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "asOf",
+        "from",
+        "to",
+        "items"
+      ],
+      "properties": {
+        "asOf": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "from": {
+          "type": "string",
+          "format": "date"
+        },
+        "to": {
+          "type": "string",
+          "format": "date"
+        },
+        "items": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/$defs/UsageRow"
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "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."
+        }
+      }
+    },
+    "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."
+    }
+  }
+} 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;