@openvtc/trust-tasks 0.25.1 → 0.25.2

package/src/vta/pcs/applications/delete/0.1/payload.ts

@@ -0,0 +1,182 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/applications/delete/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * A client tells its VTA to forget a hidden-vetting application: its PCS key and every attestation it holds are destroyed.
+ */
+export interface VTAPCSApplicationsDeletePayload {
+  /**
+   * The handle vta/pcs/applications/create returned.
+   */
+  applicationId: string;
+  ext?: Ext;
+}
+export interface VTAPCSApplicationsDeleteResponsePayload {
+  applicationId: string;
+  /**
+   * Always true: a refusal is a trust-task-error, not a false here.
+   */
+  deleted: true;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/pcs/applications/delete/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAPCSApplicationsDeletePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/applications/delete/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAPCSApplicationsDeleteResponsePayload;
+
+/**
+ * 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/delete/0.1",
+  "title": "VTA PCS — Applications — Delete — payload",
+  "description": "A client tells its VTA to forget a hidden-vetting application: its PCS key and every attestation it holds are destroyed.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "applicationId"
+  ],
+  "properties": {
+    "applicationId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "The handle vta/pcs/applications/create returned."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Applications — Delete — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "applicationId",
+        "deleted"
+      ],
+      "properties": {
+        "applicationId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "deleted": {
+          "type": "boolean",
+          "const": true,
+          "description": "Always true: a refusal is a trust-task-error, not a false here."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/** 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 — Delete — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "applicationId",
+        "deleted"
+      ],
+      "properties": {
+        "applicationId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "deleted": {
+          "type": "boolean",
+          "const": true,
+          "description": "Always true: a refusal is a trust-task-error, not a false here."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/**
+ * 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,
+} as const;
+
+/**
+ * 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,
+} as const;

package/src/vta/pcs/applications/show/0.1/payload.ts

@@ -0,0 +1,482 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/applications/show/0.1/payload.schema.json
+ */
+
+import type { ApplicationSummary, Ext, Multibase, StatementMeta } from "../../../../../_shared/components.js";
+
+
+/**
+ * A client reads one of its hidden-vetting applications back from its VTA: its PCS identifier and the metadata of the attestations it holds, never its key.
+ */
+export interface VTAPCSApplicationsShowPayload {
+  /**
+   * The handle vta/pcs/applications/create returned.
+   */
+  applicationId: string;
+  ext?: Ext;
+}
+export interface VTAPCSApplicationsShowResponsePayload {
+  application: ApplicationSummary;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ApplicationSummary, Ext, Multibase, StatementMeta };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/pcs/applications/show/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAPCSApplicationsShowPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/applications/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAPCSApplicationsShowResponsePayload;
+
+/**
+ * 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/show/0.1",
+  "title": "VTA PCS — Applications — Show — payload",
+  "description": "A client reads one of its hidden-vetting applications back from its VTA: its PCS identifier and the metadata of the attestations it holds, never its key.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "applicationId"
+  ],
+  "properties": {
+    "applicationId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "The handle vta/pcs/applications/create returned."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Applications — Show — 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."
+        }
+      }
+    }
+  }
+} as const;
+
+/** 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 — Show — 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."
+        }
+      }
+    }
+  }
+} as const;
+
+/**
+ * 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,
+} as const;
+
+/**
+ * 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,
+} as const;