@aleph-alpha/chat-kit 1.3.0 → 1.4.0

package/src/helpers/conversationTree.spec.ts

@@ -1,4 +1,9 @@
-import type { ConversationTree, TreeMessage } from '../types';
+import type {
+  ConversationTree,
+  MessageContent,
+  MessageTextContent,
+  TreeMessage,
+} from '../types';
 import {
   addNode,
   createEmptyTree,
@@ -8,6 +13,17 @@ import {
   updateNodeId,
 } from './conversationTree';
 
+let textIdCounter = 0;
+function text(value: string): MessageTextContent {
+  textIdCounter += 1;
+  return {
+    type: 'text',
+    id: `txt-${textIdCounter}`,
+    text: value,
+    status: 'completed',
+  };
+}
+
 function makeTreeMessage(
   overrides: Partial<TreeMessage> & { id: string },
 ): TreeMessage {
@@ -16,7 +32,7 @@ function makeTreeMessage(
     childrenIds: [],
     activeChildIndex: 0,
     role: 'user',
-    content: '',
+    content: [],
     status: 'completed',
     createdAt: new Date('2025-01-01'),
     ...overrides,
@@ -42,6 +58,13 @@ function makeTree(
   return { nodes, rootId };
 }
 
+function getText(content: MessageContent[]): string {
+  return content
+    .filter((c): c is MessageTextContent => c.type === 'text')
+    .map((c) => c.text)
+    .join('');
+}
+
 /**
  * Builds a simple branching tree for tests:
  *
@@ -58,42 +81,42 @@ function makeTree(
 function makeBranchingTree(): ConversationTree {
   return makeTree(
     {
-      u1: makeTreeMessage({ id: 'u1', role: 'user', content: 'Hello' }),
+      u1: makeTreeMessage({ id: 'u1', role: 'user', content: [text('Hello')] }),
       a1: makeTreeMessage({
         id: 'a1',
         parentId: 'u1',
         role: 'assistant',
-        content: 'Hi',
+        content: [text('Hi')],
       }),
       u2: makeTreeMessage({
         id: 'u2',
         parentId: 'a1',
         role: 'user',
-        content: 'Question',
+        content: [text('Question')],
       }),
       a2: makeTreeMessage({
         id: 'a2',
         parentId: 'u2',
         role: 'assistant',
-        content: 'Answer 1',
+        content: [text('Answer 1')],
       }),
       a3: makeTreeMessage({
         id: 'a3',
         parentId: 'u2',
         role: 'assistant',
-        content: 'Answer 2',
+        content: [text('Answer 2')],
       }),
       a1b: makeTreeMessage({
         id: 'a1b',
         parentId: 'u1',
         role: 'assistant',
-        content: 'Alt hi',
+        content: [text('Alt hi')],
       }),
       u3: makeTreeMessage({
         id: 'u3',
         parentId: 'a1b',
         role: 'user',
-        content: 'Follow-up',
+        content: [text('Follow-up')],
       }),
     },
     'u1',
@@ -166,7 +189,7 @@ describe('getLinearPath', () => {
 
     const u1Msg = path[0];
     expect(u1Msg.role).toBe('user');
-    expect(u1Msg.content).toBe('Hello');
+    expect(getText(u1Msg.content)).toBe('Hello');
     expect(u1Msg.status).toBe('completed');
     expect(u1Msg.createdAt).toEqual(new Date('2025-01-01'));
   });
@@ -175,7 +198,7 @@ describe('getLinearPath', () => {
 describe('addNode', () => {
   it('adds the first node as root', () => {
     const tree = createEmptyTree();
-    const node = makeTreeMessage({ id: 'u1', content: 'Hello' });
+    const node = makeTreeMessage({ id: 'u1', content: [text('Hello')] });
 
     addNode(tree, node);
 
@@ -248,8 +271,8 @@ describe('addNode', () => {
 describe('updateNode', () => {
   it('updates content of an existing node', () => {
     const tree = makeBranchingTree();
-    updateNode(tree, 'a1', { content: 'Updated hi' });
-    expect(tree.nodes.a1.content).toBe('Updated hi');
+    updateNode(tree, 'a1', { content: [text('Updated hi')] });
+    expect(getText(tree.nodes.a1.content)).toBe('Updated hi');
   });
 
   it('updates status of an existing node', () => {
@@ -261,7 +284,7 @@ describe('updateNode', () => {
   it('is a no-op for nonexistent id', () => {
     const tree = makeBranchingTree();
     const nodeCount = Object.keys(tree.nodes).length;
-    updateNode(tree, 'nonexistent', { content: 'x' });
+    updateNode(tree, 'nonexistent', { content: [text('x')] });
     expect(Object.keys(tree.nodes).length).toBe(nodeCount);
   });
 });
@@ -366,19 +389,23 @@ describe('integration: full branching scenario', () => {
   it('simulates send → regenerate → navigate workflow', () => {
     const tree = createEmptyTree();
 
-    addNode(tree, makeTreeMessage({ id: 'u1', content: 'Hello' }));
+    addNode(tree, makeTreeMessage({ id: 'u1', content: [text('Hello')] }));
     addNode(
       tree,
       makeTreeMessage({
         id: 'a1',
         parentId: 'u1',
         role: 'assistant',
-        content: 'Hi there',
+        content: [text('Hi there')],
       }),
     );
     addNode(
       tree,
-      makeTreeMessage({ id: 'u2', parentId: 'a1', content: 'Tell me more' }),
+      makeTreeMessage({
+        id: 'u2',
+        parentId: 'a1',
+        content: [text('Tell me more')],
+      }),
     );
     addNode(
       tree,
@@ -386,7 +413,7 @@ describe('integration: full branching scenario', () => {
         id: 'a2',
         parentId: 'u2',
         role: 'assistant',
-        content: 'Sure thing',
+        content: [text('Sure thing')],
       }),
     );
 
@@ -399,7 +426,7 @@ describe('integration: full branching scenario', () => {
         id: 'a3',
         parentId: 'u2',
         role: 'assistant',
-        content: 'Certainly!',
+        content: [text('Certainly!')],
       }),
     );
 

package/src/index.ts

@@ -1,7 +1,5 @@
 // Services
 export {
-  ChatService,
-  type IChatService,
   type ChatConfig,
   type ChatMessage,
   type ChatResponse,
@@ -12,6 +10,12 @@ export {
   type StreamEvent,
 } from './services';
 
+// Adapters' wire-level types (e.g. Responses-API) are intentionally NOT
+// re-exported at the top level — import them from
+// `@aleph-alpha/chat-kit/adapters/responses-api` (or the aggregate
+// `@aleph-alpha/chat-kit/adapters`) to keep the format you depend on
+// explicit.
+
 // Handlers
 export {
   useMessageHandler,
@@ -83,7 +87,12 @@ export type {
   BaseMessage,
   Conversation,
   ConversationTree,
+  MessageContent,
+  MessageContentStatus,
+  MessageReasoningContent,
   MessageRole,
   MessageStatus,
+  MessageTextContent,
+  MessageToolContent,
   TreeMessage,
 } from './types';

package/src/services/index.ts

@@ -1,5 +1,3 @@
-export { ChatService, type IChatService } from './ChatService';
-export { MockChatService } from './MockChatService';
 export type {
   ChatConfig,
   ChatMessage,

package/src/services/types.ts

@@ -1,4 +1,4 @@
-import type { BaseMessage, MessageRole } from '../types';
+import type { BaseMessage, MessageContent, MessageRole } from '../types';
 
 /**
  * Minimal HTTP transport contract that chat-kit composables depend on.
@@ -61,7 +61,7 @@ export interface RawConversationList {
 export interface ChatMessage {
   id: string;
   role: MessageRole;
-  content: string;
+  content: MessageContent[];
 }
 
 /**

package/src/types.ts

@@ -6,10 +6,63 @@ export type MessageRole = 'user' | 'assistant' | 'system';
 
 export type MessageStatus = 'started' | 'sending' | 'completed' | 'error';
 
+/**
+ * Lifecycle of a single content item inside a message — used to indicate
+ * whether a streamed text part is still being produced, has finished, or was
+ * cut short. Tool content does not carry a status (it represents a single
+ * fired tool call) so it always omits this field.
+ */
+export type MessageContentStatus = 'in_progress' | 'completed' | 'incomplete';
+
+/**
+ * Plain text part of a message. Multiple text parts can appear in a single
+ * assistant turn, interleaved with reasoning and tool calls.
+ */
+export interface MessageTextContent {
+  type: 'text';
+  id: string;
+  text: string;
+  status: MessageContentStatus;
+}
+
+/**
+ * Tool invocation triggered by the assistant during its turn. Only the tool
+ * name is rendered; arguments and results are intentionally outside the
+ * UI-facing model and should be tracked by the host application.
+ */
+export interface MessageToolContent {
+  type: 'tool';
+  id: string;
+  name: string;
+}
+
+/**
+ * Chain-of-thought / reasoning segment produced by the assistant. `text` is
+ * the (optional) human-readable trail — populated when the underlying
+ * transport exposes reasoning content (`REASONING_MESSAGE_CONTENT` deltas
+ * during a live run, `reasoning_text` parts when re-hydrating from the
+ * Responses API). Surfaces that only need a "Thinking…" / "Thought"
+ * indicator can ignore it and rely on `status` alone.
+ */
+export interface MessageReasoningContent {
+  type: 'reasoning';
+  id: string;
+  text?: string;
+  status: MessageContentStatus;
+}
+
+/**
+ * Discriminated union of all content parts that can appear inside a message.
+ */
+export type MessageContent =
+  | MessageTextContent
+  | MessageToolContent
+  | MessageReasoningContent;
+
 export interface BaseMessage {
   id: string;
   role: MessageRole;
-  content: string;
+  content: MessageContent[];
   createdAt: Date;
   status: MessageStatus;
   siblingIds?: string[];
@@ -22,7 +75,7 @@ export interface TreeMessage {
   childrenIds: string[];
   activeChildIndex: number;
   role: MessageRole;
-  content: string;
+  content: MessageContent[];
   status: MessageStatus;
   createdAt: Date;
 }

package/dist/ChatService-LogwJNxh.js

@@ -1,9 +0,0 @@
-class ChatService {
-  config;
-  constructor(config) {
-    this.config = config || {};
-  }
-}
-export {
-  ChatService as C
-};

package/dist/services/ChatService.d.ts

@@ -1,42 +0,0 @@
-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 declare abstract class ChatService implements IChatService {
-    protected config: ChatConfig;
-    constructor(config?: ChatConfig);
-    abstract sendMessage(message: ChatMessage): Promise<ChatResponse>;
-    abstract getHistory(limit?: number): Promise<ChatMessage[]>;
-    abstract streamMessage(message: ChatMessage, onEvent: (event: StreamEvent) => void): Promise<void>;
-}
-//# sourceMappingURL=ChatService.d.ts.map

package/dist/services/ChatService.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ChatService.d.ts","sourceRoot":"","sources":["../../src/services/ChatService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACZ,MAAM,SAAS,CAAC;AAEjB;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAEzD;;;;OAIG;IACH,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEnD;;;;;OAKG;IACH,aAAa,CACX,OAAO,EAAE,WAAW,EACpB,OAAO,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED;;;;;GAKG;AACH,8BAAsB,WAAY,YAAW,YAAY;IACvD,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC;gBAEjB,MAAM,CAAC,EAAE,UAAU;IAI/B,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IACjE,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAC3D,QAAQ,CAAC,aAAa,CACpB,OAAO,EAAE,WAAW,EACpB,OAAO,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,IAAI,CAAC;CACjB"}

package/dist/services/MockChatService.d.ts

@@ -1,10 +0,0 @@
-import { ChatService, type IChatService } from './ChatService';
-import type { ChatMessage, ChatResponse, StreamEvent } from './types';
-export declare class MockChatService extends ChatService implements IChatService {
-    constructor();
-    sendMessage(message: ChatMessage): Promise<ChatResponse>;
-    getHistory(): Promise<ChatMessage[]>;
-    streamMessage(message: ChatMessage, onEvent: (event: StreamEvent) => void): Promise<void>;
-    private createBaseMessage;
-}
-//# sourceMappingURL=MockChatService.d.ts.map

package/dist/services/MockChatService.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"MockChatService.d.ts","sourceRoot":"","sources":["../../src/services/MockChatService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtE,qBAAa,eAAgB,SAAQ,WAAY,YAAW,YAAY;;IAKhE,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IAYxD,UAAU,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAIpC,aAAa,CACjB,OAAO,EAAE,WAAW,EACpB,OAAO,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,IAAI,CAAC;IAMhB,OAAO,CAAC,iBAAiB;CAY1B"}

package/src/services/ChatService.ts

@@ -1,60 +0,0 @@
-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

@@ -1,47 +0,0 @@
-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',
-    };
-  }
-}