next-ws 2.1.17 → 2.2.0

package/README.md

@@ -8,8 +8,8 @@
   <img alt='package version' src='https://img.shields.io/npm/v/next-ws?label=version'>
   <img alt='total downloads' src='https://img.shields.io/npm/dt/next-ws'>
   <br>
-  <a href='https://github.com/apteryxxyz/next-ws'><img alt='next-ws repo stars' src='https://img.shields.io/github/stars/apteryxxyz/next-ws?style=social'></a>
-  <a href='https://github.com/apteryxxyz'><img alt='apteryxxyz followers' src='https://img.shields.io/github/followers/apteryxxyz?style=social'></a>
+  <a href='https://github.com/k0d13/next-ws'><img alt='next-ws repo stars' src='https://img.shields.io/github/stars/k0d13/next-ws?style=social'></a>
+  <a href='https://github.com/k0d13'><img alt='k0d13 followers' src='https://img.shields.io/github/followers/k0d13?style=social'></a>
   <a href='https://discord.gg/B2rEQ9g2vf'><img src='https://discordapp.com/api/guilds/829836158007115806/widget.png?style=shield' alt='discord shield'/></a>
 </div>
 
@@ -66,7 +66,7 @@ export function UPGRADE(
 ## 🌀 Examples
 
 > [!TIP]  
-> For more detailed examples, refer the [`examples` directory](https://github.com/apteryxxyz/next-ws/tree/main/examples).
+> For more detailed examples, refer the [`examples` directory](https://github.com/k0d13/next-ws/tree/main/examples).
 
 ### Echo Server
 
@@ -96,4 +96,4 @@ You can now connect to your WebSocket server, send it a message and receive the
 
 ### Chat Room
 
-See the [chat room example](https://github.com/apteryxxyz/next-ws/tree/main/examples/chat-room).
+See the [chat room example](https://github.com/k0d13/next-ws/tree/main/examples/chat-room).

package/dist/cli.cjs

@@ -27,7 +27,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var import_minimist = __toESM(require("minimist"));
 
 // package.json
-var version = "2.1.16";
+var version = "2.2.0";
 
 // src/commands/helpers/define.ts
 function defineCommandGroup(definition) {
@@ -728,7 +728,8 @@ var patchNextNodeServer = definePatchStep({
       try { nextWs ??= require('next-ws/server') } catch {}
       try { nextWs ??= require(require.resolve('next-ws/server', { paths: [process.cwd()] }) )} catch {}
       try { nextWs ??= require('${resolveNextWsDirectory().replaceAll(import_node_path3.sep, "/").replaceAll("'", "\\'")}/dist/server/index.cjs') } catch {}
-      nextWs?.setupWebSocketServer(this);
+      const adapter = nextWs?.getAdapter?.();
+      nextWs?.setupWebSocketServer(this, adapter ? { adapter } : undefined);
     `);
     const block = import_jscodeshift.default.blockStatement(snippet.nodes()[0].program.body);
     return (0, import_jscodeshift.default)(code).find(import_jscodeshift.default.ClassDeclaration, { id: { name: "NextNodeServer" } }).find(import_jscodeshift.default.MethodDefinition, { kind: "constructor" }).forEach(({ node }) => {
@@ -842,7 +843,7 @@ var patchCookies2 = definePatchStep({
 });
 var patch_2_default = definePatch({
   name: "patch-2",
-  versions: ">=15.0.0 <=16.1.6",
+  versions: ">=15.0.0 <=16.1.7",
   steps: [
     patchNextNodeServer,
     patchRouterServer,
@@ -916,7 +917,7 @@ var patch_default = defineCommand({
         patch = patches_default[patches_default.length - 1];
         info("Proceeding with the latest patch");
         log(
-          "If you encounter any issues please report them at https://github.com/apteryxxyz/next-ws/issues"
+          "If you encounter any issues please report them at https://github.com/k0d13/next-ws/issues"
         );
       } else {
         error("Aborted");

package/dist/server/index.cjs

@@ -30,8 +30,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/server/index.ts
 var server_exports = {};
 __export(server_exports, {
+  getAdapter: () => getAdapter,
   getHttpServer: () => getHttpServer,
   getWebSocketServer: () => getWebSocketServer,
+  setAdapter: () => setAdapter,
   setHttpServer: () => setHttpServer,
   setWebSocketServer: () => setWebSocketServer,
   setupWebSocketServer: () => setupWebSocketServer
@@ -76,11 +78,18 @@ var [getRequestStorage, setRequestStorage, useRequestStorage] = (
     //
   )
 );
+var [getAdapter, setAdapter, useAdapter] = (
+  //
+  useGlobal(
+    /* @__PURE__ */ Symbol.for("next-ws.adapter")
+    //
+  )
+);
 
 // src/server/setup.ts
 var import_node_async_hooks = require("async_hooks");
 var logger2 = __toESM(require("next/dist/build/output/log.js"));
-var import_ws = __toESM(require("ws"));
+var ws = __toESM(require("ws"));
 
 // src/server/helpers/match.ts
 function compileRoutePattern(routePattern) {
@@ -209,8 +218,8 @@ function createRequestStore(request) {
 }
 
 // src/server/setup.ts
-var WebSocketServer2 = import_ws.WebSocketServer || import_ws.Server;
-function setupWebSocketServer(nextServer) {
+var WebSocketServer2 = ws.WebSocketServer || ws.Server;
+function setupWebSocketServer(nextServer, options) {
   const httpServer = (
     //
     // @ts-expect-error - serverOptions is protected
@@ -226,10 +235,16 @@ function setupWebSocketServer(nextServer) {
     //
     useRequestStorage(() => new import_node_async_hooks.AsyncLocalStorage())
   );
-  logger2.ready("[next-ws] has started the WebSocket server");
+  const adapter = options?.adapter;
+  if (adapter) {
+    logger2.ready("[next-ws] adapter configured for multi-instance support");
+  } else {
+    logger2.ready("[next-ws] has started the WebSocket server");
+  }
   const kAttached = /* @__PURE__ */ Symbol.for("next-ws.http-server.attached");
   if (Reflect.has(httpServer, kAttached)) return;
   Reflect.set(httpServer, kAttached, true);
+  const routeClients = /* @__PURE__ */ new Map();
   httpServer.on("upgrade", async (message, socket, head) => {
     const request = toNextRequest(message);
     const pathname = request.nextUrl.pathname;
@@ -252,10 +267,27 @@ function setupWebSocketServer(nextServer) {
     }
     if (handleSocket)
       logger2.warnOnce(
-        "DeprecationWarning: [next-ws] SOCKET is deprecated, prefer UPGRADE instead, see https://github.com/apteryxxyz/next-ws#-usage"
+        "DeprecationWarning: [next-ws] SOCKET is deprecated, prefer UPGRADE instead, see https://github.com/k0d13/next-ws#-usage"
       );
     wsServer.handleUpgrade(message, socket, head, async (client) => {
       wsServer.emit("connection", client, message);
+      if (adapter) {
+        if (!routeClients.has(pathname)) {
+          routeClients.set(pathname, /* @__PURE__ */ new Set());
+          await adapter.onMessage(pathname, (message2) => {
+            const clients = routeClients.get(pathname);
+            if (!clients) return;
+            for (const localClient of clients) {
+              if (localClient.readyState === ws.WebSocket.OPEN) {
+                localClient.send(
+                  typeof message2 === "string" ? message2 : JSON.stringify(message2)
+                );
+              }
+            }
+          });
+        }
+        routeClients.get(pathname)?.add(client);
+      }
       try {
         const context = { params: route.params };
         if (handleUpgrade) {
@@ -272,6 +304,13 @@ function setupWebSocketServer(nextServer) {
           if (typeof handleClose === "function")
             client.once("close", () => handleClose());
         }
+        if (adapter) {
+          client.on("message", (data) => {
+            adapter.broadcast(pathname, data).catch((err) => {
+              logger2.error("[next-ws] adapter broadcast failed:", err);
+            });
+          });
+        }
       } catch (cause) {
         logger2.error(
           `[next-ws] error in socket handler for '${pathname}'`,
@@ -282,14 +321,28 @@ function setupWebSocketServer(nextServer) {
         } catch {
         }
       }
+      client.once("close", () => {
+        if (adapter) {
+          routeClients.get(pathname)?.delete(client);
+        }
+      });
     });
     return;
   });
+  if (adapter) {
+    httpServer.once("close", async () => {
+      await adapter.close().catch((err) => {
+        logger2.error("[next-ws] adapter cleanup failed:", err);
+      });
+    });
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  getAdapter,
   getHttpServer,
   getWebSocketServer,
+  setAdapter,
   setHttpServer,
   setWebSocketServer,
   setupWebSocketServer

package/dist/server/index.d.ts

@@ -1,9 +1,54 @@
 import * as next_server from 'next/server';
 import * as http from 'http';
 import * as ws from 'ws';
-import * as node_http from 'node:http';
 import NextNodeServer from 'next/dist/server/next-server.js';
 
+/**
+ * Adapter interface for multi-instance WebSocket deployments.
+ * Enables message broadcasting across multiple server instances via pub/sub.
+ *
+ * @example
+ * ```typescript
+ * class RedisAdapter implements Adapter {
+ *   private pub = new Redis(process.env.REDIS_URL);
+ *   private sub = new Redis(process.env.REDIS_URL);
+ *
+ *   async broadcast(room: string, message: unknown): Promise<void> {
+ *     await this.pub.publish(room, JSON.stringify(message));
+ *   }
+ *
+ *   async onMessage(room: string, handler: (message: unknown) => void): Promise<void> {
+ *     this.sub.subscribe(room);
+ *     this.sub.on('message', (channel, msg) => {
+ *       if (channel === room) handler(JSON.parse(msg));
+ *     });
+ *   }
+ *
+ *   async close(): Promise<void> {
+ *     await Promise.all([this.pub.quit(), this.sub.quit()]);
+ *   }
+ * }
+ * ```
+ */
+interface Adapter {
+    /**
+     * Broadcast a message to all instances subscribed to the specified room.
+     * @param room Room identifier (typically the route pathname)
+     * @param message Message to broadcast (will be JSON stringified if needed)
+     */
+    broadcast(room: string, message: unknown): Promise<void>;
+    /**
+     * Subscribe to messages for a specific room.
+     * @param room Room identifier to subscribe to
+     * @param handler Callback invoked when messages arrive for this room
+     */
+    onMessage(room: string, handler: (message: unknown) => void): void | Promise<void>;
+    /**
+     * Clean up adapter resources (close connections, unsubscribe, etc.)
+     */
+    close(): Promise<void>;
+}
+
 /**
  * WebSocket socket handler.
  * @param client WebSocket client instance
@@ -41,15 +86,21 @@ type RouteContext<Path extends string> = {
     params: Record<string, string | string[] | undefined> & RouteParams<Path> & RouteParams<Path>;
 };
 
-declare const getHttpServer: () => node_http.Server<typeof node_http.IncomingMessage, typeof node_http.ServerResponse> | undefined;
-declare const setHttpServer: (value: node_http.Server<typeof node_http.IncomingMessage, typeof node_http.ServerResponse>) => boolean;
+declare const getHttpServer: () => http.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | undefined;
+declare const setHttpServer: (value: http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>) => boolean;
 declare const getWebSocketServer: () => ws.WebSocketServer | undefined;
 declare const setWebSocketServer: (value: ws.WebSocketServer) => boolean;
+declare const getAdapter: () => Adapter | undefined;
+declare const setAdapter: (value: Adapter | undefined) => boolean;
 
+interface SetupOptions {
+    adapter?: Adapter;
+}
 /**
  * Attach the WebSocket server to the HTTP server.
  * @param nextServer Next.js Node server instance
+ * @param options Setup options including optional adapter
  */
-declare function setupWebSocketServer(nextServer: NextNodeServer): void;
+declare function setupWebSocketServer(nextServer: NextNodeServer, options?: SetupOptions): void;
 
-export { type RouteContext, type SocketHandler, type UpgradeHandler, getHttpServer, getWebSocketServer, setHttpServer, setWebSocketServer, setupWebSocketServer };
+export { type Adapter, type RouteContext, type SetupOptions, type SocketHandler, type UpgradeHandler, getAdapter, getHttpServer, getWebSocketServer, setAdapter, setHttpServer, setWebSocketServer, setupWebSocketServer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-ws",
-  "version": "2.1.17",
+  "version": "2.2.0",
   "description": "Add support for WebSockets in the Next.js app directory",
   "license": "MIT",
   "keywords": [
@@ -10,13 +10,13 @@
     "server",
     "client"
   ],
-  "homepage": "https://github.com/apteryxxyz/next-ws#readme",
+  "homepage": "https://github.com/k0d13/next-ws#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/apteryxxyz/next-ws.git"
+    "url": "git+https://github.com/k0d13/next-ws.git"
   },
   "bugs": {
-    "url": "https://github.com/apteryxxyz/next-ws/issues"
+    "url": "https://github.com/k0d13/next-ws/issues"
   },
   "bin": {
     "next-ws": "./dist/cli.cjs"
@@ -38,7 +38,7 @@
   "dependencies": {
     "jscodeshift": "^17.3.0",
     "minimist": "^1.2.8",
-    "semver": "^7.7.2"
+    "semver": "^7.7.4"
   },
   "peerDependencies": {
     "next": ">=13.5.1",
@@ -48,23 +48,24 @@
   "devDependencies": {
     "@biomejs/biome": "^2.2.0",
     "@changesets/changelog-git": "^0.2.1",
-    "@changesets/cli": "^2.27.12",
+    "@changesets/cli": "^2.30.0",
     "@favware/npm-deprecate": "^2.0.0",
-    "@playwright/test": "^1.55.0",
+    "@playwright/test": "^1.58.2",
     "@types/jscodeshift": "^17.3.0",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^24.3.0",
+    "@types/node": "^24.11.0",
     "@types/react": "19.1.10",
-    "@types/semver": "^7.7.0",
+    "@types/semver": "^7.7.1",
     "@types/ws": "^8.18.1",
-    "chalk": "^5.6.0",
+    "chalk": "^5.6.2",
     "husky": "^9.1.7",
-    "next": "16.1.6",
+    "ioredis": "^5.10.0",
+    "next": "16.1.7",
     "pinst": "^3.0.0",
     "react": "19.1.1",
     "react-dom": "19.1.1",
-    "tsup": "^8.5.0",
-    "typescript": "^5.9.2"
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
   },
   "scripts": {
     "check": "tsc --noEmit",