homebridge-lib 6.7.5 → 7.0.0-1

package/cli/hap.js

@@ -7,8 +7,11 @@
 //
 // Logger for HomeKit accessory announcements.
 
-'use strict'
+import { createRequire } from 'node:module'
 
-const { HapTool } = require('hb-lib-tools')
+import { HapTool } from 'hb-lib-tools/HapTool'
 
-new HapTool(require('../package.json')).main()
+const require = createRequire(import.meta.url)
+const packageJson = require('../package.json')
+
+new HapTool(packageJson).main()

package/cli/json.js

@@ -7,8 +7,11 @@
 //
 // JSON formatter.
 
-'use strict'
+import { createRequire } from 'node:module'
 
-const { JsonTool } = require('hb-lib-tools')
+import { JsonTool } from 'hb-lib-tools/JsonTool'
 
-new JsonTool(require('../package.json')).main()
+const require = createRequire(import.meta.url)
+const packageJson = require('../package.json')
+
+new JsonTool(packageJson).main()

package/cli/sysinfo.js

@@ -7,8 +7,11 @@
 //
 // Show system info.
 
-'use strict'
+import { createRequire } from 'node:module'
 
-const { SysinfoTool } = require('hb-lib-tools')
+import { SysinfoTool } from 'hb-lib-tools/SysinfoTool'
 
-new SysinfoTool(require('../package.json')).main()
+const require = createRequire(import.meta.url)
+const packageJson = require('../package.json')
+
+new SysinfoTool(packageJson).main()

package/cli/upnp.js

@@ -7,8 +7,11 @@
 //
 // Logger for UPnP device announcements.
 
-'use strict'
+import { createRequire } from 'node:module'
 
-const { UpnpTool } = require('hb-lib-tools')
+import { UpnpTool } from 'hb-lib-tools/UpnpTool'
 
-new UpnpTool(require('../package.json')).main()
+const require = createRequire(import.meta.url)
+const packageJson = require('../package.json')
+
+new UpnpTool(packageJson).main()

package/index.js

@@ -3,12 +3,8 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
-
-const hbLibTools = require('hb-lib-tools')
-
 /** Library for Homebridge plugins.
-  * see the {@tutorial homebridgeLib} tutorial.
+  * see the {@tutorial homebridge-lib} tutorial.
   *
   * Homebridge Lib provides:
   * - A series of base classes for building Homebridge dynamic platform plugins:
@@ -38,7 +34,7 @@ const hbLibTools = require('hb-lib-tools')
   * To access the classes provided by Homebridge Lib from your module,
   * simply load it by:
   * ```javascript
-  * const homebridgeLib = require('homebridge-lib')
+  * import { Class } from 'homebridge-lib/Class'
   * ```
   *
   * Note that each class provided by Homebridge Lib is implemented as a
@@ -46,207 +42,54 @@ const hbLibTools = require('hb-lib-tools')
   * Due to the way NodeJS deals with circular module dependencies, these modules
   * might not yet be initialised while your module is loading.
   *
-  * @module homebridgeLib
+  * @module homebridge-lib
   */
-class homebridgeLib {
-  /** Delegate of a HomeKit accessory.
-    * <br>See {@link AccessoryDelegate}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get AccessoryDelegate () { return require('./lib/AccessoryDelegate') }
-
-  /** Adaptive Lighting.
-    * <br>See {@link AdaptiveLighting}.
-    * @type {Class}
-    * @memberof module: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}
-    * @memberof module:homebridgeLib
-    */
-  static get CharacteristicDelegate () { return require('./lib/CharacteristicDelegate') }
-
-  /** Colour conversions.
-    * <br>See {@link Colour}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  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 hbLibTools.CommandLineParser }
-
-  /** Command-line tool.
-    * <br>See {@link CommandLineTool}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get CommandLineTool () { return hbLibTools.CommandLineTool }
-
-  /** Abstract superclass for {@link EveHomeKitTypes}
-    * and {@link MyHomeKitTypes}.
-    * <br>See {@link CustomHomeKitTypes}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get CustomHomeKitTypes () { return require('./lib/CustomHomeKitTypes') }
-
-  /** Abstract superclass for {@link Platform}, {@link AccessoryDelegate},
-    * {@link ServiceDelegate}, and {@link CharacteristicDelegate}.
-    * <br>See {@link Delegate}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get Delegate () { return require('./lib/Delegate') }
-
-  /** Custom HomeKit services and characteristics used by
-    * [Eve](https://www.evehome.com/en) accessories and by the
-    * [Eve app](https://www.evehome.com/en/eve-app).
-    * <br>See {@link EveHomeKitTypes}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get EveHomeKitTypes () { return require('./lib/EveHomeKitTypes') }
-
-  /** HTTP client.
-    * <br>See {@link HttpClient}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get HttpClient () { return hbLibTools.HttpClient }
-
-  /** JSON formatter.
-    * <br>See {@link JsonFormatter}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get JsonFormatter () { return hbLibTools.JsonFormatter }
-
-  /** My own collection of custom HomeKit services and characteristics.
-    * <br>See {@link MyHomeKitTypes}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get MyHomeKitTypes () { return require('./lib/MyHomeKitTypes') }
-
-  /** Parser and validator for options and other parameters.
-    * <br>See {@link OptionParser}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get OptionParser () { return hbLibTools.OptionParser }
-
-  /** Homebridge dynamic platform plugin.
-    * <br>See {@link Platform}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get Platform () { return require('./lib/Platform') }
-
-  /** Delegate of a property of a HomeKit accessory or service.
-    * <br>See {@link PropertyDelegate}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get PropertyDelegate () { return require('./lib/PropertyDelegate') }
-
-  /** Delegate of a HomeKit service.
-    * <br>See {@link ServiceDelegate}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get ServiceDelegate () { return require('./lib/ServiceDelegate') }
 
-  /** System information.
-    * <br>See {@link SystemInfo}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get SystemInfo () { return hbLibTools.SystemInfo }
-
-  /** Universal Plug and Play client.
-    * <br>See {@link UpnpClient}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get UpnpClient () { return hbLibTools.UpnpClient }
-
-  /** Server for dynamic configuration settings through Homebridge UI.
-    * <br>See {@link UiServer}.
-    * @type {Class}
-    * @memberof module:homebridgeLib
-    */
-  static get UiServer () { return require('./lib/UiServer') }
-
-  /** Resolve after given period, delaying execution.
-    *
-    * E.g. to delay execution for 1.5 seconds, issue:
-    * ```javascript
-    *   await homebridgeLib.timeout(1500)
-    * ```
-    *
-    * @param {integer} msec - Period (in msec) to wait.
-    * @throws {TypeError} On invalid parameter type.
-    * @throws {RangeError} On invalid parameter value.
-    * @memberof module:homebridgeLib
-    */
-  static get timeout () { return hbLibTools.timeout }
-
-  /** Convert Error to string.
-    *
-    * Include the stack trace only for programming errors (JavaScript and NodeJS
-    * runtime errors).
-    * Translate system errors into more readable messages.
-    * @param {Error} e - The error.
-    * @param {boolean} [useChalk=false] - Use chalk to grey out the stack trace.
-    * @returns {string} - The error as string.
-    * @memberof module:homebridgeLib
-    */
-  static get formatError () { return hbLibTools.formatError }
-
-  /** Convert integer to hex string.
-    * @param {integer} i - The integer.
-    * @param {integer} [length=4] - The number of digits in the hex string.
-    * @returns {string} - The hex string.
-    * @memberof module:homebridgeLib
-    */
-  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`](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 hbLibTools.semver }
-
-  /** Return the recommended version of NodeJS from package.json.
-    * This is the version used to develop and test the software,
-    * typically the latest LTS version.
-    * @param {string} packageJson - The contents of package.json
-    * #return {string} - The recommended version.
-    * @memberof module:hbLibTools
-    */
-  static get recommendedNodeVersion () { return hbLibTools.recommendedNodeVersion }
-}
+/** Convert Error to string.
+  *
+  * Include the stack trace only for programming errors (JavaScript and NodeJS
+  * runtime errors).
+  * Translate system errors into more readable messages.
+  * @function formatError
+  * @param {Error} e - The error.
+  * @param {boolean} [useChalk=false] - Use chalk to grey out the stack trace.
+  * @returns {string} - The error as string.
+  * @memberof module:homebridge-lib
+  */
+export { formatError } from 'hb-lib-tools'
+
+/** Return the recommended version of NodeJS from package.json.
+  * This is the version used to develop and test the software,
+  * typically the latest LTS version.
+  * @function recommendedNodeVersion
+  * @param {string} packageJson - The contents of package.json
+  * #return {string} - The recommended version.
+  * @memberof module:hbLibTools
+  */
+export { recommendedNodeVersion } from 'hb-lib-tools'
 
-module.exports = homebridgeLib
+/** Resolve after given period, delaying execution.
+  *
+  * E.g. to delay execution for 1.5 seconds, issue:
+  * ```javascript
+  *   import { timeout } from 'homebridge-lib'
+  *
+  *   await timeout(1500)
+  * ```
+  *
+  * @function timeout
+  * @param {integer} msec - Period (in msec) to wait.
+  * @throws {TypeError} On invalid parameter type.
+  * @throws {RangeError} On invalid parameter value.
+  * @memberof module:homebridge-lib
+  */
+export { timeout } from 'hb-lib-tools'
+
+/** Convert integer to hex string.
+  * @function toHexString
+  * @param {integer} i - The integer.
+  * @param {integer} [length=4] - The number of digits in the hex string.
+  * @returns {string} - The hex string.
+  * @memberof module:homebridge-lib
+  */
+export { toHexString } from 'hb-lib-tools'

package/lib/AccessoryDelegate.js

@@ -3,18 +3,27 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
-
-const homebridgeLib = require('../index')
+import { CharacteristicDelegate } from 'homebridge-lib/CharacteristicDelegate'
+import { Delegate } from 'homebridge-lib/Delegate'
+import { PropertyDelegate } from 'homebridge-lib/PropertyDelegate'
+import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
+import 'homebridge-lib/ServiceDelegate/AccessoryInformation'
 
 const startsWithUuid = /^[0-9A-F]{8}-[0-9A-F]{4}-[1-5][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}/
 
+/** Delegate of a HomeKit accessory.
+  * <br>See {@link AccessoryDelegate}.
+  * @name AccessoryDelegate
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+
 /** Delegate of a HomeKit accessory.
   *
   * @abstract
   * @extends Delegate
   */
-class AccessoryDelegate extends homebridgeLib.Delegate {
+class AccessoryDelegate extends Delegate {
   /** Create a new instance of a HomeKit accessory delegate.
     *
     * When the corresponding HomeKit accessory was restored from persistent
@@ -75,8 +84,7 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
 
     // Create delegate for AccessoryInformation service.
     this._serviceDelegates = {}
-    this._accessoryInformationDelegate =
-      new homebridgeLib.ServiceDelegate.AccessoryInformation(this, params)
+    this._accessoryInformationDelegate = new ServiceDelegate.AccessoryInformation(this, params)
 
     // Configure PlatformAccessory.
     this._accessory.on('identify', this._identify.bind(this))
@@ -189,7 +197,7 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
       throw new SyntaxError(`${key}: duplicate key`)
     }
 
-    const delegate = new homebridgeLib.PropertyDelegate(this, params)
+    const delegate = new PropertyDelegate(this, params)
     this._propertyDelegates[key] = delegate
 
     // Create shortcut for characteristic value.
@@ -303,8 +311,8 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
     */
   manageLogLevel (delegate, forPlatform = false) {
     if (
-      !(delegate instanceof homebridgeLib.CharacteristicDelegate) &&
-      !(delegate instanceof homebridgeLib.PropertyDelegate)
+      !(delegate instanceof CharacteristicDelegate) &&
+      !(delegate instanceof PropertyDelegate)
     ) {
       throw new TypeError('delegate: not a CharacteristicDelegate or PropertyDelegate')
     }
@@ -329,4 +337,4 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
   }
 }
 
-module.exports = AccessoryDelegate
+export { AccessoryDelegate }

package/lib/AdaptiveLighting.js

@@ -3,9 +3,7 @@
 // Library for Homebridge plugins.
 // Copyright © 2020-2024 Erik Baauw. All rights reserved.
 
-'use strict'
-
-const { CharacteristicDelegate } = require('../index')
+import { CharacteristicDelegate } from 'homebridge-lib/CharacteristicDelegate'
 
 /* global BigInt */
 
@@ -164,6 +162,13 @@ function tlvFromHexString (type, value) {
   return tlvFromBuffer(type, Buffer.from(value, 'hex'))
 }
 
+/** Adaptive Lighting.
+  * <br>See {@link AdaptiveLighting}.
+  * @name AdaptiveLighting
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+
 /** Adaptive Lighting.
   */
 class AdaptiveLighting {
@@ -342,4 +347,4 @@ class AdaptiveLighting {
   }
 }
 
-module.exports = AdaptiveLighting
+export { AdaptiveLighting }

package/lib/Bonjour.js

@@ -0,0 +1,12 @@
+// homebridge-lib/lib/Bonjour.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2020-2024 Erik Baauw. All rights reserved.
+
+/** Return the `Bonjour` class from [`bonjour-hap`](https://github.com/homebridge/bonjour),
+  * so plugins don't have to list this as a separate dependency.
+  * @name Bonjour
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+export { Bonjour } from 'hb-lib-tools/Bonjour'

package/lib/CharacteristicDelegate.js

@@ -3,9 +3,16 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
+import { Delegate } from 'homebridge-lib/Delegate'
+import { OptionParser } from 'homebridge-lib/OptionParser'
+import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
 
-const homebridgeLib = require('../index')
+/** Delegate of a HomeKit characteristic.
+  * <br>See {@link CharacteristicDelegate}.
+  * @name CharacteristicDelegate
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
 
 /** Delegate of a HomeKit characteristic.
   *
@@ -50,7 +57,7 @@ const homebridgeLib = require('../index')
   *
   * @extends Delegate
   */
-class CharacteristicDelegate extends homebridgeLib.Delegate {
+class CharacteristicDelegate extends Delegate {
   /** Create a new instance of a HomeKit characteristic delegate.
     *
     * Note that instances of `CharacteristicDelegate` are normally created by
@@ -95,7 +102,7 @@ class CharacteristicDelegate extends homebridgeLib.Delegate {
     * optional parameter is not applicable.
     */
   constructor (serviceDelegate, params = {}) {
-    if (!(serviceDelegate instanceof homebridgeLib.ServiceDelegate)) {
+    if (!(serviceDelegate instanceof ServiceDelegate)) {
       throw new TypeError('serviceDelegate: not a ServiceDelegate')
     }
     super(serviceDelegate.platform, serviceDelegate.name)
@@ -145,7 +152,7 @@ class CharacteristicDelegate extends homebridgeLib.Delegate {
         }
         this._characteristic.on('set', this._onSet.bind(this))
       }
-      this._timeout = homebridgeLib.OptionParser.toInt(
+      this._timeout = OptionParser.toInt(
         'params.timeout', params.timeout == null ? 1000 : params.timeout, 500, 5000
       )
       // Check that we are the only listener
@@ -451,4 +458,4 @@ class CharacteristicDelegate extends homebridgeLib.Delegate {
   }
 }
 
-module.exports = CharacteristicDelegate
+export { CharacteristicDelegate }

package/lib/Colour.js

@@ -0,0 +1,12 @@
+// homebridge-lib/lib/Colour.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2020-2024 Erik Baauw. All rights reserved.
+
+/** Colour conversions.
+  * <br>See {@link Colour}.
+  * @name Colour
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+export { Colour } from 'hb-lib-tools/Colour'

package/lib/CommandLineParser.js

@@ -0,0 +1,12 @@
+// homebridge-lib/lib/CommandLineParser.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2020-2024 Erik Baauw. All rights reserved.
+
+/** Parser and validator for command-line arguments.
+  * <br>See {@link CommandLineParser}.
+  * @name CommandLineParser
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+export { CommandLineParser } from 'hb-lib-tools/CommandLineParser'

package/lib/CommandLineTool.js

@@ -0,0 +1,12 @@
+// homebridge-lib/lib/CommandLineTool.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2020-2024 Erik Baauw. All rights reserved.
+
+/** Command-line tool.
+  * <br>See {@link CommandLineTool}.
+  * @name CommandLineTool
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+export { CommandLineTool } from 'hb-lib-tools/CommandLineTool'

package/lib/CustomHomeKitTypes.js

@@ -13,6 +13,14 @@ let hap
 let hapCharacteristics
 let hapServices
 
+/** Abstract superclass for {@link EveHomeKitTypes}
+  * and {@link MyHomeKitTypes}.
+  * <br>See {@link CustomHomeKitTypes}.
+  * @name CustomHomeKitTypes
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+
 /** Abstract superclass for {@link EveHomeKitTypes} and {@link MyHomeKitTypes}.
   *
   * `CustomHomeKitTypes` creates and manages a collection of:
@@ -233,4 +241,4 @@ class CustomHomeKitTypes {
   }
 }
 
-module.exports = CustomHomeKitTypes
+export { CustomHomeKitTypes }

package/lib/Delegate.js

@@ -3,12 +3,19 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
+import { EventEmitter } from 'node:events'
 
-const homebridgeLib = require('../index')
-const { HttpClient } = homebridgeLib
+import { HttpClient } from 'hb-lib-tools/HttpClient'
 
-const events = require('events')
+import { Platform } from 'homebridge-lib/Platform'
+
+/** Abstract superclass for {@link Platform}, {@link AccessoryDelegate},
+  * {@link ServiceDelegate}, and {@link CharacteristicDelegate}.
+  * <br>See {@link Delegate}.
+  * @name Delegate
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
 
 /** Abstract superclass for {@link Platform}, {@link AccessoryDelegate},
   * {@link ServiceDelegate}, and {@link CharacteristicDelegate}.
@@ -19,7 +26,7 @@ const events = require('events')
   * @abstract
   * @extends EventEmitter
   */
-class Delegate extends events.EventEmitter {
+class Delegate extends EventEmitter {
   /** Create a new `Delegate` instance.
     * @abstract
     * @param {?Platform} platform - Reference to the corresponding platform
@@ -32,7 +39,7 @@ class Delegate extends events.EventEmitter {
     if (platform == null) {
       platform = this
     }
-    if (!(platform instanceof homebridgeLib.Platform)) {
+    if (!(platform instanceof Platform)) {
       throw new TypeError('platform: not a Platform')
     }
     this._platform = platform
@@ -256,4 +263,4 @@ class Delegate extends events.EventEmitter {
   }
 }
 
-module.exports = Delegate
+export { Delegate }

package/lib/EveHomeKitTypes.js

@@ -3,7 +3,7 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-const { CustomHomeKitTypes } = require('../index')
+import { CustomHomeKitTypes } from 'homebridge-lib/CustomHomeKitTypes'
 
 // Return long Eve UUID.
 function uuid (id) {
@@ -14,6 +14,15 @@ function uuid (id) {
   return `E863F${id}-079E-48FF-8F27-9C2605A29F52`
 }
 
+/** Custom HomeKit services and characteristics used by
+  * [Eve](https://www.evehome.com/en) accessories and by the
+  * [Eve app](https://www.evehome.com/en/eve-app).
+  * <br>See {@link EveHomeKitTypes}.
+  * @name EveHomeKitTypes
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+
 /** Custom HomeKit Services and Characteristic used by
   * [Eve](https://www.evehome.com/en) accessories and by the
   * [Eve app](https://www.evehome.com/en/eve-app).
@@ -691,4 +700,4 @@ class EveHomeKitTypes extends CustomHomeKitTypes {
   }
 }
 
-module.exports = EveHomeKitTypes
+export { EveHomeKitTypes }

package/lib/HttpClient.js

@@ -0,0 +1,7 @@
+/** HTTP client.
+  * <br>See {@link HttpClient}.
+  * @name HttpClient
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+export { HttpClient } from 'hb-lib-tools/HttpClient'

package/lib/JsonFormatter.js

@@ -0,0 +1,7 @@
+/** JSON formatter.
+  * <br>See {@link JsonFormatter}.
+  * @name JsonFormatter
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+export { JsonFormatter } from 'hb-lib-tools/JsonFormatter'

package/lib/MyHomeKitTypes.js

@@ -5,16 +5,21 @@
 //
 // My own collection of custom HomeKit Services and Characteristics.
 
-const { CustomHomeKitTypes } = require('../index')
+import { CustomHomeKitTypes } from 'homebridge-lib/CustomHomeKitTypes'
 
 function uuid (id) {
   return MyHomeKitTypes.uuid(id, '-0000-1000-8000-656261617577')
 }
-
-/**
- * My own collection of custom HomeKit Services and Characteristics.
- * @extends CustomHomeKitTypes
- */
+/** My own collection of custom HomeKit services and characteristics.
+  * <br>See {@link MyHomeKitTypes}.
+  * @name MyHomeKitTypes
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+
+/** My own collection of custom HomeKit Services and Characteristics.
+  * @extends CustomHomeKitTypes
+  */
 class MyHomeKitTypes extends CustomHomeKitTypes {
   /**
    * Create my custom HomeKit Services and Characteristics.
@@ -1034,4 +1039,4 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
   }
 }
 
-module.exports = MyHomeKitTypes
+export { MyHomeKitTypes }

package/lib/OptionParser.js

@@ -0,0 +1,12 @@
+// homebridge-lib/lib/OptionParser.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2017-2024 Erik Baauw. All rights reserved.
+
+/** Parser and validator for options and other parameters.
+  * <br>See {@link OptionParser}.
+  * @name OptionParser
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+export { OptionParser } from 'hb-lib-tools/OptionParser'

package/lib/Platform.js

@@ -3,37 +3,50 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
+import { once } from 'node:events'
+import { writeFile, unlink } from 'node:fs/promises'
+import { Server, STATUS_CODES } from 'node:http'
+import { createRequire } from 'node:module'
+import { format, promisify } from 'node:util'
+import zlib from 'node:zlib'
 
-const homebridgeLib = require('../index')
-const {
-  HttpClient, SystemInfo, UpnpClient, formatError, recommendedNodeVersion, semver
-} = homebridgeLib
+import { HttpClient } from 'hb-lib-tools/HttpClient'
+import { SystemInfo } from 'hb-lib-tools/SystemInfo'
+import { UpnpClient } from 'hb-lib-tools/UpnpClient'
 
-const events = require('events')
-const fs = require('fs')
-const http = require('http')
-const util = require('util')
-const zlib = require('zlib')
+import { Delegate } from 'homebridge-lib/Delegate'
+import { EveHomeKitTypes } from 'homebridge-lib/EveHomeKitTypes'
+import { MyHomeKitTypes } from 'homebridge-lib/MyHomeKitTypes'
+import { semver } from 'homebridge-lib/semver'
 
+import { formatError, recommendedNodeVersion } from 'homebridge-lib'
+
+const require = createRequire(import.meta.url)
 const libPackageJson = require('../package.json')
 
 const uuid = /^[0-9A-F]{8}-[0-9A-F]{4}-[1-5][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/
-const gzip = util.promisify(zlib.gzip)
+const gzip = promisify(zlib.gzip)
 
 const context = {
   libName: libPackageJson.name,
   libVersion: libPackageJson.version,
   nodeVersion: process.version.slice(1),
   recommendedNodeVersion: recommendedNodeVersion(libPackageJson),
-  recommendedHomebridgeVersion:
-    semver.minVersion(libPackageJson.engines.homebridge).toString(),
+  // recommendedHomebridgeVersion:
+  //   semver.minVersion(libPackageJson.engines.homebridge).toString(),
   saveInterval: 3600,
   checkInterval: 7 * 24 * 3600,
   driftDebugThreshold: 250,
   driftWarningThreshold: 2500
 }
 
+/** Homebridge dynamic platform plugin.
+  * <br>See {@link Platform}.
+  * @name Platform
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+
 /** Homebridge dynamic platform plugin.
   *
   * `Platform` provides the following features to a platform plugin:
@@ -49,7 +62,7 @@ const context = {
   * @abstract
   * @extends Delegate
   */
-class Platform extends homebridgeLib.Delegate {
+class Platform extends Delegate {
   /** Load the platform plugin.
     *
     * Called by Homebridge, through the plugin's `index.js`, when loading the
@@ -67,6 +80,9 @@ class Platform extends homebridgeLib.Delegate {
       context.homebridge = homebridge
       context.homebridgeVersion = homebridge.serverVersion
       context.PlatformAccessory = homebridge.platformAccessory
+      context.recommendedHomebridgeVersion =
+        semver.minVersion(libPackageJson.engines.homebridge).toString()
+
       const hap = {
         Services: {},
         Characteristics: {}
@@ -81,8 +97,8 @@ class Platform extends homebridgeLib.Delegate {
       }).forEach((key) => {
         hap.Characteristics[key] = homebridge.hap.Characteristic[key]
       })
-      const eve = new homebridgeLib.EveHomeKitTypes(homebridge)
-      const my = new homebridgeLib.MyHomeKitTypes(homebridge)
+      const eve = new EveHomeKitTypes(homebridge)
+      const my = new MyHomeKitTypes(homebridge)
 
       context.Accessory = Object.freeze({
         Categories: Object.freeze(Object.assign({}, homebridge.hap.Categories))
@@ -105,6 +121,11 @@ class Platform extends homebridgeLib.Delegate {
       })
     }
     context[Platform.name] = { packageJson, platformName }
+    // console.log(
+    //   '%s v%s, node v%s, homebridge v%s, %s v%s',
+    //   packageJson.name, packageJson.version, context.nodeVersion,
+    //   context.homebridgeVersion, context.libName, context.libVersion
+    // )
     homebridge.registerPlatform(
       packageJson.name, platformName, Platform, true
     )
@@ -170,9 +191,6 @@ class Platform extends homebridgeLib.Delegate {
   // Main platform function.
   // Called by homebridge after restoring accessories from cache.
   async _main () {
-    // process.on('unhandledRejection', (error) => {
-    //   this.error('unhandled rejection: %s', error.stack)
-    // })
     /** System information.
       * @type {SystemInfo}
       * @readonly
@@ -204,7 +222,7 @@ class Platform extends homebridgeLib.Delegate {
         await this._createUiServer()
       } catch (error) { this.error(error) }
     }
-    await events.once(this, 'initialised')
+    await once(this, 'initialised')
     this._flushCachedAccessories()
     for (const id in this._accessories) {
       if (this._accessoryDelegates[id] == null) {
@@ -248,7 +266,7 @@ class Platform extends homebridgeLib.Delegate {
       this._pluginName + '.json.gz'
     try {
       const data = await gzip(JSON.stringify(Object.assign(result, dumpInfo)))
-      await fs.promises.writeFile(filename, data)
+      await writeFile(filename, data)
       this.log('created debug dump file %s', filename)
     } catch (error) {
       this.error('%s: %s', filename, error)
@@ -526,7 +544,7 @@ class Platform extends homebridgeLib.Delegate {
     const historyFile = accessory.context.historyFile
     if (historyFile) {
       this.debug('remove history file %s', historyFile)
-      fs.unlink(historyFile, (error) => {
+      unlink(historyFile, (error) => {
         if (error) {
           this.warn(error)
         }
@@ -611,7 +629,7 @@ class Platform extends homebridgeLib.Delegate {
   // Create HTTP server for Homebridge Plugin UI Settings.
   async _createUiServer () {
     this._ui = {}
-    this._ui.server = new http.Server()
+    this._ui.server = new Server()
     this._ui.server
       .on('listening', () => {
         this._ui.port = this._ui.server.address().port
@@ -660,7 +678,7 @@ class Platform extends homebridgeLib.Delegate {
                 )
             this.debug(
               'ui request %d: %d %s', this._ui.requestId,
-              status, http.STATUS_CODES[status]
+              status, STATUS_CODES[status]
             )
             if (status === 200) {
               this.vdebug('ui request %d: response: %j', this._ui.requestId, body)
@@ -684,7 +702,7 @@ class Platform extends homebridgeLib.Delegate {
       host: '127.0.0.1',
       signal: this._ui.abortController.signal
     })
-    await events.once(this._ui.server, 'listening')
+    await once(this._ui.server, 'listening')
   }
 
   // ===== Logging =============================================================
@@ -707,7 +725,7 @@ class Platform extends homebridgeLib.Delegate {
     if (args[0] == null) {
       message = ''
     } else if (typeof (args[0]) === 'string') {
-      message = util.format(...args)
+      message = format(...args)
     } else {
       throw new TypeError('format: not a string or instance of Error')
     }
@@ -740,4 +758,4 @@ class Platform extends homebridgeLib.Delegate {
   }
 }
 
-module.exports = Platform
+export { Platform }

package/lib/PropertyDelegate.js

@@ -3,9 +3,15 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
+import { AccessoryDelegate } from 'homebridge-lib/AccessoryDelegate'
+import { Delegate } from 'homebridge-lib/Delegate'
 
-const homebridgeLib = require('../index')
+/** Delegate of a property of a HomeKit accessory or service.
+  * <br>See {@link PropertyDelegate}.
+  * @name PropertyDelegate
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
 
 /** Delegate of a property of a delegate of a HomeKit accessory or HomeKit
   * service.
@@ -18,7 +24,7 @@ const homebridgeLib = require('../index')
   *
   * @extends Delegate
   */
-class PropertyDelegate extends homebridgeLib.Delegate {
+class PropertyDelegate extends Delegate {
   /** Instantiate a property delegate.
     *
     * Note that instances are normally created by invoking
@@ -40,7 +46,7 @@ class PropertyDelegate extends homebridgeLib.Delegate {
     * optional parameter is not applicable.
     */
   constructor (parent, params = {}) {
-    if (!(parent instanceof homebridgeLib.AccessoryDelegate)) {
+    if (!(parent instanceof AccessoryDelegate)) {
       throw new TypeError('parent: not an AccessoryDelegate')
     }
     super(parent.platform, parent.name + ': ' + params.key)
@@ -134,4 +140,4 @@ class PropertyDelegate extends homebridgeLib.Delegate {
   }
 }
 
-module.exports = PropertyDelegate
+export { PropertyDelegate }

package/lib/ServiceDelegate/AccessoryInformation.js

@@ -3,9 +3,7 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
-
-const { ServiceDelegate } = require('../../index')
+import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
 
 /** Class for an _AccessoryInformation_ service delegate.
   *
@@ -111,4 +109,4 @@ class AccessoryInformation extends ServiceDelegate {
   }
 }
 
-module.exports = AccessoryInformation
+ServiceDelegate.AccessoryInformation = AccessoryInformation

package/lib/ServiceDelegate/Battery.js

@@ -3,9 +3,7 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
-
-const { ServiceDelegate } = require('../../index')
+import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
 
 /** Class for a _Battery_ service delegate.
   *
@@ -105,4 +103,4 @@ class Battery extends ServiceDelegate {
   }
 }
 
-module.exports = Battery
+ServiceDelegate.Battery = Battery

package/lib/ServiceDelegate/Dummy.js

@@ -3,9 +3,7 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
-
-const { ServiceDelegate } = require('../../index')
+import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
 
 /** Class for a delegate for a dummy _StatelessProgrammableSwitch_ service.
   *
@@ -44,4 +42,4 @@ class Dummy extends ServiceDelegate {
   }
 }
 
-module.exports = Dummy
+ServiceDelegate.Dummy = Dummy

package/lib/ServiceDelegate/History.js

@@ -7,9 +7,8 @@
 // fakagato-history repository, copyright © 2017 simont77.
 // See https://github.com/simont77/fakegato-history.
 
-'use strict'
-
-const { CharacteristicDelegate, ServiceDelegate } = require('../../index')
+import { CharacteristicDelegate } from 'homebridge-lib/CharacteristicDelegate'
+import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
 
 // Eve history keeps time as # seconds since epoch of 2001/01/01.
 // @type {integer}
@@ -749,4 +748,4 @@ class History extends ServiceDelegate {
   }
 }
 
-module.exports = History
+ServiceDelegate.History = History

package/lib/ServiceDelegate/ServiceLabel.js

@@ -3,9 +3,7 @@
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
-
-const { ServiceDelegate } = require('../../index')
+import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
 
 /** Class for a _ServiceLabel_ service delegate.
   *
@@ -47,4 +45,4 @@ class ServiceLabel extends ServiceDelegate {
   }
 }
 
-module.exports = ServiceLabel
+ServiceDelegate.ServiceLabel = ServiceLabel

package/lib/{ServiceDelegate/index.js → ServiceDelegate.js}

@@ -1,11 +1,18 @@
-// homebridge-lib/lib/ServiceDelegate/index.js
+// homebridge-lib/lib/ServiceDelegate.js
 //
 // Library for Homebridge plugins.
 // Copyright © 2017-2024 Erik Baauw. All rights reserved.
 
-'use strict'
+import { AccessoryDelegate } from 'homebridge-lib/AccessoryDelegate'
+import { CharacteristicDelegate } from 'homebridge-lib/CharacteristicDelegate'
+import { Delegate } from 'homebridge-lib/Delegate'
 
-const homebridgeLib = require('../../index')
+/** Delegate of a HomeKit service.
+  * <br>See {@link ServiceDelegate}.
+  * @name ServiceDelegate
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
 
 /** Delegate of a HomeKit service.
   *
@@ -19,13 +26,7 @@ const homebridgeLib = require('../../index')
   * @abstract
   * @extends Delegate
   */
-class ServiceDelegate extends homebridgeLib.Delegate {
-  static get AccessoryInformation () { return require('./AccessoryInformation') }
-  static get Battery () { return require('./Battery') }
-  static get Dummy () { return require('./Dummy') }
-  static get History () { return require('./History') }
-  static get ServiceLabel () { return require('./ServiceLabel') }
-
+class ServiceDelegate extends Delegate {
   /** Create a new instance of a HomeKit service delegate.
     *
     * When the associated HomeKit service was restored from persistent
@@ -49,7 +50,7 @@ class ServiceDelegate extends homebridgeLib.Delegate {
     * @params {?boolean} params.hidden - Hidden service.
     */
   constructor (accessoryDelegate, params = {}) {
-    if (!(accessoryDelegate instanceof homebridgeLib.AccessoryDelegate)) {
+    if (!(accessoryDelegate instanceof AccessoryDelegate)) {
       throw new TypeError('parent: not a AccessoryDelegate')
     }
     if (params.name == null) {
@@ -229,7 +230,7 @@ class ServiceDelegate extends homebridgeLib.Delegate {
       throw new SyntaxError(`${key}: duplicate key`)
     }
 
-    const characteristicDelegate = new homebridgeLib.CharacteristicDelegate(
+    const characteristicDelegate = new CharacteristicDelegate(
       this, params
     )
     this._characteristicDelegates[key] = characteristicDelegate
@@ -318,4 +319,4 @@ class ServiceDelegate extends homebridgeLib.Delegate {
   }
 }
 
-module.exports = ServiceDelegate
+export { ServiceDelegate }

package/lib/SystemInfo.js

@@ -0,0 +1,12 @@
+// homebridge-lib/lib/SystemInfo.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2020-2024 Erik Baauw. All rights reserved.
+
+/** System information.
+  * <br>See {@link SystemInfo}.
+  * @name SystemInfo
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+export { SystemInfo } from 'hb-lib-tools/SystemInfo'

package/lib/UiServer.js

@@ -3,15 +3,23 @@
 // Library for Homebridge plugins.
 // Copyright © 2022-2024 Erik Baauw. All rights reserved.
 
-'use strict'
-
-const {
-  HomebridgePluginUiServer // , RequestError
-} = require('@homebridge/plugin-ui-utils')
-const { HttpClient, chalk, formatError } = require('../index')
-const fs = require('fs').promises
-const path = require('path')
-const util = require('util')
+import { readFile } from 'node:fs/promises'
+import { join } from 'node:path'
+import { format } from 'node:util'
+
+// Somehow this causes Homebridge to crash with SIGTERM after ~9 seconds.
+import { HomebridgePluginUiServer } from '@homebridge/plugin-ui-utils'
+
+import { formatError } from 'hb-lib-tools'
+import { chalk } from 'hb-lib-tools/chalk'
+import { HttpClient } from 'hb-lib-tools/HttpClient'
+
+/** Server for dynamic configuration settings through Homebridge UI.
+  * <br>See {@link UiServer}.
+  * @name UiServer
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
 
 /** Server for handling Homebridge Plugin UI requests.
   *
@@ -93,12 +101,12 @@ class UiServer extends HomebridgePluginUiServer {
         if (username != null) {
           fileName += '.' + username.replace(/:/g, '').toUpperCase()
         }
-        const fullFileName = path.join(
+        const fullFileName = join(
           this.homebridgeStoragePath,
           'accessories',
           fileName
         )
-        const json = await fs.readFile(fullFileName)
+        const json = await readFile(fullFileName)
         const cachedAccessories = JSON.parse(json)
         return cachedAccessories
       } catch (error) {
@@ -219,9 +227,9 @@ class UiServer extends HomebridgePluginUiServer {
     if (args[0] == null) {
       message = ''
     } else if (typeof args[0] === 'string') {
-      message = util.format(...args)
+      message = format(...args)
     } else {
-      message = util.format('%o', ...args)
+      message = format('%o', ...args)
     }
 
     // Handle colours.
@@ -233,4 +241,4 @@ class UiServer extends HomebridgePluginUiServer {
   }
 }
 
-module.exports = UiServer
+export { UiServer }

package/lib/UpnpClient.js

@@ -0,0 +1,12 @@
+// homebridge-lib/lib/UpnpClient.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2020-2024 Erik Baauw. All rights reserved.
+
+/** Universal Plug and Play client.
+  * <br>See {@link UpnpClient}.
+  * @name UpnpClient
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+export { UpnpClient } from 'hb-lib-tools/UpnpClient'

package/lib/chalk.js

@@ -0,0 +1,11 @@
+// homebridge-lib/lib/chalk.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2020-2024 Erik Baauw. All rights reserved.
+
+/** Return the [`chalk`](https://github.com/chalk/chalk) module,
+  * so plugins don't have to list this as a separate dependency.
+  * @name chalk
+  * @memberof module:homebridge-lib
+  */
+export { chalk } from 'hb-lib-tools/chalk'

package/lib/semver.js

@@ -0,0 +1,11 @@
+// homebridge-lib/lib/semver.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2020-2024 Erik Baauw. All rights reserved.
+
+/** Return the [`semver`](https://github.com/npm/node-semver) module,
+  * so plugins don't have to list this as a separate dependency.
+  * @name semver
+  * @memberof module:homebridge-lib
+  */
+export { semver } from 'hb-lib-tools/semver'

package/package.json

@@ -3,12 +3,17 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "6.7.5",
+  "version": "7.0.0-1",
   "keywords": [
     "homekit",
     "homebridge"
   ],
+  "type": "module",
   "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./*": "./lib/*.js"
+  },
   "files": [
     "index.js",
     "lib",
@@ -21,12 +26,12 @@
     "upnp": "cli/upnp.js"
   },
   "engines": {
-    "homebridge": "^1.7.0",
-    "node": "20.12.0||^20||^18"
+    "homebridge": "^1.8.1",
+    "node": "20.12.2||^20||^18"
   },
   "dependencies": {
-    "@homebridge/plugin-ui-utils": "~1.0.1",
-    "hb-lib-tools": "~1.2.4"
+    "@homebridge/plugin-ui-utils": "~1.0.3",
+    "hb-lib-tools": "~2.0.0-2"
   },
   "scripts": {
     "prepare": "standard && rm -rf out && jsdoc -c jsdoc.json",