@openvtc/trust-tasks 0.21.2 → 0.21.4

package/src/vta/services/update/1.1/payload.ts

@@ -0,0 +1,326 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/services/update/1.1/payload.schema.json
+ */
+
+import type { Ext, ServiceKind, ServiceMutationResult } from "../../../../_shared/components.js";
+
+
+/**
+ * Request payload for vta/services/update. Replaces the settings on a transport that is already advertised. Refused when the transport is not currently enabled — that case is `enable`, and conflating the two would let a typo silently advertise a service the operator meant to change.
+ */
+export interface VTAServicesUpdatePayload {
+  service: ServiceKind;
+  /**
+   * Kind-specific settings. Which member applies is decided by `service`, and the two must agree — a `rest` request carrying `mediatorDid` is malformed, not a request with an ignored field. `didcomm` and `tsp` take `mediatorDid`; `rest` and `webauthn` take `url`.
+   */
+  config: {
+    /**
+     * Mediator to route through. Applies to `didcomm` and `tsp`.
+     */
+    mediatorDid?: string;
+    /**
+     * Endpoint to advertise. Applies to `rest` and `webauthn`. MUST be `https://`, with no fragment and no userinfo — the agent refuses anything else, because this value ends up in a signed DID document that clients will fetch.
+     */
+    url?: string;
+    /**
+     * `didcomm` only: skip the mediator handshake except for DID resolution. Absent means the handshake runs, which is the safe reading — this carries no schema-level default on purpose, because a default would materialise the field into a `rest` or `webauthn` config where it has no meaning. The handshake is what proves the mediator is reachable and willing, so forcing past it can advertise a mediator that cannot actually deliver.
+     */
+    force?: boolean;
+    /**
+     * `didcomm` only: trust-ping round-trip budget. Default 10.
+     */
+    handshakeTimeoutSecs?: number;
+  };
+  ext?: Ext;
+  /**
+   * Mediated transports only (`didcomm`, `tsp`): how long the replaced mediator keeps accepting delivery for correspondents still holding the previous DID document. Refused for `rest` and `webauthn`. Absent takes the agent's default. The agent may raise a value below its floor to the floor — and does, over a request that arrived through the mediator being replaced — and one mediator carrying both mediated transports drains once for both, so read `drainUntil` in the result for the window actually applied.
+   */
+  drainTtlSecs?: number;
+}
+/**
+ * Success response to vta/services/update. Type https://trusttasks.org/spec/vta/services/update/1.1#response.
+ */
+export interface VTAServicesUpdateResponsePayload {
+  result: ServiceMutationResult;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, ServiceKind, ServiceMutationResult };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/services/update/1.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAServicesUpdatePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/services/update/1.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAServicesUpdateResponsePayload;
+
+/**
+ * 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/update/1.1",
+  "title": "VTA Services — Update — payload",
+  "description": "Request payload for vta/services/update. Replaces the settings on a transport that is already advertised. Refused when the transport is not currently enabled — that case is `enable`, and conflating the two would let a typo silently advertise a service the operator meant to change.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "service",
+    "config"
+  ],
+  "properties": {
+    "service": {
+      "$ref": "#/$defs/ServiceKind"
+    },
+    "config": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Kind-specific settings. Which member applies is decided by `service`, and the two must agree — a `rest` request carrying `mediatorDid` is malformed, not a request with an ignored field. `didcomm` and `tsp` take `mediatorDid`; `rest` and `webauthn` take `url`.",
+      "properties": {
+        "mediatorDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Mediator to route through. Applies to `didcomm` and `tsp`."
+        },
+        "url": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Endpoint to advertise. Applies to `rest` and `webauthn`. MUST be `https://`, with no fragment and no userinfo — the agent refuses anything else, because this value ends up in a signed DID document that clients will fetch."
+        },
+        "force": {
+          "type": "boolean",
+          "description": "`didcomm` only: skip the mediator handshake except for DID resolution. Absent means the handshake runs, which is the safe reading — this carries no schema-level default on purpose, because a default would materialise the field into a `rest` or `webauthn` config where it has no meaning. The handshake is what proves the mediator is reachable and willing, so forcing past it can advertise a mediator that cannot actually deliver."
+        },
+        "handshakeTimeoutSecs": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "`didcomm` only: trust-ping round-trip budget. Default 10."
+        }
+      }
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    },
+    "drainTtlSecs": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Mediated transports only (`didcomm`, `tsp`): how long the replaced mediator keeps accepting delivery for correspondents still holding the previous DID document. Refused for `rest` and `webauthn`. Absent takes the agent's default. The agent may raise a value below its floor to the floor — and does, over a request that arrived through the mediator being replaced — and one mediator carrying both mediated transports drains once for both, so read `drainUntil` in the result for the window actually applied."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Services — Update — response payload",
+      "description": "Success response to vta/services/update. Type https://trusttasks.org/spec/vta/services/update/1.1#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 — Update — response payload",
+      "description": "Success response to vta/services/update. Type https://trusttasks.org/spec/vta/services/update/1.1#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,
+  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;