@ecopages/react 0.2.1-beta.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +164 -28
- package/package.json +67 -30
- package/src/app/client-only.js +10 -0
- package/src/app/dynamic.js +9 -0
- package/src/app/dynamic.test.browser.js +38 -0
- package/src/bundling/bootstrap-package-paths.d.ts +5 -0
- package/src/bundling/bootstrap-package-paths.js +5 -0
- package/src/{services/react-bundle.service.d.ts → bundling/bundle.d.ts} +29 -11
- package/src/bundling/bundle.js +130 -0
- package/src/bundling/runtime-alias-map.d.ts +12 -0
- package/src/bundling/runtime-alias-map.js +110 -0
- package/src/bundling/runtime-bundle.d.ts +70 -0
- package/src/bundling/runtime-bundle.js +233 -0
- package/src/{utils/react-dom-runtime-interop-plugin.d.ts → bundling/runtime-interop-plugin.d.ts} +1 -1
- package/src/bundling/runtime-interop-plugin.js +32 -0
- package/src/bundling/runtime-mode.d.ts +1 -0
- package/src/bundling/runtime-mode.js +10 -0
- package/src/bundling/runtime-modules.d.ts +21 -0
- package/src/bundling/runtime-modules.js +28 -0
- package/src/client-graph/ast-transform-eco-page.d.ts +10 -0
- package/src/client-graph/ast-transform-eco-page.js +71 -0
- package/src/client-graph/ast-transform-import-edits.d.ts +13 -0
- package/src/client-graph/ast-transform-import-edits.js +75 -0
- package/src/client-graph/ast-transform-walk-imports.d.ts +20 -0
- package/src/client-graph/ast-transform-walk-imports.js +105 -0
- package/src/client-graph/ast-transform.d.ts +12 -0
- package/src/client-graph/ast-transform.js +91 -0
- package/src/client-graph/ast-walk.d.ts +10 -0
- package/src/client-graph/ast-walk.js +26 -0
- package/src/client-graph/boundary-plugin-read-file-inline.d.ts +7 -0
- package/src/client-graph/boundary-plugin-read-file-inline.js +43 -0
- package/src/client-graph/boundary-plugin-transform.d.ts +16 -0
- package/src/client-graph/boundary-plugin-transform.js +31 -0
- package/src/client-graph/boundary-plugin.d.ts +23 -0
- package/src/client-graph/boundary-plugin.js +177 -0
- package/src/client-graph/component-config-traversal.js +77 -0
- package/src/client-graph/declared-modules.js +69 -0
- package/src/client-graph/module-classification.d.ts +3 -0
- package/src/client-graph/module-classification.js +43 -0
- package/src/client-graph/reachability-analyzer.d.ts +26 -0
- package/src/client-graph/reachability-analyzer.js +55 -0
- package/src/client-graph/reachability-client-roots.d.ts +8 -0
- package/src/client-graph/reachability-client-roots.js +59 -0
- package/src/client-graph/reachability-export-names.d.ts +5 -0
- package/src/client-graph/reachability-export-names.js +34 -0
- package/src/client-graph/reachability-fallback-roots.d.ts +3 -0
- package/src/client-graph/reachability-fallback-roots.js +71 -0
- package/src/client-graph/reachability-preload.d.ts +10 -0
- package/src/client-graph/reachability-preload.js +30 -0
- package/src/client-graph/reachability-top-level-index.d.ts +14 -0
- package/src/client-graph/reachability-top-level-index.js +93 -0
- package/src/client-graph/reachability-traverse.d.ts +7 -0
- package/src/client-graph/reachability-traverse.js +201 -0
- package/src/client-graph/specifier-classification.d.ts +74 -0
- package/src/client-graph/specifier-classification.js +191 -0
- package/src/content/collection-component-cache.d.ts +25 -0
- package/src/content/collection-component-cache.js +62 -0
- package/src/contracts/router-adapter.js +6 -0
- package/src/dev-transform/react-dev-transform-contributor.d.ts +17 -0
- package/src/dev-transform/react-dev-transform-contributor.js +22 -0
- package/src/hmr/hmr-strategy-process.d.ts +34 -0
- package/src/hmr/hmr-strategy-process.js +83 -0
- package/src/hmr/hmr-strategy.d.ts +67 -0
- package/src/hmr/hmr-strategy.js +306 -0
- package/src/{services/react-hmr-page-metadata-cache.d.ts → hmr/page-metadata-cache.d.ts} +5 -1
- package/src/hmr/page-metadata-cache.js +44 -0
- package/src/hmr/react-hmr-dev-transform-plugins.d.ts +22 -0
- package/src/hmr/react-hmr-dev-transform-plugins.js +19 -0
- package/src/hydration/assert-no-bare-ecopages-imports.d.ts +4 -0
- package/src/hydration/assert-no-bare-ecopages-imports.js +7 -0
- package/src/hydration/bootstrap-imports.d.ts +25 -0
- package/src/hydration/bootstrap-imports.js +33 -0
- package/src/hydration/browser/island-hydration.d.ts +82 -0
- package/src/hydration/browser/island-hydration.js +251 -0
- package/src/hydration/browser/page-hydration-hmr.d.ts +11 -0
- package/src/hydration/browser/page-hydration-hmr.js +56 -0
- package/src/hydration/browser/page-hydration-module.d.ts +8 -0
- package/src/hydration/browser/page-hydration-module.js +17 -0
- package/src/hydration/browser/page-hydration.d.ts +54 -0
- package/src/hydration/browser/page-hydration.js +177 -0
- package/src/hydration/compiled-page-hydration-options.d.ts +20 -0
- package/src/hydration/hydration-asset.d.ts +127 -0
- package/src/hydration/hydration-asset.js +379 -0
- package/src/hydration/hydration-lifecycle.test.browser.d.ts +1 -0
- package/src/hydration/hydration-lifecycle.test.browser.js +461 -0
- package/src/hydration/hydration-page-entry-source.d.ts +5 -0
- package/src/hydration/hydration-page-entry-source.js +87 -0
- package/src/hydration/hydration-script-compiler.d.ts +48 -0
- package/src/hydration/hydration-script-compiler.js +213 -0
- package/src/hydration/page-data-manifest.d.ts +58 -0
- package/src/hydration/page-data-manifest.js +97 -0
- package/src/hydration/page-data-reader.d.ts +17 -0
- package/src/hydration/page-data-reader.js +31 -0
- package/src/hydration/page-payload.d.ts +68 -0
- package/src/hydration/page-payload.js +106 -0
- package/src/hydration/serialize-page-data-script.d.ts +27 -0
- package/src/hydration/serialize-page-data-script.js +30 -0
- package/src/{services/react-mdx-config-dependency.service.d.ts → mdx/mdx-config-dependency.d.ts} +9 -8
- package/src/mdx/mdx-config-dependency.js +107 -0
- package/src/mdx/mdx-loader-plugin.d.ts +8 -0
- package/src/mdx/mdx-loader-plugin.js +11 -0
- package/src/page/page-module.d.ts +46 -0
- package/src/page/page-module.js +74 -0
- package/src/plugin/react.constants.js +1 -0
- package/src/{react.plugin.d.ts → plugin/react.plugin.d.ts} +21 -27
- package/src/plugin/react.plugin.js +210 -0
- package/src/plugin/react.types.d.ts +106 -0
- package/src/plugin/react.types.js +1 -0
- package/src/render/component-ownership.d.ts +49 -0
- package/src/render/component-ownership.js +47 -0
- package/src/render/component-ssr.d.ts +59 -0
- package/src/render/component-ssr.js +76 -0
- package/src/render/eco-embed.js +9 -0
- package/src/render/errors.d.ts +16 -0
- package/src/render/errors.js +23 -0
- package/src/render/html-boundary.js +59 -0
- package/src/render/layout-compose.d.ts +66 -0
- package/src/render/layout-compose.js +134 -0
- package/src/render/react-renderer.d.ts +114 -0
- package/src/render/react-renderer.js +490 -0
- package/src/render/react-runtime.d.ts +13 -0
- package/src/render/react-runtime.js +26 -0
- package/src/render/unified-layout-composition.d.ts +22 -0
- package/src/render/unified-layout-composition.js +31 -0
- package/src/runtime/use-sync-external-store-with-selector.js +52 -54
- package/src/eco-embed.js +0 -11
- package/src/react-hmr-strategy.d.ts +0 -230
- package/src/react-hmr-strategy.js +0 -657
- package/src/react-renderer.d.ts +0 -233
- package/src/react-renderer.js +0 -622
- package/src/react.constants.js +0 -4
- package/src/react.plugin.js +0 -205
- package/src/react.types.d.ts +0 -88
- package/src/react.types.js +0 -0
- package/src/router-adapter.js +0 -0
- package/src/services/pages-index.d.ts +0 -64
- package/src/services/pages-index.js +0 -73
- package/src/services/react-bundle.service.js +0 -86
- package/src/services/react-hmr-page-metadata-cache.js +0 -35
- package/src/services/react-hydration-asset.service.d.ts +0 -84
- package/src/services/react-hydration-asset.service.js +0 -217
- package/src/services/react-mdx-config-dependency.service.js +0 -122
- package/src/services/react-page-module.service.d.ts +0 -88
- package/src/services/react-page-module.service.js +0 -166
- package/src/services/react-page-payload.service.d.ts +0 -46
- package/src/services/react-page-payload.service.js +0 -67
- package/src/services/react-runtime-bundle.service.d.ts +0 -45
- package/src/services/react-runtime-bundle.service.js +0 -186
- package/src/utils/client-graph-boundary-cache.d.ts +0 -108
- package/src/utils/client-graph-boundary-cache.js +0 -116
- package/src/utils/client-graph-boundary-plugin.d.ts +0 -51
- package/src/utils/client-graph-boundary-plugin.js +0 -552
- package/src/utils/client-only.js +0 -19
- package/src/utils/component-config-traversal.js +0 -54
- package/src/utils/declared-modules.js +0 -47
- package/src/utils/dynamic.js +0 -12
- package/src/utils/dynamic.test.browser.js +0 -33
- package/src/utils/hmr-scripts.d.ts +0 -18
- package/src/utils/hmr-scripts.js +0 -31
- package/src/utils/html-boundary.js +0 -55
- package/src/utils/hydration-scripts.d.ts +0 -92
- package/src/utils/hydration-scripts.js +0 -358
- package/src/utils/hydration-scripts.test.browser.js +0 -198
- package/src/utils/reachability-analyzer.d.ts +0 -66
- package/src/utils/reachability-analyzer.js +0 -339
- package/src/utils/react-dom-runtime-interop-plugin.js +0 -38
- package/src/utils/react-mdx-loader-plugin.d.ts +0 -3
- package/src/utils/react-mdx-loader-plugin.js +0 -45
- package/src/utils/react-runtime-alias-map.d.ts +0 -8
- package/src/utils/react-runtime-alias-map.js +0 -90
- /package/src/{utils → app}/client-only.d.ts +0 -0
- /package/src/{utils → app}/dynamic.d.ts +0 -0
- /package/src/{utils → app}/dynamic.test.browser.d.ts +0 -0
- /package/src/{utils → client-graph}/component-config-traversal.d.ts +0 -0
- /package/src/{utils → client-graph}/declared-modules.d.ts +0 -0
- /package/src/{declarations.d.ts → contracts/declarations.d.ts} +0 -0
- /package/src/{router-adapter.d.ts → contracts/router-adapter.d.ts} +0 -0
- /package/src/{utils/hydration-scripts.test.browser.d.ts → hydration/compiled-page-hydration-options.js} +0 -0
- /package/src/{react.constants.d.ts → plugin/react.constants.d.ts} +0 -0
- /package/src/{eco-embed.d.ts → render/eco-embed.d.ts} +0 -0
- /package/src/{utils → render}/html-boundary.d.ts +0 -0
package/src/{services/react-mdx-config-dependency.service.d.ts → mdx/mdx-config-dependency.d.ts}
RENAMED
|
@@ -1,11 +1,12 @@
|
|
|
1
|
-
import type
|
|
2
|
-
import { type AssetProcessingService, type ProcessedAsset } from '@ecopages/core/
|
|
3
|
-
import type {
|
|
1
|
+
import { type EcoComponent, type EcoComponentConfig } from '@ecopages/core';
|
|
2
|
+
import { type AssetProcessingIntegration, type AssetProcessingService, type ProcessedAsset } from '@ecopages/core/integration';
|
|
3
|
+
import type { PageModuleService } from '../page/page-module.js';
|
|
4
4
|
type MdxConfigDependencyProcessor = (components: Partial<EcoComponent>[]) => Promise<ProcessedAsset[]>;
|
|
5
|
-
export interface
|
|
5
|
+
export interface MdxConfigDependencyServiceConfig {
|
|
6
6
|
integrationName: string;
|
|
7
|
-
pageModuleService: Pick<
|
|
8
|
-
assetProcessingService
|
|
7
|
+
pageModuleService: Pick<PageModuleService, 'ensureConfigFileMetadata'>;
|
|
8
|
+
assetProcessingService: Pick<AssetProcessingService, 'processDependencies'>;
|
|
9
|
+
assetProcessingIntegration?: AssetProcessingIntegration;
|
|
9
10
|
}
|
|
10
11
|
/**
|
|
11
12
|
* Resolves MDX-owned config dependencies that live outside the normal React component tree.
|
|
@@ -15,9 +16,9 @@ export interface ReactMdxConfigDependencyServiceConfig {
|
|
|
15
16
|
* component configs so the shared dependency pipeline can process them without
|
|
16
17
|
* growing more MDX-specific logic inside the renderer.
|
|
17
18
|
*/
|
|
18
|
-
export declare class
|
|
19
|
+
export declare class MdxConfigDependencyService {
|
|
19
20
|
private readonly config;
|
|
20
|
-
constructor(config:
|
|
21
|
+
constructor(config: MdxConfigDependencyServiceConfig);
|
|
21
22
|
/**
|
|
22
23
|
* Processes MDX-owned config dependencies and eagerly emits any SSR-marked lazy scripts.
|
|
23
24
|
*/
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import path from 'node:path';
|
|
2
|
+
import { getComponentIdentity, } from '@ecopages/core';
|
|
3
|
+
import { attachEcoFileMetadataToConfig } from '@ecopages/core/integration';
|
|
4
|
+
import { AssetFactory, } from '@ecopages/core/integration';
|
|
5
|
+
import { collectFromConfigForest, getComponentConfigs } from '../client-graph/component-config-traversal.js';
|
|
6
|
+
/**
|
|
7
|
+
* Resolves MDX-owned config dependencies that live outside the normal React component tree.
|
|
8
|
+
*
|
|
9
|
+
* React MDX pages can declare dependencies on the page config itself or on a
|
|
10
|
+
* resolved layout config. Those roots need to be materialized as synthetic
|
|
11
|
+
* component configs so the shared dependency pipeline can process them without
|
|
12
|
+
* growing more MDX-specific logic inside the renderer.
|
|
13
|
+
*/
|
|
14
|
+
export class MdxConfigDependencyService {
|
|
15
|
+
config;
|
|
16
|
+
constructor(config) {
|
|
17
|
+
this.config = config;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Processes MDX-owned config dependencies and eagerly emits any SSR-marked lazy scripts.
|
|
21
|
+
*/
|
|
22
|
+
async processMdxConfigDependencies(options) {
|
|
23
|
+
const components = this.createOwnedConfigComponents(options.pagePath, options.config);
|
|
24
|
+
if (components.length === 0) {
|
|
25
|
+
return [];
|
|
26
|
+
}
|
|
27
|
+
const processedDependencies = await options.processComponentDependencies(components);
|
|
28
|
+
const eagerSsrLazyDependencies = await this.processDeclaredSsrLazyDependencies(components);
|
|
29
|
+
return [...processedDependencies, ...eagerSsrLazyDependencies];
|
|
30
|
+
}
|
|
31
|
+
createOwnedConfigComponents(pagePath, config) {
|
|
32
|
+
const components = [];
|
|
33
|
+
for (const layout of config?.layouts ?? []) {
|
|
34
|
+
if (layout?.config?.dependencies) {
|
|
35
|
+
const layoutConfig = this.config.pageModuleService.ensureConfigFileMetadata(layout.config, pagePath);
|
|
36
|
+
components.push({ config: layoutConfig });
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
if (config?.dependencies) {
|
|
40
|
+
components.push({
|
|
41
|
+
config: attachEcoFileMetadataToConfig(config, pagePath, this.config.integrationName),
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
return components;
|
|
45
|
+
}
|
|
46
|
+
async processDeclaredSsrLazyDependencies(components) {
|
|
47
|
+
const dependencies = this.collectDeclaredSsrLazyDependencies(components);
|
|
48
|
+
if (dependencies.length === 0) {
|
|
49
|
+
return [];
|
|
50
|
+
}
|
|
51
|
+
return this.config.assetProcessingService.processDependencies(dependencies, this.config.assetProcessingIntegration);
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Collects `lazy` script dependencies that also opt into SSR from an MDX config graph.
|
|
55
|
+
*/
|
|
56
|
+
collectDeclaredSsrLazyDependencies(components) {
|
|
57
|
+
const dependencies = [];
|
|
58
|
+
const seenKeys = new Set();
|
|
59
|
+
const normalizeAttributes = (attributes) => ({
|
|
60
|
+
type: 'module',
|
|
61
|
+
defer: '',
|
|
62
|
+
...(attributes ?? {}),
|
|
63
|
+
});
|
|
64
|
+
collectFromConfigForest(getComponentConfigs(components), (config) => {
|
|
65
|
+
const componentFile = getComponentIdentity(config)?.file;
|
|
66
|
+
if (!componentFile) {
|
|
67
|
+
return [];
|
|
68
|
+
}
|
|
69
|
+
const componentDir = path.dirname(componentFile);
|
|
70
|
+
for (const script of config.dependencies?.scripts ?? []) {
|
|
71
|
+
if (typeof script === 'string' || !script.lazy || script.ssr !== true) {
|
|
72
|
+
continue;
|
|
73
|
+
}
|
|
74
|
+
const attributes = normalizeAttributes(script.attributes);
|
|
75
|
+
if (script.content) {
|
|
76
|
+
const key = `content:${script.content}:${JSON.stringify(attributes)}`;
|
|
77
|
+
if (seenKeys.has(key)) {
|
|
78
|
+
continue;
|
|
79
|
+
}
|
|
80
|
+
seenKeys.add(key);
|
|
81
|
+
dependencies.push(AssetFactory.createContentScript({
|
|
82
|
+
position: 'head',
|
|
83
|
+
content: script.content,
|
|
84
|
+
attributes,
|
|
85
|
+
}));
|
|
86
|
+
continue;
|
|
87
|
+
}
|
|
88
|
+
if (!script.src) {
|
|
89
|
+
continue;
|
|
90
|
+
}
|
|
91
|
+
const resolvedPath = path.resolve(componentDir, script.src);
|
|
92
|
+
const key = `file:${resolvedPath}:${JSON.stringify(attributes)}`;
|
|
93
|
+
if (seenKeys.has(key)) {
|
|
94
|
+
continue;
|
|
95
|
+
}
|
|
96
|
+
seenKeys.add(key);
|
|
97
|
+
dependencies.push(AssetFactory.createFileScript({
|
|
98
|
+
filepath: resolvedPath,
|
|
99
|
+
position: 'head',
|
|
100
|
+
attributes,
|
|
101
|
+
}));
|
|
102
|
+
}
|
|
103
|
+
return [];
|
|
104
|
+
});
|
|
105
|
+
return dependencies;
|
|
106
|
+
}
|
|
107
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { CompileOptions } from '@mdx-js/mdx';
|
|
2
|
+
import type { RequestPipelineMetricsState } from '@ecopages/core/build';
|
|
3
|
+
export interface CreateReactMdxLoaderPluginOptions {
|
|
4
|
+
compilerOptions?: CompileOptions;
|
|
5
|
+
projectRoot: string;
|
|
6
|
+
requestPipelineMetrics: RequestPipelineMetricsState;
|
|
7
|
+
}
|
|
8
|
+
export declare function createReactMdxLoaderPlugin(options: CreateReactMdxLoaderPluginOptions): import("@ecopages/core/integration").EcoBuildPlugin;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { createMdxLoaderPlugin as createMdxLoaderPluginCore } from '@ecopages/mdx/core';
|
|
2
|
+
export function createReactMdxLoaderPlugin(options) {
|
|
3
|
+
return createMdxLoaderPluginCore({
|
|
4
|
+
name: 'react-mdx-loader',
|
|
5
|
+
integrationName: 'react',
|
|
6
|
+
compilerOptions: options.compilerOptions,
|
|
7
|
+
defaultMdExtensions: [],
|
|
8
|
+
projectRoot: options.projectRoot,
|
|
9
|
+
requestPipelineMetrics: options.requestPipelineMetrics,
|
|
10
|
+
});
|
|
11
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Page module loading and configuration resolution service for React integration.
|
|
3
|
+
*
|
|
4
|
+
* Handles component identity resolution and module hydration analysis.
|
|
5
|
+
* MDX page modules load through the core {@link PageModuleImportService} path
|
|
6
|
+
* using the React plugin's server build contributions.
|
|
7
|
+
*
|
|
8
|
+
* @module
|
|
9
|
+
*/
|
|
10
|
+
import { type EcoComponentConfig, type EcoPageFile } from '@ecopages/core';
|
|
11
|
+
/**
|
|
12
|
+
* Configuration for the PageModuleService.
|
|
13
|
+
*/
|
|
14
|
+
export interface PageModuleServiceConfig {
|
|
15
|
+
layoutsDir?: string;
|
|
16
|
+
componentsDir?: string;
|
|
17
|
+
mdxExtensions: string[];
|
|
18
|
+
integrationName: string;
|
|
19
|
+
hasRouterAdapter: boolean;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Manages page module metadata resolution and hydration analysis for React pages.
|
|
23
|
+
*/
|
|
24
|
+
export declare class PageModuleService {
|
|
25
|
+
private readonly config;
|
|
26
|
+
constructor(config: PageModuleServiceConfig);
|
|
27
|
+
/**
|
|
28
|
+
* Checks if the given file path corresponds to an MDX file based on configured extensions.
|
|
29
|
+
*/
|
|
30
|
+
isMdxFile(filePath: string): boolean;
|
|
31
|
+
/**
|
|
32
|
+
* Ensures that an EcoComponentConfig has canonical identity attached.
|
|
33
|
+
*/
|
|
34
|
+
ensureConfigFileMetadata(config: EcoComponentConfig, pagePath: string): EcoComponentConfig;
|
|
35
|
+
hasModulesInConfig(config: EcoComponentConfig | undefined): boolean;
|
|
36
|
+
shouldHydratePage(pageModule: EcoPageFile<{
|
|
37
|
+
config?: EcoComponentConfig;
|
|
38
|
+
}> & {
|
|
39
|
+
config?: EcoComponentConfig;
|
|
40
|
+
}): boolean;
|
|
41
|
+
collectPageDeclaredModules(pageModule: EcoPageFile<{
|
|
42
|
+
config?: EcoComponentConfig;
|
|
43
|
+
}> & {
|
|
44
|
+
config?: EcoComponentConfig;
|
|
45
|
+
}): string[];
|
|
46
|
+
}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Page module loading and configuration resolution service for React integration.
|
|
3
|
+
*
|
|
4
|
+
* Handles component identity resolution and module hydration analysis.
|
|
5
|
+
* MDX page modules load through the core {@link PageModuleImportService} path
|
|
6
|
+
* using the React plugin's server build contributions.
|
|
7
|
+
*
|
|
8
|
+
* @module
|
|
9
|
+
*/
|
|
10
|
+
import path from 'node:path';
|
|
11
|
+
import { bindComponentIdentity, getComponentIdentity, getComponentOwner, } from '@ecopages/core';
|
|
12
|
+
import { contentHash } from '@ecopages/core/build';
|
|
13
|
+
import { fileSystem } from '@ecopages/file-system';
|
|
14
|
+
import { someInConfigTree } from '../client-graph/component-config-traversal.js';
|
|
15
|
+
import { collectPageDeclaredModulesFromModule } from '../client-graph/declared-modules.js';
|
|
16
|
+
/**
|
|
17
|
+
* Manages page module metadata resolution and hydration analysis for React pages.
|
|
18
|
+
*/
|
|
19
|
+
export class PageModuleService {
|
|
20
|
+
config;
|
|
21
|
+
constructor(config) {
|
|
22
|
+
this.config = config;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Checks if the given file path corresponds to an MDX file based on configured extensions.
|
|
26
|
+
*/
|
|
27
|
+
isMdxFile(filePath) {
|
|
28
|
+
return this.config.mdxExtensions.some((ext) => filePath.endsWith(ext));
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Ensures that an EcoComponentConfig has canonical identity attached.
|
|
32
|
+
*/
|
|
33
|
+
ensureConfigFileMetadata(config, pagePath) {
|
|
34
|
+
const identity = getComponentIdentity(config);
|
|
35
|
+
if (identity?.file) {
|
|
36
|
+
return config;
|
|
37
|
+
}
|
|
38
|
+
const buildIdentity = (file) => ({
|
|
39
|
+
id: identity?.id ?? BigInt(`0x${contentHash(file, 16)}`).toString(36),
|
|
40
|
+
integration: getComponentOwner(config, this.config.integrationName),
|
|
41
|
+
file,
|
|
42
|
+
});
|
|
43
|
+
const resolveDependencyValue = (value) => typeof value === 'string' ? value : value.src;
|
|
44
|
+
const dependencyPaths = [
|
|
45
|
+
...(config.dependencies?.stylesheets ?? []).map(resolveDependencyValue),
|
|
46
|
+
...(config.dependencies?.scripts ?? []).map(resolveDependencyValue),
|
|
47
|
+
]
|
|
48
|
+
.filter((value) => Boolean(value))
|
|
49
|
+
.filter((value) => value.startsWith('./') || value.startsWith('../'));
|
|
50
|
+
const candidateDirs = [this.config.layoutsDir, this.config.componentsDir, path.dirname(pagePath)].filter((value) => typeof value === 'string' && value.length > 0);
|
|
51
|
+
for (const dependencyPath of dependencyPaths) {
|
|
52
|
+
for (const candidateDir of candidateDirs) {
|
|
53
|
+
const resolvedDependency = path.resolve(candidateDir, dependencyPath);
|
|
54
|
+
if (fileSystem.exists(resolvedDependency)) {
|
|
55
|
+
return bindComponentIdentity(buildIdentity(path.join(candidateDir, path.basename(pagePath))), config);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
return bindComponentIdentity(buildIdentity(pagePath), config);
|
|
60
|
+
}
|
|
61
|
+
hasModulesInConfig(config) {
|
|
62
|
+
return someInConfigTree(config, (node) => node.dependencies?.modules?.some((entry) => entry.trim().length > 0) ?? false);
|
|
63
|
+
}
|
|
64
|
+
shouldHydratePage(pageModule) {
|
|
65
|
+
if (this.config.hasRouterAdapter) {
|
|
66
|
+
return true;
|
|
67
|
+
}
|
|
68
|
+
const pageConfig = pageModule.default?.config;
|
|
69
|
+
return this.hasModulesInConfig(pageConfig) || this.hasModulesInConfig(pageModule.config);
|
|
70
|
+
}
|
|
71
|
+
collectPageDeclaredModules(pageModule) {
|
|
72
|
+
return collectPageDeclaredModulesFromModule(pageModule);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export const REACT_PLUGIN_NAME = 'react';
|
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
import { IntegrationPlugin, type EcoBuildPlugin } from '@ecopages/core/
|
|
2
|
-
import type { BrowserRuntimeManifest } from '@ecopages/core/build/browser-runtime-manifest';
|
|
3
|
-
import type { HmrStrategy } from '@ecopages/core/hmr/hmr-strategy';
|
|
1
|
+
import { IntegrationPlugin, type IntegrationRendererBase, type IntegrationRuntimeContext, type EcoBuildPlugin } from '@ecopages/core/integration';
|
|
4
2
|
import type React from 'react';
|
|
5
|
-
import { ReactRenderer } from '
|
|
3
|
+
import { ReactRenderer } from '../render/react-renderer.js';
|
|
6
4
|
import type { ReactPluginOptions } from './react.types.js';
|
|
7
5
|
export type { ReactMdxOptions, ReactPluginOptions, ReactRendererConfig } from './react.types.js';
|
|
8
6
|
/**
|
|
@@ -15,19 +13,21 @@ export declare const PLUGIN_NAME = "react";
|
|
|
15
13
|
*/
|
|
16
14
|
export declare class ReactPlugin extends IntegrationPlugin<React.ReactNode> {
|
|
17
15
|
renderer: typeof ReactRenderer;
|
|
16
|
+
readonly bundlesPageDependencies = true;
|
|
18
17
|
private readonly routerAdapter;
|
|
19
|
-
private readonly mdxEnabled;
|
|
20
|
-
private readonly mdxCompilerOptions?;
|
|
21
18
|
private readonly mdxExtensions;
|
|
22
|
-
private
|
|
19
|
+
private readonly mdxCompilerOptions;
|
|
20
|
+
private readonly getMdxLoaderPlugin?;
|
|
23
21
|
private readonly runtimeBundleService;
|
|
24
22
|
private readonly hmrPageMetadataCache;
|
|
25
|
-
private readonly clientGraphBoundaryCache;
|
|
26
23
|
private runtimeDependenciesInitialized;
|
|
27
24
|
/**
|
|
28
|
-
*
|
|
25
|
+
* When true, always emit page browser graph / hydration assets.
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
* Mapped from public `explicitGraph`. Does not skip client-graph AST stripping.
|
|
29
29
|
*/
|
|
30
|
-
private readonly
|
|
30
|
+
private readonly forceBrowserGraph;
|
|
31
31
|
private readonly rendererConfig;
|
|
32
32
|
constructor(options?: ReactPluginOptions);
|
|
33
33
|
/**
|
|
@@ -37,27 +37,21 @@ export declare class ReactPlugin extends IntegrationPlugin<React.ReactNode> {
|
|
|
37
37
|
* Keeping that state on the instance avoids cross-plugin static mutation while
|
|
38
38
|
* preserving the same runtime services the base initializer wires up.
|
|
39
39
|
*/
|
|
40
|
-
|
|
41
|
-
rendererModules?: unknown;
|
|
42
|
-
}): ReactRenderer;
|
|
40
|
+
createRenderer(base: IntegrationRendererBase): ReactRenderer;
|
|
43
41
|
private ensureRuntimeDependencies;
|
|
44
|
-
get plugins(): EcoBuildPlugin[];
|
|
45
|
-
get browserRuntimeManifest(): BrowserRuntimeManifest;
|
|
46
|
-
/**
|
|
47
|
-
* Ensures the optional React MDX loader exists before either config-time
|
|
48
|
-
* manifest sealing or runtime setup needs it.
|
|
49
|
-
*/
|
|
50
|
-
private ensureMdxLoaderPlugin;
|
|
51
42
|
/**
|
|
52
|
-
*
|
|
53
|
-
*
|
|
43
|
+
* Returns the MDX loader when MDX is enabled.
|
|
44
|
+
*
|
|
45
|
+
* @remarks
|
|
46
|
+
* The loader is created on the first read for an app runtime and kept, because the renderer and the HMR
|
|
47
|
+
* strategy reuse the instance the build manifest holds.
|
|
54
48
|
*/
|
|
55
|
-
|
|
49
|
+
plugins(app: IntegrationRuntimeContext['appConfig']): EcoBuildPlugin[];
|
|
50
|
+
private resolveMdxLoaderPlugin;
|
|
56
51
|
/**
|
|
57
|
-
*
|
|
58
|
-
* materialized.
|
|
52
|
+
* Adds the React runtime vendor assets to the global dependencies, then processes them.
|
|
59
53
|
*/
|
|
60
|
-
setup(): Promise<void>;
|
|
54
|
+
setup(context: IntegrationRuntimeContext): Promise<void>;
|
|
61
55
|
/**
|
|
62
56
|
* Provides React-specific HMR strategy with Fast Refresh support.
|
|
63
57
|
*
|
|
@@ -67,7 +61,7 @@ export declare class ReactPlugin extends IntegrationPlugin<React.ReactNode> {
|
|
|
67
61
|
*
|
|
68
62
|
* @returns ReactHmrStrategy instance for handling React component updates
|
|
69
63
|
*/
|
|
70
|
-
|
|
64
|
+
hmr(context: IntegrationRuntimeContext): void;
|
|
71
65
|
}
|
|
72
66
|
/**
|
|
73
67
|
* Factory function to create a React plugin instance
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This module contains the react plugin for Ecopages
|
|
3
|
+
* @module
|
|
4
|
+
*/
|
|
5
|
+
import { requireAppRuntime } from '@ecopages/core/integration';
|
|
6
|
+
import { IntegrationPlugin, } from '@ecopages/core/integration';
|
|
7
|
+
import { Logger } from '@ecopages/logger';
|
|
8
|
+
import path from 'node:path';
|
|
9
|
+
import { REACT_PLUGIN_NAME } from './react.constants.js';
|
|
10
|
+
import { ReactRenderer } from '../render/react-renderer.js';
|
|
11
|
+
import { ReactHmrStrategy } from '../hmr/hmr-strategy.js';
|
|
12
|
+
import { ReactDevTransformContributor } from '../dev-transform/react-dev-transform-contributor.js';
|
|
13
|
+
import { RuntimeBundleService } from '../bundling/runtime-bundle.js';
|
|
14
|
+
import { HmrPageMetadataCache } from '../hmr/page-metadata-cache.js';
|
|
15
|
+
import { createReactMdxLoaderPlugin } from '../mdx/mdx-loader-plugin.js';
|
|
16
|
+
import { appendMdxExtensions, resolveMdxCompilerOptions } from '@ecopages/mdx/core';
|
|
17
|
+
import { resolveReactPluginRuntimeModules } from '../bundling/runtime-modules.js';
|
|
18
|
+
const appLogger = new Logger('[ReactPlugin]');
|
|
19
|
+
/**
|
|
20
|
+
* The name of the React plugin
|
|
21
|
+
*/
|
|
22
|
+
export const PLUGIN_NAME = REACT_PLUGIN_NAME;
|
|
23
|
+
const resolveReactMdxCompilerOptions = (mdxOptions) => resolveMdxCompilerOptions(mdxOptions, { jsxImportSource: 'react' });
|
|
24
|
+
/**
|
|
25
|
+
* Resolves user-facing React plugin options into the internal plugin config.
|
|
26
|
+
*
|
|
27
|
+
* Defaults:
|
|
28
|
+
* - `extensions`: `['.tsx']`
|
|
29
|
+
* - `explicitGraph`: `false`
|
|
30
|
+
* - MDX is disabled when `mdx` is omitted
|
|
31
|
+
* - `mdx.extensions`: `['.mdx']`
|
|
32
|
+
*/
|
|
33
|
+
const resolveReactPluginOptions = (options) => {
|
|
34
|
+
const { extensions: userExtensions, router, mdx, explicitGraph, dependencies, runtimeModules, ...baseConfig } = options ?? {};
|
|
35
|
+
const extensions = [...(userExtensions ?? ['.tsx'])];
|
|
36
|
+
const mdxEnabled = mdx !== undefined;
|
|
37
|
+
const mdxExtensions = mdx?.extensions ?? ['.mdx'];
|
|
38
|
+
const resolvedRuntimeModules = resolveReactPluginRuntimeModules(runtimeModules);
|
|
39
|
+
if (mdxEnabled) {
|
|
40
|
+
appendMdxExtensions(extensions, mdxExtensions);
|
|
41
|
+
}
|
|
42
|
+
const rendererConfig = {
|
|
43
|
+
routerAdapter: router,
|
|
44
|
+
runtimeModules: resolvedRuntimeModules,
|
|
45
|
+
mdxExtensions,
|
|
46
|
+
hmrPageMetadataCache: new HmrPageMetadataCache(),
|
|
47
|
+
forceBrowserGraph: explicitGraph ?? false,
|
|
48
|
+
};
|
|
49
|
+
return {
|
|
50
|
+
...baseConfig,
|
|
51
|
+
extensions,
|
|
52
|
+
integrationDependencies: dependencies,
|
|
53
|
+
mdxCompilerOptions: mdxEnabled && mdx ? resolveReactMdxCompilerOptions(mdx) : undefined,
|
|
54
|
+
rendererConfig,
|
|
55
|
+
};
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* The React plugin class
|
|
59
|
+
* This plugin provides support for React components in Ecopages
|
|
60
|
+
*/
|
|
61
|
+
export class ReactPlugin extends IntegrationPlugin {
|
|
62
|
+
renderer = ReactRenderer;
|
|
63
|
+
bundlesPageDependencies = true;
|
|
64
|
+
routerAdapter;
|
|
65
|
+
mdxExtensions;
|
|
66
|
+
mdxCompilerOptions;
|
|
67
|
+
getMdxLoaderPlugin;
|
|
68
|
+
runtimeBundleService;
|
|
69
|
+
hmrPageMetadataCache;
|
|
70
|
+
runtimeDependenciesInitialized = false;
|
|
71
|
+
/**
|
|
72
|
+
* When true, always emit page browser graph / hydration assets.
|
|
73
|
+
*
|
|
74
|
+
* @remarks
|
|
75
|
+
* Mapped from public `explicitGraph`. Does not skip client-graph AST stripping.
|
|
76
|
+
*/
|
|
77
|
+
forceBrowserGraph;
|
|
78
|
+
rendererConfig;
|
|
79
|
+
constructor(options) {
|
|
80
|
+
const config = resolveReactPluginOptions(options);
|
|
81
|
+
const { extensions, rendererConfig, integrationDependencies, mdxCompilerOptions, ...baseConfig } = config;
|
|
82
|
+
const runtimeBundleService = new RuntimeBundleService({
|
|
83
|
+
routerAdapter: rendererConfig.routerAdapter,
|
|
84
|
+
runtimeModules: rendererConfig.runtimeModules,
|
|
85
|
+
});
|
|
86
|
+
super({
|
|
87
|
+
name: PLUGIN_NAME,
|
|
88
|
+
extensions,
|
|
89
|
+
jsxImportSource: 'react',
|
|
90
|
+
integrationDependencies,
|
|
91
|
+
browserRuntimeManifest: runtimeBundleService.getRuntimeManifest(),
|
|
92
|
+
...baseConfig,
|
|
93
|
+
});
|
|
94
|
+
this.routerAdapter = rendererConfig.routerAdapter;
|
|
95
|
+
this.mdxCompilerOptions = mdxCompilerOptions;
|
|
96
|
+
this.getMdxLoaderPlugin = mdxCompilerOptions
|
|
97
|
+
? () => {
|
|
98
|
+
if (!this.appConfig?.rootDir) {
|
|
99
|
+
throw new Error('[ReactPlugin] Cannot create MDX loader: appConfig.rootDir is required.');
|
|
100
|
+
}
|
|
101
|
+
const plugin = this.runtime?.buildManifest.server.find((item) => item.name === 'react-mdx-loader');
|
|
102
|
+
if (!plugin) {
|
|
103
|
+
throw new Error('[ReactPlugin] The app build manifest does not contain the React MDX loader.');
|
|
104
|
+
}
|
|
105
|
+
return plugin;
|
|
106
|
+
}
|
|
107
|
+
: undefined;
|
|
108
|
+
this.mdxExtensions = rendererConfig.mdxExtensions ?? ['.mdx'];
|
|
109
|
+
this.hmrPageMetadataCache = rendererConfig.hmrPageMetadataCache ?? new HmrPageMetadataCache();
|
|
110
|
+
this.forceBrowserGraph = rendererConfig.forceBrowserGraph ?? false;
|
|
111
|
+
this.rendererConfig = {
|
|
112
|
+
...rendererConfig,
|
|
113
|
+
getMdxLoaderPlugin: this.getMdxLoaderPlugin,
|
|
114
|
+
mdxExtensions: this.mdxExtensions,
|
|
115
|
+
hmrPageMetadataCache: this.hmrPageMetadataCache,
|
|
116
|
+
forceBrowserGraph: this.forceBrowserGraph,
|
|
117
|
+
};
|
|
118
|
+
if (mdxCompilerOptions) {
|
|
119
|
+
appLogger.debug('MDX mode enabled with React jsx runtime');
|
|
120
|
+
}
|
|
121
|
+
this.runtimeBundleService = runtimeBundleService;
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* Creates a React renderer with instance-owned runtime configuration.
|
|
125
|
+
*
|
|
126
|
+
* React renderers depend on plugin-owned router, MDX, and HMR metadata state.
|
|
127
|
+
* Keeping that state on the instance avoids cross-plugin static mutation while
|
|
128
|
+
* preserving the same runtime services the base initializer wires up.
|
|
129
|
+
*/
|
|
130
|
+
createRenderer(base) {
|
|
131
|
+
const renderer = new this.renderer({
|
|
132
|
+
...base,
|
|
133
|
+
reactConfig: this.rendererConfig,
|
|
134
|
+
});
|
|
135
|
+
renderer.name ||= this.name;
|
|
136
|
+
return renderer;
|
|
137
|
+
}
|
|
138
|
+
ensureRuntimeDependencies(appConfig) {
|
|
139
|
+
if (this.runtimeDependenciesInitialized) {
|
|
140
|
+
return;
|
|
141
|
+
}
|
|
142
|
+
this.runtimeBundleService.setRootDir(appConfig.rootDir);
|
|
143
|
+
this.runtimeBundleService.setWorkDir(appConfig.absolutePaths.workDir ?? path.join(appConfig.rootDir, appConfig.workDir ?? '.eco'));
|
|
144
|
+
this.runtimeBundleService.setRuntimeModules(this.rendererConfig.runtimeModules ?? []);
|
|
145
|
+
this.integrationDependencies.unshift(...this.runtimeBundleService.getDependencies());
|
|
146
|
+
this.runtimeDependenciesInitialized = true;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Returns the MDX loader when MDX is enabled.
|
|
150
|
+
*
|
|
151
|
+
* @remarks
|
|
152
|
+
* The loader is created on the first read for an app runtime and kept, because the renderer and the HMR
|
|
153
|
+
* strategy reuse the instance the build manifest holds.
|
|
154
|
+
*/
|
|
155
|
+
plugins(app) {
|
|
156
|
+
const loader = this.mdxCompilerOptions ? this.resolveMdxLoaderPlugin(this.mdxCompilerOptions, app) : undefined;
|
|
157
|
+
return loader ? [loader] : [];
|
|
158
|
+
}
|
|
159
|
+
resolveMdxLoaderPlugin(compilerOptions, appConfig) {
|
|
160
|
+
const requestPipelineMetrics = requireAppRuntime(appConfig).requestPipelineMetrics;
|
|
161
|
+
return createReactMdxLoaderPlugin({
|
|
162
|
+
compilerOptions,
|
|
163
|
+
projectRoot: appConfig.rootDir,
|
|
164
|
+
requestPipelineMetrics,
|
|
165
|
+
});
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* Adds the React runtime vendor assets to the global dependencies, then processes them.
|
|
169
|
+
*/
|
|
170
|
+
async setup(context) {
|
|
171
|
+
this.ensureRuntimeDependencies(context.appConfig);
|
|
172
|
+
await super.setup(context);
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Provides React-specific HMR strategy with Fast Refresh support.
|
|
176
|
+
*
|
|
177
|
+
* The strategy shares a React-only page metadata cache with the renderer so
|
|
178
|
+
* save-time rebuilds can reuse declared-module analysis without expanding the
|
|
179
|
+
* core HMR interfaces.
|
|
180
|
+
*
|
|
181
|
+
* @returns ReactHmrStrategy instance for handling React component updates
|
|
182
|
+
*/
|
|
183
|
+
hmr(context) {
|
|
184
|
+
super.hmr(context);
|
|
185
|
+
const manager = context.runtime.hmr;
|
|
186
|
+
if (!manager)
|
|
187
|
+
return;
|
|
188
|
+
const strategy = new ReactHmrStrategy({
|
|
189
|
+
context: manager.getDefaultContext(),
|
|
190
|
+
projectRoot: context.appConfig.rootDir,
|
|
191
|
+
pageMetadataCache: this.hmrPageMetadataCache,
|
|
192
|
+
runtimeManifest: this.runtimeBundleService.getRuntimeManifest('development'),
|
|
193
|
+
getMdxLoaderPlugin: this.getMdxLoaderPlugin,
|
|
194
|
+
ownedTemplateExtensions: this.extensions,
|
|
195
|
+
allTemplateExtensions: context.appConfig.templatesExt,
|
|
196
|
+
});
|
|
197
|
+
manager.registerStrategy(strategy);
|
|
198
|
+
manager.registerDevTransformContributor(new ReactDevTransformContributor({
|
|
199
|
+
strategy: strategy,
|
|
200
|
+
}));
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Factory function to create a React plugin instance
|
|
205
|
+
* @param options Configuration options for the React plugin
|
|
206
|
+
* @returns A new ReactPlugin instance
|
|
207
|
+
*/
|
|
208
|
+
export function reactPlugin(options) {
|
|
209
|
+
return new ReactPlugin(options);
|
|
210
|
+
}
|