AML versioning: major.minor.build

Artifacts

Module	Artifacts
amf-custom-validation	5.0.168
amf-aml	5.0.168
amf-validation	5.0.168

Adoption guide

For more details on this release please read the Release details section

This is a breaking change for the amf-validation module since it does no longer include custom validations and does not longer depend on the amf-aml module.

For amf-aml adopters:

[email protected] now includes validation so it is no longer necessary to manually import amf-validation (it should be automatically imported just by adding the amf-aml dependency)

For amf-validation adopters:

If you are interested in AML only you can import [email protected] which now includes validation
If you are interested in AML with custom validations you can import [email protected]

For amf-client adopters:

If you manually register the AMFValidatorPlugin, to use the validator:
- with custom validations: register amf.plugins.features.validation.custom.AMFValidatorPlugin instead
- without custom validations: register amf.plugins.features.validation.AMFValidatorPlugin (same as before)
If you manually register the AMFValidation feature, to register the validation features:
- with custom validations: register amf.client.PluginsWrapper.features.AMFCustomValidation instead
- without custom validations: register amf.client.PluginsWrapper.features.AMFValidation (same as before)
If you use the default AMF initializer amf.client.AMF.init(): no action required, validation is registered by default with custom validation capabilities

Note: The custom validation feature amf.client.PluginsWrapper.features.AMFCustomValidation and the custom validation plugin amf.plugins.features.validation.custom.AMFValidatorPlugin include all the features of the regular validation feature/plugin plus custom validations.

Release details

AML is now standalone and supports out-of-the-box validation. This is supported by a remodularzation of the validation modules in the AMF ecosystem.

Remodularization of validation modules

New modules in the AML project

After the remodularization the amf-aml project (amf-aml github repository) now includes two new modules:

amf-custom-validation
amf-validation

These modules were previously part of the amf-validation module in the amf project (amf github repository)

Remodularization architecture

Previous to the remodularization the amf project contained the amf-validation module which internally contained two parts: the validation core and custom validations. This can be observed in the "Pre 5.0.x" column in Table 1.

To support AML out-of-the-box validation and avoid circular dependencies, the custom validations part of the amf-validation module was extracted to a new module called amf-custom-validation and dependencies were reorganized as observed in the "5.0.x" column in Table 1.