@openvtc/trust-tasks 0.19.3 → 0.19.5

package/src/vta/webvh/dids/realign-keys/1.0/payload.ts

@@ -0,0 +1,332 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/dids/realign-keys/1.0/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * Rename a did:webvh's key records so each is addressed by the verification-method identifier its published document declares. The payload names no identifier but the DID: every target is derived by the recipient from that DID's own document.
+ */
+export interface VTAWebVHDIDsRealignKeysPayload {
+  /**
+   * The DID whose key records are to be realigned. The only identifier the producer chooses.
+   */
+  did: string;
+  /**
+   * Compute and report the realignment without performing it. Absent reads as false.
+   */
+  dryRun?: boolean;
+  ext?: Ext;
+}
+/**
+ * Success response to vta/webvh/dids/realign-keys. Type https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response.
+ */
+export interface VTAWebVHDIDsRealignKeysResponsePayload {
+  did: string;
+  /**
+   * The renames performed, or in a dry run the ones that would be.
+   */
+  moved: ARecordRenamedOntoTheIdentifierItsKeyIsPublishedUnder[];
+  /**
+   * Verification-method identifiers whose record was already correct.
+   */
+  alreadyAligned: string[];
+  /**
+   * Verification-method identifiers the recipient holds no key for. Not a failure — a DID may publish a method whose private half lives elsewhere — but the difference between this being empty and not is the difference between the DID being consistent and merely unchanged.
+   */
+  unmatched: string[];
+  /**
+   * Where the recipient will allocate the next identifier it mints for this DID. Past everything the document already publishes, so a later rotation cannot reissue a published identifier under new key material.
+   */
+  nextFragmentId: number;
+  /**
+   * True when nothing was written. Echoed so a report is self-describing: a plan and a receipt are otherwise the same shape.
+   */
+  dryRun: boolean;
+  ext?: Ext;
+}
+export interface ARecordRenamedOntoTheIdentifierItsKeyIsPublishedUnder {
+  /**
+   * The identifier the record had.
+   */
+  from: string;
+  /**
+   * The verification-method identifier it takes.
+   */
+  to: string;
+  /**
+   * Multibase public half of the key, which is what identified the record. Reported so the producer can check the rename against the published document rather than trusting this report.
+   */
+  publicKey: string;
+}
+
+/** 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/webvh/dids/realign-keys/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWebVHDIDsRealignKeysPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAWebVHDIDsRealignKeysResponsePayload;
+
+/**
+ * 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/webvh/dids/realign-keys/1.0",
+  "title": "VTA WebVH DIDs Realign-Keys — payload",
+  "description": "Rename a did:webvh's key records so each is addressed by the verification-method identifier its published document declares. The payload names no identifier but the DID: every target is derived by the recipient from that DID's own document.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "did"
+  ],
+  "properties": {
+    "did": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The DID whose key records are to be realigned. The only identifier the producer chooses."
+    },
+    "dryRun": {
+      "type": "boolean",
+      "description": "Compute and report the realignment without performing it. Absent reads as false."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA WebVH DIDs Realign-Keys — response payload",
+      "description": "Success response to vta/webvh/dids/realign-keys. Type https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "moved",
+        "alreadyAligned",
+        "unmatched",
+        "nextFragmentId",
+        "dryRun"
+      ],
+      "properties": {
+        "did": {
+          "type": "string"
+        },
+        "moved": {
+          "type": "array",
+          "description": "The renames performed, or in a dry run the ones that would be.",
+          "items": {
+            "$ref": "#/$defs/RealignedKey"
+          }
+        },
+        "alreadyAligned": {
+          "type": "array",
+          "description": "Verification-method identifiers whose record was already correct.",
+          "items": {
+            "type": "string"
+          }
+        },
+        "unmatched": {
+          "type": "array",
+          "description": "Verification-method identifiers the recipient holds no key for. Not a failure — a DID may publish a method whose private half lives elsewhere — but the difference between this being empty and not is the difference between the DID being consistent and merely unchanged.",
+          "items": {
+            "type": "string"
+          }
+        },
+        "nextFragmentId": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Where the recipient will allocate the next identifier it mints for this DID. Past everything the document already publishes, so a later rotation cannot reissue a published identifier under new key material."
+        },
+        "dryRun": {
+          "type": "boolean",
+          "description": "True when nothing was written. Echoed so a report is self-describing: a plan and a receipt are otherwise the same shape."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "RealignedKey": {
+      "title": "A record renamed onto the identifier its key is published under",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "from",
+        "to",
+        "publicKey"
+      ],
+      "properties": {
+        "from": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The identifier the record had."
+        },
+        "to": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The verification-method identifier it takes."
+        },
+        "publicKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Multibase public half of the key, which is what identified the record. Reported so the producer can check the rename against the published document rather than trusting this report."
+        }
+      }
+    },
+    "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 WebVH DIDs Realign-Keys — response payload",
+      "description": "Success response to vta/webvh/dids/realign-keys. Type https://trusttasks.org/spec/vta/webvh/dids/realign-keys/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "moved",
+        "alreadyAligned",
+        "unmatched",
+        "nextFragmentId",
+        "dryRun"
+      ],
+      "properties": {
+        "did": {
+          "type": "string"
+        },
+        "moved": {
+          "type": "array",
+          "description": "The renames performed, or in a dry run the ones that would be.",
+          "items": {
+            "$ref": "#/$defs/RealignedKey"
+          }
+        },
+        "alreadyAligned": {
+          "type": "array",
+          "description": "Verification-method identifiers whose record was already correct.",
+          "items": {
+            "type": "string"
+          }
+        },
+        "unmatched": {
+          "type": "array",
+          "description": "Verification-method identifiers the recipient holds no key for. Not a failure — a DID may publish a method whose private half lives elsewhere — but the difference between this being empty and not is the difference between the DID being consistent and merely unchanged.",
+          "items": {
+            "type": "string"
+          }
+        },
+        "nextFragmentId": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Where the recipient will allocate the next identifier it mints for this DID. Past everything the document already publishes, so a later rotation cannot reissue a published identifier under new key material."
+        },
+        "dryRun": {
+          "type": "boolean",
+          "description": "True when nothing was written. Echoed so a report is self-describing: a plan and a receipt are otherwise the same shape."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "RealignedKey": {
+      "title": "A record renamed onto the identifier its key is published under",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "from",
+        "to",
+        "publicKey"
+      ],
+      "properties": {
+        "from": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The identifier the record had."
+        },
+        "to": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The verification-method identifier it takes."
+        },
+        "publicKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Multibase public half of the key, which is what identified the record. Reported so the producer can check the rename against the published document rather than trusting this report."
+        }
+      }
+    },
+    "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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vtc/_shared/0.1/vetter-profile.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/_shared/0.1/vetter-profile.schema.json
+ */
+
+/**
+ * Shared types for the vtc/vetting/vetters/* family: the pieces of a vetter's self-published profile that vtc/vetting/vetters/profile writes and vtc/vetting/vetters/list returns. Defined once so a profile and a listing entry are compared value for value. Not itself a Trust Task specification (the `_shared` folder is skipped by the registry build and the codegen).
+ */
+export interface VTCSharedVetterProfileDefinitions {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { CalendarDate, CountryCode, LanguageTag, PlaceName, VetterAcceptsDocumentation, VetterAvailability, VetterContactHint, VetterDisplayName, VetterEvent, VetterLocation, VetterMethods } from "../../../_shared/components.js";