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

package/src/services/module-loading/page-module-import.service.js

@@ -0,0 +1,132 @@
+import path from "node:path";
+import { pathToFileURL } from "node:url";
+import { fileSystem } from "@ecopages/file-system";
+import { build } from "../../build/build-adapter.js";
+class PageModuleImportService {
+  dependencies;
+  importCache = /* @__PURE__ */ new Map();
+  developmentInvalidationVersion = 0;
+  constructor(dependencies) {
+    this.dependencies = {
+      hashFile: dependencies?.hashFile ?? ((filePath) => fileSystem.hash(filePath)),
+      buildModule: dependencies?.buildModule ?? ((options, buildExecutor) => build(options, buildExecutor))
+    };
+  }
+  /**
+   * Clears the shared import cache used by framework-owned page-module loads.
+   */
+  clearImportCache() {
+    this.importCache.clear();
+  }
+  /**
+   * Invalidates all previously imported modules in development by clearing the
+   * import cache and incrementing the invalidation version included in cache keys.
+   *
+   * This forces all modules to be reloaded on the next import, even if their
+   * source content hasn't changed. This is necessary to ensure that changes to
+   * non-content aspects of modules (e.g. dependencies, transpilation output)
+   * are picked up during development.
+   */
+  invalidateDevelopmentGraph() {
+    this.clearImportCache();
+    this.developmentInvalidationVersion += 1;
+  }
+  /**
+   * Imports a page-like module from source.
+   *
+   * The caller controls the output directory and error wording so different
+   * subsystems can reuse the same loading mechanism while preserving their
+   * current diagnostics. Module identities stay stable for unchanged files and
+   * roll forward automatically when the source hash changes during watch mode.
+   *
+   * @typeParam T Expected module shape.
+   * @param options Runtime-specific import settings.
+   * @returns The loaded module.
+   */
+  async importModule(options) {
+    const { filePath, rootDir, externalPackages, splitting } = options;
+    const invalidationVersion = options.invalidationVersion ?? this.developmentInvalidationVersion;
+    const fileHash = this.dependencies.hashFile(filePath);
+    const runtime = typeof Bun !== "undefined" ? "bun" : "node";
+    const cacheKey = [
+      runtime,
+      filePath,
+      rootDir,
+      splitting ?? "default",
+      externalPackages ?? "default",
+      fileHash,
+      invalidationVersion
+    ].join("::");
+    const cachedModule = this.importCache.get(cacheKey);
+    if (cachedModule) {
+      return await cachedModule;
+    }
+    const importPromise = this.loadModule({
+      ...options,
+      fileHash
+    });
+    this.importCache.set(cacheKey, importPromise);
+    try {
+      return await importPromise;
+    } catch (error) {
+      this.importCache.delete(cacheKey);
+      throw error;
+    }
+  }
+  async loadModule(options) {
+    const {
+      filePath,
+      rootDir,
+      outdir,
+      invalidationVersion = this.developmentInvalidationVersion,
+      splitting,
+      externalPackages,
+      transpileErrorMessage = (details) => `Error transpiling page module: ${details}`,
+      noOutputMessage = (targetFilePath) => `No transpiled output generated for page module: ${targetFilePath}`,
+      fileHash
+    } = options;
+    if (typeof Bun !== "undefined") {
+      const moduleUrl = pathToFileURL(filePath);
+      if (process.env.NODE_ENV === "development") {
+        moduleUrl.searchParams.set("update", `${fileHash}-${invalidationVersion}`);
+      }
+      return await import(moduleUrl.href);
+    }
+    const fileBaseName = path.basename(filePath, path.extname(filePath));
+    const outputFileName = `${fileBaseName}-${fileHash}.js`;
+    const buildResult = await this.dependencies.buildModule(
+      {
+        entrypoints: [filePath],
+        root: rootDir,
+        outdir,
+        target: "node",
+        format: "esm",
+        sourcemap: "none",
+        splitting: splitting ?? true,
+        minify: false,
+        naming: outputFileName,
+        externalPackages: true,
+        plugins: options.plugins,
+        ...externalPackages !== void 0 ? { externalPackages } : {}
+      },
+      options.buildExecutor
+    );
+    if (!buildResult.success) {
+      const details = buildResult.logs.map((log) => log.message).join(" | ");
+      throw new Error(transpileErrorMessage(details));
+    }
+    const preferredOutputPath = path.join(outdir, outputFileName);
+    const compiledOutput = buildResult.outputs.find((output) => output.path === preferredOutputPath)?.path ?? buildResult.outputs.find((output) => output.path.endsWith(".js"))?.path;
+    if (!compiledOutput) {
+      throw new Error(noOutputMessage(filePath));
+    }
+    const compiledOutputUrl = pathToFileURL(compiledOutput);
+    if (process.env.NODE_ENV === "development") {
+      compiledOutputUrl.searchParams.set("update", `${fileHash}-${invalidationVersion}`);
+    }
+    return await import(compiledOutputUrl.href);
+  }
+}
+export {
+  PageModuleImportService
+};

package/src/services/module-loading/server-loader.service.d.ts

@@ -0,0 +1,96 @@
+import type { EcoBuildPlugin } from '../../build/build-types.js';
+import { type ServerModuleTranspilerBootstrapArgs, type ServerModuleTranspilerOptions } from './server-module-transpiler.service.js';
+/**
+ * High-level module-loading options owned by the framework loader boundary.
+ *
+ * @remarks
+ * These are the same shape the lower-level transpiler needs, minus the
+ * root/build-executor ownership that the loader keeps internally.
+ */
+export interface ServerLoaderModuleOptions extends ServerModuleTranspilerOptions {
+    plugins?: EcoBuildPlugin[];
+}
+/**
+ * Mutable app-phase server-loading context.
+ *
+ * @remarks
+ * The loader starts with bootstrap config-loading context. Once a real built
+ * app config is available, the runtime adapter rebinds the loader so app-entry
+ * and downstream server modules load through the app-owned executor.
+ */
+export interface ServerLoaderAppContext extends ServerModuleTranspilerBootstrapArgs {
+}
+/**
+ * Minimal transpiler dependency required by the server loader.
+ *
+ * @remarks
+ * The loader owns orchestration between bootstrap and app phases, so tests only
+ * need this narrow import/invalidate/dispose surface rather than the concrete
+ * transpiler class.
+ */
+export interface ServerLoaderTranspilerDependency {
+    importModule<T = unknown>(options: ServerLoaderModuleOptions): Promise<T>;
+    invalidate(changedFiles?: string[]): void;
+    dispose(): Promise<void>;
+}
+/**
+ * Factory dependency used by the loader to create phase-specific transpilers.
+ */
+export interface ServerLoaderDependencyFactory {
+    createTranspiler(context: ServerModuleTranspilerBootstrapArgs): ServerLoaderTranspilerDependency;
+}
+/**
+ * Framework-owned server loading boundary.
+ *
+ * @remarks
+ * This abstraction owns config loading, app-entry loading, and cache lifecycle
+ * for the Node thin-host runtime path. Hosts and runtime adapters should depend
+ * on this boundary rather than coordinating raw transpiler instances directly.
+ */
+export interface ServerLoader {
+    /**
+     * Loads the bootstrap config module through the bootstrap server-loading
+     * context.
+     */
+    loadConfig<T = unknown>(options: ServerLoaderModuleOptions): Promise<T>;
+    /**
+     * Loads the app entry module through the currently active app context.
+     *
+     * @remarks
+     * Until app context is rebound, this falls back to the bootstrap context so a
+     * caller can still load through one boundary during early bootstrap.
+     */
+    loadApp<T = unknown>(options: ServerLoaderModuleOptions): Promise<T>;
+    /**
+     * Rebinds the app-phase loading context after a real app config has been
+     * loaded and app-owned build services are available.
+     */
+    rebindAppContext(context: ServerLoaderAppContext): void;
+    /**
+     * Invalidates cached server module state for development reloads.
+     */
+    invalidate(changedFiles?: string[]): void;
+    /**
+     * Releases loader-owned resources.
+     */
+    dispose(): Promise<void>;
+}
+/**
+ * `ServerLoader` implementation backed by `ServerModuleTranspiler` instances.
+ *
+ * @remarks
+ * This is the first named loader abstraction for Workstream 3. It keeps the
+ * lower-level transpiler as the implementation detail while moving ownership of
+ * config/app entry orchestration into one service boundary.
+ */
+export declare class TranspilerServerLoader implements ServerLoader {
+    private readonly createTranspiler;
+    private readonly configTranspiler;
+    private appTranspiler;
+    constructor(configContext: ServerModuleTranspilerBootstrapArgs, dependencies?: ServerLoaderDependencyFactory);
+    loadConfig<T = unknown>(options: ServerLoaderModuleOptions): Promise<T>;
+    loadApp<T = unknown>(options: ServerLoaderModuleOptions): Promise<T>;
+    rebindAppContext(context: ServerLoaderAppContext): void;
+    invalidate(changedFiles?: string[]): void;
+    dispose(): Promise<void>;
+}

package/src/services/module-loading/server-loader.service.js

@@ -0,0 +1,32 @@
+import {
+  ServerModuleTranspiler
+} from "./server-module-transpiler.service.js";
+class TranspilerServerLoader {
+  createTranspiler;
+  configTranspiler;
+  appTranspiler = null;
+  constructor(configContext, dependencies) {
+    this.createTranspiler = dependencies?.createTranspiler ?? ((context) => new ServerModuleTranspiler(context));
+    this.configTranspiler = this.createTranspiler(configContext);
+  }
+  async loadConfig(options) {
+    return await this.configTranspiler.importModule(options);
+  }
+  async loadApp(options) {
+    return await (this.appTranspiler ?? this.configTranspiler).importModule(options);
+  }
+  rebindAppContext(context) {
+    this.appTranspiler = this.createTranspiler(context);
+  }
+  invalidate(changedFiles) {
+    this.configTranspiler.invalidate(changedFiles);
+    this.appTranspiler?.invalidate(changedFiles);
+  }
+  async dispose() {
+    await this.appTranspiler?.dispose();
+    await this.configTranspiler.dispose();
+  }
+}
+export {
+  TranspilerServerLoader
+};

package/src/services/module-loading/server-module-transpiler.service.d.ts

@@ -0,0 +1,69 @@
+import type { BuildExecutor } from '../../build/build-adapter.js';
+import type { EcoBuildPlugin } from '../../build/build-types.js';
+import { type PageModuleImportOptions } from './page-module-import.service.js';
+export type ServerModuleTranspilerOptions = Omit<PageModuleImportOptions, 'rootDir' | 'buildExecutor'>;
+/**
+ * Minimal import-service dependency required by the server module transpiler.
+ *
+ * @remarks
+ * This keeps the transpiler boundary testable without module-level mocking and
+ * lets callers provide an app-owned import implementation when needed.
+ */
+export interface ServerModuleImportDependency {
+    importModule<T = unknown>(options: PageModuleImportOptions): Promise<T>;
+    invalidateDevelopmentGraph(): void;
+}
+/**
+ * Immutable execution context for one server-transpiler instance.
+ *
+ * @remarks
+ * Callers own when and why a new transpiler is created. This service only owns
+ * applying the supplied root/build-executor pair consistently to every module
+ * load that passes through it.
+ */
+export type ServerModuleTranspilerBootstrapArgs = {
+    rootDir: string;
+    getBuildExecutor: () => BuildExecutor | undefined;
+    getInvalidationVersion?: () => number;
+    invalidateModules?: (changedFiles?: string[]) => void;
+    pageModuleImportService?: ServerModuleImportDependency;
+    /** Factory evaluated on each importModule call to produce plugins applied to every load. */
+    getDefaultPlugins?: () => EcoBuildPlugin[];
+};
+/**
+ * App-owned boundary for server-side source module loading.
+ *
+ * @remarks
+ * This service centralizes server-side module transpilation and import behind
+ * an explicit caller-owned root and build executor.
+ */
+export declare class ServerModuleTranspiler {
+    private readonly pageModuleImportService;
+    private readonly getRootDir;
+    private readonly getBuildExecutor;
+    private readonly getInvalidationVersion;
+    private readonly invalidateModules;
+    private readonly getDefaultPlugins;
+    /**
+     * Creates one explicit server-transpiler boundary for a given execution
+     * context.
+     */
+    constructor(args: ServerModuleTranspilerBootstrapArgs);
+    /**
+     * Loads a server-side source module through the caller-owned transpile
+     * context.
+     */
+    importModule<T = unknown>(options: ServerModuleTranspilerOptions): Promise<T>;
+    /**
+     * Invalidates cached module state for development reloads.
+     */
+    invalidate(changedFiles?: string[]): void;
+    /**
+     * Releases transpiler-owned resources.
+     *
+     * @remarks
+     * The current implementation delegates cache ownership to lower-level module
+     * loading services, so disposal is intentionally a no-op for now.
+     */
+    dispose(): Promise<void>;
+}

package/src/services/module-loading/server-module-transpiler.service.js

@@ -0,0 +1,61 @@
+import { PageModuleImportService } from "./page-module-import.service.js";
+class ServerModuleTranspiler {
+  pageModuleImportService;
+  getRootDir;
+  getBuildExecutor;
+  getInvalidationVersion;
+  invalidateModules;
+  getDefaultPlugins;
+  /**
+   * Creates one explicit server-transpiler boundary for a given execution
+   * context.
+   */
+  constructor(args) {
+    this.pageModuleImportService = args.pageModuleImportService ?? new PageModuleImportService();
+    this.getRootDir = () => args.rootDir;
+    this.getBuildExecutor = args.getBuildExecutor;
+    this.getInvalidationVersion = () => args.getInvalidationVersion?.();
+    this.getDefaultPlugins = args.getDefaultPlugins ?? (() => []);
+    this.invalidateModules = (changedFiles) => {
+      if (args.invalidateModules) {
+        args.invalidateModules(changedFiles);
+        return;
+      }
+      this.pageModuleImportService.invalidateDevelopmentGraph();
+    };
+  }
+  /**
+   * Loads a server-side source module through the caller-owned transpile
+   * context.
+   */
+  async importModule(options) {
+    const mergedPlugins = [...this.getDefaultPlugins(), ...options.plugins ?? []];
+    const { plugins: _plugins, ...baseOptions } = options;
+    return await this.pageModuleImportService.importModule({
+      ...baseOptions,
+      ...mergedPlugins.length > 0 ? { plugins: mergedPlugins } : {},
+      rootDir: this.getRootDir(),
+      buildExecutor: this.getBuildExecutor(),
+      invalidationVersion: this.getInvalidationVersion()
+    });
+  }
+  /**
+   * Invalidates cached module state for development reloads.
+   */
+  invalidate(changedFiles) {
+    this.invalidateModules(changedFiles);
+  }
+  /**
+   * Releases transpiler-owned resources.
+   *
+   * @remarks
+   * The current implementation delegates cache ownership to lower-level module
+   * loading services, so disposal is intentionally a no-op for now.
+   */
+  async dispose() {
+    return;
+  }
+}
+export {
+  ServerModuleTranspiler
+};

package/src/services/runtime-manifest/node-runtime-manifest.service.d.ts

@@ -0,0 +1,35 @@
+import type { EcoPagesAppConfig } from '../../internal-types.js';
+export interface NodeRuntimeManifest {
+    runtime: 'node';
+    appRootDir: string;
+    sourceRootDir: string;
+    distDir: string;
+    workDir?: string;
+    modulePaths: {
+        config: string;
+        entry?: string;
+    };
+}
+/**
+ * Returns the default file handoff location for the Node runtime manifest.
+ */
+export declare function getNodeRuntimeManifestPath(appConfig: EcoPagesAppConfig): string;
+export declare function createNodeRuntimeManifest(appConfig: EcoPagesAppConfig, options?: {
+    entryModulePath?: string;
+}): NodeRuntimeManifest;
+/**
+ * Serializes a Node runtime manifest to the file boundary used by the thin host.
+ */
+export declare function writeNodeRuntimeManifestFile(manifest: NodeRuntimeManifest, manifestFilePath: string): string;
+/**
+ * Derives the app-owned Node manifest and writes it to the runtime handoff path.
+ */
+export declare function writeAppNodeRuntimeManifest(appConfig: EcoPagesAppConfig, options?: {
+    entryModulePath?: string;
+    manifestFilePath?: string;
+}): {
+    manifest: NodeRuntimeManifest;
+    manifestFilePath: string;
+};
+export declare function getAppNodeRuntimeManifest(appConfig: EcoPagesAppConfig): NodeRuntimeManifest;
+export declare function setAppNodeRuntimeManifest(appConfig: EcoPagesAppConfig, nodeRuntimeManifest: NodeRuntimeManifest): void;

package/src/services/runtime-manifest/node-runtime-manifest.service.js

@@ -0,0 +1,60 @@
+import { mkdirSync, writeFileSync } from "node:fs";
+import path from "node:path";
+import { DEFAULT_ECOPAGES_WORK_DIR } from "../../constants.js";
+const NODE_RUNTIME_MANIFEST_DIRNAME = "runtime";
+const NODE_RUNTIME_MANIFEST_FILENAME = "node-runtime-manifest.json";
+function getNodeRuntimeManifestPath(appConfig) {
+  return path.join(resolveWorkDir(appConfig), NODE_RUNTIME_MANIFEST_DIRNAME, NODE_RUNTIME_MANIFEST_FILENAME);
+}
+function resolveWorkDir(appConfig) {
+  return appConfig.absolutePaths?.workDir ?? path.join(appConfig.rootDir, appConfig.workDir ?? DEFAULT_ECOPAGES_WORK_DIR);
+}
+function createNodeRuntimeManifest(appConfig, options) {
+  return {
+    runtime: "node",
+    appRootDir: appConfig.rootDir,
+    sourceRootDir: appConfig.absolutePaths.srcDir,
+    distDir: appConfig.absolutePaths.distDir,
+    workDir: resolveWorkDir(appConfig),
+    modulePaths: {
+      config: appConfig.absolutePaths.config,
+      ...options?.entryModulePath ? { entry: options.entryModulePath } : {}
+    }
+  };
+}
+function writeNodeRuntimeManifestFile(manifest, manifestFilePath) {
+  mkdirSync(path.dirname(manifestFilePath), { recursive: true });
+  writeFileSync(manifestFilePath, `${JSON.stringify(manifest, null, 2)}
+`, "utf8");
+  return manifestFilePath;
+}
+function writeAppNodeRuntimeManifest(appConfig, options) {
+  const manifest = createNodeRuntimeManifest(appConfig, {
+    entryModulePath: options?.entryModulePath
+  });
+  const manifestFilePath = writeNodeRuntimeManifestFile(
+    manifest,
+    options?.manifestFilePath ?? getNodeRuntimeManifestPath(appConfig)
+  );
+  return {
+    manifest,
+    manifestFilePath
+  };
+}
+function getAppNodeRuntimeManifest(appConfig) {
+  return appConfig.runtime?.nodeRuntimeManifest ?? createNodeRuntimeManifest(appConfig);
+}
+function setAppNodeRuntimeManifest(appConfig, nodeRuntimeManifest) {
+  appConfig.runtime = {
+    ...appConfig.runtime ?? {},
+    nodeRuntimeManifest
+  };
+}
+export {
+  createNodeRuntimeManifest,
+  getAppNodeRuntimeManifest,
+  getNodeRuntimeManifestPath,
+  setAppNodeRuntimeManifest,
+  writeAppNodeRuntimeManifest,
+  writeNodeRuntimeManifestFile
+};

package/src/services/runtime-state/dev-graph.service.d.ts

@@ -0,0 +1,118 @@
+import type { EcoPagesAppConfig } from '../../internal-types.js';
+import { type ServerInvalidationState } from './server-invalidation-state.service.js';
+import { type EntrypointDependencyGraph } from './entrypoint-dependency-graph.service.js';
+/**
+ * Tracks development-time dependency relationships and invalidation state for
+ * one Ecopages app instance.
+ *
+ * @remarks
+ * The current contract stays intentionally small. It supports today's needs for
+ * server-module cache invalidation and entrypoint-to-dependency lookups without
+ * forcing the rest of the runtime to know about one specific graph
+ * implementation.
+ */
+export interface DevGraphService extends ServerInvalidationState, EntrypointDependencyGraph {
+}
+/**
+ * Minimal dev-graph implementation used when an app has no selective graph
+ * metadata available.
+ *
+ * @remarks
+ * This preserves correct behavior by using coarse invalidation version bumps.
+ * Callers still pass changed-file information through the interface now so a
+ * richer graph can become more selective later without changing call sites.
+ */
+export declare class NoopDevGraphService implements DevGraphService {
+    private readonly invalidationState;
+    private readonly dependencyGraph;
+    /**
+     * Returns the current coarse invalidation version.
+     */
+    getServerInvalidationVersion(): number;
+    /**
+     * Invalidates all server-side module state by incrementing the shared version.
+     */
+    invalidateServerModules(_changedFiles?: string[]): void;
+    /**
+     * Indicates that this graph cannot target invalidation to one entrypoint set.
+     */
+    supportsSelectiveInvalidation(): boolean;
+    /**
+     * Returns an empty entrypoint set because this implementation stores no
+     * dependency graph metadata.
+     */
+    getDependencyEntrypoints(_filePath: string): Set<string>;
+    /**
+     * Accepts dependency updates to preserve interface compatibility, but stores no
+     * graph state in the noop implementation.
+     */
+    setEntrypointDependencies(_entrypointPath: string, _dependencies: string[]): void;
+    /**
+     * Clears one entrypoint from the graph.
+     *
+     * @remarks
+     * There is no stored graph state in this implementation, so this is a no-op.
+     */
+    clearEntrypointDependencies(_entrypointPath: string): void;
+    /**
+     * Resets graph-owned state for a fresh runtime cycle.
+     */
+    reset(): void;
+}
+/**
+ * In-memory development graph with entrypoint-to-dependency reverse lookups.
+ *
+ * @remarks
+ * This is the current selective graph implementation used by development flows
+ * that need to answer which entrypoints depend on a changed file while still
+ * keeping invalidation state app-local.
+ */
+export declare class InMemoryDevGraphService implements DevGraphService {
+    private readonly invalidationState;
+    private readonly dependencyGraph;
+    /**
+     * Returns the current app-local server invalidation version.
+     */
+    getServerInvalidationVersion(): number;
+    /**
+     * Invalidates the current server-module cache generation.
+     *
+     * @remarks
+     * The current implementation still uses a coarse generation bump for server
+     * modules. Selective dependency lookups are used by callers that need to limit
+     * browser rebuild work.
+     */
+    invalidateServerModules(_changedFiles?: string[]): void;
+    /**
+     * Indicates that this graph can answer dependency-to-entrypoint lookups.
+     */
+    supportsSelectiveInvalidation(): boolean;
+    /**
+     * Returns all known entrypoints that currently depend on the given file.
+     */
+    getDependencyEntrypoints(filePath: string): Set<string>;
+    /**
+     * Replaces the stored dependency set for one entrypoint.
+     *
+     * @remarks
+     * The entrypoint itself is always included in its own dependency set so reverse
+     * lookups can map a changed entry file back to that same entrypoint.
+     */
+    setEntrypointDependencies(entrypointPath: string, dependencies: string[]): void;
+    /**
+     * Removes one entrypoint and all of its reverse dependency edges.
+     */
+    clearEntrypointDependencies(entrypointPath: string): void;
+    /**
+     * Clears all graph state and starts a fresh invalidation generation.
+     */
+    reset(): void;
+}
+/**
+ * Returns the dev-graph service owned by one app instance.
+ */
+export declare function getAppDevGraphService(appConfig: EcoPagesAppConfig): DevGraphService;
+/**
+ * Installs the dev-graph service that should back one app/runtime instance.
+ */
+export declare function setAppDevGraphService(appConfig: EcoPagesAppConfig, devGraphService: DevGraphService): void;