@open-press/core 0.8.0 → 1.1.0

package/engine/output/chrome-pdf.mjs

@@ -152,6 +152,78 @@ export async function printUrlToPdf({
   }
 }
 
+export async function captureUrlPagesToPng({
+  root,
+  url,
+  outDir,
+  chrome,
+  waitForReady = waitForPrintReady,
+  viewport = DEFAULT_PRINT_VIEWPORT,
+  debuggingPortBase = 9700,
+  debuggingPortRange = 300,
+  profilePrefix = "chrome-image",
+}) {
+  chrome ??= resolveChromePath();
+  await fs.mkdir(outDir, { recursive: true });
+
+  const debuggingPort = String(debuggingPortBase + Math.floor(Math.random() * debuggingPortRange));
+  const profileDir = path.join(root, ".openpress", "tmp", `${profilePrefix}-${process.pid}-${Date.now()}`);
+  await fs.mkdir(profileDir, { recursive: true });
+
+  const child = spawn(
+    chrome,
+    [
+      "--headless=new",
+      "--disable-gpu",
+      "--no-sandbox",
+      `--remote-debugging-port=${debuggingPort}`,
+      `--user-data-dir=${profileDir}`,
+      "about:blank",
+    ],
+    { cwd: root, stdio: ["ignore", "pipe", "pipe"] },
+  );
+
+  try {
+    const tab = await waitForChromeTab(debuggingPort);
+    const client = await connectChromeDevTools(tab.webSocketDebuggerUrl);
+    try {
+      await preparePdfPage(client, { viewport });
+      await client.send("Page.navigate", { url });
+      const pageCount = await waitForReady(client);
+      const rects = await getPrintPageRects(client);
+      if (rects.length === 0) throw new Error("No OpenPress pages found for image export.");
+
+      const padWidth = Math.max(3, String(rects.length).length);
+      const files = [];
+      for (const [index, rect] of rects.entries()) {
+        const filename = `page-${String(index + 1).padStart(padWidth, "0")}.png`;
+        const filePath = path.join(outDir, filename);
+        const result = await client.send("Page.captureScreenshot", {
+          format: "png",
+          fromSurface: true,
+          captureBeyondViewport: true,
+          clip: {
+            x: Math.max(0, rect.x),
+            y: Math.max(0, rect.y),
+            width: rect.width,
+            height: rect.height,
+            scale: 1,
+          },
+        });
+        await fs.writeFile(filePath, Buffer.from(String(result.data ?? ""), "base64"));
+        files.push(filePath);
+      }
+
+      return { pageCount, files };
+    } finally {
+      client.close();
+    }
+  } finally {
+    await stopChildProcess(child);
+    await cleanupChromeProfile(profileDir);
+  }
+}
+
 export async function preparePdfPage(client, { viewport = DEFAULT_PRINT_VIEWPORT } = {}) {
   await client.send("Page.enable");
   await client.send("Runtime.enable");
@@ -265,6 +337,26 @@ export async function waitForPrintReady(client) {
   throw new Error("Timed out waiting for OpenPress pagination before PDF export.");
 }
 
+async function getPrintPageRects(client) {
+  const result = await client.send("Runtime.evaluate", {
+    returnByValue: true,
+    expression: `(() => {
+      return Array.from(document.querySelectorAll('.openpress-public-page > .openpress-html-page')).map((page, index) => {
+        const target = page.querySelector('.openpress-html-page__html') || page;
+        const rect = target.getBoundingClientRect();
+        return {
+          index,
+          x: rect.left + window.scrollX,
+          y: rect.top + window.scrollY,
+          width: rect.width,
+          height: rect.height,
+        };
+      }).filter((rect) => rect.width > 0 && rect.height > 0);
+    })()`,
+  });
+  return Array.isArray(result.result?.value) ? result.result.value : [];
+}
+
 export async function stopChildProcess(child) {
   if (child.exitCode !== null || child.signalCode !== null) return;
   child.kill();

package/engine/output/static-server.mjs

@@ -2,6 +2,7 @@ import fs from "node:fs/promises";
 import http from "node:http";
 import path from "node:path";
 import { spawn } from "node:child_process";
+import { fileURLToPath } from "node:url";
 import { loadConfig, publicPdfHref } from "../runtime/config.mjs";
 import { searchSourceText } from "../runtime/source-text-tools.mjs";
 import { handleProjectAssetRequest } from "../react/project-asset-endpoint.mjs";
@@ -13,6 +14,9 @@ const port = Number(valueAfter(rest, "--port") ?? "8765");
 const root = path.resolve(rootArg);
 const workspace = path.resolve(valueAfter(rest, "--workspace") ?? await inferWorkspaceRoot(root));
 const config = await loadConfig(workspace);
+const ENGINE_DIR = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
+const FRAMEWORK_ROOT = path.resolve(ENGINE_DIR, "..");
+const CLI_ENTRY = path.join(ENGINE_DIR, "cli.mjs");
 
 const mimeTypes = {
   ".html": "text/html; charset=utf-8",
@@ -73,17 +77,45 @@ const server = http.createServer(async (req, res) => {
       res.end("Forbidden");
       return;
     }
-    const stat = await fs.stat(target);
-    const filePath = stat.isDirectory() ? path.join(target, "index.html") : target;
-    const body = await fs.readFile(filePath);
-    res.writeHead(200, { "Content-Type": mimeTypes[path.extname(filePath)] ?? "application/octet-stream" });
-    res.end(body);
+    try {
+      const stat = await fs.stat(target);
+      const filePath = stat.isDirectory() ? path.join(target, "index.html") : target;
+      const body = await fs.readFile(filePath);
+      res.writeHead(200, { "Content-Type": mimeTypes[path.extname(filePath)] ?? "application/octet-stream" });
+      res.end(body);
+    } catch (err) {
+      // SPA fallback: when a path doesn't map to a real file AND it
+      // looks like a client-side route (no extension, not under a
+      // reserved namespace), serve index.html so the reader's URL-based
+      // routing can take over. This lets /cheatsheet / /proposal etc.
+      // reload correctly without needing host-level rewrite rules.
+      if (err?.code === "ENOENT" && shouldFallbackToIndex(url.pathname)) {
+        const indexBody = await fs.readFile(path.join(root, "index.html"));
+        res.writeHead(200, { "Content-Type": "text/html" });
+        res.end(indexBody);
+        return;
+      }
+      throw err;
+    }
   } catch {
     res.writeHead(404);
     res.end("Not found");
   }
 });
 
+function shouldFallbackToIndex(pathname) {
+  // Reserved namespaces — real resources whose 404s should stay 404.
+  if (pathname.startsWith("/openpress/")) return false;
+  if (pathname.startsWith("/__openpress/")) return false;
+  if (pathname.startsWith("/assets/")) return false;
+  // Anything with a file extension is an asset miss; fall through.
+  const lastSlash = pathname.lastIndexOf("/");
+  const tail = pathname.slice(lastSlash + 1);
+  if (tail.includes(".")) return false;
+  // Otherwise: looks like a client-side route — serve the SPA shell.
+  return true;
+}
+
 server.listen(port, host, () => {
   console.log(`OpenPress static preview: http://${host}:${port}/`);
 });
@@ -149,7 +181,10 @@ function valueAfter(args, flag) {
 
 async function inferWorkspaceRoot(staticRoot) {
   for (const candidate of [staticRoot, path.dirname(staticRoot), path.dirname(path.dirname(staticRoot))]) {
-    if (await fileExists(path.join(candidate, "openpress.config.mjs"))) return candidate;
+    // 1.0 workspace markers: press/index.tsx (the document entry) or
+    // package.json with an "openpress" field. Either is sufficient.
+    if (await fileExists(path.join(candidate, "press", "index.tsx"))) return candidate;
+    if (await hasOpenpressPackageField(candidate)) return candidate;
   }
   if (path.basename(path.dirname(staticRoot)) === ".deploy") {
     return path.dirname(path.dirname(staticRoot));
@@ -157,6 +192,16 @@ async function inferWorkspaceRoot(staticRoot) {
   return process.cwd();
 }
 
+async function hasOpenpressPackageField(dir) {
+  try {
+    const text = await fs.readFile(path.join(dir, "package.json"), "utf8");
+    const parsed = JSON.parse(text);
+    return parsed?.openpress && typeof parsed.openpress === "object";
+  } catch {
+    return false;
+  }
+}
+
 async function handleLocalPdfExportRequest(req, res) {
   if (req.method !== "POST") {
     writeJson(res, 405, { ok: false, message: "Local PDF export endpoint requires POST." });
@@ -169,7 +214,7 @@ async function handleLocalPdfExportRequest(req, res) {
     ok: result.code === 0 && exists,
     code: result.code,
     pdf: `/__openpress/local-pdf-file?ts=${Date.now()}`,
-    command: "node engine/cli.mjs pdf .",
+    command: "open-press pdf .",
     stdout: result.stdout,
     stderr: result.stderr,
   });
@@ -209,7 +254,7 @@ async function handleDeployRequest(req, res) {
       deploy_adapter: config.deploy.adapter,
       deploy_source: config.deploy.source,
       deploy_project_name: config.deploy.projectName,
-      command: "node engine/cli.mjs deploy . --confirm",
+      command: "open-press deploy . --confirm",
     });
     return;
   }
@@ -228,7 +273,7 @@ async function handleDeployRequest(req, res) {
     pdf: deployedUrl ? `${deployedUrl}/${config.pdf.filename}` : deploymentInfo.pdf,
     public_url: publicUrl,
     dirty: false,
-    command: "node engine/cli.mjs deploy . --confirm",
+    command: "open-press deploy . --confirm",
     stdout: result.stdout,
     stderr: result.stderr,
   });
@@ -313,7 +358,7 @@ async function handleMediaFileRequest(req, res, url) {
 
 function runLocalPdfExport() {
   return new Promise((resolve) => {
-    const child = spawn("node", ["engine/cli.mjs", "pdf", "."], {
+    const child = spawn("node", [CLI_ENTRY, "pdf", "."], {
       cwd: workspace,
       shell: false,
     });
@@ -336,7 +381,7 @@ function runLocalPdfExport() {
 
 function runDeploy() {
   return new Promise((resolve) => {
-    const child = spawn("node", ["engine/cli.mjs", "deploy", ".", "--confirm"], {
+    const child = spawn("node", [CLI_ENTRY, "deploy", ".", "--confirm"], {
       cwd: workspace,
       shell: false,
     });
@@ -367,7 +412,7 @@ function isDeployConfigured() {
 function deploySetupMessage() {
   if (isDeployConfigured()) return undefined;
   if (config.deploy.adapter === "cloudflare-pages") {
-    return "Cloudflare Pages deployment requires `deploy.projectName` in openpress.config.mjs.";
+    return 'Cloudflare Pages deployment requires `openpress.deploy.projectName` in package.json.';
   }
   return `Deployment adapter \`${config.deploy.adapter}\` is not configured.`;
 }
@@ -430,12 +475,10 @@ function getDeploymentSourcePaths() {
     config.paths.themeDir,
     config.paths.designDoc,
     config.paths.componentsDir,
-    path.join(workspace, "src"),
-    path.join(workspace, "index.html"),
+    path.join(FRAMEWORK_ROOT, "src"),
+    path.join(FRAMEWORK_ROOT, "index.html"),
+    path.join(FRAMEWORK_ROOT, "vite.config.ts"),
     path.join(workspace, "package.json"),
-    path.join(workspace, "openpress.config.mjs"),
-    config.configPath,
-    path.join(workspace, "vite.config.ts"),
   ];
 }
 

package/engine/react/comment-marker.mjs

@@ -4,15 +4,15 @@ import path from "node:path";
 import { loadConfig } from "../runtime/config.mjs";
 import { collectSourceTextFiles } from "../runtime/source-text-tools.mjs";
 
-// Any `.mdx` or `.tsx` file under `document/` is a legal comment target.
+// Any `.mdx` or `.tsx` file under `press/` is a legal comment target.
 // The Press Tree allows arbitrary source layouts — `section-folders`,
 // `section-files`, `file-list`, custom `root` paths, etc. — so we no
-// longer hardcode `document/chapters/<slug>/content/*.mdx`. The boundary
-// is "inside the workspace's authored `document/` directory" and "looks
+// longer hardcode `press/chapters/<slug>/content/*.mdx`. The boundary
+// is "inside the workspace's authored `press/` directory" and "looks
 // like an editable React/MDX source" by extension.
 const EDITABLE_COMMENT_SOURCE_PATTERNS = [
-  /^document\/.+\.mdx$/,
-  /^document\/.+\.tsx$/,
+  /^press\/.+\.mdx$/,
+  /^press\/.+\.tsx$/,
 ];
 const COMMENT_MARKER_RE = /(?:\{\/\*|\/\*)\s*@openpress-comment\b(?<attrs>[^*]*)\*\/\}?/g;
 const COMMENT_LINE_RE = /^\s*(?:\{\/\*|\/\*)\s*@openpress-comment\b[^*]*\*\/\}?\s*$/;
@@ -167,23 +167,23 @@ function normalizeEditableSourcePath(value) {
     throw new Error(`OpenPress comment target path is invalid: ${value}`);
   }
   const posix = path.posix.normalize(normalized);
-  // The Press Tree source resolver emits paths relative to `document/`
+  // The Press Tree source resolver emits paths relative to `press/`
   // (e.g. "chapters/01-start/content/01-start.mdx"). The comment marker
-  // works in workspace-relative paths (with the `document/` prefix). If
-  // the incoming path is documentRoot-relative, prepend `document/`.
-  if (!posix.startsWith("document/") && looksDocumentRelative(posix)) {
-    return `document/${posix}`;
+  // works in workspace-relative paths (with the `press/` prefix). If
+  // the incoming path is documentRoot-relative, prepend `press/`.
+  if (!posix.startsWith("press/") && looksDocumentRelative(posix)) {
+    return `press/${posix}`;
   }
   return posix;
 }
 
 // Identify paths the Press Tree source resolver emits — those are relative
-// to `document/`. Match `.mdx` / `.tsx` files that don't already have the
-// `document/` prefix and don't look like system / engine paths. The check
+// to `press/`. Match `.mdx` / `.tsx` files that don't already have the
+// `press/` prefix and don't look like system / engine paths. The check
 // is intentionally tight so we never silently rewrite engine internals
 // (e.g. `src/openpress/...`) into "editable" workspace paths.
 const SYSTEM_PATH_PREFIXES = [
-  "document/",
+  "press/",
   "src/",
   "engine/",
   "dist/",

package/engine/react/document-entry.mjs

@@ -1,6 +1,6 @@
 // Layer 1 — Document entry loader.
 //
-// Loads `document/index.tsx`, validates it exports a Press component as
+// Loads `press/index.tsx`, validates it exports a Press component as
 // default, reads optional `config` and `sources` named exports, and sets
 // up the vite SSR server with `@open-press/core` aliases (including the
 // subpaths `/mdx` and `/manuscript`).
@@ -12,7 +12,8 @@ import { fileURLToPath } from "node:url";
 import react from "@vitejs/plugin-react";
 import ts from "typescript";
 import { createServer as createViteServer } from "vite";
-import { normalizeConfig } from "../runtime/config.mjs";
+import { loadConfig } from "../runtime/config.mjs";
+import { inspectPressTree } from "./press-tree-inspection.mjs";
 
 const ENGINE_REACT_DIR = path.dirname(fileURLToPath(import.meta.url));
 const FRAMEWORK_ROOT = path.resolve(ENGINE_REACT_DIR, "..", "..");
@@ -24,10 +25,17 @@ const REACT_PACKAGE_ROOT = path.join(FRAMEWORK_ROOT, "node_modules", "react");
 const require = createRequire(import.meta.url);
 const REACT_EXPORT_NAMES = Object.keys(require("react")).filter((name) => /^[A-Za-z_$][\w$]*$/.test(name));
 
+// 1.0 contract: the document entry lives at press/index.tsx.
+async function resolveEntryPath(workspaceRoot) {
+  const candidate = path.join(workspaceRoot, "press", "index.tsx");
+  if (await fileExists(candidate)) return candidate;
+  return null;
+}
+
 export async function loadReactDocumentEntry(root = ".", { server: externalServer } = {}) {
   const workspaceRoot = path.resolve(root);
-  const entryPath = path.join(workspaceRoot, "document", "index.tsx");
-  if (!(await fileExists(entryPath))) return null;
+  const entryPath = await resolveEntryPath(workspaceRoot);
+  if (!entryPath) return null;
 
   const source = await fs.readFile(entryPath, "utf8");
   assertNoObviousTopLevelSideEffects(source, entryPath);
@@ -44,19 +52,35 @@ export async function loadReactDocumentEntry(root = ".", { server: externalServe
     // export pipeline throws separately if it's missing when actually needed.
     const Press = typeof mod.default === "function" ? mod.default : null;
 
-    const config = normalizeReactDocumentConfig(workspaceRoot, entryPath, mod.config);
-    const sources = mod.sources ?? {};
-    if (sources && (typeof sources !== "object" || Array.isArray(sources))) {
-      throw new Error(
-        `OpenPress document entry ${entryPath} \`sources\` export must be an object literal (or omitted).`,
+    // Inspect the JSX tree returned by the user's default export to
+    // pull <Workspace> / <Press> props declared inline. The 1.0 contract
+    // treats workspaces uniformly as "array of Press children" — the
+    // single-doc case is just length 1.
+    let inspection = { workspaceProps: {}, presses: [], wrappedInWorkspace: false };
+    if (Press) {
+      const coreModule = await ownServer.ssrLoadModule(
+        path.join(FRAMEWORK_ROOT, "src", "openpress", "core", "index.tsx"),
       );
+      inspection = inspectPressTree({
+        UserComponent: Press,
+        PRESS_MARKER: coreModule.PRESS_MARKER,
+        WORKSPACE_MARKER: coreModule.WORKSPACE_MARKER,
+      });
     }
 
+    // Workspace-level config (deploy, pdf, captionNumbering defaults)
+    // comes from package.json "openpress" via loadConfig. Each Press
+    // overlays its own metadata via JSX props at export time.
+    const config = await loadConfig(workspaceRoot);
+
     return {
       entryPath,
       config,
       Press,
-      sources,
+      presses: inspection.presses,
+      workspaceProps: inspection.workspaceProps,
+      pressCount: inspection.presses.length,
+      wrappedInWorkspace: inspection.wrappedInWorkspace,
     };
   } finally {
     if (!externalServer) await ownServer.close();
@@ -80,7 +104,7 @@ export async function createReactSsrServer(workspaceRoot = ".") {
         { find: "@open-press/core/manuscript", replacement: MANUSCRIPT_ENTRY },
         { find: "@open-press/core/numbering", replacement: NUMBERING_ENTRY },
         { find: "@open-press/core", replacement: CORE_ENTRY },
-        { find: "@/components", replacement: path.join(resolvedWorkspaceRoot, "document", "components") },
+        { find: "@/components", replacement: path.join(resolvedWorkspaceRoot, "press", "components") },
       ],
     },
     optimizeDeps: {
@@ -250,23 +274,6 @@ function isFileSystemModule(moduleName) {
   return moduleName === "fs" || moduleName === "node:fs" || moduleName === "fs/promises" || moduleName === "node:fs/promises";
 }
 
-function normalizeReactDocumentConfig(workspaceRoot, entryPath, config) {
-  if (config != null && (typeof config !== "object" || Array.isArray(config))) {
-    throw new Error("OpenPress React document entry `config` export must be an object when provided.");
-  }
-  const rawConfig = config ?? {};
-  const paths = rawConfig.paths ?? {};
-  return normalizeConfig(workspaceRoot, {
-    ...rawConfig,
-    documentDir: rawConfig.documentDir ?? paths.documentDir ?? "document",
-    sourceDir: rawConfig.sourceDir ?? paths.chaptersDir ?? paths.sourceDir ?? "chapters",
-    componentsDir: rawConfig.componentsDir ?? paths.componentsDir ?? "components",
-    mediaDir: rawConfig.mediaDir ?? paths.mediaDir ?? "media",
-    themeDir: rawConfig.themeDir ?? paths.themeDir ?? "theme",
-    designDoc: rawConfig.designDoc ?? paths.designDoc ?? "design.md",
-  }, entryPath);
-}
-
 async function fileExists(filePath) {
   try {
     const stat = await fs.stat(filePath);