mqtt-json-rpc 1.3.6 → 2.0.0

package/README.md

@@ -20,13 +20,13 @@ $ npm install mqtt mqtt-json-rpc
 About
 -----
 
-This is a small wrapper around the
+This is an addon API for the
 [MQTT.js](https://www.npmjs.com/package/mqtt) API of
 [Node.js](https://nodejs.org/), for
 [Remote Procedure Call](https://en.wikipedia.org/wiki/Remote_procedure_call) (RPC)
 communication based on the [JSON-RPC](http://www.jsonrpc.org/)
 protocol. This allows a bi-directional request/response-style communication over
-the uni-directional message protocol [MQTT](http://mqtt.org).
+the technically uni-directional message protocol [MQTT](http://mqtt.org).
 
 Usage
 -----
@@ -40,7 +40,7 @@ const RPC  = require("mqtt-json-rpc")
 const mqtt = MQTT.connect("wss://127.0.0.1:8889", { ... })
 const rpc  = new RPC(mqtt)
 
-rpc.on("connect", () => {
+mqtt.on("connect", () => {
     rpc.register("example/hello", (a1, a2) => {
         console.log("example/hello: request: ", a1, a2)
         return `${a1}:${a2}`
@@ -57,10 +57,10 @@ const RPC  = require("mqtt-json-rpc")
 const mqtt = MQTT.connect("wss://127.0.0.1:8889", { ... })
 const rpc  = new RPC(mqtt)
 
-rpc.on("connect", () => {
+mqtt.on("connect", () => {
     rpc.call("example/hello", "world", 42).then((response) => {
         console.log("example/hello response: ", response)
-        rpc.end()
+        mqtt.end()
     })
 })
 ```
@@ -68,14 +68,13 @@ rpc.on("connect", () => {
 Application Programming Interface
 ---------------------------------
 
-The API of MQTT-JSON-RPC is a superset of the original
-[MQTT.js](https://www.npmjs.com/package/mqtt) API because it is just a
-wrapper around it with the following additional methods:
+The MQTT-JSON-RPC API provides the following methods (check out the
+corresponding [TypeScript definition](mqtt-json-rpc.d.ts)) file):
 
-- `constructor(mqtt: MQTT, encoding?: string]): MQTT-JSON-RPC`:<br/>
-  Create the [MQTT.js](https://www.npmjs.com/package/mqtt) API wrapper.
+- `constructor(mqtt: MQTT, options?: { encoding?: string, timeout?: number }): MQTT-JSON-RPC`:<br/>
   The `mqtt` is the [MQTT.js](https://www.npmjs.com/package/mqtt) instance.
-  The optional `encoding` can be either `json` (default), `msgpack` or `cbor`.
+  The optional `encoding` option can be either `json` (default), `msgpack` or `cbor`.
+  The optional `timeout` option is the timeout in seconds.
 
 - `MQTT-JSON-RPC#registered(method: string): boolean`:<br/>
   Check for the previous registration of a method. The `method` has to
@@ -141,7 +140,7 @@ rpc.register("example/hello", (a1, a2) => {
 })
 ```
 
-...and then its result, here `"world:42"`, is then
+...and then its result, in the above `rpc.call` example `"world:42"`, is then
 sent back as the following JSON-RPC 2.0 success response
 message to the temporary (client-specific) MQTT topic
 `example/hello/response/d1acc980-0e4e-11e8-98f0-ab5030b47df4`:
@@ -193,7 +192,7 @@ user    example
 topic   readwrite example/#
 ```
 
-...and an `example` user in `mosquitto-pwd.txt` like:
+...and an `example` user (with password `example`) in `mosquitto-pwd.txt` like:
 
 ```
 example:$6$awYNe6oCAi+xlvo5$mWIUqyy4I0O3nJ99lP1mkRVqsDGymF8en5NChQQxf7KrVJLUp1SzrrVDe94wWWJa3JGIbOXD9wfFGZdi948e6A==
@@ -214,13 +213,13 @@ const mqtt = MQTT.connect("wss://127.0.0.1:8889", {
 
 const rpc = new RPC(mqtt)
 
-rpc.on("error",     (err)            => { console.log("ERROR", err) })
-rpc.on("offline",   ()               => { console.log("OFFLINE") })
-rpc.on("close",     ()               => { console.log("CLOSE") })
-rpc.on("reconnect", ()               => { console.log("RECONNECT") })
-rpc.on("message",   (topic, message) => { console.log("RECEIVED", topic, message.toString()) })
+mqtt.on("error",     (err)            => { console.log("ERROR", err) })
+mqtt.on("offline",   ()               => { console.log("OFFLINE") })
+mqtt.on("close",     ()               => { console.log("CLOSE") })
+mqtt.on("reconnect", ()               => { console.log("RECONNECT") })
+mqtt.on("message",   (topic, message) => { console.log("RECEIVED", topic, message.toString()) })
 
-rpc.on("connect", () => {
+mqtt.on("connect", () => {
     console.log("CONNECT")
     rpc.register("example/hello", (a1, a2) => {
         console.log("example/hello: request: ", a1, a2)
@@ -228,7 +227,7 @@ rpc.on("connect", () => {
     })
     rpc.call("example/hello", "world", 42).then((result) => {
         console.log("example/hello sucess: ", result)
-        rpc.end()
+        mqtt.end()
     }).catch((err) => {
         console.log("example/hello error: ", err)
     })
@@ -250,7 +249,7 @@ CLOSE
 License
 -------
 
-Copyright (c) 2018-2022 Dr. Ralf S. Engelschall (http://engelschall.com/)
+Copyright (c) 2018-2023 Dr. Ralf S. Engelschall (http://engelschall.com/)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/eslint.yaml

@@ -1,6 +1,6 @@
 ##
 ##  MQTT-JSON-RPC -- JSON-RPC protocol over MQTT communication
-##  Copyright (c) 2018-2022 Dr. Ralf S. Engelschall <rse@engelschall.com>
+##  Copyright (c) 2018-2023 Dr. Ralf S. Engelschall <rse@engelschall.com>
 ##
 ##  Permission is hereby granted, free of charge, to any person obtaining
 ##  a copy of this software and associated documentation files (the

package/mqtt-json-rpc.d.ts

@@ -0,0 +1,54 @@
+/*
+**  MQTT-JSON-RPC -- JSON-RPC protocol over MQTT communication
+**  Copyright (c) 2018-2023 Dr. Ralf S. Engelschall <rse@engelschall.com>
+**
+**  Permission is hereby granted, free of charge, to any person obtaining
+**  a copy of this software and associated documentation files (the
+**  "Software"), to deal in the Software without restriction, including
+**  without limitation the rights to use, copy, modify, merge, publish,
+**  distribute, sublicense, and/or sell copies of the Software, and to
+**  permit persons to whom the Software is furnished to do so, subject to
+**  the following conditions:
+**
+**  The above copyright notice and this permission notice shall be included
+**  in all copies or substantial portions of the Software.
+**
+**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+**  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+**  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+**  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+**  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+**  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+**  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+declare module "mqtt-json-rpc" {
+    export class API {
+        constructor(
+            mqtt:          any,
+            options: {
+                encoding?: string,
+                timeout?:  number
+            }
+        )
+        registered(
+            method:        string
+        ):                 boolean
+        register(
+            method:        string,
+            callback:      (...params: any[]) => any
+        ):                 Promise<boolean>
+        unregister(
+            method:        string
+        ):                 Promise<any>
+        notify (
+            method:        string,
+            ...params:     any[]
+        ):                 void
+        call (
+            method:        string,
+            ...params:     any[]
+        ):                 Promise<any>
+    }
+}
+

package/mqtt-json-rpc.js

@@ -1,6 +1,6 @@
 /*
 **  MQTT-JSON-RPC -- JSON-RPC protocol over MQTT communication
-**  Copyright (c) 2018-2022 Dr. Ralf S. Engelschall <rse@engelschall.com>
+**  Copyright (c) 2018-2023 Dr. Ralf S. Engelschall <rse@engelschall.com>
 **
 **  Permission is hereby granted, free of charge, to any person obtaining
 **  a copy of this software and associated documentation files (the
@@ -57,23 +57,6 @@ class API {
         })
     }
 
-    /*  just pass-through the entire MQTT Client API  */
-    on                    (...args) { return this.mqtt.on(...args) }
-    addListener           (...args) { return this.mqtt.addListener(...args) }
-    removeListener        (...args) { return this.mqtt.removeListener(...args) }
-    publish               (...args) { return this.mqtt.publish(...args) }
-    subscribe             (...args) { return this.mqtt.subscribe(...args) }
-    unsubscribe           (...args) { return this.mqtt.unsubscribe(...args) }
-    end                   (...args) { return this.mqtt.end(...args) }
-    removeOutgoingMessage (...args) { return this.mqtt.removeOutgoingMessage(...args) }
-    reconnect             (...args) { return this.mqtt.reconnect(...args) }
-    handleMessage         (...args) { return this.mqtt.handleMessage(...args) }
-    get connected         ()        { return this.mqtt.connected }
-    set connected         (value)   { this.mqtt.connected = value }
-    getLastMessageId      (...args) { return this.mqtt.getLastMessageId(...args) }
-    get reconnecting      ()        { return this.mqtt.reconnecting }
-    set reconnecting      (value)   { this.mqtt.reconnecting = value }
-
     /*
      *  RPC server/response side
      */

package/package.json

@@ -1,9 +1,10 @@
 {
     "name":        "mqtt-json-rpc",
-    "version":     "1.3.6",
+    "version":     "2.0.0",
     "description": "JSON-RPC protocol over MQTT communication",
     "keywords":    [ "json-rpc", "json", "rpc", "mqtt" ],
     "main":        "./mqtt-json-rpc.js",
+    "types":       "./mqtt-json-rpc.d.ts",
     "license":     "MIT",
     "repository": {
         "type":    "git",
@@ -17,9 +18,9 @@
     "homepage":    "https://github.com/rse/mqtt-json-rpc",
     "bugs":        "https://github.com/rse/mqtt-json-rpc/issues",
     "devDependencies": {
-        "eslint":                  "8.13.0",
-        "eslint-config-standard":  "17.0.0",
-        "eslint-plugin-import":    "2.26.0",
+        "eslint":                  "8.44.0",
+        "eslint-config-standard":  "17.1.0",
+        "eslint-plugin-import":    "2.27.5",
         "eslint-plugin-node":      "11.1.0",
         "mqtt":                    "4.3.7"
     },
@@ -27,8 +28,8 @@
         "mqtt":                    ">=4.0.0"
     },
     "dependencies": {
-        "pure-uuid":               "1.6.2",
-        "encodr":                  "1.3.2",
+        "pure-uuid":               "1.6.4",
+        "encodr":                  "1.3.5",
         "jsonrpc-lite":            "2.2.0"
     },
     "engines": {

package/sample/package.json

@@ -3,17 +3,17 @@
     "version":                             "0.0.0",
     "description":                         "",
     "dependencies": {
-        "@babel/core":                     "7.17.9",
+        "@babel/core":                     "7.22.8",
         "mqtt":                            "4.3.7",
         "mqtt-json-rpc":                   ".."
     },
     "devDependencies": {
-        "grunt":                           "1.5.2",
+        "grunt":                           "1.6.1",
         "grunt-cli":                       "1.4.3",
         "grunt-browserify":                "6.0.0",
         "browserify":                      "17.0.0",
         "babelify":                        "10.0.0",
-        "@babel/preset-env":               "7.16.11"
+        "@babel/preset-env":               "7.22.7"
     },
     "scripts": {
         "build":                           "grunt default",

package/sample/sample.js

@@ -10,13 +10,13 @@ const mqtt = MQTT.connect("wss://127.0.0.1:8889", {
 
 const rpc = new RPC(mqtt)
 
-rpc.on("error",     (err)            => { console.log("ERROR", err) })
-rpc.on("offline",   ()               => { console.log("OFFLINE") })
-rpc.on("close",     ()               => { console.log("CLOSE") })
-rpc.on("reconnect", ()               => { console.log("RECONNECT") })
-rpc.on("message",   (topic, message) => { console.log("RECEIVED", topic, message.toString()) })
+mqtt.on("error",     (err)            => { console.log("ERROR", err) })
+mqtt.on("offline",   ()               => { console.log("OFFLINE") })
+mqtt.on("close",     ()               => { console.log("CLOSE") })
+mqtt.on("reconnect", ()               => { console.log("RECONNECT") })
+mqtt.on("message",   (topic, message) => { console.log("RECEIVED", topic, message.toString()) })
 
-rpc.on("connect", () => {
+mqtt.on("connect", () => {
     console.log("CONNECT")
     rpc.register("example/hello", (a1, a2) => {
         console.log("example/hello: request: ", a1, a2)
@@ -24,7 +24,7 @@ rpc.on("connect", () => {
     })
     rpc.call("example/hello", "world", 42).then((result) => {
         console.log("example/hello sucess: ", result)
-        rpc.end()
+        mqtt.end()
     }).catch((err) => {
         console.log("example/hello error: ", err)
     })