@chainlit/react-client 0.2.4 → 0.3.1

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2023- The Chainlit team. All rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.mts

@@ -70,6 +70,20 @@ interface ICommand {
     icon: string;
     description: string;
     button?: boolean;
+    persistent?: boolean;
+}
+
+interface IModeOption {
+    id: string;
+    name: string;
+    description?: string;
+    icon?: string;
+    default?: boolean;
+}
+interface IMode {
+    id: string;
+    name: string;
+    options: IModeOption[];
 }
 
 interface IFeedback {
@@ -89,6 +103,7 @@ interface IStep {
     parentId?: string;
     isError?: boolean;
     command?: string;
+    modes?: Record<string, string>;
     showInput?: boolean | string;
     waitForAnswer?: boolean;
     input?: string;
@@ -105,6 +120,10 @@ interface IStep {
     indent?: number;
 }
 
+interface IAskElementResponse {
+    submitted: boolean;
+    [key: string]: unknown;
+}
 interface FileSpec {
     accept?: string[] | Record<string, string[]>;
     max_size_mb?: number;
@@ -117,11 +136,12 @@ interface IFileRef {
     id: string;
 }
 interface IAsk {
-    callback: (payload: IStep | IFileRef[] | IAction) => void;
+    callback: (payload: IStep | IFileRef[] | IAction | IAskElementResponse) => void;
     spec: {
-        type: 'text' | 'file' | 'action';
+        type: 'text' | 'file' | 'action' | 'element';
         step_id: string;
         timeout: number;
+        element_id?: string;
     } & FileSpec & ActionSpec;
     parentId?: string;
 }
@@ -167,11 +187,13 @@ interface IStarter {
     label: string;
     message: string;
     icon?: string;
+    command?: string;
 }
 interface ChatProfile {
     default: boolean;
     icon?: string;
     name: string;
+    display_name?: string;
     markdown_description: string;
     starters?: IStarter[];
 }
@@ -185,25 +207,34 @@ interface IAuthConfig {
     headerAuth: boolean;
     oauthProviders: string[];
     default_theme?: 'light' | 'dark';
+    ui?: IChainlitConfig['ui'];
 }
 interface IChainlitConfig {
     markdown?: string;
     ui: {
         name: string;
         description?: string;
-        font_family?: string;
         default_theme?: 'light' | 'dark';
         layout?: 'default' | 'wide';
+        default_sidebar_state?: 'open' | 'closed';
         cot: 'hidden' | 'tool_call' | 'full';
         github?: string;
         custom_css?: string;
         custom_js?: string;
         custom_font?: string;
+        alert_style?: 'classic' | 'modern';
+        login_page_image?: string;
+        login_page_image_filter?: string;
+        login_page_image_dark_filter?: string;
         custom_meta_image_url?: string;
+        logo_file_url?: string;
+        default_avatar_file_url?: string;
         header_links?: {
             name: string;
+            display_name: string;
             icon_url: string;
             url: string;
+            target?: '_blank' | '_self' | '_parent' | '_top';
         }[];
     };
     features: {
@@ -216,14 +247,28 @@ interface IChainlitConfig {
         audio: IAudioConfig;
         unsafe_allow_html?: boolean;
         user_message_autoscroll?: boolean;
+        assistant_message_autoscroll?: boolean;
         latex?: boolean;
         edit_message?: boolean;
-        mcp?: boolean;
+        mcp?: {
+            enabled?: boolean;
+            sse?: {
+                enabled?: boolean;
+            };
+            streamable_http?: {
+                enabled?: boolean;
+            };
+            stdio?: {
+                enabled?: boolean;
+            };
+        };
     };
     debugUrl?: string;
     userEnv: string[];
+    maskUserEnv?: boolean;
     dataPersistence: boolean;
     threadResumable: boolean;
+    threadSharing?: boolean;
     chatProfiles: ChatProfile[];
     starters?: IStarter[];
     translation: object;
@@ -235,9 +280,10 @@ interface IMcp {
         name: string;
     }];
     status: 'connected' | 'connecting' | 'failed';
-    clientType: 'sse' | 'stdio';
+    clientType: 'sse' | 'stdio' | 'streamable-http';
     command?: string;
     url?: string;
+    headers?: Record<string, string>;
 }
 
 interface IToken {
@@ -250,9 +296,9 @@ declare const useChatData: () => {
     actions: IAction[];
     askUser: IAsk | undefined;
     callFn: ICallFn | undefined;
-    chatSettingsDefaultValue: any;
+    chatSettingsDefaultValue: Record<string, any>;
     chatSettingsInputs: any;
-    chatSettingsValue: any;
+    chatSettingsValue: Record<string, any>;
     connected: boolean | undefined;
     disabled: boolean;
     elements: IMessageElement[];
@@ -263,7 +309,7 @@ declare const useChatData: () => {
 
 type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 declare const useChatInteract: () => {
-    uploadFile: (file: File, onProgress: (progress: number) => void) => {
+    uploadFile: (file: File, onProgress: (progress: number) => void, parentId?: string) => {
         xhr: XMLHttpRequest;
         promise: Promise<{
             id: string;
@@ -300,6 +346,7 @@ declare const sessionState: recoil.RecoilState<ISession | undefined>;
 declare const actionState: recoil.RecoilState<IAction[]>;
 declare const messagesState: recoil.RecoilState<IStep[]>;
 declare const commandsState: recoil.RecoilState<ICommand[]>;
+declare const modesState: recoil.RecoilState<IMode[]>;
 declare const tokenCountState: recoil.RecoilState<number>;
 declare const loadingState: recoil.RecoilState<boolean>;
 declare const askUserState: recoil.RecoilState<IAsk | undefined>;
@@ -309,8 +356,8 @@ declare const audioConnectionState: recoil.RecoilState<"connecting" | "on" | "of
 declare const isAiSpeakingState: recoil.RecoilState<boolean>;
 declare const callFnState: recoil.RecoilState<ICallFn | undefined>;
 declare const chatSettingsInputsState: recoil.RecoilState<any>;
-declare const chatSettingsDefaultValueSelector: recoil.RecoilValueReadOnly<any>;
-declare const chatSettingsValueState: recoil.RecoilState<any>;
+declare const chatSettingsDefaultValueSelector: recoil.RecoilValueReadOnly<Record<string, any>>;
+declare const chatSettingsValueState: recoil.RecoilState<Record<string, any>>;
 declare const elementState: recoil.RecoilState<IMessageElement[]>;
 declare const tasklistState: recoil.RecoilState<ITasklistElement[]>;
 declare const firstUserInteraction: recoil.RecoilState<string | undefined>;
@@ -321,6 +368,7 @@ declare const threadHistoryState: recoil.RecoilState<ThreadHistory | undefined>;
 declare const sideViewState: recoil.RecoilState<{
     title: string;
     elements: IMessageElement[];
+    key?: string | undefined;
 } | undefined>;
 declare const currentThreadIdState: recoil.RecoilState<string | undefined>;
 declare const mcpState: recoil.RecoilState<IMcp[]>;
@@ -329,7 +377,7 @@ declare const useChatSession: () => {
     connect: lodash.DebouncedFunc<({ transports, userEnv }: {
         transports?: string[] | undefined;
         userEnv: Record<string, string>;
-    }) => void>;
+    }) => Promise<void>>;
     disconnect: () => void;
     session: ISession | undefined;
     sessionId: string;
@@ -395,9 +443,10 @@ type Payload = FormData | any;
 declare class APIBase {
     httpEndpoint: string;
     type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord';
+    additionalQueryParams?: Record<string, string> | undefined;
     on401?: (() => void) | undefined;
     onError?: ((error: ClientError) => void) | undefined;
-    constructor(httpEndpoint: string, type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord', on401?: (() => void) | undefined, onError?: ((error: ClientError) => void) | undefined);
+    constructor(httpEndpoint: string, type: 'webapp' | 'copilot' | 'teams' | 'slack' | 'discord', additionalQueryParams?: Record<string, string> | undefined, on401?: (() => void) | undefined, onError?: ((error: ClientError) => void) | undefined);
     buildEndpoint(path: string): string;
     private getDetailFromErrorResponse;
     private handleRequestError;
@@ -414,10 +463,11 @@ declare class APIBase {
 declare class ChainlitAPI extends APIBase {
     headerAuth(): Promise<any>;
     jwtAuth(token: string): Promise<any>;
+    stickyCookie(sessionId: string): Promise<any>;
     passwordAuth(data: FormData): Promise<any>;
     getUser(): Promise<IUser>;
     logout(): Promise<any>;
-    setFeedback(feedback: IFeedback): Promise<{
+    setFeedback(feedback: IFeedback, sessionId: string): Promise<{
         success: boolean;
         feedbackId: string;
     }>;
@@ -430,7 +480,7 @@ declare class ChainlitAPI extends APIBase {
     }>;
     renameThread(threadId: string, name: string): Promise<any>;
     deleteThread(threadId: string): Promise<any>;
-    uploadFile(file: File, onProgress: (progress: number) => void, sessionId: string): {
+    uploadFile(file: File, onProgress: (progress: number) => void, sessionId: string, parentId?: string): {
         xhr: XMLHttpRequest;
         promise: Promise<{
             id: string;
@@ -440,11 +490,15 @@ declare class ChainlitAPI extends APIBase {
     updateElement(element: IElement, sessionId: string): Promise<any>;
     deleteElement(element: IElement, sessionId: string): Promise<any>;
     connectStdioMCP(sessionId: string, name: string, fullCommand: string): Promise<any>;
-    connectSseMCP(sessionId: string, name: string, url: string): Promise<any>;
+    connectSseMCP(sessionId: string, name: string, url: string, headers?: Record<string, string>): Promise<any>;
+    connectStreamableHttpMCP(sessionId: string, name: string, url: string, headers?: Record<string, string>): Promise<any>;
     disconnectMcp(sessionId: string, name: string): Promise<any>;
     getElementUrl(id: string, sessionId: string): string;
-    getLogoEndpoint(theme: string): string;
+    getLogoEndpoint(theme: string, configuredLogoUrl?: string): string;
     getOAuthEndpoint(provider: string): string;
+    shareThread(threadId: string, isShared: boolean): Promise<{
+        success: boolean;
+    }>;
 }
 
 declare const defaultChainlitContext: undefined;
@@ -463,4 +517,4 @@ declare const WavRenderer: {
     drawBars: (ctx: CanvasRenderingContext2D, data: Float32Array, cssWidth: number, cssHeight: number, color: string, pointCount?: number, barWidth?: number, barSpacing?: number, center?: boolean) => void;
 };
 
-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 };
+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, IMode, IModeOption, 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, modesState, nestMessages, resumeThreadErrorState, sessionIdState, sessionState, sideViewState, tasklistState, threadHistoryState, threadIdToResumeState, tokenCountState, updateMessageById, updateMessageContentById, useApi, useAudio, useAuth, useChatData, useChatInteract, useChatMessages, useChatSession, useConfig, userState, wavRecorderState, wavStreamPlayerState };