@openvtc/trust-tasks 0.19.15 → 0.19.17

package/dist/messaging/monitor/subscribe/0.1/payload.d.ts

@@ -0,0 +1,719 @@
+/**
+ * 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 declare const TYPE_URI: "https://trusttasks.org/spec/messaging/monitor/subscribe/0.1";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = MessagingSubscribeToTrafficMonitorPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/messaging/monitor/subscribe/0.1#response";
+/** 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/messaging/monitor/subscribe/0.1";
+    readonly title: "Messaging — Subscribe to Traffic Monitor — payload";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly filter: {
+            readonly $ref: "#/$defs/MonitorFilter";
+        };
+        readonly leaseSeconds: {
+            readonly type: "integer";
+            readonly minimum: 10;
+            readonly maximum: 3600;
+            readonly description: "How long the subscription lives unless renewed. Default 300.";
+        };
+        readonly maxEventsPerSecond: {
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly maximum: 1000;
+            readonly description: "Rate ceiling the subscriber can absorb; the mediator MAY apply a lower one. Events over the ceiling are counted as dropped, never queued.";
+        };
+        readonly subscriptionId: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "Renew or re-filter an existing subscription held by the same requester. Omitted = create a new one.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+            readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Messaging — Subscribe to Traffic Monitor — response payload";
+            readonly 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.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly subscriptionId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly expiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly filter: {
+                    readonly $ref: "#/$defs/MonitorFilter";
+                    readonly description: "The filter in force, after the mediator narrowed it to what the requester is entitled to see.";
+                };
+                readonly maxEventsPerSecond: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly description: "The rate ceiling in force.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                    readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+                };
+            };
+            readonly required: readonly ["subscriptionId", "expiresAt", "filter", "maxEventsPerSecond"];
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly MonitorFilter: {
+            readonly title: "MonitorFilter";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly 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.";
+            readonly properties: {
+                readonly dids: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 100;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/Vid";
+                    };
+                    readonly description: "Only events whose `from` or `to` is one of these accounts.";
+                };
+                readonly directions: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/TrafficDirection";
+                    };
+                };
+                readonly stages: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/TrafficStage";
+                    };
+                };
+                readonly protocols: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/WireProtocol";
+                    };
+                };
+                readonly channels: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/TrafficChannel";
+                    };
+                };
+                readonly messageTypePrefixes: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 20;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 512;
+                    };
+                    readonly description: "Only events whose `messageType` starts with one of these strings. Events with no `messageType` never match when this member is present.";
+                };
+                readonly failuresOnly: {
+                    readonly type: "boolean";
+                    readonly description: "Only events that carry an `outcome`.";
+                };
+            };
+        };
+        readonly TrafficChannel: {
+            readonly title: "TrafficChannel";
+            readonly type: "string";
+            readonly enum: readonly ["websocket", "rest", "peerMediator", "internal"];
+            readonly description: "How the traffic reached or left the mediator. `peerMediator` is mediator-to-mediator forwarding.";
+        };
+        readonly WireProtocol: {
+            readonly title: "WireProtocol";
+            readonly type: "string";
+            readonly enum: readonly ["didcomm", "didcommV1", "tsp", "other"];
+            readonly 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.";
+        };
+        readonly TrafficStage: {
+            readonly title: "TrafficStage";
+            readonly type: "string";
+            readonly enum: readonly ["received", "stored", "delivered", "forwarded", "refused", "deleted", "expired", "purged"];
+            readonly 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.";
+        };
+        readonly TrafficDirection: {
+            readonly title: "TrafficDirection";
+            readonly type: "string";
+            readonly enum: readonly ["inbound", "outbound", "internal"];
+            readonly 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).";
+        };
+        readonly Vid: {
+            readonly title: "Vid";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly 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 {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Messaging — Subscribe to Traffic Monitor — response payload";
+            readonly 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.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly subscriptionId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly expiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly filter: {
+                    readonly $ref: "#/$defs/MonitorFilter";
+                    readonly description: "The filter in force, after the mediator narrowed it to what the requester is entitled to see.";
+                };
+                readonly maxEventsPerSecond: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly description: "The rate ceiling in force.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                    readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+                };
+            };
+            readonly required: readonly ["subscriptionId", "expiresAt", "filter", "maxEventsPerSecond"];
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly MonitorFilter: {
+            readonly title: "MonitorFilter";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly 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.";
+            readonly properties: {
+                readonly dids: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 100;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/Vid";
+                    };
+                    readonly description: "Only events whose `from` or `to` is one of these accounts.";
+                };
+                readonly directions: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/TrafficDirection";
+                    };
+                };
+                readonly stages: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/TrafficStage";
+                    };
+                };
+                readonly protocols: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/WireProtocol";
+                    };
+                };
+                readonly channels: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/TrafficChannel";
+                    };
+                };
+                readonly messageTypePrefixes: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 20;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 512;
+                    };
+                    readonly description: "Only events whose `messageType` starts with one of these strings. Events with no `messageType` never match when this member is present.";
+                };
+                readonly failuresOnly: {
+                    readonly type: "boolean";
+                    readonly description: "Only events that carry an `outcome`.";
+                };
+            };
+        };
+        readonly TrafficChannel: {
+            readonly title: "TrafficChannel";
+            readonly type: "string";
+            readonly enum: readonly ["websocket", "rest", "peerMediator", "internal"];
+            readonly description: "How the traffic reached or left the mediator. `peerMediator` is mediator-to-mediator forwarding.";
+        };
+        readonly WireProtocol: {
+            readonly title: "WireProtocol";
+            readonly type: "string";
+            readonly enum: readonly ["didcomm", "didcommV1", "tsp", "other"];
+            readonly 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.";
+        };
+        readonly TrafficStage: {
+            readonly title: "TrafficStage";
+            readonly type: "string";
+            readonly enum: readonly ["received", "stored", "delivered", "forwarded", "refused", "deleted", "expired", "purged"];
+            readonly 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.";
+        };
+        readonly TrafficDirection: {
+            readonly title: "TrafficDirection";
+            readonly type: "string";
+            readonly enum: readonly ["inbound", "outbound", "internal"];
+            readonly 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).";
+        };
+        readonly Vid: {
+            readonly title: "Vid";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly 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.";
+        };
+    };
+};
+/**
+ * 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/messaging/monitor/subscribe/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/messaging/monitor/subscribe/0.1";
+        readonly title: "Messaging — Subscribe to Traffic Monitor — payload";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly properties: {
+            readonly filter: {
+                readonly $ref: "#/$defs/MonitorFilter";
+            };
+            readonly leaseSeconds: {
+                readonly type: "integer";
+                readonly minimum: 10;
+                readonly maximum: 3600;
+                readonly description: "How long the subscription lives unless renewed. Default 300.";
+            };
+            readonly maxEventsPerSecond: {
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly maximum: 1000;
+                readonly description: "Rate ceiling the subscriber can absorb; the mediator MAY apply a lower one. Events over the ceiling are counted as dropped, never queued.";
+            };
+            readonly subscriptionId: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "Renew or re-filter an existing subscription held by the same requester. Omitted = create a new one.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+                readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Messaging — Subscribe to Traffic Monitor — response payload";
+                readonly 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.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly subscriptionId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly expiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly filter: {
+                        readonly $ref: "#/$defs/MonitorFilter";
+                        readonly description: "The filter in force, after the mediator narrowed it to what the requester is entitled to see.";
+                    };
+                    readonly maxEventsPerSecond: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "The rate ceiling in force.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                        readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+                    };
+                };
+                readonly required: readonly ["subscriptionId", "expiresAt", "filter", "maxEventsPerSecond"];
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly MonitorFilter: {
+                readonly title: "MonitorFilter";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly 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.";
+                readonly properties: {
+                    readonly dids: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly maxItems: 100;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/Vid";
+                        };
+                        readonly description: "Only events whose `from` or `to` is one of these accounts.";
+                    };
+                    readonly directions: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/TrafficDirection";
+                        };
+                    };
+                    readonly stages: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/TrafficStage";
+                        };
+                    };
+                    readonly protocols: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/WireProtocol";
+                        };
+                    };
+                    readonly channels: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/TrafficChannel";
+                        };
+                    };
+                    readonly messageTypePrefixes: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly maxItems: 20;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                            readonly maxLength: 512;
+                        };
+                        readonly description: "Only events whose `messageType` starts with one of these strings. Events with no `messageType` never match when this member is present.";
+                    };
+                    readonly failuresOnly: {
+                        readonly type: "boolean";
+                        readonly description: "Only events that carry an `outcome`.";
+                    };
+                };
+            };
+            readonly TrafficChannel: {
+                readonly title: "TrafficChannel";
+                readonly type: "string";
+                readonly enum: readonly ["websocket", "rest", "peerMediator", "internal"];
+                readonly description: "How the traffic reached or left the mediator. `peerMediator` is mediator-to-mediator forwarding.";
+            };
+            readonly WireProtocol: {
+                readonly title: "WireProtocol";
+                readonly type: "string";
+                readonly enum: readonly ["didcomm", "didcommV1", "tsp", "other"];
+                readonly 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.";
+            };
+            readonly TrafficStage: {
+                readonly title: "TrafficStage";
+                readonly type: "string";
+                readonly enum: readonly ["received", "stored", "delivered", "forwarded", "refused", "deleted", "expired", "purged"];
+                readonly 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.";
+            };
+            readonly TrafficDirection: {
+                readonly title: "TrafficDirection";
+                readonly type: "string";
+                readonly enum: readonly ["inbound", "outbound", "internal"];
+                readonly 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).";
+            };
+            readonly Vid: {
+                readonly title: "Vid";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly 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.";
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/messaging/monitor/subscribe/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Messaging — Subscribe to Traffic Monitor — response payload";
+                readonly 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.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly subscriptionId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly expiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly filter: {
+                        readonly $ref: "#/$defs/MonitorFilter";
+                        readonly description: "The filter in force, after the mediator narrowed it to what the requester is entitled to see.";
+                    };
+                    readonly maxEventsPerSecond: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly description: "The rate ceiling in force.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                        readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+                    };
+                };
+                readonly required: readonly ["subscriptionId", "expiresAt", "filter", "maxEventsPerSecond"];
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly MonitorFilter: {
+                readonly title: "MonitorFilter";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly 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.";
+                readonly properties: {
+                    readonly dids: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly maxItems: 100;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/Vid";
+                        };
+                        readonly description: "Only events whose `from` or `to` is one of these accounts.";
+                    };
+                    readonly directions: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/TrafficDirection";
+                        };
+                    };
+                    readonly stages: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/TrafficStage";
+                        };
+                    };
+                    readonly protocols: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/WireProtocol";
+                        };
+                    };
+                    readonly channels: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/TrafficChannel";
+                        };
+                    };
+                    readonly messageTypePrefixes: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly maxItems: 20;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                            readonly maxLength: 512;
+                        };
+                        readonly description: "Only events whose `messageType` starts with one of these strings. Events with no `messageType` never match when this member is present.";
+                    };
+                    readonly failuresOnly: {
+                        readonly type: "boolean";
+                        readonly description: "Only events that carry an `outcome`.";
+                    };
+                };
+            };
+            readonly TrafficChannel: {
+                readonly title: "TrafficChannel";
+                readonly type: "string";
+                readonly enum: readonly ["websocket", "rest", "peerMediator", "internal"];
+                readonly description: "How the traffic reached or left the mediator. `peerMediator` is mediator-to-mediator forwarding.";
+            };
+            readonly WireProtocol: {
+                readonly title: "WireProtocol";
+                readonly type: "string";
+                readonly enum: readonly ["didcomm", "didcommV1", "tsp", "other"];
+                readonly 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.";
+            };
+            readonly TrafficStage: {
+                readonly title: "TrafficStage";
+                readonly type: "string";
+                readonly enum: readonly ["received", "stored", "delivered", "forwarded", "refused", "deleted", "expired", "purged"];
+                readonly 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.";
+            };
+            readonly TrafficDirection: {
+                readonly title: "TrafficDirection";
+                readonly type: "string";
+                readonly enum: readonly ["inbound", "outbound", "internal"];
+                readonly 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).";
+            };
+            readonly Vid: {
+                readonly title: "Vid";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly 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.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map