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

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,16 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from "./SwaggerModule.js";
+export * from "./decorators/docs.js";
+export * from "./decorators/hidden.js";
+export * from "./interfaces/SwaggerSettings.js";
+export * from "./interfaces/interfaces.js";
+export * from "./middlewares/cssMiddleware.js";
+export * from "./middlewares/indexMiddleware.js";
+export * from "./middlewares/jsMiddleware.js";
+export * from "./middlewares/redirectMiddleware.js";
+export * from "./services/SwaggerService.js";
+export * from "./utils/includeRoute.js";
+export * from "./utils/matchPath.js";
+//# 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;;GAEG;AAEH,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC","sourcesContent":["/**\n * @file Automatically generated by barrelsby.\n */\n\nexport * from \"./SwaggerModule\";\nexport * from \"./decorators/docs\";\nexport * from \"./decorators/hidden\";\nexport * from \"./interfaces/SwaggerSettings\";\nexport * from \"./interfaces/interfaces\";\nexport * from \"./middlewares/cssMiddleware\";\nexport * from \"./middlewares/indexMiddleware\";\nexport * from \"./middlewares/jsMiddleware\";\nexport * from \"./middlewares/redirectMiddleware\";\nexport * from \"./services/SwaggerService\";\nexport * from \"./utils/includeRoute\";\nexport * from \"./utils/matchPath\";\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 {OpenSpec2, OpenSpec3, OpenSpecVersions, OS2Versions, 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 SwaggerOS2Settings extends SwaggerSettingsBase {\n  specVersion?: OS2Versions;\n  /**\n   * OpenSpec 2\n   */\n  spec?: Partial<OpenSpec2>;\n}\n\nexport interface SwaggerOS3Settings extends SwaggerSettingsBase {\n  specVersion?: OS3Versions;\n  /**\n   * OpenSpec 3\n   */\n  spec?: Partial<OpenSpec3>;\n}\n\nexport type SwaggerSettings = SwaggerOS2Settings | SwaggerOS3Settings;\n"]}

package/lib/esm/interfaces/interfaces.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/interfaces/interfaces.ts"],"names":[],"mappings":"","sourcesContent":["import {SwaggerSettings} from \"./SwaggerSettings\";\n\ndeclare global {\n  namespace TsED {\n    interface Configuration {\n      swagger: SwaggerSettings[];\n    }\n  }\n}\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/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/lib/esm/services/SwaggerService.js

@@ -0,0 +1,41 @@
+var _SwaggerService_specs;
+import { __classPrivateFieldGet, __decorate, __metadata, __param } from "tslib";
+import { Configuration, Injectable, InjectorService, Platform } from "@tsed/common";
+import { generateSpec } from "@tsed/schema";
+import { includeRoute } from "../utils/includeRoute.js";
+let SwaggerService = class SwaggerService {
+    constructor(injectorService, platform, configuration) {
+        this.injectorService = injectorService;
+        this.platform = platform;
+        this.configuration = configuration;
+        _SwaggerService_specs.set(this, new Map());
+    }
+    async getOpenAPISpec(conf) {
+        if (!__classPrivateFieldGet(this, _SwaggerService_specs, "f").has(conf.path)) {
+            const { version = "1.0.0", acceptMimes } = this.configuration;
+            const specPath = conf.specPath ? this.configuration.resolve(conf.specPath) : conf.specPath;
+            const tokens = this.platform
+                .getMountedControllers()
+                .filter(({ route, provider }) => includeRoute(route, provider, conf))
+                .map(({ route, provider }) => ({ token: provider.token, rootPath: route.replace(provider.path, "") }));
+            const spec = await generateSpec({
+                tokens,
+                ...conf,
+                specPath,
+                version,
+                acceptMimes
+            });
+            __classPrivateFieldGet(this, _SwaggerService_specs, "f").set(conf.path, spec);
+        }
+        return __classPrivateFieldGet(this, _SwaggerService_specs, "f").get(conf.path);
+    }
+};
+_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,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAC,MAAM,cAAc,CAAC;AAElF,OAAO,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAGnD,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,gCAA6C,IAAI,GAAG,EAAE,EAAC;IAMpD,CAAC;IASG,KAAK,CAAC,cAAc,CAAC,IAAqB;QAC/C,IAAI,CAAC,uBAAA,IAAI,6BAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC/B,MAAM,EAAC,OAAO,GAAG,OAAO,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC,aAAa,CAAC;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;YAE3F,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ;iBACzB,qBAAqB,EAAE;iBACvB,MAAM,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,EAAC,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;iBAClE,GAAG,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;YAErG,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC;gBAC9B,MAAM;gBACN,GAAG,IAAI;gBACP,QAAQ;gBACR,OAAO;gBACP,WAAW;aACZ,CAAC,CAAC;YAEH,uBAAA,IAAI,6BAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;SAClC;QAED,OAAO,uBAAA,IAAI,6BAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF,CAAA;;AAvCY,cAAc;IAD1B,UAAU,EAAE;IAOR,WAAA,aAAa,EAAE,CAAA;qCAFS,eAAe;QACtB,QAAQ;GALjB,cAAc,CAuC1B;SAvCY,cAAc","sourcesContent":["import {Configuration, Injectable, InjectorService, Platform} from \"@tsed/common\";\nimport {OpenSpec2, OpenSpec3} from \"@tsed/openspec\";\nimport {generateSpec} from \"@tsed/schema\";\nimport {SwaggerOS2Settings, SwaggerOS3Settings, SwaggerSettings} from \"../interfaces/SwaggerSettings\";\nimport {includeRoute} from \"../utils/includeRoute\";\n\n@Injectable()\nexport class SwaggerService {\n  #specs: Map<string, OpenSpec3 | OpenSpec2> = 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 async getOpenAPISpec(conf: SwaggerOS3Settings): Promise<OpenSpec3>;\n  public async getOpenAPISpec(conf: SwaggerOS2Settings): Promise<OpenSpec2>;\n  public async getOpenAPISpec(conf: SwaggerSettings): Promise<OpenSpec2>;\n  public async getOpenAPISpec(conf: SwaggerSettings) {\n    if (!this.#specs.has(conf.path)) {\n      const {version = \"1.0.0\", acceptMimes} = this.configuration;\n      const specPath = conf.specPath ? this.configuration.resolve(conf.specPath) : conf.specPath;\n\n      const tokens = this.platform\n        .getMountedControllers()\n        .filter(({route, provider}) => includeRoute(route, provider, conf))\n        .map(({route, provider}) => ({token: provider.token, rootPath: route.replace(provider.path, \"\")}));\n\n      const spec = await generateSpec({\n        tokens,\n        ...conf,\n        specPath,\n        version,\n        acceptMimes\n      });\n\n      this.#specs.set(conf.path, spec);\n    }\n\n    return this.#specs.get(conf.path);\n  }\n}\n"]}

package/lib/esm/utils/includeRoute.js

@@ -0,0 +1,16 @@
+import { matchPath } from "./matchPath.js";
+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,aAAa,CAAC;AAGtC,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 \"./matchPath\";\nimport {SwaggerSettings} from \"../interfaces/SwaggerSettings\";\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/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,22 @@
-import { BeforeRoutesInit, Configuration, InjectorService, OnReady, PlatformApplication } from "@tsed/common";
-import { SwaggerSettings } from "./interfaces";
+import { OnRoutesInit, Configuration, InjectorService, OnReady, PlatformApplication } from "@tsed/common";
+import { SwaggerSettings } from "./interfaces/SwaggerSettings";
 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[];
     /**
      *
      */
-    $beforeRoutesInit(): void;
+    $onRoutesInit(): void;
     $onReady(): void;
     generateSpecFiles(): Promise<void[]>;
     private getUrls;

package/lib/types/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from "./SwaggerModule";
+export * from "./decorators/docs";
+export * from "./decorators/hidden";
+export * from "./interfaces/SwaggerSettings";
+export * from "./interfaces/interfaces";
+export * from "./middlewares/cssMiddleware";
+export * from "./middlewares/indexMiddleware";
+export * from "./middlewares/jsMiddleware";
+export * from "./middlewares/redirectMiddleware";
+export * from "./services/SwaggerService";
+export * from "./utils/includeRoute";
+export * from "./utils/matchPath";

package/lib/{interfaces → types/interfaces}/SwaggerSettings.d.ts

@@ -79,9 +79,6 @@ export interface SwaggerSettingsBase {
      */
     pathPatterns?: string[];
 }
-/**
- * @deprecated Since 2021-09-03. Will be removed in v7.
- */
 export interface SwaggerOS2Settings extends SwaggerSettingsBase {
     specVersion?: OS2Versions;
     /**

package/lib/{interfaces/index.d.ts → types/interfaces/interfaces.d.ts}

@@ -6,4 +6,3 @@ declare global {
         }
     }
 }
-export * from "./SwaggerSettings";

package/lib/types/services/SwaggerService.d.ts

@@ -0,0 +1,17 @@
+import { Configuration, InjectorService, Platform } from "@tsed/common";
+import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
+import { SwaggerOS2Settings, SwaggerOS3Settings, SwaggerSettings } from "../interfaces/SwaggerSettings";
+export declare class SwaggerService {
+    #private;
+    private injectorService;
+    private platform;
+    private configuration;
+    constructor(injectorService: InjectorService, platform: Platform, configuration: Configuration);
+    /**
+     * Generate Spec for the given configuration
+     * @returns {Spec}
+     */
+    getOpenAPISpec(conf: SwaggerOS3Settings): Promise<OpenSpec3>;
+    getOpenAPISpec(conf: SwaggerOS2Settings): Promise<OpenSpec2>;
+    getOpenAPISpec(conf: SwaggerSettings): Promise<OpenSpec2>;
+}

package/lib/{utils → types/utils}/includeRoute.d.ts

@@ -1,3 +1,3 @@
 import { ControllerProvider } from "@tsed/common";
-import { SwaggerSettings } from "..";
+import { SwaggerSettings } from "../interfaces/SwaggerSettings";
 export declare function includeRoute(route: string, provider: ControllerProvider, conf: SwaggerSettings): boolean;

package/lib/views/index.ejs

@@ -0,0 +1,145 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700"
+          rel="stylesheet">
+    <link rel="stylesheet" type="text/css" href="./swagger-ui.css">
+    <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32"/>
+    <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16"/>
+    <style>
+        html {
+            box-sizing: border-box;
+            overflow: -moz-scrollbars-vertical;
+            overflow-y: scroll;
+        }
+
+        *,
+        *:before,
+        *:after {
+            box-sizing: inherit;
+        }
+
+        body {
+            margin: 0;
+            background: #fafafa;
+        }
+
+        <% if (!showExplorer) { %>
+        .swagger-ui .topbar .download-url-wrapper {
+            display: none
+        }
+
+        <% } %>
+    </style>
+    <% if (cssPath) { %>
+    <link rel="stylesheet" type="text/css" href="./main.css">
+    <% } %>
+</head>
+
+<body>
+<div id="swagger-ui"></div>
+
+<script src="./swagger-ui-bundle.js"></script>
+<script src="./swagger-ui-standalone-preset.js"></script>
+<script>
+  if (typeof Object.assign !== 'function') {
+    // Must be writable: true, enumerable: false, configurable: true
+    Object.defineProperty(Object, "assign", {
+      value: function assign(target, varArgs) { // .length of function is 2
+        'use strict';
+        if (target == null) { // TypeError if undefined or null
+          throw new TypeError('Cannot convert undefined or null to object');
+        }
+
+        var to = Object(target);
+
+        for (var index = 1; index < arguments.length; index++) {
+          var nextSource = arguments[index];
+
+          if (nextSource != null) { // Skip over if undefined or null
+            for (var nextKey in nextSource) {
+              // Avoid bugs when hasOwnProperty is shadowed
+              if (Object.prototype.hasOwnProperty.call(nextSource, nextKey)) {
+                to[nextKey] = nextSource[nextKey];
+              }
+            }
+          }
+        }
+        return to;
+      },
+      writable: true,
+      configurable: true
+    });
+  }
+</script>
+<script>
+  const origin = window.location.origin;
+  const initialOptions = <%- JSON.stringify(swaggerOptions) %>;
+  const currentUrl = origin + "<%- url %>";
+  const urls = <%- JSON.stringify(urls) %>
+  .map(function (o) {
+    if (!o.url.match(/^https?:/)) {
+      const url = origin + o.url;
+      return {
+        name: o.name,
+        url: url,
+        selected: url === currentUrl
+      }
+    }
+    return o;
+  })
+    .sort(function (a, b) {
+      return a.selected ? -1 : 1
+    });
+
+  const SwaggerUIBuilder = {
+    config: Object.assign({
+      urls: urls,
+      dom_id: '#swagger-ui',
+      deepLinking: true,
+      presets: [
+        SwaggerUIBundle.presets.apis,
+        SwaggerUIStandalonePreset
+      ],
+      plugins: [
+        SwaggerUIBundle.plugins.DownloadUrl
+      ],
+      layout: "StandaloneLayout",
+      oauth2RedirectUrl: currentUrl.replace('swagger.json', 'oauth2-redirect.html'),
+      validatorUrl: origin.match('0.0.0.0') || origin.match('localhost') ? null : undefined
+    }, initialOptions),
+    /**
+     *
+     */
+    init: function () {
+      this.ui = SwaggerUIBundle(this.config);
+
+      if (this.config.oauth) {
+        this.ui.initOAuth(this.config.oauth);
+      }
+
+      if (this.config.authorize) {
+        this.ui.authActions.authorize(this.config.authorize);
+      }
+
+      window.ui = this.ui;
+
+      const event = new Event('swagger.init');
+      document.dispatchEvent(event);
+    }
+  }
+
+</script>
+<% if (jsPath) { %>
+<script src="./main.js"></script>
+<% } %>
+<script>
+  window.onload = function () {
+    SwaggerUIBuilder.init();
+  }
+</script>
+
+</body>
+</html>