websocket-ts 1.1.1 → 2.1.2

package/dist/esm/src/websocket_builder.js

@@ -0,0 +1,213 @@
+import { WebsocketEvent, } from "./websocket_event";
+import { Websocket } from "./websocket";
+/**
+ * Builder for websockets.
+ */
+export class WebsocketBuilder {
+    /**
+     * Creates a new WebsocketBuilder.
+     *
+     * @param url the url to connect to
+     */
+    constructor(url) {
+        this._url = url;
+    }
+    /**
+     * Getter for the url.
+     *
+     * @returns the url
+     */
+    get url() {
+        return this._url;
+    }
+    /**
+     * Adds protocols to the websocket. Subsequent calls to this method will override the previously set protocols.
+     *
+     * @param protocols the protocols to add
+     */
+    withProtocols(protocols) {
+        this._protocols = protocols;
+        return this;
+    }
+    /**
+     * Getter for the protocols.
+     *
+     * @returns the protocols, undefined if no protocols have been set
+     */
+    get protocols() {
+        return this._protocols;
+    }
+    /**
+     * 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) {
+        var _a;
+        this._options = Object.assign(Object.assign({}, this._options), { retry: Object.assign(Object.assign({}, (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry), { maxRetries }) });
+        return this;
+    }
+    /**
+     * 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() {
+        var _a, _b;
+        return (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry) === null || _b === void 0 ? void 0 : _b.maxRetries;
+    }
+    /**
+     * 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) {
+        var _a;
+        this._options = Object.assign(Object.assign({}, this._options), { retry: Object.assign(Object.assign({}, (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry), { instantReconnect }) });
+        return this;
+    }
+    /**
+     * 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() {
+        var _a, _b;
+        return (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry) === null || _b === void 0 ? void 0 : _b.instantReconnect;
+    }
+    /**
+     * 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) {
+        var _a;
+        this._options = Object.assign(Object.assign({}, this._options), { retry: Object.assign(Object.assign({}, (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry), { backoff }) });
+        return this;
+    }
+    /**
+     * Getter for the backoff.
+     *
+     * @returns the backoff, undefined if no backoff has been set
+     */
+    get backoff() {
+        var _a, _b;
+        return (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.retry) === null || _b === void 0 ? void 0 : _b.backoff;
+    }
+    /**
+     * 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) {
+        this._options = Object.assign(Object.assign({}, this._options), { buffer });
+        return this;
+    }
+    /**
+     * Getter for the buffer.
+     *
+     * @returns the buffer, undefined if no buffer has been set
+     */
+    get buffer() {
+        var _a;
+        return (_a = this._options) === null || _a === void 0 ? void 0 : _a.buffer;
+    }
+    /**
+     * 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, options) {
+        this.addListener(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
+     */
+    onClose(listener, options) {
+        this.addListener(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
+     */
+    onError(listener, options) {
+        this.addListener(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
+     */
+    onMessage(listener, options) {
+        this.addListener(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
+     */
+    onRetry(listener, options) {
+        this.addListener(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
+     */
+    onReconnect(listener, options) {
+        this.addListener(WebsocketEvent.reconnect, listener, options);
+        return this;
+    }
+    /**
+     * Builds the websocket.
+     *
+     * @return a new websocket, with the set options
+     */
+    build() {
+        return new 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
+     */
+    addListener(event, listener, options) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w;
+        this._options = Object.assign(Object.assign({}, this._options), { listeners: {
+                open: (_c = (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.listeners) === null || _b === void 0 ? void 0 : _b.open) !== null && _c !== void 0 ? _c : [],
+                close: (_f = (_e = (_d = this._options) === null || _d === void 0 ? void 0 : _d.listeners) === null || _e === void 0 ? void 0 : _e.close) !== null && _f !== void 0 ? _f : [],
+                error: (_j = (_h = (_g = this._options) === null || _g === void 0 ? void 0 : _g.listeners) === null || _h === void 0 ? void 0 : _h.error) !== null && _j !== void 0 ? _j : [],
+                message: (_m = (_l = (_k = this._options) === null || _k === void 0 ? void 0 : _k.listeners) === null || _l === void 0 ? void 0 : _l.message) !== null && _m !== void 0 ? _m : [],
+                retry: (_q = (_p = (_o = this._options) === null || _o === void 0 ? void 0 : _o.listeners) === null || _p === void 0 ? void 0 : _p.retry) !== null && _q !== void 0 ? _q : [],
+                reconnect: (_t = (_s = (_r = this._options) === null || _r === void 0 ? void 0 : _r.listeners) === null || _s === void 0 ? void 0 : _s.reconnect) !== null && _t !== void 0 ? _t : [],
+                [event]: [
+                    ...((_w = (_v = (_u = this._options) === null || _u === void 0 ? void 0 : _u.listeners) === null || _v === void 0 ? void 0 : _v[event]) !== null && _w !== void 0 ? _w : []),
+                    { listener, options },
+                ],
+            } });
+        return this;
+    }
+}
+//# sourceMappingURL=websocket_builder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"websocket_builder.js","sourceRoot":"","sources":["../../../src/websocket_builder.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,GAGf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAIxC;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAM3B;;;;OAIG;IACH,YAAY,GAAW;QACrB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,aAAa,CAClB,SAAwC;QAExC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,UAA8B;;QAClD,IAAI,CAAC,QAAQ,mCACR,IAAI,CAAC,QAAQ,KAChB,KAAK,kCAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,KAAE,UAAU,MAC7C,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;;QACZ,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,0CAAE,UAAU,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CACzB,gBAAqC;;QAErC,IAAI,CAAC,QAAQ,mCACR,IAAI,CAAC,QAAQ,KAChB,KAAK,kCAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,KAAE,gBAAgB,MACnD,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,gBAAgB;;QAClB,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,0CAAE,gBAAgB,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,OAA4B;;QAC7C,IAAI,CAAC,QAAQ,mCACR,IAAI,CAAC,QAAQ,KAChB,KAAK,kCAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,KAAE,OAAO,MAC1C,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;;QACT,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,0CAAE,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,MAAmC;QACnD,IAAI,CAAC,QAAQ,mCAAQ,IAAI,CAAC,QAAQ,KAAE,MAAM,GAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;;QACR,OAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,MAAM,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CACX,QAAqD,EACrD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CACZ,QAAsD,EACtD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CACZ,QAAsD,EACtD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CACd,QAAwD,EACxD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CACZ,QAAsD,EACtD,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAChB,QAA0D,EAC1D,OAAuC;QAEvC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK;QACV,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,iDAAiD;IACpH,CAAC;IAED;;;;;;OAMG;IACK,WAAW,CACjB,KAAqB,EACrB,QAAmC,EACnC,OAAuC;;QAEvC,IAAI,CAAC,QAAQ,mCACR,IAAI,CAAC,QAAQ,KAChB,SAAS,EAAE;gBACT,IAAI,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,IAAI,mCAAI,EAAE;gBAC1C,KAAK,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE;gBAC5C,KAAK,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE;gBAC5C,OAAO,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,OAAO,mCAAI,EAAE;gBAChD,KAAK,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,KAAK,mCAAI,EAAE;gBAC5C,SAAS,EAAE,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAE,SAAS,mCAAI,EAAE;gBACpD,CAAC,KAAK,CAAC,EAAE;oBACP,GAAG,CAAC,MAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,0CAAG,KAAK,CAAC,mCAAI,EAAE,CAAC;oBAC5C,EAAE,QAAQ,EAAE,OAAO,EAAE;iBACtB;aACF,GACF,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

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

@@ -0,0 +1,19 @@
+/**
+ * Events that can be fired by the websocket.
+ */
+export 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 || (WebsocketEvent = {}));
+//# sourceMappingURL=websocket_event.js.map

package/dist/esm/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,MAAM,CAAN,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,KAAd,cAAc,QAkBzB"}

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

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

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

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

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

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

package/dist/esm/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/package.json

@@ -1,8 +1,9 @@
 {
   "name": "websocket-ts",
-  "version": "1.1.1",
-  "main": "lib/index.js",
-  "types": "lib/",
+  "version": "2.1.2",
+  "main": "dist/cjs/src/index.js",
+  "types": "dist/cjs/src/index.d.ts",
+  "module": "dist/esm/src/index.js",
   "license": "MIT",
   "keywords": [
     "websocket",
@@ -12,22 +13,34 @@
     "reconnecting",
     "buffered"
   ],
+  "sideEffects": false,
   "repository": {
     "url": "github:jjxxs/websocket-ts"
   },
   "scripts": {
-    "build": "tsc -p .",
-    "compile": "tsc",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build": "npm run build:cjs && npm run build:esm",
     "test": "jest",
-    "coveralls": "jest --coverage && cat ./coverage/lcov.info | coveralls"
+    "test:coverage": "jest --coverage",
+    "coveralls": "cat ./coverage/lcov.info | coveralls",
+    "lint": "cross-env-shell eslint './src/{**/*,*}.{js,ts}' './tests/{**/*,*}.{js,ts}'"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.23",
-    "@types/ws": "^7.4.4",
-    "coveralls": "^3.1.0",
-    "jest": "^27.0.4",
-    "ts-jest": "^27.0.2",
-    "typescript": "^4.3.2",
-    "ws": "^7.4.6"
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "coveralls": "^3.1.1",
+    "eslint": "^8.49.0",
+    "@types/jest": "^29.5.4",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2",
+    "@types/ws": "^8.5.5",
+    "ws": "^7.0.0",
+    "cross-env": "^7.0.3"
   }
-}
+}

package/src/backoff/backoff.ts

@@ -1,18 +1,26 @@
 /**
- * Backoff provides a series of numbers. This series follows
- * a concrete pattern, e.g. be constant, linearly increasing,
- * exponentially increasing etc.
+ * 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 {
-    /**
-     * Provides the callee with the next number in the
-     * series.
-     * @return the next number
-     */
-    next(): number
+  /**
+   * 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;
 
-    /**
-     *  Resets the series to its starting-value.
-     */
-    reset(): void
+  /**
+   * 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;
 }

package/src/backoff/constantbackoff.ts

@@ -1,20 +1,38 @@
-import {Backoff} from "./backoff";
+import { Backoff } from "./backoff";
 
 /**
- * ConstantBackoff always returns the same value.
+ * ConstantBackoff always returns the same backoff-time.
  */
 export class ConstantBackoff implements Backoff {
-    private readonly backoff: number;
+  private readonly backoff: number;
+  private _retries: number = 0;
 
-    constructor(backoff: number) {
-        this.backoff = backoff;
+  /**
+   * Creates a new ConstantBackoff.
+   * @param backoff the backoff-time to return
+   */
+  constructor(backoff: number) {
+    if (!Number.isInteger(backoff) || backoff < 0) {
+      throw new Error("Backoff must be a positive integer");
     }
 
-    next(): number {
-        return this.backoff;
-    }
+    this.backoff = backoff;
+  }
 
-    reset = () => {
-        // no-op
-    }
+  get retries(): number {
+    return this._retries;
+  }
+
+  get current(): number {
+    return this.backoff;
+  }
+
+  next(): number {
+    this._retries++;
+    return this.backoff;
+  }
+
+  reset(): void {
+    this._retries = 0;
+  }
 }

package/src/backoff/exponentialbackoff.ts

@@ -1,38 +1,78 @@
-import {Backoff} from "./backoff";
+import { Backoff } from "./backoff";
 
 /**
- * ExponentialBackoff doubles the backoff with every step until a maximum
- * is reached. This is modelled after the binary exponential-backoff algo-
- * rithm used in computer-networking.
+ * ExponentialBackoff increases the backoff-time exponentially.
+ * An optional maximum can be provided as an upper bound to the
+ * exponent and thus to the returned backoff.
  *
- * The calculation-specification is:
- *          backoff = k * 2^s with s in [1, expMax].
+ * The series can be described as ('i' is the current step/retry):
+ *    backoff = base * 2^i                | without bound
+ *    backoff = base * 2^min(i, expMax)   | with bound
  *
- * Example: for initial=100, expMax=7 the ExponentialBackoff will pro-
- * duce the backoff-series [100, 200, 400, 800, 1600, 3200, 6400].
+ * Example:
+ *
+ * 1) Without bound:
+ *   base = 1000, expMax = undefined
+ *   backoff = 1000 * 2^0 = 1000 // first retry
+ *   backoff = 1000 * 2^1 = 2000 // second retry
+ *   backoff = 1000 * 2^2 = 4000 // ...doubles with every retry
+ *   backoff = 1000 * 2^3 = 8000
+ *   backoff = 1000 * 2^4 = 16000
+ *   ... // and so on
+ *
+ * 2) With bound:
+ *  base = 1000, expMax = 3
+ *  backoff = 1000 * 2^0 = 1000 // first retry
+ *  backoff = 1000 * 2^1 = 2000 // second retry
+ *  backoff = 1000 * 2^2 = 4000 // third retry
+ *  backoff = 1000 * 2^3 = 8000 // maximum reached, don't increase further
+ *  backoff = 1000 * 2^3 = 8000
+ *  backoff = 1000 * 2^3 = 8000
+ *  ... // and so on
  */
 export class ExponentialBackoff implements Backoff {
-    private readonly initial: number;
-    private readonly expMax: number;
-    private expCurrent: number;
-    private current: number;
+  private readonly base: number;
+  private readonly expMax?: number;
+  private i: number;
+  private _retries: number = 0;
 
-    constructor(initial: number, expMax: number) {
-        this.initial = initial;
-        this.expMax = expMax;
-        this.expCurrent = 1;
-        this.current = this.initial;
+  /**
+   * Creates a new ExponentialBackoff.
+   * @param base the base of the exponentiation
+   * @param expMax the maximum exponent, no bound if undefined
+   */
+  constructor(base: number, expMax?: number) {
+    if (!Number.isInteger(base) || base < 0) {
+      throw new Error("Base must be a positive integer or zero");
     }
-
-    next(): number {
-        const backoff = this.current;
-        if (this.expMax > this.expCurrent++)
-            this.current = this.current * 2;
-        return backoff;
+    if (expMax !== undefined && (!Number.isInteger(expMax) || expMax < 0)) {
+      throw new Error("ExpMax must be a undefined, a positive integer or zero");
     }
 
-    reset() {
-        this.expCurrent = 1;
-        this.current = this.initial;
-    }
-}
+    this.base = base;
+    this.expMax = expMax;
+    this.i = 0;
+  }
+
+  get retries() {
+    return this._retries;
+  }
+
+  get current(): number {
+    return this.base * Math.pow(2, this.i);
+  }
+
+  next(): number {
+    this._retries++;
+    this.i =
+      this.expMax === undefined
+        ? this.i + 1
+        : Math.min(this.i + 1, this.expMax);
+    return this.current;
+  }
+
+  reset(): void {
+    this._retries = 0;
+    this.i = 0;
+  }
+}