playsocketjs 5.1.0 → 5.2.1

package/README.md

@@ -315,7 +315,7 @@ The callback signature is `callback(verified, code?, message?)` where `code` ref
 | `kick()` | `clientId: string, reason?: string` | `void` | Kick a client by their client ID. |
 | `move()` | `clientId: string, roomId: string` | `void` | Move a client that is already in a room to a different room. |
 | `onEvent()` | `event: string, callback: Function` | `() => void` | Register a server-side event callback. Returns unsubscribe function. |
-| `getRoomStorage()` | `roomId: string` | `object` | Get a snapshot of the current room storage. |
+| `getRoomStorage()` | `roomId: string, options?: { dangerouslySkipCloning?: boolean }` | `object` | Get a snapshot of the current room storage. Pass `dangerouslySkipCloning: true` to get the uncloned store for performance reasons. |
 | `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` | `object` | Create a server-owned room (returns object containing room ID and state).|

package/package.json

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

package/src/server/server.js

@@ -576,13 +576,15 @@ export default class PlaySocketServer {
     }
 
     /**
-     * Get snapshot of a room's storage
+     * Get a snapshot of a room's storage
      * @param {string} roomId - ID of the room to get the storage from
+     * @param {object} [options] - Options
+     * @param {boolean} [options.dangerouslySkipCloning=false] - Return uncloned store (faster, but allows illegal mutation)
      * @returns {Record<string, any> | undefined} Storage object or undefined if the room doesn't exist
      */
-    getRoomStorage(roomId) {
+    getRoomStorage(roomId, { dangerouslySkipCloning = false } = {}) {
         const room = this.#rooms[roomId];
-        if (room) return room.crdtManager.propertyStore;
+        if (room) return dangerouslySkipCloning ? room.crdtManager.rawPropertyStore : room.crdtManager.propertyStore;
     }
 
     /**

package/src/universal/constants.js

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

package/src/universal/crdtManager.js

@@ -110,7 +110,7 @@ export default class CRDTManager {
     importPropertyUpdate(update) {
         try {
             const { key, operation: rawOperation, vectorClock } = update;
-            const operation = /** @type {Operation} */ (this.#sanitizeValue(rawOperation));
+            const operation = /** @type {Operation} */ (this.#normalizeAndCopy(rawOperation));
             if (this.#debug) console.log(CONSOLE_PREFIX + "Importing update:", update); // Debug
 
             // Check key limit to safeguard against too many keys
@@ -183,9 +183,9 @@ export default class CRDTManager {
      */
     updateProperty(key, type, value, secondValue) {
         try {
-            // Sanitize inputs
-            value = this.#sanitizeValue(value);
-            secondValue = this.#sanitizeValue(secondValue);
+            // Normalize inputs
+            value = this.#normalizeAndCopy(value);
+            secondValue = this.#normalizeAndCopy(secondValue);
 
             // Debug log
             if (this.#debug) console.log(CONSOLE_PREFIX + `Updating property with key ${key}, type ${type}, value ${value} and secondValue ${secondValue}`);
@@ -366,12 +366,12 @@ export default class CRDTManager {
      */
     #handleOperation(curValue, type, value, secondValue) {
         try {
+            // Set operation (before the structured clone since for set we don't care about curValue anyway)
+            if (type === "set") return value;
+
             // Deep copy to avoid reference issues in case value is or contains object(s)
             curValue = structuredClone(curValue);
 
-            // Set operation
-            if (type === "set") return value;
-
             // Number increment operation
             if (type === "number-increment") {
                 if (!Number.isFinite(curValue)) curValue = 0; // Auto-convert to number if current value isn't a finite number
@@ -431,20 +431,15 @@ export default class CRDTManager {
     }
 
     /**
-     * Remove HTML to prevent XSS and enforce size limits
-     * @param {*} value - Value to sanitize
-     * @returns {*} Sanitized value
+     * Enforce size limit, normalize undefined to null, and return deep copy
+     * @param {*} value - Value to normalize
+     * @returns {*} Normalized value
      */
-    #sanitizeValue(value) {
-        if (value === undefined) return null; // Normalize undefined to null to avoid divergence in transport
-
-        // Check total serialized size
-        const jsonString = JSON.stringify(value);
-        if (jsonString?.length > 50000) throw new Error("Value too large"); // 50KB limit
-
-        if (typeof value === "string") return (value.includes("<") || value.includes(">")) ? value.replace(/[<>]/g, "") : value;
-        if (Array.isArray(value)) return Array.from(value, item => this.#sanitizeValue(item));
-        if (value && typeof value === "object") return Object.fromEntries(Object.entries(value).map(([k, v]) => [k, this.#sanitizeValue(v)]));
+    #normalizeAndCopy(value) {
+        if (value === undefined) return null;
+        if (JSON.stringify(value)?.length > 50_000) throw new Error("Value too large"); // 50KB limit
+        if (Array.isArray(value)) return Array.from(value, item => this.#normalizeAndCopy(item));
+        if (value && typeof value === "object") return Object.fromEntries(Object.entries(value).map(([k, v]) => [k, this.#normalizeAndCopy(v)]));
         return value;
     }
 
@@ -461,6 +456,14 @@ export default class CRDTManager {
         }
     }
 
+    /**
+     * Get uncloned property store
+     * @returns {Record<string, any>} Object with key value pairs
+     */
+    get rawPropertyStore() {
+        return this.#propertyStore;
+    }
+
     /**
      * Check for changes in the local property store
      * @returns {boolean} Check if any values changed going from the last to the current property update

package/types/server/server.d.ts

@@ -145,11 +145,15 @@ export default class PlaySocketServer {
      */
     move(clientId: string, roomId: string): void;
     /**
-     * Get snapshot of a room's storage
+     * Get a snapshot of a room's storage
      * @param {string} roomId - ID of the room to get the storage from
+     * @param {object} [options] - Options
+     * @param {boolean} [options.dangerouslySkipCloning=false] - Return uncloned store (faster, but allows illegal mutation)
      * @returns {Record<string, any> | undefined} Storage object or undefined if the room doesn't exist
      */
-    getRoomStorage(roomId: string): Record<string, any> | undefined;
+    getRoomStorage(roomId: string, { dangerouslySkipCloning }?: {
+        dangerouslySkipCloning?: boolean;
+    }): Record<string, any> | undefined;
     /**
      * Get the operation details from a storage update (e.g. in the "storageUpdateRequested" event)
      * @param {PropertyUpdate} update - Property update

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 = "5.1.0";
+export declare const VERSION = "5.2.1";
 /**
  * Logging prefixes
  */

package/types/universal/crdtManager.d.ts

@@ -123,6 +123,11 @@ export default class CRDTManager {
      * @returns {Record<string, any>} Object with key value pairs
      */
     get propertyStore(): Record<string, any>;
+    /**
+     * Get uncloned property store
+     * @returns {Record<string, any>} Object with key value pairs
+     */
+    get rawPropertyStore(): Record<string, any>;
     /**
      * Check for changes in the local property store
      * @returns {boolean} Check if any values changed going from the last to the current property update