@botpress/webchat 2.2.20 → 2.3.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 (53) hide show
  1. package/.turbo/turbo-build.log +8 -8
  2. package/dist/adapters/adapters/webchat-to-target.d.ts +46 -0
  3. package/dist/adapters/webchat.d.ts +816 -0
  4. package/dist/client/{PushpinClient/index.d.ts → client.d.ts} +6 -5
  5. package/dist/client/index.d.ts +1 -2
  6. package/dist/client/{PushpinClient/inner-client → inner-client}/index.d.ts +3 -3
  7. package/dist/client/{PushpinClient/inner-client → inner-client}/signal-listener.d.ts +1 -1
  8. package/dist/client/types.d.ts +3 -26
  9. package/dist/components/Block.d.ts +1 -1
  10. package/dist/components/Message/Message.d.ts +4 -2
  11. package/dist/components/renderers/Audio/Audio.d.ts +3 -1
  12. package/dist/components/renderers/Bubble/Bubble.d.ts +2 -2
  13. package/dist/components/renderers/Button/Button.d.ts +2 -2
  14. package/dist/components/renderers/Carousel/Carousel.d.ts +3 -1
  15. package/dist/components/renderers/Column/Column.d.ts +2 -2
  16. package/dist/components/renderers/Dropdown/Dropdown.d.ts +2 -2
  17. package/dist/components/renderers/File/File.d.ts +3 -1
  18. package/dist/components/renderers/Image/Image.d.ts +3 -1
  19. package/dist/components/renderers/Location/Location.d.ts +3 -1
  20. package/dist/components/renderers/Row/Row.d.ts +2 -2
  21. package/dist/components/renderers/Text/Text.d.ts +2 -2
  22. package/dist/components/renderers/Video/Video.d.ts +3 -1
  23. package/dist/gen/client/models.d.ts +57 -48
  24. package/dist/gen/client/operations/createMessage.d.ts +114 -96
  25. package/dist/gen/client/operations/getMessage.d.ts +57 -48
  26. package/dist/gen/client/operations/listConversationMessages.d.ts +57 -48
  27. package/dist/gen/signals/index.d.ts +409 -94
  28. package/dist/gen/signals/messageCreated.t.d.ts +57 -48
  29. package/dist/gen/signals/messageCreated.z.d.ts +408 -86
  30. package/dist/get-client.d.ts +1 -2
  31. package/dist/hooks/useClient.d.ts +1 -2
  32. package/dist/index.js +12137 -14521
  33. package/dist/index.umd.cjs +88 -88
  34. package/dist/schemas/init.d.ts +0 -7
  35. package/dist/stores/offlineStore.d.ts +1 -1
  36. package/dist/stores/webchatStore.d.ts +1 -0
  37. package/dist/style.css +1 -1
  38. package/dist/styles/classes.d.ts +22 -22
  39. package/dist/types/block-type.d.ts +16 -14
  40. package/dist/types/init.d.ts +0 -1
  41. package/openapi.ts +1 -1
  42. package/package.json +3 -2
  43. package/dist/client/MessagingClient/client.d.ts +0 -35
  44. package/dist/client/MessagingClient/index.d.ts +0 -1
  45. package/dist/gen/signals/custom.j.d.ts +0 -3
  46. package/dist/gen/signals/messageCreated.j.d.ts +0 -3
  47. package/dist/gen/signals/typingStarted.j.d.ts +0 -3
  48. package/dist/gen/signals/typingStopped.j.d.ts +0 -3
  49. package/dist/gen/signals/webchatConfig.j.d.ts +0 -3
  50. package/dist/gen/signals/webchatVisibility.j.d.ts +0 -3
  51. /package/dist/client/{PushpinClient/inner-client → inner-client}/event-emitter.d.ts +0 -0
  52. /package/dist/client/{PushpinClient/inner-client → inner-client}/eventsource.d.ts +0 -0
  53. /package/dist/client/{PushpinClient/state-machine.d.ts → state-machine.d.ts} +0 -0
@@ -11,10 +11,6 @@ export interface CreateMessageRequestBody {
11
11
  */
12
12
  payload: {
13
13
  audioUrl: string;
14
- /**
15
- * CSS className to apply to the message
16
- */
17
- className?: string;
18
14
  type: "audio";
19
15
  [k: string]: any;
20
16
  } | {
@@ -28,10 +24,6 @@ export interface CreateMessageRequestBody {
28
24
  [k: string]: any;
29
25
  }[];
30
26
  type: "card";
31
- /**
32
- * CSS className to apply to the message
33
- */
34
- className?: string;
35
27
  [k: string]: any;
36
28
  } | {
37
29
  items: {
@@ -44,16 +36,8 @@ export interface CreateMessageRequestBody {
44
36
  value: string;
45
37
  [k: string]: any;
46
38
  }[];
47
- /**
48
- * CSS className to apply to the message
49
- */
50
- className?: string;
51
39
  [k: string]: any;
52
40
  }[];
53
- /**
54
- * CSS className to apply to the message
55
- */
56
- className?: string;
57
41
  type: "carousel";
58
42
  [k: string]: any;
59
43
  } | {
@@ -63,10 +47,6 @@ export interface CreateMessageRequestBody {
63
47
  value: string;
64
48
  [k: string]: any;
65
49
  }[];
66
- /**
67
- * CSS className to apply to the message
68
- */
69
- className?: string;
70
50
  type: "choice";
71
51
  disableFreeText?: boolean;
72
52
  [k: string]: any;
@@ -77,27 +57,15 @@ export interface CreateMessageRequestBody {
77
57
  value: string;
78
58
  [k: string]: any;
79
59
  }[];
80
- /**
81
- * CSS className to apply to the message
82
- */
83
- className?: string;
84
60
  type: "dropdown";
85
61
  [k: string]: any;
86
62
  } | {
87
63
  fileUrl: string;
88
64
  title?: string;
89
- /**
90
- * CSS className to apply to the message
91
- */
92
- className?: string;
93
65
  type: "file";
94
66
  [k: string]: any;
95
67
  } | {
96
68
  imageUrl: string;
97
- /**
98
- * CSS className to apply to the message
99
- */
100
- className?: string;
101
69
  type: "image";
102
70
  [k: string]: any;
103
71
  } | {
@@ -105,36 +73,77 @@ export interface CreateMessageRequestBody {
105
73
  longitude: number;
106
74
  address?: string;
107
75
  title?: string;
108
- /**
109
- * CSS className to apply to the message
110
- */
111
- className?: string;
112
76
  type: "location";
113
77
  [k: string]: any;
114
78
  } | {
115
79
  markdown: string;
116
- /**
117
- * CSS className to apply to the message
118
- */
119
- className?: string;
120
80
  type: "markdown";
121
81
  [k: string]: any;
122
82
  } | {
123
83
  text: string;
124
- /**
125
- * CSS className to apply to the message
126
- */
127
- className?: string;
128
84
  type: "text";
129
85
  [k: string]: any;
130
86
  } | {
131
87
  videoUrl: string;
132
- /**
133
- * CSS className to apply to the message
134
- */
135
- className?: string;
136
88
  type: "video";
137
89
  [k: string]: any;
90
+ } | {
91
+ items: ({
92
+ type: "text";
93
+ payload: {
94
+ text: string;
95
+ [k: string]: any;
96
+ };
97
+ [k: string]: any;
98
+ } | {
99
+ type: "markdown";
100
+ payload: {
101
+ markdown: string;
102
+ [k: string]: any;
103
+ };
104
+ [k: string]: any;
105
+ } | {
106
+ type: "image";
107
+ payload: {
108
+ imageUrl: string;
109
+ [k: string]: any;
110
+ };
111
+ [k: string]: any;
112
+ } | {
113
+ type: "audio";
114
+ payload: {
115
+ audioUrl: string;
116
+ [k: string]: any;
117
+ };
118
+ [k: string]: any;
119
+ } | {
120
+ type: "video";
121
+ payload: {
122
+ videoUrl: string;
123
+ [k: string]: any;
124
+ };
125
+ [k: string]: any;
126
+ } | {
127
+ type: "file";
128
+ payload: {
129
+ fileUrl: string;
130
+ title?: string;
131
+ [k: string]: any;
132
+ };
133
+ [k: string]: any;
134
+ } | {
135
+ type: "location";
136
+ payload: {
137
+ latitude: number;
138
+ longitude: number;
139
+ address?: string;
140
+ title?: string;
141
+ [k: string]: any;
142
+ };
143
+ [k: string]: any;
144
+ })[];
145
+ type: "bloc";
146
+ [k: string]: any;
138
147
  };
139
148
  /**
140
149
  * ID of the [Conversation](#schema_conversation)
@@ -169,10 +178,6 @@ export interface CreateMessageResponse {
169
178
  */
170
179
  payload: {
171
180
  audioUrl: string;
172
- /**
173
- * CSS className to apply to the message
174
- */
175
- className?: string;
176
181
  type: "audio";
177
182
  [k: string]: any;
178
183
  } | {
@@ -186,10 +191,6 @@ export interface CreateMessageResponse {
186
191
  [k: string]: any;
187
192
  }[];
188
193
  type: "card";
189
- /**
190
- * CSS className to apply to the message
191
- */
192
- className?: string;
193
194
  [k: string]: any;
194
195
  } | {
195
196
  items: {
@@ -202,16 +203,8 @@ export interface CreateMessageResponse {
202
203
  value: string;
203
204
  [k: string]: any;
204
205
  }[];
205
- /**
206
- * CSS className to apply to the message
207
- */
208
- className?: string;
209
206
  [k: string]: any;
210
207
  }[];
211
- /**
212
- * CSS className to apply to the message
213
- */
214
- className?: string;
215
208
  type: "carousel";
216
209
  [k: string]: any;
217
210
  } | {
@@ -221,10 +214,6 @@ export interface CreateMessageResponse {
221
214
  value: string;
222
215
  [k: string]: any;
223
216
  }[];
224
- /**
225
- * CSS className to apply to the message
226
- */
227
- className?: string;
228
217
  type: "choice";
229
218
  disableFreeText?: boolean;
230
219
  [k: string]: any;
@@ -235,27 +224,15 @@ export interface CreateMessageResponse {
235
224
  value: string;
236
225
  [k: string]: any;
237
226
  }[];
238
- /**
239
- * CSS className to apply to the message
240
- */
241
- className?: string;
242
227
  type: "dropdown";
243
228
  [k: string]: any;
244
229
  } | {
245
230
  fileUrl: string;
246
231
  title?: string;
247
- /**
248
- * CSS className to apply to the message
249
- */
250
- className?: string;
251
232
  type: "file";
252
233
  [k: string]: any;
253
234
  } | {
254
235
  imageUrl: string;
255
- /**
256
- * CSS className to apply to the message
257
- */
258
- className?: string;
259
236
  type: "image";
260
237
  [k: string]: any;
261
238
  } | {
@@ -263,36 +240,77 @@ export interface CreateMessageResponse {
263
240
  longitude: number;
264
241
  address?: string;
265
242
  title?: string;
266
- /**
267
- * CSS className to apply to the message
268
- */
269
- className?: string;
270
243
  type: "location";
271
244
  [k: string]: any;
272
245
  } | {
273
246
  markdown: string;
274
- /**
275
- * CSS className to apply to the message
276
- */
277
- className?: string;
278
247
  type: "markdown";
279
248
  [k: string]: any;
280
249
  } | {
281
250
  text: string;
282
- /**
283
- * CSS className to apply to the message
284
- */
285
- className?: string;
286
251
  type: "text";
287
252
  [k: string]: any;
288
253
  } | {
289
254
  videoUrl: string;
290
- /**
291
- * CSS className to apply to the message
292
- */
293
- className?: string;
294
255
  type: "video";
295
256
  [k: string]: any;
257
+ } | {
258
+ items: ({
259
+ type: "text";
260
+ payload: {
261
+ text: string;
262
+ [k: string]: any;
263
+ };
264
+ [k: string]: any;
265
+ } | {
266
+ type: "markdown";
267
+ payload: {
268
+ markdown: string;
269
+ [k: string]: any;
270
+ };
271
+ [k: string]: any;
272
+ } | {
273
+ type: "image";
274
+ payload: {
275
+ imageUrl: string;
276
+ [k: string]: any;
277
+ };
278
+ [k: string]: any;
279
+ } | {
280
+ type: "audio";
281
+ payload: {
282
+ audioUrl: string;
283
+ [k: string]: any;
284
+ };
285
+ [k: string]: any;
286
+ } | {
287
+ type: "video";
288
+ payload: {
289
+ videoUrl: string;
290
+ [k: string]: any;
291
+ };
292
+ [k: string]: any;
293
+ } | {
294
+ type: "file";
295
+ payload: {
296
+ fileUrl: string;
297
+ title?: string;
298
+ [k: string]: any;
299
+ };
300
+ [k: string]: any;
301
+ } | {
302
+ type: "location";
303
+ payload: {
304
+ latitude: number;
305
+ longitude: number;
306
+ address?: string;
307
+ title?: string;
308
+ [k: string]: any;
309
+ };
310
+ [k: string]: any;
311
+ })[];
312
+ type: "bloc";
313
+ [k: string]: any;
296
314
  };
297
315
  /**
298
316
  * ID of the [User](#schema_user)
@@ -36,10 +36,6 @@ export interface GetMessageResponse {
36
36
  */
37
37
  payload: {
38
38
  audioUrl: string;
39
- /**
40
- * CSS className to apply to the message
41
- */
42
- className?: string;
43
39
  type: "audio";
44
40
  [k: string]: any;
45
41
  } | {
@@ -53,10 +49,6 @@ export interface GetMessageResponse {
53
49
  [k: string]: any;
54
50
  }[];
55
51
  type: "card";
56
- /**
57
- * CSS className to apply to the message
58
- */
59
- className?: string;
60
52
  [k: string]: any;
61
53
  } | {
62
54
  items: {
@@ -69,16 +61,8 @@ export interface GetMessageResponse {
69
61
  value: string;
70
62
  [k: string]: any;
71
63
  }[];
72
- /**
73
- * CSS className to apply to the message
74
- */
75
- className?: string;
76
64
  [k: string]: any;
77
65
  }[];
78
- /**
79
- * CSS className to apply to the message
80
- */
81
- className?: string;
82
66
  type: "carousel";
83
67
  [k: string]: any;
84
68
  } | {
@@ -88,10 +72,6 @@ export interface GetMessageResponse {
88
72
  value: string;
89
73
  [k: string]: any;
90
74
  }[];
91
- /**
92
- * CSS className to apply to the message
93
- */
94
- className?: string;
95
75
  type: "choice";
96
76
  disableFreeText?: boolean;
97
77
  [k: string]: any;
@@ -102,27 +82,15 @@ export interface GetMessageResponse {
102
82
  value: string;
103
83
  [k: string]: any;
104
84
  }[];
105
- /**
106
- * CSS className to apply to the message
107
- */
108
- className?: string;
109
85
  type: "dropdown";
110
86
  [k: string]: any;
111
87
  } | {
112
88
  fileUrl: string;
113
89
  title?: string;
114
- /**
115
- * CSS className to apply to the message
116
- */
117
- className?: string;
118
90
  type: "file";
119
91
  [k: string]: any;
120
92
  } | {
121
93
  imageUrl: string;
122
- /**
123
- * CSS className to apply to the message
124
- */
125
- className?: string;
126
94
  type: "image";
127
95
  [k: string]: any;
128
96
  } | {
@@ -130,36 +98,77 @@ export interface GetMessageResponse {
130
98
  longitude: number;
131
99
  address?: string;
132
100
  title?: string;
133
- /**
134
- * CSS className to apply to the message
135
- */
136
- className?: string;
137
101
  type: "location";
138
102
  [k: string]: any;
139
103
  } | {
140
104
  markdown: string;
141
- /**
142
- * CSS className to apply to the message
143
- */
144
- className?: string;
145
105
  type: "markdown";
146
106
  [k: string]: any;
147
107
  } | {
148
108
  text: string;
149
- /**
150
- * CSS className to apply to the message
151
- */
152
- className?: string;
153
109
  type: "text";
154
110
  [k: string]: any;
155
111
  } | {
156
112
  videoUrl: string;
157
- /**
158
- * CSS className to apply to the message
159
- */
160
- className?: string;
161
113
  type: "video";
162
114
  [k: string]: any;
115
+ } | {
116
+ items: ({
117
+ type: "text";
118
+ payload: {
119
+ text: string;
120
+ [k: string]: any;
121
+ };
122
+ [k: string]: any;
123
+ } | {
124
+ type: "markdown";
125
+ payload: {
126
+ markdown: string;
127
+ [k: string]: any;
128
+ };
129
+ [k: string]: any;
130
+ } | {
131
+ type: "image";
132
+ payload: {
133
+ imageUrl: string;
134
+ [k: string]: any;
135
+ };
136
+ [k: string]: any;
137
+ } | {
138
+ type: "audio";
139
+ payload: {
140
+ audioUrl: string;
141
+ [k: string]: any;
142
+ };
143
+ [k: string]: any;
144
+ } | {
145
+ type: "video";
146
+ payload: {
147
+ videoUrl: string;
148
+ [k: string]: any;
149
+ };
150
+ [k: string]: any;
151
+ } | {
152
+ type: "file";
153
+ payload: {
154
+ fileUrl: string;
155
+ title?: string;
156
+ [k: string]: any;
157
+ };
158
+ [k: string]: any;
159
+ } | {
160
+ type: "location";
161
+ payload: {
162
+ latitude: number;
163
+ longitude: number;
164
+ address?: string;
165
+ title?: string;
166
+ [k: string]: any;
167
+ };
168
+ [k: string]: any;
169
+ })[];
170
+ type: "bloc";
171
+ [k: string]: any;
163
172
  };
164
173
  /**
165
174
  * ID of the [User](#schema_user)
@@ -34,10 +34,6 @@ export interface ListConversationMessagesResponse {
34
34
  */
35
35
  payload: {
36
36
  audioUrl: string;
37
- /**
38
- * CSS className to apply to the message
39
- */
40
- className?: string;
41
37
  type: "audio";
42
38
  [k: string]: any;
43
39
  } | {
@@ -51,10 +47,6 @@ export interface ListConversationMessagesResponse {
51
47
  [k: string]: any;
52
48
  }[];
53
49
  type: "card";
54
- /**
55
- * CSS className to apply to the message
56
- */
57
- className?: string;
58
50
  [k: string]: any;
59
51
  } | {
60
52
  items: {
@@ -67,16 +59,8 @@ export interface ListConversationMessagesResponse {
67
59
  value: string;
68
60
  [k: string]: any;
69
61
  }[];
70
- /**
71
- * CSS className to apply to the message
72
- */
73
- className?: string;
74
62
  [k: string]: any;
75
63
  }[];
76
- /**
77
- * CSS className to apply to the message
78
- */
79
- className?: string;
80
64
  type: "carousel";
81
65
  [k: string]: any;
82
66
  } | {
@@ -86,10 +70,6 @@ export interface ListConversationMessagesResponse {
86
70
  value: string;
87
71
  [k: string]: any;
88
72
  }[];
89
- /**
90
- * CSS className to apply to the message
91
- */
92
- className?: string;
93
73
  type: "choice";
94
74
  disableFreeText?: boolean;
95
75
  [k: string]: any;
@@ -100,27 +80,15 @@ export interface ListConversationMessagesResponse {
100
80
  value: string;
101
81
  [k: string]: any;
102
82
  }[];
103
- /**
104
- * CSS className to apply to the message
105
- */
106
- className?: string;
107
83
  type: "dropdown";
108
84
  [k: string]: any;
109
85
  } | {
110
86
  fileUrl: string;
111
87
  title?: string;
112
- /**
113
- * CSS className to apply to the message
114
- */
115
- className?: string;
116
88
  type: "file";
117
89
  [k: string]: any;
118
90
  } | {
119
91
  imageUrl: string;
120
- /**
121
- * CSS className to apply to the message
122
- */
123
- className?: string;
124
92
  type: "image";
125
93
  [k: string]: any;
126
94
  } | {
@@ -128,36 +96,77 @@ export interface ListConversationMessagesResponse {
128
96
  longitude: number;
129
97
  address?: string;
130
98
  title?: string;
131
- /**
132
- * CSS className to apply to the message
133
- */
134
- className?: string;
135
99
  type: "location";
136
100
  [k: string]: any;
137
101
  } | {
138
102
  markdown: string;
139
- /**
140
- * CSS className to apply to the message
141
- */
142
- className?: string;
143
103
  type: "markdown";
144
104
  [k: string]: any;
145
105
  } | {
146
106
  text: string;
147
- /**
148
- * CSS className to apply to the message
149
- */
150
- className?: string;
151
107
  type: "text";
152
108
  [k: string]: any;
153
109
  } | {
154
110
  videoUrl: string;
155
- /**
156
- * CSS className to apply to the message
157
- */
158
- className?: string;
159
111
  type: "video";
160
112
  [k: string]: any;
113
+ } | {
114
+ items: ({
115
+ type: "text";
116
+ payload: {
117
+ text: string;
118
+ [k: string]: any;
119
+ };
120
+ [k: string]: any;
121
+ } | {
122
+ type: "markdown";
123
+ payload: {
124
+ markdown: string;
125
+ [k: string]: any;
126
+ };
127
+ [k: string]: any;
128
+ } | {
129
+ type: "image";
130
+ payload: {
131
+ imageUrl: string;
132
+ [k: string]: any;
133
+ };
134
+ [k: string]: any;
135
+ } | {
136
+ type: "audio";
137
+ payload: {
138
+ audioUrl: string;
139
+ [k: string]: any;
140
+ };
141
+ [k: string]: any;
142
+ } | {
143
+ type: "video";
144
+ payload: {
145
+ videoUrl: string;
146
+ [k: string]: any;
147
+ };
148
+ [k: string]: any;
149
+ } | {
150
+ type: "file";
151
+ payload: {
152
+ fileUrl: string;
153
+ title?: string;
154
+ [k: string]: any;
155
+ };
156
+ [k: string]: any;
157
+ } | {
158
+ type: "location";
159
+ payload: {
160
+ latitude: number;
161
+ longitude: number;
162
+ address?: string;
163
+ title?: string;
164
+ [k: string]: any;
165
+ };
166
+ [k: string]: any;
167
+ })[];
168
+ type: "bloc";
169
+ [k: string]: any;
161
170
  };
162
171
  /**
163
172
  * ID of the [User](#schema_user)