@openvtc/trust-tasks 0.2.48 → 0.2.50

package/src/vta/did-templates/delete/2.0/payload.ts

@@ -0,0 +1,31 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/did-templates/delete/2.0/payload.schema.json
+ */
+
+/**
+ * Remove a DID template from a VTA by name. Omit `contextId` to remove from the global scope (super-admin gated); set it to remove a template scoped to that context (gated on the context's admin, or a super-admin). The success response echoes the deleted name for audit pipelines.
+ */
+export interface VTADIDTemplateDeletePayload {
+  /**
+   * Scope selector. Absent: the global scope, gated on a super-administrator. Present: the context the template is scoped to, gated on that context's administrator (or a super-administrator).
+   */
+  contextId?: string;
+  /**
+   * Resource id — the name of the template to remove within the selected scope.
+   */
+  name: string;
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/delete/2.0" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/delete/2.0#response" as const;

package/src/vta/did-templates/get/2.0/payload.ts

@@ -0,0 +1,31 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/did-templates/get/2.0/payload.schema.json
+ */
+
+/**
+ * Fetch one DID template on a VTA by name. Omit `contextId` to read from the global scope (any authenticated caller); set it to read a template scoped to that context (requires access to the context). The success response is the persisted DidTemplateRecord.
+ */
+export interface VTADIDTemplateGetPayload {
+  /**
+   * Scope selector. Absent: the global scope. Present: the context the template is scoped to; the caller MUST have access to that context.
+   */
+  contextId?: string;
+  /**
+   * Template name to fetch within the selected scope.
+   */
+  name: string;
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/get/2.0" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/get/2.0#response" as const;

package/src/vta/did-templates/list/2.0/payload.ts

@@ -0,0 +1,27 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/did-templates/list/2.0/payload.schema.json
+ */
+
+/**
+ * List the DID templates in one scope on a VTA. Omit `contextId` to list the global templates (any authenticated caller); set it to list the templates scoped to that context (requires access to the context). The success response is the array of persisted DidTemplateRecords for the selected scope.
+ */
+export interface VTADIDTemplateListPayload {
+  /**
+   * Scope selector. Absent: the global scope. Present: the context whose templates are listed; the caller MUST have access to that context.
+   */
+  contextId?: string;
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/list/2.0" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/list/2.0#response" as const;

package/src/vta/did-templates/render/2.0/payload.ts

@@ -0,0 +1,37 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/did-templates/render/2.0/payload.schema.json
+ */
+
+/**
+ * Render a DID template to a DID document. Omit `contextId` to render a global template; set it to render a template scoped to that context (requires access to the context; the VTA MAY fall back to a global template of the same name). Callers supply variables; the VTA injects ambient variables (VTA_DID, VTA_URL, NOW — plus CONTEXT_ID and, if set on the context, CONTEXT_DID when contextId is present) server-side, merges the caller's on top, substitutes every placeholder, and returns the rendered document.
+ */
+export interface VTADIDTemplateRenderPayload {
+  /**
+   * Scope selector. Absent: the global scope. Present: the context whose template is rendered; the caller MUST have access to that context. When present the VTA additionally injects the ambient variables CONTEXT_ID and (if set on the context) CONTEXT_DID.
+   */
+  contextId?: string;
+  /**
+   * Resource id — the name of the template to render within the selected scope.
+   */
+  name: string;
+  /**
+   * Caller-supplied template variables, keyed by name. The VTA injects ambient variables (VTA_DID, VTA_URL, NOW; plus CONTEXT_ID / CONTEXT_DID when contextId is present) server-side and merges these on top.
+   */
+  vars?: {
+    [k: string]: unknown | undefined;
+  };
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/render/2.0" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/render/2.0#response" as const;

package/src/vta/did-templates/update/2.0/payload.ts

@@ -0,0 +1,77 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/did-templates/update/2.0/payload.schema.json
+ */
+
+/**
+ * Replace an existing DID template on a VTA. Omit `contextId` to replace in the global scope (super-admin gated); set it to replace a template scoped to that context (gated on the context's admin, or a super-admin). The `name` is the resource id within the selected scope and MUST equal `template.name`; the VTA replaces the stored body, preserving createdAt/createdBy and advancing updatedAt. The success response is the persisted DidTemplateRecord.
+ */
+export interface VTADIDTemplateUpdatePayload {
+  /**
+   * Scope selector. Absent: the global scope, gated on a super-administrator. Present: the context the template is scoped to, gated on that context's administrator (or a super-administrator).
+   */
+  contextId?: string;
+  /**
+   * Resource id — the template's name within the selected scope. MUST equal `template.name` or the VTA rejects with the framework's `malformedRequest`.
+   */
+  name: string;
+  template: DidTemplate;
+  ext?: Ext;
+}
+/**
+ * Full replacement template document. Validated against the v1 template schema before persistence; an invalid shape is rejected with the framework's `malformedRequest`.
+ */
+export interface DidTemplate {
+  /**
+   * Template schema version. Currently always 1.
+   */
+  schemaVersion: 1;
+  /**
+   * Template id within its scope. Lowercase alphanumeric and hyphen only.
+   */
+  name: string;
+  /**
+   * Classification hint, e.g. `mediator`, `did-host-http`, `app`. Drives downstream provisioning behaviour.
+   */
+  kind: string;
+  /**
+   * Human-readable description of what the template provisions.
+   */
+  description?: string | null;
+  /**
+   * DID methods this template targets, e.g. ["webvh", "web"] for a hosted DID or ["key"] for a did:key.
+   */
+  methods?: string[];
+  /**
+   * Variables the caller MUST supply at render time. MUST NOT include reserved ambient names (DID, SIGNING_KEY_MB, KA_KEY_MB, VTA_DID, VTA_URL, CONTEXT_ID, CONTEXT_DID, NOW).
+   */
+  requiredVars?: string[];
+  /**
+   * Variables with default values, keyed by variable name.
+   */
+  optionalVars?: {
+    [k: string]: unknown | undefined;
+  };
+  /**
+   * Hints for CLI / setup wizards (e.g. preRotationCount, portable, addMediatorService).
+   */
+  defaults?: {
+    [k: string]: unknown | undefined;
+  };
+  /**
+   * The DID document body with `{TOKEN}` placeholders. `document.id` MUST contain the `{DID}` placeholder. Every `{TOKEN}` MUST be declared in requiredVars/optionalVars or be a reserved ambient name.
+   */
+  document: {};
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/update/2.0" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/update/2.0#response" as const;