@openvtc/trust-tasks 0.19.15 → 0.19.17

package/src/messaging/message/list/0.1/payload.ts

@@ -0,0 +1,410 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/message/list/0.1/payload.schema.json
+ */
+
+import type { DeliveryState, Ext, MessageMeta, Queue, Vid, WireProtocol } from "../../../../_shared/components.js";
+
+
+export interface MessagingListMessagesPayload {
+  /**
+   * The account whose queue to list. Omitted = the requester's own account. A requester without administrative standing may name only itself.
+   */
+  did?: Vid;
+  queue: Queue;
+  /**
+   * Only messages exchanged with this counterparty.
+   */
+  peer?: Vid;
+  /**
+   * Opaque continuation token from a prior page's nextCursor. Echoed verbatim; treated as unstructured by the requester.
+   */
+  cursor?: string;
+  /**
+   * Maximum messages per page. The mediator chooses a default when omitted.
+   */
+  limit?: number;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * The success response to a messaging/message/list request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/message/list/0.1#response.
+ */
+export interface MessagingListMessagesResponsePayload {
+  /**
+   * The page, oldest first.
+   */
+  messages: MessageMeta[];
+  /**
+   * Opaque continuation token. Present only when further items remain beyond this page; omitted on the final page.
+   */
+  nextCursor?: string;
+  /**
+   * 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 { DeliveryState, Ext, MessageMeta, Queue, Vid, WireProtocol };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/message/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = MessagingListMessagesPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/message/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = MessagingListMessagesResponsePayload;
+
+/**
+ * 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/message/list/0.1",
+  "title": "Messaging — List Messages — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "queue"
+  ],
+  "properties": {
+    "did": {
+      "$ref": "#/$defs/Vid",
+      "description": "The account whose queue to list. Omitted = the requester's own account. A requester without administrative standing may name only itself."
+    },
+    "queue": {
+      "$ref": "#/$defs/Queue"
+    },
+    "peer": {
+      "$ref": "#/$defs/Vid",
+      "description": "Only messages exchanged with this counterparty."
+    },
+    "cursor": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Opaque continuation token from a prior page's nextCursor. Echoed verbatim; treated as unstructured by the requester."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 500,
+      "description": "Maximum messages per page. The mediator chooses a default when omitted."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Messaging — List Messages — response payload",
+      "description": "The success response to a messaging/message/list request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/message/list/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "messages": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/MessageMeta"
+          },
+          "description": "The page, oldest first."
+        },
+        "nextCursor": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Opaque continuation token. Present only when further items remain beyond this page; omitted on the final page."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      },
+      "required": [
+        "messages"
+      ]
+    },
+    "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-]+)+$"
+      }
+    },
+    "MessageMeta": {
+      "title": "MessageMeta",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "msgId",
+        "queue",
+        "size",
+        "receivedAt"
+      ],
+      "description": "Metadata of one stored message. Never carries the message body.",
+      "properties": {
+        "msgId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The mediator's identifier for the stored message; the handle messaging/message/get and messaging/message/delete accept.",
+          "maxLength": 256
+        },
+        "queue": {
+          "$ref": "#/$defs/Queue"
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Stored size in bytes."
+        },
+        "receivedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the mediator stored the message."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the mediator will expire the message if it is not deleted first."
+        },
+        "from": {
+          "$ref": "#/$defs/Vid",
+          "description": "The sender, where the mediator knows it. Absent for anonymous messages."
+        },
+        "to": {
+          "$ref": "#/$defs/Vid",
+          "description": "The recipient account."
+        },
+        "protocol": {
+          "$ref": "#/$defs/WireProtocol"
+        },
+        "deliveryState": {
+          "$ref": "#/$defs/DeliveryState"
+        },
+        "deliveredAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the message was first handed to the recipient. Present only when deliveryState is `delivered`."
+        }
+      }
+    },
+    "DeliveryState": {
+      "title": "DeliveryState",
+      "type": "string",
+      "enum": [
+        "queued",
+        "delivered"
+      ],
+      "description": "`queued`: stored and not yet handed to the recipient. `delivered`: handed to the recipient (pickup or live stream) but not yet deleted by it — the recipient has not acknowledged it."
+    },
+    "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."
+    },
+    "Queue": {
+      "title": "Queue",
+      "type": "string",
+      "enum": [
+        "receive",
+        "send"
+      ],
+      "description": "Which of an account's two queues. `receive` holds messages addressed to the account awaiting its pickup. `send` holds messages the account sent that are still held against it until their recipient deletes them — so a stalled recipient fills its senders' send queues."
+    },
+    "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 — List Messages — response payload",
+      "description": "The success response to a messaging/message/list request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/message/list/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "messages": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/MessageMeta"
+          },
+          "description": "The page, oldest first."
+        },
+        "nextCursor": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Opaque continuation token. Present only when further items remain beyond this page; omitted on the final page."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      },
+      "required": [
+        "messages"
+      ]
+    },
+    "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-]+)+$"
+      }
+    },
+    "MessageMeta": {
+      "title": "MessageMeta",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "msgId",
+        "queue",
+        "size",
+        "receivedAt"
+      ],
+      "description": "Metadata of one stored message. Never carries the message body.",
+      "properties": {
+        "msgId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The mediator's identifier for the stored message; the handle messaging/message/get and messaging/message/delete accept.",
+          "maxLength": 256
+        },
+        "queue": {
+          "$ref": "#/$defs/Queue"
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Stored size in bytes."
+        },
+        "receivedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the mediator stored the message."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the mediator will expire the message if it is not deleted first."
+        },
+        "from": {
+          "$ref": "#/$defs/Vid",
+          "description": "The sender, where the mediator knows it. Absent for anonymous messages."
+        },
+        "to": {
+          "$ref": "#/$defs/Vid",
+          "description": "The recipient account."
+        },
+        "protocol": {
+          "$ref": "#/$defs/WireProtocol"
+        },
+        "deliveryState": {
+          "$ref": "#/$defs/DeliveryState"
+        },
+        "deliveredAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the message was first handed to the recipient. Present only when deliveryState is `delivered`."
+        }
+      }
+    },
+    "DeliveryState": {
+      "title": "DeliveryState",
+      "type": "string",
+      "enum": [
+        "queued",
+        "delivered"
+      ],
+      "description": "`queued`: stored and not yet handed to the recipient. `delivered`: handed to the recipient (pickup or live stream) but not yet deleted by it — the recipient has not acknowledged it."
+    },
+    "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."
+    },
+    "Queue": {
+      "title": "Queue",
+      "type": "string",
+      "enum": [
+        "receive",
+        "send"
+      ],
+      "description": "Which of an account's two queues. `receive` holds messages addressed to the account awaiting its pickup. `send` holds messages the account sent that are still held against it until their recipient deletes them — so a stalled recipient fills its senders' send queues."
+    },
+    "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/event/0.1/payload.ts

@@ -0,0 +1,267 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/monitor/event/0.1/payload.schema.json
+ */
+
+import type { Ext, MonitorEvent, TrafficChannel, TrafficDirection, TrafficOutcome, TrafficStage, Vid, WireProtocol } from "../../../../_shared/components.js";
+
+
+export interface MessagingTrafficMonitorEventPayload {
+  subscriptionId: string;
+  /**
+   * Batch sequence number, starting at 1 and increasing by exactly 1 per batch within a subscription. A gap means batches were lost in transit.
+   */
+  seq: number;
+  /**
+   * Events in the order the mediator observed them. May be empty on a heartbeat batch.
+   *
+   * @maxItems 500
+   */
+  events: MonitorEvent[];
+  /**
+   * Events that matched the filter but were discarded since the previous batch — rate ceiling exceeded or subscriber not connected.
+   */
+  dropped: number;
+  /**
+   * The subscription's current expiry, so the subscriber can renew before it lapses.
+   */
+  expiresAt: string;
+  /**
+   * 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, MonitorEvent, TrafficChannel, TrafficDirection, TrafficOutcome, TrafficStage, Vid, WireProtocol };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/monitor/event/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = MessagingTrafficMonitorEventPayload;
+
+/**
+ * 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/event/0.1",
+  "title": "Messaging — Traffic Monitor Event — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "subscriptionId",
+    "seq",
+    "events",
+    "dropped",
+    "expiresAt"
+  ],
+  "properties": {
+    "subscriptionId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "seq": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Batch sequence number, starting at 1 and increasing by exactly 1 per batch within a subscription. A gap means batches were lost in transit."
+    },
+    "events": {
+      "type": "array",
+      "maxItems": 500,
+      "items": {
+        "$ref": "#/$defs/MonitorEvent"
+      },
+      "description": "Events in the order the mediator observed them. May be empty on a heartbeat batch."
+    },
+    "dropped": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Events that matched the filter but were discarded since the previous batch — rate ceiling exceeded or subscriber not connected."
+    },
+    "expiresAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The subscription's current expiry, so the subscriber can renew before it lapses."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "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-]+)+$"
+      }
+    },
+    "MonitorEvent": {
+      "title": "MonitorEvent",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "at",
+        "direction",
+        "stage",
+        "channel",
+        "protocol"
+      ],
+      "description": "One observed step in the life of one message at the mediator. Carries metadata only — never a message body.",
+      "properties": {
+        "at": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the step happened, with sub-second precision where the mediator has it."
+        },
+        "direction": {
+          "$ref": "#/$defs/TrafficDirection"
+        },
+        "stage": {
+          "$ref": "#/$defs/TrafficStage"
+        },
+        "channel": {
+          "$ref": "#/$defs/TrafficChannel"
+        },
+        "protocol": {
+          "$ref": "#/$defs/WireProtocol"
+        },
+        "msgId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The stored message's identifier, once it has one; correlates the events of one message and matches MessageMeta.msgId.",
+          "maxLength": 256
+        },
+        "from": {
+          "$ref": "#/$defs/Vid",
+          "description": "The sender, where the mediator knows it."
+        },
+        "to": {
+          "$ref": "#/$defs/Vid",
+          "description": "The recipient, where the mediator knows it."
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Frame size in bytes."
+        },
+        "messageType": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The plaintext message type, present only when the mediator itself was the addressee and read it (a routing forward, a pickup request, a trust-task type URI, a trust ping). Absent for end-to-end-encrypted traffic the mediator only relays.",
+          "maxLength": 512
+        },
+        "outcome": {
+          "$ref": "#/$defs/TrafficOutcome",
+          "description": "Present when stage is `refused`, and on any other stage that failed."
+        },
+        "latencyMs": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "For `delivered` and `forwarded`: milliseconds since the message was stored."
+        }
+      }
+    },
+    "TrafficOutcome": {
+      "title": "TrafficOutcome",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "code"
+      ],
+      "description": "Why a frame was refused or failed.",
+      "properties": {
+        "code": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The stable error code the mediator returned to the sender (a trust-task-error or problem-report code).",
+          "maxLength": 256
+        },
+        "detail": {
+          "type": "string",
+          "description": "Short human-readable explanation. Not machine-parsed.",
+          "maxLength": 1024
+        }
+      }
+    },
+    "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."
+    },
+    "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."
+    },
+    "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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;