@webex/cc-components 1.28.0-ccwidgets.98 → 1.28.0-next.1

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

@@ -14,6 +14,18 @@ export declare const SELECT = "Select";
 export declare const SUBMIT_WRAP_UP = "Submit & Wrap up";
 export declare const MUTE_CALL = "Mute";
 export declare const UNMUTE_CALL = "Unmute";
+export declare const DIAL_NUMBER = "DialNumber";
+export declare const AGENTS = "Agents";
+export declare const QUEUES = "Queues";
+export declare const SEARCH_PLACEHOLDER = "Search...";
+export declare const CLEAR_SEARCH = "Clear search";
+export declare const SCROLL_TO_LOAD_MORE = "Scroll to load more";
+export declare const LOADING_MORE_QUEUES = "Loading more queues...";
+export declare const LOADING_MORE_DIAL_NUMBERS = "Loading more dial numbers...";
+export declare const LOADING_MORE_ENTRY_POINTS = "Loading more entry points...";
+export declare const NO_DATA_AVAILABLE_CONSULT_TRANSFER = "No data available for consult transfer.";
+export declare const VIA_SEARCH_SUFFIX = " via search";
+export declare const DEFAULT_PAGE_SIZE = 25;
 export declare const NO_CUSTOMER_NAME = "No Customer Name";
 export declare const NO_CALLER_ID = "No Caller ID";
 export declare const NO_PHONE_NUMBER = "No Phone Number";

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

@@ -1,4 +1,4 @@
-import { ILogger, ITask, IContactCenter, IWrapupCode, BuddyDetails, DestinationType, ContactServiceQueue } from '@webex/cc-store';
+import { ILogger, ITask, IContactCenter, IWrapupCode, BuddyDetails, DestinationType, ContactServiceQueue, AddressBookEntry, EntryPointRecord, FetchPaginatedList, Participant } from '@webex/cc-store';
 type Enum<T extends Record<string, unknown>> = T[keyof T];
 /**
  * Interface representing the TaskProps of a user.
@@ -95,9 +95,13 @@ export interface TaskProps {
      * The logger instance from SDK
      */
     logger: ILogger;
+    /**
+     * Agent ID of the logged-in user
+     */
+    agentId: string;
 }
-export type IncomingTaskComponentProps = Pick<TaskProps, 'isBrowser' | 'accept' | 'reject'> & Partial<Pick<TaskProps, 'incomingTask'>>;
-export type TaskListComponentProps = Pick<TaskProps, 'isBrowser' | 'acceptTask' | 'declineTask' | 'onTaskSelect' | 'logger'> & Partial<Pick<TaskProps, 'currentTask' | 'taskList'>>;
+export type IncomingTaskComponentProps = Pick<TaskProps, 'isBrowser' | 'accept' | 'reject' | 'logger'> & Partial<Pick<TaskProps, 'incomingTask'>>;
+export type TaskListComponentProps = Pick<TaskProps, 'isBrowser' | 'acceptTask' | 'declineTask' | 'onTaskSelect' | 'logger' | 'agentId'> & Partial<Pick<TaskProps, 'currentTask' | 'taskList'>>;
 /**
  * Interface representing the properties for control actions on a task.
  */
@@ -236,29 +240,31 @@ export interface ControlProps {
      * @param destinationType
      * @returns
      */
-    consultCall: (consultDestination: string, destinationType: DestinationType) => void;
+    consultCall: (consultDestination: string, destinationType: DestinationType, allowParticipantsToInteract: boolean) => void;
     /**
-     * Function to end the consult call.
+     * Function to merge the consult call in a conference.
      */
-    endConsultCall: () => void;
+    consultConference: () => void;
     /**
-     * Function to transfer the consult call to a destination.
-     * @param destination - The destination to transfer the consult call to.
-     * @param destinationType - The type of destination.
+     * Function to switch to conference call.
+     */
+    switchToMainCall: () => void;
+    /**
+     * Function to switch to consult call.
      */
-    consultTransfer: (destination: string, destinationType: DestinationType) => void;
+    switchToConsult: () => void;
     /**
-     * Flag to determine if the consult call is connecting.
+     * Function to exit Conference
      */
-    consultInitiated: boolean;
+    exitConference: () => void;
     /**
-     * Flag to determine if the consult call is connecting.
+     * Function to end the consult call.
      */
-    consultCompleted: boolean;
+    endConsultCall: () => void;
     /**
-     * Flag to determine if the consult call is accepted.
+     * Function to transfer the consult call to a already established consult.
      */
-    consultAccepted: boolean;
+    consultTransfer: () => void;
     /**
      * Timestamp when the consult call started.
      */
@@ -268,15 +274,6 @@ export interface ControlProps {
      * This is used to play audio for the call control.
      */
     callControlAudio: MediaStream | null;
-    /**
-     * ID of the consulting agent
-     */
-    consultAgentId: string;
-    /**
-     * Function to set the consulting agent ID
-     * @param agentId - The ID of the consulting agent.
-     */
-    setConsultAgentId: (agentId: string) => void;
     /**
      * Name of the consulting agent.
      */
@@ -324,6 +321,10 @@ export interface ControlProps {
      * Flag to determine if the consulting to queue is enabled for the agent
      */
     allowConsultToQueue: boolean;
+    /**
+     * Flag to enable or disable conference feature
+     */
+    conferenceEnabled: boolean;
     /**
      * Function to set the last target type
      */
@@ -332,27 +333,46 @@ export interface ControlProps {
      * Function to set the last target type
      */
     setLastTargetType: (targetType: 'queue' | 'agent') => void;
-    controlVisibility: {
-        accept: boolean;
-        decline: boolean;
-        end: boolean;
-        muteUnmute: boolean;
-        holdResume: boolean;
-        consult: boolean;
-        transfer: boolean;
-        conference: boolean;
-        wrapup: boolean;
-        pauseResumeRecording: boolean;
-        endConsult: boolean;
-        recordingIndicator: boolean;
-    };
+    controlVisibility: ControlVisibility;
     secondsUntilAutoWrapup?: number;
     /**
      * Function to cancel the auto wrap-up timer.
      */
     cancelAutoWrapup: () => void;
+    /**
+     * List of participants in the conference excluding the agent themselves.
+     */
+    conferenceParticipants: Participant[];
+    /** Fetch paginated address book entries for dial numbers */
+    getAddressBookEntries?: FetchPaginatedList<AddressBookEntry>;
+    /** Fetch paginated entry points */
+    getEntryPoints?: FetchPaginatedList<EntryPointRecord>;
+    /** Fetch paginated queues (filtered by media type in store) */
+    getQueuesFetcher?: FetchPaginatedList<ContactServiceQueue>;
+    /**
+     * Options to configure consult/transfer popover behavior.
+     */
+    consultTransferOptions?: ConsultTransferOptions;
+    /**
+     * Agent ID of the logged-in user
+     */
+    agentId: string;
 }
-export type CallControlComponentProps = Pick<ControlProps, 'currentTask' | 'wrapupCodes' | 'toggleHold' | 'toggleRecording' | 'toggleMute' | 'isMuted' | 'endCall' | 'wrapupCall' | 'isHeld' | 'setIsHeld' | 'isRecording' | 'setIsRecording' | 'buddyAgents' | 'loadBuddyAgents' | 'transferCall' | 'consultCall' | 'endConsultCall' | 'consultInitiated' | 'consultTransfer' | 'consultCompleted' | 'consultAccepted' | 'consultStartTimeStamp' | 'callControlAudio' | 'consultAgentName' | 'setConsultAgentName' | 'consultAgentId' | 'setConsultAgentId' | 'holdTime' | 'callControlClassName' | 'callControlConsultClassName' | 'startTimestamp' | 'queues' | 'loadQueues' | 'isEndConsultEnabled' | 'allowConsultToQueue' | 'lastTargetType' | 'setLastTargetType' | 'controlVisibility' | 'logger' | 'secondsUntilAutoWrapup' | 'cancelAutoWrapup'>;
+export type CallControlComponentProps = Pick<ControlProps, 'currentTask' | 'wrapupCodes' | 'toggleHold' | 'toggleRecording' | 'toggleMute' | 'isMuted' | 'endCall' | 'wrapupCall' | 'isRecording' | 'setIsRecording' | 'buddyAgents' | 'loadBuddyAgents' | 'transferCall' | 'consultCall' | 'consultConference' | 'switchToMainCall' | 'switchToConsult' | 'exitConference' | 'endConsultCall' | 'consultTransfer' | 'consultStartTimeStamp' | 'callControlAudio' | 'consultAgentName' | 'setConsultAgentName' | 'holdTime' | 'callControlClassName' | 'callControlConsultClassName' | 'startTimestamp' | 'allowConsultToQueue' | 'lastTargetType' | 'setLastTargetType' | 'controlVisibility' | 'logger' | 'secondsUntilAutoWrapup' | 'cancelAutoWrapup' | 'conferenceParticipants' | 'getAddressBookEntries' | 'getEntryPoints' | 'getQueuesFetcher' | 'consultTransferOptions'>;
+export type OutdialAniEntry = {
+    /** Unique identifier for the ANI entry */
+    id: string;
+    /** Display name for the ANI entry */
+    name: string;
+    /** Phone number associated with this ANI entry */
+    number: string;
+    /** Related links for this ANI entry */
+    links: string[];
+    /** Timestamp when this entry was created (Unix timestamp in milliseconds) */
+    createdTime: number;
+    /** Timestamp when this entry was last updated (Unix timestamp in milliseconds) */
+    lastUpdatedTime: number;
+};
 /**
  * Interface representing the properties for OutdialCall component.
  */
@@ -360,7 +380,11 @@ export interface OutdialCallProps {
     /**
      * Function to start outdial call.
      */
-    startOutdial: (destination: string) => void;
+    startOutdial: (destination: string, origin?: string) => void;
+    /**
+     * Function to get a list of Outdial ANI entries.
+     */
+    getOutdialANIEntries: () => Promise<OutdialAniEntry[]>;
     /**
      * CC SDK Instance.
      */
@@ -370,7 +394,7 @@ export interface OutdialCallProps {
      */
     logger: ILogger;
 }
-export type OutdialCallComponentProps = Pick<OutdialCallProps, 'startOutdial'>;
+export type OutdialCallComponentProps = Pick<OutdialCallProps, 'logger' | 'startOutdial' | 'getOutdialANIEntries'>;
 /**
  * Interface representing the properties for CallControlListItem component.
  */
@@ -382,6 +406,17 @@ export interface ConsultTransferListComponentProps {
     className?: string;
     logger: ILogger;
 }
+/**
+ * Interface representing the properties for CallControlDialNumber component.
+ */
+export interface ConsultTransferDialNumberComponentProps {
+    title: string;
+    subtitle?: string;
+    buttonIcon: string;
+    onButtonPress: (dialNumber: string) => void;
+    className?: string;
+    logger: ILogger;
+}
 /**
  * Interface representing the properties for ConsultTransferPopover component.
  */
@@ -389,10 +424,17 @@ export interface ConsultTransferPopoverComponentProps {
     heading: string;
     buttonIcon: string;
     buddyAgents: BuddyDetails[];
-    queues?: ContactServiceQueue[];
-    onAgentSelect?: (agentId: string, agentName: string) => void;
-    onQueueSelect?: (queueId: string, queueName: string) => void;
+    getAddressBookEntries?: FetchPaginatedList<AddressBookEntry>;
+    getEntryPoints?: FetchPaginatedList<EntryPointRecord>;
+    getQueues?: FetchPaginatedList<ContactServiceQueue>;
+    onAgentSelect: (agentId: string, agentName: string, allowParticipantsToInteract: boolean) => void;
+    onQueueSelect: (queueId: string, queueName: string, allowParticipantsToInteract: boolean) => void;
+    onEntryPointSelect: (entryPointId: string, entryPointName: string, allowParticipantsToInteract: boolean) => void;
+    onDialNumberSelect: (dialNumber: string, allowParticipantsToInteract: boolean) => void;
     allowConsultToQueue: boolean;
+    /** Options governing popover visibility/behavior */
+    consultTransferOptions?: ConsultTransferOptions;
+    isConferenceInProgress?: boolean;
     logger: ILogger;
 }
 /**
@@ -401,20 +443,19 @@ export interface ConsultTransferPopoverComponentProps {
 export interface CallControlConsultComponentsProps {
     agentName: string;
     startTimeStamp: number;
-    onTransfer?: () => void;
-    endConsultCall?: () => void;
-    consultCompleted: boolean;
-    isAgentBeingConsulted: boolean;
-    isEndConsultEnabled: boolean;
+    consultTransfer: () => void;
+    endConsultCall: () => void;
+    consultConference: () => void;
+    switchToMainCall: () => void;
     logger: ILogger;
-    muteUnmute: boolean;
     isMuted: boolean;
-    onToggleConsultMute?: () => void;
+    controlVisibility: ControlVisibility;
+    toggleConsultMute: () => void;
 }
 /**
  * Type representing the possible menu types in call control.
  */
-export type CallControlMenuType = 'Consult' | 'Transfer';
+export type CallControlMenuType = 'Consult' | 'Transfer' | 'ExitConference';
 export declare const MEDIA_CHANNEL: {
     readonly EMAIL: "email";
     readonly CHAT: "chat";
@@ -436,6 +477,54 @@ export interface AutoWrapupTimerProps {
     secondsUntilAutoWrapup: number;
     allowCancelAutoWrapup?: boolean;
     handleCancelWrapup: () => void;
+    logger?: ILogger;
+}
+export interface CallControlButton {
+    id: string;
+    icon: string;
+    onClick?: () => void;
+    tooltip: string;
+    className: string;
+    disabled: boolean;
+    isVisible: boolean;
+    menuType?: CallControlMenuType;
+    dataTestId?: string;
+}
+export type Visibility = {
+    isVisible: boolean;
+    isEnabled: boolean;
+};
+export interface ControlVisibility {
+    accept: Visibility;
+    decline: Visibility;
+    end: Visibility;
+    muteUnmute: Visibility;
+    muteUnmuteConsult: Visibility;
+    holdResume: Visibility;
+    consult: Visibility;
+    transfer: Visibility;
+    conference: Visibility;
+    wrapup: Visibility;
+    pauseResumeRecording: Visibility;
+    endConsult: Visibility;
+    recordingIndicator: Visibility;
+    exitConference: Visibility;
+    mergeConference: Visibility;
+    consultTransfer: Visibility;
+    mergeConferenceConsult: Visibility;
+    consultTransferConsult: Visibility;
+    switchToMainCall: Visibility;
+    switchToConsult: Visibility;
+    isConferenceInProgress: boolean;
+    isConsultInitiated: boolean;
+    isConsultInitiatedAndAccepted: boolean;
+    isConsultReceived: boolean;
+    isConsultInitiatedOrAccepted: boolean;
+    isHeld: boolean;
+    consultCallHeld: boolean;
+}
+export interface MediaTypeInfo {
+    labelName: string;
 }
 export interface TaskComponentData {
     currentMediaType: {
@@ -494,4 +583,52 @@ export declare enum TaskQueue {
     VIP = "vip",
     ESCALATION = "escalation"
 }
+export interface TimerUIState {
+    isUrgent: boolean;
+    containerClassName: string;
+    iconClassName: string;
+    iconName: string;
+    formattedTime: string;
+}
+/**
+ * Categories displayed in Consult/Transfer popover.
+ */
+export type CategoryType = 'Agents' | 'Queues' | 'Dial Number' | 'Entry Point';
+/** Category string constants to avoid typos and ease reuse */
+export declare const CATEGORY_DIAL_NUMBER: CategoryType;
+export declare const CATEGORY_ENTRY_POINT: CategoryType;
+export declare const CATEGORY_QUEUES: CategoryType;
+export declare const CATEGORY_AGENTS: CategoryType;
+/**
+ * Parameters for `useConsultTransferPopover` hook.
+ */
+export type UseConsultTransferParams = {
+    showDialNumberTab: boolean;
+    showEntryPointTab: boolean;
+    getAddressBookEntries?: FetchPaginatedList<AddressBookEntry>;
+    getEntryPoints?: FetchPaginatedList<EntryPointRecord>;
+    getQueues?: FetchPaginatedList<ContactServiceQueue>;
+    logger?: ILogger;
+};
+/**
+ * Options to configure Consult/Transfer popover behavior and visibility.
+ */
+export interface ConsultTransferOptions {
+    /** Show the Dial Number tab. Defaults to true. */
+    showDialNumberTab?: boolean;
+    /** Show the Entry Point tab. Defaults to true. */
+    showEntryPointTab?: boolean;
+}
+/**
+ * Interface for button configuration
+ */
+export interface ButtonConfig {
+    key: string;
+    icon: string;
+    onClick: () => void;
+    tooltip: string;
+    className: string;
+    disabled?: boolean;
+    isVisible: boolean;
+}
 export {};