@cometchat/chat-sdk-javascript 4.0.0-beta1

package/dist/type/lib/ConversationRequest.d.ts

@@ -0,0 +1,89 @@
+import { Conversation } from './models/ConversationModel';
+export declare class ConversationsRequest {
+    private limit;
+    private next_page;
+    private current_page;
+    private total_pages;
+    private conversationType;
+    private fetchingInProgress;
+    private getUserAndGroupTags;
+    private tags;
+    private withTags;
+    private groupTags;
+    private userTags;
+    private pagination;
+    private validateConversationBuilder;
+    /**
+     * @private
+     * @param {ConversationsRequestBuilder} builder
+    */
+    constructor(builder?: ConversationsRequestBuilder);
+    /**
+     * Get list of next set of conversations based on the parameters specified in ConversationsRequestBuilder class. The Developer need to call this method repeatedly using the same object of ConversationsRequest class to get paginated list of conversations.
+     * @returns {Promise<Conversation[] | []>}
+    */
+    fetchNext(): Promise<Conversation[] | []>;
+    /**
+     * @internal
+     */
+    getNextData(): any;
+}
+export declare class ConversationsRequestBuilder {
+    /** @private */ conversationType: string;
+    /** @private */ limit: number;
+    /** @private */ getUserAndGroupTags: boolean;
+    /** @private */ tags: Array<String>;
+    /** @private */ WithTags: boolean;
+    /** @private */ groupTags: Array<String>;
+    /** @private */ userTags: Array<String>;
+    /**
+     *
+     * @param {number} limit
+     * A method to set limit for the number of Conversations returned in a single iteration. A maximum of 50 conversations can fetched in a single iteration.
+     * @returns
+    */
+    setLimit(limit: number): this;
+    /**
+     *
+     * @param {string} conversationType
+     * A method to set the conversation type. It can take once of the two values: 1. 'user' - to fetch only the user conversations. 2. 'group' - to fetch only the group conversations.
+     * @returns
+    */
+    setConversationType(conversationType: string): this;
+    /**
+     *
+     * @param {boolean} getUserAndGroupTags
+     * A method to fetch the user/group tags in the ConversationWith Object. The default value is false.
+     * @returns
+    */
+    withUserAndGroupTags(getUserAndGroupTags: boolean): this;
+    /**
+     * A method to get conversations with the specified tags.
+     * @param {Array<String>} tags
+     * @returns
+    */
+    setTags(tags: Array<String>): this;
+    /**
+     * A method to get the tags along with conversations.
+     * @param {boolean} withTags
+     * @returns
+    */
+    withTags(withTags: boolean): this;
+    /**
+     * A method to filter conversation list by group tags.
+     * @param {Array<String>} groupTags
+     * @returns
+    */
+    setGroupTags(groupTags: Array<String>): this;
+    /**
+     * A method to filter conversation list by user tags.
+     * @param {Array<String>} userTags
+     * @returns
+    */
+    setUserTags(userTags: Array<String>): this;
+    /**
+     * This method will return an object of the ConversationsRequest class.
+     * @returns {ConversationsRequest}
+    */
+    build(): ConversationsRequest;
+}

package/dist/type/lib/GroupMembersRequest.d.ts

@@ -0,0 +1,61 @@
+import { GroupMember } from './models/GroupMember';
+export declare class GroupMembersRequest {
+    private static MAX_LIMIT;
+    private static DEFAULT_LIMIT;
+    private limit;
+    private guid;
+    private cursor;
+    private total;
+    private searchKeyword;
+    private next_page;
+    private last_page;
+    private current_page;
+    private total_pages;
+    private scopes?;
+    private pagination;
+    private store;
+    constructor(builder: GroupMembersRequestBuilder);
+    private validateGroupMembersBuilder;
+    /**
+     * 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.
+     * @returns {Promise<GroupMember[] | []>}
+    */
+    fetchNext(): Promise<GroupMember[] | []>;
+    /**
+     * @internal
+     */
+    getNextData(): any;
+}
+export declare class GroupMembersRequestBuilder {
+    /** @private */ limit: number;
+    /** @private */ searchKeyword: string;
+    /** @private */ guid: string;
+    /** @private */ scopes?: Array<String>;
+    constructor(guid: string);
+    /**
+     *
+     * @param {number} limit
+     * A method to set limit for the number of group members returned in a single iteration. A maximum of 100 group members can fetched in a single iteration.
+     * @returns
+    */
+    setLimit(limit: number): this;
+    /**
+     *
+     * @param {string} searchKeyword
+     * A method to set the search string based on which the group members are to be fetched.
+     * @returns
+    */
+    setSearchKeyword(searchKeyword: string): this;
+    /**
+     *
+     * @param {string[]} scopes
+     * A method to set the search group members based on their scope.
+     * @returns
+    */
+    setScopes(scopes: Array<String>): this;
+    /**
+     * This method will return an object of the GroupMembersRequest class.
+     * @returns {GroupMembersRequest}
+    */
+    build(): GroupMembersRequest;
+}

package/dist/type/lib/GroupsRequest.d.ts

@@ -0,0 +1,78 @@
+import { Group } from './models/Group';
+export declare class GroupsRequest {
+    private static MAX_LIMIT;
+    private static DEFAULT_LIMIT;
+    private limit;
+    private cursor;
+    private total;
+    private searchKeyword;
+    private next_page;
+    private last_page;
+    private current_page;
+    private total_pages;
+    private hasJoined;
+    private tags;
+    private withTags;
+    private pagination;
+    private validateGroupBuilder;
+    constructor(builder?: GroupsRequestBuilder);
+    /**
+     * Get list of next set of groups based on the parameters specified in GroupsRequestBuilder class The Developer need to call this method repeatedly using the same object of GroupsRequest class to get paginated list of groups.
+     * @returns {Promise<Group[] | []>}
+    */
+    fetchNext(): Promise<Group[] | []>;
+    /**
+     * Create the pagination data to send with each request.
+     *
+     * @internal
+     * @returns {*}
+     * @memberof GroupsRequest
+    */
+    private getNextData;
+}
+export declare class GroupsRequestBuilder {
+    /** @private */ limit: number;
+    /** @private */ searchKeyword: string;
+    /** @private */ hasJoined: boolean;
+    /** @private */ tags: Array<String>;
+    /** @private */ showTags: boolean;
+    /**
+     *
+     * @param {number} limit
+     * A method to set limit for the number of Groups returned in a single iteration. A maximum of 100 groups can fetched in a single iteration.
+     * @returns
+    */
+    setLimit(limit: number): this;
+    /**
+     *
+     * @param {string} searchKeyword
+     * A method to set the search string based on which the groups are to be fetched.
+     * @returns
+    */
+    setSearchKeyword(searchKeyword: string): this;
+    /**
+     * A method to fetch only joined groups.
+     * @param {boolean} hasJoined
+     * @returns
+     */
+    joinedOnly(hasJoined: boolean): this;
+    /**
+     *
+     * @param {string[]} tags
+     * A method to set the tags based on which the groups are to be fetched.
+     * @returns
+    */
+    setTags(tags: Array<String>): this;
+    /**
+     *
+     * @param {boolean} withTags
+     * A method to get the tags along with the other details of the groups.
+     * @returns
+    */
+    withTags(withTags: boolean): this;
+    /**
+     * This method will return an object of the GroupsRequest class.
+     * @returns {GroupsRequest}
+    */
+    build(): GroupsRequest;
+}

package/dist/type/lib/Helper.d.ts

@@ -0,0 +1,46 @@
+import { CometChatException } from './models/CustomError';
+import { BaseMessage } from './models/BaseMessage';
+export declare function getChatHost(appSettings: Object): any;
+export declare function getJidHost(appSettings: Object): any;
+export declare function isObject(object: any): boolean;
+export declare function isTruthy($true: any): any;
+export declare function isFalsy($false: any): any;
+export declare function getOrdinalSuffix(number: number): string;
+export declare function format(fmt: any, ...args: any[]): any;
+export declare function createUidFromJid(jid: string): string;
+export declare class Logger {
+    static log(TAG: string, message: any): void;
+    static error(TAG: string, message: any): void;
+    static info(TAG: string, message: any): void;
+}
+export declare const getCurrentTime: () => number;
+/**
+ * returns the settings from localstorage if exists, else fetch from server and update local settings
+ *
+ * @export
+ * @returns promise.
+ */
+export declare function getAppSettings(): Promise<unknown>;
+/**
+ * get the updated settings from the server and replace in the localstorage.
+ *
+ * @export
+ * @returns
+ */
+export declare function getUpdatedSettings(): Promise<unknown>;
+export declare const isImage: (file: Blob) => boolean;
+export declare const isVideo: (file: Blob) => boolean;
+export declare const isAudio: (file: Blob) => boolean;
+export declare const validateScope: (scope: any) => CometChatException;
+export declare const validateUpdateGroup: (group: any) => CometChatException;
+export declare const validateJoinGroup: (group: any, type: any, password: any) => CometChatException;
+export declare const validateCreateGroup: (group: any) => CometChatException;
+export declare const validateId: (id: any, type: any) => CometChatException;
+export declare const validateHideMessagesFromBlockedUsers: (bool: any) => CometChatException;
+export declare const validateArray: (array: any, type: any) => CometChatException;
+export declare const validateMsgId: (msgId: any) => CometChatException;
+export declare const validateChatType: (type: any) => CometChatException;
+export declare const validateMessage: (message: any) => BaseMessage | CometChatException;
+export declare const validateCreateUser: (user: any) => CometChatException;
+export declare const validateUpdateUser: (user: any) => CometChatException;
+export declare const validateConversationType: (conversationType: any) => CometChatException;

package/dist/type/lib/ListenerHandlers.d.ts

@@ -0,0 +1,101 @@
+import { CallListener, CallsListener, ConnectionListener, WSConnectionListener, GroupListener, GroupsListener, LoginListener, UserLoginListener, MessageListener, MessagesListener, UserListener, UsersListener } from "./models/Listner";
+export declare class ListenerHandlers {
+    connectionHandlers?: WSConnectionListener[];
+    loginHandlers?: UserLoginListener[];
+    messageHandlers?: MessagesListener[];
+    userHandlers?: UsersListener[];
+    groupHandlers?: GroupsListener[];
+    callHandlers?: CallsListener[];
+    private static listenerHandlers;
+    static getInstance(): ListenerHandlers;
+    /**
+     * attaches the callback functions which will be acting as connection status listeners.
+     *
+     * @param {String} name name of the listener
+     * @param {Function} callback callback listener function.
+     * @memberof ListenerHandlers
+     */
+    addConnectionEventListener(name: string, connectionEventListener: ConnectionListener): void;
+    /**
+     * removing the callback functions which were acting as connection status listeners.
+     *
+     * @param {string} handler
+     * @memberof ListenerHandlers
+     */
+    removeConnectionEventListener(handler: string): void;
+    /**
+     * attaches the callback functions which will be acting as login progress listeners.
+     *
+     * @param {String} name name of the listener
+     * @param {Function} callback callback listener function.
+     * @memberof ListenerHandlers
+     */
+    addLoginEventListener(name: string, loginEventListener: LoginListener): void;
+    /**
+     * removing the callback functions which were acting as login progress listeners.
+     *
+     * @param {string} handler
+     * @memberof ListenerHandlers
+     */
+    removeLoginEventListener(handler: string): void;
+    /**
+     * attaches the callback functions which will be acting as incoming message listeners.
+     *
+     * @param {String} name name of the listener
+     * @param {Function} callback callback listener function.
+     * @memberof ListenerHandlers
+     */
+    addMessageEventListener(name: string, messageListener: MessageListener): void;
+    /**
+     * removing the callback functions which were acting as incoming message listeners.
+     *
+     * @param {string} handler
+     * @memberof ListenerHandlers
+     */
+    removeMessageEventListener(handler: string): void;
+    /**
+     * attaches the callback functions which will be acting as incoming user presence listeners.
+     *
+     * @param {String} name name of the listener
+     * @param {Function} callback callback listener function.
+     * @memberof ListenerHandlers
+     */
+    addUserEventListener(name: string, userEventListener: UserListener): void;
+    /**
+     * removing the callback functions which were acting as incoming user presence listeners.
+     *
+     * @param {string} handler
+     * @memberof ListenerHandlers
+     */
+    removeUserEventListener(handler: string): void;
+    /**
+     * attaches the callback functions which will be acting as incoming group action listeners.
+     *
+     * @param {String} name name of the listener
+     * @param {Function} callback callback listener function.
+     * @memberof ListenerHandlers
+     */
+    addGroupEventListener(name: string, groupListener: GroupListener): void;
+    /**
+     * removing the callback functions which were acting as incoming group action listeners.
+     *
+     * @param {string} handler
+     * @memberof ListenerHandlers
+     */
+    removeGroupEventListener(handler: string): void;
+    /**
+     * attaches the callback functions which will be acting as incoming call listeners.
+     *
+     * @param {String} name name of the listener
+     * @param {Function} callback callback listener function.
+     * @memberof ListenerHandlers
+     */
+    addCallEventListener(name: string, callListener: CallListener): void;
+    /**
+     * removing the callback functions which were acting as incoming call listeners.
+     *
+     * @param {string} handler
+     * @memberof ListenerHandlers
+     */
+    removeCallEventListener(handler: string): void;
+}

package/dist/type/lib/MessagesRequest.d.ts

@@ -0,0 +1,188 @@
+import { BaseMessage } from "./models/BaseMessage";
+export declare class MessagesRequest {
+    private limit?;
+    private uid?;
+    private guid?;
+    private parentMessageId?;
+    private timestamp?;
+    private id?;
+    private messageStore;
+    private affix;
+    private lastAffix;
+    private currentMethod;
+    private endpointName;
+    private listId;
+    private totalPages;
+    private unread;
+    private inProgress;
+    private hideMessagesFromBlockedUsers;
+    private searchKey?;
+    private updatedAt;
+    private onlyUpdates;
+    private paginationMeta;
+    private category?;
+    private categories?;
+    private type?;
+    private types?;
+    private tags?;
+    private WithTags?;
+    private hideReplies?;
+    private hideDeletedMessages;
+    constructor(builder?: MessagesRequestBuilder);
+    /**
+     * 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[] | []>}
+    */
+    fetchNext(): Promise<BaseMessage[] | []>;
+    /**
+     * Get list of previous 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[] | []>}
+    */
+    fetchPrevious(): Promise<BaseMessage[] | []>;
+    private makeAPICall;
+    private createEndpoint;
+    private makeData;
+    private getFilteredPreviousDataByReceiverId;
+    private getFilteredNextDataByReceiverId;
+}
+export declare class MessagesRequestBuilder {
+    /** @private */ limit?: number;
+    /** @private */ maxLimit: number;
+    /** @private */ uid?: string;
+    /** @private */ guid?: string;
+    /** @private */ parentMessageId?: number;
+    /** @private */ timestamp?: number;
+    /** @private */ id?: number;
+    /** @private */ unread?: boolean;
+    /** @private */ HideMessagesFromBlockedUsers?: boolean;
+    /** @private */ searchKey?: string;
+    /** @private */ updatedAt?: string;
+    /** @private */ onlyUpdate?: number;
+    /** @private */ category?: string;
+    /** @private */ categories?: Array<String>;
+    /** @private */ type?: string;
+    /** @private */ types?: Array<String>;
+    /** @private */ HideReplies?: boolean;
+    /** @private */ HideDeletedMessages?: boolean;
+    /** @private */ tags?: Array<String>;
+    /** @private */ WithTags?: 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
+     * @returns
+    */
+    setLimit(limit: number): this;
+    /**
+     * A method to set GUID of a Group to get messages of that particular group conversation.
+     * @param {string} guid
+     * @returns
+    */
+    setGUID(guid: string): this;
+    /**
+     * A method to set UID of a User to get messages of that particular user conversation.
+     * @param {string} uid
+     * @returns
+    */
+    setUID(uid: string): this;
+    /**
+     * A method to set parent message id to get messages of that particular thread.
+     * @param {number} parentMessageId
+     * @returns
+    */
+    setParentMessageId(parentMessageId: number): this;
+    /**
+     * A method to set timestamp to get messages before/after the specified timestamp.
+     * @param {number} timestamp
+     * @returns
+    */
+    setTimestamp(timestamp?: number): this;
+    /**
+     * A method to set message ID of a particular message to get messages before/after the specified message.
+     * @param {number} id
+     * @returns
+    */
+    setMessageId(id?: number): this;
+    /**
+     * A method to get only unread messages.
+     * @param {boolean} unread
+     * @returns
+    */
+    setUnread(unread?: boolean): this;
+    /**
+     * Method to set parameters to hide or show message from blocked users.
+     * @param {boolean} hideMessagesFromBlockedUsers
+     * @returns
+    */
+    hideMessagesFromBlockedUsers(hideMessagesFromBlockedUsers?: boolean): this;
+    /**
+     * A method to set the search string based on which the messages are to be fetched.
+     * @param {string} searchKey
+     * @returns
+    */
+    setSearchKeyword(searchKey: string): this;
+    /**
+     * A method set timestamp to get fetch messages updated/edited after that timestamp.
+     * @param {string} updatedAt
+     * @returns
+     */
+    setUpdatedAfter(updatedAt: string): this;
+    /**
+     * A method to get only edited/updated messages.
+     * @param {boolean} onlyUpdate
+     * @returns
+     */
+    updatesOnly(onlyUpdate: boolean): this;
+    /**
+     * A method to set parameter to get the messages belonging to a specific category.
+     * @param {string} category
+     * @returns
+    */
+    setCategory(category: string): this;
+    /**
+     * A method to set parameter to get the messages belonging to specific categories.
+     * @param {string[]} categories
+     * @returns
+    */
+    setCategories(categories: Array<String>): this;
+    /**
+     * A method to set parameter to get the messages belonging to a specific type.
+     * @param {string} type
+     * @returns
+    */
+    setType(type: string): this;
+    /**
+     * A method to set parameter to get the messages belonging to specific types.
+     * @param {string[]} types
+     * @returns
+    */
+    setTypes(types: Array<String>): this;
+    /**
+     * A method to hide message replies.
+     * @param {boolean} hideReplies
+     * @returns
+    */
+    hideReplies(hideReplies: boolean): this;
+    /**
+     * A method to hide deleted messages.
+     * @param {boolean} hideDeletedMessages
+     * @returns
+    */
+    hideDeletedMessages(hideDeletedMessages: boolean): this;
+    /**
+     * A method to set parameter to get the messages belonging to specific tags.
+     * @param {Array<String>} tags
+     * @returns
+    */
+    setTags(tags: Array<String>): this;
+    /**
+     * A method to get messages with tags.
+     * @param {boolean} withTags
+     * @returns
+    */
+    withTags(withTags: boolean): this;
+    /**
+     * This method will return an object of the MessagesRequest class.
+     * @returns {MessagesRequest}
+    */
+    build(): MessagesRequest;
+}