Google Git
Sign in
apache / incubator-kie-tools / 66a2c1ac65166936f8c12979b8a8035829a0196c / . / packages / xml-parser-ts
tree: 914bfaaa30b28beaa7c21019fdb40349e332fdbb [path history] [tgz]
  1. env/
  2. src/
  3. tests/
  4. jest.config.js
  5. LICENSE
  6. package.json
  7. README.md
  8. tsconfig.json
packages/xml-parser-ts/README.md

@kie-tools/xml-parser-ts

This lets you parse/build XML strings from/to JSON using types and metadata generated with @kie-tools/xml-parser-ts-codegen. It uses DOMParser or jsdom to parse the XMLs and guarantees that:

  1. Parse/builds are idempotent for XMLs created with
  2. The JSON resulting from parsing is type-safe, as the metada generated by @kie-tools/xml-parser-ts-codegen provides information on what is a string, a boolean, an integer, a float or an array. Even if there's only one element on a sequence, @kie-tools/xml-parser-ts will make sure it is an array with length 1.
  3. The types generated by @kie-tools/xml-parser-ts-codegen can be extended and parsed/built.
  4. Unknown elements/attributes are kept in the original JSON.
  5. Comments ignored.

Some characteristics:

  1. Namespaces declared on the original XML can be preserved when building from the JSON.

Apache KIE (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Some of the incubating project’s releases may not be fully compliant with ASF policy. For example, releases may have incomplete or un-reviewed licensing conditions. What follows is a list of known issues the project is currently aware of (note that this list, by definition, is likely to be incomplete):

  • Hibernate, an LGPL project, is being used. Hibernate is in the process of relicensing to ASL v2

  • Some files, particularly test files, and those not supporting comments, may be missing the ASF Licensing Header

  • Hibernate, an LGPL project, is being used. Hibernate is in the process of relicensing to ASL v2

  • Some files, particularly test files, and those not supporting comments, may be missing the ASF Licensing Header

If you are planning to incorporate this work into your product/project, please be aware that you will need to conduct a thorough licensing review to determine the overall implications of including this work. For the current status of this project through the Apache Incubator visit: https://incubator.apache.org/projects/kie.html