@webex/contact-center 3.12.0-next.7 → 3.12.0-next.70

package/dist/cc.js

@@ -301,6 +301,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
     this.$webex.once(_constants.READY, () => {
       // @ts-ignore
       this.$config = this.config;
+      this.validatePluginConfig();
 
       /**
        * This is used for handling the async requests by sending webex.request and wait for corresponding websocket event.
@@ -312,7 +313,6 @@ class ContactCenter extends _webexCore.WebexPlugin {
         webex: this.$webex,
         connectionConfig: this.getConnectionConfig()
       });
-      this.services.webSocketManager.on('message', this.handleWebsocketMessage);
       this.webCallingService = new _WebCallingService.default(this.$webex);
       this.apiAIAssistant = new _ApiAiAssistant.ApiAIAssistant(this.$webex);
       this.metricsManager = _MetricsManager.default.getInstance({
@@ -369,6 +369,16 @@ class ContactCenter extends _webexCore.WebexPlugin {
     // @ts-ignore
     this.trigger(_types4.TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, task);
   };
+
+  /**
+   * Handles multi-login hydrate events emitted when browser login accepts an incoming call.
+   * @private
+   * @param {ITask} task The task object associated with multi-login hydrate
+   */
+  handleTaskMultiLoginHydrate = task => {
+    // @ts-ignore
+    this.trigger(_types4.TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, task);
+  };
   handleRTDWebsocketMessage = payload => {
     this.taskManager.handleRealtimeWebsocketEvent(payload);
   };
@@ -382,6 +392,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
     this.taskManager.on(_types4.TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
     this.taskManager.on(_types4.TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
     this.taskManager.on(_types4.TASK_EVENTS.TASK_MERGED, this.handleTaskMerged);
+    this.taskManager.on(_types4.TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, this.handleTaskMultiLoginHydrate);
     this.taskManager.on(_types4.TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, this.handleCampaignPreviewReservation);
   }
 
@@ -422,13 +433,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
    * ```
    */
   async register() {
-    _loggerProxy.default.info('Starting CC SDK registration', {
+    _loggerProxy.default.log('Starting CC SDK registration', {
       module: _constants.CC_FILE,
       method: _constants.METHODS.REGISTER
     });
     try {
       this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_SUCCESS, _constants4.METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_FAILED]);
       this.setupEventListeners();
+      this.services.webSocketManager.on('message', this.handleWebsocketMessage);
       const resp = await this.connectWebsocket();
       // Ensure 'dn' is always populated from 'defaultDn'
       resp.dn = resp.defaultDn;
@@ -491,6 +503,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
       this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WEBSOCKET_DEREGISTER_SUCCESS, _constants4.METRIC_EVENT_NAMES.WEBSOCKET_DEREGISTER_FAIL]);
       this.taskManager.off(_types4.TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
       this.taskManager.off(_types4.TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
+      this.taskManager.off(_types4.TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, this.handleTaskMultiLoginHydrate);
       this.taskManager.off(_types4.TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, this.handleCampaignPreviewReservation);
       this.taskManager.unregisterIncomingCallEvent();
       this.services.webSocketManager.off('message', this.handleWebsocketMessage);
@@ -609,6 +622,25 @@ class ContactCenter extends _webexCore.WebexPlugin {
     }
   }
 
+  /**
+   * Checks whether WebRTC registration should be skipped by config.
+   * @returns {boolean}
+   * @private
+   */
+  isWebRTCRegistrationDisabled() {
+    return this.$config?.disableWebRTCRegistration === true;
+  }
+
+  /**
+   * Validates contact-center plugin configuration before service initialization
+   * @private
+   */
+  validatePluginConfig() {
+    if (this.$config?.disableWebRTCRegistration === true && this.$config?.allowMultiLogin === false) {
+      throw new Error('Invalid Contact Center configuration: disableWebRTCRegistration cannot be true when allowMultiLogin is false. Enable allowMultiLogin or allow WebRTC registration so an SDK instance can receive Mobius/WebRTC task events.');
+    }
+  }
+
   /**
    * Connects to the websocket and fetches the agent profile
    * @returns {Promise<Profile>} Agent profile information
@@ -616,7 +648,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
    * @private
    */
   async connectWebsocket() {
-    _loggerProxy.default.info('Connecting to websocket', {
+    _loggerProxy.default.log('Connecting to websocket', {
       module: _constants.CC_FILE,
       method: _constants.METHODS.CONNECT_WEBSOCKET
     });
@@ -639,7 +671,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
       this.taskManager.setWebRtcEnabled(this.agentConfig.webRtcEnabled);
       this.apiAIAssistant.setAIFeatureFlags(this.agentConfig.aiFeature);
       if (this.agentConfig.aiFeature?.realtimeTranscripts?.enable) {
-        _loggerProxy.default.info('Connecting to RTD websocket', {
+        _loggerProxy.default.log('Connecting to RTD websocket', {
           module: _constants.CC_FILE,
           method: _constants.METHODS.CONNECT_WEBSOCKET
         });
@@ -659,7 +691,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
           });
         });
       }
-      if (this.agentConfig.webRtcEnabled && this.agentConfig.loginVoiceOptions.includes(_types.LoginOption.BROWSER)) {
+      if (this.agentConfig.webRtcEnabled && this.agentConfig.loginVoiceOptions.includes(_types.LoginOption.BROWSER) && !this.isWebRTCRegistrationDisabled()) {
         try {
           await this.$webex.internal.mercury.connect();
           _loggerProxy.default.log('Authentication: webex.internal.mercury.connect successful', {
@@ -672,9 +704,19 @@ class ContactCenter extends _webexCore.WebexPlugin {
             method: _constants.METHODS.CONNECT_WEBSOCKET
           });
         }
+      } else if (this.isWebRTCRegistrationDisabled()) {
+        _loggerProxy.default.info('Skipping Mobius registration because disableWebRTCRegistration is enabled', {
+          module: _constants.CC_FILE,
+          method: _constants.METHODS.CONNECT_WEBSOCKET
+        });
       }
       if (this.$config && this.$config.allowAutomatedRelogin) {
         await this.silentRelogin();
+      } else {
+        _loggerProxy.default.log('Skipping silent relogin: allowAutomatedRelogin is disabled', {
+          module: _constants.CC_FILE,
+          method: _constants.METHODS.CONNECT_WEBSOCKET
+        });
       }
       return this.agentConfig;
     } catch (error) {
@@ -715,22 +757,27 @@ class ContactCenter extends _webexCore.WebexPlugin {
    * ```
    */
   async stationLogin(data) {
-    _loggerProxy.default.info('Starting agent station login', {
+    const loggerContext = {
       module: _constants.CC_FILE,
       method: _constants.METHODS.STATION_LOGIN
-    });
+    };
     try {
+      _loggerProxy.default.log(`Starting agent station login | loginOption: ${data?.loginOption} teamId: ${data?.teamId}`, loggerContext);
       this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.STATION_LOGIN_SUCCESS, _constants4.METRIC_EVENT_NAMES.STATION_LOGIN_FAILED]);
       const dialPlanEntries = this.agentConfig?.dialPlan?.dialPlanEntity ?? [];
-      if (data.loginOption === _types.LoginOption.AGENT_DN && !(0, _Utils.isValidDialNumber)(data.dialNumber, dialPlanEntries)) {
-        const error = new Error('INVALID_DIAL_NUMBER');
-        // @ts-ignore - adding custom key to the error object
-        error.details = {
-          data: {
-            reason: 'INVALID_DIAL_NUMBER'
-          }
-        };
-        throw error;
+      if (data.loginOption === _types.LoginOption.AGENT_DN) {
+        _loggerProxy.default.log(`Validating dial number | dialPlanEnabled: ${!!this.agentConfig?.dialPlan} | dialPlanEntryCount: ${dialPlanEntries.length}`, loggerContext);
+        if (!(0, _Utils.isValidDialNumber)(data.dialNumber, dialPlanEntries)) {
+          _loggerProxy.default.log(`Dial number validation failed | dialNumber: ${data.dialNumber} | dialPlanEntryCount: ${dialPlanEntries.length}`, loggerContext);
+          const error = new Error('INVALID_DIAL_NUMBER');
+          // @ts-ignore - adding custom key to the error object
+          error.details = {
+            data: {
+              reason: 'INVALID_DIAL_NUMBER'
+            }
+          };
+          throw error;
+        }
       }
       const loginResponse = await this.services.agent.stationLogin({
         data: {
@@ -746,8 +793,13 @@ class ContactCenter extends _webexCore.WebexPlugin {
           auxCodeId: _constants.EMPTY_STRING
         }
       });
-      if (this.agentConfig.webRtcEnabled && data.loginOption === _types.LoginOption.BROWSER) {
+      if (this.agentConfig.webRtcEnabled && data.loginOption === _types.LoginOption.BROWSER && !this.isWebRTCRegistrationDisabled()) {
         await this.webCallingService.registerWebCallingLine();
+      } else if (this.agentConfig.webRtcEnabled && data.loginOption === _types.LoginOption.BROWSER && this.isWebRTCRegistrationDisabled()) {
+        _loggerProxy.default.info('Skipping web calling line registration because disableWebRTCRegistration is enabled', {
+          module: _constants.CC_FILE,
+          method: _constants.METHODS.STATION_LOGIN
+        });
       }
       const resp = await loginResponse;
       const {
@@ -1102,13 +1154,13 @@ class ContactCenter extends _webexCore.WebexPlugin {
   async handleConnectionLost(msg) {
     if (msg.isConnectionLost) {
       // TODO: Emit an event saying connection is lost
-      _loggerProxy.default.info('event=handleConnectionLost | Connection lost', {
+      _loggerProxy.default.log('event=handleConnectionLost | Connection lost', {
         module: _constants.CC_FILE,
         method: _constants.METHODS.HANDLE_CONNECTION_LOST
       });
     } else if (msg.isSocketReconnected) {
       // TODO: Emit an event saying connection is re-estabilished
-      _loggerProxy.default.info('event=handleConnectionReconnect | Connection reconnected attempting to request silent relogin', {
+      _loggerProxy.default.log('event=handleConnectionReconnect | Connection reconnected attempting to request silent relogin', {
         module: _constants.CC_FILE,
         method: _constants.METHODS.HANDLE_CONNECTION_LOST
       });
@@ -1123,7 +1175,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
    * @private
    */
   async silentRelogin() {
-    _loggerProxy.default.info('Starting silent relogin process', {
+    _loggerProxy.default.log('Starting silent relogin process', {
       module: _constants.CC_FILE,
       method: _constants.METHODS.SILENT_RELOGIN
     });
@@ -1145,7 +1197,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
       this.agentConfig.currentTeamId = reLoginResponse.data.teamId;
       await this.handleDeviceType(deviceType, dn);
       if (lastStateChangeReason === 'agent-wss-disconnect') {
-        _loggerProxy.default.info('event=requestAutoStateChange | Requesting state change to available on socket reconnect', {
+        _loggerProxy.default.log('event=requestAutoStateChange | Requesting state change to available on socket reconnect', {
           module: _constants.CC_FILE,
           method: _constants.METHODS.SILENT_RELOGIN
         });
@@ -1169,8 +1221,6 @@ class ContactCenter extends _webexCore.WebexPlugin {
       }
       this.agentConfig.lastStateAuxCodeId = auxCodeId;
       this.agentConfig.isAgentLoggedIn = true;
-      // TODO: https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-626777 Implement the de-register method and close the listener there
-      this.services.webSocketManager.on('message', this.handleWebsocketMessage);
       _loggerProxy.default.log(`Silent relogin process completed successfully with login Option: ${reLoginResponse.data.deviceType} teamId: ${reLoginResponse.data.teamId}`, {
         module: _constants.CC_FILE,
         method: _constants.METHODS.SILENT_RELOGIN,
@@ -1205,6 +1255,13 @@ class ContactCenter extends _webexCore.WebexPlugin {
     this.agentConfig.deviceType = deviceType;
     switch (deviceType) {
       case _types.LoginOption.BROWSER:
+        if (this.isWebRTCRegistrationDisabled()) {
+          _loggerProxy.default.info('Skipping web calling line registration because disableWebRTCRegistration is enabled', {
+            module: _constants.CC_FILE,
+            method: _constants.METHODS.HANDLE_DEVICE_TYPE
+          });
+          break;
+        }
         try {
           await this.webCallingService.registerWebCallingLine();
         } catch (error) {
@@ -1444,6 +1501,138 @@ class ContactCenter extends _webexCore.WebexPlugin {
     }
   }
 
+  /**
+   * Skips a campaign preview contact, requesting the next contact from the campaign.
+   *
+   * When a campaign manager reserves a contact for an agent, the agent receives an
+   * `AgentOfferCampaignReservation` event. Instead of accepting, the agent can skip the
+   * preview contact to move to the next contact in the campaign.
+   *
+   * @param {PreviewContactPayload} payload - The preview contact payload containing interactionId and campaignId (campaign name, not UUID).
+   * @returns {Promise<TaskResponse>} Promise resolving with agent contact on success.
+   * @throws {Error} If the operation fails (network error, etc.)
+   *
+   * @example
+   * ```typescript
+   * webex.cc.on('task:campaignPreviewReservation', async (task) => {
+   *   const { interactionId } = task.data;
+   *   const campaignId = task.data.interaction.callProcessingDetails.campaignId;
+   *
+   *   const result = await webex.cc.skipPreviewContact({ interactionId, campaignId });
+   * });
+   * ```
+   */
+  async skipPreviewContact(payload) {
+    const task = this.taskManager.getTask(payload.interactionId);
+    if (task?.data?.interaction?.callProcessingDetails?.campaignPreviewSkipDisabled === 'true') {
+      _loggerProxy.default.warn('Skip action is disabled for this campaign preview contact', {
+        module: _constants.CC_FILE,
+        method: _constants.METHODS.SKIP_PREVIEW_CONTACT,
+        interactionId: payload.interactionId
+      });
+      throw new Error('Skip action is disabled for this campaign preview contact');
+    }
+    _loggerProxy.default.info('Skipping campaign preview contact', {
+      module: _constants.CC_FILE,
+      method: _constants.METHODS.SKIP_PREVIEW_CONTACT
+    });
+    try {
+      this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_SUCCESS, _constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_FAILED]);
+      const result = await this.services.dialer.skipPreviewContact({
+        data: payload
+      });
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_SUCCESS, {
+        ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(result),
+        interactionId: payload.interactionId,
+        campaignId: payload.campaignId
+      }, ['behavioral', 'business', 'operational']);
+      _loggerProxy.default.log('Campaign preview contact skipped successfully', {
+        module: _constants.CC_FILE,
+        method: _constants.METHODS.SKIP_PREVIEW_CONTACT,
+        trackingId: result.trackingId,
+        interactionId: payload.interactionId
+      });
+      return result;
+    } catch (error) {
+      const failure = error.details;
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_FAILED, {
+        ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failure),
+        interactionId: payload.interactionId,
+        campaignId: payload.campaignId
+      }, ['behavioral', 'business', 'operational']);
+      const {
+        error: detailedError
+      } = (0, _Utils.getErrorDetails)(error, _constants.METHODS.SKIP_PREVIEW_CONTACT, _constants.CC_FILE);
+      throw detailedError;
+    }
+  }
+
+  /**
+   * Removes a campaign preview contact from the campaign list entirely.
+   *
+   * When a campaign manager reserves a contact for an agent, the agent receives an
+   * `AgentOfferCampaignReservation` event. Instead of accepting or skipping, the agent can
+   * remove the preview contact to permanently take it out of the campaign contact list.
+   *
+   * @param {PreviewContactPayload} payload - The preview contact payload containing interactionId and campaignId (campaign name, not UUID).
+   * @returns {Promise<TaskResponse>} Promise resolving with agent contact on success.
+   * @throws {Error} If the operation fails (network error, etc.)
+   *
+   * @example
+   * ```typescript
+   * webex.cc.on('task:campaignPreviewReservation', async (task) => {
+   *   const { interactionId } = task.data;
+   *   const campaignId = task.data.interaction.callProcessingDetails.campaignId;
+   *
+   *   const result = await webex.cc.removePreviewContact({ interactionId, campaignId });
+   * });
+   * ```
+   */
+  async removePreviewContact(payload) {
+    const task = this.taskManager.getTask(payload.interactionId);
+    if (task?.data?.interaction?.callProcessingDetails?.campaignPreviewRemoveDisabled === 'true') {
+      _loggerProxy.default.warn('Remove action is disabled for this campaign preview contact', {
+        module: _constants.CC_FILE,
+        method: _constants.METHODS.REMOVE_PREVIEW_CONTACT,
+        interactionId: payload.interactionId
+      });
+      throw new Error('Remove action is disabled for this campaign preview contact');
+    }
+    _loggerProxy.default.info('Removing campaign preview contact', {
+      module: _constants.CC_FILE,
+      method: _constants.METHODS.REMOVE_PREVIEW_CONTACT
+    });
+    try {
+      this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_SUCCESS, _constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_FAILED]);
+      const result = await this.services.dialer.removePreviewContact({
+        data: payload
+      });
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_SUCCESS, {
+        ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(result),
+        interactionId: payload.interactionId,
+        campaignId: payload.campaignId
+      }, ['behavioral', 'business', 'operational']);
+      _loggerProxy.default.log('Campaign preview contact removed successfully', {
+        module: _constants.CC_FILE,
+        method: _constants.METHODS.REMOVE_PREVIEW_CONTACT,
+        trackingId: result.trackingId,
+        interactionId: payload.interactionId
+      });
+      return result;
+    } catch (error) {
+      const failure = error.details;
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_FAILED, {
+        ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failure),
+        interactionId: payload.interactionId,
+        campaignId: payload.campaignId
+      }, ['behavioral', 'business', 'operational']);
+      const {
+        error: detailedError
+      } = (0, _Utils.getErrorDetails)(error, _constants.METHODS.REMOVE_PREVIEW_CONTACT, _constants.CC_FILE);
+      throw detailedError;
+    }
+  }
+
   /**
    * Fetches outdial ANI (Automatic Number Identification) entries for an outdial ANI ID.
    *