@openvtc/trust-tasks 0.28.8 → 0.28.9

package/dist/vta/notifications/show/0.1/payload.d.ts

@@ -0,0 +1,1004 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/notifications/show/0.1/payload.schema.json
+ */
+import type { ContextId, Did_NotificationsV0_1 as Did, Ext, HeldNotification, Kind_NotificationsV0_1 as Kind, Notification, NotificationId, RecordId, State, Status, Subject } from "../../../../_shared/components.js";
+/**
+ * A client with standing in a trust context reads one notification its VTA holds there, with the document that delivered it exactly as received — the notifications/notify document, or the notifications/relay document carrying it — so the client can verify the originator's proof and every relay itself rather than take the VTA's word (VTI-NTF-050). A read changes nothing, and sends nothing to anyone. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTANotificationsShowPayload {
+    contextId: ContextId;
+    recordId: RecordId;
+    ext?: Ext;
+}
+export interface VTANotificationsShowResponsePayload {
+    item: HeldNotification;
+    /**
+     * The document that delivered the revision held, kept whole and exactly as received — proof included: the notifications/notify/0.1 document, or the outermost notifications/relay/0.1 document. An opaque object, so that every member its issuer signed survives unchanged for the client to verify.
+     */
+    document: {};
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ContextId, Did, Ext, HeldNotification, Kind, Notification, NotificationId, RecordId, State, Status, Subject };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vta/notifications/show/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 = VTANotificationsShowPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/notifications/show/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTANotificationsShowResponsePayload;
+/**
+ * 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/vta/notifications/show/0.1";
+    readonly title: "VTA Notifications — Show — payload";
+    readonly description: "A client with standing in a trust context reads one notification its VTA holds there, with the document that delivered it exactly as received — the notifications/notify document, or the notifications/relay document carrying it — so the client can verify the originator's proof and every relay itself rather than take the VTA's word (VTI-NTF-050). A read changes nothing, and sends nothing to anyone. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["contextId", "recordId"];
+    readonly properties: {
+        readonly contextId: {
+            readonly $ref: "#/$defs/ContextId";
+        };
+        readonly recordId: {
+            readonly $ref: "#/$defs/RecordId";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTA Notifications — Show — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["item", "document"];
+            readonly properties: {
+                readonly item: {
+                    readonly $ref: "#/$defs/HeldNotification";
+                };
+                readonly document: {
+                    readonly type: "object";
+                    readonly minProperties: 1;
+                    readonly description: "The document that delivered the revision held, kept whole and exactly as received — proof included: the notifications/notify/0.1 document, or the outermost notifications/relay/0.1 document. An opaque object, so that every member its issuer signed survives unchanged for the client to verify.";
+                };
+            };
+        };
+        readonly HeldNotification: {
+            readonly title: "HeldNotification";
+            readonly description: "One notification the VTA holds, as a client with standing in its context sees it. `originator` and every entry of `relayedBy` were verified by the VTA when it accepted the notification (VTI-NTF-042); a client that does not take the VTA's word for them reads the document with vta/notifications/show and verifies it itself.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["recordId", "contextId", "addressee", "originator", "relayedBy", "notification", "state", "receivedAt"];
+            readonly properties: {
+                readonly recordId: {
+                    readonly $ref: "#/$defs/RecordId";
+                };
+                readonly contextId: {
+                    readonly $ref: "#/$defs/ContextId";
+                };
+                readonly addressee: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The principal's DID the notification, or the relay that delivered it, was addressed to.";
+                };
+                readonly originator: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The issuer of the notifications/notify document: who said the thing exists.";
+                };
+                readonly relayedBy: {
+                    readonly type: "array";
+                    readonly maxItems: 4;
+                    readonly items: {
+                        readonly $ref: "#/$defs/Did";
+                    };
+                    readonly description: "The relayers the held revision passed through, in the order they relayed it: the first is the notification's own addressee, the last the relayer that delivered it to `addressee`. Empty for a notification the originator sent to `addressee` directly. The acceptance policy counted the last one (VTI-NTF-031).";
+                };
+                readonly notification: {
+                    readonly $ref: "#/$defs/Notification";
+                    readonly description: "The notification's members at the revision held.";
+                };
+                readonly state: {
+                    readonly $ref: "#/$defs/State";
+                };
+                readonly receivedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the VTA accepted the revision held.";
+                };
+                readonly dismissedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the principal dismissed it. Present exactly when `state` is `dismissed`.";
+                };
+            };
+            readonly dependentSchemas: {
+                readonly state: {
+                    readonly anyOf: readonly [{
+                        readonly required: readonly ["dismissedAt"];
+                    }, {
+                        readonly properties: {
+                            readonly state: {
+                                readonly const: "active";
+                            };
+                        };
+                    }];
+                };
+                readonly dismissedAt: {
+                    readonly properties: {
+                        readonly state: {
+                            readonly const: "dismissed";
+                        };
+                    };
+                };
+            };
+        };
+        readonly State: {
+            readonly title: "State";
+            readonly description: "The principal's disposition of a held notification: `active`, or `dismissed` by vta/notifications/dismiss. Dismissal is the principal's alone and changes nothing outside the VTA (VTI-NTF-052).";
+            readonly type: "string";
+            readonly enum: readonly ["active", "dismissed"];
+        };
+        readonly ContextId: {
+            readonly title: "ContextId";
+            readonly description: "The trust context the notification is held in: the one the addressed DID belongs to.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+        };
+        readonly RecordId: {
+            readonly title: "RecordId";
+            readonly description: "The VTA's own identifier for one held notification, stable across the revisions that replace it. Opaque and compared for equality only; unguessable, because a show of a record in a context the caller may not read is refused and an enumerable identifier would turn the refusal into an oracle.";
+            readonly type: "string";
+            readonly minLength: 16;
+            readonly maxLength: 128;
+            readonly pattern: "^[A-Za-z0-9._~:-]+$";
+        };
+        readonly Notification: {
+            readonly title: "Notification";
+            readonly description: "The members of one notification, as notifications/notify carries them and as a recipient's agent records them. The originator is the `issuer` of the notifications/notify document and the addressee its `recipient`; neither is repeated here, because the originator's proof covers both.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["notificationId", "revision", "kind", "subject", "audience", "status", "relayable"];
+            readonly properties: {
+                readonly notificationId: {
+                    readonly $ref: "#/$defs/NotificationId";
+                };
+                readonly revision: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly maximum: 1000000;
+                    readonly description: "The revision of this notification. A recipient replaces the record it holds with a higher revision and leaves it unchanged for an equal or lower one (VTI-NTF-022). The first revision is 1.";
+                };
+                readonly kind: {
+                    readonly $ref: "#/$defs/Kind";
+                };
+                readonly subject: {
+                    readonly $ref: "#/$defs/Subject";
+                };
+                readonly audience: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The DID whose holders or members the thing concerns — for an election under a credential roll, the DID the roll names (`roll.memberOf`); otherwise the community's own. It says whom the thing is for, not that the recipient is one of them: a recipient may be the audience itself, or a party the audience relayed the notification to.";
+                };
+                readonly status: {
+                    readonly $ref: "#/$defs/Status";
+                };
+                readonly relayable: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the addressee may relay this notification to the parties it stands for (notifications/relay). The originator states it explicitly; an addressee MUST NOT relay a notification whose `relayable` is false, or whose kind may not be relayed (VTI-NTF-041).";
+                };
+                readonly validFrom: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the thing can first be acted on — for an election, when voting opens. Absent: it can be acted on now.";
+                };
+                readonly validUntil: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the thing can no longer be acted on, and the notification lapses — for an election, when voting closes. A recipient discards a notification received after it (VTI-NTF-032). Absent: the kind's definition says when it lapses.";
+                };
+            };
+        };
+        readonly Status: {
+            readonly title: "Status";
+            readonly description: "Whether the thing is still open to the audience: `available`, or `withdrawn` — cancelled by its holder, or no longer open to the audience — in which case the recipient keeps the record only to show that it was withdrawn (VTI-NTF-024).";
+            readonly type: "string";
+            readonly enum: readonly ["available", "withdrawn"];
+        };
+        readonly Did: {
+            readonly title: "Did";
+            readonly description: "A DID.";
+            readonly type: "string";
+            readonly minLength: 8;
+            readonly maxLength: 2048;
+            readonly pattern: "^did:[a-z0-9]+:\\S+$";
+        };
+        readonly Subject: {
+            readonly title: "Subject";
+            readonly description: "Where the thing is and how to open it. Only these three members: what the thing contains is shown by its holder, to a reader it admits, when the thing is opened with `openWith`.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["heldBy", "id", "openWith"];
+            readonly properties: {
+                readonly heldBy: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The DID of the party holding the thing — for an election, the community. The party a recipient sends `openWith` to.";
+                };
+                readonly id: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 256;
+                    readonly description: "The thing's identifier at `heldBy`, in the form the `openWith` task takes it — for an election, its `electionId`.";
+                };
+                readonly openWith: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 512;
+                    readonly pattern: "^https://\\S+$";
+                    readonly description: "The Type URI of the Trust Task by which a recipient opens the thing at `heldBy` — for an election, `https://trusttasks.org/spec/vtc/elections/show/0.6`. A recipient opens it only at its principal's choice (VTI-NTF-053), and only by a version of that task it and `heldBy` both serve.";
+                };
+            };
+        };
+        readonly Kind: {
+            readonly title: "Kind";
+            readonly description: "What the thing is. Either a registered kind — one lowerCamelCase name in the VTI specification's notification kind registry (Appendix G), such as `election` — or an unregistered kind, written `<reverse-DNS domain>:<name>` under a domain its definer controls, such as `org.example:meetingInvite`. A recipient that does not recognise a kind holds, lists and discards it and does nothing else with it (VTI-NTF-012).";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+            readonly pattern: "^([a-z][a-zA-Z0-9]{0,63}|[a-z0-9]+(-[a-z0-9]+)*(\\.[a-z0-9]+(-[a-z0-9]+)*)+:[a-z][a-zA-Z0-9]{0,63})$";
+        };
+        readonly NotificationId: {
+            readonly title: "NotificationId";
+            readonly description: "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+            readonly pattern: "^[A-Za-z0-9._~:-]+$";
+        };
+        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-]+)+$";
+            };
+        };
+    };
+};
+/** 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: "VTA Notifications — Show — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["item", "document"];
+            readonly properties: {
+                readonly item: {
+                    readonly $ref: "#/$defs/HeldNotification";
+                };
+                readonly document: {
+                    readonly type: "object";
+                    readonly minProperties: 1;
+                    readonly description: "The document that delivered the revision held, kept whole and exactly as received — proof included: the notifications/notify/0.1 document, or the outermost notifications/relay/0.1 document. An opaque object, so that every member its issuer signed survives unchanged for the client to verify.";
+                };
+            };
+        };
+        readonly HeldNotification: {
+            readonly title: "HeldNotification";
+            readonly description: "One notification the VTA holds, as a client with standing in its context sees it. `originator` and every entry of `relayedBy` were verified by the VTA when it accepted the notification (VTI-NTF-042); a client that does not take the VTA's word for them reads the document with vta/notifications/show and verifies it itself.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["recordId", "contextId", "addressee", "originator", "relayedBy", "notification", "state", "receivedAt"];
+            readonly properties: {
+                readonly recordId: {
+                    readonly $ref: "#/$defs/RecordId";
+                };
+                readonly contextId: {
+                    readonly $ref: "#/$defs/ContextId";
+                };
+                readonly addressee: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The principal's DID the notification, or the relay that delivered it, was addressed to.";
+                };
+                readonly originator: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The issuer of the notifications/notify document: who said the thing exists.";
+                };
+                readonly relayedBy: {
+                    readonly type: "array";
+                    readonly maxItems: 4;
+                    readonly items: {
+                        readonly $ref: "#/$defs/Did";
+                    };
+                    readonly description: "The relayers the held revision passed through, in the order they relayed it: the first is the notification's own addressee, the last the relayer that delivered it to `addressee`. Empty for a notification the originator sent to `addressee` directly. The acceptance policy counted the last one (VTI-NTF-031).";
+                };
+                readonly notification: {
+                    readonly $ref: "#/$defs/Notification";
+                    readonly description: "The notification's members at the revision held.";
+                };
+                readonly state: {
+                    readonly $ref: "#/$defs/State";
+                };
+                readonly receivedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the VTA accepted the revision held.";
+                };
+                readonly dismissedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the principal dismissed it. Present exactly when `state` is `dismissed`.";
+                };
+            };
+            readonly dependentSchemas: {
+                readonly state: {
+                    readonly anyOf: readonly [{
+                        readonly required: readonly ["dismissedAt"];
+                    }, {
+                        readonly properties: {
+                            readonly state: {
+                                readonly const: "active";
+                            };
+                        };
+                    }];
+                };
+                readonly dismissedAt: {
+                    readonly properties: {
+                        readonly state: {
+                            readonly const: "dismissed";
+                        };
+                    };
+                };
+            };
+        };
+        readonly State: {
+            readonly title: "State";
+            readonly description: "The principal's disposition of a held notification: `active`, or `dismissed` by vta/notifications/dismiss. Dismissal is the principal's alone and changes nothing outside the VTA (VTI-NTF-052).";
+            readonly type: "string";
+            readonly enum: readonly ["active", "dismissed"];
+        };
+        readonly ContextId: {
+            readonly title: "ContextId";
+            readonly description: "The trust context the notification is held in: the one the addressed DID belongs to.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+        };
+        readonly RecordId: {
+            readonly title: "RecordId";
+            readonly description: "The VTA's own identifier for one held notification, stable across the revisions that replace it. Opaque and compared for equality only; unguessable, because a show of a record in a context the caller may not read is refused and an enumerable identifier would turn the refusal into an oracle.";
+            readonly type: "string";
+            readonly minLength: 16;
+            readonly maxLength: 128;
+            readonly pattern: "^[A-Za-z0-9._~:-]+$";
+        };
+        readonly Notification: {
+            readonly title: "Notification";
+            readonly description: "The members of one notification, as notifications/notify carries them and as a recipient's agent records them. The originator is the `issuer` of the notifications/notify document and the addressee its `recipient`; neither is repeated here, because the originator's proof covers both.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["notificationId", "revision", "kind", "subject", "audience", "status", "relayable"];
+            readonly properties: {
+                readonly notificationId: {
+                    readonly $ref: "#/$defs/NotificationId";
+                };
+                readonly revision: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly maximum: 1000000;
+                    readonly description: "The revision of this notification. A recipient replaces the record it holds with a higher revision and leaves it unchanged for an equal or lower one (VTI-NTF-022). The first revision is 1.";
+                };
+                readonly kind: {
+                    readonly $ref: "#/$defs/Kind";
+                };
+                readonly subject: {
+                    readonly $ref: "#/$defs/Subject";
+                };
+                readonly audience: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The DID whose holders or members the thing concerns — for an election under a credential roll, the DID the roll names (`roll.memberOf`); otherwise the community's own. It says whom the thing is for, not that the recipient is one of them: a recipient may be the audience itself, or a party the audience relayed the notification to.";
+                };
+                readonly status: {
+                    readonly $ref: "#/$defs/Status";
+                };
+                readonly relayable: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the addressee may relay this notification to the parties it stands for (notifications/relay). The originator states it explicitly; an addressee MUST NOT relay a notification whose `relayable` is false, or whose kind may not be relayed (VTI-NTF-041).";
+                };
+                readonly validFrom: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the thing can first be acted on — for an election, when voting opens. Absent: it can be acted on now.";
+                };
+                readonly validUntil: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the thing can no longer be acted on, and the notification lapses — for an election, when voting closes. A recipient discards a notification received after it (VTI-NTF-032). Absent: the kind's definition says when it lapses.";
+                };
+            };
+        };
+        readonly Status: {
+            readonly title: "Status";
+            readonly description: "Whether the thing is still open to the audience: `available`, or `withdrawn` — cancelled by its holder, or no longer open to the audience — in which case the recipient keeps the record only to show that it was withdrawn (VTI-NTF-024).";
+            readonly type: "string";
+            readonly enum: readonly ["available", "withdrawn"];
+        };
+        readonly Did: {
+            readonly title: "Did";
+            readonly description: "A DID.";
+            readonly type: "string";
+            readonly minLength: 8;
+            readonly maxLength: 2048;
+            readonly pattern: "^did:[a-z0-9]+:\\S+$";
+        };
+        readonly Subject: {
+            readonly title: "Subject";
+            readonly description: "Where the thing is and how to open it. Only these three members: what the thing contains is shown by its holder, to a reader it admits, when the thing is opened with `openWith`.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["heldBy", "id", "openWith"];
+            readonly properties: {
+                readonly heldBy: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The DID of the party holding the thing — for an election, the community. The party a recipient sends `openWith` to.";
+                };
+                readonly id: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 256;
+                    readonly description: "The thing's identifier at `heldBy`, in the form the `openWith` task takes it — for an election, its `electionId`.";
+                };
+                readonly openWith: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 512;
+                    readonly pattern: "^https://\\S+$";
+                    readonly description: "The Type URI of the Trust Task by which a recipient opens the thing at `heldBy` — for an election, `https://trusttasks.org/spec/vtc/elections/show/0.6`. A recipient opens it only at its principal's choice (VTI-NTF-053), and only by a version of that task it and `heldBy` both serve.";
+                };
+            };
+        };
+        readonly Kind: {
+            readonly title: "Kind";
+            readonly description: "What the thing is. Either a registered kind — one lowerCamelCase name in the VTI specification's notification kind registry (Appendix G), such as `election` — or an unregistered kind, written `<reverse-DNS domain>:<name>` under a domain its definer controls, such as `org.example:meetingInvite`. A recipient that does not recognise a kind holds, lists and discards it and does nothing else with it (VTI-NTF-012).";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+            readonly pattern: "^([a-z][a-zA-Z0-9]{0,63}|[a-z0-9]+(-[a-z0-9]+)*(\\.[a-z0-9]+(-[a-z0-9]+)*)+:[a-z][a-zA-Z0-9]{0,63})$";
+        };
+        readonly NotificationId: {
+            readonly title: "NotificationId";
+            readonly description: "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+            readonly pattern: "^[A-Za-z0-9._~:-]+$";
+        };
+        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-]+)+$";
+            };
+        };
+    };
+};
+/**
+ * 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/vta/notifications/show/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/vta/notifications/show/0.1";
+        readonly title: "VTA Notifications — Show — payload";
+        readonly description: "A client with standing in a trust context reads one notification its VTA holds there, with the document that delivered it exactly as received — the notifications/notify document, or the notifications/relay document carrying it — so the client can verify the originator's proof and every relay itself rather than take the VTA's word (VTI-NTF-050). A read changes nothing, and sends nothing to anyone. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["contextId", "recordId"];
+        readonly properties: {
+            readonly contextId: {
+                readonly $ref: "#/$defs/ContextId";
+            };
+            readonly recordId: {
+                readonly $ref: "#/$defs/RecordId";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTA Notifications — Show — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["item", "document"];
+                readonly properties: {
+                    readonly item: {
+                        readonly $ref: "#/$defs/HeldNotification";
+                    };
+                    readonly document: {
+                        readonly type: "object";
+                        readonly minProperties: 1;
+                        readonly description: "The document that delivered the revision held, kept whole and exactly as received — proof included: the notifications/notify/0.1 document, or the outermost notifications/relay/0.1 document. An opaque object, so that every member its issuer signed survives unchanged for the client to verify.";
+                    };
+                };
+            };
+            readonly HeldNotification: {
+                readonly title: "HeldNotification";
+                readonly description: "One notification the VTA holds, as a client with standing in its context sees it. `originator` and every entry of `relayedBy` were verified by the VTA when it accepted the notification (VTI-NTF-042); a client that does not take the VTA's word for them reads the document with vta/notifications/show and verifies it itself.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["recordId", "contextId", "addressee", "originator", "relayedBy", "notification", "state", "receivedAt"];
+                readonly properties: {
+                    readonly recordId: {
+                        readonly $ref: "#/$defs/RecordId";
+                    };
+                    readonly contextId: {
+                        readonly $ref: "#/$defs/ContextId";
+                    };
+                    readonly addressee: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The principal's DID the notification, or the relay that delivered it, was addressed to.";
+                    };
+                    readonly originator: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The issuer of the notifications/notify document: who said the thing exists.";
+                    };
+                    readonly relayedBy: {
+                        readonly type: "array";
+                        readonly maxItems: 4;
+                        readonly items: {
+                            readonly $ref: "#/$defs/Did";
+                        };
+                        readonly description: "The relayers the held revision passed through, in the order they relayed it: the first is the notification's own addressee, the last the relayer that delivered it to `addressee`. Empty for a notification the originator sent to `addressee` directly. The acceptance policy counted the last one (VTI-NTF-031).";
+                    };
+                    readonly notification: {
+                        readonly $ref: "#/$defs/Notification";
+                        readonly description: "The notification's members at the revision held.";
+                    };
+                    readonly state: {
+                        readonly $ref: "#/$defs/State";
+                    };
+                    readonly receivedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the VTA accepted the revision held.";
+                    };
+                    readonly dismissedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the principal dismissed it. Present exactly when `state` is `dismissed`.";
+                    };
+                };
+                readonly dependentSchemas: {
+                    readonly state: {
+                        readonly anyOf: readonly [{
+                            readonly required: readonly ["dismissedAt"];
+                        }, {
+                            readonly properties: {
+                                readonly state: {
+                                    readonly const: "active";
+                                };
+                            };
+                        }];
+                    };
+                    readonly dismissedAt: {
+                        readonly properties: {
+                            readonly state: {
+                                readonly const: "dismissed";
+                            };
+                        };
+                    };
+                };
+            };
+            readonly State: {
+                readonly title: "State";
+                readonly description: "The principal's disposition of a held notification: `active`, or `dismissed` by vta/notifications/dismiss. Dismissal is the principal's alone and changes nothing outside the VTA (VTI-NTF-052).";
+                readonly type: "string";
+                readonly enum: readonly ["active", "dismissed"];
+            };
+            readonly ContextId: {
+                readonly title: "ContextId";
+                readonly description: "The trust context the notification is held in: the one the addressed DID belongs to.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+            };
+            readonly RecordId: {
+                readonly title: "RecordId";
+                readonly description: "The VTA's own identifier for one held notification, stable across the revisions that replace it. Opaque and compared for equality only; unguessable, because a show of a record in a context the caller may not read is refused and an enumerable identifier would turn the refusal into an oracle.";
+                readonly type: "string";
+                readonly minLength: 16;
+                readonly maxLength: 128;
+                readonly pattern: "^[A-Za-z0-9._~:-]+$";
+            };
+            readonly Notification: {
+                readonly title: "Notification";
+                readonly description: "The members of one notification, as notifications/notify carries them and as a recipient's agent records them. The originator is the `issuer` of the notifications/notify document and the addressee its `recipient`; neither is repeated here, because the originator's proof covers both.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["notificationId", "revision", "kind", "subject", "audience", "status", "relayable"];
+                readonly properties: {
+                    readonly notificationId: {
+                        readonly $ref: "#/$defs/NotificationId";
+                    };
+                    readonly revision: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly maximum: 1000000;
+                        readonly description: "The revision of this notification. A recipient replaces the record it holds with a higher revision and leaves it unchanged for an equal or lower one (VTI-NTF-022). The first revision is 1.";
+                    };
+                    readonly kind: {
+                        readonly $ref: "#/$defs/Kind";
+                    };
+                    readonly subject: {
+                        readonly $ref: "#/$defs/Subject";
+                    };
+                    readonly audience: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The DID whose holders or members the thing concerns — for an election under a credential roll, the DID the roll names (`roll.memberOf`); otherwise the community's own. It says whom the thing is for, not that the recipient is one of them: a recipient may be the audience itself, or a party the audience relayed the notification to.";
+                    };
+                    readonly status: {
+                        readonly $ref: "#/$defs/Status";
+                    };
+                    readonly relayable: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the addressee may relay this notification to the parties it stands for (notifications/relay). The originator states it explicitly; an addressee MUST NOT relay a notification whose `relayable` is false, or whose kind may not be relayed (VTI-NTF-041).";
+                    };
+                    readonly validFrom: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the thing can first be acted on — for an election, when voting opens. Absent: it can be acted on now.";
+                    };
+                    readonly validUntil: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the thing can no longer be acted on, and the notification lapses — for an election, when voting closes. A recipient discards a notification received after it (VTI-NTF-032). Absent: the kind's definition says when it lapses.";
+                    };
+                };
+            };
+            readonly Status: {
+                readonly title: "Status";
+                readonly description: "Whether the thing is still open to the audience: `available`, or `withdrawn` — cancelled by its holder, or no longer open to the audience — in which case the recipient keeps the record only to show that it was withdrawn (VTI-NTF-024).";
+                readonly type: "string";
+                readonly enum: readonly ["available", "withdrawn"];
+            };
+            readonly Did: {
+                readonly title: "Did";
+                readonly description: "A DID.";
+                readonly type: "string";
+                readonly minLength: 8;
+                readonly maxLength: 2048;
+                readonly pattern: "^did:[a-z0-9]+:\\S+$";
+            };
+            readonly Subject: {
+                readonly title: "Subject";
+                readonly description: "Where the thing is and how to open it. Only these three members: what the thing contains is shown by its holder, to a reader it admits, when the thing is opened with `openWith`.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["heldBy", "id", "openWith"];
+                readonly properties: {
+                    readonly heldBy: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The DID of the party holding the thing — for an election, the community. The party a recipient sends `openWith` to.";
+                    };
+                    readonly id: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 256;
+                        readonly description: "The thing's identifier at `heldBy`, in the form the `openWith` task takes it — for an election, its `electionId`.";
+                    };
+                    readonly openWith: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 512;
+                        readonly pattern: "^https://\\S+$";
+                        readonly description: "The Type URI of the Trust Task by which a recipient opens the thing at `heldBy` — for an election, `https://trusttasks.org/spec/vtc/elections/show/0.6`. A recipient opens it only at its principal's choice (VTI-NTF-053), and only by a version of that task it and `heldBy` both serve.";
+                    };
+                };
+            };
+            readonly Kind: {
+                readonly title: "Kind";
+                readonly description: "What the thing is. Either a registered kind — one lowerCamelCase name in the VTI specification's notification kind registry (Appendix G), such as `election` — or an unregistered kind, written `<reverse-DNS domain>:<name>` under a domain its definer controls, such as `org.example:meetingInvite`. A recipient that does not recognise a kind holds, lists and discards it and does nothing else with it (VTI-NTF-012).";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+                readonly pattern: "^([a-z][a-zA-Z0-9]{0,63}|[a-z0-9]+(-[a-z0-9]+)*(\\.[a-z0-9]+(-[a-z0-9]+)*)+:[a-z][a-zA-Z0-9]{0,63})$";
+            };
+            readonly NotificationId: {
+                readonly title: "NotificationId";
+                readonly description: "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+                readonly pattern: "^[A-Za-z0-9._~:-]+$";
+            };
+            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-]+)+$";
+                };
+            };
+        };
+    };
+};
+/**
+ * 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/vta/notifications/show/0.1#response";
+    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 $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTA Notifications — Show — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["item", "document"];
+                readonly properties: {
+                    readonly item: {
+                        readonly $ref: "#/$defs/HeldNotification";
+                    };
+                    readonly document: {
+                        readonly type: "object";
+                        readonly minProperties: 1;
+                        readonly description: "The document that delivered the revision held, kept whole and exactly as received — proof included: the notifications/notify/0.1 document, or the outermost notifications/relay/0.1 document. An opaque object, so that every member its issuer signed survives unchanged for the client to verify.";
+                    };
+                };
+            };
+            readonly HeldNotification: {
+                readonly title: "HeldNotification";
+                readonly description: "One notification the VTA holds, as a client with standing in its context sees it. `originator` and every entry of `relayedBy` were verified by the VTA when it accepted the notification (VTI-NTF-042); a client that does not take the VTA's word for them reads the document with vta/notifications/show and verifies it itself.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["recordId", "contextId", "addressee", "originator", "relayedBy", "notification", "state", "receivedAt"];
+                readonly properties: {
+                    readonly recordId: {
+                        readonly $ref: "#/$defs/RecordId";
+                    };
+                    readonly contextId: {
+                        readonly $ref: "#/$defs/ContextId";
+                    };
+                    readonly addressee: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The principal's DID the notification, or the relay that delivered it, was addressed to.";
+                    };
+                    readonly originator: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The issuer of the notifications/notify document: who said the thing exists.";
+                    };
+                    readonly relayedBy: {
+                        readonly type: "array";
+                        readonly maxItems: 4;
+                        readonly items: {
+                            readonly $ref: "#/$defs/Did";
+                        };
+                        readonly description: "The relayers the held revision passed through, in the order they relayed it: the first is the notification's own addressee, the last the relayer that delivered it to `addressee`. Empty for a notification the originator sent to `addressee` directly. The acceptance policy counted the last one (VTI-NTF-031).";
+                    };
+                    readonly notification: {
+                        readonly $ref: "#/$defs/Notification";
+                        readonly description: "The notification's members at the revision held.";
+                    };
+                    readonly state: {
+                        readonly $ref: "#/$defs/State";
+                    };
+                    readonly receivedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the VTA accepted the revision held.";
+                    };
+                    readonly dismissedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the principal dismissed it. Present exactly when `state` is `dismissed`.";
+                    };
+                };
+                readonly dependentSchemas: {
+                    readonly state: {
+                        readonly anyOf: readonly [{
+                            readonly required: readonly ["dismissedAt"];
+                        }, {
+                            readonly properties: {
+                                readonly state: {
+                                    readonly const: "active";
+                                };
+                            };
+                        }];
+                    };
+                    readonly dismissedAt: {
+                        readonly properties: {
+                            readonly state: {
+                                readonly const: "dismissed";
+                            };
+                        };
+                    };
+                };
+            };
+            readonly State: {
+                readonly title: "State";
+                readonly description: "The principal's disposition of a held notification: `active`, or `dismissed` by vta/notifications/dismiss. Dismissal is the principal's alone and changes nothing outside the VTA (VTI-NTF-052).";
+                readonly type: "string";
+                readonly enum: readonly ["active", "dismissed"];
+            };
+            readonly ContextId: {
+                readonly title: "ContextId";
+                readonly description: "The trust context the notification is held in: the one the addressed DID belongs to.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+            };
+            readonly RecordId: {
+                readonly title: "RecordId";
+                readonly description: "The VTA's own identifier for one held notification, stable across the revisions that replace it. Opaque and compared for equality only; unguessable, because a show of a record in a context the caller may not read is refused and an enumerable identifier would turn the refusal into an oracle.";
+                readonly type: "string";
+                readonly minLength: 16;
+                readonly maxLength: 128;
+                readonly pattern: "^[A-Za-z0-9._~:-]+$";
+            };
+            readonly Notification: {
+                readonly title: "Notification";
+                readonly description: "The members of one notification, as notifications/notify carries them and as a recipient's agent records them. The originator is the `issuer` of the notifications/notify document and the addressee its `recipient`; neither is repeated here, because the originator's proof covers both.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["notificationId", "revision", "kind", "subject", "audience", "status", "relayable"];
+                readonly properties: {
+                    readonly notificationId: {
+                        readonly $ref: "#/$defs/NotificationId";
+                    };
+                    readonly revision: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly maximum: 1000000;
+                        readonly description: "The revision of this notification. A recipient replaces the record it holds with a higher revision and leaves it unchanged for an equal or lower one (VTI-NTF-022). The first revision is 1.";
+                    };
+                    readonly kind: {
+                        readonly $ref: "#/$defs/Kind";
+                    };
+                    readonly subject: {
+                        readonly $ref: "#/$defs/Subject";
+                    };
+                    readonly audience: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The DID whose holders or members the thing concerns — for an election under a credential roll, the DID the roll names (`roll.memberOf`); otherwise the community's own. It says whom the thing is for, not that the recipient is one of them: a recipient may be the audience itself, or a party the audience relayed the notification to.";
+                    };
+                    readonly status: {
+                        readonly $ref: "#/$defs/Status";
+                    };
+                    readonly relayable: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the addressee may relay this notification to the parties it stands for (notifications/relay). The originator states it explicitly; an addressee MUST NOT relay a notification whose `relayable` is false, or whose kind may not be relayed (VTI-NTF-041).";
+                    };
+                    readonly validFrom: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the thing can first be acted on — for an election, when voting opens. Absent: it can be acted on now.";
+                    };
+                    readonly validUntil: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the thing can no longer be acted on, and the notification lapses — for an election, when voting closes. A recipient discards a notification received after it (VTI-NTF-032). Absent: the kind's definition says when it lapses.";
+                    };
+                };
+            };
+            readonly Status: {
+                readonly title: "Status";
+                readonly description: "Whether the thing is still open to the audience: `available`, or `withdrawn` — cancelled by its holder, or no longer open to the audience — in which case the recipient keeps the record only to show that it was withdrawn (VTI-NTF-024).";
+                readonly type: "string";
+                readonly enum: readonly ["available", "withdrawn"];
+            };
+            readonly Did: {
+                readonly title: "Did";
+                readonly description: "A DID.";
+                readonly type: "string";
+                readonly minLength: 8;
+                readonly maxLength: 2048;
+                readonly pattern: "^did:[a-z0-9]+:\\S+$";
+            };
+            readonly Subject: {
+                readonly title: "Subject";
+                readonly description: "Where the thing is and how to open it. Only these three members: what the thing contains is shown by its holder, to a reader it admits, when the thing is opened with `openWith`.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["heldBy", "id", "openWith"];
+                readonly properties: {
+                    readonly heldBy: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The DID of the party holding the thing — for an election, the community. The party a recipient sends `openWith` to.";
+                    };
+                    readonly id: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 256;
+                        readonly description: "The thing's identifier at `heldBy`, in the form the `openWith` task takes it — for an election, its `electionId`.";
+                    };
+                    readonly openWith: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 512;
+                        readonly pattern: "^https://\\S+$";
+                        readonly description: "The Type URI of the Trust Task by which a recipient opens the thing at `heldBy` — for an election, `https://trusttasks.org/spec/vtc/elections/show/0.6`. A recipient opens it only at its principal's choice (VTI-NTF-053), and only by a version of that task it and `heldBy` both serve.";
+                    };
+                };
+            };
+            readonly Kind: {
+                readonly title: "Kind";
+                readonly description: "What the thing is. Either a registered kind — one lowerCamelCase name in the VTI specification's notification kind registry (Appendix G), such as `election` — or an unregistered kind, written `<reverse-DNS domain>:<name>` under a domain its definer controls, such as `org.example:meetingInvite`. A recipient that does not recognise a kind holds, lists and discards it and does nothing else with it (VTI-NTF-012).";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+                readonly pattern: "^([a-z][a-zA-Z0-9]{0,63}|[a-z0-9]+(-[a-z0-9]+)*(\\.[a-z0-9]+(-[a-z0-9]+)*)+:[a-z][a-zA-Z0-9]{0,63})$";
+            };
+            readonly NotificationId: {
+                readonly title: "NotificationId";
+                readonly description: "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+                readonly pattern: "^[A-Za-z0-9._~:-]+$";
+            };
+            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-]+)+$";
+                };
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map