homey-api 3.14.17 → 3.14.19

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

@@ -2289,7 +2289,11 @@ export class APIError extends Error {
 
   message: string;
 
+  message: string;
+
   statusCode: number;
+
+  message: string;
 }
 
 export class APIErrorHomeyOffline extends APIError {
@@ -2298,6 +2302,14 @@ export class APIErrorHomeyOffline extends APIError {
   statusCode: number;
 }
 
+export class APIErrorHomeySubscriptionInactive extends APIError {
+  statusCode: number;
+
+  statusCode: number;
+
+  message: string;
+}
+
 export class APIErrorNotFound extends APIError {
   message: string;
 
@@ -2537,7 +2549,11 @@ export class APIError extends Error {
 
   message: string;
 
+  message: string;
+
   statusCode: number;
+
+  message: string;
 }
 
 export class APIErrorHomeyOffline extends APIError {
@@ -2546,6 +2562,14 @@ export class APIErrorHomeyOffline extends APIError {
   statusCode: number;
 }
 
+export class APIErrorHomeySubscriptionInactive extends APIError {
+  statusCode: number;
+
+  statusCode: number;
+
+  message: string;
+}
+
 export class APIErrorNotFound extends APIError {
   message: string;
 

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

@@ -2354,7 +2354,11 @@ export class APIError extends Error {
 
   message: string;
 
+  message: string;
+
   statusCode: number;
+
+  message: string;
 }
 
 export class APIErrorHomeyOffline extends APIError {
@@ -2363,6 +2367,14 @@ export class APIErrorHomeyOffline extends APIError {
   statusCode: number;
 }
 
+export class APIErrorHomeySubscriptionInactive extends APIError {
+  statusCode: number;
+
+  statusCode: number;
+
+  message: string;
+}
+
 export class APIErrorNotFound extends APIError {
   message: string;
 
@@ -5950,8 +5962,6 @@ export class Util {
 
   static env(): string;
 
-  static promiseAny(promises: Array<Promise>): Promise<any>;
-
   static serializeQueryObject(queryObject: object): string;
 
   static encodeUrlSearchParams(params: object): string;
@@ -5994,8 +6004,6 @@ export class Util {
 
   static env(): string;
 
-  static promiseAny(promises: Array<Promise>): Promise<any>;
-
   static serializeQueryObject(queryObject: object): string;
 
   static encodeUrlSearchParams(params: object): string;
@@ -6016,7 +6024,11 @@ export class APIError extends Error {
 
   message: string;
 
+  message: string;
+
   statusCode: number;
+
+  message: string;
 }
 
 export class APIErrorHomeyOffline extends APIError {
@@ -6025,6 +6037,14 @@ export class APIErrorHomeyOffline extends APIError {
   statusCode: number;
 }
 
+export class APIErrorHomeySubscriptionInactive extends APIError {
+  statusCode: number;
+
+  statusCode: number;
+
+  message: string;
+}
+
 export class APIErrorNotFound extends APIError {
   message: string;
 
@@ -9548,8 +9568,6 @@ export class Util {
 
   static env(): string;
 
-  static promiseAny(promises: Array<Promise>): Promise<any>;
-
   static serializeQueryObject(queryObject: object): string;
 
   static encodeUrlSearchParams(params: object): string;
@@ -9592,8 +9610,6 @@ export class Util {
 
   static env(): string;
 
-  static promiseAny(promises: Array<Promise>): Promise<any>;
-
   static serializeQueryObject(queryObject: object): string;
 
   static encodeUrlSearchParams(params: object): string;

package/lib/APIErrorHomeyOffline.js

@@ -9,7 +9,6 @@ const APIError = require('./APIError');
  * @extends APIError
  */
 class APIErrorHomeyOffline extends APIError {
-
   constructor(err) {
     if (err instanceof Error) {
       super(`Homey Offline (${err.message || err.toString()})`, 500);
@@ -17,7 +16,6 @@ class APIErrorHomeyOffline extends APIError {
       super('Homey Offline', 500);
     }
   }
-
 }
 
 module.exports = APIErrorHomeyOffline;

package/lib/APIErrorHomeySubscriptionInactive.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const APIError = require('./APIError');
+
+/**
+ * Thrown when Homey subscription is inactive.
+ * @class
+ * @hideconstructor
+ * @extends APIError
+ */
+class APIErrorHomeySubscriptionInactive extends APIError {
+  /**
+   *
+   * @param {string} message
+   * @param {number} statusCode
+   */
+  constructor(message, statusCode) {
+    super(message);
+
+    /**
+     * Error message
+     * @var {string} APIError#message
+     */
+
+    /**
+     * HTTP Status Code
+     * @type {number}
+     */
+    this.statusCode = statusCode;
+  }
+}
+
+module.exports = APIErrorHomeySubscriptionInactive;

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -2,6 +2,7 @@
 
 const SocketIOClient = require('socket.io-client');
 const APIErrorHomeyOffline = require('../APIErrorHomeyOffline');
+const APIErrorHomeySubscriptionInactive = require('../APIErrorHomeySubscriptionInactive');
 const Util = require('../Util');
 const HomeyAPI = require('./HomeyAPI');
 const HomeyAPIError = require('./HomeyAPIError');
@@ -226,6 +227,9 @@ 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];
@@ -272,6 +276,26 @@ class HomeyAPIV3 extends HomeyAPI {
       const text = await response.text();
 
       if (!response.ok) {
+        const responseContentType = response.headers.get('Content-Type');
+        let parsed;
+
+        if (responseContentType && responseContentType.toLowerCase().includes('application/json')) {
+          try {
+            parsed = JSON.parse(text);
+            // eslint-disable-next-line no-empty
+          } catch (err) {}
+        }
+
+        if (typeof parsed === 'object' && parsed !== null) {
+          if (
+            parsed.error &&
+            parsed.error === 'Subscription Inactive' &&
+            parsed.statusCode === 403
+          ) {
+            throw new APIErrorHomeySubscriptionInactive(parsed.error, parsed.statusCode);
+          }
+        }
+
         throw new Error(text || response.statusText);
       }
 
@@ -358,7 +382,7 @@ class HomeyAPIV3 extends HomeyAPI {
     if (pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL_SECURE]
         .then((result) => resolve(result))
-        .catch(() => {
+        .catch((error) => {
           const promises = [];
 
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]) {
@@ -377,14 +401,34 @@ class HomeyAPIV3 extends HomeyAPI {
             promises.push(pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]);
           }
 
+          if (error instanceof APIErrorHomeySubscriptionInactive) {
+            throw error;
+          }
+
           if (!promises.length) {
             throw new APIErrorHomeyOffline();
           }
 
-          return Util.promiseAny(promises);
+          return Promise.any(promises);
         })
         .then((result) => resolve(result))
-        .catch(() => reject(new APIErrorHomeyOffline()));
+        .catch((error) => {
+          if (error instanceof AggregateError) {
+            for (const err of error.errors) {
+              if (err instanceof APIErrorHomeySubscriptionInactive) {
+                reject(err);
+                return;
+              }
+            }
+          }
+
+          if (error instanceof APIErrorHomeySubscriptionInactive) {
+            reject(error);
+            return;
+          }
+
+          reject(new APIErrorHomeyOffline());
+        });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]
         .then((result) => resolve(result))
@@ -392,7 +436,14 @@ class HomeyAPIV3 extends HomeyAPI {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
-              .catch((err) => reject(new APIErrorHomeyOffline(err)));
+              .catch((err) => {
+                if (err instanceof APIErrorHomeySubscriptionInactive) {
+                  reject(err);
+                  return;
+                }
+
+                reject(new APIErrorHomeyOffline(err));
+              });
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS]) {
@@ -402,7 +453,14 @@ class HomeyAPIV3 extends HomeyAPI {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
-              .catch((err) => reject(new APIErrorHomeyOffline(err)));
+              .catch((err) => {
+                if (err instanceof APIErrorHomeySubscriptionInactive) {
+                  reject(err);
+                  return;
+                }
+
+                reject(new APIErrorHomeyOffline(err));
+              });
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED]) {
@@ -412,13 +470,27 @@ class HomeyAPIV3 extends HomeyAPI {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
-              .catch((err) => reject(new APIErrorHomeyOffline(err)));
+              .catch((err) => {
+                if (err instanceof APIErrorHomeySubscriptionInactive) {
+                  reject(err);
+                  return;
+                }
+
+                reject(new APIErrorHomeyOffline(err));
+              });
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
         .then((result) => resolve(result))
-        .catch((err) => reject(new APIErrorHomeyOffline(err)));
+        .catch((err) => {
+          if (err instanceof APIErrorHomeySubscriptionInactive) {
+            reject(err);
+            return;
+          }
+
+          reject(new APIErrorHomeyOffline(err));
+        });
     } else {
       reject(new APIErrorHomeyOffline());
     }

package/lib/Util.js

@@ -9,7 +9,6 @@ const APIErrorTimeout = require('./APIErrorTimeout');
  * @hideconstructor
  */
 class Util {
-
   /**
    * Makes a call using `window.fetch` or `node-fetch`.
    * @param  {string} args
@@ -24,7 +23,7 @@ class Util {
 
     if (timeoutDuration != null) {
       const abortController = new AbortController();
-  
+
       abortTimeout = setTimeout(() => {
         abortController.abort('Timeout');
       }, timeoutDuration);
@@ -38,7 +37,7 @@ class Util {
       responsePromise = fetch(url, options);
     } else if (this.isBrowser()) {
       responsePromise = window.fetch(url, options);
-    } else if  (this.isNodeJS()) {
+    } else if (this.isNodeJS()) {
       const fetch = require('node-fetch');
       responsePromise = fetch(url, options);
     } else if (typeof fetch !== 'undefined') {
@@ -74,7 +73,7 @@ class Util {
    * @returns {Promise<void>}
    */
   static async wait(ms) {
-    return new Promise(resolve => {
+    return new Promise((resolve) => {
       setTimeout(resolve, ms);
     });
   }
@@ -86,10 +85,14 @@ class Util {
    * @param {string} [message="Timeout after 5000ms"]
    * @returns {Promise}
    */
-  static async timeout(promise, timeoutMillis = 5000, message = `Timeout after ${timeoutMillis}ms`) {
+  static async timeout(
+    promise,
+    timeoutMillis = 5000,
+    message = `Timeout after ${timeoutMillis}ms`
+  ) {
     const timeoutError = new APIErrorTimeout(message);
     let timeoutRef;
-    
+
     const returnPromise = Promise.race([
       promise,
       new Promise((_, reject) => {
@@ -98,10 +101,10 @@ class Util {
         }, timeoutMillis);
       }),
     ]);
-    
+
     returnPromise
       // eslint-disable-next-line no-unused-vars
-      .catch(err => { })
+      .catch((err) => {})
       .finally(() => {
         clearTimeout(timeoutRef);
       });
@@ -136,7 +139,7 @@ class Util {
    * @returns {boolean}
    */
   static isReactNative() {
-    return (typeof navigator !== 'undefined' && navigator.product === 'ReactNative');
+    return typeof navigator !== 'undefined' && navigator.product === 'ReactNative';
   }
 
   /**
@@ -144,7 +147,7 @@ class Util {
    */
   static isBrowser() {
     if (this.isReactNative()) return false;
-    return (typeof document !== 'undefined' && typeof window.document !== 'undefined');
+    return typeof document !== 'undefined' && typeof window.document !== 'undefined';
   }
 
   /**
@@ -152,7 +155,7 @@ class Util {
    */
   static isNodeJS() {
     if (this.isReactNative()) return false;
-    return (typeof process !== 'undefined');
+    return typeof process !== 'undefined';
   }
 
   /**
@@ -225,9 +228,9 @@ class Util {
    * @returns {string} - UUID v4 string
    */
   static uuid() {
-    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, c => {
-      const r = Math.random() * 16 | 0; const
-        v = c === 'x' ? r : ((r & 0x3) | 0x8);
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
+      const r = (Math.random() * 16) | 0;
+      const v = c === 'x' ? r : (r & 0x3) | 0x8;
       return v.toString(16);
     });
   }
@@ -262,35 +265,6 @@ class Util {
       .toUpperCase();
   }
 
-  /**
-   * Polyfill for Promise.any, which is only supported on Node.js >=15
-   * @param {Array<Promise>} promises
-   */
-  static async promiseAny(promises) {
-    if (promises.length === 0) return;
-    const rejections = [];
-    let rejectionCount = 0;
-
-    return new Promise((resolve, reject) => {
-      promises.forEach((promise, i) => {
-        promise
-          .then(result => resolve(result))
-          .catch(err => {
-            rejectionCount = rejectionCount + 1;
-            rejections[i] = err;
-
-            // Check if all promises have been rejected
-            if (rejectionCount === promises.length) {
-              const error = new Error('All Promises rejected');
-              error.error = rejections;
-              error.name = 'AggregateError';
-              reject(rejections);
-            }
-          });
-      });
-    });
-  }
-
   /**
    * Converts an object to a query string
    * @param {object} queryObject - Query parameter object
@@ -303,13 +277,8 @@ class Util {
 
     function add(key, value) {
       // If value is a function, invoke it and return its value.
-      value = (typeof value === 'function') ?
-        value() :
-        value === null ?
-          '' :
-          value;
-      querystring[querystring.length] = encodeURIComponent(key) +
-        '=' + encodeURIComponent(value);
+      value = typeof value === 'function' ? value() : value === null ? '' : value;
+      querystring[querystring.length] = encodeURIComponent(key) + '=' + encodeURIComponent(value);
     }
 
     function buildParams(prefix, obj, add) {
@@ -322,10 +291,11 @@ class Util {
             add(prefix, obj[index]);
           } else {
             // Item is non-scalar (array or object), encode its numeric index.
-            buildParams(prefix + '[' + (typeof (obj[index]) === 'object' ?
-              index :
-              ''
-            ) + ']', obj[index], add);
+            buildParams(
+              prefix + '[' + (typeof obj[index] === 'object' ? index : '') + ']',
+              obj[index],
+              add
+            );
           }
         }
       } else if (typeof obj === 'object') {
@@ -352,7 +322,7 @@ class Util {
   /**
    * We use this instead of URLSearchParams because in react-native URLSearchParams are not encoded
    * for some reason.
-   * 
+   *
    * @param {object} params
    * @returns {string} encoded params
    */
@@ -362,12 +332,11 @@ class Util {
     for (const [key, value] of Object.entries(params)) {
       const encodedKey = encodeURIComponent(key);
       const encodedValue = encodeURIComponent(value);
-      encodedPairs.push(encodedKey + "=" + encodedValue);
+      encodedPairs.push(encodedKey + '=' + encodedValue);
     }
 
-    return encodedPairs.join("&");
+    return encodedPairs.join('&');
   }
-
 }
 
 module.exports = Util;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.14.17",
+  "version": "3.14.19",
   "description": "Homey API",
   "main": "index.js",
   "files": [
@@ -51,7 +51,7 @@
     "form-data": "^4.0.0",
     "node-fetch": "^2.6.7",
     "socket.io-client": "^2.5.0",
-    "engine.io-client": "github:athombv/engine.io-client#backport/infinite-loop-fix-node-native-websocket"
+    "engine.io-client": "https://github.com/athombv/engine.io-client/tarball/backport/infinite-loop-fix-node-native-websocket"
   },
   "devDependencies": {
     "@athombv/jsdoc-template": "^1.6.2",