@livechat/widget-react - npm Package Compare versions

Comparing version 1.2.3 to 1.3.0

package.json

 {
   "name": "@livechat/widget-react",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "sideEffects": false,
@@ -29,3 +29,3 @@ "description": "This library allows to render and interact with the LiveChat Chat Widget inside a React application",
   "dependencies": {
-    "@livechat/widget-core": "^1.2.3"
+    "@livechat/widget-core": "^1.3.0"
   },
@@ -43,3 +43,3 @@ "peerDependencies": {
   },
-  "gitHead": "cc0402c69d32224598a6823a3a4f35a1c41462bb"
+  "gitHead": "733bfae3ba047d1b372afad17f82538170b4ecd9"
 }

README.md

@@ -52,12 +52,22 @@ # @livechat/widget-react
 
-| Prop              | Type                                   |
-| ----------------- | -------------------------------------- |
-| license           | string (required)                      |
-| group             | string                                 |
-| customerName      | string                                 |
-| customerEmail     | string                                 |
-| chatBetweenGroups | boolean                                |
-| sessionVariables  | Record<string, string>                 |
-| visibility        | 'maximized' \| 'minimized' \| 'hidden' |
+| Prop                   | Type                                   |
+| ---------------------- | -------------------------------------- |
+| license                | string (required)                      |
+| customerName           | string                                 |
+| group                  | string                                 |
+| customerEmail          | string                                 |
+| chatBetweenGroups      | boolean                                |
+| sessionVariables       | Record<string, string>                 |
+| visibility             | 'maximized' \| 'minimized' \| 'hidden' |
+| customIdentityProvider | () => CustomerAuth                     |
 
+CustomerAuth:
+
+| parameters    | type                   | description                                                                            |
+| ------------- | ---------------------- | -------------------------------------------------------------------------------------- |
+| getFreshToken | () => Promise<Token>   | Should resolve with freshly requested customer access token.                           |
+| getToken      | () => Promise<Token>   | Should resolve with currently stored customer access token.                            |
+| hasToken      | () => Promise<boolean> | Should resolve with a boolean value representing if a token has been already acquired. |
+| invalidate    | () => Promise<void>    | Should handle token invalidation and/or clearing the locally cached value.             |
+
 #### Event handlers
@@ -186,2 +196,69 @@
 
+#### Custom Identity Provider
+
+In order to make Custom Identity Provider work, you'll have to properly implement and provide a set of following methods:
+
+- `getToken` - resolving [Chat Widget token]('https://developers.livechat.com/docs/extending-chat-widget/custom-identity-provider#chat-widget-token'). If you want to cache the token, this should return the cached token instead of a fresh request to https://accounts.livechat.com/customer/token endpoint.
+- `getFreshToken` - resolving [Chat Widget token]('https://developers.livechat.com/docs/extending-chat-widget/custom-identity-provider#chat-widget-token'). This should always make a call for a fresh token from https://accounts.livechat.com/customer/token endpoint.
+- `hasToken` - resolving boolean. It determines whether a token has been acquired.
+- `invalidate` - resolving nothing. When called, it should remove the current token. There is no need to do anything else as a new token will be requested by getFreshToken afterwards.
+
+##### Example usage
+
+```ts
+import { LiveChatWidget } from '@livechat/widget-react'
+
+const customIdentityProvider = () => {
+  const baseAPI = 'YOUR_API_URL'
+  const userId = '30317220-c72d-11ed-2137-0242ac120002'
+
+  const getToken = async () => {
+    const response = await fetch(`${baseAPI}/getToken/${userId}`)
+
+    const token = await response.json()
+    console.log('getToken', token)
+    return token
+  }
+
+  const getFreshToken = async () => {
+    const response = await fetch(`${baseAPI}/getFreshToken/${userId}`)
+
+    const token = await response.json()
+    console.log('getFreshToken, token')
+    return token
+  }
+
+  const hasToken = async () => {
+    const response = await fetch(`${baseAPI}/hasToken/${userId}`)
+    const data = await response.json()
+    return data
+  }
+
+  const invalidateToken = async () => {
+    const response = await fetch(`${baseAPI}/invalidate/${userId}`)
+    const data = await response.json()
+    console.log(data)
+  }
+
+  return {
+    getToken,
+    getFreshToken,
+    hasToken,
+    invalidate: invalidateToken,
+  }
+}
+
+function App() {
+  return (
+    <LiveChatWidget
+      license="12345678"
+      visibility="maximized"
+      customIdentityProvider={customIdentityProvider}
+    />
+  )
+}
+```
+
+For more information about Custom Identity Provider, check out https://developers.livechat.com/docs/extending-chat-widget/custom-identity-provider
+
 ## Contributing
@@ -188,0 +265,0 @@

No alert changes

Improved metrics

Total package byte prevSize

41558

increased by8.59%

Number of lines in readme file

269

increased by40.1%

Dependency changes

• Updated@livechat/widget-core@^1.3.0