unpdf 1.1.0 → 1.2.1

package/README.md

@@ -18,7 +18,7 @@ This library is also intended as a modern alternative to the unmaintained but st
 ## PDF.js Compatibility
 
 > [!Tip]
-> The serverless PDF.js bundle provided by `unpdf` is built from PDF.js v5.2.133.
+> The serverless PDF.js bundle provided by `unpdf` is built from PDF.js v5.4.54.
 
 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.
 
@@ -273,7 +273,7 @@ extractPdfImages().catch(console.error)
 
 ### `renderPageAsImage`
 
-To render a PDF page as an image, you can use the `renderPageAsImage` method. This method will return an `ArrayBuffer` of the rendered image.
+To render a PDF page as an image, you can use the `renderPageAsImage` method. This method will return an `ArrayBuffer` of the rendered image. It can also return a data URL (`string`) if `toDataURL` option is set to `true`.
 
 > [!NOTE]
 > This method will only work in Node.js and browser environments.
@@ -286,8 +286,8 @@ In order to use this method, make sure to meet the following requirements:
 **Type Declaration**
 
 ```ts
-declare function renderPageAsImage(
-  data: DocumentInitParameters['data'],
+function renderPageAsImage(
+  data: DocumentInitParameters['data'] | PDFDocumentProxy,
   pageNumber: number,
   options?: {
     canvasImport?: () => Promise<typeof import('@napi-rs/canvas')>
@@ -295,11 +295,24 @@ declare function renderPageAsImage(
     scale?: number
     width?: number
     height?: number
+    toDataURL?: false
   },
 ): Promise<ArrayBuffer>
+function renderPageAsImage(
+  data: DocumentInitParameters['data'] | PDFDocumentProxy,
+  pageNumber: number,
+  options: {
+    canvasImport?: () => Promise<typeof import('@napi-rs/canvas')>
+    /** @default 1.0 */
+    scale?: number
+    width?: number
+    height?: number
+    toDataURL: true
+  },
+): Promise<string>
 ```
 
-**Example**
+**Examples**
 
 ```ts
 import { definePDFJSModule, renderPageAsImage } from 'unpdf'
@@ -318,6 +331,36 @@ const result = await renderPageAsImage(buffer, pageNumber, {
 await writeFile('dummy-page-1.png', new Uint8Array(result))
 ```
 
+```ts
+import { definePDFJSModule, renderPageAsImage } from 'unpdf'
+
+await definePDFJSModule(() => import('pdfjs-dist'))
+
+const pdf = await readFile('./dummy.pdf')
+const buffer = new Uint8Array(pdf)
+const pageNumber = 1
+
+const result = await renderPageAsImage(buffer, pageNumber, {
+  canvasImport: () => import('@napi-rs/canvas'),
+  scale: 2,
+  toDataURL: true,
+})
+
+const html = `<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Dummy Page</title>
+  </head>
+  <body>
+    <img alt="Example Page" src="${result}">
+  </body>
+</html>`
+
+await writeFile('dummy-page-1.html', html)
+```
+
 ## License
 
 [MIT](./LICENSE) License © 2023-PRESENT [Johann Schopplich](https://github.com/johannschopplich)

package/dist/index.cjs

@@ -182,10 +182,14 @@ async function renderPageAsImage$1(data, pageNumber, options = {}) {
   const viewport = page.getViewport({ scale: Math.max(0, scale) });
   const drawingContext = new CanvasFactory().create(viewport.width, viewport.height);
   await page.render({
+    canvas: drawingContext.canvas,
     canvasContext: drawingContext.context,
     viewport
   }).promise;
   const dataUrl = drawingContext.canvas.toDataURL();
+  if (options.toDataURL) {
+    return dataUrl;
+  }
   const response = await fetch(dataUrl);
   return await response.arrayBuffer();
 }

package/dist/index.d.cts

@@ -32,7 +32,16 @@ declare function renderPageAsImage$1(data: DocumentInitParameters['data'] | PDFD
     scale?: number;
     width?: number;
     height?: number;
+    toDataURL?: false;
 }): Promise<ArrayBuffer>;
+declare function renderPageAsImage$1(data: DocumentInitParameters['data'] | PDFDocumentProxy, pageNumber: number, options: {
+    canvasImport?: () => Promise<typeof _napi_rs_canvas>;
+    /** @default 1.0 */
+    scale?: number;
+    width?: number;
+    height?: number;
+    toDataURL: true;
+}): Promise<string>;
 
 declare function extractLinks$1(data: DocumentInitParameters['data'] | PDFDocumentProxy): Promise<{
     totalPages: number;

package/dist/index.d.mts

@@ -32,7 +32,16 @@ declare function renderPageAsImage$1(data: DocumentInitParameters['data'] | PDFD
     scale?: number;
     width?: number;
     height?: number;
+    toDataURL?: false;
 }): Promise<ArrayBuffer>;
+declare function renderPageAsImage$1(data: DocumentInitParameters['data'] | PDFDocumentProxy, pageNumber: number, options: {
+    canvasImport?: () => Promise<typeof _napi_rs_canvas>;
+    /** @default 1.0 */
+    scale?: number;
+    width?: number;
+    height?: number;
+    toDataURL: true;
+}): Promise<string>;
 
 declare function extractLinks$1(data: DocumentInitParameters['data'] | PDFDocumentProxy): Promise<{
     totalPages: number;

package/dist/index.d.ts

@@ -32,7 +32,16 @@ declare function renderPageAsImage$1(data: DocumentInitParameters['data'] | PDFD
     scale?: number;
     width?: number;
     height?: number;
+    toDataURL?: false;
 }): Promise<ArrayBuffer>;
+declare function renderPageAsImage$1(data: DocumentInitParameters['data'] | PDFDocumentProxy, pageNumber: number, options: {
+    canvasImport?: () => Promise<typeof _napi_rs_canvas>;
+    /** @default 1.0 */
+    scale?: number;
+    width?: number;
+    height?: number;
+    toDataURL: true;
+}): Promise<string>;
 
 declare function extractLinks$1(data: DocumentInitParameters['data'] | PDFDocumentProxy): Promise<{
     totalPages: number;

package/dist/index.mjs

@@ -180,10 +180,14 @@ async function renderPageAsImage$1(data, pageNumber, options = {}) {
   const viewport = page.getViewport({ scale: Math.max(0, scale) });
   const drawingContext = new CanvasFactory().create(viewport.width, viewport.height);
   await page.render({
+    canvas: drawingContext.canvas,
     canvasContext: drawingContext.context,
     viewport
   }).promise;
   const dataUrl = drawingContext.canvas.toDataURL();
+  if (options.toDataURL) {
+    return dataUrl;
+  }
   const response = await fetch(dataUrl);
   return await response.arrayBuffer();
 }