@chainlit/react-client 0.2.3 → 0.3.0
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/LICENSE +203 -0
- package/dist/index.d.mts +66 -10
- package/dist/index.d.ts +66 -10
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +8 -8
- package/dist/index.mjs.map +1 -1
- package/package.json +8 -24
package/LICENSE
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
Copyright 2023- The Chainlit team. All rights reserved.
|
|
2
|
+
|
|
3
|
+
Apache License
|
|
4
|
+
Version 2.0, January 2004
|
|
5
|
+
http://www.apache.org/licenses/
|
|
6
|
+
|
|
7
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
|
+
|
|
9
|
+
1. Definitions.
|
|
10
|
+
|
|
11
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
12
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
13
|
+
|
|
14
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
15
|
+
the copyright owner that is granting the License.
|
|
16
|
+
|
|
17
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
18
|
+
other entities that control, are controlled by, or are under common
|
|
19
|
+
control with that entity. For the purposes of this definition,
|
|
20
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
21
|
+
direction or management of such entity, whether by contract or
|
|
22
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
23
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
24
|
+
|
|
25
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
26
|
+
exercising permissions granted by this License.
|
|
27
|
+
|
|
28
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
29
|
+
including but not limited to software source code, documentation
|
|
30
|
+
source, and configuration files.
|
|
31
|
+
|
|
32
|
+
"Object" form shall mean any form resulting from mechanical
|
|
33
|
+
transformation or translation of a Source form, including but
|
|
34
|
+
not limited to compiled object code, generated documentation,
|
|
35
|
+
and conversions to other media types.
|
|
36
|
+
|
|
37
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
38
|
+
Object form, made available under the License, as indicated by a
|
|
39
|
+
copyright notice that is included in or attached to the work
|
|
40
|
+
(an example is provided in the Appendix below).
|
|
41
|
+
|
|
42
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
43
|
+
form, that is based on (or derived from) the Work and for which the
|
|
44
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
45
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
46
|
+
of this License, Derivative Works shall not include works that remain
|
|
47
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
48
|
+
the Work and Derivative Works thereof.
|
|
49
|
+
|
|
50
|
+
"Contribution" shall mean any work of authorship, including
|
|
51
|
+
the original version of the Work and any modifications or additions
|
|
52
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
53
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
54
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
55
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
56
|
+
means any form of electronic, verbal, or written communication sent
|
|
57
|
+
to the Licensor or its representatives, including but not limited to
|
|
58
|
+
communication on electronic mailing lists, source code control systems,
|
|
59
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
60
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
61
|
+
excluding communication that is conspicuously marked or otherwise
|
|
62
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
63
|
+
|
|
64
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
65
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
66
|
+
subsequently incorporated within the Work.
|
|
67
|
+
|
|
68
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
69
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
70
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
71
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
72
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
73
|
+
Work and such Derivative Works in Source or Object form.
|
|
74
|
+
|
|
75
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
76
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
77
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
78
|
+
(except as stated in this section) patent license to make, have made,
|
|
79
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
80
|
+
where such license applies only to those patent claims licensable
|
|
81
|
+
by such Contributor that are necessarily infringed by their
|
|
82
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
83
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
84
|
+
institute patent litigation against any entity (including a
|
|
85
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
86
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
87
|
+
or contributory patent infringement, then any patent licenses
|
|
88
|
+
granted to You under this License for that Work shall terminate
|
|
89
|
+
as of the date such litigation is filed.
|
|
90
|
+
|
|
91
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
92
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
93
|
+
modifications, and in Source or Object form, provided that You
|
|
94
|
+
meet the following conditions:
|
|
95
|
+
|
|
96
|
+
(a) You must give any other recipients of the Work or
|
|
97
|
+
Derivative Works a copy of this License; and
|
|
98
|
+
|
|
99
|
+
(b) You must cause any modified files to carry prominent notices
|
|
100
|
+
stating that You changed the files; and
|
|
101
|
+
|
|
102
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
103
|
+
that You distribute, all copyright, patent, trademark, and
|
|
104
|
+
attribution notices from the Source form of the Work,
|
|
105
|
+
excluding those notices that do not pertain to any part of
|
|
106
|
+
the Derivative Works; and
|
|
107
|
+
|
|
108
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
109
|
+
distribution, then any Derivative Works that You distribute must
|
|
110
|
+
include a readable copy of the attribution notices contained
|
|
111
|
+
within such NOTICE file, excluding those notices that do not
|
|
112
|
+
pertain to any part of the Derivative Works, in at least one
|
|
113
|
+
of the following places: within a NOTICE text file distributed
|
|
114
|
+
as part of the Derivative Works; within the Source form or
|
|
115
|
+
documentation, if provided along with the Derivative Works; or,
|
|
116
|
+
within a display generated by the Derivative Works, if and
|
|
117
|
+
wherever such third-party notices normally appear. The contents
|
|
118
|
+
of the NOTICE file are for informational purposes only and
|
|
119
|
+
do not modify the License. You may add Your own attribution
|
|
120
|
+
notices within Derivative Works that You distribute, alongside
|
|
121
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
122
|
+
that such additional attribution notices cannot be construed
|
|
123
|
+
as modifying the License.
|
|
124
|
+
|
|
125
|
+
You may add Your own copyright statement to Your modifications and
|
|
126
|
+
may provide additional or different license terms and conditions
|
|
127
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
128
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
129
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
130
|
+
the conditions stated in this License.
|
|
131
|
+
|
|
132
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
133
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
134
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
135
|
+
this License, without any additional terms or conditions.
|
|
136
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
137
|
+
the terms of any separate license agreement you may have executed
|
|
138
|
+
with Licensor regarding such Contributions.
|
|
139
|
+
|
|
140
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
141
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
142
|
+
except as required for reasonable and customary use in describing the
|
|
143
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
144
|
+
|
|
145
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
146
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
147
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
148
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
149
|
+
implied, including, without limitation, any warranties or conditions
|
|
150
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
151
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
152
|
+
appropriateness of using or redistributing the Work and assume any
|
|
153
|
+
risks associated with Your exercise of permissions under this License.
|
|
154
|
+
|
|
155
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
156
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
157
|
+
unless required by applicable law (such as deliberate and grossly
|
|
158
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
159
|
+
liable to You for damages, including any direct, indirect, special,
|
|
160
|
+
incidental, or consequential damages of any character arising as a
|
|
161
|
+
result of this License or out of the use or inability to use the
|
|
162
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
163
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
164
|
+
other commercial damages or losses), even if such Contributor
|
|
165
|
+
has been advised of the possibility of such damages.
|
|
166
|
+
|
|
167
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
168
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
169
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
170
|
+
or other liability obligations and/or rights consistent with this
|
|
171
|
+
License. However, in accepting such obligations, You may act only
|
|
172
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
173
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
174
|
+
defend, and hold each Contributor harmless for any liability
|
|
175
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
176
|
+
of your accepting any such warranty or additional liability.
|
|
177
|
+
|
|
178
|
+
END OF TERMS AND CONDITIONS
|
|
179
|
+
|
|
180
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
181
|
+
|
|
182
|
+
To apply the Apache License to your work, attach the following
|
|
183
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
184
|
+
replaced with your own identifying information. (Don't include
|
|
185
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
186
|
+
comment syntax for the file format. We also recommend that a
|
|
187
|
+
file or class name and description of purpose be included on the
|
|
188
|
+
same "printed page" as the copyright notice for easier
|
|
189
|
+
identification within third-party archives.
|
|
190
|
+
|
|
191
|
+
Copyright [yyyy] [name of copyright owner]
|
|
192
|
+
|
|
193
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
194
|
+
you may not use this file except in compliance with the License.
|
|
195
|
+
You may obtain a copy of the License at
|
|
196
|
+
|
|
197
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
|
+
|
|
199
|
+
Unless required by applicable law or agreed to in writing, software
|
|
200
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
201
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
202
|
+
See the License for the specific language governing permissions and
|
|
203
|
+
limitations under the License.
|
package/dist/index.d.mts
CHANGED
|
@@ -69,6 +69,8 @@ interface ICommand {
|
|
|
69
69
|
id: string;
|
|
70
70
|
icon: string;
|
|
71
71
|
description: string;
|
|
72
|
+
button?: boolean;
|
|
73
|
+
persistent?: boolean;
|
|
72
74
|
}
|
|
73
75
|
|
|
74
76
|
interface IFeedback {
|
|
@@ -104,6 +106,10 @@ interface IStep {
|
|
|
104
106
|
indent?: number;
|
|
105
107
|
}
|
|
106
108
|
|
|
109
|
+
interface IAskElementResponse {
|
|
110
|
+
submitted: boolean;
|
|
111
|
+
[key: string]: unknown;
|
|
112
|
+
}
|
|
107
113
|
interface FileSpec {
|
|
108
114
|
accept?: string[] | Record<string, string[]>;
|
|
109
115
|
max_size_mb?: number;
|
|
@@ -116,10 +122,12 @@ interface IFileRef {
|
|
|
116
122
|
id: string;
|
|
117
123
|
}
|
|
118
124
|
interface IAsk {
|
|
119
|
-
callback: (payload: IStep | IFileRef[] | IAction) => void;
|
|
125
|
+
callback: (payload: IStep | IFileRef[] | IAction | IAskElementResponse) => void;
|
|
120
126
|
spec: {
|
|
121
|
-
type: 'text' | 'file' | 'action';
|
|
127
|
+
type: 'text' | 'file' | 'action' | 'element';
|
|
128
|
+
step_id: string;
|
|
122
129
|
timeout: number;
|
|
130
|
+
element_id?: string;
|
|
123
131
|
} & FileSpec & ActionSpec;
|
|
124
132
|
parentId?: string;
|
|
125
133
|
}
|
|
@@ -165,6 +173,7 @@ interface IStarter {
|
|
|
165
173
|
label: string;
|
|
166
174
|
message: string;
|
|
167
175
|
icon?: string;
|
|
176
|
+
command?: string;
|
|
168
177
|
}
|
|
169
178
|
interface ChatProfile {
|
|
170
179
|
default: boolean;
|
|
@@ -183,25 +192,34 @@ interface IAuthConfig {
|
|
|
183
192
|
headerAuth: boolean;
|
|
184
193
|
oauthProviders: string[];
|
|
185
194
|
default_theme?: 'light' | 'dark';
|
|
195
|
+
ui?: IChainlitConfig['ui'];
|
|
186
196
|
}
|
|
187
197
|
interface IChainlitConfig {
|
|
188
198
|
markdown?: string;
|
|
189
199
|
ui: {
|
|
190
200
|
name: string;
|
|
191
201
|
description?: string;
|
|
192
|
-
font_family?: string;
|
|
193
202
|
default_theme?: 'light' | 'dark';
|
|
194
203
|
layout?: 'default' | 'wide';
|
|
204
|
+
default_sidebar_state?: 'open' | 'closed';
|
|
195
205
|
cot: 'hidden' | 'tool_call' | 'full';
|
|
196
206
|
github?: string;
|
|
197
207
|
custom_css?: string;
|
|
198
208
|
custom_js?: string;
|
|
199
209
|
custom_font?: string;
|
|
210
|
+
alert_style?: 'classic' | 'modern';
|
|
211
|
+
login_page_image?: string;
|
|
212
|
+
login_page_image_filter?: string;
|
|
213
|
+
login_page_image_dark_filter?: string;
|
|
200
214
|
custom_meta_image_url?: string;
|
|
215
|
+
logo_file_url?: string;
|
|
216
|
+
default_avatar_file_url?: string;
|
|
201
217
|
header_links?: {
|
|
202
218
|
name: string;
|
|
219
|
+
display_name: string;
|
|
203
220
|
icon_url: string;
|
|
204
221
|
url: string;
|
|
222
|
+
target?: '_blank' | '_self' | '_parent' | '_top';
|
|
205
223
|
}[];
|
|
206
224
|
};
|
|
207
225
|
features: {
|
|
@@ -213,18 +231,45 @@ interface IChainlitConfig {
|
|
|
213
231
|
};
|
|
214
232
|
audio: IAudioConfig;
|
|
215
233
|
unsafe_allow_html?: boolean;
|
|
234
|
+
user_message_autoscroll?: boolean;
|
|
216
235
|
latex?: boolean;
|
|
217
236
|
edit_message?: boolean;
|
|
237
|
+
mcp?: {
|
|
238
|
+
enabled?: boolean;
|
|
239
|
+
sse?: {
|
|
240
|
+
enabled?: boolean;
|
|
241
|
+
};
|
|
242
|
+
streamable_http?: {
|
|
243
|
+
enabled?: boolean;
|
|
244
|
+
};
|
|
245
|
+
stdio?: {
|
|
246
|
+
enabled?: boolean;
|
|
247
|
+
};
|
|
248
|
+
};
|
|
218
249
|
};
|
|
219
250
|
debugUrl?: string;
|
|
220
251
|
userEnv: string[];
|
|
252
|
+
maskUserEnv?: boolean;
|
|
221
253
|
dataPersistence: boolean;
|
|
222
254
|
threadResumable: boolean;
|
|
255
|
+
threadSharing?: boolean;
|
|
223
256
|
chatProfiles: ChatProfile[];
|
|
224
257
|
starters?: IStarter[];
|
|
225
258
|
translation: object;
|
|
226
259
|
}
|
|
227
260
|
|
|
261
|
+
interface IMcp {
|
|
262
|
+
name: string;
|
|
263
|
+
tools: [{
|
|
264
|
+
name: string;
|
|
265
|
+
}];
|
|
266
|
+
status: 'connected' | 'connecting' | 'failed';
|
|
267
|
+
clientType: 'sse' | 'stdio' | 'streamable-http';
|
|
268
|
+
command?: string;
|
|
269
|
+
url?: string;
|
|
270
|
+
headers?: Record<string, string>;
|
|
271
|
+
}
|
|
272
|
+
|
|
228
273
|
interface IToken {
|
|
229
274
|
id: number | string;
|
|
230
275
|
token: string;
|
|
@@ -248,7 +293,7 @@ declare const useChatData: () => {
|
|
|
248
293
|
|
|
249
294
|
type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
250
295
|
declare const useChatInteract: () => {
|
|
251
|
-
uploadFile: (file: File, onProgress: (progress: number) => void) => {
|
|
296
|
+
uploadFile: (file: File, onProgress: (progress: number) => void, parentId?: string) => {
|
|
252
297
|
xhr: XMLHttpRequest;
|
|
253
298
|
promise: Promise<{
|
|
254
299
|
id: string;
|
|
@@ -306,14 +351,16 @@ declare const threadHistoryState: recoil.RecoilState<ThreadHistory | undefined>;
|
|
|
306
351
|
declare const sideViewState: recoil.RecoilState<{
|
|
307
352
|
title: string;
|
|
308
353
|
elements: IMessageElement[];
|
|
354
|
+
key?: string | undefined;
|
|
309
355
|
} | undefined>;
|
|
310
356
|
declare const currentThreadIdState: recoil.RecoilState<string | undefined>;
|
|
357
|
+
declare const mcpState: recoil.RecoilState<IMcp[]>;
|
|
311
358
|
|
|
312
359
|
declare const useChatSession: () => {
|
|
313
360
|
connect: lodash.DebouncedFunc<({ transports, userEnv }: {
|
|
314
361
|
transports?: string[] | undefined;
|
|
315
362
|
userEnv: Record<string, string>;
|
|
316
|
-
}) => void
|
|
363
|
+
}) => Promise<void>>;
|
|
317
364
|
disconnect: () => void;
|
|
318
365
|
session: ISession | undefined;
|
|
319
366
|
sessionId: string;
|
|
@@ -379,9 +426,10 @@ type Payload = FormData | any;
|
|
|
379
426
|
declare class APIBase {
|
|
380
427
|
httpEndpoint: string;
|
|
381
428
|
type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord';
|
|
429
|
+
additionalQueryParams?: Record<string, string> | undefined;
|
|
382
430
|
on401?: (() => void) | undefined;
|
|
383
431
|
onError?: ((error: ClientError) => void) | undefined;
|
|
384
|
-
constructor(httpEndpoint: string, type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord', on401?: (() => void) | undefined, onError?: ((error: ClientError) => void) | undefined);
|
|
432
|
+
constructor(httpEndpoint: string, type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord', additionalQueryParams?: Record<string, string> | undefined, on401?: (() => void) | undefined, onError?: ((error: ClientError) => void) | undefined);
|
|
385
433
|
buildEndpoint(path: string): string;
|
|
386
434
|
private getDetailFromErrorResponse;
|
|
387
435
|
private handleRequestError;
|
|
@@ -398,10 +446,11 @@ declare class APIBase {
|
|
|
398
446
|
declare class ChainlitAPI extends APIBase {
|
|
399
447
|
headerAuth(): Promise<any>;
|
|
400
448
|
jwtAuth(token: string): Promise<any>;
|
|
449
|
+
stickyCookie(sessionId: string): Promise<any>;
|
|
401
450
|
passwordAuth(data: FormData): Promise<any>;
|
|
402
451
|
getUser(): Promise<IUser>;
|
|
403
452
|
logout(): Promise<any>;
|
|
404
|
-
setFeedback(feedback: IFeedback): Promise<{
|
|
453
|
+
setFeedback(feedback: IFeedback, sessionId: string): Promise<{
|
|
405
454
|
success: boolean;
|
|
406
455
|
feedbackId: string;
|
|
407
456
|
}>;
|
|
@@ -414,7 +463,7 @@ declare class ChainlitAPI extends APIBase {
|
|
|
414
463
|
}>;
|
|
415
464
|
renameThread(threadId: string, name: string): Promise<any>;
|
|
416
465
|
deleteThread(threadId: string): Promise<any>;
|
|
417
|
-
uploadFile(file: File, onProgress: (progress: number) => void, sessionId: string): {
|
|
466
|
+
uploadFile(file: File, onProgress: (progress: number) => void, sessionId: string, parentId?: string): {
|
|
418
467
|
xhr: XMLHttpRequest;
|
|
419
468
|
promise: Promise<{
|
|
420
469
|
id: string;
|
|
@@ -423,9 +472,16 @@ declare class ChainlitAPI extends APIBase {
|
|
|
423
472
|
callAction(action: IAction, sessionId: string): Promise<any>;
|
|
424
473
|
updateElement(element: IElement, sessionId: string): Promise<any>;
|
|
425
474
|
deleteElement(element: IElement, sessionId: string): Promise<any>;
|
|
475
|
+
connectStdioMCP(sessionId: string, name: string, fullCommand: string): Promise<any>;
|
|
476
|
+
connectSseMCP(sessionId: string, name: string, url: string, headers?: Record<string, string>): Promise<any>;
|
|
477
|
+
connectStreamableHttpMCP(sessionId: string, name: string, url: string, headers?: Record<string, string>): Promise<any>;
|
|
478
|
+
disconnectMcp(sessionId: string, name: string): Promise<any>;
|
|
426
479
|
getElementUrl(id: string, sessionId: string): string;
|
|
427
|
-
getLogoEndpoint(theme: string): string;
|
|
480
|
+
getLogoEndpoint(theme: string, configuredLogoUrl?: string): string;
|
|
428
481
|
getOAuthEndpoint(provider: string): string;
|
|
482
|
+
shareThread(threadId: string, isShared: boolean): Promise<{
|
|
483
|
+
success: boolean;
|
|
484
|
+
}>;
|
|
429
485
|
}
|
|
430
486
|
|
|
431
487
|
declare const defaultChainlitContext: undefined;
|
|
@@ -444,4 +500,4 @@ declare const WavRenderer: {
|
|
|
444
500
|
drawBars: (ctx: CanvasRenderingContext2D, data: Float32Array, cssWidth: number, cssHeight: number, color: string, pointCount?: number, barWidth?: number, barSpacing?: number, center?: boolean) => void;
|
|
445
501
|
};
|
|
446
502
|
|
|
447
|
-
export { APIBase, ActionSpec, AuthProvider, ChainlitAPI, ChainlitContext, ChatProfile, ClientError, ElementType, FileSpec, IAction, IAsk, IAudioConfig, IAudioElement, IAuthConfig, ICallFn, IChainlitConfig, ICommand, ICustomElement, IDataframeElement, IElement, IElementSize, IFeedback, IFileElement, IFileRef, IImageElement, IMessageElement, IPageInfo, IPagination, IPdfElement, IPlotlyElement, ISession, IStarter, IStep, ITasklistElement, ITextElement, IThread, IThreadFilters, IToken, IUser, IUserMetadata, IVideoElement, ThreadHistory, UserInput, WavRenderer, actionState, addMessage, addMessageToParent, askUserState, audioConnectionState, authState, callFnState, chatProfileState, chatSettingsDefaultValueSelector, chatSettingsInputsState, chatSettingsValueState, commandsState, configState, currentThreadIdState, defaultChainlitContext, deleteMessageById, elementState, fetcher, firstUserInteraction, hasMessageById, isAiSpeakingState, isLastMessage, loadingState, messagesState, nestMessages, resumeThreadErrorState, sessionIdState, sessionState, sideViewState, tasklistState, threadHistoryState, threadIdToResumeState, tokenCountState, updateMessageById, updateMessageContentById, useApi, useAudio, useAuth, useChatData, useChatInteract, useChatMessages, useChatSession, useConfig, userState, wavRecorderState, wavStreamPlayerState };
|
|
503
|
+
export { APIBase, ActionSpec, AuthProvider, ChainlitAPI, ChainlitContext, ChatProfile, ClientError, ElementType, FileSpec, IAction, IAsk, IAskElementResponse, IAudioConfig, IAudioElement, IAuthConfig, ICallFn, IChainlitConfig, ICommand, ICustomElement, IDataframeElement, IElement, IElementSize, IFeedback, IFileElement, IFileRef, IImageElement, IMcp, IMessageElement, IPageInfo, IPagination, IPdfElement, IPlotlyElement, ISession, IStarter, IStep, ITasklistElement, ITextElement, IThread, IThreadFilters, IToken, IUser, IUserMetadata, IVideoElement, ThreadHistory, UserInput, WavRenderer, actionState, addMessage, addMessageToParent, askUserState, audioConnectionState, authState, callFnState, chatProfileState, chatSettingsDefaultValueSelector, chatSettingsInputsState, chatSettingsValueState, commandsState, configState, currentThreadIdState, defaultChainlitContext, deleteMessageById, elementState, fetcher, firstUserInteraction, hasMessageById, isAiSpeakingState, isLastMessage, loadingState, mcpState, messagesState, nestMessages, resumeThreadErrorState, sessionIdState, sessionState, sideViewState, tasklistState, threadHistoryState, threadIdToResumeState, tokenCountState, updateMessageById, updateMessageContentById, useApi, useAudio, useAuth, useChatData, useChatInteract, useChatMessages, useChatSession, useConfig, userState, wavRecorderState, wavStreamPlayerState };
|
package/dist/index.d.ts
CHANGED
|
@@ -69,6 +69,8 @@ interface ICommand {
|
|
|
69
69
|
id: string;
|
|
70
70
|
icon: string;
|
|
71
71
|
description: string;
|
|
72
|
+
button?: boolean;
|
|
73
|
+
persistent?: boolean;
|
|
72
74
|
}
|
|
73
75
|
|
|
74
76
|
interface IFeedback {
|
|
@@ -104,6 +106,10 @@ interface IStep {
|
|
|
104
106
|
indent?: number;
|
|
105
107
|
}
|
|
106
108
|
|
|
109
|
+
interface IAskElementResponse {
|
|
110
|
+
submitted: boolean;
|
|
111
|
+
[key: string]: unknown;
|
|
112
|
+
}
|
|
107
113
|
interface FileSpec {
|
|
108
114
|
accept?: string[] | Record<string, string[]>;
|
|
109
115
|
max_size_mb?: number;
|
|
@@ -116,10 +122,12 @@ interface IFileRef {
|
|
|
116
122
|
id: string;
|
|
117
123
|
}
|
|
118
124
|
interface IAsk {
|
|
119
|
-
callback: (payload: IStep | IFileRef[] | IAction) => void;
|
|
125
|
+
callback: (payload: IStep | IFileRef[] | IAction | IAskElementResponse) => void;
|
|
120
126
|
spec: {
|
|
121
|
-
type: 'text' | 'file' | 'action';
|
|
127
|
+
type: 'text' | 'file' | 'action' | 'element';
|
|
128
|
+
step_id: string;
|
|
122
129
|
timeout: number;
|
|
130
|
+
element_id?: string;
|
|
123
131
|
} & FileSpec & ActionSpec;
|
|
124
132
|
parentId?: string;
|
|
125
133
|
}
|
|
@@ -165,6 +173,7 @@ interface IStarter {
|
|
|
165
173
|
label: string;
|
|
166
174
|
message: string;
|
|
167
175
|
icon?: string;
|
|
176
|
+
command?: string;
|
|
168
177
|
}
|
|
169
178
|
interface ChatProfile {
|
|
170
179
|
default: boolean;
|
|
@@ -183,25 +192,34 @@ interface IAuthConfig {
|
|
|
183
192
|
headerAuth: boolean;
|
|
184
193
|
oauthProviders: string[];
|
|
185
194
|
default_theme?: 'light' | 'dark';
|
|
195
|
+
ui?: IChainlitConfig['ui'];
|
|
186
196
|
}
|
|
187
197
|
interface IChainlitConfig {
|
|
188
198
|
markdown?: string;
|
|
189
199
|
ui: {
|
|
190
200
|
name: string;
|
|
191
201
|
description?: string;
|
|
192
|
-
font_family?: string;
|
|
193
202
|
default_theme?: 'light' | 'dark';
|
|
194
203
|
layout?: 'default' | 'wide';
|
|
204
|
+
default_sidebar_state?: 'open' | 'closed';
|
|
195
205
|
cot: 'hidden' | 'tool_call' | 'full';
|
|
196
206
|
github?: string;
|
|
197
207
|
custom_css?: string;
|
|
198
208
|
custom_js?: string;
|
|
199
209
|
custom_font?: string;
|
|
210
|
+
alert_style?: 'classic' | 'modern';
|
|
211
|
+
login_page_image?: string;
|
|
212
|
+
login_page_image_filter?: string;
|
|
213
|
+
login_page_image_dark_filter?: string;
|
|
200
214
|
custom_meta_image_url?: string;
|
|
215
|
+
logo_file_url?: string;
|
|
216
|
+
default_avatar_file_url?: string;
|
|
201
217
|
header_links?: {
|
|
202
218
|
name: string;
|
|
219
|
+
display_name: string;
|
|
203
220
|
icon_url: string;
|
|
204
221
|
url: string;
|
|
222
|
+
target?: '_blank' | '_self' | '_parent' | '_top';
|
|
205
223
|
}[];
|
|
206
224
|
};
|
|
207
225
|
features: {
|
|
@@ -213,18 +231,45 @@ interface IChainlitConfig {
|
|
|
213
231
|
};
|
|
214
232
|
audio: IAudioConfig;
|
|
215
233
|
unsafe_allow_html?: boolean;
|
|
234
|
+
user_message_autoscroll?: boolean;
|
|
216
235
|
latex?: boolean;
|
|
217
236
|
edit_message?: boolean;
|
|
237
|
+
mcp?: {
|
|
238
|
+
enabled?: boolean;
|
|
239
|
+
sse?: {
|
|
240
|
+
enabled?: boolean;
|
|
241
|
+
};
|
|
242
|
+
streamable_http?: {
|
|
243
|
+
enabled?: boolean;
|
|
244
|
+
};
|
|
245
|
+
stdio?: {
|
|
246
|
+
enabled?: boolean;
|
|
247
|
+
};
|
|
248
|
+
};
|
|
218
249
|
};
|
|
219
250
|
debugUrl?: string;
|
|
220
251
|
userEnv: string[];
|
|
252
|
+
maskUserEnv?: boolean;
|
|
221
253
|
dataPersistence: boolean;
|
|
222
254
|
threadResumable: boolean;
|
|
255
|
+
threadSharing?: boolean;
|
|
223
256
|
chatProfiles: ChatProfile[];
|
|
224
257
|
starters?: IStarter[];
|
|
225
258
|
translation: object;
|
|
226
259
|
}
|
|
227
260
|
|
|
261
|
+
interface IMcp {
|
|
262
|
+
name: string;
|
|
263
|
+
tools: [{
|
|
264
|
+
name: string;
|
|
265
|
+
}];
|
|
266
|
+
status: 'connected' | 'connecting' | 'failed';
|
|
267
|
+
clientType: 'sse' | 'stdio' | 'streamable-http';
|
|
268
|
+
command?: string;
|
|
269
|
+
url?: string;
|
|
270
|
+
headers?: Record<string, string>;
|
|
271
|
+
}
|
|
272
|
+
|
|
228
273
|
interface IToken {
|
|
229
274
|
id: number | string;
|
|
230
275
|
token: string;
|
|
@@ -248,7 +293,7 @@ declare const useChatData: () => {
|
|
|
248
293
|
|
|
249
294
|
type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
250
295
|
declare const useChatInteract: () => {
|
|
251
|
-
uploadFile: (file: File, onProgress: (progress: number) => void) => {
|
|
296
|
+
uploadFile: (file: File, onProgress: (progress: number) => void, parentId?: string) => {
|
|
252
297
|
xhr: XMLHttpRequest;
|
|
253
298
|
promise: Promise<{
|
|
254
299
|
id: string;
|
|
@@ -306,14 +351,16 @@ declare const threadHistoryState: recoil.RecoilState<ThreadHistory | undefined>;
|
|
|
306
351
|
declare const sideViewState: recoil.RecoilState<{
|
|
307
352
|
title: string;
|
|
308
353
|
elements: IMessageElement[];
|
|
354
|
+
key?: string | undefined;
|
|
309
355
|
} | undefined>;
|
|
310
356
|
declare const currentThreadIdState: recoil.RecoilState<string | undefined>;
|
|
357
|
+
declare const mcpState: recoil.RecoilState<IMcp[]>;
|
|
311
358
|
|
|
312
359
|
declare const useChatSession: () => {
|
|
313
360
|
connect: lodash.DebouncedFunc<({ transports, userEnv }: {
|
|
314
361
|
transports?: string[] | undefined;
|
|
315
362
|
userEnv: Record<string, string>;
|
|
316
|
-
}) => void
|
|
363
|
+
}) => Promise<void>>;
|
|
317
364
|
disconnect: () => void;
|
|
318
365
|
session: ISession | undefined;
|
|
319
366
|
sessionId: string;
|
|
@@ -379,9 +426,10 @@ type Payload = FormData | any;
|
|
|
379
426
|
declare class APIBase {
|
|
380
427
|
httpEndpoint: string;
|
|
381
428
|
type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord';
|
|
429
|
+
additionalQueryParams?: Record<string, string> | undefined;
|
|
382
430
|
on401?: (() => void) | undefined;
|
|
383
431
|
onError?: ((error: ClientError) => void) | undefined;
|
|
384
|
-
constructor(httpEndpoint: string, type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord', on401?: (() => void) | undefined, onError?: ((error: ClientError) => void) | undefined);
|
|
432
|
+
constructor(httpEndpoint: string, type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord', additionalQueryParams?: Record<string, string> | undefined, on401?: (() => void) | undefined, onError?: ((error: ClientError) => void) | undefined);
|
|
385
433
|
buildEndpoint(path: string): string;
|
|
386
434
|
private getDetailFromErrorResponse;
|
|
387
435
|
private handleRequestError;
|
|
@@ -398,10 +446,11 @@ declare class APIBase {
|
|
|
398
446
|
declare class ChainlitAPI extends APIBase {
|
|
399
447
|
headerAuth(): Promise<any>;
|
|
400
448
|
jwtAuth(token: string): Promise<any>;
|
|
449
|
+
stickyCookie(sessionId: string): Promise<any>;
|
|
401
450
|
passwordAuth(data: FormData): Promise<any>;
|
|
402
451
|
getUser(): Promise<IUser>;
|
|
403
452
|
logout(): Promise<any>;
|
|
404
|
-
setFeedback(feedback: IFeedback): Promise<{
|
|
453
|
+
setFeedback(feedback: IFeedback, sessionId: string): Promise<{
|
|
405
454
|
success: boolean;
|
|
406
455
|
feedbackId: string;
|
|
407
456
|
}>;
|
|
@@ -414,7 +463,7 @@ declare class ChainlitAPI extends APIBase {
|
|
|
414
463
|
}>;
|
|
415
464
|
renameThread(threadId: string, name: string): Promise<any>;
|
|
416
465
|
deleteThread(threadId: string): Promise<any>;
|
|
417
|
-
uploadFile(file: File, onProgress: (progress: number) => void, sessionId: string): {
|
|
466
|
+
uploadFile(file: File, onProgress: (progress: number) => void, sessionId: string, parentId?: string): {
|
|
418
467
|
xhr: XMLHttpRequest;
|
|
419
468
|
promise: Promise<{
|
|
420
469
|
id: string;
|
|
@@ -423,9 +472,16 @@ declare class ChainlitAPI extends APIBase {
|
|
|
423
472
|
callAction(action: IAction, sessionId: string): Promise<any>;
|
|
424
473
|
updateElement(element: IElement, sessionId: string): Promise<any>;
|
|
425
474
|
deleteElement(element: IElement, sessionId: string): Promise<any>;
|
|
475
|
+
connectStdioMCP(sessionId: string, name: string, fullCommand: string): Promise<any>;
|
|
476
|
+
connectSseMCP(sessionId: string, name: string, url: string, headers?: Record<string, string>): Promise<any>;
|
|
477
|
+
connectStreamableHttpMCP(sessionId: string, name: string, url: string, headers?: Record<string, string>): Promise<any>;
|
|
478
|
+
disconnectMcp(sessionId: string, name: string): Promise<any>;
|
|
426
479
|
getElementUrl(id: string, sessionId: string): string;
|
|
427
|
-
getLogoEndpoint(theme: string): string;
|
|
480
|
+
getLogoEndpoint(theme: string, configuredLogoUrl?: string): string;
|
|
428
481
|
getOAuthEndpoint(provider: string): string;
|
|
482
|
+
shareThread(threadId: string, isShared: boolean): Promise<{
|
|
483
|
+
success: boolean;
|
|
484
|
+
}>;
|
|
429
485
|
}
|
|
430
486
|
|
|
431
487
|
declare const defaultChainlitContext: undefined;
|
|
@@ -444,4 +500,4 @@ declare const WavRenderer: {
|
|
|
444
500
|
drawBars: (ctx: CanvasRenderingContext2D, data: Float32Array, cssWidth: number, cssHeight: number, color: string, pointCount?: number, barWidth?: number, barSpacing?: number, center?: boolean) => void;
|
|
445
501
|
};
|
|
446
502
|
|
|
447
|
-
export { APIBase, ActionSpec, AuthProvider, ChainlitAPI, ChainlitContext, ChatProfile, ClientError, ElementType, FileSpec, IAction, IAsk, IAudioConfig, IAudioElement, IAuthConfig, ICallFn, IChainlitConfig, ICommand, ICustomElement, IDataframeElement, IElement, IElementSize, IFeedback, IFileElement, IFileRef, IImageElement, IMessageElement, IPageInfo, IPagination, IPdfElement, IPlotlyElement, ISession, IStarter, IStep, ITasklistElement, ITextElement, IThread, IThreadFilters, IToken, IUser, IUserMetadata, IVideoElement, ThreadHistory, UserInput, WavRenderer, actionState, addMessage, addMessageToParent, askUserState, audioConnectionState, authState, callFnState, chatProfileState, chatSettingsDefaultValueSelector, chatSettingsInputsState, chatSettingsValueState, commandsState, configState, currentThreadIdState, defaultChainlitContext, deleteMessageById, elementState, fetcher, firstUserInteraction, hasMessageById, isAiSpeakingState, isLastMessage, loadingState, messagesState, nestMessages, resumeThreadErrorState, sessionIdState, sessionState, sideViewState, tasklistState, threadHistoryState, threadIdToResumeState, tokenCountState, updateMessageById, updateMessageContentById, useApi, useAudio, useAuth, useChatData, useChatInteract, useChatMessages, useChatSession, useConfig, userState, wavRecorderState, wavStreamPlayerState };
|
|
503
|
+
export { APIBase, ActionSpec, AuthProvider, ChainlitAPI, ChainlitContext, ChatProfile, ClientError, ElementType, FileSpec, IAction, IAsk, IAskElementResponse, IAudioConfig, IAudioElement, IAuthConfig, ICallFn, IChainlitConfig, ICommand, ICustomElement, IDataframeElement, IElement, IElementSize, IFeedback, IFileElement, IFileRef, IImageElement, IMcp, IMessageElement, IPageInfo, IPagination, IPdfElement, IPlotlyElement, ISession, IStarter, IStep, ITasklistElement, ITextElement, IThread, IThreadFilters, IToken, IUser, IUserMetadata, IVideoElement, ThreadHistory, UserInput, WavRenderer, actionState, addMessage, addMessageToParent, askUserState, audioConnectionState, authState, callFnState, chatProfileState, chatSettingsDefaultValueSelector, chatSettingsInputsState, chatSettingsValueState, commandsState, configState, currentThreadIdState, defaultChainlitContext, deleteMessageById, elementState, fetcher, firstUserInteraction, hasMessageById, isAiSpeakingState, isLastMessage, loadingState, mcpState, messagesState, nestMessages, resumeThreadErrorState, sessionIdState, sessionState, sideViewState, tasklistState, threadHistoryState, threadIdToResumeState, tokenCountState, updateMessageById, updateMessageContentById, useApi, useAudio, useAuth, useChatData, useChatInteract, useChatMessages, useChatSession, useConfig, userState, wavRecorderState, wavStreamPlayerState };
|