@openvtc/trust-tasks 0.26.24 → 0.26.26

package/dist/vta/pcs/trustee/justify/0.1/payload.js

@@ -0,0 +1,274 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/trustee/justify/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/pcs/trustee/justify/0.1";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/trustee/justify/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/trustee/justify/0.1",
+    "title": "VTA PCS — Trustee Justify — payload",
+    "description": "The dealer's VTA reveals the share it dealt to a trustee that complained, and returns the voting/trustees/justify request signed as the dealer.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "contextId",
+        "community",
+        "electionId",
+        "trustee",
+        "recipient"
+    ],
+    "properties": {
+        "contextId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256,
+            "description": "The VTA context the trustee's keys live in."
+        },
+        "community": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 2048,
+            "description": "The community's DID."
+        },
+        "electionId": {
+            "$ref": "#/$defs/ElectionId"
+        },
+        "trustee": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 2048,
+            "description": "The trustee's DID: a persona this VTA holds, named in the manifest's `trustees.dids`."
+        },
+        "recipient": {
+            "$ref": "#/$defs/TrusteeIndex"
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA PCS — Trustee Justify — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "document"
+            ],
+            "properties": {
+                "document": {
+                    "title": "JustifyDocument",
+                    "description": "The voting/trustees/justify request, signed as the trustee.",
+                    "type": "object",
+                    "required": [
+                        "id",
+                        "type",
+                        "issuer",
+                        "recipient",
+                        "issuedAt",
+                        "payload",
+                        "proof"
+                    ],
+                    "properties": {
+                        "id": {
+                            "type": "string",
+                            "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+                        },
+                        "type": {
+                            "const": "https://trusttasks.org/spec/voting/trustees/justify/0.1"
+                        },
+                        "issuer": {
+                            "type": "string",
+                            "minLength": 1,
+                            "maxLength": 2048,
+                            "description": "The signer."
+                        },
+                        "recipient": {
+                            "type": "string",
+                            "minLength": 1,
+                            "maxLength": 2048,
+                            "description": "The ballot box."
+                        },
+                        "issuedAt": {
+                            "type": "string",
+                            "format": "date-time"
+                        },
+                        "expiresAt": {
+                            "type": "string",
+                            "format": "date-time"
+                        },
+                        "payload": {
+                            "type": "object",
+                            "description": "That task's request payload."
+                        },
+                        "proof": {
+                            "type": "object",
+                            "description": "A Data Integrity proof by an `authentication` key of `issuer`."
+                        }
+                    }
+                },
+                "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-]+)+$"
+            }
+        },
+        "TrusteeIndex": {
+            "title": "TrusteeIndex",
+            "description": "A trustee's index: its position in the manifest's `trustees.dids`, counting from 1.",
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 64
+        },
+        "ElectionId": {
+            "title": "ElectionId",
+            "description": "An election's identifier, unique within its community. A closed alphabet: it appears in the ticket class label `voter/<electionId>` and is framed into every hash a cast is bound to.",
+            "type": "string",
+            "pattern": "^[A-Za-z0-9._-]{1,128}$"
+        }
+    }
+};
+/** 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 — Trustee Justify — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "document"
+            ],
+            "properties": {
+                "document": {
+                    "title": "JustifyDocument",
+                    "description": "The voting/trustees/justify request, signed as the trustee.",
+                    "type": "object",
+                    "required": [
+                        "id",
+                        "type",
+                        "issuer",
+                        "recipient",
+                        "issuedAt",
+                        "payload",
+                        "proof"
+                    ],
+                    "properties": {
+                        "id": {
+                            "type": "string",
+                            "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+                        },
+                        "type": {
+                            "const": "https://trusttasks.org/spec/voting/trustees/justify/0.1"
+                        },
+                        "issuer": {
+                            "type": "string",
+                            "minLength": 1,
+                            "maxLength": 2048,
+                            "description": "The signer."
+                        },
+                        "recipient": {
+                            "type": "string",
+                            "minLength": 1,
+                            "maxLength": 2048,
+                            "description": "The ballot box."
+                        },
+                        "issuedAt": {
+                            "type": "string",
+                            "format": "date-time"
+                        },
+                        "expiresAt": {
+                            "type": "string",
+                            "format": "date-time"
+                        },
+                        "payload": {
+                            "type": "object",
+                            "description": "That task's request payload."
+                        },
+                        "proof": {
+                            "type": "object",
+                            "description": "A Data Integrity proof by an `authentication` key of `issuer`."
+                        }
+                    }
+                },
+                "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-]+)+$"
+            }
+        },
+        "TrusteeIndex": {
+            "title": "TrusteeIndex",
+            "description": "A trustee's index: its position in the manifest's `trustees.dids`, counting from 1.",
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 64
+        },
+        "ElectionId": {
+            "title": "ElectionId",
+            "description": "An election's identifier, unique within its community. A closed alphabet: it appears in the ticket class label `voter/<electionId>` and is framed into every hash a cast is bound to.",
+            "type": "string",
+            "pattern": "^[A-Za-z0-9._-]{1,128}$"
+        }
+    }
+};
+/**
+ * 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/trustee/justify/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vta/pcs/trustee/justify/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA0DH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,yDAAkE,CAAC;AAK3F,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,kEAA2E,CAAC;AAK7G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,yDAAyD;IAChE,OAAO,EAAE,qCAAqC;IAC9C,aAAa,EAAE,iJAAiJ;IAChK,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,WAAW;QACX,WAAW;QACX,YAAY;QACZ,SAAS;QACT,WAAW;KACZ;IACD,YAAY,EAAE;QACZ,WAAW,EAAE;YACX,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,6CAA6C;SAC7D;QACD,WAAW,EAAE;YACX,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,sBAAsB;SACtC;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,oBAAoB;SAC7B;QACD,SAAS,EAAE;YACT,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,uFAAuF;SACvG;QACD,WAAW,EAAE;YACX,MAAM,EAAE,sBAAsB;SAC/B;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,8CAA8C;YACvD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,OAAO,EAAE,iBAAiB;oBAC1B,aAAa,EAAE,6DAA6D;oBAC5E,MAAM,EAAE,QAAQ;oBAChB,UAAU,EAAE;wBACV,IAAI;wBACJ,MAAM;wBACN,QAAQ;wBACR,WAAW;wBACX,UAAU;wBACV,SAAS;wBACT,OAAO;qBACR;oBACD,YAAY,EAAE;wBACZ,IAAI,EAAE;4BACJ,MAAM,EAAE,QAAQ;4BAChB,SAAS,EAAE,gFAAgF;yBAC5F;wBACD,MAAM,EAAE;4BACN,OAAO,EAAE,yDAAyD;yBACnE;wBACD,QAAQ,EAAE;4BACR,MAAM,EAAE,QAAQ;4BAChB,WAAW,EAAE,CAAC;4BACd,WAAW,EAAE,IAAI;4BACjB,aAAa,EAAE,aAAa;yBAC7B;wBACD,WAAW,EAAE;4BACX,MAAM,EAAE,QAAQ;4BAChB,WAAW,EAAE,CAAC;4BACd,WAAW,EAAE,IAAI;4BACjB,aAAa,EAAE,iBAAiB;yBACjC;wBACD,UAAU,EAAE;4BACV,MAAM,EAAE,QAAQ;4BAChB,QAAQ,EAAE,WAAW;yBACtB;wBACD,WAAW,EAAE;4BACX,MAAM,EAAE,QAAQ;4BAChB,QAAQ,EAAE,WAAW;yBACtB;wBACD,SAAS,EAAE;4BACT,MAAM,EAAE,QAAQ;4BAChB,aAAa,EAAE,8BAA8B;yBAC9C;wBACD,OAAO,EAAE;4BACP,MAAM,EAAE,QAAQ;4BAChB,aAAa,EAAE,gEAAgE;yBAChF;qBACF;iBACF;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,cAAc,EAAE;YACd,OAAO,EAAE,cAAc;YACvB,aAAa,EAAE,qFAAqF;YACpG,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;SACd;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,YAAY;YACrB,aAAa,EAAE,uLAAuL;YACtM,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,yBAAyB;SACrC;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,8CAA8C;YACvD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,OAAO,EAAE,iBAAiB;oBAC1B,aAAa,EAAE,6DAA6D;oBAC5E,MAAM,EAAE,QAAQ;oBAChB,UAAU,EAAE;wBACV,IAAI;wBACJ,MAAM;wBACN,QAAQ;wBACR,WAAW;wBACX,UAAU;wBACV,SAAS;wBACT,OAAO;qBACR;oBACD,YAAY,EAAE;wBACZ,IAAI,EAAE;4BACJ,MAAM,EAAE,QAAQ;4BAChB,SAAS,EAAE,gFAAgF;yBAC5F;wBACD,MAAM,EAAE;4BACN,OAAO,EAAE,yDAAyD;yBACnE;wBACD,QAAQ,EAAE;4BACR,MAAM,EAAE,QAAQ;4BAChB,WAAW,EAAE,CAAC;4BACd,WAAW,EAAE,IAAI;4BACjB,aAAa,EAAE,aAAa;yBAC7B;wBACD,WAAW,EAAE;4BACX,MAAM,EAAE,QAAQ;4BAChB,WAAW,EAAE,CAAC;4BACd,WAAW,EAAE,IAAI;4BACjB,aAAa,EAAE,iBAAiB;yBACjC;wBACD,UAAU,EAAE;4BACV,MAAM,EAAE,QAAQ;4BAChB,QAAQ,EAAE,WAAW;yBACtB;wBACD,WAAW,EAAE;4BACX,MAAM,EAAE,QAAQ;4BAChB,QAAQ,EAAE,WAAW;yBACtB;wBACD,SAAS,EAAE;4BACT,MAAM,EAAE,QAAQ;4BAChB,aAAa,EAAE,8BAA8B;yBAC9C;wBACD,OAAO,EAAE;4BACP,MAAM,EAAE,QAAQ;4BAChB,aAAa,EAAE,gEAAgE;yBAChF;qBACF;iBACF;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,cAAc,EAAE;YACd,OAAO,EAAE,cAAc;YACvB,aAAa,EAAE,qFAAqF;YACpG,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;SACd;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,YAAY;YACrB,aAAa,EAAE,uLAAuL;YACtM,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,yBAAyB;SACrC;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"}