@embedpdf/engines 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CloudPDF, Ji Chang
+
+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,81 @@
+<div align="center">
+  <a href="https://www.embedpdf.com">
+    <img alt="EmbedPDF logo" src="https://www.embedpdf.com/logo-192.png" height="96">
+  </a>
+  <h1>EmbedPDF</h1>
+
+<a href="https://www.npmjs.com/package/@embedpdf/engines"><img alt="NPM version" src="https://img.shields.io/npm/v/@embedpdf/engines.svg?style=for-the-badge&labelColor=000000"></a> <a href="https://github.com/embedpdf/embed-pdf-viewer/blob/main/packages/engines/LICENSE"><img alt="License" src="https://img.shields.io/npm/l/@embedpdf/engines.svg?style=for-the-badge&labelColor=000000"></a> <a href="https://github.com/embedpdf/embed-pdf-viewer/discussions"><img alt="Join the community on GitHub" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&labelColor=000000"></a>
+
+</div>
+
+# @embedpdf/engines
+
+Pluggable rendering engines for EmbedPDF. Ships with **`PdfiumEngine`** – a high‑level, promise‑first wrapper built on top of `@embedpdf/pdfium`.
+
+## Documentation
+
+For complete guides, examples, and full API reference, visit:
+
+**[Official Documentation](https://www.embedpdf.com/docs/engines/introduction)**
+
+## Why `@embedpdf/engines`?
+
+- **High‑level abstraction** – handles tasks, DPR scaling, annotation colour resolution, range/linearised loading.
+- **Universal runtimes** – works in browsers, Node, and serverless environments.
+- **Typed & composable** – 100 % TypeScript with generics for custom image pipelines.
+
+## Features
+
+- Open PDFs from `ArrayBuffer` or URL
+- Render full pages, arbitrary rectangles, thumbnails – all DPI‑aware
+- Text extraction, glyph geometry, word‑break‑aware search with context windows
+- Read / create / transform / delete **annotations** and **form fields**
+- Page ops: merge, extract, flatten, partial import
+- Attachments & digital‑signature introspection
+
+## Installation
+
+```bash
+npm install @embedpdf/engines @embedpdf/pdfium
+```
+
+## Basic Usage
+
+```typescript
+import { init } from '@embedpdf/pdfium';
+import { PdfiumEngine } from '@embedpdf/engines/pdfium';
+
+const pdfiumWasm =
+  'https://cdn.jsdelivr.net/npm/@embedpdf/pdfium/dist/pdfium.wasm';
+
+(async () => {
+  const response = await fetch(pdfiumWasm);
+  const wasmBinary = await response.arrayBuffer();
+  // 1 – boot the low‑level WASM module
+  const pdfium = await init({ wasmBinary });
+
+  // 2 – create the high‑level engine
+  const engine = new PdfiumEngine(pdfium);
+  engine.initialize();
+
+  // 3 – open & render
+  const document = await engine
+    .openDocumentUrl({ id: 'demo', url: '/demo.pdf' })
+    .toPromise();
+  const page0 = doc.pages[0];
+
+  const blob = await engine.renderPage(doc, page0).toPromise();
+})();
+```
+
+## Learn More
+
+Head over to our docs for:
+
+- **Getting Started** – initialise, render, destroy
+- **Engine Interface** – implement your own back‑end
+- **Advanced Topics** – workers, Node pipelines, Sharp image adapters
+
+## License
+
+MIT – see the [LICENSE](https://github.com/embedpdf/embed-pdf-viewer/blob/main/packages/engines/LICENSE) file.