@100mslive/react-native-room-kit 1.0.1 → 1.0.2-beta.1

package/src/types.ts

@@ -1,3 +1,6 @@
+import type { HMSException, HMSPeer } from "@100mslive/react-native-hms";
+import type { HMSIOSScreenShareConfig, OnLeaveHandler } from "./utils/types";
+
 export enum MeetingState {
   NOT_JOINED,
   IN_PREVIEW,
@@ -5,3 +8,71 @@ export enum MeetingState {
   MEETING_ENDED,
   ERROR,
 }
+export interface HMSPrebuiltProps {
+  roomCode: string;
+  options?: {
+    userName?: string;
+    userId?: string;
+    endPoints?: {
+      init: string;
+      token: string;
+      layout: string;
+    };
+    debugMode?: boolean;
+    ios?: HMSIOSScreenShareConfig;
+  };
+  /**
+   * onLeave - Optional callback function
+   *
+   * It will be invoked when user leaves meeting or user is removed from the room
+   */
+  onLeave?: OnLeaveHandler;
+  /**
+   * [Android Only] handleBackButton - `Optional<Boolean>` | Default value - `false`
+   *
+   * When `true`, Leave modal will open on press of back button on android
+   * otherwise user will leave meeting immediately without any confirmation modal opening
+   *
+   * Example usage:
+   * ```jsx
+   * const isScreenFocused = useIsFocused();
+   *
+   * ...
+   *
+   * <HMSPrebuilt
+   *  {...}
+   *  handleBackButton={isScreenFocused}
+   * />
+   * ```
+   */
+  handleBackButton?: boolean;
+  /**
+   * [Android Only] autoEnterPipMode - `Optional<Boolean>` | Default value - `false`
+   *
+   * When `true`, App will go into PIP mode automatically when user tries to leave or minimize app while it is inside room
+   *
+   * Example usage:
+   * ```jsx
+   * <HMSPrebuilt
+   *  {...}
+   *  autoEnterPipMode={true}
+   * />
+   * ```
+   */
+  autoEnterPipMode?: boolean;
+}
+
+export enum NotificationTypes {
+  ROLE_CHANGE_DECLINED = 'role_change_declined',
+  RECONNECTING = 'reconnecting',
+  HAND_RAISE = 'hand_raise',
+  LOCAL_SCREENSHARE = 'local_screenshare',
+  ERROR = 'error',
+  TERMINAL_ERROR = 'terminal_error',
+}
+
+export type Notification =
+  | { id: string; type: NotificationTypes; }
+  | { id: string; type: NotificationTypes; message: string; }
+  | { id: string; type: NotificationTypes; peer: HMSPeer; }
+  | { id: string; type: NotificationTypes; exception: HMSException; }

package/src/utils/types.ts

@@ -85,6 +85,8 @@ export type HMSIOSScreenShareConfig = {
   preferredExtension: string;
 };
 
+export type OnLeaveHandler = (reason: OnLeaveReason) => void;
+
 export const SUPPORTED_ASPECT_RATIOS = [
   { value: 16 / 9, id: '16:9' },
   { value: 9 / 16, id: '9:16' },
@@ -104,3 +106,28 @@ export const ChatBottomSheetTabs = ['Chat', 'Participants'] as const;
 export const ChatBroadcastFilter = { name: 'everyone' } as const;
 
 export const PeerListRefreshInterval = 5000; // in milliseconds
+
+export enum OnLeaveReason {  
+  /**
+   * User left the meeting room by pressing the "Leave" or "End Stream" button in Leave Modal
+   */
+  LEAVE = 'leave',
+  /**
+   * User was removed from the meeting room by another HMSPeer
+   */
+  PEER_KICKED = 'peer_kicked',
+  /**
+   * Meeting Room was ended by user or another HMSPeer
+   */
+  ROOM_END = 'room_ended',
+  /**
+   * Due to network issues, user left the meeting room
+   */
+  NETWORK_ISSUES = 'network_issues',
+  /**
+   * User left the meeting room by pressing the "end" button in PIP window
+   */
+  PIP = 'pip',
+};
+
+export const TerminalExceptionCodes = [4005, 1003, 2000, "4005", "1003", "2000"];

package/src/utils.ts

@@ -22,9 +22,3 @@ export const getJoinConfig = (): typeof DEFAULT_JOINING_CONFIG => {
 
   return config;
 };
-
-export enum NotificationTypes {
-  ROLE_CHANGE_DECLINED = 'role_change_declined',
-  HAND_RAISE = 'hand_raise',
-  LOCAL_SCREENSHARE = 'local_screenshare',
-}