next-ws 1.1.1 → 1.2.0

package/dist/{chunk-6VWOYYWX.mjs → chunk-WO25ABG2.js}

@@ -8,4 +8,4 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
 
 export { __name, __require };
 //# sourceMappingURL=out.js.map
-//# sourceMappingURL=chunk-6VWOYYWX.mjs.map
+//# sourceMappingURL=chunk-WO25ABG2.js.map

package/dist/client/{index.mjs → index.js}

@@ -1,4 +1,4 @@
-import { __name } from '../chunk-6VWOYYWX.mjs';
+import { __name } from '../chunk-WO25ABG2.js';
 import React, { createContext, useMemo, useEffect, useContext } from 'react';
 
 var WebSocketContext = createContext(null);
@@ -26,4 +26,4 @@ __name(useWebSocket, "useWebSocket");
 
 export { WebSocketConsumer, WebSocketContext, WebSocketProvider, useWebSocket };
 //# sourceMappingURL=out.js.map
-//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.js.map

package/dist/server/index.cjs

@@ -29,44 +29,6 @@ function getEnvironmentMeta() {
   return { isCustomServer, isMainProcess, isDevelopment };
 }
 chunkPFW3KWBF_cjs.__name(getEnvironmentMeta, "getEnvironmentMeta");
-function resolveFilename(nextServer, pathname) {
-  let pathParts = pathname.split("/"), appRoutes = {
-    // @ts-expect-error - appPathRoutes is protected
-    ...nextServer.appPathRoutes,
-    // @ts-expect-error - getAppPathRoutes is protected
-    ...nextServer.getAppPathRoutes()
-  };
-  for (let [key, [path]] of Object.entries(appRoutes))
-    if (key.includes("[") && key.includes("]")) {
-      let keyParts = key.split("/");
-      if (keyParts.length !== pathParts.length) continue;
-      for (let i = 0; i < keyParts.length; i++) {
-        let keyPart = keyParts[i], pathPart = pathParts[i];
-        if (keyPart.includes("[") && keyPart.includes("]") && (keyParts[i] = pathPart), keyParts[i] !== pathParts[i]) break;
-        if (i === keyParts.length - 1 && path?.endsWith("/route"))
-          return path;
-      }
-    } else {
-      if (key !== pathname) continue;
-      return path?.endsWith("/route") ? path : null;
-    }
-  return null;
-}
-chunkPFW3KWBF_cjs.__name(resolveFilename, "resolveFilename");
-async function getPageModule(nextServer, filename) {
-  try {
-    "hotReloader" in nextServer ? await nextServer.hotReloader?.ensurePage({
-      page: filename,
-      clientOnly: !1
-    }) : "ensurePage" in nextServer ? await nextServer.ensurePage({ page: filename, clientOnly: !1 }) : logger3__namespace.warnOnce(
-      "[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it"
-    );
-  } catch {
-  }
-  let buildPagePath = nextServer.getPagePath(filename);
-  return chunkPFW3KWBF_cjs.__require(buildPagePath);
-}
-chunkPFW3KWBF_cjs.__name(getPageModule, "getPageModule");
 function mainProcessOnly(fnName) {
   if (process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK === "1") return;
   let meta = getEnvironmentMeta();
@@ -112,6 +74,49 @@ function useWebSocketServer(wsServer) {
   return existing || (wsServer && setWebSocketServer(wsServer), wsServer);
 }
 chunkPFW3KWBF_cjs.__name(useWebSocketServer, "useWebSocketServer");
+function createRouteRegex(routePattern) {
+  let paramRegex = routePattern.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&").replace(/\\\[([a-zA-Z0-9_]+)\\\]/g, "(?<$1>[^/]+)").replace(/\\\[(?:\\\.){3}([a-zA-Z0-9_]+)\\\]/g, "(?<rest_$1>.+)");
+  return new RegExp(`^${paramRegex}$`);
+}
+chunkPFW3KWBF_cjs.__name(createRouteRegex, "createRouteRegex");
+function getRouteParams(routePattern, routePath) {
+  let routeRegex = createRouteRegex(routePattern), match = routePath.match(routeRegex);
+  if (!match) return null;
+  if (!match.groups) return {};
+  let params = {};
+  for (let [k, v] of Object.entries(match.groups))
+    k.startsWith("rest_") && (k = k.slice(5), v = v.split("/")), Reflect.set(params, k, v);
+  return params;
+}
+chunkPFW3KWBF_cjs.__name(getRouteParams, "getRouteParams");
+function resolvePathToRoute(nextServer, requestPath) {
+  let routes = {
+    // @ts-expect-error - appPathRoutes is protected
+    ...nextServer.appPathRoutes,
+    // @ts-expect-error - getAppPathRoutes is protected
+    ...nextServer.getAppPathRoutes()
+  };
+  for (let [routePath, [filePath]] of Object.entries(routes)) {
+    let routeParams = getRouteParams(routePath, requestPath);
+    if (routeParams) return { filePath, routeParams };
+  }
+  return null;
+}
+chunkPFW3KWBF_cjs.__name(resolvePathToRoute, "resolvePathToRoute");
+async function importRouteModule(nextServer, filePath) {
+  try {
+    "hotReloader" in nextServer ? await nextServer.hotReloader?.ensurePage({
+      page: filePath,
+      clientOnly: !1
+    }) : "ensurePage" in nextServer ? await nextServer.ensurePage({ page: filePath, clientOnly: !1 }) : logger3__namespace.warnOnce(
+      "[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it"
+    );
+  } catch {
+  }
+  let buildPagePath = nextServer.getPagePath(filePath);
+  return chunkPFW3KWBF_cjs.__require(buildPagePath);
+}
+chunkPFW3KWBF_cjs.__name(importRouteModule, "importRouteModule");
 
 // src/server/setup.ts
 function setupWebSocketServer(nextServer) {
@@ -124,16 +129,16 @@ function setupWebSocketServer(nextServer) {
   logger3__namespace.ready("[next-ws] has started the WebSocket server"), httpServer.on("upgrade", async (request, socket, head) => {
     let pathname = new URL(request.url ?? "", "ws://next").pathname;
     if (pathname.startsWith("/_next")) return;
-    let filename = resolveFilename(nextServer, pathname);
-    if (!filename)
+    let routeInfo = resolvePathToRoute(nextServer, pathname);
+    if (!routeInfo)
       return logger3__namespace.error(`[next-ws] could not find module for page ${pathname}`), socket.destroy();
-    let pageModule = await getPageModule(nextServer, filename);
-    if (!pageModule)
+    let routeModule = await importRouteModule(nextServer, routeInfo.filePath);
+    if (!routeModule)
       return logger3__namespace.error(`[next-ws] could not find module for page ${pathname}`), socket.destroy();
-    let socketHandler = pageModule?.routeModule?.userland?.SOCKET;
-    return !socketHandler || typeof socketHandler != "function" ? (logger3__namespace.error(`[next-ws] ${pathname} does not export a SOCKET handler`), socket.destroy()) : wsServer.handleUpgrade(request, socket, head, (c, r) => {
-      let dispose = socketHandler(c, r, wsServer);
-      typeof dispose == "function" && c.once("close", () => dispose());
+    let socketHandler = routeModule?.routeModule?.userland?.SOCKET;
+    return !socketHandler || typeof socketHandler != "function" ? (logger3__namespace.error(`[next-ws] ${pathname} does not export a SOCKET handler`), socket.destroy()) : wsServer.handleUpgrade(request, socket, head, async (c, r) => {
+      let routeContext = { params: routeInfo.routeParams }, handleClose = await socketHandler(c, r, wsServer, routeContext);
+      typeof handleClose == "function" && c.once("close", () => handleClose());
     });
   });
 }

package/dist/server/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/server/setup.ts","../../src/server/helpers/next.ts","../../src/server/helpers/persistent.ts","../../src/server/index.ts"],"names":["logger"],"mappings":";;;;;;AAAA,YAAYA,aAAY;AAExB,SAAS,uBAAuB;;;ACFhC,YAAY,YAAY;AAQjB,SAAS,qBAAqB;AACnC,MAAM,iBAAiB,CAAC,QAAQ,MAAM,WAAW,OAAO,GAClD,gBAAgB,QAAQ,IAAI,yBAAyB,KACrD,gBAAgB,QAAQ,IAAI,aAAa;AAC/C,SAAO,EAAE,gBAAgB,eAAe,cAAc;AACxD;AALgB;AAaT,SAAS,gBAAgB,YAA4B,UAAkB;AAC5E,MAAM,YAAY,SAAS,MAAM,GAAG,GAC9B,YAAY;AAAA;AAAA,IAEhB,GAAG,WAAW;AAAA;AAAA,IAEd,GAAG,WAAW,iBAAiB;AAAA,EACjC;AAEA,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,QAAQ,SAAS;AAGlD,QAFmB,IAAI,SAAS,GAAG,KAAK,IAAI,SAAS,GAAG,GAExC;AACd,UAAM,WAAW,IAAI,MAAM,GAAG;AAC9B,UAAI,SAAS,WAAW,UAAU,OAAQ;AAE1C,eAAS,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK;AACxC,YAAM,UAAU,SAAS,CAAC,GACpB,WAAW,UAAU,CAAC;AAI5B,YAFkB,QAAQ,SAAS,GAAG,KAAK,QAAQ,SAAS,GAAG,MAChD,SAAS,CAAC,IAAI,WACzB,SAAS,CAAC,MAAM,UAAU,CAAC,EAAG;AAElC,YAAI,MAAM,SAAS,SAAS,KACtB,MAAM,SAAS,QAAQ;AAAG,iBAAO;AAAA,MACzC;AAAA,IACF,OAAO;AACL,UAAI,QAAQ,SAAU;AACtB,aAAK,MAAM,SAAS,QAAQ,IACrB,OAD+B;AAAA,IAExC;AAGF,SAAO;AACT;AAnCgB;AA2ChB,eAAsB,cACpB,YACA,UACA;AACA,MAAI;AAEF,IAAI,iBAAiB,aAEnB,MAAM,WAAW,aAAa,WAAW;AAAA,MACvC,MAAM;AAAA,MACN,YAAY;AAAA,IACd,CAAC,IACQ,gBAAgB,aAGzB,MAAM,WAAW,WAAW,EAAE,MAAM,UAAU,YAAY,GAAM,CAAC,IAG1D;AAAA,MACL;AAAA,IACF;AAAA,EAEJ,QAAQ;AAAA,EAAC;AAGT,MAAM,gBAAgB,WAAW,YAAY,QAAQ;AACrD,SAAO,UAAQ,aAAa;AAC9B;AA3BsB;;;AChEtB,YAAYA,aAAY;AAGxB,SAAS,gBAAgB,QAAgB;AACvC,MAAI,QAAQ,IAAI,mCAAmC,IAAK;AAExD,MAAM,OAAO,mBAAmB;AAChC,MAAK,KAAK;AAMH,IAAK,KAAK,kBACR;AAAA,MACL,oCAAoC,MAAM;AAAA;AAAA;AAAA;AAAA,IAI5C;AAAA,MAXA,OAAM,IAAI;AAAA,IACR,gCAAgC,MAAM;AAAA;AAAA;AAAA,EAGxC;AASJ;AAlBS;AAuBF,IAAM,mBAAmB,OAAO,IAAI,mBAAmB;AAMvD,SAAS,cAAc,QAAoB;AAChD,UAAQ,IAAI,YAAY,kBAAkB,MAAM;AAClD;AAFgB;AAUT,SAAS,gBAAgB;AAC9B,yBAAgB,eAAe,GACxB,QAAQ,IAAI,YAAY,gBAAgB;AACjD;AAHgB;AAKT,SAAS,cAAc,QAAqB;AACjD,MAAM,WAAW,cAAc;AAC/B,SAAI,aACA,UAAQ,cAAc,MAAM,GACzB;AACT;AALgB;AAUT,IAAM,wBAAwB,OAAO,IAAI,wBAAwB;AAMjE,SAAS,mBAAmB,UAA2B;AAC5D,UAAQ,IAAI,YAAY,uBAAuB,QAAQ;AACzD;AAFgB;AAUT,SAAS,qBAAqB;AACnC,yBAAgB,oBAAoB,GAC7B,QAAQ,IAAI,YAAY,qBAAqB;AACtD;AAHgB;AAKT,SAAS,mBAAmB,UAA4B;AAC7D,MAAM,WAAW,mBAAmB;AACpC,SAAI,aACA,YAAU,mBAAmB,QAAQ,GAClC;AACT;AALgB;;;AFxET,SAAS,qBAAqB,YAA4B;AAC/D,UAAQ,IAAI,uBAAuB,OAAO,CAAC,GAE3C,QAAQ,IAAI,iCAAiC,OAAO,CAAC;AAErD,MAAM,aAAa,cAAc,WAAW,eAAe,UAAU,GAC/D,WAAW,mBAAmB,IAAI,gBAAgB,EAAE,UAAU,GAAK,CAAC,CAAC;AAI3E,MAFA,OAAO,QAAQ,IAAI,gCAEf,CAAC;AACH,WAAc,cAAM,gDAAgD;AACtE,MAAI,CAAC;AACH,WAAc,cAAM,qDAAqD;AAE3E,EAAO,cAAM,4CAA4C,GAEzD,WAAW,GAAG,WAAW,OAAO,SAAS,QAAQ,SAAS;AAExD,QAAM,WADM,IAAI,IAAI,QAAQ,OAAO,IAAI,WAAW,EAC7B;AACrB,QAAI,SAAS,WAAW,QAAQ,EAAG;AAEnC,QAAM,WAAW,gBAAgB,YAAY,QAAQ;AACrD,QAAI,CAAC;AACH,aAAO,cAAM,4CAA4C,QAAQ,EAAE,GAC5D,OAAO,QAAQ;AAGxB,QAAM,aAAa,MAAM,cAAc,YAAY,QAAQ;AAC3D,QAAI,CAAC;AACH,aAAO,cAAM,4CAA4C,QAAQ,EAAE,GAC5D,OAAO,QAAQ;AAGxB,QAAM,gBAAgB,YAAY,aAAa,UAAU;AACzD,WAAI,CAAC,iBAAiB,OAAO,iBAAkB,cACtC,cAAM,aAAa,QAAQ,mCAAmC,GAC9D,OAAO,QAAQ,KAGjB,SAAS,cAAc,SAAS,QAAQ,MAAM,CAAC,GAAG,MAAM;AAC7D,UAAM,UAAU,cAAc,GAAG,GAAG,QAAQ;AAC5C,MAAI,OAAO,WAAY,cAAY,EAAE,KAAK,SAAS,MAAM,QAAQ,CAAC;AAAA,IACpE,CAAC;AAAA,EACH,CAAC;AACH;AA7CgB;AAiDT,SAAS,qBAAyC;AACvD,uBAAqB,IAAI;AAC3B;AAFgB;;;AG5CT,SAAS,cAAc;AAC5B,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;AAJgB","sourcesContent":["import * as logger from 'next/dist/build/output/log';\nimport type NextNodeServer from 'next/dist/server/next-server';\nimport { WebSocketServer } from 'ws';\nimport { getPageModule, resolveFilename } from './helpers/next';\nimport { useHttpServer, useWebSocketServer } from './helpers/persistent';\n\nexport function setupWebSocketServer(nextServer: NextNodeServer) {\n  process.env.NEXT_WS_MAIN_PROCESS = String(1);\n\n  process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK = String(1);\n  // @ts-expect-error - serverOptions is protected\n  const httpServer = useHttpServer(nextServer.serverOptions?.httpServer);\n  const wsServer = useWebSocketServer(new WebSocketServer({ noServer: true }));\n  // biome-ignore lint/performance/noDelete: <explanation>\n  delete process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK;\n\n  if (!httpServer)\n    return logger.error('[next-ws] was not able to find the HTTP server');\n  if (!wsServer)\n    return logger.error('[next-ws] was not able to find the WebSocket server');\n\n  logger.ready('[next-ws] has started the WebSocket server');\n\n  httpServer.on('upgrade', async (request, socket, head) => {\n    const url = new URL(request.url ?? '', 'ws://next');\n    const pathname = url.pathname;\n    if (pathname.startsWith('/_next')) return;\n\n    const filename = resolveFilename(nextServer, pathname);\n    if (!filename) {\n      logger.error(`[next-ws] could not find module for page ${pathname}`);\n      return socket.destroy();\n    }\n\n    const pageModule = await getPageModule(nextServer, filename);\n    if (!pageModule) {\n      logger.error(`[next-ws] could not find module for page ${pathname}`);\n      return socket.destroy();\n    }\n\n    const socketHandler = pageModule?.routeModule?.userland?.SOCKET;\n    if (!socketHandler || typeof socketHandler !== 'function') {\n      logger.error(`[next-ws] ${pathname} does not export a SOCKET handler`);\n      return socket.destroy();\n    }\n\n    return wsServer.handleUpgrade(request, socket, head, (c, r) => {\n      const dispose = socketHandler(c, r, wsServer);\n      if (typeof dispose === 'function') c.once('close', () => dispose());\n    });\n  });\n}\n\n// Next WS versions below 0.2.0 used a different method of setup\n// This remains for backwards compatibility, but may be removed in a future version\nexport function hookNextNodeServer(this: NextNodeServer) {\n  setupWebSocketServer(this);\n}\n","import * as logger from 'next/dist/build/output/log';\nimport type NextNodeServer from 'next/dist/server/next-server';\nimport type { SocketHandler } from './persistent';\n\n/**\n * Get the environment metadata.\n * @returns The environment metadata.\n */\nexport function getEnvironmentMeta() {\n  const isCustomServer = !process.title.startsWith('next-');\n  const isMainProcess = process.env.NEXT_WS_MAIN_PROCESS === '1';\n  const isDevelopment = process.env.NODE_ENV === 'development';\n  return { isCustomServer, isMainProcess, isDevelopment };\n}\n\n/**\n * Resolve a filename to a page.\n * @param nextServer The NextNodeServer instance.\n * @param pathname The pathname to resolve.\n * @returns The resolved page filename, or null if the page could not be resolved.\n */\nexport function resolveFilename(nextServer: NextNodeServer, pathname: string) {\n  const pathParts = pathname.split('/');\n  const appRoutes = {\n    // @ts-expect-error - appPathRoutes is protected\n    ...nextServer.appPathRoutes,\n    // @ts-expect-error - getAppPathRoutes is protected\n    ...nextServer.getAppPathRoutes(),\n  };\n\n  for (const [key, [path]] of Object.entries(appRoutes)) {\n    const hasDynamic = key.includes('[') && key.includes(']');\n\n    if (hasDynamic) {\n      const keyParts = key.split('/');\n      if (keyParts.length !== pathParts.length) continue;\n\n      for (let i = 0; i < keyParts.length; i++) {\n        const keyPart = keyParts[i]!;\n        const pathPart = pathParts[i]!;\n\n        const isDynamic = keyPart.includes('[') && keyPart.includes(']');\n        if (isDynamic) keyParts[i] = pathPart;\n        if (keyParts[i] !== pathParts[i]) break;\n\n        if (i === keyParts.length - 1)\n          if (path?.endsWith('/route')) return path;\n      }\n    } else {\n      if (key !== pathname) continue;\n      if (!path?.endsWith('/route')) return null;\n      return path;\n    }\n  }\n\n  return null;\n}\n\n/**\n * Get the page module for a page.\n * @param nextServer The NextNodeServer instance.\n * @param filename The filename of the page.\n * @returns The page module.\n */\nexport async function getPageModule(\n  nextServer: NextNodeServer,\n  filename: string,\n) {\n  try {\n    // In Next.js 14, hotReloader was removed and ensurePage was moved to NextNodeServer\n    if ('hotReloader' in nextServer) {\n      // @ts-expect-error - hotReloader only exists in Next.js 13\n      await nextServer.hotReloader?.ensurePage({\n        page: filename,\n        clientOnly: false,\n      });\n    } else if ('ensurePage' in nextServer) {\n      // ensurePage throws an error in production, so we need to catch it\n      // @ts-expect-error - ensurePage is protected\n      await nextServer.ensurePage({ page: filename, clientOnly: false });\n    } else {\n      // Future-proofing\n      logger.warnOnce(\n        '[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it',\n      );\n    }\n  } catch {}\n\n  // @ts-expect-error - getPageModule is protected\n  const buildPagePath = nextServer.getPagePath(filename);\n  return require(buildPagePath) as PageModule;\n}\n\nexport interface PageModule {\n  routeModule?: {\n    userland?: {\n      SOCKET?: SocketHandler;\n    };\n  };\n}\n","import * as logger from 'next/dist/build/output/log';\nimport { getEnvironmentMeta } from './next';\n\nfunction mainProcessOnly(fnName: string) {\n  if (process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK === '1') return;\n\n  const meta = getEnvironmentMeta();\n  if (!meta.isMainProcess) {\n    throw new Error(\n      `[next-ws] Attempt to invoke '${fnName}' outside the main process.\nYou may be attempting to interact with the WebSocket server outside of a SOCKET handler. This will fail in production, as Next.js employs a worker process for routing, which do not have access to the WebSocket server on the main process.\nYou can resolve this by using a custom server.`,\n    );\n  } else if (!meta.isCustomServer) {\n    logger.warnOnce(\n      `[next-ws] Caution: The function '${fnName}' was invoked without a custom server.\nThis could lead to unintended behaviour, especially if you're attempting to interact with the WebSocket server outside of a SOCKET handler.\nPlease note, while such configurations might function during development, they will fail in production. This is because Next.js employs a worker process for routing in production, which do not have access to the WebSocket server on the main process.\nYou can resolve this by using a custom server.`,\n    );\n  }\n}\n\n// ========== HTTP Server ==========\n\nimport type { Server as HttpServer } from 'node:http';\nexport const NextWsHttpServer = Symbol.for('NextWs_HttpServer');\n\n/**\n * Set the HTTP server that the WebSocket server should listen on, must be called before the WebSocket server is created.\n * @param server The HTTP server.\n */\nexport function setHttpServer(server: HttpServer) {\n  Reflect.set(globalThis, NextWsHttpServer, server);\n}\n\n/**\n * Get the HTTP server that the WebSocket server is listening on.\n * @remark If you want to access the HTTP server outside of a SOCKET handler, you must be using a custom server.\n * @returns The HTTP server.\n * @throws If attempting to access the HTTP server outside of the main process.\n */\nexport function getHttpServer() {\n  mainProcessOnly('getHttpServer');\n  return Reflect.get(globalThis, NextWsHttpServer) as HttpServer;\n}\n\nexport function useHttpServer(server?: HttpServer) {\n  const existing = getHttpServer();\n  if (existing) return existing;\n  if (server) setHttpServer(server);\n  return server;\n}\n\n// ========== WebSocket Server ==========\n\nimport type { WebSocketServer } from 'ws';\nexport const NextWsWebSocketServer = Symbol.for('NextWs_WebSocketServer');\n\n/**\n * Set the WebSocket server that the WebSocket server should listen on, must be called before the WebSocket server is created.\n * @param wsServer The WebSocket server.\n */\nexport function setWebSocketServer(wsServer: WebSocketServer) {\n  Reflect.set(globalThis, NextWsWebSocketServer, wsServer);\n}\n\n/**\n * Get the WebSocket server that the WebSocket server is listening on.\n * @remark If you want to access the WebSocket server outside of a SOCKET handler, you must be using a custom server.\n * @returns The WebSocket server.\n * @throws If attempting to access the WebSocket server outside of the main process.\n */\nexport function getWebSocketServer() {\n  mainProcessOnly('getWebSocketServer');\n  return Reflect.get(globalThis, NextWsWebSocketServer) as WebSocketServer;\n}\n\nexport function useWebSocketServer(wsServer?: WebSocketServer) {\n  const existing = getWebSocketServer();\n  if (existing) return existing;\n  if (wsServer) setWebSocketServer(wsServer);\n  return wsServer;\n}\n\n/** A function that handles a WebSocket connection. */\nexport type SocketHandler = (\n  /** The WebSocket client that connected. */\n  client: import('ws').WebSocket,\n  /** The HTTP request that initiated the WebSocket connection. */\n  request: import('http').IncomingMessage,\n  /** The WebSocket server. */\n  server: import('ws').WebSocketServer,\n) => unknown | (() => void);\n","export * from './setup';\nexport {\n  setHttpServer,\n  getHttpServer,\n  setWebSocketServer,\n  getWebSocketServer,\n} from './helpers/persistent';\n\n/**\n * @deprecated\n */\nexport function verifyPatch() {\n  throw new Error(\n    \"The 'verifyPatch' function has been deprecated in favour of the `npx next-ws-cli@latest verify` command.\",\n  );\n}\n"]}
+{"version":3,"sources":["../../src/server/setup.ts","../../src/server/helpers/persistent.ts","../../src/server/helpers/route.ts","../../src/server/index.ts"],"names":["logger"],"mappings":";;;;;;AAAA,YAAYA,aAAY;AAExB,SAAS,uBAAuB;;;ACFhC,YAAY,YAAY;AAMxB,SAAS,qBAAqB;AAC5B,MAAM,iBAAiB,CAAC,QAAQ,MAAM,WAAW,OAAO,GAClD,gBAAgB,QAAQ,IAAI,yBAAyB,KACrD,gBAAgB,QAAQ,IAAI,aAAa;AAC/C,SAAO,EAAE,gBAAgB,eAAe,cAAc;AACxD;AALS;AAOT,SAAS,gBAAgB,QAAgB;AACvC,MAAI,QAAQ,IAAI,mCAAmC,IAAK;AAExD,MAAM,OAAO,mBAAmB;AAChC,MAAK,KAAK;AAMH,IAAK,KAAK,kBACR;AAAA,MACL,oCAAoC,MAAM;AAAA;AAAA;AAAA;AAAA,IAI5C;AAAA,MAXA,OAAM,IAAI;AAAA,IACR,gCAAgC,MAAM;AAAA;AAAA;AAAA,EAGxC;AASJ;AAlBS;AAuBF,IAAM,mBAAmB,OAAO,IAAI,mBAAmB;AAMvD,SAAS,cAAc,QAAoB;AAChD,UAAQ,IAAI,YAAY,kBAAkB,MAAM;AAClD;AAFgB;AAUT,SAAS,gBAAgB;AAC9B,yBAAgB,eAAe,GACxB,QAAQ,IAAI,YAAY,gBAAgB;AACjD;AAHgB;AAKT,SAAS,cAAc,QAAqB;AACjD,MAAM,WAAW,cAAc;AAC/B,SAAI,aACA,UAAQ,cAAc,MAAM,GACzB;AACT;AALgB;AAUT,IAAM,wBAAwB,OAAO,IAAI,wBAAwB;AAMjE,SAAS,mBAAmB,UAA2B;AAC5D,UAAQ,IAAI,YAAY,uBAAuB,QAAQ;AACzD;AAFgB;AAUT,SAAS,qBAAqB;AACnC,yBAAgB,oBAAoB,GAC7B,QAAQ,IAAI,YAAY,qBAAqB;AACtD;AAHgB;AAKT,SAAS,mBAAmB,UAA4B;AAC7D,MAAM,WAAW,mBAAmB;AACpC,SAAI,aACA,YAAU,mBAAmB,QAAQ,GAClC;AACT;AALgB;;;ACxFhB,YAAYA,aAAY;AAIxB,SAAS,iBAAiB,cAAsB;AAE9C,MAAM,aADiB,aAAa,QAAQ,yBAAyB,MAAM,EAExE,QAAQ,4BAA4B,cAAc,EAClD,QAAQ,uCAAuC,gBAAgB;AAClE,SAAO,IAAI,OAAO,IAAI,UAAU,GAAG;AACrC;AANS;AAQT,SAAS,eAAe,cAAsB,WAAmB;AAC/D,MAAM,aAAa,iBAAiB,YAAY,GAC1C,QAAQ,UAAU,MAAM,UAAU;AACxC,MAAI,CAAC,MAAO,QAAO;AACnB,MAAI,CAAC,MAAM,OAAQ,QAAO,CAAC;AAE3B,MAAM,SAA4C,CAAC;AACnD,WAAS,CAAC,GAAG,CAAC,KAAK,OAAO,QAAQ,MAAM,MAAM;AAC5C,IAAI,EAAE,WAAW,OAAO,MAAI,IAAI,EAAE,MAAM,CAAC,GAAK,IAAI,EAAE,MAAM,GAAG,IAC7D,QAAQ,IAAI,QAAQ,GAAG,CAAC;AAE1B,SAAO;AACT;AAZS;AAoBF,SAAS,mBACd,YACA,aACA;AACA,MAAM,SAAS;AAAA;AAAA,IAEb,GAAG,WAAW;AAAA;AAAA,IAEd,GAAG,WAAW,iBAAiB;AAAA,EACjC;AAEA,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,OAAO,QAAQ,MAAM,GAAG;AAC5D,QAAM,cAAc,eAAe,WAAW,WAAW;AACzD,QAAI,YAAa,QAAO,EAAE,UAAqB,YAAY;AAAA,EAC7D;AAEA,SAAO;AACT;AAjBgB;AAyBhB,eAAsB,kBACpB,YACA,UACA;AACA,MAAI;AAEF,IAAI,iBAAiB,aAEnB,MAAM,WAAW,aAAa,WAAW;AAAA,MACvC,MAAM;AAAA,MACN,YAAY;AAAA,IACd,CAAC,IACQ,gBAAgB,aAGzB,MAAM,WAAW,WAAW,EAAE,MAAM,UAAU,YAAY,GAAM,CAAC,IAG1D;AAAA,MACL;AAAA,IACF;AAAA,EAEJ,QAAQ;AAAA,EAAC;AAGT,MAAM,gBAAgB,WAAW,YAAY,QAAQ;AACrD,SAAO,UAAQ,aAAa;AAC9B;AA3BsB;;;AFnDf,SAAS,qBAAqB,YAA4B;AAC/D,UAAQ,IAAI,uBAAuB,OAAO,CAAC,GAE3C,QAAQ,IAAI,iCAAiC,OAAO,CAAC;AAErD,MAAM,aAAa,cAAc,WAAW,eAAe,UAAU,GAC/D,WAAW,mBAAmB,IAAI,gBAAgB,EAAE,UAAU,GAAK,CAAC,CAAC;AAI3E,MAFA,OAAO,QAAQ,IAAI,gCAEf,CAAC;AACH,WAAc,cAAM,gDAAgD;AACtE,MAAI,CAAC;AACH,WAAc,cAAM,qDAAqD;AAE3E,EAAO,cAAM,4CAA4C,GAEzD,WAAW,GAAG,WAAW,OAAO,SAAS,QAAQ,SAAS;AAExD,QAAM,WADM,IAAI,IAAI,QAAQ,OAAO,IAAI,WAAW,EAC7B;AACrB,QAAI,SAAS,WAAW,QAAQ,EAAG;AAEnC,QAAM,YAAY,mBAAmB,YAAY,QAAQ;AACzD,QAAI,CAAC;AACH,aAAO,cAAM,4CAA4C,QAAQ,EAAE,GAC5D,OAAO,QAAQ;AAGxB,QAAM,cAAc,MAAM,kBAAkB,YAAY,UAAU,QAAQ;AAC1E,QAAI,CAAC;AACH,aAAO,cAAM,4CAA4C,QAAQ,EAAE,GAC5D,OAAO,QAAQ;AAGxB,QAAM,gBAAgB,aAAa,aAAa,UAAU;AAC1D,WAAI,CAAC,iBAAiB,OAAO,iBAAkB,cACtC,cAAM,aAAa,QAAQ,mCAAmC,GAC9D,OAAO,QAAQ,KAGjB,SAAS,cAAc,SAAS,QAAQ,MAAM,OAAO,GAAG,MAAM;AACnE,UAAM,eAAe,EAAE,QAAQ,UAAU,YAAY,GAC/C,cAAc,MAAM,cAAc,GAAG,GAAG,UAAU,YAAY;AACpE,MAAI,OAAO,eAAgB,cACzB,EAAE,KAAK,SAAS,MAAM,YAAY,CAAC;AAAA,IACvC,CAAC;AAAA,EACH,CAAC;AACH;AA/CgB;AAmDT,SAAS,qBAAyC;AACvD,uBAAqB,IAAI;AAC3B;AAFgB;;;AG9CT,SAAS,cAAc;AAC5B,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;AAJgB","sourcesContent":["import * as logger from 'next/dist/build/output/log';\nimport type NextNodeServer from 'next/dist/server/next-server';\nimport { WebSocketServer } from 'ws';\nimport { useHttpServer, useWebSocketServer } from './helpers/persistent';\nimport { importRouteModule, resolvePathToRoute } from './helpers/route';\n\nexport function setupWebSocketServer(nextServer: NextNodeServer) {\n  process.env.NEXT_WS_MAIN_PROCESS = String(1);\n\n  process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK = String(1);\n  // @ts-expect-error - serverOptions is protected\n  const httpServer = useHttpServer(nextServer.serverOptions?.httpServer);\n  const wsServer = useWebSocketServer(new WebSocketServer({ noServer: true }));\n  // biome-ignore lint/performance/noDelete: <explanation>\n  delete process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK;\n\n  if (!httpServer)\n    return logger.error('[next-ws] was not able to find the HTTP server');\n  if (!wsServer)\n    return logger.error('[next-ws] was not able to find the WebSocket server');\n\n  logger.ready('[next-ws] has started the WebSocket server');\n\n  httpServer.on('upgrade', async (request, socket, head) => {\n    const url = new URL(request.url ?? '', 'ws://next');\n    const pathname = url.pathname;\n    if (pathname.startsWith('/_next')) return;\n\n    const routeInfo = resolvePathToRoute(nextServer, pathname);\n    if (!routeInfo) {\n      logger.error(`[next-ws] could not find module for page ${pathname}`);\n      return socket.destroy();\n    }\n\n    const routeModule = await importRouteModule(nextServer, routeInfo.filePath);\n    if (!routeModule) {\n      logger.error(`[next-ws] could not find module for page ${pathname}`);\n      return socket.destroy();\n    }\n\n    const socketHandler = routeModule?.routeModule?.userland?.SOCKET;\n    if (!socketHandler || typeof socketHandler !== 'function') {\n      logger.error(`[next-ws] ${pathname} does not export a SOCKET handler`);\n      return socket.destroy();\n    }\n\n    return wsServer.handleUpgrade(request, socket, head, async (c, r) => {\n      const routeContext = { params: routeInfo.routeParams };\n      const handleClose = await socketHandler(c, r, wsServer, routeContext);\n      if (typeof handleClose === 'function')\n        c.once('close', () => handleClose());\n    });\n  });\n}\n\n// Next WS versions below 0.2.0 used a different method of setup\n// This remains for backwards compatibility, but may be removed in a future version\nexport function hookNextNodeServer(this: NextNodeServer) {\n  setupWebSocketServer(this);\n}\n","import * as logger from 'next/dist/build/output/log';\n\n/**\n * Get the environment metadata.\n * @returns The environment metadata.\n */\nfunction getEnvironmentMeta() {\n  const isCustomServer = !process.title.startsWith('next-');\n  const isMainProcess = process.env.NEXT_WS_MAIN_PROCESS === '1';\n  const isDevelopment = process.env.NODE_ENV === 'development';\n  return { isCustomServer, isMainProcess, isDevelopment };\n}\n\nfunction mainProcessOnly(fnName: string) {\n  if (process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK === '1') return;\n\n  const meta = getEnvironmentMeta();\n  if (!meta.isMainProcess) {\n    throw new Error(\n      `[next-ws] Attempt to invoke '${fnName}' outside the main process.\nYou may be attempting to interact with the WebSocket server outside of a SOCKET handler. This will fail in production, as Next.js employs a worker process for routing, which do not have access to the WebSocket server on the main process.\nYou can resolve this by using a custom server.`,\n    );\n  } else if (!meta.isCustomServer) {\n    logger.warnOnce(\n      `[next-ws] Caution: The function '${fnName}' was invoked without a custom server.\nThis could lead to unintended behaviour, especially if you're attempting to interact with the WebSocket server outside of a SOCKET handler.\nPlease note, while such configurations might function during development, they will fail in production. This is because Next.js employs a worker process for routing in production, which do not have access to the WebSocket server on the main process.\nYou can resolve this by using a custom server.`,\n    );\n  }\n}\n\n// ========== HTTP Server ==========\n\nimport type { Server as HttpServer } from 'node:http';\nexport const NextWsHttpServer = Symbol.for('NextWs_HttpServer');\n\n/**\n * Set the HTTP server that the WebSocket server should listen on, must be called before the WebSocket server is created.\n * @param server The HTTP server.\n */\nexport function setHttpServer(server: HttpServer) {\n  Reflect.set(globalThis, NextWsHttpServer, server);\n}\n\n/**\n * Get the HTTP server that the WebSocket server is listening on.\n * @remark If you want to access the HTTP server outside of a SOCKET handler, you must be using a custom server.\n * @returns The HTTP server.\n * @throws If attempting to access the HTTP server outside of the main process.\n */\nexport function getHttpServer() {\n  mainProcessOnly('getHttpServer');\n  return Reflect.get(globalThis, NextWsHttpServer) as HttpServer;\n}\n\nexport function useHttpServer(server?: HttpServer) {\n  const existing = getHttpServer();\n  if (existing) return existing;\n  if (server) setHttpServer(server);\n  return server;\n}\n\n// ========== WebSocket Server ==========\n\nimport type { WebSocketServer } from 'ws';\nexport const NextWsWebSocketServer = Symbol.for('NextWs_WebSocketServer');\n\n/**\n * Set the WebSocket server that the WebSocket server should listen on, must be called before the WebSocket server is created.\n * @param wsServer The WebSocket server.\n */\nexport function setWebSocketServer(wsServer: WebSocketServer) {\n  Reflect.set(globalThis, NextWsWebSocketServer, wsServer);\n}\n\n/**\n * Get the WebSocket server that the WebSocket server is listening on.\n * @remark If you want to access the WebSocket server outside of a SOCKET handler, you must be using a custom server.\n * @returns The WebSocket server.\n * @throws If attempting to access the WebSocket server outside of the main process.\n */\nexport function getWebSocketServer() {\n  mainProcessOnly('getWebSocketServer');\n  return Reflect.get(globalThis, NextWsWebSocketServer) as WebSocketServer;\n}\n\nexport function useWebSocketServer(wsServer?: WebSocketServer) {\n  const existing = getWebSocketServer();\n  if (existing) return existing;\n  if (wsServer) setWebSocketServer(wsServer);\n  return wsServer;\n}\n","import * as logger from 'next/dist/build/output/log';\nimport type NextNodeServer from 'next/dist/server/next-server';\nimport type { SocketHandler } from './socket';\n\nfunction createRouteRegex(routePattern: string) {\n  const escapedPattern = routePattern.replace(/[-/\\\\^$*+?.()|[\\]{}]/g, '\\\\$&');\n  const paramRegex = escapedPattern\n    .replace(/\\\\\\[([a-zA-Z0-9_]+)\\\\\\]/g, '(?<$1>[^/]+)') // Match [param]\n    .replace(/\\\\\\[(?:\\\\\\.){3}([a-zA-Z0-9_]+)\\\\\\]/g, '(?<rest_$1>.+)'); // Match [...param]\n  return new RegExp(`^${paramRegex}$`);\n}\n\nfunction getRouteParams(routePattern: string, routePath: string) {\n  const routeRegex = createRouteRegex(routePattern);\n  const match = routePath.match(routeRegex);\n  if (!match) return null;\n  if (!match.groups) return {};\n\n  const params: Record<string, string | string[]> = {};\n  for (let [k, v] of Object.entries(match.groups)) {\n    if (k.startsWith('rest_')) (k = k.slice(5)), (v = v.split('/') as never);\n    Reflect.set(params, k, v);\n  }\n  return params;\n}\n\n/**\n * Resolve a request path to a route file path and route parameters.\n * @param nextServer The NextNodeServer instance.\n * @param requestPath The request path to resolve for.\n * @returns The resolved file path and route parameters, or null if the route could not be resolved.\n */\nexport function resolvePathToRoute(\n  nextServer: NextNodeServer,\n  requestPath: string,\n) {\n  const routes = {\n    // @ts-expect-error - appPathRoutes is protected\n    ...nextServer.appPathRoutes,\n    // @ts-expect-error - getAppPathRoutes is protected\n    ...nextServer.getAppPathRoutes(),\n  };\n\n  for (const [routePath, [filePath]] of Object.entries(routes)) {\n    const routeParams = getRouteParams(routePath, requestPath);\n    if (routeParams) return { filePath: filePath!, routeParams };\n  }\n\n  return null;\n}\n\n/**\n * Import the route module for a route.\n * @param nextServer The NextNodeServer instance.\n * @param filePath The file path of the route.\n * @returns\n */\nexport async function importRouteModule(\n  nextServer: NextNodeServer,\n  filePath: string,\n) {\n  try {\n    // In Next.js 14, hotReloader was removed and ensurePage was moved to NextNodeServer\n    if ('hotReloader' in nextServer) {\n      // @ts-expect-error - hotReloader only exists in Next.js 13\n      await nextServer.hotReloader?.ensurePage({\n        page: filePath,\n        clientOnly: false,\n      });\n    } else if ('ensurePage' in nextServer) {\n      // ensurePage throws an error in production, so we need to catch it\n      // @ts-expect-error - ensurePage is protected\n      await nextServer.ensurePage({ page: filePath, clientOnly: false });\n    } else {\n      // Future-proofing\n      logger.warnOnce(\n        '[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it',\n      );\n    }\n  } catch {}\n\n  // @ts-expect-error - getPageModule is protected\n  const buildPagePath = nextServer.getPagePath(filePath);\n  return require(buildPagePath) as RouteModule;\n}\n\nexport interface RouteModule {\n  routeModule?: {\n    userland?: {\n      SOCKET?: SocketHandler;\n    };\n  };\n}\n","export * from './setup';\nexport {\n  setHttpServer,\n  getHttpServer,\n  setWebSocketServer,\n  getWebSocketServer,\n} from './helpers/persistent';\n\n/**\n * @deprecated\n */\nexport function verifyPatch() {\n  throw new Error(\n    \"The 'verifyPatch' function has been deprecated in favour of the `npx next-ws-cli@latest verify` command.\",\n  );\n}\n"]}

package/dist/server/index.d.cts

@@ -1,6 +1,6 @@
 import NextNodeServer from 'next/dist/server/next-server';
-import { WebSocketServer } from 'ws';
 import { Server } from 'node:http';
+import { WebSocketServer } from 'ws';
 
 declare function setupWebSocketServer(nextServer: NextNodeServer): void;
 declare function hookNextNodeServer(this: NextNodeServer): void;

package/dist/server/index.d.ts

@@ -1,6 +1,6 @@
 import NextNodeServer from 'next/dist/server/next-server';
-import { WebSocketServer } from 'ws';
 import { Server } from 'node:http';
+import { WebSocketServer } from 'ws';
 
 declare function setupWebSocketServer(nextServer: NextNodeServer): void;
 declare function hookNextNodeServer(this: NextNodeServer): void;

package/dist/server/{index.mjs → index.js}

@@ -1,4 +1,4 @@
-import { __name, __require } from '../chunk-6VWOYYWX.mjs';
+import { __name, __require } from '../chunk-WO25ABG2.js';
 import * as logger3 from 'next/dist/build/output/log';
 import { WebSocketServer } from 'ws';
 
@@ -7,44 +7,6 @@ function getEnvironmentMeta() {
   return { isCustomServer, isMainProcess, isDevelopment };
 }
 __name(getEnvironmentMeta, "getEnvironmentMeta");
-function resolveFilename(nextServer, pathname) {
-  let pathParts = pathname.split("/"), appRoutes = {
-    // @ts-expect-error - appPathRoutes is protected
-    ...nextServer.appPathRoutes,
-    // @ts-expect-error - getAppPathRoutes is protected
-    ...nextServer.getAppPathRoutes()
-  };
-  for (let [key, [path]] of Object.entries(appRoutes))
-    if (key.includes("[") && key.includes("]")) {
-      let keyParts = key.split("/");
-      if (keyParts.length !== pathParts.length) continue;
-      for (let i = 0; i < keyParts.length; i++) {
-        let keyPart = keyParts[i], pathPart = pathParts[i];
-        if (keyPart.includes("[") && keyPart.includes("]") && (keyParts[i] = pathPart), keyParts[i] !== pathParts[i]) break;
-        if (i === keyParts.length - 1 && path?.endsWith("/route"))
-          return path;
-      }
-    } else {
-      if (key !== pathname) continue;
-      return path?.endsWith("/route") ? path : null;
-    }
-  return null;
-}
-__name(resolveFilename, "resolveFilename");
-async function getPageModule(nextServer, filename) {
-  try {
-    "hotReloader" in nextServer ? await nextServer.hotReloader?.ensurePage({
-      page: filename,
-      clientOnly: !1
-    }) : "ensurePage" in nextServer ? await nextServer.ensurePage({ page: filename, clientOnly: !1 }) : logger3.warnOnce(
-      "[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it"
-    );
-  } catch {
-  }
-  let buildPagePath = nextServer.getPagePath(filename);
-  return __require(buildPagePath);
-}
-__name(getPageModule, "getPageModule");
 function mainProcessOnly(fnName) {
   if (process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK === "1") return;
   let meta = getEnvironmentMeta();
@@ -90,6 +52,49 @@ function useWebSocketServer(wsServer) {
   return existing || (wsServer && setWebSocketServer(wsServer), wsServer);
 }
 __name(useWebSocketServer, "useWebSocketServer");
+function createRouteRegex(routePattern) {
+  let paramRegex = routePattern.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&").replace(/\\\[([a-zA-Z0-9_]+)\\\]/g, "(?<$1>[^/]+)").replace(/\\\[(?:\\\.){3}([a-zA-Z0-9_]+)\\\]/g, "(?<rest_$1>.+)");
+  return new RegExp(`^${paramRegex}$`);
+}
+__name(createRouteRegex, "createRouteRegex");
+function getRouteParams(routePattern, routePath) {
+  let routeRegex = createRouteRegex(routePattern), match = routePath.match(routeRegex);
+  if (!match) return null;
+  if (!match.groups) return {};
+  let params = {};
+  for (let [k, v] of Object.entries(match.groups))
+    k.startsWith("rest_") && (k = k.slice(5), v = v.split("/")), Reflect.set(params, k, v);
+  return params;
+}
+__name(getRouteParams, "getRouteParams");
+function resolvePathToRoute(nextServer, requestPath) {
+  let routes = {
+    // @ts-expect-error - appPathRoutes is protected
+    ...nextServer.appPathRoutes,
+    // @ts-expect-error - getAppPathRoutes is protected
+    ...nextServer.getAppPathRoutes()
+  };
+  for (let [routePath, [filePath]] of Object.entries(routes)) {
+    let routeParams = getRouteParams(routePath, requestPath);
+    if (routeParams) return { filePath, routeParams };
+  }
+  return null;
+}
+__name(resolvePathToRoute, "resolvePathToRoute");
+async function importRouteModule(nextServer, filePath) {
+  try {
+    "hotReloader" in nextServer ? await nextServer.hotReloader?.ensurePage({
+      page: filePath,
+      clientOnly: !1
+    }) : "ensurePage" in nextServer ? await nextServer.ensurePage({ page: filePath, clientOnly: !1 }) : logger3.warnOnce(
+      "[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it"
+    );
+  } catch {
+  }
+  let buildPagePath = nextServer.getPagePath(filePath);
+  return __require(buildPagePath);
+}
+__name(importRouteModule, "importRouteModule");
 
 // src/server/setup.ts
 function setupWebSocketServer(nextServer) {
@@ -102,16 +107,16 @@ function setupWebSocketServer(nextServer) {
   logger3.ready("[next-ws] has started the WebSocket server"), httpServer.on("upgrade", async (request, socket, head) => {
     let pathname = new URL(request.url ?? "", "ws://next").pathname;
     if (pathname.startsWith("/_next")) return;
-    let filename = resolveFilename(nextServer, pathname);
-    if (!filename)
+    let routeInfo = resolvePathToRoute(nextServer, pathname);
+    if (!routeInfo)
       return logger3.error(`[next-ws] could not find module for page ${pathname}`), socket.destroy();
-    let pageModule = await getPageModule(nextServer, filename);
-    if (!pageModule)
+    let routeModule = await importRouteModule(nextServer, routeInfo.filePath);
+    if (!routeModule)
       return logger3.error(`[next-ws] could not find module for page ${pathname}`), socket.destroy();
-    let socketHandler = pageModule?.routeModule?.userland?.SOCKET;
-    return !socketHandler || typeof socketHandler != "function" ? (logger3.error(`[next-ws] ${pathname} does not export a SOCKET handler`), socket.destroy()) : wsServer.handleUpgrade(request, socket, head, (c, r) => {
-      let dispose = socketHandler(c, r, wsServer);
-      typeof dispose == "function" && c.once("close", () => dispose());
+    let socketHandler = routeModule?.routeModule?.userland?.SOCKET;
+    return !socketHandler || typeof socketHandler != "function" ? (logger3.error(`[next-ws] ${pathname} does not export a SOCKET handler`), socket.destroy()) : wsServer.handleUpgrade(request, socket, head, async (c, r) => {
+      let routeContext = { params: routeInfo.routeParams }, handleClose = await socketHandler(c, r, wsServer, routeContext);
+      typeof handleClose == "function" && c.once("close", () => handleClose());
     });
   });
 }
@@ -131,4 +136,4 @@ __name(verifyPatch, "verifyPatch");
 
 export { getHttpServer, getWebSocketServer, hookNextNodeServer, setHttpServer, setWebSocketServer, setupWebSocketServer, verifyPatch };
 //# sourceMappingURL=out.js.map
-//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.js.map

package/dist/server/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/server/setup.ts","../../src/server/helpers/persistent.ts","../../src/server/helpers/route.ts","../../src/server/index.ts"],"names":["logger"],"mappings":";;;;;;AAAA,YAAYA,aAAY;AAExB,SAAS,uBAAuB;;;ACFhC,YAAY,YAAY;AAMxB,SAAS,qBAAqB;AAC5B,MAAM,iBAAiB,CAAC,QAAQ,MAAM,WAAW,OAAO,GAClD,gBAAgB,QAAQ,IAAI,yBAAyB,KACrD,gBAAgB,QAAQ,IAAI,aAAa;AAC/C,SAAO,EAAE,gBAAgB,eAAe,cAAc;AACxD;AALS;AAOT,SAAS,gBAAgB,QAAgB;AACvC,MAAI,QAAQ,IAAI,mCAAmC,IAAK;AAExD,MAAM,OAAO,mBAAmB;AAChC,MAAK,KAAK;AAMH,IAAK,KAAK,kBACR;AAAA,MACL,oCAAoC,MAAM;AAAA;AAAA;AAAA;AAAA,IAI5C;AAAA,MAXA,OAAM,IAAI;AAAA,IACR,gCAAgC,MAAM;AAAA;AAAA;AAAA,EAGxC;AASJ;AAlBS;AAuBF,IAAM,mBAAmB,OAAO,IAAI,mBAAmB;AAMvD,SAAS,cAAc,QAAoB;AAChD,UAAQ,IAAI,YAAY,kBAAkB,MAAM;AAClD;AAFgB;AAUT,SAAS,gBAAgB;AAC9B,yBAAgB,eAAe,GACxB,QAAQ,IAAI,YAAY,gBAAgB;AACjD;AAHgB;AAKT,SAAS,cAAc,QAAqB;AACjD,MAAM,WAAW,cAAc;AAC/B,SAAI,aACA,UAAQ,cAAc,MAAM,GACzB;AACT;AALgB;AAUT,IAAM,wBAAwB,OAAO,IAAI,wBAAwB;AAMjE,SAAS,mBAAmB,UAA2B;AAC5D,UAAQ,IAAI,YAAY,uBAAuB,QAAQ;AACzD;AAFgB;AAUT,SAAS,qBAAqB;AACnC,yBAAgB,oBAAoB,GAC7B,QAAQ,IAAI,YAAY,qBAAqB;AACtD;AAHgB;AAKT,SAAS,mBAAmB,UAA4B;AAC7D,MAAM,WAAW,mBAAmB;AACpC,SAAI,aACA,YAAU,mBAAmB,QAAQ,GAClC;AACT;AALgB;;;ACxFhB,YAAYA,aAAY;AAIxB,SAAS,iBAAiB,cAAsB;AAE9C,MAAM,aADiB,aAAa,QAAQ,yBAAyB,MAAM,EAExE,QAAQ,4BAA4B,cAAc,EAClD,QAAQ,uCAAuC,gBAAgB;AAClE,SAAO,IAAI,OAAO,IAAI,UAAU,GAAG;AACrC;AANS;AAQT,SAAS,eAAe,cAAsB,WAAmB;AAC/D,MAAM,aAAa,iBAAiB,YAAY,GAC1C,QAAQ,UAAU,MAAM,UAAU;AACxC,MAAI,CAAC,MAAO,QAAO;AACnB,MAAI,CAAC,MAAM,OAAQ,QAAO,CAAC;AAE3B,MAAM,SAA4C,CAAC;AACnD,WAAS,CAAC,GAAG,CAAC,KAAK,OAAO,QAAQ,MAAM,MAAM;AAC5C,IAAI,EAAE,WAAW,OAAO,MAAI,IAAI,EAAE,MAAM,CAAC,GAAK,IAAI,EAAE,MAAM,GAAG,IAC7D,QAAQ,IAAI,QAAQ,GAAG,CAAC;AAE1B,SAAO;AACT;AAZS;AAoBF,SAAS,mBACd,YACA,aACA;AACA,MAAM,SAAS;AAAA;AAAA,IAEb,GAAG,WAAW;AAAA;AAAA,IAEd,GAAG,WAAW,iBAAiB;AAAA,EACjC;AAEA,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,OAAO,QAAQ,MAAM,GAAG;AAC5D,QAAM,cAAc,eAAe,WAAW,WAAW;AACzD,QAAI,YAAa,QAAO,EAAE,UAAqB,YAAY;AAAA,EAC7D;AAEA,SAAO;AACT;AAjBgB;AAyBhB,eAAsB,kBACpB,YACA,UACA;AACA,MAAI;AAEF,IAAI,iBAAiB,aAEnB,MAAM,WAAW,aAAa,WAAW;AAAA,MACvC,MAAM;AAAA,MACN,YAAY;AAAA,IACd,CAAC,IACQ,gBAAgB,aAGzB,MAAM,WAAW,WAAW,EAAE,MAAM,UAAU,YAAY,GAAM,CAAC,IAG1D;AAAA,MACL;AAAA,IACF;AAAA,EAEJ,QAAQ;AAAA,EAAC;AAGT,MAAM,gBAAgB,WAAW,YAAY,QAAQ;AACrD,SAAO,UAAQ,aAAa;AAC9B;AA3BsB;;;AFnDf,SAAS,qBAAqB,YAA4B;AAC/D,UAAQ,IAAI,uBAAuB,OAAO,CAAC,GAE3C,QAAQ,IAAI,iCAAiC,OAAO,CAAC;AAErD,MAAM,aAAa,cAAc,WAAW,eAAe,UAAU,GAC/D,WAAW,mBAAmB,IAAI,gBAAgB,EAAE,UAAU,GAAK,CAAC,CAAC;AAI3E,MAFA,OAAO,QAAQ,IAAI,gCAEf,CAAC;AACH,WAAc,cAAM,gDAAgD;AACtE,MAAI,CAAC;AACH,WAAc,cAAM,qDAAqD;AAE3E,EAAO,cAAM,4CAA4C,GAEzD,WAAW,GAAG,WAAW,OAAO,SAAS,QAAQ,SAAS;AAExD,QAAM,WADM,IAAI,IAAI,QAAQ,OAAO,IAAI,WAAW,EAC7B;AACrB,QAAI,SAAS,WAAW,QAAQ,EAAG;AAEnC,QAAM,YAAY,mBAAmB,YAAY,QAAQ;AACzD,QAAI,CAAC;AACH,aAAO,cAAM,4CAA4C,QAAQ,EAAE,GAC5D,OAAO,QAAQ;AAGxB,QAAM,cAAc,MAAM,kBAAkB,YAAY,UAAU,QAAQ;AAC1E,QAAI,CAAC;AACH,aAAO,cAAM,4CAA4C,QAAQ,EAAE,GAC5D,OAAO,QAAQ;AAGxB,QAAM,gBAAgB,aAAa,aAAa,UAAU;AAC1D,WAAI,CAAC,iBAAiB,OAAO,iBAAkB,cACtC,cAAM,aAAa,QAAQ,mCAAmC,GAC9D,OAAO,QAAQ,KAGjB,SAAS,cAAc,SAAS,QAAQ,MAAM,OAAO,GAAG,MAAM;AACnE,UAAM,eAAe,EAAE,QAAQ,UAAU,YAAY,GAC/C,cAAc,MAAM,cAAc,GAAG,GAAG,UAAU,YAAY;AACpE,MAAI,OAAO,eAAgB,cACzB,EAAE,KAAK,SAAS,MAAM,YAAY,CAAC;AAAA,IACvC,CAAC;AAAA,EACH,CAAC;AACH;AA/CgB;AAmDT,SAAS,qBAAyC;AACvD,uBAAqB,IAAI;AAC3B;AAFgB;;;AG9CT,SAAS,cAAc;AAC5B,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;AAJgB","sourcesContent":["import * as logger from 'next/dist/build/output/log';\nimport type NextNodeServer from 'next/dist/server/next-server';\nimport { WebSocketServer } from 'ws';\nimport { useHttpServer, useWebSocketServer } from './helpers/persistent';\nimport { importRouteModule, resolvePathToRoute } from './helpers/route';\n\nexport function setupWebSocketServer(nextServer: NextNodeServer) {\n  process.env.NEXT_WS_MAIN_PROCESS = String(1);\n\n  process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK = String(1);\n  // @ts-expect-error - serverOptions is protected\n  const httpServer = useHttpServer(nextServer.serverOptions?.httpServer);\n  const wsServer = useWebSocketServer(new WebSocketServer({ noServer: true }));\n  // biome-ignore lint/performance/noDelete: <explanation>\n  delete process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK;\n\n  if (!httpServer)\n    return logger.error('[next-ws] was not able to find the HTTP server');\n  if (!wsServer)\n    return logger.error('[next-ws] was not able to find the WebSocket server');\n\n  logger.ready('[next-ws] has started the WebSocket server');\n\n  httpServer.on('upgrade', async (request, socket, head) => {\n    const url = new URL(request.url ?? '', 'ws://next');\n    const pathname = url.pathname;\n    if (pathname.startsWith('/_next')) return;\n\n    const routeInfo = resolvePathToRoute(nextServer, pathname);\n    if (!routeInfo) {\n      logger.error(`[next-ws] could not find module for page ${pathname}`);\n      return socket.destroy();\n    }\n\n    const routeModule = await importRouteModule(nextServer, routeInfo.filePath);\n    if (!routeModule) {\n      logger.error(`[next-ws] could not find module for page ${pathname}`);\n      return socket.destroy();\n    }\n\n    const socketHandler = routeModule?.routeModule?.userland?.SOCKET;\n    if (!socketHandler || typeof socketHandler !== 'function') {\n      logger.error(`[next-ws] ${pathname} does not export a SOCKET handler`);\n      return socket.destroy();\n    }\n\n    return wsServer.handleUpgrade(request, socket, head, async (c, r) => {\n      const routeContext = { params: routeInfo.routeParams };\n      const handleClose = await socketHandler(c, r, wsServer, routeContext);\n      if (typeof handleClose === 'function')\n        c.once('close', () => handleClose());\n    });\n  });\n}\n\n// Next WS versions below 0.2.0 used a different method of setup\n// This remains for backwards compatibility, but may be removed in a future version\nexport function hookNextNodeServer(this: NextNodeServer) {\n  setupWebSocketServer(this);\n}\n","import * as logger from 'next/dist/build/output/log';\n\n/**\n * Get the environment metadata.\n * @returns The environment metadata.\n */\nfunction getEnvironmentMeta() {\n  const isCustomServer = !process.title.startsWith('next-');\n  const isMainProcess = process.env.NEXT_WS_MAIN_PROCESS === '1';\n  const isDevelopment = process.env.NODE_ENV === 'development';\n  return { isCustomServer, isMainProcess, isDevelopment };\n}\n\nfunction mainProcessOnly(fnName: string) {\n  if (process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK === '1') return;\n\n  const meta = getEnvironmentMeta();\n  if (!meta.isMainProcess) {\n    throw new Error(\n      `[next-ws] Attempt to invoke '${fnName}' outside the main process.\nYou may be attempting to interact with the WebSocket server outside of a SOCKET handler. This will fail in production, as Next.js employs a worker process for routing, which do not have access to the WebSocket server on the main process.\nYou can resolve this by using a custom server.`,\n    );\n  } else if (!meta.isCustomServer) {\n    logger.warnOnce(\n      `[next-ws] Caution: The function '${fnName}' was invoked without a custom server.\nThis could lead to unintended behaviour, especially if you're attempting to interact with the WebSocket server outside of a SOCKET handler.\nPlease note, while such configurations might function during development, they will fail in production. This is because Next.js employs a worker process for routing in production, which do not have access to the WebSocket server on the main process.\nYou can resolve this by using a custom server.`,\n    );\n  }\n}\n\n// ========== HTTP Server ==========\n\nimport type { Server as HttpServer } from 'node:http';\nexport const NextWsHttpServer = Symbol.for('NextWs_HttpServer');\n\n/**\n * Set the HTTP server that the WebSocket server should listen on, must be called before the WebSocket server is created.\n * @param server The HTTP server.\n */\nexport function setHttpServer(server: HttpServer) {\n  Reflect.set(globalThis, NextWsHttpServer, server);\n}\n\n/**\n * Get the HTTP server that the WebSocket server is listening on.\n * @remark If you want to access the HTTP server outside of a SOCKET handler, you must be using a custom server.\n * @returns The HTTP server.\n * @throws If attempting to access the HTTP server outside of the main process.\n */\nexport function getHttpServer() {\n  mainProcessOnly('getHttpServer');\n  return Reflect.get(globalThis, NextWsHttpServer) as HttpServer;\n}\n\nexport function useHttpServer(server?: HttpServer) {\n  const existing = getHttpServer();\n  if (existing) return existing;\n  if (server) setHttpServer(server);\n  return server;\n}\n\n// ========== WebSocket Server ==========\n\nimport type { WebSocketServer } from 'ws';\nexport const NextWsWebSocketServer = Symbol.for('NextWs_WebSocketServer');\n\n/**\n * Set the WebSocket server that the WebSocket server should listen on, must be called before the WebSocket server is created.\n * @param wsServer The WebSocket server.\n */\nexport function setWebSocketServer(wsServer: WebSocketServer) {\n  Reflect.set(globalThis, NextWsWebSocketServer, wsServer);\n}\n\n/**\n * Get the WebSocket server that the WebSocket server is listening on.\n * @remark If you want to access the WebSocket server outside of a SOCKET handler, you must be using a custom server.\n * @returns The WebSocket server.\n * @throws If attempting to access the WebSocket server outside of the main process.\n */\nexport function getWebSocketServer() {\n  mainProcessOnly('getWebSocketServer');\n  return Reflect.get(globalThis, NextWsWebSocketServer) as WebSocketServer;\n}\n\nexport function useWebSocketServer(wsServer?: WebSocketServer) {\n  const existing = getWebSocketServer();\n  if (existing) return existing;\n  if (wsServer) setWebSocketServer(wsServer);\n  return wsServer;\n}\n","import * as logger from 'next/dist/build/output/log';\nimport type NextNodeServer from 'next/dist/server/next-server';\nimport type { SocketHandler } from './socket';\n\nfunction createRouteRegex(routePattern: string) {\n  const escapedPattern = routePattern.replace(/[-/\\\\^$*+?.()|[\\]{}]/g, '\\\\$&');\n  const paramRegex = escapedPattern\n    .replace(/\\\\\\[([a-zA-Z0-9_]+)\\\\\\]/g, '(?<$1>[^/]+)') // Match [param]\n    .replace(/\\\\\\[(?:\\\\\\.){3}([a-zA-Z0-9_]+)\\\\\\]/g, '(?<rest_$1>.+)'); // Match [...param]\n  return new RegExp(`^${paramRegex}$`);\n}\n\nfunction getRouteParams(routePattern: string, routePath: string) {\n  const routeRegex = createRouteRegex(routePattern);\n  const match = routePath.match(routeRegex);\n  if (!match) return null;\n  if (!match.groups) return {};\n\n  const params: Record<string, string | string[]> = {};\n  for (let [k, v] of Object.entries(match.groups)) {\n    if (k.startsWith('rest_')) (k = k.slice(5)), (v = v.split('/') as never);\n    Reflect.set(params, k, v);\n  }\n  return params;\n}\n\n/**\n * Resolve a request path to a route file path and route parameters.\n * @param nextServer The NextNodeServer instance.\n * @param requestPath The request path to resolve for.\n * @returns The resolved file path and route parameters, or null if the route could not be resolved.\n */\nexport function resolvePathToRoute(\n  nextServer: NextNodeServer,\n  requestPath: string,\n) {\n  const routes = {\n    // @ts-expect-error - appPathRoutes is protected\n    ...nextServer.appPathRoutes,\n    // @ts-expect-error - getAppPathRoutes is protected\n    ...nextServer.getAppPathRoutes(),\n  };\n\n  for (const [routePath, [filePath]] of Object.entries(routes)) {\n    const routeParams = getRouteParams(routePath, requestPath);\n    if (routeParams) return { filePath: filePath!, routeParams };\n  }\n\n  return null;\n}\n\n/**\n * Import the route module for a route.\n * @param nextServer The NextNodeServer instance.\n * @param filePath The file path of the route.\n * @returns\n */\nexport async function importRouteModule(\n  nextServer: NextNodeServer,\n  filePath: string,\n) {\n  try {\n    // In Next.js 14, hotReloader was removed and ensurePage was moved to NextNodeServer\n    if ('hotReloader' in nextServer) {\n      // @ts-expect-error - hotReloader only exists in Next.js 13\n      await nextServer.hotReloader?.ensurePage({\n        page: filePath,\n        clientOnly: false,\n      });\n    } else if ('ensurePage' in nextServer) {\n      // ensurePage throws an error in production, so we need to catch it\n      // @ts-expect-error - ensurePage is protected\n      await nextServer.ensurePage({ page: filePath, clientOnly: false });\n    } else {\n      // Future-proofing\n      logger.warnOnce(\n        '[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it',\n      );\n    }\n  } catch {}\n\n  // @ts-expect-error - getPageModule is protected\n  const buildPagePath = nextServer.getPagePath(filePath);\n  return require(buildPagePath) as RouteModule;\n}\n\nexport interface RouteModule {\n  routeModule?: {\n    userland?: {\n      SOCKET?: SocketHandler;\n    };\n  };\n}\n","export * from './setup';\nexport {\n  setHttpServer,\n  getHttpServer,\n  setWebSocketServer,\n  getWebSocketServer,\n} from './helpers/persistent';\n\n/**\n * @deprecated\n */\nexport function verifyPatch() {\n  throw new Error(\n    \"The 'verifyPatch' function has been deprecated in favour of the `npx next-ws-cli@latest verify` command.\",\n  );\n}\n"]}

package/package.json

@@ -1,10 +1,16 @@
 {
   "name": "next-ws",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "type": "module",
   "description": "Add support for WebSockets in Next.js 13 app directory",
   "license": "MIT",
-  "keywords": ["next", "websocket", "ws", "server", "client"],
+  "keywords": [
+    "next",
+    "websocket",
+    "ws",
+    "server",
+    "client"
+  ],
   "homepage": "https://github.com/apteryxxyz/next-ws#readme",
   "repository": {
     "type": "git",
@@ -14,37 +20,36 @@
   "bugs": {
     "url": "https://github.com/apteryxxyz/next-ws/issues"
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "exports": {
     "./client": {
-      "import": "./dist/client/index.mjs",
+      "import": "./dist/client/index.js",
       "require": "./dist/client/index.cjs",
       "types": "./dist/client/index.d.ts"
     },
     "./server": {
-      "import": "./dist/server/index.mjs",
+      "import": "./dist/server/index.js",
       "require": "./dist/server/index.cjs",
       "types": "./dist/server/index.d.ts"
     }
   },
-  "scripts": {
-    "lint": "biome lint . --write",
-    "format": "biome format . --write",
-    "check": "tsc --noEmit",
-    "build": "cp ../../readme.md . && tsup",
-    "dev": "pnpm build --watch"
-  },
   "peerDependencies": {
     "next": ">=13.1.1",
     "react": "*",
     "ws": "*"
   },
   "devDependencies": {
-    "@configs/tsup": "workspace:^",
     "@types/react": "^18.3.3",
     "@types/ws": "^8.5.10",
     "next": "^14.2.4",
     "react": "^18.3.1",
     "ws": "^8.17.1"
+  },
+  "scripts": {
+    "check": "tsc --noEmit",
+    "build": "cp ../../readme.md . && tsup",
+    "dev": "pnpm build --watch"
   }
-}
+}

package/readme.md

@@ -1,16 +1,16 @@
-<div align="center">
+<div align='center'>
   <h1><strong>Next WS</strong></h1>
   <i>Add support for WebSockets in Next.js app directory</i><br>
   <code>npm install next-ws ws</code>
 </div>
 
-<div align="center">
-  <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">
+<div align='center'>
+  <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://discord.gg/vZQbMhwsKY"><img src="https://discordapp.com/api/guilds/829836158007115806/widget.png?style=shield" alt="discord shield"/></a>
+  <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://discord.gg/B2rEQ9g2vf'><img src='https://discordapp.com/api/guilds/829836158007115806/widget.png?style=shield' alt='discord shield'/></a>
 </div>
 
 ## 🤔 About
@@ -59,7 +59,7 @@ The `SOCKET` function receives three arguments: the WebSocket client instance, t
 export function SOCKET(
   client: import('ws').WebSocket,
   request: import('http').IncomingMessage,
-  server: import('ws').WebSocketServer,
+  server: import('ws').WebSocketServer
 ) {
   // ...
 }
@@ -85,7 +85,7 @@ Creating an API route anywhere within the app directory and exporting a `SOCKET`
 export function SOCKET(
   client: import('ws').WebSocket,
   request: import('http').IncomingMessage,
-  server: import('ws').WebSocketServer,
+  server: import('ws').WebSocketServer
 ) {
   console.log('A client connected');
 
@@ -102,6 +102,9 @@ export function SOCKET(
 
 ### Using a Custom Server
 
+> [!IMPORTANT]  
+> Next WS was made to avoid the need for a custom server, if you are using one, you don't need this package and can just use a websocket server directly.
+
 To use a custom server, all you need to do is tell Next WS to use your server instead of creating its own. This can be done by calling the `setHttpServer` and `setWebSocketServer` functions from `next-ws/server` and passing your server instances.
 
 ```ts
@@ -123,7 +126,7 @@ const webSocketServer = new WebSocketServer({ noServer: true });
 setHttpServer(httpServer);
 setWebSocketServer(webSocketServer);
 
-const app = next({ dev, hostname, port, customServer: httpServer });
+const app = next({ dev, hostname, port, customServer: true });
 const handle = app.getRequestHandler();
 
 app.prepare().then(() => {
@@ -169,15 +172,15 @@ To make it easier to connect to your new WebSocket server, Next WS also provides
 import { WebSocketProvider } from 'next-ws/client';
 
 export default function Layout({ children }: React.PropsWithChildren) {
-  return <html>
-    <body>
-      <WebSocketProvider
-        url="ws://localhost:3000/api/ws"
-      >
-        {children}
-      </WebSocketProvider>
-    </body>
-  </html>;
+  return (
+    <html>
+      <body>
+        <WebSocketProvider url='ws://localhost:3000/api/ws'>
+          {children}
+        </WebSocketProvider>
+      </body>
+    </html>
+  );
 }
 ```
 
@@ -224,23 +227,20 @@ export default function Page() {
     return () => ws?.removeEventListener('message', onMessage);
   }, [ws]);
 
-  return <>
-    <input
-      ref={inputRef}
-      type="text"
-    />
-
-    <button
-      onClick={() => ws?.send(inputRef.current?.value ?? '')}
-    >
-      Send message to server
-    </button>
-
-    <p>
-      {message === null
-        ? 'Waiting to receive message...'
-        : `Got message: ${message}`}
-    </p>
-  </>;
+  return (
+    <>
+      <input ref={inputRef} type='text' />
+
+      <button onClick={() => ws?.send(inputRef.current?.value ?? '')}>
+        Send message to server
+      </button>
+
+      <p>
+        {message === null
+          ? 'Waiting to receive message...'
+          : `Got message: ${message}`}
+      </p>
+    </>
+  );
 }
-```
+```

package/dist/server/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/server/setup.ts","../../src/server/helpers/next.ts","../../src/server/helpers/persistent.ts","../../src/server/index.ts"],"names":["logger"],"mappings":";;;;;;AAAA,YAAYA,aAAY;AAExB,SAAS,uBAAuB;;;ACFhC,YAAY,YAAY;AAQjB,SAAS,qBAAqB;AACnC,MAAM,iBAAiB,CAAC,QAAQ,MAAM,WAAW,OAAO,GAClD,gBAAgB,QAAQ,IAAI,yBAAyB,KACrD,gBAAgB,QAAQ,IAAI,aAAa;AAC/C,SAAO,EAAE,gBAAgB,eAAe,cAAc;AACxD;AALgB;AAaT,SAAS,gBAAgB,YAA4B,UAAkB;AAC5E,MAAM,YAAY,SAAS,MAAM,GAAG,GAC9B,YAAY;AAAA;AAAA,IAEhB,GAAG,WAAW;AAAA;AAAA,IAEd,GAAG,WAAW,iBAAiB;AAAA,EACjC;AAEA,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,QAAQ,SAAS;AAGlD,QAFmB,IAAI,SAAS,GAAG,KAAK,IAAI,SAAS,GAAG,GAExC;AACd,UAAM,WAAW,IAAI,MAAM,GAAG;AAC9B,UAAI,SAAS,WAAW,UAAU,OAAQ;AAE1C,eAAS,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK;AACxC,YAAM,UAAU,SAAS,CAAC,GACpB,WAAW,UAAU,CAAC;AAI5B,YAFkB,QAAQ,SAAS,GAAG,KAAK,QAAQ,SAAS,GAAG,MAChD,SAAS,CAAC,IAAI,WACzB,SAAS,CAAC,MAAM,UAAU,CAAC,EAAG;AAElC,YAAI,MAAM,SAAS,SAAS,KACtB,MAAM,SAAS,QAAQ;AAAG,iBAAO;AAAA,MACzC;AAAA,IACF,OAAO;AACL,UAAI,QAAQ,SAAU;AACtB,aAAK,MAAM,SAAS,QAAQ,IACrB,OAD+B;AAAA,IAExC;AAGF,SAAO;AACT;AAnCgB;AA2ChB,eAAsB,cACpB,YACA,UACA;AACA,MAAI;AAEF,IAAI,iBAAiB,aAEnB,MAAM,WAAW,aAAa,WAAW;AAAA,MACvC,MAAM;AAAA,MACN,YAAY;AAAA,IACd,CAAC,IACQ,gBAAgB,aAGzB,MAAM,WAAW,WAAW,EAAE,MAAM,UAAU,YAAY,GAAM,CAAC,IAG1D;AAAA,MACL;AAAA,IACF;AAAA,EAEJ,QAAQ;AAAA,EAAC;AAGT,MAAM,gBAAgB,WAAW,YAAY,QAAQ;AACrD,SAAO,UAAQ,aAAa;AAC9B;AA3BsB;;;AChEtB,YAAYA,aAAY;AAGxB,SAAS,gBAAgB,QAAgB;AACvC,MAAI,QAAQ,IAAI,mCAAmC,IAAK;AAExD,MAAM,OAAO,mBAAmB;AAChC,MAAK,KAAK;AAMH,IAAK,KAAK,kBACR;AAAA,MACL,oCAAoC,MAAM;AAAA;AAAA;AAAA;AAAA,IAI5C;AAAA,MAXA,OAAM,IAAI;AAAA,IACR,gCAAgC,MAAM;AAAA;AAAA;AAAA,EAGxC;AASJ;AAlBS;AAuBF,IAAM,mBAAmB,OAAO,IAAI,mBAAmB;AAMvD,SAAS,cAAc,QAAoB;AAChD,UAAQ,IAAI,YAAY,kBAAkB,MAAM;AAClD;AAFgB;AAUT,SAAS,gBAAgB;AAC9B,yBAAgB,eAAe,GACxB,QAAQ,IAAI,YAAY,gBAAgB;AACjD;AAHgB;AAKT,SAAS,cAAc,QAAqB;AACjD,MAAM,WAAW,cAAc;AAC/B,SAAI,aACA,UAAQ,cAAc,MAAM,GACzB;AACT;AALgB;AAUT,IAAM,wBAAwB,OAAO,IAAI,wBAAwB;AAMjE,SAAS,mBAAmB,UAA2B;AAC5D,UAAQ,IAAI,YAAY,uBAAuB,QAAQ;AACzD;AAFgB;AAUT,SAAS,qBAAqB;AACnC,yBAAgB,oBAAoB,GAC7B,QAAQ,IAAI,YAAY,qBAAqB;AACtD;AAHgB;AAKT,SAAS,mBAAmB,UAA4B;AAC7D,MAAM,WAAW,mBAAmB;AACpC,SAAI,aACA,YAAU,mBAAmB,QAAQ,GAClC;AACT;AALgB;;;AFxET,SAAS,qBAAqB,YAA4B;AAC/D,UAAQ,IAAI,uBAAuB,OAAO,CAAC,GAE3C,QAAQ,IAAI,iCAAiC,OAAO,CAAC;AAErD,MAAM,aAAa,cAAc,WAAW,eAAe,UAAU,GAC/D,WAAW,mBAAmB,IAAI,gBAAgB,EAAE,UAAU,GAAK,CAAC,CAAC;AAI3E,MAFA,OAAO,QAAQ,IAAI,gCAEf,CAAC;AACH,WAAc,cAAM,gDAAgD;AACtE,MAAI,CAAC;AACH,WAAc,cAAM,qDAAqD;AAE3E,EAAO,cAAM,4CAA4C,GAEzD,WAAW,GAAG,WAAW,OAAO,SAAS,QAAQ,SAAS;AAExD,QAAM,WADM,IAAI,IAAI,QAAQ,OAAO,IAAI,WAAW,EAC7B;AACrB,QAAI,SAAS,WAAW,QAAQ,EAAG;AAEnC,QAAM,WAAW,gBAAgB,YAAY,QAAQ;AACrD,QAAI,CAAC;AACH,aAAO,cAAM,4CAA4C,QAAQ,EAAE,GAC5D,OAAO,QAAQ;AAGxB,QAAM,aAAa,MAAM,cAAc,YAAY,QAAQ;AAC3D,QAAI,CAAC;AACH,aAAO,cAAM,4CAA4C,QAAQ,EAAE,GAC5D,OAAO,QAAQ;AAGxB,QAAM,gBAAgB,YAAY,aAAa,UAAU;AACzD,WAAI,CAAC,iBAAiB,OAAO,iBAAkB,cACtC,cAAM,aAAa,QAAQ,mCAAmC,GAC9D,OAAO,QAAQ,KAGjB,SAAS,cAAc,SAAS,QAAQ,MAAM,CAAC,GAAG,MAAM;AAC7D,UAAM,UAAU,cAAc,GAAG,GAAG,QAAQ;AAC5C,MAAI,OAAO,WAAY,cAAY,EAAE,KAAK,SAAS,MAAM,QAAQ,CAAC;AAAA,IACpE,CAAC;AAAA,EACH,CAAC;AACH;AA7CgB;AAiDT,SAAS,qBAAyC;AACvD,uBAAqB,IAAI;AAC3B;AAFgB;;;AG5CT,SAAS,cAAc;AAC5B,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;AAJgB","sourcesContent":["import * as logger from 'next/dist/build/output/log';\nimport type NextNodeServer from 'next/dist/server/next-server';\nimport { WebSocketServer } from 'ws';\nimport { getPageModule, resolveFilename } from './helpers/next';\nimport { useHttpServer, useWebSocketServer } from './helpers/persistent';\n\nexport function setupWebSocketServer(nextServer: NextNodeServer) {\n  process.env.NEXT_WS_MAIN_PROCESS = String(1);\n\n  process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK = String(1);\n  // @ts-expect-error - serverOptions is protected\n  const httpServer = useHttpServer(nextServer.serverOptions?.httpServer);\n  const wsServer = useWebSocketServer(new WebSocketServer({ noServer: true }));\n  // biome-ignore lint/performance/noDelete: <explanation>\n  delete process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK;\n\n  if (!httpServer)\n    return logger.error('[next-ws] was not able to find the HTTP server');\n  if (!wsServer)\n    return logger.error('[next-ws] was not able to find the WebSocket server');\n\n  logger.ready('[next-ws] has started the WebSocket server');\n\n  httpServer.on('upgrade', async (request, socket, head) => {\n    const url = new URL(request.url ?? '', 'ws://next');\n    const pathname = url.pathname;\n    if (pathname.startsWith('/_next')) return;\n\n    const filename = resolveFilename(nextServer, pathname);\n    if (!filename) {\n      logger.error(`[next-ws] could not find module for page ${pathname}`);\n      return socket.destroy();\n    }\n\n    const pageModule = await getPageModule(nextServer, filename);\n    if (!pageModule) {\n      logger.error(`[next-ws] could not find module for page ${pathname}`);\n      return socket.destroy();\n    }\n\n    const socketHandler = pageModule?.routeModule?.userland?.SOCKET;\n    if (!socketHandler || typeof socketHandler !== 'function') {\n      logger.error(`[next-ws] ${pathname} does not export a SOCKET handler`);\n      return socket.destroy();\n    }\n\n    return wsServer.handleUpgrade(request, socket, head, (c, r) => {\n      const dispose = socketHandler(c, r, wsServer);\n      if (typeof dispose === 'function') c.once('close', () => dispose());\n    });\n  });\n}\n\n// Next WS versions below 0.2.0 used a different method of setup\n// This remains for backwards compatibility, but may be removed in a future version\nexport function hookNextNodeServer(this: NextNodeServer) {\n  setupWebSocketServer(this);\n}\n","import * as logger from 'next/dist/build/output/log';\nimport type NextNodeServer from 'next/dist/server/next-server';\nimport type { SocketHandler } from './persistent';\n\n/**\n * Get the environment metadata.\n * @returns The environment metadata.\n */\nexport function getEnvironmentMeta() {\n  const isCustomServer = !process.title.startsWith('next-');\n  const isMainProcess = process.env.NEXT_WS_MAIN_PROCESS === '1';\n  const isDevelopment = process.env.NODE_ENV === 'development';\n  return { isCustomServer, isMainProcess, isDevelopment };\n}\n\n/**\n * Resolve a filename to a page.\n * @param nextServer The NextNodeServer instance.\n * @param pathname The pathname to resolve.\n * @returns The resolved page filename, or null if the page could not be resolved.\n */\nexport function resolveFilename(nextServer: NextNodeServer, pathname: string) {\n  const pathParts = pathname.split('/');\n  const appRoutes = {\n    // @ts-expect-error - appPathRoutes is protected\n    ...nextServer.appPathRoutes,\n    // @ts-expect-error - getAppPathRoutes is protected\n    ...nextServer.getAppPathRoutes(),\n  };\n\n  for (const [key, [path]] of Object.entries(appRoutes)) {\n    const hasDynamic = key.includes('[') && key.includes(']');\n\n    if (hasDynamic) {\n      const keyParts = key.split('/');\n      if (keyParts.length !== pathParts.length) continue;\n\n      for (let i = 0; i < keyParts.length; i++) {\n        const keyPart = keyParts[i]!;\n        const pathPart = pathParts[i]!;\n\n        const isDynamic = keyPart.includes('[') && keyPart.includes(']');\n        if (isDynamic) keyParts[i] = pathPart;\n        if (keyParts[i] !== pathParts[i]) break;\n\n        if (i === keyParts.length - 1)\n          if (path?.endsWith('/route')) return path;\n      }\n    } else {\n      if (key !== pathname) continue;\n      if (!path?.endsWith('/route')) return null;\n      return path;\n    }\n  }\n\n  return null;\n}\n\n/**\n * Get the page module for a page.\n * @param nextServer The NextNodeServer instance.\n * @param filename The filename of the page.\n * @returns The page module.\n */\nexport async function getPageModule(\n  nextServer: NextNodeServer,\n  filename: string,\n) {\n  try {\n    // In Next.js 14, hotReloader was removed and ensurePage was moved to NextNodeServer\n    if ('hotReloader' in nextServer) {\n      // @ts-expect-error - hotReloader only exists in Next.js 13\n      await nextServer.hotReloader?.ensurePage({\n        page: filename,\n        clientOnly: false,\n      });\n    } else if ('ensurePage' in nextServer) {\n      // ensurePage throws an error in production, so we need to catch it\n      // @ts-expect-error - ensurePage is protected\n      await nextServer.ensurePage({ page: filename, clientOnly: false });\n    } else {\n      // Future-proofing\n      logger.warnOnce(\n        '[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it',\n      );\n    }\n  } catch {}\n\n  // @ts-expect-error - getPageModule is protected\n  const buildPagePath = nextServer.getPagePath(filename);\n  return require(buildPagePath) as PageModule;\n}\n\nexport interface PageModule {\n  routeModule?: {\n    userland?: {\n      SOCKET?: SocketHandler;\n    };\n  };\n}\n","import * as logger from 'next/dist/build/output/log';\nimport { getEnvironmentMeta } from './next';\n\nfunction mainProcessOnly(fnName: string) {\n  if (process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK === '1') return;\n\n  const meta = getEnvironmentMeta();\n  if (!meta.isMainProcess) {\n    throw new Error(\n      `[next-ws] Attempt to invoke '${fnName}' outside the main process.\nYou may be attempting to interact with the WebSocket server outside of a SOCKET handler. This will fail in production, as Next.js employs a worker process for routing, which do not have access to the WebSocket server on the main process.\nYou can resolve this by using a custom server.`,\n    );\n  } else if (!meta.isCustomServer) {\n    logger.warnOnce(\n      `[next-ws] Caution: The function '${fnName}' was invoked without a custom server.\nThis could lead to unintended behaviour, especially if you're attempting to interact with the WebSocket server outside of a SOCKET handler.\nPlease note, while such configurations might function during development, they will fail in production. This is because Next.js employs a worker process for routing in production, which do not have access to the WebSocket server on the main process.\nYou can resolve this by using a custom server.`,\n    );\n  }\n}\n\n// ========== HTTP Server ==========\n\nimport type { Server as HttpServer } from 'node:http';\nexport const NextWsHttpServer = Symbol.for('NextWs_HttpServer');\n\n/**\n * Set the HTTP server that the WebSocket server should listen on, must be called before the WebSocket server is created.\n * @param server The HTTP server.\n */\nexport function setHttpServer(server: HttpServer) {\n  Reflect.set(globalThis, NextWsHttpServer, server);\n}\n\n/**\n * Get the HTTP server that the WebSocket server is listening on.\n * @remark If you want to access the HTTP server outside of a SOCKET handler, you must be using a custom server.\n * @returns The HTTP server.\n * @throws If attempting to access the HTTP server outside of the main process.\n */\nexport function getHttpServer() {\n  mainProcessOnly('getHttpServer');\n  return Reflect.get(globalThis, NextWsHttpServer) as HttpServer;\n}\n\nexport function useHttpServer(server?: HttpServer) {\n  const existing = getHttpServer();\n  if (existing) return existing;\n  if (server) setHttpServer(server);\n  return server;\n}\n\n// ========== WebSocket Server ==========\n\nimport type { WebSocketServer } from 'ws';\nexport const NextWsWebSocketServer = Symbol.for('NextWs_WebSocketServer');\n\n/**\n * Set the WebSocket server that the WebSocket server should listen on, must be called before the WebSocket server is created.\n * @param wsServer The WebSocket server.\n */\nexport function setWebSocketServer(wsServer: WebSocketServer) {\n  Reflect.set(globalThis, NextWsWebSocketServer, wsServer);\n}\n\n/**\n * Get the WebSocket server that the WebSocket server is listening on.\n * @remark If you want to access the WebSocket server outside of a SOCKET handler, you must be using a custom server.\n * @returns The WebSocket server.\n * @throws If attempting to access the WebSocket server outside of the main process.\n */\nexport function getWebSocketServer() {\n  mainProcessOnly('getWebSocketServer');\n  return Reflect.get(globalThis, NextWsWebSocketServer) as WebSocketServer;\n}\n\nexport function useWebSocketServer(wsServer?: WebSocketServer) {\n  const existing = getWebSocketServer();\n  if (existing) return existing;\n  if (wsServer) setWebSocketServer(wsServer);\n  return wsServer;\n}\n\n/** A function that handles a WebSocket connection. */\nexport type SocketHandler = (\n  /** The WebSocket client that connected. */\n  client: import('ws').WebSocket,\n  /** The HTTP request that initiated the WebSocket connection. */\n  request: import('http').IncomingMessage,\n  /** The WebSocket server. */\n  server: import('ws').WebSocketServer,\n) => unknown | (() => void);\n","export * from './setup';\nexport {\n  setHttpServer,\n  getHttpServer,\n  setWebSocketServer,\n  getWebSocketServer,\n} from './helpers/persistent';\n\n/**\n * @deprecated\n */\nexport function verifyPatch() {\n  throw new Error(\n    \"The 'verifyPatch' function has been deprecated in favour of the `npx next-ws-cli@latest verify` command.\",\n  );\n}\n"]}