@docx-editor.dev/docx-to-pdf 0.0.1 → 2.23.0

package/LICENSE.md

@@ -0,0 +1,121 @@
+# EigenPal Pro Evaluation License 1.0
+
+Copyright (c) 2026 EigenPal, Inc. All rights reserved.
+
+By copying, modifying, or using the Software, you agree to these terms.
+
+## 1. Covered Software
+
+“Software” means all source code, object code, documentation, assets, and other
+materials contained in the “packages/docx-to-pdf/” directory of the EigenPal DOCX
+Editor repository, except for any material that expressly states that it is
+subject to a different license.
+
+## 2. Evaluation Permission; Modifications
+
+Subject to these terms, EigenPal, Inc. grants you a limited, non-exclusive,
+non-transferable, non-sublicensable, royalty-free license to:
+
+1. view, clone, and copy the Software;
+2. run the Software internally in a non-production environment solely to
+   evaluate its suitability for your intended application; and
+3. modify the Software solely as reasonably necessary for that internal,
+   non-production evaluation.
+
+For any such modification, the following applies:
+
+You may keep any modification to yourself. If you do not disclose it to EigenPal, Inc. or to anyone else, it remains yours
+If you disclose a modification to EigenPal, Inc. or to any third party, in any form, you assign all right, title, and interest in it to EigenPal, Inc. at the moment of disclosure. The same applies to any feedback you give EigenPal, Inc. You will promptly send EigenPal, Inc. the source code of any modification you disclose, and will sign any document needed to record the assignment.
+Disclosing a modification to a third party grants that third party no rights in it or in the Software. You will not license or purport to license any modification to anyone.
+You may continue using an assigned modification for the internal, non-production evaluation permitted by Section 2 for as long as this license is in effect. EigenPal, Inc. is not obliged to use or support any modification or feedback, and owes you nothing for it.
+You confirm that any modification or feedback you disclose is yours to assign and is not subject to any license that would impose obligations on EigenPal, Inc. or grant rights to any third party.
+
+
+No other rights are granted.
+
+## 3. No Production Use
+
+You may not use the Software for Production Use.
+
+“Production Use” means any use of the Software:
+
+1. in a live, operational, or customer-facing environment;
+2. to provide, operate, support, or enhance a product or service for another
+   person or organization;
+3. to process live, customer, or business-operational data; or
+4. as part of your ordinary internal business operations, other than evaluation
+   and testing.
+
+For the avoidance of doubt, Production Use includes embedding the Software in a product made available to
+others, offering the Software through a hosted or managed service, and using it
+in a customer pilot or paid proof of concept.
+
+## 4. No Distribution or Sublicensing
+
+You may not sell, sublicense, distribute, publish, transfer, or otherwise make
+the Software or modifications to the Software available to any third party.
+
+You may allow your employees and contractors to access the Software solely for
+your evaluation, provided they are bound by restrictions at least as protective
+as these terms. You are responsible for their compliance.
+
+## 5. Commercial Rights
+
+Production Use and any rights not expressly granted by this license require a
+separate written commercial agreement signed by EigenPal, Inc.
+
+Commercial licenses are available by contacting licensing@eigenpal.com.
+
+Access to the Software, correspondence with EigenPal, Inc., or payment of an
+invoice does not by itself grant production or commercial rights unless those
+rights are set out in a written agreement signed by EigenPal, Inc.
+
+## 6. Ownership
+
+EigenPal, Inc. and its licensors retain all rights, title, and interest in the
+Software. This license does not transfer ownership or grant any rights by
+implication.
+
+Modifying the Software does not grant you the right to use the Software or those
+modifications in production.
+
+## 7. Termination
+
+Your rights under this license terminate automatically if you breach these
+terms or if EigenPal terminates this license.
+
+Following termination, you must stop using the Software and delete your copies
+and modifications, except for copies that you are legally required to retain.
+EigenPal, Inc. may reinstate your rights in writing.
+
+## 8. No Warranty
+
+TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED “AS IS” AND
+WITHOUT WARRANTIES OF ANY KIND, WHETHER EXPRESS, IMPLIED, OR STATUTORY,
+INCLUDING WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
+TITLE, AND NON-INFRINGEMENT.
+
+## 9. Limitation of Liability
+
+TO THE MAXIMUM EXTENT PERMITTED BY LAW, EIGENPAL, INC. AND ITS LICENSORS WILL NOT BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, EXEMPLARY, OR PUNITIVE DAMAGES, OR FOR ANY LOSS OF DATA, REVENUE, PROFITS, OR BUSINESS, ARISING FROM OR RELATING TO THE SOFTWARE OR THIS LICENSE. TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE TOTAL AGGREGATE LIABILITY OF EIGENPAL, INC. AND ITS LICENSORS FOR ALL CLAIMS ARISING FROM OR RELATING TO THE SOFTWARE OR THIS LICENSE, WHETHER IN CONTRACT, TORT, STRICT LIABILITY, OR ANY OTHER THEORY, WILL NOT EXCEED TEN UNITED STATES DOLLARS (US$10). THE FOREGOING LIMITATIONS APPLY EVEN IF EIGENPAL, INC. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES AND EVEN IF ANY LIMITED REMEDY IS FOUND TO HAVE FAILED OF ITS ESSENTIAL PURPOSE.
+
+## 10. Trademarks
+
+This license does not grant permission to use the names, trademarks, service
+marks, or logos of EigenPal, Inc., except to identify the origin of an
+unmodified copy of the Software.
+
+## 11. Governing Law and Jurisdiction
+
+This license is governed by the laws of the State of California, without regard
+to its conflict-of-laws rules.
+
+Any dispute arising from or relating to this license will be subject to the
+exclusive jurisdiction of the state and federal courts located in California,
+and you consent to their jurisdiction.
+
+## 12. Separate Commercial Agreements
+
+If EigenPal, Inc. and you enter into a separate written commercial agreement,
+that agreement controls to the extent it grants additional rights or conflicts
+with this license.

package/README.md

@@ -1,4 +1,128 @@
-# @docx-editor.dev/docx-to-pdf
+# DOCX to PDF
 
-This package name is reserved. The real release is published from
-https://github.com/eigenpal/docx-editor.
+`@docx-editor.dev/docx-to-pdf` converts DOCX documents to PDF on Node.js. It uses Core's pagination, font resolution, and positioned glyphs to produce searchable text.
+
+The package uses the [EigenPal Pro License](LICENSE.md). Production use requires a commercial agreement.
+
+## Before you begin
+
+Use Node.js 20.16.0 or later in the 20.x release line, or Node.js 22.3.0 or later. The converter needs WebAssembly and its packaged font assets. Install a compatible `@docx-editor.dev/core` peer alongside the converter. Keep one Core copy in your application.
+
+## Install the package
+
+```sh
+npm install @docx-editor.dev/docx-to-pdf @docx-editor.dev/core
+```
+
+For Chinese, Japanese, or Korean text, supply suitable fonts or install the optional `@docx-editor.dev/fonts-cjk` package. The converter finds the package without configuration.
+
+If you previously relied on bundled CJK coverage, add the optional package to your production dependencies. For installation and deployment details, see [Configure PDF fonts](docs/fonts.md).
+
+## Convert a document
+
+```ts
+import { readFile, writeFile } from 'node:fs/promises';
+import { exportPdf } from '@docx-editor.dev/docx-to-pdf';
+
+const source = await readFile('document.docx');
+const result = await exportPdf(source, {
+  displayMode: 'proposed',
+  comments: true,
+});
+
+await writeFile('document.pdf', result.bytes);
+```
+
+Conversion preserves the source DOCX. Browser applications must send the document to a Node.js server for conversion.
+
+## Reuse a layout
+
+Use `openDocumentForExport` and `exportPdfFrom` to reuse font resolution and layout. The session also works with Markdown's `exportMarkdownFrom`. Dispose the session after all exports, including failed exports. For an example, see [Compare PDF and Markdown conversion](docs/markdown-contract.md#reuse-one-session).
+
+## Configure output
+
+| Option | Default | Behavior |
+| --- | --- | --- |
+| `fidelityPolicy` | `'strict'` | Rejects unsupported or approximate output. Use `'best-effort'` to return available output with diagnostics. |
+| `displayMode` | `'proposed'` | Includes proposed revisions. Use `'original'` for the original content or `'all-markup'` to show revisions. |
+| `comments` | `true` | Includes native PDF annotations. Set to `false` to omit them. |
+| `useSystemFonts` | `true` | Searches standard operating system directories for supported font files. Set to `false` to disable this search. |
+| `timeoutMs` | `60000` | Sets the conversion deadline in milliseconds. |
+| `maxOutputBytes` | `67108864` | Limits output to 64 MiB. You can lower this limit. |
+| `maxPages` | `10000` | Limits output pages after layout. You can lower this limit. |
+| `signal` | — | Cancels conversion through an `AbortSignal`. |
+
+The result includes `bytes`, `pageCount`, `layoutRevision`, `displayMode`, `fontResolution`, `diagnostics`, and `timings`. Timings report milliseconds spent opening the document, laying out pages, painting content, and encoding the PDF. Each result owns its byte buffer.
+
+### Fonts
+
+Use `fonts` to provide font sources before the installed and packaged sources. Use `fallbackFonts` to add sources after the packaged fonts. The exporter also reads embedded fonts before using a generic substitute for an unresolved family. Use `lastResortFonts` after embedded fonts and before generic substitutes.
+
+`glyphFallbacks` specifies an ordered list of fonts for missing glyphs. The defaults cover symbols, Arabic, Hebrew, mathematics, and color emoji. They also cover CJK text when `@docx-editor.dev/fonts-cjk` is installed. Emoji from a COLR font retain their palette colors and extractable text.
+
+Core's `fontPolicy` controls failed font sources and incomplete face coverage. Generic substitutions can change line breaks and page count, so strict export rejects them with a `font-substitution` diagnostic. Best-effort export uses the substitute and reports it. Inspect `result.fontResolution` for the selected fonts.
+
+For custom font files and policy choices, see [Configure PDF fonts](docs/fonts.md).
+
+### Comments
+
+Comments become range highlights or text notes. PDF viewers determine whether they display authors, dates, replies, and resolved state. Cross-page comments create an annotation on each affected page. Comments without a visible anchor become labeled notes on the first page.
+
+Editing PDF annotations does not update the DOCX.
+
+## Supported content
+
+- Searchable multilingual text, small caps, text decorations, and tab leaders.
+- Arabic joining across formatting runs and logical word order for Arabic, Persian, and Hebrew text extraction.
+- Synthetic bold and italic when selected font faces lack those variants.
+- Static TrueType and CFF fonts, including selected faces from font collections.
+- Page sizes, page frames, headers, footers, footnotes, and endnotes.
+- Text and image list markers, paragraph fills, and paragraph borders.
+- Table text, shading, and resolved borders.
+- Textboxes and structured equations.
+- Supported vector shapes, horizontal and vertical lines, and outlines that retain their full width.
+- PNG and JPEG images with cropping, transforms, alpha transparency, and fixed opacity.
+- Links, destinations, document metadata, and comments.
+
+The converter reads PNG and JPEG images even when DOCX metadata declares another supported raster format. Supported declarations include PNG, JPEG, GIF, BMP, and WebP.
+
+## Limitations
+
+Charts, rotated table-cell text, unsupported equation fallbacks, advanced image effects, some revision presentation, and non-PNG/JPEG media produce diagnostics. Brightness and grayscale adjustments are not supported.
+
+The writer rejects variable fonts, missing glyphs, prohibited embedding, fonts that prohibit subsetting, and font containers that cannot be encoded. Tagged PDF, PDF/A, encryption, and forms are not supported.
+
+## Errors and resource limits
+
+| Error | Cause |
+| --- | --- |
+| `PdfDocumentOpenError` | Core rejected the input document. Inspect `reason` and `detail`. |
+| `PdfFidelityError` | Strict export encountered unsupported or approximate content. Inspect `diagnostics`. |
+| `ExportResourceError` | Cancellation, deadlines, font-policy refusals, or layout failures. Inspect `code`. |
+| `PdfWorkLimitError` | Content exceeded a processing limit. |
+| `PdfOutputLimitError` | Encoded bytes exceeded `maxOutputBytes`. Inspect `limit` and `actual`. Extends `PdfEncodingError`. |
+| `PdfPageLimitError` | Layout exceeded `maxPages`. Inspect `limit` and `actual`. Extends `RangeError`. |
+| `PdfEncodingError` | PDF encoding failed. Inspect `cause`. |
+| `TypeError` or `RangeError` | An argument is invalid or a size limit was exceeded. |
+
+The writer compresses content streams and embeds font subsets. It retains layout records and font data until conversion finishes. Core's resource limits also apply.
+
+Cancellation is checked between layout, paint, and encoding batches. Synchronous font and image operations cannot be interrupted mid-call. For a hard deadline or heap limit, run conversion in a worker and configure `resourceLimits.maxOldGenerationSizeMb`.
+
+## Developer guides
+
+- [Compare PDF and Markdown conversion](docs/markdown-contract.md): shared controls and intentional differences.
+- [PDF export API](docs/api.md): options, result fields, diagnostics, stable error codes, and resource boundaries.
+- [Configure PDF fonts](docs/fonts.md): custom files, source order, policies, and troubleshooting.
+- [Integrate PDF conversion](docs/integrations.md): HTTP responses, Next.js, deployment, and batches.
+
+## Run the demo
+
+From the repository root, run:
+
+```sh
+bun install
+bun run dev:pdf
+```
+
+Open <http://127.0.0.1:5180>. For upload limits, server configuration, and production commands, see the [demo README](../../examples/docx-to-pdf/README.md).

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,32 @@
+# Third-party notices
+
+`@docx-editor.dev/docx-to-pdf` is distributed under LicenseRef-EigenPal-Pro-Evaluation-1.0. Its published bundles also contain
+source from the open-source packages listed below, redistributed here under
+their own licenses, reproduced in full.
+
+Those copies are not verbatim. The build inlines, minifies and tree-shakes
+them, and includes only the parts each bundle reaches, so what ships is a
+modified form of the original source.
+
+The terms of LicenseRef-EigenPal-Pro-Evaluation-1.0 do not apply to the portions of these bundles
+derived from the packages listed below. Those portions are licensed to you
+under their own terms.
+
+This file covers code copied INTO the published bundles. Packages this one
+declares as `dependencies` or `peerDependencies` are installed separately by
+the consumer and are not repeated here.
+
+Generated by `bun run notices:generate` from the build's esbuild metafile.
+Do not edit by hand.
+
+This package also ships prebuilt third-party assets that are not esbuild inputs,
+so they cannot appear below. Their licenses travel with the package in
+`licenses/`:
+
+- `licenses/NotoEmoji-OFL.txt`
+- `licenses/NotoSansArabic-OFL.txt`
+- `licenses/NotoSansMath-OFL.txt`
+- `licenses/NotoSansSymbols2-OFL.txt`
+- `licenses/TwemojiMozilla-LICENSE.md`
+
+No third-party code is bundled into this package.

package/assets/README.md

@@ -0,0 +1,7 @@
+# PDF fallback fonts
+
+These third-party fonts load from local files. Conversion does not download fonts. The resolver can also use installed fonts from supported operating system directories; installed fonts are not redistributed.
+
+The Noto fonts use the SIL Open Font License. Twemoji Mozilla uses the Apache License 2.0 for code and CC BY 4.0 for emoji artwork. Original licenses are in [`../licenses/`](../licenses/). [`sources.json`](sources.json) records source URLs and SHA-256 hashes.
+
+Noto Emoji and Noto Sans Arabic are static instances generated with FontTools `instantiateVariableFont` at weight 400. The Arabic instance also uses width 100. The remaining fonts are unchanged upstream binaries. PDF export creates subsets for each document.

package/assets/sources.json

@@ -0,0 +1,60 @@
+{
+  "NotoEmoji.variable.ttf": {
+    "url": "https://raw.githubusercontent.com/google/fonts/main/ofl/notoemoji/NotoEmoji%5Bwght%5D.ttf",
+    "sha256": "de6c18832938afc99caf132b39d6a30a19bac7f2e812e28db2535b4608d27551"
+  },
+  "NotoEmoji-OFL.txt": {
+    "url": "https://raw.githubusercontent.com/google/fonts/main/ofl/notoemoji/OFL.txt",
+    "sha256": "500bb1ccf43df7bbb522112f9133a52b16e1c35e809632f5d8609b179152de5b"
+  },
+  "NotoSansMath-Regular.ttf": {
+    "url": "https://raw.githubusercontent.com/google/fonts/main/ofl/notosansmath/NotoSansMath-Regular.ttf",
+    "sha256": "3f495fe933c06786e4d5f6d86b8ee70b6753a68ee3b9d87528726de0f6e2c47d",
+    "installedSha256": "3f495fe933c06786e4d5f6d86b8ee70b6753a68ee3b9d87528726de0f6e2c47d"
+  },
+  "NotoSansMath-OFL.txt": {
+    "url": "https://raw.githubusercontent.com/google/fonts/main/ofl/notosansmath/OFL.txt",
+    "sha256": "403a95275b469061b7d4371c328e0ada3bc7d63328abe2e88aad5cd243b2fe21"
+  },
+  "NotoSansArabic.variable.ttf": {
+    "url": "https://raw.githubusercontent.com/google/fonts/main/ofl/notosansarabic/NotoSansArabic%5Bwdth,wght%5D.ttf",
+    "sha256": "63111b5b2e074dd48cc67692e0a2726d86ee94c1c37fe8598257b7b4e87e869e"
+  },
+  "NotoSansArabic-OFL.txt": {
+    "url": "https://raw.githubusercontent.com/google/fonts/main/ofl/notosansarabic/OFL.txt",
+    "sha256": "07fc70bfeb985cc1a87a8587d0a0c80bab11c86c9dc3fd95b6f0cb332f983e96"
+  },
+  "NotoSansSymbols2-Regular.ttf": {
+    "url": "https://raw.githubusercontent.com/google/fonts/main/ofl/notosanssymbols2/NotoSansSymbols2-Regular.ttf",
+    "sha256": "7d5fb73b7ca67a6798101741f5d280a3d016a56a197afcd4199dbb57b4b82a21",
+    "installedSha256": "7d5fb73b7ca67a6798101741f5d280a3d016a56a197afcd4199dbb57b4b82a21"
+  },
+  "NotoSansSymbols2-OFL.txt": {
+    "url": "https://raw.githubusercontent.com/google/fonts/main/ofl/notosanssymbols2/OFL.txt",
+    "sha256": "b118dd41337806a5d4797052c77caf3bd096aed783e5eb21b4d11154351e1ac0"
+  },
+  "NotoEmoji-Regular.ttf": {
+    "derivedFrom": "NotoEmoji.variable.ttf",
+    "axes": {
+      "wght": 400
+    },
+    "installedSha256": "8db3470f6990515b6c3303667c133d41c94a6465797ff27b88a07595378d5f07"
+  },
+  "NotoSansArabic-Regular.ttf": {
+    "derivedFrom": "NotoSansArabic.variable.ttf",
+    "axes": {
+      "wght": 400,
+      "wdth": 100
+    },
+    "installedSha256": "97ad7c9db540d795730cda54885e1e5741a0494ef13681d78a73f8a0fbc60b9f"
+  },
+  "TwemojiMozilla.ttf": {
+    "url": "https://github.com/mozilla/twemoji-colr/releases/download/v0.7.0/Twemoji.Mozilla.ttf",
+    "sha256": "6d90152ee0d29e82fe2a87793af5aa4b7ad13e6538360889e141e81ed299ee8e",
+    "installedSha256": "6d90152ee0d29e82fe2a87793af5aa4b7ad13e6538360889e141e81ed299ee8e"
+  },
+  "TwemojiMozilla-LICENSE.md": {
+    "url": "https://raw.githubusercontent.com/mozilla/twemoji-colr/master/LICENSE.md",
+    "sha256": "64419edc28e9163204c3be73f835a8dfc34cd6c9b8f7d067bb685f119f839a99"
+  }
+}