@n8n/chat 0.46.0 → 0.48.0

package/README.md

@@ -14,6 +14,9 @@ Open the **Chat Trigger** node and add your domain to the **Allowed Origins (COR
 
 [See example workflow](https://github.com/n8n-io/n8n/blob/master/packages/%40n8n/chat/resources/workflow.json)
 
+To use streaming responses, you need to enable the **Streaming response** response mode in the **Chat Trigger** node.
+[See example workflow with streaming](https://github.com/n8n-io/n8n/blob/master/packages/%40n8n/chat/resources/workflow-streaming.json)
+
 > Make sure the workflow is **Active.**
 
 ### How it works
@@ -129,6 +132,7 @@ createChat({
 			inputPlaceholder: 'Type your question..',
 		},
 	},
+	enableStreaming: false,
 });
 ```
 
@@ -175,7 +179,7 @@ createChat({
 ### `loadPreviousSession`
 - **Type**: `boolean`
 - **Default**: `true`
-- **Description**: Whether to load previous messages (chat context). 
+- **Description**: Whether to load previous messages (chat context).
 
 ### `defaultLanguage`
 - **Type**: `string`
@@ -200,6 +204,11 @@ createChat({
 - **Default**: `''`
 - **Description**: A comma-separated list of allowed MIME types for file uploads. Only applicable if `allowFileUploads` is set to `true`. If left empty, all file types are allowed. For example: `'image/*,application/pdf'`.
 
+### enableStreaming
+- Type: boolean
+- Default: false
+- Description: Whether to enable streaming responses from the n8n workflow. If set to `true`, the chat will display responses as they are being generated, providing a more interactive experience. For this to work the workflow must be configured as well to return streaming responses.
+
 ## Customization
 The Chat window is entirely customizable using CSS variables.
 

package/dist/__tests__/api/message.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/utils/fetch.d.ts

@@ -2,3 +2,12 @@ import { LoadPreviousSessionResponse, SendMessageResponse } from '../../types';
 export declare function createFetchResponse<T>(data: T): () => Promise<Response>;
 export declare const createGetLatestMessagesResponse: (data?: LoadPreviousSessionResponse["data"]) => LoadPreviousSessionResponse;
 export declare const createSendMessageResponse: (output: SendMessageResponse["output"]) => SendMessageResponse;
+export declare function createMockStreamingFetchResponse(chunks: Array<{
+    type: string;
+    content?: string;
+    metadata?: {
+        nodeId: string;
+        nodeName: string;
+        timestamp: number;
+    };
+}>): () => Promise<Response>;

package/dist/__tests__/utils/streaming.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/utils/streamingHandlers.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/api/message.d.ts

@@ -1,3 +1,9 @@
 import { ChatOptions, LoadPreviousSessionResponse, SendMessageResponse } from '../types';
 export declare function loadPreviousSession(sessionId: string, options: ChatOptions): Promise<LoadPreviousSessionResponse>;
 export declare function sendMessage(message: string, files: File[], sessionId: string, options: ChatOptions): Promise<SendMessageResponse>;
+export interface StreamingEventHandlers {
+    onBeginMessage: (nodeId: string, runIndex?: number) => void;
+    onChunk: (chunk: string, nodeId?: string, runIndex?: number) => void;
+    onEndMessage: (nodeId: string, runIndex?: number) => void;
+}
+export declare function sendMessageStreaming(message: string, files: File[], sessionId: string, options: ChatOptions, handlers: StreamingEventHandlers): Promise<void>;