homey-api 3.0.0-rc.9 → 3.0.1

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

@@ -1,3 +1,5 @@
+/* eslint-disable no-unused-vars */
+
 'use strict';
 
 const Item = require('../Item');
@@ -9,7 +11,100 @@ class Flow extends Item {
    * @returns Promise<Boolean>
    */
   async isBroken() {
-    throw new Error('Not Implemented');
+    const managerFlow = this.homey.flow;
+    if (!managerFlow.isConnected()) {
+      throw new Error('Flow.isBroken requires ManagerFlow to be connected.');
+    }
+
+    const managerFlowToken = this.homey.flowtoken;
+    if (!managerFlowToken.isConnected()) {
+      throw new Error('Flow.isBroken requires ManagerFlowToken to be connected.');
+    }
+
+    // Array of local & global Token IDs.
+    // For example [ 'foo', 'homey:x:y|abc' ]
+    const tokenIds = [];
+
+    const checkToken = async tokenId => {
+      // If this is a global Token, fetch all FlowTokens
+      if (tokenId.includes('|')) {
+        const flowTokens = await managerFlowToken.getFlowTokens(); // Fill the cache
+        for (const flowTokenId of Object.keys(flowTokens)) {
+          tokenIds.push(flowTokenId);
+        }
+
+        tokenId = tokenId.replace('|', ':');
+      }
+
+      if (!tokenIds.includes(tokenId)) {
+        throw new Error(`Missing Token: ${tokenId}`);
+      }
+    };
+
+    const checkTokens = async card => {
+      // Check droptoken
+      if (card.droptoken) {
+        await checkToken(card.droptoken);
+      }
+
+      if (typeof card.args === 'object') {
+        for (const arg of Object.values(card.args)) {
+          if (typeof arg !== 'string') continue;
+          for (const [tokenMatch, tokenId] of arg.matchAll(/\[\[(.*?)\]\]/g)) {
+            await checkToken(tokenId);
+          }
+        }
+      }
+    };
+
+    // Check Trigger
+    if (this.trigger) {
+      try {
+        await managerFlow.getFlowCardTriggers(); // Fill the cache
+        const triggerCard = await this.manager.getFlowCardTrigger({ id: this.trigger.id });
+        await checkTokens(this.trigger);
+
+        // Add FlowCardTrigger.tokens to internal tokens cache
+        if (Array.isArray(triggerCard.tokens)) {
+          for (const tokenId of Object.keys(triggerCard.tokens)) {
+            tokenIds.push(tokenId);
+          }
+        }
+      } catch (err) {
+        this.__debug(err.message);
+        return true;
+      }
+    }
+
+    // Check Conditions
+    if (Array.isArray(this.conditions)) {
+      for (const condition of Object.values(this.conditions)) {
+        try {
+          await managerFlow.getFlowCardConditions(); // Fill the cache
+          const conditionCard = await this.manager.getFlowCardCondition({ id: condition.id });
+          await checkTokens(condition);
+        } catch (err) {
+          this.__debug(err.message);
+          return true;
+        }
+      }
+    }
+
+    // Check Actions
+    if (Array.isArray(this.actions)) {
+      for (const action of Object.values(this.actions)) {
+        try {
+          await managerFlow.getFlowCardActions(); // Fill the cache
+          const actionCard = await this.manager.getFlowCardAction({ id: action.id });
+          await checkTokens(action);
+        } catch (err) {
+          this.__debug(err.message);
+          return true;
+        }
+      }
+    }
+
+    return false;
   }
 
 }

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

@@ -4,14 +4,19 @@ 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;
+    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.js

@@ -16,6 +16,7 @@ const ManagerInsights = require('./HomeyAPIV3/ManagerInsights');
 const Manager = require('./HomeyAPIV3/Manager');
 
 /**
+ * An authenticated Homey API. Do not construct this class manually.
  * @class
  * @hideconstructor
  * @extends HomeyAPIV2
@@ -378,32 +379,32 @@ class HomeyAPIV3 extends HomeyAPI {
     headers,
     path,
     body,
+    json = true,
     retryAfterRefresh = false,
   }) {
     const baseUrl = await this.baseUrl;
 
-    method = method.toUpperCase();
+    method = String(method).toUpperCase();
 
     headers = {
       ...headers,
       'X-Homey-ID': this.id,
     };
 
-    if (body) {
-      headers['Content-Type'] = 'application/json';
-    }
-
     if (this.__token) {
       headers['Authorization'] = `Bearer ${this.__token}`;
     }
 
+    if (body && json === true && ['PUT', 'POST'].includes(method)) {
+      headers['Content-Type'] = 'application/json';
+      body = JSON.stringify(body);
+    }
+
     this.__debug(method, `${baseUrl}${path}`);
     const res = await Util.timeout(Util.fetch(`${baseUrl}${path}`, {
       method,
       headers,
-      body: ['PUT', 'POST'].includes(method) && typeof body !== 'undefined'
-        ? JSON.stringify(body)
-        : undefined,
+      body,
     }), $timeout);
 
     const resStatusCode = res.status;
@@ -477,16 +478,20 @@ class HomeyAPIV3 extends HomeyAPI {
 
         // Create a Session by generating a JWT token on AthomCloudAPI,
         // and then sending the JWT token to Homey.
-        this.__debug('Retrieving token...');
-        const jwtToken = await this.__api.createDelegationToken({ audience: 'homey' });
-        const token = await this.users.login({
-          $socket: false,
-          token: jwtToken,
-        });
-        await this.__setStore({ token });
-        this.__debug('Got token');
+        if (this.__api) {
+          this.__debug('Retrieving token...');
+          const jwtToken = await this.__api.createDelegationToken({ audience: 'homey' });
+          const token = await this.users.login({
+            $socket: false,
+            token: jwtToken,
+          });
+          await this.__setStore({ token });
+          this.__debug('Got token');
+
+          return token;
+        }
 
-        return token;
+        throw new Error('Cannot Sign In: Missing AthomCloudAPI');
       });
 
       this.__loginPromise

package/lib/HomeyAPI/HomeyAPIV3Cloud.js

@@ -33,6 +33,14 @@ class HomeyAPIV3Cloud extends HomeyAPIV3 {
     });
   }
 
+  get platform() {
+    return 'cloud';
+  }
+
+  get platformVersion() {
+    return 1;
+  }
+
   getSpecification() {
     // eslint-disable-next-line global-require
     return require('../../assets/specifications/HomeyAPIV3Cloud.json');

package/lib/HomeyAPI/HomeyAPIV3Local/ManagerDevkit.js

@@ -0,0 +1,32 @@
+'use strict';
+
+const FormData = require('form-data');
+
+const Manager = require('./Manager');
+
+class ManagerDevkit extends Manager {
+
+  async runApp({
+    app, // Readable
+    env = {},
+    debug = false,
+    clean = false,
+  }) {
+    const form = new FormData();
+    form.append('app', app);
+    form.append('env', JSON.stringify(env));
+    form.append('debug', debug ? 'true' : 'false');
+    form.append('purgeSettings', clean ? 'true' : 'false');
+
+    return this.homey.call({
+      $timeout: 1000 * 60 * 5, // 5 minutes
+      method: 'POST',
+      path: '/api/manager/devkit/',
+      body: form,
+      json: false,
+    });
+  }
+
+}
+
+module.exports = ManagerDevkit;

package/lib/HomeyAPI/HomeyAPIV3Local.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const HomeyAPIV3 = require('./HomeyAPIV3');
+const ManagerDevkit = require('./HomeyAPIV3Local/ManagerDevkit');
 
 /**
  * This class is returned by {@link AthomCloudAPI.Homey#authenticate} for a Homey with `platform: 'local'` and `platformVersion: 1`.
@@ -11,6 +12,19 @@ const HomeyAPIV3 = require('./HomeyAPIV3');
  */
 class HomeyAPIV3Local extends HomeyAPIV3 {
 
+  static MANAGERS = {
+    ...HomeyAPIV3.MANAGERS,
+    ManagerDevkit,
+  };
+
+  get platform() {
+    return 'local';
+  }
+
+  get platformVersion() {
+    return 2;
+  }
+
   getSpecification() {
     // eslint-disable-next-line global-require
     return require('../../assets/specifications/HomeyAPIV3Local.json');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.0.0-rc.9",
+  "version": "3.0.1",
   "description": "Homey API",
   "main": "index.js",
   "files": [
@@ -23,8 +23,8 @@
     "build:jsdoc": "npm run jsdoc",
     "webpack": "webpack",
     "webpack:watch": "webpack --watch",
-    "jsdoc": "npm run jsdoc:clean; npm run generate-specs; npm run generate-jsdoc; jsdoc --configure ./jsdoc.json --recurse; jsdoc --configure ./jsdoc.json --recurse --private --destination ./jsdoc/private; rm ./jsdoc/*.js.html;",
-    "jsdoc:clean": "rm -rf ./build/jsdoc; rm -rf ./build/jsdoc-tmp",
+    "jsdoc": "npm run jsdoc:clean; cp -r ./lib/ ./build/jsdoc-tmp; npm run generate-specs; npm run generate-jsdoc; jsdoc --configure ./jsdoc.json --recurse; jsdoc --configure ./jsdoc.json --recurse --private --destination ./jsdoc/private; rm ./jsdoc/*.js.html;",
+    "jsdoc:clean": "rm -rf ./build/jsdoc/; rm -rf ./build/jsdoc-tmp/",
     "jsdoc:watch": "watch \"npm run jsdoc:clean; npm run generate-jsdoc; npm run jsdoc;\" lib \"node_modules/@athombv/jsdoc-template\" --interval 0.5",
     "jsdoc:serve": "http-server ./jsdoc/",
     "generate-specs": "node tools/generate-specs.js",
@@ -46,6 +46,7 @@
   },
   "dependencies": {
     "core-js": "^3.19.1",
+    "form-data": "^4.0.0",
     "node-fetch": "^2.6.7",
     "regenerator-runtime": "^0.13.9",
     "socket.io-client": "^2.5.0"