@openvtc/trust-tasks 0.9.0 → 0.11.0

package/src/vta/webvh/agent-name/remove/1.0/payload.ts

@@ -0,0 +1,197 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/agent-name/remove/1.0/payload.schema.json
+ */
+
+/**
+ * Release an agent name. The name becomes available for anyone else to take, so anything that resolved it may now reach a different DID.
+ */
+export interface VTAWebVHAgentNameRemovePayload {
+  /**
+   * DID the name is bound to.
+   */
+  did: string;
+  /**
+   * The name, without the host — the full form is `<host>/@<name>`.
+   */
+  name: 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/agent-name/remove. Type https://trusttasks.org/spec/vta/webvh/agent-name/remove/1.0#response.
+ */
+export interface VTAWebVHAgentNameRemoveResponsePayload {
+  did: string;
+  name: string;
+  /**
+   * Whether the name resolves after this call.
+   */
+  enabled: boolean;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/webvh/agent-name/remove/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWebVHAgentNameRemovePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/agent-name/remove/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAWebVHAgentNameRemoveResponsePayload;
+
+/**
+ * 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/agent-name/remove/1.0",
+  "title": "VTA WebVH Agent-Name Remove — payload",
+  "description": "Release an agent name. The name becomes available for anyone else to take, so anything that resolved it may now reach a different DID.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "did",
+    "name"
+  ],
+  "properties": {
+    "did": {
+      "type": "string",
+      "minLength": 1,
+      "description": "DID the name is bound to."
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The name, without the host — the full form is `<host>/@<name>`."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA WebVH Agent-Name Remove — response payload",
+      "description": "Success response to vta/webvh/agent-name/remove. Type https://trusttasks.org/spec/vta/webvh/agent-name/remove/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "name",
+        "enabled"
+      ],
+      "properties": {
+        "did": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the name resolves after this call."
+        },
+        "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 Agent-Name Remove — response payload",
+      "description": "Success response to vta/webvh/agent-name/remove. Type https://trusttasks.org/spec/vta/webvh/agent-name/remove/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "name",
+        "enabled"
+      ],
+      "properties": {
+        "did": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the name resolves after this call."
+        },
+        "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;

package/src/vta/webvh/agent-name/set/1.0/payload.ts

@@ -0,0 +1,197 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/agent-name/set/1.0/payload.schema.json
+ */
+
+/**
+ * Bind an agent name to a DID. The binding is only authoritative once the DID document claims the name back via `alsoKnownAs` — this task records the VTA's side of it.
+ */
+export interface VTAWebVHAgentNameSetPayload {
+  /**
+   * DID the name is bound to.
+   */
+  did: string;
+  /**
+   * The name, without the host — the full form is `<host>/@<name>`.
+   */
+  name: 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/agent-name/set. Type https://trusttasks.org/spec/vta/webvh/agent-name/set/1.0#response.
+ */
+export interface VTAWebVHAgentNameSetResponsePayload {
+  did: string;
+  name: string;
+  /**
+   * Whether the name resolves after this call.
+   */
+  enabled: boolean;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/webvh/agent-name/set/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWebVHAgentNameSetPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/agent-name/set/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAWebVHAgentNameSetResponsePayload;
+
+/**
+ * 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/agent-name/set/1.0",
+  "title": "VTA WebVH Agent-Name Set — payload",
+  "description": "Bind an agent name to a DID. The binding is only authoritative once the DID document claims the name back via `alsoKnownAs` — this task records the VTA's side of it.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "did",
+    "name"
+  ],
+  "properties": {
+    "did": {
+      "type": "string",
+      "minLength": 1,
+      "description": "DID the name is bound to."
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The name, without the host — the full form is `<host>/@<name>`."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA WebVH Agent-Name Set — response payload",
+      "description": "Success response to vta/webvh/agent-name/set. Type https://trusttasks.org/spec/vta/webvh/agent-name/set/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "name",
+        "enabled"
+      ],
+      "properties": {
+        "did": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the name resolves after this call."
+        },
+        "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 Agent-Name Set — response payload",
+      "description": "Success response to vta/webvh/agent-name/set. Type https://trusttasks.org/spec/vta/webvh/agent-name/set/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "name",
+        "enabled"
+      ],
+      "properties": {
+        "did": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the name resolves after this call."
+        },
+        "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;