dewdrop-sdk 0.5.2 → 0.5.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dewdrop-sdk",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "Build a three.js game for Dewdrop: the Vite plugin, model calls, multiplayer, saves and voice.",
   "license": "MIT",
   "type": "module",

package/src/backend.js

@@ -7,7 +7,7 @@
 // past its cap. The page's URL says which room the tab joins and under
 // what name; on Dewdrop the game's page says which room, and the name is
 // the player's username.
-import { MAX_NET_CLIENTS, MAX_NET_CLIENT_FRAME_BYTES, createInbox, createOutbox, defineHandlers, label, side, unpack } from './net.js';
+import { DEFAULT_ROOM_PLAYERS, MAX_NET_CLIENTS, MAX_NET_CLIENT_FRAME_BYTES, createInbox, createOutbox, defineHandlers, label, side, unpack } from './net.js';
 import { NO_CHANNEL } from './route.js';
 
 let channel = null;
@@ -59,9 +59,9 @@ function name(text) {
 }
 
 // The players a room seats as `?players=` names them: a whole number from
-// 1 to MAX_NET_CLIENTS, or the most without one or with any other.
+// 1 to MAX_NET_CLIENTS, or DEFAULT_ROOM_PLAYERS without one or with any other.
 function players(text) {
-  return /^[0-9]{1,3}$/.test(text) && Number(text) >= 1 && Number(text) <= MAX_NET_CLIENTS ? Number(text) : MAX_NET_CLIENTS;
+  return /^[0-9]{1,3}$/.test(text) && Number(text) >= 1 && Number(text) <= MAX_NET_CLIENTS ? Number(text) : DEFAULT_ROOM_PLAYERS;
 }
 
 // Where a page's URL joins its tab: the room `?room=` names, the name
@@ -86,7 +86,7 @@ export function gameHasBackend() {
 // function at the next animation frame. Without a plugin there is no
 // channel, and `send` says so. A room that seats no more says so in the
 // console, as Dewdrop refuses the connect, and the tab's sends reach no one.
-export function attachBackend(hot, { channel: routed, hasBackend: present, frame: schedule, room = '', player = '', players = MAX_NET_CLIENTS }) {
+export function attachBackend(hot, { channel: routed, hasBackend: present, frame: schedule, room = '', player = '', players = DEFAULT_ROOM_PLAYERS }) {
   if (!routed) return;
   channel = hot;
   hasBackend = present;

package/src/evaluate.js

@@ -0,0 +1,57 @@
+// A page the dev server serves offers `dewdrop.evaluate(code)`, as a dev
+// version's page on Dewdrop does, so one script drives the game in both.
+// `code`, a string or a function sent as its source text called with
+// nothing, runs at the page's top level, as the browser's console runs
+// what is typed into it: what the game puts on `globalThis` is in reach and
+// its modules' own bindings are not. The call resolves with the value the
+// code came to as JSON carries it, a promise's once it settles, `undefined`
+// for none, or rejects with an Error carrying the text of what the code
+// threw; code, waiting calls and values past what Dewdrop takes are
+// refused in Dewdrop's words. The plugin puts `evaluateScript` in the
+// page's head; it is `offerEvaluate`'s own text, so the function imports
+// nothing and is written without a `<`.
+
+// What Dewdrop takes: the bytes of a call's code, the calls waiting at
+// once, and the bytes of a value's JSON.
+export const LIMITS = Object.freeze({ code: 32764, waiting: 16, value: 65530 });
+
+// Offers `dewdrop.evaluate` on `scope`, the page's window, within `limits`.
+// Assigned rather than defined, since the game shares the window here.
+export function offerEvaluate(scope, limits) {
+  const run = scope.eval;
+  const encoder = new scope.TextEncoder();
+  const describe = (error) => {
+    try {
+      return error !== null && typeof error === 'object' && typeof error.stack === 'string' ? error.stack : String(error);
+    } catch {
+      return '[unprintable]';
+    }
+  };
+  let waiting = 0;
+  async function evaluate(code) {
+    if (typeof code === 'function') code = `(${code})()`;
+    else if (typeof code !== 'string') throw new TypeError('dewdrop.evaluate takes a string or a function');
+    if (waiting >= limits.waiting) throw new RangeError(`dewdrop.evaluate has ${limits.waiting} calls waiting already`);
+    const bytes = encoder.encode(code).length;
+    if (bytes > limits.code) throw new RangeError(`dewdrop.evaluate takes code of at most ${limits.code} bytes, not ${bytes}`);
+    waiting += 1;
+    let text;
+    try {
+      text = JSON.stringify(await run(code));
+    } catch (error) {
+      throw new Error(describe(error));
+    } finally {
+      waiting -= 1;
+    }
+    if (text === undefined) return undefined;
+    const length = encoder.encode(text).length;
+    if (length > limits.value) throw new Error(`the value is ${length} bytes as JSON, more than the ${limits.value} an answer carries`);
+    return JSON.parse(text);
+  }
+  scope.dewdrop = Object.freeze({ evaluate });
+}
+
+// The script the plugin puts in a page the dev server serves.
+export function evaluateScript() {
+  return `(${offerEvaluate})(window, ${JSON.stringify(LIMITS)});`;
+}

package/src/net.js

@@ -18,6 +18,9 @@ export const MAX_NET_PLAYER_BYTES = 64;
 // The most players a room seats, and the most clients it holds: a room's
 // size is 1 to this.
 export const MAX_NET_CLIENTS = 100;
+// The players a room seats when its page names no size: the most a game's
+// room seats on Dewdrop until its developer says otherwise.
+export const DEFAULT_ROOM_PLAYERS = 8;
 // How often the local backend ticks: sixty times a second.
 export const NET_TICK_MS = 1000 / 60;
 

package/src/serve.js

@@ -17,7 +17,7 @@
 import { existsSync, readFileSync } from 'node:fs';
 import { dirname, resolve } from 'node:path';
 import { Worker } from 'node:worker_threads';
-import { MAX_NET_CLIENTS, label } from './net.js';
+import { DEFAULT_ROOM_PLAYERS, MAX_NET_CLIENTS, label } from './net.js';
 
 // How long a room's backend runs on after its last tab's leave, as on
 // Dewdrop.
@@ -174,13 +174,13 @@ export function createBackendHost({ entry, ws, watcher, origin = () => '', log =
     // A tab joins the room its page named under the name it gave, a room
     // it makes seating the players its page said; a page that named
     // neither joins the empty room unnamed, and one that named no size a
-    // room seating the most.
-    join(client, { room = '', player = '', players = MAX_NET_CLIENTS } = {}) {
+    // room seating DEFAULT_ROOM_PLAYERS, as a game's rooms on Dewdrop do.
+    join(client, { room = '', player = '', players = DEFAULT_ROOM_PLAYERS } = {}) {
       if (tabs.has(client)) return;
       const key = typeof room === 'string' ? room : '';
       let it = rooms.get(key);
       if (it === undefined) {
-        const capacity = Number.isInteger(players) && players >= 1 && players <= MAX_NET_CLIENTS ? players : MAX_NET_CLIENTS;
+        const capacity = Number.isInteger(players) && players >= 1 && players <= MAX_NET_CLIENTS ? players : DEFAULT_ROOM_PLAYERS;
         it = createRoom(key, capacity);
         rooms.set(key, it);
       }

package/src/vite.js

@@ -6,8 +6,9 @@
 // with a backend gets a second chunk beside it, `backend.js`. In dev: the
 // route that carries a model call to its provider with the key from the
 // developer's environment, the host that runs the game's backend for the
-// tabs that join it, and the script that starts each page's storage empty
-// for the game's saves. Every other build is untouched. The plugin
+// tabs that join it, and the scripts that start each page's storage empty
+// for the game's saves and offer `dewdrop.evaluate`. Every other build is
+// untouched. The plugin
 // imports nothing from Vite itself, so it works linked from a checkout as
 // well as installed, on Vite 3 through 8.
 import { existsSync, readFileSync } from 'node:fs';
@@ -15,6 +16,7 @@ import { resolve } from 'node:path';
 import { ASSETS_DIR, BACKEND_FILE, ENTRY_FILE, PAGE_FILE, detectViteMajor, openPage, outputOptions } from './build.js';
 import { createLlmMiddleware } from './dev.js';
 import { loadKeys } from './env.js';
+import { evaluateScript } from './evaluate.js';
 import { freshScript } from './fresh.js';
 import { DEV_ROUTE } from './route.js';
 import { createBackendHost } from './serve.js';
@@ -140,14 +142,15 @@ export default function dew() {
       },
     },
     // The page the dev server serves is told whether the game has a
-    // backend, which the client's `backend` reads before it joins, and
-    // starts with its storage empty, as on Dewdrop, from a script first
-    // in the page, before anything of its own.
+    // backend, which the client's `backend` reads before it joins, starts
+    // with its storage empty, as on Dewdrop, and offers `dewdrop.evaluate`,
+    // as a dev version's page does, from a script first in the page,
+    // before anything of its own.
     // A build's page, which no dev server serves, is left alone.
     transformIndexHtml(html) {
       if (!serving) return undefined;
       return {
-        html: withFirstScript(html, freshScript(game)),
+        html: withFirstScript(html, freshScript(game) + evaluateScript()),
         tags: [{ tag: 'meta', attrs: { name: 'dew-backend', content: entry === null ? 'no' : 'yes' }, injectTo: 'head' }],
       };
     },