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

package/dist/types/modals/InteractiveEntities/ElementEntity.d.ts

@@ -0,0 +1,35 @@
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents the base input for a dynamic form element.
+ */
+export declare class ElementEntity {
+    /**
+     * The type of the form element.
+     */
+    private elementType;
+    /**
+     * The unique identifier of the form element.
+     */
+    private elementId;
+    constructor(elementId: string, elementType: string);
+    /**
+     * Returns the type of the form element.
+     * @returns {string} The type of the form element.
+     */
+    getElementType(): string;
+    /**
+     * Returns the unique identifier of the form element.
+     * @returns {string} The unique identifier of the form element.
+     */
+    getElementId(): string;
+    /**
+     * Creates an `ElementEntity` instance from a JSON object based on its `elementType`.
+     *
+     * Initializes the appropriate element (`BaseInputElement`, `BaseInteractiveElement`, etc.)
+     * or a default `LabelElement` if the `elementType` is unrecognized.
+     *
+     * @param {fromJsonType} json - The JSON object containing element properties and `elementType`.
+     * @returns {ElementEntity} The constructed `ElementEntity`.
+     */
+    static fromJSON(json: fromJsonType): ElementEntity;
+}

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

@@ -0,0 +1,2 @@
+export { ActionEntity } from "./ActionEntity";
+export { ElementEntity } from "./ElementEntity";

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

@@ -0,0 +1,69 @@
+import { ButtonElement } from "../InteractiveElements/index";
+import { CometChat } from "@cometchat/chat-sdk-javascript";
+export interface CardData {
+    text: string;
+    cardActions: Array<ButtonElement>;
+    imageUrl?: string;
+}
+/**
+ * Represents a card message for CometChat.
+ * @extends CometChat.InteractiveMessage
+ */
+export declare class CardMessage extends CometChat.InteractiveMessage {
+    /**
+     * The URL of the image for the card.
+     */
+    private imageUrl?;
+    /**
+     * The text to display on the card.
+     */
+    private text;
+    /**
+     * The actions to perform when the card is interacted with.
+     */
+    private cardActions;
+    /**
+     * Creates a new instance of CardMessage.
+     * @param receiverId - The ID of the receiver.
+     * @param receiverType - The type of the receiver.
+     * @param text - The text to display on the card.
+     * @param cardActions - The actions to perform when the card is interacted with.
+     */
+    constructor(receiverId: string, receiverType: string, text: string, cardActions: Array<ButtonElement>);
+    /**
+     * Gets the URL of the image for the card.
+     * @returns The URL of the image.
+     */
+    getImageUrl(): string | undefined;
+    /**
+     * Sets the image URL for the interactive card data.
+     * @param imageUrl - The URL of the image to be set.
+     */
+    setImageUrl(imageUrl: string): void;
+    /**
+     * Gets the text to display on the card.
+     * @returns The text to display.
+     */
+    getText(): string;
+    /**
+     * Gets the actions to perform when the card is interacted with.
+     * @returns The actions to perform.
+     */
+    getCardActions(): Array<ButtonElement>;
+    /**
+     * Sets the interactive data for the card message.
+     * @param json - The partial data to set.
+     */
+    setInteractiveData(json: Partial<CardData>): void;
+    /**
+     * Gets the interactive data for the card message.
+     * @returns The interactive data.
+     */
+    getInteractiveData(): CardData;
+    /**
+     * Creates a new instance of CardMessage from the provided JSON.
+     * @param json - The JSON to create the instance from.
+     * @returns The new instance of CardMessage.
+     */
+    static fromJSON(json: CometChat.InteractiveMessage): CardMessage;
+}

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

@@ -0,0 +1,20 @@
+import { CometChat } from "@cometchat/chat-sdk-javascript";
+/**
+ * Represents a custom interactive message that extends CometChat's InteractiveMessage class.
+ * @extends CometChat.InteractiveMessage
+ */
+export declare class CustomInteractiveMessage extends CometChat.InteractiveMessage {
+    /**
+     * Creates a new instance of CustomInteractiveMessage.
+     * @param receiverId - The ID of the receiver of the message.
+     * @param receiverType - The type of the receiver of the message.
+     * @param json - The JSON object to create the CustomInteractiveMessage object from.
+     */
+    constructor(receiverId: string, receiverType: string, json: Object);
+    /**
+     * Static method to create a CustomInteractiveMessage object from a JSON object.
+     * @param json - JSON object to create the CustomInteractiveMessage object from.
+     * @returns CustomInteractiveMessage object.
+     */
+    static fromJSON(json: CometChat.InteractiveMessage): CustomInteractiveMessage;
+}

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

@@ -0,0 +1,75 @@
+import { ButtonElement } from "../InteractiveElements/index";
+import { CometChat } from "@cometchat/chat-sdk-javascript";
+import { ElementEntity } from "../InteractiveEntities/ElementEntity";
+export interface FormData {
+    title: string;
+    formFields: ElementEntity[];
+    submitElement: ButtonElement;
+    goalCompletionText?: string;
+}
+/**
+ * Represents a form message that extends CometChat's InteractiveMessage class.
+ * @extends CometChat.InteractiveMessage
+ */
+export declare class FormMessage extends CometChat.InteractiveMessage {
+    /**
+     * The title of the form.
+     */
+    private title;
+    /**
+     * The goal completion text of the form.
+     */
+    private goalCompletionText?;
+    /**
+     * The form fields of the form.
+     */
+    private formFields;
+    /**
+     * The submit button of the form.
+     */
+    private submitElement;
+    /**
+     * Represents a form message that can be sent via CometChat.
+     */
+    constructor(receiverId: string, receiverType: string, title: string, formFields: ElementEntity[], submitElement: ButtonElement);
+    /**
+     * Sets the interactive form data for the message.
+     * @param {InteractiveFormData} interactiveFormData - The interactive form data to be set.
+     */
+    setInteractiveData(formData: Partial<FormData>): void;
+    getInteractiveData(): FormData;
+    /**
+     * Returns the form fields of the form.
+     * @returns An array of form fields.
+     */
+    getFormFields(): ElementEntity[];
+    /**
+     * Returns the title of the form.
+     * @returns The title of the form.
+     */
+    getTitle(): string;
+    /**
+     * Returns the submit button of the form.
+     * @returns The submit button of the form.
+     */
+    getSubmitElement(): ButtonElement;
+    /**
+     * Returns the goal completion text of the form.
+     * @returns The goal completion text of the form.
+     */
+    getGoalCompletionText(): string | undefined;
+    /**
+     * Sets the goal completion text of the form.
+     * @param goalCompletionText - The goal completion text of the form.
+     */
+    setGoalCompletionText(goalCompletionText: string): void;
+    /**
+      * Creates a `FormMessage` instance from a JSON object.
+      *
+      * Initializes a `FormMessage` with form fields, a submit button, and optional goal completion text from the JSON data.
+      *
+      * @param {fromJsonType} json - The JSON object containing form properties.
+      * @returns {FormMessage} The `FormMessage` instance.
+      */
+    static fromJSON(json: CometChat.InteractiveMessage): FormMessage;
+}

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

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

@@ -0,0 +1,5 @@
+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/modals/index.d.ts

@@ -0,0 +1,7 @@
+export { CometChatActions } from './CometChatActions';
+export { CometChatActionsIcon } from './CometChatActionsIcon';
+export { CometChatActionsView } from './CometChatActionsView';
+export { CometChatMessageComposerAction } from './CometChatMessageComposerAction';
+export { CometChatMessageOption } from './CometChatMessageOption';
+export { CometChatMessageTemplate } from './CometChatMessageTemplate';
+export { CometChatOption } from './CometChatOption';