@openvtc/trust-tasks 0.28.16 → 0.28.18

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

@@ -0,0 +1,483 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/networks/preview/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Read a network before joining it: what it says about itself, the roles it requires a group for, and whether it lists the community. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCNetworksPreviewPayload {
+  /**
+   * The network's API base, as the network's administrators gave it.
+   */
+  url: string;
+  /**
+   * The DID the administrator expects at `url`. When present, the community refuses if the network found there answers as another DID.
+   */
+  network?: string;
+  ext?: Ext;
+}
+/**
+ * The network, as the community found it at `url`, and where the community stands with it.
+ */
+export interface VTCNetworksPreviewResponsePayload {
+  /**
+   * The DID the network at `url` answers as.
+   */
+  network: string;
+  /**
+   * The URL the network was read at.
+   */
+  url: string;
+  /**
+   * The network's name, from its profile.
+   */
+  name: string;
+  /**
+   * The network's description, from its profile.
+   */
+  description?: string;
+  /**
+   * The network's identified owner (VTI-VTN-002), from its profile.
+   */
+  owner?: string;
+  framework?: Framework;
+  /**
+   * The roles the network asks members to register a group for. `vtc/networks/join` must assign a group to each one marked `required`.
+   *
+   * @maxItems 64
+   */
+  roles: Role[];
+  /**
+   * `true` only when the network holds an entry for the community whose listing verifies as the network's and lists the community as a community.
+   */
+  listed: boolean;
+  /**
+   * The network's state for the community's entry, when it holds a published one: `listed` (not yet acknowledged), `acknowledged` (a member), `repudiated` (the community rejected the listing) or `suspended`.
+   */
+  entryState?: "listed" | "acknowledged" | "repudiated" | "suspended";
+  /**
+   * Why `listed` is `false`, in words for an administrator.
+   */
+  notListedReason?: string;
+  /**
+   * The community's own record of the membership, when it holds one (`vtc/networks/show`).
+   */
+  membershipState?: "acknowledged" | "repudiated" | "departed";
+  ext?: Ext;
+}
+export interface Framework {
+  /**
+   * The network's governance framework.
+   */
+  iri: string;
+  /**
+   * The framework version the network operates under.
+   */
+  version: string;
+}
+export interface Role {
+  /**
+   * The role's name, as `vtc/networks/join` assigns a group to it.
+   */
+  name: string;
+  /**
+   * Whether the network admits a member only once a group is registered for this role.
+   */
+  required: boolean;
+  /**
+   * What the network uses the role for.
+   */
+  description?: string;
+}
+
+/** 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/preview/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 = VTCNetworksPreviewPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/networks/preview/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCNetworksPreviewResponsePayload;
+
+/**
+ * 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/preview/0.1",
+  "title": "VTC Networks — Preview — payload",
+  "description": "Read a network before joining it: what it says about itself, the roles it requires a group for, and whether it lists the community. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "url"
+  ],
+  "properties": {
+    "url": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 2048,
+      "description": "The network's API base, as the network's administrators gave it."
+    },
+    "network": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "The DID the administrator expects at `url`. When present, the community refuses if the network found there answers as another DID."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Role": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "required"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "The role's name, as `vtc/networks/join` assigns a group to it."
+        },
+        "required": {
+          "type": "boolean",
+          "description": "Whether the network admits a member only once a group is registered for this role."
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "What the network uses the role for."
+        }
+      }
+    },
+    "Framework": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "iri",
+        "version"
+      ],
+      "properties": {
+        "iri": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "The network's governance framework."
+        },
+        "version": {
+          "type": "string",
+          "maxLength": 64,
+          "description": "The framework version the network operates under."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Networks — Preview — response payload",
+      "description": "The network, as the community found it at `url`, and where the community stands with it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "network",
+        "url",
+        "name",
+        "roles",
+        "listed"
+      ],
+      "properties": {
+        "network": {
+          "type": "string",
+          "pattern": "^did:[a-z0-9]+:.+$",
+          "maxLength": 2048,
+          "description": "The DID the network at `url` answers as."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "The URL the network was read at."
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 256,
+          "description": "The network's name, from its profile."
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 4096,
+          "description": "The network's description, from its profile."
+        },
+        "owner": {
+          "type": "string",
+          "maxLength": 512,
+          "description": "The network's identified owner (VTI-VTN-002), from its profile."
+        },
+        "framework": {
+          "$ref": "#/$defs/Framework"
+        },
+        "roles": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "$ref": "#/$defs/Role"
+          },
+          "description": "The roles the network asks members to register a group for. `vtc/networks/join` must assign a group to each one marked `required`."
+        },
+        "listed": {
+          "type": "boolean",
+          "description": "`true` only when the network holds an entry for the community whose listing verifies as the network's and lists the community as a community."
+        },
+        "entryState": {
+          "type": "string",
+          "enum": [
+            "listed",
+            "acknowledged",
+            "repudiated",
+            "suspended"
+          ],
+          "description": "The network's state for the community's entry, when it holds a published one: `listed` (not yet acknowledged), `acknowledged` (a member), `repudiated` (the community rejected the listing) or `suspended`."
+        },
+        "notListedReason": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Why `listed` is `false`, in words for an administrator."
+        },
+        "membershipState": {
+          "type": "string",
+          "enum": [
+            "acknowledged",
+            "repudiated",
+            "departed"
+          ],
+          "description": "The community's own record of the membership, when it holds one (`vtc/networks/show`)."
+        },
+        "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": {
+    "Role": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "required"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "The role's name, as `vtc/networks/join` assigns a group to it."
+        },
+        "required": {
+          "type": "boolean",
+          "description": "Whether the network admits a member only once a group is registered for this role."
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "What the network uses the role for."
+        }
+      }
+    },
+    "Framework": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "iri",
+        "version"
+      ],
+      "properties": {
+        "iri": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "The network's governance framework."
+        },
+        "version": {
+          "type": "string",
+          "maxLength": 64,
+          "description": "The framework version the network operates under."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Networks — Preview — response payload",
+      "description": "The network, as the community found it at `url`, and where the community stands with it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "network",
+        "url",
+        "name",
+        "roles",
+        "listed"
+      ],
+      "properties": {
+        "network": {
+          "type": "string",
+          "pattern": "^did:[a-z0-9]+:.+$",
+          "maxLength": 2048,
+          "description": "The DID the network at `url` answers as."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "The URL the network was read at."
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 256,
+          "description": "The network's name, from its profile."
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 4096,
+          "description": "The network's description, from its profile."
+        },
+        "owner": {
+          "type": "string",
+          "maxLength": 512,
+          "description": "The network's identified owner (VTI-VTN-002), from its profile."
+        },
+        "framework": {
+          "$ref": "#/$defs/Framework"
+        },
+        "roles": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "$ref": "#/$defs/Role"
+          },
+          "description": "The roles the network asks members to register a group for. `vtc/networks/join` must assign a group to each one marked `required`."
+        },
+        "listed": {
+          "type": "boolean",
+          "description": "`true` only when the network holds an entry for the community whose listing verifies as the network's and lists the community as a community."
+        },
+        "entryState": {
+          "type": "string",
+          "enum": [
+            "listed",
+            "acknowledged",
+            "repudiated",
+            "suspended"
+          ],
+          "description": "The network's state for the community's entry, when it holds a published one: `listed` (not yet acknowledged), `acknowledged` (a member), `repudiated` (the community rejected the listing) or `suspended`."
+        },
+        "notListedReason": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Why `listed` is `false`, in words for an administrator."
+        },
+        "membershipState": {
+          "type": "string",
+          "enum": [
+            "acknowledged",
+            "repudiated",
+            "departed"
+          ],
+          "description": "The community's own record of the membership, when it holds one (`vtc/networks/show`)."
+        },
+        "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;