@openvtc/trust-tasks 0.28.9 → 0.28.11

package/src/vtc/notifications/show/0.1/payload.ts

@@ -0,0 +1,761 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/notifications/show/0.1/payload.schema.json
+ */
+
+import type { Did_NotificationsV0_1 as Did, Ext, GroupId, Kind_NotificationsV0_1 as Kind, Notification, NotificationId, ReceivedNotification, Recipients, RecipientScope, RecordId_VtcNotificationsV0_1 as RecordId, RelayDecision, Status, Subject } from "../../../../_shared/components.js";
+
+
+/**
+ * An administrator with `vtc.notifications.read` reads one notification the community holds as its addressee, with the document that delivered it exactly as received — the notifications/notify document, or the notifications/relay document carrying it — so the administrator can verify the originator's proof and every relay before deciding a relay (VTI-NTF-070). 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 VTCNotificationsShowPayload {
+  recordId: RecordId;
+  ext?: Ext;
+}
+export interface VTCNotificationsShowResponsePayload {
+  item: ReceivedNotification;
+  /**
+   * 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 administrator to verify. It is also what a relay carries in `forwarded`.
+   */
+  document: {};
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Did, Ext, GroupId, Kind, Notification, NotificationId, ReceivedNotification, Recipients, RecipientScope, RecordId, RelayDecision, Status, Subject };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/notifications/show/0.1" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCNotificationsShowPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/notifications/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCNotificationsShowResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/vtc/notifications/show/0.1",
+  "title": "VTC Notifications — Show — payload",
+  "description": "An administrator with `vtc.notifications.read` reads one notification the community holds as its addressee, with the document that delivered it exactly as received — the notifications/notify document, or the notifications/relay document carrying it — so the administrator can verify the originator's proof and every relay before deciding a relay (VTI-NTF-070). 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.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "recordId"
+  ],
+  "properties": {
+    "recordId": {
+      "$ref": "#/$defs/RecordId"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Notifications — Show — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "item",
+        "document"
+      ],
+      "properties": {
+        "item": {
+          "$ref": "#/$defs/ReceivedNotification"
+        },
+        "document": {
+          "type": "object",
+          "minProperties": 1,
+          "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 administrator to verify. It is also what a relay carries in `forwarded`."
+        }
+      }
+    },
+    "ReceivedNotification": {
+      "title": "ReceivedNotification",
+      "description": "One notification the community holds, as an administrator with `vtc.notifications.read` sees it. `originator`, `deliveredBy` and every entry of `relayedBy` were verified by the community when it accepted the notification (VTI-NTF-042); an administrator that does not take the community's word for them reads the document with vtc/notifications/show and verifies it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "recordId",
+        "originator",
+        "relayedBy",
+        "notification",
+        "receivedAt",
+        "mayRelay",
+        "relayDecisions"
+      ],
+      "properties": {
+        "recordId": {
+          "$ref": "#/$defs/RecordId"
+        },
+        "originator": {
+          "$ref": "#/$defs/Did",
+          "description": "The issuer of the notifications/notify document: who said the thing exists."
+        },
+        "relayedBy": {
+          "type": "array",
+          "maxItems": 4,
+          "items": {
+            "$ref": "#/$defs/Did"
+          },
+          "description": "The relayers the held revision passed through before it reached the community, in the order they relayed it; the last delivered it here, and is the party the acceptance policy counted (VTI-NTF-031). Empty for a notification the originator sent the community directly."
+        },
+        "notification": {
+          "$ref": "#/$defs/Notification",
+          "description": "The notification's members at the revision held."
+        },
+        "receivedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community accepted the revision held."
+        },
+        "mayRelay": {
+          "type": "boolean",
+          "description": "Whether the community may relay the revision held now: its `relayable` is true, its kind may be relayed, the received chain carries at most three relays so that the community's own makes at most four (VTI-NTF-041), and it is neither withdrawn nor past its `validUntil`."
+        },
+        "relayDisclosure": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024,
+          "description": "What a relay of the notification discloses about the community, as the kind's definition states it (VTI-NTF-046) — for the kind `election`, that the community is a member of the community holding the election. Present exactly when the kind's definition says a relay discloses something; the administrator deciding a relay is shown it, and acknowledges it in vtc/notifications/relay."
+        },
+        "relayDecisions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/RelayDecision"
+          },
+          "description": "The relay decisions made for this notification, oldest first. Empty while none has been. Every later revision, a withdrawal included, is relayed to every party an earlier one was, without a new decision (VTI-NTF-044)."
+        }
+      }
+    },
+    "RelayDecision": {
+      "title": "RelayDecision",
+      "description": "One administrator's decision to relay a received notification, as the community records it (VTI-NTF-073). It records the selection and how many parties it added, never who they are: the record of whom the community relayed to exists only to relay later revisions to them (VTI-NTF-044).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "decidedAt",
+        "decidedBy",
+        "recipients",
+        "recipientCount"
+      ],
+      "properties": {
+        "decidedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the decision was made."
+        },
+        "decidedBy": {
+          "$ref": "#/$defs/Did",
+          "description": "The administrator who made it."
+        },
+        "recipients": {
+          "$ref": "#/$defs/Recipients"
+        },
+        "recipientCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many parties this decision added to those the notification is relayed to. Parties an earlier decision already reached are not counted again."
+        }
+      }
+    },
+    "Recipients": {
+      "title": "Recipients",
+      "description": "The members a relay decision reaches, resolved by the community from its own records when the decision is made (VTI-NTF-072). `groupId` is present exactly when `scope` is `group`, and `role` exactly when `scope` is `role`. Whatever the scope, the community never relays to itself, to the notification's originator, or to any relayer the received chain names (VTI-NTF-047), and relays to each party at most once per revision.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "scope"
+      ],
+      "properties": {
+        "scope": {
+          "$ref": "#/$defs/RecipientScope"
+        },
+        "groupId": {
+          "$ref": "#/$defs/GroupId",
+          "description": "The community group whose active members the relay reaches."
+        },
+        "role": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The community role whose active holders the relay reaches, in the wire form the community's member records use — for example `moderator`, or `custom:editor`."
+        }
+      },
+      "dependentSchemas": {
+        "scope": {
+          "anyOf": [
+            {
+              "required": [
+                "groupId"
+              ]
+            },
+            {
+              "required": [
+                "role"
+              ]
+            },
+            {
+              "properties": {
+                "scope": {
+                  "const": "allMembers"
+                }
+              }
+            }
+          ]
+        },
+        "groupId": {
+          "properties": {
+            "scope": {
+              "const": "group"
+            }
+          }
+        },
+        "role": {
+          "properties": {
+            "scope": {
+              "const": "role"
+            }
+          }
+        }
+      }
+    },
+    "RecipientScope": {
+      "title": "RecipientScope",
+      "description": "Which of the community's members a relay decision reaches: `allMembers` — every active member; `group` — the active members of one community group; `role` — the active members holding one community role.",
+      "type": "string",
+      "enum": [
+        "allMembers",
+        "group",
+        "role"
+      ]
+    },
+    "GroupId": {
+      "title": "GroupId",
+      "description": "Opaque identifier of a community group: `grp_` followed by 16 to 64 base64url characters. Random and community-scoped; not the group's DID.",
+      "type": "string",
+      "pattern": "^grp_[A-Za-z0-9_-]{16,64}$"
+    },
+    "Did": {
+      "title": "Did",
+      "description": "A DID.",
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 2048,
+      "pattern": "^did:[a-z0-9]+:\\S+$"
+    },
+    "RecordId": {
+      "title": "RecordId",
+      "description": "The community's own identifier for one received notification, stable across the revisions that replace it. Opaque and compared for equality only; unguessable, because a read by a caller without the capability is refused and an enumerable identifier would turn the refusal into an oracle.",
+      "type": "string",
+      "minLength": 16,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9._~:-]+$"
+    },
+    "Notification": {
+      "title": "Notification",
+      "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.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "notificationId",
+        "revision",
+        "kind",
+        "subject",
+        "audience",
+        "status",
+        "relayable"
+      ],
+      "properties": {
+        "notificationId": {
+          "$ref": "#/$defs/NotificationId"
+        },
+        "revision": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 1000000,
+          "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."
+        },
+        "kind": {
+          "$ref": "#/$defs/Kind"
+        },
+        "subject": {
+          "$ref": "#/$defs/Subject"
+        },
+        "audience": {
+          "$ref": "#/$defs/Did",
+          "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."
+        },
+        "status": {
+          "$ref": "#/$defs/Status"
+        },
+        "relayable": {
+          "type": "boolean",
+          "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)."
+        },
+        "validFrom": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the thing can first be acted on — for an election, when voting opens. Absent: it can be acted on now."
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "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."
+        }
+      }
+    },
+    "Status": {
+      "title": "Status",
+      "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).",
+      "type": "string",
+      "enum": [
+        "available",
+        "withdrawn"
+      ]
+    },
+    "Subject": {
+      "title": "Subject",
+      "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`.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "heldBy",
+        "id",
+        "openWith"
+      ],
+      "properties": {
+        "heldBy": {
+          "$ref": "#/$defs/Did",
+          "description": "The DID of the party holding the thing — for an election, the community. The party a recipient sends `openWith` to."
+        },
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The thing's identifier at `heldBy`, in the form the `openWith` task takes it — for an election, its `electionId`."
+        },
+        "openWith": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "pattern": "^https://\\S+$",
+          "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."
+        }
+      }
+    },
+    "Kind": {
+      "title": "Kind",
+      "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).",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "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})$"
+    },
+    "NotificationId": {
+      "title": "NotificationId",
+      "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.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "^[A-Za-z0-9._~:-]+$"
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Notifications — Show — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "item",
+        "document"
+      ],
+      "properties": {
+        "item": {
+          "$ref": "#/$defs/ReceivedNotification"
+        },
+        "document": {
+          "type": "object",
+          "minProperties": 1,
+          "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 administrator to verify. It is also what a relay carries in `forwarded`."
+        }
+      }
+    },
+    "ReceivedNotification": {
+      "title": "ReceivedNotification",
+      "description": "One notification the community holds, as an administrator with `vtc.notifications.read` sees it. `originator`, `deliveredBy` and every entry of `relayedBy` were verified by the community when it accepted the notification (VTI-NTF-042); an administrator that does not take the community's word for them reads the document with vtc/notifications/show and verifies it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "recordId",
+        "originator",
+        "relayedBy",
+        "notification",
+        "receivedAt",
+        "mayRelay",
+        "relayDecisions"
+      ],
+      "properties": {
+        "recordId": {
+          "$ref": "#/$defs/RecordId"
+        },
+        "originator": {
+          "$ref": "#/$defs/Did",
+          "description": "The issuer of the notifications/notify document: who said the thing exists."
+        },
+        "relayedBy": {
+          "type": "array",
+          "maxItems": 4,
+          "items": {
+            "$ref": "#/$defs/Did"
+          },
+          "description": "The relayers the held revision passed through before it reached the community, in the order they relayed it; the last delivered it here, and is the party the acceptance policy counted (VTI-NTF-031). Empty for a notification the originator sent the community directly."
+        },
+        "notification": {
+          "$ref": "#/$defs/Notification",
+          "description": "The notification's members at the revision held."
+        },
+        "receivedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community accepted the revision held."
+        },
+        "mayRelay": {
+          "type": "boolean",
+          "description": "Whether the community may relay the revision held now: its `relayable` is true, its kind may be relayed, the received chain carries at most three relays so that the community's own makes at most four (VTI-NTF-041), and it is neither withdrawn nor past its `validUntil`."
+        },
+        "relayDisclosure": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1024,
+          "description": "What a relay of the notification discloses about the community, as the kind's definition states it (VTI-NTF-046) — for the kind `election`, that the community is a member of the community holding the election. Present exactly when the kind's definition says a relay discloses something; the administrator deciding a relay is shown it, and acknowledges it in vtc/notifications/relay."
+        },
+        "relayDecisions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/RelayDecision"
+          },
+          "description": "The relay decisions made for this notification, oldest first. Empty while none has been. Every later revision, a withdrawal included, is relayed to every party an earlier one was, without a new decision (VTI-NTF-044)."
+        }
+      }
+    },
+    "RelayDecision": {
+      "title": "RelayDecision",
+      "description": "One administrator's decision to relay a received notification, as the community records it (VTI-NTF-073). It records the selection and how many parties it added, never who they are: the record of whom the community relayed to exists only to relay later revisions to them (VTI-NTF-044).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "decidedAt",
+        "decidedBy",
+        "recipients",
+        "recipientCount"
+      ],
+      "properties": {
+        "decidedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the decision was made."
+        },
+        "decidedBy": {
+          "$ref": "#/$defs/Did",
+          "description": "The administrator who made it."
+        },
+        "recipients": {
+          "$ref": "#/$defs/Recipients"
+        },
+        "recipientCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many parties this decision added to those the notification is relayed to. Parties an earlier decision already reached are not counted again."
+        }
+      }
+    },
+    "Recipients": {
+      "title": "Recipients",
+      "description": "The members a relay decision reaches, resolved by the community from its own records when the decision is made (VTI-NTF-072). `groupId` is present exactly when `scope` is `group`, and `role` exactly when `scope` is `role`. Whatever the scope, the community never relays to itself, to the notification's originator, or to any relayer the received chain names (VTI-NTF-047), and relays to each party at most once per revision.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "scope"
+      ],
+      "properties": {
+        "scope": {
+          "$ref": "#/$defs/RecipientScope"
+        },
+        "groupId": {
+          "$ref": "#/$defs/GroupId",
+          "description": "The community group whose active members the relay reaches."
+        },
+        "role": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The community role whose active holders the relay reaches, in the wire form the community's member records use — for example `moderator`, or `custom:editor`."
+        }
+      },
+      "dependentSchemas": {
+        "scope": {
+          "anyOf": [
+            {
+              "required": [
+                "groupId"
+              ]
+            },
+            {
+              "required": [
+                "role"
+              ]
+            },
+            {
+              "properties": {
+                "scope": {
+                  "const": "allMembers"
+                }
+              }
+            }
+          ]
+        },
+        "groupId": {
+          "properties": {
+            "scope": {
+              "const": "group"
+            }
+          }
+        },
+        "role": {
+          "properties": {
+            "scope": {
+              "const": "role"
+            }
+          }
+        }
+      }
+    },
+    "RecipientScope": {
+      "title": "RecipientScope",
+      "description": "Which of the community's members a relay decision reaches: `allMembers` — every active member; `group` — the active members of one community group; `role` — the active members holding one community role.",
+      "type": "string",
+      "enum": [
+        "allMembers",
+        "group",
+        "role"
+      ]
+    },
+    "GroupId": {
+      "title": "GroupId",
+      "description": "Opaque identifier of a community group: `grp_` followed by 16 to 64 base64url characters. Random and community-scoped; not the group's DID.",
+      "type": "string",
+      "pattern": "^grp_[A-Za-z0-9_-]{16,64}$"
+    },
+    "Did": {
+      "title": "Did",
+      "description": "A DID.",
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 2048,
+      "pattern": "^did:[a-z0-9]+:\\S+$"
+    },
+    "RecordId": {
+      "title": "RecordId",
+      "description": "The community's own identifier for one received notification, stable across the revisions that replace it. Opaque and compared for equality only; unguessable, because a read by a caller without the capability is refused and an enumerable identifier would turn the refusal into an oracle.",
+      "type": "string",
+      "minLength": 16,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9._~:-]+$"
+    },
+    "Notification": {
+      "title": "Notification",
+      "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.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "notificationId",
+        "revision",
+        "kind",
+        "subject",
+        "audience",
+        "status",
+        "relayable"
+      ],
+      "properties": {
+        "notificationId": {
+          "$ref": "#/$defs/NotificationId"
+        },
+        "revision": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 1000000,
+          "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."
+        },
+        "kind": {
+          "$ref": "#/$defs/Kind"
+        },
+        "subject": {
+          "$ref": "#/$defs/Subject"
+        },
+        "audience": {
+          "$ref": "#/$defs/Did",
+          "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."
+        },
+        "status": {
+          "$ref": "#/$defs/Status"
+        },
+        "relayable": {
+          "type": "boolean",
+          "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)."
+        },
+        "validFrom": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the thing can first be acted on — for an election, when voting opens. Absent: it can be acted on now."
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "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."
+        }
+      }
+    },
+    "Status": {
+      "title": "Status",
+      "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).",
+      "type": "string",
+      "enum": [
+        "available",
+        "withdrawn"
+      ]
+    },
+    "Subject": {
+      "title": "Subject",
+      "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`.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "heldBy",
+        "id",
+        "openWith"
+      ],
+      "properties": {
+        "heldBy": {
+          "$ref": "#/$defs/Did",
+          "description": "The DID of the party holding the thing — for an election, the community. The party a recipient sends `openWith` to."
+        },
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The thing's identifier at `heldBy`, in the form the `openWith` task takes it — for an election, its `electionId`."
+        },
+        "openWith": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "pattern": "^https://\\S+$",
+          "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."
+        }
+      }
+    },
+    "Kind": {
+      "title": "Kind",
+      "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).",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "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})$"
+    },
+    "NotificationId": {
+      "title": "NotificationId",
+      "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.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "^[A-Za-z0-9._~:-]+$"
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;