node-poppler 5.0.1 → 5.1.1

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). |
@@ -210,7 +211,7 @@ Converts a PDF file to EPS/JPEG/PDF/PNG/PS/SVG/TIFF.
 | [options.grayscaleFile] | <code>boolean</code> | Generate grayscale file (PNG, JPEG, and TIFF only). |
 | [options.iccFile] | <code>string</code> | Use the specified ICC file as the output profile (PNG only). The profile will be embedded in the PNG file. |
 | [options.jpegFile] | <code>boolean</code> | Generate JPEG file(s). |
-| [options.jpegOptions] | <code>string</code> | When used with `options.jpegFile`, this option can be used to control the JPEG compression parameters. It takes a string of the form `"<opt>=<val>[,<opt>=<val>]"`. Currently available options are: * `quality` Selects the JPEG quality value. The value must be an integer between 0 and 100. * `progressive` Select progressive JPEG output. The possible values are "y", "n", indicating progressive (yes) or non-progressive (no), respectively. * `optimize` Sets whether to compute optimal Huffman coding tables for the JPEG output, which will create smaller files but make an extra pass over the data. The value must be "y" or "n", with "y" performing optimization, otherwise the default Huffman tables are used. Example: `"quality=95,optimize=y"`. |
+| [options.jpegOptions] | <code>string</code> | When used with `options.jpegFile`, this option can be used to control the JPEG compression parameters. It takes a string of the form `"<opt>=<val>[,<opt>=<val>]"`. Currently available options are: - `quality` Selects the JPEG quality value. The value must be an integer between 0 and 100. - `progressive` Select progressive JPEG output. The possible values are "y", "n", indicating progressive (yes) or non-progressive (no), respectively. - `optimize` Sets whether to compute optimal Huffman coding tables for the JPEG output, which will create smaller files but make an extra pass over the data. The value must be "y" or "n", with "y" performing optimization, otherwise the default Huffman tables are used. Example: `"quality=95,optimize=y"`. |
 | [options.lastPageToConvert] | <code>number</code> | Specifies the last page to convert. |
 | [options.monochromeFile] | <code>boolean</code> | Generate monochrome file (PNG and TIFF only). |
 | [options.noCenter] | <code>boolean</code> | By default, PDF pages smaller than the paper (after any scaling) are centered on the paper. This option causes them to be aligned to the lower-left corner of the paper instead (PS,PDF,SVG 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,141 @@
 
 All notable changes to this project will be documented in this file.
 
+### [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)
+
+
+### Bug Fixes
+
+* **lib:** update poppler win32 binaries from 21.09.0 to 21.10.0 ([c8e1e77](https://www.github.com/Fdawgs/node-poppler/commit/c8e1e770cb4afa77008c82d56c3fbf3cb5609670))
+
+
+### Continuous Integration
+
+* **automerge:** update location of octokit rest methods ([c2d6959](https://www.github.com/Fdawgs/node-poppler/commit/c2d6959f71355fd7a8e274c19e59010ef4bff958))
+
+
+### Miscellaneous
+
+* **.eslintrc:** remove inaccurate sourcetype ([#323](https://www.github.com/Fdawgs/node-poppler/issues/323)) ([db65fb6](https://www.github.com/Fdawgs/node-poppler/commit/db65fb62386596fb327c8fbd1d7a6e5fd8f16003))
+* **.prettierrc:** enable `bracketsameline` option ([ccd86c9](https://www.github.com/Fdawgs/node-poppler/commit/ccd86c92087c0df02ceab41251a6cbc653ce3d85))
+* **.vscode:** remove deprecated settings ([#324](https://www.github.com/Fdawgs/node-poppler/issues/324)) ([0638d8e](https://www.github.com/Fdawgs/node-poppler/commit/0638d8e776de7d7570f2578250c7f8651c6c3ad4))
+* **index:** resolve `jsdoc/no-multi-asterisks` warning ([#325](https://www.github.com/Fdawgs/node-poppler/issues/325)) ([e54c041](https://www.github.com/Fdawgs/node-poppler/commit/e54c04199df9e8e49535f0e0499d908ab6ab9531))
+
+
+### Dependencies
+
+* **deps-dev:** add eslint-plugin-security-node ([#316](https://www.github.com/Fdawgs/node-poppler/issues/316)) ([5f7d6ad](https://www.github.com/Fdawgs/node-poppler/commit/5f7d6ad6d3bae444b05fdeb735f38d392fdd360c))
+* **deps-dev:** bump eslint-plugin-jest from 24.7.0 to 25.0.5 ([5924cc7](https://www.github.com/Fdawgs/node-poppler/commit/5924cc700bb5ad47dd76ec9bfced9013af69c733))
+* **deps-dev:** bump prettier from 2.4.0 to 2.4.1 ([ae71ec2](https://www.github.com/Fdawgs/node-poppler/commit/ae71ec26996cb1b6eb90d84265eda27e4efa6499))
+* **deps:** bump actions/setup-node from 2.4.0 to 2.4.1 ([18e8f62](https://www.github.com/Fdawgs/node-poppler/commit/18e8f62d479a632e04eae37de7745f07ef81d3aa))
+* **deps:** bump GoogleCloudPlatform/release-please-action ([e27671b](https://www.github.com/Fdawgs/node-poppler/commit/e27671b95a0241168bd5a367aa2940f2bee278ff))
+* **deps:** bump GoogleCloudPlatform/release-please-action ([84e74cf](https://www.github.com/Fdawgs/node-poppler/commit/84e74cf100dcd7f6fc97438910d78d7cd54bcffa))
+* **deps:** bump wagoid/commitlint-github-action from 4.1.4 to 4.1.5 ([2f8052b](https://www.github.com/Fdawgs/node-poppler/commit/2f8052b7884dd55505d571acb5cefd53f3edb08a))
+* **deps:** bump wagoid/commitlint-github-action from 4.1.5 to 4.1.9 ([bf11955](https://www.github.com/Fdawgs/node-poppler/commit/bf11955894fc0a4100533f1e744a5a4d956d1fd3))
+
 ### [5.0.1](https://www.github.com/Fdawgs/node-poppler/compare/v5.0.0...v5.0.1) (2021-09-13)
 
 

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,93 +1,96 @@
 {
-  "name": "node-poppler",
-  "version": "5.0.1",
-  "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": 10000
-  },
-  "devDependencies": {
-    "@commitlint/cli": "^13.1.0",
-    "@commitlint/config-conventional": "^13.1.0",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jest": "^24.3.6",
-    "eslint-plugin-jsdoc": "^36.0.6",
-    "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-security": "^1.4.0",
-    "glob": "^7.1.7",
-    "husky": "^7.0.2",
-    "jest": "^27.1.0",
-    "jsdoc-to-markdown": "^7.0.1",
-    "prettier": "2.4.0",
-    "typescript": "^4.4.2"
-  },
-  "dependencies": {
-    "camelcase": "^6.2.0",
-    "upath": "^2.0.1"
-  }
+	"name": "node-poppler",
+	"version": "5.1.1",
+	"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: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": "^15.0.0",
+		"@commitlint/config-conventional": "^15.0.0",
+		"eslint": "^7.32.0",
+		"eslint-config-airbnb-base": "^15.0.0",
+		"eslint-config-prettier": "^8.3.0",
+		"eslint-plugin-import": "^2.25.3",
+		"eslint-plugin-jest": "^25.2.4",
+		"eslint-plugin-jsdoc": "^37.0.3",
+		"eslint-plugin-promise": "^5.1.1",
+		"eslint-plugin-security": "^1.4.0",
+		"eslint-plugin-security-node": "^1.0.14",
+		"glob": "^7.2.0",
+		"husky": "^7.0.4",
+		"jest": "^27.3.1",
+		"jsdoc-to-markdown": "^7.1.0",
+		"license-checker": "^25.0.1",
+		"prettier": "2.5.1",
+		"typescript": "^4.4.4"
+	},
+	"dependencies": {
+		"camelcase": "^6.2.0",
+		"upath": "^2.0.1"
+	}
 }

package/src/index.d.ts

@@ -4,7 +4,7 @@ export class Poppler {
 	 * Useful for Linux users who have poppler-utils binaries already installed.
 	 */
 	constructor(binPath?: string | undefined);
-	popplerPath: string | undefined;
+	popplerPath: string;
 	/**
 	 * @author Frazer Smith
 	 * @description Embeds files (attachments) into a PDF file.
@@ -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.
@@ -206,10 +209,10 @@ export class Poppler {
 	 * @param {string=} options.jpegOptions - When used with `options.jpegFile`, this option can
 	 * be used to control the JPEG compression parameters. It takes a string of the form
 	 * `"<opt>=<val>[,<opt>=<val>]"`. Currently available options are:
-	 * * `quality` Selects the JPEG quality value. The value must be an integer between 0 and 100.
-	 * * `progressive` Select progressive JPEG output. The possible values are "y", "n", indicating
+	 * - `quality` Selects the JPEG quality value. The value must be an integer between 0 and 100.
+	 * - `progressive` Select progressive JPEG output. The possible values are "y", "n", indicating
 	 * progressive (yes) or non-progressive (no), respectively.
-	 * * `optimize` Sets whether to compute optimal Huffman coding tables for the JPEG output, which
+	 * - `optimize` Sets whether to compute optimal Huffman coding tables for the JPEG output, which
 	 * will create smaller files but make an extra pass over the data. The value must be "y" or "n",
 	 * with "y" performing optimization, otherwise the default Huffman tables are used.
 	 *
@@ -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,11 +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",
@@ -58,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}'`);
 			}
@@ -87,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-21.11.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.09.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.`
+			);
 		}
 	}
 
@@ -379,6 +360,7 @@ class Poppler {
 					} else if (stdErr !== "") {
 						reject(new Error(stdErr.trim()));
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});
@@ -417,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.
@@ -437,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" },
 		};
@@ -572,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.
@@ -608,10 +594,10 @@ class Poppler {
 	 * @param {string=} options.jpegOptions - When used with `options.jpegFile`, this option can
 	 * be used to control the JPEG compression parameters. It takes a string of the form
 	 * `"<opt>=<val>[,<opt>=<val>]"`. Currently available options are:
-	 * * `quality` Selects the JPEG quality value. The value must be an integer between 0 and 100.
-	 * * `progressive` Select progressive JPEG output. The possible values are "y", "n", indicating
+	 * - `quality` Selects the JPEG quality value. The value must be an integer between 0 and 100.
+	 * - `progressive` Select progressive JPEG output. The possible values are "y", "n", indicating
 	 * progressive (yes) or non-progressive (no), respectively.
-	 * * `optimize` Sets whether to compute optimal Huffman coding tables for the JPEG output, which
+	 * - `optimize` Sets whether to compute optimal Huffman coding tables for the JPEG output, which
 	 * will create smaller files but make an extra pass over the data. The value must be "y" or "n",
 	 * with "y" performing optimization, otherwise the default Huffman tables are used.
 	 *
@@ -660,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).
@@ -750,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();
@@ -774,6 +768,7 @@ class Poppler {
 					} else if (stdErr !== "") {
 						reject(new Error(stdErr.trim()));
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});
@@ -910,6 +905,7 @@ class Poppler {
 					} else if (stdErr !== "") {
 						reject(new Error(stdErr.trim()));
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});
@@ -1110,6 +1106,7 @@ class Poppler {
 					} else if (code === 0) {
 						resolve(errorMessages[code]);
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});
@@ -1355,6 +1352,7 @@ class Poppler {
 					} else if (stdErr !== "") {
 						reject(new Error(stdErr.trim()));
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});
@@ -1505,6 +1503,7 @@ class Poppler {
 					} else if (stdErr !== "") {
 						reject(new Error(stdErr.trim()));
 					} else {
+						/* istanbul ignore next */
 						reject(new Error(errorMessages[code]));
 					}
 				});