@office-open/xml

@office-open/xml

XML parsing and serialization for Office Open XML. Zero dependencies, drop-in replacement for xml + xml-js.

Features

• Zero Dependencies - No external runtime dependencies, pure TypeScript implementation
• xml() Serialization - Drop-in replacement for the xml package
• xml2js() Parsing - Drop-in replacement for xml-js XML parsing
• js2xml() Stringifying - Drop-in replacement for xml-js JS-to-XML conversion
• toElement() Direct Convert - Direct conversion from xml object format to xml-js Element, 10-19x faster than the xml→xml2js bridge
• Complete Type Definitions - Full type compatibility with xml and xml-js, import without changes
• OOXML Optimized - Implements all options needed for Office Open XML document generation

Installation

# pnpm
pnpm add @office-open/xml

# npm
npm install @office-open/xml

# yarn
yarn add @office-open/xml

# bun
bun add @office-open/xml

Migration from xml + xml-js

Replace your existing imports:

// Before
import xml from "xml";
import { xml2js, js2xml } from "xml-js";
import type { Element } from "xml-js";

// After
import { xml, xml2js, js2xml } from "@office-open/xml";
import type { Element } from "@office-open/xml";

No other code changes needed. All options and output formats are compatible.

Quick Start

import { xml, xml2js, js2xml, toElement } from "@office-open/xml";

// Serialize JS objects to XML
const xmlStr = xml({ "w:p": [{ _attr: { "w:val": "1" } }, { "w:r": [{ "w:t": "Hello" }] }] });
// <w:p w:val="1"><w:r><w:t>Hello</w:t></w:r></w:p>

// Parse XML to JS objects
const parsed = xml2js("<w:t>Hello</w:t>", { compact: false });

// Convert JS objects back to XML
const output = js2xml(parsed);

// Direct conversion (faster than xml → xml2js bridge)
const element = toElement({
  "w:p": [{ _attr: { "w:val": "1" } }, { "w:r": [{ "w:t": "Hello" }] }],
});

API

xml(input, options?)

Serialize JavaScript objects to XML string. Compatible with the xml package.

xml2js(xmlString, options?)

Parse XML string to JavaScript object. Compatible with xml-js.

js2xml(jsObject, options?)

Convert JavaScript object (xml-js Element format) to XML string. Compatible with xml-js.

json2xml(jsObject, options?)

Alias for js2xml.

xml2json(xmlString, options?)

Convenience function that returns JSON.stringify(xml2js(xmlString, options)).

toElement(input)

Direct conversion from xml object format to xml-js Element format. Much faster than the xml() → xml2js() bridge path.

escapeXml(str) / escapeAttributeValue(str)

Low-level XML entity escaping functions.

Benchmark

Performance comparison against original xml (1.0.1) and xml-js (1.6.11) packages:

Serialization (xml)

Scenario	@office-open/xml	xml	Speedup
Simple element	5,069,751 hz	724,533 hz	7.00x
Nested element	1,122,376 hz	279,423 hz	4.02x
Nested with declaration	1,050,046 hz	248,678 hz	4.22x

Parsing (xml2js)

Scenario	@office-open/xml	xml-js	Speedup
Simple XML	1,000,869 hz	90,488 hz	11.06x
Complex OOXML	310,266 hz	42,938 hz	7.23x
With captureSpaces	313,183 hz	41,814 hz	7.49x

Stringifying (js2xml)

Scenario	@office-open/xml	xml-js	Speedup
Simple element	975,878 hz	198,953 hz	4.90x
Complex OOXML	492,220 hz	107,815 hz	4.57x

Direct Conversion (toElement vs bridge)

Scenario	toElement()	xml() + xml2js() bridge	Speedup
Simple	13,199,415 hz	805,104 hz	16.40x
Nested	4,207,319 hz	458,333 hz	9.18x

Bundle Size

	@office-open/xml	xml + xml-js
gzip	4.22 kB	~15 kB

License

• MIT © Demo Macro