@openvtc/trust-tasks 0.21.4 → 0.21.5

package/src/did-management/registry/get/0.1/payload.ts

@@ -0,0 +1,410 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/registry/get/0.1/payload.schema.json
+ */
+
+import type { Ext, ServiceInstance_DidManagementV0_2 as ServiceInstance, TransportObservation } from "../../../../_shared/components.js";
+
+
+export interface RegistryGetPayload {
+  /**
+   * The registry identifier of the instance to read.
+   */
+  instanceId: string;
+  ext?: Ext;
+}
+export interface RegistryGetResponsePayload {
+  instance: ServiceInstance;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, ServiceInstance, TransportObservation };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/did-management/registry/get/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = RegistryGetPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/registry/get/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RegistryGetResponsePayload;
+
+/**
+ * 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/did-management/registry/get/0.1",
+  "title": "Registry Get — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "instanceId"
+  ],
+  "properties": {
+    "instanceId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "The registry identifier of the instance to read."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Registry Get — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "instance"
+      ],
+      "properties": {
+        "instance": {
+          "$ref": "#/$defs/ServiceInstance"
+        },
+        "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-]+)+$"
+      }
+    },
+    "ServiceInstance": {
+      "title": "ServiceInstance",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "instanceId",
+        "did",
+        "serviceType",
+        "status",
+        "registeredAt",
+        "servedDomains"
+      ],
+      "properties": {
+        "instanceId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Stable identifier the control plane uses for this instance. SHOULD be derived from the instance's DID so it survives restarts."
+        },
+        "did": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The instance's own DID — the identity its signed documents are verified against and the one the control plane addresses."
+        },
+        "serviceType": {
+          "type": "string",
+          "enum": [
+            "server",
+            "witness",
+            "watcher"
+          ],
+          "description": "`server` — a hosting server (edge) that resolves DIDs the control plane syncs to it. `witness` — a did:webvh witness. `watcher` — a did:webvh watcher that mirrors logs."
+        },
+        "label": {
+          "type": "string",
+          "maxLength": 256,
+          "description": "Operator-chosen display label. Untrusted free text."
+        },
+        "publicUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "The instance's public base URL, where it serves DID resolution. Absent when the instance registered without one."
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "active",
+            "degraded",
+            "unreachable"
+          ],
+          "description": "The control plane's current verdict, from the instance's last answered health probe. `degraded` — answered late; `unreachable` — has not answered within the control plane's configured window."
+        },
+        "servedDomains": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Hosting domains the instance has acknowledged serving. Always present — empty for an instance that serves none, which includes every `witness` and `watcher`."
+        },
+        "enabledMethods": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "DID methods the instance can host (e.g. `webvh`, `web`, `webs`), as it declared at registration."
+        },
+        "advertisedServices": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "`service[].type` values of the instance's DID document when the control plane last resolved it. Display only: nothing is routed on it. Absent when the document has not been resolved."
+        },
+        "servicesCheckedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When `advertisedServices` was last resolved. Absent with it."
+        },
+        "lastInbound": {
+          "$ref": "#/$defs/TransportObservation",
+          "description": "The last document the control plane received from this instance. Absent when it has received none."
+        },
+        "lastOutbound": {
+          "$ref": "#/$defs/TransportObservation",
+          "description": "The last document the control plane delivered to this instance. Absent when it has delivered none."
+        },
+        "lastHealthCheck": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the instance last answered a health probe. Absent when it never has."
+        },
+        "registeredAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "TransportObservation": {
+      "title": "TransportObservation",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "transport",
+        "at"
+      ],
+      "properties": {
+        "transport": {
+          "type": "string",
+          "enum": [
+            "tsp",
+            "didcomm",
+            "https"
+          ],
+          "description": "The binding the document actually travelled on."
+        },
+        "at": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    }
+  }
+} 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": "Registry Get — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "instance"
+      ],
+      "properties": {
+        "instance": {
+          "$ref": "#/$defs/ServiceInstance"
+        },
+        "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-]+)+$"
+      }
+    },
+    "ServiceInstance": {
+      "title": "ServiceInstance",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "instanceId",
+        "did",
+        "serviceType",
+        "status",
+        "registeredAt",
+        "servedDomains"
+      ],
+      "properties": {
+        "instanceId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Stable identifier the control plane uses for this instance. SHOULD be derived from the instance's DID so it survives restarts."
+        },
+        "did": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The instance's own DID — the identity its signed documents are verified against and the one the control plane addresses."
+        },
+        "serviceType": {
+          "type": "string",
+          "enum": [
+            "server",
+            "witness",
+            "watcher"
+          ],
+          "description": "`server` — a hosting server (edge) that resolves DIDs the control plane syncs to it. `witness` — a did:webvh witness. `watcher` — a did:webvh watcher that mirrors logs."
+        },
+        "label": {
+          "type": "string",
+          "maxLength": 256,
+          "description": "Operator-chosen display label. Untrusted free text."
+        },
+        "publicUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "The instance's public base URL, where it serves DID resolution. Absent when the instance registered without one."
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "active",
+            "degraded",
+            "unreachable"
+          ],
+          "description": "The control plane's current verdict, from the instance's last answered health probe. `degraded` — answered late; `unreachable` — has not answered within the control plane's configured window."
+        },
+        "servedDomains": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Hosting domains the instance has acknowledged serving. Always present — empty for an instance that serves none, which includes every `witness` and `watcher`."
+        },
+        "enabledMethods": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "DID methods the instance can host (e.g. `webvh`, `web`, `webs`), as it declared at registration."
+        },
+        "advertisedServices": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "`service[].type` values of the instance's DID document when the control plane last resolved it. Display only: nothing is routed on it. Absent when the document has not been resolved."
+        },
+        "servicesCheckedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When `advertisedServices` was last resolved. Absent with it."
+        },
+        "lastInbound": {
+          "$ref": "#/$defs/TransportObservation",
+          "description": "The last document the control plane received from this instance. Absent when it has received none."
+        },
+        "lastOutbound": {
+          "$ref": "#/$defs/TransportObservation",
+          "description": "The last document the control plane delivered to this instance. Absent when it has delivered none."
+        },
+        "lastHealthCheck": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the instance last answered a health probe. Absent when it never has."
+        },
+        "registeredAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "TransportObservation": {
+      "title": "TransportObservation",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "transport",
+        "at"
+      ],
+      "properties": {
+        "transport": {
+          "type": "string",
+          "enum": [
+            "tsp",
+            "didcomm",
+            "https"
+          ],
+          "description": "The binding the document actually travelled on."
+        },
+        "at": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    }
+  }
+} 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: false,
+  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: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;