@openvtc/trust-tasks 0.25.0 → 0.25.2

package/dist/vta/pcs/applications/create/0.1/payload.js

@@ -0,0 +1,724 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/applications/create/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/pcs/applications/create/0.1";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/applications/create/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/applications/create/0.1",
+    "title": "VTA PCS — Applications — Create — payload",
+    "description": "An applicant's client asks its VTA to start a hidden-vetting application: the VTA derives a fresh PCS key for it, keeps the key, and returns the PCS identifier vetters attest to.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "contextId",
+        "community",
+        "joinDid",
+        "parameters"
+    ],
+    "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."
+        },
+        "joinDid": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The DID the applicant joins the community as. Bound into the proof, so the proof cannot be carried to another join."
+        },
+        "parameters": {
+            "$ref": "#/$defs/CommunityParameters",
+            "description": "The community's published hidden-vetting parameters, copied verbatim from its join manifest."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA PCS — Applications — Create — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "application"
+            ],
+            "properties": {
+                "application": {
+                    "$ref": "#/$defs/ApplicationSummary"
+                },
+                "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-]+)+$"
+            }
+        },
+        "ApplicationSummary": {
+            "title": "ApplicationSummary",
+            "description": "An applicant engine as the VTA holds it, without its key.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "applicationId",
+                "contextId",
+                "community",
+                "joinDid",
+                "suite",
+                "id",
+                "attestations",
+                "createdAt"
+            ],
+            "properties": {
+                "applicationId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128,
+                    "description": "The VTA's handle for this application. Opaque; never sent to the community."
+                },
+                "contextId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The context the application's key is derived in."
+                },
+                "community": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The community's DID."
+                },
+                "joinDid": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The DID the application joins as."
+                },
+                "suite": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 64
+                },
+                "id": {
+                    "$ref": "#/$defs/Multibase",
+                    "description": "The applicant's PCS identifier: what a vetter attests to, carried in a vetting/request's `ext`."
+                },
+                "attestations": {
+                    "type": "array",
+                    "description": "The metadata of each attestation held, in the order received. Metadata names no vetter.",
+                    "items": {
+                        "$ref": "#/$defs/StatementMeta"
+                    }
+                },
+                "createdAt": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        },
+        "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]+$"
+        },
+        "StatementMeta": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "community",
+                "requirementsDigest",
+                "method",
+                "claimsVerified",
+                "livenessConfirmed",
+                "declaredRelationship",
+                "identityCommitment",
+                "cardDigestMultibase",
+                "validFrom",
+                "validUntil",
+                "tokenLabel",
+                "tokenSerial"
+            ],
+            "description": "What a Vetting Statement would have said, minus its issuer.",
+            "properties": {
+                "community": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The community this attestation is for. An attestation is not portable between communities."
+                },
+                "requirementsDigest": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The digest of the criterion's requirements as the vetter read them."
+                },
+                "method": {
+                    "type": "string",
+                    "enum": [
+                        "inPerson",
+                        "video",
+                        "priorAcquaintance"
+                    ],
+                    "description": "How the vetter met the applicant."
+                },
+                "claimsVerified": {
+                    "type": "array",
+                    "minItems": 1,
+                    "items": {
+                        "type": "string",
+                        "minLength": 1
+                    },
+                    "description": "The claim types the vetter checked."
+                },
+                "livenessConfirmed": {
+                    "type": "boolean",
+                    "description": "Whether the vetter confirmed a live person."
+                },
+                "declaredRelationship": {
+                    "type": "string",
+                    "enum": [
+                        "none",
+                        "family",
+                        "sameEmployer",
+                        "closeFriend",
+                        "other"
+                    ],
+                    "description": "The relationship the vetter declared, which the community's independence rules count."
+                },
+                "identityCommitment": {
+                    "type": "string",
+                    "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+                    "description": "The commitment on the Vetting Card the applicant showed. Consistency across attestations is what stops two applicants pooling them."
+                },
+                "cardDigestMultibase": {
+                    "type": "string",
+                    "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+                    "description": "Digest of that card, as the vetter verified it."
+                },
+                "validFrom": {
+                    "type": "string",
+                    "format": "date",
+                    "description": "A DATE, never a timestamp: an exact time would let a community line an attestation up with a vetter's activity, which undoes the proof without touching it."
+                },
+                "validUntil": {
+                    "type": "string",
+                    "format": "date",
+                    "description": "A date, for the same reason."
+                },
+                "tokenLabel": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128,
+                    "description": "The token label spent, repeated inside the bound facts so it cannot be swapped in transit."
+                },
+                "tokenSerial": {
+                    "type": "string",
+                    "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+                    "description": "The token serial spent, likewise bound."
+                }
+            }
+        },
+        "CommunityParameters": {
+            "title": "CommunityParameters",
+            "description": "The community's hidden-vetting parameters exactly as its join manifest publishes them, under the criterion's `vetting.ext`. The caller copies them in verbatim on every call that needs them, because the community rotates labels and the engine keeps no copy of its own: a stale copy costs the caller a refused proof, never a mistaken one.",
+            "$ref": "#/$defs/PublishedConfig"
+        },
+        "PublishedConfig": {
+            "title": "PublishedConfig",
+            "description": "The parameters exactly as they now appear in this community's join manifest, under vetting.ext. What an applicant and a vetter read.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "suite",
+                "helperKey",
+                "tokenKey",
+                "vetterLabels",
+                "tokenLabels",
+                "dripPerTick",
+                "tickLength",
+                "events"
+            ],
+            "properties": {
+                "suite": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "helperKey": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The helper verification key, multibase — named for its role on the wire rather than for hvk."
+                },
+                "tokenKey": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The token verification key, multibase — named for its role on the wire rather than for tvk."
+                },
+                "vetterLabels": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "minLength": 1
+                    },
+                    "description": "Class labels published whole, e.g. vetter/2026-09 — a request names one of these, not the bare period."
+                },
+                "tokenLabels": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "minLength": 1
+                    }
+                },
+                "dripPerTick": {
+                    "type": "integer",
+                    "minimum": 1
+                },
+                "tickLength": {
+                    "$ref": "#/$defs/TickLength"
+                },
+                "events": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PublishedEvent"
+                    }
+                }
+            }
+        },
+        "PublishedEvent": {
+            "title": "PublishedEvent",
+            "description": "The published shape drops approvedBy and graceDays: who approved is the community's own record, and a vetter is told closesAfter when its request is approved rather than being handed the raw grace period here.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "eventId",
+                "startDate",
+                "endDate",
+                "groupFloor",
+                "tiers"
+            ],
+            "properties": {
+                "eventId": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "startDate": {
+                    "type": "string",
+                    "format": "date"
+                },
+                "endDate": {
+                    "type": "string",
+                    "format": "date"
+                },
+                "groupFloor": {
+                    "type": "integer",
+                    "minimum": 1
+                },
+                "tiers": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/Tier"
+                    }
+                }
+            }
+        },
+        "Tier": {
+            "title": "Tier",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "name",
+                "dripPerTick"
+            ],
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "How the menu names it: desk, busy-desk."
+                },
+                "dripPerTick": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "description": "How many tokens a tick under this tier yields."
+                }
+            }
+        },
+        "TickLength": {
+            "title": "TickLength",
+            "type": "string",
+            "pattern": "^P(?:\\d+D(?:T\\d+H)?|T\\d+H)$",
+            "description": "The length of one tick of the drip, as an ISO 8601 duration in days and/or hours — at least `PT1H`. A label's tick `t` is the window starting `t` tick lengths after the label's start (`vtc/vetting/vetters/pcs-tokens`)."
+        }
+    }
+};
+/** 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 — Applications — Create — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "application"
+            ],
+            "properties": {
+                "application": {
+                    "$ref": "#/$defs/ApplicationSummary"
+                },
+                "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-]+)+$"
+            }
+        },
+        "ApplicationSummary": {
+            "title": "ApplicationSummary",
+            "description": "An applicant engine as the VTA holds it, without its key.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "applicationId",
+                "contextId",
+                "community",
+                "joinDid",
+                "suite",
+                "id",
+                "attestations",
+                "createdAt"
+            ],
+            "properties": {
+                "applicationId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128,
+                    "description": "The VTA's handle for this application. Opaque; never sent to the community."
+                },
+                "contextId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The context the application's key is derived in."
+                },
+                "community": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The community's DID."
+                },
+                "joinDid": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The DID the application joins as."
+                },
+                "suite": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 64
+                },
+                "id": {
+                    "$ref": "#/$defs/Multibase",
+                    "description": "The applicant's PCS identifier: what a vetter attests to, carried in a vetting/request's `ext`."
+                },
+                "attestations": {
+                    "type": "array",
+                    "description": "The metadata of each attestation held, in the order received. Metadata names no vetter.",
+                    "items": {
+                        "$ref": "#/$defs/StatementMeta"
+                    }
+                },
+                "createdAt": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        },
+        "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]+$"
+        },
+        "StatementMeta": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "community",
+                "requirementsDigest",
+                "method",
+                "claimsVerified",
+                "livenessConfirmed",
+                "declaredRelationship",
+                "identityCommitment",
+                "cardDigestMultibase",
+                "validFrom",
+                "validUntil",
+                "tokenLabel",
+                "tokenSerial"
+            ],
+            "description": "What a Vetting Statement would have said, minus its issuer.",
+            "properties": {
+                "community": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The community this attestation is for. An attestation is not portable between communities."
+                },
+                "requirementsDigest": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The digest of the criterion's requirements as the vetter read them."
+                },
+                "method": {
+                    "type": "string",
+                    "enum": [
+                        "inPerson",
+                        "video",
+                        "priorAcquaintance"
+                    ],
+                    "description": "How the vetter met the applicant."
+                },
+                "claimsVerified": {
+                    "type": "array",
+                    "minItems": 1,
+                    "items": {
+                        "type": "string",
+                        "minLength": 1
+                    },
+                    "description": "The claim types the vetter checked."
+                },
+                "livenessConfirmed": {
+                    "type": "boolean",
+                    "description": "Whether the vetter confirmed a live person."
+                },
+                "declaredRelationship": {
+                    "type": "string",
+                    "enum": [
+                        "none",
+                        "family",
+                        "sameEmployer",
+                        "closeFriend",
+                        "other"
+                    ],
+                    "description": "The relationship the vetter declared, which the community's independence rules count."
+                },
+                "identityCommitment": {
+                    "type": "string",
+                    "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+                    "description": "The commitment on the Vetting Card the applicant showed. Consistency across attestations is what stops two applicants pooling them."
+                },
+                "cardDigestMultibase": {
+                    "type": "string",
+                    "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+                    "description": "Digest of that card, as the vetter verified it."
+                },
+                "validFrom": {
+                    "type": "string",
+                    "format": "date",
+                    "description": "A DATE, never a timestamp: an exact time would let a community line an attestation up with a vetter's activity, which undoes the proof without touching it."
+                },
+                "validUntil": {
+                    "type": "string",
+                    "format": "date",
+                    "description": "A date, for the same reason."
+                },
+                "tokenLabel": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128,
+                    "description": "The token label spent, repeated inside the bound facts so it cannot be swapped in transit."
+                },
+                "tokenSerial": {
+                    "type": "string",
+                    "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+                    "description": "The token serial spent, likewise bound."
+                }
+            }
+        },
+        "CommunityParameters": {
+            "title": "CommunityParameters",
+            "description": "The community's hidden-vetting parameters exactly as its join manifest publishes them, under the criterion's `vetting.ext`. The caller copies them in verbatim on every call that needs them, because the community rotates labels and the engine keeps no copy of its own: a stale copy costs the caller a refused proof, never a mistaken one.",
+            "$ref": "#/$defs/PublishedConfig"
+        },
+        "PublishedConfig": {
+            "title": "PublishedConfig",
+            "description": "The parameters exactly as they now appear in this community's join manifest, under vetting.ext. What an applicant and a vetter read.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "suite",
+                "helperKey",
+                "tokenKey",
+                "vetterLabels",
+                "tokenLabels",
+                "dripPerTick",
+                "tickLength",
+                "events"
+            ],
+            "properties": {
+                "suite": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "helperKey": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The helper verification key, multibase — named for its role on the wire rather than for hvk."
+                },
+                "tokenKey": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The token verification key, multibase — named for its role on the wire rather than for tvk."
+                },
+                "vetterLabels": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "minLength": 1
+                    },
+                    "description": "Class labels published whole, e.g. vetter/2026-09 — a request names one of these, not the bare period."
+                },
+                "tokenLabels": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "minLength": 1
+                    }
+                },
+                "dripPerTick": {
+                    "type": "integer",
+                    "minimum": 1
+                },
+                "tickLength": {
+                    "$ref": "#/$defs/TickLength"
+                },
+                "events": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PublishedEvent"
+                    }
+                }
+            }
+        },
+        "PublishedEvent": {
+            "title": "PublishedEvent",
+            "description": "The published shape drops approvedBy and graceDays: who approved is the community's own record, and a vetter is told closesAfter when its request is approved rather than being handed the raw grace period here.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "eventId",
+                "startDate",
+                "endDate",
+                "groupFloor",
+                "tiers"
+            ],
+            "properties": {
+                "eventId": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "startDate": {
+                    "type": "string",
+                    "format": "date"
+                },
+                "endDate": {
+                    "type": "string",
+                    "format": "date"
+                },
+                "groupFloor": {
+                    "type": "integer",
+                    "minimum": 1
+                },
+                "tiers": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/Tier"
+                    }
+                }
+            }
+        },
+        "Tier": {
+            "title": "Tier",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "name",
+                "dripPerTick"
+            ],
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "How the menu names it: desk, busy-desk."
+                },
+                "dripPerTick": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "description": "How many tokens a tick under this tier yields."
+                }
+            }
+        },
+        "TickLength": {
+            "title": "TickLength",
+            "type": "string",
+            "pattern": "^P(?:\\d+D(?:T\\d+H)?|T\\d+H)$",
+            "description": "The length of one tick of the drip, as an ISO 8601 duration in days and/or hours — at least `PT1H`. A label's tick `t` is the window starting `t` tick lengths after the label's start (`vtc/vetting/vetters/pcs-tokens`)."
+        }
+    }
+};
+/**
+ * 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