@openvtc/trust-tasks 0.12.13 → 0.12.14

package/src/vtc/relationships/graph/0.2/payload.ts

@@ -0,0 +1,413 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/relationships/graph/0.2/payload.schema.json
+ */
+
+export interface VTCRelationshipsGraphPayload {
+  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;
+}
+export interface VTCRelationshipsGraphResponsePayload {
+  /**
+   * One per distinct DID appearing in a live edge. No isolated nodes.
+   */
+  nodes: GraphNode[];
+  /**
+   * One per **pair** of identifiers with at least one live credential between them, not one per credential.
+   */
+  edges: GraphEdge[];
+  ext?: Ext;
+}
+export interface GraphNode {
+  /**
+   * A DID participating in at least one live relationship.
+   */
+  did: string;
+}
+/**
+ * One edge between a **pair** of identifiers, carrying every half published between them.
+ *
+ * `0.1` called each credential an edge, which made a DTG edge inexpressible: the two directed halves between the same pair are one relationship, and a consumer given a flat list had to re-derive that pairing — sorting DIDs, grouping, and deciding for itself what `complete` means. Two implementations doing that independently will disagree at the margins, which is exactly the reasoning a schema exists to settle once.
+ */
+export interface GraphEdge {
+  /**
+   * The two endpoints, DID-sorted. Sorting gives the pair one identity whichever half was published first. Both entries are equal only for a self-issued credential.
+   *
+   * @minItems 2
+   * @maxItems 2
+   */
+  endpoints: [string, string];
+  /**
+   * Every credential published between the endpoints, oldest first. One for a half-edge, two for the ordinary reciprocated edge, more where a party has re-issued.
+   *
+   * @minItems 1
+   */
+  halves: [GraphHalf, ...GraphHalf[]];
+  /**
+   * True when both endpoints have asserted about each other. The distinction a flat list cannot make: an edge asserted by one party is a claim, and an edge asserted by both is a relationship.
+   */
+  complete: boolean;
+}
+/**
+ * One published relationship credential: a **directed half** of an edge, asserted by `issuerDid` about `subjectDid`.
+ *
+ * Body-free on purpose — the graph shows the shape of the trust network, not credential contents. `id` is the row identifier a revoke takes.
+ */
+export interface GraphHalf {
+  id: string;
+  /**
+   * The asserting party.
+   */
+  issuerDid: string;
+  /**
+   * The party asserted about.
+   */
+  subjectDid: string;
+  createdAt: string;
+  /**
+   * The persona this issuer has asserted on this half, when they have.
+   *
+   * The one place deliberate correlation becomes visible: two pairwise halves carrying the same `personaDid` are the same party, said so by that party. A consumer that cannot read it cannot honour a correlation its subject chose to publish.
+   */
+  personaDid?: string | null;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/relationships/graph/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRelationshipsGraphPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/relationships/graph/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRelationshipsGraphResponsePayload;
+
+/**
+ * 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/relationships/graph/0.2",
+  "title": "VTC Relationships Graph — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Relationships Graph — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "nodes",
+        "edges"
+      ],
+      "properties": {
+        "nodes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/GraphNode"
+          },
+          "description": "One per distinct DID appearing in a live edge. No isolated nodes."
+        },
+        "edges": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/GraphEdge"
+          },
+          "description": "One per **pair** of identifiers with at least one live credential between them, not one per credential."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "GraphNode": {
+      "$anchor": "graphNode",
+      "title": "GraphNode",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did"
+      ],
+      "properties": {
+        "did": {
+          "type": "string",
+          "minLength": 1,
+          "description": "A DID participating in at least one live relationship."
+        }
+      }
+    },
+    "GraphEdge": {
+      "$anchor": "graphEdge",
+      "title": "GraphEdge",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "endpoints",
+        "halves",
+        "complete"
+      ],
+      "properties": {
+        "endpoints": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^did:"
+          },
+          "minItems": 2,
+          "maxItems": 2,
+          "description": "The two endpoints, DID-sorted. Sorting gives the pair one identity whichever half was published first. Both entries are equal only for a self-issued credential."
+        },
+        "halves": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/GraphHalf"
+          },
+          "minItems": 1,
+          "description": "Every credential published between the endpoints, oldest first. One for a half-edge, two for the ordinary reciprocated edge, more where a party has re-issued."
+        },
+        "complete": {
+          "type": "boolean",
+          "description": "True when both endpoints have asserted about each other. The distinction a flat list cannot make: an edge asserted by one party is a claim, and an edge asserted by both is a relationship."
+        }
+      },
+      "description": "One edge between a **pair** of identifiers, carrying every half published between them.\n\n`0.1` called each credential an edge, which made a DTG edge inexpressible: the two directed halves between the same pair are one relationship, and a consumer given a flat list had to re-derive that pairing — sorting DIDs, grouping, and deciding for itself what `complete` means. Two implementations doing that independently will disagree at the margins, which is exactly the reasoning a schema exists to settle once."
+    },
+    "GraphHalf": {
+      "$anchor": "graphHalf",
+      "title": "GraphHalf",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "One published relationship credential: a **directed half** of an edge, asserted by `issuerDid` about `subjectDid`.\n\nBody-free on purpose — the graph shows the shape of the trust network, not credential contents. `id` is the row identifier a revoke takes.",
+      "required": [
+        "id",
+        "issuerDid",
+        "subjectDid",
+        "createdAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "issuerDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "description": "The asserting party."
+        },
+        "subjectDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "description": "The party asserted about."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "personaDid": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^did:|^$",
+          "description": "The persona this issuer has asserted on this half, when they have.\n\nThe one place deliberate correlation becomes visible: two pairwise halves carrying the same `personaDid` are the same party, said so by that party. A consumer that cannot read it cannot honour a correlation its subject chose to publish."
+        }
+      }
+    },
+    "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 Relationships Graph — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "nodes",
+        "edges"
+      ],
+      "properties": {
+        "nodes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/GraphNode"
+          },
+          "description": "One per distinct DID appearing in a live edge. No isolated nodes."
+        },
+        "edges": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/GraphEdge"
+          },
+          "description": "One per **pair** of identifiers with at least one live credential between them, not one per credential."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "GraphNode": {
+      "$anchor": "graphNode",
+      "title": "GraphNode",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did"
+      ],
+      "properties": {
+        "did": {
+          "type": "string",
+          "minLength": 1,
+          "description": "A DID participating in at least one live relationship."
+        }
+      }
+    },
+    "GraphEdge": {
+      "$anchor": "graphEdge",
+      "title": "GraphEdge",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "endpoints",
+        "halves",
+        "complete"
+      ],
+      "properties": {
+        "endpoints": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^did:"
+          },
+          "minItems": 2,
+          "maxItems": 2,
+          "description": "The two endpoints, DID-sorted. Sorting gives the pair one identity whichever half was published first. Both entries are equal only for a self-issued credential."
+        },
+        "halves": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/GraphHalf"
+          },
+          "minItems": 1,
+          "description": "Every credential published between the endpoints, oldest first. One for a half-edge, two for the ordinary reciprocated edge, more where a party has re-issued."
+        },
+        "complete": {
+          "type": "boolean",
+          "description": "True when both endpoints have asserted about each other. The distinction a flat list cannot make: an edge asserted by one party is a claim, and an edge asserted by both is a relationship."
+        }
+      },
+      "description": "One edge between a **pair** of identifiers, carrying every half published between them.\n\n`0.1` called each credential an edge, which made a DTG edge inexpressible: the two directed halves between the same pair are one relationship, and a consumer given a flat list had to re-derive that pairing — sorting DIDs, grouping, and deciding for itself what `complete` means. Two implementations doing that independently will disagree at the margins, which is exactly the reasoning a schema exists to settle once."
+    },
+    "GraphHalf": {
+      "$anchor": "graphHalf",
+      "title": "GraphHalf",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "One published relationship credential: a **directed half** of an edge, asserted by `issuerDid` about `subjectDid`.\n\nBody-free on purpose — the graph shows the shape of the trust network, not credential contents. `id` is the row identifier a revoke takes.",
+      "required": [
+        "id",
+        "issuerDid",
+        "subjectDid",
+        "createdAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "issuerDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "description": "The asserting party."
+        },
+        "subjectDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "description": "The party asserted about."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "personaDid": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^did:|^$",
+          "description": "The persona this issuer has asserted on this half, when they have.\n\nThe one place deliberate correlation becomes visible: two pairwise halves carrying the same `personaDid` are the same party, said so by that party. A consumer that cannot read it cannot honour a correlation its subject chose to publish."
+        }
+      }
+    },
+    "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: false,
+  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: false,
+  isRecipientRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;