@wandelbots/nova-api 25.8.0-dev.5 → 25.8.0-dev.6

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 (3) hide show
  1. package/package.json +1 -1
  2. package/v2/api.d.ts +33 -13
  3. package/v2/api.ts +12 -12
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wandelbots/nova-api",
3
- "version": "25.8.0-dev.5",
3
+ "version": "25.8.0-dev.6",
4
4
  "description": "API Client to interact with Wandelbots Public API.",
5
5
  "files": [
6
6
  "*",
package/v2/api.d.ts CHANGED
@@ -2313,9 +2313,19 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
2313
2313
  * @type JoggingDetailsState
2314
2314
  * @export
2315
2315
  */
2316
- export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2317
- /**
2318
- *
2316
+ export type JoggingDetailsState = {
2317
+ kind: 'PAUSED_BY_USER';
2318
+ } & JoggingPausedByUser | {
2319
+ kind: 'PAUSED_NEAR_COLLISION';
2320
+ } & JoggingPausedNearCollision | {
2321
+ kind: 'PAUSED_NEAR_JOINT_LIMIT';
2322
+ } & JoggingPausedNearJointLimit | {
2323
+ kind: 'PAUSED_ON_IO';
2324
+ } & JoggingPausedOnIO | {
2325
+ kind: 'RUNNING';
2326
+ } & JoggingRunning;
2327
+ /**
2328
+ * User has paused jogging.
2319
2329
  * @export
2320
2330
  * @interface JoggingPausedByUser
2321
2331
  */
@@ -2332,7 +2342,7 @@ export declare const JoggingPausedByUserKindEnum: {
2332
2342
  };
2333
2343
  export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2334
2344
  /**
2335
- *
2345
+ * Jogging was paused because the motion group neared a collision.
2336
2346
  * @export
2337
2347
  * @interface JoggingPausedNearCollision
2338
2348
  */
@@ -2355,7 +2365,7 @@ export declare const JoggingPausedNearCollisionKindEnum: {
2355
2365
  };
2356
2366
  export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2357
2367
  /**
2358
- *
2368
+ * Jogging was paused because a joint is near its limit.
2359
2369
  * @export
2360
2370
  * @interface JoggingPausedNearJointLimit
2361
2371
  */
@@ -2378,7 +2388,7 @@ export declare const JoggingPausedNearJointLimitKindEnum: {
2378
2388
  };
2379
2389
  export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2380
2390
  /**
2381
- *
2391
+ * Jogging was paused because of an I/O event.
2382
2392
  * @export
2383
2393
  * @interface JoggingPausedOnIO
2384
2394
  */
@@ -2395,7 +2405,7 @@ export declare const JoggingPausedOnIOKindEnum: {
2395
2405
  };
2396
2406
  export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2397
2407
  /**
2398
- *
2408
+ * Jogging is active.
2399
2409
  * @export
2400
2410
  * @interface JoggingRunning
2401
2411
  */
@@ -4850,9 +4860,19 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
4850
4860
  * @type TrajectoryDetailsState
4851
4861
  * @export
4852
4862
  */
4853
- export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
4863
+ export type TrajectoryDetailsState = {
4864
+ kind: 'END_OF_TRAJECTORY';
4865
+ } & TrajectoryEnded | {
4866
+ kind: 'PAUSED_BY_USER';
4867
+ } & TrajectoryPausedByUser | {
4868
+ kind: 'PAUSED_ON_IO';
4869
+ } & TrajectoryPausedOnIO | {
4870
+ kind: 'RUNNING';
4871
+ } & TrajectoryRunning | {
4872
+ kind: 'WAIT_FOR_IO';
4873
+ } & TrajectoryWaitForIO;
4854
4874
  /**
4855
- *
4875
+ * First or last sample (depending on direction) of trajectory has been sent.
4856
4876
  * @export
4857
4877
  * @interface TrajectoryEnded
4858
4878
  */
@@ -4892,7 +4912,7 @@ export declare const TrajectoryIdMessageTypeEnum: {
4892
4912
  };
4893
4913
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
4894
4914
  /**
4895
- *
4915
+ * User has paused execution.
4896
4916
  * @export
4897
4917
  * @interface TrajectoryPausedByUser
4898
4918
  */
@@ -4909,7 +4929,7 @@ export declare const TrajectoryPausedByUserKindEnum: {
4909
4929
  };
4910
4930
  export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
4911
4931
  /**
4912
- *
4932
+ * Execution was paused because of an I/O event.
4913
4933
  * @export
4914
4934
  * @interface TrajectoryPausedOnIO
4915
4935
  */
@@ -4926,7 +4946,7 @@ export declare const TrajectoryPausedOnIOKindEnum: {
4926
4946
  };
4927
4947
  export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
4928
4948
  /**
4929
- *
4949
+ * Trajectory is being executed.
4930
4950
  * @export
4931
4951
  * @interface TrajectoryRunning
4932
4952
  */
@@ -4949,7 +4969,7 @@ export declare const TrajectoryRunningKindEnum: {
4949
4969
  };
4950
4970
  export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
4951
4971
  /**
4952
- *
4972
+ * Waiting for an I/O event to start execution.
4953
4973
  * @export
4954
4974
  * @interface TrajectoryWaitForIO
4955
4975
  */
package/v2/api.ts CHANGED
@@ -2404,10 +2404,10 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
2404
2404
  * @type JoggingDetailsState
2405
2405
  * @export
2406
2406
  */
2407
- export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2407
+ export type JoggingDetailsState = { kind: 'PAUSED_BY_USER' } & JoggingPausedByUser | { kind: 'PAUSED_NEAR_COLLISION' } & JoggingPausedNearCollision | { kind: 'PAUSED_NEAR_JOINT_LIMIT' } & JoggingPausedNearJointLimit | { kind: 'PAUSED_ON_IO' } & JoggingPausedOnIO | { kind: 'RUNNING' } & JoggingRunning;
2408
2408
 
2409
2409
  /**
2410
- *
2410
+ * User has paused jogging.
2411
2411
  * @export
2412
2412
  * @interface JoggingPausedByUser
2413
2413
  */
@@ -2427,7 +2427,7 @@ export const JoggingPausedByUserKindEnum = {
2427
2427
  export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2428
2428
 
2429
2429
  /**
2430
- *
2430
+ * Jogging was paused because the motion group neared a collision.
2431
2431
  * @export
2432
2432
  * @interface JoggingPausedNearCollision
2433
2433
  */
@@ -2453,7 +2453,7 @@ export const JoggingPausedNearCollisionKindEnum = {
2453
2453
  export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2454
2454
 
2455
2455
  /**
2456
- *
2456
+ * Jogging was paused because a joint is near its limit.
2457
2457
  * @export
2458
2458
  * @interface JoggingPausedNearJointLimit
2459
2459
  */
@@ -2479,7 +2479,7 @@ export const JoggingPausedNearJointLimitKindEnum = {
2479
2479
  export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2480
2480
 
2481
2481
  /**
2482
- *
2482
+ * Jogging was paused because of an I/O event.
2483
2483
  * @export
2484
2484
  * @interface JoggingPausedOnIO
2485
2485
  */
@@ -2499,7 +2499,7 @@ export const JoggingPausedOnIOKindEnum = {
2499
2499
  export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2500
2500
 
2501
2501
  /**
2502
- *
2502
+ * Jogging is active.
2503
2503
  * @export
2504
2504
  * @interface JoggingRunning
2505
2505
  */
@@ -5105,10 +5105,10 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
5105
5105
  * @type TrajectoryDetailsState
5106
5106
  * @export
5107
5107
  */
5108
- export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
5108
+ export type TrajectoryDetailsState = { kind: 'END_OF_TRAJECTORY' } & TrajectoryEnded | { kind: 'PAUSED_BY_USER' } & TrajectoryPausedByUser | { kind: 'PAUSED_ON_IO' } & TrajectoryPausedOnIO | { kind: 'RUNNING' } & TrajectoryRunning | { kind: 'WAIT_FOR_IO' } & TrajectoryWaitForIO;
5109
5109
 
5110
5110
  /**
5111
- *
5111
+ * First or last sample (depending on direction) of trajectory has been sent.
5112
5112
  * @export
5113
5113
  * @interface TrajectoryEnded
5114
5114
  */
@@ -5154,7 +5154,7 @@ export const TrajectoryIdMessageTypeEnum = {
5154
5154
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
5155
5155
 
5156
5156
  /**
5157
- *
5157
+ * User has paused execution.
5158
5158
  * @export
5159
5159
  * @interface TrajectoryPausedByUser
5160
5160
  */
@@ -5174,7 +5174,7 @@ export const TrajectoryPausedByUserKindEnum = {
5174
5174
  export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
5175
5175
 
5176
5176
  /**
5177
- *
5177
+ * Execution was paused because of an I/O event.
5178
5178
  * @export
5179
5179
  * @interface TrajectoryPausedOnIO
5180
5180
  */
@@ -5194,7 +5194,7 @@ export const TrajectoryPausedOnIOKindEnum = {
5194
5194
  export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
5195
5195
 
5196
5196
  /**
5197
- *
5197
+ * Trajectory is being executed.
5198
5198
  * @export
5199
5199
  * @interface TrajectoryRunning
5200
5200
  */
@@ -5220,7 +5220,7 @@ export const TrajectoryRunningKindEnum = {
5220
5220
  export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
5221
5221
 
5222
5222
  /**
5223
- *
5223
+ * Waiting for an I/O event to start execution.
5224
5224
  * @export
5225
5225
  * @interface TrajectoryWaitForIO
5226
5226
  */