@seriousme/opifex 1.7.0 → 1.8.0

package/README.md

@@ -13,8 +13,7 @@ persistence.
 
 ## Example
 
-A simple server example using Deno, for more elaborate examples see the Usage
-section below.
+A simple server example using Deno.
 
 ```typescript
 import { MqttServer } from "./server/mod.ts";
@@ -26,6 +25,9 @@ for await (const conn of this.listener) {
 }
 ```
 
+A more elaborate example including client and server can be found in the
+[examples](/examples/) folder.
+
 ## Architecture
 
 1. The basis of Opifex is the MQTT packet module
@@ -86,6 +88,19 @@ inspiration.
 
 Bun (as of version 1.2) is capable of running the NodeJS version.
 
+## Exports
+
+| Export                       | Description                                             |
+| ---------------------------- | ------------------------------------------------------- |
+| @seriousme/opifex/tcpClient  | Exports a MQTT over TCP client                          |
+| @seriousme/opifex/tcpServer  | Exports a MQTT over TCP server                          |
+| @seriousme/opifex/server     | Exports a transport agnostic MQTT server                |
+| @seriousme/opifex/client     | Exports a transport agnostic MQTT client                |
+| @seriousme/opifex/client     | Exports an Typescript interface for storage persistence |
+| @seriousme/opifex/mqttConn   | Exports MQTT connection handling                        |
+| @seriousme/opifex/mqttPacket | Exports MQTT packet handling                            |
+| @seriousme/opifex/utils      | Exports various utilities                               |
+
 ## Naming
 
 Some MQTT servers have names like:

package/dist/bin/conformanceServer.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --experimental-strip-types
+export {};
+//# sourceMappingURL=conformanceServer.d.ts.map

package/dist/bin/conformanceServer.d.ts.map

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

package/dist/bin/conformanceServer.js

@@ -0,0 +1,98 @@
+#!/usr/bin/env -S node --experimental-strip-types
+// this server is intended to be used with https://github.com/eclipse/iottestware
+/**
+ * MQTT Server implementation with authentication and authorization
+ * @module mqttServer
+ */
+import { TcpServer } from "../node/tcpServer.js";
+import { AuthenticationResult } from "../server/mod.js";
+import { getArgs, logger, LogLevel, parseArgs } from "../utils/mod.js";
+/**
+ * UTF-8 decoder for parsing passwords
+ */
+const utf8Decoder = new TextDecoder();
+/**
+ * Map storing valid username/password combinations
+ */
+const userTable = new Map();
+userTable.set("IoTester_1", "strong_password");
+userTable.set("IoTester_2", "strong_password");
+/**
+ * Regular expression for validating usernames
+ * Allows alphanumeric characters up to 23 chars long
+ */
+const strictUsername = new RegExp(/^[a-zA-Z0-9]{0,23}$/);
+/**
+ * Flag to enable/disable username checking
+ * If false, all users are allowed access
+ * If true, only users in userTable are allowed access
+ */
+const checkUsername = true;
+/**
+ * Authenticates MQTT clients
+ * @param {Context} _ctx - Connection context
+ * @param {string} clientId - Client identifier
+ * @param {string} username - Username to authenticate
+ * @param {Uint8Array} password - Password as byte array
+ * @returns {TAuthenticationResult} Authentication result
+ */
+function isAuthenticated(_ctx, clientId, username, password) {
+    const pwd = utf8Decoder.decode(password);
+    logger.info(`Verifying authentication of client '${clientId}' with username '${username}' and password '${pwd}'`);
+    if (!checkUsername) {
+        // allow all users access
+        return AuthenticationResult.ok;
+    }
+    // is the username valid according to MQTT specification
+    if (!strictUsername.test(username)) {
+        return AuthenticationResult.badUsernameOrPassword;
+    }
+    // Does user and password match an entry in userTable
+    if (userTable.has(username)) {
+        const pass = userTable.get(username);
+        if (pwd === pass) {
+            return AuthenticationResult.ok;
+        }
+    }
+    return AuthenticationResult.notAuthorized;
+}
+/**
+ * Checks if client is authorized to publish to a topic
+ * @param {Context} ctx - Connection context
+ * @param {Topic} topic - Topic to publish to
+ * @returns {boolean} True if authorized
+ */
+function isAuthorizedToPublish(ctx, topic) {
+    logger.debug(`Checking authorization of client '${ctx.store?.clientId}' to publish on topic '${topic}'`);
+    return true;
+}
+/**
+ * Checks if client is authorized to subscribe to a topic
+ * @param {Context} ctx - Connection context
+ * @param {Topic} topic - Topic to subscribe to
+ * @returns {boolean} True if authorized
+ */
+function isAuthorizedToSubscribe(ctx, topic) {
+    logger.debug(`Checking authorization of client '${ctx.store?.clientId}' to subscribe to topic '${topic}'`);
+    return true;
+}
+/**
+ * Parse command line arguments and start server
+ */
+const { _: [portNum] } = parseArgs(getArgs());
+const port = Number(portNum ?? 1883);
+const hostname = "::";
+logger.level(LogLevel.info);
+/**
+ * TCP Server instance with authentication and authorization handlers
+ */
+const tcpServer = new TcpServer({ port, hostname }, {
+    handlers: {
+        isAuthenticated,
+        isAuthorizedToPublish,
+        isAuthorizedToSubscribe,
+    },
+});
+tcpServer.start();
+logger.info(`Server started on port ${tcpServer.port}`);
+//# sourceMappingURL=conformanceServer.js.map

package/dist/bin/conformanceServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conformanceServer.js","sourceRoot":"","sources":["../../bin/conformanceServer.ts"],"names":[],"mappings":";AACA,iFAAiF;AAEjF;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;AAEtC;;GAEG;AACH,MAAM,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;AAC5B,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;AAC/C,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;AAE/C;;;GAGG;AACH,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,aAAa,GAAG,IAAI,CAAC;AAE3B;;;;;;;GAOG;AACH,SAAS,eAAe,CACtB,IAAa,EACb,QAAgB,EAChB,QAAgB,EAChB,QAAoB;IAEpB,MAAM,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,CAAC,IAAI,CACT,uCAAuC,QAAQ,oBAAoB,QAAQ,mBAAmB,GAAG,GAAG,CACrG,CAAC;IAEF,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,yBAAyB;QACzB,OAAO,oBAAoB,CAAC,EAAE,CAAC;IACjC,CAAC;IACD,wDAAwD;IACxD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,OAAO,oBAAoB,CAAC,qBAAqB,CAAC;IACpD,CAAC;IACD,qDAAqD;IACrD,IAAI,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,oBAAoB,CAAC,EAAE,CAAC;QACjC,CAAC;IACH,CAAC;IACD,OAAO,oBAAoB,CAAC,aAAa,CAAC;AAC5C,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,GAAY,EAAE,KAAY;IACvD,MAAM,CAAC,KAAK,CACV,qCAAqC,GAAG,CAAC,KAAK,EAAE,QAAQ,0BAA0B,KAAK,GAAG,CAC3F,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAS,uBAAuB,CAAC,GAAY,EAAE,KAAY;IACzD,MAAM,CAAC,KAAK,CACV,qCAAqC,GAAG,CAAC,KAAK,EAAE,QAAQ,4BAA4B,KAAK,GAAG,CAC7F,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,MAAM,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;AAC9C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC;AACrC,MAAM,QAAQ,GAAG,IAAI,CAAC;AACtB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAE5B;;GAEG;AACH,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;IAClD,QAAQ,EAAE;QACR,eAAe;QACf,qBAAqB;QACrB,uBAAuB;KACxB;CACF,CAAC,CAAC;AACH,SAAS,CAAC,KAAK,EAAE,CAAC;AAClB,MAAM,CAAC,IAAI,CAAC,0BAA0B,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC"}

package/dist/bin/demoServer.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --experimental-strip-types
+export {};
+//# sourceMappingURL=demoServer.d.ts.map

package/dist/bin/demoServer.d.ts.map

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

package/dist/bin/demoServer.js

@@ -0,0 +1,97 @@
+#!/usr/bin/env -S node --experimental-strip-types
+/**
+ * MQTT Server implementation with authentication and authorization
+ * @module mqttServer
+ */
+import { TcpServer } from "../node/tcpServer.js";
+import { AuthenticationResult } from "../server/mod.js";
+import { getArgs, logger, LogLevel, parseArgs } from "../utils/mod.js";
+/**
+ * UTF-8 decoder for parsing passwords
+ */
+const utf8Decoder = new TextDecoder();
+/**
+ * Map storing valid username/password combinations
+ */
+const userTable = new Map();
+userTable.set("IoTester_1", "strong_password");
+userTable.set("IoTester_2", "strong_password");
+/**
+ * Regular expression for validating usernames
+ * Allows alphanumeric characters up to 23 chars long
+ */
+const strictUsername = new RegExp(/^[a-zA-Z0-9]{0,23}$/);
+/**
+ * Flag to enable/disable username checking
+ * If false, all users are allowed access
+ * If true, only users in userTable are allowed access
+ */
+const checkUsername = false;
+/**
+ * Authenticates MQTT clients
+ * @param {Context} _ctx - Connection context
+ * @param {string} clientId - Client identifier
+ * @param {string} username - Username to authenticate
+ * @param {Uint8Array} password - Password as byte array
+ * @returns {TAuthenticationResult} Authentication result
+ */
+function isAuthenticated(_ctx, clientId, username, password) {
+    const pwd = utf8Decoder.decode(password);
+    logger.info(`Verifying authentication of client '${clientId}' with username '${username}' and password '${pwd}'`);
+    if (!checkUsername) {
+        // allow all users access
+        return AuthenticationResult.ok;
+    }
+    // is the username valid according to MQTT specification
+    if (!strictUsername.test(username)) {
+        return AuthenticationResult.badUsernameOrPassword;
+    }
+    // Does user and password match an entry in userTable
+    if (userTable.has(username)) {
+        const pass = userTable.get(username);
+        if (pwd === pass) {
+            return AuthenticationResult.ok;
+        }
+    }
+    return AuthenticationResult.notAuthorized;
+}
+/**
+ * Checks if client is authorized to publish to a topic
+ * @param {Context} ctx - Connection context
+ * @param {Topic} topic - Topic to publish to
+ * @returns {boolean} True if authorized
+ */
+function isAuthorizedToPublish(ctx, topic) {
+    logger.debug(`Checking authorization of client '${ctx.store?.clientId}' to publish on topic '${topic}'`);
+    return true;
+}
+/**
+ * Checks if client is authorized to subscribe to a topic
+ * @param {Context} ctx - Connection context
+ * @param {Topic} topic - Topic to subscribe to
+ * @returns {boolean} True if authorized
+ */
+function isAuthorizedToSubscribe(ctx, topic) {
+    logger.debug(`Checking authorization of client '${ctx.store?.clientId}' to subscribe to topic '${topic}'`);
+    return true;
+}
+/**
+ * Parse command line arguments and start server
+ */
+const { _: [portNum] } = parseArgs(getArgs());
+const port = Number(portNum ?? 1883);
+const hostname = "::";
+logger.level(LogLevel.info);
+/**
+ * TCP Server instance with authentication and authorization handlers
+ */
+const tcpServer = new TcpServer({ port, hostname }, {
+    handlers: {
+        isAuthenticated,
+        isAuthorizedToPublish,
+        isAuthorizedToSubscribe,
+    },
+});
+tcpServer.start();
+logger.info(`Server started on port ${tcpServer.port}`);
+//# sourceMappingURL=demoServer.js.map

package/dist/bin/demoServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"demoServer.js","sourceRoot":"","sources":["../../bin/demoServer.ts"],"names":[],"mappings":";AAEA;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;AAEtC;;GAEG;AACH,MAAM,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;AAC5B,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;AAC/C,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;AAE/C;;;GAGG;AACH,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,aAAa,GAAG,KAAK,CAAC;AAE5B;;;;;;;GAOG;AACH,SAAS,eAAe,CACtB,IAAa,EACb,QAAgB,EAChB,QAAgB,EAChB,QAAoB;IAEpB,MAAM,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,CAAC,IAAI,CACT,uCAAuC,QAAQ,oBAAoB,QAAQ,mBAAmB,GAAG,GAAG,CACrG,CAAC;IAEF,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,yBAAyB;QACzB,OAAO,oBAAoB,CAAC,EAAE,CAAC;IACjC,CAAC;IACD,wDAAwD;IACxD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,OAAO,oBAAoB,CAAC,qBAAqB,CAAC;IACpD,CAAC;IACD,qDAAqD;IACrD,IAAI,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,oBAAoB,CAAC,EAAE,CAAC;QACjC,CAAC;IACH,CAAC;IACD,OAAO,oBAAoB,CAAC,aAAa,CAAC;AAC5C,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,GAAY,EAAE,KAAY;IACvD,MAAM,CAAC,KAAK,CACV,qCAAqC,GAAG,CAAC,KAAK,EAAE,QAAQ,0BAA0B,KAAK,GAAG,CAC3F,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAS,uBAAuB,CAAC,GAAY,EAAE,KAAY;IACzD,MAAM,CAAC,KAAK,CACV,qCAAqC,GAAG,CAAC,KAAK,EAAE,QAAQ,4BAA4B,KAAK,GAAG,CAC7F,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,MAAM,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;AAC9C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC;AACrC,MAAM,QAAQ,GAAG,IAAI,CAAC;AACtB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAE5B;;GAEG;AACH,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;IAClD,QAAQ,EAAE;QACR,eAAe;QACf,qBAAqB;QACrB,uBAAuB;KACxB;CACF,CAAC,CAAC;AACH,SAAS,CAAC,KAAK,EAAE,CAAC;AAClB,MAAM,CAAC,IAAI,CAAC,0BAA0B,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC"}

package/dist/bin/mqtt.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --experimental-strip-types
+export {};
+//# sourceMappingURL=mqtt.d.ts.map

package/dist/bin/mqtt.d.ts.map

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

package/dist/bin/mqtt.js

@@ -0,0 +1,257 @@
+#!/usr/bin/env -S node --experimental-strip-types
+/**
+ * @fileoverview MQTT command line interface that provides publish and subscribe functionality
+ * @module mqtt-cli
+ *
+ * @description
+ * This module implements a command line interface for MQTT operations:
+ * - Publish messages to an MQTT broker
+ * - Subscribe to topics on an MQTT broker
+ *
+ * Features:
+ * - TLS support with custom certificates
+ * - Authentication with username/password
+ * - Configurable QoS levels (0-2)
+ * - Message retention
+ * - Session persistence
+ * - Custom client IDs
+ *
+ * @example
+ * # Publish a message
+ * mqtt publish -t topic -m message
+ *
+ * # Subscribe to a topic
+ * mqtt subscribe -t topic
+ *
+ * @requires node
+ * @requires ../client/mod.ts
+ * @requires ../node/tcpClient.ts
+ * @requires ../utils/mod.ts
+ */
+import { DEFAULT_URL } from "../client/mod.js";
+import { getFileData, TcpClient } from "../node/tcpClient.js";
+import { getArgs, logger, LogLevel, parseArgs } from "../utils/mod.js";
+const client = new TcpClient();
+const encoder = new TextEncoder();
+const decoder = new TextDecoder();
+logger.level(LogLevel.info);
+const MQTTHelp = `MQTT command line interface, available commands are:
+
+    * publish     publish a message to the broker
+    * subscribe   subscribe for updates from the broker
+
+Run 'mqtt [command] --help' to know more about the commands.`;
+const ConnectHelp = `
+  -u/--url        the URL to connect to: default is ${DEFAULT_URL}
+  -i/--clientId   the clientId to connect to the server
+  -U/--username   the username to connect to the server
+  -P/--password   the password to connect to the server
+  -C/--caFile     the path to a CA certificate file
+  -c/--certFile   the path to a certificate file
+  -k/--keyFile    the path to a key file
+  -n/--noClean    try to resume a previous session
+  -h/--help       this text
+  `;
+const connectOpts = {
+    string: [
+        "url",
+        "username",
+        "password",
+        "caFile",
+        "certFile",
+        "keyFile",
+        "clientId",
+    ],
+    alias: {
+        u: "url",
+        U: "username",
+        P: "password",
+        C: "caFile",
+        c: "certFile",
+        k: "keyFile",
+        i: "clientId",
+        n: "noClean",
+        h: "help",
+    },
+    boolean: ["noClean", "help"],
+    default: {
+        noClean: false,
+        clientId: `Opifex-${crypto.randomUUID()}`,
+    },
+};
+const SubscribeHelp = `Usage: mqtt subscribe <options>
+
+Where options are:
+  -t/--topic      the topic to use
+  -q/--qos        the QoS (0/1/2) to use, default is 0
+${ConnectHelp}
+Example: mqtt subscribe -t hello`;
+const subscribeOpts = {
+    string: ["topic"],
+    alias: {
+        t: "topic",
+        q: "qos",
+    },
+    default: {
+        qos: 0,
+        topic: "",
+    },
+};
+function parseQos(qosArg) {
+    const qos = Number(qosArg);
+    switch (qos) {
+        case 0:
+            return 0;
+        case 1:
+            return 1;
+        case 2:
+            return 2;
+        default:
+            break;
+    }
+    console.log("QoS must be between 0 and 2");
+    return 0;
+}
+async function getTLSdata(connectArgs) {
+    const caFileData = await getFileData(connectArgs.caFile);
+    const caCerts = caFileData ? [caFileData] : undefined;
+    const cert = await getFileData(connectArgs.certFile);
+    const key = await getFileData(connectArgs.keyFile);
+    return {
+        caCerts,
+        cert,
+        key,
+    };
+}
+async function subscribe() {
+    const connectArgs = parseArgs(getArgs(), connectOpts);
+    const { caCerts, cert, key, } = await getTLSdata(connectArgs);
+    const subscribeArgs = parseArgs(getArgs(), subscribeOpts);
+    if (connectArgs.help) {
+        console.log(SubscribeHelp);
+        return;
+    }
+    if (subscribeArgs.topic === undefined) {
+        console.log("Missing `topic`");
+        return;
+    }
+    try {
+        await client.connect({
+            url: connectArgs.url,
+            caCerts,
+            cert,
+            key,
+            options: {
+                username: connectArgs.username,
+                password: encoder.encode(connectArgs.password),
+                clientId: connectArgs.clientId,
+                clean: !connectArgs.noClean,
+                keepAlive: 60,
+            },
+        });
+        logger.debug("Connected !");
+        client.subscribe({
+            subscriptions: [
+                {
+                    topicFilter: subscribeArgs.topic,
+                    qos: parseQos(subscribeArgs.qos),
+                },
+            ],
+        });
+        logger.debug("Subscribed!");
+        for await (const message of client.messages()) {
+            console.log(decoder.decode(message.payload));
+        }
+    }
+    catch (err) {
+        if (err instanceof Error) {
+            // @ts-ignore the type spec of err is missing err.code
+            logger.info(`Error: ${err.message || err.code}`);
+        }
+    }
+}
+const PublishHelp = `Usage: mqtt publish <options>
+
+Where options are:
+  -t/--topic      the topic to use
+  -m/--message    the message to send
+  -q/--qos        the QoS (0/1/2) to use, default is 0
+  -r/--retain     if the message should be retained, default is false
+${ConnectHelp}
+Example: mqtt publish -t hello -m world`;
+const publishOpts = {
+    string: ["topic", "message"],
+    boolean: ["retain"],
+    alias: {
+        t: "topic",
+        m: "message",
+        q: "qos",
+        r: "retain",
+    },
+    default: {
+        qos: 0,
+        dup: false,
+        retain: false,
+        topic: undefined,
+        message: "",
+    },
+};
+async function publish() {
+    const connectArgs = parseArgs(getArgs(), connectOpts);
+    const { caCerts, cert, key, } = await getTLSdata(connectArgs);
+    const publishArgs = parseArgs(getArgs(), publishOpts);
+    if (connectArgs.help) {
+        console.log(PublishHelp);
+        return;
+    }
+    if (publishArgs.topic === undefined) {
+        console.log("Missing `topic`");
+        return;
+    }
+    try {
+        await client.connect({
+            url: connectArgs.url,
+            caCerts,
+            cert,
+            key,
+            options: {
+                username: connectArgs.username,
+                password: encoder.encode(connectArgs.password),
+                clientId: connectArgs.clientId,
+                clean: !connectArgs.noClean,
+            },
+        });
+        logger.debug("Connected !");
+        await client.publish({
+            topic: publishArgs.topic,
+            payload: encoder.encode(publishArgs.message),
+            retain: publishArgs.retain,
+            qos: parseQos(publishArgs.qos),
+        });
+        logger.debug("Published!");
+        client.disconnect();
+        logger.debug("Disconnected !");
+    }
+    catch (err) {
+        if (err instanceof Error) {
+            // @ts-ignore the type spec of err is missing err.code
+            logger.info(`Error: ${err.message || err.code}`);
+        }
+    }
+}
+function processArgs() {
+    const { _: [cmd] } = parseArgs(getArgs());
+    switch (cmd) {
+        case "publish":
+            publish();
+            break;
+        case "subscribe":
+            subscribe();
+            break;
+        default:
+            console.log(MQTTHelp);
+            break;
+    }
+}
+processArgs();
+//# sourceMappingURL=mqtt.js.map

package/dist/bin/mqtt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.js","sourceRoot":"","sources":["../../bin/mqtt.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGvE,MAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;AAC/B,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAClC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAClC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAE5B,MAAM,QAAQ,GAAG;;;;;6DAK4C,CAAC;AAE9D,MAAM,WAAW,GAAG;sDACkC,WAAW;;;;;;;;;GAS9D,CAAC;AAEJ,MAAM,WAAW,GAAG;IAClB,MAAM,EAAE;QACN,KAAK;QACL,UAAU;QACV,UAAU;QACV,QAAQ;QACR,UAAU;QACV,SAAS;QACT,UAAU;KACX;IACD,KAAK,EAAE;QACL,CAAC,EAAE,KAAK;QACR,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,QAAQ;QACX,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,SAAS;QACZ,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,SAAS;QACZ,CAAC,EAAE,MAAM;KACV;IACD,OAAO,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC;IAC5B,OAAO,EAAE;QACP,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,UAAU,MAAM,CAAC,UAAU,EAAE,EAAE;KAC1C;CACF,CAAC;AAEF,MAAM,aAAa,GAAG;;;;;EAKpB,WAAW;iCACoB,CAAC;AAElC,MAAM,aAAa,GAAG;IACpB,MAAM,EAAE,CAAC,OAAO,CAAC;IACjB,KAAK,EAAE;QACL,CAAC,EAAE,OAAO;QACV,CAAC,EAAE,KAAK;KACT;IACD,OAAO,EAAE;QACP,GAAG,EAAE,CAAC;QACN,KAAK,EAAE,EAAE;KACV;CACF,CAAC;AAEF,SAAS,QAAQ,CAAC,MAAuB;IACvC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3B,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,CAAC;YACJ,OAAO,CAAC,CAAC;QACX,KAAK,CAAC;YACJ,OAAO,CAAC,CAAC;QACX,KAAK,CAAC;YACJ,OAAO,CAAC,CAAC;QACX;YACE,MAAM;IACV,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAC3C,OAAO,CAAC,CAAC;AACX,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,WAAiB;IACzC,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACzD,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACtD,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO;QACL,OAAO;QACP,IAAI;QACJ,GAAG;KACJ,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,SAAS;IACtB,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,EAAE,EAAE,WAAW,CAAC,CAAC;IACtD,MAAM,EACJ,OAAO,EACP,IAAI,EACJ,GAAG,GACJ,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC;IAClC,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,EAAE,EAAE,aAAa,CAAC,CAAC;IAC1D,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC3B,OAAO;IACT,CAAC;IACD,IAAI,aAAa,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACtC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC/B,OAAO;IACT,CAAC;IACD,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,GAAG,EAAE,WAAW,CAAC,GAAG;YACpB,OAAO;YACP,IAAI;YACJ,GAAG;YACH,OAAO,EAAE;gBACP,QAAQ,EAAE,WAAW,CAAC,QAAQ;gBAC9B,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;gBAC9C,QAAQ,EAAE,WAAW,CAAC,QAAQ;gBAC9B,KAAK,EAAE,CAAC,WAAW,CAAC,OAAO;gBAC3B,SAAS,EAAE,EAAE;aACd;SACF,CAAC,CAAC;QACH,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAE5B,MAAM,CAAC,SAAS,CAAC;YACf,aAAa,EAAE;gBACb;oBACE,WAAW,EAAE,aAAa,CAAC,KAAK;oBAChC,GAAG,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC;iBACjC;aACF;SACF,CAAC,CAAC;QACH,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAE5B,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC9C,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACzB,sDAAsD;YACtD,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,WAAW,GAAG;;;;;;;EAOlB,WAAW;wCAC2B,CAAC;AAEzC,MAAM,WAAW,GAAG;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC;IAC5B,OAAO,EAAE,CAAC,QAAQ,CAAC;IACnB,KAAK,EAAE;QACL,CAAC,EAAE,OAAO;QACV,CAAC,EAAE,SAAS;QACZ,CAAC,EAAE,KAAK;QACR,CAAC,EAAE,QAAQ;KACZ;IACD,OAAO,EAAE;QACP,GAAG,EAAE,CAAC;QACN,GAAG,EAAE,KAAK;QACV,MAAM,EAAE,KAAK;QACb,KAAK,EAAE,SAAS;QAChB,OAAO,EAAE,EAAE;KACZ;CACF,CAAC;AAEF,KAAK,UAAU,OAAO;IACpB,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,EAAE,EAAE,WAAW,CAAC,CAAC;IACtD,MAAM,EACJ,OAAO,EACP,IAAI,EACJ,GAAG,GACJ,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC;IAClC,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,EAAE,EAAE,WAAW,CAAC,CAAC;IACtD,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACzB,OAAO;IACT,CAAC;IACD,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC/B,OAAO;IACT,CAAC;IACD,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,GAAG,EAAE,WAAW,CAAC,GAAG;YACpB,OAAO;YACP,IAAI;YACJ,GAAG;YACH,OAAO,EAAE;gBACP,QAAQ,EAAE,WAAW,CAAC,QAAQ;gBAC9B,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;gBAC9C,QAAQ,EAAE,WAAW,CAAC,QAAQ;gBAC9B,KAAK,EAAE,CAAC,WAAW,CAAC,OAAO;aAC5B;SACF,CAAC,CAAC;QACH,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC5B,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,KAAK,EAAE,WAAW,CAAC,KAAK;YACxB,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5C,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC;SAC/B,CAAC,CAAC;QACH,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC3B,MAAM,CAAC,UAAU,EAAE,CAAC;QACpB,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACzB,sDAAsD;YACtD,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,WAAW;IAClB,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1C,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,SAAS;YACZ,OAAO,EAAE,CAAC;YACV,MAAM;QACR,KAAK,WAAW;YACd,SAAS,EAAE,CAAC;YACZ,MAAM;QACR;YACE,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACtB,MAAM;IACV,CAAC;AACH,CAAC;AAED,WAAW,EAAE,CAAC"}

package/dist/client/ConnectionState.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @description Object representing possible connection states
+ * @readonly
+ */
+export declare const ConnectionState: {
+    /** System is offline and not attempting connection */
+    readonly offline: "offline";
+    /** System is in the process of establishing a connection */
+    readonly connecting: "connecting";
+    /** System has an active connection */
+    readonly connected: "connected";
+    /** System is in the process of disconnecting */
+    readonly disconnecting: "disconnecting";
+    /** System has been disconnected */
+    readonly disconnected: "disconnected";
+};
+/**
+ * @description Type representing the possible values of ConnectionState
+ */
+export type TConnectionState = (typeof ConnectionState)[keyof typeof ConnectionState];
+//# sourceMappingURL=ConnectionState.d.ts.map

package/dist/client/ConnectionState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectionState.d.ts","sourceRoot":"","sources":["../../client/ConnectionState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,eAAe;IAC1B,sDAAsD;;IAEtD,4DAA4D;;IAE5D,sCAAsC;;IAEtC,gDAAgD;;IAEhD,mCAAmC;;CAE3B,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAC1B,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC"}

package/dist/client/ConnectionState.js

@@ -0,0 +1,17 @@
+/**
+ * @description Object representing possible connection states
+ * @readonly
+ */
+export const ConnectionState = {
+    /** System is offline and not attempting connection */
+    offline: "offline",
+    /** System is in the process of establishing a connection */
+    connecting: "connecting",
+    /** System has an active connection */
+    connected: "connected",
+    /** System is in the process of disconnecting */
+    disconnecting: "disconnecting",
+    /** System has been disconnected */
+    disconnected: "disconnected",
+};
+//# sourceMappingURL=ConnectionState.js.map

package/dist/client/ConnectionState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectionState.js","sourceRoot":"","sources":["../../client/ConnectionState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,sDAAsD;IACtD,OAAO,EAAE,SAAS;IAClB,4DAA4D;IAC5D,UAAU,EAAE,YAAY;IACxB,sCAAsC;IACtC,SAAS,EAAE,WAAW;IACtB,gDAAgD;IAChD,aAAa,EAAE,eAAe;IAC9B,mCAAmC;IACnC,YAAY,EAAE,cAAc;CACpB,CAAC"}