@awarevue/api-types 2.0.40 → 2.0.42

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 (5) hide show
  1. package/dist/api/rest/view.d.ts +82 -0
  2. package/dist/objects/view.d.ts +135 -0
  3. package/dist/objects/view.js +7 -0
  4. package/dist/package.json +1 -1
  5. package/package.json +1 -1
package/dist/api/rest/view.d.ts CHANGED
@@ -34,29 +34,50 @@ export declare const sAddViewRequest: z.ZodObject<{
34
34
  area: z.ZodString;
35
35
  type: z.ZodLiteral<"device">;
36
36
  deviceId: z.ZodString;
37
+ streamId: z.ZodOptional<z.ZodString>;
37
38
  }, "strip", z.ZodTypeAny, {
38
39
  type: "device";
39
40
  area: string;
40
41
  deviceId: string;
42
+ streamId?: string | undefined;
41
43
  }, {
42
44
  type: "device";
43
45
  area: string;
44
46
  deviceId: string;
47
+ streamId?: string | undefined;
45
48
  }>, z.ZodObject<{
46
49
  area: z.ZodString;
47
50
  type: z.ZodLiteral<"deviceCarousel">;
48
51
  deviceIds: z.ZodArray<z.ZodString, "many">;
52
+ streams: z.ZodOptional<z.ZodArray<z.ZodObject<{
53
+ deviceId: z.ZodString;
54
+ streamId: z.ZodString;
55
+ }, "strip", z.ZodTypeAny, {
56
+ deviceId: string;
57
+ streamId: string;
58
+ }, {
59
+ deviceId: string;
60
+ streamId: string;
61
+ }>, "many">>;
49
62
  timeIntervalMs: z.ZodNumber;
50
63
  }, "strip", z.ZodTypeAny, {
51
64
  type: "deviceCarousel";
52
65
  area: string;
53
66
  deviceIds: string[];
54
67
  timeIntervalMs: number;
68
+ streams?: {
69
+ deviceId: string;
70
+ streamId: string;
71
+ }[] | undefined;
55
72
  }, {
56
73
  type: "deviceCarousel";
57
74
  area: string;
58
75
  deviceIds: string[];
59
76
  timeIntervalMs: number;
77
+ streams?: {
78
+ deviceId: string;
79
+ streamId: string;
80
+ }[] | undefined;
60
81
  }>, z.ZodObject<{
61
82
  area: z.ZodString;
62
83
  type: z.ZodLiteral<"playbackTrack">;
@@ -103,11 +124,16 @@ export declare const sAddViewRequest: z.ZodObject<{
103
124
  type: "device";
104
125
  area: string;
105
126
  deviceId: string;
127
+ streamId?: string | undefined;
106
128
  } | {
107
129
  type: "deviceCarousel";
108
130
  area: string;
109
131
  deviceIds: string[];
110
132
  timeIntervalMs: number;
133
+ streams?: {
134
+ deviceId: string;
135
+ streamId: string;
136
+ }[] | undefined;
111
137
  } | {
112
138
  type: "playbackTrack";
113
139
  source: {
@@ -133,11 +159,16 @@ export declare const sAddViewRequest: z.ZodObject<{
133
159
  type: "device";
134
160
  area: string;
135
161
  deviceId: string;
162
+ streamId?: string | undefined;
136
163
  } | {
137
164
  type: "deviceCarousel";
138
165
  area: string;
139
166
  deviceIds: string[];
140
167
  timeIntervalMs: number;
168
+ streams?: {
169
+ deviceId: string;
170
+ streamId: string;
171
+ }[] | undefined;
141
172
  } | {
142
173
  type: "playbackTrack";
143
174
  source: {
@@ -167,11 +198,16 @@ export declare const sAddViewRequest: z.ZodObject<{
167
198
  type: "device";
168
199
  area: string;
169
200
  deviceId: string;
201
+ streamId?: string | undefined;
170
202
  } | {
171
203
  type: "deviceCarousel";
172
204
  area: string;
173
205
  deviceIds: string[];
174
206
  timeIntervalMs: number;
207
+ streams?: {
208
+ deviceId: string;
209
+ streamId: string;
210
+ }[] | undefined;
175
211
  } | {
176
212
  type: "playbackTrack";
177
213
  source: {
@@ -203,11 +239,16 @@ export declare const sAddViewRequest: z.ZodObject<{
203
239
  type: "device";
204
240
  area: string;
205
241
  deviceId: string;
242
+ streamId?: string | undefined;
206
243
  } | {
207
244
  type: "deviceCarousel";
208
245
  area: string;
209
246
  deviceIds: string[];
210
247
  timeIntervalMs: number;
248
+ streams?: {
249
+ deviceId: string;
250
+ streamId: string;
251
+ }[] | undefined;
211
252
  } | {
212
253
  type: "playbackTrack";
213
254
  source: {
@@ -257,29 +298,50 @@ export declare const sUpdateViewRequest: z.ZodObject<{
257
298
  area: z.ZodString;
258
299
  type: z.ZodLiteral<"device">;
259
300
  deviceId: z.ZodString;
301
+ streamId: z.ZodOptional<z.ZodString>;
260
302
  }, "strip", z.ZodTypeAny, {
261
303
  type: "device";
262
304
  area: string;
263
305
  deviceId: string;
306
+ streamId?: string | undefined;
264
307
  }, {
265
308
  type: "device";
266
309
  area: string;
267
310
  deviceId: string;
311
+ streamId?: string | undefined;
268
312
  }>, z.ZodObject<{
269
313
  area: z.ZodString;
270
314
  type: z.ZodLiteral<"deviceCarousel">;
271
315
  deviceIds: z.ZodArray<z.ZodString, "many">;
316
+ streams: z.ZodOptional<z.ZodArray<z.ZodObject<{
317
+ deviceId: z.ZodString;
318
+ streamId: z.ZodString;
319
+ }, "strip", z.ZodTypeAny, {
320
+ deviceId: string;
321
+ streamId: string;
322
+ }, {
323
+ deviceId: string;
324
+ streamId: string;
325
+ }>, "many">>;
272
326
  timeIntervalMs: z.ZodNumber;
273
327
  }, "strip", z.ZodTypeAny, {
274
328
  type: "deviceCarousel";
275
329
  area: string;
276
330
  deviceIds: string[];
277
331
  timeIntervalMs: number;
332
+ streams?: {
333
+ deviceId: string;
334
+ streamId: string;
335
+ }[] | undefined;
278
336
  }, {
279
337
  type: "deviceCarousel";
280
338
  area: string;
281
339
  deviceIds: string[];
282
340
  timeIntervalMs: number;
341
+ streams?: {
342
+ deviceId: string;
343
+ streamId: string;
344
+ }[] | undefined;
283
345
  }>, z.ZodObject<{
284
346
  area: z.ZodString;
285
347
  type: z.ZodLiteral<"playbackTrack">;
@@ -326,11 +388,16 @@ export declare const sUpdateViewRequest: z.ZodObject<{
326
388
  type: "device";
327
389
  area: string;
328
390
  deviceId: string;
391
+ streamId?: string | undefined;
329
392
  } | {
330
393
  type: "deviceCarousel";
331
394
  area: string;
332
395
  deviceIds: string[];
333
396
  timeIntervalMs: number;
397
+ streams?: {
398
+ deviceId: string;
399
+ streamId: string;
400
+ }[] | undefined;
334
401
  } | {
335
402
  type: "playbackTrack";
336
403
  source: {
@@ -356,11 +423,16 @@ export declare const sUpdateViewRequest: z.ZodObject<{
356
423
  type: "device";
357
424
  area: string;
358
425
  deviceId: string;
426
+ streamId?: string | undefined;
359
427
  } | {
360
428
  type: "deviceCarousel";
361
429
  area: string;
362
430
  deviceIds: string[];
363
431
  timeIntervalMs: number;
432
+ streams?: {
433
+ deviceId: string;
434
+ streamId: string;
435
+ }[] | undefined;
364
436
  } | {
365
437
  type: "playbackTrack";
366
438
  source: {
@@ -392,11 +464,16 @@ export declare const sUpdateViewRequest: z.ZodObject<{
392
464
  type: "device";
393
465
  area: string;
394
466
  deviceId: string;
467
+ streamId?: string | undefined;
395
468
  } | {
396
469
  type: "deviceCarousel";
397
470
  area: string;
398
471
  deviceIds: string[];
399
472
  timeIntervalMs: number;
473
+ streams?: {
474
+ deviceId: string;
475
+ streamId: string;
476
+ }[] | undefined;
400
477
  } | {
401
478
  type: "playbackTrack";
402
479
  source: {
@@ -428,11 +505,16 @@ export declare const sUpdateViewRequest: z.ZodObject<{
428
505
  type: "device";
429
506
  area: string;
430
507
  deviceId: string;
508
+ streamId?: string | undefined;
431
509
  } | {
432
510
  type: "deviceCarousel";
433
511
  area: string;
434
512
  deviceIds: string[];
435
513
  timeIntervalMs: number;
514
+ streams?: {
515
+ deviceId: string;
516
+ streamId: string;
517
+ }[] | undefined;
436
518
  } | {
437
519
  type: "playbackTrack";
438
520
  source: {
package/dist/objects/view.d.ts CHANGED
@@ -28,31 +28,52 @@ export declare const sDeviceArea: z.ZodObject<{
28
28
  area: z.ZodString;
29
29
  type: z.ZodLiteral<"device">;
30
30
  deviceId: z.ZodString;
31
+ streamId: z.ZodOptional<z.ZodString>;
31
32
  }, "strip", z.ZodTypeAny, {
32
33
  type: "device";
33
34
  area: string;
34
35
  deviceId: string;
36
+ streamId?: string | undefined;
35
37
  }, {
36
38
  type: "device";
37
39
  area: string;
38
40
  deviceId: string;
41
+ streamId?: string | undefined;
39
42
  }>;
40
43
  export type DeviceArea = z.infer<typeof sDeviceArea>;
41
44
  export declare const sDeviceCarouselArea: z.ZodObject<{
42
45
  area: z.ZodString;
43
46
  type: z.ZodLiteral<"deviceCarousel">;
44
47
  deviceIds: z.ZodArray<z.ZodString, "many">;
48
+ streams: z.ZodOptional<z.ZodArray<z.ZodObject<{
49
+ deviceId: z.ZodString;
50
+ streamId: z.ZodString;
51
+ }, "strip", z.ZodTypeAny, {
52
+ deviceId: string;
53
+ streamId: string;
54
+ }, {
55
+ deviceId: string;
56
+ streamId: string;
57
+ }>, "many">>;
45
58
  timeIntervalMs: z.ZodNumber;
46
59
  }, "strip", z.ZodTypeAny, {
47
60
  type: "deviceCarousel";
48
61
  area: string;
49
62
  deviceIds: string[];
50
63
  timeIntervalMs: number;
64
+ streams?: {
65
+ deviceId: string;
66
+ streamId: string;
67
+ }[] | undefined;
51
68
  }, {
52
69
  type: "deviceCarousel";
53
70
  area: string;
54
71
  deviceIds: string[];
55
72
  timeIntervalMs: number;
73
+ streams?: {
74
+ deviceId: string;
75
+ streamId: string;
76
+ }[] | undefined;
56
77
  }>;
57
78
  export type DeviceCarouselArea = z.infer<typeof sDeviceCarouselArea>;
58
79
  export declare const sPlaybackTrackArea: z.ZodObject<{
@@ -113,29 +134,50 @@ export declare const sViewAreaContents: z.ZodUnion<[z.ZodObject<{
113
134
  area: z.ZodString;
114
135
  type: z.ZodLiteral<"device">;
115
136
  deviceId: z.ZodString;
137
+ streamId: z.ZodOptional<z.ZodString>;
116
138
  }, "strip", z.ZodTypeAny, {
117
139
  type: "device";
118
140
  area: string;
119
141
  deviceId: string;
142
+ streamId?: string | undefined;
120
143
  }, {
121
144
  type: "device";
122
145
  area: string;
123
146
  deviceId: string;
147
+ streamId?: string | undefined;
124
148
  }>, z.ZodObject<{
125
149
  area: z.ZodString;
126
150
  type: z.ZodLiteral<"deviceCarousel">;
127
151
  deviceIds: z.ZodArray<z.ZodString, "many">;
152
+ streams: z.ZodOptional<z.ZodArray<z.ZodObject<{
153
+ deviceId: z.ZodString;
154
+ streamId: z.ZodString;
155
+ }, "strip", z.ZodTypeAny, {
156
+ deviceId: string;
157
+ streamId: string;
158
+ }, {
159
+ deviceId: string;
160
+ streamId: string;
161
+ }>, "many">>;
128
162
  timeIntervalMs: z.ZodNumber;
129
163
  }, "strip", z.ZodTypeAny, {
130
164
  type: "deviceCarousel";
131
165
  area: string;
132
166
  deviceIds: string[];
133
167
  timeIntervalMs: number;
168
+ streams?: {
169
+ deviceId: string;
170
+ streamId: string;
171
+ }[] | undefined;
134
172
  }, {
135
173
  type: "deviceCarousel";
136
174
  area: string;
137
175
  deviceIds: string[];
138
176
  timeIntervalMs: number;
177
+ streams?: {
178
+ deviceId: string;
179
+ streamId: string;
180
+ }[] | undefined;
139
181
  }>, z.ZodObject<{
140
182
  area: z.ZodString;
141
183
  type: z.ZodLiteral<"playbackTrack">;
@@ -197,29 +239,50 @@ export declare const sViewConfig: z.ZodObject<{
197
239
  area: z.ZodString;
198
240
  type: z.ZodLiteral<"device">;
199
241
  deviceId: z.ZodString;
242
+ streamId: z.ZodOptional<z.ZodString>;
200
243
  }, "strip", z.ZodTypeAny, {
201
244
  type: "device";
202
245
  area: string;
203
246
  deviceId: string;
247
+ streamId?: string | undefined;
204
248
  }, {
205
249
  type: "device";
206
250
  area: string;
207
251
  deviceId: string;
252
+ streamId?: string | undefined;
208
253
  }>, z.ZodObject<{
209
254
  area: z.ZodString;
210
255
  type: z.ZodLiteral<"deviceCarousel">;
211
256
  deviceIds: z.ZodArray<z.ZodString, "many">;
257
+ streams: z.ZodOptional<z.ZodArray<z.ZodObject<{
258
+ deviceId: z.ZodString;
259
+ streamId: z.ZodString;
260
+ }, "strip", z.ZodTypeAny, {
261
+ deviceId: string;
262
+ streamId: string;
263
+ }, {
264
+ deviceId: string;
265
+ streamId: string;
266
+ }>, "many">>;
212
267
  timeIntervalMs: z.ZodNumber;
213
268
  }, "strip", z.ZodTypeAny, {
214
269
  type: "deviceCarousel";
215
270
  area: string;
216
271
  deviceIds: string[];
217
272
  timeIntervalMs: number;
273
+ streams?: {
274
+ deviceId: string;
275
+ streamId: string;
276
+ }[] | undefined;
218
277
  }, {
219
278
  type: "deviceCarousel";
220
279
  area: string;
221
280
  deviceIds: string[];
222
281
  timeIntervalMs: number;
282
+ streams?: {
283
+ deviceId: string;
284
+ streamId: string;
285
+ }[] | undefined;
223
286
  }>, z.ZodObject<{
224
287
  area: z.ZodString;
225
288
  type: z.ZodLiteral<"playbackTrack">;
@@ -266,11 +329,16 @@ export declare const sViewConfig: z.ZodObject<{
266
329
  type: "device";
267
330
  area: string;
268
331
  deviceId: string;
332
+ streamId?: string | undefined;
269
333
  } | {
270
334
  type: "deviceCarousel";
271
335
  area: string;
272
336
  deviceIds: string[];
273
337
  timeIntervalMs: number;
338
+ streams?: {
339
+ deviceId: string;
340
+ streamId: string;
341
+ }[] | undefined;
274
342
  } | {
275
343
  type: "playbackTrack";
276
344
  source: {
@@ -296,11 +364,16 @@ export declare const sViewConfig: z.ZodObject<{
296
364
  type: "device";
297
365
  area: string;
298
366
  deviceId: string;
367
+ streamId?: string | undefined;
299
368
  } | {
300
369
  type: "deviceCarousel";
301
370
  area: string;
302
371
  deviceIds: string[];
303
372
  timeIntervalMs: number;
373
+ streams?: {
374
+ deviceId: string;
375
+ streamId: string;
376
+ }[] | undefined;
304
377
  } | {
305
378
  type: "playbackTrack";
306
379
  source: {
@@ -358,29 +431,50 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
358
431
  area: z.ZodString;
359
432
  type: z.ZodLiteral<"device">;
360
433
  deviceId: z.ZodString;
434
+ streamId: z.ZodOptional<z.ZodString>;
361
435
  }, "strip", z.ZodTypeAny, {
362
436
  type: "device";
363
437
  area: string;
364
438
  deviceId: string;
439
+ streamId?: string | undefined;
365
440
  }, {
366
441
  type: "device";
367
442
  area: string;
368
443
  deviceId: string;
444
+ streamId?: string | undefined;
369
445
  }>, z.ZodObject<{
370
446
  area: z.ZodString;
371
447
  type: z.ZodLiteral<"deviceCarousel">;
372
448
  deviceIds: z.ZodArray<z.ZodString, "many">;
449
+ streams: z.ZodOptional<z.ZodArray<z.ZodObject<{
450
+ deviceId: z.ZodString;
451
+ streamId: z.ZodString;
452
+ }, "strip", z.ZodTypeAny, {
453
+ deviceId: string;
454
+ streamId: string;
455
+ }, {
456
+ deviceId: string;
457
+ streamId: string;
458
+ }>, "many">>;
373
459
  timeIntervalMs: z.ZodNumber;
374
460
  }, "strip", z.ZodTypeAny, {
375
461
  type: "deviceCarousel";
376
462
  area: string;
377
463
  deviceIds: string[];
378
464
  timeIntervalMs: number;
465
+ streams?: {
466
+ deviceId: string;
467
+ streamId: string;
468
+ }[] | undefined;
379
469
  }, {
380
470
  type: "deviceCarousel";
381
471
  area: string;
382
472
  deviceIds: string[];
383
473
  timeIntervalMs: number;
474
+ streams?: {
475
+ deviceId: string;
476
+ streamId: string;
477
+ }[] | undefined;
384
478
  }>, z.ZodObject<{
385
479
  area: z.ZodString;
386
480
  type: z.ZodLiteral<"playbackTrack">;
@@ -427,11 +521,16 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
427
521
  type: "device";
428
522
  area: string;
429
523
  deviceId: string;
524
+ streamId?: string | undefined;
430
525
  } | {
431
526
  type: "deviceCarousel";
432
527
  area: string;
433
528
  deviceIds: string[];
434
529
  timeIntervalMs: number;
530
+ streams?: {
531
+ deviceId: string;
532
+ streamId: string;
533
+ }[] | undefined;
435
534
  } | {
436
535
  type: "playbackTrack";
437
536
  source: {
@@ -457,11 +556,16 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
457
556
  type: "device";
458
557
  area: string;
459
558
  deviceId: string;
559
+ streamId?: string | undefined;
460
560
  } | {
461
561
  type: "deviceCarousel";
462
562
  area: string;
463
563
  deviceIds: string[];
464
564
  timeIntervalMs: number;
565
+ streams?: {
566
+ deviceId: string;
567
+ streamId: string;
568
+ }[] | undefined;
465
569
  } | {
466
570
  type: "playbackTrack";
467
571
  source: {
@@ -531,29 +635,50 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
531
635
  area: z.ZodString;
532
636
  type: z.ZodLiteral<"device">;
533
637
  deviceId: z.ZodString;
638
+ streamId: z.ZodOptional<z.ZodString>;
534
639
  }, "strip", z.ZodTypeAny, {
535
640
  type: "device";
536
641
  area: string;
537
642
  deviceId: string;
643
+ streamId?: string | undefined;
538
644
  }, {
539
645
  type: "device";
540
646
  area: string;
541
647
  deviceId: string;
648
+ streamId?: string | undefined;
542
649
  }>, z.ZodObject<{
543
650
  area: z.ZodString;
544
651
  type: z.ZodLiteral<"deviceCarousel">;
545
652
  deviceIds: z.ZodArray<z.ZodString, "many">;
653
+ streams: z.ZodOptional<z.ZodArray<z.ZodObject<{
654
+ deviceId: z.ZodString;
655
+ streamId: z.ZodString;
656
+ }, "strip", z.ZodTypeAny, {
657
+ deviceId: string;
658
+ streamId: string;
659
+ }, {
660
+ deviceId: string;
661
+ streamId: string;
662
+ }>, "many">>;
546
663
  timeIntervalMs: z.ZodNumber;
547
664
  }, "strip", z.ZodTypeAny, {
548
665
  type: "deviceCarousel";
549
666
  area: string;
550
667
  deviceIds: string[];
551
668
  timeIntervalMs: number;
669
+ streams?: {
670
+ deviceId: string;
671
+ streamId: string;
672
+ }[] | undefined;
552
673
  }, {
553
674
  type: "deviceCarousel";
554
675
  area: string;
555
676
  deviceIds: string[];
556
677
  timeIntervalMs: number;
678
+ streams?: {
679
+ deviceId: string;
680
+ streamId: string;
681
+ }[] | undefined;
557
682
  }>, z.ZodObject<{
558
683
  area: z.ZodString;
559
684
  type: z.ZodLiteral<"playbackTrack">;
@@ -600,11 +725,16 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
600
725
  type: "device";
601
726
  area: string;
602
727
  deviceId: string;
728
+ streamId?: string | undefined;
603
729
  } | {
604
730
  type: "deviceCarousel";
605
731
  area: string;
606
732
  deviceIds: string[];
607
733
  timeIntervalMs: number;
734
+ streams?: {
735
+ deviceId: string;
736
+ streamId: string;
737
+ }[] | undefined;
608
738
  } | {
609
739
  type: "playbackTrack";
610
740
  source: {
@@ -630,11 +760,16 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
630
760
  type: "device";
631
761
  area: string;
632
762
  deviceId: string;
763
+ streamId?: string | undefined;
633
764
  } | {
634
765
  type: "deviceCarousel";
635
766
  area: string;
636
767
  deviceIds: string[];
637
768
  timeIntervalMs: number;
769
+ streams?: {
770
+ deviceId: string;
771
+ streamId: string;
772
+ }[] | undefined;
638
773
  } | {
639
774
  type: "playbackTrack";
640
775
  source: {
package/dist/objects/view.js CHANGED
@@ -15,11 +15,18 @@ exports.sDeviceArea = zod_1.z.object({
15
15
  area: zod_1.z.string().nonempty(),
16
16
  type: zod_1.z.literal('device'),
17
17
  deviceId: zod_1.z.string().nonempty(),
18
+ streamId: zod_1.z.string().nonempty().optional(),
18
19
  });
19
20
  exports.sDeviceCarouselArea = zod_1.z.object({
20
21
  area: zod_1.z.string().nonempty(),
21
22
  type: zod_1.z.literal('deviceCarousel'),
22
23
  deviceIds: zod_1.z.array(zod_1.z.string().nonempty()),
24
+ streams: zod_1.z
25
+ .array(zod_1.z.object({
26
+ deviceId: zod_1.z.string().nonempty(),
27
+ streamId: zod_1.z.string().nonempty(),
28
+ }))
29
+ .optional(),
23
30
  timeIntervalMs: zod_1.z.number().nonnegative(),
24
31
  });
25
32
  exports.sPlaybackTrackArea = zod_1.z.object({
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awarevue/api-types",
3
- "version": "2.0.40",
3
+ "version": "2.0.42",
4
4
  "description": "Common types between backend, agent(s) and frontend(s)",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awarevue/api-types",
3
- "version": "2.0.40",
3
+ "version": "2.0.42",
4
4
  "description": "Common types between backend, agent(s) and frontend(s)",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",