@awarevue/api-types 1.0.112 → 1.0.113

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 (4) hide show
  1. package/dist/package.json +1 -1
  2. package/dist/view.d.ts +178 -1
  3. package/dist/view.js +11 -1
  4. package/package.json +1 -1
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awarevue/api-types",
3
- "version": "1.0.112",
3
+ "version": "1.0.113",
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/dist/view.d.ts CHANGED
@@ -55,7 +55,24 @@ export declare const sDeviceCarouselArea: z.ZodObject<{
55
55
  timeIntervalMs: number;
56
56
  }>;
57
57
  export type DeviceCarouselArea = z.infer<typeof sDeviceCarouselArea>;
58
- export type ViewAreaContents = LayoutArea | LayoutSelectorArea | DeviceArea | DeviceCarouselArea;
58
+ export declare const sPlaybackTrackArea: z.ZodObject<{
59
+ area: z.ZodString;
60
+ type: z.ZodLiteral<"playbackTrack">;
61
+ controllerId: z.ZodString;
62
+ source: z.ZodString;
63
+ }, "strip", z.ZodTypeAny, {
64
+ type: "playbackTrack";
65
+ source: string;
66
+ area: string;
67
+ controllerId: string;
68
+ }, {
69
+ type: "playbackTrack";
70
+ source: string;
71
+ area: string;
72
+ controllerId: string;
73
+ }>;
74
+ export type PlaybackTrackArea = z.infer<typeof sPlaybackTrackArea>;
75
+ export type ViewAreaContents = LayoutArea | LayoutSelectorArea | DeviceArea | DeviceCarouselArea | PlaybackTrackArea;
59
76
  export declare const sViewAreaContents: z.ZodUnion<[z.ZodObject<{
60
77
  area: z.ZodString;
61
78
  type: z.ZodLiteral<"layout">;
@@ -104,6 +121,21 @@ export declare const sViewAreaContents: z.ZodUnion<[z.ZodObject<{
104
121
  area: string;
105
122
  deviceIds: string[];
106
123
  timeIntervalMs: number;
124
+ }>, z.ZodObject<{
125
+ area: z.ZodString;
126
+ type: z.ZodLiteral<"playbackTrack">;
127
+ controllerId: z.ZodString;
128
+ source: z.ZodString;
129
+ }, "strip", z.ZodTypeAny, {
130
+ type: "playbackTrack";
131
+ source: string;
132
+ area: string;
133
+ controllerId: string;
134
+ }, {
135
+ type: "playbackTrack";
136
+ source: string;
137
+ area: string;
138
+ controllerId: string;
107
139
  }>]>;
108
140
  export declare const sViewConfig: z.ZodObject<{
109
141
  rows: z.ZodNumber;
@@ -158,6 +190,21 @@ export declare const sViewConfig: z.ZodObject<{
158
190
  area: string;
159
191
  deviceIds: string[];
160
192
  timeIntervalMs: number;
193
+ }>, z.ZodObject<{
194
+ area: z.ZodString;
195
+ type: z.ZodLiteral<"playbackTrack">;
196
+ controllerId: z.ZodString;
197
+ source: z.ZodString;
198
+ }, "strip", z.ZodTypeAny, {
199
+ type: "playbackTrack";
200
+ source: string;
201
+ area: string;
202
+ controllerId: string;
203
+ }, {
204
+ type: "playbackTrack";
205
+ source: string;
206
+ area: string;
207
+ controllerId: string;
161
208
  }>]>, "many">;
162
209
  }, "strip", z.ZodTypeAny, {
163
210
  columns: number;
@@ -179,6 +226,11 @@ export declare const sViewConfig: z.ZodObject<{
179
226
  area: string;
180
227
  deviceIds: string[];
181
228
  timeIntervalMs: number;
229
+ } | {
230
+ type: "playbackTrack";
231
+ source: string;
232
+ area: string;
233
+ controllerId: string;
182
234
  })[];
183
235
  hotspotArea?: string | undefined;
184
236
  }, {
@@ -201,6 +253,11 @@ export declare const sViewConfig: z.ZodObject<{
201
253
  area: string;
202
254
  deviceIds: string[];
203
255
  timeIntervalMs: number;
256
+ } | {
257
+ type: "playbackTrack";
258
+ source: string;
259
+ area: string;
260
+ controllerId: string;
204
261
  })[];
205
262
  hotspotArea?: string | undefined;
206
263
  }>;
@@ -262,6 +319,21 @@ export declare const sAddViewRequest: z.ZodObject<{
262
319
  area: string;
263
320
  deviceIds: string[];
264
321
  timeIntervalMs: number;
322
+ }>, z.ZodObject<{
323
+ area: z.ZodString;
324
+ type: z.ZodLiteral<"playbackTrack">;
325
+ controllerId: z.ZodString;
326
+ source: z.ZodString;
327
+ }, "strip", z.ZodTypeAny, {
328
+ type: "playbackTrack";
329
+ source: string;
330
+ area: string;
331
+ controllerId: string;
332
+ }, {
333
+ type: "playbackTrack";
334
+ source: string;
335
+ area: string;
336
+ controllerId: string;
265
337
  }>]>, "many">;
266
338
  }, "strip", z.ZodTypeAny, {
267
339
  columns: number;
@@ -283,6 +355,11 @@ export declare const sAddViewRequest: z.ZodObject<{
283
355
  area: string;
284
356
  deviceIds: string[];
285
357
  timeIntervalMs: number;
358
+ } | {
359
+ type: "playbackTrack";
360
+ source: string;
361
+ area: string;
362
+ controllerId: string;
286
363
  })[];
287
364
  hotspotArea?: string | undefined;
288
365
  }, {
@@ -305,6 +382,11 @@ export declare const sAddViewRequest: z.ZodObject<{
305
382
  area: string;
306
383
  deviceIds: string[];
307
384
  timeIntervalMs: number;
385
+ } | {
386
+ type: "playbackTrack";
387
+ source: string;
388
+ area: string;
389
+ controllerId: string;
308
390
  })[];
309
391
  hotspotArea?: string | undefined;
310
392
  }>;
@@ -330,6 +412,11 @@ export declare const sAddViewRequest: z.ZodObject<{
330
412
  area: string;
331
413
  deviceIds: string[];
332
414
  timeIntervalMs: number;
415
+ } | {
416
+ type: "playbackTrack";
417
+ source: string;
418
+ area: string;
419
+ controllerId: string;
333
420
  })[];
334
421
  hotspotArea?: string | undefined;
335
422
  };
@@ -358,6 +445,11 @@ export declare const sAddViewRequest: z.ZodObject<{
358
445
  area: string;
359
446
  deviceIds: string[];
360
447
  timeIntervalMs: number;
448
+ } | {
449
+ type: "playbackTrack";
450
+ source: string;
451
+ area: string;
452
+ controllerId: string;
361
453
  })[];
362
454
  hotspotArea?: string | undefined;
363
455
  };
@@ -423,6 +515,21 @@ export declare const sUpdateViewRequest: z.ZodObject<{
423
515
  area: string;
424
516
  deviceIds: string[];
425
517
  timeIntervalMs: number;
518
+ }>, z.ZodObject<{
519
+ area: z.ZodString;
520
+ type: z.ZodLiteral<"playbackTrack">;
521
+ controllerId: z.ZodString;
522
+ source: z.ZodString;
523
+ }, "strip", z.ZodTypeAny, {
524
+ type: "playbackTrack";
525
+ source: string;
526
+ area: string;
527
+ controllerId: string;
528
+ }, {
529
+ type: "playbackTrack";
530
+ source: string;
531
+ area: string;
532
+ controllerId: string;
426
533
  }>]>, "many">;
427
534
  }, "strip", z.ZodTypeAny, {
428
535
  columns: number;
@@ -444,6 +551,11 @@ export declare const sUpdateViewRequest: z.ZodObject<{
444
551
  area: string;
445
552
  deviceIds: string[];
446
553
  timeIntervalMs: number;
554
+ } | {
555
+ type: "playbackTrack";
556
+ source: string;
557
+ area: string;
558
+ controllerId: string;
447
559
  })[];
448
560
  hotspotArea?: string | undefined;
449
561
  }, {
@@ -466,6 +578,11 @@ export declare const sUpdateViewRequest: z.ZodObject<{
466
578
  area: string;
467
579
  deviceIds: string[];
468
580
  timeIntervalMs: number;
581
+ } | {
582
+ type: "playbackTrack";
583
+ source: string;
584
+ area: string;
585
+ controllerId: string;
469
586
  })[];
470
587
  hotspotArea?: string | undefined;
471
588
  }>>;
@@ -493,6 +610,11 @@ export declare const sUpdateViewRequest: z.ZodObject<{
493
610
  area: string;
494
611
  deviceIds: string[];
495
612
  timeIntervalMs: number;
613
+ } | {
614
+ type: "playbackTrack";
615
+ source: string;
616
+ area: string;
617
+ controllerId: string;
496
618
  })[];
497
619
  hotspotArea?: string | undefined;
498
620
  } | undefined;
@@ -521,6 +643,11 @@ export declare const sUpdateViewRequest: z.ZodObject<{
521
643
  area: string;
522
644
  deviceIds: string[];
523
645
  timeIntervalMs: number;
646
+ } | {
647
+ type: "playbackTrack";
648
+ source: string;
649
+ area: string;
650
+ controllerId: string;
524
651
  })[];
525
652
  hotspotArea?: string | undefined;
526
653
  } | undefined;
@@ -595,6 +722,21 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
595
722
  area: string;
596
723
  deviceIds: string[];
597
724
  timeIntervalMs: number;
725
+ }>, z.ZodObject<{
726
+ area: z.ZodString;
727
+ type: z.ZodLiteral<"playbackTrack">;
728
+ controllerId: z.ZodString;
729
+ source: z.ZodString;
730
+ }, "strip", z.ZodTypeAny, {
731
+ type: "playbackTrack";
732
+ source: string;
733
+ area: string;
734
+ controllerId: string;
735
+ }, {
736
+ type: "playbackTrack";
737
+ source: string;
738
+ area: string;
739
+ controllerId: string;
598
740
  }>]>, "many">;
599
741
  }, "strip", z.ZodTypeAny, {
600
742
  columns: number;
@@ -616,6 +758,11 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
616
758
  area: string;
617
759
  deviceIds: string[];
618
760
  timeIntervalMs: number;
761
+ } | {
762
+ type: "playbackTrack";
763
+ source: string;
764
+ area: string;
765
+ controllerId: string;
619
766
  })[];
620
767
  hotspotArea?: string | undefined;
621
768
  }, {
@@ -638,6 +785,11 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
638
785
  area: string;
639
786
  deviceIds: string[];
640
787
  timeIntervalMs: number;
788
+ } | {
789
+ type: "playbackTrack";
790
+ source: string;
791
+ area: string;
792
+ controllerId: string;
641
793
  })[];
642
794
  hotspotArea?: string | undefined;
643
795
  }>>;
@@ -722,6 +874,21 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
722
874
  area: string;
723
875
  deviceIds: string[];
724
876
  timeIntervalMs: number;
877
+ }>, z.ZodObject<{
878
+ area: z.ZodString;
879
+ type: z.ZodLiteral<"playbackTrack">;
880
+ controllerId: z.ZodString;
881
+ source: z.ZodString;
882
+ }, "strip", z.ZodTypeAny, {
883
+ type: "playbackTrack";
884
+ source: string;
885
+ area: string;
886
+ controllerId: string;
887
+ }, {
888
+ type: "playbackTrack";
889
+ source: string;
890
+ area: string;
891
+ controllerId: string;
725
892
  }>]>, "many">;
726
893
  }, "strip", z.ZodTypeAny, {
727
894
  columns: number;
@@ -743,6 +910,11 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
743
910
  area: string;
744
911
  deviceIds: string[];
745
912
  timeIntervalMs: number;
913
+ } | {
914
+ type: "playbackTrack";
915
+ source: string;
916
+ area: string;
917
+ controllerId: string;
746
918
  })[];
747
919
  hotspotArea?: string | undefined;
748
920
  }, {
@@ -765,6 +937,11 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
765
937
  area: string;
766
938
  deviceIds: string[];
767
939
  timeIntervalMs: number;
940
+ } | {
941
+ type: "playbackTrack";
942
+ source: string;
943
+ area: string;
944
+ controllerId: string;
768
945
  })[];
769
946
  hotspotArea?: string | undefined;
770
947
  }>>;
package/dist/view.js CHANGED
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.sViewDto = exports.sViewInfo = exports.sUpdateViewRequest = exports.sAddViewRequest = exports.sViewConfig = exports.sViewAreaContents = exports.sDeviceCarouselArea = exports.sDeviceArea = exports.sLayoutSelectorArea = exports.sLayoutArea = void 0;
6
+ exports.sViewDto = exports.sViewInfo = exports.sUpdateViewRequest = exports.sAddViewRequest = exports.sViewConfig = exports.sViewAreaContents = exports.sPlaybackTrackArea = exports.sDeviceCarouselArea = exports.sDeviceArea = exports.sLayoutSelectorArea = exports.sLayoutArea = void 0;
7
7
  const zod_1 = __importDefault(require("zod"));
8
8
  exports.sLayoutArea = zod_1.default.object({
9
9
  area: zod_1.default.string().nonempty(),
@@ -25,11 +25,21 @@ exports.sDeviceCarouselArea = zod_1.default.object({
25
25
  deviceIds: zod_1.default.array(zod_1.default.string().nonempty()),
26
26
  timeIntervalMs: zod_1.default.number().nonnegative(),
27
27
  });
28
+ exports.sPlaybackTrackArea = zod_1.default.object({
29
+ area: zod_1.default.string().nonempty(),
30
+ type: zod_1.default.literal('playbackTrack'),
31
+ controllerId: zod_1.default.string().nonempty(),
32
+ source: zod_1.default
33
+ .string()
34
+ .nonempty()
35
+ .describe('The track within the controller. It is the device ID for the camera in the track.'),
36
+ });
28
37
  exports.sViewAreaContents = zod_1.default.union([
29
38
  exports.sLayoutArea,
30
39
  exports.sLayoutSelectorArea,
31
40
  exports.sDeviceArea,
32
41
  exports.sDeviceCarouselArea,
42
+ exports.sPlaybackTrackArea,
33
43
  ]);
34
44
  exports.sViewConfig = zod_1.default.object({
35
45
  rows: zod_1.default.number(),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awarevue/api-types",
3
- "version": "1.0.112",
3
+ "version": "1.0.113",
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",