@awarevue/api-types 2.0.53 → 2.0.54

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 (67) hide show
  1. package/dist/api/agent-protocol/protocol.d.ts +853 -840
  2. package/dist/api/agent-protocol/protocol.js +14 -1
  3. package/dist/api/commands/all.d.ts +224 -224
  4. package/dist/api/commands/camera.d.ts +16 -16
  5. package/dist/api/commands/display.d.ts +48 -48
  6. package/dist/api/commands/nvr-exporter.d.ts +194 -194
  7. package/dist/api/commands/server.d.ts +202 -202
  8. package/dist/api/events/all.d.ts +30 -30
  9. package/dist/api/events/camera.d.ts +42 -42
  10. package/dist/api/events/door.d.ts +4 -4
  11. package/dist/api/events/intercom-terminal.d.ts +8 -8
  12. package/dist/api/events/io-board.d.ts +4 -4
  13. package/dist/api/queries/all.d.ts +225 -225
  14. package/dist/api/queries/camera.d.ts +8 -8
  15. package/dist/api/queries/nvr-analytics-server.d.ts +36 -36
  16. package/dist/api/queries/nvr-exporter.d.ts +18 -18
  17. package/dist/api/queries/nvr-recorder.d.ts +398 -398
  18. package/dist/api/rest/agreement.d.ts +5 -5
  19. package/dist/api/rest/automation.d.ts +46 -46
  20. package/dist/api/rest/bookmarks.d.ts +12 -12
  21. package/dist/api/rest/custom-field.d.ts +5 -5
  22. package/dist/api/rest/device.d.ts +6 -6
  23. package/dist/api/rest/io-device.d.ts +14 -14
  24. package/dist/api/rest/layout.d.ts +16 -16
  25. package/dist/api/rest/macros.d.ts +13 -13
  26. package/dist/api/rest/media.d.ts +16 -16
  27. package/dist/api/rest/person.d.ts +12 -12
  28. package/dist/api/rest/query.d.ts +2 -2
  29. package/dist/api/rest/schedule.d.ts +24 -24
  30. package/dist/api/rest/security-level.d.ts +10 -10
  31. package/dist/api/rest/template.d.ts +4 -4
  32. package/dist/api/rest/token-conversion.d.ts +5 -5
  33. package/dist/api/rest/user.d.ts +17 -17
  34. package/dist/api/rest/view.d.ts +44 -44
  35. package/dist/api/ws/device-communication.d.ts +6 -6
  36. package/dist/api/ws/notifications.d.ts +4 -4
  37. package/dist/api/ws/progress.d.ts +15 -15
  38. package/dist/api/ws/web-rtc-signaling.d.ts +2 -2
  39. package/dist/objects/access-rule.d.ts +2 -2
  40. package/dist/objects/agent-metadata.d.ts +16 -16
  41. package/dist/objects/agreement.d.ts +2 -2
  42. package/dist/objects/api-key.d.ts +2 -2
  43. package/dist/objects/automation-rule.d.ts +34 -34
  44. package/dist/objects/bookmark.d.ts +8 -8
  45. package/dist/objects/credential.d.ts +2 -2
  46. package/dist/objects/custom-field.d.ts +2 -2
  47. package/dist/objects/device/any-device.d.ts +205 -205
  48. package/dist/objects/device/camera.d.ts +26 -26
  49. package/dist/objects/device/device-import.d.ts +277 -277
  50. package/dist/objects/device/door.d.ts +2 -2
  51. package/dist/objects/device/intercom-terminal.d.ts +2 -2
  52. package/dist/objects/layout.d.ts +16 -16
  53. package/dist/objects/macro.d.ts +14 -14
  54. package/dist/objects/notification.d.ts +4 -4
  55. package/dist/objects/person-presence.d.ts +12 -12
  56. package/dist/objects/person.d.ts +14 -14
  57. package/dist/objects/role.d.ts +2 -2
  58. package/dist/objects/schedule.d.ts +36 -36
  59. package/dist/objects/security-level.d.ts +6 -6
  60. package/dist/objects/template.d.ts +2 -2
  61. package/dist/objects/token-conversion.d.ts +2 -2
  62. package/dist/objects/user.d.ts +4 -4
  63. package/dist/objects/view.d.ts +58 -58
  64. package/dist/objects/zone.d.ts +2 -2
  65. package/dist/package.json +1 -1
  66. package/dist/primitives.d.ts +60 -60
  67. package/package.json +1 -1
package/dist/objects/view.d.ts CHANGED
@@ -31,13 +31,13 @@ export declare const sDeviceArea: z.ZodObject<{
31
31
  streamId: z.ZodOptional<z.ZodString>;
32
32
  }, "strip", z.ZodTypeAny, {
33
33
  type: "device";
34
- area: string;
35
34
  deviceId: string;
35
+ area: string;
36
36
  streamId?: string | undefined;
37
37
  }, {
38
38
  type: "device";
39
- area: string;
40
39
  deviceId: string;
40
+ area: string;
41
41
  streamId?: string | undefined;
42
42
  }>;
43
43
  export type DeviceArea = z.infer<typeof sDeviceArea>;
@@ -92,20 +92,20 @@ export declare const sPlaybackTrackArea: z.ZodObject<{
92
92
  }>;
93
93
  }, "strip", z.ZodTypeAny, {
94
94
  type: "playbackTrack";
95
+ area: string;
96
+ controllerId: string;
95
97
  source: {
96
98
  deviceId: string;
97
99
  streamId: string;
98
100
  };
99
- area: string;
100
- controllerId: string;
101
101
  }, {
102
102
  type: "playbackTrack";
103
+ area: string;
104
+ controllerId: string;
103
105
  source: {
104
106
  deviceId: string;
105
107
  streamId: string;
106
108
  };
107
- area: string;
108
- controllerId: string;
109
109
  }>;
110
110
  export type PlaybackTrackArea = z.infer<typeof sPlaybackTrackArea>;
111
111
  export type ViewAreaContents = LayoutArea | LayoutSelectorArea | DeviceArea | DeviceCarouselArea | PlaybackTrackArea;
@@ -137,13 +137,13 @@ export declare const sViewAreaContents: z.ZodUnion<[z.ZodObject<{
137
137
  streamId: z.ZodOptional<z.ZodString>;
138
138
  }, "strip", z.ZodTypeAny, {
139
139
  type: "device";
140
- area: string;
141
140
  deviceId: string;
141
+ area: string;
142
142
  streamId?: string | undefined;
143
143
  }, {
144
144
  type: "device";
145
- area: string;
146
145
  deviceId: string;
146
+ area: string;
147
147
  streamId?: string | undefined;
148
148
  }>, z.ZodObject<{
149
149
  area: z.ZodString;
@@ -194,20 +194,20 @@ export declare const sViewAreaContents: z.ZodUnion<[z.ZodObject<{
194
194
  }>;
195
195
  }, "strip", z.ZodTypeAny, {
196
196
  type: "playbackTrack";
197
+ area: string;
198
+ controllerId: string;
197
199
  source: {
198
200
  deviceId: string;
199
201
  streamId: string;
200
202
  };
201
- area: string;
202
- controllerId: string;
203
203
  }, {
204
204
  type: "playbackTrack";
205
+ area: string;
206
+ controllerId: string;
205
207
  source: {
206
208
  deviceId: string;
207
209
  streamId: string;
208
210
  };
209
- area: string;
210
- controllerId: string;
211
211
  }>]>;
212
212
  export declare const sViewConfig: z.ZodObject<{
213
213
  rows: z.ZodNumber;
@@ -242,13 +242,13 @@ export declare const sViewConfig: z.ZodObject<{
242
242
  streamId: z.ZodOptional<z.ZodString>;
243
243
  }, "strip", z.ZodTypeAny, {
244
244
  type: "device";
245
- area: string;
246
245
  deviceId: string;
246
+ area: string;
247
247
  streamId?: string | undefined;
248
248
  }, {
249
249
  type: "device";
250
- area: string;
251
250
  deviceId: string;
251
+ area: string;
252
252
  streamId?: string | undefined;
253
253
  }>, z.ZodObject<{
254
254
  area: z.ZodString;
@@ -299,24 +299,24 @@ export declare const sViewConfig: z.ZodObject<{
299
299
  }>;
300
300
  }, "strip", z.ZodTypeAny, {
301
301
  type: "playbackTrack";
302
+ area: string;
303
+ controllerId: string;
302
304
  source: {
303
305
  deviceId: string;
304
306
  streamId: string;
305
307
  };
306
- area: string;
307
- controllerId: string;
308
308
  }, {
309
309
  type: "playbackTrack";
310
+ area: string;
311
+ controllerId: string;
310
312
  source: {
311
313
  deviceId: string;
312
314
  streamId: string;
313
315
  };
314
- area: string;
315
- controllerId: string;
316
316
  }>]>, "many">;
317
317
  }, "strip", z.ZodTypeAny, {
318
- columns: number;
319
318
  rows: number;
319
+ columns: number;
320
320
  areas: string[][];
321
321
  contents: ({
322
322
  type: "layout";
@@ -327,8 +327,8 @@ export declare const sViewConfig: z.ZodObject<{
327
327
  area: string;
328
328
  } | {
329
329
  type: "device";
330
- area: string;
331
330
  deviceId: string;
331
+ area: string;
332
332
  streamId?: string | undefined;
333
333
  } | {
334
334
  type: "deviceCarousel";
@@ -341,17 +341,17 @@ export declare const sViewConfig: z.ZodObject<{
341
341
  }[] | undefined;
342
342
  } | {
343
343
  type: "playbackTrack";
344
+ area: string;
345
+ controllerId: string;
344
346
  source: {
345
347
  deviceId: string;
346
348
  streamId: string;
347
349
  };
348
- area: string;
349
- controllerId: string;
350
350
  })[];
351
351
  hotspotArea?: string | undefined;
352
352
  }, {
353
- columns: number;
354
353
  rows: number;
354
+ columns: number;
355
355
  areas: string[][];
356
356
  contents: ({
357
357
  type: "layout";
@@ -362,8 +362,8 @@ export declare const sViewConfig: z.ZodObject<{
362
362
  area: string;
363
363
  } | {
364
364
  type: "device";
365
- area: string;
366
365
  deviceId: string;
366
+ area: string;
367
367
  streamId?: string | undefined;
368
368
  } | {
369
369
  type: "deviceCarousel";
@@ -376,12 +376,12 @@ export declare const sViewConfig: z.ZodObject<{
376
376
  }[] | undefined;
377
377
  } | {
378
378
  type: "playbackTrack";
379
+ area: string;
380
+ controllerId: string;
379
381
  source: {
380
382
  deviceId: string;
381
383
  streamId: string;
382
384
  };
383
- area: string;
384
- controllerId: string;
385
385
  })[];
386
386
  hotspotArea?: string | undefined;
387
387
  }>;
@@ -434,13 +434,13 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
434
434
  streamId: z.ZodOptional<z.ZodString>;
435
435
  }, "strip", z.ZodTypeAny, {
436
436
  type: "device";
437
- area: string;
438
437
  deviceId: string;
438
+ area: string;
439
439
  streamId?: string | undefined;
440
440
  }, {
441
441
  type: "device";
442
- area: string;
443
442
  deviceId: string;
443
+ area: string;
444
444
  streamId?: string | undefined;
445
445
  }>, z.ZodObject<{
446
446
  area: z.ZodString;
@@ -491,24 +491,24 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
491
491
  }>;
492
492
  }, "strip", z.ZodTypeAny, {
493
493
  type: "playbackTrack";
494
+ area: string;
495
+ controllerId: string;
494
496
  source: {
495
497
  deviceId: string;
496
498
  streamId: string;
497
499
  };
498
- area: string;
499
- controllerId: string;
500
500
  }, {
501
501
  type: "playbackTrack";
502
+ area: string;
503
+ controllerId: string;
502
504
  source: {
503
505
  deviceId: string;
504
506
  streamId: string;
505
507
  };
506
- area: string;
507
- controllerId: string;
508
508
  }>]>, "many">;
509
509
  }, "strip", z.ZodTypeAny, {
510
- columns: number;
511
510
  rows: number;
511
+ columns: number;
512
512
  areas: string[][];
513
513
  contents: ({
514
514
  type: "layout";
@@ -519,8 +519,8 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
519
519
  area: string;
520
520
  } | {
521
521
  type: "device";
522
- area: string;
523
522
  deviceId: string;
523
+ area: string;
524
524
  streamId?: string | undefined;
525
525
  } | {
526
526
  type: "deviceCarousel";
@@ -533,17 +533,17 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
533
533
  }[] | undefined;
534
534
  } | {
535
535
  type: "playbackTrack";
536
+ area: string;
537
+ controllerId: string;
536
538
  source: {
537
539
  deviceId: string;
538
540
  streamId: string;
539
541
  };
540
- area: string;
541
- controllerId: string;
542
542
  })[];
543
543
  hotspotArea?: string | undefined;
544
544
  }, {
545
- columns: number;
546
545
  rows: number;
546
+ columns: number;
547
547
  areas: string[][];
548
548
  contents: ({
549
549
  type: "layout";
@@ -554,8 +554,8 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
554
554
  area: string;
555
555
  } | {
556
556
  type: "device";
557
- area: string;
558
557
  deviceId: string;
558
+ area: string;
559
559
  streamId?: string | undefined;
560
560
  } | {
561
561
  type: "deviceCarousel";
@@ -568,12 +568,12 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
568
568
  }[] | undefined;
569
569
  } | {
570
570
  type: "playbackTrack";
571
+ area: string;
572
+ controllerId: string;
571
573
  source: {
572
574
  deviceId: string;
573
575
  streamId: string;
574
576
  };
575
- area: string;
576
- controllerId: string;
577
577
  })[];
578
578
  hotspotArea?: string | undefined;
579
579
  }>>;
@@ -588,20 +588,20 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
588
588
  createdOn: z.ZodString;
589
589
  lastModifiedOn: z.ZodString;
590
590
  }, "strip", z.ZodTypeAny, {
591
- name: string;
592
591
  id: string;
593
- order: number;
592
+ name: string;
594
593
  createdOn: string;
595
594
  lastModifiedOn: string;
595
+ order: number;
596
596
  isDefault: boolean;
597
597
  createdBy: string;
598
598
  isPublic: boolean;
599
599
  }, {
600
- name: string;
601
600
  id: string;
602
- order: number;
601
+ name: string;
603
602
  createdOn: string;
604
603
  lastModifiedOn: string;
604
+ order: number;
605
605
  isDefault: boolean;
606
606
  createdBy: string;
607
607
  isPublic: boolean;
@@ -638,13 +638,13 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
638
638
  streamId: z.ZodOptional<z.ZodString>;
639
639
  }, "strip", z.ZodTypeAny, {
640
640
  type: "device";
641
- area: string;
642
641
  deviceId: string;
642
+ area: string;
643
643
  streamId?: string | undefined;
644
644
  }, {
645
645
  type: "device";
646
- area: string;
647
646
  deviceId: string;
647
+ area: string;
648
648
  streamId?: string | undefined;
649
649
  }>, z.ZodObject<{
650
650
  area: z.ZodString;
@@ -695,24 +695,24 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
695
695
  }>;
696
696
  }, "strip", z.ZodTypeAny, {
697
697
  type: "playbackTrack";
698
+ area: string;
699
+ controllerId: string;
698
700
  source: {
699
701
  deviceId: string;
700
702
  streamId: string;
701
703
  };
702
- area: string;
703
- controllerId: string;
704
704
  }, {
705
705
  type: "playbackTrack";
706
+ area: string;
707
+ controllerId: string;
706
708
  source: {
707
709
  deviceId: string;
708
710
  streamId: string;
709
711
  };
710
- area: string;
711
- controllerId: string;
712
712
  }>]>, "many">;
713
713
  }, "strip", z.ZodTypeAny, {
714
- columns: number;
715
714
  rows: number;
715
+ columns: number;
716
716
  areas: string[][];
717
717
  contents: ({
718
718
  type: "layout";
@@ -723,8 +723,8 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
723
723
  area: string;
724
724
  } | {
725
725
  type: "device";
726
- area: string;
727
726
  deviceId: string;
727
+ area: string;
728
728
  streamId?: string | undefined;
729
729
  } | {
730
730
  type: "deviceCarousel";
@@ -737,17 +737,17 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
737
737
  }[] | undefined;
738
738
  } | {
739
739
  type: "playbackTrack";
740
+ area: string;
741
+ controllerId: string;
740
742
  source: {
741
743
  deviceId: string;
742
744
  streamId: string;
743
745
  };
744
- area: string;
745
- controllerId: string;
746
746
  })[];
747
747
  hotspotArea?: string | undefined;
748
748
  }, {
749
- columns: number;
750
749
  rows: number;
750
+ columns: number;
751
751
  areas: string[][];
752
752
  contents: ({
753
753
  type: "layout";
@@ -758,8 +758,8 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
758
758
  area: string;
759
759
  } | {
760
760
  type: "device";
761
- area: string;
762
761
  deviceId: string;
762
+ area: string;
763
763
  streamId?: string | undefined;
764
764
  } | {
765
765
  type: "deviceCarousel";
@@ -772,12 +772,12 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
772
772
  }[] | undefined;
773
773
  } | {
774
774
  type: "playbackTrack";
775
+ area: string;
776
+ controllerId: string;
775
777
  source: {
776
778
  deviceId: string;
777
779
  streamId: string;
778
780
  };
779
- area: string;
780
- controllerId: string;
781
781
  })[];
782
782
  hotspotArea?: string | undefined;
783
783
  }>>;
package/dist/objects/zone.d.ts CHANGED
@@ -20,20 +20,20 @@ export declare const sZoneDto: z.ZodObject<{
20
20
  version: z.ZodNumber;
21
21
  }, "strip", z.ZodTypeAny, {
22
22
  id: string;
23
- version: number;
24
23
  displayName: string;
25
24
  createdOn: string;
26
25
  lastModifiedOn: string;
27
26
  refs: Record<string, string | string[]>;
27
+ version: number;
28
28
  devices: string[];
29
29
  isGlobal: boolean;
30
30
  }, {
31
31
  id: string;
32
- version: number;
33
32
  displayName: string;
34
33
  createdOn: string;
35
34
  lastModifiedOn: string;
36
35
  refs: Record<string, string | string[]>;
36
+ version: number;
37
37
  devices: string[];
38
38
  isGlobal: boolean;
39
39
  }>;
package/dist/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "type": "git",
5
5
  "url": "git+https://github.com/Linc-Security-Systems/aware-essentials.git"
6
6
  },
7
- "version": "2.0.53",
7
+ "version": "2.0.54",
8
8
  "description": "Common types between backend, agent(s) and frontend(s)",
9
9
  "main": "dist/index.js",
10
10
  "types": "dist/index.d.ts",