@andrewronscki/nestjs-redoc 2.0.3

package/.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,json,lock}]
+indent_size = 2

package/.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin', 'prettier'],
+  extends: [
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+    'prettier/@typescript-eslint',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    'prettier/prettier': 'error',
+  },
+};

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 André Wronscki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,199 @@
+## NestJS ReDoc (Swagger UI Alternative) - André Wronscki Version
+
+## Introduction
+
+I have tried most of the Redoc integrate NestJS solutions available on the market, but due to a lack of maintenance over a long period, many outdated packages were being used, leading to installation failures. This version has been modified and improved, allowing for perfect integration with NestJS 11.0.11
+
+-André Wronscki
+
+## Features
+
+- Customizable theme
+- It's almost a drop in replacement for you current swagger UI, you only need to import this package and modify any settings you may want to change (e.g: Page title, ReDoc options)
+
+NB: Please read the [ReDoc](https://redocly.com/docs/redoc/) Documentation firstly.
+
+## 🗿 Installation
+
+Using npm: `npm install @andrewronscki/nestjs-redoc`
+
+## How to use
+
+You need to install the [Swagger Module](https://github.com/nestjs/swagger) first if you want to get definitions updated with your project.
+
+In future versions you will be able to pass a URL parameter as document, but for the moment you need this document object from the swagger module
+
+```typescript
+const options = new DocumentBuilder()
+  .setTitle('Look, i have a title')
+  .setDescription('A very nice description')
+  .setBasePath('/api/v1')
+  .build();
+const document = SwaggerModule.createDocument(app, options);
+```
+
+Then add the following example code.
+
+**Note**: All properties are optional, if you don't specify a title we will fallback to the one you used in your DocumentBuilder instance.
+
+```typescript
+const redocOptions: RedocOptions = {
+  title: 'Hello Nest',
+  logo: {
+    url: 'https://redocly.github.io/redoc/petstore-logo.png',
+    backgroundColor: '#F0F0F0',
+    altText: 'PetStore logo',
+  },
+  sortPropsAlphabetically: true,
+  hideDownloadButton: false,
+  hideHostname: false,
+  auth: {
+    enabled: true,
+    user: 'admin',
+    password: '123',
+  },
+  tagGroups: [
+    {
+      name: 'Core resources',
+      tags: ['cats'],
+    },
+  ],
+};
+// Instead of using SwaggerModule.setup() you call this module
+await RedocModule.setup('/docs', app, document, redocOptions);
+```
+
+### You can build a function for the setup
+
+Create a file "setup.redoc.ts"
+
+```typescript
+import type { INestApplication } from '@nestjs/common';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { RedocModule, RedocOptions } from '@andrewronscki/nestjs-redoc';
+import * as process from 'process';
+
+export async function setupRedoc(app: INestApplication) {
+  const documentBuilder = new DocumentBuilder()
+    .setTitle(`${process.env.DOCS_TITLE}`)
+    .setVersion('1.0')
+    .setDescription('Powered by andrewronscki')
+    .addBearerAuth(
+      {
+        description: `Please enter token in following format: Bearer <JWT>`,
+        name: 'Authorization',
+        bearerFormat: 'Bearer',
+        scheme: 'Bearer',
+        type: 'http',
+        in: 'Header',
+      },
+      'access-token',
+    );
+
+  if (process.env.API_VERSION) {
+    documentBuilder.setVersion(process.env.API_VERSION);
+  }
+
+  const document = SwaggerModule.createDocument(app, documentBuilder.build());
+  const redocOptions: RedocOptions = {
+    title: `${process.env.DOCS_TITLE}`,
+    logo: {
+      url: `${process.env.DOCS_LOGO}`,
+      backgroundColor: '#d0e8c5',
+      altText: 'LOGO',
+    },
+    theme: {
+      typography: {
+        fontSize: '16px',
+        fontWeightBold: '900',
+      },
+      sidebar: {
+        backgroundColor: '#d0e8c5',
+      },
+      rightPanel: {
+        backgroundColor: '#01312b',
+      },
+    },
+    sortPropsAlphabetically: true,
+    sortOperationsAlphabetically: true,
+    hideDownloadButton: false,
+    hideHostname: false,
+    noAutoAuth: true,
+    pathInMiddlePanel: true,
+    auth: {
+      enabled: true,
+      user: 'admin',
+      password: `${process.env.DOCS_PASSWORD}`,
+    },
+    tagGroups: [
+      {
+        name: 'Core resources',
+        tags: ['authentication', 'user'],
+      },
+    ],
+  };
+  await RedocModule.setup('docs', app, document, redocOptions);
+  console.info(
+    `Redoc Documentation: http://localhost:${process.env.PORT}/docs`,
+  );
+}
+```
+
+In your main.ts, add this line before "await app.listen(3000);"
+
+```
+await setupRedoc(app);
+```
+
+## Available options
+
+### Redoc Options
+
+| Option                       | Description                                                                                                                                           | Type              | Note                                       |
+| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------ |
+| title                        | Web site title (e.g: ReDoc documentation)                                                                                                             | string            |
+| favicon                      | Web site favicon URL                                                                                                                                  | string            | Fallbacks to the document title if not set |
+| logo                         | Logo options                                                                                                                                          | LogoOptions       | See LogoOptions table                      |
+| theme                        | Theme options                                                                                                                                         | ThemeOptions      | See ThemeOptions info                      |
+| untrustedSpec                | If set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS, by default is false                                       | boolean           |
+| supressWarnings              | If set, warnings are not rendered at the top of documentation (they are still logged to the console)                                                  | boolean           |
+| hideHostname                 | If set, the protocol and hostname won't be shown in the operation definition                                                                          | boolean           |
+| expandResponses              | Specify which responses to expand by default by response codes, values should be passed as comma-separated list without spaces (e.g: 200, 201, "all") | string            |
+| requiredPropsFirst           | If set, show required properties first ordered in the same order as in required array                                                                 | boolean           |
+| sortPropsAlphabetically      | If set, propeties will be sorted alphabetically                                                                                                       | boolean           |
+| sortOperationsAlphabetically | If set, operations will be sorted alphabetically                                                                                                      | boolean           |
+| showExtensions               | If set the fields starting with "x-" will be shown, can be a boolean or a string with names of extensions to display                                  | boolean           |
+| noAutoAuth                   | If set, redoc won't inject authentication section automatically                                                                                       | boolean           |
+| pathInMiddlePanel            | If set, path link and HTTP verb will be shown in the middle panel instead of the right one                                                            | boolean           |
+| hideLoading                  | If set, loading spinner animation won't be shown                                                                                                      | boolean           |
+| nativeScrollbars             | If set, a native scrollbar will be used instead of perfect-scroll, this can improve performance of the frontend for big specs                         | boolean           |
+| hideDownloadButton           | This will hide the "Download spec" button, it only hides the button                                                                                   | boolean           |
+| disableSearch                | If set, the search bar will be disabled                                                                                                               | boolean           |
+| onlyRequiredInSamples        | Shows only required fileds in request samples                                                                                                         | boolean           |
+| auth                         | Auth options                                                                                                                                          | AuthOptions       | See AuthOptions info                       |
+| AuthOptions info             |
+| enabled                      | If enabled, a prompt will pop out asking for authentication details, default: `false`                                                                 | boolean           |
+| user                         | User name, default: `admin`                                                                                                                           | string            |
+| password                     | User password, default: `123`                                                                                                                         | string            |
+| tagGroups                    | Tag groups options                                                                                                                                    | TagGroupOptions[] | See Tag Group options                      |
+| Tag Group options info       |
+| name                         | Tag name                                                                                                                                              | string            |
+| tags                         | Tag collection                                                                                                                                        | string[]          |
+| redocVersion                 | Set an specific redoc version                                                                                                                         | string,number     | By default it's "latest"                   |
+
+**Note**: If you want to change your ReDoc theme settings, take a look at the official ReDoc documentation: <https://github.com/Redocly/redoc/blob/master/src/theme.ts>
+
+Apply the properties defined in ResolvedThemeInterface to the key called "theme" in the redoc options
+
+### Logo options
+
+| Option          | Description                                                                           | Type   | Example  |
+| --------------- | ------------------------------------------------------------------------------------- | ------ | -------- |
+| url             | The URL pointing to the spec Logo, must be in the format of a URL and an absolute URL | string |
+| backgroundColor | Background color to be used, must be RGB color in hexadecimal format (e.g: #008080)   | string | #F0F0F0  |
+| altText         | Alt tag for Logo                                                                      | string | PetStore |
+| href            | href tag for Logo, it defaults to the host used for your API spec                     | string |
+
+### Special Thanks
+
+Forked from https://github.com/jozefazz/nestjs-redoc

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './interfaces';
+export * from './redoc-module';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./interfaces"), exports);
+__exportStar(require("./redoc-module"), exports);

package/dist/interfaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from './redocDocument.interface';
+export * from './redocOptions.interface';

package/dist/interfaces/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./redocDocument.interface"), exports);
+__exportStar(require("./redocOptions.interface"), exports);

package/dist/interfaces/redocDocument.interface.d.ts

@@ -0,0 +1,8 @@
+import { OpenAPIObject } from '@nestjs/swagger';
+import { LogoOptions, TagGroupOptions } from './redocOptions.interface';
+export interface RedocDocument extends Partial<OpenAPIObject> {
+    info: OpenAPIObject['info'] & {
+        'x-logo'?: LogoOptions;
+    };
+    'x-tagGroups': TagGroupOptions[];
+}

package/dist/interfaces/redocDocument.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/redocOptions.interface.d.ts

@@ -0,0 +1,39 @@
+export interface RedocOptions {
+    redocVersion?: string;
+    title?: string;
+    favicon?: string;
+    logo?: LogoOptions;
+    theme?: any;
+    untrustedSpec?: boolean;
+    supressWarnings?: boolean;
+    hideHostname?: boolean;
+    expandResponses?: string;
+    requiredPropsFirst?: boolean;
+    sortPropsAlphabetically?: boolean;
+    sortOperationsAlphabetically?: boolean;
+    showExtensions?: boolean | string;
+    noAutoAuth?: boolean;
+    pathInMiddlePanel?: boolean;
+    hideLoading?: boolean;
+    nativeScrollbars?: boolean;
+    hideDownloadButton?: boolean;
+    disableSearch?: boolean;
+    onlyRequiredInSamples?: boolean;
+    docName?: string;
+    auth?: {
+        enabled: boolean;
+        user: string;
+        password: string;
+    };
+    tagGroups?: TagGroupOptions[];
+}
+export interface LogoOptions {
+    url?: string;
+    backgroundColor?: string;
+    altText?: string;
+    href?: string;
+}
+export interface TagGroupOptions {
+    name: string;
+    tags: string[];
+}

package/dist/interfaces/redocOptions.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/index.d.ts

@@ -0,0 +1 @@
+export * from './options.model';

package/dist/model/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./options.model"), exports);

package/dist/model/options.model.d.ts

@@ -0,0 +1,3 @@
+import Joi = require('joi');
+import { OpenAPIObject } from '@nestjs/swagger';
+export declare const schema: (document: OpenAPIObject) => Joi.ObjectSchema<any>;

package/dist/model/options.model.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = void 0;
+const Joi = require("joi");
+const schema = (document) => Joi.object().keys({
+    redocVersion: Joi.string().default('latest'),
+    title: Joi.string()
+        .optional()
+        .default(document.info ? document.info.title : 'Swagger documentation'),
+    favicon: Joi.string().optional(),
+    logo: {
+        url: Joi.string().optional().uri(),
+        backgroundColor: Joi.string()
+            .optional()
+            .regex(new RegExp('^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$')),
+        altText: Joi.string().optional(),
+        href: Joi.string().optional().uri(),
+    },
+    theme: Joi.any(),
+    untrustedSpec: Joi.boolean().optional().default(false),
+    supressWarnings: Joi.boolean().optional().default(true),
+    hideHostname: Joi.boolean().optional().default(false),
+    expandResponses: Joi.string().optional(),
+    requiredPropsFirst: Joi.boolean().optional().default(true),
+    sortPropsAlphabetically: Joi.boolean().optional().default(true),
+    sortOperationsAlphabetically: Joi.boolean().optional().default(true),
+    showExtensions: Joi.any().optional().default(false),
+    noAutoAuth: Joi.boolean().optional().default(true),
+    pathInMiddlePanel: Joi.boolean().optional().default(false),
+    hideLoading: Joi.boolean().optional().default(false),
+    nativeScrollbars: Joi.boolean().optional().default(false),
+    hideDownloadButton: Joi.boolean().optional().default(false),
+    disableSearch: Joi.boolean().optional().default(false),
+    onlyRequiredInSamples: Joi.boolean().optional().default(false),
+    docName: Joi.string().optional().default('swagger'),
+    auth: {
+        enabled: Joi.boolean().optional().default(false),
+        user: Joi.string().default('admin'),
+        password: Joi.string().default('123'),
+    },
+    tagGroups: Joi.array()
+        .items(Joi.object({
+        name: Joi.string(),
+        tags: Joi.array().items(Joi.string()),
+    }))
+        .optional(),
+});
+exports.schema = schema;

package/dist/redoc-module.d.ts

@@ -0,0 +1,11 @@
+import { INestApplication } from '@nestjs/common';
+import { OpenAPIObject } from '@nestjs/swagger';
+import { RedocOptions } from './interfaces';
+export declare class RedocModule {
+    static setup(path: string, app: INestApplication, document: OpenAPIObject, options: RedocOptions): Promise<void>;
+    private static setupFastify;
+    private static validateOptionsObject;
+    private static setupExpress;
+    private static normalizePath;
+    private static addVendorExtensions;
+}

package/dist/redoc-module.js

@@ -0,0 +1,126 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedocModule = void 0;
+const express_basic_auth_1 = __importDefault(require("express-basic-auth"));
+const express_handlebars_1 = require("express-handlebars");
+const path_1 = __importDefault(require("path"));
+const url_1 = require("url");
+const options_model_1 = require("./model/options.model");
+class RedocModule {
+    static setup(path, app, document, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const _options = yield this.validateOptionsObject(options, document);
+                const redocDocument = this.addVendorExtensions(_options, document);
+                const httpAdapter = app.getHttpAdapter();
+                if (httpAdapter &&
+                    httpAdapter.constructor &&
+                    httpAdapter.constructor.name === 'FastifyAdapter') {
+                    return this.setupFastify();
+                }
+                return yield this.setupExpress(path, app, redocDocument, _options);
+            }
+            catch (error) {
+                throw error;
+            }
+        });
+    }
+    static setupFastify() {
+        return __awaiter(this, void 0, void 0, function* () {
+            throw new Error('Fastify is not implemented yet');
+        });
+    }
+    static validateOptionsObject(options, document) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return (0, options_model_1.schema)(document).validateAsync(options);
+            }
+            catch (error) {
+                throw new TypeError(error.message);
+            }
+        });
+    }
+    static setupExpress(path, app, document, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const httpAdapter = app.getHttpAdapter();
+            const finalPath = this.normalizePath(path);
+            const resolvedPath = finalPath.slice(-1) !== '/' ? finalPath + '/' : finalPath;
+            const docUrl = (0, url_1.resolve)(resolvedPath, `${options.docName}.json`);
+            const hbs = (0, express_handlebars_1.create)({
+                helpers: {
+                    toJSON: function (object) {
+                        return JSON.stringify(object);
+                    },
+                },
+            });
+            const { title, favicon, theme, redocVersion } = options, otherOptions = __rest(options, ["title", "favicon", "theme", "redocVersion"]);
+            const renderData = {
+                data: Object.assign({ title,
+                    docUrl,
+                    favicon,
+                    redocVersion, options: otherOptions }, (theme && {
+                    theme: Object.assign({}, theme),
+                })),
+            };
+            const redocFilePath = path_1.default.join(__dirname, '..', 'views', 'redoc.handlebars');
+            const redocHTML = yield hbs.render(redocFilePath, renderData);
+            httpAdapter.get(finalPath, (req, res) => __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const sendPage = () => {
+                    res.setHeader('Content-Security-Policy', "default-src * 'unsafe-inline' 'unsafe-eval'; script-src * 'unsafe-inline' 'unsafe-eval'; child-src * 'unsafe-inline' 'unsafe-eval' blob:; worker-src * 'unsafe-inline' 'unsafe-eval' blob:; connect-src * 'unsafe-inline'; img-src * data: blob: 'unsafe-inline'; frame-src *; style-src * 'unsafe-inline';");
+                    res.send(redocHTML);
+                };
+                if ((_a = options.auth) === null || _a === void 0 ? void 0 : _a.enabled) {
+                    const { user, password } = options.auth;
+                    (0, express_basic_auth_1.default)({ users: { [user]: password }, challenge: true })(req, res, () => {
+                        sendPage();
+                    });
+                }
+                else {
+                    sendPage();
+                }
+            }));
+            httpAdapter.get(docUrl, (req, res) => {
+                res.setHeader('Content-Type', 'application/json');
+                res.send(document);
+            });
+        });
+    }
+    static normalizePath(path) {
+        return path.charAt(0) !== '/' ? '/' + path : path;
+    }
+    static addVendorExtensions(options, document) {
+        if (options.logo) {
+            const logoOption = Object.assign({}, options.logo);
+            document.info['x-logo'] = logoOption;
+        }
+        if (options.tagGroups) {
+            document['x-tagGroups'] = options.tagGroups;
+        }
+        return document;
+    }
+}
+exports.RedocModule = RedocModule;

package/jest.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  collectCoverage: true,
+  collectCoverageFrom: [
+    "src/**/*.ts"
+  ],
+  testMatch: [
+    "**/*.spec.ts",
+  ],
+  coverageReporters: ['lcov', 'text']
+};

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@andrewronscki/nestjs-redoc",
+  "version": "2.0.3",
+  "description": "NestJS ReDoc (Swagger UI Alternative)",
+  "keywords": [
+    "nestjs",
+    "redoc",
+    "swagger",
+    "swaggerui",
+    "openapi"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/andrewronscki/nestjs-redoc.git"
+  },
+  "author": "André Wronscki",
+  "main": "dist/index.js",
+  "private": false,
+  "license": "MIT",
+  "scripts": {
+    "prebuild": "rimraf ./dist",
+    "build": "tsc -p ./tsconfig.build.json",
+    "format": "prettier --write \"./src/**/*.ts\"",
+    "format:check": "prettier --check \"./src/**/*.ts\"",
+    "lint": "eslint \"./src/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "sample": "ts-node ./sample/main"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.11",
+    "@nestjs/core": "^11.0.11",
+    "@nestjs/swagger": "^11.0.6",
+    "reflect-metadata": "^0.2.2"
+  },
+  "dependencies": {
+    "joi": "^17.13.3",
+    "@nestjs/common": "^11.0.11",
+    "@nestjs/swagger": "^11.0.6",
+    "express-basic-auth": "^1.2.1",
+    "express-handlebars": "^8.0.1"
+  },
+  "devDependencies": {
+    "@nestjs/core": "^11.0.11",
+    "@nestjs/platform-express": "^11.0.11",
+    "@nestjs/platform-fastify": "^11.0.11",
+    "@nestjs/testing": "^11.0.11",
+    "@types/express": "^5.0.0",
+    "@types/express-handlebars": "^5.3.1",
+    "@types/hapi__joi": "^17.1.15",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.13.9",
+    "@types/supertest": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^8.26.0",
+    "@typescript-eslint/parser": "^8.26.0",
+    "commitizen": "^4.3.1",
+    "eslint": "^9.21.0",
+    "eslint-config-prettier": "^10.0.2",
+    "eslint-plugin-prettier": "^5.2.3",
+    "jest": "^29.7.0",
+    "prettier": "^3.5.3",
+    "reflect-metadata": "^0.2.2",
+    "rimraf": "^6.0.1",
+    "rxjs": "^7.8.2",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.2.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.2"
+  }
+}

package/sample/app.module.ts

@@ -0,0 +1,7 @@
+import { Module } from '@nestjs/common';
+import { CatsModule } from './cats/cats.module';
+
+@Module({
+  imports: [CatsModule],
+})
+export class AppModule {}

package/sample/cats/cats.controller.ts

@@ -0,0 +1,81 @@
+import { Body, Controller, Get, Param, Post, Query } from '@nestjs/common';
+import {
+  ApiBearerAuth,
+  ApiConsumes,
+  ApiExtension,
+  ApiHeader,
+  ApiOperation,
+  ApiResponse,
+  ApiSecurity,
+  ApiTags,
+} from '@nestjs/swagger';
+import { CatsService } from './cats.service';
+import { Cat } from './classes/cat.class';
+import { CreateCatDto } from './dto/create-cat.dto';
+import { PaginationQuery } from './dto/pagination-query.dto';
+
+@ApiSecurity('basic')
+@ApiBearerAuth()
+@ApiTags('cats')
+@ApiHeader({
+  name: 'header',
+  required: false,
+  description: 'Test',
+  schema: { default: 'test' },
+})
+@Controller('cats')
+export class CatsController {
+  constructor(private readonly catsService: CatsService) {}
+
+  @ApiTags('create cats')
+  @Post()
+  @ApiOperation({ summary: 'Create cat' })
+  @ApiResponse({
+    status: 201,
+    description: 'The record has been successfully created.',
+    type: () => Cat,
+  })
+  @ApiResponse({ status: 403, description: 'Forbidden.' })
+  @ApiExtension('x-foo', { test: 'bar ' })
+  async create(@Body() createCatDto: CreateCatDto): Promise<Cat> {
+    return this.catsService.create(createCatDto);
+  }
+
+  @Get(':id')
+  @ApiResponse({
+    status: 200,
+    description: 'The found record',
+    type: Cat,
+  })
+  @ApiExtension('x-auth-type', 'NONE')
+  findOne(@Param('id') id: string): Cat {
+    return this.catsService.findOne(+id);
+  }
+
+  @Get()
+  findAll(@Query() paginationQuery: PaginationQuery) {}
+
+  @Get('bulk')
+  findAllBulk(@Query() paginationQuery: PaginationQuery[]) {}
+
+  @Post('bulk')
+  async createBulk(@Body() createCatDto: CreateCatDto[]): Promise<Cat> {
+    return null;
+  }
+
+  @ApiConsumes('application/x-www-form-urlencoded')
+  @Post('as-form-data')
+  @ApiOperation({ summary: 'Create cat' })
+  @ApiResponse({
+    status: 201,
+    description: 'The record has been successfully created.',
+    type: Cat,
+  })
+  @ApiResponse({ status: 403, description: 'Forbidden.' })
+  async createAsFormData(@Body() createCatDto: CreateCatDto): Promise<Cat> {
+    return this.catsService.create(createCatDto);
+  }
+
+  @Get('site*')
+  getSite() {}
+}

package/sample/cats/cats.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { CatsController } from './cats.controller';
+import { CatsService } from './cats.service';
+
+@Module({
+  controllers: [CatsController],
+  providers: [CatsService],
+})
+export class CatsModule {}

package/sample/cats/cats.service.ts

@@ -0,0 +1,17 @@
+import { Injectable } from '@nestjs/common';
+import { Cat } from './classes/cat.class';
+import { CreateCatDto } from './dto/create-cat.dto';
+
+@Injectable()
+export class CatsService {
+  private readonly cats: Cat[] = [];
+
+  create(cat: CreateCatDto): Cat {
+    this.cats.push(cat);
+    return cat;
+  }
+
+  findOne(id: number): Cat {
+    return this.cats[id];
+  }
+}

package/sample/cats/classes/cat.class.ts

@@ -0,0 +1,56 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { LettersEnum } from '../dto/pagination-query.dto';
+
+export class Cat {
+  @ApiProperty({ example: 'Kitty', description: 'The name of the Cat' })
+  name: string;
+
+  @ApiProperty({ example: 1, minimum: 0, description: 'The age of the Cat' })
+  age: number;
+
+  @ApiProperty({
+    example: 'Maine Coon',
+    description: 'The breed of the Cat',
+  })
+  breed: string;
+
+  @ApiProperty({
+    name: '_tags',
+    type: [String],
+  })
+  tags?: string[];
+
+  @ApiProperty()
+  createdAt: Date;
+
+  @ApiProperty({
+    type: String,
+    isArray: true,
+  })
+  urls?: string[];
+
+  @ApiProperty({
+    name: '_options',
+    type: 'array',
+    items: {
+      type: 'object',
+      properties: {
+        isReadonly: {
+          type: 'string',
+        },
+      },
+    },
+  })
+  options?: Record<string, any>[];
+
+  @ApiProperty({
+    enum: LettersEnum,
+  })
+  enum: LettersEnum;
+
+  @ApiProperty({
+    enum: LettersEnum,
+    isArray: true,
+  })
+  enumArr: LettersEnum;
+}

package/sample/cats/dto/create-cat.dto.ts

@@ -0,0 +1,64 @@
+import { ApiExtraModels, ApiProperty } from '@nestjs/swagger';
+import { ExtraModel } from './extra-model.dto';
+import { LettersEnum } from './pagination-query.dto';
+import { TagDto } from './tag.dto';
+
+@ApiExtraModels(ExtraModel)
+export class CreateCatDto {
+  @ApiProperty()
+  readonly name: string;
+
+  @ApiProperty({ minimum: 1, maximum: 200 })
+  readonly age: number;
+
+  @ApiProperty({ name: '_breed', type: String })
+  readonly breed: string;
+
+  @ApiProperty({
+    type: [String],
+  })
+  readonly tags?: string[];
+
+  @ApiProperty()
+  createdAt: Date;
+
+  @ApiProperty({
+    type: 'string',
+    isArray: true,
+  })
+  readonly urls?: string[];
+
+  @ApiProperty({
+    type: 'array',
+    items: {
+      type: 'object',
+      properties: {
+        isReadonly: {
+          type: 'string',
+        },
+      },
+    },
+  })
+  readonly options?: Record<string, any>[];
+
+  @ApiProperty({
+    enum: LettersEnum,
+    enumName: 'LettersEnum',
+  })
+  readonly enum: LettersEnum;
+
+  @ApiProperty({
+    enum: LettersEnum,
+    enumName: 'LettersEnum',
+    isArray: true,
+  })
+  readonly enumArr: LettersEnum;
+
+  @ApiProperty({ description: 'tag', required: false })
+  readonly tag: TagDto;
+
+  nested: {
+    first: string;
+    second: number;
+  };
+}

package/sample/cats/dto/extra-model.dto.ts

@@ -0,0 +1,9 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class ExtraModel {
+  @ApiProperty()
+  readonly one: string;
+
+  @ApiProperty()
+  readonly two: number;
+}

package/sample/cats/dto/pagination-query.dto.ts

@@ -0,0 +1,42 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export enum LettersEnum {
+  A = 'A',
+  B = 'B',
+  C = 'C',
+}
+
+export class PaginationQuery {
+  @ApiProperty({
+    minimum: 0,
+    maximum: 10000,
+    title: 'Page',
+    exclusiveMaximum: true,
+    exclusiveMinimum: true,
+    format: 'int32',
+    default: 0,
+  })
+  page: number;
+
+  @ApiProperty({
+    name: '_sortBy',
+    type: [String],
+  })
+  sortBy: string[];
+
+  @ApiProperty()
+  limit: number;
+
+  @ApiProperty({
+    enum: LettersEnum,
+    enumName: 'LettersEnum',
+  })
+  enum: LettersEnum;
+
+  @ApiProperty({
+    enum: LettersEnum,
+    enumName: 'LettersEnum',
+    isArray: true,
+  })
+  enumArr: LettersEnum;
+}

package/sample/cats/dto/tag.dto.ts

@@ -0,0 +1,6 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class TagDto {
+  @ApiProperty({ description: 'name' })
+  name: string;
+}

package/sample/main.ts

@@ -0,0 +1,48 @@
+import { NestFactory } from '@nestjs/core';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { RedocModule, RedocOptions } from '../src';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  const options = new DocumentBuilder()
+    .setTitle('Cats example')
+    .setDescription('The cats API description')
+    .setVersion('1.0')
+    .addTag('cats')
+    .addBasicAuth()
+    .addBearerAuth()
+    .addOAuth2()
+    .addApiKey()
+    .addCookieAuth()
+    .addSecurityRequirements('bearer')
+    .build();
+  const document = SwaggerModule.createDocument(app, options);
+  const redocOptions: RedocOptions = {
+    title: 'Redoc Module',
+    logo: {
+      url: 'https://redocly.github.io/redoc/petstore-logo.png',
+      backgroundColor: '#F0F0F0',
+      altText: 'PetStore Logo',
+    },
+    sortPropsAlphabetically: true,
+    hideDownloadButton: false,
+    hideHostname: false,
+    noAutoAuth: true,
+    pathInMiddlePanel: true,
+    auth: {
+      enabled: true,
+      user: 'admin',
+      password: '123',
+    },
+    tagGroups: [
+      {
+        name: 'Core resources',
+        tags: ['cats'],
+      },
+    ],
+  };
+  await RedocModule.setup('docs', app, document, redocOptions);
+  await app.listen(8000);
+}
+bootstrap();

package/tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "sourceMap": false
+  },
+  "exclude": ["node_modules", "sample", "test", "dist", "**/*spec.ts"]
+}

package/views/redoc.handlebars

@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <title>{{ data.title }}</title>
+  <!-- needed for adaptive design -->
+  <meta charset="utf-8" />
+  {{#if data.favicon}}
+  <link rel="shortcut icon" type="image/x-icon" href="{{ data.favicon }}" />
+  {{/if}}
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+  <!--
+    ReDoc doesn't change outer page styles
+    -->
+  <style>
+    body {
+      margin: 0;
+      padding: 0;
+    }
+  </style>
+</head>
+
+<body>
+  <!-- we provide is specification here -->
+  <div id="redoc_container"></div>
+  <script src="https://cdn.jsdelivr.net/npm/redoc@{{data.redocVersion}}/bundles/redoc.standalone.js"> </script>
+  <script>
+    let themeJSON = '{{{ toJSON data.theme }}}';
+    if (themeJSON === '') { themeJSON = undefined }
+    Redoc.init(
+      '{{ data.docUrl }}',
+      {
+        ...(themeJSON && {
+          theme: {
+            ...JSON.parse(themeJSON)
+          }
+        }),
+        ...JSON.parse('{{{ toJSON data.options }}}')
+      },
+      document.getElementById("redoc_container")
+    );
+  </script>
+</body>
+
+</html>