@ecopages/mdx 0.2.0-alpha.13 → 0.2.0-alpha.15

package/CHANGELOG.md

@@ -18,6 +18,10 @@ All notable changes to `@ecopages/mdx` are documented here.
 
 - Updated the README for standalone non-React MDX usage, `.md` opt-in handling, and compiler configuration.
 
+### Refactoring
+
+- Replaced the standalone MDX renderer factory with explicit renderer-owned compiler configuration and collected shared MDX plugin and renderer types into a dedicated module.
+
 ---
 
 ## Migration Notes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ecopages/mdx",
-  "version": "0.2.0-alpha.13",
+  "version": "0.2.0-alpha.15",
   "description": "MDX plugin for Ecopages",
   "keywords": [
     "ecopages",
@@ -37,7 +37,7 @@
     "directory": "packages/integrations/mdx"
   },
   "peerDependencies": {
-    "@ecopages/core": "0.2.0-alpha.13",
+    "@ecopages/core": "0.2.0-alpha.15",
     "@kitajs/html": "^4.1.0",
     "@mdx-js/mdx": "^3.1.0"
   },

package/src/mdx-renderer.d.ts

@@ -2,36 +2,24 @@
  * This module contains the MDX renderer
  * @module
  */
-import type { ComponentRenderInput, ComponentRenderResult, EcoComponent, EcoComponentConfig, EcoPageFile, EcoPagesElement, GetMetadata, IntegrationRendererRenderOptions, RouteRendererBody } from '@ecopages/core';
+import type { ComponentRenderInput, ComponentRenderResult, EcoComponent, EcoPageFile, EcoPagesElement, IntegrationRendererRenderOptions, RouteRendererBody } from '@ecopages/core';
 import { IntegrationRenderer, type RenderToResponseContext } from '@ecopages/core/route-renderer/integration-renderer';
-import type { AssetProcessingService, ProcessedAsset } from '@ecopages/core/services/asset-processing-service';
+import type { ProcessedAsset } from '@ecopages/core/services/asset-processing-service';
 import type { CompileOptions } from '@mdx-js/mdx';
-/**
- * A structure representing an MDX file
- */
-export type MDXFile = {
-    default: EcoComponent;
-    config?: EcoComponentConfig;
-    getMetadata: GetMetadata;
-};
+import type { MDXRendererOptions } from './mdx.types.js';
+export type { MDXFile, MDXRendererConfig, MDXRendererOptions } from './mdx.types.js';
 /**
  * Options for the MDX renderer
  */
-interface MDXIntegrationRendererOpions<C = EcoPagesElement> extends IntegrationRendererRenderOptions<C> {
+interface MDXIntegrationRendererOptions<C = EcoPagesElement> extends IntegrationRendererRenderOptions<C> {
 }
 /**
  * A renderer for the MDX integration.
  */
 export declare class MDXRenderer extends IntegrationRenderer<EcoPagesElement> {
     name: string;
-    compilerOptions: CompileOptions;
-    constructor({ compilerOptions, ...options }: {
-        appConfig: any;
-        assetProcessingService: AssetProcessingService;
-        resolvedIntegrationDependencies: ProcessedAsset[];
-        runtimeOrigin: string;
-        compilerOptions?: CompileOptions;
-    });
+    readonly compilerOptions: CompileOptions;
+    constructor({ mdxConfig, ...options }: MDXRendererOptions);
     buildRouteRenderAssets(pagePath: string): Promise<ProcessedAsset[]>;
     protected normalizeImportedPageFile<TPageModule extends EcoPageFile>(_file: string, pageModule: TPageModule): TPageModule;
     renderComponent(input: ComponentRenderInput): Promise<ComponentRenderResult>;
@@ -39,14 +27,6 @@ export declare class MDXRenderer extends IntegrationRenderer<EcoPagesElement> {
         boundaryInput: ComponentRenderInput;
         rendererCache: Map<string, IntegrationRenderer<any>>;
     }): import("@ecopages/core").ComponentBoundaryRuntime;
-    render({ params, query, props, locals, pageLocals, metadata, Page, HtmlTemplate, Layout, pageProps, }: MDXIntegrationRendererOpions): Promise<RouteRendererBody>;
+    render({ params, query, props, locals, pageLocals, metadata, Page, HtmlTemplate, Layout, pageProps, }: MDXIntegrationRendererOptions): Promise<RouteRendererBody>;
     renderToResponse<P = Record<string, unknown>>(view: EcoComponent<P>, props: P, ctx: RenderToResponseContext): Promise<Response>;
 }
-/**
- * Factory function to create an MDX renderer class with specific compiler options.
- *
- * @param compilerOptions - Compiler options for MDX compilation.
- * @returns A new MDXRenderer class extended with the provided context.
- */
-export declare function createMDXRenderer(compilerOptions: CompileOptions): typeof MDXRenderer;
-export {};

package/src/mdx-renderer.js

@@ -5,12 +5,9 @@ import { rapidhash } from "@ecopages/core/hash";
 class MDXRenderer extends IntegrationRenderer {
   name = PLUGIN_NAME;
   compilerOptions;
-  constructor({
-    compilerOptions,
-    ...options
-  }) {
+  constructor({ mdxConfig, ...options }) {
     super(options);
-    this.compilerOptions = compilerOptions || {};
+    this.compilerOptions = mdxConfig?.compilerOptions ?? {};
   }
   async buildRouteRenderAssets(pagePath) {
     const { default: pageComponent } = await this.importPageFile(pagePath);
@@ -108,17 +105,6 @@ class MDXRenderer extends IntegrationRenderer {
     }
   }
 }
-function createMDXRenderer(compilerOptions) {
-  return class extends MDXRenderer {
-    constructor(options) {
-      super({
-        ...options,
-        compilerOptions
-      });
-    }
-  };
-}
 export {
-  MDXRenderer,
-  createMDXRenderer
+  MDXRenderer
 };

package/src/mdx.plugin.d.ts

@@ -1,15 +1,13 @@
 import type { EcoBuildPlugin } from '@ecopages/core/build/build-types';
 import type { EcoPagesElement } from '@ecopages/core';
-import { IntegrationPlugin, type IntegrationPluginConfig } from '@ecopages/core/plugins/integration-plugin';
-import type { CompileOptions } from '@mdx-js/mdx';
+import { IntegrationPlugin } from '@ecopages/core/plugins/integration-plugin';
 import { MDXRenderer } from './mdx-renderer.js';
+import type { MDXPluginConfig } from './mdx.types.js';
+export type { MDXPluginConfig, MDXRendererConfig, MDXRendererOptions } from './mdx.types.js';
 /**
  * The name of the MDX plugin
  */
 export declare const PLUGIN_NAME = "MDX";
-export type MDXPluginConfig = Partial<Omit<IntegrationPluginConfig, 'name'>> & {
-    compilerOptions?: CompileOptions;
-};
 /**
  * The MDX plugin class
  * This plugin provides support for MDX components in Ecopages.
@@ -20,9 +18,12 @@ export type MDXPluginConfig = Partial<Omit<IntegrationPluginConfig, 'name'>> & {
  */
 export declare class MDXPlugin extends IntegrationPlugin<EcoPagesElement> {
     renderer: typeof MDXRenderer;
-    private compilerOptions;
+    private readonly compilerOptions;
     private mdxLoaderPlugin;
     constructor({ compilerOptions, ...options }?: MDXPluginConfig);
+    initializeRenderer(options?: {
+        rendererModules?: unknown;
+    }): MDXRenderer;
     get plugins(): EcoBuildPlugin[];
     /**
      * Materializes the MDX loader once so config-time sealing and runtime setup

package/src/mdx.plugin.js

@@ -2,7 +2,7 @@ import { IntegrationPlugin } from "@ecopages/core/plugins/integration-plugin";
 import { deepMerge } from "@ecopages/core/utils/deep-merge";
 import { Logger } from "@ecopages/logger";
 import { createMdxLoaderPlugin } from "./mdx-loader-plugin.js";
-import { createMDXRenderer, MDXRenderer } from "./mdx-renderer.js";
+import { MDXRenderer } from "./mdx-renderer.js";
 const appLogger = new Logger("[MDXPlugin]");
 const PLUGIN_NAME = "MDX";
 const defaultOptions = {
@@ -25,7 +25,7 @@ function splitMarkdownExtensions(extensions) {
   return { mdExtensions, mdxExtensions };
 }
 class MDXPlugin extends IntegrationPlugin {
-  renderer;
+  renderer = MDXRenderer;
   compilerOptions;
   mdxLoaderPlugin;
   constructor({ compilerOptions, ...options } = { extensions: [".mdx"] }) {
@@ -50,9 +50,17 @@ class MDXPlugin extends IntegrationPlugin {
       );
     }
     this.compilerOptions = finalCompilerOptions;
-    this.renderer = createMDXRenderer(finalCompilerOptions);
     appLogger.debug(`MDX plugin configured with jsxImportSource: ${jsxImportSource ?? "default"}`);
   }
+  initializeRenderer(options) {
+    const renderer = new this.renderer({
+      ...this.createRendererOptions(options),
+      mdxConfig: {
+        compilerOptions: this.compilerOptions
+      }
+    });
+    return this.attachRendererRuntimeServices(renderer);
+  }
   get plugins() {
     if (this.mdxLoaderPlugin) {
       return [this.mdxLoaderPlugin];

package/src/mdx.types.d.ts

@@ -0,0 +1,27 @@
+import type { EcoComponent, EcoComponentConfig, GetMetadata } from '@ecopages/core';
+import type { EcoPagesAppConfig } from '@ecopages/core/internal-types';
+import type { IntegrationPluginConfig } from '@ecopages/core/plugins/integration-plugin';
+import type { AssetProcessingService, ProcessedAsset } from '@ecopages/core/services/asset-processing-service';
+import type { CompileOptions } from '@mdx-js/mdx';
+export type MDXPluginConfig = Partial<Omit<IntegrationPluginConfig, 'name'>> & {
+    compilerOptions?: CompileOptions;
+};
+export type MDXRendererConfig = {
+    compilerOptions?: CompileOptions;
+};
+export type MDXRendererOptions = {
+    appConfig: EcoPagesAppConfig;
+    assetProcessingService: AssetProcessingService;
+    resolvedIntegrationDependencies: ProcessedAsset[];
+    rendererModules?: unknown;
+    runtimeOrigin: string;
+    mdxConfig?: MDXRendererConfig;
+};
+/**
+ * A structure representing an MDX file.
+ */
+export type MDXFile = {
+    default: EcoComponent;
+    config?: EcoComponentConfig;
+    getMetadata: GetMetadata;
+};