@atom8n/chat 1.2.0

package/dist/types/chat.d.ts

@@ -0,0 +1,13 @@
+import { Ref } from 'vue';
+import { ChatMessage } from './messages';
+import { SendMessageResponse } from './webhook';
+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, files?: File[]) => Promise<SendMessageResponse | null>;
+    ws?: WebSocket | null;
+}

package/dist/types/index.d.ts

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

package/dist/types/messages.d.ts

@@ -0,0 +1,17 @@
+export type ChatMessage<T = Record<string, unknown>> = ChatMessageComponent<T> | ChatMessageText;
+export interface ChatMessageComponent<T = Record<string, unknown>> extends ChatMessageBase {
+    type: 'component';
+    key: string;
+    arguments: T;
+}
+export interface ChatMessageText extends ChatMessageBase {
+    type?: 'text';
+    text: string;
+}
+interface ChatMessageBase {
+    id: string;
+    transparent?: boolean;
+    sender: 'user' | 'bot';
+    files?: File[];
+}
+export {};

package/dist/types/options.d.ts

@@ -0,0 +1,33 @@
+import { Component, Ref } from 'vue';
+export interface ChatOptions {
+    webhookUrl: string;
+    webhookConfig?: {
+        method?: 'GET' | 'POST';
+        headers?: Record<string, string>;
+    };
+    target?: string | Element;
+    mode?: 'window' | 'fullscreen';
+    showWindowCloseButton?: boolean;
+    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;
+        closeButtonTooltip: string;
+        [message: string]: string;
+    }>;
+    theme?: {};
+    messageComponents?: Record<string, Component>;
+    disabled?: Ref<boolean>;
+    allowFileUploads?: Ref<boolean> | boolean;
+    allowedFilesMimeTypes?: Ref<string> | string;
+    enableStreaming?: boolean;
+}

package/dist/types/streaming.d.ts

@@ -0,0 +1,18 @@
+export type ChunkType = 'begin' | 'item' | 'end' | 'error';
+export interface StructuredChunk {
+    type: ChunkType;
+    content?: string;
+    metadata: {
+        nodeId: string;
+        nodeName: string;
+        timestamp: number;
+        runIndex: number;
+        itemIndex: number;
+    };
+}
+export interface NodeStreamingState {
+    nodeId: string;
+    chunks: string[];
+    isActive: boolean;
+    startTime: number;
+}

package/dist/types/webhook.d.ts

@@ -0,0 +1,19 @@
+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;
+    text?: string;
+    message?: string;
+    executionId?: string;
+    executionStarted?: boolean;
+}

package/dist/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/dist/utils/index.d.ts

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

package/dist/utils/mount.d.ts

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

package/dist/utils/streaming.d.ts

@@ -0,0 +1,26 @@
+import { ChatMessage, ChatMessageText } from '../types';
+export interface NodeRunData {
+    content: string;
+    isComplete: boolean;
+    message: ChatMessageText;
+}
+export declare class StreamingMessageManager {
+    private nodeRuns;
+    private runOrder;
+    private activeRuns;
+    constructor();
+    private getRunKey;
+    initializeRun(nodeId: string, runIndex?: number): ChatMessageText;
+    registerRunStart(nodeId: string, runIndex?: number): void;
+    addRunToActive(nodeId: string, runIndex?: number): ChatMessageText;
+    removeRunFromActive(nodeId: string, runIndex?: number): void;
+    addChunkToRun(nodeId: string, chunk: string, runIndex?: number): ChatMessageText | null;
+    getRunMessage(nodeId: string, runIndex?: number): ChatMessageText | null;
+    areAllRunsComplete(): boolean;
+    getRunCount(): number;
+    getActiveRunCount(): number;
+    getAllMessages(): ChatMessageText[];
+    reset(): void;
+}
+export declare function createBotMessage(id?: string): ChatMessageText;
+export declare function updateMessageInArray(messages: ChatMessage[], messageId: string, updatedMessage: ChatMessageText): void;

package/dist/utils/streamingHandlers.d.ts

@@ -0,0 +1,6 @@
+import { Ref } from 'vue';
+import { ChatMessage, ChatMessageText } from '../types';
+import { StreamingMessageManager } from './streaming';
+export declare function handleStreamingChunk(chunk: string, nodeId: string | undefined, streamingManager: StreamingMessageManager, receivedMessage: Ref<ChatMessageText | null>, messages: Ref<ChatMessage[]>, runIndex?: number): void;
+export declare function handleNodeStart(nodeId: string, streamingManager: StreamingMessageManager, runIndex?: number): void;
+export declare function handleNodeComplete(nodeId: string, streamingManager: StreamingMessageManager, runIndex?: number): void;

package/dist/utils/utils.d.ts

@@ -0,0 +1 @@
+export declare function constructChatWebsocketUrl(url: string, executionId: string, sessionId: string, isPublic: boolean): string;

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@atom8n/chat",
+  "version": "1.2.0",
+  "scripts": {
+    "dev": "pnpm run storybook",
+    "build": "pnpm build:vite && pnpm build:bundle",
+    "build:vite": "cross-env vite build",
+    "build:bundle": "cross-env INCLUDE_VUE=true vite build",
+    "preview": "vite preview",
+    "test:dev": "vitest",
+    "test": "vitest run",
+    "typecheck": "vue-tsc --noEmit",
+    "lint": "eslint src --quiet",
+    "lint:fix": "eslint src --fix",
+    "lint:styles": "stylelint \"src/**/*.{scss,sass,vue}\" --cache",
+    "lint:styles:fix": "stylelint \"src/**/*.{scss,sass,vue}\" --fix --cache",
+    "format": "biome format --write src .storybook && prettier --write src/ --ignore-path ../../../../.prettierignore",
+    "format:check": "biome ci src .storybook && prettier --check src/ --ignore-path ../../../../.prettierignore",
+    "storybook": "storybook dev -p 6006 --no-open",
+    "build:storybook": "storybook build"
+  },
+  "types": "./dist/index.d.ts",
+  "main": "./dist/chat.umd.js",
+  "module": "./dist/chat.es.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/chat.es.js",
+      "require": "./dist/chat.umd.js"
+    },
+    "./style.css": {
+      "import": "./dist/style.css",
+      "require": "./dist/style.css"
+    },
+    "./*": {
+      "import": "./*",
+      "require": "./*"
+    }
+  },
+  "dependencies": {
+    "@atom8n/design-system": "2.2.0",
+    "@vueuse/core": "catalog:frontend",
+    "highlight.js": "catalog:frontend",
+    "markdown-it-link-attributes": "^4.0.1",
+    "uuid": "catalog:",
+    "vue": "catalog:frontend",
+    "vue-markdown-render": "catalog:frontend"
+  },
+  "devDependencies": {
+    "@iconify-json/mdi": "^1.1.54",
+    "@n8n/storybook": "*",
+    "@n8n/eslint-config": "*",
+    "@n8n/stylelint-config": "*",
+    "@atom8n/typescript-config": "1.3.0",
+    "@atom8n/vitest-config": "1.5.0",
+    "@vitejs/plugin-vue": "catalog:frontend",
+    "@vitest/coverage-v8": "catalog:",
+    "unplugin-icons": "^0.19.0",
+    "vite": "catalog:",
+    "vitest": "catalog:",
+    "vite-plugin-dts": "^4.5.3",
+    "vue-tsc": "catalog:frontend"
+  },
+  "files": [
+    "README.md",
+    "dist"
+  ]
+}