bare-x-to-pdf 0.2.0 → 0.4.0

package/CMakeLists.txt

@@ -6,11 +6,10 @@ find_package(cmake-fetch REQUIRED PATHS node_modules/cmake-fetch)
 project(simple_converter C)
 
 include(cmake/rust.cmake)
-include(cmake/pdfium.cmake)
 
 bare_target(target)
 
-add_bare_module(simple_converter NAME bare-x-to-pdf-${target} INSTALL TARGET pdfium)
+add_bare_module(simple_converter NAME bare-x-to-pdf-${target})
 
 target_sources(
   ${simple_converter}
@@ -29,3 +28,11 @@ target_link_libraries(
   PRIVATE
     simple_converter_core
 )
+
+if(CMAKE_STRIP AND NOT WIN32)
+  add_custom_command(
+    TARGET ${simple_converter}_module
+    POST_BUILD
+    COMMAND ${CMAKE_STRIP} $<IF:$<PLATFORM_ID:Darwin,iOS>,-x,--strip-unneeded> $<TARGET_FILE:${simple_converter}_module>
+  )
+endif()

package/LICENSE.md

@@ -0,0 +1,198 @@
+# License
+
+This project is licensed under the Apache License, Version 2.0.
+See below for the full license text.
+
+## Apache License
+
+_Version 2.0, January 2004_  
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### Terms and Conditions for use, reproduction, and distribution
+
+#### 1. Definitions
+
+“License” shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+“Licensor” shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+“Legal Entity” shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, “control” means **(i)** the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
+outstanding shares, or **(iii)** beneficial ownership of such entity.
+
+“You” (or “Your”) shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+“Source” form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+“Object” form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+“Work” shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+“Derivative Works” shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+“Contribution” shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+“submitted” means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as “Not a Contribution.”
+
+“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+#### 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+#### 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+#### 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+- **(a)** You must give any other recipients of the Work or Derivative Works a copy of
+  this License; and
+- **(b)** You must cause any modified files to carry prominent notices stating that You
+  changed the files; and
+- **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
+  all copyright, patent, trademark, and attribution notices from the Source form
+  of the Work, excluding those notices that do not pertain to any part of the
+  Derivative Works; and
+- **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
+  Derivative Works that You distribute must include a readable copy of the
+  attribution notices contained within such NOTICE file, excluding those notices
+  that do not pertain to any part of the Derivative Works, in at least one of the
+  following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along
+  with the Derivative Works; or, within a display generated by the Derivative
+  Works, if and wherever such third-party notices normally appear. The contents of
+  the NOTICE file are for informational purposes only and do not modify the
+  License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work,
+  provided that such additional attribution notices cannot be construed as
+  modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+#### 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+#### 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+#### 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+#### 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+#### 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+_END OF TERMS AND CONDITIONS_
+
+### APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets `[]` replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same “printed page” as the copyright notice for easier identification within
+third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/NOTICE.md

@@ -0,0 +1,13 @@
+Copyright 2026 Tether Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -2,31 +2,38 @@
 
 Convert office documents to PDF for [Bare](https://github.com/holepunchto/bare).
 A native addon with a Rust engine that lays pages out with
-[Typst](https://typst.app) and reads PDFs with
-[PDFium](https://pdfium.googlesource.com/pdfium/).
+[Typst](https://typst.app).
 
 `x` is every format it reads into a PDF today:
 
-| Family            | Extensions                         |
-| ----------------- | ---------------------------------- |
-| Word (OOXML)      | `.docx`, `.docm`, `.dotx`, `.dotm` |
-| Word 97–2003      | `.doc`, `.dot`                     |
-| OpenDocument Text | `.odt`, `.ott`, `.fodt`            |
-| PowerPoint        | `.pptx`                            |
-| Excel             | `.xlsx`, `.xlsm`, `.xltx`, `.xltm` |
-
-PDF to `.docx` (fixed-layout) also exists, in the other direction.
+| Family                    | Extensions                         |
+| ------------------------- | ---------------------------------- |
+| Word                      | `.docx`, `.docm`, `.dotx`, `.dotm` |
+| Word 97–2003              | `.doc`, `.dot`                     |
+| Excel                     | `.xlsx`, `.xlsm`, `.xltx`, `.xltm` |
+| Excel 97–2003             | `.xls`, `.xlt`                     |
+| PowerPoint                | `.pptx`                            |
+| OpenDocument Text         | `.odt`, `.ott`, `.fodt`            |
+| OpenDocument Spreadsheet  | `.ods`, `.ots`, `.fods`            |
+| OpenDocument Presentation | `.odp`, `.otp`, `.fodp`            |
+| Markdown                  | `.md`, `.markdown`                 |
+
+The `from` name for each is the extension without its dot, and PDF is the only output.
+Markdown is CommonMark plus GitHub tables, task lists and strikethrough. Legacy
+PowerPoint (`.ppt`), `.pptm`, `.potx`, `.ppsx`, Rich Text and HTML are not read.
 
 ## Install
 
 ```sh
-npm install bare-x-to-pdf@beta
+npm install bare-x-to-pdf
 ```
 
 The native prebuild is an optional dependency per platform (`bare-x-to-pdf-<platform>-<arch>`),
-so an install downloads only the package for its own platform, about 20 MB, plus the
-fonts and sources in the main package. darwin, linux, win32, android and ios are covered;
-other hosts build from source with the Bare toolchain, CMake 4 and Rust.
+so an install downloads only the package for its own platform, about 17 MB packed and
+42 MB unpacked, plus the main package with the fonts and sources, about 4 MB packed.
+Prebuilds exist for android (arm, arm64, x64), darwin (arm64, x64), ios (arm64 and the
+arm64 and x64 simulators), linux (arm64, x64) and win32 (x64); other hosts build from a
+checkout with the Bare toolchain, CMake 4 and Rust.
 
 To bundle for a different platform, ask npm for that prebuild as well:
 
@@ -40,27 +47,38 @@ npm install --os=ios --cpu=arm64
 ```js
 const converter = require('bare-x-to-pdf')
 
-const pdf = converter.convert(docxBytes, { to: 'pdf' })
-const docx = converter.convert(pdfBytes, { to: 'docx' })
+const pdf = await converter.convert(docxBytes, { to: 'pdf' })
 ```
 
-Input is a `Uint8Array` or `ArrayBuffer` and the result is a `Buffer`. Calls are
-synchronous and CPU bound; run them in a `Bare.Thread` when latency matters.
+Input is a `Uint8Array` or `ArrayBuffer` and the result is a `Buffer`. `convert()` runs on
+the libuv thread pool and does not block the JavaScript thread; `convertSync()` runs on the
+calling thread.
 
 ## API
 
-### `convert(input, options)`
+### `const pdf = await convert(input, options)`
 
-Convert `input` and return a `Buffer`.
+Convert `input` off the JavaScript thread and resolve with a `Buffer`. The input is copied,
+so it may be changed or transferred once the call returns. Invalid options and conversion
+errors reject the promise.
 
-- `options.to` — target format, e.g. `'pdf'` or `'docx'`. Required.
-- `options.from` — source format; sniffed from the bytes when omitted.
+- `options.to` — target format, `'pdf'`. Required.
+- `options.from` — source format; sniffed from the bytes when omitted. Markdown has no
+  signature to sniff, so pass `from: 'md'` for it. Markdown images load only from `data:`
+  URIs, since the input is bytes with no directory to resolve relative paths against.
 - `options.fontsDir` — a directory of fonts to use instead of the bundled set.
-- `options.pdfiumPath` — path to the PDFium shared library.
+
+### `const pdf = convertSync(input, options)`
+
+Convert `input` on the calling thread and return a `Buffer`. Takes the same options as
+`convert()`.
 
 ### `detect(input)`
 
-Return the detected format (`'docx'`, `'pdf'`, `'doc'`, …) or `null`.
+Sniff the format from the bytes and return `'docx'`, `'pptx'`, `'xlsx'`, `'doc'`, `'xls'`,
+`'odt'`, `'ods'`, `'odp'`, `'fodt'`, `'fods'`, `'fodp'` or `null`. Templates and
+macro-enabled files report their base format (a `.dotx` is `'docx'`, an `.ots` is
+`'ods'`), which converts the same way. Markdown is plain text and always returns `null`.
 
 ### `supports(from, to)`
 
@@ -74,11 +92,50 @@ Return every supported pair as `{ from, to }`.
 
 Path to the bundled fonts directory.
 
-### `defaultPdfiumPath()`
+## Limits
+
+Documents are often untrusted, so the engine caps what a small file can make it allocate or
+lay out. A document past a hard limit is rejected with an error. One past a soft limit still
+converts, with the value clamped.
+
+Rejected:
+
+- An archive part larger than 128 MB uncompressed.
+- XML nested more than 512 elements deep.
+- A spreadsheet that would print more than 30,000 cells.
+
+Clamped:
+
+- Table spans: 1–1,000 columns.
+- Text columns: 1–64.
+- Pages: 72–14,400 pt on each side, with margins scaled to fit.
+- Lengths: NaN and infinity become 0; any other length is held within ±1,000,000 pt.
+- List counters: above 32,767, letter and Roman labels fall back to decimal.
+- Charts: up to 100,000 points per series (in .xls, 32,000 per series and 256,000 per chart).
+- Formulas: nesting depth up to 256.
+- Images: more than 50 megapixels, or ones that cannot be decoded, are drawn as blank
+  space.
+- Tables nested more than 12 deep: the inner tables are flattened into paragraphs.
+
+Spreadsheet pages with no content are not printed, as in LibreOffice Calc.
+
+## Development
+
+The platform packages in `npm/` are npm workspaces, and each declares its own `os` and `cpu`
+so that installs download only one. In a checkout, install with `npm install --force` so npm
+links all of them, then build the host prebuild with `npm run prebuild` and run `npm test`.
+The fidelity benchmark in `bench/` has its own dependencies: `cd bench && npm install`.
+
+## Releases
 
-Path to the PDFium library shipped in the platform package beside the addon.
+`.github/workflows/publish.yml` runs when a `v*` tag is pushed. Tag the commit whose
+`package.json` has that version, after running `npm run packages` to bring the platform
+packages to it. The workflow builds every platform, publishes the platform packages and then
+the main package through npm trusted publishing, and creates a GitHub release. A tag newer
+than npm's current `latest` publishes as `latest`; an older one as `release-<major>.<minor>`.
 
 ## License
 
-Apache-2.0. PDFium is BSD; Typst and its dependencies are Apache-2.0 or MIT; the
-bundled fonts are under the SIL Open Font License (see `fonts/`).
+Apache-2.0. Typst, pulldown-cmark and the other Rust dependencies are Apache-2.0 or MIT.
+Liberation, Carlito and Caladea are under the SIL Open Font License (see `fonts/`);
+OpenSymbol comes from LibreOffice.