@n8n/chat 0.6.0 → 0.7.0

package/.eslintrc.cjs

@@ -7,45 +7,4 @@ module.exports = {
 	extends: ['@n8n_io/eslint-config/frontend'],
 
 	...sharedOptions(__dirname, 'frontend'),
-
-	rules: {
-		'n8n-local-rules/dangerously-use-html-string-missing': 'off',
-
-		// TODO: Remove these
-		'id-denylist': 'warn',
-		'import/extensions': 'warn',
-		'import/no-default-export': 'warn',
-		'import/order': 'off',
-		'import/no-cycle': 'warn',
-		'import/no-duplicates': 'warn',
-		'@typescript-eslint/ban-types': 'warn',
-		'@typescript-eslint/dot-notation': 'warn',
-		'@typescript-eslint/lines-between-class-members': 'warn',
-		'@typescript-eslint/member-delimiter-style': 'warn',
-		'@typescript-eslint/naming-convention': 'warn',
-		'@typescript-eslint/no-empty-interface': 'warn',
-		'@typescript-eslint/no-for-in-array': 'warn',
-		'@typescript-eslint/no-loop-func': 'warn',
-		'@typescript-eslint/no-non-null-assertion': 'warn',
-		'@typescript-eslint/no-shadow': 'warn',
-		'@typescript-eslint/no-this-alias': 'warn',
-		'@typescript-eslint/no-unnecessary-boolean-literal-compare': 'warn',
-		'@typescript-eslint/no-unnecessary-type-assertion': 'warn',
-		'@typescript-eslint/no-unsafe-argument': 'warn',
-		'@typescript-eslint/no-unsafe-call': 'warn',
-		'@typescript-eslint/no-unsafe-return': 'warn',
-		'@typescript-eslint/no-unused-expressions': 'warn',
-		'@typescript-eslint/no-unused-vars': 'warn',
-		'@typescript-eslint/no-use-before-define': 'warn',
-		'@typescript-eslint/no-var-requires': 'warn',
-		'@typescript-eslint/prefer-nullish-coalescing': 'warn',
-		'@typescript-eslint/prefer-optional-chain': 'warn',
-		'@typescript-eslint/restrict-plus-operands': 'warn',
-		'@typescript-eslint/unbound-method': 'warn',
-		'@typescript-eslint/ban-ts-comment': ['warn', { 'ts-ignore': true }],
-		'@typescript-eslint/no-redundant-type-constituents': 'warn',
-		'@typescript-eslint/no-base-to-string': 'warn',
-		'@typescript-eslint/no-explicit-any': 'warn',
-		'@typescript-eslint/no-unsafe-enum-comparison': 'warn',
-	},
 };

package/README.md

@@ -1,10 +1,16 @@
 # n8n Chat
 This is an embeddable Chat widget for n8n. It allows the execution of AI-Powered Workflows through a Chat window.
 
+**Windowed Example**
+![n8n Chat Windowed](https://raw.githubusercontent.com/n8n-io/n8n/master/packages/%40n8n/chat/resources/images/windowed.png)
+
+**Fullscreen Example**
+![n8n Chat Fullscreen](https://raw.githubusercontent.com/n8n-io/n8n/master/packages/%40n8n/chat/resources/images/fullscreen.png)
+
 ## Prerequisites
-Create a n8n workflow which you want to execute via chat. The workflow has to be triggered using a **Webhook** node and return data using the **Respond to Webhook** node.
+Create a n8n workflow which you want to execute via chat. The workflow has to be triggered using a **Chat Trigger** node.
 
-Open the **Webhook** node and add your domain to the **Domain Allowlist** field. This makes sure that only requests from your domain are accepted.
+Open the **Chat Trigger** node and add your domain to the **Allowed Origins (CORS)** field. This makes sure that only requests from your domain are accepted.
 
 [See example workflow](https://github.com/n8n-io/n8n/blob/master/packages/%40n8n/chat/resources/workflow.json)
 
@@ -17,8 +23,6 @@ Each request is accompanied by an `action` query parameter, where `action` can b
 - `loadPreviousSession` - When the user opens the Chatbot again and the previous chat session should be loaded
 - `sendMessage` - When the user sends a message
 
-We use the `Switch` node to handle the different actions.
-
 ## Installation
 
 Open the **Webhook** node and replace `YOUR_PRODUCTION_WEBHOOK_URL` with your production URL. This is the URL that the Chat widget will use to send requests to.
@@ -106,6 +110,10 @@ createChat({
 	},
 	target: '#n8n-chat',
 	mode: 'window',
+	chatInputKey: 'chatInput',
+	chatSessionKey: 'sessionId',
+	metadata: {},
+	showWelcomeScreen: false,
 	defaultLanguage: 'en',
 	initialMessages: [
 		'Hi there! 👋',
@@ -148,6 +156,21 @@ createChat({
   - In `window` mode, the Chat window will be embedded in the target element as a chat toggle button and a fixed size chat window.
   - In `fullscreen` mode, the Chat will take up the entire width and height of its target container.
 
+### `showWelcomeScreen`
+- **Type**: `boolean`
+- **Default**: `false`
+- **Description**: Whether to show the welcome screen when the Chat window is opened.
+
+### `chatSessionKey`
+- **Type**: `string`
+- **Default**: `'sessionId'`
+- **Description**: The key to use for sending the chat history session ID for the AI Memory node.
+
+### `chatInputKey`
+- **Type**: `string`
+- **Default**: `'chatInput'`
+- **Description**: The key to use for sending the chat input for the AI Agent node.
+
 ### `defaultLanguage`
 - **Type**: `string`
 - **Default**: `'en'`

package/build.config.js

@@ -0,0 +1,21 @@
+import { defineBuildConfig } from 'unbuild';
+
+export default defineBuildConfig({
+	entries: [
+		{
+			builder: 'mkdist',
+			format: 'esm',
+			input: './src',
+			outDir: './tmp/lib',
+		},
+		{
+			builder: 'mkdist',
+			format: 'cjs',
+			input: './src',
+			outDir: './tmp/cjs',
+		},
+	],
+	clean: true,
+	declaration: true,
+	failOnWarn: false,
+});

package/package.json

@@ -1,17 +1,21 @@
 {
   "name": "@n8n/chat",
-  "version": "0.6.0",
-  "main": "./chat.umd.cjs",
+  "version": "0.7.0",
+  "main": "./chat.umd.js",
   "module": "./chat.es.js",
   "types": "./types/index.d.ts",
   "exports": {
     ".": {
-      "import": "./chat.es.js",
-      "require": "./chat.umd.cjs"
+      "import": "./index.mjs",
+      "require": "./index.js"
     },
     "./style.css": {
       "import": "./style.css",
       "require": "./style.css"
+    },
+    "./*": {
+      "import": "./*",
+      "require": "./*"
     }
   },
   "repository": {

package/resources/workflow-manual.json

@@ -0,0 +1,238 @@
+{
+  "name": "Hosted n8n AI Chat Manual",
+  "nodes": [
+    {
+      "parameters": {
+        "options": {}
+      },
+      "id": "e6043748-44fc-4019-9301-5690fe26c614",
+      "name": "OpenAI Chat Model",
+      "type": "@n8n/n8n-nodes-langchain.lmChatOpenAi",
+      "typeVersion": 1,
+      "position": [
+        860,
+        540
+      ],
+      "credentials": {
+        "openAiApi": {
+          "id": "cIIkOhl7tUX1KsL6",
+          "name": "OpenAi account"
+        }
+      }
+    },
+    {
+      "parameters": {
+        "sessionKey": "={{ $json.sessionId }}"
+      },
+      "id": "0a68a59a-8ab6-4fa5-a1ea-b7f99a93109b",
+      "name": "Window Buffer Memory",
+      "type": "@n8n/n8n-nodes-langchain.memoryBufferWindow",
+      "typeVersion": 1,
+      "position": [
+        640,
+        540
+      ]
+    },
+    {
+      "parameters": {
+        "text": "={{ $json.chatInput }}",
+        "options": {}
+      },
+      "id": "3d4e0fbf-d761-4569-b02e-f5c1eeb830c8",
+      "name": "AI Agent",
+      "type": "@n8n/n8n-nodes-langchain.agent",
+      "typeVersion": 1.1,
+      "position": [
+        840,
+        300
+      ]
+    },
+    {
+      "parameters": {
+        "dataType": "string",
+        "value1": "={{ $json.action }}",
+        "rules": {
+          "rules": [
+            {
+              "value2": "loadPreviousSession",
+              "outputKey": "loadPreviousSession"
+            },
+            {
+              "value2": "sendMessage",
+              "outputKey": "sendMessage"
+            }
+          ]
+        }
+      },
+      "id": "84213c7b-abc7-4f40-9567-cd3484a4ae6b",
+      "name": "Switch",
+      "type": "n8n-nodes-base.switch",
+      "typeVersion": 2,
+      "position": [
+        300,
+        280
+      ]
+    },
+    {
+      "parameters": {
+        "simplifyOutput": false
+      },
+      "id": "3be7f076-98ed-472a-80b6-bf8d9538ac87",
+      "name": "Chat Messages Retriever",
+      "type": "@n8n/n8n-nodes-langchain.memoryChatRetriever",
+      "typeVersion": 1,
+      "position": [
+        620,
+        140
+      ]
+    },
+    {
+      "parameters": {
+        "options": {}
+      },
+      "id": "3417c644-8a91-4524-974a-45b4a46d0e2e",
+      "name": "Respond to Webhook",
+      "type": "n8n-nodes-base.respondToWebhook",
+      "typeVersion": 1,
+      "position": [
+        1240,
+        140
+      ]
+    },
+    {
+      "parameters": {
+        "public": true,
+        "authentication": "n8nUserAuth",
+        "options": {
+          "loadPreviousSession": "manually",
+          "responseMode": "responseNode"
+        }
+      },
+      "id": "1b30c239-a819-45b4-b0ae-bdd5b92a5424",
+      "name": "Chat Trigger",
+      "type": "@n8n/n8n-nodes-langchain.chatTrigger",
+      "typeVersion": 1,
+      "position": [
+        80,
+        280
+      ],
+      "webhookId": "ed3dea26-7d68-42b3-9032-98fe967d441d"
+    },
+    {
+      "parameters": {
+        "aggregate": "aggregateAllItemData",
+        "options": {}
+      },
+      "id": "79672cf0-686b-41eb-90ae-fd31b6da837d",
+      "name": "Aggregate",
+      "type": "n8n-nodes-base.aggregate",
+      "typeVersion": 1,
+      "position": [
+        1000,
+        140
+      ]
+    }
+  ],
+  "pinData": {},
+  "connections": {
+    "OpenAI Chat Model": {
+      "ai_languageModel": [
+        [
+          {
+            "node": "AI Agent",
+            "type": "ai_languageModel",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "Window Buffer Memory": {
+      "ai_memory": [
+        [
+          {
+            "node": "AI Agent",
+            "type": "ai_memory",
+            "index": 0
+          },
+          {
+            "node": "Chat Messages Retriever",
+            "type": "ai_memory",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "Switch": {
+      "main": [
+        [
+          {
+            "node": "Chat Messages Retriever",
+            "type": "main",
+            "index": 0
+          }
+        ],
+        [
+          {
+            "node": "AI Agent",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "Chat Messages Retriever": {
+      "main": [
+        [
+          {
+            "node": "Aggregate",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "AI Agent": {
+      "main": [
+        [
+          {
+            "node": "Respond to Webhook",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "Chat Trigger": {
+      "main": [
+        [
+          {
+            "node": "Switch",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    },
+    "Aggregate": {
+      "main": [
+        [
+          {
+            "node": "Respond to Webhook",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    }
+  },
+  "active": true,
+  "settings": {
+    "executionOrder": "v1"
+  },
+  "versionId": "425c0efe-3aa0-4e0e-8c06-abe12234b1fd",
+  "id": "1569HF92Y02EUtsU",
+  "meta": {
+    "instanceId": "374b43d8b8d6299cc777811a4ad220fc688ee2d54a308cfb0de4450a5233ca9e"
+  },
+  "tags": []
+}