@vercube/ws 0.0.34 → 0.0.36

package/README.md

@@ -1,34 +1,40 @@
 <div align="center">
-  <a href="https://vercube.dev/"><img src="https://github.com/OskarLebuda/vue-lazy-hydration/raw/main/.github/assets/logo.png?raw=true" alt="Vite logo" width="200"></a>
+  <img src="https://raw.githubusercontent.com/vercube/vercube/refs/heads/main/.github/assets/cover.png" width="100%" alt="Vercube - Unleash your server development." />
   <br>
   <br>
 
-# Vercube
-
-Next generation HTTP framework
-
-  <a href="https://www.npmjs.com/package/@vercube/auth">
-    <img src="https://img.shields.io/npm/v/%40vercube%2Fauth?style=for-the-badge&logo=npm&color=%23767eff" alt="npm"/>
-  </a>
-  <a href="https://www.npmjs.com/package/@vercube/auth">
-    <img src="https://img.shields.io/npm/dm/%40vercube%2Fauth?style=for-the-badge&logo=npm&color=%23767eff" alt="npm"/>
-  </a>
-  <a href="https://github.com/vercube/vercube/blob/main/LICENSE" target="_blank">
-    <img src="https://img.shields.io/npm/l/%40vercube%2Fauth?style=for-the-badge&color=%23767eff" alt="License"/>
-  </a>
-  <a href="https://codecov.io/gh/vercube/vercube" target="_blank">
-    <img src="https://img.shields.io/codecov/c/github/vercube/vercube?style=for-the-badge&color=%23767eff" alt="Coverage"/>
-  </a>
-  <br/>
-  <br/>
+# @vercube/ws
+
+### WebSockets for Vercube apps
+
+[![Ask DeepWiki](<https://img.shields.io/badge/ask-deepwiki-%20blue?style=for-the-badge&logo=bookstack&logoColor=rgba(255%2C%20255%2C%20255%2C%200.6)&labelColor=%23000&color=%232f2f2f>)](https://deepwiki.com/vercube/vercube)
+![NPM Version](<https://img.shields.io/npm/v/%40vercube%2Fws?style=for-the-badge&logo=npm&logoColor=rgba(255%2C%20255%2C%20255%2C%200.6)&labelColor=%23000&color=%232e2e2e&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40vercube%2Fws>)
+![GitHub License](<https://img.shields.io/github/license/vercube/vercube?style=for-the-badge&logo=gitbook&logoColor=rgba(255%2C%20255%2C%20255%2C%200.6)&labelColor=%23000&color=%232f2f2f>)
+![Codecov](<https://img.shields.io/codecov/c/github/vercube/vercube?style=for-the-badge&logo=vitest&logoColor=rgba(255%2C%20255%2C%20255%2C%200.6)&labelColor=%23000&color=%232f2f2f>)
+
+**Real-time communication with decorators - `@Message` to listen, `@Emit` to respond, `@Broadcast` to send to everyone. Built on [crossws](https://crossws.unjs.io/).**
+
+[Website](https://vercube.dev) • [Documentation](https://vercube.dev/docs/getting-started)
+
 </div>
 
-An ultra-efficient JavaScript server framework that runs anywhere - Node.js, Bun, or Deno - with unmatched flexibility and complete configurability for developers who refuse to sacrifice speed or control.
+## ✨ Features
+
+- **Decorator-based** - `@Namespace`, `@Message`, `@Emit`, `@Broadcast`
+- **Connection control** - validate who can connect with `@OnConnectionAttempt`
+- **Message validation** - use Zod schemas to validate incoming data
+- **Namespaces** - organize connections into logical groups
+
+## 📦 Installation
+
+```bash
+pnpm add @vercube/ws
+```
 
-## <a name="module">Websocket module</a>
+## 📖 Usage
 
-The Websocket module enables you to set up websocket connections on your application. It offers a collection of decorators that enable you to listen to incoming messages, emit/broadcast messages and more. It works based on namespaces.
+Check out the full [documentation](https://vercube.dev/docs/modules/web-sockets/overview)
 
-## <a name="documentation">📖 Documentation</a>
+## 📜 License
 
-Comprehensive documentation is available at [vercube.dev](https://vercube.dev). There you'll find detailed module descriptions, project information, guides, and everything else you need to know about Vercube.
+[MIT](https://github.com/vercube/vercube/blob/main/LICENSE)

package/dist/index.d.mts

@@ -1,8 +1,7 @@
 import { App, BasePlugin, ValidationTypes } from "@vercube/core";
-import { Peer } from "crossws";
+import { Message as Message$1, Peer, WSError } from "crossws";
 
 //#region src/Decorators/Namespace.d.ts
-
 /**
  * A decorator function for defining a websocket namespace and accepting websocket connections.
  *
@@ -122,7 +121,7 @@ declare class WebsocketPlugin<T = unknown> extends BasePlugin<T> {
 declare namespace WebsocketTypes {
   enum HandlerAction {
     CONNECTION = "connection",
-    MESSAGE = "message",
+    MESSAGE = "message"
   }
   type HandlerAttributes = {
     callback: Function;
@@ -176,7 +175,7 @@ declare class WebsocketService {
   /**
    * Broadcast a message to all peers in the same namespace (including the sender).
    *
-   * @param {Peer} peer - The sender peer (used to determine the namespace).
+   * @param {WSPeer} peer - The sender peer (used to determine the namespace).
    * @param {unknown} message - The message to broadcast.
    * @returns {void}
    */
@@ -184,7 +183,7 @@ declare class WebsocketService {
   /**
    * Emit a message to a single peer.
    *
-   * @param {Peer} peer - The peer to send the message to.
+   * @param {WSPeer} peer - The peer to send the message to.
    * @param {unknown} message - The message to send.
    * @returns {void}
    */
@@ -192,7 +191,7 @@ declare class WebsocketService {
   /**
    * Broadcast a message to all peers in the same namespace except the sender.
    *
-   * @param {Peer} peer - The sender peer (used to determine the namespace).
+   * @param {WSPeer} peer - The sender peer (used to determine the namespace).
    * @param {unknown} message - The message to broadcast.
    * @returns {void}
    */
@@ -206,7 +205,7 @@ declare class WebsocketService {
   /**
    * Handle an incoming websocket message for a peer.
    *
-   * @param {Peer} peer - The peer receiving the message.
+   * @param {WSPeer} peer - The peer receiving the message.
    * @param {Message} rawMessage - The raw websocket message.
    * @returns {Promise<void>}
    */
@@ -216,4 +215,4 @@ declare class WebsocketService {
 //#region src/Symbols/WebsocketSymbols.d.ts
 declare const $WebsocketService: symbol;
 //#endregion
-export { $WebsocketService, Broadcast, BroadcastOthers, Emit, Message, Namespace, OnConnectionAttempt, WebsocketPlugin, WebsocketService, WebsocketTypes };
+export { $WebsocketService, Broadcast, BroadcastOthers, Emit, Message, Namespace, OnConnectionAttempt, type WSError, type Message$1 as WSMessage, type Peer as WSPeer, WebsocketPlugin, WebsocketService, WebsocketTypes };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { BadRequestError, BasePlugin, HttpServer, ValidationProvider, initializeMetadata, initializeMetadataMethod } from "@vercube/core";
+import { BadRequestError, BasePlugin, HttpServer, ValidationProvider, initializeMetadata, initializeMetadataMethod, safeJsonParse, sanitizeObject } from "@vercube/core";
 import { BaseDecorator, Identity, Inject, InjectOptional, createDecorator } from "@vercube/di";
 import { Logger } from "@vercube/logger";
 import { defineHooks } from "crossws";
@@ -36,7 +36,7 @@ let WebsocketTypes;
 })(WebsocketTypes || (WebsocketTypes = {}));
 
 //#endregion
-//#region \0@oxc-project+runtime@0.99.0/helpers/decorate.js
+//#region \0@oxc-project+runtime@0.110.0/helpers/decorate.js
 function __decorate(decorators, target, key, desc) {
 	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
 	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -108,7 +108,7 @@ var WebsocketService = class {
 	/**
 	* Broadcast a message to all peers in the same namespace (including the sender).
 	*
-	* @param {Peer} peer - The sender peer (used to determine the namespace).
+	* @param {WSPeer} peer - The sender peer (used to determine the namespace).
 	* @param {unknown} message - The message to broadcast.
 	* @returns {void}
 	*/
@@ -122,7 +122,7 @@ var WebsocketService = class {
 	/**
 	* Emit a message to a single peer.
 	*
-	* @param {Peer} peer - The peer to send the message to.
+	* @param {WSPeer} peer - The peer to send the message to.
 	* @param {unknown} message - The message to send.
 	* @returns {void}
 	*/
@@ -132,7 +132,7 @@ var WebsocketService = class {
 	/**
 	* Broadcast a message to all peers in the same namespace except the sender.
 	*
-	* @param {Peer} peer - The sender peer (used to determine the namespace).
+	* @param {WSPeer} peer - The sender peer (used to determine the namespace).
 	* @param {unknown} message - The message to broadcast.
 	* @returns {void}
 	*/
@@ -153,7 +153,7 @@ var WebsocketService = class {
 			upgrade: async (request) => {
 				const url = new URL(request.url);
 				const namespace = url.pathname;
-				const parameters = Object.fromEntries(url.searchParams.entries());
+				const parameters = sanitizeObject(Object.fromEntries(url.searchParams));
 				if (!!!this.fNamespaces?.[namespace?.toLowerCase()]) {
 					this.gLogger?.warn("WebsocketService::initialize", `Namespace "${namespace}" is not registered. Connection rejected.`);
 					return new Response("Namespace not registered", { status: 403 });
@@ -193,13 +193,13 @@ var WebsocketService = class {
 	/**
 	* Handle an incoming websocket message for a peer.
 	*
-	* @param {Peer} peer - The peer receiving the message.
+	* @param {WSPeer} peer - The peer receiving the message.
 	* @param {Message} rawMessage - The raw websocket message.
 	* @returns {Promise<void>}
 	*/
 	async handleMessage(peer, rawMessage) {
 		try {
-			const msg = JSON.parse(rawMessage.text());
+			const msg = safeJsonParse(rawMessage.text());
 			const namespace = peer.namespace?.toLowerCase();
 			const event = msg.event;
 			const data = msg.data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercube/ws",
-  "version": "0.0.34",
+  "version": "0.0.36",
   "description": "Websocket module for Vercube framework",
   "repository": "@vercube/ws",
   "license": "MIT",
@@ -18,14 +18,14 @@
     "README.md"
   ],
   "devDependencies": {
-    "zod": "4.1.13"
+    "zod": "4.3.6"
   },
   "dependencies": {
-    "crossws": "0.4.1",
-    "srvx": "0.9.6",
-    "@vercube/core": "0.0.34",
-    "@vercube/di": "0.0.34",
-    "@vercube/logger": "0.0.34"
+    "crossws": "0.4.3",
+    "srvx": "0.10.1",
+    "@vercube/core": "0.0.36",
+    "@vercube/di": "0.0.36",
+    "@vercube/logger": "0.0.36"
   },
   "publishConfig": {
     "access": "public"