@tsed/swagger 8.1.0 → 8.3.0

package/lib/esm/SwaggerModule.js

@@ -1,105 +1,49 @@
-import Fs from "node:fs";
 import { join } from "node:path";
-import { Env } from "@tsed/core";
-import { configuration, constant, inject, injectable, logger, ProviderType } from "@tsed/di";
+import { constant, injectable, ProviderType } from "@tsed/di";
 import { normalizePath } from "@tsed/normalize-path";
-import { application } from "@tsed/platform-http";
-import { PlatformRouter, useContextHandler } from "@tsed/platform-router";
+import { OpenAPIBaseModule } from "@tsed/openapi-utils";
+import { useContextHandler } from "@tsed/platform-router";
 import { ROOT_DIR, SWAGGER_UI_DIST } from "./constants.js";
-import { cssMiddleware } from "./middlewares/cssMiddleware.js";
 import { indexMiddleware } from "./middlewares/indexMiddleware.js";
-import { jsMiddleware } from "./middlewares/jsMiddleware.js";
-import { redirectMiddleware } from "./middlewares/redirectMiddleware.js";
-import { SwaggerService } from "./services/SwaggerService.js";
-export class SwaggerModule {
+export class SwaggerModule extends OpenAPIBaseModule {
     constructor() {
-        this.swaggerService = inject(SwaggerService);
-        this.env = constant("env");
-        this.disableRoutesSummary = constant("logger.disableRoutesSummary");
-        this.loaded = false;
+        super(...arguments);
+        this.name = "Swagger";
+        this.rootDir = ROOT_DIR;
     }
     get settings() {
-        return constant("swagger", []).filter((o) => !!o);
-    }
-    /**
-     *
-     */
-    $onRoutesInit() {
-        if (this.loaded) {
-            return;
-        }
-        const urls = this.getUrls();
-        this.settings.forEach((conf) => {
-            const { path = "/" } = conf;
-            application().use(path, useContextHandler(redirectMiddleware(path)));
-            application().use(path, this.createRouter(conf, urls));
+        const settings = constant("swagger", []).filter((o) => !!o);
+        return settings.map((conf) => {
+            return Object.assign({
+                disableSpec: false,
+                path: "/",
+                fileName: "swagger.json",
+                cssPath: join(ROOT_DIR, "views/assets/swagger.css"),
+                viewPath: join(ROOT_DIR, "views/index.ejs")
+            }, conf);
         });
-        this.loaded = true;
     }
-    $onReady() {
-        // istanbul ignore next
-        if (configuration().getBestHost && !this.disableRoutesSummary) {
-            const host = configuration().getBestHost();
-            const url = host.toString();
-            const displayLog = (conf) => {
-                const { path = "/", fileName = "swagger.json", doc } = conf;
-                logger().info(`[${doc || "default"}] Swagger JSON is available on ${url}${normalizePath(path, fileName)}`);
-                logger().info(`[${doc || "default"}] Swagger UI is available on ${url}${path}/`);
-            };
-            this.settings.forEach((conf) => {
-                displayLog(conf);
-            });
+    createRouter(conf) {
+        const { viewPath } = conf;
+        const router = super.createRouter(conf);
+        if (viewPath) {
+            router.get("/", useContextHandler(indexMiddleware(viewPath, {
+                urls: this.getUrls(),
+                ...conf
+            })));
+            router.statics("/", { root: SWAGGER_UI_DIST });
         }
-        this.generateSpecFiles();
-    }
-    generateSpecFiles() {
-        return Promise.all(this.settings.map(async (conf) => {
-            const { outFile } = conf;
-            if (this.env === Env.PROD || outFile) {
-                const spec = await this.swaggerService.getOpenAPISpec(conf);
-                if (outFile) {
-                    return Fs.writeFile(outFile, JSON.stringify(spec, null, 2), { encoding: "utf8" }, () => { });
-                }
-            }
-        }));
+        return router;
     }
     getUrls() {
         return this.settings.reduce((acc, conf) => {
-            const { path = "/", fileName = "swagger.json", doc, hidden } = conf;
+            const { path, fileName, 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(ROOT_DIR, "../views/index.ejs") } = conf;
-        const router = new PlatformRouter();
-        if (!disableSpec) {
-            router.get(normalizePath("/", fileName), useContextHandler(this.middlewareSwaggerJson(conf)));
-        }
-        if (viewPath) {
-            if (cssPath) {
-                router.get("/main.css", useContextHandler(cssMiddleware(cssPath)));
-            }
-            if (jsPath) {
-                router.get("/main.js", useContextHandler(jsMiddleware(jsPath)));
-            }
-            router.get("/", useContextHandler(indexMiddleware(viewPath, { urls, ...conf })));
-            router.statics("/", { root: SWAGGER_UI_DIST });
-        }
-        return router;
-    }
-    middlewareSwaggerJson(conf) {
-        return async (ctx) => {
-            ctx.response.status(200).body(await this.swaggerService.getOpenAPISpec(conf));
-        };
-    }
 }
 injectable(SwaggerModule).type(ProviderType.MODULE);
 //# sourceMappingURL=SwaggerModule.js.map

package/lib/esm/SwaggerModule.js.map

@@ -1 +1 @@
-{"version":3,"file":"SwaggerModule.js","sourceRoot":"","sources":["../../src/SwaggerModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAE/B,OAAO,EAAC,GAAG,EAAC,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAC,MAAM,UAAU,CAAC;AAC3F,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,WAAW,EAAyC,MAAM,qBAAqB,CAAC;AACxF,OAAO,EAAC,cAAc,EAAE,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExE,OAAO,EAAC,QAAQ,EAAE,eAAe,EAAC,MAAM,gBAAgB,CAAC;AAEzD,OAAO,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAC,eAAe,EAAC,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAC,YAAY,EAAC,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAC,kBAAkB,EAAC,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAC,cAAc,EAAC,MAAM,8BAA8B,CAAC;AAE5D,MAAM,OAAO,aAAa;IAA1B;QACY,mBAAc,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;QACxC,QAAG,GAAG,QAAQ,CAAM,KAAK,CAAC,CAAC;QAC3B,yBAAoB,GAAG,QAAQ,CAAU,6BAA6B,CAAC,CAAC;QAE1E,WAAM,GAAG,KAAK,CAAC;IA4GzB,CAAC;IA1GC,IAAI,QAAQ;QACV,OAAO,QAAQ,CAAoB,SAAS,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,aAAa;QACX,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;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,WAAW,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACrE,WAAW,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACrB,CAAC;IAED,QAAQ;QACN,uBAAuB;QACvB,IAAI,aAAa,EAAE,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC9D,MAAM,IAAI,GAAG,aAAa,EAAE,CAAC,WAAW,EAAE,CAAC;YAC3C,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,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,SAAS,kCAAkC,GAAG,GAAG,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;gBAC3G,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,SAAS,gCAAgC,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC;YACnF,CAAC,CAAC;YAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC7B,UAAU,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAED,iBAAiB;QACf,OAAO,OAAO,CAAC,GAAG,CAChB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/B,MAAM,EAAC,OAAO,EAAC,GAAG,IAAI,CAAC;YAEvB,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC;gBACrC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBAE5D,IAAI,OAAO,EAAE,CAAC;oBACZ,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;gBAC5F,CAAC;YACH,CAAC;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,CAAC;gBACZ,GAAG,CAAC,IAAI,CAAC,EAAC,GAAG,EAAE,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAC,CAAC,CAAC;YACpE,CAAC;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,QAAQ,EAAE,oBAAoB,CAAC,EAAC,GAAG,IAAI,CAAC;QAChI,MAAM,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QAEpC,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChG,CAAC;QACD,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,iBAAiB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACrE,CAAC;YAED,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,iBAAiB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAClE,CAAC;YAED,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,iBAAiB,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,GAAG,IAAI,EAAC,CAAC,CAAC,CAAC,CAAC;YAC/E,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAC,IAAI,EAAE,eAAe,EAAC,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,qBAAqB,CAAC,IAAqB;QACjD,OAAO,KAAK,EAAE,GAAoB,EAAE,EAAE;YACpC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,CAAC,CAAC;IACJ,CAAC;CACF;AAED,UAAU,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC"}
+{"version":3,"file":"SwaggerModule.js","sourceRoot":"","sources":["../../src/SwaggerModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAE/B,OAAO,EAAC,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAC,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAC,QAAQ,EAAE,eAAe,EAAC,MAAM,gBAAgB,CAAC;AAEzD,OAAO,EAAC,eAAe,EAAC,MAAM,kCAAkC,CAAC;AAEjE,MAAM,OAAO,aAAc,SAAQ,iBAAiB;IAApD;;QACW,SAAI,GAAG,SAAS,CAAC;QACjB,YAAO,GAAG,QAAQ,CAAC;IAkD9B,CAAC;IAhDC,IAAI,QAAQ;QACV,MAAM,QAAQ,GAAG,QAAQ,CAAoB,SAAS,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/E,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3B,OAAO,MAAM,CAAC,MAAM,CAClB;gBACE,WAAW,EAAE,KAAK;gBAClB,IAAI,EAAE,GAAG;gBACT,QAAQ,EAAE,cAAc;gBACxB,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,0BAA0B,CAAC;gBACnD,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC;aAC5C,EACD,IAAI,CACL,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAES,YAAY,CAAC,IAAqB;QAC1C,MAAM,EAAC,QAAQ,EAAC,GAAG,IAAI,CAAC;QACxB,MAAM,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,CAAC,GAAG,CACR,GAAG,EACH,iBAAiB,CACf,eAAe,CAAC,QAAQ,EAAE;gBACxB,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;gBACpB,GAAG,IAAI;aACR,CAAC,CACH,CACF,CAAC;YACF,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAC,IAAI,EAAE,eAAe,EAAC,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,OAAO;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAU,EAAE,IAAI,EAAE,EAAE;YAC/C,MAAM,EAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAC,GAAG,IAAI,CAAC;YAE3C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,GAAG,CAAC,IAAI,CAAC,EAAC,GAAG,EAAE,aAAa,CAAC,IAAI,EAAE,QAAS,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAC,CAAC,CAAC;YACrE,CAAC;YAED,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;CACF;AAED,UAAU,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC"}

package/lib/esm/constants.js

@@ -1,4 +1,5 @@
+import { join } from "path";
 import getAbsoluteFSPath from "swagger-ui-dist/absolute-path.js";
 export const SWAGGER_UI_DIST = getAbsoluteFSPath();
-export const ROOT_DIR = import.meta.dirname;
+export const ROOT_DIR = join(import.meta.dirname, "..");
 //# sourceMappingURL=constants.js.map

package/lib/esm/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,kCAAkC,CAAC;AAEjE,MAAM,CAAC,MAAM,eAAe,GAAG,iBAAiB,EAAE,CAAC;AACnD,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,MAAM,CAAC;AAC1B,OAAO,iBAAiB,MAAM,kCAAkC,CAAC;AAEjE,MAAM,CAAC,MAAM,eAAe,GAAG,iBAAiB,EAAE,CAAC;AACnD,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC"}

package/lib/esm/exports.js

@@ -0,0 +1,2 @@
+export { Docs, OpenAPIService as SwaggerService } from "@tsed/openapi-utils";
+//# sourceMappingURL=exports.js.map

package/lib/esm/exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.js","sourceRoot":"","sources":["../../src/exports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAE,cAAc,IAAI,cAAc,EAAC,MAAM,qBAAqB,CAAC"}

package/lib/esm/index.js

@@ -2,16 +2,9 @@
  * @file Automatically generated by @tsed/barrels.
  */
 export * from "./constants.js";
-export * from "./decorators/docs.js";
+export * from "./exports.js";
 export * from "./interfaces/interfaces.js";
 export * from "./interfaces/SwaggerSettings.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 "./SwaggerModule.js";
-export * from "./utils/includeRoute.js";
-export * from "./utils/matchPath.js";
-export * from "./utils/readSpec.js";
 //# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,oBAAoB,CAAC"}

package/lib/esm/middlewares/indexMiddleware.js

@@ -1,18 +1,22 @@
+import { basename } from "node:path";
+import { context } from "@tsed/di";
+import { join } from "path";
 /**
  * @ignore
  * @param viewPath
  * @param conf
  */
 export function indexMiddleware(viewPath, conf) {
-    return async (ctx) => {
-        const { path = "/", options = {}, showExplorer, cssPath, jsPath, urls } = conf;
+    return async () => {
+        const ctx = context();
+        const { path, options = {}, fileName, showExplorer, cssPath, jsPath, urls } = conf;
         ctx.response.body(await ctx.response.render(viewPath, {
             spec: {},
-            url: `${path}/swagger.json`,
+            url: `${path}/${fileName}`,
             urls,
             showExplorer,
-            cssPath,
-            jsPath,
+            cssPath: cssPath && join(path, basename(cssPath)),
+            jsPath: jsPath && join(path, basename(jsPath)),
             swaggerOptions: options
         }));
     };

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

@@ -1 +1 @@
-{"version":3,"file":"indexMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/indexMiddleware.ts"],"names":[],"mappings":"AAIA;;;;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"}
+{"version":3,"file":"indexMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/indexMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AAEjC,OAAO,EAAC,IAAI,EAAC,MAAM,MAAM,CAAC;AAI1B;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,QAAgB,EAAE,IAAwC;IACxF,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;QACtB,MAAM,EAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC;QAEjF,GAAG,CAAC,QAAQ,CAAC,IAAI,CACf,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE;YAClC,IAAI,EAAE,EAAE;YACR,GAAG,EAAE,GAAG,IAAI,IAAI,QAAQ,EAAE;YAC1B,IAAI;YACJ,YAAY;YACZ,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;YACjD,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC9C,cAAc,EAAE,OAAO;SACxB,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/lib/types/SwaggerModule.d.ts

@@ -1,25 +1,15 @@
-import { Env } from "@tsed/core";
-import { OnReady, OnRoutesInit } from "@tsed/platform-http";
+import { OpenAPIBaseModule } from "@tsed/openapi-utils";
 import { SwaggerSettings } from "./interfaces/SwaggerSettings.js";
-import { SwaggerService } from "./services/SwaggerService.js";
-export declare class SwaggerModule implements OnRoutesInit, OnReady {
-    protected swaggerService: SwaggerService;
-    protected env: Env | undefined;
-    protected disableRoutesSummary: boolean | undefined;
-    private loaded;
-    get settings(): SwaggerSettings[];
-    /**
-     *
-     */
-    $onRoutesInit(): void;
-    $onReady(): void;
-    generateSpecFiles(): Promise<void[]>;
-    private getUrls;
-    /**
-     *
-     * @param conf
-     * @param urls
-     */
-    private createRouter;
-    private middlewareSwaggerJson;
+export declare class SwaggerModule extends OpenAPIBaseModule {
+    readonly name = "Swagger";
+    readonly rootDir: string;
+    get settings(): ({
+        disableSpec: boolean;
+        path: string;
+        fileName: string;
+        cssPath: string;
+        viewPath: string;
+    } & SwaggerSettings)[];
+    protected createRouter(conf: SwaggerSettings): import("@tsed/platform-router").PlatformRouter;
+    protected getUrls(): any[];
 }

package/lib/types/exports.d.ts

@@ -0,0 +1 @@
+export { Docs, OpenAPIService as SwaggerService } from "@tsed/openapi-utils";

package/lib/types/index.d.ts

@@ -2,15 +2,8 @@
  * @file Automatically generated by @tsed/barrels.
  */
 export * from "./constants.js";
-export * from "./decorators/docs.js";
+export * from "./exports.js";
 export * from "./interfaces/interfaces.js";
 export * from "./interfaces/SwaggerSettings.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 "./SwaggerModule.js";
-export * from "./utils/includeRoute.js";
-export * from "./utils/matchPath.js";
-export * from "./utils/readSpec.js";

package/lib/types/interfaces/SwaggerSettings.d.ts

@@ -1,4 +1,4 @@
-import { OpenSpec2, OpenSpec3, OpenSpecVersions, OS2Versions, OS3Versions } from "@tsed/openspec";
+import type { OpenAPI3Settings, OpenApiSettings, Swagger2Settings } from "@tsed/openapi-utils";
 export interface SwaggerUIOptions {
     configUrl?: string;
     url?: string;
@@ -13,88 +13,12 @@ export interface SwaggerUIOptions {
     authorize?: any;
     [key: string]: any;
 }
-export interface SwaggerSettingsBase {
-    /**
-     * The url subpath to access to the documentation.
-     */
-    path: string;
-    /**
-     * Specify the spec version you want to generate.
-     */
-    specVersion?: OpenSpecVersions;
-    /**
-     * Swagger file name. By default swagger.json
-     */
-    fileName?: string;
-    /**
-     * Hidden documentation. Use this to hide documentation link in the dropdown.
-     */
-    hidden?: string;
-    /**
-     * The documentation key used by `@Docs` decorator to create several swagger documentations.
-     */
-    doc?: string;
-    /**
-     * The path to the CSS file.
-     */
-    cssPath?: string;
-    /**
-     * The path to the JS file.
-     */
-    jsPath?: string;
-    /**
-     * The path to the ejs file to create html page.
-     */
-    viewPath?: string | false;
+export type SwaggerOS2Settings = Swagger2Settings;
+export type SwaggerOS3Settings = OpenAPI3Settings;
+export type SwaggerSettings = OpenApiSettings & {
+    showExplorer?: boolean;
     /**
      * SwaggerUI options. See (https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md)
      */
     options?: SwaggerUIOptions;
-    /**
-     * Display the search field in the navbar.
-     */
-    showExplorer?: boolean;
-    /**
-     * Load the base spec documentation from the specified path.
-     */
-    specPath?: string;
-    /**
-     * Write the `swagger.json` spec documentation on the specified path.
-     */
-    outFile?: string;
-    /**
-     * Sort paths by alphabetical order
-     */
-    sortPaths?: boolean;
-    /**
-     * A function to generate the operationId.
-     */
-    operationIdFormatter?: (name: string, propertyKey: string, path: string) => string;
-    /**
-     * A pattern to generate the operationId. Format of operationId field (%c: class name, %m: method name).
-     */
-    operationIdPattern?: string;
-    /**
-     *
-     */
-    disableSpec?: boolean;
-    /**
-     * Include only controllers whose paths match the pattern list provided.
-     */
-    pathPatterns?: string[];
-}
-export interface SwaggerOS2Settings extends SwaggerSettingsBase {
-    specVersion?: OS2Versions;
-    /**
-     * OpenSpec 2
-     */
-    spec?: Partial<OpenSpec2>;
-}
-export interface SwaggerOS3Settings extends SwaggerSettingsBase {
-    specVersion?: OS3Versions;
-    /**
-     * OpenSpec 3
-     */
-    spec?: Partial<OpenSpec3>;
-}
-export type SwaggerSettings = SwaggerOS2Settings | SwaggerOS3Settings;
+};

package/lib/types/middlewares/indexMiddleware.d.ts

@@ -1,4 +1,3 @@
-import { PlatformContext } from "@tsed/platform-http";
 import { SwaggerSettings } from "../interfaces/SwaggerSettings.js";
 /**
  * @ignore
@@ -7,4 +6,4 @@ import { SwaggerSettings } from "../interfaces/SwaggerSettings.js";
  */
 export declare function indexMiddleware(viewPath: string, conf: SwaggerSettings & {
     urls: string[];
-}): (ctx: PlatformContext) => Promise<void>;
+}): () => Promise<void>;

package/lib/views/assets/swagger.css

@@ -0,0 +1,16 @@
+html {
+  box-sizing: border-box;
+  overflow: -moz-scrollbars-vertical;
+  overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+  box-sizing: inherit;
+}
+
+body {
+  margin: 0;
+  background: #fafafa;
+}

package/lib/views/index.ejs

@@ -9,32 +9,14 @@
     <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">
+    <link rel="stylesheet" type="text/css" href="<%= cssPath %>">
     <% } %>
 </head>
 
@@ -43,45 +25,14 @@
 
 <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 currentUrl = window.origin + "<%- url %>";
   const urls = <%- JSON.stringify(urls) %>
   .map(function (o) {
     if (!o.url.match(/^https?:/)) {
-      const url = origin + o.url;
+      const url = window.origin + o.url;
       return {
         name: o.name,
         url: url,
@@ -132,7 +83,7 @@
 
 </script>
 <% if (jsPath) { %>
-<script src="./main.js"></script>
+<script src="<%= jsPath %>"></script>
 <% } %>
 <script>
   window.onload = function () {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/swagger",
   "description": "Swagger package for Ts.ED framework",
   "type": "module",
-  "version": "8.1.0",
+  "version": "8.3.0",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -17,43 +17,41 @@
   },
   "scripts": {
     "clean": "rm -rf lib",
-    "build": "yarn clean && yarn barrels &&  yarn build:ts && yarn copy:views && monorepo build-hybrid",
+    "build": "yarn clean && yarn barrels &&  yarn build:ts && yarn copy:views",
     "copy:views": "cp -r ./views ./lib/views",
     "barrels": "barrels",
-    "start": "ts-node test/app/index.ts",
+    "start": "node --import @swc-node/register/esm-register test/app/index.ts",
     "test": "vitest run",
     "build:ts": "tsc --build tsconfig.json",
     "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
   },
   "dependencies": {
-    "@tsed/normalize-path": "8.1.0",
-    "@tsed/openspec": "8.1.0",
-    "fs-extra": "11.2.0",
-    "micromatch": "4.0.8",
+    "@tsed/normalize-path": "8.3.0",
+    "@tsed/openapi-utils": "8.3.0",
+    "@tsed/openspec": "8.3.0",
     "swagger-ui-dist": ">=5.17.14",
     "tslib": "2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.1.0",
-    "@tsed/core": "8.1.0",
-    "@tsed/di": "8.1.0",
-    "@tsed/json-mapper": "8.1.0",
-    "@tsed/monorepo-utils": "2.3.9",
-    "@tsed/openspec": "8.1.0",
-    "@tsed/platform-http": "8.1.0",
-    "@tsed/schema": "8.1.0",
-    "@tsed/typescript": "8.1.0",
+    "@tsed/barrels": "8.3.0",
+    "@tsed/core": "8.3.0",
+    "@tsed/di": "8.3.0",
+    "@tsed/json-mapper": "8.3.0",
+    "@tsed/openapi-utils": "8.3.0",
+    "@tsed/openspec": "8.3.0",
+    "@tsed/platform-http": "8.3.0",
+    "@tsed/schema": "8.3.0",
+    "@tsed/typescript": "8.3.0",
     "@types/swagger-ui-dist": "3.30.5",
     "eslint": "9.12.0",
-    "ts-node": "10.9.2",
     "typescript": "5.4.5",
     "vitest": "2.1.2"
   },
   "peerDependencies": {
-    "@tsed/platform-http": "8.1.0"
+    "@tsed/platform-http": "8.3.0"
   },
   "peerDependenciesMeta": {
-    "@tsed/common": {
+    "@tsed/platform-http": {
       "optional": false
     }
   },

package/readme.md

@@ -1,5 +1,5 @@
 <p style="text-align: center" align="center">
- <a href="https://tsed.dev" target="_blank"><img src="https://tsed.io/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
+ <a href="https://tsed.dev" target="_blank"><img src="https://tsed.devtsed-og.png" width="200" alt="Ts.ED logo"/></a>
 </p>
 
 <div align="center">
@@ -16,9 +16,9 @@
 </div>
 
 <div align="center">
-  <a href="https://tsed.io/">Website</a>
+  <a href="https://tsed.dev">Website</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://tsed.io/getting-started/">Getting started</a>
+  <a href="https://tsed.dev/getting-started/">Getting started</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
   <a href="https://slack.tsed.io">Slack</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
@@ -27,7 +27,7 @@
 
 <hr />
 
-A package of Ts.ED framework. See website: https://tsed.io/#/tutorials/swagger
+A package of Ts.ED framework. See website: https://tsed.io/tutorials/swagger
 
 ## Installation
 
@@ -128,9 +128,9 @@ export class CalendarCtrl {}
 #### Model documentation
 
 One of the feature of Ts.ED is the model definition to serialize or deserialize a
-JSON Object (see [converters section](https://tsed.io/docs/components/converters.html)).
+JSON Object (see [converters section](https://tsed.devdocs/components/converters.html)).
 
-This model can used on a method controller along with [@BodyParams](https://tsed.io/api/common/filters/decorators/BodyParams.html) or other decorators.
+This model can used on a method controller along with [@BodyParams](https://tsed.devapi/common/filters/decorators/BodyParams.html) or other decorators.
 
 ```typescript
 import {JsonProperty, Title, Description, Example} from "@tsed/schema";
@@ -226,11 +226,11 @@ document.addEventListener("swagger.init", (evt) => {
 
 ## Documentation
 
-See our documentation https://tsed.io/#/api/index
+See our documentation https://tsed.dev#/api/index
 
 ## Contributors
 
-Please read [contributing guidelines here](https://tsed.io/contributing.html).
+Please read [contributing guidelines here](https://tsed.devcontributing.html).
 
 <a href="https://github.com/tsedio/tsed/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>