abmqtt-dist 0.0.4

package/dist/mqtt.constants.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PacketType = void 0;
+exports.packetTypeToString = packetTypeToString;
+var PacketType;
+(function (PacketType) {
+    PacketType[PacketType["Connect"] = 1] = "Connect";
+    PacketType[PacketType["ConnAck"] = 2] = "ConnAck";
+    PacketType[PacketType["Publish"] = 3] = "Publish";
+    PacketType[PacketType["PubAck"] = 4] = "PubAck";
+    PacketType[PacketType["PubRec"] = 5] = "PubRec";
+    PacketType[PacketType["PubRel"] = 6] = "PubRel";
+    PacketType[PacketType["PubComp"] = 7] = "PubComp";
+    PacketType[PacketType["Subscribe"] = 8] = "Subscribe";
+    PacketType[PacketType["SubAck"] = 9] = "SubAck";
+    PacketType[PacketType["Unsubscribe"] = 10] = "Unsubscribe";
+    PacketType[PacketType["UnsubAck"] = 11] = "UnsubAck";
+    PacketType[PacketType["PingReq"] = 12] = "PingReq";
+    PacketType[PacketType["PingResp"] = 13] = "PingResp";
+    PacketType[PacketType["Disconnect"] = 14] = "Disconnect";
+})(PacketType || (exports.PacketType = PacketType = {}));
+const reverseMapping = Object.fromEntries(Object.entries(PacketType).map(([k, v]) => [v, k]));
+function packetTypeToString(type) {
+    return reverseMapping[type].toUpperCase();
+}
+//# sourceMappingURL=mqtt.constants.js.map

package/dist/mqtt.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.constants.js","sourceRoot":"","sources":["../src/mqtt.constants.ts"],"names":[],"mappings":";;;AAsCA,gDAEC;AAxCD,IAAY,UAeX;AAfD,WAAY,UAAU;IAClB,iDAAW,CAAA;IACX,iDAAO,CAAA;IACP,iDAAO,CAAA;IACP,+CAAM,CAAA;IACN,+CAAM,CAAA;IACN,+CAAM,CAAA;IACN,iDAAO,CAAA;IACP,qDAAS,CAAA;IACT,+CAAM,CAAA;IACN,0DAAW,CAAA;IACX,oDAAQ,CAAA;IACR,kDAAO,CAAA;IACP,oDAAQ,CAAA;IACR,wDAAU,CAAA;AACd,CAAC,EAfW,UAAU,0BAAV,UAAU,QAerB;AAmBD,MAAM,cAAc,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAI9F,SAAgB,kBAAkB,CAAC,IAAgB;IAC/C,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC,WAAW,EAAgB,CAAC;AAC5D,CAAC"}

package/dist/mqtt.listener.d.ts

@@ -0,0 +1,21 @@
+import { MqttMessage } from './mqtt.message';
+import { IncomingListenMessage } from './mqtt.types';
+export declare class MqttListener {
+    private handlers;
+    handleMessage(message: MqttMessage): Promise<void[]>;
+    addHandler<T, Params extends Record<string, string>>(handler: HandlerInfo<T, Params>): RemoveHandlerFn;
+}
+export type RemoveHandlerFn = () => void;
+export type HandlerFn<T = MessageWithParams> = (message: T) => void;
+export type ValidatorFn<Params extends Record<string, string>> = (message: MqttMessage, params: Params) => boolean;
+export type TransformerFn<TOut, Params extends Record<string, string>> = (message: IncomingListenMessage<Params>) => TOut | Promise<TOut>;
+export type MessageWithParams<T extends Record<string, string> = Record<string, string>> = MqttMessage & {
+    params: T;
+};
+export interface HandlerInfo<T, Params extends Record<string, string>> {
+    topicFilter: string;
+    paramMatcher?: string;
+    validator?: ValidatorFn<Params>;
+    transformer?: TransformerFn<T, Params>;
+    handle: HandlerFn<T>;
+}

package/dist/mqtt.listener.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MqttListener = void 0;
+const mqtt_utilities_1 = require("./mqtt.utilities");
+class MqttListener {
+    constructor() {
+        this.handlers = [];
+    }
+    handleMessage(message) {
+        return Promise.all(this.handlers
+            .filter(h => (0, mqtt_utilities_1.matchTopic)(h.topicFilter, message.topic))
+            .map(async (handler) => {
+            const params = handler.paramMatcher ? (0, mqtt_utilities_1.extractParams)(handler.paramMatcher, message.topic) : {};
+            if (handler.validator && !handler.validator(message, params))
+                return;
+            const finalMessage = {
+                ...message,
+                params,
+            };
+            handler.handle(handler.transformer ? await handler.transformer(finalMessage) : finalMessage);
+        }));
+    }
+    addHandler(handler) {
+        this.handlers.push(handler);
+        return () => (this.handlers = this.handlers.filter(x => x !== handler));
+    }
+}
+exports.MqttListener = MqttListener;
+//# sourceMappingURL=mqtt.listener.js.map

package/dist/mqtt.listener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.listener.js","sourceRoot":"","sources":["../src/mqtt.listener.ts"],"names":[],"mappings":";;;AAEA,qDAA6D;AAE7D,MAAa,YAAY;IAAzB;QACY,aAAQ,GAAiC,EAAE,CAAC;IAuBxD,CAAC;IArBU,aAAa,CAAC,OAAoB;QACrC,OAAO,OAAO,CAAC,GAAG,CACd,IAAI,CAAC,QAAQ;aACR,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,2BAAU,EAAC,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;aACrD,GAAG,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;YACjB,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAA,8BAAa,EAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9F,IAAI,OAAO,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;gBAAE,OAAO;YAErE,MAAM,YAAY,GAAG;gBACjB,GAAG,OAAO;gBACV,MAAM;aACT,CAAC;YACF,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QACjG,CAAC,CAAC,CACT,CAAC;IACN,CAAC;IAEM,UAAU,CAA2C,OAA+B;QACvF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC;IAC5E,CAAC;CACJ;AAxBD,oCAwBC"}

package/dist/mqtt.message.d.ts

@@ -0,0 +1,14 @@
+export interface MqttMessage {
+    topic: string;
+    payload: Buffer;
+    retained?: boolean;
+    duplicate?: boolean;
+    qosLevel?: number;
+}
+export interface MqttMessageOutgoing {
+    topic: string;
+    retained?: boolean;
+    duplicate?: boolean;
+    qosLevel?: number;
+    payload: Buffer | string;
+}

package/dist/mqtt.message.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mqtt.message.js.map

package/dist/mqtt.message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.message.js","sourceRoot":"","sources":["../src/mqtt.message.ts"],"names":[],"mappings":""}

package/dist/mqtt.packet.d.ts

@@ -0,0 +1,9 @@
+export declare class IdentifierPacket {
+    readonly identifier: number;
+    constructor(identifier: number);
+}
+export interface PacketWriteResult {
+    flags?: number;
+    identifier?: number;
+}
+export declare function generateIdentifier(): number;

package/dist/mqtt.packet.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdentifierPacket = void 0;
+exports.generateIdentifier = generateIdentifier;
+class IdentifierPacket {
+    constructor(identifier) {
+        this.identifier = identifier;
+    }
+}
+exports.IdentifierPacket = IdentifierPacket;
+let _lastId = 0;
+function generateIdentifier() {
+    return (_lastId = (_lastId + 1) & 0xffff);
+}
+//# sourceMappingURL=mqtt.packet.js.map

package/dist/mqtt.packet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.packet.js","sourceRoot":"","sources":["../src/mqtt.packet.ts"],"names":[],"mappings":";;;AAUA,gDAEC;AAZD,MAAa,gBAAgB;IACzB,YAA4B,UAAkB;QAAlB,eAAU,GAAV,UAAU,CAAQ;IAAG,CAAC;CACrD;AAFD,4CAEC;AAOD,IAAI,OAAO,GAAG,CAAC,CAAC;AAChB,SAAgB,kBAAkB;IAC9B,OAAO,CAAC,OAAO,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;AAC9C,CAAC"}

package/dist/mqtt.parser.d.ts

@@ -0,0 +1,21 @@
+import { PacketType } from './mqtt.constants';
+import { Transform, TransformCallback } from 'stream';
+import { Debugger } from 'debug';
+import { DefaultPacketReadResultMap, PacketReadMap, PacketReadResultMap } from './packets/packet-reader';
+export interface MqttParseResult<ReadMap extends PacketReadResultMap, T extends PacketType> {
+    type: T;
+    flags: number;
+    data: ReadMap[T];
+}
+export interface MqttTransformerOptions<T extends PacketReadResultMap = DefaultPacketReadResultMap> {
+    debug?: Debugger;
+    mapping?: PacketReadMap<T>;
+}
+export declare class MqttTransformer<ReadMap extends PacketReadResultMap = DefaultPacketReadResultMap> extends Transform {
+    options: MqttTransformerOptions<ReadMap>;
+    mapping: PacketReadMap<ReadMap>;
+    private internalStream;
+    constructor(options?: MqttTransformerOptions<ReadMap>);
+    _transform(chunk: Buffer, encoding: string, callback: TransformCallback): void;
+    reset(): void;
+}

package/dist/mqtt.parser.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MqttTransformer = void 0;
+const mqtt_constants_1 = require("./mqtt.constants");
+const packet_stream_1 = require("./packet-stream");
+const errors_1 = require("./errors");
+const stream_1 = require("stream");
+const packet_reader_1 = require("./packets/packet-reader");
+class MqttTransformer extends stream_1.Transform {
+    constructor(options = {}) {
+        super({ objectMode: true });
+        this.options = options;
+        // force the type here
+        this.mapping = packet_reader_1.DefaultPacketReadMap;
+        this.internalStream = undefined;
+        this.mapping = {
+            ...this.mapping,
+            ...options.mapping,
+        };
+    }
+    _transform(chunk, encoding, callback) {
+        if (!Buffer.isBuffer(chunk)) {
+            callback(new Error('Expected a Buffer'));
+            return;
+        }
+        const stream = this.internalStream ? this.internalStream.write(chunk, false) : packet_stream_1.PacketStream.fromBuffer(chunk);
+        this.internalStream = undefined;
+        let startPos = 0;
+        while (stream.remainingBytes > 0) {
+            const firstByte = stream.readByte();
+            const type = (firstByte >> 4);
+            const flags = firstByte & 0x0f;
+            const packetFn = this.mapping[type];
+            if (!packetFn) {
+                callback(new errors_1.UnexpectedPacketError(`No packet found for ${type}; @${stream.position - 1} len: ${stream.length}`));
+                return;
+            }
+            let remainingLength = -1;
+            try {
+                remainingLength = stream.readVariableByteInteger();
+                const packet = packetFn(stream, remainingLength, flags);
+                this.push({
+                    type,
+                    data: packet,
+                    flags,
+                });
+                stream.cut();
+                startPos = stream.position;
+            }
+            catch (e) {
+                if (e instanceof errors_1.EndOfStreamError) {
+                    this.options.debug?.(`EOS:\n  ${remainingLength} got: ${stream.length} (+) ${chunk.byteLength};\n  return: ${startPos};`);
+                    stream.position = startPos;
+                    this.internalStream = stream.cut();
+                    callback();
+                    return;
+                }
+                else {
+                    callback(new errors_1.MalformedPacketError(`Error in parser (type: ${(0, mqtt_constants_1.packetTypeToString)(type)}): ${e instanceof Error ? e.message : e} - stream: ${stream.data.toString('base64')}`));
+                    return;
+                }
+            }
+        }
+        callback();
+    }
+    reset() {
+        this.internalStream = undefined;
+    }
+}
+exports.MqttTransformer = MqttTransformer;
+//# sourceMappingURL=mqtt.parser.js.map

package/dist/mqtt.parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.parser.js","sourceRoot":"","sources":["../src/mqtt.parser.ts"],"names":[],"mappings":";;;AAAA,qDAAkE;AAClE,mDAA+C;AAC/C,qCAAyF;AACzF,mCAAsD;AAEtD,2DAKiC;AAajC,MAAa,eAAkF,SAAQ,kBAAS;IAM5G,YAAmB,UAA2C,EAAE;QAC5D,KAAK,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QADb,YAAO,GAAP,OAAO,CAAsC;QALhE,sBAAsB;QACf,YAAO,GAA2B,oCAA8C,CAAC;QAEhF,mBAAc,GAA6B,SAAS,CAAC;QAIzD,IAAI,CAAC,OAAO,GAAG;YACX,GAAG,IAAI,CAAC,OAAO;YACf,GAAG,OAAO,CAAC,OAAO;SACrB,CAAC;IACN,CAAC;IAED,UAAU,CAAC,KAAa,EAAE,QAAgB,EAAE,QAA2B;QACnE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;YACzC,OAAO;QACX,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,4BAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC9G,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAEhC,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,OAAO,MAAM,CAAC,cAAc,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpC,MAAM,IAAI,GAAG,CAAC,SAAS,IAAI,CAAC,CAAe,CAAC;YAC5C,MAAM,KAAK,GAAG,SAAS,GAAG,IAAI,CAAC;YAE/B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACZ,QAAQ,CACJ,IAAI,8BAAqB,CACrB,uBAAuB,IAAI,MAAM,MAAM,CAAC,QAAQ,GAAG,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAC/E,CACJ,CAAC;gBACF,OAAO;YACX,CAAC;YACD,IAAI,eAAe,GAAG,CAAC,CAAC,CAAC;YACzB,IAAI,CAAC;gBACD,eAAe,GAAG,MAAM,CAAC,uBAAuB,EAAE,CAAC;gBACnD,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;gBACxD,IAAI,CAAC,IAAI,CAAC;oBACN,IAAI;oBACJ,IAAI,EAAE,MAAM;oBACZ,KAAK;iBACR,CAAC,CAAC;gBACH,MAAM,CAAC,GAAG,EAAE,CAAC;gBACb,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;YAC/B,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,IAAI,CAAC,YAAY,yBAAgB,EAAE,CAAC;oBAChC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAChB,WAAW,eAAe,SAAS,MAAM,CAAC,MAAM,QAAQ,KAAK,CAAC,UAAU,gBAAgB,QAAQ,GAAG,CACtG,CAAC;oBACF,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAC3B,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC;oBACnC,QAAQ,EAAE,CAAC;oBACX,OAAO;gBACX,CAAC;qBAAM,CAAC;oBACJ,QAAQ,CACJ,IAAI,6BAAoB,CACpB,0BAA0B,IAAA,mCAAkB,EAAC,IAAI,CAAC,MAC9C,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CACrC,cAAc,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CACjD,CACJ,CAAC;oBACF,OAAO;gBACX,CAAC;YACL,CAAC;QACL,CAAC;QACD,QAAQ,EAAE,CAAC;IACf,CAAC;IAEM,KAAK;QACR,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;IACpC,CAAC;CACJ;AA5ED,0CA4EC"}

package/dist/mqtt.types.d.ts

@@ -0,0 +1,52 @@
+import { ConnectRequestOptions } from './packets';
+import { MqttTransformer } from './mqtt.parser';
+import { Transport } from './transport';
+import { XOR } from 'ts-xor';
+import { MqttMessage } from './mqtt.message';
+import { DefaultPacketReadResultMap, PacketReadMap, PacketReadResultMap, DefaultPacketWriteOptions, PacketWriteMap, PacketWriteOptionsMap, PacketWriter } from './packets';
+import { TransformerFn, ValidatorFn } from './mqtt.listener';
+import { MqttsReconnectStrategy } from './reconnect-strategy';
+export type MqttClientConstructorOptions<ReadMap extends PacketReadResultMap = DefaultPacketReadResultMap, WriteMap extends PacketWriteOptionsMap = DefaultPacketWriteOptions> = XOR<{
+    transport: Transport<unknown>;
+}, {
+    host: string;
+    port: number;
+    enableTrace?: boolean;
+}> & {
+    readMap?: PacketReadMap<ReadMap>;
+    createTransformer?: () => MqttTransformer<ReadMap>;
+    writeMap?: PacketWriteMap<WriteMap>;
+    packetWriter?: PacketWriter<WriteMap>;
+    autoReconnect?: MqttsReconnectStrategy | boolean;
+};
+export interface MqttSubscription {
+    topic: string;
+    qosLevel?: number;
+}
+export type RegisterClientOptions = ConnectRequestOptions;
+export type TimerRef = any;
+export type ExecutePeriodically = (timeInMs: number, action: () => void) => TimerRef;
+export type ExecuteDelayed = (timeInMs: number, action: () => void) => TimerRef;
+export type StopExecuting = (ref: TimerRef) => void;
+export type AsyncLike<TIn, TOut> = (data: TIn) => TOut | PromiseLike<TOut>;
+export interface ListenerInfo<TIn, TOut> {
+    eventName: string;
+    validator: (data: TIn) => boolean | PromiseLike<boolean>;
+    transformer?: (data: TIn) => TOut | PromiseLike<TOut>;
+    onData: (data: TOut) => void | PromiseLike<void>;
+}
+export interface ListenOptions<TOut, Params extends Record<string, string>> {
+    topic: string;
+    validator?: ValidatorFn<Params>;
+    transformer?: TransformerFn<TOut, Params>;
+}
+export interface ListenSubscribeOptions<TOut, Params extends Record<string, string>> extends ListenOptions<TOut, Params> {
+    subscriptionInfo?: Partial<MqttSubscription>;
+}
+export interface IncomingListenMessage<T extends Record<string, string> = Record<string, string>> extends MqttMessage {
+    params?: T;
+}
+export type Resolvable<T extends Record<string, unknown>> = (() => Promise<T>) | (() => T) | T;
+export interface IdentifierData {
+    identifier: number;
+}

package/dist/mqtt.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mqtt.types.js.map

package/dist/mqtt.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.types.js","sourceRoot":"","sources":["../src/mqtt.types.ts"],"names":[],"mappings":""}

package/dist/mqtt.utilities.d.ts

@@ -0,0 +1,32 @@
+import { Resolvable } from './mqtt.types';
+import { ConnectResponsePacket, PingResponsePacket, PublishAckPacket, PublishCompletePacket, PublishReceivedPacket, PublishReleasePacket, PublishRequestPacket, SubscribeResponsePacket, UnsubscribeResponsePacket } from './packets';
+import { PacketType } from './mqtt.constants';
+export declare function matchTopic(baseTopic: string, incomingTopic: string): boolean;
+export declare function expectRemainingLength(length: number, expected?: number): void;
+export declare function removeUntil(input: string, char: string): string;
+export declare function extractParams(template: string, topic: string): Record<string, string>;
+export interface Resolvers<T> {
+    resolve: (value: T) => void;
+    reject: (error: Error) => void;
+}
+export declare const nullOrUndefined: (input: unknown) => input is null | undefined;
+export declare const isConnAck: (target: unknown) => target is ConnectResponsePacket;
+export declare const isPublish: (target: unknown) => target is PublishRequestPacket;
+export declare const isPubAck: (target: unknown) => target is PublishAckPacket;
+export declare const isPubRec: (target: unknown) => target is PublishReceivedPacket;
+export declare const isPubRel: (target: unknown) => target is PublishReleasePacket;
+export declare const isPubComp: (target: unknown) => target is PublishCompletePacket;
+export declare const isSubAck: (target: unknown) => target is SubscribeResponsePacket;
+export declare const isUnsubAck: (target: unknown) => target is UnsubscribeResponsePacket;
+export declare const isPingResp: (target: unknown) => target is PingResponsePacket;
+export declare function resolve<T extends Record<string, unknown>>(resolvable: Resolvable<T>): Promise<T>;
+export declare function notUndefined<T>(value: T | undefined): value is T;
+export declare function toBuffer(value: Buffer | string): Buffer;
+export declare function toMqttTopicFilter(paramString: string): [string, string?];
+export declare function createDefaultPacketLogger(debug: (data: string) => void): (packetType: PacketType, packetInfo: Record<string, string | number | boolean | undefined>) => void;
+export declare function stringifyObject(obj: Record<string, unknown>): string;
+export declare function createFlowCounter(): {
+    next(): number;
+} | {
+    next(): bigint;
+};

package/dist/mqtt.utilities.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPingResp = exports.isUnsubAck = exports.isSubAck = exports.isPubComp = exports.isPubRel = exports.isPubRec = exports.isPubAck = exports.isPublish = exports.isConnAck = exports.nullOrUndefined = void 0;
+exports.matchTopic = matchTopic;
+exports.expectRemainingLength = expectRemainingLength;
+exports.removeUntil = removeUntil;
+exports.extractParams = extractParams;
+exports.resolve = resolve;
+exports.notUndefined = notUndefined;
+exports.toBuffer = toBuffer;
+exports.toMqttTopicFilter = toMqttTopicFilter;
+exports.createDefaultPacketLogger = createDefaultPacketLogger;
+exports.stringifyObject = stringifyObject;
+exports.createFlowCounter = createFlowCounter;
+const packets_1 = require("./packets");
+const mqtt_constants_1 = require("./mqtt.constants");
+function matchTopic(baseTopic, incomingTopic) {
+    if (baseTopic.length === incomingTopic.length && baseTopic === incomingTopic)
+        return true;
+    const parts = baseTopic.split('+');
+    let remaining = incomingTopic;
+    for (const part of parts) {
+        if (!remaining.startsWith(part)) {
+            return false;
+        }
+        remaining = removeUntil(remaining.substring(part.length), '/');
+    }
+    return true;
+}
+function expectRemainingLength(length, expected) {
+    if (!expected) {
+        expected = 0;
+    }
+    if (length !== expected) {
+        throw new Error(`Expected remaining length to be ${expected} but got ${length}`);
+    }
+}
+function removeUntil(input, char) {
+    return input.substring(Math.max(input.indexOf(char), 0));
+}
+function extractParams(template, topic) {
+    const templateParts = template.split('/');
+    const topicParts = topic.split('/');
+    const params = {};
+    for (let i = 0; i < Math.min(templateParts.length, topicParts.length); i++) {
+        if (templateParts[i].startsWith(':')) {
+            params[templateParts[i].substring(1)] = topicParts[i];
+        }
+    }
+    return params;
+}
+const nullOrUndefined = (input) => input == undefined;
+exports.nullOrUndefined = nullOrUndefined;
+const isConnAck = (target) => target instanceof packets_1.ConnectResponsePacket;
+exports.isConnAck = isConnAck;
+const isPublish = (target) => target instanceof packets_1.PublishRequestPacket;
+exports.isPublish = isPublish;
+const isPubAck = (target) => target instanceof packets_1.PublishAckPacket;
+exports.isPubAck = isPubAck;
+const isPubRec = (target) => target instanceof packets_1.PublishReceivedPacket;
+exports.isPubRec = isPubRec;
+const isPubRel = (target) => target instanceof packets_1.PublishReleasePacket;
+exports.isPubRel = isPubRel;
+const isPubComp = (target) => target instanceof packets_1.PublishCompletePacket;
+exports.isPubComp = isPubComp;
+const isSubAck = (target) => target instanceof packets_1.SubscribeResponsePacket;
+exports.isSubAck = isSubAck;
+const isUnsubAck = (target) => target instanceof packets_1.UnsubscribeResponsePacket;
+exports.isUnsubAck = isUnsubAck;
+const isPingResp = (target) => target instanceof packets_1.PingResponsePacket;
+exports.isPingResp = isPingResp;
+async function resolve(resolvable) {
+    return typeof resolvable === 'object' ? resolvable : await resolvable();
+}
+function notUndefined(value) {
+    return typeof value !== 'undefined';
+}
+function toBuffer(value) {
+    return typeof value === 'string' ? Buffer.from(value) : value;
+}
+const paramRegex = /\/:[A-Za-z-_0-9]+/g;
+function toMqttTopicFilter(paramString) {
+    if (paramString.match(paramRegex)) {
+        return [paramString.replace(paramRegex, '/+'), paramString];
+    }
+    return [paramString];
+}
+function createDefaultPacketLogger(debug) {
+    return (packetType, packetInfo) => {
+        if (packetType !== mqtt_constants_1.PacketType.PingReq && packetType !== mqtt_constants_1.PacketType.PingResp) {
+            debug(`Write ${(0, mqtt_constants_1.packetTypeToString)(packetType)} ${stringifyObject(packetInfo)}`);
+        }
+    };
+}
+function stringifyObject(obj) {
+    return `${obj.constructor === Object ? '' : `${obj.constructor.name} `}{${Object.entries(obj)
+        .filter(([, v]) => typeof v !== 'undefined')
+        .map(([k, v]) => `${k}: ${stringifyValue(v)}`)
+        .join(', ')}}`;
+}
+function stringifyValue(value) {
+    if (typeof value === 'object') {
+        if (value === null) {
+            return '<null>';
+        }
+        else if (Array.isArray(value)) {
+            return `<Array { len: ${value.length}}>`;
+        }
+        else if (Buffer.isBuffer(value)) {
+            return `<Buffer { bytes: ${value.byteLength}}>`;
+        }
+        else if (value.constructor !== Object) {
+            return `<${value.constructor.name}>`;
+        }
+        else {
+            return '{...}';
+        }
+    }
+    else {
+        return typeof value === 'string' ? `"${value}"` : String(value);
+    }
+}
+function createFlowCounter() {
+    if (!globalThis.BigInt) {
+        let count = 0;
+        return {
+            next() {
+                return ++count;
+            },
+        };
+    }
+    let count = BigInt(0);
+    return {
+        next() {
+            return (count += BigInt(1));
+        },
+    };
+}
+//# sourceMappingURL=mqtt.utilities.js.map

package/dist/mqtt.utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.utilities.js","sourceRoot":"","sources":["../src/mqtt.utilities.ts"],"names":[],"mappings":";;;AAcA,gCAWC;AAED,sDAOC;AAED,kCAEC;AAED,sCAUC;AAqBD,0BAEC;AAED,oCAEC;AAED,4BAEC;AAGD,8CAKC;AAED,8DAMC;AAED,0CAKC;AAoBD,8CAeC;AA1ID,uCAUmB;AACnB,qDAAkE;AAElE,SAAgB,UAAU,CAAC,SAAiB,EAAE,aAAqB;IAC/D,IAAI,SAAS,CAAC,MAAM,KAAK,aAAa,CAAC,MAAM,IAAI,SAAS,KAAK,aAAa;QAAE,OAAO,IAAI,CAAC;IAC1F,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,IAAI,SAAS,GAAG,aAAa,CAAC;IAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAgB,qBAAqB,CAAC,MAAc,EAAE,QAAiB;IACnE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,QAAQ,GAAG,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,YAAY,MAAM,EAAE,CAAC,CAAC;IACrF,CAAC;AACL,CAAC;AAED,SAAgB,WAAW,CAAC,KAAa,EAAE,IAAY;IACnD,OAAO,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC7D,CAAC;AAED,SAAgB,aAAa,CAAC,QAAgB,EAAE,KAAa;IACzD,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACzE,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC1D,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAOM,MAAM,eAAe,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,IAAI,SAAS,CAAC;AAAzD,QAAA,eAAe,mBAA0C;AAE/D,MAAM,SAAS,GAAG,CAAC,MAAe,EAAmC,EAAE,CAAC,MAAM,YAAY,+BAAqB,CAAC;AAA1G,QAAA,SAAS,aAAiG;AAChH,MAAM,SAAS,GAAG,CAAC,MAAe,EAAkC,EAAE,CAAC,MAAM,YAAY,8BAAoB,CAAC;AAAxG,QAAA,SAAS,aAA+F;AAC9G,MAAM,QAAQ,GAAG,CAAC,MAAe,EAA8B,EAAE,CAAC,MAAM,YAAY,0BAAgB,CAAC;AAA/F,QAAA,QAAQ,YAAuF;AACrG,MAAM,QAAQ,GAAG,CAAC,MAAe,EAAmC,EAAE,CAAC,MAAM,YAAY,+BAAqB,CAAC;AAAzG,QAAA,QAAQ,YAAiG;AAC/G,MAAM,QAAQ,GAAG,CAAC,MAAe,EAAkC,EAAE,CAAC,MAAM,YAAY,8BAAoB,CAAC;AAAvG,QAAA,QAAQ,YAA+F;AAC7G,MAAM,SAAS,GAAG,CAAC,MAAe,EAAmC,EAAE,CAAC,MAAM,YAAY,+BAAqB,CAAC;AAA1G,QAAA,SAAS,aAAiG;AAChH,MAAM,QAAQ,GAAG,CAAC,MAAe,EAAqC,EAAE,CAC3E,MAAM,YAAY,iCAAuB,CAAC;AADjC,QAAA,QAAQ,YACyB;AACvC,MAAM,UAAU,GAAG,CAAC,MAAe,EAAuC,EAAE,CAC/E,MAAM,YAAY,mCAAyB,CAAC;AADnC,QAAA,UAAU,cACyB;AACzC,MAAM,UAAU,GAAG,CAAC,MAAe,EAAgC,EAAE,CAAC,MAAM,YAAY,4BAAkB,CAAC;AAArG,QAAA,UAAU,cAA2F;AAE3G,KAAK,UAAU,OAAO,CAAoC,UAAyB;IACtF,OAAO,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,UAAU,EAAE,CAAC;AAC5E,CAAC;AAED,SAAgB,YAAY,CAAI,KAAoB;IAChD,OAAO,OAAO,KAAK,KAAK,WAAW,CAAC;AACxC,CAAC;AAED,SAAgB,QAAQ,CAAC,KAAsB;IAC3C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,GAAG,oBAAoB,CAAC;AACxC,SAAgB,iBAAiB,CAAC,WAAmB;IACjD,IAAI,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,CAAC,WAAW,CAAC,CAAC;AACzB,CAAC;AAED,SAAgB,yBAAyB,CAAC,KAA6B;IACnE,OAAO,CAAC,UAAsB,EAAE,UAAiE,EAAE,EAAE;QACjG,IAAI,UAAU,KAAK,2BAAU,CAAC,OAAO,IAAI,UAAU,KAAK,2BAAU,CAAC,QAAQ,EAAE,CAAC;YAC1E,KAAK,CAAC,SAAS,IAAA,mCAAkB,EAAC,UAAU,CAAC,IAAI,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACpF,CAAC;IACL,CAAC,CAAC;AACN,CAAC;AAED,SAAgB,eAAe,CAAC,GAA4B;IACxD,OAAO,GAAG,GAAG,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;SACxF,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,WAAW,CAAC;SAC3C,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;SAC7C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AACvB,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,QAAQ,CAAC;QACpB,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAO,iBAAiB,KAAK,CAAC,MAAM,IAAI,CAAC;QAC7C,CAAC;aAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,oBAAoB,KAAK,CAAC,UAAU,IAAI,CAAC;QACpD,CAAC;aAAM,IAAI,KAAK,CAAC,WAAW,KAAK,MAAM,EAAE,CAAC;YACtC,OAAO,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC;QACzC,CAAC;aAAM,CAAC;YACJ,OAAO,OAAO,CAAC;QACnB,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC;AACL,CAAC;AAED,SAAgB,iBAAiB;IAC7B,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QACrB,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,OAAO;YACH,IAAI;gBACA,OAAO,EAAE,KAAK,CAAC;YACnB,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACtB,OAAO;QACH,IAAI;YACA,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;KACJ,CAAC;AACN,CAAC"}

package/dist/packet-stream.d.ts

@@ -0,0 +1,37 @@
+export declare class PacketStream {
+    set position(value: number);
+    get position(): number;
+    get data(): Buffer;
+    get length(): number;
+    get remainingBytes(): number;
+    private _data;
+    private _position;
+    private constructor();
+    static fromLength(len: number): PacketStream;
+    static fromBuffer(buf: Buffer): PacketStream;
+    static fromString(data: string): PacketStream;
+    static empty(): PacketStream;
+    static fromHex(hex: string): PacketStream;
+    /**
+     *
+     * @param {number} steps - steps to move
+     * @returns {number} Position before moving
+     */
+    private move;
+    seek(len: number): this;
+    cut(): this;
+    write(data: Buffer, move?: boolean): this;
+    writeRawString(data: string): this;
+    writeByte(num: number): this;
+    writeWord(num: number): this;
+    writeString(str: string): this;
+    writeRawAndLength(data: Buffer): this;
+    writeVariableByteInteger(value: number): this;
+    read(len: number): Buffer;
+    readSlice(end: number): Buffer<ArrayBuffer>;
+    readByte(): number;
+    readWord(): number;
+    readString(): string;
+    readStringAsBuffer(): Buffer;
+    readVariableByteInteger(): number;
+}