node-poppler 9.1.1 → 10.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-present Frazer Smith
+Copyright (c) 2019-present Frazer Smith <frazer.dev@icloud.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,41 +1,42 @@
 # 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://npmjs.com/package/node-poppler)
+[![GitHub release](https://img.shields.io/github/v/release/Fdawgs/node-poppler)](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)
 [![CI](https://github.com/Fdawgs/node-poppler/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Fdawgs/node-poppler/actions/workflows/ci.yml)
 [![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)
+[![code style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4?style=flat)](https://github.com/prettier/prettier)
+[![OSSF Scorecard](https://api.scorecard.dev/projects/github.com/Fdawgs/node-poppler/badge)](https://scorecard.dev/viewer/?uri=github.com/Fdawgs/node-poppler)
 
-> Asynchronous Node.js wrapper for the Poppler PDF rendering library
+> Asynchronous Node.js wrapper for the Poppler PDF rendering utilities
 
 ## 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.
+[Poppler](https://poppler.freedesktop.org) is a PDF rendering library that also includes a collection of utilities, which provide functionality for manipulating PDF documents and extracting data from them, including 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.
+The `node-poppler` module provides an asynchronous Node.js wrapper around these utilities for easier use.
 
 ## Installation
 
 Install using `npm`:
 
-```bash
+```sh
 npm i node-poppler
 ```
 
 ### Linux and macOS/Darwin support
 
 64-bit Windows binaries are provided via an optional dependency on the [`node-poppler-win32`](https://www.npmjs.com/package/node-poppler-win32) package.
-For Linux and Mac users, the `poppler-data` and `poppler-utils` binaries binary will need to be installed separately.
+For Linux and macOS users, the `poppler-data` package and `poppler-utils` binaries will need to be installed separately.
 
 An example of downloading the binaries on a Debian system:
 
-```
+```sh
 sudo apt-get install poppler-data poppler-utils
 ```
 
-For macOS users, the binaries can be installed with [Homebrew](https://brew.sh/):
+For macOS users, the binaries can be installed with [Homebrew](https://brew.sh):
 
-```
+```sh
 brew install poppler
 ```
 
@@ -45,10 +46,10 @@ Please refer to the [JSDoc comments in the source code](./src/index.js) or the [
 
 ### poppler.pdfToCairo
 
-Example of an `async` `await` call to `poppler.pdfToCairo()`, to convert only the first and second page of a PDF file to PNG:
+Example of an `async`/`await` call to `poppler.pdfToCairo()` to convert the first two pages of a PDF file to PNG using ESM syntax:
 
 ```js
-const { Poppler } = require("node-poppler");
+import { Poppler } from "node-poppler";
 
 const file = "test_document.pdf";
 const poppler = new Poppler();
@@ -57,18 +58,17 @@ const options = {
 	lastPageToConvert: 2,
 	pngFile: true,
 };
-const outputFile = `test_document.png`;
+const outputFile = "test_document";
 
 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 page of a PDF file to a new
-PDF file using stdout:
+Example of an `async`/`await` call to `poppler.pdfToCairo()` to convert the first page of a PDF file to a new PDF file via stdout using ESM syntax:
 
 ```js
-const { writeFile } = require("node:fs/promises");
-const { Poppler } = require("node-poppler");
+import { writeFile } from "node:fs/promises";
+import { Poppler } from "node-poppler";
 
 const file = "test_document.pdf";
 const poppler = new Poppler();
@@ -84,9 +84,11 @@ await writeFile("new_file.pdf", res, { encoding: "binary", flush: true });
 
 ### poppler.pdfToHtml
 
-Example of calling `poppler.pdfToHtml()` with a promise chain:
+Example of calling `poppler.pdfToHtml()` with a promise chain using CJS syntax:
 
 ```js
+"use strict";
+
 const { Poppler } = require("node-poppler");
 
 const file = "test_document.pdf";
@@ -107,9 +109,11 @@ poppler
 	});
 ```
 
-Example of calling `poppler.pdfToHtml()` with a promise chain, providing a Buffer as an input:
+Example of calling `poppler.pdfToHtml()` with a promise chain using CJS syntax and a `Buffer` as input:
 
 ```js
+"use strict";
+
 const { readFileSync } = require("node:fs");
 const { Poppler } = require("node-poppler");
 
@@ -133,9 +137,11 @@ poppler
 
 ### poppler.pdfToText
 
-Example of calling `poppler.pdfToText()` with a promise chain:
+Example of calling `poppler.pdfToText()` with a promise chain using CJS syntax:
 
 ```js
+"use strict";
+
 const { Poppler } = require("node-poppler");
 
 const file = "test_document.pdf";
@@ -166,7 +172,7 @@ Please adhere to this project's [Code of Conduct](https://github.com/Fdawgs/.git
 
 ## Acknowledgements
 
-- [**Albert Astals Cid**](https://github.com/albert-astals-cid-kdab) - [Poppler](https://poppler.freedesktop.org/) developer
+- [**Albert Astals Cid**](https://github.com/albert-astals-cid-kdab) - [Poppler](https://poppler.freedesktop.org) developer
 
 ## License
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "node-poppler",
-	"version": "9.1.1",
-	"description": "Asynchronous Node.js wrapper for the Poppler PDF rendering library",
+	"version": "10.0.0",
+	"description": "Asynchronous Node.js wrapper for the Poppler PDF rendering utilities",
 	"keywords": [
 		"async",
 		"attach",