websocket-ts 1.1.1 → 2.1.2

package/dist/cjs/src/backoff/linearbackoff.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinearBackoff = void 0;
+/**
+ * LinearBackoff returns a backoff-time that is incremented by a fixed amount
+ * with every step/retry. An optional maximum can be provided as an upper bound
+ * to the returned backoff.
+ *
+ * The series can be described as ('i' is the current step/retry):
+ *   backoff = initial + increment * i                | without bound
+ *   backoff = initial + increment * min(i, max)      | with bound
+ *
+ * Example:
+ *
+ * 1) Without bound:
+ *  initial = 1000, increment = 1000
+ *  backoff = 1000 + 1000 * 0 = 1000 // first retry
+ *  backoff = 1000 + 1000 * 1 = 2000 // second retry
+ *  backoff = 1000 + 1000 * 2 = 3000 // ...increases by 'increment' with every retry
+ *  backoff = 1000 + 1000 * 3 = 4000
+ *  backoff = 1000 + 1000 * 4 = 5000
+ *  ... // and so on
+ *
+ *  2) With bound:
+ *  initial = 1000, increment = 1000, max = 5000
+ *  backoff = 1000 + 1000 * 0 = 1000 // first retry
+ *  backoff = 1000 + 1000 * 1 = 2000 // second retry
+ *  backoff = 1000 + 1000 * 2 = 3000 // third retry
+ *  backoff = 1000 + 1000 * 3 = 4000 // fourth retry
+ *  backoff = 1000 + 1000 * 4 = 5000 // maximum reached, don't increase further
+ *  backoff = 1000 + 1000 * 4 = 5000
+ *  backoff = 1000 + 1000 * 4 = 5000
+ *  ... // and so on
+ */
+var LinearBackoff = /** @class */ (function () {
+    /**
+     * Creates a new LinearBackoff.
+     * @param initial the initial backoff-time in milliseconds
+     * @param increment the amount to increment the backoff-time with every step (in milliseconds)
+     * @param max the maximum backoff-time (in milliseconds), no bound if undefined
+     */
+    function LinearBackoff(initial, increment, max) {
+        this.i = 0;
+        this._retries = 0;
+        if (initial < 0) {
+            throw new Error("Initial must be a positive number or zero");
+        }
+        if (increment < 0) {
+            throw new Error("Increment must be a positive number or zero");
+        }
+        if (max !== undefined && max < 0) {
+            throw new Error("Max must be undefined, a positive number or zero");
+        }
+        if (max !== undefined && max < initial) {
+            throw new Error("Max must be undefined or greater than or equal to initial");
+        }
+        this.initial = initial;
+        this.increment = increment;
+        this.max = max;
+    }
+    Object.defineProperty(LinearBackoff.prototype, "retries", {
+        get: function () {
+            return this._retries;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(LinearBackoff.prototype, "current", {
+        get: function () {
+            return this.max === undefined
+                ? this.initial + this.increment * this.i
+                : Math.min(this.initial + this.increment * this.i, this.max);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    LinearBackoff.prototype.next = function () {
+        this._retries++;
+        this.i++;
+        return this.current;
+    };
+    LinearBackoff.prototype.reset = function () {
+        this._retries = 0;
+        this.i = 0;
+    };
+    return LinearBackoff;
+}());
+exports.LinearBackoff = LinearBackoff;
+//# sourceMappingURL=linearbackoff.js.map

package/dist/cjs/src/backoff/linearbackoff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linearbackoff.js","sourceRoot":"","sources":["../../../../src/backoff/linearbackoff.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH;IAOE;;;;;OAKG;IACH,uBAAY,OAAe,EAAE,SAAiB,EAAE,GAAY;QATpD,MAAC,GAAW,CAAC,CAAC;QACd,aAAQ,GAAW,CAAC,CAAC;QAS3B,IAAI,OAAO,GAAG,CAAC,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;SAC9D;QACD,IAAI,SAAS,GAAG,CAAC,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;SAChE;QACD,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,CAAC,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACrE;QACD,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,OAAO,EAAE;YACtC,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAC;SACH;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED,sBAAI,kCAAO;aAAX;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;;;OAAA;IAED,sBAAI,kCAAO;aAAX;YACE,OAAO,IAAI,CAAC,GAAG,KAAK,SAAS;gBAC3B,CAAC,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;gBACxC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACjE,CAAC;;;OAAA;IAED,4BAAI,GAAJ;QACE,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,IAAI,CAAC,CAAC,EAAE,CAAC;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,6BAAK,GAAL;QACE,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAClB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IACH,oBAAC;AAAD,CAAC,AAtDD,IAsDC;AAtDY,sCAAa"}

package/dist/cjs/src/index.d.ts

@@ -0,0 +1,14 @@
+export { Backoff } from "./backoff/backoff";
+export { ConstantBackoff } from "./backoff/constantbackoff";
+export { ExponentialBackoff } from "./backoff/exponentialbackoff";
+export { LinearBackoff } from "./backoff/linearbackoff";
+export { Queue } from "./queue/queue";
+export { ArrayQueue } from "./queue/array_queue";
+export { RingQueue } from "./queue/ring_queue";
+export { Websocket } from "./websocket";
+export { WebsocketBuffer } from "./websocket_buffer";
+export { WebsocketBuilder } from "./websocket_builder";
+export { WebsocketEvent, RetryEventDetail, ReconnectEventDetail, WebsocketEventMap, WebsocketEventListener, WebsocketEventListenerParams, WebsocketEventListenerOptions, WebsocketEventListenerWithOptions, WebsocketEventListeners, } from "./websocket_event";
+export { WebsocketOptions } from "./websocket_options";
+export { WebsocketConnectionRetryOptions } from "./websocket_retry_options";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,iBAAiB,EACjB,sBAAsB,EACtB,4BAA4B,EAC5B,6BAA6B,EAC7B,iCAAiC,EACjC,uBAAuB,GACxB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,+BAA+B,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/cjs/src/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsocketEvent = exports.WebsocketBuilder = exports.Websocket = exports.RingQueue = exports.ArrayQueue = exports.LinearBackoff = exports.ExponentialBackoff = exports.ConstantBackoff = void 0;
+var constantbackoff_1 = require("./backoff/constantbackoff");
+Object.defineProperty(exports, "ConstantBackoff", { enumerable: true, get: function () { return constantbackoff_1.ConstantBackoff; } });
+var exponentialbackoff_1 = require("./backoff/exponentialbackoff");
+Object.defineProperty(exports, "ExponentialBackoff", { enumerable: true, get: function () { return exponentialbackoff_1.ExponentialBackoff; } });
+var linearbackoff_1 = require("./backoff/linearbackoff");
+Object.defineProperty(exports, "LinearBackoff", { enumerable: true, get: function () { return linearbackoff_1.LinearBackoff; } });
+var array_queue_1 = require("./queue/array_queue");
+Object.defineProperty(exports, "ArrayQueue", { enumerable: true, get: function () { return array_queue_1.ArrayQueue; } });
+var ring_queue_1 = require("./queue/ring_queue");
+Object.defineProperty(exports, "RingQueue", { enumerable: true, get: function () { return ring_queue_1.RingQueue; } });
+var websocket_1 = require("./websocket");
+Object.defineProperty(exports, "Websocket", { enumerable: true, get: function () { return websocket_1.Websocket; } });
+var websocket_builder_1 = require("./websocket_builder");
+Object.defineProperty(exports, "WebsocketBuilder", { enumerable: true, get: function () { return websocket_builder_1.WebsocketBuilder; } });
+var websocket_event_1 = require("./websocket_event");
+Object.defineProperty(exports, "WebsocketEvent", { enumerable: true, get: function () { return websocket_event_1.WebsocketEvent; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":";;;AACA,6DAA4D;AAAnD,kHAAA,eAAe,OAAA;AACxB,mEAAkE;AAAzD,wHAAA,kBAAkB,OAAA;AAC3B,yDAAwD;AAA/C,8GAAA,aAAa,OAAA;AAEtB,mDAAiD;AAAxC,yGAAA,UAAU,OAAA;AACnB,iDAA+C;AAAtC,uGAAA,SAAS,OAAA;AAClB,yCAAwC;AAA/B,sGAAA,SAAS,OAAA;AAElB,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,qDAU2B;AATzB,iHAAA,cAAc,OAAA"}

package/dist/cjs/src/queue/array_queue.d.ts

@@ -0,0 +1,17 @@
+import { Queue } from "./queue";
+/**
+ * An array queue is a queue that has an unbounded capacity. Reading from an array queue
+ * will return the oldest element and effectively remove it from the queue.
+ */
+export declare class ArrayQueue<E> implements Queue<E> {
+    private readonly elements;
+    constructor();
+    add(element: E): void;
+    clear(): void;
+    forEach(fn: (element: E) => unknown): void;
+    length(): number;
+    isEmpty(): boolean;
+    peek(): E | undefined;
+    read(): E | undefined;
+}
+//# sourceMappingURL=array_queue.d.ts.map

package/dist/cjs/src/queue/array_queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array_queue.d.ts","sourceRoot":"","sources":["../../../../src/queue/array_queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;GAGG;AACH,qBAAa,UAAU,CAAC,CAAC,CAAE,YAAW,KAAK,CAAC,CAAC,CAAC;IAC5C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAM;;IAM/B,GAAG,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI;IAIrB,KAAK;IAIL,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO;IAInC,MAAM,IAAI,MAAM;IAIhB,OAAO,IAAI,OAAO;IAIlB,IAAI,IAAI,CAAC,GAAG,SAAS;IAIrB,IAAI,IAAI,CAAC,GAAG,SAAS;CAGtB"}

package/dist/cjs/src/queue/array_queue.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArrayQueue = void 0;
+/**
+ * An array queue is a queue that has an unbounded capacity. Reading from an array queue
+ * will return the oldest element and effectively remove it from the queue.
+ */
+var ArrayQueue = /** @class */ (function () {
+    function ArrayQueue() {
+        this.elements = [];
+    }
+    ArrayQueue.prototype.add = function (element) {
+        this.elements.push(element);
+    };
+    ArrayQueue.prototype.clear = function () {
+        this.elements.length = 0;
+    };
+    ArrayQueue.prototype.forEach = function (fn) {
+        this.elements.forEach(fn);
+    };
+    ArrayQueue.prototype.length = function () {
+        return this.elements.length;
+    };
+    ArrayQueue.prototype.isEmpty = function () {
+        return this.elements.length === 0;
+    };
+    ArrayQueue.prototype.peek = function () {
+        return this.elements[0];
+    };
+    ArrayQueue.prototype.read = function () {
+        return this.elements.shift();
+    };
+    return ArrayQueue;
+}());
+exports.ArrayQueue = ArrayQueue;
+//# sourceMappingURL=array_queue.js.map

package/dist/cjs/src/queue/array_queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array_queue.js","sourceRoot":"","sources":["../../../../src/queue/array_queue.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH;IAGE;QACE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACrB,CAAC;IAED,wBAAG,GAAH,UAAI,OAAU;QACZ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED,0BAAK,GAAL;QACE,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,4BAAO,GAAP,UAAQ,EAA2B;QACjC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;IAED,2BAAM,GAAN;QACE,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,4BAAO,GAAP;QACE,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,yBAAI,GAAJ;QACE,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAED,yBAAI,GAAJ;QACE,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IACH,iBAAC;AAAD,CAAC,AAlCD,IAkCC;AAlCY,gCAAU"}

package/dist/cjs/src/queue/queue.d.ts

@@ -0,0 +1,41 @@
+/**
+ * A queue holds elements until they are read. The order in which elements are
+ * read is determined by the implementation of the queue.
+ */
+export interface Queue<E> {
+    /**
+     * Adds an element to the queue.
+     * @param element the element to add
+     */
+    add(element: E): void;
+    /**
+     * Clears the queue, removing all elements.
+     */
+    clear(): void;
+    /**
+     * Calls the given function for each element in the queue.
+     * @param fn the function to call
+     */
+    forEach(fn: (element: E) => unknown): void;
+    /**
+     * Number of elements in the queue.
+     * @return the number of elements in the queue
+     */
+    length(): number;
+    /**
+     * Whether the queue is empty.
+     * @return true if the queue is empty, false otherwise
+     */
+    isEmpty(): boolean;
+    /**
+     * Returns the next element in the queue without removing it.
+     * @return the next element in the queue, or undefined if the queue is empty
+     */
+    peek(): E | undefined;
+    /**
+     * Removes and returns the next element in the queue.
+     * @return the next element in the queue, or undefined if the queue is empty
+     */
+    read(): E | undefined;
+}
+//# sourceMappingURL=queue.d.ts.map

package/dist/cjs/src/queue/queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../../../../src/queue/queue.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC;IACtB;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,CAAC;IAE3C;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC;IAEnB;;;OAGG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS,CAAC;IAEtB;;;OAGG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS,CAAC;CACvB"}

package/{lib/buffer/buffer.js → dist/cjs/src/queue/queue.js}

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

package/dist/cjs/src/queue/queue.js.map

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

package/dist/cjs/src/queue/ring_queue.d.ts

@@ -0,0 +1,20 @@
+import { Queue } from "./queue";
+/**
+ * A ring queue is a queue that has a fixed capacity. When the queue is full, the oldest element is
+ * removed to make room for the new element. Reading from a ring queue will return the oldest
+ * element and effectively remove it from the queue.
+ */
+export declare class RingQueue<E> implements Queue<E> {
+    private readonly elements;
+    private head;
+    private tail;
+    constructor(capacity: number);
+    add(element: E): void;
+    clear(): void;
+    forEach(fn: (element: E) => unknown): void;
+    length(): number;
+    isEmpty(): boolean;
+    peek(): E | undefined;
+    read(): E | undefined;
+}
+//# sourceMappingURL=ring_queue.d.ts.map

package/dist/cjs/src/queue/ring_queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ring_queue.d.ts","sourceRoot":"","sources":["../../../../src/queue/ring_queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;GAIG;AACH,qBAAa,SAAS,CAAC,CAAC,CAAE,YAAW,KAAK,CAAC,CAAC,CAAC;IAC3C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAM;IAC/B,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,IAAI,CAAS;gBAET,QAAQ,EAAE,MAAM;IAU5B,GAAG,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI;IAQrB,KAAK;IAKL,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO;IAUnC,MAAM,IAAI,MAAM;IAQhB,OAAO,IAAI,OAAO;IAIlB,IAAI,IAAI,CAAC,GAAG,SAAS;IAIrB,IAAI,IAAI,CAAC,GAAG,SAAS;CAOtB"}

package/dist/cjs/src/queue/ring_queue.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RingQueue = void 0;
+/**
+ * A ring queue is a queue that has a fixed capacity. When the queue is full, the oldest element is
+ * removed to make room for the new element. Reading from a ring queue will return the oldest
+ * element and effectively remove it from the queue.
+ */
+var RingQueue = /** @class */ (function () {
+    function RingQueue(capacity) {
+        if (!Number.isInteger(capacity) || capacity <= 0) {
+            throw new Error("Capacity must be a positive integer");
+        }
+        this.elements = new Array(capacity + 1); // +1 to distinguish between full and empty
+        this.head = 0;
+        this.tail = 0;
+    }
+    RingQueue.prototype.add = function (element) {
+        this.elements[this.head] = element;
+        this.head = (this.head + 1) % this.elements.length;
+        if (this.head === this.tail) {
+            this.tail = (this.tail + 1) % this.elements.length;
+        }
+    };
+    RingQueue.prototype.clear = function () {
+        this.head = 0;
+        this.tail = 0;
+    };
+    RingQueue.prototype.forEach = function (fn) {
+        for (var i = this.tail; i !== this.head; i = (i + 1) % this.elements.length) {
+            fn(this.elements[i]);
+        }
+    };
+    RingQueue.prototype.length = function () {
+        return this.tail === this.head
+            ? 0
+            : this.tail < this.head
+                ? this.head - this.tail
+                : this.elements.length - this.tail + this.head;
+    };
+    RingQueue.prototype.isEmpty = function () {
+        return this.head === this.tail;
+    };
+    RingQueue.prototype.peek = function () {
+        return this.isEmpty() ? undefined : this.elements[this.tail];
+    };
+    RingQueue.prototype.read = function () {
+        var e = this.peek();
+        if (e !== undefined) {
+            this.tail = (this.tail + 1) % this.elements.length;
+        }
+        return e;
+    };
+    return RingQueue;
+}());
+exports.RingQueue = RingQueue;
+//# sourceMappingURL=ring_queue.js.map

package/dist/cjs/src/queue/ring_queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ring_queue.js","sourceRoot":"","sources":["../../../../src/queue/ring_queue.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACH;IAKE,mBAAY,QAAgB;QAC1B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,IAAI,CAAC,EAAE;YAChD,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;SACxD;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,KAAK,CAAI,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,2CAA2C;QACvF,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IAChB,CAAC;IAED,uBAAG,GAAH,UAAI,OAAU;QACZ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QACnD,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;YAC3B,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;SACpD;IACH,CAAC;IAED,yBAAK,GAAL;QACE,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IAChB,CAAC;IAED,2BAAO,GAAP,UAAQ,EAA2B;QACjC,KACE,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,EACjB,CAAC,KAAK,IAAI,CAAC,IAAI,EACf,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAClC;YACA,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;SACtB;IACH,CAAC;IAED,0BAAM,GAAN;QACE,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;YAC5B,CAAC,CAAC,CAAC;YACH,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI;gBACvB,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI;gBACvB,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACnD,CAAC;IAED,2BAAO,GAAP;QACE,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC;IACjC,CAAC;IAED,wBAAI,GAAJ;QACE,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,wBAAI,GAAJ;QACE,IAAM,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACtB,IAAI,CAAC,KAAK,SAAS,EAAE;YACnB,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;SACpD;QACD,OAAO,CAAC,CAAC;IACX,CAAC;IACH,gBAAC;AAAD,CAAC,AA7DD,IA6DC;AA7DY,8BAAS"}

package/dist/cjs/src/websocket.d.ts

@@ -0,0 +1,206 @@
+import { Backoff } from "./backoff/backoff";
+import { WebsocketBuffer } from "./websocket_buffer";
+import { WebsocketEvent, WebsocketEventListener, WebsocketEventListenerOptions } from "./websocket_event";
+import { WebsocketOptions } from "./websocket_options";
+/**
+ * A websocket wrapper that can be configured to reconnect automatically and buffer messages when the websocket is not connected.
+ */
+export declare class Websocket {
+    private readonly _url;
+    private readonly _protocols?;
+    private _closedByUser;
+    private _lastConnection?;
+    private _underlyingWebsocket;
+    private retryTimeout?;
+    private _options;
+    /**
+     * Creates a new websocket.
+     *
+     * @param url to connect to.
+     * @param protocols optional protocols to use.
+     * @param options optional options to use.
+     */
+    constructor(url: string, protocols?: string | string[], options?: WebsocketOptions);
+    /**
+     * Getter for the url.
+     *
+     * @return the url.
+     */
+    get url(): string;
+    /**
+     * Getter for the protocols.
+     *
+     * @return the protocols, or undefined if none were provided.
+     */
+    get protocols(): string | string[] | undefined;
+    /**
+     * Getter for the buffer.
+     *
+     * @return the buffer, or undefined if none was provided.
+     */
+    get buffer(): WebsocketBuffer | undefined;
+    /**
+     * Getter for the maxRetries.
+     *
+     * @return the maxRetries, or undefined if none was provided (no limit).
+     */
+    get maxRetries(): number | undefined;
+    /**
+     * Getter for the instantReconnect.
+     *
+     * @return the instantReconnect, or undefined if none was provided.
+     */
+    get instantReconnect(): boolean | undefined;
+    /**
+     * Getter for the backoff.
+     *
+     * @return the backoff, or undefined if none was provided.
+     */
+    get backoff(): Backoff | undefined;
+    /**
+     * Whether the websocket was closed by the user. A websocket is closed by the user if the close().
+     *
+     * @return true if the websocket was closed by the user, false otherwise.
+     */
+    get closedByUser(): boolean;
+    /**
+     * Getter for the last 'open' event, e.g. the last time the websocket was connected.
+     *
+     * @return the last 'open' event, or undefined if the websocket was never connected.
+     */
+    get lastConnection(): Date | undefined;
+    /**
+     * Getter for the underlying websocket. This can be used to access the browser's native websocket directly.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
+     * @return the underlying websocket.
+     */
+    get underlyingWebsocket(): WebSocket;
+    /**
+     * Getter for the readyState of the underlying websocket.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState
+     * @return the readyState of the underlying websocket.
+     */
+    get readyState(): number;
+    /**
+     * Getter for the bufferedAmount of the underlying websocket.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/bufferedAmount
+     * @return the bufferedAmount of the underlying websocket.
+     */
+    get bufferedAmount(): number;
+    /**
+     * Getter for the extensions of the underlying websocket.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/extensions
+     * @return the extensions of the underlying websocket.
+     */
+    get extensions(): string;
+    /**
+     * Getter for the binaryType of the underlying websocket.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/binaryType
+     * @return the binaryType of the underlying websocket.
+     */
+    get binaryType(): BinaryType;
+    /**
+     * Setter for the binaryType of the underlying websocket.
+     *
+     * @param value to set, 'blob' or 'arraybuffer'.
+     */
+    set binaryType(value: BinaryType);
+    /**
+     * Sends data over the websocket.
+     *
+     * If the websocket is not connected and a buffer was provided on creation, the data will be added to the buffer.
+     * If no buffer was provided or the websocket was closed by the user, the data will be dropped.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/send
+     * @param data to send.
+     */
+    send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void;
+    /**
+     * Close the websocket. No connection-retry will be attempted after this.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close
+     * @param code optional close code.
+     * @param reason optional close reason.
+     */
+    close(code?: number, reason?: string): void;
+    /**
+     * Adds an event listener for the given event-type.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
+     * @param type of the event to add the listener for.
+     * @param listener to add.
+     * @param options to use when adding the listener.
+     */
+    addEventListener<K extends WebsocketEvent>(type: K, listener: WebsocketEventListener<K>, options?: WebsocketEventListenerOptions): void;
+    /**
+     * Removes one or more event listener for the given event-type that match the given listener and options.
+     *
+     * @param type of the event to remove the listener for.
+     * @param listener to remove.
+     * @param options that were used when the listener was added.
+     */
+    removeEventListener<K extends WebsocketEvent>(type: K, listener: WebsocketEventListener<K>, options?: WebsocketEventListenerOptions): void;
+    /**
+     * Creates a new browser-native websocket and connects it to the given URL with the given protocols
+     * and adds all event listeners to the browser-native websocket.
+     *
+     * @return the created browser-native websocket which is also stored in the '_underlyingWebsocket' property.
+     */
+    private tryConnect;
+    /**
+     * Removes all event listeners from the browser-native websocket and closes it.
+     */
+    private clearWebsocket;
+    /**
+     * Handles the 'open' event of the browser-native websocket.
+     * @param event to handle.
+     */
+    private handleOpenEvent;
+    /**
+     * Handles the 'error' event of the browser-native websocket.
+     * @param event to handle.
+     */
+    private handleErrorEvent;
+    /**
+     * Handles the 'close' event of the browser-native websocket.
+     * @param event to handle.
+     */
+    private handleCloseEvent;
+    /**
+     * Handles the 'message' event of the browser-native websocket.
+     * @param event to handle.
+     */
+    private handleMessageEvent;
+    /**
+     * Dispatch an event to all listeners of the given event-type.
+     *
+     * @param type of the event to dispatch.
+     * @param event to dispatch.
+     */
+    private dispatchEvent;
+    /**
+     * Handles the given event by dispatching it to all listeners of the given event-type.
+     *
+     * @param type of the event to handle.
+     * @param event to handle.
+     */
+    private handleEvent;
+    /**
+     * Sends buffered data if there is a buffer defined.
+     */
+    private sendBufferedData;
+    /**
+     * Schedules a connection-retry if there is a backoff defined and the websocket was not closed by the user.
+     */
+    private scheduleConnectionRetryIfNeeded;
+    /**
+     * Cancels the scheduled connection-retry, if there is one.
+     */
+    private cancelScheduledConnectionRetry;
+}
+//# sourceMappingURL=websocket.d.ts.map

package/dist/cjs/src/websocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.d.ts","sourceRoot":"","sources":["../../../src/websocket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAGL,cAAc,EACd,sBAAsB,EACtB,6BAA6B,EAI9B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAoB;IAEhD,OAAO,CAAC,aAAa,CAAkB;IACvC,OAAO,CAAC,eAAe,CAAC,CAAO;IAC/B,OAAO,CAAC,oBAAoB,CAAY;IACxC,OAAO,CAAC,YAAY,CAAC,CAAS;IAE9B,OAAO,CAAC,QAAQ,CAC0C;IAE1D;;;;;;OAMG;gBAED,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,EAC7B,OAAO,CAAC,EAAE,gBAAgB;IA0B5B;;;;OAIG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAE7C;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,eAAe,GAAG,SAAS,CAExC;IAED;;;;OAIG;IACH,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED;;;;OAIG;IACH,IAAI,gBAAgB,IAAI,OAAO,GAAG,SAAS,CAE1C;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,GAAG,SAAS,CAEjC;IAED;;;;OAIG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;;;OAIG;IACH,IAAI,cAAc,IAAI,IAAI,GAAG,SAAS,CAErC;IAED;;;;;OAKG;IACH,IAAI,mBAAmB,IAAI,SAAS,CAEnC;IAED;;;;;OAKG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;;;;OAKG;IACH,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED;;;;;OAKG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;;;;OAKG;IACH,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED;;;;OAIG;IACH,IAAI,UAAU,CAAC,KAAK,EAAE,UAAU,EAE/B;IAED;;;;;;;;OAQG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,IAAI,GAAG,eAAe,GAAG,IAAI;IAY1E;;;;;;OAMG;IACI,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAMlD;;;;;;;OAOG;IACI,gBAAgB,CAAC,CAAC,SAAS,cAAc,EAC9C,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CAAC,EACnC,OAAO,CAAC,EAAE,6BAA6B,GACtC,IAAI;IAIP;;;;;;OAMG;IACI,mBAAmB,CAAC,CAAC,SAAS,cAAc,EACjD,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CAAC,EACnC,OAAO,CAAC,EAAE,6BAA6B,GACtC,IAAI;IASP;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAsBlB;;OAEG;IACH,OAAO,CAAC,cAAc;IAoBtB;;;OAGG;IACH,OAAO,CAAC,eAAe,CACwB;IAE/C;;;OAGG;IACH,OAAO,CAAC,gBAAgB,CACwB;IAEhD;;;OAGG;IACH,OAAO,CAAC,gBAAgB,CACwB;IAEhD;;;OAGG;IACH,OAAO,CAAC,kBAAkB,CACwB;IAElD;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IAuBrB;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAyCnB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAcxB;;OAEG;IACH,OAAO,CAAC,+BAA+B;IAuCvC;;OAEG;IACH,OAAO,CAAC,8BAA8B;CAGvC"}