@openvtc/trust-tasks 0.28.10 → 0.28.11

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

@@ -0,0 +1,439 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/entries/show/0.1/payload.schema.json
+ */
+
+import type { Credential, Description, Did_VtnV0_1 as Did, EntryKind, EntryProfile, EntryState, Ext, IndexEntry, Membership, Tags, Url } from "../../../../_shared/components.js";
+
+
+/**
+ * A request for one listed party's published entry. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNEntriesShowPayload {
+  /**
+   * The DID of the listed party whose entry is asked for.
+   */
+  did: Did;
+  /**
+   * The requester's membership credential from a member community, where the network's directory admits members only and nothing else admits the requester.
+   */
+  membership?: Membership;
+  ext?: Ext;
+}
+/**
+ * The party's entry as the network publishes it.
+ */
+export interface VTNEntriesShowResponsePayload {
+  entry: IndexEntry;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Credential, Description, Did, EntryKind, EntryProfile, EntryState, Ext, IndexEntry, Membership, Tags, Url };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtn/entries/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 = VTNEntriesShowPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtn/entries/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNEntriesShowResponsePayload;
+
+/**
+ * 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/entries/show/0.1",
+  "title": "VTN Entries — Show — payload",
+  "description": "A request for one listed party's published entry. 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 DID of the listed party whose entry is asked for."
+    },
+    "membership": {
+      "$ref": "#/$defs/Membership",
+      "description": "The requester's membership credential from a member community, where the network's directory admits members only and nothing else admits the requester."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTN Entries — Show — response payload",
+      "description": "The party's entry as the network publishes it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entry"
+      ],
+      "properties": {
+        "entry": {
+          "$ref": "#/$defs/IndexEntry"
+        },
+        "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-]+)+$"
+      }
+    },
+    "IndexEntry": {
+      "description": "An entry as the network publishes it, with the credentials a verifier needs.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "kind",
+        "state",
+        "acknowledged",
+        "profile",
+        "listing"
+      ],
+      "properties": {
+        "did": {
+          "$ref": "#/$defs/Did",
+          "description": "The listed party's DID."
+        },
+        "kind": {
+          "$ref": "#/$defs/EntryKind"
+        },
+        "state": {
+          "$ref": "#/$defs/EntryState"
+        },
+        "acknowledged": {
+          "type": "boolean",
+          "description": "Whether the party acknowledged: true only for a member. Every published entry states it (VTI-VTN-013)."
+        },
+        "label": {
+          "type": "string",
+          "maxLength": 200,
+          "description": "The name the directory shows."
+        },
+        "profile": {
+          "$ref": "#/$defs/EntryProfile"
+        },
+        "listing": {
+          "$ref": "#/$defs/Credential",
+          "description": "The listing credential."
+        },
+        "grant": {
+          "$ref": "#/$defs/Credential",
+          "description": "The membership grant, once acknowledged."
+        },
+        "acknowledgement": {
+          "$ref": "#/$defs/Credential",
+          "description": "The party's acknowledgement."
+        },
+        "repudiation": {
+          "$ref": "#/$defs/Credential",
+          "description": "The party's repudiation."
+        }
+      }
+    },
+    "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."
+    },
+    "EntryProfile": {
+      "description": "What the directory shows about an entry, set by the network's administrators.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [],
+      "properties": {
+        "description": {
+          "$ref": "#/$defs/Description"
+        },
+        "url": {
+          "$ref": "#/$defs/Url"
+        },
+        "tags": {
+          "$ref": "#/$defs/Tags"
+        }
+      }
+    },
+    "Tags": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 64
+      },
+      "description": "Free-text tags the directory searches.",
+      "maxItems": 32
+    },
+    "Url": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 2048,
+      "description": "The party's public address."
+    },
+    "Description": {
+      "type": "string",
+      "maxLength": 2000,
+      "description": "What the listed party is, for the directory."
+    },
+    "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."
+    },
+    "EntryKind": {
+      "type": "string",
+      "enum": [
+        "community",
+        "network"
+      ],
+      "description": "What the entry lists (VTI-VTN-031): a community, whose entries are its members, or a network, whose entries are further listings. A listing credential carries the same fact as `nodeType` `VTC` or `VTN`."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    },
+    "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 Entries — Show — response payload",
+      "description": "The party's entry as the network publishes it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entry"
+      ],
+      "properties": {
+        "entry": {
+          "$ref": "#/$defs/IndexEntry"
+        },
+        "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-]+)+$"
+      }
+    },
+    "IndexEntry": {
+      "description": "An entry as the network publishes it, with the credentials a verifier needs.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "kind",
+        "state",
+        "acknowledged",
+        "profile",
+        "listing"
+      ],
+      "properties": {
+        "did": {
+          "$ref": "#/$defs/Did",
+          "description": "The listed party's DID."
+        },
+        "kind": {
+          "$ref": "#/$defs/EntryKind"
+        },
+        "state": {
+          "$ref": "#/$defs/EntryState"
+        },
+        "acknowledged": {
+          "type": "boolean",
+          "description": "Whether the party acknowledged: true only for a member. Every published entry states it (VTI-VTN-013)."
+        },
+        "label": {
+          "type": "string",
+          "maxLength": 200,
+          "description": "The name the directory shows."
+        },
+        "profile": {
+          "$ref": "#/$defs/EntryProfile"
+        },
+        "listing": {
+          "$ref": "#/$defs/Credential",
+          "description": "The listing credential."
+        },
+        "grant": {
+          "$ref": "#/$defs/Credential",
+          "description": "The membership grant, once acknowledged."
+        },
+        "acknowledgement": {
+          "$ref": "#/$defs/Credential",
+          "description": "The party's acknowledgement."
+        },
+        "repudiation": {
+          "$ref": "#/$defs/Credential",
+          "description": "The party's repudiation."
+        }
+      }
+    },
+    "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."
+    },
+    "EntryProfile": {
+      "description": "What the directory shows about an entry, set by the network's administrators.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [],
+      "properties": {
+        "description": {
+          "$ref": "#/$defs/Description"
+        },
+        "url": {
+          "$ref": "#/$defs/Url"
+        },
+        "tags": {
+          "$ref": "#/$defs/Tags"
+        }
+      }
+    },
+    "Tags": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 64
+      },
+      "description": "Free-text tags the directory searches.",
+      "maxItems": 32
+    },
+    "Url": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 2048,
+      "description": "The party's public address."
+    },
+    "Description": {
+      "type": "string",
+      "maxLength": 2000,
+      "description": "What the listed party is, for the directory."
+    },
+    "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."
+    },
+    "EntryKind": {
+      "type": "string",
+      "enum": [
+        "community",
+        "network"
+      ],
+      "description": "What the entry lists (VTI-VTN-031): a community, whose entries are its members, or a network, whose entries are further listings. A listing credential carries the same fact as `nodeType` `VTC` or `VTN`."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    },
+    "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: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;