@tsed/scalar 8.11.0 → 8.11.2-rc.1

package/lib/esm/ScalarModule.js

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

package/lib/esm/constants.js

@@ -1,4 +1,3 @@
 import { join } from "node:path";
 import { getValue } from "@tsed/core";
 export const ROOT_DIR = join(getValue(import.meta, "dirname", ""), "..");
-//# sourceMappingURL=constants.js.map

package/lib/esm/exports.js

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

package/lib/esm/index.js

@@ -6,4 +6,3 @@ export * from "./exports.js";
 export * from "./interfaces/ScalarSettings.js";
 export * from "./middlewares/indexMiddleware.js";
 export * from "./ScalarModule.js";
-//# sourceMappingURL=index.js.map

package/lib/esm/interfaces/ScalarSettings.js

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

package/lib/esm/middlewares/indexMiddleware.js

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

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/scalar",
   "description": "Scalar package for Ts.ED framework",
   "type": "module",
-  "version": "8.11.0",
+  "version": "8.11.2-rc.1",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -27,21 +27,21 @@
   },
   "dependencies": {
     "@scalar/types": "^0.0.23",
-    "@tsed/normalize-path": "8.11.0",
-    "@tsed/openapi-utils": "8.11.0",
-    "@tsed/openspec": "8.11.0",
+    "@tsed/normalize-path": "8.11.2-rc.1",
+    "@tsed/openapi-utils": "8.11.2-rc.1",
+    "@tsed/openspec": "8.11.2-rc.1",
     "tslib": "2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.11.0",
-    "@tsed/core": "8.11.0",
-    "@tsed/di": "8.11.0",
-    "@tsed/json-mapper": "8.11.0",
-    "@tsed/openspec": "8.11.0",
-    "@tsed/platform-http": "8.11.0",
-    "@tsed/schema": "8.11.0",
-    "@tsed/swagger": "8.11.0",
-    "@tsed/typescript": "8.11.0",
+    "@tsed/barrels": "8.11.2-rc.1",
+    "@tsed/core": "8.11.2-rc.1",
+    "@tsed/di": "8.11.2-rc.1",
+    "@tsed/json-mapper": "8.11.2-rc.1",
+    "@tsed/openspec": "8.11.2-rc.1",
+    "@tsed/platform-http": "8.11.2-rc.1",
+    "@tsed/schema": "8.11.2-rc.1",
+    "@tsed/swagger": "8.11.2-rc.1",
+    "@tsed/typescript": "8.11.2-rc.1",
     "eslint": "9.12.0",
     "typescript": "5.4.5",
     "vitest": "3.1.4"
@@ -60,5 +60,8 @@
   },
   "homepage": "https://github.com/tsedio/tsed/tree/production/packages/specs/scalar",
   "author": "Romain Lenzotti",
-  "license": "MIT"
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "rc"
+  }
 }

package/lib/esm/ScalarModule.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ScalarModule.js","sourceRoot":"","sources":["../../src/ScalarModule.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,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAC,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AAExC,OAAO,EAAC,eAAe,EAAC,MAAM,kCAAkC,CAAC;AAEjE,MAAM,OAAO,YAAa,SAAQ,iBAAiB;IAAnD;;QACW,SAAI,GAAG,QAAQ,CAAC;QAChB,YAAO,GAAG,QAAQ,CAAC;IA8B9B,CAAC;IA5BC,IAAI,QAAQ;QACV,MAAM,QAAQ,GAAG,QAAQ,CAAmB,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE7E,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3B,OAAO,MAAM,CAAC,MAAM,CAClB;gBACE,WAAW,EAAE,KAAK;gBAClB,GAAG,EAAE,oDAAoD;gBACzD,IAAI,EAAE,GAAG;gBACT,QAAQ,EAAE,cAAc;gBACxB,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,yBAAyB,CAAC;gBAClD,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,kBAAkB,CAAC;aAC7C,EACD,IAAI,CACL,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAES,YAAY,CAAC,IAAoB;QACzC,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,CAAC,GAAG,EAAE,iBAAiB,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QACtE,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED,UAAU,CAAC,YAAY,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;AAEpC,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,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,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"ScalarSettings.js","sourceRoot":"","sources":["../../../src/interfaces/ScalarSettings.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,MAAM,UAAU,eAAe,CAAC,QAAgB,EAAE,IAAoB;IACpE,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;QACtB,MAAM,EAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC;QAE1D,MAAM,IAAI,GAAG;YACX,IAAI,EAAE;gBACJ,GAAG,EAAE,GAAG,IAAI,IAAI,QAAQ,EAAE;aAC3B;YACD,GAAG,OAAO;SACX,CAAC;QAEF,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,IAAI,CACxC,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE;YAClC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;YACtC,GAAG;YACH,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;YACjE,OAAO,EAAE,IAAI;SACd,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/src/ScalarModule.spec.ts

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

package/src/ScalarModule.ts

@@ -1,45 +0,0 @@
-import {join} from "node:path";
-
-import {constant, injectable, ProviderType} from "@tsed/di";
-import {OpenAPIBaseModule} from "@tsed/openapi-utils";
-import {useContextHandler} from "@tsed/platform-router";
-
-import {ROOT_DIR} from "./constants.js";
-import {ScalarSettings} from "./interfaces/ScalarSettings.js";
-import {indexMiddleware} from "./middlewares/indexMiddleware.js";
-
-export class ScalarModule extends OpenAPIBaseModule {
-  readonly name = "Scalar";
-  readonly rootDir = ROOT_DIR;
-
-  get settings() {
-    const settings = constant<ScalarSettings[]>("scalar", []).filter((o) => !!o);
-
-    return settings.map((conf) => {
-      return Object.assign(
-        {
-          disableSpec: false,
-          cdn: "https://cdn.jsdelivr.net/npm/@scalar/api-reference",
-          path: "/",
-          fileName: "openapi.json",
-          cssPath: join(ROOT_DIR, "views/assets/scalar.css"),
-          viewPath: join(ROOT_DIR, "views/scalar.ejs")
-        },
-        conf
-      );
-    });
-  }
-
-  protected createRouter(conf: ScalarSettings) {
-    const {viewPath} = conf;
-    const router = super.createRouter(conf);
-
-    if (viewPath) {
-      router.get("/", useContextHandler(indexMiddleware(viewPath, conf)));
-    }
-
-    return router;
-  }
-}
-
-injectable(ScalarModule).type(ProviderType.MODULE);

package/src/constants.ts

@@ -1,5 +0,0 @@
-import {join} from "node:path";
-
-import {getValue} from "@tsed/core";
-
-export const ROOT_DIR = join(getValue(import.meta, "dirname", ""), "..");

package/src/exports.ts

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

package/src/index.ts

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

package/src/interfaces/ScalarSettings.ts

@@ -1,9 +0,0 @@
-// @ts-ignore
-import type {ReferenceConfiguration} from "@scalar/types/legacy";
-import type {OpenApiSettings} from "@tsed/openapi-utils";
-
-export type ScalarSettings = OpenApiSettings &
-  ReferenceConfiguration & {
-    cdn?: string;
-    options?: ReferenceConfiguration;
-  };

package/src/middlewares/indexMiddleware.ts

@@ -1,28 +0,0 @@
-import {basename, join} from "node:path";
-
-import {context} from "@tsed/di";
-
-import {ScalarSettings} from "../interfaces/ScalarSettings.js";
-
-export function indexMiddleware(viewPath: string, conf: ScalarSettings) {
-  return async () => {
-    const ctx = context();
-    const {path, options = {}, cssPath, cdn, fileName} = conf;
-
-    const opts = {
-      spec: {
-        url: `${path}/${fileName}`
-      },
-      ...options
-    };
-
-    ctx.response.contentType("text/html").body(
-      await ctx.response.render(viewPath, {
-        cssPath: join(path, basename(cssPath)),
-        cdn,
-        serializedOptions: JSON.stringify(opts).split('"').join("""),
-        options: opts
-      })
-    );
-  };
-}

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