@volley/recognition-client-sdk 0.1.200 → 0.1.210

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@volley/recognition-client-sdk",
-  "version": "0.1.200",
+  "version": "0.1.210",
   "description": "Recognition Service TypeScript/Node.js Client SDK",
   "type": "module",
   "main": "dist/index.js",
@@ -28,14 +28,7 @@
   "sideEffects": false,
   "publishConfig": {
     "access": "public",
-    "provenance": false
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "test": "jest --passWithNoTests",
-    "lint": "eslint src --ext .ts",
-    "prepublishOnly": "pnpm build"
+    "provenance": true
   },
   "dependencies": {
     "uuid": "^11.0.0",
@@ -43,12 +36,9 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@recog/shared-config": "workspace:*",
-    "@recog/shared-types": "workspace:*",
-    "@recog/shared-utils": "workspace:*",
-    "@recog/websocket": "workspace:*",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/exec": "^7.1.0",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^12.0.0",
     "@semantic-release/npm": "^13.1.1",
@@ -62,12 +52,22 @@
     "semantic-release": "^25.0.1",
     "ts-jest": "^29.4.5",
     "tsup": "^8.5.0",
-    "typescript": "^5.1.6"
+    "typescript": "^5.1.6",
+    "@recog/shared-config": "1.0.0",
+    "@recog/shared-types": "1.0.0",
+    "@recog/websocket": "1.0.0",
+    "@recog/shared-utils": "1.0.0"
   },
   "keywords": [
     "recognition",
     "sdk",
     "audio",
     "speech"
-  ]
-}
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "jest --passWithNoTests",
+    "lint": "eslint src --ext .ts"
+  }
+}

package/src/config-builder.spec.ts

@@ -0,0 +1,265 @@
+/**
+ * Unit tests for ConfigBuilder
+ */
+
+import { ConfigBuilder } from './config-builder.js';
+import { RecognitionProvider, RecognitionContextTypeV1 } from '@recog/shared-types';
+
+describe('ConfigBuilder', () => {
+  it('should build empty config', () => {
+    const config = new ConfigBuilder().build();
+    expect(config).toBeDefined();
+  });
+
+  it('should set url', () => {
+    const config = new ConfigBuilder()
+      .url('ws://localhost:3101/ws/v1/recognize')
+      .build();
+    expect(config.url).toBe('ws://localhost:3101/ws/v1/recognize');
+  });
+
+  it('should set asrRequestConfig', () => {
+    const asrConfig = {
+      provider: RecognitionProvider.DEEPGRAM,
+      model: 'nova-2-general',
+      language: 'en-US',
+      sampleRate: 16000,
+      encoding: 'linear16'
+    };
+    const config = new ConfigBuilder()
+      .asrRequestConfig(asrConfig)
+      .build();
+    expect(config.asrRequestConfig).toEqual(asrConfig);
+  });
+
+  it('should set gameContext', () => {
+    const gameContext = {
+      type: RecognitionContextTypeV1.GAME_CONTEXT as const,
+      gameId: 'test-game',
+      gamePhase: 'test-phase'
+    };
+    const config = new ConfigBuilder()
+      .gameContext(gameContext)
+      .build();
+    expect(config.gameContext).toEqual(gameContext);
+  });
+
+  it('should set audioUtteranceId', () => {
+    const config = new ConfigBuilder()
+      .audioUtteranceId('test-utterance-id')
+      .build();
+    expect(config.audioUtteranceId).toBe('test-utterance-id');
+  });
+
+  it('should set callbackUrls', () => {
+    const callbackUrls = [
+      { url: 'https://example.com/callback', event: 'transcript' as const }
+    ];
+    const config = new ConfigBuilder()
+      .callbackUrls(callbackUrls)
+      .build();
+    expect(config.callbackUrls).toEqual(callbackUrls);
+  });
+
+  it('should set userId', () => {
+    const config = new ConfigBuilder()
+      .userId('user-123')
+      .build();
+    expect(config.userId).toBe('user-123');
+  });
+
+  it('should set gameSessionId', () => {
+    const config = new ConfigBuilder()
+      .gameSessionId('session-456')
+      .build();
+    expect(config.gameSessionId).toBe('session-456');
+  });
+
+  it('should set deviceId', () => {
+    const config = new ConfigBuilder()
+      .deviceId('device-789')
+      .build();
+    expect(config.deviceId).toBe('device-789');
+  });
+
+  it('should set accountId', () => {
+    const config = new ConfigBuilder()
+      .accountId('account-abc')
+      .build();
+    expect(config.accountId).toBe('account-abc');
+  });
+
+  it('should set questionAnswerId', () => {
+    const config = new ConfigBuilder()
+      .questionAnswerId('qa-xyz')
+      .build();
+    expect(config.questionAnswerId).toBe('qa-xyz');
+  });
+
+  it('should set platform', () => {
+    const config = new ConfigBuilder()
+      .platform('ios')
+      .build();
+    expect(config.platform).toBe('ios');
+  });
+
+  it('should set onTranscript callback', () => {
+    const callback = jest.fn();
+    const config = new ConfigBuilder()
+      .onTranscript(callback)
+      .build();
+    expect(config.onTranscript).toBe(callback);
+  });
+
+  it('should set onMetadata callback', () => {
+    const callback = jest.fn();
+    const config = new ConfigBuilder()
+      .onMetadata(callback)
+      .build();
+    expect(config.onMetadata).toBe(callback);
+  });
+
+  it('should set onError callback', () => {
+    const callback = jest.fn();
+    const config = new ConfigBuilder()
+      .onError(callback)
+      .build();
+    expect(config.onError).toBe(callback);
+  });
+
+  it('should set onConnected callback', () => {
+    const callback = jest.fn();
+    const config = new ConfigBuilder()
+      .onConnected(callback)
+      .build();
+    expect(config.onConnected).toBe(callback);
+  });
+
+  it('should set onDisconnected callback', () => {
+    const callback = jest.fn();
+    const config = new ConfigBuilder()
+      .onDisconnected(callback)
+      .build();
+    expect(config.onDisconnected).toBe(callback);
+  });
+
+  it('should set highWaterMark', () => {
+    const config = new ConfigBuilder()
+      .highWaterMark(1000)
+      .build();
+    expect(config.highWaterMark).toBe(1000);
+  });
+
+  it('should set lowWaterMark', () => {
+    const config = new ConfigBuilder()
+      .lowWaterMark(500)
+      .build();
+    expect(config.lowWaterMark).toBe(500);
+  });
+
+  it('should set maxBufferDurationSec', () => {
+    const config = new ConfigBuilder()
+      .maxBufferDurationSec(10)
+      .build();
+    expect(config.maxBufferDurationSec).toBe(10);
+  });
+
+  it('should set chunksPerSecond', () => {
+    const config = new ConfigBuilder()
+      .chunksPerSecond(50)
+      .build();
+    expect(config.chunksPerSecond).toBe(50);
+  });
+
+  it('should set logger', () => {
+    const logger = jest.fn();
+    const config = new ConfigBuilder()
+      .logger(logger)
+      .build();
+    expect(config.logger).toBe(logger);
+  });
+
+  it('should support method chaining', () => {
+    const config = new ConfigBuilder()
+      .url('ws://localhost:3101/ws/v1/recognize')
+      .audioUtteranceId('test-id')
+      .userId('user-123')
+      .gameSessionId('session-456')
+      .deviceId('device-789')
+      .platform('ios')
+      .highWaterMark(1000)
+      .lowWaterMark(500)
+      .build();
+
+    expect(config.url).toBe('ws://localhost:3101/ws/v1/recognize');
+    expect(config.audioUtteranceId).toBe('test-id');
+    expect(config.userId).toBe('user-123');
+    expect(config.gameSessionId).toBe('session-456');
+    expect(config.deviceId).toBe('device-789');
+    expect(config.platform).toBe('ios');
+    expect(config.highWaterMark).toBe(1000);
+    expect(config.lowWaterMark).toBe(500);
+  });
+
+  it('should build complete configuration', () => {
+    const onTranscript = jest.fn();
+    const onError = jest.fn();
+    const onConnected = jest.fn();
+    const onDisconnected = jest.fn();
+    const logger = jest.fn();
+
+    const config = new ConfigBuilder()
+      .url('ws://localhost:3101/ws/v1/recognize')
+      .asrRequestConfig({
+        provider: RecognitionProvider.DEEPGRAM,
+        model: 'nova-2-general',
+        language: 'en-US',
+        sampleRate: 16000,
+        encoding: 'linear16'
+      })
+      .gameContext({
+        type: RecognitionContextTypeV1.GAME_CONTEXT as const,
+        gameId: 'test-game',
+        gamePhase: 'test-phase'
+      })
+      .audioUtteranceId('test-utterance-id')
+      .userId('user-123')
+      .gameSessionId('session-456')
+      .deviceId('device-789')
+      .accountId('account-abc')
+      .questionAnswerId('qa-xyz')
+      .platform('ios')
+      .onTranscript(onTranscript)
+      .onError(onError)
+      .onConnected(onConnected)
+      .onDisconnected(onDisconnected)
+      .highWaterMark(1000)
+      .lowWaterMark(500)
+      .maxBufferDurationSec(10)
+      .chunksPerSecond(50)
+      .logger(logger)
+      .build();
+
+    expect(config).toMatchObject({
+      url: 'ws://localhost:3101/ws/v1/recognize',
+      audioUtteranceId: 'test-utterance-id',
+      userId: 'user-123',
+      gameSessionId: 'session-456',
+      deviceId: 'device-789',
+      accountId: 'account-abc',
+      questionAnswerId: 'qa-xyz',
+      platform: 'ios',
+      highWaterMark: 1000,
+      lowWaterMark: 500,
+      maxBufferDurationSec: 10,
+      chunksPerSecond: 50
+    });
+    expect(config.asrRequestConfig?.provider).toBe(RecognitionProvider.DEEPGRAM);
+    expect(config.gameContext?.gameId).toBe('test-game');
+    expect(config.onTranscript).toBe(onTranscript);
+    expect(config.onError).toBe(onError);
+    expect(config.onConnected).toBe(onConnected);
+    expect(config.onDisconnected).toBe(onDisconnected);
+    expect(config.logger).toBe(logger);
+  });
+});

package/src/factory.spec.ts

@@ -0,0 +1,215 @@
+/**
+ * Unit tests for Factory functions
+ */
+
+import { createClient, createClientWithBuilder } from './factory.js';
+import { ConfigBuilder } from './config-builder.js';
+import { RecognitionProvider, RecognitionContextTypeV1 } from '@recog/shared-types';
+
+// Mock the RealTimeTwoWayWebSocketRecognitionClient
+jest.mock('./recognition-client.js', () => ({
+  RealTimeTwoWayWebSocketRecognitionClient: jest.fn().mockImplementation((config) => ({
+    config,
+    connect: jest.fn(),
+    disconnect: jest.fn(),
+    sendAudio: jest.fn(),
+    startRecognition: jest.fn(),
+    stopRecognition: jest.fn()
+  }))
+}));
+
+describe('Factory Functions', () => {
+  describe('createClient', () => {
+    it('should create client with config object', () => {
+      const config = {
+        url: 'ws://localhost:3101/ws/v1/recognize',
+        audioUtteranceId: 'test-id',
+        asrRequestConfig: {
+          provider: RecognitionProvider.DEEPGRAM,
+          model: 'nova-2-general',
+          language: 'en-US',
+          sampleRate: 16000,
+          encoding: 'linear16'
+        }
+      };
+
+      const client = createClient(config);
+      expect(client).toBeDefined();
+      expect(client.connect).toBeDefined();
+      expect(client.sendAudio).toBeDefined();
+    });
+
+    it('should create client with minimal config', () => {
+      const config = {
+        url: 'ws://localhost:3101/ws/v1/recognize',
+        audioUtteranceId: 'test-id'
+      };
+
+      const client = createClient(config);
+      expect(client).toBeDefined();
+    });
+
+    it('should create client with callbacks', () => {
+      const onTranscript = jest.fn();
+      const onError = jest.fn();
+      const onConnected = jest.fn();
+
+      const config = {
+        url: 'ws://localhost:3101/ws/v1/recognize',
+        audioUtteranceId: 'test-id',
+        onTranscript,
+        onError,
+        onConnected
+      };
+
+      const client = createClient(config);
+      expect(client).toBeDefined();
+    });
+  });
+
+  describe('createClientWithBuilder', () => {
+    it('should create client using builder pattern', () => {
+      const client = createClientWithBuilder((builder) =>
+        builder
+          .url('ws://localhost:3101/ws/v1/recognize')
+          .audioUtteranceId('test-id')
+      );
+
+      expect(client).toBeDefined();
+      expect(client.connect).toBeDefined();
+    });
+
+    it('should create client with multiple builder methods', () => {
+      const onTranscript = jest.fn();
+      const onError = jest.fn();
+
+      const client = createClientWithBuilder((builder) =>
+        builder
+          .url('ws://localhost:3101/ws/v1/recognize')
+          .audioUtteranceId('test-id')
+          .userId('user-123')
+          .gameSessionId('session-456')
+          .onTranscript(onTranscript)
+          .onError(onError)
+      );
+
+      expect(client).toBeDefined();
+    });
+
+    it('should create client with ASR config via builder', () => {
+      const client = createClientWithBuilder((builder) =>
+        builder
+          .url('ws://localhost:3101/ws/v1/recognize')
+          .audioUtteranceId('test-id')
+          .asrRequestConfig({
+            provider: RecognitionProvider.DEEPGRAM,
+            model: 'nova-2-general',
+            language: 'en-US',
+            sampleRate: 16000,
+            encoding: 'linear16'
+          })
+      );
+
+      expect(client).toBeDefined();
+    });
+
+    it('should create client with game context via builder', () => {
+      const client = createClientWithBuilder((builder) =>
+        builder
+          .url('ws://localhost:3101/ws/v1/recognize')
+          .audioUtteranceId('test-id')
+          .gameContext({
+            type: RecognitionContextTypeV1.GAME_CONTEXT as const,
+            gameId: 'test-game',
+            gamePhase: 'test-phase'
+          })
+      );
+
+      expect(client).toBeDefined();
+    });
+
+    it('should create client with all optional fields via builder', () => {
+      const onTranscript = jest.fn();
+      const onMetadata = jest.fn();
+      const onError = jest.fn();
+      const onConnected = jest.fn();
+      const onDisconnected = jest.fn();
+      const logger = jest.fn();
+
+      const client = createClientWithBuilder((builder) =>
+        builder
+          .url('ws://localhost:3101/ws/v1/recognize')
+          .audioUtteranceId('test-id')
+          .userId('user-123')
+          .gameSessionId('session-456')
+          .deviceId('device-789')
+          .accountId('account-abc')
+          .questionAnswerId('qa-xyz')
+          .platform('ios')
+          .asrRequestConfig({
+            provider: RecognitionProvider.DEEPGRAM,
+            model: 'nova-2-general',
+            language: 'en-US',
+            sampleRate: 16000,
+            encoding: 'linear16'
+          })
+          .gameContext({
+            type: RecognitionContextTypeV1.GAME_CONTEXT as const,
+            gameId: 'test-game',
+            gamePhase: 'test-phase'
+          })
+          .onTranscript(onTranscript)
+          .onMetadata(onMetadata)
+          .onError(onError)
+          .onConnected(onConnected)
+          .onDisconnected(onDisconnected)
+          .highWaterMark(1000)
+          .lowWaterMark(500)
+          .maxBufferDurationSec(10)
+          .chunksPerSecond(50)
+          .logger(logger)
+      );
+
+      expect(client).toBeDefined();
+    });
+
+    it('should accept builder as parameter', () => {
+      const builder = new ConfigBuilder();
+      const client = createClientWithBuilder((b) => b.url('ws://localhost:3101').audioUtteranceId('test-id'));
+      expect(client).toBeDefined();
+    });
+  });
+
+  describe('Factory Function Equivalence', () => {
+    it('should produce equivalent clients from config and builder', () => {
+      const config = {
+        url: 'ws://localhost:3101/ws/v1/recognize',
+        audioUtteranceId: 'test-id',
+        userId: 'user-123'
+      };
+
+      const clientFromConfig = createClient(config);
+      const clientFromBuilder = createClientWithBuilder((builder) =>
+        builder
+          .url('ws://localhost:3101/ws/v1/recognize')
+          .audioUtteranceId('test-id')
+          .userId('user-123')
+      );
+
+      expect(clientFromConfig).toBeDefined();
+      expect(clientFromBuilder).toBeDefined();
+    });
+
+    it('should handle empty config gracefully', () => {
+      const config = {
+        url: 'ws://localhost:3101/ws/v1/recognize',
+        audioUtteranceId: 'test-id'
+      };
+
+      const client = createClient(config);
+      expect(client).toBeDefined();
+      expect(typeof client.connect).toBe('function');
+    });
+
+  });
+});

package/src/factory.ts

@@ -13,9 +13,13 @@ import type { IRecognitionClient, RealTimeTwoWayWebSocketRecognitionClientConfig
  * ```typescript
  * const client = createClient({
  *   url: 'ws://localhost:3101/ws/v1/recognize',
+ *   audioUtteranceId: 'unique-id',
  *   onTranscript: (result) => console.log(result)
  * });
  * ```
+ *
+ * @param config - Client configuration
+ * @returns Configured recognition client instance
  */
 export function createClient(config: RealTimeTwoWayWebSocketRecognitionClientConfig): IRecognitionClient {
   return new RealTimeTwoWayWebSocketRecognitionClient(config);