@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/primitives.d.ts CHANGED
@@ -25,11 +25,11 @@ export declare const sFileResponse: z.ZodNullable<z.ZodObject<{
25
25
  mimeType: z.ZodString;
26
26
  data: z.ZodString;
27
27
  }, "strip", z.ZodTypeAny, {
28
- data: string;
29
28
  mimeType: string;
30
- }, {
31
29
  data: string;
30
+ }, {
32
31
  mimeType: string;
32
+ data: string;
33
33
  }>>;
34
34
  export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
35
35
  name: z.ZodString;
@@ -46,16 +46,16 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
46
46
  createdOn: z.ZodString;
47
47
  lastModifiedOn: z.ZodString;
48
48
  }, "strip", z.ZodTypeAny, {
49
- name: string;
50
49
  id: string;
50
+ name: string;
51
51
  createdOn: string;
52
52
  lastModifiedOn: string;
53
53
  isDefault: boolean;
54
54
  assignedRef: string | null;
55
55
  params?: unknown;
56
56
  }, {
57
- name: string;
58
57
  id: string;
58
+ name: string;
59
59
  createdOn: string;
60
60
  lastModifiedOn: string;
61
61
  isDefault: boolean;
@@ -66,8 +66,8 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
66
66
  name: string;
67
67
  foreignRef: string;
68
68
  presets: {
69
- name: string;
70
69
  id: string;
70
+ name: string;
71
71
  createdOn: string;
72
72
  lastModifiedOn: string;
73
73
  isDefault: boolean;
@@ -82,8 +82,8 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
82
82
  name: string;
83
83
  foreignRef: string;
84
84
  presets: {
85
- name: string;
86
85
  id: string;
86
+ name: string;
87
87
  createdOn: string;
88
88
  lastModifiedOn: string;
89
89
  isDefault: boolean;
@@ -130,12 +130,12 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
130
130
  }>, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
131
131
  }, "strip", z.ZodTypeAny, {
132
132
  id: string;
133
- height: number | null;
134
- width: number | null;
135
133
  displayName: string;
136
134
  externalPlayerUrl: string | null;
137
135
  rtspUrl: string | null;
138
136
  recordingCapable: boolean;
137
+ width: number | null;
138
+ height: number | null;
139
139
  lensType: "flat" | "fisheye";
140
140
  mountPoint: "wall" | "ceiling" | "floor";
141
141
  webrtcPlaybackSource: ({
@@ -143,12 +143,12 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
143
143
  } & Record<string, unknown>) | null;
144
144
  }, {
145
145
  id: string;
146
- height: number | null;
147
- width: number | null;
148
146
  displayName: string;
149
147
  externalPlayerUrl: string | null;
150
148
  rtspUrl: string | null;
151
149
  recordingCapable: boolean;
150
+ width: number | null;
151
+ height: number | null;
152
152
  lensType: "flat" | "fisheye";
153
153
  mountPoint: "wall" | "ceiling" | "floor";
154
154
  webrtcPlaybackSource: ({
@@ -161,20 +161,34 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
161
161
  type: z.ZodLiteral<"camera">;
162
162
  }, "strip", z.ZodTypeAny, {
163
163
  type: "camera";
164
+ ptzCapable: boolean;
165
+ ptzPanSpeed: number;
166
+ ptzTiltSpeed: number;
167
+ ptzZoomSpeed: number;
168
+ panMin: number;
169
+ panMax: number;
170
+ tiltMin: number;
171
+ tiltMax: number;
172
+ zoomMin: number;
173
+ zoomMax: number;
164
174
  streams: {
165
175
  id: string;
166
- height: number | null;
167
- width: number | null;
168
176
  displayName: string;
169
177
  externalPlayerUrl: string | null;
170
178
  rtspUrl: string | null;
171
179
  recordingCapable: boolean;
180
+ width: number | null;
181
+ height: number | null;
172
182
  lensType: "flat" | "fisheye";
173
183
  mountPoint: "wall" | "ceiling" | "floor";
174
184
  webrtcPlaybackSource: ({
175
185
  kind: string;
176
186
  } & Record<string, unknown>) | null;
177
187
  }[];
188
+ defaultStreamId: string;
189
+ streamNaming: "cameraStreamNo" | "cameraStream" | "stream";
190
+ }, {
191
+ type: "camera";
178
192
  ptzCapable: boolean;
179
193
  ptzPanSpeed: number;
180
194
  ptzTiltSpeed: number;
@@ -185,36 +199,22 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
185
199
  tiltMax: number;
186
200
  zoomMin: number;
187
201
  zoomMax: number;
188
- defaultStreamId: string;
189
- streamNaming: "stream" | "cameraStreamNo" | "cameraStream";
190
- }, {
191
- type: "camera";
192
202
  streams: {
193
203
  id: string;
194
- height: number | null;
195
- width: number | null;
196
204
  displayName: string;
197
205
  externalPlayerUrl: string | null;
198
206
  rtspUrl: string | null;
199
207
  recordingCapable: boolean;
208
+ width: number | null;
209
+ height: number | null;
200
210
  lensType: "flat" | "fisheye";
201
211
  mountPoint: "wall" | "ceiling" | "floor";
202
212
  webrtcPlaybackSource: ({
203
213
  kind: string;
204
214
  } & Record<string, unknown>) | null;
205
215
  }[];
206
- ptzCapable: boolean;
207
- ptzPanSpeed: number;
208
- ptzTiltSpeed: number;
209
- ptzZoomSpeed: number;
210
- panMin: number;
211
- panMax: number;
212
- tiltMin: number;
213
- tiltMax: number;
214
- zoomMin: number;
215
- zoomMax: number;
216
216
  defaultStreamId: string;
217
- streamNaming: "stream" | "cameraStreamNo" | "cameraStream";
217
+ streamNaming: "cameraStreamNo" | "cameraStream" | "stream";
218
218
  }>, z.ZodObject<{
219
219
  canReportOpenState: z.ZodBoolean;
220
220
  canReportLockState: z.ZodBoolean;
@@ -229,14 +229,14 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
229
229
  canReportLockState: boolean;
230
230
  canControlLock: boolean;
231
231
  canRelease: boolean;
232
- style?: "window" | "single" | "double" | "sliding" | "hatch" | "roller" | undefined;
232
+ style?: "single" | "double" | "sliding" | "hatch" | "roller" | "window" | undefined;
233
233
  }, {
234
234
  type: "door";
235
235
  canReportOpenState: boolean;
236
236
  canReportLockState: boolean;
237
237
  canControlLock: boolean;
238
238
  canRelease: boolean;
239
- style?: "window" | "single" | "double" | "sliding" | "hatch" | "roller" | undefined;
239
+ style?: "single" | "double" | "sliding" | "hatch" | "roller" | "window" | undefined;
240
240
  }>, z.ZodObject<{
241
241
  inputs: z.ZodArray<z.ZodString, "many">;
242
242
  outputs: z.ZodArray<z.ZodString, "many">;
@@ -378,16 +378,16 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
378
378
  createdOn: z.ZodString;
379
379
  lastModifiedOn: z.ZodString;
380
380
  }, "strip", z.ZodTypeAny, {
381
- name: string;
382
381
  id: string;
382
+ name: string;
383
383
  createdOn: string;
384
384
  lastModifiedOn: string;
385
385
  isDefault: boolean;
386
386
  assignedRef: string | null;
387
387
  params?: unknown;
388
388
  }, {
389
- name: string;
390
389
  id: string;
390
+ name: string;
391
391
  createdOn: string;
392
392
  lastModifiedOn: string;
393
393
  isDefault: boolean;
@@ -398,8 +398,8 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
398
398
  name: string;
399
399
  foreignRef: string;
400
400
  presets: {
401
- name: string;
402
401
  id: string;
402
+ name: string;
403
403
  createdOn: string;
404
404
  lastModifiedOn: string;
405
405
  isDefault: boolean;
@@ -414,8 +414,8 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
414
414
  name: string;
415
415
  foreignRef: string;
416
416
  presets: {
417
- name: string;
418
417
  id: string;
418
+ name: string;
419
419
  createdOn: string;
420
420
  lastModifiedOn: string;
421
421
  isDefault: boolean;
@@ -462,12 +462,12 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
462
462
  }>, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
463
463
  }, "strip", z.ZodTypeAny, {
464
464
  id: string;
465
- height: number | null;
466
- width: number | null;
467
465
  displayName: string;
468
466
  externalPlayerUrl: string | null;
469
467
  rtspUrl: string | null;
470
468
  recordingCapable: boolean;
469
+ width: number | null;
470
+ height: number | null;
471
471
  lensType: "flat" | "fisheye";
472
472
  mountPoint: "wall" | "ceiling" | "floor";
473
473
  webrtcPlaybackSource: ({
@@ -475,12 +475,12 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
475
475
  } & Record<string, unknown>) | null;
476
476
  }, {
477
477
  id: string;
478
- height: number | null;
479
- width: number | null;
480
478
  displayName: string;
481
479
  externalPlayerUrl: string | null;
482
480
  rtspUrl: string | null;
483
481
  recordingCapable: boolean;
482
+ width: number | null;
483
+ height: number | null;
484
484
  lensType: "flat" | "fisheye";
485
485
  mountPoint: "wall" | "ceiling" | "floor";
486
486
  webrtcPlaybackSource: ({
@@ -493,20 +493,34 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
493
493
  type: z.ZodLiteral<"camera">;
494
494
  }, "strip", z.ZodTypeAny, {
495
495
  type: "camera";
496
+ ptzCapable: boolean;
497
+ ptzPanSpeed: number;
498
+ ptzTiltSpeed: number;
499
+ ptzZoomSpeed: number;
500
+ panMin: number;
501
+ panMax: number;
502
+ tiltMin: number;
503
+ tiltMax: number;
504
+ zoomMin: number;
505
+ zoomMax: number;
496
506
  streams: {
497
507
  id: string;
498
- height: number | null;
499
- width: number | null;
500
508
  displayName: string;
501
509
  externalPlayerUrl: string | null;
502
510
  rtspUrl: string | null;
503
511
  recordingCapable: boolean;
512
+ width: number | null;
513
+ height: number | null;
504
514
  lensType: "flat" | "fisheye";
505
515
  mountPoint: "wall" | "ceiling" | "floor";
506
516
  webrtcPlaybackSource: ({
507
517
  kind: string;
508
518
  } & Record<string, unknown>) | null;
509
519
  }[];
520
+ defaultStreamId: string;
521
+ streamNaming: "cameraStreamNo" | "cameraStream" | "stream";
522
+ }, {
523
+ type: "camera";
510
524
  ptzCapable: boolean;
511
525
  ptzPanSpeed: number;
512
526
  ptzTiltSpeed: number;
@@ -517,36 +531,22 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
517
531
  tiltMax: number;
518
532
  zoomMin: number;
519
533
  zoomMax: number;
520
- defaultStreamId: string;
521
- streamNaming: "stream" | "cameraStreamNo" | "cameraStream";
522
- }, {
523
- type: "camera";
524
534
  streams: {
525
535
  id: string;
526
- height: number | null;
527
- width: number | null;
528
536
  displayName: string;
529
537
  externalPlayerUrl: string | null;
530
538
  rtspUrl: string | null;
531
539
  recordingCapable: boolean;
540
+ width: number | null;
541
+ height: number | null;
532
542
  lensType: "flat" | "fisheye";
533
543
  mountPoint: "wall" | "ceiling" | "floor";
534
544
  webrtcPlaybackSource: ({
535
545
  kind: string;
536
546
  } & Record<string, unknown>) | null;
537
547
  }[];
538
- ptzCapable: boolean;
539
- ptzPanSpeed: number;
540
- ptzTiltSpeed: number;
541
- ptzZoomSpeed: number;
542
- panMin: number;
543
- panMax: number;
544
- tiltMin: number;
545
- tiltMax: number;
546
- zoomMin: number;
547
- zoomMax: number;
548
548
  defaultStreamId: string;
549
- streamNaming: "stream" | "cameraStreamNo" | "cameraStream";
549
+ streamNaming: "cameraStreamNo" | "cameraStream" | "stream";
550
550
  }>, z.ZodObject<{
551
551
  canReportOpenState: z.ZodBoolean;
552
552
  canReportLockState: z.ZodBoolean;
@@ -561,14 +561,14 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
561
561
  canReportLockState: boolean;
562
562
  canControlLock: boolean;
563
563
  canRelease: boolean;
564
- style?: "window" | "single" | "double" | "sliding" | "hatch" | "roller" | undefined;
564
+ style?: "single" | "double" | "sliding" | "hatch" | "roller" | "window" | undefined;
565
565
  }, {
566
566
  type: "door";
567
567
  canReportOpenState: boolean;
568
568
  canReportLockState: boolean;
569
569
  canControlLock: boolean;
570
570
  canRelease: boolean;
571
- style?: "window" | "single" | "double" | "sliding" | "hatch" | "roller" | undefined;
571
+ style?: "single" | "double" | "sliding" | "hatch" | "roller" | "window" | undefined;
572
572
  }>, z.ZodObject<{
573
573
  inputs: z.ZodArray<z.ZodString, "many">;
574
574
  outputs: z.ZodArray<z.ZodString, "many">;
package/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",