@tsed/scalar 8.3.0

package/lib/esm/ScalarModule.js

@@ -0,0 +1,37 @@
+import { join } from "node:path";
+import { constant, injectable, ProviderType } from "@tsed/di";
+import { OpenAPIBaseModule } from "@tsed/openapi-utils";
+import { useContextHandler } from "@tsed/platform-router";
+import { ROOT_DIR } from "./constants.js";
+import { indexMiddleware } from "./middlewares/indexMiddleware.js";
+export class ScalarModule extends OpenAPIBaseModule {
+    constructor() {
+        super(...arguments);
+        this.name = "Scalar";
+        this.rootDir = ROOT_DIR;
+    }
+    get settings() {
+        const settings = constant("scalar", []).filter((o) => !!o);
+        return settings.map((conf) => {
+            return Object.assign({
+                disableSpec: false,
+                _integration: "tsed",
+                cdn: "https://cdn.jsdelivr.net/npm/@scalar/api-reference",
+                path: "/",
+                fileName: "openapi.json",
+                cssPath: join(ROOT_DIR, "views/assets/scalar.css"),
+                viewPath: join(ROOT_DIR, "views/scalar.ejs")
+            }, conf);
+        });
+    }
+    createRouter(conf) {
+        const { viewPath } = conf;
+        const router = super.createRouter(conf);
+        if (viewPath) {
+            router.get("/", useContextHandler(indexMiddleware(viewPath, conf)));
+        }
+        return router;
+    }
+}
+injectable(ScalarModule).type(ProviderType.MODULE);
+//# sourceMappingURL=ScalarModule.js.map

package/lib/esm/ScalarModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScalarModule.js","sourceRoot":"","sources":["../../src/ScalarModule.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,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAC,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AAExC,OAAO,EAAC,eAAe,EAAC,MAAM,kCAAkC,CAAC;AAEjE,MAAM,OAAO,YAAa,SAAQ,iBAAiB;IAAnD;;QACW,SAAI,GAAG,QAAQ,CAAC;QAChB,YAAO,GAAG,QAAQ,CAAC;IA+B9B,CAAC;IA7BC,IAAI,QAAQ;QACV,MAAM,QAAQ,GAAG,QAAQ,CAAmB,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE7E,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3B,OAAO,MAAM,CAAC,MAAM,CAClB;gBACE,WAAW,EAAE,KAAK;gBAClB,YAAY,EAAE,MAAM;gBACpB,GAAG,EAAE,oDAAoD;gBACzD,IAAI,EAAE,GAAG;gBACT,QAAQ,EAAE,cAAc;gBACxB,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,yBAAyB,CAAC;gBAClD,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,kBAAkB,CAAC;aAC7C,EACD,IAAI,CACL,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAES,YAAY,CAAC,IAAoB;QACzC,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,CAAC,GAAG,EAAE,iBAAiB,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QACtE,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED,UAAU,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC"}

package/lib/esm/constants.js

@@ -0,0 +1,3 @@
+import { join } from "path";
+export const ROOT_DIR = join(import.meta.dirname, "..");
+//# sourceMappingURL=constants.js.map

package/lib/esm/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,MAAM,CAAC;AAE1B,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 } 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,EAAC,MAAM,qBAAqB,CAAC"}

package/lib/esm/index.js

@@ -0,0 +1,9 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./constants.js";
+export * from "./exports.js";
+export * from "./interfaces/ScalarSettings.js";
+export * from "./middlewares/indexMiddleware.js";
+export * from "./ScalarModule.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,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC"}

package/lib/esm/interfaces/ScalarSettings.js

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

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

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

package/lib/esm/middlewares/indexMiddleware.js

@@ -0,0 +1,23 @@
+import { basename } from "node:path";
+import { context } from "@tsed/di";
+import { join } from "path";
+export function indexMiddleware(viewPath, conf) {
+    return async () => {
+        const ctx = context();
+        const { path, options = {}, cssPath, cdn, fileName } = conf;
+        const opts = {
+            _integration: "tsed",
+            spec: {
+                url: `${path}/${fileName}`
+            },
+            ...options
+        };
+        ctx.response.body(await ctx.response.render(viewPath, {
+            cssPath: join(path, basename(cssPath)),
+            cdn,
+            serializedOptions: JSON.stringify(opts).split('"').join("""),
+            options: opts
+        }));
+    };
+}
+//# sourceMappingURL=indexMiddleware.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"indexMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/indexMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AACjC,OAAO,EAAC,IAAI,EAAC,MAAM,MAAM,CAAC;AAI1B,MAAM,UAAU,eAAe,CAAC,QAAgB,EAAE,IAAoB;IACpE,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;QACtB,MAAM,EAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC;QAE1D,MAAM,IAAI,GAAG;YACX,YAAY,EAAE,MAAM;YACpB,IAAI,EAAE;gBACJ,GAAG,EAAE,GAAG,IAAI,IAAI,QAAQ,EAAE;aAC3B;YACD,GAAG,OAAO;SACX,CAAC;QAEF,GAAG,CAAC,QAAQ,CAAC,IAAI,CACf,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE;YAClC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;YACtC,GAAG;YACH,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;YACjE,OAAO,EAAE,IAAI;SACd,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/lib/types/ScalarModule.d.ts

@@ -0,0 +1,8 @@
+import { OpenAPIBaseModule } from "@tsed/openapi-utils";
+import { ScalarSettings } from "./interfaces/ScalarSettings.js";
+export declare class ScalarModule extends OpenAPIBaseModule {
+    readonly name = "Scalar";
+    readonly rootDir: string;
+    get settings(): any[];
+    protected createRouter(conf: ScalarSettings): import("@tsed/platform-router").PlatformRouter;
+}

package/lib/types/constants.d.ts

@@ -0,0 +1 @@
+export declare const ROOT_DIR: string;

package/lib/types/exports.d.ts

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

package/lib/types/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./constants.js";
+export * from "./exports.js";
+export * from "./interfaces/ScalarSettings.js";
+export * from "./middlewares/indexMiddleware.js";
+export * from "./ScalarModule.js";

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

@@ -0,0 +1,6 @@
+import type { ReferenceConfiguration } from "@scalar/types/legacy";
+import type { OpenApiSettings } from "@tsed/openapi-utils";
+export type ScalarSettings = OpenApiSettings & ReferenceConfiguration & {
+    cdn?: string;
+    options?: ReferenceConfiguration;
+};

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

@@ -0,0 +1,2 @@
+import { ScalarSettings } from "../interfaces/ScalarSettings.js";
+export declare function indexMiddleware(viewPath: string, conf: ScalarSettings): () => Promise<void>;

package/lib/views/assets/scalar.css

@@ -0,0 +1,96 @@
+/* basic theme */
+.light-mode {
+  --scalar-color-1: #353535;
+  --scalar-color-2: #555555;
+  --scalar-color-3: #aeaeae;
+  --scalar-color-accent: #259dff;
+
+  --scalar-background-1: #fff;
+  --scalar-background-2: #f7f7f7;
+  --scalar-background-3: #dadada;
+  --scalar-background-accent: #E0F5FF;
+
+  --scalar-border-color: rgba(0, 0, 0, 0.1);
+}
+
+.dark-mode {
+  --scalar-color-1: rgba(255, 255, 255, 0.9);
+  --scalar-color-2: rgba(255, 255, 255, 0.62);
+  --scalar-color-3: rgba(255, 255, 255, 0.44);
+  --scalar-color-accent: #8ab4f8;
+
+  --scalar-background-1: #1a1a1a;
+  --scalar-background-2: #252525;
+  --scalar-background-3: #323232;
+  --scalar-background-accent: #8ab4f81f;
+
+  --scalar-border-color: rgba(255, 255, 255, 0.1);
+}
+
+/* Document Sidebar */
+.light-mode .t-doc__sidebar {
+  --scalar-sidebar-background-1: var(--scalar-background-1);
+  --scalar-sidebar-item-hover-color: currentColor;
+  --scalar-sidebar-item-hover-background: var(--scalar-background-2);
+  --scalar-sidebar-item-active-background: var(--scalar-background-accent);
+  --scalar-sidebar-border-color: var(--scalar-border-color);
+  --scalar-sidebar-color-1: var(--scalar-color-1);
+  --scalar-sidebar-color-2: var(--scalar-color-2);
+  --scalar-sidebar-color-active: var(--scalar-color-accent);
+  --scalar-sidebar-search-background: transparent;
+  --scalar-sidebar-search-border-color: var(--scalar-border-color);
+  --scalar-sidebar-search-color: var(--scalar-color-3);
+}
+
+.dark-mode .sidebar {
+  --scalar-sidebar-background-1: var(--scalar-background-1);
+  --scalar-sidebar-item-hover-color: currentColor;
+  --scalar-sidebar-item-hover-background: var(--scalar-background-2);
+  --scalar-sidebar-item-active-background: var(--scalar-background-accent);
+  --scalar-sidebar-border-color: var(--scalar-border-color);
+  --scalar-sidebar-color-1: var(--scalar-color-1);
+  --scalar-sidebar-color-2: var(--scalar-color-2);
+  --scalar-sidebar-color-active: var(--scalar-color-accent);
+  --scalar-sidebar-search-background: transparent;
+  --scalar-sidebar-search-border-color: var(--scalar-border-color);
+  --scalar-sidebar-search-color: var(--scalar-color-3);
+}
+
+/* advanced */
+.light-mode {
+  --scalar-button-1: rgb(49 53 56);
+  --scalar-button-1-color: #fff;
+  --scalar-button-1-hover: rgb(28 31 33);
+
+  --scalar-color-green: #669900;
+  --scalar-color-red: #dc4a68;
+  --scalar-color-yellow: #edbe20;
+  --scalar-color-blue: #0277aa;
+  --scalar-color-orange: #fb892c;
+  --scalar-color-purple: #5203d1;
+
+  --scalar-scrollbar-color: rgba(0, 0, 0, 0.18);
+  --scalar-scrollbar-color-active: rgba(0, 0, 0, 0.36);
+}
+
+.dark-mode {
+  --scalar-button-1: #f6f6f6;
+  --scalar-button-1-color: #000;
+  --scalar-button-1-hover: #e7e7e7;
+
+  --scalar-color-green: #00b648;
+  --scalar-color-red: #dc1b19;
+  --scalar-color-yellow: #ffc90d;
+  --scalar-color-blue: #4eb3ec;
+  --scalar-color-orange: #ff8d4d;
+  --scalar-color-purple: #b191f9;
+
+  --scalar-scrollbar-color: rgba(255, 255, 255, 0.24);
+  --scalar-scrollbar-color-active: rgba(255, 255, 255, 0.48);
+}
+
+:root {
+  --scalar-radius: 3px;
+  --scalar-radius-lg: 3px;
+  --scalar-radius-xl: 3px;
+}

package/lib/views/scalar.ejs

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Scalar API Reference</title>
+  <meta charset="utf-8"/>
+  <meta
+    name="viewport"
+    content="width=device-width, initial-scale=1"/>
+  <link>
+  <link rel="stylesheet" href="<%= cssPath %>" />
+</head>
+<body>
+<script
+  id="api-reference"
+  type="application/json"
+  data-configuration="<%= serializedOptions %>"></script>
+<script src="<%= cdn %>"></script>
+</body>
+</html>

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@tsed/scalar",
+  "description": "Scalar package for Ts.ED framework",
+  "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 && yarn copy:views",
+    "copy:views": "cp -r ./views ./lib/views",
+    "barrels": "barrels",
+    "test": "vitest run",
+    "start": "node --import @swc-node/register/esm-register test/app/index.ts",
+    "build:ts": "tsc --build tsconfig.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
+  },
+  "dependencies": {
+    "@scalar/types": "^0.0.23",
+    "@tsed/normalize-path": "8.3.0",
+    "@tsed/openapi-utils": "8.3.0",
+    "@tsed/openspec": "8.3.0",
+    "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/swagger": "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/scalar",
+  "author": "Romain Lenzotti",
+  "license": "MIT"
+}

package/readme.md

@@ -0,0 +1,214 @@
+<p style="text-align: center" align="center">
+ <a href="https://tsed.dev" target="_blank"><img src="https://tsed.dev/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
+</p>
+
+<div align="center">
+   <h1>Scalar</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.io/">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://tsed.io/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/scalar
+
+## Installation
+
+```bash
+npm install --save @tsed/scalar
+```
+
+Then add the following configuration in your Server:
+
+```typescript
+import {Configuration} from "@tsed/di";
+import "@tsed/scalar"; // import scalar Ts.ED module
+import {resolve} from "path";
+
+@Configuration({
+  scalar: [
+    {
+      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/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          | `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.                                                                                |
+| spec                 | `{"openapi": "3.0.1"}`                                        | The default information spec.                                                                            |
+| hidden               | `true`                                                        | Hide the documentation in the dropdown explorer list.                                                    |
+| options              | Scalar 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/scalar"; // import swagger Ts.ED module
+
+@Configuration({
+  scalar: [
+    {
+      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.io/docs/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.
+
+```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> {
+    //...
+  }
+}
+```
+
+## Documentation
+
+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/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/ScalarModule.spec.ts

@@ -0,0 +1,60 @@
+import {logger} from "@tsed/di";
+import {application} from "@tsed/platform-http";
+import {PlatformTest} from "@tsed/platform-http/testing";
+import {PlatformRouter} from "@tsed/platform-router";
+
+import {ScalarModule} from "./ScalarModule.js";
+
+vi.mock("node:fs/promises");
+
+describe("SwaggerModule", () => {
+  beforeEach(() =>
+    PlatformTest.create({
+      httpPort: 8080,
+      httpsPort: 8081,
+      scalar: [
+        {
+          path: "/doc",
+          cssPath: "/cssPath/style.css",
+          jsPath: "/jsPath/script.js",
+          viewPath: "/viewsPath",
+          outFile: "/openapi.json"
+        }
+      ]
+    })
+  );
+  afterEach(PlatformTest.reset);
+
+  describe("$onRoutesInit", () => {
+    it("should add middlewares", async () => {
+      const mod = await PlatformTest.invoke<ScalarModule>(ScalarModule);
+
+      vi.spyOn(application(), "get").mockReturnValue(undefined as never);
+      vi.spyOn(application(), "use").mockReturnValue(undefined as never);
+      vi.spyOn(PlatformRouter.prototype as any, "get").mockReturnValue(undefined);
+      vi.spyOn(PlatformRouter.prototype as any, "statics").mockReturnValue(undefined);
+
+      mod.$onRoutesInit();
+      mod.$onRoutesInit();
+
+      expect(application().use).toHaveBeenCalledWith("/doc", expect.any(Function));
+      expect(application().use).toHaveBeenCalledWith("/doc", expect.any(PlatformRouter));
+      expect(PlatformRouter.prototype.get).toHaveBeenCalledWith("/openapi.json", expect.any(Function));
+      expect(PlatformRouter.prototype.get).toHaveBeenCalledWith("/style.css", expect.any(Function));
+      expect(PlatformRouter.prototype.get).toHaveBeenCalledWith("/script.js", expect.any(Function));
+    });
+  });
+
+  describe("$onReady", () => {
+    it("should display the right log", async () => {
+      const mod = await PlatformTest.invoke<ScalarModule>(ScalarModule);
+
+      vi.spyOn(logger(), "info");
+
+      mod.$onReady();
+
+      expect(logger().info).toHaveBeenCalledWith("[default] OpenAPI JSON is available on https://0.0.0.0:8081/doc/openapi.json");
+      expect(logger().info).toHaveBeenCalledWith("[default] Scalar UI is available on https://0.0.0.0:8081/doc/");
+    });
+  });
+});

package/src/ScalarModule.ts

@@ -0,0 +1,46 @@
+import {join} from "node:path";
+
+import {constant, injectable, ProviderType} from "@tsed/di";
+import {OpenAPIBaseModule} from "@tsed/openapi-utils";
+import {useContextHandler} from "@tsed/platform-router";
+
+import {ROOT_DIR} from "./constants.js";
+import {ScalarSettings} from "./interfaces/ScalarSettings.js";
+import {indexMiddleware} from "./middlewares/indexMiddleware.js";
+
+export class ScalarModule extends OpenAPIBaseModule {
+  readonly name = "Scalar";
+  readonly rootDir = ROOT_DIR;
+
+  get settings() {
+    const settings = constant<ScalarSettings[]>("scalar", []).filter((o) => !!o);
+
+    return settings.map((conf) => {
+      return Object.assign(
+        {
+          disableSpec: false,
+          _integration: "tsed",
+          cdn: "https://cdn.jsdelivr.net/npm/@scalar/api-reference",
+          path: "/",
+          fileName: "openapi.json",
+          cssPath: join(ROOT_DIR, "views/assets/scalar.css"),
+          viewPath: join(ROOT_DIR, "views/scalar.ejs")
+        },
+        conf
+      );
+    });
+  }
+
+  protected createRouter(conf: ScalarSettings) {
+    const {viewPath} = conf;
+    const router = super.createRouter(conf);
+
+    if (viewPath) {
+      router.get("/", useContextHandler(indexMiddleware(viewPath, conf)));
+    }
+
+    return router;
+  }
+}
+
+injectable(ScalarModule).type(ProviderType.MODULE);

package/src/constants.ts

@@ -0,0 +1,3 @@
+import {join} from "path";
+
+export const ROOT_DIR = join(import.meta.dirname, "..");

package/src/exports.ts

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

package/src/index.ts

@@ -0,0 +1,8 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./constants.js";
+export * from "./exports.js";
+export * from "./interfaces/ScalarSettings.js";
+export * from "./middlewares/indexMiddleware.js";
+export * from "./ScalarModule.js";

package/src/interfaces/ScalarSettings.ts

@@ -0,0 +1,9 @@
+// @ts-ignore
+import type {ReferenceConfiguration} from "@scalar/types/legacy";
+import type {OpenApiSettings} from "@tsed/openapi-utils";
+
+export type ScalarSettings = OpenApiSettings &
+  ReferenceConfiguration & {
+    cdn?: string;
+    options?: ReferenceConfiguration;
+  };

package/src/middlewares/indexMiddleware.ts

@@ -0,0 +1,30 @@
+import {basename} from "node:path";
+
+import {context} from "@tsed/di";
+import {join} from "path";
+
+import {ScalarSettings} from "../interfaces/ScalarSettings.js";
+
+export function indexMiddleware(viewPath: string, conf: ScalarSettings) {
+  return async () => {
+    const ctx = context();
+    const {path, options = {}, cssPath, cdn, fileName} = conf;
+
+    const opts = {
+      _integration: "tsed",
+      spec: {
+        url: `${path}/${fileName}`
+      },
+      ...options
+    };
+
+    ctx.response.body(
+      await ctx.response.render(viewPath, {
+        cssPath: join(path, basename(cssPath)),
+        cdn,
+        serializedOptions: JSON.stringify(opts).split('"').join("""),
+        options: opts
+      })
+    );
+  };
+}

package/views/assets/scalar.css

@@ -0,0 +1,96 @@
+/* basic theme */
+.light-mode {
+  --scalar-color-1: #353535;
+  --scalar-color-2: #555555;
+  --scalar-color-3: #aeaeae;
+  --scalar-color-accent: #259dff;
+
+  --scalar-background-1: #fff;
+  --scalar-background-2: #f7f7f7;
+  --scalar-background-3: #dadada;
+  --scalar-background-accent: #E0F5FF;
+
+  --scalar-border-color: rgba(0, 0, 0, 0.1);
+}
+
+.dark-mode {
+  --scalar-color-1: rgba(255, 255, 255, 0.9);
+  --scalar-color-2: rgba(255, 255, 255, 0.62);
+  --scalar-color-3: rgba(255, 255, 255, 0.44);
+  --scalar-color-accent: #8ab4f8;
+
+  --scalar-background-1: #1a1a1a;
+  --scalar-background-2: #252525;
+  --scalar-background-3: #323232;
+  --scalar-background-accent: #8ab4f81f;
+
+  --scalar-border-color: rgba(255, 255, 255, 0.1);
+}
+
+/* Document Sidebar */
+.light-mode .t-doc__sidebar {
+  --scalar-sidebar-background-1: var(--scalar-background-1);
+  --scalar-sidebar-item-hover-color: currentColor;
+  --scalar-sidebar-item-hover-background: var(--scalar-background-2);
+  --scalar-sidebar-item-active-background: var(--scalar-background-accent);
+  --scalar-sidebar-border-color: var(--scalar-border-color);
+  --scalar-sidebar-color-1: var(--scalar-color-1);
+  --scalar-sidebar-color-2: var(--scalar-color-2);
+  --scalar-sidebar-color-active: var(--scalar-color-accent);
+  --scalar-sidebar-search-background: transparent;
+  --scalar-sidebar-search-border-color: var(--scalar-border-color);
+  --scalar-sidebar-search-color: var(--scalar-color-3);
+}
+
+.dark-mode .sidebar {
+  --scalar-sidebar-background-1: var(--scalar-background-1);
+  --scalar-sidebar-item-hover-color: currentColor;
+  --scalar-sidebar-item-hover-background: var(--scalar-background-2);
+  --scalar-sidebar-item-active-background: var(--scalar-background-accent);
+  --scalar-sidebar-border-color: var(--scalar-border-color);
+  --scalar-sidebar-color-1: var(--scalar-color-1);
+  --scalar-sidebar-color-2: var(--scalar-color-2);
+  --scalar-sidebar-color-active: var(--scalar-color-accent);
+  --scalar-sidebar-search-background: transparent;
+  --scalar-sidebar-search-border-color: var(--scalar-border-color);
+  --scalar-sidebar-search-color: var(--scalar-color-3);
+}
+
+/* advanced */
+.light-mode {
+  --scalar-button-1: rgb(49 53 56);
+  --scalar-button-1-color: #fff;
+  --scalar-button-1-hover: rgb(28 31 33);
+
+  --scalar-color-green: #669900;
+  --scalar-color-red: #dc4a68;
+  --scalar-color-yellow: #edbe20;
+  --scalar-color-blue: #0277aa;
+  --scalar-color-orange: #fb892c;
+  --scalar-color-purple: #5203d1;
+
+  --scalar-scrollbar-color: rgba(0, 0, 0, 0.18);
+  --scalar-scrollbar-color-active: rgba(0, 0, 0, 0.36);
+}
+
+.dark-mode {
+  --scalar-button-1: #f6f6f6;
+  --scalar-button-1-color: #000;
+  --scalar-button-1-hover: #e7e7e7;
+
+  --scalar-color-green: #00b648;
+  --scalar-color-red: #dc1b19;
+  --scalar-color-yellow: #ffc90d;
+  --scalar-color-blue: #4eb3ec;
+  --scalar-color-orange: #ff8d4d;
+  --scalar-color-purple: #b191f9;
+
+  --scalar-scrollbar-color: rgba(255, 255, 255, 0.24);
+  --scalar-scrollbar-color-active: rgba(255, 255, 255, 0.48);
+}
+
+:root {
+  --scalar-radius: 3px;
+  --scalar-radius-lg: 3px;
+  --scalar-radius-xl: 3px;
+}

package/views/scalar.ejs

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Scalar API Reference</title>
+  <meta charset="utf-8"/>
+  <meta
+    name="viewport"
+    content="width=device-width, initial-scale=1"/>
+  <link>
+  <link rel="stylesheet" href="<%= cssPath %>" />
+</head>
+<body>
+<script
+  id="api-reference"
+  type="application/json"
+  data-configuration="<%= serializedOptions %>"></script>
+<script src="<%= cdn %>"></script>
+</body>
+</html>

package/vitest.config.mts

@@ -0,0 +1,21 @@
+// @ts-ignore
+import {presets} from "@tsed/vitest/presets";
+import {defineConfig} from "vitest/config";
+
+export default defineConfig(
+  {
+    ...presets,
+    test: {
+      ...presets.test,
+      coverage: {
+        ...presets.test.coverage,
+        thresholds: {
+          statements: 0,
+          branches: 0,
+          functions: 0,
+          lines: 0
+        }
+      }
+    }
+  }
+);