node-poppler 7.1.1 → 7.2.1

package/README.md

@@ -30,8 +30,7 @@ For Linux users, you will need to download the `poppler-data` and `poppler-utils
 An example of downloading the binaries on a Debian system:
 
 ```
-sudo apt-get install poppler-data
-sudo apt-get install poppler-utils
+sudo apt-get install poppler-data poppler-utils
 ```
 
 For macOS users, you can download the latest versions with [Homebrew](https://brew.sh/):
@@ -40,22 +39,9 @@ For macOS users, you can download the latest versions with [Homebrew](https://br
 brew install poppler
 ```
 
-Once they have been installed, you will need to pass the `poppler-utils` installation directory as a parameter to an instance of the Poppler class:
+## Example usage
 
-```js
-const { Poppler } = require("node-poppler");
-const poppler = new Poppler("/usr/bin");
-```
-
-## API
-
-```js
-const { Poppler } = require("node-poppler");
-```
-
-[**API Documentation can be found here**](https://github.com/Fdawgs/node-poppler/blob/main/API.md)
-
-## Examples
+Please refer to the [JSDoc comments in the source code](./src/index.js) or the [generated type definitions](https://www.npmjs.com/package/node-poppler?activeTab=code) for information on the available options.
 
 ### poppler.pdfToCairo
 
@@ -158,9 +144,10 @@ const options = {
 	firstPageToConvert: 1,
 	lastPageToConvert: 2,
 };
+const outputFile = "test_document.txt";
 
 poppler
-	.pdfToText(file, options)
+	.pdfToText(file, outputFile, options)
 	.then((res) => {
 		console.log(res);
 	})

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "node-poppler",
-	"version": "7.1.1",
+	"version": "7.2.1",
 	"description": "Asynchronous node.js wrapper for the Poppler PDF rendering library",
 	"keywords": [
 		"async",
@@ -44,14 +44,14 @@
 		"url": "https://github.com/Fdawgs/node-poppler/issues"
 	},
 	"license": "MIT",
-	"author": "Frazer Smith <frazer.dev@outlook.com>",
+	"author": "Frazer Smith <frazer.dev@icloud.com>",
 	"funding": "https://github.com/sponsors/Fdawgs",
 	"engines": {
-		"node": ">=18.0.0"
+		"node": ">=18"
 	},
 	"dependencies": {
 		"camelcase": "^6.3.0",
-		"semver": "^7.6.0",
+		"semver": "^7.6.3",
 		"upath": "^2.0.1"
 	}
 }

package/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 
-const { execFile, spawn } = require("node:child_process");
+const { execFile, spawn, spawnSync } = require("node:child_process");
 const { promisify } = require("node:util");
 const camelCase = require("camelcase");
 const { lt } = require("semver");
@@ -84,24 +84,50 @@ function parseOptions(acceptedOptions, options, version) {
 }
 
 class Poppler {
-	/** @param {string} [binPath] - Path of poppler-utils binaries. */
+	/**
+	 * @param {string} [binPath] - Path of poppler-utils binaries.
+	 * If not provided, the constructor will attempt to find the Poppler `pdfinfo` binary
+	 * in the PATH environment variable and use that as the path for all binaries.
+	 * For `win32` the binaries are bundled with the package and will be used
+	 * if a local installation is not found.
+	 */
 	constructor(binPath) {
+		this.popplerPath = "";
+
+		/* istanbul ignore else: requires specific OS */
 		if (binPath) {
-			this.popplerPath = normalizeTrim(binPath);
-		} else if (process.platform === "win32") {
-			this.popplerPath = joinSafe(
-				__dirname,
-				"lib",
-				"win32",
-				"poppler-24.02.0",
-				"Library",
-				"bin"
-			);
+			/** @type {string|undefined} */
+			this.popplerPath = binPath;
 		} else {
+			const { platform } = process;
+
+			const which = spawnSync(platform === "win32" ? "where" : "which", [
+				"pdfinfo",
+			]).stdout.toString();
+			const popplerPath = /(.+)pdfinfo/u.exec(which)?.[1];
+
+			if (popplerPath) {
+				this.popplerPath = popplerPath;
+			}
+			if (platform === "win32" && !popplerPath) {
+				this.popplerPath = joinSafe(
+					__dirname,
+					"lib",
+					"win32",
+					"poppler-24.02.0",
+					"Library",
+					"bin"
+				);
+			}
+		}
+
+		/* istanbul ignore next: unable to test due to https://github.com/jestjs/jest/pull/14297 */
+		if (!this.popplerPath) {
 			throw new Error(
-				`${process.platform} poppler-util binaries are not provided, please pass the installation directory as a parameter to the Poppler instance.`
+				`Unable to find ${process.platform} Poppler binaries, please pass the installation directory as a parameter to the Poppler instance.`
 			);
 		}
+		this.popplerPath = normalizeTrim(this.popplerPath);
 	}
 
 	/**
@@ -1568,5 +1594,5 @@ class Poppler {
 	}
 }
 
-module.exports.Poppler = Poppler;
-module.exports.default = Poppler;
+module.exports.default = Poppler; // ESM default export
+module.exports.Poppler = Poppler; // TypeScript and named export

package/types/index.d.ts

@@ -1,8 +1,14 @@
 export default Poppler;
 export class Poppler {
-    /** @param {string} [binPath] - Path of poppler-utils binaries. */
+    /**
+     * @param {string} [binPath] - Path of poppler-utils binaries.
+     * If not provided, the constructor will attempt to find the Poppler `pdfinfo` binary
+     * in the PATH environment variable and use that as the path for all binaries.
+     * For `win32` the binaries are bundled with the package and will be used
+     * if a local installation is not found.
+     */
     constructor(binPath?: string);
-    popplerPath: string;
+    popplerPath: string | undefined;
     /**
      * @author Frazer Smith
      * @description Embeds files (attachments) into a PDF file.
@@ -299,7 +305,7 @@ export class Poppler {
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
     pdfToCairo(file: Buffer | string, outputFile?: string, options?: {
-        antialias?: ('best' | 'default' | 'fast' | 'good' | 'gray' | 'none' | 'subpixel');
+        antialias?: ("best" | "default" | "fast" | "good" | "gray" | "none" | "subpixel");
         cropBox?: boolean;
         cropHeight?: number;
         cropSize?: number;
@@ -324,7 +330,7 @@ export class Poppler {
         originalPageSizes?: boolean;
         ownerPassword?: string;
         paperHeight?: number;
-        paperSize?: ('A3' | 'A4' | 'legal' | 'letter' | 'match');
+        paperSize?: ("A3" | "A4" | "legal" | "letter" | "match");
         paperWidth?: number;
         pdfFile?: boolean;
         pngFile?: boolean;
@@ -342,7 +348,7 @@ export class Poppler {
         scalePageToYAxis?: number;
         singleFile?: boolean;
         svgFile?: boolean;
-        tiffCompression?: ('deflate' | 'jpeg' | 'lzw' | 'none' | 'packbits');
+        tiffCompression?: ("deflate" | "jpeg" | "lzw" | "none" | "packbits");
         tiffFile?: boolean;
         transparentPageColor?: boolean;
         userPassword?: string;
@@ -395,7 +401,7 @@ export class Poppler {
         firstPageToConvert?: number;
         fontFullName?: boolean;
         ignoreImages?: boolean;
-        imageFormat?: ('JPG' | 'PNG');
+        imageFormat?: ("JPG" | "PNG");
         lastPageToConvert?: number;
         noDrm?: boolean;
         noFrames?: boolean;
@@ -487,8 +493,8 @@ export class Poppler {
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
     pdfToPpm(file: Buffer | string, outputPath: string, options?: {
-        antialiasFonts?: ('no' | 'yes');
-        antialiasVectors?: ('no' | 'yes');
+        antialiasFonts?: ("no" | "yes");
+        antialiasVectors?: ("no" | "yes");
         cropBox?: boolean;
         cropHeight?: number;
         cropSize?: number;
@@ -501,7 +507,7 @@ export class Poppler {
         displayProfile?: string;
         evenPagesOnly?: boolean;
         firstPageToConvert?: number;
-        freetype?: ('no' | 'yes');
+        freetype?: ("no" | "yes");
         forcePageNumber?: boolean;
         grayscaleFile?: boolean;
         hideAnnotations?: boolean;
@@ -522,8 +528,8 @@ export class Poppler {
         scalePageToYAxis?: number;
         separator?: string;
         singleFile?: boolean;
-        thinLineMode?: ('none' | 'shape' | 'solid');
-        tiffCompression?: ('deflate' | 'jpeg' | 'lzw' | 'none' | 'packbits');
+        thinLineMode?: ("none" | "shape" | "solid");
+        tiffCompression?: ("deflate" | "jpeg" | "lzw" | "none" | "packbits");
         tiffFile?: boolean;
         userPassword?: string;
     }): Promise<string>;
@@ -637,7 +643,7 @@ export class Poppler {
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
     pdfToPs(file: Buffer | string, outputFile?: string, options?: {
-        antialias?: ('no' | 'yes');
+        antialias?: ("no" | "yes");
         binary?: boolean;
         defaultCmykProfile?: string;
         defaultGrayProfile?: string;
@@ -667,15 +673,15 @@ export class Poppler {
         overprint?: boolean;
         ownerPassword?: string;
         paperHeight?: number;
-        paperSize?: ('A3' | 'A4' | 'legal' | 'letter' | 'match');
+        paperSize?: ("A3" | "A4" | "legal" | "letter" | "match");
         paperWidth?: number;
         passfonts?: boolean;
         preload?: boolean;
         printVersionInfo?: boolean;
-        processColorFormat?: ('CMYK8' | 'MONO8' | 'RGB8');
+        processColorFormat?: ("CMYK8" | "MONO8" | "RGB8");
         processColorProfile?: string;
         quiet?: boolean;
-        rasterize?: ('always' | 'never' | 'whenneeded');
+        rasterize?: ("always" | "never" | "whenneeded");
         resolutionXYAxis?: number;
         userPassword?: string;
     }): Promise<string>;
@@ -735,7 +741,7 @@ export class Poppler {
         cropWidth?: number;
         cropXAxis?: number;
         cropYAxis?: number;
-        eolConvention?: ('dos' | 'mac' | 'unix');
+        eolConvention?: ("dos" | "mac" | "unix");
         firstPageToConvert?: number;
         fixedWidthLayout?: number;
         generateHtmlMetaFile?: boolean;