@colyseus/playground 0.17.0 → 0.17.2

package/package.json

@@ -1,32 +1,32 @@
 {
   "name": "@colyseus/playground",
-  "version": "0.17.0",
+  "version": "0.17.2",
   "main": "./build/index.js",
   "module": "./build/index.mjs",
   "typings": "./build/index.d.ts",
   "exports": {
     ".": {
+      "@source": "./src-backend/index.ts",
       "types": "./build/index.d.ts",
       "import": "./build/index.mjs",
       "require": "./build/index.js"
     },
     "./*": {
+      "@source": "./src-backend/*.ts",
       "types": "./build/*.d.ts",
-      "import": "./src-backend/*.ts",
+      "import": "./build/*.mjs",
       "require": "./build/*.js"
     }
   },
   "files": [
     "build",
-    "README.md",
-    "LICENSE",
-    "screenshot.png"
+    "src-backend"
   ],
   "peerDependencies": {
     "express": ">=4.16.0",
     "zod": "^4.1.12",
-    "@colyseus/auth": "^0.17.0",
-    "@colyseus/core": "^0.17.0"
+    "@colyseus/auth": "^0.17.2",
+    "@colyseus/core": "^0.17.2"
   },
   "browserslist": {
     "production": [
@@ -70,7 +70,7 @@
     "vite": "^5.0.11",
     "vitest": "^1.1.3",
     "web-vitals": "^2.1.4",
-    "@colyseus/sdk": "^0.17.0"
+    "@colyseus/sdk": "^0.17.2"
   },
   "dependencies": {
     "@colyseus/better-call": "^1.0.26"

package/src-backend/colyseus.ext.ts

@@ -0,0 +1,29 @@
+import { Room, Client, ClientState, ClientPrivate, AuthContext } from '@colyseus/core';
+
+export async function applyMonkeyPatch() {
+  /**
+   * Optional: if zod is available, we can use toJSONSchema() for body and query types
+   */
+  let z: any = undefined;
+  try { z = await import("zod"); } catch (e: any) { /* zod not installed  */ }
+
+  const _onJoin = Room.prototype['_onJoin'];
+  Room.prototype['_onJoin'] = async function (this: Room, client: Client & ClientPrivate) {
+    const result = await _onJoin.apply(this, arguments as any);
+
+    if (client.state === ClientState.JOINING) {
+
+      const messages: any = {};
+      Object.keys(this['onMessageEvents'].events).sort().forEach((type) => {
+        if (type.indexOf("__") === 0 || type === "*") { return; }
+
+        const messageValidator = this['onMessageValidators'][type];
+        messages[type] = z && messageValidator && z.toJSONSchema(messageValidator) || null;
+      });
+
+      client.send("__playground_message_types", messages);
+    }
+
+    return result;
+  }
+}

package/src-backend/index.ts

@@ -0,0 +1,74 @@
+import path from 'path';
+import express, { Router } from 'express';
+import { auth, JWT } from '@colyseus/auth';
+import { matchMaker, IRoomCache, __globalEndpoints } from '@colyseus/core';
+import type { Endpoint } from "@colyseus/better-call";
+import { applyMonkeyPatch } from './colyseus.ext.js';
+
+import { fileURLToPath } from 'url'; // required for ESM build (see build.mjs)
+
+export type AuthConfig = {
+  oauth: string[],
+  register: boolean,
+  anonymous: boolean,
+};
+
+export function playground(): Router {
+  applyMonkeyPatch();
+
+  const router = express.Router();
+
+  // serve static frontend
+  router.use("/", express.static(path.resolve(__dirname, "..", "build")));
+
+  // expose matchmaking stats
+  router.get("/rooms", async (req, res) => {
+    const rooms = await matchMaker.driver.query({});
+
+    const roomsByType: { [roomName: string]: number } = {};
+    const roomsById: { [roomName: string]: IRoomCache } = {};
+
+    rooms.forEach((room) => {
+      if (!roomsByType[room.name]) { roomsByType[room.name] = 0; }
+      roomsByType[room.name]++;
+      roomsById[room.roomId] = room;
+    });
+
+    res.json({
+      rooms: Object.keys(matchMaker.getAllHandlers()),
+
+      roomsByType,
+      roomsById,
+
+      auth: {
+        // list of OAuth providers
+        oauth: Object.keys(auth.oauth.providers),
+        register: typeof(auth.settings.onRegisterWithEmailAndPassword) === "function",
+        anonymous: typeof(JWT.settings.secret) === "string",
+      } as AuthConfig
+    });
+  });
+
+  // serve API docs for playground
+  // (workaround to use better-call route inside express.Router)
+  router.get("/__apidocs", async (_, res) => {
+    /**
+     * Optional: if zod is available, we can use toJSONSchema() for body and query types
+     */
+    let z: any = undefined;
+    try { z = await import("zod"); } catch (e: any) { /* zod not installed  */ }
+
+    res.json(Object.values(__globalEndpoints).map((endpoint: Endpoint) => {
+      return {
+        method: endpoint.options.method,
+        path: endpoint.path,
+        body: z && endpoint.options.body && z.toJSONSchema(endpoint.options.body),
+        query: z && endpoint.options.query && z.toJSONSchema(endpoint.options.query),
+        metadata: endpoint.options.metadata,
+        description: endpoint.options.metadata?.openapi?.description,
+      };
+    }));
+  });
+
+  return router;
+}