@rededor/cura-hydrate 0.5.4 → 1.0.0-alpha.0

package/index.d.ts

@@ -1,4 +1,6 @@
-// Generated by dts-bundle-generator v7.2.0
+// Generated by dts-bundle-generator v9.5.1
+
+import { Readable } from 'node:stream';
 
 export declare function createWindowFromHtml(templateHtml: string, uniqueId: string): any;
 export interface HydrateDocumentOptions {
@@ -14,7 +16,7 @@ export interface HydrateDocumentOptions {
 	 */
 	canonicalUrl?: string;
 	/**
-	 * Include the HTML comments and attributes used by the clientside
+	 * Include the HTML comments and attributes used by the client-side
 	 * JavaScript to read the structure of the HTML and rebuild each
 	 * component. Defaults to `true`.
 	 */
@@ -35,7 +37,7 @@ export interface HydrateDocumentOptions {
 	direction?: string;
 	/**
 	 * Component tag names listed here will not be prerendered, nor will
-	 * hydrated on the clientside. Components listed here will be ignored
+	 * hydrated on the client-side. Components listed here will be ignored
 	 * as custom elements and treated no differently than a `<div>`.
 	 */
 	excludeComponents?: string[];
@@ -68,11 +70,11 @@ export interface HydrateDocumentOptions {
 	 */
 	runtimeLogging?: boolean;
 	/**
-	 * Component tags listed here will only be prerendered or serverside-rendered
-	 * and will not be clientside hydrated. This is useful for components that
+	 * Component tags listed here will only be prerendered or server-side-rendered
+	 * and will not be client-side hydrated. This is useful for components that
 	 * are not dynamic and do not need to be defined as a custom element within the
 	 * browser. For example, a header or footer component would be a good example that
-	 * may not require any clientside JavaScript.
+	 * may not require any client-side JavaScript.
 	 */
 	staticComponents?: string[];
 	/**
@@ -134,6 +136,19 @@ export interface SerializeDocumentOptions extends HydrateDocumentOptions {
 	 * Remove HTML comments. Defaults to `true`.
 	 */
 	removeHtmlComments?: boolean;
+	/**
+	 * If set to `false` Stencil will ignore the fact that a component has a `shadow: true`
+	 * flag and serializes it as a scoped component. If set to `true` the component will
+	 * be rendered within a Declarative Shadow DOM.
+	 * @default false
+	 */
+	serializeShadowRoot?: boolean;
+	/**
+	 * The `fullDocument` flag determines the format of the rendered output. Set it to true to
+	 * generate a complete HTML document, or false to render only the component.
+	 * @default true
+	 */
+	fullDocument?: boolean;
 }
 export interface HydrateFactoryOptions extends SerializeDocumentOptions {
 	serializeToHtml: boolean;
@@ -157,7 +172,7 @@ export interface Diagnostic {
 export interface PrintLine {
 	lineIndex: number;
 	lineNumber: number;
-	text?: string;
+	text: string;
 	errorCharStart: number;
 	errorLength?: number;
 }
@@ -165,23 +180,23 @@ export interface HydrateResults {
 	buildId: string;
 	diagnostics: Diagnostic[];
 	url: string;
-	host: string;
-	hostname: string;
-	href: string;
-	port: string;
-	pathname: string;
-	search: string;
-	hash: string;
-	html: string;
+	host: string | null;
+	hostname: string | null;
+	href: string | null;
+	port: string | null;
+	pathname: string | null;
+	search: string | null;
+	hash: string | null;
+	html: string | null;
 	components: HydrateComponent[];
 	anchors: HydrateAnchorElement[];
 	imgs: HydrateImgElement[];
 	scripts: HydrateScriptElement[];
 	styles: HydrateStyleElement[];
 	staticData: HydrateStaticData[];
-	title: string;
+	title: string | null;
 	hydratedCount: number;
-	httpStatus: number;
+	httpStatus: number | null;
 }
 export interface HydrateComponent {
 	tag: string;
@@ -211,8 +226,11 @@ export interface HydrateStaticData {
 	type: string;
 	content: string;
 }
+export declare function streamToString(html: string | any, option?: SerializeDocumentOptions): Readable;
 export declare function renderToString(html: string | any, options?: SerializeDocumentOptions): Promise<HydrateResults>;
+export declare function renderToString(html: string | any, options: SerializeDocumentOptions | undefined, asStream: true): Readable;
 export declare function hydrateDocument(doc: any | string, options?: HydrateDocumentOptions): Promise<HydrateResults>;
-export declare function serializeDocumentToString(doc: any, opts: HydrateFactoryOptions): string;
+export declare function hydrateDocument(doc: any | string, options: HydrateDocumentOptions | undefined, asStream?: boolean): Readable;
+export declare function serializeDocumentToString(doc: Document, opts: HydrateFactoryOptions): string;
 
 export {};