bare-x-to-pdf 0.4.0 → 0.5.1

package/CMakeLists.txt

@@ -9,7 +9,11 @@ include(cmake/rust.cmake)
 
 bare_target(target)
 
-add_bare_module(simple_converter NAME bare-x-to-pdf-${target})
+if(target STREQUAL "wasi-wasm32")
+  add_bare_module(simple_converter)
+else()
+  add_bare_module(simple_converter NAME bare-x-to-pdf-${target})
+endif()
 
 target_sources(
   ${simple_converter}
@@ -29,10 +33,26 @@ target_link_libraries(
     simple_converter_core
 )
 
+# Bound the linear memory a hostile document can claim, so it traps instead of
+# growing to the 4 GiB limit of wasm32, and give the recursive readers and
+# Typst the 8 MiB stack they get on native threads rather than the 64 KiB
+# default of wasm-ld. The default cap leaves room for the 256 MB images and
+# 128 MB parts that core/src/limits.rs lets through.
+set(SIMPLE_CONVERTER_WASM_MAX_MEMORY 1073741824 CACHE STRING "Linear memory limit of the WebAssembly addon in bytes, a multiple of 65536")
+
+if(target MATCHES "^wasi-")
+  target_link_options(
+    ${simple_converter}_module
+    PRIVATE
+      -Wl,--max-memory=${SIMPLE_CONVERTER_WASM_MAX_MEMORY}
+      -Wl,-z,stack-size=8388608
+  )
+endif()
+
 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>
+    COMMAND ${CMAKE_STRIP} $<IF:$<PLATFORM_ID:Darwin,iOS>,-x,$<IF:$<PLATFORM_ID:WASI>,--strip-all,--strip-unneeded>> $<TARGET_FILE:${simple_converter}_module>
   )
 endif()

package/README.md

@@ -42,6 +42,39 @@ npm install --os=android --cpu=arm64
 npm install --os=ios --cpu=arm64
 ```
 
+### WebAssembly
+
+On Bare 1.36 and later the converter can also run as a WebAssembly addon, sandboxed through
+WASI. The `.wasm` prebuild ships in the main package, so there is nothing extra to install.
+Import with the `wasi-wasm32` host and a WASI provider. The attributes must be written
+inline in the `require` call. The addon needs a random source and read access to the fonts:
+
+```js
+const converter = require('bare-x-to-pdf', {
+  with: { host: 'wasi-wasm32', wasi: './wasi.js' }
+})
+```
+
+```js
+// wasi.js
+const crypto = require('bare-crypto')
+const { DirectorySync } = require('bare-directory')
+const { HostDirectory } = require('bare-wasi/host')
+
+const fonts = require.resolve('bare-x-to-pdf/package').replace(/package\.json$/, 'fonts')
+
+module.exports = (url) => ({
+  version: 'preview1',
+  random: (b) => crypto.randomFillSync(b),
+  preopens: { [fonts]: new HostDirectory(DirectorySync.open(fonts)) }
+})
+```
+
+The WebAssembly addon has only `convertSync`. `convert()` falls back to it, so it blocks the
+calling thread; run conversions in a [`bare-thread`](https://github.com/holepunchto/bare-thread).
+A hostile document can crash the addon with a `RuntimeError` without taking down the process,
+but the addon stays unusable in that thread afterwards, so replace the thread.
+
 ## Usage
 
 ```js
@@ -90,7 +123,7 @@ Return every supported pair as `{ from, to }`.
 
 ### `FONTS_DIR`
 
-Path to the bundled fonts directory.
+Path to the bundled fonts directory, resolved with `require.asset`.
 
 ## Limits
 

package/binding.c

@@ -1,12 +1,15 @@
 #include <assert.h>
-#include <bare.h>
+#include <bare/module.h>
 #include <js.h>
 #include <stdbool.h>
 #include <stdint.h>
 #include <stdlib.h>
 #include <string.h>
 #include <utf.h>
+
+#ifndef __wasm__
 #include <uv.h>
+#endif
 
 #include "simple_converter.h"
 
@@ -22,6 +25,10 @@ typedef struct {
   int status;
 } simple_converter_job_t;
 
+// WebAssembly addons are single threaded and have no event loop, so they
+// export only convertSync() and leave running it off the JavaScript thread to
+// the embedder.
+#ifndef __wasm__
 typedef struct {
   uv_work_t work;
   js_env_t *env;
@@ -30,6 +37,7 @@ typedef struct {
   bool exiting;
   simple_converter_job_t job;
 } simple_converter_req_t;
+#endif
 
 static bool
 simple_converter__string(js_env_t *env, js_value_t *value, char **result) {
@@ -218,6 +226,7 @@ simple_converter_convert_sync(js_env_t *env, js_callback_info_t *info) {
   return result;
 }
 
+#ifndef __wasm__
 static void
 simple_converter__on_work(uv_work_t *work) {
   simple_converter_req_t *req = (simple_converter_req_t *) work;
@@ -300,6 +309,7 @@ simple_converter_convert(js_env_t *env, js_callback_info_t *info) {
 
   return promise;
 }
+#endif
 
 static js_value_t *
 simple_converter_exports(js_env_t *env, js_value_t *exports) {
@@ -314,7 +324,9 @@ simple_converter_exports(js_env_t *env, js_value_t *exports) {
     assert(err == 0); \
   }
 
+#ifndef __wasm__
   V("convert", simple_converter_convert)
+#endif
   V("convertSync", simple_converter_convert_sync)
 #undef V
 

package/cmake/rust.cmake

@@ -43,6 +43,8 @@ elseif(_sys STREQUAL "win32")
   else()
     set(_triple x86_64-pc-windows-msvc)
   endif()
+elseif(_sys STREQUAL "wasi")
+  set(_triple wasm32-wasip1)
 else()
   message(FATAL_ERROR "simple-converter: no Rust target for '${_sys}/${_arch}'")
 endif()
@@ -56,3 +58,11 @@ corrosion_import_crate(
   CRATE_TYPES staticlib
   PROFILE release
 )
+
+# Corrosion 0.6.1 adds the Command Line Tools SDK as a link directory on macOS.
+# The linker searches it before CMAKE_OSX_SYSROOT, so -lSystem resolves against
+# the wrong SDK and fails when the two differ (corrosion-rs/corrosion#686, fixed
+# upstream after 0.6.1). Drop this once the pin moves past that fix.
+if(APPLE)
+  set_property(TARGET simple_converter_core-static PROPERTY INTERFACE_LINK_DIRECTORIES "")
+endif()

package/index.js

@@ -1,7 +1,6 @@
-const path = require('bare-path')
 const { binding } = require('./binding')
 
-const FONTS_DIR = path.join(__dirname, 'fonts')
+const FONTS_DIR = require.asset('./fonts')
 
 const CONVERSIONS = {
   docx: ['pdf'],
@@ -188,7 +187,11 @@ function optional(value) {
 }
 
 async function convert(input, opts = {}) {
-  return Buffer.from(await binding.convert(...prepare(input, opts)))
+  const args = prepare(input, opts)
+  // The WebAssembly addon has no thread pool, so it converts on the calling
+  // thread; run it in a worker to keep the JavaScript thread free.
+  if (binding.convert === undefined) return Buffer.from(binding.convertSync(...args))
+  return Buffer.from(await binding.convert(...args))
 }
 
 function convertSync(input, opts = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-x-to-pdf",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "description": "Convert Word, PowerPoint, Excel and OpenDocument files to PDF for Bare: a Rust engine on Typst",
   "main": "index.js",
   "exports": {
@@ -8,6 +8,10 @@
     ".": {
       "types": "./index.d.ts",
       "default": "./index.js"
+    },
+    "./types": {
+      "types": "./types.d.ts",
+      "default": "./types.js"
     }
   },
   "types": "./index.d.ts",
@@ -17,8 +21,12 @@
   "files": [
     "index.js",
     "index.d.ts",
+    "types.js",
+    "types.d.ts",
     "binding.c",
     "binding.js",
+    "wasi.js",
+    "prebuilds/wasi-wasm32",
     "CMakeLists.txt",
     "cmake",
     "core/Cargo.toml",
@@ -64,14 +72,14 @@
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {
-    "bare-path": "^3.0.0",
-    "bare-url": "^2.4.1"
-  },
   "devDependencies": {
+    "bare-crypto": "^1.15.4",
     "bare-fs": "^4.0.0",
+    "bare-path": "^3.0.0",
+    "bare-wasi": "^0.1.1",
+    "bare-wasm-abi": "^0.1.1",
     "brittle": "^4.1.0",
-    "cmake-bare": "^1.8.3",
+    "cmake-bare": "^1.10.1",
     "cmake-fetch": "^1.5.1",
     "lunte": "^1.8.4",
     "prettier": "^3.9.6",
@@ -79,6 +87,9 @@
   },
   "imports": {
     "#binding": {
+      "wasi": {
+        "wasm32": "./wasi.js"
+      },
       "android": {
         "arm": "bare-x-to-pdf-android-arm",
         "arm64": "bare-x-to-pdf-android-arm64",
@@ -107,16 +118,16 @@
     }
   },
   "optionalDependencies": {
-    "bare-x-to-pdf-android-arm": "0.4.0",
-    "bare-x-to-pdf-android-arm64": "0.4.0",
-    "bare-x-to-pdf-android-x64": "0.4.0",
-    "bare-x-to-pdf-darwin-arm64": "0.4.0",
-    "bare-x-to-pdf-darwin-x64": "0.4.0",
-    "bare-x-to-pdf-ios-arm64": "0.4.0",
-    "bare-x-to-pdf-ios-arm64-simulator": "0.4.0",
-    "bare-x-to-pdf-ios-x64-simulator": "0.4.0",
-    "bare-x-to-pdf-linux-arm64": "0.4.0",
-    "bare-x-to-pdf-linux-x64": "0.4.0",
-    "bare-x-to-pdf-win32-x64": "0.4.0"
+    "bare-x-to-pdf-android-arm": "0.5.1",
+    "bare-x-to-pdf-android-arm64": "0.5.1",
+    "bare-x-to-pdf-android-x64": "0.5.1",
+    "bare-x-to-pdf-darwin-arm64": "0.5.1",
+    "bare-x-to-pdf-darwin-x64": "0.5.1",
+    "bare-x-to-pdf-ios-arm64": "0.5.1",
+    "bare-x-to-pdf-ios-arm64-simulator": "0.5.1",
+    "bare-x-to-pdf-ios-x64-simulator": "0.5.1",
+    "bare-x-to-pdf-linux-arm64": "0.5.1",
+    "bare-x-to-pdf-linux-x64": "0.5.1",
+    "bare-x-to-pdf-win32-x64": "0.5.1"
   }
 }

package/types.d.ts

@@ -0,0 +1 @@
+export function isMimeTypeSupported(mimetype: string): boolean

package/types.js

@@ -0,0 +1,19 @@
+const supportedDocumentMimetypes = [
+  'application/msword',
+  'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+  'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
+  'application/vnd.ms-word.document.macroenabled.12',
+  'application/vnd.ms-word.template.macroenabled.12',
+  'application/vnd.ms-excel',
+  'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+  'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
+  'application/vnd.ms-excel.sheet.macroenabled.12',
+  'application/vnd.ms-excel.template.macroenabled.12',
+  'application/vnd.openxmlformats-officedocument.presentationml.presentation'
+]
+
+function isMimeTypeSupported(mimetype) {
+  return supportedDocumentMimetypes.includes(mimetype)
+}
+
+exports.isMimeTypeSupported = isMimeTypeSupported

package/wasi.js

@@ -0,0 +1 @@
+exports.binding = require.addon()