@openvtc/trust-tasks 0.10.0 → 0.12.0

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

@@ -0,0 +1,283 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/services/list/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/list. Takes no filters: the answer is the agent's whole advertised surface, which is public in its DID document anyway.
+ */
+export interface VTAServicesListPayload {
+  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/list. Type https://trusttasks.org/spec/vta/services/list/1.0#response.
+ */
+export interface VTAServicesListResponsePayload {
+  /**
+   * Every transport the agent knows about, advertised or not. A kind absent from this array has never been configured — distinct from one present with `enabled: false`.
+   */
+  services: ServiceState[];
+  ext?: Ext;
+}
+/**
+ * What the agent currently advertises for one service. `enabled` is the only member every kind carries; the rest are kind-specific and absent when they do not apply. Note that `enabled: false` and an absent entry are different: the first says the agent knows about this transport and is not advertising it, the second says it has never been configured.
+ */
+export interface ServiceState {
+  kind: ServiceKind;
+  /**
+   * Whether the agent currently advertises this transport in its DID document.
+   */
+  enabled: boolean;
+  /**
+   * The mediator this transport routes through. Present for `didcomm` and `tsp`.
+   */
+  mediatorDid?: string;
+  /**
+   * The advertised endpoint. Present for `rest` and `webauthn`.
+   */
+  url?: string;
+  /**
+   * RFC 3339 instant at which a scheduled drain completes. Present only while a `didcomm` mediator is draining — see `vta/services/drain/list`.
+   */
+  drainsUntil?: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/services/list/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAServicesListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/services/list/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAServicesListResponsePayload;
+
+/**
+ * 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/list/1.0",
+  "title": "VTA Services — List — payload",
+  "description": "Request payload for vta/services/list. Takes no filters: the answer is the agent's whole advertised surface, which is public in its DID document anyway.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Services — List — response payload",
+      "description": "Success response to vta/services/list. Type https://trusttasks.org/spec/vta/services/list/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "services"
+      ],
+      "properties": {
+        "services": {
+          "type": "array",
+          "description": "Every transport the agent knows about, advertised or not. A kind absent from this array has never been configured — distinct from one present with `enabled: false`.",
+          "items": {
+            "$ref": "#/$defs/ServiceState"
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "ServiceState": {
+      "title": "ServiceState",
+      "description": "What the agent currently advertises for one service. `enabled` is the only member every kind carries; the rest are kind-specific and absent when they do not apply. Note that `enabled: false` and an absent entry are different: the first says the agent knows about this transport and is not advertising it, the second says it has never been configured.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "enabled"
+      ],
+      "properties": {
+        "kind": {
+          "$ref": "#/$defs/ServiceKind"
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the agent currently advertises this transport in its DID document."
+        },
+        "mediatorDid": {
+          "type": "string",
+          "description": "The mediator this transport routes through. Present for `didcomm` and `tsp`."
+        },
+        "url": {
+          "type": "string",
+          "description": "The advertised endpoint. Present for `rest` and `webauthn`."
+        },
+        "drainsUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339 instant at which a scheduled drain completes. Present only while a `didcomm` mediator is draining — see `vta/services/drain/list`."
+        },
+        "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 — List — response payload",
+      "description": "Success response to vta/services/list. Type https://trusttasks.org/spec/vta/services/list/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "services"
+      ],
+      "properties": {
+        "services": {
+          "type": "array",
+          "description": "Every transport the agent knows about, advertised or not. A kind absent from this array has never been configured — distinct from one present with `enabled: false`.",
+          "items": {
+            "$ref": "#/$defs/ServiceState"
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "ServiceState": {
+      "title": "ServiceState",
+      "description": "What the agent currently advertises for one service. `enabled` is the only member every kind carries; the rest are kind-specific and absent when they do not apply. Note that `enabled: false` and an absent entry are different: the first says the agent knows about this transport and is not advertising it, the second says it has never been configured.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "enabled"
+      ],
+      "properties": {
+        "kind": {
+          "$ref": "#/$defs/ServiceKind"
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the agent currently advertises this transport in its DID document."
+        },
+        "mediatorDid": {
+          "type": "string",
+          "description": "The mediator this transport routes through. Present for `didcomm` and `tsp`."
+        },
+        "url": {
+          "type": "string",
+          "description": "The advertised endpoint. Present for `rest` and `webauthn`."
+        },
+        "drainsUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339 instant at which a scheduled drain completes. Present only while a `didcomm` mediator is draining — see `vta/services/drain/list`."
+        },
+        "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: false,
+  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: false,
+  isRecipientRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

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

@@ -0,0 +1,322 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/services/rollback/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/rollback. Reverts a transport to its previous advertised settings by writing a NEW log entry — the history is append-only, so a rollback is a forward step that restores an earlier state, never an erasure of what happened.
+ */
+export interface VTAServicesRollbackPayload {
+  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/rollback. Type https://trusttasks.org/spec/vta/services/rollback/1.0#response.
+ */
+export interface VTAServicesRollbackResponsePayload {
+  result: RollbackResult;
+  ext?: Ext;
+}
+/**
+ * The outcome of a rollback. Distinct from ServiceMutationResult because a rollback can legitimately publish nothing: if the previous state already equals the current one there is no change to write, and `kind: "noOp"` says so with `logEntryVersionId` absent. Treating that as a failure would be wrong — the requested state holds — and treating it as an ordinary success would report a log entry that does not exist.
+ */
+export interface RollbackResult {
+  /**
+   * What the rollback did. `disabled` re-disabled the transport, `enabled` re-advertised it at its prior settings, `updated` restored prior settings on an entry that stayed advertised, and `noOp` means the previous state already matched — nothing was written.
+   */
+  kind: "disabled" | "enabled" | "updated" | "noOp";
+  /**
+   * Version id of the log entry the rollback wrote. **Absent when `kind` is `noOp`**, and present otherwise.
+   */
+  logEntryVersionId?: string;
+  /**
+   * RFC 3339 instant the rollback took effect. Absent for `noOp`.
+   */
+  effectiveAt?: string;
+  /**
+   * Present when rolling back DIDComm left a mediator draining.
+   */
+  drainingMediator?: string;
+  /**
+   * When that drain completes.
+   */
+  drainUntil?: string;
+  /**
+   * The agent's own DID.
+   */
+  vtaDid?: string;
+  /**
+   * True when the entry was written locally but not published — the operator must redeploy before any verifier sees it.
+   */
+  serverless?: boolean;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/services/rollback/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAServicesRollbackPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/services/rollback/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAServicesRollbackResponsePayload;
+
+/**
+ * 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/rollback/1.0",
+  "title": "VTA Services — Rollback — payload",
+  "description": "Request payload for vta/services/rollback. Reverts a transport to its previous advertised settings by writing a NEW log entry — the history is append-only, so a rollback is a forward step that restores an earlier state, never an erasure of what happened.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "service"
+  ],
+  "properties": {
+    "service": {
+      "$ref": "#/$defs/ServiceKind"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Services — Rollback — response payload",
+      "description": "Success response to vta/services/rollback. Type https://trusttasks.org/spec/vta/services/rollback/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "result"
+      ],
+      "properties": {
+        "result": {
+          "$ref": "#/$defs/RollbackResult"
+        },
+        "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-]+)+$"
+      }
+    },
+    "RollbackResult": {
+      "title": "RollbackResult",
+      "description": "The outcome of a rollback. Distinct from ServiceMutationResult because a rollback can legitimately publish nothing: if the previous state already equals the current one there is no change to write, and `kind: \"noOp\"` says so with `logEntryVersionId` absent. Treating that as a failure would be wrong — the requested state holds — and treating it as an ordinary success would report a log entry that does not exist.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind"
+      ],
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "enabled",
+            "updated",
+            "noOp"
+          ],
+          "description": "What the rollback did. `disabled` re-disabled the transport, `enabled` re-advertised it at its prior settings, `updated` restored prior settings on an entry that stayed advertised, and `noOp` means the previous state already matched — nothing was written."
+        },
+        "logEntryVersionId": {
+          "type": "string",
+          "description": "Version id of the log entry the rollback wrote. **Absent when `kind` is `noOp`**, and present otherwise."
+        },
+        "effectiveAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339 instant the rollback took effect. Absent for `noOp`."
+        },
+        "drainingMediator": {
+          "type": "string",
+          "description": "Present when rolling back DIDComm left a mediator draining."
+        },
+        "drainUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When that drain completes."
+        },
+        "vtaDid": {
+          "type": "string",
+          "description": "The agent's own DID."
+        },
+        "serverless": {
+          "type": "boolean",
+          "default": false,
+          "description": "True when the entry was written locally but not published — the operator must redeploy before any verifier sees it."
+        },
+        "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 — Rollback — response payload",
+      "description": "Success response to vta/services/rollback. Type https://trusttasks.org/spec/vta/services/rollback/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "result"
+      ],
+      "properties": {
+        "result": {
+          "$ref": "#/$defs/RollbackResult"
+        },
+        "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-]+)+$"
+      }
+    },
+    "RollbackResult": {
+      "title": "RollbackResult",
+      "description": "The outcome of a rollback. Distinct from ServiceMutationResult because a rollback can legitimately publish nothing: if the previous state already equals the current one there is no change to write, and `kind: \"noOp\"` says so with `logEntryVersionId` absent. Treating that as a failure would be wrong — the requested state holds — and treating it as an ordinary success would report a log entry that does not exist.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind"
+      ],
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "enabled",
+            "updated",
+            "noOp"
+          ],
+          "description": "What the rollback did. `disabled` re-disabled the transport, `enabled` re-advertised it at its prior settings, `updated` restored prior settings on an entry that stayed advertised, and `noOp` means the previous state already matched — nothing was written."
+        },
+        "logEntryVersionId": {
+          "type": "string",
+          "description": "Version id of the log entry the rollback wrote. **Absent when `kind` is `noOp`**, and present otherwise."
+        },
+        "effectiveAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339 instant the rollback took effect. Absent for `noOp`."
+        },
+        "drainingMediator": {
+          "type": "string",
+          "description": "Present when rolling back DIDComm left a mediator draining."
+        },
+        "drainUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When that drain completes."
+        },
+        "vtaDid": {
+          "type": "string",
+          "description": "The agent's own DID."
+        },
+        "serverless": {
+          "type": "boolean",
+          "default": false,
+          "description": "True when the entry was written locally but not published — the operator must redeploy before any verifier sees it."
+        },
+        "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;