@webex/contact-center 3.12.0-next.72 → 3.12.0-next.74

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (188) hide show
  1. package/AGENTS.md +438 -0
  2. package/ai-docs/README.md +131 -0
  3. package/ai-docs/RULES.md +455 -0
  4. package/ai-docs/patterns/event-driven-patterns.md +485 -0
  5. package/ai-docs/patterns/testing-patterns.md +480 -0
  6. package/ai-docs/patterns/typescript-patterns.md +365 -0
  7. package/ai-docs/templates/README.md +102 -0
  8. package/ai-docs/templates/documentation/create-agents-md.md +240 -0
  9. package/ai-docs/templates/documentation/create-architecture-md.md +295 -0
  10. package/ai-docs/templates/existing-service/bug-fix.md +254 -0
  11. package/ai-docs/templates/existing-service/feature-enhancement.md +450 -0
  12. package/ai-docs/templates/new-method/00-master.md +80 -0
  13. package/ai-docs/templates/new-method/01-requirements.md +232 -0
  14. package/ai-docs/templates/new-method/02-implementation.md +295 -0
  15. package/ai-docs/templates/new-method/03-tests.md +201 -0
  16. package/ai-docs/templates/new-method/04-validation.md +141 -0
  17. package/ai-docs/templates/new-service/00-master.md +109 -0
  18. package/ai-docs/templates/new-service/01-pre-questions.md +159 -0
  19. package/ai-docs/templates/new-service/02-code-generation.md +346 -0
  20. package/ai-docs/templates/new-service/03-integration.md +178 -0
  21. package/ai-docs/templates/new-service/04-test-generation.md +205 -0
  22. package/ai-docs/templates/new-service/05-validation.md +145 -0
  23. package/dist/cc.js +53 -38
  24. package/dist/cc.js.map +1 -1
  25. package/dist/config.js +6 -0
  26. package/dist/config.js.map +1 -1
  27. package/dist/constants.js +14 -1
  28. package/dist/constants.js.map +1 -1
  29. package/dist/index.js +13 -5
  30. package/dist/index.js.map +1 -1
  31. package/dist/metrics/behavioral-events.js +26 -0
  32. package/dist/metrics/behavioral-events.js.map +1 -1
  33. package/dist/metrics/constants.js +9 -3
  34. package/dist/metrics/constants.js.map +1 -1
  35. package/dist/services/ApiAiAssistant.js +74 -3
  36. package/dist/services/ApiAiAssistant.js.map +1 -1
  37. package/dist/services/config/Util.js +2 -2
  38. package/dist/services/config/Util.js.map +1 -1
  39. package/dist/services/config/types.js +25 -9
  40. package/dist/services/config/types.js.map +1 -1
  41. package/dist/services/core/Utils.js +74 -27
  42. package/dist/services/core/Utils.js.map +1 -1
  43. package/dist/services/core/websocket/WebSocketManager.js +2 -1
  44. package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
  45. package/dist/services/core/websocket/types.js.map +1 -1
  46. package/dist/services/index.js +1 -1
  47. package/dist/services/index.js.map +1 -1
  48. package/dist/services/task/Task.js +688 -0
  49. package/dist/services/task/Task.js.map +1 -0
  50. package/dist/services/task/TaskFactory.js +45 -0
  51. package/dist/services/task/TaskFactory.js.map +1 -0
  52. package/dist/services/task/TaskManager.js +725 -612
  53. package/dist/services/task/TaskManager.js.map +1 -1
  54. package/dist/services/task/TaskUtils.js +162 -26
  55. package/dist/services/task/TaskUtils.js.map +1 -1
  56. package/dist/services/task/constants.js +6 -1
  57. package/dist/services/task/constants.js.map +1 -1
  58. package/dist/services/task/digital/Digital.js +77 -0
  59. package/dist/services/task/digital/Digital.js.map +1 -0
  60. package/dist/services/task/state-machine/TaskStateMachine.js +837 -0
  61. package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -0
  62. package/dist/services/task/state-machine/actions.js +543 -0
  63. package/dist/services/task/state-machine/actions.js.map +1 -0
  64. package/dist/services/task/state-machine/constants.js +161 -0
  65. package/dist/services/task/state-machine/constants.js.map +1 -0
  66. package/dist/services/task/state-machine/guards.js +340 -0
  67. package/dist/services/task/state-machine/guards.js.map +1 -0
  68. package/dist/services/task/state-machine/index.js +53 -0
  69. package/dist/services/task/state-machine/index.js.map +1 -0
  70. package/dist/services/task/state-machine/types.js +54 -0
  71. package/dist/services/task/state-machine/types.js.map +1 -0
  72. package/dist/services/task/state-machine/uiControlsComputer.js +553 -0
  73. package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -0
  74. package/dist/services/task/taskDataNormalizer.js +99 -0
  75. package/dist/services/task/taskDataNormalizer.js.map +1 -0
  76. package/dist/services/task/types.js +168 -16
  77. package/dist/services/task/types.js.map +1 -1
  78. package/dist/services/task/voice/Voice.js +1042 -0
  79. package/dist/services/task/voice/Voice.js.map +1 -0
  80. package/dist/services/task/voice/WebRTC.js +149 -0
  81. package/dist/services/task/voice/WebRTC.js.map +1 -0
  82. package/dist/types/cc.d.ts +19 -18
  83. package/dist/types/config.d.ts +6 -0
  84. package/dist/types/constants.d.ts +14 -1
  85. package/dist/types/index.d.ts +11 -5
  86. package/dist/types/metrics/constants.d.ts +7 -1
  87. package/dist/types/services/ApiAiAssistant.d.ts +11 -3
  88. package/dist/types/services/config/types.d.ts +113 -9
  89. package/dist/types/services/core/Utils.d.ts +23 -10
  90. package/dist/types/services/core/websocket/WebSocketManager.d.ts +1 -0
  91. package/dist/types/services/core/websocket/types.d.ts +1 -1
  92. package/dist/types/services/index.d.ts +1 -1
  93. package/dist/types/services/task/Task.d.ts +157 -0
  94. package/dist/types/services/task/TaskFactory.d.ts +12 -0
  95. package/dist/types/services/task/TaskUtils.d.ts +46 -2
  96. package/dist/types/services/task/constants.d.ts +5 -0
  97. package/dist/types/services/task/digital/Digital.d.ts +22 -0
  98. package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +1144 -0
  99. package/dist/types/services/task/state-machine/actions.d.ts +10 -0
  100. package/dist/types/services/task/state-machine/constants.d.ts +107 -0
  101. package/dist/types/services/task/state-machine/guards.d.ts +90 -0
  102. package/dist/types/services/task/state-machine/index.d.ts +13 -0
  103. package/dist/types/services/task/state-machine/types.d.ts +267 -0
  104. package/dist/types/services/task/state-machine/uiControlsComputer.d.ts +9 -0
  105. package/dist/types/services/task/taskDataNormalizer.d.ts +10 -0
  106. package/dist/types/services/task/types.d.ts +551 -78
  107. package/dist/types/services/task/voice/Voice.d.ts +184 -0
  108. package/dist/types/services/task/voice/WebRTC.d.ts +53 -0
  109. package/dist/types/types.d.ts +92 -0
  110. package/dist/types/webex.d.ts +1 -0
  111. package/dist/types.js +85 -0
  112. package/dist/types.js.map +1 -1
  113. package/dist/webex.js +14 -2
  114. package/dist/webex.js.map +1 -1
  115. package/package.json +15 -12
  116. package/src/cc.ts +63 -43
  117. package/src/config.ts +6 -0
  118. package/src/constants.ts +14 -1
  119. package/src/index.ts +14 -5
  120. package/src/metrics/ai-docs/AGENTS.md +348 -0
  121. package/src/metrics/ai-docs/ARCHITECTURE.md +336 -0
  122. package/src/metrics/behavioral-events.ts +28 -0
  123. package/src/metrics/constants.ts +9 -4
  124. package/src/services/ApiAiAssistant.ts +104 -3
  125. package/src/services/agent/ai-docs/AGENTS.md +238 -0
  126. package/src/services/agent/ai-docs/ARCHITECTURE.md +302 -0
  127. package/src/services/ai-docs/AGENTS.md +384 -0
  128. package/src/services/config/Util.ts +2 -2
  129. package/src/services/config/ai-docs/AGENTS.md +253 -0
  130. package/src/services/config/ai-docs/ARCHITECTURE.md +424 -0
  131. package/src/services/config/types.ts +116 -10
  132. package/src/services/core/Utils.ts +85 -34
  133. package/src/services/core/ai-docs/AGENTS.md +379 -0
  134. package/src/services/core/ai-docs/ARCHITECTURE.md +696 -0
  135. package/src/services/core/websocket/WebSocketManager.ts +2 -0
  136. package/src/services/core/websocket/types.ts +1 -1
  137. package/src/services/index.ts +1 -1
  138. package/src/services/task/Task.ts +837 -0
  139. package/src/services/task/TaskFactory.ts +55 -0
  140. package/src/services/task/TaskManager.ts +738 -697
  141. package/src/services/task/TaskUtils.ts +205 -25
  142. package/src/services/task/ai-docs/AGENTS.md +455 -0
  143. package/src/services/task/ai-docs/ARCHITECTURE.md +585 -0
  144. package/src/services/task/constants.ts +5 -0
  145. package/src/services/task/digital/Digital.ts +95 -0
  146. package/src/services/task/state-machine/TaskStateMachine.ts +1077 -0
  147. package/src/services/task/state-machine/actions.ts +685 -0
  148. package/src/services/task/state-machine/ai-docs/AGENTS.md +495 -0
  149. package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +1135 -0
  150. package/src/services/task/state-machine/constants.ts +172 -0
  151. package/src/services/task/state-machine/guards.ts +406 -0
  152. package/src/services/task/state-machine/index.ts +28 -0
  153. package/src/services/task/state-machine/types.ts +241 -0
  154. package/src/services/task/state-machine/uiControlsComputer.ts +867 -0
  155. package/src/services/task/taskDataNormalizer.ts +137 -0
  156. package/src/services/task/types.ts +654 -85
  157. package/src/services/task/voice/Voice.ts +1267 -0
  158. package/src/services/task/voice/WebRTC.ts +187 -0
  159. package/src/types.ts +112 -1
  160. package/src/utils/AGENTS.md +276 -0
  161. package/src/webex.js +2 -0
  162. package/test/unit/spec/cc.ts +133 -3
  163. package/test/unit/spec/logger-proxy.ts +70 -0
  164. package/test/unit/spec/services/ApiAiAssistant.ts +122 -17
  165. package/test/unit/spec/services/WebCallingService.ts +7 -1
  166. package/test/unit/spec/services/config/index.ts +27 -27
  167. package/test/unit/spec/services/core/Utils.ts +335 -1
  168. package/test/unit/spec/services/core/websocket/WebSocketManager.ts +66 -40
  169. package/test/unit/spec/services/task/AutoWrapup.ts +63 -0
  170. package/test/unit/spec/services/task/Task.ts +477 -0
  171. package/test/unit/spec/services/task/TaskFactory.ts +62 -0
  172. package/test/unit/spec/services/task/TaskManager.ts +821 -1936
  173. package/test/unit/spec/services/task/TaskUtils.ts +206 -0
  174. package/test/unit/spec/services/task/digital/Digital.ts +105 -0
  175. package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +1825 -0
  176. package/test/unit/spec/services/task/state-machine/guards.ts +479 -0
  177. package/test/unit/spec/services/task/state-machine/types.ts +18 -0
  178. package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +2020 -0
  179. package/test/unit/spec/services/task/taskTestUtils.ts +87 -0
  180. package/test/unit/spec/services/task/voice/Voice.ts +631 -0
  181. package/test/unit/spec/services/task/voice/WebRTC.ts +235 -0
  182. package/umd/contact-center.min.js +2 -2
  183. package/umd/contact-center.min.js.map +1 -1
  184. package/dist/services/task/index.js +0 -1530
  185. package/dist/services/task/index.js.map +0 -1
  186. package/dist/types/services/task/index.d.ts +0 -650
  187. package/src/services/task/index.ts +0 -1806
  188. package/test/unit/spec/services/task/index.ts +0 -2205
@@ -0,0 +1,837 @@
1
+ import {EventEmitter} from 'events';
2
+ import {createActor} from 'xstate';
3
+ import type {ActorRefFrom, SnapshotFrom} from 'xstate';
4
+ import {
5
+ ITask,
6
+ TaskData,
7
+ TaskResponse,
8
+ WrapupPayLoad,
9
+ TaskId,
10
+ TransferPayLoad,
11
+ DESTINATION_TYPE,
12
+ TASK_EVENTS,
13
+ TaskUIControls,
14
+ ConsultEndPayload,
15
+ ConsultPayload,
16
+ ConsultTransferPayLoad,
17
+ ResumeRecordingPayload,
18
+ MEDIA_CHANNEL,
19
+ TASK_CHANNEL_TYPE,
20
+ VOICE_VARIANT,
21
+ CallId,
22
+ } from './types';
23
+ import {METHODS} from './constants';
24
+ import {CC_FILE, TASK_FILE} from '../../constants';
25
+ import {getErrorDetails} from '../core/Utils';
26
+ import routingContact from './contact';
27
+ import MetricsManager from '../../metrics/MetricsManager';
28
+ import {METRIC_EVENT_NAMES} from '../../metrics/constants';
29
+ import LoggerProxy from '../../logger-proxy';
30
+ import {createTaskStateMachine, TaskState} from './state-machine';
31
+ import type {
32
+ TaskEventPayload,
33
+ TaskStateMachine,
34
+ UIControlConfig,
35
+ TaskContext,
36
+ TaskActionsMap,
37
+ TaskActionArgs,
38
+ } from './state-machine';
39
+ import {
40
+ computeUIControls,
41
+ getDefaultUIControls,
42
+ haveUIControlsChanged,
43
+ } from './state-machine/uiControlsComputer';
44
+ import AutoWrapup from './AutoWrapup';
45
+ import {WrapupData} from '../config/types';
46
+
47
+ type UIControlConfigInput = Omit<UIControlConfig, 'channelType'> & {
48
+ channelType?: UIControlConfig['channelType'];
49
+ };
50
+
51
+ export default abstract class Task extends EventEmitter implements ITask {
52
+ protected contact: ReturnType<typeof routingContact>;
53
+ protected metricsManager: MetricsManager;
54
+ public stateMachineService?: ActorRefFrom<TaskStateMachine>;
55
+ public data: TaskData;
56
+ public webCallMap: Record<TaskId, CallId>;
57
+ public state?: SnapshotFrom<TaskStateMachine>;
58
+ private lastState?: TaskState;
59
+ protected currentUiControls: TaskUIControls;
60
+ protected uiControlConfig: UIControlConfig;
61
+ protected wrapupData?: WrapupData;
62
+ public autoWrapup?: AutoWrapup;
63
+ protected agentId?: string;
64
+
65
+ constructor(
66
+ contact: ReturnType<typeof routingContact>,
67
+ data: TaskData,
68
+ uiControlConfig: UIControlConfigInput,
69
+ wrapupData?: WrapupData,
70
+ agentId?: string
71
+ ) {
72
+ super();
73
+ this.contact = contact;
74
+ this.data = data;
75
+ const channelType = uiControlConfig.channelType ?? Task.resolveChannelType(data);
76
+ // Include agentId in the config for ownership checks (transfer conference)
77
+ this.uiControlConfig = {...uiControlConfig, channelType, agentId};
78
+ this.wrapupData = wrapupData;
79
+ this.agentId = agentId;
80
+ this.metricsManager = MetricsManager.getInstance();
81
+ this.webCallMap = {};
82
+ this.currentUiControls = getDefaultUIControls();
83
+ this.initializeStateMachine();
84
+ this.setupAutoWrapupTimer();
85
+ }
86
+
87
+ private static resolveChannelType(data: TaskData): UIControlConfig['channelType'] {
88
+ const mediaType = data?.interaction?.mediaType ?? MEDIA_CHANNEL.TELEPHONY;
89
+
90
+ return mediaType === MEDIA_CHANNEL.TELEPHONY
91
+ ? TASK_CHANNEL_TYPE.VOICE
92
+ : TASK_CHANNEL_TYPE.DIGITAL;
93
+ }
94
+
95
+ // Abstract methods that all child classes must implement
96
+ public abstract accept(): Promise<TaskResponse>;
97
+
98
+ // Voice-specific methods with default implementations that throw errors
99
+ // Voice class will override these with actual implementations
100
+ public async decline(): Promise<TaskResponse> {
101
+ this.unsupportedMethodError('decline');
102
+ }
103
+
104
+ public async pauseRecording(): Promise<TaskResponse> {
105
+ this.unsupportedMethodError('pauseRecording');
106
+ }
107
+
108
+ public async resumeRecording(
109
+ resumeRecordingPayload: ResumeRecordingPayload
110
+ ): Promise<TaskResponse> {
111
+ if (resumeRecordingPayload) {
112
+ // parameter intentionally unused
113
+ }
114
+ this.unsupportedMethodError('resumeRecording');
115
+ }
116
+
117
+ public async consult(consultPayload: ConsultPayload): Promise<TaskResponse> {
118
+ if (consultPayload) {
119
+ // parameter intentionally unused
120
+ }
121
+ this.unsupportedMethodError('consult');
122
+ }
123
+
124
+ public async endConsult(consultEndPayload: ConsultEndPayload): Promise<TaskResponse> {
125
+ if (consultEndPayload) {
126
+ // parameter intentionally unused
127
+ }
128
+ this.unsupportedMethodError('endConsult');
129
+ }
130
+
131
+ public async consultTransfer(
132
+ consultTransferPayload?: ConsultTransferPayLoad
133
+ ): Promise<TaskResponse> {
134
+ if (consultTransferPayload) {
135
+ // parameter intentionally unused
136
+ }
137
+ this.unsupportedMethodError('consultTransfer');
138
+ }
139
+
140
+ public async consultConference(): Promise<TaskResponse> {
141
+ this.unsupportedMethodError('consultConference');
142
+ }
143
+
144
+ public async exitConference(): Promise<TaskResponse> {
145
+ this.unsupportedMethodError('exitConference');
146
+ }
147
+
148
+ public async transferConference(): Promise<TaskResponse> {
149
+ this.unsupportedMethodError('transferConference');
150
+ }
151
+
152
+ public async switchCall(): Promise<TaskResponse> {
153
+ this.unsupportedMethodError('switchCall');
154
+ }
155
+
156
+ public async toggleMute(): Promise<void> {
157
+ this.unsupportedMethodError('toggleMute');
158
+ }
159
+
160
+ public unregisterWebCallListeners(): void {
161
+ // Default implementation - child classes can override
162
+ LoggerProxy.log('unregisterWebCallListeners called', {
163
+ module: CC_FILE,
164
+ method: 'unregisterWebCallListeners',
165
+ interactionId: this.data?.interactionId,
166
+ });
167
+ }
168
+
169
+ /**
170
+ * Cancel any in-progress auto wrap-up timer.
171
+ * Base implementation just clears the timer reference so subclasses inherit the behavior.
172
+ */
173
+ public cancelAutoWrapupTimer(): void {
174
+ if (this.autoWrapup) {
175
+ this.autoWrapup.clear();
176
+ this.autoWrapup = undefined;
177
+ LoggerProxy.log('Auto wrap-up timer cancelled', {
178
+ module: CC_FILE,
179
+ method: 'cancelAutoWrapupTimer',
180
+ interactionId: this.data?.interactionId,
181
+ });
182
+ }
183
+ }
184
+
185
+ // Voice tasks use holdResume(), but provide separate methods for interface compliance
186
+ public async hold(): Promise<TaskResponse> {
187
+ this.unsupportedMethodError('hold');
188
+ }
189
+
190
+ public async resume(): Promise<TaskResponse> {
191
+ this.unsupportedMethodError('resume');
192
+ }
193
+
194
+ public async holdResume(): Promise<TaskResponse> {
195
+ this.unsupportedMethodError('holdResume');
196
+ }
197
+
198
+ /**
199
+ * Latest UI controls derived from state machine state and context.
200
+ */
201
+ public get uiControls(): TaskUIControls {
202
+ return this.currentUiControls;
203
+ }
204
+
205
+ protected updateUiControls(forceEmit = false): void {
206
+ const nextControls = this.computeUIControls();
207
+ const shouldEmit = forceEmit || haveUIControlsChanged(this.currentUiControls, nextControls);
208
+ this.currentUiControls = nextControls;
209
+
210
+ if (shouldEmit) {
211
+ this.emit(TASK_EVENTS.TASK_UI_CONTROLS_UPDATED, this.currentUiControls);
212
+ }
213
+ }
214
+
215
+ /**
216
+ * Initialize the state machine
217
+ */
218
+ private initializeStateMachine(): void {
219
+ const machine: TaskStateMachine = createTaskStateMachine(this.uiControlConfig, {
220
+ actions: this.getStateMachineActionOverrides(),
221
+ });
222
+
223
+ this.stateMachineService = createActor(machine);
224
+
225
+ this.stateMachineService.subscribe((snapshot) => {
226
+ const previousState = this.lastState;
227
+ const currentState = snapshot.value as TaskState;
228
+ LoggerProxy.log(`State machine transition: ${previousState || 'N/A'} -> ${currentState}`, {
229
+ module: CC_FILE,
230
+ method: 'onTransition',
231
+ // @ts-ignore - snapshot may include event detail depending on XState version
232
+ eventType: (snapshot as any)?.event?.type,
233
+ });
234
+ this.lastState = currentState;
235
+ this.state = snapshot;
236
+
237
+ this.updateUiControls(previousState !== currentState);
238
+ });
239
+
240
+ this.stateMachineService.start();
241
+ this.updateUiControls(true);
242
+ }
243
+
244
+ /**
245
+ * Send an event to the state machine
246
+ */
247
+ public sendStateMachineEvent(event: TaskEventPayload): void {
248
+ if (this.stateMachineService) {
249
+ LoggerProxy.log(`Sending state machine event: ${event?.type}`, {
250
+ module: CC_FILE,
251
+ method: 'sendStateMachineEvent',
252
+ interactionId: this.data?.interactionId,
253
+ });
254
+
255
+ this.stateMachineService.send(event);
256
+ }
257
+ }
258
+
259
+ /**
260
+ * Get the current state machine state
261
+ */
262
+ protected getCurrentState(): TaskState | undefined {
263
+ return this.stateMachineService?.getSnapshot()?.value as TaskState;
264
+ }
265
+
266
+ /**
267
+ * Compute UI controls based on current state machine state.
268
+ *
269
+ * @returns UI control states for all task actions
270
+ */
271
+ protected computeUIControls(): TaskUIControls {
272
+ const snapshot = this.stateMachineService?.getSnapshot?.();
273
+
274
+ if (!snapshot) {
275
+ return getDefaultUIControls();
276
+ }
277
+
278
+ const currentState = snapshot.value as TaskState;
279
+ const context = snapshot.context as TaskContext;
280
+
281
+ const uiControls = computeUIControls(currentState, context, this.data);
282
+
283
+ return uiControls;
284
+ }
285
+
286
+ /**
287
+ * Stop the state machine service
288
+ */
289
+ protected stopStateMachine(): void {
290
+ if (this.stateMachineService) {
291
+ this.stateMachineService.stop();
292
+ this.stateMachineService = undefined;
293
+ }
294
+ }
295
+
296
+ private static extractTaskDataFromEvent(event?: TaskEventPayload): TaskData | undefined {
297
+ if (!event || typeof event !== 'object') {
298
+ return undefined;
299
+ }
300
+
301
+ if ('taskData' in event) {
302
+ return (event as {taskData?: TaskData}).taskData;
303
+ }
304
+
305
+ return undefined;
306
+ }
307
+
308
+ private async autoAnswerIfNeeded(): Promise<void> {
309
+ if (!this.data) {
310
+ return;
311
+ }
312
+
313
+ const autoAnswerSupported =
314
+ this.uiControlConfig.channelType === TASK_CHANNEL_TYPE.DIGITAL ||
315
+ this.uiControlConfig.voiceVariant === VOICE_VARIANT.WEBRTC;
316
+
317
+ if (!autoAnswerSupported) {
318
+ return;
319
+ }
320
+
321
+ const shouldAutoAnswer = this.data.isAutoAnswering === true;
322
+
323
+ if (!shouldAutoAnswer) {
324
+ return;
325
+ }
326
+
327
+ LoggerProxy.info(`Auto-answering task`, {
328
+ module: TASK_FILE,
329
+ method: 'autoAnswerIfNeeded',
330
+ interactionId: this.data.interactionId,
331
+ });
332
+
333
+ try {
334
+ await this.accept();
335
+ LoggerProxy.info(`Task auto-answered successfully`, {
336
+ module: TASK_FILE,
337
+ method: 'autoAnswerIfNeeded',
338
+ interactionId: this.data.interactionId,
339
+ });
340
+
341
+ this.metricsManager.trackEvent(
342
+ METRIC_EVENT_NAMES.TASK_AUTO_ANSWER_SUCCESS,
343
+ {
344
+ taskId: this.data.interactionId,
345
+ mediaType: this.data.interaction.mediaType,
346
+ isAutoAnswered: true,
347
+ },
348
+ ['behavioral', 'operational']
349
+ );
350
+
351
+ this.emit(TASK_EVENTS.TASK_AUTO_ANSWERED, this);
352
+ } catch (error) {
353
+ this.updateTaskData({...this.data, isAutoAnswering: false});
354
+ LoggerProxy.error(`Failed to auto-answer task`, {
355
+ module: TASK_FILE,
356
+ method: 'autoAnswerIfNeeded',
357
+ interactionId: this.data.interactionId,
358
+ error,
359
+ });
360
+
361
+ this.metricsManager.trackEvent(
362
+ METRIC_EVENT_NAMES.TASK_AUTO_ANSWER_FAILED,
363
+ {
364
+ taskId: this.data.interactionId,
365
+ mediaType: this.data.interaction.mediaType,
366
+ error: error?.message || 'Unknown error',
367
+ isAutoAnswered: false,
368
+ },
369
+ ['behavioral', 'operational']
370
+ );
371
+ }
372
+ }
373
+
374
+ private updateTaskFromEvent(event?: TaskEventPayload): void {
375
+ const taskData = Task.extractTaskDataFromEvent(event);
376
+ if (taskData) {
377
+ this.updateTaskData(taskData);
378
+ }
379
+ }
380
+
381
+ protected getStateMachineActionOverrides(): Partial<TaskActionsMap> {
382
+ return {
383
+ ...this.getCommonActionOverrides(),
384
+ ...this.getChannelSpecificActionOverrides(),
385
+ };
386
+ }
387
+
388
+ protected getChannelSpecificActionOverrides(): Partial<TaskActionsMap> {
389
+ return {};
390
+ }
391
+
392
+ protected createEmitSelfAction(
393
+ taskEvent: TASK_EVENTS,
394
+ {updateTaskData = false}: {updateTaskData?: boolean} = {}
395
+ ) {
396
+ return ({event}: TaskActionArgs) => {
397
+ if (updateTaskData) {
398
+ this.updateTaskFromEvent(event);
399
+ }
400
+ LoggerProxy.info(`Emitting task event ${taskEvent}`, {
401
+ module: TASK_FILE,
402
+ method: 'emitTaskEvent',
403
+ interactionId: this.data?.interactionId,
404
+ });
405
+ this.emit(taskEvent, this);
406
+ };
407
+ }
408
+
409
+ private getCommonActionOverrides(): Partial<TaskActionsMap> {
410
+ return {
411
+ syncTaskDataFromEvent: ({event}: {event: TaskEventPayload}) => {
412
+ this.updateTaskFromEvent(event);
413
+ },
414
+ emitTaskIncoming: this.createEmitSelfAction(TASK_EVENTS.TASK_INCOMING, {
415
+ updateTaskData: true,
416
+ }),
417
+ emitTaskCampaignPreviewReservation: this.createEmitSelfAction(
418
+ TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION,
419
+ {updateTaskData: true}
420
+ ),
421
+ emitTaskCampaignPreviewAcceptFailed: this.createEmitSelfAction(
422
+ TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_ACCEPT_FAILED
423
+ ),
424
+ emitTaskCampaignPreviewSkipFailed: this.createEmitSelfAction(
425
+ TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_SKIP_FAILED
426
+ ),
427
+ emitTaskCampaignPreviewRemoveFailed: this.createEmitSelfAction(
428
+ TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_REMOVE_FAILED
429
+ ),
430
+ emitTaskHydrate: this.createEmitSelfAction(TASK_EVENTS.TASK_HYDRATE, {
431
+ updateTaskData: true,
432
+ }),
433
+ emitTaskOfferContact: this.createEmitSelfAction(TASK_EVENTS.TASK_OFFER_CONTACT, {
434
+ updateTaskData: true,
435
+ }),
436
+ emitTaskAssigned: ({event}: TaskActionArgs) => {
437
+ this.updateTaskFromEvent(event);
438
+ this.emit(TASK_EVENTS.TASK_ASSIGNED, this);
439
+ this.emit(TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, this);
440
+ },
441
+ emitTaskEnd: this.createEmitSelfAction(TASK_EVENTS.TASK_END, {updateTaskData: true}),
442
+ emitTaskOfferConsult: this.createEmitSelfAction(TASK_EVENTS.TASK_OFFER_CONSULT, {
443
+ updateTaskData: true,
444
+ }),
445
+ emitTaskConsultCreated: this.createEmitSelfAction(TASK_EVENTS.TASK_CONSULT_CREATED, {
446
+ updateTaskData: true,
447
+ }),
448
+ emitTaskConsulting: ({event}: TaskActionArgs) => {
449
+ this.updateTaskFromEvent(event);
450
+ if (this.data.isConsulted) {
451
+ this.emit(TASK_EVENTS.TASK_CONSULT_ACCEPTED, this);
452
+ } else {
453
+ this.emit(TASK_EVENTS.TASK_CONSULTING, this);
454
+ }
455
+ this.emit(TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, this);
456
+ },
457
+ emitTaskConsultAccepted: this.createEmitSelfAction(TASK_EVENTS.TASK_CONSULT_ACCEPTED),
458
+ emitTaskConsultEnd: this.createEmitSelfAction(TASK_EVENTS.TASK_CONSULT_END, {
459
+ updateTaskData: true,
460
+ }),
461
+ emitTaskConsultQueueCancelled: this.createEmitSelfAction(
462
+ TASK_EVENTS.TASK_CONSULT_QUEUE_CANCELLED,
463
+ {
464
+ updateTaskData: true,
465
+ }
466
+ ),
467
+ emitTaskConsultQueueFailed: this.createEmitSelfAction(TASK_EVENTS.TASK_CONSULT_QUEUE_FAILED, {
468
+ updateTaskData: true,
469
+ }),
470
+ emitTaskReject: ({event}: TaskActionArgs) => {
471
+ this.updateTaskFromEvent(event);
472
+ const reason =
473
+ event && typeof event === 'object' && 'reason' in event
474
+ ? (event as {reason?: string}).reason
475
+ : undefined;
476
+ this.emit(TASK_EVENTS.TASK_REJECT, reason);
477
+ },
478
+ emitTaskWrapup: ({event}: {event?: TaskEventPayload}) => {
479
+ this.updateTaskFromEvent(event);
480
+
481
+ const shouldEmitWrapup = Boolean(this.data.wrapUpRequired);
482
+ if (!shouldEmitWrapup) {
483
+ LoggerProxy.info(`Skipping task:wrapup event - wrapUpRequired is false`, {
484
+ module: TASK_FILE,
485
+ method: 'emitTaskEvent',
486
+ interactionId: this.data?.interactionId,
487
+ });
488
+
489
+ return;
490
+ }
491
+ LoggerProxy.info(`Emitting task event ${TASK_EVENTS.TASK_WRAPUP}`, {
492
+ module: TASK_FILE,
493
+ method: 'emitTaskEvent',
494
+ interactionId: this.data?.interactionId,
495
+ });
496
+ this.emit(TASK_EVENTS.TASK_WRAPUP, this);
497
+ },
498
+ emitTaskWrappedup: this.createEmitSelfAction(TASK_EVENTS.TASK_WRAPPEDUP, {
499
+ updateTaskData: true,
500
+ }),
501
+ requestAutoAnswer: ({event}: TaskActionArgs) => {
502
+ if (event) {
503
+ // parameter intentionally unused
504
+ }
505
+ this.autoAnswerIfNeeded();
506
+ },
507
+ requestCleanup: () => {
508
+ this.emit(TASK_EVENTS.TASK_CLEANUP, this, {removeFromCollection: false});
509
+ },
510
+ cleanupResources: () => {
511
+ this.emit(TASK_EVENTS.TASK_CLEANUP, this, {removeFromCollection: true});
512
+ },
513
+ };
514
+ }
515
+
516
+ /**
517
+ * Sets up the automatic wrap-up timer if wrap-up is required
518
+ */
519
+ protected setupAutoWrapupTimer(): void {
520
+ if (
521
+ this.data.wrapUpRequired &&
522
+ !this.autoWrapup &&
523
+ this.wrapupData &&
524
+ this.wrapupData.wrapUpProps
525
+ ) {
526
+ const wrapUpProps = this.wrapupData.wrapUpProps;
527
+ if (!wrapUpProps || wrapUpProps.autoWrapup === false) {
528
+ LoggerProxy.info(`Auto wrap-up is not required for this task`, {
529
+ module: TASK_FILE,
530
+ method: METHODS.SETUP_AUTO_WRAPUP_TIMER,
531
+ interactionId: this.data.interactionId,
532
+ });
533
+
534
+ return;
535
+ }
536
+ const defaultWrapupReason =
537
+ wrapUpProps.wrapUpReasonList?.find((r) => r.isDefault) ?? wrapUpProps.wrapUpReasonList?.[0];
538
+ if (!defaultWrapupReason) {
539
+ LoggerProxy.error('No wrap-up reason configured', {
540
+ module: TASK_FILE,
541
+ method: METHODS.SETUP_AUTO_WRAPUP_TIMER,
542
+ });
543
+
544
+ return;
545
+ }
546
+ const intervalMs = wrapUpProps.autoWrapupInterval;
547
+ if (!intervalMs || intervalMs <= 0) {
548
+ LoggerProxy.error(`Invalid auto wrap-up interval: ${intervalMs}`, {
549
+ module: TASK_FILE,
550
+ method: METHODS.SETUP_AUTO_WRAPUP_TIMER,
551
+ });
552
+
553
+ return;
554
+ }
555
+ this.autoWrapup = new AutoWrapup(intervalMs, wrapUpProps.allowCancelAutoWrapup);
556
+ this.autoWrapup.start(async () => {
557
+ LoggerProxy.info(`Auto wrap-up timer triggered`, {
558
+ module: TASK_FILE,
559
+ method: METHODS.SETUP_AUTO_WRAPUP_TIMER,
560
+ interactionId: this.data.interactionId,
561
+ });
562
+ await this.wrapup({
563
+ wrapUpReason: defaultWrapupReason.name,
564
+ auxCodeId: defaultWrapupReason.id,
565
+ });
566
+ });
567
+ }
568
+ }
569
+
570
+ /**
571
+ * Cancels the automatic wrap-up timer if it's running
572
+ */
573
+ private reconcileData(oldData: TaskData, newData: TaskData): TaskData {
574
+ Object.keys(newData).forEach((key) => {
575
+ if (newData[key] && typeof newData[key] === 'object' && !Array.isArray(newData[key])) {
576
+ oldData[key] = this.reconcileData({...oldData[key]}, newData[key]);
577
+ } else {
578
+ oldData[key] = newData[key];
579
+ }
580
+ });
581
+
582
+ return oldData;
583
+ }
584
+
585
+ /**
586
+ *
587
+ * @param methodName - The name of the method that is unsupported
588
+ * @throws Error
589
+ */
590
+ protected unsupportedMethodError(methodName: string) {
591
+ LoggerProxy.error(`Unsupported operation`, {
592
+ module: 'TASK',
593
+ method: methodName,
594
+ interactionId: this.data?.interactionId,
595
+ });
596
+ throw new Error(`Unsupported operation: ${methodName}`);
597
+ }
598
+
599
+ /**
600
+ * This method is used to update the task data.
601
+ * @param updatedData - TaskData
602
+ * @param shouldOverwrite - boolean
603
+ * @example
604
+ * ```typescript
605
+ * task.updateTaskData(updatedData, true);
606
+ * ```
607
+ */
608
+ public updateTaskData(updatedData: TaskData, shouldOverwrite = false): ITask {
609
+ this.data = shouldOverwrite ? updatedData : this.reconcileData(this.data, updatedData);
610
+ if (!shouldOverwrite) {
611
+ this.pruneStaleInteractionMaps(updatedData);
612
+ }
613
+ this.updateUiControls();
614
+ this.setupAutoWrapupTimer();
615
+
616
+ return this;
617
+ }
618
+
619
+ /**
620
+ * The backend sends `interaction.media` and `interaction.participants` as complete snapshots
621
+ * of the current call state. `reconcileData` deep-merges and never removes keys, so entries the
622
+ * backend dropped (e.g. a consult leg's media and consultee participant after the consult ends)
623
+ * linger in `this.data`. That stale data drives incorrect UI controls (e.g. the consult button
624
+ * staying disabled after the consult leg is gone, until a page refresh re-hydrates cleanly).
625
+ * Make only these two snapshot maps authoritative to the incoming payload, leaving every other
626
+ * field on the generic deep-merge path (CAD and other partial updates still merge as before).
627
+ */
628
+ private pruneStaleInteractionMaps(incoming: TaskData): void {
629
+ const incomingInteraction = incoming?.interaction;
630
+ const currentInteraction = this.data?.interaction;
631
+ if (!incomingInteraction || !currentInteraction) {
632
+ return;
633
+ }
634
+
635
+ (['media', 'participants'] as const).forEach((mapKey) => {
636
+ const incomingMap = incomingInteraction[mapKey] as Record<string, unknown> | undefined;
637
+ const currentMap = currentInteraction[mapKey] as Record<string, unknown> | undefined;
638
+ if (!incomingMap || !currentMap || typeof incomingMap !== 'object') {
639
+ return;
640
+ }
641
+
642
+ Object.keys(currentMap).forEach((id) => {
643
+ if (!(id in incomingMap)) {
644
+ delete currentMap[id];
645
+ }
646
+ });
647
+ });
648
+ }
649
+
650
+ /**
651
+ * This is used to blind transfer or vTeam transfer the task
652
+ * @param transferPayload
653
+ * @returns Promise<TaskResponse>
654
+ * @throws Error
655
+ * @example
656
+ * ```typescript
657
+ * const transferPayload = {
658
+ * to: 'myQueueId',
659
+ * destinationType: 'queue',
660
+ * }
661
+ * task.transfer(transferPayload).then(()=>{}).catch(()=>{});
662
+ * ```
663
+ */
664
+ public async transfer(transferPayload: TransferPayLoad): Promise<TaskResponse> {
665
+ LoggerProxy.log(`Starting task transfer for taskId:${this.data.interactionId}`, {
666
+ module: 'Task',
667
+ method: 'transfer',
668
+ });
669
+ try {
670
+ this.metricsManager.timeEvent([
671
+ METRIC_EVENT_NAMES.TASK_TRANSFER_SUCCESS,
672
+ METRIC_EVENT_NAMES.TASK_TRANSFER_FAILED,
673
+ ]);
674
+ let result: TaskResponse;
675
+ if (transferPayload.destinationType === DESTINATION_TYPE.QUEUE) {
676
+ result = await this.contact.vteamTransfer({
677
+ interactionId: this.data.interactionId,
678
+ data: transferPayload,
679
+ });
680
+ } else {
681
+ result = await this.contact.blindTransfer({
682
+ interactionId: this.data.interactionId,
683
+ data: transferPayload,
684
+ });
685
+ }
686
+
687
+ this.metricsManager.trackEvent(
688
+ METRIC_EVENT_NAMES.TASK_TRANSFER_SUCCESS,
689
+ {
690
+ taskId: this.data.interactionId,
691
+ destination: transferPayload.to,
692
+ destinationType: transferPayload.destinationType,
693
+ isConsultTransfer: false,
694
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(result),
695
+ },
696
+ ['operational', 'behavioral', 'business']
697
+ );
698
+
699
+ return result;
700
+ } catch (error) {
701
+ const {error: detailedError} = getErrorDetails(error, 'transfer', CC_FILE);
702
+ this.metricsManager.trackEvent(
703
+ METRIC_EVENT_NAMES.TASK_TRANSFER_FAILED,
704
+ {
705
+ taskId: this.data.interactionId,
706
+ destination: transferPayload.to,
707
+ destinationType: transferPayload.destinationType,
708
+ isConsultTransfer: false,
709
+ error: error.toString(),
710
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(
711
+ (error as any).details || {}
712
+ ),
713
+ },
714
+ ['operational', 'behavioral', 'business']
715
+ );
716
+ throw detailedError;
717
+ }
718
+ }
719
+
720
+ /**
721
+ * This is used to end the task.
722
+ * @returns Promise<TaskResponse>
723
+ * @throws Error
724
+ * @example
725
+ * ```typescript
726
+ * task.end().then(()=>{}).catch(()=>{})
727
+ * ```
728
+ */
729
+ public async end(): Promise<TaskResponse> {
730
+ LoggerProxy.log(`Ending task for taskId:${this.data.interactionId}`, {
731
+ module: 'Task',
732
+ method: 'end',
733
+ });
734
+ const requestInteractionId =
735
+ this.data.interaction?.mainInteractionId || this.data.interactionId;
736
+
737
+ try {
738
+ this.metricsManager.timeEvent([
739
+ METRIC_EVENT_NAMES.TASK_END_SUCCESS,
740
+ METRIC_EVENT_NAMES.TASK_END_FAILED,
741
+ ]);
742
+ const response = await this.contact.end({interactionId: requestInteractionId});
743
+
744
+ this.metricsManager.trackEvent(
745
+ METRIC_EVENT_NAMES.TASK_END_SUCCESS,
746
+ {
747
+ taskId: this.data.interactionId,
748
+ requestInteractionId,
749
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(response),
750
+ },
751
+ ['operational', 'behavioral', 'business']
752
+ );
753
+
754
+ return response;
755
+ } catch (error) {
756
+ const {error: detailedError} = getErrorDetails(error, 'end', CC_FILE);
757
+ this.metricsManager.trackEvent(
758
+ METRIC_EVENT_NAMES.TASK_END_FAILED,
759
+ {
760
+ taskId: this.data.interactionId,
761
+ requestInteractionId,
762
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(
763
+ (error as any).details || {}
764
+ ),
765
+ },
766
+ ['operational', 'behavioral', 'business']
767
+ );
768
+ throw detailedError;
769
+ }
770
+ }
771
+
772
+ /**
773
+ * This is used to wrap up the task.
774
+ * @param wrapupPayload - WrapupPayLoad
775
+ * @returns Promise<TaskResponse>
776
+ * @throws Error
777
+ * @example
778
+ * ```typescript
779
+ * task.wrapup(wrapupPayload).then(()=>{}).catch(()=>{})
780
+ * ```
781
+ */
782
+ public async wrapup(wrapupPayload: WrapupPayLoad): Promise<TaskResponse> {
783
+ this.cancelAutoWrapupTimer();
784
+ LoggerProxy.log(`Starting task wrapup for taskId:${this.data.interactionId}`, {
785
+ module: 'Task',
786
+ method: 'wrapup',
787
+ });
788
+ try {
789
+ this.metricsManager.timeEvent([
790
+ METRIC_EVENT_NAMES.TASK_WRAPUP_SUCCESS,
791
+ METRIC_EVENT_NAMES.TASK_WRAPUP_FAILED,
792
+ ]);
793
+ if (!this.data) {
794
+ throw new Error('No task data available');
795
+ }
796
+ if (!wrapupPayload.auxCodeId || wrapupPayload.auxCodeId.length === 0) {
797
+ throw new Error('AuxCodeId is required');
798
+ }
799
+ if (!wrapupPayload.wrapUpReason || wrapupPayload.wrapUpReason.length === 0) {
800
+ throw new Error('WrapUpReason is required');
801
+ }
802
+
803
+ const response = await this.contact.wrapup({
804
+ interactionId: this.data.interactionId,
805
+ data: wrapupPayload,
806
+ });
807
+
808
+ this.metricsManager.trackEvent(
809
+ METRIC_EVENT_NAMES.TASK_WRAPUP_SUCCESS,
810
+ {
811
+ taskId: this.data.interactionId,
812
+ wrapUpCode: wrapupPayload.auxCodeId,
813
+ wrapUpReason: wrapupPayload.wrapUpReason,
814
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(response),
815
+ },
816
+ ['operational', 'behavioral', 'business']
817
+ );
818
+
819
+ return response;
820
+ } catch (error) {
821
+ const {error: detailedError} = getErrorDetails(error, 'wrapup', CC_FILE);
822
+ this.metricsManager.trackEvent(
823
+ METRIC_EVENT_NAMES.TASK_WRAPUP_FAILED,
824
+ {
825
+ taskId: this.data.interactionId,
826
+ wrapUpCode: wrapupPayload.auxCodeId,
827
+ wrapUpReason: wrapupPayload.wrapUpReason,
828
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(
829
+ (error as any).details || {}
830
+ ),
831
+ },
832
+ ['operational', 'behavioral', 'business']
833
+ );
834
+ throw detailedError;
835
+ }
836
+ }
837
+ }