voice-runtime 0.0.1 → 1.0.0

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 Kartik Gupta
+
+   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

@@ -1,11 +1,248 @@
 # voice-runtime
 
-`voice-runtime` is the public npm entry point for TVIC: a local-first,
-provider-neutral runtime for building voice agents with bring-your-own
-telephony, speech, model, and synthesis providers.
+[![npm](https://img.shields.io/npm/v/voice-runtime.svg)](https://www.npmjs.com/package/voice-runtime)
+[![CI](https://github.com/Kkartik14/TVIC/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Kkartik14/TVIC/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
 
-This `0.0.x` package is an early preview that reserves the stable package name
-while the high-level `createVoiceAgent` API is being completed. It does not yet
-expose the executable runtime and should not be used in production.
+`voice-runtime` is the public npm entry point for
+[TVIC](https://github.com/Kkartik14/TVIC), a provider-neutral runtime for realtime
+voice agents with bring-your-own telephony, speech, model, and synthesis providers.
 
-Development happens in the [TVIC repository](https://github.com/Kkartik14/TVIC).
+## Status
+
+The package is the public Node.js entry point for the TVIC runtime. The first
+release targets Node 20 through 26 and ships both ESM and CommonJS entry points.
+It is server-side only: browser audio connects to a Node server through the
+browser-audio transport adapter, while browser imports from this package remain
+out of scope for the first release.
+
+The stable managed API assembles the STT → LLM → TTS pipeline from a prompt and
+provider configuration. The host application still owns its HTTP server,
+webhook authentication, browser-session authentication, and domain tools.
+
+This README describes the intended public contract; release status is tracked in
+the repository's `local/release/1.0.0/checklist.md`.
+
+## Install
+
+```sh
+npm install voice-runtime
+```
+
+The package has no provider SDK lock-in. You may use the built-in adapters, pass
+your own provider implementations, or mix both approaches.
+
+## Prompt-first agent
+
+```ts
+import { createVoiceAgent } from "voice-runtime";
+
+const agent = createVoiceAgent({
+  prompt: "You schedule appointments for Dr. Kartik. Be concise and confirm the time.",
+  providers: {
+    telephony: { provider: "web-client-audio" },
+    stt: { provider: "deepgram", apiKey: process.env.DEEPGRAM_API_KEY },
+    llm: {
+      provider: "openai",
+      apiKey: process.env.OPENAI_API_KEY,
+      model: "gpt-4.1-mini",
+    },
+    tts: {
+      provider: "cartesia",
+      apiKey: process.env.CARTESIA_API_KEY,
+      voiceId: process.env.CARTESIA_VOICE_ID,
+    },
+  },
+});
+
+// `callHandle` comes from a verified transport connection or your own adapter.
+const session = await agent.start({
+  callHandle,
+  channel: "web_audio",
+});
+
+for await (const event of session.run) {
+  if (event.kind === "transcript_delta") console.log("caller:", event.text);
+  if (event.kind === "error") console.error(event.error);
+}
+
+const result = await session.run;
+console.log(result.turnsHandled);
+await agent.stop();
+```
+
+`agent.start()` returns `{ sessionId, run }`. The `run` value is both an async
+event stream and an awaitable final result. The separate envelope is required by
+JavaScript Promise assimilation rules; returning the Promise-like run directly
+from an async `start()` method would make `await agent.start()` lose the session
+handle. Use `agent.run(options)` when you only need the final result.
+
+TVIC does not receive media from a prompt alone. A verified transport adapter
+must produce the `callHandle` passed to `start()`.
+
+For a built-in Web Client Audio or Twilio adapter, use the factory form so the
+adapter receives the session ID created by TVIC:
+
+```ts
+import { createTwilioMediaStreamsProvider, createVoiceAgent } from "voice-runtime";
+
+const telephony = createTwilioMediaStreamsProvider();
+
+const session = await agent.start({
+  call: verifiedInboundCall,
+  channel: "phone",
+  callHandle: ({ sessionId, call }) => telephony.acceptWebSocket(socket, call.id, sessionId),
+});
+```
+
+The factory runs after the runtime session exists and receives
+`{ sessionId, call, channel }`. The supplied call is required in this form, and
+its ID must match the returned handle's `callId`. Replace the provider and
+`channel` with `createWebClientAudioProvider()` and `"web_audio"` for browser
+audio. A preconstructed custom `CallHandle` is also supported when the adapter
+already knows how to correlate its events to the managed session.
+
+`agent.stop()` is idempotent. If a session is still running, it cancels and
+drains that session before closing the runtime and its stores.
+
+Errors on `VoiceEvent` and `MediaEvent` payloads are JSON-safe
+`NormalizedError` values. Check them with `isNormalizedError`; the
+`isTvicError` marker is reserved for thrown `TvicThrowableError` wrappers and
+is not present on plain event payloads.
+
+TVIC-created error codes use lowercase, namespaced identifiers such as
+`auth.invalid_key` and `provider.open_failed`. Custom calls to
+`normalizedError()` and `normalizeUnknownError()` must use one or more
+lowercase dot-separated segments; older persisted error records retain their
+legacy codes during migration.
+
+## What TVIC does
+
+Accepts call media, transcribes speech, decides when a caller actually finished
+their turn, runs a model and tools, synthesizes a reply incrementally, streams audio
+back, and handles interruption, cancellation, provider stalls, and hangup.
+
+Recordings, traces, incident analysis, and dashboards are deliberately out of scope.
+Those belong to Earshot, a separate voice observability product that integrates
+outside the realtime critical path.
+
+## Providers, models, and credentials
+
+Each stage is configured independently. Built-in options currently include:
+
+- STT: Deepgram, Sarvam, ElevenLabs Scribe, AssemblyAI, and Soniox.
+- LLM: OpenAI Responses.
+- TTS: Cartesia and ElevenLabs.
+- Transport: browser audio and inbound Twilio Media Streams.
+
+Maturity is intentionally explicit: Web Client Audio and inbound Twilio Media
+Streams are the stable transport candidates for `1.0.0`. The paid STT, LLM,
+and TTS adapters are currently `experimental`—their deterministic protocol
+coverage passes, but each still needs a credential-gated live-service check
+before release notes can call it stable. The root export `PROVIDER_STABILITY`
+contains the machine-readable labels.
+
+Pass an explicit `apiKey` or use the documented environment variable. Explicit
+credentials take precedence; missing credentials fail before a live session is
+created.
+
+| Provider   | Environment variable |
+| ---------- | -------------------- |
+| Deepgram   | `DEEPGRAM_API_KEY`   |
+| Sarvam     | `SARVAM_API_KEY`     |
+| ElevenLabs | `ELEVENLABS_API_KEY` |
+| AssemblyAI | `ASSEMBLYAI_API_KEY` |
+| Soniox     | `SONIOX_API_KEY`     |
+| OpenAI     | `OPENAI_API_KEY`     |
+| Cartesia   | `CARTESIA_API_KEY`   |
+
+STT, LLM, and TTS models are independent settings. TTS voice selection is also
+independent. Built-in TTS can read `CARTESIA_VOICE_ID` or
+`ELEVENLABS_VOICE_ID` for its voice. For complete provider-specific control,
+pass a constructed provider instance instead of a built-in configuration object.
+Built-in STT and OpenAI-compatible LLM configurations reject models outside the
+dated TVIC catalog unless `allowUnknownModel: true` is explicitly set.
+
+Tools are application-owned functions. Define their schema and executor once,
+then include them in the agent:
+
+```ts
+import { createVoiceAgent, defineTool } from "voice-runtime";
+
+const bookAppointment = defineTool<{ date: string }, { booked: boolean }>({
+  id: "book_appointment",
+  name: "book_appointment",
+  description: "Books an appointment for a requested date.",
+  inputSchema: { type: "object", required: ["date"] },
+  outputSchema: { type: "object", required: ["booked"] },
+  async execute(input) {
+    // Call your application service here; TVIC does not own domain state.
+    return { booked: input.date.length > 0 };
+  },
+});
+
+const providers = {
+  telephony: { provider: "web-client-audio" as const },
+  stt: { provider: "deepgram" as const, apiKey: process.env.DEEPGRAM_API_KEY },
+  llm: { provider: "openai" as const, apiKey: process.env.OPENAI_API_KEY },
+  tts: {
+    provider: "cartesia" as const,
+    apiKey: process.env.CARTESIA_API_KEY,
+    voiceId: process.env.CARTESIA_VOICE_ID,
+  },
+};
+
+const agentWithTools = createVoiceAgent({
+  prompt: "Schedule appointments and use the booking tool when needed.",
+  tools: [bookAppointment],
+  providers,
+});
+```
+
+Tool execution receives a session/turn-scoped `AbortSignal`; authorization,
+confirmation for irreversible actions, and domain-state writes remain the host
+application's responsibility.
+
+## Composable API
+
+Advanced runtime, media, provider, normalized-error, and durable-adapter APIs
+are exported from the package root. There are no advanced subpath imports in the
+first release. This lets a developer start with `createVoiceAgent` and later own
+the runtime/session/pipeline boundaries without changing package names.
+
+The host remains responsible for creating authenticated transport connections,
+owning HTTP/webhook lifecycle, and implementing application-domain tools. TVIC
+does not automatically create public unauthenticated endpoints or choose a
+provider fallback policy.
+
+## Persistence adapters
+
+The root also exposes the PostgreSQL and Redis durability building blocks. The
+database drivers are intentionally injected, so install and configure `pg` and
+`redis` in your application:
+
+```ts
+import {
+  createPostgresMemory,
+  createPostgresRedisDurableRuntimeStore,
+  runPostgresMemoryMigrations,
+  runPostgresMigrations,
+} from "voice-runtime";
+
+await runPostgresMigrations(pgPool);
+await runPostgresMemoryMigrations(memoryPool);
+const memory = createPostgresMemory({ pool: memoryPool });
+const durable = createPostgresRedisDurableRuntimeStore({
+  pool: pgPool,
+  redis: redisClient,
+});
+```
+
+The migration SQL is bundled into the published package and can also be
+inspected in the package's migration sources. Run each migration function once
+at deploy time; repeated calls are idempotent. PostgreSQL is authoritative for
+the composite store, while Redis is used for its cache/projection layer.
+
+## License
+
+[Apache-2.0](./LICENSE)