node-poppler 5.1.6 → 6.0.1

package/LICENSE

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

package/README.md

@@ -1,7 +1,7 @@
 # node-poppler
 
 [![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://www.npmjs.com/package/node-poppler)
+[![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)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier)
@@ -17,20 +17,12 @@ It was created out of a need for a PDF-to-HTML conversion module at [Yeovil Dist
 
 ## Installation
 
-Install using [`npm`](https://www.npmjs.com/package/node-poppler):
+Install using `npm`:
 
 ```bash
 npm i node-poppler
 ```
 
-Or [`yarn`](https://yarnpkg.com/en/package/node-poppler):
-
-```bash
-yarn add node-poppler
-```
-
-node-poppler's test scripts use npm commands.
-
 ### Linux and macOS/Darwin Support
 
 Windows binaries are provided with this repository.
@@ -174,6 +166,8 @@ Please adhere to this project's [Code of Conduct](./CODE_OF_CONDUCT.md) when con
 -   [**Filipe Fernandes**](https://github.com/ocefpaf/) - [poppler-feedstock](https://github.com/conda-forge/poppler-feedstock) maintainer
 -   [**Peter Williams**](https://github.com/pkgw/) - [poppler-feedstock](https://github.com/conda-forge/poppler-feedstock) maintainer
 -   [**Owen Schwartz**](https://github.com/oschwartz10612) - [poppler-windows](https://github.com/oschwartz10612/poppler-windows) developer
+-   [**Uwe Korn**](https://github.com/xhochy/) - [poppler-feedstock](https://github.com/conda-forge/poppler-feedstock) maintainer
+-   [**Xylar Asay-Davis**](https://github.com/xylar/) - [poppler-feedstock](https://github.com/conda-forge/poppler-feedstock) maintainer
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "node-poppler",
-	"version": "5.1.6",
+	"version": "6.0.1",
 	"description": "Asynchronous node.js wrapper for the Poppler PDF rendering library",
 	"keywords": [
 		"async",
@@ -41,7 +41,7 @@
 	"license": "MIT",
 	"author": "Frazer Smith <frazer.dev@outlook.com>",
 	"engines": {
-		"node": ">=12.0.0"
+		"node": ">=14.0.0"
 	},
 	"scripts": {
 		"build": "tsc",
@@ -71,24 +71,24 @@
 		"testTimeout": 60000
 	},
 	"devDependencies": {
-		"@commitlint/cli": "^17.0.2",
-		"@commitlint/config-conventional": "^17.0.2",
-		"eslint": "^8.16.0",
+		"@commitlint/cli": "^17.1.2",
+		"@commitlint/config-conventional": "^17.1.0",
+		"eslint": "^8.24.0",
 		"eslint-config-airbnb-base": "^15.0.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-import": "^2.26.0",
-		"eslint-plugin-jest": "^26.4.6",
-		"eslint-plugin-jsdoc": "^39.3.2",
-		"eslint-plugin-promise": "^6.0.0",
+		"eslint-plugin-jest": "^27.0.4",
+		"eslint-plugin-jsdoc": "^39.3.6",
+		"eslint-plugin-promise": "^6.0.1",
 		"eslint-plugin-security": "^1.5.0",
 		"eslint-plugin-security-node": "^1.1.1",
-		"glob": "^8.0.1",
+		"glob": "^8.0.3",
 		"husky": "^8.0.1",
-		"jest": "^28.1.0",
+		"jest": "^29.1.2",
 		"jsdoc-to-markdown": "^7.1.1",
 		"license-checker": "^25.0.1",
-		"prettier": "^2.6.2",
-		"typescript": "^4.7.2"
+		"prettier": "^2.7.1",
+		"typescript": "^4.8.4"
 	},
 	"dependencies": {
 		"camelcase": "^6.3.0",

package/src/index.d.ts

@@ -24,7 +24,6 @@ export class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Lists or extracts embedded files (attachments) from a PDF file.
-	 *
 	 * @param {string} file - Filepath of the PDF file to read.
 	 * @param {object=} options - Object containing options to pass to binary.
 	 * @param {boolean=} options.listEmbedded - List all of the embedded files in the PDF file.
@@ -55,7 +54,6 @@ export class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Lists the fonts used in a PDF file along with various information for each font.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {object=} options - Object containing options to pass to binary.
 	 * @param {number=} options.firstPageToExamine - Specifies the first page to examine.
@@ -74,7 +72,6 @@ export class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Saves images from a PDF file as PPM, PBM, PNG, TIFF, JPEG, JPEG2000, or JBIG2 files.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string=} outputPrefix - Filename prefix of output files.
 	 * @param {object=} options - Object containing options to pass to binary.
@@ -104,7 +101,6 @@ export class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Prints the contents of the `Info` dictionary from a PDF file.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {object=} options - Object containing options to pass to binary.
 	 * @param {number=} options.firstPageToConvert - First page to print.
@@ -145,7 +141,6 @@ export class Poppler {
 	 * @description Extract single pages from a PDF file,
 	 * and writes one PDF file for each page to outputPattern.
 	 * This will not work if the file is encrypted.
-	 *
 	 * @param {string} file - Filepath of the PDF file to read.
 	 * @param {string} outputPattern - Should contain %d (or any variant respecting printf format),
 	 * since %d is replaced by the page number.
@@ -166,7 +161,6 @@ export class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Converts a PDF file to EPS/JPEG/PDF/PNG/PS/SVG/TIFF.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string=} outputFile - Filepath of the file to output the results to.
 	 *
@@ -277,14 +271,12 @@ export class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Converts a PDF file to HTML.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string=} outputFile - Filepath of the file to output the results to.
 	 * If `undefined` then Poppler will use the directory and name of the original file
 	 * and create a new file, with `-html` appended to the end of the filename.
 	 *
 	 * Required if `file` is a Buffer.
-	 *
 	 * @param {object=} options - Object containing options to pass to binary.
 	 * @param {boolean=} options.complexOutput - Generate complex output.
 	 * @param {boolean=} options.dataUrls -  Use data URLs instead of external images in HTML.
@@ -326,7 +318,6 @@ export class Poppler {
 	 * @description Converts a PDF file to colour image files in Portable Pixmap (PPM) format,
 	 * grayscale image files in Portable Graymap (PGM) format, or monochrome image files
 	 * in Portable Bitmap (PBM) format.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string} outputPath - Filepath to output the results to.
 	 * @param {object=} options - Object containing options to pass to binary.
@@ -404,7 +395,6 @@ export class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Converts a PDF file to PostScript (PS).
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string=} outputFile - Filepath of the file to output the results to.
 	 * If `undefined` then will write output to stdout.
@@ -519,7 +509,6 @@ export class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Converts a PDF file to TXT.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string=} outputFile - Filepath of the file to output the results to.
 	 * If `undefined` then will write output to stdout.
@@ -572,7 +561,6 @@ export class Poppler {
 	 * @author Frazer Smith
 	 * @description Merges several PDF files in order of their occurrence in the files array to
 	 * one PDF result file.
-	 *
 	 * @param {Array} files - Filepaths of the PDF files to merge.
 	 * An entire directory of PDF files can be merged like so: `path/to/directory/*.pdf`.
 	 * @param {string} outputFile - Filepath of the file to output the resulting merged PDF to.

package/src/index.js

@@ -2,9 +2,9 @@
 const camelCase = require("camelcase");
 const path = require("upath");
 const { execFile, spawn } = require("child_process");
-const util = require("util");
+const { promisify } = require("util");
 
-const execFileAsync = util.promisify(execFile);
+const execFileAsync = promisify(execFile);
 
 const errorMessages = {
 	0: "No Error",
@@ -128,7 +128,6 @@ class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Lists or extracts embedded files (attachments) from a PDF file.
-	 *
 	 * @param {string} file - Filepath of the PDF file to read.
 	 * @param {object=} options - Object containing options to pass to binary.
 	 * @param {boolean=} options.listEmbedded - List all of the embedded files in the PDF file.
@@ -186,7 +185,6 @@ class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Lists the fonts used in a PDF file along with various information for each font.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {object=} options - Object containing options to pass to binary.
 	 * @param {number=} options.firstPageToExamine - Specifies the first page to examine.
@@ -266,7 +264,6 @@ class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Saves images from a PDF file as PPM, PBM, PNG, TIFF, JPEG, JPEG2000, or JBIG2 files.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string=} outputPrefix - Filename prefix of output files.
 	 * @param {object=} options - Object containing options to pass to binary.
@@ -372,7 +369,6 @@ class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Prints the contents of the `Info` dictionary from a PDF file.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {object=} options - Object containing options to pass to binary.
 	 * @param {number=} options.firstPageToConvert - First page to print.
@@ -514,7 +510,6 @@ class Poppler {
 	 * @description Extract single pages from a PDF file,
 	 * and writes one PDF file for each page to outputPattern.
 	 * This will not work if the file is encrypted.
-	 *
 	 * @param {string} file - Filepath of the PDF file to read.
 	 * @param {string} outputPattern - Should contain %d (or any variant respecting printf format),
 	 * since %d is replaced by the page number.
@@ -563,7 +558,6 @@ class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Converts a PDF file to EPS/JPEG/PDF/PNG/PS/SVG/TIFF.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string=} outputFile - Filepath of the file to output the results to.
 	 *
@@ -792,14 +786,12 @@ class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Converts a PDF file to HTML.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string=} outputFile - Filepath of the file to output the results to.
 	 * If `undefined` then Poppler will use the directory and name of the original file
 	 * and create a new file, with `-html` appended to the end of the filename.
 	 *
 	 * Required if `file` is a Buffer.
-	 *
 	 * @param {object=} options - Object containing options to pass to binary.
 	 * @param {boolean=} options.complexOutput - Generate complex output.
 	 * @param {boolean=} options.dataUrls -  Use data URLs instead of external images in HTML.
@@ -931,7 +923,6 @@ class Poppler {
 	 * @description Converts a PDF file to colour image files in Portable Pixmap (PPM) format,
 	 * grayscale image files in Portable Graymap (PGM) format, or monochrome image files
 	 * in Portable Bitmap (PBM) format.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string} outputPath - Filepath to output the results to.
 	 * @param {object=} options - Object containing options to pass to binary.
@@ -1130,7 +1121,6 @@ class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Converts a PDF file to PostScript (PS).
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string=} outputFile - Filepath of the file to output the results to.
 	 * If `undefined` then will write output to stdout.
@@ -1376,7 +1366,6 @@ class Poppler {
 	/**
 	 * @author Frazer Smith
 	 * @description Converts a PDF file to TXT.
-	 *
 	 * @param {Buffer| string} file - PDF file as Buffer, or filepath of the PDF file to read.
 	 * @param {string=} outputFile - Filepath of the file to output the results to.
 	 * If `undefined` then will write output to stdout.
@@ -1528,7 +1517,6 @@ class Poppler {
 	 * @author Frazer Smith
 	 * @description Merges several PDF files in order of their occurrence in the files array to
 	 * one PDF result file.
-	 *
 	 * @param {Array} files - Filepaths of the PDF files to merge.
 	 * An entire directory of PDF files can be merged like so: `path/to/directory/*.pdf`.
 	 * @param {string} outputFile - Filepath of the file to output the resulting merged PDF to.