@openvtc/trust-tasks 0.19.3 → 0.19.5

package/src/vtc/vetting/vetters/profile/0.1/payload.ts

@@ -0,0 +1,647 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/vetting/vetters/profile/0.1/payload.schema.json
+ */
+
+import type { CalendarDate, CountryCode, Ext, LanguageTag, PlaceName, VetterAcceptsDocumentation, VetterAvailability, VetterContactHint, VetterDisplayName, VetterEvent, VetterLocation, VetterMethods, VettingDocumentation, VettingMethod } from "../../../../../_shared/components.js";
+
+
+/**
+ * A vetter publishes, replaces or unlists their vetter profile with their community: the languages, coarse location, methods, documentation and events an applicant looking for a vetter can filter on. The payload is the whole profile and replaces whatever the community held. `listed: false` keeps the profile but removes it from vtc/vetting/vetters/list.
+ */
+export interface VTCVettingVettersProfilePayload {
+  /**
+   * Whether the profile appears in vtc/vetting/vetters/list. `false` keeps it stored and hidden.
+   */
+  listed: boolean;
+  displayName?: VetterDisplayName;
+  /**
+   * BCP 47 tags of the languages the vetter can hold a session in, most preferred first. May be empty.
+   *
+   * @maxItems 16
+   */
+  languages:
+    | []
+    | [LanguageTag]
+    | [LanguageTag, LanguageTag]
+    | [LanguageTag, LanguageTag, LanguageTag]
+    | [LanguageTag, LanguageTag, LanguageTag, LanguageTag]
+    | [LanguageTag, LanguageTag, LanguageTag, LanguageTag, LanguageTag]
+    | [LanguageTag, LanguageTag, LanguageTag, LanguageTag, LanguageTag, LanguageTag]
+    | [LanguageTag, LanguageTag, LanguageTag, LanguageTag, LanguageTag, LanguageTag, LanguageTag]
+    | [LanguageTag, LanguageTag, LanguageTag, LanguageTag, LanguageTag, LanguageTag, LanguageTag, LanguageTag]
+    | [
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag
+      ]
+    | [
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag
+      ]
+    | [
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag
+      ]
+    | [
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag
+      ]
+    | [
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag
+      ]
+    | [
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag
+      ]
+    | [
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag
+      ]
+    | [
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag,
+        LanguageTag
+      ];
+  location?: VetterLocation;
+  methods: VetterMethods;
+  acceptsDocumentation: VetterAcceptsDocumentation;
+  availability?: VetterAvailability;
+  contactHint?: VetterContactHint;
+  /**
+   * Events the vetter will attend and vet at. May be empty. Events that have ended stay stored but are not listed.
+   *
+   * @maxItems 32
+   */
+  events: VetterEvent[];
+  ext?: Ext;
+}
+/**
+ * The community stored the profile.
+ */
+export interface VTCVettingVettersProfileResponsePayload {
+  /**
+   * The stored profile's `listed` value.
+   */
+  listed: boolean;
+  /**
+   * When the community stored this profile. vtc/vetting/vetters/list returns the same value.
+   */
+  updatedAt: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CalendarDate, CountryCode, Ext, LanguageTag, PlaceName, VetterAcceptsDocumentation, VetterAvailability, VetterContactHint, VetterDisplayName, VetterEvent, VetterLocation, VetterMethods, VettingDocumentation, VettingMethod };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/vetters/profile/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCVettingVettersProfilePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/vetters/profile/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCVettingVettersProfileResponsePayload;
+
+/**
+ * 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/vetting/vetters/profile/0.1",
+  "title": "VTC Vetting — Vetters Profile — payload",
+  "description": "A vetter publishes, replaces or unlists their vetter profile with their community: the languages, coarse location, methods, documentation and events an applicant looking for a vetter can filter on. The payload is the whole profile and replaces whatever the community held. `listed: false` keeps the profile but removes it from vtc/vetting/vetters/list.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "listed",
+    "languages",
+    "methods",
+    "acceptsDocumentation",
+    "events"
+  ],
+  "properties": {
+    "listed": {
+      "type": "boolean",
+      "description": "Whether the profile appears in vtc/vetting/vetters/list. `false` keeps it stored and hidden."
+    },
+    "displayName": {
+      "$ref": "#/$defs/VetterDisplayName"
+    },
+    "languages": {
+      "type": "array",
+      "maxItems": 16,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/LanguageTag"
+      },
+      "description": "BCP 47 tags of the languages the vetter can hold a session in, most preferred first. May be empty."
+    },
+    "location": {
+      "$ref": "#/$defs/VetterLocation"
+    },
+    "methods": {
+      "$ref": "#/$defs/VetterMethods"
+    },
+    "acceptsDocumentation": {
+      "$ref": "#/$defs/VetterAcceptsDocumentation"
+    },
+    "availability": {
+      "$ref": "#/$defs/VetterAvailability"
+    },
+    "contactHint": {
+      "$ref": "#/$defs/VetterContactHint"
+    },
+    "events": {
+      "type": "array",
+      "maxItems": 32,
+      "items": {
+        "$ref": "#/$defs/VetterEvent"
+      },
+      "description": "Events the vetter will attend and vet at. May be empty. Events that have ended stay stored but are not listed."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Vetting — Vetters Profile — response payload",
+      "description": "The community stored the profile.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "listed",
+        "updatedAt"
+      ],
+      "properties": {
+        "listed": {
+          "type": "boolean",
+          "description": "The stored profile's `listed` value."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community stored this profile. vtc/vetting/vetters/list returns the same value."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "VetterEvent": {
+      "title": "VetterEvent",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "startDate",
+        "endDate"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200,
+          "description": "The event's name, e.g. `Linux Plumbers Conference 2026`."
+        },
+        "startDate": {
+          "$ref": "#/$defs/CalendarDate"
+        },
+        "endDate": {
+          "$ref": "#/$defs/CalendarDate"
+        },
+        "location": {
+          "$ref": "#/$defs/VetterLocation"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "pattern": "^https://",
+          "maxLength": 2048,
+          "description": "OPTIONAL. The event's own https page."
+        }
+      },
+      "description": "An event the vetter will attend and vet at. `endDate` is on or after `startDate` and no more than 31 days after it; JSON Schema cannot compare two members, so the community checks both and refuses a violation with `malformedRequest`."
+    },
+    "VetterLocation": {
+      "title": "VetterLocation",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "country"
+      ],
+      "properties": {
+        "country": {
+          "$ref": "#/$defs/CountryCode"
+        },
+        "region": {
+          "$ref": "#/$defs/PlaceName"
+        },
+        "city": {
+          "$ref": "#/$defs/PlaceName"
+        }
+      },
+      "description": "Where a vetter can meet people, as coarse as the vetter chooses: a country, optionally a region, optionally a city. Never a street address."
+    },
+    "PlaceName": {
+      "title": "PlaceName",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "A region or city name as the vetter writes it. Compared case-insensitively and otherwise exactly."
+    },
+    "CountryCode": {
+      "title": "CountryCode",
+      "type": "string",
+      "pattern": "^[A-Z]{2}$",
+      "description": "An ISO 3166-1 alpha-2 country code, upper case, e.g. `DE`."
+    },
+    "CalendarDate": {
+      "title": "CalendarDate",
+      "type": "string",
+      "format": "date",
+      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
+      "description": "A calendar date, `YYYY-MM-DD` (RFC 3339 full-date), with no time or zone. Compared as a UTC date."
+    },
+    "VetterContactHint": {
+      "title": "VetterContactHint",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 300,
+      "description": "Vetter-authored free text on how to obtain a ticket from them, e.g. `Find me at the OpenVTC booth`. A hint, not an address a request can be sent to: vetting/request still needs a ticket or an introduction the vetter accepts."
+    },
+    "VetterAvailability": {
+      "title": "VetterAvailability",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "Vetter-authored free text on when they are available to vet. Attributed to the vetter."
+    },
+    "VetterAcceptsDocumentation": {
+      "title": "VetterAcceptsDocumentation",
+      "type": "array",
+      "maxItems": 16,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/VettingDocumentation"
+      },
+      "description": "What documentation the vetter relies on, in the same tokens as vetting/request's `acceptsDocumentation` — `passport`, `nationalId`, `driverLicence`, `none`, or another lowerCamelCase class. The vetter's own choice; empty says nothing either way."
+    },
+    "VettingDocumentation": {
+      "title": "VettingDocumentation",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^[a-z][a-zA-Z0-9]*$",
+      "description": "A class of documentation, named in lowerCamelCase. Open rather than enumerated, because what documentation a vetter accepts is each vetter's own choice. Well-known values: `passport`, `nationalId`, `driverLicence`, and `none` — the vetter will attest without a document, which is the `priorAcquaintance` case. Only the class ever travels — never a document number, an image, an issuing authority or an expiry date. `none` states a policy (what a vetter accepts); a record of what was relied on expresses 'no document' as an empty list instead."
+    },
+    "VetterMethods": {
+      "title": "VetterMethods",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 3,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/VettingMethod"
+      },
+      "description": "The methods the vetter offers, from `inPerson`, `video`, `priorAcquaintance`."
+    },
+    "VettingMethod": {
+      "title": "VettingMethod",
+      "type": "string",
+      "enum": [
+        "inPerson",
+        "video",
+        "priorAcquaintance"
+      ],
+      "description": "How the vetter established that the person they checked is the person controlling the applicant's DID. `inPerson` — both people were physically together. `video` — a live, two-way video call. `priorAcquaintance` — the vetter has known or worked with this person over a period, and attests from that knowledge rather than from a document. A method is a description of what happened, not an assurance level: which methods count, and how many of each, is community policy."
+    },
+    "LanguageTag": {
+      "title": "LanguageTag",
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 35,
+      "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{1,8})*$",
+      "description": "A BCP 47 language tag, e.g. `en`, `de-AT`. Compared case-insensitively."
+    },
+    "VetterDisplayName": {
+      "title": "VetterDisplayName",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "The name the vetter chooses to be listed under. Self-asserted and unverified: it is not the name on any document, and a client MUST attribute it to the vetter."
+    }
+  }
+} 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": "VTC Vetting — Vetters Profile — response payload",
+      "description": "The community stored the profile.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "listed",
+        "updatedAt"
+      ],
+      "properties": {
+        "listed": {
+          "type": "boolean",
+          "description": "The stored profile's `listed` value."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community stored this profile. vtc/vetting/vetters/list returns the same value."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "VetterEvent": {
+      "title": "VetterEvent",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "startDate",
+        "endDate"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200,
+          "description": "The event's name, e.g. `Linux Plumbers Conference 2026`."
+        },
+        "startDate": {
+          "$ref": "#/$defs/CalendarDate"
+        },
+        "endDate": {
+          "$ref": "#/$defs/CalendarDate"
+        },
+        "location": {
+          "$ref": "#/$defs/VetterLocation"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "pattern": "^https://",
+          "maxLength": 2048,
+          "description": "OPTIONAL. The event's own https page."
+        }
+      },
+      "description": "An event the vetter will attend and vet at. `endDate` is on or after `startDate` and no more than 31 days after it; JSON Schema cannot compare two members, so the community checks both and refuses a violation with `malformedRequest`."
+    },
+    "VetterLocation": {
+      "title": "VetterLocation",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "country"
+      ],
+      "properties": {
+        "country": {
+          "$ref": "#/$defs/CountryCode"
+        },
+        "region": {
+          "$ref": "#/$defs/PlaceName"
+        },
+        "city": {
+          "$ref": "#/$defs/PlaceName"
+        }
+      },
+      "description": "Where a vetter can meet people, as coarse as the vetter chooses: a country, optionally a region, optionally a city. Never a street address."
+    },
+    "PlaceName": {
+      "title": "PlaceName",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "A region or city name as the vetter writes it. Compared case-insensitively and otherwise exactly."
+    },
+    "CountryCode": {
+      "title": "CountryCode",
+      "type": "string",
+      "pattern": "^[A-Z]{2}$",
+      "description": "An ISO 3166-1 alpha-2 country code, upper case, e.g. `DE`."
+    },
+    "CalendarDate": {
+      "title": "CalendarDate",
+      "type": "string",
+      "format": "date",
+      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
+      "description": "A calendar date, `YYYY-MM-DD` (RFC 3339 full-date), with no time or zone. Compared as a UTC date."
+    },
+    "VetterContactHint": {
+      "title": "VetterContactHint",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 300,
+      "description": "Vetter-authored free text on how to obtain a ticket from them, e.g. `Find me at the OpenVTC booth`. A hint, not an address a request can be sent to: vetting/request still needs a ticket or an introduction the vetter accepts."
+    },
+    "VetterAvailability": {
+      "title": "VetterAvailability",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "Vetter-authored free text on when they are available to vet. Attributed to the vetter."
+    },
+    "VetterAcceptsDocumentation": {
+      "title": "VetterAcceptsDocumentation",
+      "type": "array",
+      "maxItems": 16,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/VettingDocumentation"
+      },
+      "description": "What documentation the vetter relies on, in the same tokens as vetting/request's `acceptsDocumentation` — `passport`, `nationalId`, `driverLicence`, `none`, or another lowerCamelCase class. The vetter's own choice; empty says nothing either way."
+    },
+    "VettingDocumentation": {
+      "title": "VettingDocumentation",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^[a-z][a-zA-Z0-9]*$",
+      "description": "A class of documentation, named in lowerCamelCase. Open rather than enumerated, because what documentation a vetter accepts is each vetter's own choice. Well-known values: `passport`, `nationalId`, `driverLicence`, and `none` — the vetter will attest without a document, which is the `priorAcquaintance` case. Only the class ever travels — never a document number, an image, an issuing authority or an expiry date. `none` states a policy (what a vetter accepts); a record of what was relied on expresses 'no document' as an empty list instead."
+    },
+    "VetterMethods": {
+      "title": "VetterMethods",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 3,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/VettingMethod"
+      },
+      "description": "The methods the vetter offers, from `inPerson`, `video`, `priorAcquaintance`."
+    },
+    "VettingMethod": {
+      "title": "VettingMethod",
+      "type": "string",
+      "enum": [
+        "inPerson",
+        "video",
+        "priorAcquaintance"
+      ],
+      "description": "How the vetter established that the person they checked is the person controlling the applicant's DID. `inPerson` — both people were physically together. `video` — a live, two-way video call. `priorAcquaintance` — the vetter has known or worked with this person over a period, and attests from that knowledge rather than from a document. A method is a description of what happened, not an assurance level: which methods count, and how many of each, is community policy."
+    },
+    "LanguageTag": {
+      "title": "LanguageTag",
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 35,
+      "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{1,8})*$",
+      "description": "A BCP 47 language tag, e.g. `en`, `de-AT`. Compared case-insensitively."
+    },
+    "VetterDisplayName": {
+      "title": "VetterDisplayName",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "The name the vetter chooses to be listed under. Self-asserted and unverified: it is not the name on any document, and a client MUST attribute it to the vetter."
+    }
+  }
+} 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: 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;