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

package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow.js

@@ -18,22 +18,45 @@ class ManagerFlow extends Manager {
     FlowCardAction,
   }
 
-  // TODO: Transform card IDs
-  // async createFlow() {
-
-  // }
-
-  // async updateFlow() {
-
-  // }
-
-  // async createAdvancedFlow() {
+  async createFlow({
+    flow,
+    ...props
+  }) {
+    return this.__super__.createFlow({
+      flow: Flow.transformSet(flow),
+      ...props,
+    });
+  }
 
-  // }
+  async updateFlow({
+    flow,
+    ...props
+  }) {
+    return this.__super__.updateFlow({
+      flow: Flow.transformSet(flow),
+      ...props,
+    });
+  }
 
-  // async updateAdvancedFlow() {
+  async createAdvancedFlow({
+    advancedflow,
+    ...props
+  }) {
+    return this.__super__.createAdvancedFlow({
+      advancedflow: AdvancedFlow.transformSet(advancedflow),
+      ...props,
+    });
+  }
 
-  // }
+  async updateAdvancedFlow({
+    advancedflow,
+    ...props
+  }) {
+    return this.__super__.updateAdvancedFlow({
+      advancedflow: AdvancedFlow.transformSet(advancedflow),
+      ...props,
+    });
+  }
 
   async getFlowCardTrigger({
     $cache = true,

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/HomeyAPIV2/ManagerInsights.js

@@ -24,6 +24,23 @@ class ManagerInsights extends ManagerInsightsV3 {
     });
   }
 
+  async getLogEntries({ id }) {
+    return this.__super__getLogEntries({
+      id: id.split(':').reverse()[0],
+      uri: id.split(':', 3).join(':'),
+    });
+  }
+
+  async deleteLogEntries({ id }) {
+    return this.__super__deleteLogEntries({
+      id: id.split(':').reverse()[0],
+      uri: id.split(':', 3).join(':'),
+    });
+  }
+
+  // deleteLog
+  // updateLog
+
 }
 
 module.exports = ManagerInsights;

package/lib/HomeyAPI/HomeyAPIV3/Item.js

@@ -64,8 +64,17 @@ class Item extends EventEmitter {
 
   __update(properties) {
     for (const [key, value] of Object.entries(properties)) {
+      if (key === 'id') continue;
+
       this[key] = value;
     }
+
+    this.emit('update', properties);
+  }
+
+  __delete() {
+    this.destroy();
+    this.emit('delete');
   }
 
   async connect() {
@@ -171,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,9 +258,8 @@ class Manager extends EventEmitter {
               switch (operation.crud.type) {
                 case 'getOne': {
                   let item = { ...result };
-                  item = Item.transform(item);
+                  item = Item.transformGet(item);
                   item = new Item({
-                    itemId,
                     id: item.id,
                     homey: this.homey,
                     manager: this,
@@ -278,13 +277,13 @@ class Manager extends EventEmitter {
 
                   // Add all to cache
                   for (let item of Object.values(result)) {
-                    item = Item.transform(item);
-                    if (this.__cache[itemId][item.id]) {
-                      this.__cache[itemId][item.id].__update(item);
+                    item = Item.transformGet(item);
+
+                    if (this.isConnected() && this.__cache[itemId][item.id]) {
                       items[item.id] = this.__cache[itemId][item.id];
+                      items[item.id].__update(item);
                     } else {
                       items[item.id] = new Item({
-                        itemId,
                         id: item.id,
                         homey: this.homey,
                         manager: this,
@@ -316,13 +315,14 @@ class Manager extends EventEmitter {
                 case 'createOne':
                 case 'updateOne': {
                   let item = { ...result };
-                  item = Item.transform(item);
-                  if (this.__cache[itemId][item.id]) {
-                    item = this.__cache[itemId][item.id].__update(item);
+                  item = Item.transformGet(item);
+
+                  if (this.isConnected() && 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({
-                      itemId,
                       id: item.id,
                       homey: this.homey,
                       manager: this,
@@ -337,7 +337,7 @@ class Manager extends EventEmitter {
                   return item;
                 }
                 case 'deleteOne': {
-                  if (this.__cache[itemId][args.id]) {
+                  if (this.isConnected() && this.__cache[itemId][args.id]) {
                     this.__cache[itemId][args.id].destroy();
                     delete this.__cache[itemId][args.id];
                   }
@@ -413,55 +413,38 @@ class Manager extends EventEmitter {
 
               switch (operation) {
                 case 'create': {
-                  let item = { ...data };
-                  item = Item.transform(item);
-                  item = new Item({
-                    itemId,
-                    id: item.id,
+                  data = Item.transformGet(data);
+
+                  const item = new Item({
+                    id: data.id,
                     homey: this.homey,
                     manager: this,
-                    properties: { ...item },
+                    properties: { ...data },
                   });
+                  this.__cache[itemId][data.id] = item;
 
-                  this.__cache[itemId][item.id] = item;
-                  this.__cache[itemId][item.id].emit('create');
-
-                  return this.emit(`${itemId}.create`, item);
+                  break;
                 }
                 case 'update': {
-                  let item = { ...data };
-                  item = Item.transform(item);
+                  data = Item.transformGet(data);
 
-                  if (this.__cache[itemId][item.id]) {
-                    item = this.__cache[itemId][item.id];
-                    item.__update(item);
-                    item.emit('update');
-                  } else {
-                    item = new Item({
-                      itemId,
-                      id: item.id,
-                      homey: this.homey,
-                      manager: this,
-                      properties: { ...item },
-                    });
-                    this.__cache[itemId][item.id] = item;
+                  if (this.__cache[itemId][data.id]) {
+                    const item = this.__cache[itemId][data.id];
+                    item.__update(data);
                   }
 
-                  return this.emit(`${itemId}.update`, item);
+                  break;
                 }
                 case 'delete': {
-                  let item = Item.transform({ ...data });
-                  item = Item.transform(item);
+                  data = Item.transformGet(data);
 
-                  if (this.__cache[itemId][item.id]) {
-                    this.__cache[itemId][item.id].emit('delete');
-                    this.__cache[itemId][item.id].destroy();
+                  if (this.__cache[itemId][data.id]) {
+                    const item = this.__cache[itemId][data.id];
+                    item.__delete();
                     delete this.__cache[itemId][item.id];
                   }
 
-                  return this.emit(`${itemId}.delete`, {
-                    id: item.id,
-                  });
+                  break;
                 }
                 default:
                   break;

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

@@ -17,17 +17,13 @@ class Device extends Item {
     });
   }
 
-  get uri() {
-    return `homey:device:${this.id}`;
-  }
-
   /**
-   * 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 => {
@@ -76,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
@@ -199,10 +195,14 @@ class Device extends Item {
       }), {});
   }
 
-  static transform(item) {
-    for (const capabilityObj of Object.values(item.capabilitiesObj)) {
-      if (capabilityObj.lastUpdated) {
-        capabilityObj.lastUpdated = new Date(capabilityObj.lastUpdated);
+  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);
+        }
       }
     }
 

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

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

@@ -2,12 +2,14 @@
 
 const Manager = require('./Manager');
 const Driver = require('./ManagerDrivers/Driver');
+const PairSession = require('./ManagerDrivers/PairSession');
 
 class ManagerDrivers extends Manager {
 
   static CRUD = {
     ...super.CRUD,
     Driver,
+    PairSession,
   }
 
 }

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

@@ -4,6 +4,14 @@ 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

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

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

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

@@ -4,6 +4,20 @@ 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/package.json

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