@openvtc/trust-tasks 0.9.0 → 0.11.0

package/src/vta/webvh/servers/register/1.0/payload.ts

@@ -0,0 +1,230 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/servers/register/1.0/payload.schema.json
+ */
+
+export interface VTAWebVHServersRegisterPayload {
+  /**
+   * Local id for the server. Referenced by every DID published through it.
+   */
+  id: string;
+  /**
+   * The server's DID, used to authenticate it. Absent where the VTA resolves it during registration.
+   */
+  did?: string;
+  label?: 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;
+}
+/**
+ * A hosting server the VTA is registered with. Carries no credential: what the VTA holds to authenticate against the server is never part of this record and never leaves it.
+ */
+export interface WebvhServerRecord {
+  /**
+   * Local id for the server, chosen by the operator.
+   */
+  id: string;
+  /**
+   * The server's own DID, used to authenticate it.
+   */
+  did: string;
+  label?: string;
+  createdAt: string;
+  updatedAt: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/webvh/servers/register/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWebVHServersRegisterPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/servers/register/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = WebvhServerRecord;
+
+/**
+ * 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/register/1.0",
+  "title": "VTA WebVH Servers Register — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Local id for the server. Referenced by every DID published through it."
+    },
+    "did": {
+      "type": "string",
+      "description": "The server's DID, used to authenticate it. Absent where the VTA resolves it during registration."
+    },
+    "label": {
+      "type": "string"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA WebVH Servers Register — response payload",
+      "description": "Success response to vta/webvh/servers/register: the registration the VTA now holds. Type https://trusttasks.org/spec/vta/webvh/servers/register/1.0#response.",
+      "$ref": "#/$defs/WebvhServerRecord"
+    },
+    "WebvhServerRecord": {
+      "title": "WebvhServerRecord",
+      "description": "A hosting server the VTA is registered with. Carries no credential: what the VTA holds to authenticate against the server is never part of this record and never leaves it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "did",
+        "createdAt",
+        "updatedAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Local id for the server, chosen by the operator."
+        },
+        "did": {
+          "type": "string",
+          "description": "The server's own DID, used to authenticate it."
+        },
+        "label": {
+          "type": "string"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "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 Register — response payload",
+      "description": "Success response to vta/webvh/servers/register: the registration the VTA now holds. Type https://trusttasks.org/spec/vta/webvh/servers/register/1.0#response.",
+      "$ref": "#/$defs/WebvhServerRecord"
+    },
+    "WebvhServerRecord": {
+      "title": "WebvhServerRecord",
+      "description": "A hosting server the VTA is registered with. Carries no credential: what the VTA holds to authenticate against the server is never part of this record and never leaves it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "did",
+        "createdAt",
+        "updatedAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Local id for the server, chosen by the operator."
+        },
+        "did": {
+          "type": "string",
+          "description": "The server's own DID, used to authenticate it."
+        },
+        "label": {
+          "type": "string"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "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/servers/remove/1.0/payload.ts

@@ -0,0 +1,170 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/servers/remove/1.0/payload.schema.json
+ */
+
+export interface VTAWebVHServersRemovePayload {
+  id: 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/remove. Type https://trusttasks.org/spec/vta/webvh/servers/remove/1.0#response.
+ */
+export interface VTAWebVHServersRemoveResponsePayload {
+  id: string;
+  /**
+   * Whether the registration was removed. Removing it does not unpublish anything: DIDs the server already serves keep resolving, and the VTA simply loses its route for updating them.
+   */
+  removed: boolean;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/webvh/servers/remove/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWebVHServersRemovePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/servers/remove/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAWebVHServersRemoveResponsePayload;
+
+/**
+ * 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/remove/1.0",
+  "title": "VTA WebVH Servers Remove — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA WebVH Servers Remove — response payload",
+      "description": "Success response to vta/webvh/servers/remove. Type https://trusttasks.org/spec/vta/webvh/servers/remove/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "removed"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "removed": {
+          "type": "boolean",
+          "description": "Whether the registration was removed. Removing it does not unpublish anything: DIDs the server already serves keep resolving, and the VTA simply loses its route for updating them."
+        },
+        "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 Remove — response payload",
+      "description": "Success response to vta/webvh/servers/remove. Type https://trusttasks.org/spec/vta/webvh/servers/remove/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "removed"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "removed": {
+          "type": "boolean",
+          "description": "Whether the registration was removed. Removing it does not unpublish anything: DIDs the server already serves keep resolving, and the VTA simply loses its route for updating them."
+        },
+        "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;