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

package/src/scripts/repl.ts

@@ -1,300 +0,0 @@
-import chalk from 'chalk';
-import repl from 'node:repl';
-
-import { ADTPulse } from '@/lib/api.js';
-import type {
-  ADTPulseDisplayHelpHeaderReturns,
-  ADTPulseDisplayHelpMenuReturns,
-  ADTPulseDisplayStartupHeaderReturns,
-  ADTPulseReplApi,
-  ADTPulseReplColorLogMessage,
-  ADTPulseReplColorLogReturns,
-  ADTPulseReplColorLogType,
-  ADTPulseReplReplServer,
-  ADTPulseReplSetInstanceFingerprint,
-  ADTPulseReplSetInstancePassword,
-  ADTPulseReplSetInstanceReturns,
-  ADTPulseReplSetInstanceSubdomain,
-  ADTPulseReplSetInstanceUsername,
-  ADTPulseReplStartReplReturns,
-} from '@/types/index.d.ts';
-
-/**
- * ADT Pulse Repl.
- *
- * @since 1.0.0
- */
-class ADTPulseRepl {
-  /**
-   * ADT Pulse Repl - Api.
-   *
-   * @private
-   *
-   * @since 1.0.0
-   */
-  #api: ADTPulseReplApi;
-
-  /**
-   * ADT Pulse Repl - Repl server.
-   *
-   * @private
-   *
-   * @since 1.0.0
-   */
-  #replServer: ADTPulseReplReplServer;
-
-  /**
-   * ADT Pulse Repl - Start repl.
-   *
-   * @returns {ADTPulseReplStartReplReturns}
-   *
-   * @since 1.0.0
-   */
-  async startRepl(): ADTPulseReplStartReplReturns {
-    ADTPulseRepl.displayStartupHeader();
-    ADTPulseRepl.displayHelpMenu();
-
-    // Start the REPL server.
-    this.#replServer = repl.start({
-      ignoreUndefined: true,
-      prompt: '> ',
-    });
-
-    // Set the REPL server context on start-up.
-    this.#replServer.context.repl = this;
-
-    // Replace the default ".break" command.
-    this.#replServer.defineCommand('break', {
-      help: 'Sometimes you get stuck, this gets you out',
-      action() {
-        ADTPulseRepl.colorLog('error', 'The ".break" command is not allowed.');
-        this.displayPrompt();
-      },
-    });
-
-    // Replace the default ".clear" command.
-    this.#replServer.defineCommand('clear', {
-      help: 'Break, and also clear the local context',
-      action() {
-        ADTPulseRepl.colorLog('error', 'The ".clear" command is not allowed.');
-        this.displayPrompt();
-      },
-    });
-
-    // Replace the default ".editor" command.
-    this.#replServer.defineCommand('editor', {
-      help: 'Enter editor mode',
-      action() {
-        ADTPulseRepl.colorLog('error', 'The ".editor" command is not allowed.');
-        this.displayPrompt();
-      },
-    });
-
-    // Replace the default ".help" command.
-    this.#replServer.defineCommand('help', {
-      help: 'Print this help message',
-      action() {
-        ADTPulseRepl.displayHelpHeader();
-        ADTPulseRepl.displayHelpMenu();
-        this.displayPrompt();
-      },
-    });
-
-    // Replace the default ".load" command.
-    this.#replServer.defineCommand('load', {
-      help: 'Load JS from a file into the REPL session',
-      action() {
-        ADTPulseRepl.colorLog('error', 'The ".load" command is not allowed.');
-        this.displayPrompt();
-      },
-    });
-
-    // Replace the default ".save" command.
-    this.#replServer.defineCommand('save', {
-      help: 'Save all evaluated commands in this REPL session to a file',
-      action() {
-        ADTPulseRepl.colorLog('error', 'The ".save" command is not allowed.');
-        this.displayPrompt();
-      },
-    });
-  }
-
-  /**
-   * ADT Pulse Repl - Set instance.
-   *
-   * @param {ADTPulseReplSetInstanceSubdomain}   subdomain   - Subdomain.
-   * @param {ADTPulseReplSetInstanceUsername}    username    - Username.
-   * @param {ADTPulseReplSetInstancePassword}    password    - Password.
-   * @param {ADTPulseReplSetInstanceFingerprint} fingerprint - Fingerprint.
-   *
-   * @returns {ADTPulseReplSetInstanceReturns}
-   *
-   * @since 1.0.0
-   */
-  setInstance(subdomain: ADTPulseReplSetInstanceSubdomain, username: ADTPulseReplSetInstanceUsername, password: ADTPulseReplSetInstancePassword, fingerprint: ADTPulseReplSetInstanceFingerprint): ADTPulseReplSetInstanceReturns {
-    if (subdomain !== 'portal' && subdomain !== 'portal-ca') {
-      ADTPulseRepl.colorLog('error', 'Invalid subdomain specified. Valid values are either "portal" or "portal-ca".');
-
-      return;
-    }
-
-    if (typeof username !== 'string' || username === '') {
-      ADTPulseRepl.colorLog('error', 'Username must be a string and cannot be empty.');
-
-      return;
-    }
-
-    if (typeof password !== 'string' || password === '') {
-      ADTPulseRepl.colorLog('error', 'Password must be a string and cannot be empty.');
-
-      return;
-    }
-
-    if (typeof fingerprint !== 'string' || fingerprint === '') {
-      ADTPulseRepl.colorLog('error', 'Fingerprint must be a string and cannot be empty.');
-
-      return;
-    }
-
-    // If the values are valid, set a new instance.
-    this.#api = new ADTPulse({
-      platform: 'ADTPulse',
-      subdomain,
-      username,
-      password,
-      fingerprint,
-      sensors: [],
-    }, {
-      debug: true,
-    });
-
-    // Check if "this.#replServer" was properly set during startup.
-    if (this.#replServer === undefined) {
-      ADTPulseRepl.colorLog('error', 'Failed to set context because "this.#replServer" is undefined.');
-
-      return;
-    }
-
-    // Set the REPL server context after setting the instance.
-    this.#replServer.context.api = this.#api;
-
-    ADTPulseRepl.colorLog('info', 'Instance has been successfully set.');
-    ADTPulseRepl.colorLog('info', 'You may now use the available API methods to test the system!');
-    ADTPulseRepl.colorLog('info', '\n');
-  }
-
-  /**
-   * ADT Pulse Repl - Color log.
-   *
-   * @param {ADTPulseReplColorLogType}    type    - Type.
-   * @param {ADTPulseReplColorLogMessage} message - Message.
-   *
-   * @private
-   *
-   * @returns {ADTPulseReplColorLogReturns}
-   *
-   * @since 1.0.0
-   */
-  private static colorLog(type: ADTPulseReplColorLogType, message: ADTPulseReplColorLogMessage): ADTPulseReplColorLogReturns {
-    switch (type) {
-      case 'error':
-        console.error(chalk.redBright(message));
-        break;
-      case 'info':
-        console.info(chalk.greenBright(message));
-        break;
-      default:
-        break;
-    }
-  }
-
-  /**
-   * ADT Pulse Repl - Display help header.
-   *
-   * @returns {ADTPulseDisplayHelpHeaderReturns}
-   *
-   * @since 1.0.0
-   */
-  private static displayHelpHeader(): ADTPulseDisplayHelpHeaderReturns {
-    console.info([
-      chalk.cyanBright('########################################################'),
-      chalk.cyanBright('#### ADT Pulse for Homebridge Plugin REPL Help Menu ####'),
-      chalk.cyanBright('########################################################'),
-      '',
-      'This is the help menu on how to use this REPL interface. If you have questions on how',
-      'to use this, please refer to the documentation using the link below:',
-      '',
-      'https://github.com/mrjackyliang/homebridge-adt-pulse',
-    ].join('\n'));
-  }
-
-  /**
-   * ADT Pulse Repl - Display help menu.
-   *
-   * @returns {ADTPulseDisplayHelpMenuReturns}
-   *
-   * @since 1.0.0
-   */
-  private static displayHelpMenu(): ADTPulseDisplayHelpMenuReturns {
-    console.info([
-      '',
-      chalk.bold('Method parameter documentation:'),
-      `    {'portal' | 'portal-ca'}           ${chalk.magentaBright('subdomain')}   - Set the domain for either USA or Canada subscribers`,
-      `    {string}                           ${chalk.magentaBright('username')}    - The username for logging in to ADT Pulse portal`,
-      `    {string}                           ${chalk.magentaBright('password')}    - The password for logging in to ADT Pulse portal`,
-      `    {string}                           ${chalk.magentaBright('fingerprint')} - The fingerprint for logging in to ADT Pulse portal`,
-      `    {'arm' | 'night' | 'off' | 'stay'} ${chalk.magentaBright('armTo')}       - Available methods to arm the system`,
-      '',
-      chalk.bold('Before you use the API, set the instance using this command:'),
-      `    ${chalk.yellowBright(`repl.setInstance(${chalk.magentaBright('subdomain')}, ${chalk.magentaBright('username')}, ${chalk.magentaBright('password')}, ${chalk.magentaBright('fingerprint')});`)}`,
-      '',
-      chalk.bold('Once an instance is set, interact with the portal using these methods:'),
-      `    ${chalk.yellowBright('await api.login();')}`,
-      `    ${chalk.yellowBright('await api.logout();')}`,
-      `    ${chalk.yellowBright('await api.getGatewayInformation();')}`,
-      `    ${chalk.yellowBright('await api.getPanelInformation();')}`,
-      `    ${chalk.yellowBright('await api.getPanelStatus();')}`,
-      `    ${chalk.yellowBright(`await api.setPanelStatus(${chalk.magentaBright('armTo')});`)}`,
-      `    ${chalk.yellowBright('await api.getSensorsInformation();')}`,
-      `    ${chalk.yellowBright('await api.getSensorsStatus();')}`,
-      `    ${chalk.yellowBright('await api.performSyncCheck();')}`,
-      `    ${chalk.yellowBright('await api.performKeepAlive();')}`,
-      `    ${chalk.yellowBright('      api.isAuthenticated();')}`,
-      '',
-      chalk.bold('You may also wrap the above methods with this to see the entire response:'),
-      `    ${chalk.yellowBright(`console.log(util.inspect(${chalk.magentaBright('replace me without the ending semi-colon')}, false, null, true));`)}`,
-      chalk.bold('A small reference for REPL commands:'),
-      `    ${chalk.yellowBright('.exit')}`,
-      `    ${chalk.yellowBright('.help')}`,
-      '',
-    ].join('\n'));
-  }
-
-  /**
-   * ADT Pulse Repl - Display startup header.
-   *
-   * @returns {ADTPulseDisplayStartupHeaderReturns}
-   *
-   * @since 1.0.0
-   */
-  private static displayStartupHeader(): ADTPulseDisplayStartupHeaderReturns {
-    console.info([
-      chalk.cyanBright('##############################################################'),
-      chalk.cyanBright('####         ADT Pulse for Homebridge Plugin REPL         ####'),
-      chalk.cyanBright('#### https://github.com/mrjackyliang/homebridge-adt-pulse ####'),
-      chalk.cyanBright('####                                                      ####'),
-      chalk.cyanBright('####     Copyright (c) 2023 Jacky Liang. ISC License.     ####'),
-      chalk.cyanBright('##############################################################'),
-      '',
-      'Welcome to the REPL interface for ADT Pulse for Homebridge. This interface',
-      'allows you to interact with the ADT Pulse portal via the included API and is designed',
-      `for advanced users only. ${chalk.redBright('PLEASE USE WITH CAUTION, NO WARRANTY IS PROVIDED.')}`,
-      '',
-      `${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.',
-    ].join('\n'));
-  }
-}
-
-const adtPulseRepl = new ADTPulseRepl();
-await adtPulseRepl.startRepl();

package/src/scripts/test-api.ts

@@ -1,278 +0,0 @@
-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';
-import type {
-  ADTPulseTestAskQuestionMode,
-  ADTPulseTestAskQuestionReturns,
-  ADTPulseTestFindConfigParsedFile,
-  ADTPulseTestFindConfigPossibleLocations,
-  ADTPulseTestFindConfigReturns,
-  ADTPulseTestPrintTestOutputIsSuccess,
-  ADTPulseTestPrintTestOutputReturns,
-  ADTPulseTestSelectedConfigLocation,
-  ADTPulseTestSelectedPlatform,
-  ADTPulseTestStartTestReturns,
-} from '@/types/index.d.ts';
-
-/**
- * ADT Pulse Test.
- *
- * @since 1.0.0
- */
-class ADTPulseTest {
-  /**
-   * ADT Pulse Test - Selected config location.
-   *
-   * @private
-   *
-   * @since 1.0.0
-   */
-  #selectedConfigLocation: ADTPulseTestSelectedConfigLocation;
-
-  /**
-   * ADT Pulse Test - Selected platform.
-   *
-   * @private
-   *
-   * @since 1.0.0
-   */
-  #selectedPlatform: ADTPulseTestSelectedPlatform;
-
-  /**
-   * ADT Pulse Test - Start test.
-   *
-   * @returns {ADTPulseTestStartTestReturns}
-   *
-   * @since 1.0.0
-   */
-  async startTest(): ADTPulseTestStartTestReturns {
-    try {
-      const userAcceptedDisclaimer = await ADTPulseTest.askQuestion('disclaimer');
-
-      if (!userAcceptedDisclaimer) {
-        exit(0);
-      }
-
-      // Used to pad the user input to the next line.
-      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 is not successful, end the test.
-        if (!response.success) {
-          ADTPulseTest.printTestOutput(false);
-
-          exit(1);
-        }
-
-        // Print success responses.
-        console.info(util.inspect(response, {
-          showHidden: false,
-          depth: Infinity,
-          colors: true,
-        }));
-      }
-
-      ADTPulseTest.printTestOutput(true);
-
-      exit(0);
-    } catch {
-      ADTPulseTest.printTestOutput(false);
-
-      exit(1);
-    }
-  }
-
-  /**
-   * ADT Pulse Test - Find config.
-   *
-   * @private
-   *
-   * @returns {ADTPulseTestFindConfigReturns}
-   *
-   * @since 1.0.0
-   */
-  private findConfig(): ADTPulseTestFindConfigReturns {
-    const possibleLocations: ADTPulseTestFindConfigPossibleLocations = [
-      ...(isForwardSlashOS()) ? [
-        '/homebridge/config.json', // "homebridge" Docker.
-        '/var/lib/homebridge/config.json', // Debian or Raspbian.
-        `${os.homedir()}/.homebridge/config.json`, // macOS.
-      ] : [],
-      ...(!isForwardSlashOS()) ? [
-        `${os.homedir()}\\.homebridge\\config.json`, // Windows.
-      ] : [],
-    ];
-
-    for (let i = 0; i < possibleLocations.length; i += 1) {
-      // Don't run again if config location and platform have been selected.
-      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: ADTPulseTestFindConfigParsedFile = 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;
-  }
-
-  /**
-   * ADT Pulse Test - Ask question.
-   *
-   * @param {ADTPulseTestAskQuestionMode} mode - Mode.
-   *
-   * @private
-   *
-   * @returns {ADTPulseTestAskQuestionReturns}
-   *
-   * @since 1.0.0
-   */
-  private static async askQuestion(mode: ADTPulseTestAskQuestionMode): ADTPulseTestAskQuestionReturns {
-    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);
-      });
-    });
-  }
-
-  /**
-   * ADT Pulse Test - Print test output.
-   *
-   * @param {ADTPulseTestPrintTestOutputIsSuccess} isSuccess - Is success.
-   *
-   * @private
-   *
-   * @returns {ADTPulseTestPrintTestOutputReturns}
-   *
-   * @since 1.0.0
-   */
-  private static printTestOutput(isSuccess: ADTPulseTestPrintTestOutputIsSuccess): ADTPulseTestPrintTestOutputReturns {
-    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();