homey-api 1.4.3 → 1.5.2

package/README.md

@@ -40,6 +40,10 @@ Include Homey API from our CDN:
 
 You can then access the APIs using `window.AthomCloudAPI` etc.
 
+### In-app
+
+To use Homey API inside of an Homey Pro app with the `homey:manager:api` permission, see {@link HomeyAPIApp}.
+
 ## Issues
 
 Please report any issues you find in the [Web API Issue Tracker](https://github.com/athombv/homey-web-api-issues/issues).

package/assets/specifications/AthomAppsAPI.json

@@ -82,6 +82,40 @@
         }
       }
     },
+    "browseApps": {
+      "path": "/app/browse",
+      "method": "get",
+      "parameters": {
+        "query": {
+          "in": "query",
+          "type": "string"
+        },
+        "language": {
+          "in": "query",
+          "type": "string"
+        },
+        "platform": {
+          "in": "query",
+          "type": "array"
+        },
+        "connectivity": {
+          "in": "query",
+          "type": "array"
+        },
+        "category": {
+          "in": "query",
+          "type": "array"
+        },
+        "limit": {
+          "in": "query",
+          "type": "number"
+        },
+        "offset": {
+          "in": "query",
+          "type": "number"
+        }
+      }
+    },
     "syncApps": {
       "path": "/app/sync",
       "method": "post",
@@ -108,6 +142,24 @@
         }
       }
     },
+    "getHighlightedAppsV2": {
+      "path": "/app/highlight2",
+      "method": "get",
+      "parameters": {
+        "platform": {
+          "in": "query",
+          "type": "array"
+        },
+        "language": {
+          "in": "query",
+          "type": "string"
+        },
+        "tags": {
+          "in": "query",
+          "type": "array"
+        }
+      }
+    },
     "getMyApps": {
       "path": "/app/me",
       "method": "get",
@@ -140,6 +192,17 @@
         }
       }
     },
+    "getAppChangelog": {
+      "path": "/app/{appId}/changelog",
+      "method": "get",
+      "parameters": {
+        "appId": {
+          "in": "path",
+          "type": "string",
+          "required": true
+        }
+      }
+    },
     "updateAppAuthor": {
       "path": "/app/{appId}/author",
       "method": "put",

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

@@ -185,6 +185,53 @@
     
 
     
+      __(
+        
+          
+  
+    
+      input: {
+  
+    
+      en: string,
+    
+  
+    
+      nl: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        string | null;
+    
+  }
+
+  export class HomeyAPIApp extends HomeyAPIV2 {
+    
+      constructor(
+        
+          
+  
+    
+      homey: Homey,
+    
+  
+    
+      debug: boolean,
+    
+  
+
+        
+      )
+    
+
+    
+
+    
       __(
         
           
@@ -603,6 +650,8 @@
 
   
 
+  
+
   
 
   

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

@@ -197,6 +197,49 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      browseApps(
+        
+          
+  
+    
+      opts: {
+  
+    
+      query: string,
+    
+  
+    
+      language: string,
+    
+  
+    
+      platform: Array<any>,
+    
+  
+    
+      connectivity: Array<any>,
+    
+  
+    
+      category: Array<any>,
+    
+  
+    
+      limit: number,
+    
+  
+    
+      offset: number,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -240,6 +283,33 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      getHighlightedAppsV2(
+        
+          
+  
+    
+      opts: {
+  
+    
+      platform: Array<any>,
+    
+  
+    
+      language: string,
+    
+  
+    
+      tags: Array<any>,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -277,6 +347,25 @@
           
   
     
+      opts: {
+  
+    
+      appId: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      getAppChangelog(
+        
+          
+  
+    
       opts: {
   
     
@@ -4905,6 +4994,53 @@
     
 
     
+      __(
+        
+          
+  
+    
+      input: {
+  
+    
+      en: string,
+    
+  
+    
+      nl: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        string | null;
+    
+  }
+
+  export class HomeyAPIApp extends HomeyAPIV2 {
+    
+      constructor(
+        
+          
+  
+    
+      homey: Homey,
+    
+  
+    
+      debug: boolean,
+    
+  
+
+        
+      )
+    
+
+    
+
+    
       __(
         
           
@@ -5528,6 +5664,8 @@
 
   
 
+  
+
   
 
   

package/index.js

@@ -21,4 +21,5 @@ module.exports = {
   AthomWeatherAPI: require('./lib/AthomWeatherAPI'),
   AthomWebhooksAPI: require('./lib/AthomWebhooksAPI'),
   HomeyCloudAPI: require('./lib/HomeyCloudAPI'),
+  HomeyAPIApp: require('./lib/HomeyAPI/HomeyAPIApp'),
 };

package/lib/HomeyAPI/HomeyAPIApp.js

@@ -0,0 +1,126 @@
+'use strict';
+
+const HomeyAPI = require('./HomeyAPI');
+const HomeyAPIV2 = require('./HomeyAPIV2');
+
+/**
+ * Use this class to utilize Homey Pro's Web API from inside an app.
+ *
+ * > This class only works on apps using Apps SDK v3 running on Homey Pro.
+ *
+ * > Make sure your app has the `homey:manager:api` permission.
+ *
+ * @class
+ * @extends HomeyAPIV2
+ * @example
+ * // app.json
+ * {
+ *   ...
+ *   "platforms": [ "local" ],
+ *   "permissions": [ "homey:manager:api" ],
+ * }
+ *
+ * // app.js
+ * const Homey = require('homey');
+ * const { HomeyAPIApp } = require('homey-api');
+ *
+ * class MyApp extends Homey.App {
+ *
+ *   async onInit() {
+ *     const api = new HomeyAPIApp({
+ *       homey: this.homey,
+ *     });
+ *
+ *     const devices = await api.devices.getDevices();
+ *     this.log('Devices:', devices);
+ *   }
+ *
+ * }
+ */
+class HomeyAPIApp extends HomeyAPIV2 {
+
+  /**
+   * Possible Discovery Strategies
+   * @static
+   * @property {object} DISCOVERY_STRATEGIES
+   * @property {string} DISCOVERY_STRATEGIES.LOCAL - Local HTTP, e.g. `http://192.168.1.100`.
+   */
+  static DISCOVERY_STRATEGIES = {};
+
+  /**
+   * @param {Homey} homey - The Homey instance of your app, usually `this.homey`.
+   * @param {boolean} [debug=false] - Enable debug logs.
+   */
+  constructor({
+    homey,
+    debug = false,
+    ...props
+  }) {
+    super({
+      ...props,
+      api: null,
+      properties: {
+        id: 'local',
+        softwareVersion: null,
+      },
+      strategy: [
+        HomeyAPI.DISCOVERY_STRATEGIES.LOCAL,
+      ],
+    });
+
+    Object.defineProperty(this, '__homeySDK', {
+      value: homey,
+      enumerable: false,
+      writable: true,
+    });
+
+    Object.defineProperty(this, '__debugEnabled', {
+      value: !!debug,
+      enumerable: false,
+      writable: true,
+    });
+  }
+
+  __debug(...props) {
+    if (!this.__debugEnabled) return;
+    this.__homeySDK.log('[homey-api]', `[${this.constructor.name}]`, ...props);
+  }
+
+  async login() {
+    if (!this.__loginPromise) {
+      this.__loginPromise = Promise.resolve().then(async () => {
+        const token = await this.__homeySDK.api.getOwnerApiToken();
+        this.__debug(`Local Token: ${token}`);
+        return token;
+      });
+
+      this.__loginPromise
+        .then(token => {
+          this.__token = token;
+        })
+        .catch(err => {
+          this.__debug('Error Logging In:', err);
+        })
+        .finally(() => {
+          this.__loginPromise = null;
+        });
+    }
+
+    return this.__loginPromise;
+  }
+
+  async discoverBaseUrl() {
+    this.__baseUrl = await this.__homeySDK.api.getLocalUrl();
+    this.__strategyId = 'local';
+
+    this.__debug(`Local URL: ${this.__baseUrl}`);
+
+    return {
+      baseUrl: this.__baseUrl,
+      strategyId: this.__strategyId,
+    };
+  }
+
+}
+
+module.exports = HomeyAPIApp;

package/lib/HomeyAPI/HomeyAPIV2.js

@@ -285,6 +285,8 @@ class HomeyAPIV2 extends HomeyAPI {
             promises.push(pings[HomeyAPI.DISCOVERY_STRATEGIES.MDNS]);
           }
 
+          // TODO: Move this to the catch handler to always fallback on cloud
+          // Now mdns or local will error first and cloud won't have a chance!!
           if (pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]) {
             promises.push(pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]);
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "1.4.3",
+  "version": "1.5.2",
   "description": "Homey API",
   "main": "src/index.js",
   "types": "assets/types/homey-api.d.ts",
@@ -39,7 +39,7 @@
   },
   "dependencies": {
     "core-js": "^3.19.1",
-    "node-fetch": "^2.6.6",
+    "node-fetch": "^2.6.7",
     "regenerator-runtime": "^0.13.9",
     "socket.io-client": "^1.7.4"
   },