@openvtc/trust-tasks 0.23.8 → 0.23.9

package/src/external/accounts/probe/0.1/payload.ts

@@ -0,0 +1,337 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/external/accounts/probe/0.1/payload.schema.json
+ */
+
+import type { AccountContextId, AccountId, AccountProbeReport, AccountProbeStep, Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Prove an external account works end to end. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface ExternalAccountsProbePayload {
+  context: AccountContextId;
+  id: AccountId;
+  ext?: Ext;
+}
+export interface ExternalAccountsProbeResponsePayload {
+  report: AccountProbeReport;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AccountContextId, AccountId, AccountProbeReport, AccountProbeStep, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/external/accounts/probe/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = ExternalAccountsProbePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/external/accounts/probe/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = ExternalAccountsProbeResponsePayload;
+
+/**
+ * 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/external/accounts/probe/0.1",
+  "title": "External Accounts — Probe — payload",
+  "description": "Prove an external account works end to end. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "context",
+    "id"
+  ],
+  "properties": {
+    "context": {
+      "$ref": "#/$defs/AccountContextId"
+    },
+    "id": {
+      "$ref": "#/$defs/AccountId"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "External Accounts — Probe — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "report"
+      ],
+      "properties": {
+        "report": {
+          "$ref": "#/$defs/AccountProbeReport"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AccountProbeReport": {
+      "title": "AccountProbeReport",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "at",
+        "ok",
+        "complete",
+        "steps"
+      ],
+      "properties": {
+        "at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ok": {
+          "type": "boolean",
+          "description": "True when every step that ran succeeded."
+        },
+        "complete": {
+          "type": "boolean",
+          "description": "True only when the canary steps (`put`, `get`, `delete`, or the model's equivalent) ran, so the account was exercised end to end. A probe that stopped after `exchange` because nothing named a canary prefix is `complete: false` even when `ok` is true, and does not clear `providerSetupRequired`."
+        },
+        "steps": {
+          "type": "array",
+          "maxItems": 8,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "step",
+              "ok"
+            ],
+            "properties": {
+              "step": {
+                "$ref": "#/$defs/AccountProbeStep"
+              },
+              "ok": {
+                "type": "boolean"
+              },
+              "durationMs": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "providerError": {
+                "type": "string",
+                "maxLength": 2048,
+                "description": "The provider's error, verbatim and truncated, so an administrator sees the cloud's own words. Untrusted text. A custodian MUST remove any credential, signature or token from it first."
+              },
+              "providerRequestId": {
+                "type": "string",
+                "maxLength": 256,
+                "pattern": "^[!-~]+$"
+              }
+            }
+          },
+          "description": "In order; the first failing step ends the probe."
+        }
+      }
+    },
+    "AccountProbeStep": {
+      "title": "AccountProbeStep",
+      "type": "string",
+      "enum": [
+        "sign",
+        "exchange",
+        "put",
+        "get",
+        "delete",
+        "decode"
+      ],
+      "description": "`sign`: the custodian signed its assertion, session request or test transaction. `exchange`: the provider issued a credential for it. `put`, `get`, `delete`: one canary object at the narrowest scope of the account's bindings. `decode`: for `sui-signer`, a built test transaction passed the allow-list (it is never submitted)."
+    },
+    "AccountId": {
+      "title": "AccountId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^[a-z0-9][a-z0-9-]*$",
+      "description": "The account's identifier within its context, chosen by whoever creates it. Lowercase letters, digits and hyphens, so that it can be embedded in a certificate subject, a token subject or a provider-side condition without escaping. Unique per context; never reused after deletion while anything that names it (a provider-side trust policy, an audit row) may still exist."
+    },
+    "AccountContextId": {
+      "title": "AccountContextId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "The custodian context that owns the account. Act scope in this context decides who may manage the account and who may consume it; the account's keys are derived in this context's key space."
+    }
+  }
+} 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": "External Accounts — Probe — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "report"
+      ],
+      "properties": {
+        "report": {
+          "$ref": "#/$defs/AccountProbeReport"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AccountProbeReport": {
+      "title": "AccountProbeReport",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "at",
+        "ok",
+        "complete",
+        "steps"
+      ],
+      "properties": {
+        "at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ok": {
+          "type": "boolean",
+          "description": "True when every step that ran succeeded."
+        },
+        "complete": {
+          "type": "boolean",
+          "description": "True only when the canary steps (`put`, `get`, `delete`, or the model's equivalent) ran, so the account was exercised end to end. A probe that stopped after `exchange` because nothing named a canary prefix is `complete: false` even when `ok` is true, and does not clear `providerSetupRequired`."
+        },
+        "steps": {
+          "type": "array",
+          "maxItems": 8,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "step",
+              "ok"
+            ],
+            "properties": {
+              "step": {
+                "$ref": "#/$defs/AccountProbeStep"
+              },
+              "ok": {
+                "type": "boolean"
+              },
+              "durationMs": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "providerError": {
+                "type": "string",
+                "maxLength": 2048,
+                "description": "The provider's error, verbatim and truncated, so an administrator sees the cloud's own words. Untrusted text. A custodian MUST remove any credential, signature or token from it first."
+              },
+              "providerRequestId": {
+                "type": "string",
+                "maxLength": 256,
+                "pattern": "^[!-~]+$"
+              }
+            }
+          },
+          "description": "In order; the first failing step ends the probe."
+        }
+      }
+    },
+    "AccountProbeStep": {
+      "title": "AccountProbeStep",
+      "type": "string",
+      "enum": [
+        "sign",
+        "exchange",
+        "put",
+        "get",
+        "delete",
+        "decode"
+      ],
+      "description": "`sign`: the custodian signed its assertion, session request or test transaction. `exchange`: the provider issued a credential for it. `put`, `get`, `delete`: one canary object at the narrowest scope of the account's bindings. `decode`: for `sui-signer`, a built test transaction passed the allow-list (it is never submitted)."
+    },
+    "AccountId": {
+      "title": "AccountId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^[a-z0-9][a-z0-9-]*$",
+      "description": "The account's identifier within its context, chosen by whoever creates it. Lowercase letters, digits and hyphens, so that it can be embedded in a certificate subject, a token subject or a provider-side condition without escaping. Unique per context; never reused after deletion while anything that names it (a provider-side trust policy, an audit row) may still exist."
+    },
+    "AccountContextId": {
+      "title": "AccountContextId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "The custodian context that owns the account. Act scope in this context decides who may manage the account and who may consume it; the account's keys are derived in this context's key space."
+    }
+  }
+} 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;