@volley/recognition-client-sdk 0.1.800 → 0.1.806

package/src/utils/url-builder.ts

@@ -4,7 +4,7 @@
  */
 
 import { getRecognitionServiceBase } from '@recog/shared-config';
-import type { GameContextV1, Stage } from '@recog/shared-types';
+import type { GameContextV1, Stage, MicrophoneSourceType } from '@recog/shared-types';
 import type { RecognitionCallbackUrl } from '../recognition-client.types.js';
 
 export interface UrlBuilderConfig {
@@ -17,6 +17,8 @@ export interface UrlBuilderConfig {
   deviceId?: string;
   accountId?: string;
   questionAnswerId?: string;
+  clientId?: string;
+  microphoneSourceType?: MicrophoneSourceType | string;
   platform?: string;
   gameContext?: GameContextV1;
   /** Standalone gameId - takes precedence over gameContext.gameId if both provided */
@@ -77,6 +79,12 @@ export function buildWebSocketUrl(config: UrlBuilderConfig): string {
   if (config.questionAnswerId) {
     url.searchParams.set('questionAnswerId', config.questionAnswerId);
   }
+  if (config.clientId) {
+    url.searchParams.set('clientId', config.clientId);
+  }
+  if (config.microphoneSourceType) {
+    url.searchParams.set('microphoneSourceType', config.microphoneSourceType);
+  }
   if (config.platform) {
     url.searchParams.set('platform', config.platform);
   }

package/src/vgf-recognition-state.ts

@@ -46,6 +46,15 @@ export const RecognitionVGFStateSchema = z.object({
     functionCallConfidence: z.number().optional(), // Confidence score for the function call.
     finalFunctionCallTimestamp: z.string().optional(), // When the final action after interpreting the transcript was taken. Immutable.
 
+    // Session identity — when set, the VGF client backfills these into
+    // GameContextV1 if the caller didn't pass a `gameContext` in config.
+    // Lets RecognitionState be the single source of truth: server seeds
+    // `gameId` + `gamePhase` + `promptSlotMap` per player, controller passes
+    // the whole state as `initialState`, no separate `gameContext` needed.
+    // Backward-compatible: if `gameContext` is also passed in config, it wins.
+    gameId: z.string().optional(),
+    gamePhase: z.string().optional(),
+
     // Support for prompt slot mapping - passed to recognition context when present
     promptSlotMap: z.record(z.string(), z.array(z.string())).optional(), // Optional map of slot names to prompt values for recognition context
 
@@ -107,6 +116,22 @@ export function createInitialRecognitionState(audioUtteranceId: string): Recogni
     }
 }
 
+// Helper for "session ended — no more state updates coming".
+// Terminal states are FINALIZED (clean end with transcript), ABORTED
+// (user cancelled), and ERROR (something failed). Use this anywhere
+// you forward RecognitionState updates to a server thunk: persist
+// every update, but only do cleanup / observability / scoring work
+// after isTerminal(state) is true. Branch on `transcriptionStatus`
+// when the action depends on *which* terminal state (e.g. only score
+// on FINALIZED, only emit "cancelled" telemetry on ABORTED).
+export function isTerminal(state: Pick<RecognitionState, "transcriptionStatus">): boolean {
+    return (
+        state.transcriptionStatus === TranscriptionStatus.FINALIZED ||
+        state.transcriptionStatus === TranscriptionStatus.ABORTED ||
+        state.transcriptionStatus === TranscriptionStatus.ERROR
+    )
+}
+
 // Helper function to validate state transitions
 export function isValidRecordingStatusTransition(from: string | undefined, to: string): boolean {
     const statusOrder = [