@volley/recognition-client-sdk 0.1.800 → 0.1.803
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.bundled.d.ts +8 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +21 -5
- package/dist/index.js.map +2 -2
- package/dist/simplified-vgf-recognition-client.d.ts +1 -2
- package/dist/simplified-vgf-recognition-client.d.ts.map +1 -1
- package/dist/vgf-recognition-state.d.ts +7 -0
- package/dist/vgf-recognition-state.d.ts.map +1 -1
- package/package.json +3 -3
- package/src/index.ts +1 -0
- package/src/simplified-vgf-recognition-client.ts +20 -12
- package/src/vgf-recognition-state.ts +25 -0
package/dist/index.bundled.d.ts
CHANGED
|
@@ -2805,6 +2805,8 @@ declare const RecognitionVGFStateSchema: z.ZodObject<{
|
|
|
2805
2805
|
functionCallMetadata: z.ZodOptional<z.ZodString>;
|
|
2806
2806
|
functionCallConfidence: z.ZodOptional<z.ZodNumber>;
|
|
2807
2807
|
finalFunctionCallTimestamp: z.ZodOptional<z.ZodString>;
|
|
2808
|
+
gameId: z.ZodOptional<z.ZodString>;
|
|
2809
|
+
gamePhase: z.ZodOptional<z.ZodString>;
|
|
2808
2810
|
promptSlotMap: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>>;
|
|
2809
2811
|
promptSTT: z.ZodOptional<z.ZodString>;
|
|
2810
2812
|
promptSTF: z.ZodOptional<z.ZodString>;
|
|
@@ -2859,6 +2861,8 @@ declare const RecognitionVGFStateSchema: z.ZodObject<{
|
|
|
2859
2861
|
functionCallMetadata?: string | undefined;
|
|
2860
2862
|
functionCallConfidence?: number | undefined;
|
|
2861
2863
|
finalFunctionCallTimestamp?: string | undefined;
|
|
2864
|
+
gameId?: string | undefined;
|
|
2865
|
+
gamePhase?: string | undefined;
|
|
2862
2866
|
promptSlotMap?: Record<string, string[]> | undefined;
|
|
2863
2867
|
promptSTT?: string | undefined;
|
|
2864
2868
|
promptSTF?: string | undefined;
|
|
@@ -2901,6 +2905,8 @@ declare const RecognitionVGFStateSchema: z.ZodObject<{
|
|
|
2901
2905
|
functionCallMetadata?: string | undefined;
|
|
2902
2906
|
functionCallConfidence?: number | undefined;
|
|
2903
2907
|
finalFunctionCallTimestamp?: string | undefined;
|
|
2908
|
+
gameId?: string | undefined;
|
|
2909
|
+
gamePhase?: string | undefined;
|
|
2904
2910
|
promptSlotMap?: Record<string, string[]> | undefined;
|
|
2905
2911
|
promptSTT?: string | undefined;
|
|
2906
2912
|
promptSTF?: string | undefined;
|
|
@@ -2931,6 +2937,7 @@ declare const TranscriptionStatus: {
|
|
|
2931
2937
|
};
|
|
2932
2938
|
type TranscriptionStatusType = typeof TranscriptionStatus[keyof typeof TranscriptionStatus];
|
|
2933
2939
|
declare function createInitialRecognitionState(audioUtteranceId: string): RecognitionState;
|
|
2940
|
+
declare function isTerminal(state: Pick<RecognitionState, "transcriptionStatus">): boolean;
|
|
2934
2941
|
declare function isValidRecordingStatusTransition(from: string | undefined, to: string): boolean;
|
|
2935
2942
|
|
|
2936
2943
|
/**
|
|
@@ -3015,7 +3022,6 @@ declare class SimplifiedVGFRecognitionClient implements ISimplifiedVGFRecognitio
|
|
|
3015
3022
|
sendGameContext(context: GameContextV1): void;
|
|
3016
3023
|
isServerReady(): boolean;
|
|
3017
3024
|
getVGFState(): RecognitionState;
|
|
3018
|
-
private isTerminalStatus;
|
|
3019
3025
|
private notifyStateChange;
|
|
3020
3026
|
}
|
|
3021
3027
|
/**
|
|
@@ -3128,5 +3134,5 @@ declare function getRecognitionConductorHttpBase(stage?: Stage | string | null |
|
|
|
3128
3134
|
declare function getRecognitionConductorWsBase(stage?: Stage | string | null | undefined): string;
|
|
3129
3135
|
declare function getRecognitionConductorHost(stage?: Stage | string | null | undefined): string;
|
|
3130
3136
|
|
|
3131
|
-
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 };
|
|
3137
|
+
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, isTerminal, isValidRecordingStatusTransition, normalizeStage, resetRecognitionVGFState };
|
|
3132
3138
|
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
CHANGED
|
@@ -7,7 +7,7 @@ export { ErrorTypeV1 } from '@recog/shared-types';
|
|
|
7
7
|
export type { RecognitionException, ConnectionException, TimeoutException, ValidationException, AuthenticationException, ProviderException, QuotaExceededException, UnknownException } from '@recog/shared-types';
|
|
8
8
|
export { isExceptionImmediatelyAvailable, getUserFriendlyMessage } from '@recog/shared-types';
|
|
9
9
|
export { SimplifiedVGFRecognitionClient, createSimplifiedVGFClient, type ISimplifiedVGFRecognitionClient, type SimplifiedVGFClientConfig } from './simplified-vgf-recognition-client.js';
|
|
10
|
-
export { type RecognitionState, RecognitionVGFStateSchema, RecordingStatus, TranscriptionStatus, type RecordingStatusType, type TranscriptionStatusType, createInitialRecognitionState, isValidRecordingStatusTransition } from './vgf-recognition-state.js';
|
|
10
|
+
export { type RecognitionState, RecognitionVGFStateSchema, RecordingStatus, TranscriptionStatus, type RecordingStatusType, type TranscriptionStatusType, createInitialRecognitionState, isTerminal, isValidRecordingStatusTransition } from './vgf-recognition-state.js';
|
|
11
11
|
export { resetRecognitionVGFState } from './vgf-recognition-mapper.js';
|
|
12
12
|
export { AudioEncoding } from '@recog/websocket';
|
|
13
13
|
export { type GameContextV1, type SlotMap, RecognitionContextTypeV1, ControlSignalTypeV1, ControlSignalTypeV1 as ControlSignal, // Alias for backward compatibility
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +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"}
|
|
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,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,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"}
|
package/dist/index.js
CHANGED
|
@@ -6461,6 +6461,14 @@ var RecognitionVGFStateSchema = z.object({
|
|
|
6461
6461
|
// Confidence score for the function call.
|
|
6462
6462
|
finalFunctionCallTimestamp: z.string().optional(),
|
|
6463
6463
|
// When the final action after interpreting the transcript was taken. Immutable.
|
|
6464
|
+
// Session identity — when set, the VGF client backfills these into
|
|
6465
|
+
// GameContextV1 if the caller didn't pass a `gameContext` in config.
|
|
6466
|
+
// Lets RecognitionState be the single source of truth: server seeds
|
|
6467
|
+
// `gameId` + `gamePhase` + `promptSlotMap` per player, controller passes
|
|
6468
|
+
// the whole state as `initialState`, no separate `gameContext` needed.
|
|
6469
|
+
// Backward-compatible: if `gameContext` is also passed in config, it wins.
|
|
6470
|
+
gameId: z.string().optional(),
|
|
6471
|
+
gamePhase: z.string().optional(),
|
|
6464
6472
|
// Support for prompt slot mapping - passed to recognition context when present
|
|
6465
6473
|
promptSlotMap: z.record(z.string(), z.array(z.string())).optional(),
|
|
6466
6474
|
// Optional map of slot names to prompt values for recognition context
|
|
@@ -6507,6 +6515,9 @@ function createInitialRecognitionState(audioUtteranceId) {
|
|
|
6507
6515
|
recognitionActionProcessingState: RecognitionActionProcessingState.NOT_STARTED
|
|
6508
6516
|
};
|
|
6509
6517
|
}
|
|
6518
|
+
function isTerminal(state) {
|
|
6519
|
+
return state.transcriptionStatus === TranscriptionStatus.FINALIZED || state.transcriptionStatus === TranscriptionStatus.ABORTED || state.transcriptionStatus === TranscriptionStatus.ERROR;
|
|
6520
|
+
}
|
|
6510
6521
|
function isValidRecordingStatusTransition(from, to) {
|
|
6511
6522
|
const statusOrder = [
|
|
6512
6523
|
RecordingStatus.NOT_READY,
|
|
@@ -6659,6 +6670,13 @@ var SimplifiedVGFRecognitionClient = class {
|
|
|
6659
6670
|
}
|
|
6660
6671
|
this.state = { ...this.state, startRecordingStatus: "READY" };
|
|
6661
6672
|
this.expectedUuid = this.state.audioUtteranceId;
|
|
6673
|
+
if (!clientConfig.gameContext && this.state.gameId && this.state.gamePhase) {
|
|
6674
|
+
clientConfig.gameContext = {
|
|
6675
|
+
type: RecognitionContextTypeV1.GAME_CONTEXT,
|
|
6676
|
+
gameId: this.state.gameId,
|
|
6677
|
+
gamePhase: this.state.gamePhase
|
|
6678
|
+
};
|
|
6679
|
+
}
|
|
6662
6680
|
const hasPromptInputs = this.state.promptSlotMap !== void 0 || this.state.promptSTT !== void 0 || this.state.promptSTF !== void 0 || this.state.promptTTF !== void 0;
|
|
6663
6681
|
if (hasPromptInputs) {
|
|
6664
6682
|
if (clientConfig.asrRequestConfig) {
|
|
@@ -6666,7 +6684,7 @@ var SimplifiedVGFRecognitionClient = class {
|
|
|
6666
6684
|
}
|
|
6667
6685
|
if (!clientConfig.gameContext) {
|
|
6668
6686
|
if (clientConfig.logger) {
|
|
6669
|
-
clientConfig.logger("warn", "[VGF] prompt inputs found but no gameContext provided. They will not be sent.");
|
|
6687
|
+
clientConfig.logger("warn", "[VGF] prompt inputs found but no gameContext provided and state has no gameId/gamePhase. They will not be sent.");
|
|
6670
6688
|
}
|
|
6671
6689
|
} else {
|
|
6672
6690
|
if (this.state.promptSlotMap !== void 0) {
|
|
@@ -6878,11 +6896,8 @@ var SimplifiedVGFRecognitionClient = class {
|
|
|
6878
6896
|
getVGFState() {
|
|
6879
6897
|
return { ...this.state };
|
|
6880
6898
|
}
|
|
6881
|
-
isTerminalStatus(status) {
|
|
6882
|
-
return status === TranscriptionStatus.FINALIZED || status === TranscriptionStatus.ABORTED || status === TranscriptionStatus.ERROR;
|
|
6883
|
-
}
|
|
6884
6899
|
notifyStateChange() {
|
|
6885
|
-
if (
|
|
6900
|
+
if (isTerminal(this.state)) {
|
|
6886
6901
|
if (this.lastSentTerminalUuid === this.expectedUuid) {
|
|
6887
6902
|
if (this.logger) {
|
|
6888
6903
|
this.logger(
|
|
@@ -6968,6 +6983,7 @@ export {
|
|
|
6968
6983
|
getUserFriendlyMessage,
|
|
6969
6984
|
isExceptionImmediatelyAvailable,
|
|
6970
6985
|
isNormalDisconnection,
|
|
6986
|
+
isTerminal,
|
|
6971
6987
|
isValidRecordingStatusTransition,
|
|
6972
6988
|
normalizeStage,
|
|
6973
6989
|
resetRecognitionVGFState
|