feat(plugin-cc): refactored-voice-class (#4335)

Author: adhmenon

docs/samples/contact-center/app.js

@@ -221,13 +221,6 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
       const resp = await this.connectWebsocket();
       // Ensure 'dn' is always populated from 'defaultDn'
       resp.dn = resp.defaultDn;
-      const configFlags: ConfigFlags = {
-        isEndCallEnabled: this.agentConfig.isEndCallEnabled,
-        isEndConsultEnabled: this.agentConfig.isEndConsultEnabled,
-        webRtcEnabled: this.agentConfig.webRtcEnabled,
-        autoWrapup: this.agentConfig.wrapUpData?.wrapUpProps?.autoWrapup ?? false,
-      };
-      this.taskManager.setConfigFlags(configFlags);
       this.metricsManager.trackEvent(
         METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_SUCCESS,
         {
@@ -424,6 +417,13 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
           const agentId = data.agentId;
           const orgId = this.$webex.credentials.getOrgId();
           this.agentConfig = await this.services.config.getAgentConfig(orgId, agentId);
+          const configFlags: ConfigFlags = {
+            isEndCallEnabled: this.agentConfig.isEndCallEnabled,
+            isEndConsultEnabled: this.agentConfig.isEndConsultEnabled,
+            webRtcEnabled: this.agentConfig.webRtcEnabled,
+            autoWrapup: this.agentConfig.wrapUpData?.wrapUpProps?.autoWrapup ?? false,
+          };
+          this.taskManager.setConfigFlags(configFlags);
           LoggerProxy.log(`Agent config is fetched successfully`, {
             module: CC_FILE,
             method: METHODS.CONNECT_WEBSOCKET,

packages/@webex/plugin-cc/src/cc.ts

@@ -48,4 +48,9 @@ export const METHODS = {
   HANDLE_INCOMING_TASK: 'handleIncomingTask',
   HANDLE_TASK_HYDRATE: 'handleTaskHydrate',
   INCOMING_TASK_LISTENER: 'incomingTaskListener',
+  HOLD_RESUME: 'holdResume',
+  ACCEPT: 'accept',
+  REJECT: 'reject',
+  TRANSFER_CALL: 'transferCall',
+  COMPLETE_TRANSFER: 'completeTransfer',
 };

packages/@webex/plugin-cc/src/constants.ts

@@ -48,12 +48,12 @@ export default abstract class Task extends EventEmitter implements ITask {
 
   private initialiseUIControls() {
     this.taskUiControls = {
-      accept: new TaskButtonControl(true, true),
-      decline: new TaskButtonControl(true, true),
+      accept: new TaskButtonControl(false, false),
+      decline: new TaskButtonControl(false, false),
       hold: new TaskButtonControl(false, false),
       mute: new TaskButtonControl(false, false),
-      end: new TaskButtonControl(true, true),
-      transfer: new TaskButtonControl(true, true),
+      end: new TaskButtonControl(false, false),
+      transfer: new TaskButtonControl(false, false),
       consult: new TaskButtonControl(false, false),
       consultTransfer: new TaskButtonControl(false, false),
       endConsult: new TaskButtonControl(false, false),
@@ -68,6 +68,35 @@ export default abstract class Task extends EventEmitter implements ITask {
    */
   protected setUIControls() {}
 
+  /**
+   *
+   * @param methodName - The name of the method that is unsupported
+   * @throws Error
+   */
+  protected unsupportedMethodError(methodName: string) {
+    LoggerProxy.error(`Unsupported operation`, {
+      module: 'TASK',
+      method: methodName,
+    });
+    throw new Error(`Unsupported operation: ${methodName}`);
+  }
+
+  /**
+   * Apply visibility & enabled flags in one go.
+   * Usage: updateTaskUiControls({ hold: [true,true], end: [false,true] })
+   */
+  protected updateTaskUiControls(
+    config: Partial<Record<keyof typeof this.taskUiControls, [boolean, boolean]>>
+  ): void {
+    Object.entries(config).forEach(([k, [vis, en]]) => {
+      const ctl = this.taskUiControls[k as keyof typeof this.taskUiControls];
+      if (ctl) {
+        ctl.setVisiblity(vis);
+        ctl.setEnabled(en);
+      }
+    });
+  }
+
   /**
    * This method is used to update the task data.
    * @param updatedData - TaskData

packages/@webex/plugin-cc/src/services/task/Task.ts

@@ -95,7 +95,18 @@ export default class TaskManager extends EventEmitter {
         });
         switch (payload.data.type) {
           case CC_EVENTS.AGENT_CONTACT:
-            this.taskCollection[payload.data.interactionId] = task;
+            if (!task) {
+              // Re-create task if it does not exist
+              // This can happen when the task is created after the event is received (multi session)
+              task = TaskFactory.createTask(
+                this.contact,
+                this.webCallingService,
+                {...payload.data, isConsulted: false},
+                this.configFlags
+              );
+              this.taskCollection[payload.data.interactionId] = task;
+            }
+            this.updateTaskData(task, payload.data);
             this.emit(TASK_EVENTS.TASK_HYDRATE, task);
             break;
 
@@ -238,7 +249,11 @@ export default class TaskManager extends EventEmitter {
             task.emit(TASK_EVENTS.TASK_CONSULT_QUEUE_CANCELLED, task);
             break;
           case CC_EVENTS.AGENT_WRAPUP:
-            this.updateTaskData(task, payload.data);
+            this.updateTaskData(task, {
+              ...payload.data,
+              wrapUpRequired: true,
+            });
+            task.emit(TASK_EVENTS.TASK_END, task);
             break;
           case CC_EVENTS.AGENT_WRAPPEDUP:
             this.removeTaskFromCollection(task);

packages/@webex/plugin-cc/src/services/task/TaskManager.ts

@@ -1163,23 +1163,15 @@ export interface ITask extends EventEmitter {
  */
 export interface IVoice extends ITask {
   /**
-   * This is used to hold the task.
+   * This is used to hold or resume the task.
    * @returns Promise<TaskResponse>
    * @example
    * ```
-   * task.hold();
+   * task.holdResume();
    * ```
    */
-  hold(): Promise<TaskResponse>;
-  /**
-   * This is used to resume the task.
-   * @returns Promise<TaskResponse>
-   * @example
-   * ```
-   * task.resume();
-   * ```
-   */
-  resume(): Promise<TaskResponse>;
+  holdResume(): Promise<TaskResponse>;
+
   /**
    * This is used to consult the task.
    * @param consultPayload
@@ -1244,31 +1236,25 @@ export class TaskButtonControl {
   }
 
   /**
-   * Shows the button control.
-   */
-  show() {
-    this.visible = true;
-  }
-
-  /**
-   * Hides the button control.
-   */
-  hide() {
-    this.visible = false;
-  }
-
-  /**
-   * Enables the button control.
+   *
+   * @param visible - Indicates whether the button control is visible or not.
+   *
+   * This method sets the visibility.
+   * If `visible` is true, the button will be shown;
    */
-  enable() {
-    this.enabled = true;
+  setVisiblity(visible: boolean) {
+    this.visible = visible;
   }
 
   /**
-   * Disables the button control.
+   *
+   * @param enabled - Indicates whether the button control is enabled or not.
+   *
+   * This method sets the enabled state of the button control.
+   * If `enabled` is true, the button will be enabled; otherwise, it will be disabled.
    */
-  disable() {
-    this.enabled = false;
+  setEnabled(enabled: boolean) {
+    this.enabled = enabled;
   }
 }