@openvtc/trust-tasks 0.28.7 → 0.28.9

package/src/vtc/networks/evidence/0.1/payload.ts

@@ -0,0 +1,290 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/networks/evidence/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Ask for the credentials linking a group the caller belongs to up to a network. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCNetworksEvidencePayload {
+  /**
+   * Only links for this group. Absent: every group the caller is an active member of.
+   */
+  groupId?: string;
+  /**
+   * Only links to this network.
+   */
+  network?: string;
+  ext?: Ext;
+}
+/**
+ * The chain links the caller may present, one per group and network.
+ */
+export interface VTCNetworksEvidenceResponsePayload {
+  /**
+   * @maxItems 64
+   */
+  links: {
+    groupId: string;
+    groupDid: string;
+    network: string;
+    role: string;
+    /**
+     * The community's `servesRole` statement for the group.
+     */
+    registration: {};
+    /**
+     * The network's `groupRegistered` statement for it.
+     */
+    acceptance: {};
+  }[];
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/networks/evidence/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 = VTCNetworksEvidencePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/networks/evidence/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCNetworksEvidenceResponsePayload;
+
+/**
+ * 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/vtc/networks/evidence/0.1",
+  "title": "VTC Networks — Evidence — payload",
+  "description": "Ask for the credentials linking a group the caller belongs to up to a network. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "groupId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Only links for this group. Absent: every group the caller is an active member of."
+    },
+    "network": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "Only links to this network."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Networks — Evidence — response payload",
+      "description": "The chain links the caller may present, one per group and network.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "links"
+      ],
+      "properties": {
+        "links": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "groupId",
+              "groupDid",
+              "network",
+              "role",
+              "registration",
+              "acceptance"
+            ],
+            "properties": {
+              "groupId": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128
+              },
+              "groupDid": {
+                "type": "string",
+                "pattern": "^did:[a-z0-9]+:.+$",
+                "maxLength": 2048
+              },
+              "network": {
+                "type": "string",
+                "pattern": "^did:[a-z0-9]+:.+$",
+                "maxLength": 2048
+              },
+              "role": {
+                "type": "string",
+                "pattern": "^[a-z0-9_-]{1,64}$"
+              },
+              "registration": {
+                "type": "object",
+                "description": "The community's `servesRole` statement for the group."
+              },
+              "acceptance": {
+                "type": "object",
+                "description": "The network's `groupRegistered` statement for it."
+              }
+            }
+          }
+        },
+        "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": "VTC Networks — Evidence — response payload",
+      "description": "The chain links the caller may present, one per group and network.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "links"
+      ],
+      "properties": {
+        "links": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "groupId",
+              "groupDid",
+              "network",
+              "role",
+              "registration",
+              "acceptance"
+            ],
+            "properties": {
+              "groupId": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128
+              },
+              "groupDid": {
+                "type": "string",
+                "pattern": "^did:[a-z0-9]+:.+$",
+                "maxLength": 2048
+              },
+              "network": {
+                "type": "string",
+                "pattern": "^did:[a-z0-9]+:.+$",
+                "maxLength": 2048
+              },
+              "role": {
+                "type": "string",
+                "pattern": "^[a-z0-9_-]{1,64}$"
+              },
+              "registration": {
+                "type": "object",
+                "description": "The community's `servesRole` statement for the group."
+              },
+              "acceptance": {
+                "type": "object",
+                "description": "The network's `groupRegistered` statement for it."
+              }
+            }
+          }
+        },
+        "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,
+  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;