sci2-ts 0.15.0 → 0.15.1

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project. Versions follow [Semantic Versioning](https
 and the entries are generated from commit messages
 ([Conventional Commits](https://www.conventionalcommits.org/)) when a release is made.
 
+## [0.15.1](https://github.com/rlueder/sci-ts/compare/v0.15.0...v0.15.1) (2026-10-02)
+
+### Fixed
+
+* **viewer:** fetch game files with the build's version ([#18](https://github.com/rlueder/sci-ts/issues/18)) ([370e490](https://github.com/rlueder/sci-ts/commit/370e490d9c618d78223fbba1df4850a8c6ebb0a2))
+
 ## [0.15.0](https://github.com/rlueder/sci-ts/compare/v0.14.0...v0.15.0) (2026-10-02)
 
 ### Added

package/apps/viewer/src/files.d.ts

@@ -4,6 +4,11 @@ export declare const BASE: string;
 /**
  * FileSource over game/: the dev server's mount (see vite.config.ts), or the game copied
  * next to a built site, with its file names in game/files.json (`pnpm game site`).
+ *
+ * A built site's files.json also has the build's `version`. It's always fetched fresh, and
+ * every game file is fetched with the version on its URL, so after a new build a browser
+ * can't mix its cached files with the new ones (an old RESOURCE.000 under a new RESOURCE.MAP
+ * doesn't start).
  */
 export declare const httpFiles: FileSource;
 /**

package/apps/viewer/src/files.js

@@ -5,14 +5,19 @@ export const BASE = import.meta.env.BASE_URL;
 /**
  * FileSource over game/: the dev server's mount (see vite.config.ts), or the game copied
  * next to a built site, with its file names in game/files.json (`pnpm game site`).
+ *
+ * A built site's files.json also has the build's `version`. It's always fetched fresh, and
+ * every game file is fetched with the version on its URL, so after a new build a browser
+ * can't mix its cached files with the new ones (an old RESOURCE.000 under a new RESOURCE.MAP
+ * doesn't start).
  */
 export const httpFiles = {
     async read(path) {
-        const res = await fetch(`${BASE}game/${path}`);
+        const res = await fetch(await gameUrl(path));
         return res.ok ? new Uint8Array(await res.arrayBuffer()) : undefined;
     },
     async readRange(path, offset, length) {
-        const res = await fetch(`${BASE}game/${path}`, { headers: { Range: `bytes=${offset}-${offset + length - 1}` } });
+        const res = await fetch(await gameUrl(path), { headers: { Range: `bytes=${offset}-${offset + length - 1}` } });
         const bytes = new Uint8Array(await res.arrayBuffer());
         // A server that ignores Range (Python's http.server) sends the whole file.
         return res.status === 206 ? bytes : bytes.subarray(offset, offset + length);
@@ -20,11 +25,20 @@ export const httpFiles = {
     async list(dir) {
         if (import.meta.env.DEV)
             return (await fetch(`/__list?dir=${encodeURIComponent(dir)}`)).json();
-        staticListing ??= fetch(`${BASE}game/files.json`).then((r) => (r.ok ? r.json() : {}));
-        return (await staticListing)[dir] ?? [];
+        const files = (await staticListing())[dir];
+        return Array.isArray(files) ? files : [];
     },
 };
-let staticListing;
+let listing;
+const staticListing = () => (listing ??= fetch(`${BASE}game/files.json`, { cache: "no-store" }).then((r) => (r.ok ? r.json() : Promise.resolve({}))));
+/** A game file's URL: on a built site, with the build's version (see httpFiles). */
+async function gameUrl(path) {
+    const url = `${BASE}game/${path}`;
+    if (import.meta.env.DEV)
+        return url;
+    const version = (await staticListing()).version;
+    return typeof version === "string" ? `${url}?v=${encodeURIComponent(version)}` : url;
+}
 // --- Mods -------------------------------------------------------------------------------
 const MODS_KEY = `${APP_ID}.mods`;
 /**

package/apps/viewer/src/files.ts

@@ -7,25 +7,40 @@ export const BASE = import.meta.env.BASE_URL;
 /**
  * FileSource over game/: the dev server's mount (see vite.config.ts), or the game copied
  * next to a built site, with its file names in game/files.json (`pnpm game site`).
+ *
+ * A built site's files.json also has the build's `version`. It's always fetched fresh, and
+ * every game file is fetched with the version on its URL, so after a new build a browser
+ * can't mix its cached files with the new ones (an old RESOURCE.000 under a new RESOURCE.MAP
+ * doesn't start).
  */
 export const httpFiles: FileSource = {
   async read(path) {
-    const res = await fetch(`${BASE}game/${path}`);
+    const res = await fetch(await gameUrl(path));
     return res.ok ? new Uint8Array(await res.arrayBuffer()) : undefined;
   },
   async readRange(path, offset, length) {
-    const res = await fetch(`${BASE}game/${path}`, { headers: { Range: `bytes=${offset}-${offset + length - 1}` } });
+    const res = await fetch(await gameUrl(path), { headers: { Range: `bytes=${offset}-${offset + length - 1}` } });
     const bytes = new Uint8Array(await res.arrayBuffer());
     // A server that ignores Range (Python's http.server) sends the whole file.
     return res.status === 206 ? bytes : bytes.subarray(offset, offset + length);
   },
   async list(dir) {
     if (import.meta.env.DEV) return (await fetch(`/__list?dir=${encodeURIComponent(dir)}`)).json();
-    staticListing ??= fetch(`${BASE}game/files.json`).then((r) => (r.ok ? r.json() : {}));
-    return (await staticListing)[dir] ?? [];
+    const files = (await staticListing())[dir];
+    return Array.isArray(files) ? files : [];
   },
 };
-let staticListing: Promise<Record<string, string[]>> | undefined;
+
+let listing: Promise<Record<string, unknown>> | undefined;
+const staticListing = () => (listing ??= fetch(`${BASE}game/files.json`, { cache: "no-store" }).then((r): Promise<Record<string, unknown>> => (r.ok ? r.json() : Promise.resolve({}))));
+
+/** A game file's URL: on a built site, with the build's version (see httpFiles). */
+async function gameUrl(path: string): Promise<string> {
+  const url = `${BASE}game/${path}`;
+  if (import.meta.env.DEV) return url;
+  const version = (await staticListing()).version;
+  return typeof version === "string" ? `${url}?v=${encodeURIComponent(version)}` : url;
+}
 
 // --- Mods -------------------------------------------------------------------------------
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sci2-ts",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "description": "An SCI2 adventure game engine in TypeScript, and the tools to make games with it",
   "license": "MIT",
   "type": "module",

package/tools/site/build.d.ts

@@ -6,3 +6,5 @@ export declare function buildSite(gameDir: string, outDir: string, options?: {
     game: string;
     soundFont: boolean;
 }>;
+/** A short hash of the game's files: changes whenever any of them does. */
+export declare function buildVersion(files: Record<string, Uint8Array>): string;

package/tools/site/build.js

@@ -1,3 +1,4 @@
+import { createHash } from "node:crypto";
 import { cpSync, existsSync, mkdirSync, readFileSync, readdirSync, rmSync, statSync, writeFileSync } from "node:fs";
 import { basename, dirname, join, relative, resolve } from "node:path";
 import { writeResourceArchive } from "../../packages/sci/src/index.js";
@@ -40,7 +41,8 @@ export async function buildSite(gameDir, outDir, options = {}) {
     for (const [name, data] of Object.entries(files))
         writeFileSync(join(play, "game", name), data);
     // What the player lists in place of the dev server's directory listings.
-    writeFileSync(join(play, "game/files.json"), JSON.stringify({ "": Object.keys(files) }));
+    // With the build's version, which the player fetches every file with (apps/viewer/src/files.ts).
+    writeFileSync(join(play, "game/files.json"), JSON.stringify({ "": Object.keys(files), version: buildVersion(files) }));
     const sf2 = [join(resolve(gameDir), SOUNDFONT), join(ROOT, SOUNDFONT)].find((f) => existsSync(f));
     const soundFont = sf2 !== undefined;
     if (sf2)
@@ -110,3 +112,10 @@ ${body}
 </html>
 `;
 }
+/** A short hash of the game's files: changes whenever any of them does. */
+export function buildVersion(files) {
+    const hash = createHash("sha256");
+    for (const name of Object.keys(files).sort())
+        hash.update(name).update(files[name]);
+    return hash.digest("hex").slice(0, 12);
+}

package/tools/site/build.ts

@@ -1,3 +1,4 @@
+import { createHash } from "node:crypto";
 import { cpSync, existsSync, mkdirSync, readFileSync, readdirSync, rmSync, statSync, writeFileSync } from "node:fs";
 import { basename, dirname, join, relative, resolve } from "node:path";
 import { writeResourceArchive } from "../../packages/sci/src/index.ts";
@@ -46,7 +47,8 @@ export async function buildSite(
   mkdirSync(join(play, "game"), { recursive: true });
   for (const [name, data] of Object.entries(files)) writeFileSync(join(play, "game", name), data);
   // What the player lists in place of the dev server's directory listings.
-  writeFileSync(join(play, "game/files.json"), JSON.stringify({ "": Object.keys(files) }));
+  // With the build's version, which the player fetches every file with (apps/viewer/src/files.ts).
+  writeFileSync(join(play, "game/files.json"), JSON.stringify({ "": Object.keys(files), version: buildVersion(files) }));
   const sf2 = [join(resolve(gameDir), SOUNDFONT), join(ROOT, SOUNDFONT)].find((f) => existsSync(f));
   const soundFont = sf2 !== undefined;
   if (sf2) cpSync(sf2, join(play, "soundfonts", basename(sf2)));
@@ -116,3 +118,10 @@ ${body}
 </html>
 `;
 }
+
+/** A short hash of the game's files: changes whenever any of them does. */
+export function buildVersion(files: Record<string, Uint8Array>): string {
+  const hash = createHash("sha256");
+  for (const name of Object.keys(files).sort()) hash.update(name).update(files[name]!);
+  return hash.digest("hex").slice(0, 12);
+}