unpdf 0.4.1 → 0.5.0

package/README.md

@@ -10,7 +10,7 @@ This library is also intended as a modern alternative to the unmaintained [`pdf-
 
 - 🏗️ Conditional exports for Browser, Node and worker environments
 - 💬 Extract text from PDFs
-- 🧱 Use custom PDF.js build
+- 🧱 Opt-in to legacy PDF.js build
 
 ## Installation
 
@@ -30,15 +30,31 @@ yarn add -D unpdf
 ## Usage
 
 ```ts
-import { decodePDFText } from 'unpdf'
+import { extractPDFText } from 'unpdf'
 
-const pdfBuffer = await fetch('https://example.com/file.pdf').then(res => res.arrayBuffer())
+const pdfBuffer = await fetch('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf')
+  .then(res => res.arrayBuffer())
 
-const { totalPages, info, metadata, text } = await decodePDFText(
+const { totalPages, text } = await extractPDFText(
   new Uint8Array(pdfBuffer), { mergePages: true }
 )
 ```
 
+### Use Legacy Or Custom PDF.js Build
+
+```ts
+// Before using any other methods, define the PDF.js module
+import { defineUnPDFConfig } from 'unpdf'
+
+// Use the legacy build
+defineUnPDFConfig({
+  pdfjs: () => import('pdfjs-dist/legacy/build/pdf.js')
+})
+
+// Now, you can use the other methods
+// …
+```
+
 ## Config
 
 ```ts
@@ -63,20 +79,25 @@ interface UnPDFConfiguration {
 function defineUnPDFConfig({ pdfjs }: UnPDFConfiguration): Promise<void>
 ```
 
-### `decodePDFText`
+### `getPDFMeta`
 
 ```ts
-interface PDFContent {
-  totalPages: number
-  info?: Record<string, any>
-  metadata?: any
-  text: string | string[]
-}
+function getPDFMeta(data: ArrayBuffer): Promise<{
+  info: Record<string, any>
+  metadata: any
+}>
+```
+
+### `extractPDFText`
 
-function decodePDFText(
+```ts
+function extractPDFText(
   data: ArrayBuffer,
   { mergePages }?: { mergePages?: boolean }
-): Promise<PDFContent>
+): Promise<{
+  totalPages: number
+  text: string | string[]
+}>
 ```
 
 ### `getImagesFromPage`

package/dist/index.node.cjs

@@ -1,11 +1,15 @@
 'use strict';
 
-const image = require('./shared/unpdf.ff73f2a9.cjs');
+const image = require('./shared/unpdf.e023f326.cjs');
 const utils = require('./shared/unpdf.54007d6f.cjs');
 
-const decodePDFText = async (...args) => {
+const getPDFMeta = async (...args) => {
   await utils.resolvePDFJSImports();
-  return await image.decodePDFText(...args);
+  return await image.getPDFMeta(...args);
+};
+const extractPDFText = async (...args) => {
+  await utils.resolvePDFJSImports();
+  return await image.extractPDFText(...args);
 };
 const getImagesFromPage = async (...args) => {
   await utils.resolvePDFJSImports();
@@ -13,5 +17,6 @@ const getImagesFromPage = async (...args) => {
 };
 
 exports.defineUnPDFConfig = utils.defineUnPDFConfig;
-exports.decodePDFText = decodePDFText;
+exports.extractPDFText = extractPDFText;
 exports.getImagesFromPage = getImagesFromPage;
+exports.getPDFMeta = getPDFMeta;

package/dist/index.node.d.cts

@@ -1,8 +1,9 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.72be7352.cjs';
-export { a as defineUnPDFConfig } from './shared/unpdf.72be7352.cjs';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.842960e8.cjs';
+export { d as defineUnPDFConfig } from './shared/unpdf.842960e8.cjs';
 import 'pdfjs-dist';
 
-declare const decodePDFText: typeof decodePDFText$1;
+declare const getPDFMeta: typeof getPDFMeta$1;
+declare const extractPDFText: typeof extractPDFText$1;
 declare const getImagesFromPage: typeof getImagesFromPage$1;
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.node.d.mts

@@ -1,8 +1,9 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.72be7352.mjs';
-export { a as defineUnPDFConfig } from './shared/unpdf.72be7352.mjs';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.842960e8.mjs';
+export { d as defineUnPDFConfig } from './shared/unpdf.842960e8.mjs';
 import 'pdfjs-dist';
 
-declare const decodePDFText: typeof decodePDFText$1;
+declare const getPDFMeta: typeof getPDFMeta$1;
+declare const extractPDFText: typeof extractPDFText$1;
 declare const getImagesFromPage: typeof getImagesFromPage$1;
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.node.d.ts

@@ -1,8 +1,9 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.72be7352.js';
-export { a as defineUnPDFConfig } from './shared/unpdf.72be7352.js';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.842960e8.js';
+export { d as defineUnPDFConfig } from './shared/unpdf.842960e8.js';
 import 'pdfjs-dist';
 
-declare const decodePDFText: typeof decodePDFText$1;
+declare const getPDFMeta: typeof getPDFMeta$1;
+declare const extractPDFText: typeof extractPDFText$1;
 declare const getImagesFromPage: typeof getImagesFromPage$1;
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.node.mjs

@@ -1,14 +1,18 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.0f3aa1eb.mjs';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.0db47641.mjs';
 import { r as resolvePDFJSImports } from './shared/unpdf.5b4a24ed.mjs';
 export { d as defineUnPDFConfig } from './shared/unpdf.5b4a24ed.mjs';
 
-const decodePDFText = async (...args) => {
+const getPDFMeta = async (...args) => {
   await resolvePDFJSImports();
-  return await decodePDFText$1(...args);
+  return await getPDFMeta$1(...args);
+};
+const extractPDFText = async (...args) => {
+  await resolvePDFJSImports();
+  return await extractPDFText$1(...args);
 };
 const getImagesFromPage = async (...args) => {
   await resolvePDFJSImports();
   return await getImagesFromPage$1(...args);
 };
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.web.cjs

@@ -1,11 +1,15 @@
 'use strict';
 
-const image = require('./shared/unpdf.ff73f2a9.cjs');
+const image = require('./shared/unpdf.e023f326.cjs');
 const utils = require('./shared/unpdf.54007d6f.cjs');
 
-const decodePDFText = async (...args) => {
+const getPDFMeta = async (...args) => {
   await utils.resolvePDFJSImports();
-  return await image.decodePDFText(...args);
+  return await image.getPDFMeta(...args);
+};
+const extractPDFText = async (...args) => {
+  await utils.resolvePDFJSImports();
+  return await image.extractPDFText(...args);
 };
 const getImagesFromPage = async (...args) => {
   await utils.resolvePDFJSImports();
@@ -13,5 +17,6 @@ const getImagesFromPage = async (...args) => {
 };
 
 exports.defineUnPDFConfig = utils.defineUnPDFConfig;
-exports.decodePDFText = decodePDFText;
+exports.extractPDFText = extractPDFText;
 exports.getImagesFromPage = getImagesFromPage;
+exports.getPDFMeta = getPDFMeta;

package/dist/index.web.d.cts

@@ -1,8 +1,9 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.72be7352.cjs';
-export { a as defineUnPDFConfig } from './shared/unpdf.72be7352.cjs';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.842960e8.cjs';
+export { d as defineUnPDFConfig } from './shared/unpdf.842960e8.cjs';
 import 'pdfjs-dist';
 
-declare const decodePDFText: typeof decodePDFText$1;
+declare const getPDFMeta: typeof getPDFMeta$1;
+declare const extractPDFText: typeof extractPDFText$1;
 declare const getImagesFromPage: typeof getImagesFromPage$1;
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.web.d.mts

@@ -1,8 +1,9 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.72be7352.mjs';
-export { a as defineUnPDFConfig } from './shared/unpdf.72be7352.mjs';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.842960e8.mjs';
+export { d as defineUnPDFConfig } from './shared/unpdf.842960e8.mjs';
 import 'pdfjs-dist';
 
-declare const decodePDFText: typeof decodePDFText$1;
+declare const getPDFMeta: typeof getPDFMeta$1;
+declare const extractPDFText: typeof extractPDFText$1;
 declare const getImagesFromPage: typeof getImagesFromPage$1;
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.web.d.ts

@@ -1,8 +1,9 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.72be7352.js';
-export { a as defineUnPDFConfig } from './shared/unpdf.72be7352.js';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.842960e8.js';
+export { d as defineUnPDFConfig } from './shared/unpdf.842960e8.js';
 import 'pdfjs-dist';
 
-declare const decodePDFText: typeof decodePDFText$1;
+declare const getPDFMeta: typeof getPDFMeta$1;
+declare const extractPDFText: typeof extractPDFText$1;
 declare const getImagesFromPage: typeof getImagesFromPage$1;
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.web.mjs

@@ -1,14 +1,18 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.0f3aa1eb.mjs';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.0db47641.mjs';
 import { r as resolvePDFJSImports } from './shared/unpdf.5b4a24ed.mjs';
 export { d as defineUnPDFConfig } from './shared/unpdf.5b4a24ed.mjs';
 
-const decodePDFText = async (...args) => {
+const getPDFMeta = async (...args) => {
   await resolvePDFJSImports();
-  return await decodePDFText$1(...args);
+  return await getPDFMeta$1(...args);
+};
+const extractPDFText = async (...args) => {
+  await resolvePDFJSImports();
+  return await extractPDFText$1(...args);
 };
 const getImagesFromPage = async (...args) => {
   await resolvePDFJSImports();
   return await getImagesFromPage$1(...args);
 };
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.worker.cjs

@@ -2,7 +2,10 @@
 
 const utils = require('./shared/unpdf.54007d6f.cjs');
 
-const decodePDFText = async () => {
+const getPDFMeta = async () => {
+  throw new Error("Not implemented in worker context yet");
+};
+const extractPDFText = async () => {
   throw new Error("Not implemented in worker context yet");
 };
 const getImagesFromPage = async () => {
@@ -10,5 +13,6 @@ const getImagesFromPage = async () => {
 };
 
 exports.defineUnPDFConfig = utils.defineUnPDFConfig;
-exports.decodePDFText = decodePDFText;
+exports.extractPDFText = extractPDFText;
 exports.getImagesFromPage = getImagesFromPage;
+exports.getPDFMeta = getPDFMeta;

package/dist/index.worker.d.cts

@@ -1,8 +1,9 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.72be7352.cjs';
-export { a as defineUnPDFConfig } from './shared/unpdf.72be7352.cjs';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.842960e8.cjs';
+export { d as defineUnPDFConfig } from './shared/unpdf.842960e8.cjs';
 import 'pdfjs-dist';
 
-declare const decodePDFText: typeof decodePDFText$1;
+declare const getPDFMeta: typeof getPDFMeta$1;
+declare const extractPDFText: typeof extractPDFText$1;
 declare const getImagesFromPage: typeof getImagesFromPage$1;
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.worker.d.mts

@@ -1,8 +1,9 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.72be7352.mjs';
-export { a as defineUnPDFConfig } from './shared/unpdf.72be7352.mjs';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.842960e8.mjs';
+export { d as defineUnPDFConfig } from './shared/unpdf.842960e8.mjs';
 import 'pdfjs-dist';
 
-declare const decodePDFText: typeof decodePDFText$1;
+declare const getPDFMeta: typeof getPDFMeta$1;
+declare const extractPDFText: typeof extractPDFText$1;
 declare const getImagesFromPage: typeof getImagesFromPage$1;
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.worker.d.ts

@@ -1,8 +1,9 @@
-import { d as decodePDFText$1, g as getImagesFromPage$1 } from './shared/unpdf.72be7352.js';
-export { a as defineUnPDFConfig } from './shared/unpdf.72be7352.js';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.842960e8.js';
+export { d as defineUnPDFConfig } from './shared/unpdf.842960e8.js';
 import 'pdfjs-dist';
 
-declare const decodePDFText: typeof decodePDFText$1;
+declare const getPDFMeta: typeof getPDFMeta$1;
+declare const extractPDFText: typeof extractPDFText$1;
 declare const getImagesFromPage: typeof getImagesFromPage$1;
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/index.worker.mjs

@@ -1,10 +1,13 @@
 export { d as defineUnPDFConfig } from './shared/unpdf.5b4a24ed.mjs';
 
-const decodePDFText = async () => {
+const getPDFMeta = async () => {
+  throw new Error("Not implemented in worker context yet");
+};
+const extractPDFText = async () => {
   throw new Error("Not implemented in worker context yet");
 };
 const getImagesFromPage = async () => {
   throw new Error("Not implemented in worker context yet");
 };
 
-export { decodePDFText, getImagesFromPage };
+export { extractPDFText, getImagesFromPage, getPDFMeta };

package/dist/shared/{unpdf.0f3aa1eb.mjs → unpdf.0db47641.mjs}

@@ -1,16 +1,22 @@
 import { g as getDocumentProxy, a as getResolvedPDFJS } from './unpdf.5b4a24ed.mjs';
 
-async function decodePDFText(data, { mergePages = false } = {}) {
+async function getPDFMeta(data) {
   const pdf = await getDocumentProxy(data);
   const meta = await pdf.getMetadata().catch(() => null);
+  return {
+    info: meta?.info,
+    metadata: meta?.metadata?.getAll()
+  };
+}
+
+async function extractPDFText(data, { mergePages = false } = {}) {
+  const pdf = await getDocumentProxy(data);
   const texts = await Promise.all(
     Array.from({ length: pdf.numPages }, (_, i) => getPageText(pdf, i + 1))
   );
   const filteredTexts = texts.filter(Boolean);
   return {
     totalPages: pdf.numPages,
-    info: meta?.info,
-    metadata: meta?.metadata?.getAll(),
     text: mergePages ? filteredTexts.join("\n\n") : filteredTexts
   };
 }
@@ -39,4 +45,4 @@ async function getImagesFromPage(data, pageNumber) {
   return images;
 }
 
-export { decodePDFText as d, getImagesFromPage as g };
+export { getImagesFromPage as a, extractPDFText as e, getPDFMeta as g };

package/dist/shared/{unpdf.72be7352.d.cts → unpdf.842960e8.d.cts}

@@ -1,11 +1,19 @@
 import PDFJS from 'pdfjs-dist';
 
-interface PDFContent {
+declare function getPDFMeta(data: ArrayBuffer): Promise<{
+    info: Record<string, any>;
+    metadata: any;
+}>;
+
+declare function extractPDFText(data: ArrayBuffer, { mergePages }?: {
+    mergePages?: boolean;
+}): Promise<{
     totalPages: number;
-    info?: Record<string, any>;
-    metadata?: any;
     text: string | string[];
-}
+}>;
+
+declare function getImagesFromPage(data: ArrayBuffer, pageNumber: number): Promise<ArrayBuffer[]>;
+
 interface UnPDFConfiguration {
     /**
      * By default, UnPDF will use the latest version of PDF.js. If you want to
@@ -18,12 +26,6 @@ interface UnPDFConfiguration {
     pdfjs?: () => Promise<typeof PDFJS>;
 }
 
-declare function decodePDFText(data: ArrayBuffer, { mergePages }?: {
-    mergePages?: boolean;
-}): Promise<PDFContent>;
-
-declare function getImagesFromPage(data: ArrayBuffer, pageNumber: number): Promise<ArrayBuffer[]>;
-
 declare function defineUnPDFConfig({ pdfjs }: UnPDFConfiguration): Promise<void>;
 
-export { defineUnPDFConfig as a, decodePDFText as d, getImagesFromPage as g };
+export { getImagesFromPage as a, defineUnPDFConfig as d, extractPDFText as e, getPDFMeta as g };

package/dist/shared/{unpdf.72be7352.d.mts → unpdf.842960e8.d.mts}

@@ -1,11 +1,19 @@
 import PDFJS from 'pdfjs-dist';
 
-interface PDFContent {
+declare function getPDFMeta(data: ArrayBuffer): Promise<{
+    info: Record<string, any>;
+    metadata: any;
+}>;
+
+declare function extractPDFText(data: ArrayBuffer, { mergePages }?: {
+    mergePages?: boolean;
+}): Promise<{
     totalPages: number;
-    info?: Record<string, any>;
-    metadata?: any;
     text: string | string[];
-}
+}>;
+
+declare function getImagesFromPage(data: ArrayBuffer, pageNumber: number): Promise<ArrayBuffer[]>;
+
 interface UnPDFConfiguration {
     /**
      * By default, UnPDF will use the latest version of PDF.js. If you want to
@@ -18,12 +26,6 @@ interface UnPDFConfiguration {
     pdfjs?: () => Promise<typeof PDFJS>;
 }
 
-declare function decodePDFText(data: ArrayBuffer, { mergePages }?: {
-    mergePages?: boolean;
-}): Promise<PDFContent>;
-
-declare function getImagesFromPage(data: ArrayBuffer, pageNumber: number): Promise<ArrayBuffer[]>;
-
 declare function defineUnPDFConfig({ pdfjs }: UnPDFConfiguration): Promise<void>;
 
-export { defineUnPDFConfig as a, decodePDFText as d, getImagesFromPage as g };
+export { getImagesFromPage as a, defineUnPDFConfig as d, extractPDFText as e, getPDFMeta as g };

package/dist/shared/{unpdf.72be7352.d.ts → unpdf.842960e8.d.ts}

@@ -1,11 +1,19 @@
 import PDFJS from 'pdfjs-dist';
 
-interface PDFContent {
+declare function getPDFMeta(data: ArrayBuffer): Promise<{
+    info: Record<string, any>;
+    metadata: any;
+}>;
+
+declare function extractPDFText(data: ArrayBuffer, { mergePages }?: {
+    mergePages?: boolean;
+}): Promise<{
     totalPages: number;
-    info?: Record<string, any>;
-    metadata?: any;
     text: string | string[];
-}
+}>;
+
+declare function getImagesFromPage(data: ArrayBuffer, pageNumber: number): Promise<ArrayBuffer[]>;
+
 interface UnPDFConfiguration {
     /**
      * By default, UnPDF will use the latest version of PDF.js. If you want to
@@ -18,12 +26,6 @@ interface UnPDFConfiguration {
     pdfjs?: () => Promise<typeof PDFJS>;
 }
 
-declare function decodePDFText(data: ArrayBuffer, { mergePages }?: {
-    mergePages?: boolean;
-}): Promise<PDFContent>;
-
-declare function getImagesFromPage(data: ArrayBuffer, pageNumber: number): Promise<ArrayBuffer[]>;
-
 declare function defineUnPDFConfig({ pdfjs }: UnPDFConfiguration): Promise<void>;
 
-export { defineUnPDFConfig as a, decodePDFText as d, getImagesFromPage as g };
+export { getImagesFromPage as a, defineUnPDFConfig as d, extractPDFText as e, getPDFMeta as g };

package/dist/shared/{unpdf.ff73f2a9.cjs → unpdf.e023f326.cjs}

@@ -2,17 +2,23 @@
 
 const utils = require('./unpdf.54007d6f.cjs');
 
-async function decodePDFText(data, { mergePages = false } = {}) {
+async function getPDFMeta(data) {
   const pdf = await utils.getDocumentProxy(data);
   const meta = await pdf.getMetadata().catch(() => null);
+  return {
+    info: meta?.info,
+    metadata: meta?.metadata?.getAll()
+  };
+}
+
+async function extractPDFText(data, { mergePages = false } = {}) {
+  const pdf = await utils.getDocumentProxy(data);
   const texts = await Promise.all(
     Array.from({ length: pdf.numPages }, (_, i) => getPageText(pdf, i + 1))
   );
   const filteredTexts = texts.filter(Boolean);
   return {
     totalPages: pdf.numPages,
-    info: meta?.info,
-    metadata: meta?.metadata?.getAll(),
     text: mergePages ? filteredTexts.join("\n\n") : filteredTexts
   };
 }
@@ -41,5 +47,6 @@ async function getImagesFromPage(data, pageNumber) {
   return images;
 }
 
-exports.decodePDFText = decodePDFText;
+exports.extractPDFText = extractPDFText;
 exports.getImagesFromPage = getImagesFromPage;
+exports.getPDFMeta = getPDFMeta;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "unpdf",
   "type": "module",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "packageManager": "pnpm@8.6.12",
   "description": "Utilities to work with PDFs, like extracting text",
   "author": "Johann Schopplich <pkg@johannschopplich.com>",