Introduce a new generateAnchorTag method inside oslo-core

Informatievlaanderen · Nov 4, 2024 · df090b0 · df090b0
1 parent 43d0ce7
commit df090b0
Show file tree

Hide file tree

Showing 15 changed files with 720 additions and 573 deletions.
diff --git a/packages/oslo-converter-stakeholders/package.json b/packages/oslo-converter-stakeholders/package.json
@@ -29,7 +29,7 @@
     "url": "https://github.com/Informatievlaanderen/OSLO-UML-Transformer/issues"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^0.0.16-alpha.0",
+    "@oslo-flanders/core": "^0.0.17-alpha.0",
     "csv-parse": "^5.3.6",
     "inversify": "^6.0.1",
     "reflect-metadata": "^0.1.13",

diff --git a/packages/oslo-converter-uml-ea/package.json b/packages/oslo-converter-uml-ea/package.json
@@ -41,7 +41,7 @@
     "jest-runner-groups": "^2.2.0"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^0.0.16-alpha.0",
+    "@oslo-flanders/core": "^0.0.17-alpha.0",
     "@oslo-flanders/ea-uml-extractor": "^0.0.27-alpha.0",
     "@oslo-flanders/output-handlers": "^0.0.4-alpha.0",
     "inversify": "^6.0.1",

diff --git a/packages/oslo-core/lib/utils/anchorTag.ts b/packages/oslo-core/lib/utils/anchorTag.ts
@@ -0,0 +1,8 @@
+export function generateAnchorTag(
+  entityLabel: string,
+  propLabel?: string,
+): string {
+  const label = propLabel ? `${entityLabel}:${propLabel}` : entityLabel;
+  const anchorHref = `${encodeURIComponent(label.replace(' ', ''))}`;
+  return anchorHref;
+}
diff --git a/packages/oslo-core/package.json b/packages/oslo-core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@oslo-flanders/core",
-  "version": "0.0.16-alpha.0",
+  "version": "0.0.17-alpha.0",
   "description": "Core interfaces and utilities",
   "author": "Digitaal Vlaanderen <https://data.vlaanderen.be/id/organisatie/OVO002949>",
   "homepage": "https://github.com/informatievlaanderen/OSLO-UML-Transformer/tree/main/packages/oslo-core#readme",

diff --git a/packages/oslo-extractor-uml-ea/package.json b/packages/oslo-extractor-uml-ea/package.json
@@ -31,7 +31,7 @@
     "url": "https://github.com/Informatievlaanderen/OSLO-UML-Transformer/issues"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^0.0.16-alpha.0",
+    "@oslo-flanders/core": "^0.0.17-alpha.0",
     "alasql": "4.5.2",
     "inversify": "^6.0.1",
     "mdb-reader": "github:Informatievlaanderen/mdb-reader",

diff --git a/packages/oslo-generator-examples/package.json b/packages/oslo-generator-examples/package.json
@@ -36,7 +36,7 @@
     "url": "https://github.com/Informatievlaanderen/OSLO-UML-Transformer/issues"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^0.0.16-alpha.0",
+    "@oslo-flanders/core": "^0.0.17-alpha.0",
     "inversify": "^6.0.1",
     "n3": "^1.17.2",
     "rdf-data-factory": "^1.1.2",

diff --git a/packages/oslo-generator-html/README.md b/packages/oslo-generator-html/README.md
@@ -32,6 +32,10 @@ The service is executed from the CLI and expects the following parameters:
 | `--templates` | path to local folder containing different templates that can be used for extending the root template | | |
 | `--rootTemplate` | Use a different template other than the default ones (ap2.j2 and voc2.j2) | No | |
 
+## Sidenote
+
+For the application profile from OSLO we use a function to generate our anchor tags. The anchor tags are formed based on the available label of each entity and/or the available label of the property. If the label is not available, we use the URI of the entity or property. The final result gets encoded using the [`encodeURIComponent`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) function. The function can be found [here](../oslo-core/lib/utils/anchorTag.ts).
+
 ## Usage
 
 ```bash

diff --git a/packages/oslo-generator-html/lib/HtmlGenerationService.ts b/packages/oslo-generator-html/lib/HtmlGenerationService.ts
@@ -6,6 +6,7 @@ import { inject, injectable } from 'inversify';
 import * as nj from 'nunjucks';
 import { HtmlGenerationServiceConfiguration } from './config/HtmlGenerationServiceConfiguration';
 import { SpecificationType } from './utils/specificationTypeEnum';
+import { generateAnchorTag } from '@oslo-flanders/core/lib/utils/anchorTag';
 
 @injectable()
 export class HtmlGenerationService implements IService {
@@ -39,7 +40,7 @@ export class HtmlGenerationService implements IService {
 
     const env = nj.configure(this.dirs);
     env.addFilter('replaceBaseURI', this.replaceBaseURI);
-    env.addGlobal('getAnchorTag', this.getAnchorTag);
+    env.addFilter('generateAnchorTag', generateAnchorTag);
   }
 
   public async run(): Promise<void> {
@@ -105,14 +106,6 @@ export class HtmlGenerationService implements IService {
     await writeFile(this.configuration.output, html);
   }
 
-  private getAnchorTag = (id: string, type: string) => {
-    let domain: string = '';
-    if (id && id?.includes('#')) {
-      domain = `${id?.split('#').pop()}`;
-    }
-    return domain;
-  };
-
   private replaceBaseURI = (input: string, baseURI: string): string => {
     return input.replace(new RegExp(baseURI, 'g'), '');
   };

diff --git a/packages/oslo-generator-html/lib/templates/ap2.j2 b/packages/oslo-generator-html/lib/templates/ap2.j2
diff --git a/packages/oslo-generator-html/package.json b/packages/oslo-generator-html/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@oslo-flanders/html-generator",
-  "version": "0.0.23-alpha.0",
+  "version": "0.0.24-alpha.0",
   "description": "Generates an HTML file using an OSLO webuniversum config",
   "author": "Digitaal Vlaanderen <https://data.vlaanderen.be/id/organisatie/OVO002949>",
   "homepage": "https://github.com/informatievlaanderen/OSLO-UML-Transformer/tree/main/packages/oslo-generator-html#readme",
@@ -35,7 +35,7 @@
     "url": "https://github.com/Informatievlaanderen/OSLO-UML-Transformer/issues"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^0.0.16-alpha.0",
+    "@oslo-flanders/core": "^0.0.17-alpha.0",
     "inversify": "^6.0.1",
     "n3": "^1.16.4",
     "nunjucks": "^3.2.4",

diff --git a/packages/oslo-generator-json-webuniversum/package.json b/packages/oslo-generator-json-webuniversum/package.json
@@ -30,7 +30,7 @@
     "url": "https://github.com/Informatievlaanderen/OSLO-UML-Transformer/issues"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^0.0.16-alpha.0",
+    "@oslo-flanders/core": "^0.0.17-alpha.0",
     "inversify": "^6.0.1",
     "n3": "^1.17.2",
     "rdf-data-factory": "^1.1.2",

diff --git a/packages/oslo-generator-jsonld-context/package.json b/packages/oslo-generator-jsonld-context/package.json
@@ -39,7 +39,7 @@
     "@rdfjs/types": "^1.1.0"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^0.0.16-alpha.0",
+    "@oslo-flanders/core": "^0.0.17-alpha.0",
     "inversify": "^6.0.1",
     "n3": "^1.16.2",
     "rdf-data-factory": "^1.1.2",

diff --git a/packages/oslo-generator-rdf-vocabulary/package.json b/packages/oslo-generator-rdf-vocabulary/package.json
@@ -40,7 +40,7 @@
     "@types/streamify-array": "^1.0.0"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^0.0.16-alpha.0",
+    "@oslo-flanders/core": "^0.0.17-alpha.0",
     "inversify": "^6.0.1",
     "n3": "^1.16.2",
     "rdf-data-factory": "^1.1.1",

diff --git a/packages/oslo-generator-respec-html/package.json b/packages/oslo-generator-respec-html/package.json
@@ -34,7 +34,7 @@
     "url": "https://github.com/Informatievlaanderen/OSLO-UML-Transformer/issues"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^0.0.16-alpha.0",
+    "@oslo-flanders/core": "^0.0.17-alpha.0",
     "@oslo-flanders/html-respec-generator": "^0.0.11-alpha.0",
     "@oslo-flanders/stakeholders-converter": "^0.0.12-alpha.0",
     "inversify": "^6.0.1",

diff --git a/packages/oslo-generator-shacl-template/package.json b/packages/oslo-generator-shacl-template/package.json
@@ -37,7 +37,7 @@
     "url": "https://github.com/Informatievlaanderen/OSLO-UML-Transformer/issues"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^0.0.16-alpha.0",
+    "@oslo-flanders/core": "^0.0.17-alpha.0",
     "i18n": "^0.15.1",
     "inversify": "^6.0.1",
     "n3": "^1.17.2",