homey-api 3.0.0-rc.21 → 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/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.js

@@ -17,6 +17,14 @@ class HomeyAPIV3Local extends HomeyAPIV3 {
     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.21",
+  "version": "3.0.0-rc.22",
   "description": "Homey API",
   "main": "index.js",
   "files": [