pdf-creator-node 2.4.0 → 4.0.0

package/dist/createPdf.d.ts

@@ -1,7 +1,7 @@
-import type { FileInfo } from "html-pdf";
 import type { PdfCreateOptions, PdfDocument } from "./types";
+import type { PdfFileInfo } from "./pdfRenderOptions";
 /**
- * Renders the Handlebars template and generates a PDF via html-pdf.
+ * Renders the Handlebars template and generates a PDF via Puppeteer (headless Chromium).
  */
-export declare function create(document: PdfDocument, options: PdfCreateOptions): Promise<Buffer | NodeJS.ReadableStream | FileInfo>;
+export declare function create(document: PdfDocument, options: PdfCreateOptions): Promise<Buffer | NodeJS.ReadableStream | PdfFileInfo>;
 //# sourceMappingURL=createPdf.d.ts.map

package/dist/createPdf.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createPdf.d.ts","sourceRoot":"","sources":["../src/createPdf.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAwB7D;;GAEG;AACH,wBAAgB,MAAM,CACpB,QAAQ,EAAE,WAAW,EACrB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,cAAc,GAAG,QAAQ,CAAC,CA2CpD"}
+{"version":3,"file":"createPdf.d.ts","sourceRoot":"","sources":["../src/createPdf.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAmBtD;;GAEG;AACH,wBAAgB,MAAM,CACpB,QAAQ,EAAE,WAAW,EACrB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,cAAc,GAAG,WAAW,CAAC,CA2BvD"}

package/dist/createPdf.js

@@ -1,14 +1,12 @@
 "use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
 };
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -16,13 +14,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.create = create;
 const handlebars_1 = __importDefault(require("handlebars"));
-const html_pdf_1 = __importDefault(require("html-pdf"));
+const pdfPuppeteer_1 = require("./pdfPuppeteer");
+const pdfChrome_1 = require("./pdfChrome");
 const registerHandlebarsHelpers_1 = require("./registerHandlebarsHelpers");
 const validation_1 = require("./validation");
-function stripHtmlPdfOptions(options) {
-    const { handlebarsHelpers: _h } = options, rest = __rest(options, ["handlebarsHelpers"]);
-    return rest;
-}
 function renderHtml(document, options) {
     const hb = handlebars_1.default.create();
     (0, registerHandlebarsHelpers_1.registerHandlebarsHelpers)(hb);
@@ -40,52 +35,32 @@ function renderHtml(document, options) {
     }
 }
 /**
- * Renders the Handlebars template and generates a PDF via html-pdf.
+ * Renders the Handlebars template and generates a PDF via Puppeteer (headless Chromium).
  */
 function create(document, options) {
-    return new Promise((resolve, reject) => {
+    return (() => __awaiter(this, void 0, void 0, function* () {
         try {
             (0, validation_1.validatePdfDocument)(document);
         }
         catch (e) {
-            reject(e);
-            return;
+            throw e;
         }
         let html;
         try {
             html = renderHtml(document, options);
         }
         catch (e) {
-            reject(e);
-            return;
+            throw e;
         }
-        const pdfOptions = stripHtmlPdfOptions(options);
-        const pdfPromise = html_pdf_1.default.create(html, pdfOptions);
+        const pdfOptions = (0, pdfChrome_1.mergePdfCreateOptions)(options);
+        const buffer = yield (0, pdfPuppeteer_1.renderPdfToBuffer)(html, pdfOptions);
         switch (document.type) {
             case "buffer":
-                pdfPromise.toBuffer((err, res) => {
-                    if (err)
-                        reject(err);
-                    else
-                        resolve(res);
-                });
-                break;
+                return buffer;
             case "stream":
-                pdfPromise.toStream((err, res) => {
-                    if (err)
-                        reject(err);
-                    else
-                        resolve(res);
-                });
-                break;
+                return (0, pdfPuppeteer_1.bufferToStream)(buffer);
             default:
-                pdfPromise.toFile(document.path, (err, res) => {
-                    if (err)
-                        reject(err);
-                    else
-                        resolve(res);
-                });
-                break;
+                return (0, pdfPuppeteer_1.writePdfToFile)(document.path, buffer);
         }
-    });
+    }))();
 }

package/dist/index.d.ts

@@ -3,7 +3,11 @@
  */
 import { create } from "./createPdf";
 export { create };
-export type { Document, IfCondOptions, PdfCreateOptions, PdfDocument, PdfDocumentBuffer, PdfDocumentFile, PdfDocumentStream, } from "./types";
+export { buildPdfChrome } from "./pdfChrome";
+export { htmlPdfTokensToPuppeteer } from "./pdfPuppeteer";
+export type { Document, IfCondOptions, PdfChromeOptions, PdfCreateOptions, PdfDocument, PdfDocumentBuffer, PdfDocumentFile, PdfDocumentStream, PdfFooterConfig, PdfHeaderConfig, PdfLayout, } from "./types";
+export type { PdfFileInfo, PdfRenderOptions } from "./pdfRenderOptions";
+export type { PdfFileInfo as FileInfo } from "./pdfRenderOptions";
 declare const api: {
     create: typeof create;
 };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAIrC,OAAO,EAAE,MAAM,EAAE,CAAC;AAClB,YAAY,EACV,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,eAAe,EACf,iBAAiB,GAClB,MAAM,SAAS,CAAC;AAEjB,QAAA,MAAM,GAAG;;CAAa,CAAC;AACvB,eAAe,GAAG,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAIrC,OAAO,EAAE,MAAM,EAAE,CAAC;AAClB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAC1D,YAAY,EACV,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,SAAS,GACV,MAAM,SAAS,CAAC;AACjB,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACxE,YAAY,EAAE,WAAW,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAElE,QAAA,MAAM,GAAG;;CAAa,CAAC;AACvB,eAAe,GAAG,CAAC"}

package/dist/index.js

@@ -3,10 +3,14 @@
  * @author Shyam Hajare <hajareshyam@gmail.com>
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.create = void 0;
+exports.htmlPdfTokensToPuppeteer = exports.buildPdfChrome = exports.create = void 0;
 const registerHandlebarsHelpers_1 = require("./registerHandlebarsHelpers");
 const createPdf_1 = require("./createPdf");
 Object.defineProperty(exports, "create", { enumerable: true, get: function () { return createPdf_1.create; } });
 (0, registerHandlebarsHelpers_1.registerHandlebarsHelpers)();
+var pdfChrome_1 = require("./pdfChrome");
+Object.defineProperty(exports, "buildPdfChrome", { enumerable: true, get: function () { return pdfChrome_1.buildPdfChrome; } });
+var pdfPuppeteer_1 = require("./pdfPuppeteer");
+Object.defineProperty(exports, "htmlPdfTokensToPuppeteer", { enumerable: true, get: function () { return pdfPuppeteer_1.htmlPdfTokensToPuppeteer; } });
 const api = { create: createPdf_1.create };
 exports.default = api;

package/dist/pdfChrome.d.ts

@@ -0,0 +1,12 @@
+import type { PdfChromeOptions, PdfCreateOptions } from "./types";
+import type { PdfRenderOptions } from "./pdfRenderOptions";
+/**
+ * Builds partial html-pdf options from layout / header / footer / copyright.
+ * Use {@link mergePdfCreateOptions} to merge with explicit `format`, `header`, `footer`.
+ */
+export declare function buildPdfChrome(chrome?: PdfChromeOptions): Partial<PdfRenderOptions>;
+/**
+ * Merges `pdfChrome` with explicit PDF options. Explicit `header` / `footer` / `format` win.
+ */
+export declare function mergePdfCreateOptions(options: PdfCreateOptions): PdfRenderOptions;
+//# sourceMappingURL=pdfChrome.d.ts.map

package/dist/pdfChrome.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdfChrome.d.ts","sourceRoot":"","sources":["../src/pdfChrome.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA+C3D;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAuDnF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,CASjF"}

package/dist/pdfChrome.js

@@ -0,0 +1,117 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildPdfChrome = buildPdfChrome;
+exports.mergePdfCreateOptions = mergePdfCreateOptions;
+function escapeHtml(s) {
+    return s
+        .replace(/&/g, "&amp;")
+        .replace(/</g, "&lt;")
+        .replace(/>/g, "&gt;")
+        .replace(/"/g, "&quot;");
+}
+function defaultHeaderHtml(title) {
+    return `<div style="text-align:center;font-size:10px;padding:6px;">${escapeHtml(title)}</div>`;
+}
+function buildFooterContents(copyright, showPageNumbers) {
+    const hasCopyright = copyright != null && String(copyright).trim() !== "";
+    const pagePart = showPageNumbers
+        ? '<span style="color:#444">{{page}}</span>/<span>{{pages}}</span>'
+        : "";
+    if (hasCopyright && pagePart) {
+        return {
+            default: `<div style="text-align:center;font-size:9px;padding:4px;">${escapeHtml(String(copyright))} · ${pagePart}</div>`,
+        };
+    }
+    if (hasCopyright) {
+        return {
+            default: `<div style="text-align:center;font-size:9px;padding:4px;">${escapeHtml(String(copyright))}</div>`,
+        };
+    }
+    if (pagePart) {
+        return {
+            default: `<div style="text-align:center;font-size:9px;padding:4px;">${pagePart}</div>`,
+        };
+    }
+    return { default: "" };
+}
+/**
+ * Builds partial html-pdf options from layout / header / footer / copyright.
+ * Use {@link mergePdfCreateOptions} to merge with explicit `format`, `header`, `footer`.
+ */
+function buildPdfChrome(chrome) {
+    var _a, _b, _c, _d;
+    if (!chrome)
+        return {};
+    const out = {};
+    if (chrome.layout) {
+        const L = chrome.layout;
+        if (L.format)
+            out.format = L.format;
+        if (L.orientation)
+            out.orientation = L.orientation;
+        if (L.width)
+            out.width = L.width;
+        if (L.height)
+            out.height = L.height;
+        if (L.border !== undefined)
+            out.border = L.border;
+    }
+    if (chrome.header) {
+        const h = chrome.header;
+        const contents = (_a = h.html) !== null && _a !== void 0 ? _a : (h.title != null && h.title !== "" ? defaultHeaderHtml(h.title) : undefined);
+        if (contents) {
+            out.header = {
+                height: (_b = h.height) !== null && _b !== void 0 ? _b : "45mm",
+                contents,
+            };
+        }
+        else if (h.height) {
+            out.header = { height: h.height };
+        }
+    }
+    if (chrome.footer) {
+        const f = chrome.footer;
+        if (f.html) {
+            out.footer = {
+                height: (_c = f.height) !== null && _c !== void 0 ? _c : "28mm",
+                contents: { default: f.html },
+            };
+        }
+        else {
+            const hasCopyright = f.copyright != null && String(f.copyright).trim() !== "";
+            const showPages = f.showPageNumbers === true ||
+                (f.showPageNumbers !== false && hasCopyright);
+            if (hasCopyright || showPages) {
+                const contents = buildFooterContents(hasCopyright ? String(f.copyright) : undefined, showPages);
+                out.footer = {
+                    height: (_d = f.height) !== null && _d !== void 0 ? _d : "28mm",
+                    contents,
+                };
+            }
+            else if (f.height) {
+                out.footer = { height: f.height };
+            }
+        }
+    }
+    return out;
+}
+/**
+ * Merges `pdfChrome` with explicit PDF options. Explicit `header` / `footer` / `format` win.
+ */
+function mergePdfCreateOptions(options) {
+    var _a, _b;
+    const { handlebarsHelpers: _h, pdfChrome } = options, userPdfOptions = __rest(options, ["handlebarsHelpers", "pdfChrome"]);
+    const fromChrome = buildPdfChrome(pdfChrome);
+    return Object.assign(Object.assign(Object.assign({}, fromChrome), userPdfOptions), { header: (_a = userPdfOptions.header) !== null && _a !== void 0 ? _a : fromChrome.header, footer: (_b = userPdfOptions.footer) !== null && _b !== void 0 ? _b : fromChrome.footer });
+}

package/dist/pdfPuppeteer.d.ts

@@ -0,0 +1,11 @@
+import { Readable } from "stream";
+import type { PdfFileInfo, PdfRenderOptions } from "./pdfRenderOptions";
+/** Maps html-pdf `{{page}}` / `{{pages}}` to Puppeteer header/footer template tokens. */
+export declare function htmlPdfTokensToPuppeteer(html: string): string;
+/**
+ * Renders HTML to PDF bytes using headless Chromium (Puppeteer).
+ */
+export declare function renderPdfToBuffer(html: string, options: PdfRenderOptions): Promise<Buffer>;
+export declare function writePdfToFile(path: string, buffer: Buffer): Promise<PdfFileInfo>;
+export declare function bufferToStream(buffer: Buffer): Readable;
+//# sourceMappingURL=pdfPuppeteer.d.ts.map

package/dist/pdfPuppeteer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdfPuppeteer.d.ts","sourceRoot":"","sources":["../src/pdfPuppeteer.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAExE,yFAAyF;AACzF,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAI7D;AA8FD;;GAEG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,MAAM,CAAC,CA4BjB;AAED,wBAAsB,cAAc,CAClC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CAItB;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAEvD"}

package/dist/pdfPuppeteer.js

@@ -0,0 +1,154 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.htmlPdfTokensToPuppeteer = htmlPdfTokensToPuppeteer;
+exports.renderPdfToBuffer = renderPdfToBuffer;
+exports.writePdfToFile = writePdfToFile;
+exports.bufferToStream = bufferToStream;
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const puppeteer_1 = __importDefault(require("puppeteer"));
+const stream_1 = require("stream");
+/** Maps html-pdf `{{page}}` / `{{pages}}` to Puppeteer header/footer template tokens. */
+function htmlPdfTokensToPuppeteer(html) {
+    return html
+        .replace(/\{\{\s*page\s*\}\}/gi, '<span class="pageNumber"></span>')
+        .replace(/\{\{\s*pages\s*\}\}/gi, '<span class="totalPages"></span>');
+}
+function wrapPrintTemplate(html) {
+    return `<div style="font-size:10px;width:100%;box-sizing:border-box;padding:4px 12px;">${htmlPdfTokensToPuppeteer(html)}</div>`;
+}
+function borderToMargin(border) {
+    var _a, _b, _c, _d;
+    if (border == null)
+        return undefined;
+    if (typeof border === "string") {
+        return { top: border, right: border, bottom: border, left: border };
+    }
+    return {
+        top: (_a = border.top) !== null && _a !== void 0 ? _a : "0",
+        right: (_b = border.right) !== null && _b !== void 0 ? _b : "0",
+        bottom: (_c = border.bottom) !== null && _c !== void 0 ? _c : "0",
+        left: (_d = border.left) !== null && _d !== void 0 ? _d : "0",
+    };
+}
+function ensureFullHtmlDocument(html) {
+    const trimmed = html.trim();
+    if (/^<!DOCTYPE/i.test(trimmed) || /<html[\s>]/i.test(trimmed)) {
+        return html;
+    }
+    return `<!DOCTYPE html><html><head><meta charset="utf-8"></head><body>${html}</body></html>`;
+}
+/**
+ * v4+: Puppeteer only supports one footer template — we use `default`, else `first`, else `last`.
+ * Per-page numeric keys are ignored.
+ */
+function pickFooterHtml(footer) {
+    const c = footer === null || footer === void 0 ? void 0 : footer.contents;
+    if (!c)
+        return undefined;
+    if (c.default != null && String(c.default).trim() !== "")
+        return String(c.default);
+    if (c.first != null && String(c.first).trim() !== "")
+        return String(c.first);
+    if (c.last != null && String(c.last).trim() !== "")
+        return String(c.last);
+    return undefined;
+}
+function withBrowser(fn) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const browser = yield puppeteer_1.default.launch({
+            headless: true,
+            args: ["--no-sandbox", "--disable-setuid-sandbox", "--disable-dev-shm-usage"],
+        });
+        try {
+            return yield fn(browser);
+        }
+        finally {
+            yield browser.close();
+        }
+    });
+}
+function buildPdfOptions(opts) {
+    var _a, _b;
+    const margin = borderToMargin(opts.border);
+    const headerHtml = (_a = opts.header) === null || _a === void 0 ? void 0 : _a.contents;
+    const footerHtml = pickFooterHtml(opts.footer);
+    const hasHeader = Boolean(headerHtml && headerHtml.trim());
+    const hasFooter = Boolean(footerHtml && footerHtml.trim());
+    const format = opts.width && opts.height ? undefined : (_b = opts.format) !== null && _b !== void 0 ? _b : "A4";
+    const landscape = opts.orientation === "landscape";
+    const pdfOpts = {
+        printBackground: true,
+        landscape,
+    };
+    if (hasHeader || hasFooter) {
+        pdfOpts.displayHeaderFooter = true;
+        pdfOpts.headerTemplate = hasHeader
+            ? wrapPrintTemplate(headerHtml)
+            : "<span></span>";
+        pdfOpts.footerTemplate = hasFooter
+            ? wrapPrintTemplate(footerHtml)
+            : "<span></span>";
+    }
+    if (margin) {
+        pdfOpts.margin = margin;
+    }
+    if (opts.width && opts.height) {
+        pdfOpts.width = opts.width;
+        pdfOpts.height = opts.height;
+    }
+    else if (format) {
+        pdfOpts.format = format;
+    }
+    return pdfOpts;
+}
+/**
+ * Renders HTML to PDF bytes using headless Chromium (Puppeteer).
+ */
+function renderPdfToBuffer(html, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const fullHtml = ensureFullHtmlDocument(html);
+        const pdfOpts = buildPdfOptions(options);
+        const timeout = (_a = options.timeout) !== null && _a !== void 0 ? _a : 30000;
+        return withBrowser((browser) => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const page = yield browser.newPage();
+            page.setDefaultTimeout(timeout);
+            if (options.httpHeaders && Object.keys(options.httpHeaders).length > 0) {
+                yield page.setExtraHTTPHeaders(options.httpHeaders);
+            }
+            if ((_a = options.httpCookies) === null || _a === void 0 ? void 0 : _a.length) {
+                yield page.setCookie(...options.httpCookies);
+            }
+            yield page.setContent(fullHtml, Object.assign({ waitUntil: "load", timeout }, (options.base ? { baseURL: options.base } : {})));
+            if (typeof options.renderDelay === "number" && options.renderDelay > 0) {
+                yield new Promise((r) => setTimeout(r, options.renderDelay));
+            }
+            const buf = yield page.pdf(pdfOpts);
+            return Buffer.from(buf);
+        }));
+    });
+}
+function writePdfToFile(path, buffer) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield (0, promises_1.mkdir)((0, path_1.dirname)(path), { recursive: true });
+        yield (0, promises_1.writeFile)(path, buffer);
+        return { filename: path };
+    });
+}
+function bufferToStream(buffer) {
+    return stream_1.Readable.from(buffer);
+}

package/dist/pdfRenderOptions.d.ts

@@ -0,0 +1,65 @@
+/**
+ * PDF engine options (formerly html-pdf / PhantomJS; now mapped to Puppeteer).
+ * Kept compatible with the previous option shape where possible.
+ */
+export interface PdfRenderOptions {
+    directory?: string;
+    height?: string;
+    width?: string;
+    format?: "A3" | "A4" | "A5" | "Legal" | "Letter" | "Tabloid";
+    orientation?: "portrait" | "landscape";
+    border?: string | {
+        top?: string;
+        right?: string;
+        bottom?: string;
+        left?: string;
+    };
+    paginationOffset?: number;
+    header?: {
+        height?: string;
+        contents?: string;
+    };
+    footer?: {
+        height?: string;
+        contents?: {
+            first?: string;
+            [page: number]: string | undefined;
+            default?: string;
+            last?: string;
+        };
+    };
+    base?: string;
+    zoomFactor?: string;
+    type?: "png" | "jpeg" | "pdf";
+    quality?: string;
+    /** @deprecated No effect in v4 (Puppeteer). */
+    phantomPath?: string;
+    /** @deprecated No effect in v4 (Puppeteer). */
+    phantomArgs?: string[];
+    /** @deprecated No effect in v4 (Puppeteer). */
+    localUrlAccess?: boolean;
+    /** @deprecated No effect in v4 (Puppeteer). */
+    script?: string;
+    timeout?: number;
+    renderDelay?: "manual" | number;
+    httpHeaders?: {
+        [header: string]: string;
+    };
+    childProcessOptions?: {
+        detached?: boolean;
+    };
+    httpCookies?: Array<{
+        name: string;
+        value: string;
+        domain?: string;
+        path: string;
+        httponly?: boolean;
+        secure?: boolean;
+        expires?: number;
+    }>;
+}
+/** Result shape when writing to disk (same as previous html-pdf FileInfo). */
+export interface PdfFileInfo {
+    filename: string;
+}
+//# sourceMappingURL=pdfRenderOptions.d.ts.map

package/dist/pdfRenderOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdfRenderOptions.d.ts","sourceRoot":"","sources":["../src/pdfRenderOptions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC7D,WAAW,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IACvC,MAAM,CAAC,EACH,MAAM,GACN;QACE,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACN,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE;QACP,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,MAAM,CAAC,EAAE;QACP,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE;YACT,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;YACnC,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,+CAA+C;IAC/C,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAChC,WAAW,CAAC,EAAE;QACZ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;KAC1B,CAAC;IACF,mBAAmB,CAAC,EAAE;QACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC;IACF,WAAW,CAAC,EAAE,KAAK,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC,CAAC;CACJ;AAED,8EAA8E;AAC9E,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;CAClB"}

package/dist/pdfRenderOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.d.ts

@@ -1,5 +1,5 @@
-import type { CreateOptions } from "html-pdf";
 import type { HelperDelegate } from "handlebars";
+import type { PdfRenderOptions } from "./pdfRenderOptions";
 /** Options passed to Handlebars `ifCond` helper inverse/fn blocks */
 export interface IfCondOptions {
     fn: (context: any) => string;
@@ -29,11 +29,51 @@ export interface PdfDocumentStream {
 export type PdfDocument = PdfDocumentFile | PdfDocumentBuffer | PdfDocumentStream;
 /** @deprecated Use `PdfDocument` — kept for compatibility with earlier typings */
 export type Document = PdfDocument;
+/** Page size / margins — maps to PDF engine paper options */
+export interface PdfLayout {
+    format?: "A3" | "A4" | "A5" | "Legal" | "Letter" | "Tabloid";
+    orientation?: "portrait" | "landscape";
+    width?: string;
+    height?: string;
+    border?: PdfRenderOptions["border"];
+}
+/** Repeating header — use `html` or a plain `title` (escaped) */
+export interface PdfHeaderConfig {
+    height?: string;
+    /** Raw HTML shown on each page */
+    html?: string;
+    /** Centered plain text (HTML-escaped). Ignored if `html` is set */
+    title?: string;
+}
+/** Repeating footer — use `html`, or `copyright` / `showPageNumbers` */
+export interface PdfFooterConfig {
+    height?: string;
+    /** Raw HTML for the default footer slot */
+    html?: string;
+    /** Plain copyright line (HTML-escaped) */
+    copyright?: string;
+    /**
+     * Include `{{page}}` / `{{pages}}`. If `copyright` is set, defaults to true unless `false`.
+     * For page numbers only, set `showPageNumbers: true` and omit `copyright`.
+     */
+    showPageNumbers?: boolean;
+}
+/**
+ * High-level layout + header/footer/copyright. Merged before PDF render; any
+ * explicit `format`, `header`, `footer` on the same options object overrides these.
+ */
+export interface PdfChromeOptions {
+    layout?: PdfLayout;
+    header?: PdfHeaderConfig;
+    footer?: PdfFooterConfig;
+}
 /**
- * Options for `html-pdf`, plus optional Handlebars helpers for this render only
+ * PDF engine options (Puppeteer / Chromium), plus optional Handlebars helpers for this render only
  * (rendering uses an isolated Handlebars instance).
  */
-export type PdfCreateOptions = CreateOptions & {
+export type PdfCreateOptions = PdfRenderOptions & {
     handlebarsHelpers?: Record<string, HelperDelegate>;
+    /** Convenience presets merged into PDF options (explicit keys override) */
+    pdfChrome?: PdfChromeOptions;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,qEAAqE;AACrE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,CAAC;IAC7B,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,GAAG,CAAC;IACV,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;CACpB;AAED,0BAA0B;AAC1B,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,GAAG,CAAC;IACV,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,+BAA+B;AAC/B,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,GAAG,CAAC;IACV,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,MAAM,MAAM,WAAW,GACnB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,CAAC;AAEtB,kFAAkF;AAClF,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC;AAEnC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CACpD,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,qEAAqE;AACrE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,CAAC;IAC7B,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,GAAG,CAAC;IACV,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;CACpB;AAED,0BAA0B;AAC1B,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,GAAG,CAAC;IACV,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,+BAA+B;AAC/B,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,GAAG,CAAC;IACV,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,MAAM,MAAM,WAAW,GACnB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,CAAC;AAEtB,kFAAkF;AAClF,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC;AAEnC,6DAA6D;AAC7D,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC7D,WAAW,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;CACrC;AAED,iEAAiE;AACjE,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wEAAwE;AACxE,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG;IAChD,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACnD,2EAA2E;IAC3E,SAAS,CAAC,EAAE,gBAAgB,CAAC;CAC9B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdf-creator-node",
-  "version": "2.4.0",
+  "version": "4.0.0",
   "description": "node pdf creator",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,7 +30,8 @@
     "html2pdf",
     "html-to-pdf",
     "handlebars",
-    "html-pdf",
+    "puppeteer",
+    "chromium",
     "nodejs",
     "express",
     "report",
@@ -40,10 +41,9 @@
   "license": "MIT",
   "dependencies": {
     "handlebars": "^4.7.7",
-    "html-pdf": "^3.0.1"
+    "puppeteer": "^24.0.0"
   },
   "devDependencies": {
-    "@types/html-pdf": "^3.0.3",
     "@types/node": "^22.13.0",
     "tsx": "^4.19.2",
     "typescript": "^5.7.3"

package/readme.md

@@ -1,9 +1,28 @@
 # pdf-creator-node
 
-Convert **HTML + Handlebars** templates to **PDF** in Node.js (via [html-pdf](https://www.npmjs.com/package/html-pdf)).
+Convert **HTML + Handlebars** templates to **PDF** in Node.js using **[Puppeteer](https://pptr.dev/)** (headless **Chromium**). PhantomJS / `html-pdf` are no longer used as of **v4**.
 
 **Requirements:** [Node.js](https://nodejs.org/) 18 or newer.
 
+**Install size:** `puppeteer` downloads a compatible Chromium build on `npm install` (hundreds of MB). In CI you can cache the browser directory or set [`PUPPETEER_CACHE_DIR`](https://pptr.dev/guides/configuration) / `PUPPETEER_SKIP_DOWNLOAD` as needed.
+
+### Strengths and trade-offs
+
+| | |
+| --- | --- |
+| **Strengths** | **HTML + Handlebars** — quick to build **invoices, reports, and letters** without drawing coordinates. **v4+** uses **Chromium**, so you get **modern CSS** (flexbox, grid, web fonts) and a **maintained** rendering stack — not deprecated PhantomJS. **`pdfChrome`** helps with layout, headers, footers, and copyright in one place. |
+| **Trade-offs** | **Footprint:** Chromium adds install size and **RAM** per browser instance. **Throughput:** launching a browser is heavier than a pure-JS library like **PDFKit** for tiny one-off jobs; for **high volume**, reuse browsers ([Puppeteer patterns](https://pptr.dev/)), queue work, or run workers. **Model:** this package is **HTML → PDF**; if you need a **drawing API** (paths, precise vector control) without HTML, use PDFKit / pdf-lib instead. **Print pipeline:** PDFs use Chrome’s **print** path — edge cases can differ from on-screen CSS (true for any headless-Chrome PDF approach). |
+
+**Practical verdict:** strong fit for **small and medium** projects and **production** workloads where you control **memory** and **concurrency**; for **very large scale** (always-on millions of PDFs/day), plan **infrastructure** (pooling, autoscaling, or a dedicated rendering service) like any Chromium-based pipeline.
+
+### Upgrading from v2.x (Phantom / html-pdf)
+
+- **v4** is a **major** release: PDFs are rendered with Chromium, so layout can differ slightly from Phantom.
+- Options are still the same shape for most fields (`format`, `orientation`, `border`, `header`, `footer`, `pdfChrome`).
+- **Footer `contents`:** only one template is applied. We use `default`, else `first`, else `last`. Per-page keys (e.g. page `2`) are **not** supported in v4.
+- **`phantomPath`**, **`phantomArgs`**, etc. are **ignored** (see `PdfRenderOptions` in types).
+- `{{page}}` / `{{pages}}` in header/footer HTML are converted to Puppeteer’s print tokens automatically.
+
 ## Install
 
 ```bash
@@ -63,9 +82,31 @@ await pdf.create(document, options);
 - **Buffer:** `type: "buffer"`.
 - **Stream:** `type: "stream"`.
 
+### Layout, header, footer, and copyright (`pdfChrome`)
+
+Use **`pdfChrome`** on the second argument for common paper layout and repeating header/footer. Plain `title` / `copyright` strings are HTML-escaped.
+
+- **`layout`:** `format`, `orientation`, `width`, `height`, `border` (mapped to Puppeteer’s PDF / margin options).
+- **`header`:** `html` (raw HTML per page) **or** `title` (centered text). Default height `45mm` when content is set.
+- **`footer`:** `html` **or** combine **`copyright`** with optional **`showPageNumbers`** (`{{page}}` / `{{pages}}`). With `copyright` only, page numbers default **on** unless you set `showPageNumbers: false`. For **page numbers only**, set `showPageNumbers: true` and omit `copyright`. Default footer height `28mm` when content is set.
+
+Anything you set directly on the options object (`format`, `header`, `footer`, …) **overrides** the matching field from `pdfChrome`.
+
+```javascript
+pdf.create(document, {
+  pdfChrome: {
+    layout: { format: "A4", orientation: "portrait", border: "12mm" },
+    header: { title: "Quarterly report" },
+    footer: { copyright: "© 2026 My Company", showPageNumbers: true },
+  },
+});
+```
+
+Advanced: `buildPdfChrome(pdfChrome)` returns partial `PdfRenderOptions` if you want to compose manually (also exported).
+
 ### Optional Handlebars helpers
 
-Pass `handlebarsHelpers` on the **second** argument (alongside `html-pdf` options). Helpers apply only to that render (isolated Handlebars instance). Built-in `ifCond` is always registered.
+Pass `handlebarsHelpers` on the **second** argument (alongside PDF options). Helpers apply only to that render (isolated Handlebars instance). Built-in `ifCond` is always registered.
 
 ```javascript
 pdf.create(
@@ -113,12 +154,13 @@ You may see explicit errors such as:
 </html>
 ```
 
-## PDF options (html-pdf)
+## PDF options (Puppeteer)
 
 Examples:
 
-- **Size:** `"height": "10.5in"`, `"width": "8in"` (units: mm, cm, in, px)
-- **Or:** `"format": "Letter"` (A3, A4, A5, Legal, Letter, Tabloid) and `"orientation": "portrait"` or `"landscape"`
+- **Size:** `"height": "10.5in"`, `"width": "8in"` (CSS units), **or** `"format": "Letter"` (A3, A4, A5, Legal, Letter, Tabloid) with `"orientation"`.
+- **`border`:** margin around the page content (string or per-side object).
+- **`header` / `footer`:** `contents` is HTML. In the footer, prefer **`contents.default`** for the repeating footer; `{{page}}` and `{{pages}}` work as with older versions (mapped for Chromium print).
 
 ```javascript
 const options = {
@@ -132,11 +174,8 @@ const options = {
   footer: {
     height: "28mm",
     contents: {
-      first: "Cover page",
-      2: "Second page",
       default:
         '<span style="color: #444;">{{page}}</span>/<span>{{pages}}</span>',
-      last: "Last Page",
     },
   },
 };