@ecopages/core 0.2.0-alpha.2 → 0.2.0-alpha.20

package/src/plugins/integration-plugin.js

@@ -1,4 +1,4 @@
-import { AssetProcessingService } from "../services/asset-processing-service/asset-processing.service";
+import { AssetProcessingService } from "../services/assets/asset-processing-service/asset-processing.service.js";
 const INTEGRATION_PLUGIN_ERRORS = {
   NOT_INITIALIZED_WITH_APP_CONFIG: "Plugin not initialized with app config",
   NOT_INITIALIZED_WITH_ASSET_SERVICE: "Plugin not initialized with asset dependency service"
@@ -7,6 +7,8 @@ class IntegrationPlugin {
   name;
   extensions;
   staticBuildStep;
+  runtimeCapability;
+  jsxImportSource;
   integrationDependencies;
   resolvedIntegrationDependencies = [];
   options;
@@ -16,21 +18,75 @@ class IntegrationPlugin {
   get plugins() {
     return [];
   }
+  /**
+   * Returns build plugins that should only apply to browser-oriented bundles.
+   *
+   * @remarks
+   * Browser-only transforms such as runtime import aliasing belong here so they
+   * do not affect server bundles or static-page module generation.
+   */
+  get browserBuildPlugins() {
+    return [];
+  }
+  /**
+   * Creates the integration with static declaration-only configuration.
+   *
+   * @remarks
+   * Constructors are expected to stay side-effect free. Build-manifest
+   * contributions belong in `prepareBuildContributions()` and runtime-only setup
+   * belongs in `setup()`.
+   */
   constructor(config) {
     this.name = config.name;
     this.extensions = config.extensions;
     this.integrationDependencies = config.integrationDependencies || [];
     this.staticBuildStep = config.staticBuildStep || "render";
+    this.runtimeCapability = config.runtimeCapability;
+    this.jsxImportSource = config.jsxImportSource;
   }
+  /**
+   * Attaches the finalized app config to the integration.
+   *
+   * Core calls this during config finalization before runtime setup so the
+   * integration can resolve asset paths and other app-owned services later.
+   */
   setConfig(appConfig) {
     this.appConfig = appConfig;
     this.initializeAssetDefinitionService();
   }
+  /**
+   * Records the runtime origin used for page-module loading and renderer setup.
+   */
   setRuntimeOrigin(runtimeOrigin) {
     this.runtimeOrigin = runtimeOrigin;
   }
+  /**
+   * Returns bare-specifier mappings that should be registered in the active
+   * runtime specifier registry.
+   *
+   * @remarks
+   * Integrations that own browser runtime bundles can override this to expose
+   * stable bare specifiers for client-side imports.
+   *
+   * Today these mappings are consumed by the development runtime and browser
+   * bundle aliasing path. They are intentionally generic enough to grow into a
+   * broader import-map-style facility later without moving framework-specific
+   * map contents into core.
+   */
+  getRuntimeSpecifierMap() {
+    return {};
+  }
+  /**
+   * Attaches the shared HMR manager and registers integration-owned development hooks.
+   *
+   * @remarks
+   * The default implementation registers both runtime bare-specifier mappings and
+   * the optional integration HMR strategy. Integrations should override this only
+   * when they need to extend that shared behavior rather than replace it.
+   */
   setHmrManager(hmrManager) {
     this.hmrManager = hmrManager;
+    hmrManager.registerSpecifierMap(this.getRuntimeSpecifierMap());
     const strategy = this.getHmrStrategy?.();
     if (strategy) {
       hmrManager.registerStrategy(strategy);
@@ -39,6 +95,9 @@ class IntegrationPlugin {
       this.assetProcessingService.setHmrManager(hmrManager);
     }
   }
+  /**
+   * Creates the asset-processing service used for global integration dependencies.
+   */
   initializeAssetDefinitionService() {
     if (!this.appConfig) throw new Error(INTEGRATION_PLUGIN_ERRORS.NOT_INITIALIZED_WITH_APP_CONFIG);
     this.assetProcessingService = AssetProcessingService.createWithDefaultProcessors(this.appConfig);
@@ -46,10 +105,16 @@ class IntegrationPlugin {
       this.assetProcessingService.setHmrManager(this.hmrManager);
     }
   }
+  /**
+   * Returns processed global assets resolved during `setup()`.
+   */
   getResolvedIntegrationDependencies() {
     return this.resolvedIntegrationDependencies;
   }
-  initializeRenderer() {
+  /**
+   * Creates the shared renderer options owned by core lifecycle setup.
+   */
+  createRendererOptions(options) {
     if (!this.appConfig) {
       throw new Error(INTEGRATION_PLUGIN_ERRORS.NOT_INITIALIZED_WITH_APP_CONFIG);
     }
@@ -57,31 +122,54 @@ class IntegrationPlugin {
     if (this.hmrManager) {
       assetProcessingService.setHmrManager(this.hmrManager);
     }
-    const renderer = new this.renderer({
+    return {
       appConfig: this.appConfig,
       assetProcessingService,
       resolvedIntegrationDependencies: this.resolvedIntegrationDependencies,
+      rendererModules: options?.rendererModules,
       runtimeOrigin: this.runtimeOrigin
-    });
+    };
+  }
+  /**
+   * Attaches runtime-only services after a renderer instance has been created.
+   */
+  attachRendererRuntimeServices(renderer) {
+    if (typeof renderer.name !== "string" || renderer.name.length === 0) {
+      renderer.name = this.name;
+    }
     if (this.hmrManager) {
       renderer.setHmrManager(this.hmrManager);
     }
     return renderer;
   }
   /**
-   * Declares whether a component boundary targeting this integration should be
-   * deferred through the marker pipeline.
+   * Instantiates the integration renderer with app-owned services.
    *
-   * The default implementation never defers. Integrations that require deferred
-   * subtree rendering should override this method and return `true` when their
-   * boundary must be resolved during the marker graph stage.
+   * @remarks
+   * Renderers are cheap runtime objects. They receive the finalized app config,
+   * a fresh asset-processing service, integration-global processed assets, and
+   * any renderer module context supplied by the active runtime.
+  		renderer.name ||= this.name;
+   */
+  initializeRenderer(options) {
+    const renderer = new this.renderer(this.createRendererOptions(options));
+    renderer.name ||= this.name;
+    return this.attachRendererRuntimeServices(renderer);
+  }
+  /**
+   * Prepares build-facing contributions before the app build manifest is sealed.
    *
-   * @param input Boundary metadata for the current render pass.
-   * @returns `true` when the boundary should be deferred; otherwise `false`.
+   * @remarks
+   * Integrations can override this when runtime or build plugin declarations must
+   * be materialized ahead of runtime startup. Runtime-only side effects stay in
+   * `setup()`.
    */
-  shouldDeferComponentBoundary(_input) {
-    return false;
+  async prepareBuildContributions() {
   }
+  /**
+   * Performs runtime-only integration setup after config build has already
+   * sealed manifest contributions.
+   */
   async setup() {
     if (this.integrationDependencies.length === 0) return;
     if (!this.assetProcessingService) throw new Error(INTEGRATION_PLUGIN_ERRORS.NOT_INITIALIZED_WITH_ASSET_SERVICE);
@@ -91,6 +179,14 @@ class IntegrationPlugin {
     );
     this.initializeRenderer();
   }
+  /**
+   * Releases runtime resources owned by the integration.
+   *
+   * @remarks
+   * Most integrations do not need custom teardown. Override this only for
+   * explicit cleanup such as watchers, compiler handles, or runtime registries
+   * that outlive individual requests.
+   */
   async teardown() {
   }
 }

package/src/plugins/processor.d.ts

@@ -1,6 +1,8 @@
 import type { EcoBuildPlugin } from '../build/build-types.js';
-import type { EcoPagesAppConfig, IClientBridge } from '../internal-types';
-import type { AssetDefinition } from '../services/asset-processing-service';
+import type { EcoPagesAppConfig, IClientBridge } from '../types/internal-types.js';
+import type { AssetDefinition } from '../services/assets/asset-processing-service/assets.types.js';
+import type { RuntimeCapabilityDeclaration } from './runtime-capability.js';
+export type { RuntimeCapabilityDeclaration, RuntimeCapabilityTag } from './runtime-capability.js';
 export declare const PROCESSOR_ERRORS: {
     readonly CACHE_DIRECTORY_NOT_SET: "Cache directory not set in context";
 };
@@ -38,6 +40,7 @@ export interface ProcessorConfig<TOptions = Record<string, unknown>> {
     options?: TOptions;
     watch?: ProcessorWatchConfig;
     capabilities?: ProcessorAssetCapability[];
+    runtimeCapability?: RuntimeCapabilityDeclaration;
 }
 export interface ProcessorContext {
     config: EcoPagesAppConfig;
@@ -59,12 +62,22 @@ export declare abstract class Processor<TOptions = Record<string, unknown>> {
     protected options?: TOptions;
     protected watchConfig?: ProcessorWatchConfig;
     protected capabilities: ProcessorAssetCapability[];
+    readonly runtimeCapability?: RuntimeCapabilityDeclaration;
     /** Plugins that are only used during the build process */
     abstract buildPlugins?: EcoBuildPlugin[];
     /** Plugins that are used during runtime for file processing */
     abstract plugins?: EcoBuildPlugin[];
     constructor(config: ProcessorConfig<TOptions>);
     setContext(appConfig: EcoPagesAppConfig): void;
+    /**
+     * Prepares build-facing processor contributions before config finalization.
+     *
+     * @remarks
+     * Override this when a processor must compute runtime/build plugins or other
+     * manifest-owned state before startup. Runtime-only work such as cache
+     * warming or watcher registration should stay in `setup()`.
+     */
+    prepareBuildContributions(): Promise<void>;
     abstract setup(): Promise<void>;
     abstract teardown(): Promise<void>;
     abstract process(input: unknown, filePath?: string): Promise<unknown>;

package/src/plugins/processor.js

@@ -1,6 +1,7 @@
 import path from "node:path";
 import { fileSystem } from "@ecopages/file-system";
-import { GENERATED_BASE_PATHS } from "../constants";
+import { DEFAULT_ECOPAGES_WORK_DIR } from "../config/constants.js";
+import { GENERATED_BASE_PATHS } from "../config/constants.js";
 const PROCESSOR_ERRORS = {
   CACHE_DIRECTORY_NOT_SET: "Cache directory not set in context"
 };
@@ -16,15 +17,18 @@ class Processor {
   options;
   watchConfig;
   capabilities = [];
+  runtimeCapability;
   constructor(config) {
     this.name = config.name;
     this.options = config.options;
     this.watchConfig = config.watch;
     this.capabilities = config.capabilities ?? [];
+    this.runtimeCapability = config.runtimeCapability;
   }
   setContext(appConfig) {
+    const workDir = appConfig.absolutePaths.workDir ?? path.join(appConfig.rootDir, appConfig.workDir ?? DEFAULT_ECOPAGES_WORK_DIR);
     const cachePath = resolveGeneratedPath("cache", {
-      root: appConfig.absolutePaths.distDir,
+      root: workDir,
       module: this.name
     });
     fileSystem.ensureDir(cachePath);
@@ -36,6 +40,16 @@ class Processor {
       cache: cachePath
     };
   }
+  /**
+   * Prepares build-facing processor contributions before config finalization.
+   *
+   * @remarks
+   * Override this when a processor must compute runtime/build plugins or other
+   * manifest-owned state before startup. Runtime-only work such as cache
+   * warming or watcher registration should stay in `setup()`.
+   */
+  async prepareBuildContributions() {
+  }
   getCachePath(key) {
     return `${this.context?.cache}/${key}`;
   }

package/src/plugins/runtime-capability.d.ts

@@ -0,0 +1,9 @@
+export type RuntimeCapabilityTag = 'bun-only' | 'node-compatible' | 'requires-native-bun-api' | 'requires-node-builtins';
+/**
+ * Declares the runtime assumptions a plugin makes so config finalization can
+ * reject incompatible startup environments before bootstrapping the app.
+ */
+export interface RuntimeCapabilityDeclaration {
+    tags: RuntimeCapabilityTag[];
+    minRuntimeVersion?: string;
+}

package/src/plugins/source-transform.d.ts

@@ -0,0 +1,46 @@
+import type { EcoBuildPlugin } from '../build/build-types.js';
+import type { EcoPagesAppConfig } from '../types/internal-types.js';
+export interface EcoSourceTransformResult {
+    code: string;
+    map?: unknown;
+}
+export interface EcoSourceTransform {
+    name: string;
+    filter: RegExp;
+    enforce?: 'pre' | 'post';
+    transform(code: string, id: string): EcoSourceTransformResult | string | undefined;
+}
+export interface EcoViteCompatiblePlugin {
+    name: string;
+    enforce?: 'pre' | 'post';
+    transform(code: string, id: string): EcoSourceTransformResult | string | undefined;
+}
+/**
+ * Normalizes bundler module ids so one transform can serve Ecopages loaders,
+ * Vite, and future bundler adapters.
+ */
+export declare function normalizeTransformId(id: string): string;
+/**
+ * Applies one source transform if the normalized id matches its filter.
+ */
+export declare function applySourceTransform(transform: EcoSourceTransform, code: string, id: string): EcoSourceTransformResult | string | undefined;
+/**
+ * Adapts a source transform into the existing Ecopages build-plugin contract.
+ */
+export declare function createEcoBuildPluginFromSourceTransform(transform: EcoSourceTransform): EcoBuildPlugin;
+/**
+ * Adapts a source transform into a Vite-compatible plugin object.
+ *
+ * @remarks
+ * This intentionally returns a plain object shape so core does not need a hard
+ * dependency on `vite` just to author transform primitives.
+ */
+export declare function createVitePluginFromSourceTransform(transform: EcoSourceTransform): EcoViteCompatiblePlugin;
+/**
+ * Returns the app-owned source transforms in stable registration order.
+ */
+export declare function getAppSourceTransforms(appConfig: EcoPagesAppConfig): EcoSourceTransform[];
+/**
+ * Adapts the app-owned source transforms into Vite-compatible plugin objects.
+ */
+export declare function createVitePluginsFromAppSourceTransforms(appConfig: EcoPagesAppConfig): EcoViteCompatiblePlugin[];

package/src/plugins/source-transform.js

@@ -0,0 +1,71 @@
+import path from "node:path";
+import { fileSystem } from "@ecopages/file-system";
+function normalizeTransformId(id) {
+  const queryIndex = id.indexOf("?");
+  const hashIndex = id.indexOf("#");
+  const endIndex = [queryIndex, hashIndex].filter((index) => index >= 0).sort((left, right) => left - right)[0];
+  return endIndex === void 0 ? id : id.slice(0, endIndex);
+}
+function applySourceTransform(transform, code, id) {
+  const normalizedId = normalizeTransformId(id);
+  if (!transform.filter.test(normalizedId)) {
+    return void 0;
+  }
+  return transform.transform(code, normalizedId);
+}
+function inferLoaderFromPath(filePath) {
+  const extension = path.extname(filePath).toLowerCase();
+  switch (extension) {
+    case ".ts":
+      return "ts";
+    case ".tsx":
+      return "tsx";
+    case ".jsx":
+      return "jsx";
+    default:
+      return "js";
+  }
+}
+function createEcoBuildPluginFromSourceTransform(transform) {
+  return {
+    name: transform.name,
+    setup(build) {
+      build.onLoad({ filter: transform.filter }, (args) => {
+        const filePath = normalizeTransformId(args.path);
+        const code = fileSystem.readFileSync(filePath);
+        const result = applySourceTransform(transform, code, filePath);
+        if (!result) {
+          return void 0;
+        }
+        return {
+          contents: typeof result === "string" ? result : result.code,
+          loader: inferLoaderFromPath(filePath),
+          resolveDir: path.dirname(filePath)
+        };
+      });
+    }
+  };
+}
+function createVitePluginFromSourceTransform(transform) {
+  return {
+    name: transform.name,
+    enforce: transform.enforce,
+    transform(code, id) {
+      return applySourceTransform(transform, code, id);
+    }
+  };
+}
+function getAppSourceTransforms(appConfig) {
+  return Array.from(appConfig.sourceTransforms.values());
+}
+function createVitePluginsFromAppSourceTransforms(appConfig) {
+  return getAppSourceTransforms(appConfig).map((transform) => createVitePluginFromSourceTransform(transform));
+}
+export {
+  applySourceTransform,
+  createEcoBuildPluginFromSourceTransform,
+  createVitePluginFromSourceTransform,
+  createVitePluginsFromAppSourceTransforms,
+  getAppSourceTransforms,
+  normalizeTransformId
+};