emnapi 0.44.0 → 1.0.0

package/CMakeLists.txt

@@ -38,7 +38,7 @@ set(EMNAPI_THREADS_SRC
 )
 set(EMNAPI_SRC ${ENAPI_BASIC_SRC} ${EMNAPI_THREADS_SRC})
 
-set(EMNAPI_INCLUDE "${CMAKE_CURRENT_SOURCE_DIR}/include")
+set(EMNAPI_INCLUDE "${CMAKE_CURRENT_SOURCE_DIR}/include/node")
 set(EMNAPI_DEFINES "BUILDING_NODE_EXTENSION")
 
 set(EMNAPI_JS_LIB "${CMAKE_CURRENT_SOURCE_DIR}/dist/library_napi.js")
@@ -121,6 +121,7 @@ add_library(${EMNAPI_TARGET_NAME} STATIC ${EMNAPI_SRC} ${UV_SRC})
 target_include_directories(${EMNAPI_TARGET_NAME} PUBLIC ${EMNAPI_INCLUDE})
 target_compile_definitions(${EMNAPI_TARGET_NAME} PUBLIC ${EMNAPI_DEFINES})
 if(IS_EMSCRIPTEN)
+  set_target_properties(${EMNAPI_TARGET_NAME} PROPERTIES INTERFACE_LINK_DEPENDS ${EMNAPI_JS_LIB})
   target_link_options(${EMNAPI_TARGET_NAME} INTERFACE "--js-library=${EMNAPI_JS_LIB}")
 endif()
 
@@ -128,6 +129,7 @@ add_library(${EMNAPI_BASIC_TARGET_NAME} STATIC ${ENAPI_BASIC_SRC})
 target_include_directories(${EMNAPI_BASIC_TARGET_NAME} PUBLIC ${EMNAPI_INCLUDE})
 target_compile_definitions(${EMNAPI_BASIC_TARGET_NAME} PUBLIC ${EMNAPI_DEFINES})
 if(IS_EMSCRIPTEN)
+  set_target_properties(${EMNAPI_BASIC_TARGET_NAME} PROPERTIES INTERFACE_LINK_DEPENDS ${EMNAPI_JS_LIB})
   target_link_options(${EMNAPI_BASIC_TARGET_NAME} INTERFACE "--js-library=${EMNAPI_JS_LIB}")
 endif()
 
@@ -146,6 +148,11 @@ if(EMNAPI_BUILD_BASIC_MT)
   target_compile_options(${EMNAPI_BASIC_MT_TARGET_NAME} PUBLIC "-matomics" "-mbulk-memory")
   target_include_directories(${EMNAPI_BASIC_MT_TARGET_NAME} PUBLIC ${EMNAPI_INCLUDE})
   target_compile_definitions(${EMNAPI_BASIC_MT_TARGET_NAME} PUBLIC ${EMNAPI_DEFINES})
+
+  if(IS_EMSCRIPTEN)
+    set_target_properties(${EMNAPI_BASIC_MT_TARGET_NAME} PROPERTIES INTERFACE_LINK_DEPENDS ${EMNAPI_JS_LIB})
+    target_link_options(${EMNAPI_BASIC_MT_TARGET_NAME} INTERFACE "--js-library=${EMNAPI_JS_LIB}")
+  endif()
 endif()
 
 if(IS_EMSCRIPTEN OR (CMAKE_C_COMPILER_TARGET STREQUAL "wasm32-wasi-threads"))
@@ -160,6 +167,7 @@ if(EMNAPI_BUILD_MT)
   target_include_directories(${EMNAPI_MT_TARGET_NAME} PUBLIC ${EMNAPI_INCLUDE})
   target_compile_definitions(${EMNAPI_MT_TARGET_NAME} PUBLIC ${EMNAPI_DEFINES})
   if(IS_EMSCRIPTEN)
+    set_target_properties(${EMNAPI_MT_TARGET_NAME} PROPERTIES INTERFACE_LINK_DEPENDS ${EMNAPI_JS_LIB})
     target_link_options(${EMNAPI_MT_TARGET_NAME} INTERFACE "--js-library=${EMNAPI_JS_LIB}")
   endif()
   if(EMNAPI_WORKER_POOL_SIZE)
@@ -201,35 +209,41 @@ if(LIB_ARCH)
 endif()
 
 install(FILES
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/emnapi_common.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/emnapi.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/js_native_api_types.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/js_native_api.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/node_api_types.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/node_api.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/uv.h
-  DESTINATION "include/${PROJECT_NAME}")
+    ${CMAKE_CURRENT_SOURCE_DIR}/common.gypi
+    ${CMAKE_CURRENT_SOURCE_DIR}/emnapi.gyp
+  DESTINATION ".")
+
+install(FILES
+    ${CMAKE_CURRENT_SOURCE_DIR}/include/node/emnapi_common.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/include/node/emnapi.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/include/node/js_native_api_types.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/include/node/js_native_api.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/include/node/node_api_types.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/include/node/node_api.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/include/node/uv.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/include/node/config.gypi
+  DESTINATION "include/node")
 
 install(DIRECTORY
-  ${CMAKE_CURRENT_SOURCE_DIR}/include/uv
-  DESTINATION "include/${PROJECT_NAME}")
+  ${CMAKE_CURRENT_SOURCE_DIR}/include/node/uv
+  DESTINATION "include/node")
 
 install(FILES
     ${CMAKE_CURRENT_SOURCE_DIR}/dist/library_napi.js
-  DESTINATION "lib/${PROJECT_NAME}")
+  DESTINATION "dist")
 
 if(EMNAPI_INSTALL_SRC)
   install(FILES
       ${EMNAPI_SRC}
       "${CMAKE_CURRENT_SOURCE_DIR}/src/emnapi_internal.h"
-    DESTINATION "src/${PROJECT_NAME}")
+    DESTINATION "src")
   install(DIRECTORY
     ${CMAKE_CURRENT_SOURCE_DIR}/src/uv
-    DESTINATION "src/${PROJECT_NAME}")
+    DESTINATION "src")
   install(DIRECTORY
     ${CMAKE_CURRENT_SOURCE_DIR}/src/malloc
-    DESTINATION "src/${PROJECT_NAME}")
+    DESTINATION "src")
   install(DIRECTORY
     ${CMAKE_CURRENT_SOURCE_DIR}/src/thread
-    DESTINATION "src/${PROJECT_NAME}")
+    DESTINATION "src")
 endif()

package/README.md

@@ -4,15 +4,25 @@
   <img src="https://toyobayashi.github.io/emnapi-docs/emnapi.svg" alt="emnapi logo" width="256" />
 </p>
 
+## Sponsors
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/toyobayashi/toyobayashi/sponsorkit/sponsors.svg">
+    <img src='https://cdn.jsdelivr.net/gh/toyobayashi/toyobayashi/sponsorkit/sponsors.svg'/>
+  </a>
+</p>
+
 [![Build](https://github.com/toyobayashi/emnapi/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/toyobayashi/emnapi/actions/workflows/main.yml)
 
-[Node-API](https://nodejs.org/docs/latest/api/n-api.html) implementation for [Emscripten](https://emscripten.org/index.html), [wasi-sdk](https://github.com/WebAssembly/wasi-sdk) and clang with wasm support. napi-rs support is comming soon.
+[Node-API](https://nodejs.org/docs/latest/api/n-api.html) implementation for [Emscripten](https://emscripten.org/index.html), [wasi-sdk](https://github.com/WebAssembly/wasi-sdk) and clang with wasm support.
 
 This project aims to
 
 - Help users port their or existing Node-API native addons to wasm with code change as less as possible.
 - Make runtime behavior matches native Node.js as much as possible.
 
+This project also powers the WebAssembly feature for [napi-rs](https://github.com/napi-rs/napi-rs), and enables many Node.js native addons to run on [StackBlitz](https://stackblitz.com)'s WebContainer.
+
 See documentation for more details:
 - [https://toyobayashi.github.io/emnapi-docs/guide/](https://toyobayashi.github.io/emnapi-docs/guide/)
 - [https://emnapi-docs.vercel.app/guide/](https://emnapi-docs.vercel.app/guide/)
@@ -109,7 +119,7 @@ Create `hello.c`.
 ```c
 #include <node_api.h>
 
-#define NODE_API_CALL(env, the_call)                                \
+#define NODE_API_CALL(env, the_call)                            \
   do {                                                          \
     if ((the_call) != napi_ok) {                                \
       const napi_extended_error_info *error_info;               \
@@ -167,7 +177,7 @@ module.exports = (function (exports) {
 emcc -O3 \
      -DBUILDING_NODE_EXTENSION \
      "-DNAPI_EXTERN=__attribute__((__import_module__(\"env\")))" \
-     -I./node_modules/emnapi/include \
+     -I./node_modules/emnapi/include/node \
      -L./node_modules/emnapi/lib/wasm32-emscripten \
      --js-library=./node_modules/emnapi/dist/library_napi.js \
      -sEXPORTED_FUNCTIONS="['_malloc','_free','_napi_register_wasm_v1','_node_api_module_get_api_version_v1']" \
@@ -184,7 +194,7 @@ emcc -O3 \
 ```bash
 clang -O3 \
       -DBUILDING_NODE_EXTENSION \
-      -I./node_modules/emnapi/include \
+      -I./node_modules/emnapi/include/node \
       -L./node_modules/emnapi/lib/wasm32-wasi \
       --target=wasm32-wasi \
       --sysroot=$WASI_SDK_PATH/share/wasi-sysroot \
@@ -212,7 +222,7 @@ Choose `libdlmalloc.a` or `libemmalloc.a` for `malloc` and `free`.
 ```bash
 clang -O3 \
       -DBUILDING_NODE_EXTENSION \
-      -I./node_modules/emnapi/include \
+      -I./node_modules/emnapi/include/node \
       -L./node_modules/emnapi/lib/wasm32 \
       --target=wasm32 \
       -nostdlib \
@@ -456,7 +466,7 @@ em++ -O3 \
      "-DNAPI_EXTERN=__attribute__((__import_module__(\"env\")))" \
      -DNAPI_DISABLE_CPP_EXCEPTIONS \
      -DNODE_ADDON_API_ENABLE_MAYBE \
-     -I./node_modules/emnapi/include \
+     -I./node_modules/emnapi/include/node \
      -I./node_modules/node-addon-api \
      -L./node_modules/emnapi/lib/wasm32-emscripten \
      --js-library=./node_modules/emnapi/dist/library_napi.js \
@@ -476,7 +486,7 @@ clang++ -O3 \
         -DBUILDING_NODE_EXTENSION \
         -DNAPI_DISABLE_CPP_EXCEPTIONS \
         -DNODE_ADDON_API_ENABLE_MAYBE \
-        -I./node_modules/emnapi/include \
+        -I./node_modules/emnapi/include/node \
         -I./node_modules/node-addon-api \
         -L./node_modules/emnapi/lib/wasm32-wasi \
         --target=wasm32-wasi \
@@ -508,7 +518,7 @@ You can still use `wasm32-unknown-unknown` target if you use Node-API C API only
 ```bash
 clang++ -O3 \
         -DBUILDING_NODE_EXTENSION \
-        -I./node_modules/emnapi/include \
+        -I./node_modules/emnapi/include/node \
         -L./node_modules/emnapi/lib/wasm32 \
         --target=wasm32 \
         -fno-exceptions \
@@ -615,158 +625,166 @@ cmake --build build
 
 Output code can run in recent version modern browsers and Node.js latest LTS. IE is not supported.
 
-### Using Rust (Experimental)
+### Using node-gyp (Experimental)
 
-Currently you can use [napi-rs](https://github.com/napi-rs/napi-rs) like this, more work is working in progress.  
+Currently node-gyp works on Linux only and don't support static library linking in cross-compiling.
+There are opened PRs to try to make node-gyp work fine.
 
-Note: WASI target require rust nightly toolchain.
+- https://github.com/nodejs/gyp-next/pull/222
+- https://github.com/nodejs/node-gyp/pull/2974
 
-<details>
-<summary>Cargo.toml</summary><br />
-
-```toml
-[package]
-edition = "2021"
-name = "binding"
-version = "0.0.0"
-
-# We should build binary for WASI reactor
-# https://github.com/rust-lang/rust/pull/79997
-# https://github.com/WebAssembly/WASI/issues/24
-# for wasm
-[[bin]]
-name = "binding"
-path = "src/main.rs"
-
-# for native
-# [lib]
-# name = "binding"
-# path = "src/lib.rs"
-# crate-type = ["cdylib"]
-
-[dependencies]
-napi = { version = "2.12.1", default-features = false, features = ["napi8"] }
-napi-sys = { version = "2.2.3", features = ["napi8"] }
-napi-derive = "2.12.2"
-
-[build-dependencies]
-napi-build = "2.0.1"
-
-[profile.release]
-strip = "symbols"
-```
+If you experienced issues on Windows or macOS, please check the PRs for upstream changes detail and see
+[emnapi-node-gyp-test](https://github.com/toyobayashi/emnapi-node-gyp-test) for examples.
 
-</details>
+- Variables
 
-<details>
-<summary>.cargo/config.toml</summary><br />
-
-```toml
-[build]
-target = [
-  "wasm32-unknown-unknown",
-  "wasm32-wasi"
-]
-
-[target.wasm32-unknown-unknown]
-rustflags = [
-  "-L./node_modules/emnapi/lib/wasm32",
-  "-lemnapi",
-  "-ldlmalloc",
-  # "-lemmalloc",
-  "-C", "link-arg=--no-entry",
-  "-C", "link-arg=--initial-memory=16777216",
-  "-C", "link-arg=--export-dynamic",
-  "-C", "link-arg=--export=malloc",
-  "-C", "link-arg=--export=free",
-  "-C", "link-arg=--export=napi_register_wasm_v1",
-  "-C", "link-arg=--export-if-defined=node_api_module_get_api_version_v1",
-  "-C", "link-arg=--export-table",
-  "-C", "link-arg=--import-undefined",
-]
-
-[target.wasm32-wasi]
-rustflags = [
-  "-L./node_modules/emnapi/lib/wasm32-wasi",
-  "-lemnapi",
-  "-C", "link-arg=--initial-memory=16777216",
-  "-C", "link-arg=--export-dynamic",
-  "-C", "link-arg=--export=malloc",
-  "-C", "link-arg=--export=free",
-  "-C", "link-arg=--export=napi_register_wasm_v1",
-  "-C", "link-arg=--export-if-defined=node_api_module_get_api_version_v1",
-  "-C", "link-arg=--export-table",
-  "-C", "link-arg=--import-undefined",
-  "-Z", "wasi-exec-model=reactor", # +nightly
-]
-```
+Arch: `node-gyp configure --arch=<wasm32 | wasm64>`
 
-</details>
+```ts
+// node-gyp configure -- -Dvariable_name=value
 
-<details>
-<summary>src/main.rs</summary><br />
+declare var OS: 'emscripten' | 'wasi' | 'unknown' | ''
 
-```rust
-#![no_main]
+/**
+ * Enable async work and threadsafe-functions
+ * @default 0
+ */
+declare var wasm_threads: 0 | 1
 
-use napi_derive::napi;
+/** @default 1048576 */
+declare var stack_size: number
 
-#[napi]
-fn fibonacci(n: u32) -> u32 {
-  match n {
-    1 | 2 => 1,
-    _ => fibonacci(n - 1) + fibonacci(n - 2),
-  }
+/** @default 16777216 */
+declare var initial_memory: number
+
+/** @default 2147483648 */
+declare var max_memory: number
+
+/** @default path.join(path.dirname(commonGypiPath,'./dist/library_napi.js')) */
+declare var emnapi_js_library: string
+
+/** @default 0 */
+declare var emnapi_manual_linking: 0 | 1
+```
+
+- Create `binding.gyp`
+
+
+```py
+{
+  "targets": [
+    {
+      "target_name": "hello",
+      "sources": [
+        "hello.c"
+      ],
+      "conditions": [
+        ["OS == 'emscripten'", {
+          "product_extension": "js", # required
+
+          # Windows and Linux
+          "cflags": [],
+          "cflags_c": [],
+          "cflags_cc": [],
+          "ldflags": [],
+
+          # macOS uses following config
+          'xcode_settings': {
+            "WARNING_CFLAGS": [], # cflags
+            "OTHER_CFLAGS": [], # cflags_c
+            "OTHER_CPLUSPLUSFLAGS": [], # cflags_cc
+            "OTHER_LDFLAGS": [] # ldflags
+          }
+        }],
+        ["OS == 'wasi'", {
+          # ...
+        }],
+        ["OS == 'unknown' or OS == ''", {
+          # ...
+        }]
+      ]
+    }
+  ]
 }
 ```
 
-</details>
+- Add the following environment variables.
 
-<details>
-<summary>index.js</summary><br />
+```bash
+# Linux or macOS
+export GYP_CROSSCOMPILE=1
 
-```js
-const fs = require('fs')
-const path = require('path')
-const useWASI = false
+# emscripten
+export AR_target="$EMSDK/upstream/emscripten/emar"
+export CC_target="$EMSDK/upstream/emscripten/emcc"
+export CXX_target="$EMSDK/upstream/emscripten/em++"
 
-let wasi
-if (useWASI) {
-  const { WASI } = require('wasi')
-  wasi = new WASI({ /* ... */ })
-}
+# wasi-sdk
+export AR_target="$WASI_SDK_PATH/bin/ar"
+export CC_target="$WASI_SDK_PATH/bin/clang"
+export CXX_target="$WASI_SDK_PATH/bin/clang++"
+```
 
-const { instantiateNapiModule } = require('@emnapi/core')
+```bat
+@REM Windows
 
-const wasmBuffer = useWASI
-  ? fs.readFileSync(path.join(__dirname, './target/wasm32-wasi/release/binding.wasm'))
-  : fs.readFileSync(path.join(__dirname, './target/wasm32-unknown-unknown/release/binding.wasm'))
-
-instantiateNapiModule(wasmBuffer, {
-  context: require('@emnapi/runtime').getDefaultContext(),
-  wasi,
-  beforeInit ({ instance }) {
-    for (const sym in instance.exports) {
-      if (sym.startsWith('__napi_register__')) {
-        instance.exports[sym]()
-      }
-    }
-  },
-  overwriteImports (importObject) {
-    importObject.env = {
-      ...importObject.env,
-      ...importObject.napi,
-      ...importObject.emnapi
-    }
-  }
-}).then(({ napiModule }) => {
-  const binding = napiModule.exports
-  // output: 5
-  console.log(binding.fibonacci(5))
-})
+set GYP_CROSSCOMPILE=1
+
+@REM emscripten
+call set AR_target=%%EMSDK:\=/%%/upstream/emscripten/emar.bat
+call set CC_target=%%EMSDK:\=/%%/upstream/emscripten/emcc.bat
+call set CXX_target=%%EMSDK:\=/%%/upstream/emscripten/em++.bat
+
+@REM wasi-sdk
+call set AR_target=%%WASI_SDK_PATH:\=/%%/bin/ar.exe
+call set CC_target=%%WASI_SDK_PATH:\=/%%/bin/clang.exe
+call set CXX_target=%%WASI_SDK_PATH:\=/%%/bin/clang++.exe
 ```
 
-</details>
+- Build
+
+```bash
+# Linux or macOS
+
+# emscripten
+emmake node-gyp rebuild \
+  --arch=wasm32 \
+  --nodedir=./node_modules/emnapi \
+  -- -f make -DOS=emscripten # -Dwasm_threads=1
+
+# wasi
+node-gyp rebuild \
+  --arch=wasm32 \
+  --nodedir=./node_modules/emnapi \
+  -- -f make -DOS=wasi # -Dwasm_threads=1
+
+# bare wasm32
+node-gyp rebuild \
+  --arch=wasm32 \
+  --nodedir=./node_modules/emnapi \
+  -- -f make -DOS=unknown # -Dwasm_threads=1
+```
+
+```bat
+@REM Use make generator on Windows
+@REM Run the bat file in POSIX-like environment (e.g. Cygwin)
+
+@REM emscripten
+call npx.cmd node-gyp configure --arch=wasm32 --nodedir=./node_modules/emnapi -- -f make -DOS=emscripten
+call emmake.bat make -C %~dp0build
+
+@REM wasi
+call npx.cmd node-gyp configure --arch=wasm32 --nodedir=./node_modules/emnapi -- -f make -DOS=wasi
+make -C %~dp0build
+
+@REM bare wasm32
+call npx.cmd node-gyp configure --arch=wasm32 --nodedir=./node_modules/emnapi -- -f make -DOS=unknown
+make -C %~dp0build
+```
+
+### Using Rust
+
+See [napi-rs](https://github.com/napi-rs/napi-rs) 
 
 ### Multithread
 
@@ -846,7 +864,6 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Emscripten")
     "-sDEFAULT_PTHREAD_STACK_SIZE=2MB"
   )
 elseif(CMAKE_C_COMPILER_TARGET STREQUAL "wasm32-wasi-threads")
-  # Experimental
   target_link_libraries(hello emnapi-mt)
   set_target_properties(hello PROPERTIES SUFFIX ".wasm")
   target_compile_options(hello PRIVATE "-fno-exceptions" "-pthread")
@@ -887,7 +904,7 @@ emcmake cmake -DCMAKE_BUILD_TYPE=Release \
               -DEMNAPI_WORKER_POOL_SIZE=4 \
               -G Ninja -H. -Bbuild
 
-# wasi-sdk with thread support (Experimental)
+# wasi-sdk with thread support
 cmake -DCMAKE_TOOLCHAIN_FILE=$WASI_SDK_PATH/share/cmake/wasi-sdk-pthread.cmake \
       -DWASI_SDK_PREFIX=$WASI_SDK_PATH \
       -DEMNAPI_FIND_NODE_ADDON_API=ON \

package/cmake/wasm32.cmake

@@ -16,7 +16,7 @@ endif()
 
 set(CMAKE_C_COMPILER ${LLVM_PREFIX}/bin/clang${WASM_HOST_EXE_SUFFIX})
 set(CMAKE_CXX_COMPILER ${LLVM_PREFIX}/bin/clang++${WASM_HOST_EXE_SUFFIX})
-set(CMAKE_ASM_COMPILER ${LLVM_PREFIX}/bin/clang${WASI_HOST_EXE_SUFFIX})
+set(CMAKE_ASM_COMPILER ${LLVM_PREFIX}/bin/clang${WASM_HOST_EXE_SUFFIX})
 set(CMAKE_AR ${LLVM_PREFIX}/bin/llvm-ar${WASM_HOST_EXE_SUFFIX})
 set(CMAKE_RANLIB ${LLVM_PREFIX}/bin/llvm-ranlib${WASM_HOST_EXE_SUFFIX})
 set(CMAKE_C_COMPILER_TARGET ${triple})