websocket-ts 1.1.1 → 2.1.2

package/dist/esm/src/websocket.js

@@ -0,0 +1,356 @@
+import { WebsocketEvent, } from "./websocket_event";
+/**
+ * A websocket wrapper that can be configured to reconnect automatically and buffer messages when the websocket is not connected.
+ */
+export class Websocket {
+    /**
+     * Creates a new websocket.
+     *
+     * @param url to connect to.
+     * @param protocols optional protocols to use.
+     * @param options optional options to use.
+     */
+    constructor(url, protocols, options) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+        this._closedByUser = false; // whether the websocket was closed by the user
+        /**
+         * Handles the 'open' event of the browser-native websocket.
+         * @param event to handle.
+         */
+        this.handleOpenEvent = (event) => this.handleEvent(WebsocketEvent.open, event);
+        /**
+         * Handles the 'error' event of the browser-native websocket.
+         * @param event to handle.
+         */
+        this.handleErrorEvent = (event) => this.handleEvent(WebsocketEvent.error, event);
+        /**
+         * Handles the 'close' event of the browser-native websocket.
+         * @param event to handle.
+         */
+        this.handleCloseEvent = (event) => this.handleEvent(WebsocketEvent.close, event);
+        /**
+         * Handles the 'message' event of the browser-native websocket.
+         * @param event to handle.
+         */
+        this.handleMessageEvent = (event) => this.handleEvent(WebsocketEvent.message, event);
+        this._url = url;
+        this._protocols = protocols;
+        // make a copy of the options to prevent the user from changing them
+        this._options = {
+            buffer: options === null || options === void 0 ? void 0 : options.buffer,
+            retry: {
+                maxRetries: (_a = options === null || options === void 0 ? void 0 : options.retry) === null || _a === void 0 ? void 0 : _a.maxRetries,
+                instantReconnect: (_b = options === null || options === void 0 ? void 0 : options.retry) === null || _b === void 0 ? void 0 : _b.instantReconnect,
+                backoff: (_c = options === null || options === void 0 ? void 0 : options.retry) === null || _c === void 0 ? void 0 : _c.backoff,
+            },
+            listeners: {
+                open: [...((_e = (_d = options === null || options === void 0 ? void 0 : options.listeners) === null || _d === void 0 ? void 0 : _d.open) !== null && _e !== void 0 ? _e : [])],
+                close: [...((_g = (_f = options === null || options === void 0 ? void 0 : options.listeners) === null || _f === void 0 ? void 0 : _f.close) !== null && _g !== void 0 ? _g : [])],
+                error: [...((_j = (_h = options === null || options === void 0 ? void 0 : options.listeners) === null || _h === void 0 ? void 0 : _h.error) !== null && _j !== void 0 ? _j : [])],
+                message: [...((_l = (_k = options === null || options === void 0 ? void 0 : options.listeners) === null || _k === void 0 ? void 0 : _k.message) !== null && _l !== void 0 ? _l : [])],
+                retry: [...((_o = (_m = options === null || options === void 0 ? void 0 : options.listeners) === null || _m === void 0 ? void 0 : _m.retry) !== null && _o !== void 0 ? _o : [])],
+                reconnect: [...((_q = (_p = options === null || options === void 0 ? void 0 : options.listeners) === null || _p === void 0 ? void 0 : _p.reconnect) !== null && _q !== void 0 ? _q : [])],
+            },
+        };
+        this._underlyingWebsocket = this.tryConnect();
+    }
+    /**
+     * Getter for the url.
+     *
+     * @return the url.
+     */
+    get url() {
+        return this._url;
+    }
+    /**
+     * Getter for the protocols.
+     *
+     * @return the protocols, or undefined if none were provided.
+     */
+    get protocols() {
+        return this._protocols;
+    }
+    /**
+     * Getter for the buffer.
+     *
+     * @return the buffer, or undefined if none was provided.
+     */
+    get buffer() {
+        return this._options.buffer;
+    }
+    /**
+     * Getter for the maxRetries.
+     *
+     * @return the maxRetries, or undefined if none was provided (no limit).
+     */
+    get maxRetries() {
+        return this._options.retry.maxRetries;
+    }
+    /**
+     * Getter for the instantReconnect.
+     *
+     * @return the instantReconnect, or undefined if none was provided.
+     */
+    get instantReconnect() {
+        return this._options.retry.instantReconnect;
+    }
+    /**
+     * Getter for the backoff.
+     *
+     * @return the backoff, or undefined if none was provided.
+     */
+    get backoff() {
+        return this._options.retry.backoff;
+    }
+    /**
+     * 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() {
+        return this._closedByUser;
+    }
+    /**
+     * 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() {
+        return this._lastConnection;
+    }
+    /**
+     * 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() {
+        return this._underlyingWebsocket;
+    }
+    /**
+     * 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() {
+        return this._underlyingWebsocket.readyState;
+    }
+    /**
+     * 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() {
+        return this._underlyingWebsocket.bufferedAmount;
+    }
+    /**
+     * 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() {
+        return this._underlyingWebsocket.extensions;
+    }
+    /**
+     * 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() {
+        return this._underlyingWebsocket.binaryType;
+    }
+    /**
+     * Setter for the binaryType of the underlying websocket.
+     *
+     * @param value to set, 'blob' or 'arraybuffer'.
+     */
+    set binaryType(value) {
+        this._underlyingWebsocket.binaryType = value;
+    }
+    /**
+     * 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) {
+        if (this.closedByUser)
+            return; // no-op if closed by user
+        if (this._underlyingWebsocket.readyState === this._underlyingWebsocket.OPEN) {
+            this._underlyingWebsocket.send(data); // websocket is connected, send data
+        }
+        else if (this.buffer !== undefined) {
+            this.buffer.add(data); // websocket is not connected, add data to buffer
+        }
+    }
+    /**
+     * 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, reason) {
+        this.cancelScheduledConnectionRetry(); // cancel any scheduled retries
+        this._closedByUser = true; // mark websocket as closed by user
+        this._underlyingWebsocket.close(code, reason); // close underlying websocket with provided code and reason
+    }
+    /**
+     * 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(type, listener, options) {
+        this._options.listeners[type].push({ listener, options }); // add listener to list of listeners
+    }
+    /**
+     * 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(type, listener, options) {
+        const isListenerNotToBeRemoved = (l) => l.listener !== listener || l.options !== options;
+        this._options.listeners[type] =
+            this._options.listeners[type].filter(isListenerNotToBeRemoved); // only keep listeners that are not to be removed
+    }
+    /**
+     * 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.
+     */
+    tryConnect() {
+        this._underlyingWebsocket = new WebSocket(this.url, this.protocols); // create new browser-native websocket and add all event listeners
+        this._underlyingWebsocket.addEventListener(WebsocketEvent.open, this.handleOpenEvent);
+        this._underlyingWebsocket.addEventListener(WebsocketEvent.close, this.handleCloseEvent);
+        this._underlyingWebsocket.addEventListener(WebsocketEvent.error, this.handleErrorEvent);
+        this._underlyingWebsocket.addEventListener(WebsocketEvent.message, this.handleMessageEvent);
+        return this._underlyingWebsocket;
+    }
+    /**
+     * Removes all event listeners from the browser-native websocket and closes it.
+     */
+    clearWebsocket() {
+        this._underlyingWebsocket.removeEventListener(WebsocketEvent.open, this.handleOpenEvent);
+        this._underlyingWebsocket.removeEventListener(WebsocketEvent.close, this.handleCloseEvent);
+        this._underlyingWebsocket.removeEventListener(WebsocketEvent.error, this.handleErrorEvent);
+        this._underlyingWebsocket.removeEventListener(WebsocketEvent.message, this.handleMessageEvent);
+        this._underlyingWebsocket.close();
+    }
+    /**
+     * Dispatch an event to all listeners of the given event-type.
+     *
+     * @param type of the event to dispatch.
+     * @param event to dispatch.
+     */
+    dispatchEvent(type, event) {
+        const eventListeners = this._options.listeners[type];
+        const newEventListeners = [];
+        eventListeners.forEach(({ listener, options }) => {
+            listener(this, event); // invoke listener with event
+            if (options === undefined ||
+                options.once === undefined ||
+                !options.once) {
+                newEventListeners.push({ listener, options }); // only keep listener if it isn't a once-listener
+            }
+        });
+        this._options.listeners[type] = newEventListeners; // replace old listeners with new listeners that don't include once-listeners
+    }
+    /**
+     * 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.
+     */
+    handleEvent(type, event) {
+        switch (type) {
+            case WebsocketEvent.close:
+                this.dispatchEvent(type, event);
+                this.scheduleConnectionRetryIfNeeded(); // schedule a new connection retry if the websocket was closed by the server
+                break;
+            case WebsocketEvent.open:
+                if (this.backoff !== undefined && this._lastConnection !== undefined) {
+                    // websocket was reconnected, dispatch reconnect event and reset backoff
+                    const detail = {
+                        retries: this.backoff.retries,
+                        lastConnection: new Date(this._lastConnection),
+                    };
+                    const event = new CustomEvent(WebsocketEvent.reconnect, {
+                        detail,
+                    });
+                    this.dispatchEvent(WebsocketEvent.reconnect, event);
+                    this.backoff.reset();
+                }
+                this._lastConnection = new Date();
+                this.dispatchEvent(type, event); // dispatch open event and send buffered data
+                this.sendBufferedData();
+                break;
+            case WebsocketEvent.retry:
+                this.dispatchEvent(type, event); // dispatch retry event and try to connect
+                this.clearWebsocket(); // clear the old websocket
+                this.tryConnect();
+                break;
+            default:
+                this.dispatchEvent(type, event); // dispatch event to all listeners of the given event-type
+                break;
+        }
+    }
+    /**
+     * Sends buffered data if there is a buffer defined.
+     */
+    sendBufferedData() {
+        if (this.buffer === undefined) {
+            return; // no buffer defined, nothing to send
+        }
+        for (let ele = this.buffer.read(); ele !== undefined; ele = this.buffer.read()) {
+            this.send(ele); // send buffered data
+        }
+    }
+    /**
+     * Schedules a connection-retry if there is a backoff defined and the websocket was not closed by the user.
+     */
+    scheduleConnectionRetryIfNeeded() {
+        if (this.closedByUser) {
+            return; // user closed the websocket, no retry
+        }
+        if (this.backoff === undefined) {
+            return; // no backoff defined, no retry
+        }
+        const handleRetryEvent = (detail) => {
+            const event = new CustomEvent(WebsocketEvent.retry, { detail });
+            this.handleEvent(WebsocketEvent.retry, event);
+        };
+        // create retry event detail, depending on the 'instantReconnect' option
+        const retryEventDetail = {
+            backoff: this._options.retry.instantReconnect === true ? 0 : this.backoff.next(),
+            retries: this._options.retry.instantReconnect === true
+                ? 0
+                : this.backoff.retries,
+            lastConnection: this._lastConnection,
+        };
+        // schedule a new connection-retry if the maximum number of retries is not reached yet
+        if (this._options.retry.maxRetries === undefined ||
+            retryEventDetail.retries <= this._options.retry.maxRetries) {
+            this.retryTimeout = window.setTimeout(() => handleRetryEvent(retryEventDetail), retryEventDetail.backoff);
+        }
+    }
+    /**
+     * Cancels the scheduled connection-retry, if there is one.
+     */
+    cancelScheduledConnectionRetry() {
+        window.clearTimeout(this.retryTimeout);
+    }
+}
+//# sourceMappingURL=websocket.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.js","sourceRoot":"","sources":["../../../src/websocket.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,cAAc,GAMf,MAAM,mBAAmB,CAAC;AAG3B;;GAEG;AACH,MAAM,OAAO,SAAS;IAYpB;;;;;;OAMG;IACH,YACE,GAAW,EACX,SAA6B,EAC7B,OAA0B;;QAlBpB,kBAAa,GAAY,KAAK,CAAC,CAAC,+CAA+C;QAwSvF;;;WAGG;QACK,oBAAe,GAAG,CAAC,KAAY,EAAE,EAAE,CACzC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAE/C;;;WAGG;QACK,qBAAgB,GAAG,CAAC,KAAY,EAAE,EAAE,CAC1C,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAEhD;;;WAGG;QACK,qBAAgB,GAAG,CAAC,KAAiB,EAAE,EAAE,CAC/C,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAEhD;;;WAGG;QACK,uBAAkB,GAAG,CAAC,KAAmB,EAAE,EAAE,CACnD,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QA9ShD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,oEAAoE;QACpE,IAAI,CAAC,QAAQ,GAAG;YACd,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;YACvB,KAAK,EAAE;gBACL,UAAU,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,0CAAE,UAAU;gBACtC,gBAAgB,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,0CAAE,gBAAgB;gBAClD,OAAO,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,0CAAE,OAAO;aACjC;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,CAAC,GAAG,CAAC,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,0CAAE,IAAI,mCAAI,EAAE,CAAC,CAAC;gBAC3C,KAAK,EAAE,CAAC,GAAG,CAAC,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE,CAAC,CAAC;gBAC7C,KAAK,EAAE,CAAC,GAAG,CAAC,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE,CAAC,CAAC;gBAC7C,OAAO,EAAE,CAAC,GAAG,CAAC,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,0CAAE,OAAO,mCAAI,EAAE,CAAC,CAAC;gBACjD,KAAK,EAAE,CAAC,GAAG,CAAC,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE,CAAC,CAAC;gBAC7C,SAAS,EAAE,CAAC,GAAG,CAAC,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,0CAAE,SAAS,mCAAI,EAAE,CAAC,CAAC;aACtD;SACF,CAAC;QAEF,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU,CAAC,KAAiB;QAC9B,IAAI,CAAC,oBAAoB,CAAC,UAAU,GAAG,KAAK,CAAC;IAC/C,CAAC;IAED;;;;;;;;OAQG;IACI,IAAI,CAAC,IAAuD;QACjE,IAAI,IAAI,CAAC,YAAY;YAAE,OAAO,CAAC,0BAA0B;QAEzD,IACE,IAAI,CAAC,oBAAoB,CAAC,UAAU,KAAK,IAAI,CAAC,oBAAoB,CAAC,IAAI,EACvE;YACA,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,oCAAoC;SAC3E;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,iDAAiD;SACzE;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAa,EAAE,MAAe;QACzC,IAAI,CAAC,8BAA8B,EAAE,CAAC,CAAC,+BAA+B;QACtE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC,mCAAmC;QAC9D,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,2DAA2D;IAC5G,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CACrB,IAAO,EACP,QAAmC,EACnC,OAAuC;QAEvC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,oCAAoC;IACjG,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CACxB,IAAO,EACP,QAAmC,EACnC,OAAuC;QAEvC,MAAM,wBAAwB,GAAG,CAC/B,CAAuC,EACvC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC;QAErD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAA4C;YACvE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC,CAAC,iDAAiD;IACrH,CAAC;IAED;;;;;OAKG;IACK,UAAU;QAChB,IAAI,CAAC,oBAAoB,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,kEAAkE;QACvI,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CACxC,cAAc,CAAC,IAAI,EACnB,IAAI,CAAC,eAAe,CACrB,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CACxC,cAAc,CAAC,KAAK,EACpB,IAAI,CAAC,gBAAgB,CACtB,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CACxC,cAAc,CAAC,KAAK,EACpB,IAAI,CAAC,gBAAgB,CACtB,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CACxC,cAAc,CAAC,OAAO,EACtB,IAAI,CAAC,kBAAkB,CACxB,CAAC;QAEF,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED;;OAEG;IACK,cAAc;QACpB,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,CAC3C,cAAc,CAAC,IAAI,EACnB,IAAI,CAAC,eAAe,CACrB,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,CAC3C,cAAc,CAAC,KAAK,EACpB,IAAI,CAAC,gBAAgB,CACtB,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,CAC3C,cAAc,CAAC,KAAK,EACpB,IAAI,CAAC,gBAAgB,CACtB,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,CAC3C,cAAc,CAAC,OAAO,EACtB,IAAI,CAAC,kBAAkB,CACxB,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;IA8BD;;;;;OAKG;IACK,aAAa,CACnB,IAAO,EACP,KAA2B;QAE3B,MAAM,cAAc,GAClB,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,iBAAiB,GAA+B,EAAE,CAAC;QAEzD,cAAc,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE;YAC/C,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,6BAA6B;YAEpD,IACE,OAAO,KAAK,SAAS;gBACrB,OAAO,CAAC,IAAI,KAAK,SAAS;gBAC1B,CAAC,OAAO,CAAC,IAAI,EACb;gBACA,iBAAiB,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,iDAAiD;aACjG;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC,6EAA6E;IAClI,CAAC;IAED;;;;;OAKG;IACK,WAAW,CACjB,IAAO,EACP,KAA2B;QAE3B,QAAQ,IAAI,EAAE;YACZ,KAAK,cAAc,CAAC,KAAK;gBACvB,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAChC,IAAI,CAAC,+BAA+B,EAAE,CAAC,CAAC,4EAA4E;gBACpH,MAAM;YAER,KAAK,cAAc,CAAC,IAAI;gBACtB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;oBACpE,wEAAwE;oBACxE,MAAM,MAAM,GAAyB;wBACnC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;wBAC7B,cAAc,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;qBAC/C,CAAC;oBACF,MAAM,KAAK,GACT,IAAI,WAAW,CAAuB,cAAc,CAAC,SAAS,EAAE;wBAC9D,MAAM;qBACP,CAAC,CAAC;oBACL,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;oBACpD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;iBACtB;gBACD,IAAI,CAAC,eAAe,GAAG,IAAI,IAAI,EAAE,CAAC;gBAClC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,6CAA6C;gBAC9E,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACxB,MAAM;YAER,KAAK,cAAc,CAAC,KAAK;gBACvB,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,0CAA0C;gBAC3E,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,0BAA0B;gBACjD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,MAAM;YAER;gBACE,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,0DAA0D;gBAC3F,MAAM;SACT;IACH,CAAC;IAED;;OAEG;IACK,gBAAgB;QACtB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC7B,OAAO,CAAC,qCAAqC;SAC9C;QAED,KACE,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAC5B,GAAG,KAAK,SAAS,EACjB,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EACxB;YACA,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,qBAAqB;SACtC;IACH,CAAC;IAED;;OAEG;IACK,+BAA+B;QACrC,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,sCAAsC;SAC/C;QACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;YAC9B,OAAO,CAAC,+BAA+B;SACxC;QAED,MAAM,gBAAgB,GAAG,CAAC,MAAwB,EAAE,EAAE;YACpD,MAAM,KAAK,GAAkC,IAAI,WAAW,CAC1D,cAAc,CAAC,KAAK,EACpB,EAAE,MAAM,EAAE,CACX,CAAC;YACF,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAChD,CAAC,CAAC;QAEF,wEAAwE;QACxE,MAAM,gBAAgB,GAAqB;YACzC,OAAO,EACL,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YACzE,OAAO,EACL,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,KAAK,IAAI;gBAC3C,CAAC,CAAC,CAAC;gBACH,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO;YAC1B,cAAc,EAAE,IAAI,CAAC,eAAe;SACrC,CAAC;QAEF,sFAAsF;QACtF,IACE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS;YAC5C,gBAAgB,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,EAC1D;YACA,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,UAAU,CACnC,GAAG,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EACxC,gBAAgB,CAAC,OAAO,CACzB,CAAC;SACH;IACH,CAAC;IAED;;OAEG;IACK,8BAA8B;QACpC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACzC,CAAC;CACF"}

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

@@ -0,0 +1,16 @@
+/**
+ * A WebsocketBuffer is used to store messages temporarily until they can be sent.
+ */
+export interface WebsocketBuffer<E = string | ArrayBufferLike | Blob | ArrayBufferView> {
+    /**
+     * Adds an element to the buffer.
+     * @param element the element to add
+     */
+    add(element: E): void;
+    /**
+     * Reads an element from the buffer.
+     * @return an element from the buffer or undefined if the buffer is empty
+     */
+    read(): E | undefined;
+}
+//# sourceMappingURL=websocket_buffer.d.ts.map

package/dist/esm/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/esm/src/websocket_buffer.js

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

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

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

package/dist/esm/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/esm/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"}