node-poppler 7.1.1 → 7.2.0

package/README.md

@@ -40,22 +40,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
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "node-poppler",
-	"version": "7.1.1",
+	"version": "7.2.0",
 	"description": "Asynchronous node.js wrapper for the Poppler PDF rendering library",
 	"keywords": [
 		"async",

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.