@adaptivestone/framework 5.0.1 → 5.1.0

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.
Files changed (81) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/dist/commands/OpenApi.d.ts +26 -0
  3. package/dist/commands/OpenApi.js +101 -0
  4. package/dist/commands/OpenApi.js.map +1 -0
  5. package/dist/commands/Routes.d.ts +17 -0
  6. package/dist/commands/Routes.js +35 -0
  7. package/dist/commands/Routes.js.map +1 -0
  8. package/dist/config/cache.d.ts +14 -0
  9. package/dist/config/cache.js +14 -0
  10. package/dist/config/cache.js.map +1 -0
  11. package/dist/controllers/index.js +28 -4
  12. package/dist/controllers/index.js.map +1 -1
  13. package/dist/helpers/appInstance.d.ts +6 -0
  14. package/dist/helpers/appInstance.js +13 -0
  15. package/dist/helpers/appInstance.js.map +1 -1
  16. package/dist/modules/BaseModel.d.ts +10 -0
  17. package/dist/modules/BaseModel.js +25 -0
  18. package/dist/modules/BaseModel.js.map +1 -1
  19. package/dist/server.d.ts +20 -1
  20. package/dist/server.js +24 -1
  21. package/dist/server.js.map +1 -1
  22. package/dist/services/cache/Cache.d.ts +3 -4
  23. package/dist/services/cache/Cache.js +43 -34
  24. package/dist/services/cache/Cache.js.map +1 -1
  25. package/dist/services/cache/CacheDriver.d.ts +19 -0
  26. package/dist/services/cache/CacheDriver.js +2 -0
  27. package/dist/services/cache/CacheDriver.js.map +1 -0
  28. package/dist/services/cache/drivers/MemoryDriver.d.ts +14 -0
  29. package/dist/services/cache/drivers/MemoryDriver.js +40 -0
  30. package/dist/services/cache/drivers/MemoryDriver.js.map +1 -0
  31. package/dist/services/cache/drivers/RedisDriver.d.ts +22 -0
  32. package/dist/services/cache/drivers/RedisDriver.js +44 -0
  33. package/dist/services/cache/drivers/RedisDriver.js.map +1 -0
  34. package/dist/services/documentation/OpenApiGenerator.d.ts +39 -0
  35. package/dist/services/documentation/OpenApiGenerator.js +296 -0
  36. package/dist/services/documentation/OpenApiGenerator.js.map +1 -0
  37. package/dist/services/http/HttpServer.d.ts +23 -0
  38. package/dist/services/http/HttpServer.js +57 -0
  39. package/dist/services/http/HttpServer.js.map +1 -1
  40. package/dist/services/http/builtinErrorHandlers.d.ts +36 -0
  41. package/dist/services/http/builtinErrorHandlers.js +71 -0
  42. package/dist/services/http/builtinErrorHandlers.js.map +1 -0
  43. package/dist/services/http/httpErrors.d.ts +30 -0
  44. package/dist/services/http/httpErrors.js +46 -0
  45. package/dist/services/http/httpErrors.js.map +1 -0
  46. package/dist/services/http/middleware/AbstractMiddleware.d.ts +25 -7
  47. package/dist/services/http/middleware/AbstractMiddleware.js +14 -0
  48. package/dist/services/http/middleware/AbstractMiddleware.js.map +1 -1
  49. package/dist/services/http/middleware/GetUserByToken.d.ts +13 -0
  50. package/dist/services/http/middleware/GetUserByToken.js +5 -1
  51. package/dist/services/http/middleware/GetUserByToken.js.map +1 -1
  52. package/dist/services/http/middleware/RateLimiter.d.ts +8 -2
  53. package/dist/services/http/middleware/RateLimiter.js +38 -13
  54. package/dist/services/http/middleware/RateLimiter.js.map +1 -1
  55. package/dist/services/http/routing/RouteNode.d.ts +2 -0
  56. package/dist/services/validate/drivers/StandardSchemaDriver.d.ts +5 -2
  57. package/dist/services/validate/drivers/StandardSchemaDriver.js +24 -3
  58. package/dist/services/validate/drivers/StandardSchemaDriver.js.map +1 -1
  59. package/dist/services/validate/drivers/YupDriver.js +91 -2
  60. package/dist/services/validate/drivers/YupDriver.js.map +1 -1
  61. package/dist/services/validate/types.d.ts +7 -4
  62. package/dist/tests/globalSetupNodeTest.d.ts +2 -0
  63. package/dist/tests/globalSetupNodeTest.js +23 -0
  64. package/dist/tests/globalSetupNodeTest.js.map +1 -0
  65. package/dist/tests/globalSetupVitest.js +6 -13
  66. package/dist/tests/globalSetupVitest.js.map +1 -1
  67. package/dist/tests/nodeRunner.node-test.d.ts +14 -0
  68. package/dist/tests/nodeRunner.node-test.js +41 -0
  69. package/dist/tests/nodeRunner.node-test.js.map +1 -0
  70. package/dist/tests/nodeRunnerShared.node-test.d.ts +14 -0
  71. package/dist/tests/nodeRunnerShared.node-test.js +39 -0
  72. package/dist/tests/nodeRunnerShared.node-test.js.map +1 -0
  73. package/dist/tests/setupFramework.d.ts +33 -0
  74. package/dist/tests/setupFramework.js +134 -0
  75. package/dist/tests/setupFramework.js.map +1 -0
  76. package/dist/tests/setupNodeTest.d.ts +1 -0
  77. package/dist/tests/setupNodeTest.js +16 -0
  78. package/dist/tests/setupNodeTest.js.map +1 -0
  79. package/dist/tests/setupVitest.js +8 -99
  80. package/dist/tests/setupVitest.js.map +1 -1
  81. package/package.json +10 -3
@@ -3,17 +3,35 @@ import Base from '../../../modules/Base.ts';
3
3
  import type { IApp } from '../../../server.ts';
4
4
  import type { StandardSchemaV1 } from '../../validate/types.ts';
5
5
  import type { FrameworkRequest } from '../HttpServer.ts';
6
+ /**
7
+ * One security scheme a middleware contributes to the OpenAPI document
8
+ * (`components.securitySchemes`). Mirrors the OpenAPI Security Scheme Object:
9
+ * `type: 'apiKey'` uses `name` + `in`; `type: 'http'` uses `scheme`.
10
+ */
11
+ export interface AuthParameter {
12
+ name: string;
13
+ type: string;
14
+ in?: string;
15
+ scheme?: string;
16
+ description: string;
17
+ }
6
18
  declare class AbstractMiddleware extends Base {
7
19
  params?: Record<string, unknown>;
8
20
  constructor(app: IApp, params?: Record<string, unknown>);
9
21
  static get description(): string;
10
- get usedAuthParameters(): Array<{
11
- name: string;
12
- type: string;
13
- in?: string;
14
- scheme?: string;
15
- description: string;
16
- }>;
22
+ /**
23
+ * Security schemes this middleware enforces, declared **statically** so the
24
+ * OpenAPI generator can read them off the class with zero instantiation.
25
+ * Default `[]` (the middleware contributes no auth requirement). Override on
26
+ * subclasses that gate requests (e.g. token/bearer auth).
27
+ */
28
+ static get usedAuthParameters(): AuthParameter[];
29
+ /**
30
+ * @deprecated Since 5.0.0 — declare auth schemes **statically**
31
+ * (`static get usedAuthParameters()`). The instance form is read only as a
32
+ * fallback and will be removed in v6.
33
+ */
34
+ get usedAuthParameters(): AuthParameter[];
17
35
  /**
18
36
  * Schema describing query parameters this middleware consumes. Declared
19
37
  * **statically** so the framework (and codegen) can read it without
@@ -8,6 +8,20 @@ class AbstractMiddleware extends Base {
8
8
  static get description() {
9
9
  return 'Middleware description. Please provide own';
10
10
  }
11
+ /**
12
+ * Security schemes this middleware enforces, declared **statically** so the
13
+ * OpenAPI generator can read them off the class with zero instantiation.
14
+ * Default `[]` (the middleware contributes no auth requirement). Override on
15
+ * subclasses that gate requests (e.g. token/bearer auth).
16
+ */
17
+ static get usedAuthParameters() {
18
+ return [];
19
+ }
20
+ /**
21
+ * @deprecated Since 5.0.0 — declare auth schemes **statically**
22
+ * (`static get usedAuthParameters()`). The instance form is read only as a
23
+ * fallback and will be removed in v6.
24
+ */
11
25
  get usedAuthParameters() {
12
26
  return [];
13
27
  }
@@ -1 +1 @@
1
- {"version":3,"file":"AbstractMiddleware.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/AbstractMiddleware.ts"],"names":[],"mappings":"AACA,OAAO,IAAI,MAAM,0BAA0B,CAAC;AAK5C,MAAM,kBAAmB,SAAQ,IAAI;IACnC,MAAM,CAA2B;IAEjC,YAAY,GAAS,EAAE,MAAgC;QACrD,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,MAAM,KAAK,WAAW;QACpB,OAAO,4CAA4C,CAAC;IACtD,CAAC;IAED,IAAI,kBAAkB;QAOpB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,KAAK,sBAAsB;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,MAAM,KAAK,wBAAwB;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,IAAI,sBAAsB;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,IAAI,wBAAwB;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,IAAI,oBAAoB;QACtB,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,wBAAwB;YACtC,KAAK,EAAE,IAAI,CAAC,sBAAsB;SACnC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CACd,IAAsB,EACtB,IAAc,EACd,IAAkB;QAGlB,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC;QACnD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,KAAK,WAAW;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AAED,eAAe,kBAAkB,CAAC"}
1
+ {"version":3,"file":"AbstractMiddleware.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/AbstractMiddleware.ts"],"names":[],"mappings":"AACA,OAAO,IAAI,MAAM,0BAA0B,CAAC;AAkB5C,MAAM,kBAAmB,SAAQ,IAAI;IACnC,MAAM,CAA2B;IAEjC,YAAY,GAAS,EAAE,MAAgC;QACrD,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,MAAM,KAAK,WAAW;QACpB,OAAO,4CAA4C,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,MAAM,KAAK,kBAAkB;QAC3B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACH,IAAI,kBAAkB;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,KAAK,sBAAsB;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,MAAM,KAAK,wBAAwB;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,IAAI,sBAAsB;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,IAAI,wBAAwB;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,IAAI,oBAAoB;QACtB,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,wBAAwB;YACtC,KAAK,EAAE,IAAI,CAAC,sBAAsB;SACnC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CACd,IAAsB,EACtB,IAAc,EACd,IAAkB;QAGlB,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC;QACnD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,KAAK,WAAW;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AAED,eAAe,kBAAkB,CAAC"}
@@ -18,6 +18,19 @@ declare class GetUserByToken extends AbstractMiddleware {
18
18
  static get provides(): {
19
19
  user?: AppUser;
20
20
  };
21
+ static get usedAuthParameters(): ({
22
+ name: string;
23
+ type: string;
24
+ in: string;
25
+ description: string;
26
+ scheme?: undefined;
27
+ } | {
28
+ name: string;
29
+ type: string;
30
+ scheme: string;
31
+ description: string;
32
+ in?: undefined;
33
+ })[];
21
34
  get usedAuthParameters(): ({
22
35
  name: string;
23
36
  type: string;
@@ -12,7 +12,7 @@ class GetUserByToken extends AbstractMiddleware {
12
12
  static get provides() {
13
13
  return {};
14
14
  }
15
- get usedAuthParameters() {
15
+ static get usedAuthParameters() {
16
16
  return [
17
17
  {
18
18
  name: 'Authorization',
@@ -28,6 +28,10 @@ class GetUserByToken extends AbstractMiddleware {
28
28
  },
29
29
  ];
30
30
  }
31
+ // Back-compat for any runtime reader of the instance form (removed in v6).
32
+ get usedAuthParameters() {
33
+ return GetUserByToken.usedAuthParameters;
34
+ }
31
35
  async middleware(req, _res, next) {
32
36
  if (req.appInfo.user) {
33
37
  this.logger?.warn('You call GetUserByToken more then once');
@@ -1 +1 @@
1
- {"version":3,"file":"GetUserByToken.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/GetUserByToken.ts"],"names":[],"mappings":"AAGA,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAQzD,MAAM,cAAe,SAAQ,kBAAkB;IAC7C,MAAM,KAAK,WAAW;QACpB,OAAO,kGAAkG,CAAC;IAC5G,CAAC;IAED;;;;;OAKG;IACH,MAAM,KAAK,QAAQ;QACjB,OAAO,EAAwB,CAAC;IAClC,CAAC;IAED,IAAI,kBAAkB;QACpB,OAAO;YACL;gBACE,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,QAAQ;gBACd,EAAE,EAAE,QAAQ;gBACZ,WAAW,EAAE,cAAc,CAAC,WAAW;aACxC;YACD;gBACE,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,MAAM;gBACZ,MAAM,EAAE,QAAQ;gBAChB,WAAW,EAAE,cAAc,CAAC,WAAW;aACxC;SACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CACd,GAA6C,EAC7C,IAAc,EACd,IAAkB;QAElB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,wCAAwC,CAAC,CAAC;YAC5D,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QACD,IAAI,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QAC/B,wEAAwE;QACxE,sCAAsC;QACtC,IAAI,CAAC,MAAM,EAAE,OAAO,CAClB,8BACE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QACtB,0BAA0B,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAC5E,CAAC;QACF,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YACjC,sEAAsE;YACtE,yEAAyE;YACzE,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gBAC/B,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;QACH,CAAC;QACD,gBAAgB;QAChB,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAChD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAqB,CAAC;QAC3D,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CACrC,KAAK,CACN,CAAmC,CAAC;QACrC,IAAI,IAAI,EAAE,CAAC;YACT,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QAC1B,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;CACF;AAED,eAAe,cAAc,CAAC"}
1
+ {"version":3,"file":"GetUserByToken.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/GetUserByToken.ts"],"names":[],"mappings":"AAGA,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAQzD,MAAM,cAAe,SAAQ,kBAAkB;IAC7C,MAAM,KAAK,WAAW;QACpB,OAAO,kGAAkG,CAAC;IAC5G,CAAC;IAED;;;;;OAKG;IACH,MAAM,KAAK,QAAQ;QACjB,OAAO,EAAwB,CAAC;IAClC,CAAC;IAED,MAAM,KAAK,kBAAkB;QAC3B,OAAO;YACL;gBACE,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,QAAQ;gBACd,EAAE,EAAE,QAAQ;gBACZ,WAAW,EAAE,cAAc,CAAC,WAAW;aACxC;YACD;gBACE,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,MAAM;gBACZ,MAAM,EAAE,QAAQ;gBAChB,WAAW,EAAE,cAAc,CAAC,WAAW;aACxC;SACF,CAAC;IACJ,CAAC;IAED,2EAA2E;IAC3E,IAAI,kBAAkB;QACpB,OAAO,cAAc,CAAC,kBAAkB,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,UAAU,CACd,GAA6C,EAC7C,IAAc,EACd,IAAkB;QAElB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,wCAAwC,CAAC,CAAC;YAC5D,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QACD,IAAI,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QAC/B,wEAAwE;QACxE,sCAAsC;QACtC,IAAI,CAAC,MAAM,EAAE,OAAO,CAClB,8BACE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QACtB,0BAA0B,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAC5E,CAAC;QACF,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YACjC,sEAAsE;YACtE,yEAAyE;YACzE,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gBAC/B,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;QACH,CAAC;QACD,gBAAgB;QAChB,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAChD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAqB,CAAC;QAC3D,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CACrC,KAAK,CACN,CAAmC,CAAC;QACrC,IAAI,IAAI,EAAE,CAAC;YACT,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QAC1B,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;CACF;AAED,eAAe,cAAc,CAAC"}
@@ -1,6 +1,5 @@
1
1
  import type { NextFunction, Response } from 'express';
2
2
  import type { RateLimiterAbstract } from 'rate-limiter-flexible';
3
- import { RateLimiterRedis } from 'rate-limiter-flexible';
4
3
  import type rateLimiterConfig from '../../../config/rateLimiter.js';
5
4
  import type { IApp } from '../../../server.ts';
6
5
  import type { FrameworkRequest } from '../HttpServer.ts';
@@ -10,8 +9,15 @@ declare class RateLimiter extends AbstractMiddleware {
10
9
  static get description(): string;
11
10
  finalOptions: typeof rateLimiterConfig;
12
11
  limiter: RateLimiterAbstract;
12
+ /**
13
+ * Resolves once the limiter is built. Only the redis driver is async (it
14
+ * lazy-loads `@redis/client`); memory/mongo build synchronously, so this stays
15
+ * an already-resolved promise for them. `middleware()` awaits it before the
16
+ * first request.
17
+ */
18
+ whenReady: Promise<void>;
13
19
  constructor(app: IApp, params?: Record<string, unknown>);
14
- initRedisLimiter(): RateLimiterRedis;
20
+ initRedisLimiter(): Promise<void>;
15
21
  gerenateConsumeKey(req: FrameworkRequest & GetUserByTokenAppInfo): string;
16
22
  consumeResult(consumeKey: string, consumePoints?: number): Promise<{
17
23
  msBeforeNext: number;
@@ -1,7 +1,6 @@
1
1
  import merge from 'deepmerge';
2
2
  import mongoose from 'mongoose';
3
3
  import { RateLimiterMemory, RateLimiterMongo, RateLimiterRedis, } from 'rate-limiter-flexible';
4
- import { getRedisClientSync } from "../../../helpers/redis/redisConnection.js";
5
4
  import AbstractMiddleware from "./AbstractMiddleware.js";
6
5
  class RateLimiter extends AbstractMiddleware {
7
6
  static get description() {
@@ -9,6 +8,13 @@ class RateLimiter extends AbstractMiddleware {
9
8
  }
10
9
  finalOptions;
11
10
  limiter;
11
+ /**
12
+ * Resolves once the limiter is built. Only the redis driver is async (it
13
+ * lazy-loads `@redis/client`); memory/mongo build synchronously, so this stays
14
+ * an already-resolved promise for them. `middleware()` awaits it before the
15
+ * first request.
16
+ */
17
+ whenReady = Promise.resolve();
12
18
  constructor(app, params) {
13
19
  super(app, params);
14
20
  const limiterOptions = this.app.getConfig('rateLimiter');
@@ -18,7 +24,10 @@ class RateLimiter extends AbstractMiddleware {
18
24
  this.limiter = new RateLimiterMemory(this.finalOptions.limiterOptions);
19
25
  break;
20
26
  case 'redis':
21
- this.limiter = this.initRedisLimiter();
27
+ // Defer: the redis path lazy-loads `@redis/client` so the package only
28
+ // loads when the redis driver is actually used. memory/mongo never reach
29
+ // here, so importing RateLimiter no longer forces redis into the graph.
30
+ this.whenReady = this.initRedisLimiter();
22
31
  break;
23
32
  case 'mongo':
24
33
  this.limiter = new RateLimiterMongo({
@@ -34,17 +43,30 @@ class RateLimiter extends AbstractMiddleware {
34
43
  break;
35
44
  }
36
45
  }
37
- initRedisLimiter() {
38
- const redisClient = getRedisClientSync();
39
- return new RateLimiterRedis({
40
- storeClient: redisClient,
41
- useRedisPackage: true,
42
- // Memory fallback so a Redis outage doesn't drop limiting entirely; the
43
- // library serves from this when the store errors, and doc-10's fail-open
44
- // in `consumeResult` is the last resort.
45
- insuranceLimiter: new RateLimiterMemory(this.finalOptions.limiterOptions),
46
- ...this.finalOptions.limiterOptions,
47
- });
46
+ async initRedisLimiter() {
47
+ try {
48
+ // Dynamic-import the helper so `@redis/client` only loads on the redis
49
+ // path. `getRedisClientSync` returns immediately (connect runs in the
50
+ // background) — like the old static import, so the limiter builds without
51
+ // blocking, and a down redis is absorbed by the memory insurance below
52
+ // rather than leaving `this.limiter` unbuilt.
53
+ const { getRedisClientSync } = await import("../../../helpers/redis/redisConnection.js");
54
+ const redisClient = getRedisClientSync();
55
+ this.limiter = new RateLimiterRedis({
56
+ storeClient: redisClient,
57
+ useRedisPackage: true,
58
+ // Memory fallback so a Redis outage doesn't drop limiting entirely; the
59
+ // library serves from this when the store errors, and doc-10's fail-open
60
+ // in `consumeResult` is the last resort.
61
+ insuranceLimiter: new RateLimiterMemory(this.finalOptions.limiterOptions),
62
+ ...this.finalOptions.limiterOptions,
63
+ });
64
+ }
65
+ catch (e) {
66
+ // Leave `this.limiter` undefined so `middleware()` returns 500 (same as an
67
+ // unknown driver) rather than crashing — e.g. `@redis/client` not installed.
68
+ this.logger?.error(`RateLimiter redis init failed (is '@redis/client' installed?): ${e}`);
69
+ }
48
70
  }
49
71
  gerenateConsumeKey(req) {
50
72
  const { ip, route, user, request } = this.finalOptions.consumeKeyComponents;
@@ -95,6 +117,9 @@ class RateLimiter extends AbstractMiddleware {
95
117
  }
96
118
  }
97
119
  async middleware(req, res, next) {
120
+ // No-op for memory/mongo (already resolved); awaits the lazy redis build on
121
+ // the first request only.
122
+ await this.whenReady;
98
123
  if (!this.limiter) {
99
124
  this.logger?.info(`RateLimiter not inited correclty! Please check init logs `);
100
125
  return res.status(500).json({ message: 'RateLimiter error' });
@@ -1 +1 @@
1
- {"version":3,"file":"RateLimiter.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/RateLimiter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,WAAW,CAAC;AAE9B,OAAO,QAAQ,MAAM,UAAU,CAAC;AAKhC,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAG/E,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAGzD,MAAM,WAAY,SAAQ,kBAAkB;IAC1C,MAAM,KAAK,WAAW;QACpB,OAAO,iFAAiF,CAAC;IAC3F,CAAC;IAED,YAAY,CAA2B;IACvC,OAAO,CAAuB;IAE9B,YAAY,GAAS,EAAE,MAAgC;QACrD,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACnB,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,YAAY,GAAG,KAAK,CACvB,cAAc,EACd,MAAM,IAAI,EAAE,CACe,CAAC;QAE9B,QAAQ,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YACjC,KAAK,QAAQ;gBACX,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;gBACvE,MAAM;YAER,KAAK,OAAO;gBACV,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACvC,MAAM;YAER,KAAK,OAAO;gBACV,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC;oBAClC,WAAW,EAAE,QAAQ,CAAC,UAAU;oBAChC,sBAAsB,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,EAAE,0DAA0D;oBAC/G,oEAAoE;oBACpE,gBAAgB,EAAE,IAAI,iBAAiB,CACrC,IAAI,CAAC,YAAY,CAAC,cAAc,CACjC;oBACD,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc;iBACpC,CAAC,CAAC;gBACH,MAAM;YAER;gBACE,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,6BAA6B,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CACxD,CAAC;gBACF,MAAM;QACV,CAAC;IACH,CAAC;IAED,gBAAgB;QACd,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAC;QAEzC,OAAO,IAAI,gBAAgB,CAAC;YAC1B,WAAW,EAAE,WAAW;YACxB,eAAe,EAAE,IAAI;YACrB,wEAAwE;YACxE,yEAAyE;YACzE,yCAAyC;YACzC,gBAAgB,EAAE,IAAI,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC;YACzE,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc;SACpC,CAAC,CAAC;IACL,CAAC;IAED,kBAAkB,CAAC,GAA6C;QAC9D,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC;QAE5E,MAAM,GAAG,GAAG,EAAE,CAAC;QACf,IAAI,EAAE,EAAE,CAAC;YACP,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;gBACpB,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,wHAAwH,CACzH,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,yBAAyB;QAC9E,CAAC;QACD,IAAI,IAAI,IAAI,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC;YAC9B,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC;QAED,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACtB,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;oBACpB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,UAAkB,EAAE,aAAa,GAAG,CAAC;QACvD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACvC,UAAU,EACV,aAAa,IAAI,IAAI,CAAC,YAAY,CAAC,aAAa,CACjD,CAAC;YACF,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC;QACvD,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,yEAAyE;YACzE,oEAAoE;YACpE,yEAAyE;YACzE,2EAA2E;YAC3E,yEAAyE;YACzE,+BAA+B;YAC/B,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;gBACvB,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,sCAAsC,UAAU,MAAM,CAAC,EAAE,CAC1D,CAAC;gBACF,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;YAChE,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,mCAAmC,UAAU,EAAE,CAAC,CAAC;YACnE,MAAM,MAAM,GAAG,CAAmB,CAAC;YACnC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YAE/D,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE,CAAC;QACrD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAqB,EAAE,GAAa,EAAE,IAAkB;QACvE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,MAAM,EAAE,IAAI,CACf,2DAA2D,CAC5D,CAAC;YACF,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;QAChE,CAAC;QAED,sEAAsE;QACtE,wEAAwE;QACxE,mEAAmE;QACnE,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAElD,MAAM,UAAU,GAAG,GAAG,SAAS,IAAI,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;QAElE,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;YAC5B,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,OAAO,GAAG;aACP,MAAM,CAAC,GAAG,CAAC;aACX,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;aAC1D,IAAI,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAED,eAAe,WAAW,CAAC"}
1
+ {"version":3,"file":"RateLimiter.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/RateLimiter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,WAAW,CAAC;AAE9B,OAAO,QAAQ,MAAM,UAAU,CAAC;AAKhC,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAI/B,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAGzD,MAAM,WAAY,SAAQ,kBAAkB;IAC1C,MAAM,KAAK,WAAW;QACpB,OAAO,iFAAiF,CAAC;IAC3F,CAAC;IAED,YAAY,CAA2B;IACvC,OAAO,CAAuB;IAE9B;;;;;OAKG;IACH,SAAS,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;IAE7C,YAAY,GAAS,EAAE,MAAgC;QACrD,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACnB,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,YAAY,GAAG,KAAK,CACvB,cAAc,EACd,MAAM,IAAI,EAAE,CACe,CAAC;QAE9B,QAAQ,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YACjC,KAAK,QAAQ;gBACX,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;gBACvE,MAAM;YAER,KAAK,OAAO;gBACV,uEAAuE;gBACvE,yEAAyE;gBACzE,wEAAwE;gBACxE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACzC,MAAM;YAER,KAAK,OAAO;gBACV,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC;oBAClC,WAAW,EAAE,QAAQ,CAAC,UAAU;oBAChC,sBAAsB,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,EAAE,0DAA0D;oBAC/G,oEAAoE;oBACpE,gBAAgB,EAAE,IAAI,iBAAiB,CACrC,IAAI,CAAC,YAAY,CAAC,cAAc,CACjC;oBACD,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc;iBACpC,CAAC,CAAC;gBACH,MAAM;YAER;gBACE,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,6BAA6B,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CACxD,CAAC;gBACF,MAAM;QACV,CAAC;IACH,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,IAAI,CAAC;YACH,uEAAuE;YACvE,sEAAsE;YACtE,0EAA0E;YAC1E,uEAAuE;YACvE,8CAA8C;YAC9C,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,MAAM,CACzC,2CAA2C,CAC5C,CAAC;YACF,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAC;YACzC,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC;gBAClC,WAAW,EAAE,WAAW;gBACxB,eAAe,EAAE,IAAI;gBACrB,wEAAwE;gBACxE,yEAAyE;gBACzE,yCAAyC;gBACzC,gBAAgB,EAAE,IAAI,iBAAiB,CACrC,IAAI,CAAC,YAAY,CAAC,cAAc,CACjC;gBACD,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc;aACpC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,2EAA2E;YAC3E,6EAA6E;YAC7E,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,kEAAkE,CAAC,EAAE,CACtE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,kBAAkB,CAAC,GAA6C;QAC9D,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC;QAE5E,MAAM,GAAG,GAAG,EAAE,CAAC;QACf,IAAI,EAAE,EAAE,CAAC;YACP,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;gBACpB,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,wHAAwH,CACzH,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,yBAAyB;QAC9E,CAAC;QACD,IAAI,IAAI,IAAI,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC;YAC9B,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC;QAED,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACtB,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;oBACpB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,UAAkB,EAAE,aAAa,GAAG,CAAC;QACvD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACvC,UAAU,EACV,aAAa,IAAI,IAAI,CAAC,YAAY,CAAC,aAAa,CACjD,CAAC;YACF,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC;QACvD,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,yEAAyE;YACzE,oEAAoE;YACpE,yEAAyE;YACzE,2EAA2E;YAC3E,yEAAyE;YACzE,+BAA+B;YAC/B,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;gBACvB,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,sCAAsC,UAAU,MAAM,CAAC,EAAE,CAC1D,CAAC;gBACF,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;YAChE,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,mCAAmC,UAAU,EAAE,CAAC,CAAC;YACnE,MAAM,MAAM,GAAG,CAAmB,CAAC;YACnC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YAE/D,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE,CAAC;QACrD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAqB,EAAE,GAAa,EAAE,IAAkB;QACvE,4EAA4E;QAC5E,0BAA0B;QAC1B,MAAM,IAAI,CAAC,SAAS,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,MAAM,EAAE,IAAI,CACf,2DAA2D,CAC5D,CAAC;YACF,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;QAChE,CAAC;QAED,sEAAsE;QACtE,wEAAwE;QACxE,mEAAmE;QACnE,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAElD,MAAM,UAAU,GAAG,GAAG,SAAS,IAAI,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;QAElE,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;YAC5B,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,OAAO,GAAG;aACP,MAAM,CAAC,GAAG,CAAC;aACX,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;aAC1D,IAAI,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAED,eAAe,WAAW,CAAC"}
@@ -56,6 +56,8 @@ export interface HandlerEntry {
56
56
  methodName?: string;
57
57
  controllerClass?: string;
58
58
  sourceFile?: string;
59
+ /** Author-supplied `RouteObject.description` — surfaced by the OpenAPI generator. */
60
+ description?: string;
59
61
  };
60
62
  }
61
63
  /**
@@ -9,7 +9,10 @@ import type { ValidatorDriver } from '../types.ts';
9
9
  * Schema validate (zod, valibot, arktype). Yup is the outlier — see
10
10
  * `YupDriver.ts` for the strip-preserving fast path.
11
11
  *
12
- * `toJsonSchema` returns null here; per-vendor drivers can override
13
- * with their own native exporters when OpenAPI export is needed.
12
+ * `toJsonSchema` is vendor-generic: Standard Schema itself carries no shape, so
13
+ * conversion delegates to each lib's native exporter — a `.toJsonSchema()`
14
+ * method on the schema (arktype, …), else zod's `z.toJSONSchema` (lazy-imported
15
+ * so zod stays an optional peer). Vendors with no introspection return null and
16
+ * the caller (OpenAPI generator) degrades to a placeholder.
14
17
  */
15
18
  export declare const standardSchemaDriver: ValidatorDriver;
@@ -9,8 +9,11 @@ import { ValidationError } from "../ValidationError.js";
9
9
  * Schema validate (zod, valibot, arktype). Yup is the outlier — see
10
10
  * `YupDriver.ts` for the strip-preserving fast path.
11
11
  *
12
- * `toJsonSchema` returns null here; per-vendor drivers can override
13
- * with their own native exporters when OpenAPI export is needed.
12
+ * `toJsonSchema` is vendor-generic: Standard Schema itself carries no shape, so
13
+ * conversion delegates to each lib's native exporter — a `.toJsonSchema()`
14
+ * method on the schema (arktype, …), else zod's `z.toJSONSchema` (lazy-imported
15
+ * so zod stays an optional peer). Vendors with no introspection return null and
16
+ * the caller (OpenAPI generator) degrades to a placeholder.
14
17
  */
15
18
  export const standardSchemaDriver = {
16
19
  canHandle(body) {
@@ -31,7 +34,25 @@ export const standardSchemaDriver = {
31
34
  }
32
35
  return result.value;
33
36
  },
34
- toJsonSchema() {
37
+ async toJsonSchema(body) {
38
+ // 1. A native instance method (arktype's `.toJsonSchema()`, and any future
39
+ // lib that exposes one). Covers the general case without a per-vendor branch.
40
+ const native = body.toJsonSchema;
41
+ if (typeof native === 'function') {
42
+ return native.call(body);
43
+ }
44
+ // 2. zod (≥4) — converter lives on the `zod` module, not the schema. Lazy
45
+ // import keeps zod an optional peer; only reached when a zod schema is used.
46
+ const vendor = body['~standard']?.vendor;
47
+ if (vendor === 'zod') {
48
+ const mod = (await import('zod'));
49
+ const toJSONSchema = mod.toJSONSchema ?? mod.z?.toJSONSchema;
50
+ if (typeof toJSONSchema === 'function') {
51
+ // draft-2020-12 is what OpenAPI 3.1 expects.
52
+ return toJSONSchema(body, { target: 'draft-2020-12' });
53
+ }
54
+ }
55
+ // 3. valibot / older zod / anything else with no introspection → degrade.
35
56
  return null;
36
57
  },
37
58
  };
@@ -1 +1 @@
1
- {"version":3,"file":"StandardSchemaDriver.js","sourceRoot":"","sources":["../../../../src/services/validate/drivers/StandardSchemaDriver.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAoB;IACnD,SAAS,CAAC,IAAa;QACrB,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;YACxB,IAAI,KAAK,IAAI;YACb,WAAW,IAAI,IAAI;YACnB,OAAQ,IAAkC,CAAC,WAAW,CAAC,KAAK,QAAQ,CACrE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAa,EAAE,IAAa;QACzC,MAAM,GAAG,GAAI,IAAyB,CAAC,WAAW,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACxC,2EAA2E;QAC3E,6EAA6E;QAC7E,2EAA2E;QAC3E,6EAA6E;QAC7E,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;QACD,OAAQ,MAA8B,CAAC,KAAK,CAAC;IAC/C,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"StandardSchemaDriver.js","sourceRoot":"","sources":["../../../../src/services/validate/drivers/StandardSchemaDriver.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAoB;IACnD,SAAS,CAAC,IAAa;QACrB,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;YACxB,IAAI,KAAK,IAAI;YACb,WAAW,IAAI,IAAI;YACnB,OAAQ,IAAkC,CAAC,WAAW,CAAC,KAAK,QAAQ,CACrE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAa,EAAE,IAAa;QACzC,MAAM,GAAG,GAAI,IAAyB,CAAC,WAAW,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACxC,2EAA2E;QAC3E,6EAA6E;QAC7E,2EAA2E;QAC3E,6EAA6E;QAC7E,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;QACD,OAAQ,MAA8B,CAAC,KAAK,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,IAAa;QAC9B,2EAA2E;QAC3E,iFAAiF;QACjF,MAAM,MAAM,GAAI,IAAmC,CAAC,YAAY,CAAC;QACjE,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,OAAQ,MAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;QAED,0EAA0E;QAC1E,gFAAgF;QAChF,MAAM,MAAM,GAAI,IAAyB,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAC/D,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;YACrB,MAAM,GAAG,GAAG,CAAC,MAAM,MAAM,CAAC,KAAK,CAAC,CAG/B,CAAC;YACF,MAAM,YAAY,GAAG,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC;YAC7D,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;gBACvC,6CAA6C;gBAC7C,OAAO,YAAY,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QAED,0EAA0E;QAC1E,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAC"}
@@ -39,8 +39,19 @@ export const yupDriver = {
39
39
  throw e;
40
40
  }
41
41
  },
42
- toJsonSchema() {
43
- return null;
42
+ toJsonSchema(body) {
43
+ const describe = body.describe;
44
+ if (typeof describe !== 'function') {
45
+ return null;
46
+ }
47
+ try {
48
+ return describeToJsonSchema(describe.call(body));
49
+ }
50
+ catch {
51
+ // A non-introspectable yup shape (custom test, exotic transform) should
52
+ // degrade to a placeholder upstream, never throw mid-generation.
53
+ return null;
54
+ }
44
55
  },
45
56
  };
46
57
  function isYupValidationError(e) {
@@ -78,4 +89,82 @@ function sanitizeParams(params) {
78
89
  const { value, originalValue, ...safe } = params;
79
90
  return safe;
80
91
  }
92
+ function describeToJsonSchema(desc) {
93
+ const schema = mapYupType(desc);
94
+ if (Array.isArray(desc.oneOf) && desc.oneOf.length > 0) {
95
+ schema.enum = [...desc.oneOf];
96
+ }
97
+ // yup stamps every object with `default: {}` — an artifact, not author intent.
98
+ // Keep meaningful scalar/array defaults; drop the container noise.
99
+ if (desc.default !== undefined && desc.type !== 'object') {
100
+ schema.default = desc.default;
101
+ }
102
+ const description = desc.meta && typeof desc.meta.description === 'string'
103
+ ? desc.meta.description
104
+ : desc.label;
105
+ if (description) {
106
+ schema.description = description;
107
+ }
108
+ return applyNullable(schema, desc);
109
+ }
110
+ function mapYupType(desc) {
111
+ switch (desc.type) {
112
+ case 'object': {
113
+ const properties = {};
114
+ const required = [];
115
+ for (const [key, field] of Object.entries(desc.fields ?? {})) {
116
+ properties[key] = describeToJsonSchema(field);
117
+ if (isRequired(field)) {
118
+ required.push(key);
119
+ }
120
+ }
121
+ const out = { type: 'object', properties };
122
+ if (required.length > 0) {
123
+ out.required = required;
124
+ }
125
+ return out;
126
+ }
127
+ case 'array': {
128
+ const inner = Array.isArray(desc.innerType)
129
+ ? desc.innerType[0]
130
+ : desc.innerType;
131
+ return {
132
+ type: 'array',
133
+ items: inner ? describeToJsonSchema(inner) : {},
134
+ };
135
+ }
136
+ case 'string':
137
+ return { type: 'string' };
138
+ case 'number':
139
+ return { type: hasTest(desc, 'integer') ? 'integer' : 'number' };
140
+ case 'boolean':
141
+ return { type: 'boolean' };
142
+ case 'date':
143
+ return { type: 'string', format: 'date-time' };
144
+ case 'file':
145
+ return { type: 'string', format: 'binary' };
146
+ default:
147
+ // 'mixed', 'lazy', 'tuple', or unknown → permissive (any).
148
+ return {};
149
+ }
150
+ }
151
+ function isRequired(desc) {
152
+ if (desc.optional === false) {
153
+ return true;
154
+ }
155
+ return hasTest(desc, 'required') || hasTest(desc, 'defined');
156
+ }
157
+ function hasTest(desc, name) {
158
+ return Array.isArray(desc.tests) && desc.tests.some((t) => t?.name === name);
159
+ }
160
+ // draft 2020-12: a nullable scalar becomes a `[type, 'null']` union.
161
+ function applyNullable(schema, desc) {
162
+ if (!desc.nullable) {
163
+ return schema;
164
+ }
165
+ if (typeof schema.type === 'string') {
166
+ return { ...schema, type: [schema.type, 'null'] };
167
+ }
168
+ return schema;
169
+ }
81
170
  //# sourceMappingURL=YupDriver.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"YupDriver.js","sourceRoot":"","sources":["../../../../src/services/validate/drivers/YupDriver.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,SAAS,GAAoB;IACxC,SAAS,CAAC,IAAa;QACrB,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;YACxB,IAAI,KAAK,IAAI;YACb,WAAW,IAAI,IAAI;YAClB,IAAyB,CAAC,WAAW,CAAC,EAAE,MAAM,KAAK,KAAK,CAC1D,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAa,EAAE,IAAa;QAOzC,IAAI,CAAC;YACH,OAAO,MAAO,IAAsB,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAClD,YAAY,EAAE,IAAI;gBAClB,UAAU,EAAE,KAAK;aAClB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,IAAI,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,YAAY,CAAC,CAAC,CAAC,CAAC;YACxB,CAAC;YACD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAC;AAWF,SAAS,oBAAoB,CAAC,CAAU;IACtC,OAAO,CACL,OAAO,CAAC,KAAK,QAAQ;QACrB,CAAC,KAAK,IAAI;QACT,CAAwB,CAAC,IAAI,KAAK,iBAAiB;QACpD,KAAK,CAAC,OAAO,CAAE,CAAyB,CAAC,KAAK,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,CAA0B;IAC9C,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5E,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,IAAI,GAA4B,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5E,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;YAC1C,CAAC,CAAC,KAAK,CAAC,MAAM;YACd,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpB,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CACrB,MAAgC;IAEhC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACjD,OAAO,IAAI,CAAC;AACd,CAAC"}
1
+ {"version":3,"file":"YupDriver.js","sourceRoot":"","sources":["../../../../src/services/validate/drivers/YupDriver.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,SAAS,GAAoB;IACxC,SAAS,CAAC,IAAa;QACrB,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;YACxB,IAAI,KAAK,IAAI;YACb,WAAW,IAAI,IAAI;YAClB,IAAyB,CAAC,WAAW,CAAC,EAAE,MAAM,KAAK,KAAK,CAC1D,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAa,EAAE,IAAa;QAOzC,IAAI,CAAC;YACH,OAAO,MAAO,IAAsB,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAClD,YAAY,EAAE,IAAI;gBAClB,UAAU,EAAE,KAAK;aAClB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,IAAI,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,YAAY,CAAC,CAAC,CAAC,CAAC;YACxB,CAAC;YACD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED,YAAY,CAAC,IAAa;QACxB,MAAM,QAAQ,GAAI,IAA4C,CAAC,QAAQ,CAAC;QACxE,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC;YACH,OAAO,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACnD,CAAC;QAAC,MAAM,CAAC;YACP,wEAAwE;YACxE,iEAAiE;YACjE,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;CACF,CAAC;AAWF,SAAS,oBAAoB,CAAC,CAAU;IACtC,OAAO,CACL,OAAO,CAAC,KAAK,QAAQ;QACrB,CAAC,KAAK,IAAI;QACT,CAAwB,CAAC,IAAI,KAAK,iBAAiB;QACpD,KAAK,CAAC,OAAO,CAAE,CAAyB,CAAC,KAAK,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,CAA0B;IAC9C,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5E,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,IAAI,GAA4B,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5E,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;YAC1C,CAAC,CAAC,KAAK,CAAC,MAAM;YACd,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpB,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CACrB,MAAgC;IAEhC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACjD,OAAO,IAAI,CAAC;AACd,CAAC;AAyBD,SAAS,oBAAoB,CAAC,IAAoB;IAChD,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvD,MAAM,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IACD,+EAA+E;IAC/E,mEAAmE;IACnE,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACzD,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAChC,CAAC;IACD,MAAM,WAAW,GACf,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,KAAK,QAAQ;QACpD,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW;QACvB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;IACjB,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;IACnC,CAAC;IACD,OAAO,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,UAAU,CAAC,IAAoB;IACtC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,UAAU,GAA+B,EAAE,CAAC;YAClD,MAAM,QAAQ,GAAa,EAAE,CAAC;YAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC7D,UAAU,CAAC,GAAG,CAAC,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBAC9C,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;oBACtB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrB,CAAC;YACH,CAAC;YACD,MAAM,GAAG,GAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;YACvD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC1B,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC;gBACzC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;gBACnB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACnB,OAAO;gBACL,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;aAChD,CAAC;QACJ,CAAC;QACD,KAAK,QAAQ;YACX,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC5B,KAAK,QAAQ;YACX,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACnE,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAC7B,KAAK,MAAM;YACT,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;QACjD,KAAK,MAAM;YACT,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAC9C;YACE,2DAA2D;YAC3D,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,IAAoB;IACtC,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,OAAO,CAAC,IAAoB,EAAE,IAAY;IACjD,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,KAAK,IAAI,CAAC,CAAC;AAC/E,CAAC;AAED,qEAAqE;AACrE,SAAS,aAAa,CAAC,MAAkB,EAAE,IAAoB;IAC7D,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;IACpD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -97,8 +97,11 @@ export interface ValidatorDriver {
97
97
  canHandle(body: unknown): boolean;
98
98
  /** Validate + cast. Returns the cast value on success; throws `ValidationError` on failure. */
99
99
  validate(body: unknown, data: unknown): Promise<unknown>;
100
- /** Optional: emit JSON Schema. Returns null when introspection isn't supported. */
101
- toJsonSchema?(body: unknown, opts?: {
102
- target?: 'openapi-3.0' | 'draft-07' | 'draft-2020-12';
103
- }): JsonSchema | null;
100
+ /**
101
+ * Optional: emit JSON Schema (draft 2020-12, for OpenAPI 3.1). Returns null
102
+ * when introspection isn't supported. May be async — vendor exporters (e.g.
103
+ * zod's `z.toJSONSchema`) are reached via a lazy `import()` so the lib stays
104
+ * an optional peer.
105
+ */
106
+ toJsonSchema?(body: unknown): JsonSchema | null | Promise<JsonSchema | null>;
104
107
  }
@@ -0,0 +1,2 @@
1
+ export declare function globalSetup(): Promise<void>;
2
+ export declare function globalTeardown(): Promise<void>;
@@ -0,0 +1,23 @@
1
+ /**
2
+ * node:test global setup/teardown — the `--test-global-setup` entry module.
3
+ *
4
+ * Runs ONCE before/after the entire test run: node:test's equivalent of vitest's
5
+ * `globalSetup` (see `globalSetupVitest.ts`). It boots the in-memory Mongo and
6
+ * publishes `TEST_MONGO_URI`; the child test processes inherit it. This is the
7
+ * single entry point for the node:test suite — no per-file Mongo init, no manual
8
+ * process spawning.
9
+ *
10
+ * Wire it up (see the `test:node` script):
11
+ * node --test --test-global-setup=./src/tests/globalSetupNodeTest.ts 'glob'
12
+ *
13
+ * `--test-global-setup` is Stability 1 (experimental, added in Node v24) — the
14
+ * only API surface used here is env-var hand-off, which is the stable subset.
15
+ */
16
+ import { startTestMongo, stopTestMongo } from "./setupFramework.js";
17
+ export async function globalSetup() {
18
+ await startTestMongo(); // publishes process.env.TEST_MONGO_URI for child processes
19
+ }
20
+ export async function globalTeardown() {
21
+ await stopTestMongo();
22
+ }
23
+ //# sourceMappingURL=globalSetupNodeTest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"globalSetupNodeTest.js","sourceRoot":"","sources":["../../src/tests/globalSetupNodeTest.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpE,MAAM,CAAC,KAAK,UAAU,WAAW;IAC/B,MAAM,cAAc,EAAE,CAAC,CAAC,2DAA2D;AACrF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,MAAM,aAAa,EAAE,CAAC;AACxB,CAAC"}
@@ -1,29 +1,22 @@
1
- import { MongoMemoryReplSet } from 'mongodb-memory-server';
1
+ // vitest globalSetup: runs once per test run. Delegates the in-memory Mongo
2
+ // lifecycle to the runner-agnostic `setupFramework.ts`.
3
+ import { startTestMongo, stopTestMongo } from "./setupFramework.js";
2
4
  let isTeardown = false;
3
- let mongoMemoryServerInstance;
4
5
  const setup = async () => {
5
6
  console.log('GLOBAL SETUP PREPARE RUNNING...');
6
7
  console.time('GLOBAL TEST PREPARE. DONE');
7
- mongoMemoryServerInstance = await MongoMemoryReplSet.create({
8
- // binary: { version: '4.4.6' },
9
- replSet: { count: 1, storageEngine: 'wiredTiger' },
10
- });
11
- await mongoMemoryServerInstance.waitUntilRunning();
12
- const connectionStringMongo = await mongoMemoryServerInstance.getUri('__DB_TO_REPLACE__');
13
- process.env.TEST_MONGO_URI = connectionStringMongo;
14
- // console.info('MONGO_URI: ', connectionStringMongo);
8
+ await startTestMongo();
15
9
  console.timeEnd('GLOBAL TEST PREPARE. DONE');
16
10
  };
17
11
  const teardown = async () => {
18
12
  if (isTeardown) {
19
13
  throw new Error('teardown called twice');
20
14
  }
21
- console.time('GLOBAL TEARDOWN RUNNING. DONE');
22
15
  isTeardown = true;
23
16
  console.log('GLOBAL TEARDOWN RUNNING...');
24
- await mongoMemoryServerInstance.stop();
17
+ console.time('GLOBAL TEARDOWN RUNNING. DONE');
18
+ await stopTestMongo();
25
19
  console.timeEnd('GLOBAL TEARDOWN RUNNING. DONE');
26
- return Promise.resolve();
27
20
  };
28
21
  export { setup, teardown };
29
22
  //# sourceMappingURL=globalSetupVitest.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"globalSetupVitest.js","sourceRoot":"","sources":["../../src/tests/globalSetupVitest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,IAAI,UAAU,GAAG,KAAK,CAAC;AACvB,IAAI,yBAA6C,CAAC;AAElD,MAAM,KAAK,GAAG,KAAK,IAAI,EAAE;IACvB,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;IAC/C,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAC1C,yBAAyB,GAAG,MAAM,kBAAkB,CAAC,MAAM,CAAC;QAC1D,gCAAgC;QAChC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,aAAa,EAAE,YAAY,EAAE;KACnD,CAAC,CAAC;IACH,MAAM,yBAAyB,CAAC,gBAAgB,EAAE,CAAC;IACnD,MAAM,qBAAqB,GACzB,MAAM,yBAAyB,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IAC9D,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,qBAAqB,CAAC;IACnD,sDAAsD;IACtD,OAAO,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;IAC1B,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAE9C,UAAU,GAAG,IAAI,CAAC;IAClB,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IAC1C,MAAM,yBAAyB,CAAC,IAAI,EAAE,CAAC;IACvC,OAAO,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAEjD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC"}
1
+ {"version":3,"file":"globalSetupVitest.js","sourceRoot":"","sources":["../../src/tests/globalSetupVitest.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,wDAAwD;AACxD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpE,IAAI,UAAU,GAAG,KAAK,CAAC;AAEvB,MAAM,KAAK,GAAG,KAAK,IAAI,EAAE;IACvB,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;IAC/C,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAC1C,MAAM,cAAc,EAAE,CAAC;IACvB,OAAO,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;IAC1B,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IACD,UAAU,GAAG,IAAI,CAAC;IAClB,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IAC1C,OAAO,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC9C,MAAM,aAAa,EAAE,CAAC;IACtB,OAAO,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC"}
@@ -0,0 +1,14 @@
1
+ /**
2
+ * node:test suite — full per-file lifecycle against the shared Mongo.
3
+ *
4
+ * Mongo is started ONCE by the global-setup entry module
5
+ * (`globalSetupNodeTest.ts`, wired via `--test-global-setup` — see the
6
+ * `test:node` script). This file never touches Mongo init; it only boots a
7
+ * per-suite `Server` against the shared instance (via the shipped
8
+ * `setupNodeTest.ts` glue) and exercises the full stack: a live HTTP request and
9
+ * a Mongo write/read round-trip.
10
+ *
11
+ * Runs as part of `npm run test:node` (it shares one Mongo with the other
12
+ * `*.node-test.ts` files). The `.node-test.ts` suffix keeps vitest's glob away.
13
+ */
14
+ import './setupNodeTest.ts';
@@ -0,0 +1,41 @@
1
+ /**
2
+ * node:test suite — full per-file lifecycle against the shared Mongo.
3
+ *
4
+ * Mongo is started ONCE by the global-setup entry module
5
+ * (`globalSetupNodeTest.ts`, wired via `--test-global-setup` — see the
6
+ * `test:node` script). This file never touches Mongo init; it only boots a
7
+ * per-suite `Server` against the shared instance (via the shipped
8
+ * `setupNodeTest.ts` glue) and exercises the full stack: a live HTTP request and
9
+ * a Mongo write/read round-trip.
10
+ *
11
+ * Runs as part of `npm run test:node` (it shares one Mongo with the other
12
+ * `*.node-test.ts` files). The `.node-test.ts` suffix keeps vitest's glob away.
13
+ */
14
+ import "./setupNodeTest.js";
15
+ import assert from 'node:assert/strict';
16
+ import { describe, it } from 'node:test';
17
+ import mongoose from 'mongoose';
18
+ import { appInstance } from "../helpers/appInstance.js";
19
+ import { createDefaultTestUser, getTestServerURL } from "./testHelpers.js";
20
+ describe('node:test: server boot + Mongo round-trip', () => {
21
+ it('booted a Server connected to the shared Mongo', async () => {
22
+ await mongoose.connection.asPromise(); // resolves once the connection is open
23
+ assert.equal(mongoose.connection.readyState, 1); // 1 === connected
24
+ assert.ok(appInstance, 'app instance should be set');
25
+ });
26
+ it('serves HTTP from the booted server', async () => {
27
+ const { status } = await fetch(getTestServerURL('/')).catch(() => ({
28
+ status: 500,
29
+ }));
30
+ assert.equal(status, 200);
31
+ });
32
+ it('round-trips through Mongo (create + read a user via the model)', async () => {
33
+ const result = await createDefaultTestUser();
34
+ assert.ok(result, 'default user should be created');
35
+ assert.ok(result.token, 'an auth token should be generated');
36
+ const User = appInstance.getModel('User');
37
+ const found = await User.findOne({ email: 'test@test.com' });
38
+ assert.ok(found, 'created user should be readable back from Mongo');
39
+ });
40
+ });
41
+ //# sourceMappingURL=nodeRunner.node-test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"nodeRunner.node-test.js","sourceRoot":"","sources":["../../src/tests/nodeRunner.node-test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,oBAAoB,CAAC;AAC5B,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAExD,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAE3E,QAAQ,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACzD,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,QAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC,uCAAuC;QAC9E,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,kBAAkB;QACnE,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,4BAA4B,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;YACjE,MAAM,EAAE,GAAG;SACZ,CAAC,CAAC,CAAC;QACJ,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,MAAM,GAAG,MAAM,qBAAqB,EAAE,CAAC;QAC7C,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC;QACpD,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,mCAAmC,CAAC,CAAC;QAE7D,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAqB,CAAC;QAC9D,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;QAC7D,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,iDAAiD,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Smoke test for the **extracted / shared** Mongo-init pattern under `node:test`.
3
+ *
4
+ * This is a SECOND suite file in the same run: it proves the global-setup entry
5
+ * (`globalSetupNodeTest.ts`, wired via `--test-global-setup`) starts Mongo ONCE
6
+ * and shares it across every `*.node-test.ts` file via `TEST_MONGO_URI`. This
7
+ * file starts nothing itself — it asserts the URI arrived from the entry module
8
+ * and that it got its own fresh per-suite DB off the shared instance.
9
+ *
10
+ * The per-file server lifecycle comes from the shipped `setupNodeTest.ts` glue
11
+ * (it wires `before(startTestServer)` etc. but never touches Mongo init). Runs as
12
+ * part of `npm run test:node`.
13
+ */
14
+ import './setupNodeTest.ts';