@mysetup/mqtt 2.0.1 → 2.0.4

package/README.md

@@ -1,82 +1,68 @@
-# @mysetup/mqtt-client
+# @mysetup/mqtt
 
-A utility for managing MQTT connections, subscriptions, publishing, and client caching, built on top of the [mqtt](https://www.npmjs.com/package/mqtt) library.
-
-## Features
-
-- Connect to MQTT brokers with custom configuration
-- Subscribe and unsubscribe to topics
-- Publish messages to topics
-- Handle connection events (connect, error, reconnect, close, offline)
-- Cache and reuse MQTT clients by `clientId`
-- Custom message callbacks
-- Integration with a logger and cache system
+MQTT helpers for creating connections, subscribing, publishing, and reusing clients.
 
 ## Installation
 
-```sh
-npm install @mysetup/mqtt-client
+```bash
+pnpm add @mysetup/mqtt
 ```
 
+## Supported libraries and runtimes
+
+| Supported              | Notes                           |
+| ---------------------- | ------------------------------- |
+| Node.js                | Full support                    |
+| Next.js server runtime | Supported in backend-only usage |
+| Browser apps           | Not supported                   |
+
 ## Usage
 
-```sh
-import { mqttCreateConnection, mqttSub, mqttPublish, mqttDisconnect } from "@mysetup/mqtt-client";
+```ts
+import {
+    mqttCreateConnection,
+    mqttDisconnect,
+    mqttPublish,
+    mqttSub,
+} from "@mysetup/mqtt";
 
-const clientId = "myClientId";
+const clientId = "app-client";
 const config = {
     protocol: "mqtt",
     host: "localhost",
     port: 1883,
     path: "",
-    username: "user",
-    password: "pass",
 };
 
-const topicList = ["my/topic"];
-
 mqttCreateConnection({
     clientId,
     config,
-    topicList,
-    messageCallback: (topic, message) => {
-        console.log(`Received on ${topic}: ${message}`);
+    topicList: ["updates/topic"],
+    messageCallback: (topic, payload) => {
+        console.log(topic, payload);
     },
-    environment: "development", // Optional: enables verbose logging
-});
-
-// Subscribe to topics
-mqttSub(topicList, clientId, (topic, message) => {
-    console.log(`Received: ${message} on ${topic}`);
+    environment: "development",
 });
 
-// Publish a message
-mqttPublish("my/topic", { hello: "world" }, clientId);
-
-// Disconnect
-mqttDisconnect({ clientId, config, topicList }, false);
+mqttSub(["updates/topic"], clientId);
+mqttPublish("updates/topic", { hello: "world" }, clientId);
+mqttDisconnect(
+    {
+        clientId,
+        config,
+        topicList: ["updates/topic"],
+        messageCallback: () => {},
+    },
+    false,
+);
 ```
 
-## Functions
-
-- mqttCreateConnection(props: ConnectionProps): MqttClient
-  Creates or retrieves a cached MQTT client and connects to the broker.
-
-- mqttSub(topicList, clientId, messageCallback?, environment?)
-  Subscribes to the given topics for the specified client.
-
-- mqttUnSub(topicList, clientId, environment?)
-  Unsubscribes from the given topics for the specified client.
-
-- mqttPublish(topic, message, clientId, environment?)
-  Publishes a message to a topic.
-
-- mqttDisconnect(props, reinit, environment?)
-  Disconnects the client and optionally reinitializes the connection.
-
-- getMqttClient(clientId)
-  Retrieves the cached MQTT client by ID.
-
-## License
+## Exports
 
-MIT
+- `mqttCreateConnection`
+- `mqttSub`
+- `mqttUnSub`
+- `mqttPublish`
+- `mqttDisconnect`
+- `getMqttClient`
+- `removeMqttClient`

package/dist/index.d.ts

@@ -1,2 +1 @@
 export * from "./mqttClient";
-//# sourceMappingURL=index.d.ts.map

package/dist/mqttClient.d.ts

@@ -25,4 +25,3 @@ declare const getMqttClient: (id: string) => mqtt.MqttClient | null;
 declare const removeMqttClient: (id: string) => void;
 export { mqttCreateConnection, mqttSub, mqttUnSub, mqttDisconnect, mqttPublish, getMqttClient, removeMqttClient, };
 export type { ConnectionProps, MqttConfigProps, MqttClient };
-//# sourceMappingURL=mqttClient.d.ts.map

package/package.json

@@ -1,45 +1,58 @@
 {
-    "name": "@mysetup/mqtt",
-    "version": "2.0.1",
-    "license": "MIT",
-    "main": "dist/index.js",
-    "files": [
-        "dist"
-    ],
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.js",
-            "require": "./dist/index.js"
-        },
-        "./package.json": "./package.json"
+  "name": "@mysetup/mqtt",
+  "version": "2.0.4",
+  "description": "MQTT client helpers for Node.js applications.",
+  "author": "krishnaraj <krishnaraj.webdev@gmail.com>",
+  "license": "MIT",
+  "keywords": [
+    "mqtt",
+    "iot",
+    "nodejs",
+    "typescript",
+    "messaging"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
     },
-    "scripts": {
-        "dev": "nodemon",
-        "lint": "eslint .",
-        "typecheck": "tsc --noEmit",
-        "build": "rm -rf ./dist && tsc",
-        "format": "prettier --write \"**/*.{ts,tsx,md,js}\"",
-        "checks": "pnpm typecheck && pnpm lint",
-        "clean": "rm -rf node_modules .swc dist pnpm-lock.yaml && echo \"✅  Successfully removed \""
-    },
-    "dependencies": {
-        "mqtt": "^5.10.3"
-    },
-    "devDependencies": {
-        "@mysetup/cache": "latest",
-        "@mysetup/eslint-config": "latest",
-        "@mysetup/logger": "latest",
-        "@mysetup/prettier-config": "latest",
-        "@mysetup/tsconfig": "latest",
-        "@types/node": "^22.16.4",
-        "nodemon": "3.1.7",
-        "ts-node": "^10.9.2",
-        "typescript": "5.5.4"
-    },
-    "prettier": "@mysetup/prettier-config",
-    "engines": {
-        "node": ">=20.15.1"
-    },
-    "packageManager": "pnpm@9.9.0"
-}
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "mqtt": "^5.10.3",
+    "@mysetup/logger": "^2.0.4",
+    "@mysetup/cache": "^2.0.4"
+  },
+  "devDependencies": {
+    "@types/node": "^22.16.4",
+    "nodemon": "3.1.7",
+    "ts-node": "^10.9.2",
+    "typescript": "5.5.4",
+    "@mysetup/eslint-config": "^2.0.5",
+    "@mysetup/tsconfig": "^2.0.4",
+    "@mysetup/prettier-config": "^2.0.4"
+  },
+  "prettier": "@mysetup/prettier-config",
+  "engines": {
+    "node": ">=20.15.1"
+  },
+  "scripts": {
+    "dev": "nodemon",
+    "lint": "node ../scripts/run-eslint.cjs .",
+    "typecheck": "tsc --noEmit",
+    "build": "node ../scripts/package-fs.cjs remove dist && tsc -p tsconfig.build.json",
+    "format": "prettier --write \"**/*.{ts,tsx,md,js}\"",
+    "checks": "pnpm typecheck && pnpm lint && pnpm build",
+    "clean": "node ../scripts/package-fs.cjs remove node_modules .swc dist pnpm-lock.yaml && echo \"Cleaned\""
+  }
+}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dist/mqttClient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mqttClient.d.ts","sourceRoot":"","sources":["../mqttClient.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAGvC,KAAK,YAAY,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,KAAK,CAAC;AAEpD,UAAU,eAAe;IACrB,QAAQ,EAAE,YAAY,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,eAAe;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,eAAe,CAAC;IACxB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1D,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAkED,QAAA,MAAM,OAAO,cACE,MAAM,EAAE,YACT,MAAM,gBACF,MAAM,SAwBvB,CAAC;AAEF,QAAA,MAAM,SAAS,cACA,MAAM,EAAE,YACT,MAAM,gBACF,MAAM,SAoBvB,CAAC;AAEF,QAAA,MAAM,cAAc,UACT,eAAe,UACd,OAAO,gBACD,MAAM,SAuBvB,CAAC;AAEF,QAAA,MAAM,WAAW,UACN,MAAM,WACJ,MAAM,YACL,MAAM,gBACF,MAAM,SAqBvB,CAAC;AAsBF,QAAA,MAAM,oBAAoB,UAAW,eAAe,2BAEnD,CAAC;AAEF,QAAA,MAAM,aAAa,OAAQ,MAAM,2BAEhC,CAAC;AAEF,QAAA,MAAM,gBAAgB,OAAQ,MAAM,SAGnC,CAAC;AAEF,OAAO,EACH,oBAAoB,EACpB,OAAO,EACP,SAAS,EACT,cAAc,EACd,WAAW,EACX,aAAa,EACb,gBAAgB,GACnB,CAAC;AAEF,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC"}

package/dist/test/test-mqtt.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=test-mqtt.d.ts.map

package/dist/test/test-mqtt.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"test-mqtt.d.ts","sourceRoot":"","sources":["../../test/test-mqtt.ts"],"names":[],"mappings":""}

package/dist/test/test-mqtt.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var logger_1 = require("@mysetup/logger");
-var mqttClient_1 = require("../mqttClient");
-var _a = process.env, ENVIRONMENT = _a.ENVIRONMENT, MQTT_HOST = _a.MQTT_HOST, MQTT_USERNAME = _a.MQTT_USERNAME, MQTT_PASSWORD = _a.MQTT_PASSWORD, MQTT_PORT = _a.MQTT_PORT;
-var CLIENT_ID = "testClient-".concat(Math.random().toString(16).slice(2, 8));
-(0, mqttClient_1.mqttCreateConnection)({
-    clientId: CLIENT_ID,
-    config: {
-        host: String(MQTT_HOST),
-        port: Number(MQTT_PORT),
-        protocol: "mqtts",
-        path: "",
-        username: MQTT_USERNAME,
-        password: MQTT_PASSWORD,
-    },
-    environment: String(ENVIRONMENT),
-    topicList: ["#"],
-    messageCallback: function (topic, message) {
-        logger_1.logger.info("Message received \u2192 topic: ".concat(topic, ", message: ").concat(message.toString()));
-    },
-});