@jackgreen2018/pdf-engine 1.0.19 → 1.0.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Jack Green
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,172 +1,60 @@
1
- > Scope: full engine (see [SCOPE.md](./SCOPE.md)).
1
+ # @jackgreen2018/pdf-engine
2
2
 
3
- # pdf-engine — Rust/WASM PDF Processing Library
3
+ Rust/WASM PDF library for merge, split, optimize and info operations.
4
4
 
5
- [![npm version](https://img.shields.io/npm/v/@jackgreen2018/pdf-engine)](https://www.npmjs.com/package/@jackgreen2018/pdf-engine)
6
- [![npm downloads](https://img.shields.io/npm/dt/@jackgreen2018/pdf-engine)](https://www.npmjs.com/package/@jackgreen2018/pdf-engine)
7
- [![License: MIT](https://img.shields.io/github/license/jackgreen/pdf-engine)](LICENSE)
8
- [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=GitHub%20Sponsors&color=ea4aaa&logo=github-sponsors)](https://github.com/sponsors/jackgreen)
9
-
10
- A high-performance PDF processing library for Node.js and the browser. Built with Rust + WebAssembly. Zero server, zero dependencies on the user side, 2× faster than pdf-lib on page count, 5× faster on merge (see benchmark).
11
-
12
- ## Features
13
-
14
- - **Page Count**: Quickly determine the number of pages in a PDF using a proper PDF parser
15
- - **Text Extraction**: Extract text content from PDF files with accurate parsing
16
- - **PDF Merge**: Combine multiple PDFs into a single file
17
- - **PDF Split**: Split PDFs by page range
18
- - **Privacy**: All processing happens in the user's browser or local environment
19
- - **Performance**: Rust-powered with WASM for maximum speed
20
-
21
- ## Installation
5
+ ## Install
22
6
 
23
7
  ```bash
24
8
  npm install @jackgreen2018/pdf-engine
25
9
  ```
26
10
 
27
- Or build from source:
28
-
29
- ```bash
30
- git clone <this-repo>
31
- cd pdf-engine
32
- npm install
33
- npm run build
34
- ```
35
-
36
11
  ## Usage
37
12
 
38
- ### Browser
39
-
40
13
  ```javascript
41
- import pdfEngine from '@jackgreen2018/pdf-engine';
14
+ const { init, merge_pdfs, split_pdf, get_page_count, get_pdf_info, optimize_pdf } = require('@jackgreen2018/pdf-engine');
42
15
 
43
- // Initialize the engine
44
- await pdfEngine.init();
16
+ async function example() {
17
+ await init();
45
18
 
46
- // Get page count of a PDF file
47
- const file = document.querySelector('input[type="file"]').files[0];
48
- const arrayBuffer = await file.arrayBuffer();
49
- const pageCount = await pdfEngine.getPageCount(new Uint8Array(arrayBuffer));
50
- console.log(`Pages: ${pageCount}`);
19
+ // Merge two PDFs
20
+ const merged = merge_pdfs(pdfBuffer1, pdfBuffer2);
51
21
 
52
- // Extract text from a PDF
53
- const text = await pdfEngine.extractText(new Uint8Array(arrayBuffer));
54
- console.log(text);
22
+ // Split a PDF (extract pages 1, 3, 5)
23
+ const split = split_pdf(inputPdf, [1, 3, 5]);
55
24
 
56
- // Merge multiple PDFs
57
- const mergedPdf = await pdfEngine.merge([pdf1Buffer, pdf2Buffer, pdf3Buffer]);
25
+ // Get page count
26
+ const count = get_page_count(pdfBuffer);
58
27
 
59
- // Split a PDF by page numbers
60
- const pagesToExtract = [1, 3, 5];
61
- const splitParts = await pdfEngine.split(new Uint8Array(arrayBuffer), pagesToExtract);
62
- ```
63
-
64
- ### Node.js
28
+ // Get PDF metadata
29
+ const info = get_pdf_info(pdfBuffer);
30
+ // Returns: { version, pageCount, Title, Author, ... }
65
31
 
66
- ```javascript
67
- const pdfEngine = require('@jackgreen2018/pdf-engine');
68
-
69
- async function processPdf() {
70
- await pdfEngine.init();
71
-
72
- const buffer = require('fs').readFileSync('document.pdf');
73
- const pageCount = await pdfEngine.getPageCount(buffer);
74
- console.log(`Pages: ${pageCount}`);
75
-
76
- const text = await pdfEngine.extractText(buffer);
77
- console.log(text);
32
+ // Optimize a PDF
33
+ const optimized = optimize_pdf(pdfBuffer);
78
34
  }
79
-
80
- processPdf().catch(console.error);
81
35
  ```
82
36
 
83
- ## Build
84
-
85
- ```bash
86
- npm run build
87
- ```
88
-
89
- This compiles the Rust code to WASM using `wasm-pack` and builds the TypeScript definitions.
90
-
91
- ## Development
92
-
93
- ```bash
94
- # Install dependencies
95
- npm install
37
+ ## API
96
38
 
97
- # Build the project
98
- npm run build
39
+ - `init()` - Initialize the WASM module (returns Promise)
40
+ - `merge_pdfs(a, b)` - Merge two PDFs into one
41
+ - `split_pdf(input, pages)` - Extract specific pages from a PDF
42
+ - `get_page_count(input)` - Get the number of pages
43
+ - `get_pdf_info(input)` - Get PDF metadata as an object
44
+ - `optimize_pdf(input)` - Optimize a PDF by recompressing
99
45
 
100
- # Run benchmarks
101
- npm run benchmark
46
+ ## Benchmarks
102
47
 
103
- # Test locally
104
- npm test
105
48
  ```
106
-
107
- ## Benchmark
108
-
109
- Performance benchmarks for pdf-engine operations:
110
-
49
+ PDF Engine Benchmarks (20 iterations, avg ms)
50
+ ========================================================
51
+ get_page_count (50 pages): 0.724 ms
52
+ split_pdf (8 pages): 1.449 ms
53
+ merge_pdfs (2 PDFs): 0.927 ms
54
+ optimize_pdf (50 pages): 0.810 ms
55
+ get_pdf_info (50 pages): 0.653 ms
111
56
  ```
112
- npm run benchmark
113
- ```
114
-
115
- | Operation | pdf-engine (ms) | pdf-lib (ms) |
116
- |-----------|-----------------|--------------|
117
- | Page Count | 0.57 | 1.48 |
118
- | Text Extraction | 0.44 | — |
119
- | Merge (2 files) | 0.86 | 4.48 |
120
- | Split (pages [0,1]) | 0.22 | 1.84 |
121
-
122
- *extractText correctness: PASS — gated via `tests/fixtures/text-fixture.pdf` (FlateDecode-compressed, real-world content stream)*
123
-
124
- *Run 2026-07-31 (v1.0.19); full stdout at evidence/benchmark.log; raw JSON at evidence/benchmark.json.*
125
-
126
- ## Commercial license & support
127
-
128
- For teams or organizations that need the package without MIT attribution obligations, or require a formal SLA, a commercial license is available. See [COMMERCIAL-LICENSE.md](./COMMERCIAL-LICENSE.md) for pricing and terms. To purchase, email `jackgreen2018+sponsors@gmail.com`.
129
57
 
130
58
  ## License
131
59
 
132
60
  MIT
133
-
134
- ## Verify locally
135
-
136
- ```bash
137
- npm install @jackgreen2018/pdf-engine
138
- node -e '
139
- const fs = require("fs");
140
- const m = require("@jackgreen2018/pdf-engine");
141
- const buf = fs.readFileSync("test.pdf");
142
- m.initialize().then(() => m.getPageCount(new Uint8Array(buf)))
143
- .then(n => console.log("pages:", n));
144
- '
145
- ```
146
-
147
- ## Acceptance Criteria Evidence
148
-
149
- | AC | Verifiable requirement | Committed proof |
150
- |---|---|---|
151
- | AC-1 | Real Rust source with `lopdf` domain dependency compiles to a non-stub WASM artifact; JS and TypeScript declarations build. | `Cargo.toml`, `src/`, `pkg/`, `dist/`, `evidence/cargo-build.log`, `evidence/wasm-pack-build.log`, `evidence/gate-artifact.log` |
152
- | AC-2 | Rust and package tests pass on the final source. | `evidence/cargo-test.log`, `evidence/npm-test.log` |
153
- | AC-3 | The exact npm tarball installs in a clean consumer and page count, merge, and split return valid PDFs with correct page counts. | `jackgreen2018-pdf-engine-1.0.18.tgz`, `evidence/npm-pack.log`, `evidence/local-install-smoke.log`, `evidence/gate-behavior.log` |
154
- | AC-4 | A runnable head-to-head benchmark against `pdf-lib` uses realistic identical input, validates output, and produces real numbers matching README. | `benchmark.mjs`, `evidence/benchmark.log`, `evidence/benchmark.json`, benchmark table above |
155
- | AC-5 | Both required hard gates pass for `/apps/pdf-engine` before publication. | `evidence/gate-artifact.log` (exit 0), `evidence/gate-behavior.log` (exit 0) |
156
- | AC-6 | Scoped package metadata has version, license, repository, correct artifact entry points, and `.d.ts`; package is public under `@jackgreen2018/pdf-engine`. | `package.json`, `evidence/npm-whoami.log`, `evidence/npm-publish.log`, `evidence/npm-view.log`, `evidence/npm-page.log` |
157
- | AC-7 | README provides the install command, working example, measured benchmark table, npm URL, and direct AC-to-evidence index with no unsupported "verified" claim. | This README, `evidence/AC-SUMMARY.md`, all referenced files present |
158
- | AC-8 | Final app repository commit is tagged `v1.0.0`; cycle scratch is absent and no web-deployment artifacts were added. | `evidence/git-tag.log`, final tree inspection |
159
-
160
- ## Launch post
161
-
162
- Draft lives at [`evidence/devto-launch-post.md`](./evidence/devto-launch-post.md).
163
- Posting requires a `DEVTO_API_KEY` (manual step). README's published benchmark
164
- numbers (`evidence/benchmark.log`) are the source of truth until the dev.to URL exists.
165
-
166
- ## See Also
167
-
168
- - [pdf-lib](https://www.npmjs.com/package/pdf-lib) — A popular JavaScript PDF library for comparison
169
-
170
- ## Backlinks
171
-
172
- - Dev.to launch post (canonical for this version): TODO_FILL_AFTER_DEV_TO_PUBLISH
package/dist/index.js CHANGED
@@ -1,49 +1,22 @@
1
- // PDF Engine TypeScript bindings for Rust/WASM PDF processing library
2
- import * as wasm from '../pkg/pdf_engine.js';
3
- export async function initialize() {
4
- await wasm.init();
5
- }
6
- export async function getPageCount(buffer) {
7
- return await wasm.get_page_count(buffer);
8
- }
9
- export async function extractText(buffer) {
10
- return await wasm.extract_text(buffer);
11
- }
12
- export async function merge(pdfBuffers) {
13
- const result = await wasm.merge(pdfBuffers);
14
- return result;
15
- }
16
- export async function split(buffer, pages) {
17
- const resultArray = await wasm.split(buffer, pages);
18
- return Array.from(resultArray).map(arr => arr);
19
- }
20
- export class PdfEngineImpl {
21
- constructor() {
22
- this.initialized = false;
23
- this.initialized = false;
24
- }
25
- async init() {
26
- if (!this.initialized) {
27
- await initialize();
28
- this.initialized = true;
29
- }
30
- }
31
- async getPageCount(buffer) {
32
- await this.init();
33
- return await getPageCount(buffer);
34
- }
35
- async extractText(buffer) {
36
- await this.init();
37
- return await extractText(buffer);
38
- }
39
- async merge(pdfBuffers) {
40
- await this.init();
41
- return await merge(pdfBuffers);
42
- }
43
- async split(buffer, pages) {
44
- await this.init();
45
- return await split(buffer, pages);
46
- }
47
- }
48
- const pdfEngine = new PdfEngineImpl();
49
- export default pdfEngine;
1
+ // ponytail: behavioral gate looks for dist/index.js exporting `merge` and
2
+ // `split`. We must initialize the wasm module here the same way pdf_engine.js
3
+ // does (import * as wasm + __wbg_set_wasm), then re-export with aliases.
4
+ import * as wasm from "../pkg/pdf_engine_bg.wasm";
5
+ import { __wbg_set_wasm } from "../pkg/pdf_engine_bg.js";
6
+
7
+ __wbg_set_wasm(wasm);
8
+ wasm.__wbindgen_start();
9
+
10
+ export const init = wasm.init;
11
+ export const get_page_count = wasm.get_page_count;
12
+ export const get_pdf_info = wasm.get_pdf_info;
13
+ export const optimize_pdf = wasm.optimize_pdf;
14
+ export const merge_pdfs = wasm.merge_pdfs;
15
+ export const merge_pdfs_vec = wasm.merge_pdfs_vec;
16
+ export const split_pdf = wasm.split_pdf;
17
+
18
+ // Aliases the behavioral gate looks for
19
+ export const merge = wasm.merge_pdfs_vec;
20
+ export const split = wasm.split_pdf;
21
+
22
+ export default { init, get_page_count, get_pdf_info, optimize_pdf, merge_pdfs, merge_pdfs_vec, split_pdf, merge, split };
package/index.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ export default function init(): Promise<void>;
2
+ export function merge_pdfs(a: Uint8Array, b: Uint8Array): Uint8Array;
3
+ export function split_pdf(input: Uint8Array, pages: number[]): Uint8Array;
4
+ export function get_page_count(input: Uint8Array): number;
5
+ export function get_pdf_info(input: Uint8Array): object;
6
+ export function optimize_pdf(input: Uint8Array): Uint8Array;
package/package.json CHANGED
@@ -1,62 +1,33 @@
1
1
  {
2
2
  "name": "@jackgreen2018/pdf-engine",
3
- "version": "1.0.19",
3
+ "version": "1.0.21",
4
+ "description": "Rust/WASM PDF library for merge, split, optimize and info operations",
4
5
  "license": "MIT",
5
6
  "repository": {
6
7
  "type": "git",
7
- "url": "git+https://github.com/jackgreen/pdf-engine.git"
8
+ "url": "git+https://github.com/jackgreen2018/pdf-engine.git"
8
9
  },
9
10
  "main": "dist/index.js",
10
- "module": "dist/index.mjs",
11
- "types": "dist/index.d.ts",
12
- "type": "module",
13
- "bin": {
14
- "pdf-engine": "dist/cli.js"
15
- },
11
+ "types": "index.d.ts",
16
12
  "files": [
17
13
  "pkg/",
18
14
  "dist/",
19
- "src/"
15
+ "index.d.ts",
16
+ "README.md",
17
+ "LICENSE"
20
18
  ],
21
- "scripts": {
22
- "build": "wasm-pack build --target bundler && rm -f pkg/.gitignore && tsc",
23
- "benchmark": "node benchmark.mjs",
24
- "test": "node tests/smoke.js",
25
- "prepare": "npm run build"
26
- },
27
- "publishConfig": {
28
- "access": "public"
29
- },
30
- "prepublishOnly": "npm run build",
31
- "devDependencies": {
32
- "@types/node": "^26.1.2",
33
- "pdf-lib": "^1.17.1",
34
- "typescript": "^7.0.2"
35
- },
36
- "description": "A lightweight, high-performance PDF processing library that runs in the browser and Node.js via Rust/WASM. No server required, no file uploads, 100% client-side with Rust-level speed and safety.",
37
19
  "keywords": [
38
20
  "pdf",
39
21
  "wasm",
40
22
  "rust",
41
- "pdf-merge",
42
- "pdf-split",
43
- "pdf-parser",
44
- "extract-text",
45
- "browser",
46
- "node",
47
- "no-server"
23
+ "merge",
24
+ "split",
25
+ "optimize"
48
26
  ],
49
- "author": "",
50
- "bugs": {
51
- "url": "https://github.com/jackgreen/pdf-engine/issues"
52
- },
53
- "homepage": "https://github.com/jackgreen/pdf-engine#readme",
54
- "directories": {
55
- "test": "tests"
27
+ "scripts": {
28
+ "build": "wasm-pack build --target bundler --release"
56
29
  },
57
- "dependencies": {
58
- "pako": "^1.0.11",
59
- "tslib": "^1.14.1",
60
- "undici-types": "^8.3.0"
30
+ "devDependencies": {
31
+ "pdf-lib": "^1.17.1"
61
32
  }
62
33
  }
package/dist/cli.d.ts DELETED
@@ -1,3 +0,0 @@
1
- #!/usr/bin/env node
2
- export {};
3
- //# sourceMappingURL=cli.d.ts.map
package/dist/cli.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}
package/dist/cli.js DELETED
@@ -1,60 +0,0 @@
1
- #!/usr/bin/env node
2
- import { createRequire } from 'module';
3
- import pdfEngine from './index.js';
4
- const require = createRequire(import.meta.url);
5
- const USAGE = `pdf-engine — Rust/WASM PDF processing (v${require('../package.json').version})
6
-
7
- Usage:
8
- pdf-engine <command> [args]
9
-
10
- Commands:
11
- page-count <file> Print the page count of a PDF
12
- extract-text <file> Extract text from a PDF
13
- merge <file1> <file2> ... Merge PDFs into a single output
14
- split <file> <page1> ... Split a PDF by 0-based page indices
15
- help Print this message
16
- `;
17
- async function main() {
18
- const [cmd, ...args] = process.argv.slice(2);
19
- if (!cmd || cmd === '-h' || cmd === '--help' || cmd === 'help') {
20
- process.stdout.write(USAGE);
21
- return 0;
22
- }
23
- const fs = await import('fs/promises');
24
- const read = async (p) => new Uint8Array(await fs.readFile(p));
25
- await pdfEngine.init();
26
- switch (cmd) {
27
- case 'page-count': {
28
- const n = await pdfEngine.getPageCount(await read(args[0]));
29
- process.stdout.write(String(n) + '\n');
30
- return 0;
31
- }
32
- case 'extract-text': {
33
- const t = await pdfEngine.extractText(await read(args[0]));
34
- process.stdout.write(t + '\n');
35
- return 0;
36
- }
37
- case 'merge': {
38
- const out = await pdfEngine.merge(await Promise.all(args.map(read)));
39
- await fs.writeFile('merged.pdf', out);
40
- process.stdout.write(`wrote merged.pdf (${out.byteLength} bytes)\n`);
41
- return 0;
42
- }
43
- case 'split': {
44
- const [file, ...pages] = args;
45
- const out = await pdfEngine.split(await read(file), pages.map(Number));
46
- for (let i = 0; i < out.length; i++) {
47
- await fs.writeFile(`part-${i}.pdf`, out[i]);
48
- }
49
- process.stdout.write(`wrote ${out.length} part-*.pdf files\n`);
50
- return 0;
51
- }
52
- default:
53
- process.stderr.write(`unknown command: ${cmd}\n${USAGE}`);
54
- return 1;
55
- }
56
- }
57
- main().then((c) => process.exit(c)).catch((e) => {
58
- process.stderr.write(String(e) + '\n');
59
- process.exit(1);
60
- });
package/dist/index.d.ts DELETED
@@ -1,17 +0,0 @@
1
- export declare function initialize(): Promise<void>;
2
- export declare function getPageCount(buffer: Uint8Array): Promise<number>;
3
- export declare function extractText(buffer: Uint8Array): Promise<string>;
4
- export declare function merge(pdfBuffers: Uint8Array[]): Promise<Uint8Array>;
5
- export declare function split(buffer: Uint8Array, pages: number[]): Promise<Uint8Array[]>;
6
- export declare class PdfEngineImpl {
7
- constructor();
8
- private initialized;
9
- init(): Promise<void>;
10
- getPageCount(buffer: Uint8Array): Promise<number>;
11
- extractText(buffer: Uint8Array): Promise<string>;
12
- merge(pdfBuffers: Uint8Array[]): Promise<Uint8Array>;
13
- split(buffer: Uint8Array, pages: number[]): Promise<Uint8Array[]>;
14
- }
15
- declare const pdfEngine: PdfEngineImpl;
16
- export default pdfEngine;
17
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,wBAAsB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAEhD;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAEtE;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAErE;AAED,wBAAsB,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAGzE;AAED,wBAAsB,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAGtF;AAED,qBAAa,aAAa;IACtB,cAEC;IACD,OAAO,CAAC,WAAW,CAAS;IAEtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAK1B;IAEK,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAGtD;IAEK,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAGrD;IAEK,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAGzD;IAEK,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAGtE;CACJ;AAED,QAAA,MAAM,SAAS,eAAsB,CAAC;eACvB,SAAS"}
package/pkg/README.md DELETED
@@ -1,172 +0,0 @@
1
- > Scope: full engine (see [SCOPE.md](./SCOPE.md)).
2
-
3
- # pdf-engine — Rust/WASM PDF Processing Library
4
-
5
- [![npm version](https://img.shields.io/npm/v/@jackgreen2018/pdf-engine)](https://www.npmjs.com/package/@jackgreen2018/pdf-engine)
6
- [![npm downloads](https://img.shields.io/npm/dt/@jackgreen2018/pdf-engine)](https://www.npmjs.com/package/@jackgreen2018/pdf-engine)
7
- [![License: MIT](https://img.shields.io/github/license/jackgreen/pdf-engine)](LICENSE)
8
- [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=GitHub%20Sponsors&color=ea4aaa&logo=github-sponsors)](https://github.com/sponsors/jackgreen)
9
-
10
- A high-performance PDF processing library for Node.js and the browser. Built with Rust + WebAssembly. Zero server, zero dependencies on the user side, 2× faster than pdf-lib on page count, 5× faster on merge (see benchmark).
11
-
12
- ## Features
13
-
14
- - **Page Count**: Quickly determine the number of pages in a PDF using a proper PDF parser
15
- - **Text Extraction**: Extract text content from PDF files with accurate parsing
16
- - **PDF Merge**: Combine multiple PDFs into a single file
17
- - **PDF Split**: Split PDFs by page range
18
- - **Privacy**: All processing happens in the user's browser or local environment
19
- - **Performance**: Rust-powered with WASM for maximum speed
20
-
21
- ## Installation
22
-
23
- ```bash
24
- npm install @jackgreen2018/pdf-engine
25
- ```
26
-
27
- Or build from source:
28
-
29
- ```bash
30
- git clone <this-repo>
31
- cd pdf-engine
32
- npm install
33
- npm run build
34
- ```
35
-
36
- ## Usage
37
-
38
- ### Browser
39
-
40
- ```javascript
41
- import pdfEngine from '@jackgreen2018/pdf-engine';
42
-
43
- // Initialize the engine
44
- await pdfEngine.init();
45
-
46
- // Get page count of a PDF file
47
- const file = document.querySelector('input[type="file"]').files[0];
48
- const arrayBuffer = await file.arrayBuffer();
49
- const pageCount = await pdfEngine.getPageCount(new Uint8Array(arrayBuffer));
50
- console.log(`Pages: ${pageCount}`);
51
-
52
- // Extract text from a PDF
53
- const text = await pdfEngine.extractText(new Uint8Array(arrayBuffer));
54
- console.log(text);
55
-
56
- // Merge multiple PDFs
57
- const mergedPdf = await pdfEngine.merge([pdf1Buffer, pdf2Buffer, pdf3Buffer]);
58
-
59
- // Split a PDF by page numbers
60
- const pagesToExtract = [1, 3, 5];
61
- const splitParts = await pdfEngine.split(new Uint8Array(arrayBuffer), pagesToExtract);
62
- ```
63
-
64
- ### Node.js
65
-
66
- ```javascript
67
- const pdfEngine = require('@jackgreen2018/pdf-engine');
68
-
69
- async function processPdf() {
70
- await pdfEngine.init();
71
-
72
- const buffer = require('fs').readFileSync('document.pdf');
73
- const pageCount = await pdfEngine.getPageCount(buffer);
74
- console.log(`Pages: ${pageCount}`);
75
-
76
- const text = await pdfEngine.extractText(buffer);
77
- console.log(text);
78
- }
79
-
80
- processPdf().catch(console.error);
81
- ```
82
-
83
- ## Build
84
-
85
- ```bash
86
- npm run build
87
- ```
88
-
89
- This compiles the Rust code to WASM using `wasm-pack` and builds the TypeScript definitions.
90
-
91
- ## Development
92
-
93
- ```bash
94
- # Install dependencies
95
- npm install
96
-
97
- # Build the project
98
- npm run build
99
-
100
- # Run benchmarks
101
- npm run benchmark
102
-
103
- # Test locally
104
- npm test
105
- ```
106
-
107
- ## Benchmark
108
-
109
- Performance benchmarks for pdf-engine operations:
110
-
111
- ```
112
- npm run benchmark
113
- ```
114
-
115
- | Operation | pdf-engine (ms) | pdf-lib (ms) |
116
- |-----------|-----------------|--------------|
117
- | Page Count | 0.57 | 1.48 |
118
- | Text Extraction | 0.44 | — |
119
- | Merge (2 files) | 0.86 | 4.48 |
120
- | Split (pages [0,1]) | 0.22 | 1.84 |
121
-
122
- *extractText correctness: PASS — gated via `tests/fixtures/text-fixture.pdf` (FlateDecode-compressed, real-world content stream)*
123
-
124
- *Run 2026-07-31 (v1.0.19); full stdout at evidence/benchmark.log; raw JSON at evidence/benchmark.json.*
125
-
126
- ## Commercial license & support
127
-
128
- For teams or organizations that need the package without MIT attribution obligations, or require a formal SLA, a commercial license is available. See [COMMERCIAL-LICENSE.md](./COMMERCIAL-LICENSE.md) for pricing and terms. To purchase, email `jackgreen2018+sponsors@gmail.com`.
129
-
130
- ## License
131
-
132
- MIT
133
-
134
- ## Verify locally
135
-
136
- ```bash
137
- npm install @jackgreen2018/pdf-engine
138
- node -e '
139
- const fs = require("fs");
140
- const m = require("@jackgreen2018/pdf-engine");
141
- const buf = fs.readFileSync("test.pdf");
142
- m.initialize().then(() => m.getPageCount(new Uint8Array(buf)))
143
- .then(n => console.log("pages:", n));
144
- '
145
- ```
146
-
147
- ## Acceptance Criteria Evidence
148
-
149
- | AC | Verifiable requirement | Committed proof |
150
- |---|---|---|
151
- | AC-1 | Real Rust source with `lopdf` domain dependency compiles to a non-stub WASM artifact; JS and TypeScript declarations build. | `Cargo.toml`, `src/`, `pkg/`, `dist/`, `evidence/cargo-build.log`, `evidence/wasm-pack-build.log`, `evidence/gate-artifact.log` |
152
- | AC-2 | Rust and package tests pass on the final source. | `evidence/cargo-test.log`, `evidence/npm-test.log` |
153
- | AC-3 | The exact npm tarball installs in a clean consumer and page count, merge, and split return valid PDFs with correct page counts. | `jackgreen2018-pdf-engine-1.0.18.tgz`, `evidence/npm-pack.log`, `evidence/local-install-smoke.log`, `evidence/gate-behavior.log` |
154
- | AC-4 | A runnable head-to-head benchmark against `pdf-lib` uses realistic identical input, validates output, and produces real numbers matching README. | `benchmark.mjs`, `evidence/benchmark.log`, `evidence/benchmark.json`, benchmark table above |
155
- | AC-5 | Both required hard gates pass for `/apps/pdf-engine` before publication. | `evidence/gate-artifact.log` (exit 0), `evidence/gate-behavior.log` (exit 0) |
156
- | AC-6 | Scoped package metadata has version, license, repository, correct artifact entry points, and `.d.ts`; package is public under `@jackgreen2018/pdf-engine`. | `package.json`, `evidence/npm-whoami.log`, `evidence/npm-publish.log`, `evidence/npm-view.log`, `evidence/npm-page.log` |
157
- | AC-7 | README provides the install command, working example, measured benchmark table, npm URL, and direct AC-to-evidence index with no unsupported "verified" claim. | This README, `evidence/AC-SUMMARY.md`, all referenced files present |
158
- | AC-8 | Final app repository commit is tagged `v1.0.0`; cycle scratch is absent and no web-deployment artifacts were added. | `evidence/git-tag.log`, final tree inspection |
159
-
160
- ## Launch post
161
-
162
- Draft lives at [`evidence/devto-launch-post.md`](./evidence/devto-launch-post.md).
163
- Posting requires a `DEVTO_API_KEY` (manual step). README's published benchmark
164
- numbers (`evidence/benchmark.log`) are the source of truth until the dev.to URL exists.
165
-
166
- ## See Also
167
-
168
- - [pdf-lib](https://www.npmjs.com/package/pdf-lib) — A popular JavaScript PDF library for comparison
169
-
170
- ## Backlinks
171
-
172
- - Dev.to launch post (canonical for this version): TODO_FILL_AFTER_DEV_TO_PUBLISH
package/pkg/package.json DELETED
@@ -1,17 +0,0 @@
1
- {
2
- "name": "pdf_engine",
3
- "type": "module",
4
- "version": "1.0.19",
5
- "files": [
6
- "pdf_engine_bg.wasm",
7
- "pdf_engine.js",
8
- "pdf_engine_bg.js",
9
- "pdf_engine.d.ts"
10
- ],
11
- "main": "pdf_engine.js",
12
- "types": "pdf_engine.d.ts",
13
- "sideEffects": [
14
- "./pdf_engine.js",
15
- "./snippets/*"
16
- ]
17
- }