@ptner/mqtt-trans 0.1.0

package/README.md

@@ -0,0 +1,37 @@
+# @ai-bus/mqtt-trans
+
+基于 Aedes 的可嵌入 MQTT 服务端，一个 broker 同时服务原生 MQTT TCP 和 MQTT-over-WebSocket 客户端。
+
+## Usage
+
+```ts
+import { MqttTransServer } from "@ai-bus/mqtt-trans";
+
+const server = new MqttTransServer({
+  mqtt: { host: "0.0.0.0", port: 1883 },
+  websocket: { host: "0.0.0.0", port: 8083, path: "/mqtt" },
+  broker: {
+    authenticate(client, username, password, done) {
+      done(null, username === "device" && password?.toString() === "secret");
+    },
+  },
+});
+
+const addresses = await server.start();
+console.log(addresses);
+
+await server.publish({
+  cmd: "publish",
+  topic: "devices/status",
+  payload: Buffer.from("online"),
+  qos: 0,
+  retain: false,
+  dup: false,
+});
+
+await server.close();
+```
+
+将 `mqtt` 或 `websocket` 设为 `false` 可以关闭对应监听器。端口设为 `0` 时由操作系统分配端口，实际地址由 `start()` 返回。
+
+Aedes 1.1 实现 MQTT 3.1/3.1.1，不提供 MQTT 5 broker 功能。WebSocket 客户端应连接 `/mqtt` 并使用 `mqtt` 子协议。

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+import { type AddressInfo } from "node:net";
+import { Aedes, type AedesOptions, type PublishPacket } from "aedes";
+export interface MqttListenerOptions {
+    host?: string;
+    port?: number;
+    backlog?: number;
+}
+export interface MqttWebSocketListenerOptions {
+    host?: string;
+    port?: number;
+    path?: string;
+    maxPayload?: number;
+}
+export interface MqttTransServerOptions {
+    broker?: AedesOptions;
+    mqtt?: false | MqttListenerOptions;
+    websocket?: false | MqttWebSocketListenerOptions;
+    onError?: (error: Error) => void;
+}
+export interface MqttTransAddresses {
+    mqtt: AddressInfo | null;
+    websocket: AddressInfo | null;
+}
+export type AedesInstance = Aedes;
+export declare class MqttTransServer {
+    readonly broker: AedesInstance;
+    private readonly options;
+    private mqttServer;
+    private websocketServer;
+    private addressesValue;
+    private startPromise;
+    private closePromise;
+    constructor(options?: MqttTransServerOptions);
+    get addresses(): MqttTransAddresses;
+    start(): Promise<MqttTransAddresses>;
+    publish(packet: PublishPacket): Promise<void>;
+    close(): Promise<void>;
+    private startInternal;
+    private closeInternal;
+    private reportError;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,WAAW,EAAe,MAAM,UAAU,CAAC;AACvE,OAAO,EACL,KAAK,EACL,KAAK,YAAY,EACjB,KAAK,aAAa,EACnB,MAAM,OAAO,CAAC;AAOf,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,KAAK,GAAG,mBAAmB,CAAC;IACnC,SAAS,CAAC,EAAE,KAAK,GAAG,4BAA4B,CAAC;IACjD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC;AAElC,qBAAa,eAAe;IAC1B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,OAAO,CAAC,UAAU,CAAqB;IACvC,OAAO,CAAC,eAAe,CAA8B;IACrD,OAAO,CAAC,cAAc,CAAuD;IAC7E,OAAO,CAAC,YAAY,CAA0C;IAC9D,OAAO,CAAC,YAAY,CAA4B;gBAEpC,OAAO,GAAE,sBAA2B;IAKhD,IAAI,SAAS,IAAI,kBAAkB,CAElC;IAED,KAAK,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAMpC,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAKR,aAAa;YA4Cb,aAAa;IAe3B,OAAO,CAAC,WAAW;CAGpB"}

package/dist/index.js

@@ -0,0 +1,138 @@
+import { createServer } from "node:net";
+import { Aedes, } from "aedes";
+import { WebSocketServer, createWebSocketStream, } from "ws";
+export class MqttTransServer {
+    broker;
+    options;
+    mqttServer;
+    websocketServer;
+    addressesValue = { mqtt: null, websocket: null };
+    startPromise;
+    closePromise;
+    constructor(options = {}) {
+        this.options = options;
+        this.broker = new Aedes(options.broker);
+    }
+    get addresses() {
+        return this.addressesValue;
+    }
+    start() {
+        if (this.closePromise)
+            throw new Error("Cannot start a closed MQTT server");
+        this.startPromise ??= this.startInternal();
+        return this.startPromise;
+    }
+    publish(packet) {
+        return new Promise((resolve, reject) => {
+            this.broker.publish(packet, (error) => error ? reject(error) : resolve());
+        });
+    }
+    close() {
+        this.closePromise ??= this.closeInternal();
+        return this.closePromise;
+    }
+    async startInternal() {
+        try {
+            await this.broker.listen();
+            if (this.options.mqtt !== false) {
+                const options = this.options.mqtt ?? {};
+                this.mqttServer = createServer((socket) => this.broker.handle(socket));
+                await listenTcp(this.mqttServer, options.port ?? 1883, options.host ?? "0.0.0.0", options.backlog);
+                this.mqttServer.on("error", (error) => this.reportError(error));
+            }
+            if (this.options.websocket !== false) {
+                const options = this.options.websocket ?? {};
+                const websocketServer = new WebSocketServer({
+                    port: options.port ?? 8083,
+                    host: options.host ?? "0.0.0.0",
+                    path: options.path ?? "/mqtt",
+                    maxPayload: options.maxPayload ?? 16 * 1024 * 1024,
+                    handleProtocols: (protocols) => protocols.has("mqtt") ? "mqtt" : false,
+                });
+                this.websocketServer = websocketServer;
+                websocketServer.on("connection", (socket, request) => {
+                    this.broker.handle(createWebSocketStream(socket), request);
+                });
+                await waitForWebSocketServer(websocketServer);
+                websocketServer.on("error", (error) => this.reportError(error));
+            }
+            this.addressesValue = {
+                mqtt: addressOf(this.mqttServer?.address()),
+                websocket: addressOf(this.websocketServer?.address()),
+            };
+            return this.addressesValue;
+        }
+        catch (error) {
+            await this.closeInternal();
+            throw error;
+        }
+    }
+    async closeInternal() {
+        for (const client of this.websocketServer?.clients ?? new Set()) {
+            client.terminate();
+        }
+        await Promise.all([
+            closeTcp(this.mqttServer),
+            closeWebSocket(this.websocketServer),
+            closeBroker(this.broker),
+        ]);
+        this.mqttServer = undefined;
+        this.websocketServer = undefined;
+        this.addressesValue = { mqtt: null, websocket: null };
+    }
+    reportError(error) {
+        this.options.onError?.(error);
+    }
+}
+function listenTcp(server, port, host, backlog) {
+    return new Promise((resolve, reject) => {
+        const onError = (error) => {
+            server.off("listening", onListening);
+            reject(error);
+        };
+        const onListening = () => {
+            server.off("error", onError);
+            resolve();
+        };
+        server.once("error", onError);
+        server.once("listening", onListening);
+        server.listen({ port, host, backlog });
+    });
+}
+function waitForWebSocketServer(server) {
+    return new Promise((resolve, reject) => {
+        const onError = (error) => {
+            server.off("listening", onListening);
+            reject(error);
+        };
+        const onListening = () => {
+            server.off("error", onError);
+            resolve();
+        };
+        server.once("error", onError);
+        server.once("listening", onListening);
+    });
+}
+function closeTcp(server) {
+    if (!server?.listening)
+        return Promise.resolve();
+    return new Promise((resolve, reject) => {
+        server.close((error) => error ? reject(error) : resolve());
+    });
+}
+function closeWebSocket(server) {
+    if (!server)
+        return Promise.resolve();
+    return new Promise((resolve, reject) => {
+        server.close((error) => error ? reject(error) : resolve());
+    });
+}
+function closeBroker(broker) {
+    if (broker.closed)
+        return Promise.resolve();
+    return new Promise((resolve) => broker.close(resolve));
+}
+function addressOf(address) {
+    return address && typeof address !== "string" ? address : null;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiC,MAAM,UAAU,CAAC;AACvE,OAAO,EACL,KAAK,GAGN,MAAM,OAAO,CAAC;AACf,OAAO,EACL,eAAe,EACf,qBAAqB,GAEtB,MAAM,IAAI,CAAC;AA6BZ,MAAM,OAAO,eAAe;IACjB,MAAM,CAAgB;IACd,OAAO,CAAyB;IACzC,UAAU,CAAqB;IAC/B,eAAe,CAA8B;IAC7C,cAAc,GAAuB,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACrE,YAAY,CAA0C;IACtD,YAAY,CAA4B;IAEhD,YAAY,UAAkC,EAAE;QAC9C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAC5E,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,OAAO,CAAC,MAAqB;QAC3B,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK;QACH,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAEO,KAAK,CAAC,aAAa;QACzB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YAE3B,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBAChC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;gBACxC,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;gBACvE,MAAM,SAAS,CACb,IAAI,CAAC,UAAU,EACf,OAAO,CAAC,IAAI,IAAI,IAAI,EACpB,OAAO,CAAC,IAAI,IAAI,SAAS,EACzB,OAAO,CAAC,OAAO,CAChB,CAAC;gBACF,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;YAClE,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC;gBACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;gBAC7C,MAAM,eAAe,GAAG,IAAI,eAAe,CAAC;oBAC1C,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,IAAI;oBAC1B,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,SAAS;oBAC/B,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,OAAO;oBAC7B,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE,GAAG,IAAI,GAAG,IAAI;oBAClD,eAAe,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK;iBACvE,CAAC,CAAC;gBACH,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;gBACvC,eAAe,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;oBACnD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;gBAC7D,CAAC,CAAC,CAAC;gBACH,MAAM,sBAAsB,CAAC,eAAe,CAAC,CAAC;gBAC9C,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;YAClE,CAAC;YAED,IAAI,CAAC,cAAc,GAAG;gBACpB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC;gBAC3C,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,EAAE,CAAC;aACtD,CAAC;YACF,OAAO,IAAI,CAAC,cAAc,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,aAAa;QACzB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,eAAe,EAAE,OAAO,IAAI,IAAI,GAAG,EAAa,EAAE,CAAC;YAC3E,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,CAAC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;YACzB,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC;YACpC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;SACzB,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACxD,CAAC;IAEO,WAAW,CAAC,KAAY;QAC9B,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;CACF;AAED,SAAS,SAAS,CAChB,MAAc,EACd,IAAY,EACZ,IAAY,EACZ,OAAgB;IAEhB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,OAAO,GAAG,CAAC,KAAY,EAAE,EAAE;YAC/B,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACrC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,GAAG,EAAE;YACvB,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,sBAAsB,CAAC,MAAuB;IACrD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,OAAO,GAAG,CAAC,KAAY,EAAE,EAAE;YAC/B,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACrC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,GAAG,EAAE;YACvB,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,MAA0B;IAC1C,IAAI,CAAC,MAAM,EAAE,SAAS;QAAE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IACjD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,cAAc,CAAC,MAAmC;IACzD,IAAI,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IACtC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,WAAW,CAAC,MAAqB;IACxC,IAAI,MAAM,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC5C,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,SAAS,CAChB,OAAgD;IAEhD,OAAO,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;AACjE,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@ptner/mqtt-trans",
+  "version": "0.1.0",
+  "description": "Embeddable MQTT and MQTT-over-WebSocket server",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "node --import tsx --test test/**/*.test.ts",
+    "check": "npm run build && npm test"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "aedes": "^1.1.1",
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@types/ws": "^8.5.0",
+    "mqtt": "^5.10.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.7.0"
+  },
+  "license": "MIT"
+}