@openvtc/trust-tasks 0.27.2 → 0.27.4

package/dist/vtc/registry/records/list/0.2/payload.js

@@ -0,0 +1,306 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/registry/records/list/0.2/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/registry/records/list/0.2";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/registry/records/list/0.2#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/vtc/registry/records/list/0.2",
+    "title": "VTC Registry Records List — payload",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "entityId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Filter to records about this entity."
+        },
+        "authorityId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Filter to records asserted by this authority."
+        },
+        "action": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Filter to records for this action."
+        },
+        "resource": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Filter to records for this resource."
+        },
+        "source": {
+            "$ref": "#/$defs/Source",
+            "description": "Which view to enumerate. Defaults to `registry`."
+        },
+        "cursor": {
+            "type": "string",
+            "description": "An opaque continuation token from a previous response's `nextCursor`; a responder MUST NOT accept a cursor it did not issue."
+        },
+        "limit": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 200,
+            "description": "The most items to return, at most 200; the responder chooses a default (50) and MAY return fewer."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Source": {
+            "type": "string",
+            "enum": [
+                "registry",
+                "local"
+            ],
+            "description": "`registry` enumerates the trust registry itself; `local` enumerates the community's own record of what it published. They are different questions and a consumer MUST NOT treat one as a cache of the other."
+        },
+        "Record": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "entityId",
+                "authorityId",
+                "action",
+                "resource",
+                "recordType"
+            ],
+            "properties": {
+                "entityId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The entity the record is about."
+                },
+                "authorityId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The authority asserting it."
+                },
+                "action": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The action the assertion covers."
+                },
+                "resource": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The resource the assertion covers."
+                },
+                "recordType": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "Record discriminator, as the trust registry states it."
+                },
+                "recognized": {
+                    "type": [
+                        "boolean",
+                        "null"
+                    ],
+                    "description": "Present on recognition records: whether the action+resource is recognised. Absent on other record types — absent is not `false`."
+                },
+                "authorized": {
+                    "type": [
+                        "boolean",
+                        "null"
+                    ],
+                    "description": "Present on authorization records: whether the action+resource authorization is confirmed. Absent on other record types — absent is not `false`."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "Response": {
+            "$anchor": "response",
+            "title": "VTC Registry Records List — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "items",
+                "source"
+            ],
+            "properties": {
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/Record"
+                    },
+                    "description": "The matching records, in the maintainer's stable enumeration order."
+                },
+                "source": {
+                    "$ref": "#/$defs/Source",
+                    "description": "Which view these items came from, echoed so a consumer never has to infer it from the request it thinks it sent."
+                },
+                "nextCursor": {
+                    "type": "string",
+                    "description": "Continuation token for the next page; pass it back as `cursor`. Absent on the last page — never `null`."
+                },
+                "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-]+)+$"
+            }
+        }
+    }
+};
+/** 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": {
+        "Source": {
+            "type": "string",
+            "enum": [
+                "registry",
+                "local"
+            ],
+            "description": "`registry` enumerates the trust registry itself; `local` enumerates the community's own record of what it published. They are different questions and a consumer MUST NOT treat one as a cache of the other."
+        },
+        "Record": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "entityId",
+                "authorityId",
+                "action",
+                "resource",
+                "recordType"
+            ],
+            "properties": {
+                "entityId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The entity the record is about."
+                },
+                "authorityId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The authority asserting it."
+                },
+                "action": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The action the assertion covers."
+                },
+                "resource": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The resource the assertion covers."
+                },
+                "recordType": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "Record discriminator, as the trust registry states it."
+                },
+                "recognized": {
+                    "type": [
+                        "boolean",
+                        "null"
+                    ],
+                    "description": "Present on recognition records: whether the action+resource is recognised. Absent on other record types — absent is not `false`."
+                },
+                "authorized": {
+                    "type": [
+                        "boolean",
+                        "null"
+                    ],
+                    "description": "Present on authorization records: whether the action+resource authorization is confirmed. Absent on other record types — absent is not `false`."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "Response": {
+            "$anchor": "response",
+            "title": "VTC Registry Records List — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "items",
+                "source"
+            ],
+            "properties": {
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/Record"
+                    },
+                    "description": "The matching records, in the maintainer's stable enumeration order."
+                },
+                "source": {
+                    "$ref": "#/$defs/Source",
+                    "description": "Which view these items came from, echoed so a consumer never has to infer it from the request it thinks it sent."
+                },
+                "nextCursor": {
+                    "type": "string",
+                    "description": "Continuation token for the next page; pass it back as `cursor`. Absent on the last page — never `null`."
+                },
+                "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-]+)+$"
+            }
+        }
+    }
+};
+/**
+ * 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/vtc/registry/records/list/0.2/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vtc/registry/records/list/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAsFH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,2DAAoE,CAAC;AAK7F,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,oEAA6E,CAAC;AAK/G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,2DAA2D;IAClE,OAAO,EAAE,qCAAqC;IAC9C,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,YAAY,EAAE;QACZ,UAAU,EAAE;YACV,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,sCAAsC;SACtD;QACD,aAAa,EAAE;YACb,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,+CAA+C;SAC/D;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,oCAAoC;SACpD;QACD,UAAU,EAAE;YACV,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,sCAAsC;SACtD;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,gBAAgB;YACxB,aAAa,EAAE,kDAAkD;SAClE;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,8HAA8H;SAC9I;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,GAAG;YACd,aAAa,EAAE,mGAAmG;SACnH;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,UAAU;gBACV,OAAO;aACR;YACD,aAAa,EAAE,8MAA8M;SAC9N;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;gBACV,aAAa;gBACb,QAAQ;gBACR,UAAU;gBACV,YAAY;aACb;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,iCAAiC;iBACjD;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,6BAA6B;iBAC7C;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,kCAAkC;iBAClD;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,oCAAoC;iBACpD;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,wDAAwD;iBACxE;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE;wBACN,SAAS;wBACT,MAAM;qBACP;oBACD,aAAa,EAAE,kIAAkI;iBAClJ;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE;wBACN,SAAS;wBACT,MAAM;qBACP;oBACD,aAAa,EAAE,iJAAiJ;iBACjK;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,8CAA8C;YACvD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,OAAO;gBACP,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,OAAO,EAAE;oBACP,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,gBAAgB;qBACzB;oBACD,aAAa,EAAE,qEAAqE;iBACrF;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,gBAAgB;oBACxB,aAAa,EAAE,kHAAkH;iBAClI;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,yGAAyG;iBACzH;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;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,UAAU;gBACV,OAAO;aACR;YACD,aAAa,EAAE,8MAA8M;SAC9N;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;gBACV,aAAa;gBACb,QAAQ;gBACR,UAAU;gBACV,YAAY;aACb;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,iCAAiC;iBACjD;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,6BAA6B;iBAC7C;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,kCAAkC;iBAClD;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,oCAAoC;iBACpD;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,wDAAwD;iBACxE;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE;wBACN,SAAS;wBACT,MAAM;qBACP;oBACD,aAAa,EAAE,kIAAkI;iBAClJ;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE;wBACN,SAAS;wBACT,MAAM;qBACP;oBACD,aAAa,EAAE,iJAAiJ;iBACjK;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,8CAA8C;YACvD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,OAAO;gBACP,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,OAAO,EAAE;oBACP,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,gBAAgB;qBACzB;oBACD,aAAa,EAAE,qEAAqE;iBACrF;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,gBAAgB;oBACxB,aAAa,EAAE,kHAAkH;iBAClI;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,yGAAyG;iBACzH;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;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"}