pdf-oxide 0.3.24

package/README.md

@@ -0,0 +1,218 @@
+# PDF Oxide for Node.js — The Fastest PDF Toolkit for JavaScript & TypeScript
+
+The fastest Node.js PDF library for text extraction, image extraction, and markdown conversion. Powered by a pure-Rust core, exposed to Node.js through a native N-API addon. 0.8ms mean per document, 5× faster than PyMuPDF, 15× faster than pypdf. 100% pass rate on 3,830 real-world PDFs. MIT / Apache-2.0 licensed.
+
+[![npm](https://img.shields.io/npm/v/pdf-oxide)](https://www.npmjs.com/package/pdf-oxide)
+[![License: MIT OR Apache-2.0](https://img.shields.io/badge/License-MIT%20OR%20Apache--2.0-blue.svg)](https://opensource.org/licenses)
+
+> **Part of the [PDF Oxide](https://github.com/yfedoseev/pdf_oxide) toolkit.** Same Rust core, same speed, same 100% pass rate as the [Rust](https://docs.rs/pdf_oxide), [Python](../python/README.md), [Go](../go/README.md), [C# / .NET](../csharp/README.md), and [WASM](../wasm-pkg/README.md) bindings.
+>
+> Need to run in browsers, Deno, Bun, or Cloudflare Workers? Use the [WASM build](../wasm-pkg/README.md) instead — same API, no native binaries.
+
+## Quick Start
+
+```bash
+npm install pdf-oxide
+```
+
+```javascript
+const { PdfDocument } = require("pdf-oxide");
+
+const doc = new PdfDocument("paper.pdf");
+const text = doc.extractText(0);
+const markdown = doc.toMarkdown(0);
+doc.close();
+```
+
+TypeScript:
+
+```typescript
+import { PdfDocument } from "pdf-oxide";
+
+const doc = new PdfDocument("paper.pdf");
+const text: string = doc.extractText(0);
+const markdown: string = doc.toMarkdown(0);
+doc.close();
+```
+
+## Why pdf_oxide?
+
+- **Fast** — 0.8ms mean per document, 5× faster than PyMuPDF, 15× faster than pypdf, 29× faster than pdfplumber
+- **Reliable** — 100% pass rate on 3,830 test PDFs, zero panics, zero timeouts, no segfaults
+- **Complete** — Text extraction, image extraction, search, form fields, PDF creation, and editing in one package
+- **Permissive license** — MIT / Apache-2.0 — use freely in commercial and closed-source projects
+- **Pure Rust core** — Memory-safe, panic-free, no C dependencies beyond the N-API glue
+- **Native binaries** — Pre-built `.node` addons for Linux, macOS, and Windows (x64 + ARM64)
+- **Full TypeScript support** — Type definitions ship in the package
+
+## Performance
+
+Benchmarked on 3,830 PDFs from three independent public test suites (veraPDF, Mozilla pdf.js, DARPA SafeDocs). Text extraction libraries only. Single-thread, 60s timeout, no warm-up.
+
+| Library | Mean | p99 | Pass Rate | License |
+|---------|------|-----|-----------|---------|
+| **PDF Oxide** | **0.8ms** | **9ms** | **100%** | **MIT / Apache-2.0** |
+| PyMuPDF | 4.6ms | 28ms | 99.3% | AGPL-3.0 |
+| pypdfium2 | 4.1ms | 42ms | 99.2% | Apache-2.0 |
+| pdftext | 7.3ms | 82ms | 99.0% | GPL-3.0 |
+| pdfminer | 16.8ms | 124ms | 98.8% | MIT |
+| pypdf | 12.1ms | 97ms | 98.4% | BSD-3 |
+
+99.5% text parity vs PyMuPDF and pypdfium2 across the full corpus. The Node.js binding adds negligible overhead — extraction stays within ~25% of direct Rust calls on real-world fixtures.
+
+## Installation
+
+```bash
+npm install pdf-oxide
+```
+
+Pre-built native addons for:
+
+| Platform | x64 | ARM64 |
+|---|---|---|
+| Linux (glibc) | Yes | Yes |
+| Linux (musl)  | Yes | Yes |
+| macOS         | Yes | Yes (Apple Silicon) |
+| Windows       | Yes | Yes |
+
+Requires Node.js 18 or newer. No system dependencies. No Rust toolchain required.
+
+## API Tour
+
+### Open a document
+
+```javascript
+const { PdfDocument } = require("pdf-oxide");
+
+const doc = new PdfDocument("report.pdf");
+console.log(`Pages: ${doc.getPageCount()}`);
+
+const { major, minor } = doc.getVersion();
+console.log(`PDF version: ${major}.${minor}`);
+
+doc.close();
+```
+
+Use `using` for automatic cleanup (Node.js 22+):
+
+```javascript
+{
+  using doc = new PdfDocument("report.pdf");
+  const text = doc.extractText(0);
+} // doc.close() called automatically
+```
+
+### Text extraction
+
+```javascript
+const text = doc.extractText(0);            // single page
+const markdown = doc.toMarkdown(0);         // single page → Markdown
+const html = doc.toHtml(0);                 // single page → HTML
+const plain = doc.toPlainText(0);           // single page → plain text
+
+const allMarkdown = doc.toMarkdownAll();    // entire document
+const allHtml = doc.toHtmlAll();
+```
+
+### Iterate all pages
+
+```javascript
+const doc = new PdfDocument("document.pdf");
+const pageCount = doc.getPageCount();
+
+const pages = [];
+for (let i = 0; i < pageCount; i++) {
+  pages.push(doc.extractText(i));
+}
+
+doc.close();
+```
+
+### Async wrapper
+
+```javascript
+async function extractAll(filePath) {
+  const doc = new PdfDocument(filePath);
+  try {
+    const pageCount = doc.getPageCount();
+    const pages = [];
+    for (let i = 0; i < pageCount; i++) {
+      pages.push(doc.extractText(i));
+    }
+    return pages;
+  } finally {
+    doc.close();
+  }
+}
+
+const pages = await extractAll("document.pdf");
+```
+
+### Error handling
+
+All methods throw on failure. Catch with try/catch:
+
+```javascript
+try {
+  const text = doc.extractText(0);
+} catch (err) {
+  console.error("Extraction failed:", err.message);
+} finally {
+  doc.close();
+}
+```
+
+## Other languages
+
+PDF Oxide ships the same Rust core through six bindings:
+
+- **Rust** — `cargo add pdf_oxide` — see [docs.rs/pdf_oxide](https://docs.rs/pdf_oxide)
+- **Python** — `pip install pdf_oxide` — see [python/README.md](../python/README.md)
+- **Go** — `go get github.com/yfedoseev/pdf_oxide/go` — see [go/README.md](../go/README.md)
+- **C# / .NET** — `dotnet add package PdfOxide` — see [csharp/README.md](../csharp/README.md)
+- **WASM (browsers, Deno, Bun, edge runtimes)** — `npm install pdf-oxide-wasm` — see [wasm-pkg/README.md](../wasm-pkg/README.md)
+
+A bug fix in the Rust core lands in every binding on the next release.
+
+## Documentation
+
+- **[Full Documentation](https://pdf.oxide.fyi)** — Complete documentation site
+- **[JavaScript Getting Started](https://pdf.oxide.fyi/docs/getting-started/javascript)** — Step-by-step Node.js guide
+- **[Main Repository](https://github.com/yfedoseev/pdf_oxide)** — Rust core, CLI, MCP server, all bindings
+- **[Performance Benchmarks](https://pdf.oxide.fyi/docs/performance)** — Full benchmark methodology and results
+- **[GitHub Issues](https://github.com/yfedoseev/pdf_oxide/issues)** — Bug reports and feature requests
+
+## Use Cases
+
+- **RAG / LLM pipelines** — Convert PDFs to clean Markdown for retrieval-augmented generation with LangChain.js, LlamaIndex.js, or any framework
+- **Document processing at scale** — Extract text, images, and metadata from thousands of PDFs in seconds
+- **Server-side PDF rendering** — Extract structured content for search indexing, archival, or transformation pipelines
+- **PDF generation** — Create invoices, reports, certificates, and templated documents programmatically
+- **PyMuPDF alternative** — MIT licensed, 5× faster, no AGPL restrictions, no Python required
+
+## Why I built this
+
+I needed PyMuPDF's speed without its AGPL license, and I needed it in more than one language. Nothing existed that ticked all three boxes — fast, MIT, multi-language — so I wrote it. The Rust core is what does the real work; the bindings for Python, Go, JS/TS, C#, and WASM are thin shells around the same code, so a bug fix in one lands in all of them. It now passes 100% of the veraPDF + Mozilla pdf.js + DARPA SafeDocs test corpora (3,830 PDFs) on every platform I've tested.
+
+If it's useful to you, a star on GitHub genuinely helps. If something's broken or missing, [open an issue](https://github.com/yfedoseev/pdf_oxide/issues) — I read all of them.
+
+— Yury
+
+## License
+
+Dual-licensed under [MIT](https://github.com/yfedoseev/pdf_oxide/blob/main/LICENSE-MIT) or [Apache-2.0](https://github.com/yfedoseev/pdf_oxide/blob/main/LICENSE-APACHE) at your option. Unlike AGPL-licensed alternatives, pdf_oxide can be used freely in any project — commercial or open-source — with no copyleft restrictions.
+
+## Citation
+
+```bibtex
+@software{pdf_oxide,
+  title = {PDF Oxide: Fast PDF Toolkit for Rust, Python, Go, JavaScript, and C#},
+  author = {Yury Fedoseev},
+  year = {2025},
+  url = {https://github.com/yfedoseev/pdf_oxide}
+}
+```
+
+---
+
+**JavaScript** + **TypeScript** + **Rust core** | MIT / Apache-2.0 | 100% pass rate on 3,830 PDFs | 0.8ms mean | 5× faster than the industry leaders

package/binding.gyp

@@ -0,0 +1,35 @@
+{
+  "targets": [
+    {
+      "target_name": "pdf_oxide",
+      "sources": ["binding.cc"],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")"
+      ],
+      "dependencies": [
+        "<!(node -p \"require('node-addon-api').gyp\")"
+      ],
+      "cflags": ["-Wall", "-Wextra"],
+      "cflags_cc": ["-fexceptions"],
+      "xcode_settings": {
+        "GCC_ENABLE_CPP_EXCEPTIONS": "YES",
+        "CLANG_CXX_LIBRARY": "libc++"
+      },
+      "msvs_settings": {
+        "VCCLCompilerTool": {
+          "ExceptionHandling": 1
+        }
+      },
+      "libraries": ["-lpdf_oxide"],
+      "library_dirs": [
+        "<!@(pwd)/../lib"
+      ],
+      "link_settings": {
+        "libraries": ["-lpdf_oxide"],
+        "library_dirs": [
+          "<!@(pwd)/../lib"
+        ]
+      }
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "pdf-oxide",
+  "version": "0.3.24",
+  "type": "module",
+  "description": "High-performance PDF parsing and text extraction library with multi-language support",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "prebuild": "npm run compile:ts",
+    "build": "npm run compile:ts && node scripts/fix-esm-imports.js && node-gyp build",
+    "compile:ts": "tsc",
+    "typecheck": "tsc --noEmit",
+    "clean:ts": "rimraf lib/",
+    "clean": "npm run clean:ts && node-gyp clean",
+    "install": "npm run build",
+    "test": "node --test tests/smoke.test.mjs"
+  },
+  "files": [
+    "lib/",
+    "src/",
+    "binding.gyp",
+    "package.json",
+    "README.md"
+  ],
+  "keywords": [
+    "pdf",
+    "text-extraction",
+    "pdf-parsing",
+    "rust-ffi",
+    "native-binding"
+  ],
+  "author": "PDF Oxide Contributors",
+  "license": "MIT",
+  "homepage": "https://github.com/yfedoseev/pdf_oxide",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yfedoseev/pdf_oxide.git",
+    "directory": "nodejs"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "exports": {
+    ".": {
+      "import": "./lib/index.js",
+      "types": "./lib/index.d.ts"
+    },
+    "./builders": {
+      "import": "./lib/builders/index.js",
+      "types": "./lib/builders/index.d.ts"
+    },
+    "./managers": {
+      "import": "./lib/managers/index.js",
+      "types": "./lib/managers/index.d.ts"
+    },
+    "./errors": {
+      "import": "./lib/errors.js",
+      "types": "./lib/errors.d.ts"
+    }
+  },
+  "gypfile": true,
+  "binary": {
+    "module_name": "pdf_oxide",
+    "module_path": "./build/Release/",
+    "host": "https://github.com/releases/download/",
+    "remote_path": "./v{version}/{module_name}-v{version}-{node_abi}-{platform}-{arch}.tar.gz",
+    "package_name": "{module_name}-v{version}-{node_abi}-{platform}-{arch}.tar.gz"
+  },
+  "devDependencies": {
+    "@types/node": "^18.0.0",
+    "node-gyp": "^9.3.1",
+    "rimraf": "^5.0.0",
+    "typescript": "^5.3.0"
+  },
+  "dependencies": {
+    "node-addon-api": "^8.7.0"
+  }
+}

package/src/builders/annotation-builder.ts

@@ -0,0 +1,367 @@
+/**
+ * Builder for creating PDF annotations
+ *
+ * Configures annotation properties like content, appearance, author, and behavior.
+ *
+ * @example
+ * ```typescript
+ * import { AnnotationBuilder } from 'pdf_oxide';
+ *
+ * const annotation = AnnotationBuilder.create()
+ *   .type('highlight')
+ *   .content('Important section')
+ *   .author('Reviewer')
+ *   .color([1, 1, 0]) // Yellow
+ *   .build();
+ *
+ * pdf.addAnnotation(annotation);
+ * ```
+ */
+
+interface AnnotationBounds {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+export interface Annotation {
+  type: string;
+  content: string;
+  author?: string;
+  subject?: string;
+  color: number[];
+  opacity: number;
+  bounds?: AnnotationBounds;
+  creationDate: Date;
+  modificationDate: Date;
+  flags: number;
+  reply?: string;
+}
+
+export class AnnotationBuilder {
+  private _type: string = 'text';
+  private _content: string = '';
+  private _author?: string;
+  private _subject?: string;
+  private _color: number[] = [1, 0, 0]; // Default: red (RGB normalized 0-1)
+  private _opacity: number = 1.0;
+  private _bounds?: AnnotationBounds;
+  private _creationDate: Date = new Date();
+  private _modificationDate: Date = new Date();
+  private _flags: number = 0;
+  private _reply?: string;
+
+  /**
+   * Creates a new AnnotationBuilder instance
+   * @private
+   */
+  private constructor() {}
+
+  /**
+   * Creates a new AnnotationBuilder instance
+   * @returns New builder instance
+   */
+  static create(): AnnotationBuilder {
+    return new AnnotationBuilder();
+  }
+
+  /**
+   * Creates a text annotation (comment/note)
+   * @returns This builder for chaining
+   */
+  asText(): this {
+    this._type = 'text';
+    return this;
+  }
+
+  /**
+   * Creates a highlight annotation
+   * @returns This builder for chaining
+   */
+  asHighlight(): this {
+    this._type = 'highlight';
+    return this;
+  }
+
+  /**
+   * Creates an underline annotation
+   * @returns This builder for chaining
+   */
+  asUnderline(): this {
+    this._type = 'underline';
+    return this;
+  }
+
+  /**
+   * Creates a strikeout annotation
+   * @returns This builder for chaining
+   */
+  asStrikeout(): this {
+    this._type = 'strikeout';
+    return this;
+  }
+
+  /**
+   * Creates a squiggly (wavy underline) annotation
+   * @returns This builder for chaining
+   */
+  asSquiggly(): this {
+    this._type = 'squiggly';
+    return this;
+  }
+
+  /**
+   * Sets the annotation type
+   * @param type - Annotation type ('text', 'highlight', 'underline', 'strikeout', 'squiggly')
+   * @returns This builder for chaining
+   */
+  type(type: string): this {
+    const validTypes = ['text', 'highlight', 'underline', 'strikeout', 'squiggly', 'note'];
+    if (!validTypes.includes(type)) {
+      throw new Error(`Invalid annotation type. Must be one of: ${validTypes.join(', ')}`);
+    }
+    this._type = type;
+    return this;
+  }
+
+  /**
+   * Sets the annotation content/text
+   * @param content - The annotation content
+   * @returns This builder for chaining
+   */
+  content(content: string): this {
+    if (typeof content !== 'string') {
+      throw new Error('Content must be a string');
+    }
+    this._content = content;
+    return this;
+  }
+
+  /**
+   * Sets the author of the annotation
+   * @param author - The author name
+   * @returns This builder for chaining
+   */
+  author(author: string): this {
+    if (typeof author !== 'string') {
+      throw new Error('Author must be a string');
+    }
+    this._author = author.length > 0 ? author : undefined;
+    return this;
+  }
+
+  /**
+   * Sets the subject/title of the annotation
+   * @param subject - The annotation subject
+   * @returns This builder for chaining
+   */
+  subject(subject: string): this {
+    if (typeof subject !== 'string') {
+      throw new Error('Subject must be a string');
+    }
+    this._subject = subject.length > 0 ? subject : undefined;
+    return this;
+  }
+
+  /**
+   * Sets the color of the annotation (RGB, normalized 0-1)
+   * @param rgb - RGB color array [r, g, b] with values 0-1
+   * @returns This builder for chaining
+   *
+   * @example
+   * ```typescript
+   * builder.color([1, 1, 0]); // Yellow
+   * builder.color([1, 0, 0]); // Red
+   * builder.color([0, 1, 0]); // Green
+   * ```
+   */
+  color(rgb: number[]): this {
+    if (!Array.isArray(rgb) || rgb.length !== 3) {
+      throw new Error('Color must be an array of 3 RGB values [r, g, b]');
+    }
+    if (!rgb.every((c) => typeof c === 'number' && c >= 0 && c <= 1)) {
+      throw new Error('RGB values must be numbers between 0 and 1');
+    }
+    this._color = [...rgb];
+    return this;
+  }
+
+  /**
+   * Sets the color using common color names
+   * @param colorName - Color name (e.g., 'red', 'yellow', 'green', 'blue')
+   * @returns This builder for chaining
+   *
+   * @example
+   * ```typescript
+   * builder.colorName('yellow');
+   * builder.colorName('red');
+   * ```
+   */
+  colorName(colorName: string): this {
+    const colors: Record<string, number[]> = {
+      red: [1, 0, 0],
+      green: [0, 1, 0],
+      blue: [0, 0, 1],
+      yellow: [1, 1, 0],
+      cyan: [0, 1, 1],
+      magenta: [1, 0, 1],
+      white: [1, 1, 1],
+      black: [0, 0, 0],
+      gray: [0.5, 0.5, 0.5],
+      orange: [1, 0.5, 0],
+      purple: [0.5, 0, 0.5],
+    };
+
+    const lowerColorName = colorName.toLowerCase();
+    if (!colors[lowerColorName]) {
+      const available = Object.keys(colors).join(', ');
+      throw new Error(`Unknown color. Available colors: ${available}`);
+    }
+
+    this._color = [...colors[lowerColorName]];
+    return this;
+  }
+
+  /**
+   * Sets the opacity/transparency (0-1)
+   * @param opacity - Opacity value (0=transparent, 1=opaque)
+   * @returns This builder for chaining
+   */
+  opacity(opacity: number): this {
+    if (typeof opacity !== 'number' || opacity < 0 || opacity > 1) {
+      throw new Error('Opacity must be a number between 0 and 1');
+    }
+    this._opacity = opacity;
+    return this;
+  }
+
+  /**
+   * Sets the bounding box for the annotation
+   * @param bounds - Bounding box {x, y, width, height}
+   * @returns This builder for chaining
+   *
+   * @example
+   * ```typescript
+   * builder.bounds({x: 100, y: 200, width: 150, height: 30});
+   * ```
+   */
+  bounds(bounds: AnnotationBounds): this {
+    if (typeof bounds !== 'object' || bounds === null) {
+      throw new Error('Bounds must be an object');
+    }
+    const { x, y, width, height } = bounds;
+    if (![x, y, width, height].every((v) => typeof v === 'number' && v >= 0)) {
+      throw new Error('Bounds must have numeric x, y, width, height values >= 0');
+    }
+    this._bounds = { x, y, width, height };
+    return this;
+  }
+
+  /**
+   * Sets the creation date
+   * @param date - The creation date
+   * @returns This builder for chaining
+   */
+  creationDate(date: Date): this {
+    if (!(date instanceof Date)) {
+      throw new Error('creationDate must be a Date object');
+    }
+    this._creationDate = new Date(date);
+    return this;
+  }
+
+  /**
+   * Sets the modification date
+   * @param date - The modification date
+   * @returns This builder for chaining
+   */
+  modificationDate(date: Date): this {
+    if (!(date instanceof Date)) {
+      throw new Error('modificationDate must be a Date object');
+    }
+    this._modificationDate = new Date(date);
+    return this;
+  }
+
+  /**
+   * Sets the annotation to be printed
+   * @returns This builder for chaining
+   */
+  printable(): this {
+    this._flags |= 4; // Print flag
+    return this;
+  }
+
+  /**
+   * Sets the annotation to NOT be printed
+   * @returns This builder for chaining
+   */
+  notPrintable(): this {
+    this._flags &= ~4; // Clear print flag
+    return this;
+  }
+
+  /**
+   * Sets whether the annotation is locked (read-only)
+   * @param locked - Whether to lock the annotation
+   * @returns This builder for chaining
+   */
+  locked(locked: boolean): this {
+    if (typeof locked !== 'boolean') {
+      throw new Error('locked must be a boolean');
+    }
+    if (locked) {
+      this._flags |= 128; // Locked flag
+    } else {
+      this._flags &= ~128;
+    }
+    return this;
+  }
+
+  /**
+   * Sets a reply to this annotation
+   * @param replyContent - Content of the reply
+   * @returns This builder for chaining
+   */
+  reply(replyContent: string): this {
+    if (typeof replyContent !== 'string') {
+      throw new Error('Reply content must be a string');
+    }
+    this._reply = replyContent;
+    return this;
+  }
+
+  /**
+   * Builds and returns the annotation object
+   * @returns Immutable annotation object
+   */
+  build(): Annotation {
+    if (!this._bounds && this._type !== 'text') {
+      throw new Error(`Annotation type "${this._type}" requires bounds to be set`);
+    }
+
+    return {
+      type: this._type,
+      content: this._content,
+      author: this._author,
+      subject: this._subject,
+      color: [...this._color],
+      opacity: this._opacity,
+      bounds: this._bounds ? { ...this._bounds } : undefined,
+      creationDate: new Date(this._creationDate),
+      modificationDate: new Date(this._modificationDate),
+      flags: this._flags,
+      reply: this._reply,
+    };
+  }
+}
+
+/**
+ * Create a new AnnotationBuilder with static factory
+ * @deprecated Use AnnotationBuilder.create() instead
+ * @returns New builder instance
+ */
+export function createAnnotationBuilder(): AnnotationBuilder {
+  return AnnotationBuilder.create();
+}