@openvtc/trust-tasks 0.12.0 → 0.12.2

package/src/vta/webvh/servers/retire-orphan/0.1/payload.ts

@@ -0,0 +1,223 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/servers/retire-orphan/0.1/payload.schema.json
+ */
+
+export interface VTAWebVHServersRetireOrphanPayload {
+  /**
+   * The hosting server holding the orphaned slot, as the agent has it registered.
+   */
+  serverId: string;
+  /**
+   * The slot to retire, as reported in a reconcile response's hostOnly. The slot identifier rather than the DID, because a slot reserved but never published to has no DID and is exactly as orphaned.
+   */
+  slotId: string;
+  /**
+   * The DID the producer believes the slot serves. When present the agent MUST refuse unless it matches, so a slotId that has been reused since the report was taken cannot retire something else. Absent for a slot that was never published to.
+   */
+  expectedDid?: string;
+  /**
+   * Operator rationale, recorded in the agent's audit trail. The act has no undo, so why it was done outlives the record of what was done.
+   */
+  reason?: string;
+  ext?: Ext;
+}
+/**
+ * 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.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Success response to vta/webvh/servers/retire-orphan. Type https://trusttasks.org/spec/vta/webvh/servers/retire-orphan/0.1#response.
+ */
+export interface VTAWebVHServersRetireOrphanResponsePayload {
+  serverId: string;
+  slotId: string;
+  /**
+   * Whether the slot is no longer served. False is reported, not inferred: an agent that could not confirm removal with the host MUST NOT claim it.
+   */
+  retired: boolean;
+  /**
+   * The DID the slot was serving, echoed so the record of what was retired survives the slot's disappearance. Absent where the slot was never published to.
+   */
+  did?: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/webvh/servers/retire-orphan/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWebVHServersRetireOrphanPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/servers/retire-orphan/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAWebVHServersRetireOrphanResponsePayload;
+
+/**
+ * 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/vta/webvh/servers/retire-orphan/0.1",
+  "title": "VTA WebVH Servers Retire Orphan — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "serverId",
+    "slotId"
+  ],
+  "properties": {
+    "serverId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The hosting server holding the orphaned slot, as the agent has it registered."
+    },
+    "slotId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The slot to retire, as reported in a reconcile response's hostOnly. The slot identifier rather than the DID, because a slot reserved but never published to has no DID and is exactly as orphaned."
+    },
+    "expectedDid": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The DID the producer believes the slot serves. When present the agent MUST refuse unless it matches, so a slotId that has been reused since the report was taken cannot retire something else. Absent for a slot that was never published to."
+    },
+    "reason": {
+      "type": "string",
+      "maxLength": 1024,
+      "description": "Operator rationale, recorded in the agent's audit trail. The act has no undo, so why it was done outlives the record of what was done."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA WebVH Servers Retire Orphan — response payload",
+      "description": "Success response to vta/webvh/servers/retire-orphan. Type https://trusttasks.org/spec/vta/webvh/servers/retire-orphan/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "serverId",
+        "slotId",
+        "retired"
+      ],
+      "properties": {
+        "serverId": {
+          "type": "string"
+        },
+        "slotId": {
+          "type": "string"
+        },
+        "retired": {
+          "type": "boolean",
+          "description": "Whether the slot is no longer served. False is reported, not inferred: an agent that could not confirm removal with the host MUST NOT claim it."
+        },
+        "did": {
+          "type": "string",
+          "description": "The DID the slot was serving, echoed so the record of what was retired survives the slot's disappearance. Absent where the slot was never published to."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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": "VTA WebVH Servers Retire Orphan — response payload",
+      "description": "Success response to vta/webvh/servers/retire-orphan. Type https://trusttasks.org/spec/vta/webvh/servers/retire-orphan/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "serverId",
+        "slotId",
+        "retired"
+      ],
+      "properties": {
+        "serverId": {
+          "type": "string"
+        },
+        "slotId": {
+          "type": "string"
+        },
+        "retired": {
+          "type": "boolean",
+          "description": "Whether the slot is no longer served. False is reported, not inferred: an agent that could not confirm removal with the host MUST NOT claim it."
+        },
+        "did": {
+          "type": "string",
+          "description": "The DID the slot was serving, echoed so the record of what was retired survives the slot's disappearance. Absent where the slot was never published to."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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,
+  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,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;