@seriousme/opifex 1.6.2 → 1.7.0

package/dist/server/handlers/handleConnect.js

@@ -1,46 +0,0 @@
-import { AuthenticationResult, logger, PacketType, Timer, } from "../deps.js";
-function isAuthenticated(ctx, packet) {
-    if (ctx.handlers.isAuthenticated) {
-        return ctx.handlers.isAuthenticated(ctx, packet.clientId || "", packet.username || "", packet.password || new Uint8Array(0));
-    }
-    return AuthenticationResult.ok;
-}
-function validateConnect(ctx, packet) {
-    if (packet.protocolLevel !== 4) {
-        return AuthenticationResult.unacceptableProtocol;
-    }
-    return isAuthenticated(ctx, packet);
-}
-export function handleConnect(ctx, packet) {
-    const clientId = packet.clientId || `Opifex-${crypto.randomUUID()}`;
-    const returnCode = validateConnect(ctx, packet);
-    // connect is ok
-    if (returnCode === AuthenticationResult.ok) {
-        if (packet.will) {
-            ctx.will = {
-                type: PacketType.publish,
-                qos: packet.will.qos,
-                retain: packet.will.retain,
-                topic: packet.will.topic,
-                payload: packet.will.payload,
-            };
-        }
-        ctx.connect(clientId, packet.clean || false);
-        const keepAlive = packet.keepAlive || 0;
-        if (keepAlive > 0) {
-            logger.debug(`Setting keepalive to ${keepAlive * 1500} ms`);
-            ctx.timer = new Timer(() => {
-                ctx.close();
-            }, Math.floor(keepAlive * 1500));
-        }
-    }
-    const sessionPresent = false;
-    ctx.send({
-        type: PacketType.connack,
-        sessionPresent,
-        returnCode,
-    });
-    if (returnCode !== AuthenticationResult.ok) {
-        ctx.close();
-    }
-}

package/dist/server/handlers/handleDisconnect.js

@@ -1,4 +0,0 @@
-export function handleDisconnect(ctx) {
-    ctx.will = undefined;
-    ctx.close();
-}

package/dist/server/handlers/handlePacket.js

@@ -1,58 +0,0 @@
-import { PacketNameByType, PacketType, } from "../deps.js";
-import { handleConnect } from "./handleConnect.js";
-import { handlePingreq } from "./handlePingreq.js";
-import { handlePublish } from "./handlePublish.js";
-import { handlePuback } from "./handlePuback.js";
-import { handlePubrec } from "./handlePubrec.js";
-import { handlePubrel } from "./handlePubrel.js";
-import { handlePubcomp } from "./handlePubcomp.js";
-import { handleSubscribe } from "./handleSubscribe.js";
-import { handleUnsubscribe } from "./handleUnsubscribe.js";
-import { handleDisconnect } from "./handleDisconnect.js";
-import { logger } from "../deps.js";
-export async function handlePacket(ctx, packet) {
-    logger.debug("handling", PacketNameByType[packet.type]);
-    logger.debug(JSON.stringify(packet, null, 2));
-    if (!ctx.connected) {
-        if (packet.type === PacketType.connect) {
-            handleConnect(ctx, packet);
-        }
-        else {
-            throw new Error(`Received ${PacketNameByType[packet.type]} packet before connect`);
-        }
-    }
-    else {
-        switch (packet.type) {
-            case PacketType.pingreq:
-                await handlePingreq(ctx);
-                break;
-            case PacketType.publish:
-                await handlePublish(ctx, packet);
-                break;
-            case PacketType.puback:
-                handlePuback(ctx, packet);
-                break;
-            case PacketType.pubrel:
-                await handlePubrel(ctx, packet);
-                break;
-            case PacketType.pubrec:
-                await handlePubrec(ctx, packet);
-                break;
-            case PacketType.pubcomp:
-                handlePubcomp(ctx, packet);
-                break;
-            case PacketType.subscribe:
-                await handleSubscribe(ctx, packet);
-                break;
-            case PacketType.unsubscribe:
-                await handleUnsubscribe(ctx, packet);
-                break;
-            case PacketType.disconnect:
-                handleDisconnect(ctx);
-                break;
-            default:
-                throw new Error(`Received unexpected ${PacketNameByType[packet.type]} packet after connect`);
-        }
-        ctx.timer?.reset();
-    }
-}

package/dist/server/handlers/handlePingreq.js

@@ -1,6 +0,0 @@
-import { PacketType } from "../deps.js";
-export async function handlePingreq(ctx) {
-    await ctx.send({
-        type: PacketType.pingres,
-    });
-}

package/dist/server/handlers/handlePuback.js

@@ -1,8 +0,0 @@
-// A PUBACK Packet is the response to a PUBLISH Packet with QoS level 1.
-export function handlePuback(ctx, packet) {
-    // qos 1 only
-    const id = packet.id;
-    if (ctx.store?.pendingOutgoing.has(id)) {
-        ctx.store.pendingOutgoing.delete(id);
-    }
-}

package/dist/server/handlers/handlePubcomp.js

@@ -1,8 +0,0 @@
-// The PUBCOMP Packet is the response to a PUBREL Packet.
-// It is the fourth and final packet of the QoS 2 protocol exchange.
-export function handlePubcomp(ctx, packet) {
-    const id = packet.id;
-    if (ctx.store?.pendingAckOutgoing.has(id)) {
-        ctx.store.pendingAckOutgoing.delete(id);
-    }
-}

package/dist/server/handlers/handlePublish.js

@@ -1,41 +0,0 @@
-import { SysPrefix } from "../context.js";
-import { PacketType } from "../deps.js";
-function authorizedToPublish(ctx, topic) {
-    if (topic.startsWith(SysPrefix)) {
-        return false;
-    }
-    if (ctx.handlers.isAuthorizedToPublish) {
-        return ctx.handlers.isAuthorizedToPublish(ctx, topic);
-    }
-    return true;
-}
-export async function handlePublish(ctx, packet) {
-    if (!authorizedToPublish(ctx, packet.topic)) {
-        return;
-    }
-    const qos = packet.qos || 0;
-    if (qos === 0) {
-        ctx.persistence.publish(packet.topic, packet);
-        return;
-    }
-    if (packet.id !== undefined) {
-        // qos 1
-        if (qos === 1) {
-            const id = packet.id; // retain the id
-            ctx.persistence.publish(packet.topic, packet);
-            await ctx.send({
-                type: PacketType.puback,
-                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/server/handlers/handlePubrec.js

@@ -1,15 +0,0 @@
-import { PacketType } from "../deps.js";
-// qos 2
-// Discard message, Store PUBREC received <Packet Identifier>
-// send PUBREL <Packet Identifier>
-export async function handlePubrec(ctx, packet) {
-    const id = packet.id;
-    if (ctx.store?.pendingOutgoing.has(id)) {
-        ctx.store.pendingOutgoing.delete(id);
-        ctx.store.pendingAckOutgoing.add(id);
-        await ctx.send({
-            type: PacketType.pubrel,
-            id,
-        });
-    }
-}

package/dist/server/handlers/handlePubrel.js

@@ -1,18 +0,0 @@
-import { PacketType } from "../deps.js";
-// qos 2 only
-// Method A, Initiate onward delivery of the Application Message1  then discard message
-// Send PUBCOMP <Packet Identifier>
-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.persistence.publish(storedPacket.topic, storedPacket);
-            ctx.store.pendingIncoming.delete(id);
-            await ctx.send({
-                type: PacketType.pubcomp,
-                id,
-            });
-        }
-    }
-}

package/dist/server/handlers/handleSubscribe.js

@@ -1,33 +0,0 @@
-import { PacketType, } from "../deps.js";
-const SubscriptionFailure = 0x80;
-function authorizedToSubscribe(ctx, topicFilter) {
-    if (ctx.handlers.isAuthorizedToSubscribe) {
-        return ctx.handlers.isAuthorizedToSubscribe(ctx, topicFilter);
-    }
-    return true;
-}
-export async function handleSubscribe(ctx, packet) {
-    //  The order of return codes in the SUBACK Packet MUST match the order of
-    //  Topic Filters in the SUBSCRIBE Packet [MQTT-3.9.3-1].
-    const validSubscriptions = [];
-    const returnCodes = packet.subscriptions.map((sub) => {
-        if (ctx.store) {
-            if (!authorizedToSubscribe(ctx, sub.topicFilter)) {
-                return SubscriptionFailure;
-            }
-            ctx.persistence.subscribe(ctx.store, sub.topicFilter, sub.qos);
-            validSubscriptions.push(sub);
-            return sub.qos;
-        }
-        return SubscriptionFailure; // failure
-    });
-    await ctx.send({
-        type: PacketType.suback,
-        id: packet.id,
-        returnCodes: returnCodes,
-    });
-    // send any retained messages that match these subscriptions
-    if (ctx.store) {
-        ctx.persistence.handleRetained(ctx.store.clientId);
-    }
-}

package/dist/server/handlers/handleUnsubscribe.js

@@ -1,12 +0,0 @@
-import { PacketType } from "../deps.js";
-export async function handleUnsubscribe(ctx, packet) {
-    for (const topic of packet.topicFilters) {
-        if (ctx.store) {
-            ctx.persistence.unsubscribe(ctx.store, topic);
-        }
-    }
-    await ctx.send({
-        type: PacketType.unsuback,
-        id: packet.id,
-    });
-}

package/dist/server/mod.js

@@ -1,7 +0,0 @@
-/**
- *  This module provides an MQTT Server interface see the /bin folder for examples
- *  @module
- */
-export { AuthenticationResult } from "./deps.js";
-export { MqttServer } from "./server.js";
-export { Context } from "./context.js";

package/dist/server/server.js

@@ -1,47 +0,0 @@
-import { Context } from "./context.js";
-import { AuthenticationResult, logger, MemoryPersistence, } from "./deps.js";
-import { handlePacket } from "./handlers/handlePacket.js";
-const defaultIsAuthenticated = (_ctx, _clientId, _username, _password) => AuthenticationResult.ok;
-const defaultIsAuthorized = (_ctx, _topic) => true;
-/** The MqttServer class provides a MQTT server with configurable persistence and
- * authentication/authorization handlers.
- *
- * The default handlers are:
- *  - isAuthenticated: always returns ok
- *  - isAuthorizedToPublish: always returns true
- *  - isAuthorizedToSubscribe: always returns true
- *
- * To customize the handlers, pass in a Handlers object.
- * To customize the persistence, pass in a Persistence object.
- */
-export class MqttServer {
-    handlers;
-    persistence;
-    constructor({ persistence, handlers, }) {
-        this.persistence = persistence || new MemoryPersistence();
-        this.handlers = {
-            isAuthenticated: handlers?.isAuthenticated || defaultIsAuthenticated,
-            isAuthorizedToPublish: handlers?.isAuthorizedToPublish ||
-                defaultIsAuthorized,
-            isAuthorizedToSubscribe: handlers?.isAuthorizedToSubscribe ||
-                defaultIsAuthorized,
-        };
-    }
-    async serve(conn) {
-        const ctx = new Context(this.persistence, conn, this.handlers);
-        if (conn.remoteAddr?.transport === "tcp") {
-            logger.debug(`socket connected from ${conn.remoteAddr.hostname}`);
-        }
-        try {
-            for await (const packet of ctx.mqttConn) {
-                handlePacket(ctx, packet);
-            }
-        }
-        catch (err) {
-            logger.debug(`Error while serving:${err}`);
-        }
-        finally {
-            ctx.close();
-        }
-    }
-}

package/dist/socket/socket.js

@@ -1,36 +0,0 @@
-export class Conn {
-    reader;
-    writer;
-    closed;
-    remoteAddr;
-    closer;
-    constructor(sockConn) {
-        this.closed = false;
-        this.reader = sockConn.readable.getReader({ mode: "byob" });
-        this.writer = sockConn.writable.getWriter();
-        // this.writer.closed.then(() => this.closed = true);
-        this.closer = sockConn.close.bind(sockConn);
-        this.remoteAddr = sockConn.remoteAddr;
-    }
-    async read(buff) {
-        const buff2 = new Uint8Array(buff.length);
-        const result = await this.reader.read(buff2);
-        if (!result.done) {
-            buff.set(result.value);
-        }
-        return result.value?.byteLength || null;
-    }
-    write(data) {
-        if (this.closed) {
-            return Promise.reject();
-        }
-        this.writer.write(data);
-        return new Promise((resolve) => resolve(data.length));
-    }
-    close() {
-        if (!this.closed) {
-            this.closed = true;
-            this.closer();
-        }
-    }
-}

package/dist/timer/timer.js

@@ -1,40 +0,0 @@
-export class Timer {
-    delay; // delay in microseconds
-    // deno-lint-ignore ban-types
-    action; // function to perform when timer expires
-    timer;
-    end = 0;
-    running = false;
-    // deno-lint-ignore ban-types
-    constructor(action, delay, wait = false) {
-        this.delay = delay;
-        this.action = action;
-        if (!wait) {
-            this.reset();
-        }
-    }
-    startTimer(delay) {
-        this.running = true;
-        this.timer = setTimeout(() => this.ring(), delay);
-    }
-    ring() {
-        const timeLeft = this.end - Date.now();
-        // check if delay has passed, else execute action
-        if (timeLeft > 0) {
-            this.startTimer(timeLeft);
-            return;
-        }
-        this.running = false;
-        this.action();
-    }
-    reset() {
-        this.end = Date.now() + this.delay;
-        if (!this.running) {
-            this.startTimer(this.delay);
-        }
-    }
-    clear() {
-        clearTimeout(this.timer);
-        this.running = false;
-    }
-}

package/dist/trie/trie.js

@@ -1,95 +0,0 @@
-export class Trie {
-    #value;
-    #children;
-    separator = "/";
-    wildcardOne = "+";
-    wildcardSubtree = "#";
-    reservedPrefix = "$";
-    looseCompare;
-    constructor(looseCompare = false) {
-        this.#value = [];
-        this.#children = new Map();
-        this.looseCompare = looseCompare;
-    }
-    matchChild(child, parts) {
-        const childNode = this.#children.get(child);
-        return childNode ? childNode._match(parts) : [];
-    }
-    match(key) {
-        const parts = key.split(this.separator);
-        // toplevel wildcards are not allowed to match toplevel reserved topics
-        if (parts.length > 0 && parts[0].charAt(0) === this.reservedPrefix) {
-            return this._matchPrefix(parts);
-        }
-        return this._match(parts);
-    }
-    _matchPrefix(parts) {
-        if (parts.length === 0) {
-            return this.#value ? this.#value : [];
-        }
-        const [first, ...rest] = parts;
-        return this.matchChild(first, rest);
-    }
-    _match(parts) {
-        if (parts.length === 0) {
-            return this.#value ? this.#value : [];
-        }
-        const [first, ...rest] = parts;
-        const exact = this.matchChild(first, rest);
-        const single = this.matchChild(this.wildcardOne, rest);
-        const subtree = this.matchChild(this.wildcardSubtree, []);
-        const results = exact.concat(single, subtree);
-        return results;
-    }
-    add(key, value) {
-        return this._add(key.split(this.separator), value);
-    }
-    _add(parts, value) {
-        if (parts.length === 0) {
-            this.#value = this.#value.concat(value);
-            return;
-        }
-        const [first, ...rest] = parts;
-        const child = this.#children.get(first);
-        if (child instanceof Trie) {
-            child._add(rest, value);
-        }
-        else {
-            const node = new Trie(this.looseCompare);
-            this.#children.set(first, node);
-            node._add(rest, value);
-        }
-        return;
-    }
-    remove(key, value) {
-        return this._remove(key.split(this.separator), value);
-    }
-    _remove(parts, value) {
-        if (parts.length === 0) {
-            const arr = this.#value || [];
-            this.#value = arr.filter(this.filter(value));
-            return;
-        }
-        const [first, ...rest] = parts;
-        const node = this.#children.get(first);
-        if (node) {
-            node._remove(rest, value);
-            if (node.#value.length === 0 && this.#children.size === 0) {
-                this.#children.delete(first);
-            }
-        }
-    }
-    filter(value) {
-        if (this.looseCompare && typeof value === "object") {
-            return (item) => {
-                for (const key in value) {
-                    if (value[key] !== item[key]) {
-                        return true;
-                    }
-                }
-                return false;
-            };
-        }
-        return (item) => item !== value;
-    }
-}

package/dist/tsconfig.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["../bin/conformanceServer.ts","../bin/demoServer.ts","../bin/mqtt.ts"],"version":"5.7.3"}

package/dist/utils/args.js

@@ -1,75 +0,0 @@
-function formatValue(key, value, boolean, string) {
-    if (key === "__proto__" || key === "constructor") {
-        throw new Error(`Invalid argument: ${key}`);
-    }
-    if (boolean.includes(key)) {
-        if (value !== "false") {
-            return true;
-        }
-        return false;
-    }
-    if (!string.includes(key)) {
-        const num = Number(value);
-        if (!Number.isNaN(num)) {
-            return num;
-        }
-    }
-    return value;
-}
-function parseKeyValue(arg, alias) {
-    if (arg.startsWith("--no-")) {
-        const key = arg.slice(5);
-        return [key, false];
-    }
-    if (arg.startsWith("--")) {
-        const [key, value] = arg.slice(2).split("=", 2);
-        return [key, value];
-    }
-    if (arg.startsWith("-")) {
-        const [flag, value] = arg.slice(1).split("=", 2);
-        const key = alias[flag] || flag;
-        return [key, value];
-    }
-    return ["_", arg];
-}
-/**
- *  a parser for command line arguments
- * @param args the arguments to parse
- * @param opts the options for the parser
- * @returns the parsed arguments
- *
- * @example
- * const args = parseArgs(args, {
- *  alias: { h: "help" },
- *  boolean: ["help"],
- *  string: ["port"],
- *  default: { port: 3000 },
- * });
- */
-export function parseArgs(args, opts = {}) {
-    const { alias = {}, boolean = [], string = [], default: defaults = {} } = opts;
-    const result = { ...defaults };
-    result["_"] = [];
-    for (let i = 0; i < args.length; i++) {
-        const [key, value] = parseKeyValue(args[i], alias);
-        if (key === "_") {
-            result["_"].push(formatValue(key, value, boolean, string));
-            continue;
-        }
-        if (value === undefined) {
-            const nextArg = args[i + 1];
-            if (nextArg !== undefined &&
-                !nextArg.startsWith("-") &&
-                !boolean.includes(key)) {
-                result[key] = formatValue(key, nextArg, boolean, string);
-                i++;
-            }
-            else {
-                result[key] = formatValue(key, value, boolean, string);
-            }
-            continue;
-        }
-        result[key] = formatValue(key, value, boolean, string);
-    }
-    return result;
-}

package/dist/utils/assert.js

@@ -1,20 +0,0 @@
-export class AssertionError extends Error {
-    /** Constructs a new instance. */
-    constructor(message) {
-        super(message);
-        this.name = "AssertionError";
-    }
-}
-/** assert(expr, msg) throws AssertionError if expr is falsy. */
-export function assert(expr, msg = "") {
-    if (!expr) {
-        throw new AssertionError(msg);
-    }
-}
-export function assertArrayIncludes(actual, expected, msg) {
-    const actualArr = Array.from(actual);
-    const expectedArr = Array.from(expected);
-    for (const item of expectedArr) {
-        assert(actualArr.includes(item), msg + `\nExpected: ${expectedArr}\nActual: ${actualArr}`);
-    }
-}

package/dist/utils/asyncQueue.js

@@ -1,67 +0,0 @@
-import { nextTick } from "./nextTick.js";
-/**
- * An Async Queue is a queue that can be used to push items to it and then wait
- * for them to be consumed.
- *
- * @example
- * const queue = new AsyncQueue<string>();
- * queue.push("hello");
- * for await (const item of queue) {
- *   console.log(item); // "hello"
- * }
- */
-export class AsyncQueue {
-    queue = [];
-    maxQueueLength = Infinity;
-    nextResolve = (_value) => { };
-    nextReject = (_reason) => { };
-    done = false;
-    hasNext = false;
-    constructor(maxQueueLength) {
-        if (maxQueueLength) {
-            this.maxQueueLength = maxQueueLength;
-        }
-    }
-    async next() {
-        await nextTick();
-        if (this.done && this.queue.length === 0) {
-            return Promise.reject("Closed");
-        }
-        return new Promise((resolve, reject) => {
-            if (this.queue.length > 0) {
-                const item = this.queue.shift();
-                if (item) {
-                    return resolve(item);
-                }
-            }
-            this.nextResolve = resolve;
-            this.nextReject = reject;
-            this.hasNext = true;
-        });
-    }
-    close(reason = "closed") {
-        this.done = true;
-        if (this.hasNext) {
-            this.nextReject(reason);
-        }
-    }
-    async *[Symbol.asyncIterator]() {
-        while (true) {
-            yield this.next();
-        }
-    }
-    push(item) {
-        if (this.hasNext) {
-            this.nextResolve(item);
-            this.hasNext = false;
-            return;
-        }
-        if (this.queue.length > this.maxQueueLength) {
-            this.queue.shift();
-        }
-        this.queue.push(item);
-    }
-    get isDone() {
-        return this.done;
-    }
-}

package/dist/utils/deferred.js

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