@ecopages/core 0.2.0-alpha.3 → 0.2.0-alpha.30

package/src/static-site-generator/static-site-generator.js

@@ -2,6 +2,7 @@ import path from "node:path";
 import { appLogger } from "../global/app-logger.js";
 import { fileSystem } from "@ecopages/file-system";
 import { PathUtils } from "../utils/path-utils.module.js";
+import { prepareExplicitStaticRender } from "../adapters/shared/explicit-static-render-preparation.js";
 const STATIC_SITE_GENERATOR_ERRORS = {
   ROUTE_RENDERER_FACTORY_REQUIRED: "RouteRendererFactory is required for render strategy",
   unsupportedBodyType: (bodyType) => `Unsupported body type for static generation: ${bodyType}`,
@@ -11,9 +12,52 @@ const STATIC_SITE_GENERATOR_ERRORS = {
 };
 class StaticSiteGenerator {
   appConfig;
+  /**
+   * Creates the static-site generator for one app config.
+   */
   constructor({ appConfig }) {
     this.appConfig = appConfig;
   }
+  getExportDir() {
+    return this.appConfig.absolutePaths?.distDir ?? path.join(this.appConfig.rootDir, this.appConfig.distDir);
+  }
+  /**
+   * Logs the standardized warning emitted when a dynamic-cache page is skipped.
+   */
+  warnDynamicPageSkipped(filePath) {
+    appLogger.warn(
+      "Pages with cache: 'dynamic' are not supported in static generation or preview, so they will be skipped\n",
+      `\u27A4 ${filePath}`
+    );
+  }
+  /**
+   * Determines whether one filesystem-discovered page should be excluded from
+   * static generation.
+   */
+  async shouldSkipStaticPageFile(filePath, routeRendererFactory) {
+    const module = await routeRendererFactory.getPageRenderer(filePath).loadPageModule(filePath, {
+      cacheScope: "static-page-probe"
+    });
+    if (module.default?.cache !== "dynamic") {
+      return false;
+    }
+    this.warnDynamicPageSkipped(filePath);
+    return true;
+  }
+  /**
+   * Determines whether one explicit static route view should be excluded from
+   * static generation.
+   */
+  shouldSkipStaticView(routePath, view) {
+    if (view.cache !== "dynamic") {
+      return false;
+    }
+    this.warnDynamicPageSkipped(routePath);
+    return true;
+  }
+  /**
+   * Writes the robots.txt file declared by the app config.
+   */
   generateRobotsTxt() {
     let data = "";
     const preferences = this.appConfig.robotsTxt.preferences;
@@ -26,13 +70,19 @@ class StaticSiteGenerator {
       }
       data += "\n";
     }
-    fileSystem.ensureDir(this.appConfig.distDir);
-    fileSystem.write(`${this.appConfig.distDir}/robots.txt`, data);
+    fileSystem.ensureDir(this.getExportDir());
+    fileSystem.write(path.join(this.getExportDir(), "robots.txt"), data);
   }
+  /**
+   * Returns whether the input path points at the root directory.
+   */
   isRootDir(path2) {
     const slashes = path2.match(/\//g);
     return slashes && slashes.length === 1;
   }
+  /**
+   * Collects parent directories that must exist for the generated route set.
+   */
   getDirectories(routes) {
     const directories = /* @__PURE__ */ new Set();
     for (const route of routes) {
@@ -44,99 +94,95 @@ class StaticSiteGenerator {
     }
     return Array.from(directories);
   }
-  /**
-   * Extracts dynamic parameters from the actual path based on the template path.
-   *
-   * @param templatePath - The template path (e.g., "/blog/[slug]")
-   * @param actualPath - The actual path (e.g., "/blog/my-post")
-   * @returns A record of extracted parameters (e.g., { slug: "my-post" })
-   */
-  extractParams(templatePath, actualPath) {
-    const templateSegments = templateSegmentsFromPath(templatePath);
-    const actualSegments = templateSegmentsFromPath(actualPath);
-    const params = {};
-    for (let i = 0; i < templateSegments.length; i++) {
-      const segment = templateSegments[i];
-      if (segment.startsWith("[") && segment.endsWith("]")) {
-        const paramName = segment.slice(1, -1).replace("...", "");
-        params[paramName] = actualSegments[i];
+  writeStaticOutput(routePath, contents, directories = []) {
+    const outputPath = this.getOutputPath(routePath, directories);
+    fileSystem.ensureDir(path.dirname(outputPath));
+    fileSystem.write(outputPath, contents);
+    return outputPath;
+  }
+  getStaticBuildStrategy(filePath) {
+    const ext = PathUtils.getEcoTemplateExtension(filePath);
+    const integration = this.appConfig.integrations.find((plugin) => plugin.extensions.includes(ext));
+    return integration?.staticBuildStep || "render";
+  }
+  async createFilesystemStaticContents(route, baseUrl, routeRendererFactory) {
+    const {
+      templateRoute: { filePath },
+      params
+    } = route;
+    if (this.getStaticBuildStrategy(filePath) === "fetch") {
+      const fetchUrl = this.resolveStaticFetchUrl(route.requestUrl, baseUrl);
+      const response = await fetch(fetchUrl);
+      if (!response.ok) {
+        appLogger.error(`Failed to fetch ${fetchUrl}. Status: ${response.status}`);
+        return null;
       }
+      return response.text();
+    }
+    if (!routeRendererFactory) {
+      throw new Error(STATIC_SITE_GENERATOR_ERRORS.ROUTE_RENDERER_FACTORY_REQUIRED);
     }
-    return params;
+    if (await this.shouldSkipStaticPageFile(filePath, routeRendererFactory)) {
+      return null;
+    }
+    const renderer = routeRendererFactory.getPageRenderer(filePath);
+    const result = await renderer.execute({
+      file: filePath,
+      params
+    });
+    const body = result.body;
+    if (typeof body === "string" || Buffer.isBuffer(body)) {
+      return body;
+    }
+    if (body instanceof ReadableStream) {
+      return new Response(body).text();
+    }
+    throw new Error(STATIC_SITE_GENERATOR_ERRORS.unsupportedBodyType(typeof body));
   }
+  /**
+   * Generates static output for all filesystem-discovered routes.
+   *
+   * @remarks
+   * Routes whose integrations opt into fetch-based static builds are rendered by
+   * issuing a request against the running server origin. Render-strategy routes
+   * go through the normal route renderer directly.
+   */
   async generateStaticPages(router, baseUrl, routeRendererFactory) {
-    const routes = Object.keys(router.routes).filter((route) => !route.includes("["));
-    appLogger.debug("Static Pages", routes);
-    const directories = this.getDirectories(routes);
-    for (const directory of directories) {
-      fileSystem.ensureDir(path.join(this.appConfig.rootDir, this.appConfig.distDir, directory));
-    }
+    const routes = await router.listStaticGenerationRoutes({ runtimeOrigin: baseUrl });
+    appLogger.debug(
+      "Static Pages",
+      routes.map((route) => route.requestUrl)
+    );
+    const directories = this.getDirectories(routes.map((route) => route.requestUrl));
     for (const route of routes) {
       try {
-        const { filePath, pathname: routePathname } = router.routes[route];
-        const ext = PathUtils.getEcoTemplateExtension(filePath);
-        const integration = this.appConfig.integrations.find((plugin) => plugin.extensions.includes(ext));
-        const strategy = integration?.staticBuildStep || "render";
-        let contents;
-        if (strategy === "fetch") {
-          const fetchUrl = route.startsWith("http") ? route : `${baseUrl}${route}`;
-          const response = await fetch(fetchUrl);
-          if (!response.ok) {
-            appLogger.error(`Failed to fetch ${fetchUrl}. Status: ${response.status}`);
-            continue;
-          }
-          contents = await response.text();
-        } else {
-          if (!routeRendererFactory) {
-            throw new Error(STATIC_SITE_GENERATOR_ERRORS.ROUTE_RENDERER_FACTORY_REQUIRED);
-          }
-          let pathname2 = routePathname;
-          const pathnameSegments2 = pathname2.split("/").filter(Boolean);
-          if (pathname2 === "/") {
-            pathname2 = "/index.html";
-          } else if (pathnameSegments2.join("/").includes("[")) {
-            pathname2 = `${route.replace(router.origin, "")}.html`;
-          } else if (pathnameSegments2.length >= 1 && directories.includes(`/${pathnameSegments2.join("/")}`)) {
-            pathname2 = `${pathname2.endsWith("/") ? pathname2 : `${pathname2}/`}index.html`;
-          } else {
-            pathname2 += ".html";
-          }
-          const renderer = routeRendererFactory.createRenderer(filePath);
-          const params = this.extractParams(routePathname, pathname2.replace(".html", ""));
-          const result = await renderer.createRoute({
-            file: filePath,
-            params
-          });
-          const body = result.body;
-          if (typeof body === "string" || Buffer.isBuffer(body)) {
-            contents = body;
-          } else if (body instanceof ReadableStream) {
-            contents = await new Response(body).text();
-          } else {
-            throw new Error(STATIC_SITE_GENERATOR_ERRORS.unsupportedBodyType(typeof body));
-          }
+        const contents = await this.createFilesystemStaticContents(route, baseUrl, routeRendererFactory);
+        if (contents === null) {
+          continue;
         }
-        let pathname = routePathname;
-        const pathnameSegments = pathname.split("/").filter(Boolean);
-        if (pathname === "/") {
-          pathname = "/index.html";
-        } else if (pathnameSegments.join("/").includes("[")) {
-          pathname = `${route.replace(router.origin, "")}.html`;
-        } else if (pathnameSegments.length >= 1 && directories.includes(`/${pathnameSegments.join("/")}`)) {
-          pathname = `${pathname.endsWith("/") ? pathname : `${pathname}/`}index.html`;
-        } else {
-          pathname += ".html";
-        }
-        const outputPath = path.join(this.appConfig.rootDir, this.appConfig.distDir, pathname);
-        fileSystem.write(outputPath, contents);
+        this.writeStaticOutput(route.pathname, contents, directories);
       } catch (error) {
         appLogger.error(
-          `Error generating static page for ${route}:`,
+          `Error generating static page for ${route.requestUrl}:`,
           error instanceof Error ? error : String(error)
         );
       }
     }
   }
+  resolveStaticFetchUrl(route, baseUrl) {
+    if (!route.startsWith("http://") && !route.startsWith("https://")) {
+      return `${baseUrl}${route}`;
+    }
+    const targetUrl = new URL(route);
+    const buildUrl = new URL(baseUrl);
+    buildUrl.pathname = targetUrl.pathname;
+    buildUrl.search = targetUrl.search;
+    buildUrl.hash = targetUrl.hash;
+    return buildUrl.href;
+  }
+  /**
+   * Executes the full static-generation workflow for one app run.
+   */
   async run({
     router,
     baseUrl,
@@ -162,12 +208,10 @@ class StaticSiteGenerator {
       try {
         const mod = await route.loader();
         const view = mod.default;
-        const isDynamic = route.path.includes(":") || route.path.includes("[");
-        if (isDynamic) {
-          await this.generateDynamicStaticRoute(route.path, view, routeRendererFactory);
-        } else {
-          await this.generateSingleStaticRoute(route.path, view, routeRendererFactory);
+        if (this.shouldSkipStaticView(route.path, view)) {
+          continue;
         }
+        await this.generateExplicitStaticRoute(route.path, view, routeRendererFactory);
       } catch (error) {
         appLogger.error(
           `Error generating explicit static page for ${route.path}:`,
@@ -176,63 +220,64 @@ class StaticSiteGenerator {
       }
     }
   }
-  /**
-   * Generate a single static page for a non-dynamic route.
-   */
-  async generateSingleStaticRoute(routePath, view, routeRendererFactory) {
-    const integrationName = view.config?.__eco?.integration;
-    if (!integrationName) {
-      throw new Error(STATIC_SITE_GENERATOR_ERRORS.missingIntegration(routePath));
-    }
-    const renderer = routeRendererFactory.getRendererByIntegration(integrationName);
-    if (!renderer) {
-      throw new Error(STATIC_SITE_GENERATOR_ERRORS.noRendererForIntegration(integrationName));
+  async generateExplicitStaticRoute(routePath, view, routeRendererFactory) {
+    const { renderer, routeEntries } = await this.planExplicitStaticRoute(routePath, view, routeRendererFactory);
+    for (const { pathname, params } of routeEntries) {
+      const contents = await this.createExplicitStaticContents(
+        routePath,
+        view,
+        params,
+        routeRendererFactory,
+        renderer
+      );
+      const outputPath = this.writeStaticOutput(pathname, contents);
+      appLogger.debug(`Generated static page: ${pathname} -> ${outputPath}`);
     }
-    const props = view.staticProps ? (await view.staticProps({
-      pathname: { params: {} },
+  }
+  async planExplicitStaticRoute(routePath, view, routeRendererFactory) {
+    const { renderer } = await prepareExplicitStaticRender({
+      routePath,
+      view,
+      params: {},
       appConfig: this.appConfig,
-      runtimeOrigin: this.appConfig.baseUrl
-    })).props : {};
-    const response = await renderer.renderToResponse(view, props, {});
-    const contents = await response.text();
-    const outputPath = this.getOutputPath(routePath);
-    fileSystem.ensureDir(path.dirname(outputPath));
-    fileSystem.write(outputPath, contents);
-    appLogger.debug(`Generated static page: ${routePath} -> ${outputPath}`);
+      runtimeOrigin: this.appConfig.baseUrl,
+      routeRendererFactory,
+      errors: STATIC_SITE_GENERATOR_ERRORS
+    });
+    return {
+      renderer,
+      routeEntries: await this.listExplicitStaticRouteEntries(routePath, view)
+    };
   }
-  /**
-   * Generate static pages for a dynamic route using staticPaths.
-   */
-  async generateDynamicStaticRoute(routePath, view, routeRendererFactory) {
+  async createExplicitStaticContents(routePath, view, params, routeRendererFactory, renderer) {
+    const { props, view: renderableView } = await prepareExplicitStaticRender({
+      routePath,
+      view,
+      params,
+      appConfig: this.appConfig,
+      runtimeOrigin: this.appConfig.baseUrl,
+      routeRendererFactory,
+      errors: STATIC_SITE_GENERATOR_ERRORS
+    });
+    const response = await renderer.renderToResponse(renderableView, props, {});
+    return response.text();
+  }
+  async listExplicitStaticRouteEntries(routePath, view) {
+    const isDynamic = routePath.includes(":") || routePath.includes("[");
+    if (!isDynamic) {
+      return [{ pathname: routePath, params: {} }];
+    }
     if (!view.staticPaths) {
       throw new Error(STATIC_SITE_GENERATOR_ERRORS.dynamicRouteRequiresStaticPaths(routePath));
     }
-    const integrationName = view.config?.__eco?.integration;
-    if (!integrationName) {
-      throw new Error(STATIC_SITE_GENERATOR_ERRORS.missingIntegration(routePath));
-    }
-    const renderer = routeRendererFactory.getRendererByIntegration(integrationName);
-    if (!renderer) {
-      throw new Error(STATIC_SITE_GENERATOR_ERRORS.noRendererForIntegration(integrationName));
-    }
     const { paths } = await view.staticPaths({
       appConfig: this.appConfig,
       runtimeOrigin: this.appConfig.baseUrl
     });
-    for (const { params } of paths) {
-      const resolvedPath = this.resolveRoutePath(routePath, params);
-      const props = view.staticProps ? (await view.staticProps({
-        pathname: { params },
-        appConfig: this.appConfig,
-        runtimeOrigin: this.appConfig.baseUrl
-      })).props : {};
-      const response = await renderer.renderToResponse(view, props, {});
-      const contents = await response.text();
-      const outputPath = this.getOutputPath(resolvedPath);
-      fileSystem.ensureDir(path.dirname(outputPath));
-      fileSystem.write(outputPath, contents);
-      appLogger.debug(`Generated static page: ${resolvedPath} -> ${outputPath}`);
-    }
+    return paths.map(({ params }) => ({
+      pathname: this.resolveRoutePath(routePath, params),
+      params
+    }));
   }
   /**
    * Resolve a route path template with actual params.
@@ -251,21 +296,20 @@ class StaticSiteGenerator {
   /**
    * Get the output file path for a given route.
    */
-  getOutputPath(routePath) {
+  getOutputPath(routePath, directories = []) {
     let outputName;
     if (routePath === "/") {
       outputName = "index.html";
+    } else if (directories.includes(routePath)) {
+      outputName = `${routePath}/index.html`;
     } else if (routePath.endsWith("/")) {
       outputName = `${routePath}index.html`;
     } else {
       outputName = `${routePath}.html`;
     }
-    return path.join(this.appConfig.rootDir, this.appConfig.distDir, outputName);
+    return path.join(this.getExportDir(), outputName);
   }
 }
-function templateSegmentsFromPath(path2) {
-  return path2.split("/").filter(Boolean);
-}
 export {
   STATIC_SITE_GENERATOR_ERRORS,
   StaticSiteGenerator

package/src/{internal-types.d.ts → types/internal-types.d.ts}

@@ -1,17 +1,18 @@
-import type { EcoBuildPlugin } from './build/build-types.js';
-import type { IntegrationPlugin } from './plugins/integration-plugin.js';
-import type { Processor } from './plugins/processor.js';
+import type { EcoBuildPlugin } from '../build/build-types.js';
+import type { AppBuildManifest } from '../build/build-manifest.js';
+import type { BuildAdapter, BuildExecutor, BuildOwnership } from '../build/build-adapter.js';
+import type { AnyIntegrationPlugin } from '../plugins/integration-plugin.js';
+import type { Processor } from '../plugins/processor.js';
+import type { EcoSourceTransform } from '../plugins/source-transform.js';
 import type { PageMetadataProps } from './public-types.js';
-import type { FSRouter } from './router/fs-router.js';
-import type { CacheConfig } from './services/cache/cache.types.js';
-/**
- * The templates used to build the pages and loaded via the includes directory.
- */
-export type IncludesTemplates = {
-    head: string;
-    html: string;
-    seo: string;
-};
+import type { RouteRegistry } from '../router/server/route-registry.js';
+import type { CacheConfig } from '../services/cache/cache.types.js';
+import type { DevGraphService } from '../services/runtime-state/dev-graph.service.js';
+import type { AppModuleLoader } from '../services/module-loading/app-module-loader.service.js';
+import type { SourceModuleLoader } from '../services/module-loading/module-loading-types.js';
+import type { EntrypointDependencyGraph } from '../services/runtime-state/entrypoint-dependency-graph.service.js';
+import type { ServerInvalidationState } from '../services/runtime-state/server-invalidation-state.service.js';
+import type { ServerModuleTranspiler } from '../services/module-loading/server-module-transpiler.service.js';
 export interface RobotsPreference {
     /**
      * The user agent
@@ -58,20 +59,22 @@ export type EcoPagesAppConfig = {
      * @default "layouts"
      */
     layoutsDir: string;
-    /**
-     * The templates used for the pages
-     * @default "{head: 'head.kita.tsx', html: 'html.kita.tsx', seo: 'seo.kita.tsx'}"
-     */
-    includesTemplates: IncludesTemplates;
-    /** Error 404 page
-     * @default "404.kita.tsx"
-     */
-    error404Template: string;
     /**
      * The directory where the output will be located
      * @default "dist"
      */
     distDir: string;
+    /**
+     * The directory where internal runtime and build artifacts are stored.
+     *
+     * @remarks
+     * This directory is not intended for deployment. It owns transpiled server
+     * modules, runtime manifests, and processor caches so `distDir` can remain a
+     * clean export tree.
+     *
+     * @default ".eco"
+     */
+    workDir: string;
     /**
      * The templates extensions based on the integrations
      */
@@ -98,7 +101,7 @@ export type EcoPagesAppConfig = {
      */
     defaultMetadata: PageMetadataProps;
     /** Integrations plugins */
-    integrations: IntegrationPlugin[];
+    integrations: AnyIntegrationPlugin[];
     /** Integrations dependencies */
     integrationsDependencies: IntegrationDependencyConfig[];
     /** Derived Paths */
@@ -106,6 +109,7 @@ export type EcoPagesAppConfig = {
         config: string;
         componentsDir: string;
         distDir: string;
+        workDir: string;
         includesDir: string;
         layoutsDir: string;
         pagesDir: string;
@@ -123,11 +127,36 @@ export type EcoPagesAppConfig = {
      * Loaders to be used in the app, these are used to process the files when importing them
      */
     loaders: Map<string, EcoBuildPlugin>;
+    /**
+     * App-owned source transforms that can be adapted into Vite or other
+     * transform-first bundlers without going through the legacy loader bridge.
+     */
+    sourceTransforms: Map<string, EcoSourceTransform>;
     /**
      * Cache configuration for ISR and page caching.
      * @default { store: 'memory', defaultStrategy: 'static', enabled: true }
      */
     cache?: CacheConfig;
+    /**
+     * Runtime-owned services attached after config construction.
+     *
+     * These values are internal implementation details used to thread per-app
+     * executors and similar runtime state through the system without relying on
+     * process-global registries.
+     */
+    runtime?: {
+        appModuleLoader?: AppModuleLoader;
+        buildOwnership?: BuildOwnership;
+        buildAdapter?: BuildAdapter;
+        buildManifest?: AppBuildManifest;
+        buildExecutor?: BuildExecutor;
+        devGraphService?: DevGraphService;
+        entrypointDependencyGraph?: EntrypointDependencyGraph;
+        hostModuleLoader?: SourceModuleLoader;
+        rendererModuleContext?: unknown;
+        serverInvalidationState?: ServerInvalidationState;
+        serverModuleTranspiler?: ServerModuleTranspiler;
+    };
     /**
      * Experimental features.
      */
@@ -153,11 +182,14 @@ export type RouteKind = 'exact' | 'catch-all' | 'dynamic';
  * Represents the result of a route match.
  */
 export type MatchResult = {
-    filePath: string;
-    kind: RouteKind;
-    pathname: string;
-    query?: Record<string, string>;
-    params?: Record<string, string | string[]>;
+    requestedPathname: string;
+    templateRoute: {
+        filePath: string;
+        kind: RouteKind;
+        pathname: string;
+    };
+    query: Record<string, string>;
+    params: Record<string, string | string[]>;
 };
 /**
  * Represents a route in EcoPages.
@@ -183,10 +215,10 @@ export type FileSystemServerOptions = {
  */
 export interface EcoPagesFileSystemServerAdapter<ServerInstanceOptions = unknown> {
     startServer(serverOptions: ServerInstanceOptions): {
-        router: FSRouter;
+        router: RouteRegistry;
         server: unknown;
     } | Promise<{
-        router: FSRouter;
+        router: RouteRegistry;
         server: unknown;
     }>;
 }