@tsed/swagger 6.95.9 → 6.96.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/swagger",
-  "version": "6.95.9",
+  "version": "6.96.2",
   "description": "Swagger package for Ts.ED framework",
   "private": false,
   "source": "./src/index.ts",
@@ -25,20 +25,20 @@
     "tslib": "2.2.0"
   },
   "devDependencies": {
-    "@tsed/common": "6.95.9",
-    "@tsed/core": "6.95.9",
-    "@tsed/di": "6.95.9",
-    "@tsed/json-mapper": "6.95.9",
-    "@tsed/openspec": "6.95.9",
-    "@tsed/schema": "6.95.9"
+    "@tsed/common": "6.96.2",
+    "@tsed/core": "6.96.2",
+    "@tsed/di": "6.96.2",
+    "@tsed/json-mapper": "6.96.2",
+    "@tsed/openspec": "6.96.2",
+    "@tsed/schema": "6.96.2"
   },
   "peerDependencies": {
-    "@tsed/common": "^6.95.9",
-    "@tsed/core": "^6.95.9",
-    "@tsed/di": "^6.95.9",
-    "@tsed/json-mapper": "^6.95.9",
-    "@tsed/openspec": "^6.95.9",
-    "@tsed/schema": "^6.95.9"
+    "@tsed/common": "^6.96.2",
+    "@tsed/core": "^6.96.2",
+    "@tsed/di": "^6.96.2",
+    "@tsed/json-mapper": "^6.96.2",
+    "@tsed/openspec": "^6.96.2",
+    "@tsed/schema": "^6.96.2"
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {

package/lib/cjs/SwaggerModule.d.ts

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

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

@@ -1,10 +0,0 @@
-/**
- * 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/cjs/decorators/hidden.d.ts

@@ -1,32 +0,0 @@
-/**
- * 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/cjs/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./services/SwaggerService";
-export * from "./SwaggerModule";
-export * from "./interfaces";
-export * from "./decorators/docs";
-export * from "./decorators/hidden";

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

@@ -1,99 +0,0 @@
-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[];
-}
-/**
- * @deprecated Since 2021-09-03. Will be removed in v7.
- */
-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 declare type SwaggerSettings = SwaggerOS2Settings | SwaggerOS3Settings;

package/lib/cjs/interfaces/index.d.ts

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

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

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

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

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

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

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

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

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

package/lib/cjs/services/SwaggerService.d.ts

@@ -1,29 +0,0 @@
-import { Configuration, ControllerProvider, InjectorService, Platform } from "@tsed/common";
-import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
-import { SpecSerializerOptions } from "@tsed/schema";
-import { SwaggerOS2Settings, SwaggerOS3Settings, SwaggerSettings } from "../interfaces/SwaggerSettings";
-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): OpenSpec3;
-    getOpenAPISpec(conf: SwaggerOS2Settings): OpenSpec2;
-    getOpenAPISpec(conf: SwaggerSettings): OpenSpec2;
-    /**
-     * Return the global api information.
-     */
-    protected getDefaultSpec(conf: Partial<SwaggerSettings>): Partial<OpenSpec2 | OpenSpec3>;
-    protected readSpecPath(path: string): any;
-    /**
-     *
-     * @param ctrl
-     * @param options
-     */
-    protected buildRoutes(ctrl: ControllerProvider, options: SpecSerializerOptions): Partial<OpenSpec2>;
-}

package/lib/cjs/utils/getSpecType.d.ts

@@ -1,12 +0,0 @@
-import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
-import { SpecTypes } from "@tsed/schema";
-/**
- * @ignore
- * @param version
- */
-export declare function getSpecType(version: string): SpecTypes.SWAGGER | SpecTypes.OPENAPI;
-/**
- * @ignore
- * @param spec
- */
-export declare function getSpecTypeFromSpec(spec: Partial<OpenSpec2 | OpenSpec3>): SpecTypes.SWAGGER | SpecTypes.OPENAPI;

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

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

package/lib/cjs/utils/index.d.ts

@@ -1,7 +0,0 @@
-export * from "./getSpecType";
-export * from "./mapOpenSpec";
-export * from "./mapOpenSpec2";
-export * from "./mapOpenSpec3";
-export * from "./mapOpenSpecInfo";
-export * from "./mapOpenSpecInfo";
-export * from "./matchPath";

package/lib/cjs/utils/mapOpenSpec.d.ts

@@ -1,10 +0,0 @@
-import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
-/**
- * @ignore
- * @param spec
- * @param fileSpec
- * @param version
- * @param acceptMimes
- * @param specVersion
- */
-export declare function mapOpenSpec(spec: any, { fileSpec, acceptMimes, specVersion, version }: any): Partial<OpenSpec2 | OpenSpec3>;

package/lib/cjs/utils/mapOpenSpec2.d.ts

@@ -1,9 +0,0 @@
-import { OpenSpec2 } from "@tsed/openspec";
-/**
- * @ignore
- * @param spec
- * @param version
- * @param specVersion
- * @param acceptMimes
- */
-export declare function mapOpenSpec2(spec: Partial<OpenSpec2>, { version, specVersion, acceptMimes }: any): Partial<OpenSpec2>;

package/lib/cjs/utils/mapOpenSpec3.d.ts

@@ -1,8 +0,0 @@
-import { OpenSpec3 } from "@tsed/openspec";
-/**
- * @ignore
- * @param spec
- * @param version
- * @param specVersion
- */
-export declare function mapOpenSpec3(spec: any, { specVersion }: any): Partial<OpenSpec3>;

package/lib/cjs/utils/mapOpenSpecInfo.d.ts

@@ -1,6 +0,0 @@
-import { OpenSpecInfo } from "@tsed/openspec";
-/**
- * @ignore
- * @param info
- */
-export declare function mapOpenSpecInfo(info: Partial<OpenSpecInfo>): OpenSpecInfo;

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

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