@awarevue/api-types 1.0.108 → 1.0.110
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.
- package/dist/access-control/person-presence.d.ts +4 -4
- package/dist/agent-communication/protocol.d.ts +49 -28
- package/dist/agent-communication/queries.d.ts +6 -6
- package/dist/bookmarks.d.ts +10 -10
- package/dist/device/alarm.d.ts +317 -54
- package/dist/device/alarm.js +59 -1
- package/dist/device/any-device.d.ts +39 -0
- package/dist/device/camera-lift.d.ts +44 -8
- package/dist/device/camera-lift.js +14 -1
- package/dist/device/camera.d.ts +449 -40
- package/dist/device/camera.js +89 -1
- package/dist/device/display.d.ts +416 -9
- package/dist/device/display.js +34 -1
- package/dist/device/door.d.ts +102 -17
- package/dist/device/door.js +30 -2
- package/dist/device/intercom-terminal.d.ts +2 -2
- package/dist/device/io-board.d.ts +49 -3
- package/dist/device/io-board.js +12 -1
- package/dist/device/pbx.d.ts +69 -5
- package/dist/device/pbx.js +14 -1
- package/dist/device/presence-tracker.d.ts +164 -21
- package/dist/device/presence-tracker.js +32 -3
- package/dist/device/server.d.ts +45 -8
- package/dist/device/server.js +13 -1
- package/dist/device-command.d.ts +741 -0
- package/dist/device-command.js +19 -1
- package/dist/device-event.d.ts +20 -20
- package/dist/device-import.d.ts +76 -0
- package/dist/macros.d.ts +14 -14
- package/dist/messages/device-communication.d.ts +10 -10
- package/dist/package.json +1 -1
- package/dist/primitives.d.ts +9 -0
- package/dist/primitives.js +13 -0
- package/package.json +1 -1
package/dist/device/alarm.d.ts
CHANGED
|
@@ -1,55 +1,318 @@
|
|
|
1
|
-
import { DeviceEvent } from '../device-event';
|
|
2
1
|
import { z } from 'zod';
|
|
3
2
|
export declare const ALARM: "alarm";
|
|
4
3
|
export declare const sAlarmSpecs: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
|
|
5
4
|
export type AlarmSpecs = z.infer<typeof sAlarmSpecs>;
|
|
6
|
-
export
|
|
7
|
-
command:
|
|
5
|
+
export declare const sArmCommand: z.ZodObject<{
|
|
6
|
+
command: z.ZodLiteral<"alarm.arm">;
|
|
7
|
+
params: z.ZodObject<{
|
|
8
|
+
deviceId: z.ZodString;
|
|
9
|
+
}, "strip", z.ZodTypeAny, {
|
|
10
|
+
deviceId: string;
|
|
11
|
+
}, {
|
|
12
|
+
deviceId: string;
|
|
13
|
+
}>;
|
|
14
|
+
}, "strip", z.ZodTypeAny, {
|
|
15
|
+
params: {
|
|
16
|
+
deviceId: string;
|
|
17
|
+
};
|
|
18
|
+
command: "alarm.arm";
|
|
19
|
+
}, {
|
|
8
20
|
params: {
|
|
9
21
|
deviceId: string;
|
|
10
22
|
};
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
23
|
+
command: "alarm.arm";
|
|
24
|
+
}>;
|
|
25
|
+
export type ArmCommand = z.infer<typeof sArmCommand>;
|
|
26
|
+
export declare const sDisarmCommand: z.ZodObject<{
|
|
27
|
+
command: z.ZodLiteral<"alarm.disarm">;
|
|
28
|
+
params: z.ZodObject<{
|
|
29
|
+
deviceId: z.ZodString;
|
|
30
|
+
duration: z.ZodOptional<z.ZodNumber>;
|
|
31
|
+
}, "strip", z.ZodTypeAny, {
|
|
32
|
+
deviceId: string;
|
|
33
|
+
duration?: number | undefined;
|
|
34
|
+
}, {
|
|
35
|
+
deviceId: string;
|
|
36
|
+
duration?: number | undefined;
|
|
37
|
+
}>;
|
|
38
|
+
}, "strip", z.ZodTypeAny, {
|
|
14
39
|
params: {
|
|
15
40
|
deviceId: string;
|
|
16
|
-
duration?: number;
|
|
41
|
+
duration?: number | undefined;
|
|
17
42
|
};
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
command: 'alarm.bypass';
|
|
43
|
+
command: "alarm.disarm";
|
|
44
|
+
}, {
|
|
21
45
|
params: {
|
|
22
46
|
deviceId: string;
|
|
47
|
+
duration?: number | undefined;
|
|
23
48
|
};
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
49
|
+
command: "alarm.disarm";
|
|
50
|
+
}>;
|
|
51
|
+
export type DisarmCommand = z.infer<typeof sDisarmCommand>;
|
|
52
|
+
export declare const sBypassCommand: z.ZodObject<{
|
|
53
|
+
command: z.ZodLiteral<"alarm.bypass">;
|
|
54
|
+
params: z.ZodObject<{
|
|
55
|
+
deviceId: z.ZodString;
|
|
56
|
+
}, "strip", z.ZodTypeAny, {
|
|
57
|
+
deviceId: string;
|
|
58
|
+
}, {
|
|
59
|
+
deviceId: string;
|
|
60
|
+
}>;
|
|
61
|
+
}, "strip", z.ZodTypeAny, {
|
|
27
62
|
params: {
|
|
28
63
|
deviceId: string;
|
|
29
64
|
};
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
command: 'alarm.arm-all';
|
|
33
|
-
params: object;
|
|
34
|
-
}
|
|
35
|
-
export interface DisarmAllCommand {
|
|
36
|
-
command: 'alarm.disarm-all';
|
|
65
|
+
command: "alarm.bypass";
|
|
66
|
+
}, {
|
|
37
67
|
params: {
|
|
38
|
-
|
|
68
|
+
deviceId: string;
|
|
39
69
|
};
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
70
|
+
command: "alarm.bypass";
|
|
71
|
+
}>;
|
|
72
|
+
export type BypassCommand = z.infer<typeof sBypassCommand>;
|
|
73
|
+
export declare const sUnbypassCommand: z.ZodObject<{
|
|
74
|
+
command: z.ZodLiteral<"alarm.unbypass">;
|
|
75
|
+
params: z.ZodObject<{
|
|
76
|
+
deviceId: z.ZodString;
|
|
77
|
+
}, "strip", z.ZodTypeAny, {
|
|
78
|
+
deviceId: string;
|
|
79
|
+
}, {
|
|
80
|
+
deviceId: string;
|
|
81
|
+
}>;
|
|
82
|
+
}, "strip", z.ZodTypeAny, {
|
|
47
83
|
params: {
|
|
48
|
-
|
|
84
|
+
deviceId: string;
|
|
85
|
+
};
|
|
86
|
+
command: "alarm.unbypass";
|
|
87
|
+
}, {
|
|
88
|
+
params: {
|
|
89
|
+
deviceId: string;
|
|
90
|
+
};
|
|
91
|
+
command: "alarm.unbypass";
|
|
92
|
+
}>;
|
|
93
|
+
export type UnbypassCommand = z.infer<typeof sUnbypassCommand>;
|
|
94
|
+
export declare const sArmAllCommand: z.ZodObject<{
|
|
95
|
+
command: z.ZodLiteral<"alarm.arm-all">;
|
|
96
|
+
params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
|
|
97
|
+
}, "strip", z.ZodTypeAny, {
|
|
98
|
+
params: {};
|
|
99
|
+
command: "alarm.arm-all";
|
|
100
|
+
}, {
|
|
101
|
+
params: {};
|
|
102
|
+
command: "alarm.arm-all";
|
|
103
|
+
}>;
|
|
104
|
+
export type ArmAllCommand = z.infer<typeof sArmAllCommand>;
|
|
105
|
+
export declare const sDisarmAllCommand: z.ZodObject<{
|
|
106
|
+
command: z.ZodLiteral<"alarm.disarm-all">;
|
|
107
|
+
params: z.ZodObject<{
|
|
108
|
+
duration: z.ZodOptional<z.ZodNumber>;
|
|
109
|
+
}, "strip", z.ZodTypeAny, {
|
|
110
|
+
duration?: number | undefined;
|
|
111
|
+
}, {
|
|
112
|
+
duration?: number | undefined;
|
|
113
|
+
}>;
|
|
114
|
+
}, "strip", z.ZodTypeAny, {
|
|
115
|
+
params: {
|
|
116
|
+
duration?: number | undefined;
|
|
117
|
+
};
|
|
118
|
+
command: "alarm.disarm-all";
|
|
119
|
+
}, {
|
|
120
|
+
params: {
|
|
121
|
+
duration?: number | undefined;
|
|
122
|
+
};
|
|
123
|
+
command: "alarm.disarm-all";
|
|
124
|
+
}>;
|
|
125
|
+
export type DisarmAllCommand = z.infer<typeof sDisarmAllCommand>;
|
|
126
|
+
export declare const sAcknowledgeCommand: z.ZodObject<{
|
|
127
|
+
command: z.ZodLiteral<"alarm.acknowledge">;
|
|
128
|
+
params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
|
|
129
|
+
}, "strip", z.ZodTypeAny, {
|
|
130
|
+
params: {};
|
|
131
|
+
command: "alarm.acknowledge";
|
|
132
|
+
}, {
|
|
133
|
+
params: {};
|
|
134
|
+
command: "alarm.acknowledge";
|
|
135
|
+
}>;
|
|
136
|
+
export type AcknowledgeCommand = z.infer<typeof sAcknowledgeCommand>;
|
|
137
|
+
export declare const sSetTriggerCommand: z.ZodObject<{
|
|
138
|
+
command: z.ZodLiteral<"alarm.set-trigger">;
|
|
139
|
+
params: z.ZodObject<{
|
|
140
|
+
event: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
141
|
+
onlyIfArmed: z.ZodBoolean;
|
|
142
|
+
}, "strip", z.ZodTypeAny, {
|
|
143
|
+
event: Record<string, unknown>;
|
|
144
|
+
onlyIfArmed: boolean;
|
|
145
|
+
}, {
|
|
146
|
+
event: Record<string, unknown>;
|
|
147
|
+
onlyIfArmed: boolean;
|
|
148
|
+
}>;
|
|
149
|
+
}, "strip", z.ZodTypeAny, {
|
|
150
|
+
params: {
|
|
151
|
+
event: Record<string, unknown>;
|
|
152
|
+
onlyIfArmed: boolean;
|
|
153
|
+
};
|
|
154
|
+
command: "alarm.set-trigger";
|
|
155
|
+
}, {
|
|
156
|
+
params: {
|
|
157
|
+
event: Record<string, unknown>;
|
|
49
158
|
onlyIfArmed: boolean;
|
|
50
159
|
};
|
|
51
|
-
|
|
160
|
+
command: "alarm.set-trigger";
|
|
161
|
+
}>;
|
|
162
|
+
export type SetTriggerCommand = z.infer<typeof sSetTriggerCommand>;
|
|
52
163
|
export type AlarmCommand = ArmCommand | DisarmCommand | ArmAllCommand | DisarmAllCommand | AcknowledgeCommand | SetTriggerCommand | BypassCommand | UnbypassCommand;
|
|
164
|
+
export declare const alarmCommandSchemas: {
|
|
165
|
+
readonly 'alarm.arm': z.ZodObject<{
|
|
166
|
+
command: z.ZodLiteral<"alarm.arm">;
|
|
167
|
+
params: z.ZodObject<{
|
|
168
|
+
deviceId: z.ZodString;
|
|
169
|
+
}, "strip", z.ZodTypeAny, {
|
|
170
|
+
deviceId: string;
|
|
171
|
+
}, {
|
|
172
|
+
deviceId: string;
|
|
173
|
+
}>;
|
|
174
|
+
}, "strip", z.ZodTypeAny, {
|
|
175
|
+
params: {
|
|
176
|
+
deviceId: string;
|
|
177
|
+
};
|
|
178
|
+
command: "alarm.arm";
|
|
179
|
+
}, {
|
|
180
|
+
params: {
|
|
181
|
+
deviceId: string;
|
|
182
|
+
};
|
|
183
|
+
command: "alarm.arm";
|
|
184
|
+
}>;
|
|
185
|
+
readonly 'alarm.disarm': z.ZodObject<{
|
|
186
|
+
command: z.ZodLiteral<"alarm.disarm">;
|
|
187
|
+
params: z.ZodObject<{
|
|
188
|
+
deviceId: z.ZodString;
|
|
189
|
+
duration: z.ZodOptional<z.ZodNumber>;
|
|
190
|
+
}, "strip", z.ZodTypeAny, {
|
|
191
|
+
deviceId: string;
|
|
192
|
+
duration?: number | undefined;
|
|
193
|
+
}, {
|
|
194
|
+
deviceId: string;
|
|
195
|
+
duration?: number | undefined;
|
|
196
|
+
}>;
|
|
197
|
+
}, "strip", z.ZodTypeAny, {
|
|
198
|
+
params: {
|
|
199
|
+
deviceId: string;
|
|
200
|
+
duration?: number | undefined;
|
|
201
|
+
};
|
|
202
|
+
command: "alarm.disarm";
|
|
203
|
+
}, {
|
|
204
|
+
params: {
|
|
205
|
+
deviceId: string;
|
|
206
|
+
duration?: number | undefined;
|
|
207
|
+
};
|
|
208
|
+
command: "alarm.disarm";
|
|
209
|
+
}>;
|
|
210
|
+
readonly 'alarm.arm-all': z.ZodObject<{
|
|
211
|
+
command: z.ZodLiteral<"alarm.arm-all">;
|
|
212
|
+
params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
|
|
213
|
+
}, "strip", z.ZodTypeAny, {
|
|
214
|
+
params: {};
|
|
215
|
+
command: "alarm.arm-all";
|
|
216
|
+
}, {
|
|
217
|
+
params: {};
|
|
218
|
+
command: "alarm.arm-all";
|
|
219
|
+
}>;
|
|
220
|
+
readonly 'alarm.disarm-all': z.ZodObject<{
|
|
221
|
+
command: z.ZodLiteral<"alarm.disarm-all">;
|
|
222
|
+
params: z.ZodObject<{
|
|
223
|
+
duration: z.ZodOptional<z.ZodNumber>;
|
|
224
|
+
}, "strip", z.ZodTypeAny, {
|
|
225
|
+
duration?: number | undefined;
|
|
226
|
+
}, {
|
|
227
|
+
duration?: number | undefined;
|
|
228
|
+
}>;
|
|
229
|
+
}, "strip", z.ZodTypeAny, {
|
|
230
|
+
params: {
|
|
231
|
+
duration?: number | undefined;
|
|
232
|
+
};
|
|
233
|
+
command: "alarm.disarm-all";
|
|
234
|
+
}, {
|
|
235
|
+
params: {
|
|
236
|
+
duration?: number | undefined;
|
|
237
|
+
};
|
|
238
|
+
command: "alarm.disarm-all";
|
|
239
|
+
}>;
|
|
240
|
+
readonly 'alarm.acknowledge': z.ZodObject<{
|
|
241
|
+
command: z.ZodLiteral<"alarm.acknowledge">;
|
|
242
|
+
params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
|
|
243
|
+
}, "strip", z.ZodTypeAny, {
|
|
244
|
+
params: {};
|
|
245
|
+
command: "alarm.acknowledge";
|
|
246
|
+
}, {
|
|
247
|
+
params: {};
|
|
248
|
+
command: "alarm.acknowledge";
|
|
249
|
+
}>;
|
|
250
|
+
readonly 'alarm.set-trigger': z.ZodObject<{
|
|
251
|
+
command: z.ZodLiteral<"alarm.set-trigger">;
|
|
252
|
+
params: z.ZodObject<{
|
|
253
|
+
event: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
254
|
+
onlyIfArmed: z.ZodBoolean;
|
|
255
|
+
}, "strip", z.ZodTypeAny, {
|
|
256
|
+
event: Record<string, unknown>;
|
|
257
|
+
onlyIfArmed: boolean;
|
|
258
|
+
}, {
|
|
259
|
+
event: Record<string, unknown>;
|
|
260
|
+
onlyIfArmed: boolean;
|
|
261
|
+
}>;
|
|
262
|
+
}, "strip", z.ZodTypeAny, {
|
|
263
|
+
params: {
|
|
264
|
+
event: Record<string, unknown>;
|
|
265
|
+
onlyIfArmed: boolean;
|
|
266
|
+
};
|
|
267
|
+
command: "alarm.set-trigger";
|
|
268
|
+
}, {
|
|
269
|
+
params: {
|
|
270
|
+
event: Record<string, unknown>;
|
|
271
|
+
onlyIfArmed: boolean;
|
|
272
|
+
};
|
|
273
|
+
command: "alarm.set-trigger";
|
|
274
|
+
}>;
|
|
275
|
+
readonly 'alarm.bypass': z.ZodObject<{
|
|
276
|
+
command: z.ZodLiteral<"alarm.bypass">;
|
|
277
|
+
params: z.ZodObject<{
|
|
278
|
+
deviceId: z.ZodString;
|
|
279
|
+
}, "strip", z.ZodTypeAny, {
|
|
280
|
+
deviceId: string;
|
|
281
|
+
}, {
|
|
282
|
+
deviceId: string;
|
|
283
|
+
}>;
|
|
284
|
+
}, "strip", z.ZodTypeAny, {
|
|
285
|
+
params: {
|
|
286
|
+
deviceId: string;
|
|
287
|
+
};
|
|
288
|
+
command: "alarm.bypass";
|
|
289
|
+
}, {
|
|
290
|
+
params: {
|
|
291
|
+
deviceId: string;
|
|
292
|
+
};
|
|
293
|
+
command: "alarm.bypass";
|
|
294
|
+
}>;
|
|
295
|
+
readonly 'alarm.unbypass': z.ZodObject<{
|
|
296
|
+
command: z.ZodLiteral<"alarm.unbypass">;
|
|
297
|
+
params: z.ZodObject<{
|
|
298
|
+
deviceId: z.ZodString;
|
|
299
|
+
}, "strip", z.ZodTypeAny, {
|
|
300
|
+
deviceId: string;
|
|
301
|
+
}, {
|
|
302
|
+
deviceId: string;
|
|
303
|
+
}>;
|
|
304
|
+
}, "strip", z.ZodTypeAny, {
|
|
305
|
+
params: {
|
|
306
|
+
deviceId: string;
|
|
307
|
+
};
|
|
308
|
+
command: "alarm.unbypass";
|
|
309
|
+
}, {
|
|
310
|
+
params: {
|
|
311
|
+
deviceId: string;
|
|
312
|
+
};
|
|
313
|
+
command: "alarm.unbypass";
|
|
314
|
+
}>;
|
|
315
|
+
};
|
|
53
316
|
export type AlarmStateDto = {
|
|
54
317
|
activeAlarmId: string | null;
|
|
55
318
|
triggeredOn: number | null;
|
|
@@ -75,13 +338,13 @@ export declare const sAlarmAcknowledgedEvent: z.ZodObject<{
|
|
|
75
338
|
}, "strip", z.ZodTypeAny, {
|
|
76
339
|
kind: "alarm-acknowledged";
|
|
77
340
|
alarmId: string;
|
|
78
|
-
personId?: string | undefined;
|
|
79
341
|
userId?: string | undefined;
|
|
342
|
+
personId?: string | undefined;
|
|
80
343
|
}, {
|
|
81
344
|
kind: "alarm-acknowledged";
|
|
82
345
|
alarmId: string;
|
|
83
|
-
personId?: string | undefined;
|
|
84
346
|
userId?: string | undefined;
|
|
347
|
+
personId?: string | undefined;
|
|
85
348
|
}>;
|
|
86
349
|
export declare const sAlarmArmedAllEvent: z.ZodObject<{
|
|
87
350
|
kind: z.ZodLiteral<"alarm-armed-all">;
|
|
@@ -89,12 +352,12 @@ export declare const sAlarmArmedAllEvent: z.ZodObject<{
|
|
|
89
352
|
personId: z.ZodOptional<z.ZodString>;
|
|
90
353
|
}, "strip", z.ZodTypeAny, {
|
|
91
354
|
kind: "alarm-armed-all";
|
|
92
|
-
personId?: string | undefined;
|
|
93
355
|
userId?: string | undefined;
|
|
356
|
+
personId?: string | undefined;
|
|
94
357
|
}, {
|
|
95
358
|
kind: "alarm-armed-all";
|
|
96
|
-
personId?: string | undefined;
|
|
97
359
|
userId?: string | undefined;
|
|
360
|
+
personId?: string | undefined;
|
|
98
361
|
}>;
|
|
99
362
|
export declare const sAlarmDisarmedAllEvent: z.ZodObject<{
|
|
100
363
|
kind: z.ZodLiteral<"alarm-disarmed-all">;
|
|
@@ -102,12 +365,12 @@ export declare const sAlarmDisarmedAllEvent: z.ZodObject<{
|
|
|
102
365
|
personId: z.ZodOptional<z.ZodString>;
|
|
103
366
|
}, "strip", z.ZodTypeAny, {
|
|
104
367
|
kind: "alarm-disarmed-all";
|
|
105
|
-
personId?: string | undefined;
|
|
106
368
|
userId?: string | undefined;
|
|
369
|
+
personId?: string | undefined;
|
|
107
370
|
}, {
|
|
108
371
|
kind: "alarm-disarmed-all";
|
|
109
|
-
personId?: string | undefined;
|
|
110
372
|
userId?: string | undefined;
|
|
373
|
+
personId?: string | undefined;
|
|
111
374
|
}>;
|
|
112
375
|
export declare const sAlarmArmedEvent: z.ZodObject<{
|
|
113
376
|
kind: z.ZodLiteral<"alarm-armed">;
|
|
@@ -117,13 +380,13 @@ export declare const sAlarmArmedEvent: z.ZodObject<{
|
|
|
117
380
|
}, "strip", z.ZodTypeAny, {
|
|
118
381
|
kind: "alarm-armed";
|
|
119
382
|
subjects: string[];
|
|
120
|
-
personId?: string | undefined;
|
|
121
383
|
userId?: string | undefined;
|
|
384
|
+
personId?: string | undefined;
|
|
122
385
|
}, {
|
|
123
386
|
kind: "alarm-armed";
|
|
124
387
|
subjects: string[];
|
|
125
|
-
personId?: string | undefined;
|
|
126
388
|
userId?: string | undefined;
|
|
389
|
+
personId?: string | undefined;
|
|
127
390
|
}>;
|
|
128
391
|
export declare const sAlarmDisarmedEvent: z.ZodObject<{
|
|
129
392
|
kind: z.ZodLiteral<"alarm-disarmed">;
|
|
@@ -133,13 +396,13 @@ export declare const sAlarmDisarmedEvent: z.ZodObject<{
|
|
|
133
396
|
}, "strip", z.ZodTypeAny, {
|
|
134
397
|
kind: "alarm-disarmed";
|
|
135
398
|
subjects: string[];
|
|
136
|
-
personId?: string | undefined;
|
|
137
399
|
userId?: string | undefined;
|
|
400
|
+
personId?: string | undefined;
|
|
138
401
|
}, {
|
|
139
402
|
kind: "alarm-disarmed";
|
|
140
403
|
subjects: string[];
|
|
141
|
-
personId?: string | undefined;
|
|
142
404
|
userId?: string | undefined;
|
|
405
|
+
personId?: string | undefined;
|
|
143
406
|
}>;
|
|
144
407
|
export declare const sAlarmArmReleasedEvent: z.ZodObject<{
|
|
145
408
|
kind: z.ZodLiteral<"alarm-arm-released">;
|
|
@@ -147,12 +410,12 @@ export declare const sAlarmArmReleasedEvent: z.ZodObject<{
|
|
|
147
410
|
personId: z.ZodOptional<z.ZodString>;
|
|
148
411
|
}, "strip", z.ZodTypeAny, {
|
|
149
412
|
kind: "alarm-arm-released";
|
|
150
|
-
personId?: string | undefined;
|
|
151
413
|
userId?: string | undefined;
|
|
414
|
+
personId?: string | undefined;
|
|
152
415
|
}, {
|
|
153
416
|
kind: "alarm-arm-released";
|
|
154
|
-
personId?: string | undefined;
|
|
155
417
|
userId?: string | undefined;
|
|
418
|
+
personId?: string | undefined;
|
|
156
419
|
}>;
|
|
157
420
|
export declare const sAlarmRearmedEvent: z.ZodObject<{
|
|
158
421
|
kind: z.ZodLiteral<"alarm-rearmed">;
|
|
@@ -180,13 +443,13 @@ export declare const alarmEventSchemasByKind: {
|
|
|
180
443
|
}, "strip", z.ZodTypeAny, {
|
|
181
444
|
kind: "alarm-acknowledged";
|
|
182
445
|
alarmId: string;
|
|
183
|
-
personId?: string | undefined;
|
|
184
446
|
userId?: string | undefined;
|
|
447
|
+
personId?: string | undefined;
|
|
185
448
|
}, {
|
|
186
449
|
kind: "alarm-acknowledged";
|
|
187
450
|
alarmId: string;
|
|
188
|
-
personId?: string | undefined;
|
|
189
451
|
userId?: string | undefined;
|
|
452
|
+
personId?: string | undefined;
|
|
190
453
|
}>;
|
|
191
454
|
readonly 'alarm-armed-all': z.ZodObject<{
|
|
192
455
|
kind: z.ZodLiteral<"alarm-armed-all">;
|
|
@@ -194,12 +457,12 @@ export declare const alarmEventSchemasByKind: {
|
|
|
194
457
|
personId: z.ZodOptional<z.ZodString>;
|
|
195
458
|
}, "strip", z.ZodTypeAny, {
|
|
196
459
|
kind: "alarm-armed-all";
|
|
197
|
-
personId?: string | undefined;
|
|
198
460
|
userId?: string | undefined;
|
|
461
|
+
personId?: string | undefined;
|
|
199
462
|
}, {
|
|
200
463
|
kind: "alarm-armed-all";
|
|
201
|
-
personId?: string | undefined;
|
|
202
464
|
userId?: string | undefined;
|
|
465
|
+
personId?: string | undefined;
|
|
203
466
|
}>;
|
|
204
467
|
readonly 'alarm-disarmed-all': z.ZodObject<{
|
|
205
468
|
kind: z.ZodLiteral<"alarm-disarmed-all">;
|
|
@@ -207,12 +470,12 @@ export declare const alarmEventSchemasByKind: {
|
|
|
207
470
|
personId: z.ZodOptional<z.ZodString>;
|
|
208
471
|
}, "strip", z.ZodTypeAny, {
|
|
209
472
|
kind: "alarm-disarmed-all";
|
|
210
|
-
personId?: string | undefined;
|
|
211
473
|
userId?: string | undefined;
|
|
474
|
+
personId?: string | undefined;
|
|
212
475
|
}, {
|
|
213
476
|
kind: "alarm-disarmed-all";
|
|
214
|
-
personId?: string | undefined;
|
|
215
477
|
userId?: string | undefined;
|
|
478
|
+
personId?: string | undefined;
|
|
216
479
|
}>;
|
|
217
480
|
readonly 'alarm-armed': z.ZodObject<{
|
|
218
481
|
kind: z.ZodLiteral<"alarm-armed">;
|
|
@@ -222,13 +485,13 @@ export declare const alarmEventSchemasByKind: {
|
|
|
222
485
|
}, "strip", z.ZodTypeAny, {
|
|
223
486
|
kind: "alarm-armed";
|
|
224
487
|
subjects: string[];
|
|
225
|
-
personId?: string | undefined;
|
|
226
488
|
userId?: string | undefined;
|
|
489
|
+
personId?: string | undefined;
|
|
227
490
|
}, {
|
|
228
491
|
kind: "alarm-armed";
|
|
229
492
|
subjects: string[];
|
|
230
|
-
personId?: string | undefined;
|
|
231
493
|
userId?: string | undefined;
|
|
494
|
+
personId?: string | undefined;
|
|
232
495
|
}>;
|
|
233
496
|
readonly 'alarm-disarmed': z.ZodObject<{
|
|
234
497
|
kind: z.ZodLiteral<"alarm-disarmed">;
|
|
@@ -238,13 +501,13 @@ export declare const alarmEventSchemasByKind: {
|
|
|
238
501
|
}, "strip", z.ZodTypeAny, {
|
|
239
502
|
kind: "alarm-disarmed";
|
|
240
503
|
subjects: string[];
|
|
241
|
-
personId?: string | undefined;
|
|
242
504
|
userId?: string | undefined;
|
|
505
|
+
personId?: string | undefined;
|
|
243
506
|
}, {
|
|
244
507
|
kind: "alarm-disarmed";
|
|
245
508
|
subjects: string[];
|
|
246
|
-
personId?: string | undefined;
|
|
247
509
|
userId?: string | undefined;
|
|
510
|
+
personId?: string | undefined;
|
|
248
511
|
}>;
|
|
249
512
|
readonly 'alarm-arm-released': z.ZodObject<{
|
|
250
513
|
kind: z.ZodLiteral<"alarm-arm-released">;
|
|
@@ -252,12 +515,12 @@ export declare const alarmEventSchemasByKind: {
|
|
|
252
515
|
personId: z.ZodOptional<z.ZodString>;
|
|
253
516
|
}, "strip", z.ZodTypeAny, {
|
|
254
517
|
kind: "alarm-arm-released";
|
|
255
|
-
personId?: string | undefined;
|
|
256
518
|
userId?: string | undefined;
|
|
519
|
+
personId?: string | undefined;
|
|
257
520
|
}, {
|
|
258
521
|
kind: "alarm-arm-released";
|
|
259
|
-
personId?: string | undefined;
|
|
260
522
|
userId?: string | undefined;
|
|
523
|
+
personId?: string | undefined;
|
|
261
524
|
}>;
|
|
262
525
|
readonly 'alarm-rearmed': z.ZodObject<{
|
|
263
526
|
kind: z.ZodLiteral<"alarm-rearmed">;
|
package/dist/device/alarm.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.alarmEventSchemasByKind = exports.sAlarmRearmedEvent = exports.sAlarmArmReleasedEvent = exports.sAlarmDisarmedEvent = exports.sAlarmArmedEvent = exports.sAlarmDisarmedAllEvent = exports.sAlarmArmedAllEvent = exports.sAlarmAcknowledgedEvent = exports.sAlarmTriggeredEvent = exports.sAlarmSpecs = exports.ALARM = void 0;
|
|
3
|
+
exports.alarmEventSchemasByKind = exports.sAlarmRearmedEvent = exports.sAlarmArmReleasedEvent = exports.sAlarmDisarmedEvent = exports.sAlarmArmedEvent = exports.sAlarmDisarmedAllEvent = exports.sAlarmArmedAllEvent = exports.sAlarmAcknowledgedEvent = exports.sAlarmTriggeredEvent = exports.alarmCommandSchemas = exports.sSetTriggerCommand = exports.sAcknowledgeCommand = exports.sDisarmAllCommand = exports.sArmAllCommand = exports.sUnbypassCommand = exports.sBypassCommand = exports.sDisarmCommand = exports.sArmCommand = exports.sAlarmSpecs = exports.ALARM = void 0;
|
|
4
|
+
const primitives_1 = require("../primitives");
|
|
4
5
|
const zod_1 = require("zod");
|
|
5
6
|
/*
|
|
6
7
|
- only one alarm is active at the same time. If a new alarm-causing event takes place, the already existing alarm will be amended with the new event rather than creating a new alarm
|
|
@@ -13,6 +14,63 @@ const zod_1 = require("zod");
|
|
|
13
14
|
exports.ALARM = 'alarm';
|
|
14
15
|
// SPECS
|
|
15
16
|
exports.sAlarmSpecs = zod_1.z.object({});
|
|
17
|
+
// COMMANDS
|
|
18
|
+
exports.sArmCommand = zod_1.z.object({
|
|
19
|
+
command: zod_1.z.literal('alarm.arm'),
|
|
20
|
+
params: zod_1.z.object({
|
|
21
|
+
deviceId: primitives_1.sDeviceId,
|
|
22
|
+
}),
|
|
23
|
+
});
|
|
24
|
+
exports.sDisarmCommand = zod_1.z.object({
|
|
25
|
+
command: zod_1.z.literal('alarm.disarm'),
|
|
26
|
+
params: zod_1.z.object({
|
|
27
|
+
deviceId: primitives_1.sDeviceId,
|
|
28
|
+
duration: primitives_1.sDuration.optional().describe('Duration in milliseconds'),
|
|
29
|
+
}),
|
|
30
|
+
});
|
|
31
|
+
exports.sBypassCommand = zod_1.z.object({
|
|
32
|
+
command: zod_1.z.literal('alarm.bypass'),
|
|
33
|
+
params: zod_1.z.object({
|
|
34
|
+
deviceId: primitives_1.sDeviceId,
|
|
35
|
+
}),
|
|
36
|
+
});
|
|
37
|
+
exports.sUnbypassCommand = zod_1.z.object({
|
|
38
|
+
command: zod_1.z.literal('alarm.unbypass'),
|
|
39
|
+
params: zod_1.z.object({
|
|
40
|
+
deviceId: primitives_1.sDeviceId,
|
|
41
|
+
}),
|
|
42
|
+
});
|
|
43
|
+
exports.sArmAllCommand = zod_1.z.object({
|
|
44
|
+
command: zod_1.z.literal('alarm.arm-all'),
|
|
45
|
+
params: zod_1.z.object({}),
|
|
46
|
+
});
|
|
47
|
+
exports.sDisarmAllCommand = zod_1.z.object({
|
|
48
|
+
command: zod_1.z.literal('alarm.disarm-all'),
|
|
49
|
+
params: zod_1.z.object({
|
|
50
|
+
duration: primitives_1.sDuration.optional().describe('Duration in milliseconds'),
|
|
51
|
+
}),
|
|
52
|
+
});
|
|
53
|
+
exports.sAcknowledgeCommand = zod_1.z.object({
|
|
54
|
+
command: zod_1.z.literal('alarm.acknowledge'),
|
|
55
|
+
params: zod_1.z.object({}),
|
|
56
|
+
});
|
|
57
|
+
exports.sSetTriggerCommand = zod_1.z.object({
|
|
58
|
+
command: zod_1.z.literal('alarm.set-trigger'),
|
|
59
|
+
params: zod_1.z.object({
|
|
60
|
+
event: primitives_1.sDeviceEvent,
|
|
61
|
+
onlyIfArmed: zod_1.z.boolean().describe('Set only if the device is armed'),
|
|
62
|
+
}),
|
|
63
|
+
});
|
|
64
|
+
exports.alarmCommandSchemas = {
|
|
65
|
+
'alarm.arm': exports.sArmCommand,
|
|
66
|
+
'alarm.disarm': exports.sDisarmCommand,
|
|
67
|
+
'alarm.arm-all': exports.sArmAllCommand,
|
|
68
|
+
'alarm.disarm-all': exports.sDisarmAllCommand,
|
|
69
|
+
'alarm.acknowledge': exports.sAcknowledgeCommand,
|
|
70
|
+
'alarm.set-trigger': exports.sSetTriggerCommand,
|
|
71
|
+
'alarm.bypass': exports.sBypassCommand,
|
|
72
|
+
'alarm.unbypass': exports.sUnbypassCommand,
|
|
73
|
+
};
|
|
16
74
|
// EVENTS
|
|
17
75
|
exports.sAlarmTriggeredEvent = zod_1.z.object({
|
|
18
76
|
kind: zod_1.z.literal('alarm-triggered'),
|
|
@@ -82,11 +82,24 @@ export declare const sAnyDeviceSpecs: z.ZodDiscriminatedUnion<"type", [z.ZodObje
|
|
|
82
82
|
} & Record<string, unknown>) | null;
|
|
83
83
|
defaultStreamId: string;
|
|
84
84
|
}>, z.ZodObject<{
|
|
85
|
+
canReportOpenState: z.ZodBoolean;
|
|
86
|
+
canReportLockState: z.ZodBoolean;
|
|
87
|
+
canControlLock: z.ZodBoolean;
|
|
88
|
+
canRelease: z.ZodBoolean;
|
|
89
|
+
} & {
|
|
85
90
|
type: z.ZodLiteral<"door">;
|
|
86
91
|
}, "strip", z.ZodTypeAny, {
|
|
87
92
|
type: "door";
|
|
93
|
+
canReportOpenState: boolean;
|
|
94
|
+
canReportLockState: boolean;
|
|
95
|
+
canControlLock: boolean;
|
|
96
|
+
canRelease: boolean;
|
|
88
97
|
}, {
|
|
89
98
|
type: "door";
|
|
99
|
+
canReportOpenState: boolean;
|
|
100
|
+
canReportLockState: boolean;
|
|
101
|
+
canControlLock: boolean;
|
|
102
|
+
canRelease: boolean;
|
|
90
103
|
}>, z.ZodObject<{
|
|
91
104
|
inputs: z.ZodArray<z.ZodString, "many">;
|
|
92
105
|
outputs: z.ZodArray<z.ZodString, "many">;
|
|
@@ -390,11 +403,24 @@ export declare const sDeviceDto: z.ZodIntersection<z.ZodIntersection<z.ZodDiscri
|
|
|
390
403
|
} & Record<string, unknown>) | null;
|
|
391
404
|
defaultStreamId: string;
|
|
392
405
|
}>, z.ZodObject<{
|
|
406
|
+
canReportOpenState: z.ZodBoolean;
|
|
407
|
+
canReportLockState: z.ZodBoolean;
|
|
408
|
+
canControlLock: z.ZodBoolean;
|
|
409
|
+
canRelease: z.ZodBoolean;
|
|
410
|
+
} & {
|
|
393
411
|
type: z.ZodLiteral<"door">;
|
|
394
412
|
}, "strip", z.ZodTypeAny, {
|
|
395
413
|
type: "door";
|
|
414
|
+
canReportOpenState: boolean;
|
|
415
|
+
canReportLockState: boolean;
|
|
416
|
+
canControlLock: boolean;
|
|
417
|
+
canRelease: boolean;
|
|
396
418
|
}, {
|
|
397
419
|
type: "door";
|
|
420
|
+
canReportOpenState: boolean;
|
|
421
|
+
canReportLockState: boolean;
|
|
422
|
+
canControlLock: boolean;
|
|
423
|
+
canRelease: boolean;
|
|
398
424
|
}>, z.ZodObject<{
|
|
399
425
|
inputs: z.ZodArray<z.ZodString, "many">;
|
|
400
426
|
outputs: z.ZodArray<z.ZodString, "many">;
|
|
@@ -766,11 +792,24 @@ export declare const sCameraDto: z.ZodIntersection<z.ZodIntersection<z.ZodObject
|
|
|
766
792
|
};
|
|
767
793
|
}>>;
|
|
768
794
|
export declare const sDoorDto: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
|
|
795
|
+
canReportOpenState: z.ZodBoolean;
|
|
796
|
+
canReportLockState: z.ZodBoolean;
|
|
797
|
+
canControlLock: z.ZodBoolean;
|
|
798
|
+
canRelease: z.ZodBoolean;
|
|
799
|
+
} & {
|
|
769
800
|
type: z.ZodLiteral<"door">;
|
|
770
801
|
}, "strip", z.ZodTypeAny, {
|
|
771
802
|
type: "door";
|
|
803
|
+
canReportOpenState: boolean;
|
|
804
|
+
canReportLockState: boolean;
|
|
805
|
+
canControlLock: boolean;
|
|
806
|
+
canRelease: boolean;
|
|
772
807
|
}, {
|
|
773
808
|
type: "door";
|
|
809
|
+
canReportOpenState: boolean;
|
|
810
|
+
canReportLockState: boolean;
|
|
811
|
+
canControlLock: boolean;
|
|
812
|
+
canRelease: boolean;
|
|
774
813
|
}>, z.ZodObject<{
|
|
775
814
|
id: z.ZodString;
|
|
776
815
|
presets: z.ZodArray<z.ZodObject<{
|