@webex/cc-components 1.28.0-rtt.1 → 1.28.0-task-refactor.1

package/dist/types/components/task/CallControl/CallControlCustom/call-control-custom.utils.d.ts

@@ -1,5 +1,5 @@
-import { BuddyDetails, ContactServiceQueue, ILogger } from '@webex/cc-store';
-import { ButtonConfig, ControlVisibility } from '../../task.types';
+import { BuddyDetails, ContactServiceQueue, ILogger, TaskUIControls } from '@webex/cc-store';
+import { ButtonConfig } from '../../task.types';
 /**
  * Interface for list item data
  */
@@ -10,7 +10,7 @@ export interface ListItemData {
 /**
  * Creates the consult button configuration array
  */
-export declare const createConsultButtons: (isMuted: boolean, controlVisibility: ControlVisibility, consultTransfer: () => void, toggleConsultMute: () => void, endConsultCall: () => void, consultConference: () => void, switchToMainCall: () => void, logger?: any) => ButtonConfig[];
+export declare const createConsultButtons: (isMuted: boolean, controls: TaskUIControls, consultTransfer: () => void, toggleConsultMute: () => void, endConsultCall: () => void, consultConference: () => void, switchToMainCall: () => void, logger?: any, conferenceEnabled?: boolean) => ButtonConfig[];
 /**
  * Filters buttons that should be visible
  */

package/dist/types/components/task/CallControl/call-control.utils.d.ts

@@ -1,5 +1,6 @@
 import { CallControlMenuType } from '../task.types';
-import type { CallControlButton, ControlVisibility, MEDIA_CHANNEL as MediaChannelType, MediaTypeInfo } from '../task.types';
+import type { CallControlButton, MEDIA_CHANNEL as MediaChannelType, MediaTypeInfo } from '../task.types';
+import type { TaskUIControls } from '@webex/cc-store';
 import { DestinationType, ILogger, ITask } from '@webex/cc-store';
 /**
  * Handles toggle hold functionality
@@ -32,9 +33,14 @@ export declare const isTelephonyMediaType: (mediaType: MediaChannelType, logger?
 /**
  * Builds the call control buttons configuration
  */
-export declare const buildCallControlButtons: (isMuted: boolean, isRecording: boolean, isMuteButtonDisabled: boolean, currentMediaType: MediaTypeInfo, controlVisibility: ControlVisibility, handleMuteToggleFunc: () => void, handleToggleHoldFunc: () => void, toggleRecording: () => void, endCall: () => void, exitConference: () => void, switchToConsult: () => void, onTransferConsult: () => void, handleConsultConferencePress: () => void, logger?: ILogger) => CallControlButton[];
+export declare const buildCallControlButtons: (isMuted: boolean, isRecording: boolean, isMuteButtonDisabled: boolean, currentMediaType: MediaTypeInfo, controls: TaskUIControls, isHeld: boolean, handleMuteToggleFunc: () => void, handleToggleHoldFunc: () => void, toggleRecording: () => void, endCall: () => void, exitConference: () => void, switchToConsult: () => void, onTransferConsult: () => void, handleConsultConferencePress: () => void, logger?: ILogger, conferenceEnabled?: boolean) => CallControlButton[];
 /**
  * Filters buttons based on consultation state
+ * During consulting:
+ * - Hide: hold, consult, and blind transfer buttons
+ * - Respect SDK enabled/disabled state for consulting buttons (transferConsult, conference)
+ *   They will be enabled when on main call, disabled when on consult call
+ * - Show as-is: mute, switchToConsult, recording, exitConference, end
  */
 export declare const filterButtonsForConsultation: (buttons: CallControlButton[], consultInitiated: boolean, isTelephony: boolean, logger?: any) => CallControlButton[];
 /**

package/dist/types/components/task/IncomingTask/incoming-task.utils.d.ts

@@ -21,4 +21,10 @@ export interface IncomingTaskData {
  * @param isBrowser - Whether the device type is browser
  * @returns Processed task data with computed values
  */
-export declare const extractIncomingTaskData: (incomingTask: ITask, isBrowser: boolean, logger?: any, isDeclineButtonEnabled?: boolean) => IncomingTaskData;
+export declare const extractIncomingTaskData: (incomingTask: ITask, logger?: any, acceptControl?: {
+    isVisible: boolean;
+    isEnabled: boolean;
+}, declineControl?: {
+    isVisible: boolean;
+    isEnabled: boolean;
+}, isDeclineButtonEnabled?: boolean, isBrowser?: boolean) => IncomingTaskData;

package/dist/types/components/task/Task/task.utils.d.ts

@@ -1,4 +1,11 @@
-import type { MEDIA_CHANNEL as MediaChannelType, TaskComponentData } from '../task.types';
+import type { MEDIA_CHANNEL as MediaChannelType, TaskComponentData, CADVariable, CallAssociatedDataMap } from '../task.types';
+/** System CAD variable keys that are already displayed elsewhere in the UI. */
+export declare const SYSTEM_CAD_KEYS: Set<string>;
+/**
+ * Returns agent-viewable global variables from a callAssociatedData map,
+ * excluding system variables that are already rendered elsewhere.
+ */
+export declare const getAgentViewableGlobalVariables: (callAssociatedData: CallAssociatedDataMap | undefined) => CADVariable[];
 /**
  * Capitalizes the first word of a string
  * @param str - The string to capitalize

package/dist/types/components/task/TaskList/task-list.utils.d.ts

@@ -6,7 +6,7 @@ import { ILogger, ITask } from '@webex/cc-store';
  * @param isBrowser - Whether the device type is browser
  * @returns Processed task data with computed values
  */
-export declare const extractTaskListItemData: (task: ITask, isBrowser: boolean, agentId: string, logger?: ILogger) => TaskListItemData;
+export declare const extractTaskListItemData: (task: ITask, agentId: string, logger?: ILogger, isDeclineButtonEnabled?: boolean, isBrowser?: boolean) => TaskListItemData;
 /**
  * Determines if a task should be selectable
  * @param task - The task object

package/dist/types/components/task/task.types.d.ts

@@ -1,5 +1,26 @@
-import { ILogger, ITask, IContactCenter, IWrapupCode, BuddyDetails, DestinationType, ContactServiceQueue, AddressBookEntry, EntryPointRecord, FetchPaginatedList, Participant, AddressBookEntrySearchParams, AddressBookEntriesResponse } from '@webex/cc-store';
+import { ILogger, ITask, IContactCenter, IWrapupCode, BuddyDetails, DestinationType, ContactServiceQueue, AddressBookEntry, EntryPointRecord, FetchPaginatedList, Participant, AddressBookEntrySearchParams, AddressBookEntriesResponse, TaskUIControls } from '@webex/cc-store';
 type Enum<T extends Record<string, unknown>> = T[keyof T];
+/**
+ * Represents a single Call Associated Data (CAD) variable on an interaction.
+ * Global variables have `global: true` and are set by flow control.
+ */
+export interface CADVariable {
+    name: string;
+    displayName: string;
+    value: string;
+    type: string;
+    agentEditable: boolean;
+    agentViewable: boolean;
+    global: boolean;
+    isSecure: boolean;
+    secureKeyId: string;
+    secureKeyVersion: number;
+}
+/**
+ * Record of CAD variables keyed by variable name.
+ * This is the shape of `callAssociatedData` on the interaction at runtime.
+ */
+export type CallAssociatedDataMap = Record<string, CADVariable>;
 /**
  * Target types for consult/transfer operations
  */
@@ -81,10 +102,6 @@ export interface TaskProps {
      * Function to handle task selection
      */
     onTaskSelect: (task: ITask) => void;
-    /**
-     * Flag to determine if the user is logged in with a browser option
-     */
-    isBrowser: boolean;
     /**
      * Flag to determine if the task is answered
      */
@@ -93,10 +110,6 @@ export interface TaskProps {
      * Flag to determine if the task is ended
      */
     isEnded: boolean;
-    /**
-     * Selected login option
-     */
-    deviceType: string;
     /**
      * List of tasks
      */
@@ -109,13 +122,23 @@ export interface TaskProps {
      * Agent ID of the logged-in user
      */
     agentId: string;
-    /**
-     * Flag to enable decline button on incoming task component
-     */
-    isDeclineButtonEnabled?: boolean;
 }
-export type IncomingTaskComponentProps = Pick<TaskProps, 'isBrowser' | 'accept' | 'reject' | 'logger'> & Partial<Pick<TaskProps, 'incomingTask' | 'isDeclineButtonEnabled'>>;
-export type TaskListComponentProps = Pick<TaskProps, 'isBrowser' | 'acceptTask' | 'declineTask' | 'onTaskSelect' | 'logger' | 'agentId'> & Partial<Pick<TaskProps, 'currentTask' | 'taskList'>>;
+export type IncomingTaskComponentProps = Pick<TaskProps, 'accept' | 'reject' | 'logger'> & Partial<Pick<TaskProps, 'incomingTask'>> & {
+    acceptControl?: {
+        isVisible: boolean;
+        isEnabled: boolean;
+    };
+    declineControl?: {
+        isVisible: boolean;
+        isEnabled: boolean;
+    };
+    isDeclineButtonEnabled?: boolean;
+    isBrowser?: boolean;
+};
+export type TaskListComponentProps = Pick<TaskProps, 'acceptTask' | 'declineTask' | 'onTaskSelect' | 'logger' | 'agentId'> & Partial<Pick<TaskProps, 'currentTask' | 'taskList'>> & {
+    isDeclineButtonEnabled?: boolean;
+    isBrowser?: boolean;
+};
 /**
  * Interface representing the properties for control actions on a task.
  */
@@ -208,10 +231,6 @@ export interface ControlProps {
      * @param wrapupId - The ID associated with the wrap-up reason.
      */
     wrapupCall: (wrapupReason: string, wrapupId: string) => void;
-    /**
-     * Selected login option
-     */
-    deviceType: string;
     /**
      * Flag to determine if the task is held
      */
@@ -317,12 +336,6 @@ export interface ControlProps {
      * Time since the task is in held state
      */
     holdTime: number;
-    /**
-     * Feature flags for the task.
-     */
-    featureFlags: {
-        [key: string]: boolean;
-    };
     /**
      * Custom CSS ClassName for CallControlCAD component.
      */
@@ -363,7 +376,7 @@ export interface ControlProps {
      * Function to set the last target type
      */
     setLastTargetType: (targetType: TargetType) => void;
-    controlVisibility: ControlVisibility;
+    controls: TaskUIControls;
     secondsUntilAutoWrapup?: number;
     /**
      * Function to cancel the auto wrap-up timer.
@@ -388,7 +401,7 @@ export interface ControlProps {
      */
     agentId: string;
 }
-export type CallControlComponentProps = Pick<ControlProps, 'currentTask' | 'wrapupCodes' | 'toggleHold' | 'toggleRecording' | 'toggleMute' | 'isMuted' | 'endCall' | 'wrapupCall' | 'isRecording' | 'setIsRecording' | 'buddyAgents' | 'loadingBuddyAgents' | 'loadBuddyAgents' | 'transferCall' | 'consultCall' | 'consultConference' | 'switchToMainCall' | 'switchToConsult' | 'exitConference' | 'endConsultCall' | 'consultTransfer' | 'callControlAudio' | 'consultAgentName' | 'setConsultAgentName' | 'holdTime' | 'callControlClassName' | 'callControlConsultClassName' | 'startTimestamp' | 'stateTimerLabel' | 'stateTimerTimestamp' | 'consultTimerLabel' | 'consultTimerTimestamp' | 'allowConsultToQueue' | 'lastTargetType' | 'setLastTargetType' | 'controlVisibility' | 'logger' | 'secondsUntilAutoWrapup' | 'cancelAutoWrapup' | 'conferenceParticipants' | 'getAddressBookEntries' | 'getEntryPoints' | 'getQueuesFetcher' | 'consultTransferOptions'>;
+export type CallControlComponentProps = Pick<ControlProps, 'currentTask' | 'isHeld' | 'wrapupCodes' | 'toggleHold' | 'toggleRecording' | 'toggleMute' | 'isMuted' | 'endCall' | 'wrapupCall' | 'isRecording' | 'setIsRecording' | 'buddyAgents' | 'loadingBuddyAgents' | 'loadBuddyAgents' | 'transferCall' | 'consultCall' | 'consultConference' | 'switchToMainCall' | 'switchToConsult' | 'exitConference' | 'endConsultCall' | 'consultTransfer' | 'callControlAudio' | 'consultAgentName' | 'setConsultAgentName' | 'holdTime' | 'callControlClassName' | 'callControlConsultClassName' | 'startTimestamp' | 'stateTimerLabel' | 'stateTimerTimestamp' | 'consultTimerLabel' | 'consultTimerTimestamp' | 'allowConsultToQueue' | 'lastTargetType' | 'setLastTargetType' | 'controls' | 'logger' | 'secondsUntilAutoWrapup' | 'cancelAutoWrapup' | 'conferenceParticipants' | 'getAddressBookEntries' | 'getEntryPoints' | 'getQueuesFetcher' | 'consultTransferOptions' | 'conferenceEnabled'>;
 export type OutdialAniEntry = {
     /** Unique identifier for the ANI entry */
     id: string;
@@ -496,8 +509,9 @@ export interface CallControlConsultComponentsProps {
     switchToMainCall: () => void;
     logger: ILogger;
     isMuted: boolean;
-    controlVisibility: ControlVisibility;
+    controls: TaskUIControls;
     toggleConsultMute: () => void;
+    conferenceEnabled: boolean;
 }
 /**
  * Type representing the possible menu types in call control.