@ecopages/core 0.2.0-alpha.1 → 0.2.0-alpha.10

package/src/route-renderer/render-preparation.service.ts

@@ -1,358 +0,0 @@
-import { createRequire } from 'node:module';
-import type { EcoPagesAppConfig } from '../internal-types.ts';
-import type {
-	ComponentRenderResult,
-	EcoComponent,
-	EcoPageComponent,
-	EcoPageFile,
-	EcoPagesElement,
-	GetMetadata,
-	GetStaticProps,
-	HtmlTemplateProps,
-	IntegrationRendererRenderOptions,
-	PageProps,
-	PageMetadataProps,
-	ResolvedLazyTrigger,
-	RouteRendererOptions,
-} from '../public-types.ts';
-import {
-	type AssetProcessingService,
-	AssetFactory,
-	type ProcessedAsset,
-} from '../services/asset-processing-service/index.ts';
-import { buildGlobalInjectorBootstrapContent, buildGlobalInjectorMapScript } from '../eco/global-injector-map.ts';
-import { runWithComponentRenderContext, type ComponentRenderBoundaryContext } from '../eco/component-render-context.ts';
-
-const coreRequire = createRequire(import.meta.url);
-
-type ResolvedPageModule = {
-	Page: EcoPageFile['default'] | EcoPageComponent<any>;
-	getStaticProps?: GetStaticProps<Record<string, unknown>>;
-	getMetadata?: GetMetadata;
-	integrationSpecificProps: Record<string, unknown>;
-};
-
-export interface RenderPreparationCallbacks {
-	resolvePageModule(file: string): Promise<ResolvedPageModule>;
-	getHtmlTemplate(): Promise<EcoComponent<HtmlTemplateProps>>;
-	resolvePageData(
-		pageModule: {
-			getStaticProps?: GetStaticProps<Record<string, unknown>>;
-			getMetadata?: GetMetadata;
-		},
-		routeOptions: RouteRendererOptions,
-	): Promise<{ props: Record<string, unknown>; metadata: PageMetadataProps }>;
-	resolveDependencies(components: (EcoComponent | Partial<EcoComponent>)[]): Promise<ProcessedAsset[]>;
-	buildRouteRenderAssets(file: string): Promise<ProcessedAsset[]> | undefined;
-	shouldRenderPageComponent(input: {
-		Page: EcoComponent;
-		Layout?: EcoComponent;
-		options: RouteRendererOptions;
-	}): boolean;
-	renderPageComponent(input: {
-		component: EcoComponent;
-		props: Record<string, unknown>;
-	}): Promise<ComponentRenderResult>;
-	/**
-	 * Returns the boundary policy context that should be active while rendering
-	 * page-root component output during preparation.
-	 */
-	getComponentRenderBoundaryContext(): ComponentRenderBoundaryContext;
-	setProcessedDependencies(dependencies: ProcessedAsset[]): void;
-	dedupeProcessedAssets(assets: ProcessedAsset[]): ProcessedAsset[];
-	createPageLocalsProxy(filePath: string): RouteRendererOptions['locals'];
-}
-
-/**
- * Prepares the normalized render inputs consumed by `IntegrationRenderer.execute()`.
- *
- * This service owns the orchestration that happens before the main HTML render:
- * page module resolution, data loading, dependency aggregation, page-root
- * component artifact capture, lazy trigger bootstrap generation, and request
- * locals policy.
- */
-export class RenderPreparationService {
-	constructor(
-		private appConfig: EcoPagesAppConfig,
-		private assetProcessingService: AssetProcessingService,
-	) {}
-
-	/**
-	 * Builds the final render options object used by the integration-specific
-	 * renderer.
-	 *
-	 * The returned object contains normalized page data, processed dependency
-	 * state, component render artifacts, and the locals contract expected by the
-	 * rest of the pipeline.
-	 *
-	 * @typeParam C Integration render output element type.
-	 * @param routeOptions Route-level render inputs.
-	 * @param currentIntegrationName Active integration name for this preparation pass.
-	 * @param callbacks Renderer-specific hooks used during preparation.
-	 * @returns Normalized render options.
-	 */
-	async prepare<C = EcoPagesElement>(
-		routeOptions: RouteRendererOptions,
-		currentIntegrationName: string,
-		callbacks: RenderPreparationCallbacks,
-	): Promise<IntegrationRendererRenderOptions<C>> {
-		const pageModule = await callbacks.resolvePageModule(routeOptions.file);
-		const { Page, integrationSpecificProps } = pageModule;
-		const HtmlTemplate = await callbacks.getHtmlTemplate();
-		const { props, metadata } = await callbacks.resolvePageData(pageModule, routeOptions);
-		const Layout = Page.config?.layout;
-
-		const componentsToResolve = Layout ? [HtmlTemplate, Layout, Page] : [HtmlTemplate, Page];
-		const resolvedDependencies = await callbacks.resolveDependencies(componentsToResolve);
-		const usedIntegrationDependencies = this.collectUsedIntegrationDependencies(
-			componentsToResolve,
-			currentIntegrationName,
-		);
-		const pageDeps = (await callbacks.buildRouteRenderAssets(routeOptions.file)) || [];
-		const allDependencies = [...resolvedDependencies, ...usedIntegrationDependencies, ...pageDeps];
-
-		let componentRender: ComponentRenderResult | undefined;
-		if (callbacks.shouldRenderPageComponent({ Page, Layout, options: routeOptions })) {
-			componentRender = await this.renderPageRoot({
-				currentIntegrationName,
-				Page: Page as EcoComponent,
-				props,
-				routeOptions,
-				callbacks,
-			});
-
-			if (componentRender.assets?.length) {
-				allDependencies.push(...componentRender.assets);
-			}
-		}
-
-		const triggers = this.collectResolvedTriggers(componentsToResolve);
-		if (triggers.length > 0) {
-			const globalAssets = await this.buildGlobalInjectorAssets(triggers, currentIntegrationName);
-			allDependencies.push(...globalAssets);
-		}
-
-		callbacks.setProcessedDependencies(callbacks.dedupeProcessedAssets(allDependencies));
-
-		const pageProps = {
-			...props,
-			params: routeOptions.params || {},
-			query: routeOptions.query || {},
-		};
-
-		const cacheStrategy = (Page as EcoPageComponent<any>).cache;
-		const defaultCacheStrategy = this.appConfig.cache?.defaultStrategy ?? 'static';
-		const effectiveCacheStrategy = cacheStrategy ?? defaultCacheStrategy;
-		const localsAvailable = effectiveCacheStrategy === 'dynamic' && routeOptions.locals !== undefined;
-
-		const pageLocals = localsAvailable ? routeOptions.locals! : callbacks.createPageLocalsProxy(routeOptions.file);
-
-		const locals = localsAvailable ? routeOptions.locals : undefined;
-		const preparedOptions: IntegrationRendererRenderOptions<C> = {
-			...routeOptions,
-			resolvedDependencies,
-			componentRender,
-			HtmlTemplate: HtmlTemplate as EcoComponent<HtmlTemplateProps, C>,
-			Layout,
-			props,
-			Page: Page as EcoComponent<PageProps, C>,
-			metadata,
-			params: routeOptions.params || {},
-			query: routeOptions.query || {},
-			pageProps,
-			locals,
-			pageLocals,
-			cacheStrategy,
-		};
-
-		return {
-			...integrationSpecificProps,
-			...preparedOptions,
-		};
-	}
-
-	/**
-	 * Collects resolved lazy trigger metadata from the component tree.
-	 *
-	 * Traversal is depth-first and deduplicated by component identity so shared
-	 * component dependencies do not emit duplicate trigger sets.
-	 *
-	 * @param components Root component set.
-	 * @param seen Internal visited set for shared graphs.
-	 * @returns All resolved lazy triggers reachable from the root set.
-	 */
-	private collectResolvedTriggers(
-		components: (EcoComponent | Partial<EcoComponent>)[],
-		seen = new Set<object>(),
-	): ResolvedLazyTrigger[] {
-		const triggers: ResolvedLazyTrigger[] = [];
-		for (const comp of components) {
-			const ecoComp = comp as EcoComponent;
-			if (seen.has(ecoComp)) {
-				continue;
-			}
-			seen.add(ecoComp);
-			const ownTriggers = ecoComp.config?._resolvedLazyTriggers;
-			if (ownTriggers?.length) {
-				triggers.push(...ownTriggers);
-			}
-			const nested = ecoComp.config?.dependencies?.components;
-			if (nested?.length) {
-				triggers.push(...this.collectResolvedTriggers(nested, seen));
-			}
-		}
-		return triggers;
-	}
-
-	/**
-	 * Collects global integration dependencies used by nested components belonging
-	 * to integrations other than the current renderer.
-	 *
-	 * @param components Root component set.
-	 * @returns Processed integration dependencies contributed by nested integrations.
-	 */
-	private collectUsedIntegrationDependencies(
-		components: (EcoComponent | Partial<EcoComponent>)[],
-		currentIntegrationName: string,
-	): ProcessedAsset[] {
-		const integrationNames = this.collectIntegrationNames(components);
-		const dependencies: ProcessedAsset[] = [];
-
-		for (const integrationName of integrationNames) {
-			if (integrationName === currentIntegrationName) {
-				continue;
-			}
-
-			const integrationPlugin = this.appConfig.integrations.find(
-				(integration) => integration.name === integrationName,
-			);
-			if (!integrationPlugin || typeof integrationPlugin.getResolvedIntegrationDependencies !== 'function') {
-				continue;
-			}
-
-			dependencies.push(...integrationPlugin.getResolvedIntegrationDependencies());
-		}
-
-		return dependencies;
-	}
-
-	/**
-	 * Discovers integration names referenced by the component dependency graph.
-	 *
-	 * @param components Root component set.
-	 * @param seen Internal visited set for shared graphs.
-	 * @returns Set of integration names found in the graph.
-	 */
-	private collectIntegrationNames(
-		components: (EcoComponent | Partial<EcoComponent>)[],
-		seen = new Set<object>(),
-	): Set<string> {
-		const integrationNames = new Set<string>();
-
-		for (const comp of components) {
-			const ecoComp = comp as EcoComponent;
-			if (seen.has(ecoComp)) {
-				continue;
-			}
-			seen.add(ecoComp);
-
-			const integrationName = ecoComp.config?.integration ?? ecoComp.config?.__eco?.integration;
-			if (integrationName) {
-				integrationNames.add(integrationName);
-			}
-
-			const nested = ecoComp.config?.dependencies?.components;
-			if (nested?.length) {
-				const nestedNames = this.collectIntegrationNames(nested, seen);
-				for (const nestedName of nestedNames) {
-					integrationNames.add(nestedName);
-				}
-			}
-		}
-
-		return integrationNames;
-	}
-
-	/**
-	 * Renders the page root through the component-level render contract so any
-	 * integration-specific assets and root attributes are available before the main
-	 * document render.
-	 *
-	 * @param input Page root render inputs.
-	 * @returns Structured component render result.
-	 */
-	private async renderPageRoot(input: {
-		currentIntegrationName: string;
-		Page: EcoComponent;
-		props: Record<string, unknown>;
-		routeOptions: RouteRendererOptions;
-		callbacks: RenderPreparationCallbacks;
-	}): Promise<ComponentRenderResult> {
-		const execution = await runWithComponentRenderContext(
-			{
-				currentIntegration: input.currentIntegrationName,
-				boundaryContext: input.callbacks.getComponentRenderBoundaryContext(),
-			},
-			async () =>
-				input.callbacks.renderPageComponent({
-					component: input.Page,
-					props: {
-						...input.props,
-						params: input.routeOptions.params || {},
-						query: input.routeOptions.query || {},
-					},
-				}),
-		);
-
-		return execution.value;
-	}
-
-	/**
-	 * Builds the runtime assets needed to bootstrap global lazy trigger execution.
-	 *
-	 * @param triggers Fully resolved lazy trigger definitions.
-	 * @returns Processed assets that should be merged into the final dependency set.
-	 */
-	private async buildGlobalInjectorAssets(
-		triggers: ResolvedLazyTrigger[],
-		currentIntegrationName: string,
-	): Promise<ProcessedAsset[]> {
-		const globalInjectorImportPath = coreRequire.resolve('@ecopages/scripts-injector/global');
-		const globalInjectorRuntimeAsset = AssetFactory.createNodeModuleScript({
-			position: 'head',
-			name: 'ecopages-scripts-injector-global',
-			importPath: globalInjectorImportPath,
-			excludeFromHtml: true,
-		});
-
-		const [globalInjectorRuntimeProcessed] = await this.assetProcessingService.processDependencies(
-			[globalInjectorRuntimeAsset],
-			currentIntegrationName,
-		);
-
-		const globalInjectorModuleUrl = globalInjectorRuntimeProcessed?.srcUrl;
-		if (!globalInjectorModuleUrl) {
-			throw new Error('[ecopages] Failed to resolve global injector runtime asset URL.');
-		}
-
-		const mapScript = AssetFactory.createInlineContentScript({
-			position: 'head',
-			name: 'ecopages-global-injector-map',
-			content: buildGlobalInjectorMapScript(triggers),
-			attributes: { type: 'ecopages/global-injector-map' },
-			bundle: false,
-		});
-		const bootstrapScript = AssetFactory.createContentScript({
-			position: 'head',
-			name: 'ecopages-global-injector-bootstrap',
-			content: buildGlobalInjectorBootstrapContent(globalInjectorModuleUrl),
-			attributes: { type: 'module' },
-			bundle: false,
-		});
-
-		return this.assetProcessingService.processDependencies(
-			[mapScript, bootstrapScript, globalInjectorRuntimeAsset],
-			currentIntegrationName,
-		);
-	}
-}

package/src/route-renderer/route-renderer.ts

@@ -1,80 +0,0 @@
-import type { EcoPagesAppConfig } from '../internal-types.ts';
-import type { IntegrationPlugin } from '../plugins/integration-plugin.ts';
-import type { RouteRenderResult, RouteRendererOptions } from '../public-types.ts';
-import { invariant } from '../utils/invariant.ts';
-import { PathUtils } from '../utils/path-utils.module.ts';
-import type { IntegrationRenderer } from './integration-renderer.ts';
-
-export class RouteRenderer {
-	private renderer: IntegrationRenderer;
-
-	constructor(renderer: IntegrationRenderer) {
-		this.renderer = renderer;
-	}
-
-	async createRoute(options: RouteRendererOptions): Promise<RouteRenderResult> {
-		return this.renderer.execute(options);
-	}
-}
-
-export class RouteRendererFactory {
-	private appConfig: EcoPagesAppConfig;
-	runtimeOrigin: string;
-	private rendererCache = new Map<string, IntegrationRenderer>();
-
-	constructor({ appConfig, runtimeOrigin }: { appConfig: EcoPagesAppConfig; runtimeOrigin: string }) {
-		this.appConfig = appConfig;
-		this.runtimeOrigin = runtimeOrigin;
-	}
-
-	createRenderer(filePath: string): RouteRenderer {
-		const integrationRenderer = this.getRouteRendererEngine(filePath);
-		invariant(!!integrationRenderer, `No integration renderer found for file: ${filePath}`);
-		return new RouteRenderer(integrationRenderer);
-	}
-
-	/**
-	 * Get an integration renderer by its name.
-	 * Used for explicit routing where views specify their integration via __eco.integration.
-	 */
-	getRendererByIntegration(integrationName: string): IntegrationRenderer | null {
-		const integrationPlugin = this.appConfig.integrations.find((plugin) => plugin.name === integrationName);
-		if (!integrationPlugin) {
-			return null;
-		}
-
-		const cached = this.rendererCache.get(integrationName);
-		if (cached) {
-			return cached;
-		}
-
-		const renderer = integrationPlugin.initializeRenderer();
-		this.rendererCache.set(integrationName, renderer);
-		return renderer;
-	}
-
-	getIntegrationPlugin(filePath: string): IntegrationPlugin {
-		const templateExtension = PathUtils.getEcoTemplateExtension(filePath);
-		const isIntegrationPlugin = (plugin: IntegrationPlugin): boolean => {
-			return plugin.extensions.some((extension) => templateExtension === extension);
-		};
-		const integrationPlugin = this.appConfig.integrations.find(isIntegrationPlugin);
-		invariant(
-			!!integrationPlugin,
-			`No integration plugin found for template extension: ${templateExtension}, file: ${filePath}`,
-		);
-		return integrationPlugin as IntegrationPlugin;
-	}
-
-	private getRouteRendererEngine(filePath: string): IntegrationRenderer {
-		const integrationPlugin = this.getIntegrationPlugin(filePath);
-		const cached = this.rendererCache.get(integrationPlugin.name);
-		if (cached) {
-			return cached;
-		}
-
-		const renderer = integrationPlugin.initializeRenderer();
-		this.rendererCache.set(integrationPlugin.name, renderer);
-		return renderer;
-	}
-}

package/src/router/fs-router-scanner.ts

@@ -1,217 +0,0 @@
-import path from 'node:path';
-import { appLogger } from '../global/app-logger.ts';
-import type { EcoPagesAppConfig, RouteKind, Routes } from '../internal-types.ts';
-import type { EcoPageFile, GetStaticPaths } from '../public-types.ts';
-import { fileSystem } from '@ecopages/file-system';
-import { invariant } from '../utils/invariant.ts';
-import { existsSync } from 'node:fs';
-import { PageModuleImportService } from '../services/page-module-import.service.ts';
-
-type CreateRouteArgs = {
-	routePath: string;
-	filePath: string;
-	route: string;
-};
-
-type FSRouterScannerOptions = {
-	buildMode: boolean;
-};
-
-/**
- * @class FSRouterScanner
- * @description
- * This class is responsible for scanning the file system for routes.
- * It uses the glob package to scan the file system for files with the specified file extensions.
- * It then creates a map of the routes with the pathname as the key.
- * The pathname is the route without the file extension.
- * For example, if the file is "index.tsx", the pathname will be "/index".
- * If the file is "blog/[slug].tsx", the pathname will be "/blog/[slug]".
- * If the file is "blog/[...slug].tsx", the pathname will be "/blog/[...slug]".
- */
-export class FSRouterScanner {
-	private dir: string;
-	private origin = '';
-	private templatesExt: string[];
-	private options: FSRouterScannerOptions;
-	private appConfig: EcoPagesAppConfig;
-	routes: Routes = {};
-	private pageModuleImportService = new PageModuleImportService();
-
-	constructor({
-		dir,
-		origin,
-		templatesExt,
-		options,
-		appConfig,
-	}: {
-		dir: string;
-		origin: string;
-		templatesExt: string[];
-		options: FSRouterScannerOptions;
-		appConfig: EcoPagesAppConfig;
-	}) {
-		this.dir = dir;
-		this.origin = origin;
-		this.templatesExt = templatesExt;
-		this.options = options;
-		this.appConfig = appConfig;
-	}
-
-	private getRoutePath(path: string): string {
-		const cleanedRoute = this.templatesExt
-			.reduce((route, ext) => route.replace(ext, ''), path)
-			.replace(/\/?index$/, '');
-		return `/${cleanedRoute}`;
-	}
-
-	private getDynamicParamsNames(route: string): string[] {
-		const matches = route.match(/\[.*?\]/g);
-		return matches ? matches.map((match) => match.slice(1, -1)) : [];
-	}
-
-	private async getStaticPathsFromDynamicRoute({
-		route,
-		filePath,
-		getStaticPaths,
-	}: {
-		route: string;
-		filePath: string;
-		getStaticPaths: GetStaticPaths;
-	}): Promise<string[]> {
-		const staticPaths = await getStaticPaths({
-			appConfig: this.appConfig,
-			runtimeOrigin: this.origin,
-		});
-		return staticPaths.paths.map((path) => {
-			const dynamicParamsNames = this.getDynamicParamsNames(filePath);
-			let routeWithParams = route;
-
-			for (const param of dynamicParamsNames) {
-				routeWithParams = routeWithParams.replace(`[${param}]`, (path.params as Record<string, string>)[param]);
-			}
-
-			return routeWithParams;
-		});
-	}
-
-	private async createStaticRoutes({
-		filePath,
-		route,
-		routePath,
-		getStaticPaths,
-	}: CreateRouteArgs & { getStaticPaths: GetStaticPaths }): Promise<void> {
-		try {
-			const routesWithParams = await this.getStaticPathsFromDynamicRoute({
-				route,
-				filePath,
-				getStaticPaths,
-			});
-
-			for (const routeWithParams of routesWithParams) {
-				this.createRoute('dynamic', { filePath, route: routeWithParams, routePath });
-			}
-		} catch (error) {
-			appLogger.error(`[ecopages] Error creating static routes for ${filePath}: ${error}`);
-		}
-	}
-
-	private async handleDynamicRouteCreation({ filePath, route, routePath }: CreateRouteArgs): Promise<void> {
-		const module = (await this.importPageModule(filePath)) as EcoPageFile;
-		const Page = module.default;
-
-		/**
-		 * Check for attached static functions (consolidated API) or named exports (legacy)
-		 */
-		const getStaticPaths = Page?.staticPaths ?? module.getStaticPaths;
-		const getStaticProps = Page?.staticProps ?? module.getStaticProps;
-
-		if (this.options.buildMode) {
-			invariant(getStaticProps !== undefined, `[ecopages] Missing getStaticProps in ${filePath}`);
-			invariant(getStaticPaths !== undefined, `[ecopages] Missing getStaticPaths in ${filePath}`);
-		}
-
-		if (getStaticPaths) {
-			return this.createStaticRoutes({
-				filePath,
-				route,
-				routePath,
-				getStaticPaths,
-			});
-		}
-
-		return this.createRoute('dynamic', { filePath, route, routePath });
-	}
-
-	private async importPageModule(filePath: string): Promise<unknown> {
-		return this.pageModuleImportService.importModule({
-			filePath,
-			rootDir: this.appConfig.rootDir,
-			outdir: path.join(this.appConfig.absolutePaths.distDir, '.server-route-modules'),
-			externalPackages: false,
-			transpileErrorMessage: (details) => `Error transpiling route module: ${details}`,
-			noOutputMessage: (targetFilePath) => `No transpiled output generated for route module: ${targetFilePath}`,
-		});
-	}
-
-	private createRoute(kind: RouteKind, { filePath, route, routePath }: CreateRouteArgs): void {
-		this.routes[route] = {
-			kind,
-			pathname: routePath,
-			filePath,
-		};
-	}
-
-	private getRouteData(file: string): CreateRouteArgs & {
-		kind: RouteKind;
-	} {
-		const routePath = this.getRoutePath(file);
-		const route = `${this.origin}${routePath}`;
-		const filePath = path.join(this.dir, file);
-		const isCatchAll = filePath.includes('[...');
-		const isDynamic = !isCatchAll && filePath.includes('[') && filePath.includes(']');
-		const kind: RouteKind = isCatchAll ? 'catch-all' : isDynamic ? 'dynamic' : 'exact';
-
-		return { route, routePath, filePath, kind };
-	}
-
-	async scan(): Promise<Routes> {
-		this.routes = {};
-
-		if (!existsSync(this.dir)) {
-			return this.routes;
-		}
-
-		const scannedFiles = await fileSystem.glob(
-			this.templatesExt.map((ext) => `**/*${ext}`),
-			{ cwd: this.dir },
-		);
-
-		for await (const file of scannedFiles) {
-			if (file.includes('.ecopages-node.')) {
-				continue;
-			}
-
-			const { kind, ...routeData } = this.getRouteData(file);
-
-			switch (kind) {
-				case 'dynamic':
-					await this.handleDynamicRouteCreation(routeData);
-					break;
-				case 'catch-all':
-					if (this.options.buildMode) {
-						appLogger.warn(
-							'Catch-all routes are not supported in static generation, they will not be included in the bundle\n',
-							`➤ ${routeData.filePath}`,
-						);
-					}
-					this.createRoute(kind, routeData);
-					break;
-				default:
-					this.createRoute(kind, routeData);
-					break;
-			}
-		}
-
-		return this.routes;
-	}
-}