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

package/dist/types/modals/InteractiveMessage/SchedulerMessage.d.ts

@@ -1,230 +0,0 @@
-import { ButtonElement } from '../InteractiveElements/index';
-import { CometChat } from '@cometchat/chat-sdk-javascript';
-export interface Availability {
-    [key: string]: TimeRange[];
-}
-export interface TimeRange {
-    from: string;
-    to: string;
-}
-export interface InteractiveData {
-    /**
-     * The title of the scheduler message.
-     */
-    title: string;
-    /**
-     * The URL of the avatar image.
-     */
-    avatarUrl?: string;
-    /**
-     * The text displayed upon goal completion.
-     */
-    goalCompletionText?: string;
-    /**
-     * The timezone code for the schedule.
-     */
-    timezoneCode?: string;
-    /**
-     * The buffer time in minutes before or after scheduled events.
-     */
-    bufferTime?: number;
-    /**
-     * The duration of scheduled events in minutes.
-     */
-    duration?: number;
-    /**
-     * The availability information for scheduling.
-     */
-    availability: Availability;
-    /**
-     * The start date of the scheduling date range in ISO 8601 format.
-     */
-    dateRangeStart?: string;
-    /**
-     * The end date of the scheduling date range in ISO 8601 format.
-     */
-    dateRangeEnd?: string;
-    /**
-     * The URL to an ICS file for calendar integration.
-     */
-    icsFileUrl?: string;
-    /**
-     * The button element used to schedule events.
-     */
-    scheduleElement?: ButtonElement;
-}
-/**
- * Represents a scheduler message that extends CometChat's InteractiveMessage.
- */
-export declare class SchedulerMessage extends CometChat.InteractiveMessage {
-    private title;
-    private avatarUrl;
-    private goalCompletionText;
-    private timezoneCode;
-    private bufferTime;
-    private duration;
-    private availability;
-    private dateRangeStart;
-    private dateRangeEnd;
-    private icsFileUrl;
-    private scheduleElement;
-    /**
-     * Constructs a SchedulerMessage instance.
-     *
-     * @param {string} receiverId - The ID of the receiver.
-     * @param {string} receiverType - The type of the receiver.
-     * @param {InteractiveData} interactiveData - The interactive data for the message.
-     */
-    constructor(receiverId: string, receiverType: string, interactiveData: InteractiveData);
-    /**
-     * Sets the interactive data for the scheduler message.
-     *
-     * @param {InteractiveData} interactiveData - The interactive data to set.
-     */
-    setInteractiveData(interactiveData: InteractiveData): void;
-    /**
-     * Sets the title of the scheduler message.
-     *
-     * @param {string} title - The title to set.
-     */
-    setTitle(title: string): void;
-    /**
-     * Sets the avatar URL of the scheduler message.
-     *
-     * @param {string} avatarUrl - The avatar URL to set.
-     */
-    setAvatarUrl(avatarUrl: string): void;
-    /**
-     * Sets the goal completion text for the scheduler message.
-     *
-     * @param {string} goalCompletionText - The goal completion text to set.
-     */
-    setGoalCompletionText(goalCompletionText: string): void;
-    /**
-     * Sets the timezone code for the scheduler message.
-     *
-     * @param {string} timezoneCode - The timezone code to set.
-     */
-    setTimezoneCode(timezoneCode: string): void;
-    /**
-     * Sets the duration for the scheduler message.
-     *
-     * @param {number} duration - The duration to set.
-     */
-    setDuration(duration: number): void;
-    /**
-     * Sets the buffer time for the scheduler message.
-     *
-     * @param {number} bufferTime - The buffer time to set.
-     */
-    setBufferTime(bufferTime: number): void;
-    /**
-     * Sets the availability for the scheduler message.
-     *
-     * @param {Availability} availability - The availability to set.
-     */
-    setAvailability(availability: Availability): void;
-    /**
-     * Sets the start date range for the scheduler message.
-     *
-     * @param {string} dateRangeStart - The start date range to set.
-     */
-    setDateRangeStart(dateRangeStart: string): void;
-    /**
-     * Sets the end date range for the scheduler message.
-     *
-     * @param {string} dateRangeEnd - The end date range to set.
-     */
-    setDateRangeEnd(dateRangeEnd: string): void;
-    /**
-     * Sets the ICS file URL for the scheduler message.
-     *
-     * @param {string} icsFileUrl - The ICS file URL to set.
-     */
-    setIcsFileUrl(icsFileUrl: string): void;
-    /**
-     * Sets the schedule button element for the scheduler message.
-     *
-     * @param {ButtonElement} scheduleElement - The button element to set.
-     */
-    setScheduleElement(scheduleElement: ButtonElement): void;
-    /**
-     * Retrieves the interactive data of the scheduler message.
-     *
-     * @returns {InteractiveData} The interactive data of the message.
-     */
-    getInteractiveData(): Object;
-    /**
-     * Retrieves the title of the scheduler message.
-     *
-     * @returns {string} The title of the message.
-     */
-    getTitle(): string;
-    /**
-     * Retrieves the avatar URL of the scheduler message.
-     *
-     * @returns {string} The avatar URL of the message.
-     */
-    getAvatarUrl(): string;
-    /**
-     * Retrieves the goal completion text of the scheduler message.
-     *
-     * @returns {string} The goal completion text of the message.
-     */
-    getGoalCompletionText(): string;
-    /**
-     * Retrieves the timezone code of the scheduler message.
-     *
-     * @returns {string} The timezone code of the message.
-     */
-    getTimezoneCode(): string;
-    /**
-     * Retrieves the duration of the scheduler message.
-     *
-     * @returns {number} The duration of the message.
-     */
-    getDuration(): number;
-    /**
-     * Retrieves the buffer time of the scheduler message.
-     *
-     * @returns {number} The buffer time of the message.
-     */
-    getBufferTime(): number;
-    /**
-     * Retrieves the availability of the scheduler message.
-     *
-     * @returns {Availability} The availability of the message.
-     */
-    getAvailability(): Availability;
-    /**
-     * Retrieves the start date range of the scheduler message.
-     *
-     * @returns {string} The start date range of the message.
-     */
-    getDateRangeStart(): string;
-    /**
-     * Retrieves the end date range of the scheduler message.
-     *
-     * @returns {string} The end date range of the message.
-     */
-    getDateRangeEnd(): string;
-    /**
-     * Retrieves the ICS file URL of the scheduler message.
-     *
-     * @returns {string} The ICS file URL of the message.
-     */
-    getIcsFileUrl(): string;
-    /**
-     * Retrieves the schedule button element of the scheduler message.
-     *
-     * @returns {ButtonElement} The schedule button element of the message.
-     */
-    getScheduleElement(): ButtonElement;
-    /**
-    * Creates a `SchedulerMessage` instance from a JSON object.
-    *
-    * @param {fromJsonType} json - The JSON object containing scheduler message properties.
-    * @returns {SchedulerMessage} The constructed `SchedulerMessage` instance.
-    */
-    static fromJSON(json: CometChat.InteractiveMessage): SchedulerMessage;
-}

package/dist/types/modals/InteractiveMessage/index.d.ts

@@ -1,5 +0,0 @@
-export { FormMessage } from "./FormMessage";
-export { CardMessage } from "./CardMessage";
-export { CustomInteractiveMessage } from "./CustomInteractiveMessage";
-export { SchedulerMessage } from './SchedulerMessage';
-export type { TimeRange, Availability } from './SchedulerMessage';

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

@@ -1,27 +0,0 @@
-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

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

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

@@ -1,147 +0,0 @@
-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

@@ -1,32 +0,0 @@
-/**
- * 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

@@ -1,81 +0,0 @@
-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 {};