@awarevue/api-types 2.0.38 → 2.0.40

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 (26) hide show
  1. package/dist/api/agent-protocol/protocol.d.ts +204 -136
  2. package/dist/api/commands/all.d.ts +135 -92
  3. package/dist/api/commands/nvr-exporter.d.ts +140 -92
  4. package/dist/api/commands/nvr-exporter.js +1 -0
  5. package/dist/api/commands/server.d.ts +130 -92
  6. package/dist/api/queries/all.d.ts +153 -102
  7. package/dist/api/queries/nvr-recorder.d.ts +306 -204
  8. package/dist/api/rest/app.d.ts +44 -0
  9. package/dist/api/rest/app.js +8 -1
  10. package/dist/api/rest/cast.d.ts +2 -2
  11. package/dist/api/rest/device.d.ts +18 -0
  12. package/dist/api/rest/device.js +3 -0
  13. package/dist/api/rest/media.d.ts +3 -0
  14. package/dist/api/rest/media.js +1 -0
  15. package/dist/api/rest/view.d.ts +68 -14
  16. package/dist/api/rest/webrtc-playback.d.ts +18 -3
  17. package/dist/api/rest/webrtc-playback.js +5 -1
  18. package/dist/objects/device/any-device.d.ts +111 -66
  19. package/dist/objects/device/camera.d.ts +59 -22
  20. package/dist/objects/device/camera.js +5 -4
  21. package/dist/objects/device/device-import.d.ts +190 -124
  22. package/dist/objects/view.d.ts +114 -21
  23. package/dist/objects/view.js +7 -4
  24. package/dist/package.json +1 -1
  25. package/dist/primitives.d.ts +74 -44
  26. package/package.json +1 -1
package/dist/objects/view.d.ts CHANGED
@@ -59,15 +59,30 @@ export declare const sPlaybackTrackArea: z.ZodObject<{
59
59
  area: z.ZodString;
60
60
  type: z.ZodLiteral<"playbackTrack">;
61
61
  controllerId: z.ZodString;
62
- source: z.ZodString;
62
+ source: z.ZodObject<{
63
+ deviceId: z.ZodString;
64
+ streamId: z.ZodString;
65
+ }, "strip", z.ZodTypeAny, {
66
+ deviceId: string;
67
+ streamId: string;
68
+ }, {
69
+ deviceId: string;
70
+ streamId: string;
71
+ }>;
63
72
  }, "strip", z.ZodTypeAny, {
64
73
  type: "playbackTrack";
65
- source: string;
74
+ source: {
75
+ deviceId: string;
76
+ streamId: string;
77
+ };
66
78
  area: string;
67
79
  controllerId: string;
68
80
  }, {
69
81
  type: "playbackTrack";
70
- source: string;
82
+ source: {
83
+ deviceId: string;
84
+ streamId: string;
85
+ };
71
86
  area: string;
72
87
  controllerId: string;
73
88
  }>;
@@ -125,15 +140,30 @@ export declare const sViewAreaContents: z.ZodUnion<[z.ZodObject<{
125
140
  area: z.ZodString;
126
141
  type: z.ZodLiteral<"playbackTrack">;
127
142
  controllerId: z.ZodString;
128
- source: z.ZodString;
143
+ source: z.ZodObject<{
144
+ deviceId: z.ZodString;
145
+ streamId: z.ZodString;
146
+ }, "strip", z.ZodTypeAny, {
147
+ deviceId: string;
148
+ streamId: string;
149
+ }, {
150
+ deviceId: string;
151
+ streamId: string;
152
+ }>;
129
153
  }, "strip", z.ZodTypeAny, {
130
154
  type: "playbackTrack";
131
- source: string;
155
+ source: {
156
+ deviceId: string;
157
+ streamId: string;
158
+ };
132
159
  area: string;
133
160
  controllerId: string;
134
161
  }, {
135
162
  type: "playbackTrack";
136
- source: string;
163
+ source: {
164
+ deviceId: string;
165
+ streamId: string;
166
+ };
137
167
  area: string;
138
168
  controllerId: string;
139
169
  }>]>;
@@ -194,15 +224,30 @@ export declare const sViewConfig: z.ZodObject<{
194
224
  area: z.ZodString;
195
225
  type: z.ZodLiteral<"playbackTrack">;
196
226
  controllerId: z.ZodString;
197
- source: z.ZodString;
227
+ source: z.ZodObject<{
228
+ deviceId: z.ZodString;
229
+ streamId: z.ZodString;
230
+ }, "strip", z.ZodTypeAny, {
231
+ deviceId: string;
232
+ streamId: string;
233
+ }, {
234
+ deviceId: string;
235
+ streamId: string;
236
+ }>;
198
237
  }, "strip", z.ZodTypeAny, {
199
238
  type: "playbackTrack";
200
- source: string;
239
+ source: {
240
+ deviceId: string;
241
+ streamId: string;
242
+ };
201
243
  area: string;
202
244
  controllerId: string;
203
245
  }, {
204
246
  type: "playbackTrack";
205
- source: string;
247
+ source: {
248
+ deviceId: string;
249
+ streamId: string;
250
+ };
206
251
  area: string;
207
252
  controllerId: string;
208
253
  }>]>, "many">;
@@ -228,7 +273,10 @@ export declare const sViewConfig: z.ZodObject<{
228
273
  timeIntervalMs: number;
229
274
  } | {
230
275
  type: "playbackTrack";
231
- source: string;
276
+ source: {
277
+ deviceId: string;
278
+ streamId: string;
279
+ };
232
280
  area: string;
233
281
  controllerId: string;
234
282
  })[];
@@ -255,7 +303,10 @@ export declare const sViewConfig: z.ZodObject<{
255
303
  timeIntervalMs: number;
256
304
  } | {
257
305
  type: "playbackTrack";
258
- source: string;
306
+ source: {
307
+ deviceId: string;
308
+ streamId: string;
309
+ };
259
310
  area: string;
260
311
  controllerId: string;
261
312
  })[];
@@ -334,15 +385,30 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
334
385
  area: z.ZodString;
335
386
  type: z.ZodLiteral<"playbackTrack">;
336
387
  controllerId: z.ZodString;
337
- source: z.ZodString;
388
+ source: z.ZodObject<{
389
+ deviceId: z.ZodString;
390
+ streamId: z.ZodString;
391
+ }, "strip", z.ZodTypeAny, {
392
+ deviceId: string;
393
+ streamId: string;
394
+ }, {
395
+ deviceId: string;
396
+ streamId: string;
397
+ }>;
338
398
  }, "strip", z.ZodTypeAny, {
339
399
  type: "playbackTrack";
340
- source: string;
400
+ source: {
401
+ deviceId: string;
402
+ streamId: string;
403
+ };
341
404
  area: string;
342
405
  controllerId: string;
343
406
  }, {
344
407
  type: "playbackTrack";
345
- source: string;
408
+ source: {
409
+ deviceId: string;
410
+ streamId: string;
411
+ };
346
412
  area: string;
347
413
  controllerId: string;
348
414
  }>]>, "many">;
@@ -368,7 +434,10 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
368
434
  timeIntervalMs: number;
369
435
  } | {
370
436
  type: "playbackTrack";
371
- source: string;
437
+ source: {
438
+ deviceId: string;
439
+ streamId: string;
440
+ };
372
441
  area: string;
373
442
  controllerId: string;
374
443
  })[];
@@ -395,7 +464,10 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
395
464
  timeIntervalMs: number;
396
465
  } | {
397
466
  type: "playbackTrack";
398
- source: string;
467
+ source: {
468
+ deviceId: string;
469
+ streamId: string;
470
+ };
399
471
  area: string;
400
472
  controllerId: string;
401
473
  })[];
@@ -486,15 +558,30 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
486
558
  area: z.ZodString;
487
559
  type: z.ZodLiteral<"playbackTrack">;
488
560
  controllerId: z.ZodString;
489
- source: z.ZodString;
561
+ source: z.ZodObject<{
562
+ deviceId: z.ZodString;
563
+ streamId: z.ZodString;
564
+ }, "strip", z.ZodTypeAny, {
565
+ deviceId: string;
566
+ streamId: string;
567
+ }, {
568
+ deviceId: string;
569
+ streamId: string;
570
+ }>;
490
571
  }, "strip", z.ZodTypeAny, {
491
572
  type: "playbackTrack";
492
- source: string;
573
+ source: {
574
+ deviceId: string;
575
+ streamId: string;
576
+ };
493
577
  area: string;
494
578
  controllerId: string;
495
579
  }, {
496
580
  type: "playbackTrack";
497
- source: string;
581
+ source: {
582
+ deviceId: string;
583
+ streamId: string;
584
+ };
498
585
  area: string;
499
586
  controllerId: string;
500
587
  }>]>, "many">;
@@ -520,7 +607,10 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
520
607
  timeIntervalMs: number;
521
608
  } | {
522
609
  type: "playbackTrack";
523
- source: string;
610
+ source: {
611
+ deviceId: string;
612
+ streamId: string;
613
+ };
524
614
  area: string;
525
615
  controllerId: string;
526
616
  })[];
@@ -547,7 +637,10 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
547
637
  timeIntervalMs: number;
548
638
  } | {
549
639
  type: "playbackTrack";
550
- source: string;
640
+ source: {
641
+ deviceId: string;
642
+ streamId: string;
643
+ };
551
644
  area: string;
552
645
  controllerId: string;
553
646
  })[];
package/dist/objects/view.js CHANGED
@@ -26,10 +26,13 @@ exports.sPlaybackTrackArea = zod_1.z.object({
26
26
  area: zod_1.z.string().nonempty(),
27
27
  type: zod_1.z.literal('playbackTrack'),
28
28
  controllerId: zod_1.z.string().nonempty(),
29
- source: zod_1.z
30
- .string()
31
- .nonempty()
32
- .describe('The track within the controller. It is the device ID for the camera in the track.'),
29
+ source: zod_1.z.object({
30
+ deviceId: zod_1.z.string().nonempty(),
31
+ streamId: zod_1.z
32
+ .string()
33
+ .nonempty()
34
+ .describe('The track within the controller. It is the stream ID for the camera in the track.'),
35
+ }),
33
36
  });
34
37
  exports.sViewAreaContents = zod_1.z.union([
35
38
  exports.sLayoutArea,
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awarevue/api-types",
3
- "version": "2.0.38",
3
+ "version": "2.0.40",
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/primitives.d.ts CHANGED
@@ -100,8 +100,6 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
100
100
  }, {
101
101
  type: "alarm";
102
102
  }>, z.ZodObject<{
103
- lensType: z.ZodEnum<["flat", "fisheye"]>;
104
- mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
105
103
  ptzCapable: z.ZodBoolean;
106
104
  ptzPanSpeed: z.ZodNumber;
107
105
  ptzTiltSpeed: z.ZodNumber;
@@ -112,31 +110,46 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
112
110
  tiltMax: z.ZodNumber;
113
111
  zoomMin: z.ZodNumber;
114
112
  zoomMax: z.ZodNumber;
115
- recordingCapable: z.ZodBoolean;
116
- webrtcPlaybackSource: z.ZodNullable<z.ZodIntersection<z.ZodObject<{
117
- kind: z.ZodString;
118
- }, "strip", z.ZodTypeAny, {
119
- kind: string;
120
- }, {
121
- kind: string;
122
- }>, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
123
113
  streams: z.ZodArray<z.ZodObject<{
124
114
  id: z.ZodString;
125
115
  displayName: z.ZodString;
126
116
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
127
117
  rtspUrl: z.ZodString;
118
+ recordingCapable: z.ZodBoolean;
119
+ lensType: z.ZodEnum<["flat", "fisheye"]>;
120
+ mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
121
+ webrtcPlaybackSource: z.ZodNullable<z.ZodIntersection<z.ZodObject<{
122
+ kind: z.ZodString;
123
+ }, "strip", z.ZodTypeAny, {
124
+ kind: string;
125
+ }, {
126
+ kind: string;
127
+ }>, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
128
128
  }, "strip", z.ZodTypeAny, {
129
129
  id: string;
130
130
  displayName: string;
131
131
  externalPlayerUrl: string | null;
132
132
  rtspUrl: string;
133
+ recordingCapable: boolean;
134
+ lensType: "flat" | "fisheye";
135
+ mountPoint: "wall" | "ceiling" | "floor";
136
+ webrtcPlaybackSource: ({
137
+ kind: string;
138
+ } & Record<string, unknown>) | null;
133
139
  }, {
134
140
  id: string;
135
141
  displayName: string;
136
142
  externalPlayerUrl: string | null;
137
143
  rtspUrl: string;
144
+ recordingCapable: boolean;
145
+ lensType: "flat" | "fisheye";
146
+ mountPoint: "wall" | "ceiling" | "floor";
147
+ webrtcPlaybackSource: ({
148
+ kind: string;
149
+ } & Record<string, unknown>) | null;
138
150
  }>, "many">;
139
151
  defaultStreamId: z.ZodString;
152
+ streamNaming: z.ZodEnum<["cameraStreamNo", "cameraStream", "stream"]>;
140
153
  } & {
141
154
  type: z.ZodLiteral<"camera">;
142
155
  }, "strip", z.ZodTypeAny, {
@@ -146,9 +159,13 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
146
159
  displayName: string;
147
160
  externalPlayerUrl: string | null;
148
161
  rtspUrl: string;
162
+ recordingCapable: boolean;
163
+ lensType: "flat" | "fisheye";
164
+ mountPoint: "wall" | "ceiling" | "floor";
165
+ webrtcPlaybackSource: ({
166
+ kind: string;
167
+ } & Record<string, unknown>) | null;
149
168
  }[];
150
- lensType: "flat" | "fisheye";
151
- mountPoint: "wall" | "ceiling" | "floor";
152
169
  ptzCapable: boolean;
153
170
  ptzPanSpeed: number;
154
171
  ptzTiltSpeed: number;
@@ -159,11 +176,8 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
159
176
  tiltMax: number;
160
177
  zoomMin: number;
161
178
  zoomMax: number;
162
- recordingCapable: boolean;
163
- webrtcPlaybackSource: ({
164
- kind: string;
165
- } & Record<string, unknown>) | null;
166
179
  defaultStreamId: string;
180
+ streamNaming: "stream" | "cameraStreamNo" | "cameraStream";
167
181
  }, {
168
182
  type: "camera";
169
183
  streams: {
@@ -171,9 +185,13 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
171
185
  displayName: string;
172
186
  externalPlayerUrl: string | null;
173
187
  rtspUrl: string;
188
+ recordingCapable: boolean;
189
+ lensType: "flat" | "fisheye";
190
+ mountPoint: "wall" | "ceiling" | "floor";
191
+ webrtcPlaybackSource: ({
192
+ kind: string;
193
+ } & Record<string, unknown>) | null;
174
194
  }[];
175
- lensType: "flat" | "fisheye";
176
- mountPoint: "wall" | "ceiling" | "floor";
177
195
  ptzCapable: boolean;
178
196
  ptzPanSpeed: number;
179
197
  ptzTiltSpeed: number;
@@ -184,11 +202,8 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
184
202
  tiltMax: number;
185
203
  zoomMin: number;
186
204
  zoomMax: number;
187
- recordingCapable: boolean;
188
- webrtcPlaybackSource: ({
189
- kind: string;
190
- } & Record<string, unknown>) | null;
191
205
  defaultStreamId: string;
206
+ streamNaming: "stream" | "cameraStreamNo" | "cameraStream";
192
207
  }>, z.ZodObject<{
193
208
  canReportOpenState: z.ZodBoolean;
194
209
  canReportLockState: z.ZodBoolean;
@@ -407,8 +422,6 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
407
422
  }, {
408
423
  type: "alarm";
409
424
  }>, z.ZodObject<{
410
- lensType: z.ZodEnum<["flat", "fisheye"]>;
411
- mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
412
425
  ptzCapable: z.ZodBoolean;
413
426
  ptzPanSpeed: z.ZodNumber;
414
427
  ptzTiltSpeed: z.ZodNumber;
@@ -419,31 +432,46 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
419
432
  tiltMax: z.ZodNumber;
420
433
  zoomMin: z.ZodNumber;
421
434
  zoomMax: z.ZodNumber;
422
- recordingCapable: z.ZodBoolean;
423
- webrtcPlaybackSource: z.ZodNullable<z.ZodIntersection<z.ZodObject<{
424
- kind: z.ZodString;
425
- }, "strip", z.ZodTypeAny, {
426
- kind: string;
427
- }, {
428
- kind: string;
429
- }>, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
430
435
  streams: z.ZodArray<z.ZodObject<{
431
436
  id: z.ZodString;
432
437
  displayName: z.ZodString;
433
438
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
434
439
  rtspUrl: z.ZodString;
440
+ recordingCapable: z.ZodBoolean;
441
+ lensType: z.ZodEnum<["flat", "fisheye"]>;
442
+ mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
443
+ webrtcPlaybackSource: z.ZodNullable<z.ZodIntersection<z.ZodObject<{
444
+ kind: z.ZodString;
445
+ }, "strip", z.ZodTypeAny, {
446
+ kind: string;
447
+ }, {
448
+ kind: string;
449
+ }>, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
435
450
  }, "strip", z.ZodTypeAny, {
436
451
  id: string;
437
452
  displayName: string;
438
453
  externalPlayerUrl: string | null;
439
454
  rtspUrl: string;
455
+ recordingCapable: boolean;
456
+ lensType: "flat" | "fisheye";
457
+ mountPoint: "wall" | "ceiling" | "floor";
458
+ webrtcPlaybackSource: ({
459
+ kind: string;
460
+ } & Record<string, unknown>) | null;
440
461
  }, {
441
462
  id: string;
442
463
  displayName: string;
443
464
  externalPlayerUrl: string | null;
444
465
  rtspUrl: string;
466
+ recordingCapable: boolean;
467
+ lensType: "flat" | "fisheye";
468
+ mountPoint: "wall" | "ceiling" | "floor";
469
+ webrtcPlaybackSource: ({
470
+ kind: string;
471
+ } & Record<string, unknown>) | null;
445
472
  }>, "many">;
446
473
  defaultStreamId: z.ZodString;
474
+ streamNaming: z.ZodEnum<["cameraStreamNo", "cameraStream", "stream"]>;
447
475
  } & {
448
476
  type: z.ZodLiteral<"camera">;
449
477
  }, "strip", z.ZodTypeAny, {
@@ -453,9 +481,13 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
453
481
  displayName: string;
454
482
  externalPlayerUrl: string | null;
455
483
  rtspUrl: string;
484
+ recordingCapable: boolean;
485
+ lensType: "flat" | "fisheye";
486
+ mountPoint: "wall" | "ceiling" | "floor";
487
+ webrtcPlaybackSource: ({
488
+ kind: string;
489
+ } & Record<string, unknown>) | null;
456
490
  }[];
457
- lensType: "flat" | "fisheye";
458
- mountPoint: "wall" | "ceiling" | "floor";
459
491
  ptzCapable: boolean;
460
492
  ptzPanSpeed: number;
461
493
  ptzTiltSpeed: number;
@@ -466,11 +498,8 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
466
498
  tiltMax: number;
467
499
  zoomMin: number;
468
500
  zoomMax: number;
469
- recordingCapable: boolean;
470
- webrtcPlaybackSource: ({
471
- kind: string;
472
- } & Record<string, unknown>) | null;
473
501
  defaultStreamId: string;
502
+ streamNaming: "stream" | "cameraStreamNo" | "cameraStream";
474
503
  }, {
475
504
  type: "camera";
476
505
  streams: {
@@ -478,9 +507,13 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
478
507
  displayName: string;
479
508
  externalPlayerUrl: string | null;
480
509
  rtspUrl: string;
510
+ recordingCapable: boolean;
511
+ lensType: "flat" | "fisheye";
512
+ mountPoint: "wall" | "ceiling" | "floor";
513
+ webrtcPlaybackSource: ({
514
+ kind: string;
515
+ } & Record<string, unknown>) | null;
481
516
  }[];
482
- lensType: "flat" | "fisheye";
483
- mountPoint: "wall" | "ceiling" | "floor";
484
517
  ptzCapable: boolean;
485
518
  ptzPanSpeed: number;
486
519
  ptzTiltSpeed: number;
@@ -491,11 +524,8 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
491
524
  tiltMax: number;
492
525
  zoomMin: number;
493
526
  zoomMax: number;
494
- recordingCapable: boolean;
495
- webrtcPlaybackSource: ({
496
- kind: string;
497
- } & Record<string, unknown>) | null;
498
527
  defaultStreamId: string;
528
+ streamNaming: "stream" | "cameraStreamNo" | "cameraStream";
499
529
  }>, z.ZodObject<{
500
530
  canReportOpenState: z.ZodBoolean;
501
531
  canReportLockState: z.ZodBoolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awarevue/api-types",
3
- "version": "2.0.38",
3
+ "version": "2.0.40",
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",