@openvtc/trust-tasks 0.28.10 → 0.28.12

package/src/vtn/graph/show/0.1/payload.ts

@@ -0,0 +1,509 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/graph/show/0.1/payload.schema.json
+ */
+
+import type { Credential, Did_VtnV0_1 as Did, Edge, EdgeRole, EdgeStatus, EntryState, Ext, Graph, Membership, Node, NodeKind } from "../../../../_shared/components.js";
+
+
+/**
+ * A request for the network's trust graph. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNGraphShowPayload {
+  /**
+   * Also show removed and departed entries. For administrators only; absent means false.
+   */
+  includeExited?: boolean;
+  /**
+   * A person's membership credential from a member community, holder-bound to the signer; admits the person to a `members` directory.
+   */
+  membership?: Membership;
+  ext?: Ext;
+}
+/**
+ * The network's trust graph.
+ */
+export interface VTNGraphShowResponsePayload {
+  graph: Graph;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Credential, Did, Edge, EdgeRole, EdgeStatus, EntryState, Ext, Graph, Membership, Node, NodeKind };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtn/graph/show/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 = VTNGraphShowPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtn/graph/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNGraphShowResponsePayload;
+
+/**
+ * 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/graph/show/0.1",
+  "title": "VTN Graph — Show — payload",
+  "description": "A request for the network's trust graph. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [],
+  "properties": {
+    "includeExited": {
+      "type": "boolean",
+      "description": "Also show removed and departed entries. For administrators only; absent means false."
+    },
+    "membership": {
+      "$ref": "#/$defs/Membership",
+      "description": "A person's membership credential from a member community, holder-bound to the signer; admits the person to a `members` directory."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTN Graph — Show — response payload",
+      "description": "The network's trust graph.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "graph"
+      ],
+      "properties": {
+        "graph": {
+          "$ref": "#/$defs/Graph"
+        },
+        "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-]+)+$"
+      }
+    },
+    "Graph": {
+      "description": "The graph.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "nodes",
+        "edges"
+      ],
+      "properties": {
+        "nodes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Node"
+          },
+          "description": "The parties."
+        },
+        "edges": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Edge"
+          },
+          "description": "The credentials."
+        }
+      }
+    },
+    "Edge": {
+      "description": "One credential, from issuer to subject. A membership is two edges: the grant and the acknowledgement.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "source",
+        "target",
+        "role",
+        "credType",
+        "status",
+        "credential"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "The credential's `id`."
+        },
+        "source": {
+          "$ref": "#/$defs/Did",
+          "description": "The issuer."
+        },
+        "target": {
+          "$ref": "#/$defs/Did",
+          "description": "The subject."
+        },
+        "role": {
+          "$ref": "#/$defs/EdgeRole"
+        },
+        "credType": {
+          "type": "string",
+          "maxLength": 100,
+          "description": "The credential's DTG type, e.g. `MembershipCredential`."
+        },
+        "status": {
+          "$ref": "#/$defs/EdgeStatus"
+        },
+        "credential": {
+          "$ref": "#/$defs/Credential",
+          "description": "The credential itself."
+        }
+      }
+    },
+    "EdgeStatus": {
+      "type": "string",
+      "enum": [
+        "valid",
+        "suspended",
+        "revoked",
+        "unchecked"
+      ],
+      "description": "The credential's status as far as this network can determine it. `unchecked` is a credential whose status list this network does not hold."
+    },
+    "EdgeRole": {
+      "type": "string",
+      "enum": [
+        "listing",
+        "grant",
+        "acknowledgement",
+        "repudiation"
+      ],
+      "description": "Which credential an edge is."
+    },
+    "Credential": {
+      "type": "object",
+      "description": "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    },
+    "Node": {
+      "description": "A party.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "kind",
+        "root"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/Did",
+          "description": "The party's DID."
+        },
+        "kind": {
+          "$ref": "#/$defs/NodeKind"
+        },
+        "label": {
+          "type": "string",
+          "maxLength": 200,
+          "description": "Its name."
+        },
+        "state": {
+          "$ref": "#/$defs/EntryState",
+          "description": "Its entry's state; absent for the root."
+        },
+        "root": {
+          "type": "boolean",
+          "description": "Whether this is the network whose graph it is."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Where a member network is reached, so a viewer can expand it."
+        }
+      }
+    },
+    "NodeKind": {
+      "type": "string",
+      "enum": [
+        "network",
+        "community"
+      ],
+      "description": "What a node is."
+    },
+    "EntryState": {
+      "type": "string",
+      "enum": [
+        "listed",
+        "acknowledged",
+        "repudiated",
+        "suspended",
+        "removed",
+        "departed"
+      ],
+      "description": "`listed`: the network lists the party and the party has not answered; this is never membership (VTI-VTN-013). `acknowledged`: the party acknowledged the network's grant; it is a member. `repudiated`: the party rejected the listing. `suspended`: the network suspended the membership; reversible. `removed`: the network ended the entry. `departed`: the party left, by repudiating the grant."
+    },
+    "Membership": {
+      "type": "object",
+      "description": "A person's membership credential (VMC) from a community that is a member of this network, holder-bound to the requester's identity. Open for the same reason as `Credential`."
+    }
+  }
+} 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": "VTN Graph — Show — response payload",
+      "description": "The network's trust graph.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "graph"
+      ],
+      "properties": {
+        "graph": {
+          "$ref": "#/$defs/Graph"
+        },
+        "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-]+)+$"
+      }
+    },
+    "Graph": {
+      "description": "The graph.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "nodes",
+        "edges"
+      ],
+      "properties": {
+        "nodes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Node"
+          },
+          "description": "The parties."
+        },
+        "edges": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Edge"
+          },
+          "description": "The credentials."
+        }
+      }
+    },
+    "Edge": {
+      "description": "One credential, from issuer to subject. A membership is two edges: the grant and the acknowledgement.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "source",
+        "target",
+        "role",
+        "credType",
+        "status",
+        "credential"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "The credential's `id`."
+        },
+        "source": {
+          "$ref": "#/$defs/Did",
+          "description": "The issuer."
+        },
+        "target": {
+          "$ref": "#/$defs/Did",
+          "description": "The subject."
+        },
+        "role": {
+          "$ref": "#/$defs/EdgeRole"
+        },
+        "credType": {
+          "type": "string",
+          "maxLength": 100,
+          "description": "The credential's DTG type, e.g. `MembershipCredential`."
+        },
+        "status": {
+          "$ref": "#/$defs/EdgeStatus"
+        },
+        "credential": {
+          "$ref": "#/$defs/Credential",
+          "description": "The credential itself."
+        }
+      }
+    },
+    "EdgeStatus": {
+      "type": "string",
+      "enum": [
+        "valid",
+        "suspended",
+        "revoked",
+        "unchecked"
+      ],
+      "description": "The credential's status as far as this network can determine it. `unchecked` is a credential whose status list this network does not hold."
+    },
+    "EdgeRole": {
+      "type": "string",
+      "enum": [
+        "listing",
+        "grant",
+        "acknowledgement",
+        "repudiation"
+      ],
+      "description": "Which credential an edge is."
+    },
+    "Credential": {
+      "type": "object",
+      "description": "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    },
+    "Node": {
+      "description": "A party.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "kind",
+        "root"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/Did",
+          "description": "The party's DID."
+        },
+        "kind": {
+          "$ref": "#/$defs/NodeKind"
+        },
+        "label": {
+          "type": "string",
+          "maxLength": 200,
+          "description": "Its name."
+        },
+        "state": {
+          "$ref": "#/$defs/EntryState",
+          "description": "Its entry's state; absent for the root."
+        },
+        "root": {
+          "type": "boolean",
+          "description": "Whether this is the network whose graph it is."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Where a member network is reached, so a viewer can expand it."
+        }
+      }
+    },
+    "NodeKind": {
+      "type": "string",
+      "enum": [
+        "network",
+        "community"
+      ],
+      "description": "What a node is."
+    },
+    "EntryState": {
+      "type": "string",
+      "enum": [
+        "listed",
+        "acknowledged",
+        "repudiated",
+        "suspended",
+        "removed",
+        "departed"
+      ],
+      "description": "`listed`: the network lists the party and the party has not answered; this is never membership (VTI-VTN-013). `acknowledged`: the party acknowledged the network's grant; it is a member. `repudiated`: the party rejected the listing. `suspended`: the network suspended the membership; reversible. `removed`: the network ended the entry. `departed`: the party left, by repudiating the grant."
+    },
+    "Membership": {
+      "type": "object",
+      "description": "A person's membership credential (VMC) from a community that is a member of this network, holder-bound to the requester's identity. Open for the same reason as `Credential`."
+    }
+  }
+} 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: false,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;