@lobehub/lobehub 2.0.0-next.3 → 2.0.0-next.31

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

@@ -1,4 +1,5 @@
 /* eslint-disable sort-keys-fix/sort-keys-fix , typescript-sort-keys/interface */
+import { z } from 'zod';
 
 export interface ModelTokensUsage {
   // Input tokens breakdown
@@ -38,6 +39,44 @@ export interface ModelTokensUsage {
   totalTokens?: number;
 }
 
+export const ModelUsageSchema = z.object({
+  // Input tokens breakdown
+  inputCachedTokens: z.number().optional(),
+  inputCacheMissTokens: z.number().optional(),
+  inputWriteCacheTokens: z.number().optional(),
+  inputTextTokens: z.number().optional(),
+  inputImageTokens: z.number().optional(),
+  inputAudioTokens: z.number().optional(),
+  inputCitationTokens: z.number().optional(),
+
+  // Output tokens breakdown
+  outputTextTokens: z.number().optional(),
+  outputImageTokens: z.number().optional(),
+  outputAudioTokens: z.number().optional(),
+  outputReasoningTokens: z.number().optional(),
+
+  // Prediction tokens
+  acceptedPredictionTokens: z.number().optional(),
+  rejectedPredictionTokens: z.number().optional(),
+
+  // Total tokens
+  totalInputTokens: z.number().optional(),
+  totalOutputTokens: z.number().optional(),
+  totalTokens: z.number().optional(),
+
+  // Cost
+  cost: z.number().optional(),
+});
+
+export const ModelPerformanceSchema = z.object({
+  tps: z.number().optional(),
+  ttft: z.number().optional(),
+  duration: z.number().optional(),
+  latency: z.number().optional(),
+});
+
+export const MessageMetadataSchema = ModelUsageSchema.merge(ModelPerformanceSchema);
+
 export interface ModelUsage extends ModelTokensUsage {
   /**
    * dollar

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

@@ -16,6 +16,7 @@ export interface ChatToolPayload {
   arguments: string;
   id: string;
   identifier: string;
+  result_msg_id?: string;
   type: LobeToolRenderType;
 }
 
@@ -85,6 +86,15 @@ export const MessageToolCallSchema = z.object({
   type: z.string(),
 });
 
+export const ChatToolPayloadSchema = z.object({
+  apiName: z.string(),
+  arguments: z.string(),
+  id: z.string(),
+  identifier: z.string(),
+  result_msg_id: z.string().optional(),
+  type: z.string(),
+});
+
 /**
  * 聊天消息错误对象
  */

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

@@ -1,11 +1,20 @@
-import { GroundingSearch } from '../../search';
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+import { z } from 'zod';
+
+import { GroundingSearch, GroundingSearchSchema } from '../../search';
 import {
   ChatImageItem,
+  ChatImageItemSchema,
   ChatMessageError,
+  ChatMessageErrorSchema,
   ChatToolPayload,
+  ChatToolPayloadSchema,
   MessageMetadata,
+  MessageMetadataSchema,
   MessageToolCall,
+  MessageToolCallSchema,
   ModelReasoning,
+  ModelReasoningSchema,
 } from '../common';
 import { UIChatMessage } from '../ui';
 
@@ -34,6 +43,21 @@ export interface CreateMessageResult {
   messages: UIChatMessage[];
 }
 
+/**
+ * Result type for updateMessage
+ * Contains success status and optional message list
+ */
+export interface UpdateMessageResult {
+  /**
+   * Updated message list (only present when success is true and sessionId/topicId provided)
+   */
+  messages?: UIChatMessage[];
+  /**
+   * Whether the update was successful
+   */
+  success: boolean;
+}
+
 export interface NewMessage {
   agentId?: string | null;
   clientId?: string | null;
@@ -67,12 +91,14 @@ export interface UpdateMessageParams {
   imageList?: ChatImageItem[];
   metadata?: MessageMetadata;
   model?: string;
+  observationId?: string;
   provider?: string;
   reasoning?: ModelReasoning;
   role?: string;
   search?: GroundingSearch;
   toolCalls?: MessageToolCall[];
   tools?: ChatToolPayload[] | null;
+  traceId?: string;
 }
 
 export interface NewMessageQueryParams {
@@ -81,3 +107,23 @@ export interface NewMessageQueryParams {
   rewriteQuery: string;
   userQuery: string;
 }
+
+// ========== Zod Schemas ========== //
+
+export const UpdateMessageParamsSchema = z
+  .object({
+    content: z.string().optional(),
+    error: ChatMessageErrorSchema.nullable().optional(),
+    imageList: z.array(ChatImageItemSchema).optional(),
+    metadata: MessageMetadataSchema.optional(),
+    model: z.string().optional(),
+    observationId: z.string().optional(),
+    provider: z.string().optional(),
+    reasoning: ModelReasoningSchema.optional(),
+    role: z.string().optional(),
+    search: GroundingSearchSchema.optional(),
+    toolCalls: z.array(MessageToolCallSchema).optional(),
+    tools: z.array(ChatToolPayloadSchema).nullable().optional(),
+    traceId: z.string().optional(),
+  })
+  .passthrough();

package/packages/types/src/message/ui/chat.ts

@@ -26,10 +26,11 @@ export interface ChatFileItem {
 
 export interface AssistantContentBlock {
   content: string;
-  fileList?: ChatFileItem[];
+  error?: ChatMessageError | null;
   id: string;
   imageList?: ChatImageItem[];
   performance?: ModelPerformance;
+  reasoning?: ModelReasoning;
   tools?: ChatToolPayloadWithResult[];
   usage?: ModelUsage;
 }
@@ -62,6 +63,7 @@ export interface UIChatMessage {
   imageList?: ChatImageItem[];
   meta: MetaData;
   metadata?: MessageMetadata | null;
+  model?: string | null;
   /**
    * observation id
    */
@@ -78,6 +80,7 @@ export interface UIChatMessage {
   plugin?: ChatPluginPayload;
   pluginError?: any;
   pluginState?: any;
+  provider?: string | null;
   /**
    * quoted other message's id
    */

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

@@ -1,9 +1,14 @@
 /* eslint-disable sort-keys-fix/sort-keys-fix , typescript-sort-keys/interface */
+import { z } from 'zod';
+
 import { UploadFileItem } from '../../files';
 import { MessageSemanticSearchChunk } from '../../rag';
-import { ChatMessageError } from '../common/base';
+import { ChatMessageError, ChatMessageErrorSchema } from '../common/base';
 import { ChatPluginPayload } from '../common/tools';
-import { UIChatMessage, UIMessageRoleType } from './chat';
+import { UIChatMessage } from './chat';
+import { SemanticSearchChunkSchema } from './rag';
+
+export type CreateMessageRoleType = 'user' | 'assistant' | 'tool' | 'supervisor';
 
 export interface CreateMessageParams
   extends Partial<Omit<UIChatMessage, 'content' | 'role' | 'topicId' | 'chunksList'>> {
@@ -14,7 +19,7 @@ export interface CreateMessageParams
   fromModel?: string;
   fromProvider?: string;
   groupId?: string;
-  role: UIMessageRoleType;
+  role: CreateMessageRoleType;
   sessionId: string;
   targetId?: string | null;
   threadId?: string | null;
@@ -28,7 +33,7 @@ export interface CreateMessageParams
  */
 export interface CreateNewMessageParams {
   // ========== Required fields ==========
-  role: UIMessageRoleType;
+  role: CreateMessageRoleType;
   content: string;
   sessionId: string;
 
@@ -103,3 +108,43 @@ export interface SendGroupMessageParams {
    */
   targetMemberId?: string | null;
 }
+
+// ========== Zod Schemas ========== //
+
+const UIMessageRoleTypeSchema = z.enum(['user', 'assistant', 'tool', 'supervisor']);
+
+const ChatPluginPayloadSchema = z.object({
+  apiName: z.string(),
+  arguments: z.string(),
+  identifier: z.string(),
+  type: z.string(),
+});
+
+export const CreateNewMessageParamsSchema = z
+  .object({
+    // Required fields
+    role: UIMessageRoleTypeSchema,
+    content: z.string(),
+    sessionId: z.string().nullable().optional(),
+    // Tool related
+    tool_call_id: z.string().optional(),
+    plugin: ChatPluginPayloadSchema.optional(),
+    // Grouping
+    parentId: z.string().optional(),
+    groupId: z.string().nullable().optional(),
+    // Context
+    topicId: z.string().nullable().optional(),
+    threadId: z.string().nullable().optional(),
+    targetId: z.string().nullable().optional(),
+    // Model info
+    model: z.string().nullable().optional(),
+    provider: z.string().nullable().optional(),
+    // Content
+    files: z.array(z.string()).optional(),
+    // Error handling
+    error: ChatMessageErrorSchema.nullable().optional(),
+    // Metadata
+    traceId: z.string().optional(),
+    fileChunks: z.array(SemanticSearchChunkSchema).optional(),
+  })
+  .passthrough();

package/packages/types/src/plugins/mcp.ts

@@ -3,6 +3,7 @@ import { z } from 'zod';
 
 import { MCPErrorType } from '@/libs/mcp';
 
+import { McpConnectionType } from '../discover/mcp';
 import { CustomPluginMetadata } from '../tool/plugin';
 
 /* eslint-disable typescript-sort-keys/string-enum */
@@ -110,7 +111,9 @@ export interface CheckMcpInstallResult {
   }>;
 }
 
-export type MCPPluginListParams = Pick<PluginQueryParams, 'locale' | 'pageSize' | 'page' | 'q'>;
+export type MCPPluginListParams = Pick<PluginQueryParams, 'locale' | 'pageSize' | 'page' | 'q'> & {
+  connectionType?: McpConnectionType;
+};
 
 export interface MCPErrorInfoMetadata {
   errorLog?: string;

package/packages/types/src/search.ts

@@ -1,3 +1,5 @@
+import { z } from 'zod';
+
 export type SearchMode = 'off' | 'auto' | 'on';
 
 export enum ModelSearchImplement {
@@ -27,3 +29,17 @@ export interface GroundingSearch {
   citations?: CitationItem[];
   searchQueries?: string[];
 }
+
+export const GroundingSearchSchema = z.object({
+  citations: z
+    .array(
+      z.object({
+        favicon: z.string().optional(),
+        id: z.string().optional(),
+        title: z.string().optional(),
+        url: z.string(),
+      }),
+    )
+    .optional(),
+  searchQueries: z.array(z.string()).optional(),
+});

package/packages/types/src/serverConfig.ts

@@ -15,9 +15,9 @@ export interface ServerModelProviderConfig {
   enabledModels?: string[];
   fetchOnClient?: boolean;
   /**
-   * the model cards defined in server
+   * the model lists defined in server
    */
-  serverModelCards?: ChatModelCard[];
+  serverModelLists?: ChatModelCard[];
 }
 
 export type ServerLanguageModel = Partial<Record<GlobalLLMProviderKey, ServerModelProviderConfig>>;
@@ -32,10 +32,6 @@ export interface GlobalServerConfig {
    */
   enabledOAuthSSO?: boolean;
   image?: PartialDeep<UserImageConfig>;
-  /**
-   * @deprecated
-   */
-  languageModel?: ServerLanguageModel;
   oAuthSSOProviders?: string[];
   systemAgent?: PartialDeep<UserSystemAgentConfig>;
   telemetry: {

package/packages/types/src/topic/topic.ts

@@ -51,3 +51,17 @@ export interface TopicRankItem {
   sessionId: string | null;
   title: string | null;
 }
+
+export interface CreateTopicParams {
+  favorite?: boolean;
+  groupId?: string | null;
+  messages?: string[];
+  sessionId?: string | null;
+  title: string;
+}
+
+export interface QueryTopicParams {
+  containerId?: string | null; // sessionId or groupId
+  current?: number;
+  pageSize?: number;
+}

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

@@ -1,76 +1,2 @@
-import type { PartialDeep } from 'type-fest';
-import { z } from 'zod';
-
-import { Plans } from '../subscription';
-import { TopicDisplayMode } from '../topic';
-import { UserSettings } from '../user/settings';
-
-export interface LobeUser {
-  avatar?: string;
-  email?: string | null;
-  firstName?: string | null;
-  fullName?: string | null;
-  id: string;
-  latestName?: string | null;
-  username?: string | null;
-}
-
-export const UserGuideSchema = z.object({
-  /**
-   * Move the settings button to the avatar dropdown
-   */
-  moveSettingsToAvatar: z.boolean().optional(),
-
-  /**
-   * Topic Guide
-   */
-  topic: z.boolean().optional(),
-
-  /**
-   * tell user that uploaded files can be found in knowledge base
-   */
-  uploadFileInKnowledgeBase: z.boolean().optional(),
-});
-
-export type UserGuide = z.infer<typeof UserGuideSchema>;
-
-export interface UserPreference {
-  /**
-   * disable markdown rendering in chat input editor
-   */
-  disableInputMarkdownRender?: boolean;
-  /**
-   * enable multi-agent group chat mode
-   */
-  enableGroupChat?: boolean;
-  guide?: UserGuide;
-  hideSyncAlert?: boolean;
-  telemetry: boolean | null;
-  topicDisplayMode?: TopicDisplayMode;
-  /**
-   * whether to use cmd + enter to send message
-   */
-  useCmdEnterToSend?: boolean;
-}
-
-export interface UserInitializationState {
-  avatar?: string;
-  canEnablePWAGuide?: boolean;
-  canEnableTrace?: boolean;
-  email?: string;
-  firstName?: string;
-  fullName?: string;
-  hasConversation?: boolean;
-  isOnboard?: boolean;
-  lastName?: string;
-  preference: UserPreference;
-  settings: PartialDeep<UserSettings>;
-  subscriptionPlan?: Plans;
-  userId?: string;
-  username?: string;
-}
-
-export const NextAuthAccountSchame = z.object({
-  provider: z.string(),
-  providerAccountId: z.string(),
-});
+export * from './preference';
+export * from './settings';

package/packages/types/src/user/preference.ts

@@ -0,0 +1,105 @@
+import type { PartialDeep } from 'type-fest';
+import { z } from 'zod';
+
+import { Plans } from '../subscription';
+import { TopicDisplayMode } from '../topic';
+import { UserSettings } from './settings';
+
+export interface LobeUser {
+  avatar?: string;
+  email?: string | null;
+  firstName?: string | null;
+  fullName?: string | null;
+  id: string;
+  latestName?: string | null;
+  username?: string | null;
+}
+
+export const UserGuideSchema = z.object({
+  /**
+   * Move the settings button to the avatar dropdown
+   */
+  moveSettingsToAvatar: z.boolean().optional(),
+
+  /**
+   * Topic Guide
+   */
+  topic: z.boolean().optional(),
+
+  /**
+   * tell user that uploaded files can be found in knowledge base
+   */
+  uploadFileInKnowledgeBase: z.boolean().optional(),
+});
+
+export type UserGuide = z.infer<typeof UserGuideSchema>;
+
+export const UserLabSchema = z.object({
+  /**
+   * enable assistant message grouping in chat display
+   */
+  enableAssistantMessageGroup: z.boolean().optional(),
+  /**
+   * enable multi-agent group chat mode
+   */
+  enableGroupChat: z.boolean().optional(),
+  /**
+   * enable markdown rendering in chat input editor
+   */
+  enableInputMarkdown: z.boolean().optional(),
+});
+
+export type UserLab = z.infer<typeof UserLabSchema>;
+
+export interface UserPreference {
+  /**
+   * disable markdown rendering in chat input editor
+   * @deprecated Use lab.enableInputMarkdown instead
+   */
+  disableInputMarkdownRender?: boolean;
+  guide?: UserGuide;
+  hideSyncAlert?: boolean;
+  /**
+   * lab experimental features
+   */
+  lab?: UserLab;
+  telemetry: boolean | null;
+  topicDisplayMode?: TopicDisplayMode;
+  /**
+   * whether to use cmd + enter to send message
+   */
+  useCmdEnterToSend?: boolean;
+}
+
+export interface UserInitializationState {
+  avatar?: string;
+  canEnablePWAGuide?: boolean;
+  canEnableTrace?: boolean;
+  email?: string;
+  firstName?: string;
+  fullName?: string;
+  hasConversation?: boolean;
+  isOnboard?: boolean;
+  lastName?: string;
+  preference: UserPreference;
+  settings: PartialDeep<UserSettings>;
+  subscriptionPlan?: Plans;
+  userId?: string;
+  username?: string;
+}
+
+export const NextAuthAccountSchame = z.object({
+  provider: z.string(),
+  providerAccountId: z.string(),
+});
+
+export const UserPreferenceSchema = z
+  .object({
+    guide: UserGuideSchema.optional(),
+    hideSyncAlert: z.boolean().optional(),
+    lab: UserLabSchema.optional(),
+    telemetry: z.boolean().nullable(),
+    topicDisplayMode: z.nativeEnum(TopicDisplayMode).optional(),
+    useCmdEnterToSend: z.boolean().optional(),
+  })
+  .partial();

package/packages/types/src/user/settings/index.ts

@@ -1,3 +1,5 @@
+import { z } from 'zod';
+
 import type { LobeAgentSettings } from '../../session';
 import { UserGeneralConfig } from './general';
 import { UserHotkeyConfig } from './hotkey';
@@ -18,6 +20,7 @@ export * from './keyVaults';
 export * from './modelProvider';
 export * from './sync';
 export * from './systemAgent';
+export * from './tool';
 export * from './tts';
 
 /**
@@ -34,3 +37,22 @@ export interface UserSettings {
   tool: UserToolConfig;
   tts: UserTTSConfig;
 }
+
+/**
+ * Zod schema for partial UserSettings updates
+ * Uses passthrough to allow any nested settings fields
+ */
+export const UserSettingsSchema = z
+  .object({
+    defaultAgent: z.any().optional(),
+    general: z.any().optional(),
+    hotkey: z.any().optional(),
+    image: z.any().optional(),
+    keyVaults: z.any().optional(),
+    languageModel: z.any().optional(),
+    systemAgent: z.any().optional(),
+    tool: z.any().optional(),
+    tts: z.any().optional(),
+  })
+  .passthrough()
+  .partial();