@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
@@ -0,0 +1,179 @@
1
+ import LoggerProxy from '../../../../src/logger-proxy';
2
+ import {
3
+ callIdSuffix,
4
+ deriveWxAppAcceptReason,
5
+ logWxAppOfferDecision,
6
+ logWxAppOfferParticipantMismatch,
7
+ logWxAppSessionReadiness,
8
+ logWxAppTelephonyAction,
9
+ WXAPP_LOG_PREFIX,
10
+ } from '../../../../src/services/wxAppDiagnosticLogging';
11
+
12
+ jest.mock('../../../../src/logger-proxy', () => ({
13
+ log: jest.fn(),
14
+ warn: jest.fn(),
15
+ error: jest.fn(),
16
+ }));
17
+
18
+ describe('wxAppDiagnosticLogging', () => {
19
+ beforeEach(() => {
20
+ jest.clearAllMocks();
21
+ });
22
+
23
+ describe('callIdSuffix', () => {
24
+ it('returns last 8 characters for long call ids', () => {
25
+ expect(callIdSuffix('prefix:abcdefghijklmnop')).toBe('ijklmnop');
26
+ });
27
+
28
+ it('returns full id when length is 8 or less', () => {
29
+ expect(callIdSuffix('abc')).toBe('abc');
30
+ });
31
+ });
32
+
33
+ describe('deriveWxAppAcceptReason', () => {
34
+ it('returns wxApp_offer_ready for wxApp inbound offer', () => {
35
+ expect(
36
+ deriveWxAppAcceptReason({
37
+ isWxAppInboundOffer: true,
38
+ isWxAppOutdialOffer: false,
39
+ isWebrtc: false,
40
+ isOutdial: false,
41
+ wxAppAcceptInFlight: false,
42
+ wxAppAnswerPending: false,
43
+ enableWxBetterTogether: true,
44
+ hasDeviceCallId: true,
45
+ })
46
+ ).toBe('wxApp_offer_ready');
47
+ });
48
+
49
+ it('returns extension_non_wxApp_offer when flag on but no device call id', () => {
50
+ expect(
51
+ deriveWxAppAcceptReason({
52
+ isWxAppInboundOffer: false,
53
+ isWxAppOutdialOffer: false,
54
+ isWebrtc: false,
55
+ isOutdial: false,
56
+ wxAppAcceptInFlight: false,
57
+ wxAppAnswerPending: false,
58
+ enableWxBetterTogether: true,
59
+ hasDeviceCallId: false,
60
+ })
61
+ ).toBe('extension_non_wxApp_offer');
62
+ });
63
+
64
+ it('returns wxApp_answer_pending when answer is pending', () => {
65
+ expect(
66
+ deriveWxAppAcceptReason({
67
+ isWxAppInboundOffer: true,
68
+ isWxAppOutdialOffer: false,
69
+ isWebrtc: false,
70
+ isOutdial: false,
71
+ wxAppAcceptInFlight: false,
72
+ wxAppAnswerPending: true,
73
+ enableWxBetterTogether: true,
74
+ hasDeviceCallId: true,
75
+ })
76
+ ).toBe('wxApp_answer_pending');
77
+ });
78
+ });
79
+
80
+ describe('log helpers', () => {
81
+ it('logs session readiness at log level with grep-friendly suffix', () => {
82
+ logWxAppSessionReadiness({
83
+ enableWxBetterTogether: true,
84
+ loginOption: 'EXTENSION',
85
+ wxAppHooksApplied: true,
86
+ usersubPublished: true,
87
+ mercurySubscribed: true,
88
+ telephonyTaskType: 'Voice',
89
+ });
90
+
91
+ expect(LoggerProxy.log).toHaveBeenCalledWith(
92
+ expect.stringContaining(`${WXAPP_LOG_PREFIX} session readiness`),
93
+ expect.objectContaining({
94
+ module: 'wxAppDiagnosticLogging',
95
+ method: 'logWxAppSessionReadiness',
96
+ data: expect.objectContaining({
97
+ feature: 'wxApp',
98
+ event: 'session_readiness',
99
+ loginOption: 'EXTENSION',
100
+ usersubPublished: true,
101
+ mercurySubscribed: true,
102
+ }),
103
+ })
104
+ );
105
+ expect(LoggerProxy.log).toHaveBeenCalledWith(
106
+ expect.stringContaining('usersubPublished=true'),
107
+ expect.anything()
108
+ );
109
+ });
110
+
111
+ it('logs offer decision at log level with acceptReason suffix', () => {
112
+ logWxAppOfferDecision({
113
+ interactionId: 'task-1',
114
+ acceptVisible: true,
115
+ acceptEnabled: false,
116
+ acceptReason: 'extension_non_wxApp_offer',
117
+ hasDeviceCallId: false,
118
+ hasDeviceId: false,
119
+ usersubPublished: true,
120
+ });
121
+
122
+ expect(LoggerProxy.log).toHaveBeenCalledWith(
123
+ expect.stringContaining('acceptReason=extension_non_wxApp_offer'),
124
+ expect.objectContaining({
125
+ data: expect.objectContaining({
126
+ event: 'offer_decision',
127
+ acceptReason: 'extension_non_wxApp_offer',
128
+ interactionId: 'task-1',
129
+ usersubPublished: true,
130
+ }),
131
+ })
132
+ );
133
+ });
134
+
135
+ it('logs participant mismatch at warn level', () => {
136
+ logWxAppOfferParticipantMismatch({
137
+ interactionId: 'task-1',
138
+ usersubPublished: true,
139
+ hasDeviceCallId: false,
140
+ hasDeviceId: false,
141
+ participantDeviceType: 'wxApp',
142
+ acceptVisible: true,
143
+ acceptEnabled: false,
144
+ acceptReason: 'extension_non_wxApp_offer',
145
+ });
146
+
147
+ expect(LoggerProxy.warn).toHaveBeenCalledWith(
148
+ expect.stringContaining('participant fields mismatch'),
149
+ expect.objectContaining({
150
+ method: 'logWxAppOfferParticipantMismatch',
151
+ data: expect.objectContaining({
152
+ event: 'participant_fields_mismatch',
153
+ usersubPublished: true,
154
+ hasDeviceCallId: false,
155
+ }),
156
+ })
157
+ );
158
+ });
159
+
160
+ it('logs telephony failures at error level with trackingId', () => {
161
+ logWxAppTelephonyAction({
162
+ action: 'accept',
163
+ phase: 'failed',
164
+ interactionId: 'task-1',
165
+ trackingId: 'track-abc',
166
+ failureReason: 'REST error',
167
+ });
168
+
169
+ expect(LoggerProxy.error).toHaveBeenCalledWith(
170
+ expect.stringContaining('telephony accept failed'),
171
+ expect.objectContaining({
172
+ data: expect.objectContaining({
173
+ trackingId: 'track-abc',
174
+ }),
175
+ })
176
+ );
177
+ });
178
+ });
179
+ });
@@ -0,0 +1,288 @@
1
+ const {
2
+ areAllTasksSafe,
3
+ createRecoveryMarker,
4
+ getLegacyExternalTransitionDecision,
5
+ getRecoveryDecision,
6
+ getSelectableIdleCodes,
7
+ getWellnessTransition,
8
+ parseRecoveryMarker,
9
+ shouldResetForSessionEvent,
10
+ shouldResetSampleAfterDeregister,
11
+ } = require('../../../../../../docs/samples/contact-center/wellness-utils');
12
+ const {readFileSync} = require('fs');
13
+ const {resolve} = require('path');
14
+
15
+ describe('Contact Center wellness sample utilities', () => {
16
+ describe('safe task detection', () => {
17
+ it.each([
18
+ ['new', false, true],
19
+ ['reserved', false, true],
20
+ ['connected', false, true],
21
+ ['consulting', false, true],
22
+ ['conference', false, true],
23
+ ['wrapup', false, true],
24
+ ['campaignPreview', false, true],
25
+ ['terminated', false, false],
26
+ ['completed', false, false],
27
+ ['completed', true, true],
28
+ ])(
29
+ 'classifies task state %s with wrapUpRequired=%s',
30
+ (state, wrapUpRequired, expectedBlocking) => {
31
+ const taskList = {
32
+ task: {
33
+ data: {
34
+ wrapUpRequired,
35
+ interaction: {state},
36
+ },
37
+ },
38
+ };
39
+
40
+ expect(areAllTasksSafe(taskList)).toBe(!expectedBlocking);
41
+ }
42
+ );
43
+
44
+ it('requires every task to be terminal', () => {
45
+ expect(
46
+ areAllTasksSafe({
47
+ completed: {data: {interaction: {state: 'completed'}}},
48
+ active: {data: {interaction: {state: 'engaged'}}},
49
+ })
50
+ ).toBe(false);
51
+ });
52
+
53
+ it('treats an incomplete task shape as blocking until authoritative state arrives', () => {
54
+ expect(areAllTasksSafe({task: {}})).toBe(false);
55
+ });
56
+ });
57
+
58
+ describe('external state synchronization', () => {
59
+ it.each([
60
+ ['OnBreak', 'user-idle', 'complete'],
61
+ ['OnBreak', 'rona-code', 'ignore'],
62
+ ['WaitingForSafeState', 'rona-code', 'cancel'],
63
+ ['Ready', '0', 'ignore'],
64
+ ])(
65
+ 'returns %s / %s as %s',
66
+ (lifecycle, nextAuxCodeId, expected) => {
67
+ expect(
68
+ getLegacyExternalTransitionDecision({
69
+ lifecycle,
70
+ nextAuxCodeId,
71
+ wellnessAuxCodeId: 'wellness',
72
+ validIdleCodeIds: ['user-idle'],
73
+ })
74
+ ).toBe(expected);
75
+ }
76
+ );
77
+ });
78
+
79
+ describe('ordinary status selector', () => {
80
+ it('excludes WellbeingBreak and every other system code', () => {
81
+ expect(
82
+ getSelectableIdleCodes([
83
+ {id: '0', name: 'Available', isSystem: false},
84
+ {id: 'training', name: 'Training', isSystem: false},
85
+ {id: 'wellness', name: 'WellbeingBreak', isSystem: true},
86
+ {id: 'rona', name: 'RONA', isSystem: true},
87
+ ])
88
+ ).toEqual([
89
+ {id: '0', name: 'Available', isSystem: false},
90
+ {id: 'training', name: 'Training', isSystem: false},
91
+ ]);
92
+ });
93
+ });
94
+
95
+ describe('sample public surface guard', () => {
96
+ it('attaches the wellness constants consumed by the standalone browser sample', () => {
97
+ const webexSource = readFileSync(
98
+ resolve(__dirname, '../../../src/webex.js'),
99
+ 'utf8'
100
+ );
101
+ const appSource = readFileSync(
102
+ resolve(__dirname, '../../../../../../docs/samples/contact-center/app.js'),
103
+ 'utf8'
104
+ );
105
+
106
+ ['WELLNESS_BREAK_NOTIFICATION_ACTIONS', 'WELLNESS_BREAK_USER_ACTIONS'].forEach(
107
+ (surface) => {
108
+ expect(webexSource).toContain(`Webex.${surface} = ${surface};`);
109
+ expect(appSource).toContain(surface);
110
+ }
111
+ );
112
+ });
113
+
114
+ it('keeps the intake v0.4 US English wellness copy in the sample surfaces', () => {
115
+ const appSource = readFileSync(
116
+ resolve(__dirname, '../../../../../../docs/samples/contact-center/app.js'),
117
+ 'utf8'
118
+ );
119
+ const htmlSource = readFileSync(
120
+ resolve(__dirname, '../../../../../../docs/samples/contact-center/index.html'),
121
+ 'utf8'
122
+ );
123
+ const sampleSource = `${appSource}\n${htmlSource}`.replace(/\\'/g, "'");
124
+
125
+ [
126
+ 'Well-being break scheduled',
127
+ 'This break is pre-approved by your organization for your well-being. You deserve it.',
128
+ 'Take wellbeing break',
129
+ 'Take a break',
130
+ 'Later',
131
+ 'Great. Your well-being break will begin shortly.',
132
+ 'Great. Your well-being break starts right after this call.',
133
+ "It's great to see your dedication. But remember, taking breaks can boost your productivity and your health.",
134
+ "I'm sorry, you've reached your well-being break limit today. Continue with your tasks, but remember to take care of yourself.",
135
+ "Looks like you're busy. I didn't get a response, so I'll check back with you shortly.",
136
+ 'Relax',
137
+ 'Your 1 minute well-being break is starting in',
138
+ 'This moment is yours.',
139
+ "In a few moments, you'll return to your day.",
140
+ 'Transitioning back to work mode in',
141
+ 'Well-being break completed',
142
+ "I hope you're feeling recharged after that well-being break. See you in your next break!",
143
+ "We couldn't start your well-being break due to a system issue. Please continue with your tasks and we will see you in your next well-being break.",
144
+ 'We encountered an issue setting your status to Available.',
145
+ "We couldn't start your well-being break due to a system issue.",
146
+ ].forEach((copy) => expect(sampleSource).toContain(copy));
147
+ });
148
+
149
+ });
150
+
151
+ describe('lifecycle transitions', () => {
152
+ it('revokes manual request eligibility after a not-allowed decision', () => {
153
+ expect(
154
+ getWellnessTransition(
155
+ {lifecycle: 'RequestPending', hasOffer: false, isReady: true},
156
+ {type: 'NOT_ALLOWED'}
157
+ )
158
+ ).toEqual({
159
+ lifecycle: 'Ready',
160
+ canRequest: false,
161
+ clearOffer: true,
162
+ clearManualRequest: true,
163
+ });
164
+ });
165
+
166
+ it('keeps an offer retryable when response delivery fails', () => {
167
+ expect(
168
+ getWellnessTransition(
169
+ {lifecycle: 'OfferPending', hasOffer: true, isReady: true},
170
+ {type: 'OFFER_RESPONSE_STARTED'}
171
+ )
172
+ ).toEqual({lifecycle: 'OfferResponding', allowed: true});
173
+ expect(
174
+ getWellnessTransition(
175
+ {lifecycle: 'OfferResponding', hasOffer: true, isReady: true},
176
+ {type: 'OFFER_RESPONSE_FAILED'}
177
+ )
178
+ ).toEqual({lifecycle: 'OfferPending', rearmOffer: true});
179
+ });
180
+
181
+ it('clears an offer only after its response succeeds', () => {
182
+ expect(
183
+ getWellnessTransition(
184
+ {lifecycle: 'OfferResponding', hasOffer: true, isReady: true},
185
+ {type: 'OFFER_RESPONSE_SUCCEEDED'}
186
+ )
187
+ ).toEqual({lifecycle: 'Ready', clearOffer: true});
188
+ });
189
+
190
+ it.each([
191
+ [undefined, 'session-1', true],
192
+ ['session-1', 'session-1', true],
193
+ ['session-2', 'session-1', false],
194
+ ])(
195
+ 'scopes session cleanup for event session %s',
196
+ (eventSessionId, activeSessionId, expected) => {
197
+ expect(shouldResetForSessionEvent(eventSessionId, activeSessionId)).toBe(expected);
198
+ }
199
+ );
200
+
201
+ it.each([
202
+ [true, true, true],
203
+ [false, false, true],
204
+ [false, true, false],
205
+ ])(
206
+ 'decides deregistration cleanup for success=%s config=%s',
207
+ (succeeded, hasAgentConfig, expected) => {
208
+ expect(shouldResetSampleAfterDeregister({succeeded, hasAgentConfig})).toBe(expected);
209
+ }
210
+ );
211
+ });
212
+
213
+ describe('browser recovery marker', () => {
214
+ it('round-trips only legacy session ownership', () => {
215
+ const marker = createRecoveryMarker({
216
+ agentSessionId: 'session-1',
217
+ });
218
+
219
+ expect(parseRecoveryMarker(JSON.stringify(marker))).toEqual({
220
+ version: 1,
221
+ agentSessionId: 'session-1',
222
+ stateModel: 'legacy',
223
+ });
224
+ });
225
+
226
+ it.each([
227
+ {
228
+ name: 'discards another session',
229
+ input: {
230
+ marker: createRecoveryMarker({
231
+ agentSessionId: 'session-1',
232
+ }),
233
+ agentSessionId: 'session-2',
234
+ },
235
+ expected: 'discard',
236
+ },
237
+ {
238
+ name: 'waits for an authoritative legacy snapshot',
239
+ input: {
240
+ marker: createRecoveryMarker({
241
+ agentSessionId: 'session-1',
242
+ }),
243
+ agentSessionId: 'session-1',
244
+ legacyStateKnown: false,
245
+ },
246
+ expected: 'wait',
247
+ },
248
+ {
249
+ name: 'restores an owned legacy wellness state',
250
+ input: {
251
+ marker: createRecoveryMarker({
252
+ agentSessionId: 'session-1',
253
+ }),
254
+ agentSessionId: 'session-1',
255
+ legacyStateKnown: true,
256
+ legacyAuxCodeId: 'wellness',
257
+ wellnessAuxCodeId: 'wellness',
258
+ },
259
+ expected: 'restore',
260
+ },
261
+ {
262
+ name: 'clears a legacy marker when the session already left wellness',
263
+ input: {
264
+ marker: createRecoveryMarker({
265
+ agentSessionId: 'session-1',
266
+ }),
267
+ agentSessionId: 'session-1',
268
+ legacyStateKnown: true,
269
+ legacyAuxCodeId: '0',
270
+ wellnessAuxCodeId: 'wellness',
271
+ },
272
+ expected: 'clear',
273
+ },
274
+ ])('$name', ({input, expected}) => {
275
+ expect(getRecoveryDecision(input)).toBe(expected);
276
+ });
277
+
278
+ it('rejects malformed or unsupported recovery markers', () => {
279
+ expect(parseRecoveryMarker('{')).toBeUndefined();
280
+ expect(parseRecoveryMarker(JSON.stringify({version: 2}))).toBeUndefined();
281
+ expect(
282
+ parseRecoveryMarker(
283
+ JSON.stringify({version: 1, agentSessionId: 'session-1', stateModel: 'agent-state-control'})
284
+ )
285
+ ).toBeUndefined();
286
+ });
287
+ });
288
+ });
package/typedoc.md CHANGED
@@ -91,7 +91,7 @@ async function initializeAgent() {
91
91
 
92
92
  // 2. Login with browser-based calling
93
93
  await cc.stationLogin({
94
- teamId: profile.teams[0].teamId,
94
+ teamId: profile.teams[0].id,
95
95
  loginOption: 'BROWSER',
96
96
  });
97
97