Publish npm package with node-addon-api for Windows (#838)

.github/scripts/node-addon/notes.md

@@ -6,3 +6,4 @@ See also
   - https://stackoverflow.com/questions/15176082/npm-package-json-os-specific-dependency
   - https://github.com/WonderInventions/node-webrtc/blob/develop/lib/binding.js
   - cross-compiling https://github.com/nodejs/node-gyp/issues/829#issuecomment-665527032
+  - https://nodejs.github.io/node-addon-examples/build-tools/cmake-js

.github/scripts/node-addon/package-optional.json

@@ -1,5 +1,5 @@
 {
-  "name": "sherpa-onnx-PLATFORM-ARCH",
+  "name": "sherpa-onnx-PLATFORM2-ARCH",
   "version": "SHERPA_ONNX_VERSION",
   "description": "Speech-to-text and text-to-speech using Next-gen Kaldi without internet connection",
   "main": "index.js",

.github/scripts/node-addon/package.json

@@ -47,6 +47,7 @@
   "optionalDependencies": {
     "sherpa-onnx-darwin-arm64": "^SHERPA_ONNX_VERSION",
     "sherpa-onnx-darwin-x64": "^SHERPA_ONNX_VERSION",
-    "sherpa-onnx-linux-x64": "^SHERPA_ONNX_VERSION"
+    "sherpa-onnx-linux-x64": "^SHERPA_ONNX_VERSION",
+    "sherpa-onnx-win-x64": "^SHERPA_ONNX_VERSION"
   }
 }

.github/scripts/node-addon/run.sh

@@ -7,6 +7,11 @@ src_dir=$sherpa_onnx_dir/.github/scripts/node-addon
 
 platform=$(node -p "require('os').platform()")
 arch=$(node -p "require('os').arch()")
+platform2=$platform
+
+if [[ $platform == win32 ]]; then
+  platform2=win
+fi
 
 SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
 echo "SHERPA_ONNX_VERSION $SHERPA_ONNX_VERSION"
@@ -17,6 +22,7 @@ fi
 
 sed -i.bak s/SHERPA_ONNX_VERSION/$SHERPA_ONNX_VERSION/g $src_dir/package-optional.json
 sed -i.bak s/k2-fsa/$owner/g $src_dir/package-optional.json
+sed -i.bak s/PLATFORM2/$platform2/g $src_dir/package-optional.json
 sed -i.bak s/PLATFORM/$platform/g $src_dir/package-optional.json
 sed -i.bak s/ARCH/$arch/g $src_dir/package-optional.json
 

.github/workflows/npm-addon-linux-x64.yaml

@@ -66,30 +66,26 @@ jobs:
       - name: Build sherpa-onnx node-addon
         shell: bash
         run: |
-          export PKG_CONFIG_PATH=$PWD/build/install:$PKG_CONFIG_PATH
+          d=$PWD
+          export SHERPA_ONNX_INSTALL_DIR=$d/build/install
+
           sudo mkdir /shared
           sudo ln -s $PWD/build /shared/
 
           ls -lh /shared/build
 
-          pkg-config --cflags sherpa-onnx
-          pkg-config --libs sherpa-onnx
-
           cd scripts/node-addon-api/
 
           npm i
 
-          ./node_modules/.bin/node-gyp configure build --verbose
+          ./node_modules/.bin/cmake-js compile --log-level verbose
 
       - name: Prepare for publish
         shell: bash
         run: |
-          export PKG_CONFIG_PATH=$PWD/build/install:$PKG_CONFIG_PATH
-
           owner=${{ github.repository_owner }}
           export owner
 
-
           echo "---"
           ls -lh build/install/lib/
           sudo chown -R runner ./build

.github/workflows/npm-addon-macos.yaml

@@ -61,31 +61,24 @@ jobs:
             ..
           make -j install
 
-
-
       - name: Build sherpa-onnx node-addon
         shell: bash
         run: |
-          export PKG_CONFIG_PATH=$PWD/build/install:$PKG_CONFIG_PATH
+          d=$PWD
-
+          export SHERPA_ONNX_INSTALL_DIR=$d/build/install
-          pkg-config --cflags sherpa-onnx
-          pkg-config --libs sherpa-onnx
 
           cd scripts/node-addon-api/
 
           npm i
 
-          ./node_modules/.bin/node-gyp configure build --verbose
+          ./node_modules/.bin/cmake-js compile --log-level verbose
 
       - name: Prepare for publish
         shell: bash
         run: |
-          export PKG_CONFIG_PATH=$PWD/build/install:$PKG_CONFIG_PATH
-
           owner=${{ github.repository_owner }}
           export owner
 
-
           ls -lh build/install/lib/
           echo "---"
 

.github/workflows/npm-addon-win-x64.yaml

@@ -0,0 +1,110 @@
+name: npm-addon-win-x64
+
+on:
+  workflow_dispatch:
+
+concurrency:
+  group: npm-addon-win-x64-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  npm-addon-win-x64:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest]
+        python-version: ["3.8"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: actions/setup-node@v4
+        with:
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Display node version
+        shell: bash
+        run: |
+          node --version
+
+      - name: Build sherpa-onnx
+        shell: bash
+        run: |
+          mkdir build
+          cd build
+          cmake \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_INSTALL_PREFIX=./install \
+            -DBUILD_SHARED_LIBS=ON \
+            -DSHERPA_ONNX_ENABLE_WEBSOCKET=OFF \
+            -DSHERPA_ONNX_ENABLE_PORTAUDIO=OFF \
+            -DSHERPA_ONNX_ENABLE_BINARY=OFF \
+            ..
+
+          ls -lh  _deps/onnxruntime-src/lib/
+
+          cmake --build . --config Release --target install -- -m:6
+
+          ls -lh install/lib
+
+          echo "----------"
+
+          cp -v  _deps/onnxruntime-src/lib/*.lib ./install/lib
+
+          echo "----------"
+
+          ls -lh install/lib
+
+      - name: Build sherpa-onnx node-addon
+        shell: bash
+        run: |
+          d=$PWD
+          export SHERPA_ONNX_INSTALL_DIR=$d/build/install
+
+          cd scripts/node-addon-api/
+
+          npm i
+
+          ./node_modules/.bin/cmake-js compile --log-level verbose
+
+      - name: Prepare for publish
+        shell: bash
+        run: |
+          owner=${{ github.repository_owner }}
+          export owner
+
+          echo "---"
+          ls -lh build/install/lib/
+          echo "---"
+          ls -lh build/install/lib/
+          echo "---"
+
+          .github/scripts/node-addon/run.sh
+
+      - name: Display files to be published
+        shell: bash
+        run: |
+          ls -lh ./sherpa-onnx-node
+
+      - name: Publish
+        shell: bash
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          cd ./sherpa-onnx-node
+          npm install
+          npm ci
+          # see https://docs.npmjs.com/generating-provenance-statements
+          npm publish --provenance --access public

.github/workflows/test-nodejs-addon-api.yaml

@@ -39,7 +39,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-11, macos-14, ubuntu-20.04, ubuntu-22.04]
+        os: [macos-11, macos-14, ubuntu-20.04, ubuntu-22.04, windows-latest]
         node-version: ["16", "17", "18", "19", "21", "22"]
         python-version: ["3.8"]
 
@@ -53,6 +53,16 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Install Python dependencies
+        shell: bash
+        run: |
+          pip install ninja
+
+      - name: Show ninja help
+        shell: bash
+        run: |
+          ninja --help || true
+
       - uses: actions/setup-node@v4
         with:
           registry-url: 'https://registry.npmjs.org'
@@ -63,12 +73,18 @@ jobs:
         run: |
           node --version
 
+      - name: Display npm help
+        shell: bash
+        run: |
+          npm help
+
       - name: ccache
         uses: hendrikmuhs/ccache-action@v1.2
         with:
           key: ${{ matrix.os }}-release-shared
 
       - name: Build sherpa-onnx
+        if: matrix.os == 'windows-latest'
         shell: bash
         run: |
           export CMAKE_CXX_COMPILER_LAUNCHER=ccache
@@ -77,34 +93,71 @@ jobs:
           mkdir build
           cd build
           cmake \
-            -DCMAKE_INSTALL_PREFIX=/tmp/sherpa-onnx \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_INSTALL_PREFIX=./install \
             -DBUILD_SHARED_LIBS=ON \
             -DSHERPA_ONNX_ENABLE_WEBSOCKET=OFF \
             -DSHERPA_ONNX_ENABLE_PORTAUDIO=OFF \
             -DSHERPA_ONNX_ENABLE_BINARY=OFF \
             ..
-          make -j
+
-          make install
+          ls -lh  _deps/onnxruntime-src/lib/
+
+          cmake --build . --config Release --target install -- -m:6
+
+          ls -lh install/lib
+
+          echo "----------"
+
+          cp -v  _deps/onnxruntime-src/lib/*.lib ./install/lib
+
+          echo "----------"
+
+          ls -lh install/lib
+
+      - name: Build sherpa-onnx
+        if: matrix.os != 'windows-latest'
+        shell: bash
+        run: |
+          export CMAKE_CXX_COMPILER_LAUNCHER=ccache
+          export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+
+          mkdir build
+          cd build
+          cmake \
+            -G Ninja \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_INSTALL_PREFIX=./install \
+            -DBUILD_SHARED_LIBS=ON \
+            -DSHERPA_ONNX_ENABLE_WEBSOCKET=OFF \
+            -DSHERPA_ONNX_ENABLE_PORTAUDIO=OFF \
+            -DSHERPA_ONNX_ENABLE_BINARY=OFF \
+            ..
+
+          cmake --build . --config Release --target install -- -j 6
 
       - name: Build node-addon-api package
         shell: bash
         run: |
+          d=$PWD
+          export SHERPA_ONNX_INSTALL_DIR=$d/build/install
+
           cd scripts/node-addon-api
 
-          export PKG_CONFIG_PATH=/tmp/sherpa-onnx:$PKG_CONFIG_PATH
+          echo $d/build/install
 
-          ls -lh /tmp/sherpa-onnx
+          ls -lh $d/build/install
-
-          pkg-config --cflags sherpa-onnx
-          pkg-config --libs sherpa-onnx
 
           npm i
 
-          ./node_modules/.bin/node-gyp configure build --verbose
+          ./node_modules/.bin/cmake-js compile --log-level verbose
 
       - name: Test streaming transducer
         shell: bash
         run: |
+          export PATH=$PWD/build/install/lib:$PATH
+          export LD_LIBRARY_PATH=$PWD/build/install/lib:$LD_LIBRARY_PATH
+
           cd scripts/node-addon-api
           curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20.tar.bz2
           tar xvf sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20.tar.bz2

.github/workflows/test-nodejs-addon-npm.yaml

@@ -42,7 +42,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-11, macos-14, ubuntu-20.04, ubuntu-22.04]
+        os: [macos-11, macos-14, ubuntu-20.04, ubuntu-22.04, windows-latest]
         node-version: ["16", "17", "18", "19", "21", "22"]
 
     steps:

python-api-examples/offline-tts.py

@@ -26,14 +26,14 @@ python3 ./python-api-examples/offline-tts.py \
 
 Example (2/2)
 
-wget https://github.com/k2-fsa/sherpa-onnx/releases/download/tts-models/vits-zh-aishell3.tar.bz2
+wget https://github.com/k2-fsa/sherpa-onnx/releases/download/tts-models/vits-icefall-zh-aishell3.tar.bz2
-tar xvf vits-zh-aishell3.tar.bz2
+tar xvf vits-icefall-zh-aishell3.tar.bz2
 
 python3 ./python-api-examples/offline-tts.py \
- --vits-model=./vits-aishell3.onnx \
+ --vits-model=./model.onnx \
  --vits-lexicon=./lexicon.txt \
  --vits-tokens=./tokens.txt \
- --tts-rule-fsts=./rule.fst \
+ --tts-rule-fsts='./phone.fst,./date.fst,./number.fst' \
  --sid=21 \
  --output-filename=./liubei-21.wav \
  "勿以恶小而为之，勿以善小而不为。惟贤惟德，能服于人。122334"

scripts/node-addon-api/CMakeLists.txt

@@ -0,0 +1,78 @@
+# See also https://github.com/cmake-js/cmake-js
+# npm install cmake-js
+# ./node_modules/.bin/cmake-js --help
+# ./node_modules/.bin/cmake-js --version
+# ./node_modules/.bin/cmake-js compile --help
+# ./node_modules/.bin/cmake-js compile --log-level
+# ./node_modules/.bin/cmake-js compile --log-level verbose
+cmake_minimum_required(VERSION 3.15)
+cmake_policy(SET CMP0091 NEW)
+cmake_policy(SET CMP0042 NEW)
+
+project(sherpa-onnx)
+
+set(CMAKE_CXX_STANDARD 14)
+
+add_definitions(-DNAPI_VERSION=3)
+
+include_directories(${CMAKE_JS_INC})
+
+set(srcs
+  src/sherpa-onnx-node-addon-api.cc
+  src/streaming-asr.cc
+  src/wave-reader.cc
+)
+
+if(NOT DEFINED ENV{SHERPA_ONNX_INSTALL_DIR})
+  message(FATAL_ERROR "
+Please run:
+git clone https://github.com/k2-fsa/sherpa-onnx
+cd sherpa-onnx
+mkdir build
+cd build
+cmake -DBUILD_SHARED_LIBS=ON -DCMAKE_INSTALL_PREFIX=./install ..
+make install
+export SHERPA_ONNX_INSTALL_DIR=$PWD/install
+  ")
+endif()
+
+include_directories($ENV{SHERPA_ONNX_INSTALL_DIR}/include)
+
+# See https://nodejs.github.io/node-addon-examples/build-tools/cmake-js
+# Include Node-API wrappers
+execute_process(
+  COMMAND node -p "require('node-addon-api').include"
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+    OUTPUT_VARIABLE NODE_ADDON_API_DIR
+)
+
+string(REPLACE "\n" "" NODE_ADDON_API_DIR ${NODE_ADDON_API_DIR})
+string(REPLACE "\"" "" NODE_ADDON_API_DIR ${NODE_ADDON_API_DIR})
+include_directories(${NODE_ADDON_API_DIR})
+
+link_directories($ENV{SHERPA_ONNX_INSTALL_DIR}/lib)
+
+add_library(${PROJECT_NAME} SHARED ${srcs} ${CMAKE_JS_SRC})
+set_target_properties(${PROJECT_NAME} PROPERTIES PREFIX "" SUFFIX ".node")
+target_link_libraries(${PROJECT_NAME} ${CMAKE_JS_LIB})
+
+target_link_libraries(${PROJECT_NAME}
+  sherpa-onnx-c-api
+  sherpa-onnx-core
+  kaldi-decoder-core
+  sherpa-onnx-kaldifst-core
+  sherpa-onnx-fstfar
+  sherpa-onnx-fst
+  kaldi-native-fbank-core
+  piper_phonemize
+  espeak-ng
+  ucd
+  onnxruntime
+  -Wl,-rpath,$ENV{SHERPA_ONNX_INSTALL_DIR}/lib
+)
+
+
+if(MSVC AND CMAKE_JS_NODELIB_DEF AND CMAKE_JS_NODELIB_TARGET)
+  # Generate node.lib
+  execute_process(COMMAND ${CMAKE_AR} /def:${CMAKE_JS_NODELIB_DEF} /out:${CMAKE_JS_NODELIB_TARGET} ${CMAKE_STATIC_LINKER_FLAGS})
+endif()

scripts/node-addon-api/binding.gyp

@@ -1,35 +0,0 @@
-{
-  'targets': [
-    {
-      'target_name': 'sherpa-onnx',
-      'sources': [
-        'src/sherpa-onnx-node-addon-api.cc',
-        'src/streaming-asr.cc',
-        'src/wave-reader.cc'
-      ],
-      'include_dirs': [
-        "<!@(node -p \"require('node-addon-api').include\")",
-        "<!@(pkg-config --variable=includedir sherpa-onnx)"
-      ],
-      'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
-      'cflags!': [
-        '-fno-exceptions',
-      ],
-      'cflags_cc!': [
-        '-fno-exceptions',
-        '-std=c++17'
-      ],
-      'libraries': [
-        "<!@(pkg-config --libs sherpa-onnx)"
-      ],
-      'xcode_settings': {
-        'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
-        'CLANG_CXX_LIBRARY': 'libc++',
-        'MACOSX_DEPLOYMENT_TARGET': '10.7'
-      },
-      'msvs_settings': {
-        'VCCLCompilerTool': { 'ExceptionHandling': 1 },
-      }
-    }
-  ]
-}

scripts/node-addon-api/lib/addon.js

@@ -1,5 +1,9 @@
 const os = require('os');
-const platform_arch = `${os.platform()}-${os.arch()}`;
+
+// Package name triggered spam for sherpa-onnx-win32-x64
+// so we have renamed it to sherpa-onnx-win-x64
+const platform_arch =
+    `${os.platform() == 'win32' ? 'win' : os.platform()}-${os.arch()}`;
 const possible_paths = [
   '../build/Release/sherpa-onnx.node',
   '../build/Debug/sherpa-onnx.node',

scripts/node-addon-api/package.json

@@ -3,12 +3,12 @@
   "version": "1.0.0",
   "description": "Speech-to-text and text-to-speech using Next-gen Kaldi without internet connection",
   "dependencies": {
+    "cmake-js": "^6.0.0",
     "node-addon-api": "^1.1.0",
-    "bindings": "^1.5.0",
+    "perf_hooks": "*"
-    "perf_hooks": "*",
-    "node-gyp": "^8.3.0"
   },
   "scripts": {
+    "install": "cmake-js compile --log-level verbose",
     "test": "node --napi-modules ./test/test_binding.js"
   },
   "repository": {

scripts/node-addon-api/src/sherpa-onnx-node-addon-api.cc

@@ -3,7 +3,7 @@
 // Copyright (c)  2024  Xiaomi Corporation
 #include "napi.h"  // NOLINT
 
-Napi::Object InitStreamingAsr(Napi::Env env, Napi::Object exports);
+void InitStreamingAsr(Napi::Env env, Napi::Object exports);
 void InitWaveReader(Napi::Env env, Napi::Object exports);
 
 Napi::Object Init(Napi::Env env, Napi::Object exports) {