homebridge-adt-pulse 2.2.0 → 3.0.0-beta.10

package/build/src/scripts/test-api.js

@@ -0,0 +1,171 @@
+import chalk from 'chalk';
+import _ from 'lodash';
+import { readFileSync } from 'node:fs';
+import os from 'node:os';
+import { exit, stdin, stdout } from 'node:process';
+import readline from 'node:readline';
+import util from 'node:util';
+import { ADTPulse } from '../lib/api.js';
+import { platformConfig } from '../lib/schema.js';
+import { debugLog, isForwardSlashOS } from '../lib/utility.js';
+class ADTPulseTest {
+    #selectedConfigLocation;
+    #selectedPlatform;
+    async startTest() {
+        try {
+            const userAcceptedDisclaimer = await ADTPulseTest.askQuestion('disclaimer');
+            if (!userAcceptedDisclaimer) {
+                exit(0);
+            }
+            console.info('\r');
+            const configFoundAndSet = this.findConfig();
+            if (!configFoundAndSet || this.#selectedPlatform === undefined) {
+                ADTPulseTest.printTestOutput(false);
+                exit(1);
+            }
+            const instance = new ADTPulse(this.#selectedPlatform, {
+                debug: true,
+                testMode: {
+                    enabled: true,
+                },
+            });
+            const instanceFunctions = [
+                instance.login.bind(instance),
+                instance.getGatewayInformation.bind(instance),
+                instance.getPanelInformation.bind(instance),
+                instance.getPanelStatus.bind(instance),
+                instance.setPanelStatus.bind(instance, 'away'),
+                instance.setPanelStatus.bind(instance, 'stay'),
+                instance.setPanelStatus.bind(instance, 'night'),
+                instance.setPanelStatus.bind(instance, 'off'),
+                instance.getSensorsInformation.bind(instance),
+                instance.getSensorsStatus.bind(instance),
+                instance.performSyncCheck.bind(instance),
+                instance.performKeepAlive.bind(instance),
+                instance.logout.bind(instance),
+            ];
+            for (let i = 0; i < instanceFunctions.length; i += 1) {
+                const response = await instanceFunctions[i]();
+                if (!response.success) {
+                    ADTPulseTest.printTestOutput(false);
+                    exit(1);
+                }
+                console.info(util.inspect(response, {
+                    showHidden: false,
+                    depth: Infinity,
+                    colors: true,
+                }));
+            }
+            ADTPulseTest.printTestOutput(true);
+            exit(0);
+        }
+        catch {
+            ADTPulseTest.printTestOutput(false);
+            exit(1);
+        }
+    }
+    findConfig() {
+        const possibleLocations = [
+            ...(isForwardSlashOS()) ? [
+                '/homebridge/config.json',
+                '/var/lib/homebridge/config.json',
+                `${os.homedir()}/.homebridge/config.json`,
+            ] : [],
+            ...(!isForwardSlashOS()) ? [
+                `${os.homedir()}\\.homebridge\\config.json`,
+            ] : [],
+        ];
+        for (let i = 0; i < possibleLocations.length; i += 1) {
+            if (this.#selectedConfigLocation !== undefined && this.#selectedPlatform !== undefined) {
+                break;
+            }
+            debugLog(null, 'test-api.ts', 'info', `Attempt ${i + 1}: Finding the Homebridge config file in "${possibleLocations[i]}"`);
+            try {
+                const rawFile = readFileSync(possibleLocations[i], 'utf-8');
+                const parsedFile = JSON.parse(rawFile);
+                const platforms = _.get(parsedFile, ['platforms']);
+                const adtPlatform = _.find(platforms, (platform) => _.get(platform, ['platform']) === 'ADTPulse');
+                if (adtPlatform !== undefined) {
+                    const validAdtPlatform = platformConfig.safeParse(adtPlatform);
+                    if (validAdtPlatform.success) {
+                        this.#selectedConfigLocation = possibleLocations[i];
+                        this.#selectedPlatform = validAdtPlatform.data;
+                    }
+                }
+            }
+            catch {
+                this.#selectedConfigLocation = undefined;
+                this.#selectedPlatform = undefined;
+            }
+        }
+        if (this.#selectedConfigLocation === undefined || this.#selectedPlatform === undefined) {
+            debugLog(null, 'test-api.ts', 'error', 'Unable to find a parsable Homebridge config file with a validated "ADTPulse" platform');
+            return false;
+        }
+        debugLog(null, 'test-api.ts', 'success', `Found valid Homebridge config in "${this.#selectedConfigLocation}"`);
+        return true;
+    }
+    static async askQuestion(mode) {
+        const rlInterface = readline.createInterface({
+            input: stdin,
+            output: stdout,
+        });
+        const questions = {
+            disclaimer: [
+                chalk.cyanBright('##############################################################'),
+                chalk.cyanBright('####         ADT Pulse for Homebridge Plugin Test         ####'),
+                chalk.cyanBright('#### https://github.com/mrjackyliang/homebridge-adt-pulse ####'),
+                chalk.cyanBright('####                                                      ####'),
+                chalk.cyanBright('####     Copyright (c) 2023 Jacky Liang. ISC License.     ####'),
+                chalk.cyanBright('##############################################################'),
+                'Before you begin, please make sure of the following:',
+                '',
+                '1. You have the proper authorization to carry out system testing.',
+                '2. You are currently ON THE PROPERTY where the test is being conducted.',
+                '3. You have disarmed the system and have >= 1 door/window open.',
+                '4. You have access to MyADT and have placed the system in test mode.',
+                '',
+                `${chalk.redBright('WARNING')}: If you DO NOT have access to MyADT or CANNOT place the system into`,
+                'test mode, please DO NOT PROCEED. The author is NOT RESPONSIBLE if the test causes',
+                'an accidental trigger or if ADT agents/local authorities become involved.',
+                '',
+                `${chalk.bold.yellowBright('NOTICE')}: The API gathers anonymous analytics to detect potential bugs or issues.`,
+                '        All personally identifiable information redacted. You will see exactly what will be sent out.',
+                '',
+                chalk.yellowBright('Type "I Agree" (without quotes) to fully acknowledge that you have read through'),
+                chalk.yellowBright('and understood the instructions, and agree to the disclaimer above ...'),
+                '➜ ',
+            ].join('\n'),
+        };
+        return new Promise((resolve) => {
+            rlInterface.question(questions[mode], (input) => {
+                if (input !== 'I Agree') {
+                    resolve(false);
+                }
+                resolve(true);
+            });
+        });
+    }
+    static printTestOutput(isSuccess) {
+        if (!isSuccess) {
+            console.info([
+                '',
+                chalk.redBright('########################################################################'),
+                chalk.redBright('#####       Test has failed! Please check the error response       #####'),
+                chalk.redBright('#####  above, attempt to resolve them, then run this tester again  #####'),
+                chalk.redBright('########################################################################'),
+            ].join('\n'));
+            return;
+        }
+        console.info([
+            '',
+            chalk.greenBright('########################################################################'),
+            chalk.greenBright('#####       Test has completed! If you find my plugin useful       #####'),
+            chalk.greenBright('#####  please consider donating to my efforts via GitHub Sponsors  #####'),
+            chalk.greenBright('########################################################################'),
+        ].join('\n'));
+    }
+}
+const instance = new ADTPulseTest();
+await instance.startTest();
+//# sourceMappingURL=test-api.js.map

package/build/src/scripts/test-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-api.js","sourceRoot":"","sources":["../../../src/scripts/test-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAmB9D,MAAM,YAAY;IAQhB,uBAAuB,CAAqC;IAS5D,iBAAiB,CAA+B;IAShD,KAAK,CAAC,SAAS;QACb,IAAI,CAAC;YACH,MAAM,sBAAsB,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAE5E,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAC5B,IAAI,CAAC,CAAC,CAAC,CAAC;YACV,CAAC;YAGD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEnB,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YAE5C,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;gBAC/D,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;gBAEpC,IAAI,CAAC,CAAC,CAAC,CAAC;YACV,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAC3B,IAAI,CAAC,iBAAiB,EACtB;gBACE,KAAK,EAAE,IAAI;gBACX,QAAQ,EAAE;oBACR,OAAO,EAAE,IAAI;iBACd;aACF,CACF,CAAC;YACF,MAAM,iBAAiB,GAAG;gBACxB,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC7B,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC7C,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC3C,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACtC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAC9C,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAC9C,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC;gBAC/C,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;gBAC7C,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC7C,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACxC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACxC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACxC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;aAC/B,CAAC;YAEF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrD,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAG9C,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;oBACtB,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;oBAEpC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACV,CAAC;gBAGD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;oBAClC,UAAU,EAAE,KAAK;oBACjB,KAAK,EAAE,QAAQ;oBACf,MAAM,EAAE,IAAI;iBACb,CAAC,CAAC,CAAC;YACN,CAAC;YAED,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAEnC,IAAI,CAAC,CAAC,CAAC,CAAC;QACV,CAAC;QAAC,MAAM,CAAC;YACP,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YAEpC,IAAI,CAAC,CAAC,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAWO,UAAU;QAChB,MAAM,iBAAiB,GAA4C;YACjE,GAAG,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,CAAC;gBACxB,yBAAyB;gBACzB,iCAAiC;gBACjC,GAAG,EAAE,CAAC,OAAO,EAAE,0BAA0B;aAC1C,CAAC,CAAC,CAAC,EAAE;YACN,GAAG,CAAC,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,CAAC;gBACzB,GAAG,EAAE,CAAC,OAAO,EAAE,4BAA4B;aAC5C,CAAC,CAAC,CAAC,EAAE;SACP,CAAC;QAEF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAErD,IAAI,IAAI,CAAC,uBAAuB,KAAK,SAAS,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;gBACvF,MAAM;YACR,CAAC;YAED,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,4CAA4C,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAE3H,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;gBAC5D,MAAM,UAAU,GAAqC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACzE,MAAM,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;gBACnD,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC;gBAElG,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,MAAM,gBAAgB,GAAG,cAAc,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;oBAE/D,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC;wBAC7B,IAAI,CAAC,uBAAuB,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;wBACpD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,IAAI,CAAC;oBACjD,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;gBACzC,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;YACrC,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,uBAAuB,KAAK,SAAS,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACvF,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,uFAAuF,CAAC,CAAC;YAEhI,OAAO,KAAK,CAAC;QACf,CAAC;QAED,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,qCAAqC,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;QAE/G,OAAO,IAAI,CAAC;IACd,CAAC;IAaO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAiC;QAChE,MAAM,WAAW,GAAG,QAAQ,CAAC,eAAe,CAAC;YAC3C,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;QACH,MAAM,SAAS,GAAG;YAChB,UAAU,EAAE;gBACV,KAAK,CAAC,UAAU,CAAC,gEAAgE,CAAC;gBAClF,KAAK,CAAC,UAAU,CAAC,gEAAgE,CAAC;gBAClF,KAAK,CAAC,UAAU,CAAC,gEAAgE,CAAC;gBAClF,KAAK,CAAC,UAAU,CAAC,gEAAgE,CAAC;gBAClF,KAAK,CAAC,UAAU,CAAC,gEAAgE,CAAC;gBAClF,KAAK,CAAC,UAAU,CAAC,gEAAgE,CAAC;gBAClF,sDAAsD;gBACtD,EAAE;gBACF,mEAAmE;gBACnE,yEAAyE;gBACzE,iEAAiE;gBACjE,sEAAsE;gBACtE,EAAE;gBACF,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,sEAAsE;gBACnG,oFAAoF;gBACpF,2EAA2E;gBAC3E,EAAE;gBACF,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,2EAA2E;gBAC/G,uGAAuG;gBACvG,EAAE;gBACF,KAAK,CAAC,YAAY,CAAC,iFAAiF,CAAC;gBACrG,KAAK,CAAC,YAAY,CAAC,wEAAwE,CAAC;gBAC5F,IAAI;aACL,CAAC,IAAI,CAAC,IAAI,CAAC;SACb,CAAC;QAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC9C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjB,CAAC;gBAED,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAaO,MAAM,CAAC,eAAe,CAAC,SAA+C;QAC5E,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC;gBACX,EAAE;gBACF,KAAK,CAAC,SAAS,CAAC,0EAA0E,CAAC;gBAC3F,KAAK,CAAC,SAAS,CAAC,0EAA0E,CAAC;gBAC3F,KAAK,CAAC,SAAS,CAAC,0EAA0E,CAAC;gBAC3F,KAAK,CAAC,SAAS,CAAC,0EAA0E,CAAC;aAC5F,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAEd,OAAO;QACT,CAAC;QAED,OAAO,CAAC,IAAI,CAAC;YACX,EAAE;YACF,KAAK,CAAC,WAAW,CAAC,0EAA0E,CAAC;YAC7F,KAAK,CAAC,WAAW,CAAC,0EAA0E,CAAC;YAC7F,KAAK,CAAC,WAAW,CAAC,0EAA0E,CAAC;YAC7F,KAAK,CAAC,WAAW,CAAC,0EAA0E,CAAC;SAC9F,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAChB,CAAC;CACF;AAED,MAAM,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAC;AACpC,MAAM,QAAQ,CAAC,SAAS,EAAE,CAAC"}