diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 5a21bdeba7..58ce9ca397 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -55,6 +55,8 @@ jobs:
- webpack-build-server
- basic-crud-application/angular-client
- basic-crud-application/vue-client
+ - nextjs-pages-router-api-route
+ - nextjs-pages-router-custom-server
steps:
- name: Checkout repository
diff --git a/examples/nextjs-pages-router-api-route/.gitignore b/examples/nextjs-pages-router-api-route/.gitignore
new file mode 100644
index 0000000000..fd3dbb571a
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/.gitignore
@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
diff --git a/examples/nextjs-pages-router-api-route/README.md b/examples/nextjs-pages-router-api-route/README.md
new file mode 100644
index 0000000000..5d98b1e5a0
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/README.md
@@ -0,0 +1,40 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
diff --git a/examples/nextjs-pages-router-api-route/jsconfig.json b/examples/nextjs-pages-router-api-route/jsconfig.json
new file mode 100644
index 0000000000..b8d6842d7f
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/jsconfig.json
@@ -0,0 +1,7 @@
+{
+ "compilerOptions": {
+ "paths": {
+ "@/*": ["./src/*"]
+ }
+ }
+}
diff --git a/examples/nextjs-pages-router-api-route/next.config.mjs b/examples/nextjs-pages-router-api-route/next.config.mjs
new file mode 100644
index 0000000000..d5456a15d4
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/next.config.mjs
@@ -0,0 +1,6 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+ reactStrictMode: true,
+};
+
+export default nextConfig;
diff --git a/examples/nextjs-pages-router-api-route/package.json b/examples/nextjs-pages-router-api-route/package.json
new file mode 100644
index 0000000000..fcc6b745fc
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/package.json
@@ -0,0 +1,18 @@
+{
+ "name": "nextjs-pages-router-api-route",
+ "version": "0.1.0",
+ "private": true,
+ "scripts": {
+ "dev": "next dev",
+ "build": "next build",
+ "start": "next start",
+ "lint": "next lint"
+ },
+ "dependencies": {
+ "next": "14.1.4",
+ "react": "^18",
+ "react-dom": "^18",
+ "socket.io": "^4.7.5",
+ "socket.io-client": "^4.7.5"
+ }
+}
diff --git a/examples/nextjs-pages-router-api-route/public/favicon.ico b/examples/nextjs-pages-router-api-route/public/favicon.ico
new file mode 100644
index 0000000000..718d6fea48
Binary files /dev/null and b/examples/nextjs-pages-router-api-route/public/favicon.ico differ
diff --git a/examples/nextjs-pages-router-api-route/public/next.svg b/examples/nextjs-pages-router-api-route/public/next.svg
new file mode 100644
index 0000000000..5174b28c56
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/public/next.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/examples/nextjs-pages-router-api-route/public/vercel.svg b/examples/nextjs-pages-router-api-route/public/vercel.svg
new file mode 100644
index 0000000000..d2f8422273
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/public/vercel.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/examples/nextjs-pages-router-api-route/src/pages/_app.js b/examples/nextjs-pages-router-api-route/src/pages/_app.js
new file mode 100644
index 0000000000..b97e52fc9a
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/src/pages/_app.js
@@ -0,0 +1,5 @@
+import "@/styles/globals.css";
+
+export default function App({ Component, pageProps }) {
+ return ;
+}
diff --git a/examples/nextjs-pages-router-api-route/src/pages/_document.js b/examples/nextjs-pages-router-api-route/src/pages/_document.js
new file mode 100644
index 0000000000..b2fff8b426
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/src/pages/_document.js
@@ -0,0 +1,13 @@
+import { Html, Head, Main, NextScript } from "next/document";
+
+export default function Document() {
+ return (
+
+
+
+
+
+
+ );
+}
diff --git a/examples/nextjs-pages-router-api-route/src/pages/api/hello.js b/examples/nextjs-pages-router-api-route/src/pages/api/hello.js
new file mode 100644
index 0000000000..aee21e9afa
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/src/pages/api/hello.js
@@ -0,0 +1,5 @@
+// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
+
+export default function handler(req, res) {
+ res.status(200).json({ name: "John Doe" });
+}
diff --git a/examples/nextjs-pages-router-api-route/src/pages/api/socket.io.js b/examples/nextjs-pages-router-api-route/src/pages/api/socket.io.js
new file mode 100644
index 0000000000..dd0dd6ae2b
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/src/pages/api/socket.io.js
@@ -0,0 +1,45 @@
+import { Server } from "socket.io";
+import { Server as Engine } from "engine.io";
+
+const engine = new Engine({
+ pingInterval: 2000
+});
+
+const io = new Server();
+
+io.bind(engine);
+
+io.on("connection", (socket) => {
+ // ...
+});
+
+let once = true;
+
+export default function handler(req, res) {
+ if (once) {
+ once = false;
+ const server = req.socket.server;
+
+ // the default listener closes the websocket connection if the path does not match "/_next/webpack-hmr"
+ // see https://github.com/vercel/next.js/blob/f9d73cc2fa710a7ba90ee28f7783a8f05ea62b3a/packages/next/src/server/lib/router-server.ts#L669-L671
+ const defaultListener = server.listeners("upgrade")[0];
+ server.removeAllListeners("upgrade");
+
+ server.on("upgrade", (req, socket, head) => {
+ if (req.url.startsWith("/api/socket.io")) {
+ engine.handleUpgrade(req, socket, head);
+ } else {
+ defaultListener.call(server, req, socket, head);
+ }
+ });
+ }
+
+ engine.handleRequest(req, res);
+}
+
+export const config = {
+ api: {
+ bodyParser: false, // prevents body parsing
+ externalResolver: true, // prevents "this may result in stalled requests" warnings
+ },
+}
diff --git a/examples/nextjs-pages-router-api-route/src/pages/index.js b/examples/nextjs-pages-router-api-route/src/pages/index.js
new file mode 100644
index 0000000000..79cda6e3bf
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/src/pages/index.js
@@ -0,0 +1,56 @@
+import Head from "next/head";
+import Image from "next/image";
+import { Inter } from "next/font/google";
+import styles from "@/styles/Home.module.css";
+import { useEffect, useState } from "react";
+import { socket } from "@/socket";
+
+const inter = Inter({ subsets: ["latin"] });
+
+export default function Home() {
+ const [isConnected, setIsConnected] = useState(false);
+ const [transport, setTransport] = useState("N/A");
+
+ useEffect(() => {
+ if (socket.connected) {
+ onConnect();
+ }
+
+ function onConnect() {
+ setIsConnected(true);
+ setTransport(socket.io.engine.transport.name || "N/A");
+
+ socket.io.engine.on("upgrade", (transport) => {
+ setTransport(transport.name);
+ });
+ }
+
+ function onDisconnect() {
+ setIsConnected(false);
+ setTransport("N/A")
+ }
+
+ socket.on("connect", onConnect);
+ socket.on("disconnect", onDisconnect);
+
+ return () => {
+ socket.off("connect", onConnect);
+ socket.off("disconnect", onDisconnect);
+ };
+ }, []);
+
+ return (
+ <>
+
+ Create Next App
+
+
+
+
+
+
Status: { isConnected ? "connected" : "disconnected" }
+
Transport: { transport }
+
+ >
+ );
+}
diff --git a/examples/nextjs-pages-router-api-route/src/socket.js b/examples/nextjs-pages-router-api-route/src/socket.js
new file mode 100644
index 0000000000..d7d4ddcd5a
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/src/socket.js
@@ -0,0 +1,9 @@
+import { io } from "socket.io-client";
+
+const isBrowser = typeof window !== "undefined";
+
+// only create the Socket.IO client on the client side (no ssr)
+export const socket = isBrowser ? io({
+ path: "/api/socket.io",
+ addTrailingSlash: false,
+}) : {};
diff --git a/examples/nextjs-pages-router-api-route/src/styles/Home.module.css b/examples/nextjs-pages-router-api-route/src/styles/Home.module.css
new file mode 100644
index 0000000000..827f96590b
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/src/styles/Home.module.css
@@ -0,0 +1,229 @@
+.main {
+ display: flex;
+ flex-direction: column;
+ justify-content: space-between;
+ align-items: center;
+ padding: 6rem;
+ min-height: 100vh;
+}
+
+.description {
+ display: inherit;
+ justify-content: inherit;
+ align-items: inherit;
+ font-size: 0.85rem;
+ max-width: var(--max-width);
+ width: 100%;
+ z-index: 2;
+ font-family: var(--font-mono);
+}
+
+.description a {
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ gap: 0.5rem;
+}
+
+.description p {
+ position: relative;
+ margin: 0;
+ padding: 1rem;
+ background-color: rgba(var(--callout-rgb), 0.5);
+ border: 1px solid rgba(var(--callout-border-rgb), 0.3);
+ border-radius: var(--border-radius);
+}
+
+.code {
+ font-weight: 700;
+ font-family: var(--font-mono);
+}
+
+.grid {
+ display: grid;
+ grid-template-columns: repeat(4, minmax(25%, auto));
+ max-width: var(--max-width);
+ width: 100%;
+}
+
+.card {
+ padding: 1rem 1.2rem;
+ border-radius: var(--border-radius);
+ background: rgba(var(--card-rgb), 0);
+ border: 1px solid rgba(var(--card-border-rgb), 0);
+ transition: background 200ms, border 200ms;
+}
+
+.card span {
+ display: inline-block;
+ transition: transform 200ms;
+}
+
+.card h2 {
+ font-weight: 600;
+ margin-bottom: 0.7rem;
+}
+
+.card p {
+ margin: 0;
+ opacity: 0.6;
+ font-size: 0.9rem;
+ line-height: 1.5;
+ max-width: 30ch;
+}
+
+.center {
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ position: relative;
+ padding: 4rem 0;
+}
+
+.center::before {
+ background: var(--secondary-glow);
+ border-radius: 50%;
+ width: 480px;
+ height: 360px;
+ margin-left: -400px;
+}
+
+.center::after {
+ background: var(--primary-glow);
+ width: 240px;
+ height: 180px;
+ z-index: -1;
+}
+
+.center::before,
+.center::after {
+ content: "";
+ left: 50%;
+ position: absolute;
+ filter: blur(45px);
+ transform: translateZ(0);
+}
+
+.logo {
+ position: relative;
+}
+/* Enable hover only on non-touch devices */
+@media (hover: hover) and (pointer: fine) {
+ .card:hover {
+ background: rgba(var(--card-rgb), 0.1);
+ border: 1px solid rgba(var(--card-border-rgb), 0.15);
+ }
+
+ .card:hover span {
+ transform: translateX(4px);
+ }
+}
+
+@media (prefers-reduced-motion) {
+ .card:hover span {
+ transform: none;
+ }
+}
+
+/* Mobile */
+@media (max-width: 700px) {
+ .content {
+ padding: 4rem;
+ }
+
+ .grid {
+ grid-template-columns: 1fr;
+ margin-bottom: 120px;
+ max-width: 320px;
+ text-align: center;
+ }
+
+ .card {
+ padding: 1rem 2.5rem;
+ }
+
+ .card h2 {
+ margin-bottom: 0.5rem;
+ }
+
+ .center {
+ padding: 8rem 0 6rem;
+ }
+
+ .center::before {
+ transform: none;
+ height: 300px;
+ }
+
+ .description {
+ font-size: 0.8rem;
+ }
+
+ .description a {
+ padding: 1rem;
+ }
+
+ .description p,
+ .description div {
+ display: flex;
+ justify-content: center;
+ position: fixed;
+ width: 100%;
+ }
+
+ .description p {
+ align-items: center;
+ inset: 0 0 auto;
+ padding: 2rem 1rem 1.4rem;
+ border-radius: 0;
+ border: none;
+ border-bottom: 1px solid rgba(var(--callout-border-rgb), 0.25);
+ background: linear-gradient(
+ to bottom,
+ rgba(var(--background-start-rgb), 1),
+ rgba(var(--callout-rgb), 0.5)
+ );
+ background-clip: padding-box;
+ backdrop-filter: blur(24px);
+ }
+
+ .description div {
+ align-items: flex-end;
+ pointer-events: none;
+ inset: auto 0 0;
+ padding: 2rem;
+ height: 200px;
+ background: linear-gradient(
+ to bottom,
+ transparent 0%,
+ rgb(var(--background-end-rgb)) 40%
+ );
+ z-index: 1;
+ }
+}
+
+/* Tablet and Smaller Desktop */
+@media (min-width: 701px) and (max-width: 1120px) {
+ .grid {
+ grid-template-columns: repeat(2, 50%);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+ .vercelLogo {
+ filter: invert(1);
+ }
+
+ .logo {
+ filter: invert(1) drop-shadow(0 0 0.3rem #ffffff70);
+ }
+}
+
+@keyframes rotate {
+ from {
+ transform: rotate(360deg);
+ }
+ to {
+ transform: rotate(0deg);
+ }
+}
diff --git a/examples/nextjs-pages-router-api-route/src/styles/globals.css b/examples/nextjs-pages-router-api-route/src/styles/globals.css
new file mode 100644
index 0000000000..f4bd77c0cc
--- /dev/null
+++ b/examples/nextjs-pages-router-api-route/src/styles/globals.css
@@ -0,0 +1,107 @@
+:root {
+ --max-width: 1100px;
+ --border-radius: 12px;
+ --font-mono: ui-monospace, Menlo, Monaco, "Cascadia Mono", "Segoe UI Mono",
+ "Roboto Mono", "Oxygen Mono", "Ubuntu Monospace", "Source Code Pro",
+ "Fira Mono", "Droid Sans Mono", "Courier New", monospace;
+
+ --foreground-rgb: 0, 0, 0;
+ --background-start-rgb: 214, 219, 220;
+ --background-end-rgb: 255, 255, 255;
+
+ --primary-glow: conic-gradient(
+ from 180deg at 50% 50%,
+ #16abff33 0deg,
+ #0885ff33 55deg,
+ #54d6ff33 120deg,
+ #0071ff33 160deg,
+ transparent 360deg
+ );
+ --secondary-glow: radial-gradient(
+ rgba(255, 255, 255, 1),
+ rgba(255, 255, 255, 0)
+ );
+
+ --tile-start-rgb: 239, 245, 249;
+ --tile-end-rgb: 228, 232, 233;
+ --tile-border: conic-gradient(
+ #00000080,
+ #00000040,
+ #00000030,
+ #00000020,
+ #00000010,
+ #00000010,
+ #00000080
+ );
+
+ --callout-rgb: 238, 240, 241;
+ --callout-border-rgb: 172, 175, 176;
+ --card-rgb: 180, 185, 188;
+ --card-border-rgb: 131, 134, 135;
+}
+
+@media (prefers-color-scheme: dark) {
+ :root {
+ --foreground-rgb: 255, 255, 255;
+ --background-start-rgb: 0, 0, 0;
+ --background-end-rgb: 0, 0, 0;
+
+ --primary-glow: radial-gradient(rgba(1, 65, 255, 0.4), rgba(1, 65, 255, 0));
+ --secondary-glow: linear-gradient(
+ to bottom right,
+ rgba(1, 65, 255, 0),
+ rgba(1, 65, 255, 0),
+ rgba(1, 65, 255, 0.3)
+ );
+
+ --tile-start-rgb: 2, 13, 46;
+ --tile-end-rgb: 2, 5, 19;
+ --tile-border: conic-gradient(
+ #ffffff80,
+ #ffffff40,
+ #ffffff30,
+ #ffffff20,
+ #ffffff10,
+ #ffffff10,
+ #ffffff80
+ );
+
+ --callout-rgb: 20, 20, 20;
+ --callout-border-rgb: 108, 108, 108;
+ --card-rgb: 100, 100, 100;
+ --card-border-rgb: 200, 200, 200;
+ }
+}
+
+* {
+ box-sizing: border-box;
+ padding: 0;
+ margin: 0;
+}
+
+html,
+body {
+ max-width: 100vw;
+ overflow-x: hidden;
+}
+
+body {
+ color: rgb(var(--foreground-rgb));
+ background: linear-gradient(
+ to bottom,
+ transparent,
+ rgb(var(--background-end-rgb))
+ )
+ rgb(var(--background-start-rgb));
+}
+
+a {
+ color: inherit;
+ text-decoration: none;
+}
+
+@media (prefers-color-scheme: dark) {
+ html {
+ color-scheme: dark;
+ }
+}
diff --git a/examples/nextjs-pages-router-custom-server/.gitignore b/examples/nextjs-pages-router-custom-server/.gitignore
new file mode 100644
index 0000000000..fd3dbb571a
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/.gitignore
@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
diff --git a/examples/nextjs-pages-router-custom-server/README.md b/examples/nextjs-pages-router-custom-server/README.md
new file mode 100644
index 0000000000..5d98b1e5a0
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/README.md
@@ -0,0 +1,40 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
diff --git a/examples/nextjs-pages-router-custom-server/jsconfig.json b/examples/nextjs-pages-router-custom-server/jsconfig.json
new file mode 100644
index 0000000000..b8d6842d7f
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/jsconfig.json
@@ -0,0 +1,7 @@
+{
+ "compilerOptions": {
+ "paths": {
+ "@/*": ["./src/*"]
+ }
+ }
+}
diff --git a/examples/nextjs-pages-router-custom-server/next.config.mjs b/examples/nextjs-pages-router-custom-server/next.config.mjs
new file mode 100644
index 0000000000..d5456a15d4
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/next.config.mjs
@@ -0,0 +1,6 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+ reactStrictMode: true,
+};
+
+export default nextConfig;
diff --git a/examples/nextjs-pages-router-custom-server/package.json b/examples/nextjs-pages-router-custom-server/package.json
new file mode 100644
index 0000000000..15db2aecd9
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/package.json
@@ -0,0 +1,19 @@
+{
+ "name": "nextjs-pages-router-custom-server",
+ "version": "0.1.0",
+ "private": true,
+ "type": "module",
+ "scripts": {
+ "dev": "node server.js",
+ "build": "next build",
+ "start": "NODE_ENV=production node server.js",
+ "lint": "next lint"
+ },
+ "dependencies": {
+ "next": "14.1.4",
+ "react": "^18",
+ "react-dom": "^18",
+ "socket.io": "^4.7.5",
+ "socket.io-client": "^4.7.5"
+ }
+}
diff --git a/examples/nextjs-pages-router-custom-server/public/favicon.ico b/examples/nextjs-pages-router-custom-server/public/favicon.ico
new file mode 100644
index 0000000000..718d6fea48
Binary files /dev/null and b/examples/nextjs-pages-router-custom-server/public/favicon.ico differ
diff --git a/examples/nextjs-pages-router-custom-server/public/next.svg b/examples/nextjs-pages-router-custom-server/public/next.svg
new file mode 100644
index 0000000000..5174b28c56
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/public/next.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/examples/nextjs-pages-router-custom-server/public/vercel.svg b/examples/nextjs-pages-router-custom-server/public/vercel.svg
new file mode 100644
index 0000000000..d2f8422273
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/public/vercel.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/examples/nextjs-pages-router-custom-server/server.js b/examples/nextjs-pages-router-custom-server/server.js
new file mode 100644
index 0000000000..90c241683f
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/server.js
@@ -0,0 +1,43 @@
+import { createServer } from "http";
+import { parse } from "url";
+import next from "next";
+import { Server } from "socket.io";
+
+const dev = process.env.NODE_ENV !== "production";
+const hostname = "localhost";
+const port = 3000;
+// when using middleware `hostname` and `port` must be provided below
+const app = next({ dev, hostname, port });
+const handle = app.getRequestHandler();
+
+app.prepare().then(() => {
+ const httpServer = createServer(async (req, res) => {
+ try {
+ const parsedUrl = parse(req.url, true);
+ const { pathname, query } = parsedUrl;
+
+ await handle(req, res, parsedUrl);
+ } catch (err) {
+ console.error("Error occurred handling", req.url, err);
+ res.statusCode = 500;
+ res.end("internal server error");
+ }
+ });
+
+ const io = new Server(httpServer, {
+ pingInterval: 2000
+ });
+
+ io.on("connection", (socket) => {
+ // ...
+ });
+
+ httpServer
+ .once("error", (err) => {
+ console.error(err);
+ process.exit(1);
+ })
+ .listen(port, () => {
+ console.log(`> Ready on http://${hostname}:${port}`);
+ });
+});
diff --git a/examples/nextjs-pages-router-custom-server/src/pages/_app.js b/examples/nextjs-pages-router-custom-server/src/pages/_app.js
new file mode 100644
index 0000000000..352efd7cf7
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/src/pages/_app.js
@@ -0,0 +1,5 @@
+// import "@/styles/globals.css";
+
+export default function App({ Component, pageProps }) {
+ return ;
+}
diff --git a/examples/nextjs-pages-router-custom-server/src/pages/_document.js b/examples/nextjs-pages-router-custom-server/src/pages/_document.js
new file mode 100644
index 0000000000..b2fff8b426
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/src/pages/_document.js
@@ -0,0 +1,13 @@
+import { Html, Head, Main, NextScript } from "next/document";
+
+export default function Document() {
+ return (
+
+
+
+
+
+
+ );
+}
diff --git a/examples/nextjs-pages-router-custom-server/src/pages/api/hello.js b/examples/nextjs-pages-router-custom-server/src/pages/api/hello.js
new file mode 100644
index 0000000000..aee21e9afa
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/src/pages/api/hello.js
@@ -0,0 +1,5 @@
+// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
+
+export default function handler(req, res) {
+ res.status(200).json({ name: "John Doe" });
+}
diff --git a/examples/nextjs-pages-router-custom-server/src/pages/index.js b/examples/nextjs-pages-router-custom-server/src/pages/index.js
new file mode 100644
index 0000000000..b34ef1d296
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/src/pages/index.js
@@ -0,0 +1,56 @@
+import Head from "next/head";
+import Image from "next/image";
+import { Inter } from "next/font/google";
+// import styles from "@/styles/Home.module.css";
+import { useEffect, useState } from "react";
+import { socket } from "../socket";
+
+const inter = Inter({ subsets: ["latin"] });
+
+export default function Home() {
+ const [isConnected, setIsConnected] = useState(false);
+ const [transport, setTransport] = useState("N/A");
+
+ useEffect(() => {
+ if (socket.connected) {
+ onConnect();
+ }
+
+ function onConnect() {
+ setIsConnected(true);
+ setTransport(socket.io.engine.transport.name || "N/A");
+
+ socket.io.engine.on("upgrade", (transport) => {
+ setTransport(transport.name);
+ });
+ }
+
+ function onDisconnect() {
+ setIsConnected(false);
+ setTransport("N/A")
+ }
+
+ socket.on("connect", onConnect);
+ socket.on("disconnect", onDisconnect);
+
+ return () => {
+ socket.off("connect", onConnect);
+ socket.off("disconnect", onDisconnect);
+ };
+ }, []);
+
+ return (
+ <>
+
+ Create Next App
+
+
+
+
+
+
Status: { isConnected ? "connected" : "disconnected" }
+
Transport: { transport }
+
+ >
+ );
+}
diff --git a/examples/nextjs-pages-router-custom-server/src/socket.js b/examples/nextjs-pages-router-custom-server/src/socket.js
new file mode 100644
index 0000000000..2d57c0c35c
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/src/socket.js
@@ -0,0 +1,6 @@
+import { io } from "socket.io-client";
+
+const isBrowser = typeof window !== "undefined";
+
+// only create the Socket.IO client on the client side (no ssr)
+export const socket = isBrowser ? io() : {};
diff --git a/examples/nextjs-pages-router-custom-server/src/styles/Home.module.css b/examples/nextjs-pages-router-custom-server/src/styles/Home.module.css
new file mode 100644
index 0000000000..827f96590b
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/src/styles/Home.module.css
@@ -0,0 +1,229 @@
+.main {
+ display: flex;
+ flex-direction: column;
+ justify-content: space-between;
+ align-items: center;
+ padding: 6rem;
+ min-height: 100vh;
+}
+
+.description {
+ display: inherit;
+ justify-content: inherit;
+ align-items: inherit;
+ font-size: 0.85rem;
+ max-width: var(--max-width);
+ width: 100%;
+ z-index: 2;
+ font-family: var(--font-mono);
+}
+
+.description a {
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ gap: 0.5rem;
+}
+
+.description p {
+ position: relative;
+ margin: 0;
+ padding: 1rem;
+ background-color: rgba(var(--callout-rgb), 0.5);
+ border: 1px solid rgba(var(--callout-border-rgb), 0.3);
+ border-radius: var(--border-radius);
+}
+
+.code {
+ font-weight: 700;
+ font-family: var(--font-mono);
+}
+
+.grid {
+ display: grid;
+ grid-template-columns: repeat(4, minmax(25%, auto));
+ max-width: var(--max-width);
+ width: 100%;
+}
+
+.card {
+ padding: 1rem 1.2rem;
+ border-radius: var(--border-radius);
+ background: rgba(var(--card-rgb), 0);
+ border: 1px solid rgba(var(--card-border-rgb), 0);
+ transition: background 200ms, border 200ms;
+}
+
+.card span {
+ display: inline-block;
+ transition: transform 200ms;
+}
+
+.card h2 {
+ font-weight: 600;
+ margin-bottom: 0.7rem;
+}
+
+.card p {
+ margin: 0;
+ opacity: 0.6;
+ font-size: 0.9rem;
+ line-height: 1.5;
+ max-width: 30ch;
+}
+
+.center {
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ position: relative;
+ padding: 4rem 0;
+}
+
+.center::before {
+ background: var(--secondary-glow);
+ border-radius: 50%;
+ width: 480px;
+ height: 360px;
+ margin-left: -400px;
+}
+
+.center::after {
+ background: var(--primary-glow);
+ width: 240px;
+ height: 180px;
+ z-index: -1;
+}
+
+.center::before,
+.center::after {
+ content: "";
+ left: 50%;
+ position: absolute;
+ filter: blur(45px);
+ transform: translateZ(0);
+}
+
+.logo {
+ position: relative;
+}
+/* Enable hover only on non-touch devices */
+@media (hover: hover) and (pointer: fine) {
+ .card:hover {
+ background: rgba(var(--card-rgb), 0.1);
+ border: 1px solid rgba(var(--card-border-rgb), 0.15);
+ }
+
+ .card:hover span {
+ transform: translateX(4px);
+ }
+}
+
+@media (prefers-reduced-motion) {
+ .card:hover span {
+ transform: none;
+ }
+}
+
+/* Mobile */
+@media (max-width: 700px) {
+ .content {
+ padding: 4rem;
+ }
+
+ .grid {
+ grid-template-columns: 1fr;
+ margin-bottom: 120px;
+ max-width: 320px;
+ text-align: center;
+ }
+
+ .card {
+ padding: 1rem 2.5rem;
+ }
+
+ .card h2 {
+ margin-bottom: 0.5rem;
+ }
+
+ .center {
+ padding: 8rem 0 6rem;
+ }
+
+ .center::before {
+ transform: none;
+ height: 300px;
+ }
+
+ .description {
+ font-size: 0.8rem;
+ }
+
+ .description a {
+ padding: 1rem;
+ }
+
+ .description p,
+ .description div {
+ display: flex;
+ justify-content: center;
+ position: fixed;
+ width: 100%;
+ }
+
+ .description p {
+ align-items: center;
+ inset: 0 0 auto;
+ padding: 2rem 1rem 1.4rem;
+ border-radius: 0;
+ border: none;
+ border-bottom: 1px solid rgba(var(--callout-border-rgb), 0.25);
+ background: linear-gradient(
+ to bottom,
+ rgba(var(--background-start-rgb), 1),
+ rgba(var(--callout-rgb), 0.5)
+ );
+ background-clip: padding-box;
+ backdrop-filter: blur(24px);
+ }
+
+ .description div {
+ align-items: flex-end;
+ pointer-events: none;
+ inset: auto 0 0;
+ padding: 2rem;
+ height: 200px;
+ background: linear-gradient(
+ to bottom,
+ transparent 0%,
+ rgb(var(--background-end-rgb)) 40%
+ );
+ z-index: 1;
+ }
+}
+
+/* Tablet and Smaller Desktop */
+@media (min-width: 701px) and (max-width: 1120px) {
+ .grid {
+ grid-template-columns: repeat(2, 50%);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+ .vercelLogo {
+ filter: invert(1);
+ }
+
+ .logo {
+ filter: invert(1) drop-shadow(0 0 0.3rem #ffffff70);
+ }
+}
+
+@keyframes rotate {
+ from {
+ transform: rotate(360deg);
+ }
+ to {
+ transform: rotate(0deg);
+ }
+}
diff --git a/examples/nextjs-pages-router-custom-server/src/styles/globals.css b/examples/nextjs-pages-router-custom-server/src/styles/globals.css
new file mode 100644
index 0000000000..f4bd77c0cc
--- /dev/null
+++ b/examples/nextjs-pages-router-custom-server/src/styles/globals.css
@@ -0,0 +1,107 @@
+:root {
+ --max-width: 1100px;
+ --border-radius: 12px;
+ --font-mono: ui-monospace, Menlo, Monaco, "Cascadia Mono", "Segoe UI Mono",
+ "Roboto Mono", "Oxygen Mono", "Ubuntu Monospace", "Source Code Pro",
+ "Fira Mono", "Droid Sans Mono", "Courier New", monospace;
+
+ --foreground-rgb: 0, 0, 0;
+ --background-start-rgb: 214, 219, 220;
+ --background-end-rgb: 255, 255, 255;
+
+ --primary-glow: conic-gradient(
+ from 180deg at 50% 50%,
+ #16abff33 0deg,
+ #0885ff33 55deg,
+ #54d6ff33 120deg,
+ #0071ff33 160deg,
+ transparent 360deg
+ );
+ --secondary-glow: radial-gradient(
+ rgba(255, 255, 255, 1),
+ rgba(255, 255, 255, 0)
+ );
+
+ --tile-start-rgb: 239, 245, 249;
+ --tile-end-rgb: 228, 232, 233;
+ --tile-border: conic-gradient(
+ #00000080,
+ #00000040,
+ #00000030,
+ #00000020,
+ #00000010,
+ #00000010,
+ #00000080
+ );
+
+ --callout-rgb: 238, 240, 241;
+ --callout-border-rgb: 172, 175, 176;
+ --card-rgb: 180, 185, 188;
+ --card-border-rgb: 131, 134, 135;
+}
+
+@media (prefers-color-scheme: dark) {
+ :root {
+ --foreground-rgb: 255, 255, 255;
+ --background-start-rgb: 0, 0, 0;
+ --background-end-rgb: 0, 0, 0;
+
+ --primary-glow: radial-gradient(rgba(1, 65, 255, 0.4), rgba(1, 65, 255, 0));
+ --secondary-glow: linear-gradient(
+ to bottom right,
+ rgba(1, 65, 255, 0),
+ rgba(1, 65, 255, 0),
+ rgba(1, 65, 255, 0.3)
+ );
+
+ --tile-start-rgb: 2, 13, 46;
+ --tile-end-rgb: 2, 5, 19;
+ --tile-border: conic-gradient(
+ #ffffff80,
+ #ffffff40,
+ #ffffff30,
+ #ffffff20,
+ #ffffff10,
+ #ffffff10,
+ #ffffff80
+ );
+
+ --callout-rgb: 20, 20, 20;
+ --callout-border-rgb: 108, 108, 108;
+ --card-rgb: 100, 100, 100;
+ --card-border-rgb: 200, 200, 200;
+ }
+}
+
+* {
+ box-sizing: border-box;
+ padding: 0;
+ margin: 0;
+}
+
+html,
+body {
+ max-width: 100vw;
+ overflow-x: hidden;
+}
+
+body {
+ color: rgb(var(--foreground-rgb));
+ background: linear-gradient(
+ to bottom,
+ transparent,
+ rgb(var(--background-end-rgb))
+ )
+ rgb(var(--background-start-rgb));
+}
+
+a {
+ color: inherit;
+ text-decoration: none;
+}
+
+@media (prefers-color-scheme: dark) {
+ html {
+ color-scheme: dark;
+ }
+}