@stream-io/video-client 0.0.1-alpha.8 → 0.0.1-alpha.81

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 (234) hide show
  1. package/README.md +16 -4
  2. package/dist/index.browser.es.js +9049 -0
  3. package/dist/index.browser.es.js.map +1 -0
  4. package/dist/index.cjs.js +9109 -0
  5. package/dist/index.cjs.js.map +1 -0
  6. package/dist/index.d.ts +5 -8
  7. package/dist/index.es.js +9053 -0
  8. package/dist/index.es.js.map +1 -0
  9. package/dist/src/CallDropScheduler.d.ts +4 -9
  10. package/dist/src/StreamSfuClient.d.ts +1 -1
  11. package/dist/src/StreamVideoClient.d.ts +25 -88
  12. package/dist/src/ViewportTracker.d.ts +36 -0
  13. package/dist/src/config/defaultConfigs.d.ts +2 -2
  14. package/dist/src/config/index.d.ts +2 -0
  15. package/dist/src/config/types.d.ts +1 -1
  16. package/dist/src/coordinator/connection/client.d.ts +10 -14
  17. package/dist/src/coordinator/connection/connection.d.ts +0 -1
  18. package/dist/src/coordinator/connection/events.d.ts +5 -0
  19. package/dist/src/coordinator/connection/insights.d.ts +2 -2
  20. package/dist/src/coordinator/connection/token_manager.d.ts +4 -4
  21. package/dist/src/coordinator/connection/types.d.ts +9 -17
  22. package/dist/src/devices.d.ts +22 -0
  23. package/dist/src/events/call-permissions.d.ts +12 -0
  24. package/dist/src/events/call.d.ts +8 -7
  25. package/dist/src/events/index.d.ts +8 -0
  26. package/dist/src/events/internal.d.ts +2 -2
  27. package/dist/src/events/moderation.d.ts +14 -0
  28. package/dist/src/events/participant.d.ts +5 -6
  29. package/dist/src/events/reactions.d.ts +8 -0
  30. package/dist/src/events/recording.d.ts +10 -0
  31. package/dist/src/events/speaker.d.ts +3 -3
  32. package/dist/src/gen/coordinator/index.d.ts +2337 -774
  33. package/dist/src/gen/video/sfu/models/models.d.ts +32 -0
  34. package/dist/src/helpers/browsers.d.ts +4 -0
  35. package/dist/src/helpers/sound-detector.d.ts +1 -1
  36. package/dist/src/rpc/index.d.ts +0 -1
  37. package/dist/src/rtc/Call.d.ts +179 -35
  38. package/dist/src/rtc/CallType.d.ts +72 -0
  39. package/dist/src/rtc/Dispatcher.d.ts +8 -0
  40. package/dist/src/rtc/callEventHandlers.d.ts +2 -3
  41. package/dist/src/rtc/codecs.d.ts +2 -2
  42. package/dist/src/rtc/flows/join.d.ts +10 -0
  43. package/dist/src/rtc/publisher.d.ts +3 -1
  44. package/dist/src/rtc/types.d.ts +22 -3
  45. package/dist/src/rtc/videoLayers.d.ts +1 -11
  46. package/dist/src/sorting/__tests__/participant-data.d.ts +2 -0
  47. package/dist/src/sorting/__tests__/sorting.test.d.ts +1 -0
  48. package/dist/src/sorting/comparator.d.ts +37 -0
  49. package/dist/src/sorting/index.d.ts +3 -0
  50. package/dist/src/sorting/participants.d.ts +65 -0
  51. package/dist/src/sorting/presets.d.ts +13 -0
  52. package/dist/src/stats/state-store-stats-reporter.d.ts +2 -2
  53. package/dist/src/store/CallState.d.ts +190 -0
  54. package/dist/src/store/__tests__/CallState.test.d.ts +1 -0
  55. package/dist/src/store/index.d.ts +1 -0
  56. package/dist/src/store/rxUtils.d.ts +2 -1
  57. package/dist/src/store/stateStore.d.ts +18 -109
  58. package/docusaurus/docs/client/02-guides/01-authentication.mdx +10 -0
  59. package/docusaurus/docs/client/02-guides/02-call-lifecycle.mdx +10 -0
  60. package/docusaurus/docs/client/02-guides/03-call-engine.mdx +11 -0
  61. package/docusaurus/docs/client/02-guides/04-socket-events.mdx +10 -0
  62. package/docusaurus/docs/client/02-guides/05-joining-and-leaving-calls.mdx +8 -0
  63. package/docusaurus/docs/client/04-call-engine/01-overview.mdx +60 -0
  64. package/docusaurus/docs/client/04-call-engine/02-state-store.mdx +10 -0
  65. package/docusaurus/docs/client/05-advanced/03-permissions-and-capabilities.mdx +6 -0
  66. package/docusaurus/docs/client/SDKSpecific.jsx +10 -0
  67. package/generate-openapi.sh +18 -5
  68. package/index.ts +7 -10
  69. package/package.json +17 -14
  70. package/rollup.config.mjs +26 -3
  71. package/src/CallDropScheduler.ts +30 -35
  72. package/src/StreamSfuClient.ts +15 -7
  73. package/src/StreamVideoClient.ts +163 -353
  74. package/src/ViewportTracker.ts +112 -0
  75. package/src/__tests__/StreamVideoClient.test.ts +4 -78
  76. package/src/config/defaultConfigs.ts +2 -2
  77. package/src/config/index.ts +2 -0
  78. package/src/config/types.ts +1 -1
  79. package/src/coordinator/connection/client.ts +37 -46
  80. package/src/coordinator/connection/connection.ts +8 -10
  81. package/src/coordinator/connection/connection_fallback.ts +2 -0
  82. package/src/coordinator/connection/errors.ts +10 -0
  83. package/src/coordinator/connection/events.ts +5 -0
  84. package/src/coordinator/connection/token_manager.ts +23 -7
  85. package/src/coordinator/connection/types.ts +29 -18
  86. package/src/coordinator/connection/utils.ts +1 -0
  87. package/src/devices.ts +112 -5
  88. package/src/events/call-permissions.ts +83 -0
  89. package/src/events/call.ts +45 -37
  90. package/src/events/index.ts +8 -0
  91. package/src/events/internal.ts +2 -2
  92. package/src/events/moderation.ts +64 -0
  93. package/src/events/participant.ts +15 -24
  94. package/src/events/reactions.ts +42 -0
  95. package/src/events/recording.ts +41 -0
  96. package/src/events/speaker.ts +3 -3
  97. package/src/gen/coordinator/index.ts +2271 -745
  98. package/src/gen/video/sfu/models/models.ts +64 -4
  99. package/src/helpers/browsers.ts +12 -2
  100. package/src/helpers/sound-detector.ts +17 -2
  101. package/src/rpc/createClient.ts +1 -1
  102. package/src/rpc/index.ts +0 -1
  103. package/src/rtc/Call.ts +686 -127
  104. package/src/rtc/CallType.ts +123 -0
  105. package/src/rtc/Dispatcher.ts +8 -0
  106. package/src/rtc/callEventHandlers.ts +7 -9
  107. package/src/rtc/codecs.ts +28 -15
  108. package/src/rtc/flows/join.ts +87 -0
  109. package/src/rtc/publisher.ts +25 -1
  110. package/src/rtc/types.ts +36 -3
  111. package/src/rtc/videoLayers.ts +2 -2
  112. package/src/sorting/__tests__/participant-data.ts +99 -0
  113. package/src/sorting/__tests__/sorting.test.ts +46 -0
  114. package/src/sorting/comparator.ts +62 -0
  115. package/src/sorting/index.ts +3 -0
  116. package/src/sorting/participants.ts +129 -0
  117. package/src/sorting/presets.ts +62 -0
  118. package/src/stats/state-store-stats-reporter.ts +2 -2
  119. package/src/store/CallState.ts +345 -0
  120. package/src/store/__tests__/CallState.test.ts +105 -0
  121. package/src/store/index.ts +1 -0
  122. package/src/store/rxUtils.ts +3 -4
  123. package/src/store/stateStore.ts +32 -220
  124. package/coverage/lcov-report/base.css +0 -224
  125. package/coverage/lcov-report/block-navigation.js +0 -87
  126. package/coverage/lcov-report/favicon.png +0 -0
  127. package/coverage/lcov-report/index.html +0 -296
  128. package/coverage/lcov-report/prettify.css +0 -1
  129. package/coverage/lcov-report/prettify.js +0 -2
  130. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  131. package/coverage/lcov-report/sorter.js +0 -196
  132. package/coverage/lcov-report/src/Batcher.ts.html +0 -214
  133. package/coverage/lcov-report/src/CallDropScheduler.ts.html +0 -661
  134. package/coverage/lcov-report/src/StreamSfuClient.ts.html +0 -640
  135. package/coverage/lcov-report/src/StreamVideoClient.ts.html +0 -1546
  136. package/coverage/lcov-report/src/config/defaultConfigs.ts.html +0 -130
  137. package/coverage/lcov-report/src/config/index.html +0 -116
  138. package/coverage/lcov-report/src/coordinator/StreamCoordinatorClient.ts.html +0 -418
  139. package/coverage/lcov-report/src/coordinator/connection/base64.ts.html +0 -325
  140. package/coverage/lcov-report/src/coordinator/connection/client.ts.html +0 -2530
  141. package/coverage/lcov-report/src/coordinator/connection/connection.ts.html +0 -2335
  142. package/coverage/lcov-report/src/coordinator/connection/connection_fallback.ts.html +0 -802
  143. package/coverage/lcov-report/src/coordinator/connection/errors.ts.html +0 -295
  144. package/coverage/lcov-report/src/coordinator/connection/index.html +0 -251
  145. package/coverage/lcov-report/src/coordinator/connection/insights.ts.html +0 -349
  146. package/coverage/lcov-report/src/coordinator/connection/signing.ts.html +0 -397
  147. package/coverage/lcov-report/src/coordinator/connection/token_manager.ts.html +0 -565
  148. package/coverage/lcov-report/src/coordinator/connection/types.ts.html +0 -445
  149. package/coverage/lcov-report/src/coordinator/connection/utils.ts.html +0 -529
  150. package/coverage/lcov-report/src/coordinator/index.html +0 -116
  151. package/coverage/lcov-report/src/events/call.ts.html +0 -583
  152. package/coverage/lcov-report/src/events/index.html +0 -161
  153. package/coverage/lcov-report/src/events/internal.ts.html +0 -226
  154. package/coverage/lcov-report/src/events/participant.ts.html +0 -376
  155. package/coverage/lcov-report/src/events/speaker.ts.html +0 -271
  156. package/coverage/lcov-report/src/gen/google/protobuf/index.html +0 -131
  157. package/coverage/lcov-report/src/gen/google/protobuf/struct.ts.html +0 -1528
  158. package/coverage/lcov-report/src/gen/google/protobuf/timestamp.ts.html +0 -958
  159. package/coverage/lcov-report/src/gen/video/sfu/event/events.ts.html +0 -5971
  160. package/coverage/lcov-report/src/gen/video/sfu/event/index.html +0 -116
  161. package/coverage/lcov-report/src/gen/video/sfu/models/index.html +0 -116
  162. package/coverage/lcov-report/src/gen/video/sfu/models/models.ts.html +0 -3271
  163. package/coverage/lcov-report/src/index.html +0 -161
  164. package/coverage/lcov-report/src/rpc/index.html +0 -131
  165. package/coverage/lcov-report/src/rpc/index.ts.html +0 -91
  166. package/coverage/lcov-report/src/rpc/latency.ts.html +0 -214
  167. package/coverage/lcov-report/src/rtc/Call.ts.html +0 -1840
  168. package/coverage/lcov-report/src/rtc/CallMetadata.ts.html +0 -157
  169. package/coverage/lcov-report/src/rtc/Dispatcher.ts.html +0 -223
  170. package/coverage/lcov-report/src/rtc/IceTrickleBuffer.ts.html +0 -148
  171. package/coverage/lcov-report/src/rtc/callEventHandlers.ts.html +0 -196
  172. package/coverage/lcov-report/src/rtc/codecs.ts.html +0 -268
  173. package/coverage/lcov-report/src/rtc/helpers/iceCandidate.ts.html +0 -133
  174. package/coverage/lcov-report/src/rtc/helpers/index.html +0 -131
  175. package/coverage/lcov-report/src/rtc/helpers/tracks.ts.html +0 -139
  176. package/coverage/lcov-report/src/rtc/index.html +0 -251
  177. package/coverage/lcov-report/src/rtc/publisher.ts.html +0 -1000
  178. package/coverage/lcov-report/src/rtc/signal.ts.html +0 -187
  179. package/coverage/lcov-report/src/rtc/subscriber.ts.html +0 -340
  180. package/coverage/lcov-report/src/rtc/videoLayers.ts.html +0 -394
  181. package/coverage/lcov-report/src/stats/index.html +0 -116
  182. package/coverage/lcov-report/src/stats/state-store-stats-reporter.ts.html +0 -1177
  183. package/coverage/lcov-report/src/store/index.html +0 -146
  184. package/coverage/lcov-report/src/store/index.ts.html +0 -91
  185. package/coverage/lcov-report/src/store/rxUtils.ts.html +0 -211
  186. package/coverage/lcov-report/src/store/stateStore.ts.html +0 -1108
  187. package/coverage/lcov.info +0 -11453
  188. package/coverage/tmp/coverage-2174-1675940044783-2.json +0 -1
  189. package/dist/index.js +0 -14663
  190. package/dist/index.js.map +0 -1
  191. package/dist/src/Batcher.d.ts +0 -12
  192. package/dist/src/coordinator/StreamCoordinatorClient.d.ts +0 -19
  193. package/dist/src/gen/google/protobuf/descriptor.d.ts +0 -1650
  194. package/dist/src/gen/google/protobuf/duration.d.ts +0 -113
  195. package/dist/src/gen/video/coordinator/broadcast_v1/broadcast.d.ts +0 -66
  196. package/dist/src/gen/video/coordinator/call_v1/call.d.ts +0 -254
  197. package/dist/src/gen/video/coordinator/client_v1_rpc/client_rpc.client.d.ts +0 -351
  198. package/dist/src/gen/video/coordinator/client_v1_rpc/client_rpc.d.ts +0 -1488
  199. package/dist/src/gen/video/coordinator/client_v1_rpc/envelopes.d.ts +0 -143
  200. package/dist/src/gen/video/coordinator/client_v1_rpc/websocket.d.ts +0 -292
  201. package/dist/src/gen/video/coordinator/edge_v1/edge.d.ts +0 -183
  202. package/dist/src/gen/video/coordinator/event_v1/event.d.ts +0 -411
  203. package/dist/src/gen/video/coordinator/geofence_v1/geofence.d.ts +0 -63
  204. package/dist/src/gen/video/coordinator/member_v1/member.d.ts +0 -59
  205. package/dist/src/gen/video/coordinator/participant_v1/participant.d.ts +0 -103
  206. package/dist/src/gen/video/coordinator/push_v1/push.d.ts +0 -240
  207. package/dist/src/gen/video/coordinator/stat_v1/stat.d.ts +0 -308
  208. package/dist/src/gen/video/coordinator/user_v1/user.d.ts +0 -112
  209. package/dist/src/gen/video/coordinator/utils_v1/utils.d.ts +0 -47
  210. package/dist/src/rtc/CallMetadata.d.ts +0 -9
  211. package/dist/src/stats/coordinator-stats-reporter.d.ts +0 -10
  212. package/src/Batcher.ts +0 -43
  213. package/src/coordinator/StreamCoordinatorClient.ts +0 -111
  214. package/src/gen/google/protobuf/descriptor.ts +0 -3466
  215. package/src/gen/google/protobuf/duration.ts +0 -232
  216. package/src/gen/video/coordinator/broadcast_v1/broadcast.ts +0 -154
  217. package/src/gen/video/coordinator/call_v1/call.ts +0 -651
  218. package/src/gen/video/coordinator/client_v1_rpc/client_rpc.client.ts +0 -463
  219. package/src/gen/video/coordinator/client_v1_rpc/client_rpc.ts +0 -3819
  220. package/src/gen/video/coordinator/client_v1_rpc/envelopes.ts +0 -424
  221. package/src/gen/video/coordinator/client_v1_rpc/websocket.ts +0 -719
  222. package/src/gen/video/coordinator/edge_v1/edge.ts +0 -532
  223. package/src/gen/video/coordinator/event_v1/event.ts +0 -1171
  224. package/src/gen/video/coordinator/geofence_v1/geofence.ts +0 -128
  225. package/src/gen/video/coordinator/member_v1/member.ts +0 -138
  226. package/src/gen/video/coordinator/participant_v1/participant.ts +0 -261
  227. package/src/gen/video/coordinator/push_v1/push.ts +0 -651
  228. package/src/gen/video/coordinator/stat_v1/stat.ts +0 -656
  229. package/src/gen/video/coordinator/user_v1/user.ts +0 -277
  230. package/src/gen/video/coordinator/utils_v1/utils.ts +0 -98
  231. package/src/rtc/CallMetadata.ts +0 -24
  232. package/src/stats/coordinator-stats-reporter.ts +0 -167
  233. /package/dist/src/{rpc → rtc/flows}/latency.d.ts +0 -0
  234. /package/src/{rpc → rtc/flows}/latency.ts +0 -0
package/README.md CHANGED
@@ -4,11 +4,23 @@
4
4
 
5
5
  This package holds the autogenerated Protobuf code and clients.
6
6
 
7
- ## Generate the client
7
+ ## Generate Coordinator Models from OpenAPI spec (Dev Mode):
8
8
 
9
- 1. Follow the instructions in [GetStream/video-proto](https://github.com/getstream/video-proto)
10
- 2. Copy the generated files into `./src/gen/` and commit them to this repository
9
+ We have a shell script which will generate the Coordinator models from the OpenAPI spec.
10
+ This script expects the following directory structure to be set up:
11
+
12
+ - `chat` - the `chat` repository
13
+ - `stream-video-js` - current repository
14
+ - `cd stream-video-js/packages/client && yarn generate:open-api`
11
15
 
12
16
  ## Documentation
13
17
 
14
- API reference documentation can be generated using the `yarn run generate-docs:client`, the generated documentation will be inside the `generated-docs` folder.
18
+ API reference documentation can be generated using the `yarn run generate-docs:client`,
19
+ the generated documentation will be inside the `generated-docs` folder.
20
+
21
+ To view the documentation locally, run the following in the root of the respective SDK React/React Native.
22
+
23
+ ```bash
24
+ yarn generate-docs
25
+ `npx stream-chat-docusaurus -s`
26
+ ```