node-alarm-dot-com 2.0.0-beta.3 → 2.0.0-beta.5

package/dist/_models/DeviceStates.d.ts

@@ -1,6 +1,6 @@
 import { Relationship } from './IdentityResponse';
-import { RelationshipType } from './SystemState';
-import { GARAGE_STATES, LIGHT_STATES, LOCK_STATES, SENSOR_STATES, SYSTEM_STATES } from './States';
+import { AutomationType, RelationshipType } from './SystemState';
+import { GARAGE_STATES, LIGHT_STATES, LOCK_STATES, SENSOR_STATES, SYSTEM_STATES, THERMOSTAT_STATES } from './States';
 import { SensorType } from './SensorType';
 export interface ApiLightState extends ApiDeviceState {
     data: {
@@ -752,6 +752,306 @@ export interface CameraState extends DeviceState {
         };
     };
 }
+export interface ApiThermostatState extends ApiDeviceState {
+    data: {
+        id: string;
+        type: RelationshipType.Thermostat;
+        attributes: {
+            requiresSetup: boolean;
+            forwardingAmbientTemp: number;
+            minHeatSetpoint: number;
+            maxHeatSetpoint: number;
+            minCoolSetpoint: number;
+            maxCoolSetpoint: number;
+            minAuxHeatSetpoint: number;
+            maxAuxHeatSetpoint: number;
+            heatSetpoint: number;
+            desiredHeatSetpoint: number;
+            coolSetpoint: number;
+            desiredCoolSetpoint: number;
+            homeHeatSetpoint: number;
+            homeCoolSetpoint: number;
+            awayHeatSetpoint: number;
+            awayCoolSetpoint: number;
+            sleepHeatSetpoint: number;
+            sleepCoolSetpoint: number;
+            setpointOffset: number;
+            autoSetpointBuffer: number;
+            thirdPartySettingsUrlDesc?: string;
+            thirdPartySettingsUrl?: string;
+            state: THERMOSTAT_STATES;
+            desiredState: THERMOSTAT_STATES;
+            inferredState: THERMOSTAT_STATES;
+            scheduleMode: number;
+            fanMode: number;
+            desiredFanMode: number;
+            fanDuration?: null;
+            localDisplayLockingMode: number;
+            desiredLocalDisplayLockingMode?: null;
+            hasRtsIssue: boolean;
+            isControlled: boolean;
+            supportsSetpoints: boolean;
+            isPoolController: boolean;
+            supportsOffMode: boolean;
+            supportsHeatMode: boolean;
+            supportsCoolMode: boolean;
+            supportsAutoMode: boolean;
+            supportsSmartSchedules: boolean;
+            supportsAuxHeatMode: boolean;
+            supportsSchedules: boolean;
+            supportsFanMode: boolean;
+            supportsIndefiniteFanOn: boolean;
+            supportedFanDurations: number[];
+            supportsCirculateFanModeAlways: boolean;
+            supportsCirculateFanModeWhenOff: boolean;
+            supportsRts?: boolean;
+            supportsLocalDisplayLocking: boolean;
+            supportsPartialLocalDisplayLocking: boolean;
+            supportsHvacAnalytics: boolean;
+            supportsThirdPartySettings: boolean;
+            hasPendingTempModeChange: boolean;
+            hasPendingSetpointChange: boolean;
+            hasPendingHeatSetpointChange: boolean;
+            hasPendingCoolSetpointChange: boolean;
+            ambientTemp: number;
+            isPaired: boolean;
+            supportsPairing: boolean;
+            tempForwardingActive: boolean;
+            supportsHumidity: boolean;
+            humidityLevel?: number;
+            managedDeviceType: number;
+            hasState: boolean;
+            canBeRenamed: boolean;
+            canBeDeleted: boolean;
+            canAccessWebSettings: boolean;
+            canAccessAppSettings: boolean;
+            webSettings: number;
+            canAccessTroubleshootingWizard: boolean;
+            troubleshootingWizard?: null;
+            canBeAssociatedToVideoDevice: boolean;
+            associatedCameraDeviceIds: {};
+            macAddress: string;
+            manufacturer: string;
+            isOAuth: boolean;
+            isZWave: boolean;
+            supportsCommandClassBasic: boolean;
+            isMalfunctioning: boolean;
+            canBeSaved: boolean;
+            canChangeDescription: boolean;
+            description: string;
+            deviceModelId: number;
+            canConfirmStateChange: boolean;
+            canReceiveCommands: boolean;
+            remoteCommandsEnabled: boolean;
+            hasPermissionToChangeState: boolean;
+            deviceIcon: {
+                icon: number;
+            };
+            batteryLevelNull: number;
+            lowBattery: boolean;
+            criticalBattery: boolean;
+        };
+        relationships: {
+            ruleSuggestions: {
+                data: Relationship[];
+                meta: {
+                    count: string;
+                };
+            };
+            thermostatSettingsTemplate: {
+                data?: any;
+            };
+            remoteTemperatureSensors: {
+                data: [];
+                meta: {
+                    count: string;
+                };
+            };
+            boilerControlSystem: {
+                data?: any;
+            };
+            valveSwitches: {
+                data: [];
+                meta: {
+                    count: string;
+                };
+            };
+            peakProtect: {
+                data: {
+                    id: string;
+                    type: AutomationType.PeakProtect;
+                };
+            };
+            controlledThermostats: {
+                data: [];
+                meta: {
+                    count: string;
+                };
+            };
+            system: {
+                data: {
+                    id: string;
+                    type: RelationshipType.System;
+                };
+            };
+            stateInfo: {
+                data?: {
+                    id: string;
+                    type: RelationshipType.State;
+                };
+            };
+        };
+    };
+}
+export interface ThermostatState extends DeviceState {
+    id: string;
+    type: RelationshipType.Thermostat;
+    attributes: {
+        requiresSetup: boolean;
+        forwardingAmbientTemp: number;
+        minHeatSetpoint: number;
+        maxHeatSetpoint: number;
+        minCoolSetpoint: number;
+        maxCoolSetpoint: number;
+        minAuxHeatSetpoint: number;
+        maxAuxHeatSetpoint: number;
+        heatSetpoint: number;
+        desiredHeatSetpoint: number;
+        coolSetpoint: number;
+        desiredCoolSetpoint: number;
+        homeHeatSetpoint: number;
+        homeCoolSetpoint: number;
+        awayHeatSetpoint: number;
+        awayCoolSetpoint: number;
+        sleepHeatSetpoint: number;
+        sleepCoolSetpoint: number;
+        setpointOffset: number;
+        autoSetpointBuffer: number;
+        thirdPartySettingsUrlDesc?: string;
+        thirdPartySettingsUrl?: string;
+        state: THERMOSTAT_STATES;
+        desiredState: THERMOSTAT_STATES;
+        inferredState: THERMOSTAT_STATES;
+        scheduleMode: number;
+        fanMode: number;
+        desiredFanMode: number;
+        fanDuration?: null;
+        localDisplayLockingMode: number;
+        desiredLocalDisplayLockingMode?: null;
+        hasRtsIssue: boolean;
+        isControlled: boolean;
+        supportsSetpoints: boolean;
+        isPoolController: boolean;
+        supportsOffMode: boolean;
+        supportsHeatMode: boolean;
+        supportsCoolMode: boolean;
+        supportsAutoMode: boolean;
+        supportsSmartSchedules: boolean;
+        supportsAuxHeatMode: boolean;
+        supportsSchedules: boolean;
+        supportsFanMode: boolean;
+        supportsIndefiniteFanOn: boolean;
+        supportedFanDurations: number[];
+        supportsCirculateFanModeAlways: boolean;
+        supportsCirculateFanModeWhenOff: boolean;
+        supportsRts?: boolean;
+        supportsLocalDisplayLocking: boolean;
+        supportsPartialLocalDisplayLocking: boolean;
+        supportsHvacAnalytics: boolean;
+        supportsThirdPartySettings: boolean;
+        hasPendingTempModeChange: boolean;
+        hasPendingSetpointChange: boolean;
+        hasPendingHeatSetpointChange: boolean;
+        hasPendingCoolSetpointChange: boolean;
+        ambientTemp: number;
+        isPaired: boolean;
+        supportsPairing: boolean;
+        tempForwardingActive: boolean;
+        supportsHumidity: boolean;
+        humidityLevel?: number;
+        managedDeviceType: number;
+        hasState: boolean;
+        canBeRenamed: boolean;
+        canBeDeleted: boolean;
+        canAccessWebSettings: boolean;
+        canAccessAppSettings: boolean;
+        webSettings: number;
+        canAccessTroubleshootingWizard: boolean;
+        troubleshootingWizard?: null;
+        canBeAssociatedToVideoDevice: boolean;
+        associatedCameraDeviceIds: {};
+        macAddress: string;
+        manufacturer: string;
+        isOAuth: boolean;
+        isZWave: boolean;
+        supportsCommandClassBasic: boolean;
+        isMalfunctioning: boolean;
+        canBeSaved: boolean;
+        canChangeDescription: boolean;
+        description: string;
+        deviceModelId: number;
+        canConfirmStateChange: boolean;
+        canReceiveCommands: boolean;
+        remoteCommandsEnabled: boolean;
+        hasPermissionToChangeState: boolean;
+        deviceIcon: {
+            icon: number;
+        };
+        batteryLevelNull: number;
+        lowBattery: boolean;
+        criticalBattery: boolean;
+    };
+    relationships: {
+        ruleSuggestions: {
+            data: Relationship[];
+            meta: {
+                count: string;
+            };
+        };
+        thermostatSettingsTemplate: {
+            data?: any;
+        };
+        remoteTemperatureSensors: {
+            data: [];
+            meta: {
+                count: string;
+            };
+        };
+        boilerControlSystem: {
+            data?: any;
+        };
+        valveSwitches: {
+            data: [];
+            meta: {
+                count: string;
+            };
+        };
+        peakProtect: {
+            data: {
+                id: string;
+                type: AutomationType.PeakProtect;
+            };
+        };
+        controlledThermostats: {
+            data: [];
+            meta: {
+                count: string;
+            };
+        };
+        system: {
+            data: {
+                id: string;
+                type: RelationshipType.System;
+            };
+        };
+        stateInfo: {
+            data?: {
+                id: string;
+                type: RelationshipType.State;
+            };
+        };
+    };
+}
 /**
  * Base interface for retrieving device state from Alarm.com's API
  * All devices retrieved contain these properties.

package/dist/_models/SensorType.d.ts

@@ -8,6 +8,9 @@ export declare enum SensorType {
     CO_Detector = 6,
     Heat_Detector = 8,
     Fob = 9,
+    Keypad = 10,
     Water_Sensor = 17,
-    Glass_Break = 19
+    Glass_Break = 19,
+    Panel_Camera = 68,
+    Panel_Glass_Break = 83
 }

package/dist/_models/SensorType.js

@@ -12,6 +12,9 @@ var SensorType;
     SensorType[SensorType["CO_Detector"] = 6] = "CO_Detector";
     SensorType[SensorType["Heat_Detector"] = 8] = "Heat_Detector";
     SensorType[SensorType["Fob"] = 9] = "Fob";
+    SensorType[SensorType["Keypad"] = 10] = "Keypad";
     SensorType[SensorType["Water_Sensor"] = 17] = "Water_Sensor";
     SensorType[SensorType["Glass_Break"] = 19] = "Glass_Break";
+    SensorType[SensorType["Panel_Camera"] = 68] = "Panel_Camera";
+    SensorType[SensorType["Panel_Glass_Break"] = 83] = "Panel_Glass_Break";
 })(SensorType = exports.SensorType || (exports.SensorType = {}));

package/dist/_models/States.d.ts

@@ -1,5 +1,7 @@
 /***
  * State of the partition as defined by Alarm.com
+ * @readonly
+ * @enum {number}
  */
 export declare enum SYSTEM_STATES {
     UNKNOWN = 0,
@@ -10,6 +12,8 @@ export declare enum SYSTEM_STATES {
 }
 /***
  * State of the sensor as defined by Alarm.com
+ * @readonly
+ * @enum {number}
  */
 export declare enum SENSOR_STATES {
     UNKNOWN = 0,
@@ -22,6 +26,8 @@ export declare enum SENSOR_STATES {
 }
 /***
  * State of the light as defined by Alarm.com
+ * @readonly
+ * @enum {number}
  */
 export declare enum LIGHT_STATES {
     ON = 2,
@@ -29,6 +35,8 @@ export declare enum LIGHT_STATES {
 }
 /***
  * State of the lock as defined by Alarm.com
+ * @readonly
+ * @enum {number}
  */
 export declare enum LOCK_STATES {
     SECURED = 1,
@@ -36,14 +44,28 @@ export declare enum LOCK_STATES {
 }
 /***
  * State of the garage as defined by Alarm.com
+ * @readonly
+ * @enum {number}
  */
 export declare enum GARAGE_STATES {
     OPEN = 1,
     CLOSED = 2
 }
+/***
+ * State of the thermostat as defined by Alarm.com
+ * @readonly
+ * @enum {number}
+ */
+export declare enum THERMOSTAT_STATES {
+    OFF = 1,
+    HEATING = 2,
+    COOLING = 3,
+    AUTO = 4
+}
 /***
  * Relation types as defined by Alarm.com.
  * Relationship types tell you what object is being sent from the API.
+ * @readonly
  */
 export declare enum REL_TYPES {
     CONFIGURATION = "systems/configuration",

package/dist/_models/States.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REL_TYPES = exports.GARAGE_STATES = exports.LOCK_STATES = exports.LIGHT_STATES = exports.SENSOR_STATES = exports.SYSTEM_STATES = void 0;
+exports.REL_TYPES = exports.THERMOSTAT_STATES = exports.GARAGE_STATES = exports.LOCK_STATES = exports.LIGHT_STATES = exports.SENSOR_STATES = exports.SYSTEM_STATES = void 0;
 /***
  * State of the partition as defined by Alarm.com
+ * @readonly
+ * @enum {number}
  */
 var SYSTEM_STATES;
 (function (SYSTEM_STATES) {
@@ -14,6 +16,8 @@ var SYSTEM_STATES;
 })(SYSTEM_STATES = exports.SYSTEM_STATES || (exports.SYSTEM_STATES = {}));
 /***
  * State of the sensor as defined by Alarm.com
+ * @readonly
+ * @enum {number}
  */
 var SENSOR_STATES;
 (function (SENSOR_STATES) {
@@ -27,6 +31,8 @@ var SENSOR_STATES;
 })(SENSOR_STATES = exports.SENSOR_STATES || (exports.SENSOR_STATES = {}));
 /***
  * State of the light as defined by Alarm.com
+ * @readonly
+ * @enum {number}
  */
 var LIGHT_STATES;
 (function (LIGHT_STATES) {
@@ -35,6 +41,8 @@ var LIGHT_STATES;
 })(LIGHT_STATES = exports.LIGHT_STATES || (exports.LIGHT_STATES = {}));
 /***
  * State of the lock as defined by Alarm.com
+ * @readonly
+ * @enum {number}
  */
 var LOCK_STATES;
 (function (LOCK_STATES) {
@@ -43,6 +51,8 @@ var LOCK_STATES;
 })(LOCK_STATES = exports.LOCK_STATES || (exports.LOCK_STATES = {}));
 /***
  * State of the garage as defined by Alarm.com
+ * @readonly
+ * @enum {number}
  */
 var GARAGE_STATES;
 (function (GARAGE_STATES) {
@@ -50,9 +60,22 @@ var GARAGE_STATES;
     GARAGE_STATES[GARAGE_STATES["OPEN"] = 1] = "OPEN";
     GARAGE_STATES[GARAGE_STATES["CLOSED"] = 2] = "CLOSED"; //double check
 })(GARAGE_STATES = exports.GARAGE_STATES || (exports.GARAGE_STATES = {}));
+/***
+ * State of the thermostat as defined by Alarm.com
+ * @readonly
+ * @enum {number}
+ */
+var THERMOSTAT_STATES;
+(function (THERMOSTAT_STATES) {
+    THERMOSTAT_STATES[THERMOSTAT_STATES["OFF"] = 1] = "OFF";
+    THERMOSTAT_STATES[THERMOSTAT_STATES["HEATING"] = 2] = "HEATING";
+    THERMOSTAT_STATES[THERMOSTAT_STATES["COOLING"] = 3] = "COOLING";
+    THERMOSTAT_STATES[THERMOSTAT_STATES["AUTO"] = 4] = "AUTO";
+})(THERMOSTAT_STATES = exports.THERMOSTAT_STATES || (exports.THERMOSTAT_STATES = {}));
 /***
  * Relation types as defined by Alarm.com.
  * Relationship types tell you what object is being sent from the API.
+ * @readonly
  */
 var REL_TYPES;
 (function (REL_TYPES) {

package/dist/_models/SystemState.d.ts

@@ -204,4 +204,8 @@ export declare enum RelationshipType {
     System = "systems/system",
     State = "devices/state-info"
 }
+export declare enum AutomationType {
+    PeakProtect = "automation/peak-protect",
+    RuleSuggestion = "automation/rules/ruleSuggestion"
+}
 export {};

package/dist/_models/SystemState.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RelationshipType = void 0;
+exports.AutomationType = exports.RelationshipType = void 0;
 var RelationshipType;
 (function (RelationshipType) {
     RelationshipType["Partition"] = "devices/partition";
@@ -17,3 +17,8 @@ var RelationshipType;
     RelationshipType["System"] = "systems/system";
     RelationshipType["State"] = "devices/state-info";
 })(RelationshipType = exports.RelationshipType || (exports.RelationshipType = {}));
+var AutomationType;
+(function (AutomationType) {
+    AutomationType["PeakProtect"] = "automation/peak-protect";
+    AutomationType["RuleSuggestion"] = "automation/rules/ruleSuggestion";
+})(AutomationType = exports.AutomationType || (exports.AutomationType = {}));

package/dist/index.d.ts

@@ -69,7 +69,7 @@ export declare function armStay(partitionID: string, authOpts: AuthOpts, opts: P
  *   delay.
  * @returns {Promise}
  */
-export declare function armAway(partitionID: string, authOpts: AuthOpts, opts: any): Promise<any>;
+export declare function armAway(partitionID: string, authOpts: AuthOpts, opts: PartitionActionOptions): Promise<any>;
 /**
  * Convenience Method:
  * Disarm a security system panel. NOTE: This call generally takes 20-30 seconds

package/dist/index.js

@@ -35,7 +35,7 @@ const SENSORS_URL = 'https://www.alarm.com/web/api/devices/sensors';
 const LIGHTS_URL = 'https://www.alarm.com/web/api/devices/lights/';
 const GARAGE_URL = 'https://www.alarm.com/web/api/devices/garageDoors/';
 const LOCKS_URL = 'https://www.alarm.com/web/api/devices/locks/';
-const CT_JSON = 'application/json;charset=UTF-8';
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const UA = `node-alarm-dot-com/${require('../package.json').version}`;
 // Exported methods ////////////////////////////////////////////////////////////
 /**
@@ -54,6 +54,7 @@ async function login(username, password, existingMfaToken) {
     // load initial alarm.com page to gather required hidden form fields
     await get(ADCLOGIN_URL)
         .then(res => {
+        /* eslint-disable @typescript-eslint/naming-convention */
         const loginObj = {
             '__EVENTTARGET': null,
             '__EVENTARGUMENT': null,
@@ -66,6 +67,7 @@ async function login(username, password, existingMfaToken) {
             'ctl00$ContentPlaceHolder1$loginform$txtUserName': username,
             'txtPassword': password
         };
+        /* eslint-enable @typescript-eslint/naming-convention */
         // build login form body
         loginFormBody = Object.keys(loginObj).map(k => encodeURIComponent(k) + '=' + encodeURIComponent(loginObj[k])).join('&');
     })
@@ -74,11 +76,13 @@ async function login(username, password, existingMfaToken) {
     });
     await (0, node_fetch_1.default)(ADCFORMLOGIN_URL, {
         method: 'POST',
+        /* eslint-disable @typescript-eslint/naming-convention */
         headers: {
             'Content-Type': 'application/x-www-form-urlencoded',
             'User-Agent': UA,
             'Cookie': `twoFactorAuthenticationId=${existingMfaToken};`
         },
+        /* eslint-enable @typescript-eslint/naming-convention */
         body: loginFormBody,
         redirect: 'manual'
     })
@@ -95,6 +99,7 @@ async function login(username, password, existingMfaToken) {
         throw new Error(`POST ${ADCFORMLOGIN_URL} failed: ${err.message || err}`);
     });
     await get(IDENTITIES_URL, {
+        /* eslint-disable @typescript-eslint/naming-convention */
         headers: {
             'Accept': 'application/vnd.api+json',
             'Cookie': loginCookies,
@@ -102,6 +107,7 @@ async function login(username, password, existingMfaToken) {
             'Referer': 'https://www.alarm.com/web/system/home',
             'User-Agent': UA
         }
+        /* eslint-enable @typescript-eslint/naming-convention */
     })
         .then(res => {
         // gather identities and systems
@@ -176,12 +182,44 @@ exports.getCurrentState = getCurrentState;
  * @param {Object} authOpts  Authentication object returned from the login.
  * @returns {Promise}
  */
-function getComponents(url, componentIDs, authOpts) {
+async function getComponents(url, componentIDs, authOpts) {
     const IDs = Array.isArray(componentIDs) ? componentIDs : [componentIDs];
-    let getUrl = `${url}?${IDs.map(id => `ids%5B%5D=${id}`).join('&')}`;
-    return authenticatedGet(getUrl, authOpts);
+    let requests = [];
+    if (IDs.length <= 50) {
+        const getUrl = `${url}?${IDs.map(id => `ids%5B%5D=${id}`).join('&')}`;
+        requests.push(authenticatedGet(getUrl, authOpts));
+    }
+    else {
+        // We have found that the Alarm.com API will return a 404 error when there is an excessive number of query parameters.
+        // We get around this by breaking up our GET calls into shorter URIs.
+        const shortenedUrls = [];
+        while (IDs.length > 50) {
+            const currentArray = IDs.splice(0, 50);
+            shortenedUrls.push(`${url}?${currentArray.map(id => `ids%5B%5D=${id}`).join('&')}`);
+        }
+        shortenedUrls.push(`${url}?${IDs.map(id => `ids%5B%5D=${id}`).join('&')}`);
+        requests = shortenedUrls.map(u => authenticatedGet(u, authOpts));
+    }
+    return await combineAPIDeviceAPICalls(requests);
 }
 exports.getComponents = getComponents;
+async function combineAPIDeviceAPICalls(apiCalls) {
+    const apiStateCalls = await Promise.all(apiCalls);
+    const stateToReturn = {
+        data: [],
+        included: []
+    };
+    for (const apiCall of apiStateCalls) {
+        for (const apiData of (apiCall.data)) {
+            stateToReturn.data.push(apiData);
+        }
+        for (const apiInclude of apiCall.included) {
+            stateToReturn.included.push(apiInclude);
+        }
+    }
+    stateToReturn.meta = apiStateCalls[0].meta;
+    return stateToReturn;
+}
 // Partition methods ///////////////////////////////////////////////////////////
 /**
  * Perform partition actions, e.g., armAway, armStay, disarm.
@@ -379,7 +417,7 @@ exports.setLockUnsecure = setLockUnsecure;
 /**
  * Get information for one or more garages.
  *
- * @param {string[]} garageIDs Array of Gagage ID strings.
+ * @param {string[]} garageIDs Array of Garage ID strings.
  * @param {Object} authOpts Authentication object returned from the `login`
  *   method.
  * @returns {Promise}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-alarm-dot-com",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.5",
   "betaVersion": "2.0.0",
   "description": "An interface module written in node.js to arm and disarm Alarm.com security systems.",
   "author": {
@@ -48,12 +48,15 @@
     "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
   },
   "dependencies": {
-    "@types/node-fetch": "^3.0.2",
     "@types/node": "^17.0.16",
+    "@types/node-fetch": "^3.0.2",
     "node-fetch": "^2.6.1",
     "semver": "^7.3.5"
   },
   "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.11.0",
+    "@typescript-eslint/parser": "^5.11.0",
+    "eslint": "8.22.0",
     "rimraf": "^3.0.2",
     "ts-node": "^10.5.0",
     "typescript": "^4.5.5",