homebridge-adt-pulse 3.0.0-beta.4 → 3.0.0-beta.5

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.
@@ -1,1472 +0,0 @@
1
- import type { AxiosInstance, AxiosRequestConfig } from 'axios';
2
- import type {
3
- API,
4
- Characteristic,
5
- CharacteristicValue,
6
- DynamicPlatformPlugin,
7
- Logger,
8
- PlatformAccessory,
9
- PlatformConfig,
10
- Service,
11
- } from 'homebridge';
12
- import type { JSDOM } from 'jsdom';
13
- import type { BinaryLike } from 'node:crypto';
14
- import type repl from 'node:repl';
15
- import type { ErrorObject } from 'serialize-error';
16
- import type z from 'zod';
17
-
18
- import type { ADTPulseAccessory } from '@/lib/accessory.js';
19
- import type { ADTPulse } from '@/lib/api.js';
20
- import type { platformConfig } from '@/lib/schema.js';
21
- import type {
22
- PluginDeviceCategory,
23
- PluginDeviceId,
24
- PluginDeviceType,
25
- PluginLogLevel,
26
- PortalDeviceStatus,
27
- PortalPanelArmButtonHref,
28
- PortalPanelArmButtonLoadingText,
29
- PortalPanelArmButtonRelativeUrl,
30
- PortalPanelArmButtonText,
31
- PortalPanelArmStateClean,
32
- PortalPanelArmStateDirty,
33
- PortalPanelArmStateForce,
34
- PortalPanelArmValue,
35
- PortalPanelForceArmButtonHref,
36
- PortalPanelForceArmButtonRelativeUrl,
37
- PortalPanelForceArmResponse,
38
- PortalPanelState,
39
- PortalPanelStatus,
40
- PortalPanelStatusSensorsOpen,
41
- PortalSensorDeviceType,
42
- PortalSensorStatusIcon,
43
- PortalSensorStatusText,
44
- PortalSyncCode,
45
- PortalVersion,
46
- } from '@/types/constant.d.ts';
47
- import type {
48
- ApiResponse,
49
- ApiResponseFail,
50
- AxiosResponseWithRequest,
51
- Config,
52
- ConfigFingerprint,
53
- ConfigPassword,
54
- ConfigSubdomain,
55
- ConfigUsername,
56
- Device,
57
- DeviceId,
58
- Devices,
59
- DoSubmitHandlerRelativeUrl,
60
- DoSubmitHandlers,
61
- DoSubmitHandlerUrlParamsArm,
62
- DoSubmitHandlerUrlParamsArmState,
63
- DoSubmitHandlerUrlParamsHref,
64
- GatewayInformation,
65
- InternalConfig,
66
- NetworkId,
67
- OrbSecurityButtonBase,
68
- OrbSecurityButtonBaseButtonId,
69
- OrbSecurityButtonPendingButtonText,
70
- OrbSecurityButtonReady,
71
- OrbSecurityButtonReadyButtonText,
72
- OrbSecurityButtonReadyLoadingText,
73
- OrbSecurityButtonReadyRelativeUrl,
74
- OrbSecurityButtonReadyUrlParamsArm,
75
- OrbSecurityButtonReadyUrlParamsArmState,
76
- OrbSecurityButtonReadyUrlParamsHref,
77
- OrbSecurityButtons,
78
- PanelInformation,
79
- PanelStatus,
80
- PanelStatusState,
81
- PanelStatusStatus,
82
- PortalVersionContent,
83
- SensorInformationDeviceType,
84
- SensorInformationStatus,
85
- SensorsInformation,
86
- SensorsStatus,
87
- SensorStatusIcon,
88
- SensorStatusStatus,
89
- Sessions,
90
- UUID,
91
- } from '@/types/shared.d.ts';
92
-
93
- /**
94
- * ADT Pulse - Arm disarm handler.
95
- *
96
- * @since 1.0.0
97
- */
98
- export type ADTPulseArmDisarmHandlerRelativeUrl = PortalPanelArmButtonRelativeUrl;
99
-
100
- export type ADTPulseArmDisarmHandlerHref = PortalPanelArmButtonHref;
101
-
102
- export type ADTPulseArmDisarmHandlerArmState = PortalPanelArmStateClean | PortalPanelArmStateDirty;
103
-
104
- export type ADTPulseArmDisarmHandlerArm = PortalPanelArmValue;
105
-
106
- export type ADTPulseArmDisarmHandlerSat = UUID;
107
-
108
- export type ADTPulseArmDisarmHandlerReturnsInfoForceArmRequired = boolean;
109
-
110
- export type ADTPulseArmDisarmHandlerReturnsInfoReadyButtons = (OrbSecurityButtonBase & OrbSecurityButtonReady)[];
111
-
112
- export type ADTPulseArmDisarmHandlerReturnsInfo = {
113
- forceArmRequired: ADTPulseArmDisarmHandlerReturnsInfoForceArmRequired;
114
- readyButtons: ADTPulseArmDisarmHandlerReturnsInfoReadyButtons;
115
- };
116
-
117
- export type ADTPulseArmDisarmHandlerReturns = Promise<ApiResponse<'ARM_DISARM_HANDLER', ADTPulseArmDisarmHandlerReturnsInfo>>;
118
-
119
- export type ADTPulseArmDisarmHandlerSessions = Sessions<{
120
- axiosSetArmMode?: AxiosResponseWithRequest<unknown>;
121
- axiosSummary?: AxiosResponseWithRequest<unknown>;
122
- jsdomSummary?: JSDOM;
123
- }>;
124
-
125
- export type ADTPulseArmDisarmHandlerReadyButton = OrbSecurityButtonBase & OrbSecurityButtonReady;
126
-
127
- /**
128
- * ADT Pulse - Constructor.
129
- *
130
- * @since 1.0.0
131
- */
132
- export type ADTPulseConstructorConfig = Config;
133
-
134
- export type ADTPulseConstructorInternalConfig = InternalConfig;
135
-
136
- /**
137
- * ADT Pulse - Credentials.
138
- *
139
- * @since 1.0.0
140
- */
141
- export type ADTPulseCredentialsFingerprint = ConfigFingerprint;
142
-
143
- export type ADTPulseCredentialsPassword = ConfigPassword;
144
-
145
- export type ADTPulseCredentialsSubdomain = ConfigSubdomain;
146
-
147
- export type ADTPulseCredentialsUsername = ConfigUsername;
148
-
149
- export type ADTPulseCredentials = {
150
- fingerprint: ADTPulseCredentialsFingerprint;
151
- password: ADTPulseCredentialsPassword;
152
- subdomain: ADTPulseCredentialsSubdomain;
153
- username: ADTPulseCredentialsUsername;
154
- };
155
-
156
- /**
157
- * ADT Pulse - Force arm handler.
158
- *
159
- * @since 1.0.0
160
- */
161
- export type ADTPulseForceArmHandlerResponse = AxiosResponseWithRequest<unknown>;
162
-
163
- export type ADTPulseForceArmHandlerRelativeUrl = PortalPanelArmButtonRelativeUrl;
164
-
165
- export type ADTPulseForceArmHandlerReturnsInfoForceArmRequired = boolean;
166
-
167
- export type ADTPulseForceArmHandlerReturnsInfo = {
168
- forceArmRequired: ADTPulseForceArmHandlerReturnsInfoForceArmRequired;
169
- };
170
-
171
- export type ADTPulseForceArmHandlerReturns = Promise<ApiResponse<'FORCE_ARM_HANDLER', ADTPulseForceArmHandlerReturnsInfo>>;
172
-
173
- export type ADTPulseForceArmHandlerSessions = Sessions<{
174
- axiosForceArm?: AxiosResponseWithRequest<unknown>;
175
- jsdomArmDisarm?: JSDOM;
176
- }>;
177
-
178
- export type ADTPulseForceArmHandlerSessionsAxiosForceArm = PortalPanelForceArmResponse;
179
-
180
- export type ADTPulseForceArmHandlerTrackerComplete = boolean;
181
-
182
- export type ADTPulseForceArmHandlerTrackerErrorMessage = string | null;
183
-
184
- export type ADTPulseForceArmHandlerTrackerRequestUrl = string | null;
185
-
186
- export type ADTPulseForceArmHandlerTracker = {
187
- complete: ADTPulseForceArmHandlerTrackerComplete;
188
- errorMessage: ADTPulseForceArmHandlerTrackerErrorMessage;
189
- requestUrl: ADTPulseForceArmHandlerTrackerRequestUrl;
190
- };
191
-
192
- /**
193
- * ADT Pulse - Get gateway information.
194
- *
195
- * @since 1.0.0
196
- */
197
- export type ADTPulseGetGatewayInformationReturnsInfo = GatewayInformation;
198
-
199
- export type ADTPulseGetGatewayInformationReturns = Promise<ApiResponse<'GET_GATEWAY_INFORMATION', ADTPulseGetGatewayInformationReturnsInfo>>;
200
-
201
- export type ADTPulseGetGatewayInformationSessions = Sessions<{
202
- axiosSystemGateway?: AxiosResponseWithRequest<unknown>;
203
- jsdomSystemGateway?: JSDOM;
204
- }>;
205
-
206
- export type ADTPulseGetGatewayInformationReturnsStatus = PortalDeviceStatus | null;
207
-
208
- /**
209
- * ADT Pulse - Get panel information.
210
- *
211
- * @since 1.0.0
212
- */
213
- export type ADTPulseGetPanelInformationReturnsInfo = PanelInformation;
214
-
215
- export type ADTPulseGetPanelInformationReturns = Promise<ApiResponse<'GET_PANEL_INFORMATION', ADTPulseGetPanelInformationReturnsInfo>>;
216
-
217
- export type ADTPulseGetPanelInformationSessions = Sessions<{
218
- axiosSystemDeviceId1?: AxiosResponseWithRequest<unknown>;
219
- jsdomSystemDeviceId1?: JSDOM;
220
- }>;
221
-
222
- export type ADTPulseGetPanelInformationReturnsStatus = PortalDeviceStatus | null;
223
-
224
- /**
225
- * ADT Pulse - Get panel status.
226
- *
227
- * @since 1.0.0
228
- */
229
- export type ADTPulseGetPanelStatusReturnsInfo = PanelStatus;
230
-
231
- export type ADTPulseGetPanelStatusReturns = Promise<ApiResponse<'GET_PANEL_STATUS', ADTPulseGetPanelStatusReturnsInfo>>;
232
-
233
- export type ADTPulseGetPanelStatusSessions = Sessions<{
234
- axiosSummary?: AxiosResponseWithRequest<unknown>;
235
- jsdomSummary?: JSDOM;
236
- }>;
237
-
238
- /**
239
- * ADT Pulse - Get request config.
240
- *
241
- * @since 1.0.0
242
- */
243
- export type ADTPulseGetRequestConfigExtraConfig = AxiosRequestConfig;
244
-
245
- export type ADTPulseGetRequestConfigReturns = AxiosRequestConfig;
246
-
247
- export type ADTPulseGetRequestConfigDefaultConfig = AxiosRequestConfig;
248
-
249
- /**
250
- * ADT Pulse - Get sensors information.
251
- *
252
- * @since 1.0.0
253
- */
254
- export type ADTPulseGetSensorsInformationReturnsInfoSensors = SensorsInformation;
255
-
256
- export type ADTPulseGetSensorsInformationReturnsInfo = {
257
- sensors: ADTPulseGetSensorsInformationReturnsInfoSensors;
258
- };
259
-
260
- export type ADTPulseGetSensorsInformationReturns = Promise<ApiResponse<'GET_SENSORS_INFORMATION', ADTPulseGetSensorsInformationReturnsInfo>>;
261
-
262
- export type ADTPulseGetSensorsInformationSessions = Sessions<{
263
- axiosSystem?: AxiosResponseWithRequest<unknown>;
264
- jsdomSystem?: JSDOM;
265
- }>;
266
-
267
- /**
268
- * ADT Pulse - Get sensors status.
269
- *
270
- * @since 1.0.0
271
- */
272
- export type ADTPulseGetSensorsStatusReturnsInfoSensors = SensorsStatus;
273
-
274
- export type ADTPulseGetSensorsStatusReturnsInfo = {
275
- sensors: ADTPulseGetSensorsStatusReturnsInfoSensors;
276
- };
277
-
278
- export type ADTPulseGetSensorsStatusReturns = Promise<ApiResponse<'GET_SENSORS_STATUS', ADTPulseGetSensorsStatusReturnsInfo>>;
279
-
280
- export type ADTPulseGetSensorsStatusSessions = Sessions<{
281
- axiosSummary?: AxiosResponseWithRequest<unknown>;
282
- jsdomSummary?: JSDOM;
283
- }>;
284
-
285
- /**
286
- * ADT Pulse - Handle login failure.
287
- *
288
- * @since 1.0.0
289
- */
290
- export type ADTPulseHandleLoginFailureRequestPath = string | null;
291
-
292
- export type ADTPulseHandleLoginFailureSession = AxiosResponseWithRequest<unknown> | undefined;
293
-
294
- export type ADTPulseHandleLoginFailureReturns = void;
295
-
296
- /**
297
- * ADT Pulse - Internal.
298
- *
299
- * @since 1.0.0
300
- */
301
- export type ADTPulseInternalBaseUrl = `https://${string}`;
302
-
303
- export type ADTPulseInternalDebug = boolean;
304
-
305
- export type ADTPulseInternalLogger = Logger | null;
306
-
307
- export type ADTPulseInternalReportedHash = string;
308
-
309
- export type ADTPulseInternalReportedHashes = ADTPulseInternalReportedHash[];
310
-
311
- export type ADTPulseInternalTestModeEnabled = boolean;
312
-
313
- export type ADTPulseInternalTestModeIsDisarmChecked = boolean;
314
-
315
- export type ADTPulseInternalTestMode = {
316
- enabled: ADTPulseInternalTestModeEnabled;
317
- isDisarmChecked: ADTPulseInternalTestModeIsDisarmChecked;
318
- };
319
-
320
- export type ADTPulseInternal = {
321
- baseUrl: ADTPulseInternalBaseUrl;
322
- debug: ADTPulseInternalDebug;
323
- logger: ADTPulseInternalLogger;
324
- reportedHashes: ADTPulseInternalReportedHashes,
325
- testMode: ADTPulseInternalTestMode;
326
- };
327
-
328
- /**
329
- * ADT Pulse - Is authenticated.
330
- *
331
- * @since 1.0.0
332
- */
333
- export type ADTPulseIsAuthenticatedReturns = boolean;
334
-
335
- /**
336
- * ADT Pulse - Is portal accessible.
337
- *
338
- * @since 1.0.0
339
- */
340
- export type ADTPulseIsPortalAccessibleReturnsInfo = null;
341
-
342
- export type ADTPulseIsPortalAccessibleReturns = Promise<ApiResponse<'IS_PORTAL_ACCESSIBLE', ADTPulseIsPortalAccessibleReturnsInfo>>;
343
-
344
- /**
345
- * ADT Pulse - Login.
346
- *
347
- * @since 1.0.0
348
- */
349
- export type ADTPulseLoginReturnsInfoBackupSatCode = UUID | null;
350
-
351
- export type ADTPulseLoginReturnsInfoNetworkId = NetworkId | null;
352
-
353
- export type ADTPulseLoginReturnsInfoPortalVersion = PortalVersion | null;
354
-
355
- export type ADTPulseLoginReturnsInfo = {
356
- backupSatCode: ADTPulseLoginReturnsInfoBackupSatCode;
357
- networkId: ADTPulseLoginReturnsInfoNetworkId;
358
- portalVersion: ADTPulseLoginReturnsInfoPortalVersion;
359
- };
360
-
361
- export type ADTPulseLoginReturns = Promise<ApiResponse<'LOGIN', ADTPulseLoginReturnsInfo>>;
362
-
363
- export type ADTPulseLoginSessions = Sessions<{
364
- axiosIndex?: AxiosResponseWithRequest<unknown>;
365
- axiosSignin?: AxiosResponseWithRequest<unknown>;
366
- }>;
367
-
368
- export type ADTPulseLoginPortalVersion = PortalVersion;
369
-
370
- /**
371
- * ADT Pulse - Logout.
372
- *
373
- * @since 1.0.0
374
- */
375
- export type ADTPulseLogoutReturnsInfoBackupSatCode = UUID | null;
376
-
377
- export type ADTPulseLogoutReturnsInfoNetworkId = NetworkId | null;
378
-
379
- export type ADTPulseLogoutReturnsInfoPortalVersion = PortalVersion | null;
380
-
381
- export type ADTPulseLogoutReturnsInfo = {
382
- backupSatCode: ADTPulseLogoutReturnsInfoBackupSatCode;
383
- networkId: ADTPulseLogoutReturnsInfoNetworkId;
384
- portalVersion: ADTPulseLogoutReturnsInfoPortalVersion;
385
- };
386
-
387
- export type ADTPulseLogoutReturns = Promise<ApiResponse<'LOGOUT', ADTPulseLogoutReturnsInfo>>;
388
-
389
- export type ADTPulseLogoutSessions = Sessions<{
390
- axiosSignout?: AxiosResponseWithRequest<unknown>;
391
- }>;
392
-
393
- /**
394
- * ADT Pulse - New information dispatcher.
395
- *
396
- * @since 1.0.0
397
- */
398
- export type ADTPulseNewInformationDispatcherType = 'do-submit-handlers' | 'gateway-information' | 'orb-security-buttons' | 'panel-information' | 'panel-status' | 'portal-version' | 'sensors-information' | 'sensors-status';
399
-
400
- export type ADTPulseNewInformationDispatcherData<Type extends ADTPulseNewInformationDispatcherType> =
401
- Type extends 'do-submit-handlers' ? DoSubmitHandlers
402
- : Type extends 'gateway-information' ? GatewayInformation
403
- : Type extends 'orb-security-buttons' ? OrbSecurityButtons
404
- : Type extends 'panel-information' ? PanelInformation
405
- : Type extends 'panel-status' ? PanelStatus
406
- : Type extends 'portal-version' ? PortalVersionContent
407
- : Type extends 'sensors-information' ? SensorsInformation
408
- : Type extends 'sensors-status' ? SensorsStatus
409
- : never;
410
-
411
- export type ADTPulseNewInformationDispatcherReturns = Promise<void>;
412
-
413
- /**
414
- * ADT Pulse - Perform keep alive.
415
- *
416
- * @since 1.0.0
417
- */
418
- export type ADTPulsePerformKeepAliveReturnsInfo = null;
419
-
420
- export type ADTPulsePerformKeepAliveReturns = Promise<ApiResponse<'PERFORM_KEEP_ALIVE', ADTPulsePerformKeepAliveReturnsInfo>>;
421
-
422
- export type ADTPulsePerformKeepAliveSessions = Sessions<{
423
- axiosKeepAlive?: AxiosResponseWithRequest<unknown>;
424
- }>;
425
-
426
- /**
427
- * ADT Pulse - Perform sync check.
428
- *
429
- * @since 1.0.0
430
- */
431
- export type ADTPulsePerformSyncCheckReturnsInfoSyncCode = PortalSyncCode;
432
-
433
- export type ADTPulsePerformSyncCheckReturnsInfo = {
434
- syncCode: ADTPulsePerformSyncCheckReturnsInfoSyncCode;
435
- };
436
-
437
- export type ADTPulsePerformSyncCheckReturns = Promise<ApiResponse<'PERFORM_SYNC_CHECK', ADTPulsePerformSyncCheckReturnsInfo>>;
438
-
439
- export type ADTPulsePerformSyncCheckSessions = Sessions<{
440
- axiosSyncCheck?: AxiosResponseWithRequest<unknown>,
441
- }>;
442
-
443
- /**
444
- * ADT Pulse - Reset session.
445
- *
446
- * @since 1.0.0
447
- */
448
- export type ADTPulseResetSessionReturns = void;
449
-
450
- /**
451
- * ADT Pulse - Session.
452
- *
453
- * @since 1.0.0
454
- */
455
- export type ADTPulseSessionBackupSatCode = UUID | null;
456
-
457
- export type ADTPulseSessionHttpClient = AxiosInstance;
458
-
459
- export type ADTPulseSessionIsAuthenticated = boolean;
460
-
461
- export type ADTPulseSessionIsCleanState = boolean;
462
-
463
- export type ADTPulseSessionNetworkId = NetworkId | null;
464
-
465
- export type ADTPulseSessionPortalVersion = PortalVersion | null;
466
-
467
- export type ADTPulseSession = {
468
- backupSatCode: ADTPulseSessionBackupSatCode,
469
- httpClient: ADTPulseSessionHttpClient;
470
- isAuthenticated: ADTPulseSessionIsAuthenticated;
471
- isCleanState: ADTPulseSessionIsCleanState;
472
- networkId: ADTPulseSessionNetworkId;
473
- portalVersion: ADTPulseSessionPortalVersion;
474
- };
475
-
476
- /**
477
- * ADT Pulse - Set panel status.
478
- *
479
- * @since 1.0.0
480
- */
481
- export type ADTPulseSetPanelStatusArmTo = PortalPanelArmValue;
482
-
483
- export type ADTPulseSetPanelStatusReturnsInfoForceArmRequired = boolean;
484
-
485
- export type ADTPulseSetPanelStatusReturnsInfo = {
486
- forceArmRequired: ADTPulseSetPanelStatusReturnsInfoForceArmRequired;
487
- };
488
-
489
- export type ADTPulseSetPanelStatusReturns = Promise<ApiResponse<'SET_PANEL_STATUS', ADTPulseSetPanelStatusReturnsInfo>>;
490
-
491
- export type ADTPulseSetPanelStatusSessions = Sessions<{
492
- axiosSummary?: AxiosResponseWithRequest<unknown>;
493
- jsdomSummary?: JSDOM;
494
- }>;
495
-
496
- export type ADTPulseSetPanelStatusReadyButton = OrbSecurityButtonBase & OrbSecurityButtonReady;
497
-
498
- /**
499
- * ADT Pulse Accessory - Accessory.
500
- *
501
- * @since 1.0.0
502
- */
503
- export type ADTPulseAccessoryAccessory = PlatformAccessory<Device>;
504
-
505
- /**
506
- * ADT Pulse Accessory - Api.
507
- *
508
- * @private
509
- *
510
- * @since 1.0.0
511
- */
512
- export type ADTPulseAccessoryApi = API;
513
-
514
- /**
515
- * ADT Pulse Accessory - Characteristic.
516
- *
517
- * @since 1.0.0
518
- */
519
- export type ADTPulseAccessoryCharacteristic = typeof Characteristic;
520
-
521
- /**
522
- * ADT Pulse Accessory - Constructor.
523
- *
524
- * @since 1.0.0
525
- */
526
- export type ADTPulseAccessoryConstructorAccessory = PlatformAccessory<Device>;
527
-
528
- export type ADTPulseAccessoryConstructorState = ADTPulsePlatformState;
529
-
530
- export type ADTPulseAccessoryConstructorInstance = ADTPulse;
531
-
532
- export type ADTPulseAccessoryConstructorService = typeof Service;
533
-
534
- export type ADTPulseAccessoryConstructorCharacteristic = typeof Characteristic;
535
-
536
- export type ADTPulseAccessoryConstructorApi = API;
537
-
538
- export type ADTPulseAccessoryConstructorLog = Logger;
539
-
540
- /**
541
- * ADT Pulse Accessory - Get panel status.
542
- *
543
- * @since 1.0.0
544
- */
545
- export type ADTPulseAccessoryGetPanelStatusMode = 'current' | 'target';
546
-
547
- export type ADTPulseAccessoryGetPanelStatusContext = Device;
548
-
549
- export type ADTPulseAccessoryGetPanelStatusReturns = CharacteristicValue;
550
-
551
- /**
552
- * ADT Pulse Accessory - Set panel status.
553
- *
554
- * @since 1.0.0
555
- */
556
- export type ADTPulseAccessorySetPanelStatusArm = CharacteristicValue;
557
-
558
- export type ADTPulseAccessorySetPanelStatusContext = Device;
559
-
560
- export type ADTPulseAccessorySetPanelStatusReturns = Promise<void>;
561
-
562
- /**
563
- * ADT Pulse Accessory - Get sensor status.
564
- *
565
- * @since 1.0.0
566
- */
567
- export type ADTPulseAccessoryGetSensorStatusContext = Device;
568
-
569
- export type ADTPulseAccessoryGetSensorStatusReturns = CharacteristicValue;
570
-
571
- /**
572
- * ADT Pulse Accessory - Instance.
573
- *
574
- * @private
575
- *
576
- * @since 1.0.0
577
- */
578
- export type ADTPulseAccessoryInstance = ADTPulse;
579
-
580
- /**
581
- * ADT Pulse Accessory - Log.
582
- *
583
- * @since 1.0.0
584
- */
585
- export type ADTPulseAccessoryLog = Logger;
586
-
587
- /**
588
- * ADT Pulse Accessory - Services.
589
- *
590
- * @since 1.0.0
591
- */
592
- export type ADTPulseAccessoryServices = {
593
- [key: string]: Service | undefined;
594
- };
595
-
596
- /**
597
- * ADT Pulse Accessory - State.
598
- *
599
- * @since 1.0.0
600
- */
601
- export type ADTPulseAccessoryState = ADTPulsePlatformState;
602
-
603
- /**
604
- * ADT Pulse Platform.
605
- *
606
- * @since 1.0.0
607
- */
608
- export type ADTPulsePlatformPlugin = DynamicPlatformPlugin;
609
-
610
- /**
611
- * ADT Pulse Platform - Accessories.
612
- *
613
- * @since 1.0.0
614
- */
615
- export type ADTPulsePlatformAccessory = PlatformAccessory<Device>;
616
-
617
- export type ADTPulsePlatformAccessories = ADTPulsePlatformAccessory[];
618
-
619
- /**
620
- * ADT Pulse Platform - Add accessory.
621
- *
622
- * @since 1.0.0
623
- */
624
- export type ADTPulsePlatformAddAccessoryDevice = Device;
625
-
626
- export type ADTPulsePlatformAddAccessoryReturns = void;
627
-
628
- export type ADTPulsePlatformAddAccessoryTypedNewAccessory = PlatformAccessory<Device>;
629
-
630
- /**
631
- * ADT Pulse Platform - Api.
632
- *
633
- * @since 1.0.0
634
- */
635
- export type ADTPulsePlatformApi = API;
636
-
637
- /**
638
- * ADT Pulse Platform - Characteristic.
639
- *
640
- * @since 1.0.0
641
- */
642
- export type ADTPulsePlatformCharacteristic = typeof Characteristic;
643
-
644
- /**
645
- * ADT Pulse Platform - Config.
646
- *
647
- * @since 1.0.0
648
- */
649
- export type ADTPulsePlatformConfig = z.infer<typeof platformConfig> | null;
650
-
651
- /**
652
- * ADT Pulse Platform - Configure accessory.
653
- *
654
- * @since 1.0.0
655
- */
656
- export type ADTPulsePlatformConfigureAccessoryAccessory = PlatformAccessory<Device>;
657
-
658
- export type ADTPulsePlatformConfigureAccessoryReturns = void;
659
-
660
- /**
661
- * ADT Pulse Platform - Constants.
662
- *
663
- * @since 1.0.0
664
- */
665
- export type ADTPulsePlatformConstantsTimestampsAdtKeepAlive = number;
666
-
667
- export type ADTPulsePlatformConstantsTimestampsAdtSyncCheck = number;
668
-
669
- export type ADTPulsePlatformConstantsTimestampsSuspendSyncing = number;
670
-
671
- export type ADTPulsePlatformConstantsTimestampsSynchronize = number;
672
-
673
- export type ADTPulsePlatformConstantsTimestamps = {
674
- adtKeepAlive: ADTPulsePlatformConstantsTimestampsAdtKeepAlive;
675
- adtSyncCheck: ADTPulsePlatformConstantsTimestampsAdtSyncCheck;
676
- suspendSyncing: ADTPulsePlatformConstantsTimestampsSuspendSyncing;
677
- synchronize: ADTPulsePlatformConstantsTimestampsSynchronize;
678
- };
679
-
680
- export type ADTPulsePlatformConstantsMaxLoginRetries = number;
681
-
682
- export type ADTPulsePlatformConstants = {
683
- intervalTimestamps: ADTPulsePlatformConstantsTimestamps;
684
- maxLoginRetries: ADTPulsePlatformConstantsMaxLoginRetries;
685
- };
686
-
687
- /**
688
- * ADT Pulse Platform - Constructor.
689
- *
690
- * @since 1.0.0
691
- */
692
- export type ADTPulsePlatformConstructorLog = Logger;
693
-
694
- export type ADTPulsePlatformConstructorConfig = PlatformConfig;
695
-
696
- export type ADTPulsePlatformConstructorApi = API;
697
-
698
- /**
699
- * ADT Pulse Platform - Debug mode.
700
- *
701
- * @since 1.0.0
702
- */
703
- export type ADTPulsePlatformDebugMode = boolean | null;
704
-
705
- /**
706
- * ADT Pulse Platform - Fetch updated information.
707
- *
708
- * @since 1.0.0
709
- */
710
- export type ADTPulsePlatformFetchUpdatedInformationReturns = Promise<void>;
711
-
712
- /**
713
- * ADT Pulse Platform - Handlers.
714
- *
715
- * @since 1.0.0
716
- */
717
- export type ADTPulsePlatformHandlers = {
718
- [key: string]: ADTPulseAccessory;
719
- };
720
-
721
- /**
722
- * ADT Pulse Platform - Instance.
723
- *
724
- * @since 1.0.0
725
- */
726
- export type ADTPulsePlatformInstance = ADTPulse | null;
727
-
728
- /**
729
- * ADT Pulse Platform - Log.
730
- *
731
- * @since 1.0.0
732
- */
733
- export type ADTPulsePlatformLog = Logger;
734
-
735
- /**
736
- * ADT Pulse Platform - Poll accessories.
737
- *
738
- * @since 1.0.0
739
- */
740
- export type ADTPulsePlatformPollAccessoriesDevices = Devices;
741
-
742
- export type ADTPulsePlatformPollAccessoriesReturns = Promise<void>;
743
-
744
- /**
745
- * ADT Pulse Platform - Print system information.
746
- *
747
- * @since 1.0.0
748
- */
749
- export type ADTPulsePlatformPrintSystemInformationReturns = void;
750
-
751
- /**
752
- * ADT Pulse Platform - Remove accessory.
753
- *
754
- * @since 1.0.0
755
- */
756
- export type ADTPulsePlatformRemoveAccessoryAccessory = PlatformAccessory<Device>;
757
-
758
- export type ADTPulsePlatformRemoveAccessoryReturns = void;
759
-
760
- /**
761
- * ADT Pulse Platform - Service.
762
- *
763
- * @since 1.0.0
764
- */
765
- export type ADTPulsePlatformService = typeof Service;
766
-
767
- /**
768
- * ADT Pulse Platform - State.
769
- *
770
- * @since 1.0.0
771
- */
772
- export type ADTPulsePlatformStateActivityIsAdtKeepingAlive = boolean;
773
-
774
- export type ADTPulsePlatformStateActivityIsAdtSyncChecking = boolean;
775
-
776
- export type ADTPulsePlatformStateActivityIsLoggingIn = boolean;
777
-
778
- export type ADTPulsePlatformStateActivityIsSyncing = boolean;
779
-
780
- export type ADTPulsePlatformStateActivity = {
781
- isAdtKeepingAlive: ADTPulsePlatformStateActivityIsAdtKeepingAlive;
782
- isAdtSyncChecking: ADTPulsePlatformStateActivityIsAdtSyncChecking;
783
- isLoggingIn: ADTPulsePlatformStateActivityIsLoggingIn,
784
- isSyncing: ADTPulsePlatformStateActivityIsSyncing;
785
- };
786
-
787
- export type ADTPulsePlatformStateDataGatewayInfo = GatewayInformation | null;
788
-
789
- export type ADTPulsePlatformStateDataPanelInfo = PanelInformation | null;
790
-
791
- export type ADTPulsePlatformStateDataPanelStatus = PanelStatus | null;
792
-
793
- export type ADTPulsePlatformStateDataSensorsInfo = SensorsInformation;
794
-
795
- export type ADTPulsePlatformStateDataSensorsStatus = SensorsStatus;
796
-
797
- export type ADTPulsePlatformStateDataSyncCode = PortalSyncCode;
798
-
799
- export type ADTPulsePlatformStateData = {
800
- gatewayInfo: ADTPulsePlatformStateDataGatewayInfo;
801
- panelInfo: ADTPulsePlatformStateDataPanelInfo;
802
- panelStatus: ADTPulsePlatformStateDataPanelStatus;
803
- sensorsInfo: ADTPulsePlatformStateDataSensorsInfo;
804
- sensorsStatus: ADTPulsePlatformStateDataSensorsStatus;
805
- syncCode: ADTPulsePlatformStateDataSyncCode;
806
- };
807
-
808
- export type ADTPulsePlatformStateEventCountersFailedLogins = number;
809
-
810
- export type ADTPulsePlatformStateEventCounters = {
811
- failedLogins: ADTPulsePlatformStateEventCountersFailedLogins;
812
- };
813
-
814
- export type ADTPulsePlatformStateIntervalsSynchronize = NodeJS.Timeout | undefined;
815
-
816
- export type ADTPulsePlatformStateIntervals = {
817
- synchronize: ADTPulsePlatformStateIntervalsSynchronize;
818
- };
819
-
820
- export type ADTPulsePlatformStateLastRunOnAdtKeepAlive = number;
821
-
822
- export type ADTPulsePlatformStateLastRunOnAdtSyncCheck = number;
823
-
824
- export type ADTPulsePlatformStateLastRunOn = {
825
- adtKeepAlive: ADTPulsePlatformStateLastRunOnAdtKeepAlive;
826
- adtSyncCheck: ADTPulsePlatformStateLastRunOnAdtSyncCheck;
827
- };
828
-
829
- export type ADTPulsePlatformState = {
830
- activity: ADTPulsePlatformStateActivity;
831
- data: ADTPulsePlatformStateData;
832
- eventCounters: ADTPulsePlatformStateEventCounters;
833
- intervals: ADTPulsePlatformStateIntervals;
834
- lastRunOn: ADTPulsePlatformStateLastRunOn;
835
- };
836
-
837
- /**
838
- * ADT Pulse Platform - Synchronize.
839
- *
840
- * @since 1.0.0
841
- */
842
- export type ADTPulsePlatformSynchronizeReturns = void;
843
-
844
- /**
845
- * ADT Pulse Platform - Synchronize keep alive.
846
- *
847
- * @since 1.0.0
848
- */
849
- export type ADTPulsePlatformSynchronizeKeepAliveReturns = void;
850
-
851
- /**
852
- * ADT Pulse Platform - Synchronize sync check.
853
- *
854
- * @since 1.0.0
855
- */
856
- export type ADTPulsePlatformSynchronizeSyncCheckReturns = void;
857
-
858
- /**
859
- * ADT Pulse Platform - Unify devices.
860
- *
861
- * @since 1.0.0
862
- */
863
- export type ADTPulsePlatformUnifyDevicesReturns = Promise<void>;
864
-
865
- export type ADTPulsePlatformUnifyDevicesDevices = Devices;
866
-
867
- export type ADTPulsePlatformUnifyDevicesId = DeviceId;
868
-
869
- /**
870
- * ADT Pulse Platform - Update accessory.
871
- *
872
- * @since 1.0.0
873
- */
874
- export type ADTPulsePlatformUpdateAccessoryDevice = Device;
875
-
876
- export type ADTPulsePlatformUpdateAccessoryReturns = void;
877
-
878
- /**
879
- * ADT Pulse Repl - Api.
880
- *
881
- * @since 1.0.0
882
- */
883
- export type ADTPulseReplApi = ADTPulse | undefined;
884
-
885
- /**
886
- * ADT Pulse Repl - Color log.
887
- *
888
- * @since 1.0.0
889
- */
890
- export type ADTPulseReplColorLogType = Extract<PluginLogLevel, 'error' | 'info'>;
891
-
892
- export type ADTPulseReplColorLogMessage = string;
893
-
894
- export type ADTPulseReplColorLogReturns = void;
895
-
896
- /**
897
- * ADT Pulse Repl - Display help menu.
898
- *
899
- * @since 1.0.0
900
- */
901
- export type ADTPulseDisplayHelpMenuReturns = void;
902
-
903
- /**
904
- * ADT Pulse Repl - Display help header.
905
- *
906
- * @since 1.0.0
907
- */
908
- export type ADTPulseDisplayHelpHeaderReturns = void;
909
-
910
- /**
911
- * ADT Pulse Repl - Display startup header.
912
- *
913
- * @since 1.0.0
914
- */
915
- export type ADTPulseDisplayStartupHeaderReturns = void;
916
-
917
- /**
918
- * ADT Pulse Repl - Repl server.
919
- *
920
- * @since 1.0.0
921
- */
922
- export type ADTPulseReplReplServer = repl.REPLServer | undefined;
923
-
924
- /**
925
- * ADT Pulse Repl - Set instance.
926
- *
927
- * @since 1.0.0
928
- */
929
- export type ADTPulseReplSetInstanceSubdomain = unknown;
930
-
931
- export type ADTPulseReplSetInstanceUsername = unknown;
932
-
933
- export type ADTPulseReplSetInstancePassword = unknown;
934
-
935
- export type ADTPulseReplSetInstanceFingerprint = unknown;
936
-
937
- export type ADTPulseReplSetInstanceReturns = void;
938
-
939
- /**
940
- * ADT Pulse Repl - Start repl.
941
- *
942
- * @since 1.0.0
943
- */
944
- export type ADTPulseReplStartReplReturns = Promise<void>;
945
-
946
- /**
947
- * ADT Pulse Test - Ask question.
948
- *
949
- * @since 1.0.0
950
- */
951
- export type ADTPulseTestAskQuestionMode = 'disclaimer';
952
-
953
- export type ADTPulseTestAskQuestionReturns = Promise<boolean>;
954
-
955
- /**
956
- * ADT Pulse Test - Find config.
957
- *
958
- * @since 1.0.0
959
- */
960
- export type ADTPulseTestFindConfigReturns = boolean;
961
-
962
- export type ADTPulseTestFindConfigPossibleLocation = string;
963
-
964
- export type ADTPulseTestFindConfigPossibleLocations = ADTPulseTestFindConfigPossibleLocation[];
965
-
966
- export type ADTPulseTestFindConfigParsedFile = unknown;
967
-
968
- /**
969
- * ADT Pulse Test - Print test output.
970
- *
971
- * @since 1.0.0
972
- */
973
- export type ADTPulseTestPrintTestOutputIsSuccess = boolean;
974
-
975
- export type ADTPulseTestPrintTestOutputReturns = void;
976
-
977
- /**
978
- * ADT Pulse Test - Selected config location.
979
- *
980
- * @since 1.0.0
981
- */
982
- export type ADTPulseTestSelectedConfigLocation = string | undefined;
983
-
984
- /**
985
- * ADT Pulse Test - Selected platform.
986
- *
987
- * @since 1.0.0
988
- */
989
- export type ADTPulseTestSelectedPlatform = Config | undefined;
990
-
991
- /**
992
- * ADT Pulse Test - Start test.
993
- *
994
- * @since 1.0.0
995
- */
996
- export type ADTPulseTestStartTestReturns = Promise<void>;
997
-
998
- /**
999
- * Clear html line break.
1000
- *
1001
- * @since 1.0.0
1002
- */
1003
- export type ClearHtmlLineBreakData = string;
1004
-
1005
- export type ClearHtmlLineBreakReturns = string;
1006
-
1007
- /**
1008
- * Clear whitespace.
1009
- *
1010
- * @since 1.0.0
1011
- */
1012
- export type ClearWhitespaceData = string;
1013
-
1014
- export type ClearWhitespaceReturns = string;
1015
-
1016
- /**
1017
- * Condense sensor type.
1018
- *
1019
- * @since 1.0.0
1020
- */
1021
- export type CondenseSensorTypeSensorType = PortalSensorDeviceType;
1022
-
1023
- export type CondenseSensorTypeReturns = Exclude<PluginDeviceType, 'gateway' | 'panel'> | undefined;
1024
-
1025
- export type CondenseSensorTypeCondensed = Exclude<PluginDeviceType, 'gateway' | 'panel'> | undefined;
1026
-
1027
- /**
1028
- * Debug log.
1029
- *
1030
- * @since 1.0.0
1031
- */
1032
- export type DebugLogLogger = Logger | null;
1033
-
1034
- export type DebugLogCaller = string;
1035
-
1036
- export type DebugLogType = PluginLogLevel;
1037
-
1038
- export type DebugLogMessage = string;
1039
-
1040
- export type DebugLogReturns = void;
1041
-
1042
- /**
1043
- * Detected do submit handlers.
1044
- *
1045
- * @since 1.0.0
1046
- */
1047
- export type DetectedNewDoSubmitHandlersHandlers = DoSubmitHandlers;
1048
-
1049
- export type DetectedNewDoSubmitHandlersLogger = Logger | null;
1050
-
1051
- export type DetectedNewDoSubmitHandlersDebugMode = boolean | null;
1052
-
1053
- export type DetectedNewDoSubmitHandlersReturns = Promise<boolean>;
1054
-
1055
- export type DetectedNewDoSubmitHandlersKnownRelativeUrls = PortalPanelForceArmButtonRelativeUrl[];
1056
-
1057
- export type DetectedNewDoSubmitHandlersKnownRelativeUrlsVersion = PortalPanelForceArmButtonRelativeUrl;
1058
-
1059
- export type DetectedNewDoSubmitHandlersKnownUrlParamsArm = Exclude<PortalPanelArmValue, 'off'>[];
1060
-
1061
- export type DetectedNewDoSubmitHandlersKnownUrlParamsArmState = PortalPanelArmStateForce[];
1062
-
1063
- export type DetectedNewDoSubmitHandlersKnownUrlParamsHref = PortalPanelForceArmButtonHref[];
1064
-
1065
- /**
1066
- * Detected new gateway information.
1067
- *
1068
- * @since 1.0.0
1069
- */
1070
- export type DetectedNewGatewayInformationDevice = GatewayInformation;
1071
-
1072
- export type DetectedNewGatewayInformationLogger = Logger | null;
1073
-
1074
- export type DetectedNewGatewayInformationDebugMode = boolean | null;
1075
-
1076
- export type DetectedNewGatewayInformationReturns = Promise<boolean>;
1077
-
1078
- export type DetectedNewGatewayInformationKnownStatuses = PortalDeviceStatus[];
1079
-
1080
- /**
1081
- * Detected orb security buttons.
1082
- *
1083
- * @since 1.0.0
1084
- */
1085
- export type DetectedNewOrbSecurityButtonsButtons = OrbSecurityButtons;
1086
-
1087
- export type DetectedNewOrbSecurityButtonsLogger = Logger | null;
1088
-
1089
- export type DetectedNewOrbSecurityButtonsDebugMode = boolean | null;
1090
-
1091
- export type DetectedNewOrbSecurityButtonsReturns = Promise<boolean>;
1092
-
1093
- export type DetectedNewOrbSecurityButtonsKnownButtonText = PortalPanelArmButtonText[];
1094
-
1095
- export type DetectedNewOrbSecurityButtonsKnownLoadingText = PortalPanelArmButtonLoadingText[];
1096
-
1097
- export type DetectedNewOrbSecurityButtonsKnownRelativeUrl = PortalPanelArmButtonRelativeUrl[];
1098
-
1099
- export type DetectedNewOrbSecurityButtonsKnownUrlParamsArm = PortalPanelArmValue[];
1100
-
1101
- export type DetectedNewOrbSecurityButtonsKnownUrlParamsArmState = (PortalPanelArmStateClean | PortalPanelArmStateDirty)[];
1102
-
1103
- export type DetectedNewOrbSecurityButtonsKnownUrlParamsHref = PortalPanelArmButtonHref[];
1104
-
1105
- /**
1106
- * Detected new panel information.
1107
- *
1108
- * @since 1.0.0
1109
- */
1110
- export type DetectedNewPanelInformationDevice = PanelInformation;
1111
-
1112
- export type DetectedNewPanelInformationLogger = Logger | null;
1113
-
1114
- export type DetectedNewPanelInformationDebugMode = boolean | null;
1115
-
1116
- export type DetectedNewPanelInformationReturns = Promise<boolean>;
1117
-
1118
- export type DetectedNewPanelInformationKnownStatuses = PortalDeviceStatus[];
1119
-
1120
- /**
1121
- * Detected new panel status.
1122
- *
1123
- * @since 1.0.0
1124
- */
1125
- export type DetectedNewPanelStatusSummary = PanelStatus;
1126
-
1127
- export type DetectedNewPanelStatusLogger = Logger | null;
1128
-
1129
- export type DetectedNewPanelStatusDebugMode = boolean | null;
1130
-
1131
- export type DetectedNewPanelStatusReturns = Promise<boolean>;
1132
-
1133
- export type DetectedNewPanelStatusKnownStates = PortalPanelState[];
1134
-
1135
- export type DetectedNewPanelStatusKnownStatuses = PortalPanelStatus[];
1136
-
1137
- export type DetectedNewPanelStatusKnownStatusesSensorsOpen = PortalPanelStatusSensorsOpen;
1138
-
1139
- /**
1140
- * Detected new portal version.
1141
- *
1142
- * @since 1.0.0
1143
- */
1144
- export type DetectedNewPortalVersionVersion = PortalVersionContent;
1145
-
1146
- export type DetectedNewPortalVersionLogger = Logger | null;
1147
-
1148
- export type DetectedNewPortalVersionDebugMode = boolean | null;
1149
-
1150
- export type DetectedNewPortalVersionReturns = Promise<boolean>;
1151
-
1152
- export type DetectedNewPortalVersionKnownVersions = PortalVersion[];
1153
-
1154
- /**
1155
- * Detected new sensors' information.
1156
- *
1157
- * @since 1.0.0
1158
- */
1159
- export type DetectedNewSensorsInformationSensors = SensorsInformation;
1160
-
1161
- export type DetectedNewSensorsInformationLogger = Logger | null;
1162
-
1163
- export type DetectedNewSensorsInformationDebugMode = boolean | null;
1164
-
1165
- export type DetectedNewSensorsInformationReturns = Promise<boolean>;
1166
-
1167
- export type DetectedNewSensorsInformationKnownDeviceTypes = PortalSensorDeviceType[];
1168
-
1169
- export type DetectedNewSensorsInformationKnownStatuses = PortalDeviceStatus[];
1170
-
1171
- /**
1172
- * Detected new sensors' status.
1173
- *
1174
- * @since 1.0.0
1175
- */
1176
- export type DetectedNewSensorsStatusSensors = SensorsStatus;
1177
-
1178
- export type DetectedNewSensorsStatusLogger = Logger | null;
1179
-
1180
- export type DetectedNewSensorsStatusDebugMode = boolean | null;
1181
-
1182
- export type DetectedNewSensorsStatusReturns = Promise<boolean>;
1183
-
1184
- export type DetectedNewSensorsStatusKnownIcons = PortalSensorStatusIcon[];
1185
-
1186
- export type DetectedNewSensorsStatusKnownStatuses = PortalSensorStatusText[];
1187
-
1188
- /**
1189
- * Fetch error message.
1190
- *
1191
- * @since 1.0.0
1192
- */
1193
- export type FetchErrorMessageResponse = AxiosResponseWithRequest<unknown> | undefined;
1194
-
1195
- export type FetchErrorMessageReturns = string | null;
1196
-
1197
- /**
1198
- * Fetch missing sat code.
1199
- *
1200
- * @since 1.0.0
1201
- */
1202
- export type FetchMissingSatCodeResponse = AxiosResponseWithRequest<unknown>;
1203
-
1204
- export type FetchMissingSatCodeReturns = UUID | null;
1205
-
1206
- /**
1207
- * Fetch table cells.
1208
- *
1209
- * @since 1.0.0
1210
- */
1211
- export type FetchTableCellsNodeElements = NodeListOf<HTMLTableCellElement>;
1212
-
1213
- export type FetchTableCellsMatchList = string[];
1214
-
1215
- export type FetchTableCellsIncrementFrom = number;
1216
-
1217
- export type FetchTableCellsIncrementTo = number;
1218
-
1219
- export type FetchTableCellsReturns = {
1220
- [key: string]: string[];
1221
- };
1222
-
1223
- export type FetchTableCellsCleaner = (text: string) => string;
1224
-
1225
- export type FetchTableCellsMatched = {
1226
- [key: string]: string[];
1227
- };
1228
-
1229
- /**
1230
- * Find index with value.
1231
- *
1232
- * @since 1.0.0
1233
- */
1234
- export type FindIndexWithValueArray<Value> = Value[];
1235
-
1236
- export type FindIndexWithValueCondition<Value> = (value: Value) => boolean;
1237
-
1238
- export type FindIndexWithValueReturnsIndex = number;
1239
-
1240
- export type FindIndexWithValueReturnsValue<Value> = Value | undefined;
1241
-
1242
- export type FindIndexWithValueReturns<Value> = {
1243
- index: FindIndexWithValueReturnsIndex;
1244
- value: FindIndexWithValueReturnsValue<Value>;
1245
- };
1246
-
1247
- /**
1248
- * Find null keys.
1249
- *
1250
- * @since 1.0.0
1251
- */
1252
- export type FindNullKeysProperties = object;
1253
-
1254
- export type FindNullKeysParentKey = string;
1255
-
1256
- export type FindNullKeysReturns = string[];
1257
-
1258
- export type FindNullKeysFound = string[];
1259
-
1260
- /**
1261
- * Generate device id.
1262
- *
1263
- * @since 1.0.0
1264
- */
1265
- export type GenerateDeviceIdId = number;
1266
-
1267
- export type GenerateDeviceIdReturns = PluginDeviceId;
1268
-
1269
- /**
1270
- * Generate dynatrace pc header value.
1271
- *
1272
- * @since 1.0.0
1273
- */
1274
- export type GenerateDynatracePCHeaderValueMode = 'keep-alive' | 'force-arm';
1275
-
1276
- export type GenerateDynatracePCHeaderValueReturns = string;
1277
-
1278
- /**
1279
- * Generate hash.
1280
- *
1281
- * @since 1.0.0
1282
- */
1283
- export type GenerateHashData = BinaryLike;
1284
-
1285
- export type GenerateHashReturns = string;
1286
-
1287
- /**
1288
- * Get accessory category.
1289
- *
1290
- * @since 1.0.0
1291
- */
1292
- export type GetAccessoryCategoryDeviceCategory = PluginDeviceCategory;
1293
-
1294
- export type GetAccessoryCategoryReturns = number;
1295
-
1296
- /**
1297
- * Get plural form.
1298
- *
1299
- * @since 1.0.0
1300
- */
1301
- export type GetPluralFormCount = number;
1302
-
1303
- export type GetPluralFormSingular = string;
1304
-
1305
- export type GetPluralFormPlural = string;
1306
-
1307
- export type GetPluralFormReturns = string;
1308
-
1309
- /**
1310
- * Initialize.
1311
- *
1312
- * @since 1.0.0
1313
- */
1314
- export type InitializeApi = API;
1315
-
1316
- export type InitializeReturns = void;
1317
-
1318
- /**
1319
- * Is forward slash os.
1320
- *
1321
- * @since 1.0.0
1322
- */
1323
- export type IsForwardSlashOSReturns = boolean;
1324
-
1325
- /**
1326
- * Is portal sync code.
1327
- *
1328
- * @since 1.0.0
1329
- */
1330
- export type IsPortalSyncCodeSyncCode = string;
1331
-
1332
- export type IsPortalSyncCodeVerifiedSyncCode = PortalSyncCode;
1333
-
1334
- /**
1335
- * Parse arm disarm message.
1336
- *
1337
- * @since 1.0.0
1338
- */
1339
- export type ParseArmDisarmMessageElement = Element | null;
1340
-
1341
- export type ParseArmDisarmMessageReturns = string | null;
1342
-
1343
- /**
1344
- * Parse do submit handlers.
1345
- *
1346
- * @since 1.0.0
1347
- */
1348
- export type ParseDoSubmitHandlersElements = NodeListOf<Element>;
1349
-
1350
- export type ParseDoSubmitHandlersReturns = DoSubmitHandlers;
1351
-
1352
- export type ParseDoSubmitHandlersHandlers = DoSubmitHandlers;
1353
-
1354
- export type ParseDoSubmitHandlersRelativeUrl = DoSubmitHandlerRelativeUrl;
1355
-
1356
- export type ParseDoSubmitHandlersUrlParamsHref = DoSubmitHandlerUrlParamsHref;
1357
-
1358
- export type ParseDoSubmitHandlersUrlParamsArmState = Exclude<DoSubmitHandlerUrlParamsArmState, null> | '';
1359
-
1360
- export type ParseDoSubmitHandlersUrlParamsArm = Exclude<DoSubmitHandlerUrlParamsArm, null> | '';
1361
-
1362
- /**
1363
- * Parse orb sensors.
1364
- *
1365
- * @since 1.0.0
1366
- */
1367
- export type ParseOrbSensorsElements = NodeListOf<Element>;
1368
-
1369
- export type ParseOrbSensorsReturns = SensorsStatus;
1370
-
1371
- export type ParseOrbSensorsSensors = SensorsStatus;
1372
-
1373
- export type ParseOrbSensorsCleanedIcon = SensorStatusIcon;
1374
-
1375
- export type ParseOrbSensorsCleanedStatus = SensorStatusStatus;
1376
-
1377
- /**
1378
- * Parse orb text summary.
1379
- *
1380
- * @since 1.0.0
1381
- */
1382
- export type ParseOrbTextSummaryElement = Element | null;
1383
-
1384
- export type ParseOrbTextSummaryReturns = PanelStatus;
1385
-
1386
- export type ParseOrbTextSummaryCurrentState = Exclude<PanelStatusState, null>;
1387
-
1388
- export type ParseOrbTextSummaryCurrentStatus = Exclude<PanelStatusStatus, null> | '';
1389
-
1390
- /**
1391
- * Parse orb security buttons.
1392
- *
1393
- * @since 1.0.0
1394
- */
1395
- export type ParseOrbSecurityButtonsElements = NodeListOf<Element>;
1396
-
1397
- export type ParseOrbSecurityButtonsReturns = OrbSecurityButtons;
1398
-
1399
- export type ParseOrbSecurityButtonsButtons = OrbSecurityButtons;
1400
-
1401
- export type ParseOrbSecurityButtonsButtonId = OrbSecurityButtonBaseButtonId;
1402
-
1403
- export type ParseOrbSecurityButtonsPendingButtonText = OrbSecurityButtonPendingButtonText;
1404
-
1405
- export type ParseOrbSecurityButtonsReadyButtonText = OrbSecurityButtonReadyButtonText;
1406
-
1407
- export type ParseOrbSecurityButtonsRelativeUrl = OrbSecurityButtonReadyRelativeUrl;
1408
-
1409
- export type ParseOrbSecurityButtonsLoadingText = OrbSecurityButtonReadyLoadingText;
1410
-
1411
- export type ParseOrbSecurityButtonsHref = OrbSecurityButtonReadyUrlParamsHref;
1412
-
1413
- export type ParseOrbSecurityButtonsArmState = OrbSecurityButtonReadyUrlParamsArmState;
1414
-
1415
- export type ParseOrbSecurityButtonsArm = OrbSecurityButtonReadyUrlParamsArm;
1416
-
1417
- /**
1418
- * Parse sensors table.
1419
- *
1420
- * @since 1.0.0
1421
- */
1422
- export type ParseOrbSensorsTableElements = NodeListOf<Element>;
1423
-
1424
- export type ParseOrbSensorsTableReturns = SensorsInformation;
1425
-
1426
- export type ParseOrbSensorsTableSensors = SensorsInformation;
1427
-
1428
- export type ParseOrbSensorsTableDeviceType = SensorInformationDeviceType;
1429
-
1430
- export type ParseOrbSensorsTableStatus = SensorInformationStatus;
1431
-
1432
- /**
1433
- * Remove personal identifiable information.
1434
- *
1435
- * @since 1.0.0
1436
- */
1437
- export type RemovePersonalIdentifiableInformationModifiedObject = {
1438
- [key: string]: unknown;
1439
- };
1440
-
1441
- export type RemovePersonalIdentifiableInformationData = RemovePersonalIdentifiableInformationModifiedObject | RemovePersonalIdentifiableInformationModifiedObject[];
1442
-
1443
- export type RemovePersonalIdentifiableInformationReturns = RemovePersonalIdentifiableInformationModifiedObject | RemovePersonalIdentifiableInformationModifiedObject[];
1444
-
1445
- export type RemovePersonalIdentifiableInformationReplaceValueObject = RemovePersonalIdentifiableInformationModifiedObject;
1446
-
1447
- export type RemovePersonalIdentifiableInformationReplaceValueReturns = RemovePersonalIdentifiableInformationModifiedObject;
1448
-
1449
- /**
1450
- * Sleep.
1451
- *
1452
- * @since 1.0.0
1453
- */
1454
- export type SleepMilliseconds = number;
1455
-
1456
- export type SleepReturns = Promise<void>;
1457
-
1458
- /**
1459
- * Stack tracer.
1460
- *
1461
- * @since 1.0.0
1462
- */
1463
- export type StackTracerType = 'api-response' | 'detect-content' | 'serialize-error' | 'zod-error';
1464
-
1465
- export type StackTracerError<Type extends StackTracerType> =
1466
- Type extends 'api-response' ? ApiResponseFail<any>
1467
- : Type extends 'detect-content' ? object
1468
- : Type extends 'serialize-error' ? ErrorObject
1469
- : Type extends 'zod-error' ? z.ZodIssue[]
1470
- : never;
1471
-
1472
- export type StackTracerReturns = void;