@openvtc/trust-tasks 0.28.8 → 0.28.10

package/dist/vtc/elections/list/0.4/payload.js

@@ -0,0 +1,304 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/elections/list/0.4/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/elections/list/0.4";
+/**
+ * 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 = "0.3";
+/**
+ * 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 = "superseded by vtc/elections/list/0.5";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/elections/list/0.4#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/elections/list/0.4",
+    "title": "VTC Elections — List — payload",
+    "description": "A member or an administrator pages through the community's elections that the caller may see. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "state": {
+            "$ref": "#/$defs/RegistrarState"
+        },
+        "cursor": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 512,
+            "description": "An opaque continuation token from a previous response's `nextCursor`, bound to the caller and to `state`; a responder MUST NOT accept a cursor it did not issue."
+        },
+        "limit": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 100,
+            "description": "The most items to return; the responder chooses a default and MAY return fewer."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "RegistrarState": {
+            "title": "RegistrarState",
+            "description": "An election's state as its registrar holds it: the ballot box's `ElectionState` once the ballot box has registered the election, or, before that, `pendingRegistration` (the community is still delivering the registration) or `registrationRefused` (the ballot box refused it on a later delivery, and only a cancellation clears it). The first six values are the ballot box's `ElectionState` (voting/_shared/0.1).",
+            "type": "string",
+            "enum": [
+                "registered",
+                "registration",
+                "voting",
+                "closed",
+                "tallied",
+                "cancelled",
+                "pendingRegistration",
+                "registrationRefused"
+            ]
+        },
+        "ElectionListItem": {
+            "title": "ElectionListItem",
+            "description": "One election as a list shows it. vtc/elections/show reads it whole.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "electionId",
+                "state",
+                "votingOpensAt",
+                "votingClosesAt",
+                "binding",
+                "ticketHeld"
+            ],
+            "properties": {
+                "electionId": {
+                    "$ref": "#/$defs/ElectionId"
+                },
+                "title": {
+                    "type": "string",
+                    "maxLength": 512,
+                    "description": "The manifest's `title`, when it has one."
+                },
+                "state": {
+                    "$ref": "#/$defs/RegistrarState"
+                },
+                "votingOpensAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "maxLength": 64
+                },
+                "votingClosesAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "maxLength": 64
+                },
+                "binding": {
+                    "type": "boolean",
+                    "description": "The manifest's `binding`."
+                },
+                "ticketHeld": {
+                    "type": "boolean",
+                    "description": "Whether the community has issued a ticket for this election to the caller. About the caller only, never anyone else."
+                }
+            }
+        },
+        "Response": {
+            "$anchor": "response",
+            "title": "VTC Elections — List — response payload",
+            "description": "Success response to vtc/elections/list/0.2: one page of the elections the caller may see.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "elections"
+            ],
+            "properties": {
+                "elections": {
+                    "type": "array",
+                    "maxItems": 100,
+                    "items": {
+                        "$ref": "#/$defs/ElectionListItem"
+                    }
+                },
+                "nextCursor": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 512,
+                    "description": "Continuation token for the next page; pass it 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-]+)+$"
+            }
+        },
+        "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": {
+        "RegistrarState": {
+            "title": "RegistrarState",
+            "description": "An election's state as its registrar holds it: the ballot box's `ElectionState` once the ballot box has registered the election, or, before that, `pendingRegistration` (the community is still delivering the registration) or `registrationRefused` (the ballot box refused it on a later delivery, and only a cancellation clears it). The first six values are the ballot box's `ElectionState` (voting/_shared/0.1).",
+            "type": "string",
+            "enum": [
+                "registered",
+                "registration",
+                "voting",
+                "closed",
+                "tallied",
+                "cancelled",
+                "pendingRegistration",
+                "registrationRefused"
+            ]
+        },
+        "ElectionListItem": {
+            "title": "ElectionListItem",
+            "description": "One election as a list shows it. vtc/elections/show reads it whole.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "electionId",
+                "state",
+                "votingOpensAt",
+                "votingClosesAt",
+                "binding",
+                "ticketHeld"
+            ],
+            "properties": {
+                "electionId": {
+                    "$ref": "#/$defs/ElectionId"
+                },
+                "title": {
+                    "type": "string",
+                    "maxLength": 512,
+                    "description": "The manifest's `title`, when it has one."
+                },
+                "state": {
+                    "$ref": "#/$defs/RegistrarState"
+                },
+                "votingOpensAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "maxLength": 64
+                },
+                "votingClosesAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "maxLength": 64
+                },
+                "binding": {
+                    "type": "boolean",
+                    "description": "The manifest's `binding`."
+                },
+                "ticketHeld": {
+                    "type": "boolean",
+                    "description": "Whether the community has issued a ticket for this election to the caller. About the caller only, never anyone else."
+                }
+            }
+        },
+        "Response": {
+            "$anchor": "response",
+            "title": "VTC Elections — List — response payload",
+            "description": "Success response to vtc/elections/list/0.2: one page of the elections the caller may see.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "elections"
+            ],
+            "properties": {
+                "elections": {
+                    "type": "array",
+                    "maxItems": 100,
+                    "items": {
+                        "$ref": "#/$defs/ElectionListItem"
+                    }
+                },
+                "nextCursor": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 512,
+                    "description": "Continuation token for the next page; pass it 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-]+)+$"
+            }
+        },
+        "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: 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/elections/list/0.4/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vtc/elections/list/0.4/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA4EH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,oDAA6D,CAAC;AAEtF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAkB,KAAK,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAkB,sCAAsC,CAAC;AASjF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,6DAAsE,CAAC;AASxG;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,oDAAoD;IAC3D,OAAO,EAAE,gCAAgC;IACzC,aAAa,EAAE,4NAA4N;IAC3O,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,YAAY,EAAE;QACZ,OAAO,EAAE;YACP,MAAM,EAAE,wBAAwB;SACjC;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,kKAAkK;SAClL;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,GAAG;YACd,aAAa,EAAE,iFAAiF;SACjG;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,gBAAgB,EAAE;YAChB,OAAO,EAAE,gBAAgB;YACzB,aAAa,EAAE,2ZAA2Z;YAC1a,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,YAAY;gBACZ,cAAc;gBACd,QAAQ;gBACR,QAAQ;gBACR,SAAS;gBACT,WAAW;gBACX,qBAAqB;gBACrB,qBAAqB;aACtB;SACF;QACD,kBAAkB,EAAE;YAClB,OAAO,EAAE,kBAAkB;YAC3B,aAAa,EAAE,qEAAqE;YACpF,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,YAAY;gBACZ,OAAO;gBACP,eAAe;gBACf,gBAAgB;gBAChB,SAAS;gBACT,YAAY;aACb;YACD,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,oBAAoB;iBAC7B;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,0CAA0C;iBAC1D;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,wBAAwB;iBACjC;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,WAAW,EAAE,EAAE;iBAChB;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,WAAW,EAAE,EAAE;iBAChB;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,2BAA2B;iBAC3C;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,sHAAsH;iBACtI;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,yCAAyC;YAClD,aAAa,EAAE,2FAA2F;YAC1G,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,WAAW,EAAE;oBACX,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,0BAA0B;qBACnC;iBACF;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,oGAAoG;iBACpH;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;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,gBAAgB,EAAE;YAChB,OAAO,EAAE,gBAAgB;YACzB,aAAa,EAAE,2ZAA2Z;YAC1a,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,YAAY;gBACZ,cAAc;gBACd,QAAQ;gBACR,QAAQ;gBACR,SAAS;gBACT,WAAW;gBACX,qBAAqB;gBACrB,qBAAqB;aACtB;SACF;QACD,kBAAkB,EAAE;YAClB,OAAO,EAAE,kBAAkB;YAC3B,aAAa,EAAE,qEAAqE;YACpF,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,YAAY;gBACZ,OAAO;gBACP,eAAe;gBACf,gBAAgB;gBAChB,SAAS;gBACT,YAAY;aACb;YACD,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,oBAAoB;iBAC7B;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,0CAA0C;iBAC1D;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,wBAAwB;iBACjC;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,WAAW,EAAE,EAAE;iBAChB;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,WAAW,EAAE,EAAE;iBAChB;gBACD,SAAS,EAAE;oBACT,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,2BAA2B;iBAC3C;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,sHAAsH;iBACtI;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,yCAAyC;YAClD,aAAa,EAAE,2FAA2F;YAC1G,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,WAAW,EAAE;oBACX,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,0BAA0B;qBACnC;iBACF;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,oGAAoG;iBACpH;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;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"}