homey-api 1.5.20 → 1.5.23

package/lib/HomeyAPI/HomeyAPIV2/Device.js

@@ -9,20 +9,6 @@ class Device extends Item {
   constructor(...props) {
     super(...props);
 
-    // Set URI
-    Object.defineProperty(this, 'uri', {
-      value: `homey:device:${this.id}`,
-      enumerable: false,
-      writable: true,
-    });
-
-    // Set Connected
-    Object.defineProperty(this, '__connected', {
-      value: false,
-      enumerable: false,
-      writable: true,
-    });
-
     // Set Capability Instances
     Object.defineProperty(this, '__capabilityInstances', {
       value: {},
@@ -110,108 +96,31 @@ class Device extends Item {
     });
   }
 
-  async connect() {
-    this.__debug('connect');
-
-    // If disconnecting, await that first
-    try {
-      await this.__disconnectPromise;
-    } catch (err) { }
-
-    this.__connectPromise = Promise.resolve().then(async () => {
-      if (!this.io) {
-        this.io = this.homey.subscribe(this.uri, {
-          onConnect: () => {
-            this.__debug('onConnect');
-            this.__connected = true;
-          },
-          onDisconnect: () => {
-            this.__debug('onDisconnect');
-            this.__connected = false;
-          },
-          onReconnect: () => {
-            this.__debug('onDisconnect');
-
-            const capabilityInstances = this.__capabilityInstances;
-            if (Object.keys(capabilityInstances).length > 0) {
-              // Get the device's latest values
-              // TODO: Optimize this with `getDevices()` when >1 device has >0 capability instances.
-              this.manager.getDevice({
-                id: this.id,
-              }).then(async device => {
-                Object.entries(capabilityInstances).forEach(([capabilityId, capabilityInstance]) => {
-                  const value = device.capabilitiesObj
-                    ? typeof device.capabilitiesObj[capabilityId] !== 'undefined'
-                      ? device.capabilitiesObj[capabilityId].value
-                      : null
-                    : null;
-
-                  capabilityInstance.__onCapabilityValue({
-                    capabilityId,
-                    value,
-                    transactionId: Util.uuid(),
-                  });
-                });
-              })
-                // eslint-disable-next-line no-console
-                .catch(err => console.error(`Device[${this.id}].onReconnectError:`, err));
-            }
-          },
-          onEvent: (event, data) => {
-            // // Fire event listeners
-            if (Array.isArray(this.__listeners[event])) {
-              this.__listeners[event].forEach(listener => listener(data));
-            }
-          },
+  onReconnect() {
+    const capabilityInstances = this.__capabilityInstances;
+    if (Object.keys(capabilityInstances).length > 0) {
+      // Get the device's latest values
+      // TODO: Optimize this with `getDevices()` when >1 device has >0 capability instances.
+      this.manager.getDevice({
+        id: this.id,
+      }).then(async device => {
+        Object.entries(capabilityInstances).forEach(([capabilityId, capabilityInstance]) => {
+          const value = device.capabilitiesObj
+            ? typeof device.capabilitiesObj[capabilityId] !== 'undefined'
+              ? device.capabilitiesObj[capabilityId].value
+              : null
+            : null;
+
+          capabilityInstance.__onCapabilityValue({
+            capabilityId,
+            value,
+            transactionId: Util.uuid(),
+          });
         });
-      }
-
-      await this.io;
-    });
-
-    // Delete the connecting Promise
-    this.__connectPromise
-      .catch(() => { })
-      .finally(() => {
-        delete this.__connectPromise;
-      });
-
-    await this.__connectPromise;
-  }
-
-  async disconnect() {
-    this.__debug('disconnect');
-
-    // If connecting, await that first
-    try {
-      await this.__connectPromise;
-    } catch (err) { }
-
-    this.__disconnectPromise = Promise.resolve().then(async () => {
-      this.__connected = false;
-
-      if (this.io) {
-        this.io
-          .then(io => io.unsubscribe())
-          .catch(err => this.__debug('Error Disconnecting:', err));
-      }
-    });
-
-    // Delete the disconnecting Promise
-    this.__disconnectPromise
-      .catch(() => { })
-      .finally(() => {
-        delete this.__disconnectPromise;
-      });
-
-    await this.__disconnectPromise;
-  }
-
-  destroy() {
-    super.destroy();
-
-    // Disconnect from Socket.io
-    this.disconnect().catch(() => { });
+      })
+        // eslint-disable-next-line no-console
+        .catch(err => console.error(`Device[${this.id}].onReconnectError:`, err));
+    }
   }
 
 }

package/lib/HomeyAPI/HomeyAPIV2/Item.js

@@ -5,6 +5,7 @@ const EventEmitter = require('../../EventEmitter');
 class Item extends EventEmitter {
 
   constructor({
+    uri,
     key,
     homey,
     manager,
@@ -33,6 +34,20 @@ class Item extends EventEmitter {
       writable: false,
     });
 
+    // Set URI
+    Object.defineProperty(this, '__uri', {
+      value: uri,
+      enumerable: false,
+      writable: true,
+    });
+
+    // Set Connected
+    Object.defineProperty(this, '__connected', {
+      value: false,
+      enumerable: false,
+      writable: true,
+    });
+
     // Set Properties
     for (const [key, value] of Object.entries(properties)) {
       Object.defineProperty(this, key, {
@@ -54,9 +69,102 @@ class Item extends EventEmitter {
     return this;
   }
 
+  async connect() {
+    this.__debug('connect');
+
+    // If disconnecting, await that first
+    try {
+      await this.__disconnectPromise;
+    } catch (err) { }
+
+    this.__connectPromise = Promise.resolve().then(async () => {
+      if (!this.io) {
+        this.io = this.homey.subscribe(this.__uri, {
+          onConnect: () => {
+            this.__debug('onConnect');
+            this.__connected = true;
+
+            this.onConnect();
+          },
+          onDisconnect: () => {
+            this.__debug('onDisconnect');
+            this.__connected = false;
+
+            this.onDisconnect();
+          },
+          onReconnect: () => {
+            this.__debug('onDisconnect');
+
+            this.onReconnect();
+          },
+          onEvent: (event, data) => {
+            // // Fire event listeners
+            if (Array.isArray(this.__listeners[event])) {
+              this.__listeners[event].forEach(listener => listener(data));
+            }
+          },
+        });
+      }
+
+      await this.io;
+    });
+
+    // Delete the connecting Promise
+    this.__connectPromise
+      .catch(() => { })
+      .finally(() => {
+        delete this.__connectPromise;
+      });
+
+    await this.__connectPromise;
+  }
+
+  async disconnect() {
+    this.__debug('disconnect');
+
+    // If connecting, await that first
+    try {
+      await this.__connectPromise;
+    } catch (err) { }
+
+    this.__disconnectPromise = Promise.resolve().then(async () => {
+      this.__connected = false;
+
+      if (this.io) {
+        this.io
+          .then(io => io.unsubscribe())
+          .catch(err => this.__debug('Error Disconnecting:', err));
+      }
+    });
+
+    // Delete the disconnecting Promise
+    this.__disconnectPromise
+      .catch(() => { })
+      .finally(() => {
+        delete this.__disconnectPromise;
+      });
+
+    await this.__disconnectPromise;
+  }
+
+  onConnect() {
+    // Overload Me
+  }
+
+  onReconnect() {
+    // Overload Me
+  }
+
+  onDisconnect() {
+    // Overload Me
+  }
+
   destroy() {
     // Remove all event listeners
     this.removeAllListeners();
+
+    // Disconnect from Socket.io
+    this.disconnect().catch(() => { });
   }
 
 }

package/lib/HomeyAPI/HomeyAPIV2/Manager.js

@@ -109,6 +109,7 @@ class Manager extends EventEmitter {
             $validate = true,
             $cache = true,
             $timeout = 5000,
+            $socket = true,
             $body = {},
             $query = {},
             $headers = {},
@@ -189,6 +190,14 @@ class Manager extends EventEmitter {
               }
             }
 
+            // Append query to path
+            if (Object.keys(query).length > 0) {
+              const queryString = Object.entries(query).map(([key, value]) => {
+                return `${key}=${encodeURIComponent(value)}`;
+              }).join('&');
+              path = `${path}?${queryString}`;
+            }
+
             let result;
             const benchmark = Util.benchmark();
 
@@ -236,7 +245,7 @@ class Manager extends EventEmitter {
             // 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()) {
+            if (this.homey.isConnected() && $socket === true) {
               result = await Util.timeout(new Promise((resolve, reject) => {
                 this.homey.__ioNamespace.emit('api', {
                   args,
@@ -268,13 +277,20 @@ class Manager extends EventEmitter {
                 if (itemType === 'id') return props.id;
                 throw new Error('Invalid Item Type');
               };
+              const getItemUri = props => {
+                if (itemType === 'filter') return null;
+                if (itemType === 'id') return `homey:${itemId}:${props.id}`;
+                throw new Error('Invalid Item Type');
+              };
 
               switch (operation.crud.type) {
                 case 'getOne': {
                   const key = getItemKey(result);
+                  const uri = getItemUri(result);
 
                   result = new ItemClass({
                     key,
+                    uri,
                     homey: this.homey,
                     manager: this,
                     properties: { ...result },
@@ -290,12 +306,14 @@ class Manager extends EventEmitter {
                   // Add all to cache
                   for (const [resultKey, item] of Object.entries(result)) {
                     const key = getItemKey(item);
+                    const uri = getItemUri(item);
 
                     if (this.__cache[itemId][key]) {
                       result[resultKey] = this.__cache[itemId][key].__update(item);
                     } else {
                       result[resultKey] = new ItemClass({
                         key,
+                        uri,
                         homey: this.homey,
                         manager: this,
                         properties: { ...item },
@@ -326,11 +344,14 @@ class Manager extends EventEmitter {
                 case 'createOne':
                 case 'updateOne': {
                   const key = getItemKey(result);
+                  const uri = getItemUri(result);
+
                   if (this.__cache[itemId][key]) {
                     result = this.__cache[itemId][key].__update(result);
                   } else {
                     result = new ItemClass({
                       key,
+                      uri,
                       manager: this,
                       properties: result,
                     });
@@ -343,6 +364,7 @@ class Manager extends EventEmitter {
                 }
                 case 'deleteOne': {
                   const key = getItemKey(args);
+
                   if (this.__cache[itemId][key]) {
                     this.__cache[itemId][key].destroy();
                     delete this.__cache[itemId][key];
@@ -416,11 +438,15 @@ class Manager extends EventEmitter {
               const key = itemType === 'filter'
                 ? `${data.uri}:${data.id}`
                 : `${data.id}`;
+              const uri = itemType === 'filter'
+                ? null
+                : `homey:${itemId}:${data.id}`;
 
               switch (operation) {
                 case 'create': {
                   this.__cache[itemId][key] = new ItemClass({
                     key,
+                    uri,
                     manager: this,
                     properties: { ...data },
                   });
@@ -437,6 +463,7 @@ class Manager extends EventEmitter {
                   } else {
                     this.__cache[itemId][key] = new ItemClass({
                       key,
+                      uri,
                       manager: this,
                       properties: { ...data },
                     });

package/lib/HomeyAPI/HomeyAPIV2.js

@@ -7,7 +7,7 @@ const ManagerApps = require('./HomeyAPIV2/ManagerApps');
 const ManagerDevices = require('./HomeyAPIV2/ManagerDevices');
 const HomeyAPI = require('./HomeyAPI');
 const HomeyAPIError = require('./HomeyAPIError');
-const HomeyOfflineError = require('./HomeyOfflineError');
+const APIErrorHomeyOffline = require('../APIErrorHomeyOffline');
 const Util = require('../Util');
 
 /**
@@ -211,40 +211,39 @@ class HomeyAPIV2 extends HomeyAPI {
 
     // Ping method
     const ping = async (strategyId, timeout) => {
+      let pingTimeout;
       const baseUrl = urls[strategyId];
-      const res = await Promise.race([
+      return Promise.race([
         Util.fetch(`${baseUrl}/api/manager/system/ping?id=${this.id}`, {
           headers: {
             'X-Homey-ID': this.id,
           },
+        }).then(async res => {
+          const text = await res.text();
+          if (!res.ok) throw new Error(text || res.statusText);
+          if (text === 'false') throw new Error('Invalid Homey ID');
+
+          const homeyId = res.headers.get('X-Homey-ID');
+          if (homeyId) {
+            if (homeyId !== this.id) throw new Error('Invalid Homey ID'); // TODO: Add to Homey Connect
+          }
+
+          // Set the version that Homey told us.
+          // It's the absolute truth, because the Cloud API may be behind.
+          const homeyVersion = res.headers.get('X-Homey-Version');
+          if (homeyVersion !== this.version) {
+            this.version = homeyVersion;
+          }
+
+          return {
+            baseUrl,
+            strategyId,
+          };
         }),
         new Promise((_, reject) => {
-          const pingTimeout = setTimeout(() => reject(new Error('PingTimeout')), timeout);
-          promise
-            .catch(() => { })
-            .finally(() => clearTimeout(pingTimeout));
+          pingTimeout = setTimeout(() => reject(new Error('PingTimeout')), timeout);
         }),
-      ]);
-      const text = await res.text();
-      if (!res.ok) throw new Error(text || res.statusText);
-      if (text === 'false') throw new Error('Invalid Homey ID');
-
-      const homeyId = res.headers.get('X-Homey-ID');
-      if (homeyId) {
-        if (homeyId !== this.id) throw new Error('Invalid Homey ID'); // TODO: Add to Homey Connect
-      }
-
-      // Set the version that Homey told us.
-      // It's the absolute truth, because the Cloud API may be behind.
-      const homeyVersion = res.headers.get('X-Homey-Version');
-      if (homeyVersion !== this.version) {
-        this.version = homeyVersion;
-      }
-
-      return {
-        baseUrl,
-        strategyId,
-      };
+      ]).finally(() => clearTimeout(pingTimeout));
     };
 
     const pings = {};
@@ -293,22 +292,13 @@ class HomeyAPIV2 extends HomeyAPI {
           }
 
           if (!promises.length) {
-            throw new HomeyOfflineError();
+            throw new APIErrorHomeyOffline();
           }
 
-          return Promise.race(promises);
+          return Util.promiseAny(promises);
         })
         .then(result => resolve(result))
-        .catch(err => {
-          // Last resort: try cloud
-          if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
-            return pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD].catch(err => {
-              throw new HomeyOfflineError(err);
-            });
-          }
-
-          reject(new HomeyOfflineError(err));
-        });
+        .catch(() => reject(new APIErrorHomeyOffline()));
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]
         .then(result => resolve(result))
@@ -316,7 +306,7 @@ class HomeyAPIV2 extends HomeyAPI {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then(result => resolve(result))
-              .catch(err => reject(new HomeyOfflineError(err)));
+              .catch(err => reject(new APIErrorHomeyOffline(err)));
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS]) {
@@ -326,15 +316,15 @@ class HomeyAPIV2 extends HomeyAPI {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then(result => resolve(result))
-              .catch(err => reject(new HomeyOfflineError(err)));
+              .catch(err => reject(new APIErrorHomeyOffline(err)));
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
         .then(result => resolve(result))
-        .catch(err => reject(new HomeyOfflineError(err)));
+        .catch(err => reject(new APIErrorHomeyOffline(err)));
     } else {
-      reject(new HomeyOfflineError());
+      reject(new APIErrorHomeyOffline());
     }
 
     return promise;

package/lib/Util.js

@@ -172,6 +172,29 @@ class Util {
       .toUpperCase();
   }
 
+  /**
+   * Polyfill for Promise.any, which is only supported on Node.js >=15
+   * @param {Array<Promise>} promises
+   */
+  static async promiseAny(promises) {
+    if (promises.length === 0) return;
+    const rejections = [];
+
+    return new Promise((resolve, reject) => {
+      promises.forEach((promise, i) => {
+        promise
+          .then(result => resolve(result))
+          .catch(err => {
+            rejections[i] = err;
+
+            if (rejections.length === promises.length) {
+              reject(rejections);
+            }
+          });
+      });
+    });
+  }
+
 }
 
 module.exports = Util;

package/package.json

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