@jgengine/convex 0.9.0 → 0.11.0

package/README.md

@@ -11,7 +11,7 @@ import { resolveConvexMultiplayer } from "@jgengine/convex/resolveConvexMultipla
 
 const session = resolveConvexMultiplayer({
   game: myGame,
-  gameId: "voxel-mine",
+  gameId: "my-game",
   url: import.meta.env.VITE_CONVEX_URL,
   force: import.meta.env.VITE_CONVEX_URL !== undefined,
 });
@@ -44,6 +44,6 @@ No game-specific code lives there — any JGengine game can point at the same de
 
 Every factory defaults to `auth: "anonymous"` — the client's `externalId` is trusted as claimed, fine for local dev but spoofable. Pass `{ auth: "required" }` to every factory for production; the resolved actor becomes `ctx.auth.getUserIdentity()`'s `subject`, and `externalId` is only cross-checked against it, never trusted alone.
 
-See `examples/convex-host` for the reference thin consumer (`bunx convex dev` codegens `convex/_generated/` and prints the dev URL) and `Games/voxel-mine` for a game that declares `multiplayer: convex({ topology: "shared" })`. No Convex Cloud account is needed — `examples/convex-host/docker-compose.yml` runs the open-source backend anywhere Docker runs, with `CONVEX_SELF_HOSTED_URL`/`CONVEX_SELF_HOSTED_ADMIN_KEY` pointing the same CLI at it.
+See `examples/convex-host` for the reference thin consumer (`bunx convex dev` codegens `convex/_generated/` and prints the dev URL). Point any game that declares `multiplayer: convexPresence({ topology: "shared" })` (or `convex({ topology: "shared", authority: "server" })` for a shared sim) at the same deployment. No Convex Cloud account is needed — `examples/convex-host/docker-compose.yml` runs the open-source backend anywhere Docker runs, with `CONVEX_SELF_HOSTED_URL`/`CONVEX_SELF_HOSTED_ADMIN_KEY` pointing the same CLI at it.
 
-Part of [JGengine](https://github.com/Noisemaker111/jgengine). AGPL-3.0-only.
+Part of [JGengine](https://github.com/Noisemaker111/jgengine). Apache-2.0.

package/dist/convexSaveBackend.d.ts

@@ -0,0 +1,35 @@
+import type { ConvexReactClient } from "convex/react";
+import type { FunctionReference } from "convex/server";
+import { type SaveBackend } from "@jgengine/core/game/saveStore";
+/** The three Convex functions a save backend calls — a `query` that returns the stored string (or `null`) and two `mutation`s. Point them at your app's own module, or lean on the default `saves.*` convention. */
+export interface ConvexSaveFunctions {
+    read: FunctionReference<"query", "public", {
+        key: string;
+    }, string | null>;
+    write: FunctionReference<"mutation", "public", {
+        key: string;
+        value: string;
+    }, unknown>;
+    remove: FunctionReference<"mutation", "public", {
+        key: string;
+    }, unknown>;
+}
+/** Default `saves.read` / `saves.write` / `saves.remove` refs for apps that follow the convention — pass your own `functions` to override. */
+export declare function defaultConvexSaveFunctions(): ConvexSaveFunctions;
+/** Config for {@link createConvexSaveBackend} — the Convex client, optional function refs (defaults to the `saves.*` convention), and an optional key `namespace`. */
+export interface ConvexSaveBackendOptions {
+    client: ConvexReactClient;
+    /** The read/write/remove function refs; defaults to the `saves.*` convention. */
+    functions?: ConvexSaveFunctions;
+    /** Prefix every key so multiple games or users can share one `saves` table. */
+    namespace?: string;
+}
+/**
+ * A cloud {@link SaveBackend} backed by Convex — reads through a query and
+ * writes through mutations, so a {@link createSaveStore} configured with it
+ * saves to the server instead of `localStorage`. The only change from an offline
+ * game is swapping the backend; autosave, slots, and migration behave the same.
+ *
+ * @capability convex-save save a game to Convex (cloud) through the SaveBackend seam
+ */
+export declare function createConvexSaveBackend(options: ConvexSaveBackendOptions): SaveBackend;

package/dist/convexSaveBackend.js

@@ -0,0 +1,24 @@
+import { anyApi } from "convex/server";
+import { remoteSaveBackend } from "@jgengine/core/game/saveStore";
+/** Default `saves.read` / `saves.write` / `saves.remove` refs for apps that follow the convention — pass your own `functions` to override. */
+export function defaultConvexSaveFunctions() {
+    return anyApi.saves;
+}
+/**
+ * A cloud {@link SaveBackend} backed by Convex — reads through a query and
+ * writes through mutations, so a {@link createSaveStore} configured with it
+ * saves to the server instead of `localStorage`. The only change from an offline
+ * game is swapping the backend; autosave, slots, and migration behave the same.
+ *
+ * @capability convex-save save a game to Convex (cloud) through the SaveBackend seam
+ */
+export function createConvexSaveBackend(options) {
+    const functions = options.functions ?? defaultConvexSaveFunctions();
+    const prefix = options.namespace === undefined ? "" : `${options.namespace}:`;
+    const scope = (key) => `${prefix}${key}`;
+    return remoteSaveBackend({
+        read: (key) => options.client.query(functions.read, { key: scope(key) }),
+        write: (key, value) => options.client.mutation(functions.write, { key: scope(key), value }).then(() => undefined),
+        remove: (key) => options.client.mutation(functions.remove, { key: scope(key) }).then(() => undefined),
+    });
+}

package/dist/hostedServer.d.ts

@@ -0,0 +1,98 @@
+import type { GameDefinition } from "@jgengine/core/game/defineGame";
+import type { GameContextContent } from "@jgengine/core/runtime/gameContext";
+import { type InputFrame } from "@jgengine/core/runtime/hostedGameRunner";
+import { type HostedWorldSession, type HostedWorldStore } from "@jgengine/core/runtime/hostedWorldSession";
+import type { ModelAssetRef } from "@jgengine/core/scene/assetCatalog";
+import { type JgAuthMode } from "./server.js";
+/** One game the hosted path can serve, bound per `gameId`: its definition plus content lookup. */
+export interface HostedGameConfig {
+    definition: GameDefinition<ModelAssetRef, unknown>;
+    content: GameContextContent;
+}
+/**
+ * Everything one stateless invocation reconstructs a hosted world from: the persisted record via `store`,
+ * plus the member roster and held inputs the snapshot doesn't carry, and the op to apply to the fresh session.
+ */
+export interface HostedWorldInvocation<T> {
+    game: HostedGameConfig;
+    store: HostedWorldStore;
+    members?: readonly string[];
+    inputs?: Readonly<Record<string, InputFrame>>;
+    now?: () => number;
+    op: (session: HostedWorldSession) => T;
+}
+/** What one stateless invocation produced: the op's value, the resulting revision, whether the world changed (and was saved back), and the post-op roster. */
+export interface HostedWorldOutcome<T> {
+    value: T;
+    revision: number;
+    changed: boolean;
+    members: readonly string[];
+}
+/**
+ * The reconstruct → op → save core of the stateless hosted path, Convex-agnostic so it unit-tests against
+ * `memoryWorldStore`: build a fresh {@link createHostedWorldSession} from `store.load()`, resume persisted
+ * members and replay held inputs, run the op, then persist the snapshot at `revision + 1` iff the world changed.
+  * @internal
+  */
+export declare function invokeHostedWorld<T>(invocation: HostedWorldInvocation<T>): HostedWorldOutcome<T>;
+/** Default minimum elapsed ms before `tickHostedWorlds` advances a world — override via the factory's `tickMs`. */
+export declare const JG_HOSTED_TICK_MS = 1000;
+/**
+ * The Convex counterpart of ws's `createWorldGameHost`: serves GameContext worlds statelessly by
+ * reconstructing a hosted session from the persisted `jgHostedWorlds` row on every invocation via
+ * {@link invokeHostedWorld}. Destructure + re-export the returned functions from a `convex/` module and
+ * drive `tickHostedWorlds` from a cron. Requires {@link jgengineHostedTables} in the deployment schema.
+  * @internal
+  */
+export declare function createHostedGameServerFunctions(options: {
+    games: Record<string, HostedGameConfig>;
+    auth?: JgAuthMode;
+    tickMs?: number;
+}): {
+    getHostedServer: import("convex/server").RegisteredQuery<"public", {
+        externalId?: string | undefined;
+        gameId: string;
+        serverId?: string | undefined;
+    }, Promise<{
+        serverId: string;
+        gameId: string;
+        revision: number;
+        serverState: any;
+        memberUserIds: string[];
+    } | null>>;
+    joinHostedServer: import("convex/server").RegisteredMutation<"public", {
+        externalId?: string | undefined;
+        gameId: string;
+        serverId?: string | undefined;
+    }, Promise<{
+        serverId: string;
+        isNew: boolean;
+    }>>;
+    leaveHostedServer: import("convex/server").RegisteredMutation<"public", {
+        externalId?: string | undefined;
+        gameId: string;
+        serverId?: string | undefined;
+    }, Promise<null>>;
+    runHostedCommand: import("convex/server").RegisteredMutation<"public", {
+        command: string;
+        externalId?: string | undefined;
+        gameId: string;
+        input: any;
+        serverId?: string | undefined;
+    }, Promise<{
+        ok: false;
+        reason: string;
+    } | {
+        ok: true;
+    }>>;
+    submitHostedInput: import("convex/server").RegisteredMutation<"public", {
+        externalId?: string | undefined;
+        frame: any;
+        gameId: string;
+        serverId?: string | undefined;
+    }, Promise<null>>;
+    tickHostedWorlds: import("convex/server").RegisteredMutation<"internal", {}, Promise<{
+        ticked: number;
+        saved: number;
+    }>>;
+};

package/dist/hostedServer.js

@@ -0,0 +1,353 @@
+import { defineSchema, internalMutationGeneric, mutationGeneric, queryGeneric, } from "convex/server";
+import { ConvexError, v } from "convex/values";
+import { INPUT_COMMAND } from "@jgengine/core/runtime/hostedGameRunner";
+import { createHostedWorldSession, } from "@jgengine/core/runtime/hostedWorldSession";
+import { commitIfRevisionMatch } from "./occ.js";
+import { jgengineHostedTables, resolveActor } from "./server.js";
+/**
+ * The reconstruct → op → save core of the stateless hosted path, Convex-agnostic so it unit-tests against
+ * `memoryWorldStore`: build a fresh {@link createHostedWorldSession} from `store.load()`, resume persisted
+ * members and replay held inputs, run the op, then persist the snapshot at `revision + 1` iff the world changed.
+  * @internal
+  */
+export function invokeHostedWorld(invocation) {
+    const { game, store, members = [], inputs = {}, now, op } = invocation;
+    const loaded = store.load();
+    const loadedJson = loaded === null ? null : JSON.stringify(loaded.snapshot);
+    const session = createHostedWorldSession({
+        definition: game.definition,
+        content: game.content,
+        store: { load: () => loaded, save: () => { } },
+        ...(now === undefined ? {} : { now }),
+    });
+    for (const userId of members)
+        session.runner().resume(userId);
+    for (const [userId, frame] of Object.entries(inputs))
+        session.input(userId, frame);
+    const value = op(session);
+    const snapshot = session.runner().snapshot();
+    const baseRevision = loaded?.revision ?? 0;
+    if (loadedJson !== null && JSON.stringify(snapshot) === loadedJson) {
+        return { value, revision: baseRevision, changed: false, members: session.members() };
+    }
+    const record = { snapshot, revision: baseRevision + 1 };
+    store.save(record);
+    return { value, revision: record.revision, changed: true, members: session.members() };
+}
+const hostedSchemaForTypes = defineSchema(jgengineHostedTables());
+const query = queryGeneric;
+const mutation = mutationGeneric;
+const internalMutation = internalMutationGeneric;
+/** Default minimum elapsed ms before `tickHostedWorlds` advances a world — override via the factory's `tickMs`. */
+export const JG_HOSTED_TICK_MS = 1_000;
+async function getWorldRow(ctx, gameId, serverId) {
+    return await ctx.db
+        .query("jgHostedWorlds")
+        .withIndex("by_game_and_server", (q) => q.eq("gameId", gameId).eq("serverId", serverId))
+        .unique();
+}
+function heldInputsOf(row) {
+    return (row?.inputs ?? {});
+}
+function worldStoreForRow(row) {
+    const loaded = row === null ? null : { snapshot: row.snapshot, revision: row.revision };
+    let captured = null;
+    return {
+        store: {
+            load: () => loaded,
+            save(record) {
+                captured = record;
+            },
+        },
+        captured: () => captured,
+    };
+}
+async function persistWorldRow(ctx, args) {
+    const nowMs = Date.now();
+    if (args.row === null) {
+        if (args.record === null)
+            return;
+        await ctx.db.insert("jgHostedWorlds", {
+            gameId: args.gameId,
+            serverId: args.serverId,
+            snapshot: args.record.snapshot,
+            revision: args.record.revision,
+            memberUserIds: [...args.memberUserIds],
+            inputs: args.inputs,
+            tickAnchorMs: args.tickAnchorMs ?? nowMs,
+            createdAt: nowMs,
+            updatedAt: nowMs,
+        });
+        return;
+    }
+    await ctx.db.patch(args.row._id, {
+        ...(args.record === null
+            ? {}
+            : { snapshot: args.record.snapshot, revision: args.record.revision }),
+        memberUserIds: [...args.memberUserIds],
+        inputs: args.inputs,
+        ...(args.tickAnchorMs === undefined ? {} : { tickAnchorMs: args.tickAnchorMs }),
+        updatedAt: nowMs,
+    });
+}
+/**
+ * The Convex counterpart of ws's `createWorldGameHost`: serves GameContext worlds statelessly by
+ * reconstructing a hosted session from the persisted `jgHostedWorlds` row on every invocation via
+ * {@link invokeHostedWorld}. Destructure + re-export the returned functions from a `convex/` module and
+ * drive `tickHostedWorlds` from a cron. Requires {@link jgengineHostedTables} in the deployment schema.
+  * @internal
+  */
+export function createHostedGameServerFunctions(options) {
+    const mode = options.auth ?? "anonymous";
+    const tickMs = options.tickMs ?? JG_HOSTED_TICK_MS;
+    function resolveGame(gameId) {
+        const game = options.games[gameId];
+        if (game === undefined)
+            throw new ConvexError(`Unknown hosted game "${gameId}"`);
+        return game;
+    }
+    const getHostedServer = query({
+        args: {
+            gameId: v.string(),
+            serverId: v.optional(v.string()),
+            externalId: v.optional(v.string()),
+        },
+        returns: v.union(v.object({
+            serverId: v.string(),
+            gameId: v.string(),
+            revision: v.number(),
+            serverState: v.any(),
+            memberUserIds: v.array(v.string()),
+        }), v.null()),
+        handler: async (ctx, args) => {
+            const actorUserId = await resolveActor(ctx, args.externalId, mode);
+            if (!actorUserId)
+                return null;
+            const row = await getWorldRow(ctx, args.gameId, args.serverId ?? args.gameId);
+            if (!row)
+                return null;
+            if (!row.memberUserIds.includes(actorUserId))
+                return null;
+            return {
+                serverId: row.serverId,
+                gameId: row.gameId,
+                revision: row.revision,
+                serverState: row.snapshot,
+                memberUserIds: row.memberUserIds,
+            };
+        },
+    });
+    const joinHostedServer = mutation({
+        args: {
+            gameId: v.string(),
+            serverId: v.optional(v.string()),
+            externalId: v.optional(v.string()),
+        },
+        returns: v.object({ serverId: v.string(), isNew: v.boolean() }),
+        handler: async (ctx, args) => {
+            const actorUserId = await resolveActor(ctx, args.externalId, mode);
+            if (!actorUserId) {
+                throw new ConvexError("Not authenticated");
+            }
+            const game = resolveGame(args.gameId);
+            const serverId = args.serverId ?? args.gameId;
+            const row = await getWorldRow(ctx, args.gameId, serverId);
+            const isNew = !(row?.memberUserIds ?? []).includes(actorUserId);
+            const { store, captured } = worldStoreForRow(row);
+            const outcome = invokeHostedWorld({
+                game,
+                store,
+                members: row?.memberUserIds ?? [],
+                inputs: heldInputsOf(row),
+                op: (session) => session.join(actorUserId, isNew),
+            });
+            await persistWorldRow(ctx, {
+                gameId: args.gameId,
+                serverId,
+                row,
+                record: captured(),
+                memberUserIds: outcome.members,
+                inputs: heldInputsOf(row),
+            });
+            return { serverId, isNew };
+        },
+    });
+    const leaveHostedServer = mutation({
+        args: {
+            gameId: v.string(),
+            serverId: v.optional(v.string()),
+            externalId: v.optional(v.string()),
+        },
+        returns: v.null(),
+        handler: async (ctx, args) => {
+            const actorUserId = await resolveActor(ctx, args.externalId, mode);
+            if (!actorUserId) {
+                throw new ConvexError("Not authenticated");
+            }
+            const serverId = args.serverId ?? args.gameId;
+            const row = await getWorldRow(ctx, args.gameId, serverId);
+            if (!row)
+                return null;
+            if (!row.memberUserIds.includes(actorUserId))
+                return null;
+            const game = resolveGame(args.gameId);
+            const { store, captured } = worldStoreForRow(row);
+            const outcome = invokeHostedWorld({
+                game,
+                store,
+                members: row.memberUserIds,
+                inputs: heldInputsOf(row),
+                op: (session) => session.leave(actorUserId),
+            });
+            const inputs = heldInputsOf(row);
+            delete inputs[actorUserId];
+            await persistWorldRow(ctx, {
+                gameId: args.gameId,
+                serverId,
+                row,
+                record: captured(),
+                memberUserIds: outcome.members,
+                inputs,
+            });
+            return null;
+        },
+    });
+    const runHostedCommand = mutation({
+        args: {
+            gameId: v.string(),
+            serverId: v.optional(v.string()),
+            command: v.string(),
+            input: v.any(),
+            externalId: v.optional(v.string()),
+        },
+        returns: v.union(v.object({ ok: v.literal(true) }), v.object({ ok: v.literal(false), reason: v.string() })),
+        handler: async (ctx, args) => {
+            const actorUserId = await resolveActor(ctx, args.externalId, mode);
+            if (!actorUserId) {
+                throw new ConvexError("Not authenticated");
+            }
+            const serverId = args.serverId ?? args.gameId;
+            const row = await getWorldRow(ctx, args.gameId, serverId);
+            if (!row) {
+                return { ok: false, reason: "Server not found" };
+            }
+            if (!row.memberUserIds.includes(actorUserId)) {
+                return { ok: false, reason: "Not a member of this server" };
+            }
+            if (args.command === INPUT_COMMAND) {
+                await ctx.db.patch(row._id, {
+                    inputs: { ...heldInputsOf(row), [actorUserId]: args.input },
+                    updatedAt: Date.now(),
+                });
+                return { ok: true };
+            }
+            const game = resolveGame(args.gameId);
+            const loadedRevision = row.revision;
+            const { store, captured } = worldStoreForRow(row);
+            const outcome = invokeHostedWorld({
+                game,
+                store,
+                members: row.memberUserIds,
+                inputs: heldInputsOf(row),
+                op: (session) => session.command(actorUserId, args.command, args.input),
+            });
+            if (outcome.value.status === "rejected") {
+                return { ok: false, reason: outcome.value.reason };
+            }
+            if (outcome.value.status === "unknown-command") {
+                return { ok: false, reason: "unknown-command" };
+            }
+            const latest = await getWorldRow(ctx, args.gameId, serverId);
+            if (!latest) {
+                return { ok: false, reason: "Server not found" };
+            }
+            const commit = commitIfRevisionMatch(loadedRevision, latest.revision);
+            if (!commit.ok) {
+                return commit;
+            }
+            await persistWorldRow(ctx, {
+                gameId: args.gameId,
+                serverId,
+                row: latest,
+                record: captured(),
+                memberUserIds: outcome.members,
+                inputs: heldInputsOf(latest),
+            });
+            return { ok: true };
+        },
+    });
+    const submitHostedInput = mutation({
+        args: {
+            gameId: v.string(),
+            serverId: v.optional(v.string()),
+            frame: v.any(),
+            externalId: v.optional(v.string()),
+        },
+        returns: v.null(),
+        handler: async (ctx, args) => {
+            const actorUserId = await resolveActor(ctx, args.externalId, mode);
+            if (!actorUserId) {
+                throw new ConvexError("Not authenticated");
+            }
+            const row = await getWorldRow(ctx, args.gameId, args.serverId ?? args.gameId);
+            if (!row || !row.memberUserIds.includes(actorUserId)) {
+                throw new ConvexError("Not a member of this server");
+            }
+            await ctx.db.patch(row._id, {
+                inputs: { ...heldInputsOf(row), [actorUserId]: args.frame },
+                updatedAt: Date.now(),
+            });
+            return null;
+        },
+    });
+    const tickHostedWorlds = internalMutation({
+        args: {},
+        handler: async (ctx) => {
+            const nowMs = Date.now();
+            const rows = await ctx.db
+                .query("jgHostedWorlds")
+                .withIndex("by_tick_anchor", (q) => q.lte("tickAnchorMs", nowMs - tickMs))
+                .collect();
+            let ticked = 0;
+            let saved = 0;
+            for (const row of rows) {
+                const game = options.games[row.gameId];
+                if (game === undefined)
+                    continue;
+                if (row.memberUserIds.length === 0)
+                    continue;
+                const elapsedMs = nowMs - row.tickAnchorMs;
+                const { store, captured } = worldStoreForRow(row);
+                const outcome = invokeHostedWorld({
+                    game,
+                    store,
+                    members: row.memberUserIds,
+                    inputs: heldInputsOf(row),
+                    op: (session) => session.tick(elapsedMs / 1_000),
+                });
+                ticked += 1;
+                const record = captured();
+                if (record !== null)
+                    saved += 1;
+                await persistWorldRow(ctx, {
+                    gameId: row.gameId,
+                    serverId: row.serverId,
+                    row,
+                    record,
+                    memberUserIds: outcome.members,
+                    inputs: heldInputsOf(row),
+                    tickAnchorMs: nowMs,
+                });
+            }
+            return { ticked, saved };
+        },
+    });
+    return {
+        getHostedServer,
+        joinHostedServer,
+        leaveHostedServer,
+        runHostedCommand,
+        submitHostedInput,
+        tickHostedWorlds,
+    };
+}

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 export * from "./convexChatTransport.js";
 export * from "./convexPresenceTransport.js";
 export * from "./createConvexBackend.js";
+export * from "./convexSaveBackend.js";
 export * from "./createConvexGameTransport.js";
+export * from "./hostedServer.js";
 export * from "./occ.js";
 export * from "./resolveConvexMultiplayer.js";
 export * from "./server.js";

package/dist/index.js

@@ -1,7 +1,9 @@
 export * from "./convexChatTransport.js";
 export * from "./convexPresenceTransport.js";
 export * from "./createConvexBackend.js";
+export * from "./convexSaveBackend.js";
 export * from "./createConvexGameTransport.js";
+export * from "./hostedServer.js";
 export * from "./occ.js";
 export * from "./resolveConvexMultiplayer.js";
 export * from "./server.js";

package/dist/occ.d.ts

@@ -1,12 +1,14 @@
 import type { GameRuntime } from "@jgengine/core/runtime/gameRuntime";
 import type { GameRuntimeSnapshot } from "@jgengine/core/runtime/snapshot";
 export declare const REVISION_CONFLICT_REASON = "Revision conflict";
+/** @internal */
 export declare function commitIfRevisionMatch(loadedRevision: number, currentRevision: number): {
     ok: true;
 } | {
     ok: false;
     reason: string;
 };
+/** @internal */
 export declare function applyCommandWithOcc(args: {
     loadedRevision: number;
     currentRevision: number;

package/dist/occ.js

@@ -1,10 +1,12 @@
 export const REVISION_CONFLICT_REASON = "Revision conflict";
+/** @internal */
 export function commitIfRevisionMatch(loadedRevision, currentRevision) {
     if (currentRevision !== loadedRevision) {
         return { ok: false, reason: REVISION_CONFLICT_REASON };
     }
     return { ok: true };
 }
+/** @internal */
 export function applyCommandWithOcc(args) {
     const gate = commitIfRevisionMatch(args.loadedRevision, args.currentRevision);
     if (!gate.ok)