pdf-visual-compare 3.0.1 → 3.1.0

package/out/comparePdf.d.ts

@@ -1,3 +1,11 @@
-import { ComparePdfOptions } from './types/ComparePdfOptions.js';
+import type { ComparePdfOptions } from './types/ComparePdfOptions.js';
+/**
+ * Compares two PDF files or buffers and returns a boolean indicating whether they are similar.
+ *
+ * @param actualPdf - The file path or buffer of the actual PDF to compare.
+ * @param expectedPdf - The file path or buffer of the expected PDF to compare against.
+ * @param opts - Optional comparison options.
+ * @returns A promise that resolves to a boolean indicating whether the PDFs are similar.
+ * @throws Will throw an error if the compare threshold is less than 0.
+ */
 export declare function comparePdf(actualPdf: string | Buffer, expectedPdf: string | Buffer, opts?: ComparePdfOptions): Promise<boolean>;
-//# sourceMappingURL=comparePdf.d.ts.map

package/out/comparePdf.js

@@ -1,56 +1,71 @@
-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];
+/**
+ * Compares two PDF files or buffers and returns a boolean indicating whether they are similar.
+ *
+ * @param actualPdf - The file path or buffer of the actual PDF to compare.
+ * @param expectedPdf - The file path or buffer of the expected PDF to compare against.
+ * @param opts - Optional comparison options.
+ * @returns A promise that resolves to a boolean indicating whether the PDFs are similar.
+ * @throws Will throw an error if the compare threshold is less than 0.
+ */
+export async function comparePdf(actualPdf, expectedPdf, opts = {}) {
+    // Validate input file types
+    validateInputFileType(actualPdf);
+    validateInputFileType(expectedPdf);
+    // Set default options
+    const pdfToPngConvertOpts = { ...opts.pdfToPngConvertOptions };
+    if (!pdfToPngConvertOpts.viewportScale) {
+        pdfToPngConvertOpts.viewportScale = 2.0;
+    }
+    if (!pdfToPngConvertOpts.outputFileMaskFunc) {
+        pdfToPngConvertOpts.outputFileMaskFunc = (pageNumber) => `comparePdf_${pageNumber}.png`;
+    }
+    const diffsOutputFolder = opts?.diffsOutputFolder ?? DEFAULT_DIFFS_FOLDER;
+    const compareThreshold = opts?.compareThreshold ?? 0;
+    const excludedAreas = opts?.excludedAreas ?? [];
+    if (compareThreshold < 0) {
+        throw Error('Compare Threshold cannot be less than 0.');
+    }
+    // Convert PDFs to PNGs
+    let [actualPdfPngPages, expectedPdfPngPages] = await Promise.all([
+        pdfToPng(actualPdf, pdfToPngConvertOpts),
+        pdfToPng(expectedPdf, pdfToPngConvertOpts),
+    ]);
+    // Ensure actualPdfPngPages is always the longer array to avoid index out of bounds errors
+    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;
         }
-        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;
     });
+    return documentCompareResult;
 }
+/**
+ * Validates the type of the input file. The input file can either be a Buffer or a string representing a file path.
+ * If the input file is a Buffer, the function returns without any error.
+ * If the input file is a string, the function checks if the file exists at the given path.
+ * If the file does not exist, an error is thrown.
+ * If the input file is neither a Buffer nor a string, an error is thrown.
+ *
+ * @param inputFile - The input file to validate. It can be a Buffer or a string representing a file path.
+ * @throws {Error} If the input file is a string and the file does not exist.
+ * @throws {Error} If the input file is neither a Buffer nor a string.
+ */
 function validateInputFileType(inputFile) {
     if (Buffer.isBuffer(inputFile)) {
         return;
@@ -65,4 +80,3 @@ function validateInputFileType(inputFile) {
     }
     throw Error(`Unknown input file type.`);
 }
-//# sourceMappingURL=comparePdf.js.map

package/out/const.d.ts

@@ -1,2 +1 @@
 export declare const DEFAULT_DIFFS_FOLDER: string;
-//# sourceMappingURL=const.d.ts.map

package/out/const.js

@@ -1,3 +1,2 @@
 import { resolve } from 'node:path';
 export const DEFAULT_DIFFS_FOLDER = resolve(`./comparePdfOutput`);
-//# sourceMappingURL=const.js.map

package/out/index.d.ts

@@ -1,6 +1,3 @@
 export { comparePdf } from './comparePdf.js';
-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
+export type { ComparePdfOptions } from './types/ComparePdfOptions.js';
+export type { ExcludedPageArea } from './types/ExcludedPageArea.js';

package/out/index.js

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

package/out/types/ComparePdfOptions.d.ts

@@ -1,9 +1,8 @@
-import { PdfToPngOptions } from 'pdf-to-png-converter';
-import { ExcludedPageArea } from './ExcludedPageArea.js';
+import type { PdfToPngOptions } from 'pdf-to-png-converter';
+import type { 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.js

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

package/out/types/ExcludedPageArea.d.ts

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

package/out/types/ExcludedPageArea.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdf-visual-compare",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Visual regression testing library for PDFs in Js/Ts without binary and OS dependencies.",
   "keywords": [
     "pdf",
@@ -34,19 +34,20 @@
     "predocker:run": "npm run clean",
     "docker:run": "docker run --rm -it -v $PWD/test-results:/usr/pkg/test-results test-pdf-visual-compare",
     "docker:test": "vitest run",
-    "license-checker": "npx license-checker --production --onlyAllow 'MIT; MIT OR X11; BSD; ISC; Apache-2.0; Unlicense'",
+    "test:license": "npx --yes license-checker --production --onlyAllow \"ISC; MIT; MIT OR X11; BSD; Apache-2.0; Unlicense\"",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
-    "pretest": "npm run clean",
+    "pretest": "npm run clean && npm run lint && npm run test:license && npm run build",
     "test": "vitest run --coverage",
     "test:docker": "npm run docker:build && npm run docker:run"
   },
   "dependencies": {
-    "pdf-to-png-converter": "~3.8.0",
-    "png-visual-compare": "~3.0.0"
+    "pdf-to-png-converter": "~3.9.0",
+    "png-visual-compare": "~3.1.0"
   },
   "devDependencies": {
     "@types/node": "^24.5.2",
+    "@types/pngjs": "^6.0.5",
     "@typescript-eslint/eslint-plugin": "^8.44.0",
     "@typescript-eslint/parser": "^8.44.0",
     "@vitest/coverage-v8": "^3.2.4",
@@ -60,4 +61,4 @@
     "node": ">=20",
     "yarn": "please-use-npm"
   }
-}
+}

package/out/comparePdf.d.ts.map

@@ -1 +0,0 @@
-{"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.map

@@ -1 +0,0 @@
-{"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,EAAE,UAAU,EAAqB,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/const.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"const.d.ts","sourceRoot":"","sources":["../src/const.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,oBAAoB,QAAgC,CAAC"}

package/out/const.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"const.js","sourceRoot":"","sources":["../src/const.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,CAAC,MAAM,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC"}

package/out/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,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.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC"}

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

@@ -1 +0,0 @@
-{"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.map

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

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

@@ -1 +0,0 @@
-{"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.map

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