@hestjs/scalar 0.1.3 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,13 +11,13 @@ declare module "@hestjs/core" {
11
11
  */
12
12
  useScalar(config: ScalarConfig): void;
13
13
  /**
14
+ * 弃用,使用 useScalarAutoDiscover 方法
14
15
  * 从控制器自动生成 OpenAPI 并配置 Scalar(手动传入控制器)
15
16
  */
16
- useScalarWithControllers(controllers: ControllerConstructor[], generatorConfig: OpenAPIGeneratorConfig, scalarConfig?: Omit<ScalarConfig, 'spec'>): void;
17
17
  /**
18
- * 自动发现控制器并生成 OpenAPI 文档
18
+ * 从控制器自动生成 OpenAPI 并配置 Scalar
19
19
  */
20
- useScalarAutoDiscover(generatorConfig: OpenAPIGeneratorConfig, scalarConfig?: Omit<ScalarConfig, 'spec'>): void;
20
+ useSwagger(generatorConfig: OpenAPIGeneratorConfig, scalarConfig?: Omit<ScalarConfig, 'spec'>): void;
21
21
  /**
22
22
  * 自动发现控制器的辅助方法
23
23
  */
@@ -1 +1 @@
1
- {"version":3,"file":"extensions.d.ts","sourceRoot":"","sources":["../src/extensions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE9D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAIlE;;GAEG;AACH,OAAO,QAAQ,cAAc,CAAC;IAC5B,UAAU,uBAAuB;QAC/B;;WAEG;QACH,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,wBAAwB,CACtB,WAAW,EAAE,qBAAqB,EAAE,EACpC,eAAe,EAAE,sBAAsB,EACvC,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,GACxC,IAAI,CAAC;QAER;;WAEG;QACH,qBAAqB,CACnB,eAAe,EAAE,sBAAsB,EACvC,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,GACxC,IAAI,CAAC;QAER;;WAEG;QACH,uBAAuB,IAAI,qBAAqB,EAAE,CAAC;KACpD;CACF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,SA2D/B"}
1
+ {"version":3,"file":"extensions.d.ts","sourceRoot":"","sources":["../src/extensions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE9D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAIlE;;GAEG;AACH,OAAO,QAAQ,cAAc,CAAC;IAC5B,UAAU,uBAAuB;QAC/B;;WAEG;QACH,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QAOH;;WAEG;QACH,UAAU,CACR,eAAe,EAAE,sBAAsB,EACvC,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,GACxC,IAAI,CAAC;QAER;;WAEG;QACH,uBAAuB,IAAI,qBAAqB,EAAE,CAAC;KACpD;CACF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,SA4D/B"}
@@ -9,21 +9,25 @@ export function extendWithScalar() {
9
9
  HestApplicationInstancePrototype.useScalar = function (config) {
10
10
  setupScalar(this.hono(), config);
11
11
  };
12
- HestApplicationInstancePrototype.useScalarWithControllers = function (controllers, generatorConfig, scalarConfig = {}) {
13
- // 如果没有传入控制器,尝试从容器中获取
14
- if (controllers.length === 0) {
15
- const autoDiscoveredControllers = this.autoDiscoverControllers();
16
- if (autoDiscoveredControllers.length > 0) {
17
- controllers = autoDiscoveredControllers;
18
- }
19
- else {
20
- console.warn('No controllers found. Please pass controllers explicitly or ensure controllers are properly registered.');
21
- return;
22
- }
23
- }
24
- setupScalarWithControllers(this.hono(), controllers, generatorConfig, scalarConfig);
25
- };
26
- HestApplicationInstancePrototype.useScalarAutoDiscover = function (generatorConfig, scalarConfig = {}) {
12
+ // 弃用,使用统一的自动发现方法
13
+ // HestApplicationInstancePrototype.useScalarWithControllers = function (
14
+ // controllers: ControllerConstructor[],
15
+ // generatorConfig: OpenAPIGeneratorConfig,
16
+ // scalarConfig: Omit<ScalarConfig, 'spec'> = {}
17
+ // ) {
18
+ // // 如果没有传入控制器,尝试从容器中获取
19
+ // if (controllers.length === 0) {
20
+ // const autoDiscoveredControllers = this.autoDiscoverControllers();
21
+ // if (autoDiscoveredControllers.length > 0) {
22
+ // controllers = autoDiscoveredControllers;
23
+ // } else {
24
+ // console.warn('No controllers found. Please pass controllers explicitly or ensure controllers are properly registered.');
25
+ // return;
26
+ // }
27
+ // }
28
+ // setupScalarWithControllers(this.hono(), controllers, generatorConfig, scalarConfig);
29
+ // };
30
+ HestApplicationInstancePrototype.useSwagger = function (generatorConfig, scalarConfig = {}) {
27
31
  const controllers = this.autoDiscoverControllers();
28
32
  if (controllers.length === 0) {
29
33
  console.warn('No controllers found for auto-discovery. Please ensure controllers are properly registered.');
@@ -1 +1 @@
1
- {"version":3,"file":"extensions.js","sourceRoot":"","sources":["../src/extensions.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2E,YAAY,EAAE,MAAM,cAAc,CAAC;AAGrH,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAG9E,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;AAoCtC;;GAEG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,gCAAgC,GACpC,OAAO,CAAC,cAAc,CAAC,CAAC,uBAAuB,CAAC,SAAS,CAAC;IAE5D,gCAAgC,CAAC,SAAS,GAAG,UAAU,MAAoB;QACzE,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,gCAAgC,CAAC,wBAAwB,GAAG,UAC1D,WAAoC,EACpC,eAAuC,EACvC,eAA2C,EAAE;QAE7C,qBAAqB;QACrB,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,yBAAyB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;YACjE,IAAI,yBAAyB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACzC,WAAW,GAAG,yBAAyB,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,yGAAyG,CAAC,CAAC;gBACxH,OAAO;YACT,CAAC;QACH,CAAC;QAED,0BAA0B,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;IACtF,CAAC,CAAC;IAEF,gCAAgC,CAAC,qBAAqB,GAAG,UACvD,eAAuC,EACvC,eAA2C,EAAE;QAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QACnD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,CAAC,IAAI,CAAC,6FAA6F,CAAC,CAAC;YAC5G,OAAO;QACT,CAAC;QAED,0BAA0B,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;IACtF,CAAC,CAAC;IAEF,iBAAiB;IACjB,gBAAgB;IAChB,gCAAgC,CAAC,uBAAuB,GAAG;QACzD,IAAI,CAAC;YACH,MAAM,SAAS,GAAc,IAAI,CAAC,YAAY,EAAE,CAAC;YACjD,MAAM,eAAe,GAA2B,SAAS,CAAC,iBAAiB,EAAE,CAAC;YAE9E,SAAS;YACT,MAAM,WAAW,GAA4B,eAAe,CAAC,GAAG,CAC9D,CAAC,IAA0B,EAAE,EAAE,CAAC,IAAI,CAAC,QAAiC,CACvE,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,sBAAsB,WAAW,CAAC,MAAM,gBAAgB,WAAW,CAAC,GAAG,CAAC,CAAC,IAA2B,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAE9I,OAAO,WAAW,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;YAC5D,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,OAAO;AACP,gBAAgB,EAAE,CAAC"}
1
+ {"version":3,"file":"extensions.js","sourceRoot":"","sources":["../src/extensions.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2E,YAAY,EAAE,MAAM,cAAc,CAAC;AAGrH,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAG9E,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;AAqCtC;;GAEG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,gCAAgC,GACpC,OAAO,CAAC,cAAc,CAAC,CAAC,uBAAuB,CAAC,SAAS,CAAC;IAE5D,gCAAgC,CAAC,SAAS,GAAG,UAAU,MAAoB;QACzE,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,iBAAiB;IACjB,yEAAyE;IACzE,0CAA0C;IAC1C,6CAA6C;IAC7C,kDAAkD;IAClD,MAAM;IACN,0BAA0B;IAC1B,oCAAoC;IACpC,wEAAwE;IACxE,kDAAkD;IAClD,iDAAiD;IACjD,eAAe;IACf,iIAAiI;IACjI,gBAAgB;IAChB,QAAQ;IACR,MAAM;IAEN,yFAAyF;IACzF,KAAK;IAEL,gCAAgC,CAAC,UAAU,GAAG,UAC5C,eAAuC,EACvC,eAA2C,EAAE;QAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QACnD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,CAAC,IAAI,CAAC,6FAA6F,CAAC,CAAC;YAC5G,OAAO;QACT,CAAC;QAED,0BAA0B,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;IACtF,CAAC,CAAC;IAEF,iBAAiB;IACjB,gBAAgB;IAChB,gCAAgC,CAAC,uBAAuB,GAAG;QACzD,IAAI,CAAC;YACH,MAAM,SAAS,GAAc,IAAI,CAAC,YAAY,EAAE,CAAC;YACjD,MAAM,eAAe,GAA2B,SAAS,CAAC,iBAAiB,EAAE,CAAC;YAE9E,SAAS;YACT,MAAM,WAAW,GAA4B,eAAe,CAAC,GAAG,CAC9D,CAAC,IAA0B,EAAE,EAAE,CAAC,IAAI,CAAC,QAAiC,CACvE,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,sBAAsB,WAAW,CAAC,MAAM,gBAAgB,WAAW,CAAC,GAAG,CAAC,CAAC,IAA2B,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAE9I,OAAO,WAAW,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;YAC5D,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,OAAO;AACP,gBAAgB,EAAE,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hestjs/scalar",
3
- "version": "0.1.3",
3
+ "version": "0.1.5",
4
4
  "description": "HestJS Scalar API Reference Integration - Beautiful API documentation for HestJS applications",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -28,7 +28,7 @@
28
28
  "author": "aqz236",
29
29
  "license": "MIT",
30
30
  "dependencies": {
31
- "@hestjs/core": "^0.1.9",
31
+ "@hestjs/core": "^0.1.10",
32
32
  "@scalar/themes": "^0.13.11",
33
33
  "hono": "^4.8.9"
34
34
  },