@openvtc/trust-tasks 0.28.23 → 0.28.24

package/src/messaging/mux/revoke-all/0.1/payload.ts

@@ -0,0 +1,452 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/mux/revoke-all/0.1/payload.schema.json
+ */
+
+import type { DataIntegrityProof, Ext, MuxDataIntegrityProof, MuxDid, RevokeAllStatement } from "../../../../_shared/components.js";
+
+
+/**
+ * A member DID, proving current control with a signed revoke-all statement, advances its epoch at the mediator and so voids every grant on it at once. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface MessagingMuxRevokeAllPayload {
+  /**
+   * The revoke-all statement; the member DID is its `issuer`.
+   */
+  revocation: RevokeAllStatement;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * The success response to a messaging/mux/revoke-all request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/mux/revoke-all/0.1#response.
+ */
+export interface MessagingMuxRevokeAllResponsePayload {
+  did: MuxDid;
+  /**
+   * The member DID's epoch now in force; a new grant must carry it.
+   */
+  epoch: number;
+  /**
+   * False when the epoch named in the proof had already been voided, so nothing changed.
+   */
+  epochAdvanced: boolean;
+  /**
+   * How many grants that were active this request moved to `epochRevoked`.
+   */
+  revokedGrants: number;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { DataIntegrityProof, Ext, MuxDataIntegrityProof, MuxDid, RevokeAllStatement };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/mux/revoke-all/0.1" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = MessagingMuxRevokeAllPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/mux/revoke-all/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = MessagingMuxRevokeAllResponsePayload;
+
+/**
+ * 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/messaging/mux/revoke-all/0.1",
+  "title": "Messaging — Mux Revoke All — payload",
+  "description": "A member DID, proving current control with a signed revoke-all statement, advances its epoch at the mediator and so voids every grant on it at once. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "revocation"
+  ],
+  "properties": {
+    "revocation": {
+      "$ref": "#/$defs/RevokeAllStatement",
+      "description": "The revoke-all statement; the member DID is its `issuer`."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Messaging — Mux Revoke All — response payload",
+      "description": "The success response to a messaging/mux/revoke-all request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/mux/revoke-all/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "epoch",
+        "epochAdvanced",
+        "revokedGrants"
+      ],
+      "properties": {
+        "did": {
+          "$ref": "#/$defs/MuxDid"
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The member DID's epoch now in force; a new grant must carry it."
+        },
+        "epochAdvanced": {
+          "type": "boolean",
+          "description": "False when the epoch named in the proof had already been voided, so nothing changed."
+        },
+        "revokedGrants": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many grants that were active this request moved to `epochRevoked`."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "MuxDid": {
+      "title": "MuxDid",
+      "type": "string",
+      "minLength": 7,
+      "maxLength": 2048,
+      "pattern": "^did:[a-z0-9]+:\\S+$",
+      "description": "A DID, carried verbatim and compared by exact string equality. Unlike the messaging family's `Vid`, never a hash: the mediator resolves it to verify a statement signed by it. For a member DID reached over TSP, the TSP VID is the DID itself."
+    },
+    "RevokeAllStatement": {
+      "title": "RevokeAllStatement",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "issuer",
+        "audience",
+        "epoch",
+        "iat",
+        "exp",
+        "proof"
+      ],
+      "description": "A member DID's statement, proving current control of it, that every grant on it signed under `epoch` or earlier is void. Signed by the member with an embedded Data Integrity proof whose purpose is `authentication`.",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "muxRevokeAll",
+          "description": "Always `muxRevokeAll`; names the statement kind, so a statement of one kind is never accepted as another."
+        },
+        "issuer": {
+          "$ref": "#/$defs/MuxDid",
+          "description": "The member DID: the signer, and the DID the statement concerns."
+        },
+        "audience": {
+          "$ref": "#/$defs/MuxDid",
+          "description": "The mediator's DID. A statement names exactly one mediator and is refused by every other."
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The epoch being voided: the member DID's current one."
+        },
+        "iat": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "JWT NumericDate (RFC 7519 §2), whole seconds since 1970-01-01T00:00:00Z UTC: when the statement was signed. MUST NOT be more than 60 seconds in the mediator's future."
+        },
+        "exp": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "JWT NumericDate (RFC 7519 §2): when the statement stops being accepted. REQUIRED; MUST be after `iat` and in the future."
+        },
+        "proof": {
+          "$ref": "#/$defs/MuxDataIntegrityProof"
+        }
+      }
+    },
+    "MuxDataIntegrityProof": {
+      "title": "MuxDataIntegrityProof",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "cryptosuite",
+        "verificationMethod",
+        "proofPurpose",
+        "proofValue"
+      ],
+      "description": "The W3C Data Integrity proof embedded in a mux statement, made by the member DID: the format and verifier Trust Tasks already use for document proofs (SPEC §4.7). The proof covers the whole statement except `proof` itself, as the cryptosuite defines. Closed: a member Data Integrity defines but this list omits is refused.",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "DataIntegrityProof"
+        },
+        "cryptosuite": {
+          "type": "string",
+          "enum": [
+            "eddsa-jcs-2022",
+            "eddsa-rdfc-2022"
+          ],
+          "description": "The W3C Data Integrity EdDSA cryptosuite used."
+        },
+        "verificationMethod": {
+          "type": "string",
+          "minLength": 5,
+          "maxLength": 2048,
+          "pattern": "^did:\\S+#\\S+$",
+          "description": "The DID URL of the verification method that signed. MUST be controlled by the statement's `issuer` and listed in that DID's current `authentication` relationship."
+        },
+        "proofPurpose": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "MUST be `authentication`. Any other value is refused with `messaging/mux:proofPurposeInvalid` — a proof made for another relationship (an `assertionMethod` credential signature, say) is never accepted as control of the DID."
+        },
+        "created": {
+          "type": "string",
+          "format": "date-time",
+          "description": "OPTIONAL: when the proof was made, as Data Integrity defines it. Covered by the proof; the statement's own `iat` is what the mediator checks."
+        },
+        "proofValue": {
+          "type": "string",
+          "minLength": 2,
+          "maxLength": 4096,
+          "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+          "description": "The multibase (base58btc) signature."
+        }
+      }
+    }
+  }
+} 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": "Messaging — Mux Revoke All — response payload",
+      "description": "The success response to a messaging/mux/revoke-all request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/mux/revoke-all/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "epoch",
+        "epochAdvanced",
+        "revokedGrants"
+      ],
+      "properties": {
+        "did": {
+          "$ref": "#/$defs/MuxDid"
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The member DID's epoch now in force; a new grant must carry it."
+        },
+        "epochAdvanced": {
+          "type": "boolean",
+          "description": "False when the epoch named in the proof had already been voided, so nothing changed."
+        },
+        "revokedGrants": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many grants that were active this request moved to `epochRevoked`."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "MuxDid": {
+      "title": "MuxDid",
+      "type": "string",
+      "minLength": 7,
+      "maxLength": 2048,
+      "pattern": "^did:[a-z0-9]+:\\S+$",
+      "description": "A DID, carried verbatim and compared by exact string equality. Unlike the messaging family's `Vid`, never a hash: the mediator resolves it to verify a statement signed by it. For a member DID reached over TSP, the TSP VID is the DID itself."
+    },
+    "RevokeAllStatement": {
+      "title": "RevokeAllStatement",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "issuer",
+        "audience",
+        "epoch",
+        "iat",
+        "exp",
+        "proof"
+      ],
+      "description": "A member DID's statement, proving current control of it, that every grant on it signed under `epoch` or earlier is void. Signed by the member with an embedded Data Integrity proof whose purpose is `authentication`.",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "muxRevokeAll",
+          "description": "Always `muxRevokeAll`; names the statement kind, so a statement of one kind is never accepted as another."
+        },
+        "issuer": {
+          "$ref": "#/$defs/MuxDid",
+          "description": "The member DID: the signer, and the DID the statement concerns."
+        },
+        "audience": {
+          "$ref": "#/$defs/MuxDid",
+          "description": "The mediator's DID. A statement names exactly one mediator and is refused by every other."
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The epoch being voided: the member DID's current one."
+        },
+        "iat": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "JWT NumericDate (RFC 7519 §2), whole seconds since 1970-01-01T00:00:00Z UTC: when the statement was signed. MUST NOT be more than 60 seconds in the mediator's future."
+        },
+        "exp": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "JWT NumericDate (RFC 7519 §2): when the statement stops being accepted. REQUIRED; MUST be after `iat` and in the future."
+        },
+        "proof": {
+          "$ref": "#/$defs/MuxDataIntegrityProof"
+        }
+      }
+    },
+    "MuxDataIntegrityProof": {
+      "title": "MuxDataIntegrityProof",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "cryptosuite",
+        "verificationMethod",
+        "proofPurpose",
+        "proofValue"
+      ],
+      "description": "The W3C Data Integrity proof embedded in a mux statement, made by the member DID: the format and verifier Trust Tasks already use for document proofs (SPEC §4.7). The proof covers the whole statement except `proof` itself, as the cryptosuite defines. Closed: a member Data Integrity defines but this list omits is refused.",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "DataIntegrityProof"
+        },
+        "cryptosuite": {
+          "type": "string",
+          "enum": [
+            "eddsa-jcs-2022",
+            "eddsa-rdfc-2022"
+          ],
+          "description": "The W3C Data Integrity EdDSA cryptosuite used."
+        },
+        "verificationMethod": {
+          "type": "string",
+          "minLength": 5,
+          "maxLength": 2048,
+          "pattern": "^did:\\S+#\\S+$",
+          "description": "The DID URL of the verification method that signed. MUST be controlled by the statement's `issuer` and listed in that DID's current `authentication` relationship."
+        },
+        "proofPurpose": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "MUST be `authentication`. Any other value is refused with `messaging/mux:proofPurposeInvalid` — a proof made for another relationship (an `assertionMethod` credential signature, say) is never accepted as control of the DID."
+        },
+        "created": {
+          "type": "string",
+          "format": "date-time",
+          "description": "OPTIONAL: when the proof was made, as Data Integrity defines it. Covered by the proof; the statement's own `iat` is what the mediator checks."
+        },
+        "proofValue": {
+          "type": "string",
+          "minLength": 2,
+          "maxLength": 4096,
+          "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+          "description": "The multibase (base58btc) signature."
+        }
+      }
+    }
+  }
+} 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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;