homey-api 3.17.12 → 3.18.1

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

@@ -4761,6 +4761,40 @@ export class AthomConnectAPI {
   }): Promise<any>;
 }
 
+export class AthomDeviceFirmwareAPI {
+  constructor(opts?: {
+    baseUrl?: string;
+
+    debug?: boolean;
+
+    secret?: string;
+  });
+
+  getFirmwareURL(opts: {
+    integrity: string;
+
+    noCache?: boolean;
+
+    sourceUrl?: string;
+
+    homeyTag?: string;
+
+    $timeout?: number;
+  }): Promise<{ url: string; cache: string }>;
+
+  getFirmwareURL(opts: {
+    integrity: string;
+
+    noCache?: boolean;
+
+    sourceUrl?: string;
+
+    homeyTag?: string;
+
+    $timeout?: number;
+  }): Promise<{ url: string; cache: string }>;
+}
+
 export class AthomDNSAPI {
   constructor(opts?: {
     baseUrl?: string;
@@ -8261,6 +8295,40 @@ export class AthomDNSAPI {
   getHomeyCertificate(opts: { secret: string }): Promise<any>;
 }
 
+export class AthomDeviceFirmwareAPI {
+  constructor(opts?: {
+    baseUrl?: string;
+
+    debug?: boolean;
+
+    secret?: string;
+  });
+
+  getFirmwareURL(opts: {
+    integrity: string;
+
+    noCache?: boolean;
+
+    sourceUrl?: string;
+
+    homeyTag?: string;
+
+    $timeout?: number;
+  }): Promise<{ url: string; cache: string }>;
+
+  getFirmwareURL(opts: {
+    integrity: string;
+
+    noCache?: boolean;
+
+    sourceUrl?: string;
+
+    homeyTag?: string;
+
+    $timeout?: number;
+  }): Promise<{ url: string; cache: string }>;
+}
+
 export class AthomEnergyAPI {
   constructor(opts?: {
     baseUrl?: string;

package/index.js

@@ -20,6 +20,7 @@ module.exports.AthomStoreAPI = require('./lib/AthomStoreAPI');
 module.exports.AthomWeatherAPI = require('./lib/AthomWeatherAPI');
 module.exports.AthomWebhooksAPI = require('./lib/AthomWebhooksAPI');
 module.exports.AthomEnergyAPI = require('./lib/AthomEnergyAPI');
+module.exports.AthomDeviceFirmwareAPI = require('./lib/AthomDeviceFirmwareAPI');
 
 // Homey Cloud
 module.exports.HomeyCloudAPI = require('./lib/HomeyCloudAPI');

package/lib/AthomDeviceFirmwareAPI.js

@@ -0,0 +1,55 @@
+'use strict';
+
+const API = require('./API');
+
+class AthomDeviceFirmwareAPI extends API {
+
+  static SPECIFICATION = {
+    host: 'device-firmware.athom.com',
+    basePath: '/',
+    operations: {},
+  };
+
+  static JSDOC_PRIVATE = true;
+
+  /**
+   * Get the location of a firmware update file.
+   *
+   * @param {Object} opts
+   * @param {string} opts.integrity - The integrity hash (i.e unique key) of the firmware file, e.g. "sha256:abcdef1234567890..."
+   * @param {boolean} [opts.noCache] - Whether to bypass the cache and fetch the firmware fresh from sourceUrl. Default: false.
+   * @param {string} [opts.sourceUrl] - The original URL of the firmware file, if the cache is bypassed or missed the server can attempt to fetch the file from this URL.
+   * @param {string} [opts.homeyTag] - How to tag the file in the cache (requires sourceUrl to be set, and the cache to be bypassed or missed).
+   * @param {number} [opts.$timeout] - Optional timeout in milliseconds for this API call.
+   * @returns {Promise<{ url: string, cache: string }>}
+   */
+  async getFirmwareURL({ integrity, noCache, sourceUrl, homeyTag, $timeout }) {
+    const query = {};
+
+    if (typeof this.__secret === 'string') {
+      query.secret = this.__secret;
+    }
+
+    if (noCache !== undefined) {
+      query.noCache = noCache;
+    }
+
+    if (sourceUrl !== undefined) {
+      query.sourceUrl = sourceUrl;
+    }
+
+    if (homeyTag !== undefined) {
+      query.homeyTag = homeyTag;
+    }
+
+    return this.call({
+      method: 'get',
+      path: `/firmware/${integrity}`,
+      query,
+      timeout: $timeout,
+    });
+  }
+
+}
+
+module.exports = AthomDeviceFirmwareAPI;

package/lib/HomeyAPI/HomeyAPIV3/Item.js

@@ -62,35 +62,39 @@ class Item extends EventEmitter {
       writable: true,
     });
 
-    this.__realtimeConsumer = new RealtimeConsumer({
-      subscribe: (uri, handlers) => this.homey.subscribe(uri, handlers),
-      getUri: () => this.uri,
-      debug: (...props) => this.__debug(...props),
-      setConnected: (connected) => {
-        this.__connected = connected;
-      },
-      onConnect: () => {
-        this.onConnect();
-      },
-      onDisconnect: () => {
-        this.onDisconnect();
-      },
-      onReconnect: () => {
-        this.onReconnect();
-      },
-      onEvent: (event, data) => {
-        if (event === 'update') {
-          this.__update(this.constructor.transformGet({ ...data }));
-          return;
-        }
-
-        if (event === 'delete') {
-          this.__delete();
-          return;
-        }
-
-        this.emit(event, data);
-      },
+    Object.defineProperty(this, '__realtimeConsumer', {
+      value: new RealtimeConsumer({
+        subscribe: (uri, handlers) => this.homey.subscribe(uri, handlers),
+        getUri: () => this.uri,
+        debug: (...props) => this.__debug(...props),
+        setConnected: (connected) => {
+          this.__connected = connected;
+        },
+        onConnect: () => {
+          this.onConnect();
+        },
+        onDisconnect: () => {
+          this.onDisconnect();
+        },
+        onReconnect: () => {
+          this.onReconnect();
+        },
+        onEvent: (event, data) => {
+          if (event === 'update') {
+            this.__update(this.constructor.transformGet({ ...data }));
+            return;
+          }
+
+          if (event === 'delete') {
+            this.__delete();
+            return;
+          }
+
+          this.emit(event, data);
+        },
+      }),
+      enumerable: false,
+      writable: false,
     });
 
     // Set Properties

package/lib/HomeyAPI/HomeyAPIV3/Manager.js

@@ -87,69 +87,73 @@ class Manager extends EventEmitter {
       writable: false,
     });
 
-    this.__realtimeConsumer = new RealtimeConsumer({
-      subscribe: (uri, handlers) => this.homey.subscribe(uri, handlers),
-      getUri: () => this.uri,
-      debug: (...props) => this.__debug(...props),
-      setConnected: (connected) => {
-        this.__connected = connected;
-      },
-      onEvent: (event, data) => {
-        // Transform & add to cache if this is a CRUD event
-        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];
-
-          switch (operation) {
-            case 'create': {
-              const props = ItemClass.transformGet(data);
-
-              const item = new ItemClass({
-                id: props.id,
-                homey: this.homey,
-                manager: this,
-                properties: props,
-              });
-              this.__cache[ItemClass.ID][props.id] = item;
-
-              this.emit(event, item);
-              return;
-            }
-            case 'update': {
-              const props = ItemClass.transformGet(data);
+    Object.defineProperty(this, '__realtimeConsumer', {
+      value: new RealtimeConsumer({
+        subscribe: (uri, handlers) => this.homey.subscribe(uri, handlers),
+        getUri: () => this.uri,
+        debug: (...props) => this.__debug(...props),
+        setConnected: (connected) => {
+          this.__connected = connected;
+        },
+        onEvent: (event, data) => {
+          // Transform & add to cache if this is a CRUD event
+          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];
+
+            switch (operation) {
+              case 'create': {
+                const props = ItemClass.transformGet(data);
+
+                const item = new ItemClass({
+                  id: props.id,
+                  homey: this.homey,
+                  manager: this,
+                  properties: props,
+                });
+                this.__cache[ItemClass.ID][props.id] = item;
 
-              if (this.__cache[ItemClass.ID][props.id]) {
-                const item = this.__cache[ItemClass.ID][props.id];
-                item.__update(props);
                 this.emit(event, item);
                 return;
               }
+              case 'update': {
+                const props = ItemClass.transformGet(data);
+
+                if (this.__cache[ItemClass.ID][props.id]) {
+                  const item = this.__cache[ItemClass.ID][props.id];
+                  item.__update(props);
+                  this.emit(event, item);
+                  return;
+                }
 
-              break;
-            }
-            case 'delete': {
-              const props = ItemClass.transformGet(data);
-
-              if (this.__cache[ItemClass.ID][props.id]) {
-                const item = this.__cache[ItemClass.ID][props.id];
-                item.__delete();
-                delete this.__cache[ItemClass.ID][item.id];
-                this.emit(event, {
-                  id: item.id,
-                });
-                return;
+                break;
               }
+              case 'delete': {
+                const props = ItemClass.transformGet(data);
+
+                if (this.__cache[ItemClass.ID][props.id]) {
+                  const item = this.__cache[ItemClass.ID][props.id];
+                  item.__delete();
+                  delete this.__cache[ItemClass.ID][item.id];
+                  this.emit(event, {
+                    id: item.id,
+                  });
+                  return;
+                }
 
-              break;
+                break;
+              }
+              default:
+                break;
             }
-            default:
-              break;
           }
-        }
 
-        this.emit(event, data);
-      },
+          this.emit(event, data);
+        },
+      }),
+      enumerable: false,
+      writable: false,
     });
 
     // Create methods

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.17.12",
+  "version": "3.18.1",
   "description": "Homey API",
   "main": "index.js",
   "license": "SEE LICENSE",