viziot-mqtt-client-nodejs 1.0.7 → 2.0.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2018 VizIoT.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.
+MIT License
+
+Copyright (c) 2018 VizIoT.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.

package/README.md

@@ -1,102 +1,123 @@
 # viziot-mqtt-client-nodejs
 
-<img src="/logo.png" alt="drawing" height="200"/>
+<img src="/logo.png" alt="VizIoT.com" height="200"/>
 
-MQTT клиент node.js для сайта VizIoT.com позволяет отправлять данный с устройств на сервер VizIoT.com и получать новые значения параметров для управления устройством.
+A Promise-based MQTT client for the [VizIoT.com](http://viziot.com) IoT platform. It lets a
+Node.js device send data to VizIoT.com and receive parameter/command updates pushed from the
+dashboard. Written in TypeScript and published with type declarations, so it works out of the
+box in both TypeScript and plain JavaScript (CommonJS or ESM) projects.
 
-Установка
-=============
+> **Upgrading from 1.x?** Version 2.0.0 is a full rewrite with a breaking, Promise-based API.
+> See [CHANGELOG.md](./CHANGELOG.md) for the migration notes.
 
-`$ npm install viziot-mqtt-client-nodejs --save`
+## Installation
 
-Пример использования
-=============
+```sh
+npm install viziot-mqtt-client-nodejs
+```
+
+Requires Node.js 18 or later.
+
+## Quick start
 
-Пример подключается к брокеру и позволяет:
-- отправлять раз в минуту время, случайное число (от 1 до 100), и признак отправки данных.
-- управлять отправкой данных через сайт VizIoT.com.
+### TypeScript / ESM
 
-Для отправки данных на устройство пользователь должен укажет в настройках устройства что тип параметра "sendTestData" = "Вкл / Выкл 0-1". После этого на сайте у устройства появится переключатель, который при включении или выключении отправляет на устройство 0 или 1.
+```ts
+import { VizIoTMQTT } from 'viziot-mqtt-client-nodejs';
 
-```javascript
-'use strict';
-//#ключ и пароль устройства
-let keyDevice = '________________';
-let passDevice = '____________________';
+const client = new VizIoTMQTT(deviceKey, devicePassword);
 
-let sendTestData = 1;
-let idIntervalSend = 0;
-let intervalTime = 60000;
+client.on('error', (error) => console.error(error.message));
 
-let viziotMQTT = require('viziot-mqtt-client-nodejs');
-let viziotMQTTClient = new viziotMQTT(keyDevice, passDevice);
+await client.connect();
 
-viziotMQTTClient.connect(function (isConnect) {
-  if(isConnect){
-    clearInterval(idIntervalSend);
-    idIntervalSend = setInterval(function () {
-      sendDataToServer();
-    }, intervalTime);
-    viziotMQTTClient.startListenCommands(function (parameter, value) {
-      if(parameter == "sendTestData"){
-        sendTestData = value;
-      }
-    });
-  }
+await client.onCommand((parameter, value) => {
+  console.log('Received command:', parameter, value);
 });
 
-function getRandomInt(min, max) {
-  return Math.floor(Math.random() * (max - min + 1)) + min;
-}
-
-function sendDataToServer() {
-  if(sendTestData){
-    let packet = {
-      'date': parseInt(new Date().getTime()/1000),
-      'testData': getRandomInt(1, 100),
-      'sendTestData': sendTestData
-    };
-    viziotMQTTClient.sendDataToVizIoT(packet, function (err) {
-      if (err) {
-        console.log("Error sendDataToVizIoT", err);
-      }
-    });
-  }
-}
+await client.send({ temperature: 21.5 });
+```
+
+### CommonJS
+
+```js
+const { VizIoTMQTT } = require('viziot-mqtt-client-nodejs');
+
+const client = new VizIoTMQTT(deviceKey, devicePassword);
+
+client.connect().then(async () => {
+  await client.onCommand((parameter, value) => {
+    console.log('Received command:', parameter, value);
+  });
+  await client.send({ temperature: 21.5 });
+});
 ```
 
+Runnable versions of both examples live in [examples/](./examples).
+
+## API
+
+### `new VizIoTMQTT(deviceKey, devicePassword, brokerUrl?)`
+
+- `deviceKey` — device key from the VizIoT.com dashboard.
+- `devicePassword` — device password from the VizIoT.com dashboard.
+- `brokerUrl` — optional, defaults to `mqtt://viziot.com:48651`.
 
-<a name="api"></a>
-## Описание класса
+Throws a `VizIoTError` (code `INVALID_CREDENTIALS`) if the key or password has an invalid format.
 
-  * <a href="#constructor"><code><b>new viziotMQTT()</b></code></a>
-  * <a href="#connect"><code>viziotMQTT#<b>connect()</b></code></a>
-  * <a href="#sendDataToVizIoT"><code>viziotMQTT#<b>sendDataToVizIoT()</b></code></a>
-  * <a href="#startListenCommands"><code>viziotMQTT#<b>startListenCommands()</b></code></a>
-  
+### `client.connect(): Promise<void>`
 
-<a name="constructor"></a>
-### Конструктор let viziotMQTTClient = new viziotMQTT(keyDevice, passDevice [, mqttHost])
-- keyDevice: ключ устройства с сайта VizIoT.com
-- passDevice: пароль устройства с сайта VizIoT.com
-- mqttHost: не обязательный параметр. По умолчанию "mqtt://viziot.com:48651"
+Connects to the broker. The returned promise resolves on the first successful connection and
+rejects if the initial connection attempt fails (e.g. bad credentials). Automatic reconnection
+after a successful connection is handled internally; observe it via the `reconnect` event.
 
-<a name="connect"></a>
-### Подключение к серверу viziotMQTTClient.connect([callback])
-- callback: не обязательный параметр. Если указать, то будет вызван, когда MQTT клиент подключится к серверу.
+### `client.onCommand(listener): Promise<void>`
 
-<a name="sendDataToVizIoT"></a>
-### Отправка данных на сервер viziotMQTTClient.sendDataToVizIoT(data [, callback])
-- data: данные для отправки на сервер можно передавать строку в формате JSON или объект (ассоциативный массив).
-- callback: не обязательный параметр. Принимает два параметра:
-  - err: если есть ошибка, то будет указано ее текстовое описание, в противном случае undefined.
-  - isSend: при удачной отправки true при ошибке fasle.
-  
-<a name="startListenCommands"></a>
-### Обработчик получаемых команд viziotMQTTClient.startListenCommands(callback)
-- callback: если на устройство поступила команда, то вызывается функция callback с двумя параметрами:
-    - parameter - ключ команды или параметра
-    - value - значение 0 или 1
+Subscribes to parameter changes pushed from the VizIoT.com dashboard and registers `listener` as
+a `command` event handler. `listener` is called with `(parameter: string, value: string)`. Safe
+to call multiple times — the underlying MQTT subscription is only issued once.
+
+### `client.send(data): Promise<void>`
+
+Sends `data` (a plain object, an array, or a JSON string) to VizIoT.com with QoS 1. Rejects with
+a `VizIoTError` if `data` is empty or not JSON-serializable.
+
+### `client.disconnect(): Promise<void>`
+
+Closes the connection to the broker.
+
+### Events
+
+`VizIoTMQTT` extends `EventEmitter` and emits:
+
+| Event       | Payload                            | Description                                       |
+| ----------- | ---------------------------------- | ------------------------------------------------- |
+| `connect`   | —                                  | Emitted on every (re)connection.                  |
+| `reconnect` | —                                  | A reconnection attempt has started.               |
+| `close`     | —                                  | The connection was closed.                        |
+| `offline`   | —                                  | The client went offline.                          |
+| `error`     | `error: Error`                     | A transport-level error occurred.                 |
+| `command`   | `parameter: string, value: string` | A new parameter value was pushed from VizIoT.com. |
+
+### Errors
+
+Validation errors thrown by this library are instances of `VizIoTError`, with a `code` of
+`INVALID_CREDENTIALS`, `INVALID_PAYLOAD`, `EMPTY_PAYLOAD`, or `NOT_CONNECTED`. Transport-level
+failures (bad credentials rejected by the broker, network issues, etc.) are surfaced as the
+original `Error` from the underlying [`mqtt`](https://www.npmjs.com/package/mqtt) client.
+
+## Development
+
+```sh
+npm install
+npm run build       # bundle src/ to dist/ (CJS + ESM + .d.ts) with tsup
+npm test            # run the vitest suite
+npm run lint        # eslint
+npm run format      # prettier --write
+```
 
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for the release/versioning process.
 
+## License
 
+MIT — see [LICENSE](./LICENSE).

package/dist/index.cjs

@@ -0,0 +1,192 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  VizIoTError: () => VizIoTError,
+  VizIoTMQTT: () => VizIoTMQTT
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client.ts
+var import_node_events = require("events");
+var import_mqtt = __toESM(require("mqtt"), 1);
+
+// src/errors.ts
+var VizIoTError = class _VizIoTError extends Error {
+  code;
+  constructor(code, message) {
+    super(message);
+    this.name = "VizIoTError";
+    this.code = code;
+    Object.setPrototypeOf(this, _VizIoTError.prototype);
+  }
+};
+
+// src/client.ts
+var DEFAULT_BROKER_URL = "mqtt://viziot.com:48651";
+var DEVICE_KEY_LENGTH = 16;
+var DEVICE_PASSWORD_LENGTH = 20;
+var RECONNECT_PERIOD_MS = 5e3;
+function normalizeCredential(value) {
+  return value.replace(/[^A-Za-z0-9]/g, "");
+}
+function serializePayload(data) {
+  let payload;
+  if (typeof data === "string") {
+    try {
+      payload = JSON.stringify(JSON.parse(data));
+    } catch {
+      throw new VizIoTError("INVALID_PAYLOAD", "The data string is not valid JSON.");
+    }
+  } else if (Array.isArray(data) || typeof data === "object" && data !== null) {
+    payload = JSON.stringify(data);
+  } else {
+    throw new VizIoTError(
+      "INVALID_PAYLOAD",
+      "The data must be a string, an array, or a plain object."
+    );
+  }
+  if (payload.length <= 2) {
+    throw new VizIoTError("EMPTY_PAYLOAD", 'Refusing to send an empty payload ("{}" / "[]").');
+  }
+  return payload;
+}
+var VizIoTMQTT = class extends import_node_events.EventEmitter {
+  brokerUrl;
+  deviceKey;
+  devicePassword;
+  publishTopic;
+  subscribeTopic;
+  client = null;
+  subscribed = false;
+  /**
+   * @param deviceKey - device key from the VizIoT.com dashboard
+   * @param devicePassword - device password from the VizIoT.com dashboard
+   * @param brokerUrl - defaults to `mqtt://viziot.com:48651`
+   */
+  constructor(deviceKey, devicePassword, brokerUrl = DEFAULT_BROKER_URL) {
+    super();
+    const key = normalizeCredential(deviceKey);
+    const password = normalizeCredential(devicePassword);
+    if (key.length !== DEVICE_KEY_LENGTH || password.length !== DEVICE_PASSWORD_LENGTH) {
+      throw new VizIoTError(
+        "INVALID_CREDENTIALS",
+        "Device key or device password has an invalid format."
+      );
+    }
+    this.deviceKey = key;
+    this.devicePassword = password;
+    this.brokerUrl = brokerUrl;
+    this.publishTopic = `/devices/${key}/packet`;
+    this.subscribeTopic = `/devices/${key}/param/+`;
+  }
+  /** Connects to the VizIoT.com broker. Resolves once the connection is acknowledged. */
+  connect() {
+    return new Promise((resolve, reject) => {
+      const options = {
+        username: this.deviceKey,
+        password: this.devicePassword,
+        reconnectPeriod: RECONNECT_PERIOD_MS
+      };
+      const client = import_mqtt.default.connect(this.brokerUrl, options);
+      const onFirstConnect = () => {
+        client.removeListener("error", onFirstError);
+        this.emit("connect");
+        resolve();
+      };
+      const onFirstError = (error) => {
+        client.removeListener("connect", onFirstConnect);
+        client.end(true);
+        reject(error);
+      };
+      client.once("connect", onFirstConnect);
+      client.once("error", onFirstError);
+      client.on("reconnect", () => this.emit("reconnect"));
+      client.on("close", () => this.emit("close"));
+      client.on("offline", () => this.emit("offline"));
+      client.on("error", (error) => this.emit("error", error));
+      client.on("message", (topic, message) => {
+        const parameter = topic.slice(this.subscribeTopic.length - 1);
+        this.emit("command", parameter, message.toString());
+      });
+      this.client = client;
+    });
+  }
+  /** Ends the connection to the broker. */
+  disconnect() {
+    return new Promise((resolve, reject) => {
+      if (!this.client) {
+        resolve();
+        return;
+      }
+      this.client.end(false, {}, (error) => error ? reject(error) : resolve());
+    });
+  }
+  /**
+   * Subscribes to parameter changes pushed from the VizIoT.com dashboard and registers
+   * `listener` on the `command` event. Safe to call multiple times; the underlying MQTT
+   * subscription is only made once.
+   */
+  async onCommand(listener) {
+    if (!this.client) {
+      throw new VizIoTError("NOT_CONNECTED", "Call connect() before subscribing to commands.");
+    }
+    this.on("command", listener);
+    if (this.subscribed) {
+      return;
+    }
+    await new Promise((resolve, reject) => {
+      this.client.subscribe(this.subscribeTopic, (error) => error ? reject(error) : resolve());
+    });
+    this.subscribed = true;
+  }
+  /** Sends an object, array, or JSON string to the VizIoT.com server. */
+  async send(data) {
+    if (!this.client) {
+      throw new VizIoTError("NOT_CONNECTED", "Call connect() before sending data.");
+    }
+    const payload = serializePayload(data);
+    await new Promise((resolve, reject) => {
+      this.client.publish(
+        this.publishTopic,
+        payload,
+        { qos: 1 },
+        (error) => error ? reject(error) : resolve()
+      );
+    });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  VizIoTError,
+  VizIoTMQTT
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/client.ts","../src/errors.ts"],"sourcesContent":["export { VizIoTMQTT } from './client.js';\nexport type { VizIoTPayload, VizIoTMQTTEventMap } from './client.js';\nexport { VizIoTError } from './errors.js';\nexport type { VizIoTErrorCode } from './errors.js';\n","import { EventEmitter } from 'node:events';\nimport mqtt, { type IClientOptions, type MqttClient } from 'mqtt';\nimport { VizIoTError } from './errors.js';\n\nconst DEFAULT_BROKER_URL = 'mqtt://viziot.com:48651';\nconst DEVICE_KEY_LENGTH = 16;\nconst DEVICE_PASSWORD_LENGTH = 20;\nconst RECONNECT_PERIOD_MS = 5000;\n\n/** Data accepted by {@link VizIoTMQTT.send}: a JSON-serializable object/array, or a JSON string. */\nexport type VizIoTPayload = Record<string, unknown> | unknown[] | string;\n\nexport interface VizIoTMQTTEventMap {\n  connect: [];\n  reconnect: [];\n  close: [];\n  offline: [];\n  error: [error: Error];\n  command: [parameter: string, value: string];\n}\n\nfunction normalizeCredential(value: string): string {\n  return value.replace(/[^A-Za-z0-9]/g, '');\n}\n\nfunction serializePayload(data: VizIoTPayload): string {\n  let payload: string;\n\n  if (typeof data === 'string') {\n    try {\n      payload = JSON.stringify(JSON.parse(data));\n    } catch {\n      throw new VizIoTError('INVALID_PAYLOAD', 'The data string is not valid JSON.');\n    }\n  } else if (Array.isArray(data) || (typeof data === 'object' && data !== null)) {\n    payload = JSON.stringify(data);\n  } else {\n    throw new VizIoTError(\n      'INVALID_PAYLOAD',\n      'The data must be a string, an array, or a plain object.',\n    );\n  }\n\n  if (payload.length <= 2) {\n    throw new VizIoTError('EMPTY_PAYLOAD', 'Refusing to send an empty payload (\"{}\" / \"[]\").');\n  }\n\n  return payload;\n}\n\n/**\n * MQTT client for the VizIoT.com IoT platform.\n *\n * Emits the standard connection lifecycle events (`connect`, `reconnect`, `close`,\n * `offline`, `error`) plus a `command` event whenever the platform pushes a new\n * parameter value to the device.\n */\n// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging -- merged below with `declare interface VizIoTMQTT` to type the inherited EventEmitter methods.\nexport class VizIoTMQTT extends EventEmitter {\n  readonly brokerUrl: string;\n\n  private readonly deviceKey: string;\n  private readonly devicePassword: string;\n  private readonly publishTopic: string;\n  private readonly subscribeTopic: string;\n  private client: MqttClient | null = null;\n  private subscribed = false;\n\n  /**\n   * @param deviceKey - device key from the VizIoT.com dashboard\n   * @param devicePassword - device password from the VizIoT.com dashboard\n   * @param brokerUrl - defaults to `mqtt://viziot.com:48651`\n   */\n  constructor(deviceKey: string, devicePassword: string, brokerUrl: string = DEFAULT_BROKER_URL) {\n    super();\n\n    const key = normalizeCredential(deviceKey);\n    const password = normalizeCredential(devicePassword);\n\n    if (key.length !== DEVICE_KEY_LENGTH || password.length !== DEVICE_PASSWORD_LENGTH) {\n      throw new VizIoTError(\n        'INVALID_CREDENTIALS',\n        'Device key or device password has an invalid format.',\n      );\n    }\n\n    this.deviceKey = key;\n    this.devicePassword = password;\n    this.brokerUrl = brokerUrl;\n    this.publishTopic = `/devices/${key}/packet`;\n    this.subscribeTopic = `/devices/${key}/param/+`;\n  }\n\n  /** Connects to the VizIoT.com broker. Resolves once the connection is acknowledged. */\n  connect(): Promise<void> {\n    return new Promise((resolve, reject) => {\n      const options: IClientOptions = {\n        username: this.deviceKey,\n        password: this.devicePassword,\n        reconnectPeriod: RECONNECT_PERIOD_MS,\n      };\n\n      const client = mqtt.connect(this.brokerUrl, options);\n\n      const onFirstConnect = () => {\n        client.removeListener('error', onFirstError);\n        this.emit('connect');\n        resolve();\n      };\n      const onFirstError = (error: Error) => {\n        client.removeListener('connect', onFirstConnect);\n        client.end(true);\n        reject(error);\n      };\n\n      client.once('connect', onFirstConnect);\n      client.once('error', onFirstError);\n\n      client.on('reconnect', () => this.emit('reconnect'));\n      client.on('close', () => this.emit('close'));\n      client.on('offline', () => this.emit('offline'));\n      client.on('error', (error) => this.emit('error', error));\n      client.on('message', (topic, message) => {\n        const parameter = topic.slice(this.subscribeTopic.length - 1);\n        this.emit('command', parameter, message.toString());\n      });\n\n      this.client = client;\n    });\n  }\n\n  /** Ends the connection to the broker. */\n  disconnect(): Promise<void> {\n    return new Promise((resolve, reject) => {\n      if (!this.client) {\n        resolve();\n        return;\n      }\n      this.client.end(false, {}, (error) => (error ? reject(error) : resolve()));\n    });\n  }\n\n  /**\n   * Subscribes to parameter changes pushed from the VizIoT.com dashboard and registers\n   * `listener` on the `command` event. Safe to call multiple times; the underlying MQTT\n   * subscription is only made once.\n   */\n  async onCommand(listener: (parameter: string, value: string) => void): Promise<void> {\n    if (!this.client) {\n      throw new VizIoTError('NOT_CONNECTED', 'Call connect() before subscribing to commands.');\n    }\n\n    this.on('command', listener);\n\n    if (this.subscribed) {\n      return;\n    }\n\n    await new Promise<void>((resolve, reject) => {\n      this.client!.subscribe(this.subscribeTopic, (error) => (error ? reject(error) : resolve()));\n    });\n    this.subscribed = true;\n  }\n\n  /** Sends an object, array, or JSON string to the VizIoT.com server. */\n  async send(data: VizIoTPayload): Promise<void> {\n    if (!this.client) {\n      throw new VizIoTError('NOT_CONNECTED', 'Call connect() before sending data.');\n    }\n\n    const payload = serializePayload(data);\n\n    await new Promise<void>((resolve, reject) => {\n      this.client!.publish(this.publishTopic, payload, { qos: 1 }, (error) =>\n        error ? reject(error) : resolve(),\n      );\n    });\n  }\n}\n\n// Intentional declaration merging to give EventEmitter's `on`/`once`/`emit` precise,\n// per-event types (the same pattern Node's own type definitions use).\n// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging\nexport declare interface VizIoTMQTT {\n  on<K extends keyof VizIoTMQTTEventMap>(\n    event: K,\n    listener: (...args: VizIoTMQTTEventMap[K]) => void,\n  ): this;\n  once<K extends keyof VizIoTMQTTEventMap>(\n    event: K,\n    listener: (...args: VizIoTMQTTEventMap[K]) => void,\n  ): this;\n  emit<K extends keyof VizIoTMQTTEventMap>(event: K, ...args: VizIoTMQTTEventMap[K]): boolean;\n}\n","export type VizIoTErrorCode =\n  'INVALID_CREDENTIALS' | 'INVALID_PAYLOAD' | 'EMPTY_PAYLOAD' | 'NOT_CONNECTED';\n\n/**\n * Error thrown for any misuse of the {@link VizIoTMQTT} client\n * (invalid credentials, invalid payloads, calling methods before `connect()`, etc).\n * Transport-level failures (authentication, network, protocol) are surfaced as-is\n * from the underlying `mqtt` client instead.\n */\nexport class VizIoTError extends Error {\n  readonly code: VizIoTErrorCode;\n\n  constructor(code: VizIoTErrorCode, message: string) {\n    super(message);\n    this.name = 'VizIoTError';\n    this.code = code;\n    Object.setPrototypeOf(this, VizIoTError.prototype);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,yBAA6B;AAC7B,kBAA2D;;;ACQpD,IAAM,cAAN,MAAM,qBAAoB,MAAM;AAAA,EAC5B;AAAA,EAET,YAAY,MAAuB,SAAiB;AAClD,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,WAAO,eAAe,MAAM,aAAY,SAAS;AAAA,EACnD;AACF;;;ADdA,IAAM,qBAAqB;AAC3B,IAAM,oBAAoB;AAC1B,IAAM,yBAAyB;AAC/B,IAAM,sBAAsB;AAc5B,SAAS,oBAAoB,OAAuB;AAClD,SAAO,MAAM,QAAQ,iBAAiB,EAAE;AAC1C;AAEA,SAAS,iBAAiB,MAA6B;AACrD,MAAI;AAEJ,MAAI,OAAO,SAAS,UAAU;AAC5B,QAAI;AACF,gBAAU,KAAK,UAAU,KAAK,MAAM,IAAI,CAAC;AAAA,IAC3C,QAAQ;AACN,YAAM,IAAI,YAAY,mBAAmB,oCAAoC;AAAA,IAC/E;AAAA,EACF,WAAW,MAAM,QAAQ,IAAI,KAAM,OAAO,SAAS,YAAY,SAAS,MAAO;AAC7E,cAAU,KAAK,UAAU,IAAI;AAAA,EAC/B,OAAO;AACL,UAAM,IAAI;AAAA,MACR;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAEA,MAAI,QAAQ,UAAU,GAAG;AACvB,UAAM,IAAI,YAAY,iBAAiB,kDAAkD;AAAA,EAC3F;AAEA,SAAO;AACT;AAUO,IAAM,aAAN,cAAyB,gCAAa;AAAA,EAClC;AAAA,EAEQ;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACT,SAA4B;AAAA,EAC5B,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOrB,YAAY,WAAmB,gBAAwB,YAAoB,oBAAoB;AAC7F,UAAM;AAEN,UAAM,MAAM,oBAAoB,SAAS;AACzC,UAAM,WAAW,oBAAoB,cAAc;AAEnD,QAAI,IAAI,WAAW,qBAAqB,SAAS,WAAW,wBAAwB;AAClF,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,SAAK,YAAY;AACjB,SAAK,iBAAiB;AACtB,SAAK,YAAY;AACjB,SAAK,eAAe,YAAY,GAAG;AACnC,SAAK,iBAAiB,YAAY,GAAG;AAAA,EACvC;AAAA;AAAA,EAGA,UAAyB;AACvB,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,YAAM,UAA0B;AAAA,QAC9B,UAAU,KAAK;AAAA,QACf,UAAU,KAAK;AAAA,QACf,iBAAiB;AAAA,MACnB;AAEA,YAAM,SAAS,YAAAA,QAAK,QAAQ,KAAK,WAAW,OAAO;AAEnD,YAAM,iBAAiB,MAAM;AAC3B,eAAO,eAAe,SAAS,YAAY;AAC3C,aAAK,KAAK,SAAS;AACnB,gBAAQ;AAAA,MACV;AACA,YAAM,eAAe,CAAC,UAAiB;AACrC,eAAO,eAAe,WAAW,cAAc;AAC/C,eAAO,IAAI,IAAI;AACf,eAAO,KAAK;AAAA,MACd;AAEA,aAAO,KAAK,WAAW,cAAc;AACrC,aAAO,KAAK,SAAS,YAAY;AAEjC,aAAO,GAAG,aAAa,MAAM,KAAK,KAAK,WAAW,CAAC;AACnD,aAAO,GAAG,SAAS,MAAM,KAAK,KAAK,OAAO,CAAC;AAC3C,aAAO,GAAG,WAAW,MAAM,KAAK,KAAK,SAAS,CAAC;AAC/C,aAAO,GAAG,SAAS,CAAC,UAAU,KAAK,KAAK,SAAS,KAAK,CAAC;AACvD,aAAO,GAAG,WAAW,CAAC,OAAO,YAAY;AACvC,cAAM,YAAY,MAAM,MAAM,KAAK,eAAe,SAAS,CAAC;AAC5D,aAAK,KAAK,WAAW,WAAW,QAAQ,SAAS,CAAC;AAAA,MACpD,CAAC;AAED,WAAK,SAAS;AAAA,IAChB,CAAC;AAAA,EACH;AAAA;AAAA,EAGA,aAA4B;AAC1B,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAI,CAAC,KAAK,QAAQ;AAChB,gBAAQ;AACR;AAAA,MACF;AACA,WAAK,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,UAAW,QAAQ,OAAO,KAAK,IAAI,QAAQ,CAAE;AAAA,IAC3E,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,UAAU,UAAqE;AACnF,QAAI,CAAC,KAAK,QAAQ;AAChB,YAAM,IAAI,YAAY,iBAAiB,gDAAgD;AAAA,IACzF;AAEA,SAAK,GAAG,WAAW,QAAQ;AAE3B,QAAI,KAAK,YAAY;AACnB;AAAA,IACF;AAEA,UAAM,IAAI,QAAc,CAAC,SAAS,WAAW;AAC3C,WAAK,OAAQ,UAAU,KAAK,gBAAgB,CAAC,UAAW,QAAQ,OAAO,KAAK,IAAI,QAAQ,CAAE;AAAA,IAC5F,CAAC;AACD,SAAK,aAAa;AAAA,EACpB;AAAA;AAAA,EAGA,MAAM,KAAK,MAAoC;AAC7C,QAAI,CAAC,KAAK,QAAQ;AAChB,YAAM,IAAI,YAAY,iBAAiB,qCAAqC;AAAA,IAC9E;AAEA,UAAM,UAAU,iBAAiB,IAAI;AAErC,UAAM,IAAI,QAAc,CAAC,SAAS,WAAW;AAC3C,WAAK,OAAQ;AAAA,QAAQ,KAAK;AAAA,QAAc;AAAA,QAAS,EAAE,KAAK,EAAE;AAAA,QAAG,CAAC,UAC5D,QAAQ,OAAO,KAAK,IAAI,QAAQ;AAAA,MAClC;AAAA,IACF,CAAC;AAAA,EACH;AACF;","names":["mqtt"]}

package/dist/index.d.cts

@@ -0,0 +1,65 @@
+import { EventEmitter } from 'node:events';
+
+/** Data accepted by {@link VizIoTMQTT.send}: a JSON-serializable object/array, or a JSON string. */
+type VizIoTPayload = Record<string, unknown> | unknown[] | string;
+interface VizIoTMQTTEventMap {
+    connect: [];
+    reconnect: [];
+    close: [];
+    offline: [];
+    error: [error: Error];
+    command: [parameter: string, value: string];
+}
+/**
+ * MQTT client for the VizIoT.com IoT platform.
+ *
+ * Emits the standard connection lifecycle events (`connect`, `reconnect`, `close`,
+ * `offline`, `error`) plus a `command` event whenever the platform pushes a new
+ * parameter value to the device.
+ */
+declare class VizIoTMQTT extends EventEmitter {
+    readonly brokerUrl: string;
+    private readonly deviceKey;
+    private readonly devicePassword;
+    private readonly publishTopic;
+    private readonly subscribeTopic;
+    private client;
+    private subscribed;
+    /**
+     * @param deviceKey - device key from the VizIoT.com dashboard
+     * @param devicePassword - device password from the VizIoT.com dashboard
+     * @param brokerUrl - defaults to `mqtt://viziot.com:48651`
+     */
+    constructor(deviceKey: string, devicePassword: string, brokerUrl?: string);
+    /** Connects to the VizIoT.com broker. Resolves once the connection is acknowledged. */
+    connect(): Promise<void>;
+    /** Ends the connection to the broker. */
+    disconnect(): Promise<void>;
+    /**
+     * Subscribes to parameter changes pushed from the VizIoT.com dashboard and registers
+     * `listener` on the `command` event. Safe to call multiple times; the underlying MQTT
+     * subscription is only made once.
+     */
+    onCommand(listener: (parameter: string, value: string) => void): Promise<void>;
+    /** Sends an object, array, or JSON string to the VizIoT.com server. */
+    send(data: VizIoTPayload): Promise<void>;
+}
+declare interface VizIoTMQTT {
+    on<K extends keyof VizIoTMQTTEventMap>(event: K, listener: (...args: VizIoTMQTTEventMap[K]) => void): this;
+    once<K extends keyof VizIoTMQTTEventMap>(event: K, listener: (...args: VizIoTMQTTEventMap[K]) => void): this;
+    emit<K extends keyof VizIoTMQTTEventMap>(event: K, ...args: VizIoTMQTTEventMap[K]): boolean;
+}
+
+type VizIoTErrorCode = 'INVALID_CREDENTIALS' | 'INVALID_PAYLOAD' | 'EMPTY_PAYLOAD' | 'NOT_CONNECTED';
+/**
+ * Error thrown for any misuse of the {@link VizIoTMQTT} client
+ * (invalid credentials, invalid payloads, calling methods before `connect()`, etc).
+ * Transport-level failures (authentication, network, protocol) are surfaced as-is
+ * from the underlying `mqtt` client instead.
+ */
+declare class VizIoTError extends Error {
+    readonly code: VizIoTErrorCode;
+    constructor(code: VizIoTErrorCode, message: string);
+}
+
+export { VizIoTError, type VizIoTErrorCode, VizIoTMQTT, type VizIoTMQTTEventMap, type VizIoTPayload };

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import { EventEmitter } from 'node:events';
+
+/** Data accepted by {@link VizIoTMQTT.send}: a JSON-serializable object/array, or a JSON string. */
+type VizIoTPayload = Record<string, unknown> | unknown[] | string;
+interface VizIoTMQTTEventMap {
+    connect: [];
+    reconnect: [];
+    close: [];
+    offline: [];
+    error: [error: Error];
+    command: [parameter: string, value: string];
+}
+/**
+ * MQTT client for the VizIoT.com IoT platform.
+ *
+ * Emits the standard connection lifecycle events (`connect`, `reconnect`, `close`,
+ * `offline`, `error`) plus a `command` event whenever the platform pushes a new
+ * parameter value to the device.
+ */
+declare class VizIoTMQTT extends EventEmitter {
+    readonly brokerUrl: string;
+    private readonly deviceKey;
+    private readonly devicePassword;
+    private readonly publishTopic;
+    private readonly subscribeTopic;
+    private client;
+    private subscribed;
+    /**
+     * @param deviceKey - device key from the VizIoT.com dashboard
+     * @param devicePassword - device password from the VizIoT.com dashboard
+     * @param brokerUrl - defaults to `mqtt://viziot.com:48651`
+     */
+    constructor(deviceKey: string, devicePassword: string, brokerUrl?: string);
+    /** Connects to the VizIoT.com broker. Resolves once the connection is acknowledged. */
+    connect(): Promise<void>;
+    /** Ends the connection to the broker. */
+    disconnect(): Promise<void>;
+    /**
+     * Subscribes to parameter changes pushed from the VizIoT.com dashboard and registers
+     * `listener` on the `command` event. Safe to call multiple times; the underlying MQTT
+     * subscription is only made once.
+     */
+    onCommand(listener: (parameter: string, value: string) => void): Promise<void>;
+    /** Sends an object, array, or JSON string to the VizIoT.com server. */
+    send(data: VizIoTPayload): Promise<void>;
+}
+declare interface VizIoTMQTT {
+    on<K extends keyof VizIoTMQTTEventMap>(event: K, listener: (...args: VizIoTMQTTEventMap[K]) => void): this;
+    once<K extends keyof VizIoTMQTTEventMap>(event: K, listener: (...args: VizIoTMQTTEventMap[K]) => void): this;
+    emit<K extends keyof VizIoTMQTTEventMap>(event: K, ...args: VizIoTMQTTEventMap[K]): boolean;
+}
+
+type VizIoTErrorCode = 'INVALID_CREDENTIALS' | 'INVALID_PAYLOAD' | 'EMPTY_PAYLOAD' | 'NOT_CONNECTED';
+/**
+ * Error thrown for any misuse of the {@link VizIoTMQTT} client
+ * (invalid credentials, invalid payloads, calling methods before `connect()`, etc).
+ * Transport-level failures (authentication, network, protocol) are surfaced as-is
+ * from the underlying `mqtt` client instead.
+ */
+declare class VizIoTError extends Error {
+    readonly code: VizIoTErrorCode;
+    constructor(code: VizIoTErrorCode, message: string);
+}
+
+export { VizIoTError, type VizIoTErrorCode, VizIoTMQTT, type VizIoTMQTTEventMap, type VizIoTPayload };

package/dist/index.js

@@ -0,0 +1,154 @@
+// src/client.ts
+import { EventEmitter } from "events";
+import mqtt from "mqtt";
+
+// src/errors.ts
+var VizIoTError = class _VizIoTError extends Error {
+  code;
+  constructor(code, message) {
+    super(message);
+    this.name = "VizIoTError";
+    this.code = code;
+    Object.setPrototypeOf(this, _VizIoTError.prototype);
+  }
+};
+
+// src/client.ts
+var DEFAULT_BROKER_URL = "mqtt://viziot.com:48651";
+var DEVICE_KEY_LENGTH = 16;
+var DEVICE_PASSWORD_LENGTH = 20;
+var RECONNECT_PERIOD_MS = 5e3;
+function normalizeCredential(value) {
+  return value.replace(/[^A-Za-z0-9]/g, "");
+}
+function serializePayload(data) {
+  let payload;
+  if (typeof data === "string") {
+    try {
+      payload = JSON.stringify(JSON.parse(data));
+    } catch {
+      throw new VizIoTError("INVALID_PAYLOAD", "The data string is not valid JSON.");
+    }
+  } else if (Array.isArray(data) || typeof data === "object" && data !== null) {
+    payload = JSON.stringify(data);
+  } else {
+    throw new VizIoTError(
+      "INVALID_PAYLOAD",
+      "The data must be a string, an array, or a plain object."
+    );
+  }
+  if (payload.length <= 2) {
+    throw new VizIoTError("EMPTY_PAYLOAD", 'Refusing to send an empty payload ("{}" / "[]").');
+  }
+  return payload;
+}
+var VizIoTMQTT = class extends EventEmitter {
+  brokerUrl;
+  deviceKey;
+  devicePassword;
+  publishTopic;
+  subscribeTopic;
+  client = null;
+  subscribed = false;
+  /**
+   * @param deviceKey - device key from the VizIoT.com dashboard
+   * @param devicePassword - device password from the VizIoT.com dashboard
+   * @param brokerUrl - defaults to `mqtt://viziot.com:48651`
+   */
+  constructor(deviceKey, devicePassword, brokerUrl = DEFAULT_BROKER_URL) {
+    super();
+    const key = normalizeCredential(deviceKey);
+    const password = normalizeCredential(devicePassword);
+    if (key.length !== DEVICE_KEY_LENGTH || password.length !== DEVICE_PASSWORD_LENGTH) {
+      throw new VizIoTError(
+        "INVALID_CREDENTIALS",
+        "Device key or device password has an invalid format."
+      );
+    }
+    this.deviceKey = key;
+    this.devicePassword = password;
+    this.brokerUrl = brokerUrl;
+    this.publishTopic = `/devices/${key}/packet`;
+    this.subscribeTopic = `/devices/${key}/param/+`;
+  }
+  /** Connects to the VizIoT.com broker. Resolves once the connection is acknowledged. */
+  connect() {
+    return new Promise((resolve, reject) => {
+      const options = {
+        username: this.deviceKey,
+        password: this.devicePassword,
+        reconnectPeriod: RECONNECT_PERIOD_MS
+      };
+      const client = mqtt.connect(this.brokerUrl, options);
+      const onFirstConnect = () => {
+        client.removeListener("error", onFirstError);
+        this.emit("connect");
+        resolve();
+      };
+      const onFirstError = (error) => {
+        client.removeListener("connect", onFirstConnect);
+        client.end(true);
+        reject(error);
+      };
+      client.once("connect", onFirstConnect);
+      client.once("error", onFirstError);
+      client.on("reconnect", () => this.emit("reconnect"));
+      client.on("close", () => this.emit("close"));
+      client.on("offline", () => this.emit("offline"));
+      client.on("error", (error) => this.emit("error", error));
+      client.on("message", (topic, message) => {
+        const parameter = topic.slice(this.subscribeTopic.length - 1);
+        this.emit("command", parameter, message.toString());
+      });
+      this.client = client;
+    });
+  }
+  /** Ends the connection to the broker. */
+  disconnect() {
+    return new Promise((resolve, reject) => {
+      if (!this.client) {
+        resolve();
+        return;
+      }
+      this.client.end(false, {}, (error) => error ? reject(error) : resolve());
+    });
+  }
+  /**
+   * Subscribes to parameter changes pushed from the VizIoT.com dashboard and registers
+   * `listener` on the `command` event. Safe to call multiple times; the underlying MQTT
+   * subscription is only made once.
+   */
+  async onCommand(listener) {
+    if (!this.client) {
+      throw new VizIoTError("NOT_CONNECTED", "Call connect() before subscribing to commands.");
+    }
+    this.on("command", listener);
+    if (this.subscribed) {
+      return;
+    }
+    await new Promise((resolve, reject) => {
+      this.client.subscribe(this.subscribeTopic, (error) => error ? reject(error) : resolve());
+    });
+    this.subscribed = true;
+  }
+  /** Sends an object, array, or JSON string to the VizIoT.com server. */
+  async send(data) {
+    if (!this.client) {
+      throw new VizIoTError("NOT_CONNECTED", "Call connect() before sending data.");
+    }
+    const payload = serializePayload(data);
+    await new Promise((resolve, reject) => {
+      this.client.publish(
+        this.publishTopic,
+        payload,
+        { qos: 1 },
+        (error) => error ? reject(error) : resolve()
+      );
+    });
+  }
+};
+export {
+  VizIoTError,
+  VizIoTMQTT
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts","../src/errors.ts"],"sourcesContent":["import { EventEmitter } from 'node:events';\nimport mqtt, { type IClientOptions, type MqttClient } from 'mqtt';\nimport { VizIoTError } from './errors.js';\n\nconst DEFAULT_BROKER_URL = 'mqtt://viziot.com:48651';\nconst DEVICE_KEY_LENGTH = 16;\nconst DEVICE_PASSWORD_LENGTH = 20;\nconst RECONNECT_PERIOD_MS = 5000;\n\n/** Data accepted by {@link VizIoTMQTT.send}: a JSON-serializable object/array, or a JSON string. */\nexport type VizIoTPayload = Record<string, unknown> | unknown[] | string;\n\nexport interface VizIoTMQTTEventMap {\n  connect: [];\n  reconnect: [];\n  close: [];\n  offline: [];\n  error: [error: Error];\n  command: [parameter: string, value: string];\n}\n\nfunction normalizeCredential(value: string): string {\n  return value.replace(/[^A-Za-z0-9]/g, '');\n}\n\nfunction serializePayload(data: VizIoTPayload): string {\n  let payload: string;\n\n  if (typeof data === 'string') {\n    try {\n      payload = JSON.stringify(JSON.parse(data));\n    } catch {\n      throw new VizIoTError('INVALID_PAYLOAD', 'The data string is not valid JSON.');\n    }\n  } else if (Array.isArray(data) || (typeof data === 'object' && data !== null)) {\n    payload = JSON.stringify(data);\n  } else {\n    throw new VizIoTError(\n      'INVALID_PAYLOAD',\n      'The data must be a string, an array, or a plain object.',\n    );\n  }\n\n  if (payload.length <= 2) {\n    throw new VizIoTError('EMPTY_PAYLOAD', 'Refusing to send an empty payload (\"{}\" / \"[]\").');\n  }\n\n  return payload;\n}\n\n/**\n * MQTT client for the VizIoT.com IoT platform.\n *\n * Emits the standard connection lifecycle events (`connect`, `reconnect`, `close`,\n * `offline`, `error`) plus a `command` event whenever the platform pushes a new\n * parameter value to the device.\n */\n// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging -- merged below with `declare interface VizIoTMQTT` to type the inherited EventEmitter methods.\nexport class VizIoTMQTT extends EventEmitter {\n  readonly brokerUrl: string;\n\n  private readonly deviceKey: string;\n  private readonly devicePassword: string;\n  private readonly publishTopic: string;\n  private readonly subscribeTopic: string;\n  private client: MqttClient | null = null;\n  private subscribed = false;\n\n  /**\n   * @param deviceKey - device key from the VizIoT.com dashboard\n   * @param devicePassword - device password from the VizIoT.com dashboard\n   * @param brokerUrl - defaults to `mqtt://viziot.com:48651`\n   */\n  constructor(deviceKey: string, devicePassword: string, brokerUrl: string = DEFAULT_BROKER_URL) {\n    super();\n\n    const key = normalizeCredential(deviceKey);\n    const password = normalizeCredential(devicePassword);\n\n    if (key.length !== DEVICE_KEY_LENGTH || password.length !== DEVICE_PASSWORD_LENGTH) {\n      throw new VizIoTError(\n        'INVALID_CREDENTIALS',\n        'Device key or device password has an invalid format.',\n      );\n    }\n\n    this.deviceKey = key;\n    this.devicePassword = password;\n    this.brokerUrl = brokerUrl;\n    this.publishTopic = `/devices/${key}/packet`;\n    this.subscribeTopic = `/devices/${key}/param/+`;\n  }\n\n  /** Connects to the VizIoT.com broker. Resolves once the connection is acknowledged. */\n  connect(): Promise<void> {\n    return new Promise((resolve, reject) => {\n      const options: IClientOptions = {\n        username: this.deviceKey,\n        password: this.devicePassword,\n        reconnectPeriod: RECONNECT_PERIOD_MS,\n      };\n\n      const client = mqtt.connect(this.brokerUrl, options);\n\n      const onFirstConnect = () => {\n        client.removeListener('error', onFirstError);\n        this.emit('connect');\n        resolve();\n      };\n      const onFirstError = (error: Error) => {\n        client.removeListener('connect', onFirstConnect);\n        client.end(true);\n        reject(error);\n      };\n\n      client.once('connect', onFirstConnect);\n      client.once('error', onFirstError);\n\n      client.on('reconnect', () => this.emit('reconnect'));\n      client.on('close', () => this.emit('close'));\n      client.on('offline', () => this.emit('offline'));\n      client.on('error', (error) => this.emit('error', error));\n      client.on('message', (topic, message) => {\n        const parameter = topic.slice(this.subscribeTopic.length - 1);\n        this.emit('command', parameter, message.toString());\n      });\n\n      this.client = client;\n    });\n  }\n\n  /** Ends the connection to the broker. */\n  disconnect(): Promise<void> {\n    return new Promise((resolve, reject) => {\n      if (!this.client) {\n        resolve();\n        return;\n      }\n      this.client.end(false, {}, (error) => (error ? reject(error) : resolve()));\n    });\n  }\n\n  /**\n   * Subscribes to parameter changes pushed from the VizIoT.com dashboard and registers\n   * `listener` on the `command` event. Safe to call multiple times; the underlying MQTT\n   * subscription is only made once.\n   */\n  async onCommand(listener: (parameter: string, value: string) => void): Promise<void> {\n    if (!this.client) {\n      throw new VizIoTError('NOT_CONNECTED', 'Call connect() before subscribing to commands.');\n    }\n\n    this.on('command', listener);\n\n    if (this.subscribed) {\n      return;\n    }\n\n    await new Promise<void>((resolve, reject) => {\n      this.client!.subscribe(this.subscribeTopic, (error) => (error ? reject(error) : resolve()));\n    });\n    this.subscribed = true;\n  }\n\n  /** Sends an object, array, or JSON string to the VizIoT.com server. */\n  async send(data: VizIoTPayload): Promise<void> {\n    if (!this.client) {\n      throw new VizIoTError('NOT_CONNECTED', 'Call connect() before sending data.');\n    }\n\n    const payload = serializePayload(data);\n\n    await new Promise<void>((resolve, reject) => {\n      this.client!.publish(this.publishTopic, payload, { qos: 1 }, (error) =>\n        error ? reject(error) : resolve(),\n      );\n    });\n  }\n}\n\n// Intentional declaration merging to give EventEmitter's `on`/`once`/`emit` precise,\n// per-event types (the same pattern Node's own type definitions use).\n// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging\nexport declare interface VizIoTMQTT {\n  on<K extends keyof VizIoTMQTTEventMap>(\n    event: K,\n    listener: (...args: VizIoTMQTTEventMap[K]) => void,\n  ): this;\n  once<K extends keyof VizIoTMQTTEventMap>(\n    event: K,\n    listener: (...args: VizIoTMQTTEventMap[K]) => void,\n  ): this;\n  emit<K extends keyof VizIoTMQTTEventMap>(event: K, ...args: VizIoTMQTTEventMap[K]): boolean;\n}\n","export type VizIoTErrorCode =\n  'INVALID_CREDENTIALS' | 'INVALID_PAYLOAD' | 'EMPTY_PAYLOAD' | 'NOT_CONNECTED';\n\n/**\n * Error thrown for any misuse of the {@link VizIoTMQTT} client\n * (invalid credentials, invalid payloads, calling methods before `connect()`, etc).\n * Transport-level failures (authentication, network, protocol) are surfaced as-is\n * from the underlying `mqtt` client instead.\n */\nexport class VizIoTError extends Error {\n  readonly code: VizIoTErrorCode;\n\n  constructor(code: VizIoTErrorCode, message: string) {\n    super(message);\n    this.name = 'VizIoTError';\n    this.code = code;\n    Object.setPrototypeOf(this, VizIoTError.prototype);\n  }\n}\n"],"mappings":";AAAA,SAAS,oBAAoB;AAC7B,OAAO,UAAoD;;;ACQpD,IAAM,cAAN,MAAM,qBAAoB,MAAM;AAAA,EAC5B;AAAA,EAET,YAAY,MAAuB,SAAiB;AAClD,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,WAAO,eAAe,MAAM,aAAY,SAAS;AAAA,EACnD;AACF;;;ADdA,IAAM,qBAAqB;AAC3B,IAAM,oBAAoB;AAC1B,IAAM,yBAAyB;AAC/B,IAAM,sBAAsB;AAc5B,SAAS,oBAAoB,OAAuB;AAClD,SAAO,MAAM,QAAQ,iBAAiB,EAAE;AAC1C;AAEA,SAAS,iBAAiB,MAA6B;AACrD,MAAI;AAEJ,MAAI,OAAO,SAAS,UAAU;AAC5B,QAAI;AACF,gBAAU,KAAK,UAAU,KAAK,MAAM,IAAI,CAAC;AAAA,IAC3C,QAAQ;AACN,YAAM,IAAI,YAAY,mBAAmB,oCAAoC;AAAA,IAC/E;AAAA,EACF,WAAW,MAAM,QAAQ,IAAI,KAAM,OAAO,SAAS,YAAY,SAAS,MAAO;AAC7E,cAAU,KAAK,UAAU,IAAI;AAAA,EAC/B,OAAO;AACL,UAAM,IAAI;AAAA,MACR;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAEA,MAAI,QAAQ,UAAU,GAAG;AACvB,UAAM,IAAI,YAAY,iBAAiB,kDAAkD;AAAA,EAC3F;AAEA,SAAO;AACT;AAUO,IAAM,aAAN,cAAyB,aAAa;AAAA,EAClC;AAAA,EAEQ;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACT,SAA4B;AAAA,EAC5B,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOrB,YAAY,WAAmB,gBAAwB,YAAoB,oBAAoB;AAC7F,UAAM;AAEN,UAAM,MAAM,oBAAoB,SAAS;AACzC,UAAM,WAAW,oBAAoB,cAAc;AAEnD,QAAI,IAAI,WAAW,qBAAqB,SAAS,WAAW,wBAAwB;AAClF,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,SAAK,YAAY;AACjB,SAAK,iBAAiB;AACtB,SAAK,YAAY;AACjB,SAAK,eAAe,YAAY,GAAG;AACnC,SAAK,iBAAiB,YAAY,GAAG;AAAA,EACvC;AAAA;AAAA,EAGA,UAAyB;AACvB,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,YAAM,UAA0B;AAAA,QAC9B,UAAU,KAAK;AAAA,QACf,UAAU,KAAK;AAAA,QACf,iBAAiB;AAAA,MACnB;AAEA,YAAM,SAAS,KAAK,QAAQ,KAAK,WAAW,OAAO;AAEnD,YAAM,iBAAiB,MAAM;AAC3B,eAAO,eAAe,SAAS,YAAY;AAC3C,aAAK,KAAK,SAAS;AACnB,gBAAQ;AAAA,MACV;AACA,YAAM,eAAe,CAAC,UAAiB;AACrC,eAAO,eAAe,WAAW,cAAc;AAC/C,eAAO,IAAI,IAAI;AACf,eAAO,KAAK;AAAA,MACd;AAEA,aAAO,KAAK,WAAW,cAAc;AACrC,aAAO,KAAK,SAAS,YAAY;AAEjC,aAAO,GAAG,aAAa,MAAM,KAAK,KAAK,WAAW,CAAC;AACnD,aAAO,GAAG,SAAS,MAAM,KAAK,KAAK,OAAO,CAAC;AAC3C,aAAO,GAAG,WAAW,MAAM,KAAK,KAAK,SAAS,CAAC;AAC/C,aAAO,GAAG,SAAS,CAAC,UAAU,KAAK,KAAK,SAAS,KAAK,CAAC;AACvD,aAAO,GAAG,WAAW,CAAC,OAAO,YAAY;AACvC,cAAM,YAAY,MAAM,MAAM,KAAK,eAAe,SAAS,CAAC;AAC5D,aAAK,KAAK,WAAW,WAAW,QAAQ,SAAS,CAAC;AAAA,MACpD,CAAC;AAED,WAAK,SAAS;AAAA,IAChB,CAAC;AAAA,EACH;AAAA;AAAA,EAGA,aAA4B;AAC1B,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAI,CAAC,KAAK,QAAQ;AAChB,gBAAQ;AACR;AAAA,MACF;AACA,WAAK,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,UAAW,QAAQ,OAAO,KAAK,IAAI,QAAQ,CAAE;AAAA,IAC3E,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,UAAU,UAAqE;AACnF,QAAI,CAAC,KAAK,QAAQ;AAChB,YAAM,IAAI,YAAY,iBAAiB,gDAAgD;AAAA,IACzF;AAEA,SAAK,GAAG,WAAW,QAAQ;AAE3B,QAAI,KAAK,YAAY;AACnB;AAAA,IACF;AAEA,UAAM,IAAI,QAAc,CAAC,SAAS,WAAW;AAC3C,WAAK,OAAQ,UAAU,KAAK,gBAAgB,CAAC,UAAW,QAAQ,OAAO,KAAK,IAAI,QAAQ,CAAE;AAAA,IAC5F,CAAC;AACD,SAAK,aAAa;AAAA,EACpB;AAAA;AAAA,EAGA,MAAM,KAAK,MAAoC;AAC7C,QAAI,CAAC,KAAK,QAAQ;AAChB,YAAM,IAAI,YAAY,iBAAiB,qCAAqC;AAAA,IAC9E;AAEA,UAAM,UAAU,iBAAiB,IAAI;AAErC,UAAM,IAAI,QAAc,CAAC,SAAS,WAAW;AAC3C,WAAK,OAAQ;AAAA,QAAQ,KAAK;AAAA,QAAc;AAAA,QAAS,EAAE,KAAK,EAAE;AAAA,QAAG,CAAC,UAC5D,QAAQ,OAAO,KAAK,IAAI,QAAQ;AAAA,MAClC;AAAA,IACF,CAAC;AAAA,EACH;AACF;","names":[]}

package/package.json

@@ -1,25 +1,69 @@
 {
-    "name": "viziot-mqtt-client-nodejs",
-    "version": "1.0.7",
-    "description": "MQTT client node.js for web site VizIoT.com",
-    "license": "MIT",
-    "author": "Trunov Alexandr <viziot.com@gmail.com> (http://viziot.com)",
-    "main": "./ViziotMQTT.js",
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
-    },
-    "homepage": "http://VizIoT.com",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/VizIoT-com/viziot-mqtt-client-nodejs"
-    },
-    "keywords": [
-        "mqtt client",
-        "viziot client",
-        "viziot mqtt client",
-        "viziot mqtt client for Node.JS"
-    ],
-    "dependencies": {
-        "mqtt": "^2.18.8"
+  "name": "viziot-mqtt-client-nodejs",
+  "version": "2.0.0",
+  "description": "Promise-based MQTT client for the VizIoT.com IoT platform, written in TypeScript with first-class support for both TypeScript and JavaScript (CommonJS/ESM) projects.",
+  "license": "MIT",
+  "author": "Trunov Alexandr <viziot.com@gmail.com> (http://viziot.com)",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
+  },
+  "files": [
+    "dist",
+    "logo.png"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "prepublishOnly": "npm run lint && npm run typecheck && npm run test && npm run build"
+  },
+  "homepage": "http://VizIoT.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/VizIoT-com/viziot-mqtt-client-nodejs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/VizIoT-com/viziot-mqtt-client-nodejs/issues"
+  },
+  "keywords": [
+    "mqtt",
+    "mqtt-client",
+    "iot",
+    "viziot",
+    "typescript"
+  ],
+  "dependencies": {
+    "mqtt": "^5.16.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^22.20.3",
+    "@vitest/coverage-v8": "^5.0.1",
+    "eslint": "^10.10.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^17.12.0",
+    "prettier": "^3.9.7",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.70.0",
+    "vitest": "^5.0.1"
+  }
 }

package/ViziotMQTT.js

@@ -1,211 +0,0 @@
-'use strict';
-// ==================================================================================
-// VizIoTMQTT.js
-// ----------------------------------------------------------------------------------
-// Description:   MQTT client node.js for web site VizIoT.com
-// Copyright:     (c) 2017 - 2018
-// Author:        VizIoT.com
-// ----------------------------------------------------------------------------------
-// Contributors:  Trunov Alexandr
-// ----------------------------------------------------------------------------------
-// License:       MIT
-// ==================================================================================
-
-const defaultHost = 'mqtt://viziot.com:48651';
-let mqtt = require('mqtt');
-var errorsVizIoT = {
-	0: '',
-	1: 'Ключ или пароль устройства записаны в неправильном формате',
-	2: "Ошибка! Параметр не является массивом или объектом",
-	3: "Ошибка! Данные для отправки не могут == null",
-	4: "Ошибка! Параметр не является массивом или объектом",
-	5: "Ошибка! Попытка отправить пустые данные",
-	6: "Ошибка! Не указан callback"
-
-};
-var errorsMQTT = {
-	0: '',
-	1: 'Unacceptable protocol version',
-	2: 'Identifier rejected',
-	3: 'Server unavailable',
-	4: 'Bad username or password',
-	5: 'Ошибка авторизации. Проверьте ключ и пароль устройства.',
-	16: 'No matching subscribers',
-	17: 'No subscription existed',
-	128: 'Unspecified error',
-	129: 'Malformed Packet',
-	130: 'Protocol Error',
-	131: 'Implementation specific error',
-	132: 'Unsupported Protocol Version',
-	133: 'Client Identifier not valid',
-	134: 'Bad User Name or Password',
-	135: 'Not authorized',
-	136: 'Server unavailable',
-	137: 'Server busy',
-	138: 'Banned',
-	139: 'Server shutting down',
-	140: 'Bad authentication method',
-	141: 'Keep Alive timeout',
-	142: 'Session taken over',
-	143: 'Topic Filter invalid',
-	144: 'Topic Name invalid',
-	145: 'Packet identifier in use',
-	146: 'Packet Identifier not found',
-	147: 'Receive Maximum exceeded',
-	148: 'Topic Alias invalid',
-	149: 'Packet too large',
-	150: 'Message rate too high',
-	151: 'Quota exceeded',
-	152: 'Administrative action',
-	153: 'Payload format invalid',
-	154: 'Retain not supported',
-	155: 'QoS not supported',
-	156: 'Use another server',
-	157: 'Server moved',
-	158: 'Shared Subscriptions not supported',
-	159: 'Connection rate exceeded',
-	160: 'Maximum connect time',
-	161: 'Subscription Identifiers not supported',
-	162: 'Wildcard Subscriptions not supported'
-};
-module.exports = class VizIoTMQTT {
-
-	/**
-	 * Инициализация Объекта VizIoTMQTT
-	 * @param deviceKey - ключ устройства с сайта VizIoT.com
-	 * @param devicePass - пароль устройства с сайта VizIoT.com
-	 * @param mqttHost - можно не указывать. По умолчанию "mqtt://viziot.com:48651"
-	 */
-	constructor(deviceKey, devicePass, mqttHost) {
-		if(mqttHost == undefined){
-			this.hostBroker = defaultHost;
-		}else{
-			this.hostBroker = mqttHost;
-		}
-		this.keyAndPassIsOk = false;
-		deviceKey = deviceKey.replace(/[^A-Za-z0-9]/g, "");
-		devicePass = devicePass.replace(/[^A-Za-z0-9]/g, "");
-		if(deviceKey.length == 16 && devicePass.length == 20){
-			this.key = deviceKey;
-			this.pass = devicePass;
-			this.topicForPublish = '/devices/' + deviceKey + '/packet';
-			this.topicForSubscribe = '/devices/' + deviceKey + '/param/+';
-			this.keyAndPassIsOk = true;
-		}else{
-			console.log(errorsVizIoT[1]);
-		}
-	}
-
-	connect(callback) {
-		if(typeof callback != "function"){
-			// console.log(new Error(errorsVizIoT[6]));
-			callback = function () {
-
-			};
-		}
-		if(this.keyAndPassIsOk){
-			let dataForConnectToBroker = {
-				'username': this.key,
-				'password': this.pass,
-				'reconnectPeriod': 5000
-			};
-
-			this.mqttClient = mqtt.connect(this.hostBroker, dataForConnectToBroker);
-			this.mqttClient.on('connect', function (connect) {
-				console.log("Соединение с MQTT брокером VizIoT.com установлено.");
-				callback();
-			});
-			this.mqttClient.on('reconnect', function () {
-				console.log("Пере подключение к MQTT брокеру VizIoT.com.");
-			});
-			this.mqttClient.on('close', function () {
-				console.log("Подключение к MQTT брокеру VizIoT.com закрыто.");
-			});
-			this.mqttClient.on('offline', function () {
-				// console.log("MQTT 'offline'");
-			});
-			this.mqttClient.on('error', function (error) {
-				if (error) {
-					console.log(errorsMQTT[error.code]);
-				}
-			});
-		}
-	}
-
-	/**
-	 * Например
-	 * VizIoTClient.startListenMessages(function (topic, message) {
-	 * 		.....
-	 * })
-	 * callback Параметры
-	 * 		parameter - ключ команды или параметра
-	 * 		value - значение параметра
-	 * @param callback
-	 */
-	startListenCommands(callback) {
-		if(typeof callback != "function"){
-			console.log(new Error(errorsVizIoT[6]));
-			return false;
-		}
-		let strLengthForDelitfromTopic = this.topicForSubscribe.length;
-		this.mqttClient.on('message', function (topic, message, packet) {
-			let parameter = topic.substring(strLengthForDelitfromTopic-1);
-			let value = message.toString();
-			callback(parameter, value);
-		});
-		this.mqttClient.subscribe(this.topicForSubscribe,  function (err, granted){
-			if(err) console.log("subscribe", err, granted);
-		});
-	}
-
-	/**
-	 * в функцию передается массив или объект для отправки на Сервер VizIoT
-	 * @param data
-	 * @param callback
-	 */
-	sendDataToVizIoT(data, callback){
-		if(typeof callback != "function"){
-			callback = function (err) {
-				if(err){
-					console.log("Ошибка в sendDataToVizIoT!", err);
-				}
-			}
-		}
-		let packet = "";
-		switch (typeof data){
-			case "string":
-				try {
-					packet = JSON.parse(data);
-					packet = JSON.stringify(packet);
-				} catch (err) {
-					callback(errorsVizIoT[2], false);
-					return false;
-				}
-				break;
-			case "object":
-				if(data != null){
-					packet = JSON.stringify(data);
-				}else{
-					callback(errorsVizIoT[3], false);
-					return false;
-				}
-				break;
-			default:
-				callback(errorsVizIoT[4], false);
-				return false;
-				break;
-		}
-		if(packet.length <= 2){
-			callback(errorsVizIoT[5], false);
-			return false;
-		}
-		this.mqttClient.publish(this.topicForPublish, packet, {'qos': 1}, function (err) {
-			if (err) {
-				callback(err, false);
-			}else{
-				callback(undefined, true);
-			}
-		});
-	}
-
-};