@openvtc/trust-tasks 0.21.4 → 0.21.5

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

@@ -0,0 +1,200 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/server/info/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface ServerInfoPayload {
+  ext?: Ext;
+}
+export interface ServerInfoResponsePayload {
+  /**
+   * The service's own DID: the recipient a client addresses every other Trust Task to, and the issuer of this response.
+   */
+  serviceDid: string;
+  /**
+   * Whether the service serves agent-name redirects. A client cannot detect it otherwise: with the feature off a name answers exactly as an unknown one.
+   */
+  agentNames: boolean;
+  /**
+   * The agent names the service's own DID serves, as local parts. The community name of a service that owns its domain is the empty string. Empty when it serves none.
+   */
+  serviceNames: string[];
+  /**
+   * How long a disabled domain keeps serving before its content becomes eligible for purge. Absent when the service cannot state it.
+   */
+  domainPurgeGraceSeconds?: number;
+  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/info/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = ServerInfoPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/server/info/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = ServerInfoResponsePayload;
+
+/**
+ * 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/info/0.1",
+  "title": "Server Info — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Server Info — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "serviceDid",
+        "agentNames",
+        "serviceNames"
+      ],
+      "properties": {
+        "serviceDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The service's own DID: the recipient a client addresses every other Trust Task to, and the issuer of this response."
+        },
+        "agentNames": {
+          "type": "boolean",
+          "description": "Whether the service serves agent-name redirects. A client cannot detect it otherwise: with the feature off a name answers exactly as an unknown one."
+        },
+        "serviceNames": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The agent names the service's own DID serves, as local parts. The community name of a service that owns its domain is the empty string. Empty when it serves none."
+        },
+        "domainPurgeGraceSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How long a disabled domain keeps serving before its content becomes eligible for purge. Absent when the service cannot state it."
+        },
+        "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 Info — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "serviceDid",
+        "agentNames",
+        "serviceNames"
+      ],
+      "properties": {
+        "serviceDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The service's own DID: the recipient a client addresses every other Trust Task to, and the issuer of this response."
+        },
+        "agentNames": {
+          "type": "boolean",
+          "description": "Whether the service serves agent-name redirects. A client cannot detect it otherwise: with the feature off a name answers exactly as an unknown one."
+        },
+        "serviceNames": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The agent names the service's own DID serves, as local parts. The community name of a service that owns its domain is the empty string. Empty when it serves none."
+        },
+        "domainPurgeGraceSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How long a disabled domain keeps serving before its content becomes eligible for purge. Absent when the service cannot state it."
+        },
+        "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: true,
+  isProofRequired: false,
+  isRecipientRequired: false,
+  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: true,
+  isProofRequired: true,
+  isRecipientRequired: false,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

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

@@ -0,0 +1,418 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/server/metrics/0.1/payload.schema.json
+ */
+
+import type { Ext, Histogram, HistogramBucket, Metric, MetricsSnapshot } from "../../../../_shared/components.js";
+
+
+/**
+ * The read takes no selector — the whole snapshot is returned. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface DIDManagementServerMetricsPayload {
+  ext?: Ext;
+}
+/**
+ * The service's current metrics snapshot. Carried in a Trust Task document whose type is https://trusttasks.org/spec/did-management/server/metrics/0.1#response.
+ */
+export interface DIDManagementServerMetricsResponsePayload {
+  snapshot: MetricsSnapshot;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, Histogram, HistogramBucket, Metric, MetricsSnapshot };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/did-management/server/metrics/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = DIDManagementServerMetricsPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/server/metrics/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = DIDManagementServerMetricsResponsePayload;
+
+/**
+ * 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/metrics/0.1",
+  "title": "DID Management — Server Metrics — payload",
+  "description": "The read takes no selector — the whole snapshot is returned. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "DID Management — Server Metrics — response payload",
+      "description": "The service's current metrics snapshot. Carried in a Trust Task document whose type is https://trusttasks.org/spec/did-management/server/metrics/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "snapshot"
+      ],
+      "properties": {
+        "snapshot": {
+          "$ref": "#/$defs/MetricsSnapshot"
+        },
+        "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-]+)+$"
+      }
+    },
+    "MetricsSnapshot": {
+      "title": "MetricsSnapshot",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "takenAt",
+        "counters",
+        "gauges",
+        "histograms"
+      ],
+      "properties": {
+        "takenAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the service read these values from its own instrumentation. Not the same as the envelope's issuedAt when a snapshot is cached briefly before answering."
+        },
+        "counters": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Metric"
+          },
+          "description": "Monotonically increasing totals (e.g. requests served, errors raised). Empty when the service exposes none. Always present, so a collector can tell \"no counters\" from \"the field was dropped\"."
+        },
+        "gauges": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Metric"
+          },
+          "description": "Point-in-time values that can rise or fall (e.g. open connections, queue depth). Empty when the service exposes none. Always present, for the same reason as counters."
+        },
+        "histograms": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Histogram"
+          },
+          "description": "Distributions of observed values (e.g. request latency). Empty when the service exposes none. Always present, for the same reason as counters."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Histogram": {
+      "title": "Histogram",
+      "description": "One histogram's distribution, in the Prometheus cumulative-bucket convention: each bucket's `count` includes every observation at or below its `le`.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "count",
+        "sum",
+        "buckets"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The histogram's stable name (e.g. `did_hosting_resolve_seconds`)."
+        },
+        "labels": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Dimensions the distribution is broken down by. Absent or empty when the histogram carries none."
+        },
+        "count": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total number of observations."
+        },
+        "sum": {
+          "type": "number",
+          "description": "Sum of all observed values."
+        },
+        "buckets": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/HistogramBucket"
+          },
+          "description": "Cumulative buckets, ordered by ascending `le`. Empty when the service exposes no bucket breakdown for this histogram — count and sum still apply. Always present, for the same reason as the snapshot's own arrays."
+        }
+      }
+    },
+    "HistogramBucket": {
+      "title": "HistogramBucket",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "le",
+        "count"
+      ],
+      "properties": {
+        "le": {
+          "type": "number",
+          "description": "Upper bound of this bucket, inclusive. The final bucket conventionally reports the same value as the histogram's own `count` at whatever `le` the service treats as its ceiling."
+        },
+        "count": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of observations at or below `le`."
+        }
+      }
+    },
+    "Metric": {
+      "title": "Metric",
+      "description": "One counter or gauge reading.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "value"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The metric's stable name (e.g. `did_hosting_requests_total`). Implementation-defined; the framework imposes no vocabulary."
+        },
+        "value": {
+          "type": "number",
+          "description": "The current reading."
+        },
+        "labels": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Dimensions the value is broken down by (e.g. `{\"method\": \"resolve\"}`). Absent or empty when the metric carries none."
+        }
+      }
+    }
+  }
+} 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": "DID Management — Server Metrics — response payload",
+      "description": "The service's current metrics snapshot. Carried in a Trust Task document whose type is https://trusttasks.org/spec/did-management/server/metrics/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "snapshot"
+      ],
+      "properties": {
+        "snapshot": {
+          "$ref": "#/$defs/MetricsSnapshot"
+        },
+        "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-]+)+$"
+      }
+    },
+    "MetricsSnapshot": {
+      "title": "MetricsSnapshot",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "takenAt",
+        "counters",
+        "gauges",
+        "histograms"
+      ],
+      "properties": {
+        "takenAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the service read these values from its own instrumentation. Not the same as the envelope's issuedAt when a snapshot is cached briefly before answering."
+        },
+        "counters": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Metric"
+          },
+          "description": "Monotonically increasing totals (e.g. requests served, errors raised). Empty when the service exposes none. Always present, so a collector can tell \"no counters\" from \"the field was dropped\"."
+        },
+        "gauges": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Metric"
+          },
+          "description": "Point-in-time values that can rise or fall (e.g. open connections, queue depth). Empty when the service exposes none. Always present, for the same reason as counters."
+        },
+        "histograms": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Histogram"
+          },
+          "description": "Distributions of observed values (e.g. request latency). Empty when the service exposes none. Always present, for the same reason as counters."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Histogram": {
+      "title": "Histogram",
+      "description": "One histogram's distribution, in the Prometheus cumulative-bucket convention: each bucket's `count` includes every observation at or below its `le`.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "count",
+        "sum",
+        "buckets"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The histogram's stable name (e.g. `did_hosting_resolve_seconds`)."
+        },
+        "labels": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Dimensions the distribution is broken down by. Absent or empty when the histogram carries none."
+        },
+        "count": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total number of observations."
+        },
+        "sum": {
+          "type": "number",
+          "description": "Sum of all observed values."
+        },
+        "buckets": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/HistogramBucket"
+          },
+          "description": "Cumulative buckets, ordered by ascending `le`. Empty when the service exposes no bucket breakdown for this histogram — count and sum still apply. Always present, for the same reason as the snapshot's own arrays."
+        }
+      }
+    },
+    "HistogramBucket": {
+      "title": "HistogramBucket",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "le",
+        "count"
+      ],
+      "properties": {
+        "le": {
+          "type": "number",
+          "description": "Upper bound of this bucket, inclusive. The final bucket conventionally reports the same value as the histogram's own `count` at whatever `le` the service treats as its ceiling."
+        },
+        "count": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of observations at or below `le`."
+        }
+      }
+    },
+    "Metric": {
+      "title": "Metric",
+      "description": "One counter or gauge reading.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "value"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The metric's stable name (e.g. `did_hosting_requests_total`). Implementation-defined; the framework imposes no vocabulary."
+        },
+        "value": {
+          "type": "number",
+          "description": "The current reading."
+        },
+        "labels": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Dimensions the value is broken down by (e.g. `{\"method\": \"resolve\"}`). Absent or empty when the metric carries none."
+        }
+      }
+    }
+  }
+} 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;