homey-api 3.0.0-rc.6 → 3.0.0-rc.8

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

@@ -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

@@ -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/HomeyAPIV2/ManagerDevices/Capability.js

@@ -4,8 +4,8 @@ const CapabilityV3 = require('../../HomeyAPIV3/ManagerDevices/Capability');
 
 class Capability extends CapabilityV3 {
 
-  static transform(item) {
-    item = super.transform(item);
+  static transformGet(item) {
+    item = super.transformGet(item);
 
     item.id = `${item.uri}:${item.id}`;
     item.ownerUri = item.uri;

package/lib/HomeyAPI/HomeyAPIV2/ManagerDevices/Device.js

@@ -4,8 +4,8 @@ const DeviceV3 = require('../../HomeyAPIV3/ManagerDevices/Device');
 
 class Device extends DeviceV3 {
 
-  static transform(item) {
-    item = super.transform(item);
+  static transformGet(item) {
+    item = super.transformGet(item);
 
     item.driverId = `${item.driverUri}:${item.driverId}`;
     delete item.driverUri;

package/lib/HomeyAPI/HomeyAPIV2/ManagerDrivers/Driver.js

@@ -4,8 +4,8 @@ const DriverV3 = require('../../HomeyAPIV3/ManagerDrivers/Driver');
 
 class Driver extends DriverV3 {
 
-  static transform(item) {
-    item = super.transform(item);
+  static transformGet(item) {
+    item = super.transformGet(item);
 
     item.ownerId = item.id;
     item.ownerUri = item.uri;

package/lib/HomeyAPI/HomeyAPIV2/ManagerDrivers/PairSession.js

@@ -4,8 +4,8 @@ const PairSessionV3 = require('../../HomeyAPIV3/ManagerDrivers/PairSession');
 
 class PairSession extends PairSessionV3 {
 
-  static transform(item) {
-    item = super.transform(item);
+  static transformGet(item) {
+    item = super.transformGet(item);
 
     item.driverId = `${item.driverUri}:${item.driverId}`;
     item.ownerUri = item.driverUri;

package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow/AdvancedFlow.js

@@ -4,7 +4,7 @@ const AdvancedFlowV3 = require('../../HomeyAPIV3/ManagerFlow/Flow');
 
 class AdvancedFlow extends AdvancedFlowV3 {
 
-  static transform(item) {
+  static transformGet(item) {
     if (item.cards) {
       for (const card of Object.values(item.cards)) {
         card.id = `${card.ownerUri}:${card.id}`;
@@ -14,7 +14,7 @@ class AdvancedFlow extends AdvancedFlowV3 {
     return item;
   }
 
-  static transformSave(item) {
+  static transformSet(item) {
     if (item.cards) {
       for (const card of Object.values(item.cards)) {
         card.ownerUri = card.id.split(':', 3).join(':');

package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow/Flow.js

@@ -4,8 +4,8 @@ const FlowV3 = require('../../HomeyAPIV3/ManagerFlow/Flow');
 
 class Flow extends FlowV3 {
 
-  static transform(item) {
-    item = super.transform(item);
+  static transformGet(item) {
+    item = super.transformGet(item);
 
     if (item.trigger) {
       item.trigger.id = `${item.trigger.uri}:${item.trigger.id}`;
@@ -29,7 +29,7 @@ class Flow extends FlowV3 {
     return item;
   }
 
-  static transformSave(item) {
+  static transformSet(item) {
     if (item.trigger) {
       item.trigger.uri = item.trigger.id.split(':', 3).join(':');
       item.trigger.id = item.trigger.id.split(':').reverse()[0];

package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow/FlowCardAction.js

@@ -4,8 +4,8 @@ const FlowCardActionV3 = require('../../HomeyAPIV3/ManagerFlow/FlowCardAction');
 
 class FlowCardAction extends FlowCardActionV3 {
 
-  static transform(item) {
-    item = super.transform(item);
+  static transformGet(item) {
+    item = super.transformGet(item);
 
     item.id = `${item.uri}:${item.id}`;
     item.ownerUri = item.uri;

package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow/FlowCardCondition.js

@@ -4,8 +4,8 @@ const FlowCardConditionV3 = require('../../HomeyAPIV3/ManagerFlow/FlowCardCondit
 
 class FlowCardCondition extends FlowCardConditionV3 {
 
-  static transform(item) {
-    item = super.transform(item);
+  static transformGet(item) {
+    item = super.transformGet(item);
 
     item.id = `${item.uri}:${item.id}`;
     item.ownerUri = item.uri;

package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow/FlowCardTrigger.js

@@ -4,8 +4,8 @@ const FlowCardTriggerV3 = require('../../HomeyAPIV3/ManagerFlow/FlowCardTrigger'
 
 class FlowCardTrigger extends FlowCardTriggerV3 {
 
-  static transform(item) {
-    item = super.transform(item);
+  static transformGet(item) {
+    item = super.transformGet(item);
 
     item.id = `${item.uri}:${item.id}`;
     item.ownerUri = item.uri;

package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow.js

@@ -23,7 +23,7 @@ class ManagerFlow extends Manager {
     ...props
   }) {
     return this.__super__.createFlow({
-      flow: Flow.transformSave(flow),
+      flow: Flow.transformSet(flow),
       ...props,
     });
   }
@@ -33,7 +33,7 @@ class ManagerFlow extends Manager {
     ...props
   }) {
     return this.__super__.updateFlow({
-      flow: Flow.transformSave(flow),
+      flow: Flow.transformSet(flow),
       ...props,
     });
   }
@@ -43,7 +43,7 @@ class ManagerFlow extends Manager {
     ...props
   }) {
     return this.__super__.createAdvancedFlow({
-      advancedflow: AdvancedFlow.transformSave(advancedflow),
+      advancedflow: AdvancedFlow.transformSet(advancedflow),
       ...props,
     });
   }
@@ -53,7 +53,7 @@ class ManagerFlow extends Manager {
     ...props
   }) {
     return this.__super__.updateAdvancedFlow({
-      advancedflow: AdvancedFlow.transformSave(advancedflow),
+      advancedflow: AdvancedFlow.transformSet(advancedflow),
       ...props,
     });
   }

package/lib/HomeyAPI/HomeyAPIV2/ManagerFlowToken/FlowToken.js

@@ -4,15 +4,15 @@ const FlowTokenV3 = require('../../HomeyAPIV3/ManagerFlowToken/FlowToken');
 
 class FlowToken extends FlowTokenV3 {
 
-  static transform(item) {
+  static transformGet(item) {
     // TODO: Remove FlowTokenV3.transform and uncomment this after front-end does not use FlowToken.uri|id|uriObj anymore!
-    // item = super.transform(item);
+    // item = super.transformGet(item);
 
     item.ownerUri = item.uri;
     item.ownerId = item.id;
-    item.ownerName = item.uriObj.name;
     item.id = `${item.ownerUri}:${item.ownerId}`;
 
+    delete item.ownerName; // Prepare for back-end change
     delete item.uri;
     delete item.uriObj;
 

package/lib/HomeyAPI/HomeyAPIV2/ManagerInsights/Log.js

@@ -4,12 +4,11 @@ const LogV3 = require('../../HomeyAPIV3/ManagerInsights/Log');
 
 class Log extends LogV3 {
 
-  static transform(item) {
-    item = super.transform(item);
+  static transformGet(item) {
+    item = super.transformGet(item);
 
     item.ownerId = item.id;
     item.ownerUri = item.uri;
-    item.ownerName = item.uriObj.name;
     item.id = `${item.uri}:${item.id}`;
 
     delete item.uri;

package/lib/HomeyAPI/HomeyAPIV3/Item.js

@@ -180,7 +180,11 @@ class Item extends EventEmitter {
     this.disconnect().catch(() => { });
   }
 
-  static transform(item) {
+  static transformGet(item) {
+    return item;
+  }
+
+  static transformSet(item) {
     return item;
   }
 

package/lib/HomeyAPI/HomeyAPIV3/Manager.js

@@ -258,7 +258,7 @@ class Manager extends EventEmitter {
               switch (operation.crud.type) {
                 case 'getOne': {
                   let item = { ...result };
-                  item = Item.transform(item);
+                  item = Item.transformGet(item);
                   item = new Item({
                     id: item.id,
                     homey: this.homey,
@@ -277,7 +277,7 @@ class Manager extends EventEmitter {
 
                   // Add all to cache
                   for (let item of Object.values(result)) {
-                    item = Item.transform(item);
+                    item = Item.transformGet(item);
                     if (this.__cache[itemId][item.id]) {
                       items[item.id] = this.__cache[itemId][item.id];
                       items[item.id].__update(item);
@@ -314,13 +314,13 @@ class Manager extends EventEmitter {
                 case 'createOne':
                 case 'updateOne': {
                   let item = { ...result };
-                  item = Item.transform(item);
+                  item = Item.transformGet(item);
 
                   if (this.__cache[itemId][item.id]) {
                     item = this.__cache[itemId][item.id];
                     item.__update(item);
                   } else {
-                    item = Item.transform(item);
+                    item = Item.transformGet(item);
                     item = new Item({
                       id: item.id,
                       homey: this.homey,
@@ -412,7 +412,7 @@ class Manager extends EventEmitter {
 
               switch (operation) {
                 case 'create': {
-                  data = Item.transform(data);
+                  data = Item.transformGet(data);
 
                   const item = new Item({
                     id: data.id,
@@ -425,7 +425,7 @@ class Manager extends EventEmitter {
                   break;
                 }
                 case 'update': {
-                  data = Item.transform(data);
+                  data = Item.transformGet(data);
 
                   if (this.__cache[itemId][data.id]) {
                     const item = this.__cache[itemId][data.id];
@@ -435,7 +435,7 @@ class Manager extends EventEmitter {
                   break;
                 }
                 case 'delete': {
-                  data = Item.transform(data);
+                  data = Item.transformGet(data);
 
                   if (this.__cache[itemId][data.id]) {
                     const item = this.__cache[itemId][data.id];

package/lib/HomeyAPI/HomeyAPIV3/ManagerDevices/Device.js

@@ -195,7 +195,9 @@ class Device extends Item {
       }), {});
   }
 
-  static transform(item) {
+  static transformGet(item) {
+    item = super.transformGet(item);
+
     if (item.capabilitiesObj) {
       for (const capabilityObj of Object.values(item.capabilitiesObj)) {
         if (capabilityObj.lastUpdated) {

package/lib/HomeyAPI/HomeyAPIV3/ManagerFlow/FlowCard.js

@@ -4,6 +4,14 @@ const Item = require('../Item');
 
 class FlowCard extends Item {
 
+  static transformGet(item) {
+    item = super.transformGet(item);
+
+    delete item.ownerName; // Prepare for back-end change
+
+    return item;
+  }
+
 }
 
 module.exports = FlowCard;

package/lib/HomeyAPI/HomeyAPIV3/ManagerFlowToken/FlowToken.js

@@ -5,10 +5,13 @@ const Item = require('../Item');
 class FlowToken extends Item {
 
   // TODO: Remove when back-end has removed these properties.
-  static transform(item) {
+  static transformGet(item) {
+    item = super.transformGet(item);
+
     delete item.uri;
     delete item.id;
     delete item.uriObj;
+    delete item.ownerName; // Prepare for back-end change
   }
 
 }

package/lib/HomeyAPI/HomeyAPIV3/ManagerInsights/Log.js

@@ -10,6 +10,14 @@ class Log extends Item {
     });
   }
 
+  static transformGet(item) {
+    item = super.transformGet(item);
+
+    delete item.ownerName; // Prepare for back-end change
+
+    return item;
+  }
+
 }
 
 module.exports = Log;

package/package.json

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