homey-api 3.0.0-rc.13 → 3.0.0-rc.15

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

@@ -287,6 +287,33 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      createLocalAPI(
+        
+          
+  
+    
+      opts: {
+  
+    
+      address: String,
+    
+  
+    
+      token: String,
+    
+  
+    
+      debug: function | null,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     

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

@@ -5402,6 +5402,33 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      createLocalAPI(
+        
+          
+  
+    
+      opts: {
+  
+    
+      address: String,
+    
+  
+    
+      token: String,
+    
+  
+    
+      debug: function | null,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     

package/index.js

@@ -2,23 +2,22 @@
 
 'use strict';
 
-module.exports = {
-  AthomAppsAPI: require('./lib/AthomAppsAPI'),
-  AthomBackupAPI: require('./lib/AthomBackupAPI'),
-  AthomCallbackAPI: require('./lib/AthomCallbackAPI'),
-  AthomCloudAPI: require('./lib/AthomCloudAPI'),
-  AthomConnectAPI: require('./lib/AthomConnectAPI'),
-  AthomDNSAPI: require('./lib/AthomDNSAPI'),
-  AthomFirmwareAPI: require('./lib/AthomFirmwareAPI'),
-  AthomFlowAPI: require('./lib/AthomFlowAPI'),
-  AthomGeolocateAPI: require('./lib/AthomGeolocateAPI'),
-  AthomIconsAPI: require('./lib/AthomIconsAPI'),
-  AthomInfraredAPI: require('./lib/AthomInfraredAPI'),
-  AthomNotificationsAPI: require('./lib/AthomNotificationsAPI'),
-  AthomSetupAPI: require('./lib/AthomSetupAPI'),
-  AthomStoreAPI: require('./lib/AthomStoreAPI'),
-  AthomWeatherAPI: require('./lib/AthomWeatherAPI'),
-  AthomWebhooksAPI: require('./lib/AthomWebhooksAPI'),
-  HomeyCloudAPI: require('./lib/HomeyCloudAPI'),
-  HomeyAPI: require('./lib/HomeyAPI/HomeyAPI'),
-};
+module.exports = {};
+module.exports.AthomAppsAPI = require('./lib/AthomAppsAPI');
+module.exports.AthomBackupAPI = require('./lib/AthomBackupAPI');
+module.exports.AthomCallbackAPI = require('./lib/AthomCallbackAPI');
+module.exports.AthomCloudAPI = require('./lib/AthomCloudAPI');
+module.exports.AthomConnectAPI = require('./lib/AthomConnectAPI');
+module.exports.AthomDNSAPI = require('./lib/AthomDNSAPI');
+module.exports.AthomFirmwareAPI = require('./lib/AthomFirmwareAPI');
+module.exports.AthomFlowAPI = require('./lib/AthomFlowAPI');
+module.exports.AthomGeolocateAPI = require('./lib/AthomGeolocateAPI');
+module.exports.AthomIconsAPI = require('./lib/AthomIconsAPI');
+module.exports.AthomInfraredAPI = require('./lib/AthomInfraredAPI');
+module.exports.AthomNotificationsAPI = require('./lib/AthomNotificationsAPI');
+module.exports.AthomSetupAPI = require('./lib/AthomSetupAPI');
+module.exports.AthomStoreAPI = require('./lib/AthomStoreAPI');
+module.exports.AthomWeatherAPI = require('./lib/AthomWeatherAPI');
+module.exports.AthomWebhooksAPI = require('./lib/AthomWebhooksAPI');
+module.exports.HomeyCloudAPI = require('./lib/HomeyCloudAPI');
+module.exports.HomeyAPI = require('./lib/HomeyAPI/HomeyAPI');

package/lib/HomeyAPI/HomeyAPI.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const Util = require('../Util');
+
 /**
  * A Homey API, to be extended.
  * @hideconstructor
@@ -126,10 +128,10 @@ class HomeyAPI {
   }
 
   /**
-   * Create a {@link HomeyAPIV3Local} instance for use in the Apps SDK.
+   * Creates a {@link HomeyAPIV3Local} or {@link HomeyAPIV2} instance for use in the Apps SDK.
    * @param {Object} opts
-   * @param {Homey} opts.homey — Homey instance
-   * @param {Function|null} opts.debug — Debug function, defaults to `null`
+   * @param {Homey} opts.homey — Homey (Apps SDK) instance.
+   * @param {Function|null} opts.debug — Debug function, defaults to `null`.
    */
   static async createAppAPI({
     homey,
@@ -172,6 +174,53 @@ class HomeyAPI {
     throw new Error(`Invalid Homey Platform Version: ${homey.platformVersion}`);
   }
 
+  /**
+   * Creates a {@link HomeyAPIV3Local} instance for use in a project.
+   * @param {Object} opts
+   * @param {String} opts.address — The address of the Homey, e.g. `http://192.168.1.123:80`.
+   * @param {String} opts.token — A Personal Access Token created in the Homey Web App.
+   * @param {Function|null} opts.debug — Debug function, defaults to `null`.
+   * @example
+   * import { HomeyAPI } from 'homey-api';
+   * const homeyApi = await HomeyAPI.createLocalAPI({
+   *   address: 'http://192.169.1.123',
+   *   token: '<my_personal_access_token>',
+   * });
+   * const devices = await homeyApi.devices.getDevices();
+   */
+  static async createLocalAPI({
+    address,
+    token,
+    debug = null,
+  }) {
+    if (!address) {
+      throw new Error('Invalid Address');
+    }
+
+    if (!token) {
+      throw new Error('Invalid Token');
+    }
+
+    const res = await Util.fetch(`${address}/api/manager/system/ping`);
+    if (!res.headers.has('X-Homey-ID')) {
+      throw new Error(`No Homey Found At Address: ${address}`);
+    }
+
+    const props = {
+      token,
+      debug: debug ?? function debug() { },
+      baseUrl: address,
+      strategy: [],
+      properties: {
+        id: res.headers.get('X-Homey-ID'),
+        softwareVersion: res.headers.get('X-Homey-Version'),
+      },
+    };
+
+    const HomeyAPIV3Local = require('./HomeyAPIV3Local');
+    return new HomeyAPIV3Local(props);
+  }
+
 }
 
 module.exports = HomeyAPI;

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

@@ -1,6 +1,6 @@
 'use strict';
 
-const AdvancedFlowV3 = require('../../HomeyAPIV3/ManagerFlow/Flow');
+const AdvancedFlowV3 = require('../../HomeyAPIV3/ManagerFlow/AdvancedFlow');
 
 class AdvancedFlow extends AdvancedFlowV3 {
 
@@ -11,6 +11,8 @@ class AdvancedFlow extends AdvancedFlowV3 {
       }
     }
 
+    delete item.broken;
+
     return item;
   }
 

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

@@ -1,9 +1,128 @@
+/* eslint-disable no-unused-vars */
+
 'use strict';
 
 const Item = require('../Item');
 
 class AdvancedFlow extends Item {
 
+  async isBroken() {
+    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 if FlowCards exist, and add Tokens
+    for (const [cardId, card] of Object.entries(this.cards)) {
+      switch (card.type) {
+        case 'trigger': {
+          try {
+            await managerFlow.getFlowCardTriggers(); // Fill the cache
+            const triggerCard = await this.manager.getFlowCardTrigger({ id: card.id });
+
+            // Add FlowCardTrigger.tokens to internal tokens cache
+            if (Array.isArray(triggerCard.tokens)) {
+              for (const token of Object.values(triggerCard.tokens)) {
+                tokenIds.push(`trigger::${cardId}::${token.id}`);
+              }
+            }
+
+            break;
+          } catch (err) {
+            this.__debug(err);
+            return true;
+          }
+        }
+        case 'condition': {
+          try {
+            await managerFlow.getFlowCardConditions(); // Fill the cache
+            const conditionCard = await this.manager.getFlowCardCondition({ id: card.id });
+
+            // Add Error Token
+            tokenIds.push(`card::${cardId}::error`);
+
+            break;
+          } catch (err) {
+            this.__debug(err);
+            return true;
+          }
+        }
+        case 'action': {
+          try {
+            await managerFlow.getFlowCardActions(); // Fill the cache
+            const actionCard = await this.manager.getFlowCardAction({ id: card.id });
+
+            // Add Error Token
+            tokenIds.push(`card::${cardId}::error`);
+
+            // Add FlowCardAction.tokens to internal tokens cache
+            if (Array.isArray(actionCard.tokens)) {
+              for (const token of Object.values(actionCard.tokens)) {
+                tokenIds.push(`action::${cardId}::${token.id}`);
+              }
+            }
+
+            break;
+          } catch (err) {
+            this.__debug(err);
+            return true;
+          }
+        }
+        default: {
+          // Do nothing
+        }
+      }
+    }
+
+    // Check Tokens
+    for (const card of Object.values(this.cards)) {
+      await checkTokens(card);
+    }
+
+    return false;
+  }
+
 }
 
 module.exports = AdvancedFlow;

package/package.json

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