@openvtc/trust-tasks 0.28.9 → 0.28.11

package/src/vta/pcs/vetter/recover/0.1/payload.ts

@@ -0,0 +1,437 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/vetter/recover/0.1/payload.schema.json
+ */
+
+import type { Ext, Multibase_VtaV0_4 as Multibase, TokenDraw, VetterSummary } from "../../../../../_shared/components.js";
+
+
+/**
+ * A vetter's client asks its VTA to restore the vetter key a community has bound the member to, when the vetter engine holds a different key or none. The VTA searches the keys it can derive for the context and, if one matches, makes it the engine's key.
+ */
+export interface VTAPCSVetterRecoverPayload {
+  /**
+   * The context the engine belongs to. Only keys derived from this context's base are searched.
+   */
+  contextId: string;
+  /**
+   * The community's DID: the helper whose parameters the engine runs under.
+   */
+  community: string;
+  /**
+   * The vetter's member DID in the community.
+   */
+  memberDid: string;
+  /**
+   * The PCS identifier the community has bound to the member, as vtc/vetting/vetters/pcs-binding/show/0.1 returns it.
+   */
+  boundId: string;
+  ext?: Ext;
+}
+export interface VTAPCSVetterRecoverResponsePayload {
+  /**
+   * True when the engine's key was replaced by the bound one; false when the engine already held it.
+   */
+  recovered: boolean;
+  vetter: VetterSummary;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, Multibase, TokenDraw, VetterSummary };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/pcs/vetter/recover/0.1" as const;
+
+/**
+ * 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 const EXTENDS: string | null = 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 const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAPCSVetterRecoverPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/vetter/recover/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAPCSVetterRecoverResponsePayload;
+
+/**
+ * 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/vetter/recover/0.1",
+  "title": "VTA PCS — Vetter — Recover — payload",
+  "description": "A vetter's client asks its VTA to restore the vetter key a community has bound the member to, when the vetter engine holds a different key or none. The VTA searches the keys it can derive for the context and, if one matches, makes it the engine's key.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "community",
+    "memberDid",
+    "boundId"
+  ],
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The context the engine belongs to. Only keys derived from this context's base are searched."
+    },
+    "community": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The community's DID: the helper whose parameters the engine runs under."
+    },
+    "memberDid": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The vetter's member DID in the community."
+    },
+    "boundId": {
+      "type": "string",
+      "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+      "description": "The PCS identifier the community has bound to the member, as vtc/vetting/vetters/pcs-binding/show/0.1 returns it."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Vetter — Recover — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "recovered",
+        "vetter"
+      ],
+      "properties": {
+        "recovered": {
+          "type": "boolean",
+          "description": "True when the engine's key was replaced by the bound one; false when the engine already held it."
+        },
+        "vetter": {
+          "$ref": "#/$defs/VetterSummary"
+        },
+        "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-]+)+$"
+      }
+    },
+    "VetterSummary": {
+      "title": "VetterSummary",
+      "description": "A vetter engine as the VTA holds it, without its key, its credentials or its tokens.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contextId",
+        "community",
+        "memberDid",
+        "suite",
+        "id",
+        "enrolledLabels",
+        "pendingLabels",
+        "tokensFree",
+        "tokensHeld",
+        "drawsInFlight",
+        "attested"
+      ],
+      "properties": {
+        "contextId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "community": {
+          "type": "string",
+          "minLength": 1
+        },
+        "memberDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The member DID the engine draws tokens as. Bound into every token request."
+        },
+        "suite": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64
+        },
+        "id": {
+          "$ref": "#/$defs/Multibase",
+          "description": "The vetter's PCS identifier for this community."
+        },
+        "enrolledLabels": {
+          "type": "array",
+          "description": "Class labels this vetter holds a credential under, newest first.",
+          "items": {
+            "type": "string",
+            "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+          }
+        },
+        "pendingLabels": {
+          "type": "array",
+          "description": "Class labels requested and not yet accepted.",
+          "items": {
+            "type": "string",
+            "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+          }
+        },
+        "tokensFree": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Tokens held and not reserved."
+        },
+        "tokensHeld": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Tokens held in all."
+        },
+        "drawsInFlight": {
+          "type": "array",
+          "description": "Draws requested and not yet accepted or abandoned.",
+          "items": {
+            "$ref": "#/$defs/TokenDraw"
+          }
+        },
+        "attested": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Attestations made through this engine."
+        }
+      }
+    },
+    "TokenDraw": {
+      "title": "TokenDraw",
+      "description": "One draw of the token drip: a label and a tick.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "label",
+        "tick"
+      ],
+      "properties": {
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "tick": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "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]+$"
+    }
+  }
+} 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 — Vetter — Recover — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "recovered",
+        "vetter"
+      ],
+      "properties": {
+        "recovered": {
+          "type": "boolean",
+          "description": "True when the engine's key was replaced by the bound one; false when the engine already held it."
+        },
+        "vetter": {
+          "$ref": "#/$defs/VetterSummary"
+        },
+        "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-]+)+$"
+      }
+    },
+    "VetterSummary": {
+      "title": "VetterSummary",
+      "description": "A vetter engine as the VTA holds it, without its key, its credentials or its tokens.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contextId",
+        "community",
+        "memberDid",
+        "suite",
+        "id",
+        "enrolledLabels",
+        "pendingLabels",
+        "tokensFree",
+        "tokensHeld",
+        "drawsInFlight",
+        "attested"
+      ],
+      "properties": {
+        "contextId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "community": {
+          "type": "string",
+          "minLength": 1
+        },
+        "memberDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The member DID the engine draws tokens as. Bound into every token request."
+        },
+        "suite": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64
+        },
+        "id": {
+          "$ref": "#/$defs/Multibase",
+          "description": "The vetter's PCS identifier for this community."
+        },
+        "enrolledLabels": {
+          "type": "array",
+          "description": "Class labels this vetter holds a credential under, newest first.",
+          "items": {
+            "type": "string",
+            "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+          }
+        },
+        "pendingLabels": {
+          "type": "array",
+          "description": "Class labels requested and not yet accepted.",
+          "items": {
+            "type": "string",
+            "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+          }
+        },
+        "tokensFree": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Tokens held and not reserved."
+        },
+        "tokensHeld": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Tokens held in all."
+        },
+        "drawsInFlight": {
+          "type": "array",
+          "description": "Draws requested and not yet accepted or abandoned.",
+          "items": {
+            "$ref": "#/$defs/TokenDraw"
+          }
+        },
+        "attested": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Attestations made through this engine."
+        }
+      }
+    },
+    "TokenDraw": {
+      "title": "TokenDraw",
+      "description": "One draw of the token drip: a label and a tick.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "label",
+        "tick"
+      ],
+      "properties": {
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "tick": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "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]+$"
+    }
+  }
+} 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;

package/src/vtc/notifications/_shared/0.1/received-notification.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/notifications/_shared/0.1/received-notification.schema.json
+ */
+
+/**
+ * Shared shapes for the notifications a Verifiable Trust Community holds as their addressee: each a notifications/notify notification the community accepted, directly or by notifications/relay, under its stated acceptance policy (VTI-NTF-034). A community holds at most one record per originator and notificationId, replaced by a higher revision (VTI-NTF-022). Its administrators list them with vtc/notifications/list, read one whole with vtc/notifications/show, and decide a relay of one to members with vtc/notifications/relay (VTI-NTF-070 – VTI-NTF-074). Holding a notification tells nobody anything: the community sends nothing to the originator, a relayer or the thing's holder because of it, and relays it only on an administrator's decision. Not itself a Trust Task specification (the `_shared` folder is skipped by the registry build and the codegen).
+ */
+export interface VTCNotificationsSharedDefinitions {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../../_shared/components.js".
+ */
+export type { ReceivedNotification, Recipients, RecipientScope, RecordId_VtcNotificationsV0_1 as RecordId, RelayDecision } from "../../../../_shared/components.js";