homey-api 3.0.19 → 3.0.21

package/lib/HomeyAPI/HomeyAPIV2/ManagerDevices/Device.js

@@ -11,6 +11,7 @@ class Device extends DeviceV3 {
 
     delete item.driverUri;
     delete item.zoneName;
+    
     return item;
   }
 }

package/lib/HomeyAPI/HomeyAPIV3/Manager.js

@@ -459,6 +459,16 @@ class Manager extends EventEmitter {
 
     }
 
+    if (this.__connectPromise) {
+      await this.__connectPromise
+      return;
+    }
+
+    if (this.io) {
+      await this.io;
+      return
+    }
+
     this.__connectPromise = Promise.resolve().then(async () => {
       if (!this.io) {
         this.io = this.homey.subscribe(this.uri, {

package/lib/HomeyAPI/HomeyAPIV3/ManagerDevices/Device.js

@@ -229,6 +229,7 @@ class Device extends Item {
     item = super.transformGet(item);
 
     delete item.driverUri;
+    delete item.insights;
 
     if (item.capabilitiesObj) {
       for (const capabilityObj of Object.values(item.capabilitiesObj)) {

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -45,6 +45,7 @@ class HomeyAPIV3 extends HomeyAPI {
     ],
     baseUrl = null,
     token = null,
+    session = null,
     ...props
   }) {
     super({ properties, ...props });
@@ -67,6 +68,12 @@ class HomeyAPIV3 extends HomeyAPI {
       writable: true,
     });
 
+    Object.defineProperty(this, '__session', {
+      value: session,
+      enumerable: false,
+      writable: true,
+    });
+
     Object.defineProperty(this, '__strategies', {
       value: Array.isArray(strategy)
         ? strategy
@@ -276,8 +283,11 @@ 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, 3000);
+      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]);
+      });
     }
 
     // Ping local (http://xxx-xxx-xxx-xxx)
@@ -452,7 +462,7 @@ class HomeyAPIV3 extends HomeyAPI {
             method,
             headers,
             path,
-            originalBody,
+            body: originalBody,
             retryAfterRefresh: true,
           });
         }
@@ -487,9 +497,13 @@ class HomeyAPIV3 extends HomeyAPI {
       this.__loginPromise = Promise.resolve().then(async () => {
         // Check store for a valid Homey.Session
         const store = await this.__getStore();
-        if (store && store.token) {
+
+        if (store && store.token && store.session) {
           this.__debug('Got token from store');
-          return store.token;
+          this.__token = store.token;
+          this.__session = store.session;
+
+          return;
         }
 
         // Create a Session by generating a JWT token on AthomCloudAPI,
@@ -501,21 +515,28 @@ class HomeyAPIV3 extends HomeyAPI {
             $socket: false,
             token: jwtToken,
           });
-          await this.__setStore({ token });
-          this.__debug('Got token');
+          this.__token = token;
+
+          const session = await this.sessions.getSessionMe({
+            $socket: false,
+          });
+          this.__session = session;
+
+          await this.__setStore({ token, session });
 
-          return token;
+          this.__debug('Got token');
+          return;
         }
 
         throw new Error('Cannot Sign In: Missing AthomCloudAPI');
       });
 
       this.__loginPromise
-        .then(token => {
-          this.__token = token;
-        })
+        .then(() => { })
         .catch(err => {
           this.__debug('Error Logging In:', err);
+          this.__token = null;
+          this.__session = null;
         })
         .finally(() => {
           this.__loginPromise = null;
@@ -553,14 +574,16 @@ class HomeyAPIV3 extends HomeyAPI {
     await this.connect();
     await new Promise((resolve, reject) => {
       this.__ioNamespace.once('disconnect', (reason) => {
-        reject(reason);
+        reject(new Error(reason));
       });
+      this.__debug('subscribing', uri);
       this.__ioNamespace.emit('subscribe', uri, err => {
         if (err) {
           this.__debug('Failed to subscribe', uri, err);
           return reject(err)
         }
       
+        this.__debug('subscribed', uri);
         return resolve();
       });
     });
@@ -623,13 +646,15 @@ class HomeyAPIV3 extends HomeyAPI {
         return new Promise((resolve, reject) => {
           this.__debug(`SocketIOClient ${baseUrl}`);
           this.__io = SocketIOClient(baseUrl, {
-            autoConnect: false,
+            autoConnect: true,
             transports: ['websocket'],
             transportOptions: {
               pingTimeout: 8000,
               pingInterval: 5000,
             },
+            reconnection: true,
           });
+
           this.__io.on('disconnect', reason => {
             this.__debug('SocketIOClient.onDisconnect', reason);
             this.__connected = false;
@@ -640,11 +665,18 @@ class HomeyAPIV3 extends HomeyAPI {
               this.__ioNamespace.removeAllListeners();
             }
 
+            if (reason === 'io server disconnect') {
+              // The disconnect was initiated by the server.
+              this.__io.connect();
+            }
+
             reject(new Error('Disconnected'));
           });
+
           this.__io.on('error', err => {
             this.__debug('SocketIOClient.onError', err.message);
           });
+
           this.__io.on('reconnect', () => {
             this.__debug('SocketIOClient.onReconnect');
             this.__handshakeClient()
@@ -658,17 +690,25 @@ class HomeyAPIV3 extends HomeyAPI {
                 reject(err);
               });
           });
+          
+          this.__io.on('reconnect_attempt', () => {
+            this.__debug(`SocketIOClient.onReconnectAttempt`);
+          });
+
           this.__io.on('reconnecting', attempt => {
             this.__debug(`SocketIOClient.onReconnecting (Attempt #${attempt})`);
           });
+
           this.__io.on('reconnect_error', err => {
             this.__debug('SocketIOClient.onReconnectError', err.message);
           });
-          this.__io.once('connect_error', err => {
+
+          this.__io.on('connect_error', err => {
             this.__debug('SocketIOClient.onConnectError', err.message);
             reject(err);
           });
-          this.__io.once('connect', () => {
+
+          this.__io.on('connect', () => {
             this.__debug('SocketIOClient.onConnect');
             this.__handshakeClient()
               .then(() => {
@@ -681,9 +721,10 @@ class HomeyAPIV3 extends HomeyAPI {
                 reject(err);
               });
           });
-          this.__io.connect();
+          // this.__io.connect();
         });
       });
+
       this.io.catch(err => {
         this.__debug('SocketIOClient Error', err.message);
       });
@@ -712,6 +753,8 @@ class HomeyAPIV3 extends HomeyAPI {
   }
 
   async __handshakeClient() {
+    this.__debug('__handshakeClient');
+
     return new Promise((resolve, reject) => {
       this.__io.emit('handshakeClient', {
         token: this.__token,
@@ -746,31 +789,70 @@ class HomeyAPIV3 extends HomeyAPI {
 
         return new Promise((resolve, reject) => {
           this.__ioNamespace = this.__io.io.socket(namespace);
+
+          this.__debug(this.__ioNamespace);
+
+          // Assuming this.__ioNamespace is your namespace object
+          if (this.__ioNamespace.connected) {
+            this.__debug(`SocketIOClient.Namespace[${namespace}].connected`);
+          }
+
           this.__ioNamespace.once('connect', () => {
             this.__debug(`SocketIOClient.Namespace[${namespace}].onConnect`);
             resolve();
           });
+
           this.__ioNamespace.once('connect_error', err => {
             this.__debug(`SocketIOClient.Namespace[${namespace}].onConnectError`, err.message);
             reject(err);
           });
+
           this.__ioNamespace.on('reconnecting', attempt => {
             this.__debug(`SocketIOClient.Namespace[${namespace}].onReconnecting (Attempt #${attempt})`);
           });
+
           this.__ioNamespace.on('reconnect', () => {
             this.__debug(`SocketIOClient.Namespace[${namespace}].onReconnect`);
           });
+
           this.__ioNamespace.on('reconnect_error', err => {
             this.__debug(`SocketIOClient.Namespace[${namespace}].onReconnectError`, err.message);
           });
+
           this.__ioNamespace.on('disconnect', reason => {
             this.__debug(`SocketIOClient.Namespace[${namespace}].onDisconnect`, reason);
           });
-          this.__ioNamespace.connect();
+
+          this.__debug(`SocketIOClient.Namespace[${namespace}].disconnected`, this.__ioNamespace.disconnected);
+          this.__debug(`SocketIOClient.Namespace[${namespace}].connected`, this.__ioNamespace.connected);
         });
       });
   }
 
+  hasScope(scope) {
+    if (this.__session == null) {
+      this.__debug('Tried to call hasScope without a session present.');
+      return true;
+    }
+
+    return this.__session.intersectedScopes.some((availableScope) => {
+      return this.constructor.instanceOfScope(scope, availableScope);
+    });
+  }
+
+  static instanceOfScope(scopeOne, scopeTwo) {
+    const partsOne = scopeOne.split(':');
+    const partsTwo = scopeTwo.split(':');
+
+    let suffixIsEqual = true;
+
+    if (partsOne[1]) {
+      suffixIsEqual = partsOne[1] === partsTwo[1];
+    }
+
+    return scopeOne.indexOf(partsTwo[0]) === 0 && suffixIsEqual;
+  }
+
 }
 
 module.exports = HomeyAPIV3;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.0.19",
+  "version": "3.0.21",
   "description": "Homey API",
   "main": "index.js",
   "files": [
@@ -12,7 +12,7 @@
   ],
   "types": "assets/types/homey-api.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "jest",
     "lint": "eslint .",
     "serve": "concurrently \"serve jsdoc/\"  \"npm run jsdoc:watch\"",
     "build": "npm run build:specs; npm run build:jsdoc; npm run build:types; npm run build:webpack;",
@@ -65,9 +65,11 @@
     "ejs": "^3.1.6",
     "eslint": "^7.32.0",
     "eslint-config-athom": "^2.1.1",
+    "eslint-plugin-jest": "^27.4.0",
     "fs-extra": "^10.0.0",
     "homey-api": "^3.0.8",
     "http-server": "^0.12.3",
+    "jest": "^29.7.0",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
     "jsdoc-ts-utils": "^4.0.0",