websocket-ts 2.2.0 → 2.3.0

package/dist/esm/src/websocket_event.js

@@ -1,19 +1,18 @@
 /**
  * Events that can be fired by the websocket.
  */
-export var WebsocketEvent;
-(function (WebsocketEvent) {
+export const WebsocketEvent = {
     /** Fired when the connection is opened. */
-    WebsocketEvent["open"] = "open";
+    open: "open",
     /** Fired when the connection is closed. */
-    WebsocketEvent["close"] = "close";
+    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";
+    error: "error",
     /** Fired when a message is received. */
-    WebsocketEvent["message"] = "message";
+    message: "message",
     /** Fired when the websocket tries to reconnect after a connection loss. */
-    WebsocketEvent["retry"] = "retry";
+    retry: "retry",
     /** Fired when the websocket successfully reconnects after a connection loss. */
-    WebsocketEvent["reconnect"] = "reconnect";
-})(WebsocketEvent || (WebsocketEvent = {}));
+    reconnect: "reconnect",
+};
 //# sourceMappingURL=websocket_event.js.map

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

@@ -1 +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"}
+{"version":3,"file":"websocket_event.js","sourceRoot":"","sources":["../../../src/websocket_event.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,2CAA2C;IAC3C,IAAI,EAAE,MAAM;IAEZ,2CAA2C;IAC3C,KAAK,EAAE,OAAO;IAEd,8GAA8G;IAC9G,KAAK,EAAE,OAAO;IAEd,wCAAwC;IACxC,OAAO,EAAE,SAAS;IAElB,2EAA2E;IAC3E,KAAK,EAAE,OAAO;IAEd,gFAAgF;IAChF,SAAS,EAAE,WAAW;CACd,CAAC"}

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

@@ -8,7 +8,7 @@ export interface WebsocketConnectionRetryOptions {
      */
     readonly maxRetries?: number;
     /**
-     * Wether to reconnect immediately after a connection has been lost,
+     * Whether to reconnect immediately after a connection has been lost,
      * ignoring the backoff strategy for the first retry.
      */
     readonly instantReconnect?: boolean;

package/package.json

@@ -1,14 +1,10 @@
 {
   "name": "websocket-ts",
-  "version": "2.2.0",
+  "description": "A WebSocket client library with optional reconnecting and buffering capabilities.",
+  "version": "2.3.0",
   "main": "dist/cjs/src/index.js",
   "types": "dist/cjs/src/index.d.ts",
   "module": "dist/esm/src/index.js",
-  "type": "module",
-  "exports": {
-    "import": "./dist/esm/src/index.js",
-    "require": "./dist/cjs/src/index.js"
-  },
   "license": "MIT",
   "keywords": [
     "websocket",
@@ -26,28 +22,27 @@
     "build": "npm run build:cjs && npm run build:esm",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:esm": "tsc -p tsconfig.esm.json",
-    "coveralls": "cat ./coverage/lcov.info | coveralls",
-    "lint": "cross-env-shell eslint",
+    "lint": "cross-env-shell eslint './src/{**/*,*}.{js,ts}' './tests/{**/*,*}.{js,ts}'",
     "test": "vitest",
     "test:coverage": "vitest --coverage"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.2.0",
-    "@eslint/js": "^9.20.0",
-    "@types/ws": "^8.5.14",
-    "@typescript-eslint/eslint-plugin": "^8.24.0",
-    "@typescript-eslint/parser": "^8.24.0",
-    "@vitest/coverage-v8": "^3.0.5",
-    "coveralls": "^3.1.1",
-    "cross-env": "^7.0.3",
-    "eslint": "^9.20.1",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-prettier": "^5.2.3",
-    "globals": "^15.15.0",
-    "jsdom": "^26.0.0",
+    "@eslint/eslintrc": "^3.3.5",
+    "@eslint/js": "^9.39.4",
+    "@types/ws": "^8.18.1",
+    "@typescript-eslint/eslint-plugin": "^8.57.2",
+    "@typescript-eslint/parser": "^8.57.2",
+    "@vitest/coverage-v8": "^3.2.4",
+    "coveralls-next": "^5.0.0",
+    "cross-env": "^10.1.0",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "globals": "^16.5.0",
+    "jsdom": "^26.1.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.7.3",
-    "vitest": "^3.0.5",
-    "ws": "^8.18.0"
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4",
+    "ws": "^8.20.0"
   }
 }

package/src/backoff/exponentialbackoff.ts

@@ -46,7 +46,7 @@ export class ExponentialBackoff implements Backoff {
       throw new Error("Base must be a positive integer or zero");
     }
     if (expMax !== undefined && (!Number.isInteger(expMax) || expMax < 0)) {
-      throw new Error("ExpMax must be a undefined, a positive integer or zero");
+      throw new Error("ExpMax must be undefined, a positive integer, or zero");
     }
 
     this.base = base;

package/src/index.ts

@@ -5,7 +5,7 @@ export { LinearBackoff } from "./backoff/linearbackoff";
 export { Queue } from "./queue/queue";
 export { ArrayQueue } from "./queue/array_queue";
 export { RingQueue } from "./queue/ring_queue";
-export { Websocket } from "./websocket";
+export { UrlProvider, Websocket } from "./websocket";
 export { WebsocketBuffer } from "./websocket_buffer";
 export { WebsocketBuilder } from "./websocket_builder";
 export {

package/src/websocket.ts

@@ -12,11 +12,18 @@ import {
 } from "./websocket_event";
 import { WebsocketOptions } from "./websocket_options";
 
+/**
+ * A URL or a function that returns a URL. When a function is provided, it is called on each connection attempt,
+ * enabling use cases like load balancing, auth token rotation, and failover.
+ */
+export type UrlProvider = string | (() => string);
+
 /**
  * A websocket wrapper that can be configured to reconnect automatically and buffer messages when the websocket is not connected.
  */
 export class Websocket {
-  private readonly _url: string; // the url to connect to
+  private readonly _urlProvider: UrlProvider; // the url or url provider
+  private _url!: string; // the last resolved url
   private readonly _protocols?: string | string[]; // the protocols to use
 
   private _closedByUser: boolean = false; // whether the websocket was closed by the user
@@ -30,16 +37,16 @@ export class Websocket {
   /**
    * Creates a new websocket.
    *
-   * @param url to connect to.
+   * @param url to connect to, or a function that returns a URL.
    * @param protocols optional protocols to use.
    * @param options optional options to use.
    */
   constructor(
-    url: string,
+    url: UrlProvider,
     protocols?: string | string[],
     options?: WebsocketOptions,
   ) {
-    this._url = url;
+    this._urlProvider = url;
     this._protocols = protocols;
 
     // make a copy of the options to prevent the user from changing them
@@ -271,7 +278,11 @@ export class Websocket {
    * @return the created browser-native websocket which is also stored in the '_underlyingWebsocket' property.
    */
   private tryConnect(): WebSocket {
-    this._underlyingWebsocket = new WebSocket(this.url, this.protocols); // create new browser-native websocket and add all event listeners
+    this._url =
+      typeof this._urlProvider === "function"
+        ? this._urlProvider()
+        : this._urlProvider;
+    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,

package/src/websocket_builder.ts

@@ -4,7 +4,7 @@ import {
   WebsocketEventListener,
   WebsocketEventListenerOptions,
 } from "./websocket_event";
-import { Websocket } from "./websocket";
+import { UrlProvider, Websocket } from "./websocket";
 import { WebsocketBuffer } from "./websocket_buffer";
 import { WebsocketOptions } from "./websocket_options";
 
@@ -12,7 +12,7 @@ import { WebsocketOptions } from "./websocket_options";
  * Builder for websockets.
  */
 export class WebsocketBuilder {
-  private readonly _url: string;
+  private readonly _url: UrlProvider;
 
   private _protocols?: string | string[];
   private _options?: WebsocketOptions;
@@ -20,18 +20,18 @@ export class WebsocketBuilder {
   /**
    * Creates a new WebsocketBuilder.
    *
-   * @param url the url to connect to
+   * @param url the url to connect to, or a function that returns a URL
    */
-  constructor(url: string) {
+  constructor(url: UrlProvider) {
     this._url = url;
   }
 
   /**
    * Getter for the url.
    *
-   * @returns the url
+   * @returns the url or url provider
    */
-  get url(): string {
+  get url(): UrlProvider {
     return this._url;
   }
 
@@ -79,9 +79,9 @@ export class WebsocketBuilder {
   }
 
   /**
-   * Sets wether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
+   * Sets whether 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
+   * @param instantReconnect whether to reconnect immediately after a connection has been lost
    */
   public withInstantReconnect(
     instantReconnect: boolean | undefined,
@@ -94,9 +94,9 @@ export class WebsocketBuilder {
   }
 
   /**
-   * Getter for wether to reconnect immediately after a connection has been lost, ignoring the backoff strategy for the first retry.
+   * Getter for whether 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
+   * @returns whether to reconnect immediately after a connection has been lost, undefined if no value has been set
    */
   get instantReconnect(): boolean | undefined {
     return this._options?.retry?.instantReconnect;

package/src/websocket_event.ts

@@ -3,24 +3,39 @@ import { Websocket } from "./websocket";
 /**
  * Events that can be fired by the websocket.
  */
-export enum WebsocketEvent {
+export const WebsocketEvent = {
   /** Fired when the connection is opened. */
-  open = "open",
+  open: "open",
 
   /** Fired when the connection is closed. */
-  close = "close",
+  close: "close",
 
   /** Fired when the connection has been closed because of an error, such as when some data couldn't be sent. */
-  error = "error",
+  error: "error",
 
   /** Fired when a message is received. */
-  message = "message",
+  message: "message",
 
   /** Fired when the websocket tries to reconnect after a connection loss. */
-  retry = "retry",
+  retry: "retry",
 
   /** Fired when the websocket successfully reconnects after a connection loss. */
-  reconnect = "reconnect",
+  reconnect: "reconnect",
+} as const;
+
+/** Union of all event type strings, allowing plain strings like "open" as event types. */
+export type WebsocketEvent =
+  (typeof WebsocketEvent)[keyof typeof WebsocketEvent];
+
+/** Provides member types (e.g. WebsocketEvent.open) for use as generic type arguments. */
+// eslint-disable-next-line @typescript-eslint/no-namespace
+export namespace WebsocketEvent {
+  export type open = typeof WebsocketEvent.open;
+  export type close = typeof WebsocketEvent.close;
+  export type error = typeof WebsocketEvent.error;
+  export type message = typeof WebsocketEvent.message;
+  export type retry = typeof WebsocketEvent.retry;
+  export type reconnect = typeof WebsocketEvent.reconnect;
 }
 
 /***

package/src/websocket_retry_options.ts

@@ -10,7 +10,7 @@ export interface WebsocketConnectionRetryOptions {
   readonly maxRetries?: number;
 
   /**
-   * Wether to reconnect immediately after a connection has been lost,
+   * Whether to reconnect immediately after a connection has been lost,
    * ignoring the backoff strategy for the first retry.
    */
   readonly instantReconnect?: boolean;

package/tsconfig.cjs.json

@@ -1,74 +1,74 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Basic Options */
-    // "incremental": true,                   /* Enable incremental compilation */
-    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                      /* Generates corresponding '.d.ts' file. */
-    "declarationMap": true,                   /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    "sourceMap": true,                        /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./dist/cjs",                   /* Redirect output structure to the directory. */
-    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    "paths": {
-      // workaround for: https://github.com/vitest-dev/vitest/issues/4567
-      "rollup/parseAst": ["./node_modules/rollup/dist/parseAst"]
-    },                                        /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
-  },
-  "include": ["src", "tests"],
-  "exclude": ["node_modules", "dist"]
-}
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                      /* Generates corresponding '.d.ts' file. */
+    "declarationMap": true,                   /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true,                        /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist/cjs",                   /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    "paths": {
+      // workaround for: https://github.com/vitest-dev/vitest/issues/4567
+      "rollup/parseAst": ["./node_modules/rollup/dist/parseAst"]
+    },                                        /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  },
+  "include": ["src", "tests"],
+  "exclude": ["node_modules", "dist"]
+}