homey-api 3.4.28 → 3.4.30

package/assets/specifications/AthomAppsAPI.json

@@ -317,6 +317,17 @@
         }
       }
     },
+    "getAppIcon": {
+      "path": "/app/{appId}/icon",
+      "method": "get",
+      "parameters": {
+        "appId": {
+          "in": "path",
+          "type": "string",
+          "required": true
+        }
+      }
+    },
     "getAppInstall": {
       "path": "/app/{appId}/install",
       "method": "get",

package/assets/specifications/HomeyAPIV3Cloud.json

@@ -2596,6 +2596,202 @@
         }
       }
     },
+    "ManagerMoods": {
+      "id": "moods",
+      "idCamelCase": "moods",
+      "private": true,
+      "items": {
+        "Mood": {
+          "id": "mood",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              },
+              "zone": {
+                "type": "string"
+              },
+              "devices": {
+                "type": "object",
+                "additionalProperties": false,
+                "patternProperties": {
+                  "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                      "state": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "patternProperties": {
+                          ".*": {
+                            "anyOf": [
+                              {
+                                "type": "string"
+                              },
+                              {
+                                "type": "boolean"
+                              },
+                              {
+                                "type": "number"
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "additionalProperties": false
+          }
+        }
+      },
+      "operations": {
+        "getState": {
+          "method": "get",
+          "path": "/state",
+          "private": false,
+          "scopes": [
+            "homey.system.readonly"
+          ],
+          "parameters": {}
+        },
+        "getMoods": {
+          "method": "get",
+          "path": "/mood",
+          "private": false,
+          "scopes": [
+            "homey.mood.readonly"
+          ],
+          "crud": {
+            "type": "getAll",
+            "item": "Mood"
+          },
+          "parameters": {}
+        },
+        "getMood": {
+          "method": "get",
+          "path": "/mood/:id",
+          "private": false,
+          "scopes": [
+            "homey.mood.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "Mood"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "createMood": {
+          "method": "post",
+          "path": "/mood",
+          "private": false,
+          "scopes": [
+            "homey.mood"
+          ],
+          "crud": {
+            "type": "createOne",
+            "item": "Mood"
+          },
+          "parameters": {
+            "mood": {
+              "in": "body",
+              "type": "object",
+              "root": true,
+              "required": true,
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "required": true
+                },
+                "devices": {
+                  "type": "object",
+                  "required": true
+                }
+              }
+            }
+          }
+        },
+        "updateMood": {
+          "method": "put",
+          "path": "/mood/:id",
+          "private": false,
+          "scopes": [
+            "homey.mood"
+          ],
+          "crud": {
+            "type": "updateOne",
+            "item": "Mood"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "mood": {
+              "in": "body",
+              "type": "object",
+              "root": true,
+              "required": true,
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "devices": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "setMood": {
+          "method": "post",
+          "path": "/mood/:id/set",
+          "private": false,
+          "scopes": [
+            "homey.mood.set"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "deleteMood": {
+          "method": "delete",
+          "path": "/mood/:id",
+          "private": false,
+          "scopes": [
+            "homey.mood"
+          ],
+          "crud": {
+            "type": "deleteOne",
+            "item": "Mood"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        }
+      }
+    },
     "ManagerNotifications": {
       "id": "notifications",
       "idCamelCase": "notifications",

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

@@ -935,6 +935,18 @@ export namespace HomeyAPIV3Cloud.ManagerLogic {
   }
 }
 
+export namespace HomeyAPIV3Cloud.ManagerMoods {
+  export class Mood {
+    id: string;
+
+    name: string;
+
+    zone: string;
+
+    devices: object;
+  }
+}
+
 export namespace HomeyAPIV3Cloud.ManagerNotifications {
   export class Notification {
     id: string;
@@ -1659,6 +1671,8 @@ export class AthomAppsAPI {
     userId?: string;
   }): Promise<any>;
 
+  getAppIcon(opts: { appId: string }): Promise<any>;
+
   getAppInstall(opts: {
     appId: string;
 
@@ -1947,6 +1961,8 @@ export class AthomAppsAPI {
     userId?: string;
   }): Promise<any>;
 
+  getAppIcon(opts: { appId: string }): Promise<any>;
+
   getAppInstall(opts: {
     appId: string;
 
@@ -4589,7 +4605,15 @@ export class HomeyCloudAPI {
 }
 
 export class Util {
-  static fetch(args: any): Promise;
+  static fetch(
+    args: string,
+
+    options?: Object,
+
+    timeoutDuration?: number,
+
+    timeoutMessage?: string,
+  ): Promise<any>;
 
   static wait(ms: number): Promise<void>;
 
@@ -4625,7 +4649,15 @@ export class Util {
 
   static encodeUrlSearchParams(params: object): string;
 
-  static fetch(args: any): Promise;
+  static fetch(
+    args: string,
+
+    options?: Object,
+
+    timeoutDuration?: number,
+
+    timeoutMessage?: string,
+  ): Promise<any>;
 
   static wait(ms: number): Promise<void>;
 
@@ -4835,6 +4867,8 @@ export class AthomAppsAPI {
     userId?: string;
   }): Promise<any>;
 
+  getAppIcon(opts: { appId: string }): Promise<any>;
+
   getAppInstall(opts: {
     appId: string;
 
@@ -5123,6 +5157,8 @@ export class AthomAppsAPI {
     userId?: string;
   }): Promise<any>;
 
+  getAppIcon(opts: { appId: string }): Promise<any>;
+
   getAppInstall(opts: {
     appId: string;
 
@@ -7701,7 +7737,15 @@ export class HomeyCloudAPI {
 }
 
 export class Util {
-  static fetch(args: any): Promise;
+  static fetch(
+    args: string,
+
+    options?: Object,
+
+    timeoutDuration?: number,
+
+    timeoutMessage?: string,
+  ): Promise<any>;
 
   static wait(ms: number): Promise<void>;
 
@@ -7737,7 +7781,15 @@ export class Util {
 
   static encodeUrlSearchParams(params: object): string;
 
-  static fetch(args: any): Promise;
+  static fetch(
+    args: string,
+
+    options?: Object,
+
+    timeoutDuration?: number,
+
+    timeoutMessage?: string,
+  ): Promise<any>;
 
   static wait(ms: number): Promise<void>;
 
@@ -8501,6 +8553,36 @@ export namespace HomeyAPIV3Cloud {
     }): Promise<any>;
   }
 
+  export class ManagerMoods extends HomeyAPIV3.ManagerMoods {
+    getState(): Promise<any>;
+
+    getMoods(): Promise<{ [key: string]: HomeyAPIV3Cloud.ManagerMoods.Mood }>;
+
+    getMood(opts: { id: string }): Promise<HomeyAPIV3Cloud.ManagerMoods.Mood>;
+
+    createMood(opts: {
+      mood: {
+        name: string;
+
+        devices: object;
+      };
+    }): Promise<HomeyAPIV3Cloud.ManagerMoods.Mood>;
+
+    updateMood(opts: {
+      id: string;
+
+      mood: {
+        name?: string;
+
+        devices?: object;
+      };
+    }): Promise<HomeyAPIV3Cloud.ManagerMoods.Mood>;
+
+    setMood(opts: { id: string }): Promise<any>;
+
+    deleteMood(opts: { id: string }): Promise<any>;
+  }
+
   export class ManagerNotifications extends HomeyAPIV3.ManagerNotifications {
     getState(): Promise<any>;
 

package/lib/API.js

@@ -6,7 +6,6 @@ const Util = require('./Util');
 const APIError = require('./APIError');
 
 class API {
-
   static SPECIFICATION = null;
   static SPECIFICATION_URL = null;
   static DEFINITION_CLASSES = {};
@@ -16,19 +15,13 @@ class API {
   static JSDOC_PRIVATE = null;
   static JSDOC_EXAMPLE = null;
 
-  constructor({
-    baseUrl,
-    debug = false,
-    secret = null,
-  } = {}) {
+  constructor({ baseUrl, debug = false, secret = null } = {}) {
     // Set Debug Enabled
     const debugEnvKey = `${Util.envKey(this.constructor.name)}_DEBUG`;
     const debugEnv = Util.env(debugEnvKey);
 
     Object.defineProperty(this, '__debugEnabled', {
-      value: debugEnv !== null
-        ? !!debugEnv
-        : !!debug,
+      value: debugEnv !== null ? !!debugEnv : !!debug,
       enumerable: false,
       writable: true,
     });
@@ -38,9 +31,7 @@ class API {
     const secretEnv = Util.env(secretEnvKey);
 
     Object.defineProperty(this, '__secret', {
-      value: secretEnv !== null
-        ? secretEnv
-        : secret,
+      value: secretEnv !== null ? secretEnv : secret,
       enumerable: false,
       writable: false,
     });
@@ -49,11 +40,17 @@ class API {
     const baseUrlEnvKey = `${Util.envKey(this.constructor.name)}_BASEURL`;
     const baseUrlEnv = Util.env(baseUrlEnvKey);
 
-    this.baseUrl = baseUrlEnv || baseUrl || `https://${this.constructor.SPECIFICATION.host}${this.constructor.SPECIFICATION.basePath}`;
-    if (this.baseUrl.endsWith('/')) this.baseUrl = this.baseUrl.substring(0, this.baseUrl.length - 1);
+    this.baseUrl =
+      baseUrlEnv ||
+      baseUrl ||
+      `https://${this.constructor.SPECIFICATION.host}${this.constructor.SPECIFICATION.basePath}`;
+    if (this.baseUrl.endsWith('/'))
+      this.baseUrl = this.baseUrl.substring(0, this.baseUrl.length - 1);
 
     // Create Operations
-    for (const [operationId, operation] of Object.entries(this.constructor.SPECIFICATION.operations || {})) {
+    for (const [operationId, operation] of Object.entries(
+      this.constructor.SPECIFICATION.operations || {}
+    )) {
       this.__registerOperation(operationId, operation);
     }
   }
@@ -81,7 +78,11 @@ class API {
         let value = args[parameterId];
 
         // Set secret if not provided as parameter but in constructor
-        if (parameterId === 'secret' && typeof value === 'undefined' && typeof this.__secret === 'string') {
+        if (
+          parameterId === 'secret' &&
+          typeof value === 'undefined' &&
+          typeof this.__secret === 'string'
+        ) {
           value = this.__secret;
         }
 
@@ -97,16 +98,26 @@ class API {
           }
 
           if (typeof value !== 'undefined') {
-            if (parameter.in !== 'query' && parameter.type === 'string' && typeof value !== 'string') {
-              throw new Error(`Invalid Parameter Type: ${parameterId}. Got: ${typeof value}. Expected: string`);
+            if (
+              parameter.in !== 'query' &&
+              parameter.type === 'string' &&
+              typeof value !== 'string'
+            ) {
+              throw new Error(
+                `Invalid Parameter Type: ${parameterId}. Got: ${typeof value}. Expected: string`
+              );
             }
 
             if (parameter.type === 'number' && typeof value !== 'number') {
-              throw new Error(`Invalid Parameter Type: ${parameterId}. Got: ${typeof value}. Expected: number`);
+              throw new Error(
+                `Invalid Parameter Type: ${parameterId}. Got: ${typeof value}. Expected: number`
+              );
             }
 
             if (parameter.type === 'boolean' && typeof value !== 'boolean') {
-              throw new Error(`Invalid Parameter Type: ${parameterId}. Got: ${typeof value}. Expected: boolean`);
+              throw new Error(
+                `Invalid Parameter Type: ${parameterId}. Got: ${typeof value}. Expected: boolean`
+              );
             }
           }
         }
@@ -149,7 +160,7 @@ class API {
         context: { operation },
         timeout: $timeout,
         timeoutMessage: $timeoutMessage,
-      }).catch(err => {
+      }).catch((err) => {
         if (typeof this.__secret === 'string' && err.message.includes(this.__secret)) {
           err.message = err.message.replace(this.__secret, '<redacted>');
         }
@@ -189,7 +200,7 @@ class API {
     // Headers
     request.headers = {
       ...request.headers,
-      ...await this.onCallRequestHeaders({ request }),
+      ...(await this.onCallRequestHeaders({ request })),
     };
 
     // Timeout
@@ -229,11 +240,18 @@ class API {
   async onCallRequestExecute({ request }) {
     this.__debug('onCallRequestExecute', request);
 
-    return Util.timeout(Util.fetch(request.url, {
-      method: request.method,
-      headers: request.headers,
-      body: request.body,
-    }), request.timeout, request.timeoutMessage);
+    const result = await Util.fetch(
+      request.url,
+      {
+        method: request.method,
+        headers: request.headers,
+        body: request.body,
+      },
+      request.timeout,
+      request.timeoutMessage
+    );
+
+    return result;
   }
 
   async onCallResponse({ request, response }) {
@@ -313,7 +331,6 @@ class API {
       return body.message;
     }
 
-
     return body;
   }
 
@@ -343,7 +360,6 @@ class API {
 
     throw new APIError(message, statusCode);
   }
-
 }
 
 module.exports = API;

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -455,12 +455,13 @@ class HomeyAPIV3 extends HomeyAPI {
     }
 
     this.__debug(method, `${baseUrl}${path}`);
-    const res = await Util.timeout(
-      Util.fetch(`${baseUrl}${path}`, {
+    const res = await Util.fetch(
+      `${baseUrl}${path}`,
+      {
         method,
         headers,
         body,
-      }),
+      },
       $timeout
     );
 

package/lib/Util.js

@@ -14,25 +14,55 @@ class Util {
 
   /**
    * Makes a call using `window.fetch` or `node-fetch`.
-   * @param  {...any} args
-   * @returns {Promise}
+   * @param  {string} args
+   * @param  {{}=} options
+   * @param  {number=} timeoutDuration
+   * @param  {string=} timeoutMessage
+   * @returns {Promise<any>}
    */
-  static async fetch(...args) {
-    if (this.isReactNative()) {
-      return fetch(...args);
+  static async fetch(url, options, timeoutDuration, timeoutMessage) {
+    options = { ...options };
+    let abortTimeout = null;
+
+    if (timeoutDuration != null) {
+      const abortController = new AbortController();
+  
+      abortTimeout = setTimeout(() => {
+        abortController.abort('Timeout');
+      }, timeoutDuration);
+
+      options.signal = abortController.signal;
     }
 
-    if (this.isBrowser()) {
-      return window.fetch(...args);
-    }
+    let responsePromise = null;
 
-    if (this.isNodeJS()) {
+    if (this.isReactNative()) {
+      responsePromise = fetch(url, options);
+    } else if (this.isBrowser()) {
+      responsePromise = window.fetch(url, options);
+    } else if  (this.isNodeJS()) {
       const fetch = require('node-fetch');
-      return fetch(...args);
+      responsePromise = fetch(url, options);
+    } else if (typeof fetch !== 'undefined') {
+      responsePromise = fetch(url, options);
+    } else {
+      throw new Error('No fetch implementation found');
     }
 
-    if (typeof fetch !== 'undefined') {
-      return fetch(...args);
+    try {
+      const result = await responsePromise;
+
+      return result;
+    } catch (err) {
+      if (err.name === 'AbortError') {
+        if (options.signal && options.signal.aborted && options.signal.reason === 'Timeout') {
+          throw new APIErrorTimeout(timeoutMessage ?? `Timeout after ${timeoutDuration}ms`);
+        }
+      }
+
+      throw err;
+    } finally {
+      clearTimeout(abortTimeout);
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.4.28",
+  "version": "3.4.30",
   "description": "Homey API",
   "main": "index.js",
   "files": [