npm - next-ws - Versions diffs - 1.1.1 → 2.0.0 - Mend

next-ws 1.1.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

package/README.md +100 -0
package/dist/chunk-3RG5ZIWI.js +10 -0
package/dist/cli.cjs +5399 -0
package/dist/client/index.cjs +64 -26
package/dist/client/index.js +38 -0
package/dist/server/index.cjs +180 -124
package/dist/server/index.d.cts +3 -9
package/dist/server/index.d.ts +3 -9
package/dist/server/index.js +181 -0
package/package.json +46 -24
package/dist/chunk-6VWOYYWX.mjs +0 -11
package/dist/chunk-6VWOYYWX.mjs.map +0 -1
package/dist/chunk-PFW3KWBF.cjs +0 -14
package/dist/chunk-PFW3KWBF.cjs.map +0 -1
package/dist/client/index.cjs.map +0 -1
package/dist/client/index.mjs +0 -29
package/dist/client/index.mjs.map +0 -1
package/dist/server/index.cjs.map +0 -1
package/dist/server/index.mjs +0 -134
package/dist/server/index.mjs.map +0 -1
package/readme.md +0 -246

package/dist/server/index.js ADDED Viewed

@@ -0,0 +1,181 @@
+import {
+  __require
+} from "../chunk-3RG5ZIWI.js";
+// src/server/setup.ts
+import * as logger3 from "next/dist/build/output/log.js";
+import { WebSocketServer } from "ws";
+// src/server/helpers/persistent.ts
+import * as logger from "next/dist/build/output/log.js";
+function getEnvironmentMeta() {
+  const isCustomServer = !process.title.startsWith("next-");
+  const isMainProcess = process.env.NEXT_WS_MAIN_PROCESS === "1";
+  const isDevelopment = process.env.NODE_ENV === "development";
+  return { isCustomServer, isMainProcess, isDevelopment };
+}
+function mainProcessOnly(fnName) {
+  if (process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK === "1") return;
+  const meta = getEnvironmentMeta();
+  if (!meta.isMainProcess) {
+    throw new Error(
+      `[next-ws] Attempt to invoke '${fnName}' outside the main process.
+You 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.
+You can resolve this by using a custom server.`
+    );
+  } else if (!meta.isCustomServer) {
+    logger.warnOnce(
+      `[next-ws] Caution: The function '${fnName}' was invoked without a custom server.
+This could lead to unintended behaviour, especially if you're attempting to interact with the WebSocket server outside of a SOCKET handler.
+Please 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.
+You can resolve this by using a custom server.`
+    );
+  }
+}
+var NextWsHttpServer = Symbol.for("NextWs_HttpServer");
+function setHttpServer(server) {
+  Reflect.set(globalThis, NextWsHttpServer, server);
+}
+function getHttpServer() {
+  mainProcessOnly("getHttpServer");
+  return Reflect.get(globalThis, NextWsHttpServer);
+}
+function useHttpServer(server) {
+  const existing = getHttpServer();
+  if (existing) return existing;
+  if (server) setHttpServer(server);
+  return server;
+}
+var NextWsWebSocketServer = Symbol.for("NextWs_WebSocketServer");
+function setWebSocketServer(wsServer) {
+  Reflect.set(globalThis, NextWsWebSocketServer, wsServer);
+}
+function getWebSocketServer() {
+  mainProcessOnly("getWebSocketServer");
+  return Reflect.get(globalThis, NextWsWebSocketServer);
+}
+function useWebSocketServer(wsServer) {
+  const existing = getWebSocketServer();
+  if (existing) return existing;
+  if (wsServer) setWebSocketServer(wsServer);
+  return wsServer;
+}
+// src/server/helpers/route.ts
+import { pathToFileURL } from "node:url";
+import * as logger2 from "next/dist/build/output/log.js";
+function createRouteRegex(routePattern) {
+  const escapedPattern = routePattern.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&");
+  const paramRegex = escapedPattern.replace(/\\\[([a-zA-Z0-9_]+)\\\]/g, "(?<$1>[^/]+)").replace(/\\\[(?:\\\.){3}([a-zA-Z0-9_]+)\\\]/g, "(?<rest_$1>.+)");
+  return new RegExp(`^${paramRegex}$`);
+}
+function getRouteParams(routePattern, routePath) {
+  const routeRegex = createRouteRegex(routePattern);
+  const match = routePath.match(routeRegex);
+  if (!match) return null;
+  if (!match.groups) return {};
+  const params = {};
+  for (let [k, v] of Object.entries(match.groups)) {
+    if (k.startsWith("rest_")) {
+      k = k.slice(5);
+      v = v.split("/");
+    }
+    Reflect.set(params, k, v);
+  }
+  return params;
+}
+function resolvePathToRoute(nextServer, requestPath) {
+  const routes = {
+    // @ts-expect-error - appPathRoutes is protected
+    ...nextServer.appPathRoutes,
+    // @ts-expect-error - getAppPathRoutes is protected
+    ...nextServer.getAppPathRoutes()
+  };
+  for (const [routePath, [filePath]] of Object.entries(routes)) {
+    const routeParams = getRouteParams(routePath, requestPath);
+    if (routeParams) return { filePath, routeParams };
+  }
+  return null;
+}
+async function importRouteModule(nextServer, filePath) {
+  try {
+    if ("hotReloader" in nextServer) {
+      await nextServer.hotReloader?.ensurePage({
+        page: filePath,
+        clientOnly: false
+      });
+    } else if ("ensurePage" in nextServer) {
+      await nextServer.ensurePage({ page: filePath, clientOnly: false });
+    } else {
+      logger2.warnOnce(
+        "[next-ws] unable to ensure page, you may need to open the route in your browser first so Next.js compiles it"
+      );
+    }
+  } catch {
+  }
+  const buildPagePath = nextServer.getPagePath(filePath);
+  return importModule(buildPagePath);
+}
+async function importModule(modulePath) {
+  const moduleUrl = pathToFileURL(modulePath).toString();
+  try {
+    return await import(moduleUrl).then((m) => m.default);
+  } catch (requireError) {
+    try {
+      return __require(modulePath);
+    } catch (requireError2) {
+      console.error(`Both import and require failed for ${modulePath}`);
+      throw requireError2;
+    }
+  }
+}
+function getSocketHandler(routeModule) {
+  return routeModule?.routeModule?.userland?.SOCKET ?? routeModule?.handlers?.SOCKET;
+}
+// src/server/setup.ts
+function setupWebSocketServer(nextServer) {
+  process.env.NEXT_WS_MAIN_PROCESS = String(1);
+  process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK = String(1);
+  const httpServer = useHttpServer(nextServer.serverOptions?.httpServer);
+  const wsServer = useWebSocketServer(new WebSocketServer({ noServer: true }));
+  process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK = String(0);
+  if (!httpServer)
+    return logger3.error("[next-ws] was not able to find the HTTP server");
+  if (!wsServer)
+    return logger3.error("[next-ws] was not able to find the WebSocket server");
+  logger3.ready("[next-ws] has started the WebSocket server");
+  httpServer.on("upgrade", async (request, socket, head) => {
+    const url = new URL(request.url ?? "", "ws://next");
+    const pathname = url.pathname;
+    if (pathname.startsWith("/_next")) return;
+    const routeInfo = resolvePathToRoute(nextServer, pathname);
+    if (!routeInfo) {
+      logger3.error(`[next-ws] could not find module for page ${pathname}`);
+      return socket.destroy();
+    }
+    const routeModule = await importRouteModule(nextServer, routeInfo.filePath);
+    if (!routeModule) {
+      logger3.error(`[next-ws] could not find module for page ${pathname}`);
+      return socket.destroy();
+    }
+    const socketHandler = getSocketHandler(routeModule);
+    if (!socketHandler || typeof socketHandler !== "function") {
+      logger3.error(`[next-ws] ${pathname} does not export a SOCKET handler`);
+      return socket.destroy();
+    }
+    return wsServer.handleUpgrade(request, socket, head, async (c, r) => {
+      const routeContext = { params: routeInfo.routeParams };
+      const handleClose = await socketHandler(c, r, wsServer, routeContext);
+      if (typeof handleClose === "function")
+        c.once("close", () => handleClose());
+    });
+  });
+}
+export {
+  getHttpServer,
+  getWebSocketServer,
+  setHttpServer,
+  setWebSocketServer,
+  setupWebSocketServer
+};

package/package.json CHANGED Viewed

@@ -1,38 +1,40 @@
 {
   "name": "next-ws",
-  "version": "1.1.1",
+  "version": "2.0.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",
-    "url": "git+https://github.com/apteryxxyz/next-ws.git",
-    "directory": "packages/core"
+    "url": "git+https://github.com/apteryxxyz/next-ws.git"
   },
   "bugs": {
     "url": "https://github.com/apteryxxyz/next-ws/issues"
   },
-  "files": ["dist"],
+  "bin": {
+    "next-ws": "./dist/cli.cjs"
+  },
+  "files": [
+    "dist"
+  ],
   "exports": {
     "./client": {
-      "import": "./dist/client/index.mjs",
       "require": "./dist/client/index.cjs",
-      "types": "./dist/client/index.d.ts"
+      "import": "./dist/client/index.js"
     },
     "./server": {
-      "import": "./dist/server/index.mjs",
       "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"
+      "import": "./dist/server/index.js"
+    },
+    "./package.json": "./package.json"
   },
   "peerDependencies": {
     "next": ">=13.1.1",
@@ -40,11 +42,31 @@
     "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"
+    "@biomejs/biome": "^1.9.4",
+    "@changesets/changelog-git": "^0.2.0",
+    "@changesets/cli": "^2.27.12",
+    "@playwright/test": "^1.50.1",
+    "@types/node": "^22.13.1",
+    "@types/react": "^19.0.8",
+    "@types/semver": "^7.5.8",
+    "@types/ws": "^8.5.14",
+    "chalk": "^5.4.1",
+    "commander": "^13.1.0",
+    "husky": "^9.1.7",
+    "pinst": "^3.0.0",
+    "semver": "^7.7.1",
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "lint": "biome ci .",
+    "format": "biome check . --write",
+    "check": "tsc --noEmit",
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "playwright test",
+    "_postinstall": "biome format package.json --write && pnpm build",
+    "change": "changeset",
+    "release": "changeset version && biome format package.json --write && pnpm build && changeset publish"
   }
-}
+}

package/dist/chunk-6VWOYYWX.mjs DELETED Viewed

@@ -1,11 +0,0 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: !0 }), __require = /* @__PURE__ */ ((x) => typeof require < "u" ? require : typeof Proxy < "u" ? new Proxy(x, {
-  get: (a, b) => (typeof require < "u" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require < "u") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-export { __name, __require };
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=chunk-6VWOYYWX.mjs.map

package/dist/chunk-6VWOYYWX.mjs.map DELETED Viewed

	@@ -1 +0,0 @@
1	- {"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/dist/chunk-PFW3KWBF.cjs DELETED Viewed

@@ -1,14 +0,0 @@
-'use strict';
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: !0 }), __require = /* @__PURE__ */ ((x) => typeof require < "u" ? require : typeof Proxy < "u" ? new Proxy(x, {
-  get: (a, b) => (typeof require < "u" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require < "u") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-exports.__name = __name;
-exports.__require = __require;
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=chunk-PFW3KWBF.cjs.map

package/dist/chunk-PFW3KWBF.cjs.map DELETED Viewed

	@@ -1 +0,0 @@
1	- {"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/dist/client/index.cjs.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"sources":["../../src/client/context.tsx"],"names":["client"],"mappings":";;;;;AAGA,OAAO,WAAW;AAClB,SAAS,eAAe,YAAY,WAAW,eAAe;AAEvD,IAAM,mBAAmB,cAAgC,IAAI;AACpE,iBAAiB,cAAc;AACxB,IAAM,oBAAoB,iBAAiB;AAQ3C,SAAS,kBACd,GAQA;AACA,MAAM,SAAS,QAAQ,MAAM;AAC3B,QAAI,OAAO,SAAW,IAAa,QAAO;AAC1C,QAAMA,UAAS,IAAI,UAAU,EAAE,KAAK,EAAE,SAAS;AAC/C,WAAI,EAAE,eAAYA,QAAO,aAAa,EAAE,aACjCA;AAAA,EACT,GAAG,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC;AAErC,mBAAU,MAAM;AACd,QAAI,QAAQ,eAAe,UAAU;AACrC,aAAO,MAAM,OAAO,MAAM;AAAA,EAC5B,GAAG,CAAC,MAAM,CAAC,GAGT,oCAAC,iBAAiB,UAAjB,EAA0B,OAAO,UAC/B,EAAE,QACL;AAEJ;AA3BgB;AAiCT,SAAS,eAAe;AAC7B,MAAM,UAAU,WAAW,gBAAgB;AAC3C,MAAI,YAAY;AACd,UAAM,IAAI,MAAM,sDAAsD;AACxE,SAAO;AACT;AALgB","sourcesContent":["'use client';\n\n// biome-ignore lint/style/useImportType: <explanation>\nimport React from 'react';\nimport { createContext, useContext, useEffect, useMemo } from 'react';\n\nexport const WebSocketContext = createContext<WebSocket | null>(null);\nWebSocketContext.displayName = 'WebSocketContext';\nexport const WebSocketConsumer = WebSocketContext.Consumer;\n\n/**\n * Provides a WebSocket client to its children via context,\n * allowing for easy access to the WebSocket from anywhere in the app.\n * @param props WebSocket parameters and children.\n * @returns JSX Element\n */\nexport function WebSocketProvider(\n p: React.PropsWithChildren<{\n /** The URL for the WebSocket to connect to. */\n url: string;\n /** The subprotocols to use. */\n protocols?: string[] | string;\n /** The binary type to use. */\n binaryType?: BinaryType;\n }>,\n) {\n const client = useMemo(() => {\n if (typeof window === 'undefined') return null;\n const client = new WebSocket(p.url, p.protocols);\n if (p.binaryType) client.binaryType = p.binaryType;\n return client;\n }, [p.url, p.protocols, p.binaryType]);\n\n useEffect(() => {\n if (client?.readyState !== WebSocket.OPEN) return;\n return () => client.close();\n }, [client]);\n\n return (\n <WebSocketContext.Provider value={client}>\n {p.children}\n </WebSocketContext.Provider>\n );\n}\n\n/**\n * Access the websocket from anywhere in the app, so long as it's wrapped in a WebSocketProvider.\n * @returns WebSocket client when connected, null when disconnected.\n */\nexport function useWebSocket() {\n const context = useContext(WebSocketContext);\n if (context === undefined)\n throw new Error('useWebSocket must be used within a WebSocketProvider');\n return context;\n}\n"]}

package/dist/client/index.mjs DELETED Viewed

@@ -1,29 +0,0 @@
-import { __name } from '../chunk-6VWOYYWX.mjs';
-import React, { createContext, useMemo, useEffect, useContext } from 'react';
-var WebSocketContext = createContext(null);
-WebSocketContext.displayName = "WebSocketContext";
-var WebSocketConsumer = WebSocketContext.Consumer;
-function WebSocketProvider(p) {
-  let client = useMemo(() => {
-    if (typeof window > "u") return null;
-    let client2 = new WebSocket(p.url, p.protocols);
-    return p.binaryType && (client2.binaryType = p.binaryType), client2;
-  }, [p.url, p.protocols, p.binaryType]);
-  return useEffect(() => {
-    if (client?.readyState === WebSocket.OPEN)
-      return () => client.close();
-  }, [client]), /* @__PURE__ */ React.createElement(WebSocketContext.Provider, { value: client }, p.children);
-}
-__name(WebSocketProvider, "WebSocketProvider");
-function useWebSocket() {
-  let context = useContext(WebSocketContext);
-  if (context === void 0)
-    throw new Error("useWebSocket must be used within a WebSocketProvider");
-  return context;
-}
-__name(useWebSocket, "useWebSocket");
-export { WebSocketConsumer, WebSocketContext, WebSocketProvider, useWebSocket };
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=index.mjs.map

package/dist/client/index.mjs.map DELETED Viewed

@@ -1 +0,0 @@

package/dist/server/index.cjs.map DELETED Viewed

@@ -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"]}

package/dist/server/index.mjs DELETED Viewed

@@ -1,134 +0,0 @@
-import { __name, __require } from '../chunk-6VWOYYWX.mjs';
-import * as logger3 from 'next/dist/build/output/log';
-import { WebSocketServer } from 'ws';
-function getEnvironmentMeta() {
-  let isCustomServer = !process.title.startsWith("next-"), isMainProcess = process.env.NEXT_WS_MAIN_PROCESS === "1", isDevelopment = process.env.NODE_ENV === "development";
-  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();
-  if (meta.isMainProcess)
-    meta.isCustomServer || logger3.warnOnce(
-      `[next-ws] Caution: The function '${fnName}' was invoked without a custom server.
-This could lead to unintended behaviour, especially if you're attempting to interact with the WebSocket server outside of a SOCKET handler.
-Please 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.
-You can resolve this by using a custom server.`
-    );
-  else throw new Error(
-    `[next-ws] Attempt to invoke '${fnName}' outside the main process.
-You 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.
-You can resolve this by using a custom server.`
-  );
-}
-__name(mainProcessOnly, "mainProcessOnly");
-var NextWsHttpServer = Symbol.for("NextWs_HttpServer");
-function setHttpServer(server) {
-  Reflect.set(globalThis, NextWsHttpServer, server);
-}
-__name(setHttpServer, "setHttpServer");
-function getHttpServer() {
-  return mainProcessOnly("getHttpServer"), Reflect.get(globalThis, NextWsHttpServer);
-}
-__name(getHttpServer, "getHttpServer");
-function useHttpServer(server) {
-  let existing = getHttpServer();
-  return existing || (server && setHttpServer(server), server);
-}
-__name(useHttpServer, "useHttpServer");
-var NextWsWebSocketServer = Symbol.for("NextWs_WebSocketServer");
-function setWebSocketServer(wsServer) {
-  Reflect.set(globalThis, NextWsWebSocketServer, wsServer);
-}
-__name(setWebSocketServer, "setWebSocketServer");
-function getWebSocketServer() {
-  return mainProcessOnly("getWebSocketServer"), Reflect.get(globalThis, NextWsWebSocketServer);
-}
-__name(getWebSocketServer, "getWebSocketServer");
-function useWebSocketServer(wsServer) {
-  let existing = getWebSocketServer();
-  return existing || (wsServer && setWebSocketServer(wsServer), wsServer);
-}
-__name(useWebSocketServer, "useWebSocketServer");
-// src/server/setup.ts
-function setupWebSocketServer(nextServer) {
-  process.env.NEXT_WS_MAIN_PROCESS = String(1), process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK = String(1);
-  let httpServer = useHttpServer(nextServer.serverOptions?.httpServer), wsServer = useWebSocketServer(new WebSocketServer({ noServer: !0 }));
-  if (delete process.env.NEXT_WS_SKIP_ENVIRONMENT_CHECK, !httpServer)
-    return logger3.error("[next-ws] was not able to find the HTTP server");
-  if (!wsServer)
-    return logger3.error("[next-ws] was not able to find the WebSocket server");
-  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)
-      return logger3.error(`[next-ws] could not find module for page ${pathname}`), socket.destroy();
-    let pageModule = await getPageModule(nextServer, filename);
-    if (!pageModule)
-      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());
-    });
-  });
-}
-__name(setupWebSocketServer, "setupWebSocketServer");
-function hookNextNodeServer() {
-  setupWebSocketServer(this);
-}
-__name(hookNextNodeServer, "hookNextNodeServer");
-// src/server/index.ts
-function verifyPatch() {
-  throw new Error(
-    "The 'verifyPatch' function has been deprecated in favour of the `npx next-ws-cli@latest verify` command."
-  );
-}
-__name(verifyPatch, "verifyPatch");
-export { getHttpServer, getWebSocketServer, hookNextNodeServer, setHttpServer, setWebSocketServer, setupWebSocketServer, verifyPatch };
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=index.mjs.map

package/dist/server/index.mjs.map DELETED Viewed

@@ -1 +0,0 @@