node-alarm-dot-com 1.11.0-beta.6 → 2.0.0-beta.0

package/dist/index.d.ts

@@ -31,7 +31,7 @@ export declare function login(username: string, password: string, existingMfaTok
  * @param {Object} authOpts  Authentication object returned from the login.
  * @returns {Promise}
  */
-export declare function getCurrentState(systemID: string, authOpts: any): Promise<FlattenedSystemState>;
+export declare function getCurrentState(systemID: string, authOpts: AuthOpts): Promise<FlattenedSystemState>;
 /**
  * Get information about groups of components e.g., sensors, lights, locks, garages, etc.
  *
@@ -86,9 +86,10 @@ export declare function disarm(partitionID: string, authOpts: AuthOpts): Promise
  * @param {string} lightID  Light ID string.
  * @param {number} brightness  An integer, 1-100, indicating brightness.
  * @param {Object} authOpts  Authentication object returned from the login.
+ * @param {boolean} isDimmer  Indicates whether or not light is dimmable.
  * @returns {Promise}
  */
-export declare function setLightOn(lightID: string, authOpts: AuthOpts, brightness: number): Promise<any>;
+export declare function setLightOn(lightID: string, authOpts: AuthOpts, brightness: number, isDimmer: boolean): Promise<any>;
 /**
  * Convenience Method:
  * Sets a light to OFF. The brightness level is ignored.
@@ -96,9 +97,10 @@ export declare function setLightOn(lightID: string, authOpts: AuthOpts, brightne
  * @param {string} lightID  Light ID string.
  * @param {number} brightness  An integer, 1-100, indicating brightness. Ignored.
  * @param {Object} authOpts  Authentication object returned from the login.
+ * @param {boolean} isDimmer  Indicates whether or not light is dimmable.
  * @returns {Promise}
  */
-export declare function setLightOff(lightID: string, authOpts: AuthOpts, brightness: number): Promise<any>;
+export declare function setLightOff(lightID: string, authOpts: AuthOpts, brightness: number, isDimmer: boolean): Promise<any>;
 /**
  * Convenience Method:
  * Sets a lock to "locked" (SECURED).

package/dist/index.js

@@ -46,17 +46,13 @@ const UA = `node-alarm-dot-com/${require('../package.json').version}`;
  * @param {string} existingMfaToken MFA token from browser used to bypass MFA.
  * @returns {Promise}
  */
-function login(username, password, existingMfaToken) {
+async function login(username, password, existingMfaToken) {
     let loginCookies;
     let ajaxKey;
     let loginFormBody, identities, systems;
     // load initial alarm.com page to gather required hidden form fields
-    return get(ADCLOGIN_URL)
-        .catch(err => {
-        throw new Error(`GET ${ADCLOGIN_URL} failed: ${err.message || err}`);
-    })
+    await get(ADCLOGIN_URL)
         .then(res => {
-        // build login form body
         const loginObj = {
             '__EVENTTARGET': null,
             '__EVENTARGUMENT': null,
@@ -69,56 +65,57 @@ function login(username, password, existingMfaToken) {
             'ctl00$ContentPlaceHolder1$loginform$txtUserName': username,
             'txtPassword': password
         };
+        // build login form body
         loginFormBody = Object.keys(loginObj).map(k => encodeURIComponent(k) + '=' + encodeURIComponent(loginObj[k])).join('&');
-        // submit login form and gather cookies/keys for session
-        return node_fetch_1.default(ADCFORMLOGIN_URL, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/x-www-form-urlencoded',
-                'User-Agent': UA,
-                'Cookie': `twoFactorAuthenticationId=${existingMfaToken};`
-            },
-            body: loginFormBody,
-            redirect: 'manual'
-        })
-            .catch((err) => {
-            throw new Error(`POST ${ADCFORMLOGIN_URL} failed: ${err.message || err}`);
-        })
-            .then((res) => {
-            // gather cookies for session
-            loginCookies = res.headers.raw()['set-cookie'].map(c => c.split(';')[0]).join('; ');
-            // gather ajaxkey for session headers
-            const re = /afg=([^;]+);/.exec(loginCookies);
-            if (!re)
-                throw new Error(`No afg cookie: ${loginCookies}`);
-            ajaxKey = re[1];
-            // request identities and systems for account
-            return get(IDENTITIES_URL, {
-                headers: {
-                    'Accept': 'application/vnd.api+json',
-                    'Cookie': loginCookies,
-                    'ajaxrequestuniquekey': ajaxKey,
-                    'Referer': 'https://www.alarm.com/web/system/home',
-                    'User-Agent': UA
-                }
-            })
-                .catch(err => {
-                throw new Error(`GET ${IDENTITIES_URL} failed: ${err.message || err}`);
-            })
-                .then(res => {
-                // gather identities and systems
-                identities = res.body;
-                systems = (identities.data || []).map((d) => getValue(d, 'relationships.selectedSystem.data.id'));
-                // finally return session/account object for polling and manipulation
-                return {
-                    cookie: loginCookies,
-                    ajaxKey: ajaxKey,
-                    systems: systems,
-                    identities: identities
-                };
-            });
-        });
+    })
+        .catch(err => {
+        throw new Error(`GET ${ADCLOGIN_URL} failed: ${err.message || err}`);
     });
+    await (0, node_fetch_1.default)(ADCFORMLOGIN_URL, {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/x-www-form-urlencoded',
+            'User-Agent': UA,
+            'Cookie': `twoFactorAuthenticationId=${existingMfaToken};`
+        },
+        body: loginFormBody,
+        redirect: 'manual'
+    })
+        .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) {
+            throw new Error(`No afg cookie: ${loginCookies}`);
+        }
+        ajaxKey = re[1];
+    })
+        .catch((err) => {
+        throw new Error(`POST ${ADCFORMLOGIN_URL} failed: ${err.message || err}`);
+    });
+    await get(IDENTITIES_URL, {
+        headers: {
+            'Accept': 'application/vnd.api+json',
+            'Cookie': loginCookies,
+            'ajaxrequestuniquekey': ajaxKey,
+            'Referer': 'https://www.alarm.com/web/system/home',
+            'User-Agent': UA
+        }
+    })
+        .then(res => {
+        // gather identities and systems
+        identities = res.body;
+        systems = (identities.data || []).map((d) => getValue(d, 'relationships.selectedSystem.data.id'));
+    })
+        .catch(err => {
+        throw new Error(`GET ${IDENTITIES_URL} failed: ${err.message || err}`);
+    });
+    return {
+        cookie: loginCookies,
+        ajaxKey: ajaxKey,
+        systems: systems,
+        identities: identities
+    };
 }
 exports.login = login;
 /**
@@ -131,43 +128,42 @@ exports.login = login;
  * @param {Object} authOpts  Authentication object returned from the login.
  * @returns {Promise}
  */
-function getCurrentState(systemID, authOpts) {
+async function getCurrentState(systemID, authOpts) {
     // This call to the systems endpoint retrieves an overview of all devices in a system
-    return authenticatedGet(SYSTEM_URL + systemID, authOpts).then(async (res) => {
-        const rels = res.data.relationships;
-        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(p => p.id);
-        if (typeof partitionIDs[0] != 'undefined') {
-            components.set('partitions', await getComponents(PARTITIONS_URL, partitionIDs, authOpts));
-        }
-        const sensorIDs = rels.sensors.data.map(s => s.id);
-        if (typeof sensorIDs[0] != 'undefined') {
-            components.set('sensors', await getComponents(SENSORS_URL, sensorIDs, authOpts));
-        }
-        const lightIDs = rels.lights.data.map(l => l.id);
-        if (typeof lightIDs[0] != 'undefined') {
-            components.set('lights', await getComponents(LIGHTS_URL, lightIDs, authOpts));
-        }
-        const lockIDs = rels.locks.data.map(l => l.id);
-        if (typeof lockIDs[0] != 'undefined') {
-            components.set('locks', await getComponents(LOCKS_URL, lockIDs, authOpts));
-        }
-        const garageIDs = rels.garageDoors.data.map(g => g.id);
-        if (typeof garageIDs[0] != 'undefined') {
-            components.set('garages', await getComponents(GARAGE_URL, garageIDs, authOpts));
-        }
-        return {
-            id: res.data.id,
-            attributes: res.data.attributes,
-            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
-        };
+    const res = await authenticatedGet(SYSTEM_URL + systemID, authOpts);
+    const rels = res.data.relationships;
+    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);
+    if (typeof partitionIDs[0] !== 'undefined') {
+        components.set('partitions', await getComponents(PARTITIONS_URL, partitionIDs, authOpts));
+    }
+    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);
+    if (typeof lightIDs[0] !== 'undefined') {
+        components.set('lights', await getComponents(LIGHTS_URL, lightIDs, authOpts));
+    }
+    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);
+    if (typeof garageIDs[0] !== 'undefined') {
+        components.set('garages', await getComponents(GARAGE_URL, garageIDs, authOpts));
+    }
+    return ({
+        id: res.data.id,
+        attributes: res.data.attributes,
+        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;
@@ -266,14 +262,30 @@ exports.disarm = disarm;
 // about any of the components, sensors included.
 // Light methods ///////////////////////////////////////////////////////////////
 /**
- * Perform light actions, e.g., turn on, turn off, change brightness level.
+ * Perform non-dimmable light actions, i.e. turn on, turn off
+ *
+ * @param {string} lightID  Light ID string.
+ * @param {string} action  Action (verb) to perform on the light.
+ * @param {Object} authOpts  Authentication object returned from the login.
+ */
+function lightAction(lightID, authOpts, action) {
+    const url = `${LIGHTS_URL}${lightID}/${action}`;
+    const postOpts = Object.assign({}, authOpts, {
+        body: {
+            statePollOnly: false
+        }
+    });
+    return authenticatedPost(url, postOpts);
+}
+/**
+ * Perform dimmable light actions, e.g., turn on, turn off, change brightness level.
  *
  * @param {string} lightID  Light ID string.
  * @param {string} action  Action (verb) to perform on the light.
  * @param {Object} authOpts  Authentication object returned from the login.
  * @param {number} brightness  An integer, 1-100, indicating brightness.
  */
-function lightAction(lightID, authOpts, brightness, action) {
+function dimmerAction(lightID, authOpts, brightness, action) {
     const url = `${LIGHTS_URL}${lightID}/${action}`;
     const postOpts = Object.assign({}, authOpts, {
         body: {
@@ -290,10 +302,16 @@ function lightAction(lightID, authOpts, brightness, action) {
  * @param {string} lightID  Light ID string.
  * @param {number} brightness  An integer, 1-100, indicating brightness.
  * @param {Object} authOpts  Authentication object returned from the login.
+ * @param {boolean} isDimmer  Indicates whether or not light is dimmable.
  * @returns {Promise}
  */
-function setLightOn(lightID, authOpts, brightness) {
-    return lightAction(lightID, authOpts, brightness, 'turnOn');
+function setLightOn(lightID, authOpts, brightness, isDimmer) {
+    if (isDimmer) {
+        return dimmerAction(lightID, authOpts, brightness, 'turnOn');
+    }
+    else {
+        return lightAction(lightID, authOpts, 'turnOn');
+    }
 }
 exports.setLightOn = setLightOn;
 /**
@@ -303,10 +321,16 @@ exports.setLightOn = setLightOn;
  * @param {string} lightID  Light ID string.
  * @param {number} brightness  An integer, 1-100, indicating brightness. Ignored.
  * @param {Object} authOpts  Authentication object returned from the login.
+ * @param {boolean} isDimmer  Indicates whether or not light is dimmable.
  * @returns {Promise}
  */
-function setLightOff(lightID, authOpts, brightness) {
-    return lightAction(lightID, authOpts, brightness, 'turnOff');
+function setLightOff(lightID, authOpts, brightness, isDimmer) {
+    if (isDimmer) {
+        return dimmerAction(lightID, authOpts, brightness, 'turnOff');
+    }
+    else {
+        return lightAction(lightID, authOpts, 'turnOff');
+    }
 }
 exports.setLightOff = setLightOff;
 // Lock methods ////////////////////////////////////////////////////////////////
@@ -360,8 +384,9 @@ exports.setLockUnsecure = setLockUnsecure;
  * @returns {Promise}
  */
 function getGarages(garageIDs, authOpts) {
-    if (!Array.isArray(garageIDs))
+    if (!Array.isArray(garageIDs)) {
         garageIDs = [garageIDs];
+    }
     const query = garageIDs.map(id => `ids%5B%5D=${id}`).join('&');
     const url = `${GARAGE_URL}?${query}`;
     return authenticatedGet(url, authOpts);
@@ -405,13 +430,15 @@ function openGarage(garageID, authOpts) {
 exports.openGarage = openGarage;
 // Helper methods //////////////////////////////////////////////////////////////
 function getValue(data, path) {
-    if (typeof path === 'string')
+    if (typeof path === 'string') {
         path = path.split('.');
-    for (let i = 0; typeof data === 'object' && i < path.length; i++)
+    }
+    for (let i = 0; typeof data === 'object' && i < path.length; i++) {
         data = data[path[i]];
+    }
     return data;
 }
-function authenticatedGet(url, opts) {
+async function authenticatedGet(url, opts) {
     opts = opts || {};
     opts.headers = opts.headers || {};
     opts.headers.Accept = 'application/vnd.api+json';
@@ -419,9 +446,10 @@ function authenticatedGet(url, opts) {
     opts.headers.Cookie = opts.cookie;
     opts.headers.Referer = HOME_URL;
     opts.headers['User-Agent'] = UA;
-    return get(url, opts).then(res => res.body);
+    const res = await get(url, opts);
+    return res.body;
 }
-function authenticatedPost(url, opts) {
+async function authenticatedPost(url, opts) {
     opts = opts || {};
     opts.headers = opts.headers || {};
     opts.headers.Accept = 'application/vnd.api+json';
@@ -430,64 +458,62 @@ function authenticatedPost(url, opts) {
     opts.headers.Referer = HOME_URL;
     opts.headers['User-Agent'] = UA;
     opts.headers['Content-Type'] = 'application/json; charset=UTF-8';
-    return post(url, opts).then(res => res.body);
+    const res = await post(url, opts);
+    return res.body;
 }
-function get(url, opts) {
+async function get(url, opts) {
     opts = opts || {};
     let status;
     let resHeaders;
-    return node_fetch_1.default(url, {
-        method: 'GET',
-        redirect: 'manual',
-        headers: opts.headers
-    })
-        .then(res => {
+    try {
+        const res = await (0, node_fetch_1.default)(url, {
+            method: 'GET',
+            redirect: 'manual',
+            headers: opts.headers
+        });
         status = res.status;
         resHeaders = res.headers;
         const type = res.headers.get('content-type') || '';
-        // If response is type JSON,
-        return type.indexOf('json') !== -1 ? (res.status === 204 ? {} : res.json()) : res.text();
-    })
-        .then((body) => {
+        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');
         }
-        if (status >= 400)
+        if (status >= 400) {
             throw new Error(body.Message || body || status);
+        }
         return {
             headers: resHeaders,
             body: body
         };
-    })
-        .catch(err => {
+    }
+    catch (err) {
         throw new Error(`GET ${url} failed: ${err.message || err}`);
-    });
+    }
 }
-function post(url, opts) {
+async function post(url, opts) {
     opts = opts || {};
     let status;
     let resHeaders;
-    return node_fetch_1.default(url, {
-        method: 'POST',
-        redirect: 'manual',
-        body: opts.body ? JSON.stringify(opts.body) : undefined,
-        headers: opts.headers
-    })
-        .then(res => {
+    try {
+        const res = await (0, node_fetch_1.default)(url, {
+            method: 'POST',
+            redirect: 'manual',
+            body: opts.body ? JSON.stringify(opts.body) : undefined,
+            headers: opts.headers
+        });
         status = res.status;
         resHeaders = res.headers;
-        return (res.status === 204 ? {} : res.json());
-    })
-        .then((json) => {
-        if (status !== 200)
+        const json = await (res.status === 204 ? {} : res.json());
+        if (status !== 200) {
             throw new Error(json.Message || status);
+        }
         return {
             headers: resHeaders,
             body: json
         };
-    })
-        .catch(err => {
+    }
+    catch (err) {
         throw new Error(`POST ${url} failed: ${err.message || err}`);
-    });
+    }
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "node-alarm-dot-com",
-  "version": "1.11.0-beta.6",
-  "betaVersion": "1.11.0",
+  "version": "2.0.0-beta.0",
+  "betaVersion": "2.0.0",
   "description": "An interface module written in node.js to arm and disarm Alarm.com security systems.",
   "author": {
-    "name": "Mike Kormendy",
-    "email": "mike@somethinginteractive.com"
+    "name": "Chase Lau",
+    "url": "https://github.com/chase9"
   },
   "license": "MIT",
   "keywords": [
@@ -45,17 +45,18 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "engines": {
-    "node": ">=0.12.0"
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
   },
   "dependencies": {
-    "@types/node-fetch": "^2.5.10",
+    "@types/node-fetch": "^3.0.2",
+    "@types/node": "^17.0.16",
     "node-fetch": "^2.6.1",
     "semver": "^7.3.5"
   },
   "devDependencies": {
     "rimraf": "^3.0.2",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.2.4",
-    "yargs": "^17.0.1"
+    "ts-node": "^10.5.0",
+    "typescript": "^4.5.5",
+    "yargs": "^17.3.1"
   }
 }