@awarevue/api-types 2.0.43 → 2.0.45

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 (21) hide show
  1. package/dist/api/agent-protocol/protocol.d.ts +56 -28
  2. package/dist/api/commands/all.d.ts +36 -18
  3. package/dist/api/commands/nvr-exporter.d.ts +36 -18
  4. package/dist/api/commands/server.d.ts +36 -18
  5. package/dist/api/queries/all.d.ts +169 -24
  6. package/dist/api/queries/nvr-analytics-server.d.ts +297 -6
  7. package/dist/api/queries/nvr-analytics-server.js +82 -1
  8. package/dist/api/queries/nvr-recorder.d.ts +84 -42
  9. package/dist/api/rest/media.d.ts +12 -4
  10. package/dist/api/rest/media.js +2 -0
  11. package/dist/api/rest/user.d.ts +9 -9
  12. package/dist/objects/device/any-device.d.ts +30 -15
  13. package/dist/objects/device/camera.d.ts +16 -8
  14. package/dist/objects/device/camera.js +2 -1
  15. package/dist/objects/device/device-import.d.ts +52 -26
  16. package/dist/objects/role.d.ts +3 -3
  17. package/dist/package.json +1 -1
  18. package/dist/permissions.d.ts +3 -3
  19. package/dist/permissions.js +1 -0
  20. package/dist/primitives.d.ts +20 -10
  21. package/package.json +1 -1
package/dist/objects/device/device-import.d.ts CHANGED
@@ -47,7 +47,8 @@ export declare const sImportedDevice: z.ZodIntersection<z.ZodIntersection<z.ZodO
47
47
  id: z.ZodString;
48
48
  displayName: z.ZodString;
49
49
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
50
- rtspUrl: z.ZodString;
50
+ rtspUrl: z.ZodNullable<z.ZodString>;
51
+ mountedStreamId: z.ZodNullable<z.ZodString>;
51
52
  recordingCapable: z.ZodBoolean;
52
53
  lensType: z.ZodEnum<["flat", "fisheye"]>;
53
54
  mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
@@ -62,7 +63,8 @@ export declare const sImportedDevice: z.ZodIntersection<z.ZodIntersection<z.ZodO
62
63
  id: string;
63
64
  displayName: string;
64
65
  externalPlayerUrl: string | null;
65
- rtspUrl: string;
66
+ rtspUrl: string | null;
67
+ mountedStreamId: string | null;
66
68
  recordingCapable: boolean;
67
69
  lensType: "flat" | "fisheye";
68
70
  mountPoint: "wall" | "ceiling" | "floor";
@@ -73,7 +75,8 @@ export declare const sImportedDevice: z.ZodIntersection<z.ZodIntersection<z.ZodO
73
75
  id: string;
74
76
  displayName: string;
75
77
  externalPlayerUrl: string | null;
76
- rtspUrl: string;
78
+ rtspUrl: string | null;
79
+ mountedStreamId: string | null;
77
80
  recordingCapable: boolean;
78
81
  lensType: "flat" | "fisheye";
79
82
  mountPoint: "wall" | "ceiling" | "floor";
@@ -91,7 +94,8 @@ export declare const sImportedDevice: z.ZodIntersection<z.ZodIntersection<z.ZodO
91
94
  id: string;
92
95
  displayName: string;
93
96
  externalPlayerUrl: string | null;
94
- rtspUrl: string;
97
+ rtspUrl: string | null;
98
+ mountedStreamId: string | null;
95
99
  recordingCapable: boolean;
96
100
  lensType: "flat" | "fisheye";
97
101
  mountPoint: "wall" | "ceiling" | "floor";
@@ -117,7 +121,8 @@ export declare const sImportedDevice: z.ZodIntersection<z.ZodIntersection<z.ZodO
117
121
  id: string;
118
122
  displayName: string;
119
123
  externalPlayerUrl: string | null;
120
- rtspUrl: string;
124
+ rtspUrl: string | null;
125
+ mountedStreamId: string | null;
121
126
  recordingCapable: boolean;
122
127
  lensType: "flat" | "fisheye";
123
128
  mountPoint: "wall" | "ceiling" | "floor";
@@ -340,7 +345,8 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
340
345
  id: z.ZodString;
341
346
  displayName: z.ZodString;
342
347
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
343
- rtspUrl: z.ZodString;
348
+ rtspUrl: z.ZodNullable<z.ZodString>;
349
+ mountedStreamId: z.ZodNullable<z.ZodString>;
344
350
  recordingCapable: z.ZodBoolean;
345
351
  lensType: z.ZodEnum<["flat", "fisheye"]>;
346
352
  mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
@@ -355,7 +361,8 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
355
361
  id: string;
356
362
  displayName: string;
357
363
  externalPlayerUrl: string | null;
358
- rtspUrl: string;
364
+ rtspUrl: string | null;
365
+ mountedStreamId: string | null;
359
366
  recordingCapable: boolean;
360
367
  lensType: "flat" | "fisheye";
361
368
  mountPoint: "wall" | "ceiling" | "floor";
@@ -366,7 +373,8 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
366
373
  id: string;
367
374
  displayName: string;
368
375
  externalPlayerUrl: string | null;
369
- rtspUrl: string;
376
+ rtspUrl: string | null;
377
+ mountedStreamId: string | null;
370
378
  recordingCapable: boolean;
371
379
  lensType: "flat" | "fisheye";
372
380
  mountPoint: "wall" | "ceiling" | "floor";
@@ -384,7 +392,8 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
384
392
  id: string;
385
393
  displayName: string;
386
394
  externalPlayerUrl: string | null;
387
- rtspUrl: string;
395
+ rtspUrl: string | null;
396
+ mountedStreamId: string | null;
388
397
  recordingCapable: boolean;
389
398
  lensType: "flat" | "fisheye";
390
399
  mountPoint: "wall" | "ceiling" | "floor";
@@ -410,7 +419,8 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
410
419
  id: string;
411
420
  displayName: string;
412
421
  externalPlayerUrl: string | null;
413
- rtspUrl: string;
422
+ rtspUrl: string | null;
423
+ mountedStreamId: string | null;
414
424
  recordingCapable: boolean;
415
425
  lensType: "flat" | "fisheye";
416
426
  mountPoint: "wall" | "ceiling" | "floor";
@@ -613,7 +623,8 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
613
623
  id: string;
614
624
  displayName: string;
615
625
  externalPlayerUrl: string | null;
616
- rtspUrl: string;
626
+ rtspUrl: string | null;
627
+ mountedStreamId: string | null;
617
628
  recordingCapable: boolean;
618
629
  lensType: "flat" | "fisheye";
619
630
  mountPoint: "wall" | "ceiling" | "floor";
@@ -708,7 +719,8 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
708
719
  id: string;
709
720
  displayName: string;
710
721
  externalPlayerUrl: string | null;
711
- rtspUrl: string;
722
+ rtspUrl: string | null;
723
+ mountedStreamId: string | null;
712
724
  recordingCapable: boolean;
713
725
  lensType: "flat" | "fisheye";
714
726
  mountPoint: "wall" | "ceiling" | "floor";
@@ -833,7 +845,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
833
845
  id: z.ZodString;
834
846
  displayName: z.ZodString;
835
847
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
836
- rtspUrl: z.ZodString;
848
+ rtspUrl: z.ZodNullable<z.ZodString>;
849
+ mountedStreamId: z.ZodNullable<z.ZodString>;
837
850
  recordingCapable: z.ZodBoolean;
838
851
  lensType: z.ZodEnum<["flat", "fisheye"]>;
839
852
  mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
@@ -848,7 +861,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
848
861
  id: string;
849
862
  displayName: string;
850
863
  externalPlayerUrl: string | null;
851
- rtspUrl: string;
864
+ rtspUrl: string | null;
865
+ mountedStreamId: string | null;
852
866
  recordingCapable: boolean;
853
867
  lensType: "flat" | "fisheye";
854
868
  mountPoint: "wall" | "ceiling" | "floor";
@@ -859,7 +873,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
859
873
  id: string;
860
874
  displayName: string;
861
875
  externalPlayerUrl: string | null;
862
- rtspUrl: string;
876
+ rtspUrl: string | null;
877
+ mountedStreamId: string | null;
863
878
  recordingCapable: boolean;
864
879
  lensType: "flat" | "fisheye";
865
880
  mountPoint: "wall" | "ceiling" | "floor";
@@ -877,7 +892,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
877
892
  id: string;
878
893
  displayName: string;
879
894
  externalPlayerUrl: string | null;
880
- rtspUrl: string;
895
+ rtspUrl: string | null;
896
+ mountedStreamId: string | null;
881
897
  recordingCapable: boolean;
882
898
  lensType: "flat" | "fisheye";
883
899
  mountPoint: "wall" | "ceiling" | "floor";
@@ -903,7 +919,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
903
919
  id: string;
904
920
  displayName: string;
905
921
  externalPlayerUrl: string | null;
906
- rtspUrl: string;
922
+ rtspUrl: string | null;
923
+ mountedStreamId: string | null;
907
924
  recordingCapable: boolean;
908
925
  lensType: "flat" | "fisheye";
909
926
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1103,7 +1120,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1103
1120
  id: z.ZodString;
1104
1121
  displayName: z.ZodString;
1105
1122
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
1106
- rtspUrl: z.ZodString;
1123
+ rtspUrl: z.ZodNullable<z.ZodString>;
1124
+ mountedStreamId: z.ZodNullable<z.ZodString>;
1107
1125
  recordingCapable: z.ZodBoolean;
1108
1126
  lensType: z.ZodEnum<["flat", "fisheye"]>;
1109
1127
  mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
@@ -1118,7 +1136,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1118
1136
  id: string;
1119
1137
  displayName: string;
1120
1138
  externalPlayerUrl: string | null;
1121
- rtspUrl: string;
1139
+ rtspUrl: string | null;
1140
+ mountedStreamId: string | null;
1122
1141
  recordingCapable: boolean;
1123
1142
  lensType: "flat" | "fisheye";
1124
1143
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1129,7 +1148,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1129
1148
  id: string;
1130
1149
  displayName: string;
1131
1150
  externalPlayerUrl: string | null;
1132
- rtspUrl: string;
1151
+ rtspUrl: string | null;
1152
+ mountedStreamId: string | null;
1133
1153
  recordingCapable: boolean;
1134
1154
  lensType: "flat" | "fisheye";
1135
1155
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1147,7 +1167,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1147
1167
  id: string;
1148
1168
  displayName: string;
1149
1169
  externalPlayerUrl: string | null;
1150
- rtspUrl: string;
1170
+ rtspUrl: string | null;
1171
+ mountedStreamId: string | null;
1151
1172
  recordingCapable: boolean;
1152
1173
  lensType: "flat" | "fisheye";
1153
1174
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1173,7 +1194,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1173
1194
  id: string;
1174
1195
  displayName: string;
1175
1196
  externalPlayerUrl: string | null;
1176
- rtspUrl: string;
1197
+ rtspUrl: string | null;
1198
+ mountedStreamId: string | null;
1177
1199
  recordingCapable: boolean;
1178
1200
  lensType: "flat" | "fisheye";
1179
1201
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1478,7 +1500,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1478
1500
  id: string;
1479
1501
  displayName: string;
1480
1502
  externalPlayerUrl: string | null;
1481
- rtspUrl: string;
1503
+ rtspUrl: string | null;
1504
+ mountedStreamId: string | null;
1482
1505
  recordingCapable: boolean;
1483
1506
  lensType: "flat" | "fisheye";
1484
1507
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1597,7 +1620,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1597
1620
  id: string;
1598
1621
  displayName: string;
1599
1622
  externalPlayerUrl: string | null;
1600
- rtspUrl: string;
1623
+ rtspUrl: string | null;
1624
+ mountedStreamId: string | null;
1601
1625
  recordingCapable: boolean;
1602
1626
  lensType: "flat" | "fisheye";
1603
1627
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1683,7 +1707,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1683
1707
  id: string;
1684
1708
  displayName: string;
1685
1709
  externalPlayerUrl: string | null;
1686
- rtspUrl: string;
1710
+ rtspUrl: string | null;
1711
+ mountedStreamId: string | null;
1687
1712
  recordingCapable: boolean;
1688
1713
  lensType: "flat" | "fisheye";
1689
1714
  mountPoint: "wall" | "ceiling" | "floor";
@@ -1802,7 +1827,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
1802
1827
  id: string;
1803
1828
  displayName: string;
1804
1829
  externalPlayerUrl: string | null;
1805
- rtspUrl: string;
1830
+ rtspUrl: string | null;
1831
+ mountedStreamId: string | null;
1806
1832
  recordingCapable: boolean;
1807
1833
  lensType: "flat" | "fisheye";
1808
1834
  mountPoint: "wall" | "ceiling" | "floor";
package/dist/objects/role.d.ts CHANGED
@@ -4,18 +4,18 @@ export declare const sRoleDto: z.ZodObject<{
4
4
  displayName: z.ZodString;
5
5
  systemName: z.ZodEffects<z.ZodString, string, string>;
6
6
  description: z.ZodString;
7
- permissions: z.ZodArray<z.ZodUnion<[z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"camera:detection">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"zone:update">, z.ZodLiteral<"zone:delete">, z.ZodLiteral<"zone:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"alarm:bypass">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"device:notes">, z.ZodLiteral<"device:rename">, z.ZodLiteral<"device:alarms">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"notification:read">, z.ZodLiteral<"notification:create">, z.ZodLiteral<"notification:acknowledge">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"display:read">, z.ZodLiteral<"security-level:update">, z.ZodLiteral<"security-level:delete">, z.ZodLiteral<"security-level:create">, z.ZodLiteral<"citadel-mode:toggle">, z.ZodLiteral<"token-conversion:update">, z.ZodLiteral<"token-conversion:delete">, z.ZodLiteral<"token-conversion:create">, z.ZodLiteral<"bookmark:read">, z.ZodLiteral<"bookmark:create">, z.ZodLiteral<"bookmark:update">, z.ZodLiteral<"bookmark:delete">, z.ZodLiteral<"access-path:read">, z.ZodLiteral<"access-path:create">, z.ZodLiteral<"access-path:update">, z.ZodLiteral<"access-path:delete">, z.ZodLiteral<"person-type:create">, z.ZodLiteral<"person-type:update">, z.ZodLiteral<"person-type:delete">, z.ZodLiteral<"agreement:create">, z.ZodLiteral<"agreement:update">, z.ZodLiteral<"agreement:delete">, z.ZodLiteral<"api-key:create">, z.ZodLiteral<"api-key:revoke">, z.ZodLiteral<"access-authority:read">, z.ZodLiteral<"access-authority:sync">, z.ZodLiteral<"access-authority:delete">]>, "many">;
7
+ permissions: z.ZodArray<z.ZodUnion<[z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"camera:detection">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"person:face">, z.ZodLiteral<"zone:update">, z.ZodLiteral<"zone:delete">, z.ZodLiteral<"zone:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"alarm:bypass">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"device:notes">, z.ZodLiteral<"device:rename">, z.ZodLiteral<"device:alarms">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"notification:read">, z.ZodLiteral<"notification:create">, z.ZodLiteral<"notification:acknowledge">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"display:read">, z.ZodLiteral<"security-level:update">, z.ZodLiteral<"security-level:delete">, z.ZodLiteral<"security-level:create">, z.ZodLiteral<"citadel-mode:toggle">, z.ZodLiteral<"token-conversion:update">, z.ZodLiteral<"token-conversion:delete">, z.ZodLiteral<"token-conversion:create">, z.ZodLiteral<"bookmark:read">, z.ZodLiteral<"bookmark:create">, z.ZodLiteral<"bookmark:update">, z.ZodLiteral<"bookmark:delete">, z.ZodLiteral<"access-path:read">, z.ZodLiteral<"access-path:create">, z.ZodLiteral<"access-path:update">, z.ZodLiteral<"access-path:delete">, z.ZodLiteral<"person-type:create">, z.ZodLiteral<"person-type:update">, z.ZodLiteral<"person-type:delete">, z.ZodLiteral<"agreement:create">, z.ZodLiteral<"agreement:update">, z.ZodLiteral<"agreement:delete">, z.ZodLiteral<"api-key:create">, z.ZodLiteral<"api-key:revoke">, z.ZodLiteral<"access-authority:read">, z.ZodLiteral<"access-authority:sync">, z.ZodLiteral<"access-authority:delete">]>, "many">;
8
8
  }, "strip", z.ZodTypeAny, {
9
9
  id: string;
10
10
  description: string;
11
11
  displayName: string;
12
- permissions: ("layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "zone:update" | "zone:delete" | "zone:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:rename" | "device:alarms" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "notification:read" | "notification:create" | "notification:acknowledge" | "template:update" | "template:delete" | "template:create" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "display:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke" | "access-authority:read" | "access-authority:sync" | "access-authority:delete")[];
12
+ permissions: ("layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "person:face" | "zone:update" | "zone:delete" | "zone:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:rename" | "device:alarms" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "notification:read" | "notification:create" | "notification:acknowledge" | "template:update" | "template:delete" | "template:create" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "display:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke" | "access-authority:read" | "access-authority:sync" | "access-authority:delete")[];
13
13
  systemName: string;
14
14
  }, {
15
15
  id: string;
16
16
  description: string;
17
17
  displayName: string;
18
- permissions: ("layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "zone:update" | "zone:delete" | "zone:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:rename" | "device:alarms" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "notification:read" | "notification:create" | "notification:acknowledge" | "template:update" | "template:delete" | "template:create" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "display:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke" | "access-authority:read" | "access-authority:sync" | "access-authority:delete")[];
18
+ permissions: ("layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "person:face" | "zone:update" | "zone:delete" | "zone:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:rename" | "device:alarms" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "notification:read" | "notification:create" | "notification:acknowledge" | "template:update" | "template:delete" | "template:create" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "display:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke" | "access-authority:read" | "access-authority:sync" | "access-authority:delete")[];
19
19
  systemName: string;
20
20
  }>;
21
21
  export type RoleDto = z.infer<typeof sRoleDto>;
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awarevue/api-types",
3
- "version": "2.0.43",
3
+ "version": "2.0.45",
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/permissions.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { z } from 'zod';
2
- export declare const sPermissionId: z.ZodUnion<[z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"camera:detection">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"zone:update">, z.ZodLiteral<"zone:delete">, z.ZodLiteral<"zone:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"alarm:bypass">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"device:notes">, z.ZodLiteral<"device:rename">, z.ZodLiteral<"device:alarms">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"notification:read">, z.ZodLiteral<"notification:create">, z.ZodLiteral<"notification:acknowledge">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"display:read">, z.ZodLiteral<"security-level:update">, z.ZodLiteral<"security-level:delete">, z.ZodLiteral<"security-level:create">, z.ZodLiteral<"citadel-mode:toggle">, z.ZodLiteral<"token-conversion:update">, z.ZodLiteral<"token-conversion:delete">, z.ZodLiteral<"token-conversion:create">, z.ZodLiteral<"bookmark:read">, z.ZodLiteral<"bookmark:create">, z.ZodLiteral<"bookmark:update">, z.ZodLiteral<"bookmark:delete">, z.ZodLiteral<"access-path:read">, z.ZodLiteral<"access-path:create">, z.ZodLiteral<"access-path:update">, z.ZodLiteral<"access-path:delete">, z.ZodLiteral<"person-type:create">, z.ZodLiteral<"person-type:update">, z.ZodLiteral<"person-type:delete">, z.ZodLiteral<"agreement:create">, z.ZodLiteral<"agreement:update">, z.ZodLiteral<"agreement:delete">, z.ZodLiteral<"api-key:create">, z.ZodLiteral<"api-key:revoke">, z.ZodLiteral<"access-authority:read">, z.ZodLiteral<"access-authority:sync">, z.ZodLiteral<"access-authority:delete">]>;
2
+ export declare const sPermissionId: z.ZodUnion<[z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"camera:detection">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"person:face">, z.ZodLiteral<"zone:update">, z.ZodLiteral<"zone:delete">, z.ZodLiteral<"zone:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"alarm:bypass">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"device:notes">, z.ZodLiteral<"device:rename">, z.ZodLiteral<"device:alarms">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"notification:read">, z.ZodLiteral<"notification:create">, z.ZodLiteral<"notification:acknowledge">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"display:read">, z.ZodLiteral<"security-level:update">, z.ZodLiteral<"security-level:delete">, z.ZodLiteral<"security-level:create">, z.ZodLiteral<"citadel-mode:toggle">, z.ZodLiteral<"token-conversion:update">, z.ZodLiteral<"token-conversion:delete">, z.ZodLiteral<"token-conversion:create">, z.ZodLiteral<"bookmark:read">, z.ZodLiteral<"bookmark:create">, z.ZodLiteral<"bookmark:update">, z.ZodLiteral<"bookmark:delete">, z.ZodLiteral<"access-path:read">, z.ZodLiteral<"access-path:create">, z.ZodLiteral<"access-path:update">, z.ZodLiteral<"access-path:delete">, z.ZodLiteral<"person-type:create">, z.ZodLiteral<"person-type:update">, z.ZodLiteral<"person-type:delete">, z.ZodLiteral<"agreement:create">, z.ZodLiteral<"agreement:update">, z.ZodLiteral<"agreement:delete">, z.ZodLiteral<"api-key:create">, z.ZodLiteral<"api-key:revoke">, z.ZodLiteral<"access-authority:read">, z.ZodLiteral<"access-authority:sync">, z.ZodLiteral<"access-authority:delete">]>;
3
3
  export type PermissionArea = 'layout' | 'camera' | 'preset' | 'door' | 'public-view' | 'private-view' | 'person' | 'zone' | 'access-rule' | 'schedule' | 'presence' | 'factory' | 'event' | 'alarm' | 'user' | 'role' | 'device' | 'module' | 'automation' | 'device-group' | 'macro' | 'template' | 'custom-field' | 'device' | 'display' | 'security-level' | 'citadel-mode' | 'token-conversion' | 'bookmark' | 'access-path' | 'person-type' | 'agreement' | 'api-key' | 'access-authority' | 'notification';
4
- export declare const permissions: Record<"layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "zone:update" | "zone:delete" | "zone:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:rename" | "device:alarms" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "notification:read" | "notification:create" | "notification:acknowledge" | "template:update" | "template:delete" | "template:create" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "display:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke" | "access-authority:read" | "access-authority:sync" | "access-authority:delete", string>;
5
- export declare const permissionsArray: ("layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "zone:update" | "zone:delete" | "zone:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:rename" | "device:alarms" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "notification:read" | "notification:create" | "notification:acknowledge" | "template:update" | "template:delete" | "template:create" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "display:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke" | "access-authority:read" | "access-authority:sync" | "access-authority:delete")[];
4
+ export declare const permissions: Record<"layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "person:face" | "zone:update" | "zone:delete" | "zone:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:rename" | "device:alarms" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "notification:read" | "notification:create" | "notification:acknowledge" | "template:update" | "template:delete" | "template:create" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "display:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke" | "access-authority:read" | "access-authority:sync" | "access-authority:delete", string>;
5
+ export declare const permissionsArray: ("layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "person:face" | "zone:update" | "zone:delete" | "zone:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:rename" | "device:alarms" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "notification:read" | "notification:create" | "notification:acknowledge" | "template:update" | "template:delete" | "template:create" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "display:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke" | "access-authority:read" | "access-authority:sync" | "access-authority:delete")[];
6
6
  export type PermissionId = z.infer<typeof sPermissionId>;
package/dist/permissions.js CHANGED
@@ -42,6 +42,7 @@ exports.sPermissionId = zod_1.z.union([
42
42
  zod_1.z.literal('person:create').describe('Create people'),
43
43
  zod_1.z.literal('person:assign').describe('Assign credentials and access rules'),
44
44
  zod_1.z.literal('person:print').describe('Print person details'),
45
+ zod_1.z.literal('person:face').describe('Manage face recognition data'),
45
46
  //Zones
46
47
  zod_1.z.literal('zone:update').describe('Update zone'),
47
48
  zod_1.z.literal('zone:delete').describe('Delete zone'),
package/dist/primitives.d.ts CHANGED
@@ -115,7 +115,8 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
115
115
  id: z.ZodString;
116
116
  displayName: z.ZodString;
117
117
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
118
- rtspUrl: z.ZodString;
118
+ rtspUrl: z.ZodNullable<z.ZodString>;
119
+ mountedStreamId: z.ZodNullable<z.ZodString>;
119
120
  recordingCapable: z.ZodBoolean;
120
121
  lensType: z.ZodEnum<["flat", "fisheye"]>;
121
122
  mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
@@ -130,7 +131,8 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
130
131
  id: string;
131
132
  displayName: string;
132
133
  externalPlayerUrl: string | null;
133
- rtspUrl: string;
134
+ rtspUrl: string | null;
135
+ mountedStreamId: string | null;
134
136
  recordingCapable: boolean;
135
137
  lensType: "flat" | "fisheye";
136
138
  mountPoint: "wall" | "ceiling" | "floor";
@@ -141,7 +143,8 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
141
143
  id: string;
142
144
  displayName: string;
143
145
  externalPlayerUrl: string | null;
144
- rtspUrl: string;
146
+ rtspUrl: string | null;
147
+ mountedStreamId: string | null;
145
148
  recordingCapable: boolean;
146
149
  lensType: "flat" | "fisheye";
147
150
  mountPoint: "wall" | "ceiling" | "floor";
@@ -159,7 +162,8 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
159
162
  id: string;
160
163
  displayName: string;
161
164
  externalPlayerUrl: string | null;
162
- rtspUrl: string;
165
+ rtspUrl: string | null;
166
+ mountedStreamId: string | null;
163
167
  recordingCapable: boolean;
164
168
  lensType: "flat" | "fisheye";
165
169
  mountPoint: "wall" | "ceiling" | "floor";
@@ -185,7 +189,8 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
185
189
  id: string;
186
190
  displayName: string;
187
191
  externalPlayerUrl: string | null;
188
- rtspUrl: string;
192
+ rtspUrl: string | null;
193
+ mountedStreamId: string | null;
189
194
  recordingCapable: boolean;
190
195
  lensType: "flat" | "fisheye";
191
196
  mountPoint: "wall" | "ceiling" | "floor";
@@ -437,7 +442,8 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
437
442
  id: z.ZodString;
438
443
  displayName: z.ZodString;
439
444
  externalPlayerUrl: z.ZodNullable<z.ZodString>;
440
- rtspUrl: z.ZodString;
445
+ rtspUrl: z.ZodNullable<z.ZodString>;
446
+ mountedStreamId: z.ZodNullable<z.ZodString>;
441
447
  recordingCapable: z.ZodBoolean;
442
448
  lensType: z.ZodEnum<["flat", "fisheye"]>;
443
449
  mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
@@ -452,7 +458,8 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
452
458
  id: string;
453
459
  displayName: string;
454
460
  externalPlayerUrl: string | null;
455
- rtspUrl: string;
461
+ rtspUrl: string | null;
462
+ mountedStreamId: string | null;
456
463
  recordingCapable: boolean;
457
464
  lensType: "flat" | "fisheye";
458
465
  mountPoint: "wall" | "ceiling" | "floor";
@@ -463,7 +470,8 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
463
470
  id: string;
464
471
  displayName: string;
465
472
  externalPlayerUrl: string | null;
466
- rtspUrl: string;
473
+ rtspUrl: string | null;
474
+ mountedStreamId: string | null;
467
475
  recordingCapable: boolean;
468
476
  lensType: "flat" | "fisheye";
469
477
  mountPoint: "wall" | "ceiling" | "floor";
@@ -481,7 +489,8 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
481
489
  id: string;
482
490
  displayName: string;
483
491
  externalPlayerUrl: string | null;
484
- rtspUrl: string;
492
+ rtspUrl: string | null;
493
+ mountedStreamId: string | null;
485
494
  recordingCapable: boolean;
486
495
  lensType: "flat" | "fisheye";
487
496
  mountPoint: "wall" | "ceiling" | "floor";
@@ -507,7 +516,8 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
507
516
  id: string;
508
517
  displayName: string;
509
518
  externalPlayerUrl: string | null;
510
- rtspUrl: string;
519
+ rtspUrl: string | null;
520
+ mountedStreamId: string | null;
511
521
  recordingCapable: boolean;
512
522
  lensType: "flat" | "fisheye";
513
523
  mountPoint: "wall" | "ceiling" | "floor";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awarevue/api-types",
3
- "version": "2.0.43",
3
+ "version": "2.0.45",
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",