@volley/recognition-client-sdk 0.1.385 → 0.1.418

package/dist/index.bundled.d.ts

@@ -218,7 +218,8 @@ declare enum RecognitionResultTypeV1 {
     FUNCTION_CALL = "FunctionCall",
     METADATA = "Metadata",
     ERROR = "Error",
-    CLIENT_CONTROL_MESSAGE = "ClientControlMessage"
+    CLIENT_CONTROL_MESSAGE = "ClientControlMessage",
+    AUDIO_METRICS = "AudioMetrics"
 }
 /**
  * Transcription result V1 - contains transcript message
@@ -293,6 +294,18 @@ declare const FunctionCallResultSchemaV1: z.ZodObject<{
     functionArgJson: string;
 }>;
 type FunctionCallResultV1 = z.infer<typeof FunctionCallResultSchemaV1>;
+/**
+ * Transcript outcome type - categorizes final transcript state
+ * Used in Metadata schema. Maps 1:1 with Datadog metrics:
+ * - WITH_CONTENT → recog.client.websocket.transcript.final_with_content
+ * - EMPTY → recog.client.websocket.transcript.final_empty
+ * - NEVER_SENT → derived from sessions.streamed - final_with_content - final_empty
+ */
+declare enum TranscriptOutcomeType {
+    WITH_CONTENT = "with_content",
+    EMPTY = "empty",
+    NEVER_SENT = "never_sent"
+}
 /**
  * Metadata result V1 - contains metadata, timing information, and ASR config
  * Sent when the provider connection closes to provide final timing metrics and config
@@ -312,6 +325,7 @@ declare const MetadataResultSchemaV1: z.ZodObject<{
     apiType: z.ZodOptional<z.ZodNativeEnum<typeof ASRApiType>>;
     asrConfig: z.ZodOptional<z.ZodString>;
     rawAsrMetadata: z.ZodOptional<z.ZodString>;
+    transcriptOutcome: z.ZodOptional<z.ZodNativeEnum<typeof TranscriptOutcomeType>>;
 }, "strip", z.ZodTypeAny, {
     type: RecognitionResultTypeV1.METADATA;
     audioUtteranceId: string;
@@ -326,6 +340,7 @@ declare const MetadataResultSchemaV1: z.ZodObject<{
     apiType?: ASRApiType | undefined;
     asrConfig?: string | undefined;
     rawAsrMetadata?: string | undefined;
+    transcriptOutcome?: TranscriptOutcomeType | undefined;
 }, {
     type: RecognitionResultTypeV1.METADATA;
     audioUtteranceId: string;
@@ -340,6 +355,7 @@ declare const MetadataResultSchemaV1: z.ZodObject<{
     apiType?: ASRApiType | undefined;
     asrConfig?: string | undefined;
     rawAsrMetadata?: string | undefined;
+    transcriptOutcome?: TranscriptOutcomeType | undefined;
 }>;
 type MetadataResultV1 = z.infer<typeof MetadataResultSchemaV1>;
 /**
@@ -405,11 +421,11 @@ declare enum ClientControlActionV1 {
  * These are system configuration issues, not user-facing
  */
 declare const AuthenticationExceptionSchema: z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.AUTHENTICATION_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<false>;
@@ -419,10 +435,10 @@ declare const AuthenticationExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.AUTHENTICATION_ERROR;
     isImmediatelyAvailable: false;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     service?: string | undefined;
     authMethod?: string | undefined;
@@ -430,10 +446,10 @@ declare const AuthenticationExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.AUTHENTICATION_ERROR;
     isImmediatelyAvailable: false;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     service?: string | undefined;
     authMethod?: string | undefined;
@@ -445,11 +461,11 @@ type AuthenticationException = z.infer<typeof AuthenticationExceptionSchema>;
  * User provided invalid input - can show them what's wrong
  */
 declare const ValidationExceptionSchema: z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.VALIDATION_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<true>;
@@ -460,10 +476,10 @@ declare const ValidationExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.VALIDATION_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     field?: string | undefined;
     expected?: string | undefined;
@@ -472,10 +488,10 @@ declare const ValidationExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.VALIDATION_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     field?: string | undefined;
     expected?: string | undefined;
@@ -490,8 +506,8 @@ type ValidationException = z.infer<typeof ValidationExceptionSchema>;
 declare const ProviderExceptionSchema: z.ZodObject<{
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.PROVIDER_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<false>;
@@ -503,8 +519,8 @@ declare const ProviderExceptionSchema: z.ZodObject<{
     errorType: ErrorTypeV1.PROVIDER_ERROR;
     isImmediatelyAvailable: false;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     provider?: string | undefined;
     providerErrorCode?: string | number | undefined;
@@ -514,8 +530,8 @@ declare const ProviderExceptionSchema: z.ZodObject<{
     errorType: ErrorTypeV1.PROVIDER_ERROR;
     isImmediatelyAvailable: false;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     provider?: string | undefined;
     providerErrorCode?: string | number | undefined;
@@ -528,11 +544,11 @@ type ProviderException = z.infer<typeof ProviderExceptionSchema>;
  * Request took too long - user should try again
  */
 declare const TimeoutExceptionSchema: z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.TIMEOUT_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<true>;
@@ -542,10 +558,10 @@ declare const TimeoutExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.TIMEOUT_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     timeoutMs?: number | undefined;
     operation?: string | undefined;
@@ -553,10 +569,10 @@ declare const TimeoutExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.TIMEOUT_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     timeoutMs?: number | undefined;
     operation?: string | undefined;
@@ -568,11 +584,11 @@ type TimeoutException = z.infer<typeof TimeoutExceptionSchema>;
  * Rate limit or quota exceeded - user should wait
  */
 declare const QuotaExceededExceptionSchema: z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.QUOTA_EXCEEDED>;
     isImmediatelyAvailable: z.ZodLiteral<true>;
@@ -583,10 +599,10 @@ declare const QuotaExceededExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.QUOTA_EXCEEDED;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     quotaType?: string | undefined;
     resetAt?: number | undefined;
@@ -595,10 +611,10 @@ declare const QuotaExceededExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.QUOTA_EXCEEDED;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     quotaType?: string | undefined;
     resetAt?: number | undefined;
@@ -611,11 +627,11 @@ type QuotaExceededException = z.infer<typeof QuotaExceededExceptionSchema>;
  * Connection establishment or network failure - user should check network or retry
  */
 declare const ConnectionExceptionSchema: z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.CONNECTION_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<true>;
@@ -626,10 +642,10 @@ declare const ConnectionExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.CONNECTION_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     attempts?: number | undefined;
     url?: string | undefined;
@@ -638,10 +654,10 @@ declare const ConnectionExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.CONNECTION_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     attempts?: number | undefined;
     url?: string | undefined;
@@ -654,11 +670,11 @@ type ConnectionException = z.infer<typeof ConnectionExceptionSchema>;
  * Unexpected error - needs investigation
  */
 declare const UnknownExceptionSchema: z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.UNKNOWN_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<false>;
@@ -668,10 +684,10 @@ declare const UnknownExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.UNKNOWN_ERROR;
     isImmediatelyAvailable: false;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     stack?: string | undefined;
     context?: Record<string, unknown> | undefined;
@@ -679,10 +695,10 @@ declare const UnknownExceptionSchema: z.ZodObject<{
     message: string;
     errorType: ErrorTypeV1.UNKNOWN_ERROR;
     isImmediatelyAvailable: false;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     stack?: string | undefined;
     context?: Record<string, unknown> | undefined;
@@ -693,11 +709,11 @@ type UnknownException = z.infer<typeof UnknownExceptionSchema>;
  * Use this for type-safe error handling
  */
 declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.AUTHENTICATION_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<false>;
@@ -707,10 +723,10 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.AUTHENTICATION_ERROR;
     isImmediatelyAvailable: false;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     service?: string | undefined;
     authMethod?: string | undefined;
@@ -718,19 +734,19 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.AUTHENTICATION_ERROR;
     isImmediatelyAvailable: false;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     service?: string | undefined;
     authMethod?: string | undefined;
 }>, z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.VALIDATION_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<true>;
@@ -741,10 +757,10 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.VALIDATION_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     field?: string | undefined;
     expected?: string | undefined;
@@ -753,10 +769,10 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.VALIDATION_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     field?: string | undefined;
     expected?: string | undefined;
@@ -764,8 +780,8 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
 }>, z.ZodObject<{
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.PROVIDER_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<false>;
@@ -777,8 +793,8 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     errorType: ErrorTypeV1.PROVIDER_ERROR;
     isImmediatelyAvailable: false;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     provider?: string | undefined;
     providerErrorCode?: string | number | undefined;
@@ -788,18 +804,18 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     errorType: ErrorTypeV1.PROVIDER_ERROR;
     isImmediatelyAvailable: false;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     provider?: string | undefined;
     providerErrorCode?: string | number | undefined;
     isTransient?: boolean | undefined;
 }>, z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.TIMEOUT_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<true>;
@@ -809,10 +825,10 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.TIMEOUT_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     timeoutMs?: number | undefined;
     operation?: string | undefined;
@@ -820,19 +836,19 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.TIMEOUT_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     timeoutMs?: number | undefined;
     operation?: string | undefined;
 }>, z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.QUOTA_EXCEEDED>;
     isImmediatelyAvailable: z.ZodLiteral<true>;
@@ -843,10 +859,10 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.QUOTA_EXCEEDED;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     quotaType?: string | undefined;
     resetAt?: number | undefined;
@@ -855,20 +871,20 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.QUOTA_EXCEEDED;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     quotaType?: string | undefined;
     resetAt?: number | undefined;
     retryAfterSeconds?: number | undefined;
 }>, z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.CONNECTION_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<true>;
@@ -879,10 +895,10 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.CONNECTION_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     attempts?: number | undefined;
     url?: string | undefined;
@@ -891,20 +907,20 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.CONNECTION_ERROR;
     isImmediatelyAvailable: true;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     attempts?: number | undefined;
     url?: string | undefined;
     underlyingError?: string | undefined;
 }>, z.ZodObject<{
-    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     message: z.ZodString;
-    audioUtteranceId: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodNativeEnum<typeof RecognitionProvider>>;
     description: z.ZodOptional<z.ZodString>;
+    audioUtteranceId: z.ZodOptional<z.ZodString>;
     timestamp: z.ZodOptional<z.ZodNumber>;
     errorType: z.ZodLiteral<ErrorTypeV1.UNKNOWN_ERROR>;
     isImmediatelyAvailable: z.ZodLiteral<false>;
@@ -914,10 +930,10 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.UNKNOWN_ERROR;
     isImmediatelyAvailable: false;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     stack?: string | undefined;
     context?: Record<string, unknown> | undefined;
@@ -925,10 +941,10 @@ declare const RecognitionExceptionSchema: z.ZodDiscriminatedUnion<"errorType", [
     message: string;
     errorType: ErrorTypeV1.UNKNOWN_ERROR;
     isImmediatelyAvailable: false;
-    provider?: RecognitionProvider | undefined;
     code?: string | number | undefined;
-    audioUtteranceId?: string | undefined;
+    provider?: RecognitionProvider | undefined;
     description?: string | undefined;
+    audioUtteranceId?: string | undefined;
     timestamp?: number | undefined;
     stack?: string | undefined;
     context?: Record<string, unknown> | undefined;
@@ -1520,6 +1536,12 @@ interface IRecognitionClientConfig {
     asrRequestConfig?: ASRRequestConfig;
     /** Game context for improved recognition accuracy */
     gameContext?: GameContextV1;
+    /**
+     * Game ID for tracking and routing purposes (optional)
+     * If provided, this is added to the WebSocket URL as a query parameter.
+     * If gameContext is also provided, this takes precedence over gameContext.gameId.
+     */
+    gameId?: string;
     /** Audio utterance ID (optional) - if not provided, a UUID v4 will be generated */
     audioUtteranceId?: string;
     /** Callback URLs for server-side notifications with optional message type filtering (optional)
@@ -1885,6 +1907,11 @@ declare class ConfigBuilder {
      * Set game context
      */
     gameContext(context: GameContextV1): this;
+    /**
+     * Set game ID directly (takes precedence over gameContext.gameId)
+     * Use this when you only need to identify the game without full context.
+     */
+    gameId(id: string): this;
     /**
      * Set audio utterance ID
      */
@@ -2237,6 +2264,7 @@ declare class SimplifiedVGFRecognitionClient implements ISimplifiedVGFRecognitio
     private stateChangeCallback;
     private expectedUuid;
     private logger;
+    private lastSentTerminalUuid;
     constructor(config: SimplifiedVGFClientConfig);
     connect(): Promise<void>;
     sendAudio(audioData: ArrayBuffer | ArrayBufferView | Blob): void;
@@ -2251,6 +2279,7 @@ declare class SimplifiedVGFRecognitionClient implements ISimplifiedVGFRecognitio
     isTranscriptionFinished(): boolean;
     isBufferOverflowing(): boolean;
     getVGFState(): RecognitionState;
+    private isTerminalStatus;
     private notifyStateChange;
 }
 /**
@@ -2298,6 +2327,31 @@ declare class SimplifiedVGFRecognitionClient implements ISimplifiedVGFRecognitio
  */
 declare function createSimplifiedVGFClient(config: SimplifiedVGFClientConfig): ISimplifiedVGFRecognitionClient;
 
+/**
+ * VGF Recognition Mapper
+ *
+ * Maps between the existing recognition client types and the simplified VGF state.
+ * This provides a clean abstraction layer for game developers.
+ */
+
+/**
+ * Resets session state with a new UUID.
+ *
+ * This creates a fresh session state while preserving non-session fields
+ * (like promptSlotMap, asrConfig, etc.)
+ *
+ * Resets:
+ * - audioUtteranceId → new UUID
+ * - transcriptionStatus → NOT_STARTED
+ * - startRecordingStatus → READY
+ * - recognitionActionProcessingState → NOT_STARTED
+ * - finalTranscript → undefined
+ *
+ * @param currentState - The current recognition state
+ * @returns A new state with reset session fields and a new UUID
+ */
+declare function resetSessionState(currentState: RecognitionState): RecognitionState;
+
 /**
  * Base URL schema shared across service endpoint helpers.
  */
@@ -2338,5 +2392,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 { AudioEncoding, ClientControlActionV1, ClientState, ConfigBuilder, ConnectionError, ControlSignalTypeV1 as ControlSignal, ControlSignalTypeV1, DeepgramModel, ElevenLabsModel, ErrorTypeV1, FinalTranscriptStability, FireworksModel, GeminiModel, GoogleModel, Language, OpenAIModel, RECOGNITION_CONDUCTOR_BASES, RECOGNITION_SERVICE_BASES, RealTimeTwoWayWebSocketRecognitionClient, RecognitionContextTypeV1, RecognitionError, RecognitionProvider, RecognitionResultTypeV1, RecognitionVGFStateSchema, RecordingStatus, STAGES, SampleRate, SimplifiedVGFRecognitionClient, TimeoutError, TranscriptionStatus, ValidationError, createClient, createClientWithBuilder, createDefaultASRConfig, createInitialRecognitionState, createSimplifiedVGFClient, getRecognitionConductorBase, getRecognitionConductorHost, getRecognitionConductorHttpBase, getRecognitionConductorWsBase, getRecognitionServiceBase, getRecognitionServiceHost, getRecognitionServiceHttpBase, getRecognitionServiceWsBase, getUserFriendlyMessage, isExceptionImmediatelyAvailable, isNormalDisconnection, isValidRecordingStatusTransition, normalizeStage };
+export { AudioEncoding, ClientControlActionV1, ClientState, ConfigBuilder, ConnectionError, ControlSignalTypeV1 as ControlSignal, ControlSignalTypeV1, DeepgramModel, ElevenLabsModel, ErrorTypeV1, FinalTranscriptStability, FireworksModel, GeminiModel, GoogleModel, Language, OpenAIModel, RECOGNITION_CONDUCTOR_BASES, RECOGNITION_SERVICE_BASES, RealTimeTwoWayWebSocketRecognitionClient, RecognitionContextTypeV1, RecognitionError, RecognitionProvider, RecognitionResultTypeV1, RecognitionVGFStateSchema, RecordingStatus, STAGES, SampleRate, SimplifiedVGFRecognitionClient, TimeoutError, TranscriptionStatus, ValidationError, createClient, createClientWithBuilder, createDefaultASRConfig, createInitialRecognitionState, createSimplifiedVGFClient, getRecognitionConductorBase, getRecognitionConductorHost, getRecognitionConductorHttpBase, getRecognitionConductorWsBase, getRecognitionServiceBase, getRecognitionServiceHost, getRecognitionServiceHttpBase, getRecognitionServiceWsBase, getUserFriendlyMessage, isExceptionImmediatelyAvailable, isNormalDisconnection, isValidRecordingStatusTransition, normalizeStage, resetSessionState };
 export type { ASRRequestConfig, ASRRequestV1, 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

@@ -8,6 +8,7 @@ export type { RecognitionException, ConnectionException, TimeoutException, Valid
 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 { resetSessionState } 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 ErrorResultV1, RecognitionResultTypeV1, ClientControlActionV1, type ASRRequestConfig, type ASRRequestV1, FinalTranscriptStability, createDefaultASRConfig, RecognitionProvider, DeepgramModel, ElevenLabsModel, FireworksModel, GoogleModel, GeminiModel, OpenAIModel, Language, SampleRate, STAGES, type Stage } from '@recog/shared-types';

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;AAGpC,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,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,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,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,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAGhE,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,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,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"}