homey-api 3.0.7 → 3.0.8

package/lib/HomeyAPI/HomeyAPI.js

@@ -11,10 +11,11 @@ class HomeyAPI {
 
   /**
    * Platforms
-   * @static
+   * @memberof HomeyAPI
    * @property {object} PLATFORMS
    * @property {string} PLATFORMS.LOCAL - Homey (2016 — 2019) & Homey Pro (2019 — 2023)
    * @property {string} PLATFORMS.CLOUD - Homey Cloud
+   * @static
    */
   static PLATFORMS = {
     LOCAL: 'local',
@@ -23,13 +24,14 @@ class HomeyAPI {
 
   /**
    * Discovery Strategies
-   * @static
+   * @memberof HomeyAPI
    * @property {object} DISCOVERY_STRATEGIES
    * @property {string} DISCOVERY_STRATEGIES.CLOUD - Cloud HTTPS, e.g. `https://abcdef.connect.athom.com`.
    * @property {string} DISCOVERY_STRATEGIES.MDNS - Local HTTP, e.g. `http://homey-abcdef.local`
    * @property {string} DISCOVERY_STRATEGIES.LOCAL - Local HTTP, e.g. `http://192.168.1.100`.
    * @property {string} DISCOVERY_STRATEGIES.LOCAL_SECURE - Local HTTPS, e.g. `https://192-168-1-100.homey.homeylocal.com`.
    * @property {string} DISCOVERY_STRATEGIES.REMOTE_FORWARDED - Remote HTTPS, e.g. `https://12-34-56-78.homey.homeylocal.com:12345`.
+   * @static
    */
   static DISCOVERY_STRATEGIES = {
     MDNS: 'mdns',
@@ -177,7 +179,7 @@ class HomeyAPI {
    * Creates a {@link HomeyAPIV3Local} or {@link HomeyAPIV2} instance for use in the Apps SDK.
    * @param {Object} opts
    * @param {Homey} opts.homey — Homey (Apps SDK) instance.
-   * @param {Function|null} opts.debug — Debug function, defaults to `null`.
+   * @param {Function|null} [opts.debug=null] — Debug function, defaults to `null`.
    * @example
    * const { HomeyAPI } = require('homey-api');
    *

package/lib/HomeyAPI/HomeyAPIErrorNotFound.js

@@ -7,7 +7,7 @@ const HomeyAPIError = require('./HomeyAPIError');
 /**
  * @class
  * @hideconstructor
- * @extends APIError
+ * @extends HomeyAPIError
  * @memberof HomeyAPI
  */
 class HomeyAPIErrorNotFound extends HomeyAPIError {

package/lib/HomeyAPI/HomeyAPIV2.js

@@ -13,7 +13,7 @@ const ManagerInsights = require('./HomeyAPIV2/ManagerInsights');
  *
  * @class
  * @hideconstructor
- * @extends HomeyAPI
+ * @extends HomeyAPIV3
  */
 class HomeyAPIV2 extends HomeyAPIV3 {
 

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -19,7 +19,7 @@ const Manager = require('./HomeyAPIV3/Manager');
  * An authenticated Homey API. Do not construct this class manually.
  * @class
  * @hideconstructor
- * @extends HomeyAPIV2
+ * @extends HomeyAPI
  */
 class HomeyAPIV3 extends HomeyAPI {
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.0.7",
+  "version": "3.0.8",
   "description": "Homey API",
   "main": "index.js",
   "files": [
@@ -24,12 +24,14 @@
     "webpack": "webpack",
     "webpack:watch": "webpack --watch",
     "jsdoc": "npm run jsdoc:clean; cp -r ./lib/ ./build/jsdoc-tmp; npm run generate-specs; npm run generate-jsdoc; jsdoc --configure ./jsdoc.json --recurse; jsdoc --configure ./jsdoc.json --recurse --private --destination ./jsdoc/private; rm ./jsdoc/*.js.html;",
+    "jsdoc:only": "jsdoc --configure ./jsdoc.json --recurse; jsdoc --configure ./jsdoc.json --recurse --private --destination ./jsdoc/private; rm ./jsdoc/*.js.html;",
     "jsdoc:clean": "rm -rf ./build/jsdoc/; rm -rf ./build/jsdoc-tmp/",
     "jsdoc:watch": "watch \"npm run jsdoc:clean; npm run generate-jsdoc; npm run jsdoc;\" lib \"node_modules/@athombv/jsdoc-template\" --interval 0.5",
     "jsdoc:serve": "http-server ./jsdoc/",
     "generate-specs": "node tools/generate-specs.js",
     "generate-jsdoc": "node tools/generate-jsdoc.js",
-    "generate-types": "node tools/generate-types.js",
+    "generate-types": "node tools/generate-types.js && prettier --write assets/types",
+    "validate-types": "npx tsc --noEmit ./assets/types/homey-api.d.ts",
     "example-browser": "http-server ./examples/browser/ --port 80"
   },
   "repository": {
@@ -52,7 +54,7 @@
     "socket.io-client": "^2.5.0"
   },
   "devDependencies": {
-    "@athombv/jsdoc-template": "^1.6.1",
+    "@athombv/jsdoc-template": "^1.6.2",
     "@babel/core": "^7.16.0",
     "@babel/plugin-proposal-class-properties": "^7.16.0",
     "@babel/preset-env": "^7.16.0",
@@ -66,9 +68,9 @@
     "fs-extra": "^10.0.0",
     "homey-api": "^3.0.6",
     "http-server": "^0.12.3",
-    "jsdoc": "^3.6.7",
-    "jsdoc-to-markdown": "^7.1.0",
-    "jsdoc-ts-utils": "^2.0.1",
+    "jsdoc": "^4.0.2",
+    "jsdoc-to-markdown": "^8.0.0",
+    "jsdoc-ts-utils": "^4.0.0",
     "jsdoc-tsimport-plugin": "^1.0.5",
     "keypather": "^3.1.0",
     "prettier": "^3.0.0",