hb-nb-tools 2.0.0-0 → 2.0.0-2

package/cli/nb.js

@@ -5,6 +5,11 @@
 // Command line interface to Nuki bridge HTTP API.
 // Copyright © 2018-2024 Erik Baauw. All rights reserved.
 
-import { NbTool } from '../index.js'
+import { createRequire } from 'node:module'
 
-new NbTool(import.meta.dirname).main()
+import { NbTool } from 'hb-nb-tools/NbTool'
+
+const require = createRequire(import.meta.url)
+const packageJson = require('../package.json')
+
+new NbTool(packageJson).main()

package/index.js

@@ -5,32 +5,5 @@
 
 /** Homebridge NB Tools.
   *
-  * @module hbNbTools
+  * @module hb-nb-tools
   */
-
-/** Nuki bridge HTTP API client.
-  * <br>See {@link NbClient}.
-  * @name NbClient
-  * @type {Class}
-  * @memberof module:hbNbTools
-  */
-export { NbClient } from './lib/NbClient.js'
-
-/** Parser and validator for command-line arguments.
-  * <br>See {@link NbDiscovery}.
-  * @name NbDiscovery
-  * @type {Class}
-  * @memberof module:hbNbTools
-  */
-export { NbDiscovery } from './lib/NbDiscovery.js'
-
-/** Command-line tool.
-  * <br>See {@link NbListener}.
-  * @name NbListener
-  * @type {Class}
-  * @memberof module:hbNbTools
-  */
-export { NbListener } from './lib/NbListener.js'
-
-// Command-line tools.
-export { NbTool } from './lib/NbTool.js'

package/jsdoc.json

@@ -0,0 +1,21 @@
+{
+  "plugins": [
+    "plugins/markdown"
+  ],
+  "rescurseDepth": 10,
+  "source": {
+    "include": [
+      "README.md",
+      "index.js",
+      "lib",
+      "cli",
+      "node_modules/hb-lib-tools/lib/HttpClient.js"
+    ]
+  },
+  "opts": {
+    "recurse": true
+  },
+  "templates": {
+    "monospaceLinks": true
+  }
+}

package/lib/NbClient.js

@@ -6,10 +6,26 @@
 import { createHash, randomInt } from 'node:crypto'
 import tweetnacl from 'tweetnacl'
 
-import { HttpClient, JsonFormatter, OptionParser, toHexString } from 'hb-lib-tools'
+import { toHexString } from 'hb-lib-tools'
+import { HttpClient } from 'hb-lib-tools/HttpClient'
+import { JsonFormatter } from 'hb-lib-tools/JsonFormatter'
+import { OptionParser } from 'hb-lib-tools/OptionParser'
 
 const { secretbox, randomBytes } = tweetnacl
 
+/** Nuki bridge HTTP API client.
+  * <br>See {@link NbClient}.
+  * @name NbClient
+  * @type {Class}
+  * @memberof module:hb-nb-tools
+  */
+
+/** Nuki bridge HTTP API client.
+  *
+  * See the [Nuki bridge HTTP API](https://developer.nuki.io/page/nuki-bridge-http-api-1-13/4)
+  * documentation for a better understanding of the API.
+  * @extends HttpClient
+  */
 class NbClient extends HttpClient {
   static get DeviceTypes () {
     return {

package/lib/NbDiscovery.js

@@ -3,8 +3,22 @@
 //
 // Homebridge NB Tools.
 
-import { HttpClient, OptionParser } from 'hb-lib-tools'
+import { HttpClient } from 'hb-lib-tools/HttpClient'
+import { OptionParser } from 'hb-lib-tools/OptionParser'
 
+/** Nuki bridge discovery.
+  * <br>See {@link NbDiscovery}.
+  * @name NbDiscovery
+  * @type {Class}
+  * @memberof module:hb-nb-tools
+  */
+
+/** Class for discovery of Nuki bridges.
+  *
+  * See the [Nuki bridge HTTP API](https://developer.nuki.io/page/nuki-bridge-http-api-1-13/4)
+  * documentation for a better understanding of the API.
+  * @extends HttpClient
+  */
 class NbDiscovery extends HttpClient {
   constructor (params = {}) {
     const config = {

package/lib/NbListener.js

@@ -6,10 +6,23 @@
 import { EventEmitter } from 'node:events'
 import { createServer } from 'node:http'
 
-import { OptionParser } from 'hb-lib-tools'
+import { OptionParser } from 'hb-lib-tools/OptionParser'
 
-import { NbClient } from '../index.js'
+import { NbClient } from 'hb-nb-tools/NbClient'
 
+/** Listerner for Nuki bridge callbacks.
+  * <br>See {@link NbListener}.
+  * @name NbListener
+  * @type {Class}
+  * @memberof module:hb-nb-tools
+  */
+
+/** Class for listening to Nuki bridge callbacks.
+  *
+  * See the [Nuki bridge HTTP API](https://developer.nuki.io/page/nuki-bridge-http-api-1-13/4)
+  * documentation for a better understanding of the API.
+  * @extends EventEmitter
+  */
 class NbListener extends EventEmitter {
   constructor (port = 0) {
     super()

package/lib/NbTool.js

@@ -3,11 +3,14 @@
 //
 // Command line interface to Nuki bridge HTTP API.
 
-import {
-  CommandLineParser, CommandLineTool, JsonFormatter, OptionParser
-} from 'hb-lib-tools'
-
-import { NbClient, NbDiscovery, NbListener } from '../index.js'
+import { CommandLineParser } from 'hb-lib-tools/CommandLineParser'
+import { CommandLineTool } from 'hb-lib-tools/CommandLineTool'
+import { JsonFormatter } from 'hb-lib-tools/JsonFormatter'
+import { OptionParser } from 'hb-lib-tools/OptionParser'
+
+import { NbClient } from 'hb-nb-tools/NbClient'
+import { NbDiscovery } from 'hb-nb-tools/NbDiscovery'
+import { NbListener } from 'hb-nb-tools/NbListener'
 
 const { b, u } = CommandLineTool
 const { UsageError } = CommandLineParser

package/package.json

@@ -3,9 +3,11 @@
   "description": "Homebridge NB Tools",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "2.0.0-0",
+  "version": "2.0.0-2",
   "type": "module",
-  "main": "index.js",
+  "exports": {
+    "./*": "./lib/*.js"
+  },
   "keywords": [
     "nuki",
     "smart-lock",
@@ -19,11 +21,11 @@
     "node": "^20||^18"
   },
   "dependencies": {
-    "hb-lib-tools": "~2.0.0-0",
+    "hb-lib-tools": "~2.0.0-2",
     "tweetnacl": "~1.0.3"
   },
   "scripts": {
-    "prepare": "standard",
+    "prepare": "standard && rm -rf out && jsdoc -c jsdoc.json",
     "test": "standard && echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -33,5 +35,15 @@
   "bugs": {
     "url": "https://github.com/ebaauw/hb-nb-tools/issues"
   },
-  "homepage": "https://github.com/ebaauw/hb-nb-tools#readme"
+  "homepage": "https://github.com/ebaauw/hb-nb-tools#readme",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/ebaauw"
+    },
+    {
+      "type": "paypal",
+      "url": "https://www.paypal.me/ebaauw/EUR"
+    }
+  ]
 }