Publish node-addon-api wrapper for sherpa-onnx as npm packages (#829)

This commit is contained in:
Fangjun Kuang
2024-05-04 13:27:39 +08:00
committed by GitHub
parent 2f9553d838
commit 4f758e6cd3
27 changed files with 773 additions and 15 deletions

View File

@@ -0,0 +1,3 @@
# Introduction
Please see [sherpa-onnx-node](https://www.npmjs.com/package/sherpa-onnx-node)

11
.github/scripts/node-addon/README.md vendored Normal file
View File

@@ -0,0 +1,11 @@
# Introduction
Please see
https://github.com/k2-fsa/sherpa-onnx/blob/master/nodejs-addon-examples/README.md
for usages.
||Method|Support multiple threads|Minimum required node version|
|---|---|---|---|
|this package| https://github.com/nodejs/node-addon-api | Yes | v10|
|https://www.npmjs.com/package/sherpa-onnx| WebAssembly | No | v18|

1
.github/scripts/node-addon/index.js vendored Normal file
View File

@@ -0,0 +1 @@
module.exports = require('./sherpa-onnx.node');

8
.github/scripts/node-addon/notes.md vendored Normal file
View File

@@ -0,0 +1,8 @@
# Introduction
See also
- https://github.com/WonderInventions/node-webrtc/blob/develop/package.json
- 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

View File

@@ -0,0 +1,53 @@
{
"name": "sherpa-onnx-PLATFORM-ARCH",
"version": "SHERPA_ONNX_VERSION",
"description": "Speech-to-text and text-to-speech using Next-gen Kaldi without internet connection",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/k2-fsa/sherpa-onnx.git"
},
"keywords": [
"speech to text",
"text to speech",
"transcription",
"real-time speech recognition",
"without internet connection",
"embedded systems",
"open source",
"zipformer",
"asr",
"tts",
"stt",
"c++",
"onnxruntime",
"onnx",
"ai",
"next-gen kaldi",
"offline",
"privacy",
"open source",
"vad",
"speaker id",
"language id",
"node-addon-api",
"streaming speech recognition",
"speech",
"recognition"
],
"author": "The next-gen Kaldi team",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/k2-fsa/sherpa-onnx/issues"
},
"homepage": "https://github.com/k2-fsa/sherpa-onnx#readme",
"os": [
"PLATFORM"
],
"cpu": [
"ARCH"
]
}

52
.github/scripts/node-addon/package.json vendored Normal file
View File

@@ -0,0 +1,52 @@
{
"name": "sherpa-onnx-node",
"version": "SHERPA_ONNX_VERSION",
"description": "Speech-to-text and text-to-speech using Next-gen Kaldi without internet connection",
"main": "sherpa-onnx.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/k2-fsa/sherpa-onnx.git"
},
"keywords": [
"speech to text",
"text to speech",
"transcription",
"real-time speech recognition",
"without internet connection",
"embedded systems",
"open source",
"zipformer",
"asr",
"tts",
"stt",
"c++",
"onnxruntime",
"onnx",
"ai",
"next-gen kaldi",
"offline",
"privacy",
"open source",
"vad",
"speaker id",
"language id",
"node-addon-api",
"streaming speech recognition",
"speech",
"recognition"
],
"author": "The next-gen Kaldi team",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/k2-fsa/sherpa-onnx/issues"
},
"homepage": "https://github.com/k2-fsa/sherpa-onnx#readme",
"optionalDependencies": {
"sherpa-onnx-darwin-arm64": "^SHERPA_ONNX_VERSION",
"sherpa-onnx-darwin-x64": "^SHERPA_ONNX_VERSION",
"sherpa-onnx-linux-x64": "^SHERPA_ONNX_VERSION"
}
}

37
.github/scripts/node-addon/run.sh vendored Executable file
View File

@@ -0,0 +1,37 @@
#!/usr/bin/env bash
sherpa_onnx_dir=$PWD
echo "sherpa_onnx_dir: $sherpa_onnx_dir"
src_dir=$sherpa_onnx_dir/.github/scripts/node-addon
platform=$(node -p "require('os').platform()")
arch=$(node -p "require('os').arch()")
SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)
echo "SHERPA_ONNX_VERSION $SHERPA_ONNX_VERSION"
if [ -z $owner ]; then
owner=k2-fsa
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/PLATFORM/$platform/g $src_dir/package-optional.json
sed -i.bak s/ARCH/$arch/g $src_dir/package-optional.json
git diff $src_dir/package-optional.json
dst=$sherpa_onnx_dir/sherpa-onnx-node
mkdir -p $dst
cp $src_dir/package-optional.json $dst/package.json
cp $src_dir/index.js $dst/
cp $src_dir/README-optional.md $dst/README.md
cp -fv build/install/lib/lib* $dst/ || true
cp -fv build/install/lib/*dll $dst/ || true
cp scripts/node-addon-api/build/Release/sherpa-onnx.node $dst/
ls $dst