@rimelabs/sdk 0.1.0-alpha.1 → 0.1.0-alpha.10

package/CHANGELOG.md

@@ -1,16 +1,78 @@
 # Changelog
 
-## 0.1.0-alpha.1
+## [0.1.0-alpha.10](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.9...typescript-v0.1.0-alpha.10) (2026-10-08)
+
+
+### Bug Fixes
+
+* **deps:** bump @rimelabs/api from 0.1.0 to 0.2.0 in /typescript ([#31](https://github.com/rimelabs/rime-sdk/issues/31)) ([8a89dad](https://github.com/rimelabs/rime-sdk/commit/8a89dad7a5b0ca94da47641e5e91e031cf1ace6d))
+* **deps:** use versioned API packages across SDKs ([#34](https://github.com/rimelabs/rime-sdk/issues/34)) ([bde6ecb](https://github.com/rimelabs/rime-sdk/commit/bde6ecbb50028d9f920883d5c82732e3d14fb2ed))
+
+## [0.1.0-alpha.9](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.8...typescript-v0.1.0-alpha.9) (2026-10-08)
+
+
+### Bug Fixes
+
+* make package quickstarts usable without repository access ([#24](https://github.com/rimelabs/rime-sdk/issues/24)) ([3a30b83](https://github.com/rimelabs/rime-sdk/commit/3a30b83ecaad1740c84d1e8c005520522cf56d26))
+
+## [0.1.0-alpha.8](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.7...typescript-v0.1.0-alpha.8) (2026-10-08)
+
+
+### Features
+
+* add voice examples and automate example dependency updates ([#22](https://github.com/rimelabs/rime-sdk/issues/22)) ([dea7044](https://github.com/rimelabs/rime-sdk/commit/dea7044831058ebee9ae536e8d822a4d7fabbd3d))
+
+## [0.1.0-alpha.7](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.6...typescript-v0.1.0-alpha.7) (2026-10-07)
+
+
+### Bug Fixes
+
+* publish npm releases under the latest tag ([#20](https://github.com/rimelabs/rime-sdk/issues/20)) ([40cf8a4](https://github.com/rimelabs/rime-sdk/commit/40cf8a44720be24cd42acc5f9f97f1269b786e3e))
+
+## [0.1.0-alpha.6](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.5...typescript-v0.1.0-alpha.6) (2026-10-07)
+
 
-Initial local alpha for Node.js 22+ and ESM. Adds Coda synthesis, discovery,
-API-key authentication, sentence buffering, PCM and mu-law profiles, typed errors,
-deadlines, and cancellation. The Themis wire contract is assumed and needs
-deployment validation.
+### Features
+
+* add Prism realtime support to Python and TypeScript ([#18](https://github.com/rimelabs/rime-sdk/issues/18)) ([af56a96](https://github.com/rimelabs/rime-sdk/commit/af56a96f909b53ca1818b3cbc942f8d0812092ea))
+
+## [0.1.0-alpha.5](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.4...typescript-v0.1.0-alpha.5) (2026-09-29)
+
+
+### Bug Fixes
+
+* support API 0.1.0 in Python and TypeScript SDKs ([#16](https://github.com/rimelabs/rime-sdk/issues/16)) ([af0f646](https://github.com/rimelabs/rime-sdk/commit/af0f6467ffe662673e13a4f943351d4c8b88e0fa))
+
+## [0.1.0-alpha.4](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.3...typescript-v0.1.0-alpha.4) (2026-09-28)
+
+
+### Bug Fixes
+
+* **deps:** bump @rimelabs/api from 0.0.1 to 0.0.2 in /typescript ([8a57747](https://github.com/rimelabs/rime-sdk/commit/8a57747e6e07edfa7ec4f44238fb7074b7e010ab))
+
+## [0.1.0-alpha.3](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.2...typescript-v0.1.0-alpha.3) (2026-09-28)
+
+
+### Bug Fixes
+
+* match ITU mu-law quantization for negative PCM ([#10](https://github.com/rimelabs/rime-sdk/issues/10)) ([e03dcb3](https://github.com/rimelabs/rime-sdk/commit/e03dcb3424cab5a9b7d6bc9b1c37b3b72540e3a6))
+
+## [0.1.0-alpha.2](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.1...typescript-v0.1.0-alpha.2) (2026-09-28)
+
+- Add `model: "mistv3"` for Mist v3 speech, voice discovery, and language discovery.
+  The model selects its standard endpoint and default voice. Custom endpoints
+  retain the model's default voice. Coda remains the default model.
+- Reorganize the usage guide around examples and option tables. Clarify audio
+  output, timeout defaults, error handling, and cancellation.
+
+## 0.1.0-alpha.1
 
-Review fixes preserve zero-width spaces and BOM characters during sentence
-mapping, distinguish token-exchange rate limits and service failures from
-rejected credentials, and cancel failed HTTP response bodies.
+Initial public alpha for Node.js 22 and later, with ESM and TypeScript types:
 
-Further review fixes stop pending reads after cancellation, preserve errors from
-responses without audio metadata, handle responses with only trailers, and
-collect discovery request IDs from headers and trailers.
+- Stream Coda speech from a string or an async text source with API-key authentication.
+- Discover voices and languages, and select a custom deployment endpoint.
+- Receive raw 24 kHz PCM or 8 kHz mu-law audio with sentence buffering.
+- Set operation deadlines, cancel streams, and handle typed errors with request IDs.
+- Preserve original text during sentence detection, including zero-width spaces
+  and byte order marks.
+- Report server errors even when no audio metadata arrives or input writes fail.

package/LICENSE-PRISM

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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/NOTICE-PRISM

@@ -0,0 +1,9 @@
+Prism protocol implementation
+
+The TypeScript realtime session adapts the Python SDK and the reference client in
+rimelabs/sglang-omni at bc8a500249536f369d20bc094baa9169e5986758:
+  clients/prism_realtime/prism_realtime/client.py
+
+The reference file identifies its license as Apache-2.0. See LICENSE-PRISM.
+This SDK adds typed events, request and admission handling, AbortSignal
+cancellation, tool rounds, PCM conversion, and resource limits for Node.js.

package/README.md

@@ -1,93 +1,175 @@
 # Rime SDK for Node.js
 
-Requires Node.js 22 or later. The package uses ESM and includes TypeScript types.
-Browser use is not supported. This is an alpha release.
-Install it from npm using the `next` tag:
+Generate speech with TTS, or send speech to Prism and receive a spoken reply.
+Both APIs use the `Rime` client. Your application handles audio capture and playback.
+
+## Install
+
+Requires Node.js 22 or later. This alpha package uses ESM and includes TypeScript types.
+Run it on a server. Browser use is not supported.
 
 ```sh
-npm install @rimelabs/sdk@next
+mkdir rime-quickstart
+cd rime-quickstart
+npm init -y
+npm install @rimelabs/sdk wavefile
+export RIME_API_KEY="your-api-key"
 ```
 
+Get a TTS API key from the [Rime dashboard](https://app.rime.ai/).
+An explicit `new Rime({ apiKey: "..." })` overrides `RIME_API_KEY`. The SDK does not load `.env` files.
+The commands below use a macOS or Linux shell.
+
+These examples use JavaScript `.mjs` files so you can run them without a TypeScript build.
+The additional [wavefile package](https://github.com/rochars/wavefile) reads and writes WAV files
+for the examples. It is not required by the SDK.
+
+## TTS: save speech
+
+Save this as `tts.mjs`. It writes a playable `speech.wav` file with no audio-device dependencies.
+
 ```javascript
-import { writeFile } from "node:fs/promises";
-import { Rime, AudioFormat } from "@rimelabs/sdk";
+import { writeFileSync } from "node:fs";
+import wavefile from "wavefile";
+import { Rime } from "@rimelabs/sdk";
 
-const client = new Rime({ apiKey: "your-api-key" });
+const client = new Rime({ timeout: 60 });
 try {
-  const audio = client.tts.stream("Hello. This is Rime.", {
-    voice: "clementine",
-    audioFormat: AudioFormat.PCM_24000,
-  });
-  await writeFile("speech.pcm", audio);
-  console.log(audio.requestId);
+  const chunks = [];
+  for await (const chunk of client.tts.stream(
+    "Your appointment is confirmed for tomorrow.",
+  )) {
+    chunks.push(Buffer.from(chunk));
+  }
+  const pcm = Buffer.concat(chunks);
+  const samples = Array.from({ length: pcm.length / 2 }, (_, i) =>
+    pcm.readInt16LE(i * 2),
+  );
+  const wav = new wavefile.WaveFile();
+  wav.fromScratch(1, 24000, "16", samples);
+  writeFileSync("speech.wav", wav.toBuffer());
+  console.log("Saved speech.wav");
 } finally {
   await client.close();
 }
 ```
 
-Omit `apiKey` to read `RIME_API_KEY`. The default model is `coda`.
-The SDK selects its standard endpoint. Only `coda` is currently supported.
-For a custom deployment of that model, set `endpoint`:
-
-```javascript
-const client = new Rime({ model: "coda", endpoint: "coda.api.customer-name.rime.ai" });
-```
-
-Use a hostname with an optional port, such as `host:8443`. Omit the scheme and path.
-Connections always use TLS; the default port is `443`.
-The endpoint applies to speech, voices, and languages for this client.
-
-The default voice is `clementine`; the default language is `en`.
-`tts.stream()` also accepts `AsyncIterable<string>`. Do not await the factory.
-The first iterator read starts work. A `for await` loop exit cancels the stream.
-Use `await audio.cancel()` in a `finally` block if you read the iterator manually.
-
-`await client.voices.list({ language: "en" })` returns voice names.
-`await client.languages.list()` returns language codes.
-Both accept an options object with `timeout` in seconds.
+Run `node tts.mjs`, then open `speech.wav` in your audio player.
+This short example collects the audio in memory before writing the file.
+For long responses, write audio chunks as they arrive.
 
-`new Rime({ timeout: 30 })` sets an overall timeout. An operation can replace
-it with `{ timeout: 10 }` or disable it with `{ timeout: null }`.
-An omitted or `undefined` option inherits the client setting. Internal connection
-and progress limits still apply. An overall timeout continues during caller pauses.
+Coda is the default model. Use `new Rime({ model: "mistv3" })` for Mist v3, or pass
+`{ voice: "your-voice" }` as the second argument to `client.tts.stream(...)` to select a voice.
+The default output is mono 24 kHz PCM16. The example adds its WAV header.
+To supply text from an LLM, pass an async iterable of strings instead of a string.
+The SDK handles sentence boundaries.
 
-`audio.format` is a read-only `AudioFormat` with `encoding`, `sampleRate`, and
-`channels`. `PCM_24000` is raw signed 16-bit little-endian mono PCM at 24 kHz.
-`MULAW_8000` is raw mono G.711 mu-law at 8 kHz. Neither includes a file header.
-The iterator yields `Uint8Array` chunks with complete sample frames.
-Chunk sizes are not fixed.
+## Prism: send recorded speech
 
-`await audio.cancel()` cancels one operation. `await client.close()` cancels all
-client work. Both are idempotent. Both objects support `Symbol.asyncDispose`.
-Normal iterator completion means that the final service status was successful.
-Partial audio can precede a typed error. Synthesis is never replayed.
+Prism needs a deployment that serves its realtime API. Obtain the endpoint,
+credentials, and voice from your deployment operator. The TTS endpoint does not serve Prism.
+Set `RIME_API_KEY` to the credential for that deployment if it differs from your TTS key.
 
-Catch `RimeError` or one of `RimeAuthenticationError`, `RimePermissionError`,
-`RimeInputError`, `RimeResourceLimitError`, `RimeUnavailableError`,
-`RimeTimeoutError`, `RimeAudioFormatError`, `RimeCancelledError`, or
-`RimeStreamError`. Errors expose a message and optional `requestId`.
-Cancellation cannot stop application code that waits on an unrelated promise.
-The SDK stops its RPC and limits how long it waits for source cleanup.
-
-The SDK sends the API key as a bearer token over TLS.
-
-## Development for contributors
+```sh
+export PRISM_URL="wss://your-prism-host/v1/realtime"
+export PRISM_VOICE="your-deployment-voice"
+```
 
-These instructions require access to the source repository.
-Run the commands from its `typescript/` directory:
+You can omit `PRISM_VOICE` if the deployment has a default voice.
+Record a short question and export it as `question.wav`, using **16 kHz, mono, signed 16-bit PCM WAV**.
+Save the following as `prism.mjs` beside that file. It sends the recording at capture speed,
+then sends silence so Prism can detect the end of speech. The spoken reply goes to `reply.wav`.
 
-```sh
-npm ci
-npm run check
-npm run lint
-npm test
-npm pack
+```javascript
+import { readFileSync, writeFileSync } from "node:fs";
+import { setTimeout as sleep } from "node:timers/promises";
+import wavefile from "wavefile";
+import { Rime, RimeRealtimeError } from "@rimelabs/sdk";
+
+const input = new wavefile.WaveFile(readFileSync("question.wav"));
+if (
+  input.container !== "RIFF" ||
+  input.fmt.audioFormat !== 1 ||
+  input.fmt.numChannels !== 1 ||
+  input.fmt.sampleRate !== 16000 ||
+  input.bitDepth !== "16"
+) {
+  throw new Error("question.wav must be 16 kHz mono PCM16");
+}
+const data = Buffer.from(input.data.samples);
+if (!data.length || data.length % 2)
+  throw new Error("question.wav has no complete PCM16 audio");
+const endpoint = process.env.PRISM_URL;
+if (!endpoint)
+  throw new Error("Set PRISM_URL to your deployment's /v1/realtime URL");
+
+const client = new Rime();
+const stop = new AbortController();
+const deadline = setTimeout(() => {
+  stop.abort();
+  void client.close();
+}, 60_000);
+let sending;
+let reading;
+try {
+  const session = await client.realtime.connect({
+    endpoint,
+    voice: process.env.PRISM_VOICE,
+    instructions: "Give short, clear answers.",
+  });
+  sending = (async () => {
+    for (let offset = 0; ; offset += 1280) {
+      const frame = Buffer.alloc(1280);
+      if (offset < data.length)
+        data.copy(frame, 0, offset, Math.min(offset + 1280, data.length));
+      await session.sendAudio({ data: frame });
+      await sleep(40, undefined, { signal: stop.signal });
+    }
+  })();
+  const chunks = [];
+  reading = (async () => {
+    for await (const { payload } of session.events) {
+      if (payload.kind === "audio.delta")
+        chunks.push(Buffer.from(payload.audio.data));
+      if (payload.kind === "error") throw new RimeRealtimeError(payload.error);
+      if (payload.kind === "response.ended") {
+        if (payload.status !== "completed") {
+          throw new Error(`Response ${payload.status}: ${payload.reason}`);
+        }
+        return;
+      }
+    }
+    throw new Error("Session closed before the reply ended");
+  })();
+  await Promise.race([sending, reading]);
+  const pcm = Buffer.concat(chunks);
+  const samples = Array.from({ length: pcm.length / 2 }, (_, i) =>
+    pcm.readInt16LE(i * 2),
+  );
+  const wav = new wavefile.WaveFile();
+  wav.fromScratch(1, 24000, "16", samples);
+  writeFileSync("reply.wav", wav.toBuffer());
+  console.log("Saved reply.wav");
+} finally {
+  stop.abort();
+  clearTimeout(deadline);
+  await client.close();
+  await Promise.allSettled([sending, reading]);
+}
 ```
 
-The package includes a pinned Microsoft BlingFire WASM binary and its license.
-It does not download code at runtime. See [vendor provenance](vendor/README.md).
+Run `node prism.mjs`, then open `reply.wav`. This example has a 60-second deadline
+and collects the reply in memory. It saves audio without playing it, so it sends no playback receipt.
+For live conversations, your application must capture microphone audio, play replies,
+stop playback on interruption, and report the actual played position to Prism.
+Keep the API key on your server when you add a browser interface.
+TTS settings do not configure Prism sessions.
+
+## Help and licenses
 
-## License
+See [Rime documentation](https://docs.rime.ai/) for API keys, TTS models, and deployment information.
+The examples above run with the installed package. No source checkout is required.
 
-The SDK is licensed under the [MIT License](LICENSE).
-BlingFire retains its [upstream license](vendor/LICENSE.blingfire).
+SDK code uses the MIT license. The Prism protocol module uses Apache 2.0.
+BlingFire retains its MIT license. License texts and notices are included in the package.
+Its WASM runtime ships with the package. The SDK downloads no code or models at runtime.

package/dist/auth.d.ts

@@ -1,10 +1,14 @@
-import { policy } from "./policy.js";
+export interface AuthenticationConfiguration {
+    exchangeUrl: string;
+    audience: string;
+    authTimeout: number;
+}
 export interface Token {
     value: string;
     expiresAt: number;
     audience: string;
 }
-export declare function exchangeKey(key: string, signal: AbortSignal, configuration?: Readonly<typeof policy>): Promise<Token>;
+export declare function exchangeKey(key: string, signal: AbortSignal, configuration: Readonly<AuthenticationConfiguration>): Promise<Token>;
 export declare const authentication: {
     exchangeKey: typeof exchangeKey;
 };
@@ -16,7 +20,8 @@ export declare class Credentials {
     private refreshAt;
     private controller;
     private closed;
-    constructor(key: string, configuration?: Readonly<typeof policy>);
+    constructor(key: string, configuration: Readonly<AuthenticationConfiguration>);
+    realtimeAuthorization(): string;
     metadata(signal: AbortSignal): Promise<string>;
     themisMetadata(signal: AbortSignal): Promise<string>;
     close(): Promise<void>;

package/dist/auth.js

@@ -1,6 +1,6 @@
-import { policy, abortable } from "./policy.js";
+import { abortable } from "./cancellation.js";
 import { RimeError, RimeAuthenticationError, RimePermissionError, RimeTimeoutError, RimeCancelledError, RimeResourceLimitError, RimeUnavailableError, } from "./errors.js";
-export async function exchangeKey(key, signal, configuration = policy) {
+export async function exchangeKey(key, signal, configuration) {
     try {
         const response = await fetch(configuration.exchangeUrl, {
             method: "POST",
@@ -77,10 +77,15 @@ export class Credentials {
     refreshAt = 0;
     controller = new AbortController();
     closed = false;
-    constructor(key, configuration = policy) {
+    constructor(key, configuration) {
         this.key = key;
         this.configuration = configuration;
     }
+    realtimeAuthorization() {
+        if (this.closed)
+            throw new RimeAuthenticationError("Credentials are closed");
+        return `Bearer ${this.key}`;
+    }
     async metadata(signal) {
         // TEMPORARY until Themis is ready: replace this body with the call below.
         // return this.themisMetadata(signal);

package/dist/cancellation.d.ts

@@ -0,0 +1 @@
+export declare function abortable<T>(promise: PromiseLike<T>, signal: AbortSignal): Promise<T>;

package/dist/cancellation.js

@@ -0,0 +1,18 @@
+export function abortable(promise, signal) {
+    if (signal.aborted)
+        return Promise.reject(signal.reason);
+    return new Promise((resolve, reject) => {
+        const abort = () => {
+            signal.removeEventListener("abort", abort);
+            reject(signal.reason);
+        };
+        signal.addEventListener("abort", abort, { once: true });
+        Promise.resolve(promise).then((value) => {
+            signal.removeEventListener("abort", abort);
+            resolve(value);
+        }, (error) => {
+            signal.removeEventListener("abort", abort);
+            reject(error);
+        });
+    });
+}