@nlxai/touchpoint-ui 1.2.1 → 1.2.2-alpha.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.
Files changed (31) hide show
  1. package/README.md +6 -0
  2. package/docs/README.md +134 -22
  3. package/docs/interfaces/BidirectionalContext.md +51 -0
  4. package/docs/interfaces/BidirectionalCustomCommand.md +79 -0
  5. package/docs/interfaces/ChoiceMessage.md +39 -0
  6. package/docs/interfaces/CustomCardProps.md +39 -3
  7. package/docs/interfaces/CustomCardRowProps.md +3 -3
  8. package/docs/interfaces/DateInputProps.md +13 -1
  9. package/docs/interfaces/IconButtonProps.md +5 -5
  10. package/docs/interfaces/Icons.IconProps.md +2 -2
  11. package/docs/interfaces/InputField.md +27 -0
  12. package/docs/interfaces/InteractiveElementInfo.md +21 -0
  13. package/docs/interfaces/PageForms.md +27 -0
  14. package/docs/interfaces/PageState.md +39 -0
  15. package/docs/interfaces/TextButtonProps.md +5 -5
  16. package/docs/interfaces/Theme.md +25 -25
  17. package/docs/interfaces/TouchpointConfiguration.md +73 -17
  18. package/docs/interfaces/TouchpointInstance.md +77 -3
  19. package/docs/modules/Icons.md +62 -41
  20. package/index.html +3 -1
  21. package/lib/components/FullscreenVoice.d.ts +2 -2
  22. package/lib/components/Messages.d.ts +1 -1
  23. package/lib/components/VoiceMini.d.ts +1 -1
  24. package/lib/components/defaultModalities/shared.d.ts +1 -1
  25. package/lib/index.js +13967 -12047
  26. package/lib/index.umd.js +78 -75
  27. package/lib/interface.d.ts +5 -0
  28. package/package.json +6 -6
  29. package/vite.config.ts +2 -0
  30. package/postcss.config.js +0 -6
  31. package/tailwind.config.js +0 -50
package/docs/interfaces/Icons.IconProps.md CHANGED
@@ -14,7 +14,7 @@ Additional CSS classes to apply to the icon
14
14
 
15
15
  #### Defined in
16
16
 
17
- [packages/touchpoint-ui/src/components/ui/Icons.tsx:11](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/Icons.tsx#L11)
17
+ [packages/touchpoint-ui/src/components/ui/Icons.tsx:11](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/Icons.tsx#L11)
18
18
 
19
19
  ___
20
20
 
@@ -26,4 +26,4 @@ Custom size in pixels for the icon
26
26
 
27
27
  #### Defined in
28
28
 
29
- [packages/touchpoint-ui/src/components/ui/Icons.tsx:15](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/Icons.tsx#L15)
29
+ [packages/touchpoint-ui/src/components/ui/Icons.tsx:15](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/Icons.tsx#L15)
package/docs/interfaces/InputField.md ADDED
@@ -0,0 +1,27 @@
1
+ # Interface: InputField
2
+
3
+ Input field value
4
+
5
+ ## Properties
6
+
7
+ ### id
8
+
9
+ • **id**: `string`
10
+
11
+ Field ID
12
+
13
+ #### Defined in
14
+
15
+ [packages/touchpoint-ui/src/interface.ts:211](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L211)
16
+
17
+ ___
18
+
19
+ ### value
20
+
21
+ • **value**: `string` \| `boolean`
22
+
23
+ Field value
24
+
25
+ #### Defined in
26
+
27
+ [packages/touchpoint-ui/src/interface.ts:215](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L215)
package/docs/interfaces/InteractiveElementInfo.md ADDED
@@ -0,0 +1,21 @@
1
+ # Interface: InteractiveElementInfo
2
+
3
+ Accessibility information with ID
4
+
5
+ ## Hierarchy
6
+
7
+ - [`AccessibilityInformation`](../README.md#accessibilityinformation)
8
+
9
+ ↳ **`InteractiveElementInfo`**
10
+
11
+ ## Properties
12
+
13
+ ### id
14
+
15
+ • **id**: `string`
16
+
17
+ Form element ID (assigned by the analysis logic, not necessarily equal to the DOM ID)
18
+
19
+ #### Defined in
20
+
21
+ [packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts:18](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts#L18)
package/docs/interfaces/PageForms.md ADDED
@@ -0,0 +1,27 @@
1
+ # Interface: PageForms
2
+
3
+ Page forms with elements
4
+
5
+ ## Properties
6
+
7
+ ### context
8
+
9
+ • **context**: [`InteractiveElementInfo`](InteractiveElementInfo.md)[]
10
+
11
+ Page context
12
+
13
+ #### Defined in
14
+
15
+ [packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts:28](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts#L28)
16
+
17
+ ___
18
+
19
+ ### formElements
20
+
21
+ • **formElements**: `Record`\<`string`, `Element`\>
22
+
23
+ Form element references
24
+
25
+ #### Defined in
26
+
27
+ [packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts:32](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts#L32)
package/docs/interfaces/PageState.md ADDED
@@ -0,0 +1,39 @@
1
+ # Interface: PageState
2
+
3
+ Internal state that the automatic context maintains.
4
+
5
+ ## Properties
6
+
7
+ ### formElements
8
+
9
+ • **formElements**: `Record`\<`string`, `Element`\>
10
+
11
+ Mapping from form element IDs to their DOM elements
12
+
13
+ #### Defined in
14
+
15
+ [packages/touchpoint-ui/src/interface.ts:223](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L223)
16
+
17
+ ___
18
+
19
+ ### links
20
+
21
+ • **links**: `Record`\<`string`, `string`\>
22
+
23
+ Mapping from link element names to their URLs
24
+
25
+ #### Defined in
26
+
27
+ [packages/touchpoint-ui/src/interface.ts:225](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L225)
28
+
29
+ ___
30
+
31
+ ### customCommands
32
+
33
+ • **customCommands**: `Map`\<`string`, (`arg`: `any`) => `void`\>
34
+
35
+ Mapping from custom commands to their handlers
36
+
37
+ #### Defined in
38
+
39
+ [packages/touchpoint-ui/src/interface.ts:227](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L227)
package/docs/interfaces/TextButtonProps.md CHANGED
@@ -20,7 +20,7 @@ Handler function called when the button is clicked
20
20
 
21
21
  #### Defined in
22
22
 
23
- [packages/touchpoint-ui/src/components/ui/TextButton.tsx:13](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L13)
23
+ [packages/touchpoint-ui/src/components/ui/TextButton.tsx:13](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L13)
24
24
 
25
25
  ___
26
26
 
@@ -32,7 +32,7 @@ Text to display on the button
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/touchpoint-ui/src/components/ui/TextButton.tsx:17](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L17)
35
+ [packages/touchpoint-ui/src/components/ui/TextButton.tsx:17](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L17)
36
36
 
37
37
  ___
38
38
 
@@ -44,7 +44,7 @@ Additional CSS classes to apply to the button
44
44
 
45
45
  #### Defined in
46
46
 
47
- [packages/touchpoint-ui/src/components/ui/TextButton.tsx:21](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L21)
47
+ [packages/touchpoint-ui/src/components/ui/TextButton.tsx:21](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L21)
48
48
 
49
49
  ___
50
50
 
@@ -57,7 +57,7 @@ Default value is "ghost"
57
57
 
58
58
  #### Defined in
59
59
 
60
- [packages/touchpoint-ui/src/components/ui/TextButton.tsx:26](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L26)
60
+ [packages/touchpoint-ui/src/components/ui/TextButton.tsx:26](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L26)
61
61
 
62
62
  ___
63
63
 
@@ -69,4 +69,4 @@ Icon component to display inside the button.
69
69
 
70
70
  #### Defined in
71
71
 
72
- [packages/touchpoint-ui/src/components/ui/TextButton.tsx:30](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L30)
72
+ [packages/touchpoint-ui/src/components/ui/TextButton.tsx:30](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L30)
package/docs/interfaces/Theme.md CHANGED
@@ -12,7 +12,7 @@ Font family
12
12
 
13
13
  #### Defined in
14
14
 
15
- [packages/touchpoint-ui/src/types.ts:61](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L61)
15
+ [packages/touchpoint-ui/src/interface.ts:71](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L71)
16
16
 
17
17
  ___
18
18
 
@@ -24,7 +24,7 @@ Primary color with 80% opacity
24
24
 
25
25
  #### Defined in
26
26
 
27
- [packages/touchpoint-ui/src/types.ts:66](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L66)
27
+ [packages/touchpoint-ui/src/interface.ts:76](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L76)
28
28
 
29
29
  ___
30
30
 
@@ -36,7 +36,7 @@ Primary color with 60% opacity
36
36
 
37
37
  #### Defined in
38
38
 
39
- [packages/touchpoint-ui/src/types.ts:70](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L70)
39
+ [packages/touchpoint-ui/src/interface.ts:80](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L80)
40
40
 
41
41
  ___
42
42
 
@@ -48,7 +48,7 @@ Primary color with 40% opacity
48
48
 
49
49
  #### Defined in
50
50
 
51
- [packages/touchpoint-ui/src/types.ts:74](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L74)
51
+ [packages/touchpoint-ui/src/interface.ts:84](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L84)
52
52
 
53
53
  ___
54
54
 
@@ -60,7 +60,7 @@ Primary color with 20% opacity
60
60
 
61
61
  #### Defined in
62
62
 
63
- [packages/touchpoint-ui/src/types.ts:78](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L78)
63
+ [packages/touchpoint-ui/src/interface.ts:88](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L88)
64
64
 
65
65
  ___
66
66
 
@@ -72,7 +72,7 @@ Primary color with 10% opacity
72
72
 
73
73
  #### Defined in
74
74
 
75
- [packages/touchpoint-ui/src/types.ts:82](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L82)
75
+ [packages/touchpoint-ui/src/interface.ts:92](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L92)
76
76
 
77
77
  ___
78
78
 
@@ -84,7 +84,7 @@ Primary color with 5% opacity
84
84
 
85
85
  #### Defined in
86
86
 
87
- [packages/touchpoint-ui/src/types.ts:86](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L86)
87
+ [packages/touchpoint-ui/src/interface.ts:96](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L96)
88
88
 
89
89
  ___
90
90
 
@@ -96,7 +96,7 @@ Primary color with 1% opacity
96
96
 
97
97
  #### Defined in
98
98
 
99
- [packages/touchpoint-ui/src/types.ts:90](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L90)
99
+ [packages/touchpoint-ui/src/interface.ts:100](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L100)
100
100
 
101
101
  ___
102
102
 
@@ -108,7 +108,7 @@ Secondary color with 80% opacity
108
108
 
109
109
  #### Defined in
110
110
 
111
- [packages/touchpoint-ui/src/types.ts:95](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L95)
111
+ [packages/touchpoint-ui/src/interface.ts:105](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L105)
112
112
 
113
113
  ___
114
114
 
@@ -120,7 +120,7 @@ Secondary color with 60% opacity
120
120
 
121
121
  #### Defined in
122
122
 
123
- [packages/touchpoint-ui/src/types.ts:99](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L99)
123
+ [packages/touchpoint-ui/src/interface.ts:109](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L109)
124
124
 
125
125
  ___
126
126
 
@@ -132,7 +132,7 @@ Secondary color with 40% opacity
132
132
 
133
133
  #### Defined in
134
134
 
135
- [packages/touchpoint-ui/src/types.ts:103](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L103)
135
+ [packages/touchpoint-ui/src/interface.ts:113](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L113)
136
136
 
137
137
  ___
138
138
 
@@ -144,7 +144,7 @@ Secondary color with 20% opacity
144
144
 
145
145
  #### Defined in
146
146
 
147
- [packages/touchpoint-ui/src/types.ts:107](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L107)
147
+ [packages/touchpoint-ui/src/interface.ts:117](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L117)
148
148
 
149
149
  ___
150
150
 
@@ -156,7 +156,7 @@ Secondary color with 10% opacity
156
156
 
157
157
  #### Defined in
158
158
 
159
- [packages/touchpoint-ui/src/types.ts:111](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L111)
159
+ [packages/touchpoint-ui/src/interface.ts:121](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L121)
160
160
 
161
161
  ___
162
162
 
@@ -168,7 +168,7 @@ Secondary color with 5% opacity
168
168
 
169
169
  #### Defined in
170
170
 
171
- [packages/touchpoint-ui/src/types.ts:115](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L115)
171
+ [packages/touchpoint-ui/src/interface.ts:125](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L125)
172
172
 
173
173
  ___
174
174
 
@@ -180,7 +180,7 @@ Secondary color with 1% opacity
180
180
 
181
181
  #### Defined in
182
182
 
183
- [packages/touchpoint-ui/src/types.ts:119](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L119)
183
+ [packages/touchpoint-ui/src/interface.ts:129](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L129)
184
184
 
185
185
  ___
186
186
 
@@ -192,7 +192,7 @@ Accent color used e.g. for prominent buttons, the loader animation as well as se
192
192
 
193
193
  #### Defined in
194
194
 
195
- [packages/touchpoint-ui/src/types.ts:124](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L124)
195
+ [packages/touchpoint-ui/src/interface.ts:134](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L134)
196
196
 
197
197
  ___
198
198
 
@@ -204,7 +204,7 @@ Accent color with 20% opacity
204
204
 
205
205
  #### Defined in
206
206
 
207
- [packages/touchpoint-ui/src/types.ts:128](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L128)
207
+ [packages/touchpoint-ui/src/interface.ts:138](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L138)
208
208
 
209
209
  ___
210
210
 
@@ -216,7 +216,7 @@ The background color of the main Touchpoint interface
216
216
 
217
217
  #### Defined in
218
218
 
219
- [packages/touchpoint-ui/src/types.ts:132](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L132)
219
+ [packages/touchpoint-ui/src/interface.ts:142](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L142)
220
220
 
221
221
  ___
222
222
 
@@ -228,7 +228,7 @@ The color of the overlay covering the visible portion of the website when the To
228
228
 
229
229
  #### Defined in
230
230
 
231
- [packages/touchpoint-ui/src/types.ts:136](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L136)
231
+ [packages/touchpoint-ui/src/interface.ts:146](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L146)
232
232
 
233
233
  ___
234
234
 
@@ -240,7 +240,7 @@ Primary warning color
240
240
 
241
241
  #### Defined in
242
242
 
243
- [packages/touchpoint-ui/src/types.ts:141](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L141)
243
+ [packages/touchpoint-ui/src/interface.ts:151](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L151)
244
244
 
245
245
  ___
246
246
 
@@ -252,7 +252,7 @@ Secondary warning color
252
252
 
253
253
  #### Defined in
254
254
 
255
- [packages/touchpoint-ui/src/types.ts:145](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L145)
255
+ [packages/touchpoint-ui/src/interface.ts:155](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L155)
256
256
 
257
257
  ___
258
258
 
@@ -264,7 +264,7 @@ Primary error color
264
264
 
265
265
  #### Defined in
266
266
 
267
- [packages/touchpoint-ui/src/types.ts:149](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L149)
267
+ [packages/touchpoint-ui/src/interface.ts:159](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L159)
268
268
 
269
269
  ___
270
270
 
@@ -276,7 +276,7 @@ Secondary error color
276
276
 
277
277
  #### Defined in
278
278
 
279
- [packages/touchpoint-ui/src/types.ts:153](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L153)
279
+ [packages/touchpoint-ui/src/interface.ts:163](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L163)
280
280
 
281
281
  ___
282
282
 
@@ -288,7 +288,7 @@ Inner border radius: used for most buttons
288
288
 
289
289
  #### Defined in
290
290
 
291
- [packages/touchpoint-ui/src/types.ts:158](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L158)
291
+ [packages/touchpoint-ui/src/interface.ts:168](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L168)
292
292
 
293
293
  ___
294
294
 
@@ -300,4 +300,4 @@ Outer border radius: generally used for elements that contain buttons that have
300
300
 
301
301
  #### Defined in
302
302
 
303
- [packages/touchpoint-ui/src/types.ts:162](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L162)
303
+ [packages/touchpoint-ui/src/interface.ts:172](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L172)
package/docs/interfaces/TouchpointConfiguration.md CHANGED
@@ -8,11 +8,11 @@ Main Touchpoint creation properties object
8
8
 
9
9
  • **config**: `Config`
10
10
 
11
- Connection information for the @nlxai/chat-core conversation handler
11
+ Connection information for the @nlxai/core conversation handler
12
12
 
13
13
  #### Defined in
14
14
 
15
- [packages/touchpoint-ui/src/types.ts:178](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L178)
15
+ [packages/touchpoint-ui/src/interface.ts:365](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L365)
16
16
 
17
17
  ___
18
18
 
@@ -24,7 +24,7 @@ Optional window size for the chat window, defaults to `half`
24
24
 
25
25
  #### Defined in
26
26
 
27
- [packages/touchpoint-ui/src/types.ts:182](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L182)
27
+ [packages/touchpoint-ui/src/interface.ts:369](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L369)
28
28
 
29
29
  ___
30
30
 
@@ -36,7 +36,7 @@ Optional color mode for the chat window, defaults to `dark`
36
36
 
37
37
  #### Defined in
38
38
 
39
- [packages/touchpoint-ui/src/types.ts:186](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L186)
39
+ [packages/touchpoint-ui/src/interface.ts:373](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L373)
40
40
 
41
41
  ___
42
42
 
@@ -48,13 +48,25 @@ URL of icon used to display the brand in the chat header
48
48
 
49
49
  #### Defined in
50
50
 
51
- [packages/touchpoint-ui/src/types.ts:190](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L190)
51
+ [packages/touchpoint-ui/src/interface.ts:377](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L377)
52
+
53
+ ___
54
+
55
+ ### animate
56
+
57
+ • `Optional` **animate**: `boolean`
58
+
59
+ Include border animation. Currently only supported in Voice Mini.
60
+
61
+ #### Defined in
62
+
63
+ [packages/touchpoint-ui/src/interface.ts:381](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L381)
52
64
 
53
65
  ___
54
66
 
55
67
  ### launchIcon
56
68
 
57
- • `Optional` **launchIcon**: `string` \| `boolean`
69
+ • `Optional` **launchIcon**: `string` \| `boolean` \| [`CustomLaunchButton`](../README.md#customlaunchbutton)
58
70
 
59
71
  URL of icon used on the launch icon in the bottom right when the experience is collapsed.
60
72
 
@@ -62,7 +74,7 @@ When set to `false`, no launch button is shown at all. When not set or set to `t
62
74
 
63
75
  #### Defined in
64
76
 
65
- [packages/touchpoint-ui/src/types.ts:196](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L196)
77
+ [packages/touchpoint-ui/src/interface.ts:387](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L387)
66
78
 
67
79
  ___
68
80
 
@@ -74,7 +86,7 @@ Specifies whether the user message has bubbles or not
74
86
 
75
87
  #### Defined in
76
88
 
77
- [packages/touchpoint-ui/src/types.ts:200](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L200)
89
+ [packages/touchpoint-ui/src/interface.ts:391](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L391)
78
90
 
79
91
  ___
80
92
 
@@ -86,7 +98,7 @@ Specifies whether the agent message has bubbles or not
86
98
 
87
99
  #### Defined in
88
100
 
89
- [packages/touchpoint-ui/src/types.ts:204](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L204)
101
+ [packages/touchpoint-ui/src/interface.ts:395](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L395)
90
102
 
91
103
  ___
92
104
 
@@ -98,7 +110,7 @@ Enables chat mode, a classic chat experience with inline loaders and the chat hi
98
110
 
99
111
  #### Defined in
100
112
 
101
- [packages/touchpoint-ui/src/types.ts:208](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L208)
113
+ [packages/touchpoint-ui/src/interface.ts:399](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L399)
102
114
 
103
115
  ___
104
116
 
@@ -110,19 +122,35 @@ Optional theme object to override default theme values
110
122
 
111
123
  #### Defined in
112
124
 
113
- [packages/touchpoint-ui/src/types.ts:212](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L212)
125
+ [packages/touchpoint-ui/src/interface.ts:403](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L403)
126
+
127
+ ___
128
+
129
+ ### modalityComponents
130
+
131
+ • `Optional` **modalityComponents**: `Record`\<`string`, [`CustomModalityComponent`](../README.md#custommodalitycomponent)\<`unknown`\>\>
132
+
133
+ Optional custom modality components to render in Touchpoint
134
+
135
+ #### Defined in
136
+
137
+ [packages/touchpoint-ui/src/interface.ts:407](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L407)
114
138
 
115
139
  ___
116
140
 
117
141
  ### customModalities
118
142
 
119
- • `Optional` **customModalities**: `Record`\<`string`, [`CustomModalityComponent`](../README.md#custommodalitycomponent)\<`any`\>\>
143
+ • `Optional` **customModalities**: `Record`\<`string`, [`CustomModalityComponent`](../README.md#custommodalitycomponent)\<`unknown`\>\>
120
144
 
121
145
  Optional custom modality components to render in Touchpoint
122
146
 
147
+ **`Deprecated`**
148
+
149
+ use [TouchpointConfiguration.modalityComponents](TouchpointConfiguration.md#modalitycomponents) instead.
150
+
123
151
  #### Defined in
124
152
 
125
- [packages/touchpoint-ui/src/types.ts:216](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L216)
153
+ [packages/touchpoint-ui/src/interface.ts:412](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L412)
126
154
 
127
155
  ___
128
156
 
@@ -136,18 +164,46 @@ Custom conversation init method. Defaults to sending the welcome intent
136
164
 
137
165
  the conversation handler.
138
166
 
167
+ **`Param`**
168
+
169
+ the context object
170
+
139
171
  #### Defined in
140
172
 
141
- [packages/touchpoint-ui/src/types.ts:221](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L221)
173
+ [packages/touchpoint-ui/src/interface.ts:418](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L418)
142
174
 
143
175
  ___
144
176
 
145
177
  ### input
146
178
 
147
- • `Optional` **input**: ``"text"`` \| ``"voice"`` \| ``"voiceMini"``
179
+ • `Optional` **input**: [`Input`](../README.md#input)
180
+
181
+ Controls the ways in which the user can communicate with the application. Defaults to `"text"`
182
+
183
+ #### Defined in
184
+
185
+ [packages/touchpoint-ui/src/interface.ts:422](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L422)
186
+
187
+ ___
188
+
189
+ ### initialContext
190
+
191
+ • `Optional` **initialContext**: `Context`
192
+
193
+ Context sent with the initial request.
194
+
195
+ #### Defined in
196
+
197
+ [packages/touchpoint-ui/src/interface.ts:426](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L426)
198
+
199
+ ___
200
+
201
+ ### bidirectional
202
+
203
+ • `Optional` **bidirectional**: [`BidirectionalConfig`](../README.md#bidirectionalconfig)
148
204
 
149
- Controls the ways in which the user can communicate with the application. Defaults to `"text"`
205
+ Enables bidirectional mode of voice+. Will automatically set the bidirectional flag in the config.
150
206
 
151
207
  #### Defined in
152
208
 
153
- [packages/touchpoint-ui/src/types.ts:225](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L225)
209
+ [packages/touchpoint-ui/src/interface.ts:432](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L432)