playsocketjs 2.2.2 → 2.4.0

package/README.md

@@ -219,9 +219,11 @@ Creates a new PlaySocket Server instance with configuration options.
 - `clientRegistrationRequested`: Client requests to register (returns the client's ID `string`, customData `object`) – return `false` or a rejection reason `string` to block the registration
 - `clientDisconnected`: Client disconnected from the server (returns the client's ID `string`)
 - `clientJoinedRoom`: Client joined a room – note that clients can only leave by disconnecting (returns the client's ID `string`, room ID `string`)
+- `clientJoinRequested`: Client requests to join a room (returns the client's ID `string`, room ID `string`) – return `false` or a rejection reason `string` to block them from joining
 - `roomCreated`: Client created a room (returns room ID `string`)
 - `roomDestroyed`: Room was destroyed, this happens when all participants leave (returns room ID `string`)
 - `roomCreationRequested`: Room creation requested by client (returns `object` containing the client's ID `string`, room ID `string` and the initialStorage `object`) – if you return an `object` in the callback, it will take that as the initial storage instead. If you return `false`, the creation will be denied
+- `storageUpdated`: Room storage property updated (returns `object` containing the ID of the client who requested the update `string`, room ID `string`, the update `object`, and the storage `object`)
 - `storageUpdateRequested`: Room storage property update requested by client (returns `object` containing the client's ID `string`, room ID `string` and the update `object`) – if you return `false` in the callback, the update will be blocked
 - `requestReceived`: Request from client was received by the server (returns `object` containing client's ID `string`, if in room – room ID `string`, request name `string` and optional passed data of type `any`)
 

package/dist/playsocket-client.js

@@ -2505,6 +2505,7 @@ class PlaySocket {
      * @param {*} updateValue - New value for update-matching
      */
     updateStorage(key, type, value, updateValue) {
+        if (!this.#inRoom) return this.#triggerEvent("error", "Cannot update storage when not in a room.");
         if (this.#debug) console.log(LOG_PREFIX + `Property update for key ${key}, operation ${type}, value ${value} and updateValue ${updateValue}.`);
         const propUpdate = this.#crdtManager.updateProperty(key, type, value, updateValue);
         this.#sendToServer({

package/dist/playsocket-server.js

@@ -2351,7 +2351,7 @@ function requireServer () {
 	                        if (data.sessionToken !== this.#clientTokens.get(data.id)) {
 	                            ws.send(encode({
 	                                type: 'reconnection_failed',
-	                                reason: "Session token does not match"
+	                                reason: "Session token does not match."
 	                            }), { binary: true });
 	                            return;
 	                        }
@@ -2378,7 +2378,7 @@ function requireServer () {
 
 	                        ws.send(encode({ type: 'reconnected', roomData }), { binary: true });
 	                    } else {
-	                        ws.send(encode({ type: 'reconnection_failed', reason: "Client unknown to server" }), { binary: true });
+	                        ws.send(encode({ type: 'reconnection_failed', reason: "Client unknown to server." }), { binary: true });
 	                    }
 	                    break;
 
@@ -2389,7 +2389,7 @@ function requireServer () {
 	                    if (this.#clientRooms.get(ws.clientId) || this.#rooms[newRoomId]) {
 	                        ws.send(encode({
 	                            type: 'room_creation_failed',
-	                            reason: this.#clientRooms.get(ws.clientId) ? 'Already in a room' : 'Room ID is taken'
+	                            reason: this.#clientRooms.get(ws.clientId) ? 'Already in a room.' : 'Room ID is taken.'
 	                        }), { binary: true });
 	                        return;
 	                    }
@@ -2440,17 +2440,17 @@ function requireServer () {
 	                    const roomId = data.roomId;
 	                    const room = this.#rooms[roomId];
 
-	                    if (!room ||
-	                        (room.participants.length >= room.maxSize) ||
-	                        this.#clientRooms.get(ws.clientId)) {
-	                        ws.send(encode({
-	                            type: 'join_rejected',
-	                            reason: !room ? 'Room not found' :
-	                                room.participants.length >= room.maxSize ? 'Room full' :
-	                                    'Already in a room'
-	                        }), { binary: true });
-	                        return;
-	                    }
+	                    const rejectJoin = (reason) => {
+	                        ws.send(encode({ type: 'join_rejected', reason }), { binary: true });
+	                    };
+
+	                    // Event callback
+	                    const joinAllowed = await this.#triggerEvent("clientJoinRequested", ws.clientId, roomId);
+	                    if (joinAllowed === false || typeof joinAllowed === 'string') return rejectJoin(typeof joinAllowed === 'string' ? joinAllowed : 'Denied.');
+
+	                    if (!room) return rejectJoin("Room not found.");
+	                    if (this.#clientRooms.get(ws.clientId)) return rejectJoin("Already in a room.");
+	                    if (room.participants.length >= room.maxSize) return rejectJoin("Room full.");
 
 	                    room.participants.push(ws.clientId);
 	                    this.#clientRooms.set(ws.clientId, roomId);
@@ -2500,7 +2500,6 @@ function requireServer () {
 	                        // Increment version for this room
 	                        const currentVersion = this.#roomVersions.get(updateRoomId) + 1;
 	                        this.#roomVersions.set(updateRoomId, currentVersion);
-	                        if (this.#debug) console.log("Property update received and imported:", data.update);
 
 	                        updateRoom.participants?.forEach(p => {
 	                            const client = this.#clients.get(p);
@@ -2512,6 +2511,9 @@ function requireServer () {
 	                                }), { binary: true });
 	                            }
 	                        });
+
+	                        this.#triggerEvent("storageUpdated", { roomId: updateRoomId, clientId: ws.clientId, update: structuredClone(data.update), storage: this.getRoomStorage(updateRoomId) });
+	                        if (this.#debug) console.log("Property update received and imported:", data.update);
 	                    }
 	                    break;
 
@@ -2660,7 +2662,7 @@ function requireServer () {
 	     * @param {Function} callback - Callback function
 	     */
 	    onEvent(event, callback) {
-	        const validEvents = ["clientRegistered", "clientRegistrationRequested", "clientDisconnected", "clientJoinedRoom", "roomCreationRequested", "requestReceived", "roomCreated", "storageUpdateRequested", "roomDestroyed"];
+	        const validEvents = ["clientRegistered", "clientRegistrationRequested", "clientDisconnected", "clientJoinedRoom", "clientJoinRequested", "roomCreated", "roomCreationRequested", "requestReceived", "storageUpdated", "storageUpdateRequested", "roomDestroyed"];
 	        if (!validEvents.includes(event)) return console.warn(`Invalid PlaySocket event type "${event}"`);
 	        if (!this.#callbacks.has(event)) this.#callbacks.set(event, []);
 	        this.#callbacks.get(event).push(callback);

package/package.json

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