homey-api 3.4.32 → 3.4.34

package/assets/specifications/AthomAppsAPI.json

@@ -176,6 +176,36 @@
         }
       }
     },
+    "searchMatterDriver": {
+      "path": "/app/search-matter-driver",
+      "method": "post",
+      "parameters": {
+        "language": {
+          "in": "query",
+          "type": "string"
+        },
+        "homeyVersion": {
+          "type": "string",
+          "in": "body"
+        },
+        "homeyPlatform": {
+          "type": "string",
+          "in": "body"
+        },
+        "homeyMinimumSdkVersion": {
+          "type": "number",
+          "in": "body"
+        },
+        "productId": {
+          "type": "number",
+          "in": "body"
+        },
+        "vendorId": {
+          "type": "number",
+          "in": "body"
+        }
+      }
+    },
     "browseApps": {
       "path": "/app/browse",
       "method": "get",

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

@@ -1623,6 +1623,20 @@ export class AthomAppsAPI {
     manufacturerId?: number;
   }): Promise<any>;
 
+  searchMatterDriver(opts: {
+    language?: string;
+
+    homeyVersion?: string;
+
+    homeyPlatform?: string;
+
+    homeyMinimumSdkVersion?: number;
+
+    productId?: number;
+
+    vendorId?: number;
+  }): Promise<any>;
+
   browseApps(opts: {
     query?: string;
 
@@ -1913,6 +1927,20 @@ export class AthomAppsAPI {
     manufacturerId?: number;
   }): Promise<any>;
 
+  searchMatterDriver(opts: {
+    language?: string;
+
+    homeyVersion?: string;
+
+    homeyPlatform?: string;
+
+    homeyMinimumSdkVersion?: number;
+
+    productId?: number;
+
+    vendorId?: number;
+  }): Promise<any>;
+
   browseApps(opts: {
     query?: string;
 
@@ -4819,6 +4847,20 @@ export class AthomAppsAPI {
     manufacturerId?: number;
   }): Promise<any>;
 
+  searchMatterDriver(opts: {
+    language?: string;
+
+    homeyVersion?: string;
+
+    homeyPlatform?: string;
+
+    homeyMinimumSdkVersion?: number;
+
+    productId?: number;
+
+    vendorId?: number;
+  }): Promise<any>;
+
   browseApps(opts: {
     query?: string;
 
@@ -5109,6 +5151,20 @@ export class AthomAppsAPI {
     manufacturerId?: number;
   }): Promise<any>;
 
+  searchMatterDriver(opts: {
+    language?: string;
+
+    homeyVersion?: string;
+
+    homeyPlatform?: string;
+
+    homeyMinimumSdkVersion?: number;
+
+    productId?: number;
+
+    vendorId?: number;
+  }): Promise<any>;
+
   browseApps(opts: {
     query?: string;
 

package/index.browser.js

@@ -1,6 +1,3 @@
-/* eslint-disable no-undef */
-/* eslint-disable global-require */
-
 'use strict';
 
 global.AthomAppsAPI = require('./lib/AthomAppsAPI');

package/index.js

@@ -1,5 +1,3 @@
-/* eslint-disable global-require */
-
 'use strict';
 
 module.exports = {};

package/lib/API.js

@@ -172,7 +172,6 @@ class API {
 
   __debug(...props) {
     if (!this.__debugEnabled) return;
-    // eslint-disable-next-line no-console
     console.log('[homey-api]', `[${this.constructor.name}]`, ...props);
   }
 

package/lib/APIErrorNotFound.js

@@ -1,5 +1,3 @@
-/* eslint-disable camelcase */
-
 'use strict';
 
 const APIError = require('./APIError');

package/lib/APIErrorTimeout.js

@@ -1,5 +1,3 @@
-/* eslint-disable camelcase */
-
 'use strict';
 
 const APIError = require('./APIError');

package/lib/AthomCloudAPI/StorageAdapterBrowser.js

@@ -17,7 +17,6 @@ class StorageAdapterBrowser extends StorageAdapter {
    */
   async get() {
     try {
-      // eslint-disable-next-line no-undef
       return JSON.parse(window.localStorage.getItem(this.constructor.LOCAL_STORAGE_KEY) || '{}');
     } catch (err) {
       return {};
@@ -29,7 +28,6 @@ class StorageAdapterBrowser extends StorageAdapter {
    * @returns {Promise<void>}
    */
   async set(value) {
-    // eslint-disable-next-line no-undef
     window.localStorage.setItem(this.constructor.LOCAL_STORAGE_KEY, JSON.stringify(value));
   }
 

package/lib/AthomCloudAPI/Token.js

@@ -1,5 +1,3 @@
-/* eslint-disable camelcase */
-
 'use strict';
 
 /**

package/lib/AthomCloudAPI.js

@@ -476,11 +476,9 @@ for(const {@link HomeyAPIV2.ManagerDevices.Device device} of Object.values(devic
 
     // Remove ?code=... from URL
     if (Util.isBrowser() && removeCodeFromHistory) {
-      // eslint-disable-next-line no-undef
       const url = new URL(window.location.href);
       url.searchParams.delete('code');
 
-      // eslint-disable-next-line no-undef
       window.history.pushState(undefined, undefined, url.toString());
     }
 

package/lib/HomeyAPI/HomeyAPI.js

@@ -3,6 +3,9 @@
 const Util = require('../Util');
 const EventEmitter = require('../EventEmitter');
 
+const tierCache = {};
+const versionCache = {};
+
 /**
  * An authenticated Homey API. Do not construct this class manually.
  * @class
@@ -49,6 +52,18 @@ class HomeyAPI extends EventEmitter {
   }) {
     super();
 
+    Object.defineProperty(this, '__tierCache', {
+      value: tierCache,
+      enumerable: false,
+      writable: false,
+    });
+
+    Object.defineProperty(this, '__versionCache', {
+      value: versionCache,
+      enumerable: false,
+      writable: false,
+    });
+
     // Set Debug Enabled
     Object.defineProperty(this, '__debugFunction', {
       value: debug,

package/lib/HomeyAPI/HomeyAPIError.js

@@ -1,5 +1,3 @@
-/* eslint-disable camelcase */
-
 'use strict';
 
 const APIError = require('../APIError');

package/lib/HomeyAPI/HomeyAPIErrorNotFound.js

@@ -1,5 +1,3 @@
-/* eslint-disable camelcase */
-
 'use strict';
 
 const HomeyAPIError = require('./HomeyAPIError');

package/lib/HomeyAPI/HomeyAPIV1.js

@@ -11,8 +11,8 @@ const HomeyAPI = require('./HomeyAPI');
  */
 class HomeyAPIV1 extends HomeyAPI {
 
-  constructor({ properties, ...props }) {
-    super({ properties, ...props });
+  constructor({ properties, api, debug }) {
+    super({ properties, api, debug });
 
     // TODO: Bearer token
     const { token } = this.__properties;

package/lib/HomeyAPI/HomeyAPIV2/Manager.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-multi-assign */
-
 'use strict';
 
 const HomeyAPIV3Manager = require('../HomeyAPIV3/Manager');

package/lib/HomeyAPI/HomeyAPIV3/Manager.js

@@ -1,12 +1,8 @@
-/* eslint-disable no-multi-assign */
-
 'use strict';
 
 const EventEmitter = require('../../EventEmitter');
 const Util = require('../../Util');
 const HomeyAPIError = require('../HomeyAPIError');
-
-// eslint-disable-next-line no-unused-vars
 const Item = require('./Item');
 
 /**

package/lib/HomeyAPI/HomeyAPIV3/ManagerFlow/AdvancedFlow.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-unused-vars */
-
 'use strict';
 
 const Item = require('../Item');
@@ -56,6 +54,7 @@ class AdvancedFlow extends Item {
       if (typeof card.args === 'object') {
         for (const arg of Object.values(card.args)) {
           if (typeof arg !== 'string') continue;
+          // eslint-disable-next-line no-unused-vars
           for (const [tokenMatch, tokenId] of arg.matchAll(/\[\[(.*?)\]\]/g)) {
             await checkToken(tokenId);
           }
@@ -87,6 +86,7 @@ class AdvancedFlow extends Item {
         case 'condition': {
           try {
             await managerFlow.getFlowCardConditions(); // Fill the cache
+            // eslint-disable-next-line no-unused-vars
             const conditionCard = await this.manager.getFlowCardCondition({ id: card.id });
 
             // Add Error Token

package/lib/HomeyAPI/HomeyAPIV3/ManagerFlow/Flow.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-unused-vars */
 
 'use strict';
 
@@ -56,6 +55,7 @@ class Flow extends Item {
       if (typeof card.args === 'object') {
         for (const arg of Object.values(card.args)) {
           if (typeof arg !== 'string') continue;
+          // eslint-disable-next-line no-unused-vars
           for (const [tokenMatch, tokenId] of arg.matchAll(/\[\[(.*?)\]\]/g)) {
             await checkToken(tokenId);
           }
@@ -87,6 +87,7 @@ class Flow extends Item {
       for (const condition of Object.values(this.conditions)) {
         try {
           await managerFlow.getFlowCardConditions(); // Fill the cache
+          // eslint-disable-next-line no-unused-vars
           const conditionCard = await this.manager.getFlowCardCondition({ id: condition.id });
           await checkTokens(condition);
         } catch (err) {
@@ -101,6 +102,7 @@ class Flow extends Item {
       for (const action of Object.values(this.actions)) {
         try {
           await managerFlow.getFlowCardActions(); // Fill the cache
+          // eslint-disable-next-line no-unused-vars
           const actionCard = await this.manager.getFlowCardAction({ id: action.id });
           await checkTokens(action);
         } catch (err) {

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -12,13 +12,8 @@ const ManagerFlow = require('./HomeyAPIV3/ManagerFlow');
 const ManagerFlowToken = require('./HomeyAPIV3/ManagerFlowToken');
 const ManagerInsights = require('./HomeyAPIV3/ManagerInsights');
 const ManagerUsers = require('./HomeyAPIV3/ManagerUsers');
-
-// eslint-disable-next-line no-unused-vars
 const Manager = require('./HomeyAPIV3/Manager');
 
-const tierCache = {};
-const versionCache = {};
-
 /**
  * An authenticated Homey API. Do not construct this class manually.
  * @class
@@ -53,9 +48,10 @@ class HomeyAPIV3 extends HomeyAPI {
     token = null,
     session = null,
     reconnect = true,
-    ...props
+    api,
+    debug,
   }) {
-    super({ properties, ...props });
+    super({ properties, api, debug });
 
     this.__refreshMap = {};
 
@@ -131,21 +127,13 @@ class HomeyAPIV3 extends HomeyAPI {
         this.__baseUrlPromise = this.discoverBaseUrl().then(({ baseUrl }) => {
           return baseUrl;
         });
-        this.__baseUrlPromise.catch(() => {});
+        this.__baseUrlPromise.catch(() => { });
       }
 
       return this.__baseUrlPromise;
     })();
   }
 
-  get tier() {
-    return tierCache[this.id];
-  }
-
-  get version() {
-    return versionCache[this.id];
-  }
-
   get strategyId() {
     return this.__strategyId;
   }
@@ -156,7 +144,6 @@ class HomeyAPIV3 extends HomeyAPI {
    */
 
   getSpecification() {
-    // eslint-disable-next-line global-require
     return require('../../assets/specifications/HomeyAPIV2.json');
   }
 
@@ -174,8 +161,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;
 
@@ -252,60 +239,68 @@ class HomeyAPIV3 extends HomeyAPI {
     // Create the returned Promise
     let resolve;
     let reject;
+
     const promise = new Promise((resolve_, reject_) => {
       resolve = resolve_;
       reject = reject_;
     });
+
     promise
       .then(({ baseUrl, strategyId }) => {
         this.__baseUrl = baseUrl;
         this.__strategyId = strategyId;
       })
-      .catch(() => {});
+      .catch(() => { });
 
     // Ping method
     const ping = async (strategyId, timeout) => {
-      let pingTimeout;
       const baseUrl = urls[strategyId];
-      return Promise.race([
-        Util.fetch(`${baseUrl}/api/manager/system/ping?id=${this.id}`, {
+
+      const response = await 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');
+        },
+        timeout
+      );
 
-          const homeyId = res.headers.get('X-Homey-ID');
+      const text = await response.text();
 
-          if (homeyId) {
-            if (homeyId !== this.id) throw new Error('Invalid Homey ID'); // TODO: Add to Homey Connect
-          }
+      if (!response.ok) {
+        throw new Error(text || response.statusText)
+      }
 
-          // 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;
-          }
+      if (text === 'false') {
+        throw new Error('Invalid Homey ID')
+      }
+
+      const homeyId = response.headers.get('X-Homey-ID');
+
+      if (homeyId && homeyId !== this.id) {
+        throw new Error('Invalid Homey ID'); // TODO: Add to Homey Connect
+      }
 
-          return {
-            baseUrl,
-            strategyId,
-          };
-        }),
-        new Promise((_, reject) => {
-          pingTimeout = setTimeout(() => reject(new Error('PingTimeout')), timeout);
-        }),
-      ]).finally(() => clearTimeout(pingTimeout));
+      // Set the version that Homey told us.
+      // It's the absolute truth, because the Cloud API may be behind.
+      const homeyVersion = response.headers.get('X-Homey-Version');
+
+      if (homeyVersion !== this.version) {
+        this.version = homeyVersion;
+      }
+
+      return {
+        baseUrl,
+        strategyId,
+      };
     };
 
     const pings = {};
 
     // 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, 5000);
+      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]);
@@ -455,6 +450,7 @@ class HomeyAPIV3 extends HomeyAPI {
     }
 
     this.__debug(method, `${baseUrl}${path}`);
+
     const res = await Util.fetch(
       `${baseUrl}${path}`,
       {
@@ -472,11 +468,11 @@ class HomeyAPIV3 extends HomeyAPI {
     const resHeadersContentType = res.headers.get('Content-Type');
     const version = res.headers.get('x-homey-version');
     if (version) {
-      versionCache[this.id] = version;
+      this.__versionCache[this.id] = version;
     }
     const tier = res.headers.get('x-homey-tier');
     if (tier) {
-      tierCache[this.id] = tier;
+      this.__tierCache[this.id] = tier;
     }
 
     const resBodyText = await res.text();
@@ -485,7 +481,7 @@ class HomeyAPIV3 extends HomeyAPI {
       try {
         resBodyJson = JSON.parse(resBodyText);
         // eslint-disable-next-line no-empty
-      } catch (err) {}
+      } catch (err) { }
     }
 
     if (!res.ok) {
@@ -554,31 +550,7 @@ class HomeyAPIV3 extends HomeyAPI {
           return;
         }
 
-        // Create a Session by generating a JWT token on AthomCloudAPI,
-        // and then sending the JWT token to Homey.
-        if (this.__api) {
-          this.__debug('Retrieving token...');
-          const jwtToken = await this.__api.createDelegationToken({ audience: 'homey' });
-          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;
-
-          await this.__setStore({ token, session });
-
-          this.__debug('Got token');
-          return;
-        }
-
-        throw new Error('Cannot Sign In: Missing AthomCloudAPI');
+        await this.__refreshSession();
       });
 
       this.__loginPromise
@@ -596,6 +568,50 @@ class HomeyAPIV3 extends HomeyAPI {
     return this.__loginPromise;
   }
 
+  async __refreshSession() {
+    this.__debug('refreshSession');
+
+    if (this.__api) {
+      // Create a Session by generating a JWT token on AthomCloudAPI,
+      // and then sending the JWT token to Homey.
+      const jwtToken = await this.__api.createDelegationToken({ audience: 'homey' });
+      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;
+
+      await this.__setStore({ session, token });
+
+      this.__debug('Got token');
+      return;
+    }
+
+    throw new Error('Cannot Sign In: Missing AthomCloudAPI');
+  }
+
+  async refreshSession() {
+    if (!this.__refreshSessionPromise) {
+      this.__refreshSessionPromise = this.__refreshSession();
+
+      this.__refreshSessionPromise
+        .catch(err => {
+          this.__debug('Error refreshing session:', err);
+        }).finally(() => {
+          this.__refreshSessionPromise = null;
+        });
+    }
+
+    return this.__refreshSessionPromise;
+  }
+
   async logout() {
     this.__token = null;
     this.__session = null;
@@ -625,12 +641,12 @@ class HomeyAPIV3 extends HomeyAPI {
       });
 
       this.__refreshMap[token]
-        .then(() => {})
+        .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
+          // Delete after 30 seconds some requests might still be pending and they should be able
           // to receive a rejected promise for this token.
           this.__refreshMap[token + 'timeout'] = setTimeout(() => {
             delete this.__refreshMap[token];
@@ -647,17 +663,17 @@ class HomeyAPIV3 extends HomeyAPI {
    * @returns {Boolean}
    */
   isConnected() {
-    return this.__homeySocket && this.__homeySocket.connected;
+    return Boolean(this.__homeySocket && this.__homeySocket.connected);
   }
 
   async subscribe(
     uri,
     {
-      onConnect = () => {},
-      onReconnect = () => {},
-      onReconnectError = () => {},
-      onDisconnect = () => {},
-      onEvent = () => {},
+      onConnect = () => { },
+      onReconnect = () => { },
+      onReconnectError = () => { },
+      onDisconnect = () => { },
+      onEvent = () => { },
     }
   ) {
     this.__debug('subscribe', uri);

package/lib/HomeyAPI/HomeyAPIV3Cloud.js

@@ -2,6 +2,7 @@
 
 const HomeyAPIV3 = require('./HomeyAPIV3');
 
+
 /**
  * This class is returned by {@link AthomCloudAPI.Homey#authenticate} for a Homey with `platform: 'cloud'` and `platformVersion: 1`.
  *
@@ -33,6 +34,14 @@ class HomeyAPIV3Cloud extends HomeyAPIV3 {
     });
   }
 
+  get tier() {
+    return this.__tierCache[this.id];
+  }
+
+  get version() {
+    return this.__versionCache[this.id];
+  }
+
   get platform() {
     return 'cloud';
   }
@@ -42,7 +51,6 @@ class HomeyAPIV3Cloud extends HomeyAPIV3 {
   }
 
   getSpecification() {
-    // eslint-disable-next-line global-require
     return require('../../assets/specifications/HomeyAPIV3Cloud.json');
   }
 

package/lib/HomeyAPI/HomeyAPIV3Local.js

@@ -26,7 +26,6 @@ class HomeyAPIV3Local extends HomeyAPIV3 {
   }
 
   getSpecification() {
-    // eslint-disable-next-line global-require
     return require('../../assets/specifications/HomeyAPIV3Local.json');
   }
 

package/lib/Util.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-undef */
-
 'use strict';
 
 const APIErrorTimeout = require('./APIErrorTimeout');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.4.32",
+  "version": "3.4.34",
   "description": "Homey API",
   "main": "index.js",
   "files": [
@@ -16,6 +16,7 @@
     "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;",
+    "build:docs": "plantuml-cli -tsvg SOCKET.md",
     "build:webpack": "npm run webpack",
     "build:webpack:watch": "npm run webpack:watch",
     "build:types": "npm run generate-types;",
@@ -75,6 +76,7 @@
     "jsdoc-ts-utils": "^4.0.0",
     "jsdoc-tsimport-plugin": "^1.0.5",
     "keypather": "^3.1.0",
+    "plantuml-cli": "^1.2024.4",
     "prettier": "^3.2.5",
     "serve": "^14.0.1",
     "socket.io": "^4.7.4",