@wandelbots/nova-js 3.13.0-pr.307.64cc6ba → 3.13.0-pr.307.720787b

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.
@@ -1,3 +1,4 @@
1
+ import { t as Nova } from "../../Nova-B1o5iTQ6.cjs";
1
2
  import { ConnectionOptions, Msg, NatsConnection } from "@nats-io/nats-core";
2
3
 
3
4
  //#region src/lib/experimental/nats/buildNatsServerUrl.d.ts
@@ -2005,193 +2006,1017 @@ interface NatsErrorPayload {
2005
2006
  //#region src/lib/experimental/nats/generated/operations.d.ts
2006
2007
  /** Subject parameters required by each NATS subject, e.g. "nova.v2.cells.{cell}". */
2007
2008
  interface NatsOperationParams {
2008
- /** publishCell */
2009
+ /**
2010
+ * Cell Configuration
2011
+ *
2012
+ * Publishes the configuration for a cell.
2013
+ *
2014
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2015
+ *
2016
+ * @operationId publishCell
2017
+ */
2009
2018
  "nova.v2.cells.{cell}": {
2019
+ /**
2020
+ * Unique identifier addressing a cell in all API calls.
2021
+ */
2010
2022
  cell: string;
2011
2023
  };
2012
- /** publishApp */
2024
+ /**
2025
+ * App Configuration
2026
+ *
2027
+ * Publishes the configuration for a GUI application in the cell.
2028
+ *
2029
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2030
+ *
2031
+ * @operationId publishApp
2032
+ */
2013
2033
  "nova.v2.cells.{cell}.apps.{app}": {
2034
+ /**
2035
+ * Unique identifier addressing a cell in all API calls.
2036
+ */
2014
2037
  cell: string;
2038
+ /**
2039
+ * Name of the provided application.
2040
+ * 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.
2041
+ */
2015
2042
  app: string;
2016
2043
  };
2017
- /** publishProgramStatus */
2044
+ /**
2045
+ * Program Status
2046
+ *
2047
+ * Publishes status messages for programs running in an app within a cell.
2048
+ * The status messages provide information about the current state of a program run.
2049
+ *
2050
+ * @operationId publishProgramStatus
2051
+ */
2018
2052
  "nova.v2.cells.{cell}.programs": {
2053
+ /**
2054
+ * Unique identifier addressing a cell in all API calls.
2055
+ */
2019
2056
  cell: string;
2020
2057
  };
2021
- /** publishRobotController */
2058
+ /**
2059
+ * Robot Controller Configuration
2060
+ *
2061
+ * Publishes the configuration of a robot controller.
2062
+ *
2063
+ * @operationId publishRobotController
2064
+ */
2022
2065
  "nova.v2.cells.{cell}.controllers.{controller}": {
2066
+ /**
2067
+ * Unique identifier addressing a cell in all API calls.
2068
+ */
2023
2069
  cell: string;
2070
+ /**
2071
+ * Unique identifier to address a controller in the cell.
2072
+ */
2024
2073
  controller: string;
2025
2074
  };
2026
- /** publishCellStatus */
2075
+ /**
2076
+ * Service Status
2077
+ *
2078
+ * Publishes the status of all cell resources.
2079
+ *
2080
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2081
+ *
2082
+ * @operationId publishCellStatus
2083
+ */
2027
2084
  "nova.v2.cells.{cell}.status": {
2085
+ /**
2086
+ * Unique identifier addressing a cell in all API calls.
2087
+ */
2028
2088
  cell: string;
2029
2089
  };
2030
- /** publishCellCycle */
2090
+ /**
2091
+ * Cell Cycle Event
2092
+ *
2093
+ * Publishes the cycle events for a cell.
2094
+ *
2095
+ * @operationId publishCellCycle
2096
+ */
2031
2097
  "nova.v2.cells.{cell}.cycle": {
2098
+ /**
2099
+ * Unique identifier addressing a cell in all API calls.
2100
+ */
2032
2101
  cell: string;
2033
2102
  };
2034
- /** publishSystemStatus */
2035
- "nova.v2.system.status": Record<string, never>;
2036
- /** publishCollisionSetup */
2103
+ /**
2104
+ * Wandelbots NOVA status
2105
+ *
2106
+ * Publishes the status of all system services.
2107
+ *
2108
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2109
+ *
2110
+ * @operationId publishSystemStatus
2111
+ */
2112
+ "nova.v2.system.status": Record<never, never>;
2113
+ /**
2114
+ * Collision Setup
2115
+ *
2116
+ * Publishes the stored collision setup.
2117
+ *
2118
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2119
+ *
2120
+ * @operationId publishCollisionSetup
2121
+ */
2037
2122
  "nova.v2.cells.{cell}.collision.setups.{setup}": {
2123
+ /**
2124
+ * Unique identifier addressing a cell in all API calls.
2125
+ */
2038
2126
  cell: string;
2127
+ /**
2128
+ * Unique identifier addressing a collision setup.
2129
+ */
2039
2130
  setup: string;
2040
2131
  };
2041
- /** publishBUSIOStatus */
2132
+ /**
2133
+ * BUS Inputs/Outputs Service Status
2134
+ *
2135
+ * Publishes the status of BUS inputs/outputs service.
2136
+ *
2137
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`.
2138
+ *
2139
+ * @operationId publishBUSIOStatus
2140
+ */
2042
2141
  "nova.v2.cells.{cell}.bus-ios.status": {
2142
+ /**
2143
+ * Unique identifier addressing a cell in all API calls.
2144
+ */
2043
2145
  cell: string;
2044
2146
  };
2045
- /** publishBUSIOsIOs */
2147
+ /**
2148
+ * BUS Input/Output Values
2149
+ *
2150
+ * Publishes updates of BUS input/output values.
2151
+ *
2152
+ * @operationId publishBUSIOsIOs
2153
+ */
2046
2154
  "nova.v2.cells.{cell}.bus-ios.ios": {
2155
+ /**
2156
+ * Unique identifier addressing a cell in all API calls.
2157
+ */
2047
2158
  cell: string;
2048
2159
  };
2049
- /** setBUSIOsIOs */
2160
+ /**
2161
+ * Set Output Values
2162
+ *
2163
+ * Set output values published with the BUS inputs/outputs service.
2164
+ * If you're using a virtual service, you can set inputs as well.
2165
+ *
2166
+ * @operationId setBUSIOsIOs
2167
+ */
2050
2168
  "nova.v2.cells.{cell}.bus-ios.ios.set": {
2169
+ /**
2170
+ * Unique identifier addressing a cell in all API calls.
2171
+ */
2051
2172
  cell: string;
2052
2173
  };
2053
- /** selectRobotControllerIOs */
2174
+ /**
2175
+ * Select Input/Output Values
2176
+ *
2177
+ * Select input/output values published by the controller.
2178
+ *
2179
+ * @operationId selectRobotControllerIOs
2180
+ */
2054
2181
  "nova.v2.cells.{cell}.controllers.{controller}.ios.select": {
2182
+ /**
2183
+ * Unique identifier addressing a cell in all API calls.
2184
+ */
2055
2185
  cell: string;
2186
+ /**
2187
+ * Unique identifier to address a controller in a cell.
2188
+ */
2056
2189
  controller: string;
2057
2190
  };
2058
- /** publishRobotControllerIOs */
2191
+ /**
2192
+ * Input/Output Values
2193
+ *
2194
+ * Publishes updates of input/output values.
2195
+ *
2196
+ * @operationId publishRobotControllerIOs
2197
+ */
2059
2198
  "nova.v2.cells.{cell}.controllers.{controller}.ios": {
2199
+ /**
2200
+ * Unique identifier addressing a cell in all API calls.
2201
+ */
2060
2202
  cell: string;
2203
+ /**
2204
+ * Unique identifier to address a controller in the cell.
2205
+ */
2061
2206
  controller: string;
2062
2207
  };
2063
- /** publishRobotControllersState */
2208
+ /**
2209
+ * State of Robot Controller
2210
+ *
2211
+ * Publishes the current state of a robot controller.
2212
+ *
2213
+ * @operationId publishRobotControllersState
2214
+ */
2064
2215
  "nova.v2.cells.{cell}.controllers.{controller}.state": {
2216
+ /**
2217
+ * Unique identifier addressing a cell in all API calls.
2218
+ */
2065
2219
  cell: string;
2220
+ /**
2221
+ * Unique identifier to address a controller in the cell.
2222
+ */
2066
2223
  controller: string;
2067
2224
  };
2068
- /** publishMotionGroupDescription */
2225
+ /**
2226
+ * Description of Motion Group
2227
+ *
2228
+ * Publishes the description of a motion group, including TCPs, mounting, safety zones, limits, etc.
2229
+ *
2230
+ * @operationId publishMotionGroupDescription
2231
+ */
2069
2232
  "nova.v2.cells.{cell}.controllers.{controller}.motion-groups.{motion-group}.description": {
2233
+ /**
2234
+ * Unique identifier addressing a cell in all API calls.
2235
+ */
2070
2236
  cell: string;
2237
+ /**
2238
+ * Unique identifier addressing a controller in the cell.
2239
+ */
2071
2240
  controller: string;
2241
+ /**
2242
+ * Motion group identifier.
2243
+ */
2072
2244
  "motion-group": string;
2073
2245
  };
2074
- /** eventSystemUpdateStarted */
2075
- "nova.v2.events.system.update.started": Record<string, never>;
2076
- /** eventSystemUpdateCompleted */
2077
- "nova.v2.events.system.update.completed": Record<string, never>;
2078
- /** eventSystemNetworkStatusChanged */
2079
- "nova.v2.events.system.network.status.changed": Record<string, never>;
2080
- /** eventCellCreated */
2246
+ /**
2247
+ * System Update Started
2248
+ *
2249
+ * Publishes an event when a system update process is initiated.
2250
+ *
2251
+ * This event is triggered once the service-manager begins a system update process,
2252
+ * providing details about the update metadata, trigger information, and pre-update checks.
2253
+ *
2254
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
2255
+ * for reliable delivery and event replay capabilities.
2256
+ *
2257
+ * @operationId eventSystemUpdateStarted
2258
+ */
2259
+ "nova.v2.events.system.update.started": Record<never, never>;
2260
+ /**
2261
+ * System Update Completed
2262
+ *
2263
+ * Publishes an event when a system update process is completed.
2264
+ *
2265
+ * This event is triggered once the service-manager completes a system update process,
2266
+ * providing comprehensive results including success status, component outcomes,
2267
+ * error details, and post-update validation results.
2268
+ *
2269
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
2270
+ * for reliable delivery and event replay capabilities.
2271
+ *
2272
+ * @operationId eventSystemUpdateCompleted
2273
+ */
2274
+ "nova.v2.events.system.update.completed": Record<never, never>;
2275
+ /**
2276
+ * System Network Status Changed
2277
+ *
2278
+ * Publishes an event when a system network status changes.
2279
+ *
2280
+ * This event is triggered once system-info service detects a change in the system network status,
2281
+ * providing details about the new network state and related information.
2282
+ *
2283
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
2284
+ * for reliable delivery and event replay capabilities.
2285
+ *
2286
+ * @operationId eventSystemNetworkStatusChanged
2287
+ */
2288
+ "nova.v2.events.system.network.status.changed": Record<never, never>;
2289
+ /**
2290
+ * Cell Created
2291
+ *
2292
+ * Publishes an event when a cell foundation release is created.
2293
+ *
2294
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2295
+ *
2296
+ * @operationId eventCellCreated
2297
+ */
2081
2298
  "nova.v2.events.cells.{cell}.created": {
2299
+ /**
2300
+ * Unique identifier addressing a cell in all API calls.
2301
+ */
2082
2302
  cell: string;
2083
2303
  };
2084
- /** eventCellUpdated */
2304
+ /**
2305
+ * Cell Updated
2306
+ *
2307
+ * Publishes an event when a cell foundation release is updated.
2308
+ *
2309
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2310
+ *
2311
+ * @operationId eventCellUpdated
2312
+ */
2085
2313
  "nova.v2.events.cells.{cell}.updated": {
2314
+ /**
2315
+ * Unique identifier addressing a cell in all API calls.
2316
+ */
2086
2317
  cell: string;
2087
2318
  };
2088
- /** eventCellDeleted */
2319
+ /**
2320
+ * Cell Deleted
2321
+ *
2322
+ * Publishes an event when a cell foundation release is deleted.
2323
+ *
2324
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2325
+ *
2326
+ * @operationId eventCellDeleted
2327
+ */
2089
2328
  "nova.v2.events.cells.{cell}.deleted": {
2329
+ /**
2330
+ * Unique identifier addressing a cell in all API calls.
2331
+ */
2090
2332
  cell: string;
2091
2333
  };
2092
- /** eventAppCreated */
2334
+ /**
2335
+ * App Created
2336
+ *
2337
+ * Publishes an event when an app release is created in a cell.
2338
+ *
2339
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2340
+ *
2341
+ * @operationId eventAppCreated
2342
+ */
2093
2343
  "nova.v2.events.cells.{cell}.apps.{app}.created": {
2344
+ /**
2345
+ * Unique identifier addressing a cell in all API calls.
2346
+ */
2094
2347
  cell: string;
2348
+ /**
2349
+ * Unique identifier addressing an app in the cell.
2350
+ */
2095
2351
  app: string;
2096
2352
  };
2097
- /** eventAppUpdated */
2353
+ /**
2354
+ * App Updated
2355
+ *
2356
+ * Publishes an event when an app release is updated in a cell.
2357
+ *
2358
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2359
+ *
2360
+ * @operationId eventAppUpdated
2361
+ */
2098
2362
  "nova.v2.events.cells.{cell}.apps.{app}.updated": {
2363
+ /**
2364
+ * Unique identifier addressing a cell in all API calls.
2365
+ */
2099
2366
  cell: string;
2367
+ /**
2368
+ * Unique identifier addressing an app in the cell.
2369
+ */
2100
2370
  app: string;
2101
2371
  };
2102
- /** eventAppDeleted */
2372
+ /**
2373
+ * App Deleted
2374
+ *
2375
+ * Publishes an event when an app release is deleted from a cell.
2376
+ *
2377
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2378
+ *
2379
+ * @operationId eventAppDeleted
2380
+ */
2103
2381
  "nova.v2.events.cells.{cell}.apps.{app}.deleted": {
2382
+ /**
2383
+ * Unique identifier addressing a cell in all API calls.
2384
+ */
2104
2385
  cell: string;
2386
+ /**
2387
+ * Unique identifier addressing an app in the cell.
2388
+ */
2105
2389
  app: string;
2106
2390
  };
2107
- /** eventRobotControllerCreated */
2391
+ /**
2392
+ * Robot Controller Created
2393
+ *
2394
+ * Publishes an event when a robot controller release is created in a cell.
2395
+ *
2396
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2397
+ *
2398
+ * @operationId eventRobotControllerCreated
2399
+ */
2108
2400
  "nova.v2.events.cells.{cell}.controllers.{controller}.created": {
2401
+ /**
2402
+ * Unique identifier addressing a cell in all API calls.
2403
+ */
2109
2404
  cell: string;
2405
+ /**
2406
+ * Unique identifier to address a controller in the cell.
2407
+ */
2110
2408
  controller: string;
2111
2409
  };
2112
- /** eventRobotControllerUpdated */
2410
+ /**
2411
+ * Robot Controller Updated
2412
+ *
2413
+ * Publishes an event when a robot controller release is updated in a cell.
2414
+ *
2415
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2416
+ *
2417
+ * @operationId eventRobotControllerUpdated
2418
+ */
2113
2419
  "nova.v2.events.cells.{cell}.controllers.{controller}.updated": {
2420
+ /**
2421
+ * Unique identifier addressing a cell in all API calls.
2422
+ */
2114
2423
  cell: string;
2424
+ /**
2425
+ * Unique identifier to address a controller in the cell.
2426
+ */
2115
2427
  controller: string;
2116
2428
  };
2117
- /** eventRobotControllerDeleted */
2429
+ /**
2430
+ * Robot Controller Deleted
2431
+ *
2432
+ * Publishes an event when a robot controller release is deleted from a cell.
2433
+ *
2434
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2435
+ *
2436
+ * @operationId eventRobotControllerDeleted
2437
+ */
2118
2438
  "nova.v2.events.cells.{cell}.controllers.{controller}.deleted": {
2439
+ /**
2440
+ * Unique identifier addressing a cell in all API calls.
2441
+ */
2119
2442
  cell: string;
2443
+ /**
2444
+ * Unique identifier to address a controller in the cell.
2445
+ */
2120
2446
  controller: string;
2121
2447
  };
2122
2448
  }
2123
2449
  /** Payload types for subjects the server publishes and the client subscribes to. */
2124
2450
  interface NatsSubscribePayloads {
2125
- /** publishCell */
2451
+ /**
2452
+ * Cell Configuration
2453
+ *
2454
+ * Publishes the configuration for a cell.
2455
+ *
2456
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2457
+ *
2458
+ * @operationId publishCell
2459
+ */
2126
2460
  "nova.v2.cells.{cell}": Cell;
2127
- /** publishApp */
2461
+ /**
2462
+ * App Configuration
2463
+ *
2464
+ * Publishes the configuration for a GUI application in the cell.
2465
+ *
2466
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2467
+ *
2468
+ * @operationId publishApp
2469
+ */
2128
2470
  "nova.v2.cells.{cell}.apps.{app}": App;
2129
- /** publishProgramStatus */
2471
+ /**
2472
+ * Program Status
2473
+ *
2474
+ * Publishes status messages for programs running in an app within a cell.
2475
+ * The status messages provide information about the current state of a program run.
2476
+ *
2477
+ * @operationId publishProgramStatus
2478
+ */
2130
2479
  "nova.v2.cells.{cell}.programs": ProgramStatus;
2131
- /** publishRobotController */
2480
+ /**
2481
+ * Robot Controller Configuration
2482
+ *
2483
+ * Publishes the configuration of a robot controller.
2484
+ *
2485
+ * @operationId publishRobotController
2486
+ */
2132
2487
  "nova.v2.cells.{cell}.controllers.{controller}": RobotController;
2133
- /** publishCellStatus */
2488
+ /**
2489
+ * Service Status
2490
+ *
2491
+ * Publishes the status of all cell resources.
2492
+ *
2493
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2494
+ *
2495
+ * @operationId publishCellStatus
2496
+ */
2134
2497
  "nova.v2.cells.{cell}.status": ServiceStatusList;
2135
- /** publishCellCycle */
2498
+ /**
2499
+ * Cell Cycle Event
2500
+ *
2501
+ * Publishes the cycle events for a cell.
2502
+ *
2503
+ * @operationId publishCellCycle
2504
+ */
2136
2505
  "nova.v2.cells.{cell}.cycle": CellCycleEvent;
2137
- /** publishSystemStatus */
2506
+ /**
2507
+ * Wandelbots NOVA status
2508
+ *
2509
+ * Publishes the status of all system services.
2510
+ *
2511
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2512
+ *
2513
+ * @operationId publishSystemStatus
2514
+ */
2138
2515
  "nova.v2.system.status": ServiceStatusList;
2139
- /** publishCollisionSetup */
2516
+ /**
2517
+ * Collision Setup
2518
+ *
2519
+ * Publishes the stored collision setup.
2520
+ *
2521
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2522
+ *
2523
+ * @operationId publishCollisionSetup
2524
+ */
2140
2525
  "nova.v2.cells.{cell}.collision.setups.{setup}": CollisionSetup;
2141
- /** publishBUSIOStatus */
2526
+ /**
2527
+ * BUS Inputs/Outputs Service Status
2528
+ *
2529
+ * Publishes the status of BUS inputs/outputs service.
2530
+ *
2531
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`.
2532
+ *
2533
+ * @operationId publishBUSIOStatus
2534
+ */
2142
2535
  "nova.v2.cells.{cell}.bus-ios.status": BusIOsState;
2143
- /** publishBUSIOsIOs */
2536
+ /**
2537
+ * BUS Input/Output Values
2538
+ *
2539
+ * Publishes updates of BUS input/output values.
2540
+ *
2541
+ * @operationId publishBUSIOsIOs
2542
+ */
2144
2543
  "nova.v2.cells.{cell}.bus-ios.ios": ListIOValuesResponse;
2145
- /** publishRobotControllerIOs */
2544
+ /**
2545
+ * Input/Output Values
2546
+ *
2547
+ * Publishes updates of input/output values.
2548
+ *
2549
+ * @operationId publishRobotControllerIOs
2550
+ */
2146
2551
  "nova.v2.cells.{cell}.controllers.{controller}.ios": StreamIOValuesResponse;
2147
- /** publishRobotControllersState */
2552
+ /**
2553
+ * State of Robot Controller
2554
+ *
2555
+ * Publishes the current state of a robot controller.
2556
+ *
2557
+ * @operationId publishRobotControllersState
2558
+ */
2148
2559
  "nova.v2.cells.{cell}.controllers.{controller}.state": RobotControllerState;
2149
- /** publishMotionGroupDescription */
2560
+ /**
2561
+ * Description of Motion Group
2562
+ *
2563
+ * Publishes the description of a motion group, including TCPs, mounting, safety zones, limits, etc.
2564
+ *
2565
+ * @operationId publishMotionGroupDescription
2566
+ */
2150
2567
  "nova.v2.cells.{cell}.controllers.{controller}.motion-groups.{motion-group}.description": MotionGroupDescription;
2151
- /** eventSystemUpdateStarted */
2568
+ /**
2569
+ * System Update Started
2570
+ *
2571
+ * Publishes an event when a system update process is initiated.
2572
+ *
2573
+ * This event is triggered once the service-manager begins a system update process,
2574
+ * providing details about the update metadata, trigger information, and pre-update checks.
2575
+ *
2576
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
2577
+ * for reliable delivery and event replay capabilities.
2578
+ *
2579
+ * @operationId eventSystemUpdateStarted
2580
+ */
2152
2581
  "nova.v2.events.system.update.started": SystemUpdateStartedEvent;
2153
- /** eventSystemUpdateCompleted */
2582
+ /**
2583
+ * System Update Completed
2584
+ *
2585
+ * Publishes an event when a system update process is completed.
2586
+ *
2587
+ * This event is triggered once the service-manager completes a system update process,
2588
+ * providing comprehensive results including success status, component outcomes,
2589
+ * error details, and post-update validation results.
2590
+ *
2591
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
2592
+ * for reliable delivery and event replay capabilities.
2593
+ *
2594
+ * @operationId eventSystemUpdateCompleted
2595
+ */
2154
2596
  "nova.v2.events.system.update.completed": SystemUpdateCompletedEvent;
2155
- /** eventSystemNetworkStatusChanged */
2597
+ /**
2598
+ * System Network Status Changed
2599
+ *
2600
+ * Publishes an event when a system network status changes.
2601
+ *
2602
+ * This event is triggered once system-info service detects a change in the system network status,
2603
+ * providing details about the new network state and related information.
2604
+ *
2605
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
2606
+ * for reliable delivery and event replay capabilities.
2607
+ *
2608
+ * @operationId eventSystemNetworkStatusChanged
2609
+ */
2156
2610
  "nova.v2.events.system.network.status.changed": NetworkStatusChangedEvent;
2157
- /** eventCellCreated */
2611
+ /**
2612
+ * Cell Created
2613
+ *
2614
+ * Publishes an event when a cell foundation release is created.
2615
+ *
2616
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2617
+ *
2618
+ * @operationId eventCellCreated
2619
+ */
2158
2620
  "nova.v2.events.cells.{cell}.created": CellCreatedEvent;
2159
- /** eventCellUpdated */
2621
+ /**
2622
+ * Cell Updated
2623
+ *
2624
+ * Publishes an event when a cell foundation release is updated.
2625
+ *
2626
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2627
+ *
2628
+ * @operationId eventCellUpdated
2629
+ */
2160
2630
  "nova.v2.events.cells.{cell}.updated": CellUpdatedEvent;
2161
- /** eventCellDeleted */
2631
+ /**
2632
+ * Cell Deleted
2633
+ *
2634
+ * Publishes an event when a cell foundation release is deleted.
2635
+ *
2636
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2637
+ *
2638
+ * @operationId eventCellDeleted
2639
+ */
2162
2640
  "nova.v2.events.cells.{cell}.deleted": CellDeletedEvent;
2163
- /** eventAppCreated */
2641
+ /**
2642
+ * App Created
2643
+ *
2644
+ * Publishes an event when an app release is created in a cell.
2645
+ *
2646
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2647
+ *
2648
+ * @operationId eventAppCreated
2649
+ */
2164
2650
  "nova.v2.events.cells.{cell}.apps.{app}.created": AppCreatedEvent;
2165
- /** eventAppUpdated */
2651
+ /**
2652
+ * App Updated
2653
+ *
2654
+ * Publishes an event when an app release is updated in a cell.
2655
+ *
2656
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2657
+ *
2658
+ * @operationId eventAppUpdated
2659
+ */
2166
2660
  "nova.v2.events.cells.{cell}.apps.{app}.updated": AppUpdatedEvent;
2167
- /** eventAppDeleted */
2661
+ /**
2662
+ * App Deleted
2663
+ *
2664
+ * Publishes an event when an app release is deleted from a cell.
2665
+ *
2666
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2667
+ *
2668
+ * @operationId eventAppDeleted
2669
+ */
2168
2670
  "nova.v2.events.cells.{cell}.apps.{app}.deleted": AppDeletedEvent;
2169
- /** eventRobotControllerCreated */
2671
+ /**
2672
+ * Robot Controller Created
2673
+ *
2674
+ * Publishes an event when a robot controller release is created in a cell.
2675
+ *
2676
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2677
+ *
2678
+ * @operationId eventRobotControllerCreated
2679
+ */
2170
2680
  "nova.v2.events.cells.{cell}.controllers.{controller}.created": RobotControllerCreatedEvent;
2171
- /** eventRobotControllerUpdated */
2681
+ /**
2682
+ * Robot Controller Updated
2683
+ *
2684
+ * Publishes an event when a robot controller release is updated in a cell.
2685
+ *
2686
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2687
+ *
2688
+ * @operationId eventRobotControllerUpdated
2689
+ */
2172
2690
  "nova.v2.events.cells.{cell}.controllers.{controller}.updated": RobotControllerUpdatedEvent;
2173
- /** eventRobotControllerDeleted */
2691
+ /**
2692
+ * Robot Controller Deleted
2693
+ *
2694
+ * Publishes an event when a robot controller release is deleted from a cell.
2695
+ *
2696
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2697
+ *
2698
+ * @operationId eventRobotControllerDeleted
2699
+ */
2174
2700
  "nova.v2.events.cells.{cell}.controllers.{controller}.deleted": RobotControllerDeletedEvent;
2175
2701
  }
2176
2702
  type NatsSubscribeSubject = keyof NatsSubscribePayloads;
2177
2703
  /** Request payload types for subjects the client sends requests to. */
2178
2704
  interface NatsRequestPayloads {
2179
- /** setBUSIOsIOs */
2705
+ /**
2706
+ * Set Output Values
2707
+ *
2708
+ * Set output values published with the BUS inputs/outputs service.
2709
+ * If you're using a virtual service, you can set inputs as well.
2710
+ *
2711
+ * @operationId setBUSIOsIOs
2712
+ */
2180
2713
  "nova.v2.cells.{cell}.bus-ios.ios.set": ListIOValuesResponse;
2181
- /** selectRobotControllerIOs */
2714
+ /**
2715
+ * Select Input/Output Values
2716
+ *
2717
+ * Select input/output values published by the controller.
2718
+ *
2719
+ * @operationId selectRobotControllerIOs
2720
+ */
2182
2721
  "nova.v2.cells.{cell}.controllers.{controller}.ios.select": SelectIOs;
2183
2722
  }
2184
2723
  /** Reply payload types for request/reply subjects. */
2185
2724
  interface NatsReplyPayloads {
2186
- /** setBUSIOsIOs */
2725
+ /**
2726
+ * Set Output Values
2727
+ *
2728
+ * Set output values published with the BUS inputs/outputs service.
2729
+ * If you're using a virtual service, you can set inputs as well.
2730
+ *
2731
+ * @operationId setBUSIOsIOs
2732
+ */
2187
2733
  "nova.v2.cells.{cell}.bus-ios.ios.set": NatsErrorPayload;
2188
- /** selectRobotControllerIOs */
2734
+ /**
2735
+ * Select Input/Output Values
2736
+ *
2737
+ * Select input/output values published by the controller.
2738
+ *
2739
+ * @operationId selectRobotControllerIOs
2740
+ */
2189
2741
  "nova.v2.cells.{cell}.controllers.{controller}.ios.select": NatsErrorPayload;
2190
2742
  }
2191
2743
  type NatsRequestSubject = keyof NatsRequestPayloads;
2744
+ /** Payload types for every subject defined in the spec, publishable via NovaNatsClient#publish. */
2745
+ interface NatsPublishPayloads {
2746
+ /**
2747
+ * Cell Configuration
2748
+ *
2749
+ * Publishes the configuration for a cell.
2750
+ *
2751
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2752
+ *
2753
+ * @operationId publishCell
2754
+ */
2755
+ "nova.v2.cells.{cell}": Cell;
2756
+ /**
2757
+ * App Configuration
2758
+ *
2759
+ * Publishes the configuration for a GUI application in the cell.
2760
+ *
2761
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2762
+ *
2763
+ * @operationId publishApp
2764
+ */
2765
+ "nova.v2.cells.{cell}.apps.{app}": App;
2766
+ /**
2767
+ * Program Status
2768
+ *
2769
+ * Publishes status messages for programs running in an app within a cell.
2770
+ * The status messages provide information about the current state of a program run.
2771
+ *
2772
+ * @operationId publishProgramStatus
2773
+ */
2774
+ "nova.v2.cells.{cell}.programs": ProgramStatus;
2775
+ /**
2776
+ * Robot Controller Configuration
2777
+ *
2778
+ * Publishes the configuration of a robot controller.
2779
+ *
2780
+ * @operationId publishRobotController
2781
+ */
2782
+ "nova.v2.cells.{cell}.controllers.{controller}": RobotController;
2783
+ /**
2784
+ * Service Status
2785
+ *
2786
+ * Publishes the status of all cell resources.
2787
+ *
2788
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2789
+ *
2790
+ * @operationId publishCellStatus
2791
+ */
2792
+ "nova.v2.cells.{cell}.status": ServiceStatusList;
2793
+ /**
2794
+ * Cell Cycle Event
2795
+ *
2796
+ * Publishes the cycle events for a cell.
2797
+ *
2798
+ * @operationId publishCellCycle
2799
+ */
2800
+ "nova.v2.cells.{cell}.cycle": CellCycleEvent;
2801
+ /**
2802
+ * Wandelbots NOVA status
2803
+ *
2804
+ * Publishes the status of all system services.
2805
+ *
2806
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2807
+ *
2808
+ * @operationId publishSystemStatus
2809
+ */
2810
+ "nova.v2.system.status": ServiceStatusList;
2811
+ /**
2812
+ * Collision Setup
2813
+ *
2814
+ * Publishes the stored collision setup.
2815
+ *
2816
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`
2817
+ *
2818
+ * @operationId publishCollisionSetup
2819
+ */
2820
+ "nova.v2.cells.{cell}.collision.setups.{setup}": CollisionSetup;
2821
+ /**
2822
+ * BUS Inputs/Outputs Service Status
2823
+ *
2824
+ * Publishes the status of BUS inputs/outputs service.
2825
+ *
2826
+ * The latest status message is persisted NATS JetStream, documented in `x-nats-jetstream-stream`.
2827
+ *
2828
+ * @operationId publishBUSIOStatus
2829
+ */
2830
+ "nova.v2.cells.{cell}.bus-ios.status": BusIOsState;
2831
+ /**
2832
+ * BUS Input/Output Values
2833
+ *
2834
+ * Publishes updates of BUS input/output values.
2835
+ *
2836
+ * @operationId publishBUSIOsIOs
2837
+ */
2838
+ "nova.v2.cells.{cell}.bus-ios.ios": ListIOValuesResponse;
2839
+ /**
2840
+ * Set Output Values
2841
+ *
2842
+ * Set output values published with the BUS inputs/outputs service.
2843
+ * If you're using a virtual service, you can set inputs as well.
2844
+ *
2845
+ * @operationId setBUSIOsIOs
2846
+ */
2847
+ "nova.v2.cells.{cell}.bus-ios.ios.set": ListIOValuesResponse;
2848
+ /**
2849
+ * Select Input/Output Values
2850
+ *
2851
+ * Select input/output values published by the controller.
2852
+ *
2853
+ * @operationId selectRobotControllerIOs
2854
+ */
2855
+ "nova.v2.cells.{cell}.controllers.{controller}.ios.select": SelectIOs;
2856
+ /**
2857
+ * Input/Output Values
2858
+ *
2859
+ * Publishes updates of input/output values.
2860
+ *
2861
+ * @operationId publishRobotControllerIOs
2862
+ */
2863
+ "nova.v2.cells.{cell}.controllers.{controller}.ios": StreamIOValuesResponse;
2864
+ /**
2865
+ * State of Robot Controller
2866
+ *
2867
+ * Publishes the current state of a robot controller.
2868
+ *
2869
+ * @operationId publishRobotControllersState
2870
+ */
2871
+ "nova.v2.cells.{cell}.controllers.{controller}.state": RobotControllerState;
2872
+ /**
2873
+ * Description of Motion Group
2874
+ *
2875
+ * Publishes the description of a motion group, including TCPs, mounting, safety zones, limits, etc.
2876
+ *
2877
+ * @operationId publishMotionGroupDescription
2878
+ */
2879
+ "nova.v2.cells.{cell}.controllers.{controller}.motion-groups.{motion-group}.description": MotionGroupDescription;
2880
+ /**
2881
+ * System Update Started
2882
+ *
2883
+ * Publishes an event when a system update process is initiated.
2884
+ *
2885
+ * This event is triggered once the service-manager begins a system update process,
2886
+ * providing details about the update metadata, trigger information, and pre-update checks.
2887
+ *
2888
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
2889
+ * for reliable delivery and event replay capabilities.
2890
+ *
2891
+ * @operationId eventSystemUpdateStarted
2892
+ */
2893
+ "nova.v2.events.system.update.started": SystemUpdateStartedEvent;
2894
+ /**
2895
+ * System Update Completed
2896
+ *
2897
+ * Publishes an event when a system update process is completed.
2898
+ *
2899
+ * This event is triggered once the service-manager completes a system update process,
2900
+ * providing comprehensive results including success status, component outcomes,
2901
+ * error details, and post-update validation results.
2902
+ *
2903
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
2904
+ * for reliable delivery and event replay capabilities.
2905
+ *
2906
+ * @operationId eventSystemUpdateCompleted
2907
+ */
2908
+ "nova.v2.events.system.update.completed": SystemUpdateCompletedEvent;
2909
+ /**
2910
+ * System Network Status Changed
2911
+ *
2912
+ * Publishes an event when a system network status changes.
2913
+ *
2914
+ * This event is triggered once system-info service detects a change in the system network status,
2915
+ * providing details about the new network state and related information.
2916
+ *
2917
+ * The event follows CloudEvents v1.0 specification and is persisted in NATS JetStream
2918
+ * for reliable delivery and event replay capabilities.
2919
+ *
2920
+ * @operationId eventSystemNetworkStatusChanged
2921
+ */
2922
+ "nova.v2.events.system.network.status.changed": NetworkStatusChangedEvent;
2923
+ /**
2924
+ * Cell Created
2925
+ *
2926
+ * Publishes an event when a cell foundation release is created.
2927
+ *
2928
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2929
+ *
2930
+ * @operationId eventCellCreated
2931
+ */
2932
+ "nova.v2.events.cells.{cell}.created": CellCreatedEvent;
2933
+ /**
2934
+ * Cell Updated
2935
+ *
2936
+ * Publishes an event when a cell foundation release is updated.
2937
+ *
2938
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2939
+ *
2940
+ * @operationId eventCellUpdated
2941
+ */
2942
+ "nova.v2.events.cells.{cell}.updated": CellUpdatedEvent;
2943
+ /**
2944
+ * Cell Deleted
2945
+ *
2946
+ * Publishes an event when a cell foundation release is deleted.
2947
+ *
2948
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2949
+ *
2950
+ * @operationId eventCellDeleted
2951
+ */
2952
+ "nova.v2.events.cells.{cell}.deleted": CellDeletedEvent;
2953
+ /**
2954
+ * App Created
2955
+ *
2956
+ * Publishes an event when an app release is created in a cell.
2957
+ *
2958
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2959
+ *
2960
+ * @operationId eventAppCreated
2961
+ */
2962
+ "nova.v2.events.cells.{cell}.apps.{app}.created": AppCreatedEvent;
2963
+ /**
2964
+ * App Updated
2965
+ *
2966
+ * Publishes an event when an app release is updated in a cell.
2967
+ *
2968
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2969
+ *
2970
+ * @operationId eventAppUpdated
2971
+ */
2972
+ "nova.v2.events.cells.{cell}.apps.{app}.updated": AppUpdatedEvent;
2973
+ /**
2974
+ * App Deleted
2975
+ *
2976
+ * Publishes an event when an app release is deleted from a cell.
2977
+ *
2978
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2979
+ *
2980
+ * @operationId eventAppDeleted
2981
+ */
2982
+ "nova.v2.events.cells.{cell}.apps.{app}.deleted": AppDeletedEvent;
2983
+ /**
2984
+ * Robot Controller Created
2985
+ *
2986
+ * Publishes an event when a robot controller release is created in a cell.
2987
+ *
2988
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2989
+ *
2990
+ * @operationId eventRobotControllerCreated
2991
+ */
2992
+ "nova.v2.events.cells.{cell}.controllers.{controller}.created": RobotControllerCreatedEvent;
2993
+ /**
2994
+ * Robot Controller Updated
2995
+ *
2996
+ * Publishes an event when a robot controller release is updated in a cell.
2997
+ *
2998
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
2999
+ *
3000
+ * @operationId eventRobotControllerUpdated
3001
+ */
3002
+ "nova.v2.events.cells.{cell}.controllers.{controller}.updated": RobotControllerUpdatedEvent;
3003
+ /**
3004
+ * Robot Controller Deleted
3005
+ *
3006
+ * Publishes an event when a robot controller release is deleted from a cell.
3007
+ *
3008
+ * The event follows CloudEvents v1.0 and is persisted in NATS JetStream for reliable delivery and replay capabilities.
3009
+ *
3010
+ * @operationId eventRobotControllerDeleted
3011
+ */
3012
+ "nova.v2.events.cells.{cell}.controllers.{controller}.deleted": RobotControllerDeletedEvent;
3013
+ }
3014
+ type NatsPublishSubject = keyof NatsPublishPayloads;
2192
3015
  //#endregion
2193
3016
  //#region src/lib/experimental/nats/NovaNatsClient.d.ts
2194
3017
  type NovaNatsClientConfig = ConnectionOptions;
3018
+ type NatsMessageHandler<K extends NatsSubscribeSubject> = (payload: NatsSubscribePayloads[K], msg: Msg) => void;
3019
+ type SubscribeArgs<K extends NatsSubscribeSubject> = keyof NatsOperationParams[K] extends never ? [handler: NatsMessageHandler<K>] : [params: NatsOperationParams[K], handler: NatsMessageHandler<K>];
2195
3020
  /**
2196
3021
  * Typed NATS client for the Wandelbots NOVA messaging API, generated from
2197
3022
  * src/asyncapi.yaml (see scripts/generate-nats-client.ts).
@@ -2201,7 +3026,7 @@ type NovaNatsClientConfig = ConnectionOptions;
2201
3026
  declare class NovaNatsClient {
2202
3027
  readonly config: NovaNatsClientConfig;
2203
3028
  private connectionPromise;
2204
- constructor(config: NovaNatsClientConfig);
3029
+ constructor(nova: Nova, config?: NovaNatsClientConfig);
2205
3030
  /**
2206
3031
  * Connects to NATS if not already connected or connecting, and returns the
2207
3032
  * connection. Safe to call concurrently: all callers share the same
@@ -2220,7 +3045,7 @@ declare class NovaNatsClient {
2220
3045
  *
2221
3046
  * Returns a function that unsubscribes when called.
2222
3047
  */
2223
- subscribe<K extends NatsSubscribeSubject>(subject: K, params: NatsOperationParams[K], handler: (payload: NatsSubscribePayloads[K], msg: Msg) => void): Promise<() => void>;
3048
+ subscribe<K extends NatsSubscribeSubject>(subject: K, ...args: SubscribeArgs<K>): Promise<() => void>;
2224
3049
  /**
2225
3050
  * Sends a request payload for a NATS subject the server receives, and
2226
3051
  * waits for the JSON-decoded reply.
@@ -2232,7 +3057,16 @@ declare class NovaNatsClient {
2232
3057
  request<K extends NatsRequestSubject>(subject: K, params: NatsOperationParams[K], payload: NatsRequestPayloads[K], opts?: {
2233
3058
  timeout?: number;
2234
3059
  }): Promise<NatsReplyPayloads[K]>;
3060
+ /**
3061
+ * Publishes a JSON payload to any NATS subject defined in the spec,
3062
+ * without waiting for a reply.
3063
+ *
3064
+ * `subject` is the subject template as it appears on the wire, e.g.
3065
+ * `"nova.v2.cells.{cell}.bus-ios.ios.set"`, with `{param}` placeholders
3066
+ * filled in from `params`.
3067
+ */
3068
+ publish<K extends NatsPublishSubject>(subject: K, params: NatsOperationParams[K], payload: NatsPublishPayloads[K]): Promise<void>;
2235
3069
  }
2236
3070
  //#endregion
2237
- export { type NatsOperationParams, type NatsReplyPayloads, type NatsRequestPayloads, type NatsRequestSubject, type NatsSubscribePayloads, type NatsSubscribeSubject, NovaNatsClient, type NovaNatsClientConfig, buildNatsServerUrl };
3071
+ export { type NatsOperationParams, type NatsPublishPayloads, type NatsPublishSubject, type NatsReplyPayloads, type NatsRequestPayloads, type NatsRequestSubject, type NatsSubscribePayloads, type NatsSubscribeSubject, NovaNatsClient, type NovaNatsClientConfig, buildNatsServerUrl };
2238
3072
  //# sourceMappingURL=index.d.cts.map