@openvtc/trust-tasks 0.9.0 → 0.11.0

package/src/vta/contexts/update-did/1.0/payload.ts

@@ -0,0 +1,285 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/contexts/update-did/1.0/payload.schema.json
+ */
+
+export interface VTAContextsUpdateDIDPayload {
+  /**
+   * Context whose DID is being set.
+   */
+  id: string;
+  /**
+   * The DID this context acts as from now on. Anything that authenticated or signed as the previous DID keeps referring to it; this task does not migrate those references, and a consumer MUST NOT imply that it does.
+   */
+  did: string;
+  ext?: Ext;
+}
+/**
+ * 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.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+/**
+ * A context as the VTA holds it.
+ */
+export interface ContextRecord {
+  /**
+   * Context id. For a nested context this is the full path (`parent/leaf`), not the leaf alone — an ACL scope naming this context must use this value verbatim.
+   */
+  id: string;
+  /**
+   * Human-readable name. Operator-facing only; carries no authorization meaning, and two contexts may share a name.
+   */
+  name: string;
+  /**
+   * DID this context acts as, when one has been assigned. Absent means the context has no identity of its own yet — not that it has been denied one.
+   */
+  did?: string;
+  /**
+   * Free-form description.
+   */
+  description?: string;
+  /**
+   * Id of the context this one nests under. Absent for a top-level context. Authority granted at a parent reaches its children, so this member is load-bearing for anyone reasoning about scope.
+   */
+  parent?: string;
+  /**
+   * Resolved path from the root context, as the VTA derives it from the parent chain. Consumers MUST treat this as derived state: it is recomputed by the maintainer and is not independently settable.
+   */
+  basePath: string;
+  /**
+   * RFC 3339.
+   */
+  createdAt: string;
+  /**
+   * RFC 3339.
+   */
+  updatedAt: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/contexts/update-did/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAContextsUpdateDIDPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/contexts/update-did/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = ContextRecord;
+
+/**
+ * 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/contexts/update-did/1.0",
+  "title": "VTA Contexts Update-DID — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id",
+    "did"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Context whose DID is being set."
+    },
+    "did": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The DID this context acts as from now on. Anything that authenticated or signed as the previous DID keeps referring to it; this task does not migrate those references, and a consumer MUST NOT imply that it does."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Contexts Update-DID — response payload",
+      "description": "Success response to vta/contexts/update-did: the context as it now stands. Type https://trusttasks.org/spec/vta/contexts/update-did/1.0#response.",
+      "$ref": "#/$defs/ContextRecord"
+    },
+    "ContextRecord": {
+      "title": "ContextRecord",
+      "description": "A context as the VTA holds it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "basePath",
+        "createdAt",
+        "updatedAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Context id. For a nested context this is the full path (`parent/leaf`), not the leaf alone — an ACL scope naming this context must use this value verbatim."
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Human-readable name. Operator-facing only; carries no authorization meaning, and two contexts may share a name."
+        },
+        "did": {
+          "type": "string",
+          "description": "DID this context acts as, when one has been assigned. Absent means the context has no identity of its own yet — not that it has been denied one."
+        },
+        "description": {
+          "type": "string",
+          "description": "Free-form description."
+        },
+        "parent": {
+          "type": "string",
+          "description": "Id of the context this one nests under. Absent for a top-level context. Authority granted at a parent reaches its children, so this member is load-bearing for anyone reasoning about scope."
+        },
+        "basePath": {
+          "type": "string",
+          "description": "Resolved path from the root context, as the VTA derives it from the parent chain. Consumers MUST treat this as derived state: it is recomputed by the maintainer and is not independently settable."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339."
+        },
+        "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 Contexts Update-DID — response payload",
+      "description": "Success response to vta/contexts/update-did: the context as it now stands. Type https://trusttasks.org/spec/vta/contexts/update-did/1.0#response.",
+      "$ref": "#/$defs/ContextRecord"
+    },
+    "ContextRecord": {
+      "title": "ContextRecord",
+      "description": "A context as the VTA holds it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "basePath",
+        "createdAt",
+        "updatedAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Context id. For a nested context this is the full path (`parent/leaf`), not the leaf alone — an ACL scope naming this context must use this value verbatim."
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Human-readable name. Operator-facing only; carries no authorization meaning, and two contexts may share a name."
+        },
+        "did": {
+          "type": "string",
+          "description": "DID this context acts as, when one has been assigned. Absent means the context has no identity of its own yet — not that it has been denied one."
+        },
+        "description": {
+          "type": "string",
+          "description": "Free-form description."
+        },
+        "parent": {
+          "type": "string",
+          "description": "Id of the context this one nests under. Absent for a top-level context. Authority granted at a parent reaches its children, so this member is load-bearing for anyone reasoning about scope."
+        },
+        "basePath": {
+          "type": "string",
+          "description": "Resolved path from the root context, as the VTA derives it from the parent chain. Consumers MUST treat this as derived state: it is recomputed by the maintainer and is not independently settable."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339."
+        },
+        "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,
+  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,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vta/services/disable/1.0/payload.ts

@@ -0,0 +1,302 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/services/disable/1.0/payload.schema.json
+ */
+
+/**
+ * Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.
+ */
+export type ServiceKind = "didcomm" | "rest" | "tsp" | "webauthn";
+
+/**
+ * Request payload for vta/services/disable. Stops advertising a transport and republishes the log. For `didcomm` this schedules a drain rather than cutting delivery immediately — see `drainUntil` in the result.
+ */
+export interface VTAServicesDisablePayload {
+  service: ServiceKind;
+  ext?: Ext;
+}
+/**
+ * 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.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Success response to vta/services/disable. Type https://trusttasks.org/spec/vta/services/disable/1.0#response.
+ */
+export interface VTAServicesDisableResponsePayload {
+  result: ServiceMutationResult;
+  ext?: Ext;
+}
+/**
+ * The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.
+ */
+export interface ServiceMutationResult {
+  /**
+   * Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history.
+   */
+  logEntryVersionId: string;
+  /**
+   * RFC 3339 instant the change took effect — the same instant stamped on the new log entry.
+   */
+  effectiveAt: string;
+  /**
+   * Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong.
+   */
+  drainUntil?: string;
+  /**
+   * The mediator being drained, when `drainUntil` is present.
+   */
+  drainingMediator?: string;
+  /**
+   * The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip.
+   */
+  vtaDid?: string;
+  /**
+   * True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.
+   */
+  serverless?: boolean;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/services/disable/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAServicesDisablePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/services/disable/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAServicesDisableResponsePayload;
+
+/**
+ * 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/services/disable/1.0",
+  "title": "VTA Services — Disable — payload",
+  "description": "Request payload for vta/services/disable. Stops advertising a transport and republishes the log. For `didcomm` this schedules a drain rather than cutting delivery immediately — see `drainUntil` in the result.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "service"
+  ],
+  "properties": {
+    "service": {
+      "$ref": "#/$defs/ServiceKind"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Services — Disable — response payload",
+      "description": "Success response to vta/services/disable. Type https://trusttasks.org/spec/vta/services/disable/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "result"
+      ],
+      "properties": {
+        "result": {
+          "$ref": "#/$defs/ServiceMutationResult"
+        },
+        "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-]+)+$"
+      }
+    },
+    "ServiceMutationResult": {
+      "title": "ServiceMutationResult",
+      "description": "The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "logEntryVersionId",
+        "effectiveAt"
+      ],
+      "properties": {
+        "logEntryVersionId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history."
+        },
+        "effectiveAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339 instant the change took effect — the same instant stamped on the new log entry."
+        },
+        "drainUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong."
+        },
+        "drainingMediator": {
+          "type": "string",
+          "description": "The mediator being drained, when `drainUntil` is present."
+        },
+        "vtaDid": {
+          "type": "string",
+          "description": "The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip."
+        },
+        "serverless": {
+          "type": "boolean",
+          "description": "True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.",
+          "default": false
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "ServiceKind": {
+      "title": "ServiceKind",
+      "description": "Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.",
+      "type": "string",
+      "enum": [
+        "didcomm",
+        "rest",
+        "tsp",
+        "webauthn"
+      ]
+    }
+  }
+} 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 Services — Disable — response payload",
+      "description": "Success response to vta/services/disable. Type https://trusttasks.org/spec/vta/services/disable/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "result"
+      ],
+      "properties": {
+        "result": {
+          "$ref": "#/$defs/ServiceMutationResult"
+        },
+        "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-]+)+$"
+      }
+    },
+    "ServiceMutationResult": {
+      "title": "ServiceMutationResult",
+      "description": "The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "logEntryVersionId",
+        "effectiveAt"
+      ],
+      "properties": {
+        "logEntryVersionId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history."
+        },
+        "effectiveAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339 instant the change took effect — the same instant stamped on the new log entry."
+        },
+        "drainUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong."
+        },
+        "drainingMediator": {
+          "type": "string",
+          "description": "The mediator being drained, when `drainUntil` is present."
+        },
+        "vtaDid": {
+          "type": "string",
+          "description": "The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip."
+        },
+        "serverless": {
+          "type": "boolean",
+          "description": "True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.",
+          "default": false
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "ServiceKind": {
+      "title": "ServiceKind",
+      "description": "Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.",
+      "type": "string",
+      "enum": [
+        "didcomm",
+        "rest",
+        "tsp",
+        "webauthn"
+      ]
+    }
+  }
+} 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,
+  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,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;