@mudlet/mudlet-web 0.3.0

package/dist-lib/vite.js

@@ -0,0 +1,154 @@
+import { readFileSync, existsSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { fileURLToPath } from 'node:url';
+import { dirname, join } from 'node:path';
+import { nodePolyfills } from 'vite-plugin-node-polyfills';
+/**
+ * The `@mudlet/mudlet-web/vite` companion plugin. The library leaves all of its
+ * heavyweight dependencies external, so the consumer's Vite processes them —
+ * and needs the same handling the app build has: the pcre2 WASM file
+ * at the site root, node polyfills on the main thread and in workers, and the
+ * VFS service worker emitted into the output. One plugin call supplies all of
+ * it:
+ *
+ *     import mudletWeb from '@mudlet/mudlet-web/vite';
+ *     export default defineConfig({ plugins: [mudletWeb(), react()] });
+ *
+ * Mudlet Web's own vite.config.ts uses this plugin too (imported from source), so
+ * the app build and consumer builds can't drift apart.
+ */
+const require = createRequire(import.meta.url);
+const POLYFILLS = ['buffer', 'stream', 'events', 'util'];
+/** vfs-sw.js ships next to the compiled plugin in dist-lib (consumers) and in
+ *  public/ when running from the mudix repo itself (source import). */
+function resolveVfsSwPath() {
+    for (const rel of ['./vfs-sw.js', '../public/vfs-sw.js']) {
+        const p = fileURLToPath(new URL(rel, import.meta.url));
+        if (existsSync(p))
+            return p;
+    }
+    return null;
+}
+/** Serves libpcre2.wasm at the root URL in dev (where emscripten looks for it
+ *  when document.currentScript is null) and emits it to the build output.
+ *  Resolved from wherever pcre2-wasm-universal lives relative to mudix. */
+function pcre2WasmPlugin() {
+    // The wasm file isn't in the package's exports map — resolve the exported
+    // ./libpcre2 entry (dist/libpcre2.js) and take its sibling.
+    const wasmPath = join(dirname(require.resolve('pcre2-wasm-universal/libpcre2')), 'libpcre2.wasm');
+    return {
+        name: 'mudix:pcre2-wasm',
+        configureServer(server) {
+            server.middlewares.use((req, res, next) => {
+                if (req.url === '/libpcre2.wasm') {
+                    res.setHeader('Content-Type', 'application/wasm');
+                    res.end(readFileSync(wasmPath));
+                    return;
+                }
+                next();
+            });
+        },
+        generateBundle() {
+            this.emitFile({
+                type: 'asset',
+                fileName: 'libpcre2.wasm',
+                source: readFileSync(wasmPath),
+            });
+        },
+    };
+}
+/** Serves/emits the VFS service worker at the site root so
+ *  `registerVfsServiceWorker()` (called by MudletWebApp) finds it. Skipped when
+ *  the consumer already ships its own copy in public/ — as the standalone
+ *  mudix app does. */
+function vfsServiceWorkerPlugin() {
+    const swPath = resolveVfsSwPath();
+    let skip = false;
+    return {
+        name: 'mudix:vfs-sw',
+        configResolved(config) {
+            skip = !swPath || (!!config.publicDir && existsSync(join(config.publicDir, 'vfs-sw.js')));
+        },
+        configureServer(server) {
+            server.middlewares.use((req, res, next) => {
+                if (!skip && swPath && req.url?.split('?')[0] === '/vfs-sw.js') {
+                    res.setHeader('Content-Type', 'text/javascript');
+                    res.end(readFileSync(swPath));
+                    return;
+                }
+                next();
+            });
+        },
+        generateBundle() {
+            if (skip || !swPath)
+                return;
+            this.emitFile({
+                type: 'asset',
+                fileName: 'vfs-sw.js',
+                source: readFileSync(swPath, 'utf8'),
+            });
+        },
+    };
+}
+export default function mudix() {
+    return [
+        {
+            name: 'mudix:config',
+            config: () => ({
+                optimizeDeps: {
+                    // 'mudix': the library entry carries relative `?url` asset
+                    // imports (external in the lib build); the dep optimizer's
+                    // scanner treats the query as part of a filesystem path and
+                    // dies on Windows (os error 123). Excluded, mudix is served
+                    // through Vite's transform pipeline in dev, where `?url`
+                    // works. Harmless in mudix's own repo (not a dep there).
+                    exclude: ['pcre2-wasm-universal', '@mudlet/mudlet-web'],
+                    // CJS deps reached from the excluded mudix entry must be
+                    // pre-bundled explicitly (Vite doesn't interop CJS served
+                    // raw). Extend this list if dev mode reports "does not
+                    // provide an export named ..." for another dependency.
+                    //
+                    // 'mudlet-map-editor' stands for its whole subtree rather
+                    // than the individual CJS leaves: the editor pulls in
+                    // react-i18next, whose own deps (use-sync-external-store,
+                    // html-parse-stringify > void-elements) are CJS, and which
+                    // of them trips first depends on evaluation order. Listing
+                    // the editor pre-bundles the lot in one go — and mirrors
+                    // mudix's own dev server, where the scanner finds the
+                    // `import('mudlet-map-editor')` in MapEditorModal and
+                    // pre-bundles it anyway. Bare package names only, no
+                    // subpaths: `mudlet-map-renderer/bigmap` and friends only
+                    // exist in newer versions, and an unresolvable `include`
+                    // entry is a hard dev-server startup failure.
+                    include: [
+                        'eventemitter3',
+                        'wasmoon-lua5.1',
+                        '@zenfs/core > readable-stream',
+                        'mudlet-map-editor',
+                    ],
+                },
+                // Workers don't inherit `plugins`; re-declare nodePolyfills so
+                // the map parser worker (Buffer) gets the same shim it gets on
+                // the main thread.
+                worker: {
+                    format: 'es',
+                    plugins: () => [nodePolyfills({ include: POLYFILLS })],
+                },
+                build: {
+                    rollupOptions: {
+                        onwarn(warning, defaultHandler) {
+                            if (warning.code === 'COMMONJS_VARIABLE_IN_ESM' &&
+                                warning.id?.includes('pcre2-wasm-universal')) {
+                                return;
+                            }
+                            defaultHandler(warning);
+                        },
+                    },
+                },
+            }),
+        },
+        nodePolyfills({ include: POLYFILLS }),
+        pcre2WasmPlugin(),
+        vfsServiceWorkerPlugin(),
+    ];
+}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "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"
+  }
+}