@volley/recognition-client-sdk 0.1.800 → 0.1.806

package/dist/browser.bundled.d.ts

@@ -1,9 +1,40 @@
 import { z } from 'zod';
 
+/**
+ * Gemini Model Types
+ * Based on available models as of January 2025
+ *
+ * API Version Notes:
+ * - Gemini 2.5+ models: Use v1beta API (early access features)
+ * - Gemini 2.0 models: Use v1beta API (early access features)
+ * - Gemini 1.5 models: Use v1 API (stable, production-ready)
+ *
+ * @see https://ai.google.dev/gemini-api/docs/models
+ * @see https://ai.google.dev/gemini-api/docs/api-versions
+ */
+declare enum GeminiModel {
+    GEMINI_2_5_PRO = "gemini-2.5-pro",
+    GEMINI_2_5_FLASH = "gemini-2.5-flash",
+    GEMINI_2_5_FLASH_LITE = "gemini-2.5-flash-lite",
+    GEMINI_2_0_FLASH_LATEST = "gemini-2.0-flash-latest",
+    GEMINI_2_0_FLASH_EXP = "gemini-2.0-flash-exp"
+}
+
+/**
+ * OpenAI Batch API Model Types (HTTP API)
+ * @see https://platform.openai.com/docs/guides/speech-to-text
+ *
+ * Note: For openai-realtime provider models, see OpenAIRealtimeModel in provider.types.ts
+ */
+declare enum OpenAIModel {
+    WHISPER_1 = "whisper-1"
+}
+
 /**
  * Provider types and enums for recognition services
  * NOTE_TO_AI: DO NOT CHANGE THIS UNLESS EXPLICITLY ASKED. Always ask before making any changes.
  */
+
 /**
  * Supported speech recognition providers
  */
@@ -45,6 +76,17 @@ declare enum DeepgramModel {
     NOVA_3 = "nova-3",
     FLUX_GENERAL_EN = "flux-general-en"
 }
+/**
+ * AssemblyAI streaming speech models
+ * @see https://www.assemblyai.com/docs/streaming/universal-streaming
+ * @see https://www.assemblyai.com/docs/streaming/universal-3-pro
+ */
+declare enum AssemblyAIModel {
+    DEFAULT = "default",
+    UNIVERSAL_STREAMING_ENGLISH = "universal-streaming-english",
+    UNIVERSAL_STREAMING_MULTILINGUAL = "universal-streaming-multilingual",
+    U3_RT_PRO = "u3-rt-pro"
+}
 /**
  * Google Cloud Speech models
  * @see https://cloud.google.com/speech-to-text/docs/transcription-model
@@ -169,7 +211,7 @@ declare enum SelfServeVllmModel {
 /**
  * Type alias for any model from any provider
  */
-type RecognitionModel = DeepgramModel | GoogleModel | FireworksModel | GladiaModel | ElevenLabsModel | OpenAIRealtimeModel | MistralVoxtralModel | CartesiaModel | DashScopeModel | InworldSttModel | SelfServeVllmModel | BedrockModel | AwsTranscribeModel | AmazonNovaSonicModel | string;
+type RecognitionModel = AssemblyAIModel | DeepgramModel | GoogleModel | FireworksModel | GladiaModel | ElevenLabsModel | OpenAIModel | GeminiModel | OpenAIRealtimeModel | MistralVoxtralModel | CartesiaModel | DashScopeModel | InworldSttModel | SelfServeVllmModel | BedrockModel | AwsTranscribeModel | AmazonNovaSonicModel | string;
 
 /**
  * Recognition Result Types V1
@@ -797,6 +839,26 @@ declare const GameContextSchemaV1: z.ZodObject<{
 }>;
 type GameContextV1 = z.infer<typeof GameContextSchemaV1>;
 
+/**
+ * Microphone Source Types
+ *
+ * Identifies which client-side audio capture path produced the audio.
+ * Paired with the upstream client capture enum — the recognition service
+ * always stores/uses this enum internally (never the raw wire string).
+ *
+ * Clients send the value as a string query param; normalize it to the enum
+ * at the SDK / server boundary via {@link coerceMicrophoneSourceType}.
+ */
+/**
+ * Audio capture source path reported by the client.
+ */
+declare enum MicrophoneSourceType {
+    /** Browser / legacy web capture path (default). */
+    WEB = "web",
+    /** Mobile native bridge path (MobileNativeSource) when supported. */
+    NATIVE = "native"
+}
+
 /**
  * Unified ASR Request Configuration
  *
@@ -1327,6 +1389,14 @@ interface IRecognitionClientConfig {
     accountId?: string;
     /** Question answer identifier for tracking Q&A sessions (optional and tracking purpose only) */
     questionAnswerId?: string;
+    /** Client identifier for downstream tracking/audio-labeling (optional and tracking purpose only) */
+    clientId?: string;
+    /**
+     * Client audio capture path (optional). Accepts the {@link MicrophoneSourceType}
+     * enum or its string value ('web' | 'native'). Defaults to 'web' on the server
+     * when omitted. The service normalizes this to the enum at the boundary.
+     */
+    microphoneSourceType?: MicrophoneSourceType | string;
     /** Platform for audio recording device (optional, e.g., 'ios', 'android', 'web', 'unity') */
     platform?: string;
     /** Experiment cohort (optional). Defaults to 'control' if not provided. */

package/dist/config-builder.d.ts

@@ -4,7 +4,7 @@
  * Simple builder pattern for RealTimeTwoWayWebSocketRecognitionClientConfig
  */
 import type { RealTimeTwoWayWebSocketRecognitionClientConfig, RecognitionCallbackUrl } from './recognition-client.types.js';
-import type { ASRRequestConfig, GameContextV1, TranscriptionResultV1, MetadataResultV1, SessionConfiguredV1, AudioMetricsResultV1, ErrorResultV1, Stage } from '@recog/shared-types';
+import type { ASRRequestConfig, GameContextV1, TranscriptionResultV1, MetadataResultV1, SessionConfiguredV1, AudioMetricsResultV1, ErrorResultV1, Stage, MicrophoneSourceType } from '@recog/shared-types';
 /**
  * Builder for RealTimeTwoWayWebSocketRecognitionClientConfig
  *
@@ -82,6 +82,15 @@ export declare class ConfigBuilder {
      * Set question answer ID
      */
     questionAnswerId(id: string): this;
+    /**
+     * Set client ID (for downstream tracking/audio-labeling)
+     */
+    clientId(id: string): this;
+    /**
+     * Set the client audio capture path (MicrophoneSourceType enum or 'web' | 'native' string).
+     * Defaults to 'web' on the server when omitted.
+     */
+    microphoneSourceType(source: MicrophoneSourceType | string): this;
     /**
      * Set platform
      */

package/dist/config-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config-builder.d.ts","sourceRoot":"","sources":["../src/config-builder.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACV,8CAA8C,EAC9C,sBAAsB,EACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,aAAa,EACb,KAAK,EACN,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAA+D;IAE7E;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKtB;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI;IAKhD;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAKzC;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,sBAAsB,EAAE,GAAG,IAAI;IAKlD;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKxB;;OAEG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK/B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK1B;;OAEG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKhC;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI;IAKvD;;;OAGG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK7C;;OAEG;IACH,YAAY,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,IAAI,GAAG,IAAI;IAKrE;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI,GAAG,IAAI;IAKhE;;OAEG;IACH,mBAAmB,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,GAAG,IAAI;IAK1E;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,GAAG,IAAI;IAKvE;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI;IAKvD;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAKvC;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAKtE;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKjC;;OAEG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK3C;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKrC;;OAEG;IAEH,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI;IAKvG;;OAEG;IACH,KAAK,IAAI,8CAA8C;CAGxD"}
+{"version":3,"file":"config-builder.d.ts","sourceRoot":"","sources":["../src/config-builder.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACV,8CAA8C,EAC9C,sBAAsB,EACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,aAAa,EACb,KAAK,EACL,oBAAoB,EACrB,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAA+D;IAE7E;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKtB;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI;IAKhD;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAKzC;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,sBAAsB,EAAE,GAAG,IAAI;IAKlD;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKxB;;OAEG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK/B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK1B;;OAEG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAK1B;;;OAGG;IACH,oBAAoB,CAAC,MAAM,EAAE,oBAAoB,GAAG,MAAM,GAAG,IAAI;IAKjE;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKhC;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI;IAKvD;;;OAGG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK7C;;OAEG;IACH,YAAY,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,IAAI,GAAG,IAAI;IAKrE;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI,GAAG,IAAI;IAKhE;;OAEG;IACH,mBAAmB,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,GAAG,IAAI;IAK1E;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,GAAG,IAAI;IAKvE;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI;IAKvD;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAKvC;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAKtE;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKjC;;OAEG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK3C;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKrC;;OAEG;IAEH,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI;IAKvG;;OAEG;IACH,KAAK,IAAI,8CAA8C;CAGxD"}

package/dist/index.bundled.d.ts

@@ -1,9 +1,40 @@
 import { z } from 'zod';
 
+/**
+ * Gemini Model Types
+ * Based on available models as of January 2025
+ *
+ * API Version Notes:
+ * - Gemini 2.5+ models: Use v1beta API (early access features)
+ * - Gemini 2.0 models: Use v1beta API (early access features)
+ * - Gemini 1.5 models: Use v1 API (stable, production-ready)
+ *
+ * @see https://ai.google.dev/gemini-api/docs/models
+ * @see https://ai.google.dev/gemini-api/docs/api-versions
+ */
+declare enum GeminiModel {
+    GEMINI_2_5_PRO = "gemini-2.5-pro",
+    GEMINI_2_5_FLASH = "gemini-2.5-flash",
+    GEMINI_2_5_FLASH_LITE = "gemini-2.5-flash-lite",
+    GEMINI_2_0_FLASH_LATEST = "gemini-2.0-flash-latest",
+    GEMINI_2_0_FLASH_EXP = "gemini-2.0-flash-exp"
+}
+
+/**
+ * OpenAI Batch API Model Types (HTTP API)
+ * @see https://platform.openai.com/docs/guides/speech-to-text
+ *
+ * Note: For openai-realtime provider models, see OpenAIRealtimeModel in provider.types.ts
+ */
+declare enum OpenAIModel {
+    WHISPER_1 = "whisper-1"
+}
+
 /**
  * Provider types and enums for recognition services
  * NOTE_TO_AI: DO NOT CHANGE THIS UNLESS EXPLICITLY ASKED. Always ask before making any changes.
  */
+
 /**
  * Supported speech recognition providers
  */
@@ -45,6 +76,17 @@ declare enum DeepgramModel {
     NOVA_3 = "nova-3",
     FLUX_GENERAL_EN = "flux-general-en"
 }
+/**
+ * AssemblyAI streaming speech models
+ * @see https://www.assemblyai.com/docs/streaming/universal-streaming
+ * @see https://www.assemblyai.com/docs/streaming/universal-3-pro
+ */
+declare enum AssemblyAIModel {
+    DEFAULT = "default",
+    UNIVERSAL_STREAMING_ENGLISH = "universal-streaming-english",
+    UNIVERSAL_STREAMING_MULTILINGUAL = "universal-streaming-multilingual",
+    U3_RT_PRO = "u3-rt-pro"
+}
 /**
  * Google Cloud Speech models
  * @see https://cloud.google.com/speech-to-text/docs/transcription-model
@@ -169,7 +211,7 @@ declare enum SelfServeVllmModel {
 /**
  * Type alias for any model from any provider
  */
-type RecognitionModel = DeepgramModel | GoogleModel | FireworksModel | GladiaModel | ElevenLabsModel | OpenAIRealtimeModel | MistralVoxtralModel | CartesiaModel | DashScopeModel | InworldSttModel | SelfServeVllmModel | BedrockModel | AwsTranscribeModel | AmazonNovaSonicModel | string;
+type RecognitionModel = AssemblyAIModel | DeepgramModel | GoogleModel | FireworksModel | GladiaModel | ElevenLabsModel | OpenAIModel | GeminiModel | OpenAIRealtimeModel | MistralVoxtralModel | CartesiaModel | DashScopeModel | InworldSttModel | SelfServeVllmModel | BedrockModel | AwsTranscribeModel | AmazonNovaSonicModel | string;
 
 /**
  * Recognition Result Types V1
@@ -1527,6 +1569,26 @@ declare const ASRRequestSchemaV1: z.ZodObject<{
 }>;
 type ASRRequestV1 = z.infer<typeof ASRRequestSchemaV1>;
 
+/**
+ * Microphone Source Types
+ *
+ * Identifies which client-side audio capture path produced the audio.
+ * Paired with the upstream client capture enum — the recognition service
+ * always stores/uses this enum internally (never the raw wire string).
+ *
+ * Clients send the value as a string query param; normalize it to the enum
+ * at the SDK / server boundary via {@link coerceMicrophoneSourceType}.
+ */
+/**
+ * Audio capture source path reported by the client.
+ */
+declare enum MicrophoneSourceType {
+    /** Browser / legacy web capture path (default). */
+    WEB = "web",
+    /** Mobile native bridge path (MobileNativeSource) when supported. */
+    NATIVE = "native"
+}
+
 /**
  * Unified ASR Request Configuration
  *
@@ -1811,36 +1873,6 @@ type PartialASRRequestConfig = Partial<ASRRequestConfig>;
  */
 declare function createDefaultASRConfig(overrides?: PartialASRRequestConfig): ASRRequestConfig;
 
-/**
- * Gemini Model Types
- * Based on available models as of January 2025
- *
- * API Version Notes:
- * - Gemini 2.5+ models: Use v1beta API (early access features)
- * - Gemini 2.0 models: Use v1beta API (early access features)
- * - Gemini 1.5 models: Use v1 API (stable, production-ready)
- *
- * @see https://ai.google.dev/gemini-api/docs/models
- * @see https://ai.google.dev/gemini-api/docs/api-versions
- */
-declare enum GeminiModel {
-    GEMINI_2_5_PRO = "gemini-2.5-pro",
-    GEMINI_2_5_FLASH = "gemini-2.5-flash",
-    GEMINI_2_5_FLASH_LITE = "gemini-2.5-flash-lite",
-    GEMINI_2_0_FLASH_LATEST = "gemini-2.0-flash-latest",
-    GEMINI_2_0_FLASH_EXP = "gemini-2.0-flash-exp"
-}
-
-/**
- * OpenAI Batch API Model Types (HTTP API)
- * @see https://platform.openai.com/docs/guides/speech-to-text
- *
- * Note: For openai-realtime provider models, see OpenAIRealtimeModel in provider.types.ts
- */
-declare enum OpenAIModel {
-    WHISPER_1 = "whisper-1"
-}
-
 /**
  * Standard stage/environment constants used across all services
  */
@@ -2096,6 +2128,14 @@ interface IRecognitionClientConfig {
     accountId?: string;
     /** Question answer identifier for tracking Q&A sessions (optional and tracking purpose only) */
     questionAnswerId?: string;
+    /** Client identifier for downstream tracking/audio-labeling (optional and tracking purpose only) */
+    clientId?: string;
+    /**
+     * Client audio capture path (optional). Accepts the {@link MicrophoneSourceType}
+     * enum or its string value ('web' | 'native'). Defaults to 'web' on the server
+     * when omitted. The service normalizes this to the enum at the boundary.
+     */
+    microphoneSourceType?: MicrophoneSourceType | string;
     /** Platform for audio recording device (optional, e.g., 'ios', 'android', 'web', 'unity') */
     platform?: string;
     /** Experiment cohort (optional). Defaults to 'control' if not provided. */
@@ -2596,6 +2636,15 @@ declare class ConfigBuilder {
      * Set question answer ID
      */
     questionAnswerId(id: string): this;
+    /**
+     * Set client ID (for downstream tracking/audio-labeling)
+     */
+    clientId(id: string): this;
+    /**
+     * Set the client audio capture path (MicrophoneSourceType enum or 'web' | 'native' string).
+     * Defaults to 'web' on the server when omitted.
+     */
+    microphoneSourceType(source: MicrophoneSourceType | string): this;
     /**
      * Set platform
      */
@@ -2805,6 +2854,8 @@ declare const RecognitionVGFStateSchema: z.ZodObject<{
     functionCallMetadata: z.ZodOptional<z.ZodString>;
     functionCallConfidence: z.ZodOptional<z.ZodNumber>;
     finalFunctionCallTimestamp: z.ZodOptional<z.ZodString>;
+    gameId: z.ZodOptional<z.ZodString>;
+    gamePhase: z.ZodOptional<z.ZodString>;
     promptSlotMap: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>>;
     promptSTT: z.ZodOptional<z.ZodString>;
     promptSTF: z.ZodOptional<z.ZodString>;
@@ -2859,6 +2910,8 @@ declare const RecognitionVGFStateSchema: z.ZodObject<{
     functionCallMetadata?: string | undefined;
     functionCallConfidence?: number | undefined;
     finalFunctionCallTimestamp?: string | undefined;
+    gameId?: string | undefined;
+    gamePhase?: string | undefined;
     promptSlotMap?: Record<string, string[]> | undefined;
     promptSTT?: string | undefined;
     promptSTF?: string | undefined;
@@ -2901,6 +2954,8 @@ declare const RecognitionVGFStateSchema: z.ZodObject<{
     functionCallMetadata?: string | undefined;
     functionCallConfidence?: number | undefined;
     finalFunctionCallTimestamp?: string | undefined;
+    gameId?: string | undefined;
+    gamePhase?: string | undefined;
     promptSlotMap?: Record<string, string[]> | undefined;
     promptSTT?: string | undefined;
     promptSTF?: string | undefined;
@@ -2931,6 +2986,7 @@ declare const TranscriptionStatus: {
 };
 type TranscriptionStatusType = typeof TranscriptionStatus[keyof typeof TranscriptionStatus];
 declare function createInitialRecognitionState(audioUtteranceId: string): RecognitionState;
+declare function isTerminal(state: Pick<RecognitionState, "transcriptionStatus">): boolean;
 declare function isValidRecordingStatusTransition(from: string | undefined, to: string): boolean;
 
 /**
@@ -3015,9 +3071,42 @@ declare class SimplifiedVGFRecognitionClient implements ISimplifiedVGFRecognitio
     sendGameContext(context: GameContextV1): void;
     isServerReady(): boolean;
     getVGFState(): RecognitionState;
-    private isTerminalStatus;
     private notifyStateChange;
 }
+/**
+ * Fluent builder for {@link SimplifiedVGFClientConfig}.
+ *
+ * Extends {@link ConfigBuilder} with the two VGF-specific fields
+ * (`onStateChange`, `initialState`) so the simplified client has the same
+ * builder ergonomics as the base RealTimeTwoWayWebSocketRecognitionClient.
+ *
+ * Example:
+ * ```typescript
+ * import { STAGES, RecognitionProvider } from '@recog/shared-types';
+ *
+ * const config = new SimplifiedVGFConfigBuilder()
+ *   .stage(STAGES.STAGING)
+ *   .asrRequestConfig({ provider: RecognitionProvider.DEEPGRAM, language: 'en' })
+ *   .onStateChange((state) => setVGFState(state))
+ *   .build();
+ * ```
+ */
+declare class SimplifiedVGFConfigBuilder extends ConfigBuilder {
+    private vgfConfig;
+    /**
+     * Set the VGF state-change callback, fired whenever the VGF state updates.
+     */
+    onStateChange(callback: (state: RecognitionState) => void): this;
+    /**
+     * Set the initial VGF state to restore from a previous session.
+     * The audioUtteranceId is extracted from it when valid.
+     */
+    initialState(state: RecognitionState): this;
+    /**
+     * Build the SimplifiedVGFClientConfig (base fields + VGF fields).
+     */
+    build(): SimplifiedVGFClientConfig;
+}
 /**
  * Factory function for creating simplified client
  * Usage examples:
@@ -3062,6 +3151,24 @@ declare class SimplifiedVGFRecognitionClient implements ISimplifiedVGFRecognitio
  * // VGF state automatically updates based on transcription results
  */
 declare function createSimplifiedVGFClient(config: SimplifiedVGFClientConfig): ISimplifiedVGFRecognitionClient;
+/**
+ * Create a simplified VGF client using the builder pattern.
+ *
+ * Mirror of `createClientWithBuilder` for the base client.
+ *
+ * Example:
+ * ```typescript
+ * import { STAGES, RecognitionProvider } from '@recog/shared-types';
+ *
+ * const client = createSimplifiedVGFClientWithBuilder((builder) =>
+ *   builder
+ *     .stage(STAGES.STAGING)
+ *     .asrRequestConfig({ provider: RecognitionProvider.DEEPGRAM, language: 'en' })
+ *     .onStateChange((state) => setVGFState(state))
+ * );
+ * ```
+ */
+declare function createSimplifiedVGFClientWithBuilder(configure: (builder: SimplifiedVGFConfigBuilder) => SimplifiedVGFConfigBuilder): ISimplifiedVGFRecognitionClient;
 
 /**
  * VGF Recognition Mapper
@@ -3128,5 +3235,5 @@ declare function getRecognitionConductorHttpBase(stage?: Stage | string | null |
 declare function getRecognitionConductorWsBase(stage?: Stage | string | null | undefined): string;
 declare function getRecognitionConductorHost(stage?: Stage | string | null | undefined): string;
 
-export { AmazonNovaSonicModel, AudioEncoding, AwsTranscribeModel, BedrockModel, CartesiaModel, ClientControlActionV1, ClientState, ConfigBuilder, ConnectionError, ControlSignalTypeV1 as ControlSignal, ControlSignalTypeV1, DashScopeModel, DeepgramModel, ElevenLabsModel, ErrorTypeV1, FinalTranscriptStability, FireworksModel, GeminiModel, GladiaModel, GoogleModel, Language, MistralVoxtralModel, OpenAIModel, OpenAIRealtimeModel, RECOGNITION_CONDUCTOR_BASES, RECOGNITION_SERVICE_BASES, RealTimeTwoWayWebSocketRecognitionClient, RecognitionContextTypeV1, RecognitionError, RecognitionProvider, RecognitionResultTypeV1, RecognitionVGFStateSchema, RecordingStatus, STAGES, SampleRate, SelfServeVllmModel, SimplifiedVGFRecognitionClient, TimeoutError, TranscriptionStatus, ValidationError, createClient, createClientWithBuilder, createDefaultASRConfig, createInitialRecognitionState, createSimplifiedVGFClient, getRecognitionConductorBase, getRecognitionConductorHost, getRecognitionConductorHttpBase, getRecognitionConductorWsBase, getRecognitionServiceBase, getRecognitionServiceHost, getRecognitionServiceHttpBase, getRecognitionServiceWsBase, getUserFriendlyMessage, isExceptionImmediatelyAvailable, isNormalDisconnection, isValidRecordingStatusTransition, normalizeStage, resetRecognitionVGFState };
+export { AmazonNovaSonicModel, AssemblyAIModel, AudioEncoding, AwsTranscribeModel, BedrockModel, CartesiaModel, ClientControlActionV1, ClientState, ConfigBuilder, ConnectionError, ControlSignalTypeV1 as ControlSignal, ControlSignalTypeV1, DashScopeModel, DeepgramModel, ElevenLabsModel, ErrorTypeV1, FinalTranscriptStability, FireworksModel, GeminiModel, GladiaModel, GoogleModel, Language, MicrophoneSourceType, MistralVoxtralModel, OpenAIModel, OpenAIRealtimeModel, RECOGNITION_CONDUCTOR_BASES, RECOGNITION_SERVICE_BASES, RealTimeTwoWayWebSocketRecognitionClient, RecognitionContextTypeV1, RecognitionError, RecognitionProvider, RecognitionResultTypeV1, RecognitionVGFStateSchema, RecordingStatus, STAGES, SampleRate, SelfServeVllmModel, SimplifiedVGFConfigBuilder, SimplifiedVGFRecognitionClient, TimeoutError, TranscriptionStatus, ValidationError, createClient, createClientWithBuilder, createDefaultASRConfig, createInitialRecognitionState, createSimplifiedVGFClient, createSimplifiedVGFClientWithBuilder, getRecognitionConductorBase, getRecognitionConductorHost, getRecognitionConductorHttpBase, getRecognitionConductorWsBase, getRecognitionServiceBase, getRecognitionServiceHost, getRecognitionServiceHttpBase, getRecognitionServiceWsBase, getUserFriendlyMessage, isExceptionImmediatelyAvailable, isNormalDisconnection, isTerminal, isValidRecordingStatusTransition, normalizeStage, resetRecognitionVGFState };
 export type { ASRRequestConfig, ASRRequestV1, AudioMetricsResultV1, AuthenticationException, ConnectionException, ErrorResultV1, FunctionCallResultV1, GameContextV1, IRecognitionClient, IRecognitionClientConfig, IRecognitionClientStats, ISimplifiedVGFRecognitionClient, MetadataResultV1, ProviderException, QuotaExceededException, RealTimeTwoWayWebSocketRecognitionClientConfig, RecognitionCallbackUrl, RecognitionException, RecognitionState, RecordingStatusType, SimplifiedVGFClientConfig, SlotMap, Stage, TimeoutException, TranscriptionResult, TranscriptionResultV1, TranscriptionStatusType, UnknownException, ValidationException };

package/dist/index.d.ts

@@ -6,11 +6,11 @@ export { RecognitionError, ConnectionError, TimeoutError, ValidationError } from
 export { ErrorTypeV1 } from '@recog/shared-types';
 export type { RecognitionException, ConnectionException, TimeoutException, ValidationException, AuthenticationException, ProviderException, QuotaExceededException, UnknownException } from '@recog/shared-types';
 export { isExceptionImmediatelyAvailable, getUserFriendlyMessage } from '@recog/shared-types';
-export { SimplifiedVGFRecognitionClient, createSimplifiedVGFClient, type ISimplifiedVGFRecognitionClient, type SimplifiedVGFClientConfig } from './simplified-vgf-recognition-client.js';
-export { type RecognitionState, RecognitionVGFStateSchema, RecordingStatus, TranscriptionStatus, type RecordingStatusType, type TranscriptionStatusType, createInitialRecognitionState, isValidRecordingStatusTransition } from './vgf-recognition-state.js';
+export { SimplifiedVGFRecognitionClient, SimplifiedVGFConfigBuilder, createSimplifiedVGFClient, createSimplifiedVGFClientWithBuilder, type ISimplifiedVGFRecognitionClient, type SimplifiedVGFClientConfig } from './simplified-vgf-recognition-client.js';
+export { type RecognitionState, RecognitionVGFStateSchema, RecordingStatus, TranscriptionStatus, type RecordingStatusType, type TranscriptionStatusType, createInitialRecognitionState, isTerminal, isValidRecordingStatusTransition } from './vgf-recognition-state.js';
 export { resetRecognitionVGFState } from './vgf-recognition-mapper.js';
 export { AudioEncoding } from '@recog/websocket';
 export { type GameContextV1, type SlotMap, RecognitionContextTypeV1, ControlSignalTypeV1, ControlSignalTypeV1 as ControlSignal, // Alias for backward compatibility
-type TranscriptionResultV1, type FunctionCallResultV1, type MetadataResultV1, type AudioMetricsResultV1, type ErrorResultV1, RecognitionResultTypeV1, ClientControlActionV1, type ASRRequestConfig, type ASRRequestV1, FinalTranscriptStability, createDefaultASRConfig, RecognitionProvider, DeepgramModel, ElevenLabsModel, FireworksModel, GladiaModel, GoogleModel, GeminiModel, OpenAIModel, SelfServeVllmModel, OpenAIRealtimeModel, MistralVoxtralModel, CartesiaModel, DashScopeModel, BedrockModel, AwsTranscribeModel, AmazonNovaSonicModel, Language, SampleRate, STAGES, type Stage } from '@recog/shared-types';
+type TranscriptionResultV1, type FunctionCallResultV1, type MetadataResultV1, type AudioMetricsResultV1, type ErrorResultV1, RecognitionResultTypeV1, ClientControlActionV1, type ASRRequestConfig, type ASRRequestV1, FinalTranscriptStability, createDefaultASRConfig, RecognitionProvider, AssemblyAIModel, DeepgramModel, ElevenLabsModel, FireworksModel, GladiaModel, GoogleModel, GeminiModel, OpenAIModel, SelfServeVllmModel, OpenAIRealtimeModel, MistralVoxtralModel, CartesiaModel, DashScopeModel, BedrockModel, AwsTranscribeModel, AmazonNovaSonicModel, Language, SampleRate, MicrophoneSourceType, STAGES, type Stage } from '@recog/shared-types';
 export { getRecognitionServiceBase, getRecognitionServiceHttpBase, getRecognitionServiceWsBase, getRecognitionServiceHost, getRecognitionConductorBase, getRecognitionConductorHttpBase, getRecognitionConductorWsBase, getRecognitionConductorHost, normalizeStage, RECOGNITION_SERVICE_BASES, RECOGNITION_CONDUCTOR_BASES } from '@recog/shared-config';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,wCAAwC,EACxC,KAAK,8CAA8C,EACnD,KAAK,mBAAmB,EACxB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,WAAW,EACZ,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAGrE,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,eAAe,EAChB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,gBAAgB,EACjB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,+BAA+B,EAC/B,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,8BAA8B,EAC9B,yBAAyB,EACzB,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC/B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACL,KAAK,gBAAgB,EACrB,yBAAyB,EACzB,eAAe,EACf,mBAAmB,EACnB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,6BAA6B,EAC7B,gCAAgC,EACjC,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAGvE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjD,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,OAAO,EACZ,wBAAwB,EACxB,mBAAmB,EACnB,mBAAmB,IAAI,aAAa,EAAG,mCAAmC;AAG1E,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,uBAAuB,EACvB,qBAAqB,EAGrB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,wBAAwB,EACxB,sBAAsB,EACtB,mBAAmB,EACnB,aAAa,EACb,eAAe,EACf,cAAc,EACd,WAAW,EACX,WAAW,EACX,WAAW,EACX,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,EACpB,QAAQ,EACR,UAAU,EAGV,MAAM,EACN,KAAK,KAAK,EACX,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,yBAAyB,EACzB,6BAA6B,EAC7B,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,+BAA+B,EAC/B,6BAA6B,EAC7B,2BAA2B,EAC3B,cAAc,EACd,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,wCAAwC,EACxC,KAAK,8CAA8C,EACnD,KAAK,mBAAmB,EACxB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,WAAW,EACZ,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAGrE,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,eAAe,EAChB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,gBAAgB,EACjB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,+BAA+B,EAC/B,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,yBAAyB,EACzB,oCAAoC,EACpC,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC/B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACL,KAAK,gBAAgB,EACrB,yBAAyB,EACzB,eAAe,EACf,mBAAmB,EACnB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,6BAA6B,EAC7B,UAAU,EACV,gCAAgC,EACjC,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAGvE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjD,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,OAAO,EACZ,wBAAwB,EACxB,mBAAmB,EACnB,mBAAmB,IAAI,aAAa,EAAG,mCAAmC;AAG1E,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,uBAAuB,EACvB,qBAAqB,EAGrB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,wBAAwB,EACxB,sBAAsB,EACtB,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,eAAe,EACf,cAAc,EACd,WAAW,EACX,WAAW,EACX,WAAW,EACX,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,EACpB,QAAQ,EACR,UAAU,EAGV,oBAAoB,EAGpB,MAAM,EACN,KAAK,KAAK,EACX,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,yBAAyB,EACzB,6BAA6B,EAC7B,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,+BAA+B,EAC/B,6BAA6B,EAC7B,2BAA2B,EAC3B,cAAc,EACd,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,sBAAsB,CAAC"}