@openvtc/trust-tasks 0.28.9 → 0.28.11

package/src/vtn/memberships/join/0.1/payload.ts

@@ -0,0 +1,488 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/memberships/join/0.1/payload.schema.json
+ */
+
+import type { Credential, Did_VtnV0_1 as Did, Ext, RoleMapping, RoleName_VtnV0_1 as RoleName, SignedTask, UpstreamGroup, UpstreamMembership } from "../../../../_shared/components.js";
+
+
+/**
+ * Accept a parent network's listing of this network: register this network's groups for the parent's roles, then acknowledge the parent's membership offer. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNMembershipsJoinPayload {
+  /**
+   * The parent network's base URL, as the parent's administrators gave it. Where it is reached, not who it is.
+   */
+  url: string;
+  /**
+   * The parent network's DID. This network refuses if the network found at `url` answers as another DID.
+   */
+  network: Did;
+  /**
+   * Which of this network's roles serves each parent role. A role the parent requires that is not mapped is served by this network's role of the same name.
+   *
+   * @maxItems 32
+   */
+  roles: RoleMapping[];
+  ext?: Ext;
+}
+/**
+ * The membership as it now stands.
+ */
+export interface VTNMembershipsJoinResponsePayload {
+  /**
+   * This network's membership of the parent as it now stands.
+   */
+  membership: UpstreamMembership;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Credential, Did, Ext, RoleMapping, RoleName, SignedTask, UpstreamGroup, UpstreamMembership };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtn/memberships/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 = VTNMembershipsJoinPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtn/memberships/join/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNMembershipsJoinResponsePayload;
+
+/**
+ * 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/memberships/join/0.1",
+  "title": "VTN Memberships — Join — payload",
+  "description": "Accept a parent network's listing of this network: register this network's groups for the parent's roles, then acknowledge the parent's membership offer. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "url",
+    "network",
+    "roles"
+  ],
+  "properties": {
+    "url": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 2048,
+      "description": "The parent network's base URL, as the parent's administrators gave it. Where it is reached, not who it is."
+    },
+    "network": {
+      "$ref": "#/$defs/Did",
+      "description": "The parent network's DID. This network refuses if the network found at `url` answers as another DID."
+    },
+    "roles": {
+      "type": "array",
+      "maxItems": 32,
+      "items": {
+        "$ref": "#/$defs/RoleMapping"
+      },
+      "description": "Which of this network's roles serves each parent role. A role the parent requires that is not mapped is served by this network's role of the same name."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTN Memberships — Join — response payload",
+      "description": "The membership as it now stands.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "membership"
+      ],
+      "properties": {
+        "membership": {
+          "$ref": "#/$defs/UpstreamMembership",
+          "description": "This network's membership of the parent as it now stands."
+        },
+        "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-]+)+$"
+      }
+    },
+    "UpstreamMembership": {
+      "description": "This network's membership of a parent.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "network",
+        "url",
+        "state",
+        "listing",
+        "groups",
+        "updatedAt"
+      ],
+      "properties": {
+        "network": {
+          "$ref": "#/$defs/Did",
+          "description": "The parent network."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Where the parent is reached."
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 200,
+          "description": "The parent's name."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "acknowledged",
+            "repudiated",
+            "departed"
+          ],
+          "description": "`acknowledged`: this network is a member. `repudiated`: it rejected the parent's listing. `departed`: it left."
+        },
+        "listing": {
+          "$ref": "#/$defs/Credential",
+          "description": "The parent's listing of this network, as verified."
+        },
+        "grant": {
+          "$ref": "#/$defs/Credential",
+          "description": "The parent's grant."
+        },
+        "acknowledgement": {
+          "$ref": "#/$defs/Credential",
+          "description": "This network's acknowledgement."
+        },
+        "repudiation": {
+          "$ref": "#/$defs/Credential",
+          "description": "This network's repudiation of the listing or grant."
+        },
+        "groups": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/UpstreamGroup"
+          },
+          "description": "Groups registered at the parent."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When it last changed."
+        }
+      }
+    },
+    "UpstreamGroup": {
+      "description": "A group this network registered at its parent.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "parentRole",
+        "localRole",
+        "group",
+        "registration",
+        "acceptance"
+      ],
+      "properties": {
+        "parentRole": {
+          "$ref": "#/$defs/RoleName"
+        },
+        "localRole": {
+          "$ref": "#/$defs/RoleName"
+        },
+        "group": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "This network's network group (`<did>#role-<localRole>`)."
+        },
+        "registration": {
+          "$ref": "#/$defs/SignedTask",
+          "description": "This network's signed vtn/groups/register request to the parent."
+        },
+        "acceptance": {
+          "$ref": "#/$defs/Credential",
+          "description": "The parent's groupRegistered credential accepting the registration: issued by the parent, subject this network's network group, `object.digestMultibase` the digest of `registration`, revocable on the parent's status list."
+        }
+      }
+    },
+    "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."
+    },
+    "SignedTask": {
+      "type": "object",
+      "description": "A complete Trust Task document, with its proof, exactly as signed and received. Verified as a document in its own right; open so its proof still covers every member, and so its digest can be recomputed."
+    },
+    "RoleName": {
+      "type": "string",
+      "pattern": "^[a-z0-9_-]{1,64}$",
+      "description": "A role's name: 1–64 lowercase letters, digits, `-` or `_`."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    },
+    "RoleMapping": {
+      "description": "Which of this network's roles serves a parent's role.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "parentRole",
+        "localRole"
+      ],
+      "properties": {
+        "parentRole": {
+          "$ref": "#/$defs/RoleName",
+          "description": "The parent's role."
+        },
+        "localRole": {
+          "$ref": "#/$defs/RoleName",
+          "description": "This network's role whose network group serves it."
+        }
+      }
+    }
+  }
+} 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 Memberships — Join — response payload",
+      "description": "The membership as it now stands.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "membership"
+      ],
+      "properties": {
+        "membership": {
+          "$ref": "#/$defs/UpstreamMembership",
+          "description": "This network's membership of the parent as it now stands."
+        },
+        "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-]+)+$"
+      }
+    },
+    "UpstreamMembership": {
+      "description": "This network's membership of a parent.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "network",
+        "url",
+        "state",
+        "listing",
+        "groups",
+        "updatedAt"
+      ],
+      "properties": {
+        "network": {
+          "$ref": "#/$defs/Did",
+          "description": "The parent network."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Where the parent is reached."
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 200,
+          "description": "The parent's name."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "acknowledged",
+            "repudiated",
+            "departed"
+          ],
+          "description": "`acknowledged`: this network is a member. `repudiated`: it rejected the parent's listing. `departed`: it left."
+        },
+        "listing": {
+          "$ref": "#/$defs/Credential",
+          "description": "The parent's listing of this network, as verified."
+        },
+        "grant": {
+          "$ref": "#/$defs/Credential",
+          "description": "The parent's grant."
+        },
+        "acknowledgement": {
+          "$ref": "#/$defs/Credential",
+          "description": "This network's acknowledgement."
+        },
+        "repudiation": {
+          "$ref": "#/$defs/Credential",
+          "description": "This network's repudiation of the listing or grant."
+        },
+        "groups": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/UpstreamGroup"
+          },
+          "description": "Groups registered at the parent."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When it last changed."
+        }
+      }
+    },
+    "UpstreamGroup": {
+      "description": "A group this network registered at its parent.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "parentRole",
+        "localRole",
+        "group",
+        "registration",
+        "acceptance"
+      ],
+      "properties": {
+        "parentRole": {
+          "$ref": "#/$defs/RoleName"
+        },
+        "localRole": {
+          "$ref": "#/$defs/RoleName"
+        },
+        "group": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "This network's network group (`<did>#role-<localRole>`)."
+        },
+        "registration": {
+          "$ref": "#/$defs/SignedTask",
+          "description": "This network's signed vtn/groups/register request to the parent."
+        },
+        "acceptance": {
+          "$ref": "#/$defs/Credential",
+          "description": "The parent's groupRegistered credential accepting the registration: issued by the parent, subject this network's network group, `object.digestMultibase` the digest of `registration`, revocable on the parent's status list."
+        }
+      }
+    },
+    "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."
+    },
+    "SignedTask": {
+      "type": "object",
+      "description": "A complete Trust Task document, with its proof, exactly as signed and received. Verified as a document in its own right; open so its proof still covers every member, and so its digest can be recomputed."
+    },
+    "RoleName": {
+      "type": "string",
+      "pattern": "^[a-z0-9_-]{1,64}$",
+      "description": "A role's name: 1–64 lowercase letters, digits, `-` or `_`."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    },
+    "RoleMapping": {
+      "description": "Which of this network's roles serves a parent's role.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "parentRole",
+        "localRole"
+      ],
+      "properties": {
+        "parentRole": {
+          "$ref": "#/$defs/RoleName",
+          "description": "The parent's role."
+        },
+        "localRole": {
+          "$ref": "#/$defs/RoleName",
+          "description": "This network's role whose network group serves it."
+        }
+      }
+    }
+  }
+} 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;