react-peer-chat 0.5.0 → 0.5.2

package/README.md

@@ -33,7 +33,7 @@ It also exports a `clearChat` function that clears the text chat whenever invoke
 ```jsx
 import React from 'react';
 import Chat, { clearChat } from 'react-peer-chat';
-import 'react-peer-chat/build/styles.css';
+import 'react-peer-chat/dist/styles.css';
 
 export default function App() {
     return <div>
@@ -51,7 +51,7 @@ export default function App() {
 ```jsx
 import React from 'react';
 import Chat, { clearChat } from 'react-peer-chat';
-import 'react-peer-chat/build/styles.css';
+import 'react-peer-chat/dist/styles.css';
 
 export default function App() {
     return <div>
@@ -70,7 +70,7 @@ Use props provided by `<Chat>` component to customize it.
 ```jsx
 import React from 'react';
 import Chat from 'react-peer-chat';
-import 'react-peer-chat/build/styles.css';
+import 'react-peer-chat/dist/styles.css';
 
 export default function App() {
     return <Chat 
@@ -92,7 +92,7 @@ Use Function as Children(FoC) to fully customize the `<Chat>` component.
 ```jsx
 import React from 'react'
 import Chat from 'react-peer-chat'
-// import 'react-peer-chat/build/styles.css' (No need to import CSS when using custom component)
+// import 'react-peer-chat/dist/styles.css' (No need to import CSS when using custom component)
 
 export default function App() {
     return <Chat
@@ -122,10 +122,10 @@ Here is the full API for the `<Chat>` component, these properties can be set on
 | `voice` | `boolean` | No | `true` | Voice chat will be enabled if this property is set to true. |
 | `peerOptions` | [`PeerOptions`](#PeerOptions) | No | - | Options to customize peerjs Peer instance. |
 | `dialogOptions` | [`DialogOptions`](#DialogOptions) | No | { position: 'center' } | Options to customize text dialog box styling. |
-| `onError` | `Function` | No | `() => alert('Browser not supported! Try some other browser.')` | Function to be executed if browser doesn't support [WebRTC](https://webrtc.org/). |
+| `onError` | `Function` | No | `() => alert('Browser not supported! Try some other browser.')` | Function to be executed if browser doesn't support `WebRTC` |
 | `onMicError` | `Function` | No | `() => alert('Microphone not accessible!')` | Function to be executed when microphone is not accessible. |
 | `props` | `React.DetailedHTMLProps` | No | - | Props to customize the `<Chat>` component. |
-| `children` | [`Children`](#Children) | No | - | Props to customize the `<Chat>` component. |
+| `children` | [`Children`](#Children) | No | - | See [usage with FoC](#Full-Customization) |
 ### Types
 #### PeerOptions
 ```typescript
@@ -157,7 +157,5 @@ type ChildrenOptions = {
 };
 type Children = (childrenOptions: ChildrenOptions) => ReactNode;
 ```
-## Used By
-- [StarWars](https://starwarsgame.vercel.app/)
 ## Author
 [Sahil Aggarwal](https://www.github.com/SahilAggarwal2004)

package/{build → dist}/index.d.ts

@@ -7,7 +7,7 @@ export interface DialogOptions {
     position?: DialogPosition;
     style?: CSSProperties;
 }
-type RemotePeers = {
+export type RemotePeers = {
     [id: string]: string;
 };
 export interface Message {

package/package.json

@@ -1,42 +1,43 @@
-{
-  "name": "react-peer-chat",
-  "version": "0.5.0",
-  "description": "An easy to use react component for impleting peer-to-peer chatting.",
-  "main": "./build/index.js",
-  "type": "module",
-  "scripts": {
-    "copy": "copy .\\src\\*.css build",
-    "build": "npm i && tsc && npm run copy"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/SahilAggarwal2004/react-peer-chat.git"
-  },
-  "keywords": [
-    "react",
-    "chat",
-    "component",
-    "peer",
-    "peerjs",
-    "p2p",
-    "peer-to-peer",
-    "webrtc",
-    "react-peer-chat"
-  ],
-  "author": "Sahil Aggarwal",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/SahilAggarwal2004/react-peer-chat/issues"
-  },
-  "homepage": "https://github.com/SahilAggarwal2004/react-peer-chat#readme",
-  "peerDependencies": {
-    "react": ">=16.0.0",
-    "react-dom": ">=16.0.0"
-  },
-  "devDependencies": {
-    "@types/react": "^18.2.23"
-  },
-  "dependencies": {
-    "peerjs": "^1.5.1"
-  }
+{
+  "name": "react-peer-chat",
+  "version": "0.5.2",
+  "description": "An easy to use react component for impleting peer-to-peer chatting.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SahilAggarwal2004/react-peer-chat.git"
+  },
+  "keywords": [
+    "react",
+    "chat",
+    "component",
+    "peer",
+    "peerjs",
+    "p2p",
+    "peer-to-peer",
+    "webrtc",
+    "react-peer-chat"
+  ],
+  "author": "Sahil Aggarwal",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/SahilAggarwal2004/react-peer-chat/issues"
+  },
+  "homepage": "https://github.com/SahilAggarwal2004/react-peer-chat#readme",
+  "peerDependencies": {
+    "react": ">=16.0.0",
+    "react-dom": ">=16.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.28"
+  },
+  "dependencies": {
+    "peerjs": "^1.5.1"
+  },
+  "scripts": {
+    "copy": "copy .\\src\\*.css dist",
+    "build": "npm i && tsc && npm run copy"
+  }
 }