pdf-visual-compare 1.1.0 → 1.2.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,3 @@
 import { ComparePdfOptions } from './types';
 export default function comparePdf(actualPdfFilePathOrBuffer: string | ArrayBufferLike, expectedPdfFilePathOrBuffer: string | ArrayBufferLike, opts?: ComparePdfOptions): Promise<boolean>;
+//# sourceMappingURL=compare.pdf.d.ts.map

package/out/compare.pdf.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare.pdf.d.ts","sourceRoot":"","sources":["../src/compare.pdf.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAqC,MAAM,SAAS,CAAC;AAE/E,wBAA8B,UAAU,CACtC,yBAAyB,EAAE,MAAM,GAAG,eAAe,EACnD,2BAA2B,EAAE,MAAM,GAAG,eAAe,EACrD,IAAI,CAAC,EAAE,iBAAiB,GACvB,OAAO,CAAC,OAAO,CAAC,CAqDlB"}

package/out/compare.pdf.js

@@ -14,10 +14,13 @@ async function comparePdf(actualPdfFilePathOrBuffer, expectedPdfFilePathOrBuffer
     if (!Buffer.isBuffer(expectedPdfFilePathOrBuffer) && !(0, fs_1.existsSync)(expectedPdfFilePathOrBuffer)) {
         throw Error('Expected PDF file not found.');
     }
-    const pdfToPngConvertOpts = opts?.pdfToPngConvertOptions ?? {
-        viewportScale: 2.0,
-        outputFileMask: 'comparePdf',
-    };
+    const pdfToPngConvertOpts = { ...opts?.pdfToPngConvertOptions };
+    if (!pdfToPngConvertOpts.viewportScale) {
+        pdfToPngConvertOpts.viewportScale = 2.0;
+    }
+    if (!pdfToPngConvertOpts.outputFileMask) {
+        pdfToPngConvertOpts.outputFileMask = 'comparePdf';
+    }
     const diffsOutputFolder = opts?.diffsOutputFolder
         ? opts.diffsOutputFolder
         : (0, path_1.resolve)(`./comparePdfOutput`);
@@ -37,17 +40,17 @@ async function comparePdf(actualPdfFilePathOrBuffer, expectedPdfFilePathOrBuffer
     if (actualPdfPngPages.length !== expectedPdfPngPages.length) {
         return false;
     }
-    let overallCompareResult = true;
+    let documentCompareResult = true;
     actualPdfPngPages.forEach((actualPdfPngPage, index) => {
         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;
+        const expectedPngPageOutput = expectedPdfPngPages.find((p) => p.name === actualPdfPngPage.name);
+        const pageCompareResult = (0, png_visual_compare_1.default)(actualPdfPngPage.content, expectedPngPageOutput.content, comparePngOpts);
+        if (pageCompareResult > compareThreshold) {
+            documentCompareResult = false;
         }
     });
-    return overallCompareResult;
+    return documentCompareResult;
 }
 exports.default = comparePdf;
 //# sourceMappingURL=compare.pdf.js.map

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,+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"}
+{"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,EAAC,GAAG,IAAI,EAAE,sBAAsB,EAAE,CAAC;IAChF,IAAI,CAAC,mBAAmB,CAAC,aAAa,EAAE;QACtC,mBAAmB,CAAC,aAAa,GAAG,GAAG,CAAA;KACxC;IACD,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE;QACvC,mBAAmB,CAAC,cAAc,GAAG,YAAY,CAAA;KAClD;IAED,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,GAAuB,IAAI,EAAE,aAAa;QAC3D,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,qBAAqB,GAAG,IAAI,CAAC;IACjC,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,qBAAqB,GAAkB,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,IAAI,CAAkB,CAAC;QAChI,MAAM,iBAAiB,GAAW,IAAA,4BAAU,EAAC,gBAAgB,CAAC,OAAO,EAAE,qBAAqB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAEtH,IAAI,iBAAiB,GAAG,gBAAgB,EAAE;YACxC,qBAAqB,GAAG,KAAK,CAAC;SAC/B;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAzDD,6BAyDC"}

package/out/index.d.ts

@@ -1,3 +1,4 @@
 import comparePdf from './compare.pdf';
 export default comparePdf;
 export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,eAAe,CAAC;AACvC,eAAe,UAAU,CAAC;AAC1B,cAAc,SAAS,CAAC"}

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

@@ -5,3 +5,4 @@ export declare type ComparePdfOptions = {
     excludedAreas?: ExcludedPageArea[];
     compareThreshold?: number;
 };
+//# sourceMappingURL=compare.options.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"compare.options.d.ts","sourceRoot":"","sources":["../../src/types/compare.options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,GAAG,CAAC;AAEtD,oBAAY,iBAAiB,GAAG;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sBAAsB,CAAC,EAAE,eAAe,CAAC;IACzC,aAAa,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}

package/out/types/excluded.page.area.d.ts

@@ -6,3 +6,4 @@ export declare type ExcludedPageArea = {
     diffFilePath?: string;
     matchingThreshold?: number;
 };
+//# sourceMappingURL=excluded.page.area.d.ts.map

package/out/types/excluded.page.area.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"excluded.page.area.d.ts","sourceRoot":"","sources":["../../src/types/excluded.page.area.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAEhC,oBAAY,gBAAgB,GAAG;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC;IACvB,iBAAiB,CAAC,EAAE,KAAK,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC"}

package/out/types/index.d.ts

@@ -2,3 +2,4 @@ export { PdfToPngOptions } from 'pdf-to-png-converter';
 export { Area, Color } from 'png-visual-compare';
 export { ComparePdfOptions } from '../types/compare.options';
 export { ExcludedPageArea } from './excluded.page.area';
+//# sourceMappingURL=index.d.ts.map

package/out/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdf-visual-compare",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Visual regression testing library for PDFs in Js/Ts without binary and OS dependencies.",
   "keywords": [
     "pdf",
@@ -25,7 +25,7 @@
   ],
   "scripts": {
     "build": "npm run clean && npm run tsc",
-    "clean": "rimraf ./out ./coverage ./test-results",
+    "clean": "rimraf ./out ./coverage ./test-results ./comparePdfOutput",
     "docker:build": "docker build --compress -t test-pdf-visual-compare .",
     "predocker:run": "npm run clean",
     "docker:run": "docker run --rm -it -v ./test-results:/usr/pkg/test-results test-pdf-visual-compare",
@@ -33,24 +33,24 @@
     "license-checker": "npx license-checker --production --onlyAllow 'MIT; MIT OR X11; BSD; ISC; Apache-2.0; Unlicense'",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
-    "pretest": "npm run clean",
+    "pretest": "npm run build",
     "test": "jest",
     "test:docker": "npm run docker:build && npm run docker:run",
     "tsc": "tsc --pretty"
   },
   "dependencies": {
-    "pdf-to-png-converter": "2.0.0",
-    "png-visual-compare": "0.4.12"
+    "pdf-to-png-converter": "2.3.0",
+    "png-visual-compare": "0.4.14"
   },
   "devDependencies": {
-    "@types/jest": "27.5.1",
-    "@types/node": "17.0.34",
-    "@typescript-eslint/eslint-plugin": "5.25.0",
-    "@typescript-eslint/parser": "5.25.0",
-    "eslint": "8.15.0",
-    "jest": "28.1.0",
-    "ts-jest": "28.0.2",
-    "ts-node": "10.7.0",
-    "typescript": "4.6.4"
+    "@types/jest": "28.1.6",
+    "@types/node": "18.6.3",
+    "@typescript-eslint/eslint-plugin": "5.32.0",
+    "@typescript-eslint/parser": "5.32.0",
+    "eslint": "8.21.0",
+    "jest": "28.1.3",
+    "ts-jest": "28.0.7",
+    "ts-node": "10.9.1",
+    "typescript": "4.7.4"
   }
 }