.github/workflows/build-examples.yml

@@ -19,6 +19,8 @@ jobs:
           - custom-parsers
           - typescript-example/cjs
           - typescript-example/esm
+          - typescript-client-example/cjs
+          - typescript-client-example/esm
           - webpack-build
           - webpack-build-server
           - basic-crud-application/angular-client

.github/workflows/ci.yml

@@ -22,6 +22,7 @@ jobs:
         node-version:
           - 18
           - 20
+          - 22
 
     services:
       redis:
@@ -59,3 +60,7 @@ jobs:
       - name: Run tests with fetch instead of XHR (engine.io-client)
         run: npm run test:node-fetch --workspace=engine.io-client
         if: ${{ matrix.node-version == '18' }}
+
+      - name: Run tests with Node.js native WebSocket (engine.io-client)
+        run: npm run test:node-builtin-ws --workspace=engine.io-client
+        if: ${{ matrix.node-version == '22' }}

examples/nuxt-example/server/plugins/socket.io.ts

@@ -20,17 +20,18 @@ export default defineNitroPlugin((nitroApp: NitroApp) => {
     },
     websocket: {
       open(peer) {
-        const nodeContext = peer.ctx.node;
-        const req = nodeContext.req;
+        // crossws >= 0.3.0
+        // @ts-expect-error private method and property
+        engine.prepare(peer._internal.nodeReq);
+        // @ts-expect-error private method and property
+        engine.onWebSocket(peer._internal.nodeReq, peer._internal.nodeReq.socket, peer.websocket);
 
-        // @ts-expect-error private method
-        engine.prepare(req);
-
-        const rawSocket = nodeContext.req.socket;
-        const websocket = nodeContext.ws;
-
-        // @ts-expect-error private method
-        engine.onWebSocket(req, rawSocket, websocket);
+        // crossws < 0.3.0
+        // const context = peer.ctx.node;
+        // // @ts-expect-error private method
+        // engine.prepare(context.req);
+        // // @ts-expect-error private method
+        // engine.onWebSocket(context.req, context.req.socket, context.ws);
       }
     }
   }));

examples/typescript-client-example/cjs/client.ts

@@ -0,0 +1,30 @@
+import { io, type Socket } from "socket.io-client";
+
+interface ServerToClientEvents {
+    hello: (val: string) => void;
+}
+
+interface ClientToServerEvents {
+    ping: (cb: () => void) => void;
+}
+
+const socket: Socket<ServerToClientEvents, ClientToServerEvents> = io("ws://localhost:8080/");
+
+socket.on("connect", () => {
+    console.log(`connect ${socket.id}`);
+});
+
+socket.on("hello", (val) => {
+    console.log(`got ${val}`);
+});
+
+socket.on("disconnect", () => {
+    console.log(`disconnect`);
+});
+
+setInterval(() => {
+    const start = Date.now();
+    socket.emit("ping", () => {
+        console.log(`pong (latency: ${Date.now() - start} ms)`);
+    });
+}, 1000);

examples/typescript-client-example/cjs/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "typescript-client-example-cjs",
+  "version": "0.0.1",
+  "description": "An example with TypeScript",
+  "type": "commonjs",
+  "private": true,
+  "scripts": {
+    "build": "tsc",
+    "start": "ts-node client.ts"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "socket.io-client": "^4.8.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  }
+}

examples/typescript-client-example/cjs/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "target": "es2022",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "strict": true
+  }
+}

examples/typescript-client-example/esm/client.ts

@@ -0,0 +1,30 @@
+import { io, type Socket } from "socket.io-client";
+
+interface ServerToClientEvents {
+    hello: (val: string) => void;
+}
+
+interface ClientToServerEvents {
+    ping: (cb: () => void) => void;
+}
+
+const socket: Socket<ServerToClientEvents, ClientToServerEvents> = io("ws://localhost:8080/");
+
+socket.on("connect", () => {
+    console.log(`connect ${socket.id}`);
+});
+
+socket.on("hello", (val) => {
+   console.log(`got ${val}`);
+});
+
+socket.on("disconnect", () => {
+    console.log(`disconnect`);
+});
+
+setInterval(() => {
+    const start = Date.now();
+    socket.emit("ping", () => {
+        console.log(`pong (latency: ${Date.now() - start} ms)`);
+    });
+}, 1000);

examples/typescript-client-example/esm/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "typescript-client-example-esm",
+  "version": "0.0.1",
+  "description": "An example with TypeScript",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "build": "tsc",
+    "start": "node --no-warnings=ExperimentalWarning --loader ts-node/esm client.ts"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "socket.io-client": "^4.8.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  }
+}

examples/typescript-client-example/esm/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "target": "es2022",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "strict": true
+  }
+}