node-alarm-dot-com 2.0.0-beta.7 → 2.1.0-beta.0

package/dist/_models/DeviceStates.d.ts

@@ -344,18 +344,18 @@ export interface ApiPartitionState extends ApiDeviceState {
         id: string;
         type: RelationshipType.Partition;
         attributes: {
-            'partitionId': number;
-            'state': SYSTEM_STATES;
-            'desiredState': SYSTEM_STATES;
-            'extendedArmingOptions': {
-                'Disarmed': [];
-                'ArmedStay': [];
-                'ArmedAway': [];
-                'ArmedNight': [];
+            partitionId: number;
+            state: SYSTEM_STATES;
+            desiredState: SYSTEM_STATES;
+            extendedArmingOptions: {
+                Disarmed: [];
+                ArmedStay: [];
+                ArmedAway: [];
+                ArmedNight: [];
             };
-            'invalidExtendedArmingOptions': {
-                'Disarmed': number[][];
-                'ArmedStay': number[][];
+            invalidExtendedArmingOptions: {
+                Disarmed: number[][];
+                ArmedStay: number[][];
                 ArmedAway: number[][];
                 ArmedNight: number[][];
             };
@@ -403,18 +403,18 @@ export interface PartitionState extends DeviceState {
     id: string;
     type: RelationshipType.Partition;
     attributes: {
-        'partitionId': number;
-        'state': SYSTEM_STATES;
-        'desiredState': SYSTEM_STATES;
-        'extendedArmingOptions': {
-            'Disarmed': [];
-            'ArmedStay': [];
-            'ArmedAway': [];
-            'ArmedNight': [];
+        partitionId: number;
+        state: SYSTEM_STATES;
+        desiredState: SYSTEM_STATES;
+        extendedArmingOptions: {
+            Disarmed: [];
+            ArmedStay: [];
+            ArmedAway: [];
+            ArmedNight: [];
         };
-        'invalidExtendedArmingOptions': {
-            'Disarmed': number[][];
-            'ArmedStay': number[][];
+        invalidExtendedArmingOptions: {
+            Disarmed: number[][];
+            ArmedStay: number[][];
             ArmedAway: number[][];
             ArmedNight: number[][];
         };
@@ -595,7 +595,7 @@ export interface ApiCameraState extends ApiDeviceState {
             httpsPort: number;
             shouldUseEntireImageForSnapshot: boolean;
             hasDdnsed: boolean;
-            usageProtocolMapping: {};
+            usageProtocolMapping: object;
             isVirtualCamera: boolean;
             supportsLiveView: boolean;
             forcedAspectRatio: null;
@@ -692,7 +692,7 @@ export interface CameraState extends DeviceState {
         httpsPort: number;
         shouldUseEntireImageForSnapshot: boolean;
         hasDdnsed: boolean;
-        usageProtocolMapping: {};
+        usageProtocolMapping: object;
         isVirtualCamera: boolean;
         supportsLiveView: boolean;
         forcedAspectRatio: null;
@@ -829,7 +829,7 @@ export interface ApiThermostatState extends ApiDeviceState {
             canAccessTroubleshootingWizard: boolean;
             troubleshootingWizard?: null;
             canBeAssociatedToVideoDevice: boolean;
-            associatedCameraDeviceIds: {};
+            associatedCameraDeviceIds: object;
             macAddress: string;
             manufacturer: string;
             isOAuth: boolean;
@@ -859,7 +859,7 @@ export interface ApiThermostatState extends ApiDeviceState {
                 };
             };
             thermostatSettingsTemplate: {
-                data?: any;
+                data?: unknown;
             };
             remoteTemperatureSensors: {
                 data: [];
@@ -868,7 +868,7 @@ export interface ApiThermostatState extends ApiDeviceState {
                 };
             };
             boilerControlSystem: {
-                data?: any;
+                data?: unknown;
             };
             valveSwitches: {
                 data: [];
@@ -979,7 +979,7 @@ export interface ThermostatState extends DeviceState {
         canAccessTroubleshootingWizard: boolean;
         troubleshootingWizard?: null;
         canBeAssociatedToVideoDevice: boolean;
-        associatedCameraDeviceIds: {};
+        associatedCameraDeviceIds: object;
         macAddress: string;
         manufacturer: string;
         isOAuth: boolean;
@@ -1009,7 +1009,7 @@ export interface ThermostatState extends DeviceState {
             };
         };
         thermostatSettingsTemplate: {
-            data?: any;
+            data?: unknown;
         };
         remoteTemperatureSensors: {
             data: [];
@@ -1018,7 +1018,7 @@ export interface ThermostatState extends DeviceState {
             };
         };
         boilerControlSystem: {
-            data?: any;
+            data?: unknown;
         };
         valveSwitches: {
             data: [];
@@ -1066,6 +1066,6 @@ export interface ApiDeviceState {
 export interface DeviceState {
     id: string;
     type: RelationshipType;
-    attributes: any;
-    relationships: any;
+    attributes: object;
+    relationships: object;
 }

package/dist/_models/PartitionActionOptions.d.ts

@@ -5,4 +5,5 @@ export interface PartitionActionOptions {
     noEntryDelay: boolean;
     silentArming: boolean;
     nightArming: boolean;
+    forceBypass: boolean;
 }

package/dist/_models/SensorType.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SensorType = void 0;
+/* eslint-disable @typescript-eslint/naming-convention */
 /**
  * Number indicating the type of sensor according to the Alarm.com API
  */

package/dist/_models/States.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.REL_TYPES = exports.THERMOSTAT_STATES = exports.GARAGE_STATES = exports.LOCK_STATES = exports.LIGHT_STATES = exports.SENSOR_STATES = exports.SYSTEM_STATES = void 0;
+/* eslint-disable @typescript-eslint/naming-convention */
 /***
  * State of the partition as defined by Alarm.com
  * @readonly

package/dist/index.js

@@ -57,25 +57,27 @@ async function login(username, password, existingMfaToken) {
     let loginFormBody, identities, systems;
     // load initial alarm.com page to gather required hidden form fields
     await get(ADCLOGIN_URL)
-        .then(res => {
+        .then((res) => {
         /* eslint-disable @typescript-eslint/naming-convention */
         const loginObj = {
-            '__EVENTTARGET': null,
-            '__EVENTARGUMENT': null,
-            '__VIEWSTATEENCRYPTED': null,
-            '__EVENTVALIDATION': res.body.match(/name="__EVENTVALIDATION".*?value="([^"]*)"/)[1],
-            '__VIEWSTATE': res.body.match(/name="__VIEWSTATE".*?value="([^"]*)"/)[1],
-            '__VIEWSTATEGENERATOR': res.body.match(/name="__VIEWSTATEGENERATOR".*?value="([^"]*)"/)[1],
-            '__PREVIOUSPAGE': res.body.match(/name="__PREVIOUSPAGE".*?value="([^"]*)"/)[1],
-            'IsFromNewSite': '1',
-            'ctl00$ContentPlaceHolder1$loginform$txtUserName': username,
-            'txtPassword': password
+            __EVENTTARGET: null,
+            __EVENTARGUMENT: null,
+            __VIEWSTATEENCRYPTED: null,
+            __EVENTVALIDATION: res.body.match(/name="__EVENTVALIDATION".*?value="([^"]*)"/)[1],
+            __VIEWSTATE: res.body.match(/name="__VIEWSTATE".*?value="([^"]*)"/)[1],
+            __VIEWSTATEGENERATOR: res.body.match(/name="__VIEWSTATEGENERATOR".*?value="([^"]*)"/)[1],
+            __PREVIOUSPAGE: res.body.match(/name="__PREVIOUSPAGE".*?value="([^"]*)"/)[1],
+            IsFromNewSite: '1',
+            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('&');
+        loginFormBody = Object.keys(loginObj)
+            .map((k) => encodeURIComponent(k) + '=' + encodeURIComponent(loginObj[k]))
+            .join('&');
     })
-        .catch(err => {
+        .catch((err) => {
         throw new Error(`GET ${ADCLOGIN_URL} failed: ${err.message || err}`);
     });
     await (0, node_fetch_1.default)(ADCFORMLOGIN_URL, {
@@ -84,14 +86,16 @@ async function login(username, password, existingMfaToken) {
         headers: {
             'Content-Type': 'application/x-www-form-urlencoded',
             'User-Agent': UA,
-            'Cookie': `twoFactorAuthenticationId=${existingMfaToken};`
+            Cookie: `twoFactorAuthenticationId=${existingMfaToken};`
         },
         /* eslint-enable @typescript-eslint/naming-convention */
         body: loginFormBody,
         redirect: 'manual'
     })
-        .then(res => {
-        loginCookies = res.headers.raw()['set-cookie'].map(c => c.split(';')[0]).join('; ');
+        .then((res) => {
+        loginCookies = res.headers
+            .raw()['set-cookie'].map((c) => c.split(';')[0])
+            .join('; ');
         // gather ajaxkey for session headers
         const re = /afg=([^;]+);/.exec(loginCookies);
         if (!re) {
@@ -105,20 +109,20 @@ async function login(username, password, existingMfaToken) {
     await get(IDENTITIES_URL, {
         /* eslint-disable @typescript-eslint/naming-convention */
         headers: {
-            'Accept': 'application/vnd.api+json',
-            'Cookie': loginCookies,
-            'ajaxrequestuniquekey': ajaxKey,
-            'Referer': 'https://www.alarm.com/web/system/home',
+            Accept: 'application/vnd.api+json',
+            Cookie: loginCookies,
+            ajaxrequestuniquekey: ajaxKey,
+            Referer: 'https://www.alarm.com/web/system/home',
             'User-Agent': UA
         }
         /* eslint-enable @typescript-eslint/naming-convention */
     })
-        .then(res => {
+        .then((res) => {
         // gather identities and systems
         identities = res.body;
         systems = (identities.data || []).map((d) => getValue(d, 'relationships.selectedSystem.data.id'));
     })
-        .catch(err => {
+        .catch((err) => {
         throw new Error(`GET ${IDENTITIES_URL} failed: ${err.message || err}`);
     });
     return {
@@ -146,36 +150,38 @@ async function getCurrentState(systemID, authOpts) {
     const components = new Map();
     // push the results of getComponents into the components
     // Now we go through and get detailed information about all devices
-    const partitionIDs = rels.partitions.data.map(partition => partition.id);
+    const partitionIDs = rels.partitions.data.map((partition) => partition.id);
     if (typeof partitionIDs[0] !== 'undefined') {
         components.set('partitions', await getComponents(PARTITIONS_URL, partitionIDs, authOpts));
     }
-    const sensorIDs = rels.sensors.data.map(sensor => sensor.id);
+    const sensorIDs = rels.sensors.data.map((sensor) => sensor.id);
     if (typeof sensorIDs[0] !== 'undefined') {
         components.set('sensors', await getComponents(SENSORS_URL, sensorIDs, authOpts));
     }
-    const lightIDs = rels.lights.data.map(light => light.id);
+    const lightIDs = rels.lights.data.map((light) => light.id);
     if (typeof lightIDs[0] !== 'undefined') {
         components.set('lights', await getComponents(LIGHTS_URL, lightIDs, authOpts));
     }
-    const lockIDs = rels.locks.data.map(lock => lock.id);
+    const lockIDs = rels.locks.data.map((lock) => lock.id);
     if (typeof lockIDs[0] !== 'undefined') {
         components.set('locks', await getComponents(LOCKS_URL, lockIDs, authOpts));
     }
-    const garageIDs = rels.garageDoors.data.map(garage => garage.id);
+    const garageIDs = rels.garageDoors.data.map((garage) => garage.id);
     if (typeof garageIDs[0] !== 'undefined') {
         components.set('garages', await getComponents(GARAGE_URL, garageIDs, authOpts));
     }
-    return ({
+    return {
         id: res.data.id,
         attributes: res.data.attributes,
-        partitions: components.has('partitions') ? components.get('partitions').data : [],
+        partitions: components.has('partitions')
+            ? components.get('partitions').data
+            : [],
         sensors: components.has('sensors') ? components.get('sensors').data : [],
         lights: components.has('lights') ? components.get('lights').data : [],
         locks: components.has('locks') ? components.get('locks').data : [],
         garages: components.has('garages') ? components.get('garages').data : [],
         relationships: rels
-    });
+    };
 }
 exports.getCurrentState = getCurrentState;
 /**
@@ -190,7 +196,7 @@ async function getComponents(url, componentIDs, authOpts) {
     const IDs = Array.isArray(componentIDs) ? componentIDs : [componentIDs];
     let requests = [];
     if (IDs.length <= 50) {
-        const getUrl = `${url}?${IDs.map(id => `ids%5B%5D=${id}`).join('&')}`;
+        const getUrl = `${url}?${IDs.map((id) => `ids%5B%5D=${id}`).join('&')}`;
         requests.push(authenticatedGet(getUrl, authOpts));
     }
     else {
@@ -199,10 +205,10 @@ async function getComponents(url, componentIDs, authOpts) {
         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}?${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));
+        shortenedUrls.push(`${url}?${IDs.map((id) => `ids%5B%5D=${id}`).join('&')}`);
+        requests = shortenedUrls.map((u) => authenticatedGet(u, authOpts));
     }
     return await combineAPIDeviceAPICalls(requests);
 }
@@ -214,7 +220,7 @@ async function combineAPIDeviceAPICalls(apiCalls) {
         included: []
     };
     for (const apiCall of apiStateCalls) {
-        for (const apiData of (apiCall.data)) {
+        for (const apiData of apiCall.data) {
             stateToReturn.data.push(apiData);
         }
         for (const apiInclude of apiCall.included) {
@@ -237,7 +243,8 @@ function partitionAction(partitionID, action, authOpts, opts) {
     opts = opts || {
         noEntryDelay: false,
         silentArming: false,
-        nightArming: false
+        nightArming: false,
+        forceBypass: false
     };
     const url = `${PARTITIONS_URL}${partitionID}/${action}`;
     const body = {
@@ -247,9 +254,12 @@ function partitionAction(partitionID, action, authOpts, opts) {
     };
     // We only want to set nightArming when told to do so
     //This is because calling nightArm when not supported will break the action
-    if (opts.nightArming) {
+    if (opts.nightArming === true) {
         body['nightArming'] = true;
     }
+    if (opts.forceBypass === true) {
+        body['forceBypass'] = true;
+    }
     const postOpts = Object.assign({}, authOpts, { body });
     return authenticatedPost(url, postOpts);
 }
@@ -430,7 +440,7 @@ function getGarages(garageIDs, authOpts) {
     if (!Array.isArray(garageIDs)) {
         garageIDs = [garageIDs];
     }
-    const query = garageIDs.map(id => `ids%5B%5D=${id}`).join('&');
+    const query = garageIDs.map((id) => `ids%5B%5D=${id}`).join('&');
     const url = `${GARAGE_URL}?${query}`;
     return authenticatedGet(url, authOpts);
 }
@@ -517,7 +527,11 @@ async function get(url, opts) {
         status = res.status;
         resHeaders = res.headers;
         const type = res.headers.get('content-type') || '';
-        const body = await (type.indexOf('json') !== -1 ? (res.status === 204 ? {} : res.json()) : res.text());
+        const body = await (type.indexOf('json') !== -1
+            ? res.status === 204
+                ? {}
+                : res.json()
+            : res.text());
         if (status === 409) {
             throw new Error('Two factor is enabled on this account but not setup in the plugin.' +
                 ' See the wiki for details');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-alarm-dot-com",
-  "version": "2.0.0-beta.7",
-  "betaVersion": "2.0.0",
+  "version": "2.1.0-beta.0",
+  "betaVersion": "2.1.0",
   "description": "An interface module written in node.js to arm and disarm Alarm.com security systems.",
   "author": {
     "name": "Chase Lau",