@cometchat/chat-uikit-react 4.3.22 → 5.0.0-beta1

package/dist/types/src/components/Calling/CometChatCallLogs/CometChatCallLogs.d.ts

@@ -0,0 +1,71 @@
+/// <reference types="react" />
+import { DatePatterns } from "../../../Enums/Enums";
+interface CallLogsProps {
+    /**
+     * Title of the component
+     *
+     * @defaultValue `localize("CALLS")`
+     */
+    title?: string;
+    /**
+     * Custom list item view to be rendered for each user in the fetched list
+     */
+    listItemView?: (call: any) => JSX.Element;
+    /**
+     * Custom subtitle view to be rendered for each user in the fetched list
+     *
+     * @remarks
+     * This prop is used if `listItemView` prop is not provided
+     */
+    subtitleView?: (call: any) => JSX.Element;
+    /**
+     * View to be placed in the tail view
+     *
+     * @remarks
+     * This prop will be used if `listItemView` is not provided
+     */
+    tailView?: (call: any) => JSX.Element;
+    /**
+     * Custom view for the empty state of the component
+     */
+    emptyStateView?: JSX.Element;
+    /**
+     * Custom view for the error state of the component
+     */
+    errorStateView?: JSX.Element;
+    /**
+     * Custom view for the loading state of the component
+     */
+    loadingStateView?: JSX.Element;
+    /**
+     * Object representing the active call that is currently selected.
+     *
+     */
+    activeCall?: any;
+    /**
+     * Allows filtering and customizing call logs using available parameters
+     *  @defaultValue Default request builder having the limit set to 30
+     */
+    callLogRequestBuilder?: any;
+    /**
+     * Function to call on click of the default list item view of a user
+     */
+    onItemClick?: Function;
+    /**
+     * Function to call on click of the tail view of a user
+     */
+    onCallButtonClicked?: Function;
+    /**
+     * Function to call whenever the component encounters an error
+     */
+    onError?: Function;
+    /**
+     * Date format for 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`
+     */
+    datePattern?: DatePatterns;
+}
+declare const CometChatCallLogs: (props: CallLogsProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatCallLogs };

package/dist/types/src/components/Calling/CometChatCallLogs/useCometChatCallLogs.d.ts

@@ -0,0 +1,2 @@
+declare function useCometChatCallLogs(loggedInUser: CometChat.User | null, setLoggedInUser: Function, requestBuilder: any, setCallBuilder: Function, getCallList: Function, attachListeners: Function, subscribeToEvents: Function, detachListeners: Function, onErrorCallback: Function): void;
+export { useCometChatCallLogs };

package/dist/types/src/components/Calling/CometChatIncomingCall/CometChatIncomingCall.d.ts

@@ -0,0 +1,59 @@
+/// <reference types="react" />
+import { CometChatUIKitCalls } from "../../../CometChatUIKit/CometChatCalls";
+interface IncomingCallProps {
+    /**
+     * CometChat call object consumed by the component to launch itself.
+     */
+    call?: any;
+    /**
+     * Used to disable/enable the sound of incoming calls.
+     *
+     * @default false
+     */
+    disableSoundForCalls?: boolean;
+    /**
+     * Used to set a custom sound for incoming calls.
+     *
+     * @example customSoundForCalls='Your Custom Sound For Calls'
+     */
+    customSoundForCalls?: string;
+    /**
+     * Triggered when you click the accept button of the Incoming Call component.
+     * You can override this action.
+     */
+    onAccept?: Function;
+    /**
+     * Triggered when you click the decline button of the Incoming Call component.
+     * You can override this action.
+     */
+    onDecline?: Function;
+    /**
+     * Used to set custom accept button text.
+     *
+     * @example acceptButtonText='Your Custom Accept Button Text'
+     */
+    acceptButtonText?: string;
+    /**
+     * Used to set custom decline button text.
+     *
+     * @example declineButtonText='Your Decline Button Text'
+     */
+    declineButtonText?: string;
+    /**
+     * Custom subtitle view for the incoming call component.
+     */
+    subtitleView?: (call: CometChat.Call) => JSX.Element;
+    /**
+     * Triggered when an error occurs in the Incoming Call component.
+     */
+    onError?: Function;
+    /**
+     * Builder function for configuring and updating call settings.
+     *
+     * @param call - The current CometChat call object.
+     * @returns An instance of CallSettingsBuilder.
+     */
+    callSettingsBuilder?: (call: CometChat.Call) => typeof CometChatUIKitCalls.CallSettingsBuilder;
+}
+declare const CometChatIncomingCall: (props: IncomingCallProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatIncomingCall };

package/dist/types/src/components/Calling/CometChatIncomingCall/useCometChatIncomingCall.d.ts

@@ -0,0 +1,2 @@
+declare function useCometChatIncomingCall(loggedInUser: any, setLoggedInUser: any, call: CometChat.Call, attachListeners: Function, removeListener: Function, acceptCallButtonRef: any, rejectCallButtonRef: any, showCall: any, callRef: any, acceptIncomingCall: Function, rejectIncomingCall: Function, showIncomingCallScreen: boolean, subscribeToEvents: Function): void;
+export { useCometChatIncomingCall };

package/dist/types/src/components/Calling/CometChatOngoingCall/CometChatOngoingCall.d.ts

@@ -0,0 +1,10 @@
+import { CometChatUIKitCalls } from "../../../CometChatUIKit/CometChatCalls";
+import { CallWorkflow } from "../../../Enums/Enums";
+interface OngoingCallProps {
+    callSettingsBuilder?: typeof CometChatUIKitCalls.CallSettings;
+    sessionID: string;
+    onError?: Function;
+    callWorkflow?: CallWorkflow;
+}
+declare const CometChatOngoingCall: (props: OngoingCallProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatOngoingCall };

package/dist/types/src/components/Calling/CometChatOngoingCall/useCometChatOngoingCall.d.ts

@@ -0,0 +1,2 @@
+declare function useCometChatOngoingCall(setLoggedInUser: any, sessionID: string, startCall: any): void;
+export { useCometChatOngoingCall };

package/dist/types/src/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/src/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/src/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/src/components/Calling/Utils/utils.d.ts

@@ -0,0 +1,7 @@
+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;
+export declare function convertMinutesToHoursMinutesSeconds(minutes: number): string;
+export declare function convertSecondsToHoursMinutesSeconds(seconds: number): string;
+export declare function downloadRecordingFromURL(url: string): void;

package/dist/types/src/components/CometChatConversations/CometChatConversations.d.ts

@@ -0,0 +1,219 @@
+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
+     */
+    menu?: JSX.Element;
+    /**
+     * Title of the component
+     *
+     * @defaultValue `localize("CHATS")`
+     */
+    title?: string;
+    /**
+     * Request builder to fetch conversations
+     * @defaultValue Default request builder having the limit set to 30
+     */
+    conversationsRequestBuilder?: CometChat.ConversationsRequestBuilder;
+    /**
+     * Function to call whenever the component encounters an error
+     */
+    onError?: (error: CometChat.CometChatException) => void;
+    /**
+     * Custom list item view to be rendered for each conversation in the fetched list
+     */
+    listItemView?: (conversation: CometChat.Conversation) => JSX.Element;
+    /**
+     * Custom subtitle view to be rendered for each conversation in the fetched list
+     *
+     * @remarks
+     * 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
+     *
+     * @remarks
+     * If set to true, the status indicator of the default list item view is not displayed for conversation objects related to users
+     *
+     * @defaultValue `false`
+     */
+    disableUsersPresence?: boolean;
+    /**
+     * Conversation to highlight
+     *
+     * @remarks
+     * This prop is used if `listItemView` prop is not provided
+     */
+    activeConversation?: CometChat.Conversation;
+    /**
+     * Selection mode to use for the default tail view
+     *
+     * @remarks
+     * This prop is used if `listItemView` prop is not provided.
+     *
+     * @defaultValue `SelectionMode.none`
+     */
+    selectionMode?: SelectionMode;
+    /**
+     * Disable receipt status
+     *
+     * @remarks
+     * If set to true, the receipt status of the sent message won't be displayed, and received messages won't be marked as delivered
+     *
+     * @defaultValue `false`
+     */
+    hideReceipt?: boolean;
+    /**
+     * List of actions available on mouse over on the default list item component
+     */
+    options?: ((conversation: CometChat.Conversation) => CometChatOption[]) | null;
+    /**
+     * Date format for 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`
+     */
+    datePattern?: DatePatterns;
+    /**
+     * Custom view for the loading state of the component
+     */
+    loadingStateView?: JSX.Element;
+    /**
+     * Custom view for the empty state of the component
+     */
+    emptyStateView?: JSX.Element;
+    /**
+     * Custom view for the error state of the component
+     */
+    errorStateView?: JSX.Element;
+    /**
+     * Hide error view
+     *
+     * @remarks
+     * If set to true, hides the default and the custom error view
+     *
+     * @defaultValue `false`
+     */
+    hideError?: boolean;
+    /**
+     * Function to call on click of the default list item view of a conversation
+     */
+    onItemClick?: (conversation: CometChat.Conversation) => void;
+    /**
+     * Function to call when a conversation from the fetched list is selected
+     *
+     * @remarks
+     * This prop is used if `selectionMode` prop is not `SelectionMode.none`
+     */
+    onSelect?: (conversation: CometChat.Conversation, selected: boolean) => void;
+    /**
+     * Disable typing indicator display
+     *
+     * @defaultValue `false`
+     */
+    disableTyping?: boolean;
+    /**
+     * Title of the confirmation dialog.
+     *
+     */
+    confirmDialogTitle?: string;
+    /**
+     * Message displayed in the confirmation dialog.
+     *
+     */
+    confirmDialogMessage?: string;
+    /**
+    * Text for the cancel button in the confirmation dialog.
+    */
+    cancelButtonText?: string;
+    /**
+     * Text for the confirm button in the confirmation dialog.
+     */
+    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 = {
+    type: "appendConversations";
+    conversations: CometChat.Conversation[];
+    removeOldConversation?: boolean;
+} | {
+    type: "setConversationList";
+    conversationList: CometChat.Conversation[];
+} | {
+    type: "setFetchState";
+    fetchState: States;
+} | {
+    type: "setConversationToBeDeleted";
+    conversation: CometChat.Conversation | null;
+} | {
+    type: "removeConversation";
+    conversation: CometChat.Conversation;
+} | {
+    type: "updateConversationWithUser";
+    user: CometChat.User;
+} | {
+    type: "fromUpdateConversationListFn";
+    conversation: CometChat.Conversation;
+} | {
+    type: "addTypingIndicator";
+    typingIndicator: CometChat.TypingIndicator;
+} | {
+    type: "removeTypingIndicator";
+    typingIndicator: CometChat.TypingIndicator;
+} | {
+    type: "updateConversationLastMessage";
+    message: CometChat.BaseMessage;
+} | {
+    type: "updateConversationLastMessageAndPlaceAtTheTop";
+    message: CometChat.BaseMessage;
+} | {
+    type: "updateConversationLastMessageAndGroupAndPlaceAtTheTop";
+    group: CometChat.Group;
+    message: CometChat.Action;
+} | {
+    type: "removeConversationOfTheGroup";
+    group: CometChat.Group;
+} | {
+    type: "removeConversationOfTheUser";
+    user: CometChat.User;
+} | {
+    type: "updateConversationLastMessageResetUnreadCountAndPlaceAtTheTop";
+    message: CometChat.BaseMessage;
+    conversation: CometChat.Conversation;
+} | {
+    type: "resetUnreadCountAndSetReadAtIfLastMessage";
+    message: CometChat.BaseMessage;
+} | {
+    type: "setLastMessageReadOrDeliveredAt";
+    updateReadAt: boolean;
+    messageReceipt: CometChat.MessageReceipt;
+} | {
+    type: "setLoggedInUser";
+    loggedInUser: CometChat.User | null;
+} | {
+    type: "setIsFirstReload";
+    isFirstReload: boolean;
+};
+/**
+ * Renders a scrollable list of conversations that has been created in a CometChat app
+ */
+export declare function CometChatConversations(props: ConversationsProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/src/components/CometChatConversations/controller.d.ts

@@ -0,0 +1,74 @@
+import { CometChat } from '@cometchat/chat-sdk-javascript';
+type Args = {
+    conversationsRequestBuilder: CometChat.ConversationsRequestBuilder | null;
+};
+export declare class ConversationsManager {
+    private static limit;
+    private conversationsRequest;
+    private static conversationType;
+    /**
+     * Set `conversationsRequest` of the instance
+     */
+    constructor(args: Args);
+    /**
+     * Calls `fetchNext` method of the set `conversationsRequest`
+     */
+    fetchNext(): Promise<[] | import("@cometchat/chat-sdk-javascript").Conversation[]>;
+    /**
+     * Attaches an SDK user listener
+     *
+     * @returns Function to call to remove the attached SDK user listener
+     */
+    static attachUserListener(callback: (user: CometChat.User) => void): () => void;
+    /**
+     * Attaches an SDK group listener
+     *
+     * @returns Function to call to remove the attached SDK group listener
+     */
+    static attachGroupListener(callback: (message: CometChat.BaseMessage, remove?: boolean) => Promise<void>, loggedInUser: CometChat.User | null): () => void;
+    /**
+     * Attaches an SDK message received listener
+     *
+     * @returns - Function to remove the added SDK message received listener
+     */
+    static attachMessageReceivedListener(callback: (message: CometChat.BaseMessage) => Promise<void>): () => void;
+    /**
+     * Attaches an SDK message receipt listener
+     *
+     * @returns - Function to remove the added SDK message receipt listener
+     */
+    static attachMessageReceiptListener(callback: (receipt: CometChat.MessageReceipt, updateReadAt: boolean) => void): () => void;
+    /**
+     * Attaches an SDK message typing listener
+     *
+     * @returns - Function to remove the added SDK message typing listener
+     */
+    static attachMessageTypingListener(callback: (typingIndicator: CometChat.TypingIndicator, typingStarted: boolean) => void): () => void;
+    /**
+     * Attaches an SDK message modified listener
+     *
+     * @returns - Function to remove the added SDK message modified listener
+     */
+    static attachMessageModifiedListener(callback: (message: CometChat.BaseMessage) => void): () => void;
+    /**
+     * Attaches an SDK call listener
+     *
+     * @returns - Function to remove the added SDK call listener
+     */
+    static attachCallListener(callback: (message: CometChat.BaseMessage) => void): () => void;
+    /**
+  * Attaches an SDK websocket  listener
+  *
+  * @returns - Function to remove the added SDK websocket listener
+  */
+    static attachConnestionListener(callback: () => void): () => void;
+    /**
+     * Determines if the last message should trigger an update based on its category and type.
+     *
+     * @param message - The last message sent or received in the conversation.
+     * @returns {boolean} - Returns true if the message should trigger an update, false otherwise.
+     */
+    static shouldLastMessageAndUnreadCountBeUpdated: (message: CometChat.BaseMessage) => any;
+    static shouldIncrementForCustomMessage(message: CometChat.CustomMessage): any;
+}
+export {};

package/dist/types/src/components/CometChatConversations/useCometChatConversations.d.ts

@@ -0,0 +1,25 @@
+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;
+    conversationsManagerRef: React.MutableRefObject<ConversationsManager | null>;
+    fetchNextAndAppendConversations: (fetchId: string) => Promise<void>;
+    fetchNextIdRef: React.MutableRefObject<string>;
+    dispatch: React.Dispatch<Action>;
+    conversationToBeDeleted: CometChat.Conversation | null;
+    errorHandler: (error: unknown) => void;
+    refreshSingleConversation: (message: CometChat.BaseMessage, remove?: boolean) => Promise<void>;
+    onMessageReceived: (message: CometChat.BaseMessage) => Promise<void>;
+    setReceipts: (messageReceipt: CometChat.MessageReceipt, updateReadAt: boolean) => void;
+    setTypingIndicator: (typingIndicator: CometChat.TypingIndicator, typingStarted: boolean) => void;
+    disableTyping: boolean;
+    loggedInUser: CometChat.User | null;
+    isFirstReload: boolean;
+    disableUsersPresence?: boolean;
+    activeConversation: Conversation | null;
+    setActiveConversationState: React.Dispatch<React.SetStateAction<Conversation | null>>;
+};
+export declare function useCometChatConversations(args: Args): void;
+export {};