@seriousme/opifex 1.6.2 → 1.7.0

package/dist/mqttPacket/pubcomp.js

@@ -1,20 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { Decoder } from "./decoder.js";
-import { Encoder } from "./encoder.js";
-export const pubcomp = {
-    encode(packet) {
-        const flags = 0;
-        const encoder = new Encoder();
-        encoder.setInt16(packet.id);
-        return { flags, bytes: encoder.done() };
-    },
-    decode(buffer) {
-        const decoder = new Decoder(buffer);
-        const id = decoder.getInt16();
-        decoder.done();
-        return {
-            type: PacketType.pubcomp,
-            id,
-        };
-    },
-};

package/dist/mqttPacket/publish.js

@@ -1,51 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { BitMask } from "./BitMask.js";
-import { Encoder, EncoderError } from "./encoder.js";
-import { booleanFlag, Decoder, DecoderError } from "./decoder.js";
-export const publish = {
-    encode(packet) {
-        const qos = packet.qos || 0;
-        const flags = (packet.dup ? BitMask.bit3 : 0) +
-            (qos & 2 ? BitMask.bit2 : 0) +
-            (qos & 1 ? BitMask.bit1 : 0) +
-            (packet.retain ? BitMask.bit0 : 0);
-        const encoder = new Encoder();
-        encoder.setTopic(packet.topic);
-        if (qos === 1 || qos === 2) {
-            if (typeof packet.id !== "number" || packet.id < 1) {
-                throw new EncoderError("when qos is 1 or 2, packet must have id");
-            }
-            encoder.setInt16(packet.id);
-        }
-        encoder.setRemainder(packet.payload);
-        return { flags, bytes: encoder.done() };
-    },
-    decode(buffer, flags) {
-        const dup = booleanFlag(flags, BitMask.bit3);
-        const qos = (flags & 6) >> 1;
-        const retain = booleanFlag(flags, BitMask.bit0);
-        if (qos !== 0 && qos !== 1 && qos !== 2) {
-            throw new DecoderError("Invalid qos");
-        }
-        if (dup && qos === 0) {
-            throw new DecoderError("Invalid qos for possible duplicate");
-        }
-        const decoder = new Decoder(buffer);
-        const topic = decoder.getTopic();
-        let id = 0;
-        if (qos > 0) {
-            id = decoder.getInt16();
-        }
-        const payload = decoder.getRemainder();
-        // no decoder.done() required because of getRemainder
-        return {
-            type: PacketType.publish,
-            topic,
-            payload,
-            dup,
-            retain,
-            qos,
-            id,
-        };
-    },
-};

package/dist/mqttPacket/pubrec.js

@@ -1,20 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { Decoder } from "./decoder.js";
-import { Encoder } from "./encoder.js";
-export const pubrec = {
-    encode(packet) {
-        const flags = 0;
-        const encoder = new Encoder();
-        encoder.setInt16(packet.id);
-        return { flags, bytes: encoder.done() };
-    },
-    decode(buffer) {
-        const decoder = new Decoder(buffer);
-        const id = decoder.getInt16();
-        decoder.done();
-        return {
-            type: PacketType.pubrec,
-            id,
-        };
-    },
-};

package/dist/mqttPacket/pubrel.js

@@ -1,20 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { Decoder } from "./decoder.js";
-import { Encoder } from "./encoder.js";
-export const pubrel = {
-    encode(packet) {
-        const flags = 0;
-        const encoder = new Encoder();
-        encoder.setInt16(packet.id);
-        return { flags, bytes: encoder.done() };
-    },
-    decode(buffer) {
-        const decoder = new Decoder(buffer);
-        const id = decoder.getInt16();
-        decoder.done();
-        return {
-            type: PacketType.pubrel,
-            id,
-        };
-    },
-};

package/dist/mqttPacket/suback.js

@@ -1,29 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { Encoder } from "./encoder.js";
-import { Decoder } from "./decoder.js";
-export const suback = {
-    encode(packet) {
-        const flags = 0;
-        const encoder = new Encoder();
-        encoder.setInt16(packet.id);
-        encoder.setRemainder(packet.returnCodes);
-        return {
-            flags,
-            bytes: encoder.done(),
-        };
-    },
-    decode(buffer) {
-        const decoder = new Decoder(buffer);
-        const id = decoder.getInt16();
-        const payload = decoder.getRemainder();
-        const returnCodes = [];
-        for (const code of payload) {
-            returnCodes.push(code);
-        }
-        return {
-            type: PacketType.suback,
-            id,
-            returnCodes,
-        };
-    },
-};

package/dist/mqttPacket/subscribe.js

@@ -1,52 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { BitMask } from "./BitMask.js";
-import { Encoder } from "./encoder.js";
-import { booleanFlag, Decoder, DecoderError } from "./decoder.js";
-export const subscribe = {
-    encode(packet) {
-        // Bits 3,2,1 and 0 of the fixed header of the SUBSCRIBE Control Packet are reserved and
-        // MUST be set to 0,0,1 and 0 respectively. The Server MUST treat any other value as
-        // malformed and close the Network Connection [MQTT-3.8.1-1].
-        const flags = 0b0010;
-        const encoder = new Encoder();
-        encoder.setInt16(packet.id);
-        for (const sub of packet.subscriptions) {
-            encoder.setTopic(sub.topicFilter);
-            encoder.setByte(sub.qos);
-        }
-        return { flags, bytes: encoder.done() };
-    },
-    decode(buffer, flags) {
-        // Bits 3,2,1 and 0 of the fixed header of the SUBSCRIBE Control Packet are reserved and
-        // MUST be set to 0,0,1 and 0 respectively. The Server MUST treat any other value as
-        // malformed and close the Network Connection [MQTT-3.8.1-1].
-        if (!booleanFlag(flags, BitMask.bit1)) {
-            throw new DecoderError("Invalid header");
-        }
-        const decoder = new Decoder(buffer);
-        const id = decoder.getInt16();
-        const subscriptions = [];
-        // The payload of a SUBSCRIBE packet MUST contain at least one Topic Filter / QoS pair.
-        // A SUBSCRIBE packet with no payload is a protocol violation [MQTT-3.8.3-3].
-        do {
-            const topicFilter = decoder.getTopicFilter();
-            const qos = decoder.getByte();
-            if (qos !== 0 && qos !== 1 && qos !== 2) {
-                throw new DecoderError("Invalid qos");
-            }
-            if (qos > 0 && id === 0) {
-                throw new DecoderError("Invalid packet identifier");
-            }
-            subscriptions.push({
-                topicFilter: topicFilter,
-                qos,
-            });
-        } while (!decoder.atEnd());
-        decoder.done();
-        return {
-            type: PacketType.subscribe,
-            id,
-            subscriptions,
-        };
-    },
-};

package/dist/mqttPacket/types.js

@@ -1 +0,0 @@
-export {};

package/dist/mqttPacket/unsuback.js

@@ -1,20 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { Decoder } from "./decoder.js";
-import { Encoder } from "./encoder.js";
-export const unsuback = {
-    encode(packet) {
-        const flags = 0;
-        const encoder = new Encoder();
-        encoder.setInt16(packet.id);
-        return { flags, bytes: encoder.done() };
-    },
-    decode(buffer) {
-        const decoder = new Decoder(buffer);
-        const id = decoder.getInt16();
-        decoder.done();
-        return {
-            type: PacketType.unsuback,
-            id,
-        };
-    },
-};

package/dist/mqttPacket/unsubscribe.js

@@ -1,36 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { BitMask } from "./BitMask.js";
-import { Encoder } from "./encoder.js";
-import { booleanFlag, Decoder, DecoderError } from "./decoder.js";
-export const unsubscribe = {
-    encode(packet) {
-        // Bits 3,2,1 and 0 of the fixed header of the UNSUBSCRIBE Control Packet are reserved and
-        // MUST be set to 0,0,1 and 0 respectively. The Server MUST treat any other value as
-        // malformed and close the Network Connection [MQTT-3.10.1-1].
-        const flags = 0b0010;
-        const encoder = new Encoder();
-        encoder.setInt16(packet.id);
-        for (const topicFilter of packet.topicFilters) {
-            encoder.setTopicFilter(topicFilter);
-        }
-        return { flags, bytes: encoder.done() };
-    },
-    decode(buffer, flags) {
-        if (!booleanFlag(flags, BitMask.bit1)) {
-            throw new DecoderError("Invalid header");
-        }
-        const decoder = new Decoder(buffer);
-        const id = decoder.getInt16();
-        const topicFilters = [];
-        do {
-            const topicFilter = decoder.getTopicFilter();
-            topicFilters.push(topicFilter);
-        } while (!decoder.atEnd());
-        decoder.done();
-        return {
-            type: PacketType.unsubscribe,
-            id,
-            topicFilters,
-        };
-    },
-};

package/dist/mqttPacket/validators.js

@@ -1,15 +0,0 @@
-// deno-lint-ignore no-control-regex
-const invalidUTF8regEx = new RegExp(/\x00|\uFFFD/);
-// deno-lint-ignore no-control-regex
-const invalidTopicRegEx = new RegExp(/^$|\+|#|\x00|\uFFFD/);
-// deno-lint-ignore no-control-regex
-const invalidTopicFilterRegEx = new RegExp(/^$|#.|[^\/]\+|\+[^\/]|\x00|\uFFFD/);
-export function invalidUTF8(value) {
-    return invalidUTF8regEx.test(value);
-}
-export function invalidTopic(value) {
-    return invalidTopicRegEx.test(value);
-}
-export function invalidTopicFilter(value) {
-    return invalidTopicFilterRegEx.test(value);
-}

package/dist/node/tcpClient.js

@@ -1,81 +0,0 @@
-/*
- * this a NodeJS specific implementation of TCP client sockets
- * it extends the platform agnostic Client class
- *  @module
- */
-import { Client } from "../client/client.js";
-import { logger } from "../client/deps.js";
-import { readFile } from "node:fs/promises";
-import { createConnection } from "node:net";
-import * as tls from "node:tls";
-import { wrapNodeSocket } from "./wrapNodeSocket.js";
-/**
- * @function getFileData
- * @param filename
- * @returns Promise
- *
- * Fetches data from a file and returns it as a string
- * @example
- * const data = await getFileData("data.txt");
- */
-export async function getFileData(filename) {
-    if (!filename) {
-        return;
-    }
-    const data = await readFile(filename, { encoding: "utf-8" });
-    if (data === "") {
-        return;
-    }
-    return data;
-}
-/*
- * TCPclient extends the Client class to provide TCP based clients
- * it is used by the MQTTclient to connect to the broker
- * see mqtt.ts in the /bin folder as an example
- */
-export class TcpClient extends Client {
-    connectMQTT(hostname, port = 1883) {
-        logger.debug({ hostname, port });
-        return new Promise((resolve, reject) => {
-            const socket = createConnection({ port, host: hostname }, () => {
-                logger.debug("Connected to server");
-                resolve(wrapNodeSocket(socket));
-            });
-            socket.once("error", (err) => {
-                logger.debug("Connection failed: ", err);
-                reject(err);
-            });
-        });
-    }
-    connectMQTTS(hostname, port = 8883, ca, cert, key) {
-        const opts = {
-            host: hostname,
-            port,
-            secureContext: (ca || key || cert)
-                ? tls.createSecureContext({ ca, cert, key })
-                : undefined,
-        };
-        logger.debug({ hostname, port, ca, cert });
-        return new Promise((resolve, reject) => {
-            const socket = tls.connect(opts, () => {
-                logger.debug("Connected to server");
-                resolve(wrapNodeSocket(socket));
-            });
-            socket.once("error", (err) => {
-                logger.debug("Connection failed", err);
-                reject(err);
-            });
-        });
-    }
-    createConn(protocol, hostname, port, caCerts) {
-        // if you need to support alternative connection types just
-        // overload this method in your subclass
-        if (protocol === "mqtts:") {
-            return this.connectMQTTS(hostname, port, caCerts);
-        }
-        if (protocol === "mqtt:") {
-            return this.connectMQTT(hostname, port);
-        }
-        throw `Unsupported protocol: ${protocol}`;
-    }
-}

package/dist/node/tcpServer.js

@@ -1,43 +0,0 @@
-import { createServer } from "node:net";
-import { MqttServer } from "../server/mod.js";
-import { wrapNodeSocket } from "./wrapNodeSocket.js";
-/*
- * TCP server that wraps a MqttServer, see demoServer.ts in the /bin folder
- */
-export class TcpServer {
-    mqttServer;
-    server;
-    serverOptions;
-    constructor(serverOptions, mqttOptions) {
-        this.mqttServer = new MqttServer(mqttOptions);
-        this.serverOptions = serverOptions;
-    }
-    start() {
-        this.server = createServer((sock) => this.mqttServer.serve(wrapNodeSocket(sock)));
-        this.server.listen(this.serverOptions.port, this.serverOptions.hostname);
-    }
-    stop() {
-        this.server?.close();
-    }
-    get port() {
-        const address = this.server?.address();
-        if (typeof address === "object") {
-            return address?.port;
-        }
-        return this.serverOptions?.port;
-    }
-    get address() {
-        const addressResult = this.server?.address();
-        if (typeof addressResult === "object") {
-            const address = addressResult?.address;
-            if (address === "::") {
-                return "localhost";
-            }
-            if (address?.includes(":")) {
-                return `[${address}]`;
-            }
-            return address;
-        }
-        return addressResult;
-    }
-}

package/dist/node/wrapNodeSocket.js

@@ -1,47 +0,0 @@
-import { Writable } from "node:stream";
-function closer(sock) {
-    if (!sock.closed) {
-        sock.end();
-    }
-}
-export function wrapNodeSocket(socket) {
-    const readable = new ReadableStream({
-        type: "bytes",
-        start(controller) {
-            socket.on("data", (data) => {
-                controller.enqueue(data);
-                const desiredSize = controller.desiredSize ?? 0;
-                if (desiredSize <= 0) {
-                    // The internal queue is full, so propagate
-                    // the backpressure signal to the underlying source.
-                    socket.pause();
-                }
-            });
-            socket.on("error", (err) => controller.error(err));
-            socket.on("end", () => {
-                // close the controller
-                controller.close();
-                // and unlock the last BYOB read request
-                controller.byobRequest?.respond(0);
-            });
-        },
-        pull: () => {
-            socket.resume();
-        },
-        cancel: () => {
-            socket.end();
-        },
-    });
-    const writable = Writable.toWeb(socket);
-    const remoteAddr = {
-        hostname: socket.remoteAddress || "",
-        port: socket.remotePort || 0,
-    };
-    const conn = {
-        readable: readable,
-        writable: writable,
-        close: () => closer(socket),
-        remoteAddr,
-    };
-    return conn;
-}

package/dist/persistence/deps.js

@@ -1,3 +0,0 @@
-export { PacketType } from "../mqttPacket/mod.js";
-export { Trie } from "../trie/trie.js";
-export { logger } from "../utils/mod.js";

package/dist/persistence/memory/memoryPersistence.js

@@ -1,117 +0,0 @@
-import { Trie, } from "../deps.js";
-import { assert } from "../../utils/mod.js";
-const maxPacketId = 0xffff;
-export class MemoryStore {
-    clientId;
-    packetId;
-    pendingIncoming;
-    pendingOutgoing;
-    pendingAckOutgoing;
-    subscriptions;
-    constructor(clientId) {
-        this.packetId = 0;
-        this.pendingIncoming = new Map();
-        this.pendingOutgoing = new Map();
-        this.pendingAckOutgoing = new Set();
-        this.subscriptions = new Map();
-        this.clientId = clientId;
-    }
-    nextId() {
-        const currentId = this.packetId;
-        do {
-            this.packetId++;
-            if (this.packetId > maxPacketId) {
-                this.packetId = 0;
-            }
-        } while ((this.pendingOutgoing.has(this.packetId) ||
-            this.pendingAckOutgoing.has(this.packetId)) &&
-            this.packetId !== currentId);
-        assert(this.packetId !== currentId, "No unused packetId available");
-        return this.packetId;
-    }
-}
-export class MemoryPersistence {
-    clientList;
-    retained;
-    trie;
-    constructor() {
-        this.clientList = new Map();
-        this.retained = new Map();
-        this.trie = new Trie(true);
-    }
-    registerClient(clientId, handler, clean) {
-        const existingClient = this.clientList.get(clientId);
-        const store = !clean && existingClient
-            ? existingClient.store
-            : new MemoryStore(clientId);
-        this.clientList.set(clientId, { store, handler });
-        return store;
-    }
-    deregisterClient(clientId) {
-        const client = this.clientList.get(clientId);
-        if (client) {
-            this.unsubscribeAll(client.store);
-            this.clientList.delete(clientId);
-        }
-    }
-    subscribe(store, topicFilter, qos) {
-        const clientId = store.clientId;
-        if (!store.subscriptions.has(topicFilter)) {
-            store.subscriptions.set(topicFilter, qos);
-            this.trie.add(topicFilter, { clientId, qos });
-        }
-    }
-    unsubscribe(store, topicFilter) {
-        const clientId = store.clientId;
-        const qos = store.subscriptions.get(topicFilter);
-        if (qos) {
-            store.subscriptions.delete(topicFilter);
-            this.trie.remove(topicFilter, { clientId, qos });
-        }
-    }
-    unsubscribeAll(store) {
-        for (const [topicFilter, _qos] of store.subscriptions) {
-            this.unsubscribe(store, topicFilter);
-        }
-    }
-    publish(topic, packet) {
-        if (packet.retain) {
-            this.retained.set(packet.topic, packet);
-            if (packet.payload === undefined) {
-                this.retained.delete(packet.topic);
-            }
-        }
-        // dedup clients
-        const clients = new Map();
-        for (const { clientId, qos } of this.trie.match(topic)) {
-            const prevQos = clients.get(clientId);
-            if (!prevQos || prevQos < qos) {
-                clients.set(clientId, qos);
-            }
-        }
-        // publish the message to all clients
-        for (const [clientId, qos] of clients) {
-            const newPacket = Object.assign({}, packet);
-            newPacket.retain = false;
-            newPacket.qos = qos;
-            //  logger.debug(`publish ${topic} to client ${clientId}`);
-            const client = this.clientList.get(clientId);
-            client?.handler(packet);
-        }
-    }
-    handleRetained(clientId) {
-        const retainedTrie = new Trie();
-        const client = this.clientList.get(clientId);
-        const store = client?.store;
-        if (store) {
-            for (const [topicFilter, _qos] of store.subscriptions) {
-                retainedTrie.add(topicFilter, clientId);
-            }
-            for (const [topic, packet] of this.retained) {
-                if (retainedTrie.match(topic).length > 0) {
-                    client?.handler(packet);
-                }
-            }
-        }
-    }
-}

package/dist/persistence/persistence.js

@@ -1 +0,0 @@
-export {};

package/dist/persistence/store.js

@@ -1 +0,0 @@
-export {};

package/dist/server/context.js

@@ -1,100 +0,0 @@
-import { logger, MqttConn, PacketNameByType, PacketType, } from "./deps.js";
-export const SysPrefix = "$";
-export const utf8Encoder = new TextEncoder();
-/**
- * The Context class is used to maintain state of a MQTT connection
- * It handles:
- *  - connect/disconnect including broadcasting of these events
- *  - publish
- *  - persistence
- *  - the will
- */
-export class Context {
-    connected;
-    conn;
-    mqttConn;
-    persistence;
-    handlers;
-    static clientList = new Map();
-    store;
-    will;
-    timer;
-    constructor(persistence, conn, handlers) {
-        this.persistence = persistence;
-        this.connected = false;
-        this.conn = conn;
-        this.mqttConn = new MqttConn({ conn });
-        this.handlers = handlers;
-    }
-    async send(packet) {
-        logger.debug("Sending", PacketNameByType[packet.type]);
-        logger.debug(JSON.stringify(packet, null, 2));
-        await this.mqttConn.send(packet);
-    }
-    connect(clientId, clean) {
-        logger.debug("Connecting", clientId);
-        const existingSession = Context.clientList.get(clientId);
-        if (existingSession) {
-            existingSession.close(false);
-        }
-        this.store = this.persistence.registerClient(clientId, this.doPublish.bind(this), clean);
-        this.connected = true;
-        this.broadcast("$SYS/connect/clients", clientId);
-        logger.debug("Connected", clientId);
-    }
-    doPublish(packet) {
-        const qos = packet.qos || 0;
-        if (qos === 0) {
-            packet.id = 0;
-            this.send(packet);
-            return;
-        }
-        if (this.store) {
-            packet.id = this.store.nextId();
-            this.store.pendingOutgoing.set(packet.id, packet);
-            this.send(packet);
-        }
-    }
-    clean(clientId) {
-        this.persistence.deregisterClient(clientId);
-    }
-    close(executewill = true) {
-        if (this.connected) {
-            logger.debug(`Closing ${this.store?.clientId} while mqttConn is ${this.mqttConn.isClosed ? "" : "not "}closed`);
-            this.connected = false;
-            if (typeof this.timer === "object") {
-                this.timer.clear();
-            }
-            if (this.store) {
-                this.broadcast("$SYS/disconnect/clients", this.store.clientId);
-            }
-            if (executewill) {
-                this.handleWill();
-            }
-        }
-        if (!this.mqttConn.isClosed) {
-            this.mqttConn.close();
-        }
-    }
-    handleWill() {
-        if (this.will) {
-            if (!this.will.topic.startsWith(SysPrefix) &&
-                this.handlers.isAuthorizedToPublish &&
-                this.handlers.isAuthorizedToPublish(this, this.will.topic)) {
-                this.persistence.publish(this.will.topic, this.will);
-            }
-        }
-    }
-    broadcast(topic, payload, retain = false) {
-        const packet = {
-            type: PacketType.publish,
-            topic,
-            retain,
-            payload: utf8Encoder.encode(payload),
-        };
-        if (packet.retain === true) {
-            this.persistence.retained.set(packet.topic, packet);
-        }
-        this.persistence.publish(packet.topic, packet);
-    }
-}

package/dist/server/deps.js

@@ -1,5 +0,0 @@
-export { MqttConn } from "../mqttConn/mqttConn.js";
-export { MemoryPersistence } from "../persistence/memory/memoryPersistence.js";
-export { AuthenticationResult, PacketNameByType, PacketType, } from "../mqttPacket/mod.js";
-export { Timer } from "../timer/timer.js";
-export { logger } from "../utils/mod.js";