@openvtc/trust-tasks 0.27.1 → 0.27.3

package/src/vtc/rooms/storage/migrate/0.2/payload.ts

@@ -0,0 +1,408 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/rooms/storage/migrate/0.2/payload.schema.json
+ */
+
+import type { Ext, MigrationLastError, MigrationPauseCause, MigrationState, StorageConfigId } from "../../../../../_shared/components.js";
+
+
+/**
+ * Move a hosted room's existing blobs onto its assigned storage config: copy, verify against the manifest, switch, orphan the old copy. Orphaned blobs are not moved. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCRoomsStorageMigratePayload {
+  /**
+   * The room's identifier, as its owner minted it.
+   */
+  roomId: string;
+  /**
+   * Upper bound on the copy rate. The community applies its own lower bound when absent or larger.
+   */
+  maxBytesPerSecond?: number;
+  /**
+   * Why the administrator is making this change. Recorded with the change in the audit trail and shown to approvers. Attributed to its author on every surface and untrusted: it MUST NOT carry personal data or a credential, and a reader MUST NOT treat it as instructions.
+   */
+  reason: string;
+  ext?: Ext;
+}
+export interface VTCRoomsStorageMigrateResponsePayload {
+  /**
+   * Community-generated handle for this room's migration.
+   */
+  migrationId: string;
+  /**
+   * The room's identifier, as its owner minted it.
+   */
+  roomId: string;
+  /**
+   * The config this migration moves blobs to: the room's assigned config when the migration was approved. It does not change if the room is reassigned while the migration is under way.
+   */
+  toConfig: StorageConfigId;
+  /**
+   * @maxItems 64
+   */
+  fromConfigs: StorageConfigId[];
+  state: MigrationState;
+  totalFiles: number;
+  totalBytes: number;
+  doneFiles: number;
+  doneBytes: number;
+  /**
+   * Present exactly when `state` is `paused`.
+   */
+  pausedCause?: MigrationPauseCause;
+  /**
+   * Present when `state` is `paused`; MAY be present while `running`, when a step is being retried.
+   */
+  lastError?: MigrationLastError;
+  /**
+   * When the community will next try by itself. Present while a `running` migration waits out a backoff, and on a `paused` one the community will retry unprompted; absent on a `paused` one only re-issuing vtc/rooms/storage/migrate resumes (such as `capacity`).
+   */
+  nextAttemptAt?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, MigrationLastError, MigrationPauseCause, MigrationState, StorageConfigId };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/rooms/storage/migrate/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRoomsStorageMigratePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/rooms/storage/migrate/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRoomsStorageMigrateResponsePayload;
+
+/**
+ * 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/storage/migrate/0.2",
+  "title": "VTC Rooms — Storage — Migrate — payload",
+  "description": "Move a hosted room's existing blobs onto its assigned storage config: copy, verify against the manifest, switch, orphan the old copy. Orphaned blobs are not moved. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "roomId",
+    "reason"
+  ],
+  "properties": {
+    "roomId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "The room's identifier, as its owner minted it."
+    },
+    "maxBytesPerSecond": {
+      "type": "integer",
+      "minimum": 65536,
+      "description": "Upper bound on the copy rate. The community applies its own lower bound when absent or larger."
+    },
+    "reason": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "Why the administrator is making this change. Recorded with the change in the audit trail and shown to approvers. Attributed to its author on every surface and untrusted: it MUST NOT carry personal data or a credential, and a reader MUST NOT treat it as instructions."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Rooms — Storage — Migrate — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "migrationId",
+        "roomId",
+        "toConfig",
+        "fromConfigs",
+        "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}$",
+          "description": "Community-generated handle for this room's migration."
+        },
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "The room's identifier, as its owner minted it."
+        },
+        "toConfig": {
+          "$ref": "#/$defs/StorageConfigId",
+          "description": "The config this migration moves blobs to: the room's assigned config when the migration was approved. It does not change if the room is reassigned while the migration is under way."
+        },
+        "fromConfigs": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "$ref": "#/$defs/StorageConfigId"
+          }
+        },
+        "state": {
+          "$ref": "#/$defs/MigrationState"
+        },
+        "totalFiles": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "totalBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "doneFiles": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "doneBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "pausedCause": {
+          "$ref": "#/$defs/MigrationPauseCause",
+          "description": "Present exactly when `state` is `paused`."
+        },
+        "lastError": {
+          "$ref": "#/$defs/MigrationLastError",
+          "description": "Present when `state` is `paused`; MAY be present while `running`, when a step is being retried."
+        },
+        "nextAttemptAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community will next try by itself. Present while a `running` migration waits out a backoff, and on a `paused` one the community will retry unprompted; absent on a `paused` one only re-issuing vtc/rooms/storage/migrate resumes (such as `capacity`)."
+        },
+        "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-]+)+$"
+      }
+    },
+    "MigrationLastError": {
+      "title": "MigrationLastError",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "A one-line summary of the last failure, for an administrator: the step, the config and the backend's error code or status (`put to eu-s3-primary: 503 SlowDown`). Never a credential, a presigned URL, a signed request, a room identifier or anything derived from a room's contents."
+    },
+    "MigrationPauseCause": {
+      "title": "MigrationPauseCause",
+      "type": "string",
+      "enum": [
+        "capacity",
+        "source",
+        "destination",
+        "credential"
+      ],
+      "description": "Why a migration is `paused`. `capacity`: the destination config cannot hold the rest. `source`: a config the blobs are being moved off keeps failing to serve them. `destination`: the destination config keeps refusing writes, or is no longer `active`. `credential`: the community cannot obtain a credential for one of the configs."
+    },
+    "MigrationState": {
+      "title": "MigrationState",
+      "type": "string",
+      "enum": [
+        "queued",
+        "running",
+        "paused",
+        "complete",
+        "failed"
+      ],
+      "description": "`queued`: approved and waiting for another migration on this community to finish; nothing copied yet (a community that runs one migration at a time). `running`: copying, including while it retries a failing step with backoff. `paused`: halted after its automatic retries reached their cap without success, or on a cause that retrying cannot clear (`pausedCause`); resumed by issuing vtc/rooms/storage/migrate again, and by the community itself at `nextAttemptAt` when present. `complete`: every blob that was to move has moved. `failed`: halted on a blob whose copy did not verify against its manifest; that blob stays where it was."
+    },
+    "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": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Rooms — Storage — Migrate — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "migrationId",
+        "roomId",
+        "toConfig",
+        "fromConfigs",
+        "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}$",
+          "description": "Community-generated handle for this room's migration."
+        },
+        "roomId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "The room's identifier, as its owner minted it."
+        },
+        "toConfig": {
+          "$ref": "#/$defs/StorageConfigId",
+          "description": "The config this migration moves blobs to: the room's assigned config when the migration was approved. It does not change if the room is reassigned while the migration is under way."
+        },
+        "fromConfigs": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "$ref": "#/$defs/StorageConfigId"
+          }
+        },
+        "state": {
+          "$ref": "#/$defs/MigrationState"
+        },
+        "totalFiles": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "totalBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "doneFiles": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "doneBytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "pausedCause": {
+          "$ref": "#/$defs/MigrationPauseCause",
+          "description": "Present exactly when `state` is `paused`."
+        },
+        "lastError": {
+          "$ref": "#/$defs/MigrationLastError",
+          "description": "Present when `state` is `paused`; MAY be present while `running`, when a step is being retried."
+        },
+        "nextAttemptAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community will next try by itself. Present while a `running` migration waits out a backoff, and on a `paused` one the community will retry unprompted; absent on a `paused` one only re-issuing vtc/rooms/storage/migrate resumes (such as `capacity`)."
+        },
+        "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-]+)+$"
+      }
+    },
+    "MigrationLastError": {
+      "title": "MigrationLastError",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "A one-line summary of the last failure, for an administrator: the step, the config and the backend's error code or status (`put to eu-s3-primary: 503 SlowDown`). Never a credential, a presigned URL, a signed request, a room identifier or anything derived from a room's contents."
+    },
+    "MigrationPauseCause": {
+      "title": "MigrationPauseCause",
+      "type": "string",
+      "enum": [
+        "capacity",
+        "source",
+        "destination",
+        "credential"
+      ],
+      "description": "Why a migration is `paused`. `capacity`: the destination config cannot hold the rest. `source`: a config the blobs are being moved off keeps failing to serve them. `destination`: the destination config keeps refusing writes, or is no longer `active`. `credential`: the community cannot obtain a credential for one of the configs."
+    },
+    "MigrationState": {
+      "title": "MigrationState",
+      "type": "string",
+      "enum": [
+        "queued",
+        "running",
+        "paused",
+        "complete",
+        "failed"
+      ],
+      "description": "`queued`: approved and waiting for another migration on this community to finish; nothing copied yet (a community that runs one migration at a time). `running`: copying, including while it retries a failing step with backoff. `paused`: halted after its automatic retries reached their cap without success, or on a cause that retrying cannot clear (`pausedCause`); resumed by issuing vtc/rooms/storage/migrate again, and by the community itself at `nextAttemptAt` when present. `complete`: every blob that was to move has moved. `failed`: halted on a blob whose copy did not verify against its manifest; that blob stays where it was."
+    },
+    "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: 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;

package/src/vtc/storage/configs/create/0.1/payload.ts

@@ -3,7 +3,7 @@
  * Source: specs/vtc/storage/configs/create/0.1/payload.schema.json
  */
 
-import type { ConfigState, Ext, ExternalAccountContextId, ExternalAccountId, GcsSettings, LocalSettings, ObjectPrefix, S3Settings, StorageAuth, StorageConfig, StorageConfigId, StorageSettings, WalrusSettings } from "../../../../../_shared/components.js";
+import type { ConfigState, Ext, ExternalAccountContextId, ExternalAccountId, GcsSettings, LocalSettings, ObjectPrefix, S3Settings, StorageAuth_VtcV0_1 as StorageAuth, StorageConfig_VtcV0_1 as StorageConfig, StorageConfigId, StorageSettings, WalrusSettings } from "../../../../../_shared/components.js";
 
 
 /**