@ecopages/core 0.2.0-alpha.1
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/CHANGELOG.md +89 -0
- package/LICENSE +21 -0
- package/README.md +32 -0
- package/package.json +279 -0
- package/src/adapters/abstract/application-adapter.d.ts +168 -0
- package/src/adapters/abstract/application-adapter.js +109 -0
- package/src/adapters/abstract/application-adapter.ts +337 -0
- package/src/adapters/abstract/router-adapter.d.ts +26 -0
- package/src/adapters/abstract/router-adapter.js +5 -0
- package/src/adapters/abstract/router-adapter.ts +30 -0
- package/src/adapters/abstract/server-adapter.d.ts +69 -0
- package/src/adapters/abstract/server-adapter.js +15 -0
- package/src/adapters/abstract/server-adapter.ts +79 -0
- package/src/adapters/bun/client-bridge.d.ts +34 -0
- package/src/adapters/bun/client-bridge.js +48 -0
- package/src/adapters/bun/client-bridge.ts +62 -0
- package/src/adapters/bun/create-app.d.ts +60 -0
- package/src/adapters/bun/create-app.js +117 -0
- package/src/adapters/bun/create-app.ts +189 -0
- package/src/adapters/bun/define-api-handler.d.ts +61 -0
- package/src/adapters/bun/define-api-handler.js +15 -0
- package/src/adapters/bun/define-api-handler.ts +114 -0
- package/src/adapters/bun/hmr-manager.d.ts +84 -0
- package/src/adapters/bun/hmr-manager.js +227 -0
- package/src/adapters/bun/hmr-manager.ts +281 -0
- package/src/adapters/bun/index.d.ts +3 -0
- package/src/adapters/bun/index.js +8 -0
- package/src/adapters/bun/index.ts +3 -0
- package/src/adapters/bun/server-adapter.d.ts +155 -0
- package/src/adapters/bun/server-adapter.js +368 -0
- package/src/adapters/bun/server-adapter.ts +492 -0
- package/src/adapters/bun/server-lifecycle.d.ts +52 -0
- package/src/adapters/bun/server-lifecycle.js +120 -0
- package/src/adapters/bun/server-lifecycle.ts +154 -0
- package/src/adapters/index.d.ts +6 -0
- package/src/adapters/index.js +14 -0
- package/src/adapters/index.ts +6 -0
- package/src/adapters/node/create-app.d.ts +21 -0
- package/src/adapters/node/create-app.js +143 -0
- package/src/adapters/node/create-app.ts +179 -0
- package/src/adapters/node/index.d.ts +4 -0
- package/src/adapters/node/index.js +8 -0
- package/src/adapters/node/index.ts +9 -0
- package/src/adapters/node/node-client-bridge.d.ts +26 -0
- package/src/adapters/node/node-client-bridge.js +66 -0
- package/src/adapters/node/node-client-bridge.ts +79 -0
- package/src/adapters/node/node-hmr-manager.d.ts +62 -0
- package/src/adapters/node/node-hmr-manager.js +221 -0
- package/src/adapters/node/node-hmr-manager.ts +271 -0
- package/src/adapters/node/server-adapter.d.ts +190 -0
- package/src/adapters/node/server-adapter.js +420 -0
- package/src/adapters/node/server-adapter.ts +561 -0
- package/src/adapters/node/static-content-server.d.ts +24 -0
- package/src/adapters/node/static-content-server.js +166 -0
- package/src/adapters/node/static-content-server.ts +203 -0
- package/src/adapters/shared/api-response.d.ts +52 -0
- package/src/adapters/shared/api-response.js +96 -0
- package/src/adapters/shared/api-response.ts +104 -0
- package/src/adapters/shared/application-adapter.d.ts +18 -0
- package/src/adapters/shared/application-adapter.js +90 -0
- package/src/adapters/shared/application-adapter.ts +199 -0
- package/src/adapters/shared/explicit-static-route-matcher.d.ts +38 -0
- package/src/adapters/shared/explicit-static-route-matcher.js +100 -0
- package/src/adapters/shared/explicit-static-route-matcher.ts +134 -0
- package/src/adapters/shared/file-route-middleware-pipeline.d.ts +65 -0
- package/src/adapters/shared/file-route-middleware-pipeline.js +98 -0
- package/src/adapters/shared/file-route-middleware-pipeline.ts +123 -0
- package/src/adapters/shared/fs-server-response-factory.d.ts +19 -0
- package/src/adapters/shared/fs-server-response-factory.js +97 -0
- package/src/adapters/shared/fs-server-response-factory.ts +118 -0
- package/src/adapters/shared/fs-server-response-matcher.d.ts +71 -0
- package/src/adapters/shared/fs-server-response-matcher.js +155 -0
- package/src/adapters/shared/fs-server-response-matcher.ts +198 -0
- package/src/adapters/shared/render-context.d.ts +14 -0
- package/src/adapters/shared/render-context.js +69 -0
- package/src/adapters/shared/render-context.ts +105 -0
- package/src/adapters/shared/server-adapter.d.ts +87 -0
- package/src/adapters/shared/server-adapter.js +353 -0
- package/src/adapters/shared/server-adapter.ts +442 -0
- package/src/adapters/shared/server-route-handler.d.ts +89 -0
- package/src/adapters/shared/server-route-handler.js +120 -0
- package/src/adapters/shared/server-route-handler.ts +166 -0
- package/src/adapters/shared/server-static-builder.d.ts +38 -0
- package/src/adapters/shared/server-static-builder.js +46 -0
- package/src/adapters/shared/server-static-builder.ts +82 -0
- package/src/build/build-adapter.d.ts +74 -0
- package/src/build/build-adapter.js +54 -0
- package/src/build/build-adapter.ts +132 -0
- package/src/build/build-types.d.ts +57 -0
- package/src/build/build-types.js +0 -0
- package/src/build/build-types.ts +83 -0
- package/src/build/esbuild-build-adapter.d.ts +69 -0
- package/src/build/esbuild-build-adapter.js +390 -0
- package/src/build/esbuild-build-adapter.ts +510 -0
- package/src/config/config-builder.d.ts +227 -0
- package/src/config/config-builder.js +392 -0
- package/src/config/config-builder.ts +474 -0
- package/src/constants.d.ts +32 -0
- package/src/constants.js +21 -0
- package/src/constants.ts +39 -0
- package/src/create-app.d.ts +17 -0
- package/src/create-app.js +66 -0
- package/src/create-app.ts +87 -0
- package/src/declarations.d.ts +26 -0
- package/src/define-api-handler.d.ts +25 -0
- package/src/define-api-handler.js +15 -0
- package/src/define-api-handler.ts +66 -0
- package/src/dev/sc-server.d.ts +30 -0
- package/src/dev/sc-server.js +111 -0
- package/src/dev/sc-server.ts +143 -0
- package/src/eco/README.md +636 -0
- package/src/eco/component-render-context.d.ts +105 -0
- package/src/eco/component-render-context.js +77 -0
- package/src/eco/component-render-context.ts +202 -0
- package/src/eco/eco.d.ts +9 -0
- package/src/eco/eco.js +110 -0
- package/src/eco/eco.ts +221 -0
- package/src/eco/eco.types.d.ts +170 -0
- package/src/eco/eco.types.js +0 -0
- package/src/eco/eco.types.ts +202 -0
- package/src/eco/eco.utils.d.ts +40 -0
- package/src/eco/eco.utils.js +40 -0
- package/src/eco/eco.utils.ts +89 -0
- package/src/eco/global-injector-map.d.ts +16 -0
- package/src/eco/global-injector-map.js +80 -0
- package/src/eco/global-injector-map.ts +112 -0
- package/src/eco/lazy-injector-map.d.ts +8 -0
- package/src/eco/lazy-injector-map.js +70 -0
- package/src/eco/lazy-injector-map.ts +120 -0
- package/src/eco/module-dependencies.d.ts +18 -0
- package/src/eco/module-dependencies.js +49 -0
- package/src/eco/module-dependencies.ts +75 -0
- package/src/env.d.ts +20 -0
- package/src/errors/http-error.d.ts +31 -0
- package/src/errors/http-error.js +50 -0
- package/src/errors/http-error.ts +72 -0
- package/src/errors/index.d.ts +2 -0
- package/src/errors/index.js +4 -0
- package/src/errors/index.ts +2 -0
- package/src/errors/locals-access-error.d.ts +4 -0
- package/src/errors/locals-access-error.js +9 -0
- package/src/errors/locals-access-error.ts +7 -0
- package/src/global/app-logger.d.ts +2 -0
- package/src/global/app-logger.js +6 -0
- package/src/global/app-logger.ts +4 -0
- package/src/hmr/client/__screenshots__/hmr-runtime.test.browser.ts/HMR-Runtime-HMR-Server-Integration-should-have-HMR-script-injected-in-page-1.png +0 -0
- package/src/hmr/client/__screenshots__/hmr-runtime.test.browser.ts/HMR-Runtime-HMR-Server-Integration-should-load-fixture-app-page-1.png +0 -0
- package/src/hmr/client/__screenshots__/hmr-runtime.test.browser.ts/HMR-Runtime-WebSocket-Connection-should-connect-to-correct-HMR-endpoint-1.png +0 -0
- package/src/hmr/client/hmr-runtime.d.ts +10 -0
- package/src/hmr/client/hmr-runtime.js +86 -0
- package/src/hmr/client/hmr-runtime.ts +121 -0
- package/src/hmr/hmr-strategy.d.ts +159 -0
- package/src/hmr/hmr-strategy.js +29 -0
- package/src/hmr/hmr-strategy.ts +172 -0
- package/src/hmr/hmr.test.e2e.d.ts +1 -0
- package/src/hmr/hmr.test.e2e.js +50 -0
- package/src/hmr/hmr.test.e2e.ts +75 -0
- package/src/hmr/strategies/default-hmr-strategy.d.ts +43 -0
- package/src/hmr/strategies/default-hmr-strategy.js +34 -0
- package/src/hmr/strategies/default-hmr-strategy.ts +60 -0
- package/src/hmr/strategies/js-hmr-strategy.d.ts +136 -0
- package/src/hmr/strategies/js-hmr-strategy.js +179 -0
- package/src/hmr/strategies/js-hmr-strategy.ts +308 -0
- package/src/index.browser.d.ts +3 -0
- package/src/index.browser.js +4 -0
- package/src/index.browser.ts +3 -0
- package/src/index.d.ts +5 -0
- package/src/index.js +10 -0
- package/src/index.ts +5 -0
- package/src/integrations/ghtml/ghtml-renderer.d.ts +15 -0
- package/src/integrations/ghtml/ghtml-renderer.js +60 -0
- package/src/integrations/ghtml/ghtml-renderer.ts +93 -0
- package/src/integrations/ghtml/ghtml.plugin.d.ts +20 -0
- package/src/integrations/ghtml/ghtml.plugin.js +21 -0
- package/src/integrations/ghtml/ghtml.plugin.ts +32 -0
- package/src/internal-types.d.ts +200 -0
- package/src/internal-types.js +0 -0
- package/src/internal-types.ts +212 -0
- package/src/plugins/alias-resolver-plugin.d.ts +2 -0
- package/src/plugins/alias-resolver-plugin.js +39 -0
- package/src/plugins/alias-resolver-plugin.ts +45 -0
- package/src/plugins/eco-component-meta-plugin.d.ts +95 -0
- package/src/plugins/eco-component-meta-plugin.js +157 -0
- package/src/plugins/eco-component-meta-plugin.ts +474 -0
- package/src/plugins/integration-plugin.d.ts +102 -0
- package/src/plugins/integration-plugin.js +100 -0
- package/src/plugins/integration-plugin.ts +184 -0
- package/src/plugins/processor.d.ts +82 -0
- package/src/plugins/processor.js +122 -0
- package/src/plugins/processor.ts +220 -0
- package/src/public-types.d.ts +1094 -0
- package/src/public-types.js +0 -0
- package/src/public-types.ts +1255 -0
- package/src/route-renderer/GRAPH.md +387 -0
- package/src/route-renderer/README.md +135 -0
- package/src/route-renderer/component-graph-executor.d.ts +32 -0
- package/src/route-renderer/component-graph-executor.js +31 -0
- package/src/route-renderer/component-graph-executor.ts +84 -0
- package/src/route-renderer/component-graph.d.ts +42 -0
- package/src/route-renderer/component-graph.js +72 -0
- package/src/route-renderer/component-graph.ts +159 -0
- package/src/route-renderer/component-marker.d.ts +52 -0
- package/src/route-renderer/component-marker.js +46 -0
- package/src/route-renderer/component-marker.ts +117 -0
- package/src/route-renderer/dependency-resolver.d.ts +24 -0
- package/src/route-renderer/dependency-resolver.js +428 -0
- package/src/route-renderer/dependency-resolver.ts +596 -0
- package/src/route-renderer/html-post-processing.service.d.ts +40 -0
- package/src/route-renderer/html-post-processing.service.js +86 -0
- package/src/route-renderer/html-post-processing.service.ts +103 -0
- package/src/route-renderer/integration-renderer.d.ts +339 -0
- package/src/route-renderer/integration-renderer.js +526 -0
- package/src/route-renderer/integration-renderer.ts +696 -0
- package/src/route-renderer/marker-graph-resolver.d.ts +76 -0
- package/src/route-renderer/marker-graph-resolver.js +93 -0
- package/src/route-renderer/marker-graph-resolver.ts +153 -0
- package/src/route-renderer/page-module-loader.d.ts +61 -0
- package/src/route-renderer/page-module-loader.js +102 -0
- package/src/route-renderer/page-module-loader.ts +153 -0
- package/src/route-renderer/render-execution.service.d.ts +69 -0
- package/src/route-renderer/render-execution.service.js +91 -0
- package/src/route-renderer/render-execution.service.ts +158 -0
- package/src/route-renderer/render-preparation.service.d.ts +112 -0
- package/src/route-renderer/render-preparation.service.js +243 -0
- package/src/route-renderer/render-preparation.service.ts +358 -0
- package/src/route-renderer/route-renderer.d.ts +26 -0
- package/src/route-renderer/route-renderer.js +68 -0
- package/src/route-renderer/route-renderer.ts +80 -0
- package/src/router/fs-router-scanner.d.ts +41 -0
- package/src/router/fs-router-scanner.js +155 -0
- package/src/router/fs-router-scanner.ts +217 -0
- package/src/router/fs-router.d.ts +26 -0
- package/src/router/fs-router.js +100 -0
- package/src/router/fs-router.ts +122 -0
- package/src/services/asset-processing-service/asset-processing.service.d.ts +41 -0
- package/src/services/asset-processing-service/asset-processing.service.js +250 -0
- package/src/services/asset-processing-service/asset-processing.service.ts +306 -0
- package/src/services/asset-processing-service/asset.factory.d.ts +17 -0
- package/src/services/asset-processing-service/asset.factory.js +82 -0
- package/src/services/asset-processing-service/asset.factory.ts +105 -0
- package/src/services/asset-processing-service/assets.types.d.ts +88 -0
- package/src/services/asset-processing-service/assets.types.js +0 -0
- package/src/services/asset-processing-service/assets.types.ts +112 -0
- package/src/services/asset-processing-service/index.d.ts +3 -0
- package/src/services/asset-processing-service/index.js +3 -0
- package/src/services/asset-processing-service/index.ts +3 -0
- package/src/services/asset-processing-service/processor.interface.d.ts +22 -0
- package/src/services/asset-processing-service/processor.interface.js +6 -0
- package/src/services/asset-processing-service/processor.interface.ts +27 -0
- package/src/services/asset-processing-service/processor.registry.d.ts +8 -0
- package/src/services/asset-processing-service/processor.registry.js +15 -0
- package/src/services/asset-processing-service/processor.registry.ts +18 -0
- package/src/services/asset-processing-service/processors/base/base-processor.d.ts +24 -0
- package/src/services/asset-processing-service/processors/base/base-processor.js +59 -0
- package/src/services/asset-processing-service/processors/base/base-processor.ts +76 -0
- package/src/services/asset-processing-service/processors/base/base-script-processor.d.ts +16 -0
- package/src/services/asset-processing-service/processors/base/base-script-processor.js +80 -0
- package/src/services/asset-processing-service/processors/base/base-script-processor.ts +105 -0
- package/src/services/asset-processing-service/processors/index.d.ts +5 -0
- package/src/services/asset-processing-service/processors/index.js +5 -0
- package/src/services/asset-processing-service/processors/index.ts +5 -0
- package/src/services/asset-processing-service/processors/script/content-script.processor.d.ts +5 -0
- package/src/services/asset-processing-service/processors/script/content-script.processor.js +57 -0
- package/src/services/asset-processing-service/processors/script/content-script.processor.ts +66 -0
- package/src/services/asset-processing-service/processors/script/file-script.processor.d.ts +8 -0
- package/src/services/asset-processing-service/processors/script/file-script.processor.js +76 -0
- package/src/services/asset-processing-service/processors/script/file-script.processor.ts +88 -0
- package/src/services/asset-processing-service/processors/script/node-module-script.processor.d.ts +7 -0
- package/src/services/asset-processing-service/processors/script/node-module-script.processor.js +74 -0
- package/src/services/asset-processing-service/processors/script/node-module-script.processor.ts +84 -0
- package/src/services/asset-processing-service/processors/stylesheet/content-stylesheet.processor.d.ts +5 -0
- package/src/services/asset-processing-service/processors/stylesheet/content-stylesheet.processor.js +25 -0
- package/src/services/asset-processing-service/processors/stylesheet/content-stylesheet.processor.ts +27 -0
- package/src/services/asset-processing-service/processors/stylesheet/file-stylesheet.processor.d.ts +9 -0
- package/src/services/asset-processing-service/processors/stylesheet/file-stylesheet.processor.js +63 -0
- package/src/services/asset-processing-service/processors/stylesheet/file-stylesheet.processor.ts +77 -0
- package/src/services/cache/cache.types.d.ts +107 -0
- package/src/services/cache/cache.types.js +0 -0
- package/src/services/cache/cache.types.ts +126 -0
- package/src/services/cache/index.d.ts +7 -0
- package/src/services/cache/index.js +7 -0
- package/src/services/cache/index.ts +18 -0
- package/src/services/cache/memory-cache-store.d.ts +42 -0
- package/src/services/cache/memory-cache-store.js +98 -0
- package/src/services/cache/memory-cache-store.ts +130 -0
- package/src/services/cache/page-cache-service.d.ts +70 -0
- package/src/services/cache/page-cache-service.js +152 -0
- package/src/services/cache/page-cache-service.ts +202 -0
- package/src/services/html-transformer.service.d.ts +50 -0
- package/src/services/html-transformer.service.js +163 -0
- package/src/services/html-transformer.service.ts +217 -0
- package/src/services/page-module-import.service.d.ts +37 -0
- package/src/services/page-module-import.service.js +88 -0
- package/src/services/page-module-import.service.ts +129 -0
- package/src/services/page-request-cache-coordinator.service.d.ts +75 -0
- package/src/services/page-request-cache-coordinator.service.js +107 -0
- package/src/services/page-request-cache-coordinator.service.ts +128 -0
- package/src/services/schema-validation-service.d.ts +122 -0
- package/src/services/schema-validation-service.js +101 -0
- package/src/services/schema-validation-service.ts +204 -0
- package/src/services/validation/standard-schema.types.d.ts +65 -0
- package/src/services/validation/standard-schema.types.js +0 -0
- package/src/services/validation/standard-schema.types.ts +68 -0
- package/src/static-site-generator/static-site-generator.d.ts +57 -0
- package/src/static-site-generator/static-site-generator.js +272 -0
- package/src/static-site-generator/static-site-generator.ts +359 -0
- package/src/utils/css.d.ts +1 -0
- package/src/utils/css.js +7 -0
- package/src/utils/css.ts +5 -0
- package/src/utils/deep-merge.d.ts +14 -0
- package/src/utils/deep-merge.js +32 -0
- package/src/utils/deep-merge.ts +47 -0
- package/src/utils/hash.d.ts +1 -0
- package/src/utils/hash.js +7 -0
- package/src/utils/hash.ts +5 -0
- package/src/utils/html.d.ts +1 -0
- package/src/utils/html.js +4 -0
- package/src/utils/html.ts +1 -0
- package/src/utils/invariant.d.ts +5 -0
- package/src/utils/invariant.js +11 -0
- package/src/utils/invariant.ts +15 -0
- package/src/utils/locals-utils.d.ts +15 -0
- package/src/utils/locals-utils.js +24 -0
- package/src/utils/locals-utils.ts +37 -0
- package/src/utils/parse-cli-args.d.ts +24 -0
- package/src/utils/parse-cli-args.js +47 -0
- package/src/utils/parse-cli-args.ts +83 -0
- package/src/utils/path-utils.module.d.ts +5 -0
- package/src/utils/path-utils.module.js +14 -0
- package/src/utils/path-utils.module.ts +14 -0
- package/src/utils/runtime.d.ts +11 -0
- package/src/utils/runtime.js +40 -0
- package/src/utils/runtime.ts +44 -0
- package/src/utils/server-utils.module.d.ts +19 -0
- package/src/utils/server-utils.module.js +56 -0
- package/src/utils/server-utils.module.ts +67 -0
- package/src/watchers/project-watcher.d.ts +120 -0
- package/src/watchers/project-watcher.js +238 -0
- package/src/watchers/project-watcher.test-helpers.d.ts +4 -0
- package/src/watchers/project-watcher.test-helpers.js +51 -0
- package/src/watchers/project-watcher.test-helpers.ts +40 -0
- package/src/watchers/project-watcher.ts +306 -0
package/src/eco/eco.ts
ADDED
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The eco namespace - unified component and page factory API
|
|
3
|
+
* @module
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import type {
|
|
7
|
+
EcoComponent,
|
|
8
|
+
EcoPagesElement,
|
|
9
|
+
EcoPageComponent,
|
|
10
|
+
GetMetadata,
|
|
11
|
+
GetStaticPaths,
|
|
12
|
+
GetStaticProps,
|
|
13
|
+
Middleware,
|
|
14
|
+
RequestLocals,
|
|
15
|
+
RequestPageContext,
|
|
16
|
+
} from '../public-types.ts';
|
|
17
|
+
import type { CacheStrategy } from '../services/cache/cache.types.ts';
|
|
18
|
+
import type {
|
|
19
|
+
ComponentOptions,
|
|
20
|
+
Eco,
|
|
21
|
+
PageOptions,
|
|
22
|
+
PageOptionsBase,
|
|
23
|
+
PagePropsFor,
|
|
24
|
+
PagePropsForWithLocals,
|
|
25
|
+
PageRequires,
|
|
26
|
+
} from './eco.types.ts';
|
|
27
|
+
import { createNodeId, createPropsRef, createSlotRef, getComponentRenderContext } from './component-render-context.ts';
|
|
28
|
+
import { createComponentMarker, parseComponentMarkers } from '../route-renderer/component-marker.ts';
|
|
29
|
+
import { addTriggerAttribute, isThenable, wrapWithScriptsInjector } from './eco.utils.ts';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Creates a component factory with lazy-trigger support and deferred-boundary
|
|
33
|
+
* marker emission.
|
|
34
|
+
*
|
|
35
|
+
* Behavior:
|
|
36
|
+
* - In normal render flow, returns `options.render(props)` with optional lazy
|
|
37
|
+
* trigger/script wrapping.
|
|
38
|
+
* - When rendering under component graph context and the active boundary policy
|
|
39
|
+
* decides the target boundary should defer, emits an `eco-marker` token
|
|
40
|
+
* instead of rendering the component immediately.
|
|
41
|
+
*
|
|
42
|
+
* @param options Component options for rendering and dependency declaration.
|
|
43
|
+
* @returns Configured eco component.
|
|
44
|
+
*/
|
|
45
|
+
function createComponentFactory<P, E>(options: ComponentOptions<P, E>): EcoComponent<P, E> {
|
|
46
|
+
const integrationName = options.integration ?? options.__eco?.integration;
|
|
47
|
+
const comp: EcoComponent<P, E> = ((props: P) => {
|
|
48
|
+
const renderContext = getComponentRenderContext();
|
|
49
|
+
const shouldEmitMarker =
|
|
50
|
+
renderContext !== undefined &&
|
|
51
|
+
renderContext.boundaryContext.decideBoundaryRender({
|
|
52
|
+
currentIntegration: renderContext.currentIntegration,
|
|
53
|
+
targetIntegration: integrationName,
|
|
54
|
+
component: comp,
|
|
55
|
+
}) === 'defer';
|
|
56
|
+
|
|
57
|
+
if (shouldEmitMarker && renderContext) {
|
|
58
|
+
const nodeId = createNodeId(renderContext);
|
|
59
|
+
const propsRef = createPropsRef(renderContext);
|
|
60
|
+
const componentRef = comp.config?.__eco?.id ?? comp.config?.__eco?.file;
|
|
61
|
+
|
|
62
|
+
if (!componentRef) {
|
|
63
|
+
throw new Error(
|
|
64
|
+
'[ecopages] Missing component reference metadata for cross-integration marker emission.',
|
|
65
|
+
);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
const componentProps = (props ?? {}) as Record<string, unknown>;
|
|
69
|
+
renderContext.propsByRef[propsRef] = componentProps;
|
|
70
|
+
|
|
71
|
+
let slotRef: string | undefined;
|
|
72
|
+
const children = componentProps.children;
|
|
73
|
+
if (typeof children === 'string' && children.includes('<eco-marker')) {
|
|
74
|
+
const childMarkers = parseComponentMarkers(children);
|
|
75
|
+
if (childMarkers.length > 0) {
|
|
76
|
+
slotRef = createSlotRef(renderContext);
|
|
77
|
+
renderContext.slotChildrenByRef[slotRef] = childMarkers.map((marker) => marker.nodeId);
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
return createComponentMarker({
|
|
82
|
+
nodeId,
|
|
83
|
+
integration: integrationName as string,
|
|
84
|
+
componentRef,
|
|
85
|
+
propsRef,
|
|
86
|
+
slotRef,
|
|
87
|
+
}) as E;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
const content = options.render(props);
|
|
91
|
+
|
|
92
|
+
const lazyTriggers = comp.config?._resolvedLazyTriggers;
|
|
93
|
+
if (lazyTriggers && lazyTriggers.length > 0) {
|
|
94
|
+
const triggerId = lazyTriggers[0].triggerId;
|
|
95
|
+
if (isThenable(content)) {
|
|
96
|
+
return content.then((resolvedContent) => addTriggerAttribute(resolvedContent, triggerId));
|
|
97
|
+
}
|
|
98
|
+
return addTriggerAttribute(content, triggerId);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
const lazyGroups = comp.config?._resolvedLazyScripts;
|
|
102
|
+
|
|
103
|
+
if (lazyGroups && lazyGroups.length > 0) {
|
|
104
|
+
if (isThenable(content)) {
|
|
105
|
+
return content.then((resolvedContent) => wrapWithScriptsInjector(resolvedContent, lazyGroups));
|
|
106
|
+
}
|
|
107
|
+
return wrapWithScriptsInjector(content, lazyGroups);
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
return content;
|
|
111
|
+
}) as EcoComponent<P, E>;
|
|
112
|
+
|
|
113
|
+
comp.config = {
|
|
114
|
+
__eco: options.__eco,
|
|
115
|
+
integration: options.integration,
|
|
116
|
+
dependencies: options.dependencies,
|
|
117
|
+
};
|
|
118
|
+
|
|
119
|
+
return comp;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* Creates a reusable component with optional dependencies.
|
|
124
|
+
*
|
|
125
|
+
* @param options Component definition options.
|
|
126
|
+
* @returns Eco component function.
|
|
127
|
+
*/
|
|
128
|
+
function component<P = {}, E = EcoPagesElement>(options: ComponentOptions<P, E>): EcoComponent<P, E> {
|
|
129
|
+
return createComponentFactory(options);
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Creates a page component with typed props and optional static helpers.
|
|
134
|
+
*/
|
|
135
|
+
function page<T = {}, E = EcoPagesElement>(options: PageOptions<T, E> & { requires?: undefined }): EcoPageComponent<T>;
|
|
136
|
+
function page<T = {}, E = EcoPagesElement, const K extends keyof RequestLocals = keyof RequestLocals>(
|
|
137
|
+
options: Omit<PageOptions<T, E>, 'render' | 'requires'> & {
|
|
138
|
+
requires: PageRequires<K>;
|
|
139
|
+
render: (props: PagePropsForWithLocals<T, K>) => E | Promise<E>;
|
|
140
|
+
},
|
|
141
|
+
): EcoPageComponent<T>;
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Creates a page component and attaches optional static APIs.
|
|
145
|
+
*
|
|
146
|
+
* @param options Page options.
|
|
147
|
+
* @returns Eco page component.
|
|
148
|
+
*/
|
|
149
|
+
function page<T, E>(
|
|
150
|
+
options: PageOptionsBase<T, E> & { cache?: CacheStrategy; middleware?: Middleware[] },
|
|
151
|
+
): EcoPageComponent<T> {
|
|
152
|
+
const { layout, dependencies, render, staticPaths, staticProps, metadata, cache, requires, middleware } = options;
|
|
153
|
+
|
|
154
|
+
const componentOptions: ComponentOptions<PagePropsFor<T> & Partial<RequestPageContext>, E> = {
|
|
155
|
+
__eco: options.__eco,
|
|
156
|
+
integration: options.integration,
|
|
157
|
+
dependencies: layout
|
|
158
|
+
? {
|
|
159
|
+
...dependencies,
|
|
160
|
+
components: [...(dependencies?.components || []), layout],
|
|
161
|
+
}
|
|
162
|
+
: dependencies,
|
|
163
|
+
render,
|
|
164
|
+
};
|
|
165
|
+
|
|
166
|
+
const pageComponent = createComponentFactory(componentOptions) as EcoPageComponent<T>;
|
|
167
|
+
|
|
168
|
+
if (layout && pageComponent.config) {
|
|
169
|
+
pageComponent.config.layout = layout;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
if (staticPaths) pageComponent.staticPaths = staticPaths;
|
|
173
|
+
if (staticProps) pageComponent.staticProps = staticProps;
|
|
174
|
+
if (metadata) pageComponent.metadata = metadata;
|
|
175
|
+
if (cache) pageComponent.cache = cache;
|
|
176
|
+
if (requires) pageComponent.requires = requires;
|
|
177
|
+
if (middleware) pageComponent.middleware = middleware;
|
|
178
|
+
|
|
179
|
+
return pageComponent;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
/**
|
|
183
|
+
* Type-safe wrapper for metadata functions.
|
|
184
|
+
*
|
|
185
|
+
* @param fn Metadata factory function.
|
|
186
|
+
* @returns The same function.
|
|
187
|
+
*/
|
|
188
|
+
function metadata<P = {}>(fn: GetMetadata<P>): GetMetadata<P> {
|
|
189
|
+
return fn;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* Type-safe wrapper for static paths functions.
|
|
194
|
+
*
|
|
195
|
+
* @param fn Static paths function.
|
|
196
|
+
* @returns The same function.
|
|
197
|
+
*/
|
|
198
|
+
function staticPaths(fn: GetStaticPaths): GetStaticPaths {
|
|
199
|
+
return fn;
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* Type-safe wrapper for static props functions.
|
|
204
|
+
*
|
|
205
|
+
* @param fn Static props function.
|
|
206
|
+
* @returns The same function.
|
|
207
|
+
*/
|
|
208
|
+
function staticProps<P>(fn: GetStaticProps<P>): GetStaticProps<P> {
|
|
209
|
+
return fn;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* The eco namespace - provides factories for components and pages
|
|
214
|
+
*/
|
|
215
|
+
export const eco: Eco = {
|
|
216
|
+
component,
|
|
217
|
+
page,
|
|
218
|
+
metadata,
|
|
219
|
+
staticPaths,
|
|
220
|
+
staticProps,
|
|
221
|
+
};
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Type definitions for the eco namespace API
|
|
3
|
+
* @module
|
|
4
|
+
*/
|
|
5
|
+
import type { DependencyLazyTrigger, EcoComponent, EcoComponentDependencies, EcoInjectedMeta, EcoPagesElement, GetMetadata, GetStaticPaths, GetStaticProps, Middleware, RequestLocals, RequestPageContext } from '../public-types.js';
|
|
6
|
+
import type { CacheStrategy } from '../services/cache/cache.types.js';
|
|
7
|
+
type WithRequiredLocals<K extends keyof RequestLocals> = Omit<RequestLocals, K> & {
|
|
8
|
+
[P in K]-?: Exclude<RequestLocals[P], null | undefined>;
|
|
9
|
+
};
|
|
10
|
+
type RequiresKeys = keyof RequestLocals;
|
|
11
|
+
export type PageRequires<K extends RequiresKeys = RequiresKeys> = K | readonly K[];
|
|
12
|
+
/**
|
|
13
|
+
* Lazy trigger options map directly to scripts-injector attributes.
|
|
14
|
+
* Only one trigger type can be active at a time.
|
|
15
|
+
*/
|
|
16
|
+
export type LazyTrigger = DependencyLazyTrigger;
|
|
17
|
+
/**
|
|
18
|
+
* Options for creating a component with eco.component()
|
|
19
|
+
* @template P - The props type for the component
|
|
20
|
+
* @template E - The element/return type (defaults to EcoPagesElement for Kita, use ReactNode for React)
|
|
21
|
+
*/
|
|
22
|
+
export interface ComponentOptions<P, E = EcoPagesElement> {
|
|
23
|
+
/** @internal Injected by eco-component-meta-plugin */
|
|
24
|
+
__eco?: EcoInjectedMeta;
|
|
25
|
+
integration?: string;
|
|
26
|
+
dependencies?: EcoComponentDependencies;
|
|
27
|
+
render: (props: P) => E | Promise<E>;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Base options shared by all page variants
|
|
31
|
+
*/
|
|
32
|
+
export interface PageOptionsBase<T, E = EcoPagesElement> {
|
|
33
|
+
/** @internal Injected by eco-component-meta-plugin */
|
|
34
|
+
__eco?: EcoInjectedMeta;
|
|
35
|
+
integration?: string;
|
|
36
|
+
dependencies?: EcoComponentDependencies;
|
|
37
|
+
layout?: EcoComponent<{
|
|
38
|
+
children: E;
|
|
39
|
+
} & Partial<RequestPageContext>>;
|
|
40
|
+
/**
|
|
41
|
+
* Define static paths for dynamic routes (e.g., [slug].tsx).
|
|
42
|
+
* Returns all possible paths that should be pre-rendered at build time.
|
|
43
|
+
*/
|
|
44
|
+
staticPaths?: GetStaticPaths;
|
|
45
|
+
/**
|
|
46
|
+
* Fetch data for the page at build time.
|
|
47
|
+
* Props returned here are passed to both render() and metadata().
|
|
48
|
+
*/
|
|
49
|
+
staticProps?: GetStaticProps<T>;
|
|
50
|
+
/**
|
|
51
|
+
* Generate page metadata (title, description, etc.).
|
|
52
|
+
* Receives props from staticProps if defined.
|
|
53
|
+
*/
|
|
54
|
+
metadata?: GetMetadata<T>;
|
|
55
|
+
/**
|
|
56
|
+
* Declares which `locals` keys must be present for this page.
|
|
57
|
+
*
|
|
58
|
+
* This is a typing and documentation feature; runtime enforcement must be done via handler/page middleware.
|
|
59
|
+
*/
|
|
60
|
+
requires?: PageRequires;
|
|
61
|
+
render: (props: PagePropsFor<T> & Partial<RequestPageContext>) => E | Promise<E>;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Page options without middleware - allows any cache strategy
|
|
65
|
+
*/
|
|
66
|
+
interface PageOptionsWithoutMiddleware<T, E = EcoPagesElement> extends PageOptionsBase<T, E> {
|
|
67
|
+
/**
|
|
68
|
+
* Cache configuration for ISR (Incremental Static Regeneration).
|
|
69
|
+
* - `'static'`: Cache indefinitely (default)
|
|
70
|
+
* - `'dynamic'`: No caching, render on every request
|
|
71
|
+
* - `{ revalidate: number, tags?: string[] }`: Cache with time-based revalidation
|
|
72
|
+
*/
|
|
73
|
+
cache?: CacheStrategy;
|
|
74
|
+
middleware?: undefined;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Page options with middleware - requires cache: 'dynamic'
|
|
78
|
+
*/
|
|
79
|
+
interface PageOptionsWithMiddleware<T, E = EcoPagesElement> extends PageOptionsBase<T, E> {
|
|
80
|
+
/**
|
|
81
|
+
* Cache must be 'dynamic' when using middleware.
|
|
82
|
+
* Middleware runs on every request, so caching would bypass middleware effects.
|
|
83
|
+
*/
|
|
84
|
+
cache: 'dynamic';
|
|
85
|
+
/**
|
|
86
|
+
* Request-time middleware for file-based routes.
|
|
87
|
+
* Runs before rendering and can short-circuit by returning a Response.
|
|
88
|
+
*/
|
|
89
|
+
middleware: Middleware[];
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Options for creating a page with eco.page()
|
|
93
|
+
*
|
|
94
|
+
* Supports two patterns:
|
|
95
|
+
* 1. **Consolidated API** (recommended): Define staticPaths, staticProps, and metadata inline
|
|
96
|
+
* 2. **Separate exports** (legacy): Export getStaticPaths, getStaticProps, getMetadata separately
|
|
97
|
+
*
|
|
98
|
+
* When using `middleware`, `cache` must be set to `'dynamic'` because middleware
|
|
99
|
+
* runs on every request and caching would bypass middleware effects.
|
|
100
|
+
*
|
|
101
|
+
* @template T - The props type for the page
|
|
102
|
+
* @template E - The element/return type (defaults to EcoPagesElement for Kita, use ReactNode for React)
|
|
103
|
+
*/
|
|
104
|
+
export type PageOptions<T, E = EcoPagesElement> = PageOptionsWithoutMiddleware<T, E> | PageOptionsWithMiddleware<T, E>;
|
|
105
|
+
export type PagePropsForWithLocals<T, K extends RequiresKeys | never = never> = PagePropsFor<T> & (K extends never ? Partial<RequestPageContext> : Omit<Partial<RequestPageContext>, 'locals'> & {
|
|
106
|
+
locals: WithRequiredLocals<Extract<K, keyof RequestLocals>>;
|
|
107
|
+
});
|
|
108
|
+
/**
|
|
109
|
+
* Extracts props type from getStaticProps return type, or uses T directly if it's a props object.
|
|
110
|
+
* Always includes params and query for page context.
|
|
111
|
+
*/
|
|
112
|
+
export type PagePropsFor<T> = T extends GetStaticProps<infer P> ? P & {
|
|
113
|
+
params?: Record<string, string>;
|
|
114
|
+
query?: Record<string, string>;
|
|
115
|
+
} : T & {
|
|
116
|
+
params?: Record<string, string>;
|
|
117
|
+
query?: Record<string, string>;
|
|
118
|
+
};
|
|
119
|
+
/**
|
|
120
|
+
* A page component with optional attached static functions.
|
|
121
|
+
* Used by the consolidated eco.page() API where staticPaths, staticProps,
|
|
122
|
+
* and metadata are defined inline and attached to the component.
|
|
123
|
+
*/
|
|
124
|
+
export type EcoPageComponent<T> = EcoComponent<PagePropsFor<T> & Partial<RequestPageContext>> & {
|
|
125
|
+
staticPaths?: GetStaticPaths;
|
|
126
|
+
staticProps?: GetStaticProps<T>;
|
|
127
|
+
metadata?: GetMetadata<T>;
|
|
128
|
+
cache?: CacheStrategy;
|
|
129
|
+
requires?: PageRequires;
|
|
130
|
+
middleware?: Middleware[];
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* The eco namespace interface
|
|
134
|
+
*/
|
|
135
|
+
export interface Eco {
|
|
136
|
+
/**
|
|
137
|
+
* Create a reusable component with dependencies and optional lazy-loading.
|
|
138
|
+
* @template P - Props type
|
|
139
|
+
* @template E - Element/return type (EcoPagesElement for Kita, ReactNode for React)
|
|
140
|
+
*/
|
|
141
|
+
component: <P = {}, E = EcoPagesElement>(options: ComponentOptions<P, E>) => EcoComponent<P, E>;
|
|
142
|
+
/**
|
|
143
|
+
* Create a page component with type-safe props from getStaticProps.
|
|
144
|
+
* Returns an EcoPageComponent with attached staticPaths, staticProps, and metadata.
|
|
145
|
+
*
|
|
146
|
+
* If `requires` is provided, the `render` callback receives `locals` as required and non-null for the required keys.
|
|
147
|
+
*/
|
|
148
|
+
page: {
|
|
149
|
+
<T = {}, E = EcoPagesElement>(options: PageOptions<T, E> & {
|
|
150
|
+
requires?: undefined;
|
|
151
|
+
}): EcoPageComponent<T>;
|
|
152
|
+
<T = {}, E = EcoPagesElement, const K extends RequiresKeys = RequiresKeys>(options: Omit<PageOptions<T, E>, 'render' | 'requires'> & {
|
|
153
|
+
requires: PageRequires<K>;
|
|
154
|
+
render: (props: PagePropsForWithLocals<T, K>) => E | Promise<E>;
|
|
155
|
+
}): EcoPageComponent<T>;
|
|
156
|
+
};
|
|
157
|
+
/**
|
|
158
|
+
* Type-safe wrapper for page metadata (identity function)
|
|
159
|
+
*/
|
|
160
|
+
metadata: <P = {}>(fn: GetMetadata<P>) => GetMetadata<P>;
|
|
161
|
+
/**
|
|
162
|
+
* Type-safe wrapper for static paths (identity function)
|
|
163
|
+
*/
|
|
164
|
+
staticPaths: (fn: GetStaticPaths) => GetStaticPaths;
|
|
165
|
+
/**
|
|
166
|
+
* Type-safe wrapper for static props (identity function)
|
|
167
|
+
*/
|
|
168
|
+
staticProps: <P>(fn: GetStaticProps<P>) => GetStaticProps<P>;
|
|
169
|
+
}
|
|
170
|
+
export {};
|
|
File without changes
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Type definitions for the eco namespace API
|
|
3
|
+
* @module
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import type {
|
|
7
|
+
DependencyLazyTrigger,
|
|
8
|
+
EcoComponent,
|
|
9
|
+
EcoComponentDependencies,
|
|
10
|
+
EcoInjectedMeta,
|
|
11
|
+
EcoPagesElement,
|
|
12
|
+
GetMetadata,
|
|
13
|
+
GetStaticPaths,
|
|
14
|
+
GetStaticProps,
|
|
15
|
+
Middleware,
|
|
16
|
+
RequestLocals,
|
|
17
|
+
RequestPageContext,
|
|
18
|
+
} from '../public-types.ts';
|
|
19
|
+
import type { CacheStrategy } from '../services/cache/cache.types.ts';
|
|
20
|
+
|
|
21
|
+
type WithRequiredLocals<K extends keyof RequestLocals> = Omit<RequestLocals, K> & {
|
|
22
|
+
[P in K]-?: Exclude<RequestLocals[P], null | undefined>;
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
type RequiresKeys = keyof RequestLocals;
|
|
26
|
+
|
|
27
|
+
export type PageRequires<K extends RequiresKeys = RequiresKeys> = K | readonly K[];
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Lazy trigger options map directly to scripts-injector attributes.
|
|
31
|
+
* Only one trigger type can be active at a time.
|
|
32
|
+
*/
|
|
33
|
+
export type LazyTrigger = DependencyLazyTrigger;
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Options for creating a component with eco.component()
|
|
37
|
+
* @template P - The props type for the component
|
|
38
|
+
* @template E - The element/return type (defaults to EcoPagesElement for Kita, use ReactNode for React)
|
|
39
|
+
*/
|
|
40
|
+
export interface ComponentOptions<P, E = EcoPagesElement> {
|
|
41
|
+
/** @internal Injected by eco-component-meta-plugin */
|
|
42
|
+
__eco?: EcoInjectedMeta;
|
|
43
|
+
integration?: string;
|
|
44
|
+
dependencies?: EcoComponentDependencies;
|
|
45
|
+
render: (props: P) => E | Promise<E>;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Base options shared by all page variants
|
|
50
|
+
*/
|
|
51
|
+
export interface PageOptionsBase<T, E = EcoPagesElement> {
|
|
52
|
+
/** @internal Injected by eco-component-meta-plugin */
|
|
53
|
+
__eco?: EcoInjectedMeta;
|
|
54
|
+
integration?: string;
|
|
55
|
+
dependencies?: EcoComponentDependencies;
|
|
56
|
+
layout?: EcoComponent<{ children: E } & Partial<RequestPageContext>>;
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Define static paths for dynamic routes (e.g., [slug].tsx).
|
|
60
|
+
* Returns all possible paths that should be pre-rendered at build time.
|
|
61
|
+
*/
|
|
62
|
+
staticPaths?: GetStaticPaths;
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Fetch data for the page at build time.
|
|
66
|
+
* Props returned here are passed to both render() and metadata().
|
|
67
|
+
*/
|
|
68
|
+
staticProps?: GetStaticProps<T>;
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Generate page metadata (title, description, etc.).
|
|
72
|
+
* Receives props from staticProps if defined.
|
|
73
|
+
*/
|
|
74
|
+
metadata?: GetMetadata<T>;
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Declares which `locals` keys must be present for this page.
|
|
78
|
+
*
|
|
79
|
+
* This is a typing and documentation feature; runtime enforcement must be done via handler/page middleware.
|
|
80
|
+
*/
|
|
81
|
+
requires?: PageRequires;
|
|
82
|
+
|
|
83
|
+
render: (props: PagePropsFor<T> & Partial<RequestPageContext>) => E | Promise<E>;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Page options without middleware - allows any cache strategy
|
|
88
|
+
*/
|
|
89
|
+
interface PageOptionsWithoutMiddleware<T, E = EcoPagesElement> extends PageOptionsBase<T, E> {
|
|
90
|
+
/**
|
|
91
|
+
* Cache configuration for ISR (Incremental Static Regeneration).
|
|
92
|
+
* - `'static'`: Cache indefinitely (default)
|
|
93
|
+
* - `'dynamic'`: No caching, render on every request
|
|
94
|
+
* - `{ revalidate: number, tags?: string[] }`: Cache with time-based revalidation
|
|
95
|
+
*/
|
|
96
|
+
cache?: CacheStrategy;
|
|
97
|
+
middleware?: undefined;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Page options with middleware - requires cache: 'dynamic'
|
|
102
|
+
*/
|
|
103
|
+
interface PageOptionsWithMiddleware<T, E = EcoPagesElement> extends PageOptionsBase<T, E> {
|
|
104
|
+
/**
|
|
105
|
+
* Cache must be 'dynamic' when using middleware.
|
|
106
|
+
* Middleware runs on every request, so caching would bypass middleware effects.
|
|
107
|
+
*/
|
|
108
|
+
cache: 'dynamic';
|
|
109
|
+
/**
|
|
110
|
+
* Request-time middleware for file-based routes.
|
|
111
|
+
* Runs before rendering and can short-circuit by returning a Response.
|
|
112
|
+
*/
|
|
113
|
+
middleware: Middleware[];
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* Options for creating a page with eco.page()
|
|
118
|
+
*
|
|
119
|
+
* Supports two patterns:
|
|
120
|
+
* 1. **Consolidated API** (recommended): Define staticPaths, staticProps, and metadata inline
|
|
121
|
+
* 2. **Separate exports** (legacy): Export getStaticPaths, getStaticProps, getMetadata separately
|
|
122
|
+
*
|
|
123
|
+
* When using `middleware`, `cache` must be set to `'dynamic'` because middleware
|
|
124
|
+
* runs on every request and caching would bypass middleware effects.
|
|
125
|
+
*
|
|
126
|
+
* @template T - The props type for the page
|
|
127
|
+
* @template E - The element/return type (defaults to EcoPagesElement for Kita, use ReactNode for React)
|
|
128
|
+
*/
|
|
129
|
+
export type PageOptions<T, E = EcoPagesElement> = PageOptionsWithoutMiddleware<T, E> | PageOptionsWithMiddleware<T, E>;
|
|
130
|
+
|
|
131
|
+
export type PagePropsForWithLocals<T, K extends RequiresKeys | never = never> = PagePropsFor<T> &
|
|
132
|
+
(K extends never
|
|
133
|
+
? Partial<RequestPageContext>
|
|
134
|
+
: Omit<Partial<RequestPageContext>, 'locals'> & {
|
|
135
|
+
locals: WithRequiredLocals<Extract<K, keyof RequestLocals>>;
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* Extracts props type from getStaticProps return type, or uses T directly if it's a props object.
|
|
140
|
+
* Always includes params and query for page context.
|
|
141
|
+
*/
|
|
142
|
+
export type PagePropsFor<T> =
|
|
143
|
+
T extends GetStaticProps<infer P>
|
|
144
|
+
? P & { params?: Record<string, string>; query?: Record<string, string> }
|
|
145
|
+
: T & { params?: Record<string, string>; query?: Record<string, string> };
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* A page component with optional attached static functions.
|
|
149
|
+
* Used by the consolidated eco.page() API where staticPaths, staticProps,
|
|
150
|
+
* and metadata are defined inline and attached to the component.
|
|
151
|
+
*/
|
|
152
|
+
export type EcoPageComponent<T> = EcoComponent<PagePropsFor<T> & Partial<RequestPageContext>> & {
|
|
153
|
+
staticPaths?: GetStaticPaths;
|
|
154
|
+
staticProps?: GetStaticProps<T>;
|
|
155
|
+
metadata?: GetMetadata<T>;
|
|
156
|
+
cache?: CacheStrategy;
|
|
157
|
+
requires?: PageRequires;
|
|
158
|
+
middleware?: Middleware[];
|
|
159
|
+
};
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* The eco namespace interface
|
|
163
|
+
*/
|
|
164
|
+
export interface Eco {
|
|
165
|
+
/**
|
|
166
|
+
* Create a reusable component with dependencies and optional lazy-loading.
|
|
167
|
+
* @template P - Props type
|
|
168
|
+
* @template E - Element/return type (EcoPagesElement for Kita, ReactNode for React)
|
|
169
|
+
*/
|
|
170
|
+
component: <P = {}, E = EcoPagesElement>(options: ComponentOptions<P, E>) => EcoComponent<P, E>;
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Create a page component with type-safe props from getStaticProps.
|
|
174
|
+
* Returns an EcoPageComponent with attached staticPaths, staticProps, and metadata.
|
|
175
|
+
*
|
|
176
|
+
* If `requires` is provided, the `render` callback receives `locals` as required and non-null for the required keys.
|
|
177
|
+
*/
|
|
178
|
+
page: {
|
|
179
|
+
<T = {}, E = EcoPagesElement>(options: PageOptions<T, E> & { requires?: undefined }): EcoPageComponent<T>;
|
|
180
|
+
<T = {}, E = EcoPagesElement, const K extends RequiresKeys = RequiresKeys>(
|
|
181
|
+
options: Omit<PageOptions<T, E>, 'render' | 'requires'> & {
|
|
182
|
+
requires: PageRequires<K>;
|
|
183
|
+
render: (props: PagePropsForWithLocals<T, K>) => E | Promise<E>;
|
|
184
|
+
},
|
|
185
|
+
): EcoPageComponent<T>;
|
|
186
|
+
};
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* Type-safe wrapper for page metadata (identity function)
|
|
190
|
+
*/
|
|
191
|
+
metadata: <P = {}>(fn: GetMetadata<P>) => GetMetadata<P>;
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Type-safe wrapper for static paths (identity function)
|
|
195
|
+
*/
|
|
196
|
+
staticPaths: (fn: GetStaticPaths) => GetStaticPaths;
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* Type-safe wrapper for static props (identity function)
|
|
200
|
+
*/
|
|
201
|
+
staticProps: <P>(fn: GetStaticProps<P>) => GetStaticProps<P>;
|
|
202
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { EcoComponent } from '../public-types.js';
|
|
2
|
+
/**
|
|
3
|
+
* Returns `true` when `value` is a thenable (Promise-like) object.
|
|
4
|
+
*
|
|
5
|
+
* Used to transparently handle both synchronous and asynchronous component
|
|
6
|
+
* render results without requiring every caller to branch on `instanceof Promise`.
|
|
7
|
+
*
|
|
8
|
+
* @typeParam T Expected resolved type of the thenable.
|
|
9
|
+
*/
|
|
10
|
+
export declare function isThenable<T>(value: unknown): value is PromiseLike<T>;
|
|
11
|
+
/**
|
|
12
|
+
* Injects `data-eco-trigger` into the first real HTML element opening tag of
|
|
13
|
+
* a component's rendered output string.
|
|
14
|
+
*
|
|
15
|
+
* The scan skips over leading whitespace, HTML comments (`<!-- -->`), CDATA
|
|
16
|
+
* sections, and doctype declarations so that the attribute is always placed on
|
|
17
|
+
* the first actual element — not spurious markup that can precede it.
|
|
18
|
+
*
|
|
19
|
+
* The insertion point is the end of the element's tag name, before any existing
|
|
20
|
+
* attributes or the closing `>`, which produces output like:
|
|
21
|
+
*
|
|
22
|
+
* ```html
|
|
23
|
+
* <my-element data-eco-trigger="eco-trigger-abc123" class="foo">…</my-element>
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* When no eligible opening tag is found the original string is returned
|
|
27
|
+
* unchanged so callers never receive a broken fragment.
|
|
28
|
+
*
|
|
29
|
+
* @param content Rendered HTML string (or any value coercible to string).
|
|
30
|
+
* @param triggerId Stable trigger identifier produced by `buildResolvedLazyTriggers`.
|
|
31
|
+
*/
|
|
32
|
+
export declare function addTriggerAttribute(content: unknown, triggerId: string): string;
|
|
33
|
+
/**
|
|
34
|
+
* Wraps rendered component output in a `<scripts-injector>` element that
|
|
35
|
+
* carries an inline injector map for the legacy (non-global-injector) path.
|
|
36
|
+
*
|
|
37
|
+
* @param content Rendered component HTML.
|
|
38
|
+
* @param lazyGroups Resolved lazy script groups attached to the component config.
|
|
39
|
+
*/
|
|
40
|
+
export declare function wrapWithScriptsInjector(content: unknown, lazyGroups: NonNullable<EcoComponent['config']>['_resolvedLazyScripts']): string;
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { buildInjectorMapScript } from "./lazy-injector-map.js";
|
|
2
|
+
function isThenable(value) {
|
|
3
|
+
return typeof value === "object" && value !== null && "then" in value && typeof value.then === "function";
|
|
4
|
+
}
|
|
5
|
+
function addTriggerAttribute(content, triggerId) {
|
|
6
|
+
const str = String(content);
|
|
7
|
+
let i = 0;
|
|
8
|
+
while (i < str.length) {
|
|
9
|
+
if (str[i] !== "<") {
|
|
10
|
+
i++;
|
|
11
|
+
continue;
|
|
12
|
+
}
|
|
13
|
+
const next = str[i + 1];
|
|
14
|
+
if (next === "!" || next === "?") {
|
|
15
|
+
const end = str.indexOf(">", i);
|
|
16
|
+
if (end === -1) break;
|
|
17
|
+
i = end + 1;
|
|
18
|
+
continue;
|
|
19
|
+
}
|
|
20
|
+
if (next && /[a-zA-Z]/.test(next)) {
|
|
21
|
+
const tagSlice = str.slice(i + 1);
|
|
22
|
+
const nameEnd = tagSlice.search(/[\s/>]/);
|
|
23
|
+
if (nameEnd === -1) break;
|
|
24
|
+
const insertAt = i + 1 + nameEnd;
|
|
25
|
+
return `${str.slice(0, insertAt)} data-eco-trigger="${triggerId}"${str.slice(insertAt)}`;
|
|
26
|
+
}
|
|
27
|
+
break;
|
|
28
|
+
}
|
|
29
|
+
return str;
|
|
30
|
+
}
|
|
31
|
+
function wrapWithScriptsInjector(content, lazyGroups) {
|
|
32
|
+
const wrappedContent = String(content);
|
|
33
|
+
const injectorMapScript = buildInjectorMapScript(lazyGroups ?? []);
|
|
34
|
+
return `<scripts-injector><script type="ecopages/injector-map">${injectorMapScript}<\/script>${wrappedContent}<\/scripts-injector>`;
|
|
35
|
+
}
|
|
36
|
+
export {
|
|
37
|
+
addTriggerAttribute,
|
|
38
|
+
isThenable,
|
|
39
|
+
wrapWithScriptsInjector
|
|
40
|
+
};
|