@colyseus/monitor 0.12.2 → 0.12.3

package/README.md

@@ -54,6 +54,10 @@ npm start
 
 Access the UI on [http://localhost:2567/colyseus](http://localhost:2567/colyseus).
 
+## Environment Variables
+
+* `GAME_SERVER_URL` (default: current URL) - the URL for colyseus monitor to monitor (example: `server.game.com`).
+
 ## License
 
 MIT

package/lib/api.d.ts

@@ -1,2 +1,2 @@
-import { MonitorOptions } from ".";
-export declare function getAPI(opts: Partial<MonitorOptions>): import("express-serve-static-core").Router;
+import { MonitorOptions } from ".";
+export declare function getAPI(opts: Partial<MonitorOptions>): import("express-serve-static-core").Router;

package/lib/api.js

@@ -1,87 +1,88 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const colyseus_1 = require("colyseus");
-const express_1 = __importDefault(require("express"));
-const node_os_utils_1 = __importDefault(require("node-os-utils"));
-const UNAVAILABLE_ROOM_ERROR = "@colyseus/monitor: room $roomId is not available anymore.";
-const DEFAULT_COLUMNS = [
-    'roomId',
-    'name',
-    'clients',
-    'maxClients',
-    'locked',
-    'elapsedTime',
-];
-function getAPI(opts) {
-    const api = express_1.default.Router();
-    api.get("/", (req, res) => __awaiter(this, void 0, void 0, function* () {
-        try {
-            const rooms = yield colyseus_1.matchMaker.query({});
-            let connections = 0;
-            res.json({
-                columns: opts.columns || DEFAULT_COLUMNS,
-                rooms: rooms.map(room => {
-                    const data = room.toJSON();
-                    connections += room.clients;
-                    // additional data
-                    data.locked = room.locked || false;
-                    data.private = room.private;
-                    data.maxClients = `${room.maxClients}`;
-                    data.elapsedTime = Date.now() - new Date(room.createdAt).getTime();
-                    return data;
-                }),
-                connections,
-                cpu: yield node_os_utils_1.default.cpu.usage(),
-                memory: yield node_os_utils_1.default.mem.used()
-            });
-        }
-        catch (e) {
-            const message = e.message;
-            console.error(message);
-            res.status(500);
-            res.json({ message });
-        }
-    }));
-    api.get("/room", (req, res) => __awaiter(this, void 0, void 0, function* () {
-        const roomId = req.query.roomId;
-        try {
-            const inspectData = yield colyseus_1.matchMaker.remoteRoomCall(roomId, "getInspectData");
-            res.json(inspectData);
-        }
-        catch (e) {
-            const message = UNAVAILABLE_ROOM_ERROR.replace("$roomId", roomId);
-            console.error(message);
-            res.status(500);
-            res.json({ message });
-        }
-    }));
-    api.get("/room/call", (req, res) => __awaiter(this, void 0, void 0, function* () {
-        const roomId = req.query.roomId;
-        const method = req.query.method;
-        const args = JSON.parse(req.query.args);
-        try {
-            const data = yield colyseus_1.matchMaker.remoteRoomCall(roomId, method, args);
-            res.json(data);
-        }
-        catch (e) {
-            const message = UNAVAILABLE_ROOM_ERROR.replace("$roomId", roomId);
-            console.error(message);
-            res.status(500);
-            res.json({ message });
-        }
-    }));
-    return api;
-}
-exports.getAPI = getAPI;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAPI = void 0;
+const colyseus_1 = require("colyseus");
+const express_1 = __importDefault(require("express"));
+const node_os_utils_1 = __importDefault(require("node-os-utils"));
+const UNAVAILABLE_ROOM_ERROR = "@colyseus/monitor: room $roomId is not available anymore.";
+const DEFAULT_COLUMNS = [
+    'roomId',
+    'name',
+    'clients',
+    'maxClients',
+    'locked',
+    'elapsedTime',
+];
+function getAPI(opts) {
+    const api = express_1.default.Router();
+    api.get("/", (req, res) => __awaiter(this, void 0, void 0, function* () {
+        try {
+            const rooms = yield colyseus_1.matchMaker.query({});
+            let connections = 0;
+            res.json({
+                columns: opts.columns || DEFAULT_COLUMNS,
+                rooms: rooms.map(room => {
+                    const data = room.toJSON();
+                    connections += room.clients;
+                    // additional data
+                    data.locked = room.locked || false;
+                    data.private = room.private;
+                    data.maxClients = `${room.maxClients}`;
+                    data.elapsedTime = Date.now() - new Date(room.createdAt).getTime();
+                    return data;
+                }),
+                connections,
+                cpu: yield node_os_utils_1.default.cpu.usage(),
+                memory: yield node_os_utils_1.default.mem.used()
+            });
+        }
+        catch (e) {
+            const message = e.message;
+            console.error(message);
+            res.status(500);
+            res.json({ message });
+        }
+    }));
+    api.get("/room", (req, res) => __awaiter(this, void 0, void 0, function* () {
+        const roomId = req.query.roomId;
+        try {
+            const inspectData = yield colyseus_1.matchMaker.remoteRoomCall(roomId, "getInspectData");
+            res.json(inspectData);
+        }
+        catch (e) {
+            const message = UNAVAILABLE_ROOM_ERROR.replace("$roomId", roomId);
+            console.error(message);
+            res.status(500);
+            res.json({ message });
+        }
+    }));
+    api.get("/room/call", (req, res) => __awaiter(this, void 0, void 0, function* () {
+        const roomId = req.query.roomId;
+        const method = req.query.method;
+        const args = JSON.parse(req.query.args);
+        try {
+            const data = yield colyseus_1.matchMaker.remoteRoomCall(roomId, method, args);
+            res.json(data);
+        }
+        catch (e) {
+            const message = UNAVAILABLE_ROOM_ERROR.replace("$roomId", roomId);
+            console.error(message);
+            res.status(500);
+            res.json({ message });
+        }
+    }));
+    return api;
+}
+exports.getAPI = getAPI;

package/lib/ext/Room.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/ext/Room.js

@@ -1,69 +1,69 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-//
-// Monkey-patch Colyseus' default behaviour
-//
-const colyseus_1 = require("colyseus");
-function getStateSize(room) {
-    // TODO: `Serializer<T>` should provide a method for this (e.g. `serializer.hasState()`)
-    const hasState = (room._serializer.state || room._serializer.previousState);
-    const fullState = hasState && room._serializer.getFullState();
-    return fullState && (fullState.byteLength || fullState.length) || 0;
-}
-colyseus_1.Room.prototype.getAvailableData = function () {
-    return {
-        clients: this.clients.length,
-        maxClients: this.maxClients,
-        metadata: this.metadata,
-        roomId: this.roomId,
-    };
-};
-colyseus_1.Room.prototype.getRoomListData = function () {
-    return __awaiter(this, void 0, void 0, function* () {
-        const stateSize = getStateSize(this);
-        const elapsedTime = this.clock.elapsedTime;
-        const locked = this.locked;
-        const data = this.getAvailableData();
-        return Object.assign(Object.assign({}, data), { locked, elapsedTime, stateSize });
-    });
-};
-colyseus_1.Room.prototype.getInspectData = function () {
-    return __awaiter(this, void 0, void 0, function* () {
-        const state = this.state;
-        const stateSize = getStateSize(this);
-        const data = this.getAvailableData();
-        const clients = this.clients.map((client) => ({ sessionId: client.sessionId }));
-        const locked = this.locked;
-        return Object.assign(Object.assign({}, data), { locked, clients, state, stateSize });
-    });
-};
-// Actions
-colyseus_1.Room.prototype._forceClientDisconnect = function (sessionId) {
-    return __awaiter(this, void 0, void 0, function* () {
-        for (let i = 0; i < this.clients.length; i++) {
-            if (this.clients[i].sessionId === sessionId) {
-                this.clients[i].terminate();
-                break;
-            }
-        }
-    });
-};
-colyseus_1.Room.prototype._sendMessageToClient = function (sessionId, data) {
-    return __awaiter(this, void 0, void 0, function* () {
-        for (let i = 0; i < this.clients.length; i++) {
-            if (this.clients[i].sessionId === sessionId) {
-                this.send(this.clients[i], data);
-                break;
-            }
-        }
-    });
-};
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+//
+// Monkey-patch Colyseus' default behaviour
+//
+const colyseus_1 = require("colyseus");
+function getStateSize(room) {
+    // TODO: `Serializer<T>` should provide a method for this (e.g. `serializer.hasState()`)
+    const hasState = (room._serializer.state || room._serializer.previousState);
+    const fullState = hasState && room._serializer.getFullState();
+    return fullState && (fullState.byteLength || fullState.length) || 0;
+}
+colyseus_1.Room.prototype.getAvailableData = function () {
+    return {
+        clients: this.clients.length,
+        maxClients: this.maxClients,
+        metadata: this.metadata,
+        roomId: this.roomId,
+    };
+};
+colyseus_1.Room.prototype.getRoomListData = function () {
+    return __awaiter(this, void 0, void 0, function* () {
+        const stateSize = getStateSize(this);
+        const elapsedTime = this.clock.elapsedTime;
+        const locked = this.locked;
+        const data = this.getAvailableData();
+        return Object.assign(Object.assign({}, data), { locked, elapsedTime, stateSize });
+    });
+};
+colyseus_1.Room.prototype.getInspectData = function () {
+    return __awaiter(this, void 0, void 0, function* () {
+        const state = this.state;
+        const stateSize = getStateSize(this);
+        const data = this.getAvailableData();
+        const clients = this.clients.map((client) => ({ sessionId: client.sessionId }));
+        const locked = this.locked;
+        return Object.assign(Object.assign({}, data), { locked, clients, state, stateSize });
+    });
+};
+// Actions
+colyseus_1.Room.prototype._forceClientDisconnect = function (sessionId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        for (let i = 0; i < this.clients.length; i++) {
+            if (this.clients[i].sessionId === sessionId) {
+                this.clients[i].terminate();
+                break;
+            }
+        }
+    });
+};
+colyseus_1.Room.prototype._sendMessageToClient = function (sessionId, data) {
+    return __awaiter(this, void 0, void 0, function* () {
+        for (let i = 0; i < this.clients.length; i++) {
+            if (this.clients[i].sessionId === sessionId) {
+                this.send(this.clients[i], data);
+                break;
+            }
+        }
+    });
+};

package/lib/index.d.ts

@@ -1,11 +1,11 @@
-import express from 'express';
-import './ext/Room';
-export interface MonitorOptions {
-    columns: Array<'roomId' | 'name' | 'clients' | 'maxClients' | 'locked' | 'elapsedTime' | {
-        metadata: string;
-    }>;
-}
-/**
- * TODO: expose the `router` instead on next major version.
- */
-export declare function monitor(opts?: Partial<MonitorOptions>): express.Router;
+import express from 'express';
+import './ext/Room';
+export interface MonitorOptions {
+    columns: Array<'roomId' | 'name' | 'clients' | 'maxClients' | 'locked' | 'elapsedTime' | {
+        metadata: string;
+    }>;
+}
+/**
+ * TODO: expose the `router` instead on next major version.
+ */
+export declare function monitor(opts?: Partial<MonitorOptions>): express.Router;

package/lib/index.js

@@ -1,20 +1,21 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const express_1 = __importDefault(require("express"));
-const path_1 = __importDefault(require("path"));
-const api_1 = require("./api");
-require("./ext/Room");
-const frontendDirectory = path_1.default.resolve(__dirname, "..", "lib", "static");
-/**
- * TODO: expose the `router` instead on next major version.
- */
-function monitor(opts = {}) {
-    const router = express_1.default.Router();
-    router.use('/', express_1.default.static(frontendDirectory));
-    router.use('/api', api_1.getAPI(opts));
-    return router;
-}
-exports.monitor = monitor;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.monitor = void 0;
+const express_1 = __importDefault(require("express"));
+const path_1 = __importDefault(require("path"));
+const api_1 = require("./api");
+require("./ext/Room");
+const frontendDirectory = path_1.default.resolve(__dirname, "..", "lib", "static");
+/**
+ * TODO: expose the `router` instead on next major version.
+ */
+function monitor(opts = {}) {
+    const router = express_1.default.Router();
+    router.use('/', express_1.default.static(frontendDirectory));
+    router.use('/api', api_1.getAPI(opts));
+    return router;
+}
+exports.monitor = monitor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colyseus/monitor",
-  "version": "0.12.2",
+  "version": "0.12.3",
   "description": "Web Monitoring Panel for Colyseus",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -35,7 +35,7 @@
     "@types/react": "^16.3.9",
     "@types/react-router-dom": "^4.2.6",
     "@types/superagent": "^3.5.8",
-    "colyseus": "^0.11.24",
+    "colyseus": "^0.12.0",
     "cors": "^2.8.4",
     "css-loader": "^0.28.11",
     "extract-text-webpack-plugin": "^4.0.0-beta.0",
@@ -52,7 +52,7 @@
     "superagent": "^3.8.2",
     "ts-loader": "^4.2.0",
     "ts-node": "^5.0.1",
-    "typescript": "^3.0.3",
+    "typescript": "^3.9.7",
     "webpack": "^4.5.0",
     "webpack-cli": "^3.2.3",
     "webpack-dev-middleware": "^3.1.2",
@@ -61,8 +61,5 @@
   "dependencies": {
     "express": "^4.16.3",
     "node-os-utils": "^1.2.0"
-  },
-  "peerDependencies": {
-    "colyseus": "^0.11.0"
   }
 }

package/tsconfig.json

@@ -9,6 +9,7 @@
         "esModuleInterop": true,
         "experimentalDecorators": true,
         "sourceMap": false,
+        "skipLibCheck": true,
         "jsx": "react"
     },
     "include": [