-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(lib): add license file and pn suffix (#129)
* feat(lib): add license file and pn suffix * feat(lib): pre-deploy fixes * PubNub SDK v0.1.0 release. * feat(lib): link readme file from root folder --------- Co-authored-by: PubNub Release Bot <[email protected]>
- Loading branch information
1 parent
15bf0fc
commit c4263f9
Showing
8 changed files
with
107 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| PubNub Real-time Cloud-Hosted Push API and Push Notification Client Frameworks | ||
| Copyright (c) 2023 PubNub Inc. | ||
| http://www.pubnub.com/ | ||
| http://www.pubnub.com/terms | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in | ||
| all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| THE SOFTWARE. | ||
|
|
||
| PubNub Real-time Cloud-Hosted Push API and Push Notification Client Frameworks | ||
| Copyright (c) 2023 PubNub Inc. | ||
| http://www.pubnub.com/ | ||
| http://www.pubnub.com/terms |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # PubNub JavaScript Chat SDK | ||
|
|
||
| Chat SDK offers a set of handy methods to create your own feature-rich chat or add a chat to your existing application. | ||
|
|
||
| ## Supported frameworks | ||
|
|
||
| Chat SDK is written in TypeScript and relies on the existing [JavaScript SDK](https://www.pubnub.com/docs/sdks/javascript). It's framework-agnostic and lets you build a chat app using any JavaScript-based framework, like: | ||
|
|
||
| - React | ||
| - React Native | ||
| - Vue | ||
| - Angular | ||
|
|
||
| ## Features | ||
|
|
||
| Chat SDK offers a wide range of features to build direct, group, and public chats. | ||
|
|
||
| Explore these documentation sections for details: | ||
|
|
||
| - **Channels** - manage [channels](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/create), [join](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/join) or [leave](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/leave) them, [invite](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/invite) other chat members, or [reference channel names](https://www.pubnub.com/docs/chat/chat-sdk/build/features/channels/references) in messages through hashtags. | ||
| - **Users** - manage [users](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/create), track user's [presence](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/presence), [mention](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/mentions) users, manage [permissions](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/permissions) or [report](https://www.pubnub.com/docs/chat/chat-sdk/build/features/users/moderation) users for misbehaving. | ||
| - **Messages** - manage [messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/send-receive), add [reactions](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/reactions), [forward](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/forwards) messages to others, [pin](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/pinned) them to channels, add [quotes](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/quote) or [links](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/links), create [threads](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/threads) or send [files](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/files), [report](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/moderation) offensive messages, or shows users how many messages they missed while they were offline through [unread messages](https://www.pubnub.com/docs/chat/chat-sdk/build/features/messages/unread). | ||
|
|
||
| Also, add [typing indicators](https://www.pubnub.com/docs/chat/chat-sdk/build/features/typing-indicator), [push notifications](/docs/chat/chat-sdk/build/features/push-notifications), and more. | ||
|
|
||
| ## Samples | ||
|
|
||
| Test our TypeScript sample chat apps created in various JavaScript frameworks: | ||
|
|
||
| | Source code | Framework | Description | | ||
| | :------------------------------------------------------------------------------------------ | :----------- | :--------------------------------------------------------------------------------------- | | ||
| | [Direct chat](https://github.com/pubnub/js-chat/tree/master/samples/getting-started) | React | Basic 1:1 support chat letting you exchange messages between a user and a support agent. | | ||
| | [Group chat](https://github.com/pubnub/js-chat/tree/master/samples/react-native-group-chat) | React Native | Feature-full group chat letting you test most of the features offered by the Chat SDK. | | ||
|
|
||
| ## Chat SDK docs | ||
|
|
||
| You'll find all the information about working with Chat SDK in the official [PubNub Chat SDK documentation](pubnub.com/docs/chat/chat-sdk/overview). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,8 @@ | ||
| { | ||
| "name": "@pubnub/chat", | ||
| "version": "1.0.0", | ||
| "version": "0.1.0", | ||
| "description": "PubNub JavaScript Chat SDK", | ||
| "author": "PubNub <[email protected]>", | ||
| "main": "dist/index.js", | ||
| "module": "dist/index.es.js", | ||
| "types": "dist/index.d.ts", | ||
|
|
@@ -11,6 +12,9 @@ | |
| "build": "rollup -c", | ||
| "dev": "tsc -w" | ||
| }, | ||
| "files": [ | ||
| "dist" | ||
| ], | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/pubnub/js-chat.git" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,30 @@ | ||
| import pkg from "./package.json" assert { type: 'json' }; | ||
| import pkg from "./package.json" assert { type: "json" } | ||
| import replace from "@rollup/plugin-replace" | ||
| import ts from "rollup-plugin-ts" | ||
| import terser from '@rollup/plugin-terser'; | ||
| import terser from "@rollup/plugin-terser" | ||
|
|
||
| export default [ | ||
| { | ||
| { | ||
| input: "./src/index.ts", | ||
| external: ["pubnub"], | ||
| output: [ | ||
| { | ||
| file: pkg.main, | ||
| format: "cjs", | ||
| }, | ||
| { | ||
| file: pkg.module, | ||
| format: "esm", | ||
| }, | ||
| { | ||
| file: pkg.main, | ||
| format: "cjs", | ||
| }, | ||
| { | ||
| file: pkg.module, | ||
| format: "esm", | ||
| }, | ||
| ], | ||
| plugins: [ | ||
| replace({ | ||
| preventAssignment: true, | ||
| __PLATFORM__: "CA-TS", | ||
| __VERSION__: pkg.version, | ||
| }), | ||
| ts(), | ||
| terser(), | ||
| replace({ | ||
| preventAssignment: true, | ||
| __PLATFORM__: "CA-TS", | ||
| __VERSION__: pkg.version, | ||
| }), | ||
| ts(), | ||
| terser(), | ||
| ], | ||
| }] | ||
| }, | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| { | ||
| "name": "js-chat", | ||
| "version": "0.0.1", | ||
| "private": true, | ||
| "workspaces": [ | ||
| "lib", | ||
|
|
||