mqtt-payload-inspector 1.0.0

package/README.md

@@ -0,0 +1,32 @@
+# MQTT Payload Inspector
+
+Inspect, decode and analyze MQTT payloads.
+
+## Installation
+
+npm install @muthukumar/mqtt-payload-inspector
+
+## Usage
+
+```js
+const inspector =
+require("@muthukumar/mqtt-payload-inspector");
+
+const payload =
+"7b22766f6c74616765223a3233307d";
+
+console.log(
+    inspector.inspect(payload)
+);
+```
+
+## Output
+
+```json
+{
+  "format": "HEX",
+  "decoded": {
+    "voltage": 230
+  }
+}
+```

package/examples/test.js

@@ -0,0 +1,6 @@
+const { inspect } = require("../src");
+
+const payload =
+"7b22766f6c74616765223a3233302c2263757272656e74223a312e357d";
+
+console.log(inspect(payload));

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "mqtt-payload-inspector",
+  "version": "1.0.0",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "mqtt",
+    "iot",
+    "payload",
+    "hex",
+    "base64",
+    "decoder",
+    "inspector"
+  ],
+  "author": "Muthukumar",
+  "license": "MIT",
+  "description": "Inspect, decode and analyze MQTT payloads",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "crypto-js": "^4.2.0",
+    "entropy-string": "^4.2.0"
+  },
+  "devDependencies": {
+    "eslint": "^10.5.0",
+    "jest": "^30.4.2"
+  }
+}

package/src/decode.js

@@ -0,0 +1,31 @@
+function decode(payload) {
+    const str = payload.toString().trim();
+
+    // HEX
+    if (/^[0-9a-fA-F]+$/.test(str)) {
+        const decoded = Buffer.from(str, "hex").toString("utf8");
+
+        try {
+            return JSON.parse(decoded);
+        } catch {
+            return decoded;
+        }
+    }
+
+    // BASE64
+    if (/^[A-Za-z0-9+/=]+$/.test(str)) {
+        try {
+            const decoded = Buffer.from(str, "base64").toString("utf8");
+
+            try {
+                return JSON.parse(decoded);
+            } catch {
+                return decoded;
+            }
+        } catch {}
+    }
+
+    return payload;
+}
+
+module.exports = decode;

package/src/decoder.js

@@ -0,0 +1,10 @@
+const inspector = require("../src");
+
+const payload = JSON.stringify({
+    voltage: 230,
+    current: 1.5
+});
+
+const result = inspector.inspect(payload);
+
+console.log(result);

package/src/index.js

@@ -0,0 +1,18 @@
+const detectFormat = require("./inspect");
+const decode = require("./decode");
+const stats = require("./stats");
+
+function inspect(payload) {
+
+    const format = detectFormat(payload);
+
+    return {
+        format,
+        decoded: decode(payload),
+        ...stats(payload)
+    };
+}
+
+module.exports = {
+    inspect
+};

package/src/inspect.js

@@ -0,0 +1,20 @@
+function detectFormat(payload) {
+    const str = payload.toString().trim();
+
+    try {
+        JSON.parse(str);
+        return "JSON";
+    } catch {}
+
+    if (/^[0-9a-fA-F]+$/.test(str)) {
+        return "HEX";
+    }
+
+    if (/^[A-Za-z0-9+/=]+$/.test(str)) {
+        return "BASE64";
+    }
+
+    return "TEXT";
+}
+
+module.exports = detectFormat;

package/src/stats.js

@@ -0,0 +1,20 @@
+function detectFormat(payload) {
+    const str = payload.toString().trim();
+
+    try {
+        JSON.parse(str);
+        return "JSON";
+    } catch {}
+
+    if (/^[0-9a-fA-F]+$/.test(str)) {
+        return "HEX";
+    }
+
+    if (/^[A-Za-z0-9+/=]+$/.test(str)) {
+        return "BASE64";
+    }
+
+    return "TEXT";
+}
+
+module.exports = detectFormat;

package/src/topicParser.js

@@ -0,0 +1,13 @@
+function parse(topic) {
+    const parts = topic.split("/");
+
+    return {
+        project: parts[0],
+        country: parts[1],
+        state: parts[2],
+        city: parts[3],
+        deviceId: parts[4]
+    };
+}
+
+module.exports = parse;