@100mslive/roomkit-react 0.1.12 → 0.1.13

package/dist/{HLSView-PWVM4OIP.js → HLSView-IENE4HRP.js}

@@ -22,7 +22,7 @@ import {
   init_define_process_env,
   styled,
   useTheme
-} from "./chunk-WREKGNP6.js";
+} from "./chunk-U4AB6X6M.js";
 
 // src/Prebuilt/layouts/HLSView.jsx
 init_define_process_env();
@@ -880,4 +880,4 @@ var HLSView_default = HLSView;
 export {
   HLSView_default as default
 };
-//# sourceMappingURL=HLSView-PWVM4OIP.js.map
+//# sourceMappingURL=HLSView-IENE4HRP.js.map

package/dist/Prebuilt/App.d.ts

@@ -15,8 +15,6 @@ export declare type HMSPrebuiltProps = {
     options?: HMSPrebuiltOptions;
     screens?: Screens;
     authToken?: string;
-    roomId?: string;
-    role?: string;
     onLeave?: () => void;
     onJoin?: () => void;
     /**

package/dist/Prebuilt/AppContext.d.ts

@@ -1,8 +1,6 @@
 import React from 'react';
 declare type HMSPrebuiltContextType = {
     roomCode: string;
-    roomId?: string;
-    role?: string;
     userName?: string;
     userId?: string;
     containerSelector: string;

package/dist/Prebuilt/common/constants.d.ts

@@ -0,0 +1,110 @@
+export declare const DEFAULT_WAITING_VIEWER_ROLE = "waiting-room";
+export declare const QUERY_PARAM_SKIP_PREVIEW = "skip_preview";
+export declare const QUERY_PARAM_SKIP_PREVIEW_HEADFUL = "skip_preview_headful";
+export declare const QUERY_PARAM_NAME = "name";
+export declare const QUERY_PARAM_VIEW_MODE = "ui_mode";
+export declare const QUERY_PARAM_PREVIEW_AS_ROLE = "preview_as_role";
+export declare const UI_MODE_GRID = "grid";
+export declare const MAX_TOASTS = 5;
+export declare const RTMP_RECORD_RESOLUTION_MIN = 480;
+export declare const RTMP_RECORD_RESOLUTION_MAX = 1280;
+export declare const RTMP_RECORD_DEFAULT_RESOLUTION: {
+    width: number;
+    height: number;
+};
+export declare const EMOJI_REACTION_TYPE = "EMOJI_REACTION";
+export declare const CHAT_SELECTOR: {
+    PEER_ID: string;
+    ROLE: string;
+};
+export declare const APP_DATA: {
+    uiSettings: string;
+    chatOpen: string;
+    chatSelector: string;
+    chatDraft: string;
+    appConfig: string;
+    sidePane: string;
+    hlsStats: string;
+    waitingViewerRole: string;
+    subscribedNotifications: string;
+    logo: string;
+    appLayout: string;
+    hlsStarted: string;
+    rtmpStarted: string;
+    recordingStarted: string;
+    embedConfig: string;
+    pinnedTrackId: string;
+    dropdownList: string;
+    authToken: string;
+    pdfConfig: string;
+    minimiseInset: string;
+    activeScreensharePeerId: string;
+    disableNotifications: string;
+    pollState: string;
+    background: string;
+    backgroundType: string;
+};
+export declare const UI_SETTINGS: {
+    isAudioOnly: string;
+    maxTileCount: string;
+    uiViewMode: string;
+    showStatsOnTiles: string;
+    enableAmbientMusic: string;
+    mirrorLocalVideo: string;
+};
+export declare const SIDE_PANE_OPTIONS: {
+    PARTICIPANTS: string;
+    CHAT: string;
+    STREAMING: string;
+    POLLS: string;
+    VB: string;
+};
+export declare const POLL_STATE: {
+    pollInView: string;
+    view: string;
+};
+export declare const POLL_VIEWS: {
+    CREATE_POLL_QUIZ: string;
+    CREATE_QUESTIONS: string;
+    VOTE: string;
+    RESULTS: string;
+};
+export declare const SUBSCRIBED_NOTIFICATIONS: {
+    PEER_JOINED: string;
+    PEER_LEFT: string;
+    METADATA_UPDATED: string;
+    NEW_MESSAGE: string;
+    ERROR: string;
+};
+export declare const CREATE_ROOM_DOC_URL = "https://github.com/100mslive/100ms-web/wiki/Creating-and-joining-a-room";
+export declare const HLS_TIMED_METADATA_DOC_URL = "https://www.100ms.live/docs/javascript/v2/how--to-guides/record-and-live-stream/hls/hls-timed-metadata";
+export declare const REMOTE_STOP_SCREENSHARE_TYPE = "REMOTE_STOP_SCREENSHARE";
+export declare const isChrome: boolean;
+export declare const isFirefox: boolean;
+export declare const isSafari: boolean;
+export declare const isIOS: boolean;
+export declare const isMacOS: boolean;
+export declare const isAndroid: boolean;
+export declare const isIPadOS = false;
+export declare enum SESSION_STORE_KEY {
+    TRANSCRIPTION_STATE = "transcriptionState",
+    PINNED_MESSAGES = "pinnedMessages",
+    SPOTLIGHT = "spotlight",
+    CHAT_PEER_BLACKLIST = "chatPeerBlacklist",
+    CHAT_MESSAGE_BLACKLIST = "chatMessageBlacklist",
+    CHAT_STATE = "chatState"
+}
+export declare enum INTERACTION_TYPE {
+    POLL = "Poll",
+    QUIZ = "Quiz"
+}
+export declare enum QUESTION_TYPE_TITLE {
+    'single-choice' = "Single Choice",
+    'multiple-choice' = "Multiple Choice"
+}
+export declare enum QUESTION_TYPE {
+    SINGLE_CHOICE = "single-choice",
+    MULTIPLE_CHOICE = "multiple-choice"
+}
+export declare const ROLE_CHANGE_DECLINED = "role_change_declined";
+export declare const DEFAULT_PORTAL_CONTAINER = "#prebuilt-container";

package/dist/Prebuilt/components/AppData/AppData.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const AppData: React.MemoExoticComponent<() => React.JSX.Element>;

package/dist/Prebuilt/components/Chat/MwebChatOption.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+export declare const MwebChatOption: ({ icon, text, onClick, color, }: {
+    icon: any;
+    text: string;
+    onClick: () => void | Promise<void>;
+    color: string;
+}) => React.JSX.Element;

package/dist/Prebuilt/components/Chat/Navigation.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+export declare const Navigation: ({ total, index, showPrevious, showNext, isMobile, }: {
+    total: number;
+    index: number;
+    showPrevious: () => void;
+    showNext: () => void;
+    isMobile: boolean;
+}) => React.JSX.Element | null;

package/dist/Prebuilt/components/Chat/PinnedMessage.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+export declare const PinnedMessage: ({ clearPinnedMessage }: {
+    clearPinnedMessage: (index: number) => void;
+}) => React.JSX.Element | null;

package/dist/Prebuilt/components/Footer/Footer.d.ts

@@ -1,6 +1,7 @@
 import React from 'react';
-import { ConferencingScreen, DefaultConferencingScreen_Elements, HLSLiveStreamingScreen_Elements } from '@100mslive/types-prebuilt';
+import { ConferencingScreen } from '@100mslive/types-prebuilt';
+import { ConferencingScreenElements } from '../../provider/roomLayoutProvider/hooks/useRoomLayoutScreen';
 export declare const Footer: ({ screenType, elements, }: {
     screenType: keyof ConferencingScreen;
-    elements: DefaultConferencingScreen_Elements | HLSLiveStreamingScreen_Elements;
+    elements: ConferencingScreenElements;
 }) => React.JSX.Element;

package/dist/Prebuilt/components/Notifications/ChatNotifications.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const ChatNotifications: () => React.JSX.Element;

package/dist/Prebuilt/components/Preview/PreviewJoin.d.ts

@@ -8,8 +8,9 @@ export declare const PreviewTile: ({ name, error }: {
     name: string;
     error?: boolean | undefined;
 }) => React.JSX.Element;
-export declare const PreviewControls: ({ hideSettings }: {
+export declare const PreviewControls: ({ hideSettings, vbEnabled }: {
     hideSettings: boolean;
+    vbEnabled: boolean;
 }) => React.JSX.Element;
 export declare const PreviewSettings: React.MemoExoticComponent<() => React.JSX.Element>;
 export default PreviewJoin;

package/dist/Prebuilt/components/VirtualBackground/VBCollection.d.ts

@@ -1,4 +1,5 @@
 import React from 'react';
+import { HMSVirtualBackgroundTypes } from '@100mslive/hms-virtual-background';
 export declare const VBCollection: ({ options, title, activeBackgroundType, activeBackground, }: {
     options: {
         title?: string | undefined;
@@ -9,5 +10,5 @@ export declare const VBCollection: ({ options, title, activeBackgroundType, acti
     }[];
     title: string;
     activeBackground: HTMLImageElement | string;
-    activeBackgroundType: string;
+    activeBackgroundType: HMSVirtualBackgroundTypes;
 }) => React.JSX.Element | null;

package/dist/Prebuilt/components/VirtualBackground/VBPicker.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import { VirtualBackground } from '@100mslive/types-prebuilt/elements/virtual_background';
+export declare const VBPicker: ({ background_media }?: VirtualBackground) => React.JSX.Element | null;

package/dist/Prebuilt/components/VirtualBackground/constants.d.ts

@@ -1,9 +1,3 @@
 import { HMSVBPlugin } from '@100mslive/hms-virtual-background';
-export declare const VB_EFFECT: {
-    BLUR: string;
-    BEAUTIFY: string;
-    NONE: string;
-    MEDIA: string;
-};
 export declare const defaultMedia: string[];
 export declare const vbPlugin: HMSVBPlugin;

package/dist/Prebuilt/components/hooks/useChatBlacklist.d.ts

@@ -0,0 +1,4 @@
+import { SESSION_STORE_KEY } from '../../common/constants';
+export declare const useChatBlacklist: (sessionStoreKey: SESSION_STORE_KEY.CHAT_MESSAGE_BLACKLIST | SESSION_STORE_KEY.CHAT_PEER_BLACKLIST) => {
+    blacklistItem: (blacklistedIDs: string[], blacklistID: string) => Promise<any>;
+};

package/dist/Prebuilt/components/hooks/useSetPinnedMessages.d.ts

@@ -0,0 +1,16 @@
+import { HMSMessage } from '@100mslive/react-sdk';
+declare type PinnedMessage = {
+    text: string;
+    id: string;
+    authorId: string;
+    pinnedBy: string;
+};
+/**
+ * set pinned chat message by updating the session store
+ */
+export declare const useSetPinnedMessages: () => {
+    setPinnedMessages: (pinnedMessages: PinnedMessage[] | undefined, message: HMSMessage, pinnedBy: string) => Promise<void>;
+    removePinnedMessage: (pinnedMessages: PinnedMessage[] | undefined, indexToRemove: number) => Promise<void>;
+    unpinBlacklistedMessages: (pinnedMessages: PinnedMessage[] | undefined, blacklistedPeerIDSet: Set<string>, blacklistedMessageIDSet: Set<string>) => Promise<void>;
+};
+export {};

package/dist/Prebuilt/provider/roomLayoutProvider/hooks/useRoomLayoutScreen.d.ts

@@ -1,4 +1,4 @@
-import { ConferencingScreen, DefaultPreviewScreen_Elements, Screens } from '@100mslive/types-prebuilt';
+import { ConferencingScreen, DefaultConferencingScreen_Elements, DefaultPreviewScreen_Elements, HLSLiveStreamingScreen_Elements, Screens } from '@100mslive/types-prebuilt';
 export declare type useRoomLayoutScreenProps = {
     screen: keyof Screens;
 };
@@ -7,9 +7,10 @@ export declare function useRoomLayoutPreviewScreen(): {
     elements: DefaultPreviewScreen_Elements | undefined;
     screenType: "default" | undefined;
 };
+export declare type ConferencingScreenElements = DefaultConferencingScreen_Elements & HLSLiveStreamingScreen_Elements;
 export declare function useRoomLayoutConferencingScreen(): {
     hideSections: string[];
-    elements: import("@100mslive/types-prebuilt").DefaultConferencingScreen_Elements | import("@100mslive/types-prebuilt").HLSLiveStreamingScreen_Elements | undefined;
+    elements: ConferencingScreenElements;
     screenType: keyof ConferencingScreen;
 };
 export declare function useRoomLayoutLeaveScreen(): {