dbtour-addon-explorer 0.0.0-stage → 0.2.0

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "dbtour-addon-explorer",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "The dbtour page: search, table view and neighbourhood diagrams in one HTML file that opens without a server.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Victor Saly",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/victorsaly/dbtour.git",
+    "directory": "packages/addon-explorer"
+  },
+  "engines": {
+    "node": ">=22.18"
+  },
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "files": [
+    "src/index.ts",
+    "dist"
+  ],
+  "scripts": {
+    "build": "node build.mjs",
+    "prepack": "node build.mjs"
+  },
+  "keywords": [
+    "dbtour",
+    "database",
+    "documentation",
+    "erd",
+    "schema",
+    "explorer"
+  ],
+  "devDependencies": {
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "@xyflow/react": "^12.12.0",
+    "dbtour": "0.2.0",
+    "elkjs": "^0.12.1",
+    "esbuild": "^0.28.2",
+    "react": "^19.3.1",
+    "react-dom": "^19.3.1"
+  }
+}

package/src/index.ts

@@ -0,0 +1,47 @@
+// The explorer add-on: render(model) returns index.html with the page and the model inlined, so the file
+// opens from disk with no server and no network. The page itself is built from src/page into dist/.
+import { readFileSync } from 'node:fs';
+import type { Model } from 'dbtour/model';
+import { markDataUri } from './mark.ts';
+
+export function render(model: Model): Record<string, string> {
+  return { 'index.html': pageHtml(model, builtFile('page.js'), builtFile('page.css')) };
+}
+
+function builtFile(name: string): string {
+  try {
+    return readFileSync(new URL(`../dist/${name}`, import.meta.url), 'utf8');
+  } catch (error) {
+    throw new Error(`dbtour-addon-explorer has no dist/${name}: in the dbtour repository run npm run build, otherwise reinstall the package`, { cause: error });
+  }
+}
+
+/** The HTML around the bundle and the model. Pure, so it is tested without the build. */
+export function pageHtml(model: Model, js: string, css: string): string {
+  const title = `${model.databases.map((d) => d.name).join(', ') || 'dbtour'} · dbtour`;
+  // Inside a JSON string "<" is "<", so no "</script" or "<!--" can end the element early. The bundle
+  // gets the same treatment where "</script" could appear inside one of its strings or patterns.
+  const json = JSON.stringify(model).replace(/</g, '\\u003c');
+  const script = js.replace(/<\/(script)/gi, '<\\/$1');
+  return `<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="color-scheme" content="light dark">
+<title>${escapeHtml(title)}</title>
+<link rel="icon" href="${markDataUri()}">
+<style>${css}</style>
+</head>
+<body>
+<div id="app"></div>
+<script id="dbtour-model" type="application/json">${json}</script>
+<script>${script}</script>
+</body>
+</html>
+`;
+}
+
+function escapeHtml(text: string): string {
+  return text.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.