@cometchat/chat-sdk-javascript 4.0.0-beta1 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/dist/CometChat.js +1 -1
  2. package/dist/index.d.ts +41 -0
  3. package/dist/type/lib/CometChat.d.ts +21 -0
  4. package/dist/type/lib/Constants.d.ts +20 -0
  5. package/dist/type/lib/Helper.d.ts +1 -0
  6. package/dist/type/lib/models/UserModel.d.ts +2 -0
  7. package/package.json +1 -1
  8. package/dist/.DS_Store +0 -0
  9. package/dist/javascript-chat-sdk/.git/COMMIT_EDITMSG +0 -1
  10. package/dist/javascript-chat-sdk/.git/FETCH_HEAD +0 -4
  11. package/dist/javascript-chat-sdk/.git/HEAD +0 -1
  12. package/dist/javascript-chat-sdk/.git/ORIG_HEAD +0 -1
  13. package/dist/javascript-chat-sdk/.git/config +0 -19
  14. package/dist/javascript-chat-sdk/.git/description +0 -1
  15. package/dist/javascript-chat-sdk/.git/hooks/applypatch-msg.sample +0 -15
  16. package/dist/javascript-chat-sdk/.git/hooks/commit-msg.sample +0 -24
  17. package/dist/javascript-chat-sdk/.git/hooks/fsmonitor-watchman.sample +0 -174
  18. package/dist/javascript-chat-sdk/.git/hooks/post-update.sample +0 -8
  19. package/dist/javascript-chat-sdk/.git/hooks/pre-applypatch.sample +0 -14
  20. package/dist/javascript-chat-sdk/.git/hooks/pre-commit.sample +0 -49
  21. package/dist/javascript-chat-sdk/.git/hooks/pre-merge-commit.sample +0 -13
  22. package/dist/javascript-chat-sdk/.git/hooks/pre-push.sample +0 -53
  23. package/dist/javascript-chat-sdk/.git/hooks/pre-rebase.sample +0 -169
  24. package/dist/javascript-chat-sdk/.git/hooks/pre-receive.sample +0 -24
  25. package/dist/javascript-chat-sdk/.git/hooks/prepare-commit-msg.sample +0 -42
  26. package/dist/javascript-chat-sdk/.git/hooks/push-to-checkout.sample +0 -78
  27. package/dist/javascript-chat-sdk/.git/hooks/update.sample +0 -128
  28. package/dist/javascript-chat-sdk/.git/index +0 -0
  29. package/dist/javascript-chat-sdk/.git/info/exclude +0 -6
  30. package/dist/javascript-chat-sdk/.git/logs/HEAD +0 -13
  31. package/dist/javascript-chat-sdk/.git/logs/refs/heads/master +0 -1
  32. package/dist/javascript-chat-sdk/.git/logs/refs/heads/master-v3 +0 -3
  33. package/dist/javascript-chat-sdk/.git/logs/refs/heads/master-v4 +0 -4
  34. package/dist/javascript-chat-sdk/.git/logs/refs/remotes/origin/HEAD +0 -1
  35. package/dist/javascript-chat-sdk/.git/logs/refs/remotes/origin/master-v3 +0 -2
  36. package/dist/javascript-chat-sdk/.git/logs/refs/remotes/origin/master-v4 +0 -2
  37. package/dist/javascript-chat-sdk/.git/logs/refs/stash +0 -1
  38. package/dist/javascript-chat-sdk/.git/objects/09/b9e17d9a0acd55c3644f4cfa19b1c40a139018 +0 -0
  39. package/dist/javascript-chat-sdk/.git/objects/0f/2d8999b370e8ddb236f767aa565b2aa72a6b21 +0 -0
  40. package/dist/javascript-chat-sdk/.git/objects/15/7f5161e31be14c74df7907c9c5046fbbea4461 +0 -0
  41. package/dist/javascript-chat-sdk/.git/objects/17/89200f3f5621f9df6d08d1071c59557ce5a29d +0 -0
  42. package/dist/javascript-chat-sdk/.git/objects/26/1de108a0253f54cf37e8a072f7f5f0098c7e89 +0 -4
  43. package/dist/javascript-chat-sdk/.git/objects/43/7ffc94a259dcd818cca308ab60a2780714092d +0 -1
  44. package/dist/javascript-chat-sdk/.git/objects/4e/6ab6a981ea6dccdb60b6438d7ca142aef269fc +0 -0
  45. package/dist/javascript-chat-sdk/.git/objects/5e/04a3d79cebcc2b02c14ea807f839ea73d44461 +0 -0
  46. package/dist/javascript-chat-sdk/.git/objects/65/bbff4d1cccc12285ea1c59a6f2082552f0d034 +0 -0
  47. package/dist/javascript-chat-sdk/.git/objects/6a/a6ef178cb2e3775bb149aba99ace8399525da6 +0 -0
  48. package/dist/javascript-chat-sdk/.git/objects/6b/e1ffe406de9ebb698ea891315b2b1459160029 +0 -0
  49. package/dist/javascript-chat-sdk/.git/objects/6b/efb8e9de892be7ecee5d39c30c0aa17d43d727 +0 -2
  50. package/dist/javascript-chat-sdk/.git/objects/6e/f136ca41bbb5684639947fa121b7eebb795592 +0 -0
  51. package/dist/javascript-chat-sdk/.git/objects/87/96f6311621c3ee4fc8d37eeec64a6c94e3e6ca +0 -0
  52. package/dist/javascript-chat-sdk/.git/objects/8b/2d226d44814b7265b68ab7953a87cd44d77965 +0 -0
  53. package/dist/javascript-chat-sdk/.git/objects/9c/bc4afb06153fd276e240e709984bf1099386ba +0 -0
  54. package/dist/javascript-chat-sdk/.git/objects/a9/6c6710dfb57871b6eccda3a94d83990ba94d9f +0 -0
  55. package/dist/javascript-chat-sdk/.git/objects/ad/1b70a4bb12b3fe2e6306d2b0922582036f4e42 +0 -0
  56. package/dist/javascript-chat-sdk/.git/objects/c1/655387f263ec50dbef8042099eead57dfe00c2 +0 -0
  57. package/dist/javascript-chat-sdk/.git/objects/e0/ad85d968302e5447402ed4d0bc8ace931b9167 +0 -0
  58. package/dist/javascript-chat-sdk/.git/objects/e8/0b03094191c92690d5bb92b4271058f188efd1 +0 -1
  59. package/dist/javascript-chat-sdk/.git/objects/f0/cc86624ec0504ed24dcd6a7b2cdee917b73395 +0 -2
  60. package/dist/javascript-chat-sdk/.git/objects/f9/95e0e3dc98868eb6404f8cdd84632ae140e1ff +0 -2
  61. package/dist/javascript-chat-sdk/.git/objects/fb/d9b82e03d33337a8d2606fc9e2f1652ffda3de +0 -0
  62. package/dist/javascript-chat-sdk/.git/objects/pack/pack-efd6261f29a0c404693064c4a255aada38ddab72.idx +0 -0
  63. package/dist/javascript-chat-sdk/.git/objects/pack/pack-efd6261f29a0c404693064c4a255aada38ddab72.pack +0 -0
  64. package/dist/javascript-chat-sdk/.git/packed-refs +0 -107
  65. package/dist/javascript-chat-sdk/.git/refs/heads/master +0 -1
  66. package/dist/javascript-chat-sdk/.git/refs/heads/master-v3 +0 -1
  67. package/dist/javascript-chat-sdk/.git/refs/heads/master-v4 +0 -1
  68. package/dist/javascript-chat-sdk/.git/refs/remotes/origin/HEAD +0 -1
  69. package/dist/javascript-chat-sdk/.git/refs/remotes/origin/master-v3 +0 -1
  70. package/dist/javascript-chat-sdk/.git/refs/remotes/origin/master-v4 +0 -1
  71. package/dist/javascript-chat-sdk/.git/refs/stash +0 -1
  72. package/dist/javascript-chat-sdk/.gitignore +0 -2
  73. package/dist/javascript-chat-sdk/CometChat.d.ts +0 -4732
  74. package/dist/javascript-chat-sdk/CometChat.js +0 -1
  75. package/dist/javascript-chat-sdk/LICENSE.md +0 -3
  76. package/dist/javascript-chat-sdk/README.md +0 -189
  77. package/dist/javascript-chat-sdk/package.json +0 -36
@@ -1,3 +0,0 @@
1
- Copyright (c) 2020 CometChat Inc.
2
-
3
- License agreement: https://www.cometchat.com/legal-terms-of-service
@@ -1,189 +0,0 @@
1
- <div style="width:100%">
2
- <div style="width:100%">
3
- <div style="width:50%; display:inline-block">
4
- <p align="center">
5
- <img style="text-align:center" width="180" height="180" alt="" src="https://avatars2.githubusercontent.com/u/45484907?s=200&v=4">
6
- </p>
7
- </div>
8
- </div>
9
- </br>
10
- </br>
11
- </div>
12
-
13
- # CometChat Javascript SDK
14
-
15
- CometChat enables you to add voice, video & text chat for your website & app.
16
- This guide demonstrates how to add chat to a WebSite using CometChat.
17
-
18
- ## Features
19
-
20
- <ul>
21
- <li> 1-1 & Group Conversations </li>
22
- <li> Voice & video calling & conferencing </li>
23
- <li> Rich Media Attachments </li>
24
- <li> Typing Indicators </li>
25
- <li> Custom Messages </li>
26
- <li> Read receipts </li>
27
- <li> Online Presence Indicators </li>
28
- <li> Message History </li>
29
- <li> Single Sign-on </li>
30
- <li> Webhooks </li>
31
- <li> Bots </li>
32
- <li> Users & Friends List </li>
33
- <li> Groups List </li>
34
- <li> Conversations List </li>
35
- <li> Threaded Conversations </li>
36
- </ul>
37
-
38
- ## Extensions
39
-
40
- [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)
41
-
42
- [![Platform](https://img.shields.io/badge/Platform-Javascript-brightgreen)](#)
43
- <a href=" "> <img src="https://img.shields.io/badge/Version-3.0.11-important" /></a>
44
- ![GitHub repo size](https://img.shields.io/github/repo-size/cometchat-pro/javascript-chat-sdk)
45
- ![GitHub contributors](https://img.shields.io/github/contributors/cometchat-pro/javascript-chat-sdk)
46
- ![GitHub stars](https://img.shields.io/github/stars/cometchat-pro/javascript-chat-sdk?style=social)
47
- ![Twitter Follow](https://img.shields.io/twitter/follow/cometchat?style=social)
48
- <hr/>
49
-
50
-
51
- ## Prerequisites :star:
52
- Before you begin, ensure you have met the following requirements:<br/>
53
- ✅ &nbsp; You have [`Visual Studio Code`](https://code.visualstudio.com/) or any other code editor installed in your machine.<br/>
54
- ✅ &nbsp; You have [`npm`](https://www.npmjs.com/get-npm) installed in your machine.<br/>
55
- ✅ &nbsp; You have read [CometChat Key Concepts](https://prodocs.cometchat.com/docs/concepts).<br/>
56
-
57
- <hr/>
58
-
59
- ## Installing CometChat Javascript SDK
60
- ## Setup :wrench:
61
-
62
- To setup Javascript SDK, you need to first register on CometChat Dashboard. [Click here to sign up](https://app.cometchat.com/login).
63
-
64
- ### i. Get your Application Keys :key:
65
-
66
- <a href="https://app.cometchat.io" target="_blank">Signup for CometChat</a> and then:
67
-
68
- 1. Create a new app: Click **Add App** option available → Enter App Name & other information → Create App
69
- 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**
70
- <img align="center" src="https://files.readme.io/4b771c5-qs_copy.jpg"/>
71
-
72
- <hr/>
73
-
74
- ### ii. Add the CometChat Dependency
75
- <ul>
76
- <li>
77
- <b>Install via NPM</b><br/>
78
- 1. Run the following command to install the CometChat Javascript SDK<br/>
79
-
80
- ```javascript
81
- npm install @cometchat/chat-sdk-javascript@4.0.0-beta4 --save
82
- ```
83
- </li>
84
-
85
- <li>
86
- <b>Import via CDN</b><br/>
87
- 1. Include the CometChat Javascript library in your HTML code.<br/>
88
-
89
- ```html
90
- <script type="text/javascript" src="https://unpkg.com/@cometchat/chat-sdk-javascript@4.0.0-beta4/CometChat.js"></script>
91
- ```
92
-
93
- You can refer to the below link for instructions on how to do so:<br/>
94
- [📝 Add CometChat Dependency](https://prodocs.cometchat.com/docs/js-quick-start#add-the-cometchat-dependency)
95
- </li>
96
- </ul>
97
- <hr/>
98
-
99
- ## Configure CometChat Javascript SDK
100
-
101
- ### i. Initialize CometChat 🌟
102
- We suggest you call the init() method on app startup, preferably in the index.js file.
103
-
104
- ```javascript
105
- var appID = "APP_ID";
106
- var region = "REGION";
107
- var appSetting = new CometChat.AppSettingsBuilder().subscribePresenceForAllUsers().setRegion(region).build();
108
- CometChat.init(appID, appSetting).then(
109
- () => {
110
- console.log("Initialization completed successfully");
111
- },
112
- error => {
113
- console.log("Initialization failed with error:", error);
114
- }
115
- );
116
- ```
117
-
118
- | :information_source: &nbsp; <b> Note: Make sure to replace `region` and `appID` with your credentials.</b> |
119
- |------------------------------------------------------------------------------------------------------------|
120
-
121
- ### ii. Create User 👤
122
- Once initialisation is successful, you will need to create a user. You need to use createUser() method to create user on the fly.
123
- ```javascript
124
- let authKey = "AUTH_KEY";
125
- var uid = "user1";
126
- var name = "Kevin";
127
-
128
- var user = new CometChat.User(uid);
129
-
130
- user.setName(name);
131
-
132
- CometChat.createUser(user, authKey).then(
133
- user => {
134
- console.log("user created", user);
135
- },error => {
136
- console.log("error", error);
137
- }
138
- );
139
- ```
140
- >:information_source: <b>Note: Make sure that UID and name are specified as these are mandatory fields to create a user.</b>
141
- <hr/>
142
-
143
- ### iii. Login User 👤
144
- Once you have created the user successfully, you will need to log the user into CometChat using the login() method.
145
- ```javascript
146
- var UID = "SUPERHERO1";
147
- var authKey = "AUTH_KEY";
148
-
149
- CometChat.getLoggedinUser().then(
150
- user => {
151
- if(!user){
152
- CometChat.login(UID, authKey).then(
153
- user => {
154
- console.log("Login Successful:", { user });
155
- },
156
- error => {
157
- console.log("Login failed with exception:", { error });
158
- }
159
- );
160
- }else{
161
- // User already logged in
162
- }
163
- }, error => {
164
- console.log("getLoggedinUser failed with exception:", { error });
165
- }
166
- );
167
- ```
168
-
169
- | :information_source: &nbsp; <b>Note - The login() method needs to be called only once. Also replace AUTH_KEY with your App Auth Key.</b> |
170
- |------------------------------------------------------------------------------------------------------------|
171
-
172
- <hr/>
173
-
174
- 📝 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.
175
-
176
- <hr/>
177
-
178
- ## Learn more about UI-Kit
179
- [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)
180
-
181
- ## Contributors :clap:
182
- Thanks to the following people who have contributed to this project:
183
- [👨‍💻 @ajaygajra](https://github.com/ajaygajra)
184
- [👨‍💻 @mayur-bhandari](https://github.com/mayur-bhandari)
185
- <hr/>
186
-
187
- ## Contact :mailbox:
188
- Contact us via real time support present in [CometChat Dashboard.](https://app.cometchat.io/)
189
- <hr/>
@@ -1,36 +0,0 @@
1
- {
2
- "name": "@cometchat/chat-sdk-javascript",
3
- "version": "4.0.0",
4
- "description": "A complete chat solution.",
5
- "main": "CometChat.js",
6
- "scripts": {
7
- "test": "echo \"Error: no test specified\" && exit 1"
8
- },
9
- "keywords": [
10
- "CometChat",
11
- "chat",
12
- "messaging",
13
- "chat",
14
- "sdk",
15
- "pro",
16
- "message",
17
- "sdk",
18
- "messaging",
19
- "sdk",
20
- "audio",
21
- "chat",
22
- "video",
23
- "chat",
24
- "webRTC"
25
- ],
26
- "author": "CometChat",
27
- "license": "SEE LICENSE IN LICENSE.md",
28
- "repository": {
29
- "type": "git",
30
- "url": "git+https://github.com/cometchat-pro/javascript-chat-sdk.git"
31
- },
32
- "bugs": {
33
- "url": "https://github.com/cometchat-pro/javascript-chat-sdk/issues"
34
- },
35
- "homepage": "https://github.com/cometchat-pro/javascript-chat-sdk#readme"
36
- }