hb-nb-tools 2.0.0-1 → 2.0.0

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 { createRequire } from 'node:module'
+
 import { NbTool } from 'hb-nb-tools/NbTool'
 
-new NbTool(import.meta.dirname).main()
+const require = createRequire(import.meta.url)
+const packageJson = require('../package.json')
+
+new NbTool(packageJson).main()

package/index.js

@@ -0,0 +1,9 @@
+// hb-nb-tools/index.js
+//
+// Homebridge NB Tools.
+// Copyright © 2017-2024 Erik Baauw. All rights reserved.
+
+/** Homebridge NB Tools.
+  *
+  * @module hb-nb-tools
+  */

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

@@ -13,6 +13,19 @@ 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

@@ -6,6 +6,19 @@
 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

@@ -10,6 +10,19 @@ import { OptionParser } from 'hb-lib-tools/OptionParser'
 
 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/package.json

@@ -3,7 +3,7 @@
   "description": "Homebridge NB Tools",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "2.0.0-1",
+  "version": "2.0.0",
   "type": "module",
   "exports": {
     "./*": "./lib/*.js"
@@ -21,11 +21,11 @@
     "node": "^20||^18"
   },
   "dependencies": {
-    "hb-lib-tools": "~2.0.0-1",
+    "hb-lib-tools": "~2.0.0",
     "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": {
@@ -35,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"
+    }
+  ]
 }