homey-api 3.0.4 → 3.0.6

package/lib/API.js

@@ -1,8 +1,3 @@
-/* eslint-disable new-cap */
-/* eslint-disable max-classes-per-file */
-/* eslint-disable global-require */
-/* eslint-disable import/no-dynamic-require */
-
 'use strict';
 
 // const path = require('path');
@@ -274,6 +269,7 @@ class API {
     });
   }
 
+  // eslint-disable-next-line no-unused-vars
   async onCallRequestHeaders({ request }) {
     return {};
   }
@@ -294,15 +290,19 @@ class API {
   }
 
   async onCallResponseOK({
+    // eslint-disable-next-line no-unused-vars
     context,
     body,
+    // eslint-disable-next-line no-unused-vars
     statusCode,
+    // eslint-disable-next-line no-unused-vars
     statusText,
   }) {
     return body;
   }
 
   async onCallResponseNotOK({
+    // eslint-disable-next-line no-unused-vars
     context,
     body,
     statusCode,

package/lib/APIDefinition.js

@@ -9,7 +9,7 @@ class APIDefinition {
   /**
    *
    * @param {object} opts
-   * @param {API} opts.api
+   * @param {import('./API.js')} opts.api
    * @param {object} opts.properties
    */
   constructor({

package/lib/AthomCloudAPI/Homey.js

@@ -25,8 +25,8 @@ class Homey extends APIDefinition {
   /**
    * This method returns a {@link HomeyAPI} instance matching the Homey's API level and platform.
    * Additionally, it ensures a session on the Homey during initialization.
-   * @param {object} opts
-   * @param {string|array} opts.strategy - One string, or an array of {@link HomeyAPI#DISCOVERY_STRATEGIES} strings, to connect to the Homey.
+   * @param {object} [opts]
+   * @param {string|array} [opts.strategy] - One string, or an array of {@link HomeyAPI#DISCOVERY_STRATEGIES} strings, to connect to the Homey.
    * @returns {Promise<HomeyAPI>}
    */
   async authenticate({ strategy } = {}) {

package/lib/AthomCloudAPI/StorageAdapter.js

@@ -19,6 +19,7 @@ class StorageAdapter {
    * @param {object} value
    * @returns {Promise<void>}
    */
+  // eslint-disable-next-line no-unused-vars
   async set(value) {
     throw new Error('Not Implemented: StorageAdapter.set()');
   }

package/lib/AthomCloudAPI.js

@@ -240,7 +240,8 @@ for(const {@link HomeyAPIV2.ManagerDevices.Device device} of Object.values(devic
   /*
    * API overloads
   */
-
+ 
+  // eslint-disable-next-line no-unused-vars
   async onCallRequestHeaders({ request }) {
     // Try to set the Token from the StorageAdapter
     if (!this.__token) {

package/lib/HomeyAPI/HomeyAPIV3/Item.js

@@ -9,23 +9,34 @@ const EventEmitter = require('../../EventEmitter');
  * @memberof HomeyAPIV3
  */
 class Item extends EventEmitter {
-
   static ID = null; // Set by Manager.js
 
-  constructor({
-    id,
-    homey,
-    manager,
-    properties,
-  }) {
+  /**
+   * The ID of the Item.
+   * @type {string}
+   */
+  id;
+  /**
+   * The URI of the Item, e.g. `homey:foo:bar`.
+   * @type {string}
+   */
+  uri;
+
+  constructor({ id, homey, manager, properties }) {
     super();
 
-    Object.defineProperty(this, '__id', {
+    Object.defineProperty(this, 'id', {
       value: id,
       enumerable: true,
       writable: false,
     });
 
+    Object.defineProperty(this, 'uri', {
+      value: `homey:${this.constructor.ID}:${this.id}`,
+      enumerable: true,
+      writable: false,
+    });
+
     // Set Homey
     Object.defineProperty(this, '__homey', {
       value: homey,
@@ -59,22 +70,6 @@ class Item extends EventEmitter {
     }
   }
 
-  /**
-   * The ID of the Item.
-   * @type {String}
-   */
-  get id() {
-    return this.__id;
-  }
-
-  /**
-   * The URI of the Item, e.g. `homey:foo:bar`.
-   * @type {String}
-   */
-  get uri() {
-    return `homey:${this.constructor.ID}:${this.id}`;
-  }
-
   /**
    * The Manager of the Item.
    * @type {HomeyAPIV3.Manager}
@@ -123,7 +118,8 @@ class Item extends EventEmitter {
       // promise before we try to connect again.
       await Promise.resolve();
       await this.__disconnectPromise;
-    } catch (err) { }
+      // eslint-disable-next-line no-empty
+    } catch (err) {}
 
     this.__connectPromise = Promise.resolve().then(async () => {
       if (!this.io) {
@@ -158,7 +154,7 @@ class Item extends EventEmitter {
 
     // Delete the connecting Promise
     this.__connectPromise
-      .catch(() => { })
+      .catch(() => {})
       .finally(() => {
         delete this.__connectPromise;
       });
@@ -175,21 +171,20 @@ class Item extends EventEmitter {
     // If connecting, await that first
     try {
       await this.__connectPromise;
-    } catch (err) { }
+      // eslint-disable-next-line no-empty
+    } catch (err) {}
 
     this.__disconnectPromise = Promise.resolve().then(async () => {
       this.__connected = false;
 
       if (this.io) {
-        this.io
-          .then(io => io.unsubscribe())
-          .catch(err => this.__debug('Error Disconnecting:', err));
+        this.io.then(io => io.unsubscribe()).catch(err => this.__debug('Error Disconnecting:', err));
       }
     });
 
     // Delete the disconnecting Promise
     this.__disconnectPromise
-      .catch(() => { })
+      .catch(() => {})
       .finally(() => {
         delete this.__disconnectPromise;
         // Delete this.io so connect can start new connections.
@@ -216,7 +211,7 @@ class Item extends EventEmitter {
     this.removeAllListeners();
 
     // Disconnect from Socket.io
-    this.disconnect().catch(() => { });
+    this.disconnect().catch(() => {});
   }
 
   static transformGet(item) {
@@ -226,7 +221,6 @@ class Item extends EventEmitter {
   static transformSet(item) {
     return item;
   }
-
 }
 
 module.exports = Item;

package/lib/HomeyAPI/HomeyAPIV3/Manager.js

@@ -396,7 +396,10 @@ class Manager extends EventEmitter {
     // If disconnecting, await that first
     try {
       await this.__disconnectPromise;
-    } catch (err) { }
+    // eslint-disable-next-line no-empty
+    } catch (err) { 
+
+    }
 
     this.__connectPromise = Promise.resolve().then(async () => {
       if (!this.io) {
@@ -498,7 +501,10 @@ class Manager extends EventEmitter {
     // If connecting, await that first
     try {
       await this.__connectPromise;
-    } catch (err) { }
+    // eslint-disable-next-line no-empty
+    } catch (err) { 
+
+    }
 
     this.__disconnectPromise = Promise.resolve().then(async () => {
       this.__connected = false;

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

@@ -162,10 +162,11 @@ class Device extends Item {
 
   /**
    * Get the device's logs.
-   * @returns {Promise<{String, HomeyAPIV3.ManagerInsights.Log}>}
+   * @returns {Promise.<Object.<string, HomeyAPIV3.ManagerInsights.Log>>}
    */
   async getLogs() {
     const logs = await this.homey.insights.getLogs();
+
     return Object.values(logs)
       .filter(log => log.ownerUri === this.uri)
       .reduce((result, log) => ({
@@ -176,7 +177,7 @@ class Device extends Item {
 
   /**
    * Get the device's flows.
-   * @returns {Promise<{String, HomeyAPIV3.ManagerFlow.Flow}>}
+   * @returns {Promise.<Object.<string, HomeyAPIV3.ManagerFlow.Flow>>}
    */
   async getFlows() {
     const flows = await this.homey.flow.getFlows();
@@ -198,8 +199,7 @@ class Device extends Item {
   }
 
   /**
-   * @returns {Promise<{String, HomeyAPIV3.ManagerFlow.AdvancedFlow}>}
-   * @returns {Promise<Object>}
+   * @returns {Promise.<Object.<string, HomeyAPIV3.ManagerFlow.AdvancedFlow>>}
    */
   async getAdvancedFlows() {
     const advancedFlows = await this.homey.flow.getAdvancedFlows();

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -421,7 +421,10 @@ class HomeyAPIV3 extends HomeyAPI {
     if (resHeadersContentType && resHeadersContentType.startsWith('application/json')) {
       try {
         resBodyJson = JSON.parse(resBodyText);
-      } catch (err) { }
+      // eslint-disable-next-line no-empty
+      } catch (err) { 
+
+      }
     }
 
     if (!res.ok) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.0.4",
+  "version": "3.0.6",
   "description": "Homey API",
   "main": "index.js",
   "files": [
@@ -42,7 +42,7 @@
   },
   "homepage": "https://github.com/athombv/node-homey-api#readme",
   "engines": {
-    "node": ">12"
+    "node": ">=16"
   },
   "dependencies": {
     "core-js": "^3.19.1",
@@ -56,6 +56,8 @@
     "@babel/core": "^7.16.0",
     "@babel/plugin-proposal-class-properties": "^7.16.0",
     "@babel/preset-env": "^7.16.0",
+    "@typescript-eslint/eslint-plugin": "^6.1.0",
+    "@typescript-eslint/parser": "^6.1.0",
     "babel-loader": "^8.2.3",
     "concurrently": "^5.1.0",
     "ejs": "^3.1.6",
@@ -66,8 +68,11 @@
     "jsdoc": "^3.6.7",
     "jsdoc-to-markdown": "^7.1.0",
     "jsdoc-ts-utils": "^2.0.1",
+    "jsdoc-tsimport-plugin": "^1.0.5",
     "keypather": "^3.1.0",
+    "prettier": "^3.0.0",
     "serve": "^14.0.1",
+    "typescript": "^5.1.6",
     "watch": "^1.0.2",
     "webpack": "^5.64.0",
     "webpack-cli": "^4.9.1",