@openvtc/trust-tasks 0.19.14 → 0.19.16

package/src/messaging/monitor/subscribe/0.1/payload.ts

@@ -0,0 +1,473 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/monitor/subscribe/0.1/payload.schema.json
+ */
+
+import type { Ext, MonitorFilter, TrafficChannel, TrafficDirection, TrafficStage, Vid, WireProtocol } from "../../../../_shared/components.js";
+
+
+export interface MessagingSubscribeToTrafficMonitorPayload {
+  filter?: MonitorFilter;
+  /**
+   * How long the subscription lives unless renewed. Default 300.
+   */
+  leaseSeconds?: number;
+  /**
+   * Rate ceiling the subscriber can absorb; the mediator MAY apply a lower one. Events over the ceiling are counted as dropped, never queued.
+   */
+  maxEventsPerSecond?: number;
+  /**
+   * Renew or re-filter an existing subscription held by the same requester. Omitted = create a new one.
+   */
+  subscriptionId?: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * The success response to a messaging/monitor/subscribe request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/monitor/subscribe/0.1#response.
+ */
+export interface MessagingSubscribeToTrafficMonitorResponsePayload {
+  subscriptionId: string;
+  expiresAt: string;
+  /**
+   * The filter in force, after the mediator narrowed it to what the requester is entitled to see.
+   */
+  filter: MonitorFilter;
+  /**
+   * The rate ceiling in force.
+   */
+  maxEventsPerSecond: number;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, MonitorFilter, TrafficChannel, TrafficDirection, TrafficStage, Vid, WireProtocol };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/monitor/subscribe/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = MessagingSubscribeToTrafficMonitorPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/monitor/subscribe/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = MessagingSubscribeToTrafficMonitorResponsePayload;
+
+/**
+ * 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/messaging/monitor/subscribe/0.1",
+  "title": "Messaging — Subscribe to Traffic Monitor — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "filter": {
+      "$ref": "#/$defs/MonitorFilter"
+    },
+    "leaseSeconds": {
+      "type": "integer",
+      "minimum": 10,
+      "maximum": 3600,
+      "description": "How long the subscription lives unless renewed. Default 300."
+    },
+    "maxEventsPerSecond": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 1000,
+      "description": "Rate ceiling the subscriber can absorb; the mediator MAY apply a lower one. Events over the ceiling are counted as dropped, never queued."
+    },
+    "subscriptionId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Renew or re-filter an existing subscription held by the same requester. Omitted = create a new one."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Messaging — Subscribe to Traffic Monitor — response payload",
+      "description": "The success response to a messaging/monitor/subscribe request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/monitor/subscribe/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "subscriptionId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "filter": {
+          "$ref": "#/$defs/MonitorFilter",
+          "description": "The filter in force, after the mediator narrowed it to what the requester is entitled to see."
+        },
+        "maxEventsPerSecond": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The rate ceiling in force."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      },
+      "required": [
+        "subscriptionId",
+        "expiresAt",
+        "filter",
+        "maxEventsPerSecond"
+      ]
+    },
+    "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-]+)+$"
+      }
+    },
+    "MonitorFilter": {
+      "title": "MonitorFilter",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Selects which events a monitor subscription receives. Every member present narrows the selection (members are ANDed; values within one member are ORed). An empty filter selects everything the requester is entitled to see.",
+      "properties": {
+        "dids": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Vid"
+          },
+          "description": "Only events whose `from` or `to` is one of these accounts."
+        },
+        "directions": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/TrafficDirection"
+          }
+        },
+        "stages": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/TrafficStage"
+          }
+        },
+        "protocols": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/WireProtocol"
+          }
+        },
+        "channels": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/TrafficChannel"
+          }
+        },
+        "messageTypePrefixes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 20,
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 512
+          },
+          "description": "Only events whose `messageType` starts with one of these strings. Events with no `messageType` never match when this member is present."
+        },
+        "failuresOnly": {
+          "type": "boolean",
+          "description": "Only events that carry an `outcome`."
+        }
+      }
+    },
+    "TrafficChannel": {
+      "title": "TrafficChannel",
+      "type": "string",
+      "enum": [
+        "websocket",
+        "rest",
+        "peerMediator",
+        "internal"
+      ],
+      "description": "How the traffic reached or left the mediator. `peerMediator` is mediator-to-mediator forwarding."
+    },
+    "WireProtocol": {
+      "title": "WireProtocol",
+      "type": "string",
+      "enum": [
+        "didcomm",
+        "didcommV1",
+        "tsp",
+        "other"
+      ],
+      "description": "The protocol a message travelled in, as the mediator detected it from the wire form. `didcomm` is DIDComm v2 (JWE/JWS); `didcommV1` is a DIDComm v1 envelope; `tsp` is a Trust Spanning Protocol message; `other` is anything the mediator could not classify."
+    },
+    "TrafficStage": {
+      "title": "TrafficStage",
+      "type": "string",
+      "enum": [
+        "received",
+        "stored",
+        "delivered",
+        "forwarded",
+        "refused",
+        "deleted",
+        "expired",
+        "purged"
+      ],
+      "description": "What happened. `received`: a frame arrived. `stored`: it was queued for a local account. `delivered`: handed to its recipient. `forwarded`: relayed to another mediator. `refused`: rejected (see the event's `outcome`). `deleted`: removed by its recipient or an administrator. `expired`: removed by expiry. `purged`: removed by a queue purge."
+    },
+    "TrafficDirection": {
+      "title": "TrafficDirection",
+      "type": "string",
+      "enum": [
+        "inbound",
+        "outbound",
+        "internal"
+      ],
+      "description": "`inbound`: arriving at the mediator. `outbound`: leaving it (delivery to a recipient, or a forward to another mediator). `internal`: a state change with no wire traffic (expiry, deletion, purge)."
+    },
+    "Vid": {
+      "title": "Vid",
+      "type": "string",
+      "minLength": 1,
+      "description": "A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the account's controlling DID, carried verbatim and compared by exact string equality. For privacy — and because some mediators key accounts by a one-way hash and never hold the full DID — a stable hash of the DID (e.g. its SHA-256 digest) is an equally valid value here: producer and consumer simply agree on the same opaque identifier and compare by exact string equality. The field carries whichever form the issuing mediator uses."
+    }
+  }
+} 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": "Messaging — Subscribe to Traffic Monitor — response payload",
+      "description": "The success response to a messaging/monitor/subscribe request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/monitor/subscribe/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "subscriptionId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "filter": {
+          "$ref": "#/$defs/MonitorFilter",
+          "description": "The filter in force, after the mediator narrowed it to what the requester is entitled to see."
+        },
+        "maxEventsPerSecond": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The rate ceiling in force."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      },
+      "required": [
+        "subscriptionId",
+        "expiresAt",
+        "filter",
+        "maxEventsPerSecond"
+      ]
+    },
+    "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-]+)+$"
+      }
+    },
+    "MonitorFilter": {
+      "title": "MonitorFilter",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Selects which events a monitor subscription receives. Every member present narrows the selection (members are ANDed; values within one member are ORed). An empty filter selects everything the requester is entitled to see.",
+      "properties": {
+        "dids": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Vid"
+          },
+          "description": "Only events whose `from` or `to` is one of these accounts."
+        },
+        "directions": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/TrafficDirection"
+          }
+        },
+        "stages": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/TrafficStage"
+          }
+        },
+        "protocols": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/WireProtocol"
+          }
+        },
+        "channels": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/TrafficChannel"
+          }
+        },
+        "messageTypePrefixes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 20,
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 512
+          },
+          "description": "Only events whose `messageType` starts with one of these strings. Events with no `messageType` never match when this member is present."
+        },
+        "failuresOnly": {
+          "type": "boolean",
+          "description": "Only events that carry an `outcome`."
+        }
+      }
+    },
+    "TrafficChannel": {
+      "title": "TrafficChannel",
+      "type": "string",
+      "enum": [
+        "websocket",
+        "rest",
+        "peerMediator",
+        "internal"
+      ],
+      "description": "How the traffic reached or left the mediator. `peerMediator` is mediator-to-mediator forwarding."
+    },
+    "WireProtocol": {
+      "title": "WireProtocol",
+      "type": "string",
+      "enum": [
+        "didcomm",
+        "didcommV1",
+        "tsp",
+        "other"
+      ],
+      "description": "The protocol a message travelled in, as the mediator detected it from the wire form. `didcomm` is DIDComm v2 (JWE/JWS); `didcommV1` is a DIDComm v1 envelope; `tsp` is a Trust Spanning Protocol message; `other` is anything the mediator could not classify."
+    },
+    "TrafficStage": {
+      "title": "TrafficStage",
+      "type": "string",
+      "enum": [
+        "received",
+        "stored",
+        "delivered",
+        "forwarded",
+        "refused",
+        "deleted",
+        "expired",
+        "purged"
+      ],
+      "description": "What happened. `received`: a frame arrived. `stored`: it was queued for a local account. `delivered`: handed to its recipient. `forwarded`: relayed to another mediator. `refused`: rejected (see the event's `outcome`). `deleted`: removed by its recipient or an administrator. `expired`: removed by expiry. `purged`: removed by a queue purge."
+    },
+    "TrafficDirection": {
+      "title": "TrafficDirection",
+      "type": "string",
+      "enum": [
+        "inbound",
+        "outbound",
+        "internal"
+      ],
+      "description": "`inbound`: arriving at the mediator. `outbound`: leaving it (delivery to a recipient, or a forward to another mediator). `internal`: a state change with no wire traffic (expiry, deletion, purge)."
+    },
+    "Vid": {
+      "title": "Vid",
+      "type": "string",
+      "minLength": 1,
+      "description": "A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the account's controlling DID, carried verbatim and compared by exact string equality. For privacy — and because some mediators key accounts by a one-way hash and never hold the full DID — a stable hash of the DID (e.g. its SHA-256 digest) is an equally valid value here: producer and consumer simply agree on the same opaque identifier and compare by exact string equality. The field carries whichever form the issuing mediator uses."
+    }
+  }
+} 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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/messaging/monitor/unsubscribe/0.1/payload.ts

@@ -0,0 +1,172 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/monitor/unsubscribe/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface MessagingUnsubscribeFromTrafficMonitorPayload {
+  subscriptionId: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * The success response to a messaging/monitor/unsubscribe request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/monitor/unsubscribe/0.1#response.
+ */
+export interface MessagingUnsubscribeFromTrafficMonitorResponsePayload {
+  eventsSent?: number;
+  eventsDropped?: number;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  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/messaging/monitor/unsubscribe/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = MessagingUnsubscribeFromTrafficMonitorPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/monitor/unsubscribe/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = MessagingUnsubscribeFromTrafficMonitorResponsePayload;
+
+/**
+ * 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/messaging/monitor/unsubscribe/0.1",
+  "title": "Messaging — Unsubscribe from Traffic Monitor — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "subscriptionId"
+  ],
+  "properties": {
+    "subscriptionId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Messaging — Unsubscribe from Traffic Monitor — response payload",
+      "description": "The success response to a messaging/monitor/unsubscribe request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/monitor/unsubscribe/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "eventsSent": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "eventsDropped": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "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": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Messaging — Unsubscribe from Traffic Monitor — response payload",
+      "description": "The success response to a messaging/monitor/unsubscribe request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/monitor/unsubscribe/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "eventsSent": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "eventsDropped": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "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: 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,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;