@zero-server/sdk 0.9.0 → 0.9.2

package/lib/ws/room.js

@@ -1,223 +1,223 @@
-/**
- * @module ws/room
- * @description WebSocket room/channel manager.
- *              Provides broadcast, room-based messaging, and connection
- *              registry for WebSocket connections.
- */
-
-/**
- * Manages a pool of WebSocket connections with room-based grouping.
- *
- * @example
- *   const pool = new WebSocketPool();
- *   app.ws('/chat', (ws, req) => {
- *       pool.add(ws);
- *       pool.join(ws, 'general');
- *       ws.on('message', msg => pool.toRoom('general', msg));
- *       ws.on('close', () => pool.remove(ws));
- *   });
- */
-class WebSocketPool
-{
-    /** @constructor */
-    constructor()
-    {
-        /** @type {Set<import('./connection')>} All active connections. */
-        this._connections = new Set();
-        /** @type {Map<string, Set<import('./connection')>>} Room → connection sets. */
-        this._rooms = new Map();
-    }
-
-    /**
-     * Add a connection to the pool.
-     * @param {import('./connection')} ws - WebSocket connection.
-     * @returns {WebSocketPool} this
-     */
-    add(ws)
-    {
-        this._connections.add(ws);
-
-        // Auto-remove on close
-        ws.once('close', () => this.remove(ws));
-
-        return this;
-    }
-
-    /**
-     * Remove a connection from the pool and all rooms.
-     * @param {import('./connection')} ws - WebSocket connection.
-     * @returns {WebSocketPool} this
-     */
-    remove(ws)
-    {
-        this._connections.delete(ws);
-        for (const [room, members] of this._rooms)
-        {
-            members.delete(ws);
-            if (members.size === 0) this._rooms.delete(room);
-        }
-        return this;
-    }
-
-    /**
-     * Join a connection to a room.
-     * @param {import('./connection')} ws - WebSocket connection.
-     * @param {string} room - Room name.
-     * @returns {WebSocketPool} this
-     */
-    join(ws, room)
-    {
-        if (!this._rooms.has(room)) this._rooms.set(room, new Set());
-        this._rooms.get(room).add(ws);
-        return this;
-    }
-
-    /**
-     * Remove a connection from a room.
-     * @param {import('./connection')} ws - WebSocket connection.
-     * @param {string} room - Room name.
-     * @returns {WebSocketPool} this
-     */
-    leave(ws, room)
-    {
-        const members = this._rooms.get(room);
-        if (members)
-        {
-            members.delete(ws);
-            if (members.size === 0) this._rooms.delete(room);
-        }
-        return this;
-    }
-
-    /**
-     * Get all rooms a connection belongs to.
-     * @param {import('./connection')} ws - WebSocket connection.
-     * @returns {string[]} Room names the connection belongs to.
-     */
-    roomsOf(ws)
-    {
-        const result = [];
-        for (const [room, members] of this._rooms)
-        {
-            if (members.has(ws)) result.push(room);
-        }
-        return result;
-    }
-
-    /**
-     * Broadcast a message to ALL connected clients.
-     * @param {string|Buffer} data   - Payload.
-     * @param {import('./connection')} [exclude] - Optional connection to exclude (e.g. the sender).
-     */
-    broadcast(data, exclude)
-    {
-        for (const ws of this._connections)
-        {
-            if (ws !== exclude && ws.readyState === 1) ws.send(data);
-        }
-    }
-
-    /**
-     * Broadcast a JSON message to ALL connected clients.
-     * @param {*} obj - Value to serialise.
-     * @param {import('./connection')} [exclude] - Connection(s) to exclude.
-     */
-    broadcastJSON(obj, exclude)
-    {
-        const msg = JSON.stringify(obj);
-        this.broadcast(msg, exclude);
-    }
-
-    /**
-     * Send a message to all connections in a specific room.
-     * @param {string} room          - Room name.
-     * @param {string|Buffer} data   - Payload.
-     * @param {import('./connection')} [exclude] - Connection(s) to exclude.
-     */
-    toRoom(room, data, exclude)
-    {
-        const members = this._rooms.get(room);
-        if (!members) return;
-        for (const ws of members)
-        {
-            if (ws !== exclude && ws.readyState === 1) ws.send(data);
-        }
-    }
-
-    /**
-     * Send a JSON message to all connections in a specific room.
-     * @param {string} room - Room name.
-     * @param {*}      obj - Data object to send.
-     * @param {import('./connection')} [exclude] - Connection(s) to exclude.
-     */
-    toRoomJSON(room, obj, exclude)
-    {
-        this.toRoom(room, JSON.stringify(obj), exclude);
-    }
-
-    /**
-     * Get all connections in a room.
-     * @param {string} room - Room name.
-     * @returns {import('./connection')[]} Connections in the room (empty array if the room does not exist).
-     */
-    in(room)
-    {
-        const members = this._rooms.get(room);
-        return members ? Array.from(members) : [];
-    }
-
-    /**
-     * Total number of active connections.
-     * @type {number}
-     */
-    get size()
-    {
-        return this._connections.size;
-    }
-
-    /**
-     * Number of connections in a specific room.
-     * @param {string} room - Room name.
-     * @returns {number} Number of connections in the room.
-     */
-    roomSize(room)
-    {
-        const members = this._rooms.get(room);
-        return members ? members.size : 0;
-    }
-
-    /**
-     * List all active room names.
-     * @returns {string[]} Array of room names.
-     */
-    get rooms()
-    {
-        return Array.from(this._rooms.keys());
-    }
-
-    /**
-     * Get all active connections.
-     * @returns {import('./connection')[]} Array of connections in the pool.
-     */
-    get clients()
-    {
-        return Array.from(this._connections);
-    }
-
-    /**
-     * Close all connections gracefully.
-     * @param {number} [code=1001] - Close code.
-     * @param {string} [reason]    - Close reason.
-     */
-    closeAll(code = 1001, reason = 'Server shutdown')
-    {
-        for (const ws of this._connections)
-        {
-            ws.close(code, reason);
-        }
-        this._connections.clear();
-        this._rooms.clear();
-    }
-}
-
-module.exports = WebSocketPool;
+/**
+ * @module ws/room
+ * @description WebSocket room/channel manager.
+ *              Provides broadcast, room-based messaging, and connection
+ *              registry for WebSocket connections.
+ */
+
+/**
+ * Manages a pool of WebSocket connections with room-based grouping.
+ *
+ * @example
+ *   const pool = new WebSocketPool();
+ *   app.ws('/chat', (ws, req) => {
+ *       pool.add(ws);
+ *       pool.join(ws, 'general');
+ *       ws.on('message', msg => pool.toRoom('general', msg));
+ *       ws.on('close', () => pool.remove(ws));
+ *   });
+ */
+class WebSocketPool
+{
+    /** @constructor */
+    constructor()
+    {
+        /** @type {Set<import('./connection')>} All active connections. */
+        this._connections = new Set();
+        /** @type {Map<string, Set<import('./connection')>>} Room → connection sets. */
+        this._rooms = new Map();
+    }
+
+    /**
+     * Add a connection to the pool.
+     * @param {import('./connection')} ws - WebSocket connection.
+     * @returns {WebSocketPool} this
+     */
+    add(ws)
+    {
+        this._connections.add(ws);
+
+        // Auto-remove on close
+        ws.once('close', () => this.remove(ws));
+
+        return this;
+    }
+
+    /**
+     * Remove a connection from the pool and all rooms.
+     * @param {import('./connection')} ws - WebSocket connection.
+     * @returns {WebSocketPool} this
+     */
+    remove(ws)
+    {
+        this._connections.delete(ws);
+        for (const [room, members] of this._rooms)
+        {
+            members.delete(ws);
+            if (members.size === 0) this._rooms.delete(room);
+        }
+        return this;
+    }
+
+    /**
+     * Join a connection to a room.
+     * @param {import('./connection')} ws - WebSocket connection.
+     * @param {string} room - Room name.
+     * @returns {WebSocketPool} this
+     */
+    join(ws, room)
+    {
+        if (!this._rooms.has(room)) this._rooms.set(room, new Set());
+        this._rooms.get(room).add(ws);
+        return this;
+    }
+
+    /**
+     * Remove a connection from a room.
+     * @param {import('./connection')} ws - WebSocket connection.
+     * @param {string} room - Room name.
+     * @returns {WebSocketPool} this
+     */
+    leave(ws, room)
+    {
+        const members = this._rooms.get(room);
+        if (members)
+        {
+            members.delete(ws);
+            if (members.size === 0) this._rooms.delete(room);
+        }
+        return this;
+    }
+
+    /**
+     * Get all rooms a connection belongs to.
+     * @param {import('./connection')} ws - WebSocket connection.
+     * @returns {string[]} Room names the connection belongs to.
+     */
+    roomsOf(ws)
+    {
+        const result = [];
+        for (const [room, members] of this._rooms)
+        {
+            if (members.has(ws)) result.push(room);
+        }
+        return result;
+    }
+
+    /**
+     * Broadcast a message to ALL connected clients.
+     * @param {string|Buffer} data   - Payload.
+     * @param {import('./connection')} [exclude] - Optional connection to exclude (e.g. the sender).
+     */
+    broadcast(data, exclude)
+    {
+        for (const ws of this._connections)
+        {
+            if (ws !== exclude && ws.readyState === 1) ws.send(data);
+        }
+    }
+
+    /**
+     * Broadcast a JSON message to ALL connected clients.
+     * @param {*} obj - Value to serialise.
+     * @param {import('./connection')} [exclude] - Connection(s) to exclude.
+     */
+    broadcastJSON(obj, exclude)
+    {
+        const msg = JSON.stringify(obj);
+        this.broadcast(msg, exclude);
+    }
+
+    /**
+     * Send a message to all connections in a specific room.
+     * @param {string} room          - Room name.
+     * @param {string|Buffer} data   - Payload.
+     * @param {import('./connection')} [exclude] - Connection(s) to exclude.
+     */
+    toRoom(room, data, exclude)
+    {
+        const members = this._rooms.get(room);
+        if (!members) return;
+        for (const ws of members)
+        {
+            if (ws !== exclude && ws.readyState === 1) ws.send(data);
+        }
+    }
+
+    /**
+     * Send a JSON message to all connections in a specific room.
+     * @param {string} room - Room name.
+     * @param {*}      obj - Data object to send.
+     * @param {import('./connection')} [exclude] - Connection(s) to exclude.
+     */
+    toRoomJSON(room, obj, exclude)
+    {
+        this.toRoom(room, JSON.stringify(obj), exclude);
+    }
+
+    /**
+     * Get all connections in a room.
+     * @param {string} room - Room name.
+     * @returns {import('./connection')[]} Connections in the room (empty array if the room does not exist).
+     */
+    in(room)
+    {
+        const members = this._rooms.get(room);
+        return members ? Array.from(members) : [];
+    }
+
+    /**
+     * Total number of active connections.
+     * @type {number}
+     */
+    get size()
+    {
+        return this._connections.size;
+    }
+
+    /**
+     * Number of connections in a specific room.
+     * @param {string} room - Room name.
+     * @returns {number} Number of connections in the room.
+     */
+    roomSize(room)
+    {
+        const members = this._rooms.get(room);
+        return members ? members.size : 0;
+    }
+
+    /**
+     * List all active room names.
+     * @returns {string[]} Array of room names.
+     */
+    get rooms()
+    {
+        return Array.from(this._rooms.keys());
+    }
+
+    /**
+     * Get all active connections.
+     * @returns {import('./connection')[]} Array of connections in the pool.
+     */
+    get clients()
+    {
+        return Array.from(this._connections);
+    }
+
+    /**
+     * Close all connections gracefully.
+     * @param {number} [code=1001] - Close code.
+     * @param {string} [reason]    - Close reason.
+     */
+    closeAll(code = 1001, reason = 'Server shutdown')
+    {
+        for (const ws of this._connections)
+        {
+            ws.close(code, reason);
+        }
+        this._connections.clear();
+        this._rooms.clear();
+    }
+}
+
+module.exports = WebSocketPool;

package/package.json

@@ -1,73 +1,73 @@
-{
-  "name": "@zero-server/sdk",
-  "version": "0.9.0",
-  "description": "Zero-dependency backend framework for Node.js — routing, ORM, auth, WebSocket, SSE, gRPC, observability, and 20+ middleware. Distributed as a single SDK and as scoped @zero-server/* packages.",
-  "main": "index.js",
-  "bin": {
-    "zh": "lib/cli.js",
-    "zs": "lib/cli.js"
-  },
-  "types": "types/index.d.ts",
-  "files": [
-    "lib",
-    "types",
-    "index.js",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "start": "node documentation/full-server.js",
-    "docs": "node documentation/full-server.js",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage",
-    "build": "node .tools/build.js",
-    "build:api": "node .tools/build-api-md.js",
-    "packages:generate": "node .tools/generate-package-stubs.js",
-    "packages:docs": "node .tools/generate-scope-docs.js",
-    "packages:publish": "node .tools/publish-package-stubs.js",
-    "ci": "npm test && npm run build && npm run packages:generate && npm run packages:docs"
-  },
-  "keywords": [
-    "http",
-    "server",
-    "router",
-    "middleware",
-    "fetch",
-    "multipart",
-    "static",
-    "websocket",
-    "sse",
-    "grpc",
-    "orm",
-    "jwt",
-    "oauth",
-    "zero-server",
-    "zero-http"
-  ],
-  "author": "Anthony Wiedman",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/tonywied17/zero-server.git"
-  },
-  "bugs": {
-    "url": "https://github.com/tonywied17/zero-server/issues"
-  },
-  "homepage": "https://z-server.com",
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/",
-    "access": "public"
-  },
-  "devDependencies": {
-    "@vitest/coverage-v8": "^4.1.2",
-    "better-sqlite3": "^12.8.0",
-    "mongodb": "^7.1.1",
-    "mysql2": "^3.20.0",
-    "pg": "^8.20.0",
-    "vitest": "^4.1.2"
-  }
-}
+{
+  "name": "@zero-server/sdk",
+  "version": "0.9.2",
+  "description": "Zero-dependency backend framework for Node.js — routing, ORM, auth, WebSocket, SSE, gRPC, observability, and 20+ middleware. Distributed as a single SDK and as scoped @zero-server/* packages.",
+  "main": "index.js",
+  "bin": {
+    "zh": "lib/cli.js",
+    "zs": "lib/cli.js"
+  },
+  "types": "types/index.d.ts",
+  "files": [
+    "lib",
+    "types",
+    "index.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "start": "node website-docs/full-server.js",
+    "docs": "node website-docs/full-server.js",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "build": "node .tools/build.js",
+    "build:api": "node .tools/build-api-md.js",
+    "packages:generate": "node .tools/generate-package-stubs.js",
+    "packages:docs": "node .tools/generate-scope-docs.js",
+    "packages:publish": "node .tools/publish-package-stubs.js",
+    "ci": "npm test && npm run build && npm run packages:generate && npm run packages:docs"
+  },
+  "keywords": [
+    "http",
+    "server",
+    "router",
+    "middleware",
+    "fetch",
+    "multipart",
+    "static",
+    "websocket",
+    "sse",
+    "grpc",
+    "orm",
+    "jwt",
+    "oauth",
+    "zero-server",
+    "zero-server"
+  ],
+  "author": "Anthony Wiedman",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tonywied17/zero-server.git"
+  },
+  "bugs": {
+    "url": "https://github.com/tonywied17/zero-server/issues"
+  },
+  "homepage": "https://z-server.dev",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.2",
+    "better-sqlite3": "^12.8.0",
+    "mongodb": "^7.1.1",
+    "mysql2": "^3.20.0",
+    "pg": "^8.20.0",
+    "vitest": "^4.1.2"
+  }
+}