@haklex/ rich- litexml
用于方便 LLM 文档 I/O 的双向 Lexical 编辑器状态 XML 序列化。 转换 Lexical SerializedEditorState 改为紧凑的,具有符号效率的XML格式,并再次返回——使AI代理能够以最小的符号间接费用来读取和写入结构化的丰富文本文档.
安装
pnpm add @haklex/rich-litexml
同伴依赖关系
| 软件包 | 版本 |
|---|---|
lexical | ^0.45.0 |
使用量
将编辑器状态序列化为 XML
import { serializeToXml } from '@haklex/rich-litexml';
const xml = serializeToXml(serializedEditorState);
// '<root><p>Hello <strong>world</strong></p><img src="..." /></root>'
将 XML 切换为编辑器状态
import { deserializeFromXml } from '@haklex/rich-litexml';
const editorState = deserializeFromXml(xmlString);
注册自定义节点类型
import { LitexmlRegistry } from '@haklex/rich-litexml';
import { registerBuiltinReaders, registerCustomReaders } from '@haklex/rich-litexml';
import { registerBuiltinWriters, registerCustomWriters } from '@haklex/rich-litexml';
const registry = new LitexmlRegistry();
registerBuiltinReaders(registry);
registerBuiltinWriters(registry);
// Add custom node readers/writers
registerCustomReaders(registry, [myReader]);
registerCustomWriters(registry, [myWriter]);
出口
序列化
| 导出 | 说明 |
|---|---|
serializeToXml(state, options?) | 转换 SerializedEditorState 到 XML 字符串 |
serializeNodesToXml(nodes, options?) | 将序列化节点数组转换为 XML |
deserializeFromXml(xml) | 将 XML 字符串转换为 SerializedEditorState |
deserializeNodesFromXml(xml) | 将 XML 字符串转换为序列化节点数组 |
书记官处
| 导出 | 说明 |
|---|---|
LitexmlRegistry | 用于自定义节点阅读器/写入器的插件注册类 |
createDefaultRegistry() | 创建一个预先使用内建内容的登记册 |
registerBuiltinReaders(registry) | XML – 节点读取器内置的注册 |
registerBuiltinWriters(registry) | 内置节点的注册 ~ XML 写入器 |
registerCustomReaders(registry, readers) | 注册自定义阅读器 |
registerCustomWriters(registry, writers) | 注册自定义作者 |
类型
| 导出 | 说明 |
|---|---|
XmlSerializerOptions | XML 序列化选项 |
LitexmlNodeReader | XML — 节点转换的读取器接口 |
LitexmlNodeWriter | 节点- XML 转换的 Writer 接口 |
XmlNodeData, (中文(简体) ), XmlNodeElement | XML AT 类型 |
XmlRenderOptions | XML 输出的渲染样式选项 |
子路径导出
| 导入路径 | 说明 |
|---|---|
@haklex/rich-litexml | 完全导出(浏览器或节点.js,自动选择) |
软件包在浏览器和 Node.js 入口之间自动选择: Node.js 使用 linkedom hTML 解析,而浏览器条目使用本地 DOMParser。 。 。 .
说明: LiteXML基于XML,而不是自定义的DSL. 紧凑的标签词汇将 LLM 消耗的符号计数最小化 。 关于AI代理集成,参见
@haklex/rich-agent-core。 。 。 .
哈克历克的一部分
此软件包是 哈克历 丰富的编辑生态系统.
许可证
麻省理工学院