@webex/contact-center 3.12.0 → 3.13.0-next.10

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 (297) hide show
  1. package/.repo-context.json +704 -0
  2. package/.sdd/manifest.json +1613 -0
  3. package/AGENTS.md +969 -0
  4. package/dist/cc.js +1102 -47
  5. package/dist/cc.js.map +1 -1
  6. package/dist/config.js +13 -0
  7. package/dist/config.js.map +1 -1
  8. package/dist/constants.js +46 -3
  9. package/dist/constants.js.map +1 -1
  10. package/dist/index.js +86 -17
  11. package/dist/index.js.map +1 -1
  12. package/dist/metrics/MetricsManager.js +16 -0
  13. package/dist/metrics/MetricsManager.js.map +1 -1
  14. package/dist/metrics/behavioral-events.js +211 -0
  15. package/dist/metrics/behavioral-events.js.map +1 -1
  16. package/dist/metrics/constants.js +58 -4
  17. package/dist/metrics/constants.js.map +1 -1
  18. package/dist/services/AddressBook.js +18 -15
  19. package/dist/services/AddressBook.js.map +1 -1
  20. package/dist/services/AnswerCallOnWebexService.js +202 -0
  21. package/dist/services/AnswerCallOnWebexService.js.map +1 -0
  22. package/dist/services/ApiAiAssistant.js +369 -14
  23. package/dist/services/ApiAiAssistant.js.map +1 -1
  24. package/dist/services/EntryPoint.js +46 -68
  25. package/dist/services/EntryPoint.js.map +1 -1
  26. package/dist/services/Queue.js +27 -22
  27. package/dist/services/Queue.js.map +1 -1
  28. package/dist/services/UserPreference.js +427 -0
  29. package/dist/services/UserPreference.js.map +1 -0
  30. package/dist/services/WebCallingService.js +287 -37
  31. package/dist/services/WebCallingService.js.map +1 -1
  32. package/dist/services/WebexCrossClientService.js +225 -0
  33. package/dist/services/WebexCrossClientService.js.map +1 -0
  34. package/dist/services/WxAppTelephonyMercurySync.js +111 -0
  35. package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
  36. package/dist/services/config/Util.js +48 -48
  37. package/dist/services/config/Util.js.map +1 -1
  38. package/dist/services/config/constants.js +57 -79
  39. package/dist/services/config/constants.js.map +1 -1
  40. package/dist/services/config/index.js +100 -226
  41. package/dist/services/config/index.js.map +1 -1
  42. package/dist/services/config/types.js +100 -40
  43. package/dist/services/config/types.js.map +1 -1
  44. package/dist/services/constants.js +19 -1
  45. package/dist/services/constants.js.map +1 -1
  46. package/dist/services/core/Err.js.map +1 -1
  47. package/dist/services/core/Utils.js +131 -32
  48. package/dist/services/core/Utils.js.map +1 -1
  49. package/dist/services/core/WebexRequest.js +6 -2
  50. package/dist/services/core/WebexRequest.js.map +1 -1
  51. package/dist/services/core/aqm-reqs.js +17 -11
  52. package/dist/services/core/aqm-reqs.js.map +1 -1
  53. package/dist/services/core/constants.js +9 -1
  54. package/dist/services/core/constants.js.map +1 -1
  55. package/dist/services/core/types.js.map +1 -1
  56. package/dist/services/core/websocket/WebSocketManager.js +26 -6
  57. package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
  58. package/dist/services/core/websocket/connection-service.js +3 -1
  59. package/dist/services/core/websocket/connection-service.js.map +1 -1
  60. package/dist/services/core/websocket/types.js.map +1 -1
  61. package/dist/services/index.js +6 -0
  62. package/dist/services/index.js.map +1 -1
  63. package/dist/services/task/Task.js +955 -0
  64. package/dist/services/task/Task.js.map +1 -0
  65. package/dist/services/task/TaskFactory.js +50 -0
  66. package/dist/services/task/TaskFactory.js.map +1 -0
  67. package/dist/services/task/TaskManager.js +1275 -504
  68. package/dist/services/task/TaskManager.js.map +1 -1
  69. package/dist/services/task/TaskUtils.js +221 -27
  70. package/dist/services/task/TaskUtils.js.map +1 -1
  71. package/dist/services/task/WebexCallingUtils.js +70 -0
  72. package/dist/services/task/WebexCallingUtils.js.map +1 -0
  73. package/dist/services/task/constants.js +22 -2
  74. package/dist/services/task/constants.js.map +1 -1
  75. package/dist/services/task/contact.js +29 -0
  76. package/dist/services/task/contact.js.map +1 -1
  77. package/dist/services/task/dialer.js +78 -0
  78. package/dist/services/task/dialer.js.map +1 -1
  79. package/dist/services/task/digital/Digital.js +78 -0
  80. package/dist/services/task/digital/Digital.js.map +1 -0
  81. package/dist/services/task/state-machine/TaskStateMachine.js +982 -0
  82. package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -0
  83. package/dist/services/task/state-machine/actions.js +572 -0
  84. package/dist/services/task/state-machine/actions.js.map +1 -0
  85. package/dist/services/task/state-machine/constants.js +161 -0
  86. package/dist/services/task/state-machine/constants.js.map +1 -0
  87. package/dist/services/task/state-machine/guards.js +379 -0
  88. package/dist/services/task/state-machine/guards.js.map +1 -0
  89. package/dist/services/task/state-machine/index.js +53 -0
  90. package/dist/services/task/state-machine/index.js.map +1 -0
  91. package/dist/services/task/state-machine/types.js +54 -0
  92. package/dist/services/task/state-machine/types.js.map +1 -0
  93. package/dist/services/task/state-machine/uiControlsComputer.js +703 -0
  94. package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -0
  95. package/dist/services/task/taskDataNormalizer.js +99 -0
  96. package/dist/services/task/taskDataNormalizer.js.map +1 -0
  97. package/dist/services/task/types.js +259 -5
  98. package/dist/services/task/types.js.map +1 -1
  99. package/dist/services/task/voice/Voice.js +1504 -0
  100. package/dist/services/task/voice/Voice.js.map +1 -0
  101. package/dist/services/task/voice/WebRTC.js +152 -0
  102. package/dist/services/task/voice/WebRTC.js.map +1 -0
  103. package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
  104. package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
  105. package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
  106. package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
  107. package/dist/services/wxAppDiagnosticLogging.js +159 -0
  108. package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
  109. package/dist/services/wxAppTelephonyUtils.js +19 -0
  110. package/dist/services/wxAppTelephonyUtils.js.map +1 -0
  111. package/dist/types/cc.d.ts +222 -10
  112. package/dist/types/config.d.ts +13 -0
  113. package/dist/types/constants.d.ts +40 -1
  114. package/dist/types/index.d.ts +58 -22
  115. package/dist/types/metrics/MetricsManager.d.ts +6 -0
  116. package/dist/types/metrics/constants.d.ts +52 -1
  117. package/dist/types/services/AddressBook.d.ts +2 -1
  118. package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
  119. package/dist/types/services/ApiAiAssistant.d.ts +67 -5
  120. package/dist/types/services/EntryPoint.d.ts +7 -5
  121. package/dist/types/services/Queue.d.ts +5 -3
  122. package/dist/types/services/UserPreference.d.ts +118 -0
  123. package/dist/types/services/WebexCrossClientService.d.ts +32 -0
  124. package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
  125. package/dist/types/services/config/Util.d.ts +4 -8
  126. package/dist/types/services/config/constants.d.ts +49 -76
  127. package/dist/types/services/config/index.d.ts +16 -64
  128. package/dist/types/services/config/types.d.ts +252 -114
  129. package/dist/types/services/constants.d.ts +16 -0
  130. package/dist/types/services/core/Err.d.ts +6 -0
  131. package/dist/types/services/core/Utils.d.ts +43 -13
  132. package/dist/types/services/core/WebexRequest.d.ts +1 -0
  133. package/dist/types/services/core/constants.d.ts +7 -0
  134. package/dist/types/services/core/types.d.ts +2 -0
  135. package/dist/types/services/core/websocket/WebSocketManager.d.ts +2 -0
  136. package/dist/types/services/core/websocket/types.d.ts +1 -1
  137. package/dist/types/services/index.d.ts +2 -0
  138. package/dist/types/services/task/Task.d.ts +186 -0
  139. package/dist/types/services/task/TaskFactory.d.ts +14 -0
  140. package/dist/types/services/task/TaskUtils.d.ts +54 -2
  141. package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
  142. package/dist/types/services/task/constants.d.ts +20 -0
  143. package/dist/types/services/task/contact.d.ts +4 -0
  144. package/dist/types/services/task/dialer.d.ts +30 -0
  145. package/dist/types/services/task/digital/Digital.d.ts +23 -0
  146. package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +1442 -0
  147. package/dist/types/services/task/state-machine/actions.d.ts +10 -0
  148. package/dist/types/services/task/state-machine/constants.d.ts +107 -0
  149. package/dist/types/services/task/state-machine/guards.d.ts +103 -0
  150. package/dist/types/services/task/state-machine/index.d.ts +13 -0
  151. package/dist/types/services/task/state-machine/types.d.ts +277 -0
  152. package/dist/types/services/task/state-machine/uiControlsComputer.d.ts +9 -0
  153. package/dist/types/services/task/taskDataNormalizer.d.ts +10 -0
  154. package/dist/types/services/task/types.d.ts +790 -66
  155. package/dist/types/services/task/voice/Voice.d.ts +241 -0
  156. package/dist/types/services/task/voice/WebRTC.d.ts +54 -0
  157. package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
  158. package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
  159. package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
  160. package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
  161. package/dist/types/types.d.ts +258 -11
  162. package/dist/types/utils/PageCache.d.ts +20 -3
  163. package/dist/types/webex.d.ts +1 -0
  164. package/dist/types.js +204 -6
  165. package/dist/types.js.map +1 -1
  166. package/dist/utils/PageCache.js +19 -5
  167. package/dist/utils/PageCache.js.map +1 -1
  168. package/dist/webex.js +22 -2
  169. package/dist/webex.js.map +1 -1
  170. package/docs/adr/0001-spec-source-policy.md +97 -0
  171. package/docs/adr/0002-consult-transfer-list-policy.md +345 -0
  172. package/docs/adr/0003-repo-standards-migration.md +104 -0
  173. package/docs/adr/index.md +35 -0
  174. package/docs/architecture.md +460 -0
  175. package/docs/getting-started.md +142 -0
  176. package/docs/index.md +53 -0
  177. package/docs/specs/README.md +98 -0
  178. package/package.json +17 -12
  179. package/schemas/repo-context.schema.json +796 -0
  180. package/src/cc.ts +1439 -105
  181. package/src/config.ts +13 -0
  182. package/src/constants.ts +53 -1
  183. package/src/docs/README.md +727 -0
  184. package/src/index.ts +72 -16
  185. package/src/metrics/MetricsManager.ts +16 -0
  186. package/src/metrics/behavioral-events.ts +218 -0
  187. package/src/metrics/constants.ts +63 -4
  188. package/src/metrics/docs/README.md +710 -0
  189. package/src/services/AddressBook.ts +17 -6
  190. package/src/services/AnswerCallOnWebexService.ts +239 -0
  191. package/src/services/ApiAiAssistant.ts +494 -15
  192. package/src/services/EntryPoint.ts +59 -60
  193. package/src/services/Queue.ts +29 -12
  194. package/src/services/UserPreference.ts +509 -0
  195. package/src/services/WebCallingService.ts +362 -40
  196. package/src/services/WebexCrossClientService.ts +298 -0
  197. package/src/services/WxAppTelephonyMercurySync.ts +142 -0
  198. package/src/services/agent/docs/README.md +673 -0
  199. package/src/services/config/Util.ts +54 -84
  200. package/src/services/config/constants.ts +64 -86
  201. package/src/services/config/docs/README.md +530 -0
  202. package/src/services/config/index.ts +116 -277
  203. package/src/services/config/types.ts +238 -125
  204. package/src/services/constants.ts +18 -0
  205. package/src/services/core/Err.ts +3 -0
  206. package/src/services/core/Utils.ts +151 -37
  207. package/src/services/core/WebexRequest.ts +3 -1
  208. package/src/services/core/aqm-reqs.ts +18 -12
  209. package/src/services/core/constants.ts +8 -0
  210. package/src/services/core/docs/README.md +993 -0
  211. package/src/services/core/types.ts +33 -1
  212. package/src/services/core/websocket/WebSocketManager.ts +37 -8
  213. package/src/services/core/websocket/connection-service.ts +5 -1
  214. package/src/services/core/websocket/types.ts +1 -1
  215. package/src/services/docs/README.md +765 -0
  216. package/src/services/index.ts +4 -0
  217. package/src/services/task/Task.ts +1211 -0
  218. package/src/services/task/TaskFactory.ts +82 -0
  219. package/src/services/task/TaskManager.ts +1551 -584
  220. package/src/services/task/TaskUtils.ts +316 -25
  221. package/src/services/task/WebexCallingUtils.ts +136 -0
  222. package/src/services/task/constants.ts +21 -0
  223. package/src/services/task/contact.ts +30 -0
  224. package/src/services/task/dialer.ts +80 -0
  225. package/src/services/task/digital/Digital.ts +102 -0
  226. package/src/services/task/docs/README.md +1569 -0
  227. package/src/services/task/state-machine/TaskStateMachine.ts +1320 -0
  228. package/src/services/task/state-machine/actions.ts +741 -0
  229. package/src/services/task/state-machine/constants.ts +172 -0
  230. package/src/services/task/state-machine/docs/README.md +1388 -0
  231. package/src/services/task/state-machine/guards.ts +442 -0
  232. package/src/services/task/state-machine/index.ts +28 -0
  233. package/src/services/task/state-machine/types.ts +258 -0
  234. package/src/services/task/state-machine/uiControlsComputer.ts +1135 -0
  235. package/src/services/task/taskDataNormalizer.ts +137 -0
  236. package/src/services/task/types.ts +974 -70
  237. package/src/services/task/voice/Voice.ts +1878 -0
  238. package/src/services/task/voice/WebRTC.ts +194 -0
  239. package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
  240. package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
  241. package/src/services/wxAppDiagnosticLogging.ts +286 -0
  242. package/src/services/wxAppTelephonyUtils.ts +14 -0
  243. package/src/types.ts +323 -13
  244. package/src/utils/AGENTS.md +291 -0
  245. package/src/utils/PageCache.ts +38 -5
  246. package/src/utils/docs/README.md +413 -0
  247. package/src/webex.js +10 -0
  248. package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
  249. package/test/unit/spec/cc.ts +4046 -181
  250. package/test/unit/spec/index.ts +891 -0
  251. package/test/unit/spec/logger-proxy.ts +70 -0
  252. package/test/unit/spec/metrics/MetricsManager.ts +25 -0
  253. package/test/unit/spec/metrics/behavioral-events.ts +60 -0
  254. package/test/unit/spec/services/AddressBook.ts +37 -6
  255. package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
  256. package/test/unit/spec/services/ApiAiAssistant.ts +442 -23
  257. package/test/unit/spec/services/EntryPoint.ts +87 -40
  258. package/test/unit/spec/services/Queue.ts +123 -12
  259. package/test/unit/spec/services/UserPreference.ts +401 -0
  260. package/test/unit/spec/services/WebCallingService.ts +484 -49
  261. package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
  262. package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
  263. package/test/unit/spec/services/config/Util.ts +501 -0
  264. package/test/unit/spec/services/config/index.ts +318 -548
  265. package/test/unit/spec/services/core/Utils.ts +447 -8
  266. package/test/unit/spec/services/core/WebexRequest.ts +8 -7
  267. package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
  268. package/test/unit/spec/services/core/websocket/WebSocketManager.ts +132 -56
  269. package/test/unit/spec/services/core/websocket/connection-service.ts +3 -1
  270. package/test/unit/spec/services/task/AutoWrapup.ts +63 -0
  271. package/test/unit/spec/services/task/Task.ts +2723 -0
  272. package/test/unit/spec/services/task/TaskFactory.ts +116 -0
  273. package/test/unit/spec/services/task/TaskManager.ts +4800 -1586
  274. package/test/unit/spec/services/task/TaskUtils.ts +307 -0
  275. package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
  276. package/test/unit/spec/services/task/contact.ts +33 -0
  277. package/test/unit/spec/services/task/dialer.ts +190 -0
  278. package/test/unit/spec/services/task/digital/Digital.ts +105 -0
  279. package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +4060 -0
  280. package/test/unit/spec/services/task/state-machine/guards.ts +839 -0
  281. package/test/unit/spec/services/task/state-machine/types.ts +18 -0
  282. package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +3101 -0
  283. package/test/unit/spec/services/task/taskTestUtils.ts +87 -0
  284. package/test/unit/spec/services/task/voice/Voice.ts +2355 -0
  285. package/test/unit/spec/services/task/voice/WebRTC.ts +235 -0
  286. package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
  287. package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
  288. package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
  289. package/test/unit/spec/wellnessSampleUtils.ts +288 -0
  290. package/typedoc.md +1 -1
  291. package/umd/contact-center.min.js +2 -2
  292. package/umd/contact-center.min.js.map +1 -1
  293. package/dist/services/task/index.js +0 -1525
  294. package/dist/services/task/index.js.map +0 -1
  295. package/dist/types/services/task/index.d.ts +0 -650
  296. package/src/services/task/index.ts +0 -1801
  297. package/test/unit/spec/services/task/index.ts +0 -2184
@@ -1,18 +1,68 @@
1
1
  import ApiAIAssistant from '../../../../src/services/ApiAiAssistant';
2
2
  import MetricsManager from '../../../../src/metrics/MetricsManager';
3
3
  import LoggerProxy from '../../../../src/logger-proxy';
4
- import {HTTP_METHODS, WebexSDK} from '../../../../src/types';
4
+ import WebexRequest from '../../../../src/services/core/WebexRequest';
5
+ import {
6
+ HTTP_METHODS,
7
+ RealTimeAssistanceUserActionId,
8
+ WELLNESS_BREAK_USER_ACTIONS,
9
+ WebexSDK,
10
+ } from '../../../../src/types';
5
11
 
6
- jest.mock('../../../../src/metrics/MetricsManager');
7
- jest.mock('../../../../src/logger-proxy');
12
+ jest.mock('../../../../src/metrics/MetricsManager', () => ({
13
+ __esModule: true,
14
+ default: {
15
+ getInstance: jest.fn(),
16
+ },
17
+ }));
18
+ jest.mock('../../../../src/logger-proxy', () => ({
19
+ __esModule: true,
20
+ default: {
21
+ log: jest.fn(),
22
+ error: jest.fn(),
23
+ info: jest.fn(),
24
+ warn: jest.fn(),
25
+ trace: jest.fn(),
26
+ debug: jest.fn(),
27
+ },
28
+ }));
29
+ jest.mock('../../../../src/services/core/WebexRequest', () => ({
30
+ __esModule: true,
31
+ default: {
32
+ getInstance: jest.fn(),
33
+ },
34
+ }));
35
+ jest.mock('../../../../src/services/core/Utils', () => ({
36
+ __esModule: true,
37
+ getErrorDetails: jest.fn((error: any, methodName: string, moduleName: string) => {
38
+ const LoggerProxyMock = require('../../../../src/logger-proxy').default;
39
+ const reason = error?.details?.data?.reason ?? `Error while performing ${methodName}`;
40
+ const detailedError = new Error(reason) as Error & {data?: Record<string, unknown>};
41
+
42
+ detailedError.data = {};
43
+ LoggerProxyMock.error(`${methodName} failed with reason: ${reason}`, {
44
+ module: moduleName,
45
+ method: methodName,
46
+ });
47
+
48
+ return {error: detailedError, reason};
49
+ }),
50
+ }));
8
51
 
9
52
  describe('ApiAIAssistant', () => {
10
53
  let apiAIAssistant: ApiAIAssistant;
11
54
  let mockWebex: WebexSDK;
12
55
  let mockMetricsManager: jest.Mocked<MetricsManager>;
56
+ let mockUploadLogs: jest.Mock;
57
+ let wellnessContext: {
58
+ isWellnessBreakEnabled: boolean;
59
+ agentId?: string;
60
+ agentSessionId?: string;
61
+ };
13
62
 
14
63
  beforeEach(() => {
15
64
  jest.clearAllMocks();
65
+ mockUploadLogs = jest.fn();
16
66
 
17
67
  mockWebex = {
18
68
  credentials: {
@@ -33,15 +83,94 @@ describe('ApiAIAssistant', () => {
33
83
  once: jest.fn(),
34
84
  } as unknown as WebexSDK;
35
85
 
86
+ jest.spyOn(WebexRequest, 'getInstance').mockReturnValue({
87
+ request: mockWebex.request,
88
+ uploadLogs: mockUploadLogs,
89
+ } as any);
90
+
36
91
  mockMetricsManager = {
37
92
  trackEvent: jest.fn(),
38
93
  timeEvent: jest.fn(),
39
94
  } as unknown as jest.Mocked<MetricsManager>;
40
95
  (MetricsManager.getInstance as jest.Mock).mockReturnValue(mockMetricsManager);
41
96
 
42
- apiAIAssistant = new ApiAIAssistant(mockWebex);
97
+ wellnessContext = {isWellnessBreakEnabled: false};
98
+ apiAIAssistant = new ApiAIAssistant(mockWebex, () => wellnessContext);
99
+ });
100
+
101
+ it('sends a summary request and resolves it from the matching RTD event', async () => {
102
+ (mockWebex.request as jest.Mock).mockResolvedValue({body: {accepted: true}});
103
+
104
+ const request = apiAIAssistant.requestAndWaitForRtd({
105
+ correlationId: 'conversation-1',
106
+ rtdEventType: 'POST_CALL_SUMMARY',
107
+ timeoutMs: 15000,
108
+ createTimeoutError: () => new Error('TIMEOUT'),
109
+ agentId: 'agent-1',
110
+ interactionId: 'interaction-1',
111
+ eventType: 'CTI_EVENT' as any,
112
+ eventName: 'GET_POST_CALL_SUMMARY' as any,
113
+ eventMetaData: {conversationId: 'conversation-1'},
114
+ timeout: 15000,
115
+ });
116
+
117
+ await Promise.resolve();
118
+ expect(apiAIAssistant.resolveFromRtdEvent('POST_CALL_SUMMARY', 'conversation-1', {summary: 'ready'})).toBe(
119
+ 'resolved'
120
+ );
121
+ await expect(request).resolves.toEqual({summary: 'ready'});
122
+ expect(mockWebex.request).toHaveBeenCalledTimes(1);
123
+ const requestBody = (mockWebex.request as jest.Mock).mock.calls[0][0].body;
124
+
125
+ expect(requestBody.publishTimestamp).toEqual(expect.any(Number));
126
+ expect(requestBody.eventDetails.data).toMatchObject({
127
+ conversationId: 'conversation-1',
128
+ interactionId: 'interaction-1',
129
+ actionTimeStamp: expect.any(String),
130
+ });
131
+ });
132
+
133
+ it('rejects an RTD request when its timeout expires', async () => {
134
+ jest.useFakeTimers();
135
+ (mockWebex.request as jest.Mock).mockResolvedValue({body: {accepted: true}});
136
+ const request = apiAIAssistant.requestAndWaitForRtd({
137
+ correlationId: 'conversation-1',
138
+ rtdEventType: 'POST_CALL_SUMMARY',
139
+ timeoutMs: 15000,
140
+ createTimeoutError: () => new Error('TIMEOUT'),
141
+ agentId: 'agent-1',
142
+ interactionId: 'interaction-1',
143
+ eventType: 'CTI_EVENT' as any,
144
+ eventName: 'GET_POST_CALL_SUMMARY' as any,
145
+ });
146
+
147
+ jest.advanceTimersByTime(15000);
148
+ await expect(request).rejects.toThrow('TIMEOUT');
149
+ jest.useRealTimers();
43
150
  });
44
151
 
152
+ it('removes the pending RTD request when the HTTP request fails', async () => {
153
+ const error = new Error('HTTP_FAILED');
154
+ (mockWebex.request as jest.Mock).mockRejectedValue(error);
155
+
156
+ const request = apiAIAssistant.requestAndWaitForRtd({
157
+ correlationId: 'conversation-1',
158
+ rtdEventType: 'POST_CALL_SUMMARY',
159
+ timeoutMs: 15000,
160
+ createTimeoutError: () => new Error('TIMEOUT'),
161
+ agentId: 'agent-1',
162
+ interactionId: 'interaction-1',
163
+ eventType: 'CTI_EVENT' as any,
164
+ eventName: 'GET_POST_CALL_SUMMARY' as any,
165
+ });
166
+
167
+ await expect(request).rejects.toBeInstanceOf(Error);
168
+ expect(apiAIAssistant.resolveFromRtdEvent('POST_CALL_SUMMARY', 'conversation-1', {})).toBe(
169
+ 'not-found'
170
+ );
171
+ });
172
+
173
+
45
174
  it('should send transcript start event successfully', async () => {
46
175
  (mockWebex.request as jest.Mock).mockResolvedValue({body: {ok: true}});
47
176
 
@@ -50,26 +179,23 @@ describe('ApiAIAssistant', () => {
50
179
  'interaction-1',
51
180
  'CUSTOM_EVENT',
52
181
  'GET_TRANSCRIPTS',
53
- 'START'
182
+ {action: 'START', actionTimeStamp: 'caller-supplied'}
54
183
  );
55
184
 
56
- expect(mockWebex.request).toHaveBeenCalledWith({
57
- uri: 'https://api-ai-assistant.produs1.ciscoccservice.com/event',
58
- method: HTTP_METHODS.POST,
59
- addAuthHeader: true,
60
- body: {
61
- agentId: 'test-agent-id',
62
- orgId: 'test-org-id',
63
- eventType: 'CUSTOM_EVENT',
64
- eventName: 'GET_TRANSCRIPTS',
65
- eventDetails: {
66
- data: expect.objectContaining({
67
- interactionId: 'interaction-1',
68
- action: 'START',
69
- }),
70
- },
71
- },
72
- });
185
+ expect(mockWebex.request).toHaveBeenCalledTimes(1);
186
+ const requestArgs = (mockWebex.request as jest.Mock).mock.calls[0][0];
187
+
188
+ expect(requestArgs.uri).toBe('https://api-ai-assistant.produs1.ciscoccservice.com/event');
189
+ expect(requestArgs.method).toBe(HTTP_METHODS.POST);
190
+ expect(requestArgs.addAuthHeader).toBe(true);
191
+ expect(requestArgs.body.agentId).toBe('test-agent-id');
192
+ expect(requestArgs.body.orgId).toBe('test-org-id');
193
+ expect(requestArgs.body.eventType).toBe('CUSTOM_EVENT');
194
+ expect(requestArgs.body.eventName).toBe('GET_TRANSCRIPTS');
195
+ expect(requestArgs.body.eventDetails.data.interactionId).toBe('interaction-1');
196
+ expect(requestArgs.body.eventDetails.data.action).toBe('START');
197
+ expect(requestArgs.body.eventDetails.data.actionTimeStamp).toEqual(expect.any(String));
198
+ expect(requestArgs.body.eventDetails.data.actionTimeStamp).not.toBe('caller-supplied');
73
199
  expect(result).toEqual({ok: true});
74
200
  });
75
201
 
@@ -93,6 +219,131 @@ describe('ApiAIAssistant', () => {
93
219
  expect(result).toEqual(responseBody as any);
94
220
  });
95
221
 
222
+ it('rejects an invalid agentId/interactionId and does not call webex.request', async () => {
223
+ apiAIAssistant.setAIFeatureFlags({realtimeTranscripts: {enable: true}} as any);
224
+
225
+ await expect(
226
+ apiAIAssistant.fetchHistoricTranscripts('', 'interaction-1')
227
+ ).rejects.toBeDefined();
228
+ await expect(
229
+ apiAIAssistant.fetchHistoricTranscripts('test-agent-id', 'bad id!')
230
+ ).rejects.toBeDefined();
231
+
232
+ expect(mockWebex.request).not.toHaveBeenCalled();
233
+ });
234
+
235
+ it('should request real-time assistance without extra context using sendEvent', async () => {
236
+ const sendEventSpy = jest.spyOn(apiAIAssistant, 'sendEvent').mockResolvedValue({ok: true});
237
+ apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: true}} as any);
238
+
239
+ const result = await apiAIAssistant.getRealTimeAssistance({
240
+ agentId: 'test-agent-id',
241
+ interactionId: 'interaction-1',
242
+ });
243
+
244
+ expect(sendEventSpy).toHaveBeenCalledTimes(1);
245
+ const [agentId, interactionId, eventType, eventName, metadata, languageCode, trackingId] =
246
+ sendEventSpy.mock.calls[0];
247
+
248
+ expect(agentId).toBe('test-agent-id');
249
+ expect(interactionId).toBe('interaction-1');
250
+ expect(eventType).toBe('CUSTOM_EVENT');
251
+ expect(eventName).toBe('GET_SUGGESTIONS');
252
+ expect(metadata).toBeUndefined();
253
+ expect(languageCode).toBe('en');
254
+ expect(typeof trackingId).toBe('string');
255
+ expect(trackingId.startsWith('WX_CC_SDK_')).toBe(true);
256
+ expect(result).toEqual({ok: true});
257
+ });
258
+
259
+ it('should request real-time assistance with extra context using sendEvent', async () => {
260
+ const sendEventSpy = jest.spyOn(apiAIAssistant, 'sendEvent').mockResolvedValue({ok: true});
261
+ apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: true}} as any);
262
+
263
+ const result = await apiAIAssistant.getRealTimeAssistance({
264
+ agentId: 'test-agent-id',
265
+ interactionId: 'interaction-1',
266
+ context: 'Need assistance with credit card payment due date',
267
+ });
268
+
269
+ expect(sendEventSpy).toHaveBeenCalledTimes(1);
270
+ const [agentId, interactionId, eventType, eventName, metadata, languageCode, trackingId] =
271
+ sendEventSpy.mock.calls[0];
272
+
273
+ expect(agentId).toBe('test-agent-id');
274
+ expect(interactionId).toBe('interaction-1');
275
+ expect(eventType).toBe('CUSTOM_EVENT');
276
+ expect(eventName).toBe('ADD_SUGGESTIONS_EXTRA_CONTEXT');
277
+ expect(metadata).toEqual({context: 'Need assistance with credit card payment due date'});
278
+ expect(languageCode).toBe('en');
279
+ expect(typeof trackingId).toBe('string');
280
+ expect(trackingId.startsWith('WX_CC_SDK_')).toBe(true);
281
+ expect(result).toEqual({ok: true});
282
+ });
283
+
284
+ it('should treat whitespace-only context as GET_SUGGESTIONS', async () => {
285
+ const sendEventSpy = jest.spyOn(apiAIAssistant, 'sendEvent').mockResolvedValue({ok: true});
286
+ apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: true}} as any);
287
+
288
+ const result = await apiAIAssistant.getRealTimeAssistance({
289
+ agentId: 'test-agent-id',
290
+ interactionId: 'interaction-1',
291
+ context: ' ',
292
+ });
293
+
294
+ expect(sendEventSpy).toHaveBeenCalledTimes(1);
295
+ const [agentId, interactionId, eventType, eventName, metadata, languageCode, trackingId] =
296
+ sendEventSpy.mock.calls[0];
297
+
298
+ expect(agentId).toBe('test-agent-id');
299
+ expect(interactionId).toBe('interaction-1');
300
+ expect(eventType).toBe('CUSTOM_EVENT');
301
+ expect(eventName).toBe('GET_SUGGESTIONS');
302
+ expect(metadata).toEqual({context: ''});
303
+ expect(languageCode).toBe('en');
304
+ expect(typeof trackingId).toBe('string');
305
+ expect(trackingId.startsWith('WX_CC_SDK_')).toBe(true);
306
+ expect(result).toEqual({ok: true});
307
+ });
308
+
309
+ [
310
+ RealTimeAssistanceUserActionId.LIKE,
311
+ RealTimeAssistanceUserActionId.DISLIKE,
312
+ RealTimeAssistanceUserActionId.COPY,
313
+ ].forEach((actionId) => {
314
+ it(`should send real-time assistance user action for ${actionId}`, async () => {
315
+ (mockWebex.request as jest.Mock).mockResolvedValue({body: {ok: true}});
316
+ apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: true}} as any);
317
+
318
+ const result = await apiAIAssistant.sendRealTimeAssistanceUserAction({
319
+ agentId: 'test-agent-id',
320
+ interactionId: 'interaction-1',
321
+ adaptiveCardId: 'adaptive-card-1',
322
+ actionId,
323
+ });
324
+
325
+ expect(mockWebex.request).toHaveBeenCalledTimes(1);
326
+ const requestArgs = (mockWebex.request as jest.Mock).mock.calls[0][0];
327
+ const eventData = requestArgs.body.eventDetails.data;
328
+
329
+ expect(requestArgs.uri).toBe('https://api-ai-assistant.produs1.ciscoccservice.com/event');
330
+ expect(requestArgs.method).toBe(HTTP_METHODS.POST);
331
+ expect(requestArgs.addAuthHeader).toBe(true);
332
+ expect(requestArgs.body.agentId).toBe('test-agent-id');
333
+ expect(requestArgs.body.orgId).toBe('test-org-id');
334
+ expect(requestArgs.body.eventType).toBe('CUSTOM_EVENT');
335
+ expect(requestArgs.body.eventName).toBe('SUGGESTED_RESPONSES_USER_ACTION');
336
+ expect(eventData.interactionId).toBe('interaction-1');
337
+ expect(eventData.adaptiveCardId).toBe('adaptive-card-1');
338
+ expect(eventData.userAction.actionType).toBe('Action.Submit');
339
+ expect(eventData.userAction.actionId).toBe(actionId);
340
+ expect(eventData.languageCode).toBe('en');
341
+ expect(typeof eventData.actionTimeStamp).toBe('string');
342
+ expect(eventData.trackingId.startsWith('WX_CC_SDK_')).toBe(true);
343
+ expect(result).toEqual({ok: true});
344
+ });
345
+ });
346
+
96
347
  it('should fail when base URL mapping is not available', async () => {
97
348
  (mockWebex.internal.services.get as jest.Mock).mockReturnValue('https://unknown-host.invalid');
98
349
 
@@ -103,7 +354,7 @@ describe('ApiAIAssistant', () => {
103
354
  'interaction-1',
104
355
  'CUSTOM_EVENT',
105
356
  'GET_TRANSCRIPTS',
106
- 'STOP'
357
+ {action: 'STOP'}
107
358
  );
108
359
  } catch (_error) {
109
360
  failed = true;
@@ -112,4 +363,172 @@ describe('ApiAIAssistant', () => {
112
363
  expect(failed).toBe(true);
113
364
  expect(LoggerProxy.error).toHaveBeenCalled();
114
365
  });
366
+
367
+ it('should fail when realtime transcripts feature is disabled', async () => {
368
+ apiAIAssistant.setAIFeatureFlags({realtimeTranscripts: {enable: false}} as any);
369
+ let errorMessage = '';
370
+
371
+ try {
372
+ await apiAIAssistant.fetchHistoricTranscripts('test-agent-id', 'interaction-1');
373
+ } catch (error) {
374
+ errorMessage = (error as Error)?.message || '';
375
+ }
376
+
377
+ expect(errorMessage).toBe('Error while performing fetchHistoricTranscripts');
378
+ });
379
+
380
+ it('should fail when real-time assistance feature is disabled', async () => {
381
+ apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: false}} as any);
382
+ let errorMessage = '';
383
+
384
+ try {
385
+ await apiAIAssistant.getRealTimeAssistance({
386
+ agentId: 'test-agent-id',
387
+ interactionId: 'interaction-1',
388
+ });
389
+ } catch (error) {
390
+ errorMessage = (error as Error)?.message || '';
391
+ }
392
+
393
+ expect(errorMessage).toBe('Error while performing getRealTimeAssistance');
394
+ });
395
+
396
+ it('should fail to send real-time assistance user action when feature is disabled', async () => {
397
+ apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: false}} as any);
398
+ let errorMessage = '';
399
+
400
+ try {
401
+ await apiAIAssistant.sendRealTimeAssistanceUserAction({
402
+ agentId: 'test-agent-id',
403
+ interactionId: 'interaction-1',
404
+ adaptiveCardId: 'adaptive-card-1',
405
+ actionId: RealTimeAssistanceUserActionId.LIKE,
406
+ });
407
+ } catch (error) {
408
+ errorMessage = (error as Error)?.message || '';
409
+ }
410
+
411
+ expect(errorMessage).toBe('Error while performing sendRealTimeAssistanceUserAction');
412
+ });
413
+
414
+ describe('Agent Wellness Break actions', () => {
415
+ beforeEach(() => {
416
+ wellnessContext = {
417
+ isWellnessBreakEnabled: true,
418
+ agentId: 'test-agent-id',
419
+ agentSessionId: 'session-1',
420
+ };
421
+ });
422
+
423
+ it('does not expose wellness context mutation on the public assistant instance', () => {
424
+ expect(apiAIAssistant).not.toHaveProperty('setWellnessContext');
425
+ });
426
+
427
+ it('sends the exact REQUESTED body and resolves only for HTTP 202', async () => {
428
+ jest.spyOn(Date, 'now').mockReturnValue(1787640000000);
429
+ (mockWebex.request as jest.Mock).mockResolvedValue({statusCode: 202});
430
+
431
+ await expect(apiAIAssistant.requestWellnessBreak()).resolves.toBeUndefined();
432
+
433
+ expect(mockWebex.request).toHaveBeenCalledWith({
434
+ uri: 'https://api-ai-assistant.produs1.ciscoccservice.com/event',
435
+ method: HTTP_METHODS.POST,
436
+ addAuthHeader: true,
437
+ body: {
438
+ agentId: 'test-agent-id',
439
+ orgId: 'test-org-id',
440
+ eventType: 'CUSTOM_EVENT',
441
+ eventName: 'WellnessBreakAction',
442
+ eventDetails: {
443
+ data: {
444
+ action: 'REQUESTED',
445
+ agentSessionId: 'session-1',
446
+ actionTimeStamp: 1787640000000,
447
+ },
448
+ },
449
+ },
450
+ });
451
+ });
452
+
453
+ it.each([
454
+ WELLNESS_BREAK_USER_ACTIONS.ACCEPTED,
455
+ WELLNESS_BREAK_USER_ACTIONS.REJECTED,
456
+ WELLNESS_BREAK_USER_ACTIONS.NO_RESPONSE,
457
+ ] as const)(
458
+ 'sends the %s offer action',
459
+ async (action) => {
460
+ (mockWebex.request as jest.Mock).mockResolvedValue({statusCode: 202});
461
+
462
+ await apiAIAssistant.respondToWellnessBreak({action});
463
+
464
+ expect(
465
+ (mockWebex.request as jest.Mock).mock.calls[0][0].body.eventDetails.data.action
466
+ ).toBe(action);
467
+ }
468
+ );
469
+
470
+ it('rejects disabled or incomplete internal session context before HTTP', async () => {
471
+ wellnessContext = {
472
+ isWellnessBreakEnabled: false,
473
+ agentId: 'test-agent-id',
474
+ agentSessionId: 'session-1',
475
+ };
476
+ await expect(apiAIAssistant.requestWellnessBreak()).rejects.toThrow(
477
+ 'WELLNESS_BREAK_NOT_ENABLED'
478
+ );
479
+
480
+ wellnessContext = {
481
+ isWellnessBreakEnabled: true,
482
+ };
483
+ await expect(apiAIAssistant.requestWellnessBreak()).rejects.toThrow(
484
+ 'WELLNESS_BREAK_AGENT_ID_REQUIRED'
485
+ );
486
+
487
+ wellnessContext = {
488
+ isWellnessBreakEnabled: true,
489
+ agentId: 'test-agent-id',
490
+ };
491
+ await expect(apiAIAssistant.requestWellnessBreak()).rejects.toThrow(
492
+ 'WELLNESS_BREAK_AGENT_SESSION_REQUIRED'
493
+ );
494
+ expect(mockWebex.request).not.toHaveBeenCalled();
495
+ });
496
+
497
+ it('rejects a missing organization before HTTP', async () => {
498
+ (mockWebex.credentials.getOrgId as jest.Mock).mockReturnValue(' ');
499
+
500
+ await expect(apiAIAssistant.requestWellnessBreak()).rejects.toThrow(
501
+ 'WELLNESS_BREAK_ORG_ID_REQUIRED'
502
+ );
503
+ expect(mockWebex.request).not.toHaveBeenCalled();
504
+ });
505
+
506
+ it.each([200, 204, 400, 401, 403, 404, 409, 429, 500])(
507
+ 'rejects the non-202 HTTP status %i',
508
+ async (statusCode) => {
509
+ (mockWebex.request as jest.Mock).mockResolvedValue({statusCode});
510
+
511
+ await expect(apiAIAssistant.requestWellnessBreak()).rejects.toThrow(
512
+ `WELLNESS_BREAK_ACTION_UNEXPECTED_STATUS_${statusCode}`
513
+ );
514
+ }
515
+ );
516
+
517
+ it('rejects network failures through the structured error path', async () => {
518
+ (mockWebex.request as jest.Mock).mockRejectedValue(new Error('Network unavailable'));
519
+
520
+ await expect(apiAIAssistant.requestWellnessBreak()).rejects.toThrow(
521
+ 'Error while performing requestWellnessBreak'
522
+ );
523
+ });
524
+
525
+ it('rejects unsupported offer actions before HTTP', async () => {
526
+ await expect(
527
+ apiAIAssistant.respondToWellnessBreak({
528
+ action: 'REQUESTED',
529
+ } as unknown as Parameters<ApiAIAssistant['respondToWellnessBreak']>[0])
530
+ ).rejects.toThrow('WELLNESS_BREAK_ACTION_INVALID');
531
+ expect(mockWebex.request).not.toHaveBeenCalled();
532
+ });
533
+ });
115
534
  });