pdfjs-serverless 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-PRESENT Johann Schopplich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+# pdfjs-serverless
+
+> **Note**
+>
+> Work in progress.
+
+A redistribution of Mozilla's [PDF.js](https://github.com/mozilla/pdf.js) for serverless enviroments, like Deno Deploy and Cloudflare Workers.
+
+## 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. polyfilling 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.
+
+## Installation
+
+Run the following command to add `pdfjs-serverless` to your project.
+
+```bash
+# pnpm
+pnpm add pdfjs-serverless
+
+# npm
+npm install pdfjs-serverless
+
+# yarn
+yarn add pdfjs-serverless
+```
+
+## Usage
+
+### Deno
+
+```ts
+import { getDocument } from 'https://esm.sh/pdfjs-serverless'
+
+const data = Deno.readFileSync('./dummy.pdf')
+const doc = await getDocument(data).promise
+
+console.log(await doc.getMetadata())
+```
+
+### 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)
+
+## License
+
+[MIT](./LICENSE) License © 2023-PRESENT [Johann Schopplich](https://github.com/johannschopplich)

package/dist/index.d.ts

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