v2.0 node

.github/workflows/nodejs-demos.yml

@@ -33,7 +33,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [14.x, 16.x, 18.x, 20.x]
+        node-version: [16.x, 18.x, 20.x]
 
     steps:
     - uses: actions/checkout@v3
@@ -43,8 +43,9 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
 
-    - name: Pre-build dependencies
-      run: npm install yarn
+    - name: Build Node.js SDK
+      run: yarn && yarn build
+      working-directory: binding/nodejs
 
     - name: Install dependencies
       run: yarn install
@@ -62,8 +63,9 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - name: Pre-build dependencies
-      run: npm install --global yarn
+    - name: Build Node.js SDK
+      run: yarn && yarn build
+      working-directory: binding/nodejs
 
     - name: Install dependencies
       run: yarn install
@@ -77,18 +79,18 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [lts/*]
 
     steps:
     - uses: actions/checkout@v3
 
-    - name: Use Node.js ${{ matrix.node-version }}
+    - name: Use Node.js LTS
       uses: actions/setup-node@v3
       with:
-        node-version: ${{ matrix.node-version }}
+        node-version: lts/*
 
-    - name: Pre-build dependencies
-      run: npm install yarn
+    - name: Build Node.js SDK
+      run: yarn && yarn build
+      working-directory: binding/nodejs
 
     - name: Install dependencies
       run: yarn install

.github/workflows/nodejs-perf.yml

@@ -32,14 +32,14 @@ jobs:
         os: [ubuntu-latest, windows-latest, macos-latest]
         include:
         - os: ubuntu-latest
-          init_performance_threshold_sec: 2.0
-          proc_performance_threshold_sec: 0.7
-        - os: windows-latest
           init_performance_threshold_sec: 2.5
           proc_performance_threshold_sec: 0.9
+        - os: windows-latest
+          init_performance_threshold_sec: 2.5
+          proc_performance_threshold_sec: 1.1
         - os: macos-latest
-          init_performance_threshold_sec: 3.5
-          proc_performance_threshold_sec: 0.9
+          init_performance_threshold_sec: 4.0
+          proc_performance_threshold_sec: 2.0
 
 
     steps:
@@ -50,9 +50,6 @@ jobs:
       with:
         node-version: 18.x
 
-    - name: Pre-build dependencies
-      run: npm install yarn
-
     - name: Install dependencies
       run: yarn install
 
@@ -69,26 +66,23 @@ jobs:
         include:
         - machine: rpi3-32
           init_performance_threshold_sec: 7.6
-          proc_performance_threshold_sec: 3.3
+          proc_performance_threshold_sec: 4.5
         - machine: rpi3-64
           init_performance_threshold_sec: 8.4
-          proc_performance_threshold_sec: 3.3
+          proc_performance_threshold_sec: 4.5
         - machine: rpi4-32
           init_performance_threshold_sec: 5.7
-          proc_performance_threshold_sec: 2.1
+          proc_performance_threshold_sec: 3.3
         - machine: rpi4-64
           init_performance_threshold_sec: 5.1
-          proc_performance_threshold_sec: 2.0
+          proc_performance_threshold_sec: 3.2
         - machine: jetson
           init_performance_threshold_sec: 5.1
-          proc_performance_threshold_sec: 2.0
+          proc_performance_threshold_sec: 3.2
 
     steps:
     - uses: actions/checkout@v3
 
-    - name: Pre-build dependencies
-      run: npm install --global yarn
-
     - name: Install dependencies
       run: yarn install
 

.github/workflows/nodejs.yml

@@ -35,7 +35,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [14.x, 16.x, 18.x, 20.x]
+        node-version: [16.x, 18.x, 20.x]
 
     steps:
     - uses: actions/checkout@v3
@@ -45,9 +45,6 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
 
-    - name: Pre-build dependencies
-      run: npm install yarn
-
     - name: Install dependencies
       run: yarn install
 
@@ -64,9 +61,6 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - name: Pre-build dependencies
-      run: npm install --global yarn
-
     - name: Install dependencies
       run: yarn install
 

binding/nodejs/README.md

@@ -15,7 +15,7 @@ Leopard is an on-device speech-to-text engine. Leopard is:
 
 ## Compatibility
 
-- Node.js 12+
+- Node.js 16+
 - Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (4, 3), and NVIDIA Jetson Nano.
 
 ## Installation
@@ -37,7 +37,7 @@ Create an instance of the engine and transcribe an audio file:
 ```javascript
 const {Leopard} = require("@picovoice/leopard-node");
 
-const accessKey = "${ACCESS_KEY}" // Obtained from the Picovoice Console (https://console.picovoice.ai/)
+const accessKey = "${ACCESS_KEY}"; // Obtained from the Picovoice Console (https://console.picovoice.ai/)
 const handle = new Leopard(accessKey);
 
 const result = handle.processFile('${AUDIO_PATH}');

binding/nodejs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picovoice/leopard-node",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "Picovoice Leopard Node.js binding",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",
@@ -38,7 +38,7 @@
   "homepage": "https://picovoice.ai/products/leopard/",
   "devDependencies": {
     "@types/jest": "^27.4.1",
-    "@types/node": "^17.0.21",
+    "@types/node": "^18.11.9",
     "@typescript-eslint/eslint-plugin": "^5.19.0",
     "@typescript-eslint/parser": "^5.19.0",
     "eslint": "^8.13.0",
@@ -53,7 +53,7 @@
     "wavefile": "^11.0.0"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=16.0.0"
   },
   "cpu": [
     "!ia32",

binding/nodejs/src/errors.ts

@@ -12,47 +12,81 @@
 
 import PvStatus from './pv_status_t';
 
-export class LeopardError extends Error {}
+export class LeopardError extends Error {
+  private readonly _message: string;
+  private readonly _messageStack: string[];
+
+  constructor(message: string, messageStack: string[] = []) {
+    super(LeopardError.errorToString(message, messageStack));
+    this._message = message;
+    this._messageStack = messageStack;
+  }
+
+  get message(): string {
+    return this._message;
+  }
+
+  get messageStack(): string[] {
+    return this._messageStack;
+  }
+
+  private static errorToString(
+    initial: string,
+    messageStack: string[]
+  ): string {
+    let msg = initial;
+
+    if (messageStack.length > 0) {
+      msg += `: ${messageStack.reduce(
+        (acc, value, index) => acc + '\n  [' + index + '] ' + value,
+        ''
+      )}`;
+    }
+
+    return msg;
+  }
+}
 
 export class LeopardOutOfMemoryError extends LeopardError {}
-export class LeopardIoError extends LeopardError {}
+export class LeopardIOError extends LeopardError {}
 export class LeopardInvalidArgumentError extends LeopardError {}
 export class LeopardStopIterationError extends LeopardError {}
 export class LeopardKeyError extends LeopardError {}
 export class LeopardInvalidStateError extends LeopardError {}
 export class LeopardRuntimeError extends LeopardError {}
 export class LeopardActivationError extends LeopardError {}
-export class LeopardActivationLimitReached extends LeopardError {}
-export class LeopardActivationThrottled extends LeopardError {}
-export class LeopardActivationRefused extends LeopardError {}
+export class LeopardActivationLimitReachedError extends LeopardError {}
+export class LeopardActivationThrottledError extends LeopardError {}
+export class LeopardActivationRefusedError extends LeopardError {}
 
 export function pvStatusToException(
   pvStatus: PvStatus,
-  errorMessage: string
+  errorMessage: string,
+  messageStack: string[] = []
 ): void {
   switch (pvStatus) {
     case PvStatus.OUT_OF_MEMORY:
-      throw new LeopardOutOfMemoryError(errorMessage);
+      throw new LeopardOutOfMemoryError(errorMessage, messageStack);
     case PvStatus.IO_ERROR:
-      throw new LeopardIoError(errorMessage);
+      throw new LeopardIOError(errorMessage, messageStack);
     case PvStatus.INVALID_ARGUMENT:
-      throw new LeopardInvalidArgumentError(errorMessage);
+      throw new LeopardInvalidArgumentError(errorMessage, messageStack);
     case PvStatus.STOP_ITERATION:
-      throw new LeopardStopIterationError(errorMessage);
+      throw new LeopardStopIterationError(errorMessage, messageStack);
     case PvStatus.KEY_ERROR:
-      throw new LeopardKeyError(errorMessage);
+      throw new LeopardKeyError(errorMessage, messageStack);
     case PvStatus.INVALID_STATE:
-      throw new LeopardInvalidStateError(errorMessage);
+      throw new LeopardInvalidStateError(errorMessage, messageStack);
     case PvStatus.RUNTIME_ERROR:
-      throw new LeopardRuntimeError(errorMessage);
+      throw new LeopardRuntimeError(errorMessage, messageStack);
     case PvStatus.ACTIVATION_ERROR:
-      throw new LeopardActivationError(errorMessage);
+      throw new LeopardActivationError(errorMessage, messageStack);
     case PvStatus.ACTIVATION_LIMIT_REACHED:
-      throw new LeopardActivationLimitReached(errorMessage);
+      throw new LeopardActivationLimitReachedError(errorMessage, messageStack);
     case PvStatus.ACTIVATION_THROTTLED:
-      throw new LeopardActivationThrottled(errorMessage);
+      throw new LeopardActivationThrottledError(errorMessage, messageStack);
     case PvStatus.ACTIVATION_REFUSED:
-      throw new LeopardActivationRefused(errorMessage);
+      throw new LeopardActivationRefusedError(errorMessage, messageStack);
     default:
       // eslint-disable-next-line no-console
       console.warn(`Unmapped error code: ${pvStatus}`);

binding/nodejs/src/index.ts

@@ -14,13 +14,13 @@ import { Leopard } from './leopard';
 
 import {
   LeopardActivationError,
-  LeopardActivationLimitReached,
-  LeopardActivationRefused,
-  LeopardActivationThrottled,
+  LeopardActivationLimitReachedError,
+  LeopardActivationRefusedError,
+  LeopardActivationThrottledError,
   LeopardError,
   LeopardInvalidArgumentError,
   LeopardInvalidStateError,
-  LeopardIoError,
+  LeopardIOError,
   LeopardKeyError,
   LeopardOutOfMemoryError,
   LeopardRuntimeError,
@@ -38,16 +38,16 @@ import {
 export {
   Leopard,
   LeopardActivationError,
-  LeopardActivationLimitReached,
-  LeopardActivationRefused,
-  LeopardActivationThrottled,
+  LeopardActivationLimitReachedError,
+  LeopardActivationRefusedError,
+  LeopardActivationThrottledError,
   LeopardOptions,
   LeopardError,
   LeopardInitOptions,
   LeopardInputOptions,
   LeopardInvalidArgumentError,
   LeopardInvalidStateError,
-  LeopardIoError,
+  LeopardIOError,
   LeopardKeyError,
   LeopardOutOfMemoryError,
   LeopardRuntimeError,