pdfjs-serverless 0.2.1 → 0.2.3

package/README.md

@@ -1,14 +1,6 @@
 # pdfjs-serverless
 
-A nodeless/serverless redistribution of Mozilla's [PDF.js](https://github.com/mozilla/pdf.js) for serverless enviroments, like Deno Deploy and Cloudflare Workers with zero dependencies.
-
-## How It Works
-
-First, some string replacements of the `pdf.js` library is necessary, i.e. removing browser context references. Additionally, we enforce Node.js (might sound paradox at first, bear with me) compatibility, i.e. mocking the `canvas` module and setting the `isNodeJS` flag to `true`.
-
-To achieve a nodeless build, [`unenv`](https://github.com/unjs/unenv) does the heavy lifting by converting Node.js specific code to be platform-agnostic.
-
-See the [`rollup.config.js`](./rollup.config.js) file for more information.
+A redistribution of Mozilla's [PDF.js](https://github.com/mozilla/pdf.js) for serverless environments, like Deno Deploy and Cloudflare Workers with zero dependencies. All named exports of the `PDF.js` library are available at roughly 1.4 MB (minified).
 
 ## Installation
 
@@ -25,14 +17,24 @@ npm install pdfjs-serverless
 yarn add pdfjs-serverless
 ```
 
+## How It Works
+
+First, some string replacements of the `PDF.js` library is necessary, i.e. removing browser context references and checks like `typeof window`. Additionally, we enforce Node.js compatibility (might sound paradox at first, bear with me), i.e. mocking the `canvas` module and setting the `isNodeJS` flag to `true`.
+
+PDF.js uses a worker to parse and work with PDF documents. This worker is a separate file that is loaded by the main library. For the serverless build, we need to inline the worker code into the main library.
+
+To achieve the final nodeless build, [`unenv`](https://github.com/unjs/unenv) does the heavy lifting by converting Node.js specific code to be platform-agnostic. This ensures that Node.js built-in modules like `fs` are mocked.
+
+See the [`rollup.config.ts`](./rollup.config.ts) file for more information.
+
 ## Example Usage
 
-### Deno
+### 🦕 Deno
 
 ```ts
 import { getDocument } from 'https://esm.sh/pdfjs-serverless'
 
-const data = Deno.readFileSync('./dummy.pdf')
+const data = Deno.readFileSync('dummy.pdf')
 const doc = await getDocument(data).promise
 
 console.log(await doc.getMetadata())
@@ -45,30 +47,6 @@ for (let i = 1; i <= doc.numPages; i++) {
 }
 ```
 
-### In Combination With `unpdf`
-
-The following example shows how to use `pdfjs-serverless` with [`unpdf`](https://github.com/johannschopplich/unpdf):
-
-```ts
-import { defineUnPDFConfig, extractPDFText } from 'unpdf'
-
-// Use the serverless version of PDF.js
-defineUnPDFConfig({
-  pdfjs: () => import('pdfjs-serverless')
-})
-
-// Now, you can use the other methods provided by unpdf
-
-// Fetch a PDF file from the web
-const pdf = await fetch('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf')
-  .then(res => res.arrayBuffer())
-
-// Pass the PDF buffer to the relevant method
-const { totalPages, text } = await extractPDFText(
-  new Uint8Array(pdf), { mergePages: true }
-)
-```
-
 ## Inspiration
 
 - [`pdf.mjs`](https://github.com/bru02/pdf.mjs), a nodeless build of PDF.js v2.

package/dist/index.d.mts

@@ -0,0 +1 @@
+export * from './types/src/pdf.d.ts'