@stream-io/video-client 0.1.4 → 0.1.6

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+### [0.1.6](https://github.com/GetStream/stream-video-js/compare/client0.1.5...client0.1.6) (2023-07-26)
+
+
+### Documentation
+
+* Readme for js client, contributing guide ([#858](https://github.com/GetStream/stream-video-js/issues/858)) ([4d25c90](https://github.com/GetStream/stream-video-js/commit/4d25c909d2db3c5f98f89ad37dd810fc4ab7cc95))
+
+### [0.1.5](https://github.com/GetStream/stream-video-js/compare/client0.1.4...client0.1.5) (2023-07-21)
+
+
+### Bug Fixes
+
+* strict mode issue ([#740](https://github.com/GetStream/stream-video-js/issues/740)) ([c39e4e4](https://github.com/GetStream/stream-video-js/commit/c39e4e4041a2326393478ad808b2aa791d50f8ce))
+
 ### [0.1.4](https://github.com/GetStream/stream-video-js/compare/client0.1.3...client0.1.4) (2023-07-21)
 
 

package/README.md

@@ -1,14 +1,60 @@
 # @stream-io/video-client
 
-🚧 **WARNING** This package is not yet stable, it is for internal use only. For more information check out our [video product page](https://getstream.io/video/).
+🚧 **WARNING** This package is not yet stable, it is for internal use only. For more information check out our [video product page](https://getstream.io/video/). 🚧
 
-This package holds the autogenerated Protobuf code and clients.
+Low-level video client for browser and Node.js integrations.
 
-## Generate Coordinator Models from OpenAPI spec (Dev Mode):
+## **Quick Links**
 
-We have a shell script which will generate the Coordinator models from the OpenAPI spec.
-This script expects the following directory structure to be set up:
+- [Register](https://getstream.io/chat/trial/) to get an API key for Stream Video
+  TODO: add links to docs and tutorials
 
-- `chat` - the `chat` repository
-- `stream-video-js` - current repository
-- `cd stream-video-js/packages/client && yarn generate:open-api`
+## What is Stream?
+
+Stream allows developers to rapidly deploy scalable feeds, chat messaging and video with an industry leading 99.999% uptime SLA guarantee.
+
+With Stream's video components, you can use their SDK to build in-app video calling, audio rooms, audio calls, or live streaming. The best place to get started is with their tutorials:
+
+- Video & Audio Calling Tutorial
+- Audio Rooms Tutorial
+- Livestreaming Tutorial
+
+Stream provides UI components and state handling that make it easy to build video calling for your app. All calls run on Stream's network of edge servers around the world, ensuring optimal latency and reliability.
+
+## 👩‍💻 Free for Makers 👨‍💻
+
+Stream is free for most side and hobby projects. To qualify, your project/company needs to have < 5 team members and < $10k in monthly revenue. Makers get $100 in monthly credit for video for free.
+
+## 💡Supported Features💡
+
+Here are some of the features we support:
+
+- Developer experience: Great SDKs, docs, tutorials and support so you can build quickly
+- Edge network: Servers around the world ensure optimal latency and reliability
+- Chat: Stored chat, reactions, threads, typing indicators, URL previews etc
+- Security & Privacy: Based in USA and EU, Soc2 certified, GDPR compliant
+- Dynascale: Automatically switch resolutions, fps, bitrate, codecs and paginate video on large calls
+- Screen sharing
+- Picture in picture support
+- Active speaker
+- Custom events
+- Geofencing
+- Notifications and ringing calls
+- Opus DTX & Red for reliable audio
+- Webhooks & SQS
+- Backstage mode
+- Flexible permissions system
+- Joining calls by ID, link or invite
+- Enabling and disabling audio and video when in calls
+- Flipping, Enabling and disabling camera in calls
+- Enabling and disabling speakerphone in calls
+- Push notification providers support
+- Call recording
+- Broadcasting to HLS
+
+## Contributing
+
+- How can I submit a sample app?
+  - Apps submissions are always welcome. 🥳 Open a PR with a proper description and we'll review it as soon as possible.
+- Spot a bug 🕷 ?
+  - We welcome code changes that improve the apps or fix a problem. Please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github.

package/dist/index.browser.es.js

@@ -4,7 +4,7 @@ import { ServiceType, stackIntercept } from '@protobuf-ts/runtime-rpc';
 import axios, { AxiosHeaders } from 'axios';
 export { AxiosError } from 'axios';
 import { TwirpFetchTransport } from '@protobuf-ts/twirp-transport';
-import { ReplaySubject, BehaviorSubject, takeWhile, pairwise, tap, debounce, timer, map as map$2, Observable, debounceTime, concatMap, from, shareReplay, merge, combineLatest, filter } from 'rxjs';
+import { ReplaySubject, BehaviorSubject, takeWhile, filter, pairwise, tap, debounce, timer, map as map$2, Observable, debounceTime, concatMap, from, shareReplay, merge, combineLatest } from 'rxjs';
 import * as SDP from 'sdp-transform';
 import WebSocket from 'isomorphic-ws';
 import { take, map as map$1, distinctUntilChanged } from 'rxjs/operators';
@@ -9465,11 +9465,13 @@ class Call {
          */
         this.leave = ({ reject = false } = {}) => __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
-            // TODO: handle case when leave is called during JOINING
             const callingState = this.state.callingState;
             if (callingState === CallingState.LEFT) {
                 throw new Error('Cannot leave call that has already been left.');
             }
+            if (callingState === CallingState.JOINING) {
+                yield this.assertCallJoined();
+            }
             if (this.ringing) {
                 // I'm the one who started the call, so I should cancel it.
                 const hasOtherParticipants = this.state.remoteParticipants.length > 0;
@@ -9875,13 +9877,6 @@ class Call {
                 }, timeout);
             });
         };
-        this.assertCallJoined = () => {
-            return new Promise((resolve) => {
-                this.state.callingState$
-                    .pipe(takeWhile((state) => state !== CallingState.JOINED, true))
-                    .subscribe(() => resolve());
-            });
-        };
         /**
          * Starts publishing the given video stream to the call.
          * The stream will be stopped if the user changes an input device, or if the user leaves the call.
@@ -10112,6 +10107,13 @@ class Call {
             var _h;
             return (_h = this.publisher) === null || _h === void 0 ? void 0 : _h.updateVideoPublishQuality(enabledRids);
         });
+        this.assertCallJoined = () => {
+            return new Promise((resolve) => {
+                this.state.callingState$
+                    .pipe(takeWhile((state) => state !== CallingState.JOINED, true), filter((s) => s === CallingState.JOINED))
+                    .subscribe(() => resolve());
+            });
+        };
         /**
          * Sends a reaction to the other call participants.
          *
@@ -10323,7 +10325,7 @@ class Call {
          * @returns
          */
         this.queryMembers = (request) => {
-            return this.streamClient.post('/call/members', Object.assign(Object.assign({}, request), { id: this.id, type: this.type }));
+            return this.streamClient.post('/call/members', Object.assign(Object.assign({}, (request || {})), { id: this.id, type: this.type }));
         };
         /**
          * Will update the call members.
@@ -11634,7 +11636,7 @@ class WSConnectionFallback {
     }
 }
 
-const version = '0.1.4';
+const version = '0.1.6';
 
 const logger = getLogger(['location']);
 const HINT_URL = `https://hint.stream-io-video.com/`;
@@ -11697,14 +11699,6 @@ class StreamClient {
         });
         this._getConnectionID = () => { var _a, _b; return ((_a = this.wsConnection) === null || _a === void 0 ? void 0 : _a.connectionID) || ((_b = this.wsFallback) === null || _b === void 0 ? void 0 : _b.connectionID); };
         this._hasConnectionID = () => Boolean(this._getConnectionID());
-        /**
-         * This will start a promise to hold API calls until `connectUser` is called, useful when user is set in `StreamVideoClient constructor`
-         */
-        this.startWaitingForConnection = () => {
-            this.waitForConnectPromise = new Promise((resolve) => {
-                this.resolveConnectPromise = resolve;
-            });
-        };
         /**
          * connectUser - Set the current user and open a WebSocket connection
          *
@@ -11739,11 +11733,6 @@ class StreamClient {
             this._setUser(user);
             const wsPromise = this.openConnection();
             this.setUserPromise = Promise.all([setTokenPromise, wsPromise]).then((result) => result[1]);
-            if (this.resolveConnectPromise) {
-                this.resolveConnectPromise();
-                this.waitForConnectPromise = undefined;
-                this.resolveConnectPromise = undefined;
-            }
             try {
                 return yield this.setUserPromise;
             }
@@ -11858,11 +11847,6 @@ class StreamClient {
             });
             this.anonymous = true;
             yield this._setToken(user, tokenOrProvider, this.anonymous);
-            if (this.resolveConnectPromise) {
-                this.resolveConnectPromise();
-                this.waitForConnectPromise = undefined;
-                this.resolveConnectPromise = undefined;
-            }
             this._setUser(user);
             // some endpoints require a connection_id to be resolved.
             // as anonymous users aren't allowed to open WS connections, we just
@@ -11919,9 +11903,6 @@ class StreamClient {
             this.logger('trace', `client:${type} - Response - url: ${url} > status ${response.status}`, {
                 response,
             });
-            this.logger('trace', `client:${type} - Response payload`, {
-                response,
-            });
         };
         this._logApiError = (type, url, error) => {
             this.logger('error', `client:${type} - Error - url: ${url}`, {
@@ -11932,9 +11913,6 @@ class StreamClient {
         this.doAxiosRequest = (type, url, data, options = {}) => __awaiter(this, void 0, void 0, function* () {
             var _h;
             if (!options.publicEndpoint) {
-                if (this.waitForConnectPromise) {
-                    yield this.waitForConnectPromise;
-                }
                 yield Promise.all([
                     this.tokenManager.tokenReady(),
                     this.connectionIdPromise,
@@ -11973,9 +11951,9 @@ class StreamClient {
             }
             catch (e /**TODO: generalize error types  */) {
                 e.client_request_id = (_h = requestConfig.headers) === null || _h === void 0 ? void 0 : _h['x-client-request-id'];
-                this._logApiError(type, url, e);
                 this.consecutiveFailures += 1;
                 if (e.response) {
+                    this._logApiError(type, url, e.response);
                     /** connection_fallback depends on this token expiration logic */
                     if (e.response.data.code === KnownCodes.TOKEN_EXPIRED &&
                         !this.tokenManager.isStatic()) {
@@ -11988,6 +11966,7 @@ class StreamClient {
                     return this.handleResponse(e.response);
                 }
                 else {
+                    this._logApiError(type, url, e);
                     // eslint-disable-next-line no-throw-literal
                     throw e;
                 }
@@ -12272,6 +12251,7 @@ class StreamClient {
 class StreamVideoClient {
     constructor(apiKeyOrArgs, opts) {
         var _a, _b;
+        this.logLevel = 'warn';
         this.eventHandlersToUnregister = [];
         /**
          * Disconnects the currently connected user from the client.
@@ -12282,7 +12262,7 @@ class StreamVideoClient {
          *                https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent
          */
         this.disconnectUser = (timeout) => __awaiter(this, void 0, void 0, function* () {
-            if (!this.streamClient.user) {
+            if (!this.streamClient.user && !this.connectionPromise) {
                 return;
             }
             const disconnectUser = () => this.streamClient.disconnectUser(timeout);
@@ -12343,7 +12323,7 @@ class StreamVideoClient {
          *
          * @param data the query data.
          */
-        this.queryCalls = (data) => __awaiter(this, void 0, void 0, function* () {
+        this.queryCalls = (data = {}) => __awaiter(this, void 0, void 0, function* () {
             const response = yield this.streamClient.post('/calls', data);
             const calls = response.calls.map((c) => {
                 const call = new Call({
@@ -12459,14 +12439,16 @@ class StreamVideoClient {
                 this.streamClient.setUserAgent(this.streamClient.getUserAgent() +
                     `-video-${SdkType[sdkInfo.type].toLowerCase()}-sdk-${sdkInfo.major}.${sdkInfo.minor}.${sdkInfo.patch}`);
             }
-            this.user = apiKeyOrArgs.user;
-            this.token = apiKeyOrArgs.token || apiKeyOrArgs.tokenProvider;
-            if (this.user) {
-                this.streamClient.startWaitingForConnection();
-            }
         }
         this.writeableStateStore = new StreamVideoWriteableStateStore();
         this.readOnlyStateStore = new StreamVideoReadOnlyStateStore(this.writeableStateStore);
+        if (typeof apiKeyOrArgs !== 'string') {
+            const user = apiKeyOrArgs.user;
+            const token = apiKeyOrArgs.token || apiKeyOrArgs.tokenProvider;
+            if (user) {
+                this.connectUser(user, token);
+            }
+        }
     }
     /**
      * Connects the given user to the client.
@@ -12479,24 +12461,21 @@ class StreamVideoClient {
     connectUser(user, token) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const userToConnect = user || this.user;
-            const tokenToUse = token || this.token;
-            if (!userToConnect) {
-                throw new Error('Connect user is called without user');
-            }
-            if (userToConnect.type === 'anonymous') {
-                userToConnect.id = '!anon';
-                return this.connectAnonymousUser(userToConnect, tokenToUse);
-            }
-            if (userToConnect.type === 'guest') {
-                const response = yield this.createGuestUser({
-                    user: Object.assign(Object.assign({}, userToConnect), { role: 'guest' }),
-                });
-                return this.connectUser(response.user, response.access_token);
+            if (user.type === 'anonymous') {
+                user.id = '!anon';
+                return this.connectAnonymousUser(user, token);
             }
-            const connectUser = () => {
-                return this.streamClient.connectUser(userToConnect, tokenToUse);
+            let connectUser = () => {
+                return this.streamClient.connectUser(user, token);
             };
+            if (user.type === 'guest') {
+                connectUser = () => __awaiter(this, void 0, void 0, function* () {
+                    const response = yield this.createGuestUser({
+                        user: Object.assign(Object.assign({}, user), { role: 'guest' }),
+                    });
+                    return this.streamClient.connectUser(response.user, response.access_token);
+                });
+            }
             this.connectionPromise = this.disconnectionPromise
                 ? this.disconnectionPromise.then(() => connectUser())
                 : connectUser();
@@ -12530,7 +12509,7 @@ class StreamVideoClient {
                 if (event.type !== 'call.created')
                     return;
                 const { call, members } = event;
-                if (userToConnect.id === call.created_by.id) {
+                if (user.id === call.created_by.id) {
                     this.logger('warn', 'Received `call.created` sent by the current user');
                     return;
                 }
@@ -12548,7 +12527,7 @@ class StreamVideoClient {
                 if (event.type !== 'call.ring')
                     return;
                 const { call, members } = event;
-                if (userToConnect.id === call.created_by.id) {
+                if (user.id === call.created_by.id) {
                     this.logger('debug', 'Received `call.ring` sent by the current user so ignoring the event');
                     return;
                 }