@seriousme/opifex 1.11.2 → 2.0.3

package/dist/utils/topicFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"topicFilter.d.ts","sourceRoot":"","sources":["../../utils/topicFilter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAS/D;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG;IACrD,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB,CAWA;AAED,sCAAsC;AACtC,wBAAgB,eAAe,CAC7B,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,GAChB,MAAM,CAKR"}

package/dist/utils/topicFilter.js

@@ -0,0 +1,52 @@
+/**
+ * Converts an MQTT topic filter into a regular expression according to the MQTT specification.
+ *
+ * This utility escapes standard regex characters to prevent injection or unexpected behavior,
+ * and then converts the native MQTT wildcards into their regex equivalents:
+ * - `+` (single-level wildcard) becomes `[^/]+` (matches one or more characters except a forward slash)
+ * - `#` (multi-level wildcard) becomes an optional matching group `(?:/.*)?` to correctly handle parent levels.
+ *
+ * @param topicFilter - The MQTT topic filter string to convert (e.g., "home/+/temperature" or "clients/#").
+ * @returns A `RegExp` object configured to match topics corresponding to the filter.
+ *
+ * @example
+ * ```typescript
+ * const regex = topicFilterToRegExp("home/+/temperature");
+ * regex.test("home/livingroom/temperature"); // true
+ * regex.test("home/kitchen/lights");        // false
+ * ```
+ */
+export function topicFilterToRegExp(topicFilter) {
+    // RegExp.escape (ES2024+) safely escapes special characters, forcing punctuation into hex formats (\xHH)
+    const escaped = RegExp.escape(topicFilter);
+    const regexStr = escaped
+        .replace(/\\\+/g, "[^/]+") // Replace '+' wildcard globally
+        .replace(/(?:\\\/)?\\x23/g, "(?:/.*)?"); // Replace '#' and its optional preceding slash (\/) globally
+    return new RegExp(`^${regexStr}$`);
+}
+/**
+ * Parses a Topic filter for a "shared subscription" into the share name and the regular Topic Filter
+ *
+ * @param topicFilter - The MQTT topic filter string to parse (e.g. "$share/sharename/rest/of/topic/filter")).
+ * @returns an object that contains the regular topicFilter and he share name (if present)
+ */
+export function parseTopicFilter(topicFilter) {
+    if (topicFilter.startsWith("$share/")) {
+        const nextSlashIndex = topicFilter.indexOf("/", 7);
+        if (nextSlashIndex !== -1) {
+            return {
+                topicFilter: topicFilter.slice(nextSlashIndex + 1),
+                shareName: topicFilter.slice(7, nextSlashIndex),
+            };
+        }
+    }
+    return { topicFilter, shareName: "" };
+}
+/** the inverse of parseTopicFilter */
+export function joinTopicFilter(topicFilter, shareName) {
+    if (shareName !== "") {
+        return `$share/${shareName}/${topicFilter}`;
+    }
+    return topicFilter;
+}
+//# sourceMappingURL=topicFilter.js.map

package/dist/utils/topicFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"topicFilter.js","sourceRoot":"","sources":["../../utils/topicFilter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,mBAAmB,CAAC,WAAmB;IACrD,yGAAyG;IACzG,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAE3C,MAAM,QAAQ,GAAG,OAAO;SACrB,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,gCAAgC;SAC1D,OAAO,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC,CAAC,6DAA6D;IAExG,OAAO,IAAI,MAAM,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,WAAmB;IAIlD,IAAI,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QACtC,MAAM,cAAc,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACnD,IAAI,cAAc,KAAK,CAAC,CAAC,EAAE,CAAC;YAC1B,OAAO;gBACL,WAAW,EAAE,WAAW,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC;gBAClD,SAAS,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC;aAChD,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;AACxC,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,eAAe,CAC7B,WAAmB,EACnB,SAAiB;IAEjB,IAAI,SAAS,KAAK,EAAE,EAAE,CAAC;QACrB,OAAO,UAAU,SAAS,IAAI,WAAW,EAAE,CAAC;IAC9C,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/utils/utils.d.ts

@@ -1,2 +1,4 @@
+import { setTimeout as delay } from "node:timers/promises";
+export { delay };
 export declare const noop: () => void;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../utils/utils.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,IAAI,YAAW,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../utils/utils.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,IAAI,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,CAAC;AAEjB,eAAO,MAAM,IAAI,YAAW,CAAC"}

package/dist/utils/utils.js

@@ -2,5 +2,7 @@
  * This file contains utilities used throughout the project too small to
  * deserve their own dedicated files.
  */
+import { setTimeout as delay } from "node:timers/promises";
+export { delay };
 export const noop = () => { };
 //# sourceMappingURL=utils.js.map

package/dist/utils/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../utils/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../utils/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,IAAI,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,CAAC;AAEjB,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC"}

package/dist/utils/validators.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Checks for too many topic levels to reduce the risk of Denial of Service
+ *
+ * @param value - The string to validate.
+ * @returns `true` if the string contains more / signs than allowed`.
+ */
+export declare function invalidmaxTopicLevels(value: string, maxTopicLevels: number): boolean;
+/**
+ * Checks for invalid characters in an MQTT topic name.
+ * It cannot contain wildcards (+, #)
+ *
+ * @param value - The topic name to validate.
+ * @returns `true` if the topic is invalid, otherwise `false`.
+ */
+export declare function invalidTopic(value: string): boolean;
+/**
+ * Checks for MQTT wildcards in a string.
+ *
+ * @param value - The topic name to validate.
+ * @returns `true` if the topic is invalid, otherwise `false`.
+ */
+export declare function hasWildcards(value: string): boolean;
+/**
+ * Checks for invalid characters and malformed wildcards in an MQTT topic filter.
+ *
+ * Wildcard rules according to the MQTT specification:
+ * - '+' must occupy an entire level (e.g., 'a/+/b' is valid, 'a+/b' is invalid)
+ * - '#' must only appear at the very end of the string (e.g., 'a/#' is valid, 'a/#/b' is invalid)
+ *
+ * @param value - The topic filter to validate.
+ * @returns `true` if the topic filter is invalid, otherwise `false`.
+ */
+export declare function invalidTopicFilter(value: string): boolean;
+//# sourceMappingURL=validators.d.ts.map

package/dist/utils/validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../../utils/validators.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,EACb,cAAc,EAAE,MAAM,GACrB,OAAO,CAST;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAGnD;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAczD"}

package/dist/utils/validators.js

@@ -0,0 +1,61 @@
+/**
+ * Checks for too many topic levels to reduce the risk of Denial of Service
+ *
+ * @param value - The string to validate.
+ * @returns `true` if the string contains more / signs than allowed`.
+ */
+export function invalidmaxTopicLevels(value, maxTopicLevels) {
+    let slashCount = 0;
+    for (const char of value) {
+        if (char === "/") {
+            slashCount++;
+            if (slashCount >= maxTopicLevels)
+                return true;
+        }
+    }
+    return false;
+}
+/**
+ * Checks for invalid characters in an MQTT topic name.
+ * It cannot contain wildcards (+, #)
+ *
+ * @param value - The topic name to validate.
+ * @returns `true` if the topic is invalid, otherwise `false`.
+ */
+export function invalidTopic(value) {
+    return hasWildcards(value);
+}
+/**
+ * Checks for MQTT wildcards in a string.
+ *
+ * @param value - The topic name to validate.
+ * @returns `true` if the topic is invalid, otherwise `false`.
+ */
+export function hasWildcards(value) {
+    // Native .includes() is significantly faster than regular expressions for basic character checks
+    return value.includes("+") || value.includes("#");
+}
+/**
+ * Checks for invalid characters and malformed wildcards in an MQTT topic filter.
+ *
+ * Wildcard rules according to the MQTT specification:
+ * - '+' must occupy an entire level (e.g., 'a/+/b' is valid, 'a+/b' is invalid)
+ * - '#' must only appear at the very end of the string (e.g., 'a/#' is valid, 'a/#/b' is invalid)
+ *
+ * @param value - The topic filter to validate.
+ * @returns `true` if the topic filter is invalid, otherwise `false`.
+ */
+export function invalidTopicFilter(value) {
+    // Rule 1: A '#' wildcard must NEVER be followed by any other character
+    if (/#./.test(value)) {
+        return true;
+    }
+    // Rule 2: A '+' wildcard must be isolated by slashes (or string boundaries).
+    // Modern lookbehind (?<=) and lookahead (?=) make this highly readable.
+    const malformedPlus = /(?<=[^\/])\+|\+(?=[^\/])/.test(value);
+    if (malformedPlus) {
+        return true;
+    }
+    return false;
+}
+//# sourceMappingURL=validators.js.map

package/dist/utils/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../utils/validators.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,KAAa,EACb,cAAsB;IAEtB,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjB,UAAU,EAAE,CAAC;YACb,IAAI,UAAU,IAAI,cAAc;gBAAE,OAAO,IAAI,CAAC;QAChD,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,iGAAiG;IACjG,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC9C,uEAAuE;IACvE,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6EAA6E;IAC7E,wEAAwE;IACxE,MAAM,aAAa,GAAG,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7D,IAAI,aAAa,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/web/webSocketStream.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Utility functions for wrapping standard WebSockets into standard web streams.
+ */
+export interface WebSocketConnection<T extends Uint8Array | string = Uint8Array | string> {
+    readable: ReadableStream<T>;
+    writable: WritableStream<T>;
+    protocol: string;
+    extensions: string;
+}
+export interface WebSocketCloseInfo {
+    closeCode?: number;
+    reason?: string;
+}
+export interface WebSocketStreamOptions {
+    protocols?: string[];
+    signal?: AbortSignal;
+}
+/**
+ * [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) with [Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API)
+ *
+ * @see https://web.dev/websocketstream/
+ */
+export declare class WebSocketStream<T extends Uint8Array | string = Uint8Array | string> {
+    readonly opened: Promise<WebSocketConnection<T>>;
+    readonly closed: Promise<WebSocketCloseInfo>;
+    readonly close: (closeInfo?: WebSocketCloseInfo) => void;
+    constructor(ws: WebSocket, options?: WebSocketStreamOptions);
+}
+//# sourceMappingURL=webSocketStream.d.ts.map

package/dist/web/webSocketStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webSocketStream.d.ts","sourceRoot":"","sources":["../../web/webSocketStream.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,UAAU,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM;IAEnD,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IAC5B,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,eAAe,CAC1B,CAAC,SAAS,UAAU,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM;IAEnD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE7C,QAAQ,CAAC,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAEzD,YAAY,EAAE,EAAE,SAAS,EAAE,OAAO,GAAE,sBAA2B,EA0D9D;CACF"}

package/dist/web/webSocketStream.js

@@ -0,0 +1,69 @@
+/**
+ * Utility functions for wrapping standard WebSockets into standard web streams.
+ */
+/**
+ * [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) with [Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API)
+ *
+ * @see https://web.dev/websocketstream/
+ */
+export class WebSocketStream {
+    opened;
+    closed;
+    close;
+    constructor(ws, options = {}) {
+        if (options.signal?.aborted) {
+            throw new DOMException("This operation was aborted", "AbortError");
+        }
+        const closeWithInfo = ({ closeCode: code, reason } = {}) => ws.close(code, reason);
+        this.opened = new Promise((resolve, reject) => {
+            ws.onopen = () => {
+                resolve({
+                    readable: new ReadableStream({
+                        start(controller) {
+                            ws.onmessage = ({ data }) => {
+                                if (data instanceof ArrayBuffer) {
+                                    controller.enqueue(new Uint8Array(data));
+                                }
+                                else {
+                                    controller.enqueue(data);
+                                }
+                            };
+                            ws.onerror = (e) => controller.error(e);
+                        },
+                        cancel: closeWithInfo,
+                    }),
+                    writable: new WritableStream({
+                        write(chunk) {
+                            if (chunk instanceof Uint8Array) {
+                                ws.send(chunk.buffer);
+                            }
+                            else {
+                                ws.send(chunk);
+                            }
+                        },
+                        abort() {
+                            ws.close();
+                        },
+                        close: closeWithInfo,
+                    }),
+                    protocol: ws.protocol,
+                    extensions: ws.extensions,
+                });
+                ws.removeEventListener("error", reject);
+            };
+            ws.addEventListener("error", reject);
+        });
+        this.closed = new Promise((resolve, reject) => {
+            ws.onclose = ({ code, reason }) => {
+                resolve({ closeCode: code, reason });
+                ws.removeEventListener("error", reject);
+            };
+            ws.addEventListener("error", reject);
+        });
+        if (options.signal) {
+            options.signal.onabort = () => ws.close();
+        }
+        this.close = closeWithInfo;
+    }
+}
+//# sourceMappingURL=webSocketStream.js.map

package/dist/web/webSocketStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webSocketStream.js","sourceRoot":"","sources":["../../web/webSocketStream.ts"],"names":[],"mappings":"AAAA;;GAEG;AAqBH;;;;GAIG;AACH,MAAM,OAAO,eAAe;IAGjB,MAAM,CAAkC;IAExC,MAAM,CAA8B;IAEpC,KAAK,CAA2C;IAEzD,YAAY,EAAa,EAAE,OAAO,GAA2B,EAAE;QAC7D,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,YAAY,CAAC,4BAA4B,EAAE,YAAY,CAAC,CAAC;QACrE,CAAC;QACD,MAAM,aAAa,GAAG,CACpB,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,GAAuB,EAAE,EACpD,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAE5B,IAAI,CAAC,MAAM,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC5C,EAAE,CAAC,MAAM,GAAG,GAAG,EAAE;gBACf,OAAO,CAAC;oBACN,QAAQ,EAAE,IAAI,cAAc,CAAI;wBAC9B,KAAK,CAAC,UAAU;4BACd,EAAE,CAAC,SAAS,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;gCAC1B,IAAI,IAAI,YAAY,WAAW,EAAE,CAAC;oCAChC,UAAU,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,IAAI,CAAM,CAAC,CAAC;gCAChD,CAAC;qCAAM,CAAC;oCACN,UAAU,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;gCAChC,CAAC;4BACH,CAAC,CAAC;4BACF,EAAE,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAC1C,CAAC;wBACD,MAAM,EAAE,aAAa;qBACtB,CAAC;oBACF,QAAQ,EAAE,IAAI,cAAc,CAAI;wBAC9B,KAAK,CAAC,KAAK;4BACT,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;gCAChC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAqB,CAAC,CAAC;4BACvC,CAAC;iCAAM,CAAC;gCACN,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;4BACjB,CAAC;wBACH,CAAC;wBACD,KAAK;4BACH,EAAE,CAAC,KAAK,EAAE,CAAC;wBACb,CAAC;wBACD,KAAK,EAAE,aAAa;qBACrB,CAAC;oBACF,QAAQ,EAAE,EAAE,CAAC,QAAQ;oBACrB,UAAU,EAAE,EAAE,CAAC,UAAU;iBAC1B,CAAC,CAAC;gBACH,EAAE,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC1C,CAAC,CAAC;YACF,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAChE,EAAE,CAAC,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE;gBAChC,OAAO,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBACrC,EAAE,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC1C,CAAC,CAAC;YACF,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC;IAC7B,CAAC;CACF"}

package/dist/web/wrapWebSocket.d.ts

@@ -0,0 +1,12 @@
+import type { SockConn } from "../socket/socket.ts";
+export type HostnamePort = {
+    hostname?: string;
+    port?: string | number;
+};
+/**
+ * Wraps a WebSocketStream socket into a standard web streams-based socket connection
+ * @param ws - The WebSocket to wrap
+ * @returns A SockConn object
+ */
+export declare function wrapWebSocket(ws: WebSocket, remoteAddr?: HostnamePort): Promise<SockConn>;
+//# sourceMappingURL=wrapWebSocket.d.ts.map

package/dist/web/wrapWebSocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrapWebSocket.d.ts","sourceRoot":"","sources":["../../web/wrapWebSocket.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAGpD,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB,CAAC;AAYF;;;;GAIG;AACH,wBAAsB,aAAa,CACjC,EAAE,EAAE,SAAS,EACb,UAAU,CAAC,EAAE,YAAY,GACxB,OAAO,CAAC,QAAQ,CAAC,CAqBnB"}

package/dist/web/wrapWebSocket.js

@@ -0,0 +1,41 @@
+/**
+ * Utility functions for wrapping WebSocketStream sockets into standard web streams.
+ */
+import { WebSocketStream } from "./webSocketStream.js";
+import { logger } from "../utils/logger.js";
+/**
+ * Closes a WebSocketStream socket if it is not already closed
+ * @param sock - The WebSocketStream socket to close
+ */
+async function closer(stream) {
+    if (!await stream.closed) {
+        stream.close();
+    }
+}
+/**
+ * Wraps a WebSocketStream socket into a standard web streams-based socket connection
+ * @param ws - The WebSocket to wrap
+ * @returns A SockConn object
+ */
+export async function wrapWebSocket(ws, remoteAddr) {
+    ws.binaryType = "arraybuffer";
+    const wsstream = new WebSocketStream(ws);
+    logger.debug("created wsstream");
+    const stream = await wsstream.opened;
+    logger.debug("wsstream is opened");
+    const readable = stream.readable;
+    const writable = stream.writable;
+    const { hostname = "localhost", port = 0 } = remoteAddr || {};
+    const conn = {
+        readable: readable,
+        writable: writable,
+        close: () => closer(wsstream),
+        remoteAddr: {
+            hostname,
+            port: Number(port),
+            transport: "tcp",
+        },
+    };
+    return conn;
+}
+//# sourceMappingURL=wrapWebSocket.js.map

package/dist/web/wrapWebSocket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrapWebSocket.js","sourceRoot":"","sources":["../../web/wrapWebSocket.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAO5C;;;GAGG;AACH,KAAK,UAAU,MAAM,CAAC,MAAuB;IAC3C,IAAI,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,EAAa,EACb,UAAyB;IAEzB,EAAE,CAAC,UAAU,GAAG,aAAa,CAAC;IAC9B,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAa,EAAE,CAAC,CAAC;IACrD,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACjC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IACjC,MAAM,EAAE,QAAQ,GAAG,WAAW,EAAE,IAAI,GAAG,CAAC,EAAE,GAAG,UAAU,IAAI,EAAE,CAAC;IAE9D,MAAM,IAAI,GAAa;QACrB,QAAQ,EAAE,QAAsC;QAChD,QAAQ,EAAE,QAAsC;QAChD,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC7B,UAAU,EAAE;YACV,QAAQ;YACR,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;YAClB,SAAS,EAAE,KAAK;SACjB;KACF,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/web/wsClient.d.ts

@@ -0,0 +1,7 @@
+import { Client } from "../client/client.ts";
+import type { SockConn } from "../client/deps.ts";
+export declare class WsClient extends Client {
+    private establishSocket;
+    protected createConn(): Promise<SockConn>;
+}
+//# sourceMappingURL=wsClient.d.ts.map

package/dist/web/wsClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wsClient.d.ts","sourceRoot":"","sources":["../../web/wsClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAGlD,qBAAa,QAAS,SAAQ,MAAM;YACpB,eAAe;IAO7B,UAAmB,UAAU,IAAI,OAAO,CAAC,QAAQ,CAAC,CAUjD;CACF"}

package/dist/web/wsClient.js

@@ -0,0 +1,22 @@
+import { Client } from "../client/client.js";
+import { logger } from "../client/deps.js";
+import { wrapWebSocket } from "./wrapWebSocket.js";
+export class WsClient extends Client {
+    async establishSocket(url) {
+        const ws = new WebSocket(url);
+        const conn = await wrapWebSocket(ws);
+        return conn;
+    }
+    // overload createConn from the base client class
+    createConn() {
+        const { protocol, hostname, port: portStr, pathname } = this.connectUrl;
+        const port = portStr ? Number(portStr) : (protocol === "wss:" ? 443 : 80);
+        const path = pathname || "/mqtt";
+        logger.debug({ hostname, port, path });
+        if (protocol === "ws:" || protocol === "wss:") {
+            return this.establishSocket(`${protocol}//${hostname}:${port}${path}`);
+        }
+        throw new Error(`Unsupported protocol: ${protocol}`);
+    }
+}
+//# sourceMappingURL=wsClient.js.map

package/dist/web/wsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wsClient.js","sourceRoot":"","sources":["../../web/wsClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,MAAM,OAAO,QAAS,SAAQ,MAAM;IAC1B,KAAK,CAAC,eAAe,CAAC,GAAW;QACvC,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,EAAE,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iDAAiD;IAC9B,UAAU;QAC3B,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC;QACxE,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1E,MAAM,IAAI,GAAG,QAAQ,IAAI,OAAO,CAAC;QAEjC,MAAM,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACvC,IAAI,QAAQ,KAAK,KAAK,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,QAAQ,KAAK,QAAQ,IAAI,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;QACzE,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,EAAE,CAAC,CAAC;IACvD,CAAC;CACF"}

package/dist/web/wsClient.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=wsClient.test.d.ts.map

package/dist/web/wsClient.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wsClient.test.d.ts","sourceRoot":"","sources":["../../web/wsClient.test.ts"],"names":[],"mappings":""}

package/dist/web/wsClient.test.js

@@ -0,0 +1,20 @@
+import { test } from "node:test";
+import assert from "node:assert/strict";
+import { WsClient } from "./wsClient.js";
+// most client testing is already done in wsServer.test.ts
+test("Web: Test createConn - unsupported protocol", async () => {
+    const client = new WsClient();
+    // Use an unsupported protocol like 'ftp://' to trigger the throw in createConn
+    const invalidParams = {
+        url: new URL("ftp://localhost:1883"),
+        numberOfRetries: 0,
+    };
+    // Assert that connect rejects with the specific "Unsupported protocol" error
+    await assert.rejects(async () => {
+        await client.connect(invalidParams);
+    }, {
+        name: "Error",
+        message: "Unsupported protocol: ftp:",
+    }, "Should throw an error when an unsupported protocol is provided");
+});
+//# sourceMappingURL=wsClient.test.js.map

package/dist/web/wsClient.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wsClient.test.js","sourceRoot":"","sources":["../../web/wsClient.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,0DAA0D;AAC1D,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;IAC7D,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;IAE9B,+EAA+E;IAC/E,MAAM,aAAa,GAAG;QACpB,GAAG,EAAE,IAAI,GAAG,CAAC,sBAAsB,CAAC;QACpC,eAAe,EAAE,CAAC;KACnB,CAAC;IAEF,6EAA6E;IAC7E,MAAM,MAAM,CAAC,OAAO,CAClB,KAAK,IAAI,EAAE;QACT,MAAM,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC,EACD;QACE,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,4BAA4B;KACtC,EACD,gEAAgE,CACjE,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/examples/authHandler.test.ts

@@ -0,0 +1,164 @@
+import { test } from "node:test";
+import assert from "node:assert/strict";
+import { TcpClient } from "@seriousme/opifex/tcpClient";
+import { TcpServer } from "@seriousme/opifex/tcpServer";
+import { delay, logger, LogLevel } from "@seriousme/opifex/utils";
+import type { PublishPacket, QoS } from "@seriousme/opifex/mqttPacket";
+import { ReasonCode } from "@seriousme/opifex/server";
+// just for demo purposes: ReasonCode is identical in server and client
+import {
+  MQTTLevel,
+  ReasonCode as ClientReasonCode,
+} from "@seriousme/opifex/client";
+
+import type { Context } from "@seriousme/opifex/server";
+
+const txtEncoder = new TextEncoder();
+const txtDecoder = new TextDecoder();
+
+logger.level(LogLevel.info);
+const firstClientMessage = "first client message";
+const secondClientMessage = "second client message";
+const firstServerMessage = "first server message";
+const secondServerMessage = "second server message";
+
+const authMethodForTest = "opifex-for-test-only";
+
+function serverProcessAuth(
+  _ctx: Context,
+  _clientId: string,
+  authMethod: string,
+  authData: Uint8Array,
+) {
+  logger.debug("serverProcessAuth", authMethod, txtDecoder.decode(authData));
+  if (authMethod !== authMethodForTest) {
+    return {
+      reasonCode: ReasonCode.badAuthenticationMethod,
+    };
+  }
+  const authDataString = txtDecoder.decode(authData);
+  if (authDataString === firstClientMessage) {
+    return {
+      reasonCode: ReasonCode.continueAuthentication,
+      authData: txtEncoder.encode(firstServerMessage),
+    };
+  }
+
+  if (authDataString === secondClientMessage) {
+    return {
+      reasonCode: ReasonCode.success,
+      authData: txtEncoder.encode(secondServerMessage),
+    };
+  }
+  return {
+    reasonCode: ReasonCode.notAuthorized,
+  };
+}
+
+function clientProcessAuth(
+  authMethod: string,
+  authData: Uint8Array,
+) {
+  const authDataString = txtDecoder.decode(authData);
+  logger.debug("clientProcessAuth", authMethod, authDataString);
+  if (
+    authMethod !== authMethodForTest ||
+    (
+      authDataString !== firstServerMessage &&
+      authDataString !== secondServerMessage
+    )
+  ) {
+    return {
+      reasonCode: ClientReasonCode.badAuthenticationMethod,
+      reasonString: "Unknown method or bad data",
+    };
+  }
+  return {
+    reasonCode: ClientReasonCode.continueAuthentication,
+    authData: txtEncoder.encode(secondClientMessage),
+    reasonString: "Continue",
+  };
+}
+
+test("Test MQTTv5 Auth using TCP client and server", async function () {
+  const server = new TcpServer({ port: 0 }, {
+    handlers: {
+      processAuth: serverProcessAuth,
+    },
+  });
+  server.start();
+
+  assert.deepStrictEqual(
+    server.port !== undefined,
+    true,
+    "server runs a a random port",
+  );
+  logger.info(
+    `TCP server running on port: ${server.port}, address: ${server.address}`,
+  );
+
+  const params = {
+    url: new URL(`mqtt://${server.address}:${server.port}`),
+    numberOfRetries: 0,
+    options: {
+      protocolLevel: MQTTLevel.v5,
+      properties: {
+        authenticationMethod: authMethodForTest,
+        authenticationData: txtEncoder.encode(firstClientMessage),
+      },
+    },
+  };
+
+  const client = new TcpClient();
+  client.onAuth = clientProcessAuth;
+  await client.connect(params);
+  logger.info("Client connected to server at", client.url);
+
+  const publishSet: { topic: string; qos: QoS }[] = [
+    { topic: "t0@q0", qos: 0 },
+    { topic: "t1@q0", qos: 0 },
+  ];
+
+  const subscriptions = publishSet.map((item) => ({
+    topicFilter: item.topic,
+    qos: item.qos,
+  }));
+  await client.subscribe({
+    subscriptions,
+  });
+
+  // the IIFE ensures message reception runs in parallel
+  logger.info("Start receiving");
+  const received: PublishPacket[] = [];
+  (async function () {
+    for await (const item of client.messages()) {
+      logger.verbose("Receiving:", item.topic, "--", item.qos);
+      received.push(item);
+    }
+  })();
+  // end of IIFE
+  for (const item of publishSet) {
+    logger.verbose("Publishing:", item.topic, "--", item.qos);
+    await client.publish({
+      topic: item.topic,
+      qos: item.qos,
+      payload: new Uint8Array([0x01]),
+    });
+  }
+
+  await delay(100);
+  logger.info("Disconnect client");
+  await client.disconnect();
+
+  logger.info("Check completeness");
+  for (const item of publishSet) {
+    const found = received.find((f) =>
+      f.topic == item.topic && f.qos === item.qos
+    );
+    logger.verbose("Found:", item.topic, "--", item.qos);
+    assert(found, `${item.topic} -- ${item.qos}`);
+  }
+
+  logger.info("Stop server");
+  server.stop();
+});