@openvtc/trust-tasks 0.28.17 → 0.28.18

package/src/vtn/registry/check/0.1/payload.ts

@@ -0,0 +1,365 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/registry/check/0.1/payload.schema.json
+ */
+
+import type { Did_VtnV0_1 as Did, Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Ask the network to ask its trust registry about one party. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNRegistryCheckPayload {
+  /**
+   * The party asked about.
+   */
+  did: Did;
+  ext?: Ext;
+}
+/**
+ * What the registry answered, and its own answer document.
+ */
+export interface VTNRegistryCheckResponsePayload {
+  /**
+   * The trust registry asked.
+   */
+  registry: Did;
+  /**
+   * The network's DID: the authority of its records.
+   */
+  authority: Did;
+  /**
+   * The TRQP resource the network's records are published under.
+   */
+  resource: string;
+  actions: Actions;
+  /**
+   * The party asked about.
+   */
+  did: Did;
+  /**
+   * Whether the registry answered. `false` is indeterminate, never "not a member".
+   */
+  reachable: boolean;
+  /**
+   * Whether the registry holds an authorised member record for the party. Absent when not reachable.
+   */
+  member?: boolean;
+  /**
+   * Whether the registry holds an authorised listed record for the party. Absent when not reachable.
+   */
+  listed?: boolean;
+  /**
+   * The registry's answer document, verbatim and signed by the registry.
+   */
+  answer?: {};
+  /**
+   * Why the registry could not be asked, when not reachable.
+   */
+  reason?: string;
+  ext?: Ext;
+}
+export interface Actions {
+  /**
+   * The action acknowledged members are published under.
+   */
+  member: string;
+  /**
+   * The action listed parties are published under, where the network publishes them.
+   */
+  listed: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Did, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtn/registry/check/0.1" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTNRegistryCheckPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtn/registry/check/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNRegistryCheckResponsePayload;
+
+/**
+ * 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/vtn/registry/check/0.1",
+  "title": "VTN Registry — Check — payload",
+  "description": "Ask the network to ask its trust registry about one party. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "did"
+  ],
+  "properties": {
+    "did": {
+      "$ref": "#/$defs/Did",
+      "description": "The party asked about."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Actions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "member",
+        "listed"
+      ],
+      "properties": {
+        "member": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The action acknowledged members are published under."
+        },
+        "listed": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The action listed parties are published under, where the network publishes them."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTN Registry — Check — response payload",
+      "description": "What the registry answered, and its own answer document.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "registry",
+        "authority",
+        "resource",
+        "actions",
+        "did",
+        "reachable"
+      ],
+      "properties": {
+        "registry": {
+          "$ref": "#/$defs/Did",
+          "description": "The trust registry asked."
+        },
+        "authority": {
+          "$ref": "#/$defs/Did",
+          "description": "The network's DID: the authority of its records."
+        },
+        "resource": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The TRQP resource the network's records are published under."
+        },
+        "actions": {
+          "$ref": "#/$defs/Actions"
+        },
+        "did": {
+          "$ref": "#/$defs/Did",
+          "description": "The party asked about."
+        },
+        "reachable": {
+          "type": "boolean",
+          "description": "Whether the registry answered. `false` is indeterminate, never \"not a member\"."
+        },
+        "member": {
+          "type": "boolean",
+          "description": "Whether the registry holds an authorised member record for the party. Absent when not reachable."
+        },
+        "listed": {
+          "type": "boolean",
+          "description": "Whether the registry holds an authorised listed record for the party. Absent when not reachable."
+        },
+        "answer": {
+          "type": "object",
+          "description": "The registry's answer document, verbatim and signed by the registry."
+        },
+        "reason": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Why the registry could not be asked, when not reachable."
+        },
+        "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-]+)+$"
+      }
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    }
+  }
+} 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": {
+    "Actions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "member",
+        "listed"
+      ],
+      "properties": {
+        "member": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The action acknowledged members are published under."
+        },
+        "listed": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The action listed parties are published under, where the network publishes them."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTN Registry — Check — response payload",
+      "description": "What the registry answered, and its own answer document.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "registry",
+        "authority",
+        "resource",
+        "actions",
+        "did",
+        "reachable"
+      ],
+      "properties": {
+        "registry": {
+          "$ref": "#/$defs/Did",
+          "description": "The trust registry asked."
+        },
+        "authority": {
+          "$ref": "#/$defs/Did",
+          "description": "The network's DID: the authority of its records."
+        },
+        "resource": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The TRQP resource the network's records are published under."
+        },
+        "actions": {
+          "$ref": "#/$defs/Actions"
+        },
+        "did": {
+          "$ref": "#/$defs/Did",
+          "description": "The party asked about."
+        },
+        "reachable": {
+          "type": "boolean",
+          "description": "Whether the registry answered. `false` is indeterminate, never \"not a member\"."
+        },
+        "member": {
+          "type": "boolean",
+          "description": "Whether the registry holds an authorised member record for the party. Absent when not reachable."
+        },
+        "listed": {
+          "type": "boolean",
+          "description": "Whether the registry holds an authorised listed record for the party. Absent when not reachable."
+        },
+        "answer": {
+          "type": "object",
+          "description": "The registry's answer document, verbatim and signed by the registry."
+        },
+        "reason": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Why the registry could not be asked, when not reachable."
+        },
+        "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-]+)+$"
+      }
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    }
+  }
+} 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: false,
+  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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;