@haklex/rich-litexml 0.24.0 → 0.25.0

package/README.md

@@ -0,0 +1,102 @@
+# @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
+
+```bash
+pnpm add @haklex/rich-litexml
+```
+
+## Peer Dependencies
+
+| Package   | Version   |
+| --------- | --------- |
+| `lexical` | `^0.45.0` |
+
+## Usage
+
+### Serialize editor state to XML
+
+```ts
+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
+
+```ts
+import { deserializeFromXml } from '@haklex/rich-litexml';
+
+const editorState = deserializeFromXml(xmlString);
+```
+
+### Register custom node types
+
+```ts
+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
+
+| Export                                 | Description                                      |
+| -------------------------------------- | ------------------------------------------------ |
+| `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
+
+| Export                                     | Description                                           |
+| ------------------------------------------ | ----------------------------------------------------- |
+| `LitexmlRegistry`                          | Plugin 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
+
+| Export                          | Description                                |
+| ------------------------------- | ------------------------------------------ |
+| `XmlSerializerOptions`          | Options for XML serialization              |
+| `LitexmlNodeReader`             | Reader interface for XML → node conversion |
+| `LitexmlNodeWriter`             | Writer interface for node → XML conversion |
+| `XmlNodeData`, `XmlNodeElement` | XML AST types                              |
+| `XmlRenderOptions`              | Rendering style options for XML output     |
+
+### Sub-path Exports
+
+| Import Path            | Description                                      |
+| ---------------------- | ------------------------------------------------ |
+| `@haklex/rich-litexml` | Full 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](../../README.md) rich editor ecosystem.
+
+## License
+
+MIT

package/dist/browser.mjs

@@ -1,4 +1,4 @@
-import { a as createDefaultRegistry, c as LitexmlRegistry, d as registerParseHTML, i as deserializeNodesFromXml, l as registerCustomReaders, n as serializeToXml, o as registerCustomWriters, r as deserializeFromXml, s as registerBuiltinWriters, t as serializeNodesToXml, u as registerBuiltinReaders } from "./src-BHEK3mCO.js";
+import { a as createDefaultRegistry, c as LitexmlRegistry, d as registerParseHTML, i as deserializeNodesFromXml, l as registerCustomReaders, n as serializeToXml, o as registerCustomWriters, r as deserializeFromXml, s as registerBuiltinWriters, t as serializeNodesToXml, u as registerBuiltinReaders } from "./src-1idECb05.js";
 //#region src/index-browser.ts
 registerParseHTML((html) => new DOMParser().parseFromString(html, "text/html"));
 //#endregion

package/dist/node.mjs

@@ -1,4 +1,4 @@
-import { a as createDefaultRegistry, c as LitexmlRegistry, d as registerParseHTML, i as deserializeNodesFromXml, l as registerCustomReaders, n as serializeToXml, o as registerCustomWriters, r as deserializeFromXml, s as registerBuiltinWriters, t as serializeNodesToXml, u as registerBuiltinReaders } from "./src-BHEK3mCO.js";
+import { a as createDefaultRegistry, c as LitexmlRegistry, d as registerParseHTML, i as deserializeNodesFromXml, l as registerCustomReaders, n as serializeToXml, o as registerCustomWriters, r as deserializeFromXml, s as registerBuiltinWriters, t as serializeNodesToXml, u as registerBuiltinReaders } from "./src-1idECb05.js";
 import { parseHTML } from "linkedom";
 //#region src/index-node.ts
 registerParseHTML((html) => parseHTML(html).document);

package/dist/readers/custom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"custom.d.ts","sourceRoot":"","sources":["../../src/readers/custom.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAoDnD,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,CAidrE"}
+{"version":3,"file":"custom.d.ts","sourceRoot":"","sources":["../../src/readers/custom.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAoDnD,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,CA0erE"}

package/dist/{src-BHEK3mCO.js → src-1idECb05.js}

@@ -405,6 +405,22 @@ function registerCustomReaders(registry) {
 		snapshot: extractCdataText(el) || el.getAttribute("snapshot") || el.textContent?.trim() || "",
 		version: 1
 	}));
+	registry.registerReader("dynamic", (el) => {
+		let props = {};
+		const raw = (extractCdataText(el) ?? el.textContent ?? "").trim();
+		if (raw) try {
+			const parsed = JSON.parse(raw);
+			if (parsed && typeof parsed === "object" && !Array.isArray(parsed)) props = parsed;
+		} catch {}
+		return {
+			type: "dynamic",
+			...extractBlockId(el),
+			url: el.getAttribute("url") ?? "",
+			props,
+			initialHeight: numAttr(el, "initial-height") ?? 320,
+			version: 1
+		};
+	});
 	registry.registerReader("grid", (el, ctx) => {
 		const cells = [];
 		for (const child of el.children) if (child.tagName.toLowerCase() === "cell") {
@@ -795,6 +811,24 @@ function registerCustomWriters(registry) {
 			children: [{ cdata: n.snapshot }]
 		};
 	});
+	registry.registerWriter("dynamic", (node) => {
+		const n = node;
+		const attrs = optAttr({
+			...blockId(n),
+			"url": n.url,
+			"initial-height": n.initialHeight != null ? String(n.initialHeight) : void 0
+		});
+		if (!n.props || Object.keys(n.props).length === 0) return {
+			tag: "dynamic",
+			attrs,
+			selfClosing: true
+		};
+		return {
+			tag: "dynamic",
+			attrs,
+			children: [{ cdata: JSON.stringify(n.props) }]
+		};
+	});
 	registry.registerWriter("grid-container", (node, ctx) => {
 		const n = node;
 		const cells = (n.cells ?? []).map((cellState) => ({

package/dist/writers/custom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"custom.d.ts","sourceRoot":"","sources":["../../src/writers/custom.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAenD,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,CAwUrE"}
+{"version":3,"file":"custom.d.ts","sourceRoot":"","sources":["../../src/writers/custom.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAenD,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,CA2VrE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haklex/rich-litexml",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "description": "Bidirectional Lexical SerializedNode <-> XML conversion with plugin registry",
   "repository": {
     "type": "git",