afpp 2.0.0-beta.2 → 2.1.0

package/README.md

@@ -8,57 +8,101 @@
 ![Repo Size](https://img.shields.io/github/repo-size/l2ysho/afpp)
 ![Last Commit](https://img.shields.io/github/last-commit/l2ysho/afpp.svg)
 
-Another f\*cking pdf parser. (alpha)
+Another f\*cking PDF parser. Because parsing PDFs in Node.js should be easy. Live long and parse PDFs. 🖖
 
 ## Why?
 
-If you are parsing pdf files in nodejs and you are satisfied with your actual solution, good for you, you don't need this.
+There are plenty of PDF-related packages for Node.js. They work… until they don’t.
+
+Afpp was built to solve the headaches I ran into while trying to parse PDFs in Node.js:
+
+- 📦 Do I need a package with 30+ MB just to read a PDF?
+- 🧵 Why is the event loop blocked?
+- 🐏 Is that a memory leak I smell?
+- 🐌 Should reading a PDF really be this performance-heavy?
+- 🐞 Why is everything so buggy?
+- 🎨 Why does it complain about the lack of a canvas in Node.js?
+- 🧱 Why does canvas require native C++/Python dependencies to build?
+- 🪟 Why does it complain about the missing window object?
+- 🪄 Why do I need ImageMagick for this?!
+- 👻 What the hell is Ghostscript, and why does it keep failing?
+- ❌ Where’s the TypeScript support?
+- 🧓 Why are the dependencies older than my dev career?
+- 🔐 Why does everything work… until I try an encrypted PDF?
+- 🕯️ Why does every OS need its own special setup ritual?
 
-But if you’ve encountered one or more of these issues:
+## Prerequisites
 
-- package size (+30mb)
-- blocking event loop
-- performance issues
-- buggy as shit
-- not working in esm/commonjs
-- old pdfjs-dist as peer dependency
-- no typescript support
-- parsing of encrypted pdf files (password needed)
+- Node.js >= v22.14.0
 
-then you might find this package useful.
+## 📦 Installation
 
-## Prerequisites
+You can install `afpp` via npm, Yarn, or pnpm.
+
+### npm
+
+```bash
+npm install afpp
+```
 
--- Node.js v22.14.0
+### Yarn
+
+```bash
+yarn add afpp
+```
+
+### pnpm
+
+```bash
+pnpm add afpp
+```
 
 ## Getting started
 
-`npm install afpp`
+The `afpp` library makes it simple to extract text or images from PDF files in Node.js. Whether your PDF is stored locally, hosted online, or encrypted, `afpp` provides an easy-to-use API to handle it all. All functions have common parameters and accepts string path, buffer, or URL object.
 
-**commonjs**:
+### Get text from path
 
-```js
-const { pdf2string } = require('afpp');
-const path = require('node:path');
+```ts
+import { readFile } from 'fs/promises';
+import path from 'path';
 
-const pathToFile = path.join('example.pdf');
+import { pdf2string } from 'afpp';
+
+(async function main() {
+  const pathToFile = path.join('..', 'test', 'example.pdf');
+  const input = await readFile(pathToFile);
+  const data = await pdf2string(input);
 
-(async function start() {
-  const pdfString = await pdf2string(pathToFile);
-  console.log(pdfString);
+  console.log('Extracted text:', data); // ['page 1 content', 'page 2 content', ...]
 })();
 ```
 
-**esm**:
+### Get image from URL
 
-```js
-import { pdf2string } from 'afpp';
-import path from 'node:path';
+```ts
+import { pdf2image } from 'afpp';
+
+(async function main() {
+  const url = new URL('https://pdfobject.com/pdf/sample.pdf');
+  const arrayOfImages = await pdf2image(url);
+
+  console.log(arrayOfImages); // [imageBuffer, imageBuffer, ...]
+})();
+```
+
+### Parse pdf buffer
+
+```ts
+import { parsePdf } from 'afpp';
 
-const pathToFile = path.join('example.pdf');
+(async function main() {
+  // Download PDF from URL
+  const response = await fetch('https://pdfobject.com/pdf/sample.pdf');
+  const buffer = Buffer.from(await response.arrayBuffer());
 
-(async function start() {
-  const pdfString = await pdf2string(pathToFile);
-  console.log(pdfString);
+  // Parse the PDF buffer
+  const result = await parsePdf(buffer, {}, (content) => content);
+  console.log('Parsed PDF:', result);
 })();
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "afpp",
-  "version": "2.0.0-beta.2",
+  "version": "2.1.0",
   "description": "another f*cking pdf parser",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -25,8 +25,8 @@
     "url": "git+ssh://git@github.com/l2ysho/afpp.git"
   },
   "engines": {
-    "node": "v22.15.0",
-    "npm": "10.9.2"
+    "node": ">=22.14.0",
+    "npm": ">=10.9.2"
   },
   "keywords": [
     "pdf",