@timber-js/app 0.2.0-alpha.16 → 0.2.0-alpha.161

package/src/routing/manifest-codegen.ts

@@ -0,0 +1,281 @@
+/**
+ * Route manifest codegen — generates virtual module source for the route
+ * manifest, search-params registry, and global schema.
+ *
+ * Extracted from plugins/routing.ts to keep it under the 500-line budget.
+ * See design/18-build-system.md §"Virtual Modules".
+ *
+ * Task: TIM-1071 item 8
+ */
+
+import { existsSync } from 'node:fs';
+import { join } from 'node:path';
+import { collectInterceptionRewrites } from './interception.js';
+import { fileHasExport } from './export-detect.js';
+import type { RouteTree, SegmentNode, RouteFile } from './types.js';
+
+// ── Single-file conventions ─────────────────────────────────────────────
+// Each entry maps to a node property that holds a single RouteFile.
+// Order matches the original serializeNode output for byte-identical diffs.
+const SINGLE_FILE_KEYS = [
+  'page',
+  'layout',
+  'middleware',
+  'access',
+  'route',
+  'error',
+  'default',
+  'denied',
+  'params',
+] as const;
+
+// ── Record-shaped conventions ───────────────────────────────────────────
+// Each entry maps to a node property that holds Record<string, RouteFile>.
+const RECORD_FILE_KEYS = [
+  'statusFiles',
+  'jsonStatusFiles',
+  'legacyStatusFiles',
+  'metadataRoutes',
+] as const;
+
+const SCHEMA_EXTENSIONS = ['.ts', '.tsx', '.js', '.jsx'];
+
+// ── Manifest generation ─────────────────────────────────────────────────
+
+/**
+ * Generate the virtual module source for the route manifest.
+ *
+ * The output is a default-exported object containing the serialized route tree.
+ * All file references use absolute paths (required for virtual modules).
+ */
+export function generateManifestModule(tree: RouteTree, viteRoot: string): string {
+  const imports: string[] = [];
+  let importIndex = 0;
+
+  function addImport(file: RouteFile): string {
+    const varName = `_route${importIndex++}`;
+    imports.push(`const ${varName} = () => import("${file.filePath}");`);
+    return varName;
+  }
+
+  function serializeRouteFile(key: string, file: RouteFile, indent: string): string {
+    const v = addImport(file);
+    return `${indent}${key}: { load: ${v}, filePath: ${JSON.stringify(file.filePath)} },`;
+  }
+
+  function serializeRouteFileRecord(
+    key: string,
+    record: Record<string, RouteFile>,
+    indent: string
+  ): string | null {
+    const entries = Object.entries(record);
+    if (entries.length === 0) return null;
+    const inner = entries.map(([name, file]) => {
+      const v = addImport(file);
+      return `${indent}    ${JSON.stringify(name)}: { load: ${v}, filePath: ${JSON.stringify(file.filePath)} }`;
+    });
+    return `${indent}${key}: {\n${inner.join(',\n')}\n${indent}},`;
+  }
+
+  function serializeNode(node: SegmentNode, indent: string): string {
+    const nextIndent = indent + '  ';
+    const parts: string[] = [];
+
+    parts.push(`${nextIndent}segmentName: ${JSON.stringify(node.segmentName)},`);
+    parts.push(`${nextIndent}segmentType: ${JSON.stringify(node.segmentType)},`);
+    parts.push(`${nextIndent}urlPath: ${JSON.stringify(node.urlPath)},`);
+
+    if (node.paramName) {
+      parts.push(`${nextIndent}paramName: ${JSON.stringify(node.paramName)},`);
+    }
+
+    if (node.interceptionMarker) {
+      parts.push(`${nextIndent}interceptionMarker: ${JSON.stringify(node.interceptionMarker)},`);
+    }
+    if (node.interceptedSegmentName) {
+      parts.push(
+        `${nextIndent}interceptedSegmentName: ${JSON.stringify(node.interceptedSegmentName)},`
+      );
+    }
+
+    // Single-file conventions — table-driven to avoid copy-paste drift
+    for (const key of SINGLE_FILE_KEYS) {
+      const file = node[key];
+      if (file) {
+        parts.push(serializeRouteFile(key, file, nextIndent));
+      }
+    }
+
+    // searchParams is now a named export from page.tsx, not a separate file.
+    // The page module's searchParams export is loaded via the page's lazy import.
+    // Runtime registration happens in the route loader using the page module.
+
+    // Record-shaped conventions — table-driven
+    for (const key of RECORD_FILE_KEYS) {
+      const record = node[key];
+      if (record) {
+        const line = serializeRouteFileRecord(key, record, nextIndent);
+        if (line) parts.push(line);
+      }
+    }
+
+    // Children
+    if (node.children.length > 0) {
+      const childNodes = node.children.map((c) => serializeNode(c, nextIndent));
+      parts.push(`${nextIndent}children: [\n${childNodes.join(',\n')}\n${nextIndent}],`);
+    } else {
+      parts.push(`${nextIndent}children: [],`);
+    }
+
+    // Parallel slots
+    const slotKeys = Object.keys(node.slots);
+    if (slotKeys.length > 0) {
+      const slotEntries: string[] = [];
+      for (const slotName of slotKeys) {
+        const slotNode = node.slots[slotName]!;
+        slotEntries.push(
+          `${nextIndent}    ${JSON.stringify(slotName)}: ${serializeNode(slotNode, nextIndent + '  ')}`
+        );
+      }
+      parts.push(`${nextIndent}slots: {\n${slotEntries.join(',\n')}\n${nextIndent}},`);
+    } else {
+      parts.push(`${nextIndent}slots: {},`);
+    }
+
+    return `${indent}{\n${parts.join('\n')}\n${indent}}`;
+  }
+
+  const rootSerialized = serializeNode(tree.root, '  ');
+
+  let proxyLine = '';
+  if (tree.proxy) {
+    const v = addImport(tree.proxy);
+    proxyLine = `  proxy: { load: ${v}, filePath: ${JSON.stringify(tree.proxy.filePath)} },`;
+  }
+
+  let globalErrorLine = '';
+  if (tree.globalError) {
+    const v = addImport(tree.globalError);
+    globalErrorLine = `  globalError: { load: ${v}, filePath: ${JSON.stringify(tree.globalError.filePath)} },`;
+  }
+
+  const rewrites = collectInterceptionRewrites(tree.root);
+  const rewritesLine =
+    rewrites.length > 0
+      ? `  interceptionRewrites: ${JSON.stringify(rewrites.map((r) => ({ interceptedPattern: r.interceptedPattern, interceptingPrefix: r.interceptingPrefix })))},`
+      : '';
+
+  const code = [
+    '// Auto-generated route manifest — do not edit.',
+    '// Generated by timber-routing plugin.',
+    '',
+    ...imports,
+    '',
+    'const manifest = {',
+    `  viteRoot: ${JSON.stringify(viteRoot)},`,
+    proxyLine,
+    globalErrorLine,
+    rewritesLine,
+    `  root: ${rootSerialized},`,
+    '};',
+    '',
+    'export default manifest;',
+  ]
+    .filter((line) => line !== undefined && line !== '')
+    .join('\n');
+
+  return code;
+}
+
+// ── Search-params registry ──────────────────────────────────────────────
+
+/**
+ * Walk the route tree and collect every page that exports a
+ * `searchParams` definition, then emit a module that statically imports
+ * each export and registers it into the shared search-params registry.
+ */
+export function generateSearchParamsRegistryModule(tree: RouteTree): string {
+  const entries: Array<{ urlPath: string; filePath: string }> = [];
+
+  function walk(node: SegmentNode): void {
+    if (node.page) {
+      if (node.params && fileHasSearchParamsExport(node.params.filePath)) {
+        entries.push({ urlPath: node.urlPath, filePath: node.params.filePath });
+      } else if (fileHasSearchParamsExport(node.page.filePath)) {
+        entries.push({ urlPath: node.urlPath, filePath: node.page.filePath });
+      }
+    }
+    for (const child of node.children) walk(child);
+    for (const slot of Object.values(node.slots)) walk(slot);
+  }
+  walk(tree.root);
+
+  entries.sort((a, b) => a.urlPath.localeCompare(b.urlPath));
+
+  const lines: string[] = [];
+  lines.push('// Auto-generated search-params registry — do not edit.');
+  lines.push('// Generated by timber-routing plugin (TIM-830).');
+  lines.push('');
+  lines.push("import { registerSearchParams } from '@timber-js/app/search-params';");
+  lines.push('');
+
+  entries.forEach((entry, i) => {
+    lines.push(`import { searchParams as r${i} } from ${JSON.stringify(entry.filePath)};`);
+  });
+  lines.push('');
+
+  entries.forEach((entry, i) => {
+    lines.push(`registerSearchParams(${JSON.stringify(entry.urlPath)}, r${i});`);
+  });
+  lines.push('');
+
+  lines.push('export {};');
+  lines.push('');
+
+  return lines.join('\n');
+}
+
+function fileHasSearchParamsExport(filePath: string): boolean {
+  return fileHasExport(filePath, 'searchParams');
+}
+
+// ── Schema module ───────────────────────────────────────────────────────
+
+/**
+ * Generate the virtual:timber-schema module.
+ *
+ * When app/schema.{ts,tsx,js,jsx} exists, generates a module that
+ * imports the schema and resolves its segmentParams codecs into a
+ * bare-name codec map for runtime coercion.
+ */
+export function generateSchemaModule(appDir: string): string {
+  let schemaPath: string | null = null;
+  for (const ext of SCHEMA_EXTENSIONS) {
+    const candidate = join(appDir, `schema${ext}`);
+    if (existsSync(candidate)) {
+      schemaPath = candidate;
+      break;
+    }
+  }
+
+  if (!schemaPath) {
+    return [
+      '// Auto-generated schema loader — no app/schema.ts found.',
+      'export default null;',
+    ].join('\n');
+  }
+
+  return [
+    '// Auto-generated schema loader — do not edit.',
+    '// Generated by timber-routing plugin (TIM-931).',
+    '',
+    `import schema from ${JSON.stringify(schemaPath)};`,
+    `import { resolveSchemaCodecs } from '@timber-js/app/params';`,
+    '',
+    'const globalCodecs = schema?.segmentParams',
+    '  ? resolveSchemaCodecs(schema.segmentParams)',
+    '  : null;',
+    '',
+    'export default globalCodecs;',
+  ].join('\n');
+}