pdf-visual-compare 2.2.0 → 2.4.0

package/README.md

@@ -1,45 +1,45 @@
 # pdf-visual-compare
 
-Visual regression testing library for PDFs in Js/Ts without binary and OS dependencies.
+Visual regression testing library for PDFs in JavaScript/TypeScript 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
+## Getting Started
 
-Installation:
+### Installation
 
 ```sh
 npm install -D pdf-visual-compare
 ```
 
-## Example
+### Example
 
 ```javascript
-  const result: boolean = await comparePdf('./pdf1.pdf', './pdf2.pdf');
+const result = await comparePdf('./pdf1.pdf', './pdf2.pdf');
 
-  // If you want to configure comparing process, use the following props
+// If you want to configure the comparing process, use the following options
 
-  const result: boolean = await comparePdf('./pdf1.pdf', './pdf2.pdf', {
-  diffsOutputFolder?: string; // Folder to write output PNG files with differences
-  pdfToPngConvertOptions?: {
+const result = await comparePdf('./pdf1.pdf', './pdf2.pdf', {
+  diffsOutputFolder: 'diffs', // Folder to write output PNG files with differences
+  pdfToPngConvertOptions: {
     viewportScale: 2.0, // The desired scale of PNG viewport. Default value is 2.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.
+    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.
+    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.
+  },
+  excludedAreas: [], // Areas list to exclude from comparing for each PDF page. Empty array by default.
+  compareThreshold: 0.1 // Comparing threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0.1 by default.
 });
-
 ```
 
-## Buy Me A Coffee
+## Support
+
+If you want to support my work, you can 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)
 
-[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/dichovsky)

package/out/comparePdf.d.ts

@@ -0,0 +1,3 @@
+import { ComparePdfOptions } from './types/ComparePdfOptions.js';
+export declare function comparePdf(actualPdf: string | Buffer, expectedPdf: string | Buffer, opts?: ComparePdfOptions): Promise<boolean>;
+//# sourceMappingURL=comparePdf.d.ts.map

package/out/comparePdf.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comparePdf.d.ts","sourceRoot":"","sources":["../src/comparePdf.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAYjE,wBAAsB,UAAU,CAC5B,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,WAAW,EAAE,MAAM,GAAG,MAAM,EAC5B,IAAI,GAAE,iBAAsB,GAC7B,OAAO,CAAC,OAAO,CAAC,CA0DlB"}

package/out/comparePdf.js

@@ -0,0 +1,68 @@
+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());
+    });
+};
+import { existsSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { pdfToPng } from 'pdf-to-png-converter';
+import comparePng from 'png-visual-compare';
+import { DEFAULT_DIFFS_FOLDER } from './const.js';
+export function comparePdf(actualPdf_1, expectedPdf_1) {
+    return __awaiter(this, arguments, void 0, function* (actualPdf, expectedPdf, opts = {}) {
+        var _a, _b, _c;
+        validateInputFileType(actualPdf);
+        validateInputFileType(expectedPdf);
+        const pdfToPngConvertOpts = Object.assign({}, opts.pdfToPngConvertOptions);
+        if (!pdfToPngConvertOpts.viewportScale) {
+            pdfToPngConvertOpts.viewportScale = 2.0;
+        }
+        if (!pdfToPngConvertOpts.outputFileMaskFunc) {
+            pdfToPngConvertOpts.outputFileMaskFunc = (pageNumber) => `comparePdf_${pageNumber}.png`;
+        }
+        const diffsOutputFolder = (_a = opts === null || opts === void 0 ? void 0 : opts.diffsOutputFolder) !== null && _a !== void 0 ? _a : DEFAULT_DIFFS_FOLDER;
+        const compareThreshold = (_b = opts === null || opts === void 0 ? void 0 : opts.compareThreshold) !== null && _b !== void 0 ? _b : 0;
+        const excludedAreas = (_c = opts === null || opts === void 0 ? void 0 : opts.excludedAreas) !== null && _c !== void 0 ? _c : [];
+        if (compareThreshold < 0) {
+            throw Error('Compare Threshold cannot be less than 0.');
+        }
+        let [actualPdfPngPages, expectedPdfPngPages] = yield Promise.all([
+            pdfToPng(actualPdf, pdfToPngConvertOpts),
+            pdfToPng(expectedPdf, pdfToPngConvertOpts),
+        ]);
+        if (actualPdfPngPages.length < expectedPdfPngPages.length) {
+            [actualPdfPngPages, expectedPdfPngPages] = [expectedPdfPngPages, actualPdfPngPages];
+        }
+        let documentCompareResult = true;
+        actualPdfPngPages.forEach((pngPage, index) => {
+            var _a;
+            const comparePngOpts = Object.assign(Object.assign(Object.assign({}, opts === null || opts === void 0 ? void 0 : opts.pdfToPngConvertOptions), excludedAreas[index]), { throwErrorOnInvalidInputData: false });
+            comparePngOpts.diffFilePath = resolve(diffsOutputFolder, `diff_${pngPage.name}`);
+            const pngPageOutputToCompareWith = expectedPdfPngPages.find((p) => p.name === pngPage.name);
+            const pageCompareResult = comparePng(pngPage.content, (_a = pngPageOutputToCompareWith === null || pngPageOutputToCompareWith === void 0 ? void 0 : pngPageOutputToCompareWith.content) !== null && _a !== void 0 ? _a : '', comparePngOpts);
+            if (pageCompareResult > compareThreshold) {
+                documentCompareResult = false;
+            }
+        });
+        return documentCompareResult;
+    });
+}
+function validateInputFileType(inputFile) {
+    if (Buffer.isBuffer(inputFile)) {
+        return;
+    }
+    if (typeof inputFile === 'string') {
+        if (existsSync(inputFile)) {
+            return;
+        }
+        else {
+            throw Error(`PDF file not found: ${inputFile}`);
+        }
+    }
+    throw Error(`Unknown input file type.`);
+}
+//# sourceMappingURL=comparePdf.js.map

package/out/comparePdf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comparePdf.js","sourceRoot":"","sources":["../src/comparePdf.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAkC,MAAM,sBAAsB,CAAC;AAChF,OAAO,UAAiC,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAalD,MAAM,UAAgB,UAAU;yDAC5B,SAA0B,EAC1B,WAA4B,EAC5B,OAA0B,EAAE;;QAG5B,qBAAqB,CAAC,SAAS,CAAC,CAAC;QACjC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAGnC,MAAM,mBAAmB,qBAAyB,IAAI,CAAC,sBAAsB,CAAE,CAAC;QAChF,IAAI,CAAC,mBAAmB,CAAC,aAAa,EAAE,CAAC;YACrC,mBAAmB,CAAC,aAAa,GAAG,GAAG,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,CAAC;YAC1C,mBAAmB,CAAC,kBAAkB,GAAG,CAAC,UAAkB,EAAE,EAAE,CAAC,cAAc,UAAU,MAAM,CAAC;QACpG,CAAC;QAED,MAAM,iBAAiB,GAAW,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,iBAAiB,mCAAI,oBAAoB,CAAC;QAClF,MAAM,gBAAgB,GAAW,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,mCAAI,CAAC,CAAC;QAC7D,MAAM,aAAa,GAAgC,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,mCAAI,EAAE,CAAC;QAE7E,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC5D,CAAC;QAGD,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC7D,QAAQ,CAAC,SAAS,EAAE,mBAAmB,CAAC;YACxC,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;SAC7C,CAAC,CAAC;QAGH,IAAI,iBAAiB,CAAC,MAAM,GAAG,mBAAmB,CAAC,MAAM,EAAE,CAAC;YACxD,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,GAAG,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;QACxF,CAAC;QAED,IAAI,qBAAqB,GAAG,IAAI,CAAC;QACjC,iBAAiB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;;YACzC,MAAM,cAAc,iDACb,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,sBAAsB,GAC5B,aAAa,CAAC,KAAK,CAAC,KACvB,4BAA4B,EAAE,KAAK,GACtC,CAAC;YACF,cAAc,CAAC,YAAY,GAAG,OAAO,CAAC,iBAAiB,EAAE,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YAEjF,MAAM,0BAA0B,GAA8B,mBAAmB,CAAC,IAAI,CAClF,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CACjC,CAAC;YAEF,MAAM,iBAAiB,GAAW,UAAU,CACxC,OAAO,CAAC,OAAO,EACf,MAAA,0BAA0B,aAA1B,0BAA0B,uBAA1B,0BAA0B,CAAE,OAAO,mCAAI,EAAE,EACzC,cAAc,CACjB,CAAC;YAEF,IAAI,iBAAiB,GAAG,gBAAgB,EAAE,CAAC;gBACvC,qBAAqB,GAAG,KAAK,CAAC;YAClC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,qBAAqB,CAAC;IACjC,CAAC;CAAA;AAaD,SAAS,qBAAqB,CAAC,SAAc;IACzC,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7B,OAAO;IACX,CAAC;IACD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAChC,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,OAAO;QACX,CAAC;aAAM,CAAC;YACJ,MAAM,KAAK,CAAC,uBAAuB,SAAS,EAAE,CAAC,CAAC;QACpD,CAAC;IACL,CAAC;IACD,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;AAC5C,CAAC"}

package/out/index.d.ts

@@ -1,4 +1,7 @@
-import comparePdf from './compare.pdf';
+import { comparePdf } from './comparePdf.js';
 export default comparePdf;
-export * from './types';
+export { PdfToPngOptions } from 'pdf-to-png-converter';
+export { Area, Color } from 'png-visual-compare';
+export { ComparePdfOptions } from './types/ComparePdfOptions.js';
+export { ExcludedPageArea } from './types/ExcludedPageArea.js';
 //# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,eAAe,UAAU,CAAC;AAG1B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAGjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC"}

package/out/index.js

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

package/out/index.js.map

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

package/out/types/ComparePdfOptions.d.ts

@@ -0,0 +1,9 @@
+import { PdfToPngOptions } from 'pdf-to-png-converter';
+import { ExcludedPageArea } from './ExcludedPageArea.js';
+export type ComparePdfOptions = {
+    diffsOutputFolder?: string;
+    pdfToPngConvertOptions?: PdfToPngOptions;
+    excludedAreas?: readonly ExcludedPageArea[];
+    compareThreshold?: number;
+};
+//# sourceMappingURL=ComparePdfOptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComparePdfOptions.d.ts","sourceRoot":"","sources":["../../src/types/ComparePdfOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sBAAsB,CAAC,EAAE,eAAe,CAAC;IACzC,aAAa,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}

package/out/types/ComparePdfOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ComparePdfOptions.js.map

package/out/types/ComparePdfOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComparePdfOptions.js","sourceRoot":"","sources":["../../src/types/ComparePdfOptions.ts"],"names":[],"mappings":""}

package/out/types/{excluded.page.area.d.ts → ExcludedPageArea.d.ts}

@@ -1,4 +1,4 @@
-import { Area, Color } from '.';
+import { Area, Color } from 'png-visual-compare';
 export type ExcludedPageArea = {
     pageNumber: number;
     excludedAreas?: Area[];
@@ -6,4 +6,4 @@ export type ExcludedPageArea = {
     diffFilePath?: string;
     matchingThreshold?: number;
 };
-//# sourceMappingURL=excluded.page.area.d.ts.map
+//# sourceMappingURL=ExcludedPageArea.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExcludedPageArea.d.ts","sourceRoot":"","sources":["../../src/types/ExcludedPageArea.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,MAAM,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/ExcludedPageArea.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ExcludedPageArea.js.map

package/out/types/ExcludedPageArea.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExcludedPageArea.js","sourceRoot":"","sources":["../../src/types/ExcludedPageArea.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdf-visual-compare",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "description": "Visual regression testing library for PDFs in Js/Ts without binary and OS dependencies.",
   "keywords": [
     "pdf",
@@ -18,10 +18,17 @@
   },
   "license": "MIT",
   "author": "Igor Magdich <magdich.igor@gmail.com>",
-  "main": "out/index.js",
-  "types": "out/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "default": "./out/index.js",
+      "types": "./out/index.d.ts"
+    }
+  },
+  "main": "./out/index.js",
+  "types": "./out/index.d.ts",
   "files": [
-    "/out"
+    "./out"
   ],
   "scripts": {
     "prebuild": "npm run clean",
@@ -39,18 +46,22 @@
     "test:docker": "npm run docker:build && npm run docker:run"
   },
   "dependencies": {
-    "pdf-to-png-converter": "^3.3.0",
-    "png-visual-compare": "^2.1.0"
+    "pdf-to-png-converter": "^3.6.1",
+    "png-visual-compare": "^2.2.1"
   },
   "devDependencies": {
-    "@types/node": "^22.5.1",
-    "@typescript-eslint/eslint-plugin": "^8.3.0",
-    "@typescript-eslint/parser": "^8.3.0",
-    "@vitest/coverage-v8": "^2.0.5",
-    "eslint": "^9.9.1",
+    "@types/node": "^22.10.1",
+    "@typescript-eslint/eslint-plugin": "^8.17.0",
+    "@typescript-eslint/parser": "^8.17.0",
+    "@vitest/coverage-v8": "^2.1.8",
+    "eslint": "^9.16.0",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.5.4",
-    "vitest": "^2.0.5"
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  },
+  "engines": {
+    "node": ">=20",
+    "yarn": "please-use-npm"
   }
 }

package/out/compare.pdf.d.ts

@@ -1,3 +0,0 @@
-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

@@ -1 +0,0 @@
-{"version":3,"file":"compare.pdf.d.ts","sourceRoot":"","sources":["../src/compare.pdf.ts"],"names":[],"mappings":"AAKA,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,CA8ClB"}

package/out/compare.pdf.js

@@ -1,55 +0,0 @@
-import { existsSync } from 'node:fs';
-import { resolve } from 'node:path';
-import { pdfToPng } from 'pdf-to-png-converter';
-import comparePng from 'png-visual-compare';
-import { DEFAULT_DIFFS_FOLDER } from './const';
-export default async function comparePdf(actualPdfFilePathOrBuffer, expectedPdfFilePathOrBuffer, opts) {
-    inputFileTypeGuard(actualPdfFilePathOrBuffer);
-    inputFileTypeGuard(expectedPdfFilePathOrBuffer);
-    const pdfToPngConvertOpts = { ...opts?.pdfToPngConvertOptions };
-    if (!pdfToPngConvertOpts.viewportScale) {
-        pdfToPngConvertOpts.viewportScale = 2.0;
-    }
-    if (!pdfToPngConvertOpts.outputFileMask) {
-        pdfToPngConvertOpts.outputFileMask = 'comparePdf';
-    }
-    const diffsOutputFolder = opts?.diffsOutputFolder ? opts.diffsOutputFolder : DEFAULT_DIFFS_FOLDER;
-    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.');
-    }
-    let [actualPdfPngPages, expectedPdfPngPages] = await Promise.all([
-        pdfToPng(actualPdfFilePathOrBuffer, pdfToPngConvertOpts),
-        pdfToPng(expectedPdfFilePathOrBuffer, pdfToPngConvertOpts),
-    ]);
-    if (actualPdfPngPages.length < expectedPdfPngPages.length) {
-        [actualPdfPngPages, expectedPdfPngPages] = [expectedPdfPngPages, actualPdfPngPages];
-    }
-    let documentCompareResult = true;
-    actualPdfPngPages.forEach((pngPage, index) => {
-        const comparePngOpts = { ...opts?.pdfToPngConvertOptions, ...excludedAreas[index], throwErrorOnInvalidInputData: false };
-        comparePngOpts.diffFilePath = resolve(diffsOutputFolder, `diff_${pngPage.name}`);
-        const pngPageOutputToCompareWith = expectedPdfPngPages.find((p) => p.name === pngPage.name);
-        const pageCompareResult = comparePng(pngPage.content, pngPageOutputToCompareWith?.content ?? '', comparePngOpts);
-        if (pageCompareResult > compareThreshold) {
-            documentCompareResult = false;
-        }
-    });
-    return documentCompareResult;
-}
-function inputFileTypeGuard(inputFile) {
-    if (Buffer.isBuffer(inputFile)) {
-        return;
-    }
-    if (typeof inputFile === 'string') {
-        if (existsSync(inputFile)) {
-            return;
-        }
-        else {
-            throw Error(`PDF file not found.`);
-        }
-    }
-    throw Error(`Unknown input file type.`);
-}
-//# sourceMappingURL=compare.pdf.js.map

package/out/compare.pdf.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"compare.pdf.js","sourceRoot":"","sources":["../src/compare.pdf.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAiB,MAAM,sBAAsB,CAAC;AAC/D,OAAO,UAAiC,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAG/C,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,UAAU,CACtC,yBAAmD,EACnD,2BAAqD,EACrD,IAAwB;IAExB,kBAAkB,CAAC,yBAAyB,CAAC,CAAC;IAC9C,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;IAEhD,MAAM,mBAAmB,GAAoB,EAAE,GAAG,IAAI,EAAE,sBAAsB,EAAE,CAAC;IACjF,IAAI,CAAC,mBAAmB,CAAC,aAAa,EAAE,CAAC;QACvC,mBAAmB,CAAC,aAAa,GAAG,GAAG,CAAC;IAC1C,CAAC;IACD,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC;QACxC,mBAAmB,CAAC,cAAc,GAAG,YAAY,CAAC;IACpD,CAAC;IAED,MAAM,iBAAiB,GAAW,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,oBAAoB,CAAC;IAC1G,MAAM,gBAAgB,GAAW,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,MAAM,aAAa,GAAuB,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAExF,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC/D,QAAQ,CAAC,yBAAyB,EAAE,mBAAmB,CAAC;QACxD,QAAQ,CAAC,2BAA2B,EAAE,mBAAmB,CAAC;KAC3D,CAAC,CAAC;IAEH,IAAI,iBAAiB,CAAC,MAAM,GAAG,mBAAmB,CAAC,MAAM,EAAE,CAAC;QAC1D,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,GAAG,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;IACtF,CAAC;IAED,IAAI,qBAAqB,GAAG,IAAI,CAAC;IACjC,iBAAiB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;QAC3C,MAAM,cAAc,GAAsB,EAAE,GAAG,IAAI,EAAE,sBAAsB,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,4BAA4B,EAAE,KAAK,EAAE,CAAC;QAC5I,cAAc,CAAC,YAAY,GAAG,OAAO,CAAC,iBAAiB,EAAE,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAEjF,MAAM,0BAA0B,GAA8B,mBAAmB,CAAC,IAAI,CACpF,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAC/B,CAAC;QAEF,MAAM,iBAAiB,GAAW,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,0BAA0B,EAAE,OAAO,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC;QAEzH,IAAI,iBAAiB,GAAG,gBAAgB,EAAE,CAAC;YACzC,qBAAqB,GAAG,KAAK,CAAC;QAChC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAED,SAAS,kBAAkB,CAAC,SAAc;IACxC,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/B,OAAO;IACT,CAAC;IACD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAClC,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IACD,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;AAC1C,CAAC"}

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

@@ -1,8 +0,0 @@
-import { ExcludedPageArea, PdfToPngOptions } from '.';
-export type ComparePdfOptions = {
-    diffsOutputFolder?: string;
-    pdfToPngConvertOptions?: PdfToPngOptions;
-    excludedAreas?: ExcludedPageArea[];
-    compareThreshold?: number;
-};
-//# sourceMappingURL=compare.options.d.ts.map

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

@@ -1 +0,0 @@
-{"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,MAAM,MAAM,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/compare.options.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=compare.options.js.map

package/out/types/compare.options.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"compare.options.js","sourceRoot":"","sources":["../../src/types/compare.options.ts"],"names":[],"mappings":""}

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

@@ -1 +0,0 @@
-{"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,MAAM,MAAM,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/excluded.page.area.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=excluded.page.area.js.map

package/out/types/excluded.page.area.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"excluded.page.area.js","sourceRoot":"","sources":["../../src/types/excluded.page.area.ts"],"names":[],"mappings":""}

package/out/types/index.d.ts

@@ -1,5 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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/out/types/index.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.js.map

package/out/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}