@openvtc/trust-tasks 0.28.10 → 0.28.12

package/dist/vtn/groups/register/0.1/payload.js

@@ -0,0 +1,291 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/groups/register/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtn/groups/register/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/vtn/groups/register/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/vtn/groups/register/0.1",
+    "title": "VTN Groups — Register — payload",
+    "description": "A member's registration of one of its groups to serve a network role. The signed document is the registration. The outer document members are owned by the framework — SPEC §6.3.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "role",
+        "group",
+        "endpoint"
+    ],
+    "properties": {
+        "role": {
+            "$ref": "#/$defs/RoleName",
+            "description": "The network's role the group serves."
+        },
+        "group": {
+            "type": "string",
+            "pattern": "^did:[a-z0-9]+:.+$",
+            "maxLength": 2048,
+            "description": "The group: a DID of the member's, or for a network its network group `<networkDid>#role-<localRole>`."
+        },
+        "endpoint": {
+            "type": "string",
+            "format": "uri",
+            "pattern": "^https://",
+            "maxLength": 2048,
+            "description": "The HTTPS URL at which the network delivers broadcasts for the group."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTN Groups — Register — response payload",
+            "description": "The registration as recorded: the member's signed request and the network's groupRegistered credential accepting it.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "group"
+            ],
+            "properties": {
+                "group": {
+                    "$ref": "#/$defs/RegisteredGroup"
+                },
+                "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-]+)+$"
+            }
+        },
+        "RegisteredGroup": {
+            "description": "A group serving a role: the member's signed registration and the network's groupRegistered credential accepting it.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "member",
+                "role",
+                "group",
+                "endpoint",
+                "registration",
+                "acceptance",
+                "registeredAt"
+            ],
+            "properties": {
+                "member": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The member that registered the group."
+                },
+                "role": {
+                    "$ref": "#/$defs/RoleName"
+                },
+                "group": {
+                    "type": "string",
+                    "maxLength": 2048,
+                    "description": "The group: a DID, or for a network group a DID URL on the network's DID (`<did>#role-<name>`)."
+                },
+                "endpoint": {
+                    "type": "string",
+                    "format": "uri",
+                    "maxLength": 2048,
+                    "description": "Where the network delivers broadcasts for the group."
+                },
+                "registration": {
+                    "$ref": "#/$defs/SignedTask",
+                    "description": "The member's signed vtn/groups/register request."
+                },
+                "acceptance": {
+                    "$ref": "#/$defs/Credential",
+                    "description": "The network's groupRegistered credential: a statement (`https://openvtc.org/vtn/vsc/groupRegistered/1`) issued by the accepting network, subject the group, `object.digestMultibase` the digest of `registration`, with a `credentialStatus` on the network's revocation list."
+                },
+                "registeredAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the network accepted the registration."
+                }
+            }
+        },
+        "SignedTask": {
+            "type": "object",
+            "description": "A complete Trust Task document, with its proof, exactly as signed and received. Verified as a document in its own right; open so its proof still covers every member, and so its digest can be recomputed."
+        },
+        "RoleName": {
+            "type": "string",
+            "pattern": "^[a-z0-9_-]{1,64}$",
+            "description": "A role's name: 1–64 lowercase letters, digits, `-` or `_`."
+        },
+        "Credential": {
+            "type": "object",
+            "description": "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers."
+        },
+        "Did": {
+            "type": "string",
+            "pattern": "^did:[a-z0-9]+:.+$",
+            "maxLength": 2048,
+            "description": "A DID."
+        }
+    }
+};
+/** 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": "VTN Groups — Register — response payload",
+            "description": "The registration as recorded: the member's signed request and the network's groupRegistered credential accepting it.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "group"
+            ],
+            "properties": {
+                "group": {
+                    "$ref": "#/$defs/RegisteredGroup"
+                },
+                "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-]+)+$"
+            }
+        },
+        "RegisteredGroup": {
+            "description": "A group serving a role: the member's signed registration and the network's groupRegistered credential accepting it.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "member",
+                "role",
+                "group",
+                "endpoint",
+                "registration",
+                "acceptance",
+                "registeredAt"
+            ],
+            "properties": {
+                "member": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The member that registered the group."
+                },
+                "role": {
+                    "$ref": "#/$defs/RoleName"
+                },
+                "group": {
+                    "type": "string",
+                    "maxLength": 2048,
+                    "description": "The group: a DID, or for a network group a DID URL on the network's DID (`<did>#role-<name>`)."
+                },
+                "endpoint": {
+                    "type": "string",
+                    "format": "uri",
+                    "maxLength": 2048,
+                    "description": "Where the network delivers broadcasts for the group."
+                },
+                "registration": {
+                    "$ref": "#/$defs/SignedTask",
+                    "description": "The member's signed vtn/groups/register request."
+                },
+                "acceptance": {
+                    "$ref": "#/$defs/Credential",
+                    "description": "The network's groupRegistered credential: a statement (`https://openvtc.org/vtn/vsc/groupRegistered/1`) issued by the accepting network, subject the group, `object.digestMultibase` the digest of `registration`, with a `credentialStatus` on the network's revocation list."
+                },
+                "registeredAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the network accepted the registration."
+                }
+            }
+        },
+        "SignedTask": {
+            "type": "object",
+            "description": "A complete Trust Task document, with its proof, exactly as signed and received. Verified as a document in its own right; open so its proof still covers every member, and so its digest can be recomputed."
+        },
+        "RoleName": {
+            "type": "string",
+            "pattern": "^[a-z0-9_-]{1,64}$",
+            "description": "A role's name: 1–64 lowercase letters, digits, `-` or `_`."
+        },
+        "Credential": {
+            "type": "object",
+            "description": "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers."
+        },
+        "Did": {
+            "type": "string",
+            "pattern": "^did:[a-z0-9]+:.+$",
+            "maxLength": 2048,
+            "description": "A DID."
+        }
+    }
+};
+/**
+ * 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/vtn/groups/register/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vtn/groups/register/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAkCH,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,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,8DAAuE,CAAC;AAKzG;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,qDAAqD;IAC5D,OAAO,EAAE,iCAAiC;IAC1C,aAAa,EAAE,mLAAmL;IAClM,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,MAAM;QACN,OAAO;QACP,UAAU;KACX;IACD,YAAY,EAAE;QACZ,MAAM,EAAE;YACN,MAAM,EAAE,kBAAkB;YAC1B,aAAa,EAAE,sCAAsC;SACtD;QACD,OAAO,EAAE;YACP,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,oBAAoB;YAC/B,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,uGAAuG;SACvH;QACD,UAAU,EAAE;YACV,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,KAAK;YACf,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,uEAAuE;SACvF;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,0CAA0C;YACnD,aAAa,EAAE,sHAAsH;YACrI,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,OAAO;aACR;YACD,YAAY,EAAE;gBACZ,OAAO,EAAE;oBACP,MAAM,EAAE,yBAAyB;iBAClC;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;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,iBAAiB,EAAE;YACjB,aAAa,EAAE,qHAAqH;YACpI,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;gBACR,MAAM;gBACN,OAAO;gBACP,UAAU;gBACV,cAAc;gBACd,YAAY;gBACZ,cAAc;aACf;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,uCAAuC;iBACvD;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,kBAAkB;iBAC3B;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,gGAAgG;iBAChH;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,KAAK;oBACf,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,sDAAsD;iBACtE;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,oBAAoB;oBAC5B,aAAa,EAAE,kDAAkD;iBAClE;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,oBAAoB;oBAC5B,aAAa,EAAE,gRAAgR;iBAChS;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,6CAA6C;iBAC7D;aACF;SACF;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,4MAA4M;SAC5N;QACD,UAAU,EAAE;YACV,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,oBAAoB;YAC/B,aAAa,EAAE,4DAA4D;SAC5E;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,sMAAsM;SACtN;QACD,KAAK,EAAE;YACL,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,oBAAoB;YAC/B,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,QAAQ;SACxB;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,0CAA0C;YACnD,aAAa,EAAE,sHAAsH;YACrI,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,OAAO;aACR;YACD,YAAY,EAAE;gBACZ,OAAO,EAAE;oBACP,MAAM,EAAE,yBAAyB;iBAClC;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;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,iBAAiB,EAAE;YACjB,aAAa,EAAE,qHAAqH;YACpI,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;gBACR,MAAM;gBACN,OAAO;gBACP,UAAU;gBACV,cAAc;gBACd,YAAY;gBACZ,cAAc;aACf;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,uCAAuC;iBACvD;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,kBAAkB;iBAC3B;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,gGAAgG;iBAChH;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,KAAK;oBACf,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,sDAAsD;iBACtE;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,oBAAoB;oBAC5B,aAAa,EAAE,kDAAkD;iBAClE;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,oBAAoB;oBAC5B,aAAa,EAAE,gRAAgR;iBAChS;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,6CAA6C;iBAC7D;aACF;SACF;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,4MAA4M;SAC5N;QACD,UAAU,EAAE;YACV,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,oBAAoB;YAC/B,aAAa,EAAE,4DAA4D;SAC5E;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,sMAAsM;SACtN;QACD,KAAK,EAAE;YACL,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,oBAAoB;YAC/B,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,QAAQ;SACxB;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"}