playsocketjs 4.1.1 → 4.2.1

package/package.json

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

package/src/client/client.js

@@ -1,5 +1,6 @@
 import { encode, decode } from "@msgpack/msgpack";
 import CRDTManager from "../universal/crdtManager.js";
+import { VERSION } from "../universal/constants.js";
 
 const ERROR_PREFIX = "PlaySocket error: ";
 const WARNING_PREFIX = "PlaySocket warning: ";
@@ -160,6 +161,7 @@ export default class PlaySocket {
                 this.#sendToServer({
                     type: "register",
                     id: this.#id,
+                    version: VERSION,
                     customData: this.#customData || undefined
                 });
             }),

package/src/server/server.js

@@ -2,7 +2,7 @@ import { WebSocketServer } from "ws";
 import { createServer } from "node:http";
 import { encode, decode } from "@msgpack/msgpack";
 import CRDTManager, { getUpdateDetails } from "../universal/crdtManager.js";
-import { HEARTBEAT_INTERVAL } from "../universal/constants.js";
+import { HEARTBEAT_INTERVAL, VERSION } from "../universal/constants.js";
 
 const MAX_ROOM_SIZE = 500;
 export const RECONNECT_GRACE_PERIOD = 5000; // Exported for use in tests
@@ -145,6 +145,12 @@ export default class PlaySocketServer {
 
             switch (data.type) {
                 case "register": {
+                    // Ensure client uses the same version as server
+                    if (data.version !== VERSION) {
+                        ws.send(encode({ type: "registration_failed", reason: `Version mismatch (client ${data.version ? "v" + data.version : "legacy"}, server v${VERSION}). Please reload the page, an update may have been released.` }), { binary: true });
+                        return;
+                    }
+
                     // Register client ID if provided & check for a duplicate
                     if (data.id && (this.#clients.get(data.id) || data.id === "server")) {
                         ws.send(encode({ type: "registration_failed", reason: "ID is taken." }), { binary: true });

package/src/universal/constants.js

@@ -5,3 +5,8 @@
  * be desynced as a result of gc
  */
 export const HEARTBEAT_INTERVAL = 5000;
+
+/**
+ * Library version, must match package.json
+ */
+export const VERSION = "4.2.1";

package/types/universal/constants.d.ts

@@ -5,3 +5,7 @@
  * be desynced as a result of gc
  */
 export declare const HEARTBEAT_INTERVAL = 5000;
+/**
+ * Library version, must match package.json
+ */
+export declare const VERSION = "4.2.1";