@openvtc/trust-tasks 0.21.3 → 0.21.5

package/src/did-management/server/config/0.1/payload.ts

@@ -0,0 +1,545 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/server/config/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface ServerConfigPayload {
+  ext?: Ext;
+}
+/**
+ * The hosting service's effective, non-secret configuration. Members the deployment does not configure are absent; nothing here is a secret, and a consumer MUST NOT add one under ext.
+ */
+export interface ServerConfigResponsePayload {
+  /**
+   * The service's own DID — the issuer of its replies.
+   */
+  serviceDid: string;
+  /**
+   * The running implementation's version string.
+   */
+  softwareVersion: string;
+  /**
+   * Implementation-defined deployment shape (e.g. a single-process daemon, or a control plane driving remote edges).
+   */
+  deploymentMode: string;
+  /**
+   * Base URL of the service's own web surface. Absent when not configured.
+   */
+  publicUrl?: string;
+  /**
+   * Base URL hosted DIDs are published under. Absent when not configured.
+   */
+  didHostingUrl?: string;
+  /**
+   * The messaging mediator the service is reached through. Absent when it runs without one.
+   */
+  mediatorDid?: string;
+  /**
+   * Which messaging transports the configuration enables.
+   */
+  transports: {
+    tsp: boolean;
+    didcomm: boolean;
+  };
+  /**
+   * `service[].type` values of the service's own resolved DID document. Absent when it could not be resolved. What the configuration enables and what the document advertises can differ; both are shown so an operator can see it.
+   */
+  advertisedServices?: string[];
+  /**
+   * DID methods this build can host.
+   */
+  enabledMethods: string[];
+  /**
+   * Whether agent-name redirects (`/@name`) are served.
+   */
+  agentNames: boolean;
+  /**
+   * The address the service's HTTP listener is bound to.
+   */
+  listenAddress?: string;
+  /**
+   * The verifiable trust agent holding the service's identity. Absent for a self-managed deployment.
+   */
+  vta?: {
+    did?: string;
+    url?: string;
+  };
+  registry?: {
+    healthCheckIntervalSeconds: number;
+    /**
+     * Instances seeded from configuration rather than registered.
+     */
+    configuredInstances: number;
+  };
+  sessions?: {
+    accessTokenSeconds: number;
+    refreshTokenSeconds: number;
+    adminIdleTimeoutSeconds: number;
+    passkeyEnrollmentSeconds: number;
+  };
+  storage?: {
+    dataDir: string;
+  };
+  logging?: {
+    level: string;
+    format: string;
+  };
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/did-management/server/config/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = ServerConfigPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/server/config/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = ServerConfigResponsePayload;
+
+/**
+ * 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/did-management/server/config/0.1",
+  "title": "Server Config — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Server Config — response payload",
+      "description": "The hosting service's effective, non-secret configuration. Members the deployment does not configure are absent; nothing here is a secret, and a consumer MUST NOT add one under ext.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "serviceDid",
+        "softwareVersion",
+        "deploymentMode",
+        "transports",
+        "enabledMethods",
+        "agentNames"
+      ],
+      "properties": {
+        "serviceDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The service's own DID — the issuer of its replies."
+        },
+        "softwareVersion": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The running implementation's version string."
+        },
+        "deploymentMode": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Implementation-defined deployment shape (e.g. a single-process daemon, or a control plane driving remote edges)."
+        },
+        "publicUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Base URL of the service's own web surface. Absent when not configured."
+        },
+        "didHostingUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Base URL hosted DIDs are published under. Absent when not configured."
+        },
+        "mediatorDid": {
+          "type": "string",
+          "description": "The messaging mediator the service is reached through. Absent when it runs without one."
+        },
+        "transports": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "tsp",
+            "didcomm"
+          ],
+          "description": "Which messaging transports the configuration enables.",
+          "properties": {
+            "tsp": {
+              "type": "boolean"
+            },
+            "didcomm": {
+              "type": "boolean"
+            }
+          }
+        },
+        "advertisedServices": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "`service[].type` values of the service's own resolved DID document. Absent when it could not be resolved. What the configuration enables and what the document advertises can differ; both are shown so an operator can see it."
+        },
+        "enabledMethods": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "DID methods this build can host."
+        },
+        "agentNames": {
+          "type": "boolean",
+          "description": "Whether agent-name redirects (`/@name`) are served."
+        },
+        "listenAddress": {
+          "type": "string",
+          "description": "The address the service's HTTP listener is bound to."
+        },
+        "vta": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "The verifiable trust agent holding the service's identity. Absent for a self-managed deployment.",
+          "properties": {
+            "did": {
+              "type": "string"
+            },
+            "url": {
+              "type": "string",
+              "format": "uri"
+            }
+          }
+        },
+        "registry": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "healthCheckIntervalSeconds",
+            "configuredInstances"
+          ],
+          "properties": {
+            "healthCheckIntervalSeconds": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "configuredInstances": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Instances seeded from configuration rather than registered."
+            }
+          }
+        },
+        "sessions": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "accessTokenSeconds",
+            "refreshTokenSeconds",
+            "adminIdleTimeoutSeconds",
+            "passkeyEnrollmentSeconds"
+          ],
+          "properties": {
+            "accessTokenSeconds": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "refreshTokenSeconds": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "adminIdleTimeoutSeconds": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "passkeyEnrollmentSeconds": {
+              "type": "integer",
+              "minimum": 1
+            }
+          }
+        },
+        "storage": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "dataDir"
+          ],
+          "properties": {
+            "dataDir": {
+              "type": "string"
+            }
+          }
+        },
+        "logging": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "level",
+            "format"
+          ],
+          "properties": {
+            "level": {
+              "type": "string"
+            },
+            "format": {
+              "type": "string"
+            }
+          }
+        },
+        "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": "Server Config — response payload",
+      "description": "The hosting service's effective, non-secret configuration. Members the deployment does not configure are absent; nothing here is a secret, and a consumer MUST NOT add one under ext.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "serviceDid",
+        "softwareVersion",
+        "deploymentMode",
+        "transports",
+        "enabledMethods",
+        "agentNames"
+      ],
+      "properties": {
+        "serviceDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The service's own DID — the issuer of its replies."
+        },
+        "softwareVersion": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The running implementation's version string."
+        },
+        "deploymentMode": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Implementation-defined deployment shape (e.g. a single-process daemon, or a control plane driving remote edges)."
+        },
+        "publicUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Base URL of the service's own web surface. Absent when not configured."
+        },
+        "didHostingUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Base URL hosted DIDs are published under. Absent when not configured."
+        },
+        "mediatorDid": {
+          "type": "string",
+          "description": "The messaging mediator the service is reached through. Absent when it runs without one."
+        },
+        "transports": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "tsp",
+            "didcomm"
+          ],
+          "description": "Which messaging transports the configuration enables.",
+          "properties": {
+            "tsp": {
+              "type": "boolean"
+            },
+            "didcomm": {
+              "type": "boolean"
+            }
+          }
+        },
+        "advertisedServices": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "`service[].type` values of the service's own resolved DID document. Absent when it could not be resolved. What the configuration enables and what the document advertises can differ; both are shown so an operator can see it."
+        },
+        "enabledMethods": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "DID methods this build can host."
+        },
+        "agentNames": {
+          "type": "boolean",
+          "description": "Whether agent-name redirects (`/@name`) are served."
+        },
+        "listenAddress": {
+          "type": "string",
+          "description": "The address the service's HTTP listener is bound to."
+        },
+        "vta": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "The verifiable trust agent holding the service's identity. Absent for a self-managed deployment.",
+          "properties": {
+            "did": {
+              "type": "string"
+            },
+            "url": {
+              "type": "string",
+              "format": "uri"
+            }
+          }
+        },
+        "registry": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "healthCheckIntervalSeconds",
+            "configuredInstances"
+          ],
+          "properties": {
+            "healthCheckIntervalSeconds": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "configuredInstances": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Instances seeded from configuration rather than registered."
+            }
+          }
+        },
+        "sessions": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "accessTokenSeconds",
+            "refreshTokenSeconds",
+            "adminIdleTimeoutSeconds",
+            "passkeyEnrollmentSeconds"
+          ],
+          "properties": {
+            "accessTokenSeconds": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "refreshTokenSeconds": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "adminIdleTimeoutSeconds": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "passkeyEnrollmentSeconds": {
+              "type": "integer",
+              "minimum": 1
+            }
+          }
+        },
+        "storage": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "dataDir"
+          ],
+          "properties": {
+            "dataDir": {
+              "type": "string"
+            }
+          }
+        },
+        "logging": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "level",
+            "format"
+          ],
+          "properties": {
+            "level": {
+              "type": "string"
+            },
+            "format": {
+              "type": "string"
+            }
+          }
+        },
+        "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,
+  isIssuedAtRequired: false,
+  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: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;