@jgengine/convex 0.9.0 → 0.11.0

package/dist/server.d.ts

@@ -1,10 +1,11 @@
-import type { DataModelFromSchemaDefinition, GenericMutationCtx } from "convex/server";
+import type { Auth, DataModelFromSchemaDefinition, GenericMutationCtx } from "convex/server";
 import type { GenericId } from "convex/values";
 import type { ChatMessage } from "@jgengine/core/game/chat";
 import type { ChatSendOutcome } from "@jgengine/core/multiplayer/chatContract";
 import { type PoseSyncRules } from "@jgengine/core/multiplayer/presenceModel";
 import type { GameRuntime } from "@jgengine/core/runtime/gameRuntime";
-import type { LeaderboardIncrement } from "@jgengine/core/runtime/hostPersistence";
+import type { LeaderboardIncrement, SessionVisibility } from "@jgengine/core/runtime/hostPersistence";
+/** @internal */
 export declare function jgengineTables(): {
     jgGameServers: import("convex/server").TableDefinition<import("convex/values").VObject<{
         createdAt: number;
@@ -55,7 +56,9 @@ export declare function jgengineTables(): {
         createdAt: import("convex/values").VFloat64<number, "required">;
         updatedAt: import("convex/values").VFloat64<number, "required">;
     }, "required", "createdAt" | "dirtyAt" | "gameId" | "joinCode" | "lastSavedAt" | "memberUserIds" | "mode" | "modeConfig" | "revision" | "save" | "save.auto" | "save.scope" | "serverState" | "sessionPlayers" | "slotsPerServer" | "status" | "tickAnchorMs" | "updatedAt" | "visibility" | `modeConfig.${string}` | `serverState.${string}` | `sessionPlayers.${string}`>, {
+        by_dirty: ["dirtyAt", "_creationTime"];
         by_game_and_status: ["gameId", "status", "_creationTime"];
+        by_status: ["status", "_creationTime"];
     }, {}, {}>;
     jgPlayerProfiles: import("convex/server").TableDefinition<import("convex/values").VObject<{
         createdAt: number;
@@ -163,6 +166,38 @@ export declare function jgengineTables(): {
         by_server_channel: ["serverId", "channelId", "_creationTime"];
     }, {}, {}>;
 };
+/**
+ * Convex table for the hosted GameContext-world path: one row per (gameId, serverId) holding the full
+ * `WorldSnapshot` blob, its revision, the member roster, and each member's held input. A sibling of
+ * {@link jgengineTables} — spread either (or both) into `defineSchema`.
+  * @internal
+  */
+export declare function jgengineHostedTables(): {
+    jgHostedWorlds: import("convex/server").TableDefinition<import("convex/values").VObject<{
+        createdAt: number;
+        gameId: string;
+        inputs: any;
+        memberUserIds: string[];
+        revision: number;
+        serverId: string;
+        snapshot: any;
+        tickAnchorMs: number;
+        updatedAt: number;
+    }, {
+        gameId: import("convex/values").VString<string, "required">;
+        serverId: import("convex/values").VString<string, "required">;
+        snapshot: import("convex/values").VAny<any, "required", string>;
+        revision: import("convex/values").VFloat64<number, "required">;
+        memberUserIds: import("convex/values").VArray<string[], import("convex/values").VString<string, "required">, "required">;
+        inputs: import("convex/values").VAny<any, "required", string>;
+        tickAnchorMs: import("convex/values").VFloat64<number, "required">;
+        createdAt: import("convex/values").VFloat64<number, "required">;
+        updatedAt: import("convex/values").VFloat64<number, "required">;
+    }, "required", "createdAt" | "gameId" | "inputs" | "memberUserIds" | "revision" | "serverId" | "snapshot" | "tickAnchorMs" | "updatedAt" | `inputs.${string}` | `snapshot.${string}`>, {
+        by_game_and_server: ["gameId", "serverId", "_creationTime"];
+        by_tick_anchor: ["tickAnchorMs", "_creationTime"];
+    }, {}, {}>;
+};
 declare const schemaForTypes: import("convex/server").SchemaDefinition<{
     jgGameServers: import("convex/server").TableDefinition<import("convex/values").VObject<{
         createdAt: number;
@@ -213,7 +248,9 @@ declare const schemaForTypes: import("convex/server").SchemaDefinition<{
         createdAt: import("convex/values").VFloat64<number, "required">;
         updatedAt: import("convex/values").VFloat64<number, "required">;
     }, "required", "createdAt" | "dirtyAt" | "gameId" | "joinCode" | "lastSavedAt" | "memberUserIds" | "mode" | "modeConfig" | "revision" | "save" | "save.auto" | "save.scope" | "serverState" | "sessionPlayers" | "slotsPerServer" | "status" | "tickAnchorMs" | "updatedAt" | "visibility" | `modeConfig.${string}` | `serverState.${string}` | `sessionPlayers.${string}`>, {
+        by_dirty: ["dirtyAt", "_creationTime"];
         by_game_and_status: ["gameId", "status", "_creationTime"];
+        by_status: ["status", "_creationTime"];
     }, {}, {}>;
     jgPlayerProfiles: import("convex/server").TableDefinition<import("convex/values").VObject<{
         createdAt: number;
@@ -325,8 +362,28 @@ type JGDataModel = DataModelFromSchemaDefinition<typeof schemaForTypes>;
 type JGMutationCtx = GenericMutationCtx<JGDataModel>;
 export type JgAuthMode = "anonymous" | "required";
 export declare const DEFAULT_CONVEX_POSE_RULES: PoseSyncRules;
+/** Resolve the acting user id under a {@link JgAuthMode}: the Convex identity when signed in (rejecting a mismatched claim), the claimed external id under `"anonymous"`, else `null`.
+ * @internal
+ */
+export declare function resolveActor(ctx: {
+    auth: Auth;
+}, claimedExternalId: string | undefined, mode: JgAuthMode): Promise<string | null>;
+/** True when a server's `visibility` should surface in public listings/browse results.
+ * @internal
+ */
+export declare function isListablePublicly(visibility: SessionVisibility | undefined): boolean;
+/** A non-member may enter a private server only by presenting its `joinCode`; members always pass.
+ * @internal
+ */
+export declare function canJoinPrivateServer(args: {
+    isMember: boolean;
+    joinCode: string | undefined;
+    suppliedCode: string | undefined;
+}): boolean;
+/** @internal */
 export declare function applyLeaderboardIncrements(ctx: JGMutationCtx, gameId: string, entries: LeaderboardIncrement[]): Promise<void>;
 export declare const JG_RUNTIME_TICK_MS = 1000;
+/** @internal */
 export declare function createGameServerFunctions(options?: {
     runtimes?: GameRuntime[];
     auth?: JgAuthMode;
@@ -426,6 +483,7 @@ export declare function createGameServerFunctions(options?: {
         saved: number;
     }>>;
 };
+/** @internal */
 export declare function createLeaderboardFunctions(options?: {
     auth?: JgAuthMode;
 }): {
@@ -456,6 +514,7 @@ export declare function createLeaderboardFunctions(options?: {
         gameId: string;
     }, Promise<null>>;
 };
+/** @internal */
 export declare function createPresenceFunctions(options?: {
     auth?: JgAuthMode;
     freshWindowMs?: number;
@@ -491,6 +550,7 @@ export declare function createPresenceFunctions(options?: {
         serverId: string;
     }, Promise<null>>;
 };
+/** @internal */
 export declare function createChatFunctions(options?: {
     auth?: JgAuthMode;
     historyLimit?: number;
@@ -514,5 +574,6 @@ export type JgCronSpec = {
     intervalSeconds: number;
     functionKey: "tickActiveServers" | "flushDirtyServers";
 };
+/** @internal */
 export declare function jgengineCronSpecs(): readonly JgCronSpec[];
 export {};

package/dist/server.js

@@ -1,6 +1,7 @@
 import { defineSchema, defineTable, internalMutationGeneric, mutationGeneric, queryGeneric, } from "convex/server";
 import { ConvexError, v } from "convex/values";
 import { createFeedWriteGate, validateFeedWrite, } from "@jgengine/core/multiplayer/feedWriteGate";
+import { normalizeJoinCode } from "@jgengine/core/multiplayer/matchmaking";
 import { decidePoseSync, spawnPresenceState, } from "@jgengine/core/multiplayer/presenceModel";
 import { createGameRuntime } from "@jgengine/core/runtime/gameRuntime";
 import { buildHydratePlayers, planServerPersist, shouldAutoSave, trimFeedEntries } from "@jgengine/core/runtime/hostPersistence";
@@ -10,6 +11,7 @@ const saveConfigValidator = v.union(v.literal("none"), v.object({
     auto: v.string(),
     scope: v.union(v.literal("player"), v.literal("chunks"), v.literal("player+chunks")),
 }));
+/** @internal */
 export function jgengineTables() {
     return {
         jgGameServers: defineTable({
@@ -30,7 +32,10 @@ export function jgengineTables() {
             dirtyAt: v.optional(v.number()),
             createdAt: v.number(),
             updatedAt: v.number(),
-        }).index("by_game_and_status", ["gameId", "status"]),
+        })
+            .index("by_game_and_status", ["gameId", "status"])
+            .index("by_status", ["status"])
+            .index("by_dirty", ["dirtyAt"]),
         jgPlayerProfiles: defineTable({
             userId: v.string(),
             gameId: v.string(),
@@ -87,6 +92,29 @@ export function jgengineTables() {
         }).index("by_server_channel", ["serverId", "channelId"]),
     };
 }
+/**
+ * Convex table for the hosted GameContext-world path: one row per (gameId, serverId) holding the full
+ * `WorldSnapshot` blob, its revision, the member roster, and each member's held input. A sibling of
+ * {@link jgengineTables} — spread either (or both) into `defineSchema`.
+  * @internal
+  */
+export function jgengineHostedTables() {
+    return {
+        jgHostedWorlds: defineTable({
+            gameId: v.string(),
+            serverId: v.string(),
+            snapshot: v.any(),
+            revision: v.number(),
+            memberUserIds: v.array(v.string()),
+            inputs: v.any(),
+            tickAnchorMs: v.number(),
+            createdAt: v.number(),
+            updatedAt: v.number(),
+        })
+            .index("by_game_and_server", ["gameId", "serverId"])
+            .index("by_tick_anchor", ["tickAnchorMs"]),
+    };
+}
 const schemaForTypes = defineSchema(jgengineTables());
 const query = queryGeneric;
 const mutation = mutationGeneric;
@@ -98,7 +126,10 @@ export const DEFAULT_CONVEX_POSE_RULES = {
     maxElapsedSec: 0.5,
     keepAliveRefreshMs: 10_000,
 };
-async function resolveActor(ctx, claimedExternalId, mode) {
+/** Resolve the acting user id under a {@link JgAuthMode}: the Convex identity when signed in (rejecting a mismatched claim), the claimed external id under `"anonymous"`, else `null`.
+ * @internal
+ */
+export async function resolveActor(ctx, claimedExternalId, mode) {
     const identity = await ctx.auth.getUserIdentity();
     if (identity !== null) {
         if (claimedExternalId !== undefined &&
@@ -113,6 +144,22 @@ async function resolveActor(ctx, claimedExternalId, mode) {
     }
     return null;
 }
+/** True when a server's `visibility` should surface in public listings/browse results.
+ * @internal
+ */
+export function isListablePublicly(visibility) {
+    return (visibility ?? "public") !== "private";
+}
+/** A non-member may enter a private server only by presenting its `joinCode`; members always pass.
+ * @internal
+ */
+export function canJoinPrivateServer(args) {
+    if (args.isMember)
+        return true;
+    if (args.joinCode === undefined || args.suppliedCode === undefined)
+        return false;
+    return normalizeJoinCode(args.suppliedCode) === normalizeJoinCode(args.joinCode);
+}
 async function requireServerMember(ctx, serverId, actorUserId) {
     const server = await ctx.db.get("jgGameServers", serverId);
     if (!server)
@@ -202,6 +249,7 @@ async function loadServerSnapshot(ctx, server, runtime) {
         revision: server.revision,
     });
 }
+/** @internal */
 export async function applyLeaderboardIncrements(ctx, gameId, entries) {
     const now = Date.now();
     for (const entry of entries) {
@@ -303,6 +351,7 @@ async function flushServerIfDue(ctx, server, now, runtime) {
     return true;
 }
 export const JG_RUNTIME_TICK_MS = 1_000;
+/** @internal */
 export function createGameServerFunctions(options) {
     const mode = options?.auth ?? "required";
     const hostSlotsPerServer = options?.slotsPerServer ?? 16;
@@ -383,8 +432,11 @@ export function createGameServerFunctions(options) {
                 throw new ConvexError("Server is full");
             }
             if ((server.visibility ?? "public") === "private" &&
-                !server.memberUserIds.includes(actorUserId) &&
-                args.serverId === undefined) {
+                !canJoinPrivateServer({
+                    isMember: server.memberUserIds.includes(actorUserId),
+                    joinCode: server.joinCode,
+                    suppliedCode: args.joinCode,
+                })) {
                 throw new ConvexError("Server is private");
             }
             const profile = await ctx.db
@@ -670,11 +722,15 @@ export function createGameServerFunctions(options) {
             updatedAt: v.number(),
         })),
         handler: async (ctx, args) => {
+            const limit = args.limit ?? 20;
             const rows = await ctx.db
                 .query("jgGameServers")
                 .withIndex("by_game_and_status", (q) => q.eq("gameId", args.gameId).eq("status", "running"))
-                .take(args.limit ?? 20);
-            return rows.map((row) => ({
+                .take(Math.min(limit * 4, 200));
+            return rows
+                .filter((row) => isListablePublicly(row.visibility))
+                .slice(0, limit)
+                .map((row) => ({
                 _id: row._id,
                 status: row.status,
                 memberCount: row.memberUserIds.length,
@@ -688,12 +744,13 @@ export function createGameServerFunctions(options) {
         args: {},
         handler: async (ctx) => {
             const now = Date.now();
-            const servers = await ctx.db.query("jgGameServers").collect();
+            const servers = await ctx.db
+                .query("jgGameServers")
+                .withIndex("by_status", (q) => q.eq("status", "running"))
+                .collect();
             let ticked = 0;
             let saved = 0;
             for (const server of servers) {
-                if (server.status !== "running")
-                    continue;
                 if (server.memberUserIds.length === 0)
                     continue;
                 const elapsedMs = now - server.tickAnchorMs;
@@ -717,11 +774,12 @@ export function createGameServerFunctions(options) {
         args: {},
         handler: async (ctx) => {
             const now = Date.now();
-            const servers = await ctx.db.query("jgGameServers").collect();
+            const servers = await ctx.db
+                .query("jgGameServers")
+                .withIndex("by_dirty", (q) => q.gt("dirtyAt", 0))
+                .collect();
             let saved = 0;
             for (const server of servers) {
-                if (server.dirtyAt === undefined)
-                    continue;
                 const runtime = resolveRuntime(registry, server.gameId);
                 const snapshot = await loadServerSnapshot(ctx, server, runtime);
                 await persistServerSnapshot(ctx, server, clearDirtyFlags(snapshot), server.save);
@@ -747,6 +805,7 @@ export function createGameServerFunctions(options) {
 }
 const leaderboardScopeValidator = v.union(v.literal("global"), v.literal("server"), v.literal("profile"));
 const MAX_LEADERBOARD_TOP_LIMIT = 100;
+/** @internal */
 export function createLeaderboardFunctions(options) {
     void options;
     const getTop = query({
@@ -810,6 +869,7 @@ export function createLeaderboardFunctions(options) {
     });
     return { getTop, getProfile, incrementMany };
 }
+/** @internal */
 export function createPresenceFunctions(options) {
     const mode = options?.auth ?? "required";
     const freshWindowMs = options?.freshWindowMs ?? 10_000;
@@ -925,6 +985,7 @@ export function createPresenceFunctions(options) {
     });
     return { list, sync, leave };
 }
+/** @internal */
 export function createChatFunctions(options) {
     const mode = options?.auth ?? "required";
     const historyLimit = options?.historyLimit ?? 100;
@@ -1020,6 +1081,7 @@ const JG_CRON_SPECS = [
     { name: "jg tick", intervalSeconds: 1, functionKey: "tickActiveServers" },
     { name: "jg flush", intervalSeconds: 60, functionKey: "flushDirtyServers" },
 ];
+/** @internal */
 export function jgengineCronSpecs() {
     return JG_CRON_SPECS;
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@jgengine/convex",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Convex adapters for JGengine: game transport, presence transport, and backend wiring over @jgengine/core.",
-  "license": "AGPL-3.0-only",
+  "license": "Apache-2.0",
   "type": "module",
   "sideEffects": false,
   "repository": {
@@ -13,7 +13,7 @@
   "files": [
     "dist",
     "CHANGELOG.md",
-    "llms.txt"
+    "skills"
   ],
   "exports": {
     ".": {
@@ -30,7 +30,7 @@
     "check-types": "tsgo --noEmit -p tsconfig.json"
   },
   "dependencies": {
-    "@jgengine/core": "^0.9.0"
+    "@jgengine/core": "^0.11.0"
   },
   "peerDependencies": {
     "convex": "^1.31.2",

package/skills/jgengine/SKILL.md

@@ -0,0 +1,51 @@
+---
+name: jgengine
+description: Route game work to the smallest useful JGengine guidance set.
+---
+
+# JGengine intake and router
+
+Read the repository [README](../../../README.md) for package truth, commands, layering, and license. This skill decides what to load; it is not an engine manual.
+
+## 1. Establish the target
+
+Capture only decisions that change architecture:
+
+- player point of view and controls
+- world shape and authored content
+- core loop, interaction, combat, and progression
+- solo, local, hosted, or persistent multiplayer
+- HUD/menu states and art direction
+- one observable completion scenario
+
+For a new in-repo game, scaffold with `bun run new:game <id> --name "Title"`. Outside this monorepo, start with `npx jgengine create`; never copy `Games/*`.
+
+## 2. Select domains
+
+Load only rows the target needs. Do not preload every domain.
+
+| Need | Skill | Owner |
+| --- | --- | --- |
+| scene placement, terrain painting, paths, asset authoring | `jgengine-editor` | editor document and authoring tools |
+| runtime world, movement, input, interaction, AI, navigation, audio | `jgengine-world` | spatial simulation and world runtime |
+| game state, systems, inventory, crafting, quests, economy, turns | `jgengine-gameplay` | non-combat rules and state |
+| targeting, stats, damage, effects, abilities, projectiles, loot | `jgengine-combat` | combat resolution |
+| HUD, menus, layout, accessibility, touch presentation | `jgengine-ui` | player-facing interface |
+| models, sprites, materials, audio files, source licensing | `jgengine-assets` | asset discovery and catalogs |
+| authority, transport, replication, sessions, host persistence | `jgengine-multiplayer` | network topology and persistence adapters |
+
+Scenes normally require both `jgengine-editor` for authoring and `jgengine-world` for runtime consumption. Combat and multiplayer are opt-in, not default intake.
+
+## 3. Discover before designing
+
+Within each selected domain:
+
+1. Search `capabilities.md` by intent; it maps needs to imports.
+2. Open `api.md` only when exact signatures or export inventory are needed.
+3. Open the linked reference only for a deeper recipe or trap.
+
+If no capability fits, identify the upstream package seam before writing game-local code. In this repository, implement a reusable primitive with its first adopter; if editor-owned content cannot be expressed, file the editor gap first.
+
+## 4. Build and finish
+
+Keep scene coordinates in the editor document, state serializable, randomness injected, and hot-path work bounded. Use `jgengine-verify` for evidence appropriate to the change. Inside this monorepo, `workflow` owns issue/PR completion. Visual polish work also uses the `jgengine-ui` quality reference.