@n8n/chat 0.5.0 → 0.5.2

package/types/options.d.ts

@@ -0,0 +1,25 @@
+export interface ChatOptions {
+    webhookUrl: string;
+    webhookConfig?: {
+        method?: 'GET' | 'POST';
+        headers?: Record<string, string>;
+    };
+    target?: string | Element;
+    mode?: 'window' | 'fullscreen';
+    showWelcomeScreen?: boolean;
+    loadPreviousSession?: boolean;
+    chatInputKey?: string;
+    chatSessionKey?: 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/options.js

@@ -0,0 +1 @@
+"use strict";

package/types/src/App.vue.d.ts

@@ -0,0 +1,8 @@
+declare const _default: import("vue").DefineComponent<Readonly<import("vue").ComponentPropsOptions<{
+    [x: string]: unknown;
+}>>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, readonly string[] | Readonly<import("vue").ExtractPropTypes<Readonly<import("vue").ComponentObjectPropsOptions<{
+    [x: string]: unknown;
+}>>>>, {
+    readonly [x: number]: string;
+} | {}, {}>;
+export default _default;

package/types/src/__stories__/App.stories.d.ts

@@ -0,0 +1,17 @@
+import type { StoryObj } from '@storybook/vue3';
+import type { ChatOptions } from '../types';
+declare const meta: {
+    title: string;
+    render: (args: Partial<ChatOptions>) => {
+        setup(): {};
+        template: string;
+    };
+    parameters: {
+        layout: string;
+    };
+    tags: string[];
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Fullscreen: Story;
+export declare const Windowed: Story;

package/types/src/__tests__/index.spec.d.ts

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

package/types/src/__tests__/utils/create.d.ts

@@ -0,0 +1,5 @@
+import { createChat } from '../../index';
+export declare function createTestChat(options?: Parameters<typeof createChat>[0]): {
+    unmount: () => void;
+    container: Element;
+};

package/types/src/__tests__/utils/fetch.d.ts

@@ -0,0 +1,4 @@
+import type { 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;

package/types/src/__tests__/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './create';
+export * from './fetch';
+export * from './selectors';

package/types/src/__tests__/utils/selectors.d.ts

@@ -0,0 +1,12 @@
+export declare function getMountingTarget(target?: string): Element | null;
+export declare function getChatWindowWrapper(): Element | null;
+export declare function getChatWindowToggle(): Element | null;
+export declare function getChatWrapper(): Element | null;
+export declare function getChatMessages(): NodeListOf<Element>;
+export declare function getChatMessage(index: number): Element;
+export declare function getChatMessageByText(text: string): HTMLElement | null;
+export declare function getChatMessageTyping(): Element | null;
+export declare function getGetStartedButton(): Element | null;
+export declare function getChatInput(): Element | null;
+export declare function getChatInputTextarea(): Element | null;
+export declare function getChatInputSendButton(): Element | null;

package/types/src/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/src/api/index.d.ts

@@ -0,0 +1,2 @@
+export * from './generic';
+export * from './message';

package/types/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/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/src/components/index.d.ts

@@ -0,0 +1,10 @@
+export { default as Button } from './Button.vue';
+export { default as Chat } from './Chat.vue';
+export { default as ChatWindow } from './ChatWindow.vue';
+export { default as GetStarted } from './GetStarted.vue';
+export { default as GetStartedFooter } from './GetStartedFooter.vue';
+export { default as Input } from './Input.vue';
+export { default as Layout } from './Layout.vue';
+export { default as Message } from './Message.vue';
+export { default as MessagesList } from './MessagesList.vue';
+export { default as PoweredBy } from './PoweredBy.vue';

package/types/src/composables/index.d.ts

@@ -0,0 +1,3 @@
+export * from './useChat';
+export * from './useI18n';
+export * from './useOptions';

package/types/src/composables/useChat.d.ts

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

package/types/src/composables/useI18n.d.ts

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

package/types/src/composables/useOptions.d.ts

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

package/types/src/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/src/constants/index.d.ts

@@ -0,0 +1,3 @@
+export * from './defaults';
+export * from './localStorage';
+export * from './symbols';

package/types/src/constants/localStorage.d.ts

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

package/types/src/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/src/event-buses/chatEventBus.d.ts

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

package/types/src/event-buses/index.d.ts

@@ -0,0 +1 @@
+export * from './chatEventBus';

package/types/src/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/src/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/src/plugins/index.d.ts

@@ -0,0 +1 @@
+export * from './chat';

package/types/src/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 | undefined>;
+    startNewSession: () => Promise<void>;
+    sendMessage: (text: string) => Promise<void>;
+}

package/types/src/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './chat';
+export * from './messages';
+export * from './options';
+export * from './webhook';

package/types/src/types/messages.d.ts

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

package/types/src/types/options.d.ts

@@ -0,0 +1,25 @@
+export interface ChatOptions {
+    webhookUrl: string;
+    webhookConfig?: {
+        method?: 'GET' | 'POST';
+        headers?: Record<string, string>;
+    };
+    target?: string | Element;
+    mode?: 'window' | 'fullscreen';
+    showWelcomeScreen?: boolean;
+    loadPreviousSession?: boolean;
+    chatInputKey?: string;
+    chatSessionKey?: 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/src/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/src/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/src/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './event-bus';
+export * from './mount';

package/types/src/utils/mount.d.ts

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

package/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/webhook.js

@@ -0,0 +1 @@
+"use strict";

package/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/utils/event-bus.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createEventBus = createEventBus;
+function createEventBus() {
+  const handlers = /* @__PURE__ */new Map();
+  function off(eventName, fn) {
+    const eventFns = handlers.get(eventName);
+    if (eventFns) {
+      eventFns.splice(eventFns.indexOf(fn) >>> 0, 1);
+    }
+  }
+  function on(eventName, fn) {
+    let eventFns = handlers.get(eventName);
+    if (!eventFns) {
+      eventFns = [fn];
+    } else {
+      eventFns.push(fn);
+    }
+    handlers.set(eventName, eventFns);
+    return () => off(eventName, fn);
+  }
+  function emit(eventName, event) {
+    const eventFns = handlers.get(eventName);
+    if (eventFns) {
+      eventFns.slice().forEach(async handler => {
+        await handler(event);
+      });
+    }
+  }
+  return {
+    on,
+    off,
+    emit
+  };
+}

package/utils/event-bus.mjs

@@ -0,0 +1,32 @@
+export function createEventBus() {
+  const handlers = /* @__PURE__ */ new Map();
+  function off(eventName, fn) {
+    const eventFns = handlers.get(eventName);
+    if (eventFns) {
+      eventFns.splice(eventFns.indexOf(fn) >>> 0, 1);
+    }
+  }
+  function on(eventName, fn) {
+    let eventFns = handlers.get(eventName);
+    if (!eventFns) {
+      eventFns = [fn];
+    } else {
+      eventFns.push(fn);
+    }
+    handlers.set(eventName, eventFns);
+    return () => off(eventName, fn);
+  }
+  function emit(eventName, event) {
+    const eventFns = handlers.get(eventName);
+    if (eventFns) {
+      eventFns.slice().forEach(async (handler) => {
+        await handler(event);
+      });
+    }
+  }
+  return {
+    on,
+    off,
+    emit
+  };
+}

package/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './event-bus';
+export * from './mount';

package/utils/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _eventBus = require("./event-bus");
+Object.keys(_eventBus).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _eventBus[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _eventBus[key];
+    }
+  });
+});
+var _mount = require("./mount");
+Object.keys(_mount).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _mount[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _mount[key];
+    }
+  });
+});

package/utils/index.mjs

@@ -0,0 +1,2 @@
+export * from "./event-bus.mjs";
+export * from "./mount.mjs";

package/utils/mount.d.ts

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

package/utils/mount.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createDefaultMountingTarget = createDefaultMountingTarget;
+function createDefaultMountingTarget(mountingTarget) {
+  const mountingTargetNode = document.querySelector(mountingTarget);
+  if (!mountingTargetNode) {
+    const generatedMountingTargetNode = document.createElement("div");
+    if (mountingTarget.startsWith("#")) {
+      generatedMountingTargetNode.id = mountingTarget.replace("#", "");
+    }
+    if (mountingTarget.startsWith(".")) {
+      generatedMountingTargetNode.classList.add(mountingTarget.replace(".", ""));
+    }
+    document.body.appendChild(generatedMountingTargetNode);
+  }
+}

package/utils/mount.mjs

@@ -0,0 +1,13 @@
+export function createDefaultMountingTarget(mountingTarget) {
+  const mountingTargetNode = document.querySelector(mountingTarget);
+  if (!mountingTargetNode) {
+    const generatedMountingTargetNode = document.createElement("div");
+    if (mountingTarget.startsWith("#")) {
+      generatedMountingTargetNode.id = mountingTarget.replace("#", "");
+    }
+    if (mountingTarget.startsWith(".")) {
+      generatedMountingTargetNode.classList.add(mountingTarget.replace(".", ""));
+    }
+    document.body.appendChild(generatedMountingTargetNode);
+  }
+}