@openvtc/trust-tasks 0.28.10 → 0.28.11

package/dist/vtn/directory/federated/0.1/payload.d.ts

@@ -0,0 +1,939 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/directory/federated/0.1/payload.schema.json
+ */
+import type { Did_VtnV0_1 as Did, EntryKind, EntryState, Ext, FederatedEntry, Membership, MembersOnly, PathHop, SearchText, Unreachable } from "../../../../_shared/components.js";
+/**
+ * A search of the network's published set and, through their signed indexes, its member networks' sets. The same query as vtn/directory/search; every member is optional. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNDirectoryFederatedSearchPayload {
+    q?: SearchText;
+    /**
+     * Only entries of this kind.
+     */
+    kind?: EntryKind;
+    /**
+     * Only entries in this state.
+     */
+    state?: EntryState;
+    membersOnly?: MembersOnly;
+    /**
+     * A person's membership credential from a member community, holder-bound to the signer; admits the person to a `members` directory.
+     */
+    membership?: Membership;
+    ext?: Ext;
+}
+/**
+ * The matches, each with the network that lists it and its path, and the member networks that could not be searched.
+ */
+export interface VTNDirectoryFederatedSearchResponsePayload {
+    /**
+     * When the network assembled the answer.
+     */
+    determinedAt: string;
+    /**
+     * The matches, this network's own first (empty `path`), each stating its own state and whether it is a member of `listedBy`.
+     */
+    results: FederatedEntry[];
+    /**
+     * Member networks whose sets could not be searched: indeterminate, not absent (VTI-REG-012).
+     */
+    unreachable: Unreachable[];
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Did, EntryKind, EntryState, Ext, FederatedEntry, Membership, MembersOnly, PathHop, SearchText, Unreachable };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtn/directory/federated/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 = VTNDirectoryFederatedSearchPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtn/directory/federated/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNDirectoryFederatedSearchResponsePayload;
+/**
+ * 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/vtn/directory/federated/0.1";
+    readonly title: "VTN Directory — Federated Search — payload";
+    readonly description: "A search of the network's published set and, through their signed indexes, its member networks' sets. The same query as vtn/directory/search; every member is optional. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly [];
+    readonly properties: {
+        readonly q: {
+            readonly $ref: "#/$defs/SearchText";
+        };
+        readonly kind: {
+            readonly $ref: "#/$defs/EntryKind";
+            readonly description: "Only entries of this kind.";
+        };
+        readonly state: {
+            readonly $ref: "#/$defs/EntryState";
+            readonly description: "Only entries in this state.";
+        };
+        readonly membersOnly: {
+            readonly $ref: "#/$defs/MembersOnly";
+        };
+        readonly membership: {
+            readonly $ref: "#/$defs/Membership";
+            readonly description: "A person's membership credential from a member community, holder-bound to the signer; admits the person to a `members` directory.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTN Directory — Federated Search — response payload";
+            readonly description: "The matches, each with the network that lists it and its path, and the member networks that could not be searched.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["determinedAt", "results", "unreachable"];
+            readonly properties: {
+                readonly determinedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the network assembled the answer.";
+                };
+                readonly results: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/FederatedEntry";
+                    };
+                    readonly description: "The matches, this network's own first (empty `path`), each stating its own state and whether it is a member of `listedBy`.";
+                };
+                readonly unreachable: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/Unreachable";
+                    };
+                    readonly description: "Member networks whose sets could not be searched: indeterminate, not absent (VTI-REG-012).";
+                };
+                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 Unreachable: {
+            readonly description: "A member network whose set could not be read: its results are indeterminate, not absent (VTI-REG-012).";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["network", "path", "reason"];
+            readonly properties: {
+                readonly network: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The member network that could not be searched.";
+                };
+                readonly path: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/PathHop";
+                    };
+                    readonly description: "How it was reached.";
+                };
+                readonly reason: {
+                    readonly type: "string";
+                    readonly maxLength: 1000;
+                    readonly description: "Why.";
+                };
+            };
+        };
+        readonly PathHop: {
+            readonly description: "One step on the path from the searched network to the network that lists a result. Each hop states its own entry state: membership does not chain (VTI-VTN-033).";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["network", "state", "acknowledged"];
+            readonly properties: {
+                readonly network: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "A network on the path.";
+                };
+                readonly name: {
+                    readonly type: "string";
+                    readonly maxLength: 200;
+                    readonly description: "Its name.";
+                };
+                readonly state: {
+                    readonly $ref: "#/$defs/EntryState";
+                    readonly description: "Its own entry's state at the network before it on the path.";
+                };
+                readonly acknowledged: {
+                    readonly type: "boolean";
+                    readonly description: "Whether that entry is a membership.";
+                };
+            };
+        };
+        readonly EntryState: {
+            readonly type: "string";
+            readonly enum: readonly ["listed", "acknowledged", "repudiated", "suspended", "removed", "departed"];
+            readonly 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.";
+        };
+        readonly Did: {
+            readonly type: "string";
+            readonly pattern: "^did:[a-z0-9]+:.+$";
+            readonly maxLength: 2048;
+            readonly description: "A DID.";
+        };
+        readonly FederatedEntry: {
+            readonly description: "A result from a member network's set, with the network that lists it and the path to that network.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["did", "kind", "state", "acknowledged", "listedBy", "path"];
+            readonly properties: {
+                readonly did: {
+                    readonly $ref: "#/$defs/Did";
+                };
+                readonly kind: {
+                    readonly $ref: "#/$defs/EntryKind";
+                };
+                readonly state: {
+                    readonly $ref: "#/$defs/EntryState";
+                };
+                readonly acknowledged: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the party is a member. Every result states it (VTI-VTN-013).";
+                };
+                readonly label: {
+                    readonly type: "string";
+                    readonly maxLength: 200;
+                    readonly description: "The name shown.";
+                };
+                readonly description: {
+                    readonly type: "string";
+                    readonly maxLength: 2000;
+                    readonly description: "What the party is.";
+                };
+                readonly url: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "The party's public address.";
+                };
+                readonly tags: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 64;
+                    };
+                    readonly description: "Tags.";
+                    readonly maxItems: 32;
+                };
+                readonly listingId: {
+                    readonly type: "string";
+                    readonly maxLength: 2048;
+                    readonly description: "The listing credential's `id`, to fetch it.";
+                };
+                readonly grantId: {
+                    readonly type: "string";
+                    readonly maxLength: 2048;
+                    readonly description: "The grant's `id`, once acknowledged.";
+                };
+                readonly listedBy: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The network whose set the result is in.";
+                };
+                readonly path: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/PathHop";
+                    };
+                    readonly description: "From the searched network to `listedBy`, one hop per nesting.";
+                };
+            };
+        };
+        readonly EntryKind: {
+            readonly type: "string";
+            readonly enum: readonly ["community", "network"];
+            readonly 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`.";
+        };
+        readonly Membership: {
+            readonly type: "object";
+            readonly 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`.";
+        };
+        readonly MembersOnly: {
+            readonly type: "boolean";
+            readonly description: "Only members (`acknowledged: true`). Absent means false.";
+        };
+        readonly SearchText: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+            readonly description: "Free text. Every whitespace-separated term must match, case-insensitively, the entry's DID, label, description or a tag.";
+        };
+    };
+};
+/** 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: "VTN Directory — Federated Search — response payload";
+            readonly description: "The matches, each with the network that lists it and its path, and the member networks that could not be searched.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["determinedAt", "results", "unreachable"];
+            readonly properties: {
+                readonly determinedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the network assembled the answer.";
+                };
+                readonly results: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/FederatedEntry";
+                    };
+                    readonly description: "The matches, this network's own first (empty `path`), each stating its own state and whether it is a member of `listedBy`.";
+                };
+                readonly unreachable: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/Unreachable";
+                    };
+                    readonly description: "Member networks whose sets could not be searched: indeterminate, not absent (VTI-REG-012).";
+                };
+                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 Unreachable: {
+            readonly description: "A member network whose set could not be read: its results are indeterminate, not absent (VTI-REG-012).";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["network", "path", "reason"];
+            readonly properties: {
+                readonly network: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The member network that could not be searched.";
+                };
+                readonly path: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/PathHop";
+                    };
+                    readonly description: "How it was reached.";
+                };
+                readonly reason: {
+                    readonly type: "string";
+                    readonly maxLength: 1000;
+                    readonly description: "Why.";
+                };
+            };
+        };
+        readonly PathHop: {
+            readonly description: "One step on the path from the searched network to the network that lists a result. Each hop states its own entry state: membership does not chain (VTI-VTN-033).";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["network", "state", "acknowledged"];
+            readonly properties: {
+                readonly network: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "A network on the path.";
+                };
+                readonly name: {
+                    readonly type: "string";
+                    readonly maxLength: 200;
+                    readonly description: "Its name.";
+                };
+                readonly state: {
+                    readonly $ref: "#/$defs/EntryState";
+                    readonly description: "Its own entry's state at the network before it on the path.";
+                };
+                readonly acknowledged: {
+                    readonly type: "boolean";
+                    readonly description: "Whether that entry is a membership.";
+                };
+            };
+        };
+        readonly EntryState: {
+            readonly type: "string";
+            readonly enum: readonly ["listed", "acknowledged", "repudiated", "suspended", "removed", "departed"];
+            readonly 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.";
+        };
+        readonly Did: {
+            readonly type: "string";
+            readonly pattern: "^did:[a-z0-9]+:.+$";
+            readonly maxLength: 2048;
+            readonly description: "A DID.";
+        };
+        readonly FederatedEntry: {
+            readonly description: "A result from a member network's set, with the network that lists it and the path to that network.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["did", "kind", "state", "acknowledged", "listedBy", "path"];
+            readonly properties: {
+                readonly did: {
+                    readonly $ref: "#/$defs/Did";
+                };
+                readonly kind: {
+                    readonly $ref: "#/$defs/EntryKind";
+                };
+                readonly state: {
+                    readonly $ref: "#/$defs/EntryState";
+                };
+                readonly acknowledged: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the party is a member. Every result states it (VTI-VTN-013).";
+                };
+                readonly label: {
+                    readonly type: "string";
+                    readonly maxLength: 200;
+                    readonly description: "The name shown.";
+                };
+                readonly description: {
+                    readonly type: "string";
+                    readonly maxLength: 2000;
+                    readonly description: "What the party is.";
+                };
+                readonly url: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "The party's public address.";
+                };
+                readonly tags: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 64;
+                    };
+                    readonly description: "Tags.";
+                    readonly maxItems: 32;
+                };
+                readonly listingId: {
+                    readonly type: "string";
+                    readonly maxLength: 2048;
+                    readonly description: "The listing credential's `id`, to fetch it.";
+                };
+                readonly grantId: {
+                    readonly type: "string";
+                    readonly maxLength: 2048;
+                    readonly description: "The grant's `id`, once acknowledged.";
+                };
+                readonly listedBy: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The network whose set the result is in.";
+                };
+                readonly path: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/PathHop";
+                    };
+                    readonly description: "From the searched network to `listedBy`, one hop per nesting.";
+                };
+            };
+        };
+        readonly EntryKind: {
+            readonly type: "string";
+            readonly enum: readonly ["community", "network"];
+            readonly 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`.";
+        };
+        readonly Membership: {
+            readonly type: "object";
+            readonly 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`.";
+        };
+        readonly MembersOnly: {
+            readonly type: "boolean";
+            readonly description: "Only members (`acknowledged: true`). Absent means false.";
+        };
+        readonly SearchText: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+            readonly description: "Free text. Every whitespace-separated term must match, case-insensitively, the entry's DID, label, description or a tag.";
+        };
+    };
+};
+/**
+ * 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/vtn/directory/federated/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtn/directory/federated/0.1";
+        readonly title: "VTN Directory — Federated Search — payload";
+        readonly description: "A search of the network's published set and, through their signed indexes, its member networks' sets. The same query as vtn/directory/search; every member is optional. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly [];
+        readonly properties: {
+            readonly q: {
+                readonly $ref: "#/$defs/SearchText";
+            };
+            readonly kind: {
+                readonly $ref: "#/$defs/EntryKind";
+                readonly description: "Only entries of this kind.";
+            };
+            readonly state: {
+                readonly $ref: "#/$defs/EntryState";
+                readonly description: "Only entries in this state.";
+            };
+            readonly membersOnly: {
+                readonly $ref: "#/$defs/MembersOnly";
+            };
+            readonly membership: {
+                readonly $ref: "#/$defs/Membership";
+                readonly description: "A person's membership credential from a member community, holder-bound to the signer; admits the person to a `members` directory.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTN Directory — Federated Search — response payload";
+                readonly description: "The matches, each with the network that lists it and its path, and the member networks that could not be searched.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["determinedAt", "results", "unreachable"];
+                readonly properties: {
+                    readonly determinedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the network assembled the answer.";
+                    };
+                    readonly results: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/FederatedEntry";
+                        };
+                        readonly description: "The matches, this network's own first (empty `path`), each stating its own state and whether it is a member of `listedBy`.";
+                    };
+                    readonly unreachable: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/Unreachable";
+                        };
+                        readonly description: "Member networks whose sets could not be searched: indeterminate, not absent (VTI-REG-012).";
+                    };
+                    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 Unreachable: {
+                readonly description: "A member network whose set could not be read: its results are indeterminate, not absent (VTI-REG-012).";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["network", "path", "reason"];
+                readonly properties: {
+                    readonly network: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The member network that could not be searched.";
+                    };
+                    readonly path: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/PathHop";
+                        };
+                        readonly description: "How it was reached.";
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly maxLength: 1000;
+                        readonly description: "Why.";
+                    };
+                };
+            };
+            readonly PathHop: {
+                readonly description: "One step on the path from the searched network to the network that lists a result. Each hop states its own entry state: membership does not chain (VTI-VTN-033).";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["network", "state", "acknowledged"];
+                readonly properties: {
+                    readonly network: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "A network on the path.";
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                        readonly maxLength: 200;
+                        readonly description: "Its name.";
+                    };
+                    readonly state: {
+                        readonly $ref: "#/$defs/EntryState";
+                        readonly description: "Its own entry's state at the network before it on the path.";
+                    };
+                    readonly acknowledged: {
+                        readonly type: "boolean";
+                        readonly description: "Whether that entry is a membership.";
+                    };
+                };
+            };
+            readonly EntryState: {
+                readonly type: "string";
+                readonly enum: readonly ["listed", "acknowledged", "repudiated", "suspended", "removed", "departed"];
+                readonly 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.";
+            };
+            readonly Did: {
+                readonly type: "string";
+                readonly pattern: "^did:[a-z0-9]+:.+$";
+                readonly maxLength: 2048;
+                readonly description: "A DID.";
+            };
+            readonly FederatedEntry: {
+                readonly description: "A result from a member network's set, with the network that lists it and the path to that network.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["did", "kind", "state", "acknowledged", "listedBy", "path"];
+                readonly properties: {
+                    readonly did: {
+                        readonly $ref: "#/$defs/Did";
+                    };
+                    readonly kind: {
+                        readonly $ref: "#/$defs/EntryKind";
+                    };
+                    readonly state: {
+                        readonly $ref: "#/$defs/EntryState";
+                    };
+                    readonly acknowledged: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the party is a member. Every result states it (VTI-VTN-013).";
+                    };
+                    readonly label: {
+                        readonly type: "string";
+                        readonly maxLength: 200;
+                        readonly description: "The name shown.";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly maxLength: 2000;
+                        readonly description: "What the party is.";
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "The party's public address.";
+                    };
+                    readonly tags: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                            readonly maxLength: 64;
+                        };
+                        readonly description: "Tags.";
+                        readonly maxItems: 32;
+                    };
+                    readonly listingId: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                        readonly description: "The listing credential's `id`, to fetch it.";
+                    };
+                    readonly grantId: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                        readonly description: "The grant's `id`, once acknowledged.";
+                    };
+                    readonly listedBy: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The network whose set the result is in.";
+                    };
+                    readonly path: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/PathHop";
+                        };
+                        readonly description: "From the searched network to `listedBy`, one hop per nesting.";
+                    };
+                };
+            };
+            readonly EntryKind: {
+                readonly type: "string";
+                readonly enum: readonly ["community", "network"];
+                readonly 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`.";
+            };
+            readonly Membership: {
+                readonly type: "object";
+                readonly 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`.";
+            };
+            readonly MembersOnly: {
+                readonly type: "boolean";
+                readonly description: "Only members (`acknowledged: true`). Absent means false.";
+            };
+            readonly SearchText: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+                readonly description: "Free text. Every whitespace-separated term must match, case-insensitively, the entry's DID, label, description or a tag.";
+            };
+        };
+    };
+};
+/**
+ * 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/vtn/directory/federated/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: false;
+    readonly isIssuedAtRequired: false;
+    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: "VTN Directory — Federated Search — response payload";
+                readonly description: "The matches, each with the network that lists it and its path, and the member networks that could not be searched.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["determinedAt", "results", "unreachable"];
+                readonly properties: {
+                    readonly determinedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the network assembled the answer.";
+                    };
+                    readonly results: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/FederatedEntry";
+                        };
+                        readonly description: "The matches, this network's own first (empty `path`), each stating its own state and whether it is a member of `listedBy`.";
+                    };
+                    readonly unreachable: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/Unreachable";
+                        };
+                        readonly description: "Member networks whose sets could not be searched: indeterminate, not absent (VTI-REG-012).";
+                    };
+                    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 Unreachable: {
+                readonly description: "A member network whose set could not be read: its results are indeterminate, not absent (VTI-REG-012).";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["network", "path", "reason"];
+                readonly properties: {
+                    readonly network: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The member network that could not be searched.";
+                    };
+                    readonly path: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/PathHop";
+                        };
+                        readonly description: "How it was reached.";
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly maxLength: 1000;
+                        readonly description: "Why.";
+                    };
+                };
+            };
+            readonly PathHop: {
+                readonly description: "One step on the path from the searched network to the network that lists a result. Each hop states its own entry state: membership does not chain (VTI-VTN-033).";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["network", "state", "acknowledged"];
+                readonly properties: {
+                    readonly network: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "A network on the path.";
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                        readonly maxLength: 200;
+                        readonly description: "Its name.";
+                    };
+                    readonly state: {
+                        readonly $ref: "#/$defs/EntryState";
+                        readonly description: "Its own entry's state at the network before it on the path.";
+                    };
+                    readonly acknowledged: {
+                        readonly type: "boolean";
+                        readonly description: "Whether that entry is a membership.";
+                    };
+                };
+            };
+            readonly EntryState: {
+                readonly type: "string";
+                readonly enum: readonly ["listed", "acknowledged", "repudiated", "suspended", "removed", "departed"];
+                readonly 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.";
+            };
+            readonly Did: {
+                readonly type: "string";
+                readonly pattern: "^did:[a-z0-9]+:.+$";
+                readonly maxLength: 2048;
+                readonly description: "A DID.";
+            };
+            readonly FederatedEntry: {
+                readonly description: "A result from a member network's set, with the network that lists it and the path to that network.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["did", "kind", "state", "acknowledged", "listedBy", "path"];
+                readonly properties: {
+                    readonly did: {
+                        readonly $ref: "#/$defs/Did";
+                    };
+                    readonly kind: {
+                        readonly $ref: "#/$defs/EntryKind";
+                    };
+                    readonly state: {
+                        readonly $ref: "#/$defs/EntryState";
+                    };
+                    readonly acknowledged: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the party is a member. Every result states it (VTI-VTN-013).";
+                    };
+                    readonly label: {
+                        readonly type: "string";
+                        readonly maxLength: 200;
+                        readonly description: "The name shown.";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly maxLength: 2000;
+                        readonly description: "What the party is.";
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "The party's public address.";
+                    };
+                    readonly tags: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                            readonly maxLength: 64;
+                        };
+                        readonly description: "Tags.";
+                        readonly maxItems: 32;
+                    };
+                    readonly listingId: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                        readonly description: "The listing credential's `id`, to fetch it.";
+                    };
+                    readonly grantId: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                        readonly description: "The grant's `id`, once acknowledged.";
+                    };
+                    readonly listedBy: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The network whose set the result is in.";
+                    };
+                    readonly path: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/PathHop";
+                        };
+                        readonly description: "From the searched network to `listedBy`, one hop per nesting.";
+                    };
+                };
+            };
+            readonly EntryKind: {
+                readonly type: "string";
+                readonly enum: readonly ["community", "network"];
+                readonly 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`.";
+            };
+            readonly Membership: {
+                readonly type: "object";
+                readonly 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`.";
+            };
+            readonly MembersOnly: {
+                readonly type: "boolean";
+                readonly description: "Only members (`acknowledged: true`). Absent means false.";
+            };
+            readonly SearchText: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+                readonly description: "Free text. Every whitespace-separated term must match, case-insensitively, the entry's DID, label, description or a tag.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map