@cometchat/chat-sdk-javascript 4.0.0-beta1

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

@@ -0,0 +1,142 @@
+import { User } from './models/UserModel';
+export declare class UsersRequest {
+    private limit;
+    private next_page;
+    private current_page;
+    private total_pages;
+    private static userStore;
+    private status;
+    private searchKeyword;
+    private hideBlockedUsers;
+    private friendsOnly;
+    private fetchingInProgress;
+    private role;
+    private roles;
+    private tags;
+    private withTags;
+    private UIDs;
+    private sortBy;
+    private sortOrder;
+    private searchIn;
+    private pagination;
+    static USER_STATUS: {
+        ONLINE: string;
+        OFFLINE: string;
+    };
+    private validateUserBuilder;
+    constructor(builder?: UsersRequestBuilder);
+    /**
+     * Get list of next set of users based on the parameters specified in UsersRequestBuilder class The Developer need to call this method repeatedly using the same object of UsersRequestBuilder class to get paginated list of users.
+     * @returns {Promise<User[] | []>}
+    */
+    fetchNext(): Promise<User[] | []>;
+    /**
+     * @internal
+     */
+    getNextData(): any;
+}
+export declare class UsersRequestBuilder {
+    /** @private */ limit: number;
+    /** @private */ status: string;
+    /** @private */ searchKeyword: string;
+    /** @private */ shouldHideBlockedUsers: boolean;
+    /** @private */ role: string;
+    /** @private */ roles: Array<String>;
+    /** @private */ tags: Array<String>;
+    /** @private */ showFriendsOnly: boolean;
+    /** @private */ showTags: boolean;
+    /** @private */ UIDs: Array<String>;
+    /** @private */ SortBy: string;
+    /** @private */ SortOrder: string;
+    /** @private */ SearchIn: Array<String>;
+    /**
+     * A method to set limit for the number of Users returned in a single iteration. A maximum of 100 users can fetched in a single iteration.
+     * @param {number} limit
+     * @returns
+    */
+    setLimit(limit: number): this;
+    /**
+     * A method to get the users belonging to a specific status.
+     * @param {string} status
+     * @returns
+    */
+    setStatus(status: string): this;
+    /**
+     * A method to set the search string based on which the users are to be fetched.
+     * @param {string} searchKeyword
+     * @returns
+    */
+    setSearchKeyword(searchKeyword: string): this;
+    /**
+     * Method to hide blocked users.
+     * @param {boolean} hideBlockedUsers
+     * @returns
+    */
+    hideBlockedUsers(hideBlockedUsers: boolean): this;
+    /**
+     * A method to get the users with the specified role.
+     * @param {string} role
+     * @returns
+    */
+    setRole(role: string): this;
+    /**
+     * A method to get the users with the specified roles.
+     * @param {string[]} role
+     * @returns
+    */
+    setRoles(roles: Array<String>): this;
+    /**
+     * A method to fetch only friends.
+     * @param {boolean} friendsOnly
+     * @returns
+    */
+    friendsOnly(friendsOnly: boolean): this;
+    /**
+     * A method to get the users with the specified tags.
+     * @param {string[]} tags
+     * @returns
+    */
+    setTags(tags: Array<String>): this;
+    /**
+     * A method to get the tags along with the other details of the users.
+     * @param {boolean} withTags
+     * @returns
+    */
+    withTags(withTags: boolean): this;
+    /**
+     * A method to get the users with the specified UIDs.
+     * @param {string[]} uids
+     * @returns
+    */
+    setUIDs(uids: Array<String>): this;
+    /**
+     * A method to get the users sorted by either `name` or `status`.
+     * It accepts a string as input.
+     * By default the SDK fetches users sorted by `status`.
+     * @param {string} sortBy
+     * @returns
+    */
+    sortBy(sortBy: string): this;
+    /**
+     * A method to get the users sorted either in `asc` or `desc` order.
+     * It accepts a string as input.
+     * By default the SDK fetches users sorted in `asc` order.
+     * @param {string} sortOrder
+     * @returns
+    */
+    sortByOrder(sortOrder: string): this;
+    /**
+     * A method to set which field the search string should be searched.
+     * It accepts an array of string as input.
+     * It can be `["name"]`, `["uid"]` or `["name", "uid"]`.
+     * By default the SDK searches the search string in `["name", "uid"]`.
+     * @param {string[]} searchIn
+     * @returns
+    */
+    searchIn(searchIn: Array<String>): this;
+    /**
+     * This method will return an object of the UsersRequest class.
+     * @returns {UsersRequest}
+    */
+    build(): UsersRequest;
+}

package/dist/type/lib/WebSockets/WSConnectionHelper.d.ts

@@ -0,0 +1,41 @@
+import { Action } from "../models/Action";
+import { BaseMessage } from "../models/BaseMessage";
+import { Call } from "../models/Call";
+import { CometChatAuthEvent } from "../models/CometChatAuthEvent";
+import { CometChatMessageEvent } from "../models/CometChatMessageEvent";
+import { CometChatPresenceEvent } from "../models/CometChatPresenceEvent";
+import { CometChatReceiptEvent } from "../models/CometChatReceiptEvent";
+import { CometChatTransientEvent } from "../models/CometChatTransientEvent";
+import { CometChatTypingEvent } from "../models/CometChatTypingEvent";
+export declare class WSConnectionHelper {
+    connection?: any;
+    private static pingTimer;
+    private static wsConnectionHelper;
+    static getInstance(): WSConnectionHelper;
+    WSLogin(jwt: any, callback: any): void;
+    onOpen(event: any, callback: any): void;
+    onClose(event: any, callback: any): void;
+    onMessage(event: any): void;
+    authenticateUser(jwt: any): void;
+    authResponseReceived(event: CometChatAuthEvent): void;
+    WSLogout(): void;
+    startPingingWS(): void;
+    listenForPong(): any;
+    clearPingTimer(): void;
+    sendOnlineEvent(): void;
+    sendOfflineEvent(): void;
+    startTypingIndicator(receiverId: string, receiverType: string, metadata: any): void;
+    pauseTypingIndicator(receiverId: string, receiverType: string, metadata: any): void;
+    markAsRead(receiverId: string, receiverType: string, messageId: string, senderId: string): void;
+    markAsDelivered(receiverId: string, receiverType: string, messageId: string, senderId: string): void;
+    sendTransientMessage(receiverId: string, receiverType: string, data: any): void;
+    publishTypingIndicator(cometchatEvent: CometChatTypingEvent): void;
+    publishReceipts(cometchatEvent: CometChatReceiptEvent): void;
+    publishPresence(cometchatEvent: CometChatPresenceEvent): void;
+    publishMessages(cometchatEvent: CometChatMessageEvent): void;
+    publishMessage(message: BaseMessage): void;
+    publishCallMessage(message: Call): void;
+    publishActionMessage(message: Action): void;
+    publishTransientMessage(cometchatEvent: CometChatTransientEvent): void;
+    getCometChatEventFromMessage(message: any): CometChatTypingEvent | CometChatReceiptEvent | CometChatAuthEvent | CometChatPresenceEvent | CometChatMessageEvent | CometChatTransientEvent;
+}

package/dist/type/lib/WebSockets/WSConstants.d.ts

@@ -0,0 +1,71 @@
+export declare const WS: {
+    protocol: string;
+};
+export declare const READY_STATE: {
+    CONNECTING: number;
+    OPEN: number;
+    CLOSING: number;
+    CLOSED: number;
+    INVALID_JWT: number;
+};
+export declare const LOGOUT_CODE = 1000;
+export declare const LOGOUT_REASON = "User logged out";
+export declare const TYPING_INDICATOR: {
+    TYPE: string;
+    ACTION: {
+        STARTED: string;
+        ENDED: string;
+    };
+};
+export declare const TRANSIENT_MESSAGE: {
+    TYPE: string;
+};
+export declare const RECEIPTS: {
+    TYPE: string;
+    ACTION: {
+        READ: string;
+        DELIVERED: string;
+    };
+    RECEIPT_TYPE: {
+        READ_RECEIPT: string;
+        DELIVERY_RECEIPT: string;
+    };
+};
+export declare const PRESENCE: {
+    TYPE: string;
+    ACTION: {
+        ONLINE: string;
+        AVAILABLE: string;
+        OFFLINE: string;
+    };
+};
+export declare const MESSAGE: {
+    TYPE: string;
+};
+export declare const AUTH: {
+    TYPE: string;
+};
+export declare const KEYS: {
+    TYPE: string;
+    ACTION: string;
+    APP_ID: string;
+    RECEIVER: string;
+    RECEIVER_TYPE: string;
+    DEVICE_ID: string;
+    BODY: string;
+    USER: string;
+    METADATA: string;
+    MESSAGE_ID: string;
+    TIMESTAMP: string;
+    STATUS: string;
+    CODE: string;
+    SENDER: string;
+    MESSAGE_SENDER: string;
+    PRESENCE_SUBSCRIPTION: string;
+    AUTH: string;
+    PING: string;
+    DATA: string;
+    PARAMS: string;
+    ACK: string;
+    PONG: string;
+};

package/dist/type/lib/WebSockets/WSHelper.d.ts

@@ -0,0 +1,3 @@
+export declare function checkConnection(connection: any): boolean;
+export declare function stringifyMessage(message: any): string;
+export declare function getWSURL(): any;

package/dist/type/lib/controllers/CallController.d.ts

@@ -0,0 +1,151 @@
+import { Call } from '../models/Call';
+import { UserCallListener, OngoingCallListener } from '../models/Listner';
+import { CallSettings } from '../CallSettings';
+import { MediaDevice } from '../models/MediaDevice';
+export declare class CallController {
+    /** @internal */
+    TAG: string;
+    /** @private */
+    static callController: CallController;
+    private static callListner;
+    private call;
+    private timer;
+    private CALL_NO_ANSWER_INTERVAL;
+    private view;
+    private static callScreen;
+    private static callSettings;
+    private isDev;
+    private static deviceList;
+    private constructor();
+    /** @internal */
+    getCallListner(): UserCallListener;
+    /** @internal */
+    setCallListner(callEventHandler: OngoingCallListener): void;
+    static getInstance(): CallController;
+    /**
+     * returns the ongoing call object or null|undefined
+     *
+     * @internal
+     * @returns {Call}
+     * @memberof CallController
+    */
+    getActiveCall(): Call;
+    /**
+     * Initialize the call.
+     *
+     * @internal
+     * @param {Call} call
+     * @returns
+     * @memberof CallController
+    */
+    initiateCall(call: Call): Promise<Call>;
+    /**
+     *End the onGoing call
+     *
+     * @internal
+     * @param {boolean} [isInternal]
+     * @memberof CallController
+     */
+    endCall(isInternal?: boolean): void;
+    /** @internal */
+    onCallStarted(call: Call): Promise<Call>;
+    /** @internal */
+    endCallSession(): void;
+    /** @internal */
+    private startCallTimer;
+    /** @internal */
+    private stopCallTimer;
+    /** @internal */
+    startCall(callsettings: CallSettings, view: HTMLElement): void;
+    /** @internal */
+    addListener(): void;
+    /** @internal */
+    removeListener(): void;
+    /** @internal */
+    handler(message: any): void;
+    private getCallUrl;
+    private static getAvailableDeviceArray;
+    private static getAvailableDeviceObject;
+    /**
+     * Method to get all the available audio input devices.
+     * @returns {MediaDevice[]}
+    */
+    getAudioInputDevices(): MediaDevice[];
+    /**
+     * Method to get all the available audio output devices.
+     * @returns {MediaDevice[]}
+    */
+    getAudioOutputDevices(): MediaDevice[];
+    /**
+     * Method to get all the available video input devices.
+     * @returns {MediaDevice[]}
+    */
+    getVideoInputDevices(): MediaDevice[];
+    /**
+     * Method to change the audio input devices.
+     * @param {string} deviceId
+     * @returns {MediaDevice[]}
+    */
+    setAudioInputDevice(deviceId: string): void;
+    /**
+     * Method to change the audio output devices.
+     * @param {string} deviceId
+     * @returns {MediaDevice[]}
+    */
+    setAudioOutputDevice(deviceId: string): void;
+    /**
+     * Method to change the video input devices.
+     * @param {string} deviceId
+     * @returns {MediaDevice[]}
+    */
+    setVideoInputDevice(deviceId: string): void;
+    /**
+     * Method to mute/unmute audio stream.
+     * @param {boolean} muteAudio
+    */
+    muteAudio(muteAudio: boolean): void;
+    /**
+     * Method to pause/unpause video stream.
+     * @param {boolean} pauseVideo
+    */
+    pauseVideo(pauseVideo: boolean): void;
+    /**
+     * Method to set mode.
+     * @param mode
+    */
+    setMode(mode: any): void;
+    /**
+     * Method to start screen share.
+    */
+    startScreenShare(): void;
+    /**
+     * Method to stop screen share.
+    */
+    stopScreenShare(): void;
+    /**
+     * Method to start call recording.
+    */
+    startRecording(): void;
+    /**
+     * Method to stop call recording.
+    */
+    stopRecording(): void;
+    /**
+     * Method to switch an audio call to video call.
+    */
+    switchToVideoCall(): void;
+    /**
+     * Method to open the virtual background settings.
+    */
+    openVirtualBackground(): void;
+    /**
+     * Method to set the background blur. This method takes number as input which decides the blur level of the background.
+    */
+    setBackgroundBlur(blurLevel: number): void;
+    /**
+     * Method to set the background image. This method takes either a URL or file Object & sets that image as the background.
+    */
+    setBackgroundImage(image: string | Object): void;
+    /** @internal */
+    endSession(): void;
+}

package/dist/type/lib/controllers/ConversationController.d.ts

@@ -0,0 +1,14 @@
+import { Conversation } from '../models/ConversationModel';
+import { User } from '../models/UserModel';
+import { TextMessage } from '../models/TextMessage';
+import { MediaMessage } from '../models/MediaMessage';
+import { CustomMessage } from '../models/CustomMessage';
+import { Group } from '../models/Group';
+export declare class ConversationController {
+    /**
+     *Takes JSONConversation format as an input and returs the CometChatConversation
+     *
+     * @param user
+     */
+    static trasformJSONConversation(conversationId: string, conversationType: string, lastMessage: TextMessage | MediaMessage | CustomMessage | any, conversationWith: User | Group, unreadMessageCount: number | any, tags: Array<String>): Conversation | any;
+}

package/dist/type/lib/controllers/GroupMemberController.d.ts

@@ -0,0 +1,10 @@
+import { GroupMember } from '../models/GroupMember';
+export declare class GroupMembersController {
+    /**
+     * Takes JSONUser format as an input and returs the CometChatUser.
+     * @param {*} groupMember
+     * @returns {(GroupMember | any)}
+     * @memberof GroupMembersController
+     */
+    static trasformJSONGroupMember(groupMember: any): GroupMember | any;
+}

package/dist/type/lib/controllers/GroupsController.d.ts

@@ -0,0 +1,9 @@
+import { Group } from '../models/Group';
+export declare class GroupsController {
+    /**
+     *Takes JSONGroup format as an input and returs the GroupObject
+     *
+     * @param user
+     */
+    static trasformJSONGroup(group: any): Group | any;
+}

package/dist/type/lib/controllers/MessageController.d.ts

@@ -0,0 +1,18 @@
+import { Message } from '../models/BaseMessage';
+import { MessageReceipt } from '../models/MessageReceipt';
+export declare class MessageController {
+    /**
+     *Takes JSONMessage format as an input and returs the Message|any
+     * @param {*} message
+     * @returns {(Message|any)}
+     * @memberof MessageController
+     */
+    static trasformJSONMessge(message: Object): Message | any;
+    /**
+     *Takes JSONMessage format as an input and returs the MessageReceipt[]
+     * @param {*} message
+     * @returns {MessageReceipt[]}
+     * @memberof MessageController
+     */
+    static getReceiptsFromJSON(message: Object): Promise<MessageReceipt[]>;
+}

package/dist/type/lib/controllers/TypingNotificationController.d.ts

@@ -0,0 +1,14 @@
+import { TypingIndicator } from '../models/TypingNotification';
+export declare class TypingNotificationController {
+    private static TYPING_STARTED_MAP;
+    private static TYPING_ENDED_MAP;
+    private static INCOMING_TYPING_STARTED_MAP;
+    static addTypingStarted(receiverId: string): void;
+    static removeTypingStarted(receiverId: string): void;
+    static getTypingStartedMap(receiverId?: string): number;
+    static addTypingEnded(receiverId: string): void;
+    static removeTypingEnded(receiverId: string): void;
+    static getTypingEndedMap(receiverId?: string): number;
+    static addIncomingTypingStarted(typingNotification: TypingIndicator): void;
+    static removeIncomingTypingStarted(typingNotification: TypingIndicator): void;
+}

package/dist/type/lib/controllers/UserAuthController.d.ts

@@ -0,0 +1,10 @@
+import { User } from "../models/UserModel";
+export declare class UserAuthController {
+    /**
+     * Function will authenticate user and will return promise which will eventually retuns user AuthId on successfull auth.
+     * @param {User} user accept the user object with uId field needed
+     * @returns Promise
+     * @memberof UserAuthController
+    */
+    static authenticateUser(user: User): Promise<boolean>;
+}

package/dist/type/lib/controllers/UsersController.d.ts

@@ -0,0 +1,9 @@
+import { User } from '../models/UserModel';
+export declare class UsersController {
+    /**
+     *Takes JSONUser format as an input and returs the CometChatUser
+     *
+     * @param user
+     */
+    static trasformJSONUser(user: any): User | any;
+}

package/dist/type/lib/localStore/KeyStore.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Wraper for local database.
+ *
+ * @export
+ * @class LocalStorage
+ */
+export declare class KeyStore {
+    private static KeyStore;
+    private keyStore;
+    private store?;
+    private constructor();
+    /**
+     * Returns the singleton instace of the class.
+     * @returns {UserStore}
+     * @memberof UserStore
+     */
+    static getInstance(): KeyStore;
+    /**
+     *set the data in local storage with provided key.
+     *
+     * @param {String} key key with the data is stored in localstorage
+     * @param {*} value value provide that will be serialized and stored.
+     * @memberof localStorage
+     */
+    set(key: string, value: any): any;
+    /**
+     * Delete the individual item from the storage
+     * @param key
+     */
+    remove(key: string): void;
+    /**
+     *gets the value from the localstorage and provides back to user.
+     *
+     * @param {string} key
+     * @memberof localStorage
+     */
+    get(key: string): Promise<Object>;
+    /**
+     *clear the user store.
+     *
+     * @returns
+     * @memberof UserStore
+     */
+    clearStore(): any;
+}

package/dist/type/lib/localStore/MessageListenerEventMaping.d.ts

@@ -0,0 +1,56 @@
+/**
+ *Wraper for local database. with store selector
+ *
+ * @export
+ * @class SettingsStore
+ */
+export declare class MessageListnerMaping {
+    private static settingsStore;
+    private settingsStore;
+    private store?;
+    private constructor();
+    /**
+     * Returns the singleton instace of the class.
+     * @returns {LocalStorage}
+     * @memberof LocalStorage
+     */
+    static getInstance(): MessageListnerMaping;
+    /**
+     *set the data in settingsStore with provided key.
+     *
+     * @param {String} key key with the data is stored in localstorage
+     * @param {*} value value provide that will be serialized and stored.
+     * @memberof localStorage
+     */
+    set(key: string, value: any): any;
+    /**
+     * Delete the individual item from the storage
+     * @param key
+     */
+    remove(key: string): void;
+    /**
+     *gets the value from the localstorage and provides back to user.
+     *
+     * @param {string} key
+     * @memberof localStorage
+     */
+    get(key: string): any;
+    /**
+     * Clear the settingsStore
+     */
+    clearStore(): any;
+    /**
+     * clears the current store if not provided.
+     *
+     * @param {String} [store]
+     * @memberof settingsStore
+     */
+    clear(store?: String): void;
+    /**
+     *Change the store
+     *
+     * @param {String} store change the store can be selected ant time.
+     * @memberof settingsStore
+     */
+    selectStore(store?: String): void;
+}

package/dist/type/lib/localStore/MessagesStore.d.ts

@@ -0,0 +1,72 @@
+/**
+ *Wraper for local database. with store selector
+ *
+ * @export
+ * @class LocalStorage
+ */
+export declare class MessagesStore {
+    private static MessagesStore;
+    messagesStore: any;
+    private store?;
+    private constructor();
+    /**
+     * Returns the singleton instace of the class.
+     * @returns {MessagesStore}
+     * @memberof MessagesStore
+     */
+    static getInstance(): MessagesStore;
+    /**
+     *set the data in local storage with provided key.
+     *
+     * @param {String} key key with the data is stored in localstorage
+     * @param {*} value value provide that will be serialized and stored.
+     * @memberof localStorage
+     */
+    set(key: string, value: any): any;
+    /**
+     * Delete the individual item from the storage
+     * @param key
+     */
+    remove(key: string): void;
+    /**
+     *gets the value from the localstorage and provides back to user.
+     *
+     * @param {string} key
+     * @memberof localStorage
+     */
+    get(key: string): any;
+    /**
+     *clear the message store
+     *
+     * @returns
+     * @memberof MessagesStore
+     */
+    clearStore(): Promise<unknown>;
+    /**
+     * gets the all messages from the database.
+     *
+     * @returns {Promise<any>}
+     * @memberof MessagesStore
+     */
+    getAllMessages(): Promise<Object>;
+    /**
+     * clears the current store if not provided.
+     *
+     * @param {String} [store]
+     * @memberof localStorage
+     */
+    clear(store?: String): void;
+    /**
+     *Change the store
+     *
+     * @param {String} store change the store can be selected ant time.
+     * @memberof localStorage
+     */
+    selectStore(store?: String): void;
+    /**
+     * Stores the bulk messages to localstorage for future use
+     *
+     * @param messages  accepts the message array and converts it to Object to store in database.
+     */
+    storeMessages(messages: any): boolean;
+}