@stream-io/video-client 0.0.1-alpha.9 → 0.0.1-alpha.90

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 (242) hide show
  1. package/README.md +16 -4
  2. package/dist/index.browser.es.js +9470 -0
  3. package/dist/index.browser.es.js.map +1 -0
  4. package/dist/index.cjs.js +9530 -0
  5. package/dist/index.cjs.js.map +1 -0
  6. package/dist/index.d.ts +5 -8
  7. package/dist/index.es.js +9474 -0
  8. package/dist/index.es.js.map +1 -0
  9. package/dist/src/StreamSfuClient.d.ts +41 -11
  10. package/dist/src/StreamVideoClient.d.ts +27 -91
  11. package/dist/src/ViewportTracker.d.ts +36 -0
  12. package/dist/src/config/defaultConfigs.d.ts +2 -2
  13. package/dist/src/config/index.d.ts +2 -0
  14. package/dist/src/config/types.d.ts +1 -13
  15. package/dist/src/coordinator/connection/client.d.ts +16 -20
  16. package/dist/src/coordinator/connection/connection.d.ts +8 -8
  17. package/dist/src/coordinator/connection/connection_fallback.d.ts +3 -2
  18. package/dist/src/coordinator/connection/insights.d.ts +2 -3
  19. package/dist/src/coordinator/connection/token_manager.d.ts +4 -4
  20. package/dist/src/coordinator/connection/types.d.ts +28 -32
  21. package/dist/src/coordinator/connection/utils.d.ts +4 -1
  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 +2331 -748
  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/createClient.d.ts +1 -1
  37. package/dist/src/rpc/index.d.ts +0 -1
  38. package/dist/src/rtc/Call.d.ts +196 -35
  39. package/dist/src/rtc/CallType.d.ts +72 -0
  40. package/dist/src/rtc/Dispatcher.d.ts +10 -0
  41. package/dist/src/rtc/callEventHandlers.d.ts +2 -3
  42. package/dist/src/rtc/codecs.d.ts +2 -2
  43. package/dist/src/rtc/flows/join.d.ts +10 -0
  44. package/dist/src/rtc/publisher.d.ts +10 -3
  45. package/dist/src/rtc/signal.d.ts +1 -1
  46. package/dist/src/rtc/subscriber.d.ts +3 -1
  47. package/dist/src/rtc/types.d.ts +22 -3
  48. package/dist/src/rtc/videoLayers.d.ts +1 -11
  49. package/dist/src/sorting/__tests__/participant-data.d.ts +2 -0
  50. package/dist/src/sorting/__tests__/sorting.test.d.ts +1 -0
  51. package/dist/src/sorting/comparator.d.ts +37 -0
  52. package/dist/src/sorting/index.d.ts +3 -0
  53. package/dist/src/sorting/participants.d.ts +65 -0
  54. package/dist/src/sorting/presets.d.ts +13 -0
  55. package/dist/src/stats/state-store-stats-reporter.d.ts +3 -3
  56. package/dist/src/store/CallState.d.ts +339 -0
  57. package/dist/src/store/__tests__/CallState.test.d.ts +1 -0
  58. package/dist/src/store/index.d.ts +1 -0
  59. package/dist/src/store/rxUtils.d.ts +5 -1
  60. package/dist/src/store/stateStore.d.ts +83 -95
  61. package/docusaurus/docs/client/02-guides/01-authentication.mdx +10 -0
  62. package/docusaurus/docs/client/02-guides/02-call-lifecycle.mdx +10 -0
  63. package/docusaurus/docs/client/02-guides/03-call-engine.mdx +11 -0
  64. package/docusaurus/docs/client/02-guides/04-socket-events.mdx +10 -0
  65. package/docusaurus/docs/client/02-guides/05-joining-and-leaving-calls.mdx +8 -0
  66. package/docusaurus/docs/client/04-call-engine/01-overview.mdx +60 -0
  67. package/docusaurus/docs/client/04-call-engine/02-state-store.mdx +10 -0
  68. package/docusaurus/docs/client/05-advanced/03-permissions-and-capabilities.mdx +6 -0
  69. package/docusaurus/docs/client/SDKSpecific.jsx +10 -0
  70. package/generate-openapi.sh +18 -5
  71. package/index.ts +7 -10
  72. package/package.json +20 -19
  73. package/rollup.config.mjs +26 -3
  74. package/src/StreamSfuClient.ts +183 -55
  75. package/src/StreamVideoClient.ts +138 -366
  76. package/src/ViewportTracker.ts +112 -0
  77. package/src/__tests__/StreamVideoClient.test.ts +4 -78
  78. package/src/config/defaultConfigs.ts +2 -3
  79. package/src/config/index.ts +2 -0
  80. package/src/config/types.ts +1 -13
  81. package/src/coordinator/connection/client.ts +44 -53
  82. package/src/coordinator/connection/connection.ts +22 -20
  83. package/src/coordinator/connection/connection_fallback.ts +6 -3
  84. package/src/coordinator/connection/errors.ts +10 -0
  85. package/src/coordinator/connection/token_manager.ts +23 -7
  86. package/src/coordinator/connection/types.ts +78 -37
  87. package/src/coordinator/connection/utils.ts +7 -4
  88. package/src/devices.ts +112 -5
  89. package/src/events/call-permissions.ts +85 -0
  90. package/src/events/call.ts +78 -59
  91. package/src/events/index.ts +8 -0
  92. package/src/events/internal.ts +3 -3
  93. package/src/events/moderation.ts +64 -0
  94. package/src/events/participant.ts +19 -30
  95. package/src/events/reactions.ts +45 -0
  96. package/src/events/recording.ts +44 -0
  97. package/src/events/speaker.ts +7 -7
  98. package/src/gen/coordinator/index.ts +2294 -748
  99. package/src/gen/video/sfu/models/models.ts +64 -4
  100. package/src/helpers/browsers.ts +12 -2
  101. package/src/helpers/sound-detector.ts +17 -2
  102. package/src/rpc/createClient.ts +3 -2
  103. package/src/rpc/index.ts +0 -1
  104. package/src/rtc/Call.ts +895 -145
  105. package/src/rtc/CallType.ts +123 -0
  106. package/src/rtc/Dispatcher.ts +32 -0
  107. package/src/rtc/callEventHandlers.ts +7 -9
  108. package/src/rtc/codecs.ts +28 -15
  109. package/src/rtc/flows/join.ts +87 -0
  110. package/src/rtc/publisher.ts +63 -25
  111. package/src/rtc/signal.ts +23 -23
  112. package/src/rtc/subscriber.ts +39 -23
  113. package/src/rtc/types.ts +36 -3
  114. package/src/rtc/videoLayers.ts +2 -2
  115. package/src/sorting/__tests__/participant-data.ts +99 -0
  116. package/src/sorting/__tests__/sorting.test.ts +46 -0
  117. package/src/sorting/comparator.ts +62 -0
  118. package/src/sorting/index.ts +3 -0
  119. package/src/sorting/participants.ts +129 -0
  120. package/src/sorting/presets.ts +62 -0
  121. package/src/stats/state-store-stats-reporter.ts +6 -10
  122. package/src/store/CallState.ts +561 -0
  123. package/src/store/__tests__/CallState.test.ts +104 -0
  124. package/src/store/index.ts +1 -0
  125. package/src/store/rxUtils.ts +8 -7
  126. package/src/store/stateStore.ts +145 -210
  127. package/tsconfig.json +2 -0
  128. package/coverage/lcov-report/base.css +0 -224
  129. package/coverage/lcov-report/block-navigation.js +0 -87
  130. package/coverage/lcov-report/favicon.png +0 -0
  131. package/coverage/lcov-report/index.html +0 -296
  132. package/coverage/lcov-report/prettify.css +0 -1
  133. package/coverage/lcov-report/prettify.js +0 -2
  134. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  135. package/coverage/lcov-report/sorter.js +0 -196
  136. package/coverage/lcov-report/src/Batcher.ts.html +0 -214
  137. package/coverage/lcov-report/src/CallDropScheduler.ts.html +0 -661
  138. package/coverage/lcov-report/src/StreamSfuClient.ts.html +0 -640
  139. package/coverage/lcov-report/src/StreamVideoClient.ts.html +0 -1546
  140. package/coverage/lcov-report/src/config/defaultConfigs.ts.html +0 -130
  141. package/coverage/lcov-report/src/config/index.html +0 -116
  142. package/coverage/lcov-report/src/coordinator/StreamCoordinatorClient.ts.html +0 -418
  143. package/coverage/lcov-report/src/coordinator/connection/base64.ts.html +0 -325
  144. package/coverage/lcov-report/src/coordinator/connection/client.ts.html +0 -2530
  145. package/coverage/lcov-report/src/coordinator/connection/connection.ts.html +0 -2335
  146. package/coverage/lcov-report/src/coordinator/connection/connection_fallback.ts.html +0 -802
  147. package/coverage/lcov-report/src/coordinator/connection/errors.ts.html +0 -295
  148. package/coverage/lcov-report/src/coordinator/connection/index.html +0 -251
  149. package/coverage/lcov-report/src/coordinator/connection/insights.ts.html +0 -349
  150. package/coverage/lcov-report/src/coordinator/connection/signing.ts.html +0 -397
  151. package/coverage/lcov-report/src/coordinator/connection/token_manager.ts.html +0 -565
  152. package/coverage/lcov-report/src/coordinator/connection/types.ts.html +0 -445
  153. package/coverage/lcov-report/src/coordinator/connection/utils.ts.html +0 -529
  154. package/coverage/lcov-report/src/coordinator/index.html +0 -116
  155. package/coverage/lcov-report/src/events/call.ts.html +0 -583
  156. package/coverage/lcov-report/src/events/index.html +0 -161
  157. package/coverage/lcov-report/src/events/internal.ts.html +0 -226
  158. package/coverage/lcov-report/src/events/participant.ts.html +0 -376
  159. package/coverage/lcov-report/src/events/speaker.ts.html +0 -271
  160. package/coverage/lcov-report/src/gen/google/protobuf/index.html +0 -131
  161. package/coverage/lcov-report/src/gen/google/protobuf/struct.ts.html +0 -1528
  162. package/coverage/lcov-report/src/gen/google/protobuf/timestamp.ts.html +0 -958
  163. package/coverage/lcov-report/src/gen/video/sfu/event/events.ts.html +0 -5971
  164. package/coverage/lcov-report/src/gen/video/sfu/event/index.html +0 -116
  165. package/coverage/lcov-report/src/gen/video/sfu/models/index.html +0 -116
  166. package/coverage/lcov-report/src/gen/video/sfu/models/models.ts.html +0 -3271
  167. package/coverage/lcov-report/src/index.html +0 -161
  168. package/coverage/lcov-report/src/rpc/index.html +0 -131
  169. package/coverage/lcov-report/src/rpc/index.ts.html +0 -91
  170. package/coverage/lcov-report/src/rpc/latency.ts.html +0 -214
  171. package/coverage/lcov-report/src/rtc/Call.ts.html +0 -1840
  172. package/coverage/lcov-report/src/rtc/CallMetadata.ts.html +0 -157
  173. package/coverage/lcov-report/src/rtc/Dispatcher.ts.html +0 -223
  174. package/coverage/lcov-report/src/rtc/IceTrickleBuffer.ts.html +0 -148
  175. package/coverage/lcov-report/src/rtc/callEventHandlers.ts.html +0 -196
  176. package/coverage/lcov-report/src/rtc/codecs.ts.html +0 -268
  177. package/coverage/lcov-report/src/rtc/helpers/iceCandidate.ts.html +0 -133
  178. package/coverage/lcov-report/src/rtc/helpers/index.html +0 -131
  179. package/coverage/lcov-report/src/rtc/helpers/tracks.ts.html +0 -139
  180. package/coverage/lcov-report/src/rtc/index.html +0 -251
  181. package/coverage/lcov-report/src/rtc/publisher.ts.html +0 -1000
  182. package/coverage/lcov-report/src/rtc/signal.ts.html +0 -187
  183. package/coverage/lcov-report/src/rtc/subscriber.ts.html +0 -340
  184. package/coverage/lcov-report/src/rtc/videoLayers.ts.html +0 -394
  185. package/coverage/lcov-report/src/stats/index.html +0 -116
  186. package/coverage/lcov-report/src/stats/state-store-stats-reporter.ts.html +0 -1177
  187. package/coverage/lcov-report/src/store/index.html +0 -146
  188. package/coverage/lcov-report/src/store/index.ts.html +0 -91
  189. package/coverage/lcov-report/src/store/rxUtils.ts.html +0 -211
  190. package/coverage/lcov-report/src/store/stateStore.ts.html +0 -1108
  191. package/coverage/lcov.info +0 -11453
  192. package/coverage/tmp/coverage-2259-1675940295953-2.json +0 -1
  193. package/dist/index.js +0 -14663
  194. package/dist/index.js.map +0 -1
  195. package/dist/src/Batcher.d.ts +0 -12
  196. package/dist/src/CallDropScheduler.d.ts +0 -44
  197. package/dist/src/coordinator/StreamCoordinatorClient.d.ts +0 -19
  198. package/dist/src/coordinator/connection/events.d.ts +0 -7
  199. package/dist/src/gen/google/protobuf/descriptor.d.ts +0 -1650
  200. package/dist/src/gen/google/protobuf/duration.d.ts +0 -113
  201. package/dist/src/gen/video/coordinator/broadcast_v1/broadcast.d.ts +0 -66
  202. package/dist/src/gen/video/coordinator/call_v1/call.d.ts +0 -254
  203. package/dist/src/gen/video/coordinator/client_v1_rpc/client_rpc.client.d.ts +0 -351
  204. package/dist/src/gen/video/coordinator/client_v1_rpc/client_rpc.d.ts +0 -1488
  205. package/dist/src/gen/video/coordinator/client_v1_rpc/envelopes.d.ts +0 -143
  206. package/dist/src/gen/video/coordinator/client_v1_rpc/websocket.d.ts +0 -292
  207. package/dist/src/gen/video/coordinator/edge_v1/edge.d.ts +0 -183
  208. package/dist/src/gen/video/coordinator/event_v1/event.d.ts +0 -411
  209. package/dist/src/gen/video/coordinator/geofence_v1/geofence.d.ts +0 -63
  210. package/dist/src/gen/video/coordinator/member_v1/member.d.ts +0 -59
  211. package/dist/src/gen/video/coordinator/participant_v1/participant.d.ts +0 -103
  212. package/dist/src/gen/video/coordinator/push_v1/push.d.ts +0 -240
  213. package/dist/src/gen/video/coordinator/stat_v1/stat.d.ts +0 -308
  214. package/dist/src/gen/video/coordinator/user_v1/user.d.ts +0 -112
  215. package/dist/src/gen/video/coordinator/utils_v1/utils.d.ts +0 -47
  216. package/dist/src/rtc/CallMetadata.d.ts +0 -9
  217. package/dist/src/stats/coordinator-stats-reporter.d.ts +0 -10
  218. package/src/Batcher.ts +0 -43
  219. package/src/CallDropScheduler.ts +0 -192
  220. package/src/coordinator/StreamCoordinatorClient.ts +0 -111
  221. package/src/coordinator/connection/events.ts +0 -10
  222. package/src/gen/google/protobuf/descriptor.ts +0 -3466
  223. package/src/gen/google/protobuf/duration.ts +0 -232
  224. package/src/gen/video/coordinator/broadcast_v1/broadcast.ts +0 -154
  225. package/src/gen/video/coordinator/call_v1/call.ts +0 -651
  226. package/src/gen/video/coordinator/client_v1_rpc/client_rpc.client.ts +0 -463
  227. package/src/gen/video/coordinator/client_v1_rpc/client_rpc.ts +0 -3819
  228. package/src/gen/video/coordinator/client_v1_rpc/envelopes.ts +0 -424
  229. package/src/gen/video/coordinator/client_v1_rpc/websocket.ts +0 -719
  230. package/src/gen/video/coordinator/edge_v1/edge.ts +0 -532
  231. package/src/gen/video/coordinator/event_v1/event.ts +0 -1171
  232. package/src/gen/video/coordinator/geofence_v1/geofence.ts +0 -128
  233. package/src/gen/video/coordinator/member_v1/member.ts +0 -138
  234. package/src/gen/video/coordinator/participant_v1/participant.ts +0 -261
  235. package/src/gen/video/coordinator/push_v1/push.ts +0 -651
  236. package/src/gen/video/coordinator/stat_v1/stat.ts +0 -656
  237. package/src/gen/video/coordinator/user_v1/user.ts +0 -277
  238. package/src/gen/video/coordinator/utils_v1/utils.ts +0 -98
  239. package/src/rtc/CallMetadata.ts +0 -24
  240. package/src/stats/coordinator-stats-reporter.ts +0 -167
  241. /package/dist/src/{rpc → rtc/flows}/latency.d.ts +0 -0
  242. /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
+ ```