@tsed/swagger 6.88.1 → 6.92.0

package/lib/esm/utils/getSpecType.js

@@ -0,0 +1,16 @@
+import { SpecTypes } from "@tsed/schema";
+/**
+ * @ignore
+ * @param version
+ */
+export function getSpecType(version) {
+    return version.startsWith("3.") ? SpecTypes.OPENAPI : SpecTypes.SWAGGER;
+}
+/**
+ * @ignore
+ * @param spec
+ */
+export function getSpecTypeFromSpec(spec) {
+    return "openapi" in spec ? SpecTypes.OPENAPI : SpecTypes.SWAGGER;
+}
+//# sourceMappingURL=getSpecType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getSpecType.js","sourceRoot":"","sources":["../../../src/utils/getSpecType.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AAEvC;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,OAAe;IACzC,OAAO,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC;AAC1E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAoC;IACtE,OAAO,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC;AACnE,CAAC","sourcesContent":["import {OpenSpec2, OpenSpec3} from \"@tsed/openspec\";\nimport {SpecTypes} from \"@tsed/schema\";\n\n/**\n * @ignore\n * @param version\n */\nexport function getSpecType(version: string) {\n  return version.startsWith(\"3.\") ? SpecTypes.OPENAPI : SpecTypes.SWAGGER;\n}\n\n/**\n * @ignore\n * @param spec\n */\nexport function getSpecTypeFromSpec(spec: Partial<OpenSpec2 | OpenSpec3>) {\n  return \"openapi\" in spec ? SpecTypes.OPENAPI : SpecTypes.SWAGGER;\n}\n"]}

package/lib/esm/utils/includeRoute.js

@@ -0,0 +1,16 @@
+import { matchPath } from ".";
+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":"AACA,OAAO,EAAC,SAAS,EAAC,MAAM,GAAG,CAAC;AAG5B,MAAM,UAAU,YAAY,CAAC,KAAa,EAAE,QAA4B,EAAE,IAAqB;IAC7F,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;QACV,OAAO,KAAK,CAAC;KACd;IAED,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE;QACzB,OAAO,IAAI,CAAC;KACb;IAED,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,gBAAgB,CAAC,CAAC;AACvC,CAAC","sourcesContent":["import {ControllerProvider} from \"@tsed/common\";\nimport {matchPath} from \".\";\nimport {SwaggerSettings} from \"..\";\n\nexport function includeRoute(route: string, provider: ControllerProvider, conf: SwaggerSettings): boolean {\n  const hidden = provider.store.get(\"hidden\");\n  const docs = provider.store.get(\"docs\") || [];\n  const {doc, pathPatterns} = conf;\n  const inDoc = doc && docs.indexOf(doc) > -1;\n  const pathPatternMatch = pathPatterns && matchPath(route, pathPatterns);\n\n  if (hidden) {\n    return false;\n  }\n\n  if (!doc && !pathPatterns) {\n    return true;\n  }\n\n  return !!(inDoc || pathPatternMatch);\n}\n"]}

package/lib/esm/utils/index.js

@@ -0,0 +1,8 @@
+export * from "./getSpecType";
+export * from "./mapOpenSpec";
+export * from "./mapOpenSpec2";
+export * from "./mapOpenSpec3";
+export * from "./mapOpenSpecInfo";
+export * from "./mapOpenSpecInfo";
+export * from "./matchPath";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC","sourcesContent":["export * from \"./getSpecType\";\nexport * from \"./mapOpenSpec\";\nexport * from \"./mapOpenSpec2\";\nexport * from \"./mapOpenSpec3\";\nexport * from \"./mapOpenSpecInfo\";\nexport * from \"./mapOpenSpecInfo\";\nexport * from \"./matchPath\";\n"]}

package/lib/esm/utils/mapOpenSpec.js

@@ -0,0 +1,36 @@
+import { getValue, setValue } from "@tsed/core";
+import { mergeSpec, SpecTypes } from "@tsed/schema";
+import { getSpecType } from "./getSpecType";
+import { mapOpenSpec2 } from "./mapOpenSpec2";
+import { mapOpenSpec3 } from "./mapOpenSpec3";
+/**
+ * @ignore
+ * @param spec
+ * @param fileSpec
+ * @param version
+ * @param acceptMimes
+ * @param specVersion
+ */
+export function mapOpenSpec(spec, { fileSpec, acceptMimes, specVersion, version }) {
+    specVersion = specVersion || getValue(spec, "openapi", getValue(spec, "swagger", "2.0"));
+    const options = {
+        specVersion,
+        acceptMimes
+    };
+    switch (getSpecType(specVersion)) {
+        case SpecTypes.OPENAPI:
+            spec = mapOpenSpec3(spec, options);
+            fileSpec = fileSpec ? mapOpenSpec3(fileSpec, options) : fileSpec;
+            break;
+        default:
+        case SpecTypes.SWAGGER:
+            spec = mapOpenSpec2(spec, options);
+            fileSpec = fileSpec ? mapOpenSpec2(fileSpec, options) : fileSpec;
+            break;
+    }
+    spec = mergeSpec(spec, fileSpec);
+    setValue(spec, "info.title", getValue(spec, "info.title", "Api documentation"));
+    setValue(spec, "info.version", getValue(spec, "info.version", version));
+    return spec;
+}
+//# sourceMappingURL=mapOpenSpec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mapOpenSpec.js","sourceRoot":"","sources":["../../../src/utils/mapOpenSpec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAE,QAAQ,EAAC,MAAM,YAAY,CAAC;AAE9C,OAAO,EAAC,SAAS,EAAE,SAAS,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,IAAS,EAAE,EAAC,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAM;IACvF,WAAW,GAAG,WAAW,IAAI,QAAQ,CAAmB,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;IAE3G,MAAM,OAAO,GAAG;QACd,WAAW;QACX,WAAW;KACZ,CAAC;IAEF,QAAQ,WAAW,CAAC,WAAW,CAAC,EAAE;QAChC,KAAK,SAAS,CAAC,OAAO;YACpB,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACnC,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;YACjE,MAAM;QACR,QAAQ;QACR,KAAK,SAAS,CAAC,OAAO;YACpB,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACnC,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;YACjE,MAAM;KACT;IAED,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAEjC,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAChF,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;IAExE,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import {getValue, setValue} from \"@tsed/core\";\nimport {OpenSpec2, OpenSpec3, OpenSpecVersions} from \"@tsed/openspec\";\nimport {mergeSpec, SpecTypes} from \"@tsed/schema\";\nimport {getSpecType} from \"./getSpecType\";\nimport {mapOpenSpec2} from \"./mapOpenSpec2\";\nimport {mapOpenSpec3} from \"./mapOpenSpec3\";\n\n/**\n * @ignore\n * @param spec\n * @param fileSpec\n * @param version\n * @param acceptMimes\n * @param specVersion\n */\nexport function mapOpenSpec(spec: any, {fileSpec, acceptMimes, specVersion, version}: any): Partial<OpenSpec2 | OpenSpec3> {\n  specVersion = specVersion || getValue<OpenSpecVersions>(spec, \"openapi\", getValue(spec, \"swagger\", \"2.0\"));\n\n  const options = {\n    specVersion,\n    acceptMimes\n  };\n\n  switch (getSpecType(specVersion)) {\n    case SpecTypes.OPENAPI:\n      spec = mapOpenSpec3(spec, options);\n      fileSpec = fileSpec ? mapOpenSpec3(fileSpec, options) : fileSpec;\n      break;\n    default:\n    case SpecTypes.SWAGGER:\n      spec = mapOpenSpec2(spec, options);\n      fileSpec = fileSpec ? mapOpenSpec2(fileSpec, options) : fileSpec;\n      break;\n  }\n\n  spec = mergeSpec(spec, fileSpec);\n\n  setValue(spec, \"info.title\", getValue(spec, \"info.title\", \"Api documentation\"));\n  setValue(spec, \"info.version\", getValue(spec, \"info.version\", version));\n\n  return spec;\n}\n"]}

package/lib/esm/utils/mapOpenSpec2.js

@@ -0,0 +1,30 @@
+import { getValue, uniq } from "@tsed/core";
+import { mapOpenSpecInfo } from "./mapOpenSpecInfo";
+/**
+ * @ignore
+ * @param spec
+ * @param version
+ * @param specVersion
+ * @param acceptMimes
+ */
+export function mapOpenSpec2(spec, { version, specVersion, acceptMimes = ["application/json"] }) {
+    const { paths, security, tags, host, basePath, schemes, consumes = [], produces = ["application/json"], definitions, parameters, responses, securityDefinitions, externalDocs } = spec;
+    return {
+        swagger: specVersion,
+        consumes: uniq([...acceptMimes, ...consumes]),
+        produces: uniq([...produces]),
+        info: mapOpenSpecInfo(getValue(spec, "info", {})),
+        paths,
+        host,
+        basePath,
+        schemes,
+        definitions,
+        parameters,
+        responses,
+        security,
+        securityDefinitions,
+        tags,
+        externalDocs
+    };
+}
+//# sourceMappingURL=mapOpenSpec2.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mapOpenSpec2.js","sourceRoot":"","sources":["../../../src/utils/mapOpenSpec2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAE,IAAI,EAAC,MAAM,YAAY,CAAC;AAE1C,OAAO,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAwB,EACxB,EAAC,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,CAAC,kBAAkB,CAAC,EAAM;IAE/D,MAAM,EACJ,KAAK,EACL,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,QAAQ,GAAG,EAAE,EACb,QAAQ,GAAG,CAAC,kBAAkB,CAAC,EAC/B,WAAW,EACX,UAAU,EACV,SAAS,EACT,mBAAmB,EACnB,YAAY,EACb,GAAG,IAAI,CAAC;IAET,OAAO;QACL,OAAO,EAAE,WAAW;QACpB,QAAQ,EAAE,IAAI,CAAC,CAAC,GAAG,WAAW,EAAE,GAAG,QAAQ,CAAC,CAAC;QAC7C,QAAQ,EAAE,IAAI,CAAS,CAAC,GAAG,QAAQ,CAAC,CAAC;QACrC,IAAI,EAAE,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACjD,KAAK;QACL,IAAI;QACJ,QAAQ;QACR,OAAO;QACP,WAAW;QACX,UAAU;QACV,SAAS;QACT,QAAQ;QACR,mBAAmB;QACnB,IAAI;QACJ,YAAY;KACb,CAAC;AACJ,CAAC","sourcesContent":["import {getValue, uniq} from \"@tsed/core\";\nimport {OpenSpec2} from \"@tsed/openspec\";\nimport {mapOpenSpecInfo} from \"./mapOpenSpecInfo\";\n\n/**\n * @ignore\n * @param spec\n * @param version\n * @param specVersion\n * @param acceptMimes\n */\nexport function mapOpenSpec2(\n  spec: Partial<OpenSpec2>,\n  {version, specVersion, acceptMimes = [\"application/json\"]}: any\n): Partial<OpenSpec2> {\n  const {\n    paths,\n    security,\n    tags,\n    host,\n    basePath,\n    schemes,\n    consumes = [],\n    produces = [\"application/json\"],\n    definitions,\n    parameters,\n    responses,\n    securityDefinitions,\n    externalDocs\n  } = spec;\n\n  return {\n    swagger: specVersion,\n    consumes: uniq([...acceptMimes, ...consumes]),\n    produces: uniq<string>([...produces]),\n    info: mapOpenSpecInfo(getValue(spec, \"info\", {})),\n    paths,\n    host,\n    basePath,\n    schemes,\n    definitions,\n    parameters,\n    responses,\n    security,\n    securityDefinitions,\n    tags,\n    externalDocs\n  };\n}\n"]}

package/lib/esm/utils/mapOpenSpec3.js

@@ -0,0 +1,22 @@
+import { getValue } from "@tsed/core";
+import { mapOpenSpecInfo } from "./mapOpenSpecInfo";
+/**
+ * @ignore
+ * @param spec
+ * @param version
+ * @param specVersion
+ */
+export function mapOpenSpec3(spec, { specVersion }) {
+    const { servers, paths, components, security, tags, externalDocs } = spec;
+    return {
+        openapi: specVersion,
+        info: mapOpenSpecInfo(getValue(spec, "info", {})),
+        servers,
+        paths,
+        components,
+        security,
+        tags,
+        externalDocs
+    };
+}
+//# sourceMappingURL=mapOpenSpec3.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mapOpenSpec3.js","sourceRoot":"","sources":["../../../src/utils/mapOpenSpec3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AAEpC,OAAO,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAElD;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,IAAS,EAAE,EAAC,WAAW,EAAM;IACxD,MAAM,EAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAC,GAAG,IAAI,CAAC;IAExE,OAAO;QACL,OAAO,EAAE,WAAW;QACpB,IAAI,EAAE,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACjD,OAAO;QACP,KAAK;QACL,UAAU;QACV,QAAQ;QACR,IAAI;QACJ,YAAY;KACb,CAAC;AACJ,CAAC","sourcesContent":["import {getValue} from \"@tsed/core\";\nimport {OpenSpec3} from \"@tsed/openspec\";\nimport {mapOpenSpecInfo} from \"./mapOpenSpecInfo\";\n\n/**\n * @ignore\n * @param spec\n * @param version\n * @param specVersion\n */\nexport function mapOpenSpec3(spec: any, {specVersion}: any): Partial<OpenSpec3> {\n  const {servers, paths, components, security, tags, externalDocs} = spec;\n\n  return {\n    openapi: specVersion,\n    info: mapOpenSpecInfo(getValue(spec, \"info\", {})),\n    servers,\n    paths,\n    components,\n    security,\n    tags,\n    externalDocs\n  };\n}\n"]}

package/lib/esm/utils/mapOpenSpecInfo.js

@@ -0,0 +1,17 @@
+import { cleanObject } from "@tsed/core";
+/**
+ * @ignore
+ * @param info
+ */
+export function mapOpenSpecInfo(info) {
+    const { title, description, version, termsOfService, contact, license } = info;
+    return cleanObject({
+        version,
+        title,
+        description,
+        termsOfService,
+        contact,
+        license
+    });
+}
+//# sourceMappingURL=mapOpenSpecInfo.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mapOpenSpecInfo.js","sourceRoot":"","sources":["../../../src/utils/mapOpenSpecInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,YAAY,CAAC;AAGvC;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,IAA2B;IACzD,MAAM,EAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC;IAE7E,OAAO,WAAW,CAAC;QACjB,OAAO;QACP,KAAK;QACL,WAAW;QACX,cAAc;QACd,OAAO;QACP,OAAO;KACR,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {cleanObject} from \"@tsed/core\";\nimport {OpenSpecInfo} from \"@tsed/openspec\";\n\n/**\n * @ignore\n * @param info\n */\nexport function mapOpenSpecInfo(info: Partial<OpenSpecInfo>): OpenSpecInfo {\n  const {title, description, version, termsOfService, contact, license} = info;\n\n  return cleanObject({\n    version,\n    title,\n    description,\n    termsOfService,\n    contact,\n    license\n  });\n}\n"]}

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","sourcesContent":["import micromatch from \"micromatch\";\n\nexport function matchPath(path: string, patterns?: string[]) {\n  return patterns && patterns.length ? micromatch.isMatch(path, patterns) : true;\n}\n"]}

package/lib/types/SwaggerModule.d.ts

@@ -0,0 +1,30 @@
+import { BeforeRoutesInit, 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 BeforeRoutesInit, OnReady {
+    injector: InjectorService;
+    app: PlatformApplication;
+    configuration: Configuration;
+    swaggerService: SwaggerService;
+    env: Env;
+    private loaded;
+    get settings(): SwaggerSettings[];
+    /**
+     *
+     */
+    $beforeRoutesInit(): void;
+    $onReady(): void;
+    generateSpecFiles(): Promise<void[]>;
+    private getUrls;
+    /**
+     *
+     * @param conf
+     * @param urls
+     */
+    private createRouter;
+    private middlewareSwaggerJson;
+}

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/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/index.d.ts

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

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

@@ -0,0 +1,99 @@
+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/types/interfaces/index.d.ts

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

package/lib/types/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/middlewares/indexMiddleware.d.ts

@@ -0,0 +1,10 @@
+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/types/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/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/services/SwaggerService.d.ts

@@ -0,0 +1,29 @@
+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/types/utils/getSpecType.d.ts

@@ -0,0 +1,12 @@
+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/types/utils/includeRoute.d.ts

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

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

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

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

@@ -0,0 +1,10 @@
+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/types/utils/mapOpenSpec2.d.ts

@@ -0,0 +1,9 @@
+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/types/utils/mapOpenSpec3.d.ts

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

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

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

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

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