unpdf 0.7.0 → 0.8.0

package/README.md

@@ -14,6 +14,11 @@ This library is also intended as a modern alternative to the unmaintained but st
 - 🧱 Opt-in to legacy PDF.js build
 - 💨 Zero dependencies
 
+## PDF.js Compatibility
+
+> [!NOTE]
+> This package is currently using PDF.js v4.0.189.
+
 ## Installation
 
 Run the following command to add `unpdf` to your project.
@@ -179,8 +184,11 @@ defineUnPDFConfig({
 
 const pdf = await readFile("./dummy.pdf");
 const buffer = new Uint8Array(pdf);
+const pageNumber = 1;
 
-const result = await renderPageAsImage(buffer, 1);
+const result = await renderPageAsImage(buffer, pageNumber, {
+  canvas: () => import("canvas"),
+});
 await writeFile("dummy-page-1.png", Buffer.from(result));
 ```
 
@@ -191,6 +199,7 @@ declare function renderPageAsImage(
   data: BinaryData | PDFDocumentProxy,
   pageNumber: number,
   options?: {
+    canvas?: () => Promise<typeof import("canvas")>;
     /** @default 1 */
     scale?: number;
     width?: number;
@@ -199,20 +208,13 @@ declare function renderPageAsImage(
 ): Promise<ArrayBuffer>;
 ```
 
-### `extractImages`
-
-```ts
-function extractImages(
-  data: BinaryData | PDFDocumentProxy,
-  pageNumber: number,
-): Promise<Uint8ClampedArray[]>;
-```
-
 ## FAQ
 
-### What About Canvas?
+### Why Is `canvas` An Optional Dependency?
+
+The official PDF.js library depends on the `canvas` module for Node.js environments, which [doesn't work inside worker threads](https://github.com/Automattic/node-canvas/issues/1394). That's why `unpdf` ships with a serverless build of PDF.js that mocks the `canvas` module.
 
-The official PDF.js library depends on the optional `canvas` module, which [doesn't work inside worker threads](https://github.com/Automattic/node-canvas/issues/1394). That's why `unpdf` ships with a serverless build of PDF.js that mocks the `canvas` module.
+However, to render PDF pages as images in Node.js environments, you need to install the `canvas` module. That's why it is a peer dependency.
 
 ## License
 

package/dist/index.cjs

@@ -116,7 +116,7 @@ async function renderPageAsImage$1(data, pageNumber, options = {}) {
   if (outputScale !== 1 && outputScale > 0) {
     viewport = page.getViewport({ scale: outputScale });
   }
-  const canvasFactory = await createIsomorphicCanvasFactory();
+  const canvasFactory = await createIsomorphicCanvasFactory(options.canvas);
   const ctx = canvasFactory.create(viewport.width, viewport.height);
   await page.render({
     canvasContext: ctx.context,
@@ -126,25 +126,19 @@ async function renderPageAsImage$1(data, pageNumber, options = {}) {
   const response = await fetch(dataUrl);
   return await response.arrayBuffer();
 }
-async function createIsomorphicCanvasFactory() {
-  let _canvas;
-  if (isNode) {
-    try {
-      _canvas = await import('canvas');
-    } catch {
-      throw new Error(
-        'The "canvas" package is required when running in Node.js.'
-      );
-    }
-  }
+async function createIsomorphicCanvasFactory(canvas) {
+  const _canvas = await canvas?.();
   return {
     _createCanvas(width, height) {
       if (isBrowser) {
-        const canvas = document.createElement("canvas");
-        canvas.width = width;
-        canvas.height = height;
-        return canvas;
+        const canvas2 = document.createElement("canvas");
+        canvas2.width = width;
+        canvas2.height = height;
+        return canvas2;
       } else if (isNode) {
+        if (!_canvas) {
+          throw new Error('Failed to resolve "canvas" package.');
+        }
         return _canvas.createCanvas(width, height);
       }
       throw new Error("Unsupported environment for canvas creation.");

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import { BinaryData, PDFDocumentProxy, DocumentInitParameters } from './types/src/display/api';
+import * as canvas from 'canvas';
 import * as _PDFJS from './types/src/pdf';
 
 declare function getMeta$1(data: BinaryData | PDFDocumentProxy): Promise<{
@@ -15,6 +16,7 @@ declare function extractText$1(data: BinaryData | PDFDocumentProxy, options?: {
 
 declare function extractImages$1(data: BinaryData | PDFDocumentProxy, pageNumber: number): Promise<Uint8ClampedArray[]>;
 declare function renderPageAsImage$1(data: BinaryData | PDFDocumentProxy, pageNumber: number, options?: {
+    canvas?: () => Promise<typeof canvas>;
     /** @default 1 */
     scale?: number;
     width?: number;

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { BinaryData, PDFDocumentProxy, DocumentInitParameters } from './types/src/display/api';
+import * as canvas from 'canvas';
 import * as _PDFJS from './types/src/pdf';
 
 declare function getMeta$1(data: BinaryData | PDFDocumentProxy): Promise<{
@@ -15,6 +16,7 @@ declare function extractText$1(data: BinaryData | PDFDocumentProxy, options?: {
 
 declare function extractImages$1(data: BinaryData | PDFDocumentProxy, pageNumber: number): Promise<Uint8ClampedArray[]>;
 declare function renderPageAsImage$1(data: BinaryData | PDFDocumentProxy, pageNumber: number, options?: {
+    canvas?: () => Promise<typeof canvas>;
     /** @default 1 */
     scale?: number;
     width?: number;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { BinaryData, PDFDocumentProxy, DocumentInitParameters } from './types/src/display/api';
+import * as canvas from 'canvas';
 import * as _PDFJS from './types/src/pdf';
 
 declare function getMeta$1(data: BinaryData | PDFDocumentProxy): Promise<{
@@ -15,6 +16,7 @@ declare function extractText$1(data: BinaryData | PDFDocumentProxy, options?: {
 
 declare function extractImages$1(data: BinaryData | PDFDocumentProxy, pageNumber: number): Promise<Uint8ClampedArray[]>;
 declare function renderPageAsImage$1(data: BinaryData | PDFDocumentProxy, pageNumber: number, options?: {
+    canvas?: () => Promise<typeof canvas>;
     /** @default 1 */
     scale?: number;
     width?: number;

package/dist/index.mjs

@@ -114,7 +114,7 @@ async function renderPageAsImage$1(data, pageNumber, options = {}) {
   if (outputScale !== 1 && outputScale > 0) {
     viewport = page.getViewport({ scale: outputScale });
   }
-  const canvasFactory = await createIsomorphicCanvasFactory();
+  const canvasFactory = await createIsomorphicCanvasFactory(options.canvas);
   const ctx = canvasFactory.create(viewport.width, viewport.height);
   await page.render({
     canvasContext: ctx.context,
@@ -124,25 +124,19 @@ async function renderPageAsImage$1(data, pageNumber, options = {}) {
   const response = await fetch(dataUrl);
   return await response.arrayBuffer();
 }
-async function createIsomorphicCanvasFactory() {
-  let _canvas;
-  if (isNode) {
-    try {
-      _canvas = await import('canvas');
-    } catch {
-      throw new Error(
-        'The "canvas" package is required when running in Node.js.'
-      );
-    }
-  }
+async function createIsomorphicCanvasFactory(canvas) {
+  const _canvas = await canvas?.();
   return {
     _createCanvas(width, height) {
       if (isBrowser) {
-        const canvas = document.createElement("canvas");
-        canvas.width = width;
-        canvas.height = height;
-        return canvas;
+        const canvas2 = document.createElement("canvas");
+        canvas2.width = width;
+        canvas2.height = height;
+        return canvas2;
       } else if (isNode) {
+        if (!_canvas) {
+          throw new Error('Failed to resolve "canvas" package.');
+        }
         return _canvas.createCanvas(width, height);
       }
       throw new Error("Unsupported environment for canvas creation.");