@seriousme/opifex 1.6.3 → 1.7.0

package/dist/mqttPacket/encoder.js

@@ -1,56 +0,0 @@
-const utf8Encoder = new TextEncoder();
-import { invalidTopic, invalidTopicFilter } from "./validators.js";
-export class EncoderError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "EncoderError";
-    }
-}
-export class Encoder {
-    buffer;
-    constructor() {
-        this.buffer = [];
-    }
-    setByte(value) {
-        this.buffer.push(value);
-        return this;
-    }
-    setInt16(value) {
-        this.setByte(value >> 8);
-        this.setByte(value & 0xff);
-        return this;
-    }
-    setByteArray(value) {
-        if (value.length > 0xffff) {
-            throw new EncoderError("More than 0xffff bytes of data");
-        }
-        this.setInt16(value.length);
-        this.buffer.push(...value);
-        return this;
-    }
-    setUtf8String(value) {
-        this.setByteArray(utf8Encoder.encode(value));
-        return this;
-    }
-    setTopic(value) {
-        if (invalidTopic(value)) {
-            throw new EncoderError("Topic must contain valid UTF-8 and contain more than 1 byte and no wildcards");
-        }
-        this.setUtf8String(value);
-        return this;
-    }
-    setTopicFilter(value) {
-        if (invalidTopicFilter(value)) {
-            throw new EncoderError("Topicfilter must contain valid UTF-8 and contain more than 1 byte and valid wildcards");
-        }
-        this.setUtf8String(value);
-        return this;
-    }
-    setRemainder(value) {
-        this.buffer.push(...value);
-        return this;
-    }
-    done() {
-        return this.buffer;
-    }
-}

package/dist/mqttPacket/length.js

@@ -1,43 +0,0 @@
-export function encodeLength(n) {
-    const output = [];
-    let x = n;
-    do {
-        let encodedByte = x % 0x80;
-        x = Math.floor(x / 0x80);
-        if (x > 0) {
-            encodedByte = encodedByte | 0x80;
-        }
-        output.push(encodedByte);
-    } while (x > 0);
-    if (output.length > 4) {
-        throw Error("length encoding failed");
-    }
-    return output;
-}
-export function decodeLength(buf, start) {
-    const decode = getLengthDecoder();
-    const lenBuf = buf.subarray(start);
-    for (const byte of lenBuf) {
-        const { done, length, numLengthBytes } = decode(byte);
-        if (done) {
-            return { length, numLengthBytes };
-        }
-    }
-    throw Error("length decoding failed");
-}
-export function getLengthDecoder() {
-    let numLengthBytes = 1;
-    let length = 0;
-    let multiplier = 1;
-    return function addLengthByte(encodedByte) {
-        length += (encodedByte & 0x7f) * multiplier;
-        multiplier *= 0x80;
-        if ((encodedByte & 0x80) === 0) {
-            return { done: true, length, numLengthBytes };
-        }
-        if (numLengthBytes++ >= 4) {
-            throw Error("length decoding failed");
-        }
-        return { done: false, length, numLengthBytes };
-    };
-}

package/dist/mqttPacket/mod.js

@@ -1,76 +0,0 @@
-/**
- *  This module provides the encoding and decoding of MQTT packets
- * it is used by the server and client modules
- *  @module
- */
-import { PacketNameByType, PacketType } from "./PacketType.js";
-import { invalidTopic, invalidTopicFilter, invalidUTF8 } from "./validators.js";
-import { decodeLength, encodeLength } from "./length.js";
-import { connect } from "./connect.js";
-import { connack } from "./connack.js";
-import { AuthenticationResult, AuthenticationResultByNumber, } from "./AuthenticationResult.js";
-import { publish } from "./publish.js";
-import { puback } from "./puback.js";
-import { pubrec } from "./pubrec.js";
-import { pubrel } from "./pubrel.js";
-import { pubcomp } from "./pubcomp.js";
-import { subscribe } from "./subscribe.js";
-import { suback } from "./suback.js";
-import { unsubscribe } from "./unsubscribe.js";
-import { unsuback } from "./unsuback.js";
-import { pingreq } from "./pingreq.js";
-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, };
-export const packetsByType = [
-    null,
-    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 function encode(packet) {
-    const packetType = packet.type;
-    // deno-lint-ignore no-explicit-any
-    const pkt = packet;
-    const encoded = packetsByType[packetType]?.encode(pkt);
-    if (!encoded) {
-        throw Error("Packet encoding failed");
-    }
-    const { flags, bytes } = encoded;
-    return Uint8Array.from([
-        (packetType << 4) | flags,
-        ...encodeLength(bytes.length),
-        ...bytes,
-    ]);
-}
-export function decodePayload(firstByte, buffer) {
-    const packetType = firstByte >> 4;
-    const flags = firstByte & 0x0f;
-    const packet = packetsByType[packetType]?.decode(buffer, flags);
-    if (packet !== undefined) {
-        return packet;
-    }
-    throw new Error("packet decoding failed");
-}
-export function decode(buffer) {
-    if (buffer.length < 2) {
-        throw new DecoderError("Packet decoding failed");
-    }
-    const { length, numLengthBytes } = decodeLength(buffer, 1);
-    const start = numLengthBytes + 1;
-    const end = start + length;
-    return decodePayload(buffer[0], buffer.subarray(start, end));
-}
-export { getLengthDecoder } from "../mqttPacket/length.js";

package/dist/mqttPacket/pingreq.js

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

package/dist/mqttPacket/pingres.js

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

package/dist/mqttPacket/puback.js

@@ -1,20 +0,0 @@
-import { PacketType } from "./PacketType.js";
-import { Decoder } from "./decoder.js";
-import { Encoder } from "./encoder.js";
-export const puback = {
-    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.puback,
-            id,
-        };
-    },
-};

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,50 +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;
-    }
-    async start() {
-        this.server = createServer((sock) => this.mqttServer.serve(wrapNodeSocket(sock)));
-        const isListening = new Promise((resolve) => {
-            this.server?.on("listening", () => {
-                resolve(true);
-            });
-        });
-        this.server.listen(this.serverOptions.port, this.serverOptions.hostname);
-        await isListening;
-        return;
-    }
-    stop() {
-        this.server?.close();
-    }
-    get port() {
-        const address = this.server?.address();
-        if (typeof address === "object" && address !== null) {
-            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;
-    }
-}