redweb 0.6.9 → 0.7.0

package/README.md

@@ -1,239 +1,192 @@
+Here is the **fully updated and cleaned-up `README.md`** for RedWeb, now featuring a **working broadcast chat example** using `allowDuplicateConnections`:
+
+---
+
 # RedWeb
 
-RedWeb is a simple and flexible Node.js framework built on top of Express.js and WebSocket. It allows you to quickly set up web servers and WebSocket servers with customizable options.
+**RedWeb** is a flexible Node.js framework built on top of **Express.js** and **WebSocket**. It enables quick setup of HTTP(S) and WebSocket servers with a modular route and handler system.
 
-## Installation
+---
 
-To install RedWeb, use npm:
+## 📦 Installation
 
 ```bash
 npm install redweb
 ```
 
-## Usage
-
-### Basic Example
+---
 
-Initialize your RedWeb instance with the default options:
+## 🚀 Quick Start
 
-```javascript
+```js
 const { HttpServer, SocketServer } = require('redweb');
 
-// HTTP server with default configuration
 const httpServer = new HttpServer();
-
-// WebSocket server with default configuration
 const socketServer = new SocketServer();
 ```
 
-### Custom Configuration
-
-#### HTTP Server with HTMX Rendering
+---
 
-RedWeb now supports dynamic rendering of `.htmx` files using `enableHtmxRendering`.
+## 🌐 HTTP Server Example (HTMX Support)
 
-```javascript
+```js
 const { HttpServer, METHODS } = require('redweb');
 
-const options = {
-    port: 3000,
-    publicPaths: ['./public'],
-    enableHtmxRendering: true, // Enable .htmx rendering
-    services: [
-        {
-            serviceName: '/submit-form',
-            method: METHODS.POST,
-            function: (req, res) => {
-                const { name, email, message } = req.body;
-                if (!name || !email || !message) {
-                    return res.status(400).json({ error: 'All fields are required' });
-                }
-                res.status(200).json({ success: 'Form submitted successfully' });
-            }
-        }
-    ]
-};
-
-const app = new HttpServer(options);
+new HttpServer({
+  port: 3000,
+  publicPaths: ['./public'],
+  enableHtmxRendering: true,
+  services: [
+    {
+      serviceName: '/submit',
+      method: METHODS.POST,
+      function: (req, res) => {
+        if (!req.body.name) return res.status(400).json({ error: 'Missing name' });
+        res.status(200).json({ message: `Thanks, ${req.body.name}!` });
+      }
+    }
+  ]
+});
 ```
 
-Place `.htmx` files in the specified `publicPaths`, and they will be dynamically rendered.
-
+`.htmx` files under `public/` will render server-side.
 Example:
 
-**File: `public/index.htmx`**
-```javascript
-const name = 'RedWeb User';
-
+```html
+<!-- public/hello.htmx -->
 <@>
-    <h1>Hello, {{name}}!</h1>
+  <h1>Hello, {{name}}!</h1>
 <@/>
 ```
 
-Accessing `/index.htmx` will render:
-```html
-<h1>Hello, RedWeb User!</h1>
-```
-
-#### HTTPS Server
-
-```javascript
-const { HttpsServer } = require('redweb');
-
-const options = {
-    port: 3443,
-    ssl: {
-        key: './path/to/key.pem',
-        cert: './path/to/cert.pem'
-    },
-    publicPaths: ['./public'],
-    enableHtmxRendering: true // Enable .htmx rendering
-};
-
-const app = new HttpsServer(options);
-```
-
-### WebSocket Server with Routes and Handlers
+---
 
-RedWeb uses **route-based architecture** for WebSocket connections, allowing you to modularize and secure your WebSocket message handling logic.
+## 🔌 WebSocket Broadcast Chat (🔥 Instant Testing)
 
-#### Defining a Custom Handler
+### 1. `ChatHandler.js`
 
-Handlers extend the `BaseHandler` class and manage their own connections and message types.
-
-```javascript
+```js
 const { BaseHandler } = require('redweb');
 
 class ChatHandler extends BaseHandler {
-    constructor() {
-        super('chat');
-    }
-
-    onMessage(socket, message) {
-        console.log(`Received chat message: ${message.text}`);
-        socket.send(JSON.stringify({ type: 'chatResponse', message: 'Hello!' }));
-    }
+  constructor() {
+    super('chat');
+  }
+
+  onMessage(socket, message) {
+    const text = message.text;
+    console.log(`Broadcasting: ${text}`);
+    socket.broadcast({ type: 'chat', text });
+  }
 }
 
 module.exports = ChatHandler;
 ```
 
-#### Defining a WebSocket Route
+---
 
-Routes group handlers and specify the WebSocket path.
+### 2. `ChatRoute.js`
 
-```javascript
+```js
 const { SocketRoute } = require('redweb');
 const ChatHandler = require('./ChatHandler');
 
 class ChatRoute extends SocketRoute {
-    constructor() {
-        super({
-            path: '/chat',
-            handlers: [ChatHandler]
-        });
-    }
+  constructor() {
+    super({
+      path: '/chat',
+      handlers: [ChatHandler],
+      allowDuplicateConnections: true // key for local testing!
+    });
+  }
 }
 
 module.exports = ChatRoute;
 ```
 
-#### Setting Up a WebSocket Server with Routes
+---
+
+### 3. `server.js`
 
-```javascript
+```js
 const { SocketServer } = require('redweb');
 const ChatRoute = require('./ChatRoute');
 
 new SocketServer({
-    port: 3000,
-    routes: [ChatRoute]
+  port: 3000,
+  routes: [ChatRoute]
 });
 ```
 
-### Adding Routes Dynamically
+---
 
-Routes can be added to the WebSocket server after initialization.
+### 4. `client.html`
 
-```javascript
-const { SocketServer, SocketRoute } = require('redweb');
-const ChatHandler = require('./ChatHandler');
-
-class ChatRoute extends SocketRoute {
-    constructor() {
-        super({
-            path: '/chat',
-            handlers: [ChatHandler]
-        });
-    }
-}
-
-const socketServer = new SocketServer({ port: 3000 });
-
-// Dynamically add a new route
-const chatRoute = new ChatRoute();
-socketServer.routes.push(chatRoute);
+```html
+<!DOCTYPE html>
+<html>
+  <body>
+    <h1>Broadcast Chat</h1>
+    <input id="msg" placeholder="Type message..." />
+    <button onclick="send()">Send</button>
+    <pre id="log"></pre>
+
+    <script>
+      const log = document.getElementById('log');
+      const ws = new WebSocket('ws://localhost:3000/chat');
+
+      ws.onmessage = (e) => {
+        const msg = JSON.parse(e.data);
+        log.textContent += `\n${msg.text}`;
+      };
+
+      function send() {
+        const text = document.getElementById('msg').value;
+        ws.send(JSON.stringify({ type: 'chat', text }));
+      }
+    </script>
+  </body>
+</html>
 ```
 
-### Client Communication with a Route
-
-The client connects to the WebSocket server using the specified route.
+Open multiple tabs to test!
 
-```javascript
-const WebSocket = require('ws');
+---
 
-const ws = new WebSocket('ws://localhost:3000/chat');
+## 🔧 Options
 
-ws.on('open', () => {
-    ws.send(JSON.stringify({ type: 'chat', text: 'Hello there!' }));
-});
+### HTTP / HTTPS Server Options
 
-ws.on('message', (message) => {
-    console.log('Received:', message);
-});
-```
+| Option                | Type      | Default        | Description                    |
+| --------------------- | --------- | -------------- | ------------------------------ |
+| `port`                | number    | `80`           | Port to listen on              |
+| `bind`                | string    | `'0.0.0.0'`    | Bind address                   |
+| `publicPaths`         | string\[] | `['./public']` | Serve static and `.htmx` files |
+| `services`            | object\[] | `[]`           | REST endpoints                 |
+| `enableHtmxRendering` | boolean   | `false`        | Enables `.htmx` file rendering |
+| `ssl`                 | object    | `undefined`    | Used in `HttpsServer`          |
 
-### Managing Connected Clients
+---
 
-RedWeb's WebSocket server maintains a list of connected clients by their IP addresses for each route. This list is automatically updated when clients connect or disconnect.
-
-```javascript
-const { SocketRoute } = require('redweb');
-
-class ChatRoute extends SocketRoute {
-    constructor() {
-        super({
-            path: '/chat',
-            handlers: []
-        });
-    }
-
-    onConnection(socket) {
-        console.log('New client connected:', socket.remoteAddress);
-    }
-}
-
-module.exports = ChatRoute;
-```
+### WebSocket Server Options
 
-## Options
+| Option                      | Type                | Default | Description                         |
+| --------------------------- | ------------------- | ------- | ----------------------------------- |
+| `port`                      | number              | `3000`  | WebSocket port                      |
+| `routes`                    | `SocketRoute[]`     | `[]`    | List of custom route classes        |
+| `allowDuplicateConnections` | boolean (per route) | `false` | Allow multiple clients from same IP |
 
-### HttpServer and HttpsServer Options
+---
 
-- **port**: Port number (default: `80`).
-- **bind**: Bind address (default: `0.0.0.0`).
-- **publicPaths**: Array of paths to serve static files (default: `['./public']`).
-- **services**: Array of services with endpoints and handlers (default: `[]`).
-- **listenCallback**: Function to execute once the server starts listening.
-- **encoding**: Encoding type for request bodies (`'json'` or `'urlencoded'`).
-- **ssl**: SSL configuration for HTTPS server (`{ key: './path/to/key.pem', cert: './path/to/cert.pem' }`).
-- **enableHtmxRendering**: Enable dynamic rendering of `.htmx` files (default: `false`).
+## 🆕 0.7.0 Update Highlights
 
-### SocketServer Options
+* ✅ `allowDuplicateConnections` for multi-tab testing
+* ✅ Robust message validation
+* ✅ `socket.broadcast()` now excludes sender
+* ✅ Better error handling
 
-- **port**: Port number (default: `3000`).
-- **routes**: Array of `SocketRoute` classes to define WebSocket routes and handlers.
-- **ssl**: SSL configuration for SecureSocketServer (`{ key: './path/to/key.pem', cert: './path/to/cert.pem' }`).
+---
 
-## License
+## 🪪 License
 
-MIT License
+MIT

package/index.d.ts

@@ -1,177 +1,98 @@
 declare module 'redweb' {
-    import { Request, Response } from 'express';
-    import { Server as HTTPServer } from 'http';
-    import { Server as HTTPSServer } from 'https';
-    import WebSocket from 'ws';
-
-    /**
-     * RedWeb encoding types.
-     */
+    import { Application } from 'express';
+    import { CorsOptions } from 'cors';
+    import { Server as HttpServer } from 'http';
+    import { WebSocket } from 'ws';
+  
     export type RedWebEncoding = 'json' | 'urlencoded';
-
-    /**
-     * Service configuration for RedWeb.
-     */
-    export interface Service {
-        serviceName: string;
-        method: 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
-        function: (req: Request, res: Response) => void;
-    }
-
-    /**
-     * Options for configuring a RedWeb server.
-     */
+  
     export interface RedWebOptions {
-        port?: number;
-        bind?: string;
-        publicPaths?: string[];
-        services?: Service[];
-        listenCallback?: () => void;
-        encoding?: RedWebEncoding;
-        ssl?: {
-            key: string;
-            cert: string;
-        };
-        corsOptions?: import('cors').CorsOptions;
-        enableHtmxRendering?: boolean; // New flag to enable HTMX rendering
-    }
-
-    /**
-     * Configuration for a WebSocket handler.
-     */
-    export interface HandlerConfig {
-        name: string;
-        handlers: {
-            [type: string]: (socket: WebSocket, data: any) => void;
-        };
+      port?: number;
+      bind?: string;
+      publicPaths?: string[];
+      services?: Array<{ serviceName: string; method: string; function: Function }>;
+      listenCallback?: () => void;
+      encoding?: RedWebEncoding;
+      ssl?: { key: string; cert: string };
+      server?: Application;
+      corsOptions?: CorsOptions;
+      enableHtmxRendering?: boolean;
     }
-
-    /**
-     * Options for configuring a WebSocket server.
-     */
+  
     export interface SocketServerOptions {
-        port?: number;
-        connectionOpenCallback?: (socket: WebSocket) => void;
-        connectionCloseCallback?: (socket: WebSocket) => void;
-        messageCallback?: (socket: WebSocket, message: string) => void;
-        messageHandlers?: {
-            [type: string]: (socket: WebSocket, data: any) => void;
-        };
-        ssl?: {
-            key: string;
-            cert: string;
-        };
-        routes?: Array<new () => SocketRoute>;
+      server?: HttpServer;
+      port?: number;
+      routes?: Array<new () => SocketRoute>;
+      ssl?: { key: string; cert: string };
     }
-
-    /**
-     * WebSocket route configuration.
-     */
+  
     export interface SocketRouteConfig {
-        path: string;
-        handlers: Array<new () => BaseHandler>;
+      path: string;
+      handlers: Array<new () => BaseHandler>;
+      allowDuplicateConnections?: boolean;
     }
-
-    /**
-     * Represents a WebSocket route.
-     */
-    export class SocketRoute {
-        path: string;
-        handlers: BaseHandler[];
-
-        constructor(config: SocketRouteConfig);
-
-        addHandler(HandlerClass: new () => BaseHandler): void;
-        handleConnection(socket: WebSocket, req: import('http').IncomingMessage): void;
-        handleMessage(socket: WebSocket, data: any): void;
-        handleClose(socket: WebSocket): void;
-        handleError(socket: WebSocket, error: Error): void;
-    }
-
-    /**
-     * Base class for WebSocket handlers.
-     */
+  
     export class BaseHandler {
-        name: string;
-
-        constructor(name: string);
-        onMessage(socket: WebSocket, message: Object): void;
-        onInitialContact(socket: WebSocket): void;
-        onClose(socket: WebSocket): void;
+      name: string;
+      constructor(name: string);
+      handleMessage(
+        socket: WebSocket & {
+          sendJson: (message: object) => void;
+          broadcast: (message: object) => void;
+        },
+        message: any
+      ): void;
+      onMessage(socket: WebSocket, message: any): void;
+      onInitialContact(socket: WebSocket): void;
     }
-
-    /**
-     * Base WebSocket server class.
-     */
-    export class BaseSocketServer {
-        routes: SocketRoute[];
-
-        constructor(server: HTTPServer | HTTPSServer, options?: SocketServerOptions);
-        handleUpgrade(req: import('http').IncomingMessage, socket: import('net').Socket, head: Buffer): void;
-        addRoute(route: new () => SocketRoute): void;
-    }
-
-    /**
-     * HTTP server class.
-     */
-    export class HttpServer {
-        constructor(options?: RedWebOptions);
+  
+    export class SocketRoute {
+      path: string;
+      handlers: BaseHandler[];
+      clients: Map<string, WebSocket>;
+      allowDuplicateConnections?: boolean;
+      constructor(config: SocketRouteConfig);
+      addHandler(handler: new () => BaseHandler): void;
+      handleMessage(sock: WebSocket, data: any): void;
     }
-
-    /**
-     * HTTPS server class.
-     */
-    export class HttpsServer {
-        constructor(options?: RedWebOptions);
+  
+    export class BaseSocketServer {
+      clients: Map<string, WebSocket>;
+      server: HttpServer;
+      routes: SocketRoute[];
+      constructor(server: HttpServer, options?: SocketServerOptions);
+      addRoute(route: new () => SocketRoute): void;
     }
-
-    /**
-     * WebSocket server class.
-     */
+  
     export class SocketServer extends BaseSocketServer {
-        constructor(options?: SocketServerOptions);
+      constructor(options?: SocketServerOptions);
     }
-
-    /**
-     * Secure WebSocket server class.
-     */
+  
     export class SecureSocketServer extends BaseSocketServer {
-        constructor(options?: SocketServerOptions);
+      constructor(options?: SocketServerOptions);
     }
-
-    /**
-     * SSL configuration loader.
-     */
-    export function loadSslConfig(sslOptions: { key: string; cert: string }): { key: string; cert: string };
-
-    /**
-     * Constants for encoding types.
-     */
-    export const ENCODINGS: {
-        json: 'json';
-        urlencoded: 'urlencoded';
-    };
-
-    /**
-     * Constants for HTTP methods.
-     */
+  
+    export class HttpServer {
+      constructor(options?: RedWebOptions);
+    }
+  
+    export class HttpsServer {
+      constructor(options?: RedWebOptions);
+    }
+  
     export const METHODS: {
-        POST: 'post';
-        GET: 'get';
-        PUT: 'put';
-        DELETE: 'delete';
-        PATCH: 'patch';
-        OPTIONS: 'options';
-        HEAD: 'head';
+      GET: 'get';
+      POST: 'post';
+      PUT: 'put';
+      DELETE: 'delete';
+    };
+  
+    export const ENCODINGS: {
+      json: 'json';
+      urlencoded: 'urlencoded';
     };
-
-    /**
-     * Default HTTP options.
-     */
+  
     export const HTTP_OPTIONS: RedWebOptions;
-
-    /**
-     * Default socket options.
-     */
     export const SOCKET_OPTIONS: SocketServerOptions;
-}
+  }
+  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redweb",
-  "version": "0.6.9",
+  "version": "0.7.0",
   "description": "A way to quickly set up an express server",
   "main": "index.js",
   "scripts": {

package/src/ws/BaseHandler.js

@@ -16,7 +16,7 @@ class BaseHandler {
     /**
      * Handles an incoming message and routes it to the appropriate handler function.
      * @param {WebSocket & {sendJson: (message: Object) => void, broadcast: (message: Object) => void}} socket - The WebSocket connection that sent the message.
-     * @param {string} message - The incoming message in JSON string format.
+     * @param {any} message - The incoming message in parsed JSON.
      */
     handleMessage(socket, message) {
         this.onMessage(socket, message);
@@ -25,7 +25,7 @@ class BaseHandler {
     /**
      * Method to be overriden to process messages.
      * @param {WebSocket} socket - The WebSocket connection that sent the message.
-     * @param {string} message - The incoming message in JSON string format.
+     * @param {any} message - The incoming message in parsed JSON.
      */
     onMessage(socket, message) {
         throw "Not yet implemented!";

package/src/ws/SocketRoute.js

@@ -1,5 +1,6 @@
 const { WebSocketServer } = require("ws");
 const { sendJson, broadcast } = require("./util");
+const { randomUUID } = require("crypto");
 
 /**
  * Represents a WebSocket route configuration.
@@ -10,9 +11,10 @@ class SocketRoute {
      * Creates a new instance of `SocketRoute`.
      * @param {Object} options - Configuration options for the WebSocket route.
      * @param {string} options.path - The path of the WebSocket route (e.g., `/chat`, `/lobby`).
+     * @param {boolean} options.allowDuplicateConnections - Whether to allow multiple connections from the same client IP address.
      * @param {import('./BaseHandler').BaseHandler[]} options.handlers - An array of handler instances that manage connections and messages for this route.
      */
-    constructor({path, handlers } = {}) {
+    constructor({path, handlers, allowDuplicateConnections } = {}) {
         if (!path) {
             throw new Error('A `path` must be specified for the SocketRoute.');
         }
@@ -34,6 +36,7 @@ class SocketRoute {
         this.clients = new Map();
         this.server = new WebSocketServer({ noServer: true, path });
         this.server.on('connection', this.handleConnection.bind(this));
+        this.allowDuplicateConnections = allowDuplicateConnections;
     }
     /**
      * Adds a new handler to the WebSocket server.
@@ -56,23 +59,37 @@ class SocketRoute {
     handleConnection(socket, req) {
         const ip = req.socket.remoteAddress;
         console.log(`New client connected: ${ip}`);
-        if (this.clients.get(ip) !== undefined) {
-            const oldClient = this.clients.get(ip);
-            console.warn(`Client ${ip} already connected, disconnecting existing connection.`);
-            oldClient.send(
-                JSON.stringify({ msg: 'You are being disconnected because a new client is connected with your IP address.' })
-            );
-            oldClient.close();
+        if (this.allowDuplicateConnections) {
+            this.clients.set(randomUUID(), socket);
+        } else {
+            if (this.clients.get(ip) !== undefined) {
+                const oldClient = this.clients.get(ip);
+                console.warn(`Client ${ip} already connected, disconnecting existing connection.`);
+                oldClient.send(
+                    JSON.stringify({ msg: 'You are being disconnected because a new client is connected with your IP address.' })
+                );
+                oldClient.close();
+            }
+            this.clients.set(ip, socket);
         }
-        this.clients.set(ip, socket);
         socket.isAssigned = false; // Tracks whether the socket has been assigned a handler.
         socket.sendJson = (data) => sendJson(socket, data);
-        socket.broadcast = (data) => broadcast([...this.clients.values()], data);
+        socket.broadcast = (data) => broadcast([...this.clients.values()].filter(sock => sock !== socket), data);
 
         this.connectionOpenCallback(socket);
-        socket.on('message', (message) => this.handleMessage(socket, JSON.parse(message)));
         socket.on('close', this.handleClose.bind(this));
         socket.on('error', this.handleError.bind(this));
+        socket.on('message', (message) => {
+            try {
+                const parsed = JSON.parse(message);
+                this.handleMessage(socket, parsed);
+            } catch (error) {
+                console.error(`Error parsing message from ${ip}:`, error);
+                socket.sendJson({ error: 'Invalid JSON format' });
+                socket.close();
+                return;
+            }
+        });
     }
 
     connectionOpenCallback(socket) {
@@ -85,7 +102,13 @@ class SocketRoute {
             sendJson(sock, {error: `No such handler ${data.type}`});
             sock.close();
         } else {
-            handler.handleMessage(sock, data);
+            try {
+                handler.handleMessage(sock, data);
+            } catch (error) {
+                console.error(`Error handling message in handler ${handler.name}:`, error);
+                sendJson(sock, { error: `${error.message}` });
+                sock.close();
+            }
         }
     }