@breeze.blue/sdk 0.5.1 → 0.6.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { AudioResponse } from "./audio.js";
 export { BreezeBlueAPIError, BreezeBlueAuthenticationError, BreezeBlueBadRequestError, BreezeBlueConfigurationError, BreezeBlueConflictError, BreezeBlueError, BreezeBlueForbiddenError, BreezeBlueGenerationNotReadyError, BreezeBlueInsufficientCreditsError, BreezeBlueNotFoundError, BreezeBlueRateLimitError, BreezeBlueRealtimeError, BreezeBlueServiceUnavailableError, BreezeBlueUpstreamError, BreezeBlueValidationError, } from "./errors.js";
-export { BreezeBlueClient, RealtimeTextToSpeechConnection } from "./client.js";
+export { BreezeBlueClient, ManagedRealtimeTextToSpeechConnection, RealtimeTextToSpeechConnection, } from "./client.js";
 export { SDK_NAME, SDK_VERSION } from "./version.js";
 export type * from "./types.js";

package/dist/index.js

@@ -1,4 +1,4 @@
 export { AudioResponse } from "./audio.js";
 export { BreezeBlueAPIError, BreezeBlueAuthenticationError, BreezeBlueBadRequestError, BreezeBlueConfigurationError, BreezeBlueConflictError, BreezeBlueError, BreezeBlueForbiddenError, BreezeBlueGenerationNotReadyError, BreezeBlueInsufficientCreditsError, BreezeBlueNotFoundError, BreezeBlueRateLimitError, BreezeBlueRealtimeError, BreezeBlueServiceUnavailableError, BreezeBlueUpstreamError, BreezeBlueValidationError, } from "./errors.js";
-export { BreezeBlueClient, RealtimeTextToSpeechConnection } from "./client.js";
+export { BreezeBlueClient, ManagedRealtimeTextToSpeechConnection, RealtimeTextToSpeechConnection, } from "./client.js";
 export { SDK_NAME, SDK_VERSION } from "./version.js";

package/dist/types.d.ts

@@ -61,18 +61,86 @@ export interface RealtimeTextToSpeechConnectOptions extends RealtimeTextToSpeech
     clientSecret?: string;
     websocketUrl?: string;
     webSocket?: BreezeBlueWebSocketConstructor;
+    signal?: AbortSignal;
     /** Handshake timeout in milliseconds. Defaults to the client `timeout`. */
     timeout?: number;
 }
+export type RealtimeTextToSpeechSessionCredentials = {
+    clientSecret: string;
+    websocketUrl?: string;
+} | {
+    clientSecret?: string;
+    websocketUrl: string;
+};
+export interface RealtimeTextToSpeechSessionFactoryContext {
+    /**
+     * Aborted when the managed connection closes or the physical epoch exceeds
+     * its timeout. Pass it to the request that creates fresh credentials.
+     */
+    signal: AbortSignal;
+}
+/**
+ * Options for an SDK-managed logical realtime connection.
+ *
+ * Every physical WebSocket epoch obtains fresh credentials. Server-side callers
+ * can omit `sessionFactory` and let the SDK call `createSession`; browser
+ * callers should provide a callback that fetches a fresh client secret from
+ * their own backend.
+ */
+export interface RealtimeTextToSpeechManagedConnectOptions extends RealtimeTextToSpeechSessionRequest {
+    sessionFactory?: (context: RealtimeTextToSpeechSessionFactoryContext) => Promise<RealtimeTextToSpeechSessionCredentials>;
+    webSocket?: BreezeBlueWebSocketConstructor;
+    /**
+     * Positive physical handshake and `session.ready` timeout in milliseconds.
+     * Defaults to the client `timeout`.
+     */
+    timeout?: number;
+    /**
+     * Keepalive interval in milliseconds. By default the SDK derives a safe
+     * interval from `session.ready.inactivityTimeoutSeconds`. Set to `0` to
+     * disable automatic keepalive.
+     */
+    heartbeatIntervalMs?: number;
+    /**
+     * Maximum wait for any server response after a managed keepalive ping.
+     * Defaults to 5 seconds. A timeout replaces an idle physical session and
+     * interrupts, but never replays, an active turn.
+     */
+    heartbeatTimeoutMs?: number;
+    /**
+     * How long before `maxSessionSeconds` to rotate at a turn boundary.
+     * Defaults to 120 seconds.
+     */
+    rotationMarginMs?: number;
+    /**
+     * Client-side age threshold for turn-boundary physical epoch rotation.
+     * Defaults to 10 minutes. An active turn may delay the switch; set to `0`
+     * to rely only on the server-advertised lifetime.
+     */
+    maxPhysicalSessionMs?: number;
+    /** Maximum attempts for one unexpected idle reconnect episode. Defaults to 3. */
+    maxReconnectAttempts?: number;
+    /** Initial unexpected reconnect delay in milliseconds. Defaults to 250. */
+    reconnectBaseDelayMs?: number;
+}
 export interface RealtimeTextToSpeechSessionReadyEvent {
     type: "session.ready";
     sessionId: string;
+    /** Absolute session expiry when provided by current servers. */
+    expiresAt?: string;
     audioFormat: RealtimeTextToSpeechAudioFormat;
     maxAppendBytes: number;
     maxTurnCharacters: number;
     inactivityTimeoutSeconds: number;
     maxSessionSeconds: number;
 }
+export interface RealtimeTextToSpeechSessionExpiringEvent {
+    type: "session.expiring";
+    sessionId: string;
+    expiresInSeconds: number;
+    maxSessionSeconds: number;
+    expiresAt: string;
+}
 export interface RealtimeTextToSpeechPongEvent {
     type: "pong";
 }
@@ -141,7 +209,7 @@ export interface RealtimeTextToSpeechErrorEvent {
  * (with camelCase keys). Do not rely on an exhaustive `switch` over `type`;
  * ignore event types you do not recognize.
  */
-export type RealtimeTextToSpeechEvent = RealtimeTextToSpeechSessionReadyEvent | RealtimeTextToSpeechPongEvent | RealtimeTextToSpeechTurnStartedEvent | RealtimeTextToSpeechAudioStartedEvent | RealtimeTextToSpeechTurnDoneEvent | RealtimeTextToSpeechTurnCancelledEvent | RealtimeTextToSpeechUsageCommittedEvent | RealtimeTextToSpeechSessionClosedEvent | RealtimeTextToSpeechErrorEvent;
+export type RealtimeTextToSpeechEvent = RealtimeTextToSpeechSessionReadyEvent | RealtimeTextToSpeechSessionExpiringEvent | RealtimeTextToSpeechPongEvent | RealtimeTextToSpeechTurnStartedEvent | RealtimeTextToSpeechAudioStartedEvent | RealtimeTextToSpeechTurnDoneEvent | RealtimeTextToSpeechTurnCancelledEvent | RealtimeTextToSpeechUsageCommittedEvent | RealtimeTextToSpeechSessionClosedEvent | RealtimeTextToSpeechErrorEvent;
 export interface RealtimeTextToSpeechAudioMessage {
     type: "audio";
     audio: Uint8Array;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.5.1";
+export declare const SDK_VERSION = "0.6.1";
 export declare const SDK_NAME = "@breeze.blue/sdk";

package/dist/version.js

@@ -1,2 +1,2 @@
-export const SDK_VERSION = "0.5.1";
+export const SDK_VERSION = "0.6.1";
 export const SDK_NAME = "@breeze.blue/sdk";

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "@breeze.blue/sdk",
-  "version": "0.5.1",
+  "version": "0.6.1",
   "description": "ESM-first TypeScript SDK for the Breeze Blue Developer API.",
   "license": "MIT",
   "author": "Breeze Blue <support@breeze.blue>",
   "homepage": "https://breezeblue.ai",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/breezebluestudio/BreezeBlueStudio.git",
+    "directory": "packages/breeze-typescript"
+  },
   "keywords": [
     "audio",
     "breeze",