@sidevoice/engine 0.0.0 → 0.3.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Ruben Pahino
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,60 @@
+<!-- npm shows this file on the package page. Images by absolute URL: npm serves no file of the repository. The
+     light/dark pair as in the repository's README; where the page ignores <picture>, the light one shows. -->
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sidevoice/sidevoice-engine/main/.github/assets/readme-header-on-dark.svg" />
+  <img alt="Sidevoice — Give your coding agent a voice. Keep the conversation." src="https://raw.githubusercontent.com/sidevoice/sidevoice-engine/main/.github/assets/readme-header.svg" width="750" />
+</picture>
+
+# @sidevoice/engine
+
+The [Sidevoice](https://github.com/sidevoice) engine for the web: it knows a catalogue of local voice models, works
+out which build of each fits the device, and takes the chosen one from absent to ready. This package is its
+WebAssembly build (`wasm-bindgen --target web`).
+
+```js
+import init, { WebEngine } from "@sidevoice/engine";
+
+await init();
+// The page says what it has; the engine keeps its files in OPFS and downloads them with fetch.
+const engine = await WebEngine.create({
+  async capabilities() {
+    return { os: "web", arch: "wasm32", accelerators: navigator.gpu ? ["webgpu", "wasm"] : ["wasm"] };
+  },
+  credential(provider) { // optional: a remote provider's key ("openai", "elevenlabs"), or null
+    return localStorage.getItem(`key:${provider}`);
+  },
+});
+const local = engine.localCatalog();
+const models = await local.models(); // LocalModelInfo[]: each with its builds ranked, whether it is installed
+const whisper = await engine.load("whisper-small", undefined, (progress) => show(progress), abort.signal);
+const stt = whisper.asStt();
+const text = await stt.transcribe(samples, 48000, "es"); // any rate: the engine resamples
+const kokoro = await engine.load("kokoro-82m-v1.0");
+const { samples: speech, sampleRate } = await kokoro.asTts().speak("Hola", "ef_dora", "es");
+const silero = await engine.load("silero-vad");
+const mic = await silero.asVad().stream({ minSilenceMs: 500 }); // a state of its own; mic.sampleRate is 16000
+const { frames, events } = await mic.accept(pcm); // events: { type: "speech-start", at } | { type: "speech-end", start, end }
+const smartTurn = await engine.load("smart-turn-v3.2");
+const p = await smartTurn.asEndOfTurn().probability(turnSoFar, 48000); // the probability the speaker has finished
+stt.free(); // the model leaves memory once its LocalModel and the Stt and Tts it handed out are freed
+whisper.free(); // (or collected)
+
+// Every catalogue alike: "local", then each remote provider, listed live with the app's keys, kept in memory only.
+for (const catalog of engine.catalogs()) {
+  const { reason, stale, detail } = await catalog.status(); // reason absent when current
+  const speakers = await catalog.models("tts"); // each { id, capabilities, languages, voices, speed? }, and its own fields
+}
+const elevenlabs = engine.remoteCatalog("elevenlabs");
+await elevenlabs.refresh(); // read again now
+const scribe = await elevenlabs.load("scribe_v2"); // a RemoteModel: the same asStt(), asTts()
+const heard = await scribe.asStt().transcribe(samples, 48000, "es");
+```
+
+Every promise rejects with an `Error` carrying the engine's stable `code` and its `params`, for the page to
+translate. Models run through [transformers.js](https://github.com/huggingface/transformers.js), a dependency of
+this package that the engine imports only when a model is loaded; Kokoro's phonemes come from eSpeak NG (the
+`espeak-ng` package), under the **GPL-3.0-or-later**: see `THIRD_PARTY_NOTICES.md`.
+
+Source, documentation and issues: https://github.com/sidevoice/sidevoice-engine
+
+Apache-2.0. Sidevoice is a trademark; see TRADEMARKS.md in the repository.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,18 @@
+# Third-party notices
+
+`@sidevoice/engine` is Apache-2.0. It depends on the packages below, which npm installs beside it; each keeps its own
+licence. The engine imports them only when a model of the transformers.js backend is loaded, and does not bundle them:
+an app that bundles the engine for the browser bundles whatever of them its bundler pulls in, under their licences.
+
+| Package | Version | Licence | What the engine uses it for |
+|---|---|---|---|
+| [`@huggingface/transformers`](https://github.com/huggingface/transformers.js) | 4.3.1 | Apache-2.0 | Runs the web builds of the catalogue (Whisper, Kokoro, Supertonic) on ONNX Runtime Web |
+| [`onnxruntime-web`](https://github.com/microsoft/onnxruntime) (through transformers.js) | as transformers.js pins it | MIT | The ONNX runtime transformers.js runs models on |
+| [`espeak-ng`](https://github.com/ianmarmour/espeak-ng.js) ([eSpeak NG](https://github.com/espeak-ng/espeak-ng) compiled to WebAssembly, with its language data) | 1.0.2 | **GPL-3.0-or-later** | Kokoro's phonemes, for every language Kokoro speaks in the browser |
+
+**eSpeak NG is under the GPL-3.0-or-later**, unlike the engine. Whether and how the engine ships with it is an open
+decision, tracked in [sidevoice-engine#30](https://github.com/sidevoice/sidevoice-engine/issues/30); until it is taken,
+this notice says what the package depends on, and nothing here settles it.
+
+The models themselves are not part of the package: the engine downloads each from the URL its catalogue pins, under
+the model's own licence, which the local catalogue's `models()` reports per model.