pdf-oxide-fips 0.3.47

package/LICENSE-APACHE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/LICENSE-MIT

@@ -0,0 +1,25 @@
+Copyright (c) 2025-present Yury Fedoseev
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

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/lib/builders/annotation-builder.d.ts

@@ -0,0 +1,198 @@
+/**
+ * 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 declare class AnnotationBuilder {
+    private _type;
+    private _content;
+    private _author?;
+    private _subject?;
+    private _color;
+    private _opacity;
+    private _bounds?;
+    private _creationDate;
+    private _modificationDate;
+    private _flags;
+    private _reply?;
+    /**
+     * Creates a new AnnotationBuilder instance
+     * @private
+     */
+    private constructor();
+    /**
+     * Creates a new AnnotationBuilder instance
+     * @returns New builder instance
+     */
+    static create(): AnnotationBuilder;
+    /**
+     * Creates a text annotation (comment/note)
+     * @returns This builder for chaining
+     */
+    asText(): this;
+    /**
+     * Creates a highlight annotation
+     * @returns This builder for chaining
+     */
+    asHighlight(): this;
+    /**
+     * Creates an underline annotation
+     * @returns This builder for chaining
+     */
+    asUnderline(): this;
+    /**
+     * Creates a strikeout annotation
+     * @returns This builder for chaining
+     */
+    asStrikeout(): this;
+    /**
+     * Creates a squiggly (wavy underline) annotation
+     * @returns This builder for chaining
+     */
+    asSquiggly(): this;
+    /**
+     * Sets the annotation type
+     * @param type - Annotation type ('text', 'highlight', 'underline', 'strikeout', 'squiggly')
+     * @returns This builder for chaining
+     */
+    type(type: string): this;
+    /**
+     * Sets the annotation content/text
+     * @param content - The annotation content
+     * @returns This builder for chaining
+     */
+    content(content: string): this;
+    /**
+     * Sets the author of the annotation
+     * @param author - The author name
+     * @returns This builder for chaining
+     */
+    author(author: string): this;
+    /**
+     * Sets the subject/title of the annotation
+     * @param subject - The annotation subject
+     * @returns This builder for chaining
+     */
+    subject(subject: string): 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;
+    /**
+     * 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;
+    /**
+     * Sets the opacity/transparency (0-1)
+     * @param opacity - Opacity value (0=transparent, 1=opaque)
+     * @returns This builder for chaining
+     */
+    opacity(opacity: number): 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;
+    /**
+     * Sets the creation date
+     * @param date - The creation date
+     * @returns This builder for chaining
+     */
+    creationDate(date: Date): this;
+    /**
+     * Sets the modification date
+     * @param date - The modification date
+     * @returns This builder for chaining
+     */
+    modificationDate(date: Date): this;
+    /**
+     * Sets the annotation to be printed
+     * @returns This builder for chaining
+     */
+    printable(): this;
+    /**
+     * Sets the annotation to NOT be printed
+     * @returns This builder for chaining
+     */
+    notPrintable(): 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;
+    /**
+     * Sets a reply to this annotation
+     * @param replyContent - Content of the reply
+     * @returns This builder for chaining
+     */
+    reply(replyContent: string): this;
+    /**
+     * Builds and returns the annotation object
+     * @returns Immutable annotation object
+     */
+    build(): Annotation;
+}
+/**
+ * Create a new AnnotationBuilder with static factory
+ * @deprecated Use AnnotationBuilder.create() instead
+ * @returns New builder instance
+ */
+export declare function createAnnotationBuilder(): AnnotationBuilder;
+export {};