@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,900 +1,900 @@
1
- /*!
2
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
3
- */
4
- import {isEmpty} from 'lodash';
5
- // @ts-ignore
6
- import {StatelessWebexPlugin} from '@webex/webex-core';
7
-
8
- import {MEETINGS, EVENT_TRIGGERS, FLOOR_ACTION, CONTENT, WHITEBOARD} from '../constants';
9
- import Trigger from '../common/events/trigger-proxy';
10
- import Member from '../member';
11
- import LoggerProxy from '../common/logs/logger-proxy';
12
- import ParameterError from '../common/errors/parameter';
13
-
14
- import MembersCollection from './collection';
15
- import MembersRequest from './request';
16
- import MembersUtil from './util';
17
-
18
- /**
19
- * Members Update Event
20
- * Emitted when something in the roster list needs to be updated
21
- * @event members:update
22
- * @instance
23
- * @property {Object} delta the changes to the members list
24
- * @property {Array} delta.updated array only the updates, includes removals, as they will have updated status and member properties
25
- * @property {Array} delta.added array added members to the meeting
26
- * @property {Array} full array the full members collection
27
- * @memberof Members
28
- */
29
-
30
- /**
31
- * Members Content Update Event
32
- * Emitted when who is sharing changes
33
- * @event members:content:update
34
- * @instance
35
- * @property {String} activeContentSharingId
36
- * @property {String} endedContentSharingId
37
- * @memberof Members
38
- */
39
-
40
- /**
41
- * Members Host Update Event
42
- * Emitted when who is the host changes
43
- * @event members:host:update
44
- * @instance
45
- * @property {String} activeHostId
46
- * @property {String} endedHostId
47
- * @memberof Members
48
- */
49
-
50
- /**
51
- * Members Self Update Event
52
- * Emitted when who is the self changes
53
- * @event members:self:update
54
- * @instance
55
- * @property {String} activeSelfId
56
- * @property {String} endedSelfId
57
- * @memberof Members
58
- */
59
-
60
- /**
61
- * @class Members
62
- */
63
- export default class Members extends StatelessWebexPlugin {
64
- hostId: any;
65
- locusUrl: any;
66
- mediaShareContentId: any;
67
- mediaShareWhiteboardId: any;
68
- membersCollection: any;
69
- membersRequest: any;
70
- recordingId: any;
71
- selfId: any;
72
- type: any;
73
-
74
- namespace = MEETINGS;
75
-
76
- /**
77
- *
78
- * @param {Object} attrs
79
- * @param {Object} options
80
- * @memberof Members
81
- */
82
- constructor(attrs: any, options: object) {
83
- super({}, options);
84
- /**
85
- * The Members Request object to interact with server
86
- * @instance
87
- * @type {MembersRequest}
88
- * @private
89
- * @memberof Members
90
- */
91
- // @ts-ignore
92
- this.membersRequest = new MembersRequest({}, options);
93
- /**
94
- * The Members Collection cache
95
- * @instance
96
- * @type {MembersCollection}
97
- * @private
98
- * @memberof Members
99
- */
100
- this.membersCollection = new MembersCollection();
101
- /**
102
- * The current locus url for the active meeting
103
- * @instance
104
- * @type {String}
105
- * @private
106
- * @memberof Members
107
- */
108
- this.locusUrl = attrs.locusUrl || null;
109
- /**
110
- * The current hostId for the meeting
111
- * @instance
112
- * @type {String}
113
- * @private
114
- * @memberof Members
115
- */
116
- this.hostId = null;
117
- /**
118
- * The current type for the meeting, could be MEETING or CALL
119
- * @instance
120
- * @type {String}
121
- * @private
122
- * @memberof Members
123
- */
124
- this.type = null;
125
- /**
126
- * Locus has a self object, sent individually to the client
127
- * i.e., each person in the call gets their own self object from locus.
128
- * We need to maintain that self object, because we also get information about all the participants
129
- * and differentiate those participants from self.
130
- * The self id shouldnt ever change, but it does have properties that will change
131
- * and we use values in locus-info, such as to determine if i am admitted to the meeting or not as guest.
132
- * The current selfId for the meeting
133
- * @instance
134
- * @type {String}
135
- * @private
136
- * @memberof Members
137
- */
138
- this.selfId = null;
139
- /**
140
- * The current mediaShareContentId for the meeting
141
- * @instance
142
- * @type {String}
143
- * @private
144
- * @memberof Members
145
- */
146
- this.mediaShareContentId = null;
147
- /**
148
- * The current mediaShareWhiteboardId for the meeting
149
- * @instance
150
- * @type {String}
151
- * @private
152
- * @memberof Members
153
- */
154
- this.mediaShareWhiteboardId = null;
155
- /**
156
- * The current recordingId for the meeting, if it exists
157
- * @instance
158
- * @type {String}
159
- * @private
160
- * @memberof Members
161
- */
162
- this.recordingId = null;
163
- }
164
-
165
- /**
166
- * Internal update the self Id value
167
- * @param {Object} payload
168
- * @param {Object} payload.newSelf
169
- * @param {Object} payload.oldSelf
170
- * @returns {undefined}
171
- * @private
172
- * @memberof Members
173
- */
174
- locusSelfUpdate(payload: {newSelf: any; oldSelf: any}) {
175
- let newSelfId = null;
176
- let oldSelfId = null;
177
-
178
- if (payload) {
179
- if (payload.newSelf) {
180
- newSelfId = payload.newSelf.id;
181
- }
182
- if (payload.oldSelf) {
183
- oldSelfId = payload.oldSelf.id;
184
- }
185
- }
186
- if (newSelfId) {
187
- const theSelf = this.membersCollection.get(newSelfId);
188
-
189
- if (theSelf) {
190
- theSelf.setIsSelf(true);
191
- }
192
- }
193
- if (oldSelfId) {
194
- const notSelf = this.membersCollection.get(oldSelfId);
195
-
196
- if (notSelf) {
197
- notSelf.setIsSelf(false);
198
- }
199
- }
200
- this.selfId = newSelfId;
201
- Trigger.trigger(
202
- this,
203
- {
204
- file: 'members',
205
- function: 'locusSelfUpdate',
206
- },
207
- EVENT_TRIGGERS.MEMBERS_SELF_UPDATE,
208
- {
209
- activeSelfId: newSelfId,
210
- endedSelfId: oldSelfId,
211
- }
212
- );
213
- }
214
-
215
- /**
216
- * Internal update the hostId value
217
- * @param {Object} payload
218
- * @param {Object} payload.newHost
219
- * @param {Object} payload.oldHost
220
- * @returns {undefined}
221
- * @private
222
- * @memberof Members
223
- */
224
- locusHostUpdate(payload: {newHost: any; oldHost: any}) {
225
- let newHostId = null;
226
- let oldHostId = null;
227
-
228
- if (payload) {
229
- if (payload.newHost) {
230
- newHostId = payload.newHost.id;
231
- }
232
- if (payload.oldHost) {
233
- oldHostId = payload.oldHost.id;
234
- }
235
- }
236
- if (newHostId) {
237
- const theHost = this.membersCollection.get(newHostId);
238
-
239
- if (theHost) {
240
- theHost.setIsHost(true);
241
- }
242
- }
243
- if (oldHostId) {
244
- const notHost = this.membersCollection.get(oldHostId);
245
-
246
- if (notHost) {
247
- notHost.setIsHost(false);
248
- }
249
- }
250
- this.hostId = newHostId;
251
- Trigger.trigger(
252
- this,
253
- {
254
- file: 'members',
255
- function: 'locusHostUpdate',
256
- },
257
- EVENT_TRIGGERS.MEMBERS_HOST_UPDATE,
258
- {
259
- activeHostId: newHostId,
260
- endedHostId: oldHostId,
261
- }
262
- );
263
- }
264
-
265
- /**
266
- * when new participant updates come in, both delta and full participants, update them in members collection
267
- * delta object in the event will have {updated, added} and full will be the full membersCollection
268
- * @param {Object} payload
269
- * @param {Object} payload.participants
270
- * @returns {undefined}
271
- * @private
272
- * @memberof Members
273
- */
274
- locusParticipantsUpdate(payload: {participants: object}) {
275
- if (payload) {
276
- const delta = this.handleLocusInfoUpdatedParticipants(payload);
277
- const full = this.handleMembersUpdate(delta); // SDK should propagate the full list for both delta and non delta updates
278
-
279
- Trigger.trigger(
280
- this,
281
- {
282
- file: 'members',
283
- function: 'locusParticipantsUpdate',
284
- },
285
- EVENT_TRIGGERS.MEMBERS_UPDATE,
286
- {
287
- delta,
288
- full,
289
- }
290
- );
291
- }
292
- }
293
-
294
- /**
295
- * Internal update the content id
296
- * @param {Object} payload
297
- * @param {Object} payload.current
298
- * @param {Object} payload.previous
299
- * @returns {undefined}
300
- * @private
301
- * @memberof Members
302
- */
303
- locusMediaSharesUpdate(payload: {current: any; previous: any}) {
304
- const currentContent = payload.current?.content;
305
- const previousContent = payload.previous?.content;
306
- const currentWhiteboard = payload.current?.whiteboard;
307
- const previousWhiteboard = payload.previous?.whiteboard;
308
- let whoSharing = null;
309
- let whoStopped = null;
310
-
311
- if (currentContent?.beneficiaryId) {
312
- if (currentContent.disposition === FLOOR_ACTION.GRANTED) {
313
- whoSharing = currentContent.beneficiaryId;
314
- this.mediaShareWhiteboardId = null;
315
- this.mediaShareContentId = whoSharing;
316
- }
317
-
318
- if (previousContent?.disposition === FLOOR_ACTION.GRANTED) {
319
- if (currentContent.disposition === FLOOR_ACTION.RELEASED) {
320
- whoStopped = currentContent.beneficiaryId;
321
- this.mediaShareContentId = null;
322
- } else if (
323
- currentContent.disposition === FLOOR_ACTION.GRANTED &&
324
- currentContent.beneficiaryId !== previousContent.beneficiaryId
325
- ) {
326
- whoStopped = previousContent.beneficiaryId;
327
- }
328
- }
329
- }
330
-
331
- if (currentWhiteboard?.beneficiaryId) {
332
- if (currentWhiteboard.disposition === FLOOR_ACTION.GRANTED) {
333
- whoSharing = currentWhiteboard.beneficiaryId;
334
- this.mediaShareContentId = null;
335
- this.mediaShareWhiteboardId = whoSharing;
336
- }
337
-
338
- if (previousWhiteboard?.disposition === FLOOR_ACTION.GRANTED) {
339
- if (currentWhiteboard.disposition === FLOOR_ACTION.RELEASED) {
340
- whoStopped = currentWhiteboard.beneficiaryId;
341
- this.mediaShareWhiteboardId = null;
342
- } else if (
343
- currentWhiteboard.disposition === FLOOR_ACTION.GRANTED &&
344
- currentWhiteboard.beneficiaryId !== previousWhiteboard.beneficiaryId
345
- ) {
346
- whoStopped = previousWhiteboard.beneficiaryId;
347
- }
348
- }
349
- }
350
-
351
- if (whoSharing) {
352
- const shareMember = this.membersCollection.get(whoSharing);
353
-
354
- if (shareMember) {
355
- shareMember.setIsContentSharing(true);
356
- }
357
- }
358
- if (whoStopped) {
359
- const stopMember = this.membersCollection.get(whoStopped);
360
-
361
- if (stopMember) {
362
- stopMember.setIsContentSharing(false);
363
- }
364
- }
365
-
366
- Trigger.trigger(
367
- this,
368
- {
369
- file: 'members',
370
- function: 'locusMediaSharesUpdate',
371
- },
372
- EVENT_TRIGGERS.MEMBERS_CONTENT_UPDATE,
373
- {
374
- activeSharingId: whoSharing,
375
- endedSharingId: whoStopped,
376
- }
377
- );
378
- }
379
-
380
- /**
381
- * Internal update the locus url value
382
- * @param {Object} payload
383
- * @param {String} payload.locusUrl
384
- * @returns {undefined}
385
- * @private
386
- * @memberof Members
387
- */
388
- locusUrlUpdate(payload: any) {
389
- if (payload) {
390
- this.setLocusUrl(null, payload);
391
- }
392
- }
393
-
394
- /**
395
- * Internal update the type of meeting
396
- * @param {Object} payload
397
- * @param {String} payload.type
398
- * @returns {undefined}
399
- * @private
400
- * @memberof Members
401
- */
402
- locusFullStateTypeUpdate(payload: {type: string}) {
403
- // TODO: at some point there could be a timing issue here, for updating each member
404
- // ie., if the type changes AND there is no locus update, then each member will not know the type of call
405
- // which means they cannot determine isMutable && isRemovable
406
- // for now this scenario is impossible to occur since we always get a locus update when the type changes
407
- // except for in delta locus meetings, but in that case, the type will always have been set differently
408
- // from the outset anyway
409
- if (payload) {
410
- this.setType(payload);
411
- }
412
- }
413
-
414
- /**
415
- * sets values in the members collection for updated and added properties from delta
416
- * @param {Object} membersUpdate {updated: [], added: []}
417
- * @returns {Object} membersCollection
418
- * @private
419
- * @memberof Members
420
- */
421
- private handleMembersUpdate(membersUpdate: any) {
422
- if (membersUpdate) {
423
- if (membersUpdate.updated) {
424
- this.constructMembers(membersUpdate.updated);
425
- }
426
- if (membersUpdate.added) {
427
- this.constructMembers(membersUpdate.added);
428
- }
429
- }
430
-
431
- return this.membersCollection.getAll();
432
- }
433
-
434
- /**
435
- * set members to the member collection from each updated/added lists as passed in
436
- * @param {Array} list
437
- * @returns {undefined}
438
- * @private
439
- * @memberof Members
440
- */
441
- private constructMembers(list: Array<any>) {
442
- list.forEach((member) => {
443
- this.membersCollection.set(member.id, member);
444
- });
445
- }
446
-
447
- /**
448
- * Internal update the participants value
449
- * @param {Object} payload
450
- * @returns {Object}
451
- * @private
452
- * @memberof Members
453
- */
454
- private handleLocusInfoUpdatedParticipants(payload: any) {
455
- this.hostId = payload.hostId || this.hostId;
456
- this.selfId = payload.selfId || this.selfId;
457
- this.recordingId = payload.recordingId;
458
- if (!payload.participants) {
459
- LoggerProxy.logger.warn(
460
- 'Members:index#handleLocusInfoUpdatedParticipants --> participants payload is missing.'
461
- );
462
- }
463
- const memberUpdate = this.update(payload.participants);
464
-
465
- return memberUpdate;
466
- }
467
-
468
- /**
469
- * Update the locus Url
470
- * @param {Object} locus
471
- * @param {String} [locusUrl] optional, takes precedence
472
- * @throws {ParameterError}
473
- * @returns {undefined}
474
- * @public
475
- * @memberof Members
476
- */
477
- public setLocusUrl(locus: any, locusUrl: string = null) {
478
- if (locusUrl) {
479
- this.locusUrl = locusUrl;
480
- } else if (locus && (locus.locusUrl || locus.url)) {
481
- this.locusUrl = locus.locusUrl || locus.url;
482
- } else {
483
- throw new ParameterError(
484
- 'Setting locusUrl for the Members module should be done with a locus object or locusUrl'
485
- );
486
- }
487
- }
488
-
489
- /**
490
- * Update the host id
491
- * @param {Object} locus
492
- * @param {String} [hostId] optional, takes precedence
493
- * @throws {ParameterError}
494
- * @returns {undefined}
495
- * @public
496
- * @memberof Members
497
- */
498
- public setHostId(locus: any, hostId: string = null) {
499
- if (hostId) {
500
- this.hostId = hostId;
501
- } else if (locus) {
502
- this.hostId = locus && locus.owner && locus.owner.info ? locus.owner.info : null;
503
- } else {
504
- throw new ParameterError(
505
- 'Setting hostid for the Members module should be done with a locus object or hostId'
506
- );
507
- }
508
- }
509
-
510
- /**
511
- * Update the type
512
- * @param {Object} fullState
513
- * @param {String} [type] optional, takes precedence
514
- * @throws {ParameterError}
515
- * @returns {undefined}
516
- * @public
517
- * @memberof Members
518
- */
519
- public setType(fullState: any, type: string = null) {
520
- if (type) {
521
- this.type = type;
522
- } else if (fullState) {
523
- this.type = (fullState && fullState.type) || null;
524
- } else {
525
- throw new ParameterError(
526
- 'Setting type for the Members module should be done with a fullstate object or type string'
527
- );
528
- }
529
- }
530
-
531
- /**
532
- * Update the self Id
533
- * @param {Object} locus
534
- * @param {String} [selfId] optional, takes precedence
535
- * @throws {Error}
536
- * @returns {undefined}
537
- * @memberof Members
538
- */
539
- setSelfId(locus: any, selfId: string = null) {
540
- if (selfId) {
541
- this.selfId = selfId;
542
- } else if (locus) {
543
- this.selfId =
544
- locus && locus.self && locus.self.person && locus.self.person.id
545
- ? locus.self.person.id
546
- : null;
547
- } else {
548
- throw new ParameterError(
549
- 'Setting selfid for the Members module should be done with a locus object or selfId'
550
- );
551
- }
552
- }
553
-
554
- /**
555
- * Update the media share content id
556
- * @param {Object} locus
557
- * @param {String} [contentId] optional, takes precedence
558
- * @throws {Error}
559
- * @returns {undefined}
560
- * @memberof Members
561
- */
562
- setMediaShareContentId(locus: any, contentId?: string) {
563
- if (contentId) {
564
- this.mediaShareContentId = contentId;
565
- } else if (locus) {
566
- const contentMediaShare =
567
- locus.mediaShares &&
568
- locus.mediaShares.length &&
569
- locus.mediaShares.find((mediaShare) => mediaShare.name === CONTENT);
570
-
571
- this.mediaShareContentId =
572
- (contentMediaShare &&
573
- contentMediaShare.floor &&
574
- contentMediaShare.floor.beneficiary &&
575
- contentMediaShare.floor.beneficiary.id) ||
576
- null;
577
- } else {
578
- throw new ParameterError(
579
- 'Setting hostid for the Members module should be done with a locus object or hostId'
580
- );
581
- }
582
- }
583
-
584
- /**
585
- * Update the media share whiteboard id
586
- * @param {Object} locus
587
- * @param {String} [whiteboardId] optional, takes precedence
588
- * @throws {Error}
589
- * @returns {undefined}
590
- * @memberof Members
591
- */
592
- setMediaShareWhiteboardId(locus: any, whiteboardId?: string) {
593
- if (whiteboardId) {
594
- this.mediaShareWhiteboardId = whiteboardId;
595
- } else if (locus) {
596
- const whiteboardMediaShare =
597
- locus.mediaShares &&
598
- locus.mediaShares.length &&
599
- locus.mediaShares.find((mediaShare) => mediaShare.name === WHITEBOARD);
600
-
601
- this.mediaShareWhiteboardId =
602
- (whiteboardMediaShare &&
603
- whiteboardMediaShare.floor &&
604
- whiteboardMediaShare.floor.beneficiary &&
605
- whiteboardMediaShare.floor.beneficiary.id) ||
606
- null;
607
- } else {
608
- throw new ParameterError(
609
- 'Setting hostid for the Members module should be done with a locus object or hostId'
610
- );
611
- }
612
- }
613
-
614
- /**
615
- * Find all the updates, and added members
616
- * Removed/left members will end up in updates
617
- * Each array contains only members
618
- * @param {Array} participants the locus participants
619
- * @returns {Object} {added: {Array}, updated: {Array}}
620
- * @private
621
- * @memberof Members
622
- */
623
- private update(participants: Array<any>) {
624
- const membersUpdate = {added: [], updated: []};
625
-
626
- if (participants) {
627
- participants.forEach((participant) => {
628
- if (participant.hideInRoster) {
629
- return;
630
- }
631
- const existing = this.membersCollection.get(participant.id);
632
-
633
- if (existing) {
634
- // TODO: compare existing member to new participant coming in properties and determine if updated (this helps for non delta events)
635
- // on client re renders, but we will have to determine what values to compare to determine difference, premature optimization
636
- membersUpdate.updated.push(
637
- new Member(participant, {
638
- recordingId: this.recordingId,
639
- selfId: this.selfId,
640
- hostId: this.hostId,
641
- contentSharingId: this.mediaShareContentId,
642
- whiteboardSharingId: this.mediaShareWhiteboardId,
643
- type: this.type,
644
- })
645
- );
646
- } else {
647
- membersUpdate.added.push(
648
- new Member(participant, {
649
- recordingId: this.recordingId,
650
- selfId: this.selfId,
651
- hostId: this.hostId,
652
- contentSharingId: this.mediaShareContentId,
653
- whiteboardSharingId: this.mediaShareWhiteboardId,
654
- type: this.type,
655
- })
656
- );
657
- }
658
- });
659
- }
660
-
661
- return membersUpdate;
662
- }
663
-
664
- /**
665
- * Adds a guest Member to the associated meeting
666
- * @param {String} invitee
667
- * @param {Boolean} [alertIfActive]
668
- * @returns {Promise}
669
- * @memberof Members
670
- */
671
- addMember(invitee: any, alertIfActive?: boolean) {
672
- if (!this.locusUrl) {
673
- return Promise.reject(
674
- new ParameterError('The associated locus url for this meeting object must be defined.')
675
- );
676
- }
677
- if (MembersUtil.isInvalidInvitee(invitee)) {
678
- return Promise.reject(
679
- new ParameterError(
680
- 'The invitee must be defined with either a valid email, emailAddress or phoneNumber property.'
681
- )
682
- );
683
- }
684
- const options = MembersUtil.generateAddMemberOptions(invitee, this.locusUrl, alertIfActive);
685
-
686
- return this.membersRequest.addMembers(options);
687
- }
688
-
689
- /**
690
- * Cancels an outgoing PSTN call to the associated meeting
691
- * @param {String} invitee
692
- * @returns {Promise}
693
- * @memberof Members
694
- */
695
- cancelPhoneInvite(invitee: any) {
696
- if (!this.locusUrl) {
697
- return Promise.reject(
698
- new ParameterError('The associated locus url for this meeting object must be defined.')
699
- );
700
- }
701
- if (MembersUtil.isInvalidInvitee(invitee)) {
702
- return Promise.reject(
703
- new ParameterError('The invitee must be defined with a valid phoneNumber property.')
704
- );
705
- }
706
- const options = MembersUtil.cancelPhoneInviteOptions(invitee, this.locusUrl);
707
-
708
- return this.membersRequest.cancelPhoneInvite(options);
709
- }
710
-
711
- /**
712
- * Admits waiting members (invited guests to meeting)
713
- * @param {Array} memberIds
714
- * @returns {Promise}
715
- * @public
716
- * @memberof Members
717
- */
718
- public admitMembers(memberIds: Array<any>) {
719
- if (isEmpty(memberIds)) {
720
- return Promise.reject(new ParameterError('No member ids provided to admit.'));
721
- }
722
- const options = MembersUtil.generateAdmitMemberOptions(memberIds, this.locusUrl);
723
-
724
- return this.membersRequest.admitMember(options);
725
- }
726
-
727
- /**
728
- * Removes a member from the meeting
729
- * @param {String} memberId
730
- * @returns {Promise}
731
- * @public
732
- * @memberof Members
733
- */
734
- public removeMember(memberId: string) {
735
- if (!this.locusUrl) {
736
- return Promise.reject(
737
- new ParameterError('The associated locus url for this meeting object must be defined.')
738
- );
739
- }
740
- if (!memberId) {
741
- return Promise.reject(
742
- new ParameterError('The member id must be defined to remove the member.')
743
- );
744
- }
745
- const options = MembersUtil.generateRemoveMemberOptions(memberId, this.locusUrl);
746
-
747
- return this.membersRequest.removeMember(options);
748
- }
749
-
750
- /**
751
- * Audio mutes another member in a meeting
752
- * @param {String} memberId
753
- * @param {boolean} [mute] default true
754
- * @returns {Promise}
755
- * @public
756
- * @memberof Members
757
- */
758
- public muteMember(memberId: string, mute = true) {
759
- if (!this.locusUrl) {
760
- return Promise.reject(
761
- new ParameterError(
762
- 'The associated locus url for this meetings members object must be defined.'
763
- )
764
- );
765
- }
766
- if (!memberId) {
767
- return Promise.reject(
768
- new ParameterError('The member id must be defined to mute the member.')
769
- );
770
- }
771
- const options = MembersUtil.generateMuteMemberOptions(memberId, mute, this.locusUrl);
772
-
773
- return this.membersRequest.muteMember(options);
774
- }
775
-
776
- /**
777
- * Raise or lower the hand of a member in a meeting
778
- * @param {String} memberId
779
- * @param {boolean} [raise] - to raise hand (=true) or lower (=false), default: true
780
- * @returns {Promise}
781
- * @public
782
- * @memberof Members
783
- */
784
- public raiseOrLowerHand(memberId: string, raise = true) {
785
- if (!this.locusUrl) {
786
- return Promise.reject(
787
- new ParameterError(
788
- 'The associated locus url for this meetings members object must be defined.'
789
- )
790
- );
791
- }
792
- if (!memberId) {
793
- return Promise.reject(
794
- new ParameterError('The member id must be defined to raise/lower the hand of the member.')
795
- );
796
- }
797
- const options = MembersUtil.generateRaiseHandMemberOptions(memberId, raise, this.locusUrl);
798
-
799
- return this.membersRequest.raiseOrLowerHandMember(options);
800
- }
801
-
802
- /**
803
- * Lower all hands of members in a meeting
804
- * @param {String} requestingMemberId - id of the participant which requested the lower all hands
805
- * @returns {Promise}
806
- * @public
807
- * @memberof Members
808
- */
809
- public lowerAllHands(requestingMemberId: string) {
810
- if (!this.locusUrl) {
811
- return Promise.reject(
812
- new ParameterError(
813
- 'The associated locus url for this meetings members object must be defined.'
814
- )
815
- );
816
- }
817
- if (!requestingMemberId) {
818
- return Promise.reject(
819
- new ParameterError(
820
- 'The requestingMemberId must be defined to lower all hands in a meeting.'
821
- )
822
- );
823
- }
824
- const options = MembersUtil.generateLowerAllHandsMemberOptions(
825
- requestingMemberId,
826
- this.locusUrl
827
- );
828
-
829
- return this.membersRequest.lowerAllHandsMember(options);
830
- }
831
-
832
- /**
833
- * Transfers the host to another member
834
- * @param {String} memberId
835
- * @param {boolean} [moderator] default true
836
- * @returns {Promise}
837
- * @public
838
- * @memberof Members
839
- */
840
- public transferHostToMember(memberId: string, moderator = true) {
841
- if (!this.locusUrl) {
842
- return Promise.reject(
843
- new ParameterError(
844
- 'The associated locus url for this meetings members object must be defined.'
845
- )
846
- );
847
- }
848
- if (!memberId) {
849
- return Promise.reject(
850
- new ParameterError('The member id must be defined to transfer host to the member.')
851
- );
852
- }
853
- const options = MembersUtil.generateTransferHostMemberOptions(
854
- memberId,
855
- moderator,
856
- this.locusUrl
857
- );
858
-
859
- return this.membersRequest.transferHostToMember(options);
860
- }
861
-
862
- /**
863
- * Sends DTMF tones for the PSTN member of a meeting
864
- * @param {String} tones a string of one or more DTMF tones to send
865
- * @param {String} memberId member id
866
- * @returns {Promise}
867
- * @public
868
- * @memberof Members
869
- */
870
- public sendDialPadKey(tones = '', memberId = '') {
871
- // @ts-ignore
872
- if (!tones && tones !== 0) {
873
- return Promise.reject(new ParameterError('DMTF tones must be passed in'));
874
- }
875
-
876
- const member = this.membersCollection.get(memberId);
877
-
878
- if (!member) {
879
- return Promise.reject(new ParameterError('there is no member associated with that Id'));
880
- }
881
-
882
- const {locusUrl} = this;
883
-
884
- const deviceArray = member.participant.devices;
885
- const device = deviceArray.find(({deviceType}) => deviceType === 'SIP');
886
- const url = device?.url;
887
-
888
- if (locusUrl && url) {
889
- const options = MembersUtil.genderateSendDTMFOptions(url, tones, memberId, locusUrl);
890
-
891
- return this.membersRequest.sendDialPadKey(options);
892
- }
893
-
894
- return Promise.reject(
895
- new Error(
896
- 'Members:index#sendDialPadKey --> cannot send DTMF, meeting does not have a connection to the "locus" call control service.'
897
- )
898
- );
899
- }
900
- }
1
+ /*!
2
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
3
+ */
4
+ import {isEmpty} from 'lodash';
5
+ // @ts-ignore
6
+ import {StatelessWebexPlugin} from '@webex/webex-core';
7
+
8
+ import {MEETINGS, EVENT_TRIGGERS, FLOOR_ACTION, CONTENT, WHITEBOARD} from '../constants';
9
+ import Trigger from '../common/events/trigger-proxy';
10
+ import Member from '../member';
11
+ import LoggerProxy from '../common/logs/logger-proxy';
12
+ import ParameterError from '../common/errors/parameter';
13
+
14
+ import MembersCollection from './collection';
15
+ import MembersRequest from './request';
16
+ import MembersUtil from './util';
17
+
18
+ /**
19
+ * Members Update Event
20
+ * Emitted when something in the roster list needs to be updated
21
+ * @event members:update
22
+ * @instance
23
+ * @property {Object} delta the changes to the members list
24
+ * @property {Array} delta.updated array only the updates, includes removals, as they will have updated status and member properties
25
+ * @property {Array} delta.added array added members to the meeting
26
+ * @property {Array} full array the full members collection
27
+ * @memberof Members
28
+ */
29
+
30
+ /**
31
+ * Members Content Update Event
32
+ * Emitted when who is sharing changes
33
+ * @event members:content:update
34
+ * @instance
35
+ * @property {String} activeContentSharingId
36
+ * @property {String} endedContentSharingId
37
+ * @memberof Members
38
+ */
39
+
40
+ /**
41
+ * Members Host Update Event
42
+ * Emitted when who is the host changes
43
+ * @event members:host:update
44
+ * @instance
45
+ * @property {String} activeHostId
46
+ * @property {String} endedHostId
47
+ * @memberof Members
48
+ */
49
+
50
+ /**
51
+ * Members Self Update Event
52
+ * Emitted when who is the self changes
53
+ * @event members:self:update
54
+ * @instance
55
+ * @property {String} activeSelfId
56
+ * @property {String} endedSelfId
57
+ * @memberof Members
58
+ */
59
+
60
+ /**
61
+ * @class Members
62
+ */
63
+ export default class Members extends StatelessWebexPlugin {
64
+ hostId: any;
65
+ locusUrl: any;
66
+ mediaShareContentId: any;
67
+ mediaShareWhiteboardId: any;
68
+ membersCollection: any;
69
+ membersRequest: any;
70
+ recordingId: any;
71
+ selfId: any;
72
+ type: any;
73
+
74
+ namespace = MEETINGS;
75
+
76
+ /**
77
+ *
78
+ * @param {Object} attrs
79
+ * @param {Object} options
80
+ * @memberof Members
81
+ */
82
+ constructor(attrs: any, options: object) {
83
+ super({}, options);
84
+ /**
85
+ * The Members Request object to interact with server
86
+ * @instance
87
+ * @type {MembersRequest}
88
+ * @private
89
+ * @memberof Members
90
+ */
91
+ // @ts-ignore
92
+ this.membersRequest = new MembersRequest({}, options);
93
+ /**
94
+ * The Members Collection cache
95
+ * @instance
96
+ * @type {MembersCollection}
97
+ * @private
98
+ * @memberof Members
99
+ */
100
+ this.membersCollection = new MembersCollection();
101
+ /**
102
+ * The current locus url for the active meeting
103
+ * @instance
104
+ * @type {String}
105
+ * @private
106
+ * @memberof Members
107
+ */
108
+ this.locusUrl = attrs.locusUrl || null;
109
+ /**
110
+ * The current hostId for the meeting
111
+ * @instance
112
+ * @type {String}
113
+ * @private
114
+ * @memberof Members
115
+ */
116
+ this.hostId = null;
117
+ /**
118
+ * The current type for the meeting, could be MEETING or CALL
119
+ * @instance
120
+ * @type {String}
121
+ * @private
122
+ * @memberof Members
123
+ */
124
+ this.type = null;
125
+ /**
126
+ * Locus has a self object, sent individually to the client
127
+ * i.e., each person in the call gets their own self object from locus.
128
+ * We need to maintain that self object, because we also get information about all the participants
129
+ * and differentiate those participants from self.
130
+ * The self id shouldnt ever change, but it does have properties that will change
131
+ * and we use values in locus-info, such as to determine if i am admitted to the meeting or not as guest.
132
+ * The current selfId for the meeting
133
+ * @instance
134
+ * @type {String}
135
+ * @private
136
+ * @memberof Members
137
+ */
138
+ this.selfId = null;
139
+ /**
140
+ * The current mediaShareContentId for the meeting
141
+ * @instance
142
+ * @type {String}
143
+ * @private
144
+ * @memberof Members
145
+ */
146
+ this.mediaShareContentId = null;
147
+ /**
148
+ * The current mediaShareWhiteboardId for the meeting
149
+ * @instance
150
+ * @type {String}
151
+ * @private
152
+ * @memberof Members
153
+ */
154
+ this.mediaShareWhiteboardId = null;
155
+ /**
156
+ * The current recordingId for the meeting, if it exists
157
+ * @instance
158
+ * @type {String}
159
+ * @private
160
+ * @memberof Members
161
+ */
162
+ this.recordingId = null;
163
+ }
164
+
165
+ /**
166
+ * Internal update the self Id value
167
+ * @param {Object} payload
168
+ * @param {Object} payload.newSelf
169
+ * @param {Object} payload.oldSelf
170
+ * @returns {undefined}
171
+ * @private
172
+ * @memberof Members
173
+ */
174
+ locusSelfUpdate(payload: {newSelf: any; oldSelf: any}) {
175
+ let newSelfId = null;
176
+ let oldSelfId = null;
177
+
178
+ if (payload) {
179
+ if (payload.newSelf) {
180
+ newSelfId = payload.newSelf.id;
181
+ }
182
+ if (payload.oldSelf) {
183
+ oldSelfId = payload.oldSelf.id;
184
+ }
185
+ }
186
+ if (newSelfId) {
187
+ const theSelf = this.membersCollection.get(newSelfId);
188
+
189
+ if (theSelf) {
190
+ theSelf.setIsSelf(true);
191
+ }
192
+ }
193
+ if (oldSelfId) {
194
+ const notSelf = this.membersCollection.get(oldSelfId);
195
+
196
+ if (notSelf) {
197
+ notSelf.setIsSelf(false);
198
+ }
199
+ }
200
+ this.selfId = newSelfId;
201
+ Trigger.trigger(
202
+ this,
203
+ {
204
+ file: 'members',
205
+ function: 'locusSelfUpdate',
206
+ },
207
+ EVENT_TRIGGERS.MEMBERS_SELF_UPDATE,
208
+ {
209
+ activeSelfId: newSelfId,
210
+ endedSelfId: oldSelfId,
211
+ }
212
+ );
213
+ }
214
+
215
+ /**
216
+ * Internal update the hostId value
217
+ * @param {Object} payload
218
+ * @param {Object} payload.newHost
219
+ * @param {Object} payload.oldHost
220
+ * @returns {undefined}
221
+ * @private
222
+ * @memberof Members
223
+ */
224
+ locusHostUpdate(payload: {newHost: any; oldHost: any}) {
225
+ let newHostId = null;
226
+ let oldHostId = null;
227
+
228
+ if (payload) {
229
+ if (payload.newHost) {
230
+ newHostId = payload.newHost.id;
231
+ }
232
+ if (payload.oldHost) {
233
+ oldHostId = payload.oldHost.id;
234
+ }
235
+ }
236
+ if (newHostId) {
237
+ const theHost = this.membersCollection.get(newHostId);
238
+
239
+ if (theHost) {
240
+ theHost.setIsHost(true);
241
+ }
242
+ }
243
+ if (oldHostId) {
244
+ const notHost = this.membersCollection.get(oldHostId);
245
+
246
+ if (notHost) {
247
+ notHost.setIsHost(false);
248
+ }
249
+ }
250
+ this.hostId = newHostId;
251
+ Trigger.trigger(
252
+ this,
253
+ {
254
+ file: 'members',
255
+ function: 'locusHostUpdate',
256
+ },
257
+ EVENT_TRIGGERS.MEMBERS_HOST_UPDATE,
258
+ {
259
+ activeHostId: newHostId,
260
+ endedHostId: oldHostId,
261
+ }
262
+ );
263
+ }
264
+
265
+ /**
266
+ * when new participant updates come in, both delta and full participants, update them in members collection
267
+ * delta object in the event will have {updated, added} and full will be the full membersCollection
268
+ * @param {Object} payload
269
+ * @param {Object} payload.participants
270
+ * @returns {undefined}
271
+ * @private
272
+ * @memberof Members
273
+ */
274
+ locusParticipantsUpdate(payload: {participants: object}) {
275
+ if (payload) {
276
+ const delta = this.handleLocusInfoUpdatedParticipants(payload);
277
+ const full = this.handleMembersUpdate(delta); // SDK should propagate the full list for both delta and non delta updates
278
+
279
+ Trigger.trigger(
280
+ this,
281
+ {
282
+ file: 'members',
283
+ function: 'locusParticipantsUpdate',
284
+ },
285
+ EVENT_TRIGGERS.MEMBERS_UPDATE,
286
+ {
287
+ delta,
288
+ full,
289
+ }
290
+ );
291
+ }
292
+ }
293
+
294
+ /**
295
+ * Internal update the content id
296
+ * @param {Object} payload
297
+ * @param {Object} payload.current
298
+ * @param {Object} payload.previous
299
+ * @returns {undefined}
300
+ * @private
301
+ * @memberof Members
302
+ */
303
+ locusMediaSharesUpdate(payload: {current: any; previous: any}) {
304
+ const currentContent = payload.current?.content;
305
+ const previousContent = payload.previous?.content;
306
+ const currentWhiteboard = payload.current?.whiteboard;
307
+ const previousWhiteboard = payload.previous?.whiteboard;
308
+ let whoSharing = null;
309
+ let whoStopped = null;
310
+
311
+ if (currentContent?.beneficiaryId) {
312
+ if (currentContent.disposition === FLOOR_ACTION.GRANTED) {
313
+ whoSharing = currentContent.beneficiaryId;
314
+ this.mediaShareWhiteboardId = null;
315
+ this.mediaShareContentId = whoSharing;
316
+ }
317
+
318
+ if (previousContent?.disposition === FLOOR_ACTION.GRANTED) {
319
+ if (currentContent.disposition === FLOOR_ACTION.RELEASED) {
320
+ whoStopped = currentContent.beneficiaryId;
321
+ this.mediaShareContentId = null;
322
+ } else if (
323
+ currentContent.disposition === FLOOR_ACTION.GRANTED &&
324
+ currentContent.beneficiaryId !== previousContent.beneficiaryId
325
+ ) {
326
+ whoStopped = previousContent.beneficiaryId;
327
+ }
328
+ }
329
+ }
330
+
331
+ if (currentWhiteboard?.beneficiaryId) {
332
+ if (currentWhiteboard.disposition === FLOOR_ACTION.GRANTED) {
333
+ whoSharing = currentWhiteboard.beneficiaryId;
334
+ this.mediaShareContentId = null;
335
+ this.mediaShareWhiteboardId = whoSharing;
336
+ }
337
+
338
+ if (previousWhiteboard?.disposition === FLOOR_ACTION.GRANTED) {
339
+ if (currentWhiteboard.disposition === FLOOR_ACTION.RELEASED) {
340
+ whoStopped = currentWhiteboard.beneficiaryId;
341
+ this.mediaShareWhiteboardId = null;
342
+ } else if (
343
+ currentWhiteboard.disposition === FLOOR_ACTION.GRANTED &&
344
+ currentWhiteboard.beneficiaryId !== previousWhiteboard.beneficiaryId
345
+ ) {
346
+ whoStopped = previousWhiteboard.beneficiaryId;
347
+ }
348
+ }
349
+ }
350
+
351
+ if (whoSharing) {
352
+ const shareMember = this.membersCollection.get(whoSharing);
353
+
354
+ if (shareMember) {
355
+ shareMember.setIsContentSharing(true);
356
+ }
357
+ }
358
+ if (whoStopped) {
359
+ const stopMember = this.membersCollection.get(whoStopped);
360
+
361
+ if (stopMember) {
362
+ stopMember.setIsContentSharing(false);
363
+ }
364
+ }
365
+
366
+ Trigger.trigger(
367
+ this,
368
+ {
369
+ file: 'members',
370
+ function: 'locusMediaSharesUpdate',
371
+ },
372
+ EVENT_TRIGGERS.MEMBERS_CONTENT_UPDATE,
373
+ {
374
+ activeSharingId: whoSharing,
375
+ endedSharingId: whoStopped,
376
+ }
377
+ );
378
+ }
379
+
380
+ /**
381
+ * Internal update the locus url value
382
+ * @param {Object} payload
383
+ * @param {String} payload.locusUrl
384
+ * @returns {undefined}
385
+ * @private
386
+ * @memberof Members
387
+ */
388
+ locusUrlUpdate(payload: any) {
389
+ if (payload) {
390
+ this.setLocusUrl(null, payload);
391
+ }
392
+ }
393
+
394
+ /**
395
+ * Internal update the type of meeting
396
+ * @param {Object} payload
397
+ * @param {String} payload.type
398
+ * @returns {undefined}
399
+ * @private
400
+ * @memberof Members
401
+ */
402
+ locusFullStateTypeUpdate(payload: {type: string}) {
403
+ // TODO: at some point there could be a timing issue here, for updating each member
404
+ // ie., if the type changes AND there is no locus update, then each member will not know the type of call
405
+ // which means they cannot determine isMutable && isRemovable
406
+ // for now this scenario is impossible to occur since we always get a locus update when the type changes
407
+ // except for in delta locus meetings, but in that case, the type will always have been set differently
408
+ // from the outset anyway
409
+ if (payload) {
410
+ this.setType(payload);
411
+ }
412
+ }
413
+
414
+ /**
415
+ * sets values in the members collection for updated and added properties from delta
416
+ * @param {Object} membersUpdate {updated: [], added: []}
417
+ * @returns {Object} membersCollection
418
+ * @private
419
+ * @memberof Members
420
+ */
421
+ private handleMembersUpdate(membersUpdate: any) {
422
+ if (membersUpdate) {
423
+ if (membersUpdate.updated) {
424
+ this.constructMembers(membersUpdate.updated);
425
+ }
426
+ if (membersUpdate.added) {
427
+ this.constructMembers(membersUpdate.added);
428
+ }
429
+ }
430
+
431
+ return this.membersCollection.getAll();
432
+ }
433
+
434
+ /**
435
+ * set members to the member collection from each updated/added lists as passed in
436
+ * @param {Array} list
437
+ * @returns {undefined}
438
+ * @private
439
+ * @memberof Members
440
+ */
441
+ private constructMembers(list: Array<any>) {
442
+ list.forEach((member) => {
443
+ this.membersCollection.set(member.id, member);
444
+ });
445
+ }
446
+
447
+ /**
448
+ * Internal update the participants value
449
+ * @param {Object} payload
450
+ * @returns {Object}
451
+ * @private
452
+ * @memberof Members
453
+ */
454
+ private handleLocusInfoUpdatedParticipants(payload: any) {
455
+ this.hostId = payload.hostId || this.hostId;
456
+ this.selfId = payload.selfId || this.selfId;
457
+ this.recordingId = payload.recordingId;
458
+ if (!payload.participants) {
459
+ LoggerProxy.logger.warn(
460
+ 'Members:index#handleLocusInfoUpdatedParticipants --> participants payload is missing.'
461
+ );
462
+ }
463
+ const memberUpdate = this.update(payload.participants);
464
+
465
+ return memberUpdate;
466
+ }
467
+
468
+ /**
469
+ * Update the locus Url
470
+ * @param {Object} locus
471
+ * @param {String} [locusUrl] optional, takes precedence
472
+ * @throws {ParameterError}
473
+ * @returns {undefined}
474
+ * @public
475
+ * @memberof Members
476
+ */
477
+ public setLocusUrl(locus: any, locusUrl: string = null) {
478
+ if (locusUrl) {
479
+ this.locusUrl = locusUrl;
480
+ } else if (locus && (locus.locusUrl || locus.url)) {
481
+ this.locusUrl = locus.locusUrl || locus.url;
482
+ } else {
483
+ throw new ParameterError(
484
+ 'Setting locusUrl for the Members module should be done with a locus object or locusUrl'
485
+ );
486
+ }
487
+ }
488
+
489
+ /**
490
+ * Update the host id
491
+ * @param {Object} locus
492
+ * @param {String} [hostId] optional, takes precedence
493
+ * @throws {ParameterError}
494
+ * @returns {undefined}
495
+ * @public
496
+ * @memberof Members
497
+ */
498
+ public setHostId(locus: any, hostId: string = null) {
499
+ if (hostId) {
500
+ this.hostId = hostId;
501
+ } else if (locus) {
502
+ this.hostId = locus && locus.owner && locus.owner.info ? locus.owner.info : null;
503
+ } else {
504
+ throw new ParameterError(
505
+ 'Setting hostid for the Members module should be done with a locus object or hostId'
506
+ );
507
+ }
508
+ }
509
+
510
+ /**
511
+ * Update the type
512
+ * @param {Object} fullState
513
+ * @param {String} [type] optional, takes precedence
514
+ * @throws {ParameterError}
515
+ * @returns {undefined}
516
+ * @public
517
+ * @memberof Members
518
+ */
519
+ public setType(fullState: any, type: string = null) {
520
+ if (type) {
521
+ this.type = type;
522
+ } else if (fullState) {
523
+ this.type = (fullState && fullState.type) || null;
524
+ } else {
525
+ throw new ParameterError(
526
+ 'Setting type for the Members module should be done with a fullstate object or type string'
527
+ );
528
+ }
529
+ }
530
+
531
+ /**
532
+ * Update the self Id
533
+ * @param {Object} locus
534
+ * @param {String} [selfId] optional, takes precedence
535
+ * @throws {Error}
536
+ * @returns {undefined}
537
+ * @memberof Members
538
+ */
539
+ setSelfId(locus: any, selfId: string = null) {
540
+ if (selfId) {
541
+ this.selfId = selfId;
542
+ } else if (locus) {
543
+ this.selfId =
544
+ locus && locus.self && locus.self.person && locus.self.person.id
545
+ ? locus.self.person.id
546
+ : null;
547
+ } else {
548
+ throw new ParameterError(
549
+ 'Setting selfid for the Members module should be done with a locus object or selfId'
550
+ );
551
+ }
552
+ }
553
+
554
+ /**
555
+ * Update the media share content id
556
+ * @param {Object} locus
557
+ * @param {String} [contentId] optional, takes precedence
558
+ * @throws {Error}
559
+ * @returns {undefined}
560
+ * @memberof Members
561
+ */
562
+ setMediaShareContentId(locus: any, contentId?: string) {
563
+ if (contentId) {
564
+ this.mediaShareContentId = contentId;
565
+ } else if (locus) {
566
+ const contentMediaShare =
567
+ locus.mediaShares &&
568
+ locus.mediaShares.length &&
569
+ locus.mediaShares.find((mediaShare) => mediaShare.name === CONTENT);
570
+
571
+ this.mediaShareContentId =
572
+ (contentMediaShare &&
573
+ contentMediaShare.floor &&
574
+ contentMediaShare.floor.beneficiary &&
575
+ contentMediaShare.floor.beneficiary.id) ||
576
+ null;
577
+ } else {
578
+ throw new ParameterError(
579
+ 'Setting hostid for the Members module should be done with a locus object or hostId'
580
+ );
581
+ }
582
+ }
583
+
584
+ /**
585
+ * Update the media share whiteboard id
586
+ * @param {Object} locus
587
+ * @param {String} [whiteboardId] optional, takes precedence
588
+ * @throws {Error}
589
+ * @returns {undefined}
590
+ * @memberof Members
591
+ */
592
+ setMediaShareWhiteboardId(locus: any, whiteboardId?: string) {
593
+ if (whiteboardId) {
594
+ this.mediaShareWhiteboardId = whiteboardId;
595
+ } else if (locus) {
596
+ const whiteboardMediaShare =
597
+ locus.mediaShares &&
598
+ locus.mediaShares.length &&
599
+ locus.mediaShares.find((mediaShare) => mediaShare.name === WHITEBOARD);
600
+
601
+ this.mediaShareWhiteboardId =
602
+ (whiteboardMediaShare &&
603
+ whiteboardMediaShare.floor &&
604
+ whiteboardMediaShare.floor.beneficiary &&
605
+ whiteboardMediaShare.floor.beneficiary.id) ||
606
+ null;
607
+ } else {
608
+ throw new ParameterError(
609
+ 'Setting hostid for the Members module should be done with a locus object or hostId'
610
+ );
611
+ }
612
+ }
613
+
614
+ /**
615
+ * Find all the updates, and added members
616
+ * Removed/left members will end up in updates
617
+ * Each array contains only members
618
+ * @param {Array} participants the locus participants
619
+ * @returns {Object} {added: {Array}, updated: {Array}}
620
+ * @private
621
+ * @memberof Members
622
+ */
623
+ private update(participants: Array<any>) {
624
+ const membersUpdate = {added: [], updated: []};
625
+
626
+ if (participants) {
627
+ participants.forEach((participant) => {
628
+ if (participant.hideInRoster) {
629
+ return;
630
+ }
631
+ const existing = this.membersCollection.get(participant.id);
632
+
633
+ if (existing) {
634
+ // TODO: compare existing member to new participant coming in properties and determine if updated (this helps for non delta events)
635
+ // on client re renders, but we will have to determine what values to compare to determine difference, premature optimization
636
+ membersUpdate.updated.push(
637
+ new Member(participant, {
638
+ recordingId: this.recordingId,
639
+ selfId: this.selfId,
640
+ hostId: this.hostId,
641
+ contentSharingId: this.mediaShareContentId,
642
+ whiteboardSharingId: this.mediaShareWhiteboardId,
643
+ type: this.type,
644
+ })
645
+ );
646
+ } else {
647
+ membersUpdate.added.push(
648
+ new Member(participant, {
649
+ recordingId: this.recordingId,
650
+ selfId: this.selfId,
651
+ hostId: this.hostId,
652
+ contentSharingId: this.mediaShareContentId,
653
+ whiteboardSharingId: this.mediaShareWhiteboardId,
654
+ type: this.type,
655
+ })
656
+ );
657
+ }
658
+ });
659
+ }
660
+
661
+ return membersUpdate;
662
+ }
663
+
664
+ /**
665
+ * Adds a guest Member to the associated meeting
666
+ * @param {String} invitee
667
+ * @param {Boolean} [alertIfActive]
668
+ * @returns {Promise}
669
+ * @memberof Members
670
+ */
671
+ addMember(invitee: any, alertIfActive?: boolean) {
672
+ if (!this.locusUrl) {
673
+ return Promise.reject(
674
+ new ParameterError('The associated locus url for this meeting object must be defined.')
675
+ );
676
+ }
677
+ if (MembersUtil.isInvalidInvitee(invitee)) {
678
+ return Promise.reject(
679
+ new ParameterError(
680
+ 'The invitee must be defined with either a valid email, emailAddress or phoneNumber property.'
681
+ )
682
+ );
683
+ }
684
+ const options = MembersUtil.generateAddMemberOptions(invitee, this.locusUrl, alertIfActive);
685
+
686
+ return this.membersRequest.addMembers(options);
687
+ }
688
+
689
+ /**
690
+ * Cancels an outgoing PSTN call to the associated meeting
691
+ * @param {String} invitee
692
+ * @returns {Promise}
693
+ * @memberof Members
694
+ */
695
+ cancelPhoneInvite(invitee: any) {
696
+ if (!this.locusUrl) {
697
+ return Promise.reject(
698
+ new ParameterError('The associated locus url for this meeting object must be defined.')
699
+ );
700
+ }
701
+ if (MembersUtil.isInvalidInvitee(invitee)) {
702
+ return Promise.reject(
703
+ new ParameterError('The invitee must be defined with a valid phoneNumber property.')
704
+ );
705
+ }
706
+ const options = MembersUtil.cancelPhoneInviteOptions(invitee, this.locusUrl);
707
+
708
+ return this.membersRequest.cancelPhoneInvite(options);
709
+ }
710
+
711
+ /**
712
+ * Admits waiting members (invited guests to meeting)
713
+ * @param {Array} memberIds
714
+ * @returns {Promise}
715
+ * @public
716
+ * @memberof Members
717
+ */
718
+ public admitMembers(memberIds: Array<any>) {
719
+ if (isEmpty(memberIds)) {
720
+ return Promise.reject(new ParameterError('No member ids provided to admit.'));
721
+ }
722
+ const options = MembersUtil.generateAdmitMemberOptions(memberIds, this.locusUrl);
723
+
724
+ return this.membersRequest.admitMember(options);
725
+ }
726
+
727
+ /**
728
+ * Removes a member from the meeting
729
+ * @param {String} memberId
730
+ * @returns {Promise}
731
+ * @public
732
+ * @memberof Members
733
+ */
734
+ public removeMember(memberId: string) {
735
+ if (!this.locusUrl) {
736
+ return Promise.reject(
737
+ new ParameterError('The associated locus url for this meeting object must be defined.')
738
+ );
739
+ }
740
+ if (!memberId) {
741
+ return Promise.reject(
742
+ new ParameterError('The member id must be defined to remove the member.')
743
+ );
744
+ }
745
+ const options = MembersUtil.generateRemoveMemberOptions(memberId, this.locusUrl);
746
+
747
+ return this.membersRequest.removeMember(options);
748
+ }
749
+
750
+ /**
751
+ * Audio mutes another member in a meeting
752
+ * @param {String} memberId
753
+ * @param {boolean} [mute] default true
754
+ * @returns {Promise}
755
+ * @public
756
+ * @memberof Members
757
+ */
758
+ public muteMember(memberId: string, mute = true) {
759
+ if (!this.locusUrl) {
760
+ return Promise.reject(
761
+ new ParameterError(
762
+ 'The associated locus url for this meetings members object must be defined.'
763
+ )
764
+ );
765
+ }
766
+ if (!memberId) {
767
+ return Promise.reject(
768
+ new ParameterError('The member id must be defined to mute the member.')
769
+ );
770
+ }
771
+ const options = MembersUtil.generateMuteMemberOptions(memberId, mute, this.locusUrl);
772
+
773
+ return this.membersRequest.muteMember(options);
774
+ }
775
+
776
+ /**
777
+ * Raise or lower the hand of a member in a meeting
778
+ * @param {String} memberId
779
+ * @param {boolean} [raise] - to raise hand (=true) or lower (=false), default: true
780
+ * @returns {Promise}
781
+ * @public
782
+ * @memberof Members
783
+ */
784
+ public raiseOrLowerHand(memberId: string, raise = true) {
785
+ if (!this.locusUrl) {
786
+ return Promise.reject(
787
+ new ParameterError(
788
+ 'The associated locus url for this meetings members object must be defined.'
789
+ )
790
+ );
791
+ }
792
+ if (!memberId) {
793
+ return Promise.reject(
794
+ new ParameterError('The member id must be defined to raise/lower the hand of the member.')
795
+ );
796
+ }
797
+ const options = MembersUtil.generateRaiseHandMemberOptions(memberId, raise, this.locusUrl);
798
+
799
+ return this.membersRequest.raiseOrLowerHandMember(options);
800
+ }
801
+
802
+ /**
803
+ * Lower all hands of members in a meeting
804
+ * @param {String} requestingMemberId - id of the participant which requested the lower all hands
805
+ * @returns {Promise}
806
+ * @public
807
+ * @memberof Members
808
+ */
809
+ public lowerAllHands(requestingMemberId: string) {
810
+ if (!this.locusUrl) {
811
+ return Promise.reject(
812
+ new ParameterError(
813
+ 'The associated locus url for this meetings members object must be defined.'
814
+ )
815
+ );
816
+ }
817
+ if (!requestingMemberId) {
818
+ return Promise.reject(
819
+ new ParameterError(
820
+ 'The requestingMemberId must be defined to lower all hands in a meeting.'
821
+ )
822
+ );
823
+ }
824
+ const options = MembersUtil.generateLowerAllHandsMemberOptions(
825
+ requestingMemberId,
826
+ this.locusUrl
827
+ );
828
+
829
+ return this.membersRequest.lowerAllHandsMember(options);
830
+ }
831
+
832
+ /**
833
+ * Transfers the host to another member
834
+ * @param {String} memberId
835
+ * @param {boolean} [moderator] default true
836
+ * @returns {Promise}
837
+ * @public
838
+ * @memberof Members
839
+ */
840
+ public transferHostToMember(memberId: string, moderator = true) {
841
+ if (!this.locusUrl) {
842
+ return Promise.reject(
843
+ new ParameterError(
844
+ 'The associated locus url for this meetings members object must be defined.'
845
+ )
846
+ );
847
+ }
848
+ if (!memberId) {
849
+ return Promise.reject(
850
+ new ParameterError('The member id must be defined to transfer host to the member.')
851
+ );
852
+ }
853
+ const options = MembersUtil.generateTransferHostMemberOptions(
854
+ memberId,
855
+ moderator,
856
+ this.locusUrl
857
+ );
858
+
859
+ return this.membersRequest.transferHostToMember(options);
860
+ }
861
+
862
+ /**
863
+ * Sends DTMF tones for the PSTN member of a meeting
864
+ * @param {String} tones a string of one or more DTMF tones to send
865
+ * @param {String} memberId member id
866
+ * @returns {Promise}
867
+ * @public
868
+ * @memberof Members
869
+ */
870
+ public sendDialPadKey(tones = '', memberId = '') {
871
+ // @ts-ignore
872
+ if (!tones && tones !== 0) {
873
+ return Promise.reject(new ParameterError('DMTF tones must be passed in'));
874
+ }
875
+
876
+ const member = this.membersCollection.get(memberId);
877
+
878
+ if (!member) {
879
+ return Promise.reject(new ParameterError('there is no member associated with that Id'));
880
+ }
881
+
882
+ const {locusUrl} = this;
883
+
884
+ const deviceArray = member.participant.devices;
885
+ const device = deviceArray.find(({deviceType}) => deviceType === 'SIP');
886
+ const url = device?.url;
887
+
888
+ if (locusUrl && url) {
889
+ const options = MembersUtil.genderateSendDTMFOptions(url, tones, memberId, locusUrl);
890
+
891
+ return this.membersRequest.sendDialPadKey(options);
892
+ }
893
+
894
+ return Promise.reject(
895
+ new Error(
896
+ 'Members:index#sendDialPadKey --> cannot send DTMF, meeting does not have a connection to the "locus" call control service.'
897
+ )
898
+ );
899
+ }
900
+ }