node-poppler 5.0.2 → 5.1.2

package/API.md

@@ -158,6 +158,7 @@ Prints the contents of the `Info` dictionary from a PDF file.
 | [options.printMetadata] | <code>boolean</code> | Prints document-level metadata. (This is the `Metadata` stream from the PDF file's Catalog object). |
 | [options.printNamedDests] | <code>boolean</code> | Print a list of all named destinations. If a page range is specified using the `options.firstPageToConvert` and `options.lastPageToConvert` options, only destinations in the page range are listed. |
 | [options.printRawDates] | <code>boolean</code> | Prints the raw (undecoded) date strings, directly from the PDF file. |
+| [options.printUrls] | <code>boolean</code> | Print all URLs in the PDF; only URLs referenced by PDF objects such as Link Annotations are listed, not URL strings in the text content. |
 | [options.printVersionInfo] | <code>boolean</code> | Print copyright and version info. |
 | [options.userPassword] | <code>string</code> | User password (for encrypted files). |
 
@@ -193,7 +194,7 @@ Converts a PDF file to EPS/JPEG/PDF/PNG/PS/SVG/TIFF.
 | Param | Type | Description |
 | --- | --- | --- |
 | file | <code>Buffer</code> \| <code>string</code> | PDF file as Buffer, or filepath of the PDF file to read. |
-| [outputFile] | <code>string</code> | Filepath of the file to output the results to. If `undefined` then will write output to stdout. Using stdout is not valid with image formats unless `options.singleFile` is set to `true`. If not set then the output filename will be derived from the PDF file name. |
+| [outputFile] | <code>string</code> | Filepath of the file to output the results to. If `undefined` then will write output to stdout. Using stdout is not valid with image formats (jpeg, png, and tiff) unless `options.singleFile` is set to `true`. Encoding is set to `binary` if used with `options.singleFile` or `options.pdfFile`. If not set then the output filename will be derived from the PDF file name. |
 | [options] | <code>object</code> | Object containing options to pass to binary. |
 | [options.antialias] | <code>&#x27;default&#x27;</code> \| <code>&#x27;none&#x27;</code> \| <code>&#x27;gray&#x27;</code> \| <code>&#x27;subpixel&#x27;</code> \| <code>&#x27;fast&#x27;</code> \| <code>&#x27;good&#x27;</code> \| <code>&#x27;best&#x27;</code> | Set the cairo antialias option used for text and drawing in image files (or rasterized regions in vector output). |
 | [options.cropBox] | <code>boolean</code> | Uses the crop box rather than media box when generating the files (PNG/JPEG/TIFF only). |
@@ -235,7 +236,7 @@ Converts a PDF file to EPS/JPEG/PDF/PNG/PS/SVG/TIFF.
 | [options.scalePageTo] | <code>number</code> | Scales the long side of each page (width for landscape pages, height for portrait pages) to fit in scale-to pixels. The size of the short side will be determined by the aspect ratio of the page (PNG/JPEG/TIFF only). |
 | [options.scalePageToXAxis] | <code>number</code> | Scales each page horizontally to fit in scale-to-x pixels. If scale-to-y is set to -1, the vertical size will determined by the aspect ratio of the page (PNG/JPEG/TIFF only). |
 | [options.scalePageToYAxis] | <code>number</code> | Scales each page vertically to fit in scale-to-y pixels. If scale-to-x is set to -1, the horizontal size will determined by the aspect ratio of the page (PNG/JPEG/TIFF only). |
-| [options.singleFile] | <code>boolean</code> | Writes only the first page and does not add digits. |
+| [options.singleFile] | <code>boolean</code> | Writes only the first page and does not add digits. Can only be used with `options.jpegFile`, `options.pngFile`, and `options.tiffFile`. |
 | [options.svgFile] | <code>boolean</code> | Generate SVG (Scalable Vector Graphics) file. |
 | [options.tiffCompression] | <code>&#x27;none&#x27;</code> \| <code>&#x27;packbits&#x27;</code> \| <code>&#x27;jpeg&#x27;</code> \| <code>&#x27;lzw&#x27;</code> \| <code>&#x27;deflate&#x27;</code> | Set TIFF compression. |
 | [options.tiffFile] | <code>boolean</code> | Generate TIFF file(s). |

package/CHANGELOG.md

@@ -2,6 +2,142 @@
 
 All notable changes to this project will be documented in this file.
 
+### [5.1.2](https://github.com/Fdawgs/node-poppler/compare/v5.1.1...v5.1.2) (2022-01-19)
+
+
+### Bug Fixes
+
+* **lib:** update poppler win32 binaries from 21.11.0 to 22.01.0 ([e76a813](https://github.com/Fdawgs/node-poppler/commit/e76a813b3ad12bb15a808ccd4d1a163016d36eec))
+
+
+### Miscellaneous
+
+* **package:** add `tif` to keywords array ([#369](https://github.com/Fdawgs/node-poppler/issues/369)) ([2929483](https://github.com/Fdawgs/node-poppler/commit/29294830056f6e8f53c82822560b840d2031f3b6))
+
+
+### Documentation
+
+* **contributing:** add mention of husky pre-commit hook ([8eb63e8](https://github.com/Fdawgs/node-poppler/commit/8eb63e8d0dac69bce76fda5032506a5171abf3e4))
+* **contributing:** add step for `lint:licenses` script ([#371](https://github.com/Fdawgs/node-poppler/issues/371)) ([5e9f7a5](https://github.com/Fdawgs/node-poppler/commit/5e9f7a510f6aa407d39a17ad24d83ade59c98f41))
+
+
+### Continuous Integration
+
+* remove spellcheck workflow ([#376](https://github.com/Fdawgs/node-poppler/issues/376)) ([56fb637](https://github.com/Fdawgs/node-poppler/commit/56fb63713171c4aed9458d48b4d2cf66a5b91419))
+
+
+### Dependencies
+
+* **deps-dev:** bump @commitlint/cli from 15.0.0 to 16.0.1 ([8ab463a](https://github.com/Fdawgs/node-poppler/commit/8ab463aa30b8bc1fd36ed40c4595f2d274d90674))
+* **deps-dev:** bump @commitlint/config-conventional ([6cda233](https://github.com/Fdawgs/node-poppler/commit/6cda233e5a29e44961c2e52d2a19d01b008e9ddc))
+* **deps-dev:** bump eslint from 7.32.0 to 8.7.0 ([73a77a5](https://github.com/Fdawgs/node-poppler/commit/73a77a5bdd250e19086ef9bd838f74b5fec2ef81))
+* **deps-dev:** bump eslint-plugin-promise from 5.2.0 to 6.0.0 ([535feb0](https://github.com/Fdawgs/node-poppler/commit/535feb08ba673a0a6812e5a3d8a4bf0e2af518f3))
+* **deps:** bump GoogleCloudPlatform/release-please-action from 2 to 3 ([e3c9d8e](https://github.com/Fdawgs/node-poppler/commit/e3c9d8e76c34d949f6d98e60a57f19dcff90a766))
+* update dependencies ([db8a76d](https://github.com/Fdawgs/node-poppler/commit/db8a76d498760e808544026183e9aade29b4c4d8))
+
+### [5.1.1](https://www.github.com/Fdawgs/node-poppler/compare/v5.1.0...v5.1.1) (2021-12-11)
+
+
+### Bug Fixes
+
+* **index:** correct message thrown for missing binaries ([#363](https://www.github.com/Fdawgs/node-poppler/issues/363)) ([5249d61](https://www.github.com/Fdawgs/node-poppler/commit/5249d6183b11f6c9eded643359e05d4f3ecf9f01))
+
+
+### Continuous Integration
+
+* trigger workflows when drafts marked as "ready to review" ([#354](https://www.github.com/Fdawgs/node-poppler/issues/354)) ([de922a2](https://www.github.com/Fdawgs/node-poppler/commit/de922a20494d8bc87333da156248342805e37a15))
+
+
+### Documentation
+
+* **coc:** reduce verbosity ([b38d954](https://www.github.com/Fdawgs/node-poppler/commit/b38d9549a890e434868cc26a59867a26a49b8167))
+
+
+### Improvements
+
+* **index:** remove unused `if` conditional ([d56589d](https://www.github.com/Fdawgs/node-poppler/commit/d56589d41caa60533718bee24eb5797aec0f40eb))
+
+
+### Miscellaneous
+
+* ignore `.yarnclean` ([#360](https://www.github.com/Fdawgs/node-poppler/issues/360)) ([196b528](https://www.github.com/Fdawgs/node-poppler/commit/196b528c860bd0bd191e1dbc53c1dfc2867aa334))
+* **package/scripts:** add `lint:licenses` ([#361](https://www.github.com/Fdawgs/node-poppler/issues/361)) ([a010434](https://www.github.com/Fdawgs/node-poppler/commit/a0104344c0569887e3af82263aa091cde0027afc))
+* turn off `security/detect-object-injection` eslint rule ([1d6dc35](https://www.github.com/Fdawgs/node-poppler/commit/1d6dc35bfe4c0e54391745a3ff45485b0c76fac0))
+
+
+### Dependencies
+
+* **dependabot:** ignore minor and patch github-actions updates ([#356](https://www.github.com/Fdawgs/node-poppler/issues/356)) ([56d1a86](https://www.github.com/Fdawgs/node-poppler/commit/56d1a86e20681a8b747da0713176522be7de258e))
+* **dependabot:** ignore minor and patch release-please-action updates ([#367](https://www.github.com/Fdawgs/node-poppler/issues/367)) ([b77729f](https://www.github.com/Fdawgs/node-poppler/commit/b77729f4764f7536fda9ead8cac0b08dc75b269a))
+* **deps-dev:** bump @commitlint/cli from 14.1.0 to 15.0.0 ([08d87b5](https://www.github.com/Fdawgs/node-poppler/commit/08d87b55891b56d81fe73db9db1a0b0eb98b9d17))
+* **deps-dev:** bump @commitlint/config-conventional ([c5452ee](https://www.github.com/Fdawgs/node-poppler/commit/c5452eef69ef09503ee7a357f09595c8526a2e0a))
+* **deps-dev:** bump prettier from 2.4.1 to 2.5.0 ([74f9e90](https://www.github.com/Fdawgs/node-poppler/commit/74f9e907ef9cdabb039463845055316d42a21ad5))
+* **deps-dev:** bump prettier from 2.5.0 to 2.5.1 ([d51ca9b](https://www.github.com/Fdawgs/node-poppler/commit/d51ca9b64884715b47eed2db64229b84c9dd9f4a))
+
+## [5.1.0](https://www.github.com/Fdawgs/node-poppler/compare/v5.0.3...v5.1.0) (2021-11-10)
+
+
+### Features
+
+* **index:** add `printUrls` arg to `pdfInfo()` options ([d58da5f](https://www.github.com/Fdawgs/node-poppler/commit/d58da5fc0d6fe6b1eeef8a660701052dd11a17fa))
+
+
+### Bug Fixes
+
+* **lib:** update poppler win32 binaries from 21.10.0 to 21.11.0 ([1838bee](https://www.github.com/Fdawgs/node-poppler/commit/1838bee3c21dc6d467db3246b5e5da0802216cf2))
+
+
+### Continuous Integration
+
+* **ci:** do not run clean-up on draft prs ([088722d](https://www.github.com/Fdawgs/node-poppler/commit/088722dde16c7cc9176c90797386d33b56b92056))
+* **spell-check:** do not run on draft prs ([6a48913](https://www.github.com/Fdawgs/node-poppler/commit/6a48913d01f63ec34c30230fe82bb34ad5d3b49e))
+
+
+### Dependencies
+
+* **deps-dev:** bump eslint-config-airbnb-base from 14.2.1 to 15.0.0 ([063e5b4](https://www.github.com/Fdawgs/node-poppler/commit/063e5b4338f7a311aebcb3b75c264c4cfd9a8ed5))
+* **deps-dev:** bump eslint-plugin-import from 2.25.2 to 2.25.3 ([5962621](https://www.github.com/Fdawgs/node-poppler/commit/59626219099901f73cd30ab720f07f1f50fa33e6))
+* **deps-dev:** bump eslint-plugin-jest from 25.2.2 to 25.2.4 ([77423a1](https://www.github.com/Fdawgs/node-poppler/commit/77423a1f88976182404ccabe498e7d26f22f40a4))
+
+
+### Documentation
+
+* **readme:** add stdout example ([#353](https://www.github.com/Fdawgs/node-poppler/issues/353)) ([f1ed3c2](https://www.github.com/Fdawgs/node-poppler/commit/f1ed3c27eff6a4bfc3a3d273c5137e7a184c4096))
+
+### [5.0.3](https://www.github.com/Fdawgs/node-poppler/compare/v5.0.2...v5.0.3) (2021-11-04)
+
+
+### Bug Fixes
+
+* **index:** normalize `binPath` constructor param ([#345](https://www.github.com/Fdawgs/node-poppler/issues/345)) ([3ec8cae](https://www.github.com/Fdawgs/node-poppler/commit/3ec8cae42432a49fcd467467d7a1c2cd5d9be1d8))
+* **index:** pdftocairo `singleFile` option ([31bbe79](https://www.github.com/Fdawgs/node-poppler/commit/31bbe79d22a68b751ee060a682b7bdcfa44ce6a7))
+* **index:** pdftocairo stdout encoding for `pdfFile` option ([8ddcbba](https://www.github.com/Fdawgs/node-poppler/commit/8ddcbba76c2ed650b6c56f63ecb8621fdc66ff45))
+
+
+### Documentation
+
+* bump coc from v2.0.0 to v2.1.0 ([#334](https://www.github.com/Fdawgs/node-poppler/issues/334)) ([7754959](https://www.github.com/Fdawgs/node-poppler/commit/775495963ef5011754e734f63dca1a04c5d3cb25))
+
+
+### Miscellaneous
+
+* **.eslintrc:** remove redundant `impliedStrict` option ([#332](https://www.github.com/Fdawgs/node-poppler/issues/332)) ([417380e](https://www.github.com/Fdawgs/node-poppler/commit/417380ec732352e2aa7040accac1333d02588e88))
+* **.prettierrc:** only enable `bracketSameLine` for html ([#341](https://www.github.com/Fdawgs/node-poppler/issues/341)) ([30dfe71](https://www.github.com/Fdawgs/node-poppler/commit/30dfe719fa84be290406240c054cf142a7e41824))
+
+
+### Continuous Integration
+
+* **cd:** stop `prepare` script running ([#342](https://www.github.com/Fdawgs/node-poppler/issues/342)) ([5d22a76](https://www.github.com/Fdawgs/node-poppler/commit/5d22a76e8b331630e6a65a9061a1fe57d3785e3a))
+
+
+### Dependencies
+
+* **deps-dev:** bump @commitlint/cli from 13.2.1 to 14.1.0 ([ffb9ccb](https://www.github.com/Fdawgs/node-poppler/commit/ffb9ccbd93b58d8f6a3571f8a8036187ccf63a49))
+* **deps-dev:** bump @commitlint/config-conventional ([fa491ea](https://www.github.com/Fdawgs/node-poppler/commit/fa491eaf0a8c8d8a35c3039b9054aa81e770ff06))
+* **deps-dev:** bump dev dependencies ([#335](https://www.github.com/Fdawgs/node-poppler/issues/335)) ([ac2e119](https://www.github.com/Fdawgs/node-poppler/commit/ac2e11955b8b00d74666262ee68bed1f6f3ab346))
+* **deps:** bump actions/checkout from 2.3.4 to 2.3.5 ([d3d838c](https://www.github.com/Fdawgs/node-poppler/commit/d3d838caf16a47af3841ec5bce45fa98f01b7c21))
+* **deps:** bump actions/checkout from 2.3.5 to 2.4.0 ([de7aad4](https://www.github.com/Fdawgs/node-poppler/commit/de7aad4ab48198f065df6044b4c897c23b831829))
+
 ### [5.0.2](https://www.github.com/Fdawgs/node-poppler/compare/v5.0.1...v5.0.2) (2021-10-12)
 
 

package/README.md

@@ -87,6 +87,25 @@ const res = await poppler.pdfToCairo(file, outputFile, options);
 console.log(res);
 ```
 
+Example of an `async` `await` call to `poppler.pdfToCairo()`, to convert only the first of a PDF file to a new
+PDF file using stdout:
+
+```js
+const fs = require("fs");
+const { Poppler } = require("node-poppler");
+
+const file = "test_document.pdf";
+const poppler = new Poppler();
+const options = {
+	lastPageToConvert: 1,
+	pdfFile: true,
+};
+
+const res = await poppler.pdfToCairo(file, undefined, options);
+// pdfToCairo writes to stdout using binary encoding if pdfFile or singleFile options are used
+await fs.writeFile("new_file.pdf", res, { encoding: "binary" });
+```
+
 ### poppler.pdfToHtml
 
 Example of calling `poppler.pdfToHtml()` with a promise chain:

package/package.json

@@ -1,94 +1,97 @@
 {
-  "name": "node-poppler",
-  "version": "5.0.2",
-  "description": "Asynchronous node.js wrapper for the Poppler PDF rendering library",
-  "keywords": [
-    "async",
-    "attach",
-    "cairo",
-    "converter",
-    "detach",
-    "eps",
-    "html",
-    "jpg",
-    "jpeg",
-    "pdf",
-    "pdf-converter",
-    "pdf-to-cairo",
-    "pdf-to-html",
-    "pdf-to-image",
-    "pdf-to-ppm",
-    "pdf-to-ps",
-    "pdf-to-text",
-    "png",
-    "poppler",
-    "ppm",
-    "ps",
-    "separate",
-    "svg",
-    "text",
-    "tiff",
-    "txt",
-    "unite"
-  ],
-  "main": "src/index.js",
-  "repository": "git+https://github.com/Fdawgs/node-poppler.git",
-  "homepage": "https://github.com/Fdawgs/node-poppler",
-  "bugs": {
-    "url": "https://github.com/Fdawgs/node-poppler/issues"
-  },
-  "license": "MIT",
-  "author": "Frazer Smith <frazer.dev@outlook.com>",
-  "engines": {
-    "node": ">=12.0.0"
-  },
-  "scripts": {
-    "build": "tsc",
-    "doc": "tsc && jsdoc2md src/index.js > API.md && npm run lint:prettier",
-    "jest": "jest --detectOpenHandles --runInBand",
-    "jest:coverage": "jest --coverage --runInBand",
-    "lint": "eslint . --cache --ext js,jsx --ignore-path .gitignore",
-    "lint:prettier": "prettier . --write --ignore-unknown",
-    "lint:prettier:ci": "prettier . --check --ignore-unknown",
-    "prepare": "husky install && rm -rf .git/hooks && ln -s ../.husky .git/hooks",
-    "test": "npm run lint && npm run jest"
-  },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
-  "jest": {
-    "clearMocks": true,
-    "coverageReporters": [
-      "text",
-      "lcovonly"
-    ],
-    "resetMocks": true,
-    "testEnvironment": "node",
-    "testTimeout": 60000
-  },
-  "devDependencies": {
-    "@commitlint/cli": "^13.2.1",
-    "@commitlint/config-conventional": "^13.2.0",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.1",
-    "eslint-plugin-jest": "^25.0.5",
-    "eslint-plugin-jsdoc": "^36.1.1",
-    "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-security": "^1.4.0",
-    "eslint-plugin-security-node": "^1.0.14",
-    "glob": "^7.2.0",
-    "husky": "^7.0.2",
-    "jest": "^27.2.5",
-    "jsdoc-to-markdown": "^7.0.1",
-    "prettier": "2.4.1",
-    "typescript": "^4.4.3"
-  },
-  "dependencies": {
-    "camelcase": "^6.2.0",
-    "upath": "^2.0.1"
-  }
+	"name": "node-poppler",
+	"version": "5.1.2",
+	"description": "Asynchronous node.js wrapper for the Poppler PDF rendering library",
+	"keywords": [
+		"async",
+		"attach",
+		"cairo",
+		"converter",
+		"detach",
+		"eps",
+		"html",
+		"jpg",
+		"jpeg",
+		"pdf",
+		"pdf-converter",
+		"pdf-to-cairo",
+		"pdf-to-html",
+		"pdf-to-image",
+		"pdf-to-ppm",
+		"pdf-to-ps",
+		"pdf-to-text",
+		"png",
+		"poppler",
+		"ppm",
+		"ps",
+		"separate",
+		"svg",
+		"text",
+		"tif",
+		"tiff",
+		"txt",
+		"unite"
+	],
+	"main": "src/index.js",
+	"repository": "git+https://github.com/Fdawgs/node-poppler.git",
+	"homepage": "https://github.com/Fdawgs/node-poppler",
+	"bugs": {
+		"url": "https://github.com/Fdawgs/node-poppler/issues"
+	},
+	"license": "MIT",
+	"author": "Frazer Smith <frazer.dev@outlook.com>",
+	"engines": {
+		"node": ">=12.0.0"
+	},
+	"scripts": {
+		"build": "tsc",
+		"doc": "tsc && jsdoc2md src/index.js > API.md && npm run lint:prettier",
+		"jest": "jest --detectOpenHandles --runInBand",
+		"jest:coverage": "jest --coverage --runInBand",
+		"lint": "eslint . --cache --ext js,jsx --ignore-path .gitignore",
+		"lint:licenses": "license-checker --direct --onlyAllow=\"0BSD;Apache-2.0;BSD-2-Clause;BSD-3-Clause;ISC;MIT;Unlicense\" --production --summary",
+		"lint:prettier": "prettier . --write --ignore-unknown",
+		"lint:prettier:ci": "prettier . --check --ignore-unknown",
+		"prepare": "",
+		"test": "npm run lint && npm run jest"
+	},
+	"commitlint": {
+		"extends": [
+			"@commitlint/config-conventional"
+		]
+	},
+	"jest": {
+		"clearMocks": true,
+		"coverageReporters": [
+			"text",
+			"lcovonly"
+		],
+		"resetMocks": true,
+		"testEnvironment": "node",
+		"testTimeout": 60000
+	},
+	"devDependencies": {
+		"@commitlint/cli": "^16.0.1",
+		"@commitlint/config-conventional": "^16.0.0",
+		"eslint": "^8.7.0",
+		"eslint-config-airbnb-base": "^15.0.0",
+		"eslint-config-prettier": "^8.3.0",
+		"eslint-plugin-import": "^2.25.4",
+		"eslint-plugin-jest": "^25.7.0",
+		"eslint-plugin-jsdoc": "^37.6.1",
+		"eslint-plugin-promise": "^6.0.0",
+		"eslint-plugin-security": "^1.4.0",
+		"eslint-plugin-security-node": "^1.1.0",
+		"glob": "^7.2.0",
+		"husky": "^7.0.4",
+		"jest": "^27.4.7",
+		"jsdoc-to-markdown": "^7.1.0",
+		"license-checker": "^25.0.1",
+		"prettier": "2.5.1",
+		"typescript": "^4.5.4"
+	},
+	"dependencies": {
+		"camelcase": "^6.3.0",
+		"upath": "^2.0.1"
+	}
 }

package/src/index.d.ts

@@ -131,6 +131,8 @@ export class Poppler {
 	 * is specified using the `options.firstPageToConvert` and `options.lastPageToConvert` options, only destinations
 	 * in the page range are listed.
 	 * @param {boolean=} options.printRawDates - Prints the raw (undecoded) date strings, directly from the PDF file.
+	 * @param {boolean=} options.printUrls - Print all URLs in the PDF; only URLs referenced by PDF objects
+	 * such as Link Annotations are listed, not URL strings in the text content.
 	 * @param {boolean=} options.printVersionInfo - Print copyright and version info.
 	 * @param {string=} options.userPassword - User password (for encrypted files).
 	 * @returns {Promise<string|Error>} Promise of stdout string on resolve, or Error object on rejection.
@@ -170,7 +172,8 @@ export class Poppler {
 	 * @param {string=} outputFile - Filepath of the file to output the results to.
 	 *
 	 * If `undefined` then will write output to stdout. Using stdout is not valid with image formats
-	 * unless `options.singleFile` is set to `true`.
+	 * (jpeg, png, and tiff) unless `options.singleFile` is set to `true`.
+	 * Encoding is set to `binary` if used with `options.singleFile` or `options.pdfFile`.
 	 *
 	 * If not set then the output filename will be derived from the PDF file name.
 	 * @param {object=} options - Object containing options to pass to binary.
@@ -258,6 +261,7 @@ export class Poppler {
 	 * pixels. If scale-to-x is set to -1, the horizontal size will determined by the aspect ratio of
 	 * the page (PNG/JPEG/TIFF only).
 	 * @param {boolean=} options.singleFile - Writes only the first page and does not add digits.
+	 * Can only be used with `options.jpegFile`, `options.pngFile`, and `options.tiffFile`.
 	 * @param {boolean=} options.svgFile - Generate SVG (Scalable Vector Graphics) file.
 	 * @param {('none'|'packbits'|'jpeg'|'lzw'|'deflate')=} options.tiffCompression - Set TIFF compression.
 	 * @param {boolean=} options.tiffFile - Generate TIFF file(s).

package/src/index.js

@@ -1,12 +1,10 @@
 /* eslint-disable security/detect-child-process */
 const camelCase = require("camelcase");
-const os = require("os");
 const path = require("upath");
 const { execFile } = require("child_process");
 const util = require("util");
 
 const execFileAsync = util.promisify(execFile);
-const platform = os.platform();
 
 const errorMessages = {
 	0: "No Error",
@@ -59,16 +57,6 @@ function parseOptions(acceptedOptions, options, version) {
 						`Invalid option provided for the current version of the binary used. '${key}' was introduced in v${acceptedOptions[key].minVersion}, but received v${version}`
 					);
 				}
-
-				if (
-					acceptedOptions[key].maxVersion &&
-					version &&
-					version > acceptedOptions[key].maxVersion
-				) {
-					invalidArgs.push(
-						`Invalid option provided for the current version of the binary used. '${key}' is only present up to v${acceptedOptions[key].maxVersion}, but received v${version}`
-					);
-				}
 			} else {
 				invalidArgs.push(`Invalid option provided '${key}'`);
 			}
@@ -88,28 +76,20 @@ class Poppler {
 	 */
 	constructor(binPath) {
 		if (binPath) {
-			this.popplerPath = binPath;
+			this.popplerPath = path.normalizeTrim(binPath);
+		} else if (process.platform === "win32") {
+			this.popplerPath = path.joinSafe(
+				__dirname,
+				"lib",
+				"win32",
+				"poppler-22.01.0",
+				"Library",
+				"bin"
+			);
 		} else {
-			let popplerPath;
-
-			// Build path to Poppler binaries based on OS
-			switch (platform) {
-				// Windows OS
-				case "win32":
-					popplerPath = path.joinSafe(
-						__dirname,
-						"lib",
-						"win32",
-						"poppler-21.10.0",
-						"Library",
-						"bin"
-					);
-					break;
-				default:
-					throw new Error(`${platform} is NOT supported.`);
-			}
-
-			this.popplerPath = popplerPath;
+			throw new Error(
+				`${process.platform} poppler-util binaries are not provided, please pass the installation directory as a parameter to the Poppler instance.`
+			);
 		}
 	}
 
@@ -380,6 +360,7 @@ class Poppler {
 					} else if (stdErr !== "") {
 						reject(new Error(stdErr.trim()));
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});
@@ -418,6 +399,8 @@ class Poppler {
 	 * is specified using the `options.firstPageToConvert` and `options.lastPageToConvert` options, only destinations
 	 * in the page range are listed.
 	 * @param {boolean=} options.printRawDates - Prints the raw (undecoded) date strings, directly from the PDF file.
+	 * @param {boolean=} options.printUrls - Print all URLs in the PDF; only URLs referenced by PDF objects
+	 * such as Link Annotations are listed, not URL strings in the text content.
 	 * @param {boolean=} options.printVersionInfo - Print copyright and version info.
 	 * @param {string=} options.userPassword - User password (for encrypted files).
 	 * @returns {Promise<string|Error>} Promise of stdout string on resolve, or Error object on rejection.
@@ -438,6 +421,7 @@ class Poppler {
 			printMetadata: { arg: "-meta", type: "boolean" },
 			printNamedDests: { arg: "-dests", type: "boolean" },
 			printRawDates: { arg: "-rawdates", type: "boolean" },
+			printUrls: { arg: "-url", type: "boolean", minVersion: "21.11.0" },
 			printVersionInfo: { arg: "-v", type: "boolean" },
 			userPassword: { arg: "-upw", type: "string" },
 		};
@@ -573,7 +557,8 @@ class Poppler {
 	 * @param {string=} outputFile - Filepath of the file to output the results to.
 	 *
 	 * If `undefined` then will write output to stdout. Using stdout is not valid with image formats
-	 * unless `options.singleFile` is set to `true`.
+	 * (jpeg, png, and tiff) unless `options.singleFile` is set to `true`.
+	 * Encoding is set to `binary` if used with `options.singleFile` or `options.pdfFile`.
 	 *
 	 * If not set then the output filename will be derived from the PDF file name.
 	 * @param {object=} options - Object containing options to pass to binary.
@@ -661,6 +646,7 @@ class Poppler {
 	 * pixels. If scale-to-x is set to -1, the horizontal size will determined by the aspect ratio of
 	 * the page (PNG/JPEG/TIFF only).
 	 * @param {boolean=} options.singleFile - Writes only the first page and does not add digits.
+	 * Can only be used with `options.jpegFile`, `options.pngFile`, and `options.tiffFile`.
 	 * @param {boolean=} options.svgFile - Generate SVG (Scalable Vector Graphics) file.
 	 * @param {('none'|'packbits'|'jpeg'|'lzw'|'deflate')=} options.tiffCompression - Set TIFF compression.
 	 * @param {boolean=} options.tiffFile - Generate TIFF file(s).
@@ -751,6 +737,13 @@ class Poppler {
 					args
 				);
 
+				if (
+					outputFile === undefined &&
+					args.some((arg) => ["-singlefile", "-pdf"].includes(arg))
+				) {
+					child.stdout.setEncoding("binary");
+				}
+
 				if (Buffer.isBuffer(file)) {
 					child.stdin.write(file);
 					child.stdin.end();
@@ -775,6 +768,7 @@ class Poppler {
 					} else if (stdErr !== "") {
 						reject(new Error(stdErr.trim()));
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});
@@ -911,6 +905,7 @@ class Poppler {
 					} else if (stdErr !== "") {
 						reject(new Error(stdErr.trim()));
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});
@@ -1111,6 +1106,7 @@ class Poppler {
 					} else if (code === 0) {
 						resolve(errorMessages[code]);
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});
@@ -1356,6 +1352,7 @@ class Poppler {
 					} else if (stdErr !== "") {
 						reject(new Error(stdErr.trim()));
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});
@@ -1506,6 +1503,7 @@ class Poppler {
 					} else if (stdErr !== "") {
 						reject(new Error(stdErr.trim()));
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});