@volley/recognition-client-sdk 0.1.670 → 0.1.689

package/dist/browser.bundled.d.ts

@@ -264,7 +264,8 @@ declare enum RecognitionResultTypeV1 {
     METADATA = "Metadata",
     ERROR = "Error",
     CLIENT_CONTROL_MESSAGE = "ClientControlMessage",
-    AUDIO_METRICS = "AudioMetrics"
+    AUDIO_METRICS = "AudioMetrics",
+    SESSION_CONFIGURED = "SessionConfigured"
 }
 /**
  * Transcription result V1 - contains transcript message
@@ -543,6 +544,46 @@ declare const ErrorResultSchemaV1: z.ZodObject<{
     description?: string | undefined;
 }>;
 type ErrorResultV1 = z.infer<typeof ErrorResultSchemaV1>;
+/**
+ * Session configured message V1 - sent after ASR provider is selected and configured
+ * Fires after circuit breaker checks pass and provider/model are finalized,
+ * before audio streaming begins. Contains the actual ASR config that will be used.
+ */
+declare const SessionConfiguredSchemaV1: z.ZodObject<{
+    type: z.ZodLiteral<RecognitionResultTypeV1.SESSION_CONFIGURED>;
+    audioUtteranceId: z.ZodString;
+    provider: z.ZodOptional<z.ZodString>;
+    model: z.ZodOptional<z.ZodString>;
+    sampleRate: z.ZodOptional<z.ZodNumber>;
+    encoding: z.ZodOptional<z.ZodString>;
+    apiType: z.ZodOptional<z.ZodNativeEnum<typeof ASRApiType>>;
+    isFallback: z.ZodOptional<z.ZodBoolean>;
+    asrRequest: z.ZodOptional<z.ZodString>;
+    providerConfig: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: RecognitionResultTypeV1.SESSION_CONFIGURED;
+    audioUtteranceId: string;
+    provider?: string | undefined;
+    model?: string | undefined;
+    sampleRate?: number | undefined;
+    encoding?: string | undefined;
+    apiType?: ASRApiType | undefined;
+    isFallback?: boolean | undefined;
+    asrRequest?: string | undefined;
+    providerConfig?: string | undefined;
+}, {
+    type: RecognitionResultTypeV1.SESSION_CONFIGURED;
+    audioUtteranceId: string;
+    provider?: string | undefined;
+    model?: string | undefined;
+    sampleRate?: number | undefined;
+    encoding?: string | undefined;
+    apiType?: ASRApiType | undefined;
+    isFallback?: boolean | undefined;
+    asrRequest?: string | undefined;
+    providerConfig?: string | undefined;
+}>;
+type SessionConfiguredV1 = z.infer<typeof SessionConfiguredSchemaV1>;
 
 /**
  * Recognition Context Types V1
@@ -1102,6 +1143,8 @@ interface IRecognitionClientConfig {
     questionAnswerId?: string;
     /** Platform for audio recording device (optional, e.g., 'ios', 'android', 'web', 'unity') */
     platform?: string;
+    /** Experiment cohort (optional). Defaults to 'control' if not provided. */
+    experimentCohort?: 'treatment' | 'control';
     /** Callback when transcript is received */
     onTranscript?: (result: TranscriptionResultV1) => void;
     /**
@@ -1111,6 +1154,8 @@ interface IRecognitionClientConfig {
     onFunctionCall?: (result: FunctionCallResultV1) => void;
     /** Callback when metadata is received. Only once after transcription is complete.*/
     onMetadata?: (metadata: MetadataResultV1) => void;
+    /** Callback when session is configured with actual ASR provider/model (optional) */
+    onSessionConfigured?: (config: SessionConfiguredV1) => void;
     /** Callback when error occurs */
     onError?: (error: ErrorResultV1) => void;
     /** Callback when connected to WebSocket */

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, ErrorResultV1, Stage } from '@recog/shared-types';
+import type { ASRRequestConfig, GameContextV1, TranscriptionResultV1, MetadataResultV1, SessionConfiguredV1, ErrorResultV1, Stage } from '@recog/shared-types';
 /**
  * Builder for RealTimeTwoWayWebSocketRecognitionClientConfig
  *
@@ -86,6 +86,10 @@ export declare class ConfigBuilder {
      * Set platform
      */
     platform(platform: string): this;
+    /**
+     * Set experiment cohort (optional, defaults to 'control')
+     */
+    experimentCohort(cohort: 'treatment' | 'control'): this;
     /**
      * Set transcript callback
      */
@@ -94,6 +98,10 @@ export declare class ConfigBuilder {
      * Set metadata callback
      */
     onMetadata(callback: (metadata: MetadataResultV1) => void): this;
+    /**
+     * Set session configured callback (optional)
+     */
+    onSessionConfigured(callback: (config: SessionConfiguredV1) => void): this;
     /**
      * Set error callback
      */

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,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,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,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;IACH,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,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;;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;;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;IACH,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

@@ -264,7 +264,8 @@ declare enum RecognitionResultTypeV1 {
     METADATA = "Metadata",
     ERROR = "Error",
     CLIENT_CONTROL_MESSAGE = "ClientControlMessage",
-    AUDIO_METRICS = "AudioMetrics"
+    AUDIO_METRICS = "AudioMetrics",
+    SESSION_CONFIGURED = "SessionConfigured"
 }
 /**
  * Transcription result V1 - contains transcript message
@@ -552,6 +553,46 @@ declare enum ClientControlActionV1 {
     READY_FOR_UPLOADING_RECORDING = "ready_for_uploading_recording",
     STOP_RECORDING = "stop_recording"
 }
+/**
+ * Session configured message V1 - sent after ASR provider is selected and configured
+ * Fires after circuit breaker checks pass and provider/model are finalized,
+ * before audio streaming begins. Contains the actual ASR config that will be used.
+ */
+declare const SessionConfiguredSchemaV1: z.ZodObject<{
+    type: z.ZodLiteral<RecognitionResultTypeV1.SESSION_CONFIGURED>;
+    audioUtteranceId: z.ZodString;
+    provider: z.ZodOptional<z.ZodString>;
+    model: z.ZodOptional<z.ZodString>;
+    sampleRate: z.ZodOptional<z.ZodNumber>;
+    encoding: z.ZodOptional<z.ZodString>;
+    apiType: z.ZodOptional<z.ZodNativeEnum<typeof ASRApiType>>;
+    isFallback: z.ZodOptional<z.ZodBoolean>;
+    asrRequest: z.ZodOptional<z.ZodString>;
+    providerConfig: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: RecognitionResultTypeV1.SESSION_CONFIGURED;
+    audioUtteranceId: string;
+    provider?: string | undefined;
+    model?: string | undefined;
+    sampleRate?: number | undefined;
+    encoding?: string | undefined;
+    apiType?: ASRApiType | undefined;
+    isFallback?: boolean | undefined;
+    asrRequest?: string | undefined;
+    providerConfig?: string | undefined;
+}, {
+    type: RecognitionResultTypeV1.SESSION_CONFIGURED;
+    audioUtteranceId: string;
+    provider?: string | undefined;
+    model?: string | undefined;
+    sampleRate?: number | undefined;
+    encoding?: string | undefined;
+    apiType?: ASRApiType | undefined;
+    isFallback?: boolean | undefined;
+    asrRequest?: string | undefined;
+    providerConfig?: string | undefined;
+}>;
+type SessionConfiguredV1 = z.infer<typeof SessionConfiguredSchemaV1>;
 
 /**
  * Error Exception Types
@@ -1862,6 +1903,8 @@ interface IRecognitionClientConfig {
     questionAnswerId?: string;
     /** Platform for audio recording device (optional, e.g., 'ios', 'android', 'web', 'unity') */
     platform?: string;
+    /** Experiment cohort (optional). Defaults to 'control' if not provided. */
+    experimentCohort?: 'treatment' | 'control';
     /** Callback when transcript is received */
     onTranscript?: (result: TranscriptionResultV1) => void;
     /**
@@ -1871,6 +1914,8 @@ interface IRecognitionClientConfig {
     onFunctionCall?: (result: FunctionCallResultV1) => void;
     /** Callback when metadata is received. Only once after transcription is complete.*/
     onMetadata?: (metadata: MetadataResultV1) => void;
+    /** Callback when session is configured with actual ASR provider/model (optional) */
+    onSessionConfigured?: (config: SessionConfiguredV1) => void;
     /** Callback when error occurs */
     onError?: (error: ErrorResultV1) => void;
     /** Callback when connected to WebSocket */
@@ -2297,6 +2342,10 @@ declare class ConfigBuilder {
      * Set platform
      */
     platform(platform: string): this;
+    /**
+     * Set experiment cohort (optional, defaults to 'control')
+     */
+    experimentCohort(cohort: 'treatment' | 'control'): this;
     /**
      * Set transcript callback
      */
@@ -2305,6 +2354,10 @@ declare class ConfigBuilder {
      * Set metadata callback
      */
     onMetadata(callback: (metadata: MetadataResultV1) => void): this;
+    /**
+     * Set session configured callback (optional)
+     */
+    onSessionConfigured(callback: (config: SessionConfiguredV1) => void): this;
     /**
      * Set error callback
      */

package/dist/index.js

@@ -3827,6 +3827,7 @@ var RecognitionResultTypeV1;
   RecognitionResultTypeV12["ERROR"] = "Error";
   RecognitionResultTypeV12["CLIENT_CONTROL_MESSAGE"] = "ClientControlMessage";
   RecognitionResultTypeV12["AUDIO_METRICS"] = "AudioMetrics";
+  RecognitionResultTypeV12["SESSION_CONFIGURED"] = "SessionConfigured";
 })(RecognitionResultTypeV1 || (RecognitionResultTypeV1 = {}));
 var TranscriptionResultSchemaV1 = z.object({
   type: z.literal(RecognitionResultTypeV1.TRANSCRIPTION),
@@ -3948,6 +3949,22 @@ var ClientControlMessageSchemaV1 = z.object({
   action: ClientControlActionsV1
   // The control action to perform
 });
+var SessionConfiguredSchemaV1 = z.object({
+  type: z.literal(RecognitionResultTypeV1.SESSION_CONFIGURED),
+  audioUtteranceId: z.string(),
+  // Provider identification
+  provider: z.string().optional(),
+  model: z.string().optional(),
+  sampleRate: z.number().optional(),
+  encoding: z.string().optional(),
+  apiType: z.nativeEnum(ASRApiType).optional(),
+  isFallback: z.boolean().optional(),
+  // Original ASR request as JSON string (includes prefixMode, prefixId, etc.)
+  asrRequest: z.string().optional(),
+  // Provider-specific config as JSON string (raw config sent to provider API, e.g. Deepgram's punctuate/endpointing)
+  providerConfig: z.string().optional()
+  // Stringified JSON of provider-specific config
+});
 var AudioMetricsResultSchemaV1 = z.object({
   type: z.literal(RecognitionResultTypeV1.AUDIO_METRICS),
   valid: z.boolean(),
@@ -3971,7 +3988,8 @@ var RecognitionResultSchemaV1 = z.discriminatedUnion("type", [
   ErrorResultSchemaV1,
   // P1 - P2
   FunctionCallResultSchemaV1,
-  ClientControlMessageSchemaV1
+  ClientControlMessageSchemaV1,
+  SessionConfiguredSchemaV1
 ]);
 
 // ../../libs/types/dist/provider-transcription.types.js
@@ -4437,8 +4455,9 @@ var RecognitionGameInfoSchema = z.object({
   questionAskedId: z.string().optional(),
   /** @deprecated Use questionAskedId instead. Kept for backward compatibility during migration. */
   questionAnswerId: z.string().optional(),
-  platform: z.string().optional()
-  // Platform for audio recording device (use the definition of platform teams)
+  platform: z.string().optional(),
+  experimentCohort: z.enum(["treatment", "control"]).optional()
+  // Experiment cohort, defaults to 'control' if not provided
 });
 var RecognitionQueryMetadataSchema = z.object({
   audioUtteranceId: z.string(),
@@ -5110,6 +5129,9 @@ function buildWebSocketUrl(config) {
   if (config.gameContext?.gamePhase) {
     url.searchParams.set("gamePhase", config.gameContext.gamePhase);
   }
+  if (config.experimentCohort) {
+    url.searchParams.set("experimentCohort", config.experimentCohort);
+  }
   return url.toString();
 }
 
@@ -5292,6 +5314,9 @@ var MessageHandler = class {
       case RecognitionResultTypeV1.CLIENT_CONTROL_MESSAGE:
         this.callbacks.onControlMessage(msgData);
         break;
+      case RecognitionResultTypeV1.SESSION_CONFIGURED:
+        this.callbacks.onSessionConfigured?.(msgData);
+        break;
       default:
         if (this.callbacks.logger) {
           this.callbacks.logger("debug", "[RecogSDK] Unknown message type", { type: msgType });
@@ -5403,7 +5428,8 @@ var RealTimeTwoWayWebSocketRecognitionClient = class _RealTimeTwoWayWebSocketRec
       ...config.questionAnswerId && { questionAnswerId: config.questionAnswerId },
       ...config.platform && { platform: config.platform },
       ...config.gameContext && { gameContext: config.gameContext },
-      ...config.gameId && { gameId: config.gameId }
+      ...config.gameId && { gameId: config.gameId },
+      ...config.experimentCohort && { experimentCohort: config.experimentCohort }
     });
     super({
       url,
@@ -5436,6 +5462,7 @@ var RealTimeTwoWayWebSocketRecognitionClient = class _RealTimeTwoWayWebSocketRec
       }),
       onMetadata: config.onMetadata || (() => {
       }),
+      onSessionConfigured: config.onSessionConfigured,
       onError: config.onError || (() => {
       }),
       onConnected: config.onConnected || (() => {
@@ -5463,6 +5490,7 @@ var RealTimeTwoWayWebSocketRecognitionClient = class _RealTimeTwoWayWebSocketRec
       onMetadata: this.config.onMetadata,
       onError: this.config.onError,
       onControlMessage: this.handleControlMessage.bind(this),
+      onSessionConfigured: this.config.onSessionConfigured,
       ...this.config.logger && { logger: this.config.logger }
     });
   }
@@ -6106,6 +6134,13 @@ var ConfigBuilder = class {
     this.config.platform = platform;
     return this;
   }
+  /**
+   * Set experiment cohort (optional, defaults to 'control')
+   */
+  experimentCohort(cohort) {
+    this.config.experimentCohort = cohort;
+    return this;
+  }
   /**
    * Set transcript callback
    */
@@ -6120,6 +6155,13 @@ var ConfigBuilder = class {
     this.config.onMetadata = callback;
     return this;
   }
+  /**
+   * Set session configured callback (optional)
+   */
+  onSessionConfigured(callback) {
+    this.config.onSessionConfigured = callback;
+    return this;
+  }
   /**
    * Set error callback
    */