@tsed/swagger 7.79.4 → 7.80.0

package/lib/esm/constants.js

@@ -1,4 +1,4 @@
 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 = __dirname;
 //# sourceMappingURL=constants.js.map

package/lib/types-esm/SwaggerModule.d.ts

@@ -0,0 +1,31 @@
+import { Configuration, InjectorService, OnReady, OnRoutesInit, PlatformApplication } from "@tsed/common";
+import { Env } from "@tsed/core";
+import { SwaggerSettings } from "./interfaces/SwaggerSettings.js";
+import { SwaggerService } from "./services/SwaggerService.js";
+/**
+ * @ignore
+ */
+export declare class SwaggerModule implements OnRoutesInit, OnReady {
+    injector: InjectorService;
+    app: PlatformApplication;
+    configuration: Configuration;
+    swaggerService: SwaggerService;
+    env: Env;
+    disableRoutesSummary: boolean;
+    private loaded;
+    get settings(): SwaggerSettings[];
+    /**
+     *
+     */
+    $onRoutesInit(): void;
+    $onReady(): void;
+    generateSpecFiles(): Promise<void[]>;
+    private getUrls;
+    /**
+     *
+     * @param conf
+     * @param urls
+     */
+    private createRouter;
+    private middlewareSwaggerJson;
+}

package/lib/types-esm/constants.d.ts

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

package/lib/types-esm/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-esm/decorators/hidden.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Disable documentation for the class and his endpoint.
+ *
+ * ````typescript
+ * @Controller('/')
+ * export class Ctrl {
+ *
+ *   @Get('/')
+ *   @Hidden()
+ *   hiddenRoute(){
+ *
+ *   }
+ * }
+ *
+ * @Controller('/')
+ * @Hidden()
+ * export class Ctrl {
+ *   @Get('/')
+ *   hiddenRoute() {
+ *
+ *   }
+ *   @Get('/2')
+ *   hiddenRoute2() {
+ *
+ *   }
+ * }
+ * ```
+ *
+ * @decorator
+ * @swagger
+ */
+export declare function Hidden(): Function;

package/lib/types-esm/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./constants.js";
+export * from "./decorators/docs.js";
+export * from "./decorators/hidden.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";

package/lib/types-esm/interfaces/SwaggerSettings.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 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;
+    /**
+     * 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;
+    /**
+     * 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-esm/interfaces/interfaces.d.ts

@@ -0,0 +1,8 @@
+import { SwaggerSettings } from "./SwaggerSettings.js";
+declare global {
+    namespace TsED {
+        interface Configuration {
+            swagger: SwaggerSettings[];
+        }
+    }
+}

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

@@ -0,0 +1,6 @@
+import { PlatformContext } from "@tsed/common";
+/**
+ * @ignore
+ * @param path
+ */
+export declare function cssMiddleware(path: string): (ctx: PlatformContext) => void;

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

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

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

@@ -0,0 +1,6 @@
+import { PlatformContext } from "@tsed/common";
+/**
+ * @ignore
+ * @param path
+ */
+export declare function jsMiddleware(path: string): (ctx: PlatformContext) => void;

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

@@ -0,0 +1,6 @@
+import { PlatformContext } from "@tsed/common";
+/**
+ * @ignore
+ * @param path
+ */
+export declare function redirectMiddleware(path: string): (ctx: PlatformContext) => void;

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

@@ -0,0 +1,17 @@
+import { Configuration, InjectorService, Platform } from "@tsed/common";
+import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
+import { SwaggerOS2Settings, SwaggerOS3Settings, SwaggerSettings } from "../interfaces/SwaggerSettings.js";
+export declare class SwaggerService {
+    #private;
+    private injectorService;
+    private platform;
+    private configuration;
+    constructor(injectorService: InjectorService, platform: Platform, configuration: Configuration);
+    /**
+     * Generate Spec for the given configuration
+     * @returns {Spec}
+     */
+    getOpenAPISpec(conf: SwaggerOS3Settings): Promise<OpenSpec3>;
+    getOpenAPISpec(conf: SwaggerOS2Settings): Promise<OpenSpec2>;
+    getOpenAPISpec(conf: SwaggerSettings): Promise<OpenSpec2>;
+}

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

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

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

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

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@tsed/swagger",
-  "version": "7.79.4",
   "description": "Swagger package for Ts.ED framework",
+  "type": "commonjs",
+  "version": "7.80.0",
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
-    "types": "./lib/types/index.d.ts",
-    "import": "./lib/esm/index.js",
-    "require": "./lib/cjs/index.js",
-    "default": "./lib/esm/index.js"
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "default": "./lib/cjs/index.js"
+    }
   },
   "scripts": {
     "clean": "rm -rf lib",
@@ -18,35 +20,36 @@
     "copy:views": "cp -r ./views ./lib/views",
     "barrels": "barrels",
     "start": "ts-node test/app/index.ts",
-    "test": "jest --max-workers=2 && jest-coverage-thresholds-bumper",
-    "build:ts": "tsc --build tsconfig.json && tsc --build tsconfig.esm.json"
+    "test": "vitest run",
+    "build:ts": "tsc --build tsconfig.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
   },
   "dependencies": {
-    "@tsed/normalize-path": "7.79.4",
-    "@tsed/openspec": "7.79.4",
+    "@tsed/normalize-path": "7.80.0",
+    "@tsed/openspec": "7.80.0",
     "fs-extra": "11.2.0",
     "micromatch": "4.0.5",
     "swagger-ui-dist": ">=5.17.1",
     "tslib": "2.6.1"
   },
   "devDependencies": {
-    "@tsed/barrels": "7.79.4",
-    "@tsed/common": "7.79.4",
-    "@tsed/core": "7.79.4",
-    "@tsed/di": "7.79.4",
-    "@tsed/json-mapper": "7.79.4",
+    "@tsed/barrels": "7.80.0",
+    "@tsed/common": "7.80.0",
+    "@tsed/core": "7.80.0",
+    "@tsed/di": "7.80.0",
+    "@tsed/json-mapper": "7.80.0",
     "@tsed/monorepo-utils": "2.3.2",
-    "@tsed/openspec": "7.79.4",
-    "@tsed/schema": "7.79.4",
-    "@tsed/typescript": "7.79.4",
+    "@tsed/openspec": "7.80.0",
+    "@tsed/schema": "7.80.0",
+    "@tsed/typescript": "7.80.0",
     "@types/swagger-ui-dist": "3.30.4",
     "eslint": "^8.57.0",
-    "jest": "^29.7.0",
     "ts-node": "10.9.2",
-    "typescript": "4.9.5"
+    "typescript": "4.9.5",
+    "vitest": "2.0.4"
   },
   "peerDependencies": {
-    "@tsed/common": "7.79.4"
+    "@tsed/common": "7.80.0"
   },
   "peerDependenciesMeta": {
     "@tsed/common": {

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
+        }
+      }
+    }
+  }
+);

package/lib/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/lib/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}