@cometchat/chat-sdk-javascript 4.1.1 → 4.1.3

package/CometChat.d.ts

@@ -300,7 +300,7 @@ export class CometChat {
                 };
                 SESSION_ID_REQUIRED: {
                         code: string;
-                        name: string;
+                        /** @internal */ name: string;
                         message: string;
                         details: {};
                 };
@@ -433,6 +433,7 @@ export class CometChat {
                                 MENTIONED_UIDS: string;
                                 ATTACHMENT_TYPES: string;
                                 WITH_PARENT: string;
+                                HIDE_QUOTED_MESSAGES: string;
                         };
                 };
         };
@@ -1086,6 +1087,7 @@ export class CometChat {
         static CometChatHelper: typeof CometChatHelper;
         static Attachment: typeof Attachment;
         static MediaDevice: typeof MediaDevice;
+        static StorageMode: typeof StorageMode;
         static MESSAGE_TYPE: {
                 TEXT: string;
                 MEDIA: string;
@@ -1215,6 +1217,10 @@ export class CometChat {
             * @memberof CometChat
          */
         static getSessionId(): string;
+        /**
+            * Initialize the storage with the current storage mode from AppSettings
+            */
+        static initializeStorage(): Promise<void>;
         /**
             * Storage event when a key is added/updated in localstorage.
             * @internal
@@ -2527,6 +2533,8 @@ export class BaseMessage implements Message {
         protected unreadRepliesCount: number;
         protected mentionedUsers?: User[];
         protected mentionedMe?: boolean;
+        protected quotedMessageId?: number;
+        protected quotedMessage?: BaseMessage;
         constructor(receiverId: string, messageType: string, receiverType: string, category: MessageCategory);
         /**
             * Get unread replies count of the message
@@ -2786,12 +2794,32 @@ export class BaseMessage implements Message {
             * set the array of reactions in message
             * @param {ReactionCount[]} reactions
             */
-        setReactions(reactions: any): ReactionCount[];
+        setReactions(reactions: ReactionCount[]): void;
         /**
             * Get the array of reactions in message
             * @returns {ReactionCount[]}
             */
         getReactions(): ReactionCount[];
+        /**
+            * Get quoted message ID of the message.
+            * @returns {number}
+            */
+        getQuotedMessageId(): number;
+        /**
+            * @param {number} value
+            * Set quoted message ID of the message.
+            */
+        setQuotedMessageId(value: number): void;
+        /**
+            * Get quoted message of the message.
+            * @returns {BaseMessage}
+            */
+        getQuotedMessage(): BaseMessage;
+        /**
+            * @param {BaseMessage} value
+            * Set quoted message of the message.
+            */
+        setQuotedMessage(value: BaseMessage): void;
 }
 
 /**
@@ -2924,6 +2952,10 @@ export enum GroupMemberScope {
     Moderator = "moderator",
     Member = "member"
 }
+export enum StorageMode {
+    LOCAL = "local",
+    SESSION = "session"
+}
 export const GROUP_MEMBER_SCOPE: {
     ADMIN: string;
     MODERATOR: string;
@@ -3150,6 +3182,7 @@ export const MessageConstatnts: {
             MENTIONED_UIDS: string;
             ATTACHMENT_TYPES: string;
             WITH_PARENT: string;
+            HIDE_QUOTED_MESSAGES: string;
         };
     };
 };
@@ -5016,6 +5049,10 @@ export class GroupsRequestBuilder {
 }
 
 export class GroupMembersRequest {
+        static USER_STATUS: {
+                ONLINE: string;
+                OFFLINE: string;
+        };
         constructor(builder: GroupMembersRequestBuilder);
         /**
             * Get list of next set of group members based on the parameters specified in GroupMembersRequestBuilder class. The Developer need to call this method repeatedly using the same object of GroupMembersRequest class to get paginated list of group members.
@@ -5047,6 +5084,12 @@ export class GroupMembersRequest {
             * @return {String[]}
             */
         getScopes(): String[];
+        /**
+            * Gets the status filter used to fetch members based on their online or offline status.
+            *
+            * @return {string}
+            */
+        getStatus(): string;
         /**
             * @internal
             */
@@ -5057,6 +5100,7 @@ export class GroupMembersRequestBuilder {
         /** @private */ searchKeyword: string;
         /** @private */ guid: string;
         /** @private */ scopes?: Array<String>;
+        /** @private */ status: string;
         constructor(guid: string);
         /**
             * Set the unique identifier of the group.
@@ -5086,6 +5130,12 @@ export class GroupMembersRequestBuilder {
             * @returns
          */
         setScopes(scopes: Array<String>): this;
+        /**
+            * A method to get the members belonging to a specific status.
+            * @param {string} status
+            * @returns
+         */
+        setStatus(status: string): this;
         /**
             * This method will return an object of the GroupMembersRequest class.
             * @returns {GroupMembersRequest}
@@ -5454,6 +5504,18 @@ export class ConversationsRequest {
             * @returns {boolean}
          */
         getUnread(): boolean;
+        /**
+            * Determines whether agentic conversations should be hidden.
+            *
+            * @returns {boolean}
+         */
+        getHideAgentic(): boolean;
+        /**
+            * Determines whether only agentic conversations should be fetched.
+            *
+            * @returns {boolean}
+         */
+        getOnlyAgentic(): boolean;
 }
 export class ConversationsRequestBuilder {
         /** @private */ conversationType: string;
@@ -5467,6 +5529,8 @@ export class ConversationsRequestBuilder {
         /** @private */ WithBlockedInfo: boolean;
         /** @private */ searchKeyword: string;
         /** @private */ unreadOnly: boolean;
+        /** @private */ hideAgentic: boolean;
+        /** @private */ onlyAgentic: boolean;
         /**
             *
             * @param {number} limit
@@ -5555,6 +5619,18 @@ export class ConversationsRequestBuilder {
             * @returns
          */
         setUnread(unread: boolean): this;
+        /**
+            * A method to hide agentic conversations from the list.
+            * @param {boolean} hideAgentic
+            * @returns
+         */
+        setHideAgentic(hideAgentic: boolean): this;
+        /**
+            * A method to fetch only agentic conversations.
+            * @param {boolean} onlyAgentic
+            * @returns
+         */
+        setOnlyAgentic(onlyAgentic: boolean): this;
         /**
             * This method will return an object of the ConversationsRequest class.
             * @returns {ConversationsRequest}
@@ -5737,6 +5813,12 @@ export class MessagesRequest {
             * Gets the flag indicating whether to fetch messages with parent message information.
          */
         isWithParent(): boolean;
+        /**
+            * Gets the flag indicating whether to hide quoted messages when fetching messages.
+            *
+            * @return {boolean}
+            */
+        isHideQuotedMessages(): boolean;
         /**
             * Get list of next messages based on the parameters specified in MessagesRequestBuilder class. The Developer need to call this method repeatedly using the same object of MessagesRequest class to get paginated list of message.
             * @returns {Promise<BaseMessage[] | []>}
@@ -5779,6 +5861,7 @@ export class MessagesRequestBuilder {
         /** @private */ mentionedUIDs?: Array<String>;
         /** @private */ attachmentTypes?: Array<AttachmentType>;
         /** @private */ WithParent?: boolean;
+        /** @private */ HideQuotedMessages?: boolean;
         /**
             * A method to set limit for the number of messages returned in a single iteration. A maximum of 100 messages can fetched in a single iteration.
             * @param {number} limit
@@ -5953,6 +6036,12 @@ export class MessagesRequestBuilder {
             * @returns {this}
          */
         withParent(withParent?: boolean): this;
+        /**
+            * A method to hide quoted messages.
+            * @param {boolean} hideQuotedMessages
+            * @returns
+         */
+        hideQuotedMessages(hideQuotedMessages: boolean): this;
         /**
             * This method will return an object of the MessagesRequest class.
             * @returns {MessagesRequest}
@@ -6225,6 +6314,10 @@ export class BlockedUsersRequestBuilder {
         build(): BlockedUsersRequest;
 }
 
+/**
+    *
+    * @module AppSettings
+    */
 export class AppSettings {
         static SUBSCRIPTION_TYPE_NONE: string;
         static SUBSCRIPTION_TYPE_ALL_USERS: string;
@@ -6238,6 +6331,9 @@ export class AppSettings {
         static REGION_IN: string;
         /** @private */
         static REGION_PRIVATE: string;
+        /** Storage modes */
+        static STORAGE_MODE_LOCAL: StorageMode;
+        static STORAGE_MODE_SESSION: StorageMode;
         /** @private */
         subscriptionType: string;
         /** @private */
@@ -6252,6 +6348,8 @@ export class AppSettings {
         adminHost: string;
         /** @private */
         clientHost: string;
+        /** @private */
+        storageMode: StorageMode;
         /**
             * @private
             * @param {AppSettingsBuilder}
@@ -6289,9 +6387,14 @@ export class AppSettings {
         getAdminHost(): string;
         /**
             * This method returns the client host to which the SDK should connect.
-            * @returns {boolean}
+            * @returns {string}
          */
         getClientHost(): string;
+        /**
+            * This method returns the storage mode (local or session) set using the `setStorageMode()` of the AppSettingsBuilder.
+            * @returns {StorageMode}
+         */
+        getStorageMode(): StorageMode;
 }
 export class AppSettingsBuilder {
         /** @private */
@@ -6308,6 +6411,8 @@ export class AppSettingsBuilder {
         adminHost: string;
         /** @private */
         clientHost: string;
+        /** @private */
+        storageMode: StorageMode;
         /**
             * A method to subscribe presence for all users.
             * @returns
@@ -6354,6 +6459,13 @@ export class AppSettingsBuilder {
             * @returns
          */
         overrideClientHost(clientHost: string): this;
+        /**
+            * @param {StorageMode} storageMode
+            * This method is used to set the storage mode for the SDK. Default is 'local' (localStorage).
+            * Use 'session' for sessionStorage.
+            * @returns {this}
+         */
+        setStorageMode(storageMode: StorageMode): this;
         /**
             * This method will return an object of the AppSettings class.
             * @returns {AppSettings}
@@ -8325,7 +8437,7 @@ export class AIAssistantBaseEvent<T extends AssistantBaseEventData = AssistantBa
         /**
             * The parent message ID (if applicable)
             */
-        patentMessageId: string;
+        parentMessageId: string;
         /**
             * Additional data associated with the event
             */
@@ -8335,10 +8447,10 @@ export class AIAssistantBaseEvent<T extends AssistantBaseEventData = AssistantBa
             * @param type - The type of the stream event
             * @param conversationId - The conversation ID
             * @param messageId - The message ID
-            * @param patentMessageId - The parent message ID
+            * @param parentMessageId - The parent message ID
             * @param data - Additional data with timestamp
             */
-        constructor(type: string, conversationId: string, messageId: string, patentMessageId: string, data: T);
+        constructor(type: string, conversationId: string, messageId: string, parentMessageId: string, data: T);
         /**
             * Get the type of the stream event
             * @returns The type as a string
@@ -8371,14 +8483,26 @@ export class AIAssistantBaseEvent<T extends AssistantBaseEventData = AssistantBa
         setMessageId(messageId: string): void;
         /**
             * Get the parent message ID
+            * @deprecated Use getParentMessageId() instead
             * @returns The parent message ID as a string
             */
         getPatentMessageId(): string;
+        /**
+            * Get the parent message ID
+            * @returns The parent message ID as a string
+            */
+        getParentMessageId(): string;
         /**
             * Set the parent message ID
-            * @param patentMessageId - The parent message ID to set
+            * @deprecated Use setParentMessageId() instead
+            * @param parentMessageId - The parent message ID to set
             */
-        setPatentMessageId(patentMessageId: string): void;
+        setPatentMessageId(parentMessageId: string): void;
+        /**
+            * Set the parent message ID
+            * @param parentMessageId - The parent message ID to set
+            */
+        setParentMessageId(parentMessageId: string): void;
         /**
             * Get the data object
             * @returns The data object
@@ -8440,7 +8564,7 @@ export interface AssistantRunStartedEventData extends AssistantBaseEventData {
     [key: string]: any;
 }
 export class AIAssistantRunStartedEvent extends AIAssistantBaseEvent<AssistantRunStartedEventData> {
-    constructor(conversationId: string, messageId: string, patentMessageId: string, data: AssistantRunStartedEventData);
+    constructor(conversationId: string, messageId: string, parentMessageId: string, data: AssistantRunStartedEventData);
 }
 
 /**
@@ -8451,7 +8575,7 @@ export interface AssistantRunFinishedEventData extends AssistantBaseEventData {
     [key: string]: any;
 }
 export class AIAssistantRunFinishedEvent extends AIAssistantBaseEvent<AssistantRunFinishedEventData> {
-    constructor(conversationId: string, messageId: string, patentMessageId: string, data: AssistantRunFinishedEventData);
+    constructor(conversationId: string, messageId: string, parentMessageId: string, data: AssistantRunFinishedEventData);
 }
 
 /**
@@ -8463,7 +8587,7 @@ export interface AssistantMessageStartedEventData extends AssistantBaseEventData
         [key: string]: any;
 }
 export class AIAssistantMessageStartedEvent extends AIAssistantBaseEvent<AssistantMessageStartedEventData> {
-        constructor(conversationId: string, messageId: string, patentMessageId: string, data: AssistantMessageStartedEventData);
+        constructor(conversationId: string, messageId: string, parentMessageId: string, data: AssistantMessageStartedEventData);
         /**
             * Returns the role of the event
             * @returns {string | undefined} The role of the event
@@ -8484,7 +8608,7 @@ export interface AssistantMessageEndedEventData extends AssistantBaseEventData {
     [key: string]: any;
 }
 export class AIAssistantMessageEndedEvent extends AIAssistantBaseEvent<AssistantMessageEndedEventData> {
-    constructor(conversationId: string, messageId: string, patentMessageId: string, data: AssistantMessageEndedEventData);
+    constructor(conversationId: string, messageId: string, parentMessageId: string, data: AssistantMessageEndedEventData);
 }
 
 /**
@@ -8499,7 +8623,7 @@ export interface AssistantContentEventData extends AssistantBaseEventData {
     * Event class for text message content received from assistant
     */
 export class AIAssistantContentReceivedEvent extends AIAssistantBaseEvent<AssistantContentEventData> {
-        constructor(conversationId: string, messageId: string, patentMessageId: string, data: AssistantContentEventData);
+        constructor(conversationId: string, messageId: string, parentMessageId: string, data: AssistantContentEventData);
         /**
             * Gets the delta value for the content received event
             * @returns The delta string
@@ -8527,7 +8651,7 @@ export interface AssistantToolStartedEventData extends AssistantBaseEventData {
     * Event class for tool call started events
     */
 export class AIAssistantToolStartedEvent extends AIAssistantBaseEvent<AssistantToolStartedEventData> {
-        constructor(conversationId: string, messageId: string, patentMessageId: string, data: AssistantToolStartedEventData);
+        constructor(conversationId: string, messageId: string, parentMessageId: string, data: AssistantToolStartedEventData);
         /**
             * Gets the tool call ID for the tool started event
             * @returns The tool call ID
@@ -8583,7 +8707,7 @@ export interface AssistantToolArgumentEventData extends AssistantBaseEventData {
     * Event class for tool call argument events
     */
 export class AIAssistantToolArgumentEvent extends AIAssistantBaseEvent<AssistantToolArgumentEventData> {
-        constructor(conversationId: string, messageId: string, patentMessageId: string, data: AssistantToolArgumentEventData);
+        constructor(conversationId: string, messageId: string, parentMessageId: string, data: AssistantToolArgumentEventData);
         /**
             * Gets the tool call ID for the tool argument event
             * @returns The tool call ID
@@ -8618,7 +8742,7 @@ export interface AssistantToolEndedEventData extends AssistantBaseEventData {
     * Event class for tool call ended events
     */
 export class AIAssistantToolEndedEvent extends AIAssistantBaseEvent<AssistantToolEndedEventData> {
-        constructor(conversationId: string, messageId: string, patentMessageId: string, data: AssistantToolEndedEventData);
+        constructor(conversationId: string, messageId: string, parentMessageId: string, data: AssistantToolEndedEventData);
         /**
             * Gets the tool call ID for the tool ended event
             * @returns The tool call ID
@@ -8650,7 +8774,7 @@ export interface AssistantToolResultEventData extends AssistantBaseEventData {
     * Event class for tool call result events
     */
 export class AIAssistantToolResultEvent extends AIAssistantBaseEvent<AssistantToolResultEventData> {
-        constructor(conversationId: string, messageId: string, patentMessageId: string, data: AssistantToolResultEventData);
+        constructor(conversationId: string, messageId: string, parentMessageId: string, data: AssistantToolResultEventData);
         /**
             * Gets the tool call ID for the tool result event
             * @returns The tool call ID
@@ -8682,4 +8806,3 @@ export class AIAssistantToolResultEvent extends AIAssistantBaseEvent<AssistantTo
             */
         setRole(role: string): void;
 }
-