npm package: @kie-tools/scesim-marshaller
Description: <!--    Licensed to the Apache Software Foundation (ASF) under one    or more contributor license agreements.  See the NOTICE file    distributed with this work for additional information    regarding copyright ownership.  The ASF licenses this file    to
Latest version: 10.1.0

<!--
   Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at
     http://www.apache.org/licenses/LICENSE-2.0
   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.
-->

## Test Scenario Marshaller

This module contains all the resources required to perform the marshalling and
unmarshalling operations agains a Test Scenario file (.scesim)

It supports scesim files with 1.8 version only.

# Project Structure

Below, a brief description of the project's structure:

| Directory                | Description                                                                                                                                                                                                                                      |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `src`                    | Source root code. It cointans the index.ts file which offers the Marshalling/Unmarshalling API                                                                                                                                                   |
| `src/schemas/scesim-1_8` | It contains the Test Scenario 1.8 XSD Schema. After a build, this directory will contain the autogenerated code which cointans TypeScript types and metadata from XSD file(s) to be consumed (please refer to `@kie-tools/xml-parser-ts` module) |
| `test`                   | It contains integration tests to run against a set of scesim files                                                                                                                                                                               |
| `test-data--manual`      | The scesim files used for the integration tests.                                                                                                                                                                                                 |

## How to build it

Like most of the projects of this repository, pnpm and NodeJS are mandatory to build the project. Please refer to the
repository main README file to know more about the requested versions and installation steps.

## How to test it

To run the tests, run this command in your terminal:

`KIE_TOOLS_BUILD__runEndToEndTests=true pnpm -F @kie-tools/scesim-marshaller test`

---

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

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