agora-appbuilder-core 4.1.3 → 4.1.4-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agora-appbuilder-core",
-  "version": "4.1.3",
+  "version": "4.1.4-beta.1",
   "description": "React Native template for RTE app builder",
   "main": "index.js",
   "files": [

package/template/customization-api/utils.ts

@@ -55,3 +55,4 @@ export {useActionSheet} from '../src/utils/useActionSheet';
 export {default as PlatformWrapper} from '../src/utils/PlatformWrapper';
 export {useSpotlight} from '../src/utils/useSpotlight';
 export {useActiveUids} from '../src/utils/useActiveUids';
+export {default as useUserBan} from '../src/utils/useUserBan';

package/template/defaultConfig.js

@@ -76,8 +76,8 @@ const DefaultConfig = {
   CHAT_ORG_NAME: '',
   CHAT_APP_NAME: '',
   CHAT_URL: '',
-  CLI_VERSION: '3.1.3',
-  CORE_VERSION: '4.1.3',
+  CLI_VERSION: '3.1.4-beta.1',
+  CORE_VERSION: '4.1.4-beta.1',
   DISABLE_LANDSCAPE_MODE: false,
   STT_AUTO_START: false,
   CLOUD_RECORDING_AUTO_START: false,

package/template/src/SDKAppWrapper.tsx

@@ -24,6 +24,7 @@ export interface AppBuilderSdkApiInterface {
     preference?: {
       disableShareTile: boolean;
       disableVideoProcessors: boolean;
+      userRemovalTimeout: number;
     },
   ) => Promise<meetingData>;
   joinPrecall: (
@@ -33,6 +34,7 @@ export interface AppBuilderSdkApiInterface {
     preference?: {
       disableShareTile: boolean;
       disableVideoProcessors: boolean;
+      userRemovalTimeout: number;
     },
   ) => Promise<
     [

package/template/src/components/EventsConfigure.tsx

@@ -244,6 +244,7 @@ const EventsConfigure: React.FC<Props> = ({
   }, [defaultContent]);
   const {
     data: {isHost, roomId},
+    roomPreference: {userRemovalTimeout},
   } = useRoomInfo();
   const {setRoomInfo} = useSetRoomInfo();
   const isHostRef = React.useRef(isHost);
@@ -402,9 +403,13 @@ const EventsConfigure: React.FC<Props> = ({
         primaryBtn: null,
         secondaryBtn: null,
       });
-      setTimeout(() => {
+      if (userRemovalTimeout > 0) {
+        setTimeout(() => {
+          executeEndCall();
+        }, userRemovalTimeout);
+      } else {
         executeEndCall();
-      }, 5000);
+      }
     });
 
     events.on(controlMessageEnum.requestAudio, () => {

package/template/src/components/SdkApiContext.tsx

@@ -30,6 +30,7 @@ type SdkApiContextInterface = {
         preference: {
           disableShareTile: boolean;
           disableVideoProcessors: boolean;
+          userRemovalTimeout: number;
         };
         promise: extractPromises<_InternalSDKMethodEventsMap['join']>;
       }

package/template/src/components/participants/UserActionMenuOptions.tsx

@@ -100,6 +100,7 @@ export default function UserActionMenuOptionsOptions(
   const {hostUids, audienceUids} = useLiveStreamDataContext();
   const {
     data: {isHost},
+    roomPreference: {userRemovalTimeout},
   } = useRoomInfo();
   const remoteRequest = useRemoteRequest();
   const remoteMute = useRemoteMute();
@@ -516,15 +517,19 @@ export default function UserActionMenuOptionsOptions(
           setModalVisible={setRemoveMeetingPopupVisible}
           username={user.name}
           removeUserFromMeeting={() => {
-            Toast.show({
-              leadingIconName: 'info',
-              type: 'info',
-              text1: toastlabel(trimText(user.name)),
-              visibilityTime: 5000,
-              primaryBtn: null,
-              secondaryBtn: null,
-              leadingIcon: null,
-            });
+            userRemovalTimeout > 0 &&
+              Toast.show({
+                leadingIconName: 'info',
+                type: 'info',
+                text1: toastlabel(
+                  trimText(user.name),
+                  userRemovalTimeout / 1000,
+                ),
+                visibilityTime: 5000,
+                primaryBtn: null,
+                secondaryBtn: null,
+                leadingIcon: null,
+              });
             endRemoteCall(user.uid);
           }}
         />

package/template/src/components/room-info/useRoomInfo.tsx

@@ -154,6 +154,7 @@ export const RoomInfoDefaultValue: RoomInfoContextInterface = {
   roomPreference: {
     disableShareTile: false,
     disableVideoProcessors: false,
+    userRemovalTimeout: 5000,
   },
 };
 

package/template/src/language/default-labels/videoCallScreenLabels.ts

@@ -1189,8 +1189,8 @@ export const VideoCallScreenLabels: I18nVideoCallScreenLabelsInterface = {
   [peoplePanelMeText]: 'Me',
   [peoplePanelPresenterText]: 'Presenter',
 
-  [userRemovedFromTheRoomToastHeading]: name =>
-    `The system will remove ${name} from this call after 5 secs.`,
+  [userRemovedFromTheRoomToastHeading]: (name, time) =>
+    `The system will remove ${name} from this call after ${time} secs.`,
 
   [vbPanelImageUploadErrorToastHeading]: 'Upload Failed',
   [vbPanelImageUploadErrorToastSubHeading]:

package/template/src/logger/AppBuilderLogger.tsx

@@ -103,7 +103,8 @@ type LogType = {
     | 'recording_start'
     | 'recording_stop'
     | 'recordings_get'
-    | 'recording_delete';
+    | 'recording_delete'
+    | 'ban_user';
   [LogSource.Events]: 'CUSTOM_EVENTS' | 'RTM_EVENTS';
   [LogSource.CustomizationAPI]:
     | 'Log'

package/template/src/utils/SdkEvents.ts

@@ -49,6 +49,7 @@ export interface userEventsMapInterface {
   'will-token-expire': () => void;
   'did-token-expire': () => void;
   'token-refreshed': () => void;
+  'rtc-user-removed': (uid: UidType, channel: string) => void;
 }
 
 const SDKEvents = createNanoEvents<userEventsMapInterface>();

package/template/src/utils/SdkMethodEvents.ts

@@ -14,6 +14,7 @@ export interface SdkMethodEvents {
     preference?: {
       disableShareTile: boolean;
       disableVideoProcessors: boolean;
+      userRemovalTimeout: number;
     },
   ): RoomInfoContextInterface['data'];
   microphoneDevice: (deviceId: deviceId) => void;

package/template/src/utils/useJoinRoom.ts

@@ -148,6 +148,7 @@ const JOIN_CHANNEL_PHRASE = gql`
 export interface joinRoomPreference {
   disableShareTile: boolean;
   disableVideoProcessors: boolean;
+  userRemovalTimeout: number;
 }
 
 export default function useJoinRoom() {

package/template/src/utils/useRemoteEndCall.ts

@@ -3,13 +3,14 @@ import {useRoomInfo} from '../components/room-info/useRoomInfo';
 import useIsPSTN from './useIsPSTN';
 import {UidType} from '../../agora-rn-uikit';
 import events, {PersistanceLevel} from '../rtm-events-api';
+import SDKEvents from './SdkEvents';
 
 /**
  * Returns a function to end the call for a remote user with the given uid.
  */
 const useRemoteEndCall = () => {
   const {
-    data: {isHost},
+    data: {isHost, channel},
   } = useRoomInfo();
   const isPSTN = useIsPSTN();
 
@@ -22,6 +23,8 @@ const useRemoteEndCall = () => {
           PersistanceLevel.None,
           uid,
         );
+        // Also Send the SDK event for wrapper app to add extra functinalities like banning user;
+        SDKEvents.emit('rtc-user-removed', uid, channel);
       }
     } else {
       console.error('A host can only remove the audience from the call.');

package/template/src/utils/useUserBan.ts

@@ -0,0 +1,113 @@
+/*
+********************************************
+ 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 from 'react';
+import {logger, LogSource} from '../logger/AppBuilderLogger';
+import {UidType} from '../../agora-rn-uikit';
+import getUniqueID from './getUniqueID';
+import StorageContext from '../components/StorageContext';
+import {useRoomInfo} from 'customization-api';
+
+type BanUserPrivilegesResponse = {
+  success: boolean;
+  message: string;
+  data?: any;
+};
+
+/**
+ * Bans specific user privileges in the channel.
+ * @param hostMeetingId - host meeting id.
+ * @param channel - channel from which to ban the user.
+ * @param uid - user id to ban.
+ * @param duration - how long to ban user in minutes - min 1 max 1440
+ * @param privileges - list of privileges to ban. default is ['join_channel', 'publish_audio', 'publish_video']
+ */
+
+function useUserBan() {
+  const {store} = React.useContext(StorageContext);
+  const {
+    data: {roomId},
+  } = useRoomInfo();
+  const BAN_API_URL = `${$config.BACKEND_ENDPOINT}/v1/channel/user/ban`;
+
+  // duration - how long to ban user in minutes - min 1 max 1440
+  const banUserPrivileges = async (
+    hostMeetingID: string,
+    channel: string,
+    uid: UidType,
+    duration: number,
+    privileges: string[] = ['join_channel', 'publish_audio', 'publish_video'],
+  ): Promise<BanUserPrivilegesResponse> => {
+    if (!uid || !duration || duration < 1 || duration > 1440) {
+      logger.error(
+        LogSource.NetworkRest,
+        'ban_user',
+        `Invalid parameters: uid=${uid}, duration=${duration}`,
+      );
+      return {success: false, message: 'Invalid user ID or duration'};
+    }
+
+    const requestId = getUniqueID();
+    logger.log(
+      LogSource.NetworkRest,
+      'ban_user',
+      `Trying to ban user with id ${uid} in channel : ${channel}`,
+    );
+
+    const payload = {
+      passphrase: hostMeetingID || roomId?.host,
+      uid: uid,
+      channel_name: channel,
+      duration: duration,
+      privileges: privileges,
+    };
+
+    try {
+      const response = await fetch(BAN_API_URL, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+          authorization: store?.token ? `Bearer ${store.token}` : '',
+          'X-Request-Id': requestId,
+          'X-Session-Id': logger.getSessionId(),
+        },
+        body: JSON.stringify(payload),
+      });
+
+      if (!response.ok && response.status != 200) {
+        const errorText = await response.text();
+        logger.error(
+          LogSource.NetworkRest,
+          'ban_user',
+          `Failed to ban user with id ${uid}`,
+          errorText,
+        );
+        return {success: false, message: errorText};
+      }
+      return {
+        success: true,
+        message: 'User privileges banned successfully',
+      };
+    } catch (error) {
+      logger.error(
+        LogSource.NetworkRest,
+        'ban_user',
+        `Error while trying to ban user with id ${uid}`,
+        error,
+      );
+      return {success: false, message: 'Error while banning the user'};
+    }
+  };
+
+  return banUserPrivileges;
+}
+
+export default useUserBan;