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

package/dist/types/resources/CometChatSoundManager/CometChatSoundManager.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Manages and plays various types of audio for CometChat events.
+ * The class provides methods to play sounds for incoming and outgoing messages and calls.
+ * It is used in CometChatCallButtons, CometChatIncomingCall, CometChatConversations, CometChatMessageComposer components.
+ */
+export declare class CometChatSoundManager {
+    static audio: string | null | HTMLAudioElement;
+    static Sound: sounds;
+    /**
+     * Plays the sound for an incoming message.
+     * @param {string|null} customSound - The custom sound URL or null to use the default.
+     *
+     * @example
+     * // Trigger the audio sound for an incoming message
+     * CometChatSoundManager.onIncomingMessage();
+     *
+     * @example
+     * // Trigger the audio sound of your choice for an incoming message
+     * CometChatSoundManager.onIncomingMessage("MP3_FILE_ASSET_PATH");
+     */
+    static onIncomingMessage: (customSound?: string | null) => void;
+    /**
+     * Plays the sound for an incoming message from another user.
+     * @param {string|null} customSound - The custom sound URL or null to use the default.
+     *
+     * @example
+     * // Trigger the audio sound for an incoming message from another user
+     * CometChatSoundManager.onIncomingOtherMessage();
+     *
+     * @example
+     * // Trigger the audio sound of your choice for an incoming message from another user
+     * CometChatSoundManager.onIncomingOtherMessage("MP3_FILE_ASSET_PATH");
+     */
+    static onIncomingOtherMessage: (customSound?: string | null) => void;
+    /**
+     * Plays the sound for an outgoing message.
+     * @param {string|null} customSound - The custom sound URL or null to use the default.
+     *
+     * @example
+     * // Trigger the audio sound for an outgoing message
+     * CometChatSoundManager.onOutgoingMessage();
+     *
+     * @example
+     * // Trigger the audio sound of your choice for an outgoing message
+     * CometChatSoundManager.onOutgoingMessage("MP3_FILE_ASSET_PATH");
+     */
+    static onOutgoingMessage: (customSound?: string | null) => void;
+    /**
+     * Plays the sound for an incoming call.
+     * @param {string|null} customSound - The custom sound URL or null to use the default.
+     *
+     * @example
+     * // Trigger the audio sound for an incoming call
+     * CometChatSoundManager.onIncomingCall();
+     *
+     * @example
+     * // Trigger the audio sound of your choice for an incoming call
+     * CometChatSoundManager.onIncomingCall("MP3_FILE_ASSET_PATH");
+     */
+    static onIncomingCall: (customSound?: string | null) => void;
+    /**
+     * Plays the sound for an outgoing call.
+     * @param {string|null} customSound - The custom sound URL or null to use the default.
+     *
+     * @example
+     * // Trigger the audio sound for an outgoing call
+     * CometChatSoundManager.onOutgoingCall();
+     *
+     * @example
+     * // Trigger the audio sound of your choice for an outgoing call
+     * CometChatSoundManager.onOutgoingCall("MP3_FILE_ASSET_PATH");
+     */
+    static onOutgoingCall: (customSound?: string | null) => void;
+    /**
+     * Contains mappings of sound types to their respective handler functions.
+     *
+     * The handlers are functions that trigger the playback of sounds for different events.
+     *
+     * @type {Object}
+     * @property {Function} incomingCall - Handler function for playing the incoming call sound.
+     * @property {Function} outgoingCall - Handler function for playing the outgoing call sound.
+     * @property {Function} incomingMessage - Handler function for playing the incoming message sound.
+     * @property {Function} incomingMessageFromOther - Handler function for playing the incoming message from other sound.
+     * @property {Function} outgoingMessage - Handler function for playing the outgoing message sound.
+     */
+    static handlers: {
+        incomingCall: (customSound?: string | null) => void;
+        outgoingCall: (customSound?: string | null) => void;
+        incomingMessage: (customSound?: string | null) => void;
+        incomingMessageFromOther: (customSound?: string | null) => void;
+        outgoingMessage: (customSound?: string | null) => void;
+    };
+    /**
+    * Plays a predefined sound based on the provided sound type.
+    * @param {"incomingCall" | "incomingMessage" | "incomingMessageFromOther" | "outgoingCall" | "outgoingMessage"} sound - The sound type to play.
+    * @param {string|null} customSound - The custom sound URL or null to use the default.
+    * @returns {boolean} - Returns false if the sound handler is not found.
+    *
+    * @example
+    * // Play the sound for incoming messages
+    * CometChatSoundManager.play("incomingMessage");
+    *
+    * @example
+    * // Play a custom sound for outgoing messages
+    * CometChatSoundManager.play("outgoingMessage", "MP3_FILE_ASSET_PATH");
+    */
+    static play(sound: "incomingCall" | "incomingMessage" | "incomingMessageFromOther" | "outgoingCall" | "outgoingMessage", customSound?: string | null): false | void;
+    /**
+     * Pauses the currently playing sound and resets its position.
+     *
+     * @example
+     * // Pause the ongoing audio sound
+     * CometChatSoundManager.pause();
+     */
+    static pause(): void;
+    /**
+     * Checks if the user has interacted with the page.
+     * @returns {boolean} True if the user has interacted, false otherwise.
+     */
+    static hasInteracted(): boolean;
+}
+export interface sounds {
+    incomingCall?: "incomingCall";
+    incomingMessage?: "incomingMessage";
+    incomingMessageFromOther: "incomingMessageFromOther";
+    outgoingCall?: "outgoingCall";
+    outgoingMessage?: "outgoingMessage";
+}

package/dist/types/resources/index.d.ts

@@ -0,0 +1 @@
+export * from './';

package/dist/types/src/CometChatCustomHooks.d.ts

@@ -0,0 +1,27 @@
+import React from "react";
+/**
+ * Sets the created ref to the `value` passed
+ *
+ * @remarks
+ * After the initial call of this hook, the internal ref is set to the `value` passed to this hook after the component has rendered completely.
+ * So the returned ref will not have the updated value while the component renders
+ */
+export declare function useRefSync<T>(value: T): React.MutableRefObject<T>;
+/**
+ * Custom hook to make refs stateful
+ *
+ * @remarks
+ * Making refs stateful opens up the possibility of using the element the ref is pointing to as a dependency for a `useEffect` call
+ *
+ * @example
+ * Here's a simple example
+ * ```ts
+ *  // At the top most level of the functional component
+ *  const [inputElement, setInputRef] = useStateRef<HTMLInputElement | null>(null);
+ *
+ *  // Inside the JSX
+ *  <input type = "text" ref = {setInputRef} />
+ * ```
+ */
+export declare function useStateRef<T>(initialValue: T): [T, (node: T) => void];
+export declare function useCometChatErrorHandler(onError?: ((error: CometChat.CometChatException) => void) | null): (error: unknown) => void;

package/dist/types/src/CometChatUIKit/CometChatCalls.d.ts

@@ -0,0 +1 @@
+export declare var CometChatUIKitCalls: any;

package/dist/types/src/CometChatUIKit/CometChatUIKit.d.ts

@@ -0,0 +1,147 @@
+import { AIExtensionDataSource } from "../components/AI/AIExtensionDataSource";
+import { CallingExtension } from "../components/Calling/CallingExtension";
+import { ExtensionsDataSource } from "../components/Extensions/ExtensionsDataSource";
+import { CometChatLocalize } from "../resources/CometChatLocalize/cometchat-localize";
+import { UIKitSettings } from "./UIKitSettings";
+import { CometChatSoundManager } from "../resources/CometChatSoundManager/CometChatSoundManager";
+import { DataSource } from "../utils/DataSource";
+interface CometChatUiKit {
+    name: string;
+    version: string;
+}
+declare global {
+    interface Window {
+        CometChatUiKit: CometChatUiKit;
+    }
+}
+/**
+ * `CometChatUIKit` is a class that provides an interface for initializing and interacting with the CometChat UI Kit.
+ * It handles various aspects of the UI Kit, including configuration, messaging, and extension management.
+ * It is used in Calling, Conversations, Groups and Users components.
+ * @class
+ */
+declare class CometChatUIKit {
+    /**
+     * `CometChatUIKit` is a class that provides an interface for initializing and interacting with the CometChat UI Kit.
+     * It handles various aspects of the UI Kit, including configuration, messaging, and extension management.
+     *
+     * @class
+     */
+    static uiKitSettings: UIKitSettings | null;
+    /**
+     * The sound manager for handling sound-related functionalities in the UI Kit.
+     * @type {typeof CometChatSoundManager}
+     */
+    static SoundManager: typeof CometChatSoundManager;
+    /**
+    * The localizer for internationalization.
+    * @type {typeof CometChatLocalize}
+    */
+    static Localize: typeof CometChatLocalize;
+    /**
+    * Settings related to conversation updates.
+    * @type {CometChat.ConversationUpdateSettings}
+    */
+    static conversationUpdateSettings: CometChat.ConversationUpdateSettings;
+    /**
+    * Variable for storing theme mode of the UIKit.
+    */
+    static themeMode: "light" | "dark";
+    /**
+     * Initializes the CometChat UI Kit with the provided settings.
+     * @param {UIKitSettings | null} uiKitSettings - The settings for initializing the UI Kit.
+     * @returns {Promise<Object> | undefined} - A promise that resolves with an object if initialization is successful, otherwise `undefined`.
+     */
+    static init(uiKitSettings: UIKitSettings | null): Promise<Object> | undefined;
+    /**
+    * Default extensions included in the UI Kit.
+    * @type {ExtensionsDataSource[]}
+    */
+    static defaultExtensions: ExtensionsDataSource[];
+    /**
+* Default callingExtension included in the UI Kit.
+* @type {CallingExtension}
+*/
+    static defaultCallingExtension: CallingExtension;
+    /**
+    * Default AI features included in the UI Kit.
+    * @type {AIExtensionDataSource[]}
+    */
+    static defaultAIFeatures: AIExtensionDataSource[];
+    /**
+     * Checking if the SDK is initialized.
+     */
+    static isInitialized(): boolean | undefined;
+    /**
+     * Enables calling functionality in the UI Kit.
+     */
+    static enableCalling(): void;
+    /**
+     * Performs post-login initialization tasks.
+     * @private
+     */
+    private static initiateAfterLogin;
+    /**
+     * Logs in a user with the specified UID.
+     * @param {string} uid - The UID of the user to log in.
+     * @returns {Promise<CometChat.User>} - A promise that resolves with the logged-in user.
+     */
+    static login(uid: string): Promise<CometChat.User>;
+    /**
+    * Logs in a user with the specified authentication token.
+    * @param {string} authToken - The authentication token for the user.
+    * @returns {Promise<CometChat.User>} - A promise that resolves with the logged-in user.
+    */
+    static loginWithAuthToken(authToken: string): Promise<CometChat.User>;
+    /**
+    * Retrieves the currently logged-in user.
+    * @returns {Promise<CometChat.User | null>} - A promise that resolves with the logged-in user or `null` if no user is logged in.
+    */
+    static getLoggedinUser(): Promise<CometChat.User | null>;
+    /**
+    * Creates a new user with the specified details.
+    * @param {CometChat.User} user - The user details to create.
+    * @returns {Promise<CometChat.User>} - A promise that resolves with the created user.
+    */
+    static createUser(user: CometChat.User): Promise<CometChat.User>;
+    /**
+    * Updates the details of an existing user.
+    * @param {CometChat.User} user - The user details to update.
+    * @returns {Promise<CometChat.User>} - A promise that resolves with the updated user.
+    */
+    static updateUser(user: CometChat.User): Promise<CometChat.User>;
+    /**
+     * Logs out the current user.
+     * @returns {Promise<Object>} - A promise that resolves with a message object upon successful logout.
+     */
+    static logout(): Promise<Object>;
+    /**
+     * Checks if the UI Kit settings are properly configured.
+     * @returns {boolean} - `true` if UI Kit settings are available and valid, otherwise `false`.
+     */
+    static checkAuthSettings(): boolean;
+    /**
+    * Sends a custom message and returns a promise with the result.
+    * @param {CometChat.CustomMessage} message - The custom message to be sent.
+    * @returns {Promise<CometChat.BaseMessage>} - A promise that resolves with the sent message.
+    */
+    static sendCustomMessage(message: CometChat.CustomMessage): Promise<unknown>;
+    /**
+    * Sends a text message and returns a promise with the result.
+    * @param {CometChat.TextMessage} message - The text message to be sent.
+    * @returns {Promise<CometChat.BaseMessage>} - A promise that resolves with the sent message.
+    */
+    static sendTextMessage(message: CometChat.TextMessage): Promise<CometChat.BaseMessage>;
+    /**
+     * Sends a media message and returns a promise with the result.
+     * @param {CometChat.MediaMessage} message - The media message to be sent.
+     * @returns {Promise<CometChat.BaseMessage>} - A promise that resolves with the sent message.
+     */
+    static sendMediaMessage(message: CometChat.MediaMessage): Promise<CometChat.BaseMessage>;
+    /**
+     * Retrieves the data source for chat configuration.
+     * @returns {DataSource} - The chat data source.
+     */
+    static getDataSource(): DataSource;
+}
+export { CometChatUIKit };

package/dist/types/src/CometChatUIKit/CometChatUIKitLoginListener.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Manages the login state and listener attachment for CometChat users.
+ * It is used in CometChatMessageComposer, CometChatMessageList, CometChatMessageInformation components.
+ */
+export declare class CometChatUIKitLoginListener {
+    private static loggedInUser;
+    private static listenerID;
+    private static isAttached;
+    /**
+     * Sets the currently logged-in user.
+     * @param user - The logged-in CometChat user.
+     */
+    static setLoggedInUser(user: CometChat.User): void;
+    /**
+     * Retrieves the currently logged-in user.
+     * @returns The logged-in CometChat user or null.
+     */
+    static getLoggedInUser(): import("@cometchat/chat-sdk-javascript").User | null;
+    /**
+     * Removes the logged-in user.
+     */
+    static removeLoggedInUser(): void;
+    /**
+     * Attaches the login listener for CometChat.
+     * If a listener is already attached, it is removed before attaching a new one.
+     */
+    static attachListener(): void;
+    /**
+     * Removes the attached login listener.
+     */
+    static removeListener(): void;
+}

package/dist/types/src/CometChatUIKit/CometChatUIKitUtility.d.ts

@@ -0,0 +1,81 @@
+import { BaseMessage, CometChat } from "@cometchat/chat-sdk-javascript";
+interface MessageExtensionType {
+    hasXSS?: string;
+    sanitized_text?: string;
+    data?: {
+        sensitive_data: string;
+        message_masked: string;
+    };
+    profanity?: string;
+    message_clean?: string;
+}
+/**
+  * Utility class for CometChat UIKit, providing various helper methods
+  * such as deep cloning, ID generation, Unix timestamp retrieval,
+  * and message extension data handling.
+  */
+export declare class CometChatUIKitUtility {
+    /**
+     * Creates a deep copy of the value provided
+     *
+     * @remarks
+     * This function cannot copy truly private properties (those that start with a "#" symbol inside a class block).
+     * Functions are copied by reference and additional properties on the array objects are ignored
+     *
+     * @param arg - Any value
+     * @returns A deep copy of `arg`
+     */
+    static clone<T>(arg: T): T;
+    /**
+     * Checks if an object has a specific property.
+     *
+     * @param obj - The object to check.
+     * @param key - The property key.
+     * @returns `true` if the property exists, `false` otherwise.
+     */
+    static checkHasOwnProperty: (obj: object | undefined, key: string) => boolean;
+    /**
+     * Generates a unique ID.
+     *
+     * @returns A unique string identifier.
+     */
+    static ID: () => string;
+    /**
+     * Retrieves the current Unix timestamp.
+     *
+     * @returns The Unix timestamp.
+     */
+    static getUnixTimestamp: () => number;
+    /**
+     * Retrieves the extension data from a message.
+     *
+     * @param messageObject - The message object containing extensions.
+     * @returns The sanitized message text if available, otherwise the original text.
+     */
+    static getExtensionData(messageObject: CometChat.BaseMessage): string;
+    /**
+     * Checks for extension data in a message.
+     *
+     * @param message - The message object to check.
+     * @param extensionKey - The extension key to look for.
+     * @returns The extension data if found.
+     */
+    static checkMessageForExtensionsData: (message: CometChat.BaseMessage | null, extensionKey: string) => (object & MessageExtensionType) | undefined;
+    /**
+     * Sanitizes an HTML string by escaping tags not matching the whitelist.
+     *
+     * @param htmlString - The HTML string to sanitize.
+     * @param whitelistRegExes - A list of regular expressions to match allowed tags.
+     * @returns The sanitized HTML string.
+     */
+    static sanitizeHtml(htmlString: string, whitelistRegExes: RegExp[]): string;
+    static convertBlobToWav: (audioBlob: {
+        arrayBuffer: () => any;
+    }) => Promise<{
+        wavBlob: Blob;
+    }>;
+    static audioBufferToWav: (audioBuffer: AudioBuffer) => ArrayBuffer;
+    static writeString: (view: DataView, offset: number, string: string) => void;
+    static convertToWav: (audioBlob: Blob) => Promise<string>;
+}
+export {};