@sendbird/uikit-react 3.4.8 → 3.5.0-mobile-web-0

package/SendbirdProvider.js

@@ -1,23 +1,23 @@
-import { _ as _objectSpread2 } from './_rollupPluginBabelHelpers-eaf55eff.js';
-import React__default, { useLayoutEffect, useState, useEffect, useCallback, useMemo, useReducer } from 'react';
+import { _ as _objectSpread2 } from './_rollupPluginBabelHelpers-ce69e916.js';
+import React__default, { useLayoutEffect, useState, useEffect, useCallback, useContext, createContext, useMemo, useReducer } from 'react';
 import { SendbirdSdkContext } from './withSendbird.js';
 import cssVars from 'css-vars-ponyfill';
-import { K } from './index.module-1c75b4f5.js';
-import { U as USER_ACTIONS } from './actionTypes-98eee9f4.js';
+import { K } from './index.module-8c144786.js';
+import { U as USER_ACTIONS } from './actionTypes-a5283c75.js';
 import SendbirdChat, { ConnectionHandler } from '@sendbird/chat';
-import { u as uuidv4 } from './uuid-c94bd88b.js';
+import { u as uuidv4 } from './uuid-720c99c0.js';
 import { OpenChannelModule } from '@sendbird/chat/openChannel';
 import { GroupChannelModule } from '@sendbird/chat/groupChannel';
-import { i as isTextuallyNull } from './index-d8fdbe6f.js';
-import { V as VoicePlayerProvider } from './index-ae8e6fc3.js';
+import { i as isTextuallyNull } from './index-fd51c7d1.js';
+import { V as VoicePlayerProvider } from './index-5644a6c0.js';
 import { VoiceRecorderProvider } from './VoiceRecorder/context.js';
-import { L as LocalizationProvider } from './LocalizationContext-ae38446a.js';
-import { M as MediaQueryProvider } from './MediaQueryContext-8d283dc2.js';
-import { g as getStringSet } from './stringSet-6d89212b.js';
-import { V as VOICE_RECORDER_DEFAULT_MAX, a as VOICE_RECORDER_DEFAULT_MIN } from './consts-9ece4263.js';
+import { L as LocalizationProvider } from './LocalizationContext-1839d2db.js';
+import { M as MediaQueryProvider } from './MediaQueryContext-0e0b3a1b.js';
+import { g as getStringSet } from './stringSet-d368e289.js';
+import { V as VOICE_RECORDER_DEFAULT_MAX, a as VOICE_RECORDER_DEFAULT_MIN } from './consts-9393e7c8.js';
 import './utils/message/getOutgoingMessageState.js';
 import './useSendbirdStateContext.js';
-import './index-321e838f.js';
+import './index-d9c12cf4.js';
 
 const isEmpty = obj => {
   if (obj === null || obj === undefined) {
@@ -294,6 +294,121 @@ function useConnectionStatus(sdk, logger) {
   return isOnline;
 }
 
+function snakeToCamel(obj) {
+  if (typeof obj !== 'object' || obj === null) {
+    return obj;
+  }
+  if (Array.isArray(obj)) {
+    return obj.map(item => snakeToCamel(item));
+  }
+  const result = {};
+  Object.keys(obj).forEach(key => {
+    const camelKey = key.replace(/_\w/g, m => m[1].toUpperCase());
+    result[camelKey] = snakeToCamel(obj[key]);
+  });
+  return result;
+}
+
+// @link: https://docs.google.com/spreadsheets/d/1-AozBMHRYOXS74vZ-7x2ptQcBL6nnM-orJWRvUgmkd4/edit#gid=0
+const initialConfig = {
+  common: {
+    enableUsingDefaultUserProfile: false
+  },
+  groupChannel: {
+    channel: {
+      enableMention: false,
+      enableOgtag: true,
+      enableReactions: true,
+      enableTypingIndicator: true,
+      enableVoiceMessage: false,
+      input: {
+        camera: {
+          enablePhoto: true,
+          enableVideo: true
+        },
+        enableDocument: true,
+        gallery: {
+          enablePhoto: true,
+          enableVideo: true
+        }
+      },
+      replyType: 'quote_reply',
+      threadReplySelectType: 'thread'
+    },
+    channelList: {
+      enableMessageReceiptStatus: false,
+      enableTypingIndicator: false
+    },
+    setting: {
+      enableMessageSearch: false
+    }
+  },
+  openChannel: {
+    channel: {
+      enableOgtag: true,
+      input: {
+        camera: {
+          enablePhoto: true,
+          enableVideo: true
+        },
+        enableDocument: true,
+        gallery: {
+          enablePhoto: true,
+          enableVideo: true
+        }
+      }
+    }
+  }
+};
+const UIKitConfigContext = /*#__PURE__*/createContext({
+  initDashboardConfigs: () => Promise.resolve(),
+  configs: initialConfig
+});
+const UIKitConfigProvider = _ref => {
+  let {
+    storage,
+    children /* appConfigurations */
+  } = _ref;
+  // TODO: Implement
+  // const localConfigs = mergeConfigs(initialConfig, mapToUIKItConfig(configurations));
+  const [remoteConfigs, setRemoteConfigs] = useState(initialConfig);
+  const initDashboardConfigs = useCallback(async sdk => {
+    try {
+      // TODO: Implement
+      // const manager = new UIKitConfigStorageManager(storage)
+      // const storedConfigs = await manager.init(sdk.appId);
+
+      if (storage == null) {
+        const payload = await sdk.getUIKitConfiguration().json;
+        setRemoteConfigs(snakeToCamel(payload.uikit_configurations));
+      }
+
+      // TODO: Implement
+      // Compare the sdk uikitConfig's lastUpdatedAt <-> stored one
+      // if(sdk.appInfo.uikitConfigInfo.lastUpdatedAt === storedConfigs.lastUpdatedAt) {
+      //   setRemoteConfigs(storedConfigs);
+      // } else {
+      //   const newConfigs = await sdk.getUIKitConfig();
+      //   const updatedConfigs = await manager.update(newConfigs);
+      //   setRemoteConfigs(updatedConfigs);
+      // }
+    } catch (error) {
+      //
+    }
+  }, []);
+
+  // TODO: Implement
+  // const configs = getByPriority(localConfigs, remoteConfigs);
+  const configs = remoteConfigs;
+  return /*#__PURE__*/React__default.createElement(UIKitConfigContext.Provider, {
+    value: {
+      initDashboardConfigs,
+      configs
+    }
+  }, children);
+};
+const useUIKitConfig = () => useContext(UIKitConfigContext);
+
 async function disconnectSdk(_ref) {
   let {
     sdkDispatcher,
@@ -322,6 +437,7 @@ async function disconnectSdk(_ref) {
   });
 }
 
+const APP_VERSION_STRING = '3.5.0-mobile-web-0';
 const {
   INIT_SDK,
   SET_SDK_LOADING,
@@ -333,7 +449,6 @@ const {
   UPDATE_USER_INFO,
   RESET_USER
 } = USER_ACTIONS;
-const APP_VERSION_STRING = '3.4.8';
 function getMissingParamError(_ref) {
   let {
     userId,
@@ -370,7 +485,7 @@ function setUpParams(_ref2) {
 //  1.b. If yes, continue
 // 2. Set up params with custom host if provided
 // 3. Set up session handler if provided
-// 4. Set up version if not storybook
+// 4. Set up version
 // 5. Connect to Sendbird -> either using user ID or (user ID + access token)
 // 6. If connected, connectCbSucess
 //  6.a check if nickname is to be updated -> no > !resolve immediately
@@ -381,6 +496,7 @@ async function setUpConnection(_ref3) {
     logger,
     sdkDispatcher,
     userDispatcher,
+    initDashboardConfigs,
     userId,
     appId,
     customApiHost,
@@ -401,6 +517,7 @@ async function setUpConnection(_ref3) {
       payload: true
     });
     if (userId && appId) {
+      var _logger$info3, _logger$info8;
       const newSdk = setUpParams({
         appId,
         customApiHost,
@@ -412,15 +529,11 @@ async function setUpConnection(_ref3) {
         logger === null || logger === void 0 ? void 0 : (_logger$info2 = logger.info) === null || _logger$info2 === void 0 ? void 0 : _logger$info2.call(logger, 'SendbirdProvider | useConnect/setupConnection/configureSession', sessionHandler);
         newSdk.setSessionHandler(sessionHandler);
       }
-      // to check if code is released version from rollup and *not from storybook*
-      // see rollup config file
-      // @ts-ignore
-      {
-        var _logger$info3;
-        logger === null || logger === void 0 ? void 0 : (_logger$info3 = logger.info) === null || _logger$info3 === void 0 ? void 0 : _logger$info3.call(logger, 'SendbirdProvider | useConnect/setupConnection/setVersion', APP_VERSION_STRING);
-        newSdk.addExtension('sb_uikit', APP_VERSION_STRING);
-      }
-      const connectCbSucess = user => {
+      logger === null || logger === void 0 ? void 0 : (_logger$info3 = logger.info) === null || _logger$info3 === void 0 ? void 0 : _logger$info3.call(logger, 'SendbirdProvider | useConnect/setupConnection/setVersion', {
+        version: APP_VERSION_STRING
+      });
+      newSdk.addExtension('sb_uikit', APP_VERSION_STRING);
+      const connectCbSucess = async user => {
         var _logger$info4;
         logger === null || logger === void 0 ? void 0 : (_logger$info4 = logger.info) === null || _logger$info4 === void 0 ? void 0 : _logger$info4.call(logger, 'SendbirdProvider | useConnect/setupConnection/connectCbSucess', user);
         sdkDispatcher({
@@ -431,11 +544,23 @@ async function setUpConnection(_ref3) {
           type: INIT_USER,
           payload: user
         });
+        initDashboardConfigs(newSdk).then(config => {
+          var _logger$info5;
+          logger === null || logger === void 0 ? void 0 : (_logger$info5 = logger.info) === null || _logger$info5 === void 0 ? void 0 : _logger$info5.call(logger, 'SendbirdProvider | useConnect/setupConnection/getUIKitConfiguration success', {
+            config
+          });
+        }).catch(error => {
+          var _logger$error;
+          logger === null || logger === void 0 ? void 0 : (_logger$error = logger.error) === null || _logger$error === void 0 ? void 0 : _logger$error.call(logger, 'SendbirdProvider | useConnect/setupConnection/getUIKitConfiguration failed', {
+            error
+          });
+        });
+
         // use nickname/profileUrl if provided
         // or set userID as nickname
         if ((nickname !== user.nickname || profileUrl !== user.profileUrl) && !(isTextuallyNull(nickname) && isTextuallyNull(profileUrl))) {
-          var _logger$info5;
-          logger === null || logger === void 0 ? void 0 : (_logger$info5 = logger.info) === null || _logger$info5 === void 0 ? void 0 : _logger$info5.call(logger, 'SendbirdProvider | useConnect/setupConnection/updateCurrentUserInfo', {
+          var _logger$info6;
+          logger === null || logger === void 0 ? void 0 : (_logger$info6 = logger.info) === null || _logger$info6 === void 0 ? void 0 : _logger$info6.call(logger, 'SendbirdProvider | useConnect/setupConnection/updateCurrentUserInfo', {
             nickname,
             profileUrl
           });
@@ -443,8 +568,8 @@ async function setUpConnection(_ref3) {
             nickname: nickname || user.nickname,
             profileUrl: profileUrl || user.profileUrl
           }).then(namedUser => {
-            var _logger$info6;
-            logger === null || logger === void 0 ? void 0 : (_logger$info6 = logger.info) === null || _logger$info6 === void 0 ? void 0 : _logger$info6.call(logger, 'SendbirdProvider | useConnect/setupConnection/updateCurrentUserInfo success', {
+            var _logger$info7;
+            logger === null || logger === void 0 ? void 0 : (_logger$info7 = logger.info) === null || _logger$info7 === void 0 ? void 0 : _logger$info7.call(logger, 'SendbirdProvider | useConnect/setupConnection/updateCurrentUserInfo success', {
               nickname,
               profileUrl
             });
@@ -460,9 +585,9 @@ async function setUpConnection(_ref3) {
         }
       };
       const connectCbError = e => {
-        var _logger$error;
+        var _logger$error2;
         const errorMessage = getConnectSbError(e);
-        logger === null || logger === void 0 ? void 0 : (_logger$error = logger.error) === null || _logger$error === void 0 ? void 0 : _logger$error.call(logger, errorMessage, {
+        logger === null || logger === void 0 ? void 0 : (_logger$error2 = logger.error) === null || _logger$error2 === void 0 ? void 0 : _logger$error2.call(logger, errorMessage, {
           e,
           appId,
           userId
@@ -479,17 +604,10 @@ async function setUpConnection(_ref3) {
         // exit promise with error
         reject(errorMessage);
       };
-      if (accessToken) {
-        var _logger$info7;
-        logger === null || logger === void 0 ? void 0 : (_logger$info7 = logger.info) === null || _logger$info7 === void 0 ? void 0 : _logger$info7.call(logger, 'SendbirdProvider | useConnect/setupConnection/connect connecting using accessToken');
-        newSdk.connect(userId, accessToken).then(res => connectCbSucess(res)).catch(err => connectCbError(err));
-      } else {
-        var _logger$info8;
-        logger === null || logger === void 0 ? void 0 : (_logger$info8 = logger.info) === null || _logger$info8 === void 0 ? void 0 : _logger$info8.call(logger, 'SendbirdProvider | useConnect/setupConnection/connect connecting using userId');
-        newSdk.connect(userId).then(res => connectCbSucess(res)).catch(err => connectCbError(err));
-      }
+      logger === null || logger === void 0 ? void 0 : (_logger$info8 = logger.info) === null || _logger$info8 === void 0 ? void 0 : _logger$info8.call(logger, `SendbirdProvider | useConnect/setupConnection/connect connecting using ${accessToken !== null && accessToken !== void 0 ? accessToken : userId}`);
+      newSdk.connect(userId, accessToken).then(res => connectCbSucess(res)).catch(err => connectCbError(err));
     } else {
-      var _logger$error2;
+      var _logger$error3;
       const errorMessage = getMissingParamError({
         userId,
         appId
@@ -497,7 +615,7 @@ async function setUpConnection(_ref3) {
       sdkDispatcher({
         type: SDK_ERROR
       });
-      logger === null || logger === void 0 ? void 0 : (_logger$error2 = logger.error) === null || _logger$error2 === void 0 ? void 0 : _logger$error2.call(logger, errorMessage);
+      logger === null || logger === void 0 ? void 0 : (_logger$error3 = logger.error) === null || _logger$error3 === void 0 ? void 0 : _logger$error3.call(logger, errorMessage);
       // exit promise with error
       reject(errorMessage);
     }
@@ -509,6 +627,7 @@ async function connect(_ref) {
     logger,
     sdkDispatcher,
     userDispatcher,
+    initDashboardConfigs,
     userId,
     appId,
     customApiHost,
@@ -529,6 +648,7 @@ async function connect(_ref) {
     logger,
     sdkDispatcher,
     userDispatcher,
+    initDashboardConfigs,
     userId,
     appId,
     customApiHost,
@@ -559,6 +679,9 @@ function useConnect(triggerTypes, staticTypes) {
     userDispatcher
   } = staticTypes;
   logger === null || logger === void 0 ? void 0 : (_logger$info = logger.info) === null || _logger$info === void 0 ? void 0 : _logger$info.call(logger, 'SendbirdProvider | useConnect', _objectSpread2(_objectSpread2({}, triggerTypes), staticTypes));
+  const {
+    initDashboardConfigs
+  } = useUIKitConfig();
   useEffect(() => {
     var _logger$info2;
     logger === null || logger === void 0 ? void 0 : (_logger$info2 = logger.info) === null || _logger$info2 === void 0 ? void 0 : _logger$info2.call(logger, 'SendbirdProvider | useConnect/useEffect', {
@@ -579,7 +702,8 @@ function useConnect(triggerTypes, staticTypes) {
         customWebSocketHost,
         sdk,
         sdkDispatcher,
-        userDispatcher
+        userDispatcher,
+        initDashboardConfigs
       });
     } catch (error) {
       var _logger$error;
@@ -604,7 +728,8 @@ function useConnect(triggerTypes, staticTypes) {
         customWebSocketHost,
         sdk,
         sdkDispatcher,
-        userDispatcher
+        userDispatcher,
+        initDashboardConfigs
       });
     } catch (error) {
       var _logger$error2;
@@ -762,8 +887,20 @@ const VoiceMessageProvider = _ref => {
   return /*#__PURE__*/React__default.createElement(VoiceRecorderProvider, null, /*#__PURE__*/React__default.createElement(VoicePlayerProvider, null, children));
 };
 
-const TIMEOUT = 5000;
-const schedulerFactory = (logger, timeout) => {
+const TIMEOUT = 2000;
+
+/*
+  * This is a factory function that returns a scheduler.
+  * The scheduler is a queue that calls the callback function on intervals.
+  * If interval is empty, the callback function is called immediately.
+  * If interval is not empty, the callback function is called after the interval.
+*/
+function schedulerFactory(_ref) {
+  let {
+    logger,
+    timeout,
+    cb
+  } = _ref;
   let queue = [];
   let interval = null;
   const push = channel => {
@@ -771,25 +908,27 @@ const schedulerFactory = (logger, timeout) => {
     if (!channelPresent) {
       queue.push(channel);
     } else {
-      logger.info('Channel: Mark as read already in queue', channel);
+      logger.info('Channel: Mark as read already in queue', {
+        channel
+      });
     }
     // start the interval if it's not already running
     if (interval) {
       return;
     }
+    const item = queue.shift();
+    if (item) {
+      cb(item);
+    }
     interval = setInterval(() => {
-      if (queue.length === 0) {
+      if (queue.length === 0 && interval) {
         clearInterval(interval);
         interval = null;
         return;
       }
-      const channel = queue.shift();
-      if (channel) {
-        try {
-          channel.markAsRead();
-        } catch (error) {
-          logger.error('Channel: Mark as read failed', error);
-        }
+      const item = queue.shift();
+      if (item) {
+        cb(item);
       }
     }, timeout || TIMEOUT);
   };
@@ -805,7 +944,17 @@ const schedulerFactory = (logger, timeout) => {
     clear,
     getQueue: () => queue
   };
-};
+}
+
+// this hook accepts a callback to run component is unmounted
+function useUnmount(callback) {
+  useLayoutEffect(() => {
+    return () => {
+      callback();
+    };
+  }, []);
+}
+
 function useMarkAsReadScheduler(_ref, _ref2) {
   let {
     isConnected
@@ -813,16 +962,63 @@ function useMarkAsReadScheduler(_ref, _ref2) {
   let {
     logger
   } = _ref2;
-  const markAsReadScheduler = useMemo(() => schedulerFactory(logger), []);
+  const markAsReadScheduler = useMemo(() => schedulerFactory({
+    logger,
+    cb: channel => {
+      try {
+        channel.markAsRead();
+      } catch (error) {
+        logger.warning('Channel: Mark as delivered failed', {
+          channel,
+          error
+        });
+      }
+    }
+  }), []);
   useEffect(() => {
     // for simplicity, we clear the queue when the connection is lost
     if (!isConnected) {
       markAsReadScheduler.clear();
     }
   }, [isConnected]);
+  useUnmount(() => {
+    markAsReadScheduler.clear();
+  });
   return markAsReadScheduler;
 }
 
+function useMarkAsDeliveredScheduler(_ref, _ref2) {
+  let {
+    isConnected
+  } = _ref;
+  let {
+    logger
+  } = _ref2;
+  const markAsDeliveredScheduler = useMemo(() => schedulerFactory({
+    logger,
+    cb: channel => {
+      try {
+        channel.markAsDelivered();
+      } catch (error) {
+        logger.warning('Channel: Mark as delivered failed', {
+          channel,
+          error
+        });
+      }
+    }
+  }), []);
+  useEffect(() => {
+    // for simplicity, we clear the queue when the connection is lost
+    if (!isConnected) {
+      markAsDeliveredScheduler.clear();
+    }
+  }, [isConnected]);
+  useUnmount(() => {
+    markAsDeliveredScheduler.clear();
+  });
+  return markAsDeliveredScheduler;
+}
+
 const Sendbird = _ref => {
   let {
     appId,
@@ -930,12 +1126,33 @@ const Sendbird = _ref => {
   }, {
     logger
   });
+  const markAsDeliveredScheduler = useMarkAsDeliveredScheduler({
+    isConnected: isOnline
+  }, {
+    logger
+  });
   const localeStringSet = React__default.useMemo(() => {
     if (!stringSet) {
       return getStringSet('en');
     }
     return _objectSpread2(_objectSpread2({}, getStringSet('en')), stringSet);
   }, [stringSet]);
+  const uikitConfigurations = {
+    // common.enable_using_default_user_profile
+    disableUserProfile,
+    // group_channel.enable_reactions
+    isReactionEnabled,
+    // group_channel.enable_mention
+    isMentionEnabled: isMentionEnabled || false,
+    // group_channel.enable_voice_message
+    isVoiceMessageEnabled,
+    // group_channel.reply_type
+    replyType,
+    // group_channel_list.enable_typing_indicator
+    isTypingIndicatorEnabledOnChannelList,
+    // group_channel_list.enable_message_receipt_status
+    isMessageReceiptStatusEnabledOnChannelList
+  };
   return /*#__PURE__*/React__default.createElement(SendbirdSdkContext.Provider, {
     value: {
       stores: {
@@ -947,8 +1164,7 @@ const Sendbird = _ref => {
         userDispatcher,
         reconnect
       },
-      config: {
-        disableUserProfile,
+      config: _objectSpread2({
         disableMarkAsDelivered,
         renderUserProfile,
         onUserProfileMessage,
@@ -965,18 +1181,36 @@ const Sendbird = _ref => {
         imageCompression: _objectSpread2({
           compressionRate: 0.7
         }, imageCompression),
-        isReactionEnabled,
-        isMentionEnabled: isMentionEnabled || false,
-        isVoiceMessageEnabled,
         voiceRecord,
         userMention: {
           maxMentionCount: (userMention === null || userMention === void 0 ? void 0 : userMention.maxMentionCount) || 10,
           maxSuggestionCount: (userMention === null || userMention === void 0 ? void 0 : userMention.maxSuggestionCount) || 15
         },
-        isTypingIndicatorEnabledOnChannelList,
-        isMessageReceiptStatusEnabledOnChannelList,
-        replyType,
-        markAsReadScheduler
+        markAsReadScheduler,
+        markAsDeliveredScheduler
+      }, uikitConfigurations)
+    }
+  }, /*#__PURE__*/React__default.createElement(UIKitConfigProvider, {
+    appConfigurations: {
+      common: {
+        enableUsingDefaultUserProfile: !uikitConfigurations.disableUserProfile
+      },
+      groupChannel: {
+        channel: {
+          enableReactions: uikitConfigurations.isReactionEnabled,
+          enableMention: uikitConfigurations.isMentionEnabled,
+          enableVoiceMessage: uikitConfigurations.isVoiceMessageEnabled,
+          /**
+           * Since dashbord UIKit Configuration's replyType is consisted of all lowercase letters,
+           * we convert it from here.
+           * i.e. 'THREAD' -> 'thread'
+           */
+          replyType: uikitConfigurations.replyType.toLowerCase()
+        },
+        channelList: {
+          enableTypingIndicator: uikitConfigurations.isTypingIndicatorEnabledOnChannelList,
+          enableMessageReceiptStatus: uikitConfigurations.isMessageReceiptStatusEnabledOnChannelList
+        }
       }
     }
   }, /*#__PURE__*/React__default.createElement(MediaQueryProvider, {
@@ -987,7 +1221,7 @@ const Sendbird = _ref => {
     dateLocale: dateLocale
   }, /*#__PURE__*/React__default.createElement(VoiceMessageProvider, {
     isVoiceMessageEnabled: isVoiceMessageEnabled
-  }, children))));
+  }, children)))));
 };
 
 export { Sendbird as default };