@seriousme/opifex 1.6.3 → 1.7.0

package/dist/client/handlers/handlePuback.js

@@ -1,13 +0,0 @@
-/**
- * Handles PUBACK packet processing for QoS level 1 PUBLISH responses
- * @param ctx - The MQTT client context
- * @param packet - The PUBACK packet received from the broker
- * @description
- * - Removes the packet ID from the list of pending outgoing messages
- * - Completes the corresponding publish operation
- */
-export function handlePuback(ctx, packet) {
-    const id = packet.id;
-    ctx.store.pendingOutgoing.delete(id);
-    ctx.receivePuback(id);
-}

package/dist/client/handlers/handlePubcomp.js

@@ -1,16 +0,0 @@
-/**
- * Handles PUBCOMP packets which are the response to PUBREL packets in QoS 2 flow
- * @param ctx - The connection context containing the client state and store
- * @param packet - The PUBCOMP packet received from the broker
- * @description
- * This function processes PUBCOMP packets which are the fourth and final packet
- * in the QoS 2 protocol exchange. It removes the message from pendingAckOutgoing queue
- * Completes the corresponding publish operation
- */
-export function handlePubcomp(ctx, packet) {
-    const id = packet.id;
-    if (ctx.store.pendingAckOutgoing.has(id)) {
-        ctx.store.pendingAckOutgoing.delete(id);
-        ctx.receivePubcomp(id);
-    }
-}

package/dist/client/handlers/handlePublish.js

@@ -1,33 +0,0 @@
-import { PacketType } from "../deps.js";
-/**
- * Handles incoming MQTT publish packets based on their QoS level
- * @param ctx - The MQTT connection context
- * @param packet - The incoming publish packet to handle
- * @returns Promise that resolves when packet is handled
- */
-export async function handlePublish(ctx, packet) {
-    const qos = packet.qos || 0;
-    if (qos === 0) {
-        ctx.receivePublish(packet);
-        return;
-    }
-    if (packet.id !== undefined) {
-        // qos 1
-        if (qos === 1) {
-            ctx.receivePublish(packet);
-            await ctx.send({
-                type: PacketType.puback,
-                id: packet.id,
-            });
-            return;
-        }
-        // qos 2
-        if (ctx.store) {
-            ctx.store.pendingIncoming.set(packet.id, packet);
-            await ctx.send({
-                type: PacketType.pubrec,
-                id: packet.id,
-            });
-        }
-    }
-}

package/dist/client/handlers/handlePubrec.js

@@ -1,26 +0,0 @@
-import { PacketType } from "../deps.js";
-/**
- * Handles PUBREC (Publish Received) packets for QoS 2 message flow
- * It is the second packet of the QoS 2 protocol exchange.
- * @param ctx - The connection context containing message stores and send function
- * @param packet - The received PUBREC packet
- * @description
- * When a PUBREC packet is received:
- * 1. Checks if there is a pending outgoing message with matching packet ID
- * 2. Creates a PUBREL packet to acknowledge the PUBREC
- * 3. Add the packet ID to pendingAckOutgoing store
- * 4. Removes the message from pendingOutgoing store
- * 5. Sends the PUBREL packet
- */
-export async function handlePubrec(ctx, packet) {
-    const id = packet.id;
-    const ack = {
-        type: PacketType.pubrel,
-        id,
-    };
-    if (ctx.store.pendingOutgoing.has(id)) {
-        ctx.store.pendingAckOutgoing.set(id, ack);
-        ctx.store.pendingOutgoing.delete(id);
-        await ctx.send(ack);
-    }
-}

package/dist/client/handlers/handlePubrel.js

@@ -1,31 +0,0 @@
-import { PacketType } from "../deps.js";
-/**
- * Handles a PUBREL packet in the MQTT QoS 2 flow
- * It is the third packet of the QoS 2 protocol exchange
- * and a response to the PUBREC packet
- *
- * It uses Method A from the MQTT specification
- * @param ctx - The MQTT client context
- * @param packet - The PUBREL packet received
- * @description
- * When a PUBREL packet is received:
- * 1. If there is a matching pending incoming message:
- *    - Delivers the stored message to the application
- *    - Removes the message from pending incoming store
- *    - Sends PUBCOMP packet as acknowledgement
- * 2. If no matching message found, silently ignores
- */
-export async function handlePubrel(ctx, packet) {
-    const id = packet.id;
-    if (ctx.store.pendingIncoming.has(id)) {
-        const storedPacket = ctx.store.pendingIncoming.get(id);
-        if (storedPacket) {
-            ctx.receivePublish(storedPacket);
-            ctx.store.pendingIncoming.delete(id);
-            await ctx.send({
-                type: PacketType.pubcomp,
-                id,
-            });
-        }
-    }
-}

package/dist/client/handlers/handleSuback.js

@@ -1,14 +0,0 @@
-/**
- * Handles SUBACK packets received from the server
- * @param ctx - The MQTT client context
- * @param packet - The SUBACK packet containing subscription confirmations
- * @description
- * - Processes SUBACK packets sent by server to confirm SUBSCRIBE requests
- * - Removes the packet ID from pending outgoing messages
- * - Notifies the client about granted QoS levels for each subscription
- */
-export function handleSuback(ctx, packet) {
-    const id = packet.id;
-    ctx.store.pendingOutgoing.delete(id);
-    ctx.receiveSuback(id, packet.returnCodes);
-}

package/dist/client/handlers/handleUnsuback.js

@@ -1,15 +0,0 @@
-/**
- * Handles the UNSUBACK packet received from the server
- * @param ctx - The MQTT client context
- * @param packet - The UNSUBACK packet received from the server
- * @description
- * The UNSUBACK Packet is sent by the Server to the Client to confirm receipt of
- * an UNSUBSCRIBE Packet.
- * When received, it removes the pending outgoing request and completes the corresponding
- * unsubscribe operation.
- */
-export function handleUnsuback(ctx, packet) {
-    const id = packet.id;
-    ctx.store.pendingOutgoing.delete(id);
-    ctx.receiveUnsuback(id);
-}

package/dist/client/mod.js

@@ -1,5 +0,0 @@
-/**
- *  This module provides an MQTT Client interface see the /bin folder for examples
- *  @module
- */
-export { Client, DEFAULT_URL } from "./client.js";

package/dist/client/store/deps.js

@@ -1 +0,0 @@
-export { assert } from "../../utils/mod.js";

package/dist/client/store/memoryStore.js

@@ -1,58 +0,0 @@
-/**
- * @module memoryStore
- */
-import { assert } from "./deps.js";
-import { maxPacketId, } from "./store.js";
-/**
- * In-memory implementation of the IStore interface for managing MQTT packet storage
- */
-export class MemoryStore {
-    /** Current packet ID counter */
-    packetId;
-    /** Map of pending incoming packets */
-    pendingIncoming;
-    /** Map of pending outgoing packets */
-    pendingOutgoing;
-    /** Map of pending acknowledgment outgoing packets */
-    pendingAckOutgoing;
-    /**
-     * Creates a new MemoryStore instance
-     */
-    constructor() {
-        this.packetId = 0;
-        this.pendingIncoming = new Map();
-        this.pendingOutgoing = new Map();
-        this.pendingAckOutgoing = new Map();
-    }
-    /**
-     * Generates the next available packet ID
-     * @returns {PacketId} The next available packet ID
-     * @throws {Error} If no unused packet ID is available
-     */
-    nextId() {
-        const currentId = this.packetId;
-        do {
-            this.packetId++;
-            if (this.packetId > maxPacketId) {
-                this.packetId = 1;
-            }
-        } while ((this.pendingIncoming.has(this.packetId) ||
-            this.pendingOutgoing.has(this.packetId) ||
-            this.pendingAckOutgoing.has(this.packetId)) &&
-            this.packetId !== currentId);
-        assert(this.packetId !== currentId, "No unused packetId available");
-        return this.packetId;
-    }
-    /**
-     * Asynchronously yields all pending outgoing packets
-     * @yields {PendingOutgoingPackets} Pending outgoing packets
-     */
-    async *pendingOutgoingPackets() {
-        for (const [_id, packet] of this.pendingAckOutgoing) {
-            yield packet;
-        }
-        for (const [_id, packet] of this.pendingOutgoing) {
-            yield packet;
-        }
-    }
-}

package/dist/client/store/store.js

@@ -1,4 +0,0 @@
-/**
- * Maximum value for MQTT packet IDs (65535)
- */
-export const maxPacketId = 0xffff;

package/dist/mqttConn/mqttConn.js

@@ -1,104 +0,0 @@
-import { decodePayload, encode, getLengthDecoder, } from "../mqttPacket/mod.js";
-import { assert } from "../utils/mod.js";
-import { Conn } from "../socket/socket.js";
-export const MqttConnError = {
-    invalidPacket: "Invalid Packet",
-    packetTooLarge: "Packet too large",
-    UnexpectedEof: "Unexpected EOF",
-};
-async function readByte(conn) {
-    const buf = new Uint8Array(1);
-    const bytesRead = await conn.read(buf);
-    assert(bytesRead !== null, MqttConnError.UnexpectedEof);
-    assert(bytesRead !== 0, MqttConnError.UnexpectedEof);
-    return buf[0];
-}
-async function readFull(conn, buf) {
-    let bytesRead = 0;
-    while (bytesRead < buf.length) {
-        const read = await conn.read(buf.subarray(bytesRead));
-        assert(read !== null, MqttConnError.UnexpectedEof);
-        assert(read !== 0, MqttConnError.UnexpectedEof);
-        bytesRead += read;
-    }
-}
-/** Read MQTT packet
- * @throws `Error` if packet is invalid
- */
-export async function readPacket(conn, maxPacketSize) {
-    // fixed header is 1 byte of type + flags
-    // + a maximum of 4 bytes to encode the remaining length
-    const decodeLength = getLengthDecoder();
-    const firstByte = await readByte(conn);
-    let result;
-    do {
-        const byte = await readByte(conn);
-        result = decodeLength(byte);
-    } while (!result.done);
-    const remainingLength = result.length;
-    assert(remainingLength < maxPacketSize - 1, MqttConnError.packetTooLarge);
-    const packetBuf = new Uint8Array(remainingLength);
-    // read the rest of the packet
-    await readFull(conn, packetBuf);
-    const packet = decodePayload(firstByte, packetBuf);
-    assert(packet !== null, MqttConnError.UnexpectedEof);
-    return packet;
-}
-export class MqttConn {
-    conn;
-    maxPacketSize;
-    _reason = undefined;
-    _isClosed = false;
-    constructor({ conn, maxPacketSize, }) {
-        this.conn = new Conn(conn);
-        this.maxPacketSize = maxPacketSize || 2 * 1024 * 1024;
-    }
-    get reason() {
-        return this._reason;
-    }
-    async *[Symbol.asyncIterator]() {
-        while (!this._isClosed) {
-            try {
-                yield await readPacket(this.conn, this.maxPacketSize);
-            }
-            catch (err) {
-                if (err instanceof Error) {
-                    if (err.name === "PartialReadError") {
-                        err.message = MqttConnError.UnexpectedEof;
-                    }
-                    this._reason = err.message;
-                }
-                // packet too large, malformed packet or connection closed
-                this.close();
-                break;
-            }
-        }
-    }
-    async send(data) {
-        try {
-            await this.conn.write(encode(data));
-        }
-        catch (err) {
-            if (err instanceof Error) {
-                this._reason = err.message;
-            }
-            this.close();
-        }
-    }
-    get isClosed() {
-        return this._isClosed;
-    }
-    close() {
-        if (this.isClosed)
-            return;
-        try {
-            this.conn.close();
-        }
-        catch (e) {
-            console.error(e);
-        }
-        finally {
-            this._isClosed = true;
-        }
-    }
-}

package/dist/mqttPacket/AuthenticationResult.js

@@ -1,16 +0,0 @@
-/**
- *  Possible MQTT authentication results
- */
-export const AuthenticationResult = {
-    ok: 0,
-    unacceptableProtocol: 1,
-    rejectedUsername: 2,
-    serverUnavailable: 3,
-    badUsernameOrPassword: 4,
-    notAuthorized: 5,
-};
-/**
- * Reverse lookup for AuthenticationResult
- */
-export const AuthenticationResultByNumber = Object
-    .fromEntries(Object.entries(AuthenticationResult).map(([k, v]) => [v, k]));

package/dist/mqttPacket/BitMask.js

@@ -1,10 +0,0 @@
-export const BitMask = {
-    bit0: 2 ** 0,
-    bit1: 2 ** 1,
-    bit2: 2 ** 2,
-    bit3: 2 ** 3,
-    bit4: 2 ** 4,
-    bit5: 2 ** 5,
-    bit6: 2 ** 6,
-    bit7: 2 ** 7,
-};

package/dist/mqttPacket/PacketType.js

@@ -1,18 +0,0 @@
-export const PacketType = {
-    reserved: 0,
-    connect: 1,
-    connack: 2,
-    publish: 3,
-    puback: 4,
-    pubrec: 5,
-    pubrel: 6,
-    pubcomp: 7,
-    subscribe: 8,
-    suback: 9,
-    unsubscribe: 10,
-    unsuback: 11,
-    pingreq: 12,
-    pingres: 13,
-    disconnect: 14,
-};
-export const PacketNameByType = Object.fromEntries(Object.entries(PacketType).map(([k, v]) => [v, k]));

package/dist/mqttPacket/connack.js

@@ -1,27 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { BitMask } from "./BitMask.js";
-import { booleanFlag, Decoder, DecoderError } from "./decoder.js";
-import { AuthenticationResultByNumber } from "./AuthenticationResult.js";
-export const connack = {
-    encode(packet) {
-        const flags = 0;
-        return {
-            flags,
-            bytes: [packet.sessionPresent ? 1 : 0, packet.returnCode || 0],
-        };
-    },
-    decode(buffer, _flags) {
-        const decoder = new Decoder(buffer);
-        const sessionPresent = booleanFlag(decoder.getByte(), BitMask.bit0);
-        const returnCode = decoder.getByte();
-        decoder.done();
-        if (!AuthenticationResultByNumber[returnCode]) {
-            throw new DecoderError("Invalid return code");
-        }
-        return {
-            type: PacketType.connack,
-            sessionPresent,
-            returnCode,
-        };
-    },
-};

package/dist/mqttPacket/connect.js

@@ -1,115 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { BitMask } from "./BitMask.js";
-import { Encoder } from "./encoder.js";
-import { booleanFlag, Decoder, DecoderError, hasEmptyFlags, } from "./decoder.js";
-function invalidProtocolName(version, name) {
-    if (version === 4 && name !== "MQTT") {
-        return true;
-    }
-    return false;
-}
-export const connect = {
-    encode(packet) {
-        const flags = 0;
-        const protocolLevel = 4;
-        const protocolName = protocolLevel === 4 ? "MQTT" : "MQIsdp";
-        const clientId = packet.clientId || "";
-        const usernameFlag = !!packet.username;
-        const passwordFlag = !!packet.password;
-        const willRetain = !!packet.will?.retain;
-        const willQoS = packet.will?.qos || 0;
-        const willFlag = !!packet.will;
-        const cleanSession = packet.clean !== false;
-        const connectFlags = (usernameFlag ? BitMask.bit7 : 0) +
-            (passwordFlag ? BitMask.bit6 : 0) +
-            (willRetain ? BitMask.bit5 : 0) +
-            (willQoS & 2 ? BitMask.bit4 : 0) +
-            (willQoS & 1 ? BitMask.bit3 : 0) +
-            (willFlag ? BitMask.bit2 : 0) +
-            (cleanSession ? BitMask.bit1 : 0);
-        const keepAlive = packet.keepAlive || 0;
-        const encoder = new Encoder();
-        encoder
-            .setUtf8String(protocolName)
-            .setByte(protocolLevel)
-            .setByte(connectFlags)
-            .setInt16(keepAlive)
-            .setUtf8String(clientId);
-        if (packet.will) {
-            encoder.setTopic(packet.will.topic).setByteArray(packet.will.payload);
-        }
-        if (packet.username) {
-            encoder.setUtf8String(packet.username);
-        }
-        if (packet.password) {
-            encoder.setByteArray(packet.password);
-        }
-        return { flags, bytes: encoder.done() };
-    },
-    decode(buffer, flags) {
-        const decoder = new Decoder(buffer);
-        const protocolName = decoder.getUtf8String();
-        const protocolLevel = decoder.getByte();
-        if (invalidProtocolName(protocolLevel, protocolName)) {
-            throw new DecoderError("Invalid protocol name");
-        }
-        const connectFlags = decoder.getByte();
-        const usernameFlag = booleanFlag(connectFlags, BitMask.bit7);
-        const passwordFlag = booleanFlag(connectFlags, BitMask.bit6);
-        const willRetain = booleanFlag(connectFlags, BitMask.bit5);
-        const willQoS = (connectFlags & (BitMask.bit4 + BitMask.bit3)) >> 3;
-        const willFlag = booleanFlag(connectFlags, BitMask.bit2);
-        const cleanSession = booleanFlag(connectFlags, BitMask.bit1);
-        const reservedBit = booleanFlag(connectFlags, BitMask.bit0);
-        hasEmptyFlags(flags);
-        // The Server MUST validate that the reserved flag in the CONNECT Control Packet
-        // is set to zero and disconnect the Client if it is not zero [MQTT-3.1.2-3].
-        if (reservedBit) {
-            throw new DecoderError("Invalid reserved bit");
-        }
-        if (willQoS !== 0 && willQoS !== 1 && willQoS !== 2) {
-            throw new DecoderError("Invalid will qos");
-        }
-        const keepAlive = decoder.getInt16();
-        const clientId = decoder.getUtf8String();
-        let willTopic;
-        let willPayload;
-        if (willFlag) {
-            willTopic = decoder.getTopic();
-            willPayload = decoder.getByteArray();
-        }
-        let username;
-        let password;
-        if (usernameFlag) {
-            username = decoder.getUtf8String();
-        }
-        if (passwordFlag) {
-            password = decoder.getByteArray();
-        }
-        decoder.done();
-        if (!willFlag && (willQoS !== 0 || willRetain === true)) {
-            throw new DecoderError("Will QoS must be 0 and Will retain to false when Will flag is false");
-        }
-        if (clientId.length === 0 && cleanSession === false) {
-            throw new DecoderError("Clean session must be true if clientID is empty");
-        }
-        return {
-            type: PacketType.connect,
-            protocolName: protocolName,
-            protocolLevel,
-            clientId: clientId,
-            username: username ? username : undefined,
-            password: password ? password : undefined,
-            will: willFlag
-                ? {
-                    topic: willTopic || "",
-                    payload: willPayload || Uint8Array.from([0]),
-                    retain: willRetain,
-                    qos: willQoS,
-                }
-                : undefined,
-            clean: cleanSession,
-            keepAlive,
-        };
-    },
-};

package/dist/mqttPacket/decoder.js

@@ -1,89 +0,0 @@
-import { invalidTopic, invalidTopicFilter } from "./validators.js";
-const utf8Decoder = new TextDecoder("utf-8");
-export function booleanFlag(byte, mask) {
-    return !!(byte & mask);
-}
-export function isEmptyBuf(buf) {
-    if (buf.length > 0) {
-        throw new DecoderError("Packet too long");
-    }
-}
-export function hasEmptyFlags(flags) {
-    if (flags !== 0) {
-        throw new DecoderError("Invalid fixed header flags");
-    }
-}
-export class DecoderError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "DecoderError";
-    }
-}
-export class Decoder {
-    buf;
-    pos;
-    len;
-    constructor(buf, pos = 0) {
-        this.buf = buf;
-        this.pos = pos;
-        this.len = buf.length;
-    }
-    checkpos(pos) {
-        if (pos > this.len) {
-            throw new DecoderError("Packet too short");
-        }
-    }
-    getByte() {
-        this.checkpos(this.pos);
-        return this.buf[this.pos++];
-    }
-    getInt16() {
-        const msb = this.getByte();
-        const lsb = this.getByte();
-        return (msb << 8) | lsb;
-    }
-    getByteArray() {
-        const len = this.getInt16();
-        const start = this.pos;
-        const end = this.pos + len;
-        this.pos = end;
-        this.checkpos(end);
-        return this.buf.subarray(start, end);
-    }
-    getUtf8String() {
-        const str = utf8Decoder.decode(this.getByteArray());
-        return str;
-    }
-    getTopic() {
-        const topic = this.getUtf8String();
-        if (invalidTopic(topic)) {
-            throw new DecoderError("Topic must contain valid UTF-8 and contain more than 1 byte and no wildcards");
-        }
-        return topic;
-    }
-    getTopicFilter() {
-        const topicFilter = this.getUtf8String();
-        if (invalidTopicFilter(topicFilter)) {
-            throw new DecoderError("Topicfilter must contain valid UTF-8 and contain more than 1 byte and valid wildcards");
-        }
-        return topicFilter;
-    }
-    getRemainder() {
-        const start = this.pos;
-        const end = this.len;
-        this.pos = end;
-        return this.buf.subarray(start, end);
-    }
-    atEnd() {
-        if (this.len === this.pos) {
-            return true;
-        }
-        return false;
-    }
-    done() {
-        if (this.atEnd()) {
-            return true;
-        }
-        throw new DecoderError("Packet too long");
-    }
-}

package/dist/mqttPacket/disconnect.js

@@ -1,14 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { isEmptyBuf } from "./decoder.js";
-export const disconnect = {
-    encode(_packet) {
-        const flags = 0;
-        return { flags, bytes: [] };
-    },
-    decode(buffer, _flags) {
-        isEmptyBuf(buffer);
-        return {
-            type: PacketType.disconnect,
-        };
-    },
-};