@vmz/core 0.0.3 → 0.1.0

package/dist/dom-ssr.d.ts

@@ -0,0 +1,78 @@
+/**
+ * VMZ DOM SSR / hydrate / resume — precise patches, no VDOM diff.
+ * Imports client DOM primitives from ./dom-core.js for tree-shakeable browser entry.
+ */
+/**
+ * @param {new (props?: object) => any} Component
+ * @param {object} [props]
+ */
+export declare function renderToString(Component: any, props?: {}, opts?: {}): Promise<any>;
+/**
+ * Stream SSR via the same Direct serialize schedule as `renderToString`.
+ * Yields HTML chunks (open tag → children → close). Joining chunks equals `renderToString`.
+ * Supports AbortSignal for cancel; consumers should respect backpressure (await between chunks).
+ * @param {new (props?: object) => any} Component
+ * @param {object} [props]
+ * @param {{ signal?: AbortSignal, slotHtml?: string }} [opts]
+ * @returns {AsyncGenerator<string, void, void>}
+ */
+export declare function renderToStream(Component: any, props?: {}, opts?: {}): AsyncGenerator<any, void, unknown>;
+/**
+ * Live-DOM counterpart: first default `<slot>` owned by this tree, not by a nested
+ * `[data-vmz]` component (Button/Link labels, etc.).
+ * @param {Element | null | undefined} root
+ * @returns {Element | null}
+ */
+export declare function findOwnedDefaultSlot(root: any): any;
+/**
+ * Hydrate/mount a file-route page inside an optional layout chain (outer → inner).
+ * Mirrors SSR `slotHtml` wrapping: each layout's owned default slot becomes the
+ * outlet for the next layout or the page. Retains layout instances on `container`
+ * so SPA transitions can dispose only the page host.
+ * @param {new (props?: object) => any} Page
+ * @param {Element} container
+ * @param {object} [props]
+ * @param {Array<new (props?: object) => any>} [layoutCtors] outer → inner
+ * @param {{ preserveState?: boolean | Record<string, unknown>, skipOnMount?: boolean }} [opts]
+ */
+export declare function hydrateRoute(Page: any, container: any, props?: {}, layoutCtors?: any[], opts?: {}): Promise<any>;
+/**
+ * SPA same-layout transition: dispose only the page host, keep layout instances.
+ * Callers must verify `data-vmz-layout` is unchanged before using this.
+ * @param {new (props?: object) => any} Page
+ * @param {Element} container `#app` that already has `__vmzPageHost` / `__vmzLayoutInsts`
+ * @param {object} [props]
+ * @param {{ preserveState?: boolean | Record<string, unknown>, skipOnMount?: boolean }} [opts]
+ */
+export declare function hydrateRoutePage(Page: any, container: any, props?: {}, opts?: {}): Promise<any>;
+/**
+ * resume: attach to existing Island DOM without re-running construct structure or onMount.
+ * Consumes ResumeEntry product (`data-vmz-resume`) derived from the same Execution Plan.
+ * @param {new (props?: object) => any} Component
+ * @param {HTMLElement} container
+ * @param {{ props?: object, state?: Record<string, unknown>, strategy?: string } | null} [slice]
+ */
+export declare function resume(Component: any, container: any, slice?: any): Promise<any>;
+/**
+ * Resume all `[data-vmz-island]` hosts (prefer ResumeEntry / EventEntry over mount).
+ * Event strategy islands wait for the DOM event before attach (lazy EventEntry).
+ * @param {ParentNode} [root]
+ */
+export declare function resumeIslands(root?: Document): void;
+/**
+ * EventEntry attach: only wire `client:event` / `client:event:*` islands.
+ * Idle/load/visible ResumeEntries are left alone (static shell can defer framework work).
+ * @param {ParentNode} [root]
+ */
+export declare function attachEventEntries(root?: Document): void;
+/**
+ * @param {new (props?: object) => any} Component
+ * @param {HTMLElement} container
+ * @param {object} [props]
+ * @param {{ preserveState?: boolean | Record<string, unknown>, skipOnMount?: boolean }} [opts]
+ */
+export declare function hydrate(Component: any, container: any, props?: {}, opts?: {}): Promise<any>;
+/**
+ * @param {ParentNode} [root]
+ */
+export declare function hydrateIslands(root?: Document): void;