@openvtc/trust-tasks 0.26.20 → 0.26.21

package/dist/vta/pcs/voter/receipt/0.1/payload.js

@@ -0,0 +1,301 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/voter/receipt/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/pcs/voter/receipt/0.1";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/voter/receipt/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/voter/receipt/0.1",
+    "title": "VTA PCS — Voter Receipt — payload",
+    "description": "A voter's client hands its VTA the ballot box's receipt for a cast, and optionally a checkpoint and an inclusion proof; the VTA checks the receipt is the voter's, keeps it, and says whether the cast is in the checkpoint.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "contextId",
+        "community",
+        "electionId",
+        "receipt"
+    ],
+    "dependentRequired": {
+        "checkpoint": [
+            "inclusion"
+        ],
+        "inclusion": [
+            "checkpoint"
+        ]
+    },
+    "properties": {
+        "contextId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256,
+            "description": "The context the voter belongs to."
+        },
+        "community": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 2048,
+            "description": "The community's DID."
+        },
+        "electionId": {
+            "$ref": "#/$defs/ElectionId"
+        },
+        "receipt": {
+            "type": "object",
+            "description": "The ballot box's signed voting/ballot/cast/0.1 #response document, whole and exactly as received."
+        },
+        "checkpoint": {
+            "type": "object",
+            "description": "A signed voting/board/head/0.1 #response document, whole and exactly as received — typically the head the community kept at close (vtc/elections/show checkpoints)."
+        },
+        "inclusion": {
+            "$ref": "#/$defs/Inclusion"
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Inclusion": {
+            "title": "Inclusion",
+            "description": "The members of a voting/board/inclusion/0.1 response that prove one entry is in a head: RFC 9162 §2.1.3 audit path for `leafIndex` in a tree of `treeSize`.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "leafIndex",
+                "treeSize",
+                "entryHash",
+                "path"
+            ],
+            "properties": {
+                "leafIndex": {
+                    "type": "integer",
+                    "minimum": 0
+                },
+                "treeSize": {
+                    "type": "integer",
+                    "minimum": 1
+                },
+                "entryHash": {
+                    "$ref": "#/$defs/DigestMultibase",
+                    "description": "The RFC 9162 leaf hash of the entry at `leafIndex`, as a multihash."
+                },
+                "path": {
+                    "$ref": "#/$defs/MerklePath"
+                }
+            }
+        },
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA PCS — Voter Receipt — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "electionId",
+                "status",
+                "leafIndex"
+            ],
+            "properties": {
+                "electionId": {
+                    "$ref": "#/$defs/ElectionId"
+                },
+                "status": {
+                    "type": "string",
+                    "enum": [
+                        "kept",
+                        "included",
+                        "notIncluded"
+                    ],
+                    "description": "`kept`: the receipt is the voter's and is kept; no checkpoint was given. `included`: the cast is in the checkpoint. `notIncluded`: the checkpoint is a valid head of the election and the evidence does not show the cast in it — the client MUST show this to the voter (VTI-VOT-053)."
+                },
+                "leafIndex": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "The board position the receipt assigns to the cast."
+                },
+                "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-]+)+$"
+            }
+        },
+        "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}$"
+        },
+        "MerklePath": {
+            "title": "MerklePath",
+            "description": "An RFC 9162 audit or consistency path: the node hashes, in the order §2.1.3 / §2.1.4 define.",
+            "type": "array",
+            "maxItems": 64,
+            "items": {
+                "$ref": "#/$defs/DigestMultibase"
+            }
+        },
+        "DigestMultibase": {
+            "title": "DigestMultibase",
+            "description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
+            "type": "string",
+            "minLength": 16,
+            "pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$",
+            "examples": [
+                "zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
+            ]
+        }
+    }
+};
+/** 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": {
+        "Inclusion": {
+            "title": "Inclusion",
+            "description": "The members of a voting/board/inclusion/0.1 response that prove one entry is in a head: RFC 9162 §2.1.3 audit path for `leafIndex` in a tree of `treeSize`.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "leafIndex",
+                "treeSize",
+                "entryHash",
+                "path"
+            ],
+            "properties": {
+                "leafIndex": {
+                    "type": "integer",
+                    "minimum": 0
+                },
+                "treeSize": {
+                    "type": "integer",
+                    "minimum": 1
+                },
+                "entryHash": {
+                    "$ref": "#/$defs/DigestMultibase",
+                    "description": "The RFC 9162 leaf hash of the entry at `leafIndex`, as a multihash."
+                },
+                "path": {
+                    "$ref": "#/$defs/MerklePath"
+                }
+            }
+        },
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA PCS — Voter Receipt — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "electionId",
+                "status",
+                "leafIndex"
+            ],
+            "properties": {
+                "electionId": {
+                    "$ref": "#/$defs/ElectionId"
+                },
+                "status": {
+                    "type": "string",
+                    "enum": [
+                        "kept",
+                        "included",
+                        "notIncluded"
+                    ],
+                    "description": "`kept`: the receipt is the voter's and is kept; no checkpoint was given. `included`: the cast is in the checkpoint. `notIncluded`: the checkpoint is a valid head of the election and the evidence does not show the cast in it — the client MUST show this to the voter (VTI-VOT-053)."
+                },
+                "leafIndex": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "The board position the receipt assigns to the cast."
+                },
+                "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-]+)+$"
+            }
+        },
+        "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}$"
+        },
+        "MerklePath": {
+            "title": "MerklePath",
+            "description": "An RFC 9162 audit or consistency path: the node hashes, in the order §2.1.3 / §2.1.4 define.",
+            "type": "array",
+            "maxItems": 64,
+            "items": {
+                "$ref": "#/$defs/DigestMultibase"
+            }
+        },
+        "DigestMultibase": {
+            "title": "DigestMultibase",
+            "description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
+            "type": "string",
+            "minLength": 16,
+            "pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$",
+            "examples": [
+                "zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
+            ]
+        }
+    }
+};
+/**
+ * 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/voter/receipt/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vta/pcs/voter/receipt/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAyDH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,uDAAgE,CAAC;AAKzF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,gEAAyE,CAAC;AAK3G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,uDAAuD;IAC9D,OAAO,EAAE,mCAAmC;IAC5C,aAAa,EAAE,8NAA8N;IAC7O,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,WAAW;QACX,WAAW;QACX,YAAY;QACZ,SAAS;KACV;IACD,mBAAmB,EAAE;QACnB,YAAY,EAAE;YACZ,WAAW;SACZ;QACD,WAAW,EAAE;YACX,YAAY;SACb;KACF;IACD,YAAY,EAAE;QACZ,WAAW,EAAE;YACX,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,mCAAmC;SACnD;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,aAAa,EAAE,mGAAmG;SACnH;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,qKAAqK;SACrL;QACD,WAAW,EAAE;YACX,MAAM,EAAE,mBAAmB;SAC5B;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,6JAA6J;YAC5K,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,WAAW;gBACX,UAAU;gBACV,WAAW;gBACX,MAAM;aACP;YACD,YAAY,EAAE;gBACZ,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;iBACb;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;iBACb;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,yBAAyB;oBACjC,aAAa,EAAE,qEAAqE;iBACrF;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,oBAAoB;iBAC7B;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,4CAA4C;YACrD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,YAAY;gBACZ,QAAQ;gBACR,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,oBAAoB;iBAC7B;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE;wBACN,MAAM;wBACN,UAAU;wBACV,aAAa;qBACd;oBACD,aAAa,EAAE,yRAAyR;iBACzS;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,qDAAqD;iBACrE;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,YAAY,EAAE;YACZ,OAAO,EAAE,YAAY;YACrB,aAAa,EAAE,uLAAuL;YACtM,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,yBAAyB;SACrC;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,YAAY;YACrB,aAAa,EAAE,8FAA8F;YAC7G,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,EAAE;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,yBAAyB;aAClC;SACF;QACD,iBAAiB,EAAE;YACjB,OAAO,EAAE,iBAAiB;YAC1B,aAAa,EAAE,gnDAAgnD;YAC/nD,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,EAAE;YACf,SAAS,EAAE,4CAA4C;YACvD,UAAU,EAAE;gBACV,iDAAiD;aAClD;SACF;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,6JAA6J;YAC5K,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,WAAW;gBACX,UAAU;gBACV,WAAW;gBACX,MAAM;aACP;YACD,YAAY,EAAE;gBACZ,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;iBACb;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;iBACb;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,yBAAyB;oBACjC,aAAa,EAAE,qEAAqE;iBACrF;gBACD,MAAM,EAAE;oBACN,MAAM,EAAE,oBAAoB;iBAC7B;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,4CAA4C;YACrD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,YAAY;gBACZ,QAAQ;gBACR,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,oBAAoB;iBAC7B;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE;wBACN,MAAM;wBACN,UAAU;wBACV,aAAa;qBACd;oBACD,aAAa,EAAE,yRAAyR;iBACzS;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;oBACZ,aAAa,EAAE,qDAAqD;iBACrE;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,YAAY,EAAE;YACZ,OAAO,EAAE,YAAY;YACrB,aAAa,EAAE,uLAAuL;YACtM,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,yBAAyB;SACrC;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,YAAY;YACrB,aAAa,EAAE,8FAA8F;YAC7G,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,EAAE;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,yBAAyB;aAClC;SACF;QACD,iBAAiB,EAAE;YACjB,OAAO,EAAE,iBAAiB;YAC1B,aAAa,EAAE,gnDAAgnD;YAC/nD,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,EAAE;YACf,SAAS,EAAE,4CAA4C;YACvD,UAAU,EAAE;gBACV,iDAAiD;aAClD;SACF;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"}