@stream-io/video-client 1.17.1 → 1.18.1

package/dist/index.cjs.js

@@ -7465,7 +7465,7 @@ const aggregate = (stats) => {
     return report;
 };
 
-const version = "1.17.1";
+const version = "1.18.1";
 const [major, minor, patch] = version.split('.');
 let sdkInfo = {
     type: SdkType.PLAIN_JAVASCRIPT,
@@ -7486,15 +7486,9 @@ const getSdkInfo = () => {
 const setOSInfo = (info) => {
     osInfo = info;
 };
-const getOSInfo = () => {
-    return osInfo;
-};
 const setDeviceInfo = (info) => {
     deviceInfo = info;
 };
-const getDeviceInfo = () => {
-    return deviceInfo;
-};
 const getWebRTCInfo = () => {
     return webRtcInfo;
 };
@@ -7562,26 +7556,40 @@ const setPowerState = (powerMode) => {
 const getDeviceState = () => {
     return deviceState;
 };
-const getClientDetails = () => {
+const getClientDetails = async () => {
     if (isReactNative()) {
         // Since RN doesn't support web, sharing browser info is not required
         return {
-            sdk: getSdkInfo(),
-            os: getOSInfo(),
-            device: getDeviceInfo(),
+            sdk: sdkInfo,
+            os: osInfo,
+            device: deviceInfo,
         };
     }
+    // @ts-expect-error - userAgentData is not yet in the TS types
+    const userAgentDataApi = navigator.userAgentData;
+    let userAgentData;
+    if (userAgentDataApi && userAgentDataApi.getHighEntropyValues) {
+        try {
+            userAgentData = await userAgentDataApi.getHighEntropyValues([
+                'platform',
+                'platformVersion',
+            ]);
+        }
+        catch (e) {
+            // Ignore the error
+        }
+    }
     const userAgent = new uaParserJs.UAParser(navigator.userAgent);
     const { browser, os, device, cpu } = userAgent.getResult();
     return {
-        sdk: getSdkInfo(),
+        sdk: sdkInfo,
         browser: {
             name: browser.name || navigator.userAgent,
             version: browser.version || '',
         },
         os: {
-            name: os.name || '',
-            version: os.version || '',
+            name: userAgentData?.platform || os.name || '',
+            version: userAgentData?.platformVersion || os.version || '',
             architecture: cpu.architecture || '',
         },
         device: {
@@ -7810,8 +7818,6 @@ const globalOverrideKey = Symbol('globalOverrideKey');
 class DynascaleManager {
     /**
      * Creates a new DynascaleManager instance.
-     *
-     * @param call the call to manage.
      */
     constructor(callState, speaker) {
         /**
@@ -10449,6 +10455,7 @@ class Call {
                 this.leaveCallHooks.forEach((hook) => hook());
                 this.initialized = false;
                 this.hasJoinedOnce = false;
+                this.ringingSubject.next(false);
                 this.clientStore.unregisterCall(this);
                 this.camera.dispose();
                 this.microphone.dispose();
@@ -10507,7 +10514,7 @@ class Call {
             this.state.updateFromCallResponse(response.call);
             this.state.setMembers(response.members);
             this.state.setOwnCapabilities(response.own_capabilities);
-            if (params?.ring || this.ringing) {
+            if (params?.ring) {
                 // the call response can indicate where the call is still ringing or not
                 this.ringingSubject.next(true);
             }
@@ -10529,7 +10536,7 @@ class Call {
             this.state.updateFromCallResponse(response.call);
             this.state.setMembers(response.members);
             this.state.setOwnCapabilities(response.own_capabilities);
-            if (data?.ring || this.ringing) {
+            if (data?.ring) {
                 // the call response can indicate where the call is still ringing or not
                 this.ringingSubject.next(true);
             }
@@ -10619,8 +10626,13 @@ class Call {
                     statsOptions = joinResponse.stats_options;
                 }
                 catch (error) {
-                    // restore the previous call state if the join-flow fails
-                    this.state.setCallingState(callingState);
+                    // prevent triggering reconnect flow if the state is OFFLINE
+                    const avoidRestoreState = this.state.callingState === exports.CallingState.OFFLINE &&
+                        callingState === exports.CallingState.RECONNECTING;
+                    if (!avoidRestoreState) {
+                        // restore the previous call state if the join-flow fails
+                        this.state.setCallingState(callingState);
+                    }
                     throw error;
                 }
             }
@@ -10641,7 +10653,7 @@ class Call {
                 : previousSfuClient;
             this.sfuClient = sfuClient;
             this.dynascaleManager.setSfuClient(sfuClient);
-            const clientDetails = getClientDetails();
+            const clientDetails = await getClientDetails();
             // we don't need to send JoinRequest if we are re-using an existing healthy SFU client
             if (previousSfuClient !== sfuClient) {
                 // prepare a generic SDP and send it to the SFU.
@@ -10900,7 +10912,7 @@ class Call {
             this.state.updateFromCallResponse(joinResponse.call);
             this.state.setMembers(joinResponse.members);
             this.state.setOwnCapabilities(joinResponse.own_capabilities);
-            if (data?.ring && !this.ringing) {
+            if (data?.ring) {
                 this.ringingSubject.next(true);
             }
             if (this.ringing && !this.isCreatedByMe) {
@@ -11769,7 +11781,7 @@ class Call {
          * @param custom Custom data
          */
         this.submitFeedback = async (rating, { reason, custom, } = {}) => {
-            const { sdkName, sdkVersion, ...platform } = getSdkSignature(getClientDetails());
+            const { sdkName, sdkVersion, ...platform } = getSdkSignature(await getClientDetails());
             return this.streamClient.post(`${this.streamClientBasePath}/feedback`, {
                 rating,
                 reason,
@@ -12453,7 +12465,7 @@ class StableWSConnection {
             }
         }
         catch (err) {
-            await this.client._setupConnectionIdPromise();
+            this.client._setupConnectionIdPromise();
             this.isConnecting = false;
             // @ts-ignore
             this._log(`_connect() - Error - `, err);
@@ -12766,8 +12778,7 @@ class StreamClient {
             if (this.userID) {
                 throw new Error('Use client.disconnect() before trying to connect as a different user. connectUser was called twice.');
             }
-            if ((this._isUsingServerAuth() || this.node) &&
-                !this.options.allowServerSideConnect) {
+            if ((this.secret || this.node) && !this.options.allowServerSideConnect) {
                 this.logger('warn', 'Please do not use connectUser server side. Use our @stream-io/node-sdk instead: https://getstream.io/video/docs/api/');
             }
             // we generate the client id client side
@@ -12835,7 +12846,7 @@ class StreamClient {
                 this.logger('info', 'client:openConnection() - openConnection called twice, healthy connection already exists');
                 return;
             }
-            await this._setupConnectionIdPromise();
+            this._setupConnectionIdPromise();
             this.clientID = `${this.userID}--${randomId()}`;
             const newWsPromise = this.connect();
             this.wsPromiseSafe = makeSafePromise(newWsPromise);
@@ -12872,7 +12883,7 @@ class StreamClient {
          */
         this.connectAnonymousUser = async (user, tokenOrProvider) => {
             addConnectionEventListeners(this.updateNetworkConnectionStatus);
-            await this._setupConnectionIdPromise();
+            this._setupConnectionIdPromise();
             this.anonymous = true;
             await this._setToken(user, tokenOrProvider, this.anonymous);
             this._setUser(user);
@@ -12922,12 +12933,16 @@ class StreamClient {
             }));
         };
         this._logApiRequest = (type, url, data, config) => {
+            if (getLogLevel() !== 'trace')
+                return;
             this.logger('trace', `client: ${type} - Request - ${url}`, {
                 payload: data,
                 config,
             });
         };
         this._logApiResponse = (type, url, response) => {
+            if (getLogLevel() !== 'trace')
+                return;
             this.logger('trace', `client:${type} - Response - url: ${url} > status ${response.status}`, {
                 response,
             });
@@ -13076,17 +13091,17 @@ class StreamClient {
             return await this.wsConnection.connect(this.defaultWSTimeout);
         };
         this.getUserAgent = () => {
-            const version = "1.17.1";
-            return (this.userAgent ||
-                `stream-video-javascript-client-${this.node ? 'node' : 'browser'}-${version}`);
-        };
-        this.setUserAgent = (userAgent) => {
-            this.userAgent = userAgent;
+            if (!this.cachedUserAgent) {
+                const { clientAppIdentifier = {} } = this.options;
+                const { sdkName = 'js', sdkVersion = "1.18.1", ...extras } = clientAppIdentifier;
+                this.cachedUserAgent = [
+                    `stream-video-${sdkName}-v${sdkVersion}`,
+                    ...Object.entries(extras).map(([key, value]) => `${key}=${value}`),
+                    `client_bundle=${"node-cjs"}`,
+                ].join('|');
+            }
+            return this.cachedUserAgent;
         };
-        /**
-         * _isUsingServerAuth - Returns true if we're using server side auth
-         */
-        this._isUsingServerAuth = () => !!this.secret;
         this._enrichAxiosOptions = (options = {
             params: {},
             headers: {},
@@ -13199,24 +13214,32 @@ class StreamClient {
 const getInstanceKey = (apiKey, user) => {
     return `${apiKey}/${user.id}`;
 };
+/**
+ * Utility function to get the client app identifier.
+ */
+const getClientAppIdentifier = (options) => {
+    const appId = options?.clientAppIdentifier || {};
+    const sdkInfo = getSdkInfo();
+    if (sdkInfo) {
+        // ensure the sdk name and version are set correctly,
+        // overriding any user-provided values
+        appId.sdkName = SdkType[sdkInfo.type].toLowerCase();
+        appId.sdkVersion = `${sdkInfo.major}.${sdkInfo.minor}.${sdkInfo.patch}`;
+    }
+    return appId;
+};
 /**
  * Creates a coordinator client.
  */
 const createCoordinatorClient = (apiKey, options) => {
+    const clientAppIdentifier = getClientAppIdentifier(options);
     const coordinatorLogger = getLogger(['coordinator']);
-    const streamClient = new StreamClient(apiKey, {
+    return new StreamClient(apiKey, {
         persistUserOnConnectionFailure: true,
         ...options,
+        clientAppIdentifier,
         logger: coordinatorLogger,
     });
-    const sdkInfo = getSdkInfo();
-    if (sdkInfo) {
-        const sdkName = SdkType[sdkInfo.type].toLowerCase();
-        const sdkVersion = `${sdkInfo.major}.${sdkInfo.minor}.${sdkInfo.patch}`;
-        const userAgent = streamClient.getUserAgent();
-        streamClient.setUserAgent(`${userAgent}-video-${sdkName}-sdk-${sdkVersion}`);
-    }
-    return streamClient;
 };
 /**
  * Creates a token provider and allows integrators to provide
@@ -13646,11 +13669,9 @@ exports.getAudioDevices = getAudioDevices;
 exports.getAudioOutputDevices = getAudioOutputDevices;
 exports.getAudioStream = getAudioStream;
 exports.getClientDetails = getClientDetails;
-exports.getDeviceInfo = getDeviceInfo;
 exports.getDeviceState = getDeviceState;
 exports.getLogLevel = getLogLevel;
 exports.getLogger = getLogger;
-exports.getOSInfo = getOSInfo;
 exports.getScreenShareStream = getScreenShareStream;
 exports.getSdkInfo = getSdkInfo;
 exports.getVideoBrowserPermission = getVideoBrowserPermission;