@openvtc/trust-tasks 0.26.17 → 0.26.19

package/src/persona/contact/put/1.1/payload.ts

@@ -0,0 +1,958 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/contact/put/1.1/payload.schema.json
+ */
+
+import type { ClaimType, ContactDocument, DirectoryEntryId, DirectoryRef, Ext, ListId, ListIds, Petname, ProofRung, Provenance, Ulid, ValueType } from "../../../../_shared/components.js";
+
+
+/**
+ * File what a peer disclosed, or change the holder's own annotations on a contact, or both. Two forms. FILING (`subjectDid`, `knownByPersona`, `document`; no `contactId`) appends a revision, never overwrites, so a changed value is visible as a change rather than arriving silently — exactly as 1.0. ANNOTATING (`contactId`; no `subjectDid`, `knownByPersona`, `document` or `credentialRefs`) changes the holder's star, petname, lists, directory link or notes on an existing contact and appends no revision. In either form each annotation given replaces the stored one, each `removeX` removes one, and each annotation absent is unchanged. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export type PersonaContactPutPayload = {
+  contextId: string;
+  /**
+   * Annotating form only: the existing contact whose annotations change. A filing never names one — the agent keys a filing on (contextId, subjectDid, knownByPersona) as in 1.0.
+   */
+  contactId?: Ulid;
+  /**
+   * Filing form only. The DID the document is about, as disclosed. Normally pairwise, so it names this relationship and not the person across all of theirs.
+   */
+  subjectDid?: string;
+  /**
+   * Filing form only. Which of the holder's personas knows this contact. A contact belongs to the relationship, not to the holder at large — the same peer met through two personas is two contacts, and collapsing them would correlate the holder's own personas in their own address book.
+   */
+  knownByPersona?: string;
+  document?: ContactDocument;
+  /**
+   * Filing form only. Vault identifiers of credentials the peer presented alongside the document. The credentials themselves belong in the credential vault and the contact holds references.
+   *
+   * @maxItems 256
+   */
+  credentialRefs?: string[];
+  /**
+   * Star or unstar the contact. Absent: unchanged. A boolean rather than a remove member because `false` is a value the holder chose, not an absence.
+   */
+  starred?: boolean;
+  /**
+   * The holder's private name for the contact, replacing any they had. Absent: unchanged.
+   */
+  petname?: Petname;
+  /**
+   * Remove the petname. Only `true` is meaningful, so only `true` is accepted. A separate member rather than `petname: null`, because a nullable optional member makes "unchanged" and "remove" the same value in libraries that map both to one absent option.
+   */
+  removePetname?: true;
+  /**
+   * The lists the contact is on, replacing the whole set. Every identifier MUST name a list in this context. Absent: unchanged. Take the contact off every list with `removeLists`.
+   */
+  lists?: ListIds;
+  /**
+   * Take the contact off every list. Only `true` is accepted.
+   */
+  removeLists?: true;
+  /**
+   * Link the contact to a community directory entry, replacing any link it had. Absent: unchanged.
+   */
+  directoryRef?: DirectoryRef;
+  /**
+   * Remove the contact's directory link. Only `true` is accepted.
+   */
+  removeDirectoryRef?: true;
+  /**
+   * The holder's private note about this contact, replacing any they had. Absent: unchanged. Never disclosed to anyone, including the contact.
+   */
+  notes?: string;
+  /**
+   * Remove the note. Only `true` is accepted.
+   */
+  removeNotes?: true;
+  ext?: Ext;
+} & {
+  [k: string]: unknown | undefined;
+};
+
+/**
+ * Success response to persona/contact/put. Type https://trusttasks.org/spec/persona/contact/put/1.1#response. Identifiers, the current revision and what changed; no claim value and no annotation text is echoed.
+ */
+export interface PersonaContactPutResponsePayload {
+  contactId: Ulid;
+  /**
+   * The contact's current revision: the one a filing just appended, or, for an annotating request, the revision that was already current. Annotations never move it.
+   */
+  rev: number;
+  /**
+   * True when this is the first revision for the subject. Always false for an annotating request.
+   */
+  created: boolean;
+  /**
+   * True when any annotation now differs from what was stored. False when every annotation given already matched and every one named for removal was already absent — including a filing that named none.
+   */
+  annotationsChanged: boolean;
+  /**
+   * Claim types whose value differs from the previous revision. Present only on a filing that updated an existing contact.
+   *
+   * @maxItems 256
+   */
+  changedClaims?: ClaimType[];
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ClaimType, ContactDocument, DirectoryEntryId, DirectoryRef, Ext, ListId, ListIds, Petname, ProofRung, Provenance, Ulid, ValueType };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/contact/put/1.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaContactPutPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/contact/put/1.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaContactPutResponsePayload;
+
+/**
+ * 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/persona/contact/put/1.1",
+  "title": "Persona Contact Put — payload",
+  "description": "File what a peer disclosed, or change the holder's own annotations on a contact, or both. Two forms. FILING (`subjectDid`, `knownByPersona`, `document`; no `contactId`) appends a revision, never overwrites, so a changed value is visible as a change rather than arriving silently — exactly as 1.0. ANNOTATING (`contactId`; no `subjectDid`, `knownByPersona`, `document` or `credentialRefs`) changes the holder's star, petname, lists, directory link or notes on an existing contact and appends no revision. In either form each annotation given replaces the stored one, each `removeX` removes one, and each annotation absent is unchanged. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId"
+  ],
+  "oneOf": [
+    {
+      "required": [
+        "subjectDid",
+        "knownByPersona",
+        "document"
+      ],
+      "not": {
+        "required": [
+          "contactId"
+        ]
+      }
+    },
+    {
+      "required": [
+        "contactId"
+      ],
+      "not": {
+        "anyOf": [
+          {
+            "required": [
+              "subjectDid"
+            ]
+          },
+          {
+            "required": [
+              "knownByPersona"
+            ]
+          },
+          {
+            "required": [
+              "document"
+            ]
+          },
+          {
+            "required": [
+              "credentialRefs"
+            ]
+          }
+        ]
+      },
+      "anyOf": [
+        {
+          "required": [
+            "starred"
+          ]
+        },
+        {
+          "required": [
+            "petname"
+          ]
+        },
+        {
+          "required": [
+            "removePetname"
+          ]
+        },
+        {
+          "required": [
+            "lists"
+          ]
+        },
+        {
+          "required": [
+            "removeLists"
+          ]
+        },
+        {
+          "required": [
+            "directoryRef"
+          ]
+        },
+        {
+          "required": [
+            "removeDirectoryRef"
+          ]
+        },
+        {
+          "required": [
+            "notes"
+          ]
+        },
+        {
+          "required": [
+            "removeNotes"
+          ]
+        }
+      ]
+    }
+  ],
+  "dependentSchemas": {
+    "removePetname": {
+      "not": {
+        "required": [
+          "petname"
+        ]
+      }
+    },
+    "removeLists": {
+      "not": {
+        "required": [
+          "lists"
+        ]
+      }
+    },
+    "removeDirectoryRef": {
+      "not": {
+        "required": [
+          "directoryRef"
+        ]
+      }
+    },
+    "removeNotes": {
+      "not": {
+        "required": [
+          "notes"
+        ]
+      }
+    }
+  },
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "contactId": {
+      "$ref": "#/$defs/Ulid",
+      "description": "Annotating form only: the existing contact whose annotations change. A filing never names one — the agent keys a filing on (contextId, subjectDid, knownByPersona) as in 1.0."
+    },
+    "subjectDid": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2048,
+      "description": "Filing form only. The DID the document is about, as disclosed. Normally pairwise, so it names this relationship and not the person across all of theirs."
+    },
+    "knownByPersona": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2048,
+      "description": "Filing form only. Which of the holder's personas knows this contact. A contact belongs to the relationship, not to the holder at large — the same peer met through two personas is two contacts, and collapsing them would correlate the holder's own personas in their own address book."
+    },
+    "document": {
+      "$ref": "#/$defs/ContactDocument"
+    },
+    "credentialRefs": {
+      "type": "array",
+      "maxItems": 256,
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "description": "Filing form only. Vault identifiers of credentials the peer presented alongside the document. The credentials themselves belong in the credential vault and the contact holds references."
+    },
+    "starred": {
+      "type": "boolean",
+      "description": "Star or unstar the contact. Absent: unchanged. A boolean rather than a remove member because `false` is a value the holder chose, not an absence."
+    },
+    "petname": {
+      "$ref": "#/$defs/Petname",
+      "description": "The holder's private name for the contact, replacing any they had. Absent: unchanged."
+    },
+    "removePetname": {
+      "type": "boolean",
+      "const": true,
+      "description": "Remove the petname. Only `true` is meaningful, so only `true` is accepted. A separate member rather than `petname: null`, because a nullable optional member makes \"unchanged\" and \"remove\" the same value in libraries that map both to one absent option."
+    },
+    "lists": {
+      "$ref": "#/$defs/ListIds",
+      "description": "The lists the contact is on, replacing the whole set. Every identifier MUST name a list in this context. Absent: unchanged. Take the contact off every list with `removeLists`."
+    },
+    "removeLists": {
+      "type": "boolean",
+      "const": true,
+      "description": "Take the contact off every list. Only `true` is accepted."
+    },
+    "directoryRef": {
+      "$ref": "#/$defs/DirectoryRef",
+      "description": "Link the contact to a community directory entry, replacing any link it had. Absent: unchanged."
+    },
+    "removeDirectoryRef": {
+      "type": "boolean",
+      "const": true,
+      "description": "Remove the contact's directory link. Only `true` is accepted."
+    },
+    "notes": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 4096,
+      "description": "The holder's private note about this contact, replacing any they had. Absent: unchanged. Never disclosed to anyone, including the contact."
+    },
+    "removeNotes": {
+      "type": "boolean",
+      "const": true,
+      "description": "Remove the note. Only `true` is accepted."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Contact Put — response payload",
+      "description": "Success response to persona/contact/put. Type https://trusttasks.org/spec/persona/contact/put/1.1#response. Identifiers, the current revision and what changed; no claim value and no annotation text is echoed.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contactId",
+        "rev",
+        "created",
+        "annotationsChanged"
+      ],
+      "properties": {
+        "contactId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "rev": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The contact's current revision: the one a filing just appended, or, for an annotating request, the revision that was already current. Annotations never move it."
+        },
+        "created": {
+          "type": "boolean",
+          "description": "True when this is the first revision for the subject. Always false for an annotating request."
+        },
+        "annotationsChanged": {
+          "type": "boolean",
+          "description": "True when any annotation now differs from what was stored. False when every annotation given already matched and every one named for removal was already absent — including a filing that named none."
+        },
+        "changedClaims": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "$ref": "#/$defs/ClaimType"
+          },
+          "description": "Claim types whose value differs from the previous revision. Present only on a filing that updated an existing contact."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "ClaimType": {
+      "title": "ClaimType",
+      "description": "The vocabulary token naming what a value IS — `name.legal`, `phone.mobile`, `address.postal`, `person.birthDate`. Dotted, most-general segment first, so that a consumer with no knowledge of the specific token can still group by its prefix.\n\nThe token is the maintainer's own; no external vocabulary is primary. External vocabularies (vCard/jCard, OIDC standard claims, schema.org) are mappings applied at PRESENTATION by a renderer, not at rest, so that a query written in any of them can be matched without the store having to live inside any one of them.\n\nThe `x:` prefix is an open extension namespace and is not decoration. The closest prior art — Windows CardSpace's self-issued card — supported exactly fifteen predefined claim types with no extensibility, and that is the specific way it failed the requirement a holder actually has. An `x:` attribute stores, composes, binds and discloses exactly like a known one; it renders generically and matches only an explicit query.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$"
+    },
+    "Ulid": {
+      "title": "Ulid",
+      "description": "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.",
+      "type": "string",
+      "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+    },
+    "DirectoryRef": {
+      "title": "DirectoryRef",
+      "description": "Links a contact to the entry in a community's member directory it corresponds to, so the holder's own client can join that community's directory with the holder's address book — showing a star or a petname beside an entry — without either side telling the other. The community never learns the link exists; the contact never learns it either. A contact has at most one.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "vtcDid",
+        "entryId"
+      ],
+      "properties": {
+        "vtcDid": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "pattern": "^did:[a-z0-9]+:",
+          "description": "The DID of the community whose directory holds the entry."
+        },
+        "entryId": {
+          "$ref": "#/$defs/DirectoryEntryId",
+          "description": "The entry, as that community's directory identifies it."
+        }
+      }
+    },
+    "DirectoryEntryId": {
+      "title": "DirectoryEntryId",
+      "description": "A community directory entry's identifier, exactly as that community's directory returned it. Opaque and community-scoped: the agent stores and compares it as a string, never parses it, and never treats the same value under two communities as the same entry.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9_-]+$"
+    },
+    "ListIds": {
+      "title": "ListIds",
+      "description": "The lists a contact is on, as a set: order carries no meaning. A contact on no list has no `lists` member, never an empty array, so there is one way to say \"none\".",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 64,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/ListId"
+      }
+    },
+    "ListId": {
+      "title": "ListId",
+      "description": "Identifier of one of the holder's contact lists: a ULID in Crockford base32, uppercase, assigned by the agent when the list is created. Meaningful only inside the context that holds the list; it is never sent to anyone but the holder's own clients.",
+      "type": "string",
+      "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+    },
+    "Petname": {
+      "title": "Petname",
+      "description": "The holder's private name for a contact, on one line: no control characters, line breaks included. A petname in Zooko's sense — chosen by the holder, meaningful to the holder, and unforgeable by anyone else, because nobody else can write it. Distinct from the contact's own disclosed `nickname` or display name, which the contact chose and may change. Compared exactly, as a string: an agent does not case-fold or normalise it.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^[^\\u0000-\\u001F\\u007F]+$"
+    },
+    "ContactDocument": {
+      "title": "ContactDocument",
+      "description": "What a peer disclosed, as received. Structurally the same claim set a holder composes and presents — a profile and a contact card are one schema seen from two sides — which is why a maintainer validates both with the same code and a consumer renders both with the same view.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "claims"
+      ],
+      "properties": {
+        "publisher": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "The DID that published the document, as it appeared. Normally a pairwise identifier, so it names the relationship rather than the person."
+        },
+        "cardVersion": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The publisher's own monotonic counter, if they supplied one. Advisory: it orders the publisher's revisions relative to each other and MUST NOT be trusted to order them against anything else."
+        },
+        "claims": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "type",
+              "valueType",
+              "value"
+            ],
+            "properties": {
+              "type": {
+                "$ref": "#/$defs/ClaimType"
+              },
+              "valueType": {
+                "$ref": "#/$defs/ValueType"
+              },
+              "value": {},
+              "provenance": {
+                "$ref": "#/$defs/Provenance",
+                "description": "As asserted by the publisher. A recipient MUST NOT treat a claimed credentialBacked provenance as verified — it is a statement about what the publisher says backs the claim, and verification is a separate act against the credential itself."
+              }
+            }
+          }
+        }
+      }
+    },
+    "Provenance": {
+      "title": "Provenance",
+      "description": "Where a value comes from, and the member that makes this family worth building on a trust stack rather than in an address book. It survives to the verifier, so a recipient can tell — per field — what the holder typed from what an issuer attested.\n\n`selfAsserted` — the holder supplied it.\n\n`credentialBacked` — the value is derived from a credential in the vault at `claimPath`. The stored value is a CACHE FOR DISPLAY; the credential is the truth. A maintainer MUST re-derive it on read and MUST fail closed (never presenting a stale value) when the credential has been revoked, has expired, or has been archived or deleted.\n\n`generated` — the value is minted per verifier at disclosure time and recorded against that verifier, so every relying party receives a different one that routes back to the holder. This is the shape of the most widely adopted consumer privacy feature in this space; a maintainer need not operate a relay to conform, but the shape must exist, because retrofitting per-verifier values into a pool-of-values model is a migration rather than an addition.\n\n`derived` — the value was taken from a source the holder connected or supplied — a code-hosting profile, an uploaded CV — rather than typed by them or attested by an issuer. Nobody signed it: it is the holder's claim that the source said so, and a consumer MUST NOT present it as attested. It exists as its own kind because a derived value is neither of the others — the holder did not author it, and no one vouches for it — and a holder deciding whether to disclose deserves to know which of their values they typed.\n\nFor how strongly a disclosed value identifies the holder, the kinds rank `credentialBacked` above `derived` above `selfAsserted`; `generated` values are per-verifier and do not correlate.",
+      "type": "object",
+      "required": [
+        "kind"
+      ],
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "required": [
+            "kind"
+          ],
+          "properties": {
+            "kind": {
+              "const": "selfAsserted"
+            }
+          }
+        },
+        {
+          "additionalProperties": false,
+          "required": [
+            "kind",
+            "credentialId",
+            "claimPath"
+          ],
+          "properties": {
+            "kind": {
+              "const": "credentialBacked"
+            },
+            "credentialId": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Vault identifier of the backing credential."
+            },
+            "claimPath": {
+              "type": "string",
+              "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$",
+              "description": "RFC 6901 JSON Pointer to the claim within the credential, e.g. `/credentialSubject/familyName`."
+            },
+            "issuerDid": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Issuer of the backing credential. Advisory: a consumer MUST verify the credential rather than trusting this member."
+            },
+            "proof": {
+              "$ref": "#/$defs/ProofRung",
+              "description": "The disclosure rung this claim was, or will be, presented at."
+            }
+          }
+        },
+        {
+          "additionalProperties": false,
+          "required": [
+            "kind",
+            "generator"
+          ],
+          "properties": {
+            "kind": {
+              "const": "generated"
+            },
+            "generator": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 64,
+              "description": "Names the minting scheme, e.g. `relayEmail`. Maintainer-defined."
+            },
+            "perVerifier": {
+              "type": "boolean",
+              "default": true,
+              "description": "When true (the default and the only useful setting), a distinct value is minted for each verifier."
+            }
+          }
+        },
+        {
+          "additionalProperties": false,
+          "required": [
+            "kind",
+            "source",
+            "derivedAt"
+          ],
+          "properties": {
+            "kind": {
+              "const": "derived"
+            },
+            "source": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 64,
+              "pattern": "^[a-z][A-Za-z0-9.-]*$",
+              "description": "The KIND of source the value was taken from — `github`, `cvUpload`, `linkedIn` — never an account, handle or URL. Provenance survives to the verifier, so this member is disclosed with the claim; a handle here would disclose an identifier the holder never chose to share."
+            },
+            "derivedAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "When the value was taken from the source. A derived value is a snapshot: the source may have changed since, and nothing re-derives it."
+            }
+          }
+        }
+      ]
+    },
+    "ProofRung": {
+      "title": "ProofRung",
+      "description": "How strongly a credential-backed claim is hidden when presented, ordered most private first. `predicate` proves a statement over a claim without disclosing the claim. `derived` discloses exactly the claims needed via an unlinkable derived proof, so two presentations cannot be joined. `selectiveDisclosure` discloses exactly the claims needed but carries the issuer's signature unchanged, so two presentations ARE linkable. `whole` discloses the entire credential.\n\nThe distinction between the first two and the last two is of kind, not degree: only `predicate` and `derived` avoid handing two verifiers a join key. A maintainer MUST default to the highest rung the credential's format supports, and MUST NOT silently fall to a lower one — a request that cannot be satisfied at the rung a producer asked for is refused, because a silent privacy downgrade discloses material the holder believed was hidden.",
+      "type": "string",
+      "enum": [
+        "predicate",
+        "derived",
+        "selectiveDisclosure",
+        "whole"
+      ]
+    },
+    "ValueType": {
+      "title": "ValueType",
+      "description": "The JSON shape of `value`, declared so that a consumer can render and compare without guessing. The maintainer validates that `value` agrees with this member and does nothing further: it does NOT validate a phone number against a phone-number grammar. That is a producer's affordance, and a store that grows opinions about the contents of its records eventually blocks its consumer's release.",
+      "type": "string",
+      "enum": [
+        "string",
+        "number",
+        "boolean",
+        "date",
+        "object"
+      ]
+    }
+  }
+} 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": "Persona Contact Put — response payload",
+      "description": "Success response to persona/contact/put. Type https://trusttasks.org/spec/persona/contact/put/1.1#response. Identifiers, the current revision and what changed; no claim value and no annotation text is echoed.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contactId",
+        "rev",
+        "created",
+        "annotationsChanged"
+      ],
+      "properties": {
+        "contactId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "rev": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The contact's current revision: the one a filing just appended, or, for an annotating request, the revision that was already current. Annotations never move it."
+        },
+        "created": {
+          "type": "boolean",
+          "description": "True when this is the first revision for the subject. Always false for an annotating request."
+        },
+        "annotationsChanged": {
+          "type": "boolean",
+          "description": "True when any annotation now differs from what was stored. False when every annotation given already matched and every one named for removal was already absent — including a filing that named none."
+        },
+        "changedClaims": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "$ref": "#/$defs/ClaimType"
+          },
+          "description": "Claim types whose value differs from the previous revision. Present only on a filing that updated an existing contact."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "ClaimType": {
+      "title": "ClaimType",
+      "description": "The vocabulary token naming what a value IS — `name.legal`, `phone.mobile`, `address.postal`, `person.birthDate`. Dotted, most-general segment first, so that a consumer with no knowledge of the specific token can still group by its prefix.\n\nThe token is the maintainer's own; no external vocabulary is primary. External vocabularies (vCard/jCard, OIDC standard claims, schema.org) are mappings applied at PRESENTATION by a renderer, not at rest, so that a query written in any of them can be matched without the store having to live inside any one of them.\n\nThe `x:` prefix is an open extension namespace and is not decoration. The closest prior art — Windows CardSpace's self-issued card — supported exactly fifteen predefined claim types with no extensibility, and that is the specific way it failed the requirement a holder actually has. An `x:` attribute stores, composes, binds and discloses exactly like a known one; it renders generically and matches only an explicit query.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$"
+    },
+    "Ulid": {
+      "title": "Ulid",
+      "description": "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.",
+      "type": "string",
+      "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+    },
+    "DirectoryRef": {
+      "title": "DirectoryRef",
+      "description": "Links a contact to the entry in a community's member directory it corresponds to, so the holder's own client can join that community's directory with the holder's address book — showing a star or a petname beside an entry — without either side telling the other. The community never learns the link exists; the contact never learns it either. A contact has at most one.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "vtcDid",
+        "entryId"
+      ],
+      "properties": {
+        "vtcDid": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "pattern": "^did:[a-z0-9]+:",
+          "description": "The DID of the community whose directory holds the entry."
+        },
+        "entryId": {
+          "$ref": "#/$defs/DirectoryEntryId",
+          "description": "The entry, as that community's directory identifies it."
+        }
+      }
+    },
+    "DirectoryEntryId": {
+      "title": "DirectoryEntryId",
+      "description": "A community directory entry's identifier, exactly as that community's directory returned it. Opaque and community-scoped: the agent stores and compares it as a string, never parses it, and never treats the same value under two communities as the same entry.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9_-]+$"
+    },
+    "ListIds": {
+      "title": "ListIds",
+      "description": "The lists a contact is on, as a set: order carries no meaning. A contact on no list has no `lists` member, never an empty array, so there is one way to say \"none\".",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 64,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/ListId"
+      }
+    },
+    "ListId": {
+      "title": "ListId",
+      "description": "Identifier of one of the holder's contact lists: a ULID in Crockford base32, uppercase, assigned by the agent when the list is created. Meaningful only inside the context that holds the list; it is never sent to anyone but the holder's own clients.",
+      "type": "string",
+      "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+    },
+    "Petname": {
+      "title": "Petname",
+      "description": "The holder's private name for a contact, on one line: no control characters, line breaks included. A petname in Zooko's sense — chosen by the holder, meaningful to the holder, and unforgeable by anyone else, because nobody else can write it. Distinct from the contact's own disclosed `nickname` or display name, which the contact chose and may change. Compared exactly, as a string: an agent does not case-fold or normalise it.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^[^\\u0000-\\u001F\\u007F]+$"
+    },
+    "ContactDocument": {
+      "title": "ContactDocument",
+      "description": "What a peer disclosed, as received. Structurally the same claim set a holder composes and presents — a profile and a contact card are one schema seen from two sides — which is why a maintainer validates both with the same code and a consumer renders both with the same view.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "claims"
+      ],
+      "properties": {
+        "publisher": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "The DID that published the document, as it appeared. Normally a pairwise identifier, so it names the relationship rather than the person."
+        },
+        "cardVersion": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The publisher's own monotonic counter, if they supplied one. Advisory: it orders the publisher's revisions relative to each other and MUST NOT be trusted to order them against anything else."
+        },
+        "claims": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "type",
+              "valueType",
+              "value"
+            ],
+            "properties": {
+              "type": {
+                "$ref": "#/$defs/ClaimType"
+              },
+              "valueType": {
+                "$ref": "#/$defs/ValueType"
+              },
+              "value": {},
+              "provenance": {
+                "$ref": "#/$defs/Provenance",
+                "description": "As asserted by the publisher. A recipient MUST NOT treat a claimed credentialBacked provenance as verified — it is a statement about what the publisher says backs the claim, and verification is a separate act against the credential itself."
+              }
+            }
+          }
+        }
+      }
+    },
+    "Provenance": {
+      "title": "Provenance",
+      "description": "Where a value comes from, and the member that makes this family worth building on a trust stack rather than in an address book. It survives to the verifier, so a recipient can tell — per field — what the holder typed from what an issuer attested.\n\n`selfAsserted` — the holder supplied it.\n\n`credentialBacked` — the value is derived from a credential in the vault at `claimPath`. The stored value is a CACHE FOR DISPLAY; the credential is the truth. A maintainer MUST re-derive it on read and MUST fail closed (never presenting a stale value) when the credential has been revoked, has expired, or has been archived or deleted.\n\n`generated` — the value is minted per verifier at disclosure time and recorded against that verifier, so every relying party receives a different one that routes back to the holder. This is the shape of the most widely adopted consumer privacy feature in this space; a maintainer need not operate a relay to conform, but the shape must exist, because retrofitting per-verifier values into a pool-of-values model is a migration rather than an addition.\n\n`derived` — the value was taken from a source the holder connected or supplied — a code-hosting profile, an uploaded CV — rather than typed by them or attested by an issuer. Nobody signed it: it is the holder's claim that the source said so, and a consumer MUST NOT present it as attested. It exists as its own kind because a derived value is neither of the others — the holder did not author it, and no one vouches for it — and a holder deciding whether to disclose deserves to know which of their values they typed.\n\nFor how strongly a disclosed value identifies the holder, the kinds rank `credentialBacked` above `derived` above `selfAsserted`; `generated` values are per-verifier and do not correlate.",
+      "type": "object",
+      "required": [
+        "kind"
+      ],
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "required": [
+            "kind"
+          ],
+          "properties": {
+            "kind": {
+              "const": "selfAsserted"
+            }
+          }
+        },
+        {
+          "additionalProperties": false,
+          "required": [
+            "kind",
+            "credentialId",
+            "claimPath"
+          ],
+          "properties": {
+            "kind": {
+              "const": "credentialBacked"
+            },
+            "credentialId": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Vault identifier of the backing credential."
+            },
+            "claimPath": {
+              "type": "string",
+              "pattern": "^(/[^/~]*(~[01][^/~]*)*)*$",
+              "description": "RFC 6901 JSON Pointer to the claim within the credential, e.g. `/credentialSubject/familyName`."
+            },
+            "issuerDid": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Issuer of the backing credential. Advisory: a consumer MUST verify the credential rather than trusting this member."
+            },
+            "proof": {
+              "$ref": "#/$defs/ProofRung",
+              "description": "The disclosure rung this claim was, or will be, presented at."
+            }
+          }
+        },
+        {
+          "additionalProperties": false,
+          "required": [
+            "kind",
+            "generator"
+          ],
+          "properties": {
+            "kind": {
+              "const": "generated"
+            },
+            "generator": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 64,
+              "description": "Names the minting scheme, e.g. `relayEmail`. Maintainer-defined."
+            },
+            "perVerifier": {
+              "type": "boolean",
+              "default": true,
+              "description": "When true (the default and the only useful setting), a distinct value is minted for each verifier."
+            }
+          }
+        },
+        {
+          "additionalProperties": false,
+          "required": [
+            "kind",
+            "source",
+            "derivedAt"
+          ],
+          "properties": {
+            "kind": {
+              "const": "derived"
+            },
+            "source": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 64,
+              "pattern": "^[a-z][A-Za-z0-9.-]*$",
+              "description": "The KIND of source the value was taken from — `github`, `cvUpload`, `linkedIn` — never an account, handle or URL. Provenance survives to the verifier, so this member is disclosed with the claim; a handle here would disclose an identifier the holder never chose to share."
+            },
+            "derivedAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "When the value was taken from the source. A derived value is a snapshot: the source may have changed since, and nothing re-derives it."
+            }
+          }
+        }
+      ]
+    },
+    "ProofRung": {
+      "title": "ProofRung",
+      "description": "How strongly a credential-backed claim is hidden when presented, ordered most private first. `predicate` proves a statement over a claim without disclosing the claim. `derived` discloses exactly the claims needed via an unlinkable derived proof, so two presentations cannot be joined. `selectiveDisclosure` discloses exactly the claims needed but carries the issuer's signature unchanged, so two presentations ARE linkable. `whole` discloses the entire credential.\n\nThe distinction between the first two and the last two is of kind, not degree: only `predicate` and `derived` avoid handing two verifiers a join key. A maintainer MUST default to the highest rung the credential's format supports, and MUST NOT silently fall to a lower one — a request that cannot be satisfied at the rung a producer asked for is refused, because a silent privacy downgrade discloses material the holder believed was hidden.",
+      "type": "string",
+      "enum": [
+        "predicate",
+        "derived",
+        "selectiveDisclosure",
+        "whole"
+      ]
+    },
+    "ValueType": {
+      "title": "ValueType",
+      "description": "The JSON shape of `value`, declared so that a consumer can render and compare without guessing. The maintainer validates that `value` agrees with this member and does nothing further: it does NOT validate a phone number against a phone-number grammar. That is a producer's affordance, and a store that grows opinions about the contents of its records eventually blocks its consumer's release.",
+      "type": "string",
+      "enum": [
+        "string",
+        "number",
+        "boolean",
+        "date",
+        "object"
+      ]
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;