@volley/recognition-client-sdk 0.1.211 → 0.1.255

package/src/utils/url-builder.spec.ts

@@ -3,13 +3,12 @@
  */
 
 import { buildWebSocketUrl, UrlBuilderConfig } from './url-builder.js';
-import { RecognitionContextTypeV1 } from '@recog/shared-types';
+import { RecognitionContextTypeV1, STAGES } from '@recog/shared-types';
 
 // Mock the shared-config module
+const mockGetRecognitionServiceBase = jest.fn();
 jest.mock('@recog/shared-config', () => ({
-  getRecognitionServiceBase: jest.fn().mockReturnValue({
-    wsBase: 'wss://recognition.volley.com'
-  })
+  getRecognitionServiceBase: mockGetRecognitionServiceBase
 }));
 
 describe('buildWebSocketUrl', () => {
@@ -17,23 +16,71 @@ describe('buildWebSocketUrl', () => {
     audioUtteranceId: 'test-utterance-123'
   };
 
+  beforeEach(() => {
+    // Reset mock before each test
+    mockGetRecognitionServiceBase.mockReturnValue({
+      wsBase: 'wss://recognition.volley.com'
+    });
+  });
+
   it('should build URL with only audioUtteranceId', () => {
     const url = buildWebSocketUrl(baseConfig);
     expect(url).toContain('audioUtteranceId=test-utterance-123');
   });
 
-  it('should use default URL if not provided', () => {
+  it('should use default production URL if neither url nor stage provided', () => {
     const url = buildWebSocketUrl(baseConfig);
     expect(url).toContain('wss://recognition.volley.com/ws/v1/recognize');
+    expect(mockGetRecognitionServiceBase).toHaveBeenCalledWith('production');
+  });
+
+  it('should use stage parameter to build URL', () => {
+    mockGetRecognitionServiceBase.mockReturnValue({
+      wsBase: 'wss://recognition-staging.volley.com'
+    });
+    const config = {
+      ...baseConfig,
+      stage: 'staging'
+    };
+    const url = buildWebSocketUrl(config);
+    expect(url).toContain('wss://recognition-staging.volley.com/ws/v1/recognize');
+    expect(mockGetRecognitionServiceBase).toHaveBeenCalledWith('staging');
+  });
+
+  it('should accept Stage enum as stage parameter', () => {
+    mockGetRecognitionServiceBase.mockReturnValue({
+      wsBase: 'wss://recognition-dev.volley.com'
+    });
+    const config = {
+      ...baseConfig,
+      stage: STAGES.DEV
+    };
+    const url = buildWebSocketUrl(config);
+    expect(url).toContain('wss://recognition-dev.volley.com/ws/v1/recognize');
+    expect(mockGetRecognitionServiceBase).toHaveBeenCalledWith(STAGES.DEV);
+  });
+
+  it('should prioritize url over stage when both provided', () => {
+    const config = {
+      ...baseConfig,
+      url: 'ws://localhost:3101/ws/v1/recognize',
+      stage: 'staging'
+    };
+    const url = buildWebSocketUrl(config);
+    expect(url).toContain('ws://localhost:3101/ws/v1/recognize');
+    // Mock should not be called when explicit URL is provided
+    expect(mockGetRecognitionServiceBase).not.toHaveBeenCalled();
   });
 
-  it('should use custom URL if provided', () => {
+  it('should use custom URL if provided (backward compatibility)', () => {
     const config = {
       ...baseConfig,
       url: 'ws://localhost:3101/ws/v1/recognize'
     };
     const url = buildWebSocketUrl(config);
     expect(url).toContain('ws://localhost:3101/ws/v1/recognize');
+    // Mock should not be called when explicit URL is provided
+    expect(mockGetRecognitionServiceBase).not.toHaveBeenCalled();
   });
 
   it('should add userId to query parameters', () => {

package/src/utils/url-builder.ts

@@ -4,11 +4,12 @@
  */
 
 import { getRecognitionServiceBase } from '@recog/shared-config';
-import type { GameContextV1 } from '@recog/shared-types';
+import type { GameContextV1, Stage } from '@recog/shared-types';
 import type { RecognitionCallbackUrl } from '../recognition-client.types.js';
 
 export interface UrlBuilderConfig {
   url?: string;
+  stage?: Stage | string;
   audioUtteranceId: string;
   callbackUrls?: RecognitionCallbackUrl[];
   userId?: string;
@@ -22,11 +23,25 @@ export interface UrlBuilderConfig {
 
 /**
  * Build WebSocket URL with all query parameters
+ * Either `url` or `stage` must be provided (or defaults to production if neither provided)
+ * If both are provided, `url` takes precedence over `stage`
  */
 export function buildWebSocketUrl(config: UrlBuilderConfig): string {
-  // Use default URL if not provided (production recognition service)
-  const defaultBase = getRecognitionServiceBase('production');
-  const baseUrl = config.url || `${defaultBase.wsBase}/ws/v1/recognize`;
+  // Determine base URL based on precedence: url > stage > default production
+  let baseUrl: string;
+
+  if (config.url) {
+    // Explicit URL takes precedence
+    baseUrl = config.url;
+  } else if (config.stage) {
+    // Use stage to build URL
+    const stageBase = getRecognitionServiceBase(config.stage);
+    baseUrl = `${stageBase.wsBase}/ws/v1/recognize`;
+  } else {
+    // Default to production if neither provided
+    const defaultBase = getRecognitionServiceBase('production');
+    baseUrl = `${defaultBase.wsBase}/ws/v1/recognize`;
+  }
 
   // Build URL - add all optional identification parameters
   const url = new URL(baseUrl);