@websy/websy-designs 1.9.4 → 1.9.6

package/dist/server/helpers/v1/createReport.js

@@ -0,0 +1,92 @@
+Object.defineProperty(exports, '__esModule', { value: true })
+exports.createReport = void 0
+const pdfLib1 = require('pdf-lib')
+async function createReport (baseDoc, headersPdfBuffer, headerHeight, footerHeight) {
+  const headerDoc = await pdfLib1.PDFDocument.load(headersPdfBuffer)
+  const basePages = baseDoc.getPages()
+  const headerPages = headerDoc.getPages()
+  const hasBoth = !!headerHeight && !!footerHeight
+  // get pages dimensions
+  const x = basePages[0].getWidth()
+  const y = basePages[0].getHeight()
+  // 1 inch = 96 px
+  // PDF unit =  inch * 72/1
+  const pdfHeaderHeight = (headerHeight / 96) * 72
+  const pdfFooterHeight = (footerHeight / 96) * 72
+  // embed all headers pdf pages in the base pdf
+  const pages = []
+  const boxes = []
+  for (let i = 1; i <= headerPages.length; i++) {
+    pages.push(headerPages[i - 1])
+    const isOdd = i % 2 !== 0
+    // have only header or
+    // have both header and footer and we are in odd pages
+    // 1, 3, 5, etc
+    if (headerHeight && (!hasBoth || isOdd)) {
+      boxes.push({
+        bottom: y - pdfHeaderHeight,
+        left: 0,
+        right: x,
+        top: y
+      })
+    }
+    // have only footer or
+    // have both header and footer and we are in plural pages
+    // 2, 4, 6, etc
+    if (footerHeight && (!hasBoth || !isOdd)) {
+      boxes.push({
+        bottom: y - pdfFooterHeight,
+        left: 0,
+        right: x,
+        top: y
+      })
+    }
+  }
+  const embeddedPages = await baseDoc.embedPages(pages, boxes)
+  // draw headers and/or footers over the base pages
+  let baseIndex = 0
+  for (let i = 1; i <= headerPages.length; i++) {
+    const embeddedPage = embeddedPages[i - 1]
+    const size = embeddedPage.size()
+    const isOdd = i % 2 !== 0
+    if (headerHeight && (!hasBoth || isOdd) && basePages[baseIndex]) {
+      console.log('attempting to draw page x')
+      basePages[baseIndex].drawPage(embeddedPage, Object.assign({},
+        size,
+        {
+          x: x - size.width,
+          y: y - size.height,
+          blendMode: pdfLib1.BlendMode.Multiply
+        }
+      ))
+    }
+    if (footerHeight && (!hasBoth || !isOdd) && basePages[baseIndex]) {
+      basePages[baseIndex].drawPage(embeddedPage, Object.assign({},
+        size,
+        {
+          x: x - size.width,
+          y: 0,
+          blendMode: pdfLib1.BlendMode.Multiply
+        }
+      ))
+    }
+    // when we have both header and footer
+    // two pages of headers pdf belong to one page of the base doc
+    //  ------------
+    // |  header 1  |
+    // |      |    ------------
+    // |      |     |  header 1  |
+    //  ------------   => | xxxxxxxxxx |
+    // |  footer 1  |     |  footer 1  |
+    // |      |    ------------
+    // |      |
+    if (hasBoth && !isOdd) {
+      baseIndex++
+    }
+    else if (!hasBoth) {
+      baseIndex++
+    }
+  }
+  return baseDoc.save()
+}
+exports.createReport = createReport

package/dist/server/helpers/v1/pdfHelper.js

@@ -1,5 +1,6 @@
 const puppeteer = require('puppeteer')
-const report = require('puppeteer-report')
+// const report = require('puppeteer-report')
+const report = require('./puppeteer-report/index')
 const fs = require('fs')
 const utils = require('../../utils')
 const http = require('http')

package/dist/server/helpers/v1/puppeteer-report/core/createReport.d.ts

@@ -0,0 +1,2 @@
+import { PDFDocument } from "pdf-lib";
+export declare function createReport(baseDoc: PDFDocument, headersPdfBuffer: Uint8Array, headerHeight: number, footerHeight: number): Promise<Uint8Array>;

package/dist/server/helpers/v1/puppeteer-report/core/createReport.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createReport = void 0;
+const pdf_lib_1 = require("pdf-lib");
+async function createReport(baseDoc, headersPdfBuffer, headerHeight, footerHeight) {
+    const headerDoc = await pdf_lib_1.PDFDocument.load(headersPdfBuffer);
+    const basePages = baseDoc.getPages();
+    const headerPages = headerDoc.getPages();
+    const hasBoth = !!headerHeight && !!footerHeight;
+    // get pages dimensions
+    const x = basePages[0].getWidth();
+    const y = basePages[0].getHeight();
+    // 1 inch = 96 px
+    // PDF unit =  inch * 72/1
+    const pdfHeaderHeight = (headerHeight / 96) * 72;
+    const pdfFooterHeight = (footerHeight / 96) * 72;
+    // embed all headers pdf pages in the base pdf
+    const pages = [];
+    const boxes = [];
+    for (let i = 1; i <= headerPages.length; i++) {
+        pages.push(headerPages[i - 1]);
+        const isOdd = i % 2 != 0;
+        // have only header or
+        // have both header and footer and we are in odd pages
+        // 1, 3, 5, etc
+        if (headerHeight && (!hasBoth || isOdd)) {
+            boxes.push({
+                bottom: y - pdfHeaderHeight,
+                left: 0,
+                right: x,
+                top: y,
+            });
+        }
+        // have only footer or
+        // have both header and footer and we are in plural pages
+        // 2, 4, 6, etc
+        if (footerHeight && (!hasBoth || !isOdd)) {
+            boxes.push({
+                bottom: y - pdfFooterHeight,
+                left: 0,
+                right: x,
+                top: y,
+            });
+        }
+    }
+    const embeddedPages = await baseDoc.embedPages(pages, boxes);
+    // draw headers and/or footers over the base pages
+    let baseIndex = 0;
+    for (let i = 1; i <= headerPages.length; i++) {
+        const embeddedPage = embeddedPages[i - 1];
+        const size = embeddedPage.size();
+        const isOdd = i % 2 != 0;
+        if (headerHeight && (!hasBoth || isOdd) && basePages[baseIndex]) {
+            basePages[baseIndex].drawPage(embeddedPage, {
+                ...size,
+                x: x - size.width,
+                y: y - size.height,
+                blendMode: pdf_lib_1.BlendMode.Multiply
+            });
+        }
+        if (footerHeight && (!hasBoth || !isOdd) && basePages[baseIndex]) {
+            basePages[baseIndex].drawPage(embeddedPage, {
+                ...size,
+                x: x - size.width,
+                y: 0,
+                blendMode: pdf_lib_1.BlendMode.Multiply
+            });
+        }
+        // when we have both header and footer
+        // two pages of headers pdf belong to one page of the base doc
+        //  ------------
+        // |  header 1  |
+        // |            |        ------------
+        // |            |       |  header 1  |
+        //  ------------     => | xxxxxxxxxx |
+        // |  footer 1  |       |  footer 1  |
+        // |            |        ------------
+        // |            |
+        if (hasBoth && !isOdd) {
+            baseIndex++;
+        }
+        else if (!hasBoth) {
+            baseIndex++;
+        }
+    }
+    return await baseDoc.save();
+}
+exports.createReport = createReport;

package/dist/server/helpers/v1/puppeteer-report/core/evaluators.d.ts

@@ -0,0 +1,25 @@
+import { PDFDocument } from "pdf-lib";
+export declare function getHeightEvaluator(marginTop: number | string, marginBottom: number | string, scale?: number): [pageFunc: ({ marginTop, marginBottom, scale }: {
+    marginTop: string;
+    marginBottom: string;
+    scale: number;
+}) => {
+    headerHeight: number;
+    footerHeight: number;
+}, argument: {
+    marginTop: string;
+    marginBottom: string;
+    scale: number;
+}];
+export declare function getBaseEvaluator(headerHeight: number, footerHeight: number): [pageFunc: ({ headerHeight, footerHeight }: {
+    headerHeight: number;
+    footerHeight: number;
+}) => void, argument: {
+    headerHeight: number;
+    footerHeight: number;
+}];
+export declare function getHeadersEvaluator(basePdfBuffer: Uint8Array): Promise<[doc: PDFDocument, pageFunc: ({ pagesCount }: {
+    pagesCount: number;
+}) => void, argument: {
+    pagesCount: number;
+}]>;

package/dist/server/helpers/v1/puppeteer-report/core/evaluators.js

@@ -0,0 +1,186 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHeadersEvaluator = exports.getBaseEvaluator = exports.getHeightEvaluator = void 0;
+const pdf_lib_1 = require("pdf-lib");
+// get header and/or footer height from html
+function getHeightEvaluator(marginTop, marginBottom, scale) {
+    const normalizeMargin = (margin) => {
+        if (typeof margin == "number") {
+            return margin + "px";
+        }
+        return margin;
+    };
+    const argument = {
+        marginTop: normalizeMargin(marginTop),
+        marginBottom: normalizeMargin(marginBottom),
+        scale: scale !== null && scale !== void 0 ? scale : 1,
+    };
+    const pageFunc = ({ marginTop, marginBottom, scale }) => {
+        // get element height include margins
+        const getHeight = (element) => {
+            if (element) {
+                const styles = window.getComputedStyle(element);
+                const margin = parseFloat(styles["marginTop"]) + parseFloat(styles["marginBottom"]);
+                // change position to ignore margin collapse
+                const position = element.style.position;
+                element.style.position = "absolute";
+                const height = element.offsetHeight + margin;
+                // reset element position
+                element.style.position = position;
+                return Math.ceil(height * scale);
+            }
+            return 0;
+        };
+        const header = document.getElementById("header");
+        const footer = document.getElementById("footer");
+        // inject a style sheet
+        const styleEl = document.createElement("style");
+        styleEl.setAttribute("id", "header__style");
+        document.head.appendChild(styleEl);
+        const styleSheet = styleEl.sheet;
+        // to respect user-defined PDF margins,
+        if (header) {
+            styleSheet.insertRule(`#header { margin-top: ${marginTop}`);
+        }
+        if (footer) {
+            styleSheet.insertRule(`#footer { margin-bottom: ${marginBottom}`);
+        }
+        const headerHeight = getHeight(header);
+        const footerHeight = getHeight(footer);
+        return { headerHeight, footerHeight };
+    };
+    return [pageFunc, argument];
+}
+exports.getHeightEvaluator = getHeightEvaluator;
+// remove header and footer from HTML content to create
+// base doc pdf, for reserving the space for header and/or footer
+// we inject a @page top/bottom margin
+//  ------------
+// |   header   |
+// | xxxxxxxxxx |
+// | xxxxxxxxxx |
+//      ...
+// | xxxxxxxxxx |
+// |   footer   |
+// to:
+//  ------------
+// |            |
+// | xxxxxxxxxx |
+// |            |
+//  ------------
+// |            |
+// | xxxxxxxxxx |
+// |            |
+//  ------------
+// |            |
+//      ...
+function getBaseEvaluator(headerHeight, footerHeight) {
+    const argument = { headerHeight, footerHeight };
+    const pageFunc = ({ headerHeight, footerHeight }) => {
+        const header = document.getElementById("header");
+        const footer = document.getElementById("footer");
+        // reset body margin
+        document.body.style.margin = "0";
+        // inject a style sheet
+        const styleEl = document.createElement("style");
+        styleEl.setAttribute("id", "page__style");
+        document.head.appendChild(styleEl);
+        const styleSheet = styleEl.sheet;
+        // hide the element and add the height of it
+        // as page margin
+        const evaluate = (element, height, isTop) => {
+            if (element) {
+                element.style.display = "none";
+                if (isTop) {
+                    styleSheet.insertRule(`@page { margin-top: ${height}px}`);
+                }
+                else {
+                    styleSheet.insertRule(`@page { margin-bottom: ${height}px}`);
+                }
+            }
+        };
+        evaluate(header, headerHeight, true);
+        evaluate(footer, footerHeight, false);
+    };
+    return [pageFunc, argument];
+}
+exports.getBaseEvaluator = getBaseEvaluator;
+// convert HTML content to a header/footer only pages, for each base doc's pages.
+// if you have both headers and footers the output pdf pages will be:
+// page = base doc's pages * 2
+//  ------------
+// |  header 1  |
+// |            |
+// |            |
+//  ------------
+// |  footer 1  |
+// |            |
+// |            |
+//  ------------
+// |  header 2  |
+//       ...
+async function getHeadersEvaluator(basePdfBuffer) {
+    const doc = await pdf_lib_1.PDFDocument.load(basePdfBuffer);
+    const argument = { pagesCount: doc.getPageCount() };
+    const pageFunc = ({ pagesCount }) => {
+        // set a value for all selected elements
+        const setElementsValue = (elements, value) => {
+            for (const element of elements) {
+                element.textContent = value;
+            }
+        };
+        const resetStyle = (element) => {
+            if (element) {
+                element.style.display = "block";
+            }
+        };
+        // add a page break after each element
+        const addPageBreak = () => {
+            const pageBreak = document.createElement("div");
+            pageBreak.style.pageBreakAfter = "always";
+            document.body.appendChild(pageBreak);
+        };
+        // duplicate an element in the page
+        const cloneElement = (element, pageNumber) => {
+            const cloned = element.cloneNode(true);
+            // fill pageNumber
+            const pageNumberElements = cloned.getElementsByClassName("pageNumber");
+            setElementsValue(pageNumberElements, pageNumber);
+            // fill total page
+            const totalPagesElements = cloned.getElementsByClassName("totalPages");
+            setElementsValue(totalPagesElements, pagesCount.toString());
+            document.body.appendChild(cloned);
+            // trigger element onchange to support JS
+            cloned.dispatchEvent(new Event("change", { bubbles: true }));
+            addPageBreak();
+        };
+        const header = document.getElementById("header");
+        const footer = document.getElementById("footer");
+        resetStyle(header);
+        resetStyle(footer);
+        // clear the page content
+        document.body.innerHTML = "";
+        // remove page margin
+        const styleEl = document.getElementById("page__style");
+        const styleSheet = styleEl.sheet;
+        while (styleSheet.rules.length > 0) {
+            styleSheet.deleteRule(0);
+        }
+        // inject new style
+        styleSheet.insertRule(`@page { margin-top: 0; margin-bottom:0; }`);
+        // duplicate the header and footer element for each page
+        for (let i = 0; i < pagesCount; i++) {
+            if (header) {
+                cloneElement(header, (i + 1).toString());
+            }
+            if (footer) {
+                cloneElement(footer, (i + 1).toString());
+            }
+        }
+        // fill title
+        const titleElements = document.getElementsByClassName("title");
+        setElementsValue(titleElements, document.title);
+    };
+    return [doc, pageFunc, argument];
+}
+exports.getHeadersEvaluator = getHeadersEvaluator;

package/dist/server/helpers/v1/puppeteer-report/core/index.d.ts

@@ -0,0 +1,2 @@
+export { createReport } from "./createReport";
+export { getBaseEvaluator, getHeadersEvaluator, getHeightEvaluator, } from "./evaluators";

package/dist/server/helpers/v1/puppeteer-report/core/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHeightEvaluator = exports.getHeadersEvaluator = exports.getBaseEvaluator = exports.createReport = void 0;
+var createReport_1 = require("./createReport");
+Object.defineProperty(exports, "createReport", { enumerable: true, get: function () { return createReport_1.createReport; } });
+var evaluators_1 = require("./evaluators");
+Object.defineProperty(exports, "getBaseEvaluator", { enumerable: true, get: function () { return evaluators_1.getBaseEvaluator; } });
+Object.defineProperty(exports, "getHeadersEvaluator", { enumerable: true, get: function () { return evaluators_1.getHeadersEvaluator; } });
+Object.defineProperty(exports, "getHeightEvaluator", { enumerable: true, get: function () { return evaluators_1.getHeightEvaluator; } });

package/dist/server/helpers/v1/puppeteer-report/index.d.ts

@@ -0,0 +1,22 @@
+import type { Page, Browser, PDFOptions } from "./types";
+/**
+ * Convert HTML file to PDF
+ * @param browser puppeteer/puppeteer-core browser object
+ * @param file full path of HTML file
+ * @param options output PDF options
+ * @returns PDF as an array of bytes
+ */
+declare function pdf(browser: Browser, file: string, options?: PDFOptions): Promise<Uint8Array>;
+/**
+ * Convert a Page to PDF
+ * @param page puppeteer/puppeteer-core page object
+ * @param options output PDF options
+ * @returns PDF as an array of bytes
+ */
+declare function pdfPage(page: Page, options?: PDFOptions): Promise<Uint8Array>;
+export { pdf, pdfPage };
+declare const _default: {
+    pdf: typeof pdf;
+    pdfPage: typeof pdfPage;
+};
+export default _default;

package/dist/server/helpers/v1/puppeteer-report/index.js

@@ -0,0 +1,75 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pdfPage = exports.pdf = void 0;
+const fs = __importStar(require("fs"));
+const core = __importStar(require("./core"));
+/**
+ * Convert HTML file to PDF
+ * @param browser puppeteer/puppeteer-core browser object
+ * @param file full path of HTML file
+ * @param options output PDF options
+ * @returns PDF as an array of bytes
+ */
+async function pdf(browser, file, options) {
+    const page = await browser.newPage();
+    try {
+        await page.goto("file:///" + file);
+        return await pdfPage(page, options);
+    }
+    finally {
+        await page.close();
+    }
+}
+exports.pdf = pdf;
+/**
+ * Convert a Page to PDF
+ * @param page puppeteer/puppeteer-core page object
+ * @param options output PDF options
+ * @returns PDF as an array of bytes
+ */
+async function pdfPage(page, options) {
+    var _a, _b, _c, _d;
+    const { path, ...pdfOptions } = options !== null && options !== void 0 ? options : {};
+    const margin = {
+        marginTop: (_b = (_a = pdfOptions === null || pdfOptions === void 0 ? void 0 : pdfOptions.margin) === null || _a === void 0 ? void 0 : _a.top) !== null && _b !== void 0 ? _b : 0,
+        marginBottom: (_d = (_c = pdfOptions === null || pdfOptions === void 0 ? void 0 : pdfOptions.margin) === null || _c === void 0 ? void 0 : _c.bottom) !== null && _d !== void 0 ? _d : 0,
+    };
+    const [getHeightFunc, getHeightArg] = core.getHeightEvaluator(margin.marginTop, margin.marginBottom, pdfOptions === null || pdfOptions === void 0 ? void 0 : pdfOptions.scale);
+    const { headerHeight, footerHeight } = await page.evaluate(getHeightFunc, getHeightArg);
+    const [basePageEvalFunc, basePageEvalArg] = core.getBaseEvaluator(headerHeight, footerHeight);
+    await page.evaluate(basePageEvalFunc, basePageEvalArg);
+    const basePdfBuffer = await page.pdf(pdfOptions);
+    const [doc, headerEvalFunc, headerEvalArg] = await core.getHeadersEvaluator(basePdfBuffer);
+    await page.evaluate(headerEvalFunc, headerEvalArg);
+    const headerPdfBuffer = await page.pdf(pdfOptions);
+    const result = await core.createReport(doc, headerPdfBuffer, headerHeight, footerHeight);
+    if (path) {
+        await fs.promises.writeFile(path, result);
+    }
+    return result;
+}
+exports.pdfPage = pdfPage;
+exports.default = { pdf, pdfPage };

package/dist/server/helpers/v1/puppeteer-report/types.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+import type { PDFOptions, Awaitable, WaitForOptions } from "puppeteer-core";
+export type { PDFOptions } from "puppeteer-core";
+type InnerParams<T extends unknown[]> = {
+    [K in keyof T]: T[K];
+};
+type EvaluateFunc<T extends unknown[]> = (...params: InnerParams<T>) => Awaitable<unknown>;
+export interface Page {
+    pdf(options?: PDFOptions): Promise<Buffer>;
+    close(): Promise<void>;
+    goto(url: string, options?: WaitForOptions & {
+        referer?: string;
+    }): Promise<unknown | null>;
+    evaluate<Params extends unknown[], Func extends EvaluateFunc<Params> = EvaluateFunc<Params>>(pageFunction: Func | string, ...args: Params): Promise<Awaited<ReturnType<Func>>>;
+}
+export interface Browser {
+    newPage(): Promise<Page>;
+}

package/dist/server/helpers/v1/puppeteer-report/types.js

@@ -0,0 +1,4 @@
+"use strict";
+//TODO: puppeteer-core types differ from puppeteer
+// https://github.com/puppeteer/puppeteer/issues/6904
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websy/websy-designs",
-  "version": "1.9.4",
+  "version": "1.9.6",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"