@haklex/rich-litexml

中文文档
0.66.0发布于 2026/11/15MITTypeScriptES Module构建来源已验证近 30 天下载 1.6万

Bidirectional Lexical SerializedNode <-> XML conversion with plugin registry

原始使用文档
文档目录13 节
  1. Installation
  2. Peer Dependencies
  3. Usage
  4. Serialize editor state to XML
  5. Deserialize XML to editor state
  6. Register custom node types
  7. Exports
  8. Serialization
  9. Registry
  10. Types
  11. Sub-path Exports
  12. Part of Haklex
  13. License

@haklex/rich-litexml

Bidirectional Lexical editor state ↔ XML serialization for LLM-friendly document I/O. Converts Lexical SerializedEditorState to a compact, token-efficient XML format and back again — enabling AI agents to read and write structured rich text documents with minimal token overhead.

Installation

pnpm add @haklex/rich-litexml

Peer Dependencies

PackageVersion
lexical^0.45.0

Usage

Serialize editor state to XML

import { serializeToXml } from '@haklex/rich-litexml';

const xml = serializeToXml(serializedEditorState);
// '<root><p>Hello <strong>world</strong></p><img src="..." /></root>'

Deserialize XML to editor state

import { deserializeFromXml } from '@haklex/rich-litexml';

const editorState = deserializeFromXml(xmlString);

Register custom node types

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]);

Exports

Serialization

ExportDescription
serializeToXml(state, options?)Convert SerializedEditorState to XML string
serializeNodesToXml(nodes, options?)Convert an array of serialized nodes to XML
deserializeFromXml(xml)Convert an XML string to SerializedEditorState
deserializeNodesFromXml(xml)Convert an XML string to serialized nodes array

Registry

ExportDescription
LitexmlRegistryPlugin registry class for custom node readers/writers
createDefaultRegistry()Create a registry pre-populated with builtins
registerBuiltinReaders(registry)Register builtin XML → node readers
registerBuiltinWriters(registry)Register builtin node → XML writers
registerCustomReaders(registry, readers)Register custom readers
registerCustomWriters(registry, writers)Register custom writers

Types

ExportDescription
XmlSerializerOptionsOptions for XML serialization
LitexmlNodeReaderReader interface for XML → node conversion
LitexmlNodeWriterWriter interface for node → XML conversion
XmlNodeData, XmlNodeElementXML AST types
XmlRenderOptionsRendering style options for XML output

Sub-path Exports

Import PathDescription
@haklex/rich-litexmlFull exports (browser or Node.js, auto-selected)

The package selects between browser and Node.js entry points automatically: Node.js uses linkedom for HTML parsing, while the browser entry uses the native DOMParser.


Note: LiteXML is XML-based, not a custom DSL. The compact tag vocabulary minimizes token count for LLM consumption. For AI agent integration, see @haklex/rich-agent-core.

Part of Haklex

This package is part of the Haklex rich editor ecosystem.

License

MIT

版本与发布记录

@haklex/rich-litexml 共发布 152 个版本,首次发布于 2026/03/31;过去 12 个月发布了 152 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.66.0latest2026/11/151 天前
0.65.72026/11/143 天前
0.65.62026/11/124 天前
0.65.52026/11/124 天前
0.65.42026/11/124 天前
0.65.32026/11/124 天前

关于 @haklex/rich-litexml 的常见问题

@haklex/rich-litexml 是什么?

Bidirectional Lexical SerializedNode <-> XML conversion with plugin registry

如何安装 @haklex/rich-litexml?

在项目目录运行 npm install @haklex/rich-litexml,或使用 pnpm add / yarn add / bun add。

@haklex/rich-litexml 支持 TypeScript 吗?

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

@haklex/rich-litexml 支持 ESM 还是 CommonJS?

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

@haklex/rich-litexml 可以商用吗?

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

@haklex/rich-litexml 的下载量有多少?

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

@haklex/rich-litexml 还在维护吗?

最新版本 0.66.0 发布于 2026/11/15(1 天前);至今共发布 152 个版本,其中过去 12 个月发布了 152 个;首次发布于 2026/03/31。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。