homey-api 3.0.0-rc.1 → 3.0.0-rc.11

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

@@ -5371,7 +5371,7 @@
     
   
     
-      debug: function,
+      debug: function | null,
     
   
 },
@@ -6411,62 +6411,6 @@
     
 
     
-      makeCapabilityInstance(
-        
-          
-  
-    
-      capabilityId: string,
-    
-  
-    
-      listener: {
-  
-    
-      value: number | boolean | string,
-    
-  
-},
-    
-  
-
-        
-      ):
-        HomeyAPIV2.ManagerDevices.Device.DeviceCapability;
-    
-      setCapabilityValue(
-        
-          
-  
-    
-      opts: {
-  
-    
-      capabilityId: string,
-    
-  
-    
-      value: number | boolean | string,
-    
-  
-    
-      opts: {
-  
-    
-      duration: number,
-    
-  
-},
-    
-  
-},
-    
-  
-
-        
-      ):
-        Promise<void>;
-    
   }
 
     }
@@ -7670,6 +7614,22 @@
 
   
 
+  
+
+  
+
+  
+    export namespace HomeyAPIV3Local.ManagerAlarms {
+      
+  export class Alarm  {
+    
+
+    
+
+    
+  }
+
+    }
   
 
   
@@ -16234,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(
         
       ):
@@ -17577,7 +17681,7 @@
     
   
     
-      data: object,
+      data: *,
     
   
 },
@@ -17604,7 +17708,7 @@
     
   
     
-      data: object,
+      data: *,
     
   
 },
@@ -18512,6 +18616,44 @@
       ):
         Promise<HomeyAPIV3Local.ManagerFlowToken.FlowToken>;
     
+      getFlowToken(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerFlowToken.FlowToken>;
+    
+      getFlowTokenValue(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
       isConnected(
         
       ):
@@ -19829,6 +19971,25 @@
     
       rebootOTA(
         
+      ):
+        Promise<any>;
+    
+      setDebug(
+        
+          
+  
+    
+      opts: {
+  
+    
+      namespace: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -20439,6 +20600,25 @@
     
       getZones(
         
+      ):
+        Promise<HomeyAPIV3Local.ManagerZones.Zone>;
+    
+      getZone(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<HomeyAPIV3Local.ManagerZones.Zone>;
     
@@ -20584,6 +20764,30 @@
     
       flashFirmware(
         
+      ):
+        Promise<any>;
+    
+      getLog(
+        
+      ):
+        Promise<any>;
+    
+      setLogEnabled(
+        
+          
+  
+    
+      opts: {
+  
+    
+      enabled: boolean,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -20621,6 +20825,10 @@
 
   
 
+  
+
+  
+
   
 
   

package/lib/HomeyAPI/HomeyAPI.js

@@ -129,22 +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 (homey.platform !== 'local') {
-      throw new Error(`Invalid Homey Platform: ${homey.platform}`);
+    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: [],
@@ -154,16 +154,21 @@ class HomeyAPI {
       },
     };
 
-    if (homey.platformVersion === 1) {
+    if (homey.platform === 'local' && homey.platformVersion === 1) {
       const HomeyAPIV2 = require('./HomeyAPIV2');
       return new HomeyAPIV2(props);
     }
 
-    if (homey.platformVersion === 2) {
+    if (homey.platform === 'local' && homey.platformVersion === 2) {
       const HomeyAPIV3Local = require('./HomeyAPIV3Local');
       return new HomeyAPIV3Local(props);
     }
 
+    if (homey.platform === 'cloud' && homey.platformVersion === 2) {
+      const HomeyAPIV3Cloud = require('./HomeyAPIV3Cloud');
+      return new HomeyAPIV3Cloud(props);
+    }
+
     throw new Error(`Invalid Homey Platform Version: ${homey.platformVersion}`);
   }
 

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

@@ -12,20 +12,6 @@ class ManagerDevices extends Manager {
     Device,
   }
 
-  async getCapability({
-    $cache = true,
-    id,
-  }) {
-    if ($cache === true && this.__cache['capability'][id]) {
-      return this.__cache['capability'][id];
-    }
-
-    return this.__super__getCapability({
-      id: id.split(':').reverse()[0],
-      uri: id.split(':', 3).join(':'),
-    });
-  }
-
 }
 
 module.exports = ManagerDevices;

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

@@ -0,0 +1,20 @@
+'use strict';
+
+const PairSessionV3 = require('../../HomeyAPIV3/ManagerDrivers/PairSession');
+
+class PairSession extends PairSessionV3 {
+
+  static transformGet(item) {
+    item = super.transformGet(item);
+
+    item.driverId = `${item.driverUri}:${item.driverId}`;
+    item.ownerUri = item.driverUri;
+
+    delete item.driverUri;
+
+    return item;
+  }
+
+}
+
+module.exports = PairSession;

package/lib/HomeyAPI/HomeyAPIV2/ManagerDrivers.js

@@ -2,12 +2,14 @@
 
 const ManagerDriversV3 = require('../HomeyAPIV3/ManagerDrivers');
 const Driver = require('./ManagerDrivers/Driver');
+const PairSession = require('./ManagerDrivers/PairSession');
 
 class ManagerDrivers extends ManagerDriversV3 {
 
   static CRUD = {
     ...super.CRUD,
     Driver,
+    PairSession,
   }
 
   async getDriver({
@@ -24,6 +26,21 @@ class ManagerDrivers extends ManagerDriversV3 {
     });
   }
 
+  async createPairSession({
+    pairsession,
+    ...props
+  }) {
+    if (pairsession.driverId) {
+      pairsession.driverUri = pairsession.driverId.split(':', 3).join(':');
+      pairsession.driverId = pairsession.driverId.split(':').reverse()[0];
+    }
+
+    return this.__super__createPairSession({
+      pairsession,
+      ...props,
+    });
+  }
+
 }
 
 module.exports = ManagerDrivers;

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

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

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,6 +29,29 @@ class Flow extends FlowV3 {
     return 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];
+    }
+
+    if (Array.isArray(item.conditions)) {
+      item.conditions.forEach(card => {
+        card.uri = card.id.split(':', 3).join(':');
+        card.id = card.id.split(':').reverse()[0];
+      });
+    }
+
+    if (Array.isArray(item.actions)) {
+      item.actions.forEach(card => {
+        card.uri = card.id.split(':', 3).join(':');
+        card.id = card.id.split(':').reverse()[0];
+      });
+    }
+
+    return item;
+  }
+
 }
 
 module.exports = Flow;

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;