@cometchat/chat-sdk-javascript 4.0.0-beta1

package/dist/javascript-chat-sdk/LICENSE.md

@@ -0,0 +1,3 @@
+Copyright (c) 2020 CometChat Inc.
+
+License agreement: https://www.cometchat.com/legal-terms-of-service

package/dist/javascript-chat-sdk/README.md

@@ -0,0 +1,189 @@
+<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 enables you to add voice, video & text chat for your website & app.
+This guide demonstrates how to add chat to a WebSite using CometChat.
+
+## 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.11-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 Javascript SDK<br/>
+
+```javascript
+	npm install @cometchat/chat-sdk-javascript@4.0.0-beta4 --save
+```
+</li>
+
+<li>
+<b>Import via CDN</b><br/>
+1. Include the CometChat Javascript library in your HTML code.<br/>
+
+```html
+  <script type="text/javascript" src="https://unpkg.com/@cometchat/chat-sdk-javascript@4.0.0-beta4/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 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/>

package/dist/javascript-chat-sdk/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@cometchat/chat-sdk-javascript",
+  "version": "4.0.0",
+  "description": "A complete chat solution.",
+  "main": "CometChat.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "CometChat",
+    "chat",
+    "messaging",
+    "chat",
+    "sdk",
+    "pro",
+    "message",
+    "sdk",
+    "messaging",
+    "sdk",
+    "audio",
+    "chat",
+    "video",
+    "chat",
+    "webRTC"
+  ],
+  "author": "CometChat",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cometchat-pro/javascript-chat-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cometchat-pro/javascript-chat-sdk/issues"
+  },
+  "homepage": "https://github.com/cometchat-pro/javascript-chat-sdk#readme"
+}

package/dist/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@cometchat-pro/chat",
+  "version": "3.0.12",
+  "description": "A complete chat solution.",
+  "main": "CometChat.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "CometChat",
+    "chat",
+    "messaging",
+    "chat",
+    "sdk",
+    "pro",
+    "message",
+    "sdk",
+    "messaging",
+    "sdk",
+    "audio",
+    "chat",
+    "video",
+    "chat",
+    "webRTC"
+  ],
+  "author": "CometChat",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cometchat-pro/javascript-chat-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cometchat-pro/javascript-chat-sdk/issues"
+  },
+  "homepage": "https://github.com/cometchat-pro/javascript-chat-sdk#readme"
+}

package/dist/type/index.d.ts

@@ -0,0 +1,10 @@
+import { CometChat as cometchat } from "./lib/CometChat";
+/**
+ *Initialises and returns the CometChat singleton object.
+ *
+ * @export
+ * @param {string} appId appId generted at the time of perchase. unique for each client.
+ * @returns {CometChat}
+ */
+export declare function init(appId: string): cometchat;
+export declare let CometChat: typeof cometchat;

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

@@ -0,0 +1,60 @@
+import { GroupMember } from './models/GroupMember';
+export declare class BannedMembersRequest {
+    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;
+    constructor(builder: BannedMembersRequestBuilder);
+    private validateBannedMembersBuilder;
+    /**
+     * Get list of next set of banned members based on the parameters specified in BannedMembersRequestBuilder class. The Developer need to call this method repeatedly using the same object of BannedMembersRequest class to get paginated list of banned members.
+     * @returns {Promise<GroupMember[] | []>}
+    */
+    fetchNext(): Promise<GroupMember[] | []>;
+    /**
+     * @internal
+     */
+    getNextData(): any;
+}
+export declare class BannedMembersRequestBuilder {
+    /** @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 banned members returned in a single iteration. A maximum of 100 banned 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 banned members are to be fetched.
+     * @returns
+    */
+    setSearchKeyword(searchKeyword: string): this;
+    /**
+     *
+     * @param {string[]} scopes
+     * A method to set the search banned members based on their scope.
+     * @returns
+    */
+    setScopes(scopes: Array<String>): this;
+    /**
+     * This method will return an object of the BannedMembersRequest class.
+     * @returns {BannedMembersRequest}
+    */
+    build(): BannedMembersRequest;
+}

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

@@ -0,0 +1,67 @@
+import { User } from './models/UserModel';
+export declare class BlockedUsersRequest {
+    private static MAX_LIMIT;
+    private static DEFAULT_LIMIT;
+    private limit;
+    private searchKeyword;
+    private next_page;
+    private current_page;
+    private total_pages;
+    private direction;
+    private fetchingInProgress;
+    static directions: {
+        BOTH: string;
+        HAS_BLOCKED_ME: string;
+        BLOCKED_BY_ME: string;
+    };
+    private pagination;
+    /**
+     * @private
+     * @param {BlockedUsersRequestBuilder} builder
+     */
+    constructor(builder?: BlockedUsersRequestBuilder);
+    private validateBlockedUsersBuilder;
+    /**
+     *
+     * Get list of next set of blocked users based on the parameters specified in BlockedUsersRequestBuilder class. The Developer need to call this method repeatedly using the same object of BlockedUsersRequest class to get paginated list of blocked users.
+     * @returns {Promise<User[] | []>}
+     */
+    fetchNext(): Promise<User[] | []>;
+    /** @internal */
+    getNextData(): any;
+}
+export declare class BlockedUsersRequestBuilder {
+    /** @private */ limit: number;
+    /** @private */ searchKeyword: string;
+    /** @private */ direction: string;
+    /**
+     *
+     * @param {number} limit
+     * A method to set limit for the number of blocked users returned in a single iteration. A maximum of 100 blocked users 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 blocked users are to be fetched.
+     * @returns
+    */
+    setSearchKeyword(searchKeyword: string): this;
+    /**
+     *
+     * @param direction
+     * A method to either fetch only users the logged-in user has blocked or the users who have blocked the logged-in user or both.
+     * @returns
+    */
+    setDirection(direction: string): this;
+    /** @internal */
+    blockedByMe(): this;
+    /** @internal */
+    hasBlockedMe(): this;
+    /**
+     * This method will return an object of the BlockedUsersRequest class.
+     * @returns {BlockedUsersRequest}
+    */
+    build(): BlockedUsersRequest;
+}