pdf-visual-compare 3.3.0 → 3.5.0

package/LICENSE

@@ -1,201 +1,21 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+MIT License
+
+Copyright (c) 2024 Igor Magdich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,169 @@
 # pdf-visual-compare
 
-Visual regression testing library for PDFs in JavaScript/TypeScript without binary and OS dependencies.
+<p align="center">
+  <strong>Visual regression testing library for PDFs in JavaScript/TypeScript without binary or OS dependencies</strong>
+</p>
 
-[![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)
+<p align="center">
+  <a href="https://www.npmjs.com/package/pdf-visual-compare">
+    <img src="https://img.shields.io/npm/v/pdf-visual-compare.svg?style=flat-square" alt="npm version">
+  </a>
+  <a href="https://www.npmjs.com/package/pdf-visual-compare">
+    <img src="https://img.shields.io/npm/dm/pdf-visual-compare.svg?style=flat-square" alt="npm downloads">
+  </a>
+  <a href="https://github.com/dichovsky/pdf-visual-compare/actions/workflows/test.yml">
+    <img src="https://github.com/dichovsky/pdf-visual-compare/actions/workflows/test.yml/badge.svg?branch=main" alt="Tests">
+  </a>
+  <a href="https://github.com/dichovsky/pdf-visual-compare/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/dichovsky/pdf-visual-compare?style=flat-square" alt="License">
+  </a>
+</p>
 
-## Getting Started
+---
 
-### Installation
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Basic comparison](#basic-comparison)
+  - [Comparison with options](#comparison-with-options)
+  - [Comparing PDF buffers](#comparing-pdf-buffers)
+- [API](#api)
+  - [comparePdf](#comparepdfactualpdf-expectedpdf-options)
+  - [ComparePdfOptions](#comparepdfoptions)
+  - [ExcludedPageArea](#excludedpagearea)
+- [Support](#support)
+
+---
+
+## Requirements
+
+- Node.js >= 20
+
+---
+
+## Installation
 
 ```sh
 npm install -D pdf-visual-compare
 ```
 
-### Example
+---
+
+## Usage
+
+### Basic comparison
+
+```typescript
+import { comparePdf } from 'pdf-visual-compare';
+
+const isEqual = await comparePdf('./actual.pdf', './expected.pdf');
+// true  → PDFs are visually identical
+// false → PDFs differ
+```
+
+### Comparison with options
 
-```javascript
-const result = await comparePdf('./pdf1.pdf', './pdf2.pdf');
+```typescript
+import { comparePdf } from 'pdf-visual-compare';
 
-// If you want to configure the comparing process, use the following options
+const isEqual = await comparePdf('./actual.pdf', './expected.pdf', {
+  // Folder for diff PNG images written when differences are found. Default: ./comparePdfOutput
+  diffsOutputFolder: 'test-results/diffs',
+
+  // Maximum number of differing pixels allowed before the comparison fails.
+  // 0 = pixel-perfect match required (default). Must be >= 0.
+  compareThreshold: 200,
+
+  // Per-page exclusion zones, matched by the `pageNumber` field (1-based).
+  // `pageNumber: 1` → first page, `pageNumber: 2` → second page, etc.
+  // Pixel coordinates are relative to the rendered PNG at the configured viewportScale.
+  excludedAreas: [
+    {
+      pageNumber: 1,
+      excludedAreas: [
+        { x1: 700, y1: 375, x2: 790, y2: 400 }, // dynamic timestamp on page 1
+      ],
+    },
+    {
+      pageNumber: 2,
+      excludedAreas: [
+        { x1: 680, y1: 240, x2: 955, y2: 465 }, // chart on page 2
+      ],
+    },
+  ],
 
-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.
-    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.
+    viewportScale: 2.0,          // Rendering scale — higher means more detail. Default: 2.0.
+    disableFontFace: true,       // Use built-in font renderer. Default: true.
+    useSystemFonts: false,       // Fall back to system fonts for non-embedded fonts. Default: false.
+    enableXfa: false,            // Enable XFA form rendering. Default: false.
+    pdfFilePassword: 'pa$$word', // Password for encrypted PDFs.
+    outputFolder: 'output/pngs', // Save intermediate PNG files here. Omit to keep in memory only.
+    outputFileMaskFunc: (pageNumber) => `page_${pageNumber}.png`, // Custom PNG filename.
+    pagesToProcess: [1, 3],      // Limit comparison to specific pages (1-based). Default: all pages.
+    verbosityLevel: 0,           // 0 = errors only, 1 = warnings, 5 = info. Default: 0.
   },
-  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.
 });
 ```
 
+### Comparing PDF buffers
+
+Both file paths and `Buffer` instances are accepted as inputs:
+
+```typescript
+import { readFileSync } from 'node:fs';
+import { comparePdf } from 'pdf-visual-compare';
+
+const actual = readFileSync('./actual.pdf');
+const expected = readFileSync('./expected.pdf');
+
+const isEqual = await comparePdf(actual, expected);
+```
+
+---
+
+## API
+
+### `comparePdf(actualPdf, expectedPdf, options?)`
+
+| Parameter     | Type                                        | Description                               |
+| ------------- | ------------------------------------------- | ----------------------------------------- |
+| `actualPdf`   | `string \| Buffer \| ArrayBufferLike`       | File path or buffer of the PDF under test |
+| `expectedPdf` | `string \| Buffer \| ArrayBufferLike`       | File path or buffer of the reference PDF  |
+| `options`     | `ComparePdfOptions` _(optional)_            | Comparison configuration                  |
+
+Returns `Promise<boolean>` — `true` if the PDFs are visually equivalent within the configured threshold, `false` otherwise.
+
+**Throws:**
+- `Error: PDF file not found: <path>` — when a string argument points to a non-existent file.
+- `Error: Unknown input file type.` — when an argument is neither a string nor a Buffer.
+- `Error: Compare Threshold cannot be less than 0.` — when `options.compareThreshold < 0`.
+
+### `ComparePdfOptions`
+
+| Property                 | Type                  | Default              | Description                                                                 |
+| ------------------------ | --------------------- | -------------------- | --------------------------------------------------------------------------- |
+| `diffsOutputFolder`      | `string`              | `./comparePdfOutput` | Folder where diff PNG images are written                                    |
+| `compareThreshold`       | `number`              | `0`                  | Maximum number of differing pixels allowed before comparison fails          |
+| `excludedAreas`          | `ExcludedPageArea[]`  | `[]`                 | Per-page exclusion zones matched by the `pageNumber` field of each entry (1-based) |
+| `pdfToPngConvertOptions` | `PdfToPngOptions`     | see below            | Options forwarded to [`pdf-to-png-converter`](https://github.com/dichovsky/pdf-to-png-converter) |
+
+### `ExcludedPageArea`
+
+| Property            | Type     | Description                                                                                         |
+| ------------------- | -------- | --------------------------------------------------------------------------------------------------- |
+| `pageNumber`        | `number` | 1-based page number this exclusion applies to (`1` = first page, `2` = second page, etc.)          |
+| `excludedAreas`     | `Area[]` | Rectangles to exclude. `Area` = `{ x1, y1, x2, y2 }` in pixels at the configured `viewportScale`  |
+| `excludedAreaColor` | `Color`  | Fill color for excluded regions in diff images. `Color` = `{ r, g, b }` with values 0–255          |
+| `diffFilePath`      | `string` | Override the diff image output path for this page                                                   |
+| `matchingThreshold` | `number` | Per-page pixel threshold, overrides the document-level `compareThreshold` for this page             |
+
+---
+
 ## Support
 
 If you want to support my work, you can buy me a coffee.
 
 [![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/dichovsky)
-

package/out/comparePdf.js

@@ -27,50 +27,58 @@ async function comparePdf(actualPdf, expectedPdf, opts = {}) {
     if (!pdfToPngConvertOpts.outputFileMaskFunc) {
         pdfToPngConvertOpts.outputFileMaskFunc = (pageNumber) => `comparePdf_${pageNumber}.png`;
     }
-    const diffsOutputFolder = opts?.diffsOutputFolder ?? const_js_1.DEFAULT_DIFFS_FOLDER;
-    const compareThreshold = opts?.compareThreshold ?? 0;
-    const excludedAreas = opts?.excludedAreas ?? [];
+    const diffsOutputFolder = opts.diffsOutputFolder ?? const_js_1.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([
-        (0, pdf_to_png_converter_1.pdfToPng)(actualPdf, pdfToPngConvertOpts),
-        (0, pdf_to_png_converter_1.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];
-    }
+    // Convert PDFs to PNGs sequentially to avoid PDF.js worker state corruption.
+    // When two pdfToPng calls run concurrently via Promise.all, the pdfDocument.cleanup()
+    // in one call can corrupt the shared PDF.js worker state for the other call, causing
+    // "Invalid page request" errors — particularly when the two PDFs have different page counts.
+    const actualPdfPngPages = await (0, pdf_to_png_converter_1.pdfToPng)(actualPdf, { ...pdfToPngConvertOpts });
+    const expectedPdfPngPages = await (0, pdf_to_png_converter_1.pdfToPng)(expectedPdf, { ...pdfToPngConvertOpts });
     let documentCompareResult = true;
-    actualPdfPngPages.forEach((pngPage, index) => {
+    for (const [index, pngPage] of actualPdfPngPages.entries()) {
+        // Look up the exclusion zone for this page by 1-based page number.
+        const pageExcludedArea = excludedAreas.find((area) => area.pageNumber === index + 1);
+        if (!pngPage.content) {
+            throw new Error(`Page content is undefined for page: ${pngPage.name}`);
+        }
+        // Only forward the fields that ComparePngOptions actually recognises.
+        // The per-page diffFilePath override takes precedence over the auto-generated path.
         const comparePngOpts = {
-            ...opts?.pdfToPngConvertOptions,
-            ...excludedAreas[index],
+            excludedAreas: pageExcludedArea?.excludedAreas,
+            diffFilePath: pageExcludedArea?.diffFilePath ?? (0, node_path_1.resolve)(diffsOutputFolder, `diff_${pngPage.name}`),
             throwErrorOnInvalidInputData: false,
         };
-        comparePngOpts.diffFilePath = (0, node_path_1.resolve)(diffsOutputFolder, `diff_${pngPage.name}`);
         const pngPageOutputToCompareWith = expectedPdfPngPages.find((p) => p.name === pngPage.name);
         const pageCompareResult = (0, png_visual_compare_1.comparePng)(pngPage.content, pngPageOutputToCompareWith?.content ?? '', comparePngOpts);
-        if (pageCompareResult > compareThreshold) {
+        // Per-page matchingThreshold overrides the document-level compareThreshold when set.
+        const pageThreshold = pageExcludedArea?.matchingThreshold ?? compareThreshold;
+        if (pageCompareResult > pageThreshold) {
             documentCompareResult = false;
         }
-    });
+    }
+    // Extra pages present in expected but absent from actual are always a mismatch.
+    if (expectedPdfPngPages.length > actualPdfPngPages.length) {
+        documentCompareResult = false;
+    }
     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.
+ * Validates the type of the input file.
+ *
+ * Accepts a `Buffer`, any `ArrayBufferLike` (`ArrayBuffer` / `SharedArrayBuffer`), or a
+ * string path that points to an existing file. Throws for any other input.
  *
- * @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.
+ * @param inputFile - The input to validate.
+ * @throws {Error} If the input is a string path that does not exist.
+ * @throws {Error} If the input is neither a recognised buffer type nor a string.
  */
 function validateInputFileType(inputFile) {
-    if (Buffer.isBuffer(inputFile)) {
+    if (Buffer.isBuffer(inputFile) || inputFile instanceof ArrayBuffer || inputFile instanceof SharedArrayBuffer) {
         return;
     }
     if (typeof inputFile === 'string') {

package/out/const.d.ts

@@ -1 +1,2 @@
+/** Default folder path for diff PNG images produced during PDF comparison. */
 export declare const DEFAULT_DIFFS_FOLDER: string;

package/out/const.js

@@ -2,4 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_DIFFS_FOLDER = void 0;
 const node_path_1 = require("node:path");
+/** Default folder path for diff PNG images produced during PDF comparison. */
 exports.DEFAULT_DIFFS_FOLDER = (0, node_path_1.resolve)(`./comparePdfOutput`);

package/out/index.d.ts

@@ -1,3 +1,12 @@
+/**
+ * pdf-visual-compare
+ *
+ * Visual regression testing library for PDFs in JavaScript/TypeScript.
+ * Converts PDF pages to PNG images and performs pixel-level comparison,
+ * requiring no native binaries or OS-level dependencies.
+ *
+ * @module pdf-visual-compare
+ */
 export { comparePdf } from './comparePdf.js';
 export type { ComparePdfOptions } from './types/ComparePdfOptions.js';
 export type { ExcludedPageArea } from './types/ExcludedPageArea.js';

package/out/index.js

@@ -1,5 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.comparePdf = void 0;
+/**
+ * pdf-visual-compare
+ *
+ * Visual regression testing library for PDFs in JavaScript/TypeScript.
+ * Converts PDF pages to PNG images and performs pixel-level comparison,
+ * requiring no native binaries or OS-level dependencies.
+ *
+ * @module pdf-visual-compare
+ */
 var comparePdf_js_1 = require("./comparePdf.js");
 Object.defineProperty(exports, "comparePdf", { enumerable: true, get: function () { return comparePdf_js_1.comparePdf; } });

package/out/types/ComparePdfOptions.d.ts

@@ -1,8 +1,30 @@
 import type { PdfToPngOptions } from 'pdf-to-png-converter';
 import type { ExcludedPageArea } from './ExcludedPageArea.js';
+/**
+ * Options for configuring the PDF comparison process.
+ */
 export type ComparePdfOptions = {
+    /**
+     * Folder path where diff PNG images are written when differences are found.
+     * @default "./comparePdfOutput"
+     */
     diffsOutputFolder?: string;
+    /**
+     * Options passed to the underlying PDF-to-PNG converter.
+     * Controls rendering scale, font handling, page selection, and more.
+     */
     pdfToPngConvertOptions?: PdfToPngOptions;
+    /**
+     * Per-page areas to exclude from pixel comparison, matched by array index (0-based).
+     * The element at index 0 applies to the first page, index 1 to the second, and so on.
+     * @default []
+     */
     excludedAreas?: readonly ExcludedPageArea[];
+    /**
+     * Maximum number of differing pixels allowed before the comparison is considered a failure.
+     * A value of `0` requires a pixel-perfect match. Must be >= 0.
+     * @default 0
+     * @throws {Error} When set to a value less than 0.
+     */
     compareThreshold?: number;
 };

package/out/types/ExcludedPageArea.d.ts

@@ -1,8 +1,42 @@
 import type { Area, Color } from 'png-visual-compare';
+/**
+ * Defines a page-specific exclusion zone for PDF comparison.
+ *
+ * Each entry is matched to a PDF page by its `pageNumber` field (1-based):
+ * `pageNumber: 1` targets the first page, `pageNumber: 2` the second, and so on.
+ * Entries whose `pageNumber` does not correspond to any page are silently ignored.
+ */
 export type ExcludedPageArea = {
+    /**
+     * 1-based page number this exclusion applies to.
+     * Must match the page's position in the PDF (`1` = first page, `2` = second page, etc.).
+     */
     pageNumber: number;
+    /**
+     * Rectangular regions to exclude from pixel comparison on this page.
+     * Coordinates (`x1`, `y1`, `x2`, `y2`) are in pixels relative to the rendered PNG
+     * at the configured `viewportScale`. `(x1, y1)` is the top-left corner and
+     * `(x2, y2)` is the bottom-right corner.
+     */
     excludedAreas?: Area[];
+    /**
+     * Fill color used to paint excluded regions in the diff output image.
+     * Expressed as `{ r, g, b }` with channel values in the range 0–255.
+     *
+     * @remarks Currently reserved for future use. The underlying `png-visual-compare`
+     * library always paints excluded areas blue; this field has no effect at runtime.
+     */
     excludedAreaColor?: Color;
+    /**
+     * Override the diff image output file path for this specific page.
+     * When set, takes precedence over the path derived from `diffsOutputFolder`.
+     * When omitted, the path is auto-generated as `<diffsOutputFolder>/diff_<pageName>`.
+     */
     diffFilePath?: string;
+    /**
+     * Per-page pixel difference threshold that overrides the document-level
+     * `compareThreshold` for this page only. Must be >= 0.
+     * When omitted, the document-level `compareThreshold` applies.
+     */
     matchingThreshold?: number;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdf-visual-compare",
-  "version": "3.3.0",
+  "version": "3.5.0",
   "description": "Visual regression testing library for PDFs in Js/Ts without binary and OS dependencies.",
   "keywords": [
     "pdf",
@@ -9,7 +9,9 @@
     "pdf compare",
     "compare pdf",
     "pdf diff",
-    "visual regression"
+    "visual regression",
+    "pdf testing",
+    "visual-diff"
   ],
   "homepage": "https://github.com/dichovsky/pdf-visual-compare#readme",
   "bugs": {
@@ -19,14 +21,26 @@
     "type": "git",
     "url": "git+https://github.com/dichovsky/pdf-visual-compare.git"
   },
+  "funding": {
+    "type": "buymeacoffee",
+    "url": "https://buymeacoffee.com/dichovsky"
+  },
   "license": "MIT",
   "author": "Igor Magdich <magdich.igor@gmail.com>",
   "main": "./out/index.js",
   "types": "./out/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./out/index.js",
+      "types": "./out/index.d.ts",
+      "default": "./out/index.js"
+    }
+  },
   "files": [
     "./out"
   ],
   "scripts": {
+    "prepublishOnly": "npm test && npm run build",
     "prebuild": "npm run clean",
     "build": "tsc --pretty",
     "clean": "rimraf ./out ./coverage ./test-results ./comparePdfOutput",
@@ -34,31 +48,29 @@
     "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",
-    "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 && npm run lint && npm run test:license && npm run build",
     "test": "vitest run --coverage",
-    "test:docker": "npm run docker:build && npm run docker:run"
+    "test:docker": "npm run docker:build && npm run docker:run",
+    "test:license": "npx --yes license-checker --production --onlyAllow \"ISC; MIT; MIT OR X11; BSD; Apache-2.0; Unlicense\""
   },
   "dependencies": {
-    "pdf-to-png-converter": "~3.11.0",
-    "png-visual-compare": "~3.2.0"
+    "pdf-to-png-converter": "~3.18.0",
+    "png-visual-compare": "~5.1.0"
   },
   "devDependencies": {
-    "@types/node": "^24.10.0",
+    "@types/node": "^25.6.0",
     "@types/pngjs": "^6.0.5",
-    "@typescript-eslint/eslint-plugin": "^8.46.3",
-    "@typescript-eslint/parser": "^8.46.3",
-    "@vitest/coverage-v8": "^4.0.7",
-    "eslint": "^9.39.1",
-    "rimraf": "^6.1.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.7"
+    "@vitest/coverage-v8": "^4.1.4",
+    "eslint": "^10.2.0",
+    "jiti": "^2.6.1",
+    "rimraf": "^6.1.3",
+    "typescript": "^6.0.2",
+    "typescript-eslint": "^8.58.1",
+    "vitest": "^4.1.4"
   },
   "engines": {
-    "node": ">=20",
-    "yarn": "please-use-npm"
+    "node": ">=20"
   }
-}
+}