@wandelbots/nova-js 3.13.0-pr.307.ea0533d → 3.13.0

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 (45) hide show
  1. package/dist/Nova--8gozkLR.d.mts +85 -0
  2. package/dist/Nova--8gozkLR.d.mts.map +1 -0
  3. package/dist/Nova-B1o5iTQ6.d.cts +85 -0
  4. package/dist/Nova-B1o5iTQ6.d.cts.map +1 -0
  5. package/dist/{context-Cu5mXcFZ.cjs → context-BZELA2eh.cjs} +3 -146
  6. package/dist/context-BZELA2eh.cjs.map +1 -0
  7. package/dist/{context-CmXqEEwW.mjs → context-ffr5Q2dc.mjs} +3 -86
  8. package/dist/context-ffr5Q2dc.mjs.map +1 -0
  9. package/dist/converters-DnG1fX23.mjs +87 -0
  10. package/dist/converters-DnG1fX23.mjs.map +1 -0
  11. package/dist/converters-EYS27XJE.cjs +146 -0
  12. package/dist/converters-EYS27XJE.cjs.map +1 -0
  13. package/dist/experimental/nats/index.cjs +96 -17
  14. package/dist/experimental/nats/index.cjs.map +1 -1
  15. package/dist/experimental/nats/index.d.cts +1079 -67
  16. package/dist/experimental/nats/index.d.cts.map +1 -1
  17. package/dist/experimental/nats/index.d.mts +1079 -67
  18. package/dist/experimental/nats/index.d.mts.map +1 -1
  19. package/dist/experimental/nats/index.mjs +96 -18
  20. package/dist/experimental/nats/index.mjs.map +1 -1
  21. package/dist/index.cjs +13 -12
  22. package/dist/index.mjs +3 -2
  23. package/dist/v1/index.cjs +3 -3
  24. package/dist/v1/index.cjs.map +1 -1
  25. package/dist/v1/index.mjs +2 -2
  26. package/dist/v2/index.cjs +4 -3
  27. package/dist/v2/index.cjs.map +1 -1
  28. package/dist/v2/index.d.cts +5 -83
  29. package/dist/v2/index.d.cts.map +1 -1
  30. package/dist/v2/index.d.mts +4 -82
  31. package/dist/v2/index.d.mts.map +1 -1
  32. package/dist/v2/index.mjs +2 -1
  33. package/dist/v2/index.mjs.map +1 -1
  34. package/dist/{wandelscriptUtils-CKhiZJsB.mjs → wandelscriptUtils-CpUXdLVc.mjs} +3 -2
  35. package/dist/{wandelscriptUtils-CKhiZJsB.mjs.map → wandelscriptUtils-CpUXdLVc.mjs.map} +1 -1
  36. package/dist/{wandelscriptUtils-BdqeVDCY.cjs → wandelscriptUtils-DcY1aLWu.cjs} +13 -12
  37. package/dist/{wandelscriptUtils-BdqeVDCY.cjs.map → wandelscriptUtils-DcY1aLWu.cjs.map} +1 -1
  38. package/package.json +1 -3
  39. package/src/experimental/nats/index.ts +7 -0
  40. package/src/lib/experimental/nats/NovaNatsClient.ts +86 -15
  41. package/src/lib/experimental/nats/buildNatsServerUrl.ts +15 -0
  42. package/src/lib/experimental/nats/buildSubject.ts +53 -5
  43. package/src/lib/experimental/nats/generated/operations.ts +918 -71
  44. package/dist/context-CmXqEEwW.mjs.map +0 -1
  45. package/dist/context-Cu5mXcFZ.cjs.map +0 -1
@@ -35,150 +35,698 @@ import type {
35
35
 
36
36
  /** Subject parameters required by each NATS subject, e.g. "nova.v2.cells.{cell}". */
37
37
  export interface NatsOperationParams {
38
- /** publishCell */
39
- "nova.v2.cells.{cell}": { cell: string }
40
- /** publishApp */
41
- "nova.v2.cells.{cell}.apps.{app}": { cell: string; app: string }
42
- /** publishProgramStatus */
43
- "nova.v2.cells.{cell}.programs": { cell: string }
44
- /** publishRobotController */
38
+ /**
39
+ * Cell Configuration
40
+ *
41
+ * Publishes the configuration for a cell.
42
+ *
43
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
44
+ *
45
+ * @operationId publishCell
46
+ */
47
+ "nova.v2.cells.{cell}": {
48
+ /**
49
+ * Unique identifier addressing a cell in all API calls.
50
+ */
51
+ cell: string
52
+ }
53
+ /**
54
+ * App Configuration
55
+ *
56
+ * Publishes the configuration for a GUI application in the cell.
57
+ *
58
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
59
+ *
60
+ * @operationId publishApp
61
+ */
62
+ "nova.v2.cells.{cell}.apps.{app}": {
63
+ /**
64
+ * Unique identifier addressing a cell in all API calls.
65
+ */
66
+ cell: string
67
+ /**
68
+ * Name of the provided application.
69
+ * Must be unique within the cell and is used as an identifier for addressing the application in all API calls, e.g., when updating the application.
70
+ */
71
+ app: string
72
+ }
73
+ /**
74
+ * Program Status
75
+ *
76
+ * Publishes status messages for programs running in an app within a cell.
77
+ * The status messages provide information about the current state of a program run.
78
+ *
79
+ * @operationId publishProgramStatus
80
+ */
81
+ "nova.v2.cells.{cell}.programs": {
82
+ /**
83
+ * Unique identifier addressing a cell in all API calls.
84
+ */
85
+ cell: string
86
+ }
87
+ /**
88
+ * Robot Controller Configuration
89
+ *
90
+ * Publishes the configuration of a robot controller.
91
+ *
92
+ * @operationId publishRobotController
93
+ */
45
94
  "nova.v2.cells.{cell}.controllers.{controller}": {
95
+ /**
96
+ * Unique identifier addressing a cell in all API calls.
97
+ */
46
98
  cell: string
99
+ /**
100
+ * Unique identifier to address a controller in the cell.
101
+ */
47
102
  controller: string
48
103
  }
49
- /** publishCellStatus */
50
- "nova.v2.cells.{cell}.status": { cell: string }
51
- /** publishCellCycle */
52
- "nova.v2.cells.{cell}.cycle": { cell: string }
53
- /** publishSystemStatus */
54
- "nova.v2.system.status": Record<string, never>
55
- /** publishCollisionSetup */
104
+ /**
105
+ * Service Status
106
+ *
107
+ * Publishes the status of all cell resources.
108
+ *
109
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
110
+ *
111
+ * @operationId publishCellStatus
112
+ */
113
+ "nova.v2.cells.{cell}.status": {
114
+ /**
115
+ * Unique identifier addressing a cell in all API calls.
116
+ */
117
+ cell: string
118
+ }
119
+ /**
120
+ * Cell Cycle Event
121
+ *
122
+ * Publishes the cycle events for a cell.
123
+ *
124
+ * @operationId publishCellCycle
125
+ */
126
+ "nova.v2.cells.{cell}.cycle": {
127
+ /**
128
+ * Unique identifier addressing a cell in all API calls.
129
+ */
130
+ cell: string
131
+ }
132
+ /**
133
+ * Wandelbots NOVA status
134
+ *
135
+ * Publishes the status of all system services.
136
+ *
137
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
138
+ *
139
+ * @operationId publishSystemStatus
140
+ */
141
+ "nova.v2.system.status": Record<never, never>
142
+ /**
143
+ * Collision Setup
144
+ *
145
+ * Publishes the stored collision setup.
146
+ *
147
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
148
+ *
149
+ * @operationId publishCollisionSetup
150
+ */
56
151
  "nova.v2.cells.{cell}.collision.setups.{setup}": {
152
+ /**
153
+ * Unique identifier addressing a cell in all API calls.
154
+ */
57
155
  cell: string
156
+ /**
157
+ * Unique identifier addressing a collision setup.
158
+ */
58
159
  setup: string
59
160
  }
60
- /** publishBUSIOStatus */
61
- "nova.v2.cells.{cell}.bus-ios.status": { cell: string }
62
- /** publishBUSIOsIOs */
63
- "nova.v2.cells.{cell}.bus-ios.ios": { cell: string }
64
- /** setBUSIOsIOs */
65
- "nova.v2.cells.{cell}.bus-ios.ios.set": { cell: string }
66
- /** selectRobotControllerIOs */
161
+ /**
162
+ * BUS Inputs/Outputs Service Status
163
+ *
164
+ * Publishes the status of BUS inputs/outputs service.
165
+ *
166
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`.
167
+ *
168
+ * @operationId publishBUSIOStatus
169
+ */
170
+ "nova.v2.cells.{cell}.bus-ios.status": {
171
+ /**
172
+ * Unique identifier addressing a cell in all API calls.
173
+ */
174
+ cell: string
175
+ }
176
+ /**
177
+ * BUS Input/Output Values
178
+ *
179
+ * Publishes updates of BUS input/output values.
180
+ *
181
+ * @operationId publishBUSIOsIOs
182
+ */
183
+ "nova.v2.cells.{cell}.bus-ios.ios": {
184
+ /**
185
+ * Unique identifier addressing a cell in all API calls.
186
+ */
187
+ cell: string
188
+ }
189
+ /**
190
+ * Set Output Values
191
+ *
192
+ * Set output values published with the BUS inputs/outputs service.
193
+ * If you're using a virtual service, you can set inputs as well.
194
+ *
195
+ * @operationId setBUSIOsIOs
196
+ */
197
+ "nova.v2.cells.{cell}.bus-ios.ios.set": {
198
+ /**
199
+ * Unique identifier addressing a cell in all API calls.
200
+ */
201
+ cell: string
202
+ }
203
+ /**
204
+ * Select Input/Output Values
205
+ *
206
+ * Select input/output values published by the controller.
207
+ *
208
+ * @operationId selectRobotControllerIOs
209
+ */
67
210
  "nova.v2.cells.{cell}.controllers.{controller}.ios.select": {
211
+ /**
212
+ * Unique identifier addressing a cell in all API calls.
213
+ */
68
214
  cell: string
215
+ /**
216
+ * Unique identifier to address a controller in a cell.
217
+ */
69
218
  controller: string
70
219
  }
71
- /** publishRobotControllerIOs */
220
+ /**
221
+ * Input/Output Values
222
+ *
223
+ * Publishes updates of input/output values.
224
+ *
225
+ * @operationId publishRobotControllerIOs
226
+ */
72
227
  "nova.v2.cells.{cell}.controllers.{controller}.ios": {
228
+ /**
229
+ * Unique identifier addressing a cell in all API calls.
230
+ */
73
231
  cell: string
232
+ /**
233
+ * Unique identifier to address a controller in the cell.
234
+ */
74
235
  controller: string
75
236
  }
76
- /** publishRobotControllersState */
237
+ /**
238
+ * State of Robot Controller
239
+ *
240
+ * Publishes the current state of a robot controller.
241
+ *
242
+ * @operationId publishRobotControllersState
243
+ */
77
244
  "nova.v2.cells.{cell}.controllers.{controller}.state": {
245
+ /**
246
+ * Unique identifier addressing a cell in all API calls.
247
+ */
78
248
  cell: string
249
+ /**
250
+ * Unique identifier to address a controller in the cell.
251
+ */
79
252
  controller: string
80
253
  }
81
- /** publishMotionGroupDescription */
254
+ /**
255
+ * Description of Motion Group
256
+ *
257
+ * Publishes the description of a motion group, including TCPs, mounting, safety zones, limits, etc.
258
+ *
259
+ * @operationId publishMotionGroupDescription
260
+ */
82
261
  "nova.v2.cells.{cell}.controllers.{controller}.motion-groups.{motion-group}.description": {
262
+ /**
263
+ * Unique identifier addressing a cell in all API calls.
264
+ */
83
265
  cell: string
266
+ /**
267
+ * Unique identifier addressing a controller in the cell.
268
+ */
84
269
  controller: string
270
+ /**
271
+ * Motion group identifier.
272
+ */
85
273
  "motion-group": string
86
274
  }
87
- /** eventSystemUpdateStarted */
88
- "nova.v2.events.system.update.started": Record<string, never>
89
- /** eventSystemUpdateCompleted */
90
- "nova.v2.events.system.update.completed": Record<string, never>
91
- /** eventSystemNetworkStatusChanged */
92
- "nova.v2.events.system.network.status.changed": Record<string, never>
93
- /** eventCellCreated */
94
- "nova.v2.events.cells.{cell}.created": { cell: string }
95
- /** eventCellUpdated */
96
- "nova.v2.events.cells.{cell}.updated": { cell: string }
97
- /** eventCellDeleted */
98
- "nova.v2.events.cells.{cell}.deleted": { cell: string }
99
- /** eventAppCreated */
275
+ /**
276
+ * System Update Started
277
+ *
278
+ * Publishes an event when a system update process is initiated.
279
+ *
280
+ * This event is triggered once the service-manager begins a system update process,
281
+ * providing details about the update metadata, trigger information, and pre-update checks.
282
+ *
283
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
284
+ * for reliable delivery and event replay capabilities.
285
+ *
286
+ * @operationId eventSystemUpdateStarted
287
+ */
288
+ "nova.v2.events.system.update.started": Record<never, never>
289
+ /**
290
+ * System Update Completed
291
+ *
292
+ * Publishes an event when a system update process is completed.
293
+ *
294
+ * This event is triggered once the service-manager completes a system update process,
295
+ * providing comprehensive results including success status, component outcomes,
296
+ * error details, and post-update validation results.
297
+ *
298
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
299
+ * for reliable delivery and event replay capabilities.
300
+ *
301
+ * @operationId eventSystemUpdateCompleted
302
+ */
303
+ "nova.v2.events.system.update.completed": Record<never, never>
304
+ /**
305
+ * System Network Status Changed
306
+ *
307
+ * Publishes an event when a system network status changes.
308
+ *
309
+ * This event is triggered once system-info service detects a change in the system network status,
310
+ * providing details about the new network state and related information.
311
+ *
312
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
313
+ * for reliable delivery and event replay capabilities.
314
+ *
315
+ * @operationId eventSystemNetworkStatusChanged
316
+ */
317
+ "nova.v2.events.system.network.status.changed": Record<never, never>
318
+ /**
319
+ * Cell Created
320
+ *
321
+ * Publishes an event when a cell foundation release is created.
322
+ *
323
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
324
+ *
325
+ * @operationId eventCellCreated
326
+ */
327
+ "nova.v2.events.cells.{cell}.created": {
328
+ /**
329
+ * Unique identifier addressing a cell in all API calls.
330
+ */
331
+ cell: string
332
+ }
333
+ /**
334
+ * Cell Updated
335
+ *
336
+ * Publishes an event when a cell foundation release is updated.
337
+ *
338
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
339
+ *
340
+ * @operationId eventCellUpdated
341
+ */
342
+ "nova.v2.events.cells.{cell}.updated": {
343
+ /**
344
+ * Unique identifier addressing a cell in all API calls.
345
+ */
346
+ cell: string
347
+ }
348
+ /**
349
+ * Cell Deleted
350
+ *
351
+ * Publishes an event when a cell foundation release is deleted.
352
+ *
353
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
354
+ *
355
+ * @operationId eventCellDeleted
356
+ */
357
+ "nova.v2.events.cells.{cell}.deleted": {
358
+ /**
359
+ * Unique identifier addressing a cell in all API calls.
360
+ */
361
+ cell: string
362
+ }
363
+ /**
364
+ * App Created
365
+ *
366
+ * Publishes an event when an app release is created in a cell.
367
+ *
368
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
369
+ *
370
+ * @operationId eventAppCreated
371
+ */
100
372
  "nova.v2.events.cells.{cell}.apps.{app}.created": {
373
+ /**
374
+ * Unique identifier addressing a cell in all API calls.
375
+ */
101
376
  cell: string
377
+ /**
378
+ * Unique identifier addressing an app in the cell.
379
+ */
102
380
  app: string
103
381
  }
104
- /** eventAppUpdated */
382
+ /**
383
+ * App Updated
384
+ *
385
+ * Publishes an event when an app release is updated in a cell.
386
+ *
387
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
388
+ *
389
+ * @operationId eventAppUpdated
390
+ */
105
391
  "nova.v2.events.cells.{cell}.apps.{app}.updated": {
392
+ /**
393
+ * Unique identifier addressing a cell in all API calls.
394
+ */
106
395
  cell: string
396
+ /**
397
+ * Unique identifier addressing an app in the cell.
398
+ */
107
399
  app: string
108
400
  }
109
- /** eventAppDeleted */
401
+ /**
402
+ * App Deleted
403
+ *
404
+ * Publishes an event when an app release is deleted from a cell.
405
+ *
406
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
407
+ *
408
+ * @operationId eventAppDeleted
409
+ */
110
410
  "nova.v2.events.cells.{cell}.apps.{app}.deleted": {
411
+ /**
412
+ * Unique identifier addressing a cell in all API calls.
413
+ */
111
414
  cell: string
415
+ /**
416
+ * Unique identifier addressing an app in the cell.
417
+ */
112
418
  app: string
113
419
  }
114
- /** eventRobotControllerCreated */
420
+ /**
421
+ * Robot Controller Created
422
+ *
423
+ * Publishes an event when a robot controller release is created in a cell.
424
+ *
425
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
426
+ *
427
+ * @operationId eventRobotControllerCreated
428
+ */
115
429
  "nova.v2.events.cells.{cell}.controllers.{controller}.created": {
430
+ /**
431
+ * Unique identifier addressing a cell in all API calls.
432
+ */
116
433
  cell: string
434
+ /**
435
+ * Unique identifier to address a controller in the cell.
436
+ */
117
437
  controller: string
118
438
  }
119
- /** eventRobotControllerUpdated */
439
+ /**
440
+ * Robot Controller Updated
441
+ *
442
+ * Publishes an event when a robot controller release is updated in a cell.
443
+ *
444
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
445
+ *
446
+ * @operationId eventRobotControllerUpdated
447
+ */
120
448
  "nova.v2.events.cells.{cell}.controllers.{controller}.updated": {
449
+ /**
450
+ * Unique identifier addressing a cell in all API calls.
451
+ */
121
452
  cell: string
453
+ /**
454
+ * Unique identifier to address a controller in the cell.
455
+ */
122
456
  controller: string
123
457
  }
124
- /** eventRobotControllerDeleted */
458
+ /**
459
+ * Robot Controller Deleted
460
+ *
461
+ * Publishes an event when a robot controller release is deleted from a cell.
462
+ *
463
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
464
+ *
465
+ * @operationId eventRobotControllerDeleted
466
+ */
125
467
  "nova.v2.events.cells.{cell}.controllers.{controller}.deleted": {
468
+ /**
469
+ * Unique identifier addressing a cell in all API calls.
470
+ */
126
471
  cell: string
472
+ /**
473
+ * Unique identifier to address a controller in the cell.
474
+ */
127
475
  controller: string
128
476
  }
129
477
  }
130
478
 
131
479
  /** Payload types for subjects the server publishes and the client subscribes to. */
132
480
  export interface NatsSubscribePayloads {
133
- /** publishCell */
481
+ /**
482
+ * Cell Configuration
483
+ *
484
+ * Publishes the configuration for a cell.
485
+ *
486
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
487
+ *
488
+ * @operationId publishCell
489
+ */
134
490
  "nova.v2.cells.{cell}": Cell
135
- /** publishApp */
491
+ /**
492
+ * App Configuration
493
+ *
494
+ * Publishes the configuration for a GUI application in the cell.
495
+ *
496
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
497
+ *
498
+ * @operationId publishApp
499
+ */
136
500
  "nova.v2.cells.{cell}.apps.{app}": App
137
- /** publishProgramStatus */
501
+ /**
502
+ * Program Status
503
+ *
504
+ * Publishes status messages for programs running in an app within a cell.
505
+ * The status messages provide information about the current state of a program run.
506
+ *
507
+ * @operationId publishProgramStatus
508
+ */
138
509
  "nova.v2.cells.{cell}.programs": ProgramStatus
139
- /** publishRobotController */
510
+ /**
511
+ * Robot Controller Configuration
512
+ *
513
+ * Publishes the configuration of a robot controller.
514
+ *
515
+ * @operationId publishRobotController
516
+ */
140
517
  "nova.v2.cells.{cell}.controllers.{controller}": RobotController
141
- /** publishCellStatus */
518
+ /**
519
+ * Service Status
520
+ *
521
+ * Publishes the status of all cell resources.
522
+ *
523
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
524
+ *
525
+ * @operationId publishCellStatus
526
+ */
142
527
  "nova.v2.cells.{cell}.status": ServiceStatusList
143
- /** publishCellCycle */
528
+ /**
529
+ * Cell Cycle Event
530
+ *
531
+ * Publishes the cycle events for a cell.
532
+ *
533
+ * @operationId publishCellCycle
534
+ */
144
535
  "nova.v2.cells.{cell}.cycle": CellCycleEvent
145
- /** publishSystemStatus */
536
+ /**
537
+ * Wandelbots NOVA status
538
+ *
539
+ * Publishes the status of all system services.
540
+ *
541
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
542
+ *
543
+ * @operationId publishSystemStatus
544
+ */
146
545
  "nova.v2.system.status": ServiceStatusList
147
- /** publishCollisionSetup */
546
+ /**
547
+ * Collision Setup
548
+ *
549
+ * Publishes the stored collision setup.
550
+ *
551
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
552
+ *
553
+ * @operationId publishCollisionSetup
554
+ */
148
555
  "nova.v2.cells.{cell}.collision.setups.{setup}": CollisionSetup
149
- /** publishBUSIOStatus */
556
+ /**
557
+ * BUS Inputs/Outputs Service Status
558
+ *
559
+ * Publishes the status of BUS inputs/outputs service.
560
+ *
561
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`.
562
+ *
563
+ * @operationId publishBUSIOStatus
564
+ */
150
565
  "nova.v2.cells.{cell}.bus-ios.status": BusIOsState
151
- /** publishBUSIOsIOs */
566
+ /**
567
+ * BUS Input/Output Values
568
+ *
569
+ * Publishes updates of BUS input/output values.
570
+ *
571
+ * @operationId publishBUSIOsIOs
572
+ */
152
573
  "nova.v2.cells.{cell}.bus-ios.ios": ListIOValuesResponse
153
- /** publishRobotControllerIOs */
574
+ /**
575
+ * Input/Output Values
576
+ *
577
+ * Publishes updates of input/output values.
578
+ *
579
+ * @operationId publishRobotControllerIOs
580
+ */
154
581
  "nova.v2.cells.{cell}.controllers.{controller}.ios": StreamIOValuesResponse
155
- /** publishRobotControllersState */
582
+ /**
583
+ * State of Robot Controller
584
+ *
585
+ * Publishes the current state of a robot controller.
586
+ *
587
+ * @operationId publishRobotControllersState
588
+ */
156
589
  "nova.v2.cells.{cell}.controllers.{controller}.state": RobotControllerState
157
- /** publishMotionGroupDescription */
590
+ /**
591
+ * Description of Motion Group
592
+ *
593
+ * Publishes the description of a motion group, including TCPs, mounting, safety zones, limits, etc.
594
+ *
595
+ * @operationId publishMotionGroupDescription
596
+ */
158
597
  "nova.v2.cells.{cell}.controllers.{controller}.motion-groups.{motion-group}.description": MotionGroupDescription
159
- /** eventSystemUpdateStarted */
598
+ /**
599
+ * System Update Started
600
+ *
601
+ * Publishes an event when a system update process is initiated.
602
+ *
603
+ * This event is triggered once the service-manager begins a system update process,
604
+ * providing details about the update metadata, trigger information, and pre-update checks.
605
+ *
606
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
607
+ * for reliable delivery and event replay capabilities.
608
+ *
609
+ * @operationId eventSystemUpdateStarted
610
+ */
160
611
  "nova.v2.events.system.update.started": SystemUpdateStartedEvent
161
- /** eventSystemUpdateCompleted */
612
+ /**
613
+ * System Update Completed
614
+ *
615
+ * Publishes an event when a system update process is completed.
616
+ *
617
+ * This event is triggered once the service-manager completes a system update process,
618
+ * providing comprehensive results including success status, component outcomes,
619
+ * error details, and post-update validation results.
620
+ *
621
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
622
+ * for reliable delivery and event replay capabilities.
623
+ *
624
+ * @operationId eventSystemUpdateCompleted
625
+ */
162
626
  "nova.v2.events.system.update.completed": SystemUpdateCompletedEvent
163
- /** eventSystemNetworkStatusChanged */
627
+ /**
628
+ * System Network Status Changed
629
+ *
630
+ * Publishes an event when a system network status changes.
631
+ *
632
+ * This event is triggered once system-info service detects a change in the system network status,
633
+ * providing details about the new network state and related information.
634
+ *
635
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
636
+ * for reliable delivery and event replay capabilities.
637
+ *
638
+ * @operationId eventSystemNetworkStatusChanged
639
+ */
164
640
  "nova.v2.events.system.network.status.changed": NetworkStatusChangedEvent
165
- /** eventCellCreated */
641
+ /**
642
+ * Cell Created
643
+ *
644
+ * Publishes an event when a cell foundation release is created.
645
+ *
646
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
647
+ *
648
+ * @operationId eventCellCreated
649
+ */
166
650
  "nova.v2.events.cells.{cell}.created": CellCreatedEvent
167
- /** eventCellUpdated */
651
+ /**
652
+ * Cell Updated
653
+ *
654
+ * Publishes an event when a cell foundation release is updated.
655
+ *
656
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
657
+ *
658
+ * @operationId eventCellUpdated
659
+ */
168
660
  "nova.v2.events.cells.{cell}.updated": CellUpdatedEvent
169
- /** eventCellDeleted */
661
+ /**
662
+ * Cell Deleted
663
+ *
664
+ * Publishes an event when a cell foundation release is deleted.
665
+ *
666
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
667
+ *
668
+ * @operationId eventCellDeleted
669
+ */
170
670
  "nova.v2.events.cells.{cell}.deleted": CellDeletedEvent
171
- /** eventAppCreated */
671
+ /**
672
+ * App Created
673
+ *
674
+ * Publishes an event when an app release is created in a cell.
675
+ *
676
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
677
+ *
678
+ * @operationId eventAppCreated
679
+ */
172
680
  "nova.v2.events.cells.{cell}.apps.{app}.created": AppCreatedEvent
173
- /** eventAppUpdated */
681
+ /**
682
+ * App Updated
683
+ *
684
+ * Publishes an event when an app release is updated in a cell.
685
+ *
686
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
687
+ *
688
+ * @operationId eventAppUpdated
689
+ */
174
690
  "nova.v2.events.cells.{cell}.apps.{app}.updated": AppUpdatedEvent
175
- /** eventAppDeleted */
691
+ /**
692
+ * App Deleted
693
+ *
694
+ * Publishes an event when an app release is deleted from a cell.
695
+ *
696
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
697
+ *
698
+ * @operationId eventAppDeleted
699
+ */
176
700
  "nova.v2.events.cells.{cell}.apps.{app}.deleted": AppDeletedEvent
177
- /** eventRobotControllerCreated */
701
+ /**
702
+ * Robot Controller Created
703
+ *
704
+ * Publishes an event when a robot controller release is created in a cell.
705
+ *
706
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
707
+ *
708
+ * @operationId eventRobotControllerCreated
709
+ */
178
710
  "nova.v2.events.cells.{cell}.controllers.{controller}.created": RobotControllerCreatedEvent
179
- /** eventRobotControllerUpdated */
711
+ /**
712
+ * Robot Controller Updated
713
+ *
714
+ * Publishes an event when a robot controller release is updated in a cell.
715
+ *
716
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
717
+ *
718
+ * @operationId eventRobotControllerUpdated
719
+ */
180
720
  "nova.v2.events.cells.{cell}.controllers.{controller}.updated": RobotControllerUpdatedEvent
181
- /** eventRobotControllerDeleted */
721
+ /**
722
+ * Robot Controller Deleted
723
+ *
724
+ * Publishes an event when a robot controller release is deleted from a cell.
725
+ *
726
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
727
+ *
728
+ * @operationId eventRobotControllerDeleted
729
+ */
182
730
  "nova.v2.events.cells.{cell}.controllers.{controller}.deleted": RobotControllerDeletedEvent
183
731
  }
184
732
 
@@ -186,18 +734,317 @@ export type NatsSubscribeSubject = keyof NatsSubscribePayloads
186
734
 
187
735
  /** Request payload types for subjects the client sends requests to. */
188
736
  export interface NatsRequestPayloads {
189
- /** setBUSIOsIOs */
737
+ /**
738
+ * Set Output Values
739
+ *
740
+ * Set output values published with the BUS inputs/outputs service.
741
+ * If you're using a virtual service, you can set inputs as well.
742
+ *
743
+ * @operationId setBUSIOsIOs
744
+ */
190
745
  "nova.v2.cells.{cell}.bus-ios.ios.set": ListIOValuesResponse
191
- /** selectRobotControllerIOs */
746
+ /**
747
+ * Select Input/Output Values
748
+ *
749
+ * Select input/output values published by the controller.
750
+ *
751
+ * @operationId selectRobotControllerIOs
752
+ */
192
753
  "nova.v2.cells.{cell}.controllers.{controller}.ios.select": SelectIOs
193
754
  }
194
755
 
195
756
  /** Reply payload types for request/reply subjects. */
196
757
  export interface NatsReplyPayloads {
197
- /** setBUSIOsIOs */
758
+ /**
759
+ * Set Output Values
760
+ *
761
+ * Set output values published with the BUS inputs/outputs service.
762
+ * If you're using a virtual service, you can set inputs as well.
763
+ *
764
+ * @operationId setBUSIOsIOs
765
+ */
198
766
  "nova.v2.cells.{cell}.bus-ios.ios.set": NatsErrorPayload
199
- /** selectRobotControllerIOs */
767
+ /**
768
+ * Select Input/Output Values
769
+ *
770
+ * Select input/output values published by the controller.
771
+ *
772
+ * @operationId selectRobotControllerIOs
773
+ */
200
774
  "nova.v2.cells.{cell}.controllers.{controller}.ios.select": NatsErrorPayload
201
775
  }
202
776
 
203
777
  export type NatsRequestSubject = keyof NatsRequestPayloads
778
+
779
+ /** Payload types for every subject defined in the spec, publishable via NovaNatsClient#publish. */
780
+ export interface NatsPublishPayloads {
781
+ /**
782
+ * Cell Configuration
783
+ *
784
+ * Publishes the configuration for a cell.
785
+ *
786
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
787
+ *
788
+ * @operationId publishCell
789
+ */
790
+ "nova.v2.cells.{cell}": Cell
791
+ /**
792
+ * App Configuration
793
+ *
794
+ * Publishes the configuration for a GUI application in the cell.
795
+ *
796
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
797
+ *
798
+ * @operationId publishApp
799
+ */
800
+ "nova.v2.cells.{cell}.apps.{app}": App
801
+ /**
802
+ * Program Status
803
+ *
804
+ * Publishes status messages for programs running in an app within a cell.
805
+ * The status messages provide information about the current state of a program run.
806
+ *
807
+ * @operationId publishProgramStatus
808
+ */
809
+ "nova.v2.cells.{cell}.programs": ProgramStatus
810
+ /**
811
+ * Robot Controller Configuration
812
+ *
813
+ * Publishes the configuration of a robot controller.
814
+ *
815
+ * @operationId publishRobotController
816
+ */
817
+ "nova.v2.cells.{cell}.controllers.{controller}": RobotController
818
+ /**
819
+ * Service Status
820
+ *
821
+ * Publishes the status of all cell resources.
822
+ *
823
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
824
+ *
825
+ * @operationId publishCellStatus
826
+ */
827
+ "nova.v2.cells.{cell}.status": ServiceStatusList
828
+ /**
829
+ * Cell Cycle Event
830
+ *
831
+ * Publishes the cycle events for a cell.
832
+ *
833
+ * @operationId publishCellCycle
834
+ */
835
+ "nova.v2.cells.{cell}.cycle": CellCycleEvent
836
+ /**
837
+ * Wandelbots NOVA status
838
+ *
839
+ * Publishes the status of all system services.
840
+ *
841
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
842
+ *
843
+ * @operationId publishSystemStatus
844
+ */
845
+ "nova.v2.system.status": ServiceStatusList
846
+ /**
847
+ * Collision Setup
848
+ *
849
+ * Publishes the stored collision setup.
850
+ *
851
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
852
+ *
853
+ * @operationId publishCollisionSetup
854
+ */
855
+ "nova.v2.cells.{cell}.collision.setups.{setup}": CollisionSetup
856
+ /**
857
+ * BUS Inputs/Outputs Service Status
858
+ *
859
+ * Publishes the status of BUS inputs/outputs service.
860
+ *
861
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`.
862
+ *
863
+ * @operationId publishBUSIOStatus
864
+ */
865
+ "nova.v2.cells.{cell}.bus-ios.status": BusIOsState
866
+ /**
867
+ * BUS Input/Output Values
868
+ *
869
+ * Publishes updates of BUS input/output values.
870
+ *
871
+ * @operationId publishBUSIOsIOs
872
+ */
873
+ "nova.v2.cells.{cell}.bus-ios.ios": ListIOValuesResponse
874
+ /**
875
+ * Set Output Values
876
+ *
877
+ * Set output values published with the BUS inputs/outputs service.
878
+ * If you're using a virtual service, you can set inputs as well.
879
+ *
880
+ * @operationId setBUSIOsIOs
881
+ */
882
+ "nova.v2.cells.{cell}.bus-ios.ios.set": ListIOValuesResponse
883
+ /**
884
+ * Select Input/Output Values
885
+ *
886
+ * Select input/output values published by the controller.
887
+ *
888
+ * @operationId selectRobotControllerIOs
889
+ */
890
+ "nova.v2.cells.{cell}.controllers.{controller}.ios.select": SelectIOs
891
+ /**
892
+ * Input/Output Values
893
+ *
894
+ * Publishes updates of input/output values.
895
+ *
896
+ * @operationId publishRobotControllerIOs
897
+ */
898
+ "nova.v2.cells.{cell}.controllers.{controller}.ios": StreamIOValuesResponse
899
+ /**
900
+ * State of Robot Controller
901
+ *
902
+ * Publishes the current state of a robot controller.
903
+ *
904
+ * @operationId publishRobotControllersState
905
+ */
906
+ "nova.v2.cells.{cell}.controllers.{controller}.state": RobotControllerState
907
+ /**
908
+ * Description of Motion Group
909
+ *
910
+ * Publishes the description of a motion group, including TCPs, mounting, safety zones, limits, etc.
911
+ *
912
+ * @operationId publishMotionGroupDescription
913
+ */
914
+ "nova.v2.cells.{cell}.controllers.{controller}.motion-groups.{motion-group}.description": MotionGroupDescription
915
+ /**
916
+ * System Update Started
917
+ *
918
+ * Publishes an event when a system update process is initiated.
919
+ *
920
+ * This event is triggered once the service-manager begins a system update process,
921
+ * providing details about the update metadata, trigger information, and pre-update checks.
922
+ *
923
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
924
+ * for reliable delivery and event replay capabilities.
925
+ *
926
+ * @operationId eventSystemUpdateStarted
927
+ */
928
+ "nova.v2.events.system.update.started": SystemUpdateStartedEvent
929
+ /**
930
+ * System Update Completed
931
+ *
932
+ * Publishes an event when a system update process is completed.
933
+ *
934
+ * This event is triggered once the service-manager completes a system update process,
935
+ * providing comprehensive results including success status, component outcomes,
936
+ * error details, and post-update validation results.
937
+ *
938
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
939
+ * for reliable delivery and event replay capabilities.
940
+ *
941
+ * @operationId eventSystemUpdateCompleted
942
+ */
943
+ "nova.v2.events.system.update.completed": SystemUpdateCompletedEvent
944
+ /**
945
+ * System Network Status Changed
946
+ *
947
+ * Publishes an event when a system network status changes.
948
+ *
949
+ * This event is triggered once system-info service detects a change in the system network status,
950
+ * providing details about the new network state and related information.
951
+ *
952
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
953
+ * for reliable delivery and event replay capabilities.
954
+ *
955
+ * @operationId eventSystemNetworkStatusChanged
956
+ */
957
+ "nova.v2.events.system.network.status.changed": NetworkStatusChangedEvent
958
+ /**
959
+ * Cell Created
960
+ *
961
+ * Publishes an event when a cell foundation release is created.
962
+ *
963
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
964
+ *
965
+ * @operationId eventCellCreated
966
+ */
967
+ "nova.v2.events.cells.{cell}.created": CellCreatedEvent
968
+ /**
969
+ * Cell Updated
970
+ *
971
+ * Publishes an event when a cell foundation release is updated.
972
+ *
973
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
974
+ *
975
+ * @operationId eventCellUpdated
976
+ */
977
+ "nova.v2.events.cells.{cell}.updated": CellUpdatedEvent
978
+ /**
979
+ * Cell Deleted
980
+ *
981
+ * Publishes an event when a cell foundation release is deleted.
982
+ *
983
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
984
+ *
985
+ * @operationId eventCellDeleted
986
+ */
987
+ "nova.v2.events.cells.{cell}.deleted": CellDeletedEvent
988
+ /**
989
+ * App Created
990
+ *
991
+ * Publishes an event when an app release is created in a cell.
992
+ *
993
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
994
+ *
995
+ * @operationId eventAppCreated
996
+ */
997
+ "nova.v2.events.cells.{cell}.apps.{app}.created": AppCreatedEvent
998
+ /**
999
+ * App Updated
1000
+ *
1001
+ * Publishes an event when an app release is updated in a cell.
1002
+ *
1003
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
1004
+ *
1005
+ * @operationId eventAppUpdated
1006
+ */
1007
+ "nova.v2.events.cells.{cell}.apps.{app}.updated": AppUpdatedEvent
1008
+ /**
1009
+ * App Deleted
1010
+ *
1011
+ * Publishes an event when an app release is deleted from a cell.
1012
+ *
1013
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
1014
+ *
1015
+ * @operationId eventAppDeleted
1016
+ */
1017
+ "nova.v2.events.cells.{cell}.apps.{app}.deleted": AppDeletedEvent
1018
+ /**
1019
+ * Robot Controller Created
1020
+ *
1021
+ * Publishes an event when a robot controller release is created in a cell.
1022
+ *
1023
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
1024
+ *
1025
+ * @operationId eventRobotControllerCreated
1026
+ */
1027
+ "nova.v2.events.cells.{cell}.controllers.{controller}.created": RobotControllerCreatedEvent
1028
+ /**
1029
+ * Robot Controller Updated
1030
+ *
1031
+ * Publishes an event when a robot controller release is updated in a cell.
1032
+ *
1033
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
1034
+ *
1035
+ * @operationId eventRobotControllerUpdated
1036
+ */
1037
+ "nova.v2.events.cells.{cell}.controllers.{controller}.updated": RobotControllerUpdatedEvent
1038
+ /**
1039
+ * Robot Controller Deleted
1040
+ *
1041
+ * Publishes an event when a robot controller release is deleted from a cell.
1042
+ *
1043
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
1044
+ *
1045
+ * @operationId eventRobotControllerDeleted
1046
+ */
1047
+ "nova.v2.events.cells.{cell}.controllers.{controller}.deleted": RobotControllerDeletedEvent
1048
+ }
1049
+
1050
+ export type NatsPublishSubject = keyof NatsPublishPayloads