agora-appbuilder-core 2.3.0-beta.9 → 3.0.1

package/template/src/custom-events/CustomEvents.ts

@@ -1,238 +0,0 @@
-/*
-********************************************
- Copyright © 2022 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. 
-*********************************************
-*/
-
-('use strict');
-import RtmEngine from 'agora-react-native-rtm';
-import RTMEngine from '../rtm/RTMEngine';
-import {ToOptions, EventPayload} from './types';
-import {EventUtils, eventMessageType} from '../rtm-events';
-import {TEventCallback, EventSourceEnum} from './types';
-import {adjustUID} from '../rtm/utils';
-
-class CustomEvents {
-  private engine!: RtmEngine;
-  private source: EventSourceEnum = EventSourceEnum.core;
-
-  constructor(source?: EventSourceEnum) {
-    this.engine = RTMEngine.getInstance().engine;
-    if (source) {
-      this.source = source;
-    }
-  }
-
-  /**
-   * Persists the data in the local attributes of the user
-   *
-   * @param {string} evt  to be stored in rtm Attribute key
-   * @param {any} payload to be stored in rtm Attribute value
-   * @api private
-   */
-  private _persist = async (evt: string, payload: any) => {
-    try {
-      const localUserId = RTMEngine.getInstance().localUid;
-      const rtmAttribute = {key: evt, value: JSON.stringify(payload)};
-      // Step 1: Call RTM API to update local attributes
-      await this.engine.addOrUpdateLocalUserAttributes([rtmAttribute]);
-    } catch (error) {
-      console.log(
-        'CUSTOM_EVENT_API error occured while updating the value ',
-        error,
-      );
-    }
-  };
-
-  /**
-   *
-   */
-  private _validateEvt = (evt: string): boolean => {
-    if (typeof evt !== 'string') {
-      throw Error(
-        `CUSTOM_EVENT_API Event name cannot be of type ${typeof evt}`,
-      );
-    }
-    if (evt.trim() == '') {
-      throw Error(`CUSTOM_EVENT_API Name or function cannot be empty`);
-    }
-    return true;
-  };
-
-  private _validateListener = (listener: TEventCallback): boolean => {
-    if (typeof listener !== 'function') {
-      throw Error(
-        `CUSTOM_EVENT_API Function cannot be of type ${typeof listener}`,
-      );
-    }
-    return true;
-  };
-
-  /**
-   * Sets the local attribute of user if  persist level is 2 or 3.
-   * If param 'to' is not provided, message is sent in the channel.
-   * If param 'to' is provided message is sent to that individual.
-   * If param 'to' is an array of uids is provided then message is sent to all the individual uids in loop.
-   *
-   * @param {any} rtmPayload payload to be sent across
-   * @param {ToOptions} to uid or uids[] of user
-   * @api private
-   */
-  private _send = async (rtmPayload: any, toUid?: ToOptions) => {
-    const to = typeof toUid == 'string' ? parseInt(toUid) : toUid;
-
-    const text = JSON.stringify({
-      type: eventMessageType.CUSTOM_EVENT,
-      msg: rtmPayload,
-    });
-    // Case 1: send to channel
-    if (
-      typeof to === 'undefined' ||
-      (typeof to === 'number' && to <= 0) ||
-      (Array.isArray(to) && to?.length === 0)
-    ) {
-      console.log('CUSTOM_EVENT_API: case 1 executed');
-      try {
-        const channelId = RTMEngine.getInstance().channelUid;
-        await this.engine.sendMessageByChannelId(channelId, text);
-      } catch (error) {
-        console.log('CUSTOM_EVENT_API: send event case 1 error : ', error);
-        throw error;
-      }
-    }
-    // Case 2: send to indivdual
-    if (typeof to === 'number' && to !== 0) {
-      console.log('CUSTOM_EVENT_API: case 2 executed', to);
-      const adjustedUID = adjustUID(to);
-      try {
-        await this.engine.sendMessageToPeer({
-          peerId: `${adjustedUID}`,
-          offline: false,
-          text,
-        });
-      } catch (error) {
-        console.log('CUSTOM_EVENT_API: send event case 2 error : ', error);
-        throw error;
-      }
-    }
-    // Case 3: send to multiple individuals
-    if (typeof to === 'object' && Array.isArray(to)) {
-      console.log('CUSTOM_EVENT_API: case 3 executed', to);
-
-      try {
-        for (const uid of to) {
-          const adjustedUID = adjustUID(uid);
-          await this.engine.sendMessageToPeer({
-            peerId: `${adjustedUID}`,
-            offline: false,
-            text,
-          });
-        }
-      } catch (error) {
-        console.log('CUSTOM_EVENT_API: send event case 3 error : ', error);
-        throw error;
-      }
-    }
-  };
-
-  /**
-   * Listens for a specified event.
-   * Adds a listener function to the specified event.
-   * When the specified event happens, the Events API triggers the callback that you pass.
-   * The listener will not be added if it is a duplicate.
-   *
-   * @param {String} evt Name of the event to attach the listener to.
-   * @param {Function} listener Method to be called when the event is emitted.
-   * @api public
-   */
-  on = (evt: string, listener: TEventCallback) => {
-    try {
-      if (!this._validateEvt(evt) || !this._validateListener(listener)) return;
-      EventUtils.addListener(evt, listener, this.source);
-    } catch (error) {
-      console.log('custom-events-on error: ', error);
-    }
-  };
-
-  /**
-   * Removes a listener function from the specified event if evt and listener function both are provided.
-   * Removes all listeners from a specified event if listener function is not provided.
-   * If you do not specify an event then all listeners will be removed.
-   * That means every event will be emptied.
-   *
-   * @param {String} evt Name of the event to remove the listener from.
-   * @param {Function} listenerToRemove Method to remove from the event.
-   * @api public
-   */
-  off = (evt?: string, listenerToRemove?: TEventCallback) => {
-    try {
-      if (listenerToRemove) {
-        if (
-          this._validateListener(listenerToRemove) &&
-          this._validateEvt(evt)
-        ) {
-          EventUtils.removeListener(evt, listenerToRemove, this.source);
-        }
-      } else if (evt) {
-        if (this._validateEvt(evt)) {
-          EventUtils.removeAllListeners(evt, this.source);
-        }
-      } else {
-        EventUtils.removeAll(this.source);
-      }
-    } catch (error) {
-      console.log('custom-events-off error: ', error);
-    }
-  };
-
-  /**
-   * This method sends p2p or channel message depending upon the 'to' value.
-   *  - If 'to' is provided this method sends p2p message.
-   *  - If 'to' is empty this method sends channel message.
-   *
-   *
-   * @param {String} evt Name of the event to remove the listener from.
-   * @param {EventPayload} payload contains action, level, value metrics.
-   * - action: {string}
-   * - level: 1 | 2 | 3
-   * - value: {string}. NOTICE: value bytelength has MAX_SIZE 32kb limit.
-   * @param {ToOptions} to uid or uid array. The default mode is to send a message in channel.
-   * @api public
-   * */
-  send = async (evt: string, payload: EventPayload, to?: ToOptions) => {
-    if (!this._validateEvt(evt)) return;
-    const {action = '', value = '', level = 1} = payload;
-
-    const rtmPayload = {
-      evt: evt,
-      payload: {
-        action,
-        value,
-        level,
-        source: this.source,
-      },
-    };
-
-    if (level === 2 || level === 3) {
-      console.log('CUSTOM_EVENT_API: Event lifecycle: persist', level);
-      try {
-        await this._persist(evt, {...payload, source: this.source});
-      } catch (error) {
-        console.log('custom-events-persist error: ', error);
-      }
-    }
-    try {
-      await this._send(rtmPayload, to);
-    } catch (error) {
-      console.log('CUSTOM_EVENT_API: sending failed. ', error);
-    }
-  };
-}
-
-export default CustomEvents;

package/template/src/custom-events/index.tsx

@@ -1,4 +0,0 @@
-import CustomEvents from './CustomEvents';
-
-export * from './types';
-export default new CustomEvents();

package/template/src/custom-events/types.ts

@@ -1,51 +0,0 @@
-import {UidType} from '../../agora-rn-uikit';
-type Simplify<T> = T extends infer S ? {[K in keyof S]: S[K]} : never;
-type NoneOf<T> = Simplify<{[K in keyof T]?: never}>;
-type AtMostOneOf<T> =
-  | NoneOf<T>
-  | {[K in keyof T]: Simplify<Pick<T, K> & NoneOf<Omit<T, K>>>}[keyof T];
-
-// export type TEventOptions = AtMostOneOf<IMessageOptions> & IEventOptions;
-
-export type ToOptions = UidType | UidType[];
-
-interface IEventPayloadBase {
-  action?: any;
-}
-
-interface IEventPayloadWithoutAttributes extends IEventPayloadBase {
-  level?: never;
-  value: string;
-}
-
-interface IEventPayloadWithAttributes extends IEventPayloadBase {
-  level: 2 | 3;
-  value: string;
-}
-
-export type EventPayload =
-  | IEventPayloadWithoutAttributes
-  | IEventPayloadWithAttributes
-  | Record<string, never>;
-
-export enum EventSourceEnum {
-  core = 'core',
-  fpe = 'fpe',
-}
-export enum EventLevel {
-  'LEVEL1' = 1,
-  'LEVEL2',
-  'LEVEL3',
-}
-interface dataPayload {
-  action: string;
-  level: 1 | 2 | 3;
-  value: string;
-}
-interface EvtCbPayload {
-  payload: dataPayload;
-  sender: string;
-  ts: number;
-  source: EventSourceEnum;
-}
-export type TEventCallback = (args: EvtCbPayload) => void;

package/template/src/pages/video-call/CustomLayout.ts

@@ -1,17 +0,0 @@
-import {useFpe} from 'fpe-api';
-import {DefaultLayouts} from './DefaultLayouts';
-
-function useCustomLayout() {
-  const fpeLayouts = useFpe((config) => {
-    if (
-      typeof config?.components?.videoCall === 'object' &&
-      config?.components?.videoCall?.customLayout
-    ) {
-      return config.components.videoCall.customLayout(DefaultLayouts);
-    } else {
-      return DefaultLayouts;
-    }
-  });
-  return fpeLayouts;
-}
-export default useCustomLayout;

package/template/src/rtm-events/types.ts

@@ -1,7 +0,0 @@
-export enum eventMessageType {
-  CONTROL_GROUP = 1,
-  CONTROL_PRIVATE,
-  NORMAL_GROUP,
-  NORMAL_PRIVATE,
-  CUSTOM_EVENT,
-}

package/template/src/utils/getMeetingInvite.ts

@@ -1,53 +0,0 @@
-const GetMeetingInviteURL = (
-  baseUrl: string,
-  isHost: boolean,
-  meetingPassphrase: {
-    host?: string;
-    attendee?: string;
-  },
-  isSeparateHostLink: boolean,
-) => {
-  if (isHost) {
-    if (isSeparateHostLink) {
-      return {
-        host: `${baseUrl}/${meetingPassphrase.host}`,
-        attendee: `${baseUrl}/${meetingPassphrase.attendee}`,
-      };
-    } else {
-      return {
-        host: `${baseUrl}/${meetingPassphrase.host}`,
-      };
-    }
-  } else {
-    return {
-      attendee: `${baseUrl}/${meetingPassphrase.attendee}`,
-    };
-  }
-};
-const GetMeetingInviteID = (
-  isHost: boolean,
-  meetingPassphrase: {
-    host?: string;
-    attendee?: string;
-  },
-  isSeparateHostLink: boolean,
-) => {
-  if (isHost) {
-    if (isSeparateHostLink) {
-      return {
-        host: `${meetingPassphrase.host}`,
-        attendee: `${meetingPassphrase.attendee}`,
-      };
-    } else {
-      return {
-        host: `${meetingPassphrase.host}`,
-      };
-    }
-  } else {
-    return {
-      attendee: `${meetingPassphrase.attendee}`,
-    };
-  }
-};
-
-export {GetMeetingInviteURL, GetMeetingInviteID};

package/template/src/utils/useGroupMessages.ts

@@ -1,24 +0,0 @@
-/*
-********************************************
- 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';
-
-/**
- * This hook will fetch the group messages
- * @returns userList
- */
-function useGroupMessages() {
-  const {messageStore} = useChatMessages();
-  return messageStore;
-}
-
-export default useGroupMessages;

package/template/src/utils/useNavParams.ts

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

package/template/src/utils/useNavigateTo.ts

@@ -1,8 +0,0 @@
-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

@@ -1,33 +0,0 @@
-/*
-********************************************
- 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/useSendControlMessage.ts

@@ -1,51 +0,0 @@
-/*
-********************************************
- 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

@@ -1,40 +0,0 @@
-/*
-********************************************
- 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/useSetUnreadMessageCount.ts

@@ -1,43 +0,0 @@
-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/useUnreadMessageCount.ts

@@ -1,50 +0,0 @@
-/*
-********************************************
- 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

@@ -1,26 +0,0 @@
-/*
-********************************************
- 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;