pdf-creator-node 2.4.0 → 2.5.0

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":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGzC,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAmB7D;;GAEG;AACH,wBAAgB,MAAM,CACpB,QAAQ,EAAE,WAAW,EACrB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,cAAc,GAAG,QAAQ,CAAC,CA2CpD"}

package/dist/createPdf.js

@@ -1,15 +1,4 @@
 "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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -17,12 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.create = create;
 const handlebars_1 = __importDefault(require("handlebars"));
 const html_pdf_1 = __importDefault(require("html-pdf"));
+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);
@@ -59,7 +45,7 @@ function create(document, options) {
             reject(e);
             return;
         }
-        const pdfOptions = stripHtmlPdfOptions(options);
+        const pdfOptions = (0, pdfChrome_1.mergePdfCreateOptions)(options);
         const pdfPromise = html_pdf_1.default.create(html, pdfOptions);
         switch (document.type) {
             case "buffer":

package/dist/index.d.ts

@@ -3,7 +3,8 @@
  */
 import { create } from "./createPdf";
 export { create };
-export type { Document, IfCondOptions, PdfCreateOptions, PdfDocument, PdfDocumentBuffer, PdfDocumentFile, PdfDocumentStream, } from "./types";
+export { buildPdfChrome } from "./pdfChrome";
+export type { Document, IfCondOptions, PdfChromeOptions, PdfCreateOptions, PdfDocument, PdfDocumentBuffer, PdfDocumentFile, PdfDocumentStream, PdfFooterConfig, PdfHeaderConfig, PdfLayout, } from "./types";
 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,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;AAEjB,QAAA,MAAM,GAAG;;CAAa,CAAC;AACvB,eAAe,GAAG,CAAC"}

package/dist/index.js

@@ -3,10 +3,12 @@
  * @author Shyam Hajare <hajareshyam@gmail.com>
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.create = void 0;
+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; } });
 const api = { create: createPdf_1.create };
 exports.default = api;

package/dist/pdfChrome.d.ts

@@ -0,0 +1,12 @@
+import type { CreateOptions } from "html-pdf";
+import type { PdfChromeOptions, PdfCreateOptions } from "./types";
+/**
+ * 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<CreateOptions>;
+/**
+ * Merges `pdfChrome` with explicit html-pdf fields. Explicit `header` / `footer` / `format` win.
+ */
+export declare function mergePdfCreateOptions(options: PdfCreateOptions): CreateOptions;
+//# 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,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AA+ClE;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC,CAuDhF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,gBAAgB,GAAG,aAAa,CAS9E"}

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 html-pdf fields. 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/types.d.ts

@@ -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 html-pdf paper options */
+export interface PdfLayout {
+    format?: "A3" | "A4" | "A5" | "Legal" | "Letter" | "Tabloid";
+    orientation?: "portrait" | "landscape";
+    width?: string;
+    height?: string;
+    border?: CreateOptions["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 `html-pdf` runs; 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
  * (rendering uses an isolated Handlebars instance).
  */
 export type PdfCreateOptions = CreateOptions & {
     handlebarsHelpers?: Record<string, HelperDelegate>;
+    /** Convenience presets merged into html-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,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,2DAA2D;AAC3D,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,aAAa,CAAC,QAAQ,CAAC,CAAC;CAClC;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,aAAa,GAAG;IAC7C,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACnD,gFAAgF;IAChF,SAAS,CAAC,EAAE,gBAAgB,CAAC;CAC9B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdf-creator-node",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "node pdf creator",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -63,6 +63,28 @@ 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 without hand-writing `html-pdf` structures. Plain `title` / `copyright` strings are HTML-escaped.
+
+- **`layout`:** `format`, `orientation`, `width`, `height`, `border` (same meaning as [html-pdf](https://www.npmjs.com/package/html-pdf) / Phantom paper size).
+- **`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 html-pdf options if you want to compose manually (also exported from the package).
+
 ### 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.