node-poppler 6.1.1 → 6.2.0

package/README.md

@@ -2,18 +2,17 @@
 
 [![GitHub Release](https://img.shields.io/github/release/Fdawgs/node-poppler.svg)](https://github.com/Fdawgs/node-poppler/releases/latest/)
 [![npm version](https://img.shields.io/npm/v/node-poppler)](https://npmjs.com/package/node-poppler)
-![Build Status](https://github.com/Fdawgs/node-poppler/workflows/CI/badge.svg?branch=master)
-[![Coverage Status](https://coveralls.io/repos/github/Fdawgs/node-poppler/badge.svg?branch=master)](https://coveralls.io/github/Fdawgs/node-poppler?branch=master)
+![Build Status](https://github.com/Fdawgs/node-poppler/workflows/CI/badge.svg?branch=main)
+[![Coverage Status](https://coveralls.io/repos/github/Fdawgs/node-poppler/badge.svg?branch=main)](https://coveralls.io/github/Fdawgs/node-poppler?branch=main)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier)
 
 > Asynchronous node.js wrapper for the Poppler PDF rendering library
 
-## Intro
+## Overview
 
 [Poppler](https://poppler.freedesktop.org/) is a PDF rendering library that also includes a collection of utility binaries, which allows for the manipulation and extraction of data from PDF documents such as converting PDF files to HTML, TXT, or PostScript.
 
 The `node-poppler` module provides an asynchronous node.js wrapper around said utility binaries for easier use.
-It was created out of a need for a PDF-to-HTML conversion module at [Yeovil District Hospital NHS Foundation Trust](https://yeovilhospital.co.uk/) to convert clinical documents.
 
 ## Installation
 
@@ -23,7 +22,7 @@ Install using `npm`:
 npm i node-poppler
 ```
 
-### Linux and macOS/Darwin Support
+### 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.
@@ -54,7 +53,7 @@ const poppler = new Poppler("/usr/bin");
 const { Poppler } = require("node-poppler");
 ```
 
-[**API Documentation can be found here**](https://github.com/Fdawgs/node-poppler/blob/master/API.md)
+[**API Documentation can be found here**](https://github.com/Fdawgs/node-poppler/blob/main/API.md)
 
 ## Examples
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "node-poppler",
-	"version": "6.1.1",
+	"version": "6.2.0",
 	"description": "Asynchronous node.js wrapper for the Poppler PDF rendering library",
 	"keywords": [
 		"async",
@@ -33,6 +33,7 @@
 		"unite"
 	],
 	"main": "src/index.js",
+	"types": "types/index.d.ts",
 	"repository": "git+https://github.com/Fdawgs/node-poppler.git",
 	"homepage": "https://github.com/Fdawgs/node-poppler",
 	"bugs": {

package/src/index.js

@@ -11,6 +11,7 @@ const errorMessages = {
 	1: "Error opening a PDF file",
 	2: "Error opening an output file",
 	3: "Error related to PDF permissions",
+	4: "Error related to ICC profile",
 	99: "Other error",
 	3221226505: "Internal process error",
 };
@@ -19,10 +20,12 @@ const errorMessages = {
  * @author Frazer Smith
  * @description Check each option provided is valid, of the correct type, and can be used by specified
  * version of binary.
+ * @ignore
  * @param {object} acceptedOptions - Object containing options that a binary accepts.
  * @param {object} options - Object containing options to pass to binary.
  * @param {string=} version - Version of binary.
- * @returns {Array|Error} Array of CLI arguments or Error object if invalid arguments provided.
+ * @returns {Array<string>} Array of CLI arguments.
+ * @throws If invalid arguments provided.
  */
 function parseOptions(acceptedOptions, options, version) {
 	const args = [];
@@ -245,7 +248,7 @@ class Poppler {
 					if (stdOut !== "") {
 						resolve(stdOut.trim());
 					} else {
-						reject(new Error(stdErr.trim()));
+						reject(new Error(stdErr ? stdErr.trim() : undefined));
 					}
 				});
 			});
@@ -481,7 +484,7 @@ class Poppler {
 							resolve(stdOut.trim());
 						}
 					} else {
-						reject(new Error(stdErr.trim()));
+						reject(new Error(stdErr ? stdErr.trim() : undefined));
 					}
 				});
 			});
@@ -873,16 +876,15 @@ class Poppler {
 					stdErr += data;
 				});
 
-				child.on("close", async (code) => {
+				/**
+				 * pdfToHtml does not return an exit code so check output to see if it was successful.
+				 * See https://gitlab.freedesktop.org/poppler/poppler/-/blob/master/utils/pdftohtml.1
+				 */
+				child.on("close", async () => {
 					if (stdOut !== "") {
 						resolve(stdOut.trim());
-					} else if (code === 0) {
-						resolve(errorMessages[code]);
-					} else if (stdErr !== "") {
-						reject(new Error(stdErr.trim()));
 					} else {
-						/* istanbul ignore next */
-						reject(new Error(errorMessages[code]));
+						reject(new Error(stdErr ? stdErr.trim() : undefined));
 					}
 				});
 			});
@@ -1518,6 +1520,5 @@ class Poppler {
 	}
 }
 
-module.exports = {
-	Poppler,
-};
+module.exports.Poppler = Poppler;
+module.exports.default = Poppler;

package/{src → types}/index.d.ts

@@ -1,3 +1,4 @@
+export default Poppler;
 export class Poppler {
 	/**
 	 * @param {string=} binPath - Path of poppler-utils binaries.