homey-api 3.0.0-rc.7 → 3.0.0-rc.9

package/assets/specifications/HomeyAPIV3Local.json

@@ -1,5 +1,177 @@
 {
   "managers": {
+    "ManagerAlarms": {
+      "id": "alarms",
+      "idCamelCase": "alarms",
+      "items": {
+        "Alarm": {
+          "id": "alarm",
+          "schema": {
+            "repetition": {
+              "type": "object",
+              "properties": {
+                "required": [
+                  "monday",
+                  "tuesday",
+                  "wednesday",
+                  "thursday",
+                  "friday",
+                  "saturday",
+                  "sunday"
+                ],
+                "monday": {
+                  "type": "boolean"
+                },
+                "tuesday": {
+                  "type": "boolean"
+                },
+                "wednesday": {
+                  "type": "boolean"
+                },
+                "thursday": {
+                  "type": "boolean"
+                },
+                "friday": {
+                  "type": "boolean"
+                },
+                "saturday": {
+                  "type": "boolean"
+                },
+                "sunday": {
+                  "type": "boolean"
+                }
+              }
+            }
+          }
+        }
+      },
+      "operations": {
+        "getAlarms": {
+          "method": "get",
+          "path": "/alarm",
+          "private": false,
+          "scopes": [
+            "homey.alarm.readonly"
+          ],
+          "crud": {
+            "type": "getAll",
+            "item": "Alarm"
+          },
+          "parameters": {}
+        },
+        "getAlarm": {
+          "method": "get",
+          "path": "/alarm/:id",
+          "private": false,
+          "scopes": [
+            "homey.alarm.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "Alarm"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "createAlarm": {
+          "method": "post",
+          "path": "/alarm",
+          "private": false,
+          "scopes": [
+            "homey.alarm"
+          ],
+          "crud": {
+            "type": "createOne",
+            "item": "Alarm"
+          },
+          "parameters": {
+            "alarm": {
+              "in": "body",
+              "type": "object",
+              "root": true,
+              "required": true,
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "time": {
+                  "type": "string"
+                },
+                "enabled": {
+                  "type": "boolean"
+                },
+                "repetition": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "updateAlarm": {
+          "method": "put",
+          "path": "/alarm/:id",
+          "private": false,
+          "scopes": [
+            "homey.alarm"
+          ],
+          "crud": {
+            "type": "updateOne",
+            "item": "Alarm"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "alarm": {
+              "in": "body",
+              "type": "object",
+              "root": true,
+              "required": true,
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "time": {
+                  "type": "string"
+                },
+                "enabled": {
+                  "type": "boolean"
+                },
+                "repetition": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "deleteAlarm": {
+          "method": "delete",
+          "path": "/alarm/:id",
+          "private": false,
+          "scopes": [
+            "homey.alarm"
+          ],
+          "crud": {
+            "type": "deleteOne",
+            "item": "Alarm"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        }
+      }
+    },
     "ManagerApi": {
       "id": "api",
       "idCamelCase": "api",
@@ -418,25 +590,6 @@
             "homey.system.readonly"
           ],
           "parameters": {}
-        },
-        "runCommand": {
-          "method": "post",
-          "path": "/command",
-          "private": false,
-          "scopes": [
-            "homey.system"
-          ],
-          "parameters": {
-            "command": {
-              "in": "body",
-              "type": "string",
-              "required": true
-            },
-            "opts": {
-              "in": "body",
-              "type": "object"
-            }
-          }
         }
       }
     },
@@ -3562,6 +3715,21 @@
             "homey.system"
           ],
           "parameters": {}
+        },
+        "setDebug": {
+          "method": "put",
+          "path": "/debug",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "namespace": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -4401,6 +4569,30 @@
             "homey.system"
           ],
           "parameters": {}
+        },
+        "getLog": {
+          "method": "get",
+          "path": "/log",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
+        },
+        "setLogEnabled": {
+          "method": "put",
+          "path": "/log",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "enabled": {
+              "in": "body",
+              "type": "boolean",
+              "required": true
+            }
+          }
         }
       }
     }

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

@@ -279,7 +279,7 @@
     
   
     
-      debug: function,
+      debug: function | null,
     
   
 },
@@ -2224,6 +2224,22 @@
 
   
 
+  
+
+  
+
+  
+    export namespace HomeyAPIV3Local.ManagerAlarms {
+      
+  export class Alarm  {
+    
+
+    
+
+    
+  }
+
+    }
   
 
   
@@ -10281,6 +10297,150 @@
     
 
     
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
+    
+      disconnect(
+        
+      ):
+        Promise<void>;
+    
+  }
+
+  export class ManagerAlarms extends HomeyAPIV3Local.Manager {
+    
+
+    
+
+    
+      getAlarms(
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      getAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      createAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      alarm: {
+  
+    
+      name: string,
+    
+  
+    
+      time: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      repetition: object,
+    
+  
+},
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      updateAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+    
+      alarm: {
+  
+    
+      name: string,
+    
+  
+    
+      time: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      repetition: object,
+    
+  
+},
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      deleteAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
       isConnected(
         
       ):
@@ -10767,29 +10927,6 @@
     
       getState(
         
-      ):
-        Promise<any>;
-    
-      runCommand(
-        
-          
-  
-    
-      opts: {
-  
-    
-      command: string,
-    
-  
-    
-      opts: object,
-    
-  
-},
-    
-  
-
-        
       ):
         Promise<any>;
     
@@ -13735,6 +13872,25 @@
     
       rebootOTA(
         
+      ):
+        Promise<any>;
+    
+      setDebug(
+        
+          
+  
+    
+      opts: {
+  
+    
+      namespace: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -14480,6 +14636,30 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      getLog(
+        
+      ):
+        Promise<any>;
+    
+      setLogEnabled(
+        
+          
+  
+    
+      opts: {
+  
+    
+      enabled: boolean,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     

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

@@ -5371,7 +5371,7 @@
     
   
     
-      debug: function,
+      debug: function | null,
     
   
 },
@@ -7614,6 +7614,22 @@
 
   
 
+  
+
+  
+
+  
+    export namespace HomeyAPIV3Local.ManagerAlarms {
+      
+  export class Alarm  {
+    
+
+    
+
+    
+  }
+
+    }
   
 
   
@@ -16178,6 +16194,150 @@
     
 
     
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
+    
+      disconnect(
+        
+      ):
+        Promise<void>;
+    
+  }
+
+  export class ManagerAlarms extends HomeyAPIV3Local.Manager {
+    
+
+    
+
+    
+      getAlarms(
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      getAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      createAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      alarm: {
+  
+    
+      name: string,
+    
+  
+    
+      time: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      repetition: object,
+    
+  
+},
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      updateAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+    
+      alarm: {
+  
+    
+      name: string,
+    
+  
+    
+      time: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      repetition: object,
+    
+  
+},
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      deleteAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
       isConnected(
         
       ):
@@ -16664,29 +16824,6 @@
     
       getState(
         
-      ):
-        Promise<any>;
-    
-      runCommand(
-        
-          
-  
-    
-      opts: {
-  
-    
-      command: string,
-    
-  
-    
-      opts: object,
-    
-  
-},
-    
-  
-
-        
       ):
         Promise<any>;
     
@@ -19773,6 +19910,25 @@
     
       rebootOTA(
         
+      ):
+        Promise<any>;
+    
+      setDebug(
+        
+          
+  
+    
+      opts: {
+  
+    
+      namespace: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -20528,6 +20684,30 @@
     
       flashFirmware(
         
+      ):
+        Promise<any>;
+    
+      getLog(
+        
+      ):
+        Promise<any>;
+    
+      setLogEnabled(
+        
+          
+  
+    
+      opts: {
+  
+    
+      enabled: boolean,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     

package/lib/HomeyAPI/HomeyAPI.js

@@ -129,18 +129,22 @@ class HomeyAPI {
    * Create a {@link HomeyAPIV3Local} instance for use in the Apps SDK.
    * @param {Object} opts
    * @param {Homey} opts.homey — Homey instance
-   * @param {Function} opts.debug — Debug method, defaults to `homey.app.log`
+   * @param {Function|null} opts.debug — Debug function, defaults to `null`
    */
   static async createAppAPI({
     homey,
-    debug = (...props) => homey.app.log('[homey-api]', ...props),
+    debug = null,
   } = {}) {
     if (!homey) {
       throw new Error('Invalid Homey');
     }
 
+    if (debug === true) {
+      debug = (...props) => homey.app.log('[homey-api]', ...props);
+    }
+
     const props = {
-      debug,
+      debug: debug ?? function debug() { },
       token: await homey.api.getOwnerApiToken(),
       baseUrl: await homey.api.getLocalUrl(),
       strategy: [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.0.0-rc.7",
+  "version": "3.0.0-rc.9",
   "description": "Homey API",
   "main": "index.js",
   "files": [