playsocketjs 4.0.0 → 4.1.0

package/README.md

@@ -214,11 +214,12 @@ Validating an incoming storage update:
 const server = new PlaySocketServer();
 
 server.onEvent("storageUpdateRequested", ({ roomId, clientId, update, storage }) => {
+    const { key, type, value, secondValue } = server.getUpdateDetails(update);
+
     // Block updates on all keys except for "players" and "chats"
-    if (!["players", "chats"].includes(update.key)) return false;
+    if (!["players", "chats"].includes(key)) return false;
 
-    if (update.key === "chats") {
-        const { type, value, secondValue } = server.getUpdateDetails(update);
+    if (key === "chats") {
         if (type !== "array-add") return false; // Only allow adding chats
         if (typeof value !== "string") return false; // Only allow strings
     }
@@ -315,7 +316,7 @@ The callback signature is `callback(verified, code?, message?)` where `code` ref
 | `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. |
-| `getUpdateDetails()` | `update: object` | `object` | Get the details (`type`, `value` and `secondValue`) of a storage update for building validation logic. |
+| `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).|
 | `destroyRoom()` | `roomId: string` | `void` | Destroy a room & kick all participants. |

package/package.json

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

package/src/server/server.js

@@ -562,7 +562,7 @@ export default class PlaySocketServer {
     /**
      * Get the operation details from a storage update (e.g. in the "storageUpdateRequested" event)
      * @param {PropertyUpdate} update - Property update
-     * @returns {{type: PropertyUpdateType | undefined, value: *, secondValue: *}} - Operation details
+     * @returns {{key: string | undefined, type: PropertyUpdateType | undefined, value: *, secondValue: *}} - Operation details
      */
     getUpdateDetails(update) {
         return getUpdateDetails(update);

package/src/universal/crdtManager.js

@@ -490,9 +490,9 @@ export default class CRDTManager {
 /**
  * Get the operation details from a property update
  * @param {PropertyUpdate} update - Property update
- * @returns {{type: PropertyUpdateType | undefined, value: *, secondValue: *}} - Operation details
+ * @returns {{key: string | undefined, type: PropertyUpdateType | undefined, value: *, secondValue: *}} - Operation details
  */
 export function getUpdateDetails(update) {
     const data = update?.operation?.data;
-    return { type: data?.type, value: data?.value, secondValue: data?.secondValue };
+    return { key: update?.key, type: data?.type, value: data?.value, secondValue: data?.secondValue };
 }

package/types/server/server.d.ts

@@ -102,9 +102,10 @@ export default class PlaySocketServer {
     /**
      * Get the operation details from a storage update (e.g. in the "storageUpdateRequested" event)
      * @param {PropertyUpdate} update - Property update
-     * @returns {{type: PropertyUpdateType | undefined, value: *, secondValue: *}} - Operation details
+     * @returns {{key: string | undefined, type: PropertyUpdateType | undefined, value: *, secondValue: *}} - Operation details
      */
     getUpdateDetails(update: PropertyUpdate): {
+        key: string | undefined;
         type: PropertyUpdateType | undefined;
         value: any;
         secondValue: any;

package/types/universal/crdtManager.d.ts

@@ -137,9 +137,10 @@ export default class CRDTManager {
 /**
  * Get the operation details from a property update
  * @param {PropertyUpdate} update - Property update
- * @returns {{type: PropertyUpdateType | undefined, value: *, secondValue: *}} - Operation details
+ * @returns {{key: string | undefined, type: PropertyUpdateType | undefined, value: *, secondValue: *}} - Operation details
  */
 export declare function getUpdateDetails(update: PropertyUpdate): {
+    key: string | undefined;
     type: PropertyUpdateType | undefined;
     value: any;
     secondValue: any;