@webex/contact-center 3.12.0-webex-services-ready.4 → 3.13.0-next.1

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 (250) hide show
  1. package/.sdd/manifest.json +24 -13
  2. package/ai-docs/ARCHITECTURE.md +1 -1
  3. package/ai-docs/CONTRACTS.md +21 -3
  4. package/ai-docs/SECURITY.md +1 -1
  5. package/ai-docs/SERVICE_STATE.md +4 -0
  6. package/ai-docs/contact-center-spec.md +53 -6
  7. package/ai-docs/features/consult-transfer-list-policy/spec/feature-spec.md +362 -0
  8. package/ai-docs/features/contact-owner-change-refactor.md +78 -0
  9. package/dist/cc.js +816 -26
  10. package/dist/cc.js.map +1 -1
  11. package/dist/config.js +7 -0
  12. package/dist/config.js.map +1 -1
  13. package/dist/constants.js +29 -2
  14. package/dist/constants.js.map +1 -1
  15. package/dist/index.js +66 -12
  16. package/dist/index.js.map +1 -1
  17. package/dist/metrics/MetricsManager.js +16 -0
  18. package/dist/metrics/MetricsManager.js.map +1 -1
  19. package/dist/metrics/behavioral-events.js +110 -0
  20. package/dist/metrics/behavioral-events.js.map +1 -1
  21. package/dist/metrics/constants.js +33 -0
  22. package/dist/metrics/constants.js.map +1 -1
  23. package/dist/services/AddressBook.js +18 -15
  24. package/dist/services/AddressBook.js.map +1 -1
  25. package/dist/services/AnswerCallOnWebexService.js +202 -0
  26. package/dist/services/AnswerCallOnWebexService.js.map +1 -0
  27. package/dist/services/ApiAiAssistant.js +221 -11
  28. package/dist/services/ApiAiAssistant.js.map +1 -1
  29. package/dist/services/EntryPoint.js +46 -68
  30. package/dist/services/EntryPoint.js.map +1 -1
  31. package/dist/services/Queue.js +27 -22
  32. package/dist/services/Queue.js.map +1 -1
  33. package/dist/services/WebCallingService.js +287 -37
  34. package/dist/services/WebCallingService.js.map +1 -1
  35. package/dist/services/WebexCrossClientService.js +225 -0
  36. package/dist/services/WebexCrossClientService.js.map +1 -0
  37. package/dist/services/WxAppTelephonyMercurySync.js +111 -0
  38. package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
  39. package/dist/services/config/Util.js +46 -46
  40. package/dist/services/config/Util.js.map +1 -1
  41. package/dist/services/config/constants.js +34 -77
  42. package/dist/services/config/constants.js.map +1 -1
  43. package/dist/services/config/index.js +100 -226
  44. package/dist/services/config/index.js.map +1 -1
  45. package/dist/services/config/types.js +55 -35
  46. package/dist/services/config/types.js.map +1 -1
  47. package/dist/services/constants.js +11 -1
  48. package/dist/services/constants.js.map +1 -1
  49. package/dist/services/core/Err.js.map +1 -1
  50. package/dist/services/core/Utils.js +25 -1
  51. package/dist/services/core/Utils.js.map +1 -1
  52. package/dist/services/core/WebexRequest.js +6 -2
  53. package/dist/services/core/WebexRequest.js.map +1 -1
  54. package/dist/services/core/aqm-reqs.js +17 -11
  55. package/dist/services/core/aqm-reqs.js.map +1 -1
  56. package/dist/services/core/constants.js +9 -1
  57. package/dist/services/core/constants.js.map +1 -1
  58. package/dist/services/core/types.js.map +1 -1
  59. package/dist/services/core/websocket/WebSocketManager.js +17 -1
  60. package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
  61. package/dist/services/task/Task.js +275 -8
  62. package/dist/services/task/Task.js.map +1 -1
  63. package/dist/services/task/TaskFactory.js +11 -6
  64. package/dist/services/task/TaskFactory.js.map +1 -1
  65. package/dist/services/task/TaskManager.js +590 -42
  66. package/dist/services/task/TaskManager.js.map +1 -1
  67. package/dist/services/task/TaskUtils.js +11 -1
  68. package/dist/services/task/TaskUtils.js.map +1 -1
  69. package/dist/services/task/WebexCallingUtils.js +70 -0
  70. package/dist/services/task/WebexCallingUtils.js.map +1 -0
  71. package/dist/services/task/constants.js +14 -2
  72. package/dist/services/task/constants.js.map +1 -1
  73. package/dist/services/task/contact.js +29 -0
  74. package/dist/services/task/contact.js.map +1 -1
  75. package/dist/services/task/digital/Digital.js +4 -3
  76. package/dist/services/task/digital/Digital.js.map +1 -1
  77. package/dist/services/task/state-machine/TaskStateMachine.js +162 -53
  78. package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -1
  79. package/dist/services/task/state-machine/actions.js +6 -1
  80. package/dist/services/task/state-machine/actions.js.map +1 -1
  81. package/dist/services/task/state-machine/guards.js +7 -10
  82. package/dist/services/task/state-machine/guards.js.map +1 -1
  83. package/dist/services/task/state-machine/types.js.map +1 -1
  84. package/dist/services/task/state-machine/uiControlsComputer.js +118 -18
  85. package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -1
  86. package/dist/services/task/types.js +47 -1
  87. package/dist/services/task/types.js.map +1 -1
  88. package/dist/services/task/voice/Voice.js +477 -17
  89. package/dist/services/task/voice/Voice.js.map +1 -1
  90. package/dist/services/task/voice/WebRTC.js +6 -3
  91. package/dist/services/task/voice/WebRTC.js.map +1 -1
  92. package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
  93. package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
  94. package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
  95. package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
  96. package/dist/services/wxAppDiagnosticLogging.js +159 -0
  97. package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
  98. package/dist/services/wxAppTelephonyUtils.js +19 -0
  99. package/dist/services/wxAppTelephonyUtils.js.map +1 -0
  100. package/dist/types/cc.d.ts +127 -9
  101. package/dist/types/config.d.ts +7 -0
  102. package/dist/types/constants.d.ts +23 -0
  103. package/dist/types/index.d.ts +38 -17
  104. package/dist/types/metrics/MetricsManager.d.ts +6 -0
  105. package/dist/types/metrics/constants.d.ts +31 -0
  106. package/dist/types/services/AddressBook.d.ts +2 -1
  107. package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
  108. package/dist/types/services/ApiAiAssistant.d.ts +48 -4
  109. package/dist/types/services/EntryPoint.d.ts +7 -5
  110. package/dist/types/services/Queue.d.ts +5 -3
  111. package/dist/types/services/WebexCrossClientService.d.ts +32 -0
  112. package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
  113. package/dist/types/services/config/Util.d.ts +4 -8
  114. package/dist/types/services/config/constants.d.ts +28 -76
  115. package/dist/types/services/config/index.d.ts +16 -64
  116. package/dist/types/services/config/types.d.ts +150 -173
  117. package/dist/types/services/constants.d.ts +9 -0
  118. package/dist/types/services/core/Err.d.ts +2 -0
  119. package/dist/types/services/core/Utils.d.ts +10 -0
  120. package/dist/types/services/core/WebexRequest.d.ts +1 -0
  121. package/dist/types/services/core/constants.d.ts +7 -0
  122. package/dist/types/services/core/types.d.ts +2 -0
  123. package/dist/types/services/task/Task.d.ts +34 -5
  124. package/dist/types/services/task/TaskFactory.d.ts +4 -2
  125. package/dist/types/services/task/TaskUtils.d.ts +6 -0
  126. package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
  127. package/dist/types/services/task/constants.d.ts +12 -0
  128. package/dist/types/services/task/contact.d.ts +4 -0
  129. package/dist/types/services/task/digital/Digital.d.ts +4 -3
  130. package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +304 -56
  131. package/dist/types/services/task/state-machine/guards.d.ts +6 -5
  132. package/dist/types/services/task/state-machine/types.d.ts +9 -1
  133. package/dist/types/services/task/types.d.ts +192 -5
  134. package/dist/types/services/task/voice/Voice.d.ts +68 -11
  135. package/dist/types/services/task/voice/WebRTC.d.ts +5 -4
  136. package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
  137. package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
  138. package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
  139. package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
  140. package/dist/types/types.d.ts +125 -13
  141. package/dist/types/utils/PageCache.d.ts +20 -3
  142. package/dist/types.js +90 -8
  143. package/dist/types.js.map +1 -1
  144. package/dist/utils/PageCache.js +19 -5
  145. package/dist/utils/PageCache.js.map +1 -1
  146. package/dist/webex.js +9 -1
  147. package/dist/webex.js.map +1 -1
  148. package/package.json +10 -9
  149. package/src/cc.ts +1047 -48
  150. package/src/config.ts +7 -0
  151. package/src/constants.ts +36 -0
  152. package/src/index.ts +49 -11
  153. package/src/metrics/MetricsManager.ts +16 -0
  154. package/src/metrics/ai-docs/metrics-spec.md +138 -21
  155. package/src/metrics/behavioral-events.ts +112 -0
  156. package/src/metrics/constants.ts +36 -0
  157. package/src/services/AddressBook.ts +17 -6
  158. package/src/services/AnswerCallOnWebexService.ts +239 -0
  159. package/src/services/ApiAiAssistant.ts +297 -13
  160. package/src/services/EntryPoint.ts +59 -60
  161. package/src/services/Queue.ts +29 -12
  162. package/src/services/WebCallingService.ts +362 -40
  163. package/src/services/WebexCrossClientService.ts +298 -0
  164. package/src/services/WxAppTelephonyMercurySync.ts +142 -0
  165. package/src/services/agent/ai-docs/AGENTS.md +1 -1
  166. package/src/services/agent/ai-docs/agent-spec.md +1 -0
  167. package/src/services/ai-docs/AGENTS.md +11 -11
  168. package/src/services/ai-docs/services-spec.md +25 -5
  169. package/src/services/config/Util.ts +52 -82
  170. package/src/services/config/ai-docs/AGENTS.md +35 -40
  171. package/src/services/config/ai-docs/ARCHITECTURE.md +90 -103
  172. package/src/services/config/ai-docs/config-spec.md +132 -132
  173. package/src/services/config/constants.ts +39 -85
  174. package/src/services/config/index.ts +116 -277
  175. package/src/services/config/types.ts +145 -195
  176. package/src/services/constants.ts +10 -0
  177. package/src/services/core/Err.ts +1 -0
  178. package/src/services/core/Utils.ts +28 -0
  179. package/src/services/core/WebexRequest.ts +3 -1
  180. package/src/services/core/ai-docs/core-spec.md +25 -11
  181. package/src/services/core/aqm-reqs.ts +18 -12
  182. package/src/services/core/constants.ts +8 -0
  183. package/src/services/core/types.ts +33 -1
  184. package/src/services/core/websocket/WebSocketManager.ts +26 -2
  185. package/src/services/task/Task.ts +386 -12
  186. package/src/services/task/TaskFactory.ts +33 -6
  187. package/src/services/task/TaskManager.ts +857 -41
  188. package/src/services/task/TaskUtils.ts +13 -0
  189. package/src/services/task/WebexCallingUtils.ts +136 -0
  190. package/src/services/task/ai-docs/ARCHITECTURE.md +1 -0
  191. package/src/services/task/ai-docs/task-spec.md +190 -8
  192. package/src/services/task/constants.ts +13 -0
  193. package/src/services/task/contact.ts +30 -0
  194. package/src/services/task/digital/Digital.ts +11 -4
  195. package/src/services/task/state-machine/TaskStateMachine.ts +235 -81
  196. package/src/services/task/state-machine/actions.ts +5 -2
  197. package/src/services/task/state-machine/ai-docs/AGENTS.md +6 -4
  198. package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +35 -16
  199. package/src/services/task/state-machine/ai-docs/task-state-machine-spec.md +103 -33
  200. package/src/services/task/state-machine/guards.ts +7 -10
  201. package/src/services/task/state-machine/types.ts +16 -1
  202. package/src/services/task/state-machine/uiControlsComputer.ts +206 -32
  203. package/src/services/task/types.ts +269 -4
  204. package/src/services/task/voice/Voice.ts +625 -17
  205. package/src/services/task/voice/WebRTC.ts +11 -4
  206. package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
  207. package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
  208. package/src/services/wxAppDiagnosticLogging.ts +286 -0
  209. package/src/services/wxAppTelephonyUtils.ts +14 -0
  210. package/src/types.ts +159 -13
  211. package/src/utils/AGENTS.md +21 -10
  212. package/src/utils/PageCache.ts +38 -5
  213. package/src/utils/ai-docs/utils-spec.md +21 -11
  214. package/src/webex.js +8 -0
  215. package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
  216. package/test/unit/spec/cc.ts +3595 -120
  217. package/test/unit/spec/index.ts +891 -0
  218. package/test/unit/spec/metrics/MetricsManager.ts +25 -0
  219. package/test/unit/spec/metrics/behavioral-events.ts +60 -0
  220. package/test/unit/spec/services/AddressBook.ts +37 -6
  221. package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
  222. package/test/unit/spec/services/ApiAiAssistant.ts +269 -8
  223. package/test/unit/spec/services/EntryPoint.ts +87 -40
  224. package/test/unit/spec/services/Queue.ts +123 -12
  225. package/test/unit/spec/services/WebCallingService.ts +483 -54
  226. package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
  227. package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
  228. package/test/unit/spec/services/config/Util.ts +501 -0
  229. package/test/unit/spec/services/config/index.ts +313 -543
  230. package/test/unit/spec/services/core/Utils.ts +22 -0
  231. package/test/unit/spec/services/core/WebexRequest.ts +8 -7
  232. package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
  233. package/test/unit/spec/services/core/websocket/WebSocketManager.ts +64 -14
  234. package/test/unit/spec/services/task/Task.ts +2257 -11
  235. package/test/unit/spec/services/task/TaskFactory.ts +56 -2
  236. package/test/unit/spec/services/task/TaskManager.ts +5559 -1493
  237. package/test/unit/spec/services/task/TaskUtils.ts +72 -0
  238. package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
  239. package/test/unit/spec/services/task/contact.ts +33 -0
  240. package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +1501 -92
  241. package/test/unit/spec/services/task/state-machine/guards.ts +210 -8
  242. package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +445 -7
  243. package/test/unit/spec/services/task/voice/Voice.ts +1710 -4
  244. package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
  245. package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
  246. package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
  247. package/test/unit/spec/wellnessSampleUtils.ts +288 -0
  248. package/typedoc.md +1 -1
  249. package/umd/contact-center.min.js +2 -2
  250. package/umd/contact-center.min.js.map +1 -1
@@ -2,21 +2,67 @@ import ApiAIAssistant from '../../../../src/services/ApiAiAssistant';
2
2
  import MetricsManager from '../../../../src/metrics/MetricsManager';
3
3
  import LoggerProxy from '../../../../src/logger-proxy';
4
4
  import WebexRequest from '../../../../src/services/core/WebexRequest';
5
- import {HTTP_METHODS, RealTimeAssistanceUserActionId, WebexSDK} from '../../../../src/types';
5
+ import {
6
+ HTTP_METHODS,
7
+ RealTimeAssistanceUserActionId,
8
+ WELLNESS_BREAK_USER_ACTIONS,
9
+ WebexSDK,
10
+ } from '../../../../src/types';
11
+
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
+ });
6
47
 
7
- jest.mock('../../../../src/metrics/MetricsManager');
8
- jest.mock('../../../../src/logger-proxy');
48
+ return {error: detailedError, reason};
49
+ }),
50
+ }));
9
51
 
10
52
  describe('ApiAIAssistant', () => {
11
53
  let apiAIAssistant: ApiAIAssistant;
12
54
  let mockWebex: WebexSDK;
13
55
  let mockMetricsManager: jest.Mocked<MetricsManager>;
56
+ let mockUploadLogs: jest.Mock;
57
+ let wellnessContext: {
58
+ isWellnessBreakEnabled: boolean;
59
+ agentId?: string;
60
+ agentSessionId?: string;
61
+ };
14
62
 
15
63
  beforeEach(() => {
16
64
  jest.clearAllMocks();
17
- jest.spyOn(WebexRequest, 'getInstance').mockReturnValue({
18
- uploadLogs: jest.fn(),
19
- } as any);
65
+ mockUploadLogs = jest.fn();
20
66
 
21
67
  mockWebex = {
22
68
  credentials: {
@@ -37,15 +83,94 @@ describe('ApiAIAssistant', () => {
37
83
  once: jest.fn(),
38
84
  } as unknown as WebexSDK;
39
85
 
86
+ jest.spyOn(WebexRequest, 'getInstance').mockReturnValue({
87
+ request: mockWebex.request,
88
+ uploadLogs: mockUploadLogs,
89
+ } as any);
90
+
40
91
  mockMetricsManager = {
41
92
  trackEvent: jest.fn(),
42
93
  timeEvent: jest.fn(),
43
94
  } as unknown as jest.Mocked<MetricsManager>;
44
95
  (MetricsManager.getInstance as jest.Mock).mockReturnValue(mockMetricsManager);
45
96
 
46
- 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
+ });
47
131
  });
48
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();
150
+ });
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
+
49
174
  it('should send transcript start event successfully', async () => {
50
175
  (mockWebex.request as jest.Mock).mockResolvedValue({body: {ok: true}});
51
176
 
@@ -54,7 +179,7 @@ describe('ApiAIAssistant', () => {
54
179
  'interaction-1',
55
180
  'CUSTOM_EVENT',
56
181
  'GET_TRANSCRIPTS',
57
- {action: 'START'}
182
+ {action: 'START', actionTimeStamp: 'caller-supplied'}
58
183
  );
59
184
 
60
185
  expect(mockWebex.request).toHaveBeenCalledTimes(1);
@@ -69,6 +194,8 @@ describe('ApiAIAssistant', () => {
69
194
  expect(requestArgs.body.eventName).toBe('GET_TRANSCRIPTS');
70
195
  expect(requestArgs.body.eventDetails.data.interactionId).toBe('interaction-1');
71
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');
72
199
  expect(result).toEqual({ok: true});
73
200
  });
74
201
 
@@ -92,6 +219,19 @@ describe('ApiAIAssistant', () => {
92
219
  expect(result).toEqual(responseBody as any);
93
220
  });
94
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
+
95
235
  it('should request real-time assistance without extra context using sendEvent', async () => {
96
236
  const sendEventSpy = jest.spyOn(apiAIAssistant, 'sendEvent').mockResolvedValue({ok: true});
97
237
  apiAIAssistant.setAIFeatureFlags({suggestedResponses: {enable: true}} as any);
@@ -270,4 +410,125 @@ describe('ApiAIAssistant', () => {
270
410
 
271
411
  expect(errorMessage).toBe('Error while performing sendRealTimeAssistanceUserAction');
272
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
+ });
273
534
  });
@@ -1,5 +1,5 @@
1
1
  import EntryPoint from '../../../../src/services/EntryPoint';
2
- import {HTTP_METHODS, WebexSDK, IHttpResponse} from '../../../../src/types';
2
+ import {HTTP_METHODS, WebexSDK, IHttpResponse, EntryPointRecord} from '../../../../src/types';
3
3
  import {METRIC_EVENT_NAMES} from '../../../../src/metrics/constants';
4
4
  import WebexRequest from '../../../../src/services/core/WebexRequest';
5
5
  import MetricsManager from '../../../../src/metrics/MetricsManager';
@@ -50,30 +50,38 @@ describe('EntryPoint', () => {
50
50
  });
51
51
 
52
52
  describe('getEntryPoints', () => {
53
- const mockEntryPoints = [
53
+ const mockDialNumberMappings = [
54
54
  {
55
- id: 'entry1',
56
- name: 'Test Entry Point 1',
57
- type: 'voice',
58
- isActive: true,
59
- orgId: 'test-org-id',
55
+ id: 'dial-number-1',
56
+ dialledNumber: '+1-555-0101',
57
+ entryPointId: 'entry1',
58
+ entryPointName: 'Test Entry Point 1',
60
59
  },
61
60
  {
62
- id: 'entry2',
63
- name: 'Test Entry Point 2',
64
- type: 'chat',
65
- isActive: true,
66
- orgId: 'test-org-id',
61
+ id: 'dial-number-2',
62
+ dialledNumber: '+1-555-0102',
63
+ entryPointId: 'entry2',
64
+ entryPointName: 'Test Entry Point 2',
67
65
  },
68
66
  ];
67
+ const expectedEntryPoints: EntryPointRecord[] = [
68
+ {id: 'entry1', name: 'Test Entry Point 1', number: '+1-555-0101'},
69
+ {id: 'entry2', name: 'Test Entry Point 2', number: '+1-555-0102'},
70
+ ];
71
+ const defaultResource =
72
+ '/organization/test-org-id/v3/dial-number?page=0&pageSize=100&attributes=id%2CdialledNumber%2CentryPointId%2CentryPointName&sort=entryPointName%2CASC&desktopProfileFilter=true&includeEntryPointName=true';
73
+ const requestHeaders = {
74
+ 'X-ORGANIZATION-ID': 'test-org-id',
75
+ 'x-ignore-internal-data': 'false',
76
+ };
69
77
 
70
78
  const mockResponse: IHttpResponse = {
71
79
  statusCode: 200,
72
80
  method: 'GET',
73
- url: '/organization/test-org-id/v2/entry-point',
81
+ url: '/organization/test-org-id/v3/dial-number',
74
82
  headers: {} as any,
75
83
  body: {
76
- data: mockEntryPoints,
84
+ data: mockDialNumberMappings,
77
85
  meta: {
78
86
  page: 0,
79
87
  pageSize: 100,
@@ -99,11 +107,14 @@ describe('EntryPoint', () => {
99
107
 
100
108
  expect(mockWebex.request).toHaveBeenCalledWith({
101
109
  service: 'wcc-api-gateway',
102
- resource: '/organization/test-org-id/v2/entry-point?page=0&pageSize=100&sortOrder=asc',
110
+ resource: defaultResource,
103
111
  method: HTTP_METHODS.GET,
112
+ body: undefined,
113
+ headers: requestHeaders,
104
114
  });
105
115
 
106
- expect(result).toEqual(mockResponse.body);
116
+ expect(result).toEqual({...mockResponse.body, data: expectedEntryPoints});
117
+ expect(result.data[0].number).toBe('+1-555-0101');
107
118
  expect(mockMetricsManager.timeEvent).toHaveBeenCalledWith(METRIC_EVENT_NAMES.ENTRYPOINT_FETCH_SUCCESS);
108
119
  expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
109
120
  METRIC_EVENT_NAMES.ENTRYPOINT_FETCH_SUCCESS,
@@ -122,7 +133,7 @@ describe('EntryPoint', () => {
122
133
  {module: 'EntryPoint', method: 'getEntryPoints'}
123
134
  );
124
135
  expect(LoggerProxy.log).toHaveBeenCalledWith(
125
- `Making API request to fetch entry points - resource: /organization/test-org-id/v2/entry-point?page=0&pageSize=100&sortOrder=asc, service: wcc-api-gateway`,
136
+ `Making API request to fetch entry points - resource: ${defaultResource}, service: wcc-api-gateway`,
126
137
  {module: 'EntryPoint', method: 'getEntryPoints'}
127
138
  );
128
139
  });
@@ -134,7 +145,7 @@ describe('EntryPoint', () => {
134
145
  page: 1,
135
146
  pageSize: 25,
136
147
  search: 'test',
137
- filter: 'type=="voice"',
148
+ filter: 'entryPointId=="entry1"',
138
149
  attributes: 'id,name',
139
150
  sortBy: 'name',
140
151
  sortOrder: 'desc' as const,
@@ -144,8 +155,11 @@ describe('EntryPoint', () => {
144
155
 
145
156
  expect(mockWebex.request).toHaveBeenCalledWith({
146
157
  service: 'wcc-api-gateway',
147
- resource: '/organization/test-org-id/v2/entry-point?page=1&pageSize=25&sortOrder=desc&search=test&filter=type%3D%3D%22voice%22&attributes=id%2Cname&sortBy=name',
158
+ resource:
159
+ '/organization/test-org-id/v3/dial-number?page=1&pageSize=25&attributes=id%2CdialledNumber%2CentryPointId%2CentryPointName%2Cname&search=test&filter=entryPointId%3D%3D%22entry1%22&sort=entryPointName%2CDESC&desktopProfileFilter=true&includeEntryPointName=true',
148
160
  method: HTTP_METHODS.GET,
161
+ body: undefined,
162
+ headers: requestHeaders,
149
163
  });
150
164
 
151
165
  expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
@@ -162,6 +176,41 @@ describe('EntryPoint', () => {
162
176
  );
163
177
  });
164
178
 
179
+ it('should allow existing parameters to override the default entry-point mapping policy', async () => {
180
+ (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
181
+
182
+ const result = await entryPointAPI.getEntryPoints({
183
+ page: 1,
184
+ pageSize: 25,
185
+ search: 'sales',
186
+ filter: 'entryPointId==entry1',
187
+ });
188
+
189
+ expect(mockWebex.request).toHaveBeenCalledWith({
190
+ service: 'wcc-api-gateway',
191
+ resource:
192
+ '/organization/test-org-id/v3/dial-number?page=1&pageSize=25&attributes=id%2CdialledNumber%2CentryPointId%2CentryPointName&search=sales&filter=entryPointId%3D%3Dentry1&sort=entryPointName%2CASC&desktopProfileFilter=true&includeEntryPointName=true',
193
+ method: HTTP_METHODS.GET,
194
+ body: undefined,
195
+ headers: requestHeaders,
196
+ });
197
+ expect(result).toEqual({...mockResponse.body, data: expectedEntryPoints});
198
+ });
199
+
200
+ it('should issue every profile-scoped request directly', async () => {
201
+ (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
202
+
203
+ await entryPointAPI.getEntryPoints();
204
+ await entryPointAPI.getEntryPoints();
205
+
206
+ expect(mockWebex.request).toHaveBeenCalledTimes(2);
207
+ expect(mockWebex.request).toHaveBeenLastCalledWith(
208
+ expect.objectContaining({
209
+ resource: expect.stringContaining('desktopProfileFilter=true'),
210
+ })
211
+ );
212
+ });
213
+
165
214
  it('should handle API errors and track metrics', async () => {
166
215
  (mockWebex.request as jest.Mock).mockRejectedValue(new Error('Internal Server Error'));
167
216
 
@@ -169,8 +218,10 @@ describe('EntryPoint', () => {
169
218
 
170
219
  expect(mockWebex.request).toHaveBeenCalledWith({
171
220
  service: 'wcc-api-gateway',
172
- resource: '/organization/test-org-id/v2/entry-point?page=0&pageSize=100&sortOrder=asc',
221
+ resource: defaultResource,
173
222
  method: HTTP_METHODS.GET,
223
+ body: undefined,
224
+ headers: requestHeaders,
174
225
  });
175
226
 
176
227
  expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
@@ -187,22 +238,24 @@ describe('EntryPoint', () => {
187
238
  expect(LoggerProxy.error).toHaveBeenCalled();
188
239
  });
189
240
 
190
-
191
-
192
- it('should not track metrics for subsequent pages in simple pagination', async () => {
241
+ it('should not track success metrics for subsequent pages under the default mapping policy', async () => {
193
242
  (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
194
243
 
195
244
  const result = await entryPointAPI.getEntryPoints({page: 2});
196
- expect(result).toEqual(mockResponse.body);
245
+ expect(result).toEqual({...mockResponse.body, data: expectedEntryPoints});
197
246
 
198
- expect(mockMetricsManager.trackEvent).not.toHaveBeenCalled();
247
+ expect(mockMetricsManager.trackEvent).not.toHaveBeenCalledWith(
248
+ METRIC_EVENT_NAMES.ENTRYPOINT_FETCH_SUCCESS,
249
+ expect.anything(),
250
+ expect.anything()
251
+ );
199
252
  });
200
253
 
201
254
  it('should track metrics for search requests on any page', async () => {
202
255
  (mockWebex.request as jest.Mock).mockResolvedValue(mockResponse);
203
256
 
204
257
  const result2 = await entryPointAPI.getEntryPoints({page: 2, search: 'test'});
205
- expect(result2).toEqual(mockResponse.body);
258
+ expect(result2).toEqual({...mockResponse.body, data: expectedEntryPoints});
206
259
 
207
260
  expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
208
261
  METRIC_EVENT_NAMES.ENTRYPOINT_FETCH_SUCCESS,
@@ -218,15 +271,11 @@ describe('EntryPoint', () => {
218
271
  );
219
272
  });
220
273
 
221
- it('should call API when requested page is not cached (cache miss)', async () => {
222
- (mockWebex.request as jest.Mock).mockResolvedValueOnce(mockResponse);
223
-
224
- await entryPointAPI.getEntryPoints({page: 0});
225
-
226
- (mockWebex.request as jest.Mock).mockResolvedValueOnce({
274
+ it('should request the specified page', async () => {
275
+ (mockWebex.request as jest.Mock).mockResolvedValue({
227
276
  ...mockResponse,
228
277
  body: {
229
- data: mockEntryPoints,
278
+ data: mockDialNumberMappings,
230
279
  meta: {
231
280
  page: 1,
232
281
  pageSize: 100,
@@ -237,21 +286,19 @@ describe('EntryPoint', () => {
237
286
  },
238
287
  });
239
288
 
240
- const callsBefore = (mockWebex.request as jest.Mock).mock.calls.length;
241
- (LoggerProxy.log as jest.Mock).mockClear();
242
-
243
289
  const result = await entryPointAPI.getEntryPoints({page: 1});
244
- const callsAfter = (mockWebex.request as jest.Mock).mock.calls.length;
245
290
 
246
- expect(callsAfter).toBe(callsBefore + 1);
247
291
  expect(result.meta.page).toBe(1);
248
292
  expect(mockWebex.request).toHaveBeenCalledWith({
249
293
  service: 'wcc-api-gateway',
250
- resource: '/organization/test-org-id/v2/entry-point?page=1&pageSize=100&sortOrder=asc',
294
+ resource:
295
+ '/organization/test-org-id/v3/dial-number?page=1&pageSize=100&attributes=id%2CdialledNumber%2CentryPointId%2CentryPointName&sort=entryPointName%2CASC&desktopProfileFilter=true&includeEntryPointName=true',
251
296
  method: HTTP_METHODS.GET,
297
+ body: undefined,
298
+ headers: requestHeaders,
252
299
  });
253
300
  expect(LoggerProxy.log).toHaveBeenCalledWith(
254
- `Making API request to fetch entry points - resource: /organization/test-org-id/v2/entry-point?page=1&pageSize=100&sortOrder=asc, service: wcc-api-gateway`,
301
+ `Making API request to fetch entry points - resource: /organization/test-org-id/v3/dial-number?page=1&pageSize=100&attributes=id%2CdialledNumber%2CentryPointId%2CentryPointName&sort=entryPointName%2CASC&desktopProfileFilter=true&includeEntryPointName=true, service: wcc-api-gateway`,
255
302
  {module: 'EntryPoint', method: 'getEntryPoints'}
256
303
  );
257
304
  });