@open-press/cli 1.0.0 → 1.1.0

package/template/core/engine/react/document-entry.mjs

@@ -1,331 +0,0 @@
-// Layer 1 — Document entry loader.
-//
-// 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`).
-
-import fs from "node:fs/promises";
-import { createRequire } from "node:module";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import react from "@vitejs/plugin-react";
-import ts from "typescript";
-import { createServer as createViteServer } from "vite";
-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, "..", "..");
-export const CORE_ENTRY = path.join(FRAMEWORK_ROOT, "src", "openpress", "core", "index.tsx");
-export const MDX_ENTRY = path.join(FRAMEWORK_ROOT, "src", "openpress", "mdx", "index.ts");
-export const MANUSCRIPT_ENTRY = path.join(FRAMEWORK_ROOT, "src", "openpress", "manuscript", "index.tsx");
-export const NUMBERING_ENTRY = path.join(FRAMEWORK_ROOT, "src", "openpress", "numbering", "index.ts");
-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 = await resolveEntryPath(workspaceRoot);
-  if (!entryPath) return null;
-
-  const source = await fs.readFile(entryPath, "utf8");
-  assertNoObviousTopLevelSideEffects(source, entryPath);
-
-  // If caller provides a server, reuse it so module identity is shared
-  // across the pipeline (PressContext, React, etc.). Otherwise open a
-  // temporary server for one-shot config reads.
-  const ownServer = externalServer ?? (await createReactSsrServer(workspaceRoot));
-  try {
-    const mod = await ownServer.ssrLoadModule(entryPath);
-
-    // Press default export is required for export/render but not for
-    // config-only commands (search, replace, validate). Validate if present;
-    // export pipeline throws separately if it's missing when actually needed.
-    const Press = typeof mod.default === "function" ? mod.default : null;
-
-    // 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,
-      presses: inspection.presses,
-      workspaceProps: inspection.workspaceProps,
-      pressCount: inspection.presses.length,
-      wrappedInWorkspace: inspection.wrappedInWorkspace,
-    };
-  } finally {
-    if (!externalServer) await ownServer.close();
-  }
-}
-
-export async function createReactSsrServer(workspaceRoot = ".") {
-  const resolvedWorkspaceRoot = path.resolve(workspaceRoot);
-  return createViteServer({
-    configFile: false,
-    root: FRAMEWORK_ROOT,
-    cacheDir: path.join(resolvedWorkspaceRoot, ".openpress", "vite-ssr"),
-    appType: "custom",
-    logLevel: "silent",
-    plugins: [reactRuntimePlugin(), react()],
-    resolve: {
-      alias: [
-        // ORDER MATTERS: subpath aliases must precede the base alias so that
-        // `@open-press/core/mdx` doesn't resolve to `@open-press/core` + `/mdx`.
-        { find: "@open-press/core/mdx", replacement: MDX_ENTRY },
-        { 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, "press", "components") },
-      ],
-    },
-    optimizeDeps: {
-      include: [
-        "@mdx-js/react",
-        "react",
-        "react-dom",
-        "react-dom/server",
-        "react/jsx-dev-runtime",
-        "react/jsx-runtime",
-      ],
-    },
-    server: {
-      middlewareMode: true,
-      fs: {
-        allow: [FRAMEWORK_ROOT, resolvedWorkspaceRoot],
-      },
-    },
-  });
-}
-
-function assertNoObviousTopLevelSideEffects(source, entryPath) {
-  const sourceFile = ts.createSourceFile(entryPath, source, ts.ScriptTarget.Latest, true, ts.ScriptKind.TSX);
-  for (const statement of sourceFile.statements) {
-    if (ts.isImportDeclaration(statement)) {
-      assertPureImport(statement, entryPath);
-      continue;
-    }
-
-    if (ts.isInterfaceDeclaration(statement) || ts.isTypeAliasDeclaration(statement)) continue;
-    if (ts.isExportDeclaration(statement) && statement.isTypeOnly) continue;
-    if (ts.isFunctionDeclaration(statement)) continue;
-    if (ts.isVariableStatement(statement)) {
-      assertTopLevelVariableStatement(statement, entryPath);
-      continue;
-    }
-    if (ts.isExportAssignment(statement)) {
-      assertPureDefaultExport(statement.expression, entryPath);
-      continue;
-    }
-
-    throw new Error(`OpenPress document entry has unsupported top-level code in ${entryPath}: ${statementKindName(statement)}`);
-  }
-}
-
-function assertPureImport(statement, entryPath) {
-  if (!statement.importClause) {
-    throw new Error(`OpenPress document entry has an unsupported side-effect import in ${entryPath}`);
-  }
-  const moduleName = stringLiteralText(statement.moduleSpecifier);
-  if (!statement.importClause.isTypeOnly && isFileSystemModule(moduleName)) {
-    throw new Error(`OpenPress document entry imports filesystem APIs at top level in ${entryPath}`);
-  }
-}
-
-function assertTopLevelVariableStatement(statement, entryPath) {
-  if ((statement.declarationList.flags & ts.NodeFlags.Const) === 0) {
-    throw new Error(`OpenPress document entry only allows top-level const declarations in ${entryPath}`);
-  }
-
-  const exported = hasModifier(statement, ts.SyntaxKind.ExportKeyword);
-  for (const declaration of statement.declarationList.declarations) {
-    if (!ts.isIdentifier(declaration.name)) {
-      throw new Error(`OpenPress document entry only allows identifier const declarations at top level in ${entryPath}`);
-    }
-    const name = declaration.name.text;
-    if (exported && name !== "config" && name !== "sources") {
-      throw new Error(`OpenPress document entry only allows exported const config and sources in ${entryPath}`);
-    }
-    if (!declaration.initializer) {
-      throw new Error(`OpenPress document entry const "${name}" must have an initializer in ${entryPath}`);
-    }
-    if (name === "config") {
-      assertPureExpression(declaration.initializer, entryPath, { allowMdxSourceCall: false });
-    } else if (name === "sources") {
-      assertPureSourcesInitializer(declaration.initializer, entryPath);
-    } else {
-      assertPureStaticInitializer(declaration.initializer, entryPath);
-    }
-  }
-}
-
-function assertPureSourcesInitializer(node, entryPath) {
-  const expression = skipExpressionWrappers(node);
-  if (!ts.isObjectLiteralExpression(expression)) {
-    throw new Error(`OpenPress document entry exported sources must be an object literal in ${entryPath}`);
-  }
-  assertPureExpression(expression, entryPath, { allowMdxSourceCall: true });
-}
-
-function assertPureStaticInitializer(node, entryPath) {
-  const expression = skipExpressionWrappers(node);
-  if (ts.isFunctionExpression(expression) || ts.isArrowFunction(expression) || ts.isClassExpression(expression)) return;
-  assertPureExpression(expression, entryPath, { allowMdxSourceCall: false });
-}
-
-function assertPureDefaultExport(node, entryPath) {
-  const expression = skipExpressionWrappers(node);
-  if (ts.isFunctionExpression(expression) || ts.isArrowFunction(expression) || ts.isIdentifier(expression)) return;
-  throw new Error(`OpenPress document entry default export must be a function component in ${entryPath}`);
-}
-
-function assertPureExpression(node, entryPath, { allowMdxSourceCall }) {
-  visitExpression(node, (child) => {
-    if (ts.isAwaitExpression(child)) {
-      throw new Error(`OpenPress document entry has an unsupported top-level side effect: await in ${entryPath}`);
-    }
-    if (ts.isCallExpression(child)) {
-      const callee = skipExpressionWrappers(child.expression);
-      if (allowMdxSourceCall && ts.isIdentifier(callee) && callee.text === "mdxSource") return;
-      if (ts.isIdentifier(callee) && callee.text === "fetch") {
-        throw new Error(`OpenPress document entry has an unsupported top-level side effect: fetch(...) in ${entryPath}`);
-      }
-      if (ts.isPropertyAccessExpression(callee) && isIdentifierText(callee.expression, "console")) {
-        throw new Error(`OpenPress document entry has an unsupported top-level side effect: console.${callee.name.text}(...) in ${entryPath}`);
-      }
-      if (ts.isPropertyAccessExpression(callee) && isIdentifierText(callee.expression, "fs")) {
-        throw new Error(`OpenPress document entry has an unsupported top-level side effect: fs.${callee.name.text}(...) in ${entryPath}`);
-      }
-      throw new Error(`OpenPress document entry cannot execute top-level function calls outside sources.mdxSource(...) in ${entryPath}`);
-    }
-    if (ts.isPropertyAccessExpression(child) && isProcessEnvAccess(child)) {
-      throw new Error(`OpenPress document entry cannot read process.env at top level in ${entryPath}`);
-    }
-  });
-}
-
-function visitExpression(node, visitor) {
-  visitor(node);
-  if (node !== undefined && node !== null && isFunctionLikeExpression(node)) return;
-  ts.forEachChild(node, (child) => visitExpression(child, visitor));
-}
-
-function isFunctionLikeExpression(node) {
-  return ts.isFunctionExpression(node) || ts.isArrowFunction(node) || ts.isClassExpression(node);
-}
-
-function skipExpressionWrappers(node) {
-  let current = node;
-  while (ts.isParenthesizedExpression(current) || ts.isAsExpression(current) || ts.isTypeAssertionExpression(current) || ts.isNonNullExpression(current)) {
-    current = current.expression;
-  }
-  return current;
-}
-
-function isProcessEnvAccess(node) {
-  return node.name.text === "env" && isIdentifierText(skipExpressionWrappers(node.expression), "process");
-}
-
-function isIdentifierText(node, text) {
-  return ts.isIdentifier(node) && node.text === text;
-}
-
-function hasModifier(node, kind) {
-  return ts.canHaveModifiers(node) && (ts.getModifiers(node) ?? []).some((modifier) => modifier.kind === kind);
-}
-
-function statementKindName(node) {
-  return ts.SyntaxKind[node.kind] ?? String(node.kind);
-}
-
-function stringLiteralText(node) {
-  return ts.isStringLiteral(node) ? node.text : "";
-}
-
-function isFileSystemModule(moduleName) {
-  return moduleName === "fs" || moduleName === "node:fs" || moduleName === "fs/promises" || moduleName === "node:fs/promises";
-}
-
-async function fileExists(filePath) {
-  try {
-    const stat = await fs.stat(filePath);
-    return stat.isFile();
-  } catch (error) {
-    if (error?.code === "ENOENT") return false;
-    throw error;
-  }
-}
-
-function reactRuntimePlugin() {
-  const modules = {
-    react: "\0openpress-react",
-    "react/jsx-runtime": "\0openpress-react-jsx-runtime",
-    "react/jsx-dev-runtime": "\0openpress-react-jsx-dev-runtime",
-  };
-  return {
-    name: "openpress-react-runtime",
-    enforce: "pre",
-    resolveId(id) {
-      return modules[id] ?? null;
-    },
-    load(id) {
-      if (id === modules.react) return reactModuleShim();
-      if (id === modules["react/jsx-runtime"]) {
-        return runtimeModuleShim(path.join(REACT_PACKAGE_ROOT, "jsx-runtime.js"), ["Fragment", "jsx", "jsxs"]);
-      }
-      if (id === modules["react/jsx-dev-runtime"]) {
-        return runtimeModuleShim(path.join(REACT_PACKAGE_ROOT, "jsx-dev-runtime.js"), ["Fragment", "jsxDEV"]);
-      }
-      return null;
-    },
-  };
-}
-
-function runtimeModuleShim(modulePath, names) {
-  const exports = names.map((name) => `export const ${name} = runtime.${name};`).join("\n");
-  return `import { createRequire } from "node:module";
-const require = createRequire(${JSON.stringify(import.meta.url)});
-const runtime = require(${JSON.stringify(modulePath)});
-${exports}
-export default runtime;
-`;
-}
-
-function reactModuleShim() {
-  const reactPath = require.resolve("react");
-  const exports = REACT_EXPORT_NAMES.map((name) => `export const ${name} = React.${name};`).join("\n");
-  return `import { createRequire } from "node:module";
-const require = createRequire(${JSON.stringify(import.meta.url)});
-const React = require(${JSON.stringify(reactPath)});
-${exports}
-export default React;
-`;
-}