@stencil/core 5.0.0-alpha.3 → 5.0.0-alpha.31

package/dist/runtime/server/runner.d.mts

@@ -1,4 +1,6 @@
-import { Readable } from "node:stream";
+import "@stencil/core/app-data";
+import "rolldown";
+import "typescript";
 //#region src/server/runner/create-window.d.ts
 declare function createWindowFromHtml(templateHtml: string, uniqueId: string): any;
 //#endregion
@@ -7,7 +9,7 @@ type ResolutionHandler = (elm: HTMLElement) => string | undefined | null;
 type TagTransformer = (tag: string) => string;
 //#endregion
 //#region src/declarations/stencil-public-compiler.d.ts
-interface HydrateDocumentOptions {
+interface SsrDocumentOptions {
   /**
    * Build ID that will be added to `<html data-stencil-build="BUILD_ID">`. By default
    * a random ID will be generated
@@ -24,7 +26,7 @@ interface HydrateDocumentOptions {
    * JavaScript to read the structure of the HTML and rebuild each
    * component. Defaults to `true`.
    */
-  clientHydrateAnnotations?: boolean;
+  clientSsrAnnotations?: boolean;
   /**
    * Constrain `setTimeout()` to 1ms, but still async. Also
    * only allows `setInterval()` to fire once, also constrained to 1ms.
@@ -123,10 +125,14 @@ interface HydrateDocumentOptions {
     default: 'declarative-shadow-dom' | 'scoped';
   } | boolean;
 }
-interface SerializeDocumentOptions extends HydrateDocumentOptions {
+interface SerializeDocumentOptions extends SsrDocumentOptions {
   /**
    * Runs after the `document` has been hydrated.
    */
+  afterSsr?(document: any): any | Promise<any>;
+  /**
+   * @deprecated Use `afterSsr` instead.
+   */
   afterHydrate?(document: any): any | Promise<any>;
   /**
    * Sets an approximate line width the HTML should attempt to stay within.
@@ -139,6 +145,10 @@ interface SerializeDocumentOptions extends HydrateDocumentOptions {
   /**
    * Runs before the `document` has been hydrated.
    */
+  beforeSsr?(document: any): any | Promise<any>;
+  /**
+   * @deprecated Use `beforeSsr` instead.
+   */
   beforeHydrate?(document: any): any | Promise<any>;
   /**
    * Format the HTML in a nicely indented format.
@@ -176,7 +186,7 @@ interface SerializeDocumentOptions extends HydrateDocumentOptions {
    */
   modes?: ResolutionHandler[];
 }
-interface HydrateFactoryOptions extends SerializeDocumentOptions {
+interface SsrFactoryOptions extends SerializeDocumentOptions {
   serializeToHtml: boolean;
   destroyWindow: boolean;
   destroyDocument: boolean;
@@ -204,7 +214,7 @@ interface PrintLine {
   errorCharStart: number;
   errorLength?: number;
 }
-interface HydrateResults {
+interface SsrResults {
   buildId: string;
   diagnostics: Diagnostic[];
   url: string;
@@ -216,42 +226,42 @@ interface HydrateResults {
   search: string | null;
   hash: string | null;
   html: string | null;
-  components: HydrateComponent[];
-  anchors: HydrateAnchorElement[];
-  imgs: HydrateImgElement[];
-  scripts: HydrateScriptElement[];
-  styles: HydrateStyleElement[];
-  staticData: HydrateStaticData[];
+  components: SsrComponent[];
+  anchors: SsrAnchorElement[];
+  imgs: SsrImgElement[];
+  scripts: SsrScriptElement[];
+  styles: SsrStyleElement[];
+  staticData: SsrStaticData[];
   title: string | null;
   hydratedCount: number;
   httpStatus: number | null;
 }
-interface HydrateComponent {
+interface SsrComponent {
   tag: string;
   mode: string;
   count: number;
   depth: number;
 }
-interface HydrateElement {
+interface SsrElement {
   [attrName: string]: string | undefined;
 }
-interface HydrateAnchorElement extends HydrateElement {
+interface SsrAnchorElement extends SsrElement {
   href?: string;
   target?: string;
 }
-interface HydrateImgElement extends HydrateElement {
+interface SsrImgElement extends SsrElement {
   src?: string;
 }
-interface HydrateScriptElement extends HydrateElement {
+interface SsrScriptElement extends SsrElement {
   src?: string;
   type?: string;
 }
-interface HydrateStyleElement extends HydrateElement {
+interface SsrStyleElement extends SsrElement {
   id?: string;
   href?: string;
   content?: string;
 }
-interface HydrateStaticData {
+interface SsrStaticData {
   id: string;
   type: string;
   content: string;
@@ -265,31 +275,36 @@ interface HydrateStaticData {
  * @param options - serialization options
  * @returns the hydration results
  */
-declare function renderToString(html: string | any, options?: SerializeDocumentOptions): Promise<HydrateResults>;
+declare function renderToString(html: string | any, options?: SerializeDocumentOptions): Promise<SsrResults>;
 /**
- * Renders HTML and returns a Node.js Readable stream.
- * This is a Node.js-specific convenience wrapper around renderToString.
- * Note: This function requires Node.js and cannot be used in QuickJS/WASM environments.
+ * Renders HTML and returns a web-standard ReadableStream.
+ * Works in Node 22+, Cloudflare Workers, Deno, Bun, and any WinterCG-compatible runtime.
  * @param html - the HTML string or document to render
  * @param options - serialization options
- * @returns a Node.js Readable stream
+ * @returns a ReadableStream
  */
-declare function streamToString(html: string | any, options?: SerializeDocumentOptions): Readable;
+declare function streamToString(html: string | any, options?: SerializeDocumentOptions): ReadableStream<string>;
 /**
- * Hydrates a document or HTML string, returning the full hydration results.
+ * Server side renders a document or HTML string, returning the full render results.
  * This is portable (no Node.js dependencies).
- * @param doc - the document or HTML string to hydrate
+ * @param doc - the document or HTML string to render
  * @param options - hydration options
- * @returns the hydration results
+ * @returns the render results
+ */
+declare function ssrDocument(doc: any | string, options?: SsrDocumentOptions): Promise<SsrResults>;
+/**
+ * v4 Compat
+ * @alias
+ * @deprecated Use `ssrDocument()` instead
  */
-declare function hydrateDocument(doc: any | string, options?: HydrateDocumentOptions): Promise<HydrateResults>;
-declare function serializeDocumentToString(doc: Document, opts: HydrateFactoryOptions): string;
+declare const hydrateDocument: typeof ssrDocument;
+declare function serializeDocumentToString(doc: Document, opts: SsrFactoryOptions): string;
 //#endregion
 //#region src/server/runner/window-initialize.d.ts
 /**
  * Reset the docData counters. Useful for testing to ensure deterministic IDs.
  */
-declare function resetHydrateDocData(): void;
+declare function resetSsrDocData(): void;
 //#endregion
 //#region src/runtime/tag-transform.d.ts
 /**
@@ -304,4 +319,4 @@ declare function transformTag<T extends string>(tag: T): T;
  */
 declare function setTagTransformer(transformer: TagTransformer): void;
 //#endregion
-export { createWindowFromHtml, hydrateDocument, renderToString, resetHydrateDocData, serializeDocumentToString, setTagTransformer, streamToString, transformTag };
+export { createWindowFromHtml, hydrateDocument, renderToString, resetSsrDocData, serializeDocumentToString, setTagTransformer, ssrDocument, streamToString, transformTag };