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

package/dist/_models/AuthOpts.d.ts

@@ -1,4 +1,7 @@
 import { IdentityResponse } from './IdentityResponse';
+/**
+ * AuthOpts is authentication information which is used in API requests to authenticate as the user.
+ */
 export interface AuthOpts {
     cookie: string;
     ajaxKey: string;

package/dist/_models/DeviceStates.d.ts

@@ -1,6 +1,7 @@
 import { Relationship } from './IdentityResponse';
 import { RelationshipType } from './SystemState';
 import { GARAGE_STATES, LIGHT_STATES, LOCK_STATES, SENSOR_STATES, SYSTEM_STATES } from './States';
+import { SensorType } from './SensorType';
 export interface ApiLightState extends ApiDeviceState {
     data: {
         id: string;
@@ -513,7 +514,7 @@ export interface SensorState extends DeviceState {
     id: string;
     type: RelationshipType.Sensor;
     attributes: {
-        deviceType: number;
+        deviceType: SensorType;
         openClosedStatus: number;
         state: SENSOR_STATES;
         stateText: string;
@@ -751,18 +752,12 @@ export interface CameraState extends DeviceState {
         };
     };
 }
+/**
+ * Base interface for retrieving device state from Alarm.com's API
+ * All devices retrieved contain these properties.
+ */
 export interface ApiDeviceState {
-    data: {
-        id: string;
-        type: RelationshipType;
-        attributes: any;
-        relationships: any;
-    } | Array<{
-        id: string;
-        type: RelationshipType;
-        attributes: any;
-        relationships: any;
-    }>;
+    data: DeviceState[] | DeviceState;
     included: [];
     meta: {
         transformer_version: '1.1' | string;

package/dist/_models/IdentityResponse.d.ts

@@ -1,3 +1,7 @@
+/**
+ * The identity response is returned upon authenticating against the Alarm.com API.
+ * It's then parsed and the authentication token stored for future use.
+ */
 export interface IdentityResponse {
     data: {
         id: number;

package/dist/_models/PartitionActionOptions.d.ts

@@ -1,3 +1,6 @@
+/**
+ * These options are sent when arming a partition to indicate desired arming options.
+ */
 export interface PartitionActionOptions {
     noEntryDelay: boolean;
     silentArming: boolean;

package/dist/_models/SensorType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Number indicating the type of sensor according to the Alarm.com API
+ */
+export declare enum SensorType {
+    Contact_Sensor = 1,
+    Motion_Sensor = 2,
+    Smoke_Detector = 5,
+    CO_Detector = 6,
+    Heat_Detector = 8,
+    Fob = 9,
+    Water_Sensor = 17,
+    Glass_Break = 19
+}

package/dist/_models/SensorType.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SensorType = void 0;
+/**
+ * Number indicating the type of sensor according to the Alarm.com API
+ */
+var SensorType;
+(function (SensorType) {
+    SensorType[SensorType["Contact_Sensor"] = 1] = "Contact_Sensor";
+    SensorType[SensorType["Motion_Sensor"] = 2] = "Motion_Sensor";
+    SensorType[SensorType["Smoke_Detector"] = 5] = "Smoke_Detector";
+    SensorType[SensorType["CO_Detector"] = 6] = "CO_Detector";
+    SensorType[SensorType["Heat_Detector"] = 8] = "Heat_Detector";
+    SensorType[SensorType["Fob"] = 9] = "Fob";
+    SensorType[SensorType["Water_Sensor"] = 17] = "Water_Sensor";
+    SensorType[SensorType["Glass_Break"] = 19] = "Glass_Break";
+})(SensorType = exports.SensorType || (exports.SensorType = {}));

package/dist/_models/States.d.ts

@@ -1,3 +1,6 @@
+/***
+ * State of the partition as defined by Alarm.com
+ */
 export declare enum SYSTEM_STATES {
     UNKNOWN = 0,
     DISARMED = 1,
@@ -5,6 +8,9 @@ export declare enum SYSTEM_STATES {
     ARMED_AWAY = 3,
     ARMED_NIGHT = 4
 }
+/***
+ * State of the sensor as defined by Alarm.com
+ */
 export declare enum SENSOR_STATES {
     UNKNOWN = 0,
     CLOSED = 1,
@@ -14,18 +20,31 @@ export declare enum SENSOR_STATES {
     DRY = 5,
     WET = 6
 }
+/***
+ * State of the light as defined by Alarm.com
+ */
 export declare enum LIGHT_STATES {
     ON = 2,
     OFF = 3
 }
+/***
+ * State of the lock as defined by Alarm.com
+ */
 export declare enum LOCK_STATES {
     SECURED = 1,
     UNSECURED = 2
 }
+/***
+ * State of the garage as defined by Alarm.com
+ */
 export declare enum GARAGE_STATES {
     OPEN = 1,
     CLOSED = 2
 }
+/***
+ * Relation types as defined by Alarm.com.
+ * Relationship types tell you what object is being sent from the API.
+ */
 export declare enum REL_TYPES {
     CONFIGURATION = "systems/configuration",
     PARTITION = "devices/partition",

package/dist/_models/States.js

@@ -1,6 +1,9 @@
 "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;
+/***
+ * State of the partition as defined by Alarm.com
+ */
 var SYSTEM_STATES;
 (function (SYSTEM_STATES) {
     SYSTEM_STATES[SYSTEM_STATES["UNKNOWN"] = 0] = "UNKNOWN";
@@ -9,6 +12,9 @@ var SYSTEM_STATES;
     SYSTEM_STATES[SYSTEM_STATES["ARMED_AWAY"] = 3] = "ARMED_AWAY";
     SYSTEM_STATES[SYSTEM_STATES["ARMED_NIGHT"] = 4] = "ARMED_NIGHT";
 })(SYSTEM_STATES = exports.SYSTEM_STATES || (exports.SYSTEM_STATES = {}));
+/***
+ * State of the sensor as defined by Alarm.com
+ */
 var SENSOR_STATES;
 (function (SENSOR_STATES) {
     SENSOR_STATES[SENSOR_STATES["UNKNOWN"] = 0] = "UNKNOWN";
@@ -19,22 +25,35 @@ var SENSOR_STATES;
     SENSOR_STATES[SENSOR_STATES["DRY"] = 5] = "DRY";
     SENSOR_STATES[SENSOR_STATES["WET"] = 6] = "WET";
 })(SENSOR_STATES = exports.SENSOR_STATES || (exports.SENSOR_STATES = {}));
+/***
+ * State of the light as defined by Alarm.com
+ */
 var LIGHT_STATES;
 (function (LIGHT_STATES) {
     LIGHT_STATES[LIGHT_STATES["ON"] = 2] = "ON";
     LIGHT_STATES[LIGHT_STATES["OFF"] = 3] = "OFF";
 })(LIGHT_STATES = exports.LIGHT_STATES || (exports.LIGHT_STATES = {}));
+/***
+ * State of the lock as defined by Alarm.com
+ */
 var LOCK_STATES;
 (function (LOCK_STATES) {
     LOCK_STATES[LOCK_STATES["SECURED"] = 1] = "SECURED";
     LOCK_STATES[LOCK_STATES["UNSECURED"] = 2] = "UNSECURED";
 })(LOCK_STATES = exports.LOCK_STATES || (exports.LOCK_STATES = {}));
+/***
+ * State of the garage as defined by Alarm.com
+ */
 var GARAGE_STATES;
 (function (GARAGE_STATES) {
     //UNKNOWN: 0,  //ADC does not have an unknown state. ADC returns temp popup
     GARAGE_STATES[GARAGE_STATES["OPEN"] = 1] = "OPEN";
     GARAGE_STATES[GARAGE_STATES["CLOSED"] = 2] = "CLOSED"; //double check
 })(GARAGE_STATES = exports.GARAGE_STATES || (exports.GARAGE_STATES = {}));
+/***
+ * Relation types as defined by Alarm.com.
+ * Relationship types tell you what object is being sent from the API.
+ */
 var REL_TYPES;
 (function (REL_TYPES) {
     REL_TYPES["CONFIGURATION"] = "systems/configuration";

package/dist/_models/SystemState.d.ts

@@ -1,4 +1,8 @@
 import { GarageState, LightState, LockState, PartitionState, SensorState } from './DeviceStates';
+/**
+ * Response information from
+ * api/systems/systems/{id}
+ */
 export interface SystemState {
     data: {
         id: number;

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export * from './_models/IdentityResponse';
 export * from './_models/PartitionActionOptions';
 export * from './_models/RequestOptions';
 export * from './_models/SystemState';
+export * from './_models/SensorType';
 /**
  * Authenticate with alarm.com.
  * Returns an authentication object that can be passed to other methods.

package/dist/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./_models/IdentityResponse"), exports);
 __exportStar(require("./_models/PartitionActionOptions"), exports);
 __exportStar(require("./_models/RequestOptions"), exports);
 __exportStar(require("./_models/SystemState"), exports);
+__exportStar(require("./_models/SensorType"), exports);
 const ADCLOGIN_URL = 'https://www.alarm.com/login';
 const ADCFORMLOGIN_URL = 'https://www.alarm.com/web/Default.aspx';
 const IDENTITIES_URL = 'https://www.alarm.com/web/api/identities';

package/package.json

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