playsocketjs 2.4.1 → 2.5.0

package/README.md

@@ -96,7 +96,7 @@ new PlaySocket(id?: string, options: PlaySocketOptions)
 ### Methods
 
 - `init()`: Initialize the WebSocket connection – Returns Promise (async) which resolves with the client's ID
-- `createRoom(initialStorage?: object, maxSize?: number)`: Create a new room and become host – Returns Promise (async) which resolves with the room ID (matches the creator's ID). The absolute client maximum is 100
+- `createRoom(initialStorage?: object, maxSize?: number)`: Create a new room and become host – Returns Promise (async) which resolves with the room ID. The room participant maximum is 100
 - `joinRoom(hostId: string)`: Join an existing room – Returns Promise (async)
 - `destroy()`: Use this to leave a room and close the connection
 - `updateStorage(key: string, type: 'set' | 'array-add' | 'array-add-unique' | 'array-remove-matching' | 'array-update-matching', value: any, updateValue?: any)`: Update the shared storage (max. 100 keys). Safely update arrays in storage by adding, removing, or updating items. UpdateValue is only required for the 'array-update-matching' operation type
@@ -203,6 +203,7 @@ Creates a new PlaySocket Server instance with configuration options.
 - `port`: Port to listen on (default: 3000, used only if no server provided)
 - `path`: WebSocket endpoint path (default: '/')
 - `server`: Existing http server (optional)
+- `rateLimit`: Adjust the messages/second rate limit (defaults to 20)
 - `debug`: Set this property to true to enable extra logging
 
 ### Methods

package/dist/playsocket-client.js

@@ -2301,10 +2301,10 @@ class PlaySocket {
                     case 'room_created':
                         if (this.#pendingCreate) {
                             this.#inRoom = true;
-                            this.#triggerEvent("status", `Room created${this.#pendingCreate.maxSize ? ` with max size ${this.#pendingCreate.maxSize}.` : '.'}`);
+                            this.#triggerEvent("status", `Room created with max. size ${message.size}.`);
                             this.#crdtManager.importState(message.state);
                             this.#triggerEvent("storageUpdated", this.getStorage);
-                            this.#pendingCreate.resolve(this.#pendingCreate.id);
+                            this.#pendingCreate.resolve(message.roomId);
                         }
                         break;
 
@@ -2456,7 +2456,7 @@ class PlaySocket {
         return Promise.race([
             new Promise((resolve, reject) => {
                 this.#roomHost = this.#id;
-                this.#pendingCreate = { maxSize, id: this.#id, resolve, reject };
+                this.#pendingCreate = { resolve, reject };
                 this.#sendToServer({
                     type: 'create_room',
                     initialStorage,

package/dist/playsocket-server.js

@@ -2213,6 +2213,7 @@ function requireServer () {
 	class PlaySocketServer {
 	    #server;
 	    #ownsServer = false;
+	    #rateLimitMaxPoints;
 	    #wss;
 	    #clients = new Map(); // ClientId -> WebSocket instance
 	    #rooms = {};
@@ -2235,10 +2236,12 @@ function requireServer () {
 	     * @param {string} [options.path='/socket'] - WebSocket endpoint path
 	     */
 	    constructor(options = {}) {
-	        const { server, port = 3000, path = '/', debug = false } = options;
+	        const { server, port = 3000, path = '/', debug = false, rateLimit = 20 } = options;
 
 	        if (debug) this.#debug = true; // Enable extra logging
 
+	        this.#rateLimitMaxPoints = rateLimit; // Set rate limit
+
 	        // Handle server creation / usage
 	        if (server) {
 	            this.#server = server; // Use provided HTTP server
@@ -2311,10 +2314,8 @@ function requireServer () {
 
 	                    // Generate client ID if none provided
 	                    if (!data.id) {
-	                        const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789';
-	                        const maxAttempts = 50;
-	                        for (let i = 0; i < maxAttempts; i++) {
-	                            const id = Array.from({ length: 6 }, () => chars[Math.floor(Math.random() * chars.length)]).join('');
+	                        for (let i = 0; i < 50; i++) {
+	                            const id = this.#generateId();
 	                            if (!this.#clients.get(id)) {
 	                                data.id = id;
 	                                break;
@@ -2384,16 +2385,31 @@ function requireServer () {
 
 	                case 'create_room':
 	                    if (!ws.clientId) return;
-	                    const newRoomId = ws.clientId;
 
-	                    if (this.#clientRooms.get(ws.clientId) || this.#rooms[newRoomId]) {
+	                    let newRoomId;
+
+	                    if (this.#clientRooms.get(ws.clientId)) {
 	                        ws.send(encode({
 	                            type: 'room_creation_failed',
-	                            reason: this.#clientRooms.get(ws.clientId) ? 'Already in a room.' : 'Room ID is taken.'
+	                            reason: 'Already in a room.'
 	                        }), { binary: true });
 	                        return;
 	                    }
 
+	                    // Generate room ID
+	                    for (let i = 0; i < 50; i++) {
+	                        const id = this.#generateId();
+	                        if (!this.#rooms[id]) {
+	                            newRoomId = id;
+	                            break;
+	                        }
+	                    }
+
+	                    if (!newRoomId) {
+	                        ws.send(encode({ type: 'room_creation_failed', reason: 'No available ID found.' }), { binary: true });
+	                        throw new Error('Failed to generate unique room ID!');
+	                    }
+
 	                    const roomCrdtManager = new CRDTManager(this.#debug); // Create the room's crdt manager
 
 	                    // Event callback with potential initial storage modifications
@@ -2421,18 +2437,19 @@ function requireServer () {
 	                    }
 
 	                    // Create room
+	                    const maxSize = Math.min(Number(data.size), 100) || 100; // Max. limit is 100 clients / room
 	                    this.#roomVersions.set(newRoomId, 0); // Start with version 0
 	                    this.#rooms[newRoomId] = {
 	                        participants: [ws.clientId],
 	                        host: ws.clientId,
-	                        maxSize: Math.min(Number(data.size), 100) || 100, // Max. limit is 100 clients / room
+	                        maxSize,
 	                        crdtManager: roomCrdtManager
 	                    };
 	                    this.#clientRooms.set(ws.clientId, newRoomId); // Add client to the room
 
-	                    ws.send(encode({ type: 'room_created', state: roomCrdtManager.getState }), { binary: true });
+	                    ws.send(encode({ type: 'room_created', state: roomCrdtManager.getState, roomId: newRoomId, size: maxSize }), { binary: true });
 	                    this.#triggerEvent("roomCreated", newRoomId);
-	                    if (this.#debug) console.log("Room created with initial storage:", data.initialStorage);
+	                    if (this.#debug) console.log(`Room ${newRoomId} created with initial storage:`, data.initialStorage);
 	                    break;
 
 	                case 'join_room':
@@ -2518,6 +2535,7 @@ function requireServer () {
 	                    break;
 
 	                case 'request':
+	                    if (!ws.clientId) return;
 	                    const requestorRoomId = this.#clientRooms.get(ws.clientId) || null;
 	                    this.#triggerEvent("requestReceived", { roomId: requestorRoomId, clientId: ws.clientId, name: data.request.name, data: data.request.data });
 	                    break;
@@ -2532,6 +2550,14 @@ function requireServer () {
 	        }
 	    }
 
+	    /**
+	     * Generate a readable, 6 digit ID
+	     */
+	    #generateId() {
+	        const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789';
+	        return Array.from({ length: 6 }, () => chars[Math.floor(Math.random() * chars.length)]).join('');
+	    }
+
 	    /**
 	     * If the client that disconnected (and is now in the reconnection-phase) was the room host,
 	     * pick a new room host immediately to avoid host-less phase (in case important logic is attached to the host)
@@ -2570,11 +2596,10 @@ function requireServer () {
 	     * @private
 	     */
 	    #checkRateLimit(connectionId, operationType) {
-	        const MAX_POINTS = 20;
 	        const now = Date.now();
 
 	        if (!this.#rateLimits.has(connectionId)) {
-	            this.#rateLimits.set(connectionId, { points: MAX_POINTS, lastReset: now });
+	            this.#rateLimits.set(connectionId, { points: this.#rateLimitMaxPoints, lastReset: now });
 	            return true;
 	        }
 
@@ -2582,7 +2607,7 @@ function requireServer () {
 
 	        // Reset points if interval has passed (1s)
 	        if (now - limit.lastReset > 1000) {
-	            limit.points = MAX_POINTS;
+	            limit.points = this.#rateLimitMaxPoints;
 	            limit.lastReset = now;
 	        }
 
@@ -2737,6 +2762,7 @@ function requireServer () {
 	                    }), { binary: true });
 	                }
 	            });
+	            this.#triggerEvent("storageUpdated", { roomId, clientId: null, update: structuredClone(propertyUpdate), storage: this.getRoomStorage(roomId) });
 	        }
 	    }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playsocketjs",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "WebSocket wrapper for creating simple multiplayer systems with ease.",
   "module": "dist/playsocket-client.js",
   "exports": {