unpdf 0.10.1 → 0.12.0

package/README.md

@@ -16,8 +16,7 @@ This library is also intended as a modern alternative to the unmaintained but st
 
 ## PDF.js Compatibility
 
-> [!NOTE]
-> This package is currently using PDF.js v4.0.189.
+The serverless build of PDF.js provided by `unpdf` is based on PDF.js v4.6.82. If you need a different version, you can [use another PDF.js build](#use-official-or-legacy-pdfjs-build).
 
 ## Installation
 
@@ -50,7 +49,7 @@ const buffer = await fetch(
 const buffer = await readFile("./dummy.pdf");
 
 // Load PDF from buffer
-const pdf = await getDocumentProxy(new Uint8Array(pdf));
+const pdf = await getDocumentProxy(new Uint8Array(buffer));
 // Extract text from PDF
 const { totalPages, text } = await extractText(pdf, { mergePages: true });
 ```
@@ -86,12 +85,15 @@ for (let i = 1; i <= doc.numPages; i++) {
 
 Generally speaking, 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]
+> The latest PDF.js v4.6.82 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.
+
 ```ts
 // Before using any other method, define the PDF.js module
 // if you need another PDF.js build
 import { configureUnPDF } from "unpdf";
 
-configureUnPDF({
+await configureUnPDF({
   // Use the official PDF.js build (make sure to install it first)
   pdfjs: () => import("pdfjs-dist"),
 });
@@ -138,7 +140,9 @@ function getResolvedPDFJS(): Promise<PDFJS>;
 ### `getMeta`
 
 ```ts
-function getMeta(data: BinaryData | PDFDocumentProxy): Promise<{
+function getMeta(
+  data: DocumentInitParameters["data"] | PDFDocumentProxy,
+): Promise<{
   info: Record<string, any>;
   metadata: Record<string, any>;
 }>;
@@ -150,7 +154,7 @@ Extracts all text from a PDF. If `mergePages` is set to `true`, the text of all
 
 ```ts
 function extractText(
-  data: BinaryData | PDFDocumentProxy,
+  data: DocumentInitParameters["data"] | PDFDocumentProxy,
   { mergePages }?: { mergePages?: boolean },
 ): Promise<{
   totalPages: number;
@@ -175,7 +179,7 @@ In order to use this method, you have to meet the following requirements:
 ```ts
 import { configureUnPDF, renderPageAsImage } from "unpdf";
 
-configureUnPDF({
+await configureUnPDF({
   // Use the official PDF.js build
   pdfjs: () => import("pdfjs-dist"),
 });
@@ -194,7 +198,7 @@ await writeFile("dummy-page-1.png", Buffer.from(result));
 
 ```ts
 declare function renderPageAsImage(
-  data: BinaryData,
+  data: DocumentInitParameters["data"],
   pageNumber: number,
   options?: {
     canvas?: () => Promise<typeof import("canvas")>;

package/dist/index.cjs

@@ -31,16 +31,18 @@ async function resolvePDFJSImports(pdfjsResolver, { force = false } = {}) {
         resolvedModule = await resolvedModule.resolvePDFJS();
       }
       return;
-    } catch {
+    } catch (error) {
+      console.error(error);
       throw new Error(
         "Resolving failed. Please check the provided configuration."
       );
     }
   }
   try {
-    const { resolvePDFJS } = await import('unpdf/pdfjs');
+    const { resolvePDFJS } = await Promise.resolve().then(function () { return pdfjs; });
     resolvedModule = await resolvePDFJS();
-  } catch {
+  } catch (error) {
+    console.error(error);
     throw new Error(
       "PDF.js is not available. Please add the package as a dependency."
     );
@@ -69,20 +71,15 @@ async function extractText$1(data, options = {}) {
   const texts = await Promise.all(
     Array.from({ length: pdf.numPages }, (_, i) => getPageText(pdf, i + 1))
   );
-  const filteredTexts = texts.filter(Boolean);
   return {
     totalPages: pdf.numPages,
-    text: mergePages ? filteredTexts.join("\n\n") : filteredTexts
+    text: mergePages ? texts.join("\n").replace(/\s+/g, " ") : texts
   };
 }
-async function getPageText(pdf, pageNumber) {
-  const page = await pdf.getPage(pageNumber);
+async function getPageText(document, pageNumber) {
+  const page = await document.getPage(pageNumber);
   const content = await page.getTextContent();
-  const items = content.items;
-  if (items.length === 0) {
-    return;
-  }
-  return items.map(({ str }) => str).join("\n");
+  return content.items.filter((item) => item.str != null).map((item) => item.str + (item.hasEOL ? "\n" : "")).join("");
 }
 
 async function extractImages$1(data, pageNumber) {
@@ -109,7 +106,7 @@ async function extractImages$1(data, pageNumber) {
 }
 async function renderPageAsImage$1(data, pageNumber, options = {}) {
   const canvasFactory = await createIsomorphicCanvasFactory(options.canvas);
-  const pdf = await getDocumentProxy(data, { canvasFactory });
+  const pdf = isPDFDocumentProxy(data) ? data : await getDocumentProxy(data, { canvasFactory });
   const page = await pdf.getPage(pageNumber);
   if (pageNumber < 1 || pageNumber > pdf.numPages) {
     throw new Error(
@@ -187,7 +184,6 @@ async function configureUnPDF(options) {
   }
 }
 
-const defineUnPDFConfig = configureUnPDF;
 const getMeta = async (...args) => {
   await resolvePDFJSImports();
   return await getMeta$1(...args);
@@ -205,8 +201,12 @@ const renderPageAsImage = async (...args) => {
   return await renderPageAsImage$1(...args);
 };
 
+const pdfjs = {
+  __proto__: null
+};
+
 exports.configureUnPDF = configureUnPDF;
-exports.defineUnPDFConfig = defineUnPDFConfig;
+exports.createIsomorphicCanvasFactory = createIsomorphicCanvasFactory;
 exports.extractImages = extractImages;
 exports.extractText = extractText;
 exports.getDocumentProxy = getDocumentProxy;

package/dist/index.d.cts

@@ -1,27 +1,49 @@
-import { BinaryData, PDFDocumentProxy, DocumentInitParameters } from './types/src/display/api';
+import { DocumentInitParameters, PDFDocumentProxy } from './types/src/display/api';
 import * as canvas from 'canvas';
+import { Canvas } from 'canvas';
 import * as _PDFJS from './types/src/pdf';
 
-declare function getMeta$1(data: BinaryData | PDFDocumentProxy): Promise<{
+declare function getMeta$1(data: DocumentInitParameters["data"] | PDFDocumentProxy): Promise<{
     info: Record<string, any>;
     metadata: Record<string, any>;
 }>;
 
-declare function extractText$1(data: BinaryData | PDFDocumentProxy, options?: {
-    mergePages?: boolean;
+declare function extractText$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, options?: {
+    mergePages?: false;
 }): Promise<{
     totalPages: number;
-    text: string | string[];
+    text: string[];
+}>;
+declare function extractText$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, options: {
+    mergePages: true;
+}): Promise<{
+    totalPages: number;
+    text: string;
 }>;
 
-declare function extractImages$1(data: BinaryData | PDFDocumentProxy, pageNumber: number): Promise<Uint8ClampedArray[]>;
-declare function renderPageAsImage$1(data: BinaryData, pageNumber: number, options?: {
+declare function extractImages$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, pageNumber: number): Promise<Uint8ClampedArray[]>;
+declare function renderPageAsImage$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, pageNumber: number, options?: {
     canvas?: () => Promise<typeof canvas>;
     /** @default 1 */
     scale?: number;
     width?: number;
     height?: number;
 }): Promise<ArrayBuffer>;
+declare function createIsomorphicCanvasFactory(canvas?: () => Promise<typeof canvas>): Promise<{
+    _createCanvas(width: number, height: number): Canvas | HTMLCanvasElement;
+    create(width: number, height: number): {
+        canvas: Canvas | HTMLCanvasElement;
+        context: CanvasRenderingContext2D;
+    };
+    reset(ctx: {
+        canvas?: Canvas;
+        context?: CanvasRenderingContext2D;
+    }, width: number, height: number): void;
+    destroy(ctx: {
+        canvas?: Canvas;
+        context?: CanvasRenderingContext2D;
+    }): void;
+}>;
 
 type PDFJS = typeof _PDFJS;
 interface UnPDFConfiguration {
@@ -37,8 +59,6 @@ interface UnPDFConfiguration {
     pdfjs?: () => Promise<any>;
 }
 
-declare function configureUnPDF(options: UnPDFConfiguration): Promise<void>;
-
 /**
  * Returns a PDFDocumentProxy instance from a given binary data.
  *
@@ -46,18 +66,17 @@ declare function configureUnPDF(options: UnPDFConfiguration): Promise<void>;
  * - `isEvalSupported: false`
  * - `useSystemFonts: true`
  */
-declare function getDocumentProxy(data: BinaryData, options?: DocumentInitParameters): Promise<PDFDocumentProxy>;
+declare function getDocumentProxy(data: DocumentInitParameters["data"], options?: DocumentInitParameters): Promise<PDFDocumentProxy>;
 declare function getResolvedPDFJS(): Promise<PDFJS>;
 declare function resolvePDFJSImports(pdfjsResolver?: () => Promise<any>, { force }?: {
     force?: boolean | undefined;
 }): Promise<void>;
 
-/** @deprecated Use `configureUnPDF` instead */
-declare const defineUnPDFConfig: typeof configureUnPDF;
+declare function configureUnPDF(options: UnPDFConfiguration): Promise<void>;
 
 declare const getMeta: typeof getMeta$1;
 declare const extractText: typeof extractText$1;
 declare const extractImages: typeof extractImages$1;
 declare const renderPageAsImage: typeof renderPageAsImage$1;
 
-export { configureUnPDF, defineUnPDFConfig, extractImages, extractText, getDocumentProxy, getMeta, getResolvedPDFJS, renderPageAsImage, resolvePDFJSImports };
+export { configureUnPDF, createIsomorphicCanvasFactory, extractImages, extractText, getDocumentProxy, getMeta, getResolvedPDFJS, renderPageAsImage, resolvePDFJSImports };

package/dist/index.d.mts

@@ -1,27 +1,49 @@
-import { BinaryData, PDFDocumentProxy, DocumentInitParameters } from './types/src/display/api';
+import { DocumentInitParameters, PDFDocumentProxy } from './types/src/display/api';
 import * as canvas from 'canvas';
+import { Canvas } from 'canvas';
 import * as _PDFJS from './types/src/pdf';
 
-declare function getMeta$1(data: BinaryData | PDFDocumentProxy): Promise<{
+declare function getMeta$1(data: DocumentInitParameters["data"] | PDFDocumentProxy): Promise<{
     info: Record<string, any>;
     metadata: Record<string, any>;
 }>;
 
-declare function extractText$1(data: BinaryData | PDFDocumentProxy, options?: {
-    mergePages?: boolean;
+declare function extractText$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, options?: {
+    mergePages?: false;
 }): Promise<{
     totalPages: number;
-    text: string | string[];
+    text: string[];
+}>;
+declare function extractText$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, options: {
+    mergePages: true;
+}): Promise<{
+    totalPages: number;
+    text: string;
 }>;
 
-declare function extractImages$1(data: BinaryData | PDFDocumentProxy, pageNumber: number): Promise<Uint8ClampedArray[]>;
-declare function renderPageAsImage$1(data: BinaryData, pageNumber: number, options?: {
+declare function extractImages$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, pageNumber: number): Promise<Uint8ClampedArray[]>;
+declare function renderPageAsImage$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, pageNumber: number, options?: {
     canvas?: () => Promise<typeof canvas>;
     /** @default 1 */
     scale?: number;
     width?: number;
     height?: number;
 }): Promise<ArrayBuffer>;
+declare function createIsomorphicCanvasFactory(canvas?: () => Promise<typeof canvas>): Promise<{
+    _createCanvas(width: number, height: number): Canvas | HTMLCanvasElement;
+    create(width: number, height: number): {
+        canvas: Canvas | HTMLCanvasElement;
+        context: CanvasRenderingContext2D;
+    };
+    reset(ctx: {
+        canvas?: Canvas;
+        context?: CanvasRenderingContext2D;
+    }, width: number, height: number): void;
+    destroy(ctx: {
+        canvas?: Canvas;
+        context?: CanvasRenderingContext2D;
+    }): void;
+}>;
 
 type PDFJS = typeof _PDFJS;
 interface UnPDFConfiguration {
@@ -37,8 +59,6 @@ interface UnPDFConfiguration {
     pdfjs?: () => Promise<any>;
 }
 
-declare function configureUnPDF(options: UnPDFConfiguration): Promise<void>;
-
 /**
  * Returns a PDFDocumentProxy instance from a given binary data.
  *
@@ -46,18 +66,17 @@ declare function configureUnPDF(options: UnPDFConfiguration): Promise<void>;
  * - `isEvalSupported: false`
  * - `useSystemFonts: true`
  */
-declare function getDocumentProxy(data: BinaryData, options?: DocumentInitParameters): Promise<PDFDocumentProxy>;
+declare function getDocumentProxy(data: DocumentInitParameters["data"], options?: DocumentInitParameters): Promise<PDFDocumentProxy>;
 declare function getResolvedPDFJS(): Promise<PDFJS>;
 declare function resolvePDFJSImports(pdfjsResolver?: () => Promise<any>, { force }?: {
     force?: boolean | undefined;
 }): Promise<void>;
 
-/** @deprecated Use `configureUnPDF` instead */
-declare const defineUnPDFConfig: typeof configureUnPDF;
+declare function configureUnPDF(options: UnPDFConfiguration): Promise<void>;
 
 declare const getMeta: typeof getMeta$1;
 declare const extractText: typeof extractText$1;
 declare const extractImages: typeof extractImages$1;
 declare const renderPageAsImage: typeof renderPageAsImage$1;
 
-export { configureUnPDF, defineUnPDFConfig, extractImages, extractText, getDocumentProxy, getMeta, getResolvedPDFJS, renderPageAsImage, resolvePDFJSImports };
+export { configureUnPDF, createIsomorphicCanvasFactory, extractImages, extractText, getDocumentProxy, getMeta, getResolvedPDFJS, renderPageAsImage, resolvePDFJSImports };

package/dist/index.d.ts

@@ -1,27 +1,49 @@
-import { BinaryData, PDFDocumentProxy, DocumentInitParameters } from './types/src/display/api';
+import { DocumentInitParameters, PDFDocumentProxy } from './types/src/display/api';
 import * as canvas from 'canvas';
+import { Canvas } from 'canvas';
 import * as _PDFJS from './types/src/pdf';
 
-declare function getMeta$1(data: BinaryData | PDFDocumentProxy): Promise<{
+declare function getMeta$1(data: DocumentInitParameters["data"] | PDFDocumentProxy): Promise<{
     info: Record<string, any>;
     metadata: Record<string, any>;
 }>;
 
-declare function extractText$1(data: BinaryData | PDFDocumentProxy, options?: {
-    mergePages?: boolean;
+declare function extractText$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, options?: {
+    mergePages?: false;
 }): Promise<{
     totalPages: number;
-    text: string | string[];
+    text: string[];
+}>;
+declare function extractText$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, options: {
+    mergePages: true;
+}): Promise<{
+    totalPages: number;
+    text: string;
 }>;
 
-declare function extractImages$1(data: BinaryData | PDFDocumentProxy, pageNumber: number): Promise<Uint8ClampedArray[]>;
-declare function renderPageAsImage$1(data: BinaryData, pageNumber: number, options?: {
+declare function extractImages$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, pageNumber: number): Promise<Uint8ClampedArray[]>;
+declare function renderPageAsImage$1(data: DocumentInitParameters["data"] | PDFDocumentProxy, pageNumber: number, options?: {
     canvas?: () => Promise<typeof canvas>;
     /** @default 1 */
     scale?: number;
     width?: number;
     height?: number;
 }): Promise<ArrayBuffer>;
+declare function createIsomorphicCanvasFactory(canvas?: () => Promise<typeof canvas>): Promise<{
+    _createCanvas(width: number, height: number): Canvas | HTMLCanvasElement;
+    create(width: number, height: number): {
+        canvas: Canvas | HTMLCanvasElement;
+        context: CanvasRenderingContext2D;
+    };
+    reset(ctx: {
+        canvas?: Canvas;
+        context?: CanvasRenderingContext2D;
+    }, width: number, height: number): void;
+    destroy(ctx: {
+        canvas?: Canvas;
+        context?: CanvasRenderingContext2D;
+    }): void;
+}>;
 
 type PDFJS = typeof _PDFJS;
 interface UnPDFConfiguration {
@@ -37,8 +59,6 @@ interface UnPDFConfiguration {
     pdfjs?: () => Promise<any>;
 }
 
-declare function configureUnPDF(options: UnPDFConfiguration): Promise<void>;
-
 /**
  * Returns a PDFDocumentProxy instance from a given binary data.
  *
@@ -46,18 +66,17 @@ declare function configureUnPDF(options: UnPDFConfiguration): Promise<void>;
  * - `isEvalSupported: false`
  * - `useSystemFonts: true`
  */
-declare function getDocumentProxy(data: BinaryData, options?: DocumentInitParameters): Promise<PDFDocumentProxy>;
+declare function getDocumentProxy(data: DocumentInitParameters["data"], options?: DocumentInitParameters): Promise<PDFDocumentProxy>;
 declare function getResolvedPDFJS(): Promise<PDFJS>;
 declare function resolvePDFJSImports(pdfjsResolver?: () => Promise<any>, { force }?: {
     force?: boolean | undefined;
 }): Promise<void>;
 
-/** @deprecated Use `configureUnPDF` instead */
-declare const defineUnPDFConfig: typeof configureUnPDF;
+declare function configureUnPDF(options: UnPDFConfiguration): Promise<void>;
 
 declare const getMeta: typeof getMeta$1;
 declare const extractText: typeof extractText$1;
 declare const extractImages: typeof extractImages$1;
 declare const renderPageAsImage: typeof renderPageAsImage$1;
 
-export { configureUnPDF, defineUnPDFConfig, extractImages, extractText, getDocumentProxy, getMeta, getResolvedPDFJS, renderPageAsImage, resolvePDFJSImports };
+export { configureUnPDF, createIsomorphicCanvasFactory, extractImages, extractText, getDocumentProxy, getMeta, getResolvedPDFJS, renderPageAsImage, resolvePDFJSImports };

package/dist/index.mjs

@@ -29,16 +29,18 @@ async function resolvePDFJSImports(pdfjsResolver, { force = false } = {}) {
         resolvedModule = await resolvedModule.resolvePDFJS();
       }
       return;
-    } catch {
+    } catch (error) {
+      console.error(error);
       throw new Error(
         "Resolving failed. Please check the provided configuration."
       );
     }
   }
   try {
-    const { resolvePDFJS } = await import('unpdf/pdfjs');
+    const { resolvePDFJS } = await Promise.resolve().then(function () { return pdfjs; });
     resolvedModule = await resolvePDFJS();
-  } catch {
+  } catch (error) {
+    console.error(error);
     throw new Error(
       "PDF.js is not available. Please add the package as a dependency."
     );
@@ -67,20 +69,15 @@ async function extractText$1(data, options = {}) {
   const texts = await Promise.all(
     Array.from({ length: pdf.numPages }, (_, i) => getPageText(pdf, i + 1))
   );
-  const filteredTexts = texts.filter(Boolean);
   return {
     totalPages: pdf.numPages,
-    text: mergePages ? filteredTexts.join("\n\n") : filteredTexts
+    text: mergePages ? texts.join("\n").replace(/\s+/g, " ") : texts
   };
 }
-async function getPageText(pdf, pageNumber) {
-  const page = await pdf.getPage(pageNumber);
+async function getPageText(document, pageNumber) {
+  const page = await document.getPage(pageNumber);
   const content = await page.getTextContent();
-  const items = content.items;
-  if (items.length === 0) {
-    return;
-  }
-  return items.map(({ str }) => str).join("\n");
+  return content.items.filter((item) => item.str != null).map((item) => item.str + (item.hasEOL ? "\n" : "")).join("");
 }
 
 async function extractImages$1(data, pageNumber) {
@@ -107,7 +104,7 @@ async function extractImages$1(data, pageNumber) {
 }
 async function renderPageAsImage$1(data, pageNumber, options = {}) {
   const canvasFactory = await createIsomorphicCanvasFactory(options.canvas);
-  const pdf = await getDocumentProxy(data, { canvasFactory });
+  const pdf = isPDFDocumentProxy(data) ? data : await getDocumentProxy(data, { canvasFactory });
   const page = await pdf.getPage(pageNumber);
   if (pageNumber < 1 || pageNumber > pdf.numPages) {
     throw new Error(
@@ -185,7 +182,6 @@ async function configureUnPDF(options) {
   }
 }
 
-const defineUnPDFConfig = configureUnPDF;
 const getMeta = async (...args) => {
   await resolvePDFJSImports();
   return await getMeta$1(...args);
@@ -203,4 +199,8 @@ const renderPageAsImage = async (...args) => {
   return await renderPageAsImage$1(...args);
 };
 
-export { configureUnPDF, defineUnPDFConfig, extractImages, extractText, getDocumentProxy, getMeta, getResolvedPDFJS, renderPageAsImage, resolvePDFJSImports };
+const pdfjs = {
+  __proto__: null
+};
+
+export { configureUnPDF, createIsomorphicCanvasFactory, extractImages, extractText, getDocumentProxy, getMeta, getResolvedPDFJS, renderPageAsImage, resolvePDFJSImports };

package/dist/pdfjs.d.mts

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