@seriousme/opifex 1.11.3 → 2.1.0

package/node/tlsServer.ts

@@ -0,0 +1,97 @@
+/*
+ * This module provides a NodeJS specific implementation of a TLS socket listener
+ * it uses the platform agnostic MqttServer class
+ *  @module
+ */
+import type { Server } from "node:net";
+import { createServer } from "node:tls";
+import type { MqttServerOptions } from "../server/mod.ts";
+import { MqttServer } from "../server/mod.ts";
+import { wrapNodeSocket } from "./wrapNodeSocket.ts";
+
+type ServerOptions = {
+  hostname?: string;
+  port?: number;
+  key: string;
+  cert: string;
+};
+
+/**
+ * TLS server that wraps a MqttServer, see the /examples folder
+ */
+export class TlsServer {
+  private mqttServer: MqttServer;
+  private server?: Server;
+  private serverOptions;
+
+  /**
+   * Create a new TLS server
+   */
+  constructor(serverOptions: ServerOptions, mqttOptions: MqttServerOptions) {
+    this.mqttServer = new MqttServer(mqttOptions);
+    this.serverOptions = serverOptions;
+  }
+
+  /**
+   * Start listening
+   */
+  async start(): Promise<void> {
+    const tlsOptions = {
+      minVersion: "TLSv1.3" as const,
+      key: this.serverOptions.key,
+      cert: this.serverOptions.cert,
+    };
+
+    this.server = createServer(
+      tlsOptions,
+      (sock) => this.mqttServer.serve(wrapNodeSocket(sock)),
+    );
+    const isListening = new Promise((resolve) => {
+      this.server?.on("listening", () => {
+        resolve(true);
+      });
+    });
+    this.server.listen(this.serverOptions.port, this.serverOptions.hostname);
+    await isListening;
+    return;
+  }
+
+  /**
+   * Stop listening
+   */
+  stop(): void {
+    this.mqttServer.close();
+    this.server?.close();
+  }
+
+  /**
+   * The port number the server is listening on
+   */
+  get port(): number | undefined {
+    const address = this.server?.address();
+    if (typeof address === "object" && address !== null) {
+      return address?.port;
+    }
+    return this.serverOptions?.port;
+  }
+
+  /**
+   * The address the server is listening on
+   */
+  get address(): string | undefined {
+    const addressResult = this.server?.address();
+    // deno-coverage-ignore-start
+    if (typeof addressResult === "object") {
+      const address = addressResult?.address;
+      if (address === "::") {
+        return "localhost";
+      }
+      if (address?.includes(":")) {
+        return `[${address}]`;
+      }
+      return address;
+    }
+    return addressResult;
+  }
+  // deno-coverage-ignore-stop
+}

package/node/wrapNodeSocket.ts

@@ -2,7 +2,7 @@
  * Utility functions for wrapping Node.js sockets into standard web streams.
  */
 import type { Socket } from "node:net";
-import { Writable } from "node:stream";
+import { Readable, Writable } from "node:stream";
 import type { NetAddr, SockConn } from "../socket/socket.ts";
 
 /**
@@ -10,9 +10,11 @@ import type { NetAddr, SockConn } from "../socket/socket.ts";
  * @param sock - The Node.js socket to close
  */
 function closer(sock: Socket): void {
+  // deno-coverage-ignore-start
   if (!sock.closed) {
     sock.end();
   }
+  // deno-coverage-ignore-stop
 }
 
 /**
@@ -21,41 +23,16 @@ function closer(sock: Socket): void {
  * @returns A socket connection object with readable/writable streams and close method
  */
 export function wrapNodeSocket(socket: Socket): SockConn {
-  const readable = new ReadableStream(
-    {
-      type: "bytes",
-      start(controller) {
-        socket.on("data", (data: Uint8Array<ArrayBuffer>) => {
-          controller.enqueue(data);
-          const desiredSize = controller.desiredSize ?? 0;
-          if (desiredSize <= 0) {
-            // The internal queue is full, so propagate
-            // the backpressure signal to the underlying source.
-            socket.pause();
-          }
-        });
-        socket.on("error", (err: unknown) => controller.error(err));
-        socket.on("end", () => {
-          // close the controller
-          controller.close();
-          // and unlock the last BYOB read request
-          controller.byobRequest?.respond(0);
-        });
-      },
-      pull: () => {
-        socket.resume();
-      },
-      cancel: () => {
-        socket.end();
-      },
-    },
-  );
+  const readable = Readable.toWeb(socket);
   const writable = Writable.toWeb(socket);
+
+  // deno-coverage-ignore-start
   const remoteAddr: NetAddr = {
     hostname: socket.remoteAddress || "",
     port: socket.remotePort || 0,
     transport: "tcp",
   };
+  // deno-coverage-ignore-stop
 
   const conn: SockConn = {
     readable: readable as ReadableStream<Uint8Array>,

package/package.json

@@ -1,25 +1,37 @@
 {
   "name": "@seriousme/opifex",
-  "version": "1.11.3",
+  "version": "2.1.0",
   "description": "MQTT client & server for Deno & NodeJS and Bun",
-  "type": "module",
-  "scripts": {
-    "test": "node --experimental-strip-types --test --test-skip-pattern='/^Deno/'",
-    "prebuild": "rm -rf dist",
-    "build": "npx -p typescript tsc --build",
-    "format": "deno fmt",
-    "preversion": "npm run test",
-    "version": "jq '( { name:.name , version:.version, license:.license } + .deno)' package.json > deno.json && deno install && git add deno.json"
+  "author": "Hans Klunder",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/seriousme/opifex.git"
   },
+  "bugs": {
+    "url": "https://github.com/seriousme/opifex/issues"
+  },
+  "homepage": "https://github.com/seriousme/opifex#readme",
   "keywords": [
     "MQTT",
     "typescript",
     "mqtt-broker"
   ],
+  "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
   "bin": {
     "mqtt": "dist/bin/mqtt.js",
     "demoServer": "dist/bin/demoServer.js"
   },
+  "scripts": {
+    "test": "node  --test --test-skip-pattern='^(?:Deno|Web):'",
+    "build": "rm -rf dist && npx -p typescript tsc --build",
+    "format": "deno fmt",
+    "coverage": "deno test -A . --coverage --clean --coverage-raw-data-only && deno coverage --exclude=.config --exclude=dev_utils --html",
+    "preversion": "npm run test"
+  },
   "files": [
     "package.json",
     "README.md",
@@ -31,43 +43,59 @@
     "dist/**/*.d.ts.map"
   ],
   "exports": {
-    "./tcpClient": "./dist/node/tcpClient.js",
-    "./tcpServer": "./dist/node/tcpServer.js",
-    "./server": "./dist/server/mod.js",
-    "./client": "./dist/client/mod.js",
-    "./trie": "./dist/trie/trie.js",
-    "./persistence": "./dist/persistence/mod.js",
-    "./mqttConn": "./dist/mqttConn/mqttConn.js",
-    "./mqttPacket": "./dist/mqttPacket/mod.js",
-    "./utils": "./dist/utils/mod.js"
-  },
-  "deno": {
-    "exports": {
-      "./tcpClient": "./deno/tcpClient.ts",
-      "./tcpServer": "./deno/tcpServer.ts",
-      "./server": "./server/mod.ts",
-      "./client": "./client/mod.ts",
-      "./trie": "./trie/trie.ts",
-      "./persistence": "./persistence/mod.ts",
-      "./mqttConn": "./mqttConn/mqttConn.ts",
-      "./mqttPacket": "./mqttPacket/mod.ts",
-      "./utils": "./utils/mod.ts"
+    "./tcpClient": {
+      "deno": "./deno/tcpClient.ts",
+      "default": "./dist/node/tcpClient.js"
     },
-    "exclude": [
-      "dist"
-    ]
-  },
-  "author": "Hans Klunder",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/seriousme/opifex.git"
-  },
-  "bugs": {
-    "url": "https://github.com/seriousme/opifex/issues"
+    "./wsClient": {
+      "deno": "./web/wsClient.ts",
+      "browser": "./dist/web/wsClient.js",
+      "default": null
+    },
+    "./tcpServer": {
+      "deno": "./deno/tcpServer.ts",
+      "default": "./dist/node/tcpServer.js"
+    },
+    "./tlsServer": {
+      "deno": "./deno/tlsServer.ts",
+      "default": "./dist/node/tlsServer.js"
+    },
+    "./wsServer": {
+      "deno": "./deno/wsServer.ts",
+      "default": null
+    },
+    "./server": {
+      "deno": "./server/mod.ts",
+      "default": "./dist/server/mod.js"
+    },
+    "./client": {
+      "deno": "./client/mod.ts",
+      "default": "./dist/client/mod.js"
+    },
+    "./trie": {
+      "deno": "./trie/trie.ts",
+      "default": "./dist/trie/trie.js"
+    },
+    "./persistence": {
+      "deno": "./persistence/mod.ts",
+      "default": "./dist/persistence/mod.js"
+    },
+    "./mqttConn": {
+      "deno": "./mqttConn/mqttConn.ts",
+      "default": "./dist/mqttConn/mqttConn.js"
+    },
+    "./mqttPacket": {
+      "deno": "./mqttPacket/mod.ts",
+      "default": "./dist/mqttPacket/mod.js"
+    },
+    "./utils": {
+      "deno": "./utils/mod.ts",
+      "default": "./dist/utils/mod.js"
+    }
   },
-  "homepage": "https://github.com/seriousme/opifex#readme",
   "devDependencies": {
-    "@types/node": "^24.12.4"
+    "@types/node": "^26.6.2",
+    "@types/node-forge": "^1.3.14",
+    "node-forge": "^1.4.0"
   }
 }