@lobehub/chat 1.11.9 → 1.12.1

package/src/types/files/upload.ts

@@ -0,0 +1,91 @@
+import { z } from 'zod';
+
+import { FileParsingTask } from '@/types/asyncTask';
+
+export interface FileUploadState {
+  progress: number;
+  /**
+   * rest time in s
+   */
+  restTime: number;
+  /**
+   * upload speed in KB/s
+   */
+  speed: number;
+}
+
+export type FileUploadStatus = 'pending' | 'uploading' | 'processing' | 'success' | 'error';
+
+export type FileProcessStatus = 'pending' | 'chunking' | 'embedding' | 'success' | 'error';
+
+export const UPLOAD_STATUS_SET = new Set(['uploading', 'pending', 'processing']);
+
+// the file that is upload at chat page
+export interface UploadFileItem {
+  /**
+   * base64 data, it will use in other data
+   */
+  base64Url?: string;
+  file: File;
+  /**
+   * the file url after upload,it will be s3 url
+   * if enable the S3 storage, or the data is same as base64Url
+   */
+  fileUrl?: string;
+  id: string;
+  /**
+   * blob url for local preview
+   * it will use in the file preview before send the message
+   */
+  previewUrl?: string;
+  status: FileUploadStatus;
+  tasks?: FileParsingTask;
+  uploadState?: FileUploadState;
+}
+
+export const FileMetadataSchema = z.object({
+  date: z.string(),
+  dirname: z.string(),
+  filename: z.string(),
+  path: z.string(),
+});
+
+export type FileMetadata = z.infer<typeof FileMetadataSchema>;
+
+export const UploadFileSchema = z.object({
+  data: z.instanceof(ArrayBuffer).optional(),
+  /**
+   * file type
+   * @example 'image/png'
+   */
+  fileType: z.string(),
+  // TODO: Need be required
+  hash: z.string().optional(),
+
+  knowledgeBaseId: z.string().optional(),
+
+  metadata: z.any().optional(),
+
+  /**
+   * file name
+   * @example 'test.png'
+   */
+  name: z.string(),
+
+  /**
+   * the mode database save the file
+   * local mean save the raw file into data
+   * url mean upload the file to a cdn and then save the url
+   */
+  saveMode: z.enum(['local', 'url']),
+  /**
+   * file size
+   */
+  size: z.number(),
+  /**
+   * file url if saveMode is url
+   */
+  url: z.string().optional(),
+});
+
+export type UploadFileParams = z.infer<typeof UploadFileSchema>;

package/src/types/knowledgeBase/index.ts

@@ -0,0 +1,45 @@
+export enum KnowledgeBaseTabs {
+  Files = 'files',
+  Settings = 'Settings',
+  Testing = 'testing',
+}
+
+export interface KnowledgeBaseItem {
+  avatar: string | null;
+
+  createdAt: Date;
+  description?: string | null;
+  enabled?: boolean;
+
+  id: string;
+
+  isPublic: boolean | null;
+
+  name: string;
+
+  settings: any;
+  // different types of knowledge bases need to be distinguished
+  type: string | null;
+  updatedAt: Date;
+}
+
+export interface CreateKnowledgeBaseParams {
+  avatar?: string;
+  description?: string;
+  name: string;
+}
+
+export enum KnowledgeType {
+  File = 'file',
+  KnowledgeBase = 'knowledgeBase',
+}
+
+export interface KnowledgeItem {
+  avatar?: string | null;
+  description?: string | null;
+  enabled?: boolean;
+  fileType?: string;
+  id: string;
+  name: string;
+  type: KnowledgeType;
+}

package/src/types/message/index.ts

@@ -2,6 +2,7 @@ import { IPluginErrorType } from '@lobehub/chat-plugin-sdk';
 
 import { ILobeAgentRuntimeErrorType } from '@/libs/agent-runtime';
 import { ErrorType } from '@/types/fetch';
+import { MessageSemanticSearchChunk } from '@/types/rag';
 
 import { BaseDataModel } from '../meta';
 import { ChatPluginPayload, ChatToolPayload } from './tools';
@@ -30,9 +31,33 @@ export interface ChatTTS {
 
 export * from './tools';
 
+export interface ChatFileItem {
+  fileType: string;
+  id: string;
+  name: string;
+  size: number;
+  url: string;
+}
+
+export interface ChatImageItem {
+  alt: string;
+  id: string;
+  url: string;
+}
+
+export interface ChatFileChunk {
+  fileId: string;
+  fileType: string;
+  fileUrl: string;
+  filename: string;
+  id: string;
+  text: string;
+}
 export interface ChatMessage extends BaseDataModel {
+  chunksList?: ChatFileChunk[];
   content: string;
   error?: ChatMessageError | null;
+
   // 扩展字段
   extra?: {
     fromModel?: string;
@@ -42,33 +67,43 @@ export interface ChatMessage extends BaseDataModel {
     // TTS
     tts?: ChatTTS;
   } & Record<string, any>;
-
+  fileList?: ChatFileItem[];
+  /**
+   * this is a deprecated field, only use in client db
+   * and should be remove after migrate to pglite
+   * this field is replaced by fileList and imageList
+   * @deprecated
+   */
   files?: string[];
+  imageList?: ChatImageItem[];
   /**
    * observation id
    */
   observationId?: string;
+
   /**
    * parent message id
    */
   parentId?: string;
-
   plugin?: ChatPluginPayload;
-  pluginState?: any;
 
+  pluginState?: any;
   /**
    * quoted other message's id
    */
   quotaId?: string;
+  ragQuery?: string | null;
+  ragQueryId?: string | null;
+  ragRawQuery?: string | null;
   /**
    * message role type
    */
   role: MessageRoleType;
-  sessionId?: string;
 
+  sessionId?: string;
   tool_call_id?: string;
-  tools?: ChatToolPayload[];
 
+  tools?: ChatToolPayload[];
   /**
    * 保存到主题的消息
    */
@@ -80,3 +115,17 @@ export interface ChatMessage extends BaseDataModel {
 }
 
 export type ChatMessageMap = Record<string, ChatMessage>;
+
+export interface CreateMessageParams
+  extends Partial<Omit<ChatMessage, 'content' | 'role' | 'topicId' | 'chunksList'>> {
+  content: string;
+  error?: ChatMessageError | null;
+  fileChunks?: MessageSemanticSearchChunk[];
+  files?: string[];
+  fromModel?: string;
+  fromProvider?: string;
+  role: MessageRoleType;
+  sessionId: string;
+  topicId?: string;
+  traceId?: string;
+}

package/src/types/rag.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+
+import { ChatSemanticSearchChunk } from '@/types/chunk';
+
+export const SemanticSearchSchema = z.object({
+  fileIds: z.array(z.string()).optional(),
+  knowledgeIds: z.array(z.string()).optional(),
+  messageId: z.string(),
+  model: z.string().optional(),
+  rewriteQuery: z.string(),
+  userQuery: z.string(),
+});
+
+export type SemanticSearchSchemaType = z.infer<typeof SemanticSearchSchema>;
+
+export type MessageSemanticSearchChunk = Pick<ChatSemanticSearchChunk, 'id' | 'similarity'>;

package/src/utils/filter.test.ts

@@ -1,3 +1,5 @@
+import { test } from 'vitest';
+
 test('placeholder', () => {});
 // describe('filterWithKeywords', () => {
 //   const data: Record<string, BaseDataModel> = {

package/src/utils/server/auth.ts

@@ -0,0 +1,23 @@
+import { auth } from '@clerk/nextjs/server';
+
+import { enableClerk, enableNextAuth } from '@/const/auth';
+import NextAuthEdge from '@/libs/next-auth/edge';
+
+export const getUserAuth = async () => {
+  if (enableClerk) {
+    const clerkAuth = auth();
+
+    const userId = clerkAuth.userId;
+    return { clerkAuth: auth, userId };
+  }
+
+  if (enableNextAuth) {
+    const session = await NextAuthEdge.auth();
+
+    const userId = session?.user.id;
+
+    return { nextAuth: session, userId };
+  }
+
+  throw new Error('Auth method is not enabled');
+};

package/src/app/(main)/chat/(workspace)/@conversation/features/ChatInput/Desktop/LocalFiles.tsx

@@ -1,46 +0,0 @@
-import { memo } from 'react';
-
-import DragUpload from '@/components/DragUpload';
-import { EditableFileList } from '@/features/FileList';
-import { useAgentStore } from '@/store/agent';
-import { agentSelectors } from '@/store/agent/slices/chat';
-import { useFileStore } from '@/store/file';
-import { useUserStore } from '@/store/user';
-import { modelProviderSelectors } from '@/store/user/selectors';
-
-interface LocalFilesProps {
-  padding?: number | string;
-}
-
-const LocalFiles = memo<LocalFilesProps>(({ padding }) => {
-  const model = useAgentStore(agentSelectors.currentAgentModel);
-
-  const enabledFiles = useUserStore(modelProviderSelectors.isModelEnabledFiles(model));
-  const canUpload = useUserStore(modelProviderSelectors.isModelEnabledUpload(model));
-
-  const inputFilesList = useFileStore((s) => s.inputFilesList);
-  const uploadFile = useFileStore((s) => s.uploadFile);
-
-  const uploadImages = async (fileList: FileList | undefined) => {
-    if (!fileList || fileList.length === 0) return;
-
-    const pools = Array.from(fileList).map(async (file) => {
-      // skip none-file items
-      if (!file.type.startsWith('image') && !enabledFiles) return;
-      await uploadFile(file);
-    });
-
-    await Promise.all(pools);
-  };
-
-  return (
-    canUpload && (
-      <>
-        <DragUpload enabledFiles={enabledFiles} onUploadFiles={uploadImages} />
-        <EditableFileList items={inputFilesList} padding={padding ?? 0} />
-      </>
-    )
-  );
-});
-
-export default LocalFiles;

package/src/app/(main)/chat/(workspace)/@conversation/features/ChatInput/Mobile/Files.tsx

@@ -1,19 +0,0 @@
-import { memo } from 'react';
-import { Flexbox } from 'react-layout-kit';
-
-import { EditableFileList } from '@/features/FileList';
-import { useFileStore } from '@/store/file';
-
-const Files = memo(() => {
-  const inputFilesList = useFileStore((s) => s.inputFilesList);
-
-  if (!inputFilesList || inputFilesList?.length === 0) return null;
-
-  return (
-    <Flexbox paddingBlock={4} style={{ position: 'relative' }}>
-      <EditableFileList alwaysShowClose items={inputFilesList} padding={'4px 8px 8px'} />
-    </Flexbox>
-  );
-});
-
-export default Files;

package/src/components/FileList/EditableFileList.tsx

@@ -1,47 +0,0 @@
-import { ImageGallery } from '@lobehub/ui';
-import { useResponsive } from 'antd-style';
-import { memo } from 'react';
-import { Flexbox } from 'react-layout-kit';
-
-import ImageItem from '@/components/ImageItem';
-
-import { ImageFileItem } from './type';
-
-interface EditableFileListProps {
-  alwaysShowClose?: boolean;
-  editable?: boolean;
-  items: ImageFileItem[];
-  onRemove?: (id: string) => void;
-  padding?: number | string;
-}
-
-export const EditableFileList = memo<EditableFileListProps>(
-  ({ items, editable = true, alwaysShowClose, onRemove, padding = 12 }) => {
-    const { mobile } = useResponsive();
-
-    return (
-      <Flexbox
-        gap={mobile ? 4 : 6}
-        horizontal
-        padding={padding}
-        style={{ overflow: 'scroll', width: '100%' }}
-      >
-        <ImageGallery>
-          {items.map((i) => (
-            <ImageItem
-              alt={i.alt}
-              alwaysShowClose={alwaysShowClose}
-              editable={editable}
-              key={i.id}
-              loading={i.loading}
-              onRemove={() => onRemove?.(i.id)}
-              url={i.url}
-            />
-          ))}
-        </ImageGallery>
-      </Flexbox>
-    );
-  },
-);
-
-export default EditableFileList;

package/src/components/FileList/index.ts

@@ -1,2 +0,0 @@
-export { EditableFileList } from './EditableFileList';
-export { ImageFileListViewer } from './FileListViewer';

package/src/components/FileList/type.tsx

@@ -1,7 +0,0 @@
-export interface ImageFileItem {
-  alt?: string;
-  id: string;
-  loading?: boolean;
-  onRemove?: (id: string) => void;
-  url: string;
-}