@webex/contact-center 3.12.0-llmrefactor.12 → 3.12.0-llmrefactor.14

package/dist/cc.js

@@ -240,6 +240,16 @@ class ContactCenter extends _webexCore.WebexPlugin {
    * @private
    */
 
+  /** Current login/relogin session used for agent-scoped wellness validation. */
+
+  /** Registered-session cache for the system WellbeingBreak idle code. */
+
+  /** Registration generation that owns the wellness idle-code cache and in-flight lookups. */
+  wellnessRegistrationGeneration = 0;
+  updateWellnessSession(agentSessionId) {
+    this.currentAgentSessionId = agentSessionId;
+  }
+
   /**
    * API instance for managing Webex Contact Center entry points
    * Provides functionality to fetch entry points with caching support
@@ -375,7 +385,11 @@ class ContactCenter extends _webexCore.WebexPlugin {
       this.answerCallOnWebexService = new _AnswerCallOnWebexService.default(this.$webex);
       this.webexCrossClientService = new _WebexCrossClientService.default(this.$webex);
       this.wxAppTelephonyMercurySync = new _WxAppTelephonyMercurySync.default(this.$webex);
-      this.apiAIAssistant = new _ApiAiAssistant.ApiAIAssistant(this.$webex);
+      this.apiAIAssistant = new _ApiAiAssistant.ApiAIAssistant(this.$webex, () => ({
+        isWellnessBreakEnabled: this.agentConfig?.isWellnessBreakEnabled === true,
+        agentId: this.agentConfig?.agentId,
+        agentSessionId: this.currentAgentSessionId
+      }));
       this.metricsManager = _MetricsManager.default.getInstance({
         webex: this.$webex
       });
@@ -442,7 +456,82 @@ class ContactCenter extends _webexCore.WebexPlugin {
     // @ts-ignore
     this.trigger(_types4.TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, task);
   };
+  trackInvalidWellnessEvent(reason) {
+    this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.AI_ASSISTANT_WELLNESS_EVENT_INVALID, {
+      reason
+    }, ['operational']);
+  }
+  normalizeWellnessBreakEvent(payload) {
+    if (this.agentConfig?.isWellnessBreakEnabled !== true) {
+      this.trackInvalidWellnessEvent('wellness_disabled');
+      return null;
+    }
+    const notificationData = (0, _Utils.isRecord)(payload.data) ? payload.data : null;
+    const notificationDetails = notificationData && (0, _Utils.isRecord)(notificationData.notifDetails) ? notificationData.notifDetails : null;
+    const sessionData = notificationData && (0, _Utils.isRecord)(notificationData.data) ? notificationData.data : null;
+    const actionEvent = notificationDetails?.actionEvent;
+    if (payload.type !== _constants.WELLNESS_BREAK_HANDLER || notificationData?.notifType !== _constants.WELLNESS_BREAK_HANDLER || typeof actionEvent !== 'string') {
+      this.trackInvalidWellnessEvent('malformed_wellness_event');
+      return null;
+    }
+    if (!Object.values(_types.WELLNESS_BREAK_NOTIFICATION_ACTIONS).includes(actionEvent)) {
+      this.trackInvalidWellnessEvent('unknown_wellness_action');
+      return null;
+    }
+    const agentId = notificationData.agentId;
+    const eventOrgId = notificationData.orgId;
+    const sessionOrgId = sessionData?.orgId;
+    const envelopeOrgId = payload.orgId;
+    const agentSessionId = sessionData?.agentSessionId;
+    const currentOrgId = this.$webex.credentials.getOrgId();
+    if (typeof agentId !== 'string' || typeof eventOrgId !== 'string' || typeof sessionOrgId !== 'string' || typeof envelopeOrgId !== 'string' || typeof agentSessionId !== 'string' || !agentId || !eventOrgId || !sessionOrgId || !envelopeOrgId || !agentSessionId) {
+      this.trackInvalidWellnessEvent('missing_wellness_identity');
+      return null;
+    }
+    if (agentId !== this.agentConfig?.agentId || eventOrgId !== currentOrgId || sessionOrgId !== currentOrgId || envelopeOrgId !== currentOrgId) {
+      this.trackInvalidWellnessEvent('mismatched_wellness_identity');
+      return null;
+    }
+    const interactionValue = sessionData.interactionId ?? sessionData.InteractionId;
+    const actionText = notificationDetails.actionText;
+    const trackingId = payload.trackingId;
+    return {
+      agentId,
+      orgId: currentOrgId,
+      agentSessionId,
+      actionEvent: actionEvent,
+      ...(typeof actionText === 'string' ? {
+        actionText
+      } : {}),
+      ...(typeof interactionValue === 'string' ? {
+        interactionId: interactionValue
+      } : {}),
+      ...(typeof trackingId === 'string' ? {
+        trackingId
+      } : {})
+    };
+  }
+  handleWellnessBreakWebsocketPayload(payload) {
+    if (payload.type !== _constants.WELLNESS_BREAK_HANDLER) {
+      return false;
+    }
+    const wellnessEvent = this.normalizeWellnessBreakEvent(payload);
+    if (wellnessEvent) {
+      // @ts-ignore - WebexPlugin emit is available at runtime but absent from its declaration.
+      this.emit(_types3.CC_EVENTS.WELLNESS_BREAK, wellnessEvent);
+    }
+    return true;
+  }
   handleRTDWebsocketMessage = event => {
+    let payload;
+    try {
+      payload = JSON.parse(event);
+    } catch {
+      // TaskManager retains its existing malformed RTD message handling.
+    }
+    if ((0, _Utils.isRecord)(payload) && this.handleWellnessBreakWebsocketPayload(payload)) {
+      return;
+    }
     this.taskManager.handleRealtimeWebsocketEvent(event);
   };
 
@@ -496,6 +585,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
    * ```
    */
   async register() {
+    this.wellnessRegistrationGeneration += 1;
+    this.wellbeingBreakIdleCode = undefined;
     _loggerProxy.default.log('Starting CC SDK registration', {
       module: _constants.CC_FILE,
       method: _constants.METHODS.REGISTER
@@ -515,7 +606,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
         module: _constants.CC_FILE,
         method: _constants.METHODS.REGISTER
       });
-      return resp;
+
+      // Registration can silently restore a station session without emitting a
+      // relogin event. Project the active session for consumers that must
+      // recover session-scoped state after a page refresh.
+      return resp.isAgentLoggedIn && this.currentAgentSessionId ? {
+        ...resp,
+        agentSessionId: this.currentAgentSessionId
+      } : resp;
     } catch (error) {
       this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_FAILED, {
         orgId: error.orgId
@@ -562,6 +660,9 @@ class ContactCenter extends _webexCore.WebexPlugin {
    *
     */
   async deregister() {
+    this.wellnessRegistrationGeneration += 1;
+    this.wellbeingBreakIdleCode = undefined;
+    this.updateWellnessSession();
     try {
       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);
@@ -601,7 +702,9 @@ class ContactCenter extends _webexCore.WebexPlugin {
       }
 
       // Clear any cached agent configuration
+      this.wellbeingBreakIdleCode = undefined;
       this.agentConfig = null;
+      this.updateWellnessSession();
       if (wxAppPublishError) {
         throw wxAppPublishError;
       }
@@ -740,7 +843,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
           accessEntryPoint: this.agentConfig.accessEntryPoint,
           accessBuddyTeam: this.agentConfig.accessBuddyTeam
         },
-        enableWxBetterTogether: this.isWxBetterTogetherEnabled()
+        enableWxBetterTogether: this.isWxBetterTogetherEnabled(),
+        getWxAppUsersubPublished: () => this.webexCrossClientService.isAnswerCallsStateActive()
       };
       this.taskManager.setConfigFlags(configFlags);
       // TODO: Make profile a singleton to make it available throughout app/sdk so we dont need to inject info everywhere
@@ -748,12 +852,15 @@ class ContactCenter extends _webexCore.WebexPlugin {
       this.taskManager.setAgentId(this.agentConfig.agentId);
       this.taskManager.setWebRtcEnabled(this.agentConfig.webRtcEnabled);
       this.apiAIAssistant.setAIFeatureFlags(this.agentConfig.aiFeature);
+      this.wellbeingBreakIdleCode = undefined;
+      this.updateWellnessSession();
 
       /**
        * RTD websocket currently supports realtime transcripts and suggested responses.
        * Extend this condition when additional AI RTD features are introduced.
+       * Wellness break notifications also arrive on this websocket.
        */
-      if (this.agentConfig.aiFeature?.realtimeTranscripts?.enable || this.agentConfig.aiFeature?.suggestedResponses?.enable) {
+      if (this.agentConfig.aiFeature?.realtimeTranscripts?.enable || this.agentConfig.aiFeature?.suggestedResponses?.enable || this.agentConfig.isWellnessBreakEnabled) {
         _loggerProxy.default.info('Connecting to RTD websocket', {
           module: _constants.CC_FILE,
           method: _constants.METHODS.CONNECT_WEBSOCKET
@@ -803,6 +910,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
       }
       return this.agentConfig;
     } catch (error) {
+      this.updateWellnessSession();
       _loggerProxy.default.error(`Error during register: ${error}`, {
         module: _constants.CC_FILE,
         method: _constants.METHODS.CONNECT_WEBSOCKET
@@ -891,6 +999,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
         channelsMap,
         ...loginData
       } = resp.data;
+      this.updateWellnessSession(resp.data.agentSessionId);
       this.agentConfig.currentTeamId = resp.data.teamId;
       const response = {
         ...loginData,
@@ -978,6 +1087,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
         this.webCallingService.deregisterWebCallingLine();
       }
       await this.teardownWxAppLocalState();
+      this.updateWellnessSession();
       _loggerProxy.default.log(`Agent station logout completed successfully`, {
         module: _constants.CC_FILE,
         method: _constants.METHODS.STATION_LOGOUT,
@@ -1098,6 +1208,63 @@ class ContactCenter extends _webexCore.WebexPlugin {
     }
   }
 
+  /**
+   * Returns the system-managed `WellbeingBreak` idle code for the current registration.
+   * The value is fetched outside Desktop Profile filtering and cached until deregistration.
+   * @returns The normalized system idle-code entity
+   * @throws Structured Contact Center error when wellness is disabled or the code is unavailable
+   * @example
+   * const idleCode = await webex.cc.getWellbeingBreakIdleCode();
+   * @public
+   */
+  async getWellbeingBreakIdleCode() {
+    const method = _constants.METHODS.GET_WELLBEING_BREAK_IDLE_CODE;
+    try {
+      if (!this.agentConfig?.isWellnessBreakEnabled) {
+        const validationError = new Error('WELLNESS_BREAK_NOT_ENABLED');
+        validationError.details = {
+          type: 'SDK_VALIDATION_ERROR',
+          orgId: this.$webex.credentials.getOrgId(),
+          trackingId: _constants.EMPTY_STRING,
+          data: {
+            reason: 'WELLNESS_BREAK_NOT_ENABLED'
+          }
+        };
+        throw validationError;
+      }
+      if (this.wellbeingBreakIdleCode) {
+        return this.wellbeingBreakIdleCode;
+      }
+      this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS, _constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED]);
+      const registrationGeneration = this.wellnessRegistrationGeneration;
+      const orgId = this.$webex.credentials.getOrgId();
+      const idleCode = await this.services.config.getWellbeingBreakIdleCode(orgId);
+      if (registrationGeneration !== this.wellnessRegistrationGeneration || orgId !== this.$webex.credentials.getOrgId() || !this.agentConfig?.isWellnessBreakEnabled) {
+        const staleRegistrationError = new Error('WELLNESS_BREAK_REGISTRATION_CHANGED');
+        staleRegistrationError.details = {
+          type: 'SDK_VALIDATION_ERROR',
+          orgId,
+          trackingId: _constants.EMPTY_STRING,
+          data: {
+            reason: 'WELLNESS_BREAK_REGISTRATION_CHANGED'
+          }
+        };
+        throw staleRegistrationError;
+      }
+      this.wellbeingBreakIdleCode = idleCode;
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS, {}, ['operational']);
+      return idleCode;
+    } catch (error) {
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED, {
+        reason: error instanceof Error ? error.message : _constants.UNKNOWN_ERROR
+      }, ['operational']);
+      const {
+        error: detailedError
+      } = (0, _Utils.getErrorDetails)(error, method, _constants.CC_FILE);
+      throw detailedError;
+    }
+  }
+
   /**
    * Processes incoming websocket messages and emits corresponding events
    * Handles various event types including agent state changes, login events,
@@ -1131,8 +1298,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
       };
       this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WEBSOCKET_EVENT_RECEIVED, metricsPayload, ['operational']);
     }
+    if (this.handleWellnessBreakWebsocketPayload(eventData)) {
+      return;
+    }
     switch (eventData.type) {
       case _types3.CC_EVENTS.AGENT_MULTI_LOGIN:
+        if (eventData.data?.type === 'AgentMultiLoginCloseSession' && (!eventData.data.agentSessionId || eventData.data.agentSessionId === this.currentAgentSessionId)) {
+          this.updateWellnessSession();
+        }
         // @ts-ignore
         this.emit(_types2.AGENT_EVENTS.AGENT_MULTI_LOGIN, eventData.data);
         break;
@@ -1153,6 +1326,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
             channelsMap,
             ...loginData
           } = eventData.data;
+          this.updateWellnessSession(loginData.agentSessionId);
           const stationLoginData = {
             ...loginData,
             mmProfile: {
@@ -1174,6 +1348,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
             channelsMap,
             ...loginData
           } = eventData.data;
+          this.updateWellnessSession(loginData.agentSessionId);
           const stationReLoginData = {
             ...loginData,
             mmProfile: {
@@ -1186,8 +1361,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
           };
           // @ts-ignore
           this.emit(_types2.AGENT_EVENTS.AGENT_RELOGIN_SUCCESS, stationReLoginData);
+          break;
         }
-        break;
       case _types3.CC_EVENTS.AGENT_STATE_CHANGE_SUCCESS:
         // @ts-ignore
         this.emit(_types2.AGENT_EVENTS.AGENT_STATE_CHANGE_SUCCESS, eventData.data);
@@ -1201,6 +1376,9 @@ class ContactCenter extends _webexCore.WebexPlugin {
         this.emit(_types2.AGENT_EVENTS.AGENT_STATION_LOGIN_FAILED, eventData.data);
         break;
       case _types3.CC_EVENTS.AGENT_LOGOUT_SUCCESS:
+        if (!eventData.data.agentSessionId || eventData.data.agentSessionId === this.currentAgentSessionId) {
+          this.updateWellnessSession();
+        }
         // @ts-ignore
         this.emit(_types2.AGENT_EVENTS.AGENT_LOGOUT_SUCCESS, eventData.data);
         break;
@@ -1321,6 +1499,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
         await this.publishAnswerOnWebexCrossClientState(true);
         publishedEnable = true;
         this.taskManager.syncWxAppMuteFromCallDetailsForAllTasks();
+        this.taskManager.refreshWxAppOfferObservabilityForAllTasks();
       } else {
         await this.publishAnswerOnWebexCrossClientState(false);
         this.wxAppTelephonyMercurySync.unsubscribe();
@@ -1383,6 +1562,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
         await this.publishAnswerOnWebexCrossClientState(true);
         publishedEnable = true;
         this.taskManager.syncWxAppMuteFromCallDetailsForAllTasks();
+        this.taskManager.refreshWxAppOfferObservabilityForAllTasks();
         const mercurySubscribed = this.wxAppTelephonyMercurySync.isSubscribed();
         const usersubPublished = this.webexCrossClientService.isAnswerCallsStateActive();
         (0, _wxAppDiagnosticLogging.logWxAppSessionReadiness)({
@@ -1397,12 +1577,18 @@ class ContactCenter extends _webexCore.WebexPlugin {
         if (sessionInitReady) {
           this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_SUCCESS, {
             loginOption,
-            enableWxBetterTogether: true
+            enableWxBetterTogether: true,
+            usersubPublished,
+            mercurySubscribed,
+            telephonyTaskType
           }, ['operational', 'behavioral']);
         } else {
           this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED, {
             loginOption,
             enableWxBetterTogether: true,
+            usersubPublished,
+            mercurySubscribed,
+            telephonyTaskType,
             skipReason: !usersubPublished ? 'usersub_not_published' : 'mercury_not_subscribed'
           }, ['operational', 'behavioral']);
         }
@@ -1439,6 +1625,9 @@ class ContactCenter extends _webexCore.WebexPlugin {
         this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED, {
           loginOption,
           enableWxBetterTogether: true,
+          usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
+          mercurySubscribed: this.wxAppTelephonyMercurySync.isSubscribed(),
+          telephonyTaskType,
           skipReason: sessionInitFailureReason,
           error: error instanceof Error ? error.toString() : String(error)
         }, ['operational', 'behavioral']);
@@ -1446,7 +1635,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
           enableWxBetterTogether: true,
           loginOption,
           wxAppHooksApplied: false,
-          usersubPublished: publishedEnable && this.webexCrossClientService.isAnswerCallsStateActive(),
+          usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
           mercurySubscribed: this.wxAppTelephonyMercurySync.isSubscribed(),
           telephonyTaskType,
           skipReason: sessionInitFailureReason
@@ -1652,7 +1841,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
         method: _constants.METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY
       });
       this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED, {
-        error: 'agentId unavailable'
+        error: 'agentId unavailable',
+        mercurySubscribed: false
       }, ['operational', 'behavioral']);
       return;
     }
@@ -1667,7 +1857,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
         method: _constants.METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY
       });
       this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED, {
-        error: error instanceof Error ? error.toString() : String(error)
+        error: error instanceof Error ? error.toString() : String(error),
+        mercurySubscribed: false
       }, ['operational', 'behavioral']);
       this.wxAppTelephonyMercurySync.unsubscribe();
       await this.releaseWxAppMercuryResources();
@@ -1686,6 +1877,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
       if (enable && this.isWxBetterTogetherEnabled()) {
         this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_FAILED, {
           enableWxBetterTogether: true,
+          usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
           skipReason: 'user_id_unavailable',
           error: 'User ID is unavailable for cross-client publish'
         }, ['operational', 'behavioral']);
@@ -1759,6 +1951,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
     });
     try {
       const reLoginResponse = await this.services.agent.reload();
+      this.updateWellnessSession(reLoginResponse.data.agentSessionId);
       const {
         agentId,
         lastStateChangeReason,