@openvtc/trust-tasks 0.28.22 → 0.28.24

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

@@ -0,0 +1,311 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/mux/revoke/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/mux/revoke/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;
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/mux/revoke/0.1#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/messaging/mux/revoke/0.1",
+    "title": "Messaging — Mux Revoke — payload",
+    "description": "Revoke stored grants, as their principal or as their member DID. The outer document members are owned by the framework — SPEC §6.3.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "as"
+    ],
+    "properties": {
+        "as": {
+            "$ref": "#/$defs/MuxRole",
+            "description": "`principal`: revoke grants delegated to the requester. `member`: revoke grants on a member DID the requester controls."
+        },
+        "did": {
+            "$ref": "#/$defs/MuxDid",
+            "description": "As `member` only: the member DID whose grants are revoked; absent means the requester itself."
+        },
+        "grantIds": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 256,
+            "uniqueItems": true,
+            "items": {
+                "$ref": "#/$defs/GrantId"
+            },
+            "description": "Grants to revoke, by identifier."
+        },
+        "dids": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 256,
+            "uniqueItems": true,
+            "items": {
+                "$ref": "#/$defs/MuxDid"
+            },
+            "description": "As `principal`: member DIDs whose grants to the requester are revoked. As `member`: principal DIDs whose grants on the member are revoked."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext",
+            "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "Messaging — Mux Revoke — response payload",
+            "description": "The success response to a messaging/mux/revoke request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/mux/revoke/0.1#response.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "revoked"
+            ],
+            "properties": {
+                "revoked": {
+                    "type": "array",
+                    "maxItems": 512,
+                    "items": {
+                        "$ref": "#/$defs/GrantRef"
+                    },
+                    "description": "Grants this request deleted; their members are detached from every connection before this response is sent, and the principal's replay floor rises so their statements cannot be stored again."
+                },
+                "unmatchedGrantIds": {
+                    "type": "array",
+                    "maxItems": 256,
+                    "items": {
+                        "$ref": "#/$defs/GrantId"
+                    },
+                    "description": "Requested grant identifiers that name no stored grant the requester may revoke in the role it named."
+                },
+                "unmatchedDids": {
+                    "type": "array",
+                    "maxItems": 256,
+                    "items": {
+                        "$ref": "#/$defs/MuxDid"
+                    },
+                    "description": "Requested DIDs with no stored grant the requester may revoke in the role it named."
+                },
+                "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."
+        },
+        "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."
+        },
+        "GrantRef": {
+            "title": "GrantRef",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "grantId",
+                "did",
+                "principal"
+            ],
+            "description": "Identifies one stored grant and the two parties to it.",
+            "properties": {
+                "grantId": {
+                    "$ref": "#/$defs/GrantId"
+                },
+                "did": {
+                    "$ref": "#/$defs/MuxDid",
+                    "description": "The member DID."
+                },
+                "principal": {
+                    "$ref": "#/$defs/MuxDid",
+                    "description": "The principal DID the grant delegates to."
+                }
+            }
+        },
+        "MuxRole": {
+            "title": "MuxRole",
+            "type": "string",
+            "enum": [
+                "principal",
+                "member"
+            ],
+            "description": "The side of a delegation a requester acts as. `principal`: the DID that authenticated the connection and to which members' traffic is delegated. `member`: a DID whose traffic is delegated."
+        }
+    }
+};
+/** 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 — response payload",
+            "description": "The success response to a messaging/mux/revoke request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/mux/revoke/0.1#response.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "revoked"
+            ],
+            "properties": {
+                "revoked": {
+                    "type": "array",
+                    "maxItems": 512,
+                    "items": {
+                        "$ref": "#/$defs/GrantRef"
+                    },
+                    "description": "Grants this request deleted; their members are detached from every connection before this response is sent, and the principal's replay floor rises so their statements cannot be stored again."
+                },
+                "unmatchedGrantIds": {
+                    "type": "array",
+                    "maxItems": 256,
+                    "items": {
+                        "$ref": "#/$defs/GrantId"
+                    },
+                    "description": "Requested grant identifiers that name no stored grant the requester may revoke in the role it named."
+                },
+                "unmatchedDids": {
+                    "type": "array",
+                    "maxItems": 256,
+                    "items": {
+                        "$ref": "#/$defs/MuxDid"
+                    },
+                    "description": "Requested DIDs with no stored grant the requester may revoke in the role it named."
+                },
+                "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."
+        },
+        "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."
+        },
+        "GrantRef": {
+            "title": "GrantRef",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "grantId",
+                "did",
+                "principal"
+            ],
+            "description": "Identifies one stored grant and the two parties to it.",
+            "properties": {
+                "grantId": {
+                    "$ref": "#/$defs/GrantId"
+                },
+                "did": {
+                    "$ref": "#/$defs/MuxDid",
+                    "description": "The member DID."
+                },
+                "principal": {
+                    "$ref": "#/$defs/MuxDid",
+                    "description": "The principal DID the grant delegates to."
+                }
+            }
+        },
+        "MuxRole": {
+            "title": "MuxRole",
+            "type": "string",
+            "enum": [
+                "principal",
+                "member"
+            ],
+            "description": "The side of a delegation a requester acts as. `principal`: the DID that authenticated the connection and to which members' traffic is delegated. `member`: a DID whose traffic is delegated."
+        }
+    }
+};
+/**
+ * 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: false,
+    isRecipientRequired: true,
+    isIssuedAtRequired: true,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/messaging/mux/revoke/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAmEH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,sDAA+D,CAAC;AAExF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAkB,IAAI,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAkB,IAAI,CAAC;AAK/C,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,+DAAwE,CAAC;AAK1G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,sDAAsD;IAC7D,OAAO,EAAE,kCAAkC;IAC3C,aAAa,EAAE,qIAAqI;IACpJ,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,IAAI;KACL;IACD,YAAY,EAAE;QACZ,IAAI,EAAE;YACJ,MAAM,EAAE,iBAAiB;YACzB,aAAa,EAAE,wHAAwH;SACxI;QACD,KAAK,EAAE;YACL,MAAM,EAAE,gBAAgB;YACxB,aAAa,EAAE,+FAA+F;SAC/G;QACD,UAAU,EAAE;YACV,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,CAAC;YACb,UAAU,EAAE,GAAG;YACf,aAAa,EAAE,IAAI;YACnB,OAAO,EAAE;gBACP,MAAM,EAAE,iBAAiB;aAC1B;YACD,aAAa,EAAE,kCAAkC;SAClD;QACD,MAAM,EAAE;YACN,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,CAAC;YACb,UAAU,EAAE,GAAG;YACf,aAAa,EAAE,IAAI;YACnB,OAAO,EAAE;gBACP,MAAM,EAAE,gBAAgB;aACzB;YACD,aAAa,EAAE,4IAA4I;SAC5J;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,yDAAyD;SACzE;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,2CAA2C;YACpD,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,SAAS;aACV;YACD,YAAY,EAAE;gBACZ,SAAS,EAAE;oBACT,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,kBAAkB;qBAC3B;oBACD,aAAa,EAAE,gMAAgM;iBAChN;gBACD,mBAAmB,EAAE;oBACnB,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,iBAAiB;qBAC1B;oBACD,aAAa,EAAE,sGAAsG;iBACtH;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,gBAAgB;qBACzB;oBACD,aAAa,EAAE,oFAAoF;iBACpG;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,yDAAyD;iBACzE;aACF;SACF;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,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,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,UAAU,EAAE;YACV,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,SAAS;gBACT,KAAK;gBACL,WAAW;aACZ;YACD,aAAa,EAAE,wDAAwD;YACvE,YAAY,EAAE;gBACZ,SAAS,EAAE;oBACT,MAAM,EAAE,iBAAiB;iBAC1B;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,gBAAgB;oBACxB,aAAa,EAAE,iBAAiB;iBACjC;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,gBAAgB;oBACxB,aAAa,EAAE,2CAA2C;iBAC3D;aACF;SACF;QACD,SAAS,EAAE;YACT,OAAO,EAAE,SAAS;YAClB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,WAAW;gBACX,QAAQ;aACT;YACD,aAAa,EAAE,8LAA8L;SAC9M;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,2CAA2C;YACpD,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,SAAS;aACV;YACD,YAAY,EAAE;gBACZ,SAAS,EAAE;oBACT,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,kBAAkB;qBAC3B;oBACD,aAAa,EAAE,gMAAgM;iBAChN;gBACD,mBAAmB,EAAE;oBACnB,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,iBAAiB;qBAC1B;oBACD,aAAa,EAAE,sGAAsG;iBACtH;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,gBAAgB;qBACzB;oBACD,aAAa,EAAE,oFAAoF;iBACpG;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,yDAAyD;iBACzE;aACF;SACF;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,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,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,UAAU,EAAE;YACV,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,SAAS;gBACT,KAAK;gBACL,WAAW;aACZ;YACD,aAAa,EAAE,wDAAwD;YACvE,YAAY,EAAE;gBACZ,SAAS,EAAE;oBACT,MAAM,EAAE,iBAAiB;iBAC1B;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,gBAAgB;oBACxB,aAAa,EAAE,iBAAiB;iBACjC;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,gBAAgB;oBACxB,aAAa,EAAE,2CAA2C;iBAC3D;aACF;SACF;QACD,SAAS,EAAE;YACT,OAAO,EAAE,SAAS;YAClB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,WAAW;gBACX,QAAQ;aACT;YACD,aAAa,EAAE,8LAA8L;SAC9M;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}