@openvtc/trust-tasks 0.10.0 → 0.12.0

package/src/vta/services/drain/cancel/1.0/payload.ts

@@ -0,0 +1,169 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/services/drain/cancel/1.0/payload.schema.json
+ */
+
+/**
+ * Request payload for vta/services/drain/cancel. Ends a drain early, dropping the mediator now instead of at `drainsUntil`. Messages still in flight through it are lost, which is the whole reason the drain window existed.
+ */
+export interface VTAServicesDrainCancelPayload {
+  /**
+   * The draining mediator to drop. Refused if it is not draining, and refused if it is the currently advertised mediator — cancelling a drain on the active mediator would strand every route the agent depends on.
+   */
+  mediatorDid: 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;
+}
+/**
+ * Success response to vta/services/drain/cancel. Type https://trusttasks.org/spec/vta/services/drain/cancel/1.0#response.
+ */
+export interface VTAServicesDrainCancelResponsePayload {
+  /**
+   * The mediator that was dropped.
+   */
+  mediatorDid: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/services/drain/cancel/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAServicesDrainCancelPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/services/drain/cancel/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAServicesDrainCancelResponsePayload;
+
+/**
+ * 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/drain/cancel/1.0",
+  "title": "VTA Services Drain — Cancel — payload",
+  "description": "Request payload for vta/services/drain/cancel. Ends a drain early, dropping the mediator now instead of at `drainsUntil`. Messages still in flight through it are lost, which is the whole reason the drain window existed.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "mediatorDid"
+  ],
+  "properties": {
+    "mediatorDid": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The draining mediator to drop. Refused if it is not draining, and refused if it is the currently advertised mediator — cancelling a drain on the active mediator would strand every route the agent depends on."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Services Drain — Cancel — response payload",
+      "description": "Success response to vta/services/drain/cancel. Type https://trusttasks.org/spec/vta/services/drain/cancel/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mediatorDid"
+      ],
+      "properties": {
+        "mediatorDid": {
+          "type": "string",
+          "description": "The mediator that was dropped."
+        },
+        "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 Services Drain — Cancel — response payload",
+      "description": "Success response to vta/services/drain/cancel. Type https://trusttasks.org/spec/vta/services/drain/cancel/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mediatorDid"
+      ],
+      "properties": {
+        "mediatorDid": {
+          "type": "string",
+          "description": "The mediator that was dropped."
+        },
+        "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/drain/list/1.0/payload.ts

@@ -0,0 +1,241 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/services/drain/list/1.0/payload.schema.json
+ */
+
+/**
+ * Request payload for vta/services/drain/list. Enumerates DIDComm mediators that are no longer advertised but are still accepting delivery.
+ */
+export interface VTAServicesDrainListPayload {
+  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/drain/list. Type https://trusttasks.org/spec/vta/services/drain/list/1.0#response.
+ */
+export interface VTAServicesDrainListResponsePayload {
+  /**
+   * Mediators currently draining. An empty array means nothing is draining — which is the ordinary state, not an error.
+   */
+  entries: DrainEntry[];
+  ext?: Ext;
+}
+/**
+ * A DIDComm mediator that is no longer advertised but is still accepting delivery, so in-flight messages routed through it are not stranded.
+ */
+export interface DrainEntry {
+  /**
+   * The mediator being drained.
+   */
+  mediatorDid: string;
+  /**
+   * Where it is still reachable for the remainder of the drain.
+   */
+  endpoint: string;
+  /**
+   * RFC 3339 instant after which the mediator is dropped and messages routed through it are lost.
+   */
+  drainsUntil: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/services/drain/list/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAServicesDrainListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/services/drain/list/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAServicesDrainListResponsePayload;
+
+/**
+ * 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/drain/list/1.0",
+  "title": "VTA Services Drain — List — payload",
+  "description": "Request payload for vta/services/drain/list. Enumerates DIDComm mediators that are no longer advertised but are still accepting delivery.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Services Drain — List — response payload",
+      "description": "Success response to vta/services/drain/list. Type https://trusttasks.org/spec/vta/services/drain/list/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entries"
+      ],
+      "properties": {
+        "entries": {
+          "type": "array",
+          "description": "Mediators currently draining. An empty array means nothing is draining — which is the ordinary state, not an error.",
+          "items": {
+            "$ref": "#/$defs/DrainEntry"
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "DrainEntry": {
+      "title": "DrainEntry",
+      "description": "A DIDComm mediator that is no longer advertised but is still accepting delivery, so in-flight messages routed through it are not stranded.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mediatorDid",
+        "endpoint",
+        "drainsUntil"
+      ],
+      "properties": {
+        "mediatorDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The mediator being drained."
+        },
+        "endpoint": {
+          "type": "string",
+          "description": "Where it is still reachable for the remainder of the drain."
+        },
+        "drainsUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339 instant after which the mediator is dropped and messages routed through it are lost."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    }
+  }
+} 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 Drain — List — response payload",
+      "description": "Success response to vta/services/drain/list. Type https://trusttasks.org/spec/vta/services/drain/list/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entries"
+      ],
+      "properties": {
+        "entries": {
+          "type": "array",
+          "description": "Mediators currently draining. An empty array means nothing is draining — which is the ordinary state, not an error.",
+          "items": {
+            "$ref": "#/$defs/DrainEntry"
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "DrainEntry": {
+      "title": "DrainEntry",
+      "description": "A DIDComm mediator that is no longer advertised but is still accepting delivery, so in-flight messages routed through it are not stranded.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mediatorDid",
+        "endpoint",
+        "drainsUntil"
+      ],
+      "properties": {
+        "mediatorDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The mediator being drained."
+        },
+        "endpoint": {
+          "type": "string",
+          "description": "Where it is still reachable for the remainder of the drain."
+        },
+        "drainsUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339 instant after which the mediator is dropped and messages routed through it are lost."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    }
+  }
+} 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;