@ecopages/core 0.2.0-alpha.54 → 0.2.0-alpha.55

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

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

package/src/plugins/source-transform.js

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

package/src/route-renderer/orchestration/component-render-context.d.ts

@@ -0,0 +1,97 @@
+import type { EcoComponent } from '../../types/public-types.js';
+/**
+ * Result returned by a renderer-owned foreign-child runtime.
+ *
+ * `inline` keeps rendering inside the current integration. `resolved` returns a
+ * renderer-owned value immediately, which can be final HTML or a renderer-local
+ * transport token for later queue resolution.
+ */
+export type ForeignChildInterceptionResult = {
+    kind: 'inline';
+    props?: Record<string, unknown>;
+} | {
+    kind: 'resolved';
+    value: unknown;
+};
+export type ForeignChildRenderInterception = {
+    kind: 'inline';
+    props?: Record<string, unknown>;
+} | {
+    kind: 'resolved';
+    value: unknown;
+} | undefined;
+/**
+ * Foreign-child metadata passed into the active renderer-owned runtime.
+ */
+export type ForeignChildInterceptionInput = {
+    currentIntegration: string;
+    targetIntegration?: string;
+    component: EcoComponent;
+    props: Record<string, unknown>;
+};
+/**
+ * Narrow renderer-owned foreign-child runtime injected into one active render
+ * context.
+ *
+ * Integrations implement this contract when foreign children must be handed
+ * off inside the renderer instead of being left for route-level reconciliation.
+ */
+export interface ForeignChildRuntime {
+    /**
+     * Intercepts one foreign child during an active render.
+     *
+     * This runtime is typically installed by the Foreign Subtree execution module,
+     * which decides whether the child stays inline or leaves the current renderer.
+     */
+    interceptForeignChild?(input: ForeignChildInterceptionInput): ForeignChildInterceptionResult | Promise<ForeignChildInterceptionResult>;
+    interceptForeignChildSync?(input: ForeignChildInterceptionInput): ForeignChildInterceptionResult;
+}
+type ForeignChildRenderInput = {
+    component: EcoComponent;
+    props: Record<string, unknown>;
+    targetIntegration?: string;
+};
+/**
+ * Per-render mutable state used while applying foreign-child interception and lazy
+ * output wrapping.
+ */
+export type ComponentRenderContext = {
+    currentIntegration: string;
+    foreignChildRuntime?: ForeignChildRuntime;
+    interceptForeignChild(input: ForeignChildRenderInput): Promise<ForeignChildRenderInterception> | ForeignChildRenderInterception;
+    finalizeComponentRender<T>(component: EcoComponent, content: T): T;
+};
+/**
+ * Returns the current component render context, if one is active.
+ *
+ * @returns Active render context or `undefined` outside render execution.
+ */
+export declare function getComponentRenderContext(): ComponentRenderContext | undefined;
+/**
+ * Runs foreign-child interception for one component render step.
+ *
+ * The active runtime may resolve the foreign child immediately or keep it inline.
+ */
+export declare function interceptForeignChild(input: ForeignChildRenderInput): Promise<ForeignChildRenderInterception> | ForeignChildRenderInterception;
+/**
+ * Applies lazy trigger or injector wrapping to completed component output.
+ *
+ * This helper works both inside render-context execution and in fallback flows
+ * where no active context exists.
+ */
+export declare function finalizeComponentRender<T>(component: EcoComponent, content: T): T;
+/**
+ * Runs render work under a fresh component render context and returns the
+ * resulting value.
+ *
+ * @param input Execution metadata for current integration and foreign-child policy.
+ * @param render Async render function to execute inside the context.
+ * @returns Render result value.
+ */
+export declare function runWithComponentRenderContext<T>(input: {
+    currentIntegration: string;
+    foreignChildRuntime?: ForeignChildRuntime;
+}, render: () => Promise<T>): Promise<{
+    value: T;
+}>;
+export {};

package/src/route-renderer/orchestration/component-render-context.js

@@ -0,0 +1,147 @@
+import { addTriggerAttribute, isThenable, wrapWithScriptsInjector } from "./render-output.utils.js";
+class ComponentRenderOutputRuntime {
+  finalizeComponentRender(component, content) {
+    const lazyTriggers = component.config?._resolvedLazyTriggers;
+    if (lazyTriggers && lazyTriggers.length > 0) {
+      return this.addTriggerToContent(content, lazyTriggers[0].triggerId);
+    }
+    const lazyGroups = component.config?._resolvedLazyScripts;
+    if (lazyGroups && lazyGroups.length > 0) {
+      return this.wrapContentWithScriptsInjector(content, lazyGroups);
+    }
+    return content;
+  }
+  addTriggerToContent(content, triggerId) {
+    if (isThenable(content)) {
+      return content.then((resolvedContent) => addTriggerAttribute(resolvedContent, triggerId));
+    }
+    return addTriggerAttribute(content, triggerId);
+  }
+  wrapContentWithScriptsInjector(content, lazyGroups) {
+    if (isThenable(content)) {
+      return content.then((resolvedContent) => wrapWithScriptsInjector(resolvedContent, lazyGroups));
+    }
+    return wrapWithScriptsInjector(content, lazyGroups);
+  }
+}
+class ContextualComponentRenderRuntime extends ComponentRenderOutputRuntime {
+  context;
+  constructor(context) {
+    super();
+    this.context = context;
+  }
+  applyForeignChildInterceptionResult(result) {
+    if (result.kind === "resolved") {
+      return result;
+    }
+    return result.props ? result : void 0;
+  }
+  /**
+   * Resolves one foreign-child interception through the active runtime.
+   *
+   * The runtime may choose inline rendering or immediate resolved output.
+   */
+  interceptForeignChild(input) {
+    const foreignChildRuntimeInput = {
+      currentIntegration: this.context.currentIntegration,
+      targetIntegration: input.targetIntegration,
+      component: input.component,
+      props: input.props
+    };
+    const asyncInterception = this.context.foreignChildRuntime?.interceptForeignChild?.(foreignChildRuntimeInput);
+    if (asyncInterception !== void 0) {
+      if (isThenable(asyncInterception)) {
+        return asyncInterception.then((result) => this.applyForeignChildInterceptionResult(result));
+      }
+      return this.applyForeignChildInterceptionResult(asyncInterception);
+    }
+    const syncInterception = this.context.foreignChildRuntime?.interceptForeignChildSync?.(foreignChildRuntimeInput);
+    if (syncInterception === void 0) {
+      return void 0;
+    }
+    return this.applyForeignChildInterceptionResult(syncInterception);
+  }
+}
+const GLOBAL_COMPONENT_RENDER_CONTEXT_STATE_KEY = "__ECOPAGES_COMPONENT_RENDER_CONTEXT_STATE__";
+function getSharedContextScope() {
+  const globalProcess = globalThis.process;
+  if (globalProcess && typeof globalProcess === "object") {
+    return globalProcess;
+  }
+  return globalThis;
+}
+function getComponentRenderContextState() {
+  const sharedScope = getSharedContextScope();
+  sharedScope[GLOBAL_COMPONENT_RENDER_CONTEXT_STATE_KEY] ??= {
+    contextStack: [],
+    nodeContextStorage: null,
+    nodeContextStorageLoader: null
+  };
+  return sharedScope[GLOBAL_COMPONENT_RENDER_CONTEXT_STATE_KEY];
+}
+async function getContextStorage() {
+  const state = getComponentRenderContextState();
+  if (state.nodeContextStorage) {
+    return state.nodeContextStorage;
+  }
+  if (state.nodeContextStorageLoader) {
+    return state.nodeContextStorageLoader;
+  }
+  state.nodeContextStorageLoader = import("node:async_hooks").then((module) => {
+    const storage = new module.AsyncLocalStorage();
+    state.nodeContextStorage = {
+      getStore: () => storage.getStore(),
+      run: (store, callback) => storage.run(store, callback)
+    };
+    return state.nodeContextStorage;
+  }).catch(() => {
+    state.nodeContextStorage = null;
+    return null;
+  }).finally(() => {
+    state.nodeContextStorageLoader = null;
+  });
+  return state.nodeContextStorageLoader;
+}
+function getComponentRenderContext() {
+  const state = getComponentRenderContextState();
+  return state.nodeContextStorage?.getStore() ?? state.contextStack[state.contextStack.length - 1];
+}
+const componentRenderOutputRuntime = new ComponentRenderOutputRuntime();
+function interceptForeignChild(input) {
+  return getComponentRenderContext()?.interceptForeignChild(input);
+}
+function finalizeComponentRender(component, content) {
+  const renderContext = getComponentRenderContext();
+  return renderContext?.finalizeComponentRender(component, content) ?? componentRenderOutputRuntime.finalizeComponentRender(component, content);
+}
+async function runWithComponentRenderContext(input, render) {
+  const context = {
+    currentIntegration: input.currentIntegration,
+    foreignChildRuntime: input.foreignChildRuntime
+  };
+  const runtime = new ContextualComponentRenderRuntime(context);
+  context.interceptForeignChild = (deferredInput) => runtime.interceptForeignChild(deferredInput);
+  context.finalizeComponentRender = (component, content) => runtime.finalizeComponentRender(component, content);
+  const storage = await getContextStorage();
+  let value;
+  if (storage) {
+    value = await storage.run(context, render);
+  } else {
+    const state = getComponentRenderContextState();
+    state.contextStack.push(context);
+    try {
+      value = await render();
+    } finally {
+      state.contextStack.pop();
+    }
+  }
+  return {
+    value
+  };
+}
+export {
+  finalizeComponentRender,
+  getComponentRenderContext,
+  interceptForeignChild,
+  runWithComponentRenderContext
+};

package/src/route-renderer/orchestration/declared-ownership-graph.d.ts

@@ -0,0 +1,18 @@
+import type { EcoComponent, OwnershipPlanNodeSource } from '../../types/public-types.js';
+export type DeclaredOwnershipRoot = {
+    component: EcoComponent;
+    source: Extract<OwnershipPlanNodeSource, 'page' | 'layout' | 'html-template'>;
+};
+export type DeclaredOwnershipNodeInput = {
+    component: EcoComponent;
+    source: Exclude<OwnershipPlanNodeSource, 'route'>;
+    parentIntegrationName: string;
+    integrationName: string;
+    componentId: string;
+    isForeignToParent: boolean;
+};
+export declare function mapDeclaredOwnershipGraph<T>(input: {
+    roots: DeclaredOwnershipRoot[];
+    currentIntegrationName: string;
+    mapNode: (node: DeclaredOwnershipNodeInput, children: T[]) => T;
+}): T[];

package/src/route-renderer/orchestration/declared-ownership-graph.js

@@ -0,0 +1,34 @@
+function mapDeclaredOwnershipGraph(input) {
+  let nextSyntheticId = 0;
+  const mapComponent = (component, source, parentIntegrationName, lineage) => {
+    const integrationName = component.config?.integration ?? component.config?.__eco?.integration ?? parentIntegrationName;
+    const componentMeta = component.config?.__eco;
+    const isForeignToParent = integrationName !== parentIntegrationName;
+    const componentId = componentMeta?.id ?? componentMeta?.file ?? `${source}:${nextSyntheticId += 1}`;
+    const nextLineage = new Set(lineage);
+    nextLineage.add(component);
+    const children = (component.config?.dependencies?.components ?? []).flatMap((child) => {
+      if (!child || nextLineage.has(child)) {
+        return [];
+      }
+      return [mapComponent(child, "dependency", integrationName, nextLineage)];
+    });
+    return input.mapNode(
+      {
+        component,
+        source,
+        parentIntegrationName,
+        integrationName,
+        componentId,
+        isForeignToParent
+      },
+      children
+    );
+  };
+  return input.roots.map(
+    ({ component, source }) => mapComponent(component, source, input.currentIntegrationName, /* @__PURE__ */ new Set())
+  );
+}
+export {
+  mapDeclaredOwnershipGraph
+};

package/src/route-renderer/orchestration/foreign-subtree-execution.service.d.ts

@@ -0,0 +1,110 @@
+import type { ProcessedAsset } from '../../services/assets/asset-processing-service/index.js';
+import type { BaseIntegrationContext, ComponentRenderInput, ComponentRenderResult, EcoComponent, ForeignSubtreeRenderPayload } from '../../types/public-types.js';
+import { type ForeignChildRuntime } from './component-render-context.js';
+import { QueuedForeignSubtreeResolutionService, type QueuedForeignSubtreeResolution, type QueuedForeignSubtreeResolutionContext } from './queued-foreign-subtree-resolution.service.js';
+export interface ForeignSubtreeExecutionOwningRenderer {
+    readonly name: string;
+    renderComponentWithForeignChildren(input: ComponentRenderInput): Promise<ComponentRenderResult>;
+    renderForeignSubtree(input: ComponentRenderInput): Promise<ForeignSubtreeRenderPayload>;
+}
+export interface ForeignSubtreeExecutionDecisionInput {
+    currentIntegration: string;
+    targetIntegration?: string;
+}
+export interface ForeignSubtreeExecutionRenderOptions {
+    currentIntegrationName: string;
+    input: ComponentRenderInput;
+    renderComponent(input: ComponentRenderInput): Promise<ComponentRenderResult>;
+    normalizeComponentRenderOutput(result: ComponentRenderResult): ComponentRenderResult;
+    hasForeignChildDescendants(component: EcoComponent): boolean;
+    createForeignChildRuntime(options: {
+        renderInput: ComponentRenderInput;
+        rendererCache: Map<string, ForeignSubtreeExecutionOwningRenderer>;
+    }): ForeignChildRuntime;
+    getOwningRenderer(integrationName: string, rendererCache: Map<string, ForeignSubtreeExecutionOwningRenderer>): ForeignSubtreeExecutionOwningRenderer;
+}
+export interface ForeignSubtreeQueuedRuntimeOptions<TContext extends QueuedForeignSubtreeResolutionContext> {
+    renderInput: ComponentRenderInput;
+    rendererCache: Map<string, ForeignSubtreeExecutionOwningRenderer>;
+    runtimeContextKey: string;
+    tokenPrefix: string;
+    createRuntimeContext?: (integrationContext: BaseIntegrationContext & Record<string, unknown>, rendererCache: Map<string, unknown>) => TContext;
+}
+export interface ForeignSubtreeStringQueuedHtmlOptions {
+    currentIntegrationName: string;
+    renderInput: ComponentRenderInput;
+    html: string;
+    runtimeContextKey: string;
+    queueLabel: string;
+    getOwningRenderer(integrationName: string, rendererCache: Map<string, ForeignSubtreeExecutionOwningRenderer>): ForeignSubtreeExecutionOwningRenderer;
+    applyAttributesToFirstElement(html: string, attributes: Record<string, string>): string;
+    dedupeProcessedAssets(assets: ProcessedAsset[]): ProcessedAsset[];
+}
+export interface ForeignSubtreeQueuedHtmlOptions<TContext extends QueuedForeignSubtreeResolutionContext> {
+    currentIntegrationName: string;
+    html: string;
+    runtimeContext?: TContext;
+    queueLabel: string;
+    renderQueuedChildren(children: unknown, runtimeContext: TContext, queuedResolutionsByToken: Map<string, QueuedForeignSubtreeResolution>, resolveToken: (token: string) => Promise<string>): Promise<{
+        assets: ProcessedAsset[];
+        children?: unknown;
+        html?: string;
+    }>;
+    getOwningRenderer(integrationName: string, rendererCache: Map<string, ForeignSubtreeExecutionOwningRenderer>): ForeignSubtreeExecutionOwningRenderer;
+    applyAttributesToFirstElement(html: string, attributes: Record<string, string>): string;
+    dedupeProcessedAssets(assets: ProcessedAsset[]): ProcessedAsset[];
+}
+/**
+ * Executes one component render tree under Foreign Child support.
+ *
+ * This service owns the execution policy for mixed-integration component trees:
+ * it decides when a child stays inline, when it must delegate to an owning
+ * renderer, how one render-pass renderer cache is reused, and how queued
+ * Foreign Subtree tokens resolve back into final HTML.
+ */
+export declare class ForeignSubtreeExecutionService {
+    private readonly queuedForeignSubtreeResolutionService;
+    constructor(queuedForeignSubtreeResolutionService?: QueuedForeignSubtreeResolutionService);
+    private requiresForeignChildRuntime;
+    /**
+     * Returns whether the current render pass must hand the child off to a foreign owner.
+     */
+    shouldDelegateForeignChild(input: ForeignSubtreeExecutionDecisionInput): boolean;
+    /**
+     * Creates the base runtime used when a renderer has not supplied its own queueing runtime.
+     *
+     * The runtime allows same-integration children to continue inline and fails fast
+     * when execution crosses into a foreign owner without a renderer-owned handoff.
+     */
+    createFailFastRuntime(rendererName: string): ForeignChildRuntime;
+    getQueuedRuntimeContext<TContext extends QueuedForeignSubtreeResolutionContext>(input: ComponentRenderInput, runtimeContextKey: string): TContext | undefined;
+    createQueuedRuntime<TContext extends QueuedForeignSubtreeResolutionContext>(options: ForeignSubtreeQueuedRuntimeOptions<TContext>): ForeignChildRuntime;
+    /**
+     * Resolves a string-first renderer HTML fragment that may contain queued Foreign Subtree tokens.
+     */
+    resolveStringQueuedHtml<TContext extends QueuedForeignSubtreeResolutionContext>(options: ForeignSubtreeStringQueuedHtmlOptions): Promise<{
+        assets: ProcessedAsset[];
+        html: string;
+    }>;
+    resolveQueuedHtml<TContext extends QueuedForeignSubtreeResolutionContext>(options: ForeignSubtreeQueuedHtmlOptions<TContext>): Promise<{
+        assets: ProcessedAsset[];
+        html: string;
+    }>;
+    /**
+     * Executes one component render with Foreign Child support under the current integration.
+     */
+    executeComponentRender(options: ForeignSubtreeExecutionRenderOptions): Promise<ComponentRenderResult>;
+    private getRendererCache;
+    private withRendererCache;
+    /**
+     * Returns the delegatable owning renderer integration for one component.
+     *
+     * The pseudo `html` integration marks document-shell ownership only and does
+     * not participate in component-level foreign subtree execution.
+     */
+    private getForeignOwnerIntegrationName;
+    private resolveForeignChildInOwningRenderer;
+    private resolveForeignSubtreeInOwningRenderer;
+    private runInForeignOwningRenderer;
+    resolveQueuedTokens(html: string, queuedResolutionsByToken: Map<string, QueuedForeignSubtreeResolution>, resolveToken: (token: string) => Promise<string>): Promise<string>;
+}