@epam/ai-dial-overlay 0.40.0-rc.9 → 0.40.1
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.
- package/README.md +7 -7
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# DIAL Overlay
|
|
2
2
|
|
|
3
|
-
DIAL Overlay is a library designed for using
|
|
3
|
+
DIAL Overlay is a library designed for using DIAL Chat in an overlay format. It allows you to set up and interact with the chat via an iframe event-based protocol.
|
|
4
4
|
|
|
5
5
|
## Public Classes to Use
|
|
6
6
|
|
|
@@ -9,7 +9,7 @@ DIAL Overlay is a library designed for using AI DIAL Chat in an overlay format.
|
|
|
9
9
|
|
|
10
10
|
## Prerequisites
|
|
11
11
|
|
|
12
|
-
[
|
|
12
|
+
[DIAL Chat application configuration](https://github.com/epam/ai-dial-chat/blob/development/apps/chat/README.md):
|
|
13
13
|
|
|
14
14
|
- `IS_IFRAME`: set this flag to `true` to enable Overlay.
|
|
15
15
|
- `ALLOWED_IFRAME_ORIGINS`: list all hosts where you are using the Overlay library. Note: For development purposes you can set `*`.
|
|
@@ -19,9 +19,9 @@ IS_IFRAME=true
|
|
|
19
19
|
ALLOWED_IFRAME_ORIGINS=http://localhost:8000
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
## Integration with
|
|
22
|
+
## Integration with DIAL Chat
|
|
23
23
|
|
|
24
|
-
Follow these steps to integrate the Overlay library with the
|
|
24
|
+
Follow these steps to integrate the Overlay library with the DIAL Chat application:
|
|
25
25
|
|
|
26
26
|
1. Install the Overlay library
|
|
27
27
|
|
|
@@ -66,7 +66,7 @@ const run = async () => {
|
|
|
66
66
|
// optional, id of the conversation to be selected at the start
|
|
67
67
|
overlayConversationId: 'some-conversation-id',
|
|
68
68
|
// optional, if DIAL should redirect to sign in the same browser window
|
|
69
|
-
// to use this flag
|
|
69
|
+
// to use this flag DIAL Chat 'ALLOW_OPEN_SIGNIN_PAGE_IN_IFRAME' environmental variable should be set to 'true'
|
|
70
70
|
signInInSameWindow: false,
|
|
71
71
|
// optional, auto-sign in options
|
|
72
72
|
signInOptions: {
|
|
@@ -144,7 +144,7 @@ There are 2 parts of implementation:
|
|
|
144
144
|
|
|
145
145
|
### ChatOverlay
|
|
146
146
|
|
|
147
|
-
Main methods and practices that allow us to communicate with
|
|
147
|
+
Main methods and practices that allow us to communicate with DIAL:
|
|
148
148
|
|
|
149
149
|
1. `ChatOverlay` is the class which in constructor creates an iframe and sets the origin of the deployed version of DIAL. That is how it works for the end user:
|
|
150
150
|
|
|
@@ -213,7 +213,7 @@ subscribe(eventType: string, callback: () => void) {
|
|
|
213
213
|
}
|
|
214
214
|
```
|
|
215
215
|
|
|
216
|
-
9. We are showing the loader until
|
|
216
|
+
9. We are showing the loader until DIAL Chat notifies that `OverlayOptions` is installed.
|
|
217
217
|
|
|
218
218
|
### DIAL Chat
|
|
219
219
|
|
package/package.json
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
"name": "@epam/ai-dial-overlay",
|
|
3
3
|
"description": "Package for opening dial in overlay",
|
|
4
4
|
"homepage": "https://dialx.ai",
|
|
5
|
-
"version": "0.40.
|
|
5
|
+
"version": "0.40.1",
|
|
6
6
|
"dependencies": {
|
|
7
|
-
"@epam/ai-dial-shared": "0.40.
|
|
7
|
+
"@epam/ai-dial-shared": "0.40.1"
|
|
8
8
|
},
|
|
9
9
|
"type": "module",
|
|
10
10
|
"bugs": {
|