pdf_oxide 0.3.24

The fastest Rust PDF library with text extraction: 0.8ms mean, 100% pass rate on 3,830 PDFs. 5× faster than pdf_extract, 17× faster than oxidize_pdf. Extract, create, and edit PDFs.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
/**
 * Stream API Tests - Node.js Implementation
 *
 * Tests for Stream API support including SearchStream, ExtractionStream,
 * and MetadataStream with backpressure handling and proper stream semantics.
 */

import test from 'ava';
import {
  SearchStream,
  ExtractionStream,
  MetadataStream,
  createSearchStream,
  createExtractionStream,
  createMetadataStream,
} from '../lib/managers/streams.js';

// Mock objects for testing
class MockSearchManager {
  search(term, pageIndex, options) {
    return [
      { text: 'found', pageIndex, position: 0, boundingBox: null },
      { text: 'found again', pageIndex, position: 10, boundingBox: null },
    ];
  }

  searchAll(term, options) {
    return [
      { text: 'result1', pageIndex: 0, position: 0 },
      { text: 'result2', pageIndex: 1, position: 5 },
      { text: 'result3', pageIndex: 2, position: 15 },
    ];
  }
}

class MockExtractionManager {
  extractText(pageIndex) {
    return `Extracted text from page ${pageIndex}`;
  }

  extractMarkdown(pageIndex) {
    return `# Page ${pageIndex}\n\nMarkdown content`;
  }

  extractHtml(pageIndex) {
    return `<html><body>Page ${pageIndex}</body></html>`;
  }
}

class MockRenderingManager {
  getPageDimensions(pageIndex) {
    return {
      width: 612,
      height: 792,
      rotation: pageIndex % 2 === 0 ? 0 : 90,
    };
  }

  getEmbeddedFonts(pageIndex) {
    return pageIndex === 0 ? ['Arial', 'Times'] : ['Helvetica'];
  }

  getEmbeddedImages(pageIndex) {
    return pageIndex === 1 ? ['image1.jpg', 'image2.png'] : ['image0.jpg'];
  }
}

// SearchStream Tests
test('SearchStream - constructor requires SearchManager', (t) => {
  const error = t.throws(() => {
    new SearchStream(null, 'test');
  });
  t.is(error.message, 'SearchManager is required');
});

test('SearchStream - constructor requires search term', (t) => {
  const manager = new MockSearchManager();
  const error = t.throws(() => {
    new SearchStream(manager, '');
  });
  t.is(error.message, 'Search term must be a non-empty string');
});

test('SearchStream - creates readable stream in object mode', (t) => {
  const manager = new MockSearchManager();
  const stream = new SearchStream(manager, 'test');
  t.true(stream.readableObjectMode);
});

test('SearchStream - emits search results as objects', async (t) => {
  const manager = new MockSearchManager();
  const stream = new SearchStream(manager, 'test', { pageIndex: 0 });

  const results = [];
  return new Promise((resolve, reject) => {
    stream.on('data', (result) => {
      t.is(typeof result.text, 'string');
      t.is(typeof result.pageIndex, 'number');
      t.is(typeof result.position, 'number');
      results.push(result);
    });

    stream.on('end', () => {
      t.is(results.length, 2);
      resolve();
    });

    stream.on('error', reject);
  });
});

test('SearchStream - supports maxResults option', (t) => {
  const manager = new MockSearchManager();
  const stream = new SearchStream(manager, 'test', { maxResults: 1 });

  const results = [];
  return new Promise((resolve, reject) => {
    stream.on('data', (result) => {
      results.push(result);
    });

    stream.on('end', () => {
      t.is(results.length, 1);
      resolve();
    });

    stream.on('error', reject);
  });
});

test('SearchStream - supports whole document search', (t) => {
  const manager = new MockSearchManager();
  const stream = new SearchStream(manager, 'test'); // No pageIndex

  const results = [];
  return new Promise((resolve, reject) => {
    stream.on('data', (result) => {
      results.push(result);
    });

    stream.on('end', () => {
      t.is(results.length, 3);
      resolve();
    });

    stream.on('error', reject);
  });
});

// ExtractionStream Tests
test('ExtractionStream - constructor requires ExtractionManager', (t) => {
  const error = t.throws(() => {
    new ExtractionStream(null, 0, 1);
  });
  t.is(error.message, 'ExtractionManager is required');
});

test('ExtractionStream - validates page range', (t) => {
  const manager = new MockExtractionManager();

  const error1 = t.throws(() => {
    new ExtractionStream(manager, -1, 5);
  });
  t.is(error1.message, 'Start page must be a non-negative number');

  const error2 = t.throws(() => {
    new ExtractionStream(manager, 5, 5);
  });
  t.is(error2.message, 'End page must be greater than start page');
});

test('ExtractionStream - validates extraction type', (t) => {
  const manager = new MockExtractionManager();

  const error = t.throws(() => {
    new ExtractionStream(manager, 0, 5, 'invalid');
  });
  t.is(error.message, "Extraction type must be 'text', 'markdown', or 'html'");
});

test('ExtractionStream - emits extraction progress', async (t) => {
  const manager = new MockExtractionManager();
  const stream = new ExtractionStream(manager, 0, 3, 'text');

  const results = [];
  return new Promise((resolve, reject) => {
    stream.on('data', (progress) => {
      t.is(typeof progress.pageIndex, 'number');
      t.is(typeof progress.totalPages, 'number');
      t.is(typeof progress.extractedText, 'string');
      t.is(typeof progress.extractionType, 'string');
      t.is(typeof progress.progress, 'number');
      t.true(progress.progress >= 0 && progress.progress <= 1);
      results.push(progress);
    });

    stream.on('end', () => {
      t.is(results.length, 3);
      // Check progress values are correct
      t.is(results[0].progress, 1 / 3);
      t.is(results[1].progress, 2 / 3);
      t.is(results[2].progress, 1.0);
      resolve();
    });

    stream.on('error', reject);
  });
});

test('ExtractionStream - supports markdown extraction', async (t) => {
  const manager = new MockExtractionManager();
  const stream = new ExtractionStream(manager, 0, 1, 'markdown');

  const results = [];
  return new Promise((resolve, reject) => {
    stream.on('data', (progress) => {
      t.is(progress.extractionType, 'markdown');
      t.true(progress.extractedText.includes('# Page'));
      results.push(progress);
    });

    stream.on('end', () => {
      t.is(results.length, 1);
      resolve();
    });

    stream.on('error', reject);
  });
});

test('ExtractionStream - supports html extraction', async (t) => {
  const manager = new MockExtractionManager();
  const stream = new ExtractionStream(manager, 0, 1, 'html');

  const results = [];
  return new Promise((resolve, reject) => {
    stream.on('data', (progress) => {
      t.is(progress.extractionType, 'html');
      t.true(progress.extractedText.includes('<html>'));
      results.push(progress);
    });

    stream.on('end', () => {
      t.is(results.length, 1);
      resolve();
    });

    stream.on('error', reject);
  });
});

// MetadataStream Tests
test('MetadataStream - constructor requires RenderingManager', (t) => {
  const error = t.throws(() => {
    new MetadataStream(null, 0, 1);
  });
  t.is(error.message, 'RenderingManager is required');
});

test('MetadataStream - validates page range', (t) => {
  const manager = new MockRenderingManager();

  const error1 = t.throws(() => {
    new MetadataStream(manager, -1, 5);
  });
  t.is(error1.message, 'Start page must be a non-negative number');

  const error2 = t.throws(() => {
    new MetadataStream(manager, 5, 5);
  });
  t.is(error2.message, 'End page must be greater than start page');
});

test('MetadataStream - emits page metadata', async (t) => {
  const manager = new MockRenderingManager();
  const stream = new MetadataStream(manager, 0, 2);

  const results = [];
  return new Promise((resolve, reject) => {
    stream.on('data', (metadata) => {
      t.is(typeof metadata.pageIndex, 'number');
      t.is(typeof metadata.width, 'number');
      t.is(typeof metadata.height, 'number');
      t.is(typeof metadata.fontCount, 'number');
      t.is(typeof metadata.imageCount, 'number');
      t.is(typeof metadata.rotation, 'number');
      results.push(metadata);
    });

    stream.on('end', () => {
      t.is(results.length, 2);
      resolve();
    });

    stream.on('error', reject);
  });
});

test('MetadataStream - includes correct font counts', async (t) => {
  const manager = new MockRenderingManager();
  const stream = new MetadataStream(manager, 0, 2);

  const results = [];
  return new Promise((resolve, reject) => {
    stream.on('data', (metadata) => {
      results.push(metadata);
    });

    stream.on('end', () => {
      // Page 0 has 2 fonts, Page 1 has 1 font
      t.is(results[0].fontCount, 2);
      t.is(results[1].fontCount, 1);
      resolve();
    });

    stream.on('error', reject);
  });
});

test('MetadataStream - includes correct image counts', async (t) => {
  const manager = new MockRenderingManager();
  const stream = new MetadataStream(manager, 0, 3);

  const results = [];
  return new Promise((resolve, reject) => {
    stream.on('data', (metadata) => {
      results.push(metadata);
    });

    stream.on('end', () => {
      t.is(results[0].imageCount, 1);
      t.is(results[1].imageCount, 2);
      resolve();
    });

    stream.on('error', reject);
  });
});

test('MetadataStream - includes rotation values', async (t) => {
  const manager = new MockRenderingManager();
  const stream = new MetadataStream(manager, 0, 2);

  const results = [];
  return new Promise((resolve, reject) => {
    stream.on('data', (metadata) => {
      results.push(metadata);
    });

    stream.on('end', () => {
      t.is(results[0].rotation, 0);
      t.is(results[1].rotation, 90);
      resolve();
    });

    stream.on('error', reject);
  });
});

// Factory Function Tests
test('createSearchStream - creates SearchStream instance', (t) => {
  const manager = new MockSearchManager();
  const stream = createSearchStream(manager, 'test');
  t.true(stream instanceof SearchStream);
});

test('createExtractionStream - creates ExtractionStream instance', (t) => {
  const manager = new MockExtractionManager();
  const stream = createExtractionStream(manager, 0, 5);
  t.true(stream instanceof ExtractionStream);
});

test('createMetadataStream - creates MetadataStream instance', (t) => {
  const manager = new MockRenderingManager();
  const stream = createMetadataStream(manager, 0, 5);
  t.true(stream instanceof MetadataStream);
});

// Backpressure Handling Tests
test('SearchStream - handles backpressure correctly', async (t) => {
  const manager = new MockSearchManager();
  const stream = new SearchStream(manager, 'test');

  let paused = false;
  let resumed = false;

  stream.on('pause', () => {
    paused = true;
  });

  stream.on('resume', () => {
    resumed = true;
  });

  // Force backpressure by setting highWaterMark to 0
  const paused1 = stream.pause();
  t.true(paused1 || !stream.readableFlowing);

  stream.resume();
  t.true(stream.readableFlowing !== false);
});

// Stream Lifecycle Tests
test('SearchStream - properly ends stream', async (t) => {
  const manager = new MockSearchManager();
  const stream = new SearchStream(manager, 'test', { pageIndex: 0 });

  let endCalled = false;
  stream.on('end', () => {
    endCalled = true;
  });

  return new Promise((resolve) => {
    stream.on('close', () => {
      t.true(endCalled);
      resolve();
    });

    // Consume all data
    stream.on('data', () => {});
  });
});

// Error Handling Tests
test('SearchStream - handles invalid manager gracefully', async (t) => {
  const stream = new SearchStream(new MockSearchManager(), 'test');

  // Add data listener first, then read
  return new Promise((resolve) => {
    const results = [];
    stream.on('data', (result) => {
      results.push(result);
    });

    stream.on('end', () => {
      t.is(results.length, 3);
      resolve();
    });
  });
});