homey-api 3.4.10 → 3.4.11

package/lib/HomeyAPI/HomeyAPIV3/Manager.js

@@ -16,15 +16,10 @@ const Item = require('./Item');
  * @memberof HomeyAPIV3
  */
 class Manager extends EventEmitter {
-
   static ID = null; // Set by HomeyAPIV3.js
   static CRUD = {};
 
-  constructor({
-    homey,
-    items,
-    operations,
-  }) {
+  constructor({ homey, items, operations }) {
     super();
 
     Object.defineProperty(this, '__homey', {
@@ -38,9 +33,9 @@ class Manager extends EventEmitter {
         const ItemClass = this.constructor.CRUD[itemName]
           ? this.constructor.CRUD[itemName]
           : (() => {
-            return class extends Item {};
-          })();
-  
+              return class extends Item {};
+            })();
+
         ItemClass.ID = item.id;
         obj[itemName] = ItemClass;
 
@@ -67,19 +62,25 @@ class Manager extends EventEmitter {
     });
 
     Object.defineProperty(this, '__cache', {
-      value: Object.values(items).reduce((obj, item) => ({
-        ...obj,
-        [item.id]: {},
-      }), {}),
+      value: Object.values(items).reduce(
+        (obj, item) => ({
+          ...obj,
+          [item.id]: {},
+        }),
+        {}
+      ),
       enumerable: false,
       writable: false,
     });
 
     Object.defineProperty(this, '__cacheAllComplete', {
-      value: Object.values(items).reduce((obj, item) => ({
-        ...obj,
-        [item.id]: false,
-      }), {}),
+      value: Object.values(items).reduce(
+        (obj, item) => ({
+          ...obj,
+          [item.id]: false,
+        }),
+        {}
+      ),
       enumerable: false,
       writable: false,
     });
@@ -92,15 +93,15 @@ class Manager extends EventEmitter {
 
     // Create methods
     for (const [operationId, operation] of Object.entries(operations)) {
-      Object.defineProperty(this,
+      Object.defineProperty(
+        this,
         // Name method __super__foo if there's an override method
-        this[operationId]
-          ? `__super__${operationId}`
-          : operationId,
+        this[operationId] ? `__super__${operationId}` : operationId,
         {
           value: async ({
             $validate = true,
             $cache = true,
+            $updateCache = true,
             $timeout = operation.timeout ?? 5000,
             $socket = operation.socket ?? true,
             $body = {},
@@ -135,7 +136,9 @@ class Manager extends EventEmitter {
                     }
 
                     if (parameter.type === 'boolean' && typeof value !== 'boolean') {
-                      throw new Error(`Invalid Parameter Type: ${parameterId}. Got: ${typeof value}. Expected: boolean`);
+                      throw new Error(
+                        `Invalid Parameter Type: ${parameterId}. Got: ${typeof value}. Expected: boolean`
+                      );
                     }
 
                     if (parameter.type === 'object' && typeof value !== 'object') {
@@ -185,7 +188,7 @@ class Manager extends EventEmitter {
               path = `${path}?${queryString}`;
             }
 
-            const pendingCallId = `${operationId}::${path}`
+            const pendingCallId = `${operationId}::${path}`;
 
             if (
               operation.method.toLowerCase() === 'get' &&
@@ -203,6 +206,7 @@ class Manager extends EventEmitter {
             const pendingCall = this.__request({
               $validate,
               $cache,
+              $updateCache,
               $timeout,
               $socket,
               operationId,
@@ -211,7 +215,7 @@ class Manager extends EventEmitter {
               body,
               query,
               headers,
-              ...args
+              ...args,
             });
 
             if (
@@ -221,23 +225,26 @@ class Manager extends EventEmitter {
               Object.keys(body).length === 0
             ) {
               this.__pendingCalls[pendingCallId] = pendingCall;
-              this.__pendingCalls[pendingCallId].catch(() => {
-                // We do nothing with the error here the caller is responsible. We just want to 
-                // cleanup the pending call.
-              }).finally(() => {
-                delete this.__pendingCalls[pendingCallId];
-              });
+              this.__pendingCalls[pendingCallId]
+                .catch(() => {
+                  // We do nothing with the error here the caller is responsible. We just want to
+                  // cleanup the pending call.
+                })
+                .finally(() => {
+                  delete this.__pendingCalls[pendingCallId];
+                });
             }
 
             const result = await pendingCall;
 
             return result;
           },
-        });
+        }
+      );
     }
   }
 
-  async __request({ $cache, $timeout, $socket, operationId, operation, path, body, headers, ...args }) {
+  async __request({ $cache, $updateCache, $timeout, $socket, operationId, operation, path, body, headers, ...args }) {
     let result;
     const benchmark = Util.benchmark();
 
@@ -269,34 +276,47 @@ class Manager extends EventEmitter {
     // send the API request to socket.io.
     // This is about ~2x faster than HTTP
     if (this.homey.isConnected() && $socket === true) {
-      result = await Util.timeout(new Promise((resolve, reject) => {
-        this.__debug(`IO ${operationId}`);
-        this.homey.__homeySocket.emit('api', {
-          args,
-          operation: operationId,
-          uri: this.uri,
-        }, (err, result) => {
-          // String Error
-          if (typeof err === 'string') {
-            err = new HomeyAPIError({
-              error: err,
-            }, 500);
-            return reject(err);
-          }
+      result = await Util.timeout(
+        new Promise((resolve, reject) => {
+          this.__debug(`IO ${operationId}`);
+          this.homey.__homeySocket.emit(
+            'api',
+            {
+              args,
+              operation: operationId,
+              uri: this.uri,
+            },
+            (err, result) => {
+              // String Error
+              if (typeof err === 'string') {
+                err = new HomeyAPIError(
+                  {
+                    error: err,
+                  },
+                  500
+                );
+                return reject(err);
+              }
 
-          // Object Error
-          if (typeof err === 'object' && err !== null) {
-            err = new HomeyAPIError({
-              stack: err.stack,
-              error: err.error,
-              error_description: err.error_description,
-            }, err.statusCode || err.code || 500);
-            return reject(err);
-          }
+              // Object Error
+              if (typeof err === 'object' && err !== null) {
+                err = new HomeyAPIError(
+                  {
+                    stack: err.stack,
+                    error: err.error,
+                    error_description: err.error_description,
+                  },
+                  err.statusCode || err.code || 500
+                );
+                return reject(err);
+              }
 
-          return resolve(result);
-        });
-      }), $timeout);
+              return resolve(result);
+            }
+          );
+        }),
+        $timeout
+      );
     } else {
       // Get from HTTP
       result = await this.homey.call({
@@ -324,7 +344,7 @@ class Manager extends EventEmitter {
             properties: props,
           });
 
-          if (this.isConnected()) {
+          if (this.isConnected() && $updateCache === true) {
             this.__cache[ItemClass.ID][item.id] = item;
           }
 
@@ -337,7 +357,7 @@ class Manager extends EventEmitter {
           for (let props of Object.values(result)) {
             props = ItemClass.transformGet(props);
 
-            if (this.isConnected() && this.__cache[ItemClass.ID][props.id]) {
+            if (this.isConnected() && $updateCache === true && this.__cache[ItemClass.ID][props.id]) {
               items[props.id] = this.__cache[ItemClass.ID][props.id];
               items[props.id].__update(props);
             } else {
@@ -348,14 +368,14 @@ class Manager extends EventEmitter {
                 properties: props,
               });
 
-              if (this.isConnected()) {
+              if (this.isConnected() && $updateCache === true) {
                 this.__cache[ItemClass.ID][props.id] = items[props.id];
               }
             }
           }
 
           // Find and delete deleted items from cache
-          if (this.__cache[ItemClass.ID]) {
+          if (this.__cache[ItemClass.ID] && $updateCache === true) {
             for (const cachedItem of Object.values(this.__cache[ItemClass.ID])) {
               if (!items[cachedItem.id]) {
                 delete this.__cache[ItemClass.ID][cachedItem.id];
@@ -364,7 +384,7 @@ class Manager extends EventEmitter {
           }
 
           // Mark cache as complete
-          if (this.isConnected()) {
+          if (this.isConnected() && $updateCache === true) {
             this.__cacheAllComplete[ItemClass.ID] = true;
           }
 
@@ -377,7 +397,7 @@ class Manager extends EventEmitter {
 
           props = ItemClass.transformGet(props);
 
-          if (this.isConnected() && this.__cache[ItemClass.ID][props.id]) {
+          if (this.isConnected() && $updateCache === true && this.__cache[ItemClass.ID][props.id]) {
             item = this.__cache[ItemClass.ID][props.id];
             item.__update(props);
           } else {
@@ -388,7 +408,7 @@ class Manager extends EventEmitter {
               properties: { ...props },
             });
 
-            if (this.isConnected()) {
+            if (this.isConnected() && $updateCache === true) {
               this.__cache[ItemClass.ID][props.id] = item;
             }
           }
@@ -396,7 +416,7 @@ class Manager extends EventEmitter {
           return item;
         }
         case 'deleteOne': {
-          if (this.isConnected() && this.__cache[ItemClass.ID][args.id]) {
+          if (this.isConnected() && $updateCache === true && this.__cache[ItemClass.ID][args.id]) {
             this.__cache[ItemClass.ID][args.id].destroy();
             delete this.__cache[ItemClass.ID][args.id];
           }
@@ -450,19 +470,17 @@ class Manager extends EventEmitter {
     // If disconnecting, await that first
     try {
       await this.__disconnectPromise;
-    // eslint-disable-next-line no-empty
-    } catch (err) { 
-
-    }
+      // eslint-disable-next-line no-empty
+    } catch (err) {}
 
     if (this.__connectPromise) {
-      await this.__connectPromise
+      await this.__connectPromise;
       return;
     }
 
     if (this.io) {
       await this.io;
-      return
+      return;
     }
 
     this.__connectPromise = Promise.resolve().then(async () => {
@@ -492,9 +510,7 @@ class Manager extends EventEmitter {
             this.__debug('onEvent', event);
 
             // Transform & add to cache if this is a CRUD event
-            if (event.endsWith('.create')
-              || event.endsWith('.update')
-              || event.endsWith('.delete')) {
+            if (event.endsWith('.create') || event.endsWith('.update') || event.endsWith('.delete')) {
               const [itemId, operation] = event.split('.');
               const itemName = this.itemNames[itemId];
               const ItemClass = this.itemClasses[itemName];
@@ -554,7 +570,7 @@ class Manager extends EventEmitter {
 
     // Delete the connecting Promise
     this.__connectPromise
-      .catch(() => { 
+      .catch(() => {
         delete this.io;
       })
       .finally(() => {
@@ -574,18 +590,14 @@ class Manager extends EventEmitter {
     // If connecting, await that first
     try {
       await this.__connectPromise;
-    // eslint-disable-next-line no-empty
-    } catch (err) { 
-
-    }
+      // eslint-disable-next-line no-empty
+    } catch (err) {}
 
     this.__disconnectPromise = Promise.resolve().then(async () => {
       this.__connected = false;
 
       if (this.io) {
-        await this.io
-          .then(io => io.unsubscribe())
-          .catch(err => this.__debug('Error Disconnecting:', err));
+        await this.io.then(io => io.unsubscribe()).catch(err => this.__debug('Error Disconnecting:', err));
 
         delete this.io;
       }
@@ -593,7 +605,7 @@ class Manager extends EventEmitter {
 
     // Delete the disconnecting Promise
     this.__disconnectPromise
-      .catch(() => { })
+      .catch(() => {})
       .finally(() => {
         delete this.__disconnectPromise;
       });
@@ -618,9 +630,8 @@ class Manager extends EventEmitter {
     this.removeAllListeners();
 
     // Disconnect from Socket.io
-    this.disconnect().catch(() => { });
+    this.disconnect().catch(() => {});
   }
-
 }
 
 module.exports = Manager;

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

@@ -127,31 +127,6 @@ class Device extends Item {
     this.manager.scheduleRefresh();
   }
 
-  refreshCapabilityInstances() {
-    Object.entries(this.__capabilityInstances).forEach(([capabilityId, capabilityInstances]) => {
-      const value = this.capabilitiesObj
-        ? this.capabilitiesObj[capabilityId] != null
-          ? this.capabilitiesObj[capabilityId].value
-          : null
-        : null;
-
-      const lastUpdated = this.capabilitiesObj
-        ? this.capabilitiesObj[capabilityId] != null
-          ? this.capabilitiesObj[capabilityId].lastUpdated
-          : null
-        : null;
-
-      for (const capabilityInstance of capabilityInstances) {
-        capabilityInstance.__onCapabilityValue({
-          capabilityId,
-          value,
-          transactionId: Util.uuid(),
-          transactionTime: lastUpdated
-        });
-      }
-    });
-  }
-
   /**
    * Get the device's zone.
    * @returns {Promise<HomeyAPIV3.ManagerZones.Zone>}

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

@@ -96,16 +96,24 @@ class DeviceCapability extends EventEmitter {
     transactionTime,
   }) {
     if (capabilityId !== this.id) return;
+
     if (this.__transactionIds[transactionId]) {
       delete this.__transactionIds[transactionId];
       return;
     }
 
+    const nextLastChanged = new Date(transactionTime);
+
+    if (this.__lastChanged != null && nextLastChanged.getTime() === this.__lastChanged.getTime()) {
+      return;
+    }
+
     this.__value = value;
-    this.__lastChanged = new Date(transactionTime);
+    this.__lastChanged = nextLastChanged;
 
     // Mutate the current device capabilitiesObj so it always reflects the last value.
     const capabilityReference = this.device.capabilitiesObj && this.device.capabilitiesObj[this.id];
+
     if (capabilityReference) {
       capabilityReference.value = value;
       capabilityReference.lastUpdated = this.__lastChanged;

package/lib/HomeyAPI/HomeyAPIV3/ManagerDevices.js

@@ -3,14 +3,14 @@
 const Manager = require('./Manager');
 const Capability = require('./ManagerDevices/Capability');
 const Device = require('./ManagerDevices/Device');
+const Util = require('../../Util');
 
 class ManagerDevices extends Manager {
-
   static CRUD = {
     ...super.CRUD,
     Capability,
     Device,
-  }
+  };
 
   scheduleRefresh() {
     if (this.__refreshTimeout) {
@@ -24,20 +24,48 @@ class ManagerDevices extends Manager {
     this.__refreshTimeout = setTimeout(() => {
       if (this.isConnected()) {
         this.__debug('Refreshing devices...');
-        this.__pendingRefreshDevicesCall = this.getDevices({ $cache: false }).then(devices => {
-          for (const device of Object.values(devices)) {
-            device.refreshCapabilityInstances();
-            this.emit('device.update', device);
-          }
-        }).catch(err => {
-          this.__debug('Failed to refresh devices.', err);
-        }).finally(() => {
-          this.__pendingRefreshDevicesCall = null;
-        });
+        this.__pendingRefreshDevicesCall = this.getDevices({ $cache: false, $updateCache: false })
+          .then(devices => {
+            const cache = this.__cache['device'];
+
+            for (const device of Object.values(devices)) {
+              const cachedDevice = cache[device.id];
+
+              if (cachedDevice != null) {
+                Object.entries(cachedDevice.__capabilityInstances).forEach(([capabilityId, capabilityInstances]) => {
+                  const value = device.capabilitiesObj
+                    ? device.capabilitiesObj[capabilityId] != null
+                      ? device.capabilitiesObj[capabilityId].value
+                      : null
+                    : null;
+
+                  const lastUpdated = device.capabilitiesObj
+                    ? device.capabilitiesObj[capabilityId] != null
+                      ? device.capabilitiesObj[capabilityId].lastUpdated
+                      : null
+                    : null;
+
+                  for (const capabilityInstance of capabilityInstances) {
+                    capabilityInstance.__onCapabilityValue({
+                      capabilityId,
+                      value,
+                      transactionId: Util.uuid(),
+                      transactionTime: lastUpdated,
+                    });
+                  }
+                });
+              }
+            }
+          })
+          .catch(err => {
+            this.__debug('Failed to refresh devices.', err);
+          })
+          .finally(() => {
+            this.__pendingRefreshDevicesCall = null;
+          });
       }
     }, 1000);
   }
-
 }
 
 module.exports = ManagerDevices;

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -16,6 +16,9 @@ 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
@@ -111,7 +114,9 @@ class HomeyAPIV3 extends HomeyAPI {
   get baseUrl() {
     return (async () => {
       if (!this.__baseUrlPromise) {
-        this.__baseUrlPromise = this.discoverBaseUrl().then(({ baseUrl }) => baseUrl);
+        this.__baseUrlPromise = this.discoverBaseUrl().then(({ baseUrl }) => {
+          return baseUrl;
+        });
         this.__baseUrlPromise.catch(() => { });
       }
 
@@ -119,6 +124,14 @@ class HomeyAPIV3 extends HomeyAPI {
     })();
   }
 
+  get tier() {
+    return tierCache[this.id];
+  }
+
+  get version() {
+    return versionCache[this.id];
+  }
+
   get strategyId() {
     return this.__strategyId;
   }
@@ -425,9 +438,13 @@ class HomeyAPIV3 extends HomeyAPI {
     const resStatusText = res.status;
     const resHeadersContentType = res.headers.get('Content-Type');
     const version = res.headers.get('x-homey-version');
-    if (version) this.version = version;
+    if (version) {
+      versionCache[this.id] = version;
+    }
     const tier = res.headers.get('x-homey-tier');
-    if (tier) this.tier = tier;
+    if (tier) {
+      tierCache[this.id] = tier;
+    }
 
     const resBodyText = await res.text();
     let resBodyJson;

package/package.json

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