@cometchat/chat-sdk-javascript 4.0.0-beta1

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

@@ -0,0 +1,72 @@
+import { User } from "../models/UserModel";
+/**
+ * Wraper for local database. with store selector
+ *
+ * @export
+ * @class LocalStorage
+ */
+export declare class UserStore {
+    private static UserStore;
+    private userStore;
+    private store?;
+    private constructor();
+    /**
+     * Returns the singleton instace of the class.
+     * @returns {UserStore}
+     * @memberof UserStore
+     */
+    static getInstance(): UserStore;
+    /**
+     *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 user store.
+     *
+     * @returns
+     * @memberof UserStore
+     */
+    clearStore(): Promise<unknown>;
+    /**
+     * 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 users to user store for future use.
+     *
+     * @param messages  accepts the message array and converts it to Object to store in database.
+     */
+    storeUsers(users: User[]): boolean;
+    /**
+     * Stores the  user to user store for future use.
+     *
+     * @param messages  accepts the message array and converts it to Object to store in database.
+     */
+    storeUser(user: User): boolean;
+}

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

@@ -0,0 +1,61 @@
+/**
+ *Wraper for local database. with store selector
+ *
+ * @export
+ * @class LocalStorage
+ */
+export declare class LocalStorage {
+    private static localStorage;
+    private localStore;
+    private store?;
+    private constructor();
+    /**
+     * Returns the singleton instace of the class.
+     * @returns {LocalStorage}
+     * @memberof LocalStorage
+     */
+    static getInstance(): LocalStorage;
+    /**
+     *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;
+    /**
+     * Update the individual item in the storage
+     * @param key
+     */
+    update(key: string, value: any): void;
+    /**
+     *gets the value from the localstorage and provides back to user.
+     *
+     * @param {string} key
+     * @memberof localStorage
+     */
+    get(key: string): Promise<Object>;
+    /**
+     * Clear the local store.
+     */
+    clearStore(): Promise<unknown>;
+    /**
+     * 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;
+}

package/dist/type/lib/models/Action.d.ts

@@ -0,0 +1,159 @@
+/**
+ *
+ * @module Action
+ */
+import { BaseMessage, Message } from "./BaseMessage";
+import { Group } from "./Group";
+import { User } from "./UserModel";
+export declare class Action extends BaseMessage implements Message {
+    static readonly TYPE: {
+        TEXT: string;
+        MEDIA: string;
+        IMAGE: string;
+        VIDEO: string;
+        AUDIO: string;
+        FILE: string;
+        CUSTOM: string;
+    };
+    static readonly RECEIVER_TYPE: {
+        USER: string;
+        GROUP: string;
+    };
+    static readonly CATEGORY: {
+        MESSAGE: string;
+        ACTION: string;
+        CALL: string;
+        CUSTOM: string;
+    };
+    static readonly ACTION_TYPE: {
+        TYPE_MEMBER_JOINED: string;
+        TYPE_MEMBER_LEFT: string;
+        TYPE_MEMBER_KICKED: string;
+        TYPE_MEMBER_BANNED: string;
+        TYPE_MEMBER_UNBANNED: string;
+        TYPE_MEMBER_INVITED: string;
+        TYPE_MEMBER_SCOPE_CHANGED: string;
+        TYPE_MESSAGE: string;
+        TYPE_MESSAGE_EDITED: string;
+        TYPE_MESSAGE_DELETED: string;
+        TYPE_MEMBER_ADDED: string;
+    };
+    private data?;
+    protected actionBy: User | Group | BaseMessage;
+    protected actionFor: User | Group | BaseMessage;
+    protected actionOn: User | Group | BaseMessage;
+    protected message: string;
+    protected rawData: any;
+    protected action: string;
+    protected oldScope: string;
+    protected newScope: string;
+    /**
+     * @internal
+    */
+    static actionFromJSON(rawMessage: any): Action | Message;
+    /**
+     * Method to get old scope of a member.
+     * @returns {string}
+    */
+    getOldScope(): string;
+    /**
+     * @param {string} oldScope
+     * Method to set old scope of a member.
+    */
+    setOldScope(oldScope: string): void;
+    /**
+     * Method to get new scope of a member.
+     * @returns {string}
+    */
+    getNewScope(): string;
+    /**
+     * @param {string} newScope
+     * Method to set new scope of a member.
+    */
+    setNewScope(newScope: string): void;
+    /**
+     * Method to get raw JSON data in string.
+     * @returns {string}
+    */
+    getRawData(): any;
+    /**
+     * @param {any} rawData
+     * Method to set raw JSON data.
+    */
+    setRawData(rawData: any): void;
+    /**
+     * Method to get the default action message.
+     * @returns {string}
+    */
+    getMessage(): string;
+    /**
+     * @param {string} message
+     * Method to set the default action message.
+    */
+    setMessage(message: string): void;
+    /**
+     * Method to get the action which is being performed.
+     * @returns {string}
+    */
+    getAction(): string;
+    /**
+     * @param {string} action
+     * Method to set the default action message.
+    */
+    setAction(action: string): void;
+    /**
+     * Method to get the sender of the action message.
+     * @returns {string}
+    */
+    getSender(): User;
+    /**
+     * Method to get the entity which performed the action.
+     * @returns {User | Group | BaseMessage}
+    */
+    getActionBy(): User | Group | BaseMessage;
+    /**
+     * @param {User | Group | BaseMessage} by
+     * Method to set the entity which performed the action.
+    */
+    setActionBy(by: User | Group | BaseMessage): void;
+    /**
+     * Method to get the entity on which the action was performed.
+     * @returns {User | Group | BaseMessage}
+    */
+    getActionOn(): User | Group | BaseMessage;
+    /**
+     * @param {User | Group | BaseMessage} on
+     * Method to set the entity on which the action was performed.
+    */
+    setActionOn(on: User | Group | BaseMessage): void;
+    /**
+     * Method to get the entity for whom the action was performed.
+     * @returns {User | Group | BaseMessage | any}
+    */
+    getActionFor(): User | Group | BaseMessage | any;
+    /**
+     * @param {User | Group | BaseMessage} for
+     * Method to set the entity for whom the action was performed.
+    */
+    setActionFor(actionFor: User | Group | BaseMessage): void;
+    /**
+     * Method to get the metadata of the action message.
+     * @returns {any}
+    */
+    getMetadata(): any;
+    /**
+     * @param {any} metadata
+     * Method to get the metadata of the action message.
+    */
+    setMetadata(metadata: any): void;
+    /**
+     * Private method to generate the message sting to provide the message to user.
+     *
+     * @private
+     * @param {Action} action
+     * @returns {string}
+     * @memberof Action
+     */
+    private getActionMessage;
+    private getSenderFromData;
+}

package/dist/type/lib/models/AppSettings.d.ts

@@ -0,0 +1,135 @@
+export declare class AppSettings {
+    static SUBSCRIPTION_TYPE_NONE: string;
+    static SUBSCRIPTION_TYPE_ALL_USERS: string;
+    static SUBSCRIPTION_TYPE_ROLES: string;
+    static SUBSCRIPTION_TYPE_FRIENDS: string;
+    /** @private */
+    static REGION_EU: string;
+    /** @private */
+    static REGION_US: string;
+    /** @private */
+    static REGION_IN: string;
+    /** @private */
+    static REGION_PRIVATE: string;
+    /** @private */
+    subscriptionType: string;
+    /** @private */
+    roles: string[];
+    /** @private */
+    region: string;
+    /** @private */
+    autoJoinGroup: boolean;
+    /** @private */
+    establishSocketConnection: boolean;
+    /** @private */
+    adminHost: string;
+    /** @private */
+    clientHost: string;
+    /**
+     * @private
+     * @param {AppSettingsBuilder}
+    */
+    constructor(builder: AppSettingsBuilder);
+    /**
+     * This method returns the subscription type set using one of the following methods of the AppSettingsBuilder `subscribePresenceForAllUsers()`, `subscribePresenceForRoles()` or `subscribePresenceForFriends()`.
+     * @returns {string}
+    */
+    getSubscriptionType(): string;
+    /**
+     * This method returns the roles set using the `setRoles()` of the AppSettingsBuilder.
+     * @returns {string[]}
+    */
+    getRoles(): string[];
+    /**
+     * This method returns the region set using the `setRegion()` of the AppSettingsBuilder.
+     * @returns {string}
+    */
+    getRegion(): string;
+    /**
+     * This method returns whether auto joining of group was enabled or not using the `enableAutoJoinForGroups()` of the AppSettingsBuilder.
+     * @returns {boolean}
+    */
+    getIsAutoJoinEnabled(): boolean;
+    /**
+     * This method returns whether the SDK should connect to WebSocket server when a user logs-in or not.
+     * @returns {boolean}
+    */
+    shouldAutoEstablishSocketConnection(): boolean;
+    /**
+     * This method returns the admin host to which the SDK should connect.
+     * @returns {boolean}
+    */
+    getAdminHost(): string;
+    /**
+     * This method returns the client host to which the SDK should connect.
+     * @returns {boolean}
+    */
+    getClientHost(): string;
+}
+export declare class AppSettingsBuilder {
+    /** @private */
+    subscriptionType: string;
+    /** @private */
+    roles: string[];
+    /** @private */
+    region: string;
+    /** @private */
+    autoJoinGroup: boolean;
+    /** @private */
+    establishSocketConnection: boolean;
+    /** @private */
+    adminHost: string;
+    /** @private */
+    clientHost: string;
+    /**
+     * A method to subscribe presence for all users.
+     * @returns
+    */
+    subscribePresenceForAllUsers(): this;
+    /**
+     * @param {string[]} roles
+     * A method to subscribe presence for all roles.
+     * @returns
+    */
+    subscribePresenceForRoles(roles: string[]): this;
+    /**
+     * A method to subscribe presence for friends.
+     * @returns
+    */
+    subscribePresenceForFriends(): this;
+    /**
+     * @param {string} region
+     * A method to set region of the app.
+     * @returns
+    */
+    setRegion(region?: string): this;
+    /**
+     * @param {boolean} isAutoJoinEnabled
+     * A method to enable/disable auto joining group. The default value is true.
+     * @returns
+    */
+    enableAutoJoinForGroups(isAutoJoinEnabled?: boolean): this;
+    /**
+     * @param {boolean} establishSocketConnection
+     * A method to auto connect to WebSocket server when a user logs-in. The default value is true.
+     * @returns
+    */
+    autoEstablishSocketConnection(establishSocketConnection?: boolean): this;
+    /**
+     * @param {string} adminHost
+     * This method is used to override the admin host which the SDK uses to make an API call.
+     * @returns
+    */
+    overrideAdminHost(adminHost: string): this;
+    /**
+     * @param {string} clientHost
+     * This method is used to override the client host which the SDK uses to make an API call.
+     * @returns
+    */
+    overrideClientHost(clientHost: string): this;
+    /**
+     * This method will return an object of the AppSettings class.
+     * @returns {AppSettings}
+    */
+    build(): AppSettings;
+}

package/dist/type/lib/models/BaseMessage.d.ts

@@ -0,0 +1,259 @@
+/**
+ *
+ * @module BaseMessage
+ */
+import { MessageCategory } from "../Constants";
+import { User } from "./UserModel";
+import { MessageReceipt } from './MessageReceipt';
+import { Group } from "./Group";
+export interface Message {
+}
+/**
+ *Basic Message Object
+ *
+ * @export
+ * @class BaseMessage
+ */
+export declare class BaseMessage implements Message {
+    protected id?: number;
+    protected conversationId?: string;
+    protected parentMessageId?: number;
+    protected muid?: string;
+    protected sender?: User;
+    protected receiverId?: string;
+    protected receiver?: User | Group;
+    protected type?: string;
+    protected category?: MessageCategory;
+    protected receiverType?: string;
+    protected sentAt?: number;
+    protected deliveredAt?: number;
+    protected readAt?: number;
+    protected deliveredToMeAt?: number;
+    protected readByMeAt?: number;
+    protected metadata: Object;
+    protected status?: string;
+    protected receipts?: any[];
+    protected readReceipts?: MessageReceipt[];
+    protected deliveryReceipts?: MessageReceipt[];
+    protected editedAt: number;
+    protected editedBy: string;
+    protected deletedAt: number;
+    protected deletedBy: string;
+    protected replyCount: number;
+    protected rawMessage: Object;
+    constructor(receiverId: string, messageType: string, receiverType: string, category: MessageCategory);
+    /**
+     * Get ID of the message
+     * @returns {number}
+    */
+    getId(): number;
+    /**
+     * @param {number} value
+     * Set ID of the message
+    */
+    setId(value: number): void;
+    /**
+     * Get conversation ID of the message.
+     * @returns {string}
+    */
+    getConversationId(): string;
+    /**
+     * @param {string} value
+     * Set conversation ID of the message.
+    */
+    setConversationId(value: string): void;
+    /**
+     * Get parent message ID of the message.
+     * @returns {number}
+    */
+    getParentMessageId(): number;
+    /**
+     * @param {number} value
+     * Set parent message ID of the message.
+    */
+    setParentMessageId(value: number): void;
+    /**
+     * Get MUID of the message.
+     * @returns {string}
+    */
+    getMuid(): string;
+    /**
+     * @param {string} value
+     * Sets the MUID of the message.
+    */
+    setMuid(value: string): void;
+    /**
+     * Get sender of the message.
+     * @returns {User}
+    */
+    getSender(): User;
+    /**
+     * @param {User} value
+     * Set sender of the message.
+    */
+    setSender(value: User): void;
+    /**
+     * Get receiver of the message.
+     * @returns {User | Group}
+    */
+    getReceiver(): User | Group;
+    /**
+     * @param {User | Group} value
+     * Set receiver of the message.
+    */
+    setReceiver(value: User | Group): void;
+    /**
+     * Get receiverID of the message.
+     * @returns {string}
+    */
+    getReceiverId(): string;
+    /**
+     * @param {string} value
+     * Set receiverId of the message.
+    */
+    setReceiverId(value: string): void;
+    /**
+     * Get type of the message.
+     * @returns {string}
+    */
+    getType(): string;
+    /**
+     * @param {string} value
+     * Set type of the message.
+    */
+    setType(value: string): void;
+    /**
+     * Get receiver type of the message.
+     * @returns {string}
+    */
+    getReceiverType(): string;
+    /**
+     * @param {string} value
+     * Set the receiver type of the message.
+    */
+    setReceiverType(value: string): void;
+    /**
+     * Get message's sentAt timestamp.
+     * @returns {number}
+    */
+    getSentAt(): number;
+    /**
+     * @param {number} value
+     * Set message's sentAt timestamp.
+    */
+    setSentAt(value: number): void;
+    /** @private */
+    getStatus(): string;
+    /** @private */
+    setStatus(value: string): void;
+    /**
+     * Get delivery timestamp of the message.
+     * @returns {number}
+    */
+    getDeliveredAt(): number;
+    /**
+     * @param {number} deliveredAt
+     * Set delivery timestamp of the message.
+    */
+    setDeliveredAt(deliveredAt: number): void;
+    /**
+     * Get timestamp of the message at which it was delivered to logged in user.
+     * @returns {number}
+    */
+    getDeliveredToMeAt(): number;
+    /**
+     * @param {number} deliveredToMeAt
+     * Set timestamp of the message at which it was delivered to logged in user.
+    */
+    setDeliveredToMeAt(deliveredToMeAt: number): void;
+    /**
+     * Get Timestamp of the when message was read at.
+     * @returns
+     */
+    getReadAt(): number;
+    /**
+     * @param {number} readAt
+     * Set read timestamp of the message.
+    */
+    setReadAt(readAt: number): void;
+    /**
+     * Get timestamp of the message at which it was read by the logged in user.
+     * @returns {number}
+    */
+    getReadByMeAt(): number;
+    /**
+     * @param {number} readByMeAt
+     * Set timestamp of the message at which it was read by the logged in user.
+    */
+    setReadByMeAt(readByMeAt: number): void;
+    /**
+     * Get category of the message.
+     * @returns {string}
+    */
+    getCategory(): MessageCategory;
+    /**
+     * @param {string} category
+     * Set category of the message.
+    */
+    setCategory(category: MessageCategory): void;
+    /**
+     * Get timestamp of the message when it was updated/edited.
+     * @returns
+    */
+    getEditedAt(): number;
+    /**
+     * @param {number} editedAt
+     * Set timestamp of the message when it was updated/edited.
+    */
+    setEditedAt(editedAt: number): void;
+    /**
+     * Get UID of the user who edited/updated the message.
+     * @returns
+    */
+    getEditedBy(): string;
+    /**
+     * @param {string} editedBy
+     * Set UID of the user who edited/updated the message.
+    */
+    setEditedBy(editedBy: string): void;
+    /**
+     * Get timestamp of the message when it was deleted.
+     * @returns {number}
+    */
+    getDeletedAt(): number;
+    /**
+     * @param {number} deletedAt
+     * Set timestamp of the message when it was deleted.
+    */
+    setDeletedAt(deletedAt: number): void;
+    /**
+     * Get UID of the user who deleted the message.
+     * @returns {number}
+    */
+    getDeletedBy(): string;
+    /**
+     * @param {string} deletedBy
+     * Set UID of the user who deleted the message.
+    */
+    setDeletedBy(deletedBy: string): void;
+    /**
+     * Get the number of replies of the message.
+     * @returns {number}
+     */
+    getReplyCount(): number;
+    /**
+     * @param {number} value
+     * Set the number of replies of the message.
+    */
+    setReplyCount(value: number): void;
+    /**
+     * Get the raw JSON of the message.
+     * @returns
+     */
+    getRawMessage(): Object;
+    /**
+     * @param {Object} rawMessage
+     * Set the raw JSON of the message.
+    */
+    setRawMessage(rawMessage: Object): void;
+}

package/dist/type/lib/models/CCExtension.d.ts

@@ -0,0 +1,15 @@
+export declare class CCExtension {
+    private id;
+    private name;
+    constructor(extension: any);
+    /**
+     * This method returns the id of the extension.
+     * @returns {string}
+    */
+    getId(): string;
+    /**
+     * This method returns the name of the extension.
+     * @returns {string}
+     */
+    getName(): string;
+}