@jgengine/ws 0.7.0 → 0.9.0

package/dist/host.js

@@ -0,0 +1,454 @@
+import { createGameRuntime } from "@jgengine/core/runtime/gameRuntime";
+import { applyLeaderboardRows, buildHydratePlayers, planServerPersist, profileLeaderboardStats, shouldAutoSave, topLeaderboardRows, toOpenServerListings, toServerListing, trimFeedEntries, } from "@jgengine/core/runtime/hostPersistence";
+import { browseSessions, findByJoinCode } from "@jgengine/core/multiplayer/matchmaking";
+import { createFeedWriteGate, validateFeedWrite, } from "@jgengine/core/multiplayer/feedWriteGate";
+import { clearDirtyFlags, createEmptyServerRow, splitProfilePlayer } from "@jgengine/core/runtime/snapshot";
+const builtinCommands = {
+    "engine.ping": {
+        validate: () => null,
+        apply: (snapshot) => snapshot,
+    },
+};
+export function createGameHost(options) {
+    const now = options.now ?? Date.now;
+    const tickMs = options.tickMs ?? 1_000;
+    const defaultSlots = options.slotsPerServer ?? 16;
+    const createServerId = options.createServerId ?? (() => `srv-${crypto.randomUUID()}`);
+    const persistence = options.persistence;
+    const feedWriteGate = createFeedWriteGate(options.allowedFeedActions ?? []);
+    const runtimes = new Map();
+    for (const runtime of options.runtimes ?? []) {
+        runtimes.set(runtime.gameId, runtime);
+    }
+    const resolveRuntime = (gameId) => {
+        const existing = runtimes.get(gameId);
+        if (existing)
+            return existing;
+        const fallback = createGameRuntime({ gameId, save: "none", commands: builtinCommands });
+        runtimes.set(gameId, fallback);
+        return fallback;
+    };
+    const live = new Map();
+    const listeners = new Set();
+    const emit = (event) => {
+        for (const listener of listeners)
+            listener(event);
+    };
+    let queue = Promise.resolve();
+    const enqueue = (operation) => {
+        const run = queue.then(operation);
+        queue = run.catch(() => undefined);
+        return run;
+    };
+    const hydrate = async (record) => {
+        const runtime = resolveRuntime(record.gameId);
+        const profiles = {};
+        for (const userId of record.memberUserIds) {
+            profiles[userId] = await persistence.loadProfile({ userId, gameId: record.gameId });
+        }
+        const chunkRecords = await persistence.loadChunks(record.serverId);
+        const chunksByKey = {};
+        for (const chunk of chunkRecords) {
+            chunksByKey[chunk.chunkKey] = chunk.snapshot;
+        }
+        const snapshot = runtime.hydrate({
+            gameId: record.gameId,
+            serverId: record.serverId,
+            serverRow: record.serverState,
+            playersByUserId: buildHydratePlayers(record, profiles),
+            chunksByKey,
+            revision: record.revision,
+        });
+        const existing = live.get(record.serverId);
+        if (existing)
+            return existing;
+        const entry = { record, snapshot };
+        live.set(record.serverId, entry);
+        return entry;
+    };
+    const getLive = async (serverId) => {
+        const existing = live.get(serverId);
+        if (existing)
+            return existing;
+        const record = await persistence.loadServer(serverId);
+        if (record === null)
+            return null;
+        return hydrate(record);
+    };
+    const flushServer = async (entry) => {
+        const timestamp = now();
+        const plan = planServerPersist(entry.record, entry.snapshot, entry.record.save, timestamp);
+        const cleared = { ...plan, server: { ...plan.server, dirtyAt: undefined } };
+        if (persistence.savePlan) {
+            await persistence.savePlan(cleared);
+        }
+        else {
+            if (cleared.leaderboard.length > 0) {
+                await persistence.applyLeaderboardIncrements(entry.record.gameId, cleared.leaderboard);
+            }
+            for (const profile of cleared.profiles) {
+                await persistence.saveProfile(profile);
+            }
+            if (cleared.chunks.length > 0) {
+                await persistence.saveChunks(entry.record.serverId, cleared.chunks);
+            }
+            if (cleared.deletedChunks.length > 0) {
+                await persistence.deleteChunks(entry.record.serverId, cleared.deletedChunks);
+            }
+            await persistence.saveServer(cleared.server);
+        }
+        entry.record = cleared.server;
+        entry.snapshot = clearDirtyFlags({ ...entry.snapshot, server: cleared.server.serverState });
+    };
+    const markMutated = (entry) => {
+        const timestamp = now();
+        entry.record = {
+            ...entry.record,
+            revision: entry.snapshot.revision,
+            dirtyAt: entry.record.dirtyAt ?? timestamp,
+            updatedAt: timestamp,
+        };
+    };
+    let interval = null;
+    const tickOnce = () => enqueue(async () => {
+        const timestamp = now();
+        let ticked = 0;
+        let saved = 0;
+        for (const entry of live.values()) {
+            if (entry.record.status !== "running")
+                continue;
+            if (entry.record.memberUserIds.length === 0)
+                continue;
+            const elapsedMs = timestamp - entry.record.tickAnchorMs;
+            if (elapsedMs < tickMs)
+                continue;
+            const runtime = resolveRuntime(entry.record.gameId);
+            const before = entry.snapshot.revision;
+            entry.snapshot = runtime.tick(entry.snapshot, elapsedMs / 1_000);
+            entry.record = { ...entry.record, tickAnchorMs: timestamp, updatedAt: timestamp };
+            ticked += 1;
+            if (entry.snapshot.revision !== before) {
+                markMutated(entry);
+                emit({ type: "server", serverId: entry.record.serverId });
+            }
+            if (shouldAutoSave(entry.record.save, entry.record.dirtyAt, entry.record.lastSavedAt, timestamp)) {
+                await flushServer(entry);
+                saved += 1;
+            }
+        }
+        return { ticked, saved };
+    });
+    const collectListings = async (gameId, options = {}) => {
+        const byId = new Map();
+        for (const record of await persistence.listServers(gameId)) {
+            byId.set(record.serverId, record);
+        }
+        for (const entry of live.values()) {
+            if (entry.record.gameId !== gameId)
+                continue;
+            byId.set(entry.record.serverId, entry.record);
+        }
+        return [...byId.values()].map((record) => ({
+            serverId: record.serverId,
+            gameId: record.gameId,
+            status: record.status,
+            visibility: record.visibility ?? "public",
+            memberCount: record.memberUserIds.length,
+            slotsPerServer: record.slotsPerServer,
+            label: record.label,
+            mode: record.mode,
+            ...(options.includeJoinCode === true && record.joinCode !== undefined
+                ? { joinCode: record.joinCode }
+                : {}),
+            tags: record.tags,
+            updatedAt: record.updatedAt,
+        }));
+    };
+    const host = {
+        joinServer: (args) => enqueue(async () => {
+            const timestamp = now();
+            const runtime = resolveRuntime(args.gameId);
+            let entry = args.serverId === undefined ? null : await getLive(args.serverId);
+            if (args.serverId !== undefined && entry === null) {
+                throw new Error("Server not found");
+            }
+            if (entry !== null && entry.record.gameId !== args.gameId) {
+                throw new Error("Server belongs to a different game");
+            }
+            if (entry === null) {
+                const attributes = args.attributes;
+                const record = {
+                    serverId: createServerId(),
+                    gameId: args.gameId,
+                    status: "running",
+                    memberUserIds: [],
+                    slotsPerServer: defaultSlots,
+                    save: runtime.save,
+                    serverState: createEmptyServerRow(),
+                    sessionPlayers: {},
+                    revision: 0,
+                    tickAnchorMs: timestamp,
+                    createdAt: timestamp,
+                    updatedAt: timestamp,
+                    ...(attributes?.label !== undefined ? { label: attributes.label } : {}),
+                    ...(attributes?.mode !== undefined ? { mode: attributes.mode } : {}),
+                    ...(attributes?.visibility !== undefined ? { visibility: attributes.visibility } : {}),
+                    ...(attributes?.joinCode !== undefined ? { joinCode: attributes.joinCode } : {}),
+                    ...(attributes?.tags !== undefined ? { tags: attributes.tags } : {}),
+                };
+                entry = await hydrate(record);
+            }
+            const { record } = entry;
+            if (record.memberUserIds.length >= record.slotsPerServer &&
+                !record.memberUserIds.includes(args.userId)) {
+                throw new Error("Server is full");
+            }
+            const profile = await persistence.loadProfile({ userId: args.userId, gameId: args.gameId });
+            const isNew = profile === null;
+            entry.record = {
+                ...record,
+                memberUserIds: record.memberUserIds.includes(args.userId)
+                    ? record.memberUserIds
+                    : [...record.memberUserIds, args.userId],
+                status: "running",
+                updatedAt: timestamp,
+                dirtyAt: timestamp,
+            };
+            entry.snapshot = runtime.joinPlayer(entry.snapshot, args.userId, isNew);
+            await flushServer(entry);
+            emit({ type: "server", serverId: entry.record.serverId });
+            emit({ type: "player", serverId: entry.record.serverId, userId: args.userId });
+            return { serverId: entry.record.serverId, isNew };
+        }),
+        browseServers: async (args) => browseSessions(await collectListings(args.gameId), args.filter ?? {}, { limit: args.limit }),
+        joinByCode: async (args) => {
+            const match = findByJoinCode(await collectListings(args.gameId, { includeJoinCode: true }), args.code);
+            if (match === null)
+                return null;
+            return host.joinServer({ userId: args.userId, gameId: args.gameId, serverId: match.serverId });
+        },
+        leaveServer: (args) => enqueue(async () => {
+            const entry = await getLive(args.serverId);
+            if (entry === null)
+                return;
+            if (!entry.record.memberUserIds.includes(args.userId))
+                return;
+            await flushServer(entry);
+            const timestamp = now();
+            const memberUserIds = entry.record.memberUserIds.filter((id) => id !== args.userId);
+            const sessionPlayers = { ...entry.record.sessionPlayers };
+            delete sessionPlayers[args.userId];
+            const players = { ...entry.snapshot.players };
+            delete players[args.userId];
+            entry.record = {
+                ...entry.record,
+                memberUserIds,
+                sessionPlayers,
+                updatedAt: timestamp,
+                status: memberUserIds.length === 0 ? "open" : entry.record.status,
+            };
+            entry.snapshot = { ...entry.snapshot, players };
+            await persistence.saveServer(entry.record);
+            if (memberUserIds.length === 0) {
+                live.delete(entry.record.serverId);
+            }
+            emit({ type: "server", serverId: args.serverId });
+        }),
+        runCommand: (args) => enqueue(async () => {
+            const entry = await getLive(args.serverId);
+            if (entry === null) {
+                return { ok: false, reason: "Server not found" };
+            }
+            if (!entry.record.memberUserIds.includes(args.userId)) {
+                return { ok: false, reason: "Not a member of this server" };
+            }
+            const runtime = resolveRuntime(entry.record.gameId);
+            const result = runtime.runCommand(entry.snapshot, args.userId, args.command, args.input);
+            if (!result.ok) {
+                return { ok: false, reason: result.reason };
+            }
+            entry.snapshot = result.snapshot;
+            markMutated(entry);
+            emit({ type: "server", serverId: args.serverId });
+            emit({ type: "player", serverId: args.serverId, userId: args.userId });
+            return { ok: true };
+        }),
+        isMember: async (args) => {
+            const entry = await getLive(args.serverId);
+            if (entry === null)
+                return false;
+            return entry.record.memberUserIds.includes(args.userId);
+        },
+        getServerView: async (args) => {
+            const entry = await getLive(args.serverId);
+            if (entry === null)
+                return null;
+            if (!entry.record.memberUserIds.includes(args.userId))
+                return null;
+            return {
+                serverId: entry.record.serverId,
+                gameId: entry.record.gameId,
+                revision: entry.snapshot.revision,
+                memberUserIds: entry.record.memberUserIds,
+                serverState: entry.snapshot.server,
+                updatedAt: entry.record.updatedAt,
+            };
+        },
+        getPlayerView: async (args) => {
+            const entry = await getLive(args.serverId);
+            if (entry === null)
+                return null;
+            if (!entry.record.memberUserIds.includes(args.userId))
+                return null;
+            const player = entry.snapshot.players[args.userId];
+            if (player !== undefined) {
+                return {
+                    userId: args.userId,
+                    gameId: entry.record.gameId,
+                    playerState: splitProfilePlayer(player).persistent,
+                    updatedAt: entry.record.updatedAt,
+                };
+            }
+            const profile = await persistence.loadProfile({ userId: args.userId, gameId: entry.record.gameId });
+            if (profile === null)
+                return null;
+            return {
+                userId: profile.userId,
+                gameId: profile.gameId,
+                playerState: profile.playerState,
+                updatedAt: profile.updatedAt,
+            };
+        },
+        getFeed: async (args) => {
+            const entry = await getLive(args.serverId);
+            if (entry === null)
+                return [];
+            if (!entry.record.memberUserIds.includes(args.userId))
+                return [];
+            return persistence.loadFeed({ serverId: args.serverId, action: args.action });
+        },
+        pushFeedEntry: (args) => enqueue(async () => {
+            const allowed = validateFeedWrite(feedWriteGate, args.action);
+            if (!allowed.ok) {
+                throw new Error(allowed.reason);
+            }
+            const entry = await getLive(args.serverId);
+            if (entry === null || !entry.record.memberUserIds.includes(args.userId)) {
+                throw new Error("Not a member of this server");
+            }
+            await persistence.appendFeed({ serverId: args.serverId, action: args.action, entry: args.entry });
+            emit({ type: "feed", serverId: args.serverId, action: args.action });
+        }),
+        listOpenServers: async (args) => {
+            const byId = new Map();
+            for (const record of await persistence.listServers(args.gameId)) {
+                byId.set(record.serverId, toServerListing(record));
+            }
+            for (const entry of live.values()) {
+                if (entry.record.gameId !== args.gameId)
+                    continue;
+                byId.set(entry.record.serverId, toServerListing(entry.record));
+            }
+            return toOpenServerListings(byId.values(), args.limit);
+        },
+        tickOnce,
+        flushAll: () => enqueue(async () => {
+            let saved = 0;
+            for (const entry of live.values()) {
+                if (entry.record.dirtyAt === undefined)
+                    continue;
+                await flushServer(entry);
+                saved += 1;
+            }
+            return saved;
+        }),
+        start: () => {
+            if (interval !== null)
+                return;
+            interval = setInterval(() => {
+                void tickOnce();
+            }, tickMs);
+        },
+        stop: async () => {
+            if (interval !== null) {
+                clearInterval(interval);
+                interval = null;
+            }
+            await enqueue(async () => {
+                for (const entry of live.values()) {
+                    if (entry.record.dirtyAt === undefined)
+                        continue;
+                    await flushServer(entry);
+                }
+            });
+        },
+        subscribe: (listener) => {
+            listeners.add(listener);
+            return () => listeners.delete(listener);
+        },
+    };
+    return host;
+}
+export function memoryPersistence(now = Date.now) {
+    const servers = new Map();
+    const profiles = new Map();
+    const chunks = new Map();
+    const feeds = new Map();
+    const leaderboard = new Map();
+    const clone = (value) => structuredClone(value);
+    return {
+        async loadServer(serverId) {
+            const record = servers.get(serverId);
+            return record === undefined ? null : clone(record);
+        },
+        async saveServer(record) {
+            servers.set(record.serverId, clone(record));
+        },
+        async listServers(gameId) {
+            return [...servers.values()].filter((record) => record.gameId === gameId).map(clone);
+        },
+        async loadProfile({ userId, gameId }) {
+            const record = profiles.get(`${gameId}|${userId}`);
+            return record === undefined ? null : clone(record);
+        },
+        async saveProfile(record) {
+            profiles.set(`${record.gameId}|${record.userId}`, clone(record));
+        },
+        async loadChunks(serverId) {
+            return [...(chunks.get(serverId)?.values() ?? [])].map(clone);
+        },
+        async saveChunks(serverId, records) {
+            const byKey = chunks.get(serverId) ?? new Map();
+            for (const record of records) {
+                byKey.set(record.chunkKey, clone(record));
+            }
+            chunks.set(serverId, byKey);
+        },
+        async deleteChunks(serverId, chunkKeys) {
+            const byKey = chunks.get(serverId);
+            if (byKey === undefined)
+                return;
+            for (const chunkKey of chunkKeys) {
+                byKey.delete(chunkKey);
+            }
+        },
+        async loadFeed({ serverId, action }) {
+            return clone(feeds.get(`${serverId}|${action}`) ?? []);
+        },
+        async appendFeed({ serverId, action, entry }) {
+            const key = `${serverId}|${action}`;
+            const entries = trimFeedEntries([...(feeds.get(key) ?? []), clone(entry)]);
+            feeds.set(key, entries);
+            return clone(entries);
+        },
+        async applyLeaderboardIncrements(gameId, entries) {
+            applyLeaderboardRows(leaderboard, gameId, entries, now());
+        },
+        async getLeaderboardTop(args) {
+            return topLeaderboardRows(leaderboard.values(), args);
+        },
+        async getLeaderboardProfile({ gameId, userId }) {
+            return profileLeaderboardStats(leaderboard.values(), gameId, userId);
+        },
+    };
+}

package/dist/hostRouter.d.ts

@@ -0,0 +1,45 @@
+import type { PoseSyncRules } from "@jgengine/core/multiplayer/presenceModel";
+import { type ChatRateLimit } from "@jgengine/core/game/chat";
+import type { GameHost } from "./host.js";
+import type { TransportPipeFactory } from "./pipe.js";
+export type HostRouterAuthenticate = (args: {
+    userId: string;
+    token?: string;
+}) => Promise<string | null> | string | null;
+export type HostRouterOptions = {
+    host: GameHost;
+    authenticate?: HostRouterAuthenticate;
+    allowAnonymous?: boolean;
+    singleSession?: boolean;
+    poseRules?: PoseSyncRules;
+    positionHistoryMs?: number;
+    chatRateLimit?: ChatRateLimit;
+    chatHistoryLimit?: number;
+    chatMaxBodyLength?: number;
+    now?: () => number;
+};
+export type HostRouterTransport = {
+    send: (data: string) => void;
+    close: () => void;
+};
+export type HostRouterConnection = {
+    handleRaw: (raw: unknown) => void;
+    close: () => void;
+};
+export type RewoundPosition = {
+    userId: string;
+    x: number;
+    y: number;
+    z: number;
+};
+export type HostRouter = {
+    connect: (transport: HostRouterTransport) => HostRouterConnection;
+    rewind: (args: {
+        serverId: string;
+        atMs: number;
+    }) => RewoundPosition[];
+    close: () => void;
+};
+export declare const DEFAULT_POSE_RULES: PoseSyncRules;
+export declare function createHostRouter(options: HostRouterOptions): HostRouter;
+export declare function loopbackPipe(router: HostRouter): TransportPipeFactory;