@oslo-flanders/swagger-generator 1.1.1 → 1.3.0

package/README.md

@@ -37,6 +37,7 @@ The service is executed from the CLI and expects the following parameters:
 | `--licenseURL` | URL of the license of the API | No | |
 | `--excludeClasses` | Classes to exclude from the generated Swagger | No | Persoon Organisatie Test |
 | `--excludeProperties` | Properties to exclude from the generated Swagger | No | voornaam achternaam |
+| `--outputFormat` | Output format for the generated files. Can be specified multiple times to generate multiple formats at once. | No | `application/json` (default) or `application/yaml` |
 | `--silent` | Suppress log messages | No | `true` or `false` (default) |
 
 ## Usage
@@ -46,4 +47,6 @@ oslo-generator-swagger --input report.jsonld --output swagger.json --language nl
 oslo-generator-swagger --input report.jsonld --output swagger.json --language nl --versionSwagger 3.0.4 --versionAPI 1.0.0 --title "Mijn API" --description "Mijn API beschrijving." --contextURL http://example.com/context.jsonld --baseURL http://example.com --excludeClasses Persoon Organisatie
 oslo-generator-swagger --input report.jsonld --output swagger.json --language nl --versionSwagger 3.0.4 --versionAPI 1.0.0 --title "Mijn API" --description "Mijn API beschrijving." --contextURL http://example.com/context.jsonld --baseURL http://example.com --excludeClasses Persoon --excludeProperties Persoon.voornaam
 oslo-generator-swagger --input report.jsonld --output swagger.json --language nl --versionSwagger 3.0.4 --versionAPI 1.0.0 --title "Mijn API" --description "Mijn API beschrijving." --contextURL http://example.com/context.jsonld --baseURL http://example.com --excludeClasses GeregistreerdPersoon --excludeProperties Persoon.voornaam Persoon.achternaam
+oslo-generator-swagger --input report.jsonld --output swagger.yaml --language nl --versionSwagger 3.0.4 --versionAPI 1.0.0 --title "Mijn API" --description "Mijn API beschrijving." --contextURL http://example.com/context.jsonld --baseURL http://example.com --outputFormat application/yaml
+oslo-generator-swagger --input report.jsonld --output swagger --language nl --versionSwagger 3.0.4 --versionAPI 1.0.0 --title "Mijn API" --description "Mijn API beschrijving." --contextURL http://example.com/context.jsonld --baseURL http://example.com --outputFormat application/json application/yaml
 ```

package/lib/SwaggerGenerationService.d.ts

@@ -1,5 +1,5 @@
 import type { IService } from '@oslo-flanders/core';
-import { QuadStore, Logger } from '@oslo-flanders/core';
+import { QuadStore, Logger, OutputFormat } from '@oslo-flanders/core';
 import { SwaggerGenerationServiceConfiguration } from './config/SwaggerGenerationServiceConfiguration';
 export declare class SwaggerGenerationService implements IService {
     readonly logger: Logger;
@@ -10,10 +10,11 @@ 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;
     createSchemas(): Object;
     createLinks(): Object;
-    writeJSON(json: Object, outputPath: string): Promise<void>;
+    writeOutput(outputFormat: OutputFormat, obj: Object, outputPath: string): Promise<void>;
 }

package/lib/SwaggerGenerationService.js

@@ -39,9 +39,14 @@ exports.SwaggerGenerationService = void 0;
 const core_1 = require("@oslo-flanders/core");
 const path = __importStar(require("path"));
 const promises_1 = require("fs/promises");
+const yaml = __importStar(require("js-yaml"));
 const inversify_1 = require("inversify");
 const SwaggerGenerationServiceConfiguration_1 = require("./config/SwaggerGenerationServiceConfiguration");
 const Properties_1 = require("./enums/Properties");
+const FILE_EXTENSIONS = {
+    [core_1.OutputFormat.Json]: '.json',
+    [core_1.OutputFormat.Yaml]: '.yaml',
+};
 let SwaggerGenerationService = class SwaggerGenerationService {
     constructor(logger, config, store) {
         this.logger = logger;
@@ -89,18 +94,23 @@ 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);
     }
     async run() {
-        /* Create Swagger schemas */
+        var _a;
+        /* Create schemas and links once, then write for each output format */
         const schemas = this.createSchemas();
-        for (const label of Object.keys(schemas))
-            await this.writeJSON(schemas[label], `swagger/components/schemas/${label}.json`);
-        /* Create Swagger links */
         const links = this.createLinks();
-        for (const label of Object.keys(links))
-            await this.writeJSON(links[label], `swagger/components/links/${label}.json`);
         /* Create self-standing referenceable components */
         const components = {
             openapi: this.configuration.versionSwagger,
@@ -113,10 +123,17 @@ let SwaggerGenerationService = class SwaggerGenerationService {
             },
             components: { schemas, links },
         };
-        await this.writeJSON(components, `swagger/components.json`);
         /* Create Swagger endpoint paths as example */
         const swagger = this.createSwagger(schemas, links);
-        await this.writeJSON(swagger, 'swagger/example.json');
+        for (const format of this.configuration.outputFormat) {
+            const ext = (_a = FILE_EXTENSIONS[format]) !== null && _a !== void 0 ? _a : '.json';
+            for (const label of Object.keys(schemas))
+                await this.writeOutput(format, schemas[label], `swagger/components/schemas/${label}${ext}`);
+            for (const label of Object.keys(links))
+                await this.writeOutput(format, links[label], `swagger/components/links/${label}${ext}`);
+            await this.writeOutput(format, components, `swagger/components${ext}`);
+            await this.writeOutput(format, swagger, `swagger/example${ext}`);
+        }
     }
     createSwagger(schemas, links) {
         var _a, _b, _c;
@@ -252,7 +269,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 +277,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 +295,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 +432,7 @@ let SwaggerGenerationService = class SwaggerGenerationService {
                     },
                 };
             }
+            this.schemaExists(schemas, label);
             /* Create components for each schema */
             schemas[label] = {
                 title: label,
@@ -503,8 +524,11 @@ let SwaggerGenerationService = class SwaggerGenerationService {
         }
         return links;
     }
-    async writeJSON(json, outputPath) {
-        const data = JSON.stringify(json, null, 2);
+    async writeOutput(outputFormat, obj, outputPath) {
+        const isYaml = outputFormat === core_1.OutputFormat.Yaml;
+        const data = isYaml
+            ? yaml.dump(JSON.parse(JSON.stringify(obj)), { noRefs: true, lineWidth: -1 })
+            : JSON.stringify(obj, null, 2);
         const filePath = path.join(this.configuration.output, outputPath);
         (0, core_1.ensureOutputDirectory)(path.dirname(filePath));
         await (0, promises_1.writeFile)(filePath, data);

package/lib/SwaggerGenerationServiceRunner.js

@@ -46,6 +46,12 @@ class SwaggerGenerationServiceRunner extends core_1.AppRunner {
             describe: 'All logs are suppressed',
             default: false,
             boolean: true,
+        })
+            .option('outputFormat', {
+            describe: 'Output format for the generated files. Can be specified multiple times.',
+            type: 'string',
+            array: true,
+            default: [core_1.OutputFormat.Json],
         })
             .demandOption([
             'input',

package/lib/config/SwaggerGenerationServiceConfiguration.d.ts

@@ -1,4 +1,5 @@
 import type { IConfiguration, YargsParams } from '@oslo-flanders/core';
+import { OutputFormat } from '@oslo-flanders/core';
 export declare class SwaggerGenerationServiceConfiguration implements IConfiguration {
     /**
      * Local path or URL to (OSLO compliant) RDF file to generate JSON-LD context from
@@ -64,6 +65,10 @@ export declare class SwaggerGenerationServiceConfiguration implements IConfigura
      * An array of property names to be excluded from the generated output
      */
     private _excludeProperties;
+    /**
+     * Output formats
+     */
+    private _outputFormat;
     createFromCli(params: YargsParams): Promise<void>;
     get input(): string;
     get output(): string;
@@ -81,4 +86,5 @@ export declare class SwaggerGenerationServiceConfiguration implements IConfigura
     get licenseURL(): string | undefined;
     get excludeClasses(): string[];
     get excludeProperties(): string[];
+    get outputFormat(): OutputFormat[];
 }

package/lib/config/SwaggerGenerationServiceConfiguration.js

@@ -7,6 +7,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SwaggerGenerationServiceConfiguration = void 0;
+const core_1 = require("@oslo-flanders/core");
 const inversify_1 = require("inversify");
 let SwaggerGenerationServiceConfiguration = class SwaggerGenerationServiceConfiguration {
     async createFromCli(params) {
@@ -26,6 +27,7 @@ let SwaggerGenerationServiceConfiguration = class SwaggerGenerationServiceConfig
         this._licenseURL = params.licenseURL;
         this._excludeClasses = params.excludeClasses;
         this._excludeProperties = params.excludeProperties;
+        this._outputFormat = params.outputFormat;
     }
     get input() {
         if (!this._input) {
@@ -99,6 +101,9 @@ let SwaggerGenerationServiceConfiguration = class SwaggerGenerationServiceConfig
     get excludeProperties() {
         return this._excludeProperties || [];
     }
+    get outputFormat() {
+        return this._outputFormat || [core_1.OutputFormat.Json];
+    }
 };
 SwaggerGenerationServiceConfiguration = __decorate([
     (0, inversify_1.injectable)()

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.3.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",
@@ -37,11 +37,13 @@
   },
   "devDependencies": {
     "@rdfjs/types": "^2.0.0",
+    "@types/js-yaml": "^4.0.0",
     "@types/streamify-array": "^1.0.0"
   },
   "dependencies": {
-    "@oslo-flanders/core": "^1.1.0",
+    "@oslo-flanders/core": "^1.2.0",
     "inversify": "^6.0.1",
+    "js-yaml": "^4.1.0",
     "n3": "^2.0.0",
     "rdf-data-factory": "^2.0.0",
     "rdf-parse": "^5.0.0",