@awarevue/api-types 2.0.16 → 2.0.18

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 (16) hide show
  1. package/dist/agent-communication/protocol.d.ts +214 -2
  2. package/dist/commands/all.d.ts +188 -10
  3. package/dist/commands/display.d.ts +28 -28
  4. package/dist/commands/nvr-exporter.d.ts +178 -0
  5. package/dist/commands/server.d.ts +178 -0
  6. package/dist/device/any-device.d.ts +15 -0
  7. package/dist/device/camera.d.ts +8 -0
  8. package/dist/device/camera.js +1 -0
  9. package/dist/device-import.d.ts +26 -0
  10. package/dist/package.json +1 -1
  11. package/dist/primitives.d.ts +99 -0
  12. package/dist/primitives.js +2 -2
  13. package/dist/queries/all.d.ts +211 -4
  14. package/dist/queries/camera.d.ts +8 -8
  15. package/dist/queries/nvr-recorder.d.ts +414 -0
  16. package/package.json +1 -1
package/dist/device-import.d.ts CHANGED
@@ -57,14 +57,17 @@ export declare const sImportedDevice: z.ZodIntersection<z.ZodIntersection<z.ZodO
57
57
  id: z.ZodString;
58
58
  displayName: z.ZodString;
59
59
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
60
+ rtspUrl: z.ZodString;
60
61
  }, "strip", z.ZodTypeAny, {
61
62
  id: string;
62
63
  displayName: string;
63
64
  externalPlayerUrl: string | null;
65
+ rtspUrl: string;
64
66
  }, {
65
67
  id: string;
66
68
  displayName: string;
67
69
  externalPlayerUrl: string | null;
70
+ rtspUrl: string;
68
71
  }>, "many">;
69
72
  defaultStreamId: z.ZodString;
70
73
  } & {
@@ -75,6 +78,7 @@ export declare const sImportedDevice: z.ZodIntersection<z.ZodIntersection<z.ZodO
75
78
  id: string;
76
79
  displayName: string;
77
80
  externalPlayerUrl: string | null;
81
+ rtspUrl: string;
78
82
  }[];
79
83
  lensType: "flat" | "fisheye";
80
84
  mountPoint: "wall" | "ceiling" | "floor";
@@ -99,6 +103,7 @@ export declare const sImportedDevice: z.ZodIntersection<z.ZodIntersection<z.ZodO
99
103
  id: string;
100
104
  displayName: string;
101
105
  externalPlayerUrl: string | null;
106
+ rtspUrl: string;
102
107
  }[];
103
108
  lensType: "flat" | "fisheye";
104
109
  mountPoint: "wall" | "ceiling" | "floor";
@@ -327,14 +332,17 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
327
332
  id: z.ZodString;
328
333
  displayName: z.ZodString;
329
334
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
335
+ rtspUrl: z.ZodString;
330
336
  }, "strip", z.ZodTypeAny, {
331
337
  id: string;
332
338
  displayName: string;
333
339
  externalPlayerUrl: string | null;
340
+ rtspUrl: string;
334
341
  }, {
335
342
  id: string;
336
343
  displayName: string;
337
344
  externalPlayerUrl: string | null;
345
+ rtspUrl: string;
338
346
  }>, "many">;
339
347
  defaultStreamId: z.ZodString;
340
348
  } & {
@@ -345,6 +353,7 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
345
353
  id: string;
346
354
  displayName: string;
347
355
  externalPlayerUrl: string | null;
356
+ rtspUrl: string;
348
357
  }[];
349
358
  lensType: "flat" | "fisheye";
350
359
  mountPoint: "wall" | "ceiling" | "floor";
@@ -369,6 +378,7 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
369
378
  id: string;
370
379
  displayName: string;
371
380
  externalPlayerUrl: string | null;
381
+ rtspUrl: string;
372
382
  }[];
373
383
  lensType: "flat" | "fisheye";
374
384
  mountPoint: "wall" | "ceiling" | "floor";
@@ -567,6 +577,7 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
567
577
  id: string;
568
578
  displayName: string;
569
579
  externalPlayerUrl: string | null;
580
+ rtspUrl: string;
570
581
  }[];
571
582
  lensType: "flat" | "fisheye";
572
583
  mountPoint: "wall" | "ceiling" | "floor";
@@ -659,6 +670,7 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
659
670
  id: string;
660
671
  displayName: string;
661
672
  externalPlayerUrl: string | null;
673
+ rtspUrl: string;
662
674
  }[];
663
675
  lensType: "flat" | "fisheye";
664
676
  mountPoint: "wall" | "ceiling" | "floor";
@@ -791,14 +803,17 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
791
803
  id: z.ZodString;
792
804
  displayName: z.ZodString;
793
805
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
806
+ rtspUrl: z.ZodString;
794
807
  }, "strip", z.ZodTypeAny, {
795
808
  id: string;
796
809
  displayName: string;
797
810
  externalPlayerUrl: string | null;
811
+ rtspUrl: string;
798
812
  }, {
799
813
  id: string;
800
814
  displayName: string;
801
815
  externalPlayerUrl: string | null;
816
+ rtspUrl: string;
802
817
  }>, "many">;
803
818
  defaultStreamId: z.ZodString;
804
819
  } & {
@@ -809,6 +824,7 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
809
824
  id: string;
810
825
  displayName: string;
811
826
  externalPlayerUrl: string | null;
827
+ rtspUrl: string;
812
828
  }[];
813
829
  lensType: "flat" | "fisheye";
814
830
  mountPoint: "wall" | "ceiling" | "floor";
@@ -833,6 +849,7 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
833
849
  id: string;
834
850
  displayName: string;
835
851
  externalPlayerUrl: string | null;
852
+ rtspUrl: string;
836
853
  }[];
837
854
  lensType: "flat" | "fisheye";
838
855
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1038,14 +1055,17 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1038
1055
  id: z.ZodString;
1039
1056
  displayName: z.ZodString;
1040
1057
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
1058
+ rtspUrl: z.ZodString;
1041
1059
  }, "strip", z.ZodTypeAny, {
1042
1060
  id: string;
1043
1061
  displayName: string;
1044
1062
  externalPlayerUrl: string | null;
1063
+ rtspUrl: string;
1045
1064
  }, {
1046
1065
  id: string;
1047
1066
  displayName: string;
1048
1067
  externalPlayerUrl: string | null;
1068
+ rtspUrl: string;
1049
1069
  }>, "many">;
1050
1070
  defaultStreamId: z.ZodString;
1051
1071
  } & {
@@ -1056,6 +1076,7 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1056
1076
  id: string;
1057
1077
  displayName: string;
1058
1078
  externalPlayerUrl: string | null;
1079
+ rtspUrl: string;
1059
1080
  }[];
1060
1081
  lensType: "flat" | "fisheye";
1061
1082
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1080,6 +1101,7 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1080
1101
  id: string;
1081
1102
  displayName: string;
1082
1103
  externalPlayerUrl: string | null;
1104
+ rtspUrl: string;
1083
1105
  }[];
1084
1106
  lensType: "flat" | "fisheye";
1085
1107
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1380,6 +1402,7 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1380
1402
  id: string;
1381
1403
  displayName: string;
1382
1404
  externalPlayerUrl: string | null;
1405
+ rtspUrl: string;
1383
1406
  }[];
1384
1407
  lensType: "flat" | "fisheye";
1385
1408
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1496,6 +1519,7 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1496
1519
  id: string;
1497
1520
  displayName: string;
1498
1521
  externalPlayerUrl: string | null;
1522
+ rtspUrl: string;
1499
1523
  }[];
1500
1524
  lensType: "flat" | "fisheye";
1501
1525
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1579,6 +1603,7 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1579
1603
  id: string;
1580
1604
  displayName: string;
1581
1605
  externalPlayerUrl: string | null;
1606
+ rtspUrl: string;
1582
1607
  }[];
1583
1608
  lensType: "flat" | "fisheye";
1584
1609
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1695,6 +1720,7 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1695
1720
  id: string;
1696
1721
  displayName: string;
1697
1722
  externalPlayerUrl: string | null;
1723
+ rtspUrl: string;
1698
1724
  }[];
1699
1725
  lensType: "flat" | "fisheye";
1700
1726
  mountPoint: "wall" | "ceiling" | "floor";
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awarevue/api-types",
3
- "version": "2.0.16",
3
+ "version": "2.0.18",
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
@@ -22,6 +22,32 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
22
22
  foreignRef: z.ZodString;
23
23
  provider: z.ZodString;
24
24
  providerMetadata: z.ZodObject<{}, "strip", z.ZodUnknown, z.objectOutputType<{}, z.ZodUnknown, "strip">, z.objectInputType<{}, z.ZodUnknown, "strip">>;
25
+ } & {
26
+ presets: z.ZodArray<z.ZodObject<{
27
+ id: z.ZodString;
28
+ name: z.ZodString;
29
+ params: z.ZodUnknown;
30
+ isDefault: z.ZodBoolean;
31
+ assignedRef: z.ZodNullable<z.ZodString>;
32
+ createdOn: z.ZodString;
33
+ lastModifiedOn: z.ZodString;
34
+ }, "strip", z.ZodTypeAny, {
35
+ name: string;
36
+ id: string;
37
+ isDefault: boolean;
38
+ assignedRef: string | null;
39
+ createdOn: string;
40
+ lastModifiedOn: string;
41
+ params?: unknown;
42
+ }, {
43
+ name: string;
44
+ id: string;
45
+ isDefault: boolean;
46
+ assignedRef: string | null;
47
+ createdOn: string;
48
+ lastModifiedOn: string;
49
+ params?: unknown;
50
+ }>, "many">;
25
51
  }, "strip", z.ZodTypeAny, {
26
52
  name: string;
27
53
  foreignRef: string;
@@ -29,6 +55,15 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
29
55
  providerMetadata: {} & {
30
56
  [k: string]: unknown;
31
57
  };
58
+ presets: {
59
+ name: string;
60
+ id: string;
61
+ isDefault: boolean;
62
+ assignedRef: string | null;
63
+ createdOn: string;
64
+ lastModifiedOn: string;
65
+ params?: unknown;
66
+ }[];
32
67
  }, {
33
68
  name: string;
34
69
  foreignRef: string;
@@ -36,6 +71,15 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
36
71
  providerMetadata: {} & {
37
72
  [k: string]: unknown;
38
73
  };
74
+ presets: {
75
+ name: string;
76
+ id: string;
77
+ isDefault: boolean;
78
+ assignedRef: string | null;
79
+ createdOn: string;
80
+ lastModifiedOn: string;
81
+ params?: unknown;
82
+ }[];
39
83
  }>, z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
40
84
  type: z.ZodLiteral<"alarm">;
41
85
  }, "strip", z.ZodTypeAny, {
@@ -67,14 +111,17 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
67
111
  id: z.ZodString;
68
112
  displayName: z.ZodString;
69
113
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
114
+ rtspUrl: z.ZodString;
70
115
  }, "strip", z.ZodTypeAny, {
71
116
  id: string;
72
117
  displayName: string;
73
118
  externalPlayerUrl: string | null;
119
+ rtspUrl: string;
74
120
  }, {
75
121
  id: string;
76
122
  displayName: string;
77
123
  externalPlayerUrl: string | null;
124
+ rtspUrl: string;
78
125
  }>, "many">;
79
126
  defaultStreamId: z.ZodString;
80
127
  } & {
@@ -85,6 +132,7 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
85
132
  id: string;
86
133
  displayName: string;
87
134
  externalPlayerUrl: string | null;
135
+ rtspUrl: string;
88
136
  }[];
89
137
  lensType: "flat" | "fisheye";
90
138
  mountPoint: "wall" | "ceiling" | "floor";
@@ -109,6 +157,7 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
109
157
  id: string;
110
158
  displayName: string;
111
159
  externalPlayerUrl: string | null;
160
+ rtspUrl: string;
112
161
  }[];
113
162
  lensType: "flat" | "fisheye";
114
163
  mountPoint: "wall" | "ceiling" | "floor";
@@ -270,12 +319,39 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
270
319
  }, {
271
320
  type: "system";
272
321
  }>]>>;
322
+ export type AgentDeviceInfo = z.infer<typeof sAgentDeviceInfo>;
273
323
  export declare const sForeignDeviceId: z.ZodTuple<[z.ZodString, z.ZodString], null>;
274
324
  export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodIntersection<z.ZodObject<{
275
325
  name: z.ZodString;
276
326
  foreignRef: z.ZodString;
277
327
  provider: z.ZodString;
278
328
  providerMetadata: z.ZodObject<{}, "strip", z.ZodUnknown, z.objectOutputType<{}, z.ZodUnknown, "strip">, z.objectInputType<{}, z.ZodUnknown, "strip">>;
329
+ } & {
330
+ presets: z.ZodArray<z.ZodObject<{
331
+ id: z.ZodString;
332
+ name: z.ZodString;
333
+ params: z.ZodUnknown;
334
+ isDefault: z.ZodBoolean;
335
+ assignedRef: z.ZodNullable<z.ZodString>;
336
+ createdOn: z.ZodString;
337
+ lastModifiedOn: z.ZodString;
338
+ }, "strip", z.ZodTypeAny, {
339
+ name: string;
340
+ id: string;
341
+ isDefault: boolean;
342
+ assignedRef: string | null;
343
+ createdOn: string;
344
+ lastModifiedOn: string;
345
+ params?: unknown;
346
+ }, {
347
+ name: string;
348
+ id: string;
349
+ isDefault: boolean;
350
+ assignedRef: string | null;
351
+ createdOn: string;
352
+ lastModifiedOn: string;
353
+ params?: unknown;
354
+ }>, "many">;
279
355
  }, "strip", z.ZodTypeAny, {
280
356
  name: string;
281
357
  foreignRef: string;
@@ -283,6 +359,15 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
283
359
  providerMetadata: {} & {
284
360
  [k: string]: unknown;
285
361
  };
362
+ presets: {
363
+ name: string;
364
+ id: string;
365
+ isDefault: boolean;
366
+ assignedRef: string | null;
367
+ createdOn: string;
368
+ lastModifiedOn: string;
369
+ params?: unknown;
370
+ }[];
286
371
  }, {
287
372
  name: string;
288
373
  foreignRef: string;
@@ -290,6 +375,15 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
290
375
  providerMetadata: {} & {
291
376
  [k: string]: unknown;
292
377
  };
378
+ presets: {
379
+ name: string;
380
+ id: string;
381
+ isDefault: boolean;
382
+ assignedRef: string | null;
383
+ createdOn: string;
384
+ lastModifiedOn: string;
385
+ params?: unknown;
386
+ }[];
293
387
  }>, z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
294
388
  type: z.ZodLiteral<"alarm">;
295
389
  }, "strip", z.ZodTypeAny, {
@@ -321,14 +415,17 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
321
415
  id: z.ZodString;
322
416
  displayName: z.ZodString;
323
417
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
418
+ rtspUrl: z.ZodString;
324
419
  }, "strip", z.ZodTypeAny, {
325
420
  id: string;
326
421
  displayName: string;
327
422
  externalPlayerUrl: string | null;
423
+ rtspUrl: string;
328
424
  }, {
329
425
  id: string;
330
426
  displayName: string;
331
427
  externalPlayerUrl: string | null;
428
+ rtspUrl: string;
332
429
  }>, "many">;
333
430
  defaultStreamId: z.ZodString;
334
431
  } & {
@@ -339,6 +436,7 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
339
436
  id: string;
340
437
  displayName: string;
341
438
  externalPlayerUrl: string | null;
439
+ rtspUrl: string;
342
440
  }[];
343
441
  lensType: "flat" | "fisheye";
344
442
  mountPoint: "wall" | "ceiling" | "floor";
@@ -363,6 +461,7 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
363
461
  id: string;
364
462
  displayName: string;
365
463
  externalPlayerUrl: string | null;
464
+ rtspUrl: string;
366
465
  }[];
367
466
  lensType: "flat" | "fisheye";
368
467
  mountPoint: "wall" | "ceiling" | "floor";
package/dist/primitives.js CHANGED
@@ -18,9 +18,9 @@ exports.sFileResponse = zod_1.z
18
18
  data: zod_1.z.string().nonempty(),
19
19
  })
20
20
  .nullable();
21
- exports.sAgentDeviceInfo = zod_1.z.intersection(device_1.sForeignDeviceInfo, device_1.sAnyDeviceSpecs, zod_1.z.object({
21
+ exports.sAgentDeviceInfo = zod_1.z.intersection(device_1.sForeignDeviceInfo.merge(zod_1.z.object({
22
22
  presets: zod_1.z.array(device_1.sPresetDto),
23
- }));
23
+ })), device_1.sAnyDeviceSpecs);
24
24
  exports.sForeignDeviceId = zod_1.z.tuple([
25
25
  zod_1.z.string().nonempty().describe('Foreign system identifier'),
26
26
  zod_1.z.string().nonempty().describe('Device identifier in foreign system'),