@webex/cc-task 1.28.0-ccconnectors.1

package/dist/types/CallControl/call-control.presentational.d.ts

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

package/dist/types/CallControl/index.d.ts

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

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

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

package/dist/types/IncomingTask/index.d.ts

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

package/dist/types/TaskList/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const TaskList: React.FunctionComponent<{}>;
+export { TaskList };

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

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

package/dist/types/helper.d.ts

@@ -0,0 +1,25 @@
+import { ITask } from '@webex/plugin-cc';
+import { useCallControlProps, UseTaskListProps, UseTaskProps } from './task.types';
+export declare const useTaskList: (props: UseTaskListProps) => {
+    taskList: ITask[];
+    acceptTask: (task: ITask) => void;
+    declineTask: (task: ITask) => void;
+    isBrowser: boolean;
+};
+export declare const useIncomingTask: (props: UseTaskProps) => {
+    incomingTask: any;
+    isAnswered: boolean;
+    isEnded: boolean;
+    accept: () => void;
+    decline: () => void;
+    isBrowser: boolean;
+};
+export declare const useCallControl: (props: useCallControlProps) => {
+    currentTask: ITask;
+    audioRef: import("react").MutableRefObject<HTMLAudioElement>;
+    endCall: () => void;
+    toggleHold: (hold: boolean) => void;
+    toggleRecording: (pause: boolean) => void;
+    wrapupCall: (wrapUpReason: string, auxCodeId: string) => void;
+    wrapupRequired: boolean;
+};

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+import { IncomingTask } from './IncomingTask/index';
+import { TaskList } from './TaskList';
+import { CallControl } from './CallControl';
+export { IncomingTask, TaskList, CallControl };

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

@@ -0,0 +1,156 @@
+import { ITask, IContactCenter } from '@webex/plugin-cc';
+import { ILogger, 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
+     */
+    selectedLoginOption: string;
+    /**
+     * List of tasks
+     */
+    taskList: ITask[];
+    /**
+     * The logger instance from SDK
+     */
+    logger: ILogger;
+}
+export type UseTaskProps = Pick<TaskProps, 'cc' | 'onAccepted' | 'onDeclined' | 'selectedLoginOption' | 'logger'>;
+export type UseTaskListProps = Pick<TaskProps, 'cc' | 'selectedLoginOption' | 'onTaskAccepted' | 'onTaskDeclined' | 'logger'>;
+export type IncomingTaskPresentationalProps = Pick<TaskProps, 'incomingTask' | 'isBrowser' | 'isAnswered' | 'isEnded' | 'accept' | 'decline'>;
+export type IncomingTaskProps = Pick<TaskProps, 'onAccepted' | 'onDeclined'>;
+export type TaskListProps = Pick<TaskProps, 'onTaskAccepted' | 'onTaskDeclined'>;
+export type TaskListPresentationalProps = Pick<TaskProps, 'currentTask' | 'taskList' | 'isBrowser' | 'acceptTask' | 'declineTask'>;
+export declare enum TASK_EVENTS {
+    TASK_INCOMING = "task:incoming",
+    TASK_ASSIGNED = "task:assigned",
+    TASK_MEDIA = "task:media",
+    TASK_HOLD = "task:hold",
+    TASK_UNHOLD = "task:unhold",
+    TASK_CONSULT = "task:consult",
+    TASK_CONSULT_END = "task:consultEnd",
+    TASK_CONSULT_ACCEPT = "task:consultAccepted",
+    TASK_PAUSE = "task:pause",
+    TASK_RESUME = "task:resume",
+    TASK_END = "task:end",
+    TASK_WRAPUP = "task:wrapup"
+}
+/**
+ * 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: () => 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 with a boolean parameter.
+     * @param pause - Boolean indicating whether to pause (true) or resume (false) recording.
+     */
+    toggleRecording: (pause: boolean) => 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;
+}
+export type CallControlProps = Pick<ControlProps, 'onHoldResume' | 'onEnd' | 'onWrapUp'>;
+export type CallControlPresentationalProps = Pick<ControlProps, 'currentTask' | 'audioRef' | 'wrapupCodes' | 'wrapupRequired' | 'toggleHold' | 'toggleRecording' | 'endCall' | 'wrapupCall'>;
+export type useCallControlProps = Pick<ControlProps, 'currentTask' | 'onHoldResume' | 'onEnd' | 'onWrapUp' | 'logger'>;

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@webex/cc-task",
+  "description": "Webex Contact Center Widgets: Task",
+  "version": "1.28.0-ccconnectors.1",
+  "main": "dist/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/",
+    "package.json"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist && rm -rf node_modules",
+    "clean:dist": "rm -rf dist",
+    "build": "yarn run -T tsc",
+    "build:src": "yarn run clean:dist && webpack",
+    "build:watch": "webpack --watch",
+    "test:unit": "jest --coverage"
+  },
+  "dependencies": {
+    "@webex/cc-store": "1.28.0-ccconnectors.1",
+    "mobx-react-lite": "^4.1.0",
+    "webex": "3.7.0-wxcc.5"
+  },
+  "devDependencies": {
+    "@babel/core": "7.25.2",
+    "@babel/preset-env": "7.25.4",
+    "@babel/preset-react": "7.24.7",
+    "@babel/preset-typescript": "7.25.9",
+    "@testing-library/dom": "10.4.0",
+    "@testing-library/jest-dom": "6.6.2",
+    "@testing-library/react": "16.0.1",
+    "@types/jest": "29.5.14",
+    "@types/react-test-renderer": "18",
+    "babel-jest": "29.7.0",
+    "babel-loader": "9.2.1",
+    "file-loader": "6.2.0",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "ts-loader": "9.5.1",
+    "typescript": "5.6.3",
+    "webpack": "5.94.0",
+    "webpack-cli": "5.1.4",
+    "webpack-merge": "6.0.1"
+  },
+  "peerDependencies": {
+    "@emotion/react": ">=11.14.0",
+    "@emotion/styled": ">=11.14.0",
+    "@mui/material": ">=6.4.2",
+    "react": ">=18.3.1",
+    "react-dom": ">=18.3.1"
+  },
+  "jest": {
+    "testEnvironment": "jsdom",
+    "testMatch": [
+      "**/tests/**/*.ts",
+      "**/tests/**/*.tsx"
+    ],
+    "moduleNameMapper": {
+      "^.+\\.(css|less|scss)$": "babel-jest"
+    }
+  },
+  "stableVersion": "1.28.0-ccwidgets.13"
+}