fix(nestjs-redox): RedocOptions.logo and RedocOptions.tagGroups not w…

…orking
julianpoemp · Jun 23, 2024 · 9d8b1e0 · 9d8b1e0
1 parent e01e6ff
commit 9d8b1e0
Show file tree

Hide file tree

Showing 4 changed files with 967 additions and 349 deletions.
diff --git a/apps/demo-express/src/main.ts b/apps/demo-express/src/main.ts
@@ -33,12 +33,15 @@ async function bootstrap() {
 
   const redocOptions: RedocOptions = {
     requiredPropsFirst: true,
+    logo: {
+      url: "https://redocly.github.io/redoc/petstore-logo.png"
+    },
     theme: {
       sidebar: {
         width: '222px',
       },
     },
-  };
+  }
 
   const redoxOptions: NestJSRedoxOptions = {
     useGlobalPrefix: true,

diff --git a/libs/nestjs-redox/src/lib/nestjs-redox.module.ts b/libs/nestjs-redox/src/lib/nestjs-redox.module.ts
@@ -156,16 +156,17 @@ export class NestjsRedoxModule {
     }
   ) {
     let document: OpenAPIObject;
-    const documentURL = typeof documentOrURL === 'string' ? documentOrURL : undefined;
+    const documentURL =
+      typeof documentOrURL === 'string' ? documentOrURL : undefined;
 
     const lazyBuildDocument = () => {
       if (typeof documentOrURL === 'string') {
         throw new Error('documentFactory is a string.');
       }
 
       return typeof documentOrURL === 'function'
-        ? documentOrURL()
-        : documentOrURL;
+        ? this.applyRedocExtensions(options.redocOptions, documentOrURL())
+        : this.applyRedocExtensions(options.redocOptions, documentOrURL);
     };
 
     const baseUrlForRedocUI = normalizeRelPath(`./${urlLastSubdirectory}/`);
@@ -293,4 +294,28 @@ export class NestjsRedoxModule {
       res.header(header.name, header.value);
     }
   }
+
+  private static applyRedocExtensions(
+    redocOptions: RedocOptions | undefined,
+    swaggerSpec: OpenAPIObject
+  ) {
+    if (redocOptions?.logo) {
+      const logo = swaggerSpec.info['x-logo'] ?? {};
+      swaggerSpec.info['x-logo'] = {
+        ...logo,
+        url: logo['url'] ?? redocOptions.logo.url,
+        href: logo['href'] ?? redocOptions.logo.href,
+        backgroundColor:
+          logo['backgroundColor'] ?? redocOptions.logo.backgroundColor,
+        altText: logo['altText'] ?? redocOptions.logo.altText,
+      };
+    }
+
+    if (redocOptions?.tagGroups) {
+      swaggerSpec.info['x-tagGroups'] =
+        swaggerSpec.info['x-tagGroups'] ?? redocOptions.tagGroups;
+    }
+
+    return swaggerSpec;
+  }
 }