node-poppler 7.2.3 → 7.2.4

package/README.md

@@ -25,7 +25,7 @@ npm i node-poppler
 ### Linux and macOS/Darwin support
 
 Windows binaries are provided with this repository.
-For Linux users, you will need to download the `poppler-data` and `poppler-utils` binaries separately.
+For Linux and Mac users, the `poppler-data` and `poppler-utils` binaries binary will need to be installed separately.
 
 An example of downloading the binaries on a Debian system:
 
@@ -33,15 +33,17 @@ An example of downloading the binaries on a Debian system:
 sudo apt-get install poppler-data poppler-utils
 ```
 
-For macOS users, you can download the latest versions with [Homebrew](https://brew.sh/):
+For macOS users, the binaries can be installed with [Homebrew](https://brew.sh/):
 
 ```
 brew install poppler
 ```
 
-## Example usage
+## API
+
+API documentation can be found [here](https://github.com/Fdawgs/node-poppler/blob/main/API.md).
 
-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.
+## Example usage
 
 ### poppler.pdfToCairo
 
@@ -79,7 +81,7 @@ const options = {
 
 const res = await poppler.pdfToCairo(file, undefined, options);
 // pdfToCairo writes to stdout using binary encoding if pdfFile or singleFile options are used
-await writeFile("new_file.pdf", res, { encoding: "binary" });
+await writeFile("new_file.pdf", res, { encoding: "binary", flush: true });
 ```
 
 ### poppler.pdfToHtml

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "node-poppler",
-	"version": "7.2.3",
+	"version": "7.2.4",
 	"description": "Asynchronous node.js wrapper for the Poppler PDF rendering library",
 	"keywords": [
 		"async",
@@ -51,7 +51,6 @@
 	},
 	"dependencies": {
 		"camelcase": "^6.3.0",
-		"semver": "^7.6.3",
-		"upath": "^2.0.1"
+		"semver": "^7.6.3"
 	}
 }

package/src/index.js

@@ -4,7 +4,7 @@ const { execFile, spawn, spawnSync } = require("node:child_process");
 const { promisify } = require("node:util");
 const camelCase = require("camelcase");
 const { lt } = require("semver");
-const { joinSafe, normalizeTrim } = require("upath");
+const { normalize, resolve: pathResolve } = require("node:path");
 
 const execFileAsync = promisify(execFile);
 
@@ -28,7 +28,7 @@ const pdfInfoFileSizesRegex = /(File\s+size:\s+)0(\s+)bytes/u;
  * version of binary.
  * @ignore
  * @param {object} acceptedOptions - Object containing accepted options.
- * @param {object} options - Object containing options to pass to binary.
+ * @param {Record<string, any>} options - Object containing options to pass to binary.
  * @param {string} [version] - Version of binary.
  * @returns {string[]} Array of CLI arguments.
  * @throws If invalid arguments provided.
@@ -38,45 +38,46 @@ function parseOptions(acceptedOptions, options, version) {
 	const args = [];
 	/** @type {string[]} */
 	const invalidArgs = [];
-	Object.keys(options).forEach((key) => {
+	for (const key of Object.keys(options)) {
 		if (Object.hasOwn(acceptedOptions, key)) {
+			const option = options[key];
+			const acceptedOption = acceptedOptions[key];
+
 			// eslint-disable-next-line valid-typeof -- `type` is a string
-			if (acceptedOptions[key].type === typeof options[key]) {
+			if (acceptedOption.type === typeof option) {
 				// Skip boolean options if false
-				if (acceptedOptions[key].type === "boolean" && !options[key]) {
-					return;
-				}
-
-				// Arg will be empty for some non-standard options
-				if (acceptedOptions[key].arg !== "") {
-					args.push(acceptedOptions[key].arg);
-				}
+				if (acceptedOption.type !== "boolean" || option) {
+					// Arg will be empty for some non-standard options
+					if (acceptedOption.arg !== "") {
+						args.push(acceptedOption.arg);
+					}
 
-				if (typeof options[key] !== "boolean") {
-					args.push(options[key]);
+					if (typeof option !== "boolean") {
+						args.push(option);
+					}
 				}
 			} else {
 				invalidArgs.push(
 					`Invalid value type provided for option '${key}', expected ${
-						acceptedOptions[key].type
-					} but received ${typeof options[key]}`
+						acceptedOption.type
+					} but received ${typeof option}`
 				);
 			}
 
 			if (
-				acceptedOptions[key].minVersion &&
+				acceptedOption.minVersion &&
 				version &&
 				// @ts-ignore: type checking is done above
-				lt(version, acceptedOptions[key].minVersion, { loose: true })
+				lt(version, acceptedOption.minVersion, { loose: true })
 			) {
 				invalidArgs.push(
-					`Invalid option provided for the current version of the binary used. '${key}' was introduced in v${acceptedOptions[key].minVersion}, but received v${version}`
+					`Invalid option provided for the current version of the binary used. '${key}' was introduced in v${acceptedOption.minVersion}, but received v${version}`
 				);
 			}
 		} else {
 			invalidArgs.push(`Invalid option provided '${key}'`);
 		}
-	});
+	}
 	if (invalidArgs.length === 0) {
 		return args;
 	}
@@ -110,7 +111,7 @@ class Poppler {
 				this.popplerPath = popplerPath;
 			}
 			if (platform === "win32" && !popplerPath) {
-				this.popplerPath = joinSafe(
+				this.popplerPath = pathResolve(
 					__dirname,
 					"lib",
 					"win32",
@@ -127,7 +128,7 @@ class Poppler {
 				`Unable to find ${process.platform} Poppler binaries, please pass the installation directory as a parameter to the Poppler instance.`
 			);
 		}
-		this.popplerPath = normalizeTrim(this.popplerPath);
+		this.popplerPath = normalize(this.popplerPath);
 	}
 
 	/**
@@ -152,7 +153,7 @@ class Poppler {
 			args.push(file, fileToAttach, outputFile);
 
 			const { stdout } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdfattach"),
+				pathResolve(this.popplerPath, "pdfattach"),
 				args
 			);
 			return Promise.resolve(stdout);
@@ -209,7 +210,7 @@ class Poppler {
 			args.push(file);
 
 			const { stdout } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdfdetach"),
+				pathResolve(this.popplerPath, "pdfdetach"),
 				args
 			);
 			return Promise.resolve(stdout);
@@ -244,7 +245,7 @@ class Poppler {
 
 		try {
 			const { stderr } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdffonts"),
+				pathResolve(this.popplerPath, "pdffonts"),
 				["-v"]
 			);
 
@@ -257,7 +258,7 @@ class Poppler {
 				args.push(Buffer.isBuffer(file) ? "-" : file);
 
 				const child = spawn(
-					joinSafe(this.popplerPath, "pdffonts"),
+					pathResolve(this.popplerPath, "pdffonts"),
 					args
 				);
 
@@ -345,7 +346,7 @@ class Poppler {
 
 		try {
 			const { stderr } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdfimages"),
+				pathResolve(this.popplerPath, "pdfimages"),
 				["-v"]
 			);
 
@@ -362,7 +363,7 @@ class Poppler {
 				}
 
 				const child = spawn(
-					joinSafe(this.popplerPath, "pdfimages"),
+					pathResolve(this.popplerPath, "pdfimages"),
 					args
 				);
 
@@ -464,7 +465,7 @@ class Poppler {
 
 		try {
 			const { stderr } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdfinfo"),
+				pathResolve(this.popplerPath, "pdfinfo"),
 				["-v"]
 			);
 
@@ -489,7 +490,7 @@ class Poppler {
 				}
 
 				const child = spawn(
-					joinSafe(this.popplerPath, "pdfinfo"),
+					pathResolve(this.popplerPath, "pdfinfo"),
 					args
 				);
 
@@ -583,7 +584,7 @@ class Poppler {
 
 		try {
 			const { stderr } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdfseparate"),
+				pathResolve(this.popplerPath, "pdfseparate"),
 				["-v"]
 			);
 
@@ -594,7 +595,7 @@ class Poppler {
 			args.push(file, outputPattern);
 
 			const { stdout } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdfseparate"),
+				pathResolve(this.popplerPath, "pdfseparate"),
 				args
 			);
 			return Promise.resolve(stdout);
@@ -767,7 +768,7 @@ class Poppler {
 
 		try {
 			const { stderr } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdftocairo"),
+				pathResolve(this.popplerPath, "pdftocairo"),
 				["-v"]
 			);
 
@@ -783,7 +784,7 @@ class Poppler {
 				);
 
 				const child = spawn(
-					joinSafe(this.popplerPath, "pdftocairo"),
+					pathResolve(this.popplerPath, "pdftocairo"),
 					args
 				);
 
@@ -908,7 +909,7 @@ class Poppler {
 
 		try {
 			const { stderr } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdftohtml"),
+				pathResolve(this.popplerPath, "pdftohtml"),
 				["-v"]
 			);
 
@@ -925,7 +926,7 @@ class Poppler {
 				}
 
 				const child = spawn(
-					joinSafe(this.popplerPath, "pdftohtml"),
+					pathResolve(this.popplerPath, "pdftohtml"),
 					args
 				);
 
@@ -1109,7 +1110,7 @@ class Poppler {
 
 		try {
 			const { stderr } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdftoppm"),
+				pathResolve(this.popplerPath, "pdftoppm"),
 				["-v"]
 			);
 
@@ -1122,7 +1123,7 @@ class Poppler {
 				args.push(Buffer.isBuffer(file) ? "-" : file, outputPath);
 
 				const child = spawn(
-					joinSafe(this.popplerPath, "pdftoppm"),
+					pathResolve(this.popplerPath, "pdftoppm"),
 					args
 				);
 
@@ -1341,7 +1342,7 @@ class Poppler {
 
 		try {
 			const { stderr } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdftops"),
+				pathResolve(this.popplerPath, "pdftops"),
 				["-v"]
 			);
 
@@ -1357,7 +1358,7 @@ class Poppler {
 				);
 
 				const child = spawn(
-					joinSafe(this.popplerPath, "pdftops"),
+					pathResolve(this.popplerPath, "pdftops"),
 					args
 				);
 
@@ -1491,7 +1492,7 @@ class Poppler {
 
 		try {
 			const { stderr } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdftotext"),
+				pathResolve(this.popplerPath, "pdftotext"),
 				["-v"]
 			);
 
@@ -1507,7 +1508,7 @@ class Poppler {
 				);
 
 				const child = spawn(
-					joinSafe(this.popplerPath, "pdftotext"),
+					pathResolve(this.popplerPath, "pdftotext"),
 					args
 				);
 
@@ -1572,7 +1573,7 @@ class Poppler {
 
 		try {
 			const { stderr } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdfunite"),
+				pathResolve(this.popplerPath, "pdfunite"),
 				["-v"]
 			);
 
@@ -1586,7 +1587,7 @@ class Poppler {
 			args.push(outputFile);
 
 			const { stdout } = await execFileAsync(
-				joinSafe(this.popplerPath, "pdfunite"),
+				pathResolve(this.popplerPath, "pdfunite"),
 				args
 			);
 			return Promise.resolve(stdout);