@openvtc/trust-tasks 0.28.8 → 0.28.10

package/dist/vtc/networks/join/0.1/payload.d.ts

@@ -0,0 +1,760 @@
+/**
+ * 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 declare const TYPE_URI: "https://trusttasks.org/spec/vtc/networks/join/0.1";
+/**
+ * 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 declare const EXTENDS: string | 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 declare const DEPRECATION: string | null;
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCNetworksJoinPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/networks/join/0.1#response";
+/** 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vtc/networks/join/0.1";
+    readonly title: "VTC Networks — Join — payload";
+    readonly 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.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["url", "network"];
+    readonly properties: {
+        readonly url: {
+            readonly type: "string";
+            readonly format: "uri";
+            readonly maxLength: 2048;
+            readonly description: "The network's API base, as the network's administrators gave it.";
+        };
+        readonly network: {
+            readonly type: "string";
+            readonly pattern: "^did:[a-z0-9]+:.+$";
+            readonly maxLength: 2048;
+            readonly description: "The network's DID. For a request naming a `url`, the community refuses if the network found there answers as another DID.";
+        };
+        readonly groups: {
+            readonly type: "array";
+            readonly maxItems: 32;
+            readonly items: {
+                readonly $ref: "#/$defs/RoleAssignment";
+            };
+            readonly description: "The community's groups to serve the network's roles. Every role the network requires must be assigned.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Networks — Join — response payload";
+            readonly description: "The membership as it now stands.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["membership"];
+            readonly properties: {
+                readonly membership: {
+                    readonly $ref: "#/$defs/NetworkMembership";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly NetworkMembership: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["network", "url", "state", "listing", "groups", "updatedAt"];
+            readonly properties: {
+                readonly network: {
+                    readonly type: "string";
+                    readonly pattern: "^did:[a-z0-9]+:.+$";
+                    readonly maxLength: 2048;
+                    readonly description: "The network's DID.";
+                };
+                readonly url: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "Where the network's API is reached: the base its `/.well-known/vtn` profile is served under.";
+                };
+                readonly name: {
+                    readonly type: "string";
+                    readonly maxLength: 200;
+                    readonly description: "The network's name, as its profile gives it.";
+                };
+                readonly state: {
+                    readonly type: "string";
+                    readonly enum: readonly ["acknowledged", "repudiated", "departed"];
+                    readonly 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.";
+                };
+                readonly listing: {
+                    readonly type: "object";
+                    readonly description: "The network's listing credential naming the community, as the community verified it.";
+                };
+                readonly grant: {
+                    readonly type: "object";
+                    readonly description: "The network's membership grant (VMC), once the community acknowledged.";
+                };
+                readonly acknowledgement: {
+                    readonly type: "object";
+                    readonly description: "The community's acknowledgement (VMC carrying the grant's digest).";
+                };
+                readonly repudiation: {
+                    readonly type: "object";
+                    readonly description: "The community's repudiation (VSC) of the listing, or — on departure — of the grant.";
+                };
+                readonly groups: {
+                    readonly type: "array";
+                    readonly maxItems: 64;
+                    readonly items: {
+                        readonly $ref: "#/$defs/RegisteredGroup";
+                    };
+                };
+                readonly joinedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly updatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+            };
+        };
+        readonly RegisteredGroup: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["role", "groupId", "groupDid", "endpoint", "registration", "acceptance", "registeredAt"];
+            readonly properties: {
+                readonly role: {
+                    readonly type: "string";
+                    readonly pattern: "^[a-z0-9_-]{1,64}$";
+                    readonly description: "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`.";
+                };
+                readonly groupId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 128;
+                    readonly description: "The community's identifier for the group.";
+                };
+                readonly groupDid: {
+                    readonly type: "string";
+                    readonly pattern: "^did:[a-z0-9]+:.+$";
+                    readonly maxLength: 2048;
+                    readonly description: "The group's own DID, which the registration names as its subject.";
+                };
+                readonly endpoint: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "Where the network delivers broadcasts for the group: the community's relay endpoint for it.";
+                };
+                readonly registration: {
+                    readonly type: "object";
+                    readonly description: "The community's `servesRole` statement (VSC): the group serves `role` in the network.";
+                };
+                readonly acceptance: {
+                    readonly type: "object";
+                    readonly description: "The network's `groupRegistered` statement (VSC), bound to the registration's digest.";
+                };
+                readonly registeredAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+            };
+        };
+        readonly RoleAssignment: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["role", "groupId"];
+            readonly properties: {
+                readonly role: {
+                    readonly type: "string";
+                    readonly pattern: "^[a-z0-9_-]{1,64}$";
+                    readonly description: "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`.";
+                };
+                readonly groupId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 128;
+                    readonly description: "The community group to serve the role.";
+                };
+            };
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Networks — Join — response payload";
+            readonly description: "The membership as it now stands.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["membership"];
+            readonly properties: {
+                readonly membership: {
+                    readonly $ref: "#/$defs/NetworkMembership";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly NetworkMembership: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["network", "url", "state", "listing", "groups", "updatedAt"];
+            readonly properties: {
+                readonly network: {
+                    readonly type: "string";
+                    readonly pattern: "^did:[a-z0-9]+:.+$";
+                    readonly maxLength: 2048;
+                    readonly description: "The network's DID.";
+                };
+                readonly url: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "Where the network's API is reached: the base its `/.well-known/vtn` profile is served under.";
+                };
+                readonly name: {
+                    readonly type: "string";
+                    readonly maxLength: 200;
+                    readonly description: "The network's name, as its profile gives it.";
+                };
+                readonly state: {
+                    readonly type: "string";
+                    readonly enum: readonly ["acknowledged", "repudiated", "departed"];
+                    readonly 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.";
+                };
+                readonly listing: {
+                    readonly type: "object";
+                    readonly description: "The network's listing credential naming the community, as the community verified it.";
+                };
+                readonly grant: {
+                    readonly type: "object";
+                    readonly description: "The network's membership grant (VMC), once the community acknowledged.";
+                };
+                readonly acknowledgement: {
+                    readonly type: "object";
+                    readonly description: "The community's acknowledgement (VMC carrying the grant's digest).";
+                };
+                readonly repudiation: {
+                    readonly type: "object";
+                    readonly description: "The community's repudiation (VSC) of the listing, or — on departure — of the grant.";
+                };
+                readonly groups: {
+                    readonly type: "array";
+                    readonly maxItems: 64;
+                    readonly items: {
+                        readonly $ref: "#/$defs/RegisteredGroup";
+                    };
+                };
+                readonly joinedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly updatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+            };
+        };
+        readonly RegisteredGroup: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["role", "groupId", "groupDid", "endpoint", "registration", "acceptance", "registeredAt"];
+            readonly properties: {
+                readonly role: {
+                    readonly type: "string";
+                    readonly pattern: "^[a-z0-9_-]{1,64}$";
+                    readonly description: "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`.";
+                };
+                readonly groupId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 128;
+                    readonly description: "The community's identifier for the group.";
+                };
+                readonly groupDid: {
+                    readonly type: "string";
+                    readonly pattern: "^did:[a-z0-9]+:.+$";
+                    readonly maxLength: 2048;
+                    readonly description: "The group's own DID, which the registration names as its subject.";
+                };
+                readonly endpoint: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "Where the network delivers broadcasts for the group: the community's relay endpoint for it.";
+                };
+                readonly registration: {
+                    readonly type: "object";
+                    readonly description: "The community's `servesRole` statement (VSC): the group serves `role` in the network.";
+                };
+                readonly acceptance: {
+                    readonly type: "object";
+                    readonly description: "The network's `groupRegistered` statement (VSC), bound to the registration's digest.";
+                };
+                readonly registeredAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+            };
+        };
+        readonly RoleAssignment: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["role", "groupId"];
+            readonly properties: {
+                readonly role: {
+                    readonly type: "string";
+                    readonly pattern: "^[a-z0-9_-]{1,64}$";
+                    readonly description: "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`.";
+                };
+                readonly groupId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 128;
+                    readonly description: "The community group to serve the role.";
+                };
+            };
+        };
+    };
+};
+/**
+ * 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtc/networks/join/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtc/networks/join/0.1";
+        readonly title: "VTC Networks — Join — payload";
+        readonly 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.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["url", "network"];
+        readonly properties: {
+            readonly url: {
+                readonly type: "string";
+                readonly format: "uri";
+                readonly maxLength: 2048;
+                readonly description: "The network's API base, as the network's administrators gave it.";
+            };
+            readonly network: {
+                readonly type: "string";
+                readonly pattern: "^did:[a-z0-9]+:.+$";
+                readonly maxLength: 2048;
+                readonly description: "The network's DID. For a request naming a `url`, the community refuses if the network found there answers as another DID.";
+            };
+            readonly groups: {
+                readonly type: "array";
+                readonly maxItems: 32;
+                readonly items: {
+                    readonly $ref: "#/$defs/RoleAssignment";
+                };
+                readonly description: "The community's groups to serve the network's roles. Every role the network requires must be assigned.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Networks — Join — response payload";
+                readonly description: "The membership as it now stands.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["membership"];
+                readonly properties: {
+                    readonly membership: {
+                        readonly $ref: "#/$defs/NetworkMembership";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly NetworkMembership: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["network", "url", "state", "listing", "groups", "updatedAt"];
+                readonly properties: {
+                    readonly network: {
+                        readonly type: "string";
+                        readonly pattern: "^did:[a-z0-9]+:.+$";
+                        readonly maxLength: 2048;
+                        readonly description: "The network's DID.";
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "Where the network's API is reached: the base its `/.well-known/vtn` profile is served under.";
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                        readonly maxLength: 200;
+                        readonly description: "The network's name, as its profile gives it.";
+                    };
+                    readonly state: {
+                        readonly type: "string";
+                        readonly enum: readonly ["acknowledged", "repudiated", "departed"];
+                        readonly 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.";
+                    };
+                    readonly listing: {
+                        readonly type: "object";
+                        readonly description: "The network's listing credential naming the community, as the community verified it.";
+                    };
+                    readonly grant: {
+                        readonly type: "object";
+                        readonly description: "The network's membership grant (VMC), once the community acknowledged.";
+                    };
+                    readonly acknowledgement: {
+                        readonly type: "object";
+                        readonly description: "The community's acknowledgement (VMC carrying the grant's digest).";
+                    };
+                    readonly repudiation: {
+                        readonly type: "object";
+                        readonly description: "The community's repudiation (VSC) of the listing, or — on departure — of the grant.";
+                    };
+                    readonly groups: {
+                        readonly type: "array";
+                        readonly maxItems: 64;
+                        readonly items: {
+                            readonly $ref: "#/$defs/RegisteredGroup";
+                        };
+                    };
+                    readonly joinedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly updatedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                };
+            };
+            readonly RegisteredGroup: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["role", "groupId", "groupDid", "endpoint", "registration", "acceptance", "registeredAt"];
+                readonly properties: {
+                    readonly role: {
+                        readonly type: "string";
+                        readonly pattern: "^[a-z0-9_-]{1,64}$";
+                        readonly description: "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`.";
+                    };
+                    readonly groupId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 128;
+                        readonly description: "The community's identifier for the group.";
+                    };
+                    readonly groupDid: {
+                        readonly type: "string";
+                        readonly pattern: "^did:[a-z0-9]+:.+$";
+                        readonly maxLength: 2048;
+                        readonly description: "The group's own DID, which the registration names as its subject.";
+                    };
+                    readonly endpoint: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "Where the network delivers broadcasts for the group: the community's relay endpoint for it.";
+                    };
+                    readonly registration: {
+                        readonly type: "object";
+                        readonly description: "The community's `servesRole` statement (VSC): the group serves `role` in the network.";
+                    };
+                    readonly acceptance: {
+                        readonly type: "object";
+                        readonly description: "The network's `groupRegistered` statement (VSC), bound to the registration's digest.";
+                    };
+                    readonly registeredAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                };
+            };
+            readonly RoleAssignment: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["role", "groupId"];
+                readonly properties: {
+                    readonly role: {
+                        readonly type: "string";
+                        readonly pattern: "^[a-z0-9_-]{1,64}$";
+                        readonly description: "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`.";
+                    };
+                    readonly groupId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 128;
+                        readonly description: "The community group to serve the role.";
+                    };
+                };
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtc/networks/join/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Networks — Join — response payload";
+                readonly description: "The membership as it now stands.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["membership"];
+                readonly properties: {
+                    readonly membership: {
+                        readonly $ref: "#/$defs/NetworkMembership";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly NetworkMembership: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["network", "url", "state", "listing", "groups", "updatedAt"];
+                readonly properties: {
+                    readonly network: {
+                        readonly type: "string";
+                        readonly pattern: "^did:[a-z0-9]+:.+$";
+                        readonly maxLength: 2048;
+                        readonly description: "The network's DID.";
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "Where the network's API is reached: the base its `/.well-known/vtn` profile is served under.";
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                        readonly maxLength: 200;
+                        readonly description: "The network's name, as its profile gives it.";
+                    };
+                    readonly state: {
+                        readonly type: "string";
+                        readonly enum: readonly ["acknowledged", "repudiated", "departed"];
+                        readonly 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.";
+                    };
+                    readonly listing: {
+                        readonly type: "object";
+                        readonly description: "The network's listing credential naming the community, as the community verified it.";
+                    };
+                    readonly grant: {
+                        readonly type: "object";
+                        readonly description: "The network's membership grant (VMC), once the community acknowledged.";
+                    };
+                    readonly acknowledgement: {
+                        readonly type: "object";
+                        readonly description: "The community's acknowledgement (VMC carrying the grant's digest).";
+                    };
+                    readonly repudiation: {
+                        readonly type: "object";
+                        readonly description: "The community's repudiation (VSC) of the listing, or — on departure — of the grant.";
+                    };
+                    readonly groups: {
+                        readonly type: "array";
+                        readonly maxItems: 64;
+                        readonly items: {
+                            readonly $ref: "#/$defs/RegisteredGroup";
+                        };
+                    };
+                    readonly joinedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly updatedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                };
+            };
+            readonly RegisteredGroup: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["role", "groupId", "groupDid", "endpoint", "registration", "acceptance", "registeredAt"];
+                readonly properties: {
+                    readonly role: {
+                        readonly type: "string";
+                        readonly pattern: "^[a-z0-9_-]{1,64}$";
+                        readonly description: "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`.";
+                    };
+                    readonly groupId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 128;
+                        readonly description: "The community's identifier for the group.";
+                    };
+                    readonly groupDid: {
+                        readonly type: "string";
+                        readonly pattern: "^did:[a-z0-9]+:.+$";
+                        readonly maxLength: 2048;
+                        readonly description: "The group's own DID, which the registration names as its subject.";
+                    };
+                    readonly endpoint: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "Where the network delivers broadcasts for the group: the community's relay endpoint for it.";
+                    };
+                    readonly registration: {
+                        readonly type: "object";
+                        readonly description: "The community's `servesRole` statement (VSC): the group serves `role` in the network.";
+                    };
+                    readonly acceptance: {
+                        readonly type: "object";
+                        readonly description: "The network's `groupRegistered` statement (VSC), bound to the registration's digest.";
+                    };
+                    readonly registeredAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                };
+            };
+            readonly RoleAssignment: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["role", "groupId"];
+                readonly properties: {
+                    readonly role: {
+                        readonly type: "string";
+                        readonly pattern: "^[a-z0-9_-]{1,64}$";
+                        readonly description: "A role the network defines, e.g. `admins`: lowercase letters, digits, `-` and `_`.";
+                    };
+                    readonly groupId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 128;
+                        readonly description: "The community group to serve the role.";
+                    };
+                };
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map