@dtelecom/livekit-client 1.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (279) hide show
  1. package/LICENSE +175 -0
  2. package/README.md +315 -0
  3. package/dist/@dtelecom/livekit-client.e2ee.worker.js +2 -0
  4. package/dist/@dtelecom/livekit-client.e2ee.worker.js.map +1 -0
  5. package/dist/@dtelecom/livekit-client.e2ee.worker.mjs +1633 -0
  6. package/dist/@dtelecom/livekit-client.e2ee.worker.mjs.map +1 -0
  7. package/dist/@dtelecom/livekit-client.esm.mjs +22545 -0
  8. package/dist/@dtelecom/livekit-client.esm.mjs.map +1 -0
  9. package/dist/@dtelecom/livekit-client.umd.js +2 -0
  10. package/dist/@dtelecom/livekit-client.umd.js.map +1 -0
  11. package/dist/@dtelecom/src/api/SignalClient.d.ts +102 -0
  12. package/dist/@dtelecom/src/api/SignalClient.d.ts.map +1 -0
  13. package/dist/@dtelecom/src/connectionHelper/ConnectionCheck.d.ts +26 -0
  14. package/dist/@dtelecom/src/connectionHelper/ConnectionCheck.d.ts.map +1 -0
  15. package/dist/@dtelecom/src/connectionHelper/checks/Checker.d.ts +59 -0
  16. package/dist/@dtelecom/src/connectionHelper/checks/Checker.d.ts.map +1 -0
  17. package/dist/@dtelecom/src/connectionHelper/checks/publishAudio.d.ts +6 -0
  18. package/dist/@dtelecom/src/connectionHelper/checks/publishAudio.d.ts.map +1 -0
  19. package/dist/@dtelecom/src/connectionHelper/checks/publishVideo.d.ts +6 -0
  20. package/dist/@dtelecom/src/connectionHelper/checks/publishVideo.d.ts.map +1 -0
  21. package/dist/@dtelecom/src/connectionHelper/checks/reconnect.d.ts +6 -0
  22. package/dist/@dtelecom/src/connectionHelper/checks/reconnect.d.ts.map +1 -0
  23. package/dist/@dtelecom/src/connectionHelper/checks/turn.d.ts +6 -0
  24. package/dist/@dtelecom/src/connectionHelper/checks/turn.d.ts.map +1 -0
  25. package/dist/@dtelecom/src/connectionHelper/checks/webrtc.d.ts +6 -0
  26. package/dist/@dtelecom/src/connectionHelper/checks/webrtc.d.ts.map +1 -0
  27. package/dist/@dtelecom/src/connectionHelper/checks/websocket.d.ts +6 -0
  28. package/dist/@dtelecom/src/connectionHelper/checks/websocket.d.ts.map +1 -0
  29. package/dist/@dtelecom/src/e2ee/E2eeManager.d.ts +47 -0
  30. package/dist/@dtelecom/src/e2ee/E2eeManager.d.ts.map +1 -0
  31. package/dist/@dtelecom/src/e2ee/KeyProvider.d.ts +44 -0
  32. package/dist/@dtelecom/src/e2ee/KeyProvider.d.ts.map +1 -0
  33. package/dist/@dtelecom/src/e2ee/constants.d.ts +15 -0
  34. package/dist/@dtelecom/src/e2ee/constants.d.ts.map +1 -0
  35. package/dist/@dtelecom/src/e2ee/errors.d.ts +11 -0
  36. package/dist/@dtelecom/src/e2ee/errors.d.ts.map +1 -0
  37. package/dist/@dtelecom/src/e2ee/index.d.ts +4 -0
  38. package/dist/@dtelecom/src/e2ee/index.d.ts.map +1 -0
  39. package/dist/@dtelecom/src/e2ee/types.d.ts +130 -0
  40. package/dist/@dtelecom/src/e2ee/types.d.ts.map +1 -0
  41. package/dist/@dtelecom/src/e2ee/utils.d.ts +24 -0
  42. package/dist/@dtelecom/src/e2ee/utils.d.ts.map +1 -0
  43. package/dist/@dtelecom/src/e2ee/worker/FrameCryptor.d.ts +176 -0
  44. package/dist/@dtelecom/src/e2ee/worker/FrameCryptor.d.ts.map +1 -0
  45. package/dist/@dtelecom/src/e2ee/worker/ParticipantKeyHandler.d.ts +65 -0
  46. package/dist/@dtelecom/src/e2ee/worker/ParticipantKeyHandler.d.ts.map +1 -0
  47. package/dist/@dtelecom/src/e2ee/worker/e2ee.worker.d.ts +2 -0
  48. package/dist/@dtelecom/src/e2ee/worker/e2ee.worker.d.ts.map +1 -0
  49. package/dist/@dtelecom/src/index.d.ts +38 -0
  50. package/dist/@dtelecom/src/index.d.ts.map +1 -0
  51. package/dist/@dtelecom/src/logger.d.ts +29 -0
  52. package/dist/@dtelecom/src/logger.d.ts.map +1 -0
  53. package/dist/@dtelecom/src/options.d.ts +104 -0
  54. package/dist/@dtelecom/src/options.d.ts.map +1 -0
  55. package/dist/@dtelecom/src/proto/livekit_models_pb.d.ts +1264 -0
  56. package/dist/@dtelecom/src/proto/livekit_models_pb.d.ts.map +1 -0
  57. package/dist/@dtelecom/src/proto/livekit_rtc_pb.d.ts +1373 -0
  58. package/dist/@dtelecom/src/proto/livekit_rtc_pb.d.ts.map +1 -0
  59. package/dist/@dtelecom/src/room/DefaultReconnectPolicy.d.ts +8 -0
  60. package/dist/@dtelecom/src/room/DefaultReconnectPolicy.d.ts.map +1 -0
  61. package/dist/@dtelecom/src/room/DeviceManager.d.ts +9 -0
  62. package/dist/@dtelecom/src/room/DeviceManager.d.ts.map +1 -0
  63. package/dist/@dtelecom/src/room/PCTransport.d.ts +41 -0
  64. package/dist/@dtelecom/src/room/PCTransport.d.ts.map +1 -0
  65. package/dist/@dtelecom/src/room/RTCEngine.d.ts +143 -0
  66. package/dist/@dtelecom/src/room/RTCEngine.d.ts.map +1 -0
  67. package/dist/@dtelecom/src/room/ReconnectPolicy.d.ts +24 -0
  68. package/dist/@dtelecom/src/room/ReconnectPolicy.d.ts.map +1 -0
  69. package/dist/@dtelecom/src/room/RegionUrlProvider.d.ts +17 -0
  70. package/dist/@dtelecom/src/room/RegionUrlProvider.d.ts.map +1 -0
  71. package/dist/@dtelecom/src/room/Room.d.ts +248 -0
  72. package/dist/@dtelecom/src/room/Room.d.ts.map +1 -0
  73. package/dist/@dtelecom/src/room/defaults.d.ts +8 -0
  74. package/dist/@dtelecom/src/room/defaults.d.ts.map +1 -0
  75. package/dist/@dtelecom/src/room/errors.d.ts +43 -0
  76. package/dist/@dtelecom/src/room/errors.d.ts.map +1 -0
  77. package/dist/@dtelecom/src/room/events.d.ts +477 -0
  78. package/dist/@dtelecom/src/room/events.d.ts.map +1 -0
  79. package/dist/@dtelecom/src/room/participant/LocalParticipant.d.ts +177 -0
  80. package/dist/@dtelecom/src/room/participant/LocalParticipant.d.ts.map +1 -0
  81. package/dist/@dtelecom/src/room/participant/Participant.d.ts +95 -0
  82. package/dist/@dtelecom/src/room/participant/Participant.d.ts.map +1 -0
  83. package/dist/@dtelecom/src/room/participant/ParticipantTrackPermission.d.ts +26 -0
  84. package/dist/@dtelecom/src/room/participant/ParticipantTrackPermission.d.ts.map +1 -0
  85. package/dist/@dtelecom/src/room/participant/RemoteParticipant.d.ts +55 -0
  86. package/dist/@dtelecom/src/room/participant/RemoteParticipant.d.ts.map +1 -0
  87. package/dist/@dtelecom/src/room/participant/publishUtils.d.ts +28 -0
  88. package/dist/@dtelecom/src/room/participant/publishUtils.d.ts.map +1 -0
  89. package/dist/@dtelecom/src/room/stats.d.ts +67 -0
  90. package/dist/@dtelecom/src/room/stats.d.ts.map +1 -0
  91. package/dist/@dtelecom/src/room/timers.d.ts +13 -0
  92. package/dist/@dtelecom/src/room/timers.d.ts.map +1 -0
  93. package/dist/@dtelecom/src/room/track/LocalAudioTrack.d.ts +25 -0
  94. package/dist/@dtelecom/src/room/track/LocalAudioTrack.d.ts.map +1 -0
  95. package/dist/@dtelecom/src/room/track/LocalTrack.d.ts +78 -0
  96. package/dist/@dtelecom/src/room/track/LocalTrack.d.ts.map +1 -0
  97. package/dist/@dtelecom/src/room/track/LocalTrackPublication.d.ts +38 -0
  98. package/dist/@dtelecom/src/room/track/LocalTrackPublication.d.ts.map +1 -0
  99. package/dist/@dtelecom/src/room/track/LocalVideoTrack.d.ts +54 -0
  100. package/dist/@dtelecom/src/room/track/LocalVideoTrack.d.ts.map +1 -0
  101. package/dist/@dtelecom/src/room/track/RemoteAudioTrack.d.ts +53 -0
  102. package/dist/@dtelecom/src/room/track/RemoteAudioTrack.d.ts.map +1 -0
  103. package/dist/@dtelecom/src/room/track/RemoteTrack.d.ts +15 -0
  104. package/dist/@dtelecom/src/room/track/RemoteTrack.d.ts.map +1 -0
  105. package/dist/@dtelecom/src/room/track/RemoteTrackPublication.d.ts +64 -0
  106. package/dist/@dtelecom/src/room/track/RemoteTrackPublication.d.ts.map +1 -0
  107. package/dist/@dtelecom/src/room/track/RemoteVideoTrack.d.ts +56 -0
  108. package/dist/@dtelecom/src/room/track/RemoteVideoTrack.d.ts.map +1 -0
  109. package/dist/@dtelecom/src/room/track/Track.d.ts +125 -0
  110. package/dist/@dtelecom/src/room/track/Track.d.ts.map +1 -0
  111. package/dist/@dtelecom/src/room/track/TrackPublication.d.ts +72 -0
  112. package/dist/@dtelecom/src/room/track/TrackPublication.d.ts.map +1 -0
  113. package/dist/@dtelecom/src/room/track/create.d.ts +24 -0
  114. package/dist/@dtelecom/src/room/track/create.d.ts.map +1 -0
  115. package/dist/@dtelecom/src/room/track/facingMode.d.ts +41 -0
  116. package/dist/@dtelecom/src/room/track/facingMode.d.ts.map +1 -0
  117. package/dist/@dtelecom/src/room/track/options.d.ts +272 -0
  118. package/dist/@dtelecom/src/room/track/options.d.ts.map +1 -0
  119. package/dist/@dtelecom/src/room/track/processor/types.d.ts +19 -0
  120. package/dist/@dtelecom/src/room/track/processor/types.d.ts.map +1 -0
  121. package/dist/@dtelecom/src/room/track/types.d.ts +24 -0
  122. package/dist/@dtelecom/src/room/track/types.d.ts.map +1 -0
  123. package/dist/@dtelecom/src/room/track/utils.d.ts +27 -0
  124. package/dist/@dtelecom/src/room/track/utils.d.ts.map +1 -0
  125. package/dist/@dtelecom/src/room/types.d.ts +26 -0
  126. package/dist/@dtelecom/src/room/types.d.ts.map +1 -0
  127. package/dist/@dtelecom/src/room/utils.d.ts +92 -0
  128. package/dist/@dtelecom/src/room/utils.d.ts.map +1 -0
  129. package/dist/@dtelecom/src/test/MockMediaStreamTrack.d.ts +26 -0
  130. package/dist/@dtelecom/src/test/MockMediaStreamTrack.d.ts.map +1 -0
  131. package/dist/@dtelecom/src/test/mocks.d.ts +12 -0
  132. package/dist/@dtelecom/src/test/mocks.d.ts.map +1 -0
  133. package/dist/@dtelecom/src/utils/AsyncQueue.d.ts +23 -0
  134. package/dist/@dtelecom/src/utils/AsyncQueue.d.ts.map +1 -0
  135. package/dist/@dtelecom/src/utils/browserParser.d.ts +12 -0
  136. package/dist/@dtelecom/src/utils/browserParser.d.ts.map +1 -0
  137. package/dist/@dtelecom/src/version.d.ts +3 -0
  138. package/dist/@dtelecom/src/version.d.ts.map +1 -0
  139. package/dist/ts4.2/@dtelecom/src/api/SignalClient.d.ts +105 -0
  140. package/dist/ts4.2/@dtelecom/src/connectionHelper/ConnectionCheck.d.ts +26 -0
  141. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/Checker.d.ts +59 -0
  142. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/publishAudio.d.ts +6 -0
  143. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/publishVideo.d.ts +6 -0
  144. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/reconnect.d.ts +6 -0
  145. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/turn.d.ts +6 -0
  146. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/webrtc.d.ts +6 -0
  147. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/websocket.d.ts +6 -0
  148. package/dist/ts4.2/@dtelecom/src/e2ee/E2eeManager.d.ts +47 -0
  149. package/dist/ts4.2/@dtelecom/src/e2ee/KeyProvider.d.ts +44 -0
  150. package/dist/ts4.2/@dtelecom/src/e2ee/constants.d.ts +15 -0
  151. package/dist/ts4.2/@dtelecom/src/e2ee/errors.d.ts +11 -0
  152. package/dist/ts4.2/@dtelecom/src/e2ee/index.d.ts +4 -0
  153. package/dist/ts4.2/@dtelecom/src/e2ee/types.d.ts +130 -0
  154. package/dist/ts4.2/@dtelecom/src/e2ee/utils.d.ts +24 -0
  155. package/dist/ts4.2/@dtelecom/src/e2ee/worker/FrameCryptor.d.ts +176 -0
  156. package/dist/ts4.2/@dtelecom/src/e2ee/worker/ParticipantKeyHandler.d.ts +65 -0
  157. package/dist/ts4.2/@dtelecom/src/e2ee/worker/e2ee.worker.d.ts +2 -0
  158. package/dist/ts4.2/@dtelecom/src/index.d.ts +38 -0
  159. package/dist/ts4.2/@dtelecom/src/logger.d.ts +29 -0
  160. package/dist/ts4.2/@dtelecom/src/options.d.ts +104 -0
  161. package/dist/ts4.2/@dtelecom/src/proto/livekit_models_pb.d.ts +1264 -0
  162. package/dist/ts4.2/@dtelecom/src/proto/livekit_rtc_pb.d.ts +1373 -0
  163. package/dist/ts4.2/@dtelecom/src/room/DefaultReconnectPolicy.d.ts +8 -0
  164. package/dist/ts4.2/@dtelecom/src/room/DeviceManager.d.ts +9 -0
  165. package/dist/ts4.2/@dtelecom/src/room/PCTransport.d.ts +43 -0
  166. package/dist/ts4.2/@dtelecom/src/room/RTCEngine.d.ts +143 -0
  167. package/dist/ts4.2/@dtelecom/src/room/ReconnectPolicy.d.ts +24 -0
  168. package/dist/ts4.2/@dtelecom/src/room/RegionUrlProvider.d.ts +17 -0
  169. package/dist/ts4.2/@dtelecom/src/room/Room.d.ts +248 -0
  170. package/dist/ts4.2/@dtelecom/src/room/defaults.d.ts +8 -0
  171. package/dist/ts4.2/@dtelecom/src/room/errors.d.ts +43 -0
  172. package/dist/ts4.2/@dtelecom/src/room/events.d.ts +477 -0
  173. package/dist/ts4.2/@dtelecom/src/room/participant/LocalParticipant.d.ts +177 -0
  174. package/dist/ts4.2/@dtelecom/src/room/participant/Participant.d.ts +95 -0
  175. package/dist/ts4.2/@dtelecom/src/room/participant/ParticipantTrackPermission.d.ts +26 -0
  176. package/dist/ts4.2/@dtelecom/src/room/participant/RemoteParticipant.d.ts +55 -0
  177. package/dist/ts4.2/@dtelecom/src/room/participant/publishUtils.d.ts +28 -0
  178. package/dist/ts4.2/@dtelecom/src/room/stats.d.ts +67 -0
  179. package/dist/ts4.2/@dtelecom/src/room/timers.d.ts +13 -0
  180. package/dist/ts4.2/@dtelecom/src/room/track/LocalAudioTrack.d.ts +25 -0
  181. package/dist/ts4.2/@dtelecom/src/room/track/LocalTrack.d.ts +78 -0
  182. package/dist/ts4.2/@dtelecom/src/room/track/LocalTrackPublication.d.ts +38 -0
  183. package/dist/ts4.2/@dtelecom/src/room/track/LocalVideoTrack.d.ts +54 -0
  184. package/dist/ts4.2/@dtelecom/src/room/track/RemoteAudioTrack.d.ts +53 -0
  185. package/dist/ts4.2/@dtelecom/src/room/track/RemoteTrack.d.ts +15 -0
  186. package/dist/ts4.2/@dtelecom/src/room/track/RemoteTrackPublication.d.ts +64 -0
  187. package/dist/ts4.2/@dtelecom/src/room/track/RemoteVideoTrack.d.ts +56 -0
  188. package/dist/ts4.2/@dtelecom/src/room/track/Track.d.ts +125 -0
  189. package/dist/ts4.2/@dtelecom/src/room/track/TrackPublication.d.ts +72 -0
  190. package/dist/ts4.2/@dtelecom/src/room/track/create.d.ts +24 -0
  191. package/dist/ts4.2/@dtelecom/src/room/track/facingMode.d.ts +41 -0
  192. package/dist/ts4.2/@dtelecom/src/room/track/options.d.ts +280 -0
  193. package/dist/ts4.2/@dtelecom/src/room/track/processor/types.d.ts +19 -0
  194. package/dist/ts4.2/@dtelecom/src/room/track/types.d.ts +24 -0
  195. package/dist/ts4.2/@dtelecom/src/room/track/utils.d.ts +27 -0
  196. package/dist/ts4.2/@dtelecom/src/room/types.d.ts +26 -0
  197. package/dist/ts4.2/@dtelecom/src/room/utils.d.ts +92 -0
  198. package/dist/ts4.2/@dtelecom/src/test/MockMediaStreamTrack.d.ts +26 -0
  199. package/dist/ts4.2/@dtelecom/src/test/mocks.d.ts +12 -0
  200. package/dist/ts4.2/@dtelecom/src/utils/AsyncQueue.d.ts +23 -0
  201. package/dist/ts4.2/@dtelecom/src/utils/browserParser.d.ts +12 -0
  202. package/dist/ts4.2/@dtelecom/src/version.d.ts +3 -0
  203. package/package.json +102 -0
  204. package/src/api/SignalClient.ts +790 -0
  205. package/src/connectionHelper/ConnectionCheck.ts +90 -0
  206. package/src/connectionHelper/checks/Checker.ts +163 -0
  207. package/src/connectionHelper/checks/publishAudio.ts +33 -0
  208. package/src/connectionHelper/checks/publishVideo.ts +33 -0
  209. package/src/connectionHelper/checks/reconnect.ts +45 -0
  210. package/src/connectionHelper/checks/turn.ts +54 -0
  211. package/src/connectionHelper/checks/webrtc.ts +82 -0
  212. package/src/connectionHelper/checks/websocket.ts +27 -0
  213. package/src/e2ee/E2eeManager.ts +375 -0
  214. package/src/e2ee/KeyProvider.ts +78 -0
  215. package/src/e2ee/constants.ts +44 -0
  216. package/src/e2ee/errors.ts +16 -0
  217. package/src/e2ee/index.ts +3 -0
  218. package/src/e2ee/types.ts +161 -0
  219. package/src/e2ee/utils.ts +127 -0
  220. package/src/e2ee/worker/FrameCryptor.test.ts +19 -0
  221. package/src/e2ee/worker/FrameCryptor.ts +612 -0
  222. package/src/e2ee/worker/ParticipantKeyHandler.ts +175 -0
  223. package/src/e2ee/worker/e2ee.worker.ts +223 -0
  224. package/src/e2ee/worker/tsconfig.json +6 -0
  225. package/src/index.ts +85 -0
  226. package/src/logger.ts +64 -0
  227. package/src/options.ts +127 -0
  228. package/src/proto/livekit_models_pb.ts +2096 -0
  229. package/src/proto/livekit_rtc_pb.ts +2332 -0
  230. package/src/room/DefaultReconnectPolicy.ts +35 -0
  231. package/src/room/DeviceManager.ts +88 -0
  232. package/src/room/PCTransport.ts +452 -0
  233. package/src/room/RTCEngine.ts +1421 -0
  234. package/src/room/ReconnectPolicy.ts +27 -0
  235. package/src/room/RegionUrlProvider.ts +82 -0
  236. package/src/room/Room.test.ts +30 -0
  237. package/src/room/Room.ts +1907 -0
  238. package/src/room/defaults.ts +49 -0
  239. package/src/room/errors.ts +90 -0
  240. package/src/room/events.ts +535 -0
  241. package/src/room/participant/LocalParticipant.ts +1350 -0
  242. package/src/room/participant/Participant.ts +299 -0
  243. package/src/room/participant/ParticipantTrackPermission.ts +42 -0
  244. package/src/room/participant/RemoteParticipant.ts +359 -0
  245. package/src/room/participant/publishUtils.test.ts +189 -0
  246. package/src/room/participant/publishUtils.ts +399 -0
  247. package/src/room/stats.ts +136 -0
  248. package/src/room/timers.ts +16 -0
  249. package/src/room/track/LocalAudioTrack.ts +171 -0
  250. package/src/room/track/LocalTrack.ts +430 -0
  251. package/src/room/track/LocalTrackPublication.ts +87 -0
  252. package/src/room/track/LocalVideoTrack.test.ts +73 -0
  253. package/src/room/track/LocalVideoTrack.ts +513 -0
  254. package/src/room/track/RemoteAudioTrack.ts +248 -0
  255. package/src/room/track/RemoteTrack.ts +62 -0
  256. package/src/room/track/RemoteTrackPublication.ts +311 -0
  257. package/src/room/track/RemoteVideoTrack.test.ts +152 -0
  258. package/src/room/track/RemoteVideoTrack.ts +410 -0
  259. package/src/room/track/Track.ts +452 -0
  260. package/src/room/track/TrackPublication.ts +158 -0
  261. package/src/room/track/create.ts +143 -0
  262. package/src/room/track/facingMode.test.ts +31 -0
  263. package/src/room/track/facingMode.ts +103 -0
  264. package/src/room/track/options.ts +362 -0
  265. package/src/room/track/processor/types.ts +20 -0
  266. package/src/room/track/types.ts +25 -0
  267. package/src/room/track/utils.test.ts +111 -0
  268. package/src/room/track/utils.ts +183 -0
  269. package/src/room/types.ts +39 -0
  270. package/src/room/utils.test.ts +16 -0
  271. package/src/room/utils.ts +501 -0
  272. package/src/room/worker.d.ts +4 -0
  273. package/src/test/MockMediaStreamTrack.ts +84 -0
  274. package/src/test/mocks.ts +19 -0
  275. package/src/utils/AsyncQueue.test.ts +100 -0
  276. package/src/utils/AsyncQueue.ts +57 -0
  277. package/src/utils/browserParser.test.ts +88 -0
  278. package/src/utils/browserParser.ts +74 -0
  279. package/src/version.ts +4 -0
@@ -0,0 +1,90 @@
1
+ import { EventEmitter } from 'events';
2
+ import type TypedEmitter from 'typed-emitter';
3
+ import { CheckStatus, Checker } from './checks/Checker';
4
+ import type { CheckInfo, InstantiableCheck } from './checks/Checker';
5
+ import { PublishAudioCheck } from './checks/publishAudio';
6
+ import { PublishVideoCheck } from './checks/publishVideo';
7
+ import { ReconnectCheck } from './checks/reconnect';
8
+ import { TURNCheck } from './checks/turn';
9
+ import { WebRTCCheck } from './checks/webrtc';
10
+ import { WebSocketCheck } from './checks/websocket';
11
+
12
+ export type { CheckInfo, CheckStatus };
13
+
14
+ export class ConnectionCheck extends (EventEmitter as new () => TypedEmitter<ConnectionCheckCallbacks>) {
15
+ token: string;
16
+
17
+ url: string;
18
+
19
+ private checkResults: Map<number, CheckInfo> = new Map();
20
+
21
+ constructor(url: string, token: string) {
22
+ super();
23
+ this.url = url;
24
+ this.token = token;
25
+ }
26
+
27
+ private getNextCheckId() {
28
+ const nextId = this.checkResults.size;
29
+ this.checkResults.set(nextId, {
30
+ logs: [],
31
+ status: CheckStatus.IDLE,
32
+ name: '',
33
+ description: '',
34
+ });
35
+ return nextId;
36
+ }
37
+
38
+ private updateCheck(checkId: number, info: CheckInfo) {
39
+ this.checkResults.set(checkId, info);
40
+ this.emit('checkUpdate', checkId, info);
41
+ }
42
+
43
+ isSuccess() {
44
+ return Array.from(this.checkResults.values()).every((r) => r.status !== CheckStatus.FAILED);
45
+ }
46
+
47
+ getResults() {
48
+ return Array.from(this.checkResults.values());
49
+ }
50
+
51
+ async createAndRunCheck<T extends Checker>(check: InstantiableCheck<T>) {
52
+ const checkId = this.getNextCheckId();
53
+ const test = new check(this.url, this.token);
54
+ const handleUpdate = (info: CheckInfo) => {
55
+ this.updateCheck(checkId, info);
56
+ };
57
+ test.on('update', handleUpdate);
58
+ const result = await test.run();
59
+ test.off('update', handleUpdate);
60
+ return result;
61
+ }
62
+
63
+ async checkWebsocket() {
64
+ return this.createAndRunCheck(WebSocketCheck);
65
+ }
66
+
67
+ async checkWebRTC() {
68
+ return this.createAndRunCheck(WebRTCCheck);
69
+ }
70
+
71
+ async checkTURN() {
72
+ return this.createAndRunCheck(TURNCheck);
73
+ }
74
+
75
+ async checkReconnect() {
76
+ return this.createAndRunCheck(ReconnectCheck);
77
+ }
78
+
79
+ async checkPublishAudio() {
80
+ return this.createAndRunCheck(PublishAudioCheck);
81
+ }
82
+
83
+ async checkPublishVideo() {
84
+ return this.createAndRunCheck(PublishVideoCheck);
85
+ }
86
+ }
87
+
88
+ type ConnectionCheckCallbacks = {
89
+ checkUpdate: (id: number, info: CheckInfo) => void;
90
+ };
@@ -0,0 +1,163 @@
1
+ import { EventEmitter } from 'events';
2
+ import type TypedEmitter from 'typed-emitter';
3
+ import type { RoomConnectOptions, RoomOptions } from '../../options';
4
+ import type RTCEngine from '../../room/RTCEngine';
5
+ import Room, { ConnectionState } from '../../room/Room';
6
+
7
+ type LogMessage = {
8
+ level: 'info' | 'warning' | 'error';
9
+ message: string;
10
+ };
11
+
12
+ export enum CheckStatus {
13
+ IDLE,
14
+ RUNNING,
15
+ SKIPPED,
16
+ SUCCESS,
17
+ FAILED,
18
+ }
19
+
20
+ export type CheckInfo = {
21
+ name: string;
22
+ logs: Array<LogMessage>;
23
+ status: CheckStatus;
24
+ description: string;
25
+ };
26
+
27
+ export interface CheckerOptions {
28
+ errorsAsWarnings?: boolean;
29
+ roomOptions?: RoomOptions;
30
+ connectOptions?: RoomConnectOptions;
31
+ }
32
+
33
+ export abstract class Checker extends (EventEmitter as new () => TypedEmitter<CheckerCallbacks>) {
34
+ protected url: string;
35
+
36
+ protected token: string;
37
+
38
+ room: Room;
39
+
40
+ connectOptions?: RoomConnectOptions;
41
+
42
+ status: CheckStatus = CheckStatus.IDLE;
43
+
44
+ logs: Array<LogMessage> = [];
45
+
46
+ errorsAsWarnings: boolean = false;
47
+
48
+ name: string;
49
+
50
+ constructor(url: string, token: string, options: CheckerOptions = {}) {
51
+ super();
52
+ this.url = url;
53
+ this.token = token;
54
+ this.name = this.constructor.name;
55
+ this.room = new Room(options.roomOptions);
56
+ this.connectOptions = options.connectOptions;
57
+ if (options.errorsAsWarnings) {
58
+ this.errorsAsWarnings = options.errorsAsWarnings;
59
+ }
60
+ }
61
+
62
+ abstract get description(): string;
63
+
64
+ protected abstract perform(): Promise<void>;
65
+
66
+ async run(onComplete?: () => void) {
67
+ if (this.status !== CheckStatus.IDLE) {
68
+ throw Error('check is running already');
69
+ }
70
+ this.setStatus(CheckStatus.RUNNING);
71
+
72
+ try {
73
+ await this.perform();
74
+ } catch (err) {
75
+ if (err instanceof Error) {
76
+ if (this.errorsAsWarnings) {
77
+ this.appendWarning(err.message);
78
+ } else {
79
+ this.appendError(err.message);
80
+ }
81
+ }
82
+ }
83
+
84
+ await this.disconnect();
85
+
86
+ // sleep for a bit to ensure disconnect
87
+ await new Promise((resolve) => setTimeout(resolve, 500));
88
+
89
+ // @ts-ignore
90
+ if (this.status !== CheckStatus.SKIPPED) {
91
+ this.setStatus(this.isSuccess() ? CheckStatus.SUCCESS : CheckStatus.FAILED);
92
+ }
93
+
94
+ if (onComplete) {
95
+ onComplete();
96
+ }
97
+ return this.getInfo();
98
+ }
99
+
100
+ protected isSuccess(): boolean {
101
+ return !this.logs.some((l) => l.level === 'error');
102
+ }
103
+
104
+ protected async connect(): Promise<Room> {
105
+ if (this.room.state === ConnectionState.Connected) {
106
+ return this.room;
107
+ }
108
+ await this.room.connect(this.url, this.token);
109
+ return this.room;
110
+ }
111
+
112
+ protected async disconnect() {
113
+ if (this.room && this.room.state !== ConnectionState.Disconnected) {
114
+ await this.room.disconnect();
115
+ // wait for it to go through
116
+ await new Promise((resolve) => setTimeout(resolve, 500));
117
+ }
118
+ }
119
+
120
+ protected skip() {
121
+ this.setStatus(CheckStatus.SKIPPED);
122
+ }
123
+
124
+ protected appendMessage(message: string) {
125
+ this.logs.push({ level: 'info', message });
126
+ this.emit('update', this.getInfo());
127
+ }
128
+
129
+ protected appendWarning(message: string) {
130
+ this.logs.push({ level: 'warning', message });
131
+ this.emit('update', this.getInfo());
132
+ }
133
+
134
+ protected appendError(message: string) {
135
+ this.logs.push({ level: 'error', message });
136
+ this.emit('update', this.getInfo());
137
+ }
138
+
139
+ protected setStatus(status: CheckStatus) {
140
+ this.status = status;
141
+ this.emit('update', this.getInfo());
142
+ }
143
+
144
+ protected get engine(): RTCEngine | undefined {
145
+ return this.room?.engine;
146
+ }
147
+
148
+ getInfo(): CheckInfo {
149
+ return {
150
+ logs: this.logs,
151
+ name: this.name,
152
+ status: this.status,
153
+ description: this.description,
154
+ };
155
+ }
156
+ }
157
+ export type InstantiableCheck<T extends Checker> = {
158
+ new (url: string, token: string, options?: CheckerOptions): T;
159
+ };
160
+
161
+ type CheckerCallbacks = {
162
+ update: (info: CheckInfo) => void;
163
+ };
@@ -0,0 +1,33 @@
1
+ import { createLocalAudioTrack } from '../../room/track/create';
2
+ import { Checker } from './Checker';
3
+
4
+ export class PublishAudioCheck extends Checker {
5
+ get description(): string {
6
+ return 'Can publish audio';
7
+ }
8
+
9
+ async perform(): Promise<void> {
10
+ const room = await this.connect();
11
+
12
+ const track = await createLocalAudioTrack();
13
+ room.localParticipant.publishTrack(track);
14
+ // wait for a few seconds to publish
15
+ await new Promise((resolve) => setTimeout(resolve, 3000));
16
+
17
+ // verify RTC stats that it's publishing
18
+ const stats = await track.sender?.getStats();
19
+ if (!stats) {
20
+ throw new Error('Could not get RTCStats');
21
+ }
22
+ let numPackets = 0;
23
+ stats.forEach((stat) => {
24
+ if (stat.type === 'outbound-rtp' && stat.mediaType === 'audio') {
25
+ numPackets = stat.packetsSent;
26
+ }
27
+ });
28
+ if (numPackets === 0) {
29
+ throw new Error('Could not determine packets are sent');
30
+ }
31
+ this.appendMessage(`published ${numPackets} audio packets`);
32
+ }
33
+ }
@@ -0,0 +1,33 @@
1
+ import { createLocalVideoTrack } from '../../room/track/create';
2
+ import { Checker } from './Checker';
3
+
4
+ export class PublishVideoCheck extends Checker {
5
+ get description(): string {
6
+ return 'Can publish video';
7
+ }
8
+
9
+ async perform(): Promise<void> {
10
+ const room = await this.connect();
11
+
12
+ const track = await createLocalVideoTrack();
13
+ room.localParticipant.publishTrack(track);
14
+ // wait for a few seconds to publish
15
+ await new Promise((resolve) => setTimeout(resolve, 3000));
16
+
17
+ // verify RTC stats that it's publishing
18
+ const stats = await track.sender?.getStats();
19
+ if (!stats) {
20
+ throw new Error('Could not get RTCStats');
21
+ }
22
+ let numPackets = 0;
23
+ stats.forEach((stat) => {
24
+ if (stat.type === 'outbound-rtp' && stat.mediaType === 'video') {
25
+ numPackets = stat.packetsSent;
26
+ }
27
+ });
28
+ if (numPackets === 0) {
29
+ throw new Error('Could not determine packets are sent');
30
+ }
31
+ this.appendMessage(`published ${numPackets} video packets`);
32
+ }
33
+ }
@@ -0,0 +1,45 @@
1
+ import { ConnectionState } from '../../room/Room';
2
+ import { RoomEvent } from '../../room/events';
3
+ import { Checker } from './Checker';
4
+
5
+ export class ReconnectCheck extends Checker {
6
+ get description(): string {
7
+ return 'Resuming connection after interruption';
8
+ }
9
+
10
+ async perform(): Promise<void> {
11
+ const room = await this.connect();
12
+ let reconnectingTriggered = false;
13
+ let reconnected = false;
14
+
15
+ let reconnectResolver: (value: unknown) => void;
16
+ const reconnectTimeout = new Promise((resolve) => {
17
+ setTimeout(resolve, 5000);
18
+ reconnectResolver = resolve;
19
+ });
20
+
21
+ room
22
+ .on(RoomEvent.Reconnecting, () => {
23
+ reconnectingTriggered = true;
24
+ })
25
+ .on(RoomEvent.Reconnected, () => {
26
+ reconnected = true;
27
+ reconnectResolver(true);
28
+ });
29
+
30
+ room.engine.client.ws?.close();
31
+ const onClose = room.engine.client.onClose;
32
+ if (onClose) {
33
+ onClose('');
34
+ }
35
+
36
+ await reconnectTimeout;
37
+
38
+ if (!reconnectingTriggered) {
39
+ throw new Error('Did not attempt to reconnect');
40
+ } else if (!reconnected || room.state !== ConnectionState.Connected) {
41
+ this.appendWarning('reconnection is only possible in Redis-based configurations');
42
+ throw new Error('Not able to reconnect');
43
+ }
44
+ }
45
+ }
@@ -0,0 +1,54 @@
1
+ import { SignalClient } from '../../api/SignalClient';
2
+ import { Checker } from './Checker';
3
+
4
+ export class TURNCheck extends Checker {
5
+ get description(): string {
6
+ return 'Can connect via TURN';
7
+ }
8
+
9
+ async perform(): Promise<void> {
10
+ const signalClient = new SignalClient();
11
+ const joinRes = await signalClient.join(this.url, this.token, {
12
+ autoSubscribe: true,
13
+ maxRetries: 0,
14
+ e2eeEnabled: false,
15
+ });
16
+
17
+ let hasTLS = false;
18
+ let hasTURN = false;
19
+ let hasSTUN = false;
20
+
21
+ for (let iceServer of joinRes.iceServers) {
22
+ for (let url of iceServer.urls) {
23
+ if (url.startsWith('turn:')) {
24
+ hasTURN = true;
25
+ hasSTUN = true;
26
+ } else if (url.startsWith('turns:')) {
27
+ hasTURN = true;
28
+ hasSTUN = true;
29
+ hasTLS = true;
30
+ }
31
+ if (url.startsWith('stun:')) {
32
+ hasSTUN = true;
33
+ }
34
+ }
35
+ }
36
+ if (!hasSTUN) {
37
+ this.appendWarning('No STUN servers configured on server side.');
38
+ } else if (hasTURN && !hasTLS) {
39
+ this.appendWarning('TURN is configured server side, but TURN/TLS is unavailable.');
40
+ }
41
+ await signalClient.close();
42
+ if (this.connectOptions?.rtcConfig?.iceServers || hasTURN) {
43
+ await this.room!.connect(this.url, this.token, {
44
+ rtcConfig: {
45
+ iceTransportPolicy: 'relay',
46
+ },
47
+ });
48
+ } else {
49
+ this.appendWarning('No TURN servers configured.');
50
+ this.skip();
51
+ await new Promise((resolve) => setTimeout(resolve, 0));
52
+ }
53
+ }
54
+ }
@@ -0,0 +1,82 @@
1
+ import { RoomEvent } from '../../room/events';
2
+ import { Checker } from './Checker';
3
+
4
+ export class WebRTCCheck extends Checker {
5
+ get description(): string {
6
+ return 'Establishing WebRTC connection';
7
+ }
8
+
9
+ protected async perform(): Promise<void> {
10
+ let hasTcp = false;
11
+ let hasIpv4Udp = false;
12
+ this.room.on(RoomEvent.SignalConnected, () => {
13
+ const prevTrickle = this.room.engine.client.onTrickle;
14
+
15
+ const candidates: RTCIceCandidate[] = [];
16
+ this.room.engine.client.onTrickle = (sd, target) => {
17
+ console.log('got candidate', sd);
18
+ if (sd.candidate) {
19
+ const candidate = new RTCIceCandidate(sd);
20
+ candidates.push(candidate);
21
+ let str = `${candidate.protocol} ${candidate.address}:${candidate.port} ${candidate.type}`;
22
+ if (candidate.protocol === 'tcp' && candidate.tcpType === 'passive') {
23
+ hasTcp = true;
24
+ str += ' (active)';
25
+ } else if (candidate.protocol === 'udp' && candidate.address) {
26
+ if (isIPPrivate(candidate.address)) {
27
+ str += ' (private)';
28
+ } else {
29
+ hasIpv4Udp = true;
30
+ }
31
+ }
32
+ this.appendMessage(str);
33
+ }
34
+ if (prevTrickle) {
35
+ prevTrickle(sd, target);
36
+ }
37
+ };
38
+
39
+ if (this.room.engine.subscriber) {
40
+ this.room.engine.subscriber.pc.onicecandidateerror = (ev) => {
41
+ if (ev instanceof RTCPeerConnectionIceErrorEvent) {
42
+ this.appendWarning(
43
+ `error with ICE candidate: ${ev.errorCode} ${ev.errorText} ${ev.url}`,
44
+ );
45
+ }
46
+ };
47
+ }
48
+ });
49
+ try {
50
+ await this.connect();
51
+ console.log('now the room is connected');
52
+ } catch (err) {
53
+ this.appendWarning('ports need to be open on firewall in order to connect.');
54
+ throw err;
55
+ }
56
+ if (!hasTcp) {
57
+ this.appendWarning('Server is not configured for ICE/TCP');
58
+ }
59
+ if (!hasIpv4Udp) {
60
+ this.appendWarning(
61
+ 'No public IPv4 UDP candidates were found. Your server is likely not configured correctly',
62
+ );
63
+ }
64
+ }
65
+ }
66
+
67
+ function isIPPrivate(address: string): boolean {
68
+ const parts = address.split('.');
69
+ if (parts.length === 4) {
70
+ if (parts[0] === '10') {
71
+ return true;
72
+ } else if (parts[0] === '192' && parts[1] === '168') {
73
+ return true;
74
+ } else if (parts[0] === '172') {
75
+ const second = parseInt(parts[1], 10);
76
+ if (second >= 16 && second <= 31) {
77
+ return true;
78
+ }
79
+ }
80
+ }
81
+ return false;
82
+ }
@@ -0,0 +1,27 @@
1
+ import { SignalClient } from '../../api/SignalClient';
2
+ import { ServerInfo_Edition } from '../../proto/livekit_models_pb';
3
+ import { Checker } from './Checker';
4
+
5
+ export class WebSocketCheck extends Checker {
6
+ get description(): string {
7
+ return 'Connecting to signal connection via WebSocket';
8
+ }
9
+
10
+ protected async perform(): Promise<void> {
11
+ if (this.url.startsWith('ws:') || this.url.startsWith('http:')) {
12
+ this.appendWarning('Server is insecure, clients may block connections to it');
13
+ }
14
+
15
+ let signalClient = new SignalClient();
16
+ const joinRes = await signalClient.join(this.url, this.token, {
17
+ autoSubscribe: true,
18
+ maxRetries: 0,
19
+ e2eeEnabled: false,
20
+ });
21
+ this.appendMessage(`Connected to server, version ${joinRes.serverVersion}.`);
22
+ if (joinRes.serverInfo?.edition === ServerInfo_Edition.Cloud && joinRes.serverInfo?.region) {
23
+ this.appendMessage(`LiveKit Cloud: ${joinRes.serverInfo?.region}`);
24
+ }
25
+ await signalClient.close();
26
+ }
27
+ }