@browserless/pdf 10.10.1 → 10.10.3

package/README.md

@@ -73,6 +73,7 @@ The package applies these optimized defaults:
 | `scale` | `number` | `0.65` | Scale of the webpage rendering (0.1 - 2) |
 | `printBackground` | `boolean` | `true` | Print background graphics |
 | `waitUntil` | `string` | `'auto'` | When to consider navigation done |
+| `waitForDom` | `number` | `0` | DOM stability window in ms (idle is `waitForDom / 10`, `0` disables DOM wait) |
 | `format` | `string` | `'Letter'` | Paper format (A4, Letter, etc.) |
 | `landscape` | `boolean` | `false` | Paper orientation |
 | `width` | `string \| number` | — | Paper width (overrides format) |
@@ -111,9 +112,10 @@ Supported units: `px`, `in`, `cm`, `mm`
 When `waitUntil: 'auto'` (the default), the package:
 
 1. Navigates to the page
-2. Takes a low-quality screenshot to check for white/blank content
-3. If the page appears blank, retries until content is detected
-4. Generates the PDF once content is confirmed
+2. Optionally waits for DOM stability (`waitForDom`, default `0` = disabled)
+3. Takes a low-quality screenshot to check for white/blank content
+4. If the page appears blank, retries until content is detected
+5. Generates the PDF once content is confirmed
 
 This ensures dynamic content (JavaScript-rendered pages) is fully loaded before PDF generation.
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@browserless/pdf",
   "description": "Convert websites to high-quality PDFs with customizable margins, background printing, and optimized scaling.",
   "homepage": "https://browserless.js.org/#/?id=pdfurl-options",
-  "version": "10.10.1",
+  "version": "10.10.3",
   "main": "src",
   "author": {
     "email": "hello@microlink.io",
@@ -30,8 +30,8 @@
     "conversion"
   ],
   "dependencies": {
-    "@browserless/goto": "^10.10.1",
-    "@browserless/screenshot": "^10.10.1",
+    "@browserless/goto": "^10.10.2",
+    "@browserless/screenshot": "^10.10.3",
     "@kikobeats/time-span": "~1.0.11",
     "debug-logfmt": "~1.4.7",
     "pretty-ms": "~7.0.1"
@@ -47,5 +47,5 @@
     "test": "exit 0"
   },
   "license": "MIT",
-  "gitHead": "32f6e72bcb489a83ac9659520a3961aeb97c47b7"
+  "gitHead": "4d2b893e8215a91d830f4471f51c567a53cd6bbb"
 }

package/src/index.js

@@ -1,7 +1,13 @@
 'use strict'
 
 const timeSpan = require('@kikobeats/time-span')({ format: n => Math.round(n) })
-const { isWhiteScreenshot } = require('@browserless/screenshot')
+const pReflect = require('p-reflect')
+const {
+  isWhiteScreenshot,
+  waitForDomStability,
+  resolveWaitForDom,
+  DEFAULT_WAIT_FOR_DOM
+} = require('@browserless/screenshot')
 const debug = require('debug-logfmt')('browserless:pdf')
 const createGoto = require('@browserless/goto')
 
@@ -22,9 +28,17 @@ module.exports = ({ goto, ...gotoOpts } = {}) => {
   return function pdf (page) {
     return async (
       url,
-      { margin = '0.35cm', scale = 0.65, printBackground = true, waitUntil = 'auto', ...opts } = {}
+      {
+        margin = '0.35cm',
+        scale = 0.65,
+        printBackground = true,
+        waitUntil = 'auto',
+        waitForDom = DEFAULT_WAIT_FOR_DOM,
+        ...opts
+      } = {}
     ) => {
       let pdfBuffer
+      const waitForDomOpts = resolveWaitForDom(waitForDom)
 
       const generatePdf = page =>
         page.pdf({
@@ -34,12 +48,26 @@ module.exports = ({ goto, ...gotoOpts } = {}) => {
           scale
         })
 
+      const waitForDomStabilityResult = async page => {
+        if (!waitForDomOpts) return
+
+        const result = await pReflect(page.evaluate(waitForDomStability, waitForDomOpts))
+        debug(
+          'waitForDomStability',
+          result.isRejected
+            ? { ...waitForDomOpts, error: result.reason.message || result.reason }
+            : { ...waitForDomOpts, ...result.value }
+        )
+      }
+
       if (waitUntil !== 'auto') {
         await goto(page, { ...opts, url, waitUntil })
+        await waitForDomStabilityResult(page)
         pdfBuffer = await generatePdf(page)
       } else {
         await goto(page, { ...opts, url, waitUntil, waitUntilAuto })
         async function waitUntilAuto (page) {
+          await waitForDomStabilityResult(page)
           const timeout = goto.timeouts.action(opts.timeout)
           let isWhite = false
           let retry = -1