@rimelabs/sdk 0.1.0-alpha.4 → 0.1.0-alpha.6

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [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)
+
+
+### 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)
 
 

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,6 +1,8 @@
 # Rime SDK for Node.js
 
-Stream speech from a string or async text source with Rime.
+Stream speech from a string or async text source. The SDK handles sentence
+boundaries, authentication, and audio conversion; your application owns playback.
+Use Prism for conversations with audio input, typed turns, and tools.
 
 ## Install
 
@@ -12,7 +14,10 @@ npm install @rimelabs/sdk@next
 export RIME_API_KEY="your-api-key"
 ```
 
-## Quick start
+An explicit `new Rime({ apiKey: "..." })` overrides the environment. The SDK
+does not load `.env` files.
+
+## TTS quick start
 
 Save this as `speech.mjs` and run `node speech.mjs`:
 
@@ -30,137 +35,59 @@ try {
 }
 ```
 
-Output is raw mono 24 kHz signed 16-bit little-endian PCM. Configure your player
-for this format; there is no WAV header.
-
-## Stream incoming text
-
-Add this async text source before the client declaration in the quick start:
-
-```javascript
-async function* text() {
-  yield "Hello. ";
-  yield "This text arrives in separate chunks.";
-}
-```
-
-Use `client.tts.stream(text())` with the same file write and cleanup.
-The SDK handles sentence boundaries. Do not await `tts.stream()`; the first
-iterator read starts work. `writeFile` consumes the stream for you.
-
-## Configuration
-
-Select Mist v3 with `new Rime({ model: "mistv3" })`. Mist v1 and v2 are not supported.
-
-| Model | Standard endpoint | Default voice |
-| --- | --- | --- |
-| `coda` | `coda.api.rime.ai:443` | `clementine` |
-| `mistv3` | `mist.api.rime.ai:443` | `astra` |
-
-### Client options
-
-| `new Rime({ ... })` option | Default | Meaning |
-| --- | --- | --- |
-| `apiKey` | `RIME_API_KEY` | API key; an explicit value overrides the environment |
-| `model` | `"coda"` | Model for speech and discovery |
-| `endpoint` | Model's standard endpoint | Custom hostname and optional port for speech and discovery |
-| `timeout` | No overall deadline | Positive seconds; `null` disables the overall deadline |
-
-Authentication uses bearer tokens over TLS. The SDK does not load `.env` files.
-
-Custom deployments use `new Rime({ model: "coda", endpoint: "host:8443" })`.
-Omit the scheme and path. TLS is required; the default port is `443`.
-Model defaults still apply.
-
-### Synthesis options
+Output is raw mono 24 kHz signed little-endian PCM16, with no WAV header.
+The default model is Coda. Select Mist v3 with `new Rime({ model: "mistv3" })`.
 
-Pass these options to `client.tts.stream(text, { ... })`:
+For streamed text, voices, audio formats, and cancellation, read the
+[TTS guide](https://github.com/rimelabs/rime-sdk/blob/main/typescript/docs/tts.md).
+Runnable scripts are in the [examples](https://github.com/rimelabs/rime-sdk/blob/main/examples/README.md).
 
-| Option | Default | Meaning |
-| --- | --- | --- |
-| `voice` | Model's default voice | Voice name from `client.voices.list()` |
-| `language` | `"en"` | Language code |
-| `audioFormat` | `AudioFormat.PCM_24000` | Output profile, imported from `@rimelabs/sdk` |
-| `timeout` | Client setting | Seconds; pass `null` to disable the overall deadline |
+## Prism quick start
 
-### Audio formats
-
-Both profiles return raw audio without a file header.
-
-| `AudioFormat` profile | Encoding | Sample rate | Channels |
-| --- | --- | --- | --- |
-| `PCM_24000` | Signed 16-bit little-endian PCM | 24 kHz | Mono |
-| `MULAW_8000` | G.711 mu-law | 8 kHz | Mono |
-
-Chunks are `Uint8Array` values with complete sample frames; sizes vary. Inspect the
-read-only `audio.format.encoding`, `audio.format.sampleRate`, and `audio.format.channels`.
-
-### Timeouts
-
-An overall deadline includes pauses between reads. Disabling it leaves internal
-connection and progress limits active. Discovery allows at most 10 seconds;
-a shorter supplied timeout takes precedence. Omit an operation's `timeout` or
-pass `undefined` to inherit the client setting.
-
-## Discover voices and languages
-
-List voices and languages inside the quick start's `try` block:
-
-```javascript
-const voices = await client.voices.list({ language: "en" });
-const languages = await client.languages.list();
-console.log(voices, languages);
-```
-
-Both return string arrays and accept `timeout`. Omit `language` to disable filtering.
-
-## Errors and cancellation
-
-Report SDK errors and request IDs while closing the client on failure:
+Set `PRISM_URL` to your deployment's full `wss://host/v1/realtime` endpoint.
+Supply `PRISM_VOICE` unless the deployment has a default voice.
 
 ```javascript
-import { writeFile } from "node:fs/promises";
-import { Rime, RimeError } from "@rimelabs/sdk";
+import { Rime, RimeRealtimeError } from "@rimelabs/sdk";
 
-let client;
+const client = new Rime();
+const deadline = setTimeout(() => void client.close(), 60_000);
+let reading;
 try {
-  client = new Rime();
-  await writeFile("speech.pcm", client.tts.stream("Hello. This is Rime."));
-} catch (error) {
-  if (error instanceof RimeError) {
-    console.error(`Speech failed: ${error.message}; requestId=${error.requestId}`);
-  }
-  throw error;
+  const session = await client.realtime.connect({
+    endpoint: process.env.PRISM_URL,
+    voice: process.env.PRISM_VOICE,
+  });
+  reading = (async () => {
+    for await (const { payload } of session.events) {
+      if (payload.kind === "text.delta") process.stdout.write(payload.delta);
+      if (payload.kind === "error") throw new RimeRealtimeError(payload.error);
+      if (payload.kind === "response.ended") {
+        if (payload.status !== "completed")
+          throw new Error(`Response ${payload.status}`);
+        return;
+      }
+    }
+    throw new Error("Session closed before the response ended");
+  })();
+  await Promise.all([reading, session.sendText("Hello!")]);
 } finally {
-  await client?.close();
+  clearTimeout(deadline);
+  await client.close();
+  await reading?.catch(() => {});
 }
 ```
 
-Each SDK error inherits from `RimeError`:
-
-| Error | Meaning |
-| --- | --- |
-| `RimeAuthenticationError` | Missing or rejected credentials |
-| `RimePermissionError` | Access denied |
-| `RimeInputError` | Invalid input or client use |
-| `RimeResourceLimitError` | Service resource limit reached |
-| `RimeUnavailableError` | Service unavailable |
-| `RimeTimeoutError` | Overall or internal deadline reached |
-| `RimeAudioFormatError` | Unsupported or unexpected audio format |
-| `RimeCancelledError` | Operation cancelled |
-| `RimeStreamError` | Other stream or transport failure |
-
-Partial audio can arrive before an error. Output is complete only after successful
-iteration. Synthesis is not retried automatically.
-
-Keep cleanup when stopping early. A `for await` loop exit cancels the stream.
-For manual reads, call `await audio.cancel()` in `finally`. `await client.close()`
-stops all client work. Both calls are safe to repeat; both objects support
-`Symbol.asyncDispose`. Cancellation stops the RPC and limits cleanup time, but
-cannot force your text source to finish an unrelated promise.
+This example prints text and discards audio. The
+[Realtime guide](https://github.com/rimelabs/rime-sdk/blob/main/typescript/docs/realtime.md)
+covers audio input, tools, playback reports, and cancellation. Runnable
+[Prism examples](https://github.com/rimelabs/rime-sdk/blob/main/examples/README.md#nodejs)
+save audio and handle tools. TTS settings do not apply to Prism sessions.
 
 ## License
 
-The SDK uses the [MIT License](LICENSE). BlingFire retains its
-[upstream license](vendor/LICENSE.blingfire). The package includes its WASM runtime
-and downloads no code or models at runtime. See [vendor provenance](vendor/README.md).
+SDK code uses the [MIT license](https://github.com/rimelabs/rime-sdk/blob/main/typescript/LICENSE).
+The Prism protocol module uses the [Apache 2.0 license](https://github.com/rimelabs/rime-sdk/blob/main/typescript/LICENSE-PRISM).
+BlingFire retains its [upstream license](https://github.com/rimelabs/rime-sdk/blob/main/typescript/vendor/LICENSE.blingfire).
+Its WASM runtime ships with the package; the SDK downloads no code or models at
+runtime. See [vendor provenance](https://github.com/rimelabs/rime-sdk/blob/main/typescript/vendor/README.md).

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);
+        });
+    });
+}

package/dist/client.d.ts

@@ -1,5 +1,8 @@
-import { AudioFormat } from "./audio.js";
-import { AudioStream, type TextSource } from "./stream.js";
+import { type SynthesisOptions, type DiscoveryOptions, type VoiceListOptions } from "./tts/client.js";
+import { type AudioStream, type TextSource } from "./tts/stream.js";
+import type { RealtimeConnectOptions } from "./realtime/types.js";
+import type { RealtimeSession } from "./realtime/session.js";
+export type { SynthesisOptions, DiscoveryOptions, VoiceListOptions, } from "./tts/client.js";
 export interface RimeOptions {
     apiKey?: string | null;
     /** Select "coda" (default) or "mistv3" for speech and discovery. */
@@ -7,27 +10,15 @@ export interface RimeOptions {
     endpoint?: string | null;
     timeout?: number | null;
 }
-export interface SynthesisOptions {
-    voice?: string | null;
-    language?: string;
-    audioFormat?: AudioFormat | null;
-    timeout?: number | null;
-}
-export interface DiscoveryOptions {
-    timeout?: number | null;
-}
-export interface VoiceListOptions extends DiscoveryOptions {
-    language?: string | null;
-}
 export declare class Rime {
-    private readonly deployment;
-    private credentials;
-    private client;
+    private readonly credentials;
+    private readonly ttsClient;
+    private readonly realtimeClient;
+    readonly realtime: {
+        connect: (options: RealtimeConnectOptions) => Promise<RealtimeSession>;
+    };
     private closed;
-    private streams;
-    private discoveryControllers;
     private closing;
-    private defaultTimeout;
     readonly tts: {
         stream: (text: TextSource, options?: SynthesisOptions) => AudioStream;
     };
@@ -39,9 +30,6 @@ export declare class Rime {
     };
     constructor(options?: RimeOptions);
     private checkOpen;
-    private prepare;
-    private stream;
-    private discover;
     close(): Promise<void>;
     [Symbol.asyncDispose](): Promise<void>;
 }