@v12-engine/engine 0.1.0 → 0.4.0

package/dist/server/navigation.js

@@ -0,0 +1,39 @@
+import { navigationWorker } from "../navigation/builds.js";
+import { existsSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+//#region src/server/navigation.ts
+/**
+* A builder of navigations in a worker thread of this process (S37): what a server builds with, so that the world of
+* one game being made does not hold up the ticks of the others (two seconds for a map of 512 cells a side). One
+* thread, made the first time and kept, which keeps the process alive only while it builds. Nothing where the
+* worker's file is not there: in this repository, which runs the engine as it is written, it builds on the thread
+* that asks
+*
+* @beta
+*/
+function nodeNavigationBuilder() {
+	const script = new URL("navigation-worker.js", import.meta.url);
+	if (script.protocol !== "file:" || !existsSync(fileURLToPath(script))) return void 0;
+	let made;
+	let pending = 0;
+	return async (build) => {
+		made ??= import("node:worker_threads").then(({ Worker }) => {
+			const worker = new Worker(script);
+			return {
+				worker,
+				builder: navigationWorker(worker)
+			};
+		});
+		const { worker, builder } = await made;
+		if (pending++ === 0) worker.ref();
+		try {
+			return await builder(build);
+		} finally {
+			if (--pending === 0) worker.unref();
+		}
+	};
+}
+//#endregion
+export { nodeNavigationBuilder };
+
+//# sourceMappingURL=navigation.js.map

package/dist/server/navigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.js","names":[],"sources":["../../src/server/navigation.ts"],"sourcesContent":["import { existsSync } from 'node:fs'\nimport { fileURLToPath } from 'node:url'\nimport { type NavigationBuilder, navigationWorker } from '#engine/navigation/builds'\n\n/**\n * A builder of navigations in a worker thread of this process (S37): what a server builds with, so that the world of\n * one game being made does not hold up the ticks of the others (two seconds for a map of 512 cells a side). One\n * thread, made the first time and kept, which keeps the process alive only while it builds. Nothing where the\n * worker's file is not there: in this repository, which runs the engine as it is written, it builds on the thread\n * that asks\n *\n * @beta\n */\nexport function nodeNavigationBuilder(): NavigationBuilder | undefined {\n\t// the worker's file sits next to this one in the build: named so, a bundler leaves the address alone\n\tconst file = 'navigation-worker.js'\n\tconst script = new URL(file, import.meta.url)\n\tif (script.protocol !== 'file:' || !existsSync(fileURLToPath(script))) return undefined\n\tlet made: Promise<{ worker: { ref(): void; unref(): void }; builder: NavigationBuilder }> | undefined\n\tlet pending = 0\n\treturn async (build) => {\n\t\tmade ??= import('node:worker_threads').then(({ Worker }) => {\n\t\t\tconst worker = new Worker(script)\n\t\t\treturn { worker, builder: navigationWorker(worker as never) }\n\t\t})\n\t\tconst { worker, builder } = await made\n\t\t// it keeps the process alive while it builds, and not after\n\t\tif (pending++ === 0) worker.ref()\n\t\ttry {\n\t\t\treturn await builder(build)\n\t\t} finally {\n\t\t\tif (--pending === 0) worker.unref()\n\t\t}\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;AAaA,SAAgB,wBAAuD;CAGtE,MAAM,SAAS,IAAI,IAAI,wBAAM,YAAY,GAAG;CAC5C,IAAI,OAAO,aAAa,WAAW,CAAC,WAAW,cAAc,MAAM,CAAC,GAAG,OAAO,KAAA;CAC9E,IAAI;CACJ,IAAI,UAAU;CACd,OAAO,OAAO,UAAU;EACvB,SAAS,OAAO,sBAAsB,CAAC,MAAM,EAAE,aAAa;GAC3D,MAAM,SAAS,IAAI,OAAO,MAAM;GAChC,OAAO;IAAE;IAAQ,SAAS,iBAAiB,MAAe;GAAE;EAC7D,CAAC;EACD,MAAM,EAAE,QAAQ,YAAY,MAAM;EAElC,IAAI,cAAc,GAAG,OAAO,IAAI;EAChC,IAAI;GACH,OAAO,MAAM,QAAQ,KAAK;EAC3B,UAAU;GACT,IAAI,EAAE,YAAY,GAAG,OAAO,MAAM;EACnC;CACD;AACD"}

package/dist/server/ops.d.ts

@@ -21,15 +21,19 @@ export interface ServerMetrics {
     };
     /** Seats held by someone connected, and those watching */
     players: number;
+    /** Connections watching the game without a seat */
     watching: number;
     /** Connections open, seated or not */
     connections: number;
     /** Ticks of the simulation stepped since it started, and the seconds they took; how long the last one took */
     ticks: number;
+    /** Total seconds the simulation ticks have taken since the server started */
     tickSeconds: number;
+    /** Seconds the most recent tick took */
     lastTickSeconds: number;
     /** Rounds of sending everyone what changed, and the seconds they took */
     sends: number;
+    /** Total seconds the rounds of sending have taken since the server started */
     sendSeconds: number;
     /** Bytes sent to those connected now, over the wire */
     bytesSent: number;

package/dist/server/ops.js

@@ -0,0 +1,137 @@
+import "../session/protocol.js";
+import { sameSecret } from "./secret.js";
+import { mkdir, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+//#region src/server/ops.ts
+/** The numbers of a process: its memory */
+var memory = () => {
+	const { rss, heapUsed } = process.memoryUsage();
+	return {
+		rss,
+		heapUsed
+	};
+};
+/**
+* The numbers of the rooms of a process, in Prometheus's text: each by its room, where there is more than one
+*
+* @internal
+*/
+function metricsText(rooms) {
+	const lines = [];
+	const each = (name, help, type, value) => {
+		lines.push(`# HELP vg_${name} ${help}`, `# TYPE vg_${name} ${type}`);
+		for (const [room, metrics] of rooms) lines.push(`vg_${name}${room ? `{room=${JSON.stringify(room)}}` : ""} ${value(metrics)}`);
+	};
+	each("up", "Whether it takes new games: 0 once it is stopping", "gauge", (m) => m.draining ? 0 : 1);
+	each("games_running", "Games running now", "gauge", (m) => m.games.running);
+	each("games_played_total", "Games played to their end", "counter", (m) => m.games.played);
+	each("players", "Seats held by someone connected", "gauge", (m) => m.players);
+	each("watching", "Connections watching a game", "gauge", (m) => m.watching);
+	each("connections", "Connections open", "gauge", (m) => m.connections);
+	each("ticks_total", "Ticks of the simulation stepped", "counter", (m) => m.ticks);
+	each("tick_seconds_total", "Seconds the ticks took", "counter", (m) => round(m.tickSeconds));
+	each("last_tick_seconds", "How long the last tick took", "gauge", (m) => round(m.lastTickSeconds));
+	each("sends_total", "Rounds of sending what changed", "counter", (m) => m.sends);
+	each("send_seconds_total", "Seconds the sending took", "counter", (m) => round(m.sendSeconds));
+	each("bytes_sent", "Bytes sent to those connected now", "gauge", (m) => m.bytesSent);
+	each("uptime_seconds", "Seconds since it started", "gauge", (m) => round(m.uptime));
+	const { rss, heapUsed } = memory();
+	lines.push("# HELP vg_protocol_version The version of the wire its players have to speak", "# TYPE vg_protocol_version gauge", `vg_protocol_version 13`, "# HELP vg_memory_bytes Memory of the process", "# TYPE vg_memory_bytes gauge", `vg_memory_bytes{kind="rss"} ${rss}`, `vg_memory_bytes{kind="heap"} ${heapUsed}`);
+	return `${lines.join("\n")}\n`;
+}
+var round = (value) => Math.round(value * 1e6) / 1e6;
+/**
+* Answers the health and numbers addresses for the rooms of a process; false for any other request, which goes to
+* what answered it before. `draining` is whether the process takes no new games
+*/
+function answerOps(request, response, options, state, games, ratings) {
+	const { pathname, searchParams } = new URL(request.url ?? "/", "http://server");
+	const best = options?.ratings ?? "/ratings";
+	if (best && ratings?.ratings && pathname === best && (request.method === "GET" || request.method === "HEAD")) {
+		const mode = searchParams.get("mode") ?? ratings.modes[0] ?? "";
+		const count = Math.min(Math.max(Number(searchParams.get("n")) || 10, 1), 100);
+		const player = searchParams.get("player");
+		const top = ratings.ratings.top?.(mode, count) ?? [];
+		const own = player ? ratings.ratings.placeOf?.(mode, player) : void 0;
+		response.writeHead(200, {
+			"content-type": "application/json",
+			"cache-control": "no-store",
+			"access-control-allow-origin": "*"
+		});
+		response.end(JSON.stringify({
+			mode,
+			modes: ratings.modes,
+			top,
+			...own && { player: own }
+		}));
+		return true;
+	}
+	const health = options?.health ?? "/health";
+	const metrics = options?.metrics ?? "/metrics";
+	const list = options?.games ?? "/games";
+	if (request.method !== "GET" && request.method !== "HEAD") return false;
+	if (list && games && pathname === list) {
+		response.writeHead(200, {
+			"content-type": "application/json",
+			"cache-control": "no-store",
+			"access-control-allow-origin": "*"
+		});
+		response.end(JSON.stringify({
+			draining: state().draining,
+			...games()
+		}));
+		return true;
+	}
+	if (health && pathname === health) {
+		const { draining } = state();
+		response.writeHead(draining ? 503 : 200, {
+			"content-type": "application/json",
+			"cache-control": "no-store"
+		});
+		response.end(JSON.stringify({
+			ok: !draining,
+			draining
+		}));
+		return true;
+	}
+	if (metrics && pathname === metrics) {
+		if (options?.metricsKey && !sameSecret(request.headers.authorization ?? "", `Bearer ${options.metricsKey}`)) {
+			response.writeHead(401, {
+				"content-type": "text/plain",
+				"www-authenticate": "Bearer"
+			});
+			response.end("The numbers take a key\n");
+			return true;
+		}
+		const { rooms, draining } = state();
+		if (searchParams.has("json")) {
+			response.writeHead(200, {
+				"content-type": "application/json",
+				"cache-control": "no-store"
+			});
+			response.end(JSON.stringify({
+				draining,
+				protocol: 13,
+				memory: memory(),
+				rooms: Object.fromEntries(rooms)
+			}));
+		} else {
+			response.writeHead(200, {
+				"content-type": "text/plain; version=0.0.4",
+				"cache-control": "no-store"
+			});
+			response.end(metricsText(rooms));
+		}
+		return true;
+	}
+	return false;
+}
+/** A game's result as a file of its own in `dir` (`GameServerOptions.resultsDir`): by when it ended and its mode */
+async function writeResult(dir, result) {
+	await mkdir(dir, { recursive: true });
+	await writeFile(join(dir, `${Date.now()}-${result.mode.replace(/[^\w-]/g, "_")}.json`), JSON.stringify(result, null, 2));
+}
+//#endregion
+export { answerOps, metricsText, writeResult };
+
+//# sourceMappingURL=ops.js.map

package/dist/server/ops.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ops.js","names":[],"sources":["../../src/server/ops.ts"],"sourcesContent":["import type { Ratings } from './ratings'\nimport { mkdir, writeFile } from 'node:fs/promises'\nimport { join } from 'node:path'\nimport type { GameResult } from '#engine/game'\nimport { type GameKindListing, type GameListing, PROTOCOL_VERSION } from '#engine/session/protocol'\nimport type { IncomingMessage, ServerResponse } from 'node:http'\nimport { sameSecret } from './secret'\n\n/*\n * A server to run in production (S58): what the HTTP server the sockets are on answers besides them. An address that\n * says whether it is well (`/health`: 200 while it takes games, 503 once it is stopping, for a load balancer to send\n * no one new) and one with its numbers (`/metrics`: as Prometheus reads them, or as JSON with `?json`)\n */\n\n/**\n * What a game server says of itself: the numbers of `/metrics` (`GameServer.metrics`)\n *\n * @beta\n */\nexport interface ServerMetrics {\n\t/** In its lobby, playing, or showing a game that ended */\n\tphase: 'lobby' | 'game' | 'ended'\n\t/** It takes no new games: it is stopping, once the running one is over (`close({ drain })`) */\n\tdraining: boolean\n\t/** Seconds since it started */\n\tuptime: number\n\t/** Games running now (0 or 1 for one server), and played to their end since it started */\n\tgames: { running: number; played: number }\n\t/** Seats held by someone connected, and those watching */\n\tplayers: number\n\t/** Connections watching the game without a seat */\n\twatching: number\n\t/** Connections open, seated or not */\n\tconnections: number\n\t/** Ticks of the simulation stepped since it started, and the seconds they took; how long the last one took */\n\tticks: number\n\t/** Total seconds the simulation ticks have taken since the server started */\n\ttickSeconds: number\n\t/** Seconds the most recent tick took */\n\tlastTickSeconds: number\n\t/** Rounds of sending everyone what changed, and the seconds they took */\n\tsends: number\n\t/** Total seconds the rounds of sending have taken since the server started */\n\tsendSeconds: number\n\t/** Bytes sent to those connected now, over the wire */\n\tbytesSent: number\n}\n\n/**\n * Where the addresses are, and who may read the numbers (`GameServerOptions.http`)\n *\n * @beta\n */\nexport interface ServerHttpOptions {\n\t/** The address that says whether it is well. `/health` when left out; false for none */\n\thealth?: string | false\n\t/** The address of its numbers. `/metrics` when left out; false for none */\n\tmetrics?: string | false\n\t/**\n\t * The address of the list of its games, for a page to find one (`GameListing`, JSON, readable from any page). `/games`\n\t * when left out; false for none\n\t */\n\tgames?: string | false\n\t/**\n\t * The address of the best of each mode (`/ratings?mode=melee&n=10&player=<rated id>`: the top and the player's own\n\t * place, JSON, readable from any page), where the server keeps ratings. `/ratings` when left out; false for none @beta\n\t */\n\tratings?: string | false\n\t/**\n\t * What reading the numbers takes (`Authorization: Bearer <key>`): they say how many play, and when. Anyone who can\n\t * reach the address when left out: keep it behind the proxy then\n\t */\n\tmetricsKey?: string\n}\n\n/** The numbers of a process: its memory */\nconst memory = () => {\n\tconst { rss, heapUsed } = process.memoryUsage()\n\treturn { rss, heapUsed }\n}\n\n/**\n * The numbers of the rooms of a process, in Prometheus's text: each by its room, where there is more than one\n *\n * @internal\n */\nexport function metricsText(rooms: ReadonlyMap<string, ServerMetrics>): string {\n\tconst lines: string[] = []\n\tconst each = (name: string, help: string, type: 'gauge' | 'counter', value: (metrics: ServerMetrics) => number) => {\n\t\tlines.push(`# HELP vg_${name} ${help}`, `# TYPE vg_${name} ${type}`)\n\t\tfor (const [room, metrics] of rooms) lines.push(`vg_${name}${room ? `{room=${JSON.stringify(room)}}` : ''} ${value(metrics)}`)\n\t}\n\teach('up', 'Whether it takes new games: 0 once it is stopping', 'gauge', (m) => (m.draining ? 0 : 1))\n\teach('games_running', 'Games running now', 'gauge', (m) => m.games.running)\n\teach('games_played_total', 'Games played to their end', 'counter', (m) => m.games.played)\n\teach('players', 'Seats held by someone connected', 'gauge', (m) => m.players)\n\teach('watching', 'Connections watching a game', 'gauge', (m) => m.watching)\n\teach('connections', 'Connections open', 'gauge', (m) => m.connections)\n\teach('ticks_total', 'Ticks of the simulation stepped', 'counter', (m) => m.ticks)\n\teach('tick_seconds_total', 'Seconds the ticks took', 'counter', (m) => round(m.tickSeconds))\n\teach('last_tick_seconds', 'How long the last tick took', 'gauge', (m) => round(m.lastTickSeconds))\n\teach('sends_total', 'Rounds of sending what changed', 'counter', (m) => m.sends)\n\teach('send_seconds_total', 'Seconds the sending took', 'counter', (m) => round(m.sendSeconds))\n\teach('bytes_sent', 'Bytes sent to those connected now', 'gauge', (m) => m.bytesSent)\n\teach('uptime_seconds', 'Seconds since it started', 'gauge', (m) => round(m.uptime))\n\tconst { rss, heapUsed } = memory()\n\tlines.push(\n\t\t// which version of the wire it speaks: a deploy of mixed versions shows as two values\n\t\t'# HELP vg_protocol_version The version of the wire its players have to speak',\n\t\t'# TYPE vg_protocol_version gauge',\n\t\t`vg_protocol_version ${PROTOCOL_VERSION}`,\n\t\t'# HELP vg_memory_bytes Memory of the process',\n\t\t'# TYPE vg_memory_bytes gauge',\n\t\t`vg_memory_bytes{kind=\"rss\"} ${rss}`,\n\t\t`vg_memory_bytes{kind=\"heap\"} ${heapUsed}`\n\t)\n\treturn `${lines.join('\\n')}\\n`\n}\n\nconst round = (value: number) => Math.round(value * 1e6) / 1e6\n\n/**\n * Answers the health and numbers addresses for the rooms of a process; false for any other request, which goes to\n * what answered it before. `draining` is whether the process takes no new games\n */\nexport function answerOps(\n\trequest: IncomingMessage,\n\tresponse: ServerResponse,\n\toptions: ServerHttpOptions | undefined,\n\tstate: () => { draining: boolean; rooms: ReadonlyMap<string, ServerMetrics> },\n\tgames?: () => { games: GameListing[]; kinds?: GameKindListing[] },\n\tratings?: { ratings?: Ratings; modes: readonly string[] }\n): boolean {\n\tconst { pathname, searchParams } = new URL(request.url ?? '/', 'http://server')\n\tconst best = options?.ratings ?? '/ratings'\n\tif (best && ratings?.ratings && pathname === best && (request.method === 'GET' || request.method === 'HEAD')) {\n\t\tconst mode = searchParams.get('mode') ?? ratings.modes[0] ?? ''\n\t\tconst count = Math.min(Math.max(Number(searchParams.get('n')) || 10, 1), 100)\n\t\tconst player = searchParams.get('player')\n\t\tconst top = ratings.ratings.top?.(mode, count) ?? []\n\t\tconst own = player ? ratings.ratings.placeOf?.(mode, player) : undefined\n\t\t// read by the pages of a game, wherever they are served from; names are what players chose to be seen by\n\t\tresponse.writeHead(200, { 'content-type': 'application/json', 'cache-control': 'no-store', 'access-control-allow-origin': '*' })\n\t\tresponse.end(JSON.stringify({ mode, modes: ratings.modes, top, ...(own && { player: own }) }))\n\t\treturn true\n\t}\n\tconst health = options?.health ?? '/health'\n\tconst metrics = options?.metrics ?? '/metrics'\n\tconst list = options?.games ?? '/games'\n\tif (request.method !== 'GET' && request.method !== 'HEAD') return false\n\tif (list && games && pathname === list) {\n\t\t// read by the pages of a game, wherever they are served from\n\t\tresponse.writeHead(200, { 'content-type': 'application/json', 'cache-control': 'no-store', 'access-control-allow-origin': '*' })\n\t\tresponse.end(JSON.stringify({ draining: state().draining, ...games() }))\n\t\treturn true\n\t}\n\tif (health && pathname === health) {\n\t\tconst { draining } = state()\n\t\tresponse.writeHead(draining ? 503 : 200, { 'content-type': 'application/json', 'cache-control': 'no-store' })\n\t\tresponse.end(JSON.stringify({ ok: !draining, draining }))\n\t\treturn true\n\t}\n\tif (metrics && pathname === metrics) {\n\t\tif (options?.metricsKey && !sameSecret(request.headers.authorization ?? '', `Bearer ${options.metricsKey}`)) {\n\t\t\tresponse.writeHead(401, { 'content-type': 'text/plain', 'www-authenticate': 'Bearer' })\n\t\t\tresponse.end('The numbers take a key\\n')\n\t\t\treturn true\n\t\t}\n\t\tconst { rooms, draining } = state()\n\t\tif (searchParams.has('json')) {\n\t\t\tresponse.writeHead(200, { 'content-type': 'application/json', 'cache-control': 'no-store' })\n\t\t\tresponse.end(JSON.stringify({ draining, protocol: PROTOCOL_VERSION, memory: memory(), rooms: Object.fromEntries(rooms) }))\n\t\t} else {\n\t\t\tresponse.writeHead(200, { 'content-type': 'text/plain; version=0.0.4', 'cache-control': 'no-store' })\n\t\t\tresponse.end(metricsText(rooms))\n\t\t}\n\t\treturn true\n\t}\n\treturn false\n}\n\n/** A game's result as a file of its own in `dir` (`GameServerOptions.resultsDir`): by when it ended and its mode */\nexport async function writeResult(dir: string, result: GameResult): Promise<void> {\n\tawait mkdir(dir, { recursive: true })\n\tawait writeFile(join(dir, `${Date.now()}-${result.mode.replace(/[^\\w-]/g, '_')}.json`), JSON.stringify(result, null, 2))\n}\n"],"mappings":";;;;;;AA4EA,IAAM,eAAe;CACpB,MAAM,EAAE,KAAK,aAAa,QAAQ,YAAY;CAC9C,OAAO;EAAE;EAAK;CAAS;AACxB;;;;;;AAOA,SAAgB,YAAY,OAAmD;CAC9E,MAAM,QAAkB,CAAC;CACzB,MAAM,QAAQ,MAAc,MAAc,MAA2B,UAA8C;EAClH,MAAM,KAAK,aAAa,KAAK,GAAG,QAAQ,aAAa,KAAK,GAAG,MAAM;EACnE,KAAK,MAAM,CAAC,MAAM,YAAY,OAAO,MAAM,KAAK,MAAM,OAAO,OAAO,SAAS,KAAK,UAAU,IAAI,EAAE,KAAK,GAAG,GAAG,MAAM,OAAO,GAAG;CAC9H;CACA,KAAK,MAAM,qDAAqD,UAAU,MAAO,EAAE,WAAW,IAAI,CAAE;CACpG,KAAK,iBAAiB,qBAAqB,UAAU,MAAM,EAAE,MAAM,OAAO;CAC1E,KAAK,sBAAsB,6BAA6B,YAAY,MAAM,EAAE,MAAM,MAAM;CACxF,KAAK,WAAW,mCAAmC,UAAU,MAAM,EAAE,OAAO;CAC5E,KAAK,YAAY,+BAA+B,UAAU,MAAM,EAAE,QAAQ;CAC1E,KAAK,eAAe,oBAAoB,UAAU,MAAM,EAAE,WAAW;CACrE,KAAK,eAAe,mCAAmC,YAAY,MAAM,EAAE,KAAK;CAChF,KAAK,sBAAsB,0BAA0B,YAAY,MAAM,MAAM,EAAE,WAAW,CAAC;CAC3F,KAAK,qBAAqB,+BAA+B,UAAU,MAAM,MAAM,EAAE,eAAe,CAAC;CACjG,KAAK,eAAe,kCAAkC,YAAY,MAAM,EAAE,KAAK;CAC/E,KAAK,sBAAsB,4BAA4B,YAAY,MAAM,MAAM,EAAE,WAAW,CAAC;CAC7F,KAAK,cAAc,qCAAqC,UAAU,MAAM,EAAE,SAAS;CACnF,KAAK,kBAAkB,4BAA4B,UAAU,MAAM,MAAM,EAAE,MAAM,CAAC;CAClF,MAAM,EAAE,KAAK,aAAa,OAAO;CACjC,MAAM,KAEL,gFACA,oCACA,0BACA,gDACA,gCACA,+BAA+B,OAC/B,gCAAgC,UACjC;CACA,OAAO,GAAG,MAAM,KAAK,IAAI,EAAE;AAC5B;AAEA,IAAM,SAAS,UAAkB,KAAK,MAAM,QAAQ,GAAG,IAAI;;;;;AAM3D,SAAgB,UACf,SACA,UACA,SACA,OACA,OACA,SACU;CACV,MAAM,EAAE,UAAU,iBAAiB,IAAI,IAAI,QAAQ,OAAO,KAAK,eAAe;CAC9E,MAAM,OAAO,SAAS,WAAW;CACjC,IAAI,QAAQ,SAAS,WAAW,aAAa,SAAS,QAAQ,WAAW,SAAS,QAAQ,WAAW,SAAS;EAC7G,MAAM,OAAO,aAAa,IAAI,MAAM,KAAK,QAAQ,MAAM,MAAM;EAC7D,MAAM,QAAQ,KAAK,IAAI,KAAK,IAAI,OAAO,aAAa,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,GAAG,GAAG;EAC5E,MAAM,SAAS,aAAa,IAAI,QAAQ;EACxC,MAAM,MAAM,QAAQ,QAAQ,MAAM,MAAM,KAAK,KAAK,CAAC;EACnD,MAAM,MAAM,SAAS,QAAQ,QAAQ,UAAU,MAAM,MAAM,IAAI,KAAA;EAE/D,SAAS,UAAU,KAAK;GAAE,gBAAgB;GAAoB,iBAAiB;GAAY,+BAA+B;EAAI,CAAC;EAC/H,SAAS,IAAI,KAAK,UAAU;GAAE;GAAM,OAAO,QAAQ;GAAO;GAAK,GAAI,OAAO,EAAE,QAAQ,IAAI;EAAG,CAAC,CAAC;EAC7F,OAAO;CACR;CACA,MAAM,SAAS,SAAS,UAAU;CAClC,MAAM,UAAU,SAAS,WAAW;CACpC,MAAM,OAAO,SAAS,SAAS;CAC/B,IAAI,QAAQ,WAAW,SAAS,QAAQ,WAAW,QAAQ,OAAO;CAClE,IAAI,QAAQ,SAAS,aAAa,MAAM;EAEvC,SAAS,UAAU,KAAK;GAAE,gBAAgB;GAAoB,iBAAiB;GAAY,+BAA+B;EAAI,CAAC;EAC/H,SAAS,IAAI,KAAK,UAAU;GAAE,UAAU,MAAM,CAAC,CAAC;GAAU,GAAG,MAAM;EAAE,CAAC,CAAC;EACvE,OAAO;CACR;CACA,IAAI,UAAU,aAAa,QAAQ;EAClC,MAAM,EAAE,aAAa,MAAM;EAC3B,SAAS,UAAU,WAAW,MAAM,KAAK;GAAE,gBAAgB;GAAoB,iBAAiB;EAAW,CAAC;EAC5G,SAAS,IAAI,KAAK,UAAU;GAAE,IAAI,CAAC;GAAU;EAAS,CAAC,CAAC;EACxD,OAAO;CACR;CACA,IAAI,WAAW,aAAa,SAAS;EACpC,IAAI,SAAS,cAAc,CAAC,WAAW,QAAQ,QAAQ,iBAAiB,IAAI,UAAU,QAAQ,YAAY,GAAG;GAC5G,SAAS,UAAU,KAAK;IAAE,gBAAgB;IAAc,oBAAoB;GAAS,CAAC;GACtF,SAAS,IAAI,0BAA0B;GACvC,OAAO;EACR;EACA,MAAM,EAAE,OAAO,aAAa,MAAM;EAClC,IAAI,aAAa,IAAI,MAAM,GAAG;GAC7B,SAAS,UAAU,KAAK;IAAE,gBAAgB;IAAoB,iBAAiB;GAAW,CAAC;GAC3F,SAAS,IAAI,KAAK,UAAU;IAAE;IAAU,UAAA;IAA4B,QAAQ,OAAO;IAAG,OAAO,OAAO,YAAY,KAAK;GAAE,CAAC,CAAC;EAC1H,OAAO;GACN,SAAS,UAAU,KAAK;IAAE,gBAAgB;IAA6B,iBAAiB;GAAW,CAAC;GACpG,SAAS,IAAI,YAAY,KAAK,CAAC;EAChC;EACA,OAAO;CACR;CACA,OAAO;AACR;;AAGA,eAAsB,YAAY,KAAa,QAAmC;CACjF,MAAM,MAAM,KAAK,EAAE,WAAW,KAAK,CAAC;CACpC,MAAM,UAAU,KAAK,KAAK,GAAG,KAAK,IAAI,EAAE,GAAG,OAAO,KAAK,QAAQ,WAAW,GAAG,EAAE,MAAM,GAAG,KAAK,UAAU,QAAQ,MAAM,CAAC,CAAC;AACxH"}

package/dist/server/packs.d.ts

@@ -1,8 +1,8 @@
-import type { GameModule } from '#engine/game';
+import type { Rules } from '#engine/game';
 import { type PackMod } from '#engine/packs';
 /**
  * The packs of content of a server, read from their files (`packs/<id>/pack.json`) in the order named: that order is
- * the game's, as a page's `defineGame({ packs })` is
+ * the game's, as a page's `createGame({ contentPacks })` is
  *
  * @beta
  */
@@ -12,4 +12,4 @@ export declare function readPacks(files: readonly string[]): PackMod[];
  *
  * @beta
  */
-export declare function withPackFiles(game: GameModule, files: readonly string[]): GameModule;
+export declare function mergePackFiles(game: Rules, files: readonly string[]): Rules;

package/dist/server/packs.js

@@ -0,0 +1,32 @@
+import { composeGame } from "../mods.js";
+import { PackError, checkPackSchema, packFromJson } from "../packs.js";
+import pack_schema_default from "../pack.schema.js";
+import { readFileSync } from "node:fs";
+//#region src/server/packs.ts
+/**
+* The packs of content of a server, read from their files (`packs/<id>/pack.json`) in the order named: that order is
+* the game's, as a page's `createGame({ contentPacks })` is
+*
+* @beta
+*/
+function readPacks(files) {
+	return files.map((file) => {
+		const text = readFileSync(file, "utf8");
+		const pack = packFromJson(text, file);
+		const wrong = checkPackSchema(JSON.parse(text), pack_schema_default);
+		if (wrong) throw new PackError(`${file}: ${wrong}`);
+		return pack;
+	});
+}
+/**
+* A server's game with its packs of content composed in (`readPacks`, `composeGame`): the game as is with none
+*
+* @beta
+*/
+function mergePackFiles(game, files) {
+	return files.length ? composeGame(game, readPacks(files)) : game;
+}
+//#endregion
+export { mergePackFiles, readPacks };
+
+//# sourceMappingURL=packs.js.map

package/dist/server/packs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packs.js","names":["packSchema"],"sources":["../../src/server/packs.ts"],"sourcesContent":["import { readFileSync } from 'node:fs'\nimport type { Rules } from '#engine/game'\nimport { composeGame } from '#engine/mods'\nimport { checkPackSchema, PackError, packFromJson, type PackMod } from '#engine/packs'\n// the pack's schema, in the server's bundle: a server reads packs where a page fetches it with them\nimport packSchema from '../pack.schema.json'\n\n/*\n * A server's packs of content (campaign plan RC6): read from its files, in the order they are named, and composed\n * into the game before any room is made. The host's packs are the game's: a player whose page has others is told as\n * they join (the welcome names the game, `melee+<pack>`, and its hash).\n */\n\n/**\n * The packs of content of a server, read from their files (`packs/<id>/pack.json`) in the order named: that order is\n * the game's, as a page's `createGame({ contentPacks })` is\n *\n * @beta\n */\nexport function readPacks(files: readonly string[]): PackMod[] {\n\treturn files.map((file) => {\n\t\tconst text = readFileSync(file, 'utf8')\n\t\tconst pack = packFromJson(text, file)\n\t\tconst wrong = checkPackSchema(JSON.parse(text), packSchema)\n\t\tif (wrong) throw new PackError(`${file}: ${wrong}`)\n\t\treturn pack\n\t})\n}\n\n/**\n * A server's game with its packs of content composed in (`readPacks`, `composeGame`): the game as is with none\n *\n * @beta\n */\nexport function mergePackFiles(game: Rules, files: readonly string[]): Rules {\n\treturn files.length ? composeGame(game, readPacks(files)) : game\n}\n"],"mappings":";;;;;;;;;;;AAmBA,SAAgB,UAAU,OAAqC;CAC9D,OAAO,MAAM,KAAK,SAAS;EAC1B,MAAM,OAAO,aAAa,MAAM,MAAM;EACtC,MAAM,OAAO,aAAa,MAAM,IAAI;EACpC,MAAM,QAAQ,gBAAgB,KAAK,MAAM,IAAI,GAAGA,mBAAU;EAC1D,IAAI,OAAO,MAAM,IAAI,UAAU,GAAG,KAAK,IAAI,OAAO;EAClD,OAAO;CACR,CAAC;AACF;;;;;;AAOA,SAAgB,eAAe,MAAa,OAAiC;CAC5E,OAAO,MAAM,SAAS,YAAY,MAAM,UAAU,KAAK,CAAC,IAAI;AAC7D"}

package/dist/server/ratings.d.ts

@@ -5,8 +5,11 @@ import type { GameResult } from '#engine/game';
  * @beta
  */
 export interface Rating {
+    /** The player's rating number in the mode, moved by every rated game they finish */
     rating: number;
+    /** How many rated games they have played in the mode */
     games: number;
+    /** How many of those games they won */
     wins: number;
     /** The name they last played by */
     name: string;
@@ -37,7 +40,9 @@ export interface Ratings {
  * @beta
  */
 export interface RatedPlayer extends Rating {
+    /** The player's rated id (`ratedId`), a hash of who they are, never their key */
     id: string;
+    /** Their place among the best, counted from 1 */
     place: number;
 }
 /**

package/dist/server/ratings.js

@@ -0,0 +1,104 @@
+import { createHash } from "node:crypto";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { dirname } from "node:path";
+//#region src/server/ratings.ts
+/**
+* The id a player is rated by: a hash of their key or login id, safe to show and keep. The same key, the same id
+*
+* @beta
+*/
+var ratedId = (key) => createHash("sha256").update(key).digest("hex").slice(0, 16);
+/**
+* Ratings kept in a file (`file`, JSON, read once and written after every game) or in memory: Elo, each side's
+* players against the average of the other's, `k` 32, starting at 1500. The computer counts as `start`, and is not
+* rated; a game with no winner, or with players of one side only, changes nothing
+*
+* @beta
+*/
+function createRatings(options = {}) {
+	const k = options.k ?? 32;
+	const start = options.start ?? 1500;
+	let byMode = {};
+	const ready = (async () => {
+		if (!options.file) return;
+		let text;
+		try {
+			text = await readFile(options.file, "utf8");
+		} catch (error) {
+			if (error.code === "ENOENT") return;
+			throw error;
+		}
+		byMode = JSON.parse(text);
+	})();
+	ready.catch(() => void 0);
+	let writing = Promise.resolve();
+	const keep = () => {
+		if (!options.file) return writing;
+		const file = options.file;
+		writing = writing.then(async () => {
+			await mkdir(dirname(file), { recursive: true });
+			await writeFile(file, JSON.stringify(byMode, null, 1));
+		});
+		return writing;
+	};
+	/** A mode's players, best first: by rating, then by more games, then by id, so the order is always the same */
+	const ranked = (mode) => Object.entries(byMode[mode] ?? {}).sort(([a, x], [b, y]) => y.rating - x.rating || y.games - x.games || (a < b ? -1 : 1)).map(([id, rating], index) => ({
+		id,
+		place: index + 1,
+		...rating
+	}));
+	return {
+		ready,
+		get: (mode, player) => byMode[mode]?.[player],
+		top: (mode, count) => ranked(mode).slice(0, Math.max(0, count)),
+		placeOf: (mode, player) => ranked(mode).find((each) => each.id === player),
+		async record(result) {
+			await ready;
+			if (result.winner === null || result.failed) return;
+			const seats = result.seats.filter((seat) => seat.outcome !== "none");
+			const rated = seats.filter((seat) => !seat.ai && seat.rated);
+			if (!rated.length) return;
+			const table = byMode[result.mode] ??= {};
+			const ratingOf = (seat) => !seat.ai && seat.rated ? table[seat.rated]?.rating ?? start : start;
+			const sides = /* @__PURE__ */ new Map();
+			for (const seat of seats) {
+				const side = seat.outcome;
+				sides.set(side, [...sides.get(side) ?? [], seat]);
+			}
+			const winners = sides.get("victory") ?? [];
+			const losers = sides.get("defeat") ?? [];
+			if (!winners.length || !losers.length) return;
+			const average = (list) => list.reduce((sum, seat) => sum + ratingOf(seat), 0) / list.length;
+			const changes = rated.map((seat) => {
+				const won = seat.outcome === "victory";
+				const theirs = average(won ? losers : winners);
+				const mine = ratingOf(seat);
+				const expected = 1 / (1 + 10 ** ((theirs - mine) / 400));
+				return {
+					seat,
+					won,
+					next: mine + k * ((won ? 1 : 0) - expected)
+				};
+			});
+			for (const { seat, won, next } of changes) {
+				const before = table[seat.rated] ?? {
+					rating: start,
+					games: 0,
+					wins: 0,
+					name: seat.name
+				};
+				table[seat.rated] = {
+					rating: Math.round(next),
+					games: before.games + 1,
+					wins: before.wins + (won ? 1 : 0),
+					name: seat.name
+				};
+			}
+			await keep();
+		}
+	};
+}
+//#endregion
+export { createRatings, ratedId };
+
+//# sourceMappingURL=ratings.js.map

package/dist/server/ratings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ratings.js","names":[],"sources":["../../src/server/ratings.ts"],"sourcesContent":["import { createHash } from 'node:crypto'\nimport { mkdir, readFile, writeFile } from 'node:fs/promises'\nimport { dirname } from 'node:path'\nimport type { GameResult } from '#engine/game'\n\n/*\n * Ranks (features-plan H4): a rating for each player in each mode, Elo, kept by the server from the results of its\n * games. There are no accounts: a player is who brings the same key (`join`'s `who`, kept in their browser), or who a\n * login says they are (`SeatAnswer.id`); what is kept and shown is a hash of it (`ratedId`), never the key\n */\n\n/**\n * A player's standing in a mode\n *\n * @beta\n */\nexport interface Rating {\n\t/** The player's rating number in the mode, moved by every rated game they finish */\n\trating: number\n\t/** How many rated games they have played in the mode */\n\tgames: number\n\t/** How many of those games they won */\n\twins: number\n\t/** The name they last played by */\n\tname: string\n}\n\n/**\n * Where a server keeps ratings (`GameServerOptions.ratings`): what it reads to show in the lobby and the list, and\n * what it tells of every game that ended. `createRatings` keeps them in a file, or in memory; a game's own keeps them\n * where it likes (a database)\n *\n * @beta\n */\nexport interface Ratings {\n\t/** A player's standing in a mode, by their rated id (`ratedId`): none for one who never played it */\n\tget(mode: string, player: string): Rating | undefined\n\t/** Takes in a game that ended: the rated seats' ratings move by how it went, against what was expected */\n\trecord(result: GameResult): void | Promise<void>\n\t/**\n\t * The best of a mode, best first, with their rated ids and places (from 1): what `/ratings` lists. A store with none\n\t * lists nothing @beta\n\t */\n\ttop?(mode: string, count: number): RatedPlayer[]\n\t/** A player's place in a mode (from 1), with their standing: none for one who never played it @beta */\n\tplaceOf?(mode: string, player: string): RatedPlayer | undefined\n}\n\n/**\n * A player in a list of the best: their standing, their rated id (`ratedId`), and their place, from 1\n *\n * @beta\n */\nexport interface RatedPlayer extends Rating {\n\t/** The player's rated id (`ratedId`), a hash of who they are, never their key */\n\tid: string\n\t/** Their place among the best, counted from 1 */\n\tplace: number\n}\n\n/**\n * The id a player is rated by: a hash of their key or login id, safe to show and keep. The same key, the same id\n *\n * @beta\n */\nexport const ratedId = (key: string): string => createHash('sha256').update(key).digest('hex').slice(0, 16)\n\n/**\n * Ratings kept in a file (`file`, JSON, read once and written after every game) or in memory: Elo, each side's\n * players against the average of the other's, `k` 32, starting at 1500. The computer counts as `start`, and is not\n * rated; a game with no winner, or with players of one side only, changes nothing\n *\n * @beta\n */\nexport function createRatings(options: { file?: string; k?: number; start?: number } = {}): Ratings & { ready: Promise<void> } {\n\tconst k = options.k ?? 32\n\tconst start = options.start ?? 1500\n\tlet byMode: Record<string, Record<string, Rating>> = {}\n\tconst ready = (async () => {\n\t\tif (!options.file) return\n\t\t// none yet: empty. One that cannot be read is not written over, nor started from empty: it says so\n\t\tlet text: string\n\t\ttry {\n\t\t\ttext = await readFile(options.file, 'utf8')\n\t\t} catch (error) {\n\t\t\tif ((error as NodeJS.ErrnoException).code === 'ENOENT') return\n\t\t\tthrow error\n\t\t}\n\t\tbyMode = JSON.parse(text)\n\t})()\n\t// told to whoever waits for it (`ready`, `record`), not to the process as a rejection nobody heard\n\tready.catch(() => undefined)\n\tlet writing = Promise.resolve()\n\tconst keep = () => {\n\t\tif (!options.file) return writing\n\t\tconst file = options.file\n\t\twriting = writing.then(async () => {\n\t\t\tawait mkdir(dirname(file), { recursive: true })\n\t\t\tawait writeFile(file, JSON.stringify(byMode, null, 1))\n\t\t})\n\t\treturn writing\n\t}\n\t/** A mode's players, best first: by rating, then by more games, then by id, so the order is always the same */\n\tconst ranked = (mode: string): RatedPlayer[] =>\n\t\tObject.entries(byMode[mode] ?? {})\n\t\t\t.sort(([a, x], [b, y]) => y.rating - x.rating || y.games - x.games || (a < b ? -1 : 1))\n\t\t\t.map(([id, rating], index) => ({ id, place: index + 1, ...rating }))\n\treturn {\n\t\tready,\n\t\tget: (mode, player) => byMode[mode]?.[player],\n\t\ttop: (mode, count) => ranked(mode).slice(0, Math.max(0, count)),\n\t\tplaceOf: (mode, player) => ranked(mode).find((each) => each.id === player),\n\t\tasync record(result) {\n\t\t\tawait ready\n\t\t\tif (result.winner === null || result.failed) return\n\t\t\tconst seats = result.seats.filter((seat) => seat.outcome !== 'none')\n\t\t\tconst rated = seats.filter((seat) => !seat.ai && seat.rated)\n\t\t\tif (!rated.length) return\n\t\t\tconst table = (byMode[result.mode] ??= {})\n\t\t\tconst ratingOf = (seat: (typeof seats)[number]) => (!seat.ai && seat.rated ? (table[seat.rated]?.rating ?? start) : start)\n\t\t\tconst sides = new Map<string, (typeof seats)[number][]>()\n\t\t\tfor (const seat of seats) {\n\t\t\t\tconst side = seat.outcome\n\t\t\t\tsides.set(side, [...(sides.get(side) ?? []), seat])\n\t\t\t}\n\t\t\tconst winners = sides.get('victory') ?? []\n\t\t\tconst losers = sides.get('defeat') ?? []\n\t\t\tif (!winners.length || !losers.length) return\n\t\t\tconst average = (list: typeof seats) => list.reduce((sum, seat) => sum + ratingOf(seat), 0) / list.length\n\t\t\tconst changes = rated.map((seat) => {\n\t\t\t\tconst won = seat.outcome === 'victory'\n\t\t\t\tconst theirs = average(won ? losers : winners)\n\t\t\t\tconst mine = ratingOf(seat)\n\t\t\t\tconst expected = 1 / (1 + 10 ** ((theirs - mine) / 400))\n\t\t\t\treturn { seat, won, next: mine + k * ((won ? 1 : 0) - expected) }\n\t\t\t})\n\t\t\tfor (const { seat, won, next } of changes) {\n\t\t\t\tconst before = table[seat.rated!] ?? { rating: start, games: 0, wins: 0, name: seat.name }\n\t\t\t\ttable[seat.rated!] = { rating: Math.round(next), games: before.games + 1, wins: before.wins + (won ? 1 : 0), name: seat.name }\n\t\t\t}\n\t\t\tawait keep()\n\t\t}\n\t}\n}\n"],"mappings":";;;;;;;;;AAiEA,IAAa,WAAW,QAAwB,WAAW,QAAQ,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,GAAG,EAAE;;;;;;;;AAS1G,SAAgB,cAAc,UAAyD,CAAC,GAAuC;CAC9H,MAAM,IAAI,QAAQ,KAAK;CACvB,MAAM,QAAQ,QAAQ,SAAS;CAC/B,IAAI,SAAiD,CAAC;CACtD,MAAM,SAAS,YAAY;EAC1B,IAAI,CAAC,QAAQ,MAAM;EAEnB,IAAI;EACJ,IAAI;GACH,OAAO,MAAM,SAAS,QAAQ,MAAM,MAAM;EAC3C,SAAS,OAAO;GACf,IAAK,MAAgC,SAAS,UAAU;GACxD,MAAM;EACP;EACA,SAAS,KAAK,MAAM,IAAI;CACzB,EAAA,CAAG;CAEH,MAAM,YAAY,KAAA,CAAS;CAC3B,IAAI,UAAU,QAAQ,QAAQ;CAC9B,MAAM,aAAa;EAClB,IAAI,CAAC,QAAQ,MAAM,OAAO;EAC1B,MAAM,OAAO,QAAQ;EACrB,UAAU,QAAQ,KAAK,YAAY;GAClC,MAAM,MAAM,QAAQ,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;GAC9C,MAAM,UAAU,MAAM,KAAK,UAAU,QAAQ,MAAM,CAAC,CAAC;EACtD,CAAC;EACD,OAAO;CACR;;CAEA,MAAM,UAAU,SACf,OAAO,QAAQ,OAAO,SAAS,CAAC,CAAC,CAAC,CAChC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,IAAI,IAAI,KAAK,EAAE,CAAC,CACtF,KAAK,CAAC,IAAI,SAAS,WAAW;EAAE;EAAI,OAAO,QAAQ;EAAG,GAAG;CAAO,EAAE;CACrE,OAAO;EACN;EACA,MAAM,MAAM,WAAW,OAAO,KAAK,GAAG;EACtC,MAAM,MAAM,UAAU,OAAO,IAAI,CAAC,CAAC,MAAM,GAAG,KAAK,IAAI,GAAG,KAAK,CAAC;EAC9D,UAAU,MAAM,WAAW,OAAO,IAAI,CAAC,CAAC,MAAM,SAAS,KAAK,OAAO,MAAM;EACzE,MAAM,OAAO,QAAQ;GACpB,MAAM;GACN,IAAI,OAAO,WAAW,QAAQ,OAAO,QAAQ;GAC7C,MAAM,QAAQ,OAAO,MAAM,QAAQ,SAAS,KAAK,YAAY,MAAM;GACnE,MAAM,QAAQ,MAAM,QAAQ,SAAS,CAAC,KAAK,MAAM,KAAK,KAAK;GAC3D,IAAI,CAAC,MAAM,QAAQ;GACnB,MAAM,QAAS,OAAO,OAAO,UAAU,CAAC;GACxC,MAAM,YAAY,SAAkC,CAAC,KAAK,MAAM,KAAK,QAAS,MAAM,KAAK,MAAM,EAAE,UAAU,QAAS;GACpH,MAAM,wBAAQ,IAAI,IAAsC;GACxD,KAAK,MAAM,QAAQ,OAAO;IACzB,MAAM,OAAO,KAAK;IAClB,MAAM,IAAI,MAAM,CAAC,GAAI,MAAM,IAAI,IAAI,KAAK,CAAC,GAAI,IAAI,CAAC;GACnD;GACA,MAAM,UAAU,MAAM,IAAI,SAAS,KAAK,CAAC;GACzC,MAAM,SAAS,MAAM,IAAI,QAAQ,KAAK,CAAC;GACvC,IAAI,CAAC,QAAQ,UAAU,CAAC,OAAO,QAAQ;GACvC,MAAM,WAAW,SAAuB,KAAK,QAAQ,KAAK,SAAS,MAAM,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK;GACnG,MAAM,UAAU,MAAM,KAAK,SAAS;IACnC,MAAM,MAAM,KAAK,YAAY;IAC7B,MAAM,SAAS,QAAQ,MAAM,SAAS,OAAO;IAC7C,MAAM,OAAO,SAAS,IAAI;IAC1B,MAAM,WAAW,KAAK,IAAI,QAAQ,SAAS,QAAQ;IACnD,OAAO;KAAE;KAAM;KAAK,MAAM,OAAO,MAAM,MAAM,IAAI,KAAK;IAAU;GACjE,CAAC;GACD,KAAK,MAAM,EAAE,MAAM,KAAK,UAAU,SAAS;IAC1C,MAAM,SAAS,MAAM,KAAK,UAAW;KAAE,QAAQ;KAAO,OAAO;KAAG,MAAM;KAAG,MAAM,KAAK;IAAK;IACzF,MAAM,KAAK,SAAU;KAAE,QAAQ,KAAK,MAAM,IAAI;KAAG,OAAO,OAAO,QAAQ;KAAG,MAAM,OAAO,QAAQ,MAAM,IAAI;KAAI,MAAM,KAAK;IAAK;GAC9H;GACA,MAAM,KAAK;EACZ;CACD;AACD"}

package/dist/server/relay.d.ts

@@ -1,14 +1,23 @@
 import type { Logger } from '#engine/log';
 import { type ServerLog } from './log';
-/** @beta */
+/**
+ * What a `WatchRelay` is started with: the port, compression and the log
+ *
+ * @beta
+ */
 export interface RelayOptions {
     /** Port to listen on: 0 for any free one */
     port: number;
+    /** Whether to compress what goes over connections whose other end can take it (`permessage-deflate`); yes when left out */
     compress?: boolean;
     /** Where it says what it does, as `GameServerOptions.log` */
     log?: ServerLog;
 }
-/** @beta */
+/**
+ * A server that relays a game from the one who shares it to the watchers who connect to it
+ *
+ * @beta
+ */
 export declare class WatchRelay {
     private readonly socket;
     private readonly shares;
@@ -19,6 +28,7 @@ export declare class WatchRelay {
     private constructor();
     /** Starts a relay, and resolves once it listens */
     static start(options: RelayOptions): Promise<WatchRelay>;
+    /** The port the relay listens on, the real one where 0 was asked for */
     get port(): number;
     /** How many watch what is shared under a key */
     watching(key: string): number;

package/dist/server/relay.js

@@ -0,0 +1,144 @@
+import { readMessage } from "../session/protocol.js";
+import { serverLogger } from "./log.js";
+import { startSocketServer } from "./websocket.js";
+//#region src/server/relay.ts
+/**
+* A server that relays a game from the one who shares it to the watchers who connect to it
+*
+* @beta
+*/
+var WatchRelay = class WatchRelay {
+	socket;
+	shares = /* @__PURE__ */ new Map();
+	watchers = /* @__PURE__ */ new Map();
+	next = 1;
+	/** What the relay says: see `RelayOptions.log` */
+	logger;
+	constructor(socket, options) {
+		this.socket = socket;
+		this.logger = serverLogger(options.log);
+		socket.onConnection((connection) => this.accept(connection));
+	}
+	/** Starts a relay, and resolves once it listens */
+	static async start(options) {
+		const socket = await startSocketServer({
+			port: options.port,
+			compress: options.compress,
+			maxMessage: 16777216
+		});
+		const relay = new WatchRelay(socket, options);
+		relay.logger.info("server", `a relay for games watched, on port ${socket.port}`, { port: socket.port });
+		return relay;
+	}
+	/** The port the relay listens on, the real one where 0 was asked for */
+	get port() {
+		return this.socket.port;
+	}
+	/** How many watch what is shared under a key */
+	watching(key) {
+		return [...this.watchers.values()].filter((watcher) => watcher.key === key).length;
+	}
+	accept(connection) {
+		let role;
+		connection.onMessage((text) => {
+			if (role && "watcher" in role) return this.fromWatcher(role.watcher, text);
+			const message = readMessage(text);
+			if (!message) return;
+			if (!role && message.type === "share") {
+				if (typeof message.key === "string" && typeof message.name === "string") role = this.share(connection, {
+					type: "share",
+					key: message.key,
+					name: message.name
+				});
+			} else if (!role && message.type === "watch") {
+				if (typeof message.key === "string") role = { watcher: this.watch(connection, message.key) };
+			} else if (role && "share" in role && message.type === "send" && typeof message.to === "number" && typeof message.text === "string") {
+				const watcher = this.watchers.get(message.to);
+				if (watcher?.key === role.share.key) watcher.connection.send(message.text);
+			}
+		});
+		connection.onClose(() => {
+			if (role && "share" in role) this.unshare(role.share);
+			else if (role && "watcher" in role) this.leave(role.watcher);
+		});
+	}
+	tell(connection, notice) {
+		connection.send(JSON.stringify(notice));
+	}
+	share(host, message) {
+		if (this.shares.has(message.key)) {
+			this.tell(host, {
+				type: "taken",
+				key: message.key
+			});
+			return;
+		}
+		const share = {
+			key: message.key,
+			name: message.name.slice(0, 80),
+			host
+		};
+		this.shares.set(share.key, share);
+		this.tell(host, {
+			type: "shared",
+			key: share.key
+		});
+		this.logger.info("server", `${share.name} is shared under ${share.key}`, { name: share.name });
+		for (const watcher of this.watchers.values()) if (watcher.key === share.key) this.tell(host, {
+			type: "watcher",
+			id: watcher.id
+		});
+		return { share };
+	}
+	unshare(share) {
+		if (this.shares.get(share.key) !== share) return;
+		this.shares.delete(share.key);
+		this.logger.info("server", `${share.name} is no longer shared`, { name: share.name });
+		for (const watcher of this.watchers.values()) if (watcher.key === share.key) this.tell(watcher.connection, {
+			type: "ended",
+			key: share.key
+		});
+	}
+	watch(connection, key) {
+		const watcher = {
+			id: this.next++,
+			connection,
+			key
+		};
+		this.watchers.set(watcher.id, watcher);
+		const share = this.shares.get(key);
+		if (share) this.tell(share.host, {
+			type: "watcher",
+			id: watcher.id
+		});
+		else this.tell(connection, {
+			type: "waiting",
+			key
+		});
+		return watcher;
+	}
+	fromWatcher(watcher, text) {
+		const share = this.shares.get(watcher.key);
+		if (share) this.tell(share.host, {
+			type: "from",
+			watcher: watcher.id,
+			text
+		});
+	}
+	leave(watcher) {
+		if (!this.watchers.delete(watcher.id)) return;
+		const share = this.shares.get(watcher.key);
+		if (share) this.tell(share.host, {
+			type: "gone",
+			watcher: watcher.id
+		});
+	}
+	/** Stops the relay: every connection closed */
+	async close() {
+		await this.socket.close();
+	}
+};
+//#endregion
+export { WatchRelay };
+
+//# sourceMappingURL=relay.js.map

package/dist/server/relay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relay.js","names":[],"sources":["../../src/server/relay.ts"],"sourcesContent":["import type { Logger } from '#engine/log'\nimport { type ServerLog, serverLogger } from './log'\nimport { readMessage } from '#engine/session/protocol'\nimport type { RelayNotice, RelayRequest } from '#engine/session/share'\nimport { type Connection, type SocketServer, startSocketServer } from './websocket'\n\n/*\n * A relay for games played in a page and watched from others. A page cannot take connections, so the one that plays\n * shares its game here (`share`, under a key like the campaign's id), and those who watch ask for it by that key\n * (`watch`). The relay only passes text along (`RelayRequest`, `RelayNotice`): the playing page's host makes each\n * watcher's game, as a server does for its observers (`shareGame`), and the relay hands it to the watcher as it came,\n * and the watcher's answers back. A watcher who comes before the game is shared, or stays after it ends (a mission\n * over, the next one loading), waits for it under its key, and is let in again when it is shared anew\n */\n\ninterface Share {\n\tkey: string\n\tname: string\n\thost: Connection\n}\n\ninterface Watcher {\n\tid: number\n\tconnection: Connection\n\tkey: string\n}\n\n/**\n * What a `WatchRelay` is started with: the port, compression and the log\n *\n * @beta\n */\nexport interface RelayOptions {\n\t/** Port to listen on: 0 for any free one */\n\tport: number\n\t/** Whether to compress what goes over connections whose other end can take it (`permessage-deflate`); yes when left out */\n\tcompress?: boolean\n\t/** Where it says what it does, as `GameServerOptions.log` */\n\tlog?: ServerLog\n}\n\n/**\n * A server that relays a game from the one who shares it to the watchers who connect to it\n *\n * @beta\n */\nexport class WatchRelay {\n\tprivate readonly shares = new Map<string, Share>()\n\tprivate readonly watchers = new Map<number, Watcher>()\n\tprivate next = 1\n\n\t/** What the relay says: see `RelayOptions.log` */\n\treadonly logger: Logger\n\n\tprivate constructor(\n\t\tprivate readonly socket: SocketServer,\n\t\toptions: RelayOptions\n\t) {\n\t\tthis.logger = serverLogger(options.log)\n\t\tsocket.onConnection((connection) => this.accept(connection))\n\t}\n\n\t/** Starts a relay, and resolves once it listens */\n\tstatic async start(options: RelayOptions): Promise<WatchRelay> {\n\t\t// a whole map goes through as one message, to each watcher who comes\n\t\tconst socket = await startSocketServer({ port: options.port, compress: options.compress, maxMessage: 16 * 1024 * 1024 })\n\t\tconst relay = new WatchRelay(socket, options)\n\t\trelay.logger.info('server', `a relay for games watched, on port ${socket.port}`, { port: socket.port })\n\t\treturn relay\n\t}\n\n\t/** The port the relay listens on, the real one where 0 was asked for */\n\tget port(): number {\n\t\treturn this.socket.port\n\t}\n\n\t/** How many watch what is shared under a key */\n\twatching(key: string): number {\n\t\treturn [...this.watchers.values()].filter((watcher) => watcher.key === key).length\n\t}\n\n\tprivate accept(connection: Connection): void {\n\t\tlet role: { share: Share } | { watcher: Watcher } | undefined\n\t\tconnection.onMessage((text) => {\n\t\t\t// what a watcher says goes to the game it watches, as it is\n\t\t\tif (role && 'watcher' in role) return this.fromWatcher(role.watcher, text)\n\t\t\t// anyone can connect and send anything: what is not as it should be is dropped\n\t\t\tconst message = readMessage(text)\n\t\t\tif (!message) return\n\t\t\tif (!role && message.type === 'share') {\n\t\t\t\tif (typeof message.key === 'string' && typeof message.name === 'string')\n\t\t\t\t\trole = this.share(connection, { type: 'share', key: message.key, name: message.name })\n\t\t\t} else if (!role && message.type === 'watch') {\n\t\t\t\tif (typeof message.key === 'string') role = { watcher: this.watch(connection, message.key) }\n\t\t\t} else if (role && 'share' in role && message.type === 'send' && typeof message.to === 'number' && typeof message.text === 'string') {\n\t\t\t\t// only to who watches this share: a game shared under one key says nothing to the watchers of another\n\t\t\t\tconst watcher = this.watchers.get(message.to)\n\t\t\t\tif (watcher?.key === role.share.key) watcher.connection.send(message.text)\n\t\t\t}\n\t\t})\n\t\tconnection.onClose(() => {\n\t\t\tif (role && 'share' in role) this.unshare(role.share)\n\t\t\telse if (role && 'watcher' in role) this.leave(role.watcher)\n\t\t})\n\t}\n\n\tprivate tell(connection: Connection, notice: RelayNotice): void {\n\t\tconnection.send(JSON.stringify(notice))\n\t}\n\n\tprivate share(host: Connection, message: Extract<RelayRequest, { type: 'share' }>): { share: Share } | undefined {\n\t\tif (this.shares.has(message.key)) {\n\t\t\tthis.tell(host, { type: 'taken', key: message.key })\n\t\t\treturn undefined\n\t\t}\n\t\tconst share: Share = { key: message.key, name: message.name.slice(0, 80), host }\n\t\tthis.shares.set(share.key, share)\n\t\tthis.tell(host, { type: 'shared', key: share.key })\n\t\tthis.logger.info('server', `${share.name} is shared under ${share.key}`, { name: share.name })\n\t\t// those who waited for it\n\t\tfor (const watcher of this.watchers.values()) if (watcher.key === share.key) this.tell(host, { type: 'watcher', id: watcher.id })\n\t\treturn { share }\n\t}\n\n\tprivate unshare(share: Share): void {\n\t\tif (this.shares.get(share.key) !== share) return\n\t\tthis.shares.delete(share.key)\n\t\tthis.logger.info('server', `${share.name} is no longer shared`, { name: share.name })\n\t\tfor (const watcher of this.watchers.values()) if (watcher.key === share.key) this.tell(watcher.connection, { type: 'ended', key: share.key })\n\t}\n\n\tprivate watch(connection: Connection, key: string): Watcher {\n\t\tconst watcher: Watcher = { id: this.next++, connection, key }\n\t\tthis.watchers.set(watcher.id, watcher)\n\t\tconst share = this.shares.get(key)\n\t\tif (share) this.tell(share.host, { type: 'watcher', id: watcher.id })\n\t\telse this.tell(connection, { type: 'waiting', key })\n\t\treturn watcher\n\t}\n\n\tprivate fromWatcher(watcher: Watcher, text: string): void {\n\t\tconst share = this.shares.get(watcher.key)\n\t\tif (share) this.tell(share.host, { type: 'from', watcher: watcher.id, text })\n\t}\n\n\tprivate leave(watcher: Watcher): void {\n\t\tif (!this.watchers.delete(watcher.id)) return\n\t\tconst share = this.shares.get(watcher.key)\n\t\tif (share) this.tell(share.host, { type: 'gone', watcher: watcher.id })\n\t}\n\n\t/** Stops the relay: every connection closed */\n\tasync close(): Promise<void> {\n\t\tawait this.socket.close()\n\t}\n}\n"],"mappings":";;;;;;;;;AA8CA,IAAa,aAAb,MAAa,WAAW;CASL;CARlB,yBAA0B,IAAI,IAAmB;CACjD,2BAA4B,IAAI,IAAqB;CACrD,OAAe;;CAGf;CAEA,YACC,QACA,SACC;EAFgB,KAAA,SAAA;EAGjB,KAAK,SAAS,aAAa,QAAQ,GAAG;EACtC,OAAO,cAAc,eAAe,KAAK,OAAO,UAAU,CAAC;CAC5D;;CAGA,aAAa,MAAM,SAA4C;EAE9D,MAAM,SAAS,MAAM,kBAAkB;GAAE,MAAM,QAAQ;GAAM,UAAU,QAAQ;GAAU,YAAY;EAAiB,CAAC;EACvH,MAAM,QAAQ,IAAI,WAAW,QAAQ,OAAO;EAC5C,MAAM,OAAO,KAAK,UAAU,sCAAsC,OAAO,QAAQ,EAAE,MAAM,OAAO,KAAK,CAAC;EACtG,OAAO;CACR;;CAGA,IAAI,OAAe;EAClB,OAAO,KAAK,OAAO;CACpB;;CAGA,SAAS,KAAqB;EAC7B,OAAO,CAAC,GAAG,KAAK,SAAS,OAAO,CAAC,CAAC,CAAC,QAAQ,YAAY,QAAQ,QAAQ,GAAG,CAAC,CAAC;CAC7E;CAEA,OAAe,YAA8B;EAC5C,IAAI;EACJ,WAAW,WAAW,SAAS;GAE9B,IAAI,QAAQ,aAAa,MAAM,OAAO,KAAK,YAAY,KAAK,SAAS,IAAI;GAEzE,MAAM,UAAU,YAAY,IAAI;GAChC,IAAI,CAAC,SAAS;GACd,IAAI,CAAC,QAAQ,QAAQ,SAAS,SACzB;QAAA,OAAO,QAAQ,QAAQ,YAAY,OAAO,QAAQ,SAAS,UAC9D,OAAO,KAAK,MAAM,YAAY;KAAE,MAAM;KAAS,KAAK,QAAQ;KAAK,MAAM,QAAQ;IAAK,CAAC;GAAA,OAChF,IAAI,CAAC,QAAQ,QAAQ,SAAS,SAChC;QAAA,OAAO,QAAQ,QAAQ,UAAU,OAAO,EAAE,SAAS,KAAK,MAAM,YAAY,QAAQ,GAAG,EAAE;GAAA,OACrF,IAAI,QAAQ,WAAW,QAAQ,QAAQ,SAAS,UAAU,OAAO,QAAQ,OAAO,YAAY,OAAO,QAAQ,SAAS,UAAU;IAEpI,MAAM,UAAU,KAAK,SAAS,IAAI,QAAQ,EAAE;IAC5C,IAAI,SAAS,QAAQ,KAAK,MAAM,KAAK,QAAQ,WAAW,KAAK,QAAQ,IAAI;GAC1E;EACD,CAAC;EACD,WAAW,cAAc;GACxB,IAAI,QAAQ,WAAW,MAAM,KAAK,QAAQ,KAAK,KAAK;QAC/C,IAAI,QAAQ,aAAa,MAAM,KAAK,MAAM,KAAK,OAAO;EAC5D,CAAC;CACF;CAEA,KAAa,YAAwB,QAA2B;EAC/D,WAAW,KAAK,KAAK,UAAU,MAAM,CAAC;CACvC;CAEA,MAAc,MAAkB,SAAiF;EAChH,IAAI,KAAK,OAAO,IAAI,QAAQ,GAAG,GAAG;GACjC,KAAK,KAAK,MAAM;IAAE,MAAM;IAAS,KAAK,QAAQ;GAAI,CAAC;GACnD;EACD;EACA,MAAM,QAAe;GAAE,KAAK,QAAQ;GAAK,MAAM,QAAQ,KAAK,MAAM,GAAG,EAAE;GAAG;EAAK;EAC/E,KAAK,OAAO,IAAI,MAAM,KAAK,KAAK;EAChC,KAAK,KAAK,MAAM;GAAE,MAAM;GAAU,KAAK,MAAM;EAAI,CAAC;EAClD,KAAK,OAAO,KAAK,UAAU,GAAG,MAAM,KAAK,mBAAmB,MAAM,OAAO,EAAE,MAAM,MAAM,KAAK,CAAC;EAE7F,KAAK,MAAM,WAAW,KAAK,SAAS,OAAO,GAAG,IAAI,QAAQ,QAAQ,MAAM,KAAK,KAAK,KAAK,MAAM;GAAE,MAAM;GAAW,IAAI,QAAQ;EAAG,CAAC;EAChI,OAAO,EAAE,MAAM;CAChB;CAEA,QAAgB,OAAoB;EACnC,IAAI,KAAK,OAAO,IAAI,MAAM,GAAG,MAAM,OAAO;EAC1C,KAAK,OAAO,OAAO,MAAM,GAAG;EAC5B,KAAK,OAAO,KAAK,UAAU,GAAG,MAAM,KAAK,uBAAuB,EAAE,MAAM,MAAM,KAAK,CAAC;EACpF,KAAK,MAAM,WAAW,KAAK,SAAS,OAAO,GAAG,IAAI,QAAQ,QAAQ,MAAM,KAAK,KAAK,KAAK,QAAQ,YAAY;GAAE,MAAM;GAAS,KAAK,MAAM;EAAI,CAAC;CAC7I;CAEA,MAAc,YAAwB,KAAsB;EAC3D,MAAM,UAAmB;GAAE,IAAI,KAAK;GAAQ;GAAY;EAAI;EAC5D,KAAK,SAAS,IAAI,QAAQ,IAAI,OAAO;EACrC,MAAM,QAAQ,KAAK,OAAO,IAAI,GAAG;EACjC,IAAI,OAAO,KAAK,KAAK,MAAM,MAAM;GAAE,MAAM;GAAW,IAAI,QAAQ;EAAG,CAAC;OAC/D,KAAK,KAAK,YAAY;GAAE,MAAM;GAAW;EAAI,CAAC;EACnD,OAAO;CACR;CAEA,YAAoB,SAAkB,MAAoB;EACzD,MAAM,QAAQ,KAAK,OAAO,IAAI,QAAQ,GAAG;EACzC,IAAI,OAAO,KAAK,KAAK,MAAM,MAAM;GAAE,MAAM;GAAQ,SAAS,QAAQ;GAAI;EAAK,CAAC;CAC7E;CAEA,MAAc,SAAwB;EACrC,IAAI,CAAC,KAAK,SAAS,OAAO,QAAQ,EAAE,GAAG;EACvC,MAAM,QAAQ,KAAK,OAAO,IAAI,QAAQ,GAAG;EACzC,IAAI,OAAO,KAAK,KAAK,MAAM,MAAM;GAAE,MAAM;GAAQ,SAAS,QAAQ;EAAG,CAAC;CACvE;;CAGA,MAAM,QAAuB;EAC5B,MAAM,KAAK,OAAO,MAAM;CACzB;AACD"}