@cometchat/chat-sdk-javascript 4.0.0-beta2 → 4.0.1

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

@@ -1,175 +0,0 @@
-/** @private */
-export interface UserObj {
-    uid: string;
-    name: string;
-    authToken: string;
-    avatar: string;
-    lastActiveAt: number;
-    link: string;
-    metadata: string;
-    role: string;
-    status: string;
-    statusMessage: string;
-    tags: Array<string>;
-    deactivatedAt: number;
-}
-/**
- * Implementation of UserObject
- */
-export declare class User {
-    private uid;
-    private name;
-    private authToken;
-    private avatar;
-    private lastActiveAt;
-    private link;
-    private metadata;
-    private role;
-    private status;
-    private statusMessage;
-    private hasBlockedMe;
-    private blockedByMe;
-    private tags;
-    private deactivatedAt;
-    /**
-     * Method to get UID of the user.
-     * @returns {string}
-    */
-    getUid(): string;
-    /**
-     * Method to set UID of the user.
-     * @param {string} uid
-    */
-    setUid(uid: string): void;
-    /**
-     * Method to get name of the user.
-     * @returns {string}
-    */
-    getName(): string;
-    /**
-     * Method to set name of the user.
-     * @param {string} name
-    */
-    setName(name: string): void;
-    /**
-     * Method to get authToken of the user.
-     * @returns {string}
-    */
-    getAuthToken(): string;
-    /**
-     * Method to set authToken of the user.
-     * @param {string} authToken
-    */
-    setAuthToken(authToken: string): void;
-    /**
-     * Method to get avatar of the user.
-     * @returns {string}
-    */
-    getAvatar(): string;
-    /**
-     * Method to set avatar of the user.
-     * @param {string} avatar
-    */
-    setAvatar(avatar: string): void;
-    /**
-     * Method to get last active at timestamp of the user.
-     * @returns {number}
-    */
-    getLastActiveAt(): number;
-    /**
-     * Method to set last active at timestamp of the user.
-     * @param {number} lastActiveAt
-    */
-    setLastActiveAt(lastActiveAt: number): void;
-    /**
-     * Method to get link of the user.
-     * @returns {string}
-    */
-    getLink(): string;
-    /**
-     * Method to set link of the user.
-     * @param {string} link
-    */
-    setLink(link: string): string;
-    /**
-     * Method to get metadata of the user.
-     * @returns {string}
-    */
-    getMetadata(): string;
-    /**
-     * Method to set metadata of the user.
-     * @param {string} metadata
-    */
-    setMetadata(metadata: string): void;
-    /**
-     * Method to get role of the user.
-     * @returns {string}
-    */
-    getRole(): string;
-    /**
-     * Method to set role of the user.
-     * @param {string} role
-    */
-    setRole(role: string): void;
-    /**
-     * Method to get status of the user.
-     * @returns {string}
-    */
-    getStatus(): string;
-    /**
-     * Method to set status of the user.
-     * @param {string} status
-    */
-    setStatus(status: string): void;
-    /**
-     * Method to get status message of the user.
-     * @returns {string}
-    */
-    getStatusMessage(): string;
-    /**
-     * Method to set status message of the user.
-     * @param {string} statusMessage
-    */
-    setStatusMessage(statusMessage: string): void;
-    setBlockedByMe(blockedByMe: boolean): void;
-    /**
-     * Method to know if the logged-in user has blocked the other user.
-     * @returns {boolean}
-    */
-    getBlockedByMe(): boolean;
-    setHasBlockedMe(hasBlockedMe: boolean): void;
-    /**
-     * Method to know if the logged-in user has been blocked by the other user.
-     * @returns {boolean}
-    */
-    getHasBlockedMe(): boolean;
-    /**
-     * Method to set tags of the user.
-     * @param {string[]} tags
-     */
-    setTags(tags: Array<string>): void;
-    /**
-     * Method to get tags of the user.
-     * @returns {string[]}
-    */
-    getTags(): Array<string>;
-    /**
-     * Method to set deactivatedAt timestamp of a user.
-     * @param {number} deactivatedAt
-    */
-    setDeactivatedAt(deactivatedAt: number): void;
-    /**
-     * Method to get deactivatedAt timestamp of a user.
-     * @returns {number}
-    */
-    getDeactivatedAt(): number;
-    constructor(...userObj: any[]);
-}
-/** @private */
-export declare class Me extends User {
-    private wsChannel;
-    private jwt;
-    constructor(userObj: UserObj | any);
-    getWsChannel(): any;
-    getJWT(): string;
-}

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

@@ -1,74 +0,0 @@
-export declare class Attachment {
-    private extension;
-    private mimeType;
-    private name;
-    private size;
-    private url;
-    constructor(file: Object);
-    /**
-     * Create the file object from the provided JSON Object.
-     * @private
-     * @param {Object} file
-     * @returns {FileObject}
-     * @memberof FileObject
-     */
-    createFileFromJSON(file: Object): Attachment;
-    /**
-     * Converts the FileObject to JSON Object.
-     * @private
-     * @param {FileObject} fileObject
-     * @returns {Object}
-     * @memberof FileObject
-     */
-    static toJSON(attachment: Attachment): Object;
-    /**
-     * Get extension of the file.
-     * @returns {string}
-    */
-    getExtension(): string;
-    /**
-     * Method to set extension of the file.
-     * @param {string} extension
-    */
-    setExtension(extension: string): void;
-    /**
-     * Get mime type of the file.
-     * @returns {string}
-    */
-    getMimeType(): string;
-    /**
-     * Method to set mimeType of the file.
-     * @param {string} mimeType
-    */
-    setMimeType(mimeType: string): void;
-    /**
-     * Get name of the file.
-     * @returns {string}
-    */
-    getName(): string;
-    /**
-     * Method to set name of the file.
-     * @param {string} name
-    */
-    setName(name: string): void;
-    /**
-     * Get size of the file.
-     * @returns {string}
-    */
-    getSize(): number;
-    /**
-     * Method to set size of the file.
-     * @param {string} name
-    */
-    setSize(size: number): void;
-    /**
-     * Get URL of the file.
-     * @returns {string}
-    */
-    getUrl(): string;
-    /**
-     * Method to set URL of the file.
-     * @param {string} name
-    */
-    setUrl(url: string): void;
-}

package/dist/type/lib/rest-api/EndPointUtils.d.ts

@@ -1,9 +0,0 @@
-/**
- *
- *
- * @export
- * @param {string} [endPointName=""]
- * @param {object} [params={}]
- * @returns
- */
-export declare function getEndPoint(endPointName?: string, params?: object): Promise<Object>;

package/dist/type/lib/rest-api/EndpointFactory.d.ts

@@ -1,28 +0,0 @@
-/**
- *Endpoint factory class which will give enpoint data to client.
- *
- * @export
- * @class EndpointFactory
- */
-export declare class EndpointFactory {
-    baseUrl: string;
-    apiVersion: string;
-    adminApiUrl: string;
-    adminApiVersion: string;
-    extensionApi: string;
-    prosodyApi: string;
-    wsApi: string;
-    /**
-     * FIXME: Need to use string templating.
-     */
-    /**
-     * User AuthToken generation Endpoints:
-     */
-    private uriEndpoints;
-    /**
-     *
-     * @param endpointName accepts enpoint name
-     * @returns enpoint object with type, headers,and expected data
-     */
-    getEndpointData(endpointName: string): Promise<Object>;
-}

package/dist/type/lib/rest-api/HttpHelper.d.ts

@@ -1,10 +0,0 @@
-/**
- * @export
- * @param {string} [endPointName=""]
- * @param {object} [params={}]
- * @param {*} [data={}]
- * @returns
- */
-export declare function makeApiCall(endPointName?: string, params?: object, data?: any, isFile?: boolean): any;
-export declare function makeAdminApiCall(endPointName?: string, params?: object, data?: any, isFile?: boolean): any;
-export declare function postData(url?: string, method?: string, data?: any, headers?: any, isFile?: boolean): any;

package/readme.md

@@ -1,189 +0,0 @@
-<div style="width:100%">
-<div style="width:100%">
-	<div style="width:50%; display:inline-block">
-		<p align="center">
-		<img style="text-align:center" width="180" height="180" alt="" src="https://avatars2.githubusercontent.com/u/45484907?s=200&v=4">	
-		</p>	
-	</div>	
-</div>
-</br>
-</br>
-</div>
-
-# CometChat Javascript SDK
-
-CometChat Pro enables you to add voice, video & text chat for your website & app.
-This guide demonstrates how to add chat to a WebSite using CometChat Pro.
-
-## Features
-
-<ul>
-<li> 1-1 & Group Conversations </li>
-<li> Voice & video calling & conferencing </li>
-<li> Rich Media Attachments </li>
-<li> Typing Indicators </li>
-<li> Custom Messages </li>
-<li> Read receipts </li>
-<li> Online Presence Indicators </li>
-<li> Message History </li>
-<li> Single Sign-on </li>
-<li> Webhooks </li>
-<li> Bots </li>
-<li> Users & Friends List </li>
-<li> Groups List </li>
-<li> Conversations List </li>
-<li> Threaded Conversations </li>
-</ul>
-
-## Extensions
-
-[Push Notification](https://prodocs.cometchat.com/docs/extensions-enhanced-push-notification) | [Email Notification](https://prodocs.cometchat.com/docs/extensions-email-notification) | [SMS Notification](https://prodocs.cometchat.com/docs/extensions-sms-notification) | [Thumbnail Generation](https://prodocs.cometchat.com/docs/extensions-thumbnail-generation) | [Link Preview](https://prodocs.cometchat.com/docs/extensions-link-preview) | [Rich Media Preview](https://prodocs.cometchat.com/docs/extensions-rich-media-preview) | [Voice Transcription](https://prodocs.cometchat.com/docs/extensions-voice-transcription) | [Smart Reply](https://prodocs.cometchat.com/docs/extensions-smart-reply) | [Message Translation](https://prodocs.cometchat.com/docs/extensions-message-translation) | [Emojis](https://prodocs.cometchat.com/docs/extensions-emojis) | [Polls](https://prodocs.cometchat.com/docs/extensions-polls) | [Reactions](https://prodocs.cometchat.com/docs/extensions-reactions) | [Stickers](https://prodocs.cometchat.com/docs/extensions-stickers) | [Video Broadcasting](https://prodocs.cometchat.com/docs/extensions-broadcast) | [Collaborative Documents](https://prodocs.cometchat.com/docs/extensions-collaborative-document) | [Collaborative Whiteboards](https://prodocs.cometchat.com/docs/extensions-collaborative-whiteboard) | [Data Masking Filter](https://prodocs.cometchat.com/docs/extensions-data-masking-filter) | [Profanity Filter](https://prodocs.cometchat.com/docs/extensions-profanity-filter) | [Image Moderation](https://prodocs.cometchat.com/docs/extensions-image-moderation)| [Sentiment Analysis](https://prodocs.cometchat.com/docs/extensions-sentiment-analysis) | [In-flight Message Moderation](https://prodocs.cometchat.com/docs/extensions-in-flight-message-moderation) | [Virus & Malware Scanner](https://prodocs.cometchat.com/docs/extensions-virus-malware-scanner) | [XSS Filter](https://prodocs.cometchat.com/docs/extensions-xss-filter)
-
-[![Platform](https://img.shields.io/badge/Platform-Javascript-brightgreen)](#)
-<a href=" "> <img src="https://img.shields.io/badge/Version-3.0.0-beta1-important" /></a>
-![GitHub repo size](https://img.shields.io/github/repo-size/cometchat-pro/javascript-chat-sdk)
-![GitHub contributors](https://img.shields.io/github/contributors/cometchat-pro/javascript-chat-sdk)
-![GitHub stars](https://img.shields.io/github/stars/cometchat-pro/javascript-chat-sdk?style=social)
-![Twitter Follow](https://img.shields.io/twitter/follow/cometchat?style=social)
-<hr/>
-
-
-## Prerequisites :star:
-Before you begin, ensure you have met the following requirements:<br/>
- ✅ &nbsp; You have [`Visual Studio Code`](https://code.visualstudio.com/) or any other code editor installed in your machine.<br/>
- ✅ &nbsp; You have [`npm`](https://www.npmjs.com/get-npm) installed in your machine.<br/>
- ✅ &nbsp; You have read [CometChat Key Concepts](https://prodocs.cometchat.com/docs/concepts).<br/>
-
-<hr/>
-
-## Installing CometChat Javascript SDK
-## Setup :wrench:
-
-To setup Javascript SDK, you  need to first register on CometChat Dashboard. [Click here to sign up](https://app.cometchat.com/login).
-
-### i. Get your Application Keys :key:
-
-<a href="https://app.cometchat.io" target="_blank">Signup for CometChat</a> and then:
-
-1. Create a new app: Click **Add App** option available  →  Enter App Name & other information  → Create App
-2. At the Top in **QuickStart** section you will find **Auth Key** & **App ID** or else you can head over to the **API & Auth Keys** section and note the **Auth Key** and **App ID**
-<img align="center" src="https://files.readme.io/4b771c5-qs_copy.jpg"/>
-
-<hr/>
-
-### ii. Add the CometChat Dependency
-<ul>
-<li>
-<b>Install via NPM</b><br/>
-1. Run the following command to install the CometChat Pro Javascript SDK<br/>
-
-```javascript
-	npm install @cometchat-pro/chat@3.0.0-beta1 --save
-```
-</li>
-
-<li>
-<b>Import via CDN</b><br/>
-1. Include the CometChat Pro Javascript library in your HTML code.<br/>
-
-```html
-  <script type="text/javascript" src="https://unpkg.com/@cometchat-pro/chat@3.0.0-beta1/CometChat.js"></script>
-```
-
- You can refer to the below link for instructions on how to do so:<br/>
-[📝 Add CometChat Dependency](https://prodocs.cometchat.com/docs/js-quick-start#add-the-cometchat-dependency)
-</li>
-</ul>
-<hr/>
-
-## Configure CometChat Javascript SDK
-
-### i. Initialize CometChat 🌟
-We suggest you call the init() method on app startup, preferably in the index.js file.
-
-```javascript
-var appID = "APP_ID";
-var region = "REGION";
-var appSetting = new CometChat.AppSettingsBuilder().subscribePresenceForAllUsers().setRegion(region).build();
-CometChat.init(appID, appSetting).then(
-  () => {
-    console.log("Initialization completed successfully");
-  },
-  error => {
-    console.log("Initialization failed with error:", error);
-  }
-);
-```
-
-| :information_source: &nbsp; <b> Note: Make sure to replace `region` and `appID` with your credentials.</b> |
-|------------------------------------------------------------------------------------------------------------|
-
-### ii. Create User 👤
-Once initialisation is successful, you will need to create a user. You need to use createUser() method to create user on the fly.
-```javascript
-let authKey = "AUTH_KEY";
-var uid = "user1";
-var name = "Kevin";
-
-var user = new CometChat.User(uid);
-
-user.setName(name);
-
-CometChat.createUser(user, authKey).then(
-  user => {
-    console.log("user created", user);
-  },error => {
-    console.log("error", error);
-  }
-);
-```
->:information_source: <b>Note: Make sure that UID and name are specified as these are mandatory fields to create a user.</b>
-<hr/>
-
-### iii. Login User 👤
-Once you have created the user successfully, you will need to log the user into CometChat using the login() method.
-```javascript
-var UID = "SUPERHERO1";
-var authKey = "AUTH_KEY";
-
-CometChat.getLoggedinUser().then(
-  user => {
-    if(!user){
-      CometChat.login(UID, authKey).then(
-        user => {
-          console.log("Login Successful:", { user });    
-        },
-        error => {
-          console.log("Login failed with exception:", { error });    
-        }
-      );
-    }else{
-      // User already logged in
-    }
-  }, error => {
-    console.log("getLoggedinUser failed with exception:", { error });
-  }
-);
-```
-
-| :information_source: &nbsp; <b>Note - The login() method needs to be called only once. Also replace AUTH_KEY with your App Auth Key.</b> |
-|------------------------------------------------------------------------------------------------------------|
-
-<hr/>
-
-📝 Please refer to our [Developer Documentation](https://prodocs.cometchat.com/docs/js-quick-start) for more information on how to configure the CometChat Pro SDK and implement various features using the same.
-
-<hr/>
-
-## Learn more about UI-Kit
-[Angular UI Kit](https://github.com/cometchat-pro/javascript-angular-chat-ui-kit) | [React UI Kit](https://github.com/cometchat-pro/javascript-react-chat-ui-kit) | [Vue UI Kit](https://github.com/cometchat-pro/javascript-vue-chat-ui-kit)
-
-## Contributors :clap:
-Thanks to the following people who have contributed to this project:
-[👨‍💻 @ajaygajra](https://github.com/ajaygajra)
-[👨‍💻 @mayur-bhandari](https://github.com/mayur-bhandari)
-<hr/>
-
-## Contact :mailbox:
-Contact us via real time support present in [CometChat Dashboard.](https://app.cometchat.io/)
-<hr/>