@openvtc/trust-tasks 0.23.8 → 0.24.0

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

@@ -0,0 +1,329 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/storage/configs/probe/0.1/payload.schema.json
+ */
+
+import type { Ext, StorageConfigId } from "../../../../../_shared/components.js";
+
+
+/**
+ * Check a storage config end to end with its own credentials, using a canary under a probe prefix. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCStorageConfigsProbePayload {
+  configId: StorageConfigId;
+  /**
+   * On a `walrus` config, register, read and let lapse a canary blob, which costs storage funds. Ignored on other kinds, which always write.
+   */
+  includeWrite?: boolean;
+  ext?: Ext;
+}
+export interface VTCStorageConfigsProbeResponsePayload {
+  configId: StorageConfigId;
+  /**
+   * True when every step attempted succeeded.
+   */
+  ok: boolean;
+  probedAt: string;
+  /**
+   * Where the canary was written, relative to the config's own prefix.
+   */
+  prefix: string;
+  /**
+   * @minItems 1
+   * @maxItems 6
+   */
+  steps:
+    | [StepResult]
+    | [StepResult, StepResult]
+    | [StepResult, StepResult, StepResult]
+    | [StepResult, StepResult, StepResult, StepResult]
+    | [StepResult, StepResult, StepResult, StepResult, StepResult]
+    | [StepResult, StepResult, StepResult, StepResult, StepResult, StepResult];
+  ext?: Ext;
+}
+export interface StepResult {
+  step: "authenticate" | "put" | "get" | "delete" | "reachRelay" | "reachAggregator";
+  ok: boolean;
+  durationMs: number;
+  /**
+   * On failure, the backend's error verbatim, truncated, with anything credential-like removed. Untrusted text: render it as text, never as markup or instructions.
+   */
+  error?: string;
+}
+
+/** 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 const TYPE_URI = "https://trusttasks.org/spec/vtc/storage/configs/probe/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCStorageConfigsProbePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/storage/configs/probe/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCStorageConfigsProbeResponsePayload;
+
+/**
+ * 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/storage/configs/probe/0.1",
+  "title": "VTC Storage — Configs — Probe — payload",
+  "description": "Check a storage config end to end with its own credentials, using a canary under a probe prefix. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "configId"
+  ],
+  "properties": {
+    "configId": {
+      "$ref": "#/$defs/StorageConfigId"
+    },
+    "includeWrite": {
+      "type": "boolean",
+      "description": "On a `walrus` config, register, read and let lapse a canary blob, which costs storage funds. Ignored on other kinds, which always write."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "StepResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "step",
+        "ok",
+        "durationMs"
+      ],
+      "properties": {
+        "step": {
+          "type": "string",
+          "enum": [
+            "authenticate",
+            "put",
+            "get",
+            "delete",
+            "reachRelay",
+            "reachAggregator"
+          ]
+        },
+        "ok": {
+          "type": "boolean"
+        },
+        "durationMs": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "error": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "On failure, the backend's error verbatim, truncated, with anything credential-like removed. Untrusted text: render it as text, never as markup or instructions."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Storage — Configs — Probe — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "configId",
+        "ok",
+        "probedAt",
+        "prefix",
+        "steps"
+      ],
+      "properties": {
+        "configId": {
+          "$ref": "#/$defs/StorageConfigId"
+        },
+        "ok": {
+          "type": "boolean",
+          "description": "True when every step attempted succeeded."
+        },
+        "probedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "prefix": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "Where the canary was written, relative to the config's own prefix."
+        },
+        "steps": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 6,
+          "items": {
+            "$ref": "#/$defs/StepResult"
+          }
+        },
+        "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."
+    }
+  }
+} 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": {
+    "StepResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "step",
+        "ok",
+        "durationMs"
+      ],
+      "properties": {
+        "step": {
+          "type": "string",
+          "enum": [
+            "authenticate",
+            "put",
+            "get",
+            "delete",
+            "reachRelay",
+            "reachAggregator"
+          ]
+        },
+        "ok": {
+          "type": "boolean"
+        },
+        "durationMs": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "error": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "On failure, the backend's error verbatim, truncated, with anything credential-like removed. Untrusted text: render it as text, never as markup or instructions."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Storage — Configs — Probe — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "configId",
+        "ok",
+        "probedAt",
+        "prefix",
+        "steps"
+      ],
+      "properties": {
+        "configId": {
+          "$ref": "#/$defs/StorageConfigId"
+        },
+        "ok": {
+          "type": "boolean",
+          "description": "True when every step attempted succeeded."
+        },
+        "probedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "prefix": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "Where the canary was written, relative to the config's own prefix."
+        },
+        "steps": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 6,
+          "items": {
+            "$ref": "#/$defs/StepResult"
+          }
+        },
+        "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."
+    }
+  }
+} 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: 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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

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

@@ -0,0 +1,211 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/storage/configs/retire/0.1/payload.schema.json
+ */
+
+import type { Ext, StorageConfigId } from "../../../../../_shared/components.js";
+
+
+/**
+ * Take a storage config with no rooms assigned out of service. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCStorageConfigsRetirePayload {
+  configId: StorageConfigId;
+  /**
+   * 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 VTCStorageConfigsRetireResponsePayload {
+  configId: StorageConfigId;
+  state: "draining" | "retired";
+  blobsRemaining: 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 const TYPE_URI = "https://trusttasks.org/spec/vtc/storage/configs/retire/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCStorageConfigsRetirePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/storage/configs/retire/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCStorageConfigsRetireResponsePayload;
+
+/**
+ * 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/storage/configs/retire/0.1",
+  "title": "VTC Storage — Configs — Retire — payload",
+  "description": "Take a storage config with no rooms assigned out of service. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "configId",
+    "reason"
+  ],
+  "properties": {
+    "configId": {
+      "$ref": "#/$defs/StorageConfigId"
+    },
+    "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 Storage — Configs — Retire — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "configId",
+        "state",
+        "blobsRemaining"
+      ],
+      "properties": {
+        "configId": {
+          "$ref": "#/$defs/StorageConfigId"
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "draining",
+            "retired"
+          ]
+        },
+        "blobsRemaining": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "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."
+    }
+  }
+} 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 Storage — Configs — Retire — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "configId",
+        "state",
+        "blobsRemaining"
+      ],
+      "properties": {
+        "configId": {
+          "$ref": "#/$defs/StorageConfigId"
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "draining",
+            "retired"
+          ]
+        },
+        "blobsRemaining": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "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."
+    }
+  }
+} 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;