@voxevolv/client 0.3.5 → 0.3.6

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to `@voxevolv/client` are recorded here.
 
+## 0.3.6 - 2026-09-23
+
+- Enable initial connection retries by default for both `RealtimeSession` and
+  `RealtimeSession.create()`. Omitted `startupRetry` uses the existing three-attempt
+  policy with a 65-second overall deadline.
+- Set `startupRetry: false` to retain a single startup attempt and its configured
+  `connect({ readyTimeoutMs })` budget. Explicit `true` and custom policies remain supported.
+
 ## 0.3.5 - 2026-09-23
 
 - Preserve global client command order across concurrent context keys and prevent

package/README.md

@@ -26,7 +26,7 @@ Browsers without a build step can use the versioned bundle after publication:
 ```html
 <script type="module">
   import { RealtimeSession } from
-    "https://cdn.jsdelivr.net/npm/@voxevolv/client@0.3.5/dist/browser/index.js";
+    "https://cdn.jsdelivr.net/npm/@voxevolv/client@0.3.6/dist/browser/index.js";
 </script>
 ```
 
@@ -41,7 +41,6 @@ const session = await RealtimeSession.create({
   // Use the hosted API directly when its lifecycle CORS policy is public.
   // A same-origin lifecycle proxy remains supported.
   apiBase: "https://YOUR_VOXEVOLV_HOST/v1",
-  startupRetry: true,
   autoRejoin: true,
   tools: {
     present_attachment: (arguments_) => presentAttachment(arguments_),
@@ -65,7 +64,6 @@ play remote audio:
 ```ts
 const session = new RealtimeSession(credentials, {
   connect: { apiBase: "https://YOUR_VOXEVOLV_HOST/v1" },
-  startupRetry: true,
   autoRejoin: true,
 });
 await session.connect({ microphone: true });
@@ -129,13 +127,19 @@ await session.connect({ waitForRemoteAudio: false });
 
 ## Initial connection retries
 
-Set `startupRetry: true` to let the SDK retry a session that has not connected
-successfully yet. The default policy makes three total attempts with 15, 20,
-and 25-second readiness budgets, waits one second before attempt two and three
+Startup retries are enabled by default in SDK 0.3.6 for both `new RealtimeSession()`
+and `RealtimeSession.create()`. Omit `startupRetry` or pass `true` to retry a
+session that has not connected successfully yet. The default policy allows up to
+three total attempts with 15, 20, and 25-second readiness budgets, waits one second
+before attempt two and three
 seconds before attempt three, and enforces a 65-second overall deadline. The
 overall deadline also includes room connection, token renewal, microphone
 publication, the client hello, and remote-audio readiness.
 
+Set `startupRetry: false` in the constructor or `create()` options for a single
+startup attempt using the `readyTimeoutMs` supplied through `connect()` or the
+constructor defaults. This does not disable `autoRejoin` after a successful connection.
+
 Attempt one uses the room token returned at session creation. Later attempts
 obtain a fresh room token for the same VoxEvolv session ID. Intermediate
 failures remain nonterminal; `connect()` rejects and the session enters
@@ -146,7 +150,6 @@ or a terminal error occurs.
 const session = await RealtimeSession.create({
   endpoint: "/api/voice-session",
   apiBase: "https://YOUR_VOXEVOLV_HOST/v1",
-  startupRetry: true,
   autoRejoin: true,
 });