@tsed/openapi-utils 8.3.0

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"}

package/lib/esm/index.js

@@ -0,0 +1,15 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./decorators/docs.js";
+export * from "./interfaces/OpenApiSettings.js";
+export * from "./middlewares/cssMiddleware.js";
+export * from "./middlewares/jsMiddleware.js";
+export * from "./middlewares/openApiMiddleware.js";
+export * from "./middlewares/redirectMiddleware.js";
+export * from "./services/OpenAPIBaseModule.js";
+export * from "./services/OpenAPIService.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

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

package/lib/esm/interfaces/OpenApiSettings.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"OpenApiSettings.js","sourceRoot":"","sources":["../../../src/interfaces/OpenApiSettings.ts"],"names":[],"mappings":""}

package/lib/esm/middlewares/cssMiddleware.js

@@ -0,0 +1,20 @@
+import { context } from "@tsed/di";
+import Fs from "fs";
+import { resolve } from "path";
+/**
+ * Expose a css file.
+ * @param path
+ */
+export function cssMiddleware(path) {
+    return () => {
+        const ctx = context();
+        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":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAC,OAAO,EAAC,MAAM,MAAM,CAAC;AAE7B;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;QAEtB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;QAEnE,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"}

package/lib/esm/middlewares/jsMiddleware.js

@@ -0,0 +1,15 @@
+import { context } from "@tsed/di";
+import Fs from "fs";
+import { resolve } from "path";
+/**
+ * Expose a js file.
+ * @param path
+ */
+export function jsMiddleware(path) {
+    return () => {
+        const ctx = context();
+        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":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAC,OAAO,EAAC,MAAM,MAAM,CAAC;AAE7B;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;QAEtB,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"}

package/lib/esm/middlewares/openApiMiddleware.js

@@ -0,0 +1,13 @@
+import { context, injector } from "@tsed/di";
+import { OpenAPIService } from "../services/OpenAPIService.js";
+/**
+ * Return a middleware to expose the OpenAPI spec.
+ */
+export function openApiMiddleware(conf) {
+    return async () => {
+        const ctx = context();
+        const spec = await injector().get(OpenAPIService).getOpenAPISpec(conf);
+        ctx.response.status(200).body(spec);
+    };
+}
+//# sourceMappingURL=openApiMiddleware.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"openApiMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/openApiMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,QAAQ,EAAC,MAAM,UAAU,CAAC;AAG3C,OAAO,EAAC,cAAc,EAAC,MAAM,+BAA+B,CAAC;AAE7D;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAqB;IACrD,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,MAAM,QAAQ,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAEvE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC;AACJ,CAAC"}

package/lib/esm/middlewares/redirectMiddleware.js

@@ -0,0 +1,14 @@
+import { context } from "@tsed/di";
+/**
+ * Redirect to the same path with a trailing slash
+ * @param path
+ */
+export function redirectMiddleware(path) {
+    return () => {
+        const ctx = context();
+        if (ctx.request.method?.toUpperCase() === "GET" && 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":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AAEjC;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;QAEtB,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7G,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,CAAC,CAAC;QACzC,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/lib/esm/services/OpenAPIBaseModule.js

@@ -0,0 +1,67 @@
+import { basename } from "node:path";
+import { configuration, constant, inject, logger } from "@tsed/di";
+import { normalizePath } from "@tsed/normalize-path";
+import { application } from "@tsed/platform-http";
+import { PlatformRouter, useContextHandler } from "@tsed/platform-router";
+import { cssMiddleware } from "../middlewares/cssMiddleware.js";
+import { jsMiddleware } from "../middlewares/jsMiddleware.js";
+import { openApiMiddleware } from "../middlewares/openApiMiddleware.js";
+import { redirectMiddleware } from "../middlewares/redirectMiddleware.js";
+import { OpenAPIService } from "../services/OpenAPIService.js";
+export class OpenAPIBaseModule {
+    constructor() {
+        this.openAPIService = inject(OpenAPIService);
+        this.env = constant("env");
+        this.disableRoutesSummary = constant("logger.disableRoutesSummary");
+        this.loaded = false;
+    }
+    $onRoutesInit() {
+        if (this.loaded) {
+            return;
+        }
+        this.settings.forEach((conf) => {
+            const { path = "/" } = conf;
+            application().use(path, useContextHandler(redirectMiddleware(path)));
+            application().use(path, this.createRouter(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, doc, specVersion } = conf;
+                logger().info(`[${doc || "default"}] ${specVersion === "2.0" ? "Swagger" : "OpenAPI"} JSON is available on ${url}${normalizePath(path, fileName)}`);
+                logger().info(`[${doc || "default"}] ${this.name} UI is available on ${url}${path}/`);
+            };
+            this.settings.forEach((conf) => {
+                displayLog(conf);
+            });
+        }
+        this.generateSpecFiles();
+    }
+    generateSpecFiles() {
+        return Promise.all(this.settings.map(async (conf) => {
+            this.openAPIService.writeOpenAPISpec(conf);
+        }));
+    }
+    createRouter(conf) {
+        const { disableSpec, fileName, cssPath, jsPath, viewPath } = conf;
+        const router = new PlatformRouter();
+        if (!disableSpec) {
+            router.get(normalizePath("/", fileName), useContextHandler(openApiMiddleware(conf)));
+        }
+        if (viewPath) {
+            if (cssPath) {
+                router.get(`/${basename(cssPath)}`, useContextHandler(cssMiddleware(cssPath)));
+            }
+            if (jsPath) {
+                router.get(`/${basename(jsPath)}`, useContextHandler(jsMiddleware(jsPath)));
+            }
+        }
+        return router;
+    }
+}
+//# sourceMappingURL=OpenAPIBaseModule.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAPIBaseModule.js","sourceRoot":"","sources":["../../../src/services/OpenAPIBaseModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,WAAW,CAAC;AAGnC,OAAO,EAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AACjE,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,WAAW,EAAwB,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAC,cAAc,EAAE,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAGxE,OAAO,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAC,YAAY,EAAC,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAC,iBAAiB,EAAC,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAC,kBAAkB,EAAC,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAC,cAAc,EAAC,MAAM,+BAA+B,CAAC;AAE7D,MAAM,OAAgB,iBAAiB;IAAvC;QAIY,mBAAc,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;QACxC,QAAG,GAAG,QAAQ,CAAM,KAAK,CAAC,CAAC;QAC3B,yBAAoB,GAAG,QAAQ,CAAU,6BAA6B,CAAC,CAAC;QAC1E,WAAM,GAAG,KAAK,CAAC;IAoEzB,CAAC;IAlEC,aAAa;QACX,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QAED,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,CAAC,CAAC,CAAC;QACnD,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,EAAE,QAAQ,EAAE,GAAG,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC;gBAEhD,MAAM,EAAE,CAAC,IAAI,CACX,IAAI,GAAG,IAAI,SAAS,KAAK,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,yBAAyB,GAAG,GAAG,aAAa,CAAC,IAAI,EAAE,QAAS,CAAC,EAAE,CACtI,CAAC;gBACF,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI,uBAAuB,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC;YACxF,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,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAES,YAAY,CAAC,IAAqB;QAC1C,MAAM,EAAC,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC;QAChE,MAAM,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QAEpC,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,EAAE,QAAS,CAAC,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACxF,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,iBAAiB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACjF,CAAC;YAED,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,iBAAiB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC9E,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/lib/esm/services/OpenAPIService.js

@@ -0,0 +1,46 @@
+import { writeFile } from "node:fs/promises";
+import { Env } from "@tsed/core";
+import { constant, inject, injectable } from "@tsed/di";
+import { Platform } from "@tsed/platform-http";
+import { generateSpec } from "@tsed/schema";
+import { includeRoute } from "../utils/includeRoute.js";
+import { readSpec } from "../utils/readSpec.js";
+export class OpenAPIService {
+    #specs;
+    constructor() {
+        this.platform = inject(Platform);
+        this.#specs = new Map();
+    }
+    async getOpenAPISpec(conf) {
+        if (!this.#specs.has(conf.path)) {
+            const version = constant("version", "1.0.0");
+            const acceptMimes = constant("acceptMimes");
+            const specPath = conf.specPath;
+            const tokens = this.platform
+                .getMountedControllers()
+                .filter(({ routes, provider }) => [...routes.values()].some((route) => includeRoute(route, provider, conf)))
+                .map(({ route, provider }) => ({ token: provider.token, rootPath: route }));
+            const spec = generateSpec({
+                tokens,
+                ...conf,
+                fileSpec: specPath ? await readSpec(specPath) : {},
+                version,
+                acceptMimes
+            });
+            this.#specs.set(conf.path, spec);
+        }
+        return this.#specs.get(conf.path);
+    }
+    async writeOpenAPISpec(conf) {
+        const { outFile } = conf;
+        const env = constant("env");
+        if (env === Env.PROD || outFile) {
+            const spec = await this.getOpenAPISpec(conf);
+            if (outFile) {
+                return writeFile(outFile, JSON.stringify(spec, null, 2), { encoding: "utf8" });
+            }
+        }
+    }
+}
+injectable(OpenAPIService);
+//# sourceMappingURL=OpenAPIService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAPIService.js","sourceRoot":"","sources":["../../../src/services/OpenAPIService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,kBAAkB,CAAC;AAE3C,OAAO,EAAC,GAAG,EAAY,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAEtD,OAAO,EAAC,QAAQ,EAAC,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAG1C,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAC;AAE9C,MAAM,OAAO,cAAc;IAGzB,MAAM,CAAiD;IAEvD;QAJU,aAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEtC,WAAM,GAAuC,IAAI,GAAG,EAAE,CAAC;IAExC,CAAC;IAQT,KAAK,CAAC,cAAc,CAAC,IAAqB;QAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC7C,MAAM,WAAW,GAAG,QAAQ,CAAS,aAAa,CAAC,CAAC;YACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ;iBACzB,qBAAqB,EAAE;iBACvB,MAAM,CAAC,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAC,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;iBACzG,GAAG,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,CAAC,KAAa,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC;YAElF,MAAM,IAAI,GAAG,YAAY,CAAC;gBACxB,MAAM;gBACN,GAAG,IAAI;gBACP,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;gBAClD,OAAO;gBACP,WAAW;aACZ,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,IAAqB;QAC1C,MAAM,EAAC,OAAO,EAAC,GAAG,IAAI,CAAC;QACvB,MAAM,GAAG,GAAG,QAAQ,CAAM,KAAK,CAAC,CAAC;QAEjC,IAAI,GAAG,KAAK,GAAG,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAE7C,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED,UAAU,CAAC,cAAc,CAAC,CAAC"}

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":"AAGA,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AAEzC,MAAM,UAAU,YAAY,CAAC,KAAa,EAAE,QAAkB,EAAE,IAAqB;IACnF,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,CAAC;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,gBAAgB,CAAC,CAAC;AACvC,CAAC"}

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"}

package/lib/esm/utils/readSpec.js

@@ -0,0 +1,14 @@
+export async function readSpec(path) {
+    const { readFile } = await import("node:fs/promises");
+    const { existsSync } = await import("node:fs");
+    if (existsSync(path)) {
+        try {
+            const response = await readFile(path, { encoding: "utf8" });
+            return JSON.parse(response);
+        }
+        catch (e) { }
+    }
+    /* istanbul ignore next */
+    return {};
+}
+//# sourceMappingURL=readSpec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"readSpec.js","sourceRoot":"","sources":["../../../src/utils/readSpec.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;IACpD,MAAM,EAAC,UAAU,EAAC,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;IAE7C,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACrB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;YAE1D,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;IAChB,CAAC;IAED,0BAA0B;IAC1B,OAAO,EAAE,CAAC;AACZ,CAAC"}

package/lib/types/decorators/docs.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Set the type documentation for this class.
+ *
+ * See [swagger documentation](/tutorials/swagger.html)
+ *
+ * @decorator
+ * @swagger
+ * @param docs
+ */
+export declare function Docs(...docs: string[]): Function;

package/lib/types/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./decorators/docs.js";
+export * from "./interfaces/OpenApiSettings.js";
+export * from "./middlewares/cssMiddleware.js";
+export * from "./middlewares/jsMiddleware.js";
+export * from "./middlewares/openApiMiddleware.js";
+export * from "./middlewares/redirectMiddleware.js";
+export * from "./services/OpenAPIBaseModule.js";
+export * from "./services/OpenAPIService.js";
+export * from "./utils/includeRoute.js";
+export * from "./utils/matchPath.js";
+export * from "./utils/readSpec.js";

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

@@ -0,0 +1,96 @@
+import { OpenSpec2, OpenSpec3, OpenSpecVersions, OS2Versions, OS3Versions } from "@tsed/openspec";
+export interface SwaggerUIOptions {
+    configUrl?: string;
+    url?: string;
+    urls?: {
+        url: string;
+        name: string;
+        primaryName?: string;
+    }[];
+    layout?: string;
+    validatorUrl?: string;
+    oauth?: any;
+    authorize?: any;
+    [key: string]: any;
+}
+export interface OpenApiSettingsBase {
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Display the documentation in the browser.
+     */
+    hidden?: boolean;
+    /**
+     * 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 Swagger2Settings extends OpenApiSettingsBase {
+    specVersion?: OS2Versions;
+    /**
+     * OpenSpec 2
+     */
+    spec?: Partial<OpenSpec2>;
+}
+export interface OpenAPI3Settings extends OpenApiSettingsBase {
+    specVersion?: OS3Versions;
+    /**
+     * OpenSpec 3
+     */
+    spec?: Partial<OpenSpec3>;
+}
+export type OpenApiSettings = Swagger2Settings | OpenAPI3Settings;

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

@@ -0,0 +1,5 @@
+/**
+ * Expose a css file.
+ * @param path
+ */
+export declare function cssMiddleware(path: string): () => void;

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

@@ -0,0 +1,5 @@
+/**
+ * Expose a js file.
+ * @param path
+ */
+export declare function jsMiddleware(path: string): () => void;

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

@@ -0,0 +1,5 @@
+import type { OpenApiSettings } from "../interfaces/OpenApiSettings.js";
+/**
+ * Return a middleware to expose the OpenAPI spec.
+ */
+export declare function openApiMiddleware(conf: OpenApiSettings): () => Promise<void>;

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

@@ -0,0 +1,5 @@
+/**
+ * Redirect to the same path with a trailing slash
+ * @param path
+ */
+export declare function redirectMiddleware(path: string): () => void;

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

@@ -0,0 +1,18 @@
+import { Env } from "@tsed/core";
+import { OnReady, OnRoutesInit } from "@tsed/platform-http";
+import { PlatformRouter } from "@tsed/platform-router";
+import type { OpenApiSettings } from "../interfaces/OpenApiSettings.js";
+import { OpenAPIService } from "../services/OpenAPIService.js";
+export declare abstract class OpenAPIBaseModule implements OnRoutesInit, OnReady {
+    abstract name: string;
+    abstract rootDir: string;
+    abstract settings: OpenApiSettings[];
+    protected openAPIService: OpenAPIService;
+    protected env: Env | undefined;
+    protected disableRoutesSummary: boolean | undefined;
+    private loaded;
+    $onRoutesInit(): void;
+    $onReady(): void;
+    generateSpecFiles(): Promise<void[]>;
+    protected createRouter(conf: OpenApiSettings): PlatformRouter;
+}

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

@@ -0,0 +1,15 @@
+import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
+import { Platform } from "@tsed/platform-http";
+import { OpenAPI3Settings, OpenApiSettings, Swagger2Settings } from "../interfaces/OpenApiSettings.js";
+export declare class OpenAPIService {
+    #private;
+    protected platform: Platform;
+    constructor();
+    /**
+     * Generate Spec for the given configuration
+     */
+    getOpenAPISpec(conf: OpenAPI3Settings): Promise<OpenSpec3>;
+    getOpenAPISpec(conf: Swagger2Settings): Promise<OpenSpec2>;
+    getOpenAPISpec(conf: OpenApiSettings): Promise<OpenSpec2>;
+    writeOpenAPISpec(conf: OpenApiSettings): Promise<void>;
+}

package/lib/types/utils/includeRoute.d.ts

@@ -0,0 +1,3 @@
+import { Provider } from "@tsed/di";
+import { OpenApiSettings } from "../interfaces/OpenApiSettings.js";
+export declare function includeRoute(route: string, provider: Provider, conf: OpenApiSettings): boolean;

package/lib/types/utils/matchPath.d.ts

@@ -0,0 +1 @@
+export declare function matchPath(path: string, patterns?: string[]): boolean;

package/lib/types/utils/readSpec.d.ts

@@ -0,0 +1 @@
+export declare function readSpec(path: string): Promise<any>;

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@tsed/openapi-utils",
+  "description": "OpenAPI utils to build @tsed/swagger package or @tsed/scalar",
+  "type": "module",
+  "version": "8.3.0",
+  "source": "./src/index.ts",
+  "main": "./lib/esm/index.js",
+  "module": "./lib/esm/index.js",
+  "typings": "./lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "@tsed/source": "./src/index.ts",
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "default": "./lib/esm/index.js"
+    }
+  },
+  "scripts": {
+    "clean": "rm -rf lib",
+    "build": "yarn clean && yarn barrels && yarn build:ts",
+    "barrels": "barrels",
+    "test": "vitest run",
+    "build:ts": "tsc --build tsconfig.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
+  },
+  "dependencies": {
+    "@tsed/openspec": "8.3.0",
+    "micromatch": "4.0.8",
+    "tslib": "2.7.0"
+  },
+  "devDependencies": {
+    "@tsed/barrels": "8.3.0",
+    "@tsed/core": "8.3.0",
+    "@tsed/di": "8.3.0",
+    "@tsed/json-mapper": "8.3.0",
+    "@tsed/openspec": "8.3.0",
+    "@tsed/platform-http": "8.3.0",
+    "@tsed/schema": "8.3.0",
+    "@tsed/typescript": "8.3.0",
+    "eslint": "9.12.0",
+    "typescript": "5.4.5",
+    "vitest": "2.1.2"
+  },
+  "peerDependencies": {
+    "@tsed/platform-http": "8.3.0"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/platform-http": {
+      "optional": false
+    }
+  },
+  "repository": "https://github.com/tsedio/tsed",
+  "bugs": {
+    "url": "https://github.com/tsedio/tsed/issues"
+  },
+  "homepage": "https://github.com/tsedio/tsed/tree/production/packages/specs/openapi-utils",
+  "author": "Romain Lenzotti",
+  "license": "MIT"
+}