nestjs-openapi-next 1.0.0

package/dist/swagger-scanner.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwaggerScanner = void 0;
+const constants_1 = require("@nestjs/common/constants");
+const lodash_1 = require("lodash");
+const constants_2 = require("./constants");
+const model_properties_accessor_1 = require("./services/model-properties-accessor");
+const schema_object_factory_1 = require("./services/schema-object-factory");
+const swagger_types_mapper_1 = require("./services/swagger-types-mapper");
+const swagger_explorer_1 = require("./swagger-explorer");
+const swagger_transformer_1 = require("./swagger-transformer");
+const get_global_prefix_1 = require("./utils/get-global-prefix");
+const strip_last_slash_util_1 = require("./utils/strip-last-slash.util");
+class SwaggerScanner {
+    constructor() {
+        this.transformer = new swagger_transformer_1.SwaggerTransformer();
+        this.schemaObjectFactory = new schema_object_factory_1.SchemaObjectFactory(new model_properties_accessor_1.ModelPropertiesAccessor(), new swagger_types_mapper_1.SwaggerTypesMapper());
+    }
+    scanApplication(app, options) {
+        const { deepScanRoutes, include: includedModules = [], extraModels = [], ignoreGlobalPrefix = false, operationIdFactory, linkNameFactory, autoTagControllers = true } = options;
+        const untypedApp = app;
+        const container = untypedApp.container;
+        const internalConfigRef = untypedApp.config;
+        const httpAdapterType = app.getHttpAdapter().getType();
+        this.initializeSwaggerExplorer(httpAdapterType);
+        const modules = this.getModules(container.getModules(), includedModules);
+        const globalPrefix = !ignoreGlobalPrefix
+            ? (0, strip_last_slash_util_1.stripLastSlash)((0, get_global_prefix_1.getGlobalPrefix)(app))
+            : '';
+        const tagGroups = this.exploreTagGroups(modules);
+        const denormalizedPaths = modules.map(({ controllers, metatype, imports }) => {
+            let result = [];
+            if (deepScanRoutes) {
+                const isGlobal = (module) => !container.isGlobalModule(module);
+                Array.from(imports.values())
+                    .filter(isGlobal)
+                    .forEach(({ metatype, controllers }) => {
+                    const modulePath = this.getModulePathMetadata(container, metatype);
+                    result = result.concat(this.scanModuleControllers(controllers, internalConfigRef, {
+                        modulePath,
+                        globalPrefix,
+                        operationIdFactory,
+                        linkNameFactory,
+                        autoTagControllers
+                    }));
+                });
+            }
+            const modulePath = this.getModulePathMetadata(container, metatype);
+            return result.concat(this.scanModuleControllers(controllers, internalConfigRef, {
+                modulePath,
+                globalPrefix,
+                operationIdFactory,
+                linkNameFactory,
+                autoTagControllers
+            }));
+        });
+        const schemas = this.explorer.getSchemas();
+        this.addExtraModels(schemas, extraModels);
+        return Object.assign(Object.assign(Object.assign({}, this.transformer.normalizePaths((0, lodash_1.flatten)(denormalizedPaths))), (tagGroups.length > 0 ? { tags: tagGroups } : {})), { components: {
+                schemas: schemas
+            } });
+    }
+    scanModuleControllers(controller, applicationConfig, options) {
+        const denormalizedArray = [...controller.values()].map((ctrl) => this.explorer.exploreController(ctrl, applicationConfig, options));
+        return (0, lodash_1.flatten)(denormalizedArray);
+    }
+    getModules(modulesContainer, include) {
+        if (!include || (0, lodash_1.isEmpty)(include)) {
+            return [...modulesContainer.values()];
+        }
+        return [...modulesContainer.values()].filter(({ metatype }) => include.some((item) => item === metatype));
+    }
+    addExtraModels(schemas, extraModels) {
+        extraModels.forEach((item) => {
+            this.schemaObjectFactory.exploreModelSchema(item, schemas);
+        });
+    }
+    getModulePathMetadata(container, metatype) {
+        const modulesContainer = container.getModules();
+        const modulePath = Reflect.getMetadata(constants_1.MODULE_PATH + modulesContainer.applicationId, metatype);
+        return modulePath !== null && modulePath !== void 0 ? modulePath : Reflect.getMetadata(constants_1.MODULE_PATH, metatype);
+    }
+    initializeSwaggerExplorer(httpAdapterType) {
+        if (this.explorer) {
+            return;
+        }
+        this.explorer = new swagger_explorer_1.SwaggerExplorer(this.schemaObjectFactory, {
+            httpAdapterType
+        });
+    }
+    exploreTagGroups(modules) {
+        const byName = new Map();
+        for (const moduleRef of modules) {
+            for (const wrapper of moduleRef.controllers.values()) {
+                const metatype = wrapper.metatype;
+                if (!metatype) {
+                    continue;
+                }
+                const groups = Reflect.getMetadata(constants_2.DECORATORS.API_TAG_GROUP, metatype) || [];
+                for (const group of groups) {
+                    if (!(group === null || group === void 0 ? void 0 : group.name)) {
+                        continue;
+                    }
+                    const previous = byName.get(group.name) || { name: group.name };
+                    byName.set(group.name, Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, previous), (group.summary !== undefined ? { summary: group.summary } : {})), (group.description !== undefined
+                        ? { description: group.description }
+                        : {})), (group.externalDocs !== undefined
+                        ? { externalDocs: group.externalDocs }
+                        : {})), (group.parent !== undefined ? { parent: group.parent } : {})), (group.kind !== undefined ? { kind: group.kind } : {})));
+                }
+            }
+        }
+        return [...byName.values()];
+    }
+}
+exports.SwaggerScanner = SwaggerScanner;

package/dist/swagger-transformer.d.ts

@@ -0,0 +1,4 @@
+import { OpenAPIObject } from './interfaces';
+export declare class SwaggerTransformer {
+    normalizePaths(denormalizedDoc: (Partial<OpenAPIObject> & Record<'root', any>)[]): Record<'paths', OpenAPIObject['paths']>;
+}

package/dist/swagger-transformer.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwaggerTransformer = void 0;
+const lodash_1 = require("lodash");
+const sort_object_lexicographically_1 = require("./utils/sort-object-lexicographically");
+class SwaggerTransformer {
+    normalizePaths(denormalizedDoc) {
+        const roots = (0, lodash_1.filter)(denormalizedDoc, (r) => r.root);
+        const groupedByPath = (0, lodash_1.groupBy)(roots, ({ root }) => root.path);
+        const paths = (0, lodash_1.mapValues)(groupedByPath, (routes) => {
+            const keyByMethod = (0, lodash_1.keyBy)(routes, ({ root }) => root.method);
+            return (0, lodash_1.mapValues)(keyByMethod, (route) => {
+                const mergedDefinition = Object.assign(Object.assign({}, (0, lodash_1.omit)(route, 'root')), (0, lodash_1.omit)(route.root, ['method', 'path']));
+                return (0, sort_object_lexicographically_1.sortObjectLexicographically)(mergedDefinition);
+            });
+        });
+        return {
+            paths
+        };
+    }
+}
+exports.SwaggerTransformer = SwaggerTransformer;

package/dist/swagger-ui/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const favIconHtml: string;
+export declare const htmlTemplateString = "\n<!-- HTML for static distribution bundle build -->\n<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n  <meta charset=\"UTF-8\">\n  <title><% title %></title>\n  <link rel=\"stylesheet\" type=\"text/css\" href=\"<% baseUrl %>swagger-ui.css\" >\n  <% favIconString %>\n  <style>\n    html\n    {\n      box-sizing: border-box;\n      overflow: -moz-scrollbars-vertical;\n      overflow-y: scroll;\n    }\n    *,\n    *:before,\n    *:after\n    {\n      box-sizing: inherit;\n    }\n\n    body {\n      margin:0;\n      background: #fafafa;\n    }\n  </style>\n</head>\n\n<body>\n\n<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" style=\"position:absolute;width:0;height:0\">\n  <defs>\n    <symbol viewBox=\"0 0 20 20\" id=\"unlocked\">\n      <path d=\"M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z\"></path>\n    </symbol>\n\n    <symbol viewBox=\"0 0 20 20\" id=\"locked\">\n      <path d=\"M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z\"/>\n    </symbol>\n\n    <symbol viewBox=\"0 0 20 20\" id=\"close\">\n      <path d=\"M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z\"/>\n    </symbol>\n\n    <symbol viewBox=\"0 0 20 20\" id=\"large-arrow\">\n      <path d=\"M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z\"/>\n    </symbol>\n\n    <symbol viewBox=\"0 0 20 20\" id=\"large-arrow-down\">\n      <path d=\"M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z\"/>\n    </symbol>\n\n\n    <symbol viewBox=\"0 0 24 24\" id=\"jump-to\">\n      <path d=\"M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z\"/>\n    </symbol>\n\n    <symbol viewBox=\"0 0 24 24\" id=\"expand\">\n      <path d=\"M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z\"/>\n    </symbol>\n\n  </defs>\n</svg>\n\n<div id=\"swagger-ui\"></div>\n\n<script src=\"<% baseUrl %>swagger-ui-bundle.js\"> </script>\n<script src=\"<% baseUrl %>swagger-ui-standalone-preset.js\"> </script>\n<script src=\"<% baseUrl %>swagger-ui-init.js\"> </script>\n<% customJs %>\n<% customJsStr %>\n<% customCssUrl %>\n<style>\n  <% customCss %>\n  <% explorerCss %>\n</style>\n</body>\n\n</html>\n";
+export declare const jsTemplateString = "\nwindow.onload = function() {\n  // Build a system\n  let url = window.location.search.match(/url=([^&]+)/);\n  if (url && url.length > 1) {\n    url = decodeURIComponent(url[1]);\n  } else {\n    url = window.location.origin;\n  }\n  <% swaggerOptions %>\n  url = options.swaggerUrl || url\n  let urls = options.swaggerUrls\n  let customOptions = options.customOptions\n  let spec1 = options.swaggerDoc\n  let swaggerOptions = {\n    spec: spec1,\n    url: url,\n    urls: urls,\n    dom_id: '#swagger-ui',\n    deepLinking: true,\n    presets: [\n      SwaggerUIBundle.presets.apis,\n      SwaggerUIStandalonePreset\n    ],\n    plugins: [\n      SwaggerUIBundle.plugins.DownloadUrl\n    ],\n    layout: \"StandaloneLayout\"\n  }\n  for (let attrname in customOptions) {\n    swaggerOptions[attrname] = customOptions[attrname];\n  }\n  let ui = SwaggerUIBundle(swaggerOptions)\n\n  if (customOptions.initOAuth) {\n    ui.initOAuth(customOptions.initOAuth)\n  }\n\n  if (customOptions.authAction) {\n    ui.authActions.authorize(customOptions.authAction)\n  }\n  \n  window.ui = ui\n}\n";

package/dist/swagger-ui/constants.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsTemplateString = exports.htmlTemplateString = exports.favIconHtml = void 0;
+exports.favIconHtml = '<link rel="icon" type="image/png" href="<% baseUrl %>favicon-32x32.png" sizes="32x32" />' +
+    '<link rel="icon" type="image/png" href="<% baseUrl %>favicon-16x16.png" sizes="16x16" />';
+exports.htmlTemplateString = `
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title><% title %></title>
+  <link rel="stylesheet" type="text/css" href="<% baseUrl %>swagger-ui.css" >
+  <% favIconString %>
+  <style>
+    html
+    {
+      box-sizing: border-box;
+      overflow: -moz-scrollbars-vertical;
+      overflow-y: scroll;
+    }
+    *,
+    *:before,
+    *:after
+    {
+      box-sizing: inherit;
+    }
+
+    body {
+      margin:0;
+      background: #fafafa;
+    }
+  </style>
+</head>
+
+<body>
+
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
+  <defs>
+    <symbol viewBox="0 0 20 20" id="unlocked">
+      <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="locked">
+      <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="close">
+      <path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow">
+      <path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow-down">
+      <path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
+    </symbol>
+
+
+    <symbol viewBox="0 0 24 24" id="jump-to">
+      <path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 24 24" id="expand">
+      <path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
+    </symbol>
+
+  </defs>
+</svg>
+
+<div id="swagger-ui"></div>
+
+<script src="<% baseUrl %>swagger-ui-bundle.js"> </script>
+<script src="<% baseUrl %>swagger-ui-standalone-preset.js"> </script>
+<script src="<% baseUrl %>swagger-ui-init.js"> </script>
+<% customJs %>
+<% customJsStr %>
+<% customCssUrl %>
+<style>
+  <% customCss %>
+  <% explorerCss %>
+</style>
+</body>
+
+</html>
+`;
+exports.jsTemplateString = `
+window.onload = function() {
+  // Build a system
+  let url = window.location.search.match(/url=([^&]+)/);
+  if (url && url.length > 1) {
+    url = decodeURIComponent(url[1]);
+  } else {
+    url = window.location.origin;
+  }
+  <% swaggerOptions %>
+  url = options.swaggerUrl || url
+  let urls = options.swaggerUrls
+  let customOptions = options.customOptions
+  let spec1 = options.swaggerDoc
+  let swaggerOptions = {
+    spec: spec1,
+    url: url,
+    urls: urls,
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  }
+  for (let attrname in customOptions) {
+    swaggerOptions[attrname] = customOptions[attrname];
+  }
+  let ui = SwaggerUIBundle(swaggerOptions)
+
+  if (customOptions.initOAuth) {
+    ui.initOAuth(customOptions.initOAuth)
+  }
+
+  if (customOptions.authAction) {
+    ui.authActions.authorize(customOptions.authAction)
+  }
+  
+  window.ui = ui
+}
+`;

package/dist/swagger-ui/helpers.d.ts

@@ -0,0 +1,2 @@
+import { SwaggerUIInitOptions } from '../interfaces/swagger-ui-init-options.interface';
+export declare function buildJSInitOptions(initOptions: SwaggerUIInitOptions): string;

package/dist/swagger-ui/helpers.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildJSInitOptions = buildJSInitOptions;
+function buildJSInitOptions(initOptions) {
+    const functionPlaceholder = '____FUNCTION_PLACEHOLDER____';
+    const fns = [];
+    let json = JSON.stringify(initOptions, (key, value) => {
+        if (typeof value === 'function') {
+            fns.push(value);
+            return functionPlaceholder;
+        }
+        return value;
+    }, 2);
+    json = json.replace(new RegExp('"' + functionPlaceholder + '"', 'g'), () => fns.shift());
+    return `let options = ${json};`;
+}

package/dist/swagger-ui/index.d.ts

@@ -0,0 +1 @@
+export * from './swagger-ui';

package/dist/swagger-ui/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("./swagger-ui"), exports);

package/dist/swagger-ui/swagger-ui.d.ts

@@ -0,0 +1,4 @@
+import { OpenAPIObject, SwaggerCustomOptions } from '../interfaces';
+export declare function buildSwaggerInitJS(swaggerDoc: OpenAPIObject, customOptions?: SwaggerCustomOptions): string;
+export declare function getSwaggerAssetsAbsoluteFSPath(): string;
+export declare function buildSwaggerHTML(baseUrl: string, customOptions?: SwaggerCustomOptions): string;

package/dist/swagger-ui/swagger-ui.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSwaggerInitJS = buildSwaggerInitJS;
+exports.getSwaggerAssetsAbsoluteFSPath = getSwaggerAssetsAbsoluteFSPath;
+exports.buildSwaggerHTML = buildSwaggerHTML;
+const constants_1 = require("./constants");
+const helpers_1 = require("./helpers");
+function buildSwaggerInitJS(swaggerDoc, customOptions = {}) {
+    const { swaggerOptions = {}, swaggerUrl } = customOptions;
+    const swaggerInitOptions = {
+        swaggerDoc,
+        swaggerUrl,
+        customOptions: swaggerOptions
+    };
+    const jsInitOptions = (0, helpers_1.buildJSInitOptions)(swaggerInitOptions);
+    return constants_1.jsTemplateString.replace('<% swaggerOptions %>', jsInitOptions);
+}
+let swaggerAssetsAbsoluteFSPath;
+function getSwaggerAssetsAbsoluteFSPath() {
+    if (!swaggerAssetsAbsoluteFSPath) {
+        swaggerAssetsAbsoluteFSPath = require('swagger-ui-dist/absolute-path.js')();
+    }
+    return swaggerAssetsAbsoluteFSPath;
+}
+function toExternalScriptTag(url) {
+    return `<script src='${url}'></script>`;
+}
+function toInlineScriptTag(jsCode) {
+    return `<script>${jsCode}</script>`;
+}
+function toExternalStylesheetTag(url) {
+    return `<link href='${url}' rel='stylesheet'>`;
+}
+function toTags(customCode, toScript) {
+    if (!customCode) {
+        return '';
+    }
+    if (typeof customCode === 'string') {
+        return toScript(customCode);
+    }
+    else {
+        return customCode.map(toScript).join('\n');
+    }
+}
+function buildSwaggerHTML(baseUrl, customOptions = {}) {
+    const { customCss = '', customJs = '', customJsStr = '', customfavIcon = false, customSiteTitle = 'Swagger UI', customCssUrl = '', explorer = false } = customOptions;
+    const favIconString = customfavIcon
+        ? `<link rel='icon' href='${customfavIcon}' />`
+        : constants_1.favIconHtml;
+    const explorerCss = explorer
+        ? ''
+        : '.swagger-ui .topbar .download-url-wrapper { display: none }';
+    return constants_1.htmlTemplateString
+        .replace('<% customCss %>', customCss)
+        .replace('<% explorerCss %>', explorerCss)
+        .replace('<% favIconString %>', favIconString)
+        .replace(/<% baseUrl %>/g, baseUrl)
+        .replace('<% customJs %>', toTags(customJs, toExternalScriptTag))
+        .replace('<% customJsStr %>', toTags(customJsStr, toInlineScriptTag))
+        .replace('<% customCssUrl %>', toTags(customCssUrl, toExternalStylesheetTag))
+        .replace('<% title %>', customSiteTitle);
+}

package/dist/type-helpers/index.d.ts

@@ -0,0 +1,4 @@
+export * from './intersection-type.helper';
+export * from './omit-type.helper';
+export * from './partial-type.helper';
+export * from './pick-type.helper';

package/dist/type-helpers/index.js

@@ -0,0 +1,20 @@
+"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("./intersection-type.helper"), exports);
+__exportStar(require("./omit-type.helper"), exports);
+__exportStar(require("./partial-type.helper"), exports);
+__exportStar(require("./pick-type.helper"), exports);

package/dist/type-helpers/intersection-type.helper.d.ts

@@ -0,0 +1,8 @@
+import { Type } from '@nestjs/common';
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+type ClassRefsToConstructors<T extends Type[]> = {
+    [U in keyof T]: T[U] extends Type<infer V> ? V : never;
+};
+type Intersection<T extends Type[]> = Type<UnionToIntersection<ClassRefsToConstructors<T>[number]>>;
+export declare function IntersectionType<T extends Type[]>(...classRefs: T): Intersection<T>;
+export {};

package/dist/type-helpers/intersection-type.helper.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IntersectionType = IntersectionType;
+const mapped_types_1 = require("@nestjs/mapped-types");
+const constants_1 = require("../constants");
+const decorators_1 = require("../decorators");
+const metadata_loader_1 = require("../plugin/metadata-loader");
+const model_properties_accessor_1 = require("../services/model-properties-accessor");
+const mapped_types_utils_1 = require("./mapped-types.utils");
+const modelPropertiesAccessor = new model_properties_accessor_1.ModelPropertiesAccessor();
+function IntersectionType(...classRefs) {
+    class IntersectionClassType {
+        constructor() {
+            classRefs.forEach((classRef) => {
+                (0, mapped_types_1.inheritPropertyInitializers)(this, classRef);
+            });
+        }
+    }
+    classRefs.forEach((classRef) => {
+        const fields = modelPropertiesAccessor.getModelProperties(classRef.prototype);
+        (0, mapped_types_1.inheritValidationMetadata)(classRef, IntersectionClassType);
+        (0, mapped_types_1.inheritTransformationMetadata)(classRef, IntersectionClassType);
+        function applyFields(fields) {
+            (0, mapped_types_utils_1.clonePluginMetadataFactory)(IntersectionClassType, classRef.prototype);
+            fields.forEach((propertyKey) => {
+                const metadata = Reflect.getMetadata(constants_1.DECORATORS.API_MODEL_PROPERTIES, classRef.prototype, propertyKey);
+                const decoratorFactory = (0, decorators_1.ApiProperty)(metadata);
+                decoratorFactory(IntersectionClassType.prototype, propertyKey);
+            });
+        }
+        applyFields(fields);
+        metadata_loader_1.MetadataLoader.addRefreshHook(() => {
+            const fields = modelPropertiesAccessor.getModelProperties(classRef.prototype);
+            applyFields(fields);
+        });
+    });
+    const intersectedNames = classRefs.reduce((prev, ref) => prev + ref.name, '');
+    Object.defineProperty(IntersectionClassType, 'name', {
+        value: `Intersection${intersectedNames}`
+    });
+    return IntersectionClassType;
+}

package/dist/type-helpers/mapped-types.utils.d.ts

@@ -0,0 +1,2 @@
+import { Type } from '@nestjs/common';
+export declare function clonePluginMetadataFactory(target: Type<unknown>, parent: Type<unknown>, transformFn?: (metadata: Record<string, any>) => Record<string, any>): void;

package/dist/type-helpers/mapped-types.utils.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clonePluginMetadataFactory = clonePluginMetadataFactory;
+const lodash_1 = require("lodash");
+const plugin_constants_1 = require("../plugin/plugin-constants");
+function clonePluginMetadataFactory(target, parent, transformFn = lodash_1.identity) {
+    let targetMetadata = {};
+    do {
+        if (!parent.constructor) {
+            return;
+        }
+        if (!parent.constructor[plugin_constants_1.METADATA_FACTORY_NAME]) {
+            continue;
+        }
+        const parentMetadata = parent.constructor[plugin_constants_1.METADATA_FACTORY_NAME]();
+        targetMetadata = Object.assign(Object.assign({}, parentMetadata), targetMetadata);
+    } while ((parent = Reflect.getPrototypeOf(parent)) &&
+        parent !== Object.prototype &&
+        parent);
+    targetMetadata = transformFn(targetMetadata);
+    if (target[plugin_constants_1.METADATA_FACTORY_NAME]) {
+        const originalFactory = target[plugin_constants_1.METADATA_FACTORY_NAME];
+        target[plugin_constants_1.METADATA_FACTORY_NAME] = () => {
+            const originalMetadata = originalFactory();
+            return Object.assign(Object.assign({}, originalMetadata), targetMetadata);
+        };
+    }
+    else {
+        target[plugin_constants_1.METADATA_FACTORY_NAME] = () => targetMetadata;
+    }
+}

package/dist/type-helpers/omit-type.helper.d.ts

@@ -0,0 +1,2 @@
+import { Type } from '@nestjs/common';
+export declare function OmitType<T, K extends keyof T>(classRef: Type<T>, keys: readonly K[]): Type<Omit<T, (typeof keys)[number]>>;

package/dist/type-helpers/omit-type.helper.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OmitType = OmitType;
+const mapped_types_1 = require("@nestjs/mapped-types");
+const lodash_1 = require("lodash");
+const constants_1 = require("../constants");
+const decorators_1 = require("../decorators");
+const metadata_loader_1 = require("../plugin/metadata-loader");
+const model_properties_accessor_1 = require("../services/model-properties-accessor");
+const mapped_types_utils_1 = require("./mapped-types.utils");
+const modelPropertiesAccessor = new model_properties_accessor_1.ModelPropertiesAccessor();
+function OmitType(classRef, keys) {
+    const fields = modelPropertiesAccessor
+        .getModelProperties(classRef.prototype)
+        .filter((item) => !keys.includes(item));
+    const isInheritedPredicate = (propertyKey) => !keys.includes(propertyKey);
+    class OmitTypeClass {
+        constructor() {
+            (0, mapped_types_1.inheritPropertyInitializers)(this, classRef, isInheritedPredicate);
+        }
+    }
+    (0, mapped_types_1.inheritValidationMetadata)(classRef, OmitTypeClass, isInheritedPredicate);
+    (0, mapped_types_1.inheritTransformationMetadata)(classRef, OmitTypeClass, isInheritedPredicate);
+    function applyFields(fields) {
+        (0, mapped_types_utils_1.clonePluginMetadataFactory)(OmitTypeClass, classRef.prototype, (metadata) => (0, lodash_1.omit)(metadata, keys));
+        fields.forEach((propertyKey) => {
+            const metadata = Reflect.getMetadata(constants_1.DECORATORS.API_MODEL_PROPERTIES, classRef.prototype, propertyKey);
+            const decoratorFactory = (0, decorators_1.ApiProperty)(metadata);
+            decoratorFactory(OmitTypeClass.prototype, propertyKey);
+        });
+    }
+    applyFields(fields);
+    metadata_loader_1.MetadataLoader.addRefreshHook(() => {
+        const fields = modelPropertiesAccessor
+            .getModelProperties(classRef.prototype)
+            .filter((item) => !keys.includes(item));
+        applyFields(fields);
+    });
+    return OmitTypeClass;
+}

package/dist/type-helpers/partial-type.helper.d.ts

@@ -0,0 +1,4 @@
+import { Type } from '@nestjs/common';
+export declare function PartialType<T>(classRef: Type<T>, options?: {
+    skipNullProperties?: boolean;
+}): Type<Partial<T>>;

package/dist/type-helpers/partial-type.helper.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PartialType = PartialType;
+const mapped_types_1 = require("@nestjs/mapped-types");
+const lodash_1 = require("lodash");
+const constants_1 = require("../constants");
+const decorators_1 = require("../decorators");
+const metadata_loader_1 = require("../plugin/metadata-loader");
+const plugin_constants_1 = require("../plugin/plugin-constants");
+const model_properties_accessor_1 = require("../services/model-properties-accessor");
+const mapped_types_utils_1 = require("./mapped-types.utils");
+const modelPropertiesAccessor = new model_properties_accessor_1.ModelPropertiesAccessor();
+function PartialType(classRef, options = {}) {
+    const applyPartialDecoratorFn = options.skipNullProperties === false
+        ? mapped_types_1.applyValidateIfDefinedDecorator
+        : mapped_types_1.applyIsOptionalDecorator;
+    const fields = modelPropertiesAccessor.getModelProperties(classRef.prototype);
+    class PartialTypeClass {
+        constructor() {
+            (0, mapped_types_1.inheritPropertyInitializers)(this, classRef);
+        }
+    }
+    const keysWithValidationConstraints = (0, mapped_types_1.inheritValidationMetadata)(classRef, PartialTypeClass);
+    if (keysWithValidationConstraints) {
+        keysWithValidationConstraints
+            .filter((key) => !fields.includes(key))
+            .forEach((key) => applyPartialDecoratorFn(PartialTypeClass, key));
+    }
+    (0, mapped_types_1.inheritTransformationMetadata)(classRef, PartialTypeClass);
+    function applyFields(fields) {
+        (0, mapped_types_utils_1.clonePluginMetadataFactory)(PartialTypeClass, classRef.prototype, (metadata) => (0, lodash_1.mapValues)(metadata, (item) => (Object.assign(Object.assign({}, item), { required: false }))));
+        if (PartialTypeClass[plugin_constants_1.METADATA_FACTORY_NAME]) {
+            const pluginFields = Object.keys(PartialTypeClass[plugin_constants_1.METADATA_FACTORY_NAME]());
+            pluginFields.forEach((key) => applyPartialDecoratorFn(PartialTypeClass, key));
+        }
+        fields.forEach((key) => {
+            const metadata = Reflect.getMetadata(constants_1.DECORATORS.API_MODEL_PROPERTIES, classRef.prototype, key) || {};
+            const decoratorFactory = (0, decorators_1.ApiProperty)(Object.assign(Object.assign({}, metadata), { required: false }));
+            decoratorFactory(PartialTypeClass.prototype, key);
+            applyPartialDecoratorFn(PartialTypeClass, key);
+        });
+    }
+    applyFields(fields);
+    metadata_loader_1.MetadataLoader.addRefreshHook(() => {
+        const fields = modelPropertiesAccessor.getModelProperties(classRef.prototype);
+        applyFields(fields);
+    });
+    return PartialTypeClass;
+}

package/dist/type-helpers/pick-type.helper.d.ts

@@ -0,0 +1,2 @@
+import { Type } from '@nestjs/common';
+export declare function PickType<T, K extends keyof T>(classRef: Type<T>, keys: readonly K[]): Type<Pick<T, (typeof keys)[number]>>;