next-ws 0.0.0-beta-20250824084203 → 0.0.0-beta-20250827053941

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 = "0.0.0-beta-20250824084203";
+var version = "0.0.0-beta-20250827053941";
 
 // src/commands/helpers/define.ts
 function defineCommandGroup(definition) {
@@ -810,10 +810,12 @@ var patch_1_default = definePatch({
 // src/patches/patch-2.ts
 var patchHeaders2 = definePatchStep({
   ...patchHeaders,
+  // CHANGE(next@15): headers function was moved
   path: "next:dist/server/request/headers.js"
 });
 var patchCookies2 = definePatchStep({
   ...patchCookies,
+  // CHANGE(next@15): cookies function was moved
   path: "next:dist/server/request/cookies.js"
 });
 var patch_2_default = definePatch({

package/dist/server/index.cjs

@@ -62,8 +62,12 @@ var [getHttpServer, setHttpServer, useHttpServer] = (
     //
   )
 );
-var [getWebSocketServer, setWebSocketServer, useWebSocketServer] = useGlobal(
-  Symbol.for("next-ws.websocket-server")
+var [getWebSocketServer, setWebSocketServer, useWebSocketServer] = (
+  //
+  useGlobal(
+    Symbol.for("next-ws.websocket-server")
+    //
+  )
 );
 var [getRequestStorage, setRequestStorage, useRequestStorage] = (
   //
@@ -74,7 +78,7 @@ var [getRequestStorage, setRequestStorage, useRequestStorage] = (
 );
 
 // src/server/setup.ts
-var import_node_async_hooks2 = require("async_hooks");
+var import_node_async_hooks = require("async_hooks");
 var logger2 = __toESM(require("next/dist/build/output/log.js"));
 var import_ws = require("ws");
 
@@ -120,15 +124,15 @@ function findMatchingRoute(nextServer, requestPathname) {
 
 // src/server/helpers/module.ts
 var logger = __toESM(require("next/dist/build/output/log.js"));
-async function importRouteModule(nextServer, filePath) {
+async function importRouteModule(nextServer, filePathname) {
   try {
     if ("hotReloader" in nextServer) {
       await nextServer.hotReloader?.ensurePage({
-        page: filePath,
+        page: filePathname,
         clientOnly: false
       });
     } else if ("ensurePage" in nextServer) {
-      await nextServer.ensurePage({ page: filePath, clientOnly: false });
+      await nextServer.ensurePage({ page: filePathname, clientOnly: false });
     } else {
       logger.warnOnce(
         "[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it"
@@ -137,8 +141,8 @@ async function importRouteModule(nextServer, filePath) {
   } catch {
   }
   try {
-    const buildPagePath = nextServer.getPagePath(filePath);
-    return require(buildPagePath).routeModule;
+    const buildPagePath = nextServer.getPagePath(filePathname);
+    return (await require(buildPagePath)).routeModule;
   } catch (cause) {
     console.error(cause);
     return void 0;
@@ -163,7 +167,6 @@ function toNextRequest(message) {
 }
 
 // src/server/helpers/store.ts
-var import_node_async_hooks = require("async_hooks");
 var import_cookies = require("next/dist/compiled/@edge-runtime/cookies");
 var ReadonlyHeaders = class extends Headers {
   append() {
@@ -190,7 +193,6 @@ function createRequestStore(request) {
     cookies: new ReadonlyRequestsCookies(request.headers)
   };
 }
-var requestStorage = new import_node_async_hooks.AsyncLocalStorage();
 
 // src/server/setup.ts
 function setupWebSocketServer(nextServer) {
@@ -205,14 +207,14 @@ function setupWebSocketServer(nextServer) {
     //
     useWebSocketServer(() => new import_ws.WebSocketServer({ noServer: true }))
   );
-  const requestStorage2 = (
+  const requestStorage = (
     //
-    useRequestStorage(() => new import_node_async_hooks2.AsyncLocalStorage())
+    useRequestStorage(() => new import_node_async_hooks.AsyncLocalStorage())
   );
   logger2.ready("[next-ws] has started the WebSocket server");
-  const kInstalled = Symbol.for("next-ws.http-server.attached");
-  if (Reflect.has(httpServer, kInstalled)) return;
-  Reflect.set(httpServer, kInstalled, true);
+  const kAttached = Symbol.for("next-ws.http-server.attached");
+  if (Reflect.has(httpServer, kAttached)) return;
+  Reflect.set(httpServer, kAttached, true);
   httpServer.on("upgrade", async (message, socket, head) => {
     const request = toNextRequest(message);
     const pathname = request.nextUrl.pathname;
@@ -242,7 +244,7 @@ function setupWebSocketServer(nextServer) {
       try {
         const context = { params: route.params };
         if (handleUpgrade) {
-          await requestStorage2.run(
+          await requestStorage.run(
             createRequestStore(request),
             //
             () => handleUpgrade(client, wsServer, request, context)

package/dist/server/index.d.ts

@@ -3,19 +3,39 @@ import * as http from 'http';
 import * as ws from 'ws';
 import NextNodeServer from 'next/dist/server/next-server.js';
 
-/** @deprecated Prefer UPGRADE and {@link UpgradeHandler} */
+/**
+ * WebSocket socket handler.
+ * @param client WebSocket client instance
+ * @param request Node.js HTTP incoming message instance
+ * @param server WebSocket server instance
+ * @param context Route context
+ * @deprecated Prefer UPGRADE and {@link UpgradeHandler}
+ */
 type SocketHandler = (client: ws.WebSocket, request: http.IncomingMessage, server: ws.WebSocketServer, context: {
     params: Record<string, string | string[]>;
 }) => unknown;
+/**
+ * WebSocket upgrade handler.
+ * @param client WebSocket client instance
+ * @param server WebSocket server instance
+ * @param request Next.js request instance
+ * @param context Route context
+ */
 type UpgradeHandler = (client: ws.WebSocket, server: ws.WebSocketServer, request: next_server.NextRequest, context: RouteContext<string>) => unknown;
 
-type RouteParams<Path extends string> = Path extends `${infer Before}[[...${infer Param}]]${infer After}` ? RouteParams<Before> & {
+/**
+ * Extract the parameters from a route pattern.
+ */
+type RouteParams<Pattern extends string> = Pattern extends `${infer Before}[[...${infer Param}]]${infer After}` ? RouteParams<Before> & {
     [K in Param]?: string[];
-} & RouteParams<After> : Path extends `${infer Before}[...${infer Param}]${infer After}` ? RouteParams<Before> & {
+} & RouteParams<After> : Pattern extends `${infer Before}[...${infer Param}]${infer After}` ? RouteParams<Before> & {
     [K in Param]: string[];
-} & RouteParams<After> : Path extends `${infer Before}[${infer Param}]${infer After}` ? RouteParams<Before> & {
+} & RouteParams<After> : Pattern extends `${infer Before}[${infer Param}]${infer After}` ? RouteParams<Before> & {
     [K in Param]: string;
 } & RouteParams<After> : {};
+/**
+ * Route context object containing the parameters.
+ */
 type RouteContext<Path extends string> = {
     params: Record<string, string | string[] | undefined> & RouteParams<Path> & RouteParams<Path>;
 };
@@ -25,6 +45,10 @@ declare const setHttpServer: (value: http.Server<typeof http.IncomingMessage, ty
 declare const getWebSocketServer: () => ws.WebSocketServer | undefined;
 declare const setWebSocketServer: (value: ws.WebSocketServer) => boolean;
 
+/**
+ * Attach the WebSocket server to the HTTP server.
+ * @param nextServer Next.js Node server instance
+ */
 declare function setupWebSocketServer(nextServer: NextNodeServer): void;
 
 export { type RouteContext, type SocketHandler, type UpgradeHandler, getHttpServer, getWebSocketServer, setHttpServer, setWebSocketServer, setupWebSocketServer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-ws",
-  "version": "0.0.0-beta-20250824084203",
+  "version": "0.0.0-beta-20250827053941",
   "description": "Add support for WebSockets in the Next.js app directory",
   "license": "MIT",
   "keywords": [
@@ -49,6 +49,7 @@
     "@biomejs/biome": "^2.2.0",
     "@changesets/changelog-git": "^0.2.1",
     "@changesets/cli": "^2.27.12",
+    "@favware/npm-deprecate": "^2.0.0",
     "@playwright/test": "^1.55.0",
     "@types/jscodeshift": "^17.3.0",
     "@types/minimist": "^1.2.5",