# @haklex/rich-agent-core 中文文档

规范地址：https://npmcn.com/package/%40haklex/rich-agent-core/

版本：0\.66\.0
npm 元数据更新时间：2026-11-15T13:30:00.560Z
中文译文更新时间：2026-11-17T06:33:59.905Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40haklex/rich-agent-core
原文对照：https://npmcn.com/package/%40haklex/rich-agent-core/?lang=original
项目主页：https://github.com/Innei/haklex#readme
源码仓库：https://github.com/Innei/haklex

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：119 kB，75 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：lexical ^0\.53\.0，@haklex/rich-editor ^0\.66\.0
- 首次发布：2026-03-30T18:41:50.372Z
- 最新版本发布：2026-11-15T13:30:00.215Z
- 近 30 天下载量：10847（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：150（近 12 个月 150 个）

## 中文简介

无头AI代理协议, diff 引擎, 并为 Lexical 编辑器存储

## 安装

```sh
npm install @haklex/rich-agent-core
```

也可以使用：`pnpm add @haklex/rich-agent-core`、`yarn add @haklex/rich-agent-core`、`bun add @haklex/rich-agent-core`

## README

# @haklex/ rich- agent- core

Lexical富文本编辑的无头AI代理协议. 提供diff-aware编辑引擎,文档上下文快照,基于LiteXML的编辑,以及Zustand后置代理商店——所有框架不可知和UI免费.

## 安装

```bash
pnpm add @haklex/rich-agent-core
```

## 同伴依赖关系

| 软件包 | 版本 |
| --- | --- |
| `@haklex/rich-editor` | 工作空间 |
| `lexical` | `^0.45.0` |

## 使用量

### 创建代理仓库

```ts
import { createAgentStore, createInitialAgentStoreState } from '@haklex/rich-agent-core';

const store = createAgentStore(
  createInitialAgentStoreState({
    // initial state configuration
  }),
);
```

### 构建代理文档上下文

```ts
import { buildDocumentContext } from '@haklex/rich-agent-core';

const context = buildDocumentContext(editorState, {
  /* options */
});
```

### 创建代理执行器

```ts
import { createAgentExecutor } from '@haklex/rich-agent-core';

const executor = createAgentExecutor({
  store,
  provider: myProvider,
  config: {
    /* executor config */
  },
});

const result = await executor.execute({ prompt: 'Improve this paragraph' });
```

### 创建文档编辑工具

```ts
import { createDocumentTools } from '@haklex/rich-agent-core';

const tools = createDocumentTools({ store, editor });
```

### 创建和比较快照

```ts
import { createSnapshot, compareBlockContent } from '@haklex/rich-agent-core';

const snapshot = createSnapshot(editorState);
const hasChanged = compareBlockContent(snapshotA, snapshotB);
```

### 使用选择器

```ts
import { agentStoreSelectors } from '@haklex/rich-agent-core';

const messages = agentStoreSelectors.messages(store.getState());
const status = agentStoreSelectors.status(store.getState());
```

## 出口

### 代理存储

| 导出 | 说明 |
| --- | --- |
| `createAgentStore(state)` | 创建 Zustand 代理店 |
| `createInitialAgentStoreState(config)` | 创建初始存储状态 |
| `agentStoreSelectors` | 存储状态的已键入选择器函数 |
| `flattenActions(actions)` | 平起平坐的行动小组 |

### 代理执行器

| 导出 | 说明 |
| --- | --- |
| `createAgentExecutor(config)` | 创建运行提示的代理执行器 |
| `AgentExecutorConfig` | 执行器的配置类型 |
| `AgentExecutorResult` | 执行器运行的结果类型 |

### 文档工具

| 导出 | 说明 |
| --- | --- |
| `createDocumentTools(config)` | 为代理服务器创建文档编辑工具 |
| `buildDocumentContext(state, options?)` | 为代理消费建立文档上下文 |

### LiteXML 整合

| 导出 | 说明 |
| --- | --- |
| `createLitexmlEditHandler(config)` | 创建一个应用 LiteXML 编辑到编辑器的处理器 |
| `createLitexmlParseHandler(config)` | 创建处理器, 从代理响应中解析 LiteXML |
| `createLitexmlRegistry(options?)` | 为代理使用创建 LiteXML 注册 |
| `LitexmlRegistryOptions` | LiteXML 注册创建选项 |
| `LitexmlRegistryProvider` | LiteXML 登记册的提供者接口 |

### 提供者

| 导出 | 说明 |
| --- | --- |
| `createProvider(config)` | 创建 AI 提供者实例 |
| `createDirectTransport(config)` | 创建直接传输适配器 |
| `createProxyTransport(config)` | 创建代理传输适配器 |
| `ProviderType` | 支助提供者类型的联盟类型 |
| `TransportAdapter` | 运输适配器接口 |

### Diff 复议( V)

| 导出 | 说明 |
| --- | --- |
| `createDiffEngine(config)` | 为编辑操作创建 diff 引擎 |
| `createReviewEngine(config)` | 为 AI 推荐编辑创建审查引擎 |
| `DiffEngineConfig`, (中文(简体) ), `ReviewEngineConfig` | 配置类型 |
| `DiffHunk`, (中文(简体) ), `DiffResult` | Diff 结果类型 |
| `ReviewBlock`, (中文(简体) ), `ReviewState` | 审查状态类型 |

### 信件引擎

| 导出 | 说明 |
| --- | --- |
| `createMessagesEngine(config)` | 为聊天状态创建消息引擎 |
| `MessagesEngineConfig` | 配置类型 |
| `ChatMessage`, (中文(简体) ), `MessageRole` | 信件类型 |

### 抓图

| 导出 | 说明 |
| --- | --- |
| `createSnapshot(state)` | 创建编辑器状态快照 |
| `compareBlockContent(a, b)` | 按块内容比较两个快照 |
| `EditorSnapshot` | 快照类型 |

### 类型

| 导出 | 说明 |
| --- | --- |
| `AgentStore`, (中文(简体) ), `AgentStoreState`, (中文(简体) ), `AgentStoreSlice` | 存储类型 |
| `AgentStoreStatus` | 存储状态enum |
| `ChatBubble` | 用于 UI 渲染的聊天泡类型 |
| `ToolCallGroupItem`, (中文(简体) ), `ToolCallItemStatus` | 工具调用类型定义 |
| `StoreSetter` | 存储设置函数类型 |

### 选择器

| 导出 | 说明 |
| --- | --- |
| `agentStoreSelectors.messages` | 获取所有信件 |
| `agentStoreSelectors.status` | 获取当前存储状态 |
| `agentStoreSelectors.session` | 获取当前会话信息 |
| `agentStoreSelectors.toolCalls` | 获取工具调用状态 |
| `agentStoreSelectors.diff` | 获取 diff 审查状态 |
| `agentStoreSelectors.model` | 获取选中的模型信息 |

## 哈克历克的一部分

此软件包是 [哈克历](https://npmcn.com/package/README.md) 丰富的编辑生态系统.

## 许可证

麻省理工学院

## 常见问题

### @haklex/rich-agent-core 是什么？

无头AI代理协议, diff 引擎, 并为 Lexical 编辑器存储

### 如何安装 @haklex/rich-agent-core？

在项目目录运行 npm install @haklex/rich-agent-core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：lexical（^0\.53\.0）、@haklex/rich-editor（^0\.66\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @haklex/rich-agent-core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @haklex/rich-agent-core 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @haklex/rich-agent-core 可以商用吗？

@haklex/rich-agent-core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @haklex/rich-agent-core 的下载量有多少？

根据 npm 官方下载统计，@haklex/rich-agent-core 在 2026/10/17 – 2026/11/15 这 30 天内被下载 10,847 次，日均约 362 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @haklex/rich-agent-core 还在维护吗？

最新版本 0\.66\.0 发布于 2026/11/15（1 天前）；至今共发布 150 个版本，其中过去 12 个月发布了 150 个；首次发布于 2026/03/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

