homey-api 3.16.0 → 3.17.0

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

@@ -5782,12 +5782,6 @@ export class Util {
 
   static encodeUrlSearchParams(params: object): string;
 
-  static deepEqual(
-    a: any,
-
-    b: any,
-  ): boolean;
-
   static fetch(
     args: string,
 
@@ -5829,12 +5823,6 @@ export class Util {
   static serializeQueryObject(queryObject: object): string;
 
   static encodeUrlSearchParams(params: object): string;
-
-  static deepEqual(
-    a: any,
-
-    b: any,
-  ): boolean;
 }
 
 export class APIDefinition {}
@@ -9212,12 +9200,6 @@ export class Util {
 
   static encodeUrlSearchParams(params: object): string;
 
-  static deepEqual(
-    a: any,
-
-    b: any,
-  ): boolean;
-
   static fetch(
     args: string,
 
@@ -9259,12 +9241,6 @@ export class Util {
   static serializeQueryObject(queryObject: object): string;
 
   static encodeUrlSearchParams(params: object): string;
-
-  static deepEqual(
-    a: any,
-
-    b: any,
-  ): boolean;
 }
 
 export namespace HomeyAPIV3Cloud {

package/lib/HomeyAPI/HomeyAPI.js

@@ -90,6 +90,7 @@ class HomeyAPI extends EventEmitter {
       value: properties.softwareVersion ?? null,
       enumerable: true,
       writable: true,
+      configurable: true,
     });
 
     // Set Name

package/lib/HomeyAPI/HomeyAPIV3/Item.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const EventEmitter = require('../../EventEmitter');
-const Util = require('../../Util');
 
 /**
  * A superclass for all CRUD Items.
@@ -95,43 +94,14 @@ class Item extends EventEmitter {
   }
 
   __update(properties) {
-    const oldValues = {};
-    const newValues = {};
-    const changedKeys = [];
-
     for (const [key, value] of Object.entries(properties)) {
       if (key === 'id') continue;
-
-      if (!Util.deepEqual(this[key], value)) {
-        oldValues[key] = Util.deepClone(this[key]);
-        newValues[key] = Util.deepClone(value);
-        changedKeys.push(key);
-
-        this[key] = value;
-      }
+      this[key] = value;
     }
 
     this.__lastUpdated = new Date();
 
-    if (changedKeys.length === 0) {
-      return {
-        oldValues,
-        newValues,
-        changedKeys,
-      };
-    }
-
-    this.emit('update', properties, {
-      oldValues,
-      newValues,
-      changedKeys,
-    });
-
-    return {
-      oldValues,
-      newValues,
-      changedKeys,
-    };
+    this.emit('update', properties);
   }
 
   __delete() {

package/lib/HomeyAPI/HomeyAPIV3/Manager.js

@@ -531,19 +531,8 @@ class Manager extends EventEmitter {
 
                   if (this.__cache[ItemClass.ID][props.id]) {
                     const item = this.__cache[ItemClass.ID][props.id];
-                    const {
-                      oldValues,
-                      newValues,
-                      changedKeys,
-                    } = item.__update(props);
-
-                    if (changedKeys.length === 0) return;
-
-                    return this.emit(event, item, {
-                      oldValues,
-                      newValues,
-                      changedKeys,
-                    });
+                    item.__update(props);
+                    return this.emit(event, item);
                   }
 
                   break;

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -228,20 +228,6 @@ class HomeyAPIV3 extends HomeyAPI {
       throw new Error('No Discovery Strategies Available');
     }
 
-    // TODO
-    // maybe we should always ping
-
-    // Don't discover, just set the only strategy
-    if (Object.keys(urls).length === 1) {
-      this.__baseUrl = Object.values(urls)[0];
-      this.__strategyId = Object.keys(urls)[0];
-
-      return {
-        baseUrl: this.__baseUrl,
-        strategyId: this.__strategyId,
-      };
-    }
-
     this.__debug(`Discovery Strategies: ${Object.keys(urls).join(',')}`);
 
     // Create the returned Promise
@@ -448,7 +434,7 @@ class HomeyAPIV3 extends HomeyAPI {
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]
         .then((result) => resolve(result))
-        .catch(() => {
+        .catch((err) => {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
@@ -463,12 +449,14 @@ class HomeyAPIV3 extends HomeyAPI {
 
                 reject(new APIErrorHomeyOffline(err));
               });
+          } else {
+            reject(new APIErrorHomeyOffline(err));
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS]
         .then((result) => resolve(result))
-        .catch(() => {
+        .catch((err) => {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
@@ -483,12 +471,14 @@ class HomeyAPIV3 extends HomeyAPI {
 
                 reject(new APIErrorHomeyOffline(err));
               });
+          } else {
+            reject(new APIErrorHomeyOffline(err));
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED]
         .then((result) => resolve(result))
-        .catch(() => {
+        .catch((err) => {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
@@ -503,6 +493,8 @@ class HomeyAPIV3 extends HomeyAPI {
 
                 reject(new APIErrorHomeyOffline(err));
               });
+          } else {
+            reject(new APIErrorHomeyOffline(err));
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
@@ -660,6 +652,7 @@ class HomeyAPIV3 extends HomeyAPI {
           this.__token = store.token;
           this.__session = store.session;
 
+          await this.baseUrl; // Ensure discovery has completed
           return;
         }
 

package/lib/HomeyAPI/HomeyAPIV3Cloud.js

@@ -32,6 +32,11 @@ class HomeyAPIV3Cloud extends HomeyAPIV3 {
       strategy,
       ...props,
     });
+
+    // Seed the version cache with the initial value from the Cloud API,
+    // then remove the own data property so the prototype getter is used.
+    this.__versionCache[this.id] ??= this.version;
+    delete this.version;
   }
 
   get tier() {
@@ -42,6 +47,10 @@ class HomeyAPIV3Cloud extends HomeyAPIV3 {
     return this.__versionCache[this.id];
   }
 
+  set version(value) {
+    this.__versionCache[this.id] = value;
+  }
+
   get platform() {
     return 'cloud';
   }

package/lib/Util.js

@@ -338,92 +338,6 @@ class Util {
     return encodedPairs.join('&');
   }
 
-  /**
-   * Deep equality check between two values.
-   * @param {any} a
-   * @param {any} b
-   * @returns {boolean}
-   */
-  static deepEqual(a, b) {
-    if (a === b) return true;
-
-    if (
-      typeof a !== 'object' ||
-      typeof b !== 'object' ||
-      a === null ||
-      b === null
-    ) {
-      return false;
-    }
-
-    const keysA = Object.keys(a);
-    const keysB = Object.keys(b);
-
-    if (keysA.length !== keysB.length) return false;
-
-    for (const key of keysA) {
-      if (!keysB.includes(key) || !this.deepEqual(a[key], b[key])) {
-        return false;
-      }
-    }
-
-    return true;
-  }
-
-  static deepClone(value) {
-    // Use native structuredClone when available
-    if (typeof structuredClone === 'function') {
-      return structuredClone(value);
-    }
-
-    const seen = new WeakMap();
-
-    function clone(val) {
-      if (val === null || typeof val !== 'object') {
-        return val;
-      }
-
-      if (seen.has(val)) {
-        return seen.get(val);
-      }
-
-      if (val instanceof Date) {
-        return new Date(val);
-      }
-
-      if (val instanceof Map) {
-        const map = new Map();
-        seen.set(val, map);
-        val.forEach((v, k) => map.set(clone(k), clone(v)));
-        return map;
-      }
-
-      if (val instanceof Set) {
-        const set = new Set();
-        seen.set(val, set);
-        val.forEach(v => set.add(clone(v)));
-        return set;
-      }
-
-      if (Array.isArray(val)) {
-        const arr = [];
-        seen.set(val, arr);
-        val.forEach((v, i) => arr[i] = clone(v));
-        return arr;
-      }
-
-      const obj = {};
-      seen.set(val, obj);
-      Object.keys(val).forEach(key => {
-        obj[key] = clone(val[key]);
-      });
-
-      return obj;
-    }
-
-    return clone(value);
-  }
-
 }
 
 module.exports = Util;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "Homey API",
   "main": "index.js",
   "license": "SEE LICENSE",
@@ -73,7 +73,7 @@
     "homey-api": "^3.0.8",
     "http-server": "^0.12.3",
     "jest": "^30.0.0-alpha.2",
-    "jsdoc": "^4.0.2",
+    "jsdoc": "4.0.5",
     "jsdoc-to-markdown": "^8.0.0",
     "jsdoc-ts-utils": "^4.0.0",
     "jsdoc-tsimport-plugin": "^1.0.5",