@seriousme/opifex 1.8.1 → 1.8.2

package/README.md

@@ -90,16 +90,16 @@ 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                               |
+| 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/persistence | 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
 

package/dist/mqttPacket/BitMask.d.ts

@@ -1,11 +1,15 @@
-export declare const BitMask: {
-    readonly bit0: number;
-    readonly bit1: number;
-    readonly bit2: number;
-    readonly bit3: number;
-    readonly bit4: number;
-    readonly bit5: number;
-    readonly bit6: number;
-    readonly bit7: number;
-};
+/**
+ * Object containing bit mask values from 2^0 to 2^7
+ * @constant
+ * @type {Record<string,number>}
+ * @property {number} bit0 - Represents 2^0 = 1
+ * @property {number} bit1 - Represents 2^1 = 2
+ * @property {number} bit2 - Represents 2^2 = 4
+ * @property {number} bit3 - Represents 2^3 = 8
+ * @property {number} bit4 - Represents 2^4 = 16
+ * @property {number} bit5 - Represents 2^5 = 32
+ * @property {number} bit6 - Represents 2^6 = 64
+ * @property {number} bit7 - Represents 2^7 = 128
+ */
+export declare const BitMask: Record<string, number>;
 //# sourceMappingURL=BitMask.d.ts.map

package/dist/mqttPacket/BitMask.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BitMask.d.ts","sourceRoot":"","sources":["../../mqttPacket/BitMask.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO;;;;;;;;;CASV,CAAC"}
+{"version":3,"file":"BitMask.d.ts","sourceRoot":"","sources":["../../mqttPacket/BitMask.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CASjC,CAAC"}

package/dist/mqttPacket/BitMask.js

@@ -1,3 +1,16 @@
+/**
+ * Object containing bit mask values from 2^0 to 2^7
+ * @constant
+ * @type {Record<string,number>}
+ * @property {number} bit0 - Represents 2^0 = 1
+ * @property {number} bit1 - Represents 2^1 = 2
+ * @property {number} bit2 - Represents 2^2 = 4
+ * @property {number} bit3 - Represents 2^3 = 8
+ * @property {number} bit4 - Represents 2^4 = 16
+ * @property {number} bit5 - Represents 2^5 = 32
+ * @property {number} bit6 - Represents 2^6 = 64
+ * @property {number} bit7 - Represents 2^7 = 128
+ */
 export const BitMask = {
     bit0: 2 ** 0,
     bit1: 2 ** 1,

package/dist/mqttPacket/BitMask.js.map

@@ -1 +1 @@
-{"version":3,"file":"BitMask.js","sourceRoot":"","sources":["../../mqttPacket/BitMask.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;CACJ,CAAC"}
+{"version":3,"file":"BitMask.js","sourceRoot":"","sources":["../../mqttPacket/BitMask.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,OAAO,GAA2B;IAC7C,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,CAAC;CACJ,CAAC"}

package/dist/mqttPacket/PacketType.d.ts

@@ -1,3 +1,6 @@
+/**
+ *  Possible MQTT packet types
+ */
 export declare const PacketType: {
     readonly reserved: 0;
     readonly connect: 1;
@@ -15,5 +18,8 @@ export declare const PacketType: {
     readonly pingres: 13;
     readonly disconnect: 14;
 };
+/**
+ * Reverse lookup for packet types
+ */
 export declare const PacketNameByType: Record<number, string>;
 //# sourceMappingURL=PacketType.d.ts.map

package/dist/mqttPacket/PacketType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PacketType.d.ts","sourceRoot":"","sources":["../../mqttPacket/PacketType.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;CAgBb,CAAC;AAEX,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAEnD,CAAC"}
+{"version":3,"file":"PacketType.d.ts","sourceRoot":"","sources":["../../mqttPacket/PacketType.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;CAgBb,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAEnD,CAAC"}

package/dist/mqttPacket/PacketType.js

@@ -1,3 +1,6 @@
+/**
+ *  Possible MQTT packet types
+ */
 export const PacketType = {
     reserved: 0,
     connect: 1,
@@ -15,5 +18,8 @@ export const PacketType = {
     pingres: 13,
     disconnect: 14,
 };
+/**
+ * Reverse lookup for packet types
+ */
 export const PacketNameByType = Object.fromEntries(Object.entries(PacketType).map(([k, v]) => [v, k]));
 //# sourceMappingURL=PacketType.js.map

package/dist/mqttPacket/PacketType.js.map

@@ -1 +1 @@
-{"version":3,"file":"PacketType.js","sourceRoot":"","sources":["../../mqttPacket/PacketType.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,QAAQ,EAAE,CAAC;IACX,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC;IACV,MAAM,EAAE,CAAC;IACT,MAAM,EAAE,CAAC;IACT,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IACV,SAAS,EAAE,CAAC;IACZ,MAAM,EAAE,CAAC;IACT,WAAW,EAAE,EAAE;IACf,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,EAAE;CACN,CAAC;AAEX,MAAM,CAAC,MAAM,gBAAgB,GAA2B,MAAM,CAAC,WAAW,CACxE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CACnD,CAAC"}
+{"version":3,"file":"PacketType.js","sourceRoot":"","sources":["../../mqttPacket/PacketType.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,QAAQ,EAAE,CAAC;IACX,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC;IACV,MAAM,EAAE,CAAC;IACT,MAAM,EAAE,CAAC;IACT,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IACV,SAAS,EAAE,CAAC;IACZ,MAAM,EAAE,CAAC;IACT,WAAW,EAAE,EAAE;IACf,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,EAAE;CACN,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA2B,MAAM,CAAC,WAAW,CACxE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CACnD,CAAC"}

package/dist/mqttPacket/decoder.d.ts

@@ -1,24 +1,95 @@
 import type { TBitMask, Topic, TopicFilter } from "./types.ts";
+/**
+ * Checks if a specific bit flag is set in a byte using a bitmask
+ * @param byte - The byte to check
+ * @param mask - The bitmask to apply
+ * @returns True if the flag is set, false otherwise
+ */
 export declare function booleanFlag(byte: number, mask: TBitMask): boolean;
+/**
+ * Checks if a buffer is empty, throws error if not empty
+ * @param buf - The buffer to check
+ * @throws {DecoderError} If buffer is not empty
+ */
 export declare function isEmptyBuf(buf: Uint8Array): void;
+/**
+ * Checks if flags are empty (zero), throws error if not
+ * @param flags - The flags value to check
+ * @throws {DecoderError} If flags are not zero
+ */
 export declare function hasEmptyFlags(flags: number): void;
+/**
+ * Custom error class for decoder errors
+ */
 export declare class DecoderError extends Error {
     constructor(message: string);
 }
+/**
+ * Decoder class for parsing MQTT packets
+ */
 export declare class Decoder {
     private buf;
     private pos;
     private len;
+    /**
+     * Creates a new Decoder instance
+     * @param buf - The buffer to decode
+     * @param pos - Starting position in the buffer (default: 0)
+     */
     constructor(buf: Uint8Array, pos?: number);
+    /**
+     * Checks if the current position is valid
+     * @param pos - Position to check
+     * @throws {DecoderError} If position exceeds buffer length
+     */
     checkpos(pos: number): void;
+    /**
+     * Gets a single byte from the buffer
+     * @returns The byte value
+     */
     getByte(): number;
+    /**
+     * Gets a 16-bit integer from the buffer
+     * @returns The 16-bit integer value
+     */
     getInt16(): number;
+    /**
+     * Gets a byte array from the buffer
+     * @returns A subarray of the buffer
+     */
     getByteArray(): Uint8Array;
+    /**
+     * Gets a UTF-8 string from the buffer
+     * @returns The decoded UTF-8 string
+     */
     getUtf8String(): string;
+    /**
+     * Gets a topic from the buffer
+     * @returns The decoded topic
+     * @throws {DecoderError} If topic is invalid
+     */
     getTopic(): Topic;
+    /**
+     * Gets a topic filter from the buffer
+     * @returns The decoded topic filter
+     * @throws {DecoderError} If topic filter is invalid
+     */
     getTopicFilter(): TopicFilter;
+    /**
+     * Gets the remaining bytes from the current position to the end
+     * @returns The remaining bytes as a subarray
+     */
     getRemainder(): Uint8Array<ArrayBufferLike>;
+    /**
+     * Checks if decoder has reached the end of the buffer
+     * @returns True if at end, false otherwise
+     */
     atEnd(): boolean;
+    /**
+     * Checks if decoding is complete
+     * @returns True if complete
+     * @throws {DecoderError} If packet is too long
+     */
     done(): boolean;
 }
 //# sourceMappingURL=decoder.d.ts.map

package/dist/mqttPacket/decoder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decoder.d.ts","sourceRoot":"","sources":["../../mqttPacket/decoder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAK/D,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,OAAO,CAEjE;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI,CAIhD;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAIjD;AAED,qBAAa,YAAa,SAAQ,KAAK;gBACzB,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,OAAO;IAClB,OAAO,CAAC,GAAG,CAAa;IACxB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,GAAG,CAAS;gBAER,GAAG,EAAE,UAAU,EAAE,GAAG,GAAE,MAAU;IAK5C,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAM3B,OAAO,IAAI,MAAM;IAKjB,QAAQ,IAAI,MAAM;IAMlB,YAAY,IAAI,UAAU;IAS1B,aAAa,IAAI,MAAM;IAKvB,QAAQ,IAAI,KAAK;IAUjB,cAAc,IAAI,WAAW;IAU7B,YAAY;IAOZ,KAAK,IAAI,OAAO;IAMhB,IAAI,IAAI,OAAO;CAMhB"}
+{"version":3,"file":"decoder.d.ts","sourceRoot":"","sources":["../../mqttPacket/decoder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAI/D;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,OAAO,CAEjE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI,CAIhD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAIjD;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,KAAK;gBACzB,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,GAAG,CAAa;IACxB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,GAAG,CAAS;IAEpB;;;;OAIG;gBACS,GAAG,EAAE,UAAU,EAAE,GAAG,GAAE,MAAU;IAM5C;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAM3B;;;OAGG;IACH,OAAO,IAAI,MAAM;IAKjB;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAMlB;;;OAGG;IACH,YAAY,IAAI,UAAU;IAS1B;;;OAGG;IACH,aAAa,IAAI,MAAM;IAKvB;;;;OAIG;IACH,QAAQ,IAAI,KAAK;IAUjB;;;;OAIG;IACH,cAAc,IAAI,WAAW;IAU7B;;;OAGG;IACH,YAAY;IAOZ;;;OAGG;IACH,KAAK,IAAI,OAAO;IAOhB;;;;OAIG;IACH,IAAI,IAAI,OAAO;CAMhB"}

package/dist/mqttPacket/decoder.js

@@ -1,47 +1,91 @@
 import { invalidTopic, invalidTopicFilter } from "./validators.js";
 const utf8Decoder = new TextDecoder("utf-8");
+/**
+ * Checks if a specific bit flag is set in a byte using a bitmask
+ * @param byte - The byte to check
+ * @param mask - The bitmask to apply
+ * @returns True if the flag is set, false otherwise
+ */
 export function booleanFlag(byte, mask) {
     return !!(byte & mask);
 }
+/**
+ * Checks if a buffer is empty, throws error if not empty
+ * @param buf - The buffer to check
+ * @throws {DecoderError} If buffer is not empty
+ */
 export function isEmptyBuf(buf) {
     if (buf.length > 0) {
         throw new DecoderError("Packet too long");
     }
 }
+/**
+ * Checks if flags are empty (zero), throws error if not
+ * @param flags - The flags value to check
+ * @throws {DecoderError} If flags are not zero
+ */
 export function hasEmptyFlags(flags) {
     if (flags !== 0) {
         throw new DecoderError("Invalid fixed header flags");
     }
 }
+/**
+ * Custom error class for decoder errors
+ */
 export class DecoderError extends Error {
     constructor(message) {
         super(message);
         this.name = "DecoderError";
     }
 }
+/**
+ * Decoder class for parsing MQTT packets
+ */
 export class Decoder {
     buf;
     pos;
     len;
+    /**
+     * Creates a new Decoder instance
+     * @param buf - The buffer to decode
+     * @param pos - Starting position in the buffer (default: 0)
+     */
     constructor(buf, pos = 0) {
         this.buf = buf;
         this.pos = pos;
         this.len = buf.length;
     }
+    /**
+     * Checks if the current position is valid
+     * @param pos - Position to check
+     * @throws {DecoderError} If position exceeds buffer length
+     */
     checkpos(pos) {
         if (pos > this.len) {
             throw new DecoderError("Packet too short");
         }
     }
+    /**
+     * Gets a single byte from the buffer
+     * @returns The byte value
+     */
     getByte() {
         this.checkpos(this.pos);
         return this.buf[this.pos++];
     }
+    /**
+     * Gets a 16-bit integer from the buffer
+     * @returns The 16-bit integer value
+     */
     getInt16() {
         const msb = this.getByte();
         const lsb = this.getByte();
         return (msb << 8) | lsb;
     }
+    /**
+     * Gets a byte array from the buffer
+     * @returns A subarray of the buffer
+     */
     getByteArray() {
         const len = this.getInt16();
         const start = this.pos;
@@ -50,10 +94,19 @@ export class Decoder {
         this.checkpos(end);
         return this.buf.subarray(start, end);
     }
+    /**
+     * Gets a UTF-8 string from the buffer
+     * @returns The decoded UTF-8 string
+     */
     getUtf8String() {
         const str = utf8Decoder.decode(this.getByteArray());
         return str;
     }
+    /**
+     * Gets a topic from the buffer
+     * @returns The decoded topic
+     * @throws {DecoderError} If topic is invalid
+     */
     getTopic() {
         const topic = this.getUtf8String();
         if (invalidTopic(topic)) {
@@ -61,6 +114,11 @@ export class Decoder {
         }
         return topic;
     }
+    /**
+     * Gets a topic filter from the buffer
+     * @returns The decoded topic filter
+     * @throws {DecoderError} If topic filter is invalid
+     */
     getTopicFilter() {
         const topicFilter = this.getUtf8String();
         if (invalidTopicFilter(topicFilter)) {
@@ -68,18 +126,31 @@ export class Decoder {
         }
         return topicFilter;
     }
+    /**
+     * Gets the remaining bytes from the current position to the end
+     * @returns The remaining bytes as a subarray
+     */
     getRemainder() {
         const start = this.pos;
         const end = this.len;
         this.pos = end;
         return this.buf.subarray(start, end);
     }
+    /**
+     * Checks if decoder has reached the end of the buffer
+     * @returns True if at end, false otherwise
+     */
     atEnd() {
         if (this.len === this.pos) {
             return true;
         }
         return false;
     }
+    /**
+     * Checks if decoding is complete
+     * @returns True if complete
+     * @throws {DecoderError} If packet is too long
+     */
     done() {
         if (this.atEnd()) {
             return true;

package/dist/mqttPacket/decoder.js.map

@@ -1 +1 @@
-{"version":3,"file":"decoder.js","sourceRoot":"","sources":["../../mqttPacket/decoder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEnE,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;AAE7C,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,IAAc;IACtD,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,GAAe;IACxC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,MAAM,IAAI,YAAY,CAAC,4BAA4B,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC7B,CAAC;CACF;AAED,MAAM,OAAO,OAAO;IACV,GAAG,CAAa;IAChB,GAAG,CAAS;IACZ,GAAG,CAAS;IAEpB,YAAY,GAAe,EAAE,MAAc,CAAC;QAC1C,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC;IACxB,CAAC;IACD,QAAQ,CAAC,GAAW;QAClB,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACnB,MAAM,IAAI,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,QAAQ;QACN,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;IAC1B,CAAC;IAED,YAAY;QACV,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QAC3B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IAED,aAAa;QACX,MAAM,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACpD,OAAO,GAAG,CAAC;IACb,CAAC;IAED,QAAQ;QACN,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACnC,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,YAAY,CACpB,8EAA8E,CAC/E,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,cAAc;QACZ,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACzC,IAAI,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,YAAY,CACpB,uFAAuF,CACxF,CAAC;QACJ,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,YAAY;QACV,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,IAAI,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF"}
+{"version":3,"file":"decoder.js","sourceRoot":"","sources":["../../mqttPacket/decoder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEnE,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;AAC7C;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,IAAc;IACtD,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;AACzB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,GAAe;IACxC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,MAAM,IAAI,YAAY,CAAC,4BAA4B,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC7B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,OAAO;IACV,GAAG,CAAa;IAChB,GAAG,CAAS;IACZ,GAAG,CAAS;IAEpB;;;;OAIG;IACH,YAAY,GAAe,EAAE,MAAc,CAAC;QAC1C,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,GAAW;QAClB,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACnB,MAAM,IAAI,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QAC3B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,MAAM,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACpD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACnC,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,YAAY,CACpB,8EAA8E,CAC/E,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACzC,IAAI,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,YAAY,CACpB,uFAAuF,CACxF,CAAC;QACJ,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,IAAI,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF"}

package/dist/mqttPacket/encoder.d.ts

@@ -1,17 +1,69 @@
 import type { Topic, TopicFilter } from "./types.ts";
+/**
+ * Custom error class for encoding operations
+ */
 export declare class EncoderError extends Error {
     constructor(message: string);
 }
+/**
+ * Encoder class for MQTT packet encoding
+ */
 export declare class Encoder {
+    /** Internal buffer to store encoded bytes */
     private buffer;
+    /**
+     * Creates a new Encoder instance
+     */
     constructor();
+    /**
+     * Adds a single byte to the buffer
+     * @param value - Byte value to add (0-255)
+     * @returns The encoder instance for chaining
+     */
     setByte(value: number): this;
+    /**
+     * Adds a 16-bit integer to the buffer in big-endian format
+     * @param value - 16-bit integer value to add
+     * @returns The encoder instance for chaining
+     */
     setInt16(value: number): this;
+    /**
+     * Adds a byte array to the buffer with length prefix
+     * @param value - Byte array to add
+     * @throws {EncoderError} If array length exceeds 0xffff bytes
+     * @returns The encoder instance for chaining
+     */
     setByteArray(value: Uint8Array): this;
+    /**
+     * Adds a UTF-8 encoded string to the buffer with length prefix
+     * @param value - String to encode and add
+     * @returns The encoder instance for chaining
+     */
     setUtf8String(value: string): this;
+    /**
+     * Adds an MQTT topic string to the buffer
+     * @param value - Topic string to add
+     * @throws {EncoderError} If topic is invalid
+     * @returns The encoder instance for chaining
+     */
     setTopic(value: Topic): this;
+    /**
+     * Adds an MQTT topic filter string to the buffer
+     * @param value - Topic filter string to add
+     * @throws {EncoderError} If topic filter is invalid
+     * @returns The encoder instance for chaining
+     */
     setTopicFilter(value: TopicFilter): this;
+    /**
+     * Adds remaining bytes to the buffer without modification
+     * @param value - Array of bytes to add
+     * @returns The encoder instance for chaining
+     */
     setRemainder(value: Uint8Array | number[]): this;
+    /**
+     * Returns the final encoded buffer
+     * @returns Array containing all encoded bytes
+     */
     done(): number[];
 }
 //# sourceMappingURL=encoder.d.ts.map

package/dist/mqttPacket/encoder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encoder.d.ts","sourceRoot":"","sources":["../../mqttPacket/encoder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGrD,qBAAa,YAAa,SAAQ,KAAK;gBACzB,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,OAAO;IAClB,OAAO,CAAC,MAAM,CAAW;;IAMzB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK5B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAM7B,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IASrC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAU5B,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAUxC,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE,GAAG,IAAI;IAKhD,IAAI,IAAI,MAAM,EAAE;CAGjB"}
+{"version":3,"file":"encoder.d.ts","sourceRoot":"","sources":["../../mqttPacket/encoder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGrD;;GAEG;AACH,qBAAa,YAAa,SAAQ,KAAK;gBACzB,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,OAAO;IAClB,6CAA6C;IAC7C,OAAO,CAAC,MAAM,CAAW;IAEzB;;OAEG;;IAKH;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK5B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAM7B;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IASrC;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAU5B;;;;;OAKG;IACH,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAUxC;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE,GAAG,IAAI;IAKhD;;;OAGG;IACH,IAAI,IAAI,MAAM,EAAE;CAGjB"}

package/dist/mqttPacket/encoder.js

@@ -1,25 +1,51 @@
 const utf8Encoder = new TextEncoder();
 import { invalidTopic, invalidTopicFilter } from "./validators.js";
+/**
+ * Custom error class for encoding operations
+ */
 export class EncoderError extends Error {
     constructor(message) {
         super(message);
         this.name = "EncoderError";
     }
 }
+/**
+ * Encoder class for MQTT packet encoding
+ */
 export class Encoder {
+    /** Internal buffer to store encoded bytes */
     buffer;
+    /**
+     * Creates a new Encoder instance
+     */
     constructor() {
         this.buffer = [];
     }
+    /**
+     * Adds a single byte to the buffer
+     * @param value - Byte value to add (0-255)
+     * @returns The encoder instance for chaining
+     */
     setByte(value) {
         this.buffer.push(value);
         return this;
     }
+    /**
+     * Adds a 16-bit integer to the buffer in big-endian format
+     * @param value - 16-bit integer value to add
+     * @returns The encoder instance for chaining
+     */
     setInt16(value) {
         this.setByte(value >> 8);
         this.setByte(value & 0xff);
         return this;
     }
+    /**
+     * Adds a byte array to the buffer with length prefix
+     * @param value - Byte array to add
+     * @throws {EncoderError} If array length exceeds 0xffff bytes
+     * @returns The encoder instance for chaining
+     */
     setByteArray(value) {
         if (value.length > 0xffff) {
             throw new EncoderError("More than 0xffff bytes of data");
@@ -28,10 +54,21 @@ export class Encoder {
         this.buffer.push(...value);
         return this;
     }
+    /**
+     * Adds a UTF-8 encoded string to the buffer with length prefix
+     * @param value - String to encode and add
+     * @returns The encoder instance for chaining
+     */
     setUtf8String(value) {
         this.setByteArray(utf8Encoder.encode(value));
         return this;
     }
+    /**
+     * Adds an MQTT topic string to the buffer
+     * @param value - Topic string to add
+     * @throws {EncoderError} If topic is invalid
+     * @returns The encoder instance for chaining
+     */
     setTopic(value) {
         if (invalidTopic(value)) {
             throw new EncoderError("Topic must contain valid UTF-8 and contain more than 1 byte and no wildcards");
@@ -39,6 +76,12 @@ export class Encoder {
         this.setUtf8String(value);
         return this;
     }
+    /**
+     * Adds an MQTT topic filter string to the buffer
+     * @param value - Topic filter string to add
+     * @throws {EncoderError} If topic filter is invalid
+     * @returns The encoder instance for chaining
+     */
     setTopicFilter(value) {
         if (invalidTopicFilter(value)) {
             throw new EncoderError("Topicfilter must contain valid UTF-8 and contain more than 1 byte and valid wildcards");
@@ -46,10 +89,19 @@ export class Encoder {
         this.setUtf8String(value);
         return this;
     }
+    /**
+     * Adds remaining bytes to the buffer without modification
+     * @param value - Array of bytes to add
+     * @returns The encoder instance for chaining
+     */
     setRemainder(value) {
         this.buffer.push(...value);
         return this;
     }
+    /**
+     * Returns the final encoded buffer
+     * @returns Array containing all encoded bytes
+     */
     done() {
         return this.buffer;
     }

package/dist/mqttPacket/encoder.js.map

@@ -1 +1 @@
-{"version":3,"file":"encoder.js","sourceRoot":"","sources":["../../mqttPacket/encoder.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEnE,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC7B,CAAC;CACF;AAED,MAAM,OAAO,OAAO;IACV,MAAM,CAAW;IAEzB;QACE,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAY,CAAC,KAAiB;QAC5B,IAAI,KAAK,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;YAC1B,MAAM,IAAI,YAAY,CAAC,gCAAgC,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,KAAa;QACzB,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,KAAY;QACnB,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,YAAY,CACpB,8EAA8E,CAC/E,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,KAAkB;QAC/B,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,YAAY,CACpB,uFAAuF,CACxF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAY,CAAC,KAA4B;QACvC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF"}
+{"version":3,"file":"encoder.js","sourceRoot":"","sources":["../../mqttPacket/encoder.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEnE;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC7B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,OAAO;IAClB,6CAA6C;IACrC,MAAM,CAAW;IAEzB;;OAEG;IACH;QACE,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,KAAiB;QAC5B,IAAI,KAAK,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;YAC1B,MAAM,IAAI,YAAY,CAAC,gCAAgC,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,KAAa;QACzB,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,KAAY;QACnB,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,YAAY,CACpB,8EAA8E,CAC/E,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,KAAkB;QAC/B,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,YAAY,CACpB,uFAAuF,CACxF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,KAA4B;QACvC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF"}

package/dist/mqttPacket/length.d.ts

@@ -1,12 +1,33 @@
+/**
+ * Encodes a number into a variable-length byte array using a modified base-128 encoding
+ * @param n The number to encode
+ * @returns Array of bytes representing the encoded number
+ * @throws Error if the encoded length is greater than 4 bytes
+ */
 export declare function encodeLength(n: number): number[];
+/**
+ * Decodes a variable-length encoded number from a byte array
+ * @param buf The byte array containing the encoded number
+ * @param start The starting position in the buffer to begin decoding
+ * @returns Object containing the decoded length and number of bytes used for encoding
+ * @throws Error if decoding fails
+ */
 export declare function decodeLength(buf: Uint8Array, start: number): {
     length: number;
     numLengthBytes: number;
 };
+/**
+ * Interface for the result returned by the length decoder
+ */
 export type LengthDecoderResult = {
     done: boolean;
     length: number;
     numLengthBytes: number;
 };
+/**
+ * Creates a stateful decoder function for processing variable-length encoded numbers
+ * @returns Function that processes one byte at a time and returns decoding status
+ * @throws Error if the encoded length is greater than 4 bytes
+ */
 export declare function getLengthDecoder(): (encodedByte: number) => LengthDecoderResult;
 //# sourceMappingURL=length.d.ts.map

package/dist/mqttPacket/length.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"length.d.ts","sourceRoot":"","sources":["../../mqttPacket/length.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAehD;AAED,wBAAgB,YAAY,CAC1B,GAAG,EAAE,UAAU,EACf,KAAK,EAAE,MAAM,GACZ;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAAE,CAU5C;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,wBAAgB,gBAAgB,IAAI,CAClC,WAAW,EAAE,MAAM,KAChB,mBAAmB,CAgBvB"}
+{"version":3,"file":"length.d.ts","sourceRoot":"","sources":["../../mqttPacket/length.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAehD;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,UAAU,EACf,KAAK,EAAE,MAAM,GACZ;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAAE,CAU5C;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,CAClC,WAAW,EAAE,MAAM,KAChB,mBAAmB,CAgBvB"}

package/dist/mqttPacket/length.js

@@ -1,3 +1,9 @@
+/**
+ * Encodes a number into a variable-length byte array using a modified base-128 encoding
+ * @param n The number to encode
+ * @returns Array of bytes representing the encoded number
+ * @throws Error if the encoded length is greater than 4 bytes
+ */
 export function encodeLength(n) {
     const output = [];
     let x = n;
@@ -14,6 +20,13 @@ export function encodeLength(n) {
     }
     return output;
 }
+/**
+ * Decodes a variable-length encoded number from a byte array
+ * @param buf The byte array containing the encoded number
+ * @param start The starting position in the buffer to begin decoding
+ * @returns Object containing the decoded length and number of bytes used for encoding
+ * @throws Error if decoding fails
+ */
 export function decodeLength(buf, start) {
     const decode = getLengthDecoder();
     const lenBuf = buf.subarray(start);
@@ -25,6 +38,11 @@ export function decodeLength(buf, start) {
     }
     throw Error("length decoding failed");
 }
+/**
+ * Creates a stateful decoder function for processing variable-length encoded numbers
+ * @returns Function that processes one byte at a time and returns decoding status
+ * @throws Error if the encoded length is greater than 4 bytes
+ */
 export function getLengthDecoder() {
     let numLengthBytes = 1;
     let length = 0;

package/dist/mqttPacket/length.js.map

@@ -1 +1 @@
-{"version":3,"file":"length.js","sourceRoot":"","sources":["../../mqttPacket/length.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,YAAY,CAAC,CAAS;IACpC,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,GAAG,CAAC;QACF,IAAI,WAAW,GAAG,CAAC,GAAG,IAAI,CAAC;QAC3B,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QACzB,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACV,WAAW,GAAG,WAAW,GAAG,IAAI,CAAC;QACnC,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3B,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;IAChB,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,GAAe,EACf,KAAa;IAEb,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;IAClC,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QACpC,CAAC;IACH,CAAC;IACD,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;AACxC,CAAC;AAQD,MAAM,UAAU,gBAAgB;IAG9B,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,OAAO,SAAS,aAAa,CAAC,WAAmB;QAC/C,MAAM,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,UAAU,CAAC;QAC5C,UAAU,IAAI,IAAI,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QAChD,CAAC;QACD,IAAI,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;IACjD,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"length.js","sourceRoot":"","sources":["../../mqttPacket/length.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,CAAS;IACpC,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,GAAG,CAAC;QACF,IAAI,WAAW,GAAG,CAAC,GAAG,IAAI,CAAC;QAC3B,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QACzB,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACV,WAAW,GAAG,WAAW,GAAG,IAAI,CAAC;QACnC,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3B,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;IAChB,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,GAAe,EACf,KAAa;IAEb,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;IAClC,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QACpC,CAAC;IACH,CAAC;IACD,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;AACxC,CAAC;AAWD;;;;GAIG;AACH,MAAM,UAAU,gBAAgB;IAG9B,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,OAAO,SAAS,aAAa,CAAC,WAAmB;QAC/C,MAAM,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,UAAU,CAAC;QAC5C,UAAU,IAAI,IAAI,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QAChD,CAAC;QACD,IAAI,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;IACjD,CAAC,CAAC;AACJ,CAAC"}

package/dist/mqttPacket/mod.d.ts

@@ -1,7 +1,8 @@
 /**
- *  This module provides the encoding and decoding of MQTT packets
- * it is used by the server and client modules
- *  @module
+ * @module MQTT Packet Encoding/Decoding
+ * @description This module provides comprehensive encoding and decoding functionality for MQTT packets
+ * used in both server and client implementations. It handles all MQTT packet types and their
+ * transformations between binary and object representations.
  */
 import type { ClientId, Dup, PacketId, Payload, QoS, ReturnCodes, TAuthenticationResult, Topic, TopicFilter, TPacketType } from "./types.ts";
 import { PacketNameByType, PacketType } from "./PacketType.ts";
@@ -29,6 +30,10 @@ export type AnyPacket = ConnectPacket | ConnackPacket | PublishPacket | PubackPa
 export type { ClientId, ConnackPacket, ConnectPacket, DisconnectPacket, Dup, PacketId, Payload, PingreqPacket, PingresPacket, PubackPacket, PubcompPacket, PublishPacket, PubrecPacket, PubrelPacket, QoS, ReturnCodes, SubackPacket, SubscribePacket, TAuthenticationResult, Topic, TopicFilter, TPacketType, UnsubackPacket, UnsubscribePacket, };
 export type { Subscription } from "./subscribe.ts";
 export { AuthenticationResult, AuthenticationResultByNumber, decodeLength, encodeLength, invalidTopic, invalidTopicFilter, invalidUTF8, PacketNameByType, PacketType, };
+/**
+ * Array mapping MQTT packet types to their corresponding encode/decode handlers
+ * Index corresponds to packet type number.
+ */
 export declare const packetsByType: readonly [null, {
     encode(packet: ConnectPacket): {
         flags: number;
@@ -114,8 +119,30 @@ export declare const packetsByType: readonly [null, {
     };
     decode(buffer: Uint8Array, _flags: number): DisconnectPacket;
 }];
+/**
+ * @function encode
+ * @description Encodes an MQTT packet object into a binary Uint8Array format
+ * @param {AnyPacket} packet - The MQTT packet object to encode
+ * @returns {Uint8Array} The encoded packet as a binary buffer
+ * @throws {Error} If packet encoding fails
+ */
 export declare function encode(packet: AnyPacket): Uint8Array;
+/**
+ * @function decodePayload
+ * @description Decodes a packet payload from binary format into an MQTT packet object
+ * @param {number} firstByte - The first byte of the MQTT packet containing type and flags
+ * @param {Uint8Array} buffer - The binary buffer containing the packet payload
+ * @returns {AnyPacket} The decoded MQTT packet object
+ * @throws {Error} If packet decoding fails
+ */
 export declare function decodePayload(firstByte: number, buffer: Uint8Array): AnyPacket;
+/**
+ * @function decode
+ * @description Decodes a complete MQTT packet from binary format into a packet object
+ * @param {Uint8Array} buffer - The binary buffer containing the complete MQTT packet
+ * @returns {AnyPacket} The decoded MQTT packet object
+ * @throws {DecoderError} If packet decoding fails due to invalid format or insufficient data
+ */
 export declare function decode(buffer: Uint8Array): AnyPacket;
 export { getLengthDecoder } from "../mqttPacket/length.ts";
 export type { LengthDecoderResult } from "../mqttPacket/length.ts";

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

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../mqttPacket/mod.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACV,QAAQ,EACR,GAAG,EACH,QAAQ,EACR,OAAO,EACP,GAAG,EACH,WAAW,EACX,qBAAqB,EACrB,KAAK,EACL,WAAW,EACX,WAAW,EACZ,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EACL,oBAAoB,EACpB,4BAA4B,EAC7B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAa,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAe,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAc,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGpE;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,aAAa,GACb,aAAa,GACb,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,eAAe,GACf,YAAY,GACZ,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,aAAa,GACb,gBAAgB,CAAC;AAErB,YAAY,EACV,QAAQ,EACR,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,GAAG,EACH,QAAQ,EACR,OAAO,EACP,aAAa,EACb,aAAa,EACb,YAAY,EACZ,aAAa,EACb,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,GAAG,EACH,WAAW,EACX,YAAY,EACZ,eAAe,EACf,qBAAqB,EACrB,KAAK,EACL,WAAW,EACX,WAAW,EACX,cAAc,EACd,iBAAiB,GAClB,CAAC;AAEF,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EACL,oBAAoB,EACpB,4BAA4B,EAC5B,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,UAAU,GACX,CAAC;AAEF,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgBhB,CAAC;AAEX,wBAAgB,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,CAcpD;AAED,wBAAgB,aAAa,CAC3B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,UAAU,GACjB,SAAS,CAQX;AAED,wBAAgB,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,CAQpD;AAED,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../mqttPacket/mod.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,QAAQ,EACR,GAAG,EACH,QAAQ,EACR,OAAO,EACP,GAAG,EACH,WAAW,EACX,qBAAqB,EACrB,KAAK,EACL,WAAW,EACX,WAAW,EACZ,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EACL,oBAAoB,EACpB,4BAA4B,EAC7B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAa,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAe,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAW,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAc,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGpE;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,aAAa,GACb,aAAa,GACb,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,eAAe,GACf,YAAY,GACZ,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,aAAa,GACb,gBAAgB,CAAC;AAErB,YAAY,EACV,QAAQ,EACR,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,GAAG,EACH,QAAQ,EACR,OAAO,EACP,aAAa,EACb,aAAa,EACb,YAAY,EACZ,aAAa,EACb,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,GAAG,EACH,WAAW,EACX,YAAY,EACZ,eAAe,EACf,qBAAqB,EACrB,KAAK,EACL,WAAW,EACX,WAAW,EACX,cAAc,EACd,iBAAiB,GAClB,CAAC;AAEF,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EACL,oBAAoB,EACpB,4BAA4B,EAC5B,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,UAAU,GACX,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgBhB,CAAC;AAEX;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,CAcpD;AAED;;;;;;;GAOG;AAEH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,UAAU,GACjB,SAAS,CAQX;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,CAQpD;AAED,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/mqttPacket/mod.js

@@ -1,7 +1,8 @@
 /**
- *  This module provides the encoding and decoding of MQTT packets
- * it is used by the server and client modules
- *  @module
+ * @module MQTT Packet Encoding/Decoding
+ * @description This module provides comprehensive encoding and decoding functionality for MQTT packets
+ * used in both server and client implementations. It handles all MQTT packet types and their
+ * transformations between binary and object representations.
  */
 import { PacketNameByType, PacketType } from "./PacketType.js";
 import { invalidTopic, invalidTopicFilter, invalidUTF8 } from "./validators.js";
@@ -23,6 +24,10 @@ import { pingres } from "./pingres.js";
 import { disconnect } from "./disconnect.js";
 import { DecoderError } from "./decoder.js";
 export { AuthenticationResult, AuthenticationResultByNumber, decodeLength, encodeLength, invalidTopic, invalidTopicFilter, invalidUTF8, PacketNameByType, PacketType, };
+/**
+ * Array mapping MQTT packet types to their corresponding encode/decode handlers
+ * Index corresponds to packet type number.
+ */
 export const packetsByType = [
     null,
     connect, // 1
@@ -40,6 +45,13 @@ export const packetsByType = [
     pingres, // 13
     disconnect, // 14
 ];
+/**
+ * @function encode
+ * @description Encodes an MQTT packet object into a binary Uint8Array format
+ * @param {AnyPacket} packet - The MQTT packet object to encode
+ * @returns {Uint8Array} The encoded packet as a binary buffer
+ * @throws {Error} If packet encoding fails
+ */
 export function encode(packet) {
     const packetType = packet.type;
     // deno-lint-ignore no-explicit-any
@@ -55,6 +67,14 @@ export function encode(packet) {
         ...bytes,
     ]);
 }
+/**
+ * @function decodePayload
+ * @description Decodes a packet payload from binary format into an MQTT packet object
+ * @param {number} firstByte - The first byte of the MQTT packet containing type and flags
+ * @param {Uint8Array} buffer - The binary buffer containing the packet payload
+ * @returns {AnyPacket} The decoded MQTT packet object
+ * @throws {Error} If packet decoding fails
+ */
 export function decodePayload(firstByte, buffer) {
     const packetType = firstByte >> 4;
     const flags = firstByte & 0x0f;
@@ -64,6 +84,13 @@ export function decodePayload(firstByte, buffer) {
     }
     throw new Error("packet decoding failed");
 }
+/**
+ * @function decode
+ * @description Decodes a complete MQTT packet from binary format into a packet object
+ * @param {Uint8Array} buffer - The binary buffer containing the complete MQTT packet
+ * @returns {AnyPacket} The decoded MQTT packet object
+ * @throws {DecoderError} If packet decoding fails due to invalid format or insufficient data
+ */
 export function decode(buffer) {
     if (buffer.length < 2) {
         throw new DecoderError("Packet decoding failed");

package/dist/mqttPacket/mod.js.map

@@ -1 +1 @@
-{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mqttPacket/mod.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAcH,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EACL,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAqB,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,MAAM,EAAqB,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,MAAM,EAAqB,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAwB,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,MAAM,EAAqB,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,WAAW,EAA0B,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAuB,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAyB,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAkD5C,OAAO,EACL,oBAAoB,EACpB,4BAA4B,EAC5B,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,UAAU,GACX,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI;IACJ,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,IAAI;IACf,MAAM,EAAE,IAAI;IACZ,WAAW,EAAE,KAAK;IAClB,QAAQ,EAAE,KAAK;IACf,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,UAAU,EAAE,KAAK;CACT,CAAC;AAEX,MAAM,UAAU,MAAM,CAAC,MAAiB;IACtC,MAAM,UAAU,GAAW,MAAM,CAAC,IAAI,CAAC;IACvC,mCAAmC;IACnC,MAAM,GAAG,GAAQ,MAAM,CAAC;IACxB,MAAM,OAAO,GAAG,aAAa,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IACvD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACxC,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACjC,OAAO,UAAU,CAAC,IAAI,CAAC;QACrB,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,KAAK;QACzB,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;QAC7B,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,SAAiB,EACjB,MAAkB;IAElB,MAAM,UAAU,GAAG,SAAS,IAAI,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,SAAS,GAAG,IAAI,CAAC;IAC/B,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAChE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,MAAkB;IACvC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,CAAC;IACnD,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,cAAc,GAAG,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;IAC3B,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mqttPacket/mod.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAcH,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EACL,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAqB,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,MAAM,EAAqB,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,MAAM,EAAqB,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAwB,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,MAAM,EAAqB,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,WAAW,EAA0B,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAuB,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAsB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAyB,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAkD5C,OAAO,EACL,oBAAoB,EACpB,4BAA4B,EAC5B,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,UAAU,GACX,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI;IACJ,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,IAAI;IACf,MAAM,EAAE,IAAI;IACZ,WAAW,EAAE,KAAK;IAClB,QAAQ,EAAE,KAAK;IACf,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,UAAU,EAAE,KAAK;CACT,CAAC;AAEX;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,MAAiB;IACtC,MAAM,UAAU,GAAW,MAAM,CAAC,IAAI,CAAC;IACvC,mCAAmC;IACnC,MAAM,GAAG,GAAQ,MAAM,CAAC;IACxB,MAAM,OAAO,GAAG,aAAa,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IACvD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACxC,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACjC,OAAO,UAAU,CAAC,IAAI,CAAC;QACrB,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,KAAK;QACzB,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;QAC7B,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AAEH,MAAM,UAAU,aAAa,CAC3B,SAAiB,EACjB,MAAkB;IAElB,MAAM,UAAU,GAAG,SAAS,IAAI,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,SAAS,GAAG,IAAI,CAAC;IAC/B,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAChE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,MAAkB;IACvC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,CAAC;IACnD,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,cAAc,GAAG,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;IAC3B,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC"}

package/mqttPacket/BitMask.ts

@@ -1,4 +1,17 @@
-export const BitMask = {
+/**
+ * Object containing bit mask values from 2^0 to 2^7
+ * @constant
+ * @type {Record<string,number>}
+ * @property {number} bit0 - Represents 2^0 = 1
+ * @property {number} bit1 - Represents 2^1 = 2
+ * @property {number} bit2 - Represents 2^2 = 4
+ * @property {number} bit3 - Represents 2^3 = 8
+ * @property {number} bit4 - Represents 2^4 = 16
+ * @property {number} bit5 - Represents 2^5 = 32
+ * @property {number} bit6 - Represents 2^6 = 64
+ * @property {number} bit7 - Represents 2^7 = 128
+ */
+export const BitMask: Record<string, number> = {
   bit0: 2 ** 0,
   bit1: 2 ** 1,
   bit2: 2 ** 2,

package/mqttPacket/PacketType.ts

@@ -1,3 +1,6 @@
+/**
+ *  Possible MQTT packet types
+ */
 export const PacketType = {
   reserved: 0,
   connect: 1,
@@ -16,6 +19,9 @@ export const PacketType = {
   disconnect: 14,
 } as const;
 
+/**
+ * Reverse lookup for packet types
+ */
 export const PacketNameByType: Record<number, string> = Object.fromEntries(
   Object.entries(PacketType).map(([k, v]) => [v, k]),
 );

package/mqttPacket/decoder.ts

@@ -2,23 +2,41 @@ import type { TBitMask, Topic, TopicFilter } from "./types.ts";
 import { invalidTopic, invalidTopicFilter } from "./validators.ts";
 
 const utf8Decoder = new TextDecoder("utf-8");
-
+/**
+ * Checks if a specific bit flag is set in a byte using a bitmask
+ * @param byte - The byte to check
+ * @param mask - The bitmask to apply
+ * @returns True if the flag is set, false otherwise
+ */
 export function booleanFlag(byte: number, mask: TBitMask): boolean {
   return !!(byte & mask);
 }
 
+/**
+ * Checks if a buffer is empty, throws error if not empty
+ * @param buf - The buffer to check
+ * @throws {DecoderError} If buffer is not empty
+ */
 export function isEmptyBuf(buf: Uint8Array): void {
   if (buf.length > 0) {
     throw new DecoderError("Packet too long");
   }
 }
 
+/**
+ * Checks if flags are empty (zero), throws error if not
+ * @param flags - The flags value to check
+ * @throws {DecoderError} If flags are not zero
+ */
 export function hasEmptyFlags(flags: number): void {
   if (flags !== 0) {
     throw new DecoderError("Invalid fixed header flags");
   }
 }
 
+/**
+ * Custom error class for decoder errors
+ */
 export class DecoderError extends Error {
   constructor(message: string) {
     super(message);
@@ -26,33 +44,59 @@ export class DecoderError extends Error {
   }
 }
 
+/**
+ * Decoder class for parsing MQTT packets
+ */
 export class Decoder {
   private buf: Uint8Array;
   private pos: number;
   private len: number;
 
+  /**
+   * Creates a new Decoder instance
+   * @param buf - The buffer to decode
+   * @param pos - Starting position in the buffer (default: 0)
+   */
   constructor(buf: Uint8Array, pos: number = 0) {
     this.buf = buf;
     this.pos = pos;
     this.len = buf.length;
   }
+
+  /**
+   * Checks if the current position is valid
+   * @param pos - Position to check
+   * @throws {DecoderError} If position exceeds buffer length
+   */
   checkpos(pos: number): void {
     if (pos > this.len) {
       throw new DecoderError("Packet too short");
     }
   }
 
+  /**
+   * Gets a single byte from the buffer
+   * @returns The byte value
+   */
   getByte(): number {
     this.checkpos(this.pos);
     return this.buf[this.pos++];
   }
 
+  /**
+   * Gets a 16-bit integer from the buffer
+   * @returns The 16-bit integer value
+   */
   getInt16(): number {
     const msb = this.getByte();
     const lsb = this.getByte();
     return (msb << 8) | lsb;
   }
 
+  /**
+   * Gets a byte array from the buffer
+   * @returns A subarray of the buffer
+   */
   getByteArray(): Uint8Array {
     const len = this.getInt16();
     const start = this.pos;
@@ -62,11 +106,20 @@ export class Decoder {
     return this.buf.subarray(start, end);
   }
 
+  /**
+   * Gets a UTF-8 string from the buffer
+   * @returns The decoded UTF-8 string
+   */
   getUtf8String(): string {
     const str = utf8Decoder.decode(this.getByteArray());
     return str;
   }
 
+  /**
+   * Gets a topic from the buffer
+   * @returns The decoded topic
+   * @throws {DecoderError} If topic is invalid
+   */
   getTopic(): Topic {
     const topic = this.getUtf8String();
     if (invalidTopic(topic)) {
@@ -77,6 +130,11 @@ export class Decoder {
     return topic;
   }
 
+  /**
+   * Gets a topic filter from the buffer
+   * @returns The decoded topic filter
+   * @throws {DecoderError} If topic filter is invalid
+   */
   getTopicFilter(): TopicFilter {
     const topicFilter = this.getUtf8String();
     if (invalidTopicFilter(topicFilter)) {
@@ -87,6 +145,10 @@ export class Decoder {
     return topicFilter;
   }
 
+  /**
+   * Gets the remaining bytes from the current position to the end
+   * @returns The remaining bytes as a subarray
+   */
   getRemainder() {
     const start = this.pos;
     const end = this.len;
@@ -94,12 +156,22 @@ export class Decoder {
     return this.buf.subarray(start, end);
   }
 
+  /**
+   * Checks if decoder has reached the end of the buffer
+   * @returns True if at end, false otherwise
+   */
   atEnd(): boolean {
     if (this.len === this.pos) {
       return true;
     }
     return false;
   }
+
+  /**
+   * Checks if decoding is complete
+   * @returns True if complete
+   * @throws {DecoderError} If packet is too long
+   */
   done(): boolean {
     if (this.atEnd()) {
       return true;

package/mqttPacket/encoder.ts

@@ -2,6 +2,9 @@ const utf8Encoder = new TextEncoder();
 import type { Topic, TopicFilter } from "./types.ts";
 import { invalidTopic, invalidTopicFilter } from "./validators.ts";
 
+/**
+ * Custom error class for encoding operations
+ */
 export class EncoderError extends Error {
   constructor(message: string) {
     super(message);
@@ -9,24 +12,47 @@ export class EncoderError extends Error {
   }
 }
 
+/**
+ * Encoder class for MQTT packet encoding
+ */
 export class Encoder {
+  /** Internal buffer to store encoded bytes */
   private buffer: number[];
 
+  /**
+   * Creates a new Encoder instance
+   */
   constructor() {
     this.buffer = [];
   }
 
+  /**
+   * Adds a single byte to the buffer
+   * @param value - Byte value to add (0-255)
+   * @returns The encoder instance for chaining
+   */
   setByte(value: number): this {
     this.buffer.push(value);
     return this;
   }
 
+  /**
+   * Adds a 16-bit integer to the buffer in big-endian format
+   * @param value - 16-bit integer value to add
+   * @returns The encoder instance for chaining
+   */
   setInt16(value: number): this {
     this.setByte(value >> 8);
     this.setByte(value & 0xff);
     return this;
   }
 
+  /**
+   * Adds a byte array to the buffer with length prefix
+   * @param value - Byte array to add
+   * @throws {EncoderError} If array length exceeds 0xffff bytes
+   * @returns The encoder instance for chaining
+   */
   setByteArray(value: Uint8Array): this {
     if (value.length > 0xffff) {
       throw new EncoderError("More than 0xffff bytes of data");
@@ -36,11 +62,22 @@ export class Encoder {
     return this;
   }
 
+  /**
+   * Adds a UTF-8 encoded string to the buffer with length prefix
+   * @param value - String to encode and add
+   * @returns The encoder instance for chaining
+   */
   setUtf8String(value: string): this {
     this.setByteArray(utf8Encoder.encode(value));
     return this;
   }
 
+  /**
+   * Adds an MQTT topic string to the buffer
+   * @param value - Topic string to add
+   * @throws {EncoderError} If topic is invalid
+   * @returns The encoder instance for chaining
+   */
   setTopic(value: Topic): this {
     if (invalidTopic(value)) {
       throw new EncoderError(
@@ -51,6 +88,12 @@ export class Encoder {
     return this;
   }
 
+  /**
+   * Adds an MQTT topic filter string to the buffer
+   * @param value - Topic filter string to add
+   * @throws {EncoderError} If topic filter is invalid
+   * @returns The encoder instance for chaining
+   */
   setTopicFilter(value: TopicFilter): this {
     if (invalidTopicFilter(value)) {
       throw new EncoderError(
@@ -61,11 +104,20 @@ export class Encoder {
     return this;
   }
 
+  /**
+   * Adds remaining bytes to the buffer without modification
+   * @param value - Array of bytes to add
+   * @returns The encoder instance for chaining
+   */
   setRemainder(value: Uint8Array | number[]): this {
     this.buffer.push(...value);
     return this;
   }
 
+  /**
+   * Returns the final encoded buffer
+   * @returns Array containing all encoded bytes
+   */
   done(): number[] {
     return this.buffer;
   }

package/mqttPacket/length.ts

@@ -1,3 +1,9 @@
+/**
+ * Encodes a number into a variable-length byte array using a modified base-128 encoding
+ * @param n The number to encode
+ * @returns Array of bytes representing the encoded number
+ * @throws Error if the encoded length is greater than 4 bytes
+ */
 export function encodeLength(n: number): number[] {
   const output = [];
   let x = n;
@@ -15,6 +21,13 @@ export function encodeLength(n: number): number[] {
   return output;
 }
 
+/**
+ * Decodes a variable-length encoded number from a byte array
+ * @param buf The byte array containing the encoded number
+ * @param start The starting position in the buffer to begin decoding
+ * @returns Object containing the decoded length and number of bytes used for encoding
+ * @throws Error if decoding fails
+ */
 export function decodeLength(
   buf: Uint8Array,
   start: number,
@@ -30,12 +43,20 @@ export function decodeLength(
   throw Error("length decoding failed");
 }
 
+/**
+ * Interface for the result returned by the length decoder
+ */
 export type LengthDecoderResult = {
   done: boolean;
   length: number;
   numLengthBytes: number;
 };
 
+/**
+ * Creates a stateful decoder function for processing variable-length encoded numbers
+ * @returns Function that processes one byte at a time and returns decoding status
+ * @throws Error if the encoded length is greater than 4 bytes
+ */
 export function getLengthDecoder(): (
   encodedByte: number,
 ) => LengthDecoderResult {

package/mqttPacket/mod.ts

@@ -1,7 +1,8 @@
 /**
- *  This module provides the encoding and decoding of MQTT packets
- * it is used by the server and client modules
- *  @module
+ * @module MQTT Packet Encoding/Decoding
+ * @description This module provides comprehensive encoding and decoding functionality for MQTT packets
+ * used in both server and client implementations. It handles all MQTT packet types and their
+ * transformations between binary and object representations.
  */
 
 import type {
@@ -99,6 +100,10 @@ export {
   PacketType,
 };
 
+/**
+ * Array mapping MQTT packet types to their corresponding encode/decode handlers
+ * Index corresponds to packet type number.
+ */
 export const packetsByType = [
   null,
   connect, // 1
@@ -117,6 +122,13 @@ export const packetsByType = [
   disconnect, // 14
 ] as const;
 
+/**
+ * @function encode
+ * @description Encodes an MQTT packet object into a binary Uint8Array format
+ * @param {AnyPacket} packet - The MQTT packet object to encode
+ * @returns {Uint8Array} The encoded packet as a binary buffer
+ * @throws {Error} If packet encoding fails
+ */
 export function encode(packet: AnyPacket): Uint8Array {
   const packetType: number = packet.type;
   // deno-lint-ignore no-explicit-any
@@ -133,6 +145,15 @@ export function encode(packet: AnyPacket): Uint8Array {
   ]);
 }
 
+/**
+ * @function decodePayload
+ * @description Decodes a packet payload from binary format into an MQTT packet object
+ * @param {number} firstByte - The first byte of the MQTT packet containing type and flags
+ * @param {Uint8Array} buffer - The binary buffer containing the packet payload
+ * @returns {AnyPacket} The decoded MQTT packet object
+ * @throws {Error} If packet decoding fails
+ */
+
 export function decodePayload(
   firstByte: number,
   buffer: Uint8Array,
@@ -146,6 +167,13 @@ export function decodePayload(
   throw new Error("packet decoding failed");
 }
 
+/**
+ * @function decode
+ * @description Decodes a complete MQTT packet from binary format into a packet object
+ * @param {Uint8Array} buffer - The binary buffer containing the complete MQTT packet
+ * @returns {AnyPacket} The decoded MQTT packet object
+ * @throws {DecoderError} If packet decoding fails due to invalid format or insufficient data
+ */
 export function decode(buffer: Uint8Array): AnyPacket {
   if (buffer.length < 2) {
     throw new DecoderError("Packet decoding failed");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seriousme/opifex",
-  "version": "1.8.1",
+  "version": "1.8.2",
   "description": "MQTT client & server for Deno & NodeJS",
   "type": "module",
   "scripts": {