pdf-visual-compare 0.0.10 → 1.1.1

package/README.md

@@ -1,4 +1,45 @@
 # pdf-visual-compare
-Visual regression testing library for PDFs in Js/Ts
+
+Visual regression testing library for PDFs in Js/Ts without binary and OS dependencies.
 
 [![Tests on push](https://github.com/dichovsky/pdf-visual-compare/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/dichovsky/pdf-visual-compare/actions/workflows/test.yml)
+
+## Getting started
+
+Installation:
+
+```sh
+npm install -D pdf-visual-compare
+```
+
+## Example
+
+```javascript
+  const result: boolean = await comparePdf('./pdf1.pdf', './pdf2.pdf');
+
+  // If you want to configure comparing process, use the following props
+
+  const result: boolean = await comparePdf('./pdf1.pdf', './pdf2.pdf', {
+  diffsOutputFolder?: string; // Folder to write output PNG files with differences
+  pdfToPngConvertOptions?: {
+    viewportScale: 2.0, // The desired scale of PNG viewport. Default value is 1.0.
+    disableFontFace: false, //When `false`, fonts will be rendered using a built-in font renderer that constructs the glyphs with primitive path commands. Default value is true.
+    useSystemFonts: false, // When `true`, fonts that aren't embedded in the PDF document will fallback to a system font. Default value is false.
+    pdfFilePassword: 'pa$$word', // Password for encrypted PDF.
+    outputFolder: 'output/folder', // Folder to write output PNG files. If not specified, PNG output will be available only as a Buffer content, without saving to a file.
+    outputFileMask: 'buffer', // Output filename mask. Default value is 'buffer'.
+    pagesToProcess: [1, 3, 11],   // Subset of pages to convert (first page = 1), other pages will be skipped if specified.
+    strictPagesToProcess: false // When `true`, will throw an error if specified page number in pagesToProcess is invalid, otherwise will skip invalid page. Default value is false.
+    verbosityLevel: 0 // Verbosity level. ERRORS: 0, WARNINGS: 1, INFOS: 5. Default value is 0.
+  };
+  excludedAreas?: ExcludedPageArea[]; // Areas list to exclude from comparing for each PDF page. Empty array by default.
+  compareThreshold?: number; // Comparing threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0.1 by default.
+});
+
+```
+
+## Buy Me A Coffee
+
+In case you want support my work
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/dichovsky)

package/out/compare.pdf.d.ts

@@ -1,2 +1,2 @@
 import { ComparePdfOptions } from './types';
-export default function comparePdf(actualPdfFilePath: string, expectedPdfFilePath: string, opts?: ComparePdfOptions): Promise<boolean>;
+export default function comparePdf(actualPdfFilePathOrBuffer: string | ArrayBufferLike, expectedPdfFilePathOrBuffer: string | ArrayBufferLike, opts?: ComparePdfOptions): Promise<boolean>;

package/out/compare.pdf.js

@@ -7,35 +7,43 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 const pdf_to_png_converter_1 = require("pdf-to-png-converter");
 const png_visual_compare_1 = __importDefault(require("png-visual-compare"));
-async function comparePdf(actualPdfFilePath, expectedPdfFilePath, opts) {
-    const actualPdfFilePathResolved = (0, path_1.resolve)(actualPdfFilePath);
-    if (!(0, fs_1.existsSync)(actualPdfFilePathResolved)) {
+async function comparePdf(actualPdfFilePathOrBuffer, expectedPdfFilePathOrBuffer, opts) {
+    if (!Buffer.isBuffer(actualPdfFilePathOrBuffer) && !(0, fs_1.existsSync)(actualPdfFilePathOrBuffer)) {
         throw Error('Actual PDF file not found.');
     }
-    const expectedPdfFilePathResolved = (0, path_1.resolve)(expectedPdfFilePath);
-    if (!(0, fs_1.existsSync)(expectedPdfFilePathResolved)) {
+    if (!Buffer.isBuffer(expectedPdfFilePathOrBuffer) && !(0, fs_1.existsSync)(expectedPdfFilePathOrBuffer)) {
         throw Error('Expected PDF file not found.');
     }
-    const pdfToPngConvertOpts = opts?.pdfToPngConvertOptions ?? {};
-    pdfToPngConvertOpts.viewportScale = pdfToPngConvertOpts.viewportScale ?? 2.0;
-    pdfToPngConvertOpts.outputFileMask = pdfToPngConvertOpts.outputFileMask ?? 'comparePdf';
+    const pdfToPngConvertOpts = opts?.pdfToPngConvertOptions ?? {
+        viewportScale: 2.0,
+        outputFileMask: 'comparePdf',
+    };
+    const diffsOutputFolder = opts?.diffsOutputFolder
+        ? opts.diffsOutputFolder
+        : (0, path_1.resolve)(`./comparePdfOutput`);
+    const compareThreshold = opts?.compareThreshold
+        ? opts?.compareThreshold
+        : 0;
+    const excludedAreas = opts?.excludedAreas
+        ? opts.excludedAreas
+        : [];
+    if (compareThreshold < 0) {
+        throw Error('Compare Threshold cannot be less than 0.');
+    }
     const [actualPdfPngPages, expectedPdfPngPages] = await Promise.all([
-        (0, pdf_to_png_converter_1.pdfToPng)(actualPdfFilePathResolved, pdfToPngConvertOpts),
-        (0, pdf_to_png_converter_1.pdfToPng)((0, path_1.resolve)(expectedPdfFilePath), pdfToPngConvertOpts),
+        (0, pdf_to_png_converter_1.pdfToPng)(actualPdfFilePathOrBuffer, pdfToPngConvertOpts),
+        (0, pdf_to_png_converter_1.pdfToPng)(expectedPdfFilePathOrBuffer, pdfToPngConvertOpts),
     ]);
     if (actualPdfPngPages.length !== expectedPdfPngPages.length) {
         return false;
     }
     let overallCompareResult = true;
-    const diffsOutputFolder = opts?.diffsOutputFolder ?? (0, path_1.resolve)(`./test-results/comparePdf/${(0, path_1.parse)(actualPdfFilePathResolved).base}_vs_${(0, path_1.parse)(expectedPdfFilePath).base}`);
     actualPdfPngPages.forEach((actualPdfPngPage, index) => {
-        let comparePngOpts = {};
-        if (opts?.excludedAreas && opts.excludedAreas[index].excludedAreas) {
-            comparePngOpts = { ...opts.excludedAreas[index] };
-        }
-        comparePngOpts.diffFilePath = comparePngOpts.diffFilePath ?? (0, path_1.resolve)(diffsOutputFolder, `diff_${actualPdfPngPage.name}`);
-        const compareResult = (0, png_visual_compare_1.default)(actualPdfPngPage.content, expectedPdfPngPages.find((expectedPdfPngPage) => expectedPdfPngPage.name === actualPdfPngPage.name).content, comparePngOpts);
-        if (compareResult > 0) {
+        const comparePngOpts = { ...opts?.pdfToPngConvertOptions, ...excludedAreas[index] };
+        comparePngOpts.diffFilePath = (0, path_1.resolve)(diffsOutputFolder, `diff_${actualPdfPngPage.name}`);
+        const expectedPdfPngPage = expectedPdfPngPages.find((expectedPdfPngPage) => expectedPdfPngPage.name === actualPdfPngPage.name);
+        const compareResult = (0, png_visual_compare_1.default)(actualPdfPngPage.content, expectedPdfPngPage.content, comparePngOpts);
+        if (compareResult > compareThreshold) {
             overallCompareResult = false;
         }
     });

package/out/compare.pdf.js.map

@@ -1 +1 @@
-{"version":3,"file":"compare.pdf.js","sourceRoot":"","sources":["../src/compare.pdf.ts"],"names":[],"mappings":";;;;;AAAA,2BAAgC;AAChC,+BAAsC;AACtC,+DAA+D;AAC/D,4EAAmE;AAGpD,KAAK,UAAU,UAAU,CAAC,iBAAyB,EAAE,mBAA2B,EAAE,IAAwB;IACrH,MAAM,yBAAyB,GAAW,IAAA,cAAO,EAAC,iBAAiB,CAAC,CAAC;IACrE,IAAI,CAAC,IAAA,eAAU,EAAC,yBAAyB,CAAC,EAAE;QACxC,MAAM,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC7C;IAED,MAAM,2BAA2B,GAAW,IAAA,cAAO,EAAC,mBAAmB,CAAC,CAAC;IACzE,IAAI,CAAC,IAAA,eAAU,EAAC,2BAA2B,CAAC,EAAE;QAC1C,MAAM,KAAK,CAAC,8BAA8B,CAAC,CAAC;KAC/C;IAED,MAAM,mBAAmB,GAAoB,IAAI,EAAE,sBAAsB,IAAI,EAAE,CAAC;IAChF,mBAAmB,CAAC,aAAa,GAAG,mBAAmB,CAAC,aAAa,IAAI,GAAG,CAAC;IAC7E,mBAAmB,CAAC,cAAc,GAAG,mBAAmB,CAAC,cAAc,IAAI,YAAY,CAAC;IAExF,MAAM,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC/D,IAAA,+BAAQ,EAAC,yBAAyB,EAAE,mBAAmB,CAAC;QACxD,IAAA,+BAAQ,EAAC,IAAA,cAAO,EAAC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;KAC9D,CAAC,CAAC;IAEH,IAAI,iBAAiB,CAAC,MAAM,KAAK,mBAAmB,CAAC,MAAM,EAAE;QACzD,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,oBAAoB,GAAG,IAAI,CAAC;IAEhC,MAAM,iBAAiB,GACnB,IAAI,EAAE,iBAAiB,IAAI,IAAA,cAAO,EAAC,6BAA6B,IAAA,YAAK,EAAC,yBAAyB,CAAC,CAAC,IAAI,OAAO,IAAA,YAAK,EAAC,mBAAmB,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAEnJ,iBAAiB,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,KAAK,EAAE,EAAE;QAClD,IAAI,cAAc,GAAsB,EAAE,CAAC;QAE3C,IAAI,IAAI,EAAE,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE;YAChE,cAAc,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;SACrD;QACD,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,IAAI,IAAA,cAAO,EAAC,iBAAiB,EAAE,QAAQ,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC;QAEzH,MAAM,aAAa,GAAW,IAAA,4BAAU,EACpC,gBAAgB,CAAC,OAAO,EACvB,mBAAmB,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,KAAK,gBAAgB,CAAC,IAAI,CAAmB,CAAC,OAAO,EAC9H,cAAc,CACjB,CAAC;QAEF,IAAI,aAAa,GAAG,CAAC,EAAE;YACnB,oBAAoB,GAAG,KAAK,CAAC;SAChC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,oBAAoB,CAAC;AAChC,CAAC;AAjDD,6BAiDC"}
+{"version":3,"file":"compare.pdf.js","sourceRoot":"","sources":["../src/compare.pdf.ts"],"names":[],"mappings":";;;;;AAAA,2BAAgC;AAChC,+BAA+B;AAC/B,+DAA+D;AAC/D,4EAAmE;AAGpD,KAAK,UAAU,UAAU,CACtC,yBAAmD,EACnD,2BAAqD,EACrD,IAAwB;IAExB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAA,eAAU,EAAC,yBAAmC,CAAC,EAAE;QACnG,MAAM,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC3C;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAA,eAAU,EAAC,2BAAqC,CAAC,EAAE;QACvG,MAAM,KAAK,CAAC,8BAA8B,CAAC,CAAC;KAC7C;IAED,MAAM,mBAAmB,GAAoB,IAAI,EAAE,sBAAsB,IAAI;QAC3E,aAAa,EAAE,GAAG;QAClB,cAAc,EAAE,YAAY;KAC7B,CAAC;IACF,MAAM,iBAAiB,GAAW,IAAI,EAAE,iBAAiB;QACvD,CAAC,CAAC,IAAI,CAAC,iBAAiB;QACxB,CAAC,CAAC,IAAA,cAAO,EAAC,oBAAoB,CAAC,CAAC;IAClC,MAAM,gBAAgB,GAAW,IAAI,EAAE,gBAAgB;QACrD,CAAC,CAAC,IAAI,EAAE,gBAAgB;QACxB,CAAC,CAAC,CAAC,CAAC;IACN,MAAM,aAAa,GAAG,IAAI,EAAE,aAAa;QACvC,CAAC,CAAC,IAAI,CAAC,aAAa;QACpB,CAAC,CAAC,EAAE,CAAC;IACP,IAAI,gBAAgB,GAAG,CAAC,EAAE;QACxB,MAAM,KAAK,CAAC,0CAA0C,CAAC,CAAC;KACzD;IAED,MAAM,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACjE,IAAA,+BAAQ,EAAC,yBAAyB,EAAE,mBAAmB,CAAC;QACxD,IAAA,+BAAQ,EAAC,2BAA2B,EAAE,mBAAmB,CAAC;KAC3D,CAAC,CAAC;IAEH,IAAI,iBAAiB,CAAC,MAAM,KAAK,mBAAmB,CAAC,MAAM,EAAE;QAC3D,OAAO,KAAK,CAAC;KACd;IAED,IAAI,oBAAoB,GAAG,IAAI,CAAC;IAChC,iBAAiB,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,KAAK,EAAE,EAAE;QACpD,MAAM,cAAc,GAAsB,EAAE,GAAG,IAAI,EAAE,sBAAsB,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACvG,cAAc,CAAC,YAAY,GAAG,IAAA,cAAO,EAAC,iBAAiB,EAAE,QAAQ,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC;QAE1F,MAAM,kBAAkB,GAAG,mBAAmB,CAAC,IAAI,CACjD,CAAC,kBAAkB,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,KAAK,gBAAgB,CAAC,IAAI,CACzD,CAAC;QACnB,MAAM,aAAa,GAAW,IAAA,4BAAU,EAAC,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAE/G,IAAI,aAAa,GAAG,gBAAgB,EAAE;YACpC,oBAAoB,GAAG,KAAK,CAAC;SAC9B;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAvDD,6BAuDC"}

package/out/types/compare.options.d.ts

@@ -2,5 +2,6 @@ import { ExcludedPageArea, PdfToPngOptions } from '.';
 export declare type ComparePdfOptions = {
     diffsOutputFolder?: string;
     pdfToPngConvertOptions?: PdfToPngOptions;
-    excludedAreas: ExcludedPageArea[];
+    excludedAreas?: ExcludedPageArea[];
+    compareThreshold?: number;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pdf-visual-compare",
-  "version": "0.0.10",
-  "description": "Visual regression testing library for PDFs in Js/Ts",
+  "version": "1.1.1",
+  "description": "Visual regression testing library for PDFs in Js/Ts without binary and OS dependencies.",
   "keywords": [
     "pdf",
     "pdf regression",
@@ -39,18 +39,18 @@
     "tsc": "tsc --pretty"
   },
   "dependencies": {
-    "pdf-to-png-converter": "0.2.5",
+    "pdf-to-png-converter": "2.0.0",
     "png-visual-compare": "0.4.12"
   },
   "devDependencies": {
-    "@types/jest": "27.5.0",
-    "@types/node": "17.0.31",
-    "@typescript-eslint/eslint-plugin": "5.22.0",
-    "@typescript-eslint/parser": "5.22.0",
-    "eslint": "8.15.0",
-    "jest": "28.1.0",
-    "ts-jest": "28.0.1",
-    "ts-node": "10.7.0",
-    "typescript": "4.6.4"
+    "@types/jest": "28.1.1",
+    "@types/node": "17.0.41",
+    "@typescript-eslint/eslint-plugin": "5.27.1",
+    "@typescript-eslint/parser": "5.27.1",
+    "eslint": "8.17.0",
+    "jest": "28.1.1",
+    "ts-jest": "28.0.4",
+    "ts-node": "10.8.1",
+    "typescript": "4.7.3"
   }
 }