@awarevue/api-types 1.0.1

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 (132) hide show
  1. package/dist/access-control/access-rule.d.ts +243 -0
  2. package/dist/access-control/access-rule.js +49 -0
  3. package/dist/access-control/credential.d.ts +14 -0
  4. package/dist/access-control/credential.js +12 -0
  5. package/dist/access-control/index.d.ts +7 -0
  6. package/dist/access-control/index.js +23 -0
  7. package/dist/access-control/person-presence.d.ts +249 -0
  8. package/dist/access-control/person-presence.js +61 -0
  9. package/dist/access-control/person.d.ts +209 -0
  10. package/dist/access-control/person.js +49 -0
  11. package/dist/access-control/schedule.d.ts +500 -0
  12. package/dist/access-control/schedule.js +65 -0
  13. package/dist/access-control/sync.d.ts +3 -0
  14. package/dist/access-control/sync.js +2 -0
  15. package/dist/access-control/zone.d.ts +65 -0
  16. package/dist/access-control/zone.js +28 -0
  17. package/dist/agent-communication/index.d.ts +1 -0
  18. package/dist/agent-communication/index.js +17 -0
  19. package/dist/agent-communication/protocol.d.ts +1692 -0
  20. package/dist/agent-communication/protocol.js +341 -0
  21. package/dist/api/alarm.d.ts +23 -0
  22. package/dist/api/alarm.js +2 -0
  23. package/dist/api/auth.d.ts +31 -0
  24. package/dist/api/auth.js +19 -0
  25. package/dist/api/index.d.ts +4 -0
  26. package/dist/api/index.js +20 -0
  27. package/dist/api/media.d.ts +187 -0
  28. package/dist/api/media.js +59 -0
  29. package/dist/api/query.d.ts +33 -0
  30. package/dist/api/query.js +41 -0
  31. package/dist/app.d.ts +12 -0
  32. package/dist/app.js +8 -0
  33. package/dist/automation.d.ts +334 -0
  34. package/dist/automation.js +49 -0
  35. package/dist/aware-config.d.ts +3 -0
  36. package/dist/aware-config.js +2 -0
  37. package/dist/custom-field.d.ts +52 -0
  38. package/dist/custom-field.js +19 -0
  39. package/dist/device/alarm.d.ts +265 -0
  40. package/dist/device/alarm.js +66 -0
  41. package/dist/device/any-device.d.ts +2376 -0
  42. package/dist/device/any-device.js +185 -0
  43. package/dist/device/camera-lift.d.ts +17 -0
  44. package/dist/device/camera-lift.js +7 -0
  45. package/dist/device/camera.d.ts +829 -0
  46. package/dist/device/camera.js +120 -0
  47. package/dist/device/device-gateway.d.ts +3 -0
  48. package/dist/device/device-gateway.js +4 -0
  49. package/dist/device/door.d.ts +217 -0
  50. package/dist/device/door.js +57 -0
  51. package/dist/device/index.d.ts +15 -0
  52. package/dist/device/index.js +31 -0
  53. package/dist/device/intercom-operator.d.ts +13 -0
  54. package/dist/device/intercom-operator.js +5 -0
  55. package/dist/device/intercom-terminal.d.ts +244 -0
  56. package/dist/device/intercom-terminal.js +48 -0
  57. package/dist/device/io-board.d.ts +55 -0
  58. package/dist/device/io-board.js +19 -0
  59. package/dist/device/motion-sensor.d.ts +8 -0
  60. package/dist/device/motion-sensor.js +8 -0
  61. package/dist/device/panic-button.d.ts +26 -0
  62. package/dist/device/panic-button.js +14 -0
  63. package/dist/device/pbx.d.ts +20 -0
  64. package/dist/device/pbx.js +11 -0
  65. package/dist/device/presence-tracker.d.ts +127 -0
  66. package/dist/device/presence-tracker.js +27 -0
  67. package/dist/device/reader/commands.d.ts +1 -0
  68. package/dist/device/reader/commands.js +2 -0
  69. package/dist/device/reader/events.d.ts +37 -0
  70. package/dist/device/reader/events.js +13 -0
  71. package/dist/device/reader/index.d.ts +3 -0
  72. package/dist/device/reader/index.js +19 -0
  73. package/dist/device/reader/specs.d.ts +2 -0
  74. package/dist/device/reader/specs.js +4 -0
  75. package/dist/device/server.d.ts +73 -0
  76. package/dist/device/server.js +33 -0
  77. package/dist/device-command.d.ts +23 -0
  78. package/dist/device-command.js +110 -0
  79. package/dist/device-event.d.ts +682 -0
  80. package/dist/device-event.js +87 -0
  81. package/dist/device-factory.d.ts +112 -0
  82. package/dist/device-factory.js +25 -0
  83. package/dist/device-group.d.ts +74 -0
  84. package/dist/device-group.js +31 -0
  85. package/dist/device-import.d.ts +1412 -0
  86. package/dist/device-import.js +33 -0
  87. package/dist/device-relation.d.ts +30 -0
  88. package/dist/device-relation.js +68 -0
  89. package/dist/device-state.d.ts +10 -0
  90. package/dist/device-state.js +2 -0
  91. package/dist/error.d.ts +13 -0
  92. package/dist/error.js +10 -0
  93. package/dist/file.d.ts +3 -0
  94. package/dist/file.js +2 -0
  95. package/dist/index.d.ts +28 -0
  96. package/dist/index.js +44 -0
  97. package/dist/layout.d.ts +188 -0
  98. package/dist/layout.js +40 -0
  99. package/dist/macros.d.ts +160 -0
  100. package/dist/macros.js +26 -0
  101. package/dist/messages/device-communication.d.ts +121 -0
  102. package/dist/messages/device-communication.js +63 -0
  103. package/dist/messages/index.d.ts +5 -0
  104. package/dist/messages/index.js +21 -0
  105. package/dist/messages/progress.d.ts +118 -0
  106. package/dist/messages/progress.js +51 -0
  107. package/dist/messages/provider-api/index.d.ts +1 -0
  108. package/dist/messages/provider-api/index.js +17 -0
  109. package/dist/messages/provider-api/sync-protocol.d.ts +83 -0
  110. package/dist/messages/provider-api/sync-protocol.js +2 -0
  111. package/dist/messages/web-rtc-signaling.d.ts +265 -0
  112. package/dist/messages/web-rtc-signaling.js +82 -0
  113. package/dist/messages/web-socket.d.ts +7 -0
  114. package/dist/messages/web-socket.js +5 -0
  115. package/dist/milestone.d.ts +5 -0
  116. package/dist/milestone.js +2 -0
  117. package/dist/module-config.d.ts +27 -0
  118. package/dist/module-config.js +2 -0
  119. package/dist/orchid.d.ts +19 -0
  120. package/dist/orchid.js +2 -0
  121. package/dist/package.json +40 -0
  122. package/dist/permissions.d.ts +6 -0
  123. package/dist/permissions.js +168 -0
  124. package/dist/template.d.ts +50 -0
  125. package/dist/template.js +21 -0
  126. package/dist/user.d.ts +184 -0
  127. package/dist/user.js +56 -0
  128. package/dist/view.d.ts +775 -0
  129. package/dist/view.js +74 -0
  130. package/dist/webrtc-playback.d.ts +20 -0
  131. package/dist/webrtc-playback.js +14 -0
  132. package/package.json +40 -0
@@ -0,0 +1,185 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.sSetUnsetRelationRequest = exports.sRemoveDevicePresetRequest = exports.sUpdateDevicePresetRequest = exports.sAddDevicePresetRequest = exports.sOverrideDeviceSpecsRequest = exports.sUpdateDeviceRequest = exports.sAddDeviceRequest = exports.sIntercomOperatorDto = exports.sAlarmDto = exports.sServerDto = exports.sPresenceTrackerDto = exports.sDeviceGatewayDto = exports.sPbxDto = exports.sIntercomTerminalDto = exports.sPanicButtonDto = exports.sMotionSensorDto = exports.sCameraLiftDto = exports.sIoBoardDto = exports.sReaderDto = exports.sDoorDto = exports.sCameraDto = exports.sDeviceDto = exports.sForeignDeviceInfo = exports.sDeviceMgmtInfo = exports.sPresetDto = exports.sProviderMetadata = exports.sAnyDeviceSpecs = exports.DEVICE_TYPES = void 0;
4
+ const zod_1 = require("zod");
5
+ const camera_1 = require("./camera");
6
+ const door_1 = require("./door");
7
+ const io_board_1 = require("./io-board");
8
+ const camera_lift_1 = require("./camera-lift");
9
+ const motion_sensor_1 = require("./motion-sensor");
10
+ const panic_button_1 = require("./panic-button");
11
+ const intercom_operator_1 = require("./intercom-operator");
12
+ const intercom_terminal_1 = require("./intercom-terminal");
13
+ const pbx_1 = require("./pbx");
14
+ const server_1 = require("./server");
15
+ const alarm_1 = require("./alarm");
16
+ const device_relation_1 = require("../device-relation");
17
+ const device_gateway_1 = require("./device-gateway");
18
+ const presence_tracker_1 = require("./presence-tracker");
19
+ exports.DEVICE_TYPES = [
20
+ alarm_1.ALARM,
21
+ server_1.SERVER,
22
+ camera_1.CAMERA,
23
+ door_1.DOOR,
24
+ 'reader',
25
+ io_board_1.IO_BOARD,
26
+ camera_lift_1.CAMERA_LIFT,
27
+ motion_sensor_1.MOTION_SENSOR,
28
+ panic_button_1.PANIC_BUTTON,
29
+ intercom_operator_1.INTERCOM_OPERATOR,
30
+ intercom_terminal_1.INTERCOM_TERMINAL,
31
+ pbx_1.PBX,
32
+ device_gateway_1.DEVICE_GATEWAY,
33
+ presence_tracker_1.PRESENCE_TRACKER,
34
+ ];
35
+ const sDeviceType = zod_1.z.enum(exports.DEVICE_TYPES);
36
+ const sAlarmSpecsWithType = alarm_1.sAlarmSpecs.merge(zod_1.z.object({ type: zod_1.z.literal(alarm_1.ALARM) }));
37
+ const sCameraSpecsWithType = camera_1.sCameraSpecs.merge(zod_1.z.object({ type: zod_1.z.literal(camera_1.CAMERA) }));
38
+ const sDoorSpecsWithType = door_1.sDoorSpecs.merge(zod_1.z.object({ type: zod_1.z.literal(door_1.DOOR) }));
39
+ const sIoBoardSpecsWithType = io_board_1.sIoBoardSpecs.merge(zod_1.z.object({ type: zod_1.z.literal(io_board_1.IO_BOARD) }));
40
+ const sCameraLiftSpecsWithType = camera_lift_1.sCameraLiftSpecs.merge(zod_1.z.object({ type: zod_1.z.literal(camera_lift_1.CAMERA_LIFT) }));
41
+ const sMotionSensorSpecsWithType = motion_sensor_1.sMotionSensorSpecs.merge(zod_1.z.object({ type: zod_1.z.literal(motion_sensor_1.MOTION_SENSOR) }));
42
+ const sPanicButtonSpecsWithType = panic_button_1.sPanicButtonSpecs.merge(zod_1.z.object({ type: zod_1.z.literal(panic_button_1.PANIC_BUTTON) }));
43
+ const sIntercomTerminalSpecsWithType = intercom_terminal_1.sIntercomTerminalSpecs.merge(zod_1.z.object({ type: zod_1.z.literal(intercom_terminal_1.INTERCOM_TERMINAL) }));
44
+ const sPbxSpecsWithType = pbx_1.sPbxSpecs.merge(zod_1.z.object({ type: zod_1.z.literal(pbx_1.PBX) }));
45
+ const sServerSpecsWithType = zod_1.z.object({ type: zod_1.z.literal(server_1.SERVER) });
46
+ const sIntercomOperatorSpecsWithType = zod_1.z.object({
47
+ type: zod_1.z.literal(intercom_operator_1.INTERCOM_OPERATOR),
48
+ });
49
+ const sDeviceGatewaySpecsWithType = zod_1.z.object({
50
+ type: zod_1.z.literal(device_gateway_1.DEVICE_GATEWAY),
51
+ });
52
+ const sPresenceTrackerSpecsWithType = zod_1.z.object({
53
+ type: zod_1.z.literal(presence_tracker_1.PRESENCE_TRACKER),
54
+ });
55
+ const sReaderSpecsWithType = zod_1.z.object({ type: zod_1.z.literal('reader') });
56
+ exports.sAnyDeviceSpecs = zod_1.z.discriminatedUnion('type', [
57
+ sAlarmSpecsWithType,
58
+ sCameraSpecsWithType,
59
+ sDoorSpecsWithType,
60
+ sIoBoardSpecsWithType,
61
+ sCameraLiftSpecsWithType,
62
+ sMotionSensorSpecsWithType,
63
+ sPanicButtonSpecsWithType,
64
+ sIntercomTerminalSpecsWithType,
65
+ sPbxSpecsWithType,
66
+ sServerSpecsWithType,
67
+ sIntercomOperatorSpecsWithType,
68
+ sDeviceGatewaySpecsWithType,
69
+ sPresenceTrackerSpecsWithType,
70
+ sReaderSpecsWithType,
71
+ ]);
72
+ exports.sProviderMetadata = zod_1.z.object({}).catchall(zod_1.z.unknown());
73
+ exports.sPresetDto = zod_1.z.object({
74
+ id: zod_1.z.string(),
75
+ name: zod_1.z.string(),
76
+ params: zod_1.z.unknown(),
77
+ isDefault: zod_1.z.boolean(),
78
+ assignedRef: zod_1.z.string().nullable(),
79
+ createdOn: zod_1.z.string().datetime(),
80
+ lastModifiedOn: zod_1.z.string().datetime(),
81
+ });
82
+ exports.sDeviceMgmtInfo = zod_1.z.object({
83
+ id: zod_1.z.string(),
84
+ presets: zod_1.z.array(exports.sPresetDto),
85
+ notes: zod_1.z.string().nullable(),
86
+ tags: zod_1.z.array(zod_1.z.string()),
87
+ relations: zod_1.z.array(device_relation_1.sDeviceRelationSide),
88
+ groups: zod_1.z.array(zod_1.z.string()),
89
+ createdOn: zod_1.z.string().datetime(),
90
+ lastModifiedOn: zod_1.z.string().datetime(),
91
+ });
92
+ exports.sForeignDeviceInfo = zod_1.z.object({
93
+ name: zod_1.z.string(),
94
+ foreignRef: zod_1.z.string(),
95
+ provider: zod_1.z.string(),
96
+ providerMetadata: exports.sProviderMetadata,
97
+ });
98
+ exports.sDeviceDto = exports.sAnyDeviceSpecs
99
+ .and(exports.sDeviceMgmtInfo)
100
+ .and(exports.sForeignDeviceInfo);
101
+ exports.sCameraDto = sCameraSpecsWithType
102
+ .and(exports.sDeviceMgmtInfo)
103
+ .and(exports.sForeignDeviceInfo);
104
+ exports.sDoorDto = sDoorSpecsWithType
105
+ .and(exports.sDeviceMgmtInfo)
106
+ .and(exports.sForeignDeviceInfo);
107
+ exports.sReaderDto = sReaderSpecsWithType
108
+ .and(exports.sDeviceMgmtInfo)
109
+ .and(exports.sForeignDeviceInfo);
110
+ exports.sIoBoardDto = sIoBoardSpecsWithType
111
+ .and(exports.sDeviceMgmtInfo)
112
+ .and(exports.sForeignDeviceInfo);
113
+ exports.sCameraLiftDto = sCameraLiftSpecsWithType
114
+ .and(exports.sDeviceMgmtInfo)
115
+ .and(exports.sForeignDeviceInfo);
116
+ exports.sMotionSensorDto = sMotionSensorSpecsWithType
117
+ .and(exports.sDeviceMgmtInfo)
118
+ .and(exports.sForeignDeviceInfo);
119
+ exports.sPanicButtonDto = sPanicButtonSpecsWithType
120
+ .and(exports.sDeviceMgmtInfo)
121
+ .and(exports.sForeignDeviceInfo);
122
+ exports.sIntercomTerminalDto = sIntercomTerminalSpecsWithType
123
+ .and(exports.sDeviceMgmtInfo)
124
+ .and(exports.sForeignDeviceInfo);
125
+ exports.sPbxDto = sPbxSpecsWithType
126
+ .and(exports.sDeviceMgmtInfo)
127
+ .and(exports.sForeignDeviceInfo);
128
+ exports.sDeviceGatewayDto = sDeviceGatewaySpecsWithType
129
+ .and(exports.sDeviceMgmtInfo)
130
+ .and(exports.sForeignDeviceInfo);
131
+ exports.sPresenceTrackerDto = sPresenceTrackerSpecsWithType
132
+ .and(exports.sDeviceMgmtInfo)
133
+ .and(exports.sForeignDeviceInfo);
134
+ exports.sServerDto = sServerSpecsWithType
135
+ .and(exports.sDeviceMgmtInfo)
136
+ .and(exports.sForeignDeviceInfo);
137
+ exports.sAlarmDto = sAlarmSpecsWithType
138
+ .and(exports.sDeviceMgmtInfo)
139
+ .and(exports.sForeignDeviceInfo);
140
+ exports.sIntercomOperatorDto = sIntercomOperatorSpecsWithType
141
+ .and(exports.sDeviceMgmtInfo)
142
+ .and(exports.sForeignDeviceInfo);
143
+ exports.sAddDeviceRequest = zod_1.z.object({
144
+ name: zod_1.z.string().nonempty(),
145
+ foreignRef: zod_1.z.string().nonempty(),
146
+ notes: zod_1.z.string().nullable(),
147
+ provider: zod_1.z.string().nonempty(),
148
+ providerMetadata: exports.sProviderMetadata,
149
+ tags: zod_1.z.array(zod_1.z.string().nonempty()),
150
+ relations: zod_1.z.array(device_relation_1.sDeviceRelationSide),
151
+ type: sDeviceType,
152
+ specs: zod_1.z.object({}).catchall(zod_1.z.unknown()).optional(),
153
+ });
154
+ exports.sUpdateDeviceRequest = zod_1.z.object({
155
+ id: zod_1.z.string().nonempty(),
156
+ name: zod_1.z.string().optional(),
157
+ notes: zod_1.z.string().nullable().optional(),
158
+ providerMetadata: zod_1.z.object({}).catchall(zod_1.z.unknown()).optional(),
159
+ specs: zod_1.z.object({}).catchall(zod_1.z.unknown()).optional(),
160
+ tags: zod_1.z.array(zod_1.z.string()).optional(),
161
+ relations: zod_1.z.array(device_relation_1.sDeviceRelationSide).optional(),
162
+ });
163
+ exports.sOverrideDeviceSpecsRequest = zod_1.z.object({
164
+ id: zod_1.z.string(),
165
+ specs: zod_1.z.object({}).catchall(zod_1.z.unknown()),
166
+ });
167
+ exports.sAddDevicePresetRequest = zod_1.z.object({
168
+ name: zod_1.z.string().nonempty(),
169
+ params: zod_1.z.object({}).catchall(zod_1.z.unknown()),
170
+ assignedRef: zod_1.z.string().nullable(),
171
+ isDefault: zod_1.z.boolean(),
172
+ deviceId: zod_1.z.string().nonempty(),
173
+ });
174
+ exports.sUpdateDevicePresetRequest = zod_1.z.object({
175
+ name: zod_1.z.string().optional(),
176
+ isDefault: zod_1.z.boolean().optional(),
177
+ assignedRef: zod_1.z.string().nullable().optional(),
178
+ deviceId: zod_1.z.string().nonempty(),
179
+ presetId: zod_1.z.string().nonempty(),
180
+ });
181
+ exports.sRemoveDevicePresetRequest = zod_1.z.object({
182
+ deviceId: zod_1.z.string().nonempty(),
183
+ presetId: zod_1.z.string().nonempty(),
184
+ });
185
+ exports.sSetUnsetRelationRequest = device_relation_1.sDeviceRelationDto;
@@ -0,0 +1,17 @@
1
+ import { z } from 'zod';
2
+ export declare const CAMERA_LIFT: "camera-lift";
3
+ export declare const sCameraLiftSpecs: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
4
+ export type CameraLiftSpecs = z.infer<typeof sCameraLiftSpecs>;
5
+ export interface CameraLiftRaiseCommand {
6
+ command: 'camera-lift.raise';
7
+ params: object;
8
+ }
9
+ export interface CameraLiftLowerCommand {
10
+ command: 'camera-lift.lower';
11
+ params: object;
12
+ }
13
+ export type CameraLiftCommand = CameraLiftRaiseCommand | CameraLiftLowerCommand;
14
+ export interface CameraLiftStateDto {
15
+ raised: boolean;
16
+ connected: boolean;
17
+ }
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.sCameraLiftSpecs = exports.CAMERA_LIFT = void 0;
4
+ const zod_1 = require("zod");
5
+ exports.CAMERA_LIFT = 'camera-lift';
6
+ // SPECS
7
+ exports.sCameraLiftSpecs = zod_1.z.object({});