@qrcommunication/gigapdf-lib 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to `@qrcommunication/gigapdf-lib` are documented here.
+The format follows [Keep a Changelog](https://keepachangelog.com/) and the
+project adheres to [Semantic Versioning](https://semver.org/).
+
+## [0.1.0] - 2026-06-14
+
+### Added
+
+- Initial public release of the TypeScript SDK for **gigapdf-lib**, a
+  zero-dependency Rust→WASM PDF engine.
+- `GigaPdfEngine`: `load()`, `loadDefault()` (Node), `open()`, `openEncrypted()`,
+  stateless conversions (`txtToPdf`, `htmlToPdf`, `rtfToPdf`, `officeToPdf`), and
+  font helpers (`fontCatalog`, `fontRequestUrl`, `parseCssFontUrl`).
+- `GigaPdfDoc`: full document API — text intelligence (`textRuns`,
+  `structuredText`, `search`, `ocr`, `ocrText`, `elements`, `elementAt`),
+  editing (`replaceText`, `removeElement`, `moveElement`, `duplicateElement`,
+  `addRectangle`, `redact`), pages (`rotatePage`, `deletePage`, `movePage`,
+  `appendPages`, `extractPages`), rendering (`renderPage`), embedded fonts
+  (`embedFont`, `addText`, `neededFonts`), conversions to
+  text/HTML/DOCX/PPTX/ODT/XLSX/ODS/RTF/PDF-A, security (`saveEncrypted`, `sign`),
+  metadata (`getMetadata`, `setMetadata`), annotations (square, highlight, line,
+  free-text, underline, strike-out, ink, stamp, plus `annotations`,
+  `removeAnnotation`, `flattenAnnotations`), hyperlinks (`links`, `addUriLink`,
+  `addGotoLink`), outline (`outline`, `setOutline`), and AcroForm fields
+  (`fields`, `setTextField`, `setCheckbox`, `setRadio`, `setChoice`).
+- The engine `.wasm` is self-contained — no third-party runtime dependencies.
+
+[0.1.0]: https://github.com/qrcommunication/gigapdf-lib/releases/tag/v0.1.0

package/LICENSE

@@ -0,0 +1,114 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+Copyright 2025 Rony Licha / QR Communication
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both
+strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything
+you might do with the software that would otherwise infringe the licensor's
+copyright in it for any permitted purpose. However, you may only distribute the
+software according to Distribution License and make changes or new works based
+on the software according to Changes and New Works License.
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of
+the software. Your license to distribute covers distributing the software with
+changes and new works permitted by Changes and New Works License.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms or the URL for them above, as well as copies of
+any plain-text lines beginning with `Required Notice:` that the licensor
+provided with the software.
+
+> Required Notice: Copyright 2025 Rony Licha / QR Communication
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new
+works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent
+claims the licensor can license, or becomes able to license, that you would
+infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public
+knowledge, personal study, private entertainment, hobby projects, amateur
+pursuits, or religious observance, without any anticipated commercial
+application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research
+organization, public safety or health organization, environmental protection
+organization, or government institution is use for a permitted purpose
+regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do
+not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to
+anyone else, or prevent the licensor from granting licenses to anyone else.
+These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to
+infringement of any patent, your patent license for the software granted under
+these terms ends immediately. If your company makes such a claim, your patent
+license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these
+terms, or done anything with the software not covered by your licenses, your
+licenses can nonetheless continue if you come into full compliance with these
+terms, and take practical steps to correct past violations, within 32 days of
+receiving notice. Otherwise, all your licenses end immediately.
+
+## No Liability
+
+> AS FAR AS THE LAW ALLOWS, THE SOFTWARE COMES AS IS, WITHOUT ANY WARRANTY OR
+> CONDITION, AND THE LICENSOR WILL NOT BE LIABLE TO YOU FOR ANY DAMAGES ARISING
+> OUT OF THESE TERMS OR THE USE OR NATURE OF THE SOFTWARE, UNDER ANY KIND OF
+> LEGAL CLAIM.
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the
+**software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that organization.
+**Control** means ownership of substantially all the assets of an entity, or the
+power to direct its management and policies by vote, contract, or otherwise.
+Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1,105 @@
+# @qrcommunication/gigapdf-lib
+
+TypeScript SDK for **gigapdf-lib** — a zero-dependency Rust→WASM PDF engine.
+Read, edit, render, OCR, search, sign, encrypt, fill forms, annotate, and convert
+PDFs ↔ Office/HTML/RTF. The engine `.wasm` is self-contained: **no third-party
+runtime dependencies**.
+
+## Install
+
+```bash
+pnpm add @qrcommunication/gigapdf-lib
+# or: npm i @qrcommunication/gigapdf-lib
+```
+
+## Quick start
+
+```ts
+import { GigaPdfEngine } from "@qrcommunication/gigapdf-lib";
+
+// Node: loads the bundled gigapdf.wasm from the package.
+const giga = await GigaPdfEngine.loadDefault();
+
+// Browser / explicit control: pass a URL, Response, or bytes.
+// const giga = await GigaPdfEngine.load("/gigapdf.wasm");
+
+const doc = giga.open(pdfBytes); // Uint8Array
+
+// Read
+const lines = doc.structuredText(1); // [{ text, x, y, w, h }]
+const hits = doc.search("invoice"); // [{ page, text, x, y, w, h }]
+const words = doc.ocr(1, 2); // OCR a scanned page at 2× scale
+
+// Edit (operates on the real content stream — no cosmetic overlay)
+doc.replaceText(1, 0, "New value");
+doc.redact(1, 72, 700, 180, 14); // physically remove content in a region
+doc.addHighlight(1, 72, 690, 252, 704, 0xffff00);
+
+// Convert
+const docx = doc.toDocx(); // also: toPptx/toOdt/toXlsx/toOds/toHtml/toText/toRtf/toPdfA
+const png = doc.renderPage(1, 2); // rasterize a page
+
+// Save
+const out = doc.save(); // or doc.saveCompressed()
+doc.close();
+```
+
+### Office / HTML / RTF → PDF
+
+```ts
+const fromDocx = giga.officeToPdf(officeBytes); // docx/xlsx/pptx/odt/ods/odp auto-detected
+const fromHtml = giga.htmlToPdf("<h1>Hello</h1>");
+const fromRtf = giga.rtfToPdf(rtfString);
+```
+
+### Fonts (host performs the network fetch)
+
+```ts
+const url = giga.fontRequestUrl("Roboto", 400); // Google Fonts CSS2 URL
+const css = await (await fetch(url, { headers: { "User-Agent": "Mozilla/4.0" } })).text();
+const ttfUrl = giga.parseCssFontUrl(css); // trusted gstatic URL
+const ttf = new Uint8Array(await (await fetch(ttfUrl)).arrayBuffer());
+const fontObj = doc.embedFont("Roboto", ttf);
+doc.addText(1, 72, 720, 18, "Selectable text", fontObj, 0x111111);
+```
+
+## Next.js (`output: "standalone"`)
+
+`loadDefault()` reads `gigapdf.wasm` from the package directory. In standalone
+output, add it to the route's `outputFileTracingIncludes` so it is copied into
+the bundle:
+
+```ts
+// next.config.ts
+outputFileTracingIncludes: {
+  "/api/pdf/*": ["./node_modules/@qrcommunication/gigapdf-lib/gigapdf.wasm"],
+}
+```
+
+Or call `GigaPdfEngine.load(bytes)` with bytes you read yourself.
+
+## API surface
+
+- **`GigaPdfEngine`** — `load`/`loadDefault`, `open`/`openEncrypted`,
+  `txtToPdf`/`htmlToPdf`/`rtfToPdf`/`officeToPdf`, `fontCatalog`/`fontRequestUrl`/`parseCssFontUrl`.
+- **`GigaPdfDoc`** — text intelligence (`textRuns`, `structuredText`, `search`,
+  `ocr`, `ocrText`, `elements`, `elementAt`), editing (`replaceText`,
+  `removeElement`, `moveElement`, `duplicateElement`, `addRectangle`, `redact`),
+  pages (`rotatePage`, `deletePage`, `movePage`, `appendPages`, `extractPages`),
+  `renderPage`, fonts (`embedFont`, `addText`, `neededFonts`), conversions
+  (`toText/Html/Docx/Pptx/Odt/Xlsx/Ods/Rtf/PdfA`), security (`saveEncrypted`,
+  `sign`), metadata (`getMetadata`, `setMetadata`), annotations (`addSquare`,
+  `addHighlight`, `addLineAnnotation`, `addFreeText`, `addUnderline`,
+  `addStrikeOut`, `addInk`, `addStamp`, `annotations`, `removeAnnotation`,
+  `flattenAnnotations`), links (`links`, `addUriLink`, `addGotoLink`), outline
+  (`outline`, `setOutline`), and forms (`fields`, `setTextField`, `setCheckbox`,
+  `setRadio`, `setChoice`).
+
+Every method is fully typed. Always `close()` a document when done to free the
+WASM handle.
+
+## License
+
+**PolyForm Noncommercial License 1.0.0** © Rony Licha / QR Communication.
+Free for noncommercial use; a commercial license is required otherwise. See
+[`LICENSE`](LICENSE).