@webex/contact-center 3.12.0 → 3.13.0

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 (337) hide show
  1. package/.sdd/manifest.json +887 -0
  2. package/AGENTS.md +94 -0
  3. package/ai-docs/ARCHITECTURE.md +168 -0
  4. package/ai-docs/CONTRACTS.md +62 -0
  5. package/ai-docs/GETTING_STARTED.md +168 -0
  6. package/ai-docs/GLOSSARY.md +43 -0
  7. package/ai-docs/README.md +138 -0
  8. package/ai-docs/REVIEW_CHECKLIST.md +41 -0
  9. package/ai-docs/RULES.md +444 -0
  10. package/ai-docs/SECURITY.md +52 -0
  11. package/ai-docs/SERVICE_STATE.md +52 -0
  12. package/ai-docs/SPEC_INDEX.md +65 -0
  13. package/ai-docs/adr/0001-spec-source-policy.md +55 -0
  14. package/ai-docs/adr/README.md +8 -0
  15. package/ai-docs/adr/_adr-template.md +31 -0
  16. package/ai-docs/contact-center-spec.md +385 -0
  17. package/ai-docs/features/consult-transfer-list-policy/spec/feature-spec.md +362 -0
  18. package/ai-docs/features/contact-owner-change-refactor.md +78 -0
  19. package/ai-docs/features/generated-spec-conformance-fidelity-remediation/spec/feature-spec.md +117 -0
  20. package/ai-docs/features/residual-warning-coverage-completion/spec/feature-spec.md +203 -0
  21. package/ai-docs/features/validator-code-fidelity-drift-fix/spec/feature-spec.md +315 -0
  22. package/ai-docs/patterns/event-driven-patterns.md +485 -0
  23. package/ai-docs/patterns/testing-patterns.md +480 -0
  24. package/ai-docs/patterns/typescript-patterns.md +365 -0
  25. package/ai-docs/templates/README.md +102 -0
  26. package/ai-docs/templates/documentation/create-agents-md.md +240 -0
  27. package/ai-docs/templates/documentation/create-architecture-md.md +295 -0
  28. package/ai-docs/templates/existing-service/bug-fix.md +254 -0
  29. package/ai-docs/templates/existing-service/feature-enhancement.md +450 -0
  30. package/ai-docs/templates/new-method/00-master.md +80 -0
  31. package/ai-docs/templates/new-method/01-requirements.md +232 -0
  32. package/ai-docs/templates/new-method/02-implementation.md +295 -0
  33. package/ai-docs/templates/new-method/03-tests.md +201 -0
  34. package/ai-docs/templates/new-method/04-validation.md +141 -0
  35. package/ai-docs/templates/new-service/00-master.md +109 -0
  36. package/ai-docs/templates/new-service/01-pre-questions.md +159 -0
  37. package/ai-docs/templates/new-service/02-code-generation.md +346 -0
  38. package/ai-docs/templates/new-service/03-integration.md +178 -0
  39. package/ai-docs/templates/new-service/04-test-generation.md +205 -0
  40. package/ai-docs/templates/new-service/05-validation.md +145 -0
  41. package/dist/cc.js +1045 -45
  42. package/dist/cc.js.map +1 -1
  43. package/dist/config.js +13 -0
  44. package/dist/config.js.map +1 -1
  45. package/dist/constants.js +40 -3
  46. package/dist/constants.js.map +1 -1
  47. package/dist/index.js +54 -17
  48. package/dist/index.js.map +1 -1
  49. package/dist/metrics/MetricsManager.js +16 -0
  50. package/dist/metrics/MetricsManager.js.map +1 -1
  51. package/dist/metrics/behavioral-events.js +211 -0
  52. package/dist/metrics/behavioral-events.js.map +1 -1
  53. package/dist/metrics/constants.js +58 -4
  54. package/dist/metrics/constants.js.map +1 -1
  55. package/dist/services/AddressBook.js +18 -15
  56. package/dist/services/AddressBook.js.map +1 -1
  57. package/dist/services/AnswerCallOnWebexService.js +202 -0
  58. package/dist/services/AnswerCallOnWebexService.js.map +1 -0
  59. package/dist/services/ApiAiAssistant.js +369 -14
  60. package/dist/services/ApiAiAssistant.js.map +1 -1
  61. package/dist/services/EntryPoint.js +46 -68
  62. package/dist/services/EntryPoint.js.map +1 -1
  63. package/dist/services/Queue.js +27 -22
  64. package/dist/services/Queue.js.map +1 -1
  65. package/dist/services/UserPreference.js +427 -0
  66. package/dist/services/UserPreference.js.map +1 -0
  67. package/dist/services/WebCallingService.js +10 -2
  68. package/dist/services/WebCallingService.js.map +1 -1
  69. package/dist/services/WebexCrossClientService.js +225 -0
  70. package/dist/services/WebexCrossClientService.js.map +1 -0
  71. package/dist/services/WxAppTelephonyMercurySync.js +111 -0
  72. package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
  73. package/dist/services/config/Util.js +48 -48
  74. package/dist/services/config/Util.js.map +1 -1
  75. package/dist/services/config/constants.js +57 -79
  76. package/dist/services/config/constants.js.map +1 -1
  77. package/dist/services/config/index.js +100 -226
  78. package/dist/services/config/index.js.map +1 -1
  79. package/dist/services/config/types.js +97 -24
  80. package/dist/services/config/types.js.map +1 -1
  81. package/dist/services/constants.js +19 -1
  82. package/dist/services/constants.js.map +1 -1
  83. package/dist/services/core/Err.js.map +1 -1
  84. package/dist/services/core/Utils.js +131 -32
  85. package/dist/services/core/Utils.js.map +1 -1
  86. package/dist/services/core/WebexRequest.js +6 -2
  87. package/dist/services/core/WebexRequest.js.map +1 -1
  88. package/dist/services/core/aqm-reqs.js +17 -11
  89. package/dist/services/core/aqm-reqs.js.map +1 -1
  90. package/dist/services/core/constants.js +9 -1
  91. package/dist/services/core/constants.js.map +1 -1
  92. package/dist/services/core/types.js.map +1 -1
  93. package/dist/services/core/websocket/WebSocketManager.js +26 -6
  94. package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
  95. package/dist/services/core/websocket/connection-service.js +3 -1
  96. package/dist/services/core/websocket/connection-service.js.map +1 -1
  97. package/dist/services/core/websocket/types.js.map +1 -1
  98. package/dist/services/index.js +6 -0
  99. package/dist/services/index.js.map +1 -1
  100. package/dist/services/task/Task.js +955 -0
  101. package/dist/services/task/Task.js.map +1 -0
  102. package/dist/services/task/TaskFactory.js +50 -0
  103. package/dist/services/task/TaskFactory.js.map +1 -0
  104. package/dist/services/task/TaskManager.js +1275 -504
  105. package/dist/services/task/TaskManager.js.map +1 -1
  106. package/dist/services/task/TaskUtils.js +221 -27
  107. package/dist/services/task/TaskUtils.js.map +1 -1
  108. package/dist/services/task/WebexCallingUtils.js +70 -0
  109. package/dist/services/task/WebexCallingUtils.js.map +1 -0
  110. package/dist/services/task/constants.js +22 -2
  111. package/dist/services/task/constants.js.map +1 -1
  112. package/dist/services/task/contact.js +29 -0
  113. package/dist/services/task/contact.js.map +1 -1
  114. package/dist/services/task/dialer.js +78 -0
  115. package/dist/services/task/dialer.js.map +1 -1
  116. package/dist/services/task/digital/Digital.js +78 -0
  117. package/dist/services/task/digital/Digital.js.map +1 -0
  118. package/dist/services/task/state-machine/TaskStateMachine.js +982 -0
  119. package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -0
  120. package/dist/services/task/state-machine/actions.js +572 -0
  121. package/dist/services/task/state-machine/actions.js.map +1 -0
  122. package/dist/services/task/state-machine/constants.js +161 -0
  123. package/dist/services/task/state-machine/constants.js.map +1 -0
  124. package/dist/services/task/state-machine/guards.js +379 -0
  125. package/dist/services/task/state-machine/guards.js.map +1 -0
  126. package/dist/services/task/state-machine/index.js +53 -0
  127. package/dist/services/task/state-machine/index.js.map +1 -0
  128. package/dist/services/task/state-machine/types.js +54 -0
  129. package/dist/services/task/state-machine/types.js.map +1 -0
  130. package/dist/services/task/state-machine/uiControlsComputer.js +703 -0
  131. package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -0
  132. package/dist/services/task/taskDataNormalizer.js +99 -0
  133. package/dist/services/task/taskDataNormalizer.js.map +1 -0
  134. package/dist/services/task/types.js +259 -5
  135. package/dist/services/task/types.js.map +1 -1
  136. package/dist/services/task/voice/Voice.js +1504 -0
  137. package/dist/services/task/voice/Voice.js.map +1 -0
  138. package/dist/services/task/voice/WebRTC.js +152 -0
  139. package/dist/services/task/voice/WebRTC.js.map +1 -0
  140. package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
  141. package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
  142. package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
  143. package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
  144. package/dist/services/wxAppDiagnosticLogging.js +159 -0
  145. package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
  146. package/dist/services/wxAppTelephonyUtils.js +19 -0
  147. package/dist/services/wxAppTelephonyUtils.js.map +1 -0
  148. package/dist/types/cc.d.ts +197 -9
  149. package/dist/types/config.d.ts +13 -0
  150. package/dist/types/constants.d.ts +38 -1
  151. package/dist/types/index.d.ts +54 -20
  152. package/dist/types/metrics/MetricsManager.d.ts +6 -0
  153. package/dist/types/metrics/constants.d.ts +52 -1
  154. package/dist/types/services/AddressBook.d.ts +2 -1
  155. package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
  156. package/dist/types/services/ApiAiAssistant.d.ts +67 -5
  157. package/dist/types/services/EntryPoint.d.ts +7 -5
  158. package/dist/types/services/Queue.d.ts +5 -3
  159. package/dist/types/services/UserPreference.d.ts +118 -0
  160. package/dist/types/services/WebexCrossClientService.d.ts +32 -0
  161. package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
  162. package/dist/types/services/config/Util.d.ts +4 -8
  163. package/dist/types/services/config/constants.d.ts +49 -76
  164. package/dist/types/services/config/index.d.ts +16 -64
  165. package/dist/types/services/config/types.d.ts +248 -114
  166. package/dist/types/services/constants.d.ts +16 -0
  167. package/dist/types/services/core/Err.d.ts +6 -0
  168. package/dist/types/services/core/Utils.d.ts +43 -13
  169. package/dist/types/services/core/WebexRequest.d.ts +1 -0
  170. package/dist/types/services/core/constants.d.ts +7 -0
  171. package/dist/types/services/core/types.d.ts +2 -0
  172. package/dist/types/services/core/websocket/WebSocketManager.d.ts +2 -0
  173. package/dist/types/services/core/websocket/types.d.ts +1 -1
  174. package/dist/types/services/index.d.ts +2 -0
  175. package/dist/types/services/task/Task.d.ts +186 -0
  176. package/dist/types/services/task/TaskFactory.d.ts +14 -0
  177. package/dist/types/services/task/TaskUtils.d.ts +54 -2
  178. package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
  179. package/dist/types/services/task/constants.d.ts +20 -0
  180. package/dist/types/services/task/contact.d.ts +4 -0
  181. package/dist/types/services/task/dialer.d.ts +30 -0
  182. package/dist/types/services/task/digital/Digital.d.ts +23 -0
  183. package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +1442 -0
  184. package/dist/types/services/task/state-machine/actions.d.ts +10 -0
  185. package/dist/types/services/task/state-machine/constants.d.ts +107 -0
  186. package/dist/types/services/task/state-machine/guards.d.ts +103 -0
  187. package/dist/types/services/task/state-machine/index.d.ts +13 -0
  188. package/dist/types/services/task/state-machine/types.d.ts +277 -0
  189. package/dist/types/services/task/state-machine/uiControlsComputer.d.ts +9 -0
  190. package/dist/types/services/task/taskDataNormalizer.d.ts +10 -0
  191. package/dist/types/services/task/types.d.ts +790 -66
  192. package/dist/types/services/task/voice/Voice.d.ts +241 -0
  193. package/dist/types/services/task/voice/WebRTC.d.ts +54 -0
  194. package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
  195. package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
  196. package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
  197. package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
  198. package/dist/types/types.d.ts +213 -11
  199. package/dist/types/utils/PageCache.d.ts +20 -3
  200. package/dist/types/webex.d.ts +1 -0
  201. package/dist/types.js +168 -6
  202. package/dist/types.js.map +1 -1
  203. package/dist/utils/PageCache.js +19 -5
  204. package/dist/utils/PageCache.js.map +1 -1
  205. package/dist/webex.js +22 -2
  206. package/dist/webex.js.map +1 -1
  207. package/package.json +16 -12
  208. package/src/cc.ts +1367 -101
  209. package/src/config.ts +13 -0
  210. package/src/constants.ts +41 -1
  211. package/src/index.ts +62 -15
  212. package/src/metrics/MetricsManager.ts +16 -0
  213. package/src/metrics/ai-docs/AGENTS.md +350 -0
  214. package/src/metrics/ai-docs/ARCHITECTURE.md +338 -0
  215. package/src/metrics/ai-docs/metrics-spec.md +971 -0
  216. package/src/metrics/behavioral-events.ts +218 -0
  217. package/src/metrics/constants.ts +63 -4
  218. package/src/services/AddressBook.ts +17 -6
  219. package/src/services/AnswerCallOnWebexService.ts +239 -0
  220. package/src/services/ApiAiAssistant.ts +494 -15
  221. package/src/services/EntryPoint.ts +59 -60
  222. package/src/services/Queue.ts +29 -12
  223. package/src/services/UserPreference.ts +509 -0
  224. package/src/services/WebCallingService.ts +16 -2
  225. package/src/services/WebexCrossClientService.ts +298 -0
  226. package/src/services/WxAppTelephonyMercurySync.ts +142 -0
  227. package/src/services/agent/ai-docs/AGENTS.md +240 -0
  228. package/src/services/agent/ai-docs/ARCHITECTURE.md +304 -0
  229. package/src/services/agent/ai-docs/agent-spec.md +505 -0
  230. package/src/services/ai-docs/AGENTS.md +386 -0
  231. package/src/services/ai-docs/services-spec.md +512 -0
  232. package/src/services/config/Util.ts +54 -84
  233. package/src/services/config/ai-docs/AGENTS.md +250 -0
  234. package/src/services/config/ai-docs/ARCHITECTURE.md +413 -0
  235. package/src/services/config/ai-docs/config-spec.md +669 -0
  236. package/src/services/config/constants.ts +64 -86
  237. package/src/services/config/index.ts +116 -277
  238. package/src/services/config/types.ts +233 -125
  239. package/src/services/constants.ts +18 -0
  240. package/src/services/core/Err.ts +3 -0
  241. package/src/services/core/Utils.ts +151 -37
  242. package/src/services/core/WebexRequest.ts +3 -1
  243. package/src/services/core/ai-docs/AGENTS.md +381 -0
  244. package/src/services/core/ai-docs/ARCHITECTURE.md +698 -0
  245. package/src/services/core/ai-docs/core-spec.md +797 -0
  246. package/src/services/core/aqm-reqs.ts +18 -12
  247. package/src/services/core/constants.ts +8 -0
  248. package/src/services/core/types.ts +33 -1
  249. package/src/services/core/websocket/WebSocketManager.ts +37 -8
  250. package/src/services/core/websocket/connection-service.ts +5 -1
  251. package/src/services/core/websocket/types.ts +1 -1
  252. package/src/services/index.ts +4 -0
  253. package/src/services/task/Task.ts +1211 -0
  254. package/src/services/task/TaskFactory.ts +82 -0
  255. package/src/services/task/TaskManager.ts +1551 -584
  256. package/src/services/task/TaskUtils.ts +316 -25
  257. package/src/services/task/WebexCallingUtils.ts +136 -0
  258. package/src/services/task/ai-docs/AGENTS.md +457 -0
  259. package/src/services/task/ai-docs/ARCHITECTURE.md +595 -0
  260. package/src/services/task/ai-docs/task-spec.md +1501 -0
  261. package/src/services/task/constants.ts +21 -0
  262. package/src/services/task/contact.ts +30 -0
  263. package/src/services/task/dialer.ts +80 -0
  264. package/src/services/task/digital/Digital.ts +102 -0
  265. package/src/services/task/state-machine/TaskStateMachine.ts +1320 -0
  266. package/src/services/task/state-machine/actions.ts +741 -0
  267. package/src/services/task/state-machine/ai-docs/AGENTS.md +460 -0
  268. package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +1156 -0
  269. package/src/services/task/state-machine/ai-docs/task-state-machine-spec.md +2247 -0
  270. package/src/services/task/state-machine/constants.ts +172 -0
  271. package/src/services/task/state-machine/guards.ts +442 -0
  272. package/src/services/task/state-machine/index.ts +28 -0
  273. package/src/services/task/state-machine/types.ts +258 -0
  274. package/src/services/task/state-machine/uiControlsComputer.ts +1135 -0
  275. package/src/services/task/taskDataNormalizer.ts +137 -0
  276. package/src/services/task/types.ts +974 -70
  277. package/src/services/task/voice/Voice.ts +1878 -0
  278. package/src/services/task/voice/WebRTC.ts +194 -0
  279. package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
  280. package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
  281. package/src/services/wxAppDiagnosticLogging.ts +286 -0
  282. package/src/services/wxAppTelephonyUtils.ts +14 -0
  283. package/src/types.ts +272 -13
  284. package/src/utils/AGENTS.md +289 -0
  285. package/src/utils/PageCache.ts +38 -5
  286. package/src/utils/ai-docs/utils-spec.md +391 -0
  287. package/src/webex.js +10 -0
  288. package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
  289. package/test/unit/spec/cc.ts +3764 -118
  290. package/test/unit/spec/index.ts +885 -0
  291. package/test/unit/spec/logger-proxy.ts +70 -0
  292. package/test/unit/spec/metrics/MetricsManager.ts +25 -0
  293. package/test/unit/spec/metrics/behavioral-events.ts +60 -0
  294. package/test/unit/spec/services/AddressBook.ts +37 -6
  295. package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
  296. package/test/unit/spec/services/ApiAiAssistant.ts +442 -23
  297. package/test/unit/spec/services/EntryPoint.ts +87 -40
  298. package/test/unit/spec/services/Queue.ts +123 -12
  299. package/test/unit/spec/services/UserPreference.ts +401 -0
  300. package/test/unit/spec/services/WebCallingService.ts +45 -1
  301. package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
  302. package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
  303. package/test/unit/spec/services/config/Util.ts +501 -0
  304. package/test/unit/spec/services/config/index.ts +318 -548
  305. package/test/unit/spec/services/core/Utils.ts +447 -8
  306. package/test/unit/spec/services/core/WebexRequest.ts +8 -7
  307. package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
  308. package/test/unit/spec/services/core/websocket/WebSocketManager.ts +132 -56
  309. package/test/unit/spec/services/core/websocket/connection-service.ts +3 -1
  310. package/test/unit/spec/services/task/AutoWrapup.ts +63 -0
  311. package/test/unit/spec/services/task/Task.ts +2723 -0
  312. package/test/unit/spec/services/task/TaskFactory.ts +116 -0
  313. package/test/unit/spec/services/task/TaskManager.ts +4800 -1586
  314. package/test/unit/spec/services/task/TaskUtils.ts +307 -0
  315. package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
  316. package/test/unit/spec/services/task/contact.ts +33 -0
  317. package/test/unit/spec/services/task/dialer.ts +190 -0
  318. package/test/unit/spec/services/task/digital/Digital.ts +105 -0
  319. package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +4060 -0
  320. package/test/unit/spec/services/task/state-machine/guards.ts +839 -0
  321. package/test/unit/spec/services/task/state-machine/types.ts +18 -0
  322. package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +3101 -0
  323. package/test/unit/spec/services/task/taskTestUtils.ts +87 -0
  324. package/test/unit/spec/services/task/voice/Voice.ts +2355 -0
  325. package/test/unit/spec/services/task/voice/WebRTC.ts +235 -0
  326. package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
  327. package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
  328. package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
  329. package/test/unit/spec/wellnessSampleUtils.ts +288 -0
  330. package/typedoc.md +1 -1
  331. package/umd/contact-center.min.js +2 -2
  332. package/umd/contact-center.min.js.map +1 -1
  333. package/dist/services/task/index.js +0 -1525
  334. package/dist/services/task/index.js.map +0 -1
  335. package/dist/types/services/task/index.d.ts +0 -650
  336. package/src/services/task/index.ts +0 -1801
  337. package/test/unit/spec/services/task/index.ts +0 -2184
@@ -117,16 +117,15 @@ export default class AqmReqs {
117
117
  clear();
118
118
  const notifFail = c.notifFail!;
119
119
  if ('errId' in notifFail) {
120
- LoggerProxy.log(`Routing request failed: ${JSON.stringify(msg)}`, {
121
- module: AQM_REQS_FILE,
122
- method: METHODS.CREATE_PROMISE,
123
- });
124
- const eerr = new Err.Details(notifFail.errId, msg as any);
125
- LoggerProxy.log(`Routing request failed: ${eerr}`, {
120
+ const error = new Err.Details(notifFail.errId, msg as any);
121
+
122
+ // The raw routing-failure payload/error is never logged verbatim; only a
123
+ // redacted, non-sensitive diagnostic is emitted regardless of redactSensitiveLogs.
124
+ LoggerProxy.log('Routing request failed (sensitive details redacted)', {
126
125
  module: AQM_REQS_FILE,
127
126
  method: METHODS.CREATE_PROMISE,
128
127
  });
129
- reject(eerr);
128
+ reject(error);
130
129
  } else {
131
130
  reject(notifFail.err(msg as any));
132
131
  }
@@ -176,13 +175,20 @@ export default class AqmReqs {
176
175
  if (response?.headers) {
177
176
  response.headers.Authorization = '*';
178
177
  }
179
- LoggerProxy.error(
180
- `Routing request timeout${keySuccess}${JSON.stringify(response)}${c.url}`,
181
- {
178
+ if (c.redactSensitiveLogs) {
179
+ LoggerProxy.error('Routing request timeout (sensitive details redacted)', {
182
180
  module: AQM_REQS_FILE,
183
181
  method: METHODS.CREATE_PROMISE,
184
- }
185
- );
182
+ });
183
+ } else {
184
+ LoggerProxy.error(
185
+ `Routing request timeout${keySuccess}${JSON.stringify(response)}${c.url}`,
186
+ {
187
+ module: AQM_REQS_FILE,
188
+ method: METHODS.CREATE_PROMISE,
189
+ }
190
+ );
191
+ }
186
192
  reject(
187
193
  new Err.Details('Service.aqm.reqs.Timeout', {
188
194
  key: keySuccess,
@@ -80,6 +80,14 @@ export const PARTICIPANT_TYPES = {
80
80
  /** Interaction state for consultation */
81
81
  export const STATE_CONSULT = 'consult';
82
82
 
83
+ /**
84
+ * Trusted domains for the RoutingNotifs WebSocket connection. A `webSocketUrl` returned by the
85
+ * subscribe/register API is only opened when its hostname matches one of these domains exactly
86
+ * or is a subdomain of one of them.
87
+ * @ignore
88
+ */
89
+ export const ALLOWED_ROUTING_NOTIFS_DOMAINS = ['cisco.com', 'ciscoccservice.com'];
90
+
83
91
  // Method names for core services
84
92
  export const METHODS = {
85
93
  // WebexRequest methods
@@ -1,4 +1,10 @@
1
- import {HTTP_METHODS, RequestBody, WebexRequestPayload} from '../../types';
1
+ import {
2
+ AIAssistantEventName,
3
+ AIAssistantEventType,
4
+ HTTP_METHODS,
5
+ RequestBody,
6
+ WebexRequestPayload,
7
+ } from '../../types';
2
8
  import * as Err from './Err';
3
9
  import {Msg} from './GlobalTypes';
4
10
 
@@ -20,6 +26,8 @@ export type Req<TRes, TErr> = {
20
26
  url: string;
21
27
  host?: string;
22
28
  method?: HTTP_METHODS;
29
+ /** Suppress request URLs and routing payloads from AQM logs for sensitive operations. */
30
+ redactSensitiveLogs?: boolean;
23
31
  err?:
24
32
  | ((errObj: WebexRequestPayload) => Err.Details<'Service.reqs.generic.failure'>)
25
33
  | Err.IdsMessage
@@ -46,3 +54,27 @@ export type ConfEmpty<TRes, TErr> = () => Req<TRes, TErr>;
46
54
  export type Res<TRes, TReq> = (p: TReq, cbRes?: CbRes<TRes>) => Promise<TRes>;
47
55
  export type ResEmpty<TRes> = (cbRes?: CbRes<TRes>) => Promise<TRes>;
48
56
  export type CbRes<TRes> = (res: any) => void | TRes;
57
+
58
+ /** @internal Pending request completed by a correlated RTD response. */
59
+ export type PendingRtdRequest<T> = {
60
+ correlationId: string;
61
+ rtdEventType: string;
62
+ timeoutId?: ReturnType<typeof setTimeout>;
63
+ resolve: (payload: T) => void;
64
+ reject: (error: Error) => void;
65
+ };
66
+
67
+ /** @internal Request configuration for an event completed by an RTD response. */
68
+ export type RtdRequestOptions = Readonly<{
69
+ correlationId: string;
70
+ rtdEventType: string;
71
+ timeoutMs: number;
72
+ createTimeoutError: () => Error;
73
+ agentId: string;
74
+ interactionId: string;
75
+ eventType: AIAssistantEventType;
76
+ eventName: AIAssistantEventName;
77
+ eventMetaData?: Record<string, unknown>;
78
+ publishTimestamp?: number;
79
+ timeout?: number;
80
+ }>;
@@ -1,12 +1,18 @@
1
1
  import EventEmitter from 'events';
2
2
  import {WebexSDK, SubscribeRequest, HTTP_METHODS} from '../../../types';
3
- import {SUBSCRIBE_API, WCC_API_GATEWAY} from '../../constants';
3
+ import {WCC_API_GATEWAY} from '../../constants';
4
4
  import {ConnectionLostDetails} from './types';
5
5
  import {CC_EVENTS, SubscribeResponse, WelcomeResponse} from '../../config/types';
6
6
  import LoggerProxy from '../../../logger-proxy';
7
7
  import workerScript from './keepalive.worker';
8
- import {KEEPALIVE_WORKER_INTERVAL, CLOSE_SOCKET_TIMEOUT, METHODS} from '../constants';
8
+ import {
9
+ KEEPALIVE_WORKER_INTERVAL,
10
+ CLOSE_SOCKET_TIMEOUT,
11
+ METHODS,
12
+ ALLOWED_ROUTING_NOTIFS_DOMAINS,
13
+ } from '../constants';
9
14
  import {WEB_SOCKET_MANAGER_FILE} from '../../../constants';
15
+ import {isAllowedUrlHost} from '../Utils';
10
16
 
11
17
  /**
12
18
  * WebSocketManager handles the WebSocket connection for Contact Center operations.
@@ -44,10 +50,13 @@ export class WebSocketManager extends EventEmitter {
44
50
  this.keepaliveWorker = new Worker(URL.createObjectURL(workerScriptBlob));
45
51
  }
46
52
 
47
- async initWebSocket(options: {body: SubscribeRequest}): Promise<WelcomeResponse> {
48
- const connectionConfig = options.body;
53
+ async initWebSocket(options: {
54
+ body: SubscribeRequest;
55
+ resource: string;
56
+ }): Promise<WelcomeResponse> {
57
+ const {body: connectionConfig, resource} = options;
49
58
  try {
50
- await this.register(connectionConfig);
59
+ await this.register(connectionConfig, resource);
51
60
  } catch (error) {
52
61
  LoggerProxy.error(`[WebSocketStatus] | Error in registering Websocket ${error}`, {
53
62
  module: WEB_SOCKET_MANAGER_FILE,
@@ -84,7 +93,7 @@ export class WebSocketManager extends EventEmitter {
84
93
  this.isConnectionLost = event.isConnectionLost;
85
94
  }
86
95
 
87
- private async register(connectionConfig: SubscribeRequest) {
96
+ private async register(connectionConfig: SubscribeRequest, resource: string) {
88
97
  try {
89
98
  // X-ORGANIZATION-ID header is only required for INT environments
90
99
  const isIntEnv = this.webex.internal?.services?.isIntegrationEnvironment() || false;
@@ -99,12 +108,30 @@ export class WebSocketManager extends EventEmitter {
99
108
 
100
109
  const subscribeResponse: SubscribeResponse = await this.webex.request({
101
110
  service: WCC_API_GATEWAY,
102
- resource: SUBSCRIBE_API,
111
+ resource,
103
112
  method: HTTP_METHODS.POST,
104
113
  body: connectionConfig,
105
114
  headers: isIntEnv && orgId ? {'X-ORGANIZATION-ID': orgId} : undefined,
106
115
  });
107
- this.url = subscribeResponse.body.webSocketUrl;
116
+ const {webSocketUrl} = subscribeResponse.body;
117
+
118
+ // Only a `wss` URL whose hostname is, or is a subdomain of, one of the allow-listed
119
+ // RoutingNotifs domains is considered trusted.
120
+ let isWssUrl = false;
121
+
122
+ try {
123
+ isWssUrl = !!webSocketUrl && new URL(webSocketUrl).protocol === 'wss:';
124
+ } catch (error) {
125
+ isWssUrl = false;
126
+ }
127
+
128
+ if (!isWssUrl || !isAllowedUrlHost(webSocketUrl, ALLOWED_ROUTING_NOTIFS_DOMAINS)) {
129
+ throw new Error(
130
+ 'Rejected webSocketUrl from RoutingNotifs registration: scheme or host not allow-listed'
131
+ );
132
+ }
133
+
134
+ this.url = webSocketUrl;
108
135
  } catch (e) {
109
136
  LoggerProxy.error(
110
137
  `Register API Failed, Request to RoutingNotifs websocket registration API failed ${e}`,
@@ -211,3 +238,5 @@ export class WebSocketManager extends EventEmitter {
211
238
  }
212
239
  }
213
240
  }
241
+
242
+ export default WebSocketManager;
@@ -10,6 +10,7 @@ import {
10
10
  } from '../constants';
11
11
  import {CONNECTION_SERVICE_FILE} from '../../../constants';
12
12
  import {SubscribeRequest} from '../../../types';
13
+ import {SUBSCRIBE_API} from '../../constants';
13
14
 
14
15
  export class ConnectionService extends EventEmitter {
15
16
  private connectionProp: ConnectionProp = {
@@ -124,7 +125,10 @@ export class ConnectionService extends EventEmitter {
124
125
  });
125
126
  const onlineStatus = navigator.onLine;
126
127
  if (onlineStatus) {
127
- await this.webSocketManager.initWebSocket({body: this.subscribeRequest});
128
+ await this.webSocketManager.initWebSocket({
129
+ body: this.subscribeRequest,
130
+ resource: SUBSCRIBE_API,
131
+ });
128
132
  await this.clearTimerOnRestoreFailed();
129
133
  this.isSocketReconnected = true;
130
134
  } else {
@@ -1,5 +1,5 @@
1
1
  import {SubscribeRequest} from '../../../types';
2
- import {WebSocketManager} from './WebSocketManager';
2
+ import type WebSocketManager from './WebSocketManager';
3
3
 
4
4
  /**
5
5
  * Options for initializing a connection service.
@@ -25,6 +25,8 @@ export default class Services {
25
25
  public readonly dialer: ReturnType<typeof aqmDialer>;
26
26
  /** WebSocket manager for handling real-time communications */
27
27
  public readonly webSocketManager: WebSocketManager;
28
+ /** RTD WebSocket manager for handling real-time transcription */
29
+ public readonly rtdWebSocketManager: WebSocketManager;
28
30
  /** Connection service for managing websocket connections */
29
31
  public readonly connectionService: ConnectionService;
30
32
  /** Singleton instance of the Services class */
@@ -39,6 +41,8 @@ export default class Services {
39
41
  constructor(options: {webex: WebexSDK; connectionConfig: SubscribeRequest}) {
40
42
  const {webex, connectionConfig} = options;
41
43
  this.webSocketManager = new WebSocketManager({webex});
44
+ // TODO: Implement reconnection logic for this websocket in upcoming PR
45
+ this.rtdWebSocketManager = new WebSocketManager({webex});
42
46
  const aqmReq = new AqmReqs(this.webSocketManager);
43
47
  this.config = new AgentConfigService();
44
48
  this.agent = routingAgent(aqmReq);