@ooneex/socket 0.0.1 → 0.3.0

package/README.md

@@ -1 +1,546 @@
-# @ooneex/router
+# @ooneex/socket
+
+A WebSocket server and client implementation for real-time bidirectional communication in TypeScript applications. This package provides types and utilities for creating WebSocket controllers with pub/sub capabilities, channel management, and seamless integration with the Ooneex framework.
+
+![Bun](https://img.shields.io/badge/Bun-Compatible-orange?style=flat-square&logo=bun)
+![Deno](https://img.shields.io/badge/Deno-Compatible-blue?style=flat-square&logo=deno)
+![Node.js](https://img.shields.io/badge/Node.js-Compatible-green?style=flat-square&logo=node.js)
+![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue?style=flat-square&logo=typescript)
+![MIT License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)
+
+## Features
+
+✅ **WebSocket Controllers** - Define socket endpoints using decorators
+
+✅ **Channel Management** - Subscribe, publish, and manage WebSocket channels
+
+✅ **Pub/Sub Support** - Built-in publish/subscribe pattern for real-time messaging
+
+✅ **Type-Safe** - Full TypeScript support with proper type definitions
+
+✅ **Framework Integration** - Works seamlessly with Ooneex routing and controllers
+
+✅ **Bidirectional Communication** - Send and receive messages in real-time
+
+✅ **Client Library** - Separate client export for frontend applications
+
+## Installation
+
+### Bun
+```bash
+bun add @ooneex/socket
+```
+
+### pnpm
+```bash
+pnpm add @ooneex/socket
+```
+
+### Yarn
+```bash
+yarn add @ooneex/socket
+```
+
+### npm
+```bash
+npm install @ooneex/socket
+```
+
+## Usage
+
+### Basic WebSocket Controller
+
+```typescript
+import { Route } from '@ooneex/routing';
+import type { IController, ContextType } from '@ooneex/socket';
+import type { IResponse } from '@ooneex/http-response';
+
+@Route.socket({
+  name: 'api.chat.connect',
+  path: '/ws/chat',
+  description: 'Connect to chat WebSocket'
+})
+class ChatController implements IController {
+  public async index(context: ContextType): Promise<IResponse> {
+    // Subscribe to the channel
+    await context.channel.subscribe();
+    
+    return context.response.json({
+      connected: true,
+      message: 'Welcome to the chat!'
+    });
+  }
+}
+```
+
+### WebSocket with Room Support
+
+```typescript
+import { Route } from '@ooneex/routing';
+import { type } from '@ooneex/validation';
+import type { IController, ContextType } from '@ooneex/socket';
+
+@Route.socket({
+  name: 'api.rooms.join',
+  path: '/ws/rooms/:roomId',
+  description: 'Join a specific room',
+  params: {
+    roomId: type('string')
+  }
+})
+class RoomController implements IController {
+  public async index(context: ContextType): Promise<IResponse> {
+    const { roomId } = context.params;
+    
+    // Subscribe to the room channel
+    await context.channel.subscribe();
+    
+    // Notify other users in the room
+    await context.channel.publish(
+      context.response.json({
+        event: 'user_joined',
+        roomId,
+        userId: context.user?.id
+      })
+    );
+    
+    return context.response.json({
+      joined: true,
+      roomId
+    });
+  }
+}
+```
+
+### Sending Messages
+
+```typescript
+import { Route } from '@ooneex/routing';
+import type { IController, ContextType } from '@ooneex/socket';
+
+@Route.socket({
+  name: 'api.messages.send',
+  path: '/ws/messages',
+  description: 'Send a message'
+})
+class MessageController implements IController {
+  public async index(context: ContextType): Promise<IResponse> {
+    const { message, recipientId } = context.payload;
+    
+    // Send response back to the sender
+    await context.channel.send(
+      context.response.json({
+        event: 'message_sent',
+        message,
+        timestamp: new Date().toISOString()
+      })
+    );
+    
+    return context.response.json({ success: true });
+  }
+}
+```
+
+### Broadcasting to Channel
+
+```typescript
+import { Route } from '@ooneex/routing';
+import type { IController, ContextType } from '@ooneex/socket';
+
+@Route.socket({
+  name: 'api.notifications.broadcast',
+  path: '/ws/notifications',
+  description: 'Broadcast notifications'
+})
+class NotificationController implements IController {
+  public async index(context: ContextType): Promise<IResponse> {
+    const { title, body } = context.payload;
+    
+    // Subscribe first
+    await context.channel.subscribe();
+    
+    // Publish to all subscribers
+    await context.channel.publish(
+      context.response.json({
+        event: 'notification',
+        title,
+        body,
+        timestamp: new Date().toISOString()
+      })
+    );
+    
+    return context.response.json({ broadcasted: true });
+  }
+}
+```
+
+### Managing Subscriptions
+
+```typescript
+import { Route } from '@ooneex/routing';
+import type { IController, ContextType } from '@ooneex/socket';
+
+@Route.socket({
+  name: 'api.presence.toggle',
+  path: '/ws/presence',
+  description: 'Toggle presence subscription'
+})
+class PresenceController implements IController {
+  public async index(context: ContextType): Promise<IResponse> {
+    const { channel } = context;
+    
+    // Check subscription status
+    if (channel.isSubscribed()) {
+      // Unsubscribe from channel
+      await channel.unsubscribe();
+      
+      return context.response.json({
+        subscribed: false,
+        message: 'Unsubscribed from presence updates'
+      });
+    }
+    
+    // Subscribe to channel
+    await channel.subscribe();
+    
+    return context.response.json({
+      subscribed: true,
+      message: 'Subscribed to presence updates'
+    });
+  }
+}
+```
+
+### Closing Connections
+
+```typescript
+import { Route } from '@ooneex/routing';
+import type { IController, ContextType } from '@ooneex/socket';
+
+@Route.socket({
+  name: 'api.connection.close',
+  path: '/ws/disconnect',
+  description: 'Close WebSocket connection'
+})
+class DisconnectController implements IController {
+  public async index(context: ContextType): Promise<IResponse> {
+    const { channel } = context;
+    
+    // Clean up subscription
+    if (channel.isSubscribed()) {
+      await channel.unsubscribe();
+    }
+    
+    // Close the connection with a code and reason
+    channel.close(1000, 'User disconnected');
+    
+    return context.response.json({ disconnected: true });
+  }
+}
+```
+
+## API Reference
+
+### Interfaces
+
+#### `IController<T>`
+
+Interface for WebSocket controllers.
+
+```typescript
+interface IController<T extends ContextConfigType = ContextConfigType> {
+  index: (context: ContextType<T>) => Promise<IResponse<T["response"]>> | IResponse<T["response"]>;
+}
+```
+
+### Types
+
+#### `ContextType<T>`
+
+Extended context type for WebSocket controllers with channel management.
+
+```typescript
+type ContextType<T extends ContextConfigType = ContextConfigType> = ControllerContextType<T> & {
+  channel: {
+    send: (response: IResponse<T["response"]>) => Promise<void>;
+    close(code?: number, reason?: string): void;
+    subscribe: () => Promise<void>;
+    isSubscribed(): boolean;
+    unsubscribe: () => Promise<void>;
+    publish: (response: IResponse<T["response"]>) => Promise<void>;
+  };
+};
+```
+
+**Channel Methods:**
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `send(response)` | `Promise<void>` | Send a message to the connected client |
+| `close(code?, reason?)` | `void` | Close the WebSocket connection |
+| `subscribe()` | `Promise<void>` | Subscribe to the channel |
+| `isSubscribed()` | `boolean` | Check if currently subscribed |
+| `unsubscribe()` | `Promise<void>` | Unsubscribe from the channel |
+| `publish(response)` | `Promise<void>` | Publish message to all channel subscribers |
+
+#### `ContextConfigType`
+
+Configuration type for socket context.
+
+```typescript
+type ContextConfigType = {
+  response: Record<string, unknown>;
+} & RequestConfigType;
+```
+
+#### `ControllerClassType`
+
+Type for socket controller class constructors.
+
+```typescript
+type ControllerClassType = new (...args: any[]) => IController;
+```
+
+## Client Usage
+
+Import the client for frontend applications:
+
+```typescript
+import { /* client exports */ } from '@ooneex/socket/client';
+```
+
+### Basic Client Connection
+
+```typescript
+// Connect to WebSocket endpoint
+const ws = new WebSocket('wss://api.example.com/ws/chat');
+
+ws.onopen = () => {
+  console.log('Connected to WebSocket');
+  
+  // Send a message
+  ws.send(JSON.stringify({
+    action: 'subscribe',
+    channel: 'general'
+  }));
+};
+
+ws.onmessage = (event) => {
+  const data = JSON.parse(event.data);
+  console.log('Received:', data);
+};
+
+ws.onclose = (event) => {
+  console.log('Disconnected:', event.code, event.reason);
+};
+
+ws.onerror = (error) => {
+  console.error('WebSocket error:', error);
+};
+```
+
+## Advanced Usage
+
+### Typed Socket Controller
+
+```typescript
+import { Route } from '@ooneex/routing';
+import { type } from '@ooneex/validation';
+import type { IController, ContextType, ContextConfigType } from '@ooneex/socket';
+
+interface ChatConfig extends ContextConfigType {
+  params: { roomId: string };
+  payload: { message: string; type: 'text' | 'image' };
+  queries: Record<string, never>;
+  response: {
+    event: string;
+    data: unknown;
+    timestamp: string;
+  };
+}
+
+@Route.socket({
+  name: 'api.chat.message',
+  path: '/ws/chat/:roomId',
+  description: 'Send chat message',
+  params: { roomId: type('string') },
+  payload: type({
+    message: 'string',
+    type: "'text' | 'image'"
+  })
+})
+class ChatMessageController implements IController<ChatConfig> {
+  public async index(context: ContextType<ChatConfig>): Promise<IResponse<ChatConfig['response']>> {
+    const { roomId } = context.params;
+    const { message, type } = context.payload;
+    
+    // TypeScript knows the exact types
+    await context.channel.publish(
+      context.response.json({
+        event: 'new_message',
+        data: { roomId, message, type, userId: context.user?.id },
+        timestamp: new Date().toISOString()
+      })
+    );
+    
+    return context.response.json({
+      event: 'message_sent',
+      data: { messageId: crypto.randomUUID() },
+      timestamp: new Date().toISOString()
+    });
+  }
+}
+```
+
+### Real-Time Notifications
+
+```typescript
+import { Route } from '@ooneex/routing';
+import type { IController, ContextType } from '@ooneex/socket';
+
+@Route.socket({
+  name: 'api.notifications.stream',
+  path: '/ws/notifications/:userId',
+  description: 'Stream user notifications'
+})
+class NotificationStreamController implements IController {
+  public async index(context: ContextType): Promise<IResponse> {
+    const { userId } = context.params;
+    
+    // Only allow users to subscribe to their own notifications
+    if (context.user?.id !== userId) {
+      return context.response.exception('Unauthorized', { status: 403 });
+    }
+    
+    await context.channel.subscribe();
+    
+    // Send initial notification count
+    const unreadCount = await this.notificationService.getUnreadCount(userId);
+    
+    return context.response.json({
+      subscribed: true,
+      unreadCount
+    });
+  }
+}
+```
+
+### Live Collaboration
+
+```typescript
+import { Route } from '@ooneex/routing';
+import type { IController, ContextType } from '@ooneex/socket';
+
+@Route.socket({
+  name: 'api.docs.collaborate',
+  path: '/ws/docs/:documentId',
+  description: 'Real-time document collaboration'
+})
+class DocumentCollaborationController implements IController {
+  public async index(context: ContextType): Promise<IResponse> {
+    const { documentId } = context.params;
+    const { action, content, cursor } = context.payload;
+    
+    await context.channel.subscribe();
+    
+    switch (action) {
+      case 'edit':
+        await context.channel.publish(
+          context.response.json({
+            event: 'content_update',
+            documentId,
+            userId: context.user?.id,
+            content
+          })
+        );
+        break;
+        
+      case 'cursor':
+        await context.channel.publish(
+          context.response.json({
+            event: 'cursor_move',
+            documentId,
+            userId: context.user?.id,
+            cursor
+          })
+        );
+        break;
+    }
+    
+    return context.response.json({ success: true });
+  }
+}
+```
+
+### WebSocket with Authentication
+
+```typescript
+import { Route } from '@ooneex/routing';
+import { ERole } from '@ooneex/role';
+import type { IController, ContextType } from '@ooneex/socket';
+
+@Route.socket({
+  name: 'api.admin.dashboard',
+  path: '/ws/admin/dashboard',
+  description: 'Admin real-time dashboard',
+  roles: [ERole.ADMIN, ERole.SUPER_ADMIN]
+})
+class AdminDashboardController implements IController {
+  public async index(context: ContextType): Promise<IResponse> {
+    // User is guaranteed to have ADMIN or SUPER_ADMIN role
+    await context.channel.subscribe();
+    
+    // Stream real-time metrics
+    return context.response.json({
+      connected: true,
+      role: context.user?.role,
+      subscribedAt: new Date().toISOString()
+    });
+  }
+}
+```
+
+## WebSocket Close Codes
+
+Common WebSocket close codes you can use:
+
+| Code | Name | Description |
+|------|------|-------------|
+| `1000` | Normal Closure | Normal connection closure |
+| `1001` | Going Away | Endpoint is going away |
+| `1002` | Protocol Error | Protocol error |
+| `1003` | Unsupported Data | Received unsupported data type |
+| `1008` | Policy Violation | Message violates policy |
+| `1011` | Internal Error | Server encountered an error |
+
+```typescript
+// Close with specific code and reason
+context.channel.close(1000, 'Session ended');
+context.channel.close(1008, 'Message too large');
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+### Development Setup
+
+1. Clone the repository
+2. Install dependencies: `bun install`
+3. Run tests: `bun run test`
+4. Build the project: `bun run build`
+
+### Guidelines
+
+- Write tests for new features
+- Follow the existing code style
+- Update documentation for API changes
+- Ensure all tests pass before submitting PR
+
+---
+
+Made with ❤️ by the Ooneex team

package/dist/client/index.d.ts

@@ -3,7 +3,7 @@ import { ResponseDataType } from "@ooneex/http-response";
 import { LocaleInfoType } from "@ooneex/translation";
 type RequestDataType = {
 	payload?: Record<string, unknown>;
-	queries?: Record<string, string | number>;
+	queries?: Record<string, boolean | number | bigint | string>;
 	language?: LocaleInfoType;
 };
 interface ISocket<
@@ -15,7 +15,7 @@ interface ISocket<
 	onMessage: (handler: (response: ResponseDataType<Response>) => void) => void;
 	onOpen: (handler: (event: Event) => void) => void;
 	onClose: (handler: (event: CloseEvent) => void) => void;
-	onError: (handler: (event: Event) => void) => void;
+	onError: (handler: (event: Event, response?: ResponseDataType<Response>) => void) => void;
 }
 declare class Socket<
 	SendData extends RequestDataType = RequestDataType,
@@ -35,7 +35,7 @@ declare class Socket<
 	onMessage(handler: (response: ResponseDataType2<Response>) => void): void;
 	onOpen(handler: (event: Event) => void): void;
 	onClose(handler: (event: CloseEvent) => void): void;
-	onError(handler: (event: Event) => void): void;
+	onError(handler: (event: Event, response?: ResponseDataType2<Response>) => void): void;
 	private buildURL;
 	private setupEventHandlers;
 	private flushQueuedMessages;

package/dist/client/index.js

@@ -1,4 +1,4 @@
 // @bun
-class n{url;ws;messageHandler;openHandler;errorHandler;closeHandler;queuedMessages=[];constructor(o){this.url=o;let e=this.buildURL(this.url);this.ws=new WebSocket(e),this.setupEventHandlers()}close(o,e){this.ws.close(o,e)}send(o){let e=JSON.stringify(o);this.sendRaw(e)}sendRaw(o){if(this.ws&&this.ws.readyState===WebSocket.OPEN)this.ws.send(o);else this.queuedMessages.push(o)}onMessage(o){this.messageHandler=o}onOpen(o){this.openHandler=o}onClose(o){this.closeHandler=o}onError(o){this.errorHandler=o}buildURL(o){if(o.startsWith("ws://")||o.startsWith("wss://"))return o;if(o.startsWith("http://"))o=o.replace("http://","ws://");else if(o.startsWith("https://"))o=o.replace("https://","wss://");else if(!o.startsWith("ws://")&&!o.startsWith("wss://"))o=`wss://${o}`;return o}setupEventHandlers(){this.ws.onmessage=(o)=>{if(this.messageHandler){let e=JSON.parse(o.data);if(e.done)this.ws.close();if(e.success){this.messageHandler(e);return}if(this.errorHandler)this.errorHandler(o,e)}},this.ws.onopen=(o)=>{if(this.flushQueuedMessages(),this.openHandler)this.openHandler(o)},this.ws.onerror=(o)=>{if(this.errorHandler)this.errorHandler(o)},this.ws.onclose=(o)=>{if(this.closeHandler)this.closeHandler(o)}}flushQueuedMessages(){while(this.queuedMessages.length>0){let o=this.queuedMessages.shift();if(o!==void 0&&this.ws.readyState===WebSocket.OPEN)this.ws.send(o)}}}export{n as Socket};
+class n{url;ws;messageHandler;openHandler;errorHandler;closeHandler;queuedMessages=[];constructor(e){this.url=e;let o=this.buildURL(this.url);this.ws=new WebSocket(o),this.setupEventHandlers()}close(e,o){this.ws.close(e,o)}send(e){let o=JSON.stringify(e);this.sendRaw(o)}sendRaw(e){if(this.ws&&this.ws.readyState===WebSocket.OPEN)this.ws.send(e);else this.queuedMessages.push(e)}onMessage(e){this.messageHandler=e}onOpen(e){this.openHandler=e}onClose(e){this.closeHandler=e}onError(e){this.errorHandler=e}buildURL(e){if(e.startsWith("ws://")||e.startsWith("wss://"))return e;if(e.startsWith("http://"))e=e.replace("http://","ws://");else if(e.startsWith("https://"))e=e.replace("https://","wss://");else if(!e.startsWith("ws://")&&!e.startsWith("wss://"))e=`wss://${e}`;return e}setupEventHandlers(){this.ws.onmessage=(e)=>{if(this.messageHandler){let o=JSON.parse(e.data);if(o.done)this.ws.close();if(o.success){this.messageHandler(o);return}if(this.errorHandler)this.errorHandler(e,o)}},this.ws.onopen=(e)=>{if(this.flushQueuedMessages(),this.openHandler)this.openHandler(e)},this.ws.onerror=(e)=>{if(this.errorHandler)this.errorHandler(e)},this.ws.onclose=(e)=>{if(this.closeHandler)this.closeHandler(e)}}flushQueuedMessages(){while(this.queuedMessages.length>0){let e=this.queuedMessages.shift();if(e!==void 0&&this.ws.readyState===WebSocket.OPEN)this.ws.send(e)}}}export{n as Socket};
 
-//# debugId=B1BC1332EB24344564756E2164756E21
+//# debugId=DDC4BBAA6B121D9B64756E2164756E21

package/dist/client/index.js.map

@@ -2,9 +2,9 @@
   "version": 3,
   "sources": ["src/client/Socket.ts"],
   "sourcesContent": [
-    "import type { ResponseDataType } from \"@ooneex/http-response\";\nimport type { ISocket, RequestDataType } from \"./types\";\n\nexport class Socket<\n  SendData extends RequestDataType = RequestDataType,\n  Response extends Record<string, unknown> = Record<string, unknown>,\n> implements ISocket<SendData, Response>\n{\n  private ws: WebSocket;\n  private messageHandler?: (response: ResponseDataType<Response>) => void;\n  private openHandler?: (event: Event) => void;\n  private errorHandler?: (event: Event, response?: ResponseDataType<Response>) => void;\n  private closeHandler?: (event: CloseEvent) => void;\n  private queuedMessages: (string | ArrayBufferLike | Blob | ArrayBufferView)[] = [];\n\n  constructor(private readonly url: string) {\n    const fullURL = this.buildURL(this.url);\n    this.ws = new WebSocket(fullURL);\n    this.setupEventHandlers();\n  }\n\n  public close(code?: number, reason?: string): void {\n    this.ws.close(code, reason);\n  }\n\n  public send(data: SendData): void {\n    const text = JSON.stringify(data);\n    this.sendRaw(text);\n  }\n\n  private sendRaw(payload: string | ArrayBufferLike | Blob | ArrayBufferView): void {\n    if (this.ws && this.ws.readyState === WebSocket.OPEN) {\n      this.ws.send(payload);\n    } else {\n      this.queuedMessages.push(payload);\n    }\n  }\n\n  public onMessage(handler: (response: ResponseDataType<Response>) => void): void {\n    this.messageHandler = handler;\n  }\n\n  public onOpen(handler: (event: Event) => void): void {\n    this.openHandler = handler;\n  }\n\n  public onClose(handler: (event: CloseEvent) => void): void {\n    this.closeHandler = handler;\n  }\n\n  public onError(handler: (event: Event) => void): void {\n    this.errorHandler = handler;\n  }\n\n  private buildURL(url: string): string {\n    if (url.startsWith(\"ws://\") || url.startsWith(\"wss://\")) {\n      return url;\n    }\n\n    // Convert HTTP(S) to WebSocket protocol\n    if (url.startsWith(\"http://\")) {\n      url = url.replace(\"http://\", \"ws://\");\n    } else if (url.startsWith(\"https://\")) {\n      url = url.replace(\"https://\", \"wss://\");\n    } else if (!url.startsWith(\"ws://\") && !url.startsWith(\"wss://\")) {\n      url = `wss://${url}`;\n    }\n\n    return url;\n  }\n\n  private setupEventHandlers(): void {\n    this.ws.onmessage = (event: MessageEvent) => {\n      if (this.messageHandler) {\n        const data = JSON.parse(event.data) as ResponseDataType<Response>;\n\n        if (data.done) {\n          this.ws.close();\n        }\n\n        if (data.success) {\n          this.messageHandler(data);\n\n          return;\n        }\n\n        if (this.errorHandler) {\n          this.errorHandler(event, data);\n        }\n      }\n    };\n\n    this.ws.onopen = (event: Event) => {\n      this.flushQueuedMessages();\n      if (this.openHandler) {\n        this.openHandler(event);\n      }\n    };\n\n    this.ws.onerror = (event: Event) => {\n      if (this.errorHandler) {\n        this.errorHandler(event);\n      }\n    };\n\n    this.ws.onclose = (event: CloseEvent) => {\n      if (this.closeHandler) {\n        this.closeHandler(event);\n      }\n    };\n  }\n\n  private flushQueuedMessages(): void {\n    while (this.queuedMessages.length > 0) {\n      const message = this.queuedMessages.shift();\n      if (message !== undefined && this.ws.readyState === WebSocket.OPEN) {\n        this.ws.send(message);\n      }\n    }\n  }\n}\n"
+    "import type { ResponseDataType } from \"@ooneex/http-response\";\nimport type { ISocket, RequestDataType } from \"./types\";\n\nexport class Socket<\n  SendData extends RequestDataType = RequestDataType,\n  Response extends Record<string, unknown> = Record<string, unknown>,\n> implements ISocket<SendData, Response>\n{\n  private ws: WebSocket;\n  private messageHandler?: (response: ResponseDataType<Response>) => void;\n  private openHandler?: (event: Event) => void;\n  private errorHandler?: (event: Event, response?: ResponseDataType<Response>) => void;\n  private closeHandler?: (event: CloseEvent) => void;\n  private queuedMessages: (string | ArrayBufferLike | Blob | ArrayBufferView)[] = [];\n\n  constructor(private readonly url: string) {\n    const fullURL = this.buildURL(this.url);\n    this.ws = new WebSocket(fullURL);\n    this.setupEventHandlers();\n  }\n\n  public close(code?: number, reason?: string): void {\n    this.ws.close(code, reason);\n  }\n\n  public send(data: SendData): void {\n    const text = JSON.stringify(data);\n    this.sendRaw(text);\n  }\n\n  private sendRaw(payload: string | ArrayBufferLike | Blob | ArrayBufferView): void {\n    if (this.ws && this.ws.readyState === WebSocket.OPEN) {\n      this.ws.send(payload);\n    } else {\n      this.queuedMessages.push(payload);\n    }\n  }\n\n  public onMessage(handler: (response: ResponseDataType<Response>) => void): void {\n    this.messageHandler = handler;\n  }\n\n  public onOpen(handler: (event: Event) => void): void {\n    this.openHandler = handler;\n  }\n\n  public onClose(handler: (event: CloseEvent) => void): void {\n    this.closeHandler = handler;\n  }\n\n  public onError(handler: (event: Event, response?: ResponseDataType<Response>) => void): void {\n    this.errorHandler = handler;\n  }\n\n  private buildURL(url: string): string {\n    if (url.startsWith(\"ws://\") || url.startsWith(\"wss://\")) {\n      return url;\n    }\n\n    // Convert HTTP(S) to WebSocket protocol\n    if (url.startsWith(\"http://\")) {\n      url = url.replace(\"http://\", \"ws://\");\n    } else if (url.startsWith(\"https://\")) {\n      url = url.replace(\"https://\", \"wss://\");\n    } else if (!url.startsWith(\"ws://\") && !url.startsWith(\"wss://\")) {\n      url = `wss://${url}`;\n    }\n\n    return url;\n  }\n\n  private setupEventHandlers(): void {\n    this.ws.onmessage = (event: MessageEvent) => {\n      if (this.messageHandler) {\n        const data = JSON.parse(event.data) as ResponseDataType<Response>;\n\n        if (data.done) {\n          this.ws.close();\n        }\n\n        if (data.success) {\n          this.messageHandler(data);\n\n          return;\n        }\n\n        if (this.errorHandler) {\n          this.errorHandler(event, data);\n        }\n      }\n    };\n\n    this.ws.onopen = (event: Event) => {\n      this.flushQueuedMessages();\n      if (this.openHandler) {\n        this.openHandler(event);\n      }\n    };\n\n    this.ws.onerror = (event: Event) => {\n      if (this.errorHandler) {\n        this.errorHandler(event);\n      }\n    };\n\n    this.ws.onclose = (event: CloseEvent) => {\n      if (this.closeHandler) {\n        this.closeHandler(event);\n      }\n    };\n  }\n\n  private flushQueuedMessages(): void {\n    while (this.queuedMessages.length > 0) {\n      const message = this.queuedMessages.shift();\n      if (message !== undefined && this.ws.readyState === WebSocket.OPEN) {\n        this.ws.send(message);\n      }\n    }\n  }\n}\n"
   ],
-  "mappings": ";AAGO,MAAM,CAIb,CAQ+B,IAPrB,GACA,eACA,YACA,aACA,aACA,eAAwE,CAAC,EAEjF,WAAW,CAAkB,EAAa,CAAb,WAC3B,IAAM,EAAU,KAAK,SAAS,KAAK,GAAG,EACtC,KAAK,GAAK,IAAI,UAAU,CAAO,EAC/B,KAAK,mBAAmB,EAGnB,KAAK,CAAC,EAAe,EAAuB,CACjD,KAAK,GAAG,MAAM,EAAM,CAAM,EAGrB,IAAI,CAAC,EAAsB,CAChC,IAAM,EAAO,KAAK,UAAU,CAAI,EAChC,KAAK,QAAQ,CAAI,EAGX,OAAO,CAAC,EAAkE,CAChF,GAAI,KAAK,IAAM,KAAK,GAAG,aAAe,UAAU,KAC9C,KAAK,GAAG,KAAK,CAAO,EAEpB,UAAK,eAAe,KAAK,CAAO,EAI7B,SAAS,CAAC,EAA+D,CAC9E,KAAK,eAAiB,EAGjB,MAAM,CAAC,EAAuC,CACnD,KAAK,YAAc,EAGd,OAAO,CAAC,EAA4C,CACzD,KAAK,aAAe,EAGf,OAAO,CAAC,EAAuC,CACpD,KAAK,aAAe,EAGd,QAAQ,CAAC,EAAqB,CACpC,GAAI,EAAI,WAAW,OAAO,GAAK,EAAI,WAAW,QAAQ,EACpD,OAAO,EAIT,GAAI,EAAI,WAAW,SAAS,EAC1B,EAAM,EAAI,QAAQ,UAAW,OAAO,EAC/B,QAAI,EAAI,WAAW,UAAU,EAClC,EAAM,EAAI,QAAQ,WAAY,QAAQ,EACjC,QAAI,CAAC,EAAI,WAAW,OAAO,GAAK,CAAC,EAAI,WAAW,QAAQ,EAC7D,EAAM,SAAS,IAGjB,OAAO,EAGD,kBAAkB,EAAS,CACjC,KAAK,GAAG,UAAY,CAAC,IAAwB,CAC3C,GAAI,KAAK,eAAgB,CACvB,IAAM,EAAO,KAAK,MAAM,EAAM,IAAI,EAElC,GAAI,EAAK,KACP,KAAK,GAAG,MAAM,EAGhB,GAAI,EAAK,QAAS,CAChB,KAAK,eAAe,CAAI,EAExB,OAGF,GAAI,KAAK,aACP,KAAK,aAAa,EAAO,CAAI,IAKnC,KAAK,GAAG,OAAS,CAAC,IAAiB,CAEjC,GADA,KAAK,oBAAoB,EACrB,KAAK,YACP,KAAK,YAAY,CAAK,GAI1B,KAAK,GAAG,QAAU,CAAC,IAAiB,CAClC,GAAI,KAAK,aACP,KAAK,aAAa,CAAK,GAI3B,KAAK,GAAG,QAAU,CAAC,IAAsB,CACvC,GAAI,KAAK,aACP,KAAK,aAAa,CAAK,GAKrB,mBAAmB,EAAS,CAClC,MAAO,KAAK,eAAe,OAAS,EAAG,CACrC,IAAM,EAAU,KAAK,eAAe,MAAM,EAC1C,GAAI,IAAY,QAAa,KAAK,GAAG,aAAe,UAAU,KAC5D,KAAK,GAAG,KAAK,CAAO,GAI5B",
-  "debugId": "B1BC1332EB24344564756E2164756E21",
+  "mappings": ";AAGO,MAAM,CAIb,CAQ+B,IAPrB,GACA,eACA,YACA,aACA,aACA,eAAwE,CAAC,EAEjF,WAAW,CAAkB,EAAa,CAAb,WAC3B,IAAM,EAAU,KAAK,SAAS,KAAK,GAAG,EACtC,KAAK,GAAK,IAAI,UAAU,CAAO,EAC/B,KAAK,mBAAmB,EAGnB,KAAK,CAAC,EAAe,EAAuB,CACjD,KAAK,GAAG,MAAM,EAAM,CAAM,EAGrB,IAAI,CAAC,EAAsB,CAChC,IAAM,EAAO,KAAK,UAAU,CAAI,EAChC,KAAK,QAAQ,CAAI,EAGX,OAAO,CAAC,EAAkE,CAChF,GAAI,KAAK,IAAM,KAAK,GAAG,aAAe,UAAU,KAC9C,KAAK,GAAG,KAAK,CAAO,EAEpB,UAAK,eAAe,KAAK,CAAO,EAI7B,SAAS,CAAC,EAA+D,CAC9E,KAAK,eAAiB,EAGjB,MAAM,CAAC,EAAuC,CACnD,KAAK,YAAc,EAGd,OAAO,CAAC,EAA4C,CACzD,KAAK,aAAe,EAGf,OAAO,CAAC,EAA8E,CAC3F,KAAK,aAAe,EAGd,QAAQ,CAAC,EAAqB,CACpC,GAAI,EAAI,WAAW,OAAO,GAAK,EAAI,WAAW,QAAQ,EACpD,OAAO,EAIT,GAAI,EAAI,WAAW,SAAS,EAC1B,EAAM,EAAI,QAAQ,UAAW,OAAO,EAC/B,QAAI,EAAI,WAAW,UAAU,EAClC,EAAM,EAAI,QAAQ,WAAY,QAAQ,EACjC,QAAI,CAAC,EAAI,WAAW,OAAO,GAAK,CAAC,EAAI,WAAW,QAAQ,EAC7D,EAAM,SAAS,IAGjB,OAAO,EAGD,kBAAkB,EAAS,CACjC,KAAK,GAAG,UAAY,CAAC,IAAwB,CAC3C,GAAI,KAAK,eAAgB,CACvB,IAAM,EAAO,KAAK,MAAM,EAAM,IAAI,EAElC,GAAI,EAAK,KACP,KAAK,GAAG,MAAM,EAGhB,GAAI,EAAK,QAAS,CAChB,KAAK,eAAe,CAAI,EAExB,OAGF,GAAI,KAAK,aACP,KAAK,aAAa,EAAO,CAAI,IAKnC,KAAK,GAAG,OAAS,CAAC,IAAiB,CAEjC,GADA,KAAK,oBAAoB,EACrB,KAAK,YACP,KAAK,YAAY,CAAK,GAI1B,KAAK,GAAG,QAAU,CAAC,IAAiB,CAClC,GAAI,KAAK,aACP,KAAK,aAAa,CAAK,GAI3B,KAAK,GAAG,QAAU,CAAC,IAAsB,CACvC,GAAI,KAAK,aACP,KAAK,aAAa,CAAK,GAKrB,mBAAmB,EAAS,CAClC,MAAO,KAAK,eAAe,OAAS,EAAG,CACrC,IAAM,EAAU,KAAK,eAAe,MAAM,EAC1C,GAAI,IAAY,QAAa,KAAK,GAAG,aAAe,UAAU,KAC5D,KAAK,GAAG,KAAK,CAAO,GAI5B",
+  "debugId": "DDC4BBAA6B121D9B64756E2164756E21",
   "names": []
 }

package/dist/index.d.ts

@@ -1,19 +1,6 @@
-import { IAnalytics } from "@ooneex/analytics";
-import { IAppEnv } from "@ooneex/app-env";
-import { ICache } from "@ooneex/cache";
-import { IDatabase, IRedisDatabaseAdapter } from "@ooneex/database";
-import { Header } from "@ooneex/http-header";
+import { ContextType as ControllerContextType } from "@ooneex/controller";
 import { RequestConfigType } from "@ooneex/http-request";
-import { IRequestFile } from "@ooneex/http-request-file";
 import { IResponse } from "@ooneex/http-response";
-import { ILogger, LogsEntity } from "@ooneex/logger";
-import { IMailer } from "@ooneex/mailer";
-import { IPermission } from "@ooneex/permission";
-import { IStorage } from "@ooneex/storage";
-import { LocaleInfoType } from "@ooneex/translation";
-import { ScalarType } from "@ooneex/types";
-import { IUrl } from "@ooneex/url";
-import { IUser } from "@ooneex/user";
 type ControllerClassType = new (...args: any[]) => IController;
 interface IController<T extends ContextConfigType = ContextConfigType> {
 	index: (context: ContextType<T>) => Promise<IResponse<T["response"]>> | IResponse<T["response"]>;
@@ -21,19 +8,7 @@ interface IController<T extends ContextConfigType = ContextConfigType> {
 type ContextConfigType = {
 	response: Record<string, unknown>;
 } & RequestConfigType;
-type ContextType<T extends ContextConfigType = ContextConfigType> = {
-	logger: ILogger<Record<string, ScalarType>> | ILogger<LogsEntity>;
-	analytics?: IAnalytics;
-	cache?: ICache;
-	permission?: IPermission;
-	storage?: IStorage;
-	database?: IDatabase;
-	redis?: IRedisDatabaseAdapter;
-	mailer?: IMailer;
-	app: {
-		url: IAppEnv;
-		env: IAppEnv;
-	};
+type ContextType<T extends ContextConfigType = ContextConfigType> = ControllerContextType<T> & {
 	channel: {
 		send: (response: IResponse<T["response"]>) => Promise<void>;
 		close(code?: number, reason?: string): void;
@@ -42,17 +17,5 @@ type ContextType<T extends ContextConfigType = ContextConfigType> = {
 		unsubscribe: () => Promise<void>;
 		publish: (response: IResponse<T["response"]>) => Promise<void>;
 	};
-	response: IResponse<T["response"]>;
-	path: string;
-	url: IUrl;
-	header: Header;
-	params: T["params"];
-	payload: T["payload"];
-	queries: T["queries"];
-	files: Record<string, IRequestFile>;
-	ip: string | null;
-	host: string;
-	language: LocaleInfoType;
-	user: IUser | null;
 };
 export { IController, ControllerClassType, ContextType, ContextConfigType };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ooneex/socket",
-  "description": "",
-  "version": "0.0.1",
+  "description": "WebSocket server and client implementation for real-time bidirectional communication",
+  "version": "0.3.0",
   "type": "module",
   "files": [
     "dist",
@@ -31,29 +31,21 @@
     "test": "bun test tests",
     "build": "bunup",
     "lint": "tsgo --noEmit && bunx biome lint",
-    "publish:prod": "bun publish --tolerate-republish --access public",
-    "publish:pack": "bun pm pack --destination ./dist",
-    "publish:dry": "bun publish --dry-run"
+    "publish": "bun publish --access public || true"
   },
   "devDependencies": {
-    "@ooneex/analytics": "0.0.1",
-    "@ooneex/cache": "0.0.1",
-    "@ooneex/database": "0.0.1",
-    "@ooneex/http-header": "0.0.1",
+    "@ooneex/controller": "0.0.1",
     "@ooneex/http-request": "0.0.1",
-    "@ooneex/http-request-file": "0.0.1",
     "@ooneex/http-response": "0.0.1",
-    "@ooneex/logger": "0.0.1",
-    "@ooneex/mailer": "0.0.1",
-    "@ooneex/permission": "0.0.1",
-    "@ooneex/storage": "0.0.1",
-    "@ooneex/translation": "0.0.1",
-    "@ooneex/types": "0.0.1",
-    "@ooneex/url": "0.0.1",
-    "@ooneex/user": "0.0.1"
+    "@ooneex/translation": "0.0.1"
   },
-  "peerDependencies": {},
-  "dependencies": {
-    "@ooneex/app-env": "0.0.1"
-  }
+  "keywords": [
+    "bun",
+    "ooneex",
+    "realtime",
+    "socket",
+    "typescript",
+    "websocket",
+    "ws"
+  ]
 }