homey-api 3.4.19 → 3.4.21

package/assets/specifications/HomeyAPIV3Cloud.json

@@ -3775,6 +3775,33 @@
       "idCamelCase": "zwave",
       "items": {},
       "operations": {
+        "getOptionRegionOverride": {
+          "method": "GET",
+          "path": "/option/regionOverride",
+          "scopes": [
+            "homey.system.readonly"
+          ]
+        },
+        "setOptionRegionOverride": {
+          "method": "PUT",
+          "path": "/option/regionOverride",
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "value": {
+              "in": "body",
+              "required": true
+            }
+          }
+        },
+        "unsetOptionRegionOverride": {
+          "method": "DELETE",
+          "path": "/option/regionOverride",
+          "scopes": [
+            "homey.system"
+          ]
+        },
         "getState": {
           "method": "get",
           "path": "/state",

package/assets/types/homey-api.d.ts

@@ -2634,6 +2634,12 @@ export namespace HomeyAPIV3Cloud {
   }
 
   export class ManagerZwave extends HomeyAPIV3.ManagerZwave {
+    getOptionRegionOverride(): Promise<any>;
+
+    setOptionRegionOverride(opts: { value: any }): Promise<any>;
+
+    unsetOptionRegionOverride(): Promise<any>;
+
     getState(): Promise<any>;
 
     runCommand(opts: {

package/assets/types/homey-api.private.d.ts

@@ -8640,6 +8640,12 @@ export namespace HomeyAPIV3Cloud {
   }
 
   export class ManagerZwave extends HomeyAPIV3.ManagerZwave {
+    getOptionRegionOverride(): Promise<any>;
+
+    setOptionRegionOverride(opts: { value: any }): Promise<any>;
+
+    unsetOptionRegionOverride(): Promise<any>;
+
     getState(): Promise<any>;
 
     runCommand(opts: {

package/lib/AthomCloudAPI.js

@@ -324,7 +324,7 @@ for(const {@link HomeyAPIV2.ManagerDevices.Device device} of Object.values(devic
     ...props
   }) {
     if (statusCode === 401 && body.error === 'invalid_token') {
-      if (this.__autoRefreshTokens && !request.context.retryAfterRefresh) {
+      if (this.__autoRefreshTokens && !request.context.isRetryAfterRefresh) {
         this.__debug('Refreshing token...');
         await this.authenticateWithRefreshToken();
 
@@ -333,7 +333,7 @@ for(const {@link HomeyAPIV2.ManagerDevices.Device device} of Object.values(devic
           ...request,
           context: {
             ...request.context,
-            retryAfterRefresh: true,
+            isRetryAfterRefresh: true,
           },
         });
       }

package/lib/HomeyAPI/HomeyAPIV3/Manager.js

@@ -107,6 +107,7 @@ class Manager extends EventEmitter {
             $body = {},
             $query = {},
             $headers = {},
+            shouldRetry,
             ...args
           } = {}) => {
             let { path } = operation;
@@ -215,6 +216,7 @@ class Manager extends EventEmitter {
               body,
               query,
               headers,
+              shouldRetry,
               ...args,
             });
 
@@ -244,7 +246,7 @@ class Manager extends EventEmitter {
     }
   }
 
-  async __request({ $cache, $updateCache, $timeout, $socket, operationId, operation, path, body, headers, ...args }) {
+  async __request({ $cache, $updateCache, $timeout, $socket, operationId, operation, path, body, headers, shouldRetry, ...args }) {
     let result;
     const benchmark = Util.benchmark();
 
@@ -323,6 +325,7 @@ class Manager extends EventEmitter {
         body,
         path: `/api/manager/${this.constructor.ID}${path}`,
         method: operation.method,
+        shouldRetry,
       });
     }
 

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -53,6 +53,8 @@ class HomeyAPIV3 extends HomeyAPI {
   }) {
     super({ properties, ...props });
 
+    this.__refreshMap = {};
+
     Object.defineProperty(this, '__baseUrl', {
       value: null,
       enumerable: false,
@@ -412,7 +414,17 @@ 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, 
+    isRetryAfterRefresh = false,
+    shouldRetry = true,
+  }) {
+    const token = this.__token;
     const baseUrl = await this.baseUrl;
 
     method = String(method).toUpperCase();
@@ -422,11 +434,12 @@ class HomeyAPIV3 extends HomeyAPI {
       'X-Homey-ID': this.id,
     };
 
-    if (this.__token) {
-      headers['Authorization'] = `Bearer ${this.__token}`;
+    if (token) {
+      headers['Authorization'] = `Bearer ${token}`;
     }
 
     const originalBody = body;
+
     if (['PUT', 'POST'].includes(method)) {
       if (body && json === true) {
         headers['Content-Type'] = 'application/json';
@@ -470,26 +483,23 @@ class HomeyAPIV3 extends HomeyAPI {
     }
 
     if (!res.ok) {
-      if (resBodyJson) {
-        // If Session Expired, clear the stored token
-        if (resStatusCode === 401) {
-          this.__debug('Session expired, invalidating token...');
-          await this.logout();
-        }
+      // If Session Expired, clear the stored token
+      if (resStatusCode === 401 && shouldRetry === true && token != null) {
+        this.__debug('Session expired');
+        await this.refreshForToken(token, isRetryAfterRefresh);
 
-        // If Session Expired, try to refresh the Token
-        if (resStatusCode === 401 && !retryAfterRefresh) {
-          this.__debug('Session expired, refreshing...');
-          await this.login();
+        if (!isRetryAfterRefresh) {
           return this.call({
             method,
             headers,
             path,
             body: originalBody,
-            retryAfterRefresh: true,
+            isRetryAfterRefresh: true,
           });
         }
+      }
 
+      if (resBodyJson) {
         throw new HomeyAPIError(
           {
             error: resBodyJson.error,
@@ -546,11 +556,13 @@ class HomeyAPIV3 extends HomeyAPI {
           const token = await this.users.login({
             $socket: false,
             token: jwtToken,
+            shouldRetry: false,
           });
           this.__token = token;
 
           const session = await this.sessions.getSessionMe({
             $socket: false,
+            shouldRetry: false,
           });
           this.__session = session;
 
@@ -564,14 +576,14 @@ class HomeyAPIV3 extends HomeyAPI {
       });
 
       this.__loginPromise
-        .then(() => {})
+        .then(() => {
+          this.__loginPromise = null;
+        })
         .catch(err => {
           this.__debug('Error Logging In:', err);
+          this.__loginPromise = null;
           this.__token = null;
           this.__session = null;
-        })
-        .finally(() => {
-          this.__loginPromise = null;
         });
     }
 
@@ -579,11 +591,49 @@ class HomeyAPIV3 extends HomeyAPI {
   }
 
   async logout() {
+    this.__token = null;
+    this.__session = null;
+
     await this.__setStore({
       token: null,
+      session: null,
     });
+  }
 
-    this.__token = null;
+  async refreshForToken(token, isRetryAfterRefresh = false) {
+    if (this.__token === token && this.__token !== null && this.__refreshMap[token] == null) {
+      this.__refreshMap[token] = Promise.resolve().then(async () => {
+        await this.__setStore({
+          token: null,
+          session: null,
+        });
+
+        if (!isRetryAfterRefresh) {
+          this.__debug('Refreshing token...');
+          // If the login fails, the tokens are cleared on the instance. We don't call logout and clear
+          // the token on the instance because that could cause a handshake client to fire with a null
+          // token. Handshake client also needs to attempt to refresh the token, and if the refresh was
+          // already started, it should reuse this promise. That also goes the other way around.
+          await this.login();
+        }
+      });
+
+      this.__refreshMap[token]
+        .then(() => {})
+        .catch(err => {
+          this.__debug('Error Refreshing Token:', err);
+        })
+        .finally(() => {
+          // Delete after 30 seconds some requests might still be pending an they should be able
+          // to receive a rejected promise for this token.
+          this.__refreshMap[token+'timeout'] = setTimeout(() => {
+            delete this.__refreshMap[token];
+            delete this.__refreshMap[token+'timeout'];
+          }, 30 * 1000);
+        });
+    }
+
+    await this.__refreshMap[token];
   }
 
   /**
@@ -879,16 +929,16 @@ class HomeyAPIV3 extends HomeyAPI {
       });
     };
 
-    const handshakeClient = async () => {
+    const handshakeClient = async token => {
       return new Promise((resolve, reject) => {
         this.__socket.emit(
           'handshakeClient',
           {
-            token: this.__token,
+            token,
             homeyId: this.id,
           },
           (err, result) => {
-            if (err != null) {            
+            if (err != null) {
               if (typeof err === 'object') {
                 err = new HomeyAPIError(
                   {
@@ -916,18 +966,22 @@ class HomeyAPIV3 extends HomeyAPI {
       });
     };
 
+    const token = this.__token;
+
     try {
-      const result = await Util.timeout(handshakeClient(), 5000, `Failed to handshake client (Timeout after 5000ms).`);
+      const result = await Util.timeout(
+        handshakeClient(token),
+        5000,
+        `Failed to handshake client (Timeout after 5000ms).`
+      );
 
       return onResult(result);
     } catch (err) {
       if (err.statusCode === 401 || err.code === 401) {
         this.__debug('Token expired, refreshing...');
-        await this.logout();
-        await this.login();
-
+        await this.refreshForToken(token, false);
         const result = await Util.timeout(
-          handshakeClient(),
+          handshakeClient(this.__token),
           5000,
           `Failed to handshake client (Timeout after 5000ms).`
         );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.4.19",
+  "version": "3.4.21",
   "description": "Homey API",
   "main": "index.js",
   "files": [
@@ -12,7 +12,7 @@
   ],
   "types": "assets/types/homey-api.d.ts",
   "scripts": {
-    "test": "jest",
+    "test": "jest --verbose",
     "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;",
@@ -56,6 +56,7 @@
     "@babel/core": "^7.16.0",
     "@babel/plugin-proposal-class-properties": "^7.16.0",
     "@babel/preset-env": "^7.16.0",
+    "@types/jest": "^29.5.12",
     "@typescript-eslint/eslint-plugin": "^6.1.0",
     "@typescript-eslint/parser": "^6.1.0",
     "babel-loader": "^8.2.3",
@@ -64,17 +65,19 @@
     "eslint": "^7.32.0",
     "eslint-config-athom": "^2.1.1",
     "eslint-plugin-jest": "^27.4.0",
+    "express": "^4.18.2",
     "fs-extra": "^10.0.0",
     "homey-api": "^3.0.8",
     "http-server": "^0.12.3",
-    "jest": "^29.7.0",
+    "jest": "^30.0.0-alpha.2",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
     "jsdoc-ts-utils": "^4.0.0",
     "jsdoc-tsimport-plugin": "^1.0.5",
     "keypather": "^3.1.0",
-    "prettier": "^3.0.0",
+    "prettier": "^3.2.5",
     "serve": "^14.0.1",
+    "socket.io": "^4.7.4",
     "typescript": "^5.1.6",
     "watch": "^1.0.2",
     "webpack": "^5.64.0",