homey-api 1.5.10 → 1.5.13

package/lib/APIErrorTimeout.js

@@ -0,0 +1,21 @@
+/* eslint-disable camelcase */
+
+'use strict';
+
+const APIError = require('./APIError');
+
+/**
+ * @class
+ * @hideconstructor
+ * @extends APIError
+ * @memberof HomeyAPI
+ */
+class APIErrorTimeout extends APIError {
+
+  constructor(message, statusCode = 408) {
+    super(message, statusCode);
+  }
+
+}
+
+module.exports = APIErrorTimeout;

package/lib/EventEmitter.js

@@ -26,6 +26,16 @@ class EventEmitter {
         listener(...data);
       });
     }
+
+    return this;
+  }
+
+  /**
+   * @param {string} event
+   * @param {function} callback
+   */
+  addListener(event, callback) {
+    return this.on(event, callback);
   }
 
   /**
@@ -37,6 +47,8 @@ class EventEmitter {
 
     this.__listeners[event] = this.__listeners[event] || [];
     this.__listeners[event].push(callback);
+
+    return this;
   }
 
   /**
@@ -53,6 +65,8 @@ class EventEmitter {
 
     this.__listeners[event] = this.__listeners[event] || [];
     this.__listeners[event].push(callback_);
+
+    return this;
   }
 
   /**
@@ -63,6 +77,8 @@ class EventEmitter {
     this.__debug(`.off('${event}')`);
 
     this.__listeners[event] = this.__listeners[event].filter(cb => cb !== callback);
+
+    return this;
   }
 
   /**
@@ -71,7 +87,7 @@ class EventEmitter {
    * @param {function} callback
    */
   removeListener(event, callback) {
-    this.off(event, callback);
+    return this.off(event, callback);
   }
 
   /**
@@ -79,6 +95,8 @@ class EventEmitter {
    */
   removeAllListeners(event) {
     this.__listeners[event] = [];
+
+    return this;
   }
 
 }

package/lib/HomeyAPI/HomeyAPIV2/Manager.js

@@ -119,6 +119,7 @@ class Manager extends EventEmitter {
             const query = { ...$query };
             const headers = { ...$headers };
 
+            // Verify & Transform parameters
             if (operation.parameters) {
               // Parse Parameters
               for (const [parameterId, parameter] of Object.entries(operation.parameters)) {
@@ -194,8 +195,9 @@ class Manager extends EventEmitter {
             let result;
             const benchmark = Util.benchmark();
 
-            // Try to get the CRUD Item from Cache.
-            if (operation.crud && $cache === true) {
+            // If connected to Socket.io,
+            // try to get the CRUD Item from Cache.
+            if (this.isConnected() && operation.crud && $cache === true) {
               const itemId = items[operation.crud.item].id;
               const itemType = items[operation.crud.item].type;
 
@@ -234,8 +236,8 @@ class Manager extends EventEmitter {
               }
             }
 
-            // If Homey is connected to Socket.io
-            // Send API request to socket.io
+            // If Homey is connected to Socket.io,
+            // send the API request to socket.io.
             // This is about ~2x faster than HTTP
             if (this.homey.isConnected()) {
               result = await Util.timeout(new Promise((resolve, reject) => {
@@ -273,13 +275,17 @@ class Manager extends EventEmitter {
                 case 'getOne': {
                   const key = getItemKey(result);
 
-                  result = this.__cache[itemId][key] = new ItemClass({
+                  result = new ItemClass({
                     key,
                     homey: this.homey,
                     manager: this,
                     properties: { ...result },
                   });
 
+                  if (this.isConnected()) {
+                    this.__cache[itemId][key] = result;
+                  }
+
                   break;
                 }
                 case 'getAll': {
@@ -290,16 +296,20 @@ class Manager extends EventEmitter {
                     if (this.__cache[itemId][key]) {
                       result[resultKey] = this.__cache[itemId][key].__update(item);
                     } else {
-                      result[resultKey] = this.__cache[itemId][key] = new ItemClass({
+                      result[resultKey] = new ItemClass({
                         key,
                         homey: this.homey,
                         manager: this,
                         properties: { ...item },
                       });
+
+                      if (this.isConnected()) {
+                        this.__cache[itemId][key] = result[resultKey];
+                      }
                     }
                   }
 
-                  // Find and delete deleted from cache
+                  // Find and delete deleted items from cache
                   if (this.__cache[itemId]) {
                     for (const cachedItem of Object.values(this.__cache[itemId])) {
                       const key = getItemKey(cachedItem);
@@ -321,11 +331,15 @@ class Manager extends EventEmitter {
                   if (this.__cache[itemId][key]) {
                     result = this.__cache[itemId][key].__update(result);
                   } else {
-                    result = this.__cache[itemId][key] = new ItemClass({
+                    result = new ItemClass({
                       key,
                       manager: this,
                       properties: result,
                     });
+
+                    if (this.isConnected()) {
+                      this.__cache[itemId][key] = result;
+                    }
                   }
                   break;
                 }
@@ -354,6 +368,14 @@ class Manager extends EventEmitter {
     this.homey.__debug(`[${this.name}]`, ...props);
   }
 
+  /**
+   * If this manager's namespace is connected to Socket.io.
+   * @returns {Boolean}
+   */
+  isConnected() {
+    return this.__connected === true;
+  }
+
   /**
    * Connect to the realtime namespace.
    * @returns {Promise<void>}

package/lib/HomeyAPI/HomeyAPIV2.js

@@ -467,6 +467,10 @@ class HomeyAPIV2 extends HomeyAPI {
     this.__token = null;
   }
 
+  /**
+   * If Homey is connected to Socket.io.
+   * @returns {Boolean}
+   */
   isConnected() {
     return this.__connected === true;
   }

package/lib/Util.js

@@ -2,6 +2,8 @@
 
 'use strict';
 
+const APIErrorTimeout = require('./APIErrorTimeout');
+
 /**
  * Helper Utility Class
  * @class
@@ -43,7 +45,7 @@ class Util {
    * @returns {Promise}
    */
   static async timeout(promise, timeoutMillis = 5000, message = `Timeout after ${timeoutMillis}ms`) {
-    const timeoutError = new Error(message);
+    const timeoutError = new APIErrorTimeout(message);
     let timeoutRef;
     return Promise.race([
       promise,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "1.5.10",
+  "version": "1.5.13",
   "description": "Homey API",
   "main": "src/index.js",
   "types": "assets/types/homey-api.d.ts",