@n8n/chat 0.2.0 → 0.4.0

package/types/components/Layout.vue.d.ts

@@ -0,0 +1,11 @@
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>, {
+    header?(_: {}): any;
+    default?(_: {}): any;
+    footer?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/types/components/Message.vue.d.ts

@@ -0,0 +1,21 @@
+import type { ChatMessage } from '../types';
+import type { PropType } from 'vue';
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    message: {
+        type: PropType<ChatMessage>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    message: {
+        type: PropType<ChatMessage>;
+        required: true;
+    };
+}>>, {}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/types/components/MessageTyping.vue.d.ts

@@ -0,0 +1,15 @@
+import type { PropType } from 'vue';
+declare const _default: import("vue").DefineComponent<{
+    animation: {
+        type: PropType<"bouncing" | "scaling">;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    animation: {
+        type: PropType<"bouncing" | "scaling">;
+        default: string;
+    };
+}>>, {
+    animation: "bouncing" | "scaling";
+}, {}>;
+export default _default;

package/types/components/MessagesList.vue.d.ts

@@ -0,0 +1,14 @@
+import type { PropType } from 'vue';
+import type { ChatMessage } from '../types';
+declare const _default: import("vue").DefineComponent<{
+    messages: {
+        type: PropType<ChatMessage[]>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    messages: {
+        type: PropType<ChatMessage[]>;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;

package/types/components/PoweredBy.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

package/types/composables/useChat.d.ts

@@ -0,0 +1,2 @@
+import type { Chat } from '../types';
+export declare function useChat(): Chat;

package/types/composables/useI18n.d.ts

@@ -0,0 +1,4 @@
+export declare function useI18n(): {
+    t: (key: string) => string;
+    te: (key: string) => boolean;
+};

package/types/composables/useOptions.d.ts

@@ -0,0 +1,4 @@
+import type { ChatOptions } from '../types';
+export declare function useOptions(): {
+    options: ChatOptions;
+};

package/types/constants/defaults.d.ts

@@ -0,0 +1,3 @@
+import type { ChatOptions } from '../types';
+export declare const defaultOptions: ChatOptions;
+export declare const defaultMountingTarget = "#n8n-chat";

package/types/constants/localStorage.d.ts

@@ -0,0 +1,2 @@
+export declare const localStorageNamespace = "n8n-chat";
+export declare const localStorageSessionIdKey = "n8n-chat/sessionId";

package/types/constants/symbols.d.ts

@@ -0,0 +1,4 @@
+import type { InjectionKey } from 'vue';
+import type { Chat, ChatOptions } from '../types';
+export declare const ChatSymbol: InjectionKey<Chat>;
+export declare const ChatOptionsSymbol: InjectionKey<ChatOptions>;

package/types/event-buses/chatEventBus.d.ts

@@ -0,0 +1 @@
+export declare const chatEventBus: import('../utils').EventBus;

package/types/index.d.ts

@@ -0,0 +1,2 @@
+import type { ChatOptions } from './types';
+export declare function createChat(options?: Partial<ChatOptions>): import("vue").App<Element>;

package/types/plugins/chat.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from 'vue';
+import type { ChatOptions } from '../types';
+export declare const ChatPlugin: Plugin<ChatOptions>;

package/types/types/chat.d.ts

@@ -0,0 +1,11 @@
+import type { ChatMessage } from '../types/messages';
+import type { Ref } from 'vue';
+export interface Chat {
+    initialMessages: Ref<ChatMessage[]>;
+    messages: Ref<ChatMessage[]>;
+    currentSessionId: Ref<string | null>;
+    waitingForResponse: Ref<boolean>;
+    loadPreviousSession: () => Promise<string>;
+    startNewSession: () => Promise<void>;
+    sendMessage: (text: string) => Promise<void>;
+}

package/types/types/messages.d.ts

@@ -0,0 +1,6 @@
+export interface ChatMessage {
+    id: string;
+    text: string;
+    createdAt: string;
+    sender: 'user' | 'bot';
+}

package/types/types/options.d.ts

@@ -0,0 +1,24 @@
+export interface ChatOptions {
+    webhookUrl: string;
+    webhookConfig?: {
+        method?: 'GET' | 'POST';
+        headers?: Record<string, string>;
+    };
+    target?: string | Element;
+    mode?: 'window' | 'fullscreen';
+    showWelcomeScreen?: boolean;
+    chatInputKey?: string;
+    chatHistoryKey?: string;
+    defaultLanguage?: 'en';
+    initialMessages?: string[];
+    metadata?: Record<string, unknown>;
+    i18n: Record<string, {
+        title: string;
+        subtitle: string;
+        footer: string;
+        getStarted: string;
+        inputPlaceholder: string;
+        [message: string]: string;
+    }>;
+    theme?: {};
+}

package/types/types/webhook.d.ts

@@ -0,0 +1,15 @@
+export interface LoadPreviousSessionResponseItem {
+    id: string[];
+    kwargs: {
+        content: string;
+        additional_kwargs: Record<string, unknown>;
+    };
+    lc: number;
+    type: string;
+}
+export interface LoadPreviousSessionResponse {
+    data: LoadPreviousSessionResponseItem[];
+}
+export interface SendMessageResponse {
+    output: string;
+}

package/types/utils/event-bus.d.ts

@@ -0,0 +1,8 @@
+export type CallbackFn = Function;
+export type UnregisterFn = () => void;
+export interface EventBus {
+    on: (eventName: string, fn: CallbackFn) => UnregisterFn;
+    off: (eventName: string, fn: CallbackFn) => void;
+    emit: <T = Event>(eventName: string, event?: T) => void;
+}
+export declare function createEventBus(): EventBus;

package/types/utils/mount.d.ts

@@ -0,0 +1 @@
+export declare function createDefaultMountingTarget(mountingTarget: string): void;

package/.eslintignore

@@ -1,2 +0,0 @@
-.eslintrc.cjs
-vitest.config.ts

package/.eslintrc.cjs

@@ -1,53 +0,0 @@
-const sharedOptions = require('@n8n_io/eslint-config/shared');
-
-/**
- * @type {import('@types/eslint').ESLint.ConfigData}
- */
-module.exports = {
-	extends: ['@n8n_io/eslint-config/frontend'],
-
-	...sharedOptions(__dirname, 'frontend'),
-
-	rules: {
-		// TODO: Remove these
-		'id-denylist': 'warn',
-		'import/extensions': 'warn',
-		'import/no-default-export': 'warn',
-		'import/no-extraneous-dependencies': '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-assignment': 'warn',
-		'@typescript-eslint/no-unsafe-call': 'warn',
-		'@typescript-eslint/no-unsafe-member-access': '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/restrict-template-expressions': '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/.np-config.json

@@ -1,5 +0,0 @@
-{
-	"yarn": false,
-	"tests": false,
-	"contents": "./dist"
-}

package/.storybook/main.ts

@@ -1,27 +0,0 @@
-import type { StorybookConfig } from '@storybook/vue3-vite';
-
-import { join, dirname } from 'path';
-
-/**
- * This function is used to resolve the absolute path of a package.
- * It is needed in projects that use Yarn PnP or are set up within a monorepo.
- */
-function getAbsolutePath(value: string): any {
-	return dirname(require.resolve(join(value, 'package.json')));
-}
-const config: StorybookConfig = {
-	stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
-	addons: [
-		getAbsolutePath('@storybook/addon-links'),
-		getAbsolutePath('@storybook/addon-essentials'),
-		getAbsolutePath('@storybook/addon-interactions'),
-	],
-	framework: {
-		name: getAbsolutePath('@storybook/vue3-vite'),
-		options: {},
-	},
-	docs: {
-		autodocs: 'tag',
-	},
-};
-export default config;

package/.storybook/preview.scss

@@ -1,4 +0,0 @@
-html, body, #storybook-root, #n8n-chat {
-	width: 100%;
-	height: 100%;
-}

package/.storybook/preview.ts

@@ -1,16 +0,0 @@
-import type { Preview } from '@storybook/vue3';
-import './preview.scss';
-
-const preview: Preview = {
-	parameters: {
-		actions: { argTypesRegex: '^on[A-Z].*' },
-		controls: {
-			matchers: {
-				color: /(background|color)$/i,
-				date: /Date$/,
-			},
-		},
-	},
-};
-
-export default preview;

package/.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-  "recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
-}

package/env.d.ts

@@ -1 +0,0 @@
-/// <reference types="vite/client" />

package/index.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8">
-    <link rel="icon" href="/favicon.ico">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Vite App</title>
-  </head>
-  <body>
-    <div id="app"></div>
-    <script type="module" src="/src/main.ts"></script>
-  </body>
-</html>

package/resources/workflow.json

@@ -1,293 +0,0 @@
-{
-	"name": "AI Webhook Chat",
-	"nodes": [
-		{
-			"parameters": {
-				"httpMethod": "POST",
-				"path": "513107b3-6f3a-4a1e-af21-659f0ed14183",
-				"responseMode": "responseNode",
-				"options": {
-					"domainAllowlist": "*.localhost"
-				}
-			},
-			"id": "51ab2689-647d-4cff-9d6f-0ba4df45e904",
-			"name": "Webhook",
-			"type": "n8n-nodes-base.webhook",
-			"typeVersion": 1,
-			"position": [
-				900,
-				200
-			],
-			"webhookId": "513107b3-6f3a-4a1e-af21-659f0ed14183"
-		},
-		{
-			"parameters": {
-				"options": {}
-			},
-			"id": "3c7fd563-f610-41fa-b198-7fcf100e2815",
-			"name": "Chat OpenAI",
-			"type": "@n8n/n8n-nodes-langchain.lmChatOpenAi",
-			"typeVersion": 1,
-			"position": [
-				1720,
-				620
-			],
-			"credentials": {
-				"openAiApi": {
-					"id": "B5Fiv70Adfg6htxn",
-					"name": "Alex's OpenAI Account"
-				}
-			}
-		},
-		{
-			"parameters": {
-				"sessionKey": "={{ $json.body.sessionId }}"
-			},
-			"id": "ebc23ffa-3bcf-494f-bcb8-51a5fff91885",
-			"name": "Window Buffer Memory",
-			"type": "@n8n/n8n-nodes-langchain.memoryBufferWindow",
-			"typeVersion": 1,
-			"position": [
-				1920,
-				620
-			]
-		},
-		{
-			"parameters": {
-				"simplifyOutput": false
-			},
-			"id": "d6721a60-159b-4a93-ac6b-b81e16d9f16f",
-			"name": "Memory Chat Retriever",
-			"type": "@n8n/n8n-nodes-langchain.memoryChatRetriever",
-			"typeVersion": 1,
-			"position": [
-				1780,
-				-40
-			]
-		},
-		{
-			"parameters": {
-				"sessionKey": "={{ $json.body.sessionId }}"
-			},
-			"id": "347edc3a-1dda-4996-b778-dcdc447ecfd8",
-			"name": "Memory Chat Retriever Window Buffer Memory",
-			"type": "@n8n/n8n-nodes-langchain.memoryBufferWindow",
-			"typeVersion": 1,
-			"position": [
-				1800,
-				160
-			]
-		},
-		{
-			"parameters": {
-				"options": {
-					"responseCode": 200,
-					"responseHeaders": {
-						"entries": [
-							{
-								"name": "sessionId",
-								"value": "={{ $json.body.sessionId }}"
-							},
-							{
-								"name": "Access-Control-Allow-Headers",
-								"value": "*"
-							}
-						]
-					}
-				}
-			},
-			"id": "d229963e-e2f1-4381-87d2-47043bd6ccc7",
-			"name": "Respond to Webhook",
-			"type": "n8n-nodes-base.respondToWebhook",
-			"typeVersion": 1,
-			"position": [
-				2460,
-				220
-			]
-		},
-		{
-			"parameters": {
-				"dataType": "string",
-				"value1": "={{ $json.body.action }}",
-				"rules": {
-					"rules": [
-						{
-							"value2": "loadPreviousSession"
-						},
-						{
-							"value2": "sendMessage",
-							"output": 1
-						}
-					]
-				}
-			},
-			"id": "fc4ad994-5f38-4dce-b1e5-397acc512687",
-			"name": "Chatbot Action",
-			"type": "n8n-nodes-base.switch",
-			"typeVersion": 1,
-			"position": [
-				1320,
-				200
-			]
-		},
-		{
-			"parameters": {
-				"jsCode": "const response = { data: [] };\n\nfor (const item of $input.all()) {\n  response.data.push(item.json);\n}\n\nreturn {\n  json: response,\n  pairedItem: 0\n};"
-			},
-			"id": "e1a80bdc-411a-42df-88dd-36915b1ae8f4",
-			"name": "Code",
-			"type": "n8n-nodes-base.code",
-			"typeVersion": 2,
-			"position": [
-				2160,
-				-40
-			]
-		},
-		{
-			"parameters": {
-				"text": "={{ $json.body.message }}",
-				"options": {}
-			},
-			"id": "f28f5c00-c742-41d5-8ddb-f0f59ab111a3",
-			"name": "Agent",
-			"type": "@n8n/n8n-nodes-langchain.agent",
-			"typeVersion": 1,
-			"position": [
-				1780,
-				340
-			]
-		},
-		{
-			"parameters": {
-				"jsCode": "// Loop over input items and add a new field called 'myNewField' to the JSON of each one\nfor (const item of $input.all()) {\n  item.json.body = JSON.parse(item.json.body);\n}\n\nreturn $input.all();"
-			},
-			"id": "415c071b-18b2-4ac5-8634-e3d939bf36ac",
-			"name": "Transform request body",
-			"type": "n8n-nodes-base.code",
-			"typeVersion": 2,
-			"position": [
-				1120,
-				200
-			]
-		}
-	],
-	"pinData": {},
-	"connections": {
-		"Webhook": {
-			"main": [
-				[
-					{
-						"node": "Transform request body",
-						"type": "main",
-						"index": 0
-					}
-				]
-			]
-		},
-		"Memory Chat Retriever": {
-			"main": [
-				[
-					{
-						"node": "Code",
-						"type": "main",
-						"index": 0
-					}
-				]
-			]
-		},
-		"Memory Chat Retriever Window Buffer Memory": {
-			"ai_memory": [
-				[
-					{
-						"node": "Memory Chat Retriever",
-						"type": "ai_memory",
-						"index": 0
-					}
-				]
-			]
-		},
-		"Chatbot Action": {
-			"main": [
-				[
-					{
-						"node": "Memory Chat Retriever",
-						"type": "main",
-						"index": 0
-					}
-				],
-				[
-					{
-						"node": "Agent",
-						"type": "main",
-						"index": 0
-					}
-				]
-			]
-		},
-		"Code": {
-			"main": [
-				[
-					{
-						"node": "Respond to Webhook",
-						"type": "main",
-						"index": 0
-					}
-				]
-			]
-		},
-		"Chat OpenAI": {
-			"ai_languageModel": [
-				[
-					{
-						"node": "Agent",
-						"type": "ai_languageModel",
-						"index": 0
-					}
-				]
-			]
-		},
-		"Window Buffer Memory": {
-			"ai_memory": [
-				[
-					{
-						"node": "Agent",
-						"type": "ai_memory",
-						"index": 0
-					}
-				]
-			]
-		},
-		"Agent": {
-			"main": [
-				[
-					{
-						"node": "Respond to Webhook",
-						"type": "main",
-						"index": 0
-					}
-				]
-			]
-		},
-		"Transform request body": {
-			"main": [
-				[
-					{
-						"node": "Chatbot Action",
-						"type": "main",
-						"index": 0
-					}
-				]
-			]
-		}
-	},
-	"active": true,
-	"settings": {
-		"executionOrder": "v1"
-	},
-	"versionId": "12c145a2-74bf-48b5-a87a-ba707949eaed",
-	"id": "L3FlJuFOxZcHtoFT",
-	"meta": {
-		"instanceId": "374b43d8b8d6299cc777811a4ad220fc688ee2d54a308cfb0de4450a5233ca9e"
-	},
-	"tags": []
-}

package/scripts/pack.js

@@ -1,11 +0,0 @@
-const path = require('path');
-const shelljs = require('shelljs');
-
-const rootDirPath = path.resolve(__dirname, '..');
-const distDirPath = path.resolve(rootDirPath, 'dist');
-
-shelljs.cd(rootDirPath);
-shelljs.exec('npm run build');
-
-shelljs.cd(distDirPath);
-shelljs.exec('npm pack');

package/scripts/postbuild.js

@@ -1,16 +0,0 @@
-const path = require('path');
-const shelljs = require('shelljs');
-
-const rootDirPath = path.resolve(__dirname, '..');
-const n8nRootDirPath = path.resolve(rootDirPath, '..', '..', '..');
-const distDirPath = path.resolve(rootDirPath, 'dist');
-
-const packageJsonFilePath = path.resolve(rootDirPath, 'package.json');
-const readmeFilePath = path.resolve(rootDirPath, 'README.md');
-const licenseFilePath = path.resolve(n8nRootDirPath, 'LICENSE.md');
-
-shelljs.cp(packageJsonFilePath, distDirPath);
-shelljs.cp(readmeFilePath, distDirPath);
-shelljs.cp(licenseFilePath, distDirPath);
-
-shelljs.mv(path.resolve(distDirPath, 'src'), path.resolve(distDirPath, 'types'));