playsocketjs 4.3.2 → 5.0.0

package/README.md

@@ -305,7 +305,7 @@ The callback signature is `callback(verified, code?, message?)` where `code` ref
 #### Methods
 
 > [!IMPORTANT]
-> Rooms created by the server default to host ID "server". If that host string is used, the room will not be auto-deleted when all participants have left and you need to take care of its lifecycle.
+> Rooms created by the server are always owned by the host ID "server". Such rooms are not auto-deleted when all participants have left, so you need to take care of their lifecycle.
 
 | Name | Parameters | Return type | Description |
 |--------|------------|-------------|-------------|
@@ -316,7 +316,7 @@ The callback signature is `callback(verified, code?, message?)` where `code` ref
 | `getRoomStorage()` | `roomId: string` | `object` | Get a snapshot of the current room storage. |
 | `getUpdateDetails()` | `update: object` | `object` | Get the details (`key`, `type`, `value` and `secondValue`) of a storage update for building validation logic. |
 | `updateRoomStorage()` | `roomId: string, key: string, type: string, value: any, secondValue?: any` | `void` | Update a key in the shared storage of a room. |
-| `createRoom()` | `initialStorage?: object, size?: number, host?: string` | `object` | Create a room (returns object containing room ID and state).|
+| `createRoom()` | `initialStorage?: object, size?: number` | `object` | Create a server-owned room (returns object containing room ID and state).|
 | `destroyRoom()` | `roomId: string` | `void` | Destroy a room & kick all participants. |
 
 #### Events

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playsocketjs",
-  "version": "4.3.2",
+  "version": "5.0.0",
   "description": "WebSocket wrapper for creating simple multiplayer systems with ease.",
   "type": "module",
   "module": "./src/client/client.js",

package/src/server/server.js

@@ -258,7 +258,7 @@ export default class PlaySocketServer {
                             return;
                         }
 
-                        const newRoom = this.createRoom(data.initialStorage, data.size, ws.clientId); // Create room
+                        const newRoom = this.#createRoom(ws.clientId, data.initialStorage, data.size); // Create room
 
                         this.#rooms[newRoom.id].participants.push(ws.clientId) // Add client to the room
                         this.#clientRooms.set(ws.clientId, newRoom.id); // Add client to the client-room map
@@ -604,14 +604,24 @@ export default class PlaySocketServer {
         }
     }
 
+    /**
+     * Create a server-owned room 
+     * @param {object} [initialStorage] - Optional initial storage object
+     * @param {number} [size] - Max. room size, up to 500
+     * @returns {{ state: CRDTState, id: string }} Object containing room state and room ID
+     */
+    createRoom(initialStorage, size) {
+        return this.#createRoom("server", initialStorage, size);
+    }
+
     /**
      * Create a room
+     * @param {string} host - Host ID (when set to "server", room will not be deleted if all clients leave)
      * @param {object} [initialStorage] - Optional initial storage object
      * @param {number} [size] - Max. room size, up to 500
-     * @param {string} [host] - Host ID, defaults to "server" (when set to "server", room will not be deleted if all clients leave)
      * @returns {{ state: CRDTState, id: string }} Object containing room state and room ID
      */
-    createRoom(initialStorage, size, host = "server") {
+    #createRoom(host, initialStorage, size) {
         let newRoomId;
 
         for (let i = 0; i < 100; i++) {

package/src/universal/constants.js

@@ -9,7 +9,7 @@ export const HEARTBEAT_INTERVAL = 5000;
 /**
  * Library version, must match package.json
  */
-export const VERSION = "4.3.2";
+export const VERSION = "5.0.0";
 
 /**
  * Logging prefixes

package/types/server/server.d.ts

@@ -120,13 +120,12 @@ export default class PlaySocketServer {
      */
     updateRoomStorage(roomId: string, key: string, type: PropertyUpdateType, value: any, secondValue?: any): void;
     /**
-     * Create a room
+     * Create a server-owned room
      * @param {object} [initialStorage] - Optional initial storage object
      * @param {number} [size] - Max. room size, up to 500
-     * @param {string} [host] - Host ID, defaults to "server" (when set to "server", room will not be deleted if all clients leave)
      * @returns {{ state: CRDTState, id: string }} Object containing room state and room ID
      */
-    createRoom(initialStorage?: object, size?: number, host?: string): {
+    createRoom(initialStorage?: object, size?: number): {
         state: CRDTState;
         id: string;
     };

package/types/universal/constants.d.ts

@@ -8,7 +8,7 @@ export declare const HEARTBEAT_INTERVAL = 5000;
 /**
  * Library version, must match package.json
  */
-export declare const VERSION = "4.3.2";
+export declare const VERSION = "5.0.0";
 /**
  * Logging prefixes
  */