@openvtc/trust-tasks 0.28.23 → 0.28.24

package/src/messaging/mux/notice/0.1/payload.ts

@@ -0,0 +1,362 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/mux/notice/0.1/payload.schema.json
+ */
+
+import type { DetachReason, Ext, GrantId, MuxDid } from "../../../../_shared/components.js";
+
+
+/**
+ * A durable notice from a mediator, stored in the recipient's inbox and delivered at least once, about grants the recipient must act on or know of: suspended, revoked, expiring, or present on a member DID. The members present depend on `notice`; see the specification. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface MessagingMuxNoticePayload {
+  /**
+   * Which notice this is. Each kind carries the members the specification lists for it, and no others.
+   */
+  notice: "grantsSuspended" | "grantsRevoked" | "grantsExpiring" | "grantsPresent";
+  /**
+   * `grantsSuspended` only, REQUIRED: the recipient's grants that were suspended. They must be recreated by a fresh messaging/mux/grant signed by the member DID under its current epoch.
+   *
+   * @minItems 1
+   * @maxItems 256
+   */
+  suspensions?: [Suspension, ...Suspension[]];
+  /**
+   * `grantsRevoked` only, REQUIRED: the recipient's grants that were revoked by someone other than the recipient.
+   *
+   * @minItems 1
+   * @maxItems 256
+   */
+  revocations?: [Revocation, ...Revocation[]];
+  /**
+   * `grantsExpiring` only, REQUIRED: grants delegated to the recipient that have passed about three quarters of their lifetime.
+   *
+   * @minItems 1
+   * @maxItems 256
+   */
+  expiring?: [ExpiringGrant, ...ExpiringGrant[]];
+  /**
+   * `grantsPresent` only, REQUIRED: the member DID the recipient authenticated as.
+   */
+  did?: MuxDid;
+  /**
+   * `grantsPresent` only, REQUIRED: grants on the member DID the mediator holds, in every state.
+   */
+  count?: number;
+  /**
+   * `grantsPresent` only, REQUIRED: how many of them this authentication just suspended under the unknown-key rule.
+   */
+  suspended?: number;
+  /**
+   * `grantsPresent` only, REQUIRED: the member DID's epoch now in force.
+   */
+  epoch?: number;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+export interface Suspension {
+  /**
+   * The member DID.
+   */
+  did: MuxDid;
+  /**
+   * @minItems 1
+   * @maxItems 256
+   */
+  grantIds: [GrantId, ...GrantId[]];
+  /**
+   * Why: `suspendedUnknownKey` in this version.
+   */
+  reason: DetachReason;
+  /**
+   * When the suspension was committed.
+   */
+  suspendedAt: string;
+}
+export interface Revocation {
+  /**
+   * The member DID.
+   */
+  did: MuxDid;
+  /**
+   * @minItems 1
+   * @maxItems 256
+   */
+  grantIds: [GrantId, ...GrantId[]];
+  /**
+   * Why: `revokedByMember`, `epochBumped`, `admin` or `accountRemoved`.
+   */
+  reason: DetachReason;
+  /**
+   * When the revocation was committed.
+   */
+  revokedAt: string;
+}
+export interface ExpiringGrant {
+  grantId: GrantId;
+  /**
+   * The member DID.
+   */
+  did: MuxDid;
+  /**
+   * The grant's effective expiry.
+   */
+  expiresAt: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { DetachReason, Ext, GrantId, MuxDid };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/mux/notice/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 = MessagingMuxNoticePayload;
+
+/**
+ * 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/notice/0.1",
+  "title": "Messaging — Mux Notice — payload",
+  "description": "A durable notice from a mediator, stored in the recipient's inbox and delivered at least once, about grants the recipient must act on or know of: suspended, revoked, expiring, or present on a member DID. The members present depend on `notice`; see the specification. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "notice"
+  ],
+  "properties": {
+    "notice": {
+      "type": "string",
+      "enum": [
+        "grantsSuspended",
+        "grantsRevoked",
+        "grantsExpiring",
+        "grantsPresent"
+      ],
+      "description": "Which notice this is. Each kind carries the members the specification lists for it, and no others."
+    },
+    "suspensions": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 256,
+      "items": {
+        "title": "Suspension",
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "did",
+          "grantIds",
+          "reason",
+          "suspendedAt"
+        ],
+        "properties": {
+          "did": {
+            "$ref": "#/$defs/MuxDid",
+            "description": "The member DID."
+          },
+          "grantIds": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 256,
+            "uniqueItems": true,
+            "items": {
+              "$ref": "#/$defs/GrantId"
+            }
+          },
+          "reason": {
+            "$ref": "#/$defs/DetachReason",
+            "description": "Why: `suspendedUnknownKey` in this version."
+          },
+          "suspendedAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "When the suspension was committed."
+          }
+        }
+      },
+      "description": "`grantsSuspended` only, REQUIRED: the recipient's grants that were suspended. They must be recreated by a fresh messaging/mux/grant signed by the member DID under its current epoch."
+    },
+    "revocations": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 256,
+      "items": {
+        "title": "Revocation",
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "did",
+          "grantIds",
+          "reason",
+          "revokedAt"
+        ],
+        "properties": {
+          "did": {
+            "$ref": "#/$defs/MuxDid",
+            "description": "The member DID."
+          },
+          "grantIds": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 256,
+            "uniqueItems": true,
+            "items": {
+              "$ref": "#/$defs/GrantId"
+            }
+          },
+          "reason": {
+            "$ref": "#/$defs/DetachReason",
+            "description": "Why: `revokedByMember`, `epochBumped`, `admin` or `accountRemoved`."
+          },
+          "revokedAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "When the revocation was committed."
+          }
+        }
+      },
+      "description": "`grantsRevoked` only, REQUIRED: the recipient's grants that were revoked by someone other than the recipient."
+    },
+    "expiring": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 256,
+      "items": {
+        "title": "ExpiringGrant",
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "grantId",
+          "did",
+          "expiresAt"
+        ],
+        "properties": {
+          "grantId": {
+            "$ref": "#/$defs/GrantId"
+          },
+          "did": {
+            "$ref": "#/$defs/MuxDid",
+            "description": "The member DID."
+          },
+          "expiresAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "The grant's effective expiry."
+          }
+        }
+      },
+      "description": "`grantsExpiring` only, REQUIRED: grants delegated to the recipient that have passed about three quarters of their lifetime."
+    },
+    "did": {
+      "$ref": "#/$defs/MuxDid",
+      "description": "`grantsPresent` only, REQUIRED: the member DID the recipient authenticated as."
+    },
+    "count": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "`grantsPresent` only, REQUIRED: grants on the member DID the mediator holds, in every state."
+    },
+    "suspended": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "`grantsPresent` only, REQUIRED: how many of them this authentication just suspended under the unknown-key rule."
+    },
+    "epoch": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "`grantsPresent` only, REQUIRED: the member DID's epoch now in force."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "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."
+    },
+    "GrantId": {
+      "title": "GrantId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9._:-]+$",
+      "description": "A grant's identifier, chosen by the member DID's signer and carried in its grant statement; a UUID is RECOMMENDED. A mediator refuses a grant whose identifier is already on the member DID's record."
+    },
+    "DetachReason": {
+      "title": "DetachReason",
+      "type": "string",
+      "enum": [
+        "revokedByMember",
+        "revokedByPrincipal",
+        "epochBumped",
+        "suspendedUnknownKey",
+        "keyRotated",
+        "expired",
+        "accountBlocked",
+        "superseded",
+        "admin",
+        "detachRequested",
+        "accountRemoved",
+        "resolutionFailed"
+      ],
+      "description": "Why a member left a connection, or why a stored grant did not attach on connect. `revokedByMember` / `revokedByPrincipal`: messaging/mux/revoke by that side. `epochBumped`: the member DID ran messaging/mux/revoke-all. `suspendedUnknownKey`: the unknown-key rule suspended the grant. `keyRotated`: the grant's signing key left the member DID's current authentication relationship (grant state `staleKey`). `expired`: the grant or attach reached its effective expiry. `accountBlocked`: the member's account was blocked. `superseded`: the member DID's own direct connection, or a newer connection of the same kind, now receives its live traffic; the member stays on this connection inactive. `admin`: an operator acted. `detachRequested`: the principal removed a session attach with messaging/mux/detach. `accountRemoved`: the member's account, or the principal's, was removed. `resolutionFailed`: the member DID could not be resolved when the grant was re-validated; the grant is not changed and is re-checked later."
+    }
+  }
+} 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;