unpdf 0.5.0 → 0.5.1

package/README.md

@@ -1,10 +1,10 @@
 # unpdf
 
-A collection of utilities to work with PDFs. Uses Mozilla's [PDF.js](https://github.com/mozilla/pdf.js) under the hood.
+A collection of utilities to work with PDFs. Uses Mozilla's [PDF.js](https://github.com/mozilla/pdf.js) under the hood and lazily initializes the library.
 
-`unpdf` takes advantage of [export conditions](https://nodejs.org/api/packages.html#packages_conditional_exports) to circumvent build issues in serverless environments. PDF.js depends on the optional `canvas` module, which [doesn't work inside worker threads](https://github.com/Automattic/node-canvas/issues/1394).
+`unpdf` takes advantage of [export conditions](https://nodejs.org/api/packages.html#packages_conditional_exports) to circumvent build issues in serverless environments. For example, PDF.js depends on the optional `canvas` module, which [doesn't work inside worker threads](https://github.com/Automattic/node-canvas/issues/1394).
 
-This library is also intended as a modern alternative to the unmaintained [`pdf-parse`](https://www.npmjs.com/package/pdf-parse).
+This library is also intended as a modern alternative to the unmaintained but still popular [`pdf-parse`](https://www.npmjs.com/package/pdf-parse).
 
 ## Features
 
@@ -18,13 +18,13 @@ Run the following command to add `unpdf` to your project.
 
 ```bash
 # pnpm
-pnpm add -D unpdf
+pnpm add unpdf
 
 # npm
-npm install -D unpdf
+npm install unpdf
 
 # yarn
-yarn add -D unpdf
+yarn add unpdf
 ```
 
 ## Usage
@@ -55,6 +55,14 @@ defineUnPDFConfig({
 // …
 ```
 
+### Access the PDF.js Module
+
+```ts
+import { getResolvedPDFJS } from 'unpdf'
+
+const { version } = await getResolvedPDFJS()
+```
+
 ## Config
 
 ```ts
@@ -75,16 +83,26 @@ interface UnPDFConfiguration {
 
 ### `defineUnPDFConfig`
 
+Define a custom PDF.js module, like the legacy build.
+
 ```ts
 function defineUnPDFConfig({ pdfjs }: UnPDFConfiguration): Promise<void>
 ```
 
+### `getResolvedPDFJS`
+
+Returns the resolved PDF.js module.
+
+```ts
+function getResolvedPDFJS(): Promise<typeof import('pdfjs-dist')>
+```
+
 ### `getPDFMeta`
 
 ```ts
 function getPDFMeta(data: ArrayBuffer): Promise<{
   info: Record<string, any>
-  metadata: any
+  metadata: Record<string, any>
 }>
 ```
 

package/dist/index.node.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
-const image = require('./shared/unpdf.e023f326.cjs');
-const utils = require('./shared/unpdf.54007d6f.cjs');
+const image = require('./shared/unpdf.3a651ae7.cjs');
+const utils = require('./shared/unpdf.15eec1ee.cjs');
 
 const getPDFMeta = async (...args) => {
   await utils.resolvePDFJSImports();
@@ -17,6 +17,9 @@ const getImagesFromPage = async (...args) => {
 };
 
 exports.defineUnPDFConfig = utils.defineUnPDFConfig;
+exports.getDocumentProxy = utils.getDocumentProxy;
+exports.getResolvedPDFJS = utils.getResolvedPDFJS;
+exports.resolvePDFJSImports = utils.resolvePDFJSImports;
 exports.extractPDFText = extractPDFText;
 exports.getImagesFromPage = getImagesFromPage;
 exports.getPDFMeta = getPDFMeta;

package/dist/index.node.d.cts

@@ -1,5 +1,6 @@
-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 { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.3a0402b0.cjs';
+export { d as defineUnPDFConfig, b as getDocumentProxy, c as getResolvedPDFJS, r as resolvePDFJSImports } from './shared/unpdf.3a0402b0.cjs';
+import 'pdfjs-dist/types/src/display/api';
 import 'pdfjs-dist';
 
 declare const getPDFMeta: typeof getPDFMeta$1;

package/dist/index.node.d.mts

@@ -1,5 +1,6 @@
-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 { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.3a0402b0.mjs';
+export { d as defineUnPDFConfig, b as getDocumentProxy, c as getResolvedPDFJS, r as resolvePDFJSImports } from './shared/unpdf.3a0402b0.mjs';
+import 'pdfjs-dist/types/src/display/api';
 import 'pdfjs-dist';
 
 declare const getPDFMeta: typeof getPDFMeta$1;

package/dist/index.node.d.ts

@@ -1,5 +1,6 @@
-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 { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.3a0402b0.js';
+export { d as defineUnPDFConfig, b as getDocumentProxy, c as getResolvedPDFJS, r as resolvePDFJSImports } from './shared/unpdf.3a0402b0.js';
+import 'pdfjs-dist/types/src/display/api';
 import 'pdfjs-dist';
 
 declare const getPDFMeta: typeof getPDFMeta$1;

package/dist/index.node.mjs

@@ -1,6 +1,6 @@
-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';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.d5a4740d.mjs';
+import { r as resolvePDFJSImports } from './shared/unpdf.9db6f9f8.mjs';
+export { d as defineUnPDFConfig, g as getDocumentProxy, a as getResolvedPDFJS } from './shared/unpdf.9db6f9f8.mjs';
 
 const getPDFMeta = async (...args) => {
   await resolvePDFJSImports();
@@ -15,4 +15,4 @@ const getImagesFromPage = async (...args) => {
   return await getImagesFromPage$1(...args);
 };
 
-export { extractPDFText, getImagesFromPage, getPDFMeta };
+export { extractPDFText, getImagesFromPage, getPDFMeta, resolvePDFJSImports };

package/dist/index.web.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
-const image = require('./shared/unpdf.e023f326.cjs');
-const utils = require('./shared/unpdf.54007d6f.cjs');
+const image = require('./shared/unpdf.3a651ae7.cjs');
+const utils = require('./shared/unpdf.15eec1ee.cjs');
 
 const getPDFMeta = async (...args) => {
   await utils.resolvePDFJSImports();
@@ -17,6 +17,9 @@ const getImagesFromPage = async (...args) => {
 };
 
 exports.defineUnPDFConfig = utils.defineUnPDFConfig;
+exports.getDocumentProxy = utils.getDocumentProxy;
+exports.getResolvedPDFJS = utils.getResolvedPDFJS;
+exports.resolvePDFJSImports = utils.resolvePDFJSImports;
 exports.extractPDFText = extractPDFText;
 exports.getImagesFromPage = getImagesFromPage;
 exports.getPDFMeta = getPDFMeta;

package/dist/index.web.d.cts

@@ -1,5 +1,6 @@
-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 { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.3a0402b0.cjs';
+export { d as defineUnPDFConfig, b as getDocumentProxy, c as getResolvedPDFJS, r as resolvePDFJSImports } from './shared/unpdf.3a0402b0.cjs';
+import 'pdfjs-dist/types/src/display/api';
 import 'pdfjs-dist';
 
 declare const getPDFMeta: typeof getPDFMeta$1;

package/dist/index.web.d.mts

@@ -1,5 +1,6 @@
-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 { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.3a0402b0.mjs';
+export { d as defineUnPDFConfig, b as getDocumentProxy, c as getResolvedPDFJS, r as resolvePDFJSImports } from './shared/unpdf.3a0402b0.mjs';
+import 'pdfjs-dist/types/src/display/api';
 import 'pdfjs-dist';
 
 declare const getPDFMeta: typeof getPDFMeta$1;

package/dist/index.web.d.ts

@@ -1,5 +1,6 @@
-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 { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.3a0402b0.js';
+export { d as defineUnPDFConfig, b as getDocumentProxy, c as getResolvedPDFJS, r as resolvePDFJSImports } from './shared/unpdf.3a0402b0.js';
+import 'pdfjs-dist/types/src/display/api';
 import 'pdfjs-dist';
 
 declare const getPDFMeta: typeof getPDFMeta$1;

package/dist/index.web.mjs

@@ -1,6 +1,6 @@
-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';
+import { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.d5a4740d.mjs';
+import { r as resolvePDFJSImports } from './shared/unpdf.9db6f9f8.mjs';
+export { d as defineUnPDFConfig, g as getDocumentProxy, a as getResolvedPDFJS } from './shared/unpdf.9db6f9f8.mjs';
 
 const getPDFMeta = async (...args) => {
   await resolvePDFJSImports();
@@ -15,4 +15,4 @@ const getImagesFromPage = async (...args) => {
   return await getImagesFromPage$1(...args);
 };
 
-export { extractPDFText, getImagesFromPage, getPDFMeta };
+export { extractPDFText, getImagesFromPage, getPDFMeta, resolvePDFJSImports };

package/dist/index.worker.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-const utils = require('./shared/unpdf.54007d6f.cjs');
+const utils = require('./shared/unpdf.15eec1ee.cjs');
 
 const getPDFMeta = async () => {
   throw new Error("Not implemented in worker context yet");
@@ -13,6 +13,9 @@ const getImagesFromPage = async () => {
 };
 
 exports.defineUnPDFConfig = utils.defineUnPDFConfig;
+exports.getDocumentProxy = utils.getDocumentProxy;
+exports.getResolvedPDFJS = utils.getResolvedPDFJS;
+exports.resolvePDFJSImports = utils.resolvePDFJSImports;
 exports.extractPDFText = extractPDFText;
 exports.getImagesFromPage = getImagesFromPage;
 exports.getPDFMeta = getPDFMeta;

package/dist/index.worker.d.cts

@@ -1,5 +1,6 @@
-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 { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.3a0402b0.cjs';
+export { d as defineUnPDFConfig, b as getDocumentProxy, c as getResolvedPDFJS, r as resolvePDFJSImports } from './shared/unpdf.3a0402b0.cjs';
+import 'pdfjs-dist/types/src/display/api';
 import 'pdfjs-dist';
 
 declare const getPDFMeta: typeof getPDFMeta$1;

package/dist/index.worker.d.mts

@@ -1,5 +1,6 @@
-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 { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.3a0402b0.mjs';
+export { d as defineUnPDFConfig, b as getDocumentProxy, c as getResolvedPDFJS, r as resolvePDFJSImports } from './shared/unpdf.3a0402b0.mjs';
+import 'pdfjs-dist/types/src/display/api';
 import 'pdfjs-dist';
 
 declare const getPDFMeta: typeof getPDFMeta$1;

package/dist/index.worker.d.ts

@@ -1,5 +1,6 @@
-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 { g as getPDFMeta$1, e as extractPDFText$1, a as getImagesFromPage$1 } from './shared/unpdf.3a0402b0.js';
+export { d as defineUnPDFConfig, b as getDocumentProxy, c as getResolvedPDFJS, r as resolvePDFJSImports } from './shared/unpdf.3a0402b0.js';
+import 'pdfjs-dist/types/src/display/api';
 import 'pdfjs-dist';
 
 declare const getPDFMeta: typeof getPDFMeta$1;

package/dist/index.worker.mjs

@@ -1,4 +1,4 @@
-export { d as defineUnPDFConfig } from './shared/unpdf.5b4a24ed.mjs';
+export { d as defineUnPDFConfig, g as getDocumentProxy, a as getResolvedPDFJS, r as resolvePDFJSImports } from './shared/unpdf.9db6f9f8.mjs';
 
 const getPDFMeta = async () => {
   throw new Error("Not implemented in worker context yet");

package/dist/shared/{unpdf.54007d6f.cjs → unpdf.15eec1ee.cjs}

@@ -2,7 +2,7 @@
 
 let resolvedModule;
 async function getDocumentProxy(data) {
-  const { getDocument } = getResolvedPDFJS();
+  const { getDocument } = await getResolvedPDFJS();
   const pdf = await getDocument({
     data,
     useWorkerFetch: false,
@@ -21,7 +21,9 @@ async function defineUnPDFConfig({ pdfjs }) {
     }
   }
 }
-function getResolvedPDFJS() {
+async function getResolvedPDFJS() {
+  if (!resolvedModule)
+    await resolvePDFJSImports();
   return resolvedModule;
 }
 async function resolvePDFJSImports() {

package/dist/shared/{unpdf.842960e8.d.ts → unpdf.3a0402b0.d.cts}

@@ -1,8 +1,9 @@
+import * as pdfjs_dist_types_src_display_api from 'pdfjs-dist/types/src/display/api';
 import PDFJS from 'pdfjs-dist';
 
 declare function getPDFMeta(data: ArrayBuffer): Promise<{
     info: Record<string, any>;
-    metadata: any;
+    metadata: Record<string, any>;
 }>;
 
 declare function extractPDFText(data: ArrayBuffer, { mergePages }?: {
@@ -26,6 +27,9 @@ interface UnPDFConfiguration {
     pdfjs?: () => Promise<typeof PDFJS>;
 }
 
+declare function getDocumentProxy(data: ArrayBuffer): Promise<pdfjs_dist_types_src_display_api.PDFDocumentProxy>;
 declare function defineUnPDFConfig({ pdfjs }: UnPDFConfiguration): Promise<void>;
+declare function getResolvedPDFJS(): Promise<typeof PDFJS>;
+declare function resolvePDFJSImports(): Promise<void>;
 
-export { getImagesFromPage as a, defineUnPDFConfig as d, extractPDFText as e, getPDFMeta as g };
+export { getImagesFromPage as a, getDocumentProxy as b, getResolvedPDFJS as c, defineUnPDFConfig as d, extractPDFText as e, getPDFMeta as g, resolvePDFJSImports as r };

package/dist/shared/{unpdf.842960e8.d.mts → unpdf.3a0402b0.d.mts}

@@ -1,8 +1,9 @@
+import * as pdfjs_dist_types_src_display_api from 'pdfjs-dist/types/src/display/api';
 import PDFJS from 'pdfjs-dist';
 
 declare function getPDFMeta(data: ArrayBuffer): Promise<{
     info: Record<string, any>;
-    metadata: any;
+    metadata: Record<string, any>;
 }>;
 
 declare function extractPDFText(data: ArrayBuffer, { mergePages }?: {
@@ -26,6 +27,9 @@ interface UnPDFConfiguration {
     pdfjs?: () => Promise<typeof PDFJS>;
 }
 
+declare function getDocumentProxy(data: ArrayBuffer): Promise<pdfjs_dist_types_src_display_api.PDFDocumentProxy>;
 declare function defineUnPDFConfig({ pdfjs }: UnPDFConfiguration): Promise<void>;
+declare function getResolvedPDFJS(): Promise<typeof PDFJS>;
+declare function resolvePDFJSImports(): Promise<void>;
 
-export { getImagesFromPage as a, defineUnPDFConfig as d, extractPDFText as e, getPDFMeta as g };
+export { getImagesFromPage as a, getDocumentProxy as b, getResolvedPDFJS as c, defineUnPDFConfig as d, extractPDFText as e, getPDFMeta as g, resolvePDFJSImports as r };

package/dist/shared/{unpdf.842960e8.d.cts → unpdf.3a0402b0.d.ts}

@@ -1,8 +1,9 @@
+import * as pdfjs_dist_types_src_display_api from 'pdfjs-dist/types/src/display/api';
 import PDFJS from 'pdfjs-dist';
 
 declare function getPDFMeta(data: ArrayBuffer): Promise<{
     info: Record<string, any>;
-    metadata: any;
+    metadata: Record<string, any>;
 }>;
 
 declare function extractPDFText(data: ArrayBuffer, { mergePages }?: {
@@ -26,6 +27,9 @@ interface UnPDFConfiguration {
     pdfjs?: () => Promise<typeof PDFJS>;
 }
 
+declare function getDocumentProxy(data: ArrayBuffer): Promise<pdfjs_dist_types_src_display_api.PDFDocumentProxy>;
 declare function defineUnPDFConfig({ pdfjs }: UnPDFConfiguration): Promise<void>;
+declare function getResolvedPDFJS(): Promise<typeof PDFJS>;
+declare function resolvePDFJSImports(): Promise<void>;
 
-export { getImagesFromPage as a, defineUnPDFConfig as d, extractPDFText as e, getPDFMeta as g };
+export { getImagesFromPage as a, getDocumentProxy as b, getResolvedPDFJS as c, defineUnPDFConfig as d, extractPDFText as e, getPDFMeta as g, resolvePDFJSImports as r };

package/dist/shared/{unpdf.e023f326.cjs → unpdf.3a651ae7.cjs}

@@ -1,13 +1,13 @@
 'use strict';
 
-const utils = require('./unpdf.54007d6f.cjs');
+const utils = require('./unpdf.15eec1ee.cjs');
 
 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()
+    info: meta?.info ?? {},
+    metadata: meta?.metadata?.getAll() ?? {}
   };
 }
 
@@ -35,7 +35,7 @@ async function getImagesFromPage(data, pageNumber) {
   const pdf = await utils.getDocumentProxy(data);
   const page = await pdf.getPage(pageNumber);
   const operatorList = await page.getOperatorList();
-  const { OPS } = utils.getResolvedPDFJS();
+  const { OPS } = await utils.getResolvedPDFJS();
   const images = [];
   for (const op of operatorList.fnArray) {
     if (op !== OPS.paintImageXObject)

package/dist/shared/{unpdf.5b4a24ed.mjs → unpdf.9db6f9f8.mjs}

@@ -1,6 +1,6 @@
 let resolvedModule;
 async function getDocumentProxy(data) {
-  const { getDocument } = getResolvedPDFJS();
+  const { getDocument } = await getResolvedPDFJS();
   const pdf = await getDocument({
     data,
     useWorkerFetch: false,
@@ -19,7 +19,9 @@ async function defineUnPDFConfig({ pdfjs }) {
     }
   }
 }
-function getResolvedPDFJS() {
+async function getResolvedPDFJS() {
+  if (!resolvedModule)
+    await resolvePDFJSImports();
   return resolvedModule;
 }
 async function resolvePDFJSImports() {

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

@@ -1,11 +1,11 @@
-import { g as getDocumentProxy, a as getResolvedPDFJS } from './unpdf.5b4a24ed.mjs';
+import { g as getDocumentProxy, a as getResolvedPDFJS } from './unpdf.9db6f9f8.mjs';
 
 async function getPDFMeta(data) {
   const pdf = await getDocumentProxy(data);
   const meta = await pdf.getMetadata().catch(() => null);
   return {
-    info: meta?.info,
-    metadata: meta?.metadata?.getAll()
+    info: meta?.info ?? {},
+    metadata: meta?.metadata?.getAll() ?? {}
   };
 }
 
@@ -33,7 +33,7 @@ async function getImagesFromPage(data, pageNumber) {
   const pdf = await getDocumentProxy(data);
   const page = await pdf.getPage(pageNumber);
   const operatorList = await page.getOperatorList();
-  const { OPS } = getResolvedPDFJS();
+  const { OPS } = await getResolvedPDFJS();
   const images = [];
   for (const op of operatorList.fnArray) {
     if (op !== OPS.paintImageXObject)

package/package.json

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