@mxmweb/fviewer 1.4.4 → 1.5.0

package/README.md

@@ -1,343 +1,591 @@
-# FViewer - 文件查看器组件库
+# @mxmweb/fviewer
 
-## 项目概述
+一个功能强大的文件查看器库，支持多种文件格式的解析和显示，包括PDF、图片、文本、Markdown等格式。
 
-FViewer 是一个基于 React 的文件查看器组件库，支持多种文件格式的预览和交互。项目采用分层架构设计，遵循 adopter_develop 规范，使用 HOC 模式封装核心组件。
+## 安装与依赖
 
-### 支持的文件格式
-- **PDF**: 支持分页查看、缩放、旋转
-- **Markdown**: 支持格式化渲染、无限滚动
-- **图片**: 支持常见图片格式（JPG、PNG、GIF等）
-- **文本**: 支持纯文本文件
-- **HTML**: 支持网页内容预览
+本库为“易安装应用库”，仅外置最小运行时依赖。请在宿主项目中安装以下对等依赖（peerDependencies）：
 
-## 项目架构
-
-### 目录结构
-```
-apps/FViewer/
-├── src/
-│   ├── core/                 # 核心组件层
-│   │   ├── Fviewer.tsx      # 主查看器组件
-│   │   ├── PdfRender/       # PDF渲染组件
-│   │   ├── types.ts         # 类型定义
-│   │   └── utils/           # 工具函数
-│   ├── adopters/            # 业务适配层
-│   │   ├── GientechStreamReader.tsx  # Stream业务流适配器
-│   │   ├── StaticFileReader.tsx      # 静态文件适配器
-│   │   └── components/      # 适配器组件
-│   ├── StreamPreview.tsx    # Stream业务流测试组件
-│   └── main.tsx             # 应用入口
-├── package.json
-└── README.md
+```bash
+# 使用 pnpm（推荐）
+pnpm add @mxmweb/fviewer \
+  react react-dom \
+  styled-components @mxmweb/zui @mxmweb/rtext \
+  pdfjs-dist
+
+# 或 yarn
+yarn add @mxmweb/fviewer \
+  react react-dom \
+  styled-components @mxmweb/zui @mxmweb/rtext \
+  pdfjs-dist
+
+# 或 npm
+npm i @mxmweb/fviewer \
+  react react-dom \
+  styled-components @mxmweb/zui @mxmweb/rtext \
+  pdfjs-dist
 ```
 
-### 架构设计原则
+PDF.js 的 worker 需由宿主自行注册一次（任意应用初始化位置）：
 
-1. **分层架构**: 
-   - `/core/`: 核心UI组件，只负责渲染和基础交互
-   - `/adopters/`: 业务适配层，处理数据获取、缓存、业务逻辑
+```ts
+import * as pdfjsLib from 'pdfjs-dist';
 
-2. **HOC模式**: 业务层通过高阶组件模式扩展核心组件功能
+// 方式一：指向你静态资源中的 worker 文件
+pdfjsLib.GlobalWorkerOptions.workerSrc = '/worker/pdf.worker.min.js';
 
-3. **事件驱动**: 使用统一的 `eventsEmit` 机制进行组件间通信
-
-4. **主题化**: 支持动态主题配置，使用 styled-components 实现
-
-## 核心组件
-
-### Fviewer (核心查看器)
-
-**位置**: `src/core/Fviewer.tsx`
-
-**功能**: 文件类型检测、内容渲染、状态管理
-
-**接口**:
-```typescript
-interface FviewerProps {
-  data: FviewerData;           // 文件数据
-  annotationData?: Annotation[]; // 标注数据
-  totalPage?: number;          // 总页数
-  currentPage?: number;        // 当前页
-  scale?: number;              // 缩放比例
-  rotation?: number;           // 旋转角度
-  eventsEmit?: (name: string, data?: any) => void; // 事件回调
-  styles?: { theme?: AppTheme; mode?: 'light' | 'dark' }; // 样式配置
-  tools?: ToolsConfig;         // 工具配置
-  customComponents?: CustomizeComponents; // 自定义组件
-}
+// 方式二：直接引入（需确保构建可访问该路径）
+// import 'pdfjs-dist/build/pdf.worker.min.js';
 ```
 
-**事件**:
-- `markdown_scroll`: Markdown滚动事件
-- `pageChange`: 页面变化事件
-- `zoomChange`: 缩放变化事件
-- `annotationChange`: 标注变化事件
-
-### PdfRender (PDF渲染器)
+> 说明：为降低包体积，`@mxmweb/rtext` 与 `pdfjs-dist` 均已外置；`react/react-dom/@mxmweb/zui/styled-components` 作为运行时依赖亦需由宿主提供。
 
-**位置**: `src/core/PdfRender/index.tsx`
+## 核心组件
 
-**功能**: PDF文档渲染、页面导航、缩放控制
+### StaticFileReader
 
-**特性**:
-- 支持分页PDF的页码映射
-- 基于PDF.js实现
-- 支持标注功能
+静态文件阅读器组件，用于加载和显示本地或远程静态文件。
 
-## 业务适配器
+#### Props接口
 
-### GientechStreamReader (Stream业务流适配器)
+- **fileUrl**: `string` - 文件URL地址（必需）
+- **fileType**: `string` - 文件类型（可选）
+- **fileName**: `string` - 文件名（可选）
+- **token**: `string` - 认证令牌（可选）
+- **initialPage**: `number` - 初始页码（可选）
+- **annotations**: `(Annotation | MDAnnotation | TableAnnotation)[]` - 标注数据数组（可选）
+- **data**: `any` - 直接数据传递（可选）
+- **eventsEmit**: `(name: string, data?: any, innerFn?: any) => void` - 事件回调函数（可选）
+- **styles**: `{ theme?: AppTheme; mode?: 'light' | 'dark' }` - 样式配置（可选）
+- **tools**: `ToolsConfig` - 工具配置（可选）
+- **customComponents**: `{ LoadingComponent?, ErrorComponent? }` - 自定义组件（可选）
+- **className**: `string` - 自定义类名（可选）
+- **headerClass**: `string` - 头部类名（可选）
+- **contentClass**: `string` - 内容类名（可选）
 
-**位置**: `src/adopters/GientechStreamReader.tsx`
+#### 调用实例
 
-**功能**: 基于Stream API的文件读取器，支持分页获取和缓存
+```tsx
+import { StaticFileReader } from '@mxmweb/fviewer';
 
-**特性**:
-- **PDF支持**: 分页加载、智能缓存、页码映射
-- **Markdown支持**: 无限滚动、块级缓存、双向加载
-- **缓存机制**: 页面级和块级缓存，5分钟过期
-- **加载状态**: 初始加载、页面加载、无限滚动加载
+function App() {
+  const handleEvents = (name: string, data?: any) => {
+    switch (name) {
+      case 'file_loaded':
+        console.log('文件加载完成:', data);
+        break;
+      case 'page_changed':
+        console.log('页面切换:', data);
+        break;
+      case 'annotation_added':
+        console.log('添加标注:', data);
+        break;
+    }
+  };
 
-**接口**:
-```typescript
-interface GientechStreamReaderProps {
-  convertedFilePath: string;   // 文件路径
-  fileName?: string;           // 文件名
-  fileType: string;            // 文件类型
-  initialPage?: number;        // 初始页/块
-  totalPages?: number;         // 总页数/块数
-  pageSize?: number;           // 页面/块大小
-  streamApiUrl?: string;       // Stream API地址
-  authorization?: string;      // 认证信息
-  eventsEmit?: (name: string, data?: any) => void;
-  styles?: { theme?: AppTheme; mode?: 'light' | 'dark' };
-  tools?: ToolsConfig;
-  customComponents?: CustomizeComponents;
+  return (
+    <StaticFileReader
+      fileUrl="https://example.com/document.pdf"
+      fileName="示例文档.pdf"
+      fileType="pdf"
+      initialPage={1}
+      eventsEmit={handleEvents}
+      styles={{
+        mode: 'light',
+        theme: {
+          colors: {
+            primary: '#1890ff',
+            background: '#ffffff',
+            text: '#000000'
+          }
+        }
+      }}
+      tools={{
+        annotation: true,
+        download: true,
+        zoom: true,
+        navigation: true
+      }}
+    />
+  );
 }
 ```
 
-**缓存策略**:
-- **PDF**: 缓存解析后的PDF文档对象，避免重复解析
-- **Markdown**: 缓存块级内容，支持向前/向后拼接
-
-**无限滚动**:
-- 向下滚动到底部80%时加载下一块
-- 向上滚动到顶部20%时加载上一块
-- 智能内容拼接，保持阅读连续性
-
-### StaticFileReader (静态文件适配器)
-
-**位置**: `src/adopters/StaticFileReader.tsx`
-
-**功能**: 静态文件读取器，支持本地文件预览
-
-## 使用示例
-
-### Stream业务流使用
+#### eventsEmit详细说明
+
+| 事件名 | 说明 | 数据格式 |
+| --- | ---- | --- |
+| `file_loaded` | 文件加载完成 | `{ fileName: string, fileType: string, totalPages?: number }` |
+| `page_changed` | 页面切换 | `{ currentPage: number, totalPages: number }` |
+| `annotation_added` | 添加标注 | `{ id: string, pageNumber: number, x: number, y: number, content: string }` |
+| `annotation_removed` | 删除标注 | `{ id: string }` |
+| `zoom_changed` | 缩放变化 | `{ scale: number }` |
+| `download_clicked` | 下载按钮点击 | `{ fileName: string }` |
+| `error_occurred` | 错误发生 | `{ error: string, details?: any }` |
+
+#### 技术栈
+
+- React 18 + TypeScript
+- Styled-components v6 主题样式
+- PDF.js 用于PDF文件解析
+- 响应式设计，支持移动端
+
+#### 其他
+
+- 支持多种文件格式：PDF、图片、文本、Markdown、HTML
+- 内置文件类型自动检测
+- 支持自定义主题和样式
+- 提供完整的标注功能
+- 支持文件下载和打印
+
+### GientechStreamReader
+
+流式文件阅读器组件，专门用于处理大文件的流式加载和分页显示。
+
+#### Props接口
+
+- **convertedFilePath**: `string` - 转换后的文件路径（必需）
+- **csrfToken**: `string` - CSRF令牌（可选）
+- **fileName**: `string` - 文件名（可选）
+- **fileType**: `string` - 文件类型（必需）
+- **initialPage**: `number` - 初始页码（可选）
+- **totalPages**: `number` - 总页数（可选）
+- **annotations**: `(Annotation | MDAnnotation | TableAnnotation)[]` - 标注数据数组（可选）
+- **userName**: `string` - 用户名（可选）
+- **userId**: `string` - 用户ID（可选）
+- **pageSize**: `number` - 页面大小（可选）
+- **streamApiUrl**: `string` - 流式API地址（可选）
+- **authorization**: `string` - 授权头（可选）
+- **eventsEmit**: `(name: string, data?: any, innerFn?: any) => void` - 事件回调函数（可选）
+- **tools**: `Partial<ToolsConfig>` - 工具配置（可选）
+- **styles**: `Styles` - 样式配置（可选）
+- **customComponents**: `{ LoadingComponent?, ErrorComponent? }` - 自定义组件（可选）
+- **className**: `string` - 自定义类名（可选）
+- **headerClass**: `string` - 头部类名（可选）
+- **contentClass**: `string` - 内容类名（可选）
+
+#### 调用实例
 
 ```tsx
-import GientechStreamReader from './adopters/GientechStreamReader';
+import { GientechStreamReader } from '@mxmweb/fviewer';
 
 function App() {
-  const handleEvents = (name: string, data: any) => {
+  const handleStreamEvents = (name: string, data?: any) => {
     switch (name) {
-      case 'pageChange':
-        console.log('页面变化:', data);
+      case 'page_loaded':
+        console.log('页面加载完成:', data);
         break;
-      case 'markdown_scroll':
-        console.log('Markdown滚动:', data);
+      case 'stream_error':
+        console.log('流式加载错误:', data);
+        break;
+      case 'cache_updated':
+        console.log('缓存更新:', data);
         break;
     }
   };
 
   return (
     <GientechStreamReader
-      convertedFilePath="/path/to/file"
-      fileName="document.pdf"
+      convertedFilePath="/api/files/12345"
       fileType="pdf"
-      initialPage={1}
-      totalPages={100}
-      pageSize={5}
-      streamApiUrl="http://api.example.com/stream"
-      authorization="Bearer token"
-      eventsEmit={handleEvents}
+      fileName="大型文档.pdf"
+      totalPages={1000}
+      pageSize={10}
+      userName="张三"
+      userId="user123"
+      eventsEmit={handleStreamEvents}
+      tools={{
+        annotation: true,
+        navigation: true,
+        zoom: true
+      }}
       styles={{
         theme: {
           colors: {
-            primary: '#007bff',
-            background: '#f8f9fa',
-            text: '#343a40'
+            primary: '#52c41a',
+            background: '#fafafa'
           }
         }
       }}
-      tools={{
-        zoom: true,
-        navigation: true,
-        close: true
-      }}
     />
   );
 }
 ```
 
-### 自定义组件
+#### eventsEmit详细说明
+
+| 事件名 | 说明 | 数据格式 |
+| --- | ---- | --- |
+| `page_loaded` | 页面加载完成 | `{ pageNo: number, data: ArrayBuffer, timestamp: number }` |
+| `stream_error` | 流式加载错误 | `{ error: string, pageNo?: number, retryCount: number }` |
+| `cache_updated` | 缓存更新 | `{ cacheKey: string, pages: number[], timestamp: number }` |
+| `page_requested` | 页面请求开始 | `{ pageNo: number, requestId: string }` |
+| `navigation_changed` | 导航变化 | `{ currentPage: number, totalPages: number, direction: 'next' \| 'prev' }` |
+| `user_action` | 用户操作 | `{ action: string, pageNo: number, timestamp: number }` |
+
+#### 技术栈
+
+- React 18 + TypeScript
+- Axios 用于HTTP请求
+- 智能分页缓存系统
+- 流式数据加载
+- 内存优化管理
+
+#### 其他
+
+- 支持超大文件的分页加载
+- 智能缓存策略，减少重复请求
+- 支持断点续传和错误重试
+- 内存使用优化，避免内存泄漏
+- 支持多种认证方式
+
+## 工具函数
+
+### parseFile
+
+通用文件解析函数，自动检测文件类型并调用相应的解析器。
 
 ```tsx
-// 自定义加载组件
-const CustomLoading = ({ status, theme }) => (
-  <div style={{ color: theme.colors.primary }}>
-    自定义加载: {status}
-  </div>
-);
-
-// 自定义错误组件
-const CustomError = ({ error, theme }) => (
-  <div style={{ color: theme.colors.error }}>
-    自定义错误: {error}
-  </div>
-);
-
-<GientechStreamReader
-  // ... 其他属性
-  customComponents={{
-    LoadingComponent: CustomLoading,
-    ErrorComponent: CustomError
-  }}
-/>
+import { parseFile } from '@mxmweb/fviewer';
+
+const result = await parseFile(fileData, {
+  fileName: 'document.pdf',
+  fileType: 'pdf'
+});
 ```
 
-## 开发指南
+### parsePdfFile
 
-### 添加新的文件类型支持
+专门用于解析PDF文件的函数。
+
+```tsx
+import { parsePdfFile } from '@mxmweb/fviewer';
 
-1. **在Fviewer中添加类型检测**:
-```typescript
-// src/core/Fviewer.tsx
-const detectFileType = (data: any): FileType => {
-  // 添加新的类型检测逻辑
-  if (fileName.toLowerCase().endsWith('.newtype')) {
-    return 'newtype';
-  }
-  // ...
-};
+const pdfResult = await parsePdfFile(pdfArrayBuffer, {
+  fileName: 'document.pdf'
+});
 ```
 
-2. **添加渲染函数**:
-```typescript
-const renderNewTypeContent = (data: any, props: FviewerProps) => {
-  return (
-    <div>
-      {/* 新类型的渲染逻辑 */}
-    </div>
-  );
-};
+### parseImageFile
+
+图片文件解析函数。
+
+```tsx
+import { parseImageFile } from '@mxmweb/fviewer';
+
+const imageResult = await parseImageFile(imageBlob, {
+  fileName: 'image.jpg'
+});
 ```
 
-3. **在renderContent中添加case**:
-```typescript
-case 'newtype':
-  return renderNewTypeContent(data, props);
+### parseTextFile
+
+文本文件解析函数。
+
+```tsx
+import { parseTextFile } from '@mxmweb/fviewer';
+
+const textResult = await parseTextFile(textContent, {
+  fileName: 'document.txt'
+});
 ```
 
-### 添加新的业务适配器
+### parseMarkdownFile
 
-1. **创建适配器组件**:
-```typescript
-// src/adopters/NewBusinessReader.tsx
-const NewBusinessReader: React.FC<NewBusinessReaderProps> = (props) => {
-  // 业务逻辑处理
-  return (
-    <Fviewer
-      data={processedData}
-      eventsEmit={handleEvents}
-      // ... 其他属性
-    />
-  );
-};
+Markdown文件解析函数。
+
+```tsx
+import { parseMarkdownFile } from '@mxmweb/fviewer';
+
+const mdResult = await parseMarkdownFile(markdownContent, {
+  fileName: 'readme.md'
+});
 ```
 
-2. **遵循HOC模式**: 适配器应该包装核心组件，处理业务逻辑
+### detectFileType
 
-### 主题定制
+文件类型检测函数。
 
-```typescript
-const customTheme: AppTheme = {
-  colors: {
-    primary: '#your-primary-color',
-    background: '#your-background-color',
-    text: '#your-text-color',
-    // ... 其他颜色
-  },
-  space: {
-    radius: 'md',
-    padding: 'md',
-    // ... 其他间距
-  }
-};
+```tsx
+import { detectFileType } from '@mxmweb/fviewer';
+
+const fileType = detectFileType('document.pdf', 'pdf');
+// 返回: 'pdf'
+```
+
+### registerPDFWorker
+
+PDF Worker注册函数。
+
+```tsx
+import { registerPDFWorker } from '@mxmweb/fviewer';
+
+// 注册PDF Worker
+registerPDFWorker('/worker/pdf.worker.min.js');
+```
+
+### isPDFWorkerRegistered
+
+检查PDF Worker是否已注册的函数。
+
+```tsx
+import { isPDFWorkerRegistered } from '@mxmweb/fviewer';
+
+const isRegistered = isPDFWorkerRegistered();
+console.log('PDF Worker已注册:', isRegistered);
+```
+
+### getPDFWorkerPath
+
+获取当前PDF Worker路径的函数。
+
+```tsx
+import { getPDFWorkerPath } from '@mxmweb/fviewer';
+
+const workerPath = getPDFWorkerPath();
+console.log('当前PDF Worker路径:', workerPath);
+```
+
+## 类型定义
+
+### StaticFileReaderProps
+
+静态文件阅读器组件的属性接口。
+
+```tsx
+interface StaticFileReaderProps {
+  // 文件相关
+  fileUrl: string;
+  fileType?: string;
+  fileName?: string;
+  token?: string;
+  initialPage?: number;
+  annotations?: (Annotation | MDAnnotation | TableAnnotation)[];
+  // 直接数据传递
+  data?: any;
+  // 事件回调
+  eventsEmit?: (name: string, data?: any, innerFn?: any) => void;
+  // 样式配置
+  styles?: {
+    theme?: AppTheme;
+    mode?: 'light' | 'dark';
+  };
+  // 工具配置
+  tools?: ToolsConfig;
+  // 自定义组件
+  customComponents?: {
+    LoadingComponent?: React.ComponentType<{
+      status: string;
+      theme: AppTheme;
+    }>;
+    ErrorComponent?: React.ComponentType<{
+      error: string;
+      theme: AppTheme;
+    }>;
+  };
+  // 自定义类名
+  className?: string;
+  headerClass?: string;
+  contentClass?: string;
+}
+```
+
+### GientechStreamReaderProps
+
+流式文件阅读器组件的属性接口。
+
+```tsx
+interface GientechStreamReaderProps {
+  // 文件相关
+  convertedFilePath: string;
+  csrfToken?: string;
+  fileName?: string;
+  fileType: string;
+  initialPage?: number;
+  totalPages?: number;
+  annotations?: (Annotation | MDAnnotation | TableAnnotation)[];
+  // 用户信息
+  userName?: string;
+  userId?: string;
+  pageSize?: number;
+  // API配置
+  streamApiUrl?: string;
+  authorization?: string;
+  // 事件回调
+  eventsEmit?: (name: string, data?: any, innerFn?: any) => void;
+  // 工具配置
+  tools?: Partial<ToolsConfig>;
+  // 样式配置
+  styles?: Styles;
+  // 自定义组件
+  customComponents?: {
+    LoadingComponent?: React.ComponentType<{
+      status: string;
+      theme: AppTheme;
+    }>;
+    ErrorComponent?: React.ComponentType<{
+      error: string;
+      theme: AppTheme;
+    }>;
+  };
+  // 自定义类名
+  className?: string;
+  headerClass?: string;
+  contentClass?: string;
+}
+```
+
+### PdfRenderProps
+
+PDF渲染组件的属性接口。
+
+```tsx
+interface PdfRenderProps {
+  data: ArrayBuffer | string;
+  pageNumber?: number;
+  scale?: number;
+  annotations?: Annotation[];
+  onPageChange?: (pageNumber: number) => void;
+  onScaleChange?: (scale: number) => void;
+}
 ```
 
-## API参考
+### Annotation
+
+PDF标注数据接口。
 
-### 事件类型
+```tsx
+interface Annotation {
+  id: string;
+  pageNumber: number;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  content?: string;
+  color?: string;
+}
+```
 
-| 事件名 | 描述 | 数据格式 |
-|--------|------|----------|
-| `pageChange` | 页面变化 | `{ pageNumber: number, totalPages: number }` |
-| `markdown_scroll` | Markdown滚动 | `{ scrollTop: number, scrollHeight: number }` |
-| `zoomChange` | 缩放变化 | `{ scale: number }` |
-| `annotationChange` | 标注变化 | `{ annotation: Annotation }` |
-| `viewer:close` | 关闭查看器 | `undefined` |
+### MDAnnotation
+
+Markdown标注数据接口。
+
+```tsx
+interface MDAnnotation {
+  id: string;
+  start: number;
+  end: number;
+  content?: string;
+  color?: string;
+}
+```
 
-### 工具配置
+### TableAnnotation
 
-```typescript
+表格标注数据接口。
+
+```tsx
+interface TableAnnotation {
+  id: string;
+  offsets: [number, number][];
+  content?: string;
+  color?: string;
+}
+```
+
+### ToolsConfig
+
+工具配置接口。
+
+```tsx
 interface ToolsConfig {
-  annotation?: boolean;  // 标注功能
-  download?: boolean;    // 下载功能
-  zoom?: boolean;        // 缩放功能
-  close?: boolean;       // 关闭功能
-  navigation?: boolean;  // 导航功能
+  annotation?: boolean;    // 标注功能
+  download?: boolean;      // 下载功能
+  zoom?: boolean;         // 缩放功能
+  close?: boolean;        // 关闭功能
+  navigation?: boolean;   // 导航功能
+  rotate?: boolean;       // 旋转功能（主要用于图片）
 }
 ```
 
-## 技术栈
+### AppTheme
 
-- **React 18**: 核心框架
-- **TypeScript**: 类型安全
-- **styled-components v6**: CSS-in-JS样式
-- **PDF.js**: PDF渲染
-- **axios**: HTTP请求
-- **@mxmweb/rtext**: 富文本渲染
+应用主题接口。
 
-## 开发环境
+```tsx
+interface AppTheme {
+  colors: {
+    primary: string;
+    secondary: string;
+    success: string;
+    warning: string;
+    error: string;
+    info: string;
+    background: string;
+    text: string;
+    border: string;
+    disabled: string;
+    disabledBackground: string;
+    disabledText: string;
+    [key: string]: any;
+  };
+  space: {
+    sidebar: string;
+    size: string;
+    radius: string;
+    padding: string;
+    margin: string;
+    shadow: string;
+    lineHeight: string;
+    [key: string]: any;
+  };
+  [key: string]: any;
+}
+```
 
-```bash
-# 安装依赖
-npm install
+### Styles
+
+样式配置接口，来自 @mxmweb/zui 包。
+
+```tsx
+import { Styles } from '@mxmweb/zui';
+
+// Styles 是一个通用的样式配置接口
+// 用于配置组件的主题和样式
+```
 
-# 启动开发服务器
-npm run dev
+### ParseResult
 
-# 构建生产版本
-npm run build
+文件解析结果接口。
 
-# 类型检查
-npm run type-check
+```tsx
+interface ParseResult {
+  type: FileType;
+  content: any;
+  fileName?: string;
+  fileType?: string;
+  totalPages?: number;
+  error?: string;
+}
 ```
 
-## 注意事项
+### ParseOptions
+
+文件解析选项接口。
+
+```tsx
+interface ParseOptions {
+  fileName?: string;
+  fileType?: string;
+  token?: string;
+}
+```
 
-1. **缓存策略**: Stream业务流使用5分钟缓存过期时间，可根据需要调整
-2. **无限滚动**: Markdown模式下的无限滚动需要后端支持块级数据返回
-3. **主题配置**: 建议使用统一的主题配置，确保UI一致性
-4. **错误处理**: 所有网络请求都有错误处理，建议在业务层添加重试机制
+### FileType
 
-## 更新日志
+文件类型枚举。
 
-### v1.0.0
-- 初始版本发布
-- 支持PDF、Markdown、图片、文本、HTML格式
-- 实现Stream业务流和静态文件两种适配器
-- 支持无限滚动和智能缓存
-- 完整的主题化支持
+```tsx
+type FileType = 'pdf' | 'image' | 'text' | 'markdown' | 'markdown_table' | 'html' | 'unknown';
+```