homebridge-lib 6.3.7 → 6.3.8

package/README.md

@@ -44,14 +44,9 @@ This way, `npm` installs Homebridge Lib automatically when installing the actual
 
 To install the command-line tools, use:
 ```
-$ sudo npm -g i homebridge-lib
+$ sudo npm -g i hb-lib-tools
 ```
 This creates symlinks to these tools in `/usr/bin` or `/usr/local/bin` (depending on how you installed NodeJS).
-Note that, when Homebridge Lib is installed like this, Homebridge might issue a warning at startup:
-```
-Plugin /usr/lib/node_modules/homebridge-lib package.json does not contain the keyword 'homebridge-plugin'
-```
-This warning can be ignored safely.
 
 ### Credits
 The logic for handling [Eve](https://www.evehome.com/en/eve-app) history was copied from Simone Tisa's [`fakegato-history`](https://github.com/simont77/fakegato-history) repository, copyright © 2017 simont77.

package/cli/hap.js

@@ -9,6 +9,6 @@
 
 'use strict'
 
-const { HapTool } = require('../index')
+const { HapTool } = require('hb-lib-tools')
 
-new HapTool().main()
+new HapTool(require('../package.json')).main()

package/cli/json.js

@@ -9,6 +9,6 @@
 
 'use strict'
 
-const { JsonTool } = require('../index')
+const { JsonTool } = require('hb-lib-tools')
 
-new JsonTool().main()
+new JsonTool(require('../package.json')).main()

package/cli/sysinfo.js

@@ -9,6 +9,6 @@
 
 'use strict'
 
-const { SysinfoTool } = require('../index')
+const { SysinfoTool } = require('hb-lib-tools')
 
-new SysinfoTool().main()
+new SysinfoTool(require('../package.json')).main()

package/cli/upnp.js

@@ -9,6 +9,6 @@
 
 'use strict'
 
-const { UpnpTool } = require('../index')
+const { UpnpTool } = require('hb-lib-tools')
 
-new UpnpTool().main()
+new UpnpTool(require('../package.json')).main()

package/index.js

@@ -5,32 +5,7 @@
 
 'use strict'
 
-const chalk = require('chalk')
-const net = require('net')
-
-// Force colors when output is re-directed.
-chalk.enabled = true
-chalk.level = 1
-
-// Check of e is a JavaScript runtime error.
-function isJavaScriptError (e) {
-  return [
-    'AssertionError',
-    'EvalError',
-    'RangeError',
-    'ReferenceError',
-    'SyntaxError',
-    'TypeError',
-    'URIError'
-  ].includes(e.constructor.name)
-}
-
-// Check if e is a NodeJs runtime error.
-function isNodejsError (e) {
-  return typeof e.code === 'string' && e.code.startsWith('ERR_')
-}
-
-const zeroes = '00000000000000000000000000000000'
+const hbLibTools = require('hb-lib-tools')
 
 /** Library for Homebridge plugins.
   * see the {@tutorial homebridgeLib} tutorial.
@@ -41,23 +16,24 @@ const zeroes = '00000000000000000000000000000000'
   * {@link AccessoryDelegate},
   * {@link ServiceDelegate}, and
   * {@link CharacteristicDelegate}.
-  * - A base class to building command-line tools:
+  * - An abstract base class to building command-line tools:
   * {@link CommandLineTool}.
   * - A series of helper classes for building homebridge plugins (of any type)
   * and/or command-line utilities:
   * {@link AdaptiveLighting},
   * {@link Colour},
   * {@link CommandLineParser},
+  * {@link CustomHomeKitTypes},
+  * {@link Delegate},
   * {@link EveHomeKitTypes},
   * {@link HttpClient},
   * {@link JsonFormatter},
   * {@link MyHomeKitTypes},
-  * {@link OptionParser}, and
+  * {@link OptionParser},
+  * {@link PropertyDelegate},
+  * {@link SystemInfo},
+  * {@link UiServer}, and
   * {@link UpnpClient}.
-  * - A series of command-line utilities for troubleshooting Homebridge setups:
-  * `hap`, `json`, `upnp`.
-  * For more information on these, start the tool from the command-line
-  * with `-h` or `--help`.
   *
   * To access the classes provided by Homebridge Lib from your module,
   * simply load it by:
@@ -87,6 +63,13 @@ class homebridgeLib {
     */
   static get AdaptiveLighting () { return require('./lib/AdaptiveLighting') }
 
+  /** Return the `Bonjour` class from [`bonjour-hap`](https://github.com/homebridge/bonjour),
+    * so plugins don't have to list this as a separate dependency.
+    * @type {Class}
+    * @memberof module:homebridgeLib
+    */
+  static get Bonjour () { return hbLibTools.Bonjour }
+
   /** Delegate of a HomeKit characteristic.
     * <br>See {@link CharacteristicDelegate}.
     * @type {Class}
@@ -99,21 +82,21 @@ class homebridgeLib {
     * @type {Class}
     * @memberof module:homebridgeLib
     */
-  static get Colour () { return require('./lib/Colour') }
+  static get Colour () { return hbLibTools.Colour }
 
   /** Parser and validator for command-line arguments.
     * <br>See {@link CommandLineParser}.
     * @type {Class}
     * @memberof module:homebridgeLib
     */
-  static get CommandLineParser () { return require('./lib/CommandLineParser') }
+  static get CommandLineParser () { return hbLibTools.CommandLineParser }
 
   /** Command-line tool.
     * <br>See {@link CommandLineTool}.
     * @type {Class}
     * @memberof module:homebridgeLib
     */
-  static get CommandLineTool () { return require('./lib/CommandLineTool') }
+  static get CommandLineTool () { return hbLibTools.CommandLineTool }
 
   /** Abstract superclass for {@link EveHomeKitTypes}
     * and {@link MyHomeKitTypes}.
@@ -145,14 +128,14 @@ class homebridgeLib {
     * @type {Class}
     * @memberof module:homebridgeLib
     */
-  static get HttpClient () { return require('./lib/HttpClient') }
+  static get HttpClient () { return hbLibTools.HttpClient }
 
   /** JSON formatter.
     * <br>See {@link JsonFormatter}.
     * @type {Class}
     * @memberof module:homebridgeLib
     */
-  static get JsonFormatter () { return require('./lib/JsonFormatter') }
+  static get JsonFormatter () { return hbLibTools.JsonFormatter }
 
   /** My own collection of custom HomeKit services and characteristics.
     * <br>See {@link MyHomeKitTypes}.
@@ -166,7 +149,7 @@ class homebridgeLib {
     * @type {Class}
     * @memberof module:homebridgeLib
     */
-  static get OptionParser () { return require('./lib/OptionParser') }
+  static get OptionParser () { return hbLibTools.OptionParser }
 
   /** Homebridge dynamic platform plugin.
     * <br>See {@link Platform}.
@@ -194,27 +177,21 @@ class homebridgeLib {
     * @type {Class}
     * @memberof module:homebridgeLib
     */
-  static get SystemInfo () { return require('./lib/SystemInfo') }
+  static get SystemInfo () { return hbLibTools.SystemInfo }
 
-  /** Server for dynamic configuration settings through Homebridge UI.
-    * <br>See {@link UiServer}.
+  /** Universal Plug and Play client.
+    * <br>See {@link UpnpClient}.
     * @type {Class}
     * @memberof module:homebridgeLib
     */
-  static get UiServer () { return require('./lib/UiServer') }
+  static get UpnpClient () { return hbLibTools.UpnpClient }
 
-  /** Universal Plug and Play client.
-    * <br>See {@link UpnpClient}.
+  /** Server for dynamic configuration settings through Homebridge UI.
+    * <br>See {@link UiServer}.
     * @type {Class}
     * @memberof module:homebridgeLib
     */
-  static get UpnpClient () { return require('./lib/UpnpClient') }
-
-  // Command-line tools.
-  static get HapTool () { return require('./lib/HapTool') }
-  static get JsonTool () { return require('./lib/JsonTool') }
-  static get SysinfoTool () { return require('./lib/SysinfoTool') }
-  static get UpnpTool () { return require('./lib/UpnpTool') }
+  static get UiServer () { return require('./lib/UiServer') }
 
   /** Resolve after given period, delaying execution.
     *
@@ -228,12 +205,7 @@ class homebridgeLib {
     * @throws {RangeError} On invalid parameter value.
     * @memberof module:homebridgeLib
     */
-  static async timeout (msec) {
-    msec = homebridgeLib.OptionParser.toInt('msec', msec, 0)
-    return new Promise((resolve, reject) => {
-      setTimeout(() => { resolve() }, msec)
-    })
-  }
+  static get timeout () { return hbLibTools.timeout }
 
   /** Convert Error to string.
     *
@@ -245,48 +217,7 @@ class homebridgeLib {
     * @returns {string} - The error as string.
     * @memberof module:homebridgeLib
     */
-  static formatError (e, useChalk = false) {
-    if (isJavaScriptError(e) || isNodejsError(e)) {
-      if (useChalk) {
-        const lines = e.stack.split('\n')
-        const firstLine = lines.shift()
-        return firstLine + '\n' + chalk.reset.grey(lines.join('\n'))
-      }
-      return e.stack
-    }
-    if (e.errno != null) { // SystemError
-      let label = ''
-      if (e.path != null) {
-        label = e.path
-      } else if (e.dest != null) {
-        label = e.dest
-      } else if (e.address != null) {
-        label = e.address
-        if (net.isIPv6(label)) {
-          label = '[' + label + ']'
-        }
-        if (e.port != null) {
-          label += ':' + e.port
-        }
-      } else if (e.port != null) {
-        label = '' + e.port
-      } else if (e.hostname != null) {
-        label = e.hostname
-      }
-      let message = ''
-      const a = /[A-Z0-9_-]*:( .*),/.exec(e.message)
-      if (a != null && a[1] != null) {
-        message = a[1]
-      }
-      if (label != null && message != null) {
-        return `${label}: cannot ${e.syscall}: ${e.code}${message}`
-      }
-    }
-    if (e.cmd != null && e.message.slice(-1) === '\n') { // exec error
-      return e.message.slice(0, e.message.length - 1)
-    }
-    return e.message
-  }
+  static get formatError () { return hbLibTools.formatError }
 
   /** Convert integer to hex string.
     * @param {integer} i - The integer.
@@ -294,14 +225,19 @@ class homebridgeLib {
     * @returns {string} - The hex string.
     * @memberof module:homebridgeLib
     */
-  static toHexString (i, length = 4) {
-    return (zeroes + i.toString(16)).slice(-length).toUpperCase()
-  }
+  static get toHexString () { return hbLibTools.toHexString }
+
+  /** Return the [`chalk`](https://github.com/chalk/chalk) module,
+    * so plugins don't have to list this as a separate dependency.
+    * @memberof module:homebridgeLib
+    */
+  static get chalk () { return hbLibTools.chalk }
 
-  /** Return the `semver` library, so plugins don't have to list this as a
-    * separate dependency.
+  /** Return the [`semver`](https://github.com/npm/node-semver) module,
+    * so plugins don't have to list this as a separate dependency.
+    * @memberof module:homebridgeLib
     */
-  static get semver () { return require('semver') }
+  static get semver () { return hbLibTools.semver }
 }
 
 module.exports = homebridgeLib

package/lib/AccessoryDelegate.js

@@ -284,7 +284,7 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
     * from.
     */
   inheritLogLevel (delegate) {
-    if (!(delegate instanceof homebridgeLib.AccessoryDelegate)) {
+    if (!(delegate instanceof AccessoryDelegate)) {
       throw new TypeError('delegate: not an AccessoryDelegate')
     }
     if (delegate === this) {

package/lib/AdaptiveLighting.js

@@ -5,7 +5,7 @@
 
 'use strict'
 
-const homebridgeLib = require('../index')
+const { CharacteristicDelegate } = require('../index')
 
 /* global BigInt */
 
@@ -185,7 +185,7 @@ class AdaptiveLighting {
 
   get briIid () {
     if (this._briIid == null) {
-      this._briIid = this._bri instanceof homebridgeLib.CharacteristicDelegate
+      this._briIid = this._bri instanceof CharacteristicDelegate
         ? this._bri._characteristic.iid
         : this._bri
     }
@@ -194,7 +194,7 @@ class AdaptiveLighting {
 
   get ctIid () {
     if (this._ctIid == null) {
-      this._ctIid = this._ct instanceof homebridgeLib.CharacteristicDelegate
+      this._ctIid = this._ct instanceof CharacteristicDelegate
         ? this._ct._characteristic.iid
         : this._ct
     }

package/lib/Delegate.js

@@ -6,6 +6,7 @@
 'use strict'
 
 const homebridgeLib = require('../index')
+const { HttpClient } = homebridgeLib
 
 const events = require('events')
 
@@ -181,7 +182,7 @@ class Delegate extends events.EventEmitter {
     * @param {...string} args - Arguments to the printf-style message.
     */
   error (format, ...args) {
-    if (format instanceof homebridgeLib.HttpClient.HttpError) {
+    if (format instanceof HttpClient.HttpError) {
       // Error already emitted by HttpClient.
       return
     }

package/lib/EveHomeKitTypes.js

@@ -3,7 +3,7 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2023 Erik Baauw. All rights reserved.
 
-const homebridgeLib = require('../index')
+const { CustomHomeKitTypes } = require('../index')
 
 // Return long Eve UUID.
 function uuid (id) {
@@ -26,7 +26,7 @@ function uuid (id) {
   * [Gist](https://gist.github.com/simont77/3f4d4330fa55b83f8ca96388d9004e7d).
   * @extends CustomHomeKitTypes
   */
-class EveHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
+class EveHomeKitTypes extends CustomHomeKitTypes {
   /** Start time for Eve history (2001-01-01T00:00:00Z).
     * @type {integer}
     * @readonly

package/lib/MyHomeKitTypes.js

@@ -5,7 +5,7 @@
 //
 // My own collection of custom HomeKit Services and Characteristics.
 
-const homebridgeLib = require('../index')
+const { CustomHomeKitTypes } = require('../index')
 
 function uuid (id) {
   return MyHomeKitTypes.uuid(id, '-0000-1000-8000-656261617577')
@@ -15,7 +15,7 @@ function uuid (id) {
  * My own collection of custom HomeKit Services and Characteristics.
  * @extends CustomHomeKitTypes
  */
-class MyHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
+class MyHomeKitTypes extends CustomHomeKitTypes {
   /**
    * Create my custom HomeKit Services and Characteristics.
    * @param {object} homebridge - API object from homebridge

package/lib/Platform.js

@@ -6,11 +6,13 @@
 'use strict'
 
 const homebridgeLib = require('../index')
+const {
+  HttpClient, SystemInfo, UpnpClient, formatError, semver
+} = homebridgeLib
 
 const events = require('events')
 const fs = require('fs')
 const http = require('http')
-const { semver } = homebridgeLib
 const util = require('util')
 const zlib = require('zlib')
 
@@ -176,7 +178,7 @@ class Platform extends homebridgeLib.Delegate {
       * @type {SystemInfo}
       * @readonly
       */
-    this.systemInfo = new homebridgeLib.SystemInfo()
+    this.systemInfo = new SystemInfo()
     this.systemInfo
       .on('error', (error) => { this.warn(error) })
       .on('exec', (command) => { this.debug('exec: %s', command) })
@@ -372,7 +374,7 @@ class Platform extends homebridgeLib.Delegate {
   async _checkLatest (name, version) {
     try {
       if (this.npmRegistry == null) {
-        this.npmRegistry = new homebridgeLib.HttpClient({
+        this.npmRegistry = new HttpClient({
           https: true,
           host: 'registry.npmjs.org',
           json: true,
@@ -556,7 +558,7 @@ class Platform extends homebridgeLib.Delegate {
     if (this._upnpMonitor != null) {
       throw new SyntaxError('upnpConfig(): already called')
     }
-    this._upnpMonitor = new homebridgeLib.UpnpClient(config)
+    this._upnpMonitor = new UpnpClient(config)
     this._upnpMonitor
       .on('error', (error) => {
         this.error('upnp: error')
@@ -693,7 +695,7 @@ class Platform extends homebridgeLib.Delegate {
     if (args.length > 0) {
       let lastArg = args.pop()
       if (lastArg instanceof Error) {
-        lastArg = homebridgeLib.formatError(lastArg, true)
+        lastArg = formatError(lastArg, true)
       }
       args.push(lastArg)
     }

package/lib/ServiceDelegate/AccessoryInformation.js

@@ -5,9 +5,7 @@
 
 'use strict'
 
-const homebridgeLib = require('../../index')
-
-const { ServiceDelegate } = homebridgeLib
+const { ServiceDelegate } = require('../../index')
 
 /** Class for an _AccessoryInformation_ service delegate.
   *

package/lib/ServiceDelegate/Battery.js

@@ -5,9 +5,7 @@
 
 'use strict'
 
-const homebridgeLib = require('../../index')
-
-const { ServiceDelegate } = homebridgeLib
+const { ServiceDelegate } = require('../../index')
 
 /** Class for a _Battery_ service delegate.
   *

package/lib/ServiceDelegate/Dummy.js

@@ -5,9 +5,7 @@
 
 'use strict'
 
-const homebridgeLib = require('../../index')
-
-const { ServiceDelegate } = homebridgeLib
+const { ServiceDelegate } = require('../../index')
 
 /** Class for a delegate for a dummy _StatelessProgrammableSwitch_ service.
   *

package/lib/ServiceDelegate/History.js

@@ -9,22 +9,17 @@
 
 'use strict'
 
-const { CharacteristicDelegate } = require('../../index')
-const homebridgeLib = require('../../index')
+const { CharacteristicDelegate, ServiceDelegate } = require('../../index')
 
-const { ServiceDelegate } = homebridgeLib
-
-/** Eve history keeps time as # seconds since epoch of 2001/01/01.
-  * @type {integer}
-  */
+// Eve history keeps time as # seconds since epoch of 2001/01/01.
+// @type {integer}
 const epoch = Math.round(new Date('2001-01-01T00:00:00Z').valueOf() / 1000)
 
 const defaultMemorySize = 6 * 24 * 7 * 4 // 4 weeks of 1 entry per 10 minutes
 
-/** Convert date (in # seconds since NodeJS epoch) to string.
-  * @param {integer} d - Seconds since NodeJS epoch.
-  * @returns {string} Human readable date string.
-  */
+// Convert date (in # seconds since NodeJS epoch) to string.
+// @param {integer} d - Seconds since NodeJS epoch.
+// @returns {string} Human readable date string.
 function dateToString (d) {
   return new Date(1000 * d).toString().slice(0, 24)
 }

package/lib/ServiceDelegate/ServiceLabel.js

@@ -5,9 +5,7 @@
 
 'use strict'
 
-const homebridgeLib = require('../../index')
-
-const { ServiceDelegate } = homebridgeLib
+const { ServiceDelegate } = require('../../index')
 
 /** Class for a _ServiceLabel_ service delegate.
   *

package/lib/UiServer.js

@@ -8,8 +8,7 @@
 const {
   HomebridgePluginUiServer // , RequestError
 } = require('@homebridge/plugin-ui-utils')
-const { HttpClient, formatError } = require('../index')
-const chalk = require('chalk')
+const { HttpClient, chalk, formatError } = require('../index')
 const fs = require('fs').promises
 const path = require('path')
 const util = require('util')

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "6.3.7",
+  "version": "6.3.8",
   "keywords": [
     "homekit",
     "homebridge"
@@ -26,13 +26,11 @@
   },
   "dependencies": {
     "@homebridge/plugin-ui-utils": "~0.0.19",
-    "bonjour-hap": "^3.6.4",
-    "chalk": "^4.1.2",
-    "semver": "^7.3.8"
+    "hb-lib-tools": "^1.0.2"
   },
   "scripts": {
-    "prepare": "standard && mocha && rm -rf out && jsdoc -c jsdoc.json",
-    "test": "standard && mocha"
+    "prepare": "standard && rm -rf out && jsdoc -c jsdoc.json",
+    "test": "standard"
   },
   "repository": {
     "type": "git",