Merge pull request #29 from Sparticuz/feature/esm

.eslintrc.js → .eslintrc.cjs

@@ -1,9 +1,10 @@
+// eslint-disable-next-line import/no-extraneous-dependencies, n/no-unpublished-require
 require("@rushstack/eslint-patch/modern-module-resolution");
 
 module.exports = {
   extends: ["@sparticuz/eslint-config"],
   parserOptions: {
-    ecmaVersion: 2021,
+    ecmaVersion: 2022,
     project: "./tsconfig.json",
     sourceType: "module",
   },

README.md

@@ -74,12 +74,6 @@ const options = {
 await decrypt(options);
 ```
 
-## CJS
-If you use CJS, you'll need to specify the function you want to require.
-```
-const decrypt = require("node-qpdf").decrypt;
-```
-
 ## Coverage
 File        | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
 ------------|---------|----------|---------|---------|-------------------

package.json

@@ -2,19 +2,6 @@
   "name": "node-qpdf2",
   "version": "4.1.0",
   "description": "A Content Preserving transformations on PDFs wrapped around QPDF",
-  "main": "./dist/index.js",
-  "scripts": {
-    "test": "c8 --reporter=lcov --reporter=text --all --include=src ava test/ --timeout=30s",
-    "lint": "eslint --ignore-path .gitignore '**/*.[jt]s'",
-    "build": "tsc -p tsconfig.build.json"
-  },
-  "engines": {
-    "node": ">=14.18.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Sparticuz/node-qpdf2.git"
-  },
   "keywords": [
     "pdf",
     "qpdf",
@@ -31,33 +18,45 @@
     "rc4-128",
     "rc4-40"
   ],
-  "author": "Kyle McNally <kyle@kmcnally.net>",
+  "homepage": "https://github.com/Sparticuz/node-qpdf2",
+  "bugs": {
+    "url": "https://github.com/Sparticuz/node-qpdf2/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Sparticuz/node-qpdf2.git"
+  },
   "license": "MIT",
+  "author": "Kyle McNally <kyle@kmcnally.net>",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "eslint --ignore-path .gitignore '**/*.[jt]s'",
+    "test": "c8 --reporter=lcov --reporter=text --all --include=src ava test/ --timeout=30s"
+  },
   "ava": {
-    "extensions": [
-      "ts"
-    ],
-    "require": [
-      "ts-node/register/transpile-only"
+    "extensions": {
+      "ts": "module"
+    },
+    "nodeArguments": [
+      "--loader=ts-node/esm/transpile-only"
     ]
   },
-  "types": "./dist/index.d.ts",
-  "bugs": {
-    "url": "https://github.com/Sparticuz/node-qpdf2/issues"
-  },
-  "homepage": "https://github.com/Sparticuz/node-qpdf2",
   "devDependencies": {
     "@rushstack/eslint-patch": "^1.2.0",
-    "@sparticuz/eslint-config": "^7.1.11",
-    "@tsconfig/node14": "^1.0.3",
-    "@types/node": "^14.18.29",
-    "@typescript-eslint/eslint-plugin": "^5.48.0",
-    "@typescript-eslint/parser": "^5.48.0",
-    "ava": "^5.1.0",
+    "@sparticuz/eslint-config": "^7.2.0",
+    "@tsconfig/node16-strictest-esm": "^1.0.3",
+    "@types/node": "^18.13.0",
+    "ava": "^5.2.0",
     "c8": "^7.12.0",
-    "eslint": "^8.31.0",
-    "prettier": "^2.8.1",
+    "eslint": "^8.33.0",
+    "prettier": "^2.8.4",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.5"
+  },
+  "engines": {
+    "node": ">=16"
   }
 }

src/decrypt.ts

@@ -1,5 +1,5 @@
-import { fileExists } from "./utils";
-import execute from "./spawn";
+import { fileExists } from "./utils.js";
+import execute from "./spawn.js";
 
 export interface DecryptSettings {
   /** The path for the encrypted pdf */

src/encrypt.ts

@@ -1,5 +1,5 @@
-import execute from "./spawn";
-import { fileExists, hyphenate } from "./utils";
+import execute from "./spawn.js";
+import { fileExists, hyphenate } from "./utils.js";
 
 const EncryptDefaults = {
   keyLength: 256,

src/index.ts

@@ -1,4 +1,4 @@
-export type { DecryptSettings } from "./decrypt";
-export { decrypt } from "./decrypt";
-export type { EncryptOptions } from "./encrypt";
-export { encrypt } from "./encrypt";
+export type { DecryptSettings } from "./decrypt.js";
+export { decrypt } from "./decrypt.js";
+export type { EncryptOptions } from "./encrypt.js";
+export { encrypt } from "./encrypt.js";

src/spawn.ts

@@ -19,11 +19,11 @@ export default (callArguments: string[]): Promise<Buffer> => {
       reject(error);
     });
     process.on("close", (code) => {
-      if (code !== 0) {
+      if (code === 0) {
+        resolve(Buffer.from(stdout.join("")));
+      } else {
         // There is a problem from qpdf
         reject(Buffer.from(stderr.join("")).toLocaleString());
-      } else {
-        resolve(Buffer.from(stdout.join("")));
       }
     });
   });

src/utils.ts

@@ -14,5 +14,6 @@ export const hyphenate = (variable: string): string =>
  * @param file the path of the file to be tested.
  */
 export const fileExists = (file: string): boolean => {
+  // eslint-disable-next-line security/detect-non-literal-fs-filename
   return !!existsSync(file);
 };

test/decrypt.ts

@@ -1,5 +1,5 @@
 import test from "ava";
-import { decrypt } from "../src/decrypt";
+import { decrypt } from "../src/decrypt.js";
 
 test("Should not work if no input file is specified", async (t) => {
   // @ts-expect-error This is what I'm testing

test/encrypt-and-decrypt.ts

@@ -1,5 +1,5 @@
 import test from "ava";
-import { encrypt, decrypt } from "../src";
+import { encrypt, decrypt } from "../src/index.js";
 
 const input = "test/example.pdf";
 

test/encrypt.ts

@@ -1,6 +1,6 @@
 import test from "ava";
 import { copyFile } from "node:fs/promises";
-import { encrypt } from "../src/encrypt";
+import { encrypt } from "../src/encrypt.js";
 
 const input = "test/example.pdf";
 const password = "1234";

tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@tsconfig/node14/tsconfig.json",
+  "extends": "@tsconfig/node16-strictest-esm/tsconfig.json",
   "compilerOptions": {
     "declaration": true,
     "outDir": "dist",