agora-appbuilder-core 2.2.0 → 2.3.0-beta.2

package/template/src/utils/useMuteToggleLocal.ts

@@ -0,0 +1,109 @@
+/*
+********************************************
+ Copyright © 2021 Agora Lab, Inc., all rights reserved.
+ AppBuilder and all associated components, source code, APIs, services, and documentation 
+ (the “Materials”) are owned by Agora Lab, Inc. and its licensors. The Materials may not be 
+ accessed, used, modified, or distributed for any purpose without a license from Agora Lab, Inc.  
+ Use without a license or in violation of any license terms and conditions (including use for 
+ any purpose competitive to Agora Lab, Inc.’s business) is strictly prohibited. For more 
+ information visit https://appbuilder.agora.io. 
+*********************************************
+*/
+import {useContext} from 'react';
+import {RtcContext, LocalContext} from '../../agora-rn-uikit';
+import {ToggleState} from '../../agora-rn-uikit/src/Contexts/PropsContext';
+
+export enum MUTE_LOCAL_TYPE {
+  audio,
+  video,
+}
+function useMuteToggleLocal() {
+  const {RtcEngine, dispatch} = useContext(RtcContext);
+  const local = useContext(LocalContext);
+
+  return async (type: MUTE_LOCAL_TYPE) => {
+    switch (type) {
+      case MUTE_LOCAL_TYPE.audio:
+        let localAudioState = local.audio;
+        // Don't do anything if it is in a transitional state
+        if (
+          localAudioState === ToggleState.enabled ||
+          localAudioState === ToggleState.disabled
+        ) {
+          // Disable UI
+          dispatch({
+            type: 'LocalMuteAudio',
+            value: [
+              localAudioState === ToggleState.enabled
+                ? ToggleState.disabling
+                : ToggleState.enabling,
+            ],
+          });
+
+          try {
+            await RtcEngine.muteLocalAudioStream(
+              localAudioState === ToggleState.enabled,
+            );
+            // Enable UI
+            dispatch({
+              type: 'LocalMuteAudio',
+              value: [
+                localAudioState === ToggleState.enabled
+                  ? ToggleState.disabled
+                  : ToggleState.enabled,
+              ],
+            });
+          } catch (e) {
+            console.error(e);
+            dispatch({
+              type: 'LocalMuteAudio',
+              value: [localAudioState],
+            });
+          }
+        }
+        break;
+      case MUTE_LOCAL_TYPE.video:
+        const localVideoState = local.video;
+        // Don't do anything if it is in a transitional state
+        if (
+          localVideoState === ToggleState.enabled ||
+          localVideoState === ToggleState.disabled
+        ) {
+          // Disable UI
+          dispatch({
+            type: 'LocalMuteVideo',
+            value: [
+              localVideoState === ToggleState.enabled
+                ? ToggleState.disabling
+                : ToggleState.enabling,
+            ],
+          });
+
+          try {
+            await RtcEngine.muteLocalVideoStream(
+              localVideoState === ToggleState.enabled ? true : false,
+            );
+
+            // Enable UI
+            dispatch({
+              type: 'LocalMuteVideo',
+              value: [
+                localVideoState === ToggleState.enabled
+                  ? ToggleState.disabled
+                  : ToggleState.enabled,
+              ],
+            });
+          } catch (e) {
+            console.log('error while dispatching');
+            dispatch({
+              type: 'LocalMuteVideo',
+              value: [localVideoState],
+            });
+          }
+        }
+        break;
+    }
+  };
+}
+
+export default useMuteToggleLocal;

package/template/src/utils/useNavParams.ts

@@ -0,0 +1,6 @@
+import {useParams} from '../components/Router';
+
+export default function useNavParams() {
+  const data = useParams();
+  return data;
+}

package/template/src/utils/useNavigateTo.ts

@@ -0,0 +1,8 @@
+import {useHistory} from '../components/Router';
+
+export default function useNavigateTo() {
+  const history = useHistory();
+  return (path: string, params?: any) => {
+    history.push(path, params);
+  };
+}

package/template/src/utils/usePrivateMessages.ts

@@ -0,0 +1,33 @@
+/*
+********************************************
+ Copyright © 2021 Agora Lab, Inc., all rights reserved.
+ AppBuilder and all associated components, source code, APIs, services, and documentation 
+ (the “Materials”) are owned by Agora Lab, Inc. and its licensors. The Materials may not be 
+ accessed, used, modified, or distributed for any purpose without a license from Agora Lab, Inc.  
+ Use without a license or in violation of any license terms and conditions (including use for 
+ any purpose competitive to Agora Lab, Inc.’s business) is strictly prohibited. For more 
+ information visit https://appbuilder.agora.io. 
+*********************************************
+*/
+
+import {useChatMessages} from '../components/chat-messages/useChatMessages';
+import {UidType} from '../../agora-rn-uikit';
+
+/**
+ * This hook will return function to find the private message by uid
+ * @returns private message
+ */
+function usePrivateMessages() {
+  const {privateMessageStore} = useChatMessages();
+  /**
+   *
+   * @param uid - User id
+   * @returns If uid is passed then it will return particular private message data
+   * otherwise it will return whole private message store
+   */
+  const getPrivateMessage = (uid?: UidType) =>
+    uid ? privateMessageStore[uid] : privateMessageStore;
+  return getPrivateMessage;
+}
+
+export default usePrivateMessages;

package/template/src/utils/useRemoteEndCall.ts

@@ -0,0 +1,27 @@
+import {controlMessageEnum} from '../components/ChatContext';
+import {UidType} from '../../agora-rn-uikit';
+import {useMeetingInfo} from '../components/meeting-info/useMeetingInfo';
+import useIsPSTN from './isPSTNUser';
+import useSendControlMessage, {
+  CONTROL_MESSAGE_TYPE,
+} from '../utils/useSendControlMessage';
+
+const useRemoteEndCall = () => {
+  const sendCtrlMsgToUid = useSendControlMessage();
+  const {isHost} = useMeetingInfo();
+  const isPSTN = useIsPSTN();
+  return (uid: UidType) => {
+    if (isHost) {
+      if (!isPSTN(uid)) {
+        sendCtrlMsgToUid(
+          CONTROL_MESSAGE_TYPE.controlMessageToUid,
+          controlMessageEnum.kickUser,
+          uid,
+        );
+      }
+    } else {
+      console.error('A host can only remove the audience from the call.');
+    }
+  };
+};
+export default useRemoteEndCall;

package/template/src/utils/useRemoteMute.ts

@@ -0,0 +1,64 @@
+/*
+********************************************
+ Copyright © 2021 Agora Lab, Inc., all rights reserved.
+ AppBuilder and all associated components, source code, APIs, services, and documentation 
+ (the “Materials”) are owned by Agora Lab, Inc. and its licensors. The Materials may not be 
+ accessed, used, modified, or distributed for any purpose without a license from Agora Lab, Inc.  
+ Use without a license or in violation of any license terms and conditions (including use for 
+ any purpose competitive to Agora Lab, Inc.’s business) is strictly prohibited. For more 
+ information visit https://appbuilder.agora.io. 
+*********************************************
+*/
+import {useMeetingInfo} from '../components/meeting-info/useMeetingInfo';
+import {UidType} from '../../agora-rn-uikit';
+import {controlMessageEnum} from '../components/ChatContext';
+import useIsPSTN from './isPSTNUser';
+import useMutePSTN from './useMutePSTN';
+import useSendControlMessage, {
+  CONTROL_MESSAGE_TYPE,
+} from '../utils/useSendControlMessage';
+
+export enum MUTE_REMOTE_TYPE {
+  audio,
+  video,
+}
+function useRemoteMute() {
+  const sendCtrlMsgToUid = useSendControlMessage();
+  const {isHost} = useMeetingInfo();
+  const isPSTN = useIsPSTN();
+  const mutePSTN = useMutePSTN();
+  return async (type: MUTE_REMOTE_TYPE, uid: UidType) => {
+    if (isHost) {
+      switch (type) {
+        case MUTE_REMOTE_TYPE.audio:
+          if (isPSTN(uid)) {
+            try {
+              mutePSTN(uid);
+            } catch (error) {
+              console.error('An error occurred while muting the PSTN user.');
+            }
+          } else {
+            sendCtrlMsgToUid(
+              CONTROL_MESSAGE_TYPE.controlMessageToUid,
+              controlMessageEnum.muteAudio,
+              uid,
+            );
+          }
+          break;
+        case MUTE_REMOTE_TYPE.video:
+          if (!isPSTN(uid)) {
+            sendCtrlMsgToUid(
+              CONTROL_MESSAGE_TYPE.controlMessageToUid,
+              controlMessageEnum.muteVideo,
+              uid,
+            );
+          }
+          break;
+      }
+    } else {
+      console.error('A host can only mute audience audio or video.');
+    }
+  };
+}
+
+export default useRemoteMute;

package/template/src/utils/useSendControlMessage.ts

@@ -0,0 +1,51 @@
+/*
+********************************************
+ Copyright © 2021 Agora Lab, Inc., all rights reserved.
+ AppBuilder and all associated components, source code, APIs, services, and documentation 
+ (the “Materials”) are owned by Agora Lab, Inc. and its licensors. The Materials may not be 
+ accessed, used, modified, or distributed for any purpose without a license from Agora Lab, Inc.  
+ Use without a license or in violation of any license terms and conditions (including use for 
+ any purpose competitive to Agora Lab, Inc.’s business) is strictly prohibited. For more 
+ information visit https://appbuilder.agora.io. 
+*********************************************
+*/
+import {UidType} from '../../agora-rn-uikit';
+import {useContext} from 'react';
+import ChatContext, {controlMessageEnum} from '../components/ChatContext';
+import {LiveStreamControlMessageEnum} from '../components/livestream';
+import {useMeetingInfo} from '../components/meeting-info/useMeetingInfo';
+
+export enum CONTROL_MESSAGE_TYPE {
+  controlMessageToEveryOne,
+  controlMessageToUid,
+}
+function useSendControlMessage() {
+  const {sendControlMessage, sendControlMessageToUid} = useContext(ChatContext);
+  const {isHost} = useMeetingInfo();
+  return (
+    type: CONTROL_MESSAGE_TYPE,
+    message: controlMessageEnum | LiveStreamControlMessageEnum,
+    uid?: UidType,
+  ) => {
+    if (isHost || ($config.EVENT_MODE && $config.RAISE_HAND)) {
+      switch (type) {
+        case CONTROL_MESSAGE_TYPE.controlMessageToEveryOne:
+          sendControlMessage(message);
+          break;
+        case CONTROL_MESSAGE_TYPE.controlMessageToUid:
+          if (uid) {
+            sendControlMessageToUid(message, uid);
+          } else {
+            console.error('UID should be passed');
+          }
+          break;
+        default:
+          break;
+      }
+    } else {
+      console.error('A host can only send the control message.');
+    }
+  };
+}
+
+export default useSendControlMessage;

package/template/src/utils/useSendMessage.ts

@@ -0,0 +1,40 @@
+/*
+********************************************
+ Copyright © 2021 Agora Lab, Inc., all rights reserved.
+ AppBuilder and all associated components, source code, APIs, services, and documentation 
+ (the “Materials”) are owned by Agora Lab, Inc. and its licensors. The Materials may not be 
+ accessed, used, modified, or distributed for any purpose without a license from Agora Lab, Inc.  
+ Use without a license or in violation of any license terms and conditions (including use for 
+ any purpose competitive to Agora Lab, Inc.’s business) is strictly prohibited. For more 
+ information visit https://appbuilder.agora.io. 
+*********************************************
+*/
+import {useContext} from 'react';
+import ChatContext from '../components/ChatContext';
+import {UidType} from '../../agora-rn-uikit';
+
+export enum MESSAGE_TYPE {
+  group,
+  private,
+}
+function useSendMessage() {
+  const {sendMessage, sendMessageToUid} = useContext(ChatContext);
+  return (type: MESSAGE_TYPE, message: string, uid?: UidType) => {
+    switch (type) {
+      case MESSAGE_TYPE.group:
+        sendMessage(message);
+        break;
+      case MESSAGE_TYPE.private:
+        if (uid) {
+          sendMessageToUid(message, uid);
+        } else {
+          console.error('To send the private message, UID should be passed');
+        }
+        break;
+      default:
+        break;
+    }
+  };
+}
+
+export default useSendMessage;

package/template/src/utils/useSetName.ts

@@ -0,0 +1,20 @@
+/*
+********************************************
+ Copyright © 2021 Agora Lab, Inc., all rights reserved.
+ AppBuilder and all associated components, source code, APIs, services, and documentation
+ (the “Materials”) are owned by Agora Lab, Inc. and its licensors. The Materials may not be
+ accessed, used, modified, or distributed for any purpose without a license from Agora Lab, Inc.
+ Use without a license or in violation of any license terms and conditions (including use for
+ any purpose competitive to Agora Lab, Inc.’s business) is strictly prohibited. For more
+ information visit https://appbuilder.agora.io.
+*********************************************
+*/
+import {useContext} from 'react';
+import ChatContext from '../components/ChatContext';
+
+function useSetName() {
+  const {setDisplayName} = useContext(ChatContext);
+  return setDisplayName;
+}
+
+export default useSetName;

package/template/src/utils/useSetUnreadMessageCount.ts

@@ -0,0 +1,43 @@
+import {UidType} from '../../agora-rn-uikit';
+import {useChatNotification} from '../components/chat-notification/useChatNotification';
+
+export enum SET_UNREAD_MESSAGE_COUNT_TYPE {
+  setPublicMessageCount,
+  setIndividualMessageCount,
+}
+
+const useSetUnreadMessageCount = () => {
+  const {setUnreadIndividualMessageCount, setUnreadGroupMessageCount} =
+    useChatNotification();
+  return (
+    type: SET_UNREAD_MESSAGE_COUNT_TYPE,
+    count: number,
+    uid?: UidType,
+  ) => {
+    switch (type) {
+      case SET_UNREAD_MESSAGE_COUNT_TYPE.setPublicMessageCount:
+        setUnreadGroupMessageCount(count);
+        break;
+      case SET_UNREAD_MESSAGE_COUNT_TYPE.setIndividualMessageCount:
+        if (uid) {
+          setUnreadIndividualMessageCount((prevState) => {
+            if (prevState && prevState.hasOwnProperty(uid)) {
+              return {
+                ...prevState,
+                [uid]: count,
+              };
+            } else {
+              console.error(`ERROR: Invalid UID`);
+              return prevState;
+            }
+          });
+        } else {
+          console.error('UID must be passed for setIndividualMessageCount.');
+        }
+        break;
+      default:
+        break;
+    }
+  };
+};
+export default useSetUnreadMessageCount;

package/template/src/utils/useSidePanel.tsx

@@ -0,0 +1,41 @@
+/*
+********************************************
+ Copyright © 2021 Agora Lab, Inc., all rights reserved.
+ AppBuilder and all associated components, source code, APIs, services, and documentation 
+ (the “Materials”) are owned by Agora Lab, Inc. and its licensors. The Materials may not be 
+ accessed, used, modified, or distributed for any purpose without a license from Agora Lab, Inc.  
+ Use without a license or in violation of any license terms and conditions (including use for 
+ any purpose competitive to Agora Lab, Inc.’s business) is strictly prohibited. For more 
+ information visit https://appbuilder.agora.io. 
+*********************************************
+*/
+
+import React, {SetStateAction} from 'react';
+import {SidePanelType} from '../subComponents/SidePanelEnum';
+import {createHook} from 'fpe-implementation';
+
+export interface SidePanelContextInterface {
+  sidePanel: SidePanelType;
+  setSidePanel: React.Dispatch<SetStateAction<SidePanelType>>;
+}
+
+const SidePanelContext = React.createContext<SidePanelContextInterface>({
+  sidePanel: SidePanelType.None,
+  setSidePanel: () => {},
+});
+
+interface SidePanelProviderProps {
+  value: SidePanelContextInterface;
+  children: React.ReactNode;
+}
+const SidePanelProvider = (props: SidePanelProviderProps) => {
+  return (
+    <SidePanelContext.Provider value={{...props.value}}>
+      {props.children}
+    </SidePanelContext.Provider>
+  );
+};
+
+const useSidePanel = createHook(SidePanelContext);
+
+export {SidePanelProvider, useSidePanel};

package/template/src/utils/useString.ts

@@ -0,0 +1,61 @@
+/*
+********************************************
+ Copyright © 2021 Agora Lab, Inc., all rights reserved.
+ AppBuilder and all associated components, source code, APIs, services, and documentation 
+ (the “Materials”) are owned by Agora Lab, Inc. and its licensors. The Materials may not be 
+ accessed, used, modified, or distributed for any purpose without a license from Agora Lab, Inc.  
+ Use without a license or in violation of any license terms and conditions (including use for 
+ any purpose competitive to Agora Lab, Inc.’s business) is strictly prohibited. For more 
+ information visit https://appbuilder.agora.io. 
+*********************************************
+*/
+import {useFpe} from 'fpe-api';
+import {useLanguage} from '../language/useLanguage';
+import {DEFAULT_I18_DATA} from '../language';
+import {TextDataInterface} from '../language/default-labels/index';
+
+export function usei18nData(
+  selectedLanguageCode: string = DEFAULT_I18_DATA.locale,
+) {
+  const languageData = useFpe((data) => data?.i18n);
+  if (
+    !selectedLanguageCode ||
+    !languageData ||
+    (languageData && !Array.isArray(languageData)) ||
+    (languageData && Array.isArray(languageData) && !languageData.length)
+  ) {
+    return DEFAULT_I18_DATA.data;
+  } else {
+    let selectedLanguageData = languageData.find(
+      (item) => item.locale === selectedLanguageCode,
+    );
+    if (selectedLanguageData && selectedLanguageData.data) {
+      return {
+        ...DEFAULT_I18_DATA.data,
+        ...selectedLanguageData.data,
+      };
+    } else {
+      return DEFAULT_I18_DATA.data;
+    }
+  }
+}
+
+export function useString<T = string>(
+  keyName: keyof TextDataInterface,
+): (input?: T) => string {
+  const lanCode = useLanguage((data) => data.languageCode);
+  const textData = usei18nData(lanCode);
+  const getString = (input?: T) => {
+    let keyValue = textData ? textData[keyName] : undefined;
+    if (!keyValue) {
+      return '';
+    } else if (typeof keyValue === 'function') {
+      return keyValue(input);
+    } else if (typeof keyValue === 'string') {
+      return keyValue;
+    } else {
+      return '';
+    }
+  };
+  return getString;
+}

package/template/src/utils/useUnreadMessageCount.ts

@@ -0,0 +1,50 @@
+/*
+********************************************
+ Copyright © 2021 Agora Lab, Inc., all rights reserved.
+ AppBuilder and all associated components, source code, APIs, services, and documentation 
+ (the “Materials”) are owned by Agora Lab, Inc. and its licensors. The Materials may not be 
+ accessed, used, modified, or distributed for any purpose without a license from Agora Lab, Inc.  
+ Use without a license or in violation of any license terms and conditions (including use for 
+ any purpose competitive to Agora Lab, Inc.’s business) is strictly prohibited. For more 
+ information visit https://appbuilder.agora.io. 
+*********************************************
+*/
+import {UidType} from '../../agora-rn-uikit';
+import {useChatNotification} from '../components/chat-notification/useChatNotification';
+
+export enum UNREAD_MESSAGE_COUNT_TYPE {
+  GroupAndPrivateCount,
+  GroupCount,
+  PrivateCount,
+  PaticularUserUnReadCount,
+}
+
+function useUnreadMessageCount() {
+  const {
+    totalUnreadCount,
+    unreadGroupMessageCount,
+    unreadPrivateMessageCount,
+    unreadIndividualMessageCount,
+  } = useChatNotification();
+
+  const getUnreadCount = (type: UNREAD_MESSAGE_COUNT_TYPE, uid?: UidType) => {
+    switch (type) {
+      case UNREAD_MESSAGE_COUNT_TYPE.GroupAndPrivateCount:
+        return totalUnreadCount;
+      case UNREAD_MESSAGE_COUNT_TYPE.GroupCount:
+        return unreadGroupMessageCount;
+      case UNREAD_MESSAGE_COUNT_TYPE.PrivateCount:
+        return unreadPrivateMessageCount;
+      case UNREAD_MESSAGE_COUNT_TYPE.PaticularUserUnReadCount:
+        return uid && unreadIndividualMessageCount[uid]
+          ? unreadIndividualMessageCount[uid]
+          : 0;
+      default:
+        return 0;
+    }
+  };
+
+  return getUnreadCount;
+}
+
+export default useUnreadMessageCount;

package/template/src/utils/useUserList.ts

@@ -0,0 +1,26 @@
+/*
+********************************************
+ Copyright © 2021 Agora Lab, Inc., all rights reserved.
+ AppBuilder and all associated components, source code, APIs, services, and documentation 
+ (the “Materials”) are owned by Agora Lab, Inc. and its licensors. The Materials may not be 
+ accessed, used, modified, or distributed for any purpose without a license from Agora Lab, Inc.  
+ Use without a license or in violation of any license terms and conditions (including use for 
+ any purpose competitive to Agora Lab, Inc.’s business) is strictly prohibited. For more 
+ information visit https://appbuilder.agora.io. 
+*********************************************
+*/
+import {useRenderContext} from 'fpe-api';
+/**
+ * This hook will fetch the user list
+ * @returns userList
+ */
+
+function useUserList() {
+  const {renderPosition, renderList} = useRenderContext();
+  return {
+    renderList: renderList,
+    renderPosition: renderPosition,
+  };
+}
+
+export default useUserList;

package/template/tsconfig.json

@@ -10,21 +10,21 @@
     "allowJs": true,                          /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
     "jsx": "react-native",                    /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
     // "sourceMap": true,                     /* Generates corresponding '.map' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
     // "outDir": "./",                        /* Redirect output structure to the directory. */
     // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
     // "removeComments": true,                /* Do not emit comments to output. */
-    "noEmit": true,                           /* Do not emit outputs. */
+    "noEmit": false,                           /* Do not emit outputs. */
     // "incremental": true,                   /* Enable incremental compilation */
     // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
     // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
     "isolatedModules": true,                  /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
 
     /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    "strict": false,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": false,                 /* Raise error on expressions and declarations with an implied 'any' type. */
     // "strictNullChecks": true,              /* Enable strict null checks. */
     // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
     // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */