homey-api 3.4.16 → 3.4.18

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -26,7 +26,6 @@ const versionCache = {};
  * @extends HomeyAPI
  */
 class HomeyAPIV3 extends HomeyAPI {
-
   static MANAGERS = {
     ManagerApps,
     ManagerDrivers,
@@ -72,6 +71,12 @@ class HomeyAPIV3 extends HomeyAPI {
       writable: true,
     });
 
+    Object.defineProperty(this, '__destroyed', {
+      value: false,
+      enumerable: false,
+      writable: true,
+    });
+
     Object.defineProperty(this, '__token', {
       value: token,
       enumerable: false,
@@ -85,9 +90,7 @@ class HomeyAPIV3 extends HomeyAPI {
     });
 
     Object.defineProperty(this, '__strategies', {
-      value: Array.isArray(strategy)
-        ? strategy
-        : [strategy],
+      value: Array.isArray(strategy) ? strategy : [strategy],
       enumerable: false,
       writable: false,
     });
@@ -99,9 +102,7 @@ class HomeyAPIV3 extends HomeyAPI {
     });
 
     Object.defineProperty(this, '__baseUrlPromise', {
-      value: typeof baseUrl === 'string'
-        ? Promise.resolve(baseUrl)
-        : null,
+      value: typeof baseUrl === 'string' ? Promise.resolve(baseUrl) : null,
       enumerable: false,
       writable: true,
     });
@@ -124,7 +125,7 @@ class HomeyAPIV3 extends HomeyAPI {
         this.__baseUrlPromise = this.discoverBaseUrl().then(({ baseUrl }) => {
           return baseUrl;
         });
-        this.__baseUrlPromise.catch(() => { });
+        this.__baseUrlPromise.catch(() => {});
       }
 
       return this.__baseUrlPromise;
@@ -167,8 +168,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;
 
@@ -254,7 +255,7 @@ class HomeyAPIV3 extends HomeyAPI {
         this.__baseUrl = baseUrl;
         this.__strategyId = strategyId;
       })
-      .catch(() => { });
+      .catch(() => {});
 
     // Ping method
     const ping = async (strategyId, timeout) => {
@@ -299,7 +300,7 @@ class HomeyAPIV3 extends HomeyAPI {
     if (urls[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE] = ping(HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE, 5000);
       pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE].catch(err => {
-        this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE} Error:`, err && err.message)
+        this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE} Error:`, err && err.message);
         this.__debug(urls[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE]);
       });
     }
@@ -307,25 +308,36 @@ 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 => this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.LOCAL} Error:`, err && err.message));
+      pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL].catch(err =>
+        this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.LOCAL} Error:`, err && err.message)
+      );
     }
 
     // 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 => this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.MDNS} Error:`, err && err.message));
+      pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS].catch(err =>
+        this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.MDNS} Error:`, err && err.message)
+      );
     }
 
     // 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 => this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.CLOUD} Error:`, err && err.message));
+      pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD].catch(err =>
+        this.__debug(`Ping ${HomeyAPI.DISCOVERY_STRATEGIES.CLOUD} Error:`, err && err.message)
+      );
     }
 
     // Ping Direct (https://xxx-xxx-xxx-xx.homey.homeylocal.com:12345)
     if (urls[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED]) {
-      pings[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED] = ping(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] = ping(
+        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)
+      );
     }
 
     // Select the best route
@@ -400,15 +412,7 @@ class HomeyAPIV3 extends HomeyAPI {
     return promise;
   }
 
-  async call({
-    $timeout = 10000,
-    method,
-    headers,
-    path,
-    body,
-    json = true,
-    retryAfterRefresh = false,
-  }) {
+  async call({ $timeout = 10000, method, headers, path, body, json = true, retryAfterRefresh = false }) {
     const baseUrl = await this.baseUrl;
 
     method = String(method).toUpperCase();
@@ -433,11 +437,14 @@ class HomeyAPIV3 extends HomeyAPI {
     }
 
     this.__debug(method, `${baseUrl}${path}`);
-    const res = await Util.timeout(Util.fetch(`${baseUrl}${path}`, {
-      method,
-      headers,
-      body,
-    }), $timeout);
+    const res = await Util.timeout(
+      Util.fetch(`${baseUrl}${path}`, {
+        method,
+        headers,
+        body,
+      }),
+      $timeout
+    );
 
     const resStatusCode = res.status;
     if (resStatusCode === 204) return undefined;
@@ -458,10 +465,8 @@ class HomeyAPIV3 extends HomeyAPI {
     if (resHeadersContentType && resHeadersContentType.startsWith('application/json')) {
       try {
         resBodyJson = JSON.parse(resBodyText);
-      // eslint-disable-next-line no-empty
-      } catch (err) { 
-
-      }
+        // eslint-disable-next-line no-empty
+      } catch (err) {}
     }
 
     if (!res.ok) {
@@ -485,22 +490,31 @@ class HomeyAPIV3 extends HomeyAPI {
           });
         }
 
-        throw new HomeyAPIError({
-          error: resBodyJson.error,
-          error_description: resBodyJson.error_description,
-          stack: resBodyJson.stack,
-        }, resStatusCode);
+        throw new HomeyAPIError(
+          {
+            error: resBodyJson.error,
+            error_description: resBodyJson.error_description,
+            stack: resBodyJson.stack,
+          },
+          resStatusCode
+        );
       }
 
       if (resBodyText) {
-        throw new HomeyAPIError({
-          error: resBodyText,
-        }, resStatusCode);
+        throw new HomeyAPIError(
+          {
+            error: resBodyText,
+          },
+          resStatusCode
+        );
       }
 
-      throw new HomeyAPIError({
-        error: resStatusText,
-      }, resStatusCode);
+      throw new HomeyAPIError(
+        {
+          error: resStatusText,
+        },
+        resStatusCode
+      );
     }
 
     if (typeof resBodyJson !== 'undefined') {
@@ -550,7 +564,7 @@ class HomeyAPIV3 extends HomeyAPI {
       });
 
       this.__loginPromise
-        .then(() => { })
+        .then(() => {})
         .catch(err => {
           this.__debug('Error Logging In:', err);
           this.__token = null;
@@ -580,36 +594,43 @@ class HomeyAPIV3 extends HomeyAPI {
     return this.__homeySocket && this.__homeySocket.connected;
   }
 
-  async subscribe(uri, {
-    onConnect = () => { },
-    onReconnect = () => { },
-    onReconnectError = () => { },
-    onDisconnect = () => { },
-    onEvent = () => { },
-  }) {
+  async subscribe(
+    uri,
+    {
+      onConnect = () => {},
+      onReconnect = () => {},
+      onReconnectError = () => {},
+      onDisconnect = () => {},
+      onEvent = () => {},
+    }
+  ) {
     this.__debug('subscribe', uri);
 
     await this.connect();
-    await Util.timeout(new Promise((resolve, reject) => {
-      if (this.isConnected() !== true) {
-        reject(new Error('Not connected after connect.'));
-        return;
-      }
-
-      this.__homeySocket.once('disconnect', (reason) => {
-        reject(new Error(reason));
-      });
-      this.__debug('subscribing', uri);
-      this.__homeySocket.emit('subscribe', uri, err => {
-        if (err) {
-          this.__debug('Failed to subscribe', uri, err);
-          return reject(err)
+    await Util.timeout(
+      new Promise((resolve, reject) => {
+        if (this.isConnected() !== true) {
+          reject(new Error('Not connected after connect.'));
+          return;
         }
-      
-        this.__debug('subscribed', uri);
-        return resolve();
-      });
-    }), 10000, `Failed to subscribe to ${uri} (Timeout after 10000ms).`);
+
+        this.__homeySocket.once('disconnect', reason => {
+          reject(new Error(reason));
+        });
+        this.__debug('subscribing', uri);
+        this.__homeySocket.emit('subscribe', uri, err => {
+          if (err) {
+            this.__debug('Failed to subscribe', uri, err);
+            return reject(err);
+          }
+
+          this.__debug('subscribed', uri);
+          return resolve();
+        });
+      }),
+      10000,
+      `Failed to subscribe to ${uri} (Timeout after 10000ms).`
+    );
 
     // On Connect
     const __onEvent = (event, data) => {
@@ -627,33 +648,39 @@ class HomeyAPIV3 extends HomeyAPI {
 
     // On Reconnect
     const __onReconnect = () => {
-      Promise.resolve().then(async () => {
-        await this.connect();
-        await Util.timeout(new Promise((resolve, reject) => {
-          if (this.isConnected() !== true) {
-            reject(new Error('Not connected after connect. (Reconnect)'));
-            return;
-          }
-
-          this.__homeySocket.once('disconnect', (reason) => {
-            reject(new Error(reason));
-          });
-          this.__debug('subscribing', uri);
-          this.__homeySocket.emit('subscribe', uri, err => {
-            if (err) {
-              this.__debug('Failed to subscribe', uri, err);
-              return reject(err)
-            }
-          
-            this.__debug('subscribed', uri);
-            return resolve();
-          });
-        }), 10000, `Failed to subscribe to ${uri} (Timeout after 10000ms).`);
+      Promise.resolve()
+        .then(async () => {
+          await this.connect();
+          await Util.timeout(
+            new Promise((resolve, reject) => {
+              if (this.isConnected() !== true) {
+                reject(new Error('Not connected after connect. (Reconnect)'));
+                return;
+              }
+
+              this.__homeySocket.once('disconnect', reason => {
+                reject(new Error(reason));
+              });
+              this.__debug('subscribing', uri);
+              this.__homeySocket.emit('subscribe', uri, err => {
+                if (err) {
+                  this.__debug('Failed to subscribe', uri, err);
+                  return reject(err);
+                }
+
+                this.__debug('subscribed', uri);
+                return resolve();
+              });
+            }),
+            10000,
+            `Failed to subscribe to ${uri} (Timeout after 10000ms).`
+          );
 
-        this.__homeySocket.on(uri, __onEvent);
+          this.__homeySocket.on(uri, __onEvent);
 
-        onReconnect();
-      }).catch(err => onReconnectError(err));
+          onReconnect();
+        })
+        .catch(err => onReconnectError(err));
     };
     this.__socket.on('reconnect', __onReconnect);
 
@@ -708,7 +735,7 @@ class HomeyAPIV3 extends HomeyAPI {
             this.__debug('SocketIOClient.onReconnect');
             this.emit('reconnect');
           });
-          
+
           this.__socket.on('reconnect_attempt', () => {
             this.__debug(`SocketIOClient.onReconnectAttempt`);
             this.emit('reconnect_attempt');
@@ -774,11 +801,13 @@ class HomeyAPIV3 extends HomeyAPI {
         this.__socket = null;
       });
     }
-    
+
     // TODO todo what?
   }
 
   destroy() {
+    this.__destroyed = true;
+
     if (this.__homeySocket) {
       this.__homeySocket.removeAllListeners();
       this.__homeySocket.close();
@@ -794,6 +823,10 @@ class HomeyAPIV3 extends HomeyAPI {
     this.removeAllListeners();
   }
 
+  isDestroyed() {
+    return this.__destroyed;
+  }
+
   async __handshakeClient() {
     this.__debug('__handshakeClient');
 
@@ -831,30 +864,35 @@ class HomeyAPIV3 extends HomeyAPI {
 
         this.__homeySocket.open();
       });
-    }
+    };
 
     const handshakeClient = async () => {
       return new Promise((resolve, reject) => {
-        this.__socket.emit('handshakeClient', {
-          token: this.__token,
-          homeyId: this.id,
-        }, (err, result) => {
-          if (err) {
-            if (err instanceof Error) {
-              return reject(err)
-            }
+        this.__socket.emit(
+          'handshakeClient',
+          {
+            token: this.__token,
+            homeyId: this.id,
+          },
+          (err, result) => {
+            if (err) {
+              if (err instanceof Error) {
+                return reject(err);
+              }
 
-            if (typeof err === 'object') {
-              return reject(new Error(err.message));
+              // .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 Error(String(err)));
             }
 
-            return reject(new Error(String(err)));
+            return resolve(result);
           }
-
-          return resolve(result);
-        });
+        );
       });
-    }
+    };
 
     try {
       const result = await Util.timeout(handshakeClient(), 5000, `Failed to handshake client (Timeout after 5000ms).`);
@@ -866,7 +904,11 @@ class HomeyAPIV3 extends HomeyAPI {
         await this.logout();
         await this.login();
 
-        const result = await Util.timeout(handshakeClient(), 5000, `Failed to handshake client (Timeout after 5000ms).`);
+        const result = await Util.timeout(
+          handshakeClient(),
+          5000,
+          `Failed to handshake client (Timeout after 5000ms).`
+        );
 
         return onResult(result);
       }
@@ -881,7 +923,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);
     });
   }
@@ -898,7 +940,6 @@ class HomeyAPIV3 extends HomeyAPI {
 
     return scopeOne.indexOf(partsTwo[0]) === 0 && suffixIsEqual;
   }
-
 }
 
 module.exports = HomeyAPIV3;

package/package.json

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