@opengeoweb/sigmet-airmet 4.22.1 → 5.0.1

package/README.md

@@ -115,22 +115,28 @@ These are the default configuration files for both products. They are being used
 
 Schema files define all required properties and types for the configuration files. Sigmet and airmet share some properties, these can be found in `firArea.schema.json`.
 
-- firArea.schema: `libs/sigmet-airmet/src/lib/utils/config/firArea.schema.json`
+- firArea.schema: `tools/build-static-schemas/firArea.schema.json`
   Defines the shared properties and validations of sigmet and airmet.
-- airmet.schema: `libs/sigmet-airmet/src/lib/utils/config/airmet.schema.json`
+- airmet.schema: `tools/build-static-schemas/airmet.schema.json`
   Defines the airmet config validations. Airmet uses the firArea scheme and adds unique properties via the $merge prop: ```"$merge": {
   "source": { "$ref": "firArea.schema.json" } ```
-- sigmet.schema: `libs/sigmet-airmet/src/lib/utils/config/sigmet.schema.json`
+- sigmet.schema: `tools/build-static-schemas/sigmet.schema.json`
   Defines the sigmet config validations. Sigmet uses the firArea scheme and adds unique properties via the $merge prop: ```"$merge": {
   "source": { "$ref": "firArea.schema.json" } ```
 
+These schema files are build using the schema building tool in tools/build-static-schemas/generateStaticSchemas.js, see tools/build-static-schemas/Readme.md
+
 #### Configuration typescript types
 
 The `SigmetConfig` and `AirmetConfig` types can be found in `libs/sigmet-airmet/src/lib/types.ts` and are leading in defining the configuration files.
 
 #### Add a new configuration key
 
-Follow these steps to add a new key to the configuration file. Make sure to run storybook by `nx storybook sigmet-airmet` to test the validations. In this example, we're going to add a new property called `my_new_config`: an array with strings that is used by sigmet and airmet.
+Follow these steps to add a new key to the configuration file. Make sure to run storybook by `nx storybook sigmet-airmet` to test the validations.
+
+**Note: Before being able to see your changes to the validation in storybook, ensure you compile the validation schemas as described in tools/build-static-schemas/Readme.md**
+
+In this example, we're going to add a new property called `my_new_config`: an array with strings that is used by sigmet and airmet.
 
 1. Since the new prop is used by both sigmet and airmet, we want to add it to the `FIRArea` typescript type. Inside `libs/sigmet-airmet/src/lib/types.ts` add the following:
 
@@ -144,7 +150,7 @@ export type FIRArea = {
 
 If you now run `nx typecheck sigmet-airmet` it will fail, and that's expected as we added a new required prop but we have not added it to our configs. We will fix this later
 
-2. Add the new validation to the schema. This validation should check for an empty array and if the array is filled with a string. Inside `libs/sigmet-airmet/src/lib/utils/config/firArea.schema.json` under `properties` register the new prop `my_new_config` property.
+2. Add the new validation to the schema. This validation should check for an empty array and if the array is filled with a string. Inside `tools/build-static-schemas/firArea.schema.json` under `properties` register the new prop `my_new_config` property.
 
 ```
 "my_new_config": {
@@ -166,7 +172,7 @@ If you now run `nx typecheck sigmet-airmet` it will fail, and that's expected as
   ],
 ```
 
-2.2 Time to test out the validations. First airmet, go to http://localhost:4400/?path=/story/demo-airmet--airmet-dialog-demo. We expect there to be an error since you added a new required property but the story is still working. The same goes for sigmet http://localhost:4400/?path=/story/demo-sigmet--sigmet-dialog-demo. This is because we are merging the firArea scheme, but this overwrites the required list. To fix this, open `libs/sigmet-airmet/src/lib/utils/config/sigmet.schema.json` and add `my_new_config` to the required prop in the `fir_areas` key. Do the same in `libs/sigmet-airmet/src/lib/utils/config/airmet.schema.json` Afterwards an error should show for both.
+2.2 Time to test out the validations. First airmet, go to http://localhost:4400/?path=/story/demo-airmet--airmet-dialog-demo. We expect there to be an error since you added a new required property but the story is still working. The same goes for sigmet http://localhost:4400/?path=/story/demo-sigmet--sigmet-dialog-demo. This is because we are merging the firArea scheme, but this overwrites the required list. To fix this, open `tools/build-static-schemas/sigmet.schema.json` and add `my_new_config` to the required prop in the `fir_areas` key. Do the same in `tools/build-static-schemas/airmet.schema.json` Afterwards an error should show for both.
 
 ```
 "required": [