react-wsclient 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Ezekiel Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

package/README.md

@@ -0,0 +1,46 @@
+# React WebSocket Client
+
+An easy and flexible way to work with websockets in React.
+
+## Why?
+
+There are already great libraries that handle websocket connectivity in React, but I didn't like the general opinion to force `flushSync` onto users. With rapid messaging over a websocket, taking advantage of React's batching for state updates can be a performance necessity. It also comes with some gotchas, but having the control is a good thing for intermediate to advanced developers.
+
+## Quick Start
+
+**Add the provider**
+
+```jsx
+createRoot(/** @type {HTMLElement} */ (document.getElementById('root'))).render(
+  <StrictMode>
+    <WSClientProvider url="ws://localhost:8080">
+      <App />
+    </WSClientProvider>
+  </StrictMode>,
+);
+```
+
+**Use the hook**
+
+```jsx
+const App = () => {
+  const [message, setMessage] = useState('');
+
+  const { sendMessage } = useWsClient({
+    onMessage: (data) => {
+      setResponse(data.content);
+    },
+  });
+
+  const send = () => {
+    sendMessage('Hello websocket!');
+  };
+
+  return (
+    <div>
+      <button onClick={send}>Send</button>
+      <p>Response: {response}</p>
+    </div>
+  );
+};
+```

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "react-wsclient",
+  "private": false,
+  "version": "1.0.0",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "files": [
+    "src"
+  ],
+  "dependencies": {
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4"
+  },
+  "peerDependencies": {
+    "react": ">=19",
+    "react-dom": ">=19"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3"
+  },
+  "scripts": {
+    "lint": "eslint ."
+  }
+}

package/src/WSClient.js

@@ -0,0 +1,178 @@
+/**
+ * @typedef {object} Options
+ * @property {(data: any) => void} onMessage
+ * @property {(data: any) => boolean} [filter]
+ * @property {(e: Event) => void} [onOpen] Optional event handler when the connection opens.
+ * @property {(e: CloseEvent, manualDisconnect: boolean) => void} [onClose]
+ */
+
+export class WSClient {
+  id = crypto.randomUUID();
+  /** @type {(() => Options)[]} */
+  subs = [];
+  /** @type {WebSocket | null} */
+  connection = null;
+  /** @type {string[]} */
+  messageQueue = [];
+  /** @type {string} */
+  url;
+  /** @type {boolean} */
+  useJson;
+  /** @type {(retryCount: number) => number} */
+  retryInterval;
+  /** @type {boolean} */
+  retry;
+  /** @type {boolean} */
+  manualDisconnect = false;
+  retryCount = 0;
+  /** @type {number} */
+  maxRetries;
+
+  /**
+   * @param {object} options
+   * @param {string} options.url
+   * @param {boolean} options.useJson
+   * @param {boolean} options.retry
+   * @param {(retryCount: number) => number} options.retryInterval
+   * @param {number} options.maxRetries
+   */
+  constructor({ url, useJson, retry, retryInterval, maxRetries }) {
+    this.url = url;
+    this.useJson = useJson;
+    this.retry = retry;
+    this.retryInterval = retryInterval;
+    this.maxRetries = maxRetries;
+  }
+
+  /**
+   * Sends data over the connection to the server.
+   * @param {string} data
+   */
+  send(data) {
+    if (this.connection && this.connection.readyState === WebSocket.OPEN) {
+      this.connection.send(data);
+    } else {
+      this.messageQueue.push(data);
+    }
+  }
+
+  /**
+   *
+   * @param {() => Options} subscriber
+   */
+  subscribe(subscriber) {
+    this.subs.push(subscriber);
+
+    return () => {
+      this.subs = this.subs.filter((sub) => sub !== subscriber);
+    };
+  }
+
+  connect() {
+    this.manualDisconnect = false;
+    if (this.connection !== null) {
+      return;
+    }
+
+    this.connection = new WebSocket(this.url);
+    this.#addListeners(this.connection);
+  }
+
+  get isConnected() {
+    return this.connection?.readyState === WebSocket.OPEN;
+  }
+
+  disconnect() {
+    this.manualDisconnect = true;
+
+    if (this.connection) {
+      this.connection?.close();
+
+      this.connection.onopen = null;
+      this.connection.onmessage = null;
+      this.connection.onclose = null;
+      this.connection.onerror = null;
+      this.connection = null;
+    }
+  }
+
+  /**
+   *
+   * @param {WebSocket} newConnection
+   */
+  #addListeners(newConnection) {
+    newConnection.onopen = (e) => {
+      this.#notifyOpen(e);
+      this.retryCount = 0;
+
+      let msg = this.messageQueue.shift();
+      while (msg !== undefined) {
+        this.connection?.send(msg);
+        msg = this.messageQueue.shift();
+      }
+    };
+
+    newConnection.onmessage = (/** @type {MessageEvent<string>} */ e) => {
+      let message;
+      if (this.useJson) {
+        try {
+          message = JSON.parse(e.data);
+        } catch (err) {
+          console.error('Failed to parse JSON message when useJson flag true.', err, e.data);
+          return;
+        }
+      } else {
+        message = e.data;
+      }
+
+      this.subs.forEach((getSub) => {
+        const sub = getSub();
+        if (!sub.filter || sub.filter(message)) {
+          sub.onMessage(message);
+        }
+      });
+    };
+
+    newConnection.onclose = (e) => {
+      this.#notifyClose(e, this.manualDisconnect);
+      if (this.manualDisconnect) {
+        return;
+      }
+
+      if (this.retry && this.retryCount < this.maxRetries) {
+        this.retryCount += 1;
+        const interval = this.retryInterval(this.retryCount);
+
+        window.setTimeout(() => {
+          this.connection = new WebSocket(this.url);
+          this.#addListeners(this.connection);
+        }, interval);
+      }
+    };
+
+    newConnection.onerror = (e) => {
+      console.error(`Error with websocket connection: `, e);
+    };
+  }
+
+  /**
+   *
+   * @param {Event} e
+   */
+  #notifyOpen(e) {
+    this.subs.forEach((getSub) => {
+      getSub().onOpen?.(e);
+    });
+  }
+
+  /**
+   *
+   * @param {CloseEvent} e
+   * @param {boolean} manualDisconnect
+   */
+  #notifyClose(e, manualDisconnect) {
+    this.subs.forEach((getSub) => {
+      getSub().onClose?.(e, manualDisconnect);
+    });
+  }
+}

package/src/WSClientContext.js

@@ -0,0 +1,6 @@
+import { createContext } from 'react';
+import { WSClient } from './WSClient';
+
+/** @type {React.Context<WSClient | null>} */
+// @ts-expect-error
+export const WSClientContext = createContext(null);

package/src/WSClientProvider.jsx

@@ -0,0 +1,42 @@
+import { useEffect, useMemo } from 'react';
+import { WSClient } from './WSClient';
+import { WSClientContext } from './WSClientContext';
+
+/** @type {Map<string, WSClient>} */
+// const clientMap = new Map();
+
+/**
+ * @typedef {object} WSConfigProviderProps
+ * @property {React.ReactNode} children
+ * @property {string} url
+ * @property {boolean} [useJson=true]
+ * @property {boolean} [retry=true]
+ * @property {(retryCount: number) => number} [retryInterval]
+ * @property {number} [maxRetries=5]
+ */
+
+/** @type {React.FC<WSConfigProviderProps>} */
+const WSClientProvider = ({ children, url, useJson = true, retry = true, retryInterval, maxRetries = 5 }) => {
+  const client = useMemo(() => {
+    const effectiveRetryInterval = retryInterval ?? ((n) => n * n * 1000);
+    return new WSClient({
+      url,
+      retry,
+      retryInterval: effectiveRetryInterval,
+      maxRetries,
+      useJson,
+    });
+  }, [url, retry, retryInterval, maxRetries, useJson]);
+
+  useEffect(() => {
+    client.connect();
+
+    return () => {
+      client.disconnect();
+    };
+  }, [client]);
+
+  return <WSClientContext.Provider value={client}>{children}</WSClientContext.Provider>;
+};
+
+export default WSClientProvider;

package/src/index.js

@@ -0,0 +1,4 @@
+import { useWsClient } from './useWsClient';
+import WSClientProvider from './WSClientProvider';
+
+export { useWsClient, WSClientProvider };

package/src/useWsClient.js

@@ -0,0 +1,44 @@
+import { useCallback, useContext, useEffect, useRef } from 'react';
+import { WSClientContext } from './WSClientContext';
+
+/**
+ * A hook that handles websocket connectivity
+ * @param {import('./WSClient').Options} options
+ */
+export const useWsClient = (options) => {
+  const wsClient = useClientContext();
+  const optionsRef = useRef(options);
+  // eslint-disable-next-line react-hooks/refs
+  optionsRef.current = options;
+
+  /** @type {(data: string) => void} */
+  const sendMessage = useCallback(
+    (data) => {
+      wsClient.send(data);
+    },
+    [wsClient],
+  );
+
+  useEffect(() => {
+    const unsubscribe = wsClient.subscribe(() => optionsRef.current);
+
+    return () => {
+      unsubscribe();
+    };
+  }, [wsClient]);
+
+  return {
+    sendMessage,
+    isConnected: wsClient.isConnected,
+    reconnect: () => wsClient.connect(),
+    disconnect: () => wsClient.disconnect(),
+  };
+};
+
+const useClientContext = () => {
+  const client = useContext(WSClientContext);
+  if (client === null) {
+    throw new Error('useWsClient must be used within a WSClientProvider.');
+  }
+  return client;
+};