Some XML helpers to help with OOXML development

> [!NOTE]
> These are all based around xml-js and output that modules internal format

API

$3

When working with xml-js it's really handy to not have to worry about when you're passing an XML string our the xml-js JSON type called Element

This helper function just outputs an Element for either input

``ts
asXmlElement("foo"); // => {name: "name", text: "foo"}
asXmlElement({ name: "name", text: "foo" }); // => {name: "name", text: "foo"}
`

> [!NOTE]
> All the other functions in this document that accept XML, also accept this Element (using this function)

$3

An XML tagged template literal with the following features

- error if XML is incorrect
- array support in substitution

The following will error in development, because of mismatched start/end tags

`ts
safeXmlhello;
`

Substitution of arrays "just works" so you can map values in the tagged template literals

`ts
const items = [1, 2, 3].map((n) => safeXmlitem ${1});
const outXml = safeXml${items};
assert.equal(
outXml,
item 1item 2item 3,
);
`

This also makes it easy to support

$3

Removes non required whitespace from the XML

`ts
const outXml = compact(

something

);
assert.equal(outXml, "something");
`

$3

For XML to be valid, there must be a single root node. When composing apps it's handy for that not to be true.

For example the following would error

`ts
const xml = safeXml
foo
bar
;
`

So instead we'd like something like a HTML fragment

`ts
const xml = safeXml

foo
bar

;
`

So we did just that, collapseFragments walks over a tree removing ... nodes.

`ts
const innerBit = safeXml

foo
bar

;
const newXml = collapseFragments(
safeXml

${innerBit}

,
);
assert.equal(
newXml,


foo
bar

,
);
`

$3

From the wikipedia page

> CDATA section is a piece of element content that is marked up to be interpreted literally, as textual data, not as marked-up content.

But is ugly and hard to read, so instead

`ts
safeXml${cdata("one < two")};
`

$3

Format XML in a consistent way, useful for logging and snapshot testing

`ts
format(
one

); /* =>
*
* one
*
*/
`

getAllByTestId

`ts
const element = getAllByTestId(


Hello


)
`

getByTestId

`ts
const element = getByTestId(


Hello


)
`

getSingleTextNode

`ts
getSingleTextNode(hello world) // => {type: "text", text: "hello world"}
`

Else throws an error

`ts
getSingleTextNode(hello inner node world) // => throws Error
`

removeTestIds

`ts
const element = removeTestIds(


Hello


) /* =>
*
*
* Hello
*
*
*/
``

CI


License

MIT