@n8n/chat 0.3.0 → 0.4.1

package/types/api/generic.d.ts

@@ -0,0 +1,6 @@
+export declare function authenticatedFetch<T>(...args: Parameters<typeof fetch>): Promise<T>;
+export declare function get<T>(url: string, query?: object, options?: RequestInit): Promise<T>;
+export declare function post<T>(url: string, body?: object, options?: RequestInit): Promise<T>;
+export declare function put<T>(url: string, body?: object, options?: RequestInit): Promise<T>;
+export declare function patch<T>(url: string, body?: object, options?: RequestInit): Promise<T>;
+export declare function del<T>(url: string, body?: object, options?: RequestInit): Promise<T>;

package/types/api/message.d.ts

@@ -0,0 +1,3 @@
+import type { ChatOptions, LoadPreviousSessionResponse, SendMessageResponse } from '../types';
+export declare function loadPreviousSession(sessionId: string, options: ChatOptions): Promise<LoadPreviousSessionResponse>;
+export declare function sendMessage(message: string, sessionId: string, options: ChatOptions): Promise<SendMessageResponse>;

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

@@ -0,0 +1,9 @@
+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<{}>>, {}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/types/components/Chat.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/components/ChatWindow.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/components/GetStarted.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/components/GetStartedFooter.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/components/Input.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/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,52 +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: {
-		'n8n-local-rules/dangerously-use-html-string-missing': 'off',
-
-		// 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-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/.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>