@openvtc/trust-tasks 0.21.1 → 0.21.3

package/src/vta/services/report/0.1/payload.ts

@@ -0,0 +1,419 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/services/report/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Asks an agent for its per-mediator inbound counts and each sender's last-seen mediator over a time window. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTAServicesReportPayload {
+  /**
+   * Lower bound, RFC 3339. Absent means as far back as the agent's telemetry goes.
+   */
+  since?: string;
+  /**
+   * Upper bound, RFC 3339. Absent means now.
+   */
+  until?: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+export interface VTAServicesReportResponsePayload {
+  /**
+   * The lower bound applied, when the request gave one.
+   */
+  since?: string;
+  /**
+   * The upper bound applied — now, when the request gave none.
+   */
+  until: string;
+  /**
+   * One entry per mediator that carried inbound traffic in the window.
+   *
+   * @maxItems 1000
+   */
+  mediators: MediatorStats[];
+  /**
+   * One entry per sender that reached the agent in the window.
+   *
+   * @maxItems 100000
+   */
+  senders: SenderLastSeen[];
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+export interface MediatorStats {
+  /**
+   * The mediator the traffic arrived through.
+   */
+  mediatorDid: string;
+  /**
+   * Messages that arrived through it in the window, over every mediated transport.
+   */
+  inboundCount: number;
+  /**
+   * The first arrival through it in the window.
+   */
+  firstSeen: string;
+  /**
+   * The last arrival through it in the window.
+   */
+  lastSeen: string;
+}
+export interface SenderLastSeen {
+  /**
+   * A sender that reached the agent in the window.
+   */
+  senderDid: string;
+  /**
+   * The mediator its most recent message arrived through.
+   */
+  lastSeenMediator: string;
+  /**
+   * The mediated transport the sender's most recent message arrived by. Absent when the agent's telemetry did not record it.
+   */
+  lastSeenTransport?: "didcomm" | "tsp";
+  /**
+   * When that message arrived.
+   */
+  lastSeenAt: string;
+}
+
+/** 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/vta/services/report/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAServicesReportPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/services/report/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAServicesReportResponsePayload;
+
+/**
+ * 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/report/0.1",
+  "title": "VTA Services — Report — payload",
+  "description": "Asks an agent for its per-mediator inbound counts and each sender's last-seen mediator over a time window. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "since": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Lower bound, RFC 3339. Absent means as far back as the agent's telemetry goes."
+    },
+    "until": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Upper bound, RFC 3339. Absent means now."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "MediatorStats": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mediatorDid",
+        "inboundCount",
+        "firstSeen",
+        "lastSeen"
+      ],
+      "properties": {
+        "mediatorDid": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1000,
+          "description": "The mediator the traffic arrived through."
+        },
+        "inboundCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages that arrived through it in the window, over every mediated transport."
+        },
+        "firstSeen": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The first arrival through it in the window."
+        },
+        "lastSeen": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The last arrival through it in the window."
+        }
+      }
+    },
+    "SenderLastSeen": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "senderDid",
+        "lastSeenMediator",
+        "lastSeenAt"
+      ],
+      "properties": {
+        "senderDid": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1000,
+          "description": "A sender that reached the agent in the window."
+        },
+        "lastSeenMediator": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1000,
+          "description": "The mediator its most recent message arrived through."
+        },
+        "lastSeenTransport": {
+          "type": "string",
+          "enum": [
+            "didcomm",
+            "tsp"
+          ],
+          "description": "The mediated transport the sender's most recent message arrived by. Absent when the agent's telemetry did not record it."
+        },
+        "lastSeenAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When that message arrived."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Services Report — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "until",
+        "mediators",
+        "senders"
+      ],
+      "properties": {
+        "since": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The lower bound applied, when the request gave one."
+        },
+        "until": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The upper bound applied — now, when the request gave none."
+        },
+        "mediators": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": {
+            "$ref": "#/$defs/MediatorStats"
+          },
+          "description": "One entry per mediator that carried inbound traffic in the window."
+        },
+        "senders": {
+          "type": "array",
+          "maxItems": 100000,
+          "items": {
+            "$ref": "#/$defs/SenderLastSeen"
+          },
+          "description": "One entry per sender that reached the agent in the window."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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": {
+    "MediatorStats": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mediatorDid",
+        "inboundCount",
+        "firstSeen",
+        "lastSeen"
+      ],
+      "properties": {
+        "mediatorDid": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1000,
+          "description": "The mediator the traffic arrived through."
+        },
+        "inboundCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages that arrived through it in the window, over every mediated transport."
+        },
+        "firstSeen": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The first arrival through it in the window."
+        },
+        "lastSeen": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The last arrival through it in the window."
+        }
+      }
+    },
+    "SenderLastSeen": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "senderDid",
+        "lastSeenMediator",
+        "lastSeenAt"
+      ],
+      "properties": {
+        "senderDid": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1000,
+          "description": "A sender that reached the agent in the window."
+        },
+        "lastSeenMediator": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1000,
+          "description": "The mediator its most recent message arrived through."
+        },
+        "lastSeenTransport": {
+          "type": "string",
+          "enum": [
+            "didcomm",
+            "tsp"
+          ],
+          "description": "The mediated transport the sender's most recent message arrived by. Absent when the agent's telemetry did not record it."
+        },
+        "lastSeenAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When that message arrived."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Services Report — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "until",
+        "mediators",
+        "senders"
+      ],
+      "properties": {
+        "since": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The lower bound applied, when the request gave one."
+        },
+        "until": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The upper bound applied — now, when the request gave none."
+        },
+        "mediators": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": {
+            "$ref": "#/$defs/MediatorStats"
+          },
+          "description": "One entry per mediator that carried inbound traffic in the window."
+        },
+        "senders": {
+          "type": "array",
+          "maxItems": 100000,
+          "items": {
+            "$ref": "#/$defs/SenderLastSeen"
+          },
+          "description": "One entry per sender that reached the agent in the window."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;