Sdtt 343 add an extra flag the ea converter that allows to export all…

… tags from the uml diagram instead of a controlled selection (#88)

* Temp commit

* temp commit

* Added support for `allTags` to export all possible Tagged Values from `EA`

* Merge main

* Cleanup

packages/oslo-converter-uml-ea/README.md

@@ -27,11 +27,13 @@ The service is executed from the CLI and expects the following parameters:
 | `--versionId` | Version identifier for the document | :heavy_check_mark: ||
 | `--outputFile` | The name of the RDF output file | No, but if omitted, output is written to process.stdout ||
 | `--outputFormat` | RDF content-type specifiying the output format | :heavy_check_mark: | `application/ld+json` |
+| `--allTags` | Add all tags from EA to the generated output | No, default `false` | `true` or `false` |
 | `--debug` | A flag to enable debug mode which is more resilient to errors | | `false` |
 
 ## Usage
 
 ```bash
 oslo-converter-ea --umlFile path/to/uml/diagram.eap --diagramName "diagramName" --versionId "test/1" --outputFile path/to/output.jsonld --outputFormat application/ld+json --publicationEnvironment https://data.vlaanderen.be
 oslo-converter-ea --umlFile https://github.com/path/to/uml/diagram.eap --diagramName "My UML diagram" --versionId "test/1" --outputFormat application/ld+json --publicationEnvironment https://data.vlaanderen.be
+oslo-converter-ea --umlFile https://github.com/path/to/uml/diagram.eap --diagramName "My UML diagram" --versionId "test/1" --outputFormat application/ld+json --publicationEnvironment https://data.vlaanderen.be --allTags true
 ```

packages/oslo-converter-uml-ea/lib/EaUmlConversionServiceRunner.ts

@@ -43,6 +43,11 @@ export class EaUmlConversionServiceRunner extends AppRunner<
         default: 'info',
         choices: LOG_LEVELS,
       })
+      .option('allTags', {
+        describe: 'Add all tags from EA to the generated output',
+        default: false,
+        boolean: true,
+      })
       .option('debug', {
         describe:
           'A flag to enable debug mode which is more resilient to errors',

packages/oslo-converter-uml-ea/lib/config/EaUmlConverterConfiguration.ts

@@ -37,13 +37,19 @@ export class EaUmlConverterConfiguration implements IConfiguration {
    */
   private _debug: boolean | undefined;
 
+  /**
+   * A boolean that decided whether or not all tags will be added to the generated output
+   */
+  private _allTags: boolean | undefined;
+
   public async createFromCli(params: YargsParams): Promise<void> {
     this._umlFile = <string>params.umlFile;
     this._diagramName = <string>params.diagramName;
     this._outputFile = <string>(params.outputFile || 'report.jsonld');
     this._versionId = <string>params.versionId;
     this._outputFormat = <string>params.outputFormat;
     this._publicationEnvironment = <string>params.publicationEnvironment;
+    this._allTags = <boolean>params.allTags;
     this._debug = <boolean>params.debug;
   }
 
@@ -57,7 +63,7 @@ export class EaUmlConverterConfiguration implements IConfiguration {
   public get diagramName(): string {
     if (!this._diagramName) {
       throw new Error(
-        `Trying to access property "diagramName" before it was set.`
+        `Trying to access property "diagramName" before it was set.`,
       );
     }
     return this._diagramName;
@@ -66,7 +72,7 @@ export class EaUmlConverterConfiguration implements IConfiguration {
   public get outputFile(): string {
     if (!this._outputFile) {
       throw new Error(
-        `Trying to access property "outputFile" before it was set.`
+        `Trying to access property "outputFile" before it was set.`,
       );
     }
     return this._outputFile;
@@ -75,7 +81,7 @@ export class EaUmlConverterConfiguration implements IConfiguration {
   public get versionId(): string {
     if (!this._versionId) {
       throw new Error(
-        `Trying to access property "versionId" before it was set.`
+        `Trying to access property "versionId" before it was set.`,
       );
     }
     return this._versionId;
@@ -84,7 +90,7 @@ export class EaUmlConverterConfiguration implements IConfiguration {
   public get outputFormat(): string {
     if (!this._outputFormat) {
       throw new Error(
-        `Trying to access property "outputFormat" before it was set.`
+        `Trying to access property "outputFormat" before it was set.`,
       );
     }
     return this._outputFormat;
@@ -93,12 +99,16 @@ export class EaUmlConverterConfiguration implements IConfiguration {
   public get publicationEnvironment(): string {
     if (!this._publicationEnvironment) {
       throw new Error(
-        `Trying to access property "publicationEnvironment" before it was set.`
+        `Trying to access property "publicationEnvironment" before it was set.`,
       );
     }
     return this._publicationEnvironment;
   }
 
+  public get allTags(): boolean {
+    return !!this._allTags;
+  }
+
   public get debug(): boolean {
     return !!this._debug;
   }

packages/oslo-converter-uml-ea/lib/converter-handlers/ElementConverterHandler.ts

@@ -15,6 +15,7 @@ import { TagNames } from '../enums/TagNames';
 import { ConverterHandler } from '../interfaces/ConverterHandler';
 import type { UriRegistry } from '../UriRegistry';
 import { getTagValue, ignore, toPascalCase } from '../utils/utils';
+import { Language } from '@oslo-flanders/core/lib/enums/Language';
 
 @injectable()
 export class ElementConverterHandler extends ConverterHandler<EaElement> {
@@ -179,6 +180,10 @@ export class ElementConverterHandler extends ConverterHandler<EaElement> {
     this.addLabels(object, objectInternalId, this.df.defaultGraph(), quads);
     this.addUsageNotes(object, objectInternalId, this.df.defaultGraph(), quads);
     this.addStatus(object, objectInternalId, this.df.defaultGraph(), quads);
+    // Add the remaining tags that are not in TagNames enum if the config requires so.
+    if (this.config.allTags) {
+      this.addOtherTags(object, objectInternalId, this.df.defaultGraph(), quads);
+    }
 
     // To be able to determine the scope of the element,
     // we need to compare it to the base URI of the package