homey-api 3.15.0 → 3.16.1

package/assets/specifications/AthomStoreAPI.json

@@ -2,319 +2,11 @@
   "host": "store-api.athom.com",
   "basePath": "/api",
   "operations": {
-    "getProducts": {
-      "path": "/store/product",
-      "method": "get",
-      "parameters": {}
-    },
-    "getProduct": {
-      "path": "/store/product/{productId}",
-      "method": "get",
-      "parameters": {
-        "productId": {
-          "in": "path",
-          "type": "string",
-          "required": true
-        }
-      }
-    },
-    "getCart": {
-      "path": "/store/cart",
-      "method": "get",
-      "parameters": {}
-    },
-    "addProductToCart": {
-      "path": "/store/cart",
-      "method": "post",
-      "parameters": {
-        "sku": {
-          "type": "string",
-          "in": "body"
-        },
-        "quantity": {
-          "type": "number",
-          "in": "body"
-        },
-        "options": {
-          "type": "object",
-          "in": "body"
-        }
-      }
-    },
-    "setCartProductQuantity": {
-      "path": "/store/cart",
-      "method": "put",
-      "parameters": {
-        "sku": {
-          "type": "string",
-          "in": "body"
-        },
-        "quantity": {
-          "type": "number",
-          "in": "body"
-        }
-      }
-    },
-    "removeProductFromCart": {
-      "path": "/store/cart",
-      "method": "delete",
-      "parameters": {
-        "sku": {
-          "type": "string",
-          "in": "body"
-        }
-      }
-    },
-    "getLocales": {
-      "path": "/store/locale",
-      "method": "get",
-      "parameters": {}
-    },
-    "setLocale": {
-      "path": "/store/locale",
-      "method": "put",
-      "parameters": {
-        "locale": {
-          "type": "string",
-          "in": "body"
-        }
-      }
-    },
-    "setUserdata": {
-      "path": "/store/userdata",
-      "method": "put",
-      "parameters": {
-        "shipping_address": {
-          "type": "boolean",
-          "in": "body"
-        },
-        "create_account": {
-          "type": "boolean",
-          "in": "body"
-        },
-        "newsletter": {
-          "type": "boolean",
-          "in": "body"
-        },
-        "is_business": {
-          "type": "boolean",
-          "in": "body"
-        },
-        "email": {
-          "type": "string",
-          "in": "body"
-        },
-        "password": {
-          "type": "string",
-          "in": "body"
-        },
-        "gender": {
-          "type": "string",
-          "in": "body"
-        },
-        "phone": {
-          "type": "string",
-          "in": "body"
-        },
-        "billing_firstname": {
-          "type": "string",
-          "in": "body"
-        },
-        "billing_lastname": {
-          "type": "string",
-          "in": "body"
-        },
-        "billing_street": {
-          "type": "string",
-          "in": "body"
-        },
-        "billing_number": {
-          "type": "string",
-          "in": "body"
-        },
-        "billing_zipcode": {
-          "type": "string",
-          "in": "body"
-        },
-        "billing_city": {
-          "type": "string",
-          "in": "body"
-        },
-        "billing_state": {
-          "type": "string",
-          "in": "body"
-        },
-        "billing_country": {
-          "type": "string",
-          "in": "body"
-        },
-        "billing_address_extra": {
-          "type": "string",
-          "in": "body"
-        },
-        "shipping_firstname": {
-          "type": "string",
-          "in": "body"
-        },
-        "shipping_lastname": {
-          "type": "string",
-          "in": "body"
-        },
-        "shipping_street": {
-          "type": "string",
-          "in": "body"
-        },
-        "shipping_number": {
-          "type": "string",
-          "in": "body"
-        },
-        "shipping_zipcode": {
-          "type": "string",
-          "in": "body"
-        },
-        "shipping_city": {
-          "type": "string",
-          "in": "body"
-        },
-        "shipping_state": {
-          "type": "string",
-          "in": "body"
-        },
-        "shipping_country": {
-          "type": "string",
-          "in": "body"
-        },
-        "shipping_address_extra": {
-          "type": "string",
-          "in": "body"
-        },
-        "business_name": {
-          "type": "string",
-          "in": "body"
-        },
-        "business_vat": {
-          "type": "string",
-          "in": "body"
-        },
-        "business_reference": {
-          "type": "string",
-          "in": "body"
-        }
-      }
-    },
-    "setBusiness": {
-      "path": "/store/business",
-      "method": "put",
-      "parameters": {
-        "business": {
-          "type": "boolean",
-          "in": "body"
-        }
-      }
-    },
-    "setCoupon": {
-      "path": "/store/coupon",
-      "method": "put",
-      "parameters": {
-        "coupon": {
-          "type": "string",
-          "in": "body"
-        }
-      }
-    },
-    "setPayment": {
-      "path": "/store/payment",
-      "method": "put",
-      "parameters": {
-        "payment": {
-          "type": "string",
-          "in": "body"
-        }
-      }
-    },
-    "createOrder": {
-      "path": "/store/order",
-      "method": "post",
-      "parameters": {}
-    },
-    "payOrder": {
-      "path": "/store/order/pay",
-      "method": "post",
-      "parameters": {
-        "orderId": {
-          "type": "string",
-          "in": "body"
-        }
-      }
-    },
-    "validateVat": {
-      "path": "/store/vat",
-      "method": "get",
-      "parameters": {
-        "vat": {
-          "in": "query",
-          "type": "string",
-          "required": true
-        }
-      }
-    },
-    "getAddressSuggestion": {
-      "path": "/util/zipcode",
-      "method": "get",
-      "parameters": {
-        "zipcode": {
-          "in": "query",
-          "type": "string",
-          "required": true
-        },
-        "number": {
-          "in": "query",
-          "type": "number",
-          "required": true
-        }
-      }
-    },
-    "createSession": {
-      "path": "/user/session",
-      "method": "post",
-      "parameters": {}
-    },
-    "deleteSession": {
-      "path": "/user/session",
-      "method": "delete",
-      "parameters": {}
-    },
     "getOrders": {
       "path": "/user/order",
       "method": "get",
       "parameters": {}
     },
-    "getOrder": {
-      "path": "/user/order/{orderId}",
-      "method": "get",
-      "parameters": {
-        "orderId": {
-          "in": "path",
-          "type": "string",
-          "required": true
-        }
-      }
-    },
-    "loginByDelegationToken": {
-      "path": "/user/login-token",
-      "method": "post",
-      "parameters": {
-        "token": {
-          "type": "string",
-          "in": "body"
-        }
-      }
-    },
-    "logout": {
-      "path": "/user/logout",
-      "method": "post",
-      "parameters": {}
-    },
     "verifySubscription": {
       "path": "/subscription/verify",
       "method": "post",

package/assets/specifications/HomeyAPIV2.json

@@ -396,6 +396,10 @@
             "homey.app"
           ],
           "parameters": {
+            "version": {
+              "in": "body",
+              "type": "string"
+            },
             "channel": {
               "in": "body",
               "type": "string"
@@ -4550,6 +4554,9 @@
               "settings": {
                 "type": "object"
               },
+              "devices": {
+                "type": "object"
+              },
               "height": {
                 "type": [
                   "number",
@@ -4558,6 +4565,9 @@
               },
               "transparent": {
                 "type": "boolean"
+              },
+              "deprecated": {
+                "type": "boolean"
               }
             },
             "x-realtime-bindings": {
@@ -6163,15 +6173,6 @@
             "homey.geolocation.readonly"
           ],
           "parameters": {}
-        },
-        "getWeatherHourly": {
-          "method": "get",
-          "path": "/forecast/hourly",
-          "private": false,
-          "scopes": [
-            "homey.geolocation.readonly"
-          ],
-          "parameters": {}
         }
       }
     },

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

@@ -148,9 +148,13 @@ export namespace HomeyAPIV2.ManagerDashboards {
 
     settings: object;
 
+    devices: object;
+
     height: number | string;
 
     transparent: boolean;
+
+    deprecated: boolean;
   }
 
   export class Dashboard extends HomeyAPIV3Local.ManagerDashboards.Dashboard {
@@ -5180,122 +5184,8 @@ export class AthomStoreAPI {
     secret?: string;
   });
 
-  getProducts(): Promise<any>;
-
-  getProduct(opts: { productId: string }): Promise<any>;
-
-  getCart(): Promise<any>;
-
-  addProductToCart(opts: {
-    sku?: string;
-
-    quantity?: number;
-
-    options?: object;
-  }): Promise<any>;
-
-  setCartProductQuantity(opts: {
-    sku?: string;
-
-    quantity?: number;
-  }): Promise<any>;
-
-  removeProductFromCart(opts: { sku?: string }): Promise<any>;
-
-  getLocales(): Promise<any>;
-
-  setLocale(opts: { locale?: string }): Promise<any>;
-
-  setUserdata(opts: {
-    shipping_address?: boolean;
-
-    create_account?: boolean;
-
-    newsletter?: boolean;
-
-    is_business?: boolean;
-
-    email?: string;
-
-    password?: string;
-
-    gender?: string;
-
-    phone?: string;
-
-    billing_firstname?: string;
-
-    billing_lastname?: string;
-
-    billing_street?: string;
-
-    billing_number?: string;
-
-    billing_zipcode?: string;
-
-    billing_city?: string;
-
-    billing_state?: string;
-
-    billing_country?: string;
-
-    billing_address_extra?: string;
-
-    shipping_firstname?: string;
-
-    shipping_lastname?: string;
-
-    shipping_street?: string;
-
-    shipping_number?: string;
-
-    shipping_zipcode?: string;
-
-    shipping_city?: string;
-
-    shipping_state?: string;
-
-    shipping_country?: string;
-
-    shipping_address_extra?: string;
-
-    business_name?: string;
-
-    business_vat?: string;
-
-    business_reference?: string;
-  }): Promise<any>;
-
-  setBusiness(opts: { business?: boolean }): Promise<any>;
-
-  setCoupon(opts: { coupon?: string }): Promise<any>;
-
-  setPayment(opts: { payment?: string }): Promise<any>;
-
-  createOrder(): Promise<any>;
-
-  payOrder(opts: { orderId?: string }): Promise<any>;
-
-  validateVat(opts: { vat: string }): Promise<any>;
-
-  getAddressSuggestion(opts: {
-    zipcode: string;
-
-    number: number;
-  }): Promise<any>;
-
-  createSession(): Promise<any>;
-
-  deleteSession(): Promise<any>;
-
   getOrders(): Promise<any>;
 
-  getOrder(opts: { orderId: string }): Promise<any>;
-
-  loginByDelegationToken(opts: { token?: string }): Promise<any>;
-
-  logout(): Promise<any>;
-
   verifySubscription(opts: {
     token?: string;
 
@@ -5408,122 +5298,8 @@ export class AthomStoreAPI {
 
   redeemCoupon(opts: { couponCode: string }): Promise<any>;
 
-  getProducts(): Promise<any>;
-
-  getProduct(opts: { productId: string }): Promise<any>;
-
-  getCart(): Promise<any>;
-
-  addProductToCart(opts: {
-    sku?: string;
-
-    quantity?: number;
-
-    options?: object;
-  }): Promise<any>;
-
-  setCartProductQuantity(opts: {
-    sku?: string;
-
-    quantity?: number;
-  }): Promise<any>;
-
-  removeProductFromCart(opts: { sku?: string }): Promise<any>;
-
-  getLocales(): Promise<any>;
-
-  setLocale(opts: { locale?: string }): Promise<any>;
-
-  setUserdata(opts: {
-    shipping_address?: boolean;
-
-    create_account?: boolean;
-
-    newsletter?: boolean;
-
-    is_business?: boolean;
-
-    email?: string;
-
-    password?: string;
-
-    gender?: string;
-
-    phone?: string;
-
-    billing_firstname?: string;
-
-    billing_lastname?: string;
-
-    billing_street?: string;
-
-    billing_number?: string;
-
-    billing_zipcode?: string;
-
-    billing_city?: string;
-
-    billing_state?: string;
-
-    billing_country?: string;
-
-    billing_address_extra?: string;
-
-    shipping_firstname?: string;
-
-    shipping_lastname?: string;
-
-    shipping_street?: string;
-
-    shipping_number?: string;
-
-    shipping_zipcode?: string;
-
-    shipping_city?: string;
-
-    shipping_state?: string;
-
-    shipping_country?: string;
-
-    shipping_address_extra?: string;
-
-    business_name?: string;
-
-    business_vat?: string;
-
-    business_reference?: string;
-  }): Promise<any>;
-
-  setBusiness(opts: { business?: boolean }): Promise<any>;
-
-  setCoupon(opts: { coupon?: string }): Promise<any>;
-
-  setPayment(opts: { payment?: string }): Promise<any>;
-
-  createOrder(): Promise<any>;
-
-  payOrder(opts: { orderId?: string }): Promise<any>;
-
-  validateVat(opts: { vat: string }): Promise<any>;
-
-  getAddressSuggestion(opts: {
-    zipcode: string;
-
-    number: number;
-  }): Promise<any>;
-
-  createSession(): Promise<any>;
-
-  deleteSession(): Promise<any>;
-
   getOrders(): Promise<any>;
 
-  getOrder(opts: { orderId: string }): Promise<any>;
-
-  loginByDelegationToken(opts: { token?: string }): Promise<any>;
-
-  logout(): Promise<any>;
-
   verifySubscription(opts: {
     token?: string;
 
@@ -8902,122 +8678,8 @@ export class AthomStoreAPI {
     secret?: string;
   });
 
-  getProducts(): Promise<any>;
-
-  getProduct(opts: { productId: string }): Promise<any>;
-
-  getCart(): Promise<any>;
-
-  addProductToCart(opts: {
-    sku?: string;
-
-    quantity?: number;
-
-    options?: object;
-  }): Promise<any>;
-
-  setCartProductQuantity(opts: {
-    sku?: string;
-
-    quantity?: number;
-  }): Promise<any>;
-
-  removeProductFromCart(opts: { sku?: string }): Promise<any>;
-
-  getLocales(): Promise<any>;
-
-  setLocale(opts: { locale?: string }): Promise<any>;
-
-  setUserdata(opts: {
-    shipping_address?: boolean;
-
-    create_account?: boolean;
-
-    newsletter?: boolean;
-
-    is_business?: boolean;
-
-    email?: string;
-
-    password?: string;
-
-    gender?: string;
-
-    phone?: string;
-
-    billing_firstname?: string;
-
-    billing_lastname?: string;
-
-    billing_street?: string;
-
-    billing_number?: string;
-
-    billing_zipcode?: string;
-
-    billing_city?: string;
-
-    billing_state?: string;
-
-    billing_country?: string;
-
-    billing_address_extra?: string;
-
-    shipping_firstname?: string;
-
-    shipping_lastname?: string;
-
-    shipping_street?: string;
-
-    shipping_number?: string;
-
-    shipping_zipcode?: string;
-
-    shipping_city?: string;
-
-    shipping_state?: string;
-
-    shipping_country?: string;
-
-    shipping_address_extra?: string;
-
-    business_name?: string;
-
-    business_vat?: string;
-
-    business_reference?: string;
-  }): Promise<any>;
-
-  setBusiness(opts: { business?: boolean }): Promise<any>;
-
-  setCoupon(opts: { coupon?: string }): Promise<any>;
-
-  setPayment(opts: { payment?: string }): Promise<any>;
-
-  createOrder(): Promise<any>;
-
-  payOrder(opts: { orderId?: string }): Promise<any>;
-
-  validateVat(opts: { vat: string }): Promise<any>;
-
-  getAddressSuggestion(opts: {
-    zipcode: string;
-
-    number: number;
-  }): Promise<any>;
-
-  createSession(): Promise<any>;
-
-  deleteSession(): Promise<any>;
-
   getOrders(): Promise<any>;
 
-  getOrder(opts: { orderId: string }): Promise<any>;
-
-  loginByDelegationToken(opts: { token?: string }): Promise<any>;
-
-  logout(): Promise<any>;
-
   verifySubscription(opts: {
     token?: string;
 
@@ -9130,122 +8792,8 @@ export class AthomStoreAPI {
 
   redeemCoupon(opts: { couponCode: string }): Promise<any>;
 
-  getProducts(): Promise<any>;
-
-  getProduct(opts: { productId: string }): Promise<any>;
-
-  getCart(): Promise<any>;
-
-  addProductToCart(opts: {
-    sku?: string;
-
-    quantity?: number;
-
-    options?: object;
-  }): Promise<any>;
-
-  setCartProductQuantity(opts: {
-    sku?: string;
-
-    quantity?: number;
-  }): Promise<any>;
-
-  removeProductFromCart(opts: { sku?: string }): Promise<any>;
-
-  getLocales(): Promise<any>;
-
-  setLocale(opts: { locale?: string }): Promise<any>;
-
-  setUserdata(opts: {
-    shipping_address?: boolean;
-
-    create_account?: boolean;
-
-    newsletter?: boolean;
-
-    is_business?: boolean;
-
-    email?: string;
-
-    password?: string;
-
-    gender?: string;
-
-    phone?: string;
-
-    billing_firstname?: string;
-
-    billing_lastname?: string;
-
-    billing_street?: string;
-
-    billing_number?: string;
-
-    billing_zipcode?: string;
-
-    billing_city?: string;
-
-    billing_state?: string;
-
-    billing_country?: string;
-
-    billing_address_extra?: string;
-
-    shipping_firstname?: string;
-
-    shipping_lastname?: string;
-
-    shipping_street?: string;
-
-    shipping_number?: string;
-
-    shipping_zipcode?: string;
-
-    shipping_city?: string;
-
-    shipping_state?: string;
-
-    shipping_country?: string;
-
-    shipping_address_extra?: string;
-
-    business_name?: string;
-
-    business_vat?: string;
-
-    business_reference?: string;
-  }): Promise<any>;
-
-  setBusiness(opts: { business?: boolean }): Promise<any>;
-
-  setCoupon(opts: { coupon?: string }): Promise<any>;
-
-  setPayment(opts: { payment?: string }): Promise<any>;
-
-  createOrder(): Promise<any>;
-
-  payOrder(opts: { orderId?: string }): Promise<any>;
-
-  validateVat(opts: { vat: string }): Promise<any>;
-
-  getAddressSuggestion(opts: {
-    zipcode: string;
-
-    number: number;
-  }): Promise<any>;
-
-  createSession(): Promise<any>;
-
-  deleteSession(): Promise<any>;
-
   getOrders(): Promise<any>;
 
-  getOrder(opts: { orderId: string }): Promise<any>;
-
-  loginByDelegationToken(opts: { token?: string }): Promise<any>;
-
-  logout(): Promise<any>;
-
   verifySubscription(opts: {
     token?: string;
 

package/lib/HomeyAPI/HomeyAPI.js

@@ -90,6 +90,7 @@ class HomeyAPI extends EventEmitter {
       value: properties.softwareVersion ?? null,
       enumerable: true,
       writable: true,
+      configurable: true,
     });
 
     // Set Name

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -228,20 +228,6 @@ 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];
-      this.__strategyId = Object.keys(urls)[0];
-
-      return {
-        baseUrl: this.__baseUrl,
-        strategyId: this.__strategyId,
-      };
-    }
-
     this.__debug(`Discovery Strategies: ${Object.keys(urls).join(',')}`);
 
     // Create the returned Promise
@@ -448,7 +434,7 @@ class HomeyAPIV3 extends HomeyAPI {
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.LOCAL]
         .then((result) => resolve(result))
-        .catch(() => {
+        .catch((err) => {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
@@ -463,12 +449,14 @@ class HomeyAPIV3 extends HomeyAPI {
 
                 reject(new APIErrorHomeyOffline(err));
               });
+          } else {
+            reject(new APIErrorHomeyOffline(err));
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS]
         .then((result) => resolve(result))
-        .catch(() => {
+        .catch((err) => {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
@@ -483,12 +471,14 @@ class HomeyAPIV3 extends HomeyAPI {
 
                 reject(new APIErrorHomeyOffline(err));
               });
+          } else {
+            reject(new APIErrorHomeyOffline(err));
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED]) {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.REMOTE_FORWARDED]
         .then((result) => resolve(result))
-        .catch(() => {
+        .catch((err) => {
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
@@ -503,6 +493,8 @@ class HomeyAPIV3 extends HomeyAPI {
 
                 reject(new APIErrorHomeyOffline(err));
               });
+          } else {
+            reject(new APIErrorHomeyOffline(err));
           }
         });
     } else if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
@@ -660,6 +652,7 @@ class HomeyAPIV3 extends HomeyAPI {
           this.__token = store.token;
           this.__session = store.session;
 
+          await this.baseUrl; // Ensure discovery has completed
           return;
         }
 

package/lib/HomeyAPI/HomeyAPIV3Cloud.js

@@ -32,6 +32,11 @@ class HomeyAPIV3Cloud extends HomeyAPIV3 {
       strategy,
       ...props,
     });
+
+    // Seed the version cache with the initial value from the Cloud API,
+    // then remove the own data property so the prototype getter is used.
+    this.__versionCache[this.id] ??= this.version;
+    delete this.version;
   }
 
   get tier() {
@@ -42,6 +47,10 @@ class HomeyAPIV3Cloud extends HomeyAPIV3 {
     return this.__versionCache[this.id];
   }
 
+  set version(value) {
+    this.__versionCache[this.id] = value;
+  }
+
   get platform() {
     return 'cloud';
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.15.0",
+  "version": "3.16.1",
   "description": "Homey API",
   "main": "index.js",
   "license": "SEE LICENSE",
@@ -73,7 +73,7 @@
     "homey-api": "^3.0.8",
     "http-server": "^0.12.3",
     "jest": "^30.0.0-alpha.2",
-    "jsdoc": "^4.0.2",
+    "jsdoc": "4.0.5",
     "jsdoc-to-markdown": "^8.0.0",
     "jsdoc-ts-utils": "^4.0.0",
     "jsdoc-tsimport-plugin": "^1.0.5",