@peculiar/pdf-cli 1.17.1 → 2.0.0

package/README.md

@@ -1,4 +1,15 @@
-# `@peculiar/pdf-cli`
+<h1 align="center">
+  @peculiar/pdf-cli
+</h1>
+
+<div align="center">
+
+![GitHub License](https://img.shields.io/github/license/PeculiarVentures/pdf)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/PeculiarVentures/pdf/release.yml?branch=main&label=release)
+[![npm version](https://img.shields.io/npm/v/@peculiar/pdf-cli.svg)](https://www.npmjs.com/package/@peculiar/pdf-cli)
+[![npm downloads](https://img.shields.io/npm/dm/@peculiar/pdf-cli.svg)](https://www.npmjs.com/package/@peculiar/pdf-cli)
+
+</div>
 
 Command-line interface for PDF document manipulation and analysis.
 
@@ -8,6 +19,10 @@ Command-line interface for PDF document manipulation and analysis.
 npm install -g @peculiar/pdf-cli
 ```
 
+## Breaking Changes In v2
+
+v2 requires Node.js `^20.19.0 || >=22.12.0` (1.x declared no `engines`). `pvpdf` is an ES module at `build/index.js` (was `build/index.cjs`); the commands are unchanged. See the [full notes](https://github.com/PeculiarVentures/pdf#breaking-changes-in-v2).
+
 ## Commands
 
 ### info

package/build/index.d.ts

@@ -0,0 +1 @@
+import "reflect-metadata";

package/build/index.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+import "reflect-metadata";
+import { Crypto } from "@peculiar/webcrypto";
+import * as core from "@peculiar/pdf-core";
+import { Command } from "commander";
+import * as pkijs from "pkijs";
+import { PDFDocument } from "@peculiar/pdf-doc";
+import * as fs from "fs";
+// src/commands/info.ts
+const info = new Command("info").argument("<pdf file>");
+info.description("Prints PDF document information");
+info.action(async (file, _options, _command) => {
+	const raw = fs.readFileSync(file);
+	const info = await (await PDFDocument.load(raw)).target.toString();
+	console.log(info);
+});
+// src/index.ts
+const program = new Command("pdf");
+pkijs.setEngine("pdf", new core.PDFCryptoEngine({
+	name: "pdf",
+	crypto: new Crypto()
+}));
+program.addCommand(info);
+program.parse();

package/package.json

@@ -1,44 +1,49 @@
 {
   "name": "@peculiar/pdf-cli",
-  "version": "1.17.1",
+  "version": "2.0.0",
   "description": "Command-line interface for PDF document manipulation and analysis",
-  "author": "microshine <microshine@mail.ru>",
-  "homepage": "https://github.com/PeculiarVentures/pdf/tree/master/packages/pdf-cli#readme",
-  "license": "AGPL",
-  "main": "build/peculiar.pdf.cli.js",
+  "type": "module",
   "bin": {
-    "pvpdf": "build/peculiar.pdf.cli.js"
+    "pvpdf": "build/index.js"
   },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
+  "main": "./build/index.js",
+  "module": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "exports": {
+    ".": "./build/index.js",
+    "./package.json": "./package.json"
   },
   "files": [
-    "build",
-    "LICENSE",
-    "README.md"
+    "build/",
+    "README.md",
+    "LICENSE"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "author": "microshine <microshine@mail.ru>",
+  "license": "AGPL",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/PeculiarVentures/pdf.git"
-  },
-  "scripts": {
-    "test": "echo \"Error: run tests from root\" && exit 1",
-    "clear": "rimraf build/*",
-    "build": "yarn run build:module",
-    "build:module": "rollup -c",
-    "rebuild": "yarn run clear && yarn run build",
-    "prepack": "npm run rebuild"
+    "url": "https://github.com/PeculiarVentures/pdf",
+    "directory": "packages/cli"
   },
   "bugs": {
     "url": "https://github.com/PeculiarVentures/pdf/issues"
   },
+  "homepage": "https://github.com/PeculiarVentures/pdf/tree/main/packages/cli#readme",
   "dependencies": {
-    "@peculiar/pdf-core": "^1.17.1",
-    "@peculiar/pdf-doc": "^1.17.1",
-    "@peculiar/webcrypto": "^1.5.0",
-    "commander": "^12.1.0",
-    "pkijs": "^3.2.4"
-  },
-  "gitHead": "5909f25f54def17880f0760a7e33f0c4aaff4bda"
+    "@peculiar/asn1-schema": "^3.0.0",
+    "@peculiar/pdf-core": "^2.0.0",
+    "@peculiar/pdf-doc": "^2.0.0",
+    "@peculiar/webcrypto": "^2.0.0",
+    "@peculiar/x509": "^3.1.0",
+    "asn1js": "^4.0.0",
+    "commander": "^14.0.3",
+    "pkijs": "^4.0.0",
+    "reflect-metadata": "^0.2.2"
+  }
 }

package/build/peculiar.pdf.cli.js

@@ -1,47 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-
-var webcrypto = require('@peculiar/webcrypto');
-var core = require('@peculiar/pdf-core');
-var commander = require('commander');
-var pkijs = require('pkijs');
-var pdfDoc = require('@peculiar/pdf-doc');
-var fs = require('fs');
-
-function _interopNamespaceDefault(e) {
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-
-var core__namespace = /*#__PURE__*/_interopNamespaceDefault(core);
-var pkijs__namespace = /*#__PURE__*/_interopNamespaceDefault(pkijs);
-var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
-
-const info = new commander.Command("info").argument("<pdf file>");
-info.description("Prints PDF document information");
-info.action(async (file, _options, _command) => {
-    const raw = fs__namespace.readFileSync(file);
-    const doc = await pdfDoc.PDFDocument.load(raw);
-    const info = await doc.target.toString();
-    console.log(info);
-});
-
-const program = new commander.Command("pdf");
-pkijs__namespace.setEngine("pdf", new core__namespace.PDFCryptoEngine({
-    name: "pdf",
-    crypto: new webcrypto.Crypto()
-}));
-program.addCommand(info);
-program.parse();