@webex/plugin-meetings 2.59.3-next.1 → 2.59.4

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 (420) hide show
  1. package/.eslintrc.js +6 -6
  2. package/LICENSE +1 -1
  3. package/README.md +1204 -1204
  4. package/UPGRADING.md +287 -287
  5. package/babel.config.js +3 -3
  6. package/browsers.js +108 -108
  7. package/dist/common/browser-detection.d.ts +9 -9
  8. package/dist/common/browser-detection.js.map +1 -1
  9. package/dist/common/collection.d.ts +48 -48
  10. package/dist/common/collection.js +43 -43
  11. package/dist/common/collection.js.map +1 -1
  12. package/dist/common/config.d.ts +2 -2
  13. package/dist/common/config.js.map +1 -1
  14. package/dist/common/errors/captcha-error.d.ts +15 -15
  15. package/dist/common/errors/captcha-error.js +7 -7
  16. package/dist/common/errors/captcha-error.js.map +1 -1
  17. package/dist/common/errors/intent-to-join.d.ts +16 -16
  18. package/dist/common/errors/intent-to-join.js +7 -7
  19. package/dist/common/errors/intent-to-join.js.map +1 -1
  20. package/dist/common/errors/join-meeting.d.ts +17 -17
  21. package/dist/common/errors/join-meeting.js +8 -8
  22. package/dist/common/errors/join-meeting.js.map +1 -1
  23. package/dist/common/errors/media.d.ts +15 -15
  24. package/dist/common/errors/media.js +7 -7
  25. package/dist/common/errors/media.js.map +1 -1
  26. package/dist/common/errors/parameter.d.ts +15 -15
  27. package/dist/common/errors/parameter.js +7 -7
  28. package/dist/common/errors/parameter.js.map +1 -1
  29. package/dist/common/errors/password-error.d.ts +15 -15
  30. package/dist/common/errors/password-error.js +7 -7
  31. package/dist/common/errors/password-error.js.map +1 -1
  32. package/dist/common/errors/permission.d.ts +14 -14
  33. package/dist/common/errors/permission.js +6 -6
  34. package/dist/common/errors/permission.js.map +1 -1
  35. package/dist/common/errors/reconnection-in-progress.d.ts +9 -9
  36. package/dist/common/errors/reconnection-in-progress.js +6 -6
  37. package/dist/common/errors/reconnection-in-progress.js.map +1 -1
  38. package/dist/common/errors/reconnection.d.ts +15 -15
  39. package/dist/common/errors/reconnection.js +7 -7
  40. package/dist/common/errors/reconnection.js.map +1 -1
  41. package/dist/common/errors/stats.d.ts +15 -15
  42. package/dist/common/errors/stats.js +7 -7
  43. package/dist/common/errors/stats.js.map +1 -1
  44. package/dist/common/errors/webex-errors.d.ts +81 -81
  45. package/dist/common/errors/webex-errors.js +42 -42
  46. package/dist/common/errors/webex-errors.js.map +1 -1
  47. package/dist/common/errors/webex-meetings-error.d.ts +20 -20
  48. package/dist/common/errors/webex-meetings-error.js +12 -12
  49. package/dist/common/errors/webex-meetings-error.js.map +1 -1
  50. package/dist/common/events/events-scope.d.ts +17 -17
  51. package/dist/common/events/events-scope.js +10 -10
  52. package/dist/common/events/events-scope.js.map +1 -1
  53. package/dist/common/events/events.d.ts +12 -12
  54. package/dist/common/events/events.js +4 -4
  55. package/dist/common/events/events.js.map +1 -1
  56. package/dist/common/events/trigger-proxy.d.ts +2 -2
  57. package/dist/common/events/trigger-proxy.js.map +1 -1
  58. package/dist/common/events/util.d.ts +2 -2
  59. package/dist/common/events/util.js.map +1 -1
  60. package/dist/common/logs/logger-config.d.ts +2 -2
  61. package/dist/common/logs/logger-config.js.map +1 -1
  62. package/dist/common/logs/logger-proxy.d.ts +2 -2
  63. package/dist/common/logs/logger-proxy.js.map +1 -1
  64. package/dist/common/logs/request.d.ts +34 -34
  65. package/dist/common/logs/request.js +18 -18
  66. package/dist/common/logs/request.js.map +1 -1
  67. package/dist/common/queue.d.ts +32 -32
  68. package/dist/common/queue.js +18 -18
  69. package/dist/common/queue.js.map +1 -1
  70. package/dist/config.d.ts +73 -73
  71. package/dist/config.js +2 -2
  72. package/dist/config.js.map +1 -1
  73. package/dist/constants.d.ts +926 -924
  74. package/dist/constants.js +11 -9
  75. package/dist/constants.js.map +1 -1
  76. package/dist/controls-options-manager/constants.d.ts +4 -4
  77. package/dist/controls-options-manager/constants.js.map +1 -1
  78. package/dist/controls-options-manager/enums.d.ts +5 -5
  79. package/dist/controls-options-manager/enums.js.map +1 -1
  80. package/dist/controls-options-manager/index.d.ts +120 -120
  81. package/dist/controls-options-manager/index.js +81 -81
  82. package/dist/controls-options-manager/index.js.map +1 -1
  83. package/dist/controls-options-manager/util.d.ts +7 -7
  84. package/dist/controls-options-manager/util.js.map +1 -1
  85. package/dist/index.d.ts +4 -4
  86. package/dist/index.js.map +1 -1
  87. package/dist/locus-info/controlsUtils.d.ts +2 -2
  88. package/dist/locus-info/controlsUtils.js +21 -21
  89. package/dist/locus-info/controlsUtils.js.map +1 -1
  90. package/dist/locus-info/embeddedAppsUtils.d.ts +2 -2
  91. package/dist/locus-info/embeddedAppsUtils.js +14 -14
  92. package/dist/locus-info/embeddedAppsUtils.js.map +1 -1
  93. package/dist/locus-info/fullState.d.ts +2 -2
  94. package/dist/locus-info/fullState.js.map +1 -1
  95. package/dist/locus-info/hostUtils.d.ts +2 -2
  96. package/dist/locus-info/hostUtils.js +19 -19
  97. package/dist/locus-info/hostUtils.js.map +1 -1
  98. package/dist/locus-info/index.d.ts +269 -269
  99. package/dist/locus-info/index.js +180 -180
  100. package/dist/locus-info/index.js.map +1 -1
  101. package/dist/locus-info/infoUtils.d.ts +2 -2
  102. package/dist/locus-info/infoUtils.js.map +1 -1
  103. package/dist/locus-info/mediaSharesUtils.d.ts +2 -2
  104. package/dist/locus-info/mediaSharesUtils.js +50 -50
  105. package/dist/locus-info/mediaSharesUtils.js.map +1 -1
  106. package/dist/locus-info/parser.d.ts +212 -212
  107. package/dist/locus-info/parser.js +136 -136
  108. package/dist/locus-info/parser.js.map +1 -1
  109. package/dist/locus-info/selfUtils.d.ts +2 -2
  110. package/dist/locus-info/selfUtils.js +52 -52
  111. package/dist/locus-info/selfUtils.js.map +1 -1
  112. package/dist/media/index.d.ts +32 -32
  113. package/dist/media/index.js +145 -145
  114. package/dist/media/index.js.map +1 -1
  115. package/dist/media/properties.d.ts +108 -108
  116. package/dist/media/properties.js +49 -49
  117. package/dist/media/properties.js.map +1 -1
  118. package/dist/media/util.d.ts +2 -2
  119. package/dist/media/util.js.map +1 -1
  120. package/dist/mediaQualityMetrics/config.d.ts +233 -233
  121. package/dist/mediaQualityMetrics/config.js.map +1 -1
  122. package/dist/meeting/effectsState.d.ts +42 -42
  123. package/dist/meeting/effectsState.js +24 -24
  124. package/dist/meeting/effectsState.js.map +1 -1
  125. package/dist/meeting/in-meeting-actions.d.ts +79 -79
  126. package/dist/meeting/in-meeting-actions.js +11 -11
  127. package/dist/meeting/in-meeting-actions.js.map +1 -1
  128. package/dist/meeting/index.d.ts +1621 -1621
  129. package/dist/meeting/index.js +1538 -1518
  130. package/dist/meeting/index.js.map +1 -1
  131. package/dist/meeting/muteState.d.ts +116 -116
  132. package/dist/meeting/muteState.js +85 -85
  133. package/dist/meeting/muteState.js.map +1 -1
  134. package/dist/meeting/request.d.ts +255 -255
  135. package/dist/meeting/request.js +141 -141
  136. package/dist/meeting/request.js.map +1 -1
  137. package/dist/meeting/state.d.ts +9 -9
  138. package/dist/meeting/state.js +30 -30
  139. package/dist/meeting/state.js.map +1 -1
  140. package/dist/meeting/util.d.ts +2 -2
  141. package/dist/meeting/util.js.map +1 -1
  142. package/dist/meeting-info/collection.d.ts +20 -20
  143. package/dist/meeting-info/collection.js +11 -11
  144. package/dist/meeting-info/collection.js.map +1 -1
  145. package/dist/meeting-info/index.d.ts +57 -57
  146. package/dist/meeting-info/index.js +50 -50
  147. package/dist/meeting-info/index.js.map +1 -1
  148. package/dist/meeting-info/meeting-info-v2.d.ts +93 -93
  149. package/dist/meeting-info/meeting-info-v2.js +52 -52
  150. package/dist/meeting-info/meeting-info-v2.js.map +1 -1
  151. package/dist/meeting-info/request.d.ts +22 -22
  152. package/dist/meeting-info/request.js +14 -14
  153. package/dist/meeting-info/request.js.map +1 -1
  154. package/dist/meeting-info/util.d.ts +2 -2
  155. package/dist/meeting-info/util.js +9 -9
  156. package/dist/meeting-info/util.js.map +1 -1
  157. package/dist/meeting-info/utilv2.d.ts +2 -2
  158. package/dist/meeting-info/utilv2.js +20 -20
  159. package/dist/meeting-info/utilv2.js.map +1 -1
  160. package/dist/meetings/collection.d.ts +23 -23
  161. package/dist/meetings/collection.js +14 -14
  162. package/dist/meetings/collection.js.map +1 -1
  163. package/dist/meetings/index.d.ts +296 -296
  164. package/dist/meetings/index.js +259 -259
  165. package/dist/meetings/index.js.map +1 -1
  166. package/dist/meetings/request.d.ts +27 -27
  167. package/dist/meetings/request.js +15 -15
  168. package/dist/meetings/request.js.map +1 -1
  169. package/dist/meetings/util.d.ts +18 -18
  170. package/dist/meetings/util.js +29 -29
  171. package/dist/meetings/util.js.map +1 -1
  172. package/dist/member/index.d.ts +147 -147
  173. package/dist/member/index.js +214 -214
  174. package/dist/member/index.js.map +1 -1
  175. package/dist/member/member.types.d.ts +11 -11
  176. package/dist/member/member.types.js.map +1 -1
  177. package/dist/member/util.d.ts +2 -2
  178. package/dist/member/util.js +60 -60
  179. package/dist/member/util.js.map +1 -1
  180. package/dist/members/collection.d.ts +24 -24
  181. package/dist/members/collection.js +11 -11
  182. package/dist/members/collection.js.map +1 -1
  183. package/dist/members/index.d.ts +298 -298
  184. package/dist/members/index.js +275 -275
  185. package/dist/members/index.js.map +1 -1
  186. package/dist/members/request.d.ts +50 -50
  187. package/dist/members/request.js +27 -27
  188. package/dist/members/request.js.map +1 -1
  189. package/dist/members/util.d.ts +2 -2
  190. package/dist/members/util.js +21 -21
  191. package/dist/members/util.js.map +1 -1
  192. package/dist/metrics/config.d.ts +169 -169
  193. package/dist/metrics/config.js.map +1 -1
  194. package/dist/metrics/constants.d.ts +59 -57
  195. package/dist/metrics/constants.js +2 -0
  196. package/dist/metrics/constants.js.map +1 -1
  197. package/dist/metrics/index.d.ts +152 -152
  198. package/dist/metrics/index.js +90 -90
  199. package/dist/metrics/index.js.map +1 -1
  200. package/dist/networkQualityMonitor/index.d.ts +70 -70
  201. package/dist/networkQualityMonitor/index.js +65 -65
  202. package/dist/networkQualityMonitor/index.js.map +1 -1
  203. package/dist/peer-connection-manager/index.d.ts +6 -6
  204. package/dist/peer-connection-manager/index.js +87 -87
  205. package/dist/peer-connection-manager/index.js.map +1 -1
  206. package/dist/peer-connection-manager/util.d.ts +6 -6
  207. package/dist/peer-connection-manager/util.js +9 -9
  208. package/dist/peer-connection-manager/util.js.map +1 -1
  209. package/dist/personal-meeting-room/index.d.ts +47 -47
  210. package/dist/personal-meeting-room/index.js +67 -67
  211. package/dist/personal-meeting-room/index.js.map +1 -1
  212. package/dist/personal-meeting-room/request.d.ts +14 -14
  213. package/dist/personal-meeting-room/request.js +7 -7
  214. package/dist/personal-meeting-room/request.js.map +1 -1
  215. package/dist/personal-meeting-room/util.d.ts +2 -2
  216. package/dist/personal-meeting-room/util.js.map +1 -1
  217. package/dist/reachability/index.d.ts +139 -139
  218. package/dist/reachability/index.js +110 -110
  219. package/dist/reachability/index.js.map +1 -1
  220. package/dist/reachability/request.d.ts +35 -35
  221. package/dist/reachability/request.js +15 -15
  222. package/dist/reachability/request.js.map +1 -1
  223. package/dist/reactions/reactions.d.ts +4 -4
  224. package/dist/reactions/reactions.js.map +1 -1
  225. package/dist/reactions/reactions.type.d.ts +32 -32
  226. package/dist/reactions/reactions.type.js.map +1 -1
  227. package/dist/reconnection-manager/index.d.ts +112 -112
  228. package/dist/reconnection-manager/index.js +112 -112
  229. package/dist/reconnection-manager/index.js.map +1 -1
  230. package/dist/recording-controller/enums.d.ts +7 -7
  231. package/dist/recording-controller/enums.js.map +1 -1
  232. package/dist/recording-controller/index.d.ts +193 -193
  233. package/dist/recording-controller/index.js +127 -127
  234. package/dist/recording-controller/index.js.map +1 -1
  235. package/dist/recording-controller/util.d.ts +13 -13
  236. package/dist/recording-controller/util.js.map +1 -1
  237. package/dist/roap/collection.d.ts +10 -10
  238. package/dist/roap/collection.js.map +1 -1
  239. package/dist/roap/handler.d.ts +47 -47
  240. package/dist/roap/handler.js +27 -27
  241. package/dist/roap/handler.js.map +1 -1
  242. package/dist/roap/index.d.ts +116 -116
  243. package/dist/roap/index.js +111 -111
  244. package/dist/roap/index.js.map +1 -1
  245. package/dist/roap/request.d.ts +35 -35
  246. package/dist/roap/request.js +17 -17
  247. package/dist/roap/request.js.map +1 -1
  248. package/dist/roap/state.d.ts +9 -9
  249. package/dist/roap/state.js +14 -14
  250. package/dist/roap/state.js.map +1 -1
  251. package/dist/roap/turnDiscovery.d.ts +67 -67
  252. package/dist/roap/turnDiscovery.js +46 -46
  253. package/dist/roap/turnDiscovery.js.map +1 -1
  254. package/dist/roap/util.d.ts +2 -2
  255. package/dist/roap/util.js.map +1 -1
  256. package/dist/statsAnalyzer/global.d.ts +118 -126
  257. package/dist/statsAnalyzer/global.js +4 -12
  258. package/dist/statsAnalyzer/global.js.map +1 -1
  259. package/dist/statsAnalyzer/index.d.ts +193 -190
  260. package/dist/statsAnalyzer/index.js +182 -140
  261. package/dist/statsAnalyzer/index.js.map +1 -1
  262. package/dist/statsAnalyzer/mqaUtil.d.ts +22 -22
  263. package/dist/statsAnalyzer/mqaUtil.js.map +1 -1
  264. package/dist/transcription/index.d.ts +64 -64
  265. package/dist/transcription/index.js +42 -42
  266. package/dist/transcription/index.js.map +1 -1
  267. package/internal-README.md +172 -172
  268. package/jest.config.js +3 -3
  269. package/package.json +21 -22
  270. package/process +1 -1
  271. package/src/common/browser-detection.ts +39 -39
  272. package/src/common/collection.ts +94 -94
  273. package/src/common/config.ts +9 -9
  274. package/src/common/errors/captcha-error.ts +25 -25
  275. package/src/common/errors/intent-to-join.ts +27 -27
  276. package/src/common/errors/join-meeting.ts +32 -32
  277. package/src/common/errors/media.ts +25 -25
  278. package/src/common/errors/parameter.ts +33 -33
  279. package/src/common/errors/password-error.ts +25 -25
  280. package/src/common/errors/permission.ts +24 -24
  281. package/src/common/errors/reconnection-in-progress.ts +8 -8
  282. package/src/common/errors/reconnection.ts +25 -25
  283. package/src/common/errors/stats.ts +25 -25
  284. package/src/common/errors/webex-errors.ts +140 -140
  285. package/src/common/errors/webex-meetings-error.ts +35 -35
  286. package/src/common/events/events-scope.ts +30 -30
  287. package/src/common/events/events.ts +25 -25
  288. package/src/common/events/trigger-proxy.ts +25 -25
  289. package/src/common/events/util.ts +39 -39
  290. package/src/common/logs/logger-config.ts +8 -8
  291. package/src/common/logs/logger-proxy.ts +44 -44
  292. package/src/common/logs/request.ts +65 -65
  293. package/src/common/queue.ts +50 -50
  294. package/src/config.ts +96 -96
  295. package/src/constants.ts +1123 -1121
  296. package/src/controls-options-manager/constants.ts +5 -5
  297. package/src/controls-options-manager/enums.ts +6 -6
  298. package/src/controls-options-manager/index.ts +183 -183
  299. package/src/controls-options-manager/util.ts +20 -20
  300. package/src/index.js +15 -15
  301. package/src/locus-info/controlsUtils.ts +112 -112
  302. package/src/locus-info/embeddedAppsUtils.ts +57 -57
  303. package/src/locus-info/fullState.ts +69 -69
  304. package/src/locus-info/hostUtils.ts +60 -60
  305. package/src/locus-info/index.ts +1303 -1303
  306. package/src/locus-info/infoUtils.ts +101 -101
  307. package/src/locus-info/mediaSharesUtils.ts +173 -173
  308. package/src/locus-info/parser.ts +680 -680
  309. package/src/locus-info/selfUtils.ts +428 -428
  310. package/src/media/index.ts +675 -675
  311. package/src/media/properties.ts +313 -313
  312. package/src/media/util.ts +37 -37
  313. package/src/mediaQualityMetrics/config.ts +382 -382
  314. package/src/meeting/effectsState.ts +209 -209
  315. package/src/meeting/in-meeting-actions.ts +153 -153
  316. package/src/meeting/index.ts +6572 -6537
  317. package/src/meeting/muteState.ts +365 -365
  318. package/src/meeting/request.ts +810 -810
  319. package/src/meeting/state.ts +194 -194
  320. package/src/meeting/util.ts +530 -530
  321. package/src/meeting-info/collection.ts +41 -41
  322. package/src/meeting-info/index.ts +137 -137
  323. package/src/meeting-info/meeting-info-v2.ts +273 -273
  324. package/src/meeting-info/request.ts +46 -46
  325. package/src/meeting-info/util.ts +314 -314
  326. package/src/meeting-info/utilv2.ts +324 -324
  327. package/src/meetings/collection.ts +43 -43
  328. package/src/meetings/index.ts +1128 -1128
  329. package/src/meetings/request.ts +81 -81
  330. package/src/meetings/util.ts +181 -181
  331. package/src/member/index.ts +446 -446
  332. package/src/member/member.types.ts +13 -13
  333. package/src/member/util.ts +286 -286
  334. package/src/members/collection.ts +40 -40
  335. package/src/members/index.ts +900 -900
  336. package/src/members/request.ts +175 -175
  337. package/src/members/util.ts +260 -260
  338. package/src/metrics/config.ts +485 -485
  339. package/src/metrics/constants.ts +63 -61
  340. package/src/metrics/index.ts +543 -543
  341. package/src/networkQualityMonitor/index.ts +211 -211
  342. package/src/peer-connection-manager/index.ts +847 -847
  343. package/src/peer-connection-manager/util.ts +119 -119
  344. package/src/personal-meeting-room/index.ts +157 -157
  345. package/src/personal-meeting-room/request.ts +48 -48
  346. package/src/personal-meeting-room/util.ts +49 -49
  347. package/src/reachability/index.ts +478 -478
  348. package/src/reachability/request.ts +81 -81
  349. package/src/reactions/reactions.ts +104 -104
  350. package/src/reactions/reactions.type.ts +36 -36
  351. package/src/reconnection-manager/index.ts +622 -622
  352. package/src/recording-controller/enums.ts +8 -8
  353. package/src/recording-controller/index.ts +315 -315
  354. package/src/recording-controller/util.ts +58 -58
  355. package/src/roap/collection.ts +62 -62
  356. package/src/roap/handler.ts +294 -294
  357. package/src/roap/index.ts +413 -413
  358. package/src/roap/request.ts +229 -229
  359. package/src/roap/state.ts +156 -156
  360. package/src/roap/turnDiscovery.ts +283 -283
  361. package/src/roap/util.ts +100 -100
  362. package/src/statsAnalyzer/global.ts +120 -128
  363. package/src/statsAnalyzer/index.ts +1329 -1266
  364. package/src/statsAnalyzer/mqaUtil.ts +290 -290
  365. package/src/transcription/index.ts +154 -154
  366. package/test/integration/spec/journey.js +941 -941
  367. package/test/integration/spec/space-meeting.js +457 -457
  368. package/test/integration/spec/transcription.js +55 -55
  369. package/test/unit/spec/common/browser-detection.js +119 -119
  370. package/test/unit/spec/common/queue.js +69 -69
  371. package/test/unit/spec/controls-options-manager/index.js +123 -123
  372. package/test/unit/spec/controls-options-manager/util.js +65 -65
  373. package/test/unit/spec/fixture/locus.js +406 -406
  374. package/test/unit/spec/locus-info/controlsUtils.js +82 -82
  375. package/test/unit/spec/locus-info/embeddedAppsUtils.js +104 -104
  376. package/test/unit/spec/locus-info/index.js +1272 -1272
  377. package/test/unit/spec/locus-info/infoUtils.js +138 -138
  378. package/test/unit/spec/locus-info/lib/BasicSeqCmp.json +975 -975
  379. package/test/unit/spec/locus-info/lib/SeqCmp.json +522 -522
  380. package/test/unit/spec/locus-info/lib/selfConstant.js +286 -286
  381. package/test/unit/spec/locus-info/parser.js +298 -298
  382. package/test/unit/spec/locus-info/selfUtils.js +185 -185
  383. package/test/unit/spec/media/properties.ts +305 -305
  384. package/test/unit/spec/meeting/effectsState.js +281 -281
  385. package/test/unit/spec/meeting/in-meeting-actions.ts +90 -90
  386. package/test/unit/spec/meeting/index.js +5298 -5227
  387. package/test/unit/spec/meeting/muteState.js +430 -430
  388. package/test/unit/spec/meeting/request.js +317 -317
  389. package/test/unit/spec/meeting/utils.js +319 -319
  390. package/test/unit/spec/meeting-info/meetinginfov2.js +376 -376
  391. package/test/unit/spec/meeting-info/request.js +64 -64
  392. package/test/unit/spec/meeting-info/util.js +37 -37
  393. package/test/unit/spec/meeting-info/utilv2.js +330 -330
  394. package/test/unit/spec/meetings/collection.js +52 -52
  395. package/test/unit/spec/meetings/index.js +1375 -1375
  396. package/test/unit/spec/meetings/utils.js +66 -66
  397. package/test/unit/spec/member/index.js +47 -47
  398. package/test/unit/spec/member/util.js +80 -80
  399. package/test/unit/spec/members/index.js +364 -364
  400. package/test/unit/spec/members/request.js +200 -200
  401. package/test/unit/spec/members/utils.js +42 -42
  402. package/test/unit/spec/metrics/index.js +111 -111
  403. package/test/unit/spec/networkQualityMonitor/index.js +99 -99
  404. package/test/unit/spec/peerconnection-manager/index.js +218 -218
  405. package/test/unit/spec/peerconnection-manager/utils.js +49 -49
  406. package/test/unit/spec/peerconnection-manager/utils.test-fixtures.ts +388 -388
  407. package/test/unit/spec/personal-meeting-room/personal-meeting-room.js +29 -29
  408. package/test/unit/spec/reachability/index.ts +50 -50
  409. package/test/unit/spec/reconnection-manager/index.js +206 -206
  410. package/test/unit/spec/recording-controller/index.js +230 -230
  411. package/test/unit/spec/recording-controller/util.js +101 -101
  412. package/test/unit/spec/roap/index.ts +128 -128
  413. package/test/unit/spec/roap/turnDiscovery.ts +372 -372
  414. package/test/unit/spec/roap/util.js +30 -30
  415. package/test/unit/spec/stats-analyzer/index.js +438 -287
  416. package/test/utils/cmr.js +104 -104
  417. package/test/utils/testUtils.js +287 -287
  418. package/test/utils/webex-config.js +77 -77
  419. package/test/utils/webex-test-users.js +82 -82
  420. package/tsconfig.json +5 -5
@@ -1,1303 +1,1303 @@
1
- import {isEqual} from 'lodash';
2
-
3
- import LoggerProxy from '../common/logs/logger-proxy';
4
- import EventsScope from '../common/events/events-scope';
5
- import {
6
- EVENTS,
7
- LOCUSEVENT,
8
- _USER_,
9
- _CALL_,
10
- _SIP_BRIDGE_,
11
- MEETING_STATE,
12
- _MEETING_,
13
- LOCUSINFO,
14
- LOCUS,
15
- _LEFT_,
16
- MEETING_REMOVED_REASON,
17
- CALL_REMOVED_REASON,
18
- RECORDING_STATE,
19
- } from '../constants';
20
- import Metrics from '../metrics';
21
- import {eventType} from '../metrics/config';
22
- import InfoUtils from './infoUtils';
23
- import FullState from './fullState';
24
- import SelfUtils from './selfUtils';
25
- import HostUtils from './hostUtils';
26
- import ControlsUtils from './controlsUtils';
27
- import EmbeddedAppsUtils from './embeddedAppsUtils';
28
- import MediaSharesUtils from './mediaSharesUtils';
29
- import LocusDeltaParser from './parser';
30
-
31
- /**
32
- * @description LocusInfo extends ChildEmitter to convert locusInfo info a private emitter to parent object
33
- * @export
34
- * @private
35
- * @class LocusInfo
36
- */
37
- export default class LocusInfo extends EventsScope {
38
- compareAndUpdateFlags: any;
39
- emitChange: any;
40
- locusParser: any;
41
- meetingId: any;
42
- parsedLocus: any;
43
- updateMeeting: any;
44
- webex: any;
45
- aclUrl: any;
46
- baseSequence: any;
47
- created: any;
48
- deltaParticipants: any;
49
- identities: any;
50
- membership: any;
51
- participants: any;
52
- participantsUrl: any;
53
- replaces: any;
54
- scheduledMeeting: any;
55
- sequence: any;
56
- controls: any;
57
- conversationUrl: any;
58
- embeddedApps: any;
59
- fullState: any;
60
- host: any;
61
- info: any;
62
- mediaShares: any;
63
- replace: any;
64
- url: any;
65
- services: any;
66
-
67
- constructor(updateMeeting, webex, meetingId) {
68
- super();
69
- this.parsedLocus = {
70
- states: [],
71
- };
72
- this.webex = webex;
73
- this.emitChange = false;
74
- this.compareAndUpdateFlags = {};
75
- this.meetingId = meetingId;
76
- this.updateMeeting = updateMeeting;
77
- this.locusParser = new LocusDeltaParser();
78
- }
79
-
80
- /**
81
- * Apply locus delta data to meeting
82
- * @param {string} action Locus delta action
83
- * @param {Locus} locus
84
- * @param {Meeting} meeting
85
- * @returns {undefined}
86
- */
87
- applyLocusDeltaData(action: string, locus: any, meeting: any) {
88
- const {DESYNC, USE_CURRENT, USE_INCOMING} = LocusDeltaParser.loci;
89
-
90
- switch (action) {
91
- case USE_INCOMING:
92
- meeting.locusInfo.onDeltaLocus(locus);
93
- break;
94
- case USE_CURRENT:
95
- meeting.locusDesync = false;
96
- meeting.needToGetFullLocus = false;
97
- break;
98
- case DESYNC:
99
- meeting.meetingRequest
100
- .getFullLocus({
101
- desync: true,
102
- locusUrl: meeting.locusUrl,
103
- })
104
- .then((res) => {
105
- meeting.locusInfo.onFullLocus(res.body);
106
- // Notify parser to resume processing delta events
107
- // now that we have full locus from DESYNC.
108
- this.locusParser.resume();
109
- });
110
- break;
111
- default:
112
- LoggerProxy.logger.info(
113
- `Locus-info:index#applyLocusDeltaData --> Unknown locus delta action: ${action}`
114
- );
115
- }
116
- }
117
-
118
- /**
119
- * Adds locus delta to parser's queue
120
- * and registers a function handler
121
- * to recieve parsed actions from queue.
122
- * @param {Locus} locus
123
- * @param {Meeting} meeting
124
- * @returns {undefined}
125
- */
126
- handleLocusDelta(locus: any, meeting: any) {
127
- // register a function to process delta actions
128
- if (!this.locusParser.onDeltaAction) {
129
- // delta action, along with associated loci
130
- // is passed into the function.
131
- this.locusParser.onDeltaAction = (action, parsedLoci) => {
132
- this.applyLocusDeltaData(action, parsedLoci, meeting);
133
- };
134
- }
135
- // queue delta event with parser
136
- this.locusParser.onDeltaEvent(locus);
137
- }
138
-
139
- /**
140
- * @param {Locus} locus
141
- * @returns {undefined}
142
- * @memberof LocusInfo
143
- */
144
- init(locus: any = {}) {
145
- this.created = locus.created || null;
146
- this.scheduledMeeting = locus.meeting || null;
147
- this.participantsUrl = locus.participantsUrl || null;
148
- this.replaces = locus.replaces || null;
149
- this.aclUrl = locus.aclUrl || null;
150
- this.baseSequence = locus.baseSequence || null;
151
- this.sequence = locus.sequence || null;
152
- this.membership = locus.membership || null;
153
- this.identities = locus.identities || null;
154
- this.participants = locus.participants || null;
155
-
156
- /**
157
- * Stores the delta values for a changed participant.
158
- *
159
- * @typedef {Object} DeltaParticipant
160
- * @property {Record<string, boolean>} delta - Contains changed streams.
161
- * @property {Object} person - Contains person data.
162
- */
163
-
164
- /**
165
- * Stored participant changes between the last event and the current event.
166
- * All previously stored events are overwritten between events.
167
- *
168
- * @instance
169
- * @type {Array<DeltaParticipant>}
170
- * @private
171
- * @member LocusInfo
172
- */
173
- this.deltaParticipants = [];
174
-
175
- // above section only updates the locusInfo object
176
- // The below section makes sure it updates the locusInfo as well as updates the meeting object
177
- this.updateParticipants(locus.participants);
178
- // For 1:1 space meeting the conversation Url does not exist in locus.conversation
179
- this.updateConversationUrl(locus.conversationUrl, locus.info);
180
- this.updateControls(locus.controls);
181
- this.updateLocusUrl(locus.url);
182
- this.updateFullState(locus.fullState);
183
- this.updateMeetingInfo(locus.info);
184
- this.updateEmbeddedApps(locus.embeddedApps);
185
- // self and participants generate sipUrl for 1:1 meeting
186
- this.updateSelf(locus.self, locus.participants);
187
- this.updateHostInfo(locus.host);
188
- this.updateMediaShares(locus.mediaShares);
189
- this.updateServices(locus.links?.services);
190
- }
191
-
192
- /**
193
- * @param {Object} locus
194
- * @returns {undefined}
195
- * @memberof LocusInfo
196
- */
197
- initialSetup(locus: object) {
198
- this.onFullLocus(locus);
199
-
200
- // Change it to true after it receives it first locus object
201
- this.emitChange = true;
202
- }
203
-
204
- /**
205
- * @param {Meeting} meeting
206
- * @param {Object} data
207
- * @returns {undefined}
208
- * @memberof LocusInfo
209
- */
210
- parse(meeting: any, data: any) {
211
- // eslint-disable-next-line @typescript-eslint/no-shadow
212
- const {eventType} = data;
213
-
214
- LoggerProxy.logger.info(`Locus-info:index#parse --> received locus data: ${eventType}`);
215
-
216
- switch (eventType) {
217
- case LOCUSEVENT.PARTICIPANT_JOIN:
218
- case LOCUSEVENT.PARTICIPANT_LEFT:
219
- case LOCUSEVENT.CONTROLS_UPDATED:
220
- case LOCUSEVENT.PARTICIPANT_AUDIO_MUTED:
221
- case LOCUSEVENT.PARTICIPANT_AUDIO_UNMUTED:
222
- case LOCUSEVENT.PARTICIPANT_VIDEO_MUTED:
223
- case LOCUSEVENT.PARTICIPANT_VIDEO_UNMUTED:
224
- case LOCUSEVENT.SELF_CHANGED:
225
- case LOCUSEVENT.PARTICIPANT_UPDATED:
226
- case LOCUSEVENT.PARTICIPANT_CONTROLS_UPDATED:
227
- case LOCUSEVENT.PARTICIPANT_ROLES_UPDATED:
228
- case LOCUSEVENT.PARTICIPANT_DECLINED:
229
- case LOCUSEVENT.FLOOR_GRANTED:
230
- case LOCUSEVENT.FLOOR_RELEASED:
231
- this.onFullLocus(data.locus, eventType);
232
- break;
233
- case LOCUSEVENT.DIFFERENCE:
234
- this.handleLocusDelta(data.locus, meeting);
235
- break;
236
-
237
- default:
238
- // Why will there be a event with no eventType ????
239
- // we may not need this, we can get full locus
240
- this.handleLocusDelta(data.locus, meeting);
241
- }
242
- }
243
-
244
- /**
245
- * @param {String} scope
246
- * @param {String} eventName
247
- * @param {Array} args
248
- * @returns {undefined}
249
- * @memberof LocusInfo
250
- */
251
- emitScoped(scope?: any, eventName?: string, args?: any) {
252
- return this.emit(scope, eventName, args);
253
- }
254
-
255
- /**
256
- * updates the locus with full locus object
257
- * @param {object} locus locus object
258
- * @param {string} eventType particulat locus event
259
- * @returns {object} null
260
- * @memberof LocusInfo
261
- */
262
- // eslint-disable-next-line @typescript-eslint/no-shadow
263
- onFullLocus(locus: any, eventType?: string) {
264
- if (!locus) {
265
- LoggerProxy.logger.error(
266
- 'Locus-info:index#onFullLocus --> object passed as argument was invalid, continuing.'
267
- );
268
- }
269
- this.updateParticipantDeltas(locus.participants);
270
- this.scheduledMeeting = locus.meeting || null;
271
- this.participants = locus.participants;
272
- this.updateLocusInfo(locus);
273
- this.updateParticipants(locus.participants);
274
- this.isMeetingActive();
275
- this.handleOneOnOneEvent(eventType);
276
- this.updateEmbeddedApps(locus.embeddedApps);
277
- // set current (working copy) for parser
278
- this.locusParser.workingCopy = locus;
279
- }
280
-
281
- // used for ringing stops on one on one
282
- /**
283
- * @param {String} eventType
284
- * @returns {undefined}
285
- * @memberof LocusInfo
286
- */
287
- // eslint-disable-next-line @typescript-eslint/no-shadow
288
- handleOneOnOneEvent(eventType: string) {
289
- if (
290
- this.parsedLocus.fullState.type === _CALL_ ||
291
- this.parsedLocus.fullState.type === _SIP_BRIDGE_
292
- ) {
293
- // for 1:1 bob calls alice and alice declines, notify the meeting state
294
- if (eventType === LOCUSEVENT.PARTICIPANT_DECLINED) {
295
- // trigger the event for stop ringing
296
- this.emitScoped(
297
- {
298
- file: 'locus-info',
299
- function: 'handleOneonOneEvent',
300
- },
301
- EVENTS.REMOTE_RESPONSE,
302
- {
303
- remoteDeclined: true,
304
- remoteAnswered: false,
305
- }
306
- );
307
- }
308
- // for 1:1 bob calls alice and alice answers, notify the meeting state
309
- if (eventType === LOCUSEVENT.PARTICIPANT_JOIN) {
310
- // trigger the event for stop ringing
311
- this.emitScoped(
312
- {
313
- file: 'locus-info',
314
- function: 'handleOneonOneEvent',
315
- },
316
- EVENTS.REMOTE_RESPONSE,
317
- {
318
- remoteDeclined: false,
319
- remoteAnswered: true,
320
- }
321
- );
322
- }
323
- }
324
- }
325
-
326
- /**
327
- * @param {Object} locus
328
- * @returns {undefined}
329
- * @memberof LocusInfo
330
- */
331
- onDeltaLocus(locus: any) {
332
- this.updateLocusInfo(locus);
333
- this.updateParticipants(locus.participants);
334
- this.isMeetingActive();
335
- }
336
-
337
- /**
338
- * @param {Object} locus
339
- * @returns {undefined}
340
- * @memberof LocusInfo
341
- */
342
- updateLocusInfo(locus: any) {
343
- this.updateControls(locus.controls);
344
- this.updateConversationUrl(locus.conversationUrl, locus.info);
345
- this.updateCreated(locus.created);
346
- this.updateFullState(locus.fullState);
347
- this.updateHostInfo(locus.host);
348
- this.updateMeetingInfo(locus.info, locus.self);
349
- this.updateMediaShares(locus.mediaShares);
350
- this.updateParticipantsUrl(locus.participantsUrl);
351
- this.updateReplace(locus.replace);
352
- this.updateSelf(locus.self, locus.participants);
353
- this.updateLocusUrl(locus.url);
354
- this.updateAclUrl(locus.aclUrl);
355
- this.updateBasequence(locus.baseSequence);
356
- this.updateSequence(locus.sequence);
357
- this.updateMemberShip(locus.membership);
358
- this.updateIdentifiers(locus.identities);
359
- this.updateEmbeddedApps(locus.embeddedApps);
360
- this.updateServices(locus.links?.services);
361
- this.compareAndUpdate();
362
- // update which required to compare different objects from locus
363
- }
364
-
365
- /**
366
- * @param {Array} participants
367
- * @param {Object} self
368
- * @returns {Array}
369
- * @memberof LocusInfo
370
- */
371
- getLocusPartner(participants: Array<any>, self: any) {
372
- if (!participants || participants.length === 0) {
373
- return null;
374
- }
375
-
376
- return (
377
- participants.find(
378
- (participant) =>
379
- self &&
380
- participant.identity !== self.identity &&
381
- (participants.length <= 2 || (participant.type === _USER_ && !participant.removed))
382
- // @ts-ignore
383
- ) || this.partner
384
- );
385
- }
386
-
387
- // TODO: all the leave states need to be checked
388
- /**
389
- * @returns {undefined}
390
- * @memberof LocusInfo
391
- */
392
- isMeetingActive() {
393
- if (
394
- this.parsedLocus.fullState.type === _CALL_ ||
395
- this.parsedLocus.fullState.type === _SIP_BRIDGE_
396
- ) {
397
- // @ts-ignore
398
- const partner = this.getLocusPartner(this.participants, this.self);
399
-
400
- this.updateMeeting({partner});
401
-
402
- // Check if guest user needs to be checked here
403
-
404
- // 1) when bob declines call from bob, (bob='DECLINED')
405
- // 2) When alice rejects call to bob , (bob='NOTIFIED')
406
-
407
- // When we dont add MEDIA for condition 2. The state of bob='IDLE'
408
-
409
- if (this.fullState && this.fullState.state === LOCUS.STATE.INACTIVE) {
410
- // TODO: update the meeting state
411
- LoggerProxy.logger.warn(
412
- 'Locus-info:index#isMeetingActive --> Call Ended, locus state is inactive.'
413
- );
414
- Metrics.postEvent({
415
- event: eventType.REMOTE_ENDED,
416
- meetingId: this.meetingId,
417
- });
418
- this.emitScoped(
419
- {
420
- file: 'locus-info',
421
- function: 'isMeetingActive',
422
- },
423
- EVENTS.DESTROY_MEETING,
424
- {
425
- reason: CALL_REMOVED_REASON.CALL_INACTIVE,
426
- shouldLeave: false,
427
- }
428
- );
429
- } else if (
430
- partner.state === MEETING_STATE.STATES.LEFT &&
431
- this.parsedLocus.self &&
432
- (this.parsedLocus.self.state === MEETING_STATE.STATES.DECLINED ||
433
- this.parsedLocus.self.state === MEETING_STATE.STATES.NOTIFIED ||
434
- this.parsedLocus.self.state === MEETING_STATE.STATES.JOINED)
435
- ) {
436
- Metrics.postEvent({
437
- event: eventType.REMOTE_ENDED,
438
- meetingId: this.meetingId,
439
- });
440
- this.emitScoped(
441
- {
442
- file: 'locus-info',
443
- function: 'isMeetingActive',
444
- },
445
- EVENTS.DESTROY_MEETING,
446
- {
447
- reason: CALL_REMOVED_REASON.PARTNER_LEFT,
448
- shouldLeave:
449
- this.parsedLocus.self.joinedWith && this.parsedLocus.self.joinedWith.state !== _LEFT_,
450
- }
451
- );
452
- } else if (
453
- this.parsedLocus.self &&
454
- this.parsedLocus.self.state === MEETING_STATE.STATES.LEFT &&
455
- (partner.state === MEETING_STATE.STATES.LEFT ||
456
- partner.state === MEETING_STATE.STATES.DECLINED ||
457
- partner.state === MEETING_STATE.STATES.NOTIFIED ||
458
- partner.state === MEETING_STATE.STATES.IDLE) // Happens when user just joins and adds no Media
459
- ) {
460
- Metrics.postEvent({
461
- event: eventType.REMOTE_ENDED,
462
- meetingId: this.meetingId,
463
- });
464
- this.emitScoped(
465
- {
466
- file: 'locus-info',
467
- function: 'isMeetingActive',
468
- },
469
- EVENTS.DESTROY_MEETING,
470
- {
471
- reason: CALL_REMOVED_REASON.SELF_LEFT,
472
- shouldLeave: false,
473
- }
474
- );
475
- }
476
- } else if (this.parsedLocus.fullState.type === _MEETING_) {
477
- if (
478
- this.fullState &&
479
- (this.fullState.state === LOCUS.STATE.INACTIVE ||
480
- // @ts-ignore
481
- this.fullState.state === LOCUS.STATE.TERMINATING)
482
- ) {
483
- LoggerProxy.logger.warn(
484
- 'Locus-info:index#isMeetingActive --> Meeting is ending due to inactive or terminating'
485
- );
486
- Metrics.postEvent({
487
- event: eventType.REMOTE_ENDED,
488
- meetingId: this.meetingId,
489
- });
490
- this.emitScoped(
491
- {
492
- file: 'locus-info',
493
- function: 'isMeetingActive',
494
- },
495
- EVENTS.DESTROY_MEETING,
496
- {
497
- reason: MEETING_REMOVED_REASON.MEETING_INACTIVE_TERMINATING,
498
- shouldLeave: false,
499
- }
500
- );
501
- } else if (this.fullState && this.fullState.removed) {
502
- // user has been dropped from a meeting
503
- Metrics.postEvent({
504
- event: eventType.REMOTE_ENDED,
505
- meetingId: this.meetingId,
506
- });
507
- this.emitScoped(
508
- {
509
- file: 'locus-info',
510
- function: 'isMeetingActive',
511
- },
512
- EVENTS.DESTROY_MEETING,
513
- {
514
- reason: MEETING_REMOVED_REASON.FULLSTATE_REMOVED,
515
- shouldLeave: false,
516
- }
517
- );
518
- }
519
- // If you are guest and you are removed from the meeting
520
- // You wont get any further events
521
- else if (this.parsedLocus.self && this.parsedLocus.self.removed) {
522
- // Check if we need to send an event
523
- this.emitScoped(
524
- {
525
- file: 'locus-info',
526
- function: 'isMeetingActive',
527
- },
528
- EVENTS.DESTROY_MEETING,
529
- {
530
- reason: MEETING_REMOVED_REASON.SELF_REMOVED,
531
- shouldLeave: false,
532
- }
533
- );
534
- }
535
- } else {
536
- LoggerProxy.logger.warn('Locus-info:index#isMeetingActive --> Meeting Type is unknown.');
537
- }
538
- }
539
-
540
- /**
541
- * checks if the host permissions have changed while in the meeting
542
- * This would be the case if your role as host or moderator has been updated
543
- * @returns {undefined}
544
- * @memberof LocusInfo
545
- */
546
- compareAndUpdate() {
547
- // TODO: check with locus team on host and moderator doc
548
- // use host as a validator if needed
549
- if (
550
- this.compareAndUpdateFlags.compareSelfAndHost ||
551
- this.compareAndUpdateFlags.compareHostAndSelf
552
- ) {
553
- this.compareSelfAndHost();
554
- }
555
- }
556
-
557
- /**
558
- * compared the self object to check if the user has host permissions
559
- * @returns {undefined}
560
- * @memberof LocusInfo
561
- */
562
- compareSelfAndHost() {
563
- // In some cases the host info is not present but the moderator values changes from null to false so it triggers an update
564
- if (
565
- this.parsedLocus.self.selfIdentity === this.parsedLocus.host?.hostId &&
566
- this.parsedLocus.self.moderator
567
- ) {
568
- this.emitScoped(
569
- {
570
- file: 'locus-info',
571
- function: 'compareSelfAndHost',
572
- },
573
- EVENTS.LOCUS_INFO_CAN_ASSIGN_HOST,
574
- {
575
- canAssignHost: true,
576
- }
577
- );
578
- } else {
579
- this.emitScoped(
580
- {
581
- file: 'locus-info',
582
- function: 'compareSelfAndHost',
583
- },
584
- EVENTS.LOCUS_INFO_CAN_ASSIGN_HOST,
585
- {
586
- canAssignHost: false,
587
- }
588
- );
589
- }
590
- }
591
-
592
- /**
593
- * Update the deltaParticipants property of this object based on a list of
594
- * provided participants.
595
- *
596
- * @param {Array} [participants] - The participants to update against.
597
- * @returns {void}
598
- */
599
- updateParticipantDeltas(participants: Array<any> = []) {
600
- // Used to find a participant within a participants collection.
601
- const findParticipant = (participant, collection) =>
602
- collection.find((item) => item.person.id === participant.person.id);
603
-
604
- // Generates an object that indicates which state properties have changed.
605
- const generateDelta = (prevState: any = {}, newState: any = {}) => {
606
- // Setup deltas.
607
- const deltas = {
608
- audioStatus: prevState.audioStatus !== newState.audioStatus,
609
- videoSlidesStatus: prevState.videoSlidesStatus !== newState.videoSlidesStatus,
610
- videoStatus: prevState.videoStatus !== newState.videoStatus,
611
- };
612
-
613
- // Clean the object
614
- Object.keys(deltas).forEach((key) => {
615
- if (deltas[key] !== true) {
616
- delete deltas[key];
617
- }
618
- });
619
-
620
- return deltas;
621
- };
622
-
623
- this.deltaParticipants = participants.reduce((collection, participant) => {
624
- const existingParticipant = findParticipant(participant, this.participants || []) || {};
625
-
626
- const delta = generateDelta(existingParticipant.status, participant.status);
627
-
628
- const changed = Object.keys(delta).length > 0;
629
-
630
- if (changed) {
631
- collection.push({
632
- person: participant.person,
633
- delta,
634
- });
635
- }
636
-
637
- return collection;
638
- }, []);
639
- }
640
-
641
- /**
642
- *
643
- * @param {Object} participants new participants object
644
- * @param {boolen} deltaParticpantFlag delta event
645
- * @returns {Array} updatedParticipants
646
- * @memberof LocusInfo
647
- */
648
- updateParticipants(participants: object) {
649
- this.emitScoped(
650
- {
651
- file: 'locus-info',
652
- function: 'updateParticipants',
653
- },
654
- EVENTS.LOCUS_INFO_UPDATE_PARTICIPANTS,
655
- {
656
- participants,
657
- recordingId: this.parsedLocus.controls && this.parsedLocus.controls.record?.modifiedBy,
658
- selfIdentity: this.parsedLocus.self && this.parsedLocus.self.selfIdentity,
659
- selfId: this.parsedLocus.self && this.parsedLocus.self.selfId,
660
- hostId: this.parsedLocus.host && this.parsedLocus.host.hostId,
661
- }
662
- );
663
- }
664
-
665
- /**
666
- * @param {Object} controls
667
- * @returns {undefined}
668
- * @memberof LocusInfo
669
- */
670
- updateControls(controls: object) {
671
- if (controls && !isEqual(this.controls, controls)) {
672
- this.parsedLocus.controls = ControlsUtils.parse(controls);
673
- const {
674
- updates: {
675
- hasRecordingChanged,
676
- hasRecordingPausedChanged,
677
- hasMeetingContainerChanged,
678
- hasTranscribeChanged,
679
- hasEntryExitToneChanged,
680
- },
681
- current,
682
- } = ControlsUtils.getControls(this.controls, controls);
683
-
684
- if (hasRecordingChanged || hasRecordingPausedChanged) {
685
- let state = null;
686
-
687
- if (hasRecordingPausedChanged) {
688
- if (current.record.paused) {
689
- state = RECORDING_STATE.PAUSED;
690
- } else {
691
- // state will be `IDLE` if the recording is not active, even when there is a `pause` status change.
692
- state = current.record.recording ? RECORDING_STATE.RESUMED : RECORDING_STATE.IDLE;
693
- }
694
- } else if (hasRecordingChanged) {
695
- state = current.record.recording ? RECORDING_STATE.RECORDING : RECORDING_STATE.IDLE;
696
- }
697
-
698
- this.emitScoped(
699
- {
700
- file: 'locus-info',
701
- function: 'updateControls',
702
- },
703
- LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
704
- {
705
- state,
706
- modifiedBy: current.record.modifiedBy,
707
- lastModified: current.record.lastModified,
708
- }
709
- );
710
- }
711
-
712
- if (hasMeetingContainerChanged) {
713
- const {meetingContainerUrl} = current.meetingContainer;
714
-
715
- this.emitScoped(
716
- {
717
- file: 'locus-info',
718
- function: 'updateControls',
719
- },
720
- LOCUSINFO.EVENTS.CONTROLS_MEETING_CONTAINER_UPDATED,
721
- {
722
- meetingContainerUrl,
723
- }
724
- );
725
- }
726
-
727
- if (hasTranscribeChanged) {
728
- const {transcribing, caption} = current.transcribe;
729
-
730
- this.emitScoped(
731
- {
732
- file: 'locus-info',
733
- function: 'updateControls',
734
- },
735
- LOCUSINFO.EVENTS.CONTROLS_MEETING_TRANSCRIBE_UPDATED,
736
- {
737
- transcribing,
738
- caption,
739
- }
740
- );
741
- }
742
-
743
- if (hasEntryExitToneChanged) {
744
- const {entryExitTone} = current;
745
-
746
- this.emitScoped(
747
- {
748
- file: 'locus-info',
749
- function: 'updateControls',
750
- },
751
- LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED,
752
- {
753
- entryExitTone,
754
- }
755
- );
756
-
757
- this.updateMeeting({entryExitTone});
758
- }
759
-
760
- this.controls = controls;
761
- }
762
- }
763
-
764
- /**
765
- * @param {String} conversationUrl
766
- * @param {Object} info
767
- * @returns {undefined}
768
- * @memberof LocusInfo
769
- */
770
- updateConversationUrl(conversationUrl: string, info: any) {
771
- if (conversationUrl && !isEqual(this.conversationUrl, conversationUrl)) {
772
- this.conversationUrl = conversationUrl;
773
- this.updateMeeting({conversationUrl});
774
- } else if (
775
- info &&
776
- info.conversationUrl &&
777
- !isEqual(this.conversationUrl, info.conversationUrl)
778
- ) {
779
- this.conversationUrl = info.conversationUrl;
780
- this.updateMeeting({conversationUrl: info.conversationUrl});
781
- }
782
- }
783
-
784
- /**
785
- * @param {Object} created
786
- * @returns {undefined}
787
- * @memberof LocusInfo
788
- */
789
- updateCreated(created: object) {
790
- if (created && !isEqual(this.created, created)) {
791
- this.created = created;
792
- }
793
- }
794
-
795
- /**
796
- * @param {Object} services
797
- * @returns {undefined}
798
- * @memberof LocusInfo
799
- */
800
- updateServices(services: Record<'breakout' | 'record', {url: string}>) {
801
- if (services && !isEqual(this.services, services)) {
802
- this.services = services;
803
- this.emitScoped(
804
- {
805
- file: 'locus-info',
806
- function: 'updateServices',
807
- },
808
- LOCUSINFO.EVENTS.LINKS_SERVICES,
809
- {
810
- services,
811
- }
812
- );
813
- }
814
- }
815
-
816
- /**
817
- * @param {Object} fullState
818
- * @returns {undefined}
819
- * @memberof LocusInfo
820
- */
821
- updateFullState(fullState: object) {
822
- if (fullState && !isEqual(this.fullState, fullState)) {
823
- const result = FullState.getFullState(this.fullState, fullState);
824
-
825
- this.updateMeeting(result.current);
826
-
827
- if (result.updates.meetingStateChangedTo) {
828
- this.emitScoped(
829
- {
830
- file: 'locus-info',
831
- function: 'updateFullState',
832
- },
833
- LOCUSINFO.EVENTS.FULL_STATE_MEETING_STATE_CHANGE,
834
- {
835
- previousState: result.previous && result.previous.meetingState,
836
- currentState: result.current.meetingState,
837
- }
838
- );
839
- }
840
-
841
- if (result.updates.meetingTypeChangedTo) {
842
- this.emitScoped(
843
- {
844
- file: 'locus-info',
845
- function: 'updateFullState',
846
- },
847
- LOCUSINFO.EVENTS.FULL_STATE_TYPE_UPDATE,
848
- {
849
- type: result.current.type,
850
- }
851
- );
852
- }
853
- this.parsedLocus.fullState = result.current;
854
- this.fullState = fullState;
855
- }
856
- }
857
-
858
- /**
859
- * handles when the locus.host is updated
860
- * @param {Object} host the locus.host property
861
- * @returns {undefined}
862
- * @memberof LocusInfo
863
- * emits internal event locus_info_update_host
864
- */
865
- updateHostInfo(host: object) {
866
- if (host && !isEqual(this.host, host)) {
867
- const parsedHosts = HostUtils.getHosts(this.host, host);
868
-
869
- this.updateMeeting(parsedHosts.current);
870
- this.parsedLocus.host = parsedHosts.current;
871
- if (parsedHosts.updates.isNewHost) {
872
- this.compareAndUpdateFlags.compareSelfAndHost = true;
873
- this.emitScoped(
874
- {
875
- file: 'locus-info',
876
- function: 'updateHostInfo',
877
- },
878
- EVENTS.LOCUS_INFO_UPDATE_HOST,
879
- {
880
- newHost: parsedHosts.current,
881
- oldHost: parsedHosts.previous,
882
- }
883
- );
884
- }
885
- this.host = host;
886
- } else {
887
- this.compareAndUpdateFlags.compareSelfAndHost = false;
888
- }
889
- }
890
-
891
- /**
892
- * @param {Object} info
893
- * @param {Object} self
894
- * @returns {undefined}
895
- * @memberof LocusInfo
896
- */
897
- updateMeetingInfo(info: object, self?: object) {
898
- if (info && !isEqual(this.info, info)) {
899
- const roles = self ? SelfUtils.getRoles(self) : this.parsedLocus.self?.roles || [];
900
- const isJoined = SelfUtils.isJoined(self || this.parsedLocus.self);
901
- const parsedInfo = InfoUtils.getInfos(this.parsedLocus.info, info, roles, isJoined);
902
-
903
- this.emitScoped(
904
- {
905
- file: 'locus-info',
906
- function: 'updateMeetingInfo',
907
- },
908
- LOCUSINFO.EVENTS.MEETING_INFO_UPDATED,
909
- {info: parsedInfo.current, self}
910
- );
911
-
912
- if (parsedInfo.updates.isLocked) {
913
- this.emitScoped(
914
- {
915
- file: 'locus-info',
916
- function: 'updateMeetingInfo',
917
- },
918
- LOCUSINFO.EVENTS.MEETING_LOCKED,
919
- info
920
- );
921
- }
922
- if (parsedInfo.updates.isUnlocked) {
923
- this.emitScoped(
924
- {
925
- file: 'locus-info',
926
- function: 'updateMeetingInfo',
927
- },
928
- LOCUSINFO.EVENTS.MEETING_UNLOCKED,
929
- info
930
- );
931
- }
932
-
933
- this.info = info;
934
- this.parsedLocus.info = parsedInfo.current;
935
- // Parses the info and adds necessary values
936
- this.updateMeeting(parsedInfo.current);
937
- }
938
- }
939
-
940
- /**
941
- * @param {Object} embeddedApps
942
- * @returns {undefined}
943
- * @memberof LocusInfo
944
- */
945
- updateEmbeddedApps(embeddedApps: object) {
946
- // don't do anything if the arrays of apps haven't changed significantly
947
- if (EmbeddedAppsUtils.areSimilar(this.embeddedApps, embeddedApps)) {
948
- return;
949
- }
950
-
951
- const parsedEmbeddedApps = EmbeddedAppsUtils.parse(embeddedApps);
952
-
953
- this.updateMeeting({embeddedApps: parsedEmbeddedApps});
954
-
955
- this.emitScoped(
956
- {
957
- file: 'locus-info',
958
- function: 'updateEmbeddedApps',
959
- },
960
- LOCUSINFO.EVENTS.EMBEDDED_APPS_UPDATED,
961
- parsedEmbeddedApps
962
- );
963
- this.embeddedApps = embeddedApps;
964
- }
965
-
966
- /**
967
- * handles when the locus.mediaShares is updated
968
- * @param {Object} mediaShares the locus.mediaShares property
969
- * @returns {undefined}
970
- * @memberof LocusInfo
971
- * emits internal event locus_info_update_media_shares
972
- */
973
- updateMediaShares(mediaShares: object) {
974
- if (mediaShares && !isEqual(this.mediaShares, mediaShares)) {
975
- const parsedMediaShares = MediaSharesUtils.getMediaShares(this.mediaShares, mediaShares);
976
-
977
- this.updateMeeting(parsedMediaShares.current);
978
- this.emitScoped(
979
- {
980
- file: 'locus-info',
981
- function: 'updateMediaShares',
982
- },
983
- EVENTS.LOCUS_INFO_UPDATE_MEDIA_SHARES,
984
- {
985
- current: parsedMediaShares.current,
986
- previous: parsedMediaShares.previous,
987
- }
988
- );
989
- this.parsedLocus.mediaShares = parsedMediaShares.current;
990
- this.mediaShares = mediaShares;
991
- }
992
- }
993
-
994
- /**
995
- * @param {String} participantsUrl
996
- * @returns {undefined}
997
- * @memberof LocusInfo
998
- */
999
- updateParticipantsUrl(participantsUrl: string) {
1000
- if (participantsUrl && !isEqual(this.participantsUrl, participantsUrl)) {
1001
- this.participantsUrl = participantsUrl;
1002
- }
1003
- }
1004
-
1005
- /**
1006
- * @param {Object} replace
1007
- * @returns {undefined}
1008
- * @memberof LocusInfo
1009
- */
1010
- updateReplace(replace: object) {
1011
- if (replace && !isEqual(this.replace, replace)) {
1012
- this.replace = replace;
1013
- }
1014
- }
1015
-
1016
- /**
1017
- * handles when the locus.self is updated
1018
- * @param {Object} self the locus.mediaShares property
1019
- * @param {Array} participants the locus.participants property
1020
- * @returns {undefined}
1021
- * @memberof LocusInfo
1022
- * emits internal events self_admitted_guest, self_unadmitted_guest, locus_info_update_self
1023
- */
1024
- updateSelf(self: any, participants: Array<any>) {
1025
- // @ts-ignore - check where this.self come from
1026
- if (self && !isEqual(this.self, self)) {
1027
- // @ts-ignore
1028
- const parsedSelves = SelfUtils.getSelves(this.self, self, this.webex.internal.device.url);
1029
-
1030
- this.updateMeeting(parsedSelves.current);
1031
- this.parsedLocus.self = parsedSelves.current;
1032
-
1033
- const element = this.parsedLocus.states[this.parsedLocus.states.length - 1];
1034
-
1035
- if (element !== parsedSelves.current.state) {
1036
- this.parsedLocus.states.push(parsedSelves.current.state);
1037
- }
1038
-
1039
- // TODO: check if we need to save the sipUri here as well
1040
- // this.emit(LOCUSINFO.EVENTS.MEETING_UPDATE, SelfUtils.getSipUrl(this.getLocusPartner(participants, self), this.parsedLocus.fullState.type, this.parsedLocus.info.sipUri));
1041
- const result = SelfUtils.getSipUrl(
1042
- this.getLocusPartner(participants, self),
1043
- this.parsedLocus.fullState.type,
1044
- this.parsedLocus.info.sipUri
1045
- );
1046
-
1047
- if (result.sipUri) {
1048
- this.updateMeeting(result);
1049
- }
1050
-
1051
- if (parsedSelves.updates.moderatorChanged) {
1052
- this.compareAndUpdateFlags.compareHostAndSelf = true;
1053
- } else {
1054
- this.compareAndUpdateFlags.compareHostAndSelf = false;
1055
- }
1056
-
1057
- if (parsedSelves.updates.layoutChanged) {
1058
- this.emitScoped(
1059
- {
1060
- file: 'locus-info',
1061
- function: 'updateSelf',
1062
- },
1063
- LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED,
1064
- {layout: parsedSelves.current.layout}
1065
- );
1066
- }
1067
-
1068
- if (parsedSelves.updates.isMediaInactiveOrReleased) {
1069
- this.emitScoped(
1070
- {
1071
- file: 'locus-info',
1072
- function: 'updateSelf',
1073
- },
1074
- LOCUSINFO.EVENTS.DISCONNECT_DUE_TO_INACTIVITY,
1075
- {reason: self.reason}
1076
- );
1077
- }
1078
-
1079
- if (parsedSelves.updates.moderatorChanged) {
1080
- this.emitScoped(
1081
- {
1082
- file: 'locus-info',
1083
- function: 'updateSelf',
1084
- },
1085
- LOCUSINFO.EVENTS.SELF_MODERATOR_CHANGED,
1086
- self
1087
- );
1088
- }
1089
- if (parsedSelves.updates.localAudioUnmuteRequiredByServer) {
1090
- this.emitScoped(
1091
- {
1092
- file: 'locus-info',
1093
- function: 'updateSelf',
1094
- },
1095
- LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUIRED,
1096
- {
1097
- muted: parsedSelves.current.remoteMuted,
1098
- unmuteAllowed: parsedSelves.current.unmuteAllowed,
1099
- }
1100
- );
1101
- }
1102
- if (parsedSelves.updates.isMutedByOthersChanged) {
1103
- this.emitScoped(
1104
- {
1105
- file: 'locus-info',
1106
- function: 'updateSelf',
1107
- },
1108
- LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
1109
- {
1110
- muted: parsedSelves.current.remoteMuted,
1111
- unmuteAllowed: parsedSelves.current.unmuteAllowed,
1112
- }
1113
- );
1114
- }
1115
- if (parsedSelves.updates.localAudioUnmuteRequestedByServer) {
1116
- this.emitScoped(
1117
- {
1118
- file: 'locus-info',
1119
- function: 'updateSelf',
1120
- },
1121
- LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUESTED,
1122
- {}
1123
- );
1124
- }
1125
- if (parsedSelves.updates.isUserUnadmitted) {
1126
- this.emitScoped(
1127
- {
1128
- file: 'locus-info',
1129
- function: 'updateSelf',
1130
- },
1131
- LOCUSINFO.EVENTS.SELF_UNADMITTED_GUEST,
1132
- self
1133
- );
1134
- }
1135
- if (parsedSelves.updates.isUserAdmitted) {
1136
- this.emitScoped(
1137
- {
1138
- file: 'locus-info',
1139
- function: 'updateSelf',
1140
- },
1141
- LOCUSINFO.EVENTS.SELF_ADMITTED_GUEST,
1142
- self
1143
- );
1144
- }
1145
-
1146
- if (parsedSelves.updates.isMediaInactive) {
1147
- this.emitScoped(
1148
- {
1149
- file: 'locus-info',
1150
- function: 'updateSelf',
1151
- },
1152
- // @ts-ignore
1153
- LOCUSINFO.EVENTS.MEDIA_INACTIVITY,
1154
- SelfUtils.getMediaStatus(self.mediaSessions)
1155
- );
1156
- }
1157
-
1158
- if (
1159
- parsedSelves.updates.audioStateChange ||
1160
- parsedSelves.updates.videoStateChange ||
1161
- parsedSelves.updates.shareStateChange
1162
- ) {
1163
- this.emitScoped(
1164
- {
1165
- file: 'locus-info',
1166
- function: 'updateSelf',
1167
- },
1168
- LOCUSINFO.EVENTS.MEDIA_STATUS_CHANGE,
1169
- {
1170
- audioStatus: parsedSelves.current.currentMediaStatus?.audio,
1171
- videoStatus: parsedSelves.current.currentMediaStatus?.video,
1172
- shareStatus: parsedSelves.current.currentMediaStatus?.share,
1173
- }
1174
- );
1175
- }
1176
-
1177
- if (parsedSelves.updates.isUserObserving) {
1178
- this.emitScoped(
1179
- {
1180
- file: 'locus-info',
1181
- function: 'updateSelf',
1182
- },
1183
- LOCUSINFO.EVENTS.SELF_OBSERVING
1184
- );
1185
- }
1186
-
1187
- if (parsedSelves.updates.canNotViewTheParticipantListChanged) {
1188
- this.emitScoped(
1189
- {
1190
- file: 'locus-info',
1191
- function: 'updateSelf',
1192
- },
1193
- LOCUSINFO.EVENTS.SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE,
1194
- {canNotViewTheParticipantList: parsedSelves.current.canNotViewTheParticipantList}
1195
- );
1196
- }
1197
-
1198
- if (parsedSelves.updates.isSharingBlockedChanged) {
1199
- this.emitScoped(
1200
- {
1201
- file: 'locus-info',
1202
- function: 'updateSelf',
1203
- },
1204
- LOCUSINFO.EVENTS.SELF_IS_SHARING_BLOCKED_CHANGE,
1205
- {isSharingBlocked: parsedSelves.current.isSharingBlocked}
1206
- );
1207
- }
1208
-
1209
- this.emitScoped(
1210
- {
1211
- file: 'locus-info',
1212
- function: 'updateSelf',
1213
- },
1214
- EVENTS.LOCUS_INFO_UPDATE_SELF,
1215
- {
1216
- oldSelf: parsedSelves.previous,
1217
- newSelf: parsedSelves.current,
1218
- }
1219
- );
1220
- this.parsedLocus.self = parsedSelves.current;
1221
- // @ts-ignore
1222
- this.self = self;
1223
- } else {
1224
- this.compareAndUpdateFlags.compareHostAndSelf = false;
1225
- }
1226
- }
1227
-
1228
- /**
1229
- * handles when the locus.url is updated
1230
- * @param {String} url
1231
- * @returns {undefined}
1232
- * emits internal event locus_info_update_url
1233
- */
1234
- updateLocusUrl(url: string) {
1235
- if (url && this.url !== url) {
1236
- this.url = url;
1237
- this.updateMeeting({locusUrl: url});
1238
- this.emitScoped(
1239
- {
1240
- file: 'locus-info',
1241
- function: 'updateLocusUrl',
1242
- },
1243
- EVENTS.LOCUS_INFO_UPDATE_URL,
1244
- url
1245
- );
1246
- }
1247
- }
1248
-
1249
- /**
1250
- * @param {String} aclUrl
1251
- * @returns {undefined}
1252
- * @memberof LocusInfo
1253
- */
1254
- updateAclUrl(aclUrl: string) {
1255
- if (aclUrl && !isEqual(this.aclUrl, aclUrl)) {
1256
- this.aclUrl = aclUrl;
1257
- }
1258
- }
1259
-
1260
- /**
1261
- * @param {Number} baseSequence
1262
- * @returns {undefined}
1263
- * @memberof LocusInfo
1264
- */
1265
- updateBasequence(baseSequence: number) {
1266
- if (baseSequence && !isEqual(this.baseSequence, baseSequence)) {
1267
- this.baseSequence = baseSequence;
1268
- }
1269
- }
1270
-
1271
- /**
1272
- * @param {Number} sequence
1273
- * @returns {undefined}
1274
- * @memberof LocusInfo
1275
- */
1276
- updateSequence(sequence: number) {
1277
- if (sequence && !isEqual(this.sequence, sequence)) {
1278
- this.sequence = sequence;
1279
- }
1280
- }
1281
-
1282
- /**
1283
- * @param {Object} membership
1284
- * @returns {undefined}
1285
- * @memberof LocusInfo
1286
- */
1287
- updateMemberShip(membership: object) {
1288
- if (membership && !isEqual(this.membership, membership)) {
1289
- this.membership = membership;
1290
- }
1291
- }
1292
-
1293
- /**
1294
- * @param {Array} identities
1295
- * @returns {undefined}
1296
- * @memberof LocusInfo
1297
- */
1298
- updateIdentifiers(identities: Array<any>) {
1299
- if (identities && !isEqual(this.identities, identities)) {
1300
- this.identities = identities;
1301
- }
1302
- }
1303
- }
1
+ import {isEqual} from 'lodash';
2
+
3
+ import LoggerProxy from '../common/logs/logger-proxy';
4
+ import EventsScope from '../common/events/events-scope';
5
+ import {
6
+ EVENTS,
7
+ LOCUSEVENT,
8
+ _USER_,
9
+ _CALL_,
10
+ _SIP_BRIDGE_,
11
+ MEETING_STATE,
12
+ _MEETING_,
13
+ LOCUSINFO,
14
+ LOCUS,
15
+ _LEFT_,
16
+ MEETING_REMOVED_REASON,
17
+ CALL_REMOVED_REASON,
18
+ RECORDING_STATE,
19
+ } from '../constants';
20
+ import Metrics from '../metrics';
21
+ import {eventType} from '../metrics/config';
22
+ import InfoUtils from './infoUtils';
23
+ import FullState from './fullState';
24
+ import SelfUtils from './selfUtils';
25
+ import HostUtils from './hostUtils';
26
+ import ControlsUtils from './controlsUtils';
27
+ import EmbeddedAppsUtils from './embeddedAppsUtils';
28
+ import MediaSharesUtils from './mediaSharesUtils';
29
+ import LocusDeltaParser from './parser';
30
+
31
+ /**
32
+ * @description LocusInfo extends ChildEmitter to convert locusInfo info a private emitter to parent object
33
+ * @export
34
+ * @private
35
+ * @class LocusInfo
36
+ */
37
+ export default class LocusInfo extends EventsScope {
38
+ compareAndUpdateFlags: any;
39
+ emitChange: any;
40
+ locusParser: any;
41
+ meetingId: any;
42
+ parsedLocus: any;
43
+ updateMeeting: any;
44
+ webex: any;
45
+ aclUrl: any;
46
+ baseSequence: any;
47
+ created: any;
48
+ deltaParticipants: any;
49
+ identities: any;
50
+ membership: any;
51
+ participants: any;
52
+ participantsUrl: any;
53
+ replaces: any;
54
+ scheduledMeeting: any;
55
+ sequence: any;
56
+ controls: any;
57
+ conversationUrl: any;
58
+ embeddedApps: any;
59
+ fullState: any;
60
+ host: any;
61
+ info: any;
62
+ mediaShares: any;
63
+ replace: any;
64
+ url: any;
65
+ services: any;
66
+
67
+ constructor(updateMeeting, webex, meetingId) {
68
+ super();
69
+ this.parsedLocus = {
70
+ states: [],
71
+ };
72
+ this.webex = webex;
73
+ this.emitChange = false;
74
+ this.compareAndUpdateFlags = {};
75
+ this.meetingId = meetingId;
76
+ this.updateMeeting = updateMeeting;
77
+ this.locusParser = new LocusDeltaParser();
78
+ }
79
+
80
+ /**
81
+ * Apply locus delta data to meeting
82
+ * @param {string} action Locus delta action
83
+ * @param {Locus} locus
84
+ * @param {Meeting} meeting
85
+ * @returns {undefined}
86
+ */
87
+ applyLocusDeltaData(action: string, locus: any, meeting: any) {
88
+ const {DESYNC, USE_CURRENT, USE_INCOMING} = LocusDeltaParser.loci;
89
+
90
+ switch (action) {
91
+ case USE_INCOMING:
92
+ meeting.locusInfo.onDeltaLocus(locus);
93
+ break;
94
+ case USE_CURRENT:
95
+ meeting.locusDesync = false;
96
+ meeting.needToGetFullLocus = false;
97
+ break;
98
+ case DESYNC:
99
+ meeting.meetingRequest
100
+ .getFullLocus({
101
+ desync: true,
102
+ locusUrl: meeting.locusUrl,
103
+ })
104
+ .then((res) => {
105
+ meeting.locusInfo.onFullLocus(res.body);
106
+ // Notify parser to resume processing delta events
107
+ // now that we have full locus from DESYNC.
108
+ this.locusParser.resume();
109
+ });
110
+ break;
111
+ default:
112
+ LoggerProxy.logger.info(
113
+ `Locus-info:index#applyLocusDeltaData --> Unknown locus delta action: ${action}`
114
+ );
115
+ }
116
+ }
117
+
118
+ /**
119
+ * Adds locus delta to parser's queue
120
+ * and registers a function handler
121
+ * to recieve parsed actions from queue.
122
+ * @param {Locus} locus
123
+ * @param {Meeting} meeting
124
+ * @returns {undefined}
125
+ */
126
+ handleLocusDelta(locus: any, meeting: any) {
127
+ // register a function to process delta actions
128
+ if (!this.locusParser.onDeltaAction) {
129
+ // delta action, along with associated loci
130
+ // is passed into the function.
131
+ this.locusParser.onDeltaAction = (action, parsedLoci) => {
132
+ this.applyLocusDeltaData(action, parsedLoci, meeting);
133
+ };
134
+ }
135
+ // queue delta event with parser
136
+ this.locusParser.onDeltaEvent(locus);
137
+ }
138
+
139
+ /**
140
+ * @param {Locus} locus
141
+ * @returns {undefined}
142
+ * @memberof LocusInfo
143
+ */
144
+ init(locus: any = {}) {
145
+ this.created = locus.created || null;
146
+ this.scheduledMeeting = locus.meeting || null;
147
+ this.participantsUrl = locus.participantsUrl || null;
148
+ this.replaces = locus.replaces || null;
149
+ this.aclUrl = locus.aclUrl || null;
150
+ this.baseSequence = locus.baseSequence || null;
151
+ this.sequence = locus.sequence || null;
152
+ this.membership = locus.membership || null;
153
+ this.identities = locus.identities || null;
154
+ this.participants = locus.participants || null;
155
+
156
+ /**
157
+ * Stores the delta values for a changed participant.
158
+ *
159
+ * @typedef {Object} DeltaParticipant
160
+ * @property {Record<string, boolean>} delta - Contains changed streams.
161
+ * @property {Object} person - Contains person data.
162
+ */
163
+
164
+ /**
165
+ * Stored participant changes between the last event and the current event.
166
+ * All previously stored events are overwritten between events.
167
+ *
168
+ * @instance
169
+ * @type {Array<DeltaParticipant>}
170
+ * @private
171
+ * @member LocusInfo
172
+ */
173
+ this.deltaParticipants = [];
174
+
175
+ // above section only updates the locusInfo object
176
+ // The below section makes sure it updates the locusInfo as well as updates the meeting object
177
+ this.updateParticipants(locus.participants);
178
+ // For 1:1 space meeting the conversation Url does not exist in locus.conversation
179
+ this.updateConversationUrl(locus.conversationUrl, locus.info);
180
+ this.updateControls(locus.controls);
181
+ this.updateLocusUrl(locus.url);
182
+ this.updateFullState(locus.fullState);
183
+ this.updateMeetingInfo(locus.info);
184
+ this.updateEmbeddedApps(locus.embeddedApps);
185
+ // self and participants generate sipUrl for 1:1 meeting
186
+ this.updateSelf(locus.self, locus.participants);
187
+ this.updateHostInfo(locus.host);
188
+ this.updateMediaShares(locus.mediaShares);
189
+ this.updateServices(locus.links?.services);
190
+ }
191
+
192
+ /**
193
+ * @param {Object} locus
194
+ * @returns {undefined}
195
+ * @memberof LocusInfo
196
+ */
197
+ initialSetup(locus: object) {
198
+ this.onFullLocus(locus);
199
+
200
+ // Change it to true after it receives it first locus object
201
+ this.emitChange = true;
202
+ }
203
+
204
+ /**
205
+ * @param {Meeting} meeting
206
+ * @param {Object} data
207
+ * @returns {undefined}
208
+ * @memberof LocusInfo
209
+ */
210
+ parse(meeting: any, data: any) {
211
+ // eslint-disable-next-line @typescript-eslint/no-shadow
212
+ const {eventType} = data;
213
+
214
+ LoggerProxy.logger.info(`Locus-info:index#parse --> received locus data: ${eventType}`);
215
+
216
+ switch (eventType) {
217
+ case LOCUSEVENT.PARTICIPANT_JOIN:
218
+ case LOCUSEVENT.PARTICIPANT_LEFT:
219
+ case LOCUSEVENT.CONTROLS_UPDATED:
220
+ case LOCUSEVENT.PARTICIPANT_AUDIO_MUTED:
221
+ case LOCUSEVENT.PARTICIPANT_AUDIO_UNMUTED:
222
+ case LOCUSEVENT.PARTICIPANT_VIDEO_MUTED:
223
+ case LOCUSEVENT.PARTICIPANT_VIDEO_UNMUTED:
224
+ case LOCUSEVENT.SELF_CHANGED:
225
+ case LOCUSEVENT.PARTICIPANT_UPDATED:
226
+ case LOCUSEVENT.PARTICIPANT_CONTROLS_UPDATED:
227
+ case LOCUSEVENT.PARTICIPANT_ROLES_UPDATED:
228
+ case LOCUSEVENT.PARTICIPANT_DECLINED:
229
+ case LOCUSEVENT.FLOOR_GRANTED:
230
+ case LOCUSEVENT.FLOOR_RELEASED:
231
+ this.onFullLocus(data.locus, eventType);
232
+ break;
233
+ case LOCUSEVENT.DIFFERENCE:
234
+ this.handleLocusDelta(data.locus, meeting);
235
+ break;
236
+
237
+ default:
238
+ // Why will there be a event with no eventType ????
239
+ // we may not need this, we can get full locus
240
+ this.handleLocusDelta(data.locus, meeting);
241
+ }
242
+ }
243
+
244
+ /**
245
+ * @param {String} scope
246
+ * @param {String} eventName
247
+ * @param {Array} args
248
+ * @returns {undefined}
249
+ * @memberof LocusInfo
250
+ */
251
+ emitScoped(scope?: any, eventName?: string, args?: any) {
252
+ return this.emit(scope, eventName, args);
253
+ }
254
+
255
+ /**
256
+ * updates the locus with full locus object
257
+ * @param {object} locus locus object
258
+ * @param {string} eventType particulat locus event
259
+ * @returns {object} null
260
+ * @memberof LocusInfo
261
+ */
262
+ // eslint-disable-next-line @typescript-eslint/no-shadow
263
+ onFullLocus(locus: any, eventType?: string) {
264
+ if (!locus) {
265
+ LoggerProxy.logger.error(
266
+ 'Locus-info:index#onFullLocus --> object passed as argument was invalid, continuing.'
267
+ );
268
+ }
269
+ this.updateParticipantDeltas(locus.participants);
270
+ this.scheduledMeeting = locus.meeting || null;
271
+ this.participants = locus.participants;
272
+ this.updateLocusInfo(locus);
273
+ this.updateParticipants(locus.participants);
274
+ this.isMeetingActive();
275
+ this.handleOneOnOneEvent(eventType);
276
+ this.updateEmbeddedApps(locus.embeddedApps);
277
+ // set current (working copy) for parser
278
+ this.locusParser.workingCopy = locus;
279
+ }
280
+
281
+ // used for ringing stops on one on one
282
+ /**
283
+ * @param {String} eventType
284
+ * @returns {undefined}
285
+ * @memberof LocusInfo
286
+ */
287
+ // eslint-disable-next-line @typescript-eslint/no-shadow
288
+ handleOneOnOneEvent(eventType: string) {
289
+ if (
290
+ this.parsedLocus.fullState.type === _CALL_ ||
291
+ this.parsedLocus.fullState.type === _SIP_BRIDGE_
292
+ ) {
293
+ // for 1:1 bob calls alice and alice declines, notify the meeting state
294
+ if (eventType === LOCUSEVENT.PARTICIPANT_DECLINED) {
295
+ // trigger the event for stop ringing
296
+ this.emitScoped(
297
+ {
298
+ file: 'locus-info',
299
+ function: 'handleOneonOneEvent',
300
+ },
301
+ EVENTS.REMOTE_RESPONSE,
302
+ {
303
+ remoteDeclined: true,
304
+ remoteAnswered: false,
305
+ }
306
+ );
307
+ }
308
+ // for 1:1 bob calls alice and alice answers, notify the meeting state
309
+ if (eventType === LOCUSEVENT.PARTICIPANT_JOIN) {
310
+ // trigger the event for stop ringing
311
+ this.emitScoped(
312
+ {
313
+ file: 'locus-info',
314
+ function: 'handleOneonOneEvent',
315
+ },
316
+ EVENTS.REMOTE_RESPONSE,
317
+ {
318
+ remoteDeclined: false,
319
+ remoteAnswered: true,
320
+ }
321
+ );
322
+ }
323
+ }
324
+ }
325
+
326
+ /**
327
+ * @param {Object} locus
328
+ * @returns {undefined}
329
+ * @memberof LocusInfo
330
+ */
331
+ onDeltaLocus(locus: any) {
332
+ this.updateLocusInfo(locus);
333
+ this.updateParticipants(locus.participants);
334
+ this.isMeetingActive();
335
+ }
336
+
337
+ /**
338
+ * @param {Object} locus
339
+ * @returns {undefined}
340
+ * @memberof LocusInfo
341
+ */
342
+ updateLocusInfo(locus: any) {
343
+ this.updateControls(locus.controls);
344
+ this.updateConversationUrl(locus.conversationUrl, locus.info);
345
+ this.updateCreated(locus.created);
346
+ this.updateFullState(locus.fullState);
347
+ this.updateHostInfo(locus.host);
348
+ this.updateMeetingInfo(locus.info, locus.self);
349
+ this.updateMediaShares(locus.mediaShares);
350
+ this.updateParticipantsUrl(locus.participantsUrl);
351
+ this.updateReplace(locus.replace);
352
+ this.updateSelf(locus.self, locus.participants);
353
+ this.updateLocusUrl(locus.url);
354
+ this.updateAclUrl(locus.aclUrl);
355
+ this.updateBasequence(locus.baseSequence);
356
+ this.updateSequence(locus.sequence);
357
+ this.updateMemberShip(locus.membership);
358
+ this.updateIdentifiers(locus.identities);
359
+ this.updateEmbeddedApps(locus.embeddedApps);
360
+ this.updateServices(locus.links?.services);
361
+ this.compareAndUpdate();
362
+ // update which required to compare different objects from locus
363
+ }
364
+
365
+ /**
366
+ * @param {Array} participants
367
+ * @param {Object} self
368
+ * @returns {Array}
369
+ * @memberof LocusInfo
370
+ */
371
+ getLocusPartner(participants: Array<any>, self: any) {
372
+ if (!participants || participants.length === 0) {
373
+ return null;
374
+ }
375
+
376
+ return (
377
+ participants.find(
378
+ (participant) =>
379
+ self &&
380
+ participant.identity !== self.identity &&
381
+ (participants.length <= 2 || (participant.type === _USER_ && !participant.removed))
382
+ // @ts-ignore
383
+ ) || this.partner
384
+ );
385
+ }
386
+
387
+ // TODO: all the leave states need to be checked
388
+ /**
389
+ * @returns {undefined}
390
+ * @memberof LocusInfo
391
+ */
392
+ isMeetingActive() {
393
+ if (
394
+ this.parsedLocus.fullState.type === _CALL_ ||
395
+ this.parsedLocus.fullState.type === _SIP_BRIDGE_
396
+ ) {
397
+ // @ts-ignore
398
+ const partner = this.getLocusPartner(this.participants, this.self);
399
+
400
+ this.updateMeeting({partner});
401
+
402
+ // Check if guest user needs to be checked here
403
+
404
+ // 1) when bob declines call from bob, (bob='DECLINED')
405
+ // 2) When alice rejects call to bob , (bob='NOTIFIED')
406
+
407
+ // When we dont add MEDIA for condition 2. The state of bob='IDLE'
408
+
409
+ if (this.fullState && this.fullState.state === LOCUS.STATE.INACTIVE) {
410
+ // TODO: update the meeting state
411
+ LoggerProxy.logger.warn(
412
+ 'Locus-info:index#isMeetingActive --> Call Ended, locus state is inactive.'
413
+ );
414
+ Metrics.postEvent({
415
+ event: eventType.REMOTE_ENDED,
416
+ meetingId: this.meetingId,
417
+ });
418
+ this.emitScoped(
419
+ {
420
+ file: 'locus-info',
421
+ function: 'isMeetingActive',
422
+ },
423
+ EVENTS.DESTROY_MEETING,
424
+ {
425
+ reason: CALL_REMOVED_REASON.CALL_INACTIVE,
426
+ shouldLeave: false,
427
+ }
428
+ );
429
+ } else if (
430
+ partner.state === MEETING_STATE.STATES.LEFT &&
431
+ this.parsedLocus.self &&
432
+ (this.parsedLocus.self.state === MEETING_STATE.STATES.DECLINED ||
433
+ this.parsedLocus.self.state === MEETING_STATE.STATES.NOTIFIED ||
434
+ this.parsedLocus.self.state === MEETING_STATE.STATES.JOINED)
435
+ ) {
436
+ Metrics.postEvent({
437
+ event: eventType.REMOTE_ENDED,
438
+ meetingId: this.meetingId,
439
+ });
440
+ this.emitScoped(
441
+ {
442
+ file: 'locus-info',
443
+ function: 'isMeetingActive',
444
+ },
445
+ EVENTS.DESTROY_MEETING,
446
+ {
447
+ reason: CALL_REMOVED_REASON.PARTNER_LEFT,
448
+ shouldLeave:
449
+ this.parsedLocus.self.joinedWith && this.parsedLocus.self.joinedWith.state !== _LEFT_,
450
+ }
451
+ );
452
+ } else if (
453
+ this.parsedLocus.self &&
454
+ this.parsedLocus.self.state === MEETING_STATE.STATES.LEFT &&
455
+ (partner.state === MEETING_STATE.STATES.LEFT ||
456
+ partner.state === MEETING_STATE.STATES.DECLINED ||
457
+ partner.state === MEETING_STATE.STATES.NOTIFIED ||
458
+ partner.state === MEETING_STATE.STATES.IDLE) // Happens when user just joins and adds no Media
459
+ ) {
460
+ Metrics.postEvent({
461
+ event: eventType.REMOTE_ENDED,
462
+ meetingId: this.meetingId,
463
+ });
464
+ this.emitScoped(
465
+ {
466
+ file: 'locus-info',
467
+ function: 'isMeetingActive',
468
+ },
469
+ EVENTS.DESTROY_MEETING,
470
+ {
471
+ reason: CALL_REMOVED_REASON.SELF_LEFT,
472
+ shouldLeave: false,
473
+ }
474
+ );
475
+ }
476
+ } else if (this.parsedLocus.fullState.type === _MEETING_) {
477
+ if (
478
+ this.fullState &&
479
+ (this.fullState.state === LOCUS.STATE.INACTIVE ||
480
+ // @ts-ignore
481
+ this.fullState.state === LOCUS.STATE.TERMINATING)
482
+ ) {
483
+ LoggerProxy.logger.warn(
484
+ 'Locus-info:index#isMeetingActive --> Meeting is ending due to inactive or terminating'
485
+ );
486
+ Metrics.postEvent({
487
+ event: eventType.REMOTE_ENDED,
488
+ meetingId: this.meetingId,
489
+ });
490
+ this.emitScoped(
491
+ {
492
+ file: 'locus-info',
493
+ function: 'isMeetingActive',
494
+ },
495
+ EVENTS.DESTROY_MEETING,
496
+ {
497
+ reason: MEETING_REMOVED_REASON.MEETING_INACTIVE_TERMINATING,
498
+ shouldLeave: false,
499
+ }
500
+ );
501
+ } else if (this.fullState && this.fullState.removed) {
502
+ // user has been dropped from a meeting
503
+ Metrics.postEvent({
504
+ event: eventType.REMOTE_ENDED,
505
+ meetingId: this.meetingId,
506
+ });
507
+ this.emitScoped(
508
+ {
509
+ file: 'locus-info',
510
+ function: 'isMeetingActive',
511
+ },
512
+ EVENTS.DESTROY_MEETING,
513
+ {
514
+ reason: MEETING_REMOVED_REASON.FULLSTATE_REMOVED,
515
+ shouldLeave: false,
516
+ }
517
+ );
518
+ }
519
+ // If you are guest and you are removed from the meeting
520
+ // You wont get any further events
521
+ else if (this.parsedLocus.self && this.parsedLocus.self.removed) {
522
+ // Check if we need to send an event
523
+ this.emitScoped(
524
+ {
525
+ file: 'locus-info',
526
+ function: 'isMeetingActive',
527
+ },
528
+ EVENTS.DESTROY_MEETING,
529
+ {
530
+ reason: MEETING_REMOVED_REASON.SELF_REMOVED,
531
+ shouldLeave: false,
532
+ }
533
+ );
534
+ }
535
+ } else {
536
+ LoggerProxy.logger.warn('Locus-info:index#isMeetingActive --> Meeting Type is unknown.');
537
+ }
538
+ }
539
+
540
+ /**
541
+ * checks if the host permissions have changed while in the meeting
542
+ * This would be the case if your role as host or moderator has been updated
543
+ * @returns {undefined}
544
+ * @memberof LocusInfo
545
+ */
546
+ compareAndUpdate() {
547
+ // TODO: check with locus team on host and moderator doc
548
+ // use host as a validator if needed
549
+ if (
550
+ this.compareAndUpdateFlags.compareSelfAndHost ||
551
+ this.compareAndUpdateFlags.compareHostAndSelf
552
+ ) {
553
+ this.compareSelfAndHost();
554
+ }
555
+ }
556
+
557
+ /**
558
+ * compared the self object to check if the user has host permissions
559
+ * @returns {undefined}
560
+ * @memberof LocusInfo
561
+ */
562
+ compareSelfAndHost() {
563
+ // In some cases the host info is not present but the moderator values changes from null to false so it triggers an update
564
+ if (
565
+ this.parsedLocus.self.selfIdentity === this.parsedLocus.host?.hostId &&
566
+ this.parsedLocus.self.moderator
567
+ ) {
568
+ this.emitScoped(
569
+ {
570
+ file: 'locus-info',
571
+ function: 'compareSelfAndHost',
572
+ },
573
+ EVENTS.LOCUS_INFO_CAN_ASSIGN_HOST,
574
+ {
575
+ canAssignHost: true,
576
+ }
577
+ );
578
+ } else {
579
+ this.emitScoped(
580
+ {
581
+ file: 'locus-info',
582
+ function: 'compareSelfAndHost',
583
+ },
584
+ EVENTS.LOCUS_INFO_CAN_ASSIGN_HOST,
585
+ {
586
+ canAssignHost: false,
587
+ }
588
+ );
589
+ }
590
+ }
591
+
592
+ /**
593
+ * Update the deltaParticipants property of this object based on a list of
594
+ * provided participants.
595
+ *
596
+ * @param {Array} [participants] - The participants to update against.
597
+ * @returns {void}
598
+ */
599
+ updateParticipantDeltas(participants: Array<any> = []) {
600
+ // Used to find a participant within a participants collection.
601
+ const findParticipant = (participant, collection) =>
602
+ collection.find((item) => item.person.id === participant.person.id);
603
+
604
+ // Generates an object that indicates which state properties have changed.
605
+ const generateDelta = (prevState: any = {}, newState: any = {}) => {
606
+ // Setup deltas.
607
+ const deltas = {
608
+ audioStatus: prevState.audioStatus !== newState.audioStatus,
609
+ videoSlidesStatus: prevState.videoSlidesStatus !== newState.videoSlidesStatus,
610
+ videoStatus: prevState.videoStatus !== newState.videoStatus,
611
+ };
612
+
613
+ // Clean the object
614
+ Object.keys(deltas).forEach((key) => {
615
+ if (deltas[key] !== true) {
616
+ delete deltas[key];
617
+ }
618
+ });
619
+
620
+ return deltas;
621
+ };
622
+
623
+ this.deltaParticipants = participants.reduce((collection, participant) => {
624
+ const existingParticipant = findParticipant(participant, this.participants || []) || {};
625
+
626
+ const delta = generateDelta(existingParticipant.status, participant.status);
627
+
628
+ const changed = Object.keys(delta).length > 0;
629
+
630
+ if (changed) {
631
+ collection.push({
632
+ person: participant.person,
633
+ delta,
634
+ });
635
+ }
636
+
637
+ return collection;
638
+ }, []);
639
+ }
640
+
641
+ /**
642
+ *
643
+ * @param {Object} participants new participants object
644
+ * @param {boolen} deltaParticpantFlag delta event
645
+ * @returns {Array} updatedParticipants
646
+ * @memberof LocusInfo
647
+ */
648
+ updateParticipants(participants: object) {
649
+ this.emitScoped(
650
+ {
651
+ file: 'locus-info',
652
+ function: 'updateParticipants',
653
+ },
654
+ EVENTS.LOCUS_INFO_UPDATE_PARTICIPANTS,
655
+ {
656
+ participants,
657
+ recordingId: this.parsedLocus.controls && this.parsedLocus.controls.record?.modifiedBy,
658
+ selfIdentity: this.parsedLocus.self && this.parsedLocus.self.selfIdentity,
659
+ selfId: this.parsedLocus.self && this.parsedLocus.self.selfId,
660
+ hostId: this.parsedLocus.host && this.parsedLocus.host.hostId,
661
+ }
662
+ );
663
+ }
664
+
665
+ /**
666
+ * @param {Object} controls
667
+ * @returns {undefined}
668
+ * @memberof LocusInfo
669
+ */
670
+ updateControls(controls: object) {
671
+ if (controls && !isEqual(this.controls, controls)) {
672
+ this.parsedLocus.controls = ControlsUtils.parse(controls);
673
+ const {
674
+ updates: {
675
+ hasRecordingChanged,
676
+ hasRecordingPausedChanged,
677
+ hasMeetingContainerChanged,
678
+ hasTranscribeChanged,
679
+ hasEntryExitToneChanged,
680
+ },
681
+ current,
682
+ } = ControlsUtils.getControls(this.controls, controls);
683
+
684
+ if (hasRecordingChanged || hasRecordingPausedChanged) {
685
+ let state = null;
686
+
687
+ if (hasRecordingPausedChanged) {
688
+ if (current.record.paused) {
689
+ state = RECORDING_STATE.PAUSED;
690
+ } else {
691
+ // state will be `IDLE` if the recording is not active, even when there is a `pause` status change.
692
+ state = current.record.recording ? RECORDING_STATE.RESUMED : RECORDING_STATE.IDLE;
693
+ }
694
+ } else if (hasRecordingChanged) {
695
+ state = current.record.recording ? RECORDING_STATE.RECORDING : RECORDING_STATE.IDLE;
696
+ }
697
+
698
+ this.emitScoped(
699
+ {
700
+ file: 'locus-info',
701
+ function: 'updateControls',
702
+ },
703
+ LOCUSINFO.EVENTS.CONTROLS_RECORDING_UPDATED,
704
+ {
705
+ state,
706
+ modifiedBy: current.record.modifiedBy,
707
+ lastModified: current.record.lastModified,
708
+ }
709
+ );
710
+ }
711
+
712
+ if (hasMeetingContainerChanged) {
713
+ const {meetingContainerUrl} = current.meetingContainer;
714
+
715
+ this.emitScoped(
716
+ {
717
+ file: 'locus-info',
718
+ function: 'updateControls',
719
+ },
720
+ LOCUSINFO.EVENTS.CONTROLS_MEETING_CONTAINER_UPDATED,
721
+ {
722
+ meetingContainerUrl,
723
+ }
724
+ );
725
+ }
726
+
727
+ if (hasTranscribeChanged) {
728
+ const {transcribing, caption} = current.transcribe;
729
+
730
+ this.emitScoped(
731
+ {
732
+ file: 'locus-info',
733
+ function: 'updateControls',
734
+ },
735
+ LOCUSINFO.EVENTS.CONTROLS_MEETING_TRANSCRIBE_UPDATED,
736
+ {
737
+ transcribing,
738
+ caption,
739
+ }
740
+ );
741
+ }
742
+
743
+ if (hasEntryExitToneChanged) {
744
+ const {entryExitTone} = current;
745
+
746
+ this.emitScoped(
747
+ {
748
+ file: 'locus-info',
749
+ function: 'updateControls',
750
+ },
751
+ LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED,
752
+ {
753
+ entryExitTone,
754
+ }
755
+ );
756
+
757
+ this.updateMeeting({entryExitTone});
758
+ }
759
+
760
+ this.controls = controls;
761
+ }
762
+ }
763
+
764
+ /**
765
+ * @param {String} conversationUrl
766
+ * @param {Object} info
767
+ * @returns {undefined}
768
+ * @memberof LocusInfo
769
+ */
770
+ updateConversationUrl(conversationUrl: string, info: any) {
771
+ if (conversationUrl && !isEqual(this.conversationUrl, conversationUrl)) {
772
+ this.conversationUrl = conversationUrl;
773
+ this.updateMeeting({conversationUrl});
774
+ } else if (
775
+ info &&
776
+ info.conversationUrl &&
777
+ !isEqual(this.conversationUrl, info.conversationUrl)
778
+ ) {
779
+ this.conversationUrl = info.conversationUrl;
780
+ this.updateMeeting({conversationUrl: info.conversationUrl});
781
+ }
782
+ }
783
+
784
+ /**
785
+ * @param {Object} created
786
+ * @returns {undefined}
787
+ * @memberof LocusInfo
788
+ */
789
+ updateCreated(created: object) {
790
+ if (created && !isEqual(this.created, created)) {
791
+ this.created = created;
792
+ }
793
+ }
794
+
795
+ /**
796
+ * @param {Object} services
797
+ * @returns {undefined}
798
+ * @memberof LocusInfo
799
+ */
800
+ updateServices(services: Record<'breakout' | 'record', {url: string}>) {
801
+ if (services && !isEqual(this.services, services)) {
802
+ this.services = services;
803
+ this.emitScoped(
804
+ {
805
+ file: 'locus-info',
806
+ function: 'updateServices',
807
+ },
808
+ LOCUSINFO.EVENTS.LINKS_SERVICES,
809
+ {
810
+ services,
811
+ }
812
+ );
813
+ }
814
+ }
815
+
816
+ /**
817
+ * @param {Object} fullState
818
+ * @returns {undefined}
819
+ * @memberof LocusInfo
820
+ */
821
+ updateFullState(fullState: object) {
822
+ if (fullState && !isEqual(this.fullState, fullState)) {
823
+ const result = FullState.getFullState(this.fullState, fullState);
824
+
825
+ this.updateMeeting(result.current);
826
+
827
+ if (result.updates.meetingStateChangedTo) {
828
+ this.emitScoped(
829
+ {
830
+ file: 'locus-info',
831
+ function: 'updateFullState',
832
+ },
833
+ LOCUSINFO.EVENTS.FULL_STATE_MEETING_STATE_CHANGE,
834
+ {
835
+ previousState: result.previous && result.previous.meetingState,
836
+ currentState: result.current.meetingState,
837
+ }
838
+ );
839
+ }
840
+
841
+ if (result.updates.meetingTypeChangedTo) {
842
+ this.emitScoped(
843
+ {
844
+ file: 'locus-info',
845
+ function: 'updateFullState',
846
+ },
847
+ LOCUSINFO.EVENTS.FULL_STATE_TYPE_UPDATE,
848
+ {
849
+ type: result.current.type,
850
+ }
851
+ );
852
+ }
853
+ this.parsedLocus.fullState = result.current;
854
+ this.fullState = fullState;
855
+ }
856
+ }
857
+
858
+ /**
859
+ * handles when the locus.host is updated
860
+ * @param {Object} host the locus.host property
861
+ * @returns {undefined}
862
+ * @memberof LocusInfo
863
+ * emits internal event locus_info_update_host
864
+ */
865
+ updateHostInfo(host: object) {
866
+ if (host && !isEqual(this.host, host)) {
867
+ const parsedHosts = HostUtils.getHosts(this.host, host);
868
+
869
+ this.updateMeeting(parsedHosts.current);
870
+ this.parsedLocus.host = parsedHosts.current;
871
+ if (parsedHosts.updates.isNewHost) {
872
+ this.compareAndUpdateFlags.compareSelfAndHost = true;
873
+ this.emitScoped(
874
+ {
875
+ file: 'locus-info',
876
+ function: 'updateHostInfo',
877
+ },
878
+ EVENTS.LOCUS_INFO_UPDATE_HOST,
879
+ {
880
+ newHost: parsedHosts.current,
881
+ oldHost: parsedHosts.previous,
882
+ }
883
+ );
884
+ }
885
+ this.host = host;
886
+ } else {
887
+ this.compareAndUpdateFlags.compareSelfAndHost = false;
888
+ }
889
+ }
890
+
891
+ /**
892
+ * @param {Object} info
893
+ * @param {Object} self
894
+ * @returns {undefined}
895
+ * @memberof LocusInfo
896
+ */
897
+ updateMeetingInfo(info: object, self?: object) {
898
+ if (info && !isEqual(this.info, info)) {
899
+ const roles = self ? SelfUtils.getRoles(self) : this.parsedLocus.self?.roles || [];
900
+ const isJoined = SelfUtils.isJoined(self || this.parsedLocus.self);
901
+ const parsedInfo = InfoUtils.getInfos(this.parsedLocus.info, info, roles, isJoined);
902
+
903
+ this.emitScoped(
904
+ {
905
+ file: 'locus-info',
906
+ function: 'updateMeetingInfo',
907
+ },
908
+ LOCUSINFO.EVENTS.MEETING_INFO_UPDATED,
909
+ {info: parsedInfo.current, self}
910
+ );
911
+
912
+ if (parsedInfo.updates.isLocked) {
913
+ this.emitScoped(
914
+ {
915
+ file: 'locus-info',
916
+ function: 'updateMeetingInfo',
917
+ },
918
+ LOCUSINFO.EVENTS.MEETING_LOCKED,
919
+ info
920
+ );
921
+ }
922
+ if (parsedInfo.updates.isUnlocked) {
923
+ this.emitScoped(
924
+ {
925
+ file: 'locus-info',
926
+ function: 'updateMeetingInfo',
927
+ },
928
+ LOCUSINFO.EVENTS.MEETING_UNLOCKED,
929
+ info
930
+ );
931
+ }
932
+
933
+ this.info = info;
934
+ this.parsedLocus.info = parsedInfo.current;
935
+ // Parses the info and adds necessary values
936
+ this.updateMeeting(parsedInfo.current);
937
+ }
938
+ }
939
+
940
+ /**
941
+ * @param {Object} embeddedApps
942
+ * @returns {undefined}
943
+ * @memberof LocusInfo
944
+ */
945
+ updateEmbeddedApps(embeddedApps: object) {
946
+ // don't do anything if the arrays of apps haven't changed significantly
947
+ if (EmbeddedAppsUtils.areSimilar(this.embeddedApps, embeddedApps)) {
948
+ return;
949
+ }
950
+
951
+ const parsedEmbeddedApps = EmbeddedAppsUtils.parse(embeddedApps);
952
+
953
+ this.updateMeeting({embeddedApps: parsedEmbeddedApps});
954
+
955
+ this.emitScoped(
956
+ {
957
+ file: 'locus-info',
958
+ function: 'updateEmbeddedApps',
959
+ },
960
+ LOCUSINFO.EVENTS.EMBEDDED_APPS_UPDATED,
961
+ parsedEmbeddedApps
962
+ );
963
+ this.embeddedApps = embeddedApps;
964
+ }
965
+
966
+ /**
967
+ * handles when the locus.mediaShares is updated
968
+ * @param {Object} mediaShares the locus.mediaShares property
969
+ * @returns {undefined}
970
+ * @memberof LocusInfo
971
+ * emits internal event locus_info_update_media_shares
972
+ */
973
+ updateMediaShares(mediaShares: object) {
974
+ if (mediaShares && !isEqual(this.mediaShares, mediaShares)) {
975
+ const parsedMediaShares = MediaSharesUtils.getMediaShares(this.mediaShares, mediaShares);
976
+
977
+ this.updateMeeting(parsedMediaShares.current);
978
+ this.emitScoped(
979
+ {
980
+ file: 'locus-info',
981
+ function: 'updateMediaShares',
982
+ },
983
+ EVENTS.LOCUS_INFO_UPDATE_MEDIA_SHARES,
984
+ {
985
+ current: parsedMediaShares.current,
986
+ previous: parsedMediaShares.previous,
987
+ }
988
+ );
989
+ this.parsedLocus.mediaShares = parsedMediaShares.current;
990
+ this.mediaShares = mediaShares;
991
+ }
992
+ }
993
+
994
+ /**
995
+ * @param {String} participantsUrl
996
+ * @returns {undefined}
997
+ * @memberof LocusInfo
998
+ */
999
+ updateParticipantsUrl(participantsUrl: string) {
1000
+ if (participantsUrl && !isEqual(this.participantsUrl, participantsUrl)) {
1001
+ this.participantsUrl = participantsUrl;
1002
+ }
1003
+ }
1004
+
1005
+ /**
1006
+ * @param {Object} replace
1007
+ * @returns {undefined}
1008
+ * @memberof LocusInfo
1009
+ */
1010
+ updateReplace(replace: object) {
1011
+ if (replace && !isEqual(this.replace, replace)) {
1012
+ this.replace = replace;
1013
+ }
1014
+ }
1015
+
1016
+ /**
1017
+ * handles when the locus.self is updated
1018
+ * @param {Object} self the locus.mediaShares property
1019
+ * @param {Array} participants the locus.participants property
1020
+ * @returns {undefined}
1021
+ * @memberof LocusInfo
1022
+ * emits internal events self_admitted_guest, self_unadmitted_guest, locus_info_update_self
1023
+ */
1024
+ updateSelf(self: any, participants: Array<any>) {
1025
+ // @ts-ignore - check where this.self come from
1026
+ if (self && !isEqual(this.self, self)) {
1027
+ // @ts-ignore
1028
+ const parsedSelves = SelfUtils.getSelves(this.self, self, this.webex.internal.device.url);
1029
+
1030
+ this.updateMeeting(parsedSelves.current);
1031
+ this.parsedLocus.self = parsedSelves.current;
1032
+
1033
+ const element = this.parsedLocus.states[this.parsedLocus.states.length - 1];
1034
+
1035
+ if (element !== parsedSelves.current.state) {
1036
+ this.parsedLocus.states.push(parsedSelves.current.state);
1037
+ }
1038
+
1039
+ // TODO: check if we need to save the sipUri here as well
1040
+ // this.emit(LOCUSINFO.EVENTS.MEETING_UPDATE, SelfUtils.getSipUrl(this.getLocusPartner(participants, self), this.parsedLocus.fullState.type, this.parsedLocus.info.sipUri));
1041
+ const result = SelfUtils.getSipUrl(
1042
+ this.getLocusPartner(participants, self),
1043
+ this.parsedLocus.fullState.type,
1044
+ this.parsedLocus.info.sipUri
1045
+ );
1046
+
1047
+ if (result.sipUri) {
1048
+ this.updateMeeting(result);
1049
+ }
1050
+
1051
+ if (parsedSelves.updates.moderatorChanged) {
1052
+ this.compareAndUpdateFlags.compareHostAndSelf = true;
1053
+ } else {
1054
+ this.compareAndUpdateFlags.compareHostAndSelf = false;
1055
+ }
1056
+
1057
+ if (parsedSelves.updates.layoutChanged) {
1058
+ this.emitScoped(
1059
+ {
1060
+ file: 'locus-info',
1061
+ function: 'updateSelf',
1062
+ },
1063
+ LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED,
1064
+ {layout: parsedSelves.current.layout}
1065
+ );
1066
+ }
1067
+
1068
+ if (parsedSelves.updates.isMediaInactiveOrReleased) {
1069
+ this.emitScoped(
1070
+ {
1071
+ file: 'locus-info',
1072
+ function: 'updateSelf',
1073
+ },
1074
+ LOCUSINFO.EVENTS.DISCONNECT_DUE_TO_INACTIVITY,
1075
+ {reason: self.reason}
1076
+ );
1077
+ }
1078
+
1079
+ if (parsedSelves.updates.moderatorChanged) {
1080
+ this.emitScoped(
1081
+ {
1082
+ file: 'locus-info',
1083
+ function: 'updateSelf',
1084
+ },
1085
+ LOCUSINFO.EVENTS.SELF_MODERATOR_CHANGED,
1086
+ self
1087
+ );
1088
+ }
1089
+ if (parsedSelves.updates.localAudioUnmuteRequiredByServer) {
1090
+ this.emitScoped(
1091
+ {
1092
+ file: 'locus-info',
1093
+ function: 'updateSelf',
1094
+ },
1095
+ LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUIRED,
1096
+ {
1097
+ muted: parsedSelves.current.remoteMuted,
1098
+ unmuteAllowed: parsedSelves.current.unmuteAllowed,
1099
+ }
1100
+ );
1101
+ }
1102
+ if (parsedSelves.updates.isMutedByOthersChanged) {
1103
+ this.emitScoped(
1104
+ {
1105
+ file: 'locus-info',
1106
+ function: 'updateSelf',
1107
+ },
1108
+ LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
1109
+ {
1110
+ muted: parsedSelves.current.remoteMuted,
1111
+ unmuteAllowed: parsedSelves.current.unmuteAllowed,
1112
+ }
1113
+ );
1114
+ }
1115
+ if (parsedSelves.updates.localAudioUnmuteRequestedByServer) {
1116
+ this.emitScoped(
1117
+ {
1118
+ file: 'locus-info',
1119
+ function: 'updateSelf',
1120
+ },
1121
+ LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUESTED,
1122
+ {}
1123
+ );
1124
+ }
1125
+ if (parsedSelves.updates.isUserUnadmitted) {
1126
+ this.emitScoped(
1127
+ {
1128
+ file: 'locus-info',
1129
+ function: 'updateSelf',
1130
+ },
1131
+ LOCUSINFO.EVENTS.SELF_UNADMITTED_GUEST,
1132
+ self
1133
+ );
1134
+ }
1135
+ if (parsedSelves.updates.isUserAdmitted) {
1136
+ this.emitScoped(
1137
+ {
1138
+ file: 'locus-info',
1139
+ function: 'updateSelf',
1140
+ },
1141
+ LOCUSINFO.EVENTS.SELF_ADMITTED_GUEST,
1142
+ self
1143
+ );
1144
+ }
1145
+
1146
+ if (parsedSelves.updates.isMediaInactive) {
1147
+ this.emitScoped(
1148
+ {
1149
+ file: 'locus-info',
1150
+ function: 'updateSelf',
1151
+ },
1152
+ // @ts-ignore
1153
+ LOCUSINFO.EVENTS.MEDIA_INACTIVITY,
1154
+ SelfUtils.getMediaStatus(self.mediaSessions)
1155
+ );
1156
+ }
1157
+
1158
+ if (
1159
+ parsedSelves.updates.audioStateChange ||
1160
+ parsedSelves.updates.videoStateChange ||
1161
+ parsedSelves.updates.shareStateChange
1162
+ ) {
1163
+ this.emitScoped(
1164
+ {
1165
+ file: 'locus-info',
1166
+ function: 'updateSelf',
1167
+ },
1168
+ LOCUSINFO.EVENTS.MEDIA_STATUS_CHANGE,
1169
+ {
1170
+ audioStatus: parsedSelves.current.currentMediaStatus?.audio,
1171
+ videoStatus: parsedSelves.current.currentMediaStatus?.video,
1172
+ shareStatus: parsedSelves.current.currentMediaStatus?.share,
1173
+ }
1174
+ );
1175
+ }
1176
+
1177
+ if (parsedSelves.updates.isUserObserving) {
1178
+ this.emitScoped(
1179
+ {
1180
+ file: 'locus-info',
1181
+ function: 'updateSelf',
1182
+ },
1183
+ LOCUSINFO.EVENTS.SELF_OBSERVING
1184
+ );
1185
+ }
1186
+
1187
+ if (parsedSelves.updates.canNotViewTheParticipantListChanged) {
1188
+ this.emitScoped(
1189
+ {
1190
+ file: 'locus-info',
1191
+ function: 'updateSelf',
1192
+ },
1193
+ LOCUSINFO.EVENTS.SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE,
1194
+ {canNotViewTheParticipantList: parsedSelves.current.canNotViewTheParticipantList}
1195
+ );
1196
+ }
1197
+
1198
+ if (parsedSelves.updates.isSharingBlockedChanged) {
1199
+ this.emitScoped(
1200
+ {
1201
+ file: 'locus-info',
1202
+ function: 'updateSelf',
1203
+ },
1204
+ LOCUSINFO.EVENTS.SELF_IS_SHARING_BLOCKED_CHANGE,
1205
+ {isSharingBlocked: parsedSelves.current.isSharingBlocked}
1206
+ );
1207
+ }
1208
+
1209
+ this.emitScoped(
1210
+ {
1211
+ file: 'locus-info',
1212
+ function: 'updateSelf',
1213
+ },
1214
+ EVENTS.LOCUS_INFO_UPDATE_SELF,
1215
+ {
1216
+ oldSelf: parsedSelves.previous,
1217
+ newSelf: parsedSelves.current,
1218
+ }
1219
+ );
1220
+ this.parsedLocus.self = parsedSelves.current;
1221
+ // @ts-ignore
1222
+ this.self = self;
1223
+ } else {
1224
+ this.compareAndUpdateFlags.compareHostAndSelf = false;
1225
+ }
1226
+ }
1227
+
1228
+ /**
1229
+ * handles when the locus.url is updated
1230
+ * @param {String} url
1231
+ * @returns {undefined}
1232
+ * emits internal event locus_info_update_url
1233
+ */
1234
+ updateLocusUrl(url: string) {
1235
+ if (url && this.url !== url) {
1236
+ this.url = url;
1237
+ this.updateMeeting({locusUrl: url});
1238
+ this.emitScoped(
1239
+ {
1240
+ file: 'locus-info',
1241
+ function: 'updateLocusUrl',
1242
+ },
1243
+ EVENTS.LOCUS_INFO_UPDATE_URL,
1244
+ url
1245
+ );
1246
+ }
1247
+ }
1248
+
1249
+ /**
1250
+ * @param {String} aclUrl
1251
+ * @returns {undefined}
1252
+ * @memberof LocusInfo
1253
+ */
1254
+ updateAclUrl(aclUrl: string) {
1255
+ if (aclUrl && !isEqual(this.aclUrl, aclUrl)) {
1256
+ this.aclUrl = aclUrl;
1257
+ }
1258
+ }
1259
+
1260
+ /**
1261
+ * @param {Number} baseSequence
1262
+ * @returns {undefined}
1263
+ * @memberof LocusInfo
1264
+ */
1265
+ updateBasequence(baseSequence: number) {
1266
+ if (baseSequence && !isEqual(this.baseSequence, baseSequence)) {
1267
+ this.baseSequence = baseSequence;
1268
+ }
1269
+ }
1270
+
1271
+ /**
1272
+ * @param {Number} sequence
1273
+ * @returns {undefined}
1274
+ * @memberof LocusInfo
1275
+ */
1276
+ updateSequence(sequence: number) {
1277
+ if (sequence && !isEqual(this.sequence, sequence)) {
1278
+ this.sequence = sequence;
1279
+ }
1280
+ }
1281
+
1282
+ /**
1283
+ * @param {Object} membership
1284
+ * @returns {undefined}
1285
+ * @memberof LocusInfo
1286
+ */
1287
+ updateMemberShip(membership: object) {
1288
+ if (membership && !isEqual(this.membership, membership)) {
1289
+ this.membership = membership;
1290
+ }
1291
+ }
1292
+
1293
+ /**
1294
+ * @param {Array} identities
1295
+ * @returns {undefined}
1296
+ * @memberof LocusInfo
1297
+ */
1298
+ updateIdentifiers(identities: Array<any>) {
1299
+ if (identities && !isEqual(this.identities, identities)) {
1300
+ this.identities = identities;
1301
+ }
1302
+ }
1303
+ }