homey-api 3.14.1 → 3.14.3

package/lib/HomeyAPI/HomeyAPIV2/ManagerDrivers/Driver.js

@@ -3,15 +3,14 @@
 const DriverV3 = require('../../HomeyAPIV3/ManagerDrivers/Driver');
 
 class Driver extends DriverV3 {
-
   static transformGet(item) {
     item = super.transformGet(item);
 
     item.ownerId = item.id;
     item.ownerUri = item.uri;
-    item.ownerName = item.uriObj.name;
-    item.ownerIconObj = item.uriObj.iconObj;
-    item.color = item.uriObj.color;
+    item.ownerName = item.uriObj?.name;
+    item.ownerIconObj = item.uriObj?.iconObj;
+    item.color = item.uriObj?.color;
     item.id = `${item.uri}:${item.id}`;
 
     delete item.uri;
@@ -19,7 +18,6 @@ class Driver extends DriverV3 {
 
     return item;
   }
-  
 }
 
 module.exports = Driver;

package/lib/HomeyAPI/HomeyAPIV2/ManagerInsights.js

@@ -4,16 +4,12 @@ const ManagerInsightsV3 = require('../HomeyAPIV3/ManagerInsights');
 const Log = require('./ManagerInsights/Log');
 
 class ManagerInsights extends ManagerInsightsV3 {
-
   static CRUD = {
     ...super.CRUD,
     Log,
-  }
+  };
 
-  async getLog({
-    $cache = true,
-    id,
-  }) {
+  async getLog({ $cache = true, id }) {
     if ($cache === true && this.__cache['log'][id]) {
       return this.__cache['log'][id];
     }
@@ -25,11 +21,16 @@ class ManagerInsights extends ManagerInsightsV3 {
   }
 
   async getLogEntries({ id, resolution }) {
-    return this.__super__getLogEntries({
+    const result = await this.__super__getLogEntries({
       id: id.split(':').reverse()[0],
       uri: id.split(':', 3).join(':'),
       resolution,
     });
+
+    return {
+      ...result,
+      id: id,
+    };
   }
 
   async deleteLogEntries({ id }) {
@@ -41,7 +42,6 @@ class ManagerInsights extends ManagerInsightsV3 {
 
   // deleteLog
   // updateLog
-
 }
 
 module.exports = ManagerInsights;

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -129,7 +129,7 @@ class HomeyAPIV3 extends HomeyAPI {
         this.__baseUrlPromise = this.discoverBaseUrl().then(({ baseUrl }) => {
           return baseUrl;
         });
-        this.__baseUrlPromise.catch(() => { });
+        this.__baseUrlPromise.catch(() => {});
       }
 
       return this.__baseUrlPromise;
@@ -163,8 +163,8 @@ class HomeyAPIV3 extends HomeyAPI {
           const ManagerClass = this.constructor.MANAGERS[managerName]
             ? this.constructor.MANAGERS[managerName]
             : (() => {
-              return class extends Manager { };
-            })();
+                return class extends Manager {};
+              })();
 
           ManagerClass.ID = manager.id;
 
@@ -217,7 +217,8 @@ class HomeyAPIV3 extends HomeyAPI {
 
     if (this.__strategies.includes(HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED)) {
       if (this.__properties.remoteUrlForwarded) {
-        urls[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED] = `${this.__properties.remoteUrlForwarded}`;
+        urls[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED] =
+          `${this.__properties.remoteUrlForwarded}`;
       }
     }
 
@@ -252,7 +253,7 @@ class HomeyAPIV3 extends HomeyAPI {
         this.__baseUrl = baseUrl;
         this.__strategyId = strategyId;
       })
-      .catch(() => { });
+      .catch(() => {});
 
     // Ping method
     const ping = async (strategyId, timeout) => {
@@ -271,11 +272,11 @@ class HomeyAPIV3 extends HomeyAPI {
       const text = await response.text();
 
       if (!response.ok) {
-        throw new Error(text || response.statusText)
+        throw new Error(text || response.statusText);
       }
 
       if (text === 'false') {
-        throw new Error('Invalid Homey ID')
+        throw new Error('Invalid Homey ID');
       }
 
       const homeyId = response.headers.get('X-Homey-ID');
@@ -302,9 +303,15 @@ class HomeyAPIV3 extends HomeyAPI {
 
     // Ping localSecure (https://xxx-xxx-xxx-xx.homey.homeylocal.com)
     if (urls[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE]) {
-      pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE] = ping(HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE, 1200);
-      pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE].catch(err => {
-        this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE} Error:`, err && err.message);
+      pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE] = ping(
+        HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE,
+        1200
+      );
+      pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE].catch((err) => {
+        this.__debug(
+          `Ping ${HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE} Error:`,
+          err && err.message
+        );
         this.__debug(urls[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE]);
       });
     }
@@ -312,7 +319,7 @@ class HomeyAPIV3 extends HomeyAPI {
     // Ping local (http://xxx-xxx-xxx-xxx)
     if (urls[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL] = ping(HomeyAPI.DISCOVERY_STRATEGIES.LOCAL, 1000);
-      pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL].catch(err =>
+      pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL].catch((err) =>
         this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.LOCAL} Error:`, err && err.message)
       );
     }
@@ -320,7 +327,7 @@ class HomeyAPIV3 extends HomeyAPI {
     // Ping mdns (http://homey-<homeyId>.local)
     if (urls[HomeyAPI.DISCOVERY_STRATEGIES.MDNS]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS] = ping(HomeyAPI.DISCOVERY_STRATEGIES.MDNS, 3000);
-      pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS].catch(err =>
+      pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS].catch((err) =>
         this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.MDNS} Error:`, err && err.message)
       );
     }
@@ -328,7 +335,7 @@ class HomeyAPIV3 extends HomeyAPI {
     // Ping cloud (https://<homeyId>.connect.athom.com)
     if (urls[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD] = ping(HomeyAPI.DISCOVERY_STRATEGIES.CLOUD, 5000);
-      pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD].catch(err =>
+      pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD].catch((err) =>
         this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.CLOUD} Error:`, err && err.message)
       );
     }
@@ -339,15 +346,18 @@ class HomeyAPIV3 extends HomeyAPI {
         HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED,
         2000
       );
-      pings[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED].catch(err =>
-        this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED} Error:`, err && err.message)
+      pings[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED].catch((err) =>
+        this.__debug(
+          `Ping ${HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED} Error:`,
+          err && err.message
+        )
       );
     }
 
     // Select the best route
     if (pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE]
-        .then(result => resolve(result))
+        .then((result) => resolve(result))
         .catch(() => {
           const promises = [];
 
@@ -373,42 +383,42 @@ class HomeyAPIV3 extends HomeyAPI {
 
           return Util.promiseAny(promises);
         })
-        .then(result => resolve(result))
+        .then((result) => resolve(result))
         .catch(() => reject(new APIErrorHomeyOffline()));
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]
-        .then(result => resolve(result))
+        .then((result) => resolve(result))
         .catch(() => {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
-              .then(result => resolve(result))
-              .catch(err => reject(new APIErrorHomeyOffline(err)));
+              .then((result) => resolve(result))
+              .catch((err) => reject(new APIErrorHomeyOffline(err)));
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS]
-        .then(result => resolve(result))
+        .then((result) => resolve(result))
         .catch(() => {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
-              .then(result => resolve(result))
-              .catch(err => reject(new APIErrorHomeyOffline(err)));
+              .then((result) => resolve(result))
+              .catch((err) => reject(new APIErrorHomeyOffline(err)));
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED]
-        .then(result => resolve(result))
+        .then((result) => resolve(result))
         .catch(() => {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
-              .then(result => resolve(result))
-              .catch(err => reject(new APIErrorHomeyOffline(err)));
+              .then((result) => resolve(result))
+              .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 APIErrorHomeyOffline(err)));
+        .then((result) => resolve(result))
+        .catch((err) => reject(new APIErrorHomeyOffline(err)));
     } else {
       reject(new APIErrorHomeyOffline());
     }
@@ -483,12 +493,13 @@ class HomeyAPIV3 extends HomeyAPI {
       try {
         resBodyJson = JSON.parse(resBodyText);
         // eslint-disable-next-line no-empty
-      } catch (err) { }
+      } catch (err) {}
     }
 
     if (!res.ok) {
-      // If Session Expired, clear the stored token
-      if (resStatusCode === 401 && shouldRetry === true && token != null) {
+      // If Session Expired, clear the stored token. Only try if AthomCloudAPI is available so we
+      // never try to refresh on local api's.
+      if (resStatusCode === 401 && shouldRetry === true && token != null && this.__api != null) {
         this.__debug('Session expired');
         await this.refreshForToken(token, isRetryAfterRefresh);
 
@@ -559,7 +570,7 @@ class HomeyAPIV3 extends HomeyAPI {
         .then(() => {
           this.__loginPromise = null;
         })
-        .catch(err => {
+        .catch((err) => {
           this.__debug('Error Logging In:', err);
           this.__loginPromise = null;
           this.__token = null;
@@ -604,9 +615,10 @@ class HomeyAPIV3 extends HomeyAPI {
       this.__refreshSessionPromise = this.__refreshSession();
 
       this.__refreshSessionPromise
-        .catch(err => {
+        .catch((err) => {
           this.__debug('Error refreshing session:', err);
-        }).finally(() => {
+        })
+        .finally(() => {
           this.__refreshSessionPromise = null;
         });
     }
@@ -643,8 +655,8 @@ class HomeyAPIV3 extends HomeyAPI {
       });
 
       this.__refreshMap[token]
-        .then(() => { })
-        .catch(err => {
+        .then(() => {})
+        .catch((err) => {
           this.__debug('Error Refreshing Token:', err);
         })
         .finally(() => {
@@ -671,11 +683,11 @@ class HomeyAPIV3 extends HomeyAPI {
   async subscribe(
     uri,
     {
-      onConnect = () => { },
-      onReconnect = () => { },
-      onReconnectError = () => { },
-      onDisconnect = () => { },
-      onEvent = () => { },
+      onConnect = () => {},
+      onReconnect = () => {},
+      onReconnectError = () => {},
+      onDisconnect = () => {},
+      onEvent = () => {},
     }
   ) {
     this.__debug('subscribe', uri);
@@ -688,11 +700,11 @@ class HomeyAPIV3 extends HomeyAPI {
           return;
         }
 
-        this.__homeySocket.once('disconnect', reason => {
+        this.__homeySocket.once('disconnect', (reason) => {
           reject(new Error(reason));
         });
         this.__debug('subscribing', uri);
-        this.__homeySocket.emit('subscribe', uri, err => {
+        this.__homeySocket.emit('subscribe', uri, (err) => {
           if (err) {
             this.__debug('Failed to subscribe', uri, err);
             return reject(err);
@@ -715,7 +727,7 @@ class HomeyAPIV3 extends HomeyAPI {
     onConnect();
 
     // On Disconnect
-    const __onDisconnect = reason => {
+    const __onDisconnect = (reason) => {
       onDisconnect(reason);
     };
     this.__socket.on('disconnect', __onDisconnect);
@@ -732,11 +744,11 @@ class HomeyAPIV3 extends HomeyAPI {
                 return;
               }
 
-              this.__homeySocket.once('disconnect', reason => {
+              this.__homeySocket.once('disconnect', (reason) => {
                 reject(new Error(reason));
               });
               this.__debug('subscribing', uri);
-              this.__homeySocket.emit('subscribe', uri, err => {
+              this.__homeySocket.emit('subscribe', uri, (err) => {
                 if (err) {
                   this.__debug('Failed to subscribe', uri, err);
                   return reject(err);
@@ -754,7 +766,7 @@ class HomeyAPIV3 extends HomeyAPI {
 
           onReconnect();
         })
-        .catch(err => onReconnectError(err));
+        .catch((err) => onReconnectError(err));
     };
     this.__socket.on('reconnect', __onReconnect);
 
@@ -795,12 +807,12 @@ class HomeyAPIV3 extends HomeyAPI {
             reconnection: this.__reconnect,
           });
 
-          this.__socket.on('disconnect', reason => {
+          this.__socket.on('disconnect', (reason) => {
             this.__debug('SocketIOClient.onDisconnect', reason);
             this.emit('disconnect', reason);
           });
 
-          this.__socket.on('error', err => {
+          this.__socket.on('error', (err) => {
             this.__debug('SocketIOClient.onError', err.message);
             this.emit('error', err);
           });
@@ -815,17 +827,17 @@ class HomeyAPIV3 extends HomeyAPI {
             this.emit('reconnect_attempt');
           });
 
-          this.__socket.on('reconnecting', attempt => {
+          this.__socket.on('reconnecting', (attempt) => {
             this.__debug(`SocketIOClient.onReconnecting (Attempt #${attempt})`);
             this.emit('reconnecting');
           });
 
-          this.__socket.on('reconnect_error', err => {
+          this.__socket.on('reconnect_error', (err) => {
             this.__debug('SocketIOClient.onReconnectError', err.message, err);
             this.emit('reconnect_error');
           });
 
-          this.__socket.on('connect_error', err => {
+          this.__socket.on('connect_error', (err) => {
             this.__debug('SocketIOClient.onConnectError', err.message);
             this.emit('connect_error');
             reject(err);
@@ -839,7 +851,7 @@ class HomeyAPIV3 extends HomeyAPI {
                 this.__debug('SocketIOClient.onConnect.onHandshakeClientSuccess');
                 resolve();
               })
-              .catch(err => {
+              .catch((err) => {
                 this.__debug('SocketIOClient.onConnect.onHandshakeClientError', err.message);
                 reject(err);
               });
@@ -849,7 +861,7 @@ class HomeyAPIV3 extends HomeyAPI {
         });
       });
 
-      this.__connectPromise.catch(err => {
+      this.__connectPromise.catch((err) => {
         this.__debug('SocketIOClient Error', err.message);
         delete this.__connectPromise;
       });
@@ -868,7 +880,7 @@ class HomeyAPIV3 extends HomeyAPI {
     // Also disconnect __homeySocket?
 
     if (this.__socket) {
-      await new Promise(resolve => {
+      await new Promise((resolve) => {
         if (this.__socket.connected) {
           this.__socket.once('disconnect', () => resolve());
           this.__socket.disconnect();
@@ -919,7 +931,7 @@ class HomeyAPIV3 extends HomeyAPI {
           resolve();
         });
 
-        this.__homeySocket.once('connect_error', err => {
+        this.__homeySocket.once('connect_error', (err) => {
           this.__debug(`SocketIOClient.Namespace[${namespace}].onConnectError`, err.message);
           if (err) {
             if (err instanceof Error) {
@@ -928,7 +940,9 @@ class HomeyAPIV3 extends HomeyAPI {
 
             // .statusCode for homey-core .code for homey-client.
             if (typeof err === 'object') {
-              return reject(new HomeyAPIError({ error_description: err.message }, err.statusCode || err.code));
+              return reject(
+                new HomeyAPIError({ error_description: err.message }, err.statusCode || err.code)
+              );
             }
 
             return reject(new Error(String(err)));
@@ -937,19 +951,21 @@ class HomeyAPIV3 extends HomeyAPI {
           reject(new Error(`Unknown error connecting to namespace ${namespace}.`));
         });
 
-        this.__homeySocket.on('disconnect', reason => {
+        this.__homeySocket.on('disconnect', (reason) => {
           this.__debug(`SocketIOClient.Namespace[${namespace}].onDisconnect`, reason);
         });
 
-        this.__homeySocket.on('reconnecting', attempt => {
-          this.__debug(`SocketIOClient.Namespace[${namespace}].onReconnecting (Attempt #${attempt})`);
+        this.__homeySocket.on('reconnecting', (attempt) => {
+          this.__debug(
+            `SocketIOClient.Namespace[${namespace}].onReconnecting (Attempt #${attempt})`
+          );
         });
 
         this.__homeySocket.on('reconnect', () => {
           this.__debug(`SocketIOClient.Namespace[${namespace}].onReconnect`);
         });
 
-        this.__homeySocket.on('reconnect_error', err => {
+        this.__homeySocket.on('reconnect_error', (err) => {
           this.__debug(`SocketIOClient.Namespace[${namespace}].onReconnectError`, err.message);
         });
 
@@ -957,7 +973,7 @@ class HomeyAPIV3 extends HomeyAPI {
       });
     };
 
-    const handshakeClient = async token => {
+    const handshakeClient = async (token) => {
       return new Promise((resolve, reject) => {
         this.__socket.emit(
           'handshakeClient',
@@ -1005,7 +1021,8 @@ class HomeyAPIV3 extends HomeyAPI {
 
       return onResult(result);
     } catch (err) {
-      if (err.statusCode === 401 || err.code === 401) {
+      // Only try if AthomCloudAPI is available so we never try to refresh on local api's.
+      if ((err.statusCode === 401 || err.code === 401) && this.__api != null) {
         this.__debug('Token expired, refreshing...');
         await this.refreshForToken(token, false);
         const result = await Util.timeout(
@@ -1027,7 +1044,7 @@ class HomeyAPIV3 extends HomeyAPI {
       return true;
     }
 
-    return this.__session.intersectedScopes.some(availableScope => {
+    return this.__session.intersectedScopes.some((availableScope) => {
       return this.constructor.instanceOfScope(scope, availableScope);
     });
   }

package/lib/Util.js

@@ -58,6 +58,11 @@ class Util {
         }
       }
 
+      if (err.type === 'aborted') {
+        // https://github.com/node-fetch/node-fetch/blob/2.x/src/abort-error.js
+        throw new APIErrorTimeout(timeoutMessage ?? `Timeout after ${timeoutDuration}ms`);
+      }
+
       throw err;
     } finally {
       clearTimeout(abortTimeout);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.14.1",
+  "version": "3.14.3",
   "description": "Homey API",
   "main": "index.js",
   "files": [