@cometchat/chat-uikit-react 4.3.24 → 5.0.0-beta2

package/dist/types/components/Calling/CometChatOutgoingCall/CometChatOutgoingCall.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Props interface for the outgoing call component
+ */
+interface OutgoingCallProps {
+    /**
+     * Sets the call object for CometChatOutgoingCall.
+     */
+    call: CometChat.Call;
+    /**
+     * Used to disable/enable the sound of outgoing calls.
+     *
+     * @default false
+     * @example disableSoundForCalls={false}
+     */
+    disableSoundForCalls?: boolean;
+    /**
+     * Used to set a custom sound for outgoing calls.
+     *
+     * @example customSoundForCalls='Your Custom Sound For Calls'
+     */
+    customSoundForCalls?: string;
+    /**
+     * Custom view for the outgoing call component.
+     */
+    customView?: any;
+    /**
+     * Triggered when an error occurs in the outgoing call component.
+     */
+    onError?: Function;
+    /**
+     * Triggered when the close button is clicked in the outgoing call component.
+     */
+    onCloseClicked?: Function;
+}
+declare const CometChatOutgoingCall: (props: OutgoingCallProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatOutgoingCall };

package/dist/types/components/Calling/CometChatOutgoingCall/useCometChatOutgoingCall.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Custom hook to handle outgoing call actions like playing audio and pausing it when necessary.
+ * @param playAudio - Function to play audio during the outgoing call.
+ * @param call - Optional CometChat.Call object representing the outgoing call.
+ */
+declare function useCometChatOutgoingCall(playAudio: Function, call?: CometChat.Call): void;
+export { useCometChatOutgoingCall };

package/dist/types/components/Calling/OutgoingCallConfiguration.d.ts

@@ -0,0 +1,8 @@
+export declare class OutgoingCallConfiguration {
+    disableSoundForCalls?: boolean;
+    customSoundForCalls?: string;
+    customView?: any;
+    onError?: Function;
+    onCloseClicked?: Function;
+    constructor(configuration: OutgoingCallConfiguration);
+}

package/dist/types/{Calling → components/Calling}/Utils/utils.d.ts

@@ -1,4 +1,4 @@
-export declare function isSentByMe(call: any, loggedInUser: CometChat.User): boolean;
+export declare function isSentByMe(call: CometChat.Call | any, loggedInUser: CometChat.User): boolean;
 export declare function isMissedCall(call: CometChat.Call, loggedInUser: CometChat.User): boolean;
 export declare function verifyCallUser(call: any, loggedInUser: CometChat.User): any;
 export declare function getCallStatusWithType(call: any, loggedInUser: CometChat.User, includeType?: boolean): string;

package/dist/types/{CometChatConversations/index.d.ts → components/CometChatConversations/CometChatConversations.d.ts}

@@ -1,24 +1,18 @@
-import { AvatarStyle, BadgeStyle, BaseStyle, ConfirmDialogStyle, DateStyle, ListItemStyle, ReceiptStyle } from "@cometchat/uikit-elements";
-import { CSSProperties, JSX } from "react";
-import { CometChatTextFormatter, ConversationsStyle } from "@cometchat/uikit-shared";
-import { CometChatOption, DatePatterns, SelectionMode, States, TitleAlignment } from "@cometchat/uikit-resources";
-interface IConversationsProps {
+import { JSX } from "react";
+import { CometChatTextFormatter } from "../../formatters/CometChatFormatters/CometChatTextFormatter";
+import { DatePatterns, SelectionMode, States } from "../../Enums/Enums";
+import { CometChatOption } from "../../modals";
+interface ConversationsProps {
     /**
      * Custom view to render on the top-right of the component
      */
-    menus?: JSX.Element;
+    menu?: JSX.Element;
     /**
      * Title of the component
      *
      * @defaultValue `localize("CHATS")`
      */
     title?: string;
-    /**
-     * Alignment of the `title` text
-     *
-     * @defaultValue `TitleAlignment.left`
-     */
-    titleAlignment?: TitleAlignment;
     /**
      * Request builder to fetch conversations
      * @defaultValue Default request builder having the limit set to 30
@@ -39,6 +33,13 @@ interface IConversationsProps {
      * This prop is used if `listItemView` prop is not provided
      */
     subtitleView?: (conversation: CometChat.Conversation) => JSX.Element;
+    /**
+     * Custom tail view to be rendered for each conversation in the fetched list
+     *
+     * @remarks
+     * This prop is used if `listItemView` prop is not provided
+     */
+    tailView?: (conversation: CometChat.Conversation) => JSX.Element;
     /**
      * Hide user presence
      *
@@ -48,12 +49,6 @@ interface IConversationsProps {
      * @defaultValue `false`
      */
     disableUsersPresence?: boolean;
-    /**
-     * Hide the separator at the bottom of the default list item view
-     *
-     * @defaultValue `false`
-     */
-    hideSeparator?: boolean;
     /**
      * Conversation to highlight
      *
@@ -70,11 +65,6 @@ interface IConversationsProps {
      * @defaultValue `SelectionMode.none`
      */
     selectionMode?: SelectionMode;
-    /**
-     * @deprecated
-     *
-     * This property is deprecated as of version 4.3.19 due to newer property 'hideReceipt'. It will be removed in subsequent versions.
-     */
     /**
      * Disable receipt status
      *
@@ -83,15 +73,6 @@ interface IConversationsProps {
      *
      * @defaultValue `false`
      */
-    disableReceipt?: boolean;
-    /**
-   * hide receipt status
-   *
-   * @remarks
-   * If set to true, the receipt status of the message won't be displayed
-   *
-   * @defaultValue `false`
-   */
     hideReceipt?: boolean;
     /**
      * List of actions available on mouse over on the default list item component
@@ -104,85 +85,14 @@ interface IConversationsProps {
      * The date component is inside the tail view of the default list item view when `selectionMode` prop is set to `SelectionMode.none`
      */
     datePattern?: DatePatterns;
-    /**
-     * @deprecated
-     *
-     * This property is deprecated as of version 4.3.8 due to newer property 'passwordGroupIcon'. It will be removed in subsequent versions.
-     */
-    /**
-     * Image URL for the status indicator icon in the default list item view of a conversation related to a password-protected group
-     *
-     * @defaultValue `./assets/locked.svg`
-     */
-    protectedGroupIcon?: string;
-    /**
-     * Image URL for the status indicator icon in the default list item view of a conversation related to a password-protected group
-     *
-     * @defaultValue {undefined}
-     */
-    passwordGroupIcon?: string;
-    /**
-     * Image URL for the status indicator icon in the default list item view of a conversation related to a private group
-     *
-     * @defaultValue `./assets/private.svg`
-     */
-    privateGroupIcon?: string;
-    /**
-     * Image URL for the read status of the sent message
-     *
-     * @defaultValue `./assets/message-read.svg`
-     */
-    readIcon?: string;
-    /**
-     * Image URL for the delivered status of the sent message
-     *
-     * @defaultValue `./assets/message-delivered.svg`
-     */
-    deliveredIcon?: string;
-    /**
-     * Image URL for the wait status of the sent message
-     *
-     * @defaultValue `./assets/wait.svg`
-     */
-    waitIcon?: string;
-    /**
-     * Image URL for the error status of the sent message
-     *
-     * @defaultValue `./assets/warning-small.svg`
-     */
-    errorIcon?: string;
-    /**
-     * Image URL for the sent status of the sent message
-     *
-     * @defaultValue `./assets/message-sent.svg`
-     */
-    sentIcon?: string;
-    /**
-     * Image URL for the default loading view
-     *
-     * @defaultValue `./assets/spinner.svg`
-     */
-    loadingIconURL?: string;
     /**
      * Custom view for the loading state of the component
      */
     loadingStateView?: JSX.Element;
-    /**
-     * Text to display in the default empty view
-     *
-     * @defaultValue `localize("NO_CHATS_FOUND")`
-     */
-    emptyStateText?: string;
     /**
      * Custom view for the empty state of the component
      */
     emptyStateView?: JSX.Element;
-    /**
-     * Text to display in the default error view
-     *
-     * @defaultValue `localize("SOMETHING_WRONG")`
-     */
-    errorStateText?: string;
     /**
      * Custom view for the error state of the component
      */
@@ -207,12 +117,6 @@ interface IConversationsProps {
      * This prop is used if `selectionMode` prop is not `SelectionMode.none`
      */
     onSelect?: (conversation: CometChat.Conversation, selected: boolean) => void;
-    /**
-     * Disable sound for incoming messages
-     *
-     * @defaulValue `false`
-     */
-    disableSoundForMessages?: boolean;
     /**
      * Disable typing indicator display
      *
@@ -220,59 +124,30 @@ interface IConversationsProps {
      */
     disableTyping?: boolean;
     /**
-     * Custom audio sound for incoming messages
-     */
-    customSoundForMessages?: string;
-    /**
-     * Styles to apply to this component
-     */
-    conversationsStyle?: ConversationsStyle;
-    /**
-     * Styles to apply to the delete conversation dialog component
-     */
-    deleteConversationDialogStyle?: ConfirmDialogStyle;
-    /**
-     * Styles to apply to the avatar component of the default list item view
-     */
-    avatarStyle?: AvatarStyle;
-    /**
-     * Styles to apply to the status indicator component of the default list item view
-     */
-    statusIndicatorStyle?: CSSProperties;
-    /**
-     * Styles to apply to the default list item view
-     */
-    listItemStyle?: ListItemStyle;
-    /**
-     * Styles to apply to the badge component
+     * Title of the confirmation dialog.
      *
-     * @remarks
-     * The badge component is inside the tail view of the default list item view when `selectionMode` prop is set to `SelectionMode.none`
      */
-    badgeStyle?: BadgeStyle;
+    confirmDialogTitle?: string;
     /**
-     * Styles to apply to the receipt component
+     * Message displayed in the confirmation dialog.
      *
-     * @remarks
-     * The receipt component is rendered conditionally inside the subtitle view of the default list item view
      */
-    receiptStyle?: ReceiptStyle;
+    confirmDialogMessage?: string;
     /**
-     * Styles to apply to the date component
-     *
-     * @remarks
-     * The date component is inside the tail view of the default list item view when `selectionMode` prop is set to `SelectionMode.none`
-     */
-    dateStyle?: DateStyle;
+    * Text for the cancel button in the confirmation dialog.
+    */
+    cancelButtonText?: string;
     /**
-     * Styles to apply to the backdrop component
+     * Text for the confirm button in the confirmation dialog.
      */
-    backdropStyle?: BaseStyle;
-    confirmDialogTitle?: string;
-    confirmDialogMessage?: string;
-    cancelButtonText?: string;
     confirmButtonText?: string;
+    /**
+     * Disable mentions in conversation. Default value is set to false
+     */
     disableMentions?: boolean;
+    /**
+     * Allows user to pass custom formatters
+     */
     textFormatters?: CometChatTextFormatter[];
 }
 export type Action = {
@@ -340,5 +215,5 @@ export type Action = {
 /**
  * Renders a scrollable list of conversations that has been created in a CometChat app
  */
-export declare function CometChatConversations(props: IConversationsProps): import("react/jsx-runtime").JSX.Element;
+export declare function CometChatConversations(props: ConversationsProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/{CometChatConversations → components/CometChatConversations}/controller.d.ts

@@ -1,4 +1,4 @@
-import { CometChat } from "@cometchat/chat-sdk-javascript";
+import { CometChat } from '@cometchat/chat-sdk-javascript';
 type Args = {
     conversationsRequestBuilder: CometChat.ConversationsRequestBuilder | null;
 };

package/dist/types/{CometChatConversations/hooks.d.ts → components/CometChatConversations/useCometChatConversations.d.ts}

@@ -1,5 +1,6 @@
-import React, { JSX } from "react";
-import { Action } from ".";
+import React from "react";
+import { Action } from "./CometChatConversations";
+import { Conversation } from "@cometchat/chat-sdk-javascript";
 import { ConversationsManager } from "./controller";
 type Args = {
     conversationsRequestBuilder: CometChat.ConversationsRequestBuilder | null;
@@ -7,7 +8,6 @@ type Args = {
     fetchNextAndAppendConversations: (fetchId: string) => Promise<void>;
     fetchNextIdRef: React.MutableRefObject<string>;
     dispatch: React.Dispatch<Action>;
-    confirmDialogElement: JSX.IntrinsicElements["cometchat-confirm-dialog"] | null;
     conversationToBeDeleted: CometChat.Conversation | null;
     errorHandler: (error: unknown) => void;
     refreshSingleConversation: (message: CometChat.BaseMessage, remove?: boolean) => Promise<void>;
@@ -17,6 +17,9 @@ type Args = {
     disableTyping: boolean;
     loggedInUser: CometChat.User | null;
     isFirstReload: boolean;
+    disableUsersPresence?: boolean;
+    activeConversation: Conversation | null;
+    setActiveConversationState: React.Dispatch<React.SetStateAction<Conversation | null>>;
 };
-export declare function Hooks(args: Args): void;
+export declare function useCometChatConversations(args: Args): void;
 export {};

package/dist/types/{CometChatGroupMembers/index.d.ts → components/CometChatGroupMembers/CometChatGroupMembers.d.ts}

@@ -1,57 +1,28 @@
-import { AvatarStyle, ChangeScopeStyle, ListItemStyle } from "@cometchat/uikit-elements";
-import { CSSProperties, JSX } from "react";
-import { CometChatOption, SelectionMode, States, TitleAlignment, UserPresencePlacement } from "@cometchat/uikit-resources";
-import { GroupMembersStyle } from "@cometchat/uikit-shared";
+import { JSX } from "react";
 import { GroupMembersManager } from "./controller";
-interface IGroupMembersProps {
-    /**
-     * Image URL for the back button
-     *
-     * @defaultValue `./assets/backbutton.svg`
-     */
-    backButtonIconURL?: string;
-    /**
-     * Show back button
-     *
-     * @defaultValue `true`
-     */
-    showBackButton?: boolean;
-    /**
-     * Function to call when the default back button is clicked
-     */
-    onBack?: () => void;
+import { SelectionMode, States } from "../../Enums/Enums";
+import { CometChatOption } from "../../modals";
+interface GroupMembersProps {
     /**
      * Custom view to render on the top-right of the component
      */
-    menus?: JSX.Element;
+    menu?: JSX.Element;
     /**
      * Title of the component
      *
      * @defaultValue `localize("MEMBERS")`
      */
     title?: string;
-    /**
-     * Alignment of the `title` text
-     *
-     * @defaultValue `TitleAlignment.center`
-     */
-    titleAlignment?: TitleAlignment;
     /**
      * Text to be displayed when the search input has no value
      *
      * @defaultValue `localize("SEARCH")`
      */
-    searchPlaceholder?: string;
-    /**
-     * Image URL for the search icon to use in the search bar
-     *
-     * @defaultValue `./assets/search.svg`
-     */
-    searchIconURL?: string;
+    searchPlaceholderText?: string;
     /**
      * Hide the search bar
      *
-     * @defaulValue `false`
+     * @defaultValue `false`
      */
     hideSearch?: boolean;
     /**
@@ -80,24 +51,6 @@ interface IGroupMembersProps {
      * Function to call whenever the component encounters an error
      */
     onError?: ((error: CometChat.CometChatException) => void) | null;
-    /**
-     * Text to display in the default empty view
-     *
-     * @defaultValue `localize("NO_USERS_FOUND")`
-     */
-    emptyStateText?: string;
-    /**
-     * Text to display in the default error view
-     *
-     * @defaultValue `localize("SOMETHING_WRONG")`
-     */
-    errorStateText?: string;
-    /**
-     * Image URL for the default loading view
-     *
-     * @defaultValue `./assets/spinner.svg`
-     */
-    loadingIconURL?: string;
     /**
      * Custom view for the loading state of the component
      */
@@ -110,12 +63,6 @@ interface IGroupMembersProps {
      * Custom view for the error state of the component
      */
     errorStateView?: JSX.Element;
-    /**
-     * @deprecated
-     *
-     * This property is deprecated as of version 4.3.8 due to newer property 'errorStateView'. It will be removed in subsequent versions.
-     */
-    errorSateView?: JSX.Element;
     /**
      * Hide error view
      *
@@ -125,12 +72,6 @@ interface IGroupMembersProps {
      * @defaultValue `false`
      */
     hideError?: boolean;
-    /**
-     * Hide the separator at the bottom of the default list item view
-     *
-     * @defaultValue `true`
-     */
-    hideSeparator?: boolean;
     /**
      * Hide user presence
      *
@@ -155,12 +96,6 @@ interface IGroupMembersProps {
      * List of actions available on mouse over on the default list item component
      */
     options?: (group: CometChat.Group, groupMember: CometChat.GroupMember) => CometChatOption[];
-    /**
-     * Image URL for the change scope component's `arrowIconURL` prop
-     *
-     * @defaultValue `./assets/down-arrow.svg`
-     */
-    dropDownIconURL?: string;
     /**
      * View to be placed in the tail view
      *
@@ -188,36 +123,6 @@ interface IGroupMembersProps {
      * This prop is used if `selectionMode` prop is not `SelectionMode.none`
      */
     onSelect?: (groupMember: CometChat.GroupMember, selected: boolean) => void;
-    /**
-     * Image URL for the close button
-     *
-     * @defaultValue `./assets/close2x.svg`
-     */
-    closeButtonIconURL?: string;
-    /**
-     * Function to call when the close button is clicked
-     */
-    onClose?: () => void;
-    /**
-     * Styles to apply to the avatar component of the default list item view
-     */
-    avatarStyle?: AvatarStyle;
-    /**
-     * Styles to apply to the status indicator component of the default list item view
-     */
-    statusIndicatorStyle?: CSSProperties;
-    /**
-     * Styles to apply to the default list item view
-     */
-    listItemStyle?: ListItemStyle;
-    /**
-     * Styles to apply to the change scope component
-     */
-    groupScopeStyle?: ChangeScopeStyle;
-    /**
-     * Styles to apply to this component
-     */
-    groupMembersStyle?: GroupMembersStyle;
     /**
      * Search keyword to filter the list of users.
      *
@@ -228,15 +133,6 @@ interface IGroupMembersProps {
      * Callback function to be executed when the user list is empty.
      */
     onEmpty?: () => void;
-    /**
-     * Timeout reference for fetching users.
-     */
-    fetchTimeOut?: any;
-    /**
-     * Placement of user presence information within the user interface.
-     * @defaultValue `bottom`
-     */
-    userPresencePlacement?: UserPresencePlacement;
     /**
      * Flag to indicate whether to disable loading state while fetching users.
      * @defaultValue `false`
@@ -248,6 +144,7 @@ export type Action = {
     groupMembers: CometChat.GroupMember[];
     groupMembersManager?: GroupMembersManager | null;
     onEmpty?: () => void;
+    disableLoadingState?: boolean;
 } | {
     type: "setGroupMemberList";
     groupMemberList: CometChat.GroupMember[];
@@ -277,5 +174,5 @@ export type Action = {
     type: "appendGroupMember";
     groupMember: CometChat.GroupMember;
 };
-export declare function CometChatGroupMembers(props: IGroupMembersProps): import("react/jsx-runtime").JSX.Element;
+export declare function CometChatGroupMembers(props: GroupMembersProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/{CometChatGroupMembers → components/CometChatGroupMembers}/controller.d.ts

@@ -1,4 +1,4 @@
-import { Action } from ".";
+import { Action } from "./CometChatGroupMembers";
 import React from "react";
 type Args = {
     searchText: string;

package/dist/types/{CometChatGroupMembers/hooks.d.ts → components/CometChatGroupMembers/useCometChatGroupMembers.d.ts}

@@ -1,5 +1,5 @@
-import React, { JSX } from "react";
-import { Action } from ".";
+import React from "react";
+import { Action } from "./CometChatGroupMembers";
 import { GroupMembersManager } from "./controller";
 type Args = {
     groupMemberRequestBuilder: CometChat.GroupMembersRequestBuilder | null;
@@ -12,11 +12,11 @@ type Args = {
     dispatch: React.Dispatch<Action>;
     loggedInUserRef: React.MutableRefObject<CometChat.User | null>;
     errorHandler: (error: unknown) => void;
-    changeScopeElement: JSX.IntrinsicElements["cometchat-change-scope"] | null;
     updateGroupMemberScope: (newScope: string) => Promise<void>;
     searchKeyword: string;
     disableLoadingState: boolean;
     groupMembersSearchText: React.MutableRefObject<string>;
+    disableUsersPresence?: boolean;
 };
 export declare function Hooks(args: Args): void;
 export {};