@tsed/swagger 7.0.0-alpha.1 → 7.0.0-beta.3

package/lib/cjs/utils/matchPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchPath.js","sourceRoot":"","sources":["../../../src/utils/matchPath.ts"],"names":[],"mappings":";;;;AAAA,yEAAoC;AAEpC,SAAgB,SAAS,CAAC,IAAY,EAAE,QAAmB;IACzD,OAAO,QAAQ,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,oBAAU,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACjF,CAAC;AAFD,8BAEC","sourcesContent":["import micromatch from \"micromatch\";\n\nexport function matchPath(path: string, patterns?: string[]) {\n  return patterns && patterns.length ? micromatch.isMatch(path, patterns) : true;\n}\n"]}

package/lib/esm/SwaggerModule.js

@@ -0,0 +1,126 @@
+import { __decorate, __metadata } from "tslib";
+import { Configuration, Constant, Inject, InjectorService, Module, normalizePath, PlatformApplication, PlatformRouter, useCtxHandler } from "@tsed/common";
+import Fs from "fs";
+import { join } from "path";
+import { cssMiddleware } from "./middlewares/cssMiddleware";
+import { indexMiddleware } from "./middlewares/indexMiddleware";
+import { jsMiddleware } from "./middlewares/jsMiddleware";
+import { redirectMiddleware } from "./middlewares/redirectMiddleware";
+import { SwaggerService } from "./services/SwaggerService";
+import { Env } from "@tsed/core";
+const swaggerUiPath = require("swagger-ui-dist").absolutePath();
+/**
+ * @ignore
+ */
+let SwaggerModule = class SwaggerModule {
+    constructor() {
+        this.loaded = false;
+    }
+    get settings() {
+        return [].concat(this.configuration.get("swagger")).filter((o) => !!o);
+    }
+    /**
+     *
+     */
+    $onRoutesInit() {
+        if (this.loaded) {
+            return;
+        }
+        const urls = this.getUrls();
+        this.settings.forEach((conf) => {
+            const { path = "/" } = conf;
+            this.app.get(path, useCtxHandler(redirectMiddleware(path)));
+            this.app.use(path, this.createRouter(conf, urls));
+        });
+        this.loaded = true;
+    }
+    $onReady() {
+        // istanbul ignore next
+        if (this.configuration.getBestHost) {
+            const host = this.configuration.getBestHost();
+            const url = host.toString();
+            const displayLog = (conf) => {
+                const { path = "/", fileName = "swagger.json", doc } = conf;
+                this.injector.logger.info(`[${doc || "default"}] Swagger JSON is available on ${url}${normalizePath(path, fileName)}`);
+                this.injector.logger.info(`[${doc || "default"}] Swagger UI is available on ${url}${path}/`);
+            };
+            this.settings.forEach((conf) => {
+                displayLog(conf);
+            });
+        }
+        this.generateSpecFiles();
+    }
+    generateSpecFiles() {
+        return Promise.all(this.settings.map((conf) => {
+            const { outFile } = conf;
+            if (this.env === Env.PROD || outFile) {
+                const spec = this.swaggerService.getOpenAPISpec(conf);
+                if (outFile) {
+                    return Fs.writeFile(outFile, JSON.stringify(spec, null, 2), { encoding: "utf8" }, () => { });
+                }
+            }
+        }));
+    }
+    getUrls() {
+        return this.settings.reduce((acc, conf) => {
+            const { path = "/", fileName = "swagger.json", doc, hidden } = conf;
+            if (!hidden) {
+                acc.push({ url: normalizePath(path, fileName), name: doc || path });
+            }
+            return acc;
+        }, []);
+    }
+    /**
+     *
+     * @param conf
+     * @param urls
+     */
+    createRouter(conf, urls) {
+        const { disableSpec = false, fileName = "swagger.json", cssPath, jsPath, viewPath = join(__dirname, "../views/index.ejs") } = conf;
+        const router = PlatformRouter.create(this.injector);
+        if (!disableSpec) {
+            router.get(normalizePath("/", fileName), useCtxHandler(this.middlewareSwaggerJson(conf)));
+        }
+        if (viewPath) {
+            if (cssPath) {
+                router.get("/main.css", useCtxHandler(cssMiddleware(cssPath)));
+            }
+            if (jsPath) {
+                router.get("/main.js", useCtxHandler(jsMiddleware(jsPath)));
+            }
+            router.get("/", useCtxHandler(indexMiddleware(viewPath, { urls, ...conf })));
+            router.statics("/", { root: swaggerUiPath });
+        }
+        return router;
+    }
+    middlewareSwaggerJson(conf) {
+        return (ctx) => {
+            ctx.response.status(200).body(this.swaggerService.getOpenAPISpec(conf));
+        };
+    }
+};
+__decorate([
+    Inject(),
+    __metadata("design:type", InjectorService)
+], SwaggerModule.prototype, "injector", void 0);
+__decorate([
+    Inject(),
+    __metadata("design:type", PlatformApplication)
+], SwaggerModule.prototype, "app", void 0);
+__decorate([
+    Configuration(),
+    __metadata("design:type", Object)
+], SwaggerModule.prototype, "configuration", void 0);
+__decorate([
+    Inject(),
+    __metadata("design:type", SwaggerService)
+], SwaggerModule.prototype, "swaggerService", void 0);
+__decorate([
+    Constant("env"),
+    __metadata("design:type", String)
+], SwaggerModule.prototype, "env", void 0);
+SwaggerModule = __decorate([
+    Module()
+], SwaggerModule);
+export { SwaggerModule };
+//# sourceMappingURL=SwaggerModule.js.map

package/lib/esm/SwaggerModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwaggerModule.js","sourceRoot":"","sources":["../../src/SwaggerModule.ts"],"names":[],"mappings":";AAAA,OAAO,EAEL,aAAa,EACb,QAAQ,EACR,MAAM,EACN,eAAe,EACf,MAAM,EACN,aAAa,EAEb,mBAAmB,EAEnB,cAAc,EACd,aAAa,EACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAC,IAAI,EAAC,MAAM,MAAM,CAAC;AAE1B,OAAO,EAAC,aAAa,EAAC,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAC,eAAe,EAAC,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAC,YAAY,EAAC,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAC,kBAAkB,EAAC,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAC,cAAc,EAAC,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAC,GAAG,EAAC,MAAM,YAAY,CAAC;AAE/B,MAAM,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,YAAY,EAAE,CAAC;AAEhE;;GAEG;AAEH,IAAa,aAAa,GAA1B,MAAa,aAAa;IAA1B;QAgBU,WAAM,GAAG,KAAK,CAAC;IA6GzB,CAAC;IA3GC,IAAI,QAAQ;QACV,OAAQ,EAAwB,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAoB,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnH,CAAC;IAED;;OAEG;IACH,aAAa;QACX,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,OAAO;SACR;QAED,MAAM,IAAI,GAAU,IAAI,CAAC,OAAO,EAAE,CAAC;QAEnC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAqB,EAAE,EAAE;YAC9C,MAAM,EAAC,IAAI,GAAG,GAAG,EAAC,GAAG,IAAI,CAAC;YAE1B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5D,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACrB,CAAC;IAED,QAAQ;QACN,uBAAuB;QACvB,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAE5B,MAAM,UAAU,GAAG,CAAC,IAAqB,EAAE,EAAE;gBAC3C,MAAM,EAAC,IAAI,GAAG,GAAG,EAAE,QAAQ,GAAG,cAAc,EAAE,GAAG,EAAC,GAAG,IAAI,CAAC;gBAE1D,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,SAAS,kCAAkC,GAAG,GAAG,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACvH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,SAAS,gCAAgC,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC;YAC/F,CAAC,CAAC;YAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC7B,UAAU,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAED,iBAAiB;QACf,OAAO,OAAO,CAAC,GAAG,CAChB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACzB,MAAM,EAAC,OAAO,EAAC,GAAG,IAAI,CAAC;YAEvB,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,IAAI,OAAO,EAAE;gBACpC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBAEtD,IAAI,OAAO,EAAE;oBACX,OAAO,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;iBAC3F;aACF;QACH,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAEO,OAAO;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAU,EAAE,IAAI,EAAE,EAAE;YAC/C,MAAM,EAAC,IAAI,GAAG,GAAG,EAAE,QAAQ,GAAG,cAAc,EAAE,GAAG,EAAE,MAAM,EAAC,GAAG,IAAI,CAAC;YAElE,IAAI,CAAC,MAAM,EAAE;gBACX,GAAG,CAAC,IAAI,CAAC,EAAC,GAAG,EAAE,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAC,CAAC,CAAC;aACnE;YAED,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;OAIG;IACK,YAAY,CAAC,IAAqB,EAAE,IAAc;QACxD,MAAM,EAAC,WAAW,GAAG,KAAK,EAAE,QAAQ,GAAG,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,oBAAoB,CAAC,EAAC,GAAG,IAAI,CAAC;QACjI,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEpD,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAC3F;QAED,IAAI,QAAQ,EAAE;YACZ,IAAI,OAAO,EAAE;gBACX,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;aAChE;YAED,IAAI,MAAM,EAAE;gBACV,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aAC7D;YAED,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,GAAG,IAAI,EAAC,CAAC,CAAC,CAAC,CAAC;YAC3E,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAC,IAAI,EAAE,aAAa,EAAC,CAAC,CAAC;SAC5C;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,qBAAqB,CAAC,IAAqB;QACjD,OAAO,CAAC,GAAoB,EAAE,EAAE;YAC9B,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,CAAC,CAAC;IACJ,CAAC;CACF,CAAA;AA3HC;IADC,MAAM,EAAE;8BACC,eAAe;+CAAC;AAG1B;IADC,MAAM,EAAE;8BACJ,mBAAmB;0CAAC;AAGzB;IADC,aAAa,EAAE;;oDACa;AAG7B;IADC,MAAM,EAAE;8BACO,cAAc;qDAAC;AAG/B;IADC,QAAQ,CAAC,KAAK,CAAC;;0CACP;AAdE,aAAa;IADzB,MAAM,EAAE;GACI,aAAa,CA6HzB;SA7HY,aAAa","sourcesContent":["import {\n  OnRoutesInit,\n  Configuration,\n  Constant,\n  Inject,\n  InjectorService,\n  Module,\n  normalizePath,\n  OnReady,\n  PlatformApplication,\n  PlatformContext,\n  PlatformRouter,\n  useCtxHandler\n} from \"@tsed/common\";\nimport Fs from \"fs\";\nimport {join} from \"path\";\nimport {SwaggerSettings} from \"./interfaces\";\nimport {cssMiddleware} from \"./middlewares/cssMiddleware\";\nimport {indexMiddleware} from \"./middlewares/indexMiddleware\";\nimport {jsMiddleware} from \"./middlewares/jsMiddleware\";\nimport {redirectMiddleware} from \"./middlewares/redirectMiddleware\";\nimport {SwaggerService} from \"./services/SwaggerService\";\nimport {Env} from \"@tsed/core\";\n\nconst swaggerUiPath = require(\"swagger-ui-dist\").absolutePath();\n\n/**\n * @ignore\n */\n@Module()\nexport class SwaggerModule implements OnRoutesInit, OnReady {\n  @Inject()\n  injector: InjectorService;\n\n  @Inject()\n  app: PlatformApplication;\n\n  @Configuration()\n  configuration: Configuration;\n\n  @Inject()\n  swaggerService: SwaggerService;\n\n  @Constant(\"env\")\n  env: Env;\n\n  private loaded = false;\n\n  get settings() {\n    return ([] as SwaggerSettings[]).concat(this.configuration.get<SwaggerSettings[]>(\"swagger\")).filter((o) => !!o);\n  }\n\n  /**\n   *\n   */\n  $onRoutesInit() {\n    if (this.loaded) {\n      return;\n    }\n\n    const urls: any[] = this.getUrls();\n\n    this.settings.forEach((conf: SwaggerSettings) => {\n      const {path = \"/\"} = conf;\n\n      this.app.get(path, useCtxHandler(redirectMiddleware(path)));\n      this.app.use(path, this.createRouter(conf, urls));\n    });\n\n    this.loaded = true;\n  }\n\n  $onReady() {\n    // istanbul ignore next\n    if (this.configuration.getBestHost) {\n      const host = this.configuration.getBestHost();\n      const url = host.toString();\n\n      const displayLog = (conf: SwaggerSettings) => {\n        const {path = \"/\", fileName = \"swagger.json\", doc} = conf;\n\n        this.injector.logger.info(`[${doc || \"default\"}] Swagger JSON is available on ${url}${normalizePath(path, fileName)}`);\n        this.injector.logger.info(`[${doc || \"default\"}] Swagger UI is available on ${url}${path}/`);\n      };\n\n      this.settings.forEach((conf) => {\n        displayLog(conf);\n      });\n    }\n\n    this.generateSpecFiles();\n  }\n\n  generateSpecFiles() {\n    return Promise.all(\n      this.settings.map((conf) => {\n        const {outFile} = conf;\n\n        if (this.env === Env.PROD || outFile) {\n          const spec = this.swaggerService.getOpenAPISpec(conf);\n\n          if (outFile) {\n            return Fs.writeFile(outFile, JSON.stringify(spec, null, 2), {encoding: \"utf8\"}, () => {});\n          }\n        }\n      })\n    );\n  }\n\n  private getUrls() {\n    return this.settings.reduce((acc: any[], conf) => {\n      const {path = \"/\", fileName = \"swagger.json\", doc, hidden} = conf;\n\n      if (!hidden) {\n        acc.push({url: normalizePath(path, fileName), name: doc || path});\n      }\n\n      return acc;\n    }, []);\n  }\n\n  /**\n   *\n   * @param conf\n   * @param urls\n   */\n  private createRouter(conf: SwaggerSettings, urls: string[]) {\n    const {disableSpec = false, fileName = \"swagger.json\", cssPath, jsPath, viewPath = join(__dirname, \"../views/index.ejs\")} = conf;\n    const router = PlatformRouter.create(this.injector);\n\n    if (!disableSpec) {\n      router.get(normalizePath(\"/\", fileName), useCtxHandler(this.middlewareSwaggerJson(conf)));\n    }\n\n    if (viewPath) {\n      if (cssPath) {\n        router.get(\"/main.css\", useCtxHandler(cssMiddleware(cssPath)));\n      }\n\n      if (jsPath) {\n        router.get(\"/main.js\", useCtxHandler(jsMiddleware(jsPath)));\n      }\n\n      router.get(\"/\", useCtxHandler(indexMiddleware(viewPath, {urls, ...conf})));\n      router.statics(\"/\", {root: swaggerUiPath});\n    }\n\n    return router;\n  }\n\n  private middlewareSwaggerJson(conf: SwaggerSettings) {\n    return (ctx: PlatformContext) => {\n      ctx.response.status(200).body(this.swaggerService.getOpenAPISpec(conf));\n    };\n  }\n}\n"]}

package/lib/esm/decorators/docs.js

@@ -0,0 +1,14 @@
+import { StoreMerge } from "@tsed/core";
+/**
+ * Set the type documentation for this class.
+ *
+ * See [swagger documentation](/tutorials/swagger.html)
+ *
+ * @decorator
+ * @swagger
+ * @param docs
+ */
+export function Docs(...docs) {
+    return StoreMerge("docs", docs);
+}
+//# sourceMappingURL=docs.js.map

package/lib/esm/decorators/docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs.js","sourceRoot":"","sources":["../../../src/decorators/docs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,YAAY,CAAC;AAEtC;;;;;;;;GAQG;AACH,MAAM,UAAU,IAAI,CAAC,GAAG,IAAc;IACpC,OAAO,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAClC,CAAC","sourcesContent":["import {StoreMerge} from \"@tsed/core\";\n\n/**\n * Set the type documentation for this class.\n *\n * See [swagger documentation](/tutorials/swagger.html)\n *\n * @decorator\n * @swagger\n * @param docs\n */\nexport function Docs(...docs: string[]) {\n  return StoreMerge(\"docs\", docs);\n}\n"]}

package/lib/esm/decorators/hidden.js

@@ -0,0 +1,36 @@
+import { Hidden as H } from "@tsed/schema";
+/**
+ * Disable documentation for the class and his endpoint.
+ *
+ * ````typescript
+ * @Controller('/')
+ * export class Ctrl {
+ *
+ *   @Get('/')
+ *   @Hidden()
+ *   hiddenRoute(){
+ *
+ *   }
+ * }
+ *
+ * @Controller('/')
+ * @Hidden()
+ * export class Ctrl {
+ *   @Get('/')
+ *   hiddenRoute() {
+ *
+ *   }
+ *   @Get('/2')
+ *   hiddenRoute2() {
+ *
+ *   }
+ * }
+ * ```
+ *
+ * @decorator
+ * @swagger
+ */
+export function Hidden() {
+    return H();
+}
+//# sourceMappingURL=hidden.js.map

package/lib/esm/decorators/hidden.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hidden.js","sourceRoot":"","sources":["../../../src/decorators/hidden.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,IAAI,CAAC,EAAC,MAAM,cAAc,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,MAAM;IACpB,OAAO,CAAC,EAAE,CAAC;AACb,CAAC","sourcesContent":["import {Hidden as H} from \"@tsed/schema\";\n\n/**\n * Disable documentation for the class and his endpoint.\n *\n * ````typescript\n * @Controller('/')\n * export class Ctrl {\n *\n *   @Get('/')\n *   @Hidden()\n *   hiddenRoute(){\n *\n *   }\n * }\n *\n * @Controller('/')\n * @Hidden()\n * export class Ctrl {\n *   @Get('/')\n *   hiddenRoute() {\n *\n *   }\n *   @Get('/2')\n *   hiddenRoute2() {\n *\n *   }\n * }\n * ```\n *\n * @decorator\n * @swagger\n */\nexport function Hidden() {\n  return H();\n}\n"]}

package/lib/esm/index.js

@@ -0,0 +1,6 @@
+export * from "./services/SwaggerService";
+export * from "./SwaggerModule";
+export * from "./interfaces";
+export * from "./decorators/docs";
+export * from "./decorators/hidden";
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC","sourcesContent":["export * from \"./services/SwaggerService\";\nexport * from \"./SwaggerModule\";\nexport * from \"./interfaces\";\nexport * from \"./decorators/docs\";\nexport * from \"./decorators/hidden\";\n"]}

package/lib/esm/interfaces/SwaggerSettings.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SwaggerSettings.js.map

package/lib/esm/interfaces/SwaggerSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwaggerSettings.js","sourceRoot":"","sources":["../../../src/interfaces/SwaggerSettings.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpec3, OpenSpecVersions, OS3Versions} from \"@tsed/openspec\";\n\nexport interface SwaggerUIOptions {\n  configUrl?: string;\n  url?: string;\n  urls?: {url: string; name: string; primaryName?: string}[];\n  layout?: string;\n  validatorUrl?: string;\n  oauth?: any;\n  authorize?: any;\n\n  [key: string]: any;\n}\n\nexport interface SwaggerSettingsBase {\n  /**\n   * The url subpath to access to the documentation.\n   */\n  path: string;\n  /**\n   * Specify the spec version you want to generate.\n   */\n  specVersion?: OpenSpecVersions;\n  /**\n   * Swagger file name. By default swagger.json\n   */\n  fileName?: string;\n  /**\n   * Hidden documentation. Use this to hide documentation link in the dropdown.\n   */\n  hidden?: string;\n  /**\n   * The documentation key used by `@Docs` decorator to create several swagger documentations.\n   */\n  doc?: string;\n  /**\n   * The path to the CSS file.\n   */\n  cssPath?: string;\n  /**\n   * The path to the JS file.\n   */\n  jsPath?: string;\n  /**\n   * The path to the ejs file to create html page.\n   */\n  viewPath?: string | false;\n  /**\n   * SwaggerUI options. See (https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md)\n   */\n  options?: SwaggerUIOptions;\n  /**\n   * Display the search field in the navbar.\n   */\n  showExplorer?: boolean;\n  /**\n   * Load the base spec documentation from the specified path.\n   */\n  specPath?: string;\n  /**\n   * Write the `swagger.json` spec documentation on the specified path.\n   */\n  outFile?: string;\n  /**\n   * A function to generate the operationId.\n   */\n  operationIdFormatter?: (name: string, propertyKey: string, path: string) => string;\n  /**\n   * A pattern to generate the operationId. Format of operationId field (%c: class name, %m: method name).\n   */\n  operationIdPattern?: string;\n  /**\n   *\n   */\n  disableSpec?: boolean;\n  /**\n   * Include only controllers whose paths match the pattern list provided.\n   */\n  pathPatterns?: string[];\n}\n\nexport interface SwaggerOS3Settings extends SwaggerSettingsBase {\n  specVersion?: OS3Versions;\n  /**\n   * OpenSpec 3\n   */\n  spec?: Partial<OpenSpec3>;\n}\n\nexport type SwaggerSettings = SwaggerOS3Settings;\n"]}

package/lib/esm/interfaces/index.js

@@ -0,0 +1,2 @@
+export * from "./SwaggerSettings";
+//# sourceMappingURL=index.js.map

package/lib/esm/interfaces/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":"AAUA,cAAc,mBAAmB,CAAC","sourcesContent":["import {SwaggerSettings} from \"./SwaggerSettings\";\n\ndeclare global {\n  namespace TsED {\n    interface Configuration {\n      swagger: SwaggerSettings[];\n    }\n  }\n}\n\nexport * from \"./SwaggerSettings\";\n"]}

package/lib/esm/middlewares/cssMiddleware.js

@@ -0,0 +1,18 @@
+import Fs from "fs";
+import { resolve } from "path";
+/**
+ * @ignore
+ * @param path
+ */
+export function cssMiddleware(path) {
+    return (ctx) => {
+        const content = Fs.readFileSync(resolve(path), { encoding: "utf8" });
+        ctx.response
+            .setHeaders({
+            "Content-Type": "text/css"
+        })
+            .status(200)
+            .body(content);
+    };
+}
+//# sourceMappingURL=cssMiddleware.js.map

package/lib/esm/middlewares/cssMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cssMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/cssMiddleware.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAC,OAAO,EAAC,MAAM,MAAM,CAAC;AAE7B;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,OAAO,CAAC,GAAoB,EAAE,EAAE;QAC9B,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;QACnE,GAAG,CAAC,QAAQ;aACT,UAAU,CAAC;YACV,cAAc,EAAE,UAAU;SAC3B,CAAC;aACD,MAAM,CAAC,GAAG,CAAC;aACX,IAAI,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import {PlatformContext} from \"@tsed/common\";\nimport Fs from \"fs\";\nimport {resolve} from \"path\";\n\n/**\n * @ignore\n * @param path\n */\nexport function cssMiddleware(path: string) {\n  return (ctx: PlatformContext) => {\n    const content = Fs.readFileSync(resolve(path), {encoding: \"utf8\"});\n    ctx.response\n      .setHeaders({\n        \"Content-Type\": \"text/css\"\n      })\n      .status(200)\n      .body(content);\n  };\n}\n"]}

package/lib/esm/middlewares/indexMiddleware.js

@@ -0,0 +1,20 @@
+/**
+ * @ignore
+ * @param viewPath
+ * @param conf
+ */
+export function indexMiddleware(viewPath, conf) {
+    return async (ctx) => {
+        const { path = "/", options = {}, showExplorer, cssPath, jsPath, urls } = conf;
+        ctx.response.body(await ctx.response.render(viewPath, {
+            spec: {},
+            url: `${path}/swagger.json`,
+            urls,
+            showExplorer,
+            cssPath,
+            jsPath,
+            swaggerOptions: options
+        }));
+    };
+}
+//# sourceMappingURL=indexMiddleware.js.map

package/lib/esm/middlewares/indexMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/indexMiddleware.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,QAAgB,EAAE,IAAwC;IACxF,OAAO,KAAK,EAAE,GAAoB,EAAE,EAAE;QACpC,MAAM,EAAC,IAAI,GAAG,GAAG,EAAE,OAAO,GAAG,EAAE,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC;QAE7E,GAAG,CAAC,QAAQ,CAAC,IAAI,CACf,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE;YAClC,IAAI,EAAE,EAAE;YACR,GAAG,EAAE,GAAG,IAAI,eAAe;YAC3B,IAAI;YACJ,YAAY;YACZ,OAAO;YACP,MAAM;YACN,cAAc,EAAE,OAAO;SACxB,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import {PlatformContext} from \"@tsed/common\";\nimport {SwaggerSettings} from \"../interfaces/SwaggerSettings\";\n\n/**\n * @ignore\n * @param viewPath\n * @param conf\n */\nexport function indexMiddleware(viewPath: string, conf: SwaggerSettings & {urls: string[]}) {\n  return async (ctx: PlatformContext) => {\n    const {path = \"/\", options = {}, showExplorer, cssPath, jsPath, urls} = conf;\n\n    ctx.response.body(\n      await ctx.response.render(viewPath, {\n        spec: {},\n        url: `${path}/swagger.json`,\n        urls,\n        showExplorer,\n        cssPath,\n        jsPath,\n        swaggerOptions: options\n      })\n    );\n  };\n}\n"]}

package/lib/esm/middlewares/jsMiddleware.js

@@ -0,0 +1,13 @@
+import Fs from "fs";
+import { resolve } from "path";
+/**
+ * @ignore
+ * @param path
+ */
+export function jsMiddleware(path) {
+    return (ctx) => {
+        const content = Fs.readFileSync(resolve(path), { encoding: "utf8" });
+        ctx.response.setHeaders({ "Content-Type": "application/javascript" }).status(200).body(content);
+    };
+}
+//# sourceMappingURL=jsMiddleware.js.map

package/lib/esm/middlewares/jsMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/jsMiddleware.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAC,OAAO,EAAC,MAAM,MAAM,CAAC;AAE7B;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,OAAO,CAAC,GAAoB,EAAE,EAAE;QAC9B,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;QACnE,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAC,cAAc,EAAE,wBAAwB,EAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChG,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import {PlatformContext} from \"@tsed/common\";\nimport Fs from \"fs\";\nimport {resolve} from \"path\";\n\n/**\n * @ignore\n * @param path\n */\nexport function jsMiddleware(path: string) {\n  return (ctx: PlatformContext) => {\n    const content = Fs.readFileSync(resolve(path), {encoding: \"utf8\"});\n    ctx.response.setHeaders({\"Content-Type\": \"application/javascript\"}).status(200).body(content);\n  };\n}\n"]}

package/lib/esm/middlewares/redirectMiddleware.js

@@ -0,0 +1,12 @@
+/**
+ * @ignore
+ * @param path
+ */
+export function redirectMiddleware(path) {
+    return (ctx) => {
+        if (ctx.request.url === path && !ctx.request.url.match(/\/$/)) {
+            ctx.response.redirect(302, `${path}/`);
+        }
+    };
+}
+//# sourceMappingURL=redirectMiddleware.js.map

package/lib/esm/middlewares/redirectMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirectMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/redirectMiddleware.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO,CAAC,GAAoB,EAAE,EAAE;QAC9B,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;YAC7D,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,CAAC,CAAC;SACxC;IACH,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import {PlatformContext} from \"@tsed/common\";\n\n/**\n * @ignore\n * @param path\n */\nexport function redirectMiddleware(path: string) {\n  return (ctx: PlatformContext) => {\n    if (ctx.request.url === path && !ctx.request.url.match(/\\/$/)) {\n      ctx.response.redirect(302, `${path}/`);\n    }\n  };\n}\n"]}

package/lib/esm/services/SwaggerService.js

@@ -0,0 +1,102 @@
+var _SwaggerService_specs;
+import { __classPrivateFieldGet, __decorate, __metadata, __param } from "tslib";
+import { Configuration, Injectable, InjectorService, Platform } from "@tsed/common";
+import { getValue } from "@tsed/core";
+import { getSpec, mergeSpec, SpecTypes } from "@tsed/schema";
+import Fs from "fs";
+import { includeRoute } from "../utils/includeRoute";
+import { mapOpenSpec } from "../utils/mapOpenSpec";
+let SwaggerService = class SwaggerService {
+    constructor(injectorService, platform, configuration) {
+        this.injectorService = injectorService;
+        this.platform = platform;
+        this.configuration = configuration;
+        _SwaggerService_specs.set(this, new Map());
+    }
+    /**
+     * Generate Spec for the given configuration
+     * @returns {Spec}
+     */
+    getOpenAPISpec(conf) {
+        if (!__classPrivateFieldGet(this, _SwaggerService_specs, "f").has(conf.path)) {
+            const defaultSpec = this.getDefaultSpec(conf);
+            let finalSpec = {};
+            const options = {
+                paths: {},
+                tags: [],
+                schemas: {},
+                specType: SpecTypes.OPENAPI,
+                operationIdFormatter: conf.operationIdFormatter,
+                operationIdPattern: conf.operationIdPattern,
+                append(spec) {
+                    finalSpec = mergeSpec(finalSpec, spec);
+                }
+            };
+            this.platform.getMountedControllers().forEach(({ route, provider }) => {
+                if (includeRoute(route, provider, conf)) {
+                    const spec = this.buildRoutes(provider, {
+                        ...options,
+                        rootPath: route.replace(provider.path, "")
+                    });
+                    options.append(spec);
+                }
+            });
+            __classPrivateFieldGet(this, _SwaggerService_specs, "f").set(conf.path, mergeSpec(defaultSpec, finalSpec));
+        }
+        return __classPrivateFieldGet(this, _SwaggerService_specs, "f").get(conf.path);
+    }
+    /**
+     * Return the global api information.
+     */
+    getDefaultSpec(conf) {
+        const { version = "1.0.0", acceptMimes } = this.configuration;
+        const { specPath, specVersion } = conf;
+        const fileSpec = specPath ? this.readSpecPath(specPath) : {};
+        return mapOpenSpec(getValue(conf, "spec", {}), {
+            fileSpec,
+            version,
+            specVersion,
+            acceptMimes
+        });
+    }
+    readSpecPath(path) {
+        path = this.configuration.resolve(path);
+        if (Fs.existsSync(path)) {
+            const json = Fs.readFileSync(path, { encoding: "utf8" });
+            /* istanbul ignore else */
+            if (json !== "") {
+                return JSON.parse(json);
+            }
+        }
+        return {};
+    }
+    /**
+     *
+     * @param ctrl
+     * @param options
+     */
+    buildRoutes(ctrl, options) {
+        const rootPath = options.rootPath + ctrl.path;
+        ctrl.children
+            .map((ctrl) => this.injectorService.getProvider(ctrl))
+            .forEach((provider) => {
+            if (!provider.store.get("hidden")) {
+                const spec = this.buildRoutes(provider, {
+                    ...options,
+                    rootPath
+                });
+                options.append(spec);
+            }
+        });
+        return getSpec(ctrl.token, options);
+    }
+};
+_SwaggerService_specs = new WeakMap();
+SwaggerService = __decorate([
+    Injectable(),
+    __param(2, Configuration()),
+    __metadata("design:paramtypes", [InjectorService,
+        Platform, Object])
+], SwaggerService);
+export { SwaggerService };
+//# sourceMappingURL=SwaggerService.js.map

package/lib/esm/services/SwaggerService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwaggerService.js","sourceRoot":"","sources":["../../../src/services/SwaggerService.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAC,aAAa,EAAsB,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAC,MAAM,cAAc,CAAC;AACtG,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AAEpC,OAAO,EAAC,OAAO,EAAE,SAAS,EAAyB,SAAS,EAAC,MAAM,cAAc,CAAC;AAClF,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpB,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AAGjD,IAAa,cAAc,GAA3B,MAAa,cAAc;IAGzB,YACU,eAAgC,EAChC,QAAkB,EACD,aAA4B;QAF7C,oBAAe,GAAf,eAAe,CAAiB;QAChC,aAAQ,GAAR,QAAQ,CAAU;QACD,kBAAa,GAAb,aAAa,CAAe;QALvD,gCAAiC,IAAI,GAAG,EAAE,EAAC;IAMxC,CAAC;IAEJ;;;OAGG;IACI,cAAc,CAAC,IAAqB;QACzC,IAAI,CAAC,uBAAA,IAAI,6BAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC/B,MAAM,WAAW,GAAQ,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YACnD,IAAI,SAAS,GAAQ,EAAE,CAAC;YAExB,MAAM,OAAO,GAA0B;gBACrC,KAAK,EAAE,EAAE;gBACT,IAAI,EAAE,EAAE;gBACR,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,SAAS,CAAC,OAAO;gBAC3B,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;gBAC/C,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;gBAC3C,MAAM,CAAC,IAAS;oBACd,SAAS,GAAG,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;gBACzC,CAAC;aACF,CAAC;YAEF,IAAI,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC,OAAO,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,EAAC,EAAE,EAAE;gBAClE,IAAI,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE;oBACvC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE;wBACtC,GAAG,OAAO;wBACV,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;qBAC3C,CAAC,CAAC;oBAEH,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;iBACtB;YACH,CAAC,CAAC,CAAC;YAEH,uBAAA,IAAI,6BAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,WAAW,EAAE,SAAS,CAAQ,CAAC,CAAC;SACtE;QAED,OAAO,uBAAA,IAAI,6BAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,IAA8B;QACrD,MAAM,EAAC,OAAO,GAAG,OAAO,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC5D,MAAM,EAAC,QAAQ,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC;QACrC,MAAM,QAAQ,GAAuB,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAEjF,OAAO,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE;YAC7C,QAAQ;YACR,OAAO;YACP,WAAW;YACX,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAES,YAAY,CAAC,IAAY;QACjC,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACvB,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;YACvD,0BAA0B;YAC1B,IAAI,IAAI,KAAK,EAAE,EAAE;gBACf,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aACzB;SACF;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACO,WAAW,CAAC,IAAwB,EAAE,OAA8B;QAC5E,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;QAE9C,IAAI,CAAC,QAAQ;aACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;aACrD,OAAO,CAAC,CAAC,QAA4B,EAAE,EAAE;YACxC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBACjC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE;oBACtC,GAAG,OAAO;oBACV,QAAQ;iBACT,CAAC,CAAC;gBAEH,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;aACtB;QACH,CAAC,CAAC,CAAC;QAEL,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAA;;AAnGY,cAAc;IAD1B,UAAU,EAAE;IAOR,WAAA,aAAa,EAAE,CAAA;qCAFS,eAAe;QACtB,QAAQ;GALjB,cAAc,CAmG1B;SAnGY,cAAc","sourcesContent":["import {Configuration, ControllerProvider, Injectable, InjectorService, Platform} from \"@tsed/common\";\nimport {getValue} from \"@tsed/core\";\nimport {OpenSpec3} from \"@tsed/openspec\";\nimport {getSpec, mergeSpec, SpecSerializerOptions, SpecTypes} from \"@tsed/schema\";\nimport Fs from \"fs\";\nimport {SwaggerSettings} from \"../interfaces/SwaggerSettings\";\nimport {includeRoute} from \"../utils/includeRoute\";\nimport {mapOpenSpec} from \"../utils/mapOpenSpec\";\n\n@Injectable()\nexport class SwaggerService {\n  #specs: Map<string, OpenSpec3> = new Map();\n\n  constructor(\n    private injectorService: InjectorService,\n    private platform: Platform,\n    @Configuration() private configuration: Configuration\n  ) {}\n\n  /**\n   * Generate Spec for the given configuration\n   * @returns {Spec}\n   */\n  public getOpenAPISpec(conf: SwaggerSettings) {\n    if (!this.#specs.has(conf.path)) {\n      const defaultSpec: any = this.getDefaultSpec(conf);\n      let finalSpec: any = {};\n\n      const options: SpecSerializerOptions = {\n        paths: {},\n        tags: [],\n        schemas: {},\n        specType: SpecTypes.OPENAPI,\n        operationIdFormatter: conf.operationIdFormatter,\n        operationIdPattern: conf.operationIdPattern,\n        append(spec: any) {\n          finalSpec = mergeSpec(finalSpec, spec);\n        }\n      };\n\n      this.platform.getMountedControllers().forEach(({route, provider}) => {\n        if (includeRoute(route, provider, conf)) {\n          const spec = this.buildRoutes(provider, {\n            ...options,\n            rootPath: route.replace(provider.path, \"\")\n          });\n\n          options.append(spec);\n        }\n      });\n\n      this.#specs.set(conf.path, mergeSpec(defaultSpec, finalSpec) as any);\n    }\n\n    return this.#specs.get(conf.path);\n  }\n\n  /**\n   * Return the global api information.\n   */\n  protected getDefaultSpec(conf: Partial<SwaggerSettings>): Partial<OpenSpec3> {\n    const {version = \"1.0.0\", acceptMimes} = this.configuration;\n    const {specPath, specVersion} = conf;\n    const fileSpec: Partial<OpenSpec3> = specPath ? this.readSpecPath(specPath) : {};\n\n    return mapOpenSpec(getValue(conf, \"spec\", {}), {\n      fileSpec,\n      version,\n      specVersion,\n      acceptMimes\n    });\n  }\n\n  protected readSpecPath(path: string) {\n    path = this.configuration.resolve(path);\n    if (Fs.existsSync(path)) {\n      const json = Fs.readFileSync(path, {encoding: \"utf8\"});\n      /* istanbul ignore else */\n      if (json !== \"\") {\n        return JSON.parse(json);\n      }\n    }\n\n    return {};\n  }\n\n  /**\n   *\n   * @param ctrl\n   * @param options\n   */\n  protected buildRoutes(ctrl: ControllerProvider, options: SpecSerializerOptions) {\n    const rootPath = options.rootPath + ctrl.path;\n\n    ctrl.children\n      .map((ctrl) => this.injectorService.getProvider(ctrl))\n      .forEach((provider: ControllerProvider) => {\n        if (!provider.store.get(\"hidden\")) {\n          const spec = this.buildRoutes(provider, {\n            ...options,\n            rootPath\n          });\n\n          options.append(spec);\n        }\n      });\n\n    return getSpec(ctrl.token, options);\n  }\n}\n"]}

package/lib/esm/utils/includeRoute.js

@@ -0,0 +1,16 @@
+import { matchPath } from ".";
+export function includeRoute(route, provider, conf) {
+    const hidden = provider.store.get("hidden");
+    const docs = provider.store.get("docs") || [];
+    const { doc, pathPatterns } = conf;
+    const inDoc = doc && docs.indexOf(doc) > -1;
+    const pathPatternMatch = pathPatterns && matchPath(route, pathPatterns);
+    if (hidden) {
+        return false;
+    }
+    if (!doc && !pathPatterns) {
+        return true;
+    }
+    return !!(inDoc || pathPatternMatch);
+}
+//# sourceMappingURL=includeRoute.js.map

package/lib/esm/utils/includeRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"includeRoute.js","sourceRoot":"","sources":["../../../src/utils/includeRoute.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,SAAS,EAAC,MAAM,GAAG,CAAC;AAG5B,MAAM,UAAU,YAAY,CAAC,KAAa,EAAE,QAA4B,EAAE,IAAqB;IAC7F,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC9C,MAAM,EAAC,GAAG,EAAE,YAAY,EAAC,GAAG,IAAI,CAAC;IACjC,MAAM,KAAK,GAAG,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,MAAM,gBAAgB,GAAG,YAAY,IAAI,SAAS,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAExE,IAAI,MAAM,EAAE;QACV,OAAO,KAAK,CAAC;KACd;IAED,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE;QACzB,OAAO,IAAI,CAAC;KACb;IAED,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,gBAAgB,CAAC,CAAC;AACvC,CAAC","sourcesContent":["import {ControllerProvider} from \"@tsed/common\";\nimport {matchPath} from \".\";\nimport {SwaggerSettings} from \"..\";\n\nexport function includeRoute(route: string, provider: ControllerProvider, conf: SwaggerSettings): boolean {\n  const hidden = provider.store.get(\"hidden\");\n  const docs = provider.store.get(\"docs\") || [];\n  const {doc, pathPatterns} = conf;\n  const inDoc = doc && docs.indexOf(doc) > -1;\n  const pathPatternMatch = pathPatterns && matchPath(route, pathPatterns);\n\n  if (hidden) {\n    return false;\n  }\n\n  if (!doc && !pathPatterns) {\n    return true;\n  }\n\n  return !!(inDoc || pathPatternMatch);\n}\n"]}

package/lib/esm/utils/index.js

@@ -0,0 +1,6 @@
+export * from "./mapOpenSpec";
+export * from "./mapOpenSpec3";
+export * from "./mapOpenSpecInfo";
+export * from "./mapOpenSpecInfo";
+export * from "./matchPath";
+//# sourceMappingURL=index.js.map

package/lib/esm/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC","sourcesContent":["export * from \"./mapOpenSpec\";\nexport * from \"./mapOpenSpec3\";\nexport * from \"./mapOpenSpecInfo\";\nexport * from \"./mapOpenSpecInfo\";\nexport * from \"./matchPath\";\n"]}

package/lib/esm/utils/mapOpenSpec.js

@@ -0,0 +1,25 @@
+import { getValue, setValue } from "@tsed/core";
+import { mergeSpec } from "@tsed/schema";
+import { mapOpenSpec3 } from "./mapOpenSpec3";
+/**
+ * @ignore
+ * @param spec
+ * @param fileSpec
+ * @param version
+ * @param acceptMimes
+ * @param specVersion
+ */
+export function mapOpenSpec(spec, { fileSpec, acceptMimes, specVersion, version }) {
+    specVersion = specVersion || getValue(spec, "openapi", "3.0.1");
+    const options = {
+        specVersion,
+        acceptMimes
+    };
+    spec = mapOpenSpec3(spec, options);
+    fileSpec = fileSpec ? mapOpenSpec3(fileSpec, options) : fileSpec;
+    spec = mergeSpec(spec, fileSpec);
+    setValue(spec, "info.title", getValue(spec, "info.title", "Api documentation"));
+    setValue(spec, "info.version", getValue(spec, "info.version", version));
+    return spec;
+}
+//# sourceMappingURL=mapOpenSpec.js.map

package/lib/esm/utils/mapOpenSpec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapOpenSpec.js","sourceRoot":"","sources":["../../../src/utils/mapOpenSpec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAE,QAAQ,EAAC,MAAM,YAAY,CAAC;AAE9C,OAAO,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AACvC,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,IAAS,EAAE,EAAC,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAM;IACvF,WAAW,GAAG,WAAW,IAAI,QAAQ,CAAmB,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAElF,MAAM,OAAO,GAAG;QACd,WAAW;QACX,WAAW;KACZ,CAAC;IAEF,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnC,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAEjE,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAEjC,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAChF,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;IAExE,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import {getValue, setValue} from \"@tsed/core\";\nimport {OpenSpec3, OpenSpecVersions} from \"@tsed/openspec\";\nimport {mergeSpec} from \"@tsed/schema\";\nimport {mapOpenSpec3} from \"./mapOpenSpec3\";\n\n/**\n * @ignore\n * @param spec\n * @param fileSpec\n * @param version\n * @param acceptMimes\n * @param specVersion\n */\nexport function mapOpenSpec(spec: any, {fileSpec, acceptMimes, specVersion, version}: any): Partial<OpenSpec3> {\n  specVersion = specVersion || getValue<OpenSpecVersions>(spec, \"openapi\", \"3.0.1\");\n\n  const options = {\n    specVersion,\n    acceptMimes\n  };\n\n  spec = mapOpenSpec3(spec, options);\n  fileSpec = fileSpec ? mapOpenSpec3(fileSpec, options) : fileSpec;\n\n  spec = mergeSpec(spec, fileSpec);\n\n  setValue(spec, \"info.title\", getValue(spec, \"info.title\", \"Api documentation\"));\n  setValue(spec, \"info.version\", getValue(spec, \"info.version\", version));\n\n  return spec;\n}\n"]}

package/lib/esm/utils/mapOpenSpec3.js

@@ -0,0 +1,22 @@
+import { getValue } from "@tsed/core";
+import { mapOpenSpecInfo } from "./mapOpenSpecInfo";
+/**
+ * @ignore
+ * @param spec
+ * @param version
+ * @param specVersion
+ */
+export function mapOpenSpec3(spec, { specVersion }) {
+    const { servers, paths, components, security, tags, externalDocs } = spec;
+    return {
+        openapi: specVersion,
+        info: mapOpenSpecInfo(getValue(spec, "info", {})),
+        servers,
+        paths,
+        components,
+        security,
+        tags,
+        externalDocs
+    };
+}
+//# sourceMappingURL=mapOpenSpec3.js.map

package/lib/esm/utils/mapOpenSpec3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapOpenSpec3.js","sourceRoot":"","sources":["../../../src/utils/mapOpenSpec3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AAEpC,OAAO,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAElD;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,IAAS,EAAE,EAAC,WAAW,EAAM;IACxD,MAAM,EAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAC,GAAG,IAAI,CAAC;IAExE,OAAO;QACL,OAAO,EAAE,WAAW;QACpB,IAAI,EAAE,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACjD,OAAO;QACP,KAAK;QACL,UAAU;QACV,QAAQ;QACR,IAAI;QACJ,YAAY;KACb,CAAC;AACJ,CAAC","sourcesContent":["import {getValue} from \"@tsed/core\";\nimport {OpenSpec3} from \"@tsed/openspec\";\nimport {mapOpenSpecInfo} from \"./mapOpenSpecInfo\";\n\n/**\n * @ignore\n * @param spec\n * @param version\n * @param specVersion\n */\nexport function mapOpenSpec3(spec: any, {specVersion}: any): Partial<OpenSpec3> {\n  const {servers, paths, components, security, tags, externalDocs} = spec;\n\n  return {\n    openapi: specVersion,\n    info: mapOpenSpecInfo(getValue(spec, \"info\", {})),\n    servers,\n    paths,\n    components,\n    security,\n    tags,\n    externalDocs\n  };\n}\n"]}

package/lib/esm/utils/mapOpenSpecInfo.js

@@ -0,0 +1,17 @@
+import { cleanObject } from "@tsed/core";
+/**
+ * @ignore
+ * @param info
+ */
+export function mapOpenSpecInfo(info) {
+    const { title, description, version, termsOfService, contact, license } = info;
+    return cleanObject({
+        version,
+        title,
+        description,
+        termsOfService,
+        contact,
+        license
+    });
+}
+//# sourceMappingURL=mapOpenSpecInfo.js.map

package/lib/esm/utils/mapOpenSpecInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapOpenSpecInfo.js","sourceRoot":"","sources":["../../../src/utils/mapOpenSpecInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,YAAY,CAAC;AAGvC;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,IAA2B;IACzD,MAAM,EAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC;IAE7E,OAAO,WAAW,CAAC;QACjB,OAAO;QACP,KAAK;QACL,WAAW;QACX,cAAc;QACd,OAAO;QACP,OAAO;KACR,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {cleanObject} from \"@tsed/core\";\nimport {OpenSpecInfo} from \"@tsed/openspec\";\n\n/**\n * @ignore\n * @param info\n */\nexport function mapOpenSpecInfo(info: Partial<OpenSpecInfo>): OpenSpecInfo {\n  const {title, description, version, termsOfService, contact, license} = info;\n\n  return cleanObject({\n    version,\n    title,\n    description,\n    termsOfService,\n    contact,\n    license\n  });\n}\n"]}

package/lib/esm/utils/matchPath.js

@@ -0,0 +1,5 @@
+import micromatch from "micromatch";
+export function matchPath(path, patterns) {
+    return patterns && patterns.length ? micromatch.isMatch(path, patterns) : true;
+}
+//# sourceMappingURL=matchPath.js.map

package/lib/esm/utils/matchPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchPath.js","sourceRoot":"","sources":["../../../src/utils/matchPath.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,YAAY,CAAC;AAEpC,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,QAAmB;IACzD,OAAO,QAAQ,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACjF,CAAC","sourcesContent":["import micromatch from \"micromatch\";\n\nexport function matchPath(path: string, patterns?: string[]) {\n  return patterns && patterns.length ? micromatch.isMatch(path, patterns) : true;\n}\n"]}

package/lib/{SwaggerModule.d.ts → types/SwaggerModule.d.ts}

@@ -1,20 +1,21 @@
-import { BeforeRoutesInit, Configuration, InjectorService, OnReady, PlatformApplication } from "@tsed/common";
-import { SwaggerSettings } from "./interfaces";
+import { OnRoutesInit, Configuration, InjectorService, OnReady, PlatformApplication } from "@tsed/common";
 import { SwaggerService } from "./services/SwaggerService";
+import { Env } from "@tsed/core";
 /**
  * @ignore
  */
-export declare class SwaggerModule implements BeforeRoutesInit, OnReady {
+export declare class SwaggerModule implements OnRoutesInit, OnReady {
     injector: InjectorService;
     app: PlatformApplication;
     configuration: Configuration;
     swaggerService: SwaggerService;
+    env: Env;
     private loaded;
-    get settings(): SwaggerSettings[];
+    get settings(): import("./interfaces").SwaggerOS3Settings[];
     /**
      *
      */
-    $beforeRoutesInit(): void;
+    $onRoutesInit(): void;
     $onReady(): void;
     generateSpecFiles(): Promise<void[]>;
     private getUrls;