@webex/contact-center 3.12.0-next.8 → 3.12.0-next.81

package/test/unit/spec/services/ApiAiAssistant.ts

@@ -1,6 +1,7 @@
 import ApiAIAssistant from '../../../../src/services/ApiAiAssistant';
 import MetricsManager from '../../../../src/metrics/MetricsManager';
 import LoggerProxy from '../../../../src/logger-proxy';
+import WebexRequest from '../../../../src/services/core/WebexRequest';
 import {HTTP_METHODS, WebexSDK} from '../../../../src/types';
 
 jest.mock('../../../../src/metrics/MetricsManager');
@@ -13,6 +14,9 @@ describe('ApiAIAssistant', () => {
 
   beforeEach(() => {
     jest.clearAllMocks();
+    jest.spyOn(WebexRequest, 'getInstance').mockReturnValue({
+      uploadLogs: jest.fn(),
+    } as any);
 
     mockWebex = {
       credentials: {
@@ -53,23 +57,18 @@ describe('ApiAIAssistant', () => {
       'START'
     );
 
-    expect(mockWebex.request).toHaveBeenCalledWith({
-      uri: 'https://api-ai-assistant.produs1.ciscoccservice.com/event',
-      method: HTTP_METHODS.POST,
-      addAuthHeader: true,
-      body: {
-        agentId: 'test-agent-id',
-        orgId: 'test-org-id',
-        eventType: 'CUSTOM_EVENT',
-        eventName: 'GET_TRANSCRIPTS',
-        eventDetails: {
-          data: expect.objectContaining({
-            interactionId: 'interaction-1',
-            action: 'START',
-          }),
-        },
-      },
-    });
+    expect(mockWebex.request).toHaveBeenCalledTimes(1);
+    const requestArgs = (mockWebex.request as jest.Mock).mock.calls[0][0];
+
+    expect(requestArgs.uri).toBe('https://api-ai-assistant.produs1.ciscoccservice.com/event');
+    expect(requestArgs.method).toBe(HTTP_METHODS.POST);
+    expect(requestArgs.addAuthHeader).toBe(true);
+    expect(requestArgs.body.agentId).toBe('test-agent-id');
+    expect(requestArgs.body.orgId).toBe('test-org-id');
+    expect(requestArgs.body.eventType).toBe('CUSTOM_EVENT');
+    expect(requestArgs.body.eventName).toBe('GET_TRANSCRIPTS');
+    expect(requestArgs.body.eventDetails.data.interactionId).toBe('interaction-1');
+    expect(requestArgs.body.eventDetails.data.action).toBe('START');
     expect(result).toEqual({ok: true});
   });
 
@@ -93,6 +92,83 @@ describe('ApiAIAssistant', () => {
     expect(result).toEqual(responseBody as any);
   });
 
+  it('should request suggested response without extra context using sendEvent', async () => {
+    const sendEventSpy = jest.spyOn(apiAIAssistant, 'sendEvent').mockResolvedValue({ok: true});
+    apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: true}} as any);
+
+    const result = await apiAIAssistant.getSuggestedResponse({
+      agentId: 'test-agent-id',
+      interactionId: 'interaction-1',
+    });
+
+    expect(sendEventSpy).toHaveBeenCalledTimes(1);
+    const [agentId, interactionId, eventType, eventName, action, context, languageCode, trackingId] =
+      sendEventSpy.mock.calls[0];
+
+    expect(agentId).toBe('test-agent-id');
+    expect(interactionId).toBe('interaction-1');
+    expect(eventType).toBe('CUSTOM_EVENT');
+    expect(eventName).toBe('GET_SUGGESTIONS');
+    expect(action).toBeUndefined();
+    expect(context).toBeUndefined();
+    expect(languageCode).toBe('en');
+    expect(typeof trackingId).toBe('string');
+    expect(trackingId.startsWith('WX_CC_SDK_')).toBe(true);
+    expect(result).toEqual({ok: true});
+  });
+
+  it('should request suggested response with extra context using sendEvent', async () => {
+    const sendEventSpy = jest.spyOn(apiAIAssistant, 'sendEvent').mockResolvedValue({ok: true});
+    apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: true}} as any);
+
+    const result = await apiAIAssistant.getSuggestedResponse({
+      agentId: 'test-agent-id',
+      interactionId: 'interaction-1',
+      context: 'Need assistance with credit card payment due date',
+    });
+
+    expect(sendEventSpy).toHaveBeenCalledTimes(1);
+    const [agentId, interactionId, eventType, eventName, action, context, languageCode, trackingId] =
+      sendEventSpy.mock.calls[0];
+
+    expect(agentId).toBe('test-agent-id');
+    expect(interactionId).toBe('interaction-1');
+    expect(eventType).toBe('CUSTOM_EVENT');
+    expect(eventName).toBe('ADD_SUGGESTIONS_EXTRA_CONTEXT');
+    expect(action).toBeUndefined();
+    expect(context).toBe('Need assistance with credit card payment due date');
+    expect(languageCode).toBe('en');
+    expect(typeof trackingId).toBe('string');
+    expect(trackingId.startsWith('WX_CC_SDK_')).toBe(true);
+    expect(result).toEqual({ok: true});
+  });
+
+  it('should treat whitespace-only context as GET_SUGGESTIONS', async () => {
+    const sendEventSpy = jest.spyOn(apiAIAssistant, 'sendEvent').mockResolvedValue({ok: true});
+    apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: true}} as any);
+
+    const result = await apiAIAssistant.getSuggestedResponse({
+      agentId: 'test-agent-id',
+      interactionId: 'interaction-1',
+      context: '   ',
+    });
+
+    expect(sendEventSpy).toHaveBeenCalledTimes(1);
+    const [agentId, interactionId, eventType, eventName, action, context, languageCode, trackingId] =
+      sendEventSpy.mock.calls[0];
+
+    expect(agentId).toBe('test-agent-id');
+    expect(interactionId).toBe('interaction-1');
+    expect(eventType).toBe('CUSTOM_EVENT');
+    expect(eventName).toBe('GET_SUGGESTIONS');
+    expect(action).toBeUndefined();
+    expect(context).toBe('');
+    expect(languageCode).toBe('en');
+    expect(typeof trackingId).toBe('string');
+    expect(trackingId.startsWith('WX_CC_SDK_')).toBe(true);
+    expect(result).toEqual({ok: true});
+  });
+
   it('should fail when base URL mapping is not available', async () => {
     (mockWebex.internal.services.get as jest.Mock).mockReturnValue('https://unknown-host.invalid');
 
@@ -112,4 +188,33 @@ describe('ApiAIAssistant', () => {
     expect(failed).toBe(true);
     expect(LoggerProxy.error).toHaveBeenCalled();
   });
+
+  it('should fail when realtime transcripts feature is disabled', async () => {
+    apiAIAssistant.setAIFeatureFlags({realtimeTranscripts: {enable: false}} as any);
+    let errorMessage = '';
+
+    try {
+      await apiAIAssistant.fetchHistoricTranscripts('test-agent-id', 'interaction-1');
+    } catch (error) {
+      errorMessage = (error as Error)?.message || '';
+    }
+
+    expect(errorMessage).toBe('Error while performing fetchHistoricTranscripts');
+  });
+
+  it('should fail when suggested responses feature is disabled', async () => {
+    apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: false}} as any);
+    let errorMessage = '';
+
+    try {
+      await apiAIAssistant.getSuggestedResponse({
+        agentId: 'test-agent-id',
+        interactionId: 'interaction-1',
+      });
+    } catch (error) {
+      errorMessage = (error as Error)?.message || '';
+    }
+
+    expect(errorMessage).toBe('Error while performing getSuggestedResponse');
+  });
 });

package/test/unit/spec/services/UserPreference.ts

@@ -0,0 +1,401 @@
+import {expect} from '@jest/globals';
+import UserPreference from '../../../../src/services/UserPreference';
+import {HTTP_METHODS, WebexSDK, IHttpResponse} from '../../../../src/types';
+import {METRIC_EVENT_NAMES} from '../../../../src/metrics/constants';
+import WebexRequest from '../../../../src/services/core/WebexRequest';
+import MetricsManager from '../../../../src/metrics/MetricsManager';
+import LoggerProxy from '../../../../src/logger-proxy';
+
+jest.mock('../../../../src/metrics/MetricsManager');
+jest.mock('../../../../src/logger-proxy');
+
+describe('UserPreference', () => {
+  let userPreferenceAPI: UserPreference;
+  let mockWebex: WebexSDK;
+  let mockMetricsManager: jest.Mocked<MetricsManager>;
+
+  const mockGetUserId = jest.fn().mockReturnValue('test-user-id');
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    (WebexRequest as any).instance = undefined;
+
+    mockWebex = {
+      credentials: {
+        getOrgId: jest.fn().mockReturnValue('test-org-id'),
+      },
+      request: jest.fn(),
+      internal: {
+        newMetrics: {
+          submitBehavioralEvent: jest.fn(),
+          submitOperationalEvent: jest.fn(),
+          submitBusinessEvent: jest.fn(),
+        },
+      },
+      ready: true,
+      once: jest.fn(),
+    } as unknown as WebexSDK;
+
+    mockMetricsManager = {
+      trackEvent: jest.fn(),
+      timeEvent: jest.fn(),
+    } as unknown as jest.Mocked<MetricsManager>;
+    (MetricsManager.getInstance as jest.Mock).mockReturnValue(mockMetricsManager);
+
+    userPreferenceAPI = new UserPreference(mockWebex, mockGetUserId);
+  });
+
+  describe('constructor', () => {
+    it('should initialize with all required dependencies', () => {
+      expect(WebexRequest.getInstance({webex: mockWebex})).toBeDefined();
+      expect(MetricsManager.getInstance).toHaveBeenCalledWith({webex: mockWebex});
+    });
+  });
+
+  describe('getUserPreference', () => {
+    const mockPreference = {
+      id: 'pref-123',
+      organizationId: 'test-org-id',
+      userId: 'test-user-id',
+      preferences: {e911Reminder: true},
+      createdTime: 1234567890,
+      lastUpdatedTime: 1234567890,
+    };
+
+    const mockResponse: IHttpResponse = {
+      statusCode: 200,
+      method: 'GET',
+      url: '/organization/test-org-id/user-preference/test-user-id',
+      headers: {} as any,
+      body: mockPreference,
+    };
+
+    beforeEach(() => {
+      jest.spyOn(Date, 'now').mockReturnValue(1000);
+    });
+
+    afterEach(() => {
+      jest.restoreAllMocks();
+    });
+
+    it('should fetch user preferences successfully with default userId', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      const result = await userPreferenceAPI.getUserPreference();
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference/test-user-id',
+        method: HTTP_METHODS.GET,
+        body: undefined,
+      });
+      expect(result).toEqual(mockPreference);
+      expect(mockMetricsManager.timeEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_GET_SUCCESS
+      );
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_GET_SUCCESS,
+        expect.objectContaining({
+          orgId: 'test-org-id',
+          userId: 'test-user-id',
+          statusCode: 200,
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+
+    it('should fetch user preferences for a specific userId', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      const result = await userPreferenceAPI.getUserPreference({userId: 'specific-user-id'});
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference/specific-user-id',
+        method: HTTP_METHODS.GET,
+        body: undefined,
+      });
+      expect(result).toEqual(mockPreference);
+    });
+
+    it('should fetch user preferences with pagination parameters', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      const result = await userPreferenceAPI.getUserPreference({page: 1, pageSize: 50});
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference/test-user-id?page=1&pageSize=50',
+        method: HTTP_METHODS.GET,
+        body: undefined,
+      });
+      expect(result).toEqual(mockPreference);
+    });
+
+    it('should throw error when userId is not available', async () => {
+      mockGetUserId.mockReturnValueOnce('');
+
+      await expect(userPreferenceAPI.getUserPreference()).rejects.toThrow(
+        'UserPreference: userId is not available.'
+      );
+
+      expect(mockMetricsManager.trackEvent).not.toHaveBeenCalled();
+    });
+
+    it('should handle API errors', async () => {
+      const mockError = new Error('API call failed');
+      (mockWebex.request as jest.Mock).mockRejectedValue(mockError);
+
+      await expect(userPreferenceAPI.getUserPreference()).rejects.toThrow('API call failed');
+
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_GET_FAILED,
+        expect.objectContaining({
+          error: 'API call failed',
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+  });
+
+  describe('createUserPreference', () => {
+    const mockCreateRequest = {
+      userId: 'test-user-id',
+      desktopPreference: '{}',
+    };
+
+    const mockCreatedPreference = {
+      id: 'pref-123',
+      organizationId: 'test-org-id',
+      userId: 'test-user-id',
+      preferences: {e911Reminder: true},
+      createdTime: 1234567890,
+      lastUpdatedTime: 1234567890,
+    };
+
+    const mockResponse: IHttpResponse = {
+      statusCode: 201,
+      method: 'POST',
+      url: '/organization/test-org-id/user-preference',
+      headers: {} as any,
+      body: mockCreatedPreference,
+    };
+
+    beforeEach(() => {
+      jest.spyOn(Date, 'now').mockReturnValue(1000);
+    });
+
+    afterEach(() => {
+      jest.restoreAllMocks();
+    });
+
+    it('should create user preferences successfully', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      const result = await userPreferenceAPI.createUserPreference(mockCreateRequest);
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference',
+        method: HTTP_METHODS.POST,
+        body: mockCreateRequest,
+      });
+      expect(result).toEqual(mockCreatedPreference);
+      expect(mockMetricsManager.timeEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_CREATE_SUCCESS
+      );
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_CREATE_SUCCESS,
+        expect.objectContaining({
+          orgId: 'test-org-id',
+          userId: 'test-user-id',
+          statusCode: 201,
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+
+    it('should throw error when userId is missing in request', async () => {
+      const invalidRequest = {
+        userId: '',
+        desktopPreference: '{}',
+      };
+
+      await expect(userPreferenceAPI.createUserPreference(invalidRequest)).rejects.toThrow(
+        'UserPreference: userId is required to create user preferences.'
+      );
+
+      expect(mockMetricsManager.trackEvent).not.toHaveBeenCalled();
+    });
+
+    it('should handle API errors', async () => {
+      const mockError = new Error('API call failed');
+      (mockWebex.request as jest.Mock).mockRejectedValue(mockError);
+
+      await expect(userPreferenceAPI.createUserPreference(mockCreateRequest)).rejects.toThrow(
+        'API call failed'
+      );
+
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_CREATE_FAILED,
+        expect.objectContaining({
+          error: 'API call failed',
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+  });
+
+  describe('updateUserPreference', () => {
+    const mockUpdateRequest = {
+      desktopPreference: '{}',
+    };
+
+    const mockUpdatedPreference = {
+      id: 'pref-123',
+      organizationId: 'test-org-id',
+      userId: 'test-user-id',
+      preferences: {e911Reminder: false},
+      createdTime: 1234567890,
+      lastUpdatedTime: 1234567899,
+    };
+
+    const mockResponse: IHttpResponse = {
+      statusCode: 200,
+      method: 'PUT',
+      url: '/organization/test-org-id/user-preference/test-user-id',
+      headers: {} as any,
+      body: mockUpdatedPreference,
+    };
+
+    beforeEach(() => {
+      jest.spyOn(Date, 'now').mockReturnValue(1000);
+    });
+
+    afterEach(() => {
+      jest.restoreAllMocks();
+    });
+
+    it('should update user preferences successfully', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      const result = await userPreferenceAPI.updateUserPreference(
+        'test-user-id',
+        mockUpdateRequest
+      );
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference/test-user-id',
+        method: HTTP_METHODS.PUT,
+        body: mockUpdateRequest,
+      });
+      expect(result).toEqual(mockUpdatedPreference);
+      expect(mockMetricsManager.timeEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_UPDATE_SUCCESS
+      );
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_UPDATE_SUCCESS,
+        expect.objectContaining({
+          orgId: 'test-org-id',
+          userId: 'test-user-id',
+          statusCode: 200,
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+
+    it('should throw error when userId is missing', async () => {
+      await expect(userPreferenceAPI.updateUserPreference('', mockUpdateRequest)).rejects.toThrow(
+        'UserPreference: userId is required to update user preferences.'
+      );
+
+      expect(mockMetricsManager.trackEvent).not.toHaveBeenCalled();
+    });
+
+    it('should handle API errors', async () => {
+      const mockError = new Error('API call failed');
+      (mockWebex.request as jest.Mock).mockRejectedValue(mockError);
+
+      await expect(
+        userPreferenceAPI.updateUserPreference('test-user-id', mockUpdateRequest)
+      ).rejects.toThrow('API call failed');
+
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_UPDATE_FAILED,
+        expect.objectContaining({
+          error: 'API call failed',
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+  });
+
+  describe('deleteUserPreference', () => {
+    const mockResponse: IHttpResponse = {
+      statusCode: 204,
+      method: 'DELETE',
+      url: '/organization/test-org-id/user-preference/test-user-id',
+      headers: {} as any,
+      body: null,
+    };
+
+    beforeEach(() => {
+      jest.spyOn(Date, 'now').mockReturnValue(1000);
+    });
+
+    afterEach(() => {
+      jest.restoreAllMocks();
+    });
+
+    it('should delete user preferences successfully', async () => {
+      (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
+
+      await userPreferenceAPI.deleteUserPreference('test-user-id');
+
+      expect(mockWebex.request).toHaveBeenCalledWith({
+        service: 'wcc-api-gateway',
+        resource: 'organization/test-org-id/user-preference/test-user-id',
+        method: HTTP_METHODS.DELETE,
+        body: undefined,
+      });
+      expect(mockMetricsManager.timeEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_DELETE_SUCCESS
+      );
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_DELETE_SUCCESS,
+        expect.objectContaining({
+          orgId: 'test-org-id',
+          userId: 'test-user-id',
+          statusCode: 204,
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+
+    it('should throw error when userId is missing', async () => {
+      await expect(userPreferenceAPI.deleteUserPreference('')).rejects.toThrow(
+        'UserPreference: userId is required to delete user preferences.'
+      );
+
+      expect(mockMetricsManager.trackEvent).not.toHaveBeenCalled();
+    });
+
+    it('should handle API errors', async () => {
+      const mockError = new Error('API call failed');
+      (mockWebex.request as jest.Mock).mockRejectedValue(mockError);
+
+      await expect(userPreferenceAPI.deleteUserPreference('test-user-id')).rejects.toThrow(
+        'API call failed'
+      );
+
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.USER_PREFERENCE_DELETE_FAILED,
+        expect.objectContaining({
+          error: 'API call failed',
+        }),
+        ['behavioral', 'operational']
+      );
+    });
+  });
+});

package/test/unit/spec/services/WebCallingService.ts

@@ -200,11 +200,17 @@ describe('WebCallingService', () => {
 
     it('should reject if registration times out', async () => {
       line = callingClient.getLines().line1 as ILine;
+      jest.spyOn(global, 'setTimeout').mockImplementation(((handler: TimerHandler) => {
+        if (typeof handler === 'function') {
+          handler();
+        }
+        return 0 as unknown as NodeJS.Timeout;
+      }) as typeof setTimeout);
 
       const promise = webRTCCalling.registerWebCallingLine();
 
       await expect(promise).rejects.toThrow('WebCallingService Registration timed out');
-    }, 20003); // Increased timeout to 20 seconds
+    });
 
     it('should handle incoming calls', async () => {
       line = callingClient.getLines().line1 as ILine;