@oslo-flanders/swagger-generator 1.1.1 → 1.2.0

package/lib/SwaggerGenerationService.d.ts

@@ -10,6 +10,7 @@ export declare class SwaggerGenerationService implements IService {
     private getProbleemdetailsLink;
     private getContact;
     private getLicense;
+    private schemaExists;
     init(): Promise<void>;
     run(): Promise<void>;
     createSwagger(schemas: any, links: any): Object;

package/lib/SwaggerGenerationService.js

@@ -89,6 +89,15 @@ let SwaggerGenerationService = class SwaggerGenerationService {
             url: this.configuration.licenseURL,
         };
     }
+    /* The schema already exists in the model. This would mean that there are identical labels, which isn't ideal
+    https://vlaamseoverheid.atlassian.net/browse/DATAST-2249?atlOrigin=eyJpIjoiMWYyZjVmOTFhMWExNDc4MmIwMGQxNjhkMjJmN2NhZGUiLCJwIjoiaiJ9
+    */
+    schemaExists(schema, label) {
+        if (schema[label]) {
+            this.logger.warn(`[SwaggerGenerationService]: Schema already exists for the label (${label}) and will be overwritten.`);
+        }
+        return !!schema[label];
+    }
     async init() {
         return this.store.addQuadsFromFile(this.configuration.input);
     }
@@ -252,7 +261,7 @@ let SwaggerGenerationService = class SwaggerGenerationService {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const schemas = {};
         /* Create schema for each enumeration */
-        for (const enumId of this.store.findSubjects(core_1.ns.oslo('assignedURI'), core_1.ns.skos('Concept'))) {
+        for (const enumId of this.store.getEnumerations()) {
             let label = (_a = (0, core_1.getApplicationProfileLabel)(enumId, this.store, this.configuration.language)) === null || _a === void 0 ? void 0 : _a.value;
             if (!label) {
                 this.logger.error(`Unknown enum label for ${enumId.value}`);
@@ -260,6 +269,7 @@ let SwaggerGenerationService = class SwaggerGenerationService {
             }
             /* Class labels should be always pascal cased */
             label = (0, core_1.toPascalCase)(label);
+            this.schemaExists(schemas, label);
             schemas[label] = {
                 title: label,
                 type: 'object',
@@ -277,7 +287,9 @@ let SwaggerGenerationService = class SwaggerGenerationService {
         for (const classId of [
             ...this.store.findSubjects(core_1.ns.rdf('type'), core_1.ns.owl('Class')),
             ...this.store.findSubjects(core_1.ns.rdf('type'), core_1.ns.rdfs('Datatype')),
-        ]) {
+        ]
+            // Extra filter to exclude all the enumerations since these are mentioned twice in the intermedairy format under enums and classes
+            .filter((val) => !(0, core_1.isEnumeration)(this.store, val))) {
             const assignedUri = this.store.getAssignedUri(classId);
             /* Primitive datatypes may not be generated */
             if (assignedUri && [...core_1.DataTypes.values()].includes(assignedUri.value))
@@ -412,6 +424,7 @@ let SwaggerGenerationService = class SwaggerGenerationService {
                     },
                 };
             }
+            this.schemaExists(schemas, label);
             /* Create components for each schema */
             schemas[label] = {
                 title: label,

package/lib/enums/Properties.js

@@ -30,6 +30,7 @@ const Properties = new Map([
     [core_1.ns.xsd('unsignedShort').value, { '@value': { type: 'number', format: 'int32', minimum: 0, maximum: 65535 }, '@type': { type: 'string', pattern: '^UnsignedShort$' } }],
     [core_1.ns.xsd('unsignedByte').value, { '@value': { type: 'number', format: 'int32', minimum: 0, maximum: 255 }, '@type': { type: 'string', pattern: '^UnsignedByte$' } }],
     [core_1.ns.xsd('decimal').value, { '@value': { type: 'string', pattern: '(+|-)?([0-9]+(.[0-9]*)?|.[0-9]+)' }, '@type': { type: 'string', pattern: '^Decimal$' } }],
+    [core_1.ns.xsd('language').value, { '@value': { type: 'string', pattern: '^[a-z]{2,3}(-[A-Z]{2})?' }, '@type': { type: 'string', pattern: '^Language$' } }],
 ]);
 /* eslint-enable max-len*/
 const mapProperties = (datatype, label, subclasses, abstract, excludeClasses) => {

package/lib/types/Swagger.d.ts

@@ -91,3 +91,6 @@ export interface SwaggerLink {
     parameters: Record<string, string>;
     description: string;
 }
+export interface Schema {
+    [key: string]: any;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oslo-flanders/swagger-generator",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Generate OpenAPI Swagger YAML documentation.",
   "author": "Digitaal Vlaanderen <https://data.vlaanderen.be/id/organisatie/OVO002949>",
   "homepage": "https://github.com/informatievlaanderen/OSLO-UML-Transformer/tree/main/packages/oslo-generator-swagger#readme",
@@ -40,7 +40,7 @@
     "@types/streamify-array": "^1.0.0"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^1.1.0",
+    "@oslo-flanders/core": "^1.2.0",
     "inversify": "^6.0.1",
     "n3": "^2.0.0",
     "rdf-data-factory": "^2.0.0",