wasm-html-to-image 1.0.10 → 1.0.11

package/dist/core-orchestrate.d.ts

@@ -42,6 +42,7 @@ export interface Orchestration {
     onLog: HtmlToImageOptions["onLog"];
     diagnostics: boolean;
     onDiagnostics: HtmlToImageOptions["onDiagnostics"];
+    onLayout: HtmlToImageOptions["onLayout"];
     resolveResource: ResolveResourceHook | undefined;
     mediaType: "screen" | "print";
     textToPaths: boolean | undefined;

package/dist/core-orchestrate.js

@@ -34,7 +34,7 @@ export function defaultSpeed(format) {
 }
 /** Build per-call orchestration state (log gate, timings, diag, resolve ctx). */
 export function createOrchestration(module, options) {
-    const { format = "png", quality = 85, speed: speedOption, width, height, crop, fit, value, url, baseUrl, fontMap, userAgent, fallbackFonts, logLevel = LogLevel.None, onLog, diagnostics = false, onDiagnostics, resolveResource, mediaType = "screen", textToPaths, css, fonts: preloadFonts, limits = {}, pdfTitle, pdfAuthor, pdfSubject, pdfKeywords, pdfCreator, pdfProducer, pdfMargin, pdfHeader, pdfFooter, } = options;
+    const { format = "png", quality = 85, speed: speedOption, width, height, crop, fit, value, url, baseUrl, fontMap, userAgent, fallbackFonts, logLevel = LogLevel.None, onLog, diagnostics = false, onDiagnostics, onLayout, resolveResource, mediaType = "screen", textToPaths, css, fonts: preloadFonts, limits = {}, pdfTitle, pdfAuthor, pdfSubject, pdfKeywords, pdfCreator, pdfProducer, pdfMargin, pdfHeader, pdfFooter, } = options;
     // `animation` accepts a boolean (image input: keep frames) or, for HTML
     // input, an object requesting keyframe sampling. The object form turns on
     // the boolean flag for the encode stage and enables the frame path.
@@ -167,6 +167,7 @@ export function createOrchestration(module, options) {
         onLog,
         diagnostics,
         onDiagnostics,
+        onLayout,
         resolveResource,
         mediaType,
         textToPaths,
@@ -407,6 +408,10 @@ export async function tryRunHtmlInstance(module, htmls, satoruOpts, defaultFontM
         await resolveHtmlResources(module, sInst, htmls, width, height, baseUrl, fontMap ?? defaultFontMap, userAgent ?? DEFAULT_USER_AGENT, fallbackFonts, resolveCtx);
         addTime("resolveResources", now() - resolveStart);
         emitLog(LogLevel.Info, "resources resolved");
+        if (orch.onLayout && typeof module.satoru_layout_json === "function") {
+            const page = Array.isArray(htmls) ? htmls[0] : htmls;
+            orch.onLayout(JSON.parse(module.satoru_layout_json(sInst, page, width, height ?? 0, orch.mediaTypeInt)));
+        }
         if (format === "svg" || format === "pdf") {
             const renderStart = now();
             const out = (await renderBinding(sInst, htmls, width, height ?? 0, fmtInt, satoruOpts));

package/dist/core.d.ts

@@ -60,6 +60,21 @@ export interface RenderOptions {
  * - Image input: render stage is skipped; `width`/`height`/`crop`/`fit`
  *   are applied as output resize on the encode stage.
  */
+/** One element's border box from `onLayout` (page coordinates, CSS px). */
+export interface LayoutBox {
+    /** Path of element-child indexes from the root, e.g. "0.1.3". */
+    p: string;
+    /** Lower-case tag name. */
+    t: string;
+    /** `id` attribute ("" when absent). */
+    i: string;
+    /** `class` attribute, truncated ("" when absent). */
+    c: string;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
 export interface HtmlToImageOptions extends RenderOptions {
     /** Encode quality 0-100 (encode stage only, default 85; ignored for svg/pdf). */
     quality?: number;
@@ -127,6 +142,13 @@ export interface HtmlToImageOptions extends RenderOptions {
     diagnostics?: boolean;
     /** Receives the diagnostics report when `diagnostics` is enabled. */
     onDiagnostics?: (report: RenderDiagnostics) => void;
+    /**
+     * Debug aid for comparing against a reference browser: receives every laid-out element's border
+     * box in page coordinates (HTML input only; `html-to-image` instance pipeline). `p` is the
+     * element's path among element children of the shadow-flattened tree ("0.1.3"), so a browser
+     * walk produces the same keys. Inline boxes are omitted except replaced ones (img, svg, ...).
+     */
+    onLayout?: (boxes: LayoutBox[]) => void;
     /**
      * Override hook for resource resolution, applied to every fetch path
      * (discovery fetches, fallback-font URLs, HTML `url` fetch). Return