@volley/recognition-client-sdk 0.1.200

package/src/config-builder.ts

@@ -0,0 +1,213 @@
+/**
+ * Configuration Builder for Recognition Client
+ *
+ * Simple builder pattern for RealTimeTwoWayWebSocketRecognitionClientConfig
+ */
+
+import type {
+  RealTimeTwoWayWebSocketRecognitionClientConfig,
+  RecognitionCallbackUrl
+} from './recognition-client.types.js';
+import type {
+  ASRRequestConfig,
+  GameContextV1,
+  TranscriptionResultV1,
+  MetadataResultV1,
+  ErrorResultV1
+} from '@recog/shared-types';
+
+/**
+ * Builder for RealTimeTwoWayWebSocketRecognitionClientConfig
+ *
+ * Provides a fluent API for building client configurations.
+ *
+ * Example:
+ * ```typescript
+ * const config = new ConfigBuilder()
+ *   .url('ws://localhost:3101/ws/v1/recognize')
+ *   .asrRequestConfig({
+ *     provider: RecognitionProvider.DEEPGRAM,
+ *     model: 'nova-2-general'
+ *   })
+ *   .onTranscript((result) => console.log(result))
+ *   .build();
+ * ```
+ */
+export class ConfigBuilder {
+  private config: Partial<RealTimeTwoWayWebSocketRecognitionClientConfig> = {};
+
+  /**
+   * Set the WebSocket URL
+   */
+  url(url: string): this {
+    this.config.url = url;
+    return this;
+  }
+
+  /**
+   * Set ASR request configuration
+   */
+  asrRequestConfig(config: ASRRequestConfig): this {
+    this.config.asrRequestConfig = config;
+    return this;
+  }
+
+  /**
+   * Set game context
+   */
+  gameContext(context: GameContextV1): this {
+    this.config.gameContext = context;
+    return this;
+  }
+
+  /**
+   * Set audio utterance ID
+   */
+  audioUtteranceId(id: string): this {
+    this.config.audioUtteranceId = id;
+    return this;
+  }
+
+  /**
+   * Set callback URLs
+   */
+  callbackUrls(urls: RecognitionCallbackUrl[]): this {
+    this.config.callbackUrls = urls;
+    return this;
+  }
+
+  /**
+   * Set user ID
+   */
+  userId(id: string): this {
+    this.config.userId = id;
+    return this;
+  }
+
+  /**
+   * Set game session ID
+   */
+  gameSessionId(id: string): this {
+    this.config.gameSessionId = id;
+    return this;
+  }
+
+  /**
+   * Set device ID
+   */
+  deviceId(id: string): this {
+    this.config.deviceId = id;
+    return this;
+  }
+
+  /**
+   * Set account ID
+   */
+  accountId(id: string): this {
+    this.config.accountId = id;
+    return this;
+  }
+
+  /**
+   * Set question answer ID
+   */
+  questionAnswerId(id: string): this {
+    this.config.questionAnswerId = id;
+    return this;
+  }
+
+  /**
+   * Set platform
+   */
+  platform(platform: string): this {
+    this.config.platform = platform;
+    return this;
+  }
+
+  /**
+   * Set transcript callback
+   */
+  onTranscript(callback: (result: TranscriptionResultV1) => void): this {
+    this.config.onTranscript = callback;
+    return this;
+  }
+
+  /**
+   * Set metadata callback
+   */
+  onMetadata(callback: (metadata: MetadataResultV1) => void): this {
+    this.config.onMetadata = callback;
+    return this;
+  }
+
+  /**
+   * Set error callback
+   */
+  onError(callback: (error: ErrorResultV1) => void): this {
+    this.config.onError = callback;
+    return this;
+  }
+
+  /**
+   * Set connected callback
+   */
+  onConnected(callback: () => void): this {
+    this.config.onConnected = callback;
+    return this;
+  }
+
+  /**
+   * Set disconnected callback
+   */
+  onDisconnected(callback: (code: number, reason: string) => void): this {
+    this.config.onDisconnected = callback;
+    return this;
+  }
+
+  /**
+   * Set high water mark
+   */
+  highWaterMark(bytes: number): this {
+    this.config.highWaterMark = bytes;
+    return this;
+  }
+
+  /**
+   * Set low water mark
+   */
+  lowWaterMark(bytes: number): this {
+    this.config.lowWaterMark = bytes;
+    return this;
+  }
+
+  /**
+   * Set max buffer duration in seconds
+   */
+  maxBufferDurationSec(seconds: number): this {
+    this.config.maxBufferDurationSec = seconds;
+    return this;
+  }
+
+  /**
+   * Set chunks per second
+   */
+  chunksPerSecond(chunks: number): this {
+    this.config.chunksPerSecond = chunks;
+    return this;
+  }
+
+  /**
+   * Set logger function
+   */
+  logger(logger: (level: 'debug' | 'info' | 'warn' | 'error', message: string, data?: any) => void): this {
+    this.config.logger = logger;
+    return this;
+  }
+
+  /**
+   * Build the configuration
+   */
+  build(): RealTimeTwoWayWebSocketRecognitionClientConfig {
+    return this.config as RealTimeTwoWayWebSocketRecognitionClientConfig;
+  }
+}

package/src/factory.ts

@@ -0,0 +1,43 @@
+/**
+ * Factory function for creating Recognition Client instances
+ */
+
+import { RealTimeTwoWayWebSocketRecognitionClient } from './recognition-client.js';
+import { ConfigBuilder } from './config-builder.js';
+import type { IRecognitionClient, RealTimeTwoWayWebSocketRecognitionClientConfig } from './recognition-client.types.js';
+
+/**
+ * Create a recognition client from a configuration object
+ *
+ * Example:
+ * ```typescript
+ * const client = createClient({
+ *   url: 'ws://localhost:3101/ws/v1/recognize',
+ *   onTranscript: (result) => console.log(result)
+ * });
+ * ```
+ */
+export function createClient(config: RealTimeTwoWayWebSocketRecognitionClientConfig): IRecognitionClient {
+  return new RealTimeTwoWayWebSocketRecognitionClient(config);
+}
+
+/**
+ * Create a recognition client using the builder pattern
+ *
+ * Example:
+ * ```typescript
+ * const client = createClientWithBuilder((builder) =>
+ *   builder
+ *     .url('ws://localhost:3101/ws/v1/recognize')
+ *     .onTranscript((result) => console.log(result))
+ *     .onError((error) => console.error(error))
+ * );
+ * ```
+ */
+export function createClientWithBuilder(
+  configure: (builder: ConfigBuilder) => ConfigBuilder
+): IRecognitionClient {
+  const builder = new ConfigBuilder();
+  const config = configure(builder).build();
+  return new RealTimeTwoWayWebSocketRecognitionClient(config);
+}

package/src/index.ts

@@ -0,0 +1,86 @@
+// 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 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,
+  RecognitionContextTypeV1,
+  ControlSignalTypeV1,
+  ControlSignalTypeV1 as ControlSignal,  // Alias for backward compatibility
+
+  // Result types
+  type TranscriptionResultV1,
+  type FunctionCallResultV1,
+  type MetadataResultV1,
+  type ErrorResultV1,
+  RecognitionResultTypeV1,
+
+  // ASR configuration types
+  type ASRRequestConfig,
+  type ASRRequestV1,
+  RecognitionProvider,
+  DeepgramModel,
+  GoogleModel,
+  GeminiModel,
+  OpenAIModel,
+  Language,
+  SampleRate
+} 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';