@awarevue/api-types 2.0.24 → 2.0.26

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 (139) hide show
  1. package/dist/_legacy/index.js +18 -2
  2. package/dist/_legacy/milestone.js +2 -1
  3. package/dist/_legacy/orchid.js +2 -1
  4. package/dist/alarm-automation.js +37 -26
  5. package/dist/api/agent-protocol/index.js +17 -1
  6. package/dist/api/agent-protocol/protocol.js +219 -212
  7. package/dist/api/commands/alarm.js +46 -43
  8. package/dist/api/commands/all.js +25 -22
  9. package/dist/api/commands/camera-lift.js +13 -10
  10. package/dist/api/commands/camera.js +65 -61
  11. package/dist/api/commands/display.js +27 -24
  12. package/dist/api/commands/door.js +21 -18
  13. package/dist/api/commands/index.js +28 -12
  14. package/dist/api/commands/intercom-terminal.js +2 -1
  15. package/dist/api/commands/io-board.js +11 -8
  16. package/dist/api/commands/nvr-exporter.js +20 -17
  17. package/dist/api/commands/pbx.js +13 -10
  18. package/dist/api/commands/presence-tracker.js +25 -22
  19. package/dist/api/commands/server.js +21 -18
  20. package/dist/api/error.js +93 -89
  21. package/dist/api/events/alarm.js +53 -50
  22. package/dist/api/events/all.js +57 -53
  23. package/dist/api/events/camera.js +68 -65
  24. package/dist/api/events/display.js +6 -3
  25. package/dist/api/events/door.js +60 -57
  26. package/dist/api/events/index.js +28 -12
  27. package/dist/api/events/intercom-terminal.js +16 -13
  28. package/dist/api/events/io-board.js +10 -7
  29. package/dist/api/events/nvr-exporter.js +14 -11
  30. package/dist/api/events/panic-button.js +8 -5
  31. package/dist/api/events/presence-tracker.js +29 -26
  32. package/dist/api/events/reader.js +11 -8
  33. package/dist/api/events/server.js +12 -9
  34. package/dist/api/index.js +25 -9
  35. package/dist/api/mqtt/index.js +17 -1
  36. package/dist/api/mqtt/payloads.js +15 -12
  37. package/dist/api/queries/all.js +23 -20
  38. package/dist/api/queries/camera.js +19 -16
  39. package/dist/api/queries/index.js +21 -5
  40. package/dist/api/queries/nvr-analytics-server.js +57 -54
  41. package/dist/api/queries/nvr-exporter.js +26 -23
  42. package/dist/api/queries/nvr-recorder.js +32 -29
  43. package/dist/api/rest/access-rule.js +14 -8
  44. package/dist/api/rest/agreement.js +6 -3
  45. package/dist/api/rest/alarm.js +2 -1
  46. package/dist/api/rest/api-keys.js +11 -8
  47. package/dist/api/rest/app.js +11 -8
  48. package/dist/api/rest/auth.js +12 -9
  49. package/dist/api/rest/automation.js +13 -10
  50. package/dist/api/rest/aware-config.js +2 -1
  51. package/dist/api/rest/bookmarks.js +17 -14
  52. package/dist/api/rest/cast.js +11 -5
  53. package/dist/api/rest/custom-field.js +6 -3
  54. package/dist/api/rest/device-event.js +2 -1
  55. package/dist/api/rest/device-group.js +19 -13
  56. package/dist/api/rest/file.js +2 -1
  57. package/dist/api/rest/index.js +50 -34
  58. package/dist/api/rest/io-device.js +21 -14
  59. package/dist/api/rest/layout.js +23 -17
  60. package/dist/api/rest/macros.js +6 -3
  61. package/dist/api/rest/media.js +55 -52
  62. package/dist/api/rest/module-config.js +2 -1
  63. package/dist/api/rest/notifications.js +11 -8
  64. package/dist/api/rest/person-agreement.js +11 -5
  65. package/dist/api/rest/person-presence.js +26 -23
  66. package/dist/api/rest/person-type.js +6 -3
  67. package/dist/api/rest/person.js +11 -5
  68. package/dist/api/rest/query.js +13 -8
  69. package/dist/api/rest/schedule.js +11 -8
  70. package/dist/api/rest/security-level.js +6 -3
  71. package/dist/api/rest/template.js +13 -10
  72. package/dist/api/rest/token-conversion.js +6 -3
  73. package/dist/api/rest/user.js +31 -28
  74. package/dist/api/rest/view.js +20 -14
  75. package/dist/api/rest/webrtc-playback.js +12 -6
  76. package/dist/api/rest/zone.js +14 -8
  77. package/dist/api/state/index.js +2 -1
  78. package/dist/api/ws/device-communication.js +46 -38
  79. package/dist/api/ws/index.js +21 -5
  80. package/dist/api/ws/notifications.js +17 -10
  81. package/dist/api/ws/progress.js +37 -30
  82. package/dist/api/ws/web-rtc-signaling.js +72 -65
  83. package/dist/api/ws/web-socket.js +5 -2
  84. package/dist/index.js +22 -6
  85. package/dist/objects/access-rule.js +32 -29
  86. package/dist/objects/agent-metadata.js +33 -30
  87. package/dist/objects/agreement.js +10 -7
  88. package/dist/objects/all.js +7 -4
  89. package/dist/objects/api-key.js +10 -7
  90. package/dist/objects/automation-rule.js +28 -25
  91. package/dist/objects/bookmark.js +14 -11
  92. package/dist/objects/credential.js +15 -9
  93. package/dist/objects/custom-field.js +11 -8
  94. package/dist/objects/device/alarm.js +6 -3
  95. package/dist/objects/device/any-device.js +206 -203
  96. package/dist/objects/device/camera-lift.js +6 -3
  97. package/dist/objects/device/camera.js +30 -27
  98. package/dist/objects/device/device-gateway.js +4 -1
  99. package/dist/objects/device/device-import.js +26 -23
  100. package/dist/objects/device/device-relation.js +16 -13
  101. package/dist/objects/device/display.js +6 -3
  102. package/dist/objects/device/door.js +10 -7
  103. package/dist/objects/device/index.js +38 -22
  104. package/dist/objects/device/intercom-operator.js +4 -1
  105. package/dist/objects/device/intercom-terminal.js +20 -17
  106. package/dist/objects/device/io-board.js +8 -5
  107. package/dist/objects/device/motion-sensor.js +6 -3
  108. package/dist/objects/device/nvr-analytics-server.js +8 -5
  109. package/dist/objects/device/nvr-exporter.js +9 -6
  110. package/dist/objects/device/nvr-recorder.js +8 -5
  111. package/dist/objects/device/panic-button.js +6 -3
  112. package/dist/objects/device/pbx.js +7 -4
  113. package/dist/objects/device/presence-tracker.js +4 -1
  114. package/dist/objects/device/reader.js +4 -1
  115. package/dist/objects/device/server.js +4 -1
  116. package/dist/objects/device/system.js +7 -4
  117. package/dist/objects/device-group.js +11 -8
  118. package/dist/objects/index.js +44 -28
  119. package/dist/objects/layout.js +23 -20
  120. package/dist/objects/macro.js +20 -17
  121. package/dist/objects/module-config.js +2 -1
  122. package/dist/objects/notification.js +15 -12
  123. package/dist/objects/person-agreement.js +10 -7
  124. package/dist/objects/person-presence.js +32 -29
  125. package/dist/objects/person-type.js +17 -11
  126. package/dist/objects/person.js +42 -39
  127. package/dist/objects/role.js +11 -8
  128. package/dist/objects/schedule.js +45 -39
  129. package/dist/objects/security-level.js +13 -10
  130. package/dist/objects/template.js +10 -7
  131. package/dist/objects/token-conversion.js +10 -7
  132. package/dist/objects/user.js +14 -11
  133. package/dist/objects/view.js +53 -50
  134. package/dist/objects/world-object.js +8 -5
  135. package/dist/objects/zone.js +16 -13
  136. package/dist/package.json +1 -1
  137. package/dist/permissions.js +149 -146
  138. package/dist/primitives.js +30 -27
  139. package/package.json +1 -1
@@ -1,202 +1,205 @@
1
- import { z } from 'zod';
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.permissionsArray = exports.permissions = exports.sPermissionId = void 0;
4
+ const zod_1 = require("zod");
2
5
  // Some Device Types omitted for now until we work out if they are needed
3
6
  const deviceTypePermissions = {
4
- camera: z.literal('device:camera').describe('View cameras'),
5
- door: z.literal('device:door').describe('View doors'),
6
- 'motion-sensor': z
7
+ camera: zod_1.z.literal('device:camera').describe('View cameras'),
8
+ door: zod_1.z.literal('device:door').describe('View doors'),
9
+ 'motion-sensor': zod_1.z
7
10
  .literal('device:motion-sensor')
8
11
  .describe('View motion sensors'),
9
- 'panic-button': z
12
+ 'panic-button': zod_1.z
10
13
  .literal('device:panic-button')
11
14
  .describe('View panic buttons'),
12
- 'intercom-terminal': z
15
+ 'intercom-terminal': zod_1.z
13
16
  .literal('device:intercom-terminal')
14
17
  .describe('View intercom terminals'),
15
- display: z.literal('device:display').describe('View displays'),
16
- 'nvr-recorder': z
18
+ display: zod_1.z.literal('device:display').describe('View displays'),
19
+ 'nvr-recorder': zod_1.z
17
20
  .literal('device:nvr-recorder')
18
21
  .describe('View NVR recorders'),
19
- 'nvr-exporter': z
22
+ 'nvr-exporter': zod_1.z
20
23
  .literal('device:nvr-exporter')
21
24
  .describe('View NVR exporters'),
22
- 'nvr-analytics-server': z
25
+ 'nvr-analytics-server': zod_1.z
23
26
  .literal('device:nvr-analytics-server')
24
27
  .describe('View NVR analytics servers'),
25
- system: z.literal('device:system').describe('View system devices'),
28
+ system: zod_1.z.literal('device:system').describe('View system devices'),
26
29
  };
27
30
  const sDeviceTypePermissions = Object.values(deviceTypePermissions);
28
- export const sPermissionId = z.union([
31
+ exports.sPermissionId = zod_1.z.union([
29
32
  //Layout
30
- z.literal('layout:read').describe('Read layout data'),
31
- z.literal('layout:update').describe('Update layouts'),
32
- z.literal('layout:delete').describe('Delete layout'),
33
- z.literal('layout:create').describe('Create layout'),
33
+ zod_1.z.literal('layout:read').describe('Read layout data'),
34
+ zod_1.z.literal('layout:update').describe('Update layouts'),
35
+ zod_1.z.literal('layout:delete').describe('Delete layout'),
36
+ zod_1.z.literal('layout:create').describe('Create layout'),
34
37
  //Camera
35
- z.literal('camera:live').describe('View live camera feed'),
36
- z.literal('camera:playback').describe('View camera playback'),
37
- z.literal('camera:playback-export').describe('Export camera playback'),
38
- z.literal('camera:ptz').describe('Control camera PTZ'),
39
- z.literal('camera:privacy-mode').describe('Control camera privacy mode'),
40
- z.literal('camera:assign').describe('Assign adjacent cameras to devices'),
41
- z.literal('camera:detection').describe('Enable or disable camera detection'),
38
+ zod_1.z.literal('camera:live').describe('View live camera feed'),
39
+ zod_1.z.literal('camera:playback').describe('View camera playback'),
40
+ zod_1.z.literal('camera:playback-export').describe('Export camera playback'),
41
+ zod_1.z.literal('camera:ptz').describe('Control camera PTZ'),
42
+ zod_1.z.literal('camera:privacy-mode').describe('Control camera privacy mode'),
43
+ zod_1.z.literal('camera:assign').describe('Assign adjacent cameras to devices'),
44
+ zod_1.z.literal('camera:detection').describe('Enable or disable camera detection'),
42
45
  //Preset
43
- z.literal('preset:read').describe('Use camera presets'),
44
- z.literal('preset:update').describe('Update presets'),
45
- z.literal('preset:delete').describe('Delete preset'),
46
- z.literal('preset:create').describe('Create preset'),
46
+ zod_1.z.literal('preset:read').describe('Use camera presets'),
47
+ zod_1.z.literal('preset:update').describe('Update presets'),
48
+ zod_1.z.literal('preset:delete').describe('Delete preset'),
49
+ zod_1.z.literal('preset:create').describe('Create preset'),
47
50
  //Door
48
- z.literal('door:release').describe('Release door'),
49
- z.literal('door:lock').describe('Lock or unlock door'),
51
+ zod_1.z.literal('door:release').describe('Release door'),
52
+ zod_1.z.literal('door:lock').describe('Lock or unlock door'),
50
53
  //Camera Lift
51
- z.literal('camera-lift:activate').describe('Activate camera lifts'),
54
+ zod_1.z.literal('camera-lift:activate').describe('Activate camera lifts'),
52
55
  //IO Board
53
- z.literal('io-board:activate').describe('Activate IO board outputs'),
56
+ zod_1.z.literal('io-board:activate').describe('Activate IO board outputs'),
54
57
  //Public View
55
- z.literal('public-view:read').describe('Read public view data'),
56
- z.literal('public-view:update').describe('Update public views'),
57
- z.literal('public-view:delete').describe('Delete public view'),
58
- z.literal('public-view:create').describe('Create public view'),
58
+ zod_1.z.literal('public-view:read').describe('Read public view data'),
59
+ zod_1.z.literal('public-view:update').describe('Update public views'),
60
+ zod_1.z.literal('public-view:delete').describe('Delete public view'),
61
+ zod_1.z.literal('public-view:create').describe('Create public view'),
59
62
  //Private View
60
- z.literal('private-view:read').describe('Read private view data'),
61
- z.literal('private-view:update').describe('Update private views'),
62
- z.literal('private-view:delete').describe('Delete private view'),
63
- z.literal('private-view:create').describe('Create private view'),
63
+ zod_1.z.literal('private-view:read').describe('Read private view data'),
64
+ zod_1.z.literal('private-view:update').describe('Update private views'),
65
+ zod_1.z.literal('private-view:delete').describe('Delete private view'),
66
+ zod_1.z.literal('private-view:create').describe('Create private view'),
64
67
  //Person
65
- z.literal('person:read').describe('Read person data'),
66
- z.literal('person:update').describe('Update person data'),
67
- z.literal('person:delete').describe('Delete person'),
68
- z.literal('person:create').describe('Create person'),
69
- z.literal('person:assign').describe('Assign credentials and access rules'),
70
- z.literal('person:print').describe('Print person details'),
68
+ zod_1.z.literal('person:read').describe('Read person data'),
69
+ zod_1.z.literal('person:update').describe('Update person data'),
70
+ zod_1.z.literal('person:delete').describe('Delete person'),
71
+ zod_1.z.literal('person:create').describe('Create person'),
72
+ zod_1.z.literal('person:assign').describe('Assign credentials and access rules'),
73
+ zod_1.z.literal('person:print').describe('Print person details'),
71
74
  //Doors and Groups (needs access to doors to be useful)
72
- z.literal('door-group:read').describe('Read door group data'),
73
- z.literal('door-group:update').describe('Update door group'),
74
- z.literal('door-group:delete').describe('Delete door group'),
75
- z.literal('door-group:create').describe('Create door group'),
75
+ zod_1.z.literal('door-group:read').describe('Read door group data'),
76
+ zod_1.z.literal('door-group:update').describe('Update door group'),
77
+ zod_1.z.literal('door-group:delete').describe('Delete door group'),
78
+ zod_1.z.literal('door-group:create').describe('Create door group'),
76
79
  //Access Rule
77
- z.literal('access-rule:read').describe('Read access rule data'),
78
- z.literal('access-rule:update').describe('Update access rules'),
79
- z.literal('access-rule:delete').describe('Delete access rule'),
80
- z.literal('access-rule:create').describe('Create access rule'),
80
+ zod_1.z.literal('access-rule:read').describe('Read access rule data'),
81
+ zod_1.z.literal('access-rule:update').describe('Update access rules'),
82
+ zod_1.z.literal('access-rule:delete').describe('Delete access rule'),
83
+ zod_1.z.literal('access-rule:create').describe('Create access rule'),
81
84
  //Schedule
82
- z.literal('schedule:read').describe('Read schedule data'),
83
- z.literal('schedule:update').describe('Update schedule data'),
84
- z.literal('schedule:delete').describe('Delete schedule'),
85
- z.literal('schedule:create').describe('Create schedule'),
85
+ zod_1.z.literal('schedule:read').describe('Read schedule data'),
86
+ zod_1.z.literal('schedule:update').describe('Update schedule data'),
87
+ zod_1.z.literal('schedule:delete').describe('Delete schedule'),
88
+ zod_1.z.literal('schedule:create').describe('Create schedule'),
86
89
  //Presence
87
- z.literal('presence:read').describe('Read presence data'),
88
- z.literal('presence:update').describe('Update presence data'),
89
- z
90
+ zod_1.z.literal('presence:read').describe('Read presence data'),
91
+ zod_1.z.literal('presence:update').describe('Update presence data'),
92
+ zod_1.z
90
93
  .literal('presence:update-reader')
91
94
  .describe('Update presence via USB reader'),
92
95
  //Factory
93
- z.literal('factory:read').describe('Read custom devices'),
94
- z.literal('factory:update').describe('Update custom devices'),
95
- z.literal('factory:delete').describe('Delete custom device'),
96
- z.literal('factory:create').describe('Create custom device'),
96
+ zod_1.z.literal('factory:read').describe('Read custom devices'),
97
+ zod_1.z.literal('factory:update').describe('Update custom devices'),
98
+ zod_1.z.literal('factory:delete').describe('Delete custom device'),
99
+ zod_1.z.literal('factory:create').describe('Create custom device'),
97
100
  //Event
98
- z.literal('event:read').describe('View events'),
99
- z.literal('event:purge').describe('Clear events'), //No UI effect yet
101
+ zod_1.z.literal('event:read').describe('View events'),
102
+ zod_1.z.literal('event:purge').describe('Clear events'), //No UI effect yet
100
103
  //Alarm
101
- z.literal('alarm:read').describe('View alarms'),
102
- z.literal('alarm:acknowlede').describe('Acknowledge alarms'),
103
- z.literal('alarm:arm').describe('Can arm or disarm'),
104
- z.literal('alarm:trigger').describe('Can trigger alarms'),
105
- z.literal('alarm:bypass').describe('Can bypass alarms'),
104
+ zod_1.z.literal('alarm:read').describe('View alarms'),
105
+ zod_1.z.literal('alarm:acknowlede').describe('Acknowledge alarms'),
106
+ zod_1.z.literal('alarm:arm').describe('Can arm or disarm'),
107
+ zod_1.z.literal('alarm:trigger').describe('Can trigger alarms'),
108
+ zod_1.z.literal('alarm:bypass').describe('Can bypass alarms'),
106
109
  //User
107
- z.literal('user:read').describe('View user data'),
108
- z.literal('user:change-password').describe('Change user password'),
109
- z.literal('user:change-username').describe('Change user login id'),
110
- z.literal('user:change-name').describe('Change user name'),
111
- z.literal('user:change-email').describe('Change user email'),
112
- z.literal('user:activate').describe('Activate or Deactivate user'),
113
- z.literal('user:delete').describe('Delete user'),
114
- z.literal('user:change-roles').describe('Change user roles'),
115
- z.literal('user:create').describe('Create user'),
110
+ zod_1.z.literal('user:read').describe('View user data'),
111
+ zod_1.z.literal('user:change-password').describe('Change user password'),
112
+ zod_1.z.literal('user:change-username').describe('Change user login id'),
113
+ zod_1.z.literal('user:change-name').describe('Change user name'),
114
+ zod_1.z.literal('user:change-email').describe('Change user email'),
115
+ zod_1.z.literal('user:activate').describe('Activate or Deactivate user'),
116
+ zod_1.z.literal('user:delete').describe('Delete user'),
117
+ zod_1.z.literal('user:change-roles').describe('Change user roles'),
118
+ zod_1.z.literal('user:create').describe('Create user'),
116
119
  //Role
117
- z.literal('role:read').describe('View role data'),
118
- z.literal('role:create').describe('Create role'),
119
- z.literal('role:delete').describe('Delete role'),
120
- z.literal('role:update').describe('Update role data'),
120
+ zod_1.z.literal('role:read').describe('View role data'),
121
+ zod_1.z.literal('role:create').describe('Create role'),
122
+ zod_1.z.literal('role:delete').describe('Delete role'),
123
+ zod_1.z.literal('role:update').describe('Update role data'),
121
124
  //Module
122
- z.literal('module:read').describe('View module settings'),
123
- z.literal('module:update').describe('Update module settings'),
124
- z.literal('module:enable').describe('Enable and disable modules'),
125
+ zod_1.z.literal('module:read').describe('View module settings'),
126
+ zod_1.z.literal('module:update').describe('Update module settings'),
127
+ zod_1.z.literal('module:enable').describe('Enable and disable modules'),
125
128
  //Device
126
- z.literal('device:discover').describe('Discover devices'), //No UI effect yet
127
- z.literal('device:import').describe('Import discovered devices'), //No UI effect yet
128
- z.literal('device:override-specs').describe('Override device specs'),
129
- z.literal('device:notes').describe('View and Edit device notes'),
130
- z.literal('device:alarms').describe('Configure device alarms'),
131
- z.literal('device:adjacent-cameras').describe('Configure adjacent cameras'),
129
+ zod_1.z.literal('device:discover').describe('Discover devices'), //No UI effect yet
130
+ zod_1.z.literal('device:import').describe('Import discovered devices'), //No UI effect yet
131
+ zod_1.z.literal('device:override-specs').describe('Override device specs'),
132
+ zod_1.z.literal('device:notes').describe('View and Edit device notes'),
133
+ zod_1.z.literal('device:alarms').describe('Configure device alarms'),
134
+ zod_1.z.literal('device:adjacent-cameras').describe('Configure adjacent cameras'),
132
135
  //Automation
133
- z.literal('automation:read').describe('View automation data'),
134
- z.literal('automation:update').describe('Update automation data'), //No UI effect yet
135
- z.literal('automation:delete').describe('Delete automation'), //No UI effect yet
136
- z.literal('automation:create').describe('Create automation'), //No UI effect yet
136
+ zod_1.z.literal('automation:read').describe('View automation data'),
137
+ zod_1.z.literal('automation:update').describe('Update automation data'), //No UI effect yet
138
+ zod_1.z.literal('automation:delete').describe('Delete automation'), //No UI effect yet
139
+ zod_1.z.literal('automation:create').describe('Create automation'), //No UI effect yet
137
140
  //Device Groups
138
- z.literal('device-group:read').describe('View device groups'),
139
- z.literal('device-group:update').describe('Update device groups'),
140
- z.literal('device-group:delete').describe('Delete device group'),
141
- z.literal('device-group:create').describe('Create device group'),
141
+ zod_1.z.literal('device-group:read').describe('View device groups'),
142
+ zod_1.z.literal('device-group:update').describe('Update device groups'),
143
+ zod_1.z.literal('device-group:delete').describe('Delete device group'),
144
+ zod_1.z.literal('device-group:create').describe('Create device group'),
142
145
  //Macros
143
- z.literal('macro:read').describe('View macros'),
144
- z.literal('macro:update').describe('Update macros'),
145
- z.literal('macro:delete').describe('Delete macro'),
146
- z.literal('macro:create').describe('Create macro'),
147
- z.literal('macro:run').describe('Run macro'),
148
- z.literal('notification:create').describe('Send notifications'),
146
+ zod_1.z.literal('macro:read').describe('View macros'),
147
+ zod_1.z.literal('macro:update').describe('Update macros'),
148
+ zod_1.z.literal('macro:delete').describe('Delete macro'),
149
+ zod_1.z.literal('macro:create').describe('Create macro'),
150
+ zod_1.z.literal('macro:run').describe('Run macro'),
151
+ zod_1.z.literal('notification:create').describe('Send notifications'),
149
152
  //Templates
150
- z.literal('template:read').describe('View templates'),
151
- z.literal('template:update').describe('Update templates'),
152
- z.literal('template:delete').describe('Delete template'),
153
- z.literal('template:create').describe('Create template'),
153
+ zod_1.z.literal('template:read').describe('View templates'),
154
+ zod_1.z.literal('template:update').describe('Update templates'),
155
+ zod_1.z.literal('template:delete').describe('Delete template'),
156
+ zod_1.z.literal('template:create').describe('Create template'),
154
157
  //Custom Fields
155
- z.literal('custom-field:read').describe('View custom fields'),
156
- z.literal('custom-field:update').describe('Update custom fields'),
157
- z.literal('custom-field:delete').describe('Delete custom field'),
158
- z.literal('custom-field:create').describe('Create custom field'),
158
+ zod_1.z.literal('custom-field:read').describe('View custom fields'),
159
+ zod_1.z.literal('custom-field:update').describe('Update custom fields'),
160
+ zod_1.z.literal('custom-field:delete').describe('Delete custom field'),
161
+ zod_1.z.literal('custom-field:create').describe('Create custom field'),
159
162
  //Media
160
- z.literal('media:read').describe('View media page'),
163
+ zod_1.z.literal('media:read').describe('View media page'),
161
164
  //About
162
- z.literal('about:read').describe('View about data'),
165
+ zod_1.z.literal('about:read').describe('View about data'),
163
166
  //Intercom
164
- z.literal('intercom:read').describe('View intercom data'), //No UI effect yet
167
+ zod_1.z.literal('intercom:read').describe('View intercom data'), //No UI effect yet
165
168
  //Display
166
- z.literal('display:read').describe('Cast to displays'),
169
+ zod_1.z.literal('display:read').describe('Cast to displays'),
167
170
  ...sDeviceTypePermissions, //No UI effects yet
168
171
  //Security Level
169
- z.literal('security-level:read').describe('View security levels'),
170
- z.literal('security-level:update').describe('Update security levels'),
171
- z.literal('security-level:delete').describe('Delete security level'),
172
- z.literal('security-level:create').describe('Create security level'),
172
+ zod_1.z.literal('security-level:read').describe('View security levels'),
173
+ zod_1.z.literal('security-level:update').describe('Update security levels'),
174
+ zod_1.z.literal('security-level:delete').describe('Delete security level'),
175
+ zod_1.z.literal('security-level:create').describe('Create security level'),
173
176
  //Citadel mode
174
- z.literal('citadel-mode:toggle').describe('Enter / exit citadel mode'),
177
+ zod_1.z.literal('citadel-mode:toggle').describe('Enter / exit citadel mode'),
175
178
  //Token Conversion
176
- z.literal('token-conversion:read').describe('View token conversion data'),
177
- z.literal('token-conversion:update').describe('Update token conversion data'),
178
- z.literal('token-conversion:delete').describe('Delete token conversion'),
179
- z.literal('token-conversion:create').describe('Create token conversion'),
179
+ zod_1.z.literal('token-conversion:read').describe('View token conversion data'),
180
+ zod_1.z.literal('token-conversion:update').describe('Update token conversion data'),
181
+ zod_1.z.literal('token-conversion:delete').describe('Delete token conversion'),
182
+ zod_1.z.literal('token-conversion:create').describe('Create token conversion'),
180
183
  //Bookmarks
181
- z.literal('bookmark:read').describe('View bookmarks'),
182
- z.literal('bookmark:create').describe('Create bookmark'),
183
- z.literal('bookmark:update').describe('Update bookmark'),
184
- z.literal('bookmark:delete').describe('Delete bookmark'),
184
+ zod_1.z.literal('bookmark:read').describe('View bookmarks'),
185
+ zod_1.z.literal('bookmark:create').describe('Create bookmark'),
186
+ zod_1.z.literal('bookmark:update').describe('Update bookmark'),
187
+ zod_1.z.literal('bookmark:delete').describe('Delete bookmark'),
185
188
  //Access Paths
186
- z.literal('access-path:read').describe('View access paths'),
187
- z.literal('access-path:create').describe('Create access path'),
188
- z.literal('access-path:update').describe('Update access path'),
189
- z.literal('access-path:delete').describe('Delete access path'),
189
+ zod_1.z.literal('access-path:read').describe('View access paths'),
190
+ zod_1.z.literal('access-path:create').describe('Create access path'),
191
+ zod_1.z.literal('access-path:update').describe('Update access path'),
192
+ zod_1.z.literal('access-path:delete').describe('Delete access path'),
190
193
  //Person Types
191
- z.literal('person-type:create').describe('Create person type'),
192
- z.literal('person-type:update').describe('Update person type'),
193
- z.literal('person-type:delete').describe('Delete person type'),
194
+ zod_1.z.literal('person-type:create').describe('Create person type'),
195
+ zod_1.z.literal('person-type:update').describe('Update person type'),
196
+ zod_1.z.literal('person-type:delete').describe('Delete person type'),
194
197
  //Agreements
195
- z.literal('agreement:create').describe('Create agreements'),
196
- z.literal('agreement:update').describe('Update agreements'),
197
- z.literal('agreement:delete').describe('Delete agreements'),
198
- z.literal('api-key:create').describe('Create API key'),
199
- z.literal('api-key:revoke').describe('Revoke API key'),
198
+ zod_1.z.literal('agreement:create').describe('Create agreements'),
199
+ zod_1.z.literal('agreement:update').describe('Update agreements'),
200
+ zod_1.z.literal('agreement:delete').describe('Delete agreements'),
201
+ zod_1.z.literal('api-key:create').describe('Create API key'),
202
+ zod_1.z.literal('api-key:revoke').describe('Revoke API key'),
200
203
  ]);
201
204
  const permissionsToRecord = (permissions) => {
202
205
  const options = permissions.options;
@@ -211,5 +214,5 @@ const permissionsToArray = (permissions) => {
211
214
  const options = permissions.options;
212
215
  return options.map((option) => option.value);
213
216
  };
214
- export const permissions = permissionsToRecord(sPermissionId);
215
- export const permissionsArray = permissionsToArray(sPermissionId);
217
+ exports.permissions = permissionsToRecord(exports.sPermissionId);
218
+ exports.permissionsArray = permissionsToArray(exports.sPermissionId);
@@ -1,39 +1,42 @@
1
- import { z } from 'zod';
2
- import { sAnyDeviceSpecs, sForeignDeviceInfo, sPresetDto, } from './objects/device';
3
- export const sDeviceId = z.string().uuid().nonempty();
4
- export const sPresetId = z.string().uuid().nonempty();
5
- export const sDeviceEvent = z.record(z.unknown());
6
- export const sPersonId = z.string().uuid().nonempty();
7
- export const sZoneId = z.string().uuid().nonempty();
8
- export const sMacroId = z.string().uuid().nonempty();
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.sCallDirection = exports.sCallState = exports.sCameraPresetInfo = exports.sNotificationSeverity = exports.sDeviceParam = exports.sForeignDeviceId = exports.sAgentDeviceInfo = exports.sFileResponse = exports.sUrl = exports.sDuration = exports.sMacroId = exports.sZoneId = exports.sPersonId = exports.sDeviceEvent = exports.sPresetId = exports.sDeviceId = void 0;
4
+ const zod_1 = require("zod");
5
+ const device_1 = require("./objects/device");
6
+ exports.sDeviceId = zod_1.z.string().uuid().nonempty();
7
+ exports.sPresetId = zod_1.z.string().uuid().nonempty();
8
+ exports.sDeviceEvent = zod_1.z.record(zod_1.z.unknown());
9
+ exports.sPersonId = zod_1.z.string().uuid().nonempty();
10
+ exports.sZoneId = zod_1.z.string().uuid().nonempty();
11
+ exports.sMacroId = zod_1.z.string().uuid().nonempty();
9
12
  // general
10
- export const sDuration = z.number().min(0).describe('Duration in milliseconds');
11
- export const sUrl = z.string().url().describe('A valid URL');
12
- export const sFileResponse = z
13
+ exports.sDuration = zod_1.z.number().min(0).describe('Duration in milliseconds');
14
+ exports.sUrl = zod_1.z.string().url().describe('A valid URL');
15
+ exports.sFileResponse = zod_1.z
13
16
  .object({
14
- mimeType: z.string().nonempty(),
15
- data: z.string().nonempty(),
17
+ mimeType: zod_1.z.string().nonempty(),
18
+ data: zod_1.z.string().nonempty(),
16
19
  })
17
20
  .nullable();
18
- export const sAgentDeviceInfo = z.intersection(sForeignDeviceInfo.merge(z.object({
19
- presets: z.array(sPresetDto),
20
- })), sAnyDeviceSpecs);
21
- export const sForeignDeviceId = z.tuple([
22
- z.string().nonempty().describe('Foreign system identifier'),
23
- z.string().nonempty().describe('Device identifier in foreign system'),
21
+ exports.sAgentDeviceInfo = zod_1.z.intersection(device_1.sForeignDeviceInfo.merge(zod_1.z.object({
22
+ presets: zod_1.z.array(device_1.sPresetDto),
23
+ })), device_1.sAnyDeviceSpecs);
24
+ exports.sForeignDeviceId = zod_1.z.tuple([
25
+ zod_1.z.string().nonempty().describe('Foreign system identifier'),
26
+ zod_1.z.string().nonempty().describe('Device identifier in foreign system'),
24
27
  ]);
25
28
  // a pointer to a device, can be local device id, foreign device info, or full device info for agents
26
- export const sDeviceParam = sDeviceId.or(sAgentDeviceInfo).or(sForeignDeviceId);
27
- export const sNotificationSeverity = z.enum(['info', 'warning', 'critical']);
28
- export const sCameraPresetInfo = z.object({
29
- name: z.string().nonempty(),
30
- isDefault: z.boolean(),
31
- values: z.unknown(),
29
+ exports.sDeviceParam = exports.sDeviceId.or(exports.sAgentDeviceInfo).or(exports.sForeignDeviceId);
30
+ exports.sNotificationSeverity = zod_1.z.enum(['info', 'warning', 'critical']);
31
+ exports.sCameraPresetInfo = zod_1.z.object({
32
+ name: zod_1.z.string().nonempty(),
33
+ isDefault: zod_1.z.boolean(),
34
+ values: zod_1.z.unknown(),
32
35
  });
33
- export const sCallState = z.enum([
36
+ exports.sCallState = zod_1.z.enum([
34
37
  'connecting',
35
38
  'connected',
36
39
  'ringing',
37
40
  'terminated',
38
41
  ]);
39
- export const sCallDirection = z.enum(['incoming', 'outgoing']);
42
+ exports.sCallDirection = zod_1.z.enum(['incoming', 'outgoing']);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awarevue/api-types",
3
- "version": "2.0.24",
3
+ "version": "2.0.26",
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",