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

package/dist/types/modals/InteractiveElements/DateTimePickerElement.d.ts

@@ -1,124 +0,0 @@
-import { DateTimePickerMode } from "../../Enums/Enums";
-import { fromJsonType } from "../InteractiveActions/APIAction";
-import { BaseInputElement } from "./BaseInputElement";
-/**
- * Represents a date and time picker element in a user interface.
- */
-export declare class DateTimePickerElement extends BaseInputElement<string> {
-    /**
-     * The label for the date-time picker.
-     * @type {string}
-     */
-    private label;
-    /**
-     * The mode of the date-time picker (e.g., date, time, or both).
-     * @type {DateTimePickerMode}
-     */
-    private mode;
-    /**
-     * The default value for the date-time picker.
-     * @type {string}
-     */
-    private defaultValue?;
-    /**
-     * The start date for the date-time picker.
-     * @type {string}
-     */
-    private from?;
-    /**
-     * The end date for the date-time picker.
-     * @type {string}
-     */
-    private to?;
-    /**
-     * The time zone for the date-time picker.
-     * @type {string}
-     */
-    private timezoneCode;
-    /**
-     * The format for the date-time picker.
-     * @type {string | undefined}
-     */
-    private dateTimeFormat?;
-    /**
-     * Creates an instance of `DateTimePickerElement`.
-     */
-    constructor(elementId: string, label: string, mode: DateTimePickerMode, timezoneCode: string, optional?: boolean);
-    /**
-    * Returns the label of the date-time picker.
-    * @returns {string} The label.
-    */
-    getLabel(): string;
-    /**
-     * Returns the default value of the date-time picker.
-     * @returns {string | undefined} The default value.
-     */
-    getDefaultValue(): string | undefined;
-    /**
-     * Sets the default value for the date-time picker.
-     * @param {string} defaultValue - The default value to set.
-     */
-    setDefaultValue(defaultValue: string): void;
-    /**
-     * Returns the mode of the date-time picker.
-     * @returns {DateTimePickerMode} The mode.
-     */
-    getMode(): DateTimePickerMode;
-    /**
-     * Returns the start date of the date-time picker.
-     * @returns {string | undefined} The start date.
-     */
-    getFrom(): string | undefined;
-    /**
-     * Sets the start date for the date-time picker.
-     * @param {string} fromDateTime - The start date to set.
-     */
-    setFrom(fromDateTime: string): void;
-    /**
-     * Returns the end date of the date-time picker.
-     * @returns {string | undefined} The end date.
-     */
-    getTo(): string | undefined;
-    /**
-     * Sets the end date for the date-time picker.
-     * @param {string} toDateTime - The end date to set.
-     */
-    setTo(toDateTime: string): void;
-    /**
-     * Returns the format of the date-time picker.
-     * @returns {string | undefined} The date-time format.
-     */
-    getDateTimeFormat(): string | undefined;
-    /**
-     * Sets the format for the date-time picker.
-     * @param {string} dateTimeFormat - The format to set.
-     */
-    setDateTimeFormat(dateTimeFormat: string): void;
-    /**
-     * Formats a given date-time using the date-time format.
-     *
-     * @param {Date} dateTime - The date-time to format.
-     * @returns {string | undefined} The formatted date-time or undefined if formatting fails.
-     */
-    formatDateTime(dateTime: Date): string | undefined;
-    /**
-     * Sets the time zone code for the date-time picker.
-     * @param {string} timezoneCode - The time zone code to set.
-     */
-    setTimezoneCode(timezoneCode: string): void;
-    /**
-     * Returns the time zone code for the date-time picker.
-     * @returns {string} The time zone code.
-     */
-    getTimezoneCode(): string;
-    /**
-     * Creates a `DateTimePickerElement` from a JSON object.
-     *
-     * This method initializes a `DateTimePickerElement` using the provided JSON data, including properties such as
-     * default value, start and end dates, date-time format, and time zone code.
-     *
-     * @param {fromJsonType} json - The JSON object containing properties for the `DateTimePickerElement`.
-     * @returns {DateTimePickerElement} The constructed `DateTimePickerElement` instance.
-     */
-    static fromJSON(json: fromJsonType): DateTimePickerElement;
-}

package/dist/types/modals/InteractiveElements/DropdownElement.d.ts

@@ -1,55 +0,0 @@
-import { BaseInputElement, OptionElement } from "./index";
-import { fromJsonType } from "../InteractiveActions/APIAction";
-/**
- * Represents a dropdown input element.
- */
-export declare class DropdownElement extends BaseInputElement<string> {
-    /**
-     * The label of the input element.
-     */
-    private label;
-    /**
-     * The default value to be selected in the dropdown.
-     */
-    private defaultValue?;
-    /**
-     * The options available for the dropdown input element.
-     */
-    private options;
-    /**
-     * Creates a new instance of DropdownInput.
-     * @param elementId - The ID of the input element.
-     * @param label - The label of the input element.
-     * @param options - The options available for the dropdown input element.
-     */
-    constructor(elementId: string, label: string, options?: OptionElement[]);
-    /**
-     * Gets the label of the input element.
-     * @returns The label of the input element.
-     */
-    getLabel(): string;
-    /**
-     * Gets the default value to be selected in the dropdown.
-     * @returns The default value to be selected in the dropdown.
-     */
-    getDefaultValue(): string | undefined;
-    /**
-     * Sets the default value to be selected in the dropdown.
-     * @param defaultValue - The default value to be selected in the dropdown.
-     */
-    setDefaultValue(defaultValue: string): void;
-    /**
-     * Gets the options available for the dropdown input element.
-     * @returns The options available for the dropdown input element.
-     */
-    getOptions(): OptionElement[];
-    /**
-     * Creates a `DropdownElement` from a JSON object.
-     *
-     * Initializes a `DropdownElement` using JSON data for the element ID, label, options, and optional default value.
-     *
-     * @param {fromJsonType} json - JSON object containing the properties for the dropdown element.
-     * @returns {DropdownElement} The `DropdownElement` instance.
-     */
-    static fromJSON(json: fromJsonType): DropdownElement;
-}

package/dist/types/modals/InteractiveElements/LabelElement.d.ts

@@ -1,29 +0,0 @@
-import { ElementEntity } from "../InteractiveEntities/ElementEntity";
-import { fromJsonType } from "../InteractiveActions/APIAction";
-/**
- * Represents a label element.
- */
-export declare class LabelElement extends ElementEntity {
-    /** The text to display in the label. */
-    private text;
-    /**
-     * Creates a new instance of the LabelElement class.
-     * @param {string} elementId - The unique identifier of the form element.
-     * @param {string} text - The text to display in the label.
-     */
-    constructor(elementId: string, text: string);
-    /**
-     * Returns the text to display in the label.
-     * @returns {string} The text to display in the label.
-     */
-    getText(): string;
-    /**
-     * Creates a `LabelElement` from a JSON object.
-     *
-     * Initializes a `LabelElement` using the provided JSON data for the element ID and text.
-     *
-     * @param {fromJsonType} json - JSON object containing the properties for the label element.
-     * @returns {LabelElement} The `LabelElement` instance.
-     */
-    static fromJSON(json: fromJsonType): LabelElement;
-}

package/dist/types/modals/InteractiveElements/OptionElement.d.ts

@@ -1,35 +0,0 @@
-import { fromJsonType } from "../InteractiveActions/APIAction";
-/**
- * Represents a option.
- */
-export declare class OptionElement {
-    /** The unique identifier for the option. */
-    private label;
-    /** The display value for the option. */
-    private value;
-    /**
-     * Creates a new instance of the OptionElement class.
-     * @param {string} label - The unique identifier for the option.
-     * @param {string} value - The display value for the option.
-     */
-    constructor(label: string, value: string);
-    /**
-     * Returns the unique identifier for the option.
-     * @returns {string} The unique identifier for the option.
-     */
-    getLabel(): string;
-    /**
-     * Returns the display value for the option.
-     * @returns {string} The display value for the option.
-     */
-    getValue(): string;
-    /**
-     * Creates an `OptionElement` from a JSON object.
-     *
-     * Initializes an `OptionElement` using the provided JSON data for the label and value.
-     *
-     * @param {fromJsonType} json - JSON object containing the properties for the option element.
-     * @returns {OptionElement} The `OptionElement` instance.
-     */
-    static fromJSON(json: fromJsonType): OptionElement;
-}

package/dist/types/modals/InteractiveElements/RadioButtonElement.d.ts

@@ -1,54 +0,0 @@
-import { BaseInputElement, OptionElement } from "./index";
-import { fromJsonType } from "../InteractiveActions/APIAction";
-type fromJSONRadioType = fromJsonType & {
-    options: OptionElement[] & fromJsonType;
-};
-/**
- * Represents a radio button input element.
- */
-export declare class RadioButtonElement extends BaseInputElement<string> {
-    /** The label of the input element. */
-    private label;
-    /** The default value of the input element. */
-    private defaultValue?;
-    /** The options available for the radio input element. */
-    private options;
-    /**
-     * Creates a new instance of the RadioButtonElement class.
-     * @param elementId The ID of the radio button element.
-     * @param label The label of the radio button element.
-     * @param options The options available for the radio button element.
-     */
-    constructor(elementId: string, label: string, options?: OptionElement[]);
-    /**
-     * Gets the label of the input element.
-     * @returns The label of the input element.
-     */
-    getLabel(): string;
-    /**
-     * Gets the default value of the input element.
-     * @returns The default value of the input element.
-     */
-    getDefaultValue(): string | undefined;
-    /**
-     * Sets the default value of the input element.
-     * @param defaultValue The default value of the input element.
-     */
-    setDefaultValue(defaultValue: string): void;
-    /**
-     * Gets the options available for the radio input element.
-     * @returns The options available for the radio input element.
-     */
-    getOptions(): OptionElement[];
-    /**
-     * Creates a `RadioButtonElement` from a JSON object.
-     *
-     * Initializes a `RadioButtonElement` using the provided JSON data. It sets the element's options,
-     * label, and default value if specified.
-     *
-     * @param {fromJSONRadioType} json - JSON object containing properties for the radio button element.
-     * @returns {RadioButtonElement} The `RadioButtonElement` instance.
-     */
-    static fromJSON(json: fromJSONRadioType | fromJsonType): RadioButtonElement;
-}
-export {};

package/dist/types/modals/InteractiveElements/SingleSelectElement.d.ts

@@ -1,50 +0,0 @@
-import { BaseInputElement, OptionElement } from "./index";
-import { fromJsonType } from "../InteractiveActions/APIAction";
-/**
- * Represents a singleSelect button input element.
- */
-export declare class SingleSelectElement extends BaseInputElement<string> {
-    /** The label of the input element. */
-    private label;
-    /** The default value of the input element. */
-    private defaultValue?;
-    /** The options available for the singleSelect input element. */
-    private options;
-    /**
-     * Creates a new instance of the SingleSelectElement class.
-     * @param elementId The ID of the singleSelect button element.
-     * @param label The label of the singleSelect button element.
-     * @param options The options available for the singleSelect button element.
-     */
-    constructor(elementId: string, label: string, options?: OptionElement[]);
-    /**
-     * Gets the label of the input element.
-     * @returns The label of the input element.
-     */
-    getLabel(): string;
-    /**
-     * Gets the default value of the input element.
-     * @returns The default value of the input element.
-     */
-    getDefaultValue(): string | undefined;
-    /**
-     * Sets the default value of the input element.
-     * @param defaultValue The default value of the input element.
-     */
-    setDefaultValue(defaultValue: string): void;
-    /**
-     * Gets the options available for the singleSelect input element.
-     * @returns The options available for the singleSelect input element.
-     */
-    getOptions(): OptionElement[];
-    /**
-     * Creates a `SingleSelectElement` from a JSON object.
-     *
-     * Initializes a `SingleSelectElement` using the provided JSON data. It sets the element's options,
-     * label, and default value if specified.
-     *
-     * @param {fromJsonType} json - JSON object containing properties for the single select element.
-     * @returns {SingleSelectElement} The `SingleSelectElement` instance.
-     */
-    static fromJSON(json: fromJsonType): SingleSelectElement;
-}

package/dist/types/modals/InteractiveElements/TextInputElement.d.ts

@@ -1,69 +0,0 @@
-import { BaseInputElement } from "./index";
-import { fromJsonType } from "../InteractiveActions/APIAction";
-/**
- * Represents a text input element.
- */
-export declare class TextInputElement extends BaseInputElement<string> {
-    /** The label of the input element. */
-    private label;
-    /** The maximum number of lines for a multi-line text input element. */
-    private maxLines?;
-    /** The placeholder text to display in the input element. */
-    private placeholder?;
-    /**
-     * The default value in text input.
-     */
-    private defaultValue?;
-    /**
-     * Creates a new instance of the TextInputElement class.
-     * @param {string} elementId - The unique identifier of the form element.
-     * @param {string} label - The label of the input element.
-     */
-    constructor(elementId: string, label: string);
-    /**
-     * Returns the label of the input element.
-     * @returns {string} The label of the input element.
-     */
-    getLabel(): string;
-    /**
-     * Returns the maximum number of lines for a multi-line text input element.
-     * @returns {number} The maximum number of lines for a multi-line text input element.
-     */
-    getMaxLines(): number | undefined;
-    /**
-     * Sets the maximum number of lines for a multi-line text input element.
-     * @param {number} maxLines - The maximum number of lines for a multi-line text input element.
-     */
-    setMaxLines(maxLines: number): void;
-    /**
-     * Returns the placeholder text to display in the input element.
-     * @returns {string} The placeholder text to display in the input element.
-     */
-    getPlaceholder(): string | undefined;
-    /**
-     * Sets the placeholder text to display in the input element.
-     * @param {string} placeholder - The placeholder text to display in the input element.
-     */
-    setPlaceholder(placeholder: string): void;
-    /**
-     * Returns the default value in text input.
-     * @returns {string} The default value in text input.
-     */
-    getDefaultValue(): string | undefined;
-    /**
-     * Sets the default value in text input.
-     * @param {string} defaultValue - The default value in text input.
-     * @returns {string} The default value in text input.
-     */
-    setDefaultValue(defaultValue: string): void;
-    /**
-     * Creates a `TextInputElement` from a JSON object.
-     *
-     * Initializes a `TextInputElement` using the provided JSON data. It sets properties such as maximum lines,
-     * placeholder text, and default value if specified.
-     *
-     * @param {fromJsonType} json - JSON object containing properties for the text input element.
-     * @returns {TextInputElement} The `TextInputElement` instance.
-     */
-    static fromJSON(json: fromJsonType): TextInputElement;
-}

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

@@ -1,11 +0,0 @@
-export { BaseInputElement } from "./BaseInputElement";
-export { BaseInteractiveElement } from "./BaseInteractiveElement";
-export { ButtonElement } from "./ButtonElement";
-export { CheckboxElement } from "./CheckboxElement";
-export { DropdownElement } from "./DropdownElement";
-export { LabelElement } from "./LabelElement";
-export { OptionElement } from "./OptionElement";
-export { RadioButtonElement } from "./RadioButtonElement";
-export { SingleSelectElement } from "./SingleSelectElement";
-export { TextInputElement } from "./TextInputElement";
-export { DateTimePickerElement } from "./DateTimePickerElement";

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

@@ -1,32 +0,0 @@
-import { APIAction, CustomAction, URLNavigationAction } from "../InteractiveActions";
-import { ButtonAction } from "../../Enums/Enums";
-import { fromJsonType } from "../InteractiveActions/APIAction";
-/**
- * Represents an action that can be performed on a UI element, such as a button.
- */
-export declare class ActionEntity {
-    /**
-     * The type of action to perform when the UI element is interacted with.
-     */
-    private actionType;
-    /**
-     * Creates an instance of the ActionEntity class.
-     * @param {ButtonAction} actionType - The type of action that the button performs.
-     */
-    constructor(actionType: ButtonAction);
-    /**
-     * Returns the type of action to perform when the UI element is interacted with.
-     * @returns {ButtonAction} The type of action to perform when the UI element is interacted with.
-     */
-    getActionType(): ButtonAction;
-    /**
-     * Creates an action instance from a JSON object based on the action type.
-     *
-     * Initializes the appropriate action type (`APIAction`, `URLNavigationAction`, or `CustomAction`)
-     * using the provided JSON data. The action type is determined by the `actionType` property in the JSON.
-     *
-     * @param {fromJsonType} json - JSON object containing the action type and properties.
-     * @returns {APIAction | URLNavigationAction | CustomAction} The corresponding action instance.
-     */
-    static fromJSON(json: fromJsonType): APIAction | URLNavigationAction | CustomAction;
-}

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

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

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

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

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

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

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