@ooneex/socket 0.17.0 → 1.0.0

package/README.md

@@ -1,51 +1,31 @@
 # @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.
+WebSocket server implementation with room management, event broadcasting, client tracking, and middleware integration for real-time applications.
 
 ![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
+✅ **IController Interface** - Standard interface for WebSocket controller implementations with typed context
 
-✅ **Channel Management** - Subscribe, publish, and manage WebSocket channels
+✅ **Channel Management** - Subscribe, unsubscribe, publish, and send messages through typed channel API
 
-✅ **Pub/Sub Support** - Built-in publish/subscribe pattern for real-time messaging
+✅ **Pub/Sub Support** - Built-in publish/subscribe pattern with `channel.publish()` and `channel.subscribe()`
 
-✅ **Type-Safe** - Full TypeScript support with proper type definitions
+✅ **Type-Safe Context** - Generic `ContextType` extending the HTTP controller context with WebSocket channel operations
 
-✅ **Framework Integration** - Works seamlessly with Ooneex routing and controllers
+✅ **Connection Lifecycle** - Close connections with status codes and reasons via `channel.close()`
 
-✅ **Bidirectional Communication** - Send and receive messages in real-time
-
-✅ **Client Library** - Separate client export for frontend applications
+✅ **Framework Integration** - Extends `@ooneex/controller` context and works with `@ooneex/routing` socket decorators
 
 ## 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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ooneex/socket",
-  "description": "WebSocket server and client implementation for real-time bidirectional communication",
-  "version": "0.17.0",
+  "description": "WebSocket server implementation with room management, event broadcasting, client tracking, and middleware integration for real-time applications",
+  "version": "1.0.0",
   "type": "module",
   "files": [
     "dist",
@@ -18,27 +18,18 @@
         "default": "./dist/index.js"
       }
     },
-    "./client": {
-      "import": {
-        "types": "./dist/client/index.d.ts",
-        "default": "./dist/client/index.js"
-      }
-    },
     "./package.json": "./package.json"
   },
   "license": "MIT",
   "scripts": {
-    "test": "bun test tests",
     "build": "bunup",
     "lint": "tsgo --noEmit && bunx biome lint",
     "npm:publish": "bun publish --tolerate-republish --access public"
   },
   "devDependencies": {
-    "@ooneex/app-env": "0.0.17",
-    "@ooneex/controller": "0.16.1",
-    "@ooneex/http-request": "0.16.0",
-    "@ooneex/http-response": "0.16.0",
-    "@ooneex/translation": "0.0.17"
+    "@ooneex/controller": "0.17.1",
+    "@ooneex/http-request": "0.17.0",
+    "@ooneex/http-response": "0.17.0"
   },
   "keywords": [
     "bun",

package/dist/client/index.d.ts

@@ -1,43 +0,0 @@
-import { ResponseDataType as ResponseDataType2 } from "@ooneex/http-response";
-import { ResponseDataType } from "@ooneex/http-response";
-import { LocaleInfoType } from "@ooneex/translation";
-type RequestDataType = {
-	payload?: Record<string, unknown>;
-	queries?: Record<string, boolean | number | bigint | string>;
-	language?: LocaleInfoType;
-};
-interface ISocket<
-	SendData extends RequestDataType = RequestDataType,
-	Response extends Record<string, unknown> = Record<string, unknown>
-> {
-	close: (code?: number, reason?: string) => void;
-	send: (data: SendData) => void;
-	onMessage: (handler: (response: ResponseDataType<Response>) => void) => void;
-	onOpen: (handler: (event: Event) => void) => void;
-	onClose: (handler: (event: CloseEvent) => void) => void;
-	onError: (handler: (event: Event, response?: ResponseDataType<Response>) => void) => void;
-}
-declare class Socket<
-	SendData extends RequestDataType = RequestDataType,
-	Response extends Record<string, unknown> = Record<string, unknown>
-> implements ISocket<SendData, Response> {
-	private readonly url;
-	private ws;
-	private messageHandler?;
-	private openHandler?;
-	private errorHandler?;
-	private closeHandler?;
-	private queuedMessages;
-	constructor(url: string);
-	close(code?: number, reason?: string): void;
-	send(data: SendData): void;
-	private sendRaw;
-	onMessage(handler: (response: ResponseDataType2<Response>) => void): void;
-	onOpen(handler: (event: Event) => void): void;
-	onClose(handler: (event: CloseEvent) => void): void;
-	onError(handler: (event: Event, response?: ResponseDataType2<Response>) => void): void;
-	private buildURL;
-	private setupEventHandlers;
-	private flushQueuedMessages;
-}
-export { Socket, RequestDataType, ISocket };

package/dist/client/index.js

@@ -1,4 +0,0 @@
-// @bun
-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=DDC4BBAA6B121D9B64756E2164756E21

package/dist/client/index.js.map

@@ -1,10 +0,0 @@
-{
-  "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, 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,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": []
-}