@openvtc/trust-tasks 0.19.14 → 0.19.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/dist/_shared/components.d.ts +331 -0
  3. package/dist/_shared/components.d.ts.map +1 -1
  4. package/dist/index.d.ts +11 -0
  5. package/dist/index.d.ts.map +1 -1
  6. package/dist/index.js +11 -0
  7. package/dist/index.js.map +1 -1
  8. package/dist/messaging/_shared/0.1/mediator-ops.d.ts +16 -0
  9. package/dist/messaging/_shared/0.1/mediator-ops.d.ts.map +1 -0
  10. package/dist/messaging/_shared/0.1/mediator-ops.js +6 -0
  11. package/dist/messaging/_shared/0.1/mediator-ops.js.map +1 -0
  12. package/dist/messaging/message/delete/0.1/payload.d.ts +370 -0
  13. package/dist/messaging/message/delete/0.1/payload.d.ts.map +1 -0
  14. package/dist/messaging/message/delete/0.1/payload.js +206 -0
  15. package/dist/messaging/message/delete/0.1/payload.js.map +1 -0
  16. package/dist/messaging/message/get/0.1/payload.d.ts +568 -0
  17. package/dist/messaging/message/get/0.1/payload.d.ts.map +1 -0
  18. package/dist/messaging/message/get/0.1/payload.js +332 -0
  19. package/dist/messaging/message/get/0.1/payload.js.map +1 -0
  20. package/dist/messaging/message/list/0.1/payload.d.ts +627 -0
  21. package/dist/messaging/message/list/0.1/payload.d.ts.map +1 -0
  22. package/dist/messaging/message/list/0.1/payload.js +352 -0
  23. package/dist/messaging/message/list/0.1/payload.js.map +1 -0
  24. package/dist/messaging/monitor/event/0.1/payload.d.ts +385 -0
  25. package/dist/messaging/monitor/event/0.1/payload.d.ts.map +1 -0
  26. package/dist/messaging/monitor/event/0.1/payload.js +230 -0
  27. package/dist/messaging/monitor/event/0.1/payload.js.map +1 -0
  28. package/dist/messaging/monitor/subscribe/0.1/payload.d.ts +719 -0
  29. package/dist/messaging/monitor/subscribe/0.1/payload.d.ts.map +1 -0
  30. package/dist/messaging/monitor/subscribe/0.1/payload.js +417 -0
  31. package/dist/messaging/monitor/subscribe/0.1/payload.js.map +1 -0
  32. package/dist/messaging/monitor/unsubscribe/0.1/payload.d.ts +245 -0
  33. package/dist/messaging/monitor/unsubscribe/0.1/payload.d.ts.map +1 -0
  34. package/dist/messaging/monitor/unsubscribe/0.1/payload.js +136 -0
  35. package/dist/messaging/monitor/unsubscribe/0.1/payload.js.map +1 -0
  36. package/dist/messaging/queue/list/0.1/payload.d.ts +679 -0
  37. package/dist/messaging/queue/list/0.1/payload.d.ts.map +1 -0
  38. package/dist/messaging/queue/list/0.1/payload.js +377 -0
  39. package/dist/messaging/queue/list/0.1/payload.js.map +1 -0
  40. package/dist/messaging/queue/purge/0.1/payload.d.ts +389 -0
  41. package/dist/messaging/queue/purge/0.1/payload.d.ts.map +1 -0
  42. package/dist/messaging/queue/purge/0.1/payload.js +210 -0
  43. package/dist/messaging/queue/purge/0.1/payload.js.map +1 -0
  44. package/dist/messaging/queue/status/0.1/payload.d.ts +697 -0
  45. package/dist/messaging/queue/status/0.1/payload.d.ts.map +1 -0
  46. package/dist/messaging/queue/status/0.1/payload.js +389 -0
  47. package/dist/messaging/queue/status/0.1/payload.js.map +1 -0
  48. package/dist/messaging/stats/show/0.1/payload.d.ts +963 -0
  49. package/dist/messaging/stats/show/0.1/payload.d.ts.map +1 -0
  50. package/dist/messaging/stats/show/0.1/payload.js +515 -0
  51. package/dist/messaging/stats/show/0.1/payload.js.map +1 -0
  52. package/dist/vtc/join-requests/list/0.1/payload.d.ts +88 -0
  53. package/dist/vtc/join-requests/list/0.1/payload.d.ts.map +1 -1
  54. package/dist/vtc/join-requests/list/0.1/payload.js +50 -0
  55. package/dist/vtc/join-requests/list/0.1/payload.js.map +1 -1
  56. package/dist/vtc/join-requests/manifest/0.2/payload.d.ts +135 -0
  57. package/dist/vtc/join-requests/manifest/0.2/payload.d.ts.map +1 -1
  58. package/dist/vtc/join-requests/manifest/0.2/payload.js +62 -0
  59. package/dist/vtc/join-requests/manifest/0.2/payload.js.map +1 -1
  60. package/dist/vtc/join-requests/show/0.1/payload.d.ts +88 -0
  61. package/dist/vtc/join-requests/show/0.1/payload.d.ts.map +1 -1
  62. package/dist/vtc/join-requests/show/0.1/payload.js +50 -0
  63. package/dist/vtc/join-requests/show/0.1/payload.js.map +1 -1
  64. package/dist/vtc/join-requests/submit/0.2/payload.d.ts +61 -0
  65. package/dist/vtc/join-requests/submit/0.2/payload.d.ts.map +1 -1
  66. package/dist/vtc/join-requests/submit/0.2/payload.js +25 -0
  67. package/dist/vtc/join-requests/submit/0.2/payload.js.map +1 -1
  68. package/package.json +1 -1
  69. package/src/_shared/components.ts +359 -0
  70. package/src/index.ts +11 -0
  71. package/src/messaging/_shared/0.1/mediator-ops.ts +17 -0
  72. package/src/messaging/message/delete/0.1/payload.ts +259 -0
  73. package/src/messaging/message/get/0.1/payload.ts +375 -0
  74. package/src/messaging/message/list/0.1/payload.ts +410 -0
  75. package/src/messaging/monitor/event/0.1/payload.ts +267 -0
  76. package/src/messaging/monitor/subscribe/0.1/payload.ts +473 -0
  77. package/src/messaging/monitor/unsubscribe/0.1/payload.ts +172 -0
  78. package/src/messaging/queue/list/0.1/payload.ts +443 -0
  79. package/src/messaging/queue/purge/0.1/payload.ts +270 -0
  80. package/src/messaging/queue/status/0.1/payload.ts +439 -0
  81. package/src/messaging/stats/show/0.1/payload.ts +611 -0
  82. package/src/vtc/join-requests/list/0.1/payload.ts +50 -0
  83. package/src/vtc/join-requests/manifest/0.2/payload.ts +81 -0
  84. package/src/vtc/join-requests/show/0.1/payload.ts +50 -0
  85. package/src/vtc/join-requests/submit/0.2/payload.ts +42 -0
@@ -0,0 +1,963 @@
1
+ /**
2
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
3
+ * Source: specs/messaging/stats/show/0.1/payload.schema.json
4
+ */
5
+ import type { Ext, QueueDepth } from "../../../../_shared/components.js";
6
+ export interface MessagingShowMediatorStatisticsPayload {
7
+ /**
8
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
9
+ */
10
+ ext?: Ext;
11
+ }
12
+ /**
13
+ * The success response to a messaging/stats/show request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/stats/show/0.1#response.
14
+ */
15
+ export interface MessagingShowMediatorStatisticsResponsePayload {
16
+ /**
17
+ * The mediator software's version string.
18
+ */
19
+ version: string;
20
+ startedAt?: string;
21
+ uptimeSeconds: number;
22
+ connections: {
23
+ websocketActive: number;
24
+ /**
25
+ * Configured ceiling; absent when unlimited.
26
+ */
27
+ websocketMax?: number;
28
+ };
29
+ /**
30
+ * Lifetime counters since the mediator's store was created. Monotonic; a client derives rates from successive readings.
31
+ */
32
+ totals: {
33
+ receivedCount: number;
34
+ receivedBytes: number;
35
+ sentCount: number;
36
+ sentBytes: number;
37
+ deletedCount: number;
38
+ deletedBytes?: number;
39
+ websocketOpened?: number;
40
+ websocketClosed?: number;
41
+ sessionsCreated?: number;
42
+ sessionsAuthenticated?: number;
43
+ invitationsCreated?: number;
44
+ invitationsClaimed?: number;
45
+ };
46
+ forwarding: {
47
+ /**
48
+ * Messages waiting to be forwarded to other mediators.
49
+ */
50
+ queueLength: number;
51
+ queueLimit?: number;
52
+ /**
53
+ * State of the store circuit breaker. `open` means the mediator is shedding store operations.
54
+ */
55
+ circuitBreaker?: "closed" | "open" | "halfOpen";
56
+ };
57
+ /**
58
+ * Aggregate of the mediator's most recent queue survey. Absent when no survey has completed.
59
+ */
60
+ queues?: {
61
+ surveyedAt: string;
62
+ /**
63
+ * Accounts the survey covered.
64
+ */
65
+ accounts: number;
66
+ /**
67
+ * The survey stopped before covering every account.
68
+ */
69
+ truncated?: boolean;
70
+ /**
71
+ * Totals across every surveyed receive queue; `saturation` is the maximum of any single queue.
72
+ */
73
+ receive?: QueueDepth;
74
+ /**
75
+ * Totals across every surveyed send queue; `saturation` is the maximum of any single queue.
76
+ */
77
+ send?: QueueDepth;
78
+ };
79
+ /**
80
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
81
+ */
82
+ ext?: Ext;
83
+ }
84
+ /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
85
+ export type { Ext, QueueDepth };
86
+ /** Trust Task type URI. */
87
+ export declare const TYPE_URI: "https://trusttasks.org/spec/messaging/stats/show/0.1";
88
+ /** Stable alias for this specification's request payload shape. */
89
+ export type Payload = MessagingShowMediatorStatisticsPayload;
90
+ /** Trust Task response type URI (request type URI + "#response"). */
91
+ export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/messaging/stats/show/0.1#response";
92
+ /** Stable alias for this specification's success-response payload shape. */
93
+ export type Response = MessagingShowMediatorStatisticsResponsePayload;
94
+ /**
95
+ * This specification's payload schema, as a value.
96
+ *
97
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
98
+ * rather than only as a `.json` file because TypeScript types are erased
99
+ * at runtime: without a schema a consumer has nothing to validate, and
100
+ * every REQUIRED payload member is optional in practice. Cross-file
101
+ * `$ref`s are already inlined, so it needs no resolver.
102
+ */
103
+ export declare const PAYLOAD_SCHEMA: {
104
+ readonly $schema: "https://json-schema.org/draft/2020-12/schema";
105
+ readonly $id: "https://trusttasks.org/spec/messaging/stats/show/0.1";
106
+ readonly title: "Messaging — Show Mediator Statistics — payload";
107
+ readonly type: "object";
108
+ readonly additionalProperties: false;
109
+ readonly properties: {
110
+ readonly ext: {
111
+ readonly $ref: "#/$defs/Ext";
112
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
113
+ };
114
+ };
115
+ readonly $defs: {
116
+ readonly Response: {
117
+ readonly $anchor: "response";
118
+ readonly title: "Messaging — Show Mediator Statistics — response payload";
119
+ readonly description: "The success response to a messaging/stats/show request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/stats/show/0.1#response.";
120
+ readonly type: "object";
121
+ readonly additionalProperties: false;
122
+ readonly properties: {
123
+ readonly version: {
124
+ readonly type: "string";
125
+ readonly minLength: 1;
126
+ readonly description: "The mediator software's version string.";
127
+ };
128
+ readonly startedAt: {
129
+ readonly type: "string";
130
+ readonly format: "date-time";
131
+ };
132
+ readonly uptimeSeconds: {
133
+ readonly type: "integer";
134
+ readonly minimum: 0;
135
+ };
136
+ readonly connections: {
137
+ readonly type: "object";
138
+ readonly additionalProperties: false;
139
+ readonly required: readonly ["websocketActive"];
140
+ readonly properties: {
141
+ readonly websocketActive: {
142
+ readonly type: "integer";
143
+ readonly minimum: 0;
144
+ };
145
+ readonly websocketMax: {
146
+ readonly type: "integer";
147
+ readonly minimum: 0;
148
+ readonly description: "Configured ceiling; absent when unlimited.";
149
+ };
150
+ };
151
+ };
152
+ readonly totals: {
153
+ readonly type: "object";
154
+ readonly additionalProperties: false;
155
+ readonly description: "Lifetime counters since the mediator's store was created. Monotonic; a client derives rates from successive readings.";
156
+ readonly required: readonly ["receivedCount", "receivedBytes", "sentCount", "sentBytes", "deletedCount"];
157
+ readonly properties: {
158
+ readonly receivedCount: {
159
+ readonly type: "integer";
160
+ readonly minimum: 0;
161
+ };
162
+ readonly receivedBytes: {
163
+ readonly type: "integer";
164
+ readonly minimum: 0;
165
+ };
166
+ readonly sentCount: {
167
+ readonly type: "integer";
168
+ readonly minimum: 0;
169
+ };
170
+ readonly sentBytes: {
171
+ readonly type: "integer";
172
+ readonly minimum: 0;
173
+ };
174
+ readonly deletedCount: {
175
+ readonly type: "integer";
176
+ readonly minimum: 0;
177
+ };
178
+ readonly deletedBytes: {
179
+ readonly type: "integer";
180
+ readonly minimum: 0;
181
+ };
182
+ readonly websocketOpened: {
183
+ readonly type: "integer";
184
+ readonly minimum: 0;
185
+ };
186
+ readonly websocketClosed: {
187
+ readonly type: "integer";
188
+ readonly minimum: 0;
189
+ };
190
+ readonly sessionsCreated: {
191
+ readonly type: "integer";
192
+ readonly minimum: 0;
193
+ };
194
+ readonly sessionsAuthenticated: {
195
+ readonly type: "integer";
196
+ readonly minimum: 0;
197
+ };
198
+ readonly invitationsCreated: {
199
+ readonly type: "integer";
200
+ readonly minimum: 0;
201
+ };
202
+ readonly invitationsClaimed: {
203
+ readonly type: "integer";
204
+ readonly minimum: 0;
205
+ };
206
+ };
207
+ };
208
+ readonly forwarding: {
209
+ readonly type: "object";
210
+ readonly additionalProperties: false;
211
+ readonly required: readonly ["queueLength"];
212
+ readonly properties: {
213
+ readonly queueLength: {
214
+ readonly type: "integer";
215
+ readonly minimum: 0;
216
+ readonly description: "Messages waiting to be forwarded to other mediators.";
217
+ };
218
+ readonly queueLimit: {
219
+ readonly type: "integer";
220
+ readonly minimum: 0;
221
+ };
222
+ readonly circuitBreaker: {
223
+ readonly type: "string";
224
+ readonly enum: readonly ["closed", "open", "halfOpen"];
225
+ readonly description: "State of the store circuit breaker. `open` means the mediator is shedding store operations.";
226
+ };
227
+ };
228
+ };
229
+ readonly queues: {
230
+ readonly type: "object";
231
+ readonly additionalProperties: false;
232
+ readonly description: "Aggregate of the mediator's most recent queue survey. Absent when no survey has completed.";
233
+ readonly required: readonly ["surveyedAt", "accounts"];
234
+ readonly properties: {
235
+ readonly surveyedAt: {
236
+ readonly type: "string";
237
+ readonly format: "date-time";
238
+ };
239
+ readonly accounts: {
240
+ readonly type: "integer";
241
+ readonly minimum: 0;
242
+ readonly description: "Accounts the survey covered.";
243
+ };
244
+ readonly truncated: {
245
+ readonly type: "boolean";
246
+ readonly description: "The survey stopped before covering every account.";
247
+ };
248
+ readonly receive: {
249
+ readonly $ref: "#/$defs/QueueDepth";
250
+ readonly description: "Totals across every surveyed receive queue; `saturation` is the maximum of any single queue.";
251
+ };
252
+ readonly send: {
253
+ readonly $ref: "#/$defs/QueueDepth";
254
+ readonly description: "Totals across every surveyed send queue; `saturation` is the maximum of any single queue.";
255
+ };
256
+ };
257
+ };
258
+ readonly ext: {
259
+ readonly $ref: "#/$defs/Ext";
260
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
261
+ };
262
+ };
263
+ readonly required: readonly ["version", "uptimeSeconds", "connections", "totals", "forwarding"];
264
+ };
265
+ readonly Ext: {
266
+ readonly title: "Ext";
267
+ 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.";
268
+ readonly type: "object";
269
+ readonly minProperties: 1;
270
+ readonly additionalProperties: true;
271
+ readonly propertyNames: {
272
+ readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
273
+ };
274
+ };
275
+ readonly QueueDepth: {
276
+ readonly title: "QueueDepth";
277
+ readonly type: "object";
278
+ readonly additionalProperties: false;
279
+ readonly required: readonly ["count", "bytes"];
280
+ readonly description: "The depth of one queue and its effective limit.";
281
+ readonly properties: {
282
+ readonly count: {
283
+ readonly type: "integer";
284
+ readonly minimum: 0;
285
+ readonly description: "Messages currently in the queue.";
286
+ };
287
+ readonly bytes: {
288
+ readonly type: "integer";
289
+ readonly minimum: 0;
290
+ readonly description: "Total stored size of those messages, in bytes.";
291
+ };
292
+ readonly limit: {
293
+ readonly type: "integer";
294
+ readonly minimum: -1;
295
+ readonly description: "The effective message-count limit for this queue after account overrides and mediator defaults are applied; -1 = unlimited.";
296
+ };
297
+ readonly saturation: {
298
+ readonly type: "number";
299
+ readonly minimum: 0;
300
+ readonly description: "count ÷ limit. Absent when the limit is unlimited. May exceed 1 when a limit was lowered below the current depth.";
301
+ };
302
+ readonly oldestAgeSeconds: {
303
+ readonly type: "integer";
304
+ readonly minimum: 0;
305
+ readonly description: "Age of the oldest message in the queue, in seconds. Absent when the queue is empty or the mediator did not measure it.";
306
+ };
307
+ readonly deliveredUnacked: {
308
+ readonly type: "integer";
309
+ readonly minimum: 0;
310
+ readonly 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.";
311
+ };
312
+ };
313
+ };
314
+ };
315
+ };
316
+ /** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
317
+ export declare const RESPONSE_PAYLOAD_SCHEMA: {
318
+ readonly $schema: "https://json-schema.org/draft/2020-12/schema";
319
+ readonly $ref: "#/$defs/Response";
320
+ readonly $defs: {
321
+ readonly Response: {
322
+ readonly $anchor: "response";
323
+ readonly title: "Messaging — Show Mediator Statistics — response payload";
324
+ readonly description: "The success response to a messaging/stats/show request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/stats/show/0.1#response.";
325
+ readonly type: "object";
326
+ readonly additionalProperties: false;
327
+ readonly properties: {
328
+ readonly version: {
329
+ readonly type: "string";
330
+ readonly minLength: 1;
331
+ readonly description: "The mediator software's version string.";
332
+ };
333
+ readonly startedAt: {
334
+ readonly type: "string";
335
+ readonly format: "date-time";
336
+ };
337
+ readonly uptimeSeconds: {
338
+ readonly type: "integer";
339
+ readonly minimum: 0;
340
+ };
341
+ readonly connections: {
342
+ readonly type: "object";
343
+ readonly additionalProperties: false;
344
+ readonly required: readonly ["websocketActive"];
345
+ readonly properties: {
346
+ readonly websocketActive: {
347
+ readonly type: "integer";
348
+ readonly minimum: 0;
349
+ };
350
+ readonly websocketMax: {
351
+ readonly type: "integer";
352
+ readonly minimum: 0;
353
+ readonly description: "Configured ceiling; absent when unlimited.";
354
+ };
355
+ };
356
+ };
357
+ readonly totals: {
358
+ readonly type: "object";
359
+ readonly additionalProperties: false;
360
+ readonly description: "Lifetime counters since the mediator's store was created. Monotonic; a client derives rates from successive readings.";
361
+ readonly required: readonly ["receivedCount", "receivedBytes", "sentCount", "sentBytes", "deletedCount"];
362
+ readonly properties: {
363
+ readonly receivedCount: {
364
+ readonly type: "integer";
365
+ readonly minimum: 0;
366
+ };
367
+ readonly receivedBytes: {
368
+ readonly type: "integer";
369
+ readonly minimum: 0;
370
+ };
371
+ readonly sentCount: {
372
+ readonly type: "integer";
373
+ readonly minimum: 0;
374
+ };
375
+ readonly sentBytes: {
376
+ readonly type: "integer";
377
+ readonly minimum: 0;
378
+ };
379
+ readonly deletedCount: {
380
+ readonly type: "integer";
381
+ readonly minimum: 0;
382
+ };
383
+ readonly deletedBytes: {
384
+ readonly type: "integer";
385
+ readonly minimum: 0;
386
+ };
387
+ readonly websocketOpened: {
388
+ readonly type: "integer";
389
+ readonly minimum: 0;
390
+ };
391
+ readonly websocketClosed: {
392
+ readonly type: "integer";
393
+ readonly minimum: 0;
394
+ };
395
+ readonly sessionsCreated: {
396
+ readonly type: "integer";
397
+ readonly minimum: 0;
398
+ };
399
+ readonly sessionsAuthenticated: {
400
+ readonly type: "integer";
401
+ readonly minimum: 0;
402
+ };
403
+ readonly invitationsCreated: {
404
+ readonly type: "integer";
405
+ readonly minimum: 0;
406
+ };
407
+ readonly invitationsClaimed: {
408
+ readonly type: "integer";
409
+ readonly minimum: 0;
410
+ };
411
+ };
412
+ };
413
+ readonly forwarding: {
414
+ readonly type: "object";
415
+ readonly additionalProperties: false;
416
+ readonly required: readonly ["queueLength"];
417
+ readonly properties: {
418
+ readonly queueLength: {
419
+ readonly type: "integer";
420
+ readonly minimum: 0;
421
+ readonly description: "Messages waiting to be forwarded to other mediators.";
422
+ };
423
+ readonly queueLimit: {
424
+ readonly type: "integer";
425
+ readonly minimum: 0;
426
+ };
427
+ readonly circuitBreaker: {
428
+ readonly type: "string";
429
+ readonly enum: readonly ["closed", "open", "halfOpen"];
430
+ readonly description: "State of the store circuit breaker. `open` means the mediator is shedding store operations.";
431
+ };
432
+ };
433
+ };
434
+ readonly queues: {
435
+ readonly type: "object";
436
+ readonly additionalProperties: false;
437
+ readonly description: "Aggregate of the mediator's most recent queue survey. Absent when no survey has completed.";
438
+ readonly required: readonly ["surveyedAt", "accounts"];
439
+ readonly properties: {
440
+ readonly surveyedAt: {
441
+ readonly type: "string";
442
+ readonly format: "date-time";
443
+ };
444
+ readonly accounts: {
445
+ readonly type: "integer";
446
+ readonly minimum: 0;
447
+ readonly description: "Accounts the survey covered.";
448
+ };
449
+ readonly truncated: {
450
+ readonly type: "boolean";
451
+ readonly description: "The survey stopped before covering every account.";
452
+ };
453
+ readonly receive: {
454
+ readonly $ref: "#/$defs/QueueDepth";
455
+ readonly description: "Totals across every surveyed receive queue; `saturation` is the maximum of any single queue.";
456
+ };
457
+ readonly send: {
458
+ readonly $ref: "#/$defs/QueueDepth";
459
+ readonly description: "Totals across every surveyed send queue; `saturation` is the maximum of any single queue.";
460
+ };
461
+ };
462
+ };
463
+ readonly ext: {
464
+ readonly $ref: "#/$defs/Ext";
465
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
466
+ };
467
+ };
468
+ readonly required: readonly ["version", "uptimeSeconds", "connections", "totals", "forwarding"];
469
+ };
470
+ readonly Ext: {
471
+ readonly title: "Ext";
472
+ 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.";
473
+ readonly type: "object";
474
+ readonly minProperties: 1;
475
+ readonly additionalProperties: true;
476
+ readonly propertyNames: {
477
+ readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
478
+ };
479
+ };
480
+ readonly QueueDepth: {
481
+ readonly title: "QueueDepth";
482
+ readonly type: "object";
483
+ readonly additionalProperties: false;
484
+ readonly required: readonly ["count", "bytes"];
485
+ readonly description: "The depth of one queue and its effective limit.";
486
+ readonly properties: {
487
+ readonly count: {
488
+ readonly type: "integer";
489
+ readonly minimum: 0;
490
+ readonly description: "Messages currently in the queue.";
491
+ };
492
+ readonly bytes: {
493
+ readonly type: "integer";
494
+ readonly minimum: 0;
495
+ readonly description: "Total stored size of those messages, in bytes.";
496
+ };
497
+ readonly limit: {
498
+ readonly type: "integer";
499
+ readonly minimum: -1;
500
+ readonly description: "The effective message-count limit for this queue after account overrides and mediator defaults are applied; -1 = unlimited.";
501
+ };
502
+ readonly saturation: {
503
+ readonly type: "number";
504
+ readonly minimum: 0;
505
+ readonly description: "count ÷ limit. Absent when the limit is unlimited. May exceed 1 when a limit was lowered below the current depth.";
506
+ };
507
+ readonly oldestAgeSeconds: {
508
+ readonly type: "integer";
509
+ readonly minimum: 0;
510
+ readonly description: "Age of the oldest message in the queue, in seconds. Absent when the queue is empty or the mediator did not measure it.";
511
+ };
512
+ readonly deliveredUnacked: {
513
+ readonly type: "integer";
514
+ readonly minimum: 0;
515
+ readonly 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.";
516
+ };
517
+ };
518
+ };
519
+ };
520
+ };
521
+ /**
522
+ * SPEC.md §7.2 policy for the request variant, from this specification's
523
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
524
+ * per-specification and cannot be derived from the document alone, and
525
+ * item 2 needs the schema this carries.
526
+ */
527
+ export declare const SPEC: {
528
+ readonly typeUri: "https://trusttasks.org/spec/messaging/stats/show/0.1";
529
+ readonly isBearer: false;
530
+ readonly isProofRequired: true;
531
+ readonly isRecipientRequired: true;
532
+ readonly isIssuedAtRequired: true;
533
+ readonly payloadSchema: {
534
+ readonly $schema: "https://json-schema.org/draft/2020-12/schema";
535
+ readonly $id: "https://trusttasks.org/spec/messaging/stats/show/0.1";
536
+ readonly title: "Messaging — Show Mediator Statistics — payload";
537
+ readonly type: "object";
538
+ readonly additionalProperties: false;
539
+ readonly properties: {
540
+ readonly ext: {
541
+ readonly $ref: "#/$defs/Ext";
542
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
543
+ };
544
+ };
545
+ readonly $defs: {
546
+ readonly Response: {
547
+ readonly $anchor: "response";
548
+ readonly title: "Messaging — Show Mediator Statistics — response payload";
549
+ readonly description: "The success response to a messaging/stats/show request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/stats/show/0.1#response.";
550
+ readonly type: "object";
551
+ readonly additionalProperties: false;
552
+ readonly properties: {
553
+ readonly version: {
554
+ readonly type: "string";
555
+ readonly minLength: 1;
556
+ readonly description: "The mediator software's version string.";
557
+ };
558
+ readonly startedAt: {
559
+ readonly type: "string";
560
+ readonly format: "date-time";
561
+ };
562
+ readonly uptimeSeconds: {
563
+ readonly type: "integer";
564
+ readonly minimum: 0;
565
+ };
566
+ readonly connections: {
567
+ readonly type: "object";
568
+ readonly additionalProperties: false;
569
+ readonly required: readonly ["websocketActive"];
570
+ readonly properties: {
571
+ readonly websocketActive: {
572
+ readonly type: "integer";
573
+ readonly minimum: 0;
574
+ };
575
+ readonly websocketMax: {
576
+ readonly type: "integer";
577
+ readonly minimum: 0;
578
+ readonly description: "Configured ceiling; absent when unlimited.";
579
+ };
580
+ };
581
+ };
582
+ readonly totals: {
583
+ readonly type: "object";
584
+ readonly additionalProperties: false;
585
+ readonly description: "Lifetime counters since the mediator's store was created. Monotonic; a client derives rates from successive readings.";
586
+ readonly required: readonly ["receivedCount", "receivedBytes", "sentCount", "sentBytes", "deletedCount"];
587
+ readonly properties: {
588
+ readonly receivedCount: {
589
+ readonly type: "integer";
590
+ readonly minimum: 0;
591
+ };
592
+ readonly receivedBytes: {
593
+ readonly type: "integer";
594
+ readonly minimum: 0;
595
+ };
596
+ readonly sentCount: {
597
+ readonly type: "integer";
598
+ readonly minimum: 0;
599
+ };
600
+ readonly sentBytes: {
601
+ readonly type: "integer";
602
+ readonly minimum: 0;
603
+ };
604
+ readonly deletedCount: {
605
+ readonly type: "integer";
606
+ readonly minimum: 0;
607
+ };
608
+ readonly deletedBytes: {
609
+ readonly type: "integer";
610
+ readonly minimum: 0;
611
+ };
612
+ readonly websocketOpened: {
613
+ readonly type: "integer";
614
+ readonly minimum: 0;
615
+ };
616
+ readonly websocketClosed: {
617
+ readonly type: "integer";
618
+ readonly minimum: 0;
619
+ };
620
+ readonly sessionsCreated: {
621
+ readonly type: "integer";
622
+ readonly minimum: 0;
623
+ };
624
+ readonly sessionsAuthenticated: {
625
+ readonly type: "integer";
626
+ readonly minimum: 0;
627
+ };
628
+ readonly invitationsCreated: {
629
+ readonly type: "integer";
630
+ readonly minimum: 0;
631
+ };
632
+ readonly invitationsClaimed: {
633
+ readonly type: "integer";
634
+ readonly minimum: 0;
635
+ };
636
+ };
637
+ };
638
+ readonly forwarding: {
639
+ readonly type: "object";
640
+ readonly additionalProperties: false;
641
+ readonly required: readonly ["queueLength"];
642
+ readonly properties: {
643
+ readonly queueLength: {
644
+ readonly type: "integer";
645
+ readonly minimum: 0;
646
+ readonly description: "Messages waiting to be forwarded to other mediators.";
647
+ };
648
+ readonly queueLimit: {
649
+ readonly type: "integer";
650
+ readonly minimum: 0;
651
+ };
652
+ readonly circuitBreaker: {
653
+ readonly type: "string";
654
+ readonly enum: readonly ["closed", "open", "halfOpen"];
655
+ readonly description: "State of the store circuit breaker. `open` means the mediator is shedding store operations.";
656
+ };
657
+ };
658
+ };
659
+ readonly queues: {
660
+ readonly type: "object";
661
+ readonly additionalProperties: false;
662
+ readonly description: "Aggregate of the mediator's most recent queue survey. Absent when no survey has completed.";
663
+ readonly required: readonly ["surveyedAt", "accounts"];
664
+ readonly properties: {
665
+ readonly surveyedAt: {
666
+ readonly type: "string";
667
+ readonly format: "date-time";
668
+ };
669
+ readonly accounts: {
670
+ readonly type: "integer";
671
+ readonly minimum: 0;
672
+ readonly description: "Accounts the survey covered.";
673
+ };
674
+ readonly truncated: {
675
+ readonly type: "boolean";
676
+ readonly description: "The survey stopped before covering every account.";
677
+ };
678
+ readonly receive: {
679
+ readonly $ref: "#/$defs/QueueDepth";
680
+ readonly description: "Totals across every surveyed receive queue; `saturation` is the maximum of any single queue.";
681
+ };
682
+ readonly send: {
683
+ readonly $ref: "#/$defs/QueueDepth";
684
+ readonly description: "Totals across every surveyed send queue; `saturation` is the maximum of any single queue.";
685
+ };
686
+ };
687
+ };
688
+ readonly ext: {
689
+ readonly $ref: "#/$defs/Ext";
690
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
691
+ };
692
+ };
693
+ readonly required: readonly ["version", "uptimeSeconds", "connections", "totals", "forwarding"];
694
+ };
695
+ readonly Ext: {
696
+ readonly title: "Ext";
697
+ 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.";
698
+ readonly type: "object";
699
+ readonly minProperties: 1;
700
+ readonly additionalProperties: true;
701
+ readonly propertyNames: {
702
+ readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
703
+ };
704
+ };
705
+ readonly QueueDepth: {
706
+ readonly title: "QueueDepth";
707
+ readonly type: "object";
708
+ readonly additionalProperties: false;
709
+ readonly required: readonly ["count", "bytes"];
710
+ readonly description: "The depth of one queue and its effective limit.";
711
+ readonly properties: {
712
+ readonly count: {
713
+ readonly type: "integer";
714
+ readonly minimum: 0;
715
+ readonly description: "Messages currently in the queue.";
716
+ };
717
+ readonly bytes: {
718
+ readonly type: "integer";
719
+ readonly minimum: 0;
720
+ readonly description: "Total stored size of those messages, in bytes.";
721
+ };
722
+ readonly limit: {
723
+ readonly type: "integer";
724
+ readonly minimum: -1;
725
+ readonly description: "The effective message-count limit for this queue after account overrides and mediator defaults are applied; -1 = unlimited.";
726
+ };
727
+ readonly saturation: {
728
+ readonly type: "number";
729
+ readonly minimum: 0;
730
+ readonly description: "count ÷ limit. Absent when the limit is unlimited. May exceed 1 when a limit was lowered below the current depth.";
731
+ };
732
+ readonly oldestAgeSeconds: {
733
+ readonly type: "integer";
734
+ readonly minimum: 0;
735
+ readonly description: "Age of the oldest message in the queue, in seconds. Absent when the queue is empty or the mediator did not measure it.";
736
+ };
737
+ readonly deliveredUnacked: {
738
+ readonly type: "integer";
739
+ readonly minimum: 0;
740
+ readonly 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.";
741
+ };
742
+ };
743
+ };
744
+ };
745
+ };
746
+ };
747
+ /**
748
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
749
+ * tracks the *issuer* party's requirement because a response swaps the
750
+ * parties (§7.3 item 5).
751
+ */
752
+ export declare const RESPONSE_SPEC: {
753
+ readonly typeUri: "https://trusttasks.org/spec/messaging/stats/show/0.1#response";
754
+ readonly isBearer: false;
755
+ readonly isProofRequired: false;
756
+ readonly isRecipientRequired: true;
757
+ readonly isIssuedAtRequired: true;
758
+ readonly payloadSchema: {
759
+ readonly $schema: "https://json-schema.org/draft/2020-12/schema";
760
+ readonly $ref: "#/$defs/Response";
761
+ readonly $defs: {
762
+ readonly Response: {
763
+ readonly $anchor: "response";
764
+ readonly title: "Messaging — Show Mediator Statistics — response payload";
765
+ readonly description: "The success response to a messaging/stats/show request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/stats/show/0.1#response.";
766
+ readonly type: "object";
767
+ readonly additionalProperties: false;
768
+ readonly properties: {
769
+ readonly version: {
770
+ readonly type: "string";
771
+ readonly minLength: 1;
772
+ readonly description: "The mediator software's version string.";
773
+ };
774
+ readonly startedAt: {
775
+ readonly type: "string";
776
+ readonly format: "date-time";
777
+ };
778
+ readonly uptimeSeconds: {
779
+ readonly type: "integer";
780
+ readonly minimum: 0;
781
+ };
782
+ readonly connections: {
783
+ readonly type: "object";
784
+ readonly additionalProperties: false;
785
+ readonly required: readonly ["websocketActive"];
786
+ readonly properties: {
787
+ readonly websocketActive: {
788
+ readonly type: "integer";
789
+ readonly minimum: 0;
790
+ };
791
+ readonly websocketMax: {
792
+ readonly type: "integer";
793
+ readonly minimum: 0;
794
+ readonly description: "Configured ceiling; absent when unlimited.";
795
+ };
796
+ };
797
+ };
798
+ readonly totals: {
799
+ readonly type: "object";
800
+ readonly additionalProperties: false;
801
+ readonly description: "Lifetime counters since the mediator's store was created. Monotonic; a client derives rates from successive readings.";
802
+ readonly required: readonly ["receivedCount", "receivedBytes", "sentCount", "sentBytes", "deletedCount"];
803
+ readonly properties: {
804
+ readonly receivedCount: {
805
+ readonly type: "integer";
806
+ readonly minimum: 0;
807
+ };
808
+ readonly receivedBytes: {
809
+ readonly type: "integer";
810
+ readonly minimum: 0;
811
+ };
812
+ readonly sentCount: {
813
+ readonly type: "integer";
814
+ readonly minimum: 0;
815
+ };
816
+ readonly sentBytes: {
817
+ readonly type: "integer";
818
+ readonly minimum: 0;
819
+ };
820
+ readonly deletedCount: {
821
+ readonly type: "integer";
822
+ readonly minimum: 0;
823
+ };
824
+ readonly deletedBytes: {
825
+ readonly type: "integer";
826
+ readonly minimum: 0;
827
+ };
828
+ readonly websocketOpened: {
829
+ readonly type: "integer";
830
+ readonly minimum: 0;
831
+ };
832
+ readonly websocketClosed: {
833
+ readonly type: "integer";
834
+ readonly minimum: 0;
835
+ };
836
+ readonly sessionsCreated: {
837
+ readonly type: "integer";
838
+ readonly minimum: 0;
839
+ };
840
+ readonly sessionsAuthenticated: {
841
+ readonly type: "integer";
842
+ readonly minimum: 0;
843
+ };
844
+ readonly invitationsCreated: {
845
+ readonly type: "integer";
846
+ readonly minimum: 0;
847
+ };
848
+ readonly invitationsClaimed: {
849
+ readonly type: "integer";
850
+ readonly minimum: 0;
851
+ };
852
+ };
853
+ };
854
+ readonly forwarding: {
855
+ readonly type: "object";
856
+ readonly additionalProperties: false;
857
+ readonly required: readonly ["queueLength"];
858
+ readonly properties: {
859
+ readonly queueLength: {
860
+ readonly type: "integer";
861
+ readonly minimum: 0;
862
+ readonly description: "Messages waiting to be forwarded to other mediators.";
863
+ };
864
+ readonly queueLimit: {
865
+ readonly type: "integer";
866
+ readonly minimum: 0;
867
+ };
868
+ readonly circuitBreaker: {
869
+ readonly type: "string";
870
+ readonly enum: readonly ["closed", "open", "halfOpen"];
871
+ readonly description: "State of the store circuit breaker. `open` means the mediator is shedding store operations.";
872
+ };
873
+ };
874
+ };
875
+ readonly queues: {
876
+ readonly type: "object";
877
+ readonly additionalProperties: false;
878
+ readonly description: "Aggregate of the mediator's most recent queue survey. Absent when no survey has completed.";
879
+ readonly required: readonly ["surveyedAt", "accounts"];
880
+ readonly properties: {
881
+ readonly surveyedAt: {
882
+ readonly type: "string";
883
+ readonly format: "date-time";
884
+ };
885
+ readonly accounts: {
886
+ readonly type: "integer";
887
+ readonly minimum: 0;
888
+ readonly description: "Accounts the survey covered.";
889
+ };
890
+ readonly truncated: {
891
+ readonly type: "boolean";
892
+ readonly description: "The survey stopped before covering every account.";
893
+ };
894
+ readonly receive: {
895
+ readonly $ref: "#/$defs/QueueDepth";
896
+ readonly description: "Totals across every surveyed receive queue; `saturation` is the maximum of any single queue.";
897
+ };
898
+ readonly send: {
899
+ readonly $ref: "#/$defs/QueueDepth";
900
+ readonly description: "Totals across every surveyed send queue; `saturation` is the maximum of any single queue.";
901
+ };
902
+ };
903
+ };
904
+ readonly ext: {
905
+ readonly $ref: "#/$defs/Ext";
906
+ readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
907
+ };
908
+ };
909
+ readonly required: readonly ["version", "uptimeSeconds", "connections", "totals", "forwarding"];
910
+ };
911
+ readonly Ext: {
912
+ readonly title: "Ext";
913
+ 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.";
914
+ readonly type: "object";
915
+ readonly minProperties: 1;
916
+ readonly additionalProperties: true;
917
+ readonly propertyNames: {
918
+ readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
919
+ };
920
+ };
921
+ readonly QueueDepth: {
922
+ readonly title: "QueueDepth";
923
+ readonly type: "object";
924
+ readonly additionalProperties: false;
925
+ readonly required: readonly ["count", "bytes"];
926
+ readonly description: "The depth of one queue and its effective limit.";
927
+ readonly properties: {
928
+ readonly count: {
929
+ readonly type: "integer";
930
+ readonly minimum: 0;
931
+ readonly description: "Messages currently in the queue.";
932
+ };
933
+ readonly bytes: {
934
+ readonly type: "integer";
935
+ readonly minimum: 0;
936
+ readonly description: "Total stored size of those messages, in bytes.";
937
+ };
938
+ readonly limit: {
939
+ readonly type: "integer";
940
+ readonly minimum: -1;
941
+ readonly description: "The effective message-count limit for this queue after account overrides and mediator defaults are applied; -1 = unlimited.";
942
+ };
943
+ readonly saturation: {
944
+ readonly type: "number";
945
+ readonly minimum: 0;
946
+ readonly description: "count ÷ limit. Absent when the limit is unlimited. May exceed 1 when a limit was lowered below the current depth.";
947
+ };
948
+ readonly oldestAgeSeconds: {
949
+ readonly type: "integer";
950
+ readonly minimum: 0;
951
+ readonly description: "Age of the oldest message in the queue, in seconds. Absent when the queue is empty or the mediator did not measure it.";
952
+ };
953
+ readonly deliveredUnacked: {
954
+ readonly type: "integer";
955
+ readonly minimum: 0;
956
+ readonly 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.";
957
+ };
958
+ };
959
+ };
960
+ };
961
+ };
962
+ };
963
+ //# sourceMappingURL=payload.d.ts.map