npm - bxo - Versions diffs - 0.0.7 → 0.0.8 - Mend

bxo 0.0.7 → 0.0.8

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 (3) hide show

package/example/websocket-example.ts +59 -26
package/package.json +1 -1
package/src/index.ts +43 -13

package/example/websocket-example.ts CHANGED Viewed

@@ -9,19 +9,26 @@ async function main() {
 <!DOCTYPE html>
 <html>
 <head>
-    <title>BXO WebSocket Example</title>
+    <title>BXO WebSocket Example with Client ID & Cookies</title>
 </head>
 <body>
-    <h1>BXO WebSocket Example</h1>
+    <h1>BXO WebSocket Example with Client ID & Cookies</h1>
     <div id="messages"></div>
     <input type="text" id="messageInput" placeholder="Type a message...">
     <button onclick="sendMessage()">Send</button>
     <button onclick="connect()">Connect</button>
     <button onclick="disconnect()">Disconnect</button>
+    <button onclick="setCookie()">Set Test Cookie</button>
     <script>
         let ws = null;
+        function setCookie() {
+            document.cookie = "testCookie=hello_from_client; path=/";
+            document.cookie = "sessionId=abc123; path=/";
+            addMessage('Cookies set! Refresh and reconnect to see them in server logs.');
+        }
         function connect() {
             ws = new WebSocket('ws://localhost:3000/ws');
@@ -73,60 +80,86 @@ async function main() {
             }
         });
     </script>
-        `, 200, {
-            "Content-Type": "text/html"
-        });
+        `, 200);
     });
-    // WebSocket route
+    // WebSocket route with enhanced client identification
     app.ws("/ws", {
         open(ws) {
-            console.log("WebSocket connection opened");
-            ws.send("Welcome to BXO WebSocket!");
+            const clientInfo = ws.data;
+            console.log("🔌 WebSocket connection opened:");
+            console.log(`  🆔 Client ID: ${clientInfo.id}`);
+            console.log(`  🔗 Connection ID: ${clientInfo.connectionId}`);
+            console.log(`  🌐 Client IP: ${clientInfo.ip}`);
+            console.log(`  🖥️  User Agent: ${clientInfo.userAgent}`);
+            console.log(`  🎯 Origin: ${clientInfo.origin}`);
+            console.log(`  🏠 Host: ${clientInfo.host}`);
+            console.log(`  📍 Path: ${clientInfo.path}`);
+            console.log(`  🍪 Cookies:`, clientInfo.cookies);
+            ws.send(`Welcome! Your WebSocket ID is: ${clientInfo.id}`);
         },
         message(ws, message) {
-            console.log("Received message:", message);
-            // Echo the message back
-            ws.send(`Echo: ${message}`);
+            const clientInfo = ws.data;
+            console.log(`💬 Message from ${clientInfo.id} (${clientInfo.ip}):`, message);
+            console.log(`   🍪 Client cookies:`, clientInfo.cookies);
+            // Echo the message back with client ID
+            ws.send(`[${clientInfo.id}] Echo: ${message}`);
         },
         close(ws, code, reason) {
-            console.log(`WebSocket connection closed: ${code} ${reason}`);
+            const clientInfo = ws.data;
+            console.log(`❌ WebSocket connection closed for ${clientInfo.id}: ${code} ${reason}`);
         },
         ping(ws, data) {
-            console.log("Ping received:", data);
+            const clientInfo = ws.data;
+            console.log(`🏓 Ping received from ${clientInfo.id}:`, data);
         },
         pong(ws, data) {
-            console.log("Pong received:", data);
+            const clientInfo = ws.data;
+            console.log(`🏓 Pong received from ${clientInfo.id}:`, data);
         }
     });
-    // Another WebSocket route with parameters
+    // Chat room WebSocket with client identification
     app.ws("/chat/:room", {
         open(ws) {
-            console.log(`WebSocket connection opened for room: ${ws.data?.room || 'unknown'}`);
-            ws.send(`Welcome to chat room: ${ws.data?.room || 'unknown'}`);
+            const clientInfo = ws.data;
+            const room = clientInfo.path.split('/').pop() || 'unknown';
+            console.log(`🏠 Chat room connection opened for room: ${room}`);
+            console.log(`  🆔 Client: ${clientInfo.id} (${clientInfo.ip})`);
+            console.log(`  🍪 Cookies:`, clientInfo.cookies);
+            ws.send(`Welcome to chat room: ${room}! Your ID is: ${clientInfo.id}`);
         },
         message(ws, message) {
-            const room = ws.data?.room || 'unknown';
-            console.log(`Message in room ${room}:`, message);
-            ws.send(`[${room}] Echo: ${message}`);
+            const clientInfo = ws.data;
+            const room = clientInfo.path.split('/').pop() || 'unknown';
+            console.log(`💬 Message in room ${room} from ${clientInfo.id}:`, message);
+            console.log(`   🍪 Client cookies:`, clientInfo.cookies);
+            ws.send(`[${room}] [${clientInfo.id}] Echo: ${message}`);
         },
         close(ws, code, reason) {
-            const room = ws.data?.room || 'unknown';
-            console.log(`WebSocket connection closed for room ${room}: ${code} ${reason}`);
+            const clientInfo = ws.data;
+            const room = clientInfo.path.split('/').pop() || 'unknown';
+            console.log(`❌ Chat room connection closed for room ${room} (${clientInfo.id}): ${code} ${reason}`);
         }
     });
     app.start();
-    console.log(`Server is running on http://localhost:${app.server?.port}`);
-    console.log(`WebSocket available at ws://localhost:${app.server?.port}/ws`);
-    console.log(`Chat WebSocket available at ws://localhost:${app.server?.port}/chat/:room`);
+    console.log(`🚀 Server is running on http://localhost:${app.server?.port}`);
+    console.log(`🔌 WebSocket available at ws://localhost:${app.server?.port}/ws`);
+    console.log(`💬 Chat WebSocket available at ws://localhost:${app.server?.port}/chat/:room`);
+    console.log(`\n📝 Features demonstrated:`);
+    console.log(`   • ws.id - Short, unique client identifier`);
+    console.log(`   • ws.data.connectionId - Detailed connection ID`);
+    console.log(`   • ws.data.cookies - Parsed cookies from handshake`);
+    console.log(`   • Client IP, User Agent, Origin tracking`);
 }
-main().catch(console.error);
+main().catch(console.error);

package/package.json CHANGED Viewed

@@ -5,7 +5,7 @@
     ".": "./src/index.ts",
     "./plugins": "./plugins/index.ts"
   },
-  "version": "0.0.7",
+  "version": "0.0.8",
   "type": "module",
   "devDependencies": {
     "@types/bun": "latest"

package/src/index.ts CHANGED Viewed

@@ -92,6 +92,18 @@ type Handler<P extends string, S extends RouteSchema | undefined = undefined> =
     app: BXO
 ) => Response | string | BunFile | Promise<Response | string | BunFile>
+// WebSocket client information type
+export type WebSocketClientInfo = {
+    id: string; // Short, unique identifier for the WebSocket connection
+    path: string;
+    ip: string;
+    userAgent: string;
+    origin: string;
+    host: string;
+    connectionId: string; // Longer, more detailed connection identifier
+    cookies: Record<string, string>; // Parsed cookies from the handshake
+};
 // WebSocket handler types
 export type WebSocketHandler<T = any> = {
     message?(ws: Bun.ServerWebSocket<T>, message: string | Buffer): void | Promise<void>;
@@ -436,22 +448,22 @@ export default class BXO {
         // Create WebSocket configuration if we have WebSocket routes
         const websocketConfig = hasWebSocketRoutes ? {
-            message: (ws: Bun.ServerWebSocket<{ path: string }>, message: string | Buffer) => {
+            message: (ws: Bun.ServerWebSocket<WebSocketClientInfo>, message: string | Buffer) => {
                 this.handleWebSocketMessage(ws, message);
             },
-            open: (ws: Bun.ServerWebSocket<{ path: string }>) => {
+            open: (ws: Bun.ServerWebSocket<WebSocketClientInfo>) => {
                 this.handleWebSocketOpen(ws);
             },
-            close: (ws: Bun.ServerWebSocket<{ path: string }>, code: number, reason: string) => {
+            close: (ws: Bun.ServerWebSocket<WebSocketClientInfo>, code: number, reason: string) => {
                 this.handleWebSocketClose(ws, code, reason);
             },
-            drain: (ws: Bun.ServerWebSocket<{ path: string }>) => {
+            drain: (ws: Bun.ServerWebSocket<WebSocketClientInfo>) => {
                 this.handleWebSocketDrain(ws);
             },
-            ping: (ws: Bun.ServerWebSocket<{ path: string }>, data: Buffer) => {
+            ping: (ws: Bun.ServerWebSocket<WebSocketClientInfo>, data: Buffer) => {
                 this.handleWebSocketPing(ws, data);
             },
-            pong: (ws: Bun.ServerWebSocket<{ path: string }>, data: Buffer) => {
+            pong: (ws: Bun.ServerWebSocket<WebSocketClientInfo>, data: Buffer) => {
                 this.handleWebSocketPong(ws, data);
             }
         } : undefined;
@@ -467,8 +479,26 @@ export default class BXO {
                         const url = new URL(req.url);
                         const wsRoute = this.findWebSocketRoute(url.pathname);
                         if (wsRoute) {
+                            // Capture client information during handshake
+                            const shortId = Math.random().toString(36).substr(2, 8);
+                            const connectionId = `${Date.now()}-${Math.random().toString(36).substr(2, 9)}`;
+                            const cookieHeader = req.headers.get("cookie");
+                            const clientInfo = {
+                                id: shortId, // Short, easy-to-use ID
+                                path: url.pathname,
+                                ip: req.headers.get("x-forwarded-for") ||
+                                    req.headers.get("x-real-ip") ||
+                                    "unknown",
+                                userAgent: req.headers.get("user-agent") || "unknown",
+                                origin: req.headers.get("origin") || "unknown",
+                                host: req.headers.get("host") || "unknown",
+                                connectionId: connectionId, // Longer, more detailed ID
+                                cookies: cookieHeader ? parseCookies(cookieHeader) : {}
+                            };
                             const success = server.upgrade(req, {
-                                data: { path: url.pathname }
+                                data: clientInfo
                             });
                             if (success) {
                                 return; // WebSocket upgrade successful
@@ -533,7 +563,7 @@ export default class BXO {
         return null;
     }
-    private handleWebSocketMessage(ws: Bun.ServerWebSocket<{ path: string }>, message: string | Buffer): void {
+    private handleWebSocketMessage(ws: Bun.ServerWebSocket<WebSocketClientInfo>, message: string | Buffer): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.message) {
             try {
@@ -544,7 +574,7 @@ export default class BXO {
         }
     }
-    private handleWebSocketOpen(ws: Bun.ServerWebSocket<{ path: string }>): void {
+    private handleWebSocketOpen(ws: Bun.ServerWebSocket<WebSocketClientInfo>): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.open) {
             try {
@@ -555,7 +585,7 @@ export default class BXO {
         }
     }
-    private handleWebSocketClose(ws: Bun.ServerWebSocket<{ path: string }>, code: number, reason: string): void {
+    private handleWebSocketClose(ws: Bun.ServerWebSocket<WebSocketClientInfo>, code: number, reason: string): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.close) {
             try {
@@ -566,7 +596,7 @@ export default class BXO {
         }
     }
-    private handleWebSocketDrain(ws: Bun.ServerWebSocket<{ path: string }>): void {
+    private handleWebSocketDrain(ws: Bun.ServerWebSocket<WebSocketClientInfo>): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.drain) {
             try {
@@ -577,7 +607,7 @@ export default class BXO {
         }
     }
-    private handleWebSocketPing(ws: Bun.ServerWebSocket<{ path: string }>, data: Buffer): void {
+    private handleWebSocketPing(ws: Bun.ServerWebSocket<WebSocketClientInfo>, data: Buffer): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.ping) {
             try {
@@ -588,7 +618,7 @@ export default class BXO {
         }
     }
-    private handleWebSocketPong(ws: Bun.ServerWebSocket<{ path: string }>, data: Buffer): void {
+    private handleWebSocketPong(ws: Bun.ServerWebSocket<WebSocketClientInfo>, data: Buffer): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.pong) {
             try {