@tsed/swagger 7.0.0-beta.3 → 7.0.0-beta.4

package/lib/esm/services/SwaggerService.js

@@ -1,11 +1,8 @@
 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";
+import { generateSpec } from "@tsed/schema";
+import { includeRoute } from "../utils/includeRoute.js";
 let SwaggerService = class SwaggerService {
     constructor(injectorService, platform, configuration) {
         this.injectorService = injectorService;
@@ -13,83 +10,25 @@ let SwaggerService = class SwaggerService {
         this.configuration = configuration;
         _SwaggerService_specs.set(this, new Map());
     }
-    /**
-     * Generate Spec for the given configuration
-     * @returns {Spec}
-     */
-    getOpenAPISpec(conf) {
+    async 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);
-                }
+            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, mergeSpec(defaultSpec, finalSpec));
+            __classPrivateFieldGet(this, _SwaggerService_specs, "f").set(conf.path, spec);
         }
         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([

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

@@ -1 +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"]}
+{"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

@@ -1,4 +1,4 @@
-import { matchPath } from ".";
+import { matchPath } from "./matchPath.js";
 export function includeRoute(route, provider, conf) {
     const hidden = provider.store.get("hidden");
     const docs = provider.store.get("docs") || [];

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

@@ -1 +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"]}
+{"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/types/SwaggerModule.d.ts

@@ -1,4 +1,5 @@
 import { OnRoutesInit, Configuration, InjectorService, OnReady, PlatformApplication } from "@tsed/common";
+import { SwaggerSettings } from "./interfaces/SwaggerSettings";
 import { SwaggerService } from "./services/SwaggerService";
 import { Env } from "@tsed/core";
 /**
@@ -11,7 +12,7 @@ export declare class SwaggerModule implements OnRoutesInit, OnReady {
     swaggerService: SwaggerService;
     env: Env;
     private loaded;
-    get settings(): import("./interfaces").SwaggerOS3Settings[];
+    get settings(): SwaggerSettings[];
     /**
      *
      */

package/lib/types/index.d.ts

@@ -1,5 +1,15 @@
-export * from "./services/SwaggerService";
+/**
+ * @file Automatically generated by barrelsby.
+ */
 export * from "./SwaggerModule";
-export * from "./interfaces";
 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/types/interfaces/SwaggerSettings.d.ts

@@ -1,4 +1,4 @@
-import { OpenSpec3, OpenSpecVersions, OS3Versions } from "@tsed/openspec";
+import { OpenSpec2, OpenSpec3, OpenSpecVersions, OS2Versions, OS3Versions } from "@tsed/openspec";
 export interface SwaggerUIOptions {
     configUrl?: string;
     url?: string;
@@ -79,6 +79,13 @@ export interface SwaggerSettingsBase {
      */
     pathPatterns?: string[];
 }
+export interface SwaggerOS2Settings extends SwaggerSettingsBase {
+    specVersion?: OS2Versions;
+    /**
+     * OpenSpec 2
+     */
+    spec?: Partial<OpenSpec2>;
+}
 export interface SwaggerOS3Settings extends SwaggerSettingsBase {
     specVersion?: OS3Versions;
     /**
@@ -86,4 +93,4 @@ export interface SwaggerOS3Settings extends SwaggerSettingsBase {
      */
     spec?: Partial<OpenSpec3>;
 }
-export declare type SwaggerSettings = SwaggerOS3Settings;
+export declare type SwaggerSettings = SwaggerOS2Settings | SwaggerOS3Settings;

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

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

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

@@ -1,7 +1,6 @@
-import { Configuration, ControllerProvider, InjectorService, Platform } from "@tsed/common";
-import { OpenSpec3 } from "@tsed/openspec";
-import { SpecSerializerOptions } from "@tsed/schema";
-import { SwaggerSettings } from "../interfaces/SwaggerSettings";
+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;
@@ -12,16 +11,7 @@ export declare class SwaggerService {
      * Generate Spec for the given configuration
      * @returns {Spec}
      */
-    getOpenAPISpec(conf: SwaggerSettings): OpenSpec3<import("@tsed/openspec").OS3Schema> | undefined;
-    /**
-     * Return the global api information.
-     */
-    protected getDefaultSpec(conf: Partial<SwaggerSettings>): Partial<OpenSpec3>;
-    protected readSpecPath(path: string): any;
-    /**
-     *
-     * @param ctrl
-     * @param options
-     */
-    protected buildRoutes(ctrl: ControllerProvider, options: SpecSerializerOptions): Partial<OpenSpec3<import("@tsed/openspec").OS3Schema>>;
+    getOpenAPISpec(conf: SwaggerOS3Settings): Promise<OpenSpec3>;
+    getOpenAPISpec(conf: SwaggerOS2Settings): Promise<OpenSpec2>;
+    getOpenAPISpec(conf: SwaggerSettings): Promise<OpenSpec2>;
 }

package/lib/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/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@tsed/swagger",
-  "version": "7.0.0-beta.3",
+  "version": "7.0.0-beta.4",
   "description": "Swagger package for Ts.ED framework",
   "private": false,
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
     "types": "./lib/types/index.d.ts",
@@ -13,38 +14,43 @@
     "default": "./lib/esm/index.js"
   },
   "scripts": {
-    "build": "yarn run build:esm && yarn run build:cjs && cp -r ./views ./lib/views",
+    "clean": "rm -rf lib",
+    "build": "yarn clean && yarn barrels && yarn run build:esm && yarn run build:cjs && cp -r ./views ./lib/views",
     "build:cjs": "tsc --build tsconfig.compile.json",
     "build:esm": "tsc --build tsconfig.compile.esm.json",
-    "start": "ts-node -r tsconfig-paths/register test/app/index.ts"
+    "barrels": "yarn barrelsby --delete -d ./src -e \"\\.spec\\.ts\" -e \"__mock__\" -e \".benchmark.ts\"",
+    "start": "ts-node -r tsconfig-paths/register test/app/index.ts",
+    "test": "cross-env NODE_ENV=test yarn jest --max-workers=2"
   },
   "dependencies": {
-    "fs-extra": "9.0.1",
-    "micromatch": "^4.0.2",
-    "swagger-ui-dist": "^3.46.0",
-    "tslib": "2.2.0"
+    "@tsed/openspec": "7.0.0-beta.4",
+    "fs-extra": "10.0.1",
+    "micromatch": "4.0.5",
+    "swagger-ui-dist": "^4.5.2",
+    "tslib": "2.3.1"
   },
   "devDependencies": {
-    "@tsed/common": "7.0.0-beta.3",
-    "@tsed/core": "7.0.0-beta.3",
-    "@tsed/di": "7.0.0-beta.3",
-    "@tsed/json-mapper": "7.0.0-beta.3",
-    "@tsed/openspec": "7.0.0-beta.3",
-    "@tsed/schema": "7.0.0-beta.3"
+    "@tsed/common": "7.0.0-beta.4",
+    "@tsed/core": "7.0.0-beta.4",
+    "@tsed/di": "7.0.0-beta.4",
+    "@tsed/json-mapper": "7.0.0-beta.4",
+    "@tsed/openspec": "7.0.0-beta.4",
+    "@tsed/schema": "7.0.0-beta.4",
+    "@types/swagger-ui-dist": ">=3.30.1"
   },
   "peerDependencies": {
-    "@tsed/common": "^7.0.0-beta.3",
-    "@tsed/core": "^7.0.0-beta.3",
-    "@tsed/di": "^7.0.0-beta.3",
-    "@tsed/json-mapper": "^7.0.0-beta.3",
-    "@tsed/openspec": "^7.0.0-beta.3",
-    "@tsed/schema": "^7.0.0-beta.3"
+    "@tsed/common": "^7.0.0-beta.4"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/common": {
+      "optional": false
+    }
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {
     "url": "https://github.com/tsedio/tsed/issues"
   },
-  "homepage": "https://github.com/tsedio/tsed/tree/beta/packages/specs/swagger",
+  "homepage": "https://github.com/tsedio/tsed/tree/production/packages/specs/swagger",
   "author": "Romain Lenzotti",
   "license": "MIT"
 }

package/readme.md

@@ -43,25 +43,22 @@ Then add the following configuration in your Server:
 import {Configuration} from "@tsed/common";
 import "@tsed/swagger"; // import swagger Ts.ED module
 import {resolve} from "path";
-const rootDir = resolve(__dirname)
 
 @Configuration({
-  rootDir,
   swagger: [
     {
-     path: "/v2/docs",
-     specVersion: "2.0"
+      path: "/v2/docs",
+      specVersion: "2.0"
     },
     {
-     path: "/v3/docs",
-     specVersion: "3.0.1"
+      path: "/v3/docs",
+      specVersion: "3.0.1"
     }
   ]
 })
-export class Server {
-
-}
+export class Server {}
 ```
+
 > The path option for swagger will be used to expose the documentation (ex: http://localhost:8000/api-docs).
 
 Normally, Swagger-ui is ready. You can start your server and check if it work fine.
@@ -72,21 +69,21 @@ Normally, Swagger-ui is ready. You can start your server and check if it work fi
 
 Some options is available to configure Swagger-ui, Ts.ED and the default spec information.
 
-Key | Example | Description
----|---|---
-path | `/api-doc` |  The url subpath to access to the documentation.
-specVersion | `2.0`, `3.0.1`  | The spec version.
-doc | `hidden-doc` |  The documentation key used by `@Docs` decorator to create several swagger documentations.
-cssPath | `${rootDir}/spec/style.css` | The path to the CSS file.
-jsPath | `${rootDir}/spec/main.js` | The path to the JS file.
-showExplorer | `true` | Display the search field in the navbar.
-spec | `{swagger: "2.0"}` | The default information spec.
-specPath | `${rootDir}/spec/swagger.base.json` | Load the base spec documentation from the specified path.
-outFile | `${rootDir}/spec/swagger.json` | Write the `swagger.json` spec documentation on the specified path.
-hidden | `true` | Hide the documentation in the dropdown explorer list.
-options | Swagger-UI options | SwaggerUI options. See (https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md)
-operationIdFormatter | `(name: string, propertyKey: string, path: string) => string` | A function to generate the operationId.
-operationIdPattern | `%c_%m` | A pattern to generate the operationId. Format of operationId field (%c: class name, %m: method name).
+| Key                  | Example                                                       | Description                                                                                              |
+| -------------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
+| path                 | `/api-doc`                                                    | The url subpath to access to the documentation.                                                          |
+| specVersion          | `2.0`, `3.0.1`                                                | The spec version.                                                                                        |
+| doc                  | `hidden-doc`                                                  | The documentation key used by `@Docs` decorator to create several swagger documentations.                |
+| cssPath              | `${rootDir}/spec/style.css`                                   | The path to the CSS file.                                                                                |
+| jsPath               | `${rootDir}/spec/main.js`                                     | The path to the JS file.                                                                                 |
+| showExplorer         | `true`                                                        | Display the search field in the navbar.                                                                  |
+| spec                 | `{swagger: "2.0"}`                                            | The default information spec.                                                                            |
+| specPath             | `${rootDir}/spec/swagger.base.json`                           | Load the base spec documentation from the specified path.                                                |
+| outFile              | `${rootDir}/spec/swagger.json`                                | Write the `swagger.json` spec documentation on the specified path.                                       |
+| hidden               | `true`                                                        | Hide the documentation in the dropdown explorer list.                                                    |
+| options              | Swagger-UI options                                            | SwaggerUI options. See (https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md) |
+| operationIdFormatter | `(name: string, propertyKey: string, path: string) => string` | A function to generate the operationId.                                                                  |
+| operationIdPattern   | `%c_%m`                                                       | A pattern to generate the operationId. Format of operationId field (%c: class name, %m: method name).    |
 
 ### Multi documentations
 
@@ -97,21 +94,18 @@ import {Configuration} from "@tsed/common";
 import "@tsed/swagger"; // import swagger Ts.ED module
 
 @Configuration({
-  rootDir: __dirname,
   swagger: [
     {
       path: "/api-docs-v1",
-      doc: 'api-v1'
+      doc: "api-v1"
     },
     {
       path: "/api-docs-v2",
-      doc: 'api-v2'
+      doc: "api-v2"
     }
   ]
 })
-export class Server {
-
-}
+export class Server {}
 ```
 
 Then use `@Docs` decorators on your controllers to specify where the controllers should be displayed.
@@ -120,19 +114,17 @@ Then use `@Docs` decorators on your controllers to specify where the controllers
 import {Controller} from "@tsed/common";
 import {Docs} from "@tsed/swagger";
 
-@Controller('/calendars')
-@Docs('api-v2') // display this controllers only for api-docs-v2
-export class CalendarCtrlV2 {
-}
-// OR 
-@Controller('/calendars')
-@Docs('api-v2', 'api-v1')  // display this controllers for api-docs-v2 and api-docs-v1
-export class CalendarCtrl {
-
-}
-``` 
+@Controller("/calendars")
+@Docs("api-v2") // display this controllers only for api-docs-v2
+export class CalendarCtrlV2 {}
+// OR
+@Controller("/calendars")
+@Docs("api-v2", "api-v1") // display this controllers for api-docs-v2 and api-docs-v1
+export class CalendarCtrl {}
+```
 
 ## Examples
+
 #### Model documentation
 
 One of the feature of Ts.ED is the model definition to serialize or deserialize a
@@ -162,57 +154,55 @@ import {BodyParams, Controller, Get, Post, QueryParams, Returns, ReturnsArray, D
 import {Summary, Deprecated, Security} from "@tsed/swagger";
 import {CalendarModel} from "../models/CalendarModel";
 
-@Controller('/calendars')
+@Controller("/calendars")
 export class Calendar {
-    @Get('/:id')
-    @Summary("Summary of this route")
-    @Description("Description of this route")
-    @Returns(CalendarModel)
-    @Returns(404, {description: "Not found"})
-    async getCalendar(@QueryParams('id') id: string): Promise<CalendarModel> {
-      //...
-    }
-    
-    @Get('/v0/:id')
-    @Deprecated()
-    @Description("Deprecated route, use /rest/calendars/:id instead of.")
-    @Returns(CalendarModel)
-    @Returns(404, {description: "Not found"})
-    getCalendarDeprecated(@QueryParams('id') id: string): Promise<CalendarModel> {
-      //...
-    }
-
-    @Get('/')
-    @Description("Description of this route")
-    @ReturnsArray(CalendarModel)
-    getCalendars(): Promise<CalendarModel[]> {
-      // ...
-    }
-
-    @Post('/')
-    @Security("calendar_auth", "write:calendar", "read:calendar")
-    @Returns(CalendarModel)
-    async createCalendar(@BodyParams() body: any): Promise<CalendarModel> {
-        //...
-    }
+  @Get("/:id")
+  @Summary("Summary of this route")
+  @Description("Description of this route")
+  @Returns(CalendarModel)
+  @Returns(404, {description: "Not found"})
+  async getCalendar(@QueryParams("id") id: string): Promise<CalendarModel> {
+    //...
+  }
+
+  @Get("/v0/:id")
+  @Deprecated()
+  @Description("Deprecated route, use /rest/calendars/:id instead of.")
+  @Returns(CalendarModel)
+  @Returns(404, {description: "Not found"})
+  getCalendarDeprecated(@QueryParams("id") id: string): Promise<CalendarModel> {
+    //...
+  }
+
+  @Get("/")
+  @Description("Description of this route")
+  @ReturnsArray(CalendarModel)
+  getCalendars(): Promise<CalendarModel[]> {
+    // ...
+  }
+
+  @Post("/")
+  @Security("calendar_auth", "write:calendar", "read:calendar")
+  @Returns(CalendarModel)
+  async createCalendar(@BodyParams() body: any): Promise<CalendarModel> {
+    //...
+  }
 }
 ```
+
 ::: warninig
 To update the swagger.json you need to reload the server before.
 :::
 
-
 ## Import Javascript
 
-It possible to import a Javascript in the Swagger-ui documentation. This script let you customize the swagger-ui instance. 
-
+It possible to import a Javascript in the Swagger-ui documentation. This script let you customize the swagger-ui instance.
 
 ```typescript
 import {Configuration} from "@tsed/common";
 import "@tsed/swagger"; // import swagger Ts.ED module
 
 @Configuration({
-  rootDir: __dirname,
   swagger: [
     {
       path: "/api-docs",
@@ -220,9 +210,7 @@ import "@tsed/swagger"; // import swagger Ts.ED module
     }
   ]
 })
-export class Server {
-
-}
+export class Server {}
 ```
 
 In your JavaScript file, you can handle Swagger-ui configuration and the instance:
@@ -230,8 +218,8 @@ In your JavaScript file, you can handle Swagger-ui configuration and the instanc
 ```javascript
 console.log(SwaggerUIBuilder.config); //Swagger-ui config
 
-document.addEventListener('swagger.init', (evt) => {
-    console.log(SwaggerUIBuilder.ui); //Swagger-ui instance
+document.addEventListener("swagger.init", (evt) => {
+  console.log(SwaggerUIBuilder.ui); //Swagger-ui instance
 });
 ```
 
@@ -239,20 +227,18 @@ document.addEventListener('swagger.init', (evt) => {
 
 See our documentation https://tsed.io/#/api/index
 
-
 ## Contributors
+
 Please read [contributing guidelines here](https://tsed.io/CONTRIBUTING.html).
 
 <a href="https://github.com/tsedio/ts-express-decorators/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
 
-
 ## Backers
 
 Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
 
 <a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
 
-
 ## Sponsors
 
 Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]

package/lib/cjs/interfaces/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./SwaggerSettings"), exports);
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":";;;AAUA,iEAAkC","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/cjs/utils/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./mapOpenSpec"), exports);
-(0, tslib_1.__exportStar)(require("./mapOpenSpec3"), exports);
-(0, tslib_1.__exportStar)(require("./mapOpenSpecInfo"), exports);
-(0, tslib_1.__exportStar)(require("./mapOpenSpecInfo"), exports);
-(0, tslib_1.__exportStar)(require("./matchPath"), exports);
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,6DAA8B;AAC9B,8DAA+B;AAC/B,iEAAkC;AAClC,iEAAkC;AAClC,2DAA4B","sourcesContent":["export * from \"./mapOpenSpec\";\nexport * from \"./mapOpenSpec3\";\nexport * from \"./mapOpenSpecInfo\";\nexport * from \"./mapOpenSpecInfo\";\nexport * from \"./matchPath\";\n"]}