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

package/dist/types/src/components/BaseComponents/CometChatAudioBubble/src/webaudio.d.ts

@@ -0,0 +1,63 @@
+import EventEmitter from './event-emitter';
+type WebAudioPlayerEvents = {
+    loadedmetadata: [];
+    canplay: [];
+    play: [];
+    pause: [];
+    seeking: [];
+    timeupdate: [];
+    volumechange: [];
+    emptied: [];
+    ended: [];
+};
+/**
+ * A Web Audio buffer player emulating the behavior of an HTML5 Audio element.
+ */
+declare class WebAudioPlayer extends EventEmitter<WebAudioPlayerEvents> {
+    private audioContext;
+    private gainNode;
+    private bufferNode;
+    private playStartTime;
+    private playedDuration;
+    private _muted;
+    private _playbackRate;
+    private _duration;
+    private buffer;
+    currentSrc: string;
+    paused: boolean;
+    crossOrigin: string | null;
+    seeking: boolean;
+    autoplay: boolean;
+    constructor(audioContext?: AudioContext);
+    /** Subscribe to an event. Returns an unsubscribe function. */
+    addEventListener: <EventName extends keyof WebAudioPlayerEvents>(event: EventName, listener: (...args: WebAudioPlayerEvents[EventName]) => void, options?: {
+        once?: boolean | undefined;
+    } | undefined) => () => void;
+    /** Unsubscribe from an event */
+    removeEventListener: <EventName extends keyof WebAudioPlayerEvents>(event: EventName, listener: (...args: WebAudioPlayerEvents[EventName]) => void) => void;
+    load(): Promise<void>;
+    get src(): string;
+    set src(value: string);
+    private _play;
+    private _pause;
+    play(): Promise<void>;
+    pause(): void;
+    stopAt(timeSeconds: number): void;
+    setSinkId(deviceId: string): Promise<void>;
+    get playbackRate(): number;
+    set playbackRate(value: number);
+    get currentTime(): number;
+    set currentTime(value: number);
+    get duration(): number;
+    set duration(value: number);
+    get volume(): number;
+    set volume(value: number);
+    get muted(): boolean;
+    set muted(value: boolean);
+    canPlayType(mimeType: string): boolean;
+    /** Get the GainNode used to play the audio. Can be used to attach filters. */
+    getGainNode(): GainNode;
+    /** Get decoded audio */
+    getChannelData(): Float32Array[];
+}
+export default WebAudioPlayer;

package/dist/types/src/components/BaseComponents/CometChatAvatar/CometChatAvatar.d.ts

@@ -0,0 +1,13 @@
+interface BaseProps {
+    /** Name used for displaying initials in the avatar. */
+    name?: string;
+    /** URL of the avatar image to be displayed. */
+    image?: string;
+}
+type CometChatAvatarProps = BaseProps & {
+    name: string;
+} | BaseProps & {
+    image: string;
+};
+declare const CometChatAvatar: (props: CometChatAvatarProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatAvatar };

package/dist/types/src/components/BaseComponents/CometChatButton/CometChatButton.d.ts

@@ -0,0 +1,12 @@
+interface ButtonProps {
+    text?: string;
+    hoverText?: string;
+    iconURL?: string;
+    disabled?: boolean;
+    isLoading?: boolean;
+    onClick?: (customEvent: CustomEvent<{
+        event: PointerEvent;
+    }>) => void;
+}
+declare const CometChatButton: (props: ButtonProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatButton };

package/dist/types/src/components/BaseComponents/CometChatCallBubble/CometChatCallBubble.d.ts

@@ -0,0 +1,12 @@
+import React from "react";
+interface CallBubbleProps {
+    title?: string;
+    sessionId?: string;
+    subtitle?: React.ReactNode;
+    buttonText?: string;
+    iconURL?: string;
+    onClicked?: ((url: string) => void) | undefined;
+    isSentByMe?: boolean;
+}
+declare const CometChatCallBubble: (props: CallBubbleProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatCallBubble };

package/dist/types/src/components/BaseComponents/CometChatChangeScope/CometChatChangeScope.d.ts

@@ -0,0 +1,10 @@
+interface ChangeScopeProps {
+    title?: string;
+    buttonText?: string;
+    options: string[];
+    defaultSelection?: string;
+    onScopeChanged?: (scope: string) => Promise<void>;
+    onCloseClick?: () => void;
+}
+declare const CometChatChangeScope: (props: ChangeScopeProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatChangeScope };

package/dist/types/src/components/BaseComponents/CometChatChangeScope/useCometChatChangeScope.d.ts

@@ -0,0 +1,10 @@
+export declare const useCometChatChangeScope: ({ defaultSelection, }: {
+    defaultSelection?: string | undefined;
+}) => {
+    selectedValue: string;
+    selectionChanged: (input: {
+        checked: boolean;
+        labelText: string | undefined;
+        id: string;
+    }) => void;
+};

package/dist/types/src/components/BaseComponents/CometChatCheckbox/CometChatCheckbox.d.ts

@@ -0,0 +1,11 @@
+interface CheckboxProps {
+    checked?: boolean;
+    labelText?: string;
+    disabled?: boolean;
+    onCheckBoxValueChanged: (input: {
+        checked: boolean;
+        labelText: string | undefined;
+    }) => void;
+}
+declare const CometChatCheckbox: (props: CheckboxProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatCheckbox };

package/dist/types/src/components/BaseComponents/CometChatCheckbox/useCometChatCheckbox.d.ts

@@ -0,0 +1,11 @@
+import { ChangeEvent } from "react";
+export declare const useCometChatCheckbox: ({ checked, onCheckBoxValueChanged }: {
+    checked?: boolean | undefined;
+    onCheckBoxValueChanged?: ((input: {
+        checked: boolean;
+        labelText: string | undefined;
+    }) => void) | undefined;
+}) => {
+    isChecked: boolean;
+    updateCheckbox: (event: ChangeEvent<HTMLInputElement>) => void;
+};

package/dist/types/src/components/BaseComponents/CometChatConfirmDialog/CometChatConfirmDialog.d.ts

@@ -0,0 +1,16 @@
+interface ConfirmDialogProps {
+    /** The title displayed at the top of the confirm dialog. */
+    title?: string;
+    /** The descriptive text inside the confirm dialog. */
+    messageText?: string;
+    /** The text displayed on the "cancel" button. */
+    cancelButtonText?: string;
+    /** The text displayed on the "confirm" button. */
+    confirmButtonText?: string;
+    /** Callback function for when the confirm button is clicked. */
+    onSubmitClick?: () => Promise<void>;
+    /** Callback function for when the cancel button is clicked. */
+    onCancelClick?: () => void;
+}
+declare const CometChatConfirmDialog: (props: ConfirmDialogProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatConfirmDialog };

package/dist/types/src/components/BaseComponents/CometChatContextMenu/CometChatContextMenu.d.ts

@@ -0,0 +1,17 @@
+import { CometChatActionsIcon, CometChatActionsView, CometChatOption } from '../../../modals';
+import { Placement } from '../../../Enums/Enums';
+interface ContextMenuProps {
+    data: Array<CometChatActionsIcon | CometChatActionsView | CometChatOption>;
+    topMenuSize?: number;
+    moreIconHoverText?: string;
+    onOptionClicked?: (option: CometChatActionsIcon | CometChatActionsView | CometChatOption) => void;
+    placement?: Placement;
+    closeOnOutsideClick?: boolean;
+}
+/**
+ * CometChatContextMenu is a composite component used to display menu data in required format.
+ * It accepts a data array for displaying the menu items and topMenuSize to specify how many menu items should be visible by default.
+ * It also accepts a URL for the 'more' icon, placement and a menu click callback function for customization purposes.
+ */
+declare const CometChatContextMenu: (props: ContextMenuProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatContextMenu };

package/dist/types/src/components/BaseComponents/CometChatDate/CometChatDate.d.ts

@@ -0,0 +1,13 @@
+import { DatePatterns } from "../../../Enums/Enums";
+interface DateProps {
+    timestamp: number;
+    pattern?: DatePatterns;
+    customDateString?: string | null;
+}
+/**
+ * CometChatDate is a generic component used to display dates in the required format.
+ * It accepts a timestamp of the time to be displayed and the pattern in which the time should be displayed.
+ * It also accepts the customDateString prop, whose value is used as is for displaying the time.
+ */
+declare const CometChatDate: (props: DateProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatDate };

package/dist/types/src/components/BaseComponents/CometChatDate/useCometChatDate.d.ts

@@ -0,0 +1,8 @@
+import { DatePatterns } from "../../../Enums/Enums";
+export declare const useCometChatDate: ({ timestamp, pattern, customDateString, }: {
+    timestamp: number;
+    pattern: DatePatterns;
+    customDateString: string | null;
+}) => {
+    getFormattedDate: () => string | null;
+};

package/dist/types/src/components/BaseComponents/CometChatDeleteBubble/CometChatDeleteBubble.d.ts

@@ -0,0 +1,14 @@
+interface DeleteBubbleProps {
+    isSentByMe: boolean;
+    /**
+     * Optional. The text to display. If not provided, a default
+     * localized "DELETE_MSG_TEXT" will be used.
+     */
+    text?: string;
+}
+/**
+ * CometChatDeleteBubble is a generic component used to indicate that a message has been deleted.
+ * It accepts the isSentByMe prop and applies sender or receiver styling based on its value.
+ */
+declare const CometChatDeleteBubble: (props: DeleteBubbleProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatDeleteBubble };

package/dist/types/src/components/BaseComponents/CometChatDocumentBubble/CometChatDocumentBubble.d.ts

@@ -0,0 +1,11 @@
+interface DocumentBubbleProps {
+    bannerImage: string;
+    title: string;
+    URL: string;
+    subtitle: string;
+    buttonText: string;
+    isSentByMe?: boolean;
+    onClicked: ((url: string) => void) | undefined;
+}
+declare const CometChatDocumentBubble: (props: DocumentBubbleProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatDocumentBubble };

package/dist/types/src/components/BaseComponents/CometChatDropDown/CometChatDropDown.d.ts

@@ -0,0 +1,14 @@
+interface onOptionsChangedEvent {
+    /** The value of the selected option from the dropdown. */
+    value?: string;
+}
+interface DropDownProps {
+    /** List of options to be displayed in the dropdown. */
+    options: string[];
+    /** Value from the list to be selected by default. */
+    selectedOption?: string;
+    /** Callback invoked when the dropdown selection changes. */
+    onOptionsChanged?: (input: onOptionsChangedEvent) => void;
+}
+declare const CometChatDropDown: (props: DropDownProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatDropDown };

package/dist/types/src/components/BaseComponents/CometChatDropDown/useCometChatDropDown.d.ts

@@ -0,0 +1,12 @@
+import { MouseEvent } from "react";
+export declare const useCometChatDropDown: ({ selectedOption, onOptionsChanged, }: {
+    selectedOption?: string | undefined;
+    onOptionsChanged?: (({ value: string }: {
+        value?: string | undefined;
+    }) => void) | undefined;
+}) => {
+    selectedOptionState: string;
+    dropdownVisible: boolean;
+    onButtonClick: (event: MouseEvent<HTMLButtonElement>) => void;
+    onOptionClick: (selectedOption: string) => void;
+};

package/dist/types/src/components/BaseComponents/CometChatEditPreview/CometChatEditPreview.d.ts

@@ -0,0 +1,21 @@
+import { FC } from 'react';
+/**
+ * Interface for the props used in the CometChatEditPreview component.
+ */
+interface EditPreviewProps {
+    /** The title to display in the preview, defaults to "Edit Message"*/
+    previewTitle?: string;
+    /** The subtitle to display in the preview, can be left empty. */
+    previewSubtitle?: string;
+    /** Callback function that triggers when the close button is clicked. */
+    onClose?: () => void;
+}
+/**
+ * CometChatEditPreview Component
+ *
+ * A React component that displays a preview of an edited message with a title and subtitle.
+ * @param {EditPreviewProps} props - The props for the component.
+ * @returns {JSX.Element} A JSX element displaying the edit preview UI.
+ */
+declare const CometChatEditPreview: FC<EditPreviewProps>;
+export { CometChatEditPreview };

package/dist/types/src/components/BaseComponents/CometChatEmojiKeyboard/CometChatEmoji.d.ts

@@ -0,0 +1,22 @@
+export declare class CometChatEmoji {
+    char: string;
+    keywords: any;
+    constructor({ char, keywords }: {
+        char?: string | undefined;
+        keywords?: never[] | undefined;
+    });
+}
+export declare class CometChatEmojiCategory {
+    id: string;
+    symbolURL: string;
+    name: string;
+    emojies: {
+        [key: string]: CometChatEmoji;
+    };
+    constructor({ id, symbolURL, name, emojies, }: {
+        id?: string | undefined;
+        symbolURL?: string | undefined;
+        name?: string | undefined;
+        emojies?: {} | undefined;
+    });
+}

package/dist/types/src/components/BaseComponents/CometChatEmojiKeyboard/CometChatEmojiKeyboard.d.ts

@@ -0,0 +1,7 @@
+import { CometChatEmojiCategory } from "./CometChatEmoji";
+interface EmojiKeyboardProps {
+    emojiData?: CometChatEmojiCategory[];
+    onEmojiClick?: (emoji: string) => void;
+}
+declare const CometChatEmojiKeyboard: (props: EmojiKeyboardProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatEmojiKeyboard };