qws-browser 1.1.1 → 2.1.0

package/dist/common/queryparser.js

@@ -1,85 +1,9 @@
-"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) => {
+// add query parameters to URL
+export const addQueryParamsToUrl = (urlString, params) => {
     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;
+    for (const [key, val] of Object.entries(params)) {
+        url.searchParams.set(key, String(val));
     }
-    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();
+    return url.href;
 };
-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,8BAA8B;AAC9B,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,SAAiB,EAAE,MAA+B,EAAU,EAAE;IAChG,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IAE/B,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,CAAC;IAED,OAAO,GAAG,CAAC,IAAI,CAAC;AAClB,CAAC,CAAC"}

package/dist/common/queue.d.ts

@@ -1,12 +1,12 @@
-import { PayloadQwsMessage } from './message';
-import { Binary } from './discriminator';
+import { PayloadQwsMessage } from './message.js';
+import { Binary } from './discriminator.js';
 /**
  * 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>;
+    messages: Map<number, Binary>;
     readIdx: number;
     ackIdx: number;
     writeIdx: number;
@@ -33,3 +33,4 @@ export default class QwsMessageQueue {
      */
     revert(idx: number): void;
 }
+//# sourceMappingURL=queue.d.ts.map

package/dist/common/queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../../src/common/queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;;IActB;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,iBAAiB,GAAG,MAAM;IAe3C;;;OAGG;IACH,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;IAU3B;;OAEG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAS9B;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAO1B"}

package/dist/common/queue.js

@@ -1,14 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const messageencode_1 = require("../browser/messageencode");
+import { serializeMessage } from '../browser/messageencode.js';
 /**
  * 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 {
+export default class QwsMessageQueue {
     constructor() {
-        this.messages = {};
+        this.messages = new Map();
         this.readIdx = 0;
         this.ackIdx = 0;
         this.writeIdx = 0;
@@ -23,8 +21,8 @@ class QwsMessageQueue {
     produce(message) {
         const idx = this.writeIdx;
         message.headers.idx = idx;
-        const data = (0, messageencode_1.serializeMessage)(message);
-        this.messages[idx] = data;
+        const data = serializeMessage(message);
+        this.messages.set(idx, data);
         this.numUnsentMessages += 1;
         this.numUnsentBytes += data.size;
         this.numUnackMessages += 1;
@@ -38,7 +36,7 @@ class QwsMessageQueue {
      */
     consume() {
         const idx = this.readIdx;
-        const ret = this.messages[idx];
+        const ret = this.messages.get(idx);
         this.numUnsentMessages -= 1;
         this.numUnsentBytes -= ret.size;
         this.readIdx += 1;
@@ -50,8 +48,8 @@ class QwsMessageQueue {
     acknowledge(idx) {
         while (this.ackIdx <= idx) {
             this.numUnackMessages -= 1;
-            this.numUnackBytes -= this.messages[this.ackIdx].size;
-            delete this.messages[this.ackIdx];
+            this.numUnackBytes -= this.messages.get(this.ackIdx).size;
+            this.messages.delete(this.ackIdx);
             this.ackIdx += 1;
         }
     }
@@ -62,8 +60,8 @@ class QwsMessageQueue {
         while (this.readIdx > idx) {
             this.readIdx -= 1;
             this.numUnsentMessages += 1;
-            this.numUnsentBytes += this.messages[this.readIdx].size;
+            this.numUnsentBytes += this.messages.get(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,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAG/D;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAWlC;QACE,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1B,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,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAE7B,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,GAAG,CAAE,CAAC;QAEpC,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,CAAC;YAC1B,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;YAC3B,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAE,CAAC,IAAI,CAAC;YAC3D,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAW;QAChB,OAAO,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC;YAC1B,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;YAClB,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAE,CAAC,IAAI,CAAC;QAC/D,CAAC;IACH,CAAC;CACF"}

package/dist/common/queuews.d.ts

@@ -1,24 +1,29 @@
-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';
+import RouteRecognizer from './router.js';
+import { Binary } from './discriminator.js';
+import { QwsMessageExtraHeaders, BinaryQwsMessageHeaders, JsonQwsMessageHeaders, ReadyQwsMessageHeaders, QwsParams } from './message.js';
+import WebSocketMessageQueue from './queue.js';
+import WrappedWebSocket from '../browser/wrappedws.js';
 /**
  * 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>;
+export type ConnectCallback = () => void | number | Promise<void> | Promise<number>;
+export type BinCallback = (body: Binary, headers?: BinaryQwsMessageHeaders, params?: QwsParams) => void | Promise<void>;
+export type JsonCallback<T> = (body: T, headers?: JsonQwsMessageHeaders, params?: QwsParams) => void | Promise<void>;
+export type ReadyCallback = (headers?: ReadyQwsMessageHeaders) => void | Promise<void>;
 /**
  * Connection options
  */
-declare type QWebSocketOptions = {
+export type QWebSocketOptions = {
     name?: string;
     extraConnectArgs?: Record<string, unknown>;
     reconnect?: boolean;
     reconnectNumTries?: number;
     reconnectIntervalMillis?: number;
+    /**
+     * Interval of heartbeats detecting dead connections, 0 disables them.
+     * A connection is terminated if nothing arrives during a whole interval after a heartbeat.
+     */
+    heartbeatIntervalMillis?: number;
 };
 /**
  * Actual queued WebSocket
@@ -32,6 +37,14 @@ export default class QWebSocket {
     needed: boolean;
     wws: WrappedWebSocket;
     ready: boolean;
+    closed: boolean;
+    heartbeatTimer?: ReturnType<typeof setInterval>;
+    heartbeatSentAt: number;
+    heartbeatConfirmed: boolean;
+    pendingAcks: Map<number, {
+        resolve: () => void;
+        reject: (error: Error) => void;
+    }>;
     callbacks: {
         onConnect?: ConnectCallback;
         onBin: RouteRecognizer;
@@ -58,13 +71,29 @@ export default class QWebSocket {
      * Main logic
      */
     setUp(): void;
+    /**
+     * Heartbeat: if nothing (not even its answer) arrived since the previous heartbeat,
+     * the connection is dead and is terminated, which triggers the usual close/reconnect logic.
+     * Checking per tick instead of measuring time since the last message
+     * tolerates throttled timers in background browser tabs.
+     */
+    private startHeartbeat;
+    private stopHeartbeat;
+    /**
+     * Resolves once the other side acknowledged the message with the given index (returned by send/sendToRoute).
+     * Rejects if the connection is closed for good before that.
+     * Reconnecting connections keep and resend their unacknowledged messages, so they don't reject on reconnect.
+     */
+    waitForAck(idx: number): Promise<void>;
+    private acknowledge;
+    private rejectPendingAcks;
     flush(): void;
     send(body: Binary | Record<string, unknown>, extraHeaders?: QwsMessageExtraHeaders): number;
-    sendToRoute(route: string, body: Binary | Record<string, unknown>, extraHeaders?: QwsMessageExtraHeaders): number;
+    sendToRoute(route: string | undefined, 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 {};
+//# sourceMappingURL=queuews.d.ts.map

package/dist/common/queuews.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queuews.d.ts","sourceRoot":"","sources":["../../src/common/queuews.ts"],"names":[],"mappings":"AACA,OAAO,eAAe,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAOL,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,SAAS,EACV,MAAM,cAAc,CAAC;AACtB,OAAO,qBAAqB,MAAM,YAAY,CAAC;AAC/C,OAAO,gBAAgB,MAAM,yBAAyB,CAAC;AAcvD;;GAEG;AAEH,MAAM,MAAM,eAAe,GAAG,MAAM,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AACpF,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,EAAE,MAAM,CAAC,EAAE,SAAS,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACxH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,SAAS,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACrH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,CAAC,EAAE,sBAAsB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC,CAAC;AAUF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,iBAAiB,CAAC;IAE3B,KAAK,EAAE,qBAAqB,CAAC;IAC7B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,EAAE,gBAAgB,CAAC;IACtB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAEhB,cAAc,CAAC,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;IAChD,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;IAE5B,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,IAAI,CAAC;QAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;KAAE,CAAC,CAAC;IAElF,SAAS,EAAE;QACT,SAAS,CAAC,EAAE,eAAe,CAAC;QAC5B,KAAK,EAAE,eAAe,CAAC;QACvB,MAAM,EAAE,eAAe,CAAC;QACxB,OAAO,CAAC,EAAE,aAAa,CAAC;QACxB,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAClE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACpD,OAAO,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KACtC,CAAC;gBAEU,OAAO,EAAE,SAAS,GAAG,MAAM,EAAE,OAAO,GAAE,iBAAsB;IA0BxE;;OAEG;IAEH,SAAS,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAI1C,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,IAAI;IAI7D,KAAK,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI;IAIlC,WAAW,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI;IAIrE,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI;IAI1C,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAItC,qBAAqB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAIjD,OAAO,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAIlD,OAAO,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAInC;;OAEG;IAGH,KAAK,IAAI,IAAI;IA0Nb;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IA0BtB,OAAO,CAAC,aAAa;IAKrB;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYtC,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,iBAAiB;IAQzB,KAAK,IAAI,IAAI;IA0Bb,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAE,sBAA2B,GAAG,MAAM;IAI/F,WAAW,CACT,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACtC,YAAY,GAAE,sBAA2B,GACxC,MAAM;IAoCT;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAevB"}