you can use:
new RegExp("\sid\s_=\s_['"]"+id+"['"]").exec(S).index

With DomParser, this attributes with special attributes like >, < are replaced with the corresponding character, will be possible txml do the same?

There is console log puts garbage in STDOUT (tXml.js, line 339):

console.log('kids', kids);

The value of this library increases if it can be configured to build the resulting object similar to popular projects like rapidx2j, nkit, x2je, xml2json and xml2js. It would instantly become a drop-in replacement for each of those libraries used in other node projects.

In order to do that, you'd need to:

1. add nodes with their tagName as keys to an object rather than values to a property;
2. group attributes to a key with a custom name, in this case "@";
3. only turn the object of the tagName key into an array if the tagName occurs more than once.

Would you be interested in adding the option(s) to do so?

Example: In stead of this:

[
  "children": [
    {
      "tagName": "child1",
      "attributes": {},
      "children": [
        {
          "tagName": "child2",
          "attributes": {},
          "children": [
            {
              "tagName": "child3",
              "attributes": {},
              "children": [
                "tagName": "child4",
                // ...

We need to end up with this:

{
  "child1": {
    "@": {},
    "child2": {
      "@": {},
      "child3": {
        "@": {},
        "child4": [
          // ...

In response to Redsandro/node-xml2js-olympics#1

#29

#29

Hello 👋

I went looking for a fast xml library for a particular use case I have and boy did I ever find one! Amazing work Tobias!
I can use streams with it too?! Superb!

Unfortunately, using the code from the readme doesn't seem to work for me :(. I'm simply told xmlStream is not async iterable
I'm on node v18.11.0.

const xmlStream = fs
    .createReadStream("./my-file.xml")
    .pipe(txml.transformStream());

  for await (let element of xmlStream) {
    // your logic here ...
  }

I tried attaching event handles like

const xmlStream = fs
    .createReadStream("./my-file.xml")
    .pipe(txml.transformStream());

xmlStream.on('data', (data) => {console.log(data});

And that didn't work, it just hangs, but if I remove the pipe I see the chunks coming in from the readStream

const xmlStream = fs
    .createReadStream("./my-file.xml");

xmlStream.on('data', (data) => {console.log(data.toString())});

Not sure what else I can try from my side.

Needs to be simplify

#29

see #21 my comment.
another thing: in addition to tagName, can we add prefix and localName field to element?
also can we don't create attributes/children if there is nothing there?

the parse options and methods filter and getElementByID are somehow not working as I understand them.
Is there some bug or maybe lacking docs?

I expect the same result for a and b and furthermore for c and d, right?

const a = txml.parse(rawXML, {
  filter: (dom) => dom.attributes.webdavID == id,
});
const b = txml.parse(rawXML).filter((dom) => dom.attributes.webdavID == id)
// expect a==b
// result: a is node with id and b == []

const c = txml.parse(rawXML, { searchId: 'N10005' });
const d = txml.getElementById(rawXML, 'N10005');
// expect c==d
// result: c is whole xml and d is the node with id

I have noticed that there is unreachable code below this while at line 406.

Just upgraded from 4.0.1 to 5.0.0 release and

txml.parse('<?xml version="1.0"?><methodCall>TEST</methodCall', { simplify: true })

now throws the following error:

TypeError: Cannot create property '_attributes' on string ''

Thanks for your work!

I am just really learning Sevelte and Javascript webdevelopment - I am having issues using the library.

I have done:
npm i txml

But I am not sure how to 'import' it. I have tried:
import * as txml from 'txml';

But that gives me a 500 error and the message:
TypeError: Cannot read properties of undefined (reading 'from')
at node_modules/safe-buffer/index.js (index.js:11:12)
at __require2 (chunk-OZI5HTJH.js?v=5487c821:15:50)
at node_modules/readable-stream/lib/_stream_readable.js (_stream_readable.js:55:14)
at __require2 (chunk-OZI5HTJH.js?v=5487c821:15:50)
at node_modules/readable-stream/readable-browser.js (readable-browser.js:1:28)
at __require2 (chunk-OZI5HTJH.js?v=5487c821:15:50)
at node_modules/through2/through2.js (through2.js:1:17)
at __require2 (chunk-OZI5HTJH.js?v=5487c821:15:50)
at transformStream.mjs:2:22

#29

It fails to parse the time tag under trkpt in GPX files.

There are 2 scenarios I have found where the parser does not throw an error even though the xml is invalid.

1. root level elements without a close tag that aren't marked as a noChildNodes element

parse("<a><b></b>")
// returns
// [
//   {
//     tagName: 'a',
//     attributes: {},
//     children: [ { tagName: 'b', attributes: {}, children: [] } ]
//   }
// ]

2. root level orphaned close tags (stops parsing after the first one encountered)

parse("</a><b></b>")
// returns
// []

parse("<a></a></b><c></c>")
// returns
// [ { tagName: 'a', attributes: {}, children: [] } ]

Technically there is a third where it doesn't error if there is more than one root element ex. <a></a><a></a> but I am assuming that is intended behavior so it can parse xml fragments. Maybe there should be an option to toggle whether to parse as a fragment or not? Either way this one isn't a big deal because it is very easy to check after parsing if there are multiple root elements.

#29

can you help me understand this please, maybe a short example in doc?. thank you

With the following HTML:

<style>p { color: "red" }</style>

txml returns:

[
      {
        tagName: 'style',
        attributes: {},
        children: [ 'p { color: "red" ' ] // note here the closing bracket is missing
      }
]

and so the text content of the <style> tag loses the } closing bracket

Wasn't sure whether this was a feature or bug, but I'm thinking it might be the latter.

Here is the input

<response>
  <error msg="haha, nice try">
    <anything></anything>
  </error>
</response>

and this is the output

{
  "response": {
    "error": {
      "anything": "",
      "_attributes": {
        "msg": "haha, nice try"
      }
    },
    "_attributes": {}
  }
}

if I take out the anything tags, the msg attribute is not included anymore

<response>
  <error msg="haha, nice try">
  </error>
</response>

result:

{
  "response": {
    "error": "",
    "_attributes": {}
  }
}

but I'm expecting:

{
  "response": {
    "error": {
      "_attributes": {
        "msg": "haha, nice try"
      }
    },
    "_attributes": {}
  }
}

It looks like the presence of an additional child tag is required to treat the element as an object instead of as a string value

Hi @TobiasNickel, is tXml still being maintained?

It would be nice to have an option to parse comments, too.
Sometimes comments in the AST can be useful.
As an optional option, this wouldn't unnecessarily impede performance.

#29

Whenever I parse this string:

<p type=bold>hello mom!</p>

I get unexpected results:

{
  tagName:"p",
  attributes:{
    type:null,
    bold:null
  },
  children:["hello mom!"]
}

I know this is an xml parser but wouldn't it just make sense to generate:

{
  tagName:"p",
  attributes:{
    type:"bold"
  },
  children:["hello mom!"]
}

Please consider adding such type parsing in the next bug fix, I love your library! 🥰🥰

When a SVG XML file begins with an XML comment, the SVG file is not parsed (stream ends immediately):

<!-- Test -->
<svg height="200" width="500">
  <polyline points="20,20 40,25 60,40 80,120 120,140 200,180" style="fill:none;stroke:black;stroke-width:3" />
</svg>

Without the comment, parsing as stream works fine:

<svg height="200" width="500">
  <polyline points="20,20 40,25 60,40 80,120 120,140 200,180" style="fill:none;stroke:black;stroke-width:3" />
</svg>

Hi @TobiasNickel,

just got this issue while importing txml in my angular application.

Error: node_modules/txml/tXml.d.ts:25:23 - error TS1246: An interface property cannot have an initializer.

25     setPos: boolean = false;

Angular doesn't allow an initializer in interfaces :-/

Thanks for your help :-)

I am having issues included this library in the browser. It appears that this library is using node only APIs (e.x. fs). I am using typescript and webpack.

[0] ERROR in ./node_modules/tXml/tXml.js
Module not found: Error: Can't resolve 'fs' in '.../node_modules/tXml'

I have tried importing a few different ways without any success
import { xml as tXml, simplify } from 'tXml';
import * as tXml from 'tXml';

Also, it appears that either the README is out of data or that the typescript definitions generated are incorrect, as the type definition does not match the README examples.

Hi,

README.md states:
tXml("<user is='great'><name>Tobias</name><familyName>Nickel</familyName><profession>Software Developer</profession><location>Shanghai / China</location></user>",{simplify:1});

however, simplify is not invoked like this. Rather it is invoked by:
tXml.simplify(tXml(xmlString));

kind regards
Martin

Thank you for lib ❤️. This is a feature request.

Right now getElementById returns a parsed XML object, but it would be great if we could change and replace it inside the original JSON and convert it to XML.

Should the type be

export type tNode = {
tagName: string;
attributes: object;
children: (tNode | string | number)[];
};

?

#29

as mentioned in the svgo PR, rollup includes to much unneccessary code into a bundle: svg/svgo#1301 (comment)

we should find a way to support propper treeshaking for smaller bundles.

Through2 look not necessary. Can be replaced with const { PassThrough } = require('through2');

The reason for that is, that txml is pure js. There will be no issues about compiling any native modules. It is also much faster than the native module.

AFAIK rollup will still hoist lazy requires to convert into es modules. You better split stream based extension into separate entry point.

tXml fails to parse perfectly valid XML like this:

<a><link>foobar</link></a>

I get error "Error: Unexpected close tag" (for the record, fix is to give noChildNodes: [] as option for parse()).

This is kind of a documented feature as documentation describes noChildNodes as "array of nodes, that have no children and don't need to be closed. Default is working good for html." and is given as an example. However, it is surprising that parsing fails if closing tag do exist (not sure but I think link tag can be closed?). It is also surprising that XML parser, by default, fails to parse valid XML even if stated in the documentation if you read far enough especially when everything seems to work at first and then just crashed later on when link tag makes it way to XML.

So I would propose enhancement along the lines:

1. Make parse() accept end tags for noChildNodes as well, if this is possible
2. Update documentation so that it is obvious that by default parse() is designed for HTML and may fail with XML
3. Perhaps even separate functions with different defaults link parseHtml() and parseXml(), this would also help e.g. with #44 so parseXml and parseHtml would by default decode entities and CDATA while parse() would be backwards compatible

But hey, great parser in any case, worked just fine with a product using Rhino engine blocking access to everything otherwise able to decode XML...

@TobiasNickel thanks for providing this phantastic library!

I was trying to parse MEI xml code (music score encodings follwing https://music-encoding.org), using txml online.

However, it seems that simplify() ignores the attributes of the lowest level elements (that is in my example e.g., the attributes).

Example XML encoding:
https://raw.githubusercontent.com/trompamusic-encodings/Beethoven_WoOAnh5_BreitkopfHaertel/master/Beethoven_WoOAnh5_Nr1_1-Breitkopf.mei

Excerpt of simplified JSON output from txml online:

                              {
                                "layer": {
                                  "note": [
                                    "",
                                    ""
                                  ],
                                  "beam": {
                                    "note": [
                                      "",
                                      "",
                                      "",
                                      ""
                                    ],
                                    "_attributes": {
                                      "xml:id": "beam-0000001293813124"
                                    }
                                  },
                                  "_attributes": {
                                    "xml:id": "layer-0000000369478504",
                                    "n": "1"
                                  }
                                },
                                "_attributes": {
                                  "xml:id": "staff-0000000951146630",
                                  "n": "1"
                                }
                              },                             

#29

node_modules/txml/dist/index.d.ts:2:10 - error TS2552: Cannot find name 'transformSt
ream'. Did you mean 'TransformStream'?

2 export { transformStream, filter, getElementById, getElementsByClassName, parse, s
implify, simplifyLostLess, stringify, toContentString };
           ~~~~~~~~~~~~~~~

  node_modules/typescript/lib/lib.dom.d.ts:13783:13
    13783 declare var TransformStream: {
                      ~~~~~~~~~~~~~~~
    'TransformStream' is declared here.

node_modules/txml/dist/index.d.ts:2:27 - error TS2552: Cannot find name 'filter'. Di
d you mean 'File'?

2 export { transformStream, filter, getElementById, getElementsByClassName, parse, s
implify, simplifyLostLess, stringify, toContentString };
                            ~~~~~~

  node_modules/typescript/lib/lib.dom.d.ts:5014:13
    5014 declare var File: {
                     ~~~~
    'File' is declared here.

node_modules/txml/dist/index.d.ts:2:35 - error TS2304: Cannot find name 'getElementB
yId'.

2 export { transformStream, filter, getElementById, getElementsByClassName, parse, s
implify, simplifyLostLess, stringify, toContentString };
                                    ~~~~~~~~~~~~~~

node_modules/txml/dist/index.d.ts:2:51 - error TS2304: Cannot find name 'getElements
ByClassName'.

2 export { transformStream, filter, getElementById, getElementsByClassName, parse, s
implify, simplifyLostLess, stringify, toContentString };
                                                    ~~~~~~~~~~~~~~~~~~~~~~

node_modules/txml/dist/index.d.ts:2:75 - error TS2304: Cannot find name 'parse'.

2 export { transformStream, filter, getElementById, getElementsByClassName, parse, s
implify, simplifyLostLess, stringify, toContentString };
                                                                            ~~~~~

node_modules/txml/dist/index.d.ts:2:82 - error TS2304: Cannot find name 'simplify'.

2 export { transformStream, filter, getElementById, getElementsByClassName, parse, s
implify, simplifyLostLess, stringify, toContentString };
                                                                                   ~
~~~~~~~

node_modules/txml/dist/index.d.ts:2:92 - error TS2304: Cannot find name 'simplifyLos
tLess'.

2 export { transformStream, filter, getElementById, getElementsByClassName, parse, s
implify, simplifyLostLess, stringify, toContentString };
  
         ~~~~~~~~~~~~~~~~

node_modules/txml/dist/index.d.ts:2:110 - error TS2304: Cannot find name 'stringify'
.

2 export { transformStream, filter, getElementById, getElementsByClassName, parse, s
implify, simplifyLostLess, stringify, toContentString };
  
                           ~~~~~~~~~

node_modules/txml/dist/index.d.ts:2:121 - error TS2304: Cannot find name 'toContentS
tring'.

2 export { transformStream, filter, getElementById, getElementsByClassName, parse, s
implify, simplifyLostLess, stringify, toContentString };
  

Have a lot of errors and it's annoying.

There aren’t any releases here，Can you release a version

I'm a bit confused about how to use the utility methods and I'm getting inconsistent outputs.

With the following HTML string

<head>
    <style>
        p { color: "red" }
    </style>
</head>

<body>
    <p>hello</p>
</body>

I get different results depending on how I use filter.

Following the README and the typescript types this example seems to be the correct one:

    xml(x).filter(element => {
      return element.tagName.toLowerCase() == 'style';
    })

However, it returns an empty array.

After digging into the unit tests, it appears that using filter as an option renders the desire output.

   xml(x, {
      filter: function (element: txml.INode) {
        return element.tagName.toLowerCase() == 'style';
      }
    } as any)

But this feels weird because it's not documented (I don't know if it will break in certain circumstances) and the typescript types don't reflect it

  let str = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"><w:body><w:p><w:r><w:t>aaaaa</w:t></w:r><w:r><w:rPr><w:sz w:val="48"></w:sz></w:rPr><w:t>       </w:t></w:r><w:r><w:t>bbbbbb</w:t></w:r></w:p><w:sectPr><w:pgSz w:w="793.7008056640625" w:h="1122.5196533203125" w:orient="portrait"></w:pgSz><w:pgMar w:top="95.99999237060547" w:right="119.81102752685547" w:bottom="95.99999237060547" w:left="119.81102752685547" w:header="47.24409484863281" w:footer="47.24409484863281" w:gutter="0"></w:pgMar></w:sectPr></w:body></w:document>';
  const resut = txml.parse(str);

Note the <w:t> </w:t> part.
Checking the result object, that 'w:t' item has an empty 'children' array: children: [].

After reading source code, it seems that parseChildren function has the following lines:

var text = parseText()
if (text.trim().length > 0)
    children.push(text);
pos++;

text.trim()causes the issue. Is there any particular purpose 'trim()' is needed here? Or am I missing something in the process?

Thanks!