@openvtc/trust-tasks 0.19.15 → 0.19.17

package/src/messaging/queue/status/0.1/payload.ts

@@ -0,0 +1,439 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/queue/status/0.1/payload.schema.json
+ */
+
+import type { AccountType, Ext, PeerDepth, QueueDepth, QueueSummary, Vid } from "../../../../_shared/components.js";
+
+
+export interface MessagingShowQueueStatusPayload {
+  /**
+   * The account whose queues to report. Omitted = the requester's own account. A requester without administrative standing may name only itself.
+   */
+  did?: Vid;
+  /**
+   * Also return the top N counterparties of each queue by message count. Omitted = no per-peer breakdown.
+   */
+  includePeers?: number;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * The success response to a messaging/queue/status request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/queue/status/0.1#response.
+ */
+export interface MessagingShowQueueStatusResponsePayload {
+  queues: QueueSummary;
+  /**
+   * Top senders into the receive queue. Present only when includePeers was requested.
+   */
+  receivePeers?: PeerDepth[];
+  /**
+   * Top recipients holding the send queue. Present only when includePeers was requested.
+   */
+  sendPeers?: PeerDepth[];
+  /**
+   * 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 { AccountType, Ext, PeerDepth, QueueDepth, QueueSummary, Vid };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/queue/status/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = MessagingShowQueueStatusPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/queue/status/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = MessagingShowQueueStatusResponsePayload;
+
+/**
+ * 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/queue/status/0.1",
+  "title": "Messaging — Show Queue Status — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "did": {
+      "$ref": "#/$defs/Vid",
+      "description": "The account whose queues to report. Omitted = the requester's own account. A requester without administrative standing may name only itself."
+    },
+    "includePeers": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 100,
+      "description": "Also return the top N counterparties of each queue by message count. Omitted = no per-peer breakdown."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Messaging — Show Queue Status — response payload",
+      "description": "The success response to a messaging/queue/status request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/queue/status/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "queues": {
+          "$ref": "#/$defs/QueueSummary"
+        },
+        "receivePeers": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/PeerDepth"
+          },
+          "description": "Top senders into the receive queue. Present only when includePeers was requested."
+        },
+        "sendPeers": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/PeerDepth"
+          },
+          "description": "Top recipients holding the send queue. Present only when includePeers was requested."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      },
+      "required": [
+        "queues"
+      ]
+    },
+    "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-]+)+$"
+      }
+    },
+    "PeerDepth": {
+      "title": "PeerDepth",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "peer",
+        "count",
+        "bytes"
+      ],
+      "description": "The share of one queue attributable to one counterparty: in a send queue, the recipient; in a receive queue, the sender.",
+      "properties": {
+        "peer": {
+          "$ref": "#/$defs/Vid",
+          "description": "The counterparty's identifier, in the same form the mediator uses for accounts."
+        },
+        "count": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "oldestAgeSeconds": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "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."
+    },
+    "QueueSummary": {
+      "title": "QueueSummary",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "receive",
+        "send"
+      ],
+      "description": "Both queues of one account.",
+      "properties": {
+        "did": {
+          "$ref": "#/$defs/Vid"
+        },
+        "accountType": {
+          "$ref": "#/$defs/AccountType"
+        },
+        "receive": {
+          "$ref": "#/$defs/QueueDepth"
+        },
+        "send": {
+          "$ref": "#/$defs/QueueDepth"
+        }
+      }
+    },
+    "QueueDepth": {
+      "title": "QueueDepth",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "count",
+        "bytes"
+      ],
+      "description": "The depth of one queue and its effective limit.",
+      "properties": {
+        "count": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages currently in the queue."
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total stored size of those messages, in bytes."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": -1,
+          "description": "The effective message-count limit for this queue after account overrides and mediator defaults are applied; -1 = unlimited."
+        },
+        "saturation": {
+          "type": "number",
+          "minimum": 0,
+          "description": "count ÷ limit. Absent when the limit is unlimited. May exceed 1 when a limit was lowered below the current depth."
+        },
+        "oldestAgeSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Age of the oldest message in the queue, in seconds. Absent when the queue is empty or the mediator did not measure it."
+        },
+        "deliveredUnacked": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages in the queue whose state is `delivered` — handed out but not yet deleted by the recipient. Absent when the mediator did not measure it."
+        }
+      }
+    },
+    "AccountType": {
+      "title": "AccountType",
+      "type": "string",
+      "enum": [
+        "standard",
+        "admin",
+        "rootAdmin",
+        "mediator"
+      ],
+      "description": "The account's role at the mediator. `standard` is an ordinary served account; `admin`/`rootAdmin` may administer other accounts; `mediator` is the mediator's own account. Only a rootAdmin may assign or modify the rootAdmin role."
+    }
+  }
+} 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 — Show Queue Status — response payload",
+      "description": "The success response to a messaging/queue/status request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/queue/status/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "queues": {
+          "$ref": "#/$defs/QueueSummary"
+        },
+        "receivePeers": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/PeerDepth"
+          },
+          "description": "Top senders into the receive queue. Present only when includePeers was requested."
+        },
+        "sendPeers": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/PeerDepth"
+          },
+          "description": "Top recipients holding the send queue. Present only when includePeers was requested."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      },
+      "required": [
+        "queues"
+      ]
+    },
+    "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-]+)+$"
+      }
+    },
+    "PeerDepth": {
+      "title": "PeerDepth",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "peer",
+        "count",
+        "bytes"
+      ],
+      "description": "The share of one queue attributable to one counterparty: in a send queue, the recipient; in a receive queue, the sender.",
+      "properties": {
+        "peer": {
+          "$ref": "#/$defs/Vid",
+          "description": "The counterparty's identifier, in the same form the mediator uses for accounts."
+        },
+        "count": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "oldestAgeSeconds": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "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."
+    },
+    "QueueSummary": {
+      "title": "QueueSummary",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "receive",
+        "send"
+      ],
+      "description": "Both queues of one account.",
+      "properties": {
+        "did": {
+          "$ref": "#/$defs/Vid"
+        },
+        "accountType": {
+          "$ref": "#/$defs/AccountType"
+        },
+        "receive": {
+          "$ref": "#/$defs/QueueDepth"
+        },
+        "send": {
+          "$ref": "#/$defs/QueueDepth"
+        }
+      }
+    },
+    "QueueDepth": {
+      "title": "QueueDepth",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "count",
+        "bytes"
+      ],
+      "description": "The depth of one queue and its effective limit.",
+      "properties": {
+        "count": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages currently in the queue."
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total stored size of those messages, in bytes."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": -1,
+          "description": "The effective message-count limit for this queue after account overrides and mediator defaults are applied; -1 = unlimited."
+        },
+        "saturation": {
+          "type": "number",
+          "minimum": 0,
+          "description": "count ÷ limit. Absent when the limit is unlimited. May exceed 1 when a limit was lowered below the current depth."
+        },
+        "oldestAgeSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Age of the oldest message in the queue, in seconds. Absent when the queue is empty or the mediator did not measure it."
+        },
+        "deliveredUnacked": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Messages in the queue whose state is `delivered` — handed out but not yet deleted by the recipient. Absent when the mediator did not measure it."
+        }
+      }
+    },
+    "AccountType": {
+      "title": "AccountType",
+      "type": "string",
+      "enum": [
+        "standard",
+        "admin",
+        "rootAdmin",
+        "mediator"
+      ],
+      "description": "The account's role at the mediator. `standard` is an ordinary served account; `admin`/`rootAdmin` may administer other accounts; `mediator` is the mediator's own account. Only a rootAdmin may assign or modify the rootAdmin role."
+    }
+  }
+} 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;