@webex/cc-components 1.28.0-ccwidgets.36 → 1.28.0-ccwidgets.38

package/dist/types/components/StationLogin/station-login.types.d.ts

@@ -0,0 +1,80 @@
+import { IContactCenter, StationLoginSuccess, StationLogoutSuccess, Team } from '@webex/plugin-cc';
+import { ILogger } from '@webex/cc-store';
+/**
+ * Interface representing the properties for the Station Login component.
+ */
+export interface IStationLoginProps {
+    /**
+     * Webex instance.
+     */
+    cc: IContactCenter;
+    /**
+     * Array of the team IDs that agent belongs to
+     */
+    teams: Team[];
+    /**
+     * Station login options available for the agent
+     */
+    loginOptions: string[];
+    /**
+     * Handler to initiate the agent login
+     */
+    login: () => void;
+    /**
+     * Handler for agent logout
+     */
+    logout: () => void;
+    /**
+     * Response data received on agent login success
+     */
+    loginSuccess?: StationLoginSuccess;
+    /**
+     * Error received on agent login failure
+     */
+    loginFailure?: Error;
+    /**
+     * Response data received on agent login success
+     */
+    logoutSuccess?: StationLogoutSuccess;
+    /**
+     * Flag to indicate if the agent is logged in
+     */
+    isAgentLoggedIn: boolean;
+    /**
+     * The selected device type for agent login
+     */
+    deviceType: string;
+    /**
+     * Callback function to be invoked once the agent login is successful
+     */
+    onLogin?: () => void;
+    /**
+     * Callback function to be invoked once the agent login is successful
+     */
+    onLogout?: () => void;
+    /**
+     * Handler to set device type
+     */
+    setDeviceType: (deviceType: string) => void;
+    /**
+     * Handler to set the entered dial number
+     */
+    setDialNumber: (dn: string) => void;
+    /**
+     * Handler to set the selected agent team
+     */
+    setTeam: (team: string) => void;
+    /**
+     * The logger instance from SDK
+     */
+    logger: ILogger;
+    /**
+     * Handler to relogin the agent when the agent is already logged in
+     */
+    handleContinue: () => void;
+    /**
+     * Flag to indicate if the alert should be shown
+     */
+    showMultipleLoginAlert: boolean;
+}
+export type StationLoginComponentProps = Pick<IStationLoginProps, 'teams' | 'loginOptions' | 'login' | 'logout' | 'loginSuccess' | 'loginFailure' | 'logoutSuccess' | 'setDeviceType' | 'setDialNumber' | 'setTeam' | 'isAgentLoggedIn' | 'handleContinue' | 'deviceType' | 'showMultipleLoginAlert'>;

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

@@ -0,0 +1,5 @@
+import React from 'react';
+import { CallControlComponentProps } from '../task.types';
+import './call-control.styles.scss';
+declare function CallControlComponent(props: CallControlComponentProps): React.JSX.Element;
+export default CallControlComponent;

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

@@ -0,0 +1,4 @@
+import React from 'react';
+import { IncomingTaskComponentProps } from '../task.types';
+declare const IncomingTaskComponent: React.FunctionComponent<IncomingTaskComponentProps>;
+export default IncomingTaskComponent;

package/dist/types/components/{OutdialCall/out-dial-call.d.ts → task/OutdialCall/outdial-call.d.ts}

@@ -1,5 +1,5 @@
 import React from 'react';
-import { OutdialCallComponentProps } from './out-dial-call.types';
-import './out-dial-call.styles.scss';
+import { OutdialCallComponentProps } from '../task.types';
+import './outdial-call.style.scss';
 declare const OutdialCallComponent: React.FunctionComponent<OutdialCallComponentProps>;
 export default OutdialCallComponent;

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

@@ -0,0 +1,17 @@
+import React from 'react';
+import { PressEvent } from '@react-types/shared';
+import './styles.scss';
+interface TaskProps {
+    title?: string;
+    state?: string;
+    startTimeStamp?: number;
+    ronaTimeout?: number;
+    selected?: boolean;
+    isIncomingTask?: boolean;
+    queue?: string;
+    acceptTask?: (e: PressEvent) => void;
+    declineTask?: (e: PressEvent) => void;
+    isBrowser?: boolean;
+}
+declare const Task: React.FC<TaskProps>;
+export default Task;

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

@@ -0,0 +1,5 @@
+import React from 'react';
+import { TaskListComponentProps } from '../task.types';
+import './styles.scss';
+declare const TaskListComponent: React.FunctionComponent<TaskListComponentProps>;
+export default TaskListComponent;

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

@@ -0,0 +1,8 @@
+import React from 'react';
+interface TaskTimerProps {
+    startTimeStamp?: number;
+    countdown?: boolean;
+    ronaTimeout?: number;
+}
+declare const TaskTimer: React.FC<TaskTimerProps>;
+export default TaskTimer;

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

@@ -0,0 +1,177 @@
+import { ILogger, ITask, IContactCenter, WrapupCodes } from '@webex/cc-store';
+/**
+ * Interface representing the TaskProps of a user.
+ */
+export interface TaskProps {
+    /**
+     * currentTask of the agent.
+     */
+    currentTask: ITask;
+    /**
+     * Incoming task on the incoming task widget
+     */
+    incomingTask: ITask;
+    /**
+     * CC SDK Instance.
+     */
+    cc: IContactCenter;
+    /**
+     * Handler for task accepted
+     */
+    onAccepted?: () => void;
+    /**
+     * Handler for task declined
+     */
+    onDeclined?: () => void;
+    /**
+     * Handler for task accepted in TaskList
+     */
+    onTaskAccepted?: (task: ITask) => void;
+    /**
+     * Handler for task declined in TaskList
+     */
+    onTaskDeclined?: (task: ITask) => void;
+    /**
+     * accept incoming task action
+     */
+    accept: () => void;
+    /**
+     * decline incoming task action
+     */
+    decline: () => void;
+    /**
+     * accept task from task list
+     */
+    acceptTask: (task: ITask) => void;
+    /**
+     * decline task from tasklist
+     */
+    declineTask: (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
+     */
+    isAnswered: boolean;
+    /**
+     * Flag to determine if the task is ended
+     */
+    isEnded: boolean;
+    /**
+     * Selected login option
+     */
+    deviceType: string;
+    /**
+     * List of tasks
+     */
+    taskList: ITask[];
+    /**
+     * The logger instance from SDK
+     */
+    logger: ILogger;
+}
+export type IncomingTaskComponentProps = Pick<TaskProps, 'incomingTask' | 'isBrowser' | 'accept' | 'decline'>;
+export type TaskListComponentProps = Pick<TaskProps, 'currentTask' | 'taskList' | 'isBrowser' | 'acceptTask' | 'declineTask'>;
+/**
+ * Interface representing the properties for control actions on a task.
+ */
+export interface ControlProps {
+    /**
+     * Audio reference
+     */
+    audioRef: React.RefObject<HTMLAudioElement>;
+    /**
+     * The current task being handled.
+     */
+    currentTask: ITask;
+    /**
+     * Function to handle hold/resume actions.
+     */
+    onHoldResume?: () => void;
+    /**
+     * Function to handle ending the task.
+     */
+    onEnd?: () => void;
+    /**
+     * Function to handle wrapping up the task.
+     */
+    onWrapUp?: ({ task, wrapUpReason }: {
+        task: ITask;
+        wrapUpReason: string;
+    }) => void;
+    /**
+     * Logger instance for logging purposes.
+     */
+    logger: ILogger;
+    /**
+     * Array of wrap-up codes.
+     * TODO: Expose this type from SDK.
+     */
+    wrapupCodes: WrapupCodes[];
+    /**
+     * Indicates if wrap-up is required.
+     */
+    wrapupRequired: boolean;
+    /**
+     * Function to handle hold/resume actions with a boolean parameter.
+     * @param hold - Boolean indicating whether to hold (true) or resume (false).
+     */
+    toggleHold: (hold: boolean) => void;
+    /**
+     * Function to handle pause/resume recording actions.
+     */
+    toggleRecording: () => void;
+    /**
+     * Function to handle ending the call.
+     */
+    endCall: () => void;
+    /**
+     * Function to handle wrapping up the call with a reason and ID.
+     * @param wrapupReason - The reason for wrapping up the call.
+     * @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
+     */
+    isHeld: boolean;
+    /**
+     * Function to set the held status of the task.
+     * @param isHeld - Boolean indicating whether the task is held.
+     */
+    setIsHeld: (isHeld: boolean) => void;
+    /**
+     * Flag to determine if the task is being recorded
+     */
+    isRecording: boolean;
+    /**
+     * Function to set the recording status of the task.
+     * @param isRecording - Boolean indicating whether the task is being recorded.
+     */
+    setIsRecording: (isRecording: boolean) => void;
+}
+export type CallControlComponentProps = Pick<ControlProps, 'currentTask' | 'audioRef' | 'wrapupCodes' | 'wrapupRequired' | 'toggleHold' | 'toggleRecording' | 'endCall' | 'wrapupCall' | 'isHeld' | 'setIsHeld' | 'isRecording' | 'setIsRecording'>;
+/**
+ * Interface representing the properties for OutdialCall component.
+ */
+export interface OutdialCallProps {
+    /**
+     * Function to start outdial call.
+     */
+    startOutdial: (destination: string) => void;
+    /**
+     * CC SDK Instance.
+     */
+    cc: IContactCenter;
+    /**
+     * Logger instance for logging purpose.
+     */
+    logger: ILogger;
+}
+export type OutdialCallComponentProps = Pick<OutdialCallProps, 'startOutdial'>;

package/dist/types/index.d.ts

@@ -1,5 +1,10 @@
 import UserStateComponent from './components/UserState/user-state';
-import { IUserState } from './components/UserState/user-state.types';
-import OutdialCallComponent from './components/OutdialCall/out-dial-call';
-import { IOutdialCall } from './components/OutdialCall/out-dial-call.types';
-export { UserStateComponent, type IUserState, OutdialCallComponent, type IOutdialCall };
+import StationLoginComponent from './components/StationLogin/station-login';
+import CallControlComponent from './components/task/CallControl/call-control';
+import IncomingTaskComponent from './components/task/IncomingTask/incoming-task';
+import TaskListComponent from './components/task/TaskList/task-list';
+import OutdialCallComponent from './components/task/OutdialCall/outdial-call';
+export { UserStateComponent, StationLoginComponent, CallControlComponent, IncomingTaskComponent, TaskListComponent, OutdialCallComponent, };
+export * from './components/StationLogin/station-login.types';
+export * from './components/UserState/user-state.types';
+export * from './components/task/task.types';