unpdf 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,34 @@
+# unpdf
+
+A collection of utilities to work with PDFs.
+
+`unpdf` takes advantage of [export conditions](https://nodejs.org/api/packages.html#packages_conditional_exports) to provide a minimal bundle size for the browser. As of now, the available methods are only supported in Node contexts.
+
+**Why this package then?**
+
+- To circumvent build issues in serverless environments, where the `canvas` package is used by `PDF.js` not supported.
+- WIP and more to come.
+
+## Installation
+
+Run the following command to add `unpdf` to your project.
+
+```bash
+pnpm install unpdf # or npm or yarn
+```
+
+## Usage
+
+```ts
+import { decodePDFText } from 'unpdf'
+
+const pdfBuffer = await fetch('https://example.com/file.pdf').then(res => res.arrayBuffer())
+
+const { totalPages, info, metadata, text } = await decodePDFText(
+  new Uint8Array(pdfBuffer), { mergePages: true }
+)
+```
+
+## License
+
+[MIT](./LICENSE) License © 2023-PRESENT [Johann Schopplich](https://github.com/johannschopplich)

package/dist/index.node.cjs

@@ -0,0 +1,44 @@
+'use strict';
+
+async function decodePDFText(data, { mergePages = false } = {}) {
+  const { getDocument } = await getPDFJSImports();
+  const pdf = await getDocument({
+    data,
+    useWorkerFetch: false,
+    useSystemFonts: true,
+    isEvalSupported: false
+  }).promise;
+  const meta = await pdf.getMetadata().catch(() => null);
+  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
+  };
+}
+async function getPageText(pdf, pageNumber) {
+  const page = await pdf.getPage(pageNumber);
+  const content = await page.getTextContent();
+  const items = content.items;
+  if (items.length === 0)
+    return;
+  return items.map(({ str }) => str).join("\n");
+}
+async function getPDFJSImports() {
+  try {
+    const { default: mod } = await import('pdfjs-dist/legacy/build/pdf');
+    const { getDocument, version } = mod;
+    return { getDocument, version };
+  } catch (e) {
+    console.error(e);
+    throw new Error(
+      "PDF.js is not available. Please run `pnpm add -D pdfjs-dist` and try again."
+    );
+  }
+}
+
+exports.decodePDFText = decodePDFText;

package/dist/index.node.d.cts

@@ -0,0 +1 @@
+export { d as decodePDFText } from './shared/unpdf.98b795c6.cjs';

package/dist/index.node.d.mts

@@ -0,0 +1 @@
+export { d as decodePDFText } from './shared/unpdf.98b795c6.mjs';

package/dist/index.node.d.ts

@@ -0,0 +1 @@
+export { d as decodePDFText } from './shared/unpdf.98b795c6.js';

package/dist/index.node.mjs

@@ -0,0 +1,42 @@
+async function decodePDFText(data, { mergePages = false } = {}) {
+  const { getDocument } = await getPDFJSImports();
+  const pdf = await getDocument({
+    data,
+    useWorkerFetch: false,
+    useSystemFonts: true,
+    isEvalSupported: false
+  }).promise;
+  const meta = await pdf.getMetadata().catch(() => null);
+  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
+  };
+}
+async function getPageText(pdf, pageNumber) {
+  const page = await pdf.getPage(pageNumber);
+  const content = await page.getTextContent();
+  const items = content.items;
+  if (items.length === 0)
+    return;
+  return items.map(({ str }) => str).join("\n");
+}
+async function getPDFJSImports() {
+  try {
+    const { default: mod } = await import('pdfjs-dist/legacy/build/pdf');
+    const { getDocument, version } = mod;
+    return { getDocument, version };
+  } catch (e) {
+    console.error(e);
+    throw new Error(
+      "PDF.js is not available. Please run `pnpm add -D pdfjs-dist` and try again."
+    );
+  }
+}
+
+export { decodePDFText };

package/dist/index.web.cjs

@@ -0,0 +1,7 @@
+'use strict';
+
+async function decodePDFText(..._args) {
+  throw new Error("Not supported in browser context yet");
+}
+
+exports.decodePDFText = decodePDFText;

package/dist/index.web.d.cts

@@ -0,0 +1,5 @@
+import { d as decodePDFText$1, P as PDFContent } from './shared/unpdf.98b795c6.cjs';
+
+declare function decodePDFText(..._args: Parameters<typeof decodePDFText$1>): Promise<PDFContent>;
+
+export { decodePDFText };

package/dist/index.web.d.mts

@@ -0,0 +1,5 @@
+import { d as decodePDFText$1, P as PDFContent } from './shared/unpdf.98b795c6.mjs';
+
+declare function decodePDFText(..._args: Parameters<typeof decodePDFText$1>): Promise<PDFContent>;
+
+export { decodePDFText };

package/dist/index.web.d.ts

@@ -0,0 +1,5 @@
+import { d as decodePDFText$1, P as PDFContent } from './shared/unpdf.98b795c6.js';
+
+declare function decodePDFText(..._args: Parameters<typeof decodePDFText$1>): Promise<PDFContent>;
+
+export { decodePDFText };

package/dist/index.web.mjs

@@ -0,0 +1,5 @@
+async function decodePDFText(..._args) {
+  throw new Error("Not supported in browser context yet");
+}
+
+export { decodePDFText };

package/dist/shared/unpdf.98b795c6.d.cts

@@ -0,0 +1,12 @@
+interface PDFContent {
+    totalPages: number;
+    info?: Record<string, any>;
+    metadata?: any;
+    text: string | string[];
+}
+
+declare function decodePDFText(data: ArrayBuffer, { mergePages }?: {
+    mergePages?: boolean;
+}): Promise<PDFContent>;
+
+export { PDFContent as P, decodePDFText as d };

package/dist/shared/unpdf.98b795c6.d.mts

@@ -0,0 +1,12 @@
+interface PDFContent {
+    totalPages: number;
+    info?: Record<string, any>;
+    metadata?: any;
+    text: string | string[];
+}
+
+declare function decodePDFText(data: ArrayBuffer, { mergePages }?: {
+    mergePages?: boolean;
+}): Promise<PDFContent>;
+
+export { PDFContent as P, decodePDFText as d };

package/dist/shared/unpdf.98b795c6.d.ts

@@ -0,0 +1,12 @@
+interface PDFContent {
+    totalPages: number;
+    info?: Record<string, any>;
+    metadata?: any;
+    text: string | string[];
+}
+
+declare function decodePDFText(data: ArrayBuffer, { mergePages }?: {
+    mergePages?: boolean;
+}): Promise<PDFContent>;
+
+export { PDFContent as P, decodePDFText as d };

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "unpdf",
+  "type": "module",
+  "version": "0.1.0",
+  "packageManager": "pnpm@8.6.12",
+  "description": "Utilities to work with PDFs",
+  "author": "Johann Schopplich <pkg@johannschopplich.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/johannschopplich/unpdf#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/johannschopplich/unpdf.git"
+  },
+  "bugs": {
+    "url": "https://github.com/johannschopplich/unpdf/issues"
+  },
+  "keywords": [
+    "pdf",
+    "parse"
+  ],
+  "sideEffects": false,
+  "exports": {
+    "browser": "./dist/index.web.mjs",
+    "bun": "./dist/index.web.mjs",
+    "deno": "./dist/index.web.mjs",
+    "edge-light": "./dist/index.web.mjs",
+    "edge-routine": "./dist/index.web.mjs",
+    "lagon": "./dist/index.web.mjs",
+    "netlify": "./dist/index.web.mjs",
+    "react-native": "./dist/index.web.mjs",
+    "wintercg": "./dist/index.web.mjs",
+    "worker": "./dist/index.web.mjs",
+    "workerd": "./dist/index.web.mjs",
+    "node": {
+      "types": "./dist/index.node.d.ts",
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    },
+    "types": "./dist/index.web.d.ts",
+    "import": "./dist/index.web.mjs",
+    "require": "./dist/index.web.cjs"
+  },
+  "main": "./dist/index.node.cjs",
+  "module": "./dist/index.web.mjs",
+  "browser": "./dist/index.web.mjs",
+  "types": "./dist/index.web.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "release": "bumpp --commit --push --tag",
+    "test:types": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "pdfjs-dist": "^3.9.179"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^0.40.2",
+    "bumpp": "^9.1.1",
+    "eslint": "^8.47.0",
+    "pdfjs-dist": "^3.9.179",
+    "typescript": "^5.1.6",
+    "unbuild": "^2.0.0-rc.0"
+  }
+}