@seriousme/opifex 1.7.0 → 1.8.0

package/dist/utils/deferred.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Create a promise that can be resolved/rejected later
+ */
+export declare class Deferred<T> {
+    promise: Promise<T>;
+    resolve: (val: T) => void;
+    reject: (err: Error) => void;
+    constructor();
+}
+//# sourceMappingURL=deferred.d.ts.map

package/dist/utils/deferred.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deferred.d.ts","sourceRoot":"","sources":["../../utils/deferred.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,qBAAa,QAAQ,CAAC,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,EAAG,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,CAAC;IAC3B,MAAM,EAAG,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAC;;CAQ/B"}

package/dist/utils/deferred.js

@@ -0,0 +1,15 @@
+/**
+ * Create a promise that can be resolved/rejected later
+ */
+export class Deferred {
+    promise;
+    resolve;
+    reject;
+    constructor() {
+        this.promise = new Promise((resolve, reject) => {
+            this.resolve = resolve;
+            this.reject = reject;
+        });
+    }
+}
+//# sourceMappingURL=deferred.js.map

package/dist/utils/deferred.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deferred.js","sourceRoot":"","sources":["../../utils/deferred.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,OAAO,QAAQ;IACnB,OAAO,CAAa;IACpB,OAAO,CAAoB;IAC3B,MAAM,CAAwB;IAE9B;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/utils/logger.d.ts

@@ -0,0 +1,63 @@
+/**
+ * The available log levels
+ */
+export declare const LogLevel: {
+    readonly error: 0;
+    readonly warn: 1;
+    readonly info: 2;
+    readonly verbose: 3;
+    readonly debug: 4;
+};
+export type TLogLevel = typeof LogLevel[keyof typeof LogLevel];
+/**
+ * Simple logger class
+ * @example
+ * ```ts
+ * const logger = new Logger();
+ * logger.level(LogLevel.debug);
+ * logger.debug("debug message");
+ * logger.verbose("verbose message");
+ * logger.info("info message");
+ * logger.warn("warn message");
+ * logger.error("error message");
+ * ```
+ */
+export declare class Logger {
+    private defaultError;
+    private defaultWarn;
+    private defaultInfo;
+    private defaultVerbose;
+    private defaultDebug;
+    private noop;
+    error: {
+        (...data: any[]): void;
+        (message?: any, ...optionalParams: any[]): void;
+    };
+    warn: {
+        (...data: any[]): void;
+        (message?: any, ...optionalParams: any[]): void;
+    };
+    info: {
+        (...data: any[]): void;
+        (message?: any, ...optionalParams: any[]): void;
+    };
+    verbose: (..._data: any[]) => void;
+    debug: (..._data: any[]) => void;
+    constructor();
+    level(logLevel: TLogLevel): void;
+}
+/**
+ * logger provides a singleton logger instance
+ * @example
+ * ```ts
+ * import { logger } from "./utils/logger.ts";
+ * logger.level(LogLevel.debug);
+ * logger.debug("debug message");
+ * logger.verbose("verbose message");
+ * logger.info("info message");
+ * logger.warn("warn message");
+ * logger.error("error message");
+ * ```
+ */
+export declare const logger: Logger;
+//# sourceMappingURL=logger.d.ts.map

package/dist/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../utils/logger.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,QAAQ;;;;;;CAMX,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,OAAO,QAAQ,CAAC,MAAM,OAAO,QAAQ,CAAC,CAAC;AAE/D;;;;;;;;;;;;GAYG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,YAAY,CAAiB;IACrC,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,cAAc,CAAe;IACrC,OAAO,CAAC,YAAY,CAAe;IAEnC,OAAO,CAAC,IAAI,CAA2B;IACvC,KAAK;;;MAAqB;IAC1B,IAAI;;;MAAoB;IACxB,IAAI;;;MAAoB;IACxB,OAAO,aAJmB,GAAG,EAAE,UAIX;IACpB,KAAK,aALqB,GAAG,EAAE,UAKb;;IAIlB,KAAK,CAAC,QAAQ,EAAE,SAAS;CAM1B;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,MAAM,EAAE,MAAqB,CAAC"}

package/dist/utils/logger.js

@@ -0,0 +1,59 @@
+/**
+ * The available log levels
+ */
+export const LogLevel = {
+    error: 0,
+    warn: 1,
+    info: 2,
+    verbose: 3,
+    debug: 4,
+};
+/**
+ * Simple logger class
+ * @example
+ * ```ts
+ * const logger = new Logger();
+ * logger.level(LogLevel.debug);
+ * logger.debug("debug message");
+ * logger.verbose("verbose message");
+ * logger.info("info message");
+ * logger.warn("warn message");
+ * logger.error("error message");
+ * ```
+ */
+export class Logger {
+    defaultError = console.error;
+    defaultWarn = console.warn;
+    defaultInfo = console.info;
+    defaultVerbose = console.log;
+    defaultDebug = console.log;
+    // deno-lint-ignore no-explicit-any
+    noop = (..._data) => { };
+    error = this.defaultError;
+    warn = this.defaultWarn;
+    info = this.defaultInfo;
+    verbose = this.noop;
+    debug = this.noop;
+    constructor() { }
+    level(logLevel) {
+        this.warn = logLevel > 0 ? this.defaultWarn : this.noop;
+        this.info = logLevel > 1 ? this.defaultInfo : this.noop;
+        this.verbose = logLevel > 2 ? this.defaultVerbose : this.noop;
+        this.debug = logLevel > 3 ? this.defaultDebug : this.noop;
+    }
+}
+/**
+ * logger provides a singleton logger instance
+ * @example
+ * ```ts
+ * import { logger } from "./utils/logger.ts";
+ * logger.level(LogLevel.debug);
+ * logger.debug("debug message");
+ * logger.verbose("verbose message");
+ * logger.info("info message");
+ * logger.warn("warn message");
+ * logger.error("error message");
+ * ```
+ */
+export const logger = new Logger();
+//# sourceMappingURL=logger.js.map

package/dist/utils/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../utils/logger.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,CAAC;IACV,KAAK,EAAE,CAAC;CACA,CAAC;AAIX;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,MAAM;IACT,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC;IAC7B,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAC7B,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IACnC,mCAAmC;IAC3B,IAAI,GAAG,CAAC,GAAG,KAAY,EAAE,EAAE,GAAE,CAAC,CAAC;IACvC,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC;IAC1B,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;IACxB,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;IACxB,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;IACpB,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC;IAElB,gBAAe,CAAC;IAEhB,KAAK,CAAC,QAAmB;QACvB,IAAI,CAAC,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACxD,IAAI,CAAC,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAC9D,IAAI,CAAC,KAAK,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IAC5D,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,MAAM,GAAW,IAAI,MAAM,EAAE,CAAC"}

package/dist/utils/mod.d.ts

@@ -0,0 +1,13 @@
+/**
+ *  This module provides various utilities
+ *  @module
+ */
+export { assert } from "./assert.ts";
+export { Deferred } from "./deferred.ts";
+export { Logger, logger, LogLevel } from "./logger.ts";
+export { AsyncQueue } from "./asyncQueue.ts";
+export { nextTick } from "./nextTick.ts";
+export { parseArgs } from "./args.ts";
+export type { Args } from "./args.ts";
+export { getArgs } from "./platform.ts";
+//# sourceMappingURL=mod.d.ts.map

package/dist/utils/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../utils/mod.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,YAAY,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC"}

package/dist/utils/mod.js

@@ -0,0 +1,12 @@
+/**
+ *  This module provides various utilities
+ *  @module
+ */
+export { assert } from "./assert.js";
+export { Deferred } from "./deferred.js";
+export { Logger, logger, LogLevel } from "./logger.js";
+export { AsyncQueue } from "./asyncQueue.js";
+export { nextTick } from "./nextTick.js";
+export { parseArgs } from "./args.js";
+export { getArgs } from "./platform.js";
+//# sourceMappingURL=mod.js.map

package/dist/utils/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../utils/mod.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC"}

package/dist/utils/nextTick.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Returns a promise that resolves on the next tick of the Node.js event loop.
+ * This is useful for deferring execution of code until after the current call stack is cleared.
+ *
+ * @example
+ * ```ts
+ * async function example() {
+ *   console.log('Before nextTick');
+ *   await nextTick();
+ *   console.log('After nextTick');
+ * }
+ * ```
+ *
+ * @returns {Promise<void>} A promise that resolves on the next tick of the event loop
+ */
+export declare function nextTick(): Promise<void>;
+//# sourceMappingURL=nextTick.d.ts.map

package/dist/utils/nextTick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nextTick.d.ts","sourceRoot":"","sources":["../../utils/nextTick.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAExC"}

package/dist/utils/nextTick.js

@@ -0,0 +1,19 @@
+/**
+ * Returns a promise that resolves on the next tick of the Node.js event loop.
+ * This is useful for deferring execution of code until after the current call stack is cleared.
+ *
+ * @example
+ * ```ts
+ * async function example() {
+ *   console.log('Before nextTick');
+ *   await nextTick();
+ *   console.log('After nextTick');
+ * }
+ * ```
+ *
+ * @returns {Promise<void>} A promise that resolves on the next tick of the event loop
+ */
+export function nextTick() {
+    return new Promise((resolve) => setTimeout(resolve, 0));
+}
+//# sourceMappingURL=nextTick.js.map

package/dist/utils/nextTick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nextTick.js","sourceRoot":"","sources":["../../utils/nextTick.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,QAAQ;IACtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;AAC1D,CAAC"}

package/dist/utils/platform.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @returns an array of command line arguments
+ */
+export declare function getArgs(): string[];
+//# sourceMappingURL=platform.d.ts.map

package/dist/utils/platform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../../utils/platform.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,OAAO,IAAI,MAAM,EAAE,CAElC"}

package/dist/utils/platform.js

@@ -0,0 +1,8 @@
+import { argv } from "node:process";
+/**
+ * @returns an array of command line arguments
+ */
+export function getArgs() {
+    return argv.slice(2);
+}
+//# sourceMappingURL=platform.js.map

package/dist/utils/platform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.js","sourceRoot":"","sources":["../../utils/platform.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC;;GAEG;AACH,MAAM,UAAU,OAAO;IACrB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC"}

package/examples/tcpServer.test.ts

@@ -0,0 +1,149 @@
+import { test } from "node:test";
+import assert from "node:assert/strict";
+import { TcpClient } from "@seriousme/opifex/tcpClient";
+import { TcpServer } from "@seriousme/opifex/tcpServer";
+import { logger, LogLevel } from "@seriousme/opifex/utils";
+import type { PublishPacket, QoS } from "@seriousme/opifex/mqttPacket";
+
+logger.level(LogLevel.info);
+export function sleep(ms: number): Promise<unknown> {
+  return new Promise((r) => setTimeout(r, ms));
+}
+
+test("Test pubSub using client and server", async function () {
+  const server = new TcpServer({ port: 0 }, {});
+  server.start();
+
+  assert.deepStrictEqual(
+    server.port !== undefined,
+    true,
+    "server runs a a random port",
+  );
+  logger.verbose({ port: server.port, address: server.address });
+
+  const params = {
+    url: new URL(`mqtt://${server.address}:${server.port}`),
+    numberOfRetries: 0,
+  };
+
+  const client = new TcpClient();
+
+  await client.connect(params);
+  assert(true, "Client connected to server");
+
+  const publishSet: { topic: string; qos: QoS }[] = [
+    { topic: "t0@q0", qos: 0 },
+    { topic: "t1@q0", qos: 0 },
+    { topic: "t2@q0", qos: 0 },
+    { topic: "t0@q1", qos: 1 },
+    { topic: "t1@q1", qos: 1 },
+    { topic: "t2@q1", qos: 1 },
+    { topic: "t0@q2", qos: 2 },
+    { topic: "t1@q2", qos: 2 },
+    { topic: "t2@q2", qos: 2 },
+  ];
+
+  const subscriptions = publishSet.map((item) => ({
+    topicFilter: item.topic,
+    qos: item.qos,
+  }));
+  await client.subscribe({
+    subscriptions,
+  });
+
+  // the IIFE ensures message reception runs in parallel
+  logger.verbose(`Start receiving`);
+  const received: PublishPacket[] = [];
+  (async function () {
+    for await (const item of client.messages()) {
+      logger.verbose(`Receiving: ${item.topic} -- ${item.qos}`);
+      received.push(item);
+    }
+  })();
+  // end of IIFE
+  for (const item of publishSet) {
+    logger.verbose(`Publishing: ${item.topic} -- ${item.qos}`);
+    await client.publish({
+      topic: item.topic,
+      qos: item.qos,
+      payload: new Uint8Array([0x01]),
+    });
+  }
+
+  await sleep(100);
+  logger.verbose(`Disconnect client`);
+  //client.closeMessages();
+  await client.disconnect();
+
+  logger.verbose(`Check completeness`);
+  for (const item of publishSet) {
+    const found = received.find((f) =>
+      f.topic == item.topic && f.qos === item.qos
+    );
+    logger.verbose(`Found: ${item.topic} -- ${item.qos}`);
+    assert(found, `${item.topic} -- ${item.qos}`);
+  }
+
+  logger.verbose(`Stop server`);
+  server.stop();
+});
+
+test("Test subscription persistence after reconnect", async function () {
+  // Start server
+  const server = new TcpServer({ port: 0 }, {});
+  server.start();
+
+  const params = {
+    url: new URL(`mqtt://${server.address}:${server.port}`),
+    numberOfRetries: 0,
+  };
+
+  const client = new TcpClient();
+  const testTopic = "test/topic";
+  const received: PublishPacket[] = [];
+
+  // First connection and subscription
+  await client.connect(params);
+  await client.subscribe({
+    subscriptions: [{
+      topicFilter: testTopic,
+      qos: 0,
+    }],
+  });
+
+  // Start receiving messages
+  (async function () {
+    for await (const item of client.messages()) {
+      received.push(item);
+    }
+  })();
+
+  // Disconnect client
+  await client.disconnect();
+  await sleep(100);
+
+  // Reconnect client
+  await client.connect(params);
+  await sleep(100);
+
+  // Publish test message
+  await client.publish({
+    topic: testTopic,
+    qos: 0,
+    payload: new Uint8Array([0x01]),
+  });
+
+  await sleep(100);
+  logger.verbose(`Disconnect client`);
+  await client.disconnect();
+
+  // Verify message was received
+  assert.equal(received.length, 1, "Should receive one message");
+  assert.equal(
+    received[0].topic,
+    testTopic,
+    "Should receive message on subscribed topic",
+  );
+
+  server.stop();
+});

package/mqttConn/mqttConn.ts

@@ -1,3 +1,7 @@
+/**
+ * @module mqttConn
+ */
+
 import {
   type AnyPacket,
   decodePayload,
@@ -10,21 +14,39 @@ import { assert } from "../utils/mod.ts";
 import type { SockConn } from "../socket/socket.ts";
 import { Conn } from "../socket/socket.ts";
 
+/**
+ * Common MQTT connection error messages
+ */
 export const MqttConnError = {
   invalidPacket: "Invalid Packet",
   packetTooLarge: "Packet too large",
   UnexpectedEof: "Unexpected EOF",
 } as const;
 
+/**
+ * Interface for MQTT connection handling
+ */
 export interface IMqttConn extends AsyncIterable<AnyPacket> {
+  /** Underlying connection */
   readonly conn: Conn;
+  /** Whether connection is closed */
   readonly isClosed: boolean;
+  /** Reason for connection closure if any */
   readonly reason: string | undefined;
+  /** Async iterator for receiving packets */
   [Symbol.asyncIterator](): AsyncIterableIterator<AnyPacket>;
+  /** Send an MQTT packet */
   send(data: AnyPacket): Promise<void>;
+  /** Close the connection */
   close(): void;
 }
 
+/**
+ * Read a single byte from the connection
+ * @param conn Connection to read from
+ * @returns Single byte as number
+ * @throws Error if EOF reached unexpectedly
+ */
 async function readByte(conn: Conn): Promise<number> {
   const buf = new Uint8Array(1);
   const bytesRead = await conn.read(buf);
@@ -33,6 +55,12 @@ async function readByte(conn: Conn): Promise<number> {
   return buf[0];
 }
 
+/**
+ * Read exact number of bytes into buffer
+ * @param conn Connection to read from
+ * @param buf Buffer to read into
+ * @throws Error if EOF reached unexpectedly
+ */
 async function readFull(conn: Conn, buf: Uint8Array): Promise<void> {
   let bytesRead = 0;
   while (bytesRead < buf.length) {
@@ -43,8 +71,12 @@ async function readFull(conn: Conn, buf: Uint8Array): Promise<void> {
   }
 }
 
-/** Read MQTT packet
- * @throws `Error` if packet is invalid
+/**
+ * Read a complete MQTT packet from the connection
+ * @param conn Connection to read from
+ * @param maxPacketSize Maximum allowed packet size
+ * @returns Decoded MQTT packet
+ * @throws Error if packet is invalid or too large
  */
 export async function readPacket(
   conn: Conn,
@@ -70,12 +102,25 @@ export async function readPacket(
   return packet;
 }
 
+/**
+ * MQTT Connection class implementing IMqttConn interface
+ */
 export class MqttConn implements IMqttConn {
+  /** Underlying connection */
   readonly conn: Conn;
+  /** Maximum allowed packet size */
   private readonly maxPacketSize: number;
+  /** Reason for connection closure if any */
   private _reason: string | undefined = undefined;
+  /** Whether connection is closed */
   private _isClosed = false;
 
+  /**
+   * Create new MQTT connection
+   * @param options Connection options
+   * @param options.conn Underlying socket connection
+   * @param options.maxPacketSize Maximum allowed packet size (default 2MB)
+   */
   constructor({
     conn,
     maxPacketSize,
@@ -87,10 +132,15 @@ export class MqttConn implements IMqttConn {
     this.maxPacketSize = maxPacketSize || 2 * 1024 * 1024;
   }
 
+  /** Get reason for connection closure */
   get reason(): string | undefined {
     return this._reason;
   }
 
+  /**
+   * Async iterator for receiving packets
+   * @yields MQTT packets
+   */
   async *[Symbol.asyncIterator](): AsyncIterableIterator<AnyPacket> {
     while (!this._isClosed) {
       try {
@@ -109,6 +159,10 @@ export class MqttConn implements IMqttConn {
     }
   }
 
+  /**
+   * Send an MQTT packet
+   * @param data Packet to send
+   */
   async send(data: AnyPacket): Promise<void> {
     try {
       await this.conn.write(encode(data));
@@ -120,10 +174,12 @@ export class MqttConn implements IMqttConn {
     }
   }
 
+  /** Whether connection is closed */
   get isClosed(): boolean {
     return this._isClosed;
   }
 
+  /** Close the connection */
   close(): void {
     if (this.isClosed) return;
     try {

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@seriousme/opifex",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "MQTT client & server for Deno & NodeJS",
   "type": "module",
   "scripts": {
     "test": "node --experimental-strip-types --test --test-skip-pattern='/^Deno/'",
     "prebuild": "rm -rf dist",
     "build": "npx -p typescript tsc --build",
-    "postbuild": "deno fmt",
+    "format": "deno fmt",
     "preversion": "npm run test",
-    "version": "npm run build",
-    "postversion": "jq '( { name:.name , version:.version, license:.license } + .deno)' package.json > deno.json"
+    "postversion": "jq '( { name:.name , version:.version, license:.license } + .deno)' package.json > deno.json",
+    "postpostversion": "deno install"
   },
   "keywords": [
     "MQTT",
@@ -32,21 +32,25 @@
     "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",
+    "./persistence": "./dist/persistence/persistence.js",
+    "./mqttConn": "./dist/mqttConn/mod.js",
     "./mqttPacket": "./dist/mqttPacket/mod.js",
-    "./utils": "./dist/utils/mod.js",
-    "./tcpClient": "./dist/node/tcpClient.js",
-    "./tcpServer": "./dist/node/tcpServer.js"
+    "./utils": "./dist/utils/mod.js"
   },
   "deno": {
     "exports": {
+      "./tcpClient": "./deno/tcpClient.ts",
+      "./tcpServer": "./deno/tcpServer.ts",
       "./server": "./server/mod.ts",
       "./client": "./client/mod.ts",
+      "./persistence": "./persistence/persistence.ts",
+      "./mqttConn": "./mqttConn/mod.ts",
       "./mqttPacket": "./mqttPacket/mod.ts",
-      "./utils": "./utils/mod.ts",
-      "./tcpClient": "./deno/tcpClient.ts",
-      "./tcpServer": "./deno/tcpServer.ts"
+      "./utils": "./utils/mod.ts"
     },
     "exclude": [
       "dist"