websocket-ts 2.1.1 → 2.1.3

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_buffer.d.ts","sourceRoot":"","sources":["../../../src/websocket_buffer.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe,CAC9B,CAAC,GAAG,MAAM,GAAG,eAAe,GAAG,IAAI,GAAG,eAAe;IAErD;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS,CAAC;CACvB"}

package/dist/cjs/src/websocket_buffer.js

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

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

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

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

@@ -0,0 +1,147 @@
+import { Backoff } from "./backoff/backoff";
+import { WebsocketEvent, WebsocketEventListener, WebsocketEventListenerOptions } from "./websocket_event";
+import { Websocket } from "./websocket";
+import { WebsocketBuffer } from "./websocket_buffer";
+/**
+ * Builder for websockets.
+ */
+export declare class WebsocketBuilder {
+    private readonly _url;
+    private _protocols?;
+    private _options?;
+    /**
+     * Creates a new WebsocketBuilder.
+     *
+     * @param url the url to connect to
+     */
+    constructor(url: string);
+    /**
+     * Getter for the url.
+     *
+     * @returns the url
+     */
+    get url(): string;
+    /**
+     * Adds protocols to the websocket. Subsequent calls to this method will override the previously set protocols.
+     *
+     * @param protocols the protocols to add
+     */
+    withProtocols(protocols: string | string[] | undefined): WebsocketBuilder;
+    /**
+     * Getter for the protocols.
+     *
+     * @returns the protocols, undefined if no protocols have been set
+     */
+    get protocols(): string | string[] | undefined;
+    /**
+     * Sets the maximum number of retries before giving up. No limit if undefined.
+     *
+     * @param maxRetries the maximum number of retries before giving up
+     */
+    withMaxRetries(maxRetries: number | undefined): WebsocketBuilder;
+    /**
+     * Getter for the maximum number of retries before giving up.
+     *
+     * @returns the maximum number of retries before giving up, undefined if no maximum has been set
+     */
+    get maxRetries(): number | undefined;
+    /**
+     * Sets wether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
+     *
+     * @param instantReconnect wether to reconnect immediately after a connection has been lost
+     */
+    withInstantReconnect(instantReconnect: boolean | undefined): WebsocketBuilder;
+    /**
+     * Getter for wether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
+     *
+     * @returns wether to reconnect immediately after a connection has been lost, undefined if no value has been set
+     */
+    get instantReconnect(): boolean | undefined;
+    /**
+     * Adds a backoff to the websocket. Subsequent calls to this method will override the previously set backoff.
+     *
+     * @param backoff the backoff to add
+     */
+    withBackoff(backoff: Backoff | undefined): WebsocketBuilder;
+    /**
+     * Getter for the backoff.
+     *
+     * @returns the backoff, undefined if no backoff has been set
+     */
+    get backoff(): Backoff | undefined;
+    /**
+     * Adds a buffer to the websocket. Subsequent calls to this method will override the previously set buffer.
+     *
+     * @param buffer the buffer to add
+     */
+    withBuffer(buffer: WebsocketBuffer | undefined): WebsocketBuilder;
+    /**
+     * Getter for the buffer.
+     *
+     * @returns the buffer, undefined if no buffer has been set
+     */
+    get buffer(): WebsocketBuffer | undefined;
+    /**
+     * Adds an 'open' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onOpen(listener: WebsocketEventListener<WebsocketEvent.open>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * Adds an 'close' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onClose(listener: WebsocketEventListener<WebsocketEvent.close>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * Adds an 'error' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onError(listener: WebsocketEventListener<WebsocketEvent.error>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * Adds an 'message' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onMessage(listener: WebsocketEventListener<WebsocketEvent.message>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * Adds an 'retry' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onRetry(listener: WebsocketEventListener<WebsocketEvent.retry>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * Adds an 'reconnect' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    onReconnect(listener: WebsocketEventListener<WebsocketEvent.reconnect>, options?: WebsocketEventListenerOptions): WebsocketBuilder;
+    /**
+     * Builds the websocket.
+     *
+     * @return a new websocket, with the set options
+     */
+    build(): Websocket;
+    /**
+     * Adds an event listener to the options.
+     *
+     * @param event the event to add the listener to
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    private addListener;
+}
+//# sourceMappingURL=websocket_builder.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_builder.d.ts","sourceRoot":"","sources":["../../../src/websocket_builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,6BAA6B,EAC9B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAGrD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAE9B,OAAO,CAAC,UAAU,CAAC,CAAoB;IACvC,OAAO,CAAC,QAAQ,CAAC,CAAmB;IAEpC;;;;OAIG;gBACS,GAAG,EAAE,MAAM;IAIvB;;;;OAIG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;;;OAIG;IACI,aAAa,CAClB,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,GACvC,gBAAgB;IAKnB;;;;OAIG;IACH,IAAI,SAAS,IAAI,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAE7C;IAED;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,gBAAgB;IAQvE;;;;OAIG;IACH,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED;;;;OAIG;IACI,oBAAoB,CACzB,gBAAgB,EAAE,OAAO,GAAG,SAAS,GACpC,gBAAgB;IAQnB;;;;OAIG;IACH,IAAI,gBAAgB,IAAI,OAAO,GAAG,SAAS,CAE1C;IAED;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,gBAAgB;IAQlE;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,GAAG,SAAS,CAEjC;IAED;;;;OAIG;IACI,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,GAAG,gBAAgB;IAKxE;;;;OAIG;IACH,IAAI,MAAM,IAAI,eAAe,GAAG,SAAS,CAExC;IAED;;;;;;OAMG;IACI,MAAM,CACX,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,EACrD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,OAAO,CACZ,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,KAAK,CAAC,EACtD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,OAAO,CACZ,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,KAAK,CAAC,EACtD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,SAAS,CACd,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,OAAO,CAAC,EACxD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,OAAO,CACZ,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,KAAK,CAAC,EACtD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;;;OAMG;IACI,WAAW,CAChB,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,SAAS,CAAC,EAC1D,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB;IAKnB;;;;OAIG;IACI,KAAK,IAAI,SAAS;IAIzB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;CAsBpB"}

package/dist/cjs/src/websocket_builder.js

@@ -0,0 +1,263 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsocketBuilder = void 0;
+var websocket_event_1 = require("./websocket_event");
+var websocket_1 = require("./websocket");
+/**
+ * Builder for websockets.
+ */
+var WebsocketBuilder = /** @class */ (function () {
+    /**
+     * Creates a new WebsocketBuilder.
+     *
+     * @param url the url to connect to
+     */
+    function WebsocketBuilder(url) {
+        this._url = url;
+    }
+    Object.defineProperty(WebsocketBuilder.prototype, "url", {
+        /**
+         * Getter for the url.
+         *
+         * @returns the url
+         */
+        get: function () {
+            return this._url;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Adds protocols to the websocket. Subsequent calls to this method will override the previously set protocols.
+     *
+     * @param protocols the protocols to add
+     */
+    WebsocketBuilder.prototype.withProtocols = function (protocols) {
+        this._protocols = protocols;
+        return this;
+    };
+    Object.defineProperty(WebsocketBuilder.prototype, "protocols", {
+        /**
+         * Getter for the protocols.
+         *
+         * @returns the protocols, undefined if no protocols have been set
+         */
+        get: function () {
+            return this._protocols;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Sets the maximum number of retries before giving up. No limit if undefined.
+     *
+     * @param maxRetries the maximum number of retries before giving up
+     */
+    WebsocketBuilder.prototype.withMaxRetries = function (maxRetries) {
+        var _a;
+        this._options = __assign(__assign({}, this._options), { retry: __assign(__assign({}, (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry), { maxRetries: maxRetries }) });
+        return this;
+    };
+    Object.defineProperty(WebsocketBuilder.prototype, "maxRetries", {
+        /**
+         * Getter for the maximum number of retries before giving up.
+         *
+         * @returns the maximum number of retries before giving up, undefined if no maximum has been set
+         */
+        get: function () {
+            var _a, _b;
+            return (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry) === null || _b === void 0 ? void 0 : _b.maxRetries;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Sets wether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
+     *
+     * @param instantReconnect wether to reconnect immediately after a connection has been lost
+     */
+    WebsocketBuilder.prototype.withInstantReconnect = function (instantReconnect) {
+        var _a;
+        this._options = __assign(__assign({}, this._options), { retry: __assign(__assign({}, (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry), { instantReconnect: instantReconnect }) });
+        return this;
+    };
+    Object.defineProperty(WebsocketBuilder.prototype, "instantReconnect", {
+        /**
+         * Getter for wether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
+         *
+         * @returns wether to reconnect immediately after a connection has been lost, undefined if no value has been set
+         */
+        get: function () {
+            var _a, _b;
+            return (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry) === null || _b === void 0 ? void 0 : _b.instantReconnect;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Adds a backoff to the websocket. Subsequent calls to this method will override the previously set backoff.
+     *
+     * @param backoff the backoff to add
+     */
+    WebsocketBuilder.prototype.withBackoff = function (backoff) {
+        var _a;
+        this._options = __assign(__assign({}, this._options), { retry: __assign(__assign({}, (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry), { backoff: backoff }) });
+        return this;
+    };
+    Object.defineProperty(WebsocketBuilder.prototype, "backoff", {
+        /**
+         * Getter for the backoff.
+         *
+         * @returns the backoff, undefined if no backoff has been set
+         */
+        get: function () {
+            var _a, _b;
+            return (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry) === null || _b === void 0 ? void 0 : _b.backoff;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Adds a buffer to the websocket. Subsequent calls to this method will override the previously set buffer.
+     *
+     * @param buffer the buffer to add
+     */
+    WebsocketBuilder.prototype.withBuffer = function (buffer) {
+        this._options = __assign(__assign({}, this._options), { buffer: buffer });
+        return this;
+    };
+    Object.defineProperty(WebsocketBuilder.prototype, "buffer", {
+        /**
+         * Getter for the buffer.
+         *
+         * @returns the buffer, undefined if no buffer has been set
+         */
+        get: function () {
+            var _a;
+            return (_a = this._options) === null || _a === void 0 ? void 0 : _a.buffer;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Adds an 'open' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    WebsocketBuilder.prototype.onOpen = function (listener, options) {
+        this.addListener(websocket_event_1.WebsocketEvent.open, listener, options);
+        return this;
+    };
+    /**
+     * Adds an 'close' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    WebsocketBuilder.prototype.onClose = function (listener, options) {
+        this.addListener(websocket_event_1.WebsocketEvent.close, listener, options);
+        return this;
+    };
+    /**
+     * Adds an 'error' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    WebsocketBuilder.prototype.onError = function (listener, options) {
+        this.addListener(websocket_event_1.WebsocketEvent.error, listener, options);
+        return this;
+    };
+    /**
+     * Adds an 'message' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    WebsocketBuilder.prototype.onMessage = function (listener, options) {
+        this.addListener(websocket_event_1.WebsocketEvent.message, listener, options);
+        return this;
+    };
+    /**
+     * Adds an 'retry' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    WebsocketBuilder.prototype.onRetry = function (listener, options) {
+        this.addListener(websocket_event_1.WebsocketEvent.retry, listener, options);
+        return this;
+    };
+    /**
+     * Adds an 'reconnect' event listener to the websocket. Subsequent calls to this method will add additional listeners that will be
+     * called in the order they were added.
+     *
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    WebsocketBuilder.prototype.onReconnect = function (listener, options) {
+        this.addListener(websocket_event_1.WebsocketEvent.reconnect, listener, options);
+        return this;
+    };
+    /**
+     * Builds the websocket.
+     *
+     * @return a new websocket, with the set options
+     */
+    WebsocketBuilder.prototype.build = function () {
+        return new websocket_1.Websocket(this._url, this._protocols, this._options); // instantiate the websocket with the set options
+    };
+    /**
+     * Adds an event listener to the options.
+     *
+     * @param event the event to add the listener to
+     * @param listener the listener to add
+     * @param options the listener options
+     */
+    WebsocketBuilder.prototype.addListener = function (event, listener, options) {
+        var _a;
+        var _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
+        this._options = __assign(__assign({}, this._options), { listeners: (_a = {
+                    open: (_d = (_c = (_b = this._options) === null || _b === void 0 ? void 0 : _b.listeners) === null || _c === void 0 ? void 0 : _c.open) !== null && _d !== void 0 ? _d : [],
+                    close: (_g = (_f = (_e = this._options) === null || _e === void 0 ? void 0 : _e.listeners) === null || _f === void 0 ? void 0 : _f.close) !== null && _g !== void 0 ? _g : [],
+                    error: (_k = (_j = (_h = this._options) === null || _h === void 0 ? void 0 : _h.listeners) === null || _j === void 0 ? void 0 : _j.error) !== null && _k !== void 0 ? _k : [],
+                    message: (_o = (_m = (_l = this._options) === null || _l === void 0 ? void 0 : _l.listeners) === null || _m === void 0 ? void 0 : _m.message) !== null && _o !== void 0 ? _o : [],
+                    retry: (_r = (_q = (_p = this._options) === null || _p === void 0 ? void 0 : _p.listeners) === null || _q === void 0 ? void 0 : _q.retry) !== null && _r !== void 0 ? _r : [],
+                    reconnect: (_u = (_t = (_s = this._options) === null || _s === void 0 ? void 0 : _s.listeners) === null || _t === void 0 ? void 0 : _t.reconnect) !== null && _u !== void 0 ? _u : []
+                },
+                _a[event] = __spreadArray(__spreadArray([], ((_x = (_w = (_v = this._options) === null || _v === void 0 ? void 0 : _v.listeners) === null || _w === void 0 ? void 0 : _w[event]) !== null && _x !== void 0 ? _x : []), true), [
+                    { listener: listener, options: options },
+                ], false),
+                _a) });
+        return this;
+    };
+    return WebsocketBuilder;
+}());
+exports.WebsocketBuilder = WebsocketBuilder;
+//# sourceMappingURL=websocket_builder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_builder.js","sourceRoot":"","sources":["../../../src/websocket_builder.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AACA,qDAI2B;AAC3B,yCAAwC;AAIxC;;GAEG;AACH;IAME;;;;OAIG;IACH,0BAAY,GAAW;QACrB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAOD,sBAAI,iCAAG;QALP;;;;WAIG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,CAAC;;;OAAA;IAED;;;;OAIG;IACI,wCAAa,GAApB,UACE,SAAwC;QAExC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAOD,sBAAI,uCAAS;QALb;;;;WAIG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;;;OAAA;IAED;;;;OAIG;IACI,yCAAc,GAArB,UAAsB,UAA8B;;QAClD,IAAI,CAAC,QAAQ,yBACR,IAAI,CAAC,QAAQ,KAChB,KAAK,wBAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,KAAE,UAAU,YAAA,MAC7C,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAOD,sBAAI,wCAAU;QALd;;;;WAIG;aACH;;YACE,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,0CAAE,UAAU,CAAC;QAC1C,CAAC;;;OAAA;IAED;;;;OAIG;IACI,+CAAoB,GAA3B,UACE,gBAAqC;;QAErC,IAAI,CAAC,QAAQ,yBACR,IAAI,CAAC,QAAQ,KAChB,KAAK,wBAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,KAAE,gBAAgB,kBAAA,MACnD,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAOD,sBAAI,8CAAgB;QALpB;;;;WAIG;aACH;;YACE,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,0CAAE,gBAAgB,CAAC;QAChD,CAAC;;;OAAA;IAED;;;;OAIG;IACI,sCAAW,GAAlB,UAAmB,OAA4B;;QAC7C,IAAI,CAAC,QAAQ,yBACR,IAAI,CAAC,QAAQ,KAChB,KAAK,wBAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,KAAE,OAAO,SAAA,MAC1C,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAOD,sBAAI,qCAAO;QALX;;;;WAIG;aACH;;YACE,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,0CAAE,OAAO,CAAC;QACvC,CAAC;;;OAAA;IAED;;;;OAIG;IACI,qCAAU,GAAjB,UAAkB,MAAmC;QACnD,IAAI,CAAC,QAAQ,yBAAQ,IAAI,CAAC,QAAQ,KAAE,MAAM,QAAA,GAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAOD,sBAAI,oCAAM;QALV;;;;WAIG;aACH;;YACE,OAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,MAAM,CAAC;QAC/B,CAAC;;;OAAA;IAED;;;;;;OAMG;IACI,iCAAM,GAAb,UACE,QAAqD,EACrD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,gCAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,kCAAO,GAAd,UACE,QAAsD,EACtD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,gCAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,kCAAO,GAAd,UACE,QAAsD,EACtD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,gCAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,oCAAS,GAAhB,UACE,QAAwD,EACxD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,gCAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,kCAAO,GAAd,UACE,QAAsD,EACtD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,gCAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,sCAAW,GAAlB,UACE,QAA0D,EAC1D,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,gCAAc,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,gCAAK,GAAZ;QACE,OAAO,IAAI,qBAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,iDAAiD;IACpH,CAAC;IAED;;;;;;OAMG;IACK,sCAAW,GAAnB,UACE,KAAqB,EACrB,QAAmC,EACnC,OAAuC;;;QAEvC,IAAI,CAAC,QAAQ,yBACR,IAAI,CAAC,QAAQ,KAChB,SAAS;oBACP,IAAI,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,IAAI,mCAAI,EAAE;oBAC1C,KAAK,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE;oBAC5C,KAAK,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE;oBAC5C,OAAO,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,OAAO,mCAAI,EAAE;oBAChD,KAAK,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE;oBAC5C,SAAS,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,SAAS,mCAAI,EAAE;;gBACpD,GAAC,KAAK,oCACD,CAAC,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAG,KAAK,CAAC,mCAAI,EAAE,CAAC;oBAC5C,EAAE,QAAQ,UAAA,EAAE,OAAO,SAAA,EAAE;yBACtB;sBAEJ,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IACH,uBAAC;AAAD,CAAC,AApQD,IAoQC;AApQY,4CAAgB"}

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

@@ -0,0 +1,67 @@
+import { Websocket } from "./websocket";
+/**
+ * Events that can be fired by the websocket.
+ */
+export declare enum WebsocketEvent {
+    /** Fired when the connection is opened. */
+    open = "open",
+    /** Fired when the connection is closed. */
+    close = "close",
+    /** Fired when the connection has been closed because of an error, such as when some data couldn't be sent. */
+    error = "error",
+    /** Fired when a message is received. */
+    message = "message",
+    /** Fired when the websocket tries to reconnect after a connection loss. */
+    retry = "retry",
+    /** Fired when the websocket successfully reconnects after a connection loss. */
+    reconnect = "reconnect"
+}
+/***
+ * Details/properties of a retry-event.
+ */
+export type RetryEventDetail = {
+    /** Number of retries that have been made since the connection was lost. */
+    readonly retries: number;
+    /** Time (ms) waited since the last connection-retry. */
+    readonly backoff: number;
+    /** Timestamp of when the connection was lost or undefined if the connection has never been established. */
+    readonly lastConnection: Date | undefined;
+};
+/**
+ * Properties of a reconnect-event.
+ */
+export type ReconnectEventDetail = Omit<RetryEventDetail, "backoff">;
+/**
+ * Maps websocket events to their corresponding event.
+ */
+export type WebsocketEventMap = {
+    [WebsocketEvent.open]: Event;
+    [WebsocketEvent.close]: CloseEvent;
+    [WebsocketEvent.error]: Event;
+    [WebsocketEvent.message]: MessageEvent;
+    [WebsocketEvent.retry]: CustomEvent<RetryEventDetail>;
+    [WebsocketEvent.reconnect]: CustomEvent<ReconnectEventDetail>;
+};
+/**
+ * Listener for websocket events.
+ * */
+export type WebsocketEventListener<K extends WebsocketEvent> = (instance: Websocket, ev: WebsocketEventMap[K]) => unknown;
+export type WebsocketEventListenerParams<K extends WebsocketEvent> = Parameters<WebsocketEventListener<K>>;
+/**
+ * Options for websocket events.
+ */
+export type WebsocketEventListenerOptions = EventListenerOptions & AddEventListenerOptions;
+/**
+ * Listener for websocket events with options.
+ */
+export type WebsocketEventListenerWithOptions<K extends WebsocketEvent> = {
+    readonly listener: WebsocketEventListener<K>;
+    readonly options?: WebsocketEventListenerOptions;
+};
+/**
+ * Maps websocket events to their corresponding event-listeners.
+ */
+export type WebsocketEventListeners = {
+    [K in WebsocketEvent]: WebsocketEventListenerWithOptions<K>[];
+};
+//# sourceMappingURL=websocket_event.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_event.d.ts","sourceRoot":"","sources":["../../../src/websocket_event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,oBAAY,cAAc;IACxB,2CAA2C;IAC3C,IAAI,SAAS;IAEb,2CAA2C;IAC3C,KAAK,UAAU;IAEf,8GAA8G;IAC9G,KAAK,UAAU;IAEf,wCAAwC;IACxC,OAAO,YAAY;IAEnB,2EAA2E;IAC3E,KAAK,UAAU;IAEf,gFAAgF;IAChF,SAAS,cAAc;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,wDAAwD;IACxD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,2GAA2G;IAC3G,QAAQ,CAAC,cAAc,EAAE,IAAI,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IACnC,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IAC9B,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IACvC,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;IACtD,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAC;CAC/D,CAAC;AAEF;;KAEK;AACL,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,cAAc,IAAI,CAC7D,QAAQ,EAAE,SAAS,EACnB,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAC,KACrB,OAAO,CAAC;AAEb,MAAM,MAAM,4BAA4B,CAAC,CAAC,SAAS,cAAc,IAAI,UAAU,CAC7E,sBAAsB,CAAC,CAAC,CAAC,CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,oBAAoB,GAC9D,uBAAuB,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,iCAAiC,CAAC,CAAC,SAAS,cAAc,IAAI;IACxE,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAC7C,QAAQ,CAAC,OAAO,CAAC,EAAE,6BAA6B,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;KACnC,CAAC,IAAI,cAAc,GAAG,iCAAiC,CAAC,CAAC,CAAC,EAAE;CAC9D,CAAC"}

package/dist/cjs/src/websocket_event.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsocketEvent = void 0;
+/**
+ * Events that can be fired by the websocket.
+ */
+var WebsocketEvent;
+(function (WebsocketEvent) {
+    /** Fired when the connection is opened. */
+    WebsocketEvent["open"] = "open";
+    /** Fired when the connection is closed. */
+    WebsocketEvent["close"] = "close";
+    /** Fired when the connection has been closed because of an error, such as when some data couldn't be sent. */
+    WebsocketEvent["error"] = "error";
+    /** Fired when a message is received. */
+    WebsocketEvent["message"] = "message";
+    /** Fired when the websocket tries to reconnect after a connection loss. */
+    WebsocketEvent["retry"] = "retry";
+    /** Fired when the websocket successfully reconnects after a connection loss. */
+    WebsocketEvent["reconnect"] = "reconnect";
+})(WebsocketEvent || (exports.WebsocketEvent = WebsocketEvent = {}));
+//# sourceMappingURL=websocket_event.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_event.js","sourceRoot":"","sources":["../../../src/websocket_event.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,IAAY,cAkBX;AAlBD,WAAY,cAAc;IACxB,2CAA2C;IAC3C,+BAAa,CAAA;IAEb,2CAA2C;IAC3C,iCAAe,CAAA;IAEf,8GAA8G;IAC9G,iCAAe,CAAA;IAEf,wCAAwC;IACxC,qCAAmB,CAAA;IAEnB,2EAA2E;IAC3E,iCAAe,CAAA;IAEf,gFAAgF;IAChF,yCAAuB,CAAA;AACzB,CAAC,EAlBW,cAAc,8BAAd,cAAc,QAkBzB"}

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

@@ -0,0 +1,21 @@
+import { WebsocketBuffer } from "./websocket_buffer";
+import { WebsocketConnectionRetryOptions } from "./websocket_retry_options";
+import { WebsocketEventListeners } from "./websocket_event";
+/**
+ * Options that can be passed to the Websocket constructor.
+ */
+export interface WebsocketOptions {
+    /**
+     * The Buffer to use.
+     */
+    readonly buffer?: WebsocketBuffer;
+    /**
+     * The options for the connection-retry-strategy.
+     */
+    readonly retry?: WebsocketConnectionRetryOptions;
+    /**
+     * The initial listeners to add to the websocket.
+     */
+    readonly listeners?: WebsocketEventListeners;
+}
+//# sourceMappingURL=websocket_options.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_options.d.ts","sourceRoot":"","sources":["../../../src/websocket_options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,+BAA+B,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,+BAA+B,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,uBAAuB,CAAC;CAC9C"}

package/dist/cjs/src/websocket_options.js

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

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

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

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

@@ -0,0 +1,20 @@
+import { Backoff } from "./backoff/backoff";
+/**
+ * Options for the websockets retry-strategy.
+ */
+export interface WebsocketConnectionRetryOptions {
+    /**
+     * The maximum number of retries before giving up. No limit if undefined.
+     */
+    readonly maxRetries?: number;
+    /**
+     * Wether to reconnect immediately after a connection has been lost,
+     * ignoring the backoff strategy for the first retry.
+     */
+    readonly instantReconnect?: boolean;
+    /**
+     * The backoff strategy to use. This is used to determine the delay between connection-retries.
+     */
+    readonly backoff?: Backoff;
+}
+//# sourceMappingURL=websocket_retry_options.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_retry_options.d.ts","sourceRoot":"","sources":["../../../src/websocket_retry_options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B"}

package/dist/cjs/src/websocket_retry_options.js

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

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

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

package/dist/esm/src/backoff/backoff.d.ts

@@ -0,0 +1,24 @@
+/**
+ * A Backoff produces a series of numbers that are used to determine
+ * the delay between connection-retries. Values are expected to be in milliseconds.
+ */
+export interface Backoff {
+    /**
+     * The number of retries. Starts at 0, increases by 1 for each call to next(). Resets to 0 when reset() is called.
+     */
+    readonly retries: number;
+    /**
+     * Current number in the series.
+     */
+    readonly current: number;
+    /**
+     * Advances the series to the next number and returns it.
+     * @return the next number in the series
+     */
+    next(): number;
+    /**
+     * Resets the series to its initial state.
+     */
+    reset(): void;
+}
+//# sourceMappingURL=backoff.d.ts.map

package/dist/esm/src/backoff/backoff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backoff.d.ts","sourceRoot":"","sources":["../../../../src/backoff/backoff.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,IAAI,IAAI,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACf"}

package/dist/esm/src/backoff/backoff.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=backoff.js.map

package/dist/esm/src/backoff/backoff.js.map

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

package/dist/esm/src/backoff/constantbackoff.d.ts

@@ -0,0 +1,18 @@
+import { Backoff } from "./backoff";
+/**
+ * ConstantBackoff always returns the same backoff-time.
+ */
+export declare class ConstantBackoff implements Backoff {
+    private readonly backoff;
+    private _retries;
+    /**
+     * Creates a new ConstantBackoff.
+     * @param backoff the backoff-time to return
+     */
+    constructor(backoff: number);
+    get retries(): number;
+    get current(): number;
+    next(): number;
+    reset(): void;
+}
+//# sourceMappingURL=constantbackoff.d.ts.map