@tsed/openapi-utils 8.3.0

package/readme.md

@@ -0,0 +1,257 @@
+<p style="text-align: center" align="center">
+ <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">
+   <h1>Swagger</h1>
+
+[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
+[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
+[![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![github](https://img.shields.io/static/v1?label=Github%20sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/romakita)
+[![opencollective](https://img.shields.io/static/v1?label=OpenCollective%20sponsor&message=%E2%9D%A4&logo=OpenCollective&color=%23fe8e86)](https://opencollective.com/tsed)
+
+</div>
+
+<div align="center">
+  <a href="https://tsed.dev">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <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>
+  <a href="https://twitter.com/TsED_io">Twitter</a>
+</div>
+
+<hr />
+
+A package of Ts.ED framework. See website: https://tsed.io/tutorials/swagger
+
+## Installation
+
+Before using the Swagger, we have to install the [swagger-ui-express](https://www.npmjs.com/package/swagger-ui-express) module.
+
+```bash
+npm install --save @tsed/swagger
+```
+
+Then add the following configuration in your Server:
+
+```typescript
+import {Configuration} from "@tsed/di";
+import "@tsed/swagger"; // import swagger Ts.ED module
+import {resolve} from "path";
+
+@Configuration({
+  swagger: [
+    {
+      path: "/v2/docs",
+      specVersion: "2.0"
+    },
+    {
+      path: "/v3/docs",
+      specVersion: "3.0.1"
+    }
+  ]
+})
+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.
+
+> Note: Ts.ED will print the swagger url in the console.
+
+### Swagger options
+
+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).    |
+
+### Multi documentations
+
+It also possible to create several swagger documentations with `doc` option:
+
+```typescript
+import {Configuration} from "@tsed/di";
+import "@tsed/swagger"; // import swagger Ts.ED module
+
+@Configuration({
+  swagger: [
+    {
+      path: "/api-docs-v1",
+      doc: "api-v1"
+    },
+    {
+      path: "/api-docs-v2",
+      doc: "api-v2"
+    }
+  ]
+})
+export class Server {}
+```
+
+Then use `@Docs` decorators on your controllers to specify where the controllers should be displayed.
+
+```typescript
+import {Controller} from "@tsed/di";
+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 {}
+```
+
+## Examples
+
+#### 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.devdocs/components/converters.html)).
+
+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";
+
+export class CalendarModel {
+  @Title("iD")
+  @Description("Description of calendar model id")
+  @Example("Example value")
+  @JsonProperty()
+  public id: string;
+
+  @JsonProperty()
+  public name: string;
+}
+```
+
+#### Endpoint documentation
+
+```typescript
+import {Controller} from "@tsed/di";
+import {BodyParams, QueryParams} from "@tsed/platform-params";
+import {Get, Post, Returns, ReturnsArray, Description, Summary, Deprecated, Security} from "@tsed/schema";
+import {CalendarModel} from "../models/CalendarModel.js";
+
+@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> {
+    //...
+  }
+}
+```
+
+::: 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.
+
+```typescript
+import {Configuration} from "@tsed/di";
+import "@tsed/swagger"; // import swagger Ts.ED module
+
+@Configuration({
+  swagger: [
+    {
+      path: "/api-docs",
+      jsPath: "/spec/main.js"
+    }
+  ]
+})
+export class Server {}
+```
+
+In your JavaScript file, you can handle Swagger-ui configuration and the instance:
+
+```javascript
+console.log(SwaggerUIBuilder.config); //Swagger-ui config
+
+document.addEventListener("swagger.init", (evt) => {
+  console.log(SwaggerUIBuilder.ui); //Swagger-ui instance
+});
+```
+
+## Documentation
+
+See our documentation https://tsed.dev#/api/index
+
+## Contributors
+
+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>
+
+## 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)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - 2022 Romain Lenzotti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/src/decorators/docs.ts

@@ -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: string[]) {
+  return StoreMerge("docs", docs);
+}

package/src/index.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/src/interfaces/OpenApiSettings.ts

@@ -0,0 +1,98 @@
+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/src/middlewares/cssMiddleware.spec.ts

@@ -0,0 +1,25 @@
+import {runInContext} from "@tsed/di";
+import {PlatformTest} from "@tsed/platform-http/testing";
+import Fs from "fs";
+
+import {cssMiddleware} from "./cssMiddleware.js";
+
+describe("cssMiddleware", () => {
+  beforeEach(PlatformTest.create);
+  afterEach(PlatformTest.reset);
+  beforeEach(() => {
+    vi.spyOn(Fs, "readFileSync").mockReturnValue(".css{}");
+  });
+  it("should create a middleware", async () => {
+    const ctx = PlatformTest.createRequestContext();
+
+    await runInContext(ctx, () => cssMiddleware("/path")());
+
+    expect(ctx.response.raw.headers).toEqual({
+      "content-type": "text/css",
+      "x-request-id": "id"
+    });
+    expect(ctx.response.raw.statusCode).toEqual(200);
+    expect(ctx.response.raw.data).toEqual(".css{}");
+  });
+});

package/src/middlewares/cssMiddleware.ts

@@ -0,0 +1,22 @@
+import {context} from "@tsed/di";
+import Fs from "fs";
+import {resolve} from "path";
+
+/**
+ * Expose a css file.
+ * @param path
+ */
+export function cssMiddleware(path: string) {
+  return () => {
+    const ctx = context();
+
+    const content = Fs.readFileSync(resolve(path), {encoding: "utf8"});
+
+    ctx.response
+      .setHeaders({
+        "Content-Type": "text/css"
+      })
+      .status(200)
+      .body(content);
+  };
+}

package/src/middlewares/jsMiddleware.spec.ts

@@ -0,0 +1,25 @@
+import {runInContext} from "@tsed/di";
+import {PlatformTest} from "@tsed/platform-http/testing";
+import Fs from "fs";
+
+import {jsMiddleware} from "./jsMiddleware.js";
+
+describe("jsMiddleware", () => {
+  beforeEach(PlatformTest.create);
+  afterEach(PlatformTest.reset);
+  beforeEach(() => {
+    vi.spyOn(Fs, "readFileSync").mockReturnValue("var test=1");
+  });
+  it("should create a middleware", async () => {
+    const ctx = PlatformTest.createRequestContext();
+
+    await runInContext(ctx, () => jsMiddleware("/path")());
+
+    expect(ctx.response.raw.headers).toEqual({
+      "content-type": "application/javascript",
+      "x-request-id": "id"
+    });
+    expect(ctx.response.raw.statusCode).toBe(200);
+    expect(ctx.response.raw.data).toBe("var test=1");
+  });
+});

package/src/middlewares/jsMiddleware.ts

@@ -0,0 +1,16 @@
+import {context} from "@tsed/di";
+import Fs from "fs";
+import {resolve} from "path";
+
+/**
+ * Expose a js file.
+ * @param path
+ */
+export function jsMiddleware(path: string) {
+  return () => {
+    const ctx = context();
+
+    const content = Fs.readFileSync(resolve(path), {encoding: "utf8"});
+    ctx.response.setHeaders({"Content-Type": "application/javascript"}).status(200).body(content);
+  };
+}

package/src/middlewares/openApiMiddleware.spec.ts

@@ -0,0 +1,31 @@
+import {runInContext} from "@tsed/di";
+import {PlatformTest} from "@tsed/platform-http/testing";
+import Fs from "fs";
+
+import {openApiMiddleware} from "./openApiMiddleware.js";
+
+describe("openApiMiddleware", () => {
+  beforeEach(PlatformTest.create);
+  afterEach(PlatformTest.reset);
+  beforeEach(() => {
+    vi.spyOn(Fs, "readFileSync").mockReturnValue("var test=1");
+  });
+  it("should create a middleware", async () => {
+    const ctx = PlatformTest.createRequestContext();
+    const conf = {specVersion: "3.0.1"};
+
+    await runInContext(ctx, () => openApiMiddleware(conf as never)());
+
+    expect(ctx.response.raw.headers).toEqual({
+      "x-request-id": "id"
+    });
+    expect(ctx.response.raw.statusCode).toBe(200);
+    expect(ctx.response.raw.data).toEqual({
+      info: {
+        title: "Api documentation",
+        version: "1.0.0"
+      },
+      openapi: "3.0.1"
+    });
+  });
+});

package/src/middlewares/openApiMiddleware.ts

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

package/src/middlewares/redirectMiddleware.spec.ts

@@ -0,0 +1,32 @@
+import {runInContext} from "@tsed/di";
+import {PlatformTest} from "@tsed/platform-http/testing";
+
+import {redirectMiddleware} from "./redirectMiddleware.js";
+
+describe("redirectMiddleware and redirect", () => {
+  beforeEach(PlatformTest.create);
+  afterEach(PlatformTest.reset);
+  it("should create a middleware", async () => {
+    const ctx = PlatformTest.createRequestContext();
+    vi.spyOn(ctx.response, "redirect").mockReturnValue(undefined as never);
+
+    ctx.request.raw.url = "/path";
+    ctx.request.raw.originalUrl = "/path";
+    ctx.request.raw.method = "GET";
+
+    await runInContext(ctx, () => redirectMiddleware("/path")());
+
+    expect(ctx.response.redirect).toHaveBeenCalledWith(302, "/path/");
+  });
+  it("should create a middleware and call next", async () => {
+    const ctx = PlatformTest.createRequestContext();
+    vi.spyOn(ctx.response, "redirect");
+    ctx.request.raw.url = "/path/";
+    ctx.request.raw.method = "GET";
+    ctx.request.raw.originalUrl = "/path/";
+
+    await runInContext(ctx, () => redirectMiddleware("/path")());
+
+    expect(ctx.response.redirect).not.toHaveBeenCalled();
+  });
+});

package/src/middlewares/redirectMiddleware.ts

@@ -0,0 +1,15 @@
+import {context} from "@tsed/di";
+
+/**
+ * Redirect to the same path with a trailing slash
+ * @param path
+ */
+export function redirectMiddleware(path: string) {
+  return () => {
+    const ctx = context();
+
+    if (ctx.request.method?.toUpperCase() === "GET" && ctx.request.url === path && !ctx.request.url.match(/\/$/)) {
+      ctx.response.redirect(302, `${path}/`);
+    }
+  };
+}

package/src/services/OpenAPIBaseModule.ts

@@ -0,0 +1,91 @@
+import {basename} from "node:path";
+
+import {Env} from "@tsed/core";
+import {configuration, constant, inject, logger} from "@tsed/di";
+import {normalizePath} from "@tsed/normalize-path";
+import {application, OnReady, OnRoutesInit} from "@tsed/platform-http";
+import {PlatformRouter, useContextHandler} from "@tsed/platform-router";
+
+import type {OpenApiSettings} from "../interfaces/OpenApiSettings.js";
+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 abstract class OpenAPIBaseModule implements OnRoutesInit, OnReady {
+  abstract name: string;
+  abstract rootDir: string;
+  abstract settings: OpenApiSettings[];
+  protected openAPIService = inject(OpenAPIService);
+  protected env = constant<Env>("env");
+  protected disableRoutesSummary = constant<boolean>("logger.disableRoutesSummary");
+  private loaded = false;
+
+  $onRoutesInit() {
+    if (this.loaded) {
+      return;
+    }
+
+    this.settings.forEach((conf: OpenApiSettings) => {
+      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: OpenApiSettings) => {
+        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);
+      })
+    );
+  }
+
+  protected createRouter(conf: OpenApiSettings) {
+    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;
+  }
+}