@openvtc/trust-tasks 0.28.1 → 0.28.3

package/dist/vta/dids/update/1.0/payload.js

@@ -0,0 +1,861 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/dids/update/1.0/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/dids/update/1.0";
+/**
+ * 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 = 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 = null;
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/dids/update/1.0#response";
+/**
+ * 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/vta/dids/update/1.0",
+    "title": "VTA DIDs — Update — payload",
+    "description": "Ask a Verifiable Trust Agent to change a key-role identity's non-key members — services, `alsoKnownAs`, method parameters such as witnesses. Keys change only through the key-role tasks (vta/dids/_shared/0.1/CONVENTIONS.md).",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "did"
+    ],
+    "properties": {
+        "did": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The key-role identity, by DID (for a `did:scid` identity, the DID without `src`)."
+        },
+        "document": {
+            "type": "object",
+            "description": "The new identifier document, for methods whose controller writes it. Omit to leave it unchanged. It MUST carry, unchanged, `verificationMethod`, every verification relationship and `keyRoles`: a change to any of them is refused with `vta/dids/update:keyMembersManaged`, because keys change only through the key-role tasks."
+        },
+        "methodParameters": {
+            "type": "object",
+            "description": "Validated against the method profile's `UpdateParameters` schema (method-profiles/<method>-parameters.schema.json); a member it does not define, or one fixed at creation, is refused with `vta/dids:methodParameterUnsupported`."
+        },
+        "label": {
+            "type": "string",
+            "maxLength": 256,
+            "description": "Operator-facing audit label."
+        },
+        "expectedVersionId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Optimistic-concurrency precondition: the version identifier (method profile §3) the caller based this change on, for example `keys/list`'s `versionId`. The VTA MUST refuse with `vta/dids:versionConflict` if the identity has moved past it. Not optional for anything a person looked at."
+        },
+        "dryRun": {
+            "type": "boolean",
+            "description": "Compute and return the preview without writing anything but the plan (CONVENTIONS.md §6.1). Absent reads as false."
+        },
+        "previewId": {
+            "type": "string",
+            "minLength": 16,
+            "description": "Apply exactly the plan a previous dry run of this same request returned, or nothing (CONVENTIONS.md §6.1); what every approval is bound to."
+        },
+        "reason": {
+            "type": "string",
+            "maxLength": 1024,
+            "description": "Why the change is being made, for the audit trail and for the other approvers. Never published."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA DIDs — Update — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "did",
+                "outcome"
+            ],
+            "properties": {
+                "did": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "outcome": {
+                    "$ref": "#/$defs/KeyChangeOutcome"
+                },
+                "preview": {
+                    "$ref": "#/$defs/IdentityChangePreview",
+                    "description": "Present when `outcome` is `preview`, `pendingApproval` or `awaitingRecoveryProof`: the plan, and what an approval is bound to."
+                },
+                "approvals": {
+                    "$ref": "#/$defs/KeyChangeApprovalState",
+                    "description": "Present when `outcome` is `pendingApproval`."
+                },
+                "newVersionId": {
+                    "type": "string",
+                    "description": "Present when `outcome` is `applied`: the version identifier of the change. Pass it as the next change's `expectedVersionId`."
+                },
+                "publication": {
+                    "$ref": "#/$defs/Publication",
+                    "description": "Present when `outcome` is `applied`."
+                },
+                "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-]+)+$"
+            }
+        },
+        "Publication": {
+            "title": "Publication",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "selfPublish"
+            ],
+            "description": "How the change reaches resolvers.",
+            "properties": {
+                "selfPublish": {
+                    "type": "boolean",
+                    "description": "True when no hosting service holds the identifier for the VTA: the caller must publish `artifacts`, and until it does resolvers see the previous version."
+                },
+                "artifacts": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PublishedArtifact"
+                    },
+                    "description": "Present when `selfPublish` is true."
+                }
+            }
+        },
+        "PublishedArtifact": {
+            "title": "PublishedArtifact",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "name",
+                "mediaType",
+                "content"
+            ],
+            "description": "A file the identifier's method publishes, as the method profile names it (`did.jsonl` for did:webvh, `did.json` and `keri.cesr` for did:webs).",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128
+                },
+                "mediaType": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "content": {
+                    "type": "string",
+                    "description": "The artefact's content, or for an append-only artefact the appended part, as text."
+                }
+            }
+        },
+        "KeyChangeApprovalState": {
+            "title": "KeyChangeApprovalState",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "required",
+                "received",
+                "expiresAt"
+            ],
+            "description": "Approval progress of a change the VTA's policy gates on approvals (CONVENTIONS.md §6).",
+            "properties": {
+                "required": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "description": "Distinct approvals the VTA's policy requires."
+                },
+                "received": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Distinct approvals recorded so far, the initiator's own included."
+                },
+                "approvals": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/RecordedApproval"
+                    },
+                    "description": "The approvals recorded. Custody projection only; omitted from a response to anyone who is not themselves an eligible approver of this change."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the preview, and every approval bound to it, stops being usable."
+                }
+            }
+        },
+        "RecordedApproval": {
+            "title": "RecordedApproval",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "approver",
+                "evidence"
+            ],
+            "properties": {
+                "approver": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "VID of the approver."
+                },
+                "evidence": {
+                    "$ref": "#/$defs/ApprovalEvidenceKind"
+                },
+                "recordedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        },
+        "ApprovalEvidenceKind": {
+            "title": "ApprovalEvidenceKind",
+            "type": "string",
+            "enum": [
+                "didSigned",
+                "webauthn",
+                "approverSigned"
+            ],
+            "description": "The evidence an approval was recorded on, as `auth/step-up/approve-response` names it. Only the approver's own evidence is ever recorded: a proof by a key the VTA records as acting for an approver — a console signing key or any other delegation — is never an approval (CONVENTIONS.md §6.3)."
+        },
+        "IdentityChangePreview": {
+            "title": "IdentityChangePreview",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "previewId",
+                "method",
+                "expiresAt",
+                "changes",
+                "document",
+                "updateKeyRotates"
+            ],
+            "description": "What a change would publish, computed by the VTA by running the handler it would run to apply it (CONVENTIONS.md §6.1). This is what a consent surface renders and what an approval is bound to.",
+            "properties": {
+                "previewId": {
+                    "type": "string",
+                    "minLength": 16,
+                    "description": "Opaque, unguessable identifier of this exact plan. Carried back by the apply request; every approval and any recovery proof is bound to it."
+                },
+                "method": {
+                    "$ref": "#/$defs/DidMethodName"
+                },
+                "baseVersionId": {
+                    "type": "string",
+                    "description": "The version identifier the plan was computed against. Absent only for a creation. The plan is void once the identifier moves past it."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "changes": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/IdentityChange"
+                    },
+                    "description": "Every change the plan would make, including the ones the caller did not ask for — in particular any movement of the update authority the method requires."
+                },
+                "document": {
+                    "type": "object",
+                    "description": "The complete identifier document the change would publish, `keyRoles` included. Public data by construction."
+                },
+                "warnings": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PreviewWarning"
+                    },
+                    "uniqueItems": true
+                },
+                "updateKeyRotates": {
+                    "type": "boolean",
+                    "description": "True when applying the plan also moves the identifier's update authority to a committed successor — every change under did:webvh pre-rotation, never a KERI interaction event. Stated as its own member because it is the consequence a reviewer most often misses."
+                },
+                "recoverySigning": {
+                    "$ref": "#/$defs/RecoverySigningRequest"
+                }
+            }
+        },
+        "RecoverySigningRequest": {
+            "title": "RecoverySigningRequest",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "commitment",
+                "keyType",
+                "unsignedChange",
+                "proofOptions"
+            ],
+            "description": "What a recovery custodian must sign for a change that only the recovery key may authorize (CONVENTIONS.md §5.4, §9.4). The custodian MUST check `unsignedChange` itself — render it to its human, confirm that it reveals the recovery key it holds and commits to a fresh recovery key it also holds — and MUST NOT sign on the strength of this request's description alone.",
+            "properties": {
+                "commitment": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The recovery commitment the identifier publishes; the custodian's key MUST be the one it commits to."
+                },
+                "keyType": {
+                    "$ref": "#/$defs/KeyType"
+                },
+                "unsignedChange": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The change exactly as it will be published, without the recovery proof, as JSON text in the method's own form (a did:webvh log entry, a KERI rotation event)."
+                },
+                "proofOptions": {
+                    "type": "object",
+                    "description": "The proof the method requires over `unsignedChange`, without its signature value, as the method profile defines it (for did:webvh, a Data Integrity proof configuration with `proofPurpose: assertionMethod` and the recovery key's `did:key` as `verificationMethod`)."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        },
+        "KeyType": {
+            "title": "KeyType",
+            "type": "string",
+            "enum": [
+                "ed25519",
+                "x25519",
+                "p256",
+                "mldsa44",
+                "mldsa65"
+            ],
+            "description": "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support."
+        },
+        "PreviewWarning": {
+            "title": "PreviewWarning",
+            "type": "string",
+            "enum": [
+                "singleKeyRole",
+                "algorithmNotInAcceptedSet",
+                "roleWillHaveNoClassicalKey",
+                "attestationReissuanceRequired",
+                "selfPublish",
+                "noWitnesses",
+                "protectionBelowPolicy",
+                "recoveryKeyRevealed"
+            ],
+            "description": "Conditions a human should be shown before approving. `singleKeyRole` — the role will hold one active key. `algorithmNotInAcceptedSet` — a verifier population the VTA knows of does not accept the new key's algorithm. `roleWillHaveNoClassicalKey` — every remaining key is post-quantum. `attestationReissuanceRequired` — revoking this attestation key obliges re-issuance and re-signed status lists (VTI-KEY-133). `selfPublish` — the VTA will not publish the change; the operator must. `noWitnesses` — the identifier has no witnesses, so a party holding the VTA's routine update key can drop the recovery commitment unobserved (CONVENTIONS.md §5.3). `protectionBelowPolicy` — a key will be held at a `ProtectionClass` below what the VTA's policy recommends for its role (a plain VTA holding an attestation key). `recoveryKeyRevealed` — this change uses the recovery key, which must be replaced by a fresh recovery commitment in the same change."
+        },
+        "IdentityChange": {
+            "title": "IdentityChange",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "op",
+                "role"
+            ],
+            "properties": {
+                "op": {
+                    "type": "string",
+                    "enum": [
+                        "addKey",
+                        "retireKey",
+                        "revokeKey",
+                        "rotateUpdateKey",
+                        "commitUpdateKey",
+                        "replaceRecoveryCommitment",
+                        "useRecoveryKey"
+                    ],
+                    "description": "`addKey` — a verification method joins its role's relationship and `keyRoles`. `retireKey` — a verification method leaves its relationship, `keyRoles` and the document. `revokeKey` — a verification method leaves its relationship and `keyRoles`, and stays in `verificationMethod` with `revoked` set to the compromise time (CONVENTIONS.md §9.1). `rotateUpdateKey` — the identifier's update authority moves to a committed routine successor. `commitUpdateKey` — a new routine successor is committed. `replaceRecoveryCommitment` — the recovery commitment changes. `useRecoveryKey` — the change is authorized by the recovery key, which the identifier then reveals."
+                },
+                "role": {
+                    "$ref": "#/$defs/IdentityKeyRole"
+                },
+                "verificationMethod": {
+                    "type": "string"
+                },
+                "keyType": {
+                    "$ref": "#/$defs/KeyType"
+                },
+                "publicKeyMultibase": {
+                    "type": "string"
+                },
+                "commitment": {
+                    "type": "string"
+                },
+                "relationships": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/DidVerificationRelationship"
+                    },
+                    "uniqueItems": true
+                }
+            }
+        },
+        "DidVerificationRelationship": {
+            "title": "DidVerificationRelationship",
+            "type": "string",
+            "enum": [
+                "authentication",
+                "assertionMethod",
+                "keyAgreement",
+                "capabilityInvocation",
+                "capabilityDelegation"
+            ],
+            "description": "A DID Core verification relationship."
+        },
+        "IdentityKeyRole": {
+            "title": "IdentityKeyRole",
+            "type": "string",
+            "enum": [
+                "attestation",
+                "operational",
+                "messaging",
+                "update",
+                "authenticator"
+            ],
+            "description": "The named key role a key occupies in an identity (CONVENTIONS.md §2; VTI-KEY-070 onward). `attestation` — the only keys in `assertionMethod`; sign the identity's attestation artefacts (credentials, endorsements, status lists) through the VTA's signing service and nowhere else. Generated inside the VTA, never derived, never exportable, never in a backup. `operational` — the only keys the identity's own process uses in `authentication`; sign the node's own traffic (Trust Task requests and responses, DIDComm and TSP signatures, invitations, notices, audit checkpoints). Derived. `messaging` — the only keys in `keyAgreement`; sign nothing. X25519, derived or generated in its own right and never converted from a signing key. `update` — the identifier's change authority as its DID method states it (a did:webvh log's `updateKeys` and `nextKeyHashes`, a KERI key event log's current and next keys); never a role-bound verification method, never in `keyRoles`. Generated inside the VTA, never derived, never exportable, never in a backup, and always accompanied by a committed recovery key held outside the VTA's protection boundary. `authenticator` — a key held on a person's own authenticator (a WebAuthn passkey), listed in `authentication` of that person's identity only; used only to verify the person's WebAuthn assertions (sign-in and step-up evidence) and never to accept a Data Integrity proof. The VTA never holds its private half, so it is enrolled by the passkey ceremony and never generated, added or rotated by these tasks. Never permitted on the durable identity of a VTA, a VTC or a VTN. No role permits `capabilityInvocation` or `capabilityDelegation` (VTI-KEY-075). The set is an extensible registry: a consumer that meets a role it does not implement MUST rely on the key for nothing, and MUST NOT map it onto a role it does know (VTI-KEY-074)."
+        },
+        "DidMethodName": {
+            "title": "DidMethodName",
+            "type": "string",
+            "pattern": "^[a-z0-9]+(:[a-z0-9]+)*$",
+            "description": "The DID method an identity uses, as the method profile that governs it is named: `webvh` for a did:webvh identity, `scid:vh` for the did:scid:vh:1 form of one, `webs` for did:webs. Deliberately a pattern and not an enumeration: a method is added by publishing its profile under method-profiles/, never by changing this schema. A VTA MUST refuse a method it holds no profile for, or whose profile declares it ineligible, with `vta/dids:methodNotEligible`."
+        },
+        "KeyChangeOutcome": {
+            "title": "KeyChangeOutcome",
+            "type": "string",
+            "enum": [
+                "preview",
+                "applied",
+                "pendingApproval",
+                "awaitingRecoveryProof"
+            ],
+            "description": "`preview` — nothing was written; the response carries the plan. `applied` — the change was made (and published, unless `publication.selfPublish`). `pendingApproval` — the plan is recorded and awaits further approvals. `awaitingRecoveryProof` — the plan is approved and waits for the recovery custodian's proof (`preview.recoverySigning`); nothing is published until it arrives."
+        }
+    }
+};
+/** 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": "VTA DIDs — Update — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "did",
+                "outcome"
+            ],
+            "properties": {
+                "did": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "outcome": {
+                    "$ref": "#/$defs/KeyChangeOutcome"
+                },
+                "preview": {
+                    "$ref": "#/$defs/IdentityChangePreview",
+                    "description": "Present when `outcome` is `preview`, `pendingApproval` or `awaitingRecoveryProof`: the plan, and what an approval is bound to."
+                },
+                "approvals": {
+                    "$ref": "#/$defs/KeyChangeApprovalState",
+                    "description": "Present when `outcome` is `pendingApproval`."
+                },
+                "newVersionId": {
+                    "type": "string",
+                    "description": "Present when `outcome` is `applied`: the version identifier of the change. Pass it as the next change's `expectedVersionId`."
+                },
+                "publication": {
+                    "$ref": "#/$defs/Publication",
+                    "description": "Present when `outcome` is `applied`."
+                },
+                "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-]+)+$"
+            }
+        },
+        "Publication": {
+            "title": "Publication",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "selfPublish"
+            ],
+            "description": "How the change reaches resolvers.",
+            "properties": {
+                "selfPublish": {
+                    "type": "boolean",
+                    "description": "True when no hosting service holds the identifier for the VTA: the caller must publish `artifacts`, and until it does resolvers see the previous version."
+                },
+                "artifacts": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PublishedArtifact"
+                    },
+                    "description": "Present when `selfPublish` is true."
+                }
+            }
+        },
+        "PublishedArtifact": {
+            "title": "PublishedArtifact",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "name",
+                "mediaType",
+                "content"
+            ],
+            "description": "A file the identifier's method publishes, as the method profile names it (`did.jsonl` for did:webvh, `did.json` and `keri.cesr` for did:webs).",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128
+                },
+                "mediaType": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "content": {
+                    "type": "string",
+                    "description": "The artefact's content, or for an append-only artefact the appended part, as text."
+                }
+            }
+        },
+        "KeyChangeApprovalState": {
+            "title": "KeyChangeApprovalState",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "required",
+                "received",
+                "expiresAt"
+            ],
+            "description": "Approval progress of a change the VTA's policy gates on approvals (CONVENTIONS.md §6).",
+            "properties": {
+                "required": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "description": "Distinct approvals the VTA's policy requires."
+                },
+                "received": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Distinct approvals recorded so far, the initiator's own included."
+                },
+                "approvals": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/RecordedApproval"
+                    },
+                    "description": "The approvals recorded. Custody projection only; omitted from a response to anyone who is not themselves an eligible approver of this change."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the preview, and every approval bound to it, stops being usable."
+                }
+            }
+        },
+        "RecordedApproval": {
+            "title": "RecordedApproval",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "approver",
+                "evidence"
+            ],
+            "properties": {
+                "approver": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "VID of the approver."
+                },
+                "evidence": {
+                    "$ref": "#/$defs/ApprovalEvidenceKind"
+                },
+                "recordedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        },
+        "ApprovalEvidenceKind": {
+            "title": "ApprovalEvidenceKind",
+            "type": "string",
+            "enum": [
+                "didSigned",
+                "webauthn",
+                "approverSigned"
+            ],
+            "description": "The evidence an approval was recorded on, as `auth/step-up/approve-response` names it. Only the approver's own evidence is ever recorded: a proof by a key the VTA records as acting for an approver — a console signing key or any other delegation — is never an approval (CONVENTIONS.md §6.3)."
+        },
+        "IdentityChangePreview": {
+            "title": "IdentityChangePreview",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "previewId",
+                "method",
+                "expiresAt",
+                "changes",
+                "document",
+                "updateKeyRotates"
+            ],
+            "description": "What a change would publish, computed by the VTA by running the handler it would run to apply it (CONVENTIONS.md §6.1). This is what a consent surface renders and what an approval is bound to.",
+            "properties": {
+                "previewId": {
+                    "type": "string",
+                    "minLength": 16,
+                    "description": "Opaque, unguessable identifier of this exact plan. Carried back by the apply request; every approval and any recovery proof is bound to it."
+                },
+                "method": {
+                    "$ref": "#/$defs/DidMethodName"
+                },
+                "baseVersionId": {
+                    "type": "string",
+                    "description": "The version identifier the plan was computed against. Absent only for a creation. The plan is void once the identifier moves past it."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "changes": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/IdentityChange"
+                    },
+                    "description": "Every change the plan would make, including the ones the caller did not ask for — in particular any movement of the update authority the method requires."
+                },
+                "document": {
+                    "type": "object",
+                    "description": "The complete identifier document the change would publish, `keyRoles` included. Public data by construction."
+                },
+                "warnings": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PreviewWarning"
+                    },
+                    "uniqueItems": true
+                },
+                "updateKeyRotates": {
+                    "type": "boolean",
+                    "description": "True when applying the plan also moves the identifier's update authority to a committed successor — every change under did:webvh pre-rotation, never a KERI interaction event. Stated as its own member because it is the consequence a reviewer most often misses."
+                },
+                "recoverySigning": {
+                    "$ref": "#/$defs/RecoverySigningRequest"
+                }
+            }
+        },
+        "RecoverySigningRequest": {
+            "title": "RecoverySigningRequest",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "commitment",
+                "keyType",
+                "unsignedChange",
+                "proofOptions"
+            ],
+            "description": "What a recovery custodian must sign for a change that only the recovery key may authorize (CONVENTIONS.md §5.4, §9.4). The custodian MUST check `unsignedChange` itself — render it to its human, confirm that it reveals the recovery key it holds and commits to a fresh recovery key it also holds — and MUST NOT sign on the strength of this request's description alone.",
+            "properties": {
+                "commitment": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The recovery commitment the identifier publishes; the custodian's key MUST be the one it commits to."
+                },
+                "keyType": {
+                    "$ref": "#/$defs/KeyType"
+                },
+                "unsignedChange": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The change exactly as it will be published, without the recovery proof, as JSON text in the method's own form (a did:webvh log entry, a KERI rotation event)."
+                },
+                "proofOptions": {
+                    "type": "object",
+                    "description": "The proof the method requires over `unsignedChange`, without its signature value, as the method profile defines it (for did:webvh, a Data Integrity proof configuration with `proofPurpose: assertionMethod` and the recovery key's `did:key` as `verificationMethod`)."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        },
+        "KeyType": {
+            "title": "KeyType",
+            "type": "string",
+            "enum": [
+                "ed25519",
+                "x25519",
+                "p256",
+                "mldsa44",
+                "mldsa65"
+            ],
+            "description": "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support."
+        },
+        "PreviewWarning": {
+            "title": "PreviewWarning",
+            "type": "string",
+            "enum": [
+                "singleKeyRole",
+                "algorithmNotInAcceptedSet",
+                "roleWillHaveNoClassicalKey",
+                "attestationReissuanceRequired",
+                "selfPublish",
+                "noWitnesses",
+                "protectionBelowPolicy",
+                "recoveryKeyRevealed"
+            ],
+            "description": "Conditions a human should be shown before approving. `singleKeyRole` — the role will hold one active key. `algorithmNotInAcceptedSet` — a verifier population the VTA knows of does not accept the new key's algorithm. `roleWillHaveNoClassicalKey` — every remaining key is post-quantum. `attestationReissuanceRequired` — revoking this attestation key obliges re-issuance and re-signed status lists (VTI-KEY-133). `selfPublish` — the VTA will not publish the change; the operator must. `noWitnesses` — the identifier has no witnesses, so a party holding the VTA's routine update key can drop the recovery commitment unobserved (CONVENTIONS.md §5.3). `protectionBelowPolicy` — a key will be held at a `ProtectionClass` below what the VTA's policy recommends for its role (a plain VTA holding an attestation key). `recoveryKeyRevealed` — this change uses the recovery key, which must be replaced by a fresh recovery commitment in the same change."
+        },
+        "IdentityChange": {
+            "title": "IdentityChange",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "op",
+                "role"
+            ],
+            "properties": {
+                "op": {
+                    "type": "string",
+                    "enum": [
+                        "addKey",
+                        "retireKey",
+                        "revokeKey",
+                        "rotateUpdateKey",
+                        "commitUpdateKey",
+                        "replaceRecoveryCommitment",
+                        "useRecoveryKey"
+                    ],
+                    "description": "`addKey` — a verification method joins its role's relationship and `keyRoles`. `retireKey` — a verification method leaves its relationship, `keyRoles` and the document. `revokeKey` — a verification method leaves its relationship and `keyRoles`, and stays in `verificationMethod` with `revoked` set to the compromise time (CONVENTIONS.md §9.1). `rotateUpdateKey` — the identifier's update authority moves to a committed routine successor. `commitUpdateKey` — a new routine successor is committed. `replaceRecoveryCommitment` — the recovery commitment changes. `useRecoveryKey` — the change is authorized by the recovery key, which the identifier then reveals."
+                },
+                "role": {
+                    "$ref": "#/$defs/IdentityKeyRole"
+                },
+                "verificationMethod": {
+                    "type": "string"
+                },
+                "keyType": {
+                    "$ref": "#/$defs/KeyType"
+                },
+                "publicKeyMultibase": {
+                    "type": "string"
+                },
+                "commitment": {
+                    "type": "string"
+                },
+                "relationships": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/DidVerificationRelationship"
+                    },
+                    "uniqueItems": true
+                }
+            }
+        },
+        "DidVerificationRelationship": {
+            "title": "DidVerificationRelationship",
+            "type": "string",
+            "enum": [
+                "authentication",
+                "assertionMethod",
+                "keyAgreement",
+                "capabilityInvocation",
+                "capabilityDelegation"
+            ],
+            "description": "A DID Core verification relationship."
+        },
+        "IdentityKeyRole": {
+            "title": "IdentityKeyRole",
+            "type": "string",
+            "enum": [
+                "attestation",
+                "operational",
+                "messaging",
+                "update",
+                "authenticator"
+            ],
+            "description": "The named key role a key occupies in an identity (CONVENTIONS.md §2; VTI-KEY-070 onward). `attestation` — the only keys in `assertionMethod`; sign the identity's attestation artefacts (credentials, endorsements, status lists) through the VTA's signing service and nowhere else. Generated inside the VTA, never derived, never exportable, never in a backup. `operational` — the only keys the identity's own process uses in `authentication`; sign the node's own traffic (Trust Task requests and responses, DIDComm and TSP signatures, invitations, notices, audit checkpoints). Derived. `messaging` — the only keys in `keyAgreement`; sign nothing. X25519, derived or generated in its own right and never converted from a signing key. `update` — the identifier's change authority as its DID method states it (a did:webvh log's `updateKeys` and `nextKeyHashes`, a KERI key event log's current and next keys); never a role-bound verification method, never in `keyRoles`. Generated inside the VTA, never derived, never exportable, never in a backup, and always accompanied by a committed recovery key held outside the VTA's protection boundary. `authenticator` — a key held on a person's own authenticator (a WebAuthn passkey), listed in `authentication` of that person's identity only; used only to verify the person's WebAuthn assertions (sign-in and step-up evidence) and never to accept a Data Integrity proof. The VTA never holds its private half, so it is enrolled by the passkey ceremony and never generated, added or rotated by these tasks. Never permitted on the durable identity of a VTA, a VTC or a VTN. No role permits `capabilityInvocation` or `capabilityDelegation` (VTI-KEY-075). The set is an extensible registry: a consumer that meets a role it does not implement MUST rely on the key for nothing, and MUST NOT map it onto a role it does know (VTI-KEY-074)."
+        },
+        "DidMethodName": {
+            "title": "DidMethodName",
+            "type": "string",
+            "pattern": "^[a-z0-9]+(:[a-z0-9]+)*$",
+            "description": "The DID method an identity uses, as the method profile that governs it is named: `webvh` for a did:webvh identity, `scid:vh` for the did:scid:vh:1 form of one, `webs` for did:webs. Deliberately a pattern and not an enumeration: a method is added by publishing its profile under method-profiles/, never by changing this schema. A VTA MUST refuse a method it holds no profile for, or whose profile declares it ineligible, with `vta/dids:methodNotEligible`."
+        },
+        "KeyChangeOutcome": {
+            "title": "KeyChangeOutcome",
+            "type": "string",
+            "enum": [
+                "preview",
+                "applied",
+                "pendingApproval",
+                "awaitingRecoveryProof"
+            ],
+            "description": "`preview` — nothing was written; the response carries the plan. `applied` — the change was made (and published, unless `publication.selfPublish`). `pendingApproval` — the plan is recorded and awaits further approvals. `awaitingRecoveryProof` — the plan is approved and waits for the recovery custodian's proof (`preview.recoverySigning`); nothing is published until it arrives."
+        }
+    }
+};
+/**
+ * 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,
+};
+/**
+ * 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,
+};
+//# sourceMappingURL=payload.js.map