node-alarm-dot-com 2.1.0-beta.5 → 2.1.0-beta.7

package/dist/_models/DeviceStates.d.ts

@@ -1,7 +1,7 @@
 import { Relationship } from './IdentityResponse';
-import { AutomationType, RelationshipType } from './SystemState';
-import { GARAGE_STATES, LIGHT_STATES, LOCK_STATES, SENSOR_STATES, SYSTEM_STATES, THERMOSTAT_STATES } from './States';
 import { SensorType } from './SensorType';
+import { GARAGE_STATES, LIGHT_STATES, LOCK_STATES, SENSOR_STATES, SYSTEM_STATES, THERMOSTAT_STATES } from './States';
+import { AutomationType, RelationshipType } from './SystemState';
 export interface ApiLightState extends ApiDeviceState {
     data: {
         id: string;
@@ -1052,6 +1052,72 @@ export interface ThermostatState extends DeviceState {
         };
     };
 }
+export interface ApiAccessControlState extends ApiDeviceState {
+    data: {
+        id: string;
+        type: RelationshipType.AccessControl;
+        attributes: {
+            managedDeviceType: number;
+            state: LOCK_STATES;
+            desiredState: LOCK_STATES;
+            canBuzz: boolean;
+            canLockUnlock: boolean;
+            readerAntiPassbackEnabled: boolean;
+            apbDelay: number;
+            twoPersonAccessEnabled: boolean;
+            hasMiwaLock: boolean;
+            twoPersonAccessSupported: boolean;
+            hasState: boolean;
+            canBeRenamed: boolean;
+            canBeDeleted: boolean;
+            canAccessWebSettings: boolean;
+            canAccessAppSettings: boolean;
+            webSettings: number;
+            canAccessTroubleshootingWizard: boolean;
+            troubleshootingWizard: null;
+            addDeviceResource: number;
+            canBeAssociatedToVideoDevice: boolean;
+            associatedCameraDeviceIds: {};
+            macAddress: string;
+            manufacturer: string;
+            isAssignedToCareReceiver: boolean;
+            isOAuth: boolean;
+            isZWave: boolean;
+            supportsCommandClassBasic: boolean;
+            isMalfunctioning: boolean;
+            isZWaveWakeupNode: boolean;
+            unitSupportsRemovingWakeupNode: boolean;
+            primaryAssociatedDeviceIds: null;
+            canBeSaved: boolean;
+            canChangeDescription: boolean;
+            description: string;
+            deviceModelId: number;
+            canConfirmStateChange: boolean;
+            canReceiveCommands: boolean;
+            remoteCommandsEnabled: boolean;
+            hasPermissionToChangeState: boolean;
+            deviceIcon: {
+                "icon": number;
+            };
+            batteryLevelNull: null;
+            batteryLevelClassification: null;
+        };
+        relationships: {
+            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/IdentityResponse.d.ts

@@ -3,107 +3,125 @@
  * It's then parsed and the authentication token stored for future use.
  */
 export interface IdentityResponse {
-    data: {
-        id: number;
-        type: 'identity';
-        attributes: {
-            timezone: string;
-            initialSetupSteps: [];
-            helpTours: number[];
-            logoSource: string;
-            logoName: string;
-            dealerPath: string;
-            favIconUrl: string;
-            poweredByPath: string;
-            copyrightInfo: string;
-            trademarkInfo: string;
-            hasCompletedOnboarding: boolean;
-            isEnterprise: boolean;
-            isAccessControl: boolean;
-            isCommercial: boolean;
-            isPointCentral: boolean;
-            isPcRpm: boolean;
-            isPointCentralSTR: boolean;
-            isMobileApp: boolean;
-            useWebsockets: boolean;
-            websocketServiceEndpoint: string;
-            enabledWebsocketMessageHandlers: null;
-            canBrowserEnableFlashDirectly: boolean;
-            supportsEnableFlashPrompt: boolean;
-            supportedNativeBridgeFeatures: null;
-            hasTroubleConditionsService: boolean;
-            errorReportingConfiguration: {
-                providerName: string;
-                apiKey: null;
-                scriptUrl: null;
-                isEnabled: boolean;
-                machineName: string;
-                logErrorsToConsole: boolean;
-                showNotificationOnError: boolean;
-                redirectToErrorRouteOnUnhandledError: boolean;
-                environment: string;
-                servicePlan: string;
-            };
-            enableHomeScreenConfiguration: boolean;
-            accountType: number;
-            externalTerms: string;
-            externalPrivacyPolicy: string;
-            applicationSessionProperties: {
-                shouldTimeout: boolean;
-                keepAliveUrl: string;
-                enableKeepAlive: boolean;
-                logoutTimeoutMs: number;
-                inactivityWarningTimeoutMs: number;
-            };
-            postLoginRedirect: null;
-            canDonateClips: boolean;
-            hasInternalBetaAccess: boolean;
-        };
-        relationships: {
-            dealer: {
-                data: Relationship;
-            };
-            primaryColor: {
-                data: Relationship;
-            };
-            secondaryColor: {
-                data: Relationship;
-            };
-            navColor: {
-                data: Relationship;
-            };
-            profile: {
-                data: Relationship;
-            };
-            accountInformation: {
-                data: Relationship;
-            };
-            availableRouteItems: {
-                data: Relationship[];
-                meta: {
-                    count: string;
-                };
-            };
-            wizard: {
-                data: Relationship[] | null;
-            };
-            clipDonationAgreement: {
-                data: Relationship;
-            };
-            selectedSystem: {
-                data: Relationship;
-            };
-            selectedSystemGroup: {
-                data: Relationship | null;
-            };
-        };
-    };
+    data: IdentityData[];
     included: any[];
     meta: {
         transformer_version: string;
     };
 }
+export interface IdentityData {
+    id: number;
+    type: 'identity';
+    attributes: {
+        timezone: string;
+        preferredTimezone: string;
+        initialSetupSteps: [];
+        helpTours: number[];
+        logoSource: string;
+        logoName: string;
+        dealerPath: string;
+        mobileAppBrand: string;
+        favIconUrl: string;
+        poweredByPath: string;
+        copyrightInfo: string;
+        trademarkInfo: string;
+        hasCompletedOnboarding: boolean;
+        isEnterprise: boolean;
+        isAccessControl: boolean;
+        isCommercial: boolean;
+        isPointCentral: boolean;
+        isPcRpm: boolean;
+        isPointCentralSTR: boolean;
+        isPointCentralAccessControl: boolean;
+        isPointCentralAccessControlSTR: boolean;
+        isUsingEnterpriseLocationsCache: boolean;
+        isMobileApp: boolean;
+        isMobileTechApp: boolean;
+        isVisualIdentification: boolean;
+        isEscalatedEvents: boolean;
+        isWindowsDevice: boolean;
+        applicationBuildNumber: number;
+        canViewHighlights: boolean;
+        canViewVideoClips: boolean;
+        hasAccessToAudioForNonDoorbellCameras: boolean;
+        hasSmartArmingSensorBased: boolean;
+        isSmartDisarmEligible: boolean;
+        canEditNoiseSensors: boolean;
+        isManagedAccessAccount: boolean;
+        supportedNativeBridgeFeatures: null;
+        supportedNativeViewTransitions: null;
+        supportedDisplayModeFeatures: null;
+        hasTroubleConditionsService: boolean;
+        errorReportingConfiguration: {
+            providerName: string;
+            apiKey: null;
+            scriptUrl: null;
+            isEnabled: boolean;
+            machineName: string;
+            logErrorsToConsole: boolean;
+            showNotificationOnError: boolean;
+            redirectToErrorRouteOnUnhandledError: boolean;
+            environment: string;
+            servicePlan: string;
+        };
+        enableHomeScreenConfiguration: boolean;
+        accountType: number;
+        externalTerms: string;
+        externalPrivacyPolicy: string;
+        shouldHidePrivacyPolicyLink: boolean;
+        shouldHideTermsAndConditionsLink: boolean;
+        applicationSessionProperties: {
+            shouldTimeout: boolean;
+            keepAliveUrl: string;
+            enableKeepAlive: boolean;
+            logoutTimeoutMs: number;
+            inactivityWarningTimeoutMs: number;
+        };
+        postLoginRedirect: null;
+        localizeTempUnitsToCelsius: boolean;
+        canDonateClips: boolean;
+        hasInternalBetaAccess: boolean;
+    };
+    relationships: {
+        dealer: {
+            data: Relationship;
+        };
+        primaryColor: {
+            data: Relationship;
+        };
+        secondaryColor: {
+            data: Relationship;
+        };
+        navColor: {
+            data: Relationship;
+        };
+        profile: {
+            data: Relationship;
+        };
+        accountInformation: {
+            data: Relationship;
+        };
+        availableRouteItems: {
+            data: Relationship[];
+            meta: {
+                count: string;
+            };
+        };
+        wizard: {
+            data: Relationship[] | null;
+        };
+        clipDonationAgreement: {
+            data: Relationship;
+        };
+        selectedSystem: {
+            data: Relationship;
+        };
+        selectedSystemGroup: {
+            data: Relationship | null;
+        };
+    };
+}
 export interface Relationship {
     id: string;
-    type: 'devices/partition' | 'devices/lock' | 'video/camera' | 'devices/garage-door' | 'automation/scene' | 'devices/sensor' | 'devices/light' | 'devices/thermostat' | 'geolocation/geo-device' | 'geolocation/fence' | 'systems/configuration' | 'navigation/route-item' | 'dealers/dealer' | 'ui/color' | 'profile/profile' | 'accountInformation/account-information';
+    type: 'devices/partition' | 'devices/lock' | 'video/camera' | 'devices/garage-door' | 'automation/scene' | 'devices/sensor' | 'devices/light' | 'devices/thermostat' | 'geolocation/geo-device' | 'geolocation/fence' | 'systems/configuration' | 'navigation/route-item' | 'devices/access-control-access-point-device' | 'dealers/dealer' | 'ui/color' | 'profile/profile' | 'accountInformation/account-information';
 }

package/dist/_models/States.d.ts

@@ -78,5 +78,6 @@ export declare enum REL_TYPES {
     THERMOSTAT = "devices/thermostat",
     GEO_DEVICE = "geolocation/geo-device",
     GEO_FENCE = "geolocation/fence",
-    SCENE = "automation/scene"
+    SCENE = "automation/scene",
+    ACCESS_CONTROL = "devices/access-control-access-point-device"
 }

package/dist/_models/States.js

@@ -91,4 +91,5 @@ var REL_TYPES;
     REL_TYPES["GEO_DEVICE"] = "geolocation/geo-device";
     REL_TYPES["GEO_FENCE"] = "geolocation/fence";
     REL_TYPES["SCENE"] = "automation/scene";
+    REL_TYPES["ACCESS_CONTROL"] = "devices/access-control-access-point-device";
 })(REL_TYPES = exports.REL_TYPES || (exports.REL_TYPES = {}));

package/dist/_models/SystemState.d.ts

@@ -203,7 +203,8 @@ export declare enum RelationshipType {
     GeoFence = "geolocation/fence",
     SystemConfig = "systems/configuration",
     System = "systems/system",
-    State = "devices/state-info"
+    State = "devices/state-info",
+    AccessControl = "devices/access-control-access-point-device"
 }
 export declare enum AutomationType {
     PeakProtect = "automation/peak-protect",

package/dist/_models/SystemState.js

@@ -16,6 +16,7 @@ var RelationshipType;
     RelationshipType["SystemConfig"] = "systems/configuration";
     RelationshipType["System"] = "systems/system";
     RelationshipType["State"] = "devices/state-info";
+    RelationshipType["AccessControl"] = "devices/access-control-access-point-device";
 })(RelationshipType = exports.RelationshipType || (exports.RelationshipType = {}));
 var AutomationType;
 (function (AutomationType) {

package/dist/index.d.ts

@@ -3,9 +3,10 @@
  */
 import { AuthOpts } from './_models/AuthOpts';
 import { ApiDeviceState } from './_models/DeviceStates';
+import { IdentityResponse } from './_models/IdentityResponse';
 import { PartitionActionOptions } from './_models/PartitionActionOptions';
 import { FlattenedSystemState } from './_models/SystemState';
-import { THERMOSTAT_STATES } from "./_models/States";
+import { THERMOSTAT_STATES } from './_models/States';
 export * from './_models/AuthOpts';
 export * from './_models/DeviceStates';
 export * from './_models/IdentityResponse';
@@ -23,6 +24,11 @@ export * from './_models/SensorType';
  * @returns {Promise}
  */
 export declare function login(username: string, password: string, existingMfaToken?: string): Promise<AuthOpts>;
+/**
+ * This function returns the alarm.com system identity for the currently logged in system.
+ * The information returned is useful for finding current systems and global config.
+ */
+export declare function getIdentitiesState(loginCookies: string, ajaxKey: string): Promise<IdentityResponse>;
 /**
  * Retrieve information about the current state of a security system including
  * attributes, partitions, accessory components and relationships.

package/dist/index.js

@@ -20,7 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.authenticatedPost = exports.authenticatedGet = exports.setThermostatTargetCoolTemperature = exports.setThermostatTargetHeatTemperature = exports.setThermostatState = exports.openGarage = exports.closeGarage = exports.setLockUnsecure = exports.setLockSecure = exports.setLightOff = exports.setLightOn = exports.disarm = exports.armAway = exports.armStay = exports.getComponents = exports.getCurrentState = exports.login = void 0;
+exports.authenticatedPost = exports.authenticatedGet = exports.setThermostatTargetCoolTemperature = exports.setThermostatTargetHeatTemperature = exports.setThermostatState = exports.openGarage = exports.closeGarage = exports.setLockUnsecure = exports.setLockSecure = exports.setLightOff = exports.setLightOn = exports.disarm = exports.armAway = exports.armStay = exports.getComponents = exports.getCurrentState = exports.getIdentitiesState = exports.login = void 0;
 const node_fetch_1 = __importDefault(require("node-fetch"));
 __exportStar(require("./_models/AuthOpts"), exports);
 __exportStar(require("./_models/DeviceStates"), exports);
@@ -55,7 +55,9 @@ const UA = `node-alarm-dot-com/${require('../package.json').version}`;
 async function login(username, password, existingMfaToken) {
     let loginCookies;
     let ajaxKey;
-    let loginFormBody, identities, systems;
+    let loginFormBody;
+    let identities;
+    let systems;
     // load initial alarm.com page to gather required hidden form fields
     await get(ADCLOGIN_URL)
         .then((res) => {
@@ -107,7 +109,29 @@ async function login(username, password, existingMfaToken) {
         .catch((err) => {
         throw new Error(`POST ${ADCFORMLOGIN_URL} failed: ${err.message || err}`);
     });
-    await get(IDENTITIES_URL, {
+    await getIdentitiesState(loginCookies, ajaxKey)
+        .then((res) => {
+        systems = (res.data || []).map((d) => {
+            return 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;
+/**
+ * This function returns the alarm.com system identity for the currently logged in system.
+ * The information returned is useful for finding current systems and global config.
+ */
+async function getIdentitiesState(loginCookies, ajaxKey) {
+    return await get(IDENTITIES_URL, {
         /* eslint-disable @typescript-eslint/naming-convention */
         headers: {
             Accept: 'application/vnd.api+json',
@@ -120,20 +144,13 @@ async function login(username, password, existingMfaToken) {
     })
         .then((res) => {
         // gather identities and systems
-        identities = res.body;
-        systems = (identities.data || []).map((d) => getValue(d, 'relationships.selectedSystem.data.id'));
+        return res.body;
     })
         .catch((err) => {
         throw new Error(`GET ${IDENTITIES_URL} failed: ${err.message || err}`);
     });
-    return {
-        cookie: loginCookies,
-        ajaxKey: ajaxKey,
-        systems: systems,
-        identities: identities
-    };
 }
-exports.login = login;
+exports.getIdentitiesState = getIdentitiesState;
 /**
  * Retrieve information about the current state of a security system including
  * attributes, partitions, accessory components and relationships.
@@ -171,16 +188,14 @@ async function getCurrentState(systemID, authOpts) {
     if (typeof garageIDs[0] !== 'undefined') {
         components.set('garages', await getComponents(GARAGE_URL, garageIDs, authOpts));
     }
-    const thermostatIDs = rels.thermostats.data.map(thermostat => thermostat.id);
+    const thermostatIDs = rels.thermostats.data.map((thermostat) => thermostat.id);
     if (typeof thermostatIDs[0] !== 'undefined') {
         components.set('thermostats', await getComponents(THERMOSTAT_URL, thermostatIDs, authOpts));
     }
     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 : [],
@@ -596,14 +611,9 @@ 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');
+            throw new Error('Two factor is enabled on this account but not setup in the plugin.' + ' See the wiki for details');
         }
         if (status >= 400) {
             throw new Error(body.Message || body || status);

package/package.json

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