@chainlit/react-client 0.2.4 → 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 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
@@ -70,6 +70,7 @@ interface ICommand {
70
70
  icon: string;
71
71
  description: string;
72
72
  button?: boolean;
73
+ persistent?: boolean;
73
74
  }
74
75
 
75
76
  interface IFeedback {
@@ -105,6 +106,10 @@ interface IStep {
105
106
  indent?: number;
106
107
  }
107
108
 
109
+ interface IAskElementResponse {
110
+ submitted: boolean;
111
+ [key: string]: unknown;
112
+ }
108
113
  interface FileSpec {
109
114
  accept?: string[] | Record<string, string[]>;
110
115
  max_size_mb?: number;
@@ -117,11 +122,12 @@ interface IFileRef {
117
122
  id: string;
118
123
  }
119
124
  interface IAsk {
120
- callback: (payload: IStep | IFileRef[] | IAction) => void;
125
+ callback: (payload: IStep | IFileRef[] | IAction | IAskElementResponse) => void;
121
126
  spec: {
122
- type: 'text' | 'file' | 'action';
127
+ type: 'text' | 'file' | 'action' | 'element';
123
128
  step_id: string;
124
129
  timeout: number;
130
+ element_id?: string;
125
131
  } & FileSpec & ActionSpec;
126
132
  parentId?: string;
127
133
  }
@@ -167,6 +173,7 @@ interface IStarter {
167
173
  label: string;
168
174
  message: string;
169
175
  icon?: string;
176
+ command?: string;
170
177
  }
171
178
  interface ChatProfile {
172
179
  default: boolean;
@@ -185,25 +192,34 @@ interface IAuthConfig {
185
192
  headerAuth: boolean;
186
193
  oauthProviders: string[];
187
194
  default_theme?: 'light' | 'dark';
195
+ ui?: IChainlitConfig['ui'];
188
196
  }
189
197
  interface IChainlitConfig {
190
198
  markdown?: string;
191
199
  ui: {
192
200
  name: string;
193
201
  description?: string;
194
- font_family?: string;
195
202
  default_theme?: 'light' | 'dark';
196
203
  layout?: 'default' | 'wide';
204
+ default_sidebar_state?: 'open' | 'closed';
197
205
  cot: 'hidden' | 'tool_call' | 'full';
198
206
  github?: string;
199
207
  custom_css?: string;
200
208
  custom_js?: string;
201
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;
202
214
  custom_meta_image_url?: string;
215
+ logo_file_url?: string;
216
+ default_avatar_file_url?: string;
203
217
  header_links?: {
204
218
  name: string;
219
+ display_name: string;
205
220
  icon_url: string;
206
221
  url: string;
222
+ target?: '_blank' | '_self' | '_parent' | '_top';
207
223
  }[];
208
224
  };
209
225
  features: {
@@ -218,12 +234,25 @@ interface IChainlitConfig {
218
234
  user_message_autoscroll?: boolean;
219
235
  latex?: boolean;
220
236
  edit_message?: boolean;
221
- mcp?: 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
+ };
222
249
  };
223
250
  debugUrl?: string;
224
251
  userEnv: string[];
252
+ maskUserEnv?: boolean;
225
253
  dataPersistence: boolean;
226
254
  threadResumable: boolean;
255
+ threadSharing?: boolean;
227
256
  chatProfiles: ChatProfile[];
228
257
  starters?: IStarter[];
229
258
  translation: object;
@@ -235,9 +264,10 @@ interface IMcp {
235
264
  name: string;
236
265
  }];
237
266
  status: 'connected' | 'connecting' | 'failed';
238
- clientType: 'sse' | 'stdio';
267
+ clientType: 'sse' | 'stdio' | 'streamable-http';
239
268
  command?: string;
240
269
  url?: string;
270
+ headers?: Record<string, string>;
241
271
  }
242
272
 
243
273
  interface IToken {
@@ -263,7 +293,7 @@ declare const useChatData: () => {
263
293
 
264
294
  type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
265
295
  declare const useChatInteract: () => {
266
- uploadFile: (file: File, onProgress: (progress: number) => void) => {
296
+ uploadFile: (file: File, onProgress: (progress: number) => void, parentId?: string) => {
267
297
  xhr: XMLHttpRequest;
268
298
  promise: Promise<{
269
299
  id: string;
@@ -321,6 +351,7 @@ declare const threadHistoryState: recoil.RecoilState<ThreadHistory | undefined>;
321
351
  declare const sideViewState: recoil.RecoilState<{
322
352
  title: string;
323
353
  elements: IMessageElement[];
354
+ key?: string | undefined;
324
355
  } | undefined>;
325
356
  declare const currentThreadIdState: recoil.RecoilState<string | undefined>;
326
357
  declare const mcpState: recoil.RecoilState<IMcp[]>;
@@ -329,7 +360,7 @@ declare const useChatSession: () => {
329
360
  connect: lodash.DebouncedFunc<({ transports, userEnv }: {
330
361
  transports?: string[] | undefined;
331
362
  userEnv: Record<string, string>;
332
- }) => void>;
363
+ }) => Promise<void>>;
333
364
  disconnect: () => void;
334
365
  session: ISession | undefined;
335
366
  sessionId: string;
@@ -395,9 +426,10 @@ type Payload = FormData | any;
395
426
  declare class APIBase {
396
427
  httpEndpoint: string;
397
428
  type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord';
429
+ additionalQueryParams?: Record<string, string> | undefined;
398
430
  on401?: (() => void) | undefined;
399
431
  onError?: ((error: ClientError) => void) | undefined;
400
- 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);
401
433
  buildEndpoint(path: string): string;
402
434
  private getDetailFromErrorResponse;
403
435
  private handleRequestError;
@@ -414,10 +446,11 @@ declare class APIBase {
414
446
  declare class ChainlitAPI extends APIBase {
415
447
  headerAuth(): Promise<any>;
416
448
  jwtAuth(token: string): Promise<any>;
449
+ stickyCookie(sessionId: string): Promise<any>;
417
450
  passwordAuth(data: FormData): Promise<any>;
418
451
  getUser(): Promise<IUser>;
419
452
  logout(): Promise<any>;
420
- setFeedback(feedback: IFeedback): Promise<{
453
+ setFeedback(feedback: IFeedback, sessionId: string): Promise<{
421
454
  success: boolean;
422
455
  feedbackId: string;
423
456
  }>;
@@ -430,7 +463,7 @@ declare class ChainlitAPI extends APIBase {
430
463
  }>;
431
464
  renameThread(threadId: string, name: string): Promise<any>;
432
465
  deleteThread(threadId: string): Promise<any>;
433
- uploadFile(file: File, onProgress: (progress: number) => void, sessionId: string): {
466
+ uploadFile(file: File, onProgress: (progress: number) => void, sessionId: string, parentId?: string): {
434
467
  xhr: XMLHttpRequest;
435
468
  promise: Promise<{
436
469
  id: string;
@@ -440,11 +473,15 @@ declare class ChainlitAPI extends APIBase {
440
473
  updateElement(element: IElement, sessionId: string): Promise<any>;
441
474
  deleteElement(element: IElement, sessionId: string): Promise<any>;
442
475
  connectStdioMCP(sessionId: string, name: string, fullCommand: string): Promise<any>;
443
- connectSseMCP(sessionId: string, name: string, url: 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>;
444
478
  disconnectMcp(sessionId: string, name: string): Promise<any>;
445
479
  getElementUrl(id: string, sessionId: string): string;
446
- getLogoEndpoint(theme: string): string;
480
+ getLogoEndpoint(theme: string, configuredLogoUrl?: string): string;
447
481
  getOAuthEndpoint(provider: string): string;
482
+ shareThread(threadId: string, isShared: boolean): Promise<{
483
+ success: boolean;
484
+ }>;
448
485
  }
449
486
 
450
487
  declare const defaultChainlitContext: undefined;
@@ -463,4 +500,4 @@ declare const WavRenderer: {
463
500
  drawBars: (ctx: CanvasRenderingContext2D, data: Float32Array, cssWidth: number, cssHeight: number, color: string, pointCount?: number, barWidth?: number, barSpacing?: number, center?: boolean) => void;
464
501
  };
465
502
 
466
- 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, 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 };
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
@@ -70,6 +70,7 @@ interface ICommand {
70
70
  icon: string;
71
71
  description: string;
72
72
  button?: boolean;
73
+ persistent?: boolean;
73
74
  }
74
75
 
75
76
  interface IFeedback {
@@ -105,6 +106,10 @@ interface IStep {
105
106
  indent?: number;
106
107
  }
107
108
 
109
+ interface IAskElementResponse {
110
+ submitted: boolean;
111
+ [key: string]: unknown;
112
+ }
108
113
  interface FileSpec {
109
114
  accept?: string[] | Record<string, string[]>;
110
115
  max_size_mb?: number;
@@ -117,11 +122,12 @@ interface IFileRef {
117
122
  id: string;
118
123
  }
119
124
  interface IAsk {
120
- callback: (payload: IStep | IFileRef[] | IAction) => void;
125
+ callback: (payload: IStep | IFileRef[] | IAction | IAskElementResponse) => void;
121
126
  spec: {
122
- type: 'text' | 'file' | 'action';
127
+ type: 'text' | 'file' | 'action' | 'element';
123
128
  step_id: string;
124
129
  timeout: number;
130
+ element_id?: string;
125
131
  } & FileSpec & ActionSpec;
126
132
  parentId?: string;
127
133
  }
@@ -167,6 +173,7 @@ interface IStarter {
167
173
  label: string;
168
174
  message: string;
169
175
  icon?: string;
176
+ command?: string;
170
177
  }
171
178
  interface ChatProfile {
172
179
  default: boolean;
@@ -185,25 +192,34 @@ interface IAuthConfig {
185
192
  headerAuth: boolean;
186
193
  oauthProviders: string[];
187
194
  default_theme?: 'light' | 'dark';
195
+ ui?: IChainlitConfig['ui'];
188
196
  }
189
197
  interface IChainlitConfig {
190
198
  markdown?: string;
191
199
  ui: {
192
200
  name: string;
193
201
  description?: string;
194
- font_family?: string;
195
202
  default_theme?: 'light' | 'dark';
196
203
  layout?: 'default' | 'wide';
204
+ default_sidebar_state?: 'open' | 'closed';
197
205
  cot: 'hidden' | 'tool_call' | 'full';
198
206
  github?: string;
199
207
  custom_css?: string;
200
208
  custom_js?: string;
201
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;
202
214
  custom_meta_image_url?: string;
215
+ logo_file_url?: string;
216
+ default_avatar_file_url?: string;
203
217
  header_links?: {
204
218
  name: string;
219
+ display_name: string;
205
220
  icon_url: string;
206
221
  url: string;
222
+ target?: '_blank' | '_self' | '_parent' | '_top';
207
223
  }[];
208
224
  };
209
225
  features: {
@@ -218,12 +234,25 @@ interface IChainlitConfig {
218
234
  user_message_autoscroll?: boolean;
219
235
  latex?: boolean;
220
236
  edit_message?: boolean;
221
- mcp?: 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
+ };
222
249
  };
223
250
  debugUrl?: string;
224
251
  userEnv: string[];
252
+ maskUserEnv?: boolean;
225
253
  dataPersistence: boolean;
226
254
  threadResumable: boolean;
255
+ threadSharing?: boolean;
227
256
  chatProfiles: ChatProfile[];
228
257
  starters?: IStarter[];
229
258
  translation: object;
@@ -235,9 +264,10 @@ interface IMcp {
235
264
  name: string;
236
265
  }];
237
266
  status: 'connected' | 'connecting' | 'failed';
238
- clientType: 'sse' | 'stdio';
267
+ clientType: 'sse' | 'stdio' | 'streamable-http';
239
268
  command?: string;
240
269
  url?: string;
270
+ headers?: Record<string, string>;
241
271
  }
242
272
 
243
273
  interface IToken {
@@ -263,7 +293,7 @@ declare const useChatData: () => {
263
293
 
264
294
  type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
265
295
  declare const useChatInteract: () => {
266
- uploadFile: (file: File, onProgress: (progress: number) => void) => {
296
+ uploadFile: (file: File, onProgress: (progress: number) => void, parentId?: string) => {
267
297
  xhr: XMLHttpRequest;
268
298
  promise: Promise<{
269
299
  id: string;
@@ -321,6 +351,7 @@ declare const threadHistoryState: recoil.RecoilState<ThreadHistory | undefined>;
321
351
  declare const sideViewState: recoil.RecoilState<{
322
352
  title: string;
323
353
  elements: IMessageElement[];
354
+ key?: string | undefined;
324
355
  } | undefined>;
325
356
  declare const currentThreadIdState: recoil.RecoilState<string | undefined>;
326
357
  declare const mcpState: recoil.RecoilState<IMcp[]>;
@@ -329,7 +360,7 @@ declare const useChatSession: () => {
329
360
  connect: lodash.DebouncedFunc<({ transports, userEnv }: {
330
361
  transports?: string[] | undefined;
331
362
  userEnv: Record<string, string>;
332
- }) => void>;
363
+ }) => Promise<void>>;
333
364
  disconnect: () => void;
334
365
  session: ISession | undefined;
335
366
  sessionId: string;
@@ -395,9 +426,10 @@ type Payload = FormData | any;
395
426
  declare class APIBase {
396
427
  httpEndpoint: string;
397
428
  type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord';
429
+ additionalQueryParams?: Record<string, string> | undefined;
398
430
  on401?: (() => void) | undefined;
399
431
  onError?: ((error: ClientError) => void) | undefined;
400
- 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);
401
433
  buildEndpoint(path: string): string;
402
434
  private getDetailFromErrorResponse;
403
435
  private handleRequestError;
@@ -414,10 +446,11 @@ declare class APIBase {
414
446
  declare class ChainlitAPI extends APIBase {
415
447
  headerAuth(): Promise<any>;
416
448
  jwtAuth(token: string): Promise<any>;
449
+ stickyCookie(sessionId: string): Promise<any>;
417
450
  passwordAuth(data: FormData): Promise<any>;
418
451
  getUser(): Promise<IUser>;
419
452
  logout(): Promise<any>;
420
- setFeedback(feedback: IFeedback): Promise<{
453
+ setFeedback(feedback: IFeedback, sessionId: string): Promise<{
421
454
  success: boolean;
422
455
  feedbackId: string;
423
456
  }>;
@@ -430,7 +463,7 @@ declare class ChainlitAPI extends APIBase {
430
463
  }>;
431
464
  renameThread(threadId: string, name: string): Promise<any>;
432
465
  deleteThread(threadId: string): Promise<any>;
433
- uploadFile(file: File, onProgress: (progress: number) => void, sessionId: string): {
466
+ uploadFile(file: File, onProgress: (progress: number) => void, sessionId: string, parentId?: string): {
434
467
  xhr: XMLHttpRequest;
435
468
  promise: Promise<{
436
469
  id: string;
@@ -440,11 +473,15 @@ declare class ChainlitAPI extends APIBase {
440
473
  updateElement(element: IElement, sessionId: string): Promise<any>;
441
474
  deleteElement(element: IElement, sessionId: string): Promise<any>;
442
475
  connectStdioMCP(sessionId: string, name: string, fullCommand: string): Promise<any>;
443
- connectSseMCP(sessionId: string, name: string, url: 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>;
444
478
  disconnectMcp(sessionId: string, name: string): Promise<any>;
445
479
  getElementUrl(id: string, sessionId: string): string;
446
- getLogoEndpoint(theme: string): string;
480
+ getLogoEndpoint(theme: string, configuredLogoUrl?: string): string;
447
481
  getOAuthEndpoint(provider: string): string;
482
+ shareThread(threadId: string, isShared: boolean): Promise<{
483
+ success: boolean;
484
+ }>;
448
485
  }
449
486
 
450
487
  declare const defaultChainlitContext: undefined;
@@ -463,4 +500,4 @@ declare const WavRenderer: {
463
500
  drawBars: (ctx: CanvasRenderingContext2D, data: Float32Array, cssWidth: number, cssHeight: number, color: string, pointCount?: number, barWidth?: number, barSpacing?: number, center?: boolean) => void;
464
501
  };
465
502
 
466
- 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, 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 };
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 };