qws-browser 1.0.1

package/README.md

@@ -0,0 +1,15 @@
+# WSQ (WebSocket Queue)
+
+Safe queueing with auto-reconnect for WebSockets
+
+- Wrapper for built-in `WebSocket`
+- Works in browser and node (via [ws](https://github.com/websockets/ws))
+- Automatic reconnect
+- Message queueing with retainment
+- Automatic two-way acknowledgment stream of messages - all messages are retained in-memory until acknowledgment is provided
+- Configurable headers per message, even when body is binary
+- Simple message routing (via [route-recognizer](https://github.com/tildeio/route-recognizer))
+
+# Examples
+
+TODO

package/dist/browser/messageencode.d.ts

@@ -0,0 +1,10 @@
+import { QwsMessage } from '../common/message';
+/**
+ * Convert binary data received through underlying WS into WSQ message
+ * Changes type based on type header
+ */
+export declare function deserializeMessage(blob: Blob): Promise<QwsMessage>;
+/**
+ * Converts WSQ message into Blob to be sent through underlying WebSocket
+ */
+export declare function serializeMessage(message: QwsMessage): Blob;

package/dist/browser/messageencode.js

@@ -0,0 +1,113 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeMessage = exports.deserializeMessage = void 0;
+const logger_1 = __importDefault(require("../common/logger"));
+/**
+ * Converts generic object into base64-encoded JSON.
+ * Used in headers and optionally JSON-style body.
+ */
+function objectToJsonBinary(object) {
+    const objectJson = JSON.stringify(object);
+    return btoa(unescape(encodeURIComponent(objectJson)));
+}
+/**
+ * Deserializes base64-json buffers
+ * Used in headers and optionally JSON-style body.
+ */
+function jsonBinaryToObject(jsonBinary) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const jsonBinaryText = yield jsonBinary.text();
+        const objectJson = decodeURIComponent(escape(atob(jsonBinaryText)));
+        return JSON.parse(objectJson);
+    });
+}
+/**
+ * Convert binary data received through underlying WS into WSQ message
+ * Changes type based on type header
+ */
+function deserializeMessage(blob) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (blob.size < 4) {
+            logger_1.default.error('Invalid blob size');
+            return {
+                headers: { type: 'bin' },
+                body: blob,
+            };
+        }
+        // take first 4 bytes from header, check if not a too large size
+        const headersSizeBlob = yield blob.slice(0, 4).arrayBuffer();
+        const headersSizeArray = new Uint32Array(headersSizeBlob);
+        const headersSize = headersSizeArray[0];
+        if (headersSize > blob.size - 4) {
+            logger_1.default.error(`Invalid header size ${headersSize} > ${blob.size - 4}`);
+            return {
+                headers: { type: 'bin' },
+                body: blob,
+            };
+        }
+        try {
+            // decode base64-JSON header
+            const headers = yield jsonBinaryToObject(blob.slice(4, headersSize + 4));
+            const bodyBlob = blob.slice(headersSize + 4);
+            const type = headers.type || 'bin';
+            // body is either JSON Blob, original binary data or nothing
+            let body;
+            switch (type) {
+                case 'bin':
+                    body = bodyBlob;
+                    break;
+                case 'json':
+                    body = yield jsonBinaryToObject(bodyBlob);
+                    break;
+                default:
+            }
+            return { headers, body };
+        }
+        catch (ex) {
+            logger_1.default.error('Could not decode message', ex);
+            return {
+                headers: { type: 'bin' },
+                body: blob,
+            };
+        }
+    });
+}
+exports.deserializeMessage = deserializeMessage;
+/**
+ * Converts WSQ message into Blob to be sent through underlying WebSocket
+ */
+function serializeMessage(message) {
+    // headers encoded into base64(json)
+    const headersEncoded = objectToJsonBinary(message.headers);
+    const headersSize = Uint32Array.from([headersEncoded.length]);
+    // body is either JSON Blob, original binary data or nothing
+    let bodyEncoded;
+    switch (message.headers.type) {
+        case 'bin':
+            bodyEncoded = message.body;
+            break;
+        case 'json':
+            bodyEncoded = objectToJsonBinary(message.body);
+            break;
+        default:
+    }
+    return new Blob([
+        headersSize,
+        headersEncoded,
+        bodyEncoded, // binary, json or null body
+    ], { type: 'application/octet-stream' });
+}
+exports.serializeMessage = serializeMessage;
+//# sourceMappingURL=messageencode.js.map

package/dist/browser/messageencode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageencode.js","sourceRoot":"","sources":["../../src/browser/messageencode.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8DAAsC;AAGtC;;;GAGG;AACH,SAAS,kBAAkB,CAAC,MAA+B;IACzD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1C,OAAO,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC;AAED;;;GAGG;AACH,SAAe,kBAAkB,CAAC,UAAgB;;QAChD,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;CAAA;AAED;;;GAGG;AACH,SAAsB,kBAAkB,CAAC,IAAU;;QACjD,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE;YACjB,gBAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;YAClC,OAAO;gBACL,OAAO,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;gBACxB,IAAI,EAAE,IAAI;aACS,CAAC;SACvB;QAED,gEAAgE;QAChE,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7D,MAAM,gBAAgB,GAAG,IAAI,WAAW,CAAC,eAAe,CAAC,CAAC;QAC1D,MAAM,WAAW,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;QACxC,IAAI,WAAW,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE;YAC/B,gBAAM,CAAC,KAAK,CAAC,uBAAuB,WAAW,MAAM,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC;YACtE,OAAO;gBACL,OAAO,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;gBACxB,IAAI,EAAE,IAAI;aACS,CAAC;SACvB;QAED,IAAI;YACF,4BAA4B;YAC5B,MAAM,OAAO,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC;YACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;YAC7C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC;YAEnC,4DAA4D;YAC5D,IAAI,IAAoC,CAAC;YACzC,QAAQ,IAAI,EAAE;gBACZ,KAAK,KAAK;oBACR,IAAI,GAAG,QAAQ,CAAC;oBAChB,MAAM;gBACR,KAAK,MAAM;oBACT,IAAI,GAAG,MAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAC;oBAC1C,MAAM;gBACR,QAAQ;aACT;YAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAgB,CAAC;SACxC;QAAC,OAAO,EAAE,EAAE;YACX,gBAAM,CAAC,KAAK,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC;YAC7C,OAAO;gBACL,OAAO,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;gBACxB,IAAI,EAAE,IAAI;aACS,CAAC;SACvB;IACH,CAAC;CAAA;AA/CD,gDA+CC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,OAAmB;IAClD,oCAAoC;IACpC,MAAM,cAAc,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3D,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IAE9D,4DAA4D;IAC5D,IAAI,WAA0B,CAAC;IAC/B,QAAQ,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE;QAC5B,KAAK,KAAK;YACR,WAAW,GAAI,OAA4B,CAAC,IAAI,CAAC;YACjD,MAAM;QACR,KAAK,MAAM;YACT,WAAW,GAAG,kBAAkB,CAAE,OAA0B,CAAC,IAAI,CAAC,CAAC;YACnE,MAAM;QACR,QAAQ;KACT;IAED,OAAO,IAAI,IAAI,CACb;QACE,WAAW;QACX,cAAc;QACd,WAAW,EAAE,4BAA4B;KAC1C,EACD,EAAE,IAAI,EAAE,0BAA0B,EAAE,CACrC,CAAC;AACJ,CAAC;AAzBD,4CAyBC"}

package/dist/browser/wrappedws.d.ts

@@ -0,0 +1,42 @@
+import { QwsMessage, AckQwsMessage, BinaryQwsMessage, ErrorQwsMessage, JsonQwsMessage, ReadyQwsMessage } from '../common/message';
+import { Binary } from '../common/discriminator';
+/**
+ * Wrapper around WebSocket, built to serialize/deserialize
+ * WSQ formatted messages.
+ */
+export default class WrappedWebSocket {
+    ws: WebSocket;
+    callbacks: {
+        bin?: (message: BinaryQwsMessage) => void;
+        json?: (message: JsonQwsMessage) => void;
+        ready?: (message: ReadyQwsMessage) => void;
+        ack?: (message: AckQwsMessage) => void;
+        err?: (message: ErrorQwsMessage) => void;
+    };
+    constructor(wsOrUrl: WebSocket | string);
+    /**
+     * Proxy callbacks
+     */
+    onWsOpen(callback: () => void): void;
+    onWsClose(callback: () => void): void;
+    onWsError(callback: (event: Event) => void): void;
+    /**
+     * Proxy others
+     */
+    get readyState(): number;
+    get bufferedAmount(): number;
+    /**
+     * Concrete message type callbacks
+     */
+    onBin(callback: (message: BinaryQwsMessage) => void): void;
+    onJson(callback: (message: JsonQwsMessage) => void): void;
+    onReady(callback: (message: ReadyQwsMessage) => void): void;
+    onAck(callback: (message: AckQwsMessage) => void): void;
+    onErr(callback: (message: ErrorQwsMessage) => void): void;
+    /**
+     * Proxy methods
+     */
+    send(message: QwsMessage): void;
+    sendRaw(data: Binary): void;
+    close(): void;
+}

package/dist/browser/wrappedws.js

@@ -0,0 +1,95 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const auto_bind_1 = __importDefault(require("auto-bind"));
+const messageencode_1 = require("./messageencode");
+/**
+ * Wrapper around WebSocket, built to serialize/deserialize
+ * WSQ formatted messages.
+ */
+class WrappedWebSocket {
+    constructor(wsOrUrl) {
+        var _a;
+        this.callbacks = {};
+        if (wsOrUrl instanceof WebSocket || ((_a = wsOrUrl === null || wsOrUrl === void 0 ? void 0 : wsOrUrl.constructor) === null || _a === void 0 ? void 0 : _a.name) === 'WebSocket') {
+            this.ws = wsOrUrl;
+        }
+        else {
+            this.ws = new WebSocket(wsOrUrl);
+        }
+        this.ws.onmessage = (event) => __awaiter(this, void 0, void 0, function* () {
+            const message = yield (0, messageencode_1.deserializeMessage)(event.data);
+            // logger.info('WRAPPER received', message);
+            const callback = this.callbacks[message.headers.type];
+            callback === null || callback === void 0 ? void 0 : callback(message);
+        });
+        (0, auto_bind_1.default)(this);
+    }
+    /**
+     * Proxy callbacks
+     */
+    onWsOpen(callback) {
+        this.ws.onopen = callback;
+    }
+    onWsClose(callback) {
+        this.ws.onclose = callback;
+    }
+    onWsError(callback) {
+        this.ws.onerror = callback;
+    }
+    /**
+     * Proxy others
+     */
+    get readyState() {
+        return this.ws.readyState;
+    }
+    get bufferedAmount() {
+        return this.ws.bufferedAmount;
+    }
+    /**
+     * Concrete message type callbacks
+     */
+    onBin(callback) {
+        this.callbacks.bin = callback;
+    }
+    onJson(callback) {
+        this.callbacks.json = callback;
+    }
+    onReady(callback) {
+        this.callbacks.ready = callback;
+    }
+    onAck(callback) {
+        this.callbacks.ack = callback;
+    }
+    onErr(callback) {
+        this.callbacks.err = callback;
+    }
+    /**
+     * Proxy methods
+     */
+    send(message) {
+        // logger.info('WRAPPER sending', message);
+        const data = (0, messageencode_1.serializeMessage)(message);
+        this.ws.send(data);
+    }
+    sendRaw(data) {
+        // logger.info('WRAPPER send raw', data.toString());
+        this.ws.send(data);
+    }
+    close() {
+        this.ws.close();
+    }
+}
+exports.default = WrappedWebSocket;
+//# sourceMappingURL=wrappedws.js.map

package/dist/browser/wrappedws.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrappedws.js","sourceRoot":"","sources":["../../src/browser/wrappedws.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,0DAAiC;AAGjC,mDAAuE;AAGvE;;;GAGG;AACH,MAAqB,gBAAgB;IAWnC,YAAY,OAA2B;;QACrC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,OAAO,YAAY,SAAS,IAAI,CAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,0CAAE,IAAI,MAAK,WAAW,EAAE;YAC9E,IAAI,CAAC,EAAE,GAAG,OAAoB,CAAC;SAChC;aAAM;YACL,IAAI,CAAC,EAAE,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;SAClC;QAED,IAAI,CAAC,EAAE,CAAC,SAAS,GAAG,CAAO,KAA2B,EAAE,EAAE;YACxD,MAAM,OAAO,GAAG,MAAM,IAAA,kCAAkB,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACrD,4CAA4C;YAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAA8B,CAAC;YACnF,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,OAAO,CAAC,CAAC;QACtB,CAAC,CAAA,CAAC;QAEF,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IAEH,QAAQ,CAAC,QAAoB;QAC3B,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED,SAAS,CAAC,QAAoB;QAC5B,IAAI,CAAC,EAAE,CAAC,OAAO,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED,SAAS,CAAC,QAAgC;QACxC,IAAI,CAAC,EAAE,CAAC,OAAO,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC;IAC5B,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC;IAChC,CAAC;IAED;;OAEG;IAEH,KAAK,CAAC,QAA6C;QACjD,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,QAAQ,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,QAA2C;QAChD,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,QAAQ,CAAC;IACjC,CAAC;IAED,OAAO,CAAC,QAA4C;QAClD,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,QAAQ,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,QAA0C;QAC9C,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,QAAQ,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,QAA4C;QAChD,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,QAAQ,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAmB;QACtB,2CAA2C;QAC3C,MAAM,IAAI,GAAG,IAAA,gCAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,oDAAoD;QACpD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;IAClB,CAAC;CACF;AAlGD,mCAkGC"}

package/dist/common/discriminator.d.ts

@@ -0,0 +1 @@
+export declare type Binary = Blob;

package/dist/common/discriminator.js

@@ -0,0 +1,5 @@
+"use strict";
+// node
+// export type Binary = Buffer;
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=discriminator.js.map

package/dist/common/discriminator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discriminator.js","sourceRoot":"","sources":["../../src/common/discriminator.ts"],"names":[],"mappings":";AAAA,OAAO;AACP,+BAA+B"}

package/dist/common/logger.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Pluggable logger interface
+ */
+export interface QwsLogger {
+    debug(...data: any[]): void;
+    info(...data: any[]): void;
+    warn(...data: any[]): void;
+    error(...data: any[]): void;
+}
+export declare class QwsLoggerWrapper implements QwsLogger {
+    backend: QwsLogger;
+    constructor(logger?: QwsLogger);
+    debug(...data: any[]): void;
+    info(...data: any[]): void;
+    warn(...data: any[]): void;
+    error(...data: any[]): void;
+    /**
+     * Overwrite default logger used by qws, which is the console.
+     * Allows plugging of external tools, such as yall2
+     */
+    setBackend(newBackend: QwsLogger): void;
+}
+/**
+ * Export default instance
+ */
+declare const logger: QwsLoggerWrapper;
+export default logger;
+/**
+ * Export setBackend method for easy external setup
+ */
+export declare const setQwsLoggingBackend: (newBackend: QwsLogger) => void;

package/dist/common/logger.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setQwsLoggingBackend = exports.QwsLoggerWrapper = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const auto_bind_1 = __importDefault(require("auto-bind"));
+class QwsLoggerWrapper {
+    constructor(logger = console) {
+        this.backend = logger;
+        (0, auto_bind_1.default)(this);
+    }
+    debug(...data) {
+        this.backend.debug(...data);
+    }
+    info(...data) {
+        this.backend.info(...data);
+    }
+    warn(...data) {
+        this.backend.warn(...data);
+    }
+    error(...data) {
+        this.backend.error(...data);
+    }
+    /**
+     * Overwrite default logger used by qws, which is the console.
+     * Allows plugging of external tools, such as yall2
+     */
+    setBackend(newBackend) {
+        this.backend = newBackend;
+    }
+}
+exports.QwsLoggerWrapper = QwsLoggerWrapper;
+/**
+ * Export default instance
+ */
+const logger = new QwsLoggerWrapper();
+exports.default = logger;
+/**
+ * Export setBackend method for easy external setup
+ */
+exports.setQwsLoggingBackend = logger.setBackend;
+//# sourceMappingURL=logger.js.map

package/dist/common/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/common/logger.ts"],"names":[],"mappings":";;;;;;AAAA,uDAAuD;AACvD,0DAAiC;AAYjC,MAAa,gBAAgB;IAG3B,YAAY,SAAoB,OAAO;QACrC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,GAAG,IAAW;QAClB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACjB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACjB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,GAAG,IAAW;QAClB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,UAAqB;QAC9B,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;IAC5B,CAAC;CACF;AA/BD,4CA+BC;AAED;;GAEG;AACH,MAAM,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;AACtC,kBAAe,MAAM,CAAC;AAEtB;;GAEG;AACU,QAAA,oBAAoB,GAAG,MAAM,CAAC,UAAU,CAAC"}

package/dist/common/message.d.ts

@@ -0,0 +1,124 @@
+/**
+ * Custom message format for WSQ messages:
+ * - first 4 bytes:   uint32 saying how long the header information is
+ * - next n bytes:    base64(json)-encoded headers
+ * - remaining bytes: actual body - could be binary or base64(json), denoted in headers
+ */
+import { Binary } from './discriminator';
+/**
+ * Denotes message type, must be included in header.
+ * 'bin' - payload message with binary body
+ * 'json' - payload message with JSON body
+ * 'ready' - ready message sent after connection and setup
+ * 'ack' - acknowledgment message for a payload message received from other side
+ * 'err' - error
+ */
+export declare type QwsMessageType = 'bin' | 'json' | 'ready' | 'ack' | 'err';
+/**
+ * Headers are sent in base64(json) format.
+ */
+export declare type QwsMessageExtraHeaders = {
+    /**
+     * Other X-headers
+     */
+    [key: string]: unknown;
+};
+/**
+ * Path parameters decodable with route-recognizer when using routed messages.
+ */
+export declare type QwsParams = {
+    /**
+     * Other X-headers
+     */
+    [key: string]: string;
+};
+/**
+ * Message types
+ */
+/**
+ * Binary payload messages
+ * Contain binary body (like video data)
+ */
+export declare type BinaryQwsMessageHeaders = QwsMessageExtraHeaders & {
+    type: 'bin';
+    /**
+     * Message index in order. Helps in acknowledgments
+     */
+    idx?: number;
+    /**
+     * Routing key for message
+     */
+    route?: string;
+};
+export declare type BinaryQwsMessage = {
+    headers: BinaryQwsMessageHeaders;
+    body: Binary;
+};
+/**
+ * JSON payload message
+ * Contain base64-JSON encoded data
+ */
+export declare type JsonQwsMessageHeaders = QwsMessageExtraHeaders & {
+    type: 'json';
+    /**
+     * Message index in order. Helps in acknowledgments
+     */
+    idx: number;
+    /**
+     * Routing key for message
+     */
+    route?: string;
+};
+export declare type JsonQwsMessage = {
+    headers: JsonQwsMessageHeaders;
+    body: Record<string, unknown>;
+};
+/**
+ * Ready message
+ * Sent back after successful connect, signalling we are ready to receive events
+ * Optionally contains a message index denoting how many messages we already have received previously
+ */
+export declare type ReadyQwsMessageHeaders = QwsMessageExtraHeaders & {
+    type: 'ready';
+    /**
+     * Message index we have already received previously that may be omitted.
+     */
+    readyIdx: number;
+};
+export declare type ReadyQwsMessage = {
+    headers: ReadyQwsMessageHeaders;
+};
+/**
+ * Acknowledgment message
+ * Sent back for every payload message
+ */
+export declare type AckQwsMessageHeaders = {
+    type: 'ack';
+    /**
+     * Message index from other side we are acknowledging
+     */
+    ackIdx: number;
+};
+export declare type AckQwsMessage = {
+    headers: AckQwsMessageHeaders;
+};
+/**
+ * Error message
+ * Sent back if processing a message is unsuccessful
+ */
+export declare type ErrorQwsMessageHeaders = {
+    type: 'err';
+    /**
+     * Message of error
+     */
+    error: string;
+};
+export declare type ErrorQwsMessage = {
+    headers: ErrorQwsMessageHeaders;
+};
+/**
+ * Common names for WSQ message
+ */
+export declare type PayloadQwsMessage = BinaryQwsMessage | JsonQwsMessage;
+export declare type QwsMessage = BinaryQwsMessage | JsonQwsMessage | ReadyQwsMessage | AckQwsMessage | ErrorQwsMessage;
+export declare type QwsMessageHeader = BinaryQwsMessageHeaders | JsonQwsMessageHeaders | ReadyQwsMessageHeaders | AckQwsMessageHeaders | ErrorQwsMessageHeaders;

package/dist/common/message.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Custom message format for WSQ messages:
+ * - first 4 bytes:   uint32 saying how long the header information is
+ * - next n bytes:    base64(json)-encoded headers
+ * - remaining bytes: actual body - could be binary or base64(json), denoted in headers
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=message.js.map

package/dist/common/message.js.map

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

package/dist/common/queryparser.d.ts

@@ -0,0 +1,5 @@
+export declare const parseUrl: (urlString: string) => Record<string, string>;
+export declare const parseQuery: (search: string) => Record<string, string>;
+export declare const addQueryParamsToUrl: (urlString: string, params: Record<string, unknown>) => string;
+export declare const addQueryParameters: (search: string, params?: {}, defaultParams?: {}) => string;
+export declare const toUrlParams: (query?: {}, defaultParams?: {}) => string;

package/dist/common/queryparser.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toUrlParams = exports.addQueryParameters = exports.addQueryParamsToUrl = exports.parseQuery = exports.parseUrl = void 0;
+// parse query parameters from URL
+const parseUrl = (urlString) => {
+    const url = new URL(urlString);
+    const query = {};
+    url.searchParams.forEach((val, key) => {
+        query[key] = val;
+    });
+    return query;
+};
+exports.parseUrl = parseUrl;
+// parse query parameters from location
+const parseQuery = (search) => {
+    const params = new URLSearchParams(search);
+    const query = {};
+    params.forEach((val, key) => {
+        query[key] = val;
+    });
+    return query;
+};
+exports.parseQuery = parseQuery;
+// parse query parameters from URL
+const addQueryParamsToUrl = (urlString, params) => {
+    const url = new URL(urlString);
+    Object.entries(params).forEach(([key, val]) => {
+        url.searchParams.set(key, `${val}`);
+    });
+    return url.toString();
+};
+exports.addQueryParamsToUrl = addQueryParamsToUrl;
+// add extra query parameters to location
+const addQueryParameters = (search, params = {}, defaultParams = {}) => {
+    const query = (0, exports.parseQuery)(search);
+    let changed = false;
+    Object.entries(params).forEach(([key, val]) => {
+        if (key in defaultParams) {
+            // has default
+            if (val !== defaultParams[key]) {
+                query[key] = `${val}`;
+                changed = true;
+            }
+            else if (key in query) {
+                delete query[key];
+                changed = true;
+            }
+        }
+        else {
+            // no default
+            // eslint-disable-next-line no-lonely-if
+            if (val !== undefined && val !== null && val !== '') {
+                query[key] = `${val}`;
+                changed = true;
+            }
+            else if (key in query) {
+                delete query[key];
+                changed = true;
+            }
+        }
+    });
+    if (!changed) {
+        return search;
+    }
+    return `?${new URLSearchParams(query).toString()}`;
+};
+exports.addQueryParameters = addQueryParameters;
+// parse into URLParams
+const toUrlParams = (query = {}, defaultParams = {}) => {
+    const params = {};
+    Object.entries(query).forEach(([key, val]) => {
+        // omit default values
+        if (key in defaultParams && defaultParams[key] === val) {
+            return;
+        }
+        if (Array.isArray(val)) {
+            params[key] = val.join(',');
+        }
+        else if (val !== undefined && val !== null && val !== '' && !Number.isNaN(val)) {
+            params[key] = `${val}`;
+        }
+    });
+    return new URLSearchParams(params).toString();
+};
+exports.toUrlParams = toUrlParams;
+//# sourceMappingURL=queryparser.js.map

package/dist/common/queryparser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryparser.js","sourceRoot":"","sources":["../../src/common/queryparser.ts"],"names":[],"mappings":";;;AAAA,kCAAkC;AAC3B,MAAM,QAAQ,GAAG,CAAC,SAAiB,EAA0B,EAAE;IACpE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACpC,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACnB,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAPW,QAAA,QAAQ,YAOnB;AAEF,uCAAuC;AAChC,MAAM,UAAU,GAAG,CAAC,MAAc,EAA0B,EAAE;IACnE,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IAC3C,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC1B,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACnB,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAPW,QAAA,UAAU,cAOrB;AAEF,kCAAkC;AAC3B,MAAM,mBAAmB,GAAG,CAAC,SAAiB,EAAE,MAA+B,EAAU,EAAE;IAChG,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IAE/B,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;QAC5C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC,CAAC;AARW,QAAA,mBAAmB,uBAQ9B;AAEF,yCAAyC;AAClC,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAE,MAAM,GAAG,EAAE,EAAE,aAAa,GAAG,EAAE,EAAU,EAAE;IAC5F,MAAM,KAAK,GAAG,IAAA,kBAAU,EAAC,MAAM,CAAC,CAAC;IACjC,IAAI,OAAO,GAAG,KAAK,CAAC;IAEpB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;QAC5C,IAAI,GAAG,IAAI,aAAa,EAAE;YACxB,cAAc;YACd,IAAI,GAAG,KAAK,aAAa,CAAC,GAAG,CAAC,EAAE;gBAC9B,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC;gBACtB,OAAO,GAAG,IAAI,CAAC;aAChB;iBAAM,IAAI,GAAG,IAAI,KAAK,EAAE;gBACvB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClB,OAAO,GAAG,IAAI,CAAC;aAChB;SACF;aAAM;YACL,aAAa;YACb,wCAAwC;YACxC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,EAAE,EAAE;gBACnD,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC;gBACtB,OAAO,GAAG,IAAI,CAAC;aAChB;iBAAM,IAAI,GAAG,IAAI,KAAK,EAAE;gBACvB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClB,OAAO,GAAG,IAAI,CAAC;aAChB;SACF;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,MAAM,CAAC;KACf;IACD,OAAO,IAAI,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;AACrD,CAAC,CAAC;AA/BW,QAAA,kBAAkB,sBA+B7B;AAEF,uBAAuB;AAChB,MAAM,WAAW,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,aAAa,GAAG,EAAE,EAAU,EAAE;IACpE,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;QAC3C,sBAAsB;QACtB,IAAI,GAAG,IAAI,aAAa,IAAI,aAAa,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE;YACtD,OAAO;SACR;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC7B;aAAM,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YAChF,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC;SACxB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;AAChD,CAAC,CAAC;AAfW,QAAA,WAAW,eAetB"}

package/dist/common/queue.d.ts

@@ -0,0 +1,35 @@
+import { PayloadQwsMessage } from './message';
+import { Binary } from './discriminator';
+/**
+ * FIFO data structure implementation for outgoing qws messages
+ * Implements acknowledgment system, so no messages are deleted until acknowledged,
+ * but new messages may be added while waiting for ack.
+ */
+export default class QwsMessageQueue {
+    messages: Record<number, Binary>;
+    readIdx: number;
+    ackIdx: number;
+    writeIdx: number;
+    numUnsentMessages: number;
+    numUnsentBytes: number;
+    numUnackMessages: number;
+    numUnackBytes: number;
+    constructor();
+    /**
+     * Push message to write end of queue
+     */
+    produce(message: PayloadQwsMessage): number;
+    /**
+     * Pop message from read end of queue.
+     * Returns idx of message, along with its content.
+     */
+    consume(): [number, Binary];
+    /**
+     * When ack is received, we can forget messages up to that point
+     */
+    acknowledge(idx: number): void;
+    /**
+     * When ack fails, we must revert to a previous point
+     */
+    revert(idx: number): void;
+}

package/dist/common/queue.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const messageencode_1 = require("../browser/messageencode");
+/**
+ * FIFO data structure implementation for outgoing qws messages
+ * Implements acknowledgment system, so no messages are deleted until acknowledged,
+ * but new messages may be added while waiting for ack.
+ */
+class QwsMessageQueue {
+    constructor() {
+        this.messages = {};
+        this.readIdx = 0;
+        this.ackIdx = 0;
+        this.writeIdx = 0;
+        this.numUnsentMessages = 0;
+        this.numUnsentBytes = 0;
+        this.numUnackMessages = 0;
+        this.numUnackBytes = 0;
+    }
+    /**
+     * Push message to write end of queue
+     */
+    produce(message) {
+        const idx = this.writeIdx;
+        message.headers.idx = idx;
+        const data = (0, messageencode_1.serializeMessage)(message);
+        this.messages[idx] = data;
+        this.numUnsentMessages += 1;
+        this.numUnsentBytes += data.size;
+        this.numUnackMessages += 1;
+        this.numUnackBytes += data.size;
+        this.writeIdx += 1;
+        return idx;
+    }
+    /**
+     * Pop message from read end of queue.
+     * Returns idx of message, along with its content.
+     */
+    consume() {
+        const idx = this.readIdx;
+        const ret = this.messages[idx];
+        this.numUnsentMessages -= 1;
+        this.numUnsentBytes -= ret.size;
+        this.readIdx += 1;
+        return [idx, ret];
+    }
+    /**
+     * When ack is received, we can forget messages up to that point
+     */
+    acknowledge(idx) {
+        while (this.ackIdx <= idx) {
+            this.numUnackMessages -= 1;
+            this.numUnackBytes -= this.messages[this.ackIdx].size;
+            delete this.messages[this.ackIdx];
+            this.ackIdx += 1;
+        }
+    }
+    /**
+     * When ack fails, we must revert to a previous point
+     */
+    revert(idx) {
+        while (this.readIdx > idx) {
+            this.readIdx -= 1;
+            this.numUnsentMessages += 1;
+            this.numUnsentBytes += this.messages[this.readIdx].size;
+        }
+    }
+}
+exports.default = QwsMessageQueue;
+//# sourceMappingURL=queue.js.map

package/dist/common/queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue.js","sourceRoot":"","sources":["../../src/common/queue.ts"],"names":[],"mappings":";;AACA,4DAA4D;AAG5D;;;;GAIG;AACH,MAAqB,eAAe;IAWlC;QACE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAChB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAElB,IAAI,CAAC,iBAAiB,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,OAA0B;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC1B,OAAO,CAAC,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;QAC1B,MAAM,IAAI,GAAG,IAAA,gCAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;QAE1B,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,IAAI,CAAC;QACjC,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;QAC3B,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,IAAI,CAAC;QAEhC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;QACnB,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAE/B,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,cAAc,IAAI,GAAG,CAAC,IAAI,CAAC;QAChC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;QAClB,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,GAAW;QACrB,OAAO,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;YACzB,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;YAC3B,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;YACtD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;SAClB;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAW;QAChB,OAAO,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE;YACzB,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;YAClB,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;SACzD;IACH,CAAC;CACF;AA7ED,kCA6EC"}

package/dist/common/queuews.d.ts

@@ -0,0 +1,70 @@
+import RouteRecognizer from 'route-recognizer';
+import { Binary } from './discriminator';
+import { QwsMessageExtraHeaders, BinaryQwsMessageHeaders, JsonQwsMessageHeaders, ReadyQwsMessageHeaders, QwsParams } from './message';
+import WebSocketMessageQueue from './queue';
+import WrappedWebSocket from '../browser/wrappedws';
+/**
+ * Callback types
+ */
+export declare type ConnectCallback = () => void | number | Promise<void> | Promise<number>;
+export declare type BinCallback = (body: Binary, headers?: BinaryQwsMessageHeaders, params?: QwsParams) => void | Promise<void>;
+export declare type JsonCallback<T> = (body: T, headers?: JsonQwsMessageHeaders, params?: QwsParams) => void | Promise<void>;
+export declare type ReadyCallback = (headers?: ReadyQwsMessageHeaders) => void | Promise<void>;
+/**
+ * Connection options
+ */
+declare type QWebSocketOptions = {
+    name?: string;
+    extraConnectArgs?: Record<string, unknown>;
+    reconnect?: boolean;
+    reconnectNumTries?: number;
+    reconnectIntervalMillis?: number;
+};
+/**
+ * Actual queued WebSocket
+ */
+export default class QWebSocket {
+    wsOrUrl: WebSocket | string;
+    name: string;
+    options: QWebSocketOptions;
+    queue: WebSocketMessageQueue;
+    reconnectionAttempts: number;
+    needed: boolean;
+    wws: WrappedWebSocket;
+    ready: boolean;
+    callbacks: {
+        onConnect?: ConnectCallback;
+        onBin: RouteRecognizer;
+        onJson: RouteRecognizer;
+        onReady?: ReadyCallback;
+        onErroneousDisconnect?: (message: string) => void | Promise<void>;
+        onError?: (message: string) => void | Promise<void>;
+        onClose?: () => void | Promise<void>;
+    };
+    constructor(wsOrUrl: WebSocket | string, options?: QWebSocketOptions);
+    /**
+     * Public callback assignments for client
+     */
+    onConnect(callback: ConnectCallback): void;
+    onBinRoute(routePattern: string, callback: BinCallback): void;
+    onBin(callback: BinCallback): void;
+    onJsonRoute<T>(routePattern: string, callback: JsonCallback<T>): void;
+    onJson<T>(callback: JsonCallback<T>): void;
+    onReady(callback: ReadyCallback): void;
+    onErroneousDisconnect(callback: () => void): void;
+    onError(callback: (message: string) => void): void;
+    onClose(callback: () => void): void;
+    /**
+     * Main logic
+     */
+    setUp(): void;
+    flush(): void;
+    send(body: Binary | Record<string, unknown>, extraHeaders?: QwsMessageExtraHeaders): number;
+    sendToRoute(route: string, body: Binary | Record<string, unknown>, extraHeaders?: QwsMessageExtraHeaders): number;
+    /**
+     * Closes WS and sets promise resolution as callback.
+     * Overwrites any manually set up callback for onClose.
+     */
+    close(): Promise<void>;
+}
+export {};

package/dist/common/queuews.js

@@ -0,0 +1,351 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const auto_bind_1 = __importDefault(require("auto-bind"));
+const route_recognizer_1 = __importDefault(require("route-recognizer"));
+const queue_1 = __importDefault(require("./queue"));
+const wrappedws_1 = __importDefault(require("../browser/wrappedws"));
+const queryparser_1 = require("./queryparser");
+const logger_1 = __importDefault(require("./logger"));
+const decodeErrorMessage = (event) => {
+    if (event === null || event === void 0 ? void 0 : event.message) {
+        return event.message;
+    }
+    if (event) {
+        return event.toString();
+    }
+    return 'Unknown error';
+};
+const defaultOpts = {
+    extraConnectArgs: {},
+    reconnect: true,
+    reconnectNumTries: 12,
+    reconnectIntervalMillis: 5000,
+};
+/**
+ * Actual queued WebSocket
+ */
+class QWebSocket {
+    constructor(wsOrUrl, options = {}) {
+        this.wsOrUrl = wsOrUrl;
+        this.options = Object.assign(Object.assign({}, defaultOpts), options);
+        this.name = options.name || 'websocket';
+        this.callbacks = {
+            onBin: new route_recognizer_1.default(),
+            onJson: new route_recognizer_1.default(),
+        };
+        this.queue = new queue_1.default();
+        this.reconnectionAttempts = 0;
+        this.needed = true;
+        this.wws = null;
+        this.ready = false;
+        (0, auto_bind_1.default)(this);
+        this.setUp();
+    }
+    /**
+     * Public callback assignments for client
+     */
+    onConnect(callback) {
+        this.callbacks.onConnect = callback;
+    }
+    onBinRoute(routePattern, callback) {
+        this.callbacks.onBin.add([{ path: routePattern, handler: callback }]);
+    }
+    onBin(callback) {
+        this.onBinRoute('', callback);
+    }
+    onJsonRoute(routePattern, callback) {
+        this.callbacks.onJson.add([{ path: routePattern, handler: callback }]);
+    }
+    onJson(callback) {
+        this.onJsonRoute('', callback);
+    }
+    onReady(callback) {
+        this.callbacks.onReady = callback;
+    }
+    onErroneousDisconnect(callback) {
+        this.callbacks.onErroneousDisconnect = callback;
+    }
+    onError(callback) {
+        this.callbacks.onError = callback;
+    }
+    onClose(callback) {
+        this.callbacks.onClose = callback;
+    }
+    /**
+     * Main logic
+     */
+    // eslint-disable-next-line max-lines-per-function
+    setUp() {
+        var _a, _b, _c, _d;
+        if (this.wws && this.wws.readyState <= 1) {
+            return;
+        }
+        this.reconnectionAttempts += 1;
+        const { reconnect, reconnectNumTries, reconnectIntervalMillis, extraConnectArgs } = this.options;
+        // timeout for too many reconnection attempts
+        if (reconnect && this.reconnectionAttempts > reconnectNumTries) {
+            logger_1.default.error(`${this.name}: Connection timed out, should re-connect entirely`);
+            (_b = (_a = this.callbacks).onError) === null || _b === void 0 ? void 0 : _b.call(_a, `WS connection timeout, max tries (${reconnectNumTries}) exceeded`);
+            return;
+        }
+        /**
+         * Actual WebSocket opening
+         */
+        if (this.wsOrUrl instanceof WebSocket || ((_d = (_c = this.wsOrUrl) === null || _c === void 0 ? void 0 : _c.constructor) === null || _d === void 0 ? void 0 : _d.name) === 'WebSocket') {
+            const ws = this.wsOrUrl;
+            this.wws = new wrappedws_1.default(ws);
+            // TODO what if this is a reconnect? No reconnection was attempted, it's just the old reference
+        }
+        else {
+            const connectUrl = (0, queryparser_1.addQueryParamsToUrl)(this.wsOrUrl, Object.assign(Object.assign({}, extraConnectArgs), { idx: this.queue.ackIdx }));
+            this.wws = new wrappedws_1.default(connectUrl);
+        }
+        this.wws.onWsError((event) => __awaiter(this, void 0, void 0, function* () {
+            var _e, _f, _g, _h;
+            // ws error will prompt reconnection which can time out, don't reject instantly
+            const message = decodeErrorMessage(event);
+            logger_1.default.error(`${this.name}: WS error occurred: ${message}`);
+            if (reconnect) {
+                yield ((_f = (_e = this.callbacks).onErroneousDisconnect) === null || _f === void 0 ? void 0 : _f.call(_e, message));
+            }
+            else {
+                yield ((_h = (_g = this.callbacks).onError) === null || _h === void 0 ? void 0 : _h.call(_g, message));
+            }
+        }));
+        this.wws.onWsOpen(() => __awaiter(this, void 0, void 0, function* () {
+            var _j, _k;
+            this.reconnectionAttempts = 0;
+            if (reconnect) {
+                logger_1.default.info(`${this.name}: Connection established after ${this.reconnectionAttempts} tries`);
+            }
+            else {
+                logger_1.default.info(`${this.name}: Connection established`);
+            }
+            try {
+                // call post-connect method, this may give previously acked messages
+                const readyIdx = yield ((_k = (_j = this.callbacks).onConnect) === null || _k === void 0 ? void 0 : _k.call(_j));
+                // send back readiness ack
+                this.wws.send({
+                    headers: {
+                        type: 'ready',
+                        readyIdx,
+                    },
+                });
+            }
+            catch (err) {
+                // error occurred during initialization phase, send error right away, no "ready" message
+                this.wws.send({
+                    headers: {
+                        type: 'err',
+                        error: decodeErrorMessage(err),
+                    },
+                });
+            }
+        }));
+        this.wws.onReady((message) => __awaiter(this, void 0, void 0, function* () {
+            var _l, _m;
+            // ready to send messages from given message index
+            const { readyIdx } = message.headers;
+            logger_1.default.info(`${this.name}: Socket ready to send${readyIdx ? `from chunk ${readyIdx}` : ''}`);
+            // if server sent chunk index to resume from, move queue cursors appropriately
+            if (readyIdx !== undefined) {
+                this.queue.acknowledge(readyIdx - 1);
+                this.queue.revert(readyIdx);
+            }
+            this.ready = true;
+            // flush if any messages in queue for it
+            this.flush();
+            try {
+                // call post-ready method
+                yield ((_m = (_l = this.callbacks).onReady) === null || _m === void 0 ? void 0 : _m.call(_l, message.headers));
+            }
+            catch (err) {
+                // error occurred during initialization phase, send error right away, no "ready" message
+                this.wws.send({
+                    headers: {
+                        type: 'err',
+                        error: decodeErrorMessage(err),
+                    },
+                });
+            }
+        }));
+        this.wws.onBin((message) => __awaiter(this, void 0, void 0, function* () {
+            // received binary message
+            const { headers, body } = message;
+            try {
+                // check callback
+                const routeResults = this.callbacks.onBin.recognize(headers.route || '');
+                if (routeResults) {
+                    const handler = routeResults[0].handler;
+                    const params = routeResults[0].params;
+                    yield (handler === null || handler === void 0 ? void 0 : handler(body, headers, params));
+                }
+                // send back acknowledgment
+                this.wws.send({
+                    headers: {
+                        type: 'ack',
+                        ackIdx: headers.idx,
+                    },
+                });
+            }
+            catch (err) {
+                // error occurred during processing binary message, send error
+                this.wws.send({
+                    headers: {
+                        type: 'err',
+                        error: decodeErrorMessage(err),
+                    },
+                });
+            }
+        }));
+        this.wws.onJson((message) => __awaiter(this, void 0, void 0, function* () {
+            // received binary message
+            const { headers, body } = message;
+            try {
+                // check callback
+                const routeResults = this.callbacks.onJson.recognize(headers.route || '');
+                if (routeResults) {
+                    const handler = routeResults[0].handler;
+                    const params = routeResults[0].params;
+                    yield (handler === null || handler === void 0 ? void 0 : handler(body, headers, params));
+                }
+                // send back acknowledgment
+                this.wws.send({
+                    headers: {
+                        type: 'ack',
+                        ackIdx: headers.idx,
+                    },
+                });
+            }
+            catch (err) {
+                // error occurred during processing json message, send error
+                this.wws.send({
+                    headers: {
+                        type: 'err',
+                        error: decodeErrorMessage(err),
+                    },
+                });
+            }
+        }));
+        this.wws.onAck((message) => {
+            // acknowledgment received
+            this.queue.acknowledge(message.headers.ackIdx);
+            if (!this.queue.numUnackMessages && !this.needed) {
+                this.wws.close();
+            }
+        });
+        this.wws.onErr((message) => __awaiter(this, void 0, void 0, function* () {
+            var _o, _p;
+            // handle error
+            logger_1.default.error(`${this.name}: Error occurred: ${message.headers.error}`);
+            yield ((_p = (_o = this.callbacks).onError) === null || _p === void 0 ? void 0 : _p.call(_o, message.headers.error));
+        }));
+        this.wws.onWsClose(() => __awaiter(this, void 0, void 0, function* () {
+            var _q, _r, _s, _t, _u, _v, _w, _x;
+            if (reconnect && this.needed) {
+                // if locally closed, needed should be false
+                // if it's true, it means we lost the connection and should try to re-connect
+                logger_1.default.info(`${this.name}: Closed pre-maturely, trying to reconnect after ${reconnectIntervalMillis}ms...`);
+                setTimeout(() => this.setUp(), reconnectIntervalMillis);
+                yield ((_r = (_q = this.callbacks).onErroneousDisconnect) === null || _r === void 0 ? void 0 : _r.call(_q, 'Closed pre-maturely'));
+            }
+            else if (reconnect && this.queue.numUnackMessages) {
+                // if there are still messages left to be sent and we should reconnect
+                logger_1.default.info(`${this.name}: Closed with messages still in queue, reconnecting in ${reconnectIntervalMillis}ms...`);
+                setTimeout(() => this.setUp(), reconnectIntervalMillis);
+                yield ((_t = (_s = this.callbacks).onErroneousDisconnect) === null || _t === void 0 ? void 0 : _t.call(_s, 'Closed with messages still in queue'));
+            }
+            else if (this.queue.numUnackMessages) {
+                // if there are still messages left to be sent, but we should not reconnect
+                logger_1.default.info(`${this.name}: Closed with messages still in queue`);
+                yield ((_v = (_u = this.callbacks).onError) === null || _v === void 0 ? void 0 : _v.call(_u, 'Closed with messages still in queue'));
+            }
+            else {
+                // all is well
+                logger_1.default.info(`${this.name}: Closed correctly`);
+                yield ((_x = (_w = this.callbacks).onClose) === null || _x === void 0 ? void 0 : _x.call(_w));
+            }
+        }));
+    }
+    flush() {
+        // connection is not open
+        if (this.wws.readyState !== WebSocket.OPEN || !this.ready) {
+            return;
+        }
+        // there is at least one message
+        if (this.queue.numUnsentMessages) {
+            // pop a message
+            const [idx, data] = this.queue.consume();
+            logger_1.default.debug(`${this.name}: Sending chunk ${idx} of size ${data.size}`);
+            this.wws.sendRaw(data);
+            logger_1.default.debug(`${this.name}: MQ decreased to size ${this.queue.numUnsentMessages} messages / ${this.queue.numUnsentBytes} bytes`);
+            this.flush();
+        }
+        else {
+            logger_1.default.debug(`${this.name}: Flushing complete, no ws messages backed up`);
+            // if not needed anymore after flush, close it
+            // send close event to ws, don't de-cache yet, wait for event
+            if (!this.queue.numUnackMessages && !this.needed) {
+                this.wws.close();
+            }
+        }
+    }
+    send(body, extraHeaders = {}) {
+        return this.sendToRoute(undefined, body, extraHeaders);
+    }
+    sendToRoute(route, body, extraHeaders = {}) {
+        // encode into payload message based on body type
+        let message;
+        if (body instanceof Blob) {
+            message = {
+                headers: Object.assign({ type: 'bin', route }, extraHeaders),
+                body,
+            };
+        }
+        else {
+            message = {
+                headers: Object.assign({ type: 'json', route }, extraHeaders),
+                body,
+            };
+        }
+        // add message to fifo queue
+        const { numUnsentMessages } = this.queue;
+        const idx = this.queue.produce(message);
+        // ready state should either be CONNECTING or OPEN at this point to flush instantly
+        if (this.wws.readyState === WebSocket.OPEN && this.ready && !numUnsentMessages) {
+            this.flush();
+        }
+        return idx;
+    }
+    /**
+     * Closes WS and sets promise resolution as callback.
+     * Overwrites any manually set up callback for onClose.
+     */
+    close() {
+        return new Promise((resolve) => {
+            this.needed = false;
+            // wrap original onClose to resolve this promise
+            const { onClose } = this.callbacks;
+            this.callbacks.onClose = () => __awaiter(this, void 0, void 0, function* () {
+                yield (onClose === null || onClose === void 0 ? void 0 : onClose());
+                resolve();
+            });
+            // flush if any messages in queue
+            this.flush();
+        });
+    }
+}
+exports.default = QWebSocket;
+//# sourceMappingURL=queuews.js.map

package/dist/common/queuews.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queuews.js","sourceRoot":"","sources":["../../src/common/queuews.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,0DAAiC;AACjC,wEAA+C;AAgB/C,oDAA4C;AAC5C,qEAAoD;AACpD,+CAAoD;AACpD,sDAA8B;AAE9B,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAU,EAAE;IAC3C,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,EAAE;QAClB,OAAO,KAAK,CAAC,OAAO,CAAC;KACtB;IACD,IAAI,KAAK,EAAE;QACT,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;KACzB;IAED,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC;AAqBF,MAAM,WAAW,GAA+B;IAC9C,gBAAgB,EAAE,EAAE;IACpB,SAAS,EAAE,IAAI;IACf,iBAAiB,EAAE,EAAE;IACrB,uBAAuB,EAAE,IAAI;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAqB,UAAU;IAqB7B,YAAY,OAA2B,EAAE,UAA6B,EAAE;QACtE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,mCACP,WAAW,GACX,OAAO,CACX,CAAC;QAEF,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,WAAW,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG;YACf,KAAK,EAAE,IAAI,0BAAe,EAAE;YAC5B,MAAM,EAAE,IAAI,0BAAe,EAAE;SAC9B,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,IAAI,eAAqB,EAAE,CAAC;QACzC,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;QAChB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC;QAEf,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED;;OAEG;IAEH,SAAS,CAAC,QAAyB;QACjC,IAAI,CAAC,SAAS,CAAC,SAAS,GAAG,QAAQ,CAAC;IACtC,CAAC;IAED,UAAU,CAAC,YAAoB,EAAE,QAAqB;QACpD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,YAAsB,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IAClF,CAAC;IAED,KAAK,CAAC,QAAqB;QACzB,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IAChC,CAAC;IAED,WAAW,CAAI,YAAoB,EAAE,QAAyB;QAC5D,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,YAAsB,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IACnF,CAAC;IAED,MAAM,CAAI,QAAyB;QACjC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,CAAC,QAAuB;QAC7B,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,QAAQ,CAAC;IACpC,CAAC;IAED,qBAAqB,CAAC,QAAoB;QACxC,IAAI,CAAC,SAAS,CAAC,qBAAqB,GAAG,QAAQ,CAAC;IAClD,CAAC;IAED,OAAO,CAAC,QAAmC;QACzC,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,QAAQ,CAAC;IACpC,CAAC;IAED,OAAO,CAAC,QAAoB;QAC1B,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,QAAQ,CAAC;IACpC,CAAC;IAED;;OAEG;IAEH,kDAAkD;IAClD,KAAK;;QACH,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,EAAE;YACxC,OAAO;SACR;QAED,IAAI,CAAC,oBAAoB,IAAI,CAAC,CAAC;QAC/B,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAEjG,6CAA6C;QAC7C,IAAI,SAAS,IAAI,IAAI,CAAC,oBAAoB,GAAG,iBAAiB,EAAE;YAC9D,gBAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,oDAAoD,CAAC,CAAC;YAC/E,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,OAAO,mDAAG,qCAAqC,iBAAiB,YAAY,CAAC,CAAC;YAC7F,OAAO;SACR;QAED;;WAEG;QACH,IAAI,IAAI,CAAC,OAAO,YAAY,SAAS,IAAI,CAAA,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,WAAW,0CAAE,IAAI,MAAK,WAAW,EAAE;YACxF,MAAM,EAAE,GAAG,IAAI,CAAC,OAAoB,CAAC;YACrC,IAAI,CAAC,GAAG,GAAG,IAAI,mBAAgB,CAAC,EAAE,CAAC,CAAC;YACpC,+FAA+F;SAChG;aAAM;YACL,MAAM,UAAU,GAAG,IAAA,iCAAmB,EAAC,IAAI,CAAC,OAAO,kCAC9C,gBAAgB,KACnB,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,IACtB,CAAC;YACH,IAAI,CAAC,GAAG,GAAG,IAAI,mBAAgB,CAAC,UAAU,CAAC,CAAC;SAC7C;QAED,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAO,KAAK,EAAE,EAAE;;YACjC,+EAA+E;YAC/E,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,gBAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,wBAAwB,OAAO,EAAE,CAAC,CAAC;YAE5D,IAAI,SAAS,EAAE;gBACb,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,qBAAqB,mDAAG,OAAO,CAAC,CAAA,CAAC;aACvD;iBAAM;gBACL,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,OAAO,mDAAG,OAAO,CAAC,CAAA,CAAC;aACzC;QACH,CAAC,CAAA,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAS,EAAE;;YAC3B,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAC;YAC9B,IAAI,SAAS,EAAE;gBACb,gBAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,kCAAkC,IAAI,CAAC,oBAAoB,QAAQ,CAAC,CAAC;aAC9F;iBAAM;gBACL,gBAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,0BAA0B,CAAC,CAAC;aACrD;YAED,IAAI;gBACF,oEAAoE;gBACpE,MAAM,QAAQ,GAAG,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,SAAS,kDAAI,CAAA,CAAC;gBAEpD,0BAA0B;gBAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;oBACZ,OAAO,EAAE;wBACP,IAAI,EAAE,OAAO;wBACb,QAAQ;qBACT;iBACiB,CAAC,CAAC;aACvB;YAAC,OAAO,GAAG,EAAE;gBACZ,wFAAwF;gBACxF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;oBACZ,OAAO,EAAE;wBACP,IAAI,EAAE,KAAK;wBACX,KAAK,EAAE,kBAAkB,CAAC,GAAG,CAAC;qBAC/B;iBACiB,CAAC,CAAC;aACvB;QACH,CAAC,CAAA,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAO,OAAwB,EAAE,EAAE;;YAClD,kDAAkD;YAClD,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;YACrC,gBAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,yBAAyB,QAAQ,CAAC,CAAC,CAAC,cAAc,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAC7F,8EAA8E;YAC9E,IAAI,QAAQ,KAAK,SAAS,EAAE;gBAC1B,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;gBACrC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;aAC7B;YACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,wCAAwC;YACxC,IAAI,CAAC,KAAK,EAAE,CAAC;YAEb,IAAI;gBACF,yBAAyB;gBACzB,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,OAAO,mDAAG,OAAO,CAAC,OAAO,CAAC,CAAA,CAAC;aACjD;YAAC,OAAO,GAAG,EAAE;gBACZ,wFAAwF;gBACxF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;oBACZ,OAAO,EAAE;wBACP,IAAI,EAAE,KAAK;wBACX,KAAK,EAAE,kBAAkB,CAAC,GAAG,CAAC;qBAC/B;iBACiB,CAAC,CAAC;aACvB;QACH,CAAC,CAAA,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAO,OAAyB,EAAE,EAAE;YACjD,0BAA0B;YAC1B,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;YAElC,IAAI;gBACF,iBAAiB;gBACjB,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;gBACzE,IAAI,YAAY,EAAE;oBAChB,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,OAAsB,CAAC;oBACvD,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,MAAmB,CAAC;oBACnD,MAAM,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA,CAAC;iBACxC;gBAED,2BAA2B;gBAC3B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;oBACZ,OAAO,EAAE;wBACP,IAAI,EAAE,KAAK;wBACX,MAAM,EAAE,OAAO,CAAC,GAAG;qBACpB;iBACe,CAAC,CAAC;aACrB;YAAC,OAAO,GAAG,EAAE;gBACZ,8DAA8D;gBAC9D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;oBACZ,OAAO,EAAE;wBACP,IAAI,EAAE,KAAK;wBACX,KAAK,EAAE,kBAAkB,CAAC,GAAG,CAAC;qBAC/B;iBACiB,CAAC,CAAC;aACvB;QACH,CAAC,CAAA,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAO,OAAuB,EAAE,EAAE;YAChD,0BAA0B;YAC1B,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;YAElC,IAAI;gBACF,iBAAiB;gBACjB,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;gBAC1E,IAAI,YAAY,EAAE;oBAChB,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,OAAgC,CAAC;oBACjE,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,MAAmB,CAAC;oBACnD,MAAM,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA,CAAC;iBACxC;gBAED,2BAA2B;gBAC3B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;oBACZ,OAAO,EAAE;wBACP,IAAI,EAAE,KAAK;wBACX,MAAM,EAAE,OAAO,CAAC,GAAG;qBACpB;iBACe,CAAC,CAAC;aACrB;YAAC,OAAO,GAAG,EAAE;gBACZ,4DAA4D;gBAC5D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;oBACZ,OAAO,EAAE;wBACP,IAAI,EAAE,KAAK;wBACX,KAAK,EAAE,kBAAkB,CAAC,GAAG,CAAC;qBAC/B;iBACiB,CAAC,CAAC;aACvB;QACH,CAAC,CAAA,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAsB,EAAE,EAAE;YACxC,0BAA0B;YAC1B,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC/C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAChD,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;aAClB;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAO,OAAwB,EAAE,EAAE;;YAChD,eAAe;YACf,gBAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,qBAAqB,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;YACvE,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,OAAO,mDAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA,CAAC;QACxD,CAAC,CAAA,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAS,EAAE;;YAC5B,IAAI,SAAS,IAAI,IAAI,CAAC,MAAM,EAAE;gBAC5B,4CAA4C;gBAC5C,6EAA6E;gBAC7E,gBAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,oDAAoD,uBAAuB,OAAO,CAAC,CAAC;gBAC5G,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,uBAAuB,CAAC,CAAC;gBACxD,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,qBAAqB,mDAAG,qBAAqB,CAAC,CAAA,CAAC;aACrE;iBAAM,IAAI,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE;gBACnD,sEAAsE;gBACtE,gBAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,0DAA0D,uBAAuB,OAAO,CAAC,CAAC;gBAClH,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,uBAAuB,CAAC,CAAC;gBACxD,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,qBAAqB,mDAAG,qCAAqC,CAAC,CAAA,CAAC;aACrF;iBAAM,IAAI,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE;gBACtC,2EAA2E;gBAC3E,gBAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,uCAAuC,CAAC,CAAC;gBACjE,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,OAAO,mDAAG,qCAAqC,CAAC,CAAA,CAAC;aACvE;iBAAM;gBACL,cAAc;gBACd,gBAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,oBAAoB,CAAC,CAAC;gBAC9C,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,OAAO,kDAAI,CAAA,CAAC;aAClC;QACH,CAAC,CAAA,CAAC,CAAC;IACL,CAAC;IAED,KAAK;QACH,yBAAyB;QACzB,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACzD,OAAO;SACR;QAED,gCAAgC;QAChC,IAAI,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE;YAChC,gBAAgB;YAChB,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACzC,gBAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,mBAAmB,GAAG,YAAY,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YACxE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACvB,gBAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,0BAA0B,IAAI,CAAC,KAAK,CAAC,iBAAiB,eAAe,IAAI,CAAC,KAAK,CAAC,cAAc,QAAQ,CAAC,CAAC;YACjI,IAAI,CAAC,KAAK,EAAE,CAAC;SACd;aAAM;YACL,gBAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,+CAA+C,CAAC,CAAC;YAC1E,8CAA8C;YAC9C,6DAA6D;YAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAChD,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;aAClB;SACF;IACH,CAAC;IAED,IAAI,CAAC,IAAsC,EAAE,eAAuC,EAAE;QACpF,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACzD,CAAC;IAED,WAAW,CAAC,KAAa,EAAE,IAAsC,EAAE,eAAuC,EAAE;QAC1G,iDAAiD;QACjD,IAAI,OAA0B,CAAC;QAE/B,IAAI,IAAI,YAAY,IAAI,EAAE;YACxB,OAAO,GAAG;gBACR,OAAO,kBACL,IAAI,EAAE,KAAK,EACX,KAAK,IACF,YAAY,CAChB;gBACD,IAAI;aACe,CAAC;SACvB;aAAM;YACL,OAAO,GAAG;gBACR,OAAO,kBACL,IAAI,EAAE,MAAM,EACZ,KAAK,IACF,YAAY,CAChB;gBACD,IAAI;aACa,CAAC;SACrB;QAED,4BAA4B;QAC5B,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACzC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAExC,mFAAmF;QACnF,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,iBAAiB,EAAE;YAC9E,IAAI,CAAC,KAAK,EAAE,CAAC;SACd;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;YAEpB,gDAAgD;YAChD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC;YACnC,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,GAAS,EAAE;gBAClC,MAAM,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,EAAI,CAAA,CAAC;gBAClB,OAAO,EAAE,CAAC;YACZ,CAAC,CAAA,CAAC;YAEF,iCAAiC;YACjC,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAnXD,6BAmXC"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import QWebSocket from './common/queuews';
+export * from './common/logger';
+export * from './common/message';
+export * from './common/queuews';
+export * from './browser/messageencode';
+export default QWebSocket;

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const queuews_1 = __importDefault(require("./common/queuews"));
+__exportStar(require("./common/logger"), exports);
+__exportStar(require("./common/message"), exports);
+__exportStar(require("./common/queuews"), exports);
+__exportStar(require("./browser/messageencode"), exports);
+exports.default = queuews_1.default;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA0C;AAE1C,kDAAgC;AAChC,mDAAiC;AACjC,mDAAiC;AACjC,0DAAwC;AAExC,kBAAe,iBAAU,CAAC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "qws-browser",
+  "version": "1.0.1",
+  "description": "Safe queueing with auto-reconnect for WebSockets",
+  "author": "Csaba Sulyok <csaba.sulyok@gmail.com>",
+  "license": "ISC",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/csabasulyok/qws-browser.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "auto-bind": "^4.0.0",
+    "route-recognizer": "^0.3.4"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^4.29.3",
+    "@typescript-eslint/parser": "^4.29.3",
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb": "^18.2.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-import-resolver-typescript": "^2.4.0",
+    "eslint-plugin-import": "^2.24.1",
+    "eslint-plugin-prettier": "^3.4.1",
+    "nodemon": "^2.0.12",
+    "prettier": "^2.3.2",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.3.5"
+  },
+  "lint-staged": {
+    "*.{js,ts,jsx,tsx}": [
+      "npm run lint",
+      "git add"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "nodemonConfig": {
+    "watch": [
+      ".env",
+      "src/*.*",
+      "examples/*.*"
+    ]
+  },
+  "scripts": {
+    "clean": "rimraf dist *.tsbuildinfo",
+    "build": "tsc -p tsconfig.build.json",
+    "cb": "pnpm clean && pnpm build",
+    "lint": "eslint 'src/**/*.{js,ts,jsx,tsx}' --quiet --fix"
+  }
+}