@tsed/swagger 8.2.0 → 8.3.0

package/lib/esm/utils/matchPath.js

@@ -1,5 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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"}

package/lib/esm/utils/readSpec.js

@@ -1,12 +0,0 @@
-export async function readSpec(path) {
-    const { default: fs } = await import("fs-extra");
-    if (fs.existsSync(path)) {
-        try {
-            return await fs.readJSON(path, { encoding: "utf8" });
-        }
-        catch (e) { }
-    }
-    /* istanbul ignore next */
-    return {};
-}
-//# sourceMappingURL=readSpec.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"readSpec.js","sourceRoot":"","sources":["../../../src/utils/readSpec.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,MAAM,EAAC,OAAO,EAAE,EAAE,EAAC,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;IAC/C,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC;YACH,OAAO,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;IAChB,CAAC;IAED,0BAA0B;IAC1B,OAAO,EAAE,CAAC;AACZ,CAAC"}

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

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

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

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

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

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

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

@@ -1,15 +0,0 @@
-import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
-import { Platform } from "@tsed/platform-http";
-import { SwaggerOS2Settings, SwaggerOS3Settings, SwaggerSettings } from "../interfaces/SwaggerSettings.js";
-export declare class SwaggerService {
-    #private;
-    protected platform: Platform;
-    constructor();
-    /**
-     * 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/utils/includeRoute.d.ts

@@ -1,3 +0,0 @@
-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/utils/matchPath.d.ts

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

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

@@ -1 +0,0 @@
-export declare function readSpec(path: string): Promise<any>;

package/src/decorators/docs.ts

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

@@ -1,24 +0,0 @@
-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", () => {
-    const ctx = PlatformTest.createRequestContext();
-
-    cssMiddleware("/path")(ctx);
-
-    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

@@ -1,19 +0,0 @@
-import {PlatformContext} from "@tsed/platform-http";
-import Fs from "fs";
-import {resolve} from "path";
-
-/**
- * @ignore
- * @param path
- */
-export function cssMiddleware(path: string) {
-  return (ctx: PlatformContext) => {
-    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

@@ -1,24 +0,0 @@
-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", () => {
-    const ctx = PlatformTest.createRequestContext();
-
-    jsMiddleware("/path")(ctx);
-
-    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

@@ -1,14 +0,0 @@
-import {PlatformContext} from "@tsed/platform-http";
-import Fs from "fs";
-import {resolve} from "path";
-
-/**
- * @ignore
- * @param path
- */
-export function jsMiddleware(path: string) {
-  return (ctx: PlatformContext) => {
-    const content = Fs.readFileSync(resolve(path), {encoding: "utf8"});
-    ctx.response.setHeaders({"Content-Type": "application/javascript"}).status(200).body(content);
-  };
-}

package/src/middlewares/redirectMiddleware.spec.ts

@@ -1,31 +0,0 @@
-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", () => {
-    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";
-
-    redirectMiddleware("/path")(ctx);
-
-    expect(ctx.response.redirect).toHaveBeenCalledWith(302, "/path/");
-  });
-  it("should create a middleware and call next", () => {
-    const ctx = PlatformTest.createRequestContext();
-    vi.spyOn(ctx.response, "redirect");
-    ctx.request.raw.url = "/path/";
-    ctx.request.raw.method = "GET";
-    ctx.request.raw.originalUrl = "/path/";
-
-    redirectMiddleware("/path")(ctx);
-
-    expect(ctx.response.redirect).not.toHaveBeenCalled();
-  });
-});

package/src/middlewares/redirectMiddleware.ts

@@ -1,13 +0,0 @@
-import {PlatformContext} from "@tsed/platform-http";
-
-/**
- * @ignore
- * @param path
- */
-export function redirectMiddleware(path: string) {
-  return (ctx: PlatformContext) => {
-    if (ctx.request.method?.toUpperCase() === "GET" && ctx.request.url === path && !ctx.request.url.match(/\/$/)) {
-      ctx.response.redirect(302, `${path}/`);
-    }
-  };
-}

package/src/services/SwaggerService.spec.ts

@@ -1,19 +0,0 @@
-import {PlatformTest} from "@tsed/platform-http/testing";
-
-import {SwaggerService} from "../index.js";
-
-describe("SwaggerService", () => {
-  beforeEach(() => PlatformTest.create());
-  afterEach(() => PlatformTest.reset());
-
-  describe("getOpenAPISpec()", () => {
-    it("should compile spec only once time", async () => {
-      const swaggerService = await PlatformTest.invoke<SwaggerService>(SwaggerService);
-      const result1 = await swaggerService.getOpenAPISpec({specVersion: "3.0.1"} as any);
-      const result2 = await swaggerService.getOpenAPISpec({specVersion: "3.0.1"} as any);
-
-      expect(result1).toEqual(result2);
-      expect(result1).toMatchSnapshot();
-    });
-  });
-});

package/src/services/SwaggerService.ts

@@ -1,51 +0,0 @@
-import type {Type} from "@tsed/core";
-import {constant, inject, injectable} from "@tsed/di";
-import {OpenSpec2, OpenSpec3} from "@tsed/openspec";
-import {Platform} from "@tsed/platform-http";
-import {generateSpec} from "@tsed/schema";
-
-import {SwaggerOS2Settings, SwaggerOS3Settings, SwaggerSettings} from "../interfaces/SwaggerSettings.js";
-import {includeRoute} from "../utils/includeRoute.js";
-import {readSpec} from "../utils/readSpec.js";
-
-export class SwaggerService {
-  protected platform = inject(Platform);
-
-  #specs: Map<string, OpenSpec3 | OpenSpec2> = new Map();
-
-  constructor() {}
-
-  /**
-   * Generate Spec for the given configuration
-   * @returns {Spec}
-   */
-  public async getOpenAPISpec(conf: SwaggerOS3Settings): Promise<OpenSpec3>;
-  public async getOpenAPISpec(conf: SwaggerOS2Settings): Promise<OpenSpec2>;
-  public async getOpenAPISpec(conf: SwaggerSettings): Promise<OpenSpec2>;
-  public async getOpenAPISpec(conf: SwaggerSettings) {
-    if (!this.#specs.has(conf.path)) {
-      const version = constant("version", "1.0.0");
-      const acceptMimes = constant<string>("acceptMimes");
-      const specPath = conf.specPath;
-
-      const tokens = this.platform
-        .getMountedControllers()
-        .filter(({routes, provider}) => [...routes.values()].some((route) => includeRoute(route, provider, conf)))
-        .map(({route, provider}) => ({token: provider.token as Type, rootPath: route}));
-
-      const spec = generateSpec({
-        tokens,
-        ...conf,
-        fileSpec: specPath ? await readSpec(specPath) : {},
-        version,
-        acceptMimes
-      });
-
-      this.#specs.set(conf.path, spec);
-    }
-
-    return this.#specs.get(conf.path);
-  }
-}
-
-injectable(SwaggerService);

package/src/services/__snapshots__/SwaggerService.spec.ts.snap

@@ -1,11 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`SwaggerService > getOpenAPISpec() > should compile spec only once time 1`] = `
-{
-  "info": {
-    "title": "Api documentation",
-    "version": "1.0.0",
-  },
-  "openapi": "3.0.1",
-}
-`;

package/src/utils/includeRoute.spec.ts

@@ -1,111 +0,0 @@
-import {ControllerProvider} from "@tsed/di";
-import {Hidden} from "@tsed/schema";
-
-import {Docs} from "../decorators/docs.js";
-import {includeRoute} from "./includeRoute.js";
-
-@Hidden()
-class HiddenCtrl {}
-
-@Docs("test")
-class DocsCtrl {}
-
-class PlainCtrl {}
-
-describe("includeRoute", () => {
-  it.each([
-    {
-      label: "a simple configuration + HiddenCtrl are given",
-      expected: false,
-      route: "/test",
-      conf: {
-        path: "/swagger"
-      },
-      controller: HiddenCtrl
-    },
-    {
-      label: "a simple configuration + PlainCtrl are given",
-      expected: true,
-      route: "/test",
-      conf: {
-        path: "/swagger"
-      },
-      controller: PlainCtrl
-    },
-    {
-      label: "a given configuration with doc property doesn't match route",
-      expected: false,
-      route: "/test",
-      conf: {
-        path: "/swagger",
-        doc: "notmatch"
-      },
-      controller: DocsCtrl
-    },
-    {
-      label: "a given configuration with doc property matching route",
-      expected: true,
-      route: "/test",
-      conf: {
-        path: "/swagger",
-        doc: "test"
-      },
-      controller: DocsCtrl
-    },
-    {
-      label: "a given configuration with pathPatterns property matching route",
-      expected: true,
-      route: "/should/match",
-      conf: {
-        path: "/swagger",
-        pathPatterns: ["/should/**"]
-      },
-      controller: PlainCtrl
-    },
-    {
-      label: "a given configuration with pathPatterns property doesn't match route",
-      expected: false,
-      route: "/shouldnot/match",
-      conf: {
-        path: "/swagger",
-        pathPatterns: ["/notmatch/**"]
-      },
-      controller: PlainCtrl
-    },
-    {
-      label: "a given configuration with pathPatterns property doesn't match route - negation on pathPatterns",
-      expected: false,
-      route: "/should/match",
-      conf: {
-        path: "/swagger",
-        pathPatterns: ["!/should/**"]
-      },
-      controller: PlainCtrl
-    },
-    {
-      label: "a given configuration with pathPatterns/doc properties but only doc match",
-      expected: true,
-      route: "/shouldnot/match",
-      conf: {
-        path: "/swagger",
-        doc: "test",
-        pathPatterns: ["/notmatch/**"]
-      },
-      controller: DocsCtrl
-    },
-    {
-      label: "a given configuration with pathPatterns/doc properties but only pathPattern match",
-      expected: true,
-      route: "/should/match",
-      conf: {
-        path: "/swagger",
-        doc: "nomatch",
-        pathPatterns: ["/should/**"]
-      },
-      controller: DocsCtrl
-    }
-  ])("should return $expected when $label ($route)", ({expected, conf, route, controller}) => {
-    const provider = new ControllerProvider(controller);
-    expect(includeRoute(route, provider, conf as any)).toBe(expected);
-  });
-});

package/src/utils/includeRoute.ts

@@ -1,22 +0,0 @@
-import {Provider} from "@tsed/di";
-
-import {SwaggerSettings} from "../interfaces/SwaggerSettings.js";
-import {matchPath} from "./matchPath.js";
-
-export function includeRoute(route: string, provider: Provider, conf: SwaggerSettings): boolean {
-  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);
-}

package/src/utils/matchPath.spec.ts

@@ -1,16 +0,0 @@
-import {matchPath} from "./matchPath.js";
-
-describe("matchPath", () => {
-  it("should match route with the glob pattern", () => {
-    expect(matchPath("/user", ["/user/**"])).toBe(true);
-    expect(matchPath("/user", [])).toBe(true);
-    expect(matchPath("/user")).toBe(true);
-    expect(matchPath("/test", ["!/user/**"])).toBe(true);
-  });
-
-  it("should not match route with the glob pattern", () => {
-    const result = matchPath("/test", ["/user/**"]);
-
-    expect(result).toBe(false);
-  });
-});

package/src/utils/matchPath.ts

@@ -1,5 +0,0 @@
-import micromatch from "micromatch";
-
-export function matchPath(path: string, patterns?: string[]) {
-  return patterns && patterns.length ? micromatch.isMatch(path, patterns) : true;
-}

package/src/utils/readSpec.ts

@@ -1,11 +0,0 @@
-export async function readSpec(path: string) {
-  const {default: fs} = await import("fs-extra");
-  if (fs.existsSync(path)) {
-    try {
-      return await fs.readJSON(path, {encoding: "utf8"});
-    } catch (e) {}
-  }
-
-  /* istanbul ignore next */
-  return {};
-}