next-ws 0.2.4 → 0.2.5-next.28f252e

package/README.md

@@ -45,7 +45,7 @@ This module is inspired by the now outdated `next-plugin-websocket`, if you are
 In order to setup a WebSocket server, Next WS needs to patch your local Next.js installation. Next WS provides a CLI command to do this for you, it will automatically detect your Next.js version and patch it accordingly, however a minimum version of Next.js 13.1.1 is required.
 
 ```sh
-npx next-ws-cli patch
+npx next-ws-cli@latest patch
 ```
 
 > If at any point your local Next.js installation is changed or updated you will need to re-run the patch command.
@@ -56,6 +56,16 @@ Once the patch is complete, you will need to install the Next WS package into yo
 npm install next-ws
 ```
 
+### 🚓 Verify Patch
+
+It is recommended to add the following code to the top level of your `next.config.js`.
+
+This will verify that Next WS has been patched correctly, and throw an error if it has not. Preventing you from accidentally deploying a broken setup.
+
+```ts
+require('next-ws/server').verifyPatch();
+```
+
 ---
 
 ## 🚀 Usage
@@ -76,16 +86,6 @@ export function SOCKET(
 
 With this straightforward setup, you can fully leverage the capabilities of Next WS and efficiently handle WebSocket connections within your Next.js application.
 
-### 🚓 Verify Patch
-
-It is recommended to add the following code to the top level of your `next.config.js`.
-
-This will verify that Next WS has been patched correctly, and throw an error if it has not. Preventing you from accidentally deploying a broken setup.
-
-```ts
-require('next-ws/server').verifyPatch();
-```
-
 ---
 
 ## 🌀 Example
@@ -135,6 +135,8 @@ export default function Layout() {
 }
 ```
 
+To make it easier to connect to your new WebSocker server, Next WS also provides some client-side utilities. These are completely optional, you can use your own implementation if you wish.
+
 The following is the props interface for the `WebSocketProvider` component, containing all the available options.
 
 ```ts

package/package.json

@@ -1,8 +1,14 @@
 {
     "name": "next-ws",
-    "version": "0.2.4",
+    "version": "0.2.5-next.28f252e",
     "description": "Add support for WebSockets in Next.js 13 app directory",
-    "keywords": ["next", "websocket", "ws", "server", "client"],
+    "keywords": [
+        "next",
+        "websocket",
+        "ws",
+        "server",
+        "client"
+    ],
     "license": "MIT",
     "homepage": "https://github.com/apteryxxyz/next-ws#readme",
     "repository": {
@@ -13,7 +19,12 @@
     "bugs": {
         "url": "https://github.com/apteryxxyz/next-ws/issues"
     },
-    "files": ["index.js", "index.d.ts", "client", "server"],
+    "files": [
+        "index.js",
+        "index.d.ts",
+        "client",
+        "server"
+    ],
     "main": "./index.js",
     "types": "./index.d.ts",
     "scripts": {
@@ -43,4 +54,4 @@
         "rimraf": "^5.0.1",
         "typescript": "<5.1.0"
     }
-}
+}

package/server/index.d.ts

@@ -1,3 +1,4 @@
 export * from './utilities/patch';
 export type { SocketHandler } from './utilities/next';
+export type * from './utilities/ws';
 export * from './setup';

package/server/setup.js

@@ -3,14 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.hookNextNodeServer = exports.setupWebSocketServer = void 0;
 const tslib_1 = require("tslib");
 const Log = tslib_1.__importStar(require("next/dist/build/output/log"));
-const ws_1 = require("ws");
 const next_1 = require("./utilities/next");
+const ws_1 = require("./utilities/ws");
 function setupWebSocketServer(nextServer) {
     const httpServer = (0, next_1.getHttpServer)(nextServer);
-    const wsServer = new ws_1.WebSocketServer({ noServer: true });
+    const wsServer = (0, ws_1.getWsServer)();
     Log.ready('[next-ws] websocket server started successfully');
     httpServer.on('upgrade', async (request, socket, head) => {
-        const url = new URL(request.url ?? '', 'http://next-ws');
+        const url = new URL(request.url ?? '', 'ws://next');
         const pathname = url.pathname;
         if (pathname.startsWith('/_next'))
             return;

package/server/utilities/next.js

@@ -13,7 +13,7 @@ const next_server_1 = tslib_1.__importDefault(require("next/dist/server/next-ser
 function getHttpServer(nextServer) {
     if (!nextServer || !(nextServer instanceof next_server_1.default))
         throw new Error('Next WS is missing access to the NextNodeServer');
-    // @ts-expect-error serverOptions is protected
+    // @ts-expect-error - serverOptions is protected
     const httpServer = nextServer.serverOptions?.httpServer;
     if (!httpServer || !(httpServer instanceof node_http_1.Server))
         throw new Error('Next WS is missing access to the http.Server');
@@ -29,18 +29,41 @@ exports.getHttpServer = getHttpServer;
 async function resolvePathname(nextServer, pathname) {
     if (pathname.startsWith('/_next'))
         return null;
+    const pathParts = pathname.split('/');
     const appRoutes = {
-        // @ts-expect-error appPathRoutes is protected
+        // @ts-expect-error - appPathRoutes is protected
         ...nextServer.appPathRoutes,
-        // @ts-expect-error getAppPathRoutes is protected
+        // @ts-expect-error - getAppPathRoutes is protected
         ...nextServer.getAppPathRoutes(),
     };
-    // TODO: 'appRoutes[pathname]' is an array of routes,  need to investigate in which case that array has more than one item
-    if (pathname in appRoutes) {
-        const route = appRoutes[pathname][0];
-        if (!route?.endsWith('/route'))
-            return null;
-        return route;
+    for (const [key, [path]] of Object.entries(appRoutes)) {
+        const hasDynamic = key.includes('[') && key.includes(']');
+        if (hasDynamic) {
+            const keyParts = key.split('/');
+            if (keyParts.length !== pathParts.length)
+                continue;
+            for (let i = 0; i < keyParts.length; i++) {
+                const keyPart = keyParts[i];
+                const pathPart = pathParts[i];
+                const isDynamic = keyPart.includes('[') && keyPart.includes(']');
+                if (isDynamic)
+                    keyParts[i] = pathPart;
+                if (keyParts[i] !== pathParts[i])
+                    break;
+                if (i === keyParts.length - 1) {
+                    if (!path?.endsWith('/route'))
+                        return null;
+                    return path;
+                }
+            }
+        }
+        else {
+            if (key !== pathname)
+                continue;
+            if (!path?.endsWith('/route'))
+                return null;
+            return path;
+        }
     }
     return null;
 }
@@ -52,12 +75,12 @@ exports.resolvePathname = resolvePathname;
  * @returns The page module.
  */
 async function getPageModule(nextServer, filename) {
-    // @ts-expect-error HotReloader is private
+    // @ts-expect-error - hotReloader is private
     await nextServer.hotReloader?.ensurePage({
         page: filename,
         clientOnly: false,
     });
-    // @ts-expect-error getPagePath is protected
+    // @ts-expect-error - getPagePath is protected
     const builtPagePath = nextServer.getPagePath(filename);
     return require(builtPagePath);
 }

package/server/utilities/ws.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="ws" />
+/// <reference types="node" />
+/**
+ * Get the WebSocketServer instance.
+ * @returns The WebSocketServer instance.
+ */
+export declare function getWsServer(): import("ws").Server<typeof import("ws"), typeof import("http").IncomingMessage>;

package/server/utilities/ws.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWsServer = void 0;
+const ws_1 = require("ws");
+/**
+ * Get the WebSocketServer instance.
+ * @returns The WebSocketServer instance.
+ */
+// prettier-ignore
+function getWsServer() {
+    return new ws_1.WebSocketServer({ noServer: true });
+}
+exports.getWsServer = getWsServer;