@volley/recognition-client-sdk/src/index.ts

Recognition Service TypeScript/Node.js Client SDK

// Export RealTimeTwoWayWebSocketRecognitionClient (primary SDK)
export {
  RealTimeTwoWayWebSocketRecognitionClient,
  type RealTimeTwoWayWebSocketRecognitionClientConfig,
  type TranscriptionResult,
  isNormalDisconnection
} from './recognition-client.js';

// Export interfaces for dependency injection and testing
export {
  type IRecognitionClient,
  type IRecognitionClientConfig,
  type IRecognitionClientStats,
  type RecognitionCallbackUrl,
  ClientState
} from './recognition-client.types.js';

// Export configuration builder
export { ConfigBuilder } from './config-builder.js';

// Export factory functions
export { createClient, createClientWithBuilder } from './factory.js';

// Export error classes
export {
  RecognitionError,
  ConnectionError,
  TimeoutError,
  ValidationError
} from './errors.js';

// Export error types from shared-types
export { ErrorTypeV1 } from '@recog/shared-types';

// Export error exception types for advanced error handling
export type {
  RecognitionException,
  ConnectionException,
  TimeoutException,
  ValidationException,
  AuthenticationException,
  ProviderException,
  QuotaExceededException,
  UnknownException
} from '@recog/shared-types';

// Export error helper functions
export {
  isExceptionImmediatelyAvailable,
  getUserFriendlyMessage
} from '@recog/shared-types';

// Export VGF state management (new simplified interface)
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';

// Re-export WebSocket protocol types for advanced usage
export { AudioEncoding } from '@recog/websocket';

// Re-export necessary types from shared-types
export {
  // Recognition context types
  type GameContextV1,
  type SlotMap,
  RecognitionContextTypeV1,
  ControlSignalTypeV1,
  ControlSignalTypeV1 as ControlSignal,  // Alias for backward compatibility

  // Result types
  type TranscriptionResultV1,
  type FunctionCallResultV1,
  type MetadataResultV1,
  type ErrorResultV1,
  RecognitionResultTypeV1,
  ClientControlActionV1,

  // ASR configuration types
  type ASRRequestConfig,
  type ASRRequestV1,
  FinalTranscriptStability,
  createDefaultASRConfig,
  RecognitionProvider,
  DeepgramModel,
  ElevenLabsModel,
  FireworksModel,
  GoogleModel,
  GeminiModel,
  OpenAIModel,
  Language,
  SampleRate,

  // Stage/Environment types
  STAGES,
  type Stage
} from '@recog/shared-types';

// Re-export shared config helpers so consumers don't depend on internal package
export {
  getRecognitionServiceBase,
  getRecognitionServiceHttpBase,
  getRecognitionServiceWsBase,
  getRecognitionServiceHost,
  getRecognitionConductorBase,
  getRecognitionConductorHttpBase,
  getRecognitionConductorWsBase,
  getRecognitionConductorHost,
  normalizeStage,
  RECOGNITION_SERVICE_BASES,
  RECOGNITION_CONDUCTOR_BASES
} from '@recog/shared-config';