@ecopages/lit 0.2.1 → 0.3.0

package/src/lit-renderer.js

@@ -1,284 +1,116 @@
-import "@lit-labs/ssr/lib/install-global-dom-shim.js";
-import { IntegrationRenderer } from "@ecopages/core/route-renderer/integration-renderer";
-import { render } from "@lit-labs/ssr";
-import { html as staticHtml, unsafeStatic } from "lit/static-html.js";
-import { LitSsrLazyPreloader } from "./lit-ssr-lazy-preloader.js";
-import { PLUGIN_NAME } from "./lit.plugin.js";
-const HTML_TEMPLATE_SLOT_MARKER = "<--content-->";
-const COMPONENT_CHILDREN_SLOT_MARKER = "<!--eco-lit-component-children-->";
-const ESCAPED_COMPONENT_CHILDREN_SLOT_MARKER = "&lt;!--eco-lit-component-children--&gt;";
-const DOUBLE_ESCAPED_COMPONENT_CHILDREN_SLOT_MARKER = "&amp;lt;!--eco-lit-component-children--&amp;gt;";
-const DUPLICATE_DECLARATIVE_SHADOW_ROOT_ATTRIBUTE = /\sshadowroot=(['"])(open|closed)\1(?=\sshadowrootmode=\1\2\1)/g;
-class LitRenderer extends IntegrationRenderer {
-  name = PLUGIN_NAME;
-  async resolveQueuedBoundaryChildren(children, queuedResolutionsByToken, resolveToken) {
-    if (children === void 0) {
-      return void 0;
-    }
-    let renderedChildren = typeof children === "string" ? children : await this.renderValueToString(children);
-    renderedChildren = await this.resolveQueuedBoundaryTokens(
-      renderedChildren,
-      queuedResolutionsByToken,
-      resolveToken
-    );
-    return renderedChildren;
-  }
-  async resolveQueuedBoundaryHtml(html, runtimeContext) {
-    const queuedBoundaryResolution = await this.resolveRendererOwnedQueuedBoundaryHtml({
-      html,
-      runtimeContext,
-      queueLabel: "Lit",
-      renderQueuedChildren: async (children, _runtimeContext, queuedResolutionsByToken, resolveToken) => {
-        const renderedChildren = await this.resolveQueuedBoundaryChildren(
-          children,
-          queuedResolutionsByToken,
-          resolveToken
-        );
+/**
+ * This module contains the Lit renderer hooks.
+ * @module
+ */
+import { createIntegrationRenderer } from '@ecopages/core/integration';
+import { resolveQueuedTokens } from '@ecopages/core/integration';
+import { CUSTOM_ELEMENT_SSR_PRELOAD_CACHE_SCOPES, CustomElementScriptPreloader, } from '@ecopages/core/integration';
+import { requireAppRuntime } from '@ecopages/core/integration';
+import { createCustomElementServerModuleImporter } from '@ecopages/core/integration';
+import { ensureLitDomShim } from './dom-shim.js';
+import { LIT_PLUGIN_NAME } from './lit.constants.js';
+import { injectLitRenderedChildren, LIT_COMPONENT_CHILDREN_SLOT_MARKER, normalizeLitHtml, renderLitValueToString, } from './utils/lit-html-rendering.js';
+/**
+ * Creates the Lit renderer class with a lazy worker-session lookup.
+ *
+ * @remarks
+ * The plugin may create its renderer before `setup()` assigns the static render session, so hooks read the
+ * session when they run instead of capturing its construction-time value.
+ */
+export function createLitRenderer(getRenderSession = () => undefined) {
+    return createIntegrationRenderer(LIT_PLUGIN_NAME, ({ appConfig, resolveComponentDependencies, resolveDependencyPath }) => {
+        const ssrScriptPreloader = new CustomElementScriptPreloader({
+            cacheScope: CUSTOM_ELEMENT_SSR_PRELOAD_CACHE_SCOPES.lit,
+            preloadScopes: requireAppRuntime(appConfig).customElementSsrPreloadScopes,
+            logLabel: 'lit',
+            requireLazyScriptEntry: true,
+            resolveDependencyPath,
+            importServerModule: createCustomElementServerModuleImporter(appConfig, '.lit-ssr'),
+        });
+        const preloadSsrScripts = async (components) => {
+            ensureLitDomShim();
+            const renderSession = getRenderSession();
+            if (renderSession) {
+                await renderSession.preloadSsrScripts(components);
+                return;
+            }
+            await ssrScriptPreloader.preloadSsrScripts(components);
+        };
         return {
-          assets: [],
-          html: renderedChildren
+            beforeRender: async (renderOptions) => preloadSsrScripts([
+                renderOptions.Page,
+                renderOptions.Layout,
+                ...(renderOptions.pageDependencyComponents ?? []),
+            ]),
+            transformDocumentHtml: normalizeLitHtml,
+            renderRemote: (routeOptions) => renderLitPageInWorker(routeOptions, getRenderSession),
+            renderComponent: async (input) => {
+                await preloadSsrScripts([input.component]);
+                if (!isFunctionComponent(input.component)) {
+                    throw new TypeError('Lit renderer expected a callable component.');
+                }
+                const component = input.component;
+                let renderedChildren;
+                if (input.children !== undefined) {
+                    renderedChildren =
+                        typeof input.children === 'string'
+                            ? input.children
+                            : await renderLitValueToString(input.children);
+                }
+                const props = renderedChildren === undefined
+                    ? input.props
+                    : {
+                        ...input.props,
+                        children: LIT_COMPONENT_CHILDREN_SLOT_MARKER,
+                    };
+                const content = await component(props);
+                const renderedHtml = await renderLitValueToString(content);
+                const html = renderedChildren === undefined
+                    ? renderedHtml
+                    : injectLitRenderedChildren(renderedHtml, renderedChildren);
+                const assets = input.component.config?.dependencies
+                    ? await resolveComponentDependencies([input.component])
+                    : undefined;
+                return {
+                    html,
+                    canAttachAttributes: true,
+                    integrationName: LIT_PLUGIN_NAME,
+                    assets,
+                };
+            },
+            renderQueuedChildren: async (children, _runtimeContext, queuedResolutionsByToken, resolveToken) => {
+                if (children === undefined) {
+                    return {};
+                }
+                if (typeof children !== 'string') {
+                    return { children };
+                }
+                return { html: await resolveQueuedTokens(children, queuedResolutionsByToken, resolveToken) };
+            },
         };
-      }
-    });
-    return {
-      html: queuedBoundaryResolution.html,
-      assets: queuedBoundaryResolution.assets.length > 0 ? queuedBoundaryResolution.assets : void 0
-    };
-  }
-  normalizeDeclarativeShadowRootMarkup(markup) {
-    return markup.replace(DUPLICATE_DECLARATIVE_SHADOW_ROOT_ATTRIBUTE, "");
-  }
-  createRenderableMarkup(markup) {
-    return staticHtml`${unsafeStatic(markup)}`;
-  }
-  shouldRenderPageComponent() {
-    return false;
-  }
-  async renderMarkupToString(markup) {
-    let renderedHtml = "";
-    for (const chunk of render(this.createRenderableMarkup(markup))) {
-      renderedHtml += chunk;
-    }
-    return this.normalizeDeclarativeShadowRootMarkup(renderedHtml);
-  }
-  async renderValueToString(value) {
-    if (typeof value === "string") {
-      return await this.renderMarkupToString(value);
-    }
-    let renderedHtml = "";
-    for (const chunk of render(value)) {
-      renderedHtml += chunk;
-    }
-    return this.normalizeDeclarativeShadowRootMarkup(renderedHtml);
-  }
-  isLitManagedComponent(component) {
-    return component?.config?.integration === this.name || component?.config?.__eco?.integration === this.name;
-  }
-  injectRenderedChildren(template, renderedChildren) {
-    for (const marker of [
-      COMPONENT_CHILDREN_SLOT_MARKER,
-      ESCAPED_COMPONENT_CHILDREN_SLOT_MARKER,
-      DOUBLE_ESCAPED_COMPONENT_CHILDREN_SLOT_MARKER
-    ]) {
-      if (template.includes(marker)) {
-        return template.split(marker).join(renderedChildren);
-      }
-    }
-    if (template.includes(HTML_TEMPLATE_SLOT_MARKER)) {
-      return template.split(HTML_TEMPLATE_SLOT_MARKER).join(renderedChildren);
-    }
-    if (template.includes("</body>")) {
-      return template.replace("</body>", `${renderedChildren}</body>`);
-    }
-    if (template.includes("</html>")) {
-      return template.replace("</html>", `${renderedChildren}</html>`);
-    }
-    return `${template}${renderedChildren}`;
-  }
-  async renderHtmlTemplate(options) {
-    if (!options.isLitManagedHtmlTemplate) {
-      return String(
-        await options.HtmlTemplate({
-          metadata: options.metadata,
-          children: options.renderedChildren,
-          pageProps: options.pageProps
-        })
-      );
-    }
-    const template = await options.HtmlTemplate({
-      metadata: options.metadata,
-      children: HTML_TEMPLATE_SLOT_MARKER,
-      pageProps: options.pageProps
     });
-    return this.injectRenderedChildren(String(template), options.renderedChildren);
-  }
-  /**
-   * Renders a Lit component boundary for component-level orchestration.
-   *
-   * SSR-eligible lazy scripts are preloaded first so custom elements registered
-   * by the component can render their server markup even when the Lit renderer is
-   * entered through cross-integration boundary handoff.
-   *
-   * Includes component-scoped dependency assets when declared.
-   */
-  async renderComponent(input) {
-    await this.preloadSsrLazyScripts([input.component]);
-    const component = input.component;
-    let renderedChildren;
-    if (input.children !== void 0) {
-      renderedChildren = typeof input.children === "string" ? input.children : await this.renderValueToString(input.children);
-    }
-    let props = input.props;
-    if (renderedChildren !== void 0) {
-      props = {
-        ...input.props,
-        children: COMPONENT_CHILDREN_SLOT_MARKER
-      };
+}
+export const LitRenderer = createLitRenderer();
+function isFunctionComponent(component) {
+    return typeof component === 'function';
+}
+/**
+ * Renders a Lit page route in its build-scoped worker when request data can cross the worker boundary.
+ *
+ * @remarks
+ * Locals and explicit props stay in-process: locals are request objects, and the worker re-imports the route module.
+ */
+async function renderLitPageInWorker(options, getRenderSession) {
+    const renderSession = getRenderSession();
+    if (!renderSession || options.locals !== undefined || options.props !== undefined) {
+        return undefined;
     }
-    const content = await component(props);
-    const renderedHtml = await this.renderValueToString(content);
-    const html = renderedChildren === void 0 ? renderedHtml : this.injectRenderedChildren(renderedHtml, renderedChildren);
-    const queuedBoundaryResolution = await this.resolveQueuedBoundaryHtml(
-      html,
-      this.getQueuedBoundaryRuntime(input)
-    );
-    const hasDependencies = Boolean(input.component.config?.dependencies);
-    const canResolveAssets = typeof this.assetProcessingService?.processDependencies === "function";
-    const assets = hasDependencies && canResolveAssets ? await this.processComponentDependencies([input.component]) : void 0;
-    return {
-      html: queuedBoundaryResolution.html,
-      canAttachAttributes: true,
-      rootTag: this.getRootTagName(queuedBoundaryResolution.html),
-      integrationName: this.name,
-      assets: this.htmlTransformer.dedupeProcessedAssets([
-        ...assets ?? [],
-        ...queuedBoundaryResolution.assets ?? []
-      ])
-    };
-  }
-  createComponentBoundaryRuntime(options) {
-    return this.createQueuedBoundaryRuntime({
-      boundaryInput: options.boundaryInput,
-      rendererCache: options.rendererCache
+    const params = options.params ?? {};
+    const result = await renderSession.renderPageInWorker({
+        filePath: options.file,
+        params,
+        query: options.query,
     });
-  }
-  ssrLazyPreloader = new LitSsrLazyPreloader({
-    resolveDependencyPath: this.resolveDependencyPath.bind(this),
-    processDependencies: this.assetProcessingService?.processDependencies?.bind(this.assetProcessingService)
-  });
-  /**
-   * Detects preload failures that are expected for browser-only modules.
-   *
-   * These errors are treated as non-fatal during SSR preload because some
-   * lazy client scripts intentionally depend on browser globals.
-   */
-  isExpectedSsrPreloadError(error) {
-    return this.ssrLazyPreloader.isExpectedSsrPreloadError(error);
-  }
-  /**
-   * Collects lazy script file paths eligible for SSR preloading.
-   *
-   * Only per-entry lazy script dependencies with `ssr: true` are collected.
-   * File-backed entries are required (`src` must be present);
-   * inline content lazy entries are intentionally skipped.
-   */
-  collectSsrPreloadScripts(components) {
-    return this.ssrLazyPreloader.collectSsrPreloadScripts(components);
-  }
-  /**
-   * Preloads SSR-eligible lazy scripts to register custom elements before render.
-   */
-  async preloadSsrLazyScripts(components) {
-    await this.ssrLazyPreloader.preloadSsrLazyScripts(components);
-  }
-  /**
-   * Resolves the concrete JS entrypoint used for SSR preloading.
-   *
-   * Scripts are passed through the asset pipeline so preload imports can use
-   * the same processed output shape as runtime dependencies.
-   */
-  async resolveSsrPreloadEntrypoint(scriptPath) {
-    return this.ssrLazyPreloader.resolveSsrPreloadEntrypoint(scriptPath);
-  }
-  async render({
-    params,
-    query,
-    props,
-    locals,
-    metadata,
-    Page,
-    Layout,
-    HtmlTemplate
-  }) {
-    try {
-      await this.preloadSsrLazyScripts([Page, Layout]);
-      return await this.renderPageWithDocumentShell({
-        page: {
-          component: Page,
-          props: {
-            params,
-            query,
-            ...props,
-            locals
-          }
-        },
-        layout: Layout ? {
-          component: Layout,
-          props: locals ? { locals } : {}
-        } : void 0,
-        htmlTemplate: HtmlTemplate,
-        metadata,
-        pageProps: props || {},
-        transformDocumentHtml: (html) => this.normalizeDeclarativeShadowRootMarkup(html)
-      });
-    } catch (error) {
-      throw this.createRenderError("Error rendering page", error);
-    }
-  }
-  async renderToResponse(view, props, ctx) {
-    try {
-      if (ctx.partial) {
-        return this.renderPartialViewResponse({
-          view,
-          props,
-          ctx,
-          transformHtml: (html) => this.normalizeDeclarativeShadowRootMarkup(html)
-        });
-      }
-      const viewConfig = view.config;
-      const Layout = viewConfig?.layout;
-      const HtmlTemplate = await this.getHtmlTemplate();
-      const metadata = await this.resolveViewMetadata(view, props);
-      await this.preloadSsrLazyScripts([view, Layout]);
-      await this.prepareViewDependencies(view, Layout);
-      const pageRender = await this.renderComponentBoundary({
-        component: view,
-        props: props ?? {}
-      });
-      const layoutRender = Layout ? await this.renderComponentBoundary({
-        component: Layout,
-        props: {},
-        children: pageRender.html
-      }) : void 0;
-      const documentRender = await this.renderComponentBoundary({
-        component: HtmlTemplate,
-        props: {
-          metadata,
-          pageProps: props ?? {}
-        },
-        children: layoutRender?.html ?? pageRender.html
-      });
-      this.appendProcessedDependencies(pageRender.assets, layoutRender?.assets, documentRender.assets);
-      const body = await this.finalizeResolvedHtml({
-        html: `${this.DOC_TYPE}${this.normalizeDeclarativeShadowRootMarkup(documentRender.html)}`,
-        partial: false
-      });
-      return this.createHtmlResponse(body, ctx);
-    } catch (error) {
-      throw this.createRenderError("Error rendering view", error);
-    }
-  }
+    const { html, ...metadata } = result;
+    return { body: html, ...metadata };
 }
-export {
-  LitRenderer
-};

package/src/lit-static-render-protocol.d.ts

@@ -0,0 +1,40 @@
+import type { PageParams, PageQuery } from '@ecopages/core';
+import type { RouteRenderResult } from '@ecopages/core/integration';
+/** A rendered page, its resolved metadata, and what the main thread needs to cache it. */
+export type LitStaticRenderResult = Pick<RouteRenderResult, 'cacheStrategy' | 'sourceDependencyPaths' | 'metadata'> & {
+    html: string;
+};
+export type LitStaticRenderWorkerInitMessage = {
+    type: 'init';
+    configModulePath: string;
+    runtimeOrigin: string;
+};
+export type LitStaticRenderWorkerRenderMessage = {
+    type: 'render';
+    id: string;
+    filePath: string;
+    /** Route params; multi-value keys stay as `string[]`. */
+    params: PageParams;
+    /** Serializable route query; preserves multi-value keys as `string[]`. */
+    query?: PageQuery;
+};
+export type LitStaticRenderWorkerShutdownMessage = {
+    type: 'shutdown';
+};
+export type LitStaticRenderWorkerRequestMessage = LitStaticRenderWorkerInitMessage | LitStaticRenderWorkerRenderMessage | LitStaticRenderWorkerShutdownMessage;
+export type LitStaticRenderWorkerReadyMessage = {
+    type: 'ready';
+};
+export type LitStaticRenderWorkerResultMessage = {
+    type: 'result';
+    id: string;
+} & LitStaticRenderResult;
+export type LitStaticRenderWorkerErrorMessage = {
+    type: 'error';
+    id?: string;
+    message: string;
+};
+export type LitStaticRenderWorkerShutdownCompleteMessage = {
+    type: 'shutdown-complete';
+};
+export type LitStaticRenderWorkerResponseMessage = LitStaticRenderWorkerReadyMessage | LitStaticRenderWorkerResultMessage | LitStaticRenderWorkerErrorMessage | LitStaticRenderWorkerShutdownCompleteMessage;

package/src/lit-static-render-protocol.js

@@ -0,0 +1 @@
+export {};

package/src/lit-static-render-result.d.ts

@@ -0,0 +1,10 @@
+import type { RouteRenderResult } from '@ecopages/core/integration';
+import type { LitStaticRenderResult } from './lit-static-render-protocol.js';
+/**
+ * Turns a route render into the message the worker posts back to the main thread.
+ *
+ * @remarks
+ * The resolved `metadata` travels with the HTML so the main thread can decide sitemap eligibility
+ * from the render instead of loading the page again.
+ */
+export declare function toLitStaticRenderResult(result: RouteRenderResult): Promise<LitStaticRenderResult>;

package/src/lit-static-render-result.js

@@ -0,0 +1,21 @@
+/**
+ * Turns a route render into the message the worker posts back to the main thread.
+ *
+ * @remarks
+ * The resolved `metadata` travels with the HTML so the main thread can decide sitemap eligibility
+ * from the render instead of loading the page again.
+ */
+export async function toLitStaticRenderResult(result) {
+    const { body, cacheStrategy, sourceDependencyPaths, metadata } = result;
+    const rendered = { cacheStrategy, sourceDependencyPaths, metadata };
+    if (typeof body === 'string') {
+        return { html: body, ...rendered };
+    }
+    if (Buffer.isBuffer(body)) {
+        return { html: body.toString('utf8'), ...rendered };
+    }
+    if (body instanceof ReadableStream) {
+        return { html: await new Response(body).text(), ...rendered };
+    }
+    throw new TypeError(`Unsupported Lit static render body type: ${typeof body}`);
+}

package/src/lit-static-render-session.d.ts

@@ -0,0 +1,65 @@
+import type { PageParams, PageQuery } from '@ecopages/core';
+import type { StaticExportContext } from '@ecopages/core/integration';
+import { type CustomElementSsrPreloadComponent } from '@ecopages/core/integration';
+import type { CustomElementScriptPreloadScopeState } from '@ecopages/core/integration';
+import { LitStaticRenderWorkerClient } from './lit-static-render-worker-client.js';
+import type { LitStaticRenderResult } from './lit-static-render-protocol.js';
+import type { AssetDefinition, AssetProcessingIntegration, ProcessedAsset } from '@ecopages/core/integration';
+type LitStaticRenderWorkerClientContract = Pick<LitStaticRenderWorkerClient, 'start' | 'renderPage' | 'dispose'>;
+type LitStaticRenderSessionOptions = {
+    preloadScopes: Map<string, CustomElementScriptPreloadScopeState>;
+    integration?: AssetProcessingIntegration;
+    resolveDependencyPath: (componentDir: string, sourcePath: string) => string;
+    processDependencies: (dependencies: AssetDefinition[], integration?: AssetProcessingIntegration) => Promise<ProcessedAsset[]>;
+    getInvalidationVersion?: () => number;
+    createWorkerClient?: (input: {
+        configModulePath: string;
+        runtimeOrigin: string;
+    }) => LitStaticRenderWorkerClientContract;
+};
+/**
+ * Plugin-runtime-scoped Lit server render session.
+ *
+ * @remarks
+ * Owns worker lifecycle and SSR preload for Lit page routes during static export
+ * and runtime/dev requests. Injected into `LitRenderer` via a lazy accessor from
+ * `LitPlugin`; there is no process-global coordinator.
+ *
+ * Worker init identity is sticky for the first `{ configModulePath, runtimeOrigin }`.
+ * Later `ensureWorker` calls with the same identity are no-ops; a different identity
+ * recreates the worker so stale config/origin is never silently reused.
+ */
+export declare class LitStaticRenderSession {
+    private readonly preloader;
+    private readonly createWorkerClient;
+    private workerClient;
+    private workerIdentity;
+    private readonly getInvalidationVersion;
+    private workerInvalidationVersion;
+    private renderChain;
+    constructor(options: LitStaticRenderSessionOptions);
+    /**
+     * Ensures the static render worker is running for the given identity.
+     *
+     * @remarks
+     * First successful start sticks that identity. Matching re-entry is a no-op.
+     * A different `configModulePath` or `runtimeOrigin` disposes and recreates.
+     */
+    ensureWorker(input: {
+        configModulePath: string;
+        runtimeOrigin: string;
+    }): Promise<void>;
+    preloadStaticRoutes(context: StaticExportContext): Promise<void>;
+    preloadSsrScripts(components: Array<CustomElementSsrPreloadComponent | undefined>): Promise<void>;
+    collectSsrPreloadScripts(components: Array<CustomElementSsrPreloadComponent | undefined>): string[];
+    renderPageInWorker(input: {
+        filePath: string;
+        params: PageParams;
+        query?: PageQuery;
+    }): Promise<LitStaticRenderResult>;
+    isExpectedSsrPreloadError(error: unknown): boolean;
+    dispose(): Promise<void>;
+    private preloadLitRoutes;
+    private isLitRoute;
+}
+export {};