@openvtc/trust-tasks 0.25.0 → 0.25.2

package/dist/vta/pcs/tokens/abandon/0.1/payload.js

@@ -0,0 +1,355 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/tokens/abandon/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/pcs/tokens/abandon/0.1";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/tokens/abandon/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/vta/pcs/tokens/abandon/0.1",
+    "title": "VTA PCS — Tokens — Abandon — payload",
+    "description": "A vetter's client tells its VTA that the community refused a token draw, so the VTA stops holding it in flight.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "contextId",
+        "community",
+        "draw"
+    ],
+    "properties": {
+        "contextId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The context the engine belongs to. Its key is derived from this context's base."
+        },
+        "community": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The community's DID: the helper whose parameters the engine runs under."
+        },
+        "draw": {
+            "$ref": "#/$defs/TokenDraw"
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA PCS — Tokens — Abandon — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "vetter"
+            ],
+            "properties": {
+                "vetter": {
+                    "$ref": "#/$defs/VetterSummary"
+                },
+                "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-]+)+$"
+            }
+        },
+        "VetterSummary": {
+            "title": "VetterSummary",
+            "description": "A vetter engine as the VTA holds it, without its key, its credentials or its tokens.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "contextId",
+                "community",
+                "memberDid",
+                "suite",
+                "id",
+                "enrolledLabels",
+                "pendingLabels",
+                "tokensFree",
+                "tokensHeld",
+                "drawsInFlight",
+                "attested"
+            ],
+            "properties": {
+                "contextId": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "community": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "memberDid": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The member DID the engine draws tokens as. Bound into every token request."
+                },
+                "suite": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 64
+                },
+                "id": {
+                    "$ref": "#/$defs/Multibase",
+                    "description": "The vetter's PCS identifier for this community."
+                },
+                "enrolledLabels": {
+                    "type": "array",
+                    "description": "Class labels this vetter holds a credential under, newest first.",
+                    "items": {
+                        "type": "string",
+                        "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+                    }
+                },
+                "pendingLabels": {
+                    "type": "array",
+                    "description": "Class labels requested and not yet accepted.",
+                    "items": {
+                        "type": "string",
+                        "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+                    }
+                },
+                "tokensFree": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Tokens held and not reserved."
+                },
+                "tokensHeld": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Tokens held in all."
+                },
+                "drawsInFlight": {
+                    "type": "array",
+                    "description": "Draws requested and not yet accepted or abandoned.",
+                    "items": {
+                        "$ref": "#/$defs/TokenDraw"
+                    }
+                },
+                "attested": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Attestations made through this engine."
+                }
+            }
+        },
+        "TokenDraw": {
+            "title": "TokenDraw",
+            "description": "One draw of the token drip: a label and a tick.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "label",
+                "tick"
+            ],
+            "properties": {
+                "label": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128
+                },
+                "tick": {
+                    "type": "integer",
+                    "minimum": 0
+                }
+            }
+        },
+        "Multibase": {
+            "title": "Multibase",
+            "description": "A binary value, multibase base58btc over the suite's canonical encoding.",
+            "type": "string",
+            "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$"
+        }
+    }
+};
+/** 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": "VTA PCS — Tokens — Abandon — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "vetter"
+            ],
+            "properties": {
+                "vetter": {
+                    "$ref": "#/$defs/VetterSummary"
+                },
+                "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-]+)+$"
+            }
+        },
+        "VetterSummary": {
+            "title": "VetterSummary",
+            "description": "A vetter engine as the VTA holds it, without its key, its credentials or its tokens.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "contextId",
+                "community",
+                "memberDid",
+                "suite",
+                "id",
+                "enrolledLabels",
+                "pendingLabels",
+                "tokensFree",
+                "tokensHeld",
+                "drawsInFlight",
+                "attested"
+            ],
+            "properties": {
+                "contextId": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "community": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "memberDid": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The member DID the engine draws tokens as. Bound into every token request."
+                },
+                "suite": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 64
+                },
+                "id": {
+                    "$ref": "#/$defs/Multibase",
+                    "description": "The vetter's PCS identifier for this community."
+                },
+                "enrolledLabels": {
+                    "type": "array",
+                    "description": "Class labels this vetter holds a credential under, newest first.",
+                    "items": {
+                        "type": "string",
+                        "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+                    }
+                },
+                "pendingLabels": {
+                    "type": "array",
+                    "description": "Class labels requested and not yet accepted.",
+                    "items": {
+                        "type": "string",
+                        "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+                    }
+                },
+                "tokensFree": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Tokens held and not reserved."
+                },
+                "tokensHeld": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Tokens held in all."
+                },
+                "drawsInFlight": {
+                    "type": "array",
+                    "description": "Draws requested and not yet accepted or abandoned.",
+                    "items": {
+                        "$ref": "#/$defs/TokenDraw"
+                    }
+                },
+                "attested": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Attestations made through this engine."
+                }
+            }
+        },
+        "TokenDraw": {
+            "title": "TokenDraw",
+            "description": "One draw of the token drip: a label and a tick.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "label",
+                "tick"
+            ],
+            "properties": {
+                "label": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128
+                },
+                "tick": {
+                    "type": "integer",
+                    "minimum": 0
+                }
+            }
+        },
+        "Multibase": {
+            "title": "Multibase",
+            "description": "A binary value, multibase base58btc over the suite's canonical encoding.",
+            "type": "string",
+            "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$"
+        }
+    }
+};
+/**
+ * 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/vta/pcs/tokens/abandon/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vta/pcs/tokens/abandon/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA4BH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,wDAAiE,CAAC;AAK1F,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,iEAA0E,CAAC;AAK5G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,wDAAwD;IAC/D,OAAO,EAAE,sCAAsC;IAC/C,aAAa,EAAE,iHAAiH;IAChI,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,WAAW;QACX,WAAW;QACX,MAAM;KACP;IACD,YAAY,EAAE;QACZ,WAAW,EAAE;YACX,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,iFAAiF;SACjG;QACD,WAAW,EAAE;YACX,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,yEAAyE;SACzF;QACD,MAAM,EAAE;YACN,MAAM,EAAE,mBAAmB;SAC5B;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,+CAA+C;YACxD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,uBAAuB;iBAChC;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,eAAe,EAAE;YACf,OAAO,EAAE,eAAe;YACxB,aAAa,EAAE,sFAAsF;YACrG,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,WAAW;gBACX,WAAW;gBACX,WAAW;gBACX,OAAO;gBACP,IAAI;gBACJ,gBAAgB;gBAChB,eAAe;gBACf,YAAY;gBACZ,YAAY;gBACZ,eAAe;gBACf,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;iBACf;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;iBACf;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,4EAA4E;iBAC5F;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,EAAE;iBAChB;gBACD,IAAI,EAAE;oBACJ,MAAM,EAAE,mBAAmB;oBAC3B,aAAa,EAAE,iDAAiD;iBACjE;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,OAAO;oBACf,aAAa,EAAE,kEAAkE;oBACjF,OAAO,EAAE;wBACP,MAAM,EAAE,QAAQ;wBAChB,SAAS,EAAE,4BAA4B;qBACxC;iBACF;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,OAAO;oBACf,aAAa,EAAE,8CAA8C;oBAC7D,OAAO,EAAE;wBACP,MAAM,EAAE,QAAQ;wBAChB,SAAS,EAAE,4BAA4B;qBACxC;iBACF;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,+BAA+B;iBAC/C;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,qBAAqB;iBACrC;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,OAAO;oBACf,aAAa,EAAE,oDAAoD;oBACnE,OAAO,EAAE;wBACP,MAAM,EAAE,mBAAmB;qBAC5B;iBACF;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,wCAAwC;iBACxD;aACF;SACF;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,iDAAiD;YAChE,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,OAAO;gBACP,MAAM;aACP;YACD,YAAY,EAAE;gBACZ,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;iBACjB;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;iBACb;aACF;SACF;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,0EAA0E;YACzF,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,0BAA0B;SACtC;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,+CAA+C;YACxD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,uBAAuB;iBAChC;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,eAAe,EAAE;YACf,OAAO,EAAE,eAAe;YACxB,aAAa,EAAE,sFAAsF;YACrG,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,WAAW;gBACX,WAAW;gBACX,WAAW;gBACX,OAAO;gBACP,IAAI;gBACJ,gBAAgB;gBAChB,eAAe;gBACf,YAAY;gBACZ,YAAY;gBACZ,eAAe;gBACf,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;iBACf;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;iBACf;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,aAAa,EAAE,4EAA4E;iBAC5F;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,EAAE;iBAChB;gBACD,IAAI,EAAE;oBACJ,MAAM,EAAE,mBAAmB;oBAC3B,aAAa,EAAE,iDAAiD;iBACjE;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,OAAO;oBACf,aAAa,EAAE,kEAAkE;oBACjF,OAAO,EAAE;wBACP,MAAM,EAAE,QAAQ;wBAChB,SAAS,EAAE,4BAA4B;qBACxC;iBACF;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,OAAO;oBACf,aAAa,EAAE,8CAA8C;oBAC7D,OAAO,EAAE;wBACP,MAAM,EAAE,QAAQ;wBAChB,SAAS,EAAE,4BAA4B;qBACxC;iBACF;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,+BAA+B;iBAC/C;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,qBAAqB;iBACrC;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,OAAO;oBACf,aAAa,EAAE,oDAAoD;oBACnE,OAAO,EAAE;wBACP,MAAM,EAAE,mBAAmB;qBAC5B;iBACF;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,wCAAwC;iBACxD;aACF;SACF;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,iDAAiD;YAChE,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,OAAO;gBACP,MAAM;aACP;YACD,YAAY,EAAE;gBACZ,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;iBACjB;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;iBACb;aACF;SACF;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,0EAA0E;YACzF,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,0BAA0B;SACtC;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"}