@tsed/swagger 8.11.1 → 8.12.0-rc.1

package/lib/esm/SwaggerModule.js

@@ -46,4 +46,3 @@ export class SwaggerModule extends OpenAPIBaseModule {
     }
 }
 injectable(SwaggerModule).type(ProviderType.MODULE);
-//# sourceMappingURL=SwaggerModule.js.map

package/lib/esm/constants.js

@@ -3,4 +3,3 @@ import { getValue } from "@tsed/core";
 import getAbsoluteFSPath from "swagger-ui-dist/absolute-path.js";
 export const SWAGGER_UI_DIST = getAbsoluteFSPath();
 export const ROOT_DIR = join(getValue(import.meta, "dirname", ""), "..");
-//# sourceMappingURL=constants.js.map

package/lib/esm/exports.js

@@ -1,2 +1 @@
 export { Docs, OpenAPIService as SwaggerService } from "@tsed/openapi-utils";
-//# sourceMappingURL=exports.js.map

package/lib/esm/index.js

@@ -7,4 +7,3 @@ export * from "./interfaces/interfaces.js";
 export * from "./interfaces/SwaggerSettings.js";
 export * from "./middlewares/indexMiddleware.js";
 export * from "./SwaggerModule.js";
-//# sourceMappingURL=index.js.map

package/lib/esm/interfaces/SwaggerSettings.js

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

package/lib/esm/interfaces/interfaces.js

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

package/lib/esm/middlewares/indexMiddleware.js

@@ -20,4 +20,3 @@ export function indexMiddleware(viewPath, conf) {
         }));
     };
 }
-//# sourceMappingURL=indexMiddleware.js.map

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/swagger",
   "description": "Swagger package for Ts.ED framework",
   "type": "module",
-  "version": "8.11.1",
+  "version": "8.12.0-rc.1",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -26,22 +26,22 @@
     "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
   },
   "dependencies": {
-    "@tsed/normalize-path": "8.11.1",
-    "@tsed/openapi-utils": "8.11.1",
-    "@tsed/openspec": "8.11.1",
+    "@tsed/normalize-path": "8.12.0-rc.1",
+    "@tsed/openapi-utils": "8.12.0-rc.1",
+    "@tsed/openspec": "8.12.0-rc.1",
     "swagger-ui-dist": ">=5.17.14",
     "tslib": "2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.11.1",
-    "@tsed/core": "8.11.1",
-    "@tsed/di": "8.11.1",
-    "@tsed/json-mapper": "8.11.1",
-    "@tsed/openapi-utils": "8.11.1",
-    "@tsed/openspec": "8.11.1",
-    "@tsed/platform-http": "8.11.1",
-    "@tsed/schema": "8.11.1",
-    "@tsed/typescript": "8.11.1",
+    "@tsed/barrels": "8.12.0-rc.1",
+    "@tsed/core": "8.12.0-rc.1",
+    "@tsed/di": "8.12.0-rc.1",
+    "@tsed/json-mapper": "8.12.0-rc.1",
+    "@tsed/openapi-utils": "8.12.0-rc.1",
+    "@tsed/openspec": "8.12.0-rc.1",
+    "@tsed/platform-http": "8.12.0-rc.1",
+    "@tsed/schema": "8.12.0-rc.1",
+    "@tsed/typescript": "8.12.0-rc.1",
     "@types/swagger-ui-dist": "3.30.5",
     "eslint": "9.12.0",
     "typescript": "5.4.5",
@@ -61,5 +61,8 @@
   },
   "homepage": "https://github.com/tsedio/tsed/tree/production/packages/specs/swagger",
   "author": "Romain Lenzotti",
-  "license": "MIT"
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "rc"
+  }
 }

package/lib/esm/SwaggerModule.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SwaggerModule.js","sourceRoot":"","sources":["../../src/SwaggerModule.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,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAC,QAAQ,EAAE,eAAe,EAAC,MAAM,gBAAgB,CAAC;AAEzD,OAAO,EAAC,eAAe,EAAC,MAAM,kCAAkC,CAAC;AAEjE,MAAM,OAAO,aAAc,SAAQ,iBAAiB;IAApD;;QACW,SAAI,GAAG,SAAS,CAAC;QACjB,YAAO,GAAG,QAAQ,CAAC;IAkD9B,CAAC;IAhDC,IAAI,QAAQ;QACV,MAAM,QAAQ,GAAG,QAAQ,CAAoB,SAAS,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/E,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3B,OAAO,MAAM,CAAC,MAAM,CAClB;gBACE,WAAW,EAAE,KAAK;gBAClB,IAAI,EAAE,GAAG;gBACT,QAAQ,EAAE,cAAc;gBACxB,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,0BAA0B,CAAC;gBACnD,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC;aAC5C,EACD,IAAI,CACL,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAES,YAAY,CAAC,IAAqB;QAC1C,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,CACR,GAAG,EACH,iBAAiB,CACf,eAAe,CAAC,QAAQ,EAAE;gBACxB,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;gBACpB,GAAG,IAAI;aACR,CAAC,CACH,CACF,CAAC;YACF,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAC,IAAI,EAAE,eAAe,EAAC,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,OAAO;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAU,EAAE,IAAI,EAAE,EAAE;YAC/C,MAAM,EAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAC,GAAG,IAAI,CAAC;YAE3C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,GAAG,CAAC,IAAI,CAAC,EAAC,GAAG,EAAE,aAAa,CAAC,IAAI,EAAE,QAAS,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAC,CAAC,CAAC;YACrE,CAAC;YAED,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;CACF;AAED,UAAU,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC"}

package/lib/esm/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAE/B,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AACpC,OAAO,iBAAiB,MAAM,kCAAkC,CAAC;AAEjE,MAAM,CAAC,MAAM,eAAe,GAAG,iBAAiB,EAAE,CAAC;AACnD,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC"}

package/lib/esm/exports.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"exports.js","sourceRoot":"","sources":["../../src/exports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAE,cAAc,IAAI,cAAc,EAAC,MAAM,qBAAqB,CAAC"}

package/lib/esm/index.js.map

@@ -1 +0,0 @@
-{"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,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,oBAAoB,CAAC"}

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

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

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

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"indexMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/indexMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAE,IAAI,EAAC,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AAIjC;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,QAAgB,EAAE,IAAwC;IACxF,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;QACtB,MAAM,EAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC;QAEjF,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,IAAI,CACxC,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE;YAClC,IAAI,EAAE,EAAE;YACR,GAAG,EAAE,GAAG,IAAI,IAAI,QAAQ,EAAE;YAC1B,IAAI;YACJ,YAAY;YACZ,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;YACjD,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC9C,cAAc,EAAE,OAAO;SACxB,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/src/SwaggerModule.spec.ts

@@ -1,64 +0,0 @@
-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 {absolutePath} from "swagger-ui-dist";
-
-import {SwaggerModule} from "./SwaggerModule.js";
-
-vi.mock("node:fs/promises");
-
-describe("SwaggerModule", () => {
-  beforeEach(() =>
-    PlatformTest.create({
-      httpPort: 8080,
-      httpsPort: 8081,
-      swagger: [
-        {
-          path: "/doc",
-          cssPath: "/cssPath/style.css",
-          jsPath: "/jsPath/script.js",
-          viewPath: "/viewsPath",
-          outFile: "/spec.json"
-        }
-      ]
-    })
-  );
-  afterEach(PlatformTest.reset);
-
-  describe("$onRoutesInit", () => {
-    it("should add middlewares", async () => {
-      const mod = await PlatformTest.invoke<SwaggerModule>(SwaggerModule);
-
-      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("/swagger.json", expect.any(Function));
-      expect(PlatformRouter.prototype.get).toHaveBeenCalledWith("/style.css", expect.any(Function));
-      expect(PlatformRouter.prototype.get).toHaveBeenCalledWith("/script.js", expect.any(Function));
-      expect(PlatformRouter.prototype.statics).toHaveBeenCalledWith("/", {
-        root: absolutePath()
-      });
-    });
-  });
-
-  describe("$onReady", () => {
-    it("should display the right log", async () => {
-      const mod = await PlatformTest.invoke<SwaggerModule>(SwaggerModule);
-
-      vi.spyOn(logger(), "info");
-
-      mod.$onReady();
-
-      expect(logger().info).toHaveBeenCalledWith("[default] OpenAPI JSON is available on https://0.0.0.0:8081/doc/swagger.json");
-      expect(logger().info).toHaveBeenCalledWith("[default] Swagger UI is available on https://0.0.0.0:8081/doc/");
-    });
-  });
-});

package/src/SwaggerModule.ts

@@ -1,66 +0,0 @@
-import {join} from "node:path";
-
-import {constant, injectable, ProviderType} from "@tsed/di";
-import {normalizePath} from "@tsed/normalize-path";
-import {OpenAPIBaseModule} from "@tsed/openapi-utils";
-import {useContextHandler} from "@tsed/platform-router";
-
-import {ROOT_DIR, SWAGGER_UI_DIST} from "./constants.js";
-import {SwaggerSettings} from "./interfaces/SwaggerSettings.js";
-import {indexMiddleware} from "./middlewares/indexMiddleware.js";
-
-export class SwaggerModule extends OpenAPIBaseModule {
-  readonly name = "Swagger";
-  readonly rootDir = ROOT_DIR;
-
-  get settings() {
-    const settings = constant<SwaggerSettings[]>("swagger", []).filter((o) => !!o);
-
-    return settings.map((conf) => {
-      return Object.assign(
-        {
-          disableSpec: false,
-          path: "/",
-          fileName: "swagger.json",
-          cssPath: join(ROOT_DIR, "views/assets/swagger.css"),
-          viewPath: join(ROOT_DIR, "views/index.ejs")
-        },
-        conf
-      );
-    });
-  }
-
-  protected createRouter(conf: SwaggerSettings) {
-    const {viewPath} = conf;
-    const router = super.createRouter(conf);
-
-    if (viewPath) {
-      router.get(
-        "/",
-        useContextHandler(
-          indexMiddleware(viewPath, {
-            urls: this.getUrls(),
-            ...conf
-          })
-        )
-      );
-      router.statics("/", {root: SWAGGER_UI_DIST});
-    }
-
-    return router;
-  }
-
-  protected getUrls() {
-    return this.settings.reduce((acc: any[], conf) => {
-      const {path, fileName, doc, hidden} = conf;
-
-      if (!hidden) {
-        acc.push({url: normalizePath(path, fileName!), name: doc || path});
-      }
-
-      return acc;
-    }, []);
-  }
-}
-
-injectable(SwaggerModule).type(ProviderType.MODULE);

package/src/constants.ts

@@ -1,7 +0,0 @@
-import {join} from "node:path";
-
-import {getValue} from "@tsed/core";
-import getAbsoluteFSPath from "swagger-ui-dist/absolute-path.js";
-
-export const SWAGGER_UI_DIST = getAbsoluteFSPath();
-export const ROOT_DIR = join(getValue(import.meta, "dirname", ""), "..");

package/src/exports.ts

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

package/src/index.ts

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

package/src/interfaces/SwaggerSettings.ts

@@ -1,23 +0,0 @@
-import type {OpenAPI3Settings, OpenApiSettings, Swagger2Settings} from "@tsed/openapi-utils";
-
-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 type SwaggerOS2Settings = Swagger2Settings;
-export type SwaggerOS3Settings = OpenAPI3Settings;
-export type SwaggerSettings = OpenApiSettings & {
-  showExplorer?: boolean;
-  /**
-   * SwaggerUI options. See (https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md)
-   */
-  options?: SwaggerUIOptions;
-};

package/src/interfaces/interfaces.ts

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

package/src/middlewares/indexMiddleware.spec.ts

@@ -1,36 +0,0 @@
-import {runInContext} from "@tsed/di";
-import {PlatformTest} from "@tsed/platform-http/testing";
-
-import {indexMiddleware} from "./indexMiddleware.js";
-
-describe("indexMiddleware and redirect", () => {
-  beforeEach(PlatformTest.create);
-  afterEach(PlatformTest.reset);
-  it("should create a middleware", async () => {
-    const ctx = PlatformTest.createRequestContext();
-    vi.spyOn(ctx.response, "render").mockResolvedValue("");
-
-    const viewPath = "/swagger.ejs";
-    const conf = {
-      path: "/doc",
-      options: {},
-      fileName: "swagger.json",
-      showExplorer: false,
-      cssPath: "/path.css",
-      jsPath: "/path.js",
-      urls: []
-    };
-
-    await runInContext(ctx, () => indexMiddleware(viewPath, conf)());
-
-    expect(ctx.response.render).toHaveBeenCalledWith(viewPath, {
-      spec: {},
-      cssPath: "/doc/path.css",
-      jsPath: "/doc/path.js",
-      showExplorer: false,
-      swaggerOptions: {},
-      url: "/doc/swagger.json",
-      urls: []
-    });
-  });
-});

package/src/middlewares/indexMiddleware.ts

@@ -1,29 +0,0 @@
-import {basename, join} from "node:path";
-
-import {context} from "@tsed/di";
-
-import {SwaggerSettings} from "../interfaces/SwaggerSettings.js";
-
-/**
- * @ignore
- * @param viewPath
- * @param conf
- */
-export function indexMiddleware(viewPath: string, conf: SwaggerSettings & {urls: string[]}) {
-  return async () => {
-    const ctx = context();
-    const {path, options = {}, fileName, showExplorer, cssPath, jsPath, urls} = conf;
-
-    ctx.response.contentType("text/html").body(
-      await ctx.response.render(viewPath, {
-        spec: {},
-        url: `${path}/${fileName}`,
-        urls,
-        showExplorer,
-        cssPath: cssPath && join(path, basename(cssPath)),
-        jsPath: jsPath && join(path, basename(jsPath)),
-        swaggerOptions: options
-      })
-    );
-  };
-}

package/vitest.config.mts

@@ -1,21 +0,0 @@
-// @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
-        }
-      }
-    }
-  }
-);