Node.js / TypeScript
Last updated: 2026-06-29
The rustpdf package wraps the rust-pdf C core with idiomatic, chainable classes over Koffi (pure FFI, no node-gyp, no native build). It covers the whole product surface: vector graphics, embedded/subset fonts & Unicode text, paragraphs, images, PDF/A (1b–3a + A-4/4e/4f), tagged/accessible output, attachments, AcroForm fields, manipulation, text extraction, encryption and digital signatures. Ships with TypeScript types.
Document authors a new PDF; EditableDoc loads and manipulates an existing one. Each holds a native handle, so call close() when done to free it promptly.Installation
Install from npm. The native library (libpdf_ffi) ships as per-platform optional dependencies (@rustpdf/darwin-arm64, @rustpdf/linux-x64-gnu, @rustpdf/linux-arm64-gnu, @rustpdf/win32-x64-msvc): npm downloads only the one matching your OS/architecture, so there's nothing to compile and no node-gyp.
npm install rustpdfRequires Node.js 18+. Verify it loaded:
const rustpdf = require("rustpdf");
console.log(rustpdf.version()); // native library version@rustpdf/<platform> package is included for the deploy architecture: e.g. install on a Linux x64 host, or add it explicitly as an optionalDependency.Quick start
A one-page document with a filled rectangle, saved to disk:
const { Document } = require("rustpdf");
const doc = new Document(); // A4 by default
doc.addPage();
doc.setFillRgb(0.86, 0.20, 0.18);
doc.rect(72, 640, 200, 120); // x, y, width, height (points)
doc.fill();
doc.save("out.pdf");
doc.close();Most methods return the document, so calls chain:
const doc = new Document();
const font = doc.addFontFile("Roboto-Regular.ttf");
doc.addPage()
.setFillRgb(0.1, 0.1, 0.12)
.rect(0, 800, 595, 42).fill()
.showText(font, 24, 72, 740, "Olá, açúcar — café");
const data = doc.toBytes(); // a Node Buffer instead of a file
doc.close();TypeScript
The package ships type declarations (index.d.ts), so no @types are needed. Both require and ES-module import work.
import { Document, PdfaLevel, Align } from "rustpdf";
const doc = new Document();
doc.pdfa(PdfaLevel.A2a).setInfo({ title: "Report" });
const f = doc.addFontFile("Roboto-Regular.ttf");
doc.addPage().showText(f, 20, 72, 760, "Title", 1); // headingLevel 1 = H1
const bytes: Buffer = doc.toBytes();
doc.close();Licensing & activation
Basic generation (everything above) is always free. The corporate features (PDF/A, digital signatures/PAdES, encryption, accessibility) require an active license token. Without one, those calls throw PdfError and produce no output.
Activation needs no rebuild. Easiest is an environment variable, auto-activated the first time a corporate feature is used:
export RUSTPDF_LICENSE="010f0000…" # the token we email you
# or point at a file:
export RUSTPDF_LICENSE_FILE=/etc/rustpdf/license.txtOr activate explicitly in code:
const rustpdf = require("rustpdf");
rustpdf.activateLicense(token); // throws PdfError if forged / expired / malformedCoordinate system
- Units are points (1 pt = 1/72 inch). A4 is
595 × 842, US Letter612 × 792. - The origin
(0, 0)is the bottom-left corner;ygrows upward. - For text,
(x, y)is the baseline of the first glyph. - Drawing/text always targets the most recently added page.
Threading & concurrency
Every native call is synchronous (it blocks the event loop for its duration) and the core is Send but not Sync: a single handle must never be touched by two threads at once.
- Documents are independent. Each
Document/EditableDocshares no state, so they're safe to build acrossworker_threads, one handle per worker. - Don't share a live handle between workers; give each its own.
- Errors are per-thread. The native last-error is thread-local, so a failure in one worker never clobbers another's, and
PdfErrorsurfaces on the calling side. - License is process-global.
activateLicense(or the env var) applies to every worker; activate once at startup. - Heavy jobs: generating a large PDF on the main thread will stall other requests, so offload to a worker.
// worker.js
const { parentPort, workerData } = require("worker_threads");
const { Document } = require("rustpdf");
const doc = new Document(); // one document per worker
doc.addPage().setFillRgb(0.1, 0.1, 0.12).rect(72, 700, 200, 80).fill();
parentPort.postMessage(doc.toBytes());
doc.close();Authoring: create & save
new Document() freeCreates an empty document (A4 default page size). Call close() to free the native handle.
| Method | Description |
|---|---|
addPage(size?) | Append a page. size is an optional { width, height } object in points. |
setDefaultSize(w, h) | Default size for subsequently added pages. |
setVersion(v) | Set the PDF header version (0 → 1.4, 1 → 1.5, 2 → 1.7, 3 → 2.0). |
pageCount | Property: number of pages so far. |
toBytes() | Render the document to a Buffer. |
save(path) | Render and write to a file. |
close() | Free the native handle. |
Pages & vector graphics
Graphics state and path operators mirror PDF's content-stream model. Colors are RGB in 0.0–1.0.
| Method | Description |
|---|---|
setFillRgb(r, g, b) | Fill color. |
setStrokeRgb(r, g, b) | Stroke color. |
setLineWidth(w) | Stroke width in points. |
rect(x, y, w, h) | Add a rectangle subpath. |
fill() | Fill the current path with the fill color. |
stroke() | Stroke the current path with the stroke color. |
const doc = new Document();
doc.addPage();
doc.setStrokeRgb(0.10, 0.45, 0.90).setLineWidth(3);
doc.rect(72, 600, 300, 160).stroke();
doc.setFillRgb(0.95, 0.77, 0.06);
doc.rect(120, 640, 120, 80).fill();
doc.save("shapes.pdf");
doc.close();Fonts & text
Fonts are embedded and subsetted, with HarfBuzz-quality shaping, kerning and full Unicode (Type0/CIDFontType2 with ToUnicode, so text extracts and copies correctly, provided the embedded font covers those characters). Register a font once, then reference it by its integer id.
addFontFile(path) → number addFont(data: Buffer) → numbershowText(font, size, x, y, text, headingLevel?)headingLevel (1–6) tags the run as H1–H6 in an accessible document (see Accessibility); leave it out (or 0) for ordinary text.
const doc = new Document();
const regular = doc.addFontFile("Roboto-Regular.ttf");
// …or from bytes you already have in memory:
// const regular = doc.addFont(fs.readFileSync("Roboto-Regular.ttf"));
doc.addPage();
doc.showText(regular, 28, 72, 760, "Invoice #1024");
doc.showText(regular, 12, 72, 720, "日本語 · Ελληνικά · العربية");
doc.save("text.pdf");
doc.close();\0) character — it truncates the string at the FFI boundary, silently dropping everything after the NUL. This applies to shown text, metadata and field names.Paragraphs
The paragraph layer wraps, aligns and justifies text inside a fixed width (greedy line breaking using shaped glyph widths).
paragraph(font, size, x, y, width, text, align?)const { Document, Align } = require("rustpdf");
const intro =
"A long paragraph that wraps to the given width and is justified " +
"automatically; extra space is distributed between words.";
const doc = new Document();
const f = doc.addFontFile("Roboto-Regular.ttf");
doc.addPage();
doc.paragraph(f, 12, 72, 700, 451, intro, Align.Justify);
doc.save("paragraph.pdf");
doc.close();See the Align enum for the alignment options.
Images
JPEGs are embedded verbatim (DCTDecode, no re-encode). PNGs are decoded and re-encoded (FlateDecode); alpha becomes an /SMask, palette becomes an Indexed color space. Register an image once, draw it many times.
| Method | Description |
|---|---|
addImageFile(path) → number | Load JPEG/PNG from a file; returns the image id. |
addImagePng(data: Buffer) → number | Register a PNG from memory. |
addImageJpeg(data: Buffer) → number | Register a JPEG from memory. |
drawImage(image, x, y, w, h) | Draw at (x, y) scaled to w × h points. |
figure(image, x, y, w, h, alt) | Draw as a tagged /Figure with alt text (accessibility). |
const doc = new Document();
const logo = doc.addImageFile("logo.png");
doc.addPage();
doc.drawImage(logo, 72, 680, 160, 90);
doc.save("with_image.pdf");
doc.close();PDF/A licensed
Produce archival-grade output. pdfa() defaults to A-2b; pass a PdfaLevel for a specific level. An embedded sRGB ICC profile, output intent, XMP metadata and document /ID are added automatically; A-1b also forces PDF 1.4 and emits a /CIDSet, and A-4 (ISO 19005-4) is based on PDF 2.0.
pdfa(level?)const { Document, PdfaLevel } = require("rustpdf");
const doc = new Document();
doc.pdfa(PdfaLevel.A2b).setInfo({ title: "Q3 Report", author: "Acme Inc." });
const f = doc.addFontFile("Roboto-Regular.ttf");
doc.addPage();
doc.showText(f, 20, 72, 760, "Archival report");
doc.save("report_pdfa.pdf"); // throws PdfError without a license granting PDF/A
doc.close();setInfo({ title: … }).Accessibility (Tagged PDF / PDF/UA) licensed
tagged() builds a logical structure tree (PDF/UA-1). Combine with pdfa(PdfaLevel.A2a) for archival and accessible output. Use headingLevel on showText for H1–H6, and figure(..., alt) for described images.
tagged() alone is not PDF/UA-1 conformant. By itself it builds the structure tree but does not emit the XMP /Metadata stream that PDF/UA-1 requires, so veraPDF fails clause 7.1 ("Catalog … shall contain the Metadata key"). For output that validates as PDF/UA-1, pair it with pdfa(PdfaLevel.A2a): doc.pdfa(PdfaLevel.A2a).tagged() emits the XMP and passes both verapdf -f 2a and verapdf -f ua1.tagged()const { Document, PdfaLevel } = require("rustpdf");
const doc = new Document();
doc.pdfa(PdfaLevel.A2a).tagged().setInfo({ title: "Accessible report" });
const f = doc.addFontFile("Roboto-Regular.ttf");
doc.addPage();
doc.showText(f, 26, 72, 760, "Annual report", 1); // H1
doc.showText(f, 14, 72, 720, "Overview", 2); // H2
doc.showText(f, 11, 72, 690, "Body paragraph of the section…");
const chart = doc.addImageFile("chart.png");
doc.figure(chart, 72, 520, 300, 150, "Revenue grew 18% year over year");
doc.save("accessible.pdf");
doc.close();figure() only produces an accessible, alt-texted figure inside a tagged/accessible document; on a plain document the alt text has no effect.Attachments (PDF/A-3) licensed
PDF/A-3 allows embedding arbitrary source files (e.g. the XML behind an e-invoice). Each attachment carries a MIME type and an AFRelationship.
attachFile(name, mime, data, relationship?, description?)const fs = require("fs");
const { Document, PdfaLevel, AFRelationship } = require("rustpdf");
const xml = fs.readFileSync("invoice.xml");
const doc = new Document();
doc.pdfa(PdfaLevel.A3b).setInfo({ title: "E-invoice 1024" });
const f = doc.addFontFile("Roboto-Regular.ttf");
doc.addPage();
doc.showText(f, 18, 72, 760, "Invoice 1024");
doc.attachFile("invoice.xml", "text/xml", xml,
AFRelationship.Source, "Structured invoice data");
doc.save("einvoice.pdf");
doc.close();attachFile before serializing.attachFile itself. The licensed badge above reflects the PDF/A-3 workflow shown here. Calling attachFile on a plain (non-PDF/A) document does not require a licence: it succeeds and produces a valid PDF with an /EmbeddedFile. The licence is enforced only when you also request a PDF/A level, which is what makes the attachment archival.ZUGFeRD / Factur-X e-invoices licensed
Turn the document into a ZUGFeRD / Factur-X electronic invoice: the embedded XML (the Cross-Industry Invoice) is attached as factur-x.xml, the file is marked PDF/A-3, and the Factur-X identification is written into the XMP metadata. The visible PDF is the human-readable invoice; the embedded XML is its machine-readable twin. Validates as PDF/A-3 + Factur-X under veraPDF.
facturx(xml: Buffer, profile?)const fs = require("fs");
const { Document, FacturxProfile } = require("rustpdf");
const xml = fs.readFileSync("factur-x.xml"); // your Cross-Industry Invoice XML
const doc = new Document();
doc.setInfo({ title: "Invoice INV-2026-001" });
const f = doc.addFontFile("Roboto-Regular.ttf");
doc.addPage();
doc.showText(f, 18, 72, 760, "Invoice INV-2026-001");
doc.facturx(xml, FacturxProfile.EN16931);
doc.save("einvoice.pdf"); // PDF/A-3 + Factur-X; needs a PDF/A license
doc.close();See the FacturxProfile enum for the conformance levels (Minimum to Extended).
AcroForm fields
Build interactive forms with generated appearance streams (no NeedAppearances). Rectangles are [x0, y0, x1, y1] arrays; page is a 0-based page index. Dotted names ("a.b.c") create hierarchical fields.
| Method | Description |
|---|---|
textField(name, page, rect, value?, size?) | Text input (size=0 → auto font size). |
checkbox(name, page, rect, checked) | Checkbox. |
dropdown(name, page, rect, options, selected?, size?) | Combo box from an array of strings. |
radioGroup(name, page, buttons, selected?) | buttons = array of { rect, export } objects. |
const doc = new Document();
doc.addPage();
doc.textField("applicant.name", 0, [72, 700, 320, 720], "");
doc.checkbox("agree", 0, [72, 660, 88, 676], false);
doc.dropdown("plan", 0, [72, 620, 240, 640],
["Starter", "Pro", "Enterprise"], 1);
doc.radioGroup("billing", 0, [
{ rect: [72, 580, 88, 596], export: "monthly" },
{ rect: [140, 580, 156, 596], export: "annual" },
], 1);
doc.save("form.pdf");
doc.close();Fill and flatten fields later with EditableDoc.
page does not exist, or whose rectangle is degenerate (x1 < x0 or zero area), is rejected when the document is serialized: toBytes()/save() throw PdfError ("targets page index N…" / "degenerate rectangle…") instead of producing an invisible, never-appearing widget. Pass a 0-based page index that exists and a rectangle with x1 > x0 and y1 > y0.Hyperlinks free
Add clickable link rectangles to the current page: a web link opens a URL; an internal link jumps to another page (optionally scrolling so a given top y-coordinate sits at the top of the view).
linkUri(rect, uri) linkToPage(rect, pageIndex, top?)const doc = new Document();
const f = doc.addFontFile("Roboto-Regular.ttf");
doc.addPage();
doc.showText(f, 14, 72, 760, "Visit rustpdf.dev (see page 2)");
doc.linkUri([72, 756, 320, 776], "https://rustpdf.dev/"); // web link
doc.linkToPage([330, 756, 430, 776], 1, 800); // jump to page 2
doc.addPage();
doc.save("links.pdf");
doc.close();Rectangles are [x0, y0, x1, y1] in points; pageIndex is 0-based.
Bookmarks / outline free
Build a navigable document outline. A Bookmark has a title, a target page and an optional top; nest children with .child(...). A document with bookmarks opens with the outline pane shown.
new Bookmark(title, page, top?) .child(bookmark) addBookmark(bookmark)const { Document, Bookmark } = require("rustpdf");
const doc = new Document();
const f = doc.addFontFile("Roboto-Regular.ttf");
for (let i = 0; i < 3; i++) doc.addPage();
const ch1 = new Bookmark("Chapter 1", 0, 820);
ch1.child(new Bookmark("Section 1.1", 1));
ch1.child(new Bookmark("Section 1.2", 2));
doc.addBookmark(ch1);
doc.addBookmark(new Bookmark("Chapter 2", 2));
doc.save("outline.pdf");
doc.close();.child(...) returns the child it appended, so you can keep building deeper nesting from it.
Metadata
setInfo({ title?, author?, subject?, keywords?, creator? })Sets the document information dictionary (and, for PDF/A, the matching XMP). Pass only the fields you need.
doc.setInfo({ title: "Q3 Report", author: "Acme Inc.",
subject: "Quarterly results", keywords: "finance, q3" });Manipulation: load an existing PDF
EditableDoc parses an existing document (classic & xref streams, object streams, all standard filters, RC4/AES decryption) into an editable model. Pages are a flat list; the page tree is rebuilt on output.
EditableDoc.load(data: Buffer, password?)EditableDoc.loadFile(path, password?)const { EditableDoc } = require("rustpdf");
const ed = EditableDoc.loadFile("in.pdf");
console.log(ed.pageCount);
ed.close();
// encrypted input:
const sec = EditableDoc.loadFile("secured.pdf", "user-or-owner-pw");
sec.save("plain.pdf");
sec.close();load does not throw in that case. Serializing a zero-page document throws PdfError ("document has no pages") instead of writing an invalid file, but check pageCount > 0 after loading untrusted input before relying on it.Pages: merge, split, reorder, rotate
| Method | Description |
|---|---|
merge(other) | Append all pages of another EditableDoc (objects renumbered & remapped). |
rotatePage(index, degrees) | Rotate one page (90 / 180 / 270). |
deletePage(index) | Remove a page. |
reorderPages(order) | Reorder with a full permutation array of indices. |
extractPages(indices) → EditableDoc | New document containing just those pages. |
pageCount | Property: current page count. |
const a = EditableDoc.loadFile("a.pdf");
const b = EditableDoc.loadFile("b.pdf");
a.merge(b); // a now has a's pages followed by b's
a.rotatePage(0, 90);
a.reorderPages([...Array(a.pageCount).keys()].reverse());
a.save("merged.pdf");
b.close();
const subset = a.extractPages([0, 2]); // pages 1 and 3
subset.save("subset.pdf");
subset.close();
a.close();reorderPages requires a true permutation of every page index (each used exactly once); an invalid argument — wrong length, a repeated index, or out-of-range — is rejected and leaves the page order unchanged — the call is a silent no-op that raises no error, so an invalid reorder cannot be detected from a return value.Metadata, overlay & form fill
| Method | Description |
|---|---|
setInfo(key, value) | Set one info entry (e.g. "Title"). |
getInfo(key) → string | Read an info entry. |
setXmp(xml: Buffer) | Replace the XMP metadata stream. |
overlayPage(index, content: Buffer) | Overlay a content-stream fragment onto a page (stamps/watermarks). |
fillTextField(name, value) → boolean | Fill an AcroForm text field; returns whether it was found. |
const ed = EditableDoc.loadFile("form.pdf");
ed.setInfo("Title", "Filled form");
const found = ed.fillTextField("applicant.name", "Jane Doe");
console.log("filled:", found, "| title:", ed.getInfo("Title"));
ed.save("filled.pdf");
ed.close();Form fill & flatten free
Fill the fields of an existing AcroForm and (optionally) flatten them: filling generates a fresh appearance stream (no NeedAppearances), and flattening bakes every widget's appearance into the page content and removes the interactive form entirely.
| Method | Description |
|---|---|
fieldNames() → string[] | Fully-qualified names of every terminal field. |
fillTextField(name, value) → boolean | Set a text (or text-style choice) field; returns whether it matched. |
setCheckbox(name, checked?) → boolean | Check/uncheck a checkbox (defaults to true). |
setRadio(name, exportValue) → boolean | Select a radio button by its export value. |
setChoice(name, value) → boolean | Set a dropdown / list-box value. |
flattenForms() | Bake all fields into static content and drop the /AcroForm. |
const { EditableDoc } = require("rustpdf");
const ed = EditableDoc.loadFile("form.pdf");
console.log(ed.fieldNames()); // ['applicant.name', 'agree', 'plan', ...]
ed.fillTextField("applicant.name", "Jane Doe");
ed.setCheckbox("agree", true);
ed.setRadio("billing", "annual");
ed.setChoice("plan", "Pro");
ed.flattenForms(); // optional: make it non-editable
ed.save("filled.pdf");
ed.close();Watermarks free
Stamp a diagonal text watermark or a centered image watermark across every page, drawn semi-transparently over the existing content. Text uses the standard Helvetica font, so keep it to WinAnsi (Latin-1) for stamps like "CONFIDENTIAL".
watermarkText(text, { size?, color?, opacity?, rotationDeg? }?)watermarkImageFile(path, width, height, opacity?)const ed = EditableDoc.loadFile("report.pdf");
ed.watermarkText("CONFIDENTIAL", { opacity: 0.25, rotationDeg: 45 });
ed.save("stamped.pdf");
ed.close();Defaults: size: 64, color: [0.5, 0.5, 0.5], opacity: 0.30, rotationDeg: 45.
Redaction licensed
True redaction: the text and graphics whose origin falls inside a rectangle are removed from the content stream (not just covered), so the data is gone from the file and is no longer extractable. Opaque black boxes are then painted over the regions.
redact(pageIndex, rects) → booleanconst ed = EditableDoc.loadFile("statement.pdf");
// rects = array of [x0, y0, x1, y1] on that page
ed.redact(0, [[60, 590, 400, 620], [60, 540, 400, 570]]);
ed.save("redacted.pdf"); // throws PdfError without a license granting redaction
ed.close();extractText on the output no longer returns it.Convert to PDF/A licensed
Convert an existing PDF to archival PDF/A (a basic profile: A-1b, A-2b or A-3b). An sRGB output intent, PDF/A XMP metadata (synced with /Info) and a document /ID are added. Fails if any font is not embedded (PDF/A requires every font embedded) or a level-A profile is requested.
convertToPdfa(level?)const { EditableDoc, PdfaLevel } = require("rustpdf");
const ed = EditableDoc.loadFile("in.pdf");
ed.convertToPdfa(PdfaLevel.A2b); // throws PdfError if fonts aren't embedded
ed.save("archival.pdf"); // veraPDF: PDF/A-2b compliant
ed.close();Optimize & compact
| Method | Description |
|---|---|
optimize() | Drop unreferenced objects, Flate-compress uncompressed streams, dedupe identical objects. |
compact(on?) | Pack objects into object streams + emit a cross-reference stream. |
const ed = EditableDoc.loadFile("big.pdf");
ed.optimize().compact(true);
ed.save("small.pdf");
ed.close();Encryption licensed
Apply standard-handler encryption at output. AES-256 (V5/R6) uses OS-CSPRNG keys/IVs.
encrypt({ method?, user?, owner?, readOnly? })const { EditableDoc, Encryption } = require("rustpdf");
const ed = EditableDoc.loadFile("in.pdf");
ed.encrypt({ user: "", owner: "owner-secret",
method: Encryption.Aes256, readOnly: true });
ed.save("secured.pdf"); // throws PdfError without an Encryption license
ed.close();See the Encryption enum for RC4 / AES-128 / AES-256.
Output & incremental update
| Method | Description |
|---|---|
toBytes() → Buffer | Serialize the manipulated document. |
save(path) | Serialize to a file. |
toBytesIncremental(original: Buffer) → Buffer | Append only changes to the original bytes (signature-safe, non-destructive). |
const fs = require("fs");
const original = fs.readFileSync("in.pdf");
const ed = EditableDoc.load(original);
ed.setInfo("Subject", "reviewed");
const incremental = ed.toBytesIncremental(original); // original bytes preserved verbatim
fs.writeFileSync("reviewed.pdf", incremental);
ed.close();Digital signatures licensed
Sign a PDF with a PKCS#7 detached signature via an incremental update (the original bytes are preserved). Keys and certificates are passed as DER Buffers. pades: true switches to PAdES-B-B.
rustpdf.sign(pdf, keyDer, certDer, { reason?, location?, name?, pades? }?) → Bufferconst fs = require("fs");
const rustpdf = require("rustpdf");
const pdf = fs.readFileSync("contract.pdf");
const keyDer = fs.readFileSync("signing-key.pkcs8.der"); // PKCS#8 private key (DER)
const certDer = fs.readFileSync("signing-cert.der"); // X.509 certificate (DER)
const signed = rustpdf.sign(pdf, keyDer, certDer, {
reason: "Approved", location: "New York",
name: "Jane Doe", pades: true,
});
fs.writeFileSync("contract.signed.pdf", signed);
// Verify in a shell: pdfsig contract.signed.pdf → "Signature is Valid."Timestamp & DSS (PAdES LTV) licensed
Build long-term-validation signatures offline. addDss appends a Document Security Store (/DSS with certs/CRLs, PAdES-B-LT); timestamp appends an RFC 3161 document timestamp (/DocTimeStamp, PAdES-B-LTA).
rustpdf.addDss(pdf, certs?, crls?) → Bufferrustpdf.timestamp(pdf, tsaKeyDer, tsaCertDer, date?) → Bufferconst signed = fs.readFileSync("contract.signed.pdf");
// B-LT: embed validation material (caller supplies DER certs/CRLs)
const lt = rustpdf.addDss(signed, [certDer], [crlDer]);
// B-LTA: add a document timestamp signed by a TSA key/cert
const lta = rustpdf.timestamp(lt, tsaKeyDer, tsaCertDer);
fs.writeFileSync("contract.lta.pdf", lta);Validate signatures licensed
Validate every signature in a PDF: each report recomputes the /ByteRange digest, parses the CMS, and checks that the cryptographic signature is valid, that the messageDigest matches the covered bytes, and whether the signature covers the whole document.
rustpdf.verifySignatures(data: Buffer) → object[]Each entry has field_name, sub_filter, signer, covers_whole_document, digest_valid, signature_valid, is_valid and byte_range. field_name and signer may be null when absent. An empty array means the document is unsigned. Signature validation is a licensed feature: this call requires an active license (signatures) even when the document is unsigned — it is not available on the free tier.
const rustpdf = require("rustpdf");
const data = fs.readFileSync("contract.signed.pdf");
for (const sig of rustpdf.verifySignatures(data)) {
console.log(sig.signer, "valid:", sig.is_valid,
"covers whole doc:", sig.covers_whole_document);
}Text & image extraction
Extract a document's text, mapping shown glyph codes back to Unicode through each font's ToUnicode map, with space/line inference. Raster images can be pulled out too: JPEGs are written verbatim as .jpg, everything else as .png. The output directory is created automatically if it does not already exist.
rustpdf.extractText(data: Buffer) → string freerustpdf.extractImagesToDir(data: Buffer, outDir: string) → number freeconst data = fs.readFileSync("report.pdf");
console.log(rustpdf.extractText(data));
const n = rustpdf.extractImagesToDir(data, "out_images/"); // returns how many were written
console.log(`wrote ${n} image(s)`);Render a page to an image licensed
Rasterize a page to a PNG image. A native Rust renderer (built on tiny-skia, with no headless browser) interprets the page content stream, painting real glyph outlines, vector graphics, images, color and transparency. Page rendering is a Pro feature; page_count is free.
renderPageToPng(pdf, page = 0, dpi = 150.0) → Buffer licensedpageCount(pdf) → number freeconst { renderPageToPng, pageCount } = require("rustpdf");
const fs = require("fs");
const data = fs.readFileSync("report.pdf");
console.log(`${pageCount(data)} page(s)`);
fs.writeFileSync("page1.png", renderPageToPng(data, 0, 150.0));Enums
PdfaLevel
| Value | Level |
|---|---|
PdfaLevel.A1b | PDF/A-1b (basic, PDF 1.4) |
PdfaLevel.A2b | PDF/A-2b (basic): default of pdfa() |
PdfaLevel.A2a | PDF/A-2a (accessible: pair with tagged()) |
PdfaLevel.A3b | PDF/A-3b (basic, allows attachments) |
PdfaLevel.A3a | PDF/A-3a (accessible + attachments) |
PdfaLevel.A4 | PDF/A-4 (ISO 19005-4, based on PDF 2.0) |
PdfaLevel.A4e | PDF/A-4e (engineering) |
PdfaLevel.A4f | PDF/A-4f (requires at least one embedded file) |
Align
| Value | Meaning |
|---|---|
Align.Left | Left-aligned (default) |
Align.Right | Right-aligned |
Align.Center | Centered |
Align.Justify | Justified (space distributed between words) |
AFRelationship
| Value | Meaning |
|---|---|
AFRelationship.Source | Source data for the document (e.g. the invoice XML) |
AFRelationship.Data | Data used to derive the visual content |
AFRelationship.Alternative | Alternative representation |
AFRelationship.Supplement | Supplementary material |
AFRelationship.Unspecified | Unspecified relationship |
Encryption
| Value | Cipher |
|---|---|
Encryption.Rc4 | RC4 (legacy) |
Encryption.Aes128 | AES-128 |
Encryption.Aes256 | AES-256 (V5/R6): recommended |
FacturxProfile
| Value | Conformance level |
|---|---|
FacturxProfile.Minimum | Minimal header data only |
FacturxProfile.BasicWL | Basic, without line items |
FacturxProfile.Basic | Basic, with line items |
FacturxProfile.EN16931 | EN 16931 (Comfort): the interoperable core, default |
FacturxProfile.Extended | EN 16931 plus extensions |
Error handling
Every failing native call throws PdfError (an Error) carrying the status (PdfStatus) code and the library's last-error message. License failures (missing/expired/forged token, or a feature the token doesn't grant) surface here too. Token activation failures carry the dedicated license status code (12); a gated build, sign or encrypt call instead reports that operation’s own status (for example Serialize = 4 or Sign = 10) with the same “requires a valid license” message.
const { Document, PdfError } = require("rustpdf");
try {
const doc = new Document();
doc.pdfa().setInfo({ title: "x" });
doc.addPage();
doc.save("out.pdf");
doc.close();
} catch (e) {
if (e instanceof PdfError) {
console.error("failed:", e.status, e.message);
// e.g. PdfStatus=4 (Serialize): feature 'pdfa' requires a valid license
}
}Utilities
| Function | Description |
|---|---|
rustpdf.version() → string | Native library version string. |
rustpdf.activateLicense(token) | Activate a license token (throws on invalid/expired). |