@openvtc/trust-tasks 0.28.17 → 0.28.18

package/dist/vtn/registry/check/0.1/payload.js

@@ -0,0 +1,282 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/registry/check/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtn/registry/check/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/registry/check/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/registry/check/0.1",
+    "title": "VTN Registry — Check — payload",
+    "description": "Ask the network to ask its trust registry about one party. The outer document members are owned by the framework — SPEC §6.3.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "did"
+    ],
+    "properties": {
+        "did": {
+            "$ref": "#/$defs/Did",
+            "description": "The party asked about."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Actions": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "member",
+                "listed"
+            ],
+            "properties": {
+                "member": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The action acknowledged members are published under."
+                },
+                "listed": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The action listed parties are published under, where the network publishes them."
+                }
+            }
+        },
+        "Response": {
+            "$anchor": "response",
+            "title": "VTN Registry — Check — response payload",
+            "description": "What the registry answered, and its own answer document.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "registry",
+                "authority",
+                "resource",
+                "actions",
+                "did",
+                "reachable"
+            ],
+            "properties": {
+                "registry": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The trust registry asked."
+                },
+                "authority": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The network's DID: the authority of its records."
+                },
+                "resource": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The TRQP resource the network's records are published under."
+                },
+                "actions": {
+                    "$ref": "#/$defs/Actions"
+                },
+                "did": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The party asked about."
+                },
+                "reachable": {
+                    "type": "boolean",
+                    "description": "Whether the registry answered. `false` is indeterminate, never \"not a member\"."
+                },
+                "member": {
+                    "type": "boolean",
+                    "description": "Whether the registry holds an authorised member record for the party. Absent when not reachable."
+                },
+                "listed": {
+                    "type": "boolean",
+                    "description": "Whether the registry holds an authorised listed record for the party. Absent when not reachable."
+                },
+                "answer": {
+                    "type": "object",
+                    "description": "The registry's answer document, verbatim and signed by the registry."
+                },
+                "reason": {
+                    "type": "string",
+                    "maxLength": 1024,
+                    "description": "Why the registry could not be asked, when not reachable."
+                },
+                "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-]+)+$"
+            }
+        },
+        "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": {
+        "Actions": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "member",
+                "listed"
+            ],
+            "properties": {
+                "member": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The action acknowledged members are published under."
+                },
+                "listed": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The action listed parties are published under, where the network publishes them."
+                }
+            }
+        },
+        "Response": {
+            "$anchor": "response",
+            "title": "VTN Registry — Check — response payload",
+            "description": "What the registry answered, and its own answer document.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "registry",
+                "authority",
+                "resource",
+                "actions",
+                "did",
+                "reachable"
+            ],
+            "properties": {
+                "registry": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The trust registry asked."
+                },
+                "authority": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The network's DID: the authority of its records."
+                },
+                "resource": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The TRQP resource the network's records are published under."
+                },
+                "actions": {
+                    "$ref": "#/$defs/Actions"
+                },
+                "did": {
+                    "$ref": "#/$defs/Did",
+                    "description": "The party asked about."
+                },
+                "reachable": {
+                    "type": "boolean",
+                    "description": "Whether the registry answered. `false` is indeterminate, never \"not a member\"."
+                },
+                "member": {
+                    "type": "boolean",
+                    "description": "Whether the registry holds an authorised member record for the party. Absent when not reachable."
+                },
+                "listed": {
+                    "type": "boolean",
+                    "description": "Whether the registry holds an authorised listed record for the party. Absent when not reachable."
+                },
+                "answer": {
+                    "type": "object",
+                    "description": "The registry's answer document, verbatim and signed by the registry."
+                },
+                "reason": {
+                    "type": "string",
+                    "maxLength": 1024,
+                    "description": "Why the registry could not be asked, when not reachable."
+                },
+                "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-]+)+$"
+            }
+        },
+        "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: false,
+    isRecipientRequired: true,
+    isIssuedAtRequired: false,
+    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: false,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map

package/dist/vtn/registry/check/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vtn/registry/check/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwEH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,oDAA6D,CAAC;AAEtF;;;;;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,6DAAsE,CAAC;AAKxG;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,oDAAoD;IAC3D,OAAO,EAAE,gCAAgC;IACzC,aAAa,EAAE,+HAA+H;IAC9I,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,KAAK;KACN;IACD,YAAY,EAAE;QACZ,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,wBAAwB;SACxC;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,SAAS,EAAE;YACT,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;gBACR,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,sDAAsD;iBACtE;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,kFAAkF;iBAClG;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,yCAAyC;YAClD,aAAa,EAAE,0DAA0D;YACzE,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;gBACV,WAAW;gBACX,UAAU;gBACV,SAAS;gBACT,KAAK;gBACL,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,2BAA2B;iBAC3C;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,kDAAkD;iBAClE;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,8DAA8D;iBAC9E;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,iBAAiB;iBAC1B;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,wBAAwB;iBACxC;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,kFAAkF;iBAClG;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,kGAAkG;iBAClH;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,kGAAkG;iBAClH;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,sEAAsE;iBACtF;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,0DAA0D;iBAC1E;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,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,SAAS,EAAE;YACT,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;gBACR,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,sDAAsD;iBACtE;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,kFAAkF;iBAClG;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,yCAAyC;YAClD,aAAa,EAAE,0DAA0D;YACzE,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;gBACV,WAAW;gBACX,UAAU;gBACV,SAAS;gBACT,KAAK;gBACL,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,2BAA2B;iBAC3C;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,kDAAkD;iBAClE;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,8DAA8D;iBAC9E;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,iBAAiB;iBAC1B;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,wBAAwB;iBACxC;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,kFAAkF;iBAClG;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,kGAAkG;iBAClH;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,kGAAkG;iBAClH;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,sEAAsE;iBACtF;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,0DAA0D;iBAC1E;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,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,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,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,KAAK;IACzB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}