echogarden 0.1.0 → 0.1.1

package/README.md

@@ -43,6 +43,12 @@ Additional tools:
 
 (hopefully in the future all platforms would be covered using expansion packages)
 
+## Updating to latest version
+
+```bash
+npm update echogarden -g
+```
+
 ## Next steps
 
 * [Using the command line interface](docs/CLI.md)

package/dist/synthesis/GoogleCloudTTS.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" resolution-mode="require"/>
 export declare function synthesize(text: string, apiKey: string, languageCode?: string, voice?: string, speakingRate?: number, pitchDeltaSemitones?: number, volumeGainDb?: number, ssml?: boolean, audioEncoding?: AudioEncoding, sampleRate?: number): Promise<{
     audioData: Buffer;
     timepoints: timePoint[];

package/docs/Engines.md

@@ -4,7 +4,7 @@
 ## Text to speech
 
 **Offline**:
-* [VITS](https://github.com/jaywalnut310/vits) (`vits`): a high-quality end-to-end neural speech synthesis model. Currently available models were trained by Michael Hansen as part of his [Piper speech synthesis system](https://github.com/rhasspy/piper). Supports English (US, UK), Spanish, Brazilian Portuguese, Italian, French, German, Dutch, Norwegian, Danish, Finnish, Polish, Ukrainian, Catalan, Kazakh, Nepali, Vietnamese and Chinese. You can listen to audio examples of all voices and languages on [Piper's samples page](https://rhasspy.github.io/piper-samples/).
+* [VITS](https://github.com/jaywalnut310/vits) (`vits`): a high-quality end-to-end neural speech synthesis architecture. Currently available models were trained by Michael Hansen as part of his [Piper speech synthesis system](https://github.com/rhasspy/piper). Supports English (US, UK), Spanish, Brazilian Portuguese, Italian, French, German, Dutch, Norwegian, Danish, Finnish, Polish, Ukrainian, Catalan, Kazakh, Nepali, Vietnamese and Chinese. You can listen to audio examples of all voices and languages on [Piper's samples page](https://rhasspy.github.io/piper-samples/).
 * [SVOX Pico](https://github.com/naggety/picotts) (`pico`): a diphone-based synthesizer. Supports English (US, UK), Spanish, Italian, French, and German.
 * [Flite](https://github.com/festvox/flite) (`flite`): a diphone-based synthesizer. Supports English (US, Scottish), and several Indic languages: Hindi, Bengali, Marathi, Telugu, Tamil, Gujarati, Kannada and Punjabi.
 * [eSpeak-NG](https://github.com/espeak-ng/espeak-ng/) (`espeak`): a formant-based synthesizer. Supports 100+ languages.
@@ -41,7 +41,7 @@ These cloud-based engines connect to public-facing cloud APIs that are not offic
 
 **Offline**:
 * [OpenAI Whisper](https://github.com/openai/whisper) (`whisper`): high accuracy transformer-based model. Supports 99 languages. There are several models of different sizes, some are multilingual, and some are English only (`.en`): `tiny`, `tiny.en`, `base`, `base.en`, `small`, `small.en`, `medium`, `medium.en`, `large`, `large-v1` and `large-v2`. _Note_: large models are not currently auto-downloaded as Echogarden packages, but may become available in the future.
-* [Vosk](https://github.com/alphacep/vosk-api) (`vosk`): models available for [25+ languages](https://alphacephei.com/vosk/models). _Note_: Vosk is not included in the default installation, but you can add support for it using `npm install @echogarden/vosk -g`. You'll need to download a model yourself and specify its directory path via the `vosk.modelPath` option.
+* [Vosk](https://github.com/alphacep/vosk-api) (`vosk`): models available for 25+ languages. _Note_: Vosk is not included in the default installation, but you can add support for it using `npm install @echogarden/vosk -g`. You'll need to manually [download a model](https://alphacephei.com/vosk/models) and specify its directory path via the `vosk.modelPath` option.
 * [Silero](https://github.com/snakers4/silero-models) (`silero`): models available for English, Spanish, German and Ukrainian. For [non-commercial use only](https://github.com/snakers4/silero-models/blob/master/LICENSE).
 
 **Cloud based**:

package/docs/Technical.md

@@ -1,9 +1,9 @@
 # Technical overview and Q&A
 
-* Echogarden is written in TypeScript and targets the Node.js platform
-* It uses ESM modules and latest ECMAScript and TypeScript features
+* Echogarden is written in TypeScript and targets the Node.js platform.
+* It uses ESM modules and latest ECMAScript and TypeScript features.
 * It does not depend on essential binary executables. Instead, all of its engines either use pure JavaScript, WebAssembly, WASI, or the ONNX runtime (with some exceptions: the CLI does use executables, loaded from an expansion package, for the SoX tool [and `ffmpeg` as well], which is used only for audio playback and recording. This simplifies the installation and ensures a non-buggy version is used. Since SoX `v14.4.2` is broken on Windows, it bundles `v14.4.1`).
-* It does not depend on essential native modules requiring compilation with `node-gyp`. This greatly simplifies and ensures the success of the installation for end-users (the ONNX runtime bundles precompiled NAPI modules for all supported platforms - it doesn't require any compilation during installation)
+* It does not depend on essential native modules requiring compilation with `node-gyp`. This greatly simplifies and ensures the success of the installation for end-users (the ONNX runtime bundles precompiled NAPI modules for all supported platforms - it doesn't require any compilation during installation).
 
 ## Package system
 
@@ -16,11 +16,11 @@ Packages are downloaded as `.tar.gz` files, and are extracted to `[data-folder]/
 * `Users/User/Library/Application Support/echogarden` on macOS
 * `/home/user/.local/share/echogarden` on Linux
 
-By using downloadable packages, the installed size is made significantly smaller and the installation faster. The total size of all available packages is currently about 11.4GB (6.8GB compressed). Another advantage of using a data folder is that the data does not need to be re-downloaded when the program is updated.
+By using downloadable packages, the installed size is made significantly smaller and the installation faster. The total size of all available packages is currently about 12.8GB (8.29GB compressed). Another advantage of using a data folder is that the data does not need to be re-downloaded when the program is updated.
 
 ## Can the base install size be made smaller?
 
-The installed (uncompressed) size, including dependencies, is around 350MB. This is without any models or voices, which are downloaded as needed.
+The installed (uncompressed) size, including dependencies, is around 300MB. This is without any models or voices, which are downloaded as needed.
 
 Currently, the biggest contributors to the size are:
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "echogarden",
-	"version": "0.1.0",
+	"version": "0.1.1",
 	"description": "An integrated speech toolbox designed with end-users in mind.",
 	"author": "Rotem Dan",
 	"license": "GPL-3.0-only",
@@ -35,7 +35,7 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"main": "dist/API/API.js",
+	"main": "./dist/API/API.js",
 	"type": "module",
 	"files": [
 		"dist",
@@ -50,7 +50,7 @@
 		"generate-options-schema": "npx ts-json-schema-generator --path ./src/api/APIOptions.ts --unstable --type APIOptions --tsconfig ./tsconfig.json --out ./data/schemas/options.json"
 	},
 	"bin": {
-		"echogarden": "dist/cli/CLILauncher.js"
+		"echogarden": "./dist/cli/CLILauncher.js"
 	},
 	"dependencies": {
 		"@aws-sdk/client-polly": "^3.316.0",