@webex/contact-center 3.12.0-next.15 → 3.12.0-next.151

package/dist/services/task/types.js

@@ -3,12 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.TASK_EVENTS = exports.MEDIA_CHANNEL = exports.DESTINATION_TYPE = exports.CONSULT_TRANSFER_DESTINATION_TYPE = void 0;
+exports.VOICE_VARIANT = exports.TASK_EVENTS = exports.TASK_CHANNEL_TYPE = exports.MEDIA_CHANNEL = exports.DESTINATION_TYPE = exports.CONSULT_TRANSFER_DESTINATION_TYPE = void 0;
+/* eslint-disable import/no-cycle */
+
 /**
  * Unique identifier for a task in the contact center system
  * @public
  */
 
+/**
+ * Unique identifier for a call in the Webex calling system
+ */
+
 /**
  * Helper type for creating enum-like objects with type safety
  * @internal
@@ -26,7 +32,7 @@ const DESTINATION_TYPE = exports.DESTINATION_TYPE = {
   DIALNUMBER: 'dialNumber',
   /** Route task to a specific agent */
   AGENT: 'agent',
-  /** Route task to an entry point (supported only for consult operations) */
+  /** Route task to an entry point */
   ENTRYPOINT: 'entryPoint'
 };
 
@@ -58,6 +64,11 @@ const CONSULT_TRANSFER_DESTINATION_TYPE = exports.CONSULT_TRANSFER_DESTINATION_T
  * @public
  */
 
+/**
+ * Agent-profile policy used by the task state machine to derive consult/transfer destinations.
+ * @internal
+ */
+
 /**
  * Defines all supported media channel types for customer interactions
  * These represent the different ways customers can communicate with agents
@@ -85,6 +96,21 @@ const MEDIA_CHANNEL = exports.MEDIA_CHANNEL = {
  * Derived from the MEDIA_CHANNEL constant
  * @public
  */
+
+/**
+ * Supported task channel types for UI control configuration
+ */
+const TASK_CHANNEL_TYPE = exports.TASK_CHANNEL_TYPE = {
+  VOICE: 'voice',
+  DIGITAL: 'digital'
+};
+/**
+ * Voice channel variants that toggle PSTN/WebRTC specific behaviors
+ */
+const VOICE_VARIANT = exports.VOICE_VARIANT = {
+  PSTN: 'pstn',
+  WEBRTC: 'webrtc'
+};
 /**
  * Enumeration of all task-related events that can occur in the contact center system
  * These events represent different states and actions in the task lifecycle
@@ -189,6 +215,14 @@ let TASK_EVENTS = exports.TASK_EVENTS = /*#__PURE__*/function (TASK_EVENTS) {
    * ```
    */
   TASK_EVENTS["TASK_CONSULT_QUEUE_FAILED"] = "task:consultQueueFailed";
+  /**
+   * Triggered whenever task UI controls are recalculated
+   */
+  TASK_EVENTS["TASK_UI_CONTROLS_UPDATED"] = "task:ui-controls-updated";
+  /**
+   * Triggered when wxApp mute state changes from Webex App (Mercury sync or call details).
+   */
+  TASK_EVENTS["TASK_WXAPP_MUTE_STATE_UPDATED"] = "task:wxapp-mute-state-updated";
   /**
    * Triggered when a consultation request is accepted
    * @example
@@ -266,6 +300,22 @@ let TASK_EVENTS = exports.TASK_EVENTS = /*#__PURE__*/function (TASK_EVENTS) {
    * ```
    */
   TASK_EVENTS["TASK_WRAPPEDUP"] = "task:wrappedup";
+  /**
+   * Triggered when the task state machine reaches a final state and resources should be cleaned up.
+   * Used internally by TaskManager to perform collection/call cleanup.
+   * @internal
+   */
+  TASK_EVENTS["TASK_CLEANUP"] = "task:cleanup";
+  /**
+   * Triggered when recording is started
+   * @example
+   * ```typescript
+   * task.on(TASK_EVENTS.TASK_RECORDING_STARTED, (task: ITask) => {
+   *   console.log('Recording started:', task.data.interactionId);
+   * });
+   * ```
+   */
+  TASK_EVENTS["TASK_RECORDING_STARTED"] = "task:recordingStarted";
   /**
    * Triggered when recording is paused
    * @example
@@ -479,6 +529,40 @@ let TASK_EVENTS = exports.TASK_EVENTS = /*#__PURE__*/function (TASK_EVENTS) {
    * ```
    */
   TASK_EVENTS["TASK_PARTICIPANT_LEFT_FAILED"] = "task:participantLeftFailed";
+  /**
+   * Triggered when agent initiates exit from conference
+   * @example
+   * ```typescript
+   * task.on(TASK_EVENTS.TASK_EXIT_CONFERENCE, (task: ITask) => {
+   *   console.log('Exiting conference:', task.data.interactionId);
+   *   // Handle conference exit initiation
+   * });
+   * ```
+   */
+  TASK_EVENTS["TASK_EXIT_CONFERENCE"] = "task:exitConference";
+  /**
+   * Triggered when agent initiates conference transfer
+   * @example
+   * ```typescript
+   * task.on(TASK_EVENTS.TASK_TRANSFER_CONFERENCE, (task: ITask) => {
+   *   console.log('Transferring conference:', task.data.interactionId);
+   *   // Handle conference transfer initiation
+   * });
+   * ```
+   */
+  TASK_EVENTS["TASK_TRANSFER_CONFERENCE"] = "task:transferConference";
+  /**
+   * Triggered when agent switches between consult call and main call.
+   * Use task.uiControls to determine current state and button visibility.
+   * @example
+   * ```typescript
+   * task.on(TASK_EVENTS.TASK_SWITCH_CALL, (task: ITask) => {
+   *   console.log('Call switched:', task.data.interactionId);
+   *   // Update UI based on task.uiControls.main.switch / task.uiControls.consult.switch
+   * });
+   * ```
+   */
+  TASK_EVENTS["TASK_SWITCH_CALL"] = "task:switchCall";
   /**
    * Triggered when a contact is merged
    * @example
@@ -501,6 +585,16 @@ let TASK_EVENTS = exports.TASK_EVENTS = /*#__PURE__*/function (TASK_EVENTS) {
    * ```
    */
   TASK_EVENTS["TASK_POST_CALL_ACTIVITY"] = "task:postCallActivity";
+  /**
+   * Triggered when a multi-login task update should hydrate SDK instances without Mobius registration.
+   * @example
+   * ```typescript
+   * task.on(TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, (task: ITask) => {
+   *   console.log('Multi-login hydrate:', task.data.interactionId);
+   * });
+   * ```
+   */
+  TASK_EVENTS["TASK_MULTI_LOGIN_HYDRATE"] = "task:multiLoginHydrate";
   /**
    * Triggered when a campaign preview contact is offered to the agent
    * @example
@@ -512,6 +606,69 @@ let TASK_EVENTS = exports.TASK_EVENTS = /*#__PURE__*/function (TASK_EVENTS) {
    * ```
    */
   TASK_EVENTS["TASK_CAMPAIGN_PREVIEW_RESERVATION"] = "task:campaignPreviewReservation";
+  /**
+   * Triggered when accepting a campaign preview contact fails
+   * @example
+   * ```typescript
+   * task.on(TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_ACCEPT_FAILED, (task: ITask) => {
+   *   console.log('Campaign preview accept failed:', task.data.interactionId);
+   *   // Handle accept failure
+   * });
+   * ```
+   */
+  TASK_EVENTS["TASK_CAMPAIGN_PREVIEW_ACCEPT_FAILED"] = "task:campaignPreviewAcceptFailed";
+  /**
+   * Triggered when skipping a campaign preview contact fails
+   * @example
+   * ```typescript
+   * task.on(TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_SKIP_FAILED, (task: ITask) => {
+   *   console.log('Campaign preview skip failed:', task.data.interactionId);
+   *   // Handle skip failure
+   * });
+   * ```
+   */
+  TASK_EVENTS["TASK_CAMPAIGN_PREVIEW_SKIP_FAILED"] = "task:campaignPreviewSkipFailed";
+  /**
+   * Triggered when removing a campaign preview contact fails
+   * @example
+   * ```typescript
+   * task.on(TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_REMOVE_FAILED, (task: ITask) => {
+   *   console.log('Campaign preview remove failed:', task.data.interactionId);
+   *   // Handle remove failure
+   * });
+   * ```
+   */
+  TASK_EVENTS["TASK_CAMPAIGN_PREVIEW_REMOVE_FAILED"] = "task:campaignPreviewRemoveFailed";
+  /**
+   * Triggered when a campaign contact is updated (e.g., after skip or remove, when the next contact is offered)
+   * @example
+   * ```typescript
+   * task.on(TASK_EVENTS.TASK_CAMPAIGN_CONTACT_UPDATED, (task: ITask) => {
+   *   console.log('Campaign contact updated:', task.data.interactionId);
+   *   // Handle updated campaign contact (e.g., display next contact)
+   * });
+   * ```
+   */
+  TASK_EVENTS["TASK_CAMPAIGN_CONTACT_UPDATED"] = "task:campaignContactUpdated";
+  /**
+   * Triggered when a mid-call summary is received for the task.
+   */
+  TASK_EVENTS["TASK_MID_CALL_SUMMARY_RECEIVED"] = "task:midCallSummaryReceived";
+  /**
+   * Triggered on the task object when AI feature enablement flags arrive for that task's interaction.
+   * Fires immediately if the frame arrived after the task was registered, or at registration time
+   * if the frame arrived before the task (orphan retention). Consumers should use this event
+   * instead of the cc-level `FEATURE_ENABLEMENT` event so they do not need to maintain an
+   * interactionId → flags map manually.
+   * @example
+   * ```typescript
+   * task.on(TASK_EVENTS.TASK_FEATURE_ENABLEMENT, (enablement: AISummaryFeatureEnablement) => {
+   *   const { midCallEnabled, postCallEnabled } = enablement;
+   *   // gate summary UI on these flags
+   * });
+   * ```
+   */
+  TASK_EVENTS["TASK_FEATURE_ENABLEMENT"] = "task:featureEnablement";
   return TASK_EVENTS;
 }({});
 /**
@@ -520,8 +677,28 @@ let TASK_EVENTS = exports.TASK_EVENTS = /*#__PURE__*/function (TASK_EVENTS) {
  * @public
  */
 /**
- * Task payload containing detailed information about a contact center task
- * This structure encapsulates all relevant data for task management
+ * Media entry type from interaction.media
+ * Used for media state tracking in consult and conference scenarios
+ */
+/**
+ * Task payload mirroring the Agent Contact event payload from Webex Contact Center
+ * (developer.webex.com). Arrives on AGENT_* websocket events and is the source of truth
+ * for UI/state machine updates.
+ * @public
+ */
+/**
+ * UI control representation for a single interaction leg.
+ */
+/** Options for {@link ITask.toggleMute} — wxApp engaged calls use `muted` for target state. */
+/** Options for {@link ITask.transmitDtmf} — wxApp engaged in-call DTMF. */
+/**
+ * UI controls surfaced to task consumers.
+ * Consumers should read controls from the per-leg surfaces and use `activeLeg`
+ * to determine which one is currently interactive.
+ */
+/**
+ * Helper class for managing task action control state
+ * Tracks visibility and enabled state for task actions that can be executed
  * @public
  */
 /**
@@ -570,6 +747,10 @@ let TASK_EVENTS = exports.TASK_EVENTS = /*#__PURE__*/function (TASK_EVENTS) {
  * Parameters for transferring a task to another destination
  * @public
  */
+/**
+ * Options for configuring transfer behavior
+ * @public
+ */
 /**
  * API payload for ending a consultation
  * This is the actual payload that is sent to the developer API
@@ -603,14 +784,87 @@ let TASK_EVENTS = exports.TASK_EVENTS = /*#__PURE__*/function (TASK_EVENTS) {
  * Data structure for cleaning up contact resources
  * @public
  */
+/**
+ * Boolean-like fields in callProcessingDetails that may arrive as strings.
+ * Used by taskDataNormalizer to coerce payloads to actual booleans.
+ */
+/**
+ * Interaction-level boolean fields that may arrive as strings from backend payloads.
+ */
+/**
+ * Participant boolean fields that may arrive as strings and need normalization.
+ */
 /**
  * Response type for task public methods
  * Can be an {@link AgentContact} object containing updated task state,
  * an Error in case of failure, or void for operations that don't return data
  * @public
  */
+/** AI-assisted mid-call summary action. @public */
+/** Feedback value sent with an AI summary response. @public */
+/** AI summary response state for post-call and mid-call flows. @public */
+/** Structured fields shared by post-call and mid-call summaries. @public */
+/** RTD payload returned or delivered for an AI summary. @public */
+/** RTD payload describing AI-summary feature enablement for an interaction. @public */
+/** Current AI-summary capabilities for a task. @public */
+/**
+ * Payload sent when reporting a post-call or mid-call summary result.
+ * Transport timestamps are generated by the SDK when the response is sent.
+ * @public
+ */
+/**
+ * Request payload for removing a supported participant from an active conference.
+ * @public
+ */
+/**
+ * Payload shape used by consult conference helper utilities.
+ */
+/**
+ * Minimal event-emitter contract exposed to SDK consumers.
+ * Defined here so that consumers do NOT need `@types/node` in their tsconfig.
+ * The runtime Task class still extends Node's EventEmitter (via ampersand-events),
+ * which satisfies this interface at runtime.
+ * @public
+ */
 /**
  * Interface for managing task-related operations in the contact center
- * Extends EventEmitter to support event-driven task updates
+ * Extends IEventEmitter to support event-driven task updates
+ */
+/**
+ * Interface for managing digital channel task operations in the contact center
+ * Digital channels (chat, email, social, SMS) have a simpler interface than voice
+ * Extends ITask but overrides updateTaskData to return IDigital
+ * @public
+ */
+/**
+ * Interface for managing voice/telephony task operations in the contact center
+ * Extends ITask with voice-specific functionality for hold/resume operations
+ * @public
+ */
+/**
+ * Configuration options for voice task UI controls
+ */
+/**
+ * Participant information for UI display
+ */
+/**
+ * @deprecated Use Participant instead
+ */
+/**
+ * Actions to be performed after handling an event
+ *
+ * These actions represent TaskManager-level concerns (task collection lifecycle,
+ * resource cleanup) rather than task-level state machine concerns. The separation
+ * ensures proper responsibility:
+ * - TaskManager: Collection management, metrics, cleanup
+ * - State Machine: Task state transitions, event emissions, UI controls
+ */
+/**
+ * Context for processing an event
+ *
+ * Contains all information needed to process a WebSocket event:
+ * - Event type and payload from the backend
+ * - Task instance (if exists)
+ * - Pre-mapped state machine event (if applicable)
  */
 //# sourceMappingURL=types.js.map