bxo 0.0.9 → 0.0.10-dev.2

package/example/websocket-example.ts

@@ -127,101 +127,127 @@ async function main() {
         `, 200);
     });
 
-    // WebSocket route with enhanced client identification
+    // WebSocket route with enhanced client identification and typed interface
     app.ws("/ws", {
         open(ws) {
-            const clientInfo = ws.data;
+            const data = ws.data; // Now fully typed with WebSocketData interface
             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);
-            console.log(`  🔍 Search Params:`, clientInfo.searchParams);
-            console.log(`  🔐 Authorization:`, clientInfo.authorization || 'None');
-            
-            // Check for authentication
-            if (clientInfo.authorization) {
+            console.log(`  🆔 Client ID: ${data.id}`);
+            console.log(`  🔗 Connection ID: ${data.connectionId}`);
+            console.log(`  🌐 Client IP: ${data.ip}`);
+            console.log(`  🖥️  User Agent: ${data.userAgent}`);
+            console.log(`  🎯 Origin: ${data.origin}`);
+            console.log(`  🏠 Host: ${data.host}`);
+            console.log(`  📍 Path: ${data.path}`);
+            console.log(`  🍪 Cookies:`, data.cookies);
+            console.log(`  🔍 Search Params:`, data.searchParams);
+            console.log(`  🔐 Authorization:`, data.authorization || 'None');
+            
+            // Use direct property access
+            console.log(`  🍪 Session Cookie:`, data.cookies.sessionId);
+            console.log(`  🔍 Room Param:`, data.searchParams.room);
+            console.log(`  👤 Username:`, data.searchParams.user || data.searchParams.username);
+            console.log(`  🏠 Room:`, data.searchParams.room);
+            console.log(`  🔐 Has Auth:`, !!(data.authorization || data.searchParams.token || data.searchParams.auth));
+            console.log(`  🔑 Auth Type:`, data.authorization ? (data.authorization.toLowerCase().startsWith('bearer ') ? 'bearer' : 'basic') : 'none');
+            console.log(`  🎫 Token:`, data.searchParams.token || data.searchParams.auth);
+            
+            // Check for authentication using direct property access
+            if (data.authorization || data.searchParams.token || data.searchParams.auth) {
                 console.log(`  ✅ Authenticated user detected`);
-                ws.send(`Welcome authenticated user! Your WebSocket ID is: ${clientInfo.id}`);
-            } else if (clientInfo.searchParams.token || clientInfo.searchParams.auth) {
-                console.log(`  🔑 Token-based auth detected`);
-                ws.send(`Welcome! Token detected. Your WebSocket ID is: ${clientInfo.id}`);
+                ws.send(`Welcome authenticated user! Your WebSocket ID is: ${data.id}`);
             } else {
-                ws.send(`Welcome! Your WebSocket ID is: ${clientInfo.id}`);
+                ws.send(`Welcome! Your WebSocket ID is: ${data.id}`);
             }
         },
         
         message(ws, message) {
-            const clientInfo = ws.data;
-            console.log(`💬 Message from ${clientInfo.id} (${clientInfo.ip}):`, message);
-            console.log(`   🍪 Client cookies:`, clientInfo.cookies);
-            console.log(`   🔍 Search params:`, clientInfo.searchParams);
-            console.log(`   🔐 Auth:`, clientInfo.authorization || 'None');
+            const data = ws.data; // Fully typed WebSocketData
+            console.log(`💬 Message from ${data.id} (${data.ip}):`, message);
+            console.log(`   🍪 Client cookies:`, data.cookies);
+            console.log(`   🔍 Search params:`, data.searchParams);
+            console.log(`   🔐 Auth:`, data.authorization || 'None');
+            
+            // Use direct property access
+            const username = data.searchParams.user || data.searchParams.username || 'Anonymous';
+            const room = data.searchParams.room;
+            const sessionId = data.cookies.sessionId;
+            
+            console.log(`   👤 Username: ${username}`);
+            console.log(`   🏠 Room: ${room || 'None'}`);
+            console.log(`   🍪 Session: ${sessionId || 'None'}`);
             
             // Echo the message back with client ID and context
-            let response = `[${clientInfo.id}] Echo: ${message}`;
+            let response = `[${data.id}] Echo: ${message}`;
             
-            // Add context based on search params
-            if (clientInfo.searchParams.room) {
-                response += ` (Room: ${clientInfo.searchParams.room})`;
+            // Add context using direct property access
+            if (room) {
+                response += ` (Room: ${room})`;
             }
-            if (clientInfo.searchParams.user) {
-                response += ` (User: ${clientInfo.searchParams.user})`;
+            if (username && username !== 'Anonymous') {
+                response += ` (User: ${username})`;
             }
             
             ws.send(response);
         },
         
         close(ws, code, reason) {
-            const clientInfo = ws.data;
-            console.log(`❌ WebSocket connection closed for ${clientInfo.id}: ${code} ${reason}`);
+            const data = ws.data;
+            console.log(`❌ WebSocket connection closed for ${data.id}: ${code} ${reason}`);
         },
         
         ping(ws, data) {
-            const clientInfo = ws.data;
-            console.log(`🏓 Ping received from ${clientInfo.id}:`, data);
+            const wsData = ws.data;
+            console.log(`🏓 Ping received from ${wsData.id}:`, data);
         },
         
         pong(ws, data) {
-            const clientInfo = ws.data;
-            console.log(`🏓 Pong received from ${clientInfo.id}:`, data);
+            const wsData = ws.data;
+            console.log(`🏓 Pong received from ${wsData.id}:`, data);
         }
     });
 
-    // Chat room WebSocket with client identification
+    // Chat room WebSocket with typed client identification
     app.ws("/chat/:room", {
         open(ws) {
-            const clientInfo = ws.data;
-            const room = clientInfo.path.split('/').pop() || 'unknown';
+            const data = ws.data; // Fully typed WebSocketData
+            const room = data.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);
-            console.log(`  🔍 Search Params:`, clientInfo.searchParams);
-            console.log(`  🔐 Authorization:`, clientInfo.authorization || 'None');
-            
-            // Check for user info in search params
-            const username = clientInfo.searchParams.user || clientInfo.searchParams.username || 'Anonymous';
-            ws.send(`Welcome to chat room: ${room}! Your ID is: ${clientInfo.id}, Username: ${username}`);
+            console.log(`  🆔 Client: ${data.id} (${data.ip})`);
+            console.log(`  🍪 Cookies:`, data.cookies);
+            console.log(`  🔍 Search Params:`, data.searchParams);
+            console.log(`  🔐 Authorization:`, data.authorization || 'None');
+            
+            // Use direct property access
+            const username = data.searchParams.user || data.searchParams.username || 'Anonymous';
+            const sessionId = data.cookies.sessionId;
+            const hasAuth = !!(data.authorization || data.searchParams.token || data.searchParams.auth);
+            
+            console.log(`  👤 Username: ${username}`);
+            console.log(`  🍪 Session: ${sessionId || 'None'}`);
+            console.log(`  🔐 Authenticated: ${hasAuth}`);
+            
+            ws.send(`Welcome to chat room: ${room}! Your ID is: ${data.id}, Username: ${username}`);
         },
         
         message(ws, message) {
-            const clientInfo = ws.data;
-            const room = clientInfo.path.split('/').pop() || 'unknown';
-            const username = clientInfo.searchParams.user || clientInfo.searchParams.username || 'Anonymous';
-            console.log(`💬 Message in room ${room} from ${clientInfo.id} (${username}):`, message);
-            console.log(`   🍪 Client cookies:`, clientInfo.cookies);
-            console.log(`   🔍 Search params:`, clientInfo.searchParams);
-            ws.send(`[${room}] [${username}] [${clientInfo.id}] Echo: ${message}`);
+            const data = ws.data; // Fully typed WebSocketData
+            const room = data.path.split('/').pop() || 'unknown';
+            const username = data.searchParams.user || data.searchParams.username || 'Anonymous';
+            const sessionId = data.cookies.sessionId;
+            
+            console.log(`💬 Message in room ${room} from ${data.id} (${username}):`, message);
+            console.log(`   🍪 Client cookies:`, data.cookies);
+            console.log(`   🔍 Search params:`, data.searchParams);
+            console.log(`   🍪 Session: ${sessionId || 'None'}`);
+            
+            ws.send(`[${room}] [${username}] [${data.id}] Echo: ${message}`);
         },
         
         close(ws, 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}`);
+            const data = ws.data;
+            const room = data.path.split('/').pop() || 'unknown';
+            console.log(`❌ Chat room connection closed for room ${room} (${data.id}): ${code} ${reason}`);
         }
     });
 
@@ -230,12 +256,18 @@ async function main() {
     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.id - Short, unique client identifier`);
     console.log(`   • ws.data.connectionId - Detailed connection ID`);
     console.log(`   • ws.data.cookies - Parsed cookies from handshake`);
     console.log(`   • ws.data.searchParams - Query parameters from URL`);
     console.log(`   • ws.data.authorization - Authorization header`);
     console.log(`   • Client IP, User Agent, Origin tracking`);
+    console.log(`\n🔧 Direct Property Access:`);
+    console.log(`   • ws.data.cookies.name - Get specific cookie`);
+    console.log(`   • ws.data.searchParams.name - Get specific search param`);
+    console.log(`   • ws.data.authorization - Check authorization header`);
+    console.log(`   • ws.data.id - Short client identifier`);
+    console.log(`   • ws.data.connectionId - Detailed connection ID`);
     console.log(`\n🧪 Test URLs:`);
     console.log(`   • Basic: ws://localhost:${app.server?.port}/ws`);
     console.log(`   • With params: ws://localhost:${app.server?.port}/ws?room=test&user=john&theme=dark`);

package/package.json

@@ -5,7 +5,7 @@
     ".": "./src/index.ts",
     "./plugins": "./plugins/index.ts"
   },
-  "version": "0.0.9",
+  "version": "0.0.10-dev.2",
   "type": "module",
   "devDependencies": {
     "@types/bun": "latest"

package/src/index.ts

@@ -106,8 +106,14 @@ export type WebSocketClientInfo = {
     authorization?: string; // Authorization header (Bearer token, Basic auth, etc.)
 };
 
+// WebSocket data interface - this is what you get when accessing ws.data
+export interface WebSocketData extends WebSocketClientInfo {
+    // Simple interface with just the data properties
+    // No convenience methods - use direct property access
+}
+
 // WebSocket handler types
-export type WebSocketHandler<T = any> = {
+export type WebSocketHandler<T = WebSocketData> = {
     message?(ws: Bun.ServerWebSocket<T>, message: string | Buffer): void | Promise<void>;
     open?(ws: Bun.ServerWebSocket<T>): void | Promise<void>;
     close?(ws: Bun.ServerWebSocket<T>, code: number, reason: string): void | Promise<void>;
@@ -450,22 +456,22 @@ export default class BXO {
 
         // Create WebSocket configuration if we have WebSocket routes
         const websocketConfig = hasWebSocketRoutes ? {
-            message: (ws: Bun.ServerWebSocket<WebSocketClientInfo>, message: string | Buffer) => {
+            message: (ws: Bun.ServerWebSocket<WebSocketData>, message: string | Buffer) => {
                 this.handleWebSocketMessage(ws, message);
             },
-            open: (ws: Bun.ServerWebSocket<WebSocketClientInfo>) => {
+            open: (ws: Bun.ServerWebSocket<WebSocketData>) => {
                 this.handleWebSocketOpen(ws);
             },
-            close: (ws: Bun.ServerWebSocket<WebSocketClientInfo>, code: number, reason: string) => {
+            close: (ws: Bun.ServerWebSocket<WebSocketData>, code: number, reason: string) => {
                 this.handleWebSocketClose(ws, code, reason);
             },
-            drain: (ws: Bun.ServerWebSocket<WebSocketClientInfo>) => {
+            drain: (ws: Bun.ServerWebSocket<WebSocketData>) => {
                 this.handleWebSocketDrain(ws);
             },
-            ping: (ws: Bun.ServerWebSocket<WebSocketClientInfo>, data: Buffer) => {
+            ping: (ws: Bun.ServerWebSocket<WebSocketData>, data: Buffer) => {
                 this.handleWebSocketPing(ws, data);
             },
-            pong: (ws: Bun.ServerWebSocket<WebSocketClientInfo>, data: Buffer) => {
+            pong: (ws: Bun.ServerWebSocket<WebSocketData>, data: Buffer) => {
                 this.handleWebSocketPong(ws, data);
             }
         } : undefined;
@@ -502,7 +508,7 @@ export default class BXO {
                                 }
                             }
                             
-                            const clientInfo = {
+                            const baseClientInfo = {
                                 id: shortId, // Short, easy-to-use ID
                                 path: url.pathname,
                                 ip: req.headers.get("x-forwarded-for") || 
@@ -516,6 +522,11 @@ export default class BXO {
                                 searchParams: searchParams, // Query parameters from URL
                                 authorization: authHeader || undefined // Authorization header
                             };
+
+                            // Create simple WebSocket data object
+                            const clientInfo: WebSocketData = {
+                                ...baseClientInfo
+                            };
                             
                             const success = server.upgrade(req, {
                                 data: clientInfo
@@ -583,7 +594,7 @@ export default class BXO {
         return null;
     }
 
-    private handleWebSocketMessage(ws: Bun.ServerWebSocket<WebSocketClientInfo>, message: string | Buffer): void {
+    private handleWebSocketMessage(ws: Bun.ServerWebSocket<WebSocketData>, message: string | Buffer): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.message) {
             try {
@@ -594,7 +605,7 @@ export default class BXO {
         }
     }
 
-    private handleWebSocketOpen(ws: Bun.ServerWebSocket<WebSocketClientInfo>): void {
+    private handleWebSocketOpen(ws: Bun.ServerWebSocket<WebSocketData>): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.open) {
             try {
@@ -605,7 +616,7 @@ export default class BXO {
         }
     }
 
-    private handleWebSocketClose(ws: Bun.ServerWebSocket<WebSocketClientInfo>, code: number, reason: string): void {
+    private handleWebSocketClose(ws: Bun.ServerWebSocket<WebSocketData>, code: number, reason: string): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.close) {
             try {
@@ -616,7 +627,7 @@ export default class BXO {
         }
     }
 
-    private handleWebSocketDrain(ws: Bun.ServerWebSocket<WebSocketClientInfo>): void {
+    private handleWebSocketDrain(ws: Bun.ServerWebSocket<WebSocketData>): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.drain) {
             try {
@@ -627,7 +638,7 @@ export default class BXO {
         }
     }
 
-    private handleWebSocketPing(ws: Bun.ServerWebSocket<WebSocketClientInfo>, data: Buffer): void {
+    private handleWebSocketPing(ws: Bun.ServerWebSocket<WebSocketData>, data: Buffer): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.ping) {
             try {
@@ -638,7 +649,7 @@ export default class BXO {
         }
     }
 
-    private handleWebSocketPong(ws: Bun.ServerWebSocket<WebSocketClientInfo>, data: Buffer): void {
+    private handleWebSocketPong(ws: Bun.ServerWebSocket<WebSocketData>, data: Buffer): void {
         const route = this.findWebSocketRoute(ws.data?.path || "");
         if (route?.websocketHandler?.pong) {
             try {

package/test-enhanced-websocket.js

@@ -1,68 +0,0 @@
-// Comprehensive test for enhanced WebSocket client identification
-console.log('🧪 Testing Enhanced WebSocket Client Identification...\n');
-
-// Test 1: Basic WebSocket connection
-console.log('1. Testing basic WebSocket connection');
-const ws1 = new WebSocket('ws://localhost:3000/ws');
-
-ws1.onopen = function() {
-    console.log('✓ Connected to basic WebSocket');
-    ws1.send('Hello from basic connection!');
-};
-
-ws1.onmessage = function(event) {
-    console.log('✓ Received:', event.data);
-    ws1.close();
-};
-
-ws1.onclose = function() {
-    console.log('✓ Basic connection closed\n');
-    
-    // Test 2: WebSocket with search parameters
-    console.log('2. Testing WebSocket with search parameters');
-    const ws2 = new WebSocket('ws://localhost:3000/ws?room=test&user=john&theme=dark&token=abc123');
-    
-    ws2.onopen = function() {
-        console.log('✓ Connected with search params');
-        ws2.send('Hello from connection with params!');
-    };
-    
-    ws2.onmessage = function(event) {
-        console.log('✓ Received:', event.data);
-        ws2.close();
-    };
-    
-    ws2.onclose = function() {
-        console.log('✓ Search params connection closed\n');
-        
-        // Test 3: Chat room with search parameters
-        console.log('3. Testing chat room with search parameters');
-        const ws3 = new WebSocket('ws://localhost:3000/chat/general?user=alice&theme=light&role=moderator');
-        
-        ws3.onopen = function() {
-            console.log('✓ Connected to chat room with params');
-            ws3.send('Hello from chat room!');
-        };
-        
-        ws3.onmessage = function(event) {
-            console.log('✓ Received:', event.data);
-            ws3.close();
-        };
-        
-        ws3.onclose = function() {
-            console.log('✓ Chat room connection closed');
-            console.log('\n✅ All tests completed! Check the server logs to see:');
-            console.log('   • ws.id - Short client identifier');
-            console.log('   • ws.data.searchParams - Query parameters');
-            console.log('   • ws.data.cookies - Parsed cookies');
-            console.log('   • ws.data.authorization - Auth header');
-            console.log('   • Client IP and other identification info');
-            process.exit(0);
-        };
-    };
-};
-
-ws1.onerror = function(error) {
-    console.error('❌ WebSocket error:', error);
-    process.exit(1);
-};