@openvtc/trust-tasks 0.23.8 → 0.24.0

package/dist/vtc/rooms/storage/migrate/0.1/payload.d.ts

@@ -0,0 +1,452 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/rooms/storage/migrate/0.1/payload.schema.json
+ */
+import type { Ext, 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. 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;
+    toConfig: StorageConfigId;
+    /**
+     * @maxItems 64
+     */
+    fromConfigs: StorageConfigId[];
+    state: "running" | "paused" | "complete" | "failed";
+    totalFiles: number;
+    totalBytes: number;
+    doneFiles: number;
+    doneBytes: number;
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, StorageConfigId };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/rooms/storage/migrate/0.1";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRoomsStorageMigratePayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/rooms/storage/migrate/0.1#response";
+/** 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vtc/rooms/storage/migrate/0.1";
+    readonly title: "VTC Rooms — Storage — Migrate — payload";
+    readonly description: "Move a hosted room's existing blobs onto its assigned storage config: copy, verify against the manifest, switch, orphan the old copy. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["roomId", "reason"];
+    readonly properties: {
+        readonly roomId: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 512;
+            readonly description: "The room's identifier, as its owner minted it.";
+        };
+        readonly maxBytesPerSecond: {
+            readonly type: "integer";
+            readonly minimum: 65536;
+            readonly description: "Upper bound on the copy rate. The community applies its own lower bound when absent or larger.";
+        };
+        readonly reason: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 500;
+            readonly 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.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Rooms — Storage — Migrate — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["migrationId", "roomId", "toConfig", "fromConfigs", "state", "totalFiles", "totalBytes", "doneFiles", "doneBytes"];
+            readonly properties: {
+                readonly migrationId: {
+                    readonly type: "string";
+                    readonly 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}$";
+                    readonly description: "Community-generated handle for this room's migration.";
+                };
+                readonly roomId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 512;
+                    readonly description: "The room's identifier, as its owner minted it.";
+                };
+                readonly toConfig: {
+                    readonly $ref: "#/$defs/StorageConfigId";
+                };
+                readonly fromConfigs: {
+                    readonly type: "array";
+                    readonly maxItems: 64;
+                    readonly items: {
+                        readonly $ref: "#/$defs/StorageConfigId";
+                    };
+                };
+                readonly state: {
+                    readonly type: "string";
+                    readonly enum: readonly ["running", "paused", "complete", "failed"];
+                };
+                readonly totalFiles: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly totalBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly doneFiles: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly doneBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly StorageConfigId: {
+            readonly title: "StorageConfigId";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 64;
+            readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
+            readonly 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 {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Rooms — Storage — Migrate — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["migrationId", "roomId", "toConfig", "fromConfigs", "state", "totalFiles", "totalBytes", "doneFiles", "doneBytes"];
+            readonly properties: {
+                readonly migrationId: {
+                    readonly type: "string";
+                    readonly 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}$";
+                    readonly description: "Community-generated handle for this room's migration.";
+                };
+                readonly roomId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 512;
+                    readonly description: "The room's identifier, as its owner minted it.";
+                };
+                readonly toConfig: {
+                    readonly $ref: "#/$defs/StorageConfigId";
+                };
+                readonly fromConfigs: {
+                    readonly type: "array";
+                    readonly maxItems: 64;
+                    readonly items: {
+                        readonly $ref: "#/$defs/StorageConfigId";
+                    };
+                };
+                readonly state: {
+                    readonly type: "string";
+                    readonly enum: readonly ["running", "paused", "complete", "failed"];
+                };
+                readonly totalFiles: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly totalBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly doneFiles: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly doneBytes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly StorageConfigId: {
+            readonly title: "StorageConfigId";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 64;
+            readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
+            readonly 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.";
+        };
+    };
+};
+/**
+ * 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtc/rooms/storage/migrate/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtc/rooms/storage/migrate/0.1";
+        readonly title: "VTC Rooms — Storage — Migrate — payload";
+        readonly description: "Move a hosted room's existing blobs onto its assigned storage config: copy, verify against the manifest, switch, orphan the old copy. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["roomId", "reason"];
+        readonly properties: {
+            readonly roomId: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 512;
+                readonly description: "The room's identifier, as its owner minted it.";
+            };
+            readonly maxBytesPerSecond: {
+                readonly type: "integer";
+                readonly minimum: 65536;
+                readonly description: "Upper bound on the copy rate. The community applies its own lower bound when absent or larger.";
+            };
+            readonly reason: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 500;
+                readonly 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.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Rooms — Storage — Migrate — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["migrationId", "roomId", "toConfig", "fromConfigs", "state", "totalFiles", "totalBytes", "doneFiles", "doneBytes"];
+                readonly properties: {
+                    readonly migrationId: {
+                        readonly type: "string";
+                        readonly 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}$";
+                        readonly description: "Community-generated handle for this room's migration.";
+                    };
+                    readonly roomId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 512;
+                        readonly description: "The room's identifier, as its owner minted it.";
+                    };
+                    readonly toConfig: {
+                        readonly $ref: "#/$defs/StorageConfigId";
+                    };
+                    readonly fromConfigs: {
+                        readonly type: "array";
+                        readonly maxItems: 64;
+                        readonly items: {
+                            readonly $ref: "#/$defs/StorageConfigId";
+                        };
+                    };
+                    readonly state: {
+                        readonly type: "string";
+                        readonly enum: readonly ["running", "paused", "complete", "failed"];
+                    };
+                    readonly totalFiles: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly doneFiles: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly doneBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly StorageConfigId: {
+                readonly title: "StorageConfigId";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 64;
+                readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
+                readonly 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.";
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtc/rooms/storage/migrate/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Rooms — Storage — Migrate — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["migrationId", "roomId", "toConfig", "fromConfigs", "state", "totalFiles", "totalBytes", "doneFiles", "doneBytes"];
+                readonly properties: {
+                    readonly migrationId: {
+                        readonly type: "string";
+                        readonly 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}$";
+                        readonly description: "Community-generated handle for this room's migration.";
+                    };
+                    readonly roomId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 512;
+                        readonly description: "The room's identifier, as its owner minted it.";
+                    };
+                    readonly toConfig: {
+                        readonly $ref: "#/$defs/StorageConfigId";
+                    };
+                    readonly fromConfigs: {
+                        readonly type: "array";
+                        readonly maxItems: 64;
+                        readonly items: {
+                            readonly $ref: "#/$defs/StorageConfigId";
+                        };
+                    };
+                    readonly state: {
+                        readonly type: "string";
+                        readonly enum: readonly ["running", "paused", "complete", "failed"];
+                    };
+                    readonly totalFiles: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly doneFiles: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly doneBytes: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly StorageConfigId: {
+                readonly title: "StorageConfigId";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 64;
+                readonly pattern: "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$";
+                readonly 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.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vtc/rooms/storage/migrate/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vtc/rooms/storage/migrate/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAGjF;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,WAAW,EAAE,eAAe,EAAE,CAAC;IAC/B,KAAK,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;IACpD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC;AAErC,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,2DAAoE,CAAC;AAE7F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,6BAA6B,CAAC;AAEpD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,oEAA6E,CAAC;AAE/G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,qCAAqC,CAAC;AAE7D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyHjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2F1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}