homey-api 1.10.17 → 3.0.0-rc.2

package/lib/HomeyAPI/HomeyAPIV3Cloud.js

@@ -3,7 +3,7 @@
 const HomeyAPIV3 = require('./HomeyAPIV3');
 
 /**
- * This class is returned by {@link AthomCloudAPI.Homey#authenticate} for a cloud-based Homey.
+ * This class is returned by {@link AthomCloudAPI.Homey#authenticate} for a Homey with `platform: 'cloud'` and `platformVersion: 1`.
  *
  * @class
  * @hideconstructor

package/lib/HomeyAPI/HomeyAPIV3Local.js

@@ -3,7 +3,7 @@
 const HomeyAPIV3 = require('./HomeyAPIV3');
 
 /**
- * This class is returned by {@link AthomCloudAPI.Homey#authenticate} for a Homey Pro.
+ * This class is returned by {@link AthomCloudAPI.Homey#authenticate} for a Homey with `platform: 'local'` and `platformVersion: 1`.
  *
  * @class
  * @hideconstructor

package/package.json

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

package/lib/HomeyAPI/HomeyAPIApp.js

@@ -1,127 +0,0 @@
-'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 {Object} args
-   * @param {Homey} args.homey - The Homey instance of your app, usually `this.homey`.
-   * @param {boolean} [args.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/Item.js

@@ -1,177 +0,0 @@
-'use strict';
-
-const EventEmitter = require('../../EventEmitter');
-
-class Item extends EventEmitter {
-
-  constructor({
-    uri,
-    key,
-    homey,
-    manager,
-    properties,
-  }) {
-    super();
-
-    // Set Homey
-    Object.defineProperty(this, 'homey', {
-      value: homey,
-      enumerable: false,
-      writable: false,
-    });
-
-    // Set Manager
-    Object.defineProperty(this, 'manager', {
-      value: manager,
-      enumerable: false,
-      writable: false,
-    });
-
-    // Set Key
-    Object.defineProperty(this, '__key', {
-      value: key,
-      enumerable: false,
-      writable: false,
-    });
-
-    // Set URI
-    Object.defineProperty(this, '__uri', {
-      value: uri,
-      enumerable: false,
-      writable: true,
-    });
-
-    // Set Connected
-    Object.defineProperty(this, '__connected', {
-      value: false,
-      enumerable: false,
-      writable: true,
-    });
-
-    // Set Properties
-    for (const [key, value] of Object.entries(properties)) {
-      Object.defineProperty(this, key, {
-        value,
-        enumerable: true,
-        writable: true,
-      });
-    }
-  }
-
-  __debug(...props) {
-    this.manager.__debug(`[${this.constructor.name}:${this.__key}]`, ...props);
-  }
-
-  __update(properties) {
-    for (const [key, value] of Object.entries(properties)) {
-      this[key] = value;
-    }
-    return this;
-  }
-
-  async connect() {
-    this.__debug('connect');
-
-    // If disconnecting, await that first
-    try {
-      // Ensure all microtasks are done first. E.g. if disconnect is called in the same tick as
-      // connect. This way the disconnect is always started first so we can await the disconnect
-      // promise before we try to connect again.
-      await Promise.resolve();
-      await this.__disconnectPromise;
-    } catch (err) { }
-
-    this.__connectPromise = Promise.resolve().then(async () => {
-      if (!this.io) {
-        this.io = this.homey.subscribe(this.__uri, {
-          onConnect: () => {
-            this.__debug('onConnect');
-            this.__connected = true;
-
-            this.onConnect();
-          },
-          onDisconnect: () => {
-            this.__debug('onDisconnect');
-            this.__connected = false;
-
-            this.onDisconnect();
-          },
-          onReconnect: () => {
-            this.__debug('onDisconnect');
-
-            this.onReconnect();
-          },
-          onEvent: (event, data) => {
-            this.__debug('onEvent', event, data);
-
-            this.emit(event, data);
-          },
-        });
-      }
-
-      await this.io;
-    });
-
-    // Delete the connecting Promise
-    this.__connectPromise
-      .catch(() => { })
-      .finally(() => {
-        delete this.__connectPromise;
-      });
-
-    await this.__connectPromise;
-  }
-
-  async disconnect() {
-    this.__debug('disconnect');
-
-    // If connecting, await that first
-    try {
-      await this.__connectPromise;
-    } catch (err) { }
-
-    this.__disconnectPromise = Promise.resolve().then(async () => {
-      this.__connected = false;
-
-      if (this.io) {
-        this.io
-          .then(io => io.unsubscribe())
-          .catch(err => this.__debug('Error Disconnecting:', err));
-      }
-    });
-
-    // Delete the disconnecting Promise
-    this.__disconnectPromise
-      .catch(() => { })
-      .finally(() => {
-        delete this.__disconnectPromise;
-        // Delete this.io so connect can start new connections.
-        delete this.io;
-      });
-
-    await this.__disconnectPromise;
-  }
-
-  onConnect() {
-    // Overload Me
-  }
-
-  onReconnect() {
-    // Overload Me
-  }
-
-  onDisconnect() {
-    // Overload Me
-  }
-
-  destroy() {
-    // Remove all event listeners
-    this.removeAllListeners();
-
-    // Disconnect from Socket.io
-    this.disconnect().catch(() => { });
-  }
-
-}
-
-module.exports = Item;