@colyseus/sdk 0.17.13 → 0.17.15

package/dist/colyseus.js

@@ -3,7 +3,7 @@
 // This software is released under the MIT License.
 // https://opensource.org/license/MIT
 //
-// colyseus.js@0.17.13 - @colyseus/schema 4.0.1
+// colyseus.js@0.17.15 - @colyseus/schema 4.0.1
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
     typeof define === 'function' && define.amd ? define('@colyseus/sdk', ['exports'], factory) :
@@ -81,17 +81,43 @@
         return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
     };
 
-    exports.CloseCode = void 0;
-    (function (CloseCode) {
-        CloseCode[CloseCode["NORMAL_CLOSURE"] = 1000] = "NORMAL_CLOSURE";
-        CloseCode[CloseCode["GOING_AWAY"] = 1001] = "GOING_AWAY";
-        CloseCode[CloseCode["NO_STATUS_RECEIVED"] = 1005] = "NO_STATUS_RECEIVED";
-        CloseCode[CloseCode["ABNORMAL_CLOSURE"] = 1006] = "ABNORMAL_CLOSURE";
-        CloseCode[CloseCode["CONSENTED"] = 4000] = "CONSENTED";
-        CloseCode[CloseCode["SERVER_SHUTDOWN"] = 4001] = "SERVER_SHUTDOWN";
-        CloseCode[CloseCode["WITH_ERROR"] = 4002] = "WITH_ERROR";
-        CloseCode[CloseCode["DEVMODE_RESTART"] = 4010] = "DEVMODE_RESTART";
-    })(exports.CloseCode || (exports.CloseCode = {}));
+    // packages/shared-types/src/Protocol.ts
+    var Protocol$1 = {
+      // Room-related (10~19)
+      JOIN_ROOM: 10,
+      ERROR: 11,
+      LEAVE_ROOM: 12,
+      ROOM_DATA: 13,
+      ROOM_STATE: 14,
+      ROOM_STATE_PATCH: 15,
+      ROOM_DATA_SCHEMA: 16,
+      // DEPRECATED: used to send schema instances via room.send()
+      ROOM_DATA_BYTES: 17,
+      PING: 18
+    };
+    var ErrorCode$1 = {
+      MATCHMAKE_NO_HANDLER: 520,
+      MATCHMAKE_INVALID_CRITERIA: 521,
+      MATCHMAKE_INVALID_ROOM_ID: 522,
+      MATCHMAKE_UNHANDLED: 523,
+      // generic exception during onCreate/onJoin
+      MATCHMAKE_EXPIRED: 524,
+      // generic exception during onCreate/onJoin
+      AUTH_FAILED: 525,
+      APPLICATION_ERROR: 526,
+      INVALID_PAYLOAD: 4217
+    };
+    var CloseCode = {
+      NORMAL_CLOSURE: 1e3,
+      GOING_AWAY: 1001,
+      NO_STATUS_RECEIVED: 1005,
+      ABNORMAL_CLOSURE: 1006,
+      CONSENTED: 4e3,
+      SERVER_SHUTDOWN: 4001,
+      WITH_ERROR: 4002,
+      MAY_TRY_RECONNECT: 4010
+    };
+
     class ServerError extends Error {
         constructor(code, message) {
             super(message);
@@ -8281,12 +8307,22 @@
                 this.ws = new WebSocket(url, this.protocols);
             }
             this.ws.binaryType = 'arraybuffer';
-            this.ws.onopen = this.events.onopen;
-            this.ws.onmessage = this.events.onmessage;
-            this.ws.onclose = this.events.onclose;
-            this.ws.onerror = this.events.onerror;
+            this.ws.onopen = (event) => { var _a, _b; return (_b = (_a = this.events).onopen) === null || _b === void 0 ? void 0 : _b.call(_a, event); };
+            this.ws.onmessage = (event) => { var _a, _b; return (_b = (_a = this.events).onmessage) === null || _b === void 0 ? void 0 : _b.call(_a, event); };
+            this.ws.onclose = (event) => { var _a, _b; return (_b = (_a = this.events).onclose) === null || _b === void 0 ? void 0 : _b.call(_a, event); };
+            this.ws.onerror = (event) => { var _a, _b; return (_b = (_a = this.events).onerror) === null || _b === void 0 ? void 0 : _b.call(_a, event); };
         }
         close(code, reason) {
+            //
+            // trigger the onclose event immediately if the code is MAY_TRY_RECONNECT
+            // when "offline" event is triggered, the close frame is delayed. this
+            // way client can try to reconnect immediately.
+            //
+            if (code === CloseCode.MAY_TRY_RECONNECT && this.events.onclose) {
+                this.ws.onclose = null;
+                this.events.onclose({ code, reason });
+            }
+            // then we close the connection
             this.ws.close(code, reason);
         }
         get isOpen() {
@@ -8294,9 +8330,23 @@
         }
     }
 
+    var _Connection__offlineListener;
+    const onOfflineListeners = [];
+    const hasGlobalEventListeners = typeof (addEventListener) === "function" && typeof (removeEventListener) === "function";
+    if (hasGlobalEventListeners) {
+        /**
+         * Detects when the network is offline and closes all connections.
+         * (When switching wifi networks, etc.)
+         */
+        addEventListener("offline", () => {
+            console.warn(`@colyseus/sdk: 🛑 Network offline. Closing ${onOfflineListeners.length} connection(s)`);
+            onOfflineListeners.forEach((listener) => listener());
+        }, false);
+    }
     class Connection {
         constructor(protocol) {
             this.events = {};
+            _Connection__offlineListener.set(this, (hasGlobalEventListeners) ? () => this.close(CloseCode.MAY_TRY_RECONNECT) : null);
             switch (protocol) {
                 case "h3":
                     this.transport = new H3TransportTransport(this.events);
@@ -8307,6 +8357,18 @@
             }
         }
         connect(url, options) {
+            if (hasGlobalEventListeners) {
+                const onOpen = this.events.onopen;
+                this.events.onopen = (ev) => {
+                    onOfflineListeners.push(__classPrivateFieldGet(this, _Connection__offlineListener, "f"));
+                    onOpen === null || onOpen === void 0 ? void 0 : onOpen(ev);
+                };
+                const onClose = this.events.onclose;
+                this.events.onclose = (ev) => {
+                    onOfflineListeners.splice(onOfflineListeners.indexOf(__classPrivateFieldGet(this, _Connection__offlineListener, "f")), 1);
+                    onClose === null || onClose === void 0 ? void 0 : onClose(ev);
+                };
+            }
             this.url = url;
             this.options = options;
             this.transport.connect(url, options);
@@ -8328,9 +8390,10 @@
             return this.transport.isOpen;
         }
     }
+    _Connection__offlineListener = new WeakMap();
 
     // Use codes between 0~127 for lesser throughput (1 byte)
-    exports.Protocol = void 0;
+    var Protocol;
     (function (Protocol) {
         // Room-related (10~19)
         Protocol[Protocol["HANDSHAKE"] = 9] = "HANDSHAKE";
@@ -8343,8 +8406,8 @@
         Protocol[Protocol["ROOM_DATA_SCHEMA"] = 16] = "ROOM_DATA_SCHEMA";
         Protocol[Protocol["ROOM_DATA_BYTES"] = 17] = "ROOM_DATA_BYTES";
         Protocol[Protocol["PING"] = 18] = "PING";
-    })(exports.Protocol || (exports.Protocol = {}));
-    exports.ErrorCode = void 0;
+    })(Protocol || (Protocol = {}));
+    var ErrorCode;
     (function (ErrorCode) {
         ErrorCode[ErrorCode["MATCHMAKE_NO_HANDLER"] = 520] = "MATCHMAKE_NO_HANDLER";
         ErrorCode[ErrorCode["MATCHMAKE_INVALID_CRITERIA"] = 521] = "MATCHMAKE_INVALID_CRITERIA";
@@ -8353,7 +8416,7 @@
         ErrorCode[ErrorCode["MATCHMAKE_EXPIRED"] = 524] = "MATCHMAKE_EXPIRED";
         ErrorCode[ErrorCode["AUTH_FAILED"] = 525] = "AUTH_FAILED";
         ErrorCode[ErrorCode["APPLICATION_ERROR"] = 526] = "APPLICATION_ERROR";
-    })(exports.ErrorCode || (exports.ErrorCode = {}));
+    })(ErrorCode || (ErrorCode = {}));
 
     const serializers = {};
     function registerSerializer(id, serializer) {
@@ -8514,7 +8577,7 @@
             // reconnection logic
             this.reconnection = {
                 retryCount: 0,
-                maxRetries: 8,
+                maxRetries: 15,
                 delay: 100,
                 minDelay: 100,
                 maxDelay: 5000,
@@ -8536,7 +8599,6 @@
                 this.serializer = new (getSerializer("schema"));
                 this.serializer.state = new rootSchema();
             }
-            this.onError((code, message) => { var _a; return (_a = console.warn) === null || _a === void 0 ? void 0 : _a.call(console, `colyseus.js - onError => (${code}) ${message}`); });
             this.onLeave(() => this.removeAllListeners());
         }
         connect(endpoint, options, headers) {
@@ -8550,10 +8612,10 @@
                     this.onError.invoke(e.code, e.reason);
                     return;
                 }
-                if (e.code === exports.CloseCode.NO_STATUS_RECEIVED ||
-                    e.code === exports.CloseCode.ABNORMAL_CLOSURE ||
-                    e.code === exports.CloseCode.GOING_AWAY ||
-                    e.code === exports.CloseCode.DEVMODE_RESTART) {
+                if (e.code === CloseCode.NO_STATUS_RECEIVED ||
+                    e.code === CloseCode.ABNORMAL_CLOSURE ||
+                    e.code === CloseCode.GOING_AWAY ||
+                    e.code === CloseCode.MAY_TRY_RECONNECT) {
                     this.onDrop.invoke(e.code, e.reason);
                     this.handleReconnection();
                 }
@@ -8563,8 +8625,6 @@
                 }
             };
             this.connection.events.onerror = (e) => {
-                var _a;
-                (_a = console.warn) === null || _a === void 0 ? void 0 : _a.call(console, `Room, onError (${e.code}): ${e.reason}`);
                 this.onError.invoke(e.code, e.reason);
             };
             /**
@@ -8586,7 +8646,7 @@
                 this.onLeave((code) => resolve(code));
                 if (this.connection) {
                     if (consented) {
-                        this.packr.buffer[0] = exports.Protocol.LEAVE_ROOM;
+                        this.packr.buffer[0] = Protocol.LEAVE_ROOM;
                         this.connection.send(this.packr.buffer.subarray(0, 1));
                     }
                     else {
@@ -8594,7 +8654,7 @@
                     }
                 }
                 else {
-                    this.onLeave.invoke(exports.CloseCode.CONSENTED);
+                    this.onLeave.invoke(CloseCode.CONSENTED);
                 }
             });
         }
@@ -8602,14 +8662,19 @@
             return this.onMessageHandlers.on(this.getMessageHandlerKey(type), callback);
         }
         ping(callback) {
+            var _a;
+            // skip if connection is not open
+            if (!((_a = this.connection) === null || _a === void 0 ? void 0 : _a.isOpen)) {
+                return;
+            }
             __classPrivateFieldSet(this, _Room_lastPingTime, now(), "f");
             __classPrivateFieldSet(this, _Room_pingCallback, callback, "f");
-            this.packr.buffer[0] = exports.Protocol.PING;
+            this.packr.buffer[0] = Protocol.PING;
             this.connection.send(this.packr.buffer.subarray(0, 1));
         }
         send(messageType, payload) {
             const it = { offset: 1 };
-            this.packr.buffer[0] = exports.Protocol.ROOM_DATA;
+            this.packr.buffer[0] = Protocol.ROOM_DATA;
             if (typeof (messageType) === "string") {
                 umdExports.encode.string(this.packr.buffer, messageType, it);
             }
@@ -8635,7 +8700,7 @@
                 return;
             }
             const it = { offset: 1 };
-            this.packr.buffer[0] = exports.Protocol.ROOM_DATA;
+            this.packr.buffer[0] = Protocol.ROOM_DATA;
             if (typeof (type) === "string") {
                 umdExports.encode.string(this.packr.buffer, type, it);
             }
@@ -8651,7 +8716,7 @@
         }
         sendBytes(type, bytes) {
             const it = { offset: 1 };
-            this.packr.buffer[0] = exports.Protocol.ROOM_DATA_BYTES;
+            this.packr.buffer[0] = Protocol.ROOM_DATA_BYTES;
             if (typeof (type) === "string") {
                 umdExports.encode.string(this.packr.buffer, type, it);
             }
@@ -8693,7 +8758,7 @@
             const buffer = new Uint8Array(event.data);
             const it = { offset: 1 };
             const code = buffer[0];
-            if (code === exports.Protocol.JOIN_ROOM) {
+            if (code === Protocol.JOIN_ROOM) {
                 const reconnectionToken = umdExports.decode.utf8Read(buffer, it, buffer[it.offset++]);
                 this.serializerId = umdExports.decode.utf8Read(buffer, it, buffer[it.offset++]);
                 // Instantiate serializer if not locally available.
@@ -8716,7 +8781,7 @@
                 }
                 this.reconnectionToken = `${this.roomId}:${reconnectionToken}`;
                 // acknowledge successfull JOIN_ROOM
-                this.packr.buffer[0] = exports.Protocol.JOIN_ROOM;
+                this.packr.buffer[0] = Protocol.JOIN_ROOM;
                 this.connection.send(this.packr.buffer.subarray(0, 1));
                 // Send any enqueued messages that were buffered while disconnected
                 if (this.reconnection.enqueuedMessages.length > 0) {
@@ -8727,23 +8792,23 @@
                     this.reconnection.enqueuedMessages = [];
                 }
             }
-            else if (code === exports.Protocol.ERROR) {
+            else if (code === Protocol.ERROR) {
                 const code = umdExports.decode.number(buffer, it);
                 const message = umdExports.decode.string(buffer, it);
                 this.onError.invoke(code, message);
             }
-            else if (code === exports.Protocol.LEAVE_ROOM) {
+            else if (code === Protocol.LEAVE_ROOM) {
                 this.leave();
             }
-            else if (code === exports.Protocol.ROOM_STATE) {
+            else if (code === Protocol.ROOM_STATE) {
                 this.serializer.setState(buffer, it);
                 this.onStateChange.invoke(this.serializer.getState());
             }
-            else if (code === exports.Protocol.ROOM_STATE_PATCH) {
+            else if (code === Protocol.ROOM_STATE_PATCH) {
                 this.serializer.patch(buffer, it);
                 this.onStateChange.invoke(this.serializer.getState());
             }
-            else if (code === exports.Protocol.ROOM_DATA) {
+            else if (code === Protocol.ROOM_DATA) {
                 const type = (umdExports.decode.stringCheck(buffer, it))
                     ? umdExports.decode.string(buffer, it)
                     : umdExports.decode.number(buffer, it);
@@ -8752,14 +8817,14 @@
                     : undefined;
                 this.dispatchMessage(type, message);
             }
-            else if (code === exports.Protocol.ROOM_DATA_BYTES) {
+            else if (code === Protocol.ROOM_DATA_BYTES) {
                 const type = (umdExports.decode.stringCheck(buffer, it))
                     ? umdExports.decode.string(buffer, it)
                     : umdExports.decode.number(buffer, it);
                 this.dispatchMessage(type, buffer.subarray(it.offset));
             }
-            else if (code === exports.Protocol.PING) {
-                (_a = __classPrivateFieldGet(this, _Room_pingCallback, "f")) === null || _a === void 0 ? void 0 : _a.call(this, now() - __classPrivateFieldGet(this, _Room_lastPingTime, "f"));
+            else if (code === Protocol.PING) {
+                (_a = __classPrivateFieldGet(this, _Room_pingCallback, "f")) === null || _a === void 0 ? void 0 : _a.call(this, Math.round(now() - __classPrivateFieldGet(this, _Room_lastPingTime, "f")));
                 __classPrivateFieldSet(this, _Room_pingCallback, undefined, "f");
             }
         }
@@ -8796,7 +8861,6 @@
                 return;
             }
             if (!this.reconnection.isReconnecting) {
-                console.info(`[Colyseus reconnection]: ${String.fromCodePoint(0x1F504)} Re-establishing connection with roomId '${this.roomId}'...`); // 🔄
                 this.reconnection.retryCount = 0;
                 this.reconnection.isReconnecting = true;
             }
@@ -8805,16 +8869,18 @@
         retryReconnection() {
             this.reconnection.retryCount++;
             const delay = Math.min(this.reconnection.maxDelay, Math.max(this.reconnection.minDelay, this.reconnection.backoff(this.reconnection.retryCount, this.reconnection.delay)));
-            console.info(`[Colyseus reconnection]: ${String.fromCodePoint(0x1F504)} will retry in ${delay}ms... (${this.reconnection.retryCount} out of ${this.reconnection.maxRetries})`); // 🔄
+            console.info(`[Colyseus reconnection]: ${String.fromCodePoint(0x023F3)} will retry in ${(delay / 1000).toFixed(1)} seconds...`); // 🔄
             // Wait before attempting reconnection
             setTimeout(() => {
                 try {
+                    console.info(`[Colyseus reconnection]: ${String.fromCodePoint(0x1F504)} Re-establishing sessionId '${this.sessionId}' with roomId '${this.roomId}'... (attempt ${this.reconnection.retryCount} of ${this.reconnection.maxRetries})`); // 🔄
                     this.connection.reconnect({
                         reconnectionToken: this.reconnectionToken.split(":")[1],
                         skipHandshake: true, // we already applied the handshake on first join
                     });
                 }
                 catch (e) {
+                    console.log(".reconnect() failed", e);
                     if (this.reconnection.retryCount < this.reconnection.maxRetries) {
                         this.retryReconnection();
                     }
@@ -9432,14 +9498,14 @@
                 let pingStart = 0;
                 conn.events.onopen = () => {
                     pingStart = Date.now();
-                    conn.send(new Uint8Array([exports.Protocol.PING]));
+                    conn.send(new Uint8Array([Protocol.PING]));
                 };
                 conn.events.onmessage = (_) => {
                     latencies.push(Date.now() - pingStart);
                     if (latencies.length < pingCount) {
                         // Send another ping
                         pingStart = Date.now();
-                        conn.send(new Uint8Array([exports.Protocol.PING]));
+                        conn.send(new Uint8Array([Protocol.PING]));
                     }
                     else {
                         // Done, calculate average and close
@@ -9449,7 +9515,7 @@
                     }
                 };
                 conn.events.onerror = (event) => {
-                    reject(new ServerError(exports.CloseCode.ABNORMAL_CLOSURE, `Failed to get latency: ${event.message}`));
+                    reject(new ServerError(CloseCode.ABNORMAL_CLOSURE, `Failed to get latency: ${event.message}`));
                 };
                 conn.connect(this.getHttpEndpoint());
             });
@@ -9543,8 +9609,11 @@
     exports.Auth = Auth;
     exports.Callbacks = umdExports.Callbacks;
     exports.Client = Client;
+    exports.CloseCode = CloseCode;
     exports.ColyseusSDK = ColyseusSDK;
+    exports.ErrorCode = ErrorCode$1;
     exports.MatchMakeError = MatchMakeError;
+    exports.Protocol = Protocol$1;
     exports.Room = Room;
     exports.SchemaSerializer = SchemaSerializer;
     exports.ServerError = ServerError;