unpdf 1.0.1 → 1.0.3

package/README.md

@@ -1,8 +1,8 @@
 # unpdf
 
-A collection of utilities for working with PDF files. Designed specifically for Bun, Deno, and serverless environments. However, it also works in Node.js and the browser.
+A collection of utilities for PDF extraction and rendering. Designed specifically for serverless environments, but it also works in Node.js, Deno, Bun and the browser. `unpdf` is particularly useful for serverless AI applications, especially for summarizing PDF documents in document analysis workflows.
 
-`unpdf` ships with a serverless build/redistribution of Mozilla's [PDF.js](https://github.com/mozilla/pdf.js) for serverless environments. Apart from some string replacements and mocks, [`unenv`](https://github.com/unjs/unenv) does the heavy lifting by converting Node.js specific code to be platform-agnostic. See [`pdfjs.rollup.config.ts`](./pdfjs.rollup.config.ts) for all the details.
+This library ships with a serverless build/redistribution of Mozilla's [PDF.js](https://github.com/mozilla/pdf.js) that is optimized for edge environments. Some string replacements, global mocks and inlining the PDF.js worker allow the browser code to become platform agnostic. See [`pdfjs.rollup.config.ts`](./pdfjs.rollup.config.ts) for the details.
 
 This library is also intended as a modern alternative to the unmaintained but still popular [`pdf-parse`](https://www.npmjs.com/package/pdf-parse).
 
@@ -11,6 +11,7 @@ This library is also intended as a modern alternative to the unmaintained but st
 - 🏗️ Made for Node.js, browser and serverless environments
 - 🪭 Includes serverless build of PDF.js ([`unpdf/pdfjs`](./package.json#L34))
 - 💬 Extract [text](#extract-text-from-pdf) and [images](#extractimages) from PDF files
+- 🧠 Perfect for AI applications and PDF summarization
 - 🧱 Opt-in to legacy PDF.js build
 - 💨 Zero dependencies
 
@@ -19,7 +20,7 @@ This library is also intended as a modern alternative to the unmaintained but st
 > [!Tip]
 > The serverless PDF.js bundle provided by `unpdf` is built from PDF.js v5.2.133.
 
-You can use an [official PDF.js build](#use-official-or-legacy-pdfjs-build) by using the [`definePDFJSModule`](#definepdfjsmodule) method. This is useful if you want to use a specific version or a custom build of PDF.js.
+You can use an [official PDF.js build](#official-or-legacy-pdfjs-build) by using the [`definePDFJSModule`](#definepdfjsmodule) method. This is useful if you want to use a specific version or a custom build of PDF.js.
 
 ## Installation
 
@@ -58,6 +59,25 @@ console.log(`Total pages: ${totalPages}`)
 console.log(text)
 ```
 
+### Official or Legacy PDF.js Build
+
+Usually you don't need to worry about the PDF.js build. `unpdf` ships with a serverless build of the latest PDF.js version. However, if you want to use the official PDF.js version or the legacy build, you can define a custom PDF.js module.
+
+> [!WARNING]
+> PDF.js v5.x uses `Promise.withResolvers`, which may not be supported in all environments, such as Node < 22. Consider to use the bundled serverless build, which includes a polyfill, or use an older version of PDF.js.
+
+For example, if you want to use the official PDF.js build, you can do the following:
+
+```ts
+import { definePDFJSModule } from 'unpdf'
+
+// Define the PDF.js build before using any other unpdf method
+await definePDFJSModule(() => import('pdfjs-dist'))
+
+// Now, you can use all unpdf methods with the official PDF.js build
+const { text } = await extractText(pdf)
+```
+
 ### PDF.js API
 
 `unpdf` provides helpful [methods](#api) to work with PDF files, such as `extractText` and `extractImages`, which should cover most use cases. However, if you need more control over the PDF.js API, you can use the `getResolvedPDFJS` method to get the resolved PDF.js module.
@@ -80,37 +100,18 @@ import { getResolvedPDFJS } from 'unpdf'
 
 const { getDocument } = await getResolvedPDFJS()
 const data = Deno.readFileSync('dummy.pdf')
-const doc = await getDocument(data).promise
+const document = await getDocument(data).promise
 
-console.log(await doc.getMetadata())
+console.log(await document.getMetadata())
 
-for (let i = 1; i <= doc.numPages; i++) {
-  const page = await doc.getPage(i)
+for (let i = 1; i <= document.numPages; i++) {
+  const page = await document.getPage(i)
   const textContent = await page.getTextContent()
   const contents = textContent.items.map(item => item.str).join(' ')
   console.log(contents)
 }
 ```
 
-### Use Official or Legacy PDF.js Build
-
-Usually you don't need to worry about the PDF.js build. `unpdf` ships with a serverless build of the latest PDF.js version. However, if you want to use the official PDF.js version or the legacy build, you can define a custom PDF.js module.
-
-> [!WARNING]
-> Later PDF.js v4.x versions uses `Promise.withResolvers`, which may not be supported in all environments, such as Node < 22. Consider to use the bundled serverless build, which includes a polyfill, or use an older version of PDF.js.
-
-For example, if you want to use the official PDF.js build, you can do the following:
-
-```ts
-import { definePDFJSModule } from 'unpdf'
-
-// Define the PDF.js build before using any other unpdf method
-await definePDFJSModule(() => import('pdfjs-dist'))
-
-// Now, you can use all unpdf methods with the official PDF.js build
-const { text } = await extractText(pdf)
-```
-
 ## API
 
 ### `definePDFJSModule`

package/dist/index.cjs

@@ -29,16 +29,13 @@ async function resolvePDFJSImport(pdfjsResolver, { reload = false } = {}) {
       resolvedModule = await interopDefault(pdfjsResolver());
       return;
     } catch (error) {
-      console.error(error);
-      throw new Error("PDF.js could not be resolved. Please check the resolver function.");
+      throw new Error(`PDF.js could not be resolved: ${error}`);
     }
   }
   try {
-    const { resolvePDFJS } = await import('unpdf/pdfjs');
-    resolvedModule = await resolvePDFJS();
+    resolvedModule = await import('unpdf/pdfjs');
   } catch (error) {
-    console.error(error);
-    throw new Error("PDF.js package not available. Please install it first.");
+    throw new Error(`Serverless PDF.js bundle could not be resolved: ${error}`);
   }
 }
 function isPDFDocumentProxy(data) {
@@ -49,7 +46,7 @@ async function interopDefault(m) {
   return resolved.default || resolved;
 }
 
-let canvasModule;
+let resolvedCanvasModule;
 /**
  * Derived from the PDF.js project by the Mozilla Foundation.
  * @see https://github.com/mozilla/pdf.js/blob/b8de9a372f9bbf7e33adb362eeae5ef1919dba73/src/display/canvas_factory.js#L18
@@ -113,21 +110,24 @@ class NodeCanvasFactory extends BaseCanvasFactory {
     super({ enableHWA });
   }
   _createCanvas(width, height) {
-    if (!canvasModule) {
+    if (!resolvedCanvasModule) {
       throw new Error("@napi-rs/canvas module is not resolved");
     }
-    return canvasModule.createCanvas(width, height);
+    return resolvedCanvasModule.createCanvas(width, height);
   }
 }
 async function resolveCanvasModule(canvasImport) {
-  canvasModule ??= await interopDefault(canvasImport());
+  resolvedCanvasModule ??= await interopDefault(canvasImport());
 }
 function injectCanvasConstructors() {
-  if (!canvasModule)
+  if (!resolvedCanvasModule)
     return;
-  globalThis.DOMMatrix ??= canvasModule.DOMMatrix;
-  globalThis.ImageData ??= canvasModule.ImageData;
-  globalThis.Path2D ??= canvasModule.Path2D;
+  if (typeof globalThis.DOMMatrix === "undefined")
+    globalThis.DOMMatrix = resolvedCanvasModule.DOMMatrix;
+  if (typeof globalThis.ImageData === "undefined")
+    globalThis.ImageData = resolvedCanvasModule.ImageData;
+  if (typeof globalThis.Path2D === "undefined")
+    globalThis.Path2D = resolvedCanvasModule.Path2D;
 }
 
 async function extractImages$1(data, pageNumber) {

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as _napi_rs_canvas from '@napi-rs/canvas';
 import { DocumentInitParameters, PDFDocumentProxy } from './types/src/display/api';
-import * as _PDFJS from './types/src/pdf';
+import * as PDFJS from './types/src/pdf';
 
 interface ExtractedImageObject {
     data: Uint8ClampedArray;
@@ -69,8 +69,6 @@ declare function configureUnPDF(options: {
     pdfjs?: () => Promise<any>;
 }): Promise<void>;
 
-type PDFJS = typeof _PDFJS;
-
 /**
  * Returns a PDFDocumentProxy instance from a given binary data.
  *
@@ -79,7 +77,7 @@ type PDFJS = typeof _PDFJS;
  * - `useSystemFonts: true`
  */
 declare function getDocumentProxy(data: DocumentInitParameters['data'], options?: DocumentInitParameters): Promise<PDFDocumentProxy>;
-declare function getResolvedPDFJS(): Promise<PDFJS>;
+declare function getResolvedPDFJS(): Promise<typeof PDFJS>;
 declare function resolvePDFJSImport(pdfjsResolver?: () => Promise<any>, { reload }?: {
     reload?: boolean | undefined;
 }): Promise<void>;

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import * as _napi_rs_canvas from '@napi-rs/canvas';
 import { DocumentInitParameters, PDFDocumentProxy } from './types/src/display/api';
-import * as _PDFJS from './types/src/pdf';
+import * as PDFJS from './types/src/pdf';
 
 interface ExtractedImageObject {
     data: Uint8ClampedArray;
@@ -69,8 +69,6 @@ declare function configureUnPDF(options: {
     pdfjs?: () => Promise<any>;
 }): Promise<void>;
 
-type PDFJS = typeof _PDFJS;
-
 /**
  * Returns a PDFDocumentProxy instance from a given binary data.
  *
@@ -79,7 +77,7 @@ type PDFJS = typeof _PDFJS;
  * - `useSystemFonts: true`
  */
 declare function getDocumentProxy(data: DocumentInitParameters['data'], options?: DocumentInitParameters): Promise<PDFDocumentProxy>;
-declare function getResolvedPDFJS(): Promise<PDFJS>;
+declare function getResolvedPDFJS(): Promise<typeof PDFJS>;
 declare function resolvePDFJSImport(pdfjsResolver?: () => Promise<any>, { reload }?: {
     reload?: boolean | undefined;
 }): Promise<void>;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _napi_rs_canvas from '@napi-rs/canvas';
 import { DocumentInitParameters, PDFDocumentProxy } from './types/src/display/api';
-import * as _PDFJS from './types/src/pdf';
+import * as PDFJS from './types/src/pdf';
 
 interface ExtractedImageObject {
     data: Uint8ClampedArray;
@@ -69,8 +69,6 @@ declare function configureUnPDF(options: {
     pdfjs?: () => Promise<any>;
 }): Promise<void>;
 
-type PDFJS = typeof _PDFJS;
-
 /**
  * Returns a PDFDocumentProxy instance from a given binary data.
  *
@@ -79,7 +77,7 @@ type PDFJS = typeof _PDFJS;
  * - `useSystemFonts: true`
  */
 declare function getDocumentProxy(data: DocumentInitParameters['data'], options?: DocumentInitParameters): Promise<PDFDocumentProxy>;
-declare function getResolvedPDFJS(): Promise<PDFJS>;
+declare function getResolvedPDFJS(): Promise<typeof PDFJS>;
 declare function resolvePDFJSImport(pdfjsResolver?: () => Promise<any>, { reload }?: {
     reload?: boolean | undefined;
 }): Promise<void>;

package/dist/index.mjs

@@ -27,16 +27,13 @@ async function resolvePDFJSImport(pdfjsResolver, { reload = false } = {}) {
       resolvedModule = await interopDefault(pdfjsResolver());
       return;
     } catch (error) {
-      console.error(error);
-      throw new Error("PDF.js could not be resolved. Please check the resolver function.");
+      throw new Error(`PDF.js could not be resolved: ${error}`);
     }
   }
   try {
-    const { resolvePDFJS } = await import('unpdf/pdfjs');
-    resolvedModule = await resolvePDFJS();
+    resolvedModule = await import('unpdf/pdfjs');
   } catch (error) {
-    console.error(error);
-    throw new Error("PDF.js package not available. Please install it first.");
+    throw new Error(`Serverless PDF.js bundle could not be resolved: ${error}`);
   }
 }
 function isPDFDocumentProxy(data) {
@@ -47,7 +44,7 @@ async function interopDefault(m) {
   return resolved.default || resolved;
 }
 
-let canvasModule;
+let resolvedCanvasModule;
 /**
  * Derived from the PDF.js project by the Mozilla Foundation.
  * @see https://github.com/mozilla/pdf.js/blob/b8de9a372f9bbf7e33adb362eeae5ef1919dba73/src/display/canvas_factory.js#L18
@@ -111,21 +108,24 @@ class NodeCanvasFactory extends BaseCanvasFactory {
     super({ enableHWA });
   }
   _createCanvas(width, height) {
-    if (!canvasModule) {
+    if (!resolvedCanvasModule) {
       throw new Error("@napi-rs/canvas module is not resolved");
     }
-    return canvasModule.createCanvas(width, height);
+    return resolvedCanvasModule.createCanvas(width, height);
   }
 }
 async function resolveCanvasModule(canvasImport) {
-  canvasModule ??= await interopDefault(canvasImport());
+  resolvedCanvasModule ??= await interopDefault(canvasImport());
 }
 function injectCanvasConstructors() {
-  if (!canvasModule)
+  if (!resolvedCanvasModule)
     return;
-  globalThis.DOMMatrix ??= canvasModule.DOMMatrix;
-  globalThis.ImageData ??= canvasModule.ImageData;
-  globalThis.Path2D ??= canvasModule.Path2D;
+  if (typeof globalThis.DOMMatrix === "undefined")
+    globalThis.DOMMatrix = resolvedCanvasModule.DOMMatrix;
+  if (typeof globalThis.ImageData === "undefined")
+    globalThis.ImageData = resolvedCanvasModule.ImageData;
+  if (typeof globalThis.Path2D === "undefined")
+    globalThis.Path2D = resolvedCanvasModule.Path2D;
 }
 
 async function extractImages$1(data, pageNumber) {

package/dist/pdfjs.d.mts

@@ -1,4 +1 @@
-import * as PDFJS from './types/src/pdf'
-declare function resolvePDFJS(): Promise<typeof PDFJS>
-export { resolvePDFJS }
 export * from './types/src/pdf'

package/dist/pdfjs.d.ts

@@ -1,4 +1 @@
-import * as PDFJS from './types/src/pdf'
-declare function resolvePDFJS(): Promise<typeof PDFJS>
-export { resolvePDFJS }
 export * from './types/src/pdf'