@aleph-alpha/chat-kit 1.0.0 → 1.2.0

package/src/index.ts

@@ -0,0 +1,86 @@
+// Services
+export {
+  ChatService,
+  type IChatService,
+  type ChatConfig,
+  type ChatMessage,
+  type ChatResponse,
+  type ConversationSummary,
+  type HttpClient,
+  type RawConversation,
+  type RawConversationList,
+  type StreamEvent,
+} from './services';
+
+// Handlers
+export {
+  useMessageHandler,
+  useMarkdownParser,
+  provideChatKitLabels,
+  useChatKitLabels,
+  defaultChatKitLabels,
+  CHAT_KIT_LABELS,
+} from './handlers';
+export type { ChatKitLabels } from './handlers';
+
+// Composables
+export {
+  useChat,
+  useConversationSessions,
+  useConversations,
+} from './composables';
+export type {
+  ChatActions,
+  ChatState,
+  ConversationSession,
+  CreateConversationInput,
+  MessageHandler,
+  MutationOptions,
+  UseChatReturn,
+  UseConversationSessionsReturn,
+  UseConversationsOptions,
+  UseConversationsReturn,
+} from './composables';
+
+// Components
+export {
+  CkAgentMessage,
+  CkConversation,
+  CkConversationLayout,
+  CkCopyMessageActionButton,
+  CkHistory,
+  CkHistoryItem,
+  CkHistoryWrapper,
+  CkInput,
+  CkMarkdownRenderer,
+  CkMessageActionButton,
+  CkPromptActionButton,
+  CkPromptStopButton,
+  CkPromptInput,
+  CkPromptInputDisclaimer,
+  CkSendIcon,
+  CkStopIcon,
+  CkUserMessage,
+} from './components';
+export type {
+  CkConversationLayoutProps,
+  CkConversationProps,
+  CkHistoryEmits,
+  CkHistoryItemEmits,
+  CkHistoryItemProps,
+  CkHistoryProps,
+  CkHistoryWrapperProps,
+  CkMarkdownElementClasses,
+  CkMarkdownRendererProps,
+  CkUserMessageProps,
+} from './components';
+
+// Shared Types
+export type {
+  BaseMessage,
+  Conversation,
+  ConversationTree,
+  MessageRole,
+  MessageStatus,
+  TreeMessage,
+} from './types';

package/src/services/ChatService.ts

@@ -0,0 +1,60 @@
+import type {
+  ChatConfig,
+  ChatMessage,
+  ChatResponse,
+  StreamEvent,
+} from './types';
+
+/**
+ * Interface for chat service implementations
+ *
+ * This is a skeleton interface that defines the contract for chat services.
+ * Implementations should provide concrete implementations of these methods.
+ */
+export interface IChatService {
+  /**
+   * Send a message and receive a response
+   * @param message - The message to send
+   * @returns Promise resolving to the chat response
+   */
+  sendMessage(message: ChatMessage): Promise<ChatResponse>;
+
+  /**
+   * Get chat history
+   * @param limit - Maximum number of messages to retrieve
+   * @returns Promise resolving to an array of messages
+   */
+  getHistory(limit?: number): Promise<ChatMessage[]>;
+
+  /**
+   * Stream a message response
+   * @param message - The message to send
+   * @param onEvent - Callback for stream events
+   * @returns Promise that resolves when streaming is complete
+   */
+  streamMessage(
+    message: ChatMessage,
+    onEvent: (event: StreamEvent) => void,
+  ): Promise<void>;
+}
+
+/**
+ * Abstract base class for chat service implementations
+ *
+ * This is a skeleton abstract class that can be extended to create
+ * concrete chat service implementations.
+ */
+export abstract class ChatService implements IChatService {
+  protected config: ChatConfig;
+
+  constructor(config?: ChatConfig) {
+    this.config = config || {};
+  }
+
+  abstract sendMessage(message: ChatMessage): Promise<ChatResponse>;
+  abstract getHistory(limit?: number): Promise<ChatMessage[]>;
+  abstract streamMessage(
+    message: ChatMessage,
+    onEvent: (event: StreamEvent) => void,
+  ): Promise<void>;
+}

package/src/services/MockChatService.ts

@@ -0,0 +1,47 @@
+import type { BaseMessage } from '../types';
+import { ChatService, type IChatService } from './ChatService';
+import type { ChatMessage, ChatResponse, StreamEvent } from './types';
+
+export class MockChatService extends ChatService implements IChatService {
+  constructor() {
+    super({});
+  }
+
+  async sendMessage(message: ChatMessage): Promise<ChatResponse> {
+    const replyText = `Mock reply: ${message.content}`;
+
+    return {
+      message: this.createBaseMessage({
+        role: 'assistant',
+        content: replyText,
+      }),
+      metadata: { mock: true },
+    };
+  }
+
+  async getHistory(): Promise<ChatMessage[]> {
+    return [];
+  }
+
+  async streamMessage(
+    message: ChatMessage,
+    onEvent: (event: StreamEvent) => void,
+  ): Promise<void> {
+    const response = await this.sendMessage(message);
+    onEvent({ type: 'chunk', data: response.message.content });
+    onEvent({ type: 'done' });
+  }
+
+  private createBaseMessage(input: {
+    role: BaseMessage['role'];
+    content: string;
+  }): BaseMessage {
+    return {
+      id: crypto.randomUUID(),
+      role: input.role,
+      content: input.content,
+      createdAt: new Date(),
+      status: 'completed',
+    };
+  }
+}

package/src/services/index.ts

@@ -0,0 +1,12 @@
+export { ChatService, type IChatService } from './ChatService';
+export { MockChatService } from './MockChatService';
+export type {
+  ChatConfig,
+  ChatMessage,
+  ChatResponse,
+  ConversationSummary,
+  HttpClient,
+  RawConversation,
+  RawConversationList,
+  StreamEvent,
+} from './types';

package/src/services/types.ts

@@ -0,0 +1,92 @@
+import type { BaseMessage, MessageRole } from '../types';
+
+/**
+ * Minimal HTTP transport contract that chat-kit composables depend on.
+ *
+ * The app injects an implementation (typically a thin wrapper around
+ * `fetch`, `ofetch`, or `axios`). The app owns the base URL, auth headers,
+ * retries, and error shape normalisation. chat-kit only calls these methods
+ * with the path it was given and assumes the response is JSON.
+ */
+export interface HttpClient {
+  get<T>(
+    path: string,
+    options?: { params?: Record<string, unknown> },
+  ): Promise<T>;
+  post<T>(path: string, body?: unknown): Promise<T>;
+  delete(path: string): Promise<void>;
+}
+
+/**
+ * One past conversation, in the shape chat-kit consumers work with.
+ *
+ * This is the shape consumers work with. The raw server response is mapped
+ * into this internally by `useConversations`.
+ */
+export interface ConversationSummary {
+  id: string;
+  title: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+/**
+ * Raw server response for a single conversation, in the OpenAI-style API
+ * shape. Consumers should not need to use this directly; `useConversations`
+ * maps it to `ConversationSummary`.
+ */
+export interface RawConversation {
+  id: string;
+  object?: string;
+  metadata?: { title?: string; [key: string]: unknown } | null;
+  created_at: number;
+  updated_at: number;
+}
+
+/**
+ * Raw server response for a list of conversations, in the OpenAI-style API
+ * shape.
+ */
+export interface RawConversationList {
+  object?: string;
+  data: RawConversation[];
+  has_more: boolean;
+  first_id?: string | null;
+  last_id?: string | null;
+}
+
+/**
+ * Chat message sent to the service
+ */
+export interface ChatMessage {
+  id: string;
+  role: MessageRole;
+  content: string;
+}
+
+/**
+ * Response from the chat service
+ */
+export interface ChatResponse {
+  message: BaseMessage;
+  metadata?: Record<string, unknown>;
+}
+
+/**
+ * Stream event emitted during message streaming
+ */
+export interface StreamEvent {
+  type: 'chunk' | 'done' | 'error';
+  data?: string;
+  error?: Error;
+}
+
+/**
+ * Configuration for the chat service
+ */
+export interface ChatConfig {
+  apiEndpoint?: string;
+  timeout?: number;
+  retries?: number;
+  headers?: Record<string, string>;
+}

package/src/test-setup.ts

@@ -0,0 +1,12 @@
+/**
+ * Global test setup for JSDOM environment.
+ * Polyfills browser APIs not available in JSDOM.
+ */
+import '@testing-library/jest-dom/vitest';
+
+// ResizeObserver is not available in JSDOM
+global.ResizeObserver = class ResizeObserver {
+  observe(): void {}
+  unobserve(): void {}
+  disconnect(): void {}
+};

package/src/test-utils/createTextPlugin.ts

@@ -0,0 +1,9 @@
+export function createTextPlugin(transform: (text: string) => string) {
+  return () => (tree: any) => {
+    const visit = (node: any) => {
+      if (node.type === 'text') node.value = transform(node.value);
+      if (node.children) node.children.forEach(visit);
+    };
+    visit(tree);
+  };
+}

package/src/types.ts

@@ -0,0 +1,47 @@
+/**
+ * Shared types used across the chat-kit package layers
+ */
+
+export type MessageRole = 'user' | 'assistant' | 'system';
+
+export type MessageStatus = 'started' | 'sending' | 'completed' | 'error';
+
+export interface BaseMessage {
+  id: string;
+  role: MessageRole;
+  content: string;
+  createdAt: Date;
+  status: MessageStatus;
+  siblingIds?: string[];
+  siblingIndex?: number;
+}
+
+export interface TreeMessage {
+  id: string;
+  parentId: string | null;
+  childrenIds: string[];
+  activeChildIndex: number;
+  role: MessageRole;
+  content: string;
+  status: MessageStatus;
+  createdAt: Date;
+}
+
+export interface ConversationTree {
+  nodes: Record<string, TreeMessage>;
+  rootId: string | null;
+}
+
+/**
+ * High-level conversation record consumed by `CkHistory`.
+ *
+ * `createdAt` and `updatedAt` are expected to be **Unix seconds**.
+ * `title` is optional; `CkHistory` falls back to a localised "Untitled"
+ * label when it is missing or blank.
+ */
+export interface Conversation {
+  id: string;
+  title?: string;
+  createdAt: number;
+  updatedAt: number;
+}

package/dist/generateId-BHf0W4Rq.js

@@ -1,6 +0,0 @@
-function generateId() {
-  return typeof crypto !== "undefined" && "randomUUID" in crypto ? crypto.randomUUID() : String(Date.now());
-}
-export {
-  generateId as g
-};