schema-components 2.0.2 → 2.1.0

package/dist/lit/ssr.d.mts

@@ -0,0 +1,37 @@
+import { TemplateResult } from "lit";
+
+//#region src/lit/ssr.d.ts
+/**
+ * Render a Lit `TemplateResult` to an HTML string, emitting Declarative
+ * Shadow DOM markup for every Custom Element it contains.
+ *
+ * The synchronous variant (`collectResultSync`) is documented to
+ * throw when the underlying render emits async iterables — which
+ * happens whenever a component uses `until`, `asyncReplace`, or
+ * similar async directives. The built-in `<sc-*>` elements never do
+ * this, so the synchronous path is safe for the default use.
+ * Consumer widgets that introduce async behaviour must use the
+ * streaming SSR API directly (out of scope for this entry).
+ *
+ * @example
+ * ```ts
+ * import { html } from "lit";
+ * import "schema-components/lit/registry";  // registers <sc-*>
+ * import { renderShadowedHtml } from "schema-components/lit/ssr";
+ *
+ * const tpl = html`<schema-view .schema=${userSchema} .value=${user}></schema-view>`;
+ * const markup = renderShadowedHtml(tpl);
+ * ```
+ *
+ * @param template - The Lit template to render.
+ * @returns The rendered HTML string with Declarative Shadow DOM
+ *   markup.
+ */
+declare function renderShadowedHtml(template: TemplateResult): string;
+/**
+ * Alias for the more discoverable name, mirroring the React
+ * `renderToString` pattern. Identical to {@link renderShadowedHtml}.
+ */
+declare function renderToString(template: TemplateResult): string;
+//#endregion
+export { renderShadowedHtml, renderToString };