@lobehub/chat 1.142.0 → 1.142.2

package/packages/model-runtime/src/core/streams/protocol.ts

@@ -1,7 +1,6 @@
+import { ChatCitationItem, ModelSpeed, ModelUsage } from '@lobechat/types';
 import type { Pricing } from 'model-bank';
 
-import { ChatCitationItem, ModelSpeed, ModelUsage } from '@/types/message';
-
 import { parseToolCalls } from '../../helpers';
 import { ChatStreamCallbacks } from '../../types';
 import { AgentRuntimeErrorType } from '../../types/error';

package/packages/model-runtime/src/core/usageConverters/anthropic.ts

@@ -1,6 +1,5 @@
 import Anthropic from '@anthropic-ai/sdk';
-
-import { ModelUsage } from '@/types/message';
+import { ModelUsage } from '@lobechat/types';
 
 import { ChatPayloadForTransformStream } from '../streams/protocol';
 import { withUsageCost } from './utils/withUsageCost';

package/packages/model-runtime/src/core/usageConverters/google-ai.ts

@@ -3,10 +3,9 @@ import {
   MediaModality,
   ModalityTokenCount,
 } from '@google/genai';
+import { ModelUsage } from '@lobechat/types';
 import type { Pricing } from 'model-bank';
 
-import { ModelUsage } from '@/types/message';
-
 import { withUsageCost } from './utils/withUsageCost';
 
 const getTokenCount = (details: ModalityTokenCount[] | undefined, modality: MediaModality) => {

package/packages/model-runtime/src/core/usageConverters/utils/computeChatCost.test.ts

@@ -1,3 +1,4 @@
+import { ModelTokensUsage } from '@lobechat/types';
 import { Pricing } from 'model-bank';
 import anthropicChatModels from 'model-bank/anthropic';
 import googleChatModels from 'model-bank/google';
@@ -5,8 +6,6 @@ import lobehubChatModels from 'model-bank/lobehub';
 import openaiChatModels from 'model-bank/openai';
 import { describe, expect, it } from 'vitest';
 
-import { ModelTokensUsage } from '@/types/message';
-
 import { computeChatCost } from './computeChatCost';
 
 describe('computeChatPricing', () => {

package/packages/model-runtime/src/core/usageConverters/utils/computeChatCost.ts

@@ -1,5 +1,6 @@
 /* eslint-disable sort-keys-fix/sort-keys-fix */
 import { CREDITS_PER_DOLLAR, USD_TO_CNY } from '@lobechat/const/currency';
+import { ModelTokensUsage } from '@lobechat/types';
 import debug from 'debug';
 import {
   FixedPricingUnit,
@@ -10,8 +11,6 @@ import {
   TieredPricingUnit,
 } from 'model-bank';
 
-import { ModelTokensUsage } from '@/types/message';
-
 const log = debug('lobe-cost:computeChatPricing');
 
 export interface PricingUnitBreakdown {

package/packages/model-runtime/src/core/usageConverters/utils/withUsageCost.ts

@@ -1,7 +1,6 @@
+import type { ModelUsage } from '@lobechat/types';
 import type { Pricing } from 'model-bank';
 
-import type { ModelUsage } from '@/types/message';
-
 import { computeChatCost } from './computeChatCost';
 import type { ComputeChatCostOptions } from './computeChatCost';
 

package/packages/model-runtime/src/types/image.ts

@@ -1,8 +1,7 @@
 /* eslint-disable typescript-sort-keys/interface */
+import { ModelUsage } from '@lobechat/types';
 import { RuntimeImageGenParams } from 'model-bank';
 
-import { ModelUsage } from '@/types/message';
-
 export type CreateImagePayload = {
   model: string;
   params: RuntimeImageGenParams;

package/packages/prompts/src/chains/__tests__/summaryHistory.test.ts

@@ -1,4 +1,4 @@
-import { ChatMessage } from '@lobechat/types';
+import { UIChatMessage } from '@lobechat/types';
 import { Mock, describe, expect, it, vi } from 'vitest';
 
 import { chainSummaryHistory } from '../summaryHistory';
@@ -9,7 +9,7 @@ describe('chainSummaryHistory', () => {
     const messages = [
       { content: 'Hello, how can I assist you?', role: 'assistant' },
       { content: 'I need help with my account.', role: 'user' },
-    ] as ChatMessage[];
+    ] as UIChatMessage[];
 
     // Act
     const result = chainSummaryHistory(messages);

package/packages/prompts/src/chains/summaryHistory.ts

@@ -1,8 +1,8 @@
-import { ChatMessage, ChatStreamPayload } from '@lobechat/types';
+import { ChatStreamPayload, UIChatMessage } from '@lobechat/types';
 
 import { chatHistoryPrompts } from '../prompts';
 
-export const chainSummaryHistory = (messages: ChatMessage[]): Partial<ChatStreamPayload> => ({
+export const chainSummaryHistory = (messages: UIChatMessage[]): Partial<ChatStreamPayload> => ({
   messages: [
     {
       content: `You're an assistant who's good at extracting key takeaways from conversations and summarizing them. Please summarize according to the user's needs. The content you need to summarize is located in the <chat_history> </chat_history> group of xml tags. The summary needs to maintain the original language.`,

package/packages/prompts/src/chains/summaryTitle.ts

@@ -1,8 +1,7 @@
-import { ChatMessage } from '@/types/message/chat';
-import { ChatStreamPayload, OpenAIChatMessage } from '@/types/openai/chat';
+import { ChatStreamPayload, OpenAIChatMessage, UIChatMessage } from '@lobechat/types';
 
 export const chainSummaryTitle = (
-  messages: (ChatMessage | OpenAIChatMessage)[],
+  messages: (UIChatMessage | OpenAIChatMessage)[],
   locale: string,
 ): Partial<ChatStreamPayload> => ({
   messages: [

package/packages/prompts/src/contexts/supervisor/makeDecision.ts

@@ -1,4 +1,4 @@
-import { ChatCompletionTool, ChatMessage, ChatStreamPayload } from '@lobechat/types';
+import { ChatCompletionTool, ChatStreamPayload, UIChatMessage } from '@lobechat/types';
 
 import { groupChatPrompts, groupSupervisorPrompts } from '../../prompts';
 import { SupervisorToolName, SupervisorTools } from './tools';
@@ -17,7 +17,7 @@ interface AgentItem {
 export interface SupervisorContext {
   allowDM?: boolean;
   availableAgents: AgentItem[];
-  messages: ChatMessage[];
+  messages: UIChatMessage[];
   // Group scene controls which tools are exposed (e.g., todos only in 'productive')
   scene?: 'casual' | 'productive';
   systemPrompt?: string;

package/packages/prompts/src/prompts/chatMessages/index.test.ts

@@ -1,4 +1,4 @@
-import { ChatMessage } from '@lobechat/types';
+import { UIChatMessage } from '@lobechat/types';
 import { describe, expect, it } from 'vitest';
 
 import {
@@ -10,8 +10,8 @@ import {
 
 let messageCounter = 0;
 const createMessage = (
-  overrides: Partial<ChatMessage> & Pick<ChatMessage, 'role' | 'content'>,
-): ChatMessage => ({
+  overrides: Partial<UIChatMessage> & Pick<UIChatMessage, 'role' | 'content'>,
+): UIChatMessage => ({
   id: overrides.id ?? `msg-${++messageCounter}`,
   createdAt: overrides.createdAt ?? 0,
   updatedAt: overrides.updatedAt ?? 0,
@@ -22,7 +22,7 @@ const createMessage = (
 describe('chatHistoryPrompts', () => {
   // Test with empty messages array
   it('should return empty chat history with empty messages', () => {
-    const messages: ChatMessage[] = [];
+    const messages: UIChatMessage[] = [];
     const result = chatHistoryPrompts(messages);
 
     expect(result).toBe(`<chat_history>
@@ -37,7 +37,7 @@ describe('chatHistoryPrompts', () => {
         role: 'user',
         content: 'Hello',
       },
-    ] as ChatMessage[];
+    ] as UIChatMessage[];
     const result = chatHistoryPrompts(messages);
 
     expect(result).toBe(`<chat_history>
@@ -60,7 +60,7 @@ describe('chatHistoryPrompts', () => {
         role: 'user',
         content: 'How are you?',
       },
-    ] as ChatMessage[];
+    ] as UIChatMessage[];
     const result = chatHistoryPrompts(messages);
 
     expect(result).toBe(`<chat_history>
@@ -81,7 +81,7 @@ describe('chatHistoryPrompts', () => {
         role: 'assistant',
         content: '<test> & </test>',
       },
-    ] as ChatMessage[];
+    ] as UIChatMessage[];
 
     const result = chatHistoryPrompts(messages);
 
@@ -98,7 +98,7 @@ describe('chatHistoryPrompts', () => {
         role: 'user',
         content: 'Line 1\nLine 2',
       },
-    ] as ChatMessage[];
+    ] as UIChatMessage[];
 
     const result = chatHistoryPrompts(messages);
 
@@ -110,7 +110,7 @@ describe('chatHistoryPrompts', () => {
 
 describe('groupSupervisorPrompts', () => {
   it('should format messages and exclude supervisor role', () => {
-    const messages: ChatMessage[] = [
+    const messages: UIChatMessage[] = [
       createMessage({ role: 'user', content: 'Hello everyone' }),
       createMessage({ role: 'assistant', agentId: 'agent-1', content: 'Reporting in' }),
       createMessage({
@@ -136,7 +136,7 @@ describe('groupSupervisorPrompts', () => {
 
 describe('groupMemeberSpeakingPrompts', () => {
   it('should wrap messages in chat_group tags', () => {
-    const messages: ChatMessage[] = [
+    const messages: UIChatMessage[] = [
       createMessage({ role: 'user', content: 'Need assistance' }),
       createMessage({ role: 'assistant', content: 'On it!' }),
     ];
@@ -156,7 +156,7 @@ describe('consolidateGroupChatHistory', () => {
   });
 
   it('should format messages with agent titles and default labels', () => {
-    const messages: ChatMessage[] = [
+    const messages: UIChatMessage[] = [
       createMessage({ role: 'assistant', content: '   ' }), // filtered out
       createMessage({ role: 'user', content: 'Hello group' }),
       createMessage({ role: 'assistant', agentId: 'agent-1', content: 'Status update' }),

package/packages/prompts/src/prompts/chatMessages/index.ts

@@ -1,17 +1,17 @@
-import { ChatMessage } from '@lobechat/types';
+import { UIChatMessage } from '@lobechat/types';
 
-const chatMessage = (message: ChatMessage) => {
+const chatMessage = (message: UIChatMessage) => {
   return `<${message.role}>${message.content}</${message.role}>`;
 };
 
-export const chatHistoryPrompts = (messages: ChatMessage[]) => {
+export const chatHistoryPrompts = (messages: UIChatMessage[]) => {
   return `<chat_history>
 ${messages.map((m) => chatMessage(m)).join('\n')}
 </chat_history>`;
 };
 
-export const groupSupervisorPrompts = (messages: ChatMessage[]) => {
-  const formatMessage = (message: ChatMessage) => {
+export const groupSupervisorPrompts = (messages: UIChatMessage[]) => {
+  const formatMessage = (message: UIChatMessage) => {
     const author = message.role === 'user' ? 'user' : message.agentId || 'assistant';
     const targetAttr = message.targetId ? ` target="${message.targetId}"` : '';
     return `<message author="${author}"${targetAttr}>${message.content}</message>`;
@@ -23,7 +23,7 @@ export const groupSupervisorPrompts = (messages: ChatMessage[]) => {
   return filteredMessages.map((m) => formatMessage(m)).join('\n');
 };
 
-export const groupMemeberSpeakingPrompts = (messages: ChatMessage[]) => {
+export const groupMemeberSpeakingPrompts = (messages: UIChatMessage[]) => {
   return `<chat_group>
 ${messages.map((m) => chatMessage(m)).join('\n')}
 </chat_group>`;
@@ -36,10 +36,13 @@ ${messages.map((m) => chatMessage(m)).join('\n')}
  * - Agent sees DMs they sent
  * - Agent sees user messages that are group messages or targeted to them
  * - For DM messages not involving the agent, content is replaced with "***"
- * 
+ *
  * TODO: Use context engineering to filter messages
  */
-export const filterMessagesForAgent = (messages: ChatMessage[], agentId: string): ChatMessage[] => {
+export const filterMessagesForAgent = (
+  messages: UIChatMessage[],
+  agentId: string,
+): UIChatMessage[] => {
   return messages
     .filter((message) => {
       // Exclude supervisor messages (messages with role="supervisor")
@@ -107,7 +110,7 @@ export const filterMessagesForAgent = (messages: ChatMessage[], agentId: string)
  * for use in system messages. Each message is formatted as "(AuthorName): content"
  */
 export const consolidateGroupChatHistory = (
-  messages: ChatMessage[],
+  messages: UIChatMessage[],
   agents: { id: string; title: string }[] = [],
 ) => {
   if (messages.length === 0) return '';
@@ -115,7 +118,7 @@ export const consolidateGroupChatHistory = (
   // Create a map for quick agent lookup
   const agentMap = new Map(agents.map((agent) => [agent.id, agent.title]));
 
-  const formatMessage = (message: ChatMessage) => {
+  const formatMessage = (message: UIChatMessage) => {
     let authorName: string;
 
     if (message.role === 'user') {

package/packages/prompts/src/prompts/groupChat/index.test.ts

@@ -1,7 +1,6 @@
+import type { UIChatMessage } from '@lobechat/types';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
-import type { ChatMessage } from '@/types/index';
-
 import { filterMessagesForAgent } from '../chatMessages';
 import { buildGroupChatSystemPrompt } from './index';
 
@@ -13,7 +12,7 @@ describe('buildGroupChatSystemPrompt', () => {
     vi.spyOn(Date, 'now').mockReturnValue(mockTimestamp);
   });
 
-  const messages: ChatMessage[] = [
+  const messages: UIChatMessage[] = [
     {
       id: 'm1',
       role: 'user',
@@ -109,7 +108,7 @@ describe('filterMessagesForAgent', () => {
     role: 'user' | 'assistant' | 'system',
     content: string,
     options?: { agentId?: string; targetId?: string },
-  ): ChatMessage => ({
+  ): UIChatMessage => ({
     id,
     role,
     content,

package/packages/prompts/src/prompts/groupChat/index.ts

@@ -1,4 +1,4 @@
-import { ChatMessage } from '@/types/index';
+import { UIChatMessage } from '@lobechat/types';
 
 export interface GroupMemberInfo {
   id: string;
@@ -27,7 +27,7 @@ export const buildGroupChatSystemPrompt = ({
   baseSystemRole?: string;
   groupMembers: GroupMemberInfo[];
   instruction?: string;
-  messages: ChatMessage[];
+  messages: UIChatMessage[];
   targetId?: string;
 }): string => {
   const membersTag = buildGroupMembersTag(groupMembers);
@@ -138,7 +138,7 @@ RULES:
 WHEN ASKING AGENTS TO SPEAK:
 
 - Only reference agents from the member list. Never invent new IDs.
-- Do not excessivly gathering information from user, you should only ask for information when it's necessary. 
+- Do not excessivly gathering information from user, you should only ask for information when it's necessary.
 - If need many information from user, make single agent to ask for all.
 ${dmRules}
 

package/packages/types/src/aiChat.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 
-import { ChatMessage } from './message';
+import { UIChatMessage } from './message';
 import { OpenAIChatMessage } from './openai/chat';
 import { LobeUniformTool, LobeUniformToolSchema } from './tool';
 import { ChatTopic } from './topic';
@@ -50,7 +50,7 @@ export const AiSendMessageServerSchema = z.object({
 export interface SendMessageServerResponse {
   assistantMessageId: string;
   isCreateNewTopic: boolean;
-  messages: ChatMessage[];
+  messages: UIChatMessage[];
   topicId: string;
   topics?: ChatTopic[];
   userMessageId: string;

package/packages/types/src/exportConfig.ts

@@ -1,7 +1,7 @@
-import { ChatMessage } from '@/types/message';
-import { LobeSessions, SessionGroupItem } from '@/types/session';
-import { ChatTopic } from '@/types/topic';
-import { UserSettings } from '@/types/user/settings';
+import { UIChatMessage } from './message';
+import { LobeSessions, SessionGroupItem } from './session';
+import { ChatTopic } from './topic';
+import { UserSettings } from './user/settings';
 
 // ---------- TODO: this file need to be deleted in V2 ---------- //
 
@@ -44,7 +44,7 @@ export interface ConfigModelMap {
  * 配置状态：会话
  */
 export interface ConfigStateSessions {
-  messages: ChatMessage[];
+  messages: UIChatMessage[];
   sessionGroups: SessionGroupItem[];
   sessions: LobeSessions;
   topics: ChatTopic[];
@@ -54,7 +54,7 @@ export interface ConfigStateSessions {
  * 配置状态：单个会话
  */
 export interface ConfigStateSingleSession {
-  messages: ChatMessage[];
+  messages: UIChatMessage[];
   sessions: LobeSessions;
   topics: ChatTopic[];
 }

package/packages/types/src/importer.ts

@@ -5,7 +5,7 @@ import {
   ChatTTS,
   ChatToolPayload,
   ChatTranslate,
-  MessageRoleType,
+  UIMessageRoleType,
 } from './message';
 import { MetaData } from './meta';
 import { SessionGroupId } from './session';
@@ -51,7 +51,7 @@ export interface ImportMessage {
   pluginState?: any;
 
   quotaId?: string;
-  role: MessageRoleType;
+  role: UIMessageRoleType;
 
   sessionId?: string;
   tool_call_id?: string;

package/packages/types/src/index.ts

@@ -11,6 +11,7 @@ export * from './discover';
 export * from './eval';
 export * from './fetch';
 export * from './files';
+export * from './generation';
 export * from './hotkey';
 export * from './knowledgeBase';
 export * from './llm';
@@ -20,6 +21,7 @@ export * from './plugins';
 export * from './rag';
 export * from './search';
 export * from './serverConfig';
+export * from './service';
 export * from './session';
 export * from './tool';
 export * from './topic';

package/packages/types/src/message/common/base.ts

@@ -0,0 +1,27 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix , typescript-sort-keys/interface */
+import type { ILobeAgentRuntimeErrorType } from '@lobechat/model-runtime';
+import type { IPluginErrorType } from '@lobehub/chat-plugin-sdk';
+
+import { ErrorType } from '../../fetch';
+
+/**
+ * 聊天消息错误对象
+ */
+export interface ChatMessageError {
+  body?: any;
+  message: string;
+  type: ErrorType | IPluginErrorType | ILobeAgentRuntimeErrorType;
+}
+
+export interface ChatCitationItem {
+  id?: string;
+  onlyUrl?: boolean;
+  title?: string;
+  url: string;
+}
+
+export interface ModelReasoning {
+  content?: string;
+  duration?: number;
+  signature?: string;
+}

package/packages/types/src/message/common/index.ts

@@ -0,0 +1,5 @@
+export * from './base';
+export * from './image';
+export * from './metadata';
+export * from './tools';
+export * from './translate';

package/packages/types/src/message/common/metadata.ts

@@ -0,0 +1,67 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix , typescript-sort-keys/interface */
+
+export interface ModelTokensUsage {
+  // Input tokens breakdown
+  /**
+   * user prompt input
+   */
+  // Input cache tokens
+  inputCachedTokens?: number;
+  inputCacheMissTokens?: number;
+  inputWriteCacheTokens?: number;
+
+  inputTextTokens?: number;
+  /**
+   * user prompt image
+   */
+  inputImageTokens?: number;
+  inputAudioTokens?: number;
+  /**
+   * currently only pplx has citation_tokens
+   */
+  inputCitationTokens?: number;
+
+  // Output tokens breakdown
+  outputTextTokens?: number;
+  outputImageTokens?: number;
+  outputAudioTokens?: number;
+  outputReasoningTokens?: number;
+
+  // Prediction tokens
+  acceptedPredictionTokens?: number;
+  rejectedPredictionTokens?: number;
+
+  // Total tokens
+  // TODO: make all following fields required
+  totalInputTokens?: number;
+  totalOutputTokens?: number;
+  totalTokens?: number;
+}
+
+export interface ModelUsage extends ModelTokensUsage {
+  /**
+   * dollar
+   */
+  cost?: number;
+}
+
+export interface ModelSpeed {
+  /**
+   * tokens per second
+   */
+  tps?: number;
+  /**
+   * time to first token
+   */
+  ttft?: number;
+  /**
+   * from output start to output finish
+   */
+  duration?: number;
+  /**
+   * from input start to output finish
+   */
+  latency?: number;
+}
+
+export interface MessageMetadata extends ModelUsage, ModelSpeed {}

package/packages/types/src/message/{tools.ts → common/tools.ts}

@@ -2,7 +2,7 @@ import { IPluginErrorType } from '@lobehub/chat-plugin-sdk';
 import type { PartialDeep } from 'type-fest';
 import { z } from 'zod';
 
-import { LobeToolRenderType } from '../tool';
+import { LobeToolRenderType } from '../../tool';
 
 export interface ChatPluginPayload {
   apiName: string;

package/packages/types/src/message/common/translate.ts

@@ -0,0 +1,8 @@
+export interface Translate {
+  from?: string;
+  to: string;
+}
+
+export interface ChatTranslate extends Translate {
+  content?: string;
+}

package/packages/types/src/message/db/index.ts

@@ -0,0 +1,2 @@
+export * from './item';
+export * from './params';

package/packages/types/src/message/db/item.ts

@@ -0,0 +1,29 @@
+import { GroundingSearch } from '../../search';
+import { MessageMetadata, ModelReasoning } from '../common';
+
+export interface DBMessageItem {
+  agentId: string | null;
+  clientId: string | null;
+  content: string | null;
+  createdAt: Date;
+  error: any | null;
+  favorite: boolean | null;
+  id: string;
+  metadata?: MessageMetadata | null;
+  model: string | null;
+  observationId: string | null;
+  parentId: string | null;
+  provider: string | null;
+  quotaId: string | null;
+  reasoning: ModelReasoning | null;
+  role: string;
+  search: GroundingSearch | null;
+  sessionId: string | null;
+  threadId: string | null;
+  tools: any | null;
+  topicId: string | null;
+  // jsonb type
+  traceId: string | null;
+  updatedAt: Date;
+  userId: string;
+}

package/packages/types/src/message/db/params.ts

@@ -0,0 +1,57 @@
+import { GroundingSearch } from '../../search';
+import {
+  ChatImageItem,
+  ChatMessageError,
+  ChatToolPayload,
+  MessageMetadata,
+  MessageToolCall,
+  ModelReasoning,
+} from '../common';
+
+export interface NewMessage {
+  agentId?: string | null;
+  clientId?: string | null;
+  content?: string | null;
+  createdAt?: Date;
+  // optional because it has a default value
+  error?: any | null;
+  favorite?: boolean;
+  id?: string;
+  model?: string | null;
+  observationId?: string | null;
+  parentId?: string | null;
+  provider?: string | null;
+  quotaId?: string | null;
+  // optional because it has a default function
+  role: 'user' | 'system' | 'assistant' | 'tool';
+  // required because it's notNull
+  sessionId?: string | null;
+  threadId?: string | null;
+  tools?: any | null;
+  topicId?: string | null;
+  traceId?: string | null;
+  // optional because it's generated
+  updatedAt?: Date;
+  userId: string; // optional because it's generated
+}
+
+export interface UpdateMessageParams {
+  content?: string;
+  error?: ChatMessageError | null;
+  imageList?: ChatImageItem[];
+  metadata?: MessageMetadata;
+  model?: string;
+  provider?: string;
+  reasoning?: ModelReasoning;
+  role?: string;
+  search?: GroundingSearch;
+  toolCalls?: MessageToolCall[];
+  tools?: ChatToolPayload[] | null;
+}
+
+export interface NewMessageQueryParams {
+  embeddingsId: string;
+  messageId: string;
+  rewriteQuery: string;
+  userQuery: string;
+}

package/packages/types/src/message/index.ts

@@ -1,9 +1,6 @@
-export * from './base';
-export * from './chat';
-export * from './image';
-export * from './rag';
-export * from './tools';
-export * from './video';
+export * from './common';
+export * from './db';
+export * from './ui';
 
 export interface ModelRankItem {
   count: number;