homey-api 3.0.0-rc.20 → 3.0.0-rc.22

package/index.js

@@ -3,6 +3,8 @@
 'use strict';
 
 module.exports = {};
+
+// Athom Cloud
 module.exports.AthomAppsAPI = require('./lib/AthomAppsAPI');
 module.exports.AthomBackupAPI = require('./lib/AthomBackupAPI');
 module.exports.AthomCallbackAPI = require('./lib/AthomCallbackAPI');
@@ -19,5 +21,23 @@ module.exports.AthomSetupAPI = require('./lib/AthomSetupAPI');
 module.exports.AthomStoreAPI = require('./lib/AthomStoreAPI');
 module.exports.AthomWeatherAPI = require('./lib/AthomWeatherAPI');
 module.exports.AthomWebhooksAPI = require('./lib/AthomWebhooksAPI');
+
+// Homey Cloud
 module.exports.HomeyCloudAPI = require('./lib/HomeyCloudAPI');
+
+// Homey API
 module.exports.HomeyAPI = require('./lib/HomeyAPI/HomeyAPI');
+module.exports.HomeyAPIV1 = require('./lib/HomeyAPI/HomeyAPIV1');
+module.exports.HomeyAPIV2 = require('./lib/HomeyAPI/HomeyAPIV2');
+module.exports.HomeyAPIV3 = require('./lib/HomeyAPI/HomeyAPIV3');
+module.exports.HomeyAPIV3Local = require('./lib/HomeyAPI/HomeyAPIV3Local');
+module.exports.HomeyAPIV3Cloud = require('./lib/HomeyAPI/HomeyAPIV3Cloud');
+
+// APIError
+module.exports.APIError = require('./lib/APIError');
+module.exports.APIErrorHomeyOffline = require('./lib/APIErrorHomeyOffline');
+module.exports.APIErrorNotFound = require('./lib/APIErrorNotFound');
+module.exports.APIErrorTimeout = require('./lib/APIErrorTimeout');
+
+// Util
+module.exports.Util = require('./lib/Util');

package/lib/API.js

@@ -73,6 +73,7 @@ class API {
       $body = {},
       $query = {},
       $headers = {},
+      $token = null,
       ...args
     } = {}) => {
       let pathWithParameters = operation.path;
@@ -89,6 +90,11 @@ class API {
           value = this.__secret;
         }
 
+        // Set Authorization header if $token is provided
+        if (typeof $token === 'string') {
+          headers.Authorization = `Bearer ${$token}`;
+        }
+
         // Validate the parameter
         if ($validate) {
           if (parameter.required === true && typeof value === 'undefined') {

package/lib/HomeyAPI/HomeyAPI.js

@@ -8,6 +8,14 @@ const Util = require('../Util');
  */
 class HomeyAPI {
 
+  /**
+   * Possible Platforms
+   */
+  static PLATFORMS = {
+    LOCAL: 'local',
+    CLOUD: 'cloud',
+  };
+
   /**
    * Possible Discovery Strategies
    * @static
@@ -27,8 +35,8 @@ class HomeyAPI {
   };
 
   constructor({
-    api,
-    properties,
+    api = null,
+    properties = {},
     debug = () => { },
   }) {
     // Set Debug Enabled
@@ -47,14 +55,28 @@ class HomeyAPI {
 
     // Set ID
     Object.defineProperty(this, 'id', {
-      value: properties.id || properties._id || null,
+      value: properties.id ?? properties._id ?? null,
       enumerable: true,
       writable: true,
     });
 
     // Set Version
     Object.defineProperty(this, 'version', {
-      value: properties.softwareVersion || null,
+      value: properties.softwareVersion ?? null,
+      enumerable: true,
+      writable: true,
+    });
+
+    // Set Name
+    Object.defineProperty(this, 'name', {
+      value: properties.name ?? null,
+      enumerable: true,
+      writable: true,
+    });
+
+    // Set Language
+    Object.defineProperty(this, 'Language', {
+      value: properties.Language ?? null,
       enumerable: true,
       writable: true,
     });
@@ -67,6 +89,10 @@ class HomeyAPI {
     });
   }
 
+  get _id() {
+    throw new Error('HomeyAPI._id is not supported, please use HomeyAPI.id');
+  }
+
   __debug(...props) {
     if (!this.__debugFunction) return;
     this.__debugFunction(...props);

package/lib/HomeyAPI/HomeyAPIV1.js

@@ -19,6 +19,14 @@ class HomeyAPIV1 extends HomeyAPI {
     this.token = token;
   }
 
+  get platform() {
+    return 'local';
+  }
+
+  get platformVersion() {
+    return 1;
+  }
+
   updates = {
     async getUpdates() {
       throw new Error('Not Implemented');

package/lib/HomeyAPI/HomeyAPIV2.js

@@ -25,6 +25,14 @@ class HomeyAPIV2 extends HomeyAPIV3 {
     ManagerInsights,
   };
 
+  get platform() {
+    return 'local';
+  }
+
+  get platformVersion() {
+    return 1;
+  }
+
 }
 
 module.exports = HomeyAPIV2;

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -378,32 +378,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;

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('purgseSettings', 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.20",
+  "version": "3.0.0-rc.22",
   "description": "Homey API",
   "main": "index.js",
   "files": [
@@ -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"