@oslo-flanders/swagger-generator 3.0.0 → 3.0.1

package/lib/SwaggerGenerationService.d.ts

@@ -17,4 +17,12 @@ export declare class SwaggerGenerationService implements IService {
     createSchemas(): Object;
     createLinks(): Object;
     writeOutput(outputFormat: OutputFormat, obj: Object, outputPath: string): Promise<void>;
+    /**
+     * Create a self-contained copy of the components object where all `$ref`
+     * pointers to `#/components/schemas/<name>` are replaced by the actual
+     * schema definition inline. Resolves recursively so that nested `$ref`
+     * references are also inlined. Circular references are preserved as `$ref`
+     * to avoid infinite recursion.
+     */
+    private resolveRefs;
 }

package/lib/SwaggerGenerationService.js

@@ -128,6 +128,8 @@ let SwaggerGenerationService = class SwaggerGenerationService {
                 ...(Object.keys(links).length > 0 ? { links } : {}),
             },
         };
+        /* Create embedded (self-contained) variant with all $ref resolved inline */
+        const embeddedComponents = this.resolveRefs(components, schemas);
         /* Create Swagger endpoint paths as example */
         const swagger = this.createSwagger(schemas, links);
         /* Only append the language suffix when the generated language differs from the primary language */
@@ -141,6 +143,7 @@ let SwaggerGenerationService = class SwaggerGenerationService {
             for (const label of Object.keys(links))
                 await this.writeOutput(format, links[label], `swagger/components/links/${label}${languageSuffix}${ext}`);
             await this.writeOutput(format, components, `swagger/components${languageSuffix}${ext}`);
+            await this.writeOutput(format, embeddedComponents, `swagger/_embedded${languageSuffix}${ext}`);
             await this.writeOutput(format, swagger, `swagger/example${languageSuffix}${ext}`);
         }
     }
@@ -596,6 +599,71 @@ let SwaggerGenerationService = class SwaggerGenerationService {
         (0, core_1.ensureOutputDirectory)(path.dirname(filePath));
         await (0, promises_1.writeFile)(filePath, data);
     }
+    /**
+     * Create a self-contained copy of the components object where all `$ref`
+     * pointers to `#/components/schemas/<name>` are replaced by the actual
+     * schema definition inline. Resolves recursively so that nested `$ref`
+     * references are also inlined. Circular references are preserved as `$ref`
+     * to avoid infinite recursion.
+     */
+    resolveRefs(components, schemas) {
+        const embedded = JSON.parse(JSON.stringify(components));
+        const resolving = new Set();
+        function walk(obj) {
+            if (!obj || typeof obj !== 'object') {
+                return;
+            }
+            if (Array.isArray(obj)) {
+                for (let i = 0; i < obj.length; i++) {
+                    if (obj[i] !== null && typeof obj[i] === 'object' && obj[i].$ref) {
+                        const match = obj[i].$ref.match(/^#\/components\/schemas\/(.+)$/);
+                        if (match && schemas[match[1]]) {
+                            if (resolving.has(match[1])) {
+                                // Circular reference – keep the $ref as-is
+                                continue;
+                            }
+                            resolving.add(match[1]);
+                            obj[i] = JSON.parse(JSON.stringify(schemas[match[1]]));
+                            walk(obj[i]);
+                            resolving.delete(match[1]);
+                        }
+                    }
+                    else {
+                        walk(obj[i]);
+                    }
+                }
+            }
+            else {
+                for (const key of Object.keys(obj)) {
+                    if (key === '$ref' &&
+                        typeof obj[key] === 'string' &&
+                        obj.$ref.startsWith('#/components/schemas/')) {
+                        continue;
+                    }
+                    if (obj[key] !== null &&
+                        typeof obj[key] === 'object' &&
+                        obj[key].$ref) {
+                        const match = obj[key].$ref.match(/^#\/components\/schemas\/(.+)$/);
+                        if (match && schemas[match[1]]) {
+                            if (resolving.has(match[1])) {
+                                // Circular reference – keep the $ref as-is
+                                continue;
+                            }
+                            resolving.add(match[1]);
+                            obj[key] = JSON.parse(JSON.stringify(schemas[match[1]]));
+                            walk(obj[key]);
+                            resolving.delete(match[1]);
+                        }
+                    }
+                    else {
+                        walk(obj[key]);
+                    }
+                }
+            }
+        }
+        walk(embedded);
+        return embedded;
+    }
 };
 SwaggerGenerationService = __decorate([
     (0, inversify_1.injectable)(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oslo-flanders/swagger-generator",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "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",