@mudlet/mudlet-web 0.3.0 → 0.4.0

package/dist-lib/vfs-sw.js

@@ -1,131 +1,131 @@
-// Service worker that serves ProfileVFS-backed assets at /__vfs/<connectionId>/<path>.
-// The page is the source of truth for VFS contents (the SW can't share folder
-// handles or always-open the same IDB store), so each request round-trips to
-// the client via MessageChannel.
-
-const CACHE_NAME = 'mudix-vfs-v1';
-// Scope path always ends with '/'. On a root-served deploy this is '/'; on
-// GitHub Pages or any subpath deploy it's '/<repo>/'. The intercept prefix is
-// '<scope>__vfs/' so SW-controlled URLs stay inside scope.
-const SCOPE_PATH = new URL(self.registration.scope).pathname;
-const PREFIX = `${SCOPE_PATH}__vfs/`;
-const READ_TIMEOUT_MS = 5000;
-
-self.addEventListener('install', () => self.skipWaiting());
-self.addEventListener('activate', (e) => e.waitUntil(self.clients.claim()));
-
-self.addEventListener('fetch', (event) => {
-    const url = new URL(event.request.url);
-    if (url.origin !== self.location.origin) return;
-    if (!url.pathname.startsWith(PREFIX)) return;
-    event.respondWith(handle(event, url));
-});
-
-async function handle(event, url) {
-    const rest = url.pathname.slice(PREFIX.length).split('/').filter(Boolean);
-    if (rest.length < 2) return new Response('Bad request', { status: 400 });
-    const connectionId = decodeURIComponent(rest[0]);
-    const filePath = '/' + rest.slice(1).map(decodeURIComponent).join('/');
-
-    const cache = await caches.open(CACHE_NAME);
-    const cached = await cache.match(event.request);
-    if (cached) return cached;
-
-    const client = await pickClient(event);
-    if (!client) {
-        // Either there's no app tab loaded (direct URL hit in fresh tab) or
-        // the only candidate is the tab currently navigating to this URL.
-        return new Response('No app tab loaded; open mudix first', { status: 503 });
-    }
-
-    const reply = await ask(client, { type: 'vfs:read', connectionId, path: filePath });
-    if (!reply || !reply.ok) {
-        return new Response(reply?.error ?? 'Not found', { status: 404 });
-    }
-
-    const headers = new Headers();
-    headers.set('Content-Type', reply.contentType || 'application/octet-stream');
-    // no-store keeps this response out of the browser's own HTTP cache, which
-    // has no validator to revalidate against (we set none) and would otherwise
-    // race our explicit Cache Storage entry above — that race is what produced
-    // stale 304-with-no-body responses for cached images. The Cache Storage
-    // entry (invalidated on writes via postMessage) is the only cache that
-    // should own this decision.
-    headers.set('Cache-Control', 'no-store');
-    const response = new Response(reply.bytes, { headers });
-    cache.put(event.request, response.clone()).catch(() => {});
-    return response;
-}
-
-async function pickClient(event) {
-    // Prefer the client that issued this request — for sub-resource fetches
-    // that's the loaded app page, which can reply immediately.
-    const requestingId = event.clientId || event.resultingClientId || '';
-    if (requestingId) {
-        const c = await self.clients.get(requestingId);
-        if (c && isUsable(c)) return c;
-    }
-    const all = await self.clients.matchAll({ type: 'window', includeUncontrolled: true });
-    const usable = all.filter(isUsable);
-    return usable.find((c) => c.focused) ?? usable[0] ?? null;
-}
-
-// Skip clients that are themselves navigating to a /__vfs/ URL — those are
-// fresh tabs in the middle of loading the SW response; they have no JS running
-// and can't reply, so picking one guarantees a timeout.
-function isUsable(client) {
-    try {
-        return !new URL(client.url).pathname.startsWith(PREFIX);
-    } catch {
-        return false;
-    }
-}
-
-function ask(client, message) {
-    return new Promise((resolve) => {
-        const channel = new MessageChannel();
-        const timer = setTimeout(() => {
-            channel.port1.close();
-            resolve({ ok: false, error: 'timeout' });
-        }, READ_TIMEOUT_MS);
-        channel.port1.onmessage = (e) => {
-            clearTimeout(timer);
-            channel.port1.close();
-            resolve(e.data);
-        };
-        client.postMessage(message, [channel.port2]);
-    });
-}
-
-self.addEventListener('message', (event) => {
-    const data = event.data;
-    if (!data) return;
-    if (data.type === 'vfs:invalidate') {
-        event.waitUntil(invalidate(data));
-    }
-});
-
-async function invalidate({ connectionId, path }) {
-    if (!connectionId) {
-        await caches.delete(CACHE_NAME);
-        return;
-    }
-    const cache = await caches.open(CACHE_NAME);
-    const connPrefix = `${PREFIX}${encodeURIComponent(connectionId)}/`;
-    const keys = await cache.keys();
-    if (path) {
-        const segs = path.split('/').filter(Boolean).map(encodeURIComponent).join('/');
-        const target = `${connPrefix}${segs}`;
-        await Promise.all(
-            keys
-                .filter((req) => new URL(req.url).pathname === target)
-                .map((req) => cache.delete(req)),
-        );
-        return;
-    }
-    await Promise.all(
-        keys
-            .filter((req) => new URL(req.url).pathname.startsWith(connPrefix))
-            .map((req) => cache.delete(req)),
-    );
-}
+// Service worker that serves ProfileVFS-backed assets at /__vfs/<connectionId>/<path>.
+// The page is the source of truth for VFS contents (the SW can't share folder
+// handles or always-open the same IDB store), so each request round-trips to
+// the client via MessageChannel.
+
+const CACHE_NAME = 'mudix-vfs-v1';
+// Scope path always ends with '/'. On a root-served deploy this is '/'; on
+// GitHub Pages or any subpath deploy it's '/<repo>/'. The intercept prefix is
+// '<scope>__vfs/' so SW-controlled URLs stay inside scope.
+const SCOPE_PATH = new URL(self.registration.scope).pathname;
+const PREFIX = `${SCOPE_PATH}__vfs/`;
+const READ_TIMEOUT_MS = 5000;
+
+self.addEventListener('install', () => self.skipWaiting());
+self.addEventListener('activate', (e) => e.waitUntil(self.clients.claim()));
+
+self.addEventListener('fetch', (event) => {
+    const url = new URL(event.request.url);
+    if (url.origin !== self.location.origin) return;
+    if (!url.pathname.startsWith(PREFIX)) return;
+    event.respondWith(handle(event, url));
+});
+
+async function handle(event, url) {
+    const rest = url.pathname.slice(PREFIX.length).split('/').filter(Boolean);
+    if (rest.length < 2) return new Response('Bad request', { status: 400 });
+    const connectionId = decodeURIComponent(rest[0]);
+    const filePath = '/' + rest.slice(1).map(decodeURIComponent).join('/');
+
+    const cache = await caches.open(CACHE_NAME);
+    const cached = await cache.match(event.request);
+    if (cached) return cached;
+
+    const client = await pickClient(event);
+    if (!client) {
+        // Either there's no app tab loaded (direct URL hit in fresh tab) or
+        // the only candidate is the tab currently navigating to this URL.
+        return new Response('No app tab loaded; open mudix first', { status: 503 });
+    }
+
+    const reply = await ask(client, { type: 'vfs:read', connectionId, path: filePath });
+    if (!reply || !reply.ok) {
+        return new Response(reply?.error ?? 'Not found', { status: 404 });
+    }
+
+    const headers = new Headers();
+    headers.set('Content-Type', reply.contentType || 'application/octet-stream');
+    // no-store keeps this response out of the browser's own HTTP cache, which
+    // has no validator to revalidate against (we set none) and would otherwise
+    // race our explicit Cache Storage entry above — that race is what produced
+    // stale 304-with-no-body responses for cached images. The Cache Storage
+    // entry (invalidated on writes via postMessage) is the only cache that
+    // should own this decision.
+    headers.set('Cache-Control', 'no-store');
+    const response = new Response(reply.bytes, { headers });
+    cache.put(event.request, response.clone()).catch(() => {});
+    return response;
+}
+
+async function pickClient(event) {
+    // Prefer the client that issued this request — for sub-resource fetches
+    // that's the loaded app page, which can reply immediately.
+    const requestingId = event.clientId || event.resultingClientId || '';
+    if (requestingId) {
+        const c = await self.clients.get(requestingId);
+        if (c && isUsable(c)) return c;
+    }
+    const all = await self.clients.matchAll({ type: 'window', includeUncontrolled: true });
+    const usable = all.filter(isUsable);
+    return usable.find((c) => c.focused) ?? usable[0] ?? null;
+}
+
+// Skip clients that are themselves navigating to a /__vfs/ URL — those are
+// fresh tabs in the middle of loading the SW response; they have no JS running
+// and can't reply, so picking one guarantees a timeout.
+function isUsable(client) {
+    try {
+        return !new URL(client.url).pathname.startsWith(PREFIX);
+    } catch {
+        return false;
+    }
+}
+
+function ask(client, message) {
+    return new Promise((resolve) => {
+        const channel = new MessageChannel();
+        const timer = setTimeout(() => {
+            channel.port1.close();
+            resolve({ ok: false, error: 'timeout' });
+        }, READ_TIMEOUT_MS);
+        channel.port1.onmessage = (e) => {
+            clearTimeout(timer);
+            channel.port1.close();
+            resolve(e.data);
+        };
+        client.postMessage(message, [channel.port2]);
+    });
+}
+
+self.addEventListener('message', (event) => {
+    const data = event.data;
+    if (!data) return;
+    if (data.type === 'vfs:invalidate') {
+        event.waitUntil(invalidate(data));
+    }
+});
+
+async function invalidate({ connectionId, path }) {
+    if (!connectionId) {
+        await caches.delete(CACHE_NAME);
+        return;
+    }
+    const cache = await caches.open(CACHE_NAME);
+    const connPrefix = `${PREFIX}${encodeURIComponent(connectionId)}/`;
+    const keys = await cache.keys();
+    if (path) {
+        const segs = path.split('/').filter(Boolean).map(encodeURIComponent).join('/');
+        const target = `${connPrefix}${segs}`;
+        await Promise.all(
+            keys
+                .filter((req) => new URL(req.url).pathname === target)
+                .map((req) => cache.delete(req)),
+        );
+        return;
+    }
+    await Promise.all(
+        keys
+            .filter((req) => new URL(req.url).pathname.startsWith(connPrefix))
+            .map((req) => cache.delete(req)),
+    );
+}

package/dist-lib/vite.js

@@ -95,6 +95,28 @@ export default function mudix() {
         {
             name: 'mudix:config',
             config: () => ({
+                resolve: {
+                    // Exactly one React instance, always. `mudlet-map-editor`
+                    // declares react/react-dom as plain *dependencies* (not
+                    // peers), so the moment its range outruns the range the
+                    // app resolved, the package manager nests a second copy
+                    // under the editor. The editor's `App` is then rendered by
+                    // mudix's React while its hooks come from the nested one,
+                    // whose dispatcher is null — "Invalid hook call", and with
+                    // no error boundary above the lazy boundary the throw
+                    // unmounts the whole root, so opening the map editor
+                    // blanked the entire UI in dev and in production alike.
+                    // Deduping is the structural fix: it survives the next
+                    // version skew, and consumers of the library (which
+                    // externalizes react) get it through this plugin too.
+                    dedupe: ['react', 'react-dom'],
+                },
+                // A Mudlet package archive is a zip, not source. `?url` imports
+                // get away without this (the explicit query short-circuits
+                // import analysis), but `?inline` — which the busted fixtures
+                // use to carry an archive into the VFS — reaches the asset
+                // pipeline and needs the extension declared.
+                assetsInclude: ['**/*.mpackage'],
                 optimizeDeps: {
                     // 'mudix': the library entry carries relative `?url` asset
                     // imports (external in the lib build); the dep optimizer's

package/package.json

@@ -1,93 +1,97 @@
-{
-  "name": "@mudlet/mudlet-web",
-  "version": "0.3.0",
-  "type": "module",
-  "description": "Mudlet Web — Mudlet in the browser, usable standalone or as a library for branded builds",
-  "license": "GPL-2.0-or-later",
-  "keywords": [
-    "mud",
-    "mudlet",
-    "mud-client",
-    "telnet",
-    "lua",
-    "game"
-  ],
-  "homepage": "https://github.com/Mudlet/mudlet-web",
-  "repository": {
-    "url": "git+https://github.com/Mudlet/mudlet-web.git"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "exports": {
-    ".": {
-      "types": "./dist-lib/index.d.ts",
-      "import": "./dist-lib/index.js"
-    },
-    "./vite": {
-      "types": "./dist-lib/vite.d.ts",
-      "import": "./dist-lib/vite.js"
-    },
-    "./styles.css": "./dist-lib/styles.css"
-  },
-  "main": "./dist-lib/index.js",
-  "types": "./dist-lib/index.d.ts",
-  "files": [
-    "dist-lib"
-  ],
-  "scripts": {
-    "dev": "vite",
-    "build": "tsc && vite build",
-    "build:lib": "vite build --config vite.lib.config.ts && tsc -p tsconfig.lib.json && tsc -p tsconfig.vite-plugin.json && node scripts/copy-lib-assets.mjs",
-    "prepublishOnly": "yarn build:lib",
-    "preview": "vite preview",
-    "typecheck": "tsc -p tsconfig.test.json",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "dev:busted": "vite --mode busted --port 5174 --strictPort",
-    "pretest:e2e": "npm run gen:busted-manifest",
-    "test:e2e": "playwright test",
-    "gen:busted-manifest": "playwright test -c playwright.manifest.config.ts",
-    "sync:mudlet-specs": "node scripts/sync-mudlet-specs.mjs"
-  },
-  "dependencies": {
-    "@codemirror/autocomplete": "^6.20.1",
-    "@codemirror/commands": "^6.10.3",
-    "@codemirror/lang-json": "^6.0.2",
-    "@codemirror/language": "^6.12.3",
-    "@codemirror/legacy-modes": "^6.5.2",
-    "@codemirror/state": "^6.6.0",
-    "@codemirror/theme-one-dark": "^6.1.3",
-    "@codemirror/view": "^6.41.1",
-    "@sqlite.org/sqlite-wasm": "^3.53.0-build1",
-    "@types/dompurify": "^3.0.5",
-    "@zenfs/core": "^2.5.6",
-    "@zenfs/dom": "^1.2.9",
-    "dompurify": "^3.4.12",
-    "fflate": "^0.8.2",
-    "lucide-react": "^1.14.0",
-    "marked": "^18.0.4",
-    "mudlet-map-binary-reader": "^1.2.0",
-    "mudlet-map-editor": "^1.3.1",
-    "mudlet-map-renderer": "^2.6.1",
-    "pako": "^2.1.0",
-    "pcre2-wasm-universal": "^1.0.0",
-    "react": "^19.2.0",
-    "react-dom": "^19.2.0",
-    "vite-plugin-node-polyfills": "^0.26.0",
-    "wasmoon-lua5.1": "^1.18.10",
-    "zustand": "^5.0.12"
-  },
-  "devDependencies": {
-    "@playwright/test": "^1.61.1",
-    "@types/node": "^25.6.0",
-    "@types/pako": "^2.0.0",
-    "@types/react": "^19.2.0",
-    "@types/react-dom": "^19.2.0",
-    "@vitejs/plugin-react": "^6.0.1",
-    "happy-dom": "^20.9.0",
-    "typescript": "^5.0.0",
-    "vite": "8.0.16",
-    "vitest": "^4.1.7"
-  }
-}
+{
+  "name": "@mudlet/mudlet-web",
+  "version": "0.4.0",
+  "type": "module",
+  "description": "Mudlet Web — Mudlet in the browser, usable standalone or as a library for branded builds",
+  "license": "GPL-2.0-or-later",
+  "keywords": [
+    "mud",
+    "mudlet",
+    "mud-client",
+    "telnet",
+    "lua",
+    "game"
+  ],
+  "homepage": "https://github.com/Mudlet/mudlet-web",
+  "repository": {
+    "url": "git+https://github.com/Mudlet/mudlet-web.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist-lib/index.d.ts",
+      "import": "./dist-lib/index.js"
+    },
+    "./vite": {
+      "types": "./dist-lib/vite.d.ts",
+      "import": "./dist-lib/vite.js"
+    },
+    "./styles.css": "./dist-lib/styles.css"
+  },
+  "main": "./dist-lib/index.js",
+  "types": "./dist-lib/index.d.ts",
+  "files": [
+    "dist-lib"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "build:lib": "vite build --config vite.lib.config.ts && tsc -p tsconfig.lib.json && tsc -p tsconfig.vite-plugin.json && node scripts/copy-lib-assets.mjs",
+    "prepublishOnly": "yarn build:lib",
+    "preview": "vite preview",
+    "typecheck": "tsc -p tsconfig.test.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "dev:busted": "vite --mode busted --port 5174 --strictPort",
+    "test:e2e": "playwright test",
+    "busted:failures": "playwright test -c playwright.failures.config.ts",
+    "sync:mudlet-specs": "node scripts/sync-mudlet-specs.mjs",
+    "sync:mudlet-lua": "node scripts/sync-mudlet-lua.mjs",
+    "sync:mudlet-games": "node scripts/sync-mudlet-games.mjs"
+  },
+  "dependencies": {
+    "@codemirror/autocomplete": "^6.20.1",
+    "@codemirror/commands": "^6.10.3",
+    "@codemirror/lang-json": "^6.0.2",
+    "@codemirror/language": "^6.12.3",
+    "@codemirror/legacy-modes": "^6.5.2",
+    "@codemirror/state": "^6.6.0",
+    "@codemirror/theme-one-dark": "^6.1.3",
+    "@codemirror/view": "^6.41.1",
+    "@sqlite.org/sqlite-wasm": "^3.53.0-build1",
+    "@types/dompurify": "^3.0.5",
+    "@zenfs/core": "^2.5.6",
+    "@zenfs/dom": "^1.2.9",
+    "dompurify": "^3.4.14",
+    "fflate": "^0.8.2",
+    "lucide-react": "^1.14.0",
+    "marked": "^18.0.4",
+    "mudlet-map-binary-reader": "^1.2.0",
+    "mudlet-map-editor": "^1.3.2",
+    "mudlet-map-renderer": "^2.6.1",
+    "pako": "^2.1.0",
+    "pcre2-wasm-universal": "^1.0.0",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "vite-plugin-node-polyfills": "^0.26.0",
+    "wasmoon-lua5.1": "^1.18.10",
+    "zustand": "^5.0.12"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.61.1",
+    "@types/node": "^25.6.0",
+    "@types/pako": "^2.0.0",
+    "@types/react": "^19.2.0",
+    "@types/react-dom": "^19.2.0",
+    "@vitejs/plugin-react": "^6.0.1",
+    "happy-dom": "^20.9.0",
+    "typescript": "^5.0.0",
+    "vite": "8.0.16",
+    "vitest": "^4.1.7"
+  },
+  "resolutions": {
+    "dompurify": "^3.4.14"
+  }
+}

package/dist-lib/ui/windows/panels/VfsModulePickerModal.d.ts

@@ -1,8 +0,0 @@
-import type { ProfileVFS } from '../../../scripting/vfs/ProfileVFS';
-interface Props {
-    vfs: ProfileVFS;
-    onClose: () => void;
-    onPick: (absolutePath: string) => void;
-}
-export declare function VfsModulePickerModal({ vfs, onClose, onPick }: Props): import("react/jsx-runtime").JSX.Element;
-export {};