@openvtc/trust-tasks 0.28.6 → 0.28.8

package/dist/vta/pcs/voter/read/0.3/payload.d.ts

@@ -0,0 +1,503 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/voter/read/0.3/payload.schema.json
+ */
+import type { Ext } from "../../../../../_shared/components.js";
+/**
+ * A voter's client asks its VTA for a vtc/elections/list or vtc/elections/show request signed as the voter's membership DID, so the client can read the community's elections as the member without holding the member's key.
+ */
+export interface VTAPCSVoterReadPayload {
+    /**
+     * The context the voter belongs to.
+     */
+    contextId: string;
+    /**
+     * The community's DID: the recipient of the signed request.
+     */
+    community: string;
+    /**
+     * The voter's membership DID at the community. MUST be a DID the engine holds an authentication key of that the caller may act as.
+     */
+    member: string;
+    /**
+     * Which read to sign: vtc/elections/list/0.3 or vtc/elections/show/0.3.
+     */
+    read: "list" | "show";
+    /**
+     * The request payload of that task, validated against its own schema.
+     */
+    payload: {};
+    ext?: Ext;
+}
+/**
+ * The signed read, to send to the community.
+ */
+export interface VTAPCSVoterReadResponsePayload {
+    document: ReadDocument;
+    ext?: Ext;
+}
+/**
+ * A complete, signed vtc/elections/list/0.3 or vtc/elections/show/0.3 request document, ready to send to the community unchanged.
+ */
+export interface ReadDocument {
+    id: string;
+    type: "https://trusttasks.org/spec/vtc/elections/list/0.3" | "https://trusttasks.org/spec/vtc/elections/show/0.3";
+    /**
+     * The request's `member`.
+     */
+    issuer: string;
+    /**
+     * The request's `community`.
+     */
+    recipient: string;
+    issuedAt: string;
+    expiresAt?: string;
+    /**
+     * The request's `payload`, exactly.
+     */
+    payload: {};
+    /**
+     * A Data Integrity proof by an `authentication` key of `issuer`.
+     */
+    proof: {};
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vta/pcs/voter/read/0.3";
+/**
+ * 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 declare const EXTENDS: string | null;
+/**
+ * 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 declare const DEPRECATION: string | null;
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAPCSVoterReadPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/pcs/voter/read/0.3#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAPCSVoterReadResponsePayload;
+/**
+ * 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vta/pcs/voter/read/0.3";
+    readonly title: "VTA PCS — Voter Read — payload";
+    readonly description: "A voter's client asks its VTA for a vtc/elections/list or vtc/elections/show request signed as the voter's membership DID, so the client can read the community's elections as the member without holding the member's key.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["contextId", "community", "member", "read", "payload"];
+    readonly properties: {
+        readonly contextId: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+            readonly description: "The context the voter belongs to.";
+        };
+        readonly community: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 2048;
+            readonly description: "The community's DID: the recipient of the signed request.";
+        };
+        readonly member: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 2048;
+            readonly pattern: "^did:";
+            readonly description: "The voter's membership DID at the community. MUST be a DID the engine holds an authentication key of that the caller may act as.";
+        };
+        readonly read: {
+            readonly type: "string";
+            readonly enum: readonly ["list", "show"];
+            readonly description: "Which read to sign: vtc/elections/list/0.3 or vtc/elections/show/0.3.";
+        };
+        readonly payload: {
+            readonly type: "object";
+            readonly description: "The request payload of that task, validated against its own schema.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly ReadDocument: {
+            readonly title: "ReadDocument";
+            readonly description: "A complete, signed vtc/elections/list/0.3 or vtc/elections/show/0.3 request document, ready to send to the community unchanged.";
+            readonly type: "object";
+            readonly required: readonly ["id", "type", "issuer", "recipient", "issuedAt", "payload", "proof"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly 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}$";
+                };
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: readonly ["https://trusttasks.org/spec/vtc/elections/list/0.3", "https://trusttasks.org/spec/vtc/elections/show/0.3"];
+                };
+                readonly issuer: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 2048;
+                    readonly description: "The request's `member`.";
+                };
+                readonly recipient: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 2048;
+                    readonly description: "The request's `community`.";
+                };
+                readonly issuedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly expiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly payload: {
+                    readonly type: "object";
+                    readonly description: "The request's `payload`, exactly.";
+                };
+                readonly proof: {
+                    readonly type: "object";
+                    readonly description: "A Data Integrity proof by an `authentication` key of `issuer`.";
+                };
+            };
+        };
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTA PCS — Voter Read — response payload";
+            readonly description: "The signed read, to send to the community.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["document"];
+            readonly properties: {
+                readonly document: {
+                    readonly $ref: "#/$defs/ReadDocument";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly ReadDocument: {
+            readonly title: "ReadDocument";
+            readonly description: "A complete, signed vtc/elections/list/0.3 or vtc/elections/show/0.3 request document, ready to send to the community unchanged.";
+            readonly type: "object";
+            readonly required: readonly ["id", "type", "issuer", "recipient", "issuedAt", "payload", "proof"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly 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}$";
+                };
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: readonly ["https://trusttasks.org/spec/vtc/elections/list/0.3", "https://trusttasks.org/spec/vtc/elections/show/0.3"];
+                };
+                readonly issuer: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 2048;
+                    readonly description: "The request's `member`.";
+                };
+                readonly recipient: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 2048;
+                    readonly description: "The request's `community`.";
+                };
+                readonly issuedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly expiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly payload: {
+                    readonly type: "object";
+                    readonly description: "The request's `payload`, exactly.";
+                };
+                readonly proof: {
+                    readonly type: "object";
+                    readonly description: "A Data Integrity proof by an `authentication` key of `issuer`.";
+                };
+            };
+        };
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTA PCS — Voter Read — response payload";
+            readonly description: "The signed read, to send to the community.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["document"];
+            readonly properties: {
+                readonly document: {
+                    readonly $ref: "#/$defs/ReadDocument";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vta/pcs/voter/read/0.3";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vta/pcs/voter/read/0.3";
+        readonly title: "VTA PCS — Voter Read — payload";
+        readonly description: "A voter's client asks its VTA for a vtc/elections/list or vtc/elections/show request signed as the voter's membership DID, so the client can read the community's elections as the member without holding the member's key.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["contextId", "community", "member", "read", "payload"];
+        readonly properties: {
+            readonly contextId: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+                readonly description: "The context the voter belongs to.";
+            };
+            readonly community: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 2048;
+                readonly description: "The community's DID: the recipient of the signed request.";
+            };
+            readonly member: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 2048;
+                readonly pattern: "^did:";
+                readonly description: "The voter's membership DID at the community. MUST be a DID the engine holds an authentication key of that the caller may act as.";
+            };
+            readonly read: {
+                readonly type: "string";
+                readonly enum: readonly ["list", "show"];
+                readonly description: "Which read to sign: vtc/elections/list/0.3 or vtc/elections/show/0.3.";
+            };
+            readonly payload: {
+                readonly type: "object";
+                readonly description: "The request payload of that task, validated against its own schema.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly ReadDocument: {
+                readonly title: "ReadDocument";
+                readonly description: "A complete, signed vtc/elections/list/0.3 or vtc/elections/show/0.3 request document, ready to send to the community unchanged.";
+                readonly type: "object";
+                readonly required: readonly ["id", "type", "issuer", "recipient", "issuedAt", "payload", "proof"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly 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}$";
+                    };
+                    readonly type: {
+                        readonly type: "string";
+                        readonly enum: readonly ["https://trusttasks.org/spec/vtc/elections/list/0.3", "https://trusttasks.org/spec/vtc/elections/show/0.3"];
+                    };
+                    readonly issuer: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 2048;
+                        readonly description: "The request's `member`.";
+                    };
+                    readonly recipient: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 2048;
+                        readonly description: "The request's `community`.";
+                    };
+                    readonly issuedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly expiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly payload: {
+                        readonly type: "object";
+                        readonly description: "The request's `payload`, exactly.";
+                    };
+                    readonly proof: {
+                        readonly type: "object";
+                        readonly description: "A Data Integrity proof by an `authentication` key of `issuer`.";
+                    };
+                };
+            };
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTA PCS — Voter Read — response payload";
+                readonly description: "The signed read, to send to the community.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["document"];
+                readonly properties: {
+                    readonly document: {
+                        readonly $ref: "#/$defs/ReadDocument";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vta/pcs/voter/read/0.3#response";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly ReadDocument: {
+                readonly title: "ReadDocument";
+                readonly description: "A complete, signed vtc/elections/list/0.3 or vtc/elections/show/0.3 request document, ready to send to the community unchanged.";
+                readonly type: "object";
+                readonly required: readonly ["id", "type", "issuer", "recipient", "issuedAt", "payload", "proof"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly 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}$";
+                    };
+                    readonly type: {
+                        readonly type: "string";
+                        readonly enum: readonly ["https://trusttasks.org/spec/vtc/elections/list/0.3", "https://trusttasks.org/spec/vtc/elections/show/0.3"];
+                    };
+                    readonly issuer: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 2048;
+                        readonly description: "The request's `member`.";
+                    };
+                    readonly recipient: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 2048;
+                        readonly description: "The request's `community`.";
+                    };
+                    readonly issuedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly expiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly payload: {
+                        readonly type: "object";
+                        readonly description: "The request's `payload`, exactly.";
+                    };
+                    readonly proof: {
+                        readonly type: "object";
+                        readonly description: "A Data Integrity proof by an `authentication` key of `issuer`.";
+                    };
+                };
+            };
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTA PCS — Voter Read — response payload";
+                readonly description: "The signed read, to send to the community.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["document"];
+                readonly properties: {
+                    readonly document: {
+                        readonly $ref: "#/$defs/ReadDocument";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vta/pcs/voter/read/0.3/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vta/pcs/voter/read/0.3/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,sCAAsC,CAAC;AAGhE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,EAAE,CAAC;IACZ,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE,YAAY,CAAC;IACvB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,oDAAoD,GAAG,oDAAoD,CAAC;IAClH;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,EAAE,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,EAAE,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,CAAC;AAEpB,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,oDAA6D,CAAC;AAEtF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,IAAW,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,GAAG,IAAW,CAAC;AAE/C,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,sBAAsB,CAAC;AAE7C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,6DAAsE,CAAC;AAExG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,8BAA8B,CAAC;AAEtD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuIjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwF1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}