@openvtc/trust-tasks 0.28.23 → 0.28.25

package/dist/messaging/mux/event/0.1/payload.js

@@ -0,0 +1,260 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/mux/event/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/mux/event/0.1";
+/**
+ * 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;
+/**
+ * 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/event/0.1",
+    "title": "Messaging — Mux Event — payload",
+    "description": "A live, unstored event from a mediator to the principal of one mux connection: the connection is ready (with its nonce and limits), members attached or detached, or an inbound frame for a member refused. The members present depend on `event`; see the specification. The outer document members are owned by the framework — SPEC §6.3.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "event"
+    ],
+    "properties": {
+        "event": {
+            "type": "string",
+            "enum": [
+                "ready",
+                "attached",
+                "detached",
+                "refused"
+            ],
+            "description": "Which event this is. Each kind carries the members the specification lists for it, and no others."
+        },
+        "sessionId": {
+            "$ref": "#/$defs/SessionId",
+            "description": "`ready` only, REQUIRED: this connection's identifier, which attach statements sign over."
+        },
+        "muxNonce": {
+            "$ref": "#/$defs/MuxNonce",
+            "description": "`ready` only, REQUIRED: this connection's nonce, which attach statements sign over."
+        },
+        "maxDidsPerConnection": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "`ready` only, REQUIRED: the most members this connection may carry."
+        },
+        "maxGrantLifetimeSeconds": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "`ready` only, REQUIRED: the longest `exp − iat` a grant may have."
+        },
+        "maxAttachLifetimeSeconds": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "`ready` only, OPTIONAL: the longest an attach statement's `exp` may lie after its `iat`."
+        },
+        "sessionExpiresAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "`ready` only, OPTIONAL: when the principal's authentication of this connection expires and the connection closes. An attach statement's `exp` may not be later."
+        },
+        "pendingNotices": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "`ready` only, REQUIRED: how many messaging/mux/notice documents wait in the principal's inbox. Non-zero means the principal must drain them before it trusts its member set."
+        },
+        "dids": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 1000,
+            "items": {
+                "$ref": "#/$defs/MemberChange"
+            },
+            "description": "`attached` and `detached` only, REQUIRED: the members that changed, batched. A larger change is split across several events."
+        },
+        "frameId": {
+            "type": "string",
+            "pattern": "^[0-9a-f]{64}$",
+            "description": "`refused` only, REQUIRED: the lowercase hex SHA-256 of the refused frame's exact bytes — the identifier `tsp-ack` already uses."
+        },
+        "sender": {
+            "$ref": "#/$defs/MuxDid",
+            "description": "`refused` only, OPTIONAL: the frame's sender, when the mediator could read it."
+        },
+        "receiver": {
+            "$ref": "#/$defs/MuxDid",
+            "description": "`refused` only, OPTIONAL: the member DID or principal the frame was addressed to, when the mediator could read it."
+        },
+        "code": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256,
+            "description": "`refused` only, REQUIRED: the mediator's stable refusal code, the same code a traffic-monitor `refused` event reports."
+        },
+        "reason": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 512,
+            "description": "`refused` only, OPTIONAL: a short human-readable explanation. Never message content."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext",
+            "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+    },
+    "$defs": {
+        "MemberChange": {
+            "title": "MemberChange",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "did",
+                "reason"
+            ],
+            "description": "One member's change in an `attached` or `detached` event.",
+            "properties": {
+                "did": {
+                    "$ref": "#/$defs/MuxDid",
+                    "description": "The member DID."
+                },
+                "reason": {
+                    "$ref": "#/$defs/MemberChangeReason",
+                    "description": "Why the member changed: an AttachReason value in an `attached` event, a DetachReason value in a `detached` event."
+                },
+                "grantId": {
+                    "$ref": "#/$defs/GrantId",
+                    "description": "The grant concerned, where the member is or was attached through one."
+                },
+                "scope": {
+                    "$ref": "#/$defs/MuxScope",
+                    "description": "`attached` only: the scope now in force for the member."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "`attached` only: when the membership lapses unless renewed."
+                },
+                "deliveryActive": {
+                    "type": "boolean",
+                    "description": "`attached` only: false while the member DID's own direct connection keeps its live traffic."
+                }
+            }
+        },
+        "MuxScope": {
+            "title": "MuxScope",
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 16,
+            "items": {
+                "$ref": "#/$defs/MuxScopeValue"
+            },
+            "description": "A set of capabilities: a non-empty JSON array of MuxScopeValue, compared as a set — order is not significant and a repeated value collapses into one. Never empty: an empty scope is refused, never read as \"all\". There is no default scope anywhere — every attach and every grant names its scope explicitly. A scope is always bounded by the member DID's own access-control capabilities at the mediator."
+        },
+        "MuxScopeValue": {
+            "title": "MuxScopeValue",
+            "type": "string",
+            "enum": [
+                "receive",
+                "pickup",
+                "delete",
+                "send"
+            ],
+            "description": "One capability a member DID extends to a principal's connection. `receive`: live delivery of the member's inbound messages on the connection. `pickup`: message-pickup status and delivery requests naming the member as `recipient_did`, and inclusion in a raw-TSP inbox drain. `delete`: deleting the member's stored messages, including delete-on-ack and delete-on-send; a member without `delete` keeps its messages in its inbox until something holding `delete` collects them. `send`: the mediator accepts on this connection frames whose sender is the member DID — the frame is still signed or authcrypted with the member's own keys; the scope only lets the mediator accept it on this socket."
+        },
+        "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."
+        },
+        "MemberChangeReason": {
+            "title": "MemberChangeReason",
+            "type": "string",
+            "enum": [
+                "connect",
+                "grant",
+                "attach",
+                "reactivated",
+                "revokedByMember",
+                "revokedByPrincipal",
+                "epochBumped",
+                "suspendedUnknownKey",
+                "keyRotated",
+                "expired",
+                "accountBlocked",
+                "superseded",
+                "admin",
+                "detachRequested",
+                "accountRemoved",
+                "resolutionFailed"
+            ],
+            "description": "The reason carried by one member's change in a messaging/mux/event `attached` or `detached` event: exactly the AttachReason values followed by the DetachReason values, with their meanings. An `attached` event carries only AttachReason values and a `detached` event only DetachReason values. One closed set rather than a union, so every generated binding types it as one enumeration; it MUST be kept equal to the two sets it joins."
+        },
+        "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."
+        },
+        "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-]+)+$"
+            }
+        },
+        "MuxNonce": {
+            "title": "MuxNonce",
+            "type": "string",
+            "pattern": "^[A-Za-z0-9_-]{43}$",
+            "description": "32 random bytes, base64url without padding, that belong to exactly one connection and are never reused. Attach statements sign over it, which is what makes an attach statement unusable on any other connection."
+        },
+        "SessionId": {
+            "title": "SessionId",
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256,
+            "description": "The mediator's identifier for one authenticated connection, as announced in that connection's `ready` event."
+        }
+    }
+};
+/**
+ * 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: false,
+    isRecipientRequired: true,
+    isIssuedAtRequired: true,
+    payloadSchema: PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map

package/dist/messaging/mux/event/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/messaging/mux/event/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA0GH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,qDAA8D,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAkB,IAAI,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAkB,IAAI,CAAC;AAK/C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,qDAAqD;IAC5D,OAAO,EAAE,iCAAiC;IAC1C,aAAa,EAAE,8UAA8U;IAC7V,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,OAAO;KACR;IACD,YAAY,EAAE;QACZ,OAAO,EAAE;YACP,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,OAAO;gBACP,UAAU;gBACV,UAAU;gBACV,SAAS;aACV;YACD,aAAa,EAAE,mGAAmG;SACnH;QACD,WAAW,EAAE;YACX,MAAM,EAAE,mBAAmB;YAC3B,aAAa,EAAE,0FAA0F;SAC1G;QACD,UAAU,EAAE;YACV,MAAM,EAAE,kBAAkB;YAC1B,aAAa,EAAE,qFAAqF;SACrG;QACD,sBAAsB,EAAE;YACtB,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,aAAa,EAAE,qEAAqE;SACrF;QACD,yBAAyB,EAAE;YACzB,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,aAAa,EAAE,mEAAmE;SACnF;QACD,0BAA0B,EAAE;YAC1B,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,aAAa,EAAE,0FAA0F;SAC1G;QACD,kBAAkB,EAAE;YAClB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,WAAW;YACrB,aAAa,EAAE,iKAAiK;SACjL;QACD,gBAAgB,EAAE;YAChB,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,aAAa,EAAE,8KAA8K;SAC9L;QACD,MAAM,EAAE;YACN,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,CAAC;YACb,UAAU,EAAE,IAAI;YAChB,OAAO,EAAE;gBACP,MAAM,EAAE,sBAAsB;aAC/B;YACD,aAAa,EAAE,8HAA8H;SAC9I;QACD,SAAS,EAAE;YACT,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,gBAAgB;YAC3B,aAAa,EAAE,iIAAiI;SACjJ;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,gBAAgB;YACxB,aAAa,EAAE,gFAAgF;SAChG;QACD,UAAU,EAAE;YACV,MAAM,EAAE,gBAAgB;YACxB,aAAa,EAAE,oHAAoH;SACpI;QACD,MAAM,EAAE;YACN,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,wHAAwH;SACxI;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,sFAAsF;SACtG;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,yDAAyD;SACzE;KACF;IACD,OAAO,EAAE;QACP,cAAc,EAAE;YACd,OAAO,EAAE,cAAc;YACvB,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,KAAK;gBACL,QAAQ;aACT;YACD,aAAa,EAAE,2DAA2D;YAC1E,YAAY,EAAE;gBACZ,KAAK,EAAE;oBACL,MAAM,EAAE,gBAAgB;oBACxB,aAAa,EAAE,iBAAiB;iBACjC;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,4BAA4B;oBACpC,aAAa,EAAE,mHAAmH;iBACnI;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,iBAAiB;oBACzB,aAAa,EAAE,uEAAuE;iBACvF;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,kBAAkB;oBAC1B,aAAa,EAAE,yDAAyD;iBACzE;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,6DAA6D;iBAC7E;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,6FAA6F;iBAC7G;aACF;SACF;QACD,UAAU,EAAE;YACV,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,CAAC;YACb,UAAU,EAAE,EAAE;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,uBAAuB;aAChC;YACD,aAAa,EAAE,mZAAmZ;SACna;QACD,eAAe,EAAE;YACf,OAAO,EAAE,eAAe;YACxB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,SAAS;gBACT,QAAQ;gBACR,QAAQ;gBACR,MAAM;aACP;YACD,aAAa,EAAE,krBAAkrB;SAClsB;QACD,SAAS,EAAE;YACT,OAAO,EAAE,SAAS;YAClB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,SAAS,EAAE,oBAAoB;YAC/B,aAAa,EAAE,uMAAuM;SACvN;QACD,oBAAoB,EAAE;YACpB,OAAO,EAAE,oBAAoB;YAC7B,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,SAAS;gBACT,OAAO;gBACP,QAAQ;gBACR,aAAa;gBACb,iBAAiB;gBACjB,oBAAoB;gBACpB,aAAa;gBACb,qBAAqB;gBACrB,YAAY;gBACZ,SAAS;gBACT,gBAAgB;gBAChB,YAAY;gBACZ,OAAO;gBACP,iBAAiB;gBACjB,gBAAgB;gBAChB,kBAAkB;aACnB;YACD,aAAa,EAAE,gbAAgb;SAChc;QACD,QAAQ,EAAE;YACR,OAAO,EAAE,QAAQ;YACjB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,sBAAsB;YACjC,aAAa,EAAE,kPAAkP;SAClQ;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,UAAU,EAAE;YACV,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,qBAAqB;YAChC,aAAa,EAAE,mNAAmN;SACnO;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,8GAA8G;SAC9H;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,cAAc;CACrB,CAAC"}