homey-api 1.10.20 → 3.0.0-rc.10

package/lib/HomeyAPI/{HomeyAPIV2 → HomeyAPIV3/ManagerApps}/App.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const Item = require('./Item');
+const Item = require('../Item');
 
 class App extends Item {
 

package/lib/HomeyAPI/{HomeyAPIV2 → HomeyAPIV3}/ManagerApps.js

@@ -1,12 +1,13 @@
 'use strict';
 
 const Manager = require('./Manager');
-const App = require('./App');
+const App = require('./ManagerApps/App');
 
 class ManagerApps extends Manager {
 
-  static ITEMS = {
-    app: App,
+  static CRUD = {
+    ...super.CRUD,
+    App,
   }
 
 }

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

@@ -0,0 +1,9 @@
+'use strict';
+
+const Item = require('../Item');
+
+class Capability extends Item {
+
+}
+
+module.exports = Capability;

package/lib/HomeyAPI/{HomeyAPIV2 → HomeyAPIV3/ManagerDevices}/Device.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const Util = require('../../Util');
-const Item = require('./Item');
+const Util = require('../../../Util');
+const Item = require('../Item');
 const DeviceCapability = require('./DeviceCapability');
 
 class Device extends Item {
@@ -18,12 +18,12 @@ class Device extends Item {
   }
 
   /**
-   * Creates an {@link HomeyAPIV2.DeviceCapability} for realtime capability updates.
+   * Creates an {@link HomeyAPIV3.DeviceCapability} for realtime capability updates.
    * @param {string} capabilityId
    * @param {Function} listener
    * @param {number|boolean|string} listener.value
-   * @returns {HomeyAPIV2.ManagerDevices.Device.DeviceCapability}
-   * @function HomeyAPIV2.ManagerDevices.Device#makeCapabilityInstance
+   * @returns {HomeyAPIV3.ManagerDevices.Device.DeviceCapability}
+   * @function HomeyAPIV3.ManagerDevices.Device#makeCapabilityInstance
    * @example
    *
    *  const onOffInstance = device.makeCapabilityInstance('onoff', value => {
@@ -72,7 +72,7 @@ class Device extends Item {
    * @param {object} [opts.opts]
    * @param {number} [opts.opts.duration]
    * @returns {Promise<void>}
-   * @function HomeyAPIV2.ManagerDevices.Device#setCapabilityValue
+   * @function HomeyAPIV3.ManagerDevices.Device#setCapabilityValue
    */
   async setCapabilityValue(options, ...args) {
     // Legacy compatibility from node-athom-api
@@ -130,10 +130,85 @@ class Device extends Item {
         });
       })
         // eslint-disable-next-line no-console
-        .catch(err => console.error(`Device[${this.id}].onReconnectError:`, err));
+        .catch(err => this.__debug(`Device[${this.id}].onReconnectError:`, err));
     }
   }
 
+  async getZone() {
+    return this.homey.zones.getZone({
+      id: this.zone,
+    });
+  }
+
+  async getDriver() {
+    return this.homey.drivers.getDriver({
+      id: this.driverId,
+    });
+  }
+
+  async getLogs() {
+    const logs = await this.homey.insights.getLogs();
+    return Object.values(logs)
+      .filter(log => log.ownerUri === this.uri)
+      .reduce((result, log) => ({
+        ...result,
+        [log.id]: log,
+      }), {});
+  }
+
+  async getFlows() {
+    const flows = await this.homey.flow.getFlows();
+    return Object.values(flows)
+      .filter(flow => {
+        if (flow.trigger && flow.trigger.id.startsWith(this.uri)) return true;
+        if (Array.isArray(flow.conditions) && flow.conditions.some(card => card.id.startsWith(this.uri))) return true;
+        if (Array.isArray(flow.actions) && flow.actions.some(card => card.id.startsWith(this.uri))) return true;
+
+        // TODO: Zone cards
+        // TODO: Subzone cards
+
+        return false;
+      })
+      .reduce((result, flow) => ({
+        ...result,
+        [flow.id]: flow,
+      }), {});
+  }
+
+  async getAdvancedFlows() {
+    const advancedFlows = await this.homey.flow.getAdvancedFlows();
+    return Object.values(advancedFlows)
+      .filter(advancedFlow => {
+        return Object.values(advancedFlow.cards)
+          .filter(card => ['trigger', 'condition', 'action'].includes(card.type))
+          .some(card => {
+            if (card.id.startsWith(this.uri)) return true;
+
+            // TODO: Zone cards
+            // TODO: Subzone cards
+            return false;
+          });
+      })
+      .reduce((result, advancedFlow) => ({
+        ...result,
+        [advancedFlow.id]: advancedFlow,
+      }), {});
+  }
+
+  static transformGet(item) {
+    item = super.transformGet(item);
+
+    if (item.capabilitiesObj) {
+      for (const capabilityObj of Object.values(item.capabilitiesObj)) {
+        if (capabilityObj.lastUpdated) {
+          capabilityObj.lastUpdated = new Date(capabilityObj.lastUpdated);
+        }
+      }
+    }
+
+    return item;
+  }
+
 }
 
 module.exports = Device;

package/lib/HomeyAPI/{HomeyAPIV2 → HomeyAPIV3/ManagerDevices}/DeviceCapability.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const Util = require('../../Util');
-const EventEmitter = require('../../EventEmitter');
+const Util = require('../../../Util');
+const EventEmitter = require('../../../EventEmitter');
 
 /**
  * @class
@@ -75,7 +75,7 @@ class DeviceCapability extends EventEmitter {
   }
 
   __debug(...props) {
-    this.device.__debug(`[Capability:${this.id}]`, ...props);
+    this.device.__debug(`[DeviceCapability:${this.id}]`, ...props);
   }
 
   /**
@@ -108,7 +108,7 @@ class DeviceCapability extends EventEmitter {
     const capabilityReference = this.device.capabilitiesObj && this.device.capabilitiesObj[this.id];
     if (capabilityReference) {
       capabilityReference.value = value;
-      capabilityReference.lastUpdated = this.__lastChanged.toISOString();
+      capabilityReference.lastUpdated = this.__lastChanged;
     }
 
     this.__listener(value);

package/lib/HomeyAPI/HomeyAPIV3/ManagerDevices.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const Manager = require('./Manager');
+const Capability = require('./ManagerDevices/Capability');
+const Device = require('./ManagerDevices/Device');
+
+class ManagerDevices extends Manager {
+
+  static CRUD = {
+    ...super.CRUD,
+    Capability,
+    Device,
+  }
+
+}
+
+module.exports = ManagerDevices;

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

@@ -0,0 +1,9 @@
+'use strict';
+
+const Item = require('../Item');
+
+class Driver extends Item {
+
+}
+
+module.exports = Driver;

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

@@ -0,0 +1,9 @@
+'use strict';
+
+const Item = require('../Item');
+
+class PairSession extends Item {
+
+}
+
+module.exports = PairSession;

package/lib/HomeyAPI/HomeyAPIV3/ManagerDrivers.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const Manager = require('./Manager');
+const Driver = require('./ManagerDrivers/Driver');
+const PairSession = require('./ManagerDrivers/PairSession');
+
+class ManagerDrivers extends Manager {
+
+  static CRUD = {
+    ...super.CRUD,
+    Driver,
+    PairSession,
+  }
+
+}
+
+module.exports = ManagerDrivers;

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

@@ -0,0 +1,9 @@
+'use strict';
+
+const Item = require('../Item');
+
+class AdvancedFlow extends Item {
+
+}
+
+module.exports = AdvancedFlow;

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

@@ -0,0 +1,17 @@
+'use strict';
+
+const Item = require('../Item');
+
+class Flow extends Item {
+
+  /**
+   * Check whether this Flow misses one or more {@link FlowCard} or {@link FlowToken}.
+   * @returns Promise<Boolean>
+   */
+  async isBroken() {
+    throw new Error('Not Implemented');
+  }
+
+}
+
+module.exports = Flow;

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

@@ -0,0 +1,17 @@
+'use strict';
+
+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/ManagerFlow/FlowCardAction.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const FlowCard = require('./FlowCard');
+
+class FlowCardAction extends FlowCard {
+
+}
+
+module.exports = FlowCardAction;

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

@@ -0,0 +1,9 @@
+'use strict';
+
+const FlowCard = require('./FlowCard');
+
+class FlowCardCondition extends FlowCard {
+
+}
+
+module.exports = FlowCardCondition;

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

@@ -0,0 +1,9 @@
+'use strict';
+
+const FlowCard = require('./FlowCard');
+
+class FlowCardTrigger extends FlowCard {
+
+}
+
+module.exports = FlowCardTrigger;

package/lib/HomeyAPI/HomeyAPIV3/ManagerFlow.js

@@ -1,32 +1,21 @@
 'use strict';
 
 const Manager = require('./Manager');
+const Flow = require('./ManagerFlow/Flow');
+const AdvancedFlow = require('./ManagerFlow/AdvancedFlow');
+const FlowCardTrigger = require('./ManagerFlow/FlowCardTrigger');
+const FlowCardCondition = require('./ManagerFlow/FlowCardCondition');
+const FlowCardAction = require('./ManagerFlow/FlowCardAction');
 
 class ManagerFlow extends Manager {
 
-  async getFlowCardTrigger(args = {}, ...rest) {
-    args.uri = '';
-    return this.__super__getFlowCardTrigger(args, ...rest);
-  }
-
-  async getFlowCardCondition(args = {}, ...rest) {
-    args.uri = '';
-    return this.__super__getFlowCardCondition(args, ...rest);
-  }
-
-  async runFlowCardCondition(args = {}, ...rest) {
-    args.uri = '';
-    return this.__super__runFlowCardCondition(args, ...rest);
-  }
-
-  async getFlowCardAction(args = {}, ...rest) {
-    args.uri = '';
-    return this.__super__getFlowCardAction(args, ...rest);
-  }
-
-  async runFlowCardAction(args = {}, ...rest) {
-    args.uri = '';
-    return this.__super__runFlowCardAction(args, ...rest);
+  static CRUD = {
+    ...super.CRUD,
+    Flow,
+    AdvancedFlow,
+    FlowCardTrigger,
+    FlowCardCondition,
+    FlowCardAction,
   }
 
 }

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

@@ -0,0 +1,19 @@
+'use strict';
+
+const Item = require('../Item');
+
+class FlowToken extends Item {
+
+  // TODO: Remove when back-end has removed these properties.
+  static transformGet(item) {
+    item = super.transformGet(item);
+
+    delete item.uri;
+    delete item.id;
+    delete item.uriObj;
+    delete item.ownerName; // Prepare for back-end change
+  }
+
+}
+
+module.exports = FlowToken;

package/lib/HomeyAPI/HomeyAPIV3/ManagerFlowToken.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const Manager = require('./Manager');
+const FlowToken = require('./ManagerFlowToken/FlowToken');
+
+class ManagerFlowToken extends Manager {
+
+  static CRUD = {
+    ...super.CRUD,
+    FlowToken,
+  };
+
+}
+
+module.exports = ManagerFlowToken;

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

@@ -0,0 +1,23 @@
+'use strict';
+
+const Item = require('../Item');
+
+class Log extends Item {
+
+  async getEntries() {
+    return this.manager.getLogEntries({
+      id: this.id,
+    });
+  }
+
+  static transformGet(item) {
+    item = super.transformGet(item);
+
+    delete item.ownerName; // Prepare for back-end change
+
+    return item;
+  }
+
+}
+
+module.exports = Log;

package/lib/HomeyAPI/HomeyAPIV3/ManagerInsights.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const Manager = require('./Manager');
+const Log = require('./ManagerInsights/Log');
+
+class ManagerInsights extends Manager {
+
+  static CRUD = {
+    ...super.CRUD,
+    Log,
+  };
+
+}
+
+module.exports = ManagerInsights;