@openvtc/trust-tasks 0.28.8 → 0.28.10

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

@@ -0,0 +1,492 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/networks/join/0.1/payload.schema.json
+ */
+
+import type { Ext, NetworkMembership, RegisteredGroup, RoleAssignment } from "../../../../_shared/components.js";
+
+
+/**
+ * Accept a network's listing of the community: register groups for the network's roles, then acknowledge its membership offer. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCNetworksJoinPayload {
+  /**
+   * The network's API base, as the network's administrators gave it.
+   */
+  url: string;
+  /**
+   * The network's DID. For a request naming a `url`, the community refuses if the network found there answers as another DID.
+   */
+  network: string;
+  /**
+   * The community's groups to serve the network's roles. Every role the network requires must be assigned.
+   *
+   * @maxItems 32
+   */
+  groups?: RoleAssignment[];
+  ext?: Ext;
+}
+/**
+ * The membership as it now stands.
+ */
+export interface VTCNetworksJoinResponsePayload {
+  membership: NetworkMembership;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, NetworkMembership, RegisteredGroup, RoleAssignment };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/networks/join/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 = VTCNetworksJoinPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/networks/join/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCNetworksJoinResponsePayload;
+
+/**
+ * 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/join/0.1",
+  "title": "VTC Networks — Join — payload",
+  "description": "Accept a network's listing of the community: register groups for the network's roles, then acknowledge its membership offer. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "url",
+    "network"
+  ],
+  "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 network's DID. For a request naming a `url`, the community refuses if the network found there answers as another DID."
+    },
+    "groups": {
+      "type": "array",
+      "maxItems": 32,
+      "items": {
+        "$ref": "#/$defs/RoleAssignment"
+      },
+      "description": "The community's groups to serve the network's roles. Every role the network requires must be assigned."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Networks — Join — response payload",
+      "description": "The membership as it now stands.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "membership"
+      ],
+      "properties": {
+        "membership": {
+          "$ref": "#/$defs/NetworkMembership"
+        },
+        "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-]+)+$"
+      }
+    },
+    "NetworkMembership": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "network",
+        "url",
+        "state",
+        "listing",
+        "groups",
+        "updatedAt"
+      ],
+      "properties": {
+        "network": {
+          "type": "string",
+          "pattern": "^did:[a-z0-9]+:.+$",
+          "maxLength": 2048,
+          "description": "The network's DID."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Where the network's API is reached: the base its `/.well-known/vtn` profile is served under."
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 200,
+          "description": "The network's name, as its profile gives it."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "acknowledged",
+            "repudiated",
+            "departed"
+          ],
+          "description": "`acknowledged`: the community is a member — it signed the acknowledgement of the network's grant. `repudiated`: the community rejected the network's listing of it. `departed`: the community left, by repudiating the grant."
+        },
+        "listing": {
+          "type": "object",
+          "description": "The network's listing credential naming the community, as the community verified it."
+        },
+        "grant": {
+          "type": "object",
+          "description": "The network's membership grant (VMC), once the community acknowledged."
+        },
+        "acknowledgement": {
+          "type": "object",
+          "description": "The community's acknowledgement (VMC carrying the grant's digest)."
+        },
+        "repudiation": {
+          "type": "object",
+          "description": "The community's repudiation (VSC) of the listing, or — on departure — of the grant."
+        },
+        "groups": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "$ref": "#/$defs/RegisteredGroup"
+          }
+        },
+        "joinedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "RegisteredGroup": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "role",
+        "groupId",
+        "groupDid",
+        "endpoint",
+        "registration",
+        "acceptance",
+        "registeredAt"
+      ],
+      "properties": {
+        "role": {
+          "type": "string",
+          "pattern": "^[a-z0-9_-]{1,64}$",
+          "description": "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`."
+        },
+        "groupId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The community's identifier for the group."
+        },
+        "groupDid": {
+          "type": "string",
+          "pattern": "^did:[a-z0-9]+:.+$",
+          "maxLength": 2048,
+          "description": "The group's own DID, which the registration names as its subject."
+        },
+        "endpoint": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Where the network delivers broadcasts for the group: the community's relay endpoint for it."
+        },
+        "registration": {
+          "type": "object",
+          "description": "The community's `servesRole` statement (VSC): the group serves `role` in the network."
+        },
+        "acceptance": {
+          "type": "object",
+          "description": "The network's `groupRegistered` statement (VSC), bound to the registration's digest."
+        },
+        "registeredAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "RoleAssignment": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "role",
+        "groupId"
+      ],
+      "properties": {
+        "role": {
+          "type": "string",
+          "pattern": "^[a-z0-9_-]{1,64}$",
+          "description": "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`."
+        },
+        "groupId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The community group to serve the role."
+        }
+      }
+    }
+  }
+} 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 — Join — response payload",
+      "description": "The membership as it now stands.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "membership"
+      ],
+      "properties": {
+        "membership": {
+          "$ref": "#/$defs/NetworkMembership"
+        },
+        "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-]+)+$"
+      }
+    },
+    "NetworkMembership": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "network",
+        "url",
+        "state",
+        "listing",
+        "groups",
+        "updatedAt"
+      ],
+      "properties": {
+        "network": {
+          "type": "string",
+          "pattern": "^did:[a-z0-9]+:.+$",
+          "maxLength": 2048,
+          "description": "The network's DID."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Where the network's API is reached: the base its `/.well-known/vtn` profile is served under."
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 200,
+          "description": "The network's name, as its profile gives it."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "acknowledged",
+            "repudiated",
+            "departed"
+          ],
+          "description": "`acknowledged`: the community is a member — it signed the acknowledgement of the network's grant. `repudiated`: the community rejected the network's listing of it. `departed`: the community left, by repudiating the grant."
+        },
+        "listing": {
+          "type": "object",
+          "description": "The network's listing credential naming the community, as the community verified it."
+        },
+        "grant": {
+          "type": "object",
+          "description": "The network's membership grant (VMC), once the community acknowledged."
+        },
+        "acknowledgement": {
+          "type": "object",
+          "description": "The community's acknowledgement (VMC carrying the grant's digest)."
+        },
+        "repudiation": {
+          "type": "object",
+          "description": "The community's repudiation (VSC) of the listing, or — on departure — of the grant."
+        },
+        "groups": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "$ref": "#/$defs/RegisteredGroup"
+          }
+        },
+        "joinedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "RegisteredGroup": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "role",
+        "groupId",
+        "groupDid",
+        "endpoint",
+        "registration",
+        "acceptance",
+        "registeredAt"
+      ],
+      "properties": {
+        "role": {
+          "type": "string",
+          "pattern": "^[a-z0-9_-]{1,64}$",
+          "description": "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`."
+        },
+        "groupId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The community's identifier for the group."
+        },
+        "groupDid": {
+          "type": "string",
+          "pattern": "^did:[a-z0-9]+:.+$",
+          "maxLength": 2048,
+          "description": "The group's own DID, which the registration names as its subject."
+        },
+        "endpoint": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Where the network delivers broadcasts for the group: the community's relay endpoint for it."
+        },
+        "registration": {
+          "type": "object",
+          "description": "The community's `servesRole` statement (VSC): the group serves `role` in the network."
+        },
+        "acceptance": {
+          "type": "object",
+          "description": "The network's `groupRegistered` statement (VSC), bound to the registration's digest."
+        },
+        "registeredAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "RoleAssignment": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "role",
+        "groupId"
+      ],
+      "properties": {
+        "role": {
+          "type": "string",
+          "pattern": "^[a-z0-9_-]{1,64}$",
+          "description": "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`."
+        },
+        "groupId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The community group to serve the role."
+        }
+      }
+    }
+  }
+} 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: 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;