@adaptivestone/framework 5.4.2 → 5.5.1

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 (97) hide show
  1. package/CHANGELOG.md +46 -0
  2. package/README.md +41 -0
  3. package/dist/codegen/appTypes.d.ts +4 -5
  4. package/dist/codegen/appTypes.js +31 -22
  5. package/dist/codegen/appTypes.js.map +1 -1
  6. package/dist/codegen/index.d.ts +2 -2
  7. package/dist/codegen/index.js +3 -3
  8. package/dist/codegen/index.js.map +1 -1
  9. package/dist/commands/CreateEnv.d.ts +7 -0
  10. package/dist/commands/CreateEnv.js +36 -0
  11. package/dist/commands/CreateEnv.js.map +1 -0
  12. package/dist/config/health.d.ts +4 -0
  13. package/dist/config/health.js +8 -0
  14. package/dist/config/health.js.map +1 -0
  15. package/dist/config/http.d.ts +1 -0
  16. package/dist/config/http.js +4 -0
  17. package/dist/config/http.js.map +1 -1
  18. package/dist/config/log.d.ts +2 -0
  19. package/dist/config/log.js +5 -0
  20. package/dist/config/log.js.map +1 -1
  21. package/dist/config/rateLimiter.js +1 -1
  22. package/dist/config/rateLimiter.js.map +1 -1
  23. package/dist/controllers/Auth.js +16 -52
  24. package/dist/controllers/Auth.js.map +1 -1
  25. package/dist/controllers/Health.d.ts +24 -0
  26. package/dist/controllers/Health.js +83 -0
  27. package/dist/controllers/Health.js.map +1 -0
  28. package/dist/controllers/Health.routes.gen.d.ts +13 -0
  29. package/dist/controllers/Health.routes.gen.js +10 -0
  30. package/dist/controllers/Health.routes.gen.js.map +1 -0
  31. package/dist/controllers/index.js +11 -7
  32. package/dist/controllers/index.js.map +1 -1
  33. package/dist/helpers/crypto.d.ts +19 -0
  34. package/dist/helpers/crypto.js +32 -1
  35. package/dist/helpers/crypto.js.map +1 -1
  36. package/dist/helpers/deprecation.d.ts +4 -3
  37. package/dist/helpers/deprecation.js +5 -4
  38. package/dist/helpers/deprecation.js.map +1 -1
  39. package/dist/helpers/files.d.ts +6 -1
  40. package/dist/helpers/files.js +2 -1
  41. package/dist/helpers/files.js.map +1 -1
  42. package/dist/helpers/objects.d.ts +5 -0
  43. package/dist/helpers/objects.js +12 -0
  44. package/dist/helpers/objects.js.map +1 -0
  45. package/dist/models/User.d.ts +4 -3
  46. package/dist/models/User.js +15 -1
  47. package/dist/models/User.js.map +1 -1
  48. package/dist/modules/AbstractController.d.ts +3 -3
  49. package/dist/server.d.ts +4 -0
  50. package/dist/server.js +16 -2
  51. package/dist/server.js.map +1 -1
  52. package/dist/services/documentation/OpenApiGenerator.js +21 -3
  53. package/dist/services/documentation/OpenApiGenerator.js.map +1 -1
  54. package/dist/services/http/HttpServer.d.ts +13 -11
  55. package/dist/services/http/HttpServer.js +27 -18
  56. package/dist/services/http/HttpServer.js.map +1 -1
  57. package/dist/services/http/builtinErrorHandlers.d.ts +12 -2
  58. package/dist/services/http/builtinErrorHandlers.js +57 -9
  59. package/dist/services/http/builtinErrorHandlers.js.map +1 -1
  60. package/dist/services/http/httpErrors.d.ts +64 -11
  61. package/dist/services/http/httpErrors.js +42 -6
  62. package/dist/services/http/httpErrors.js.map +1 -1
  63. package/dist/services/http/middleware/AbstractMiddleware.d.ts +14 -6
  64. package/dist/services/http/middleware/AbstractMiddleware.js +20 -7
  65. package/dist/services/http/middleware/AbstractMiddleware.js.map +1 -1
  66. package/dist/services/http/middleware/Auth.d.ts +2 -1
  67. package/dist/services/http/middleware/Auth.js +9 -4
  68. package/dist/services/http/middleware/Auth.js.map +1 -1
  69. package/dist/services/http/middleware/Cors.d.ts +2 -0
  70. package/dist/services/http/middleware/Cors.js +5 -0
  71. package/dist/services/http/middleware/Cors.js.map +1 -1
  72. package/dist/services/http/middleware/GetUserByToken.d.ts +1 -1
  73. package/dist/services/http/middleware/GetUserByToken.js +2 -2
  74. package/dist/services/http/middleware/GetUserByToken.js.map +1 -1
  75. package/dist/services/http/middleware/RateLimiter.d.ts +2 -0
  76. package/dist/services/http/middleware/RateLimiter.js +42 -11
  77. package/dist/services/http/middleware/RateLimiter.js.map +1 -1
  78. package/dist/services/http/middleware/RequestLogger.js +10 -2
  79. package/dist/services/http/middleware/RequestLogger.js.map +1 -1
  80. package/dist/services/http/middleware/Role.d.ts +2 -1
  81. package/dist/services/http/middleware/Role.js +14 -5
  82. package/dist/services/http/middleware/Role.js.map +1 -1
  83. package/dist/services/http/routing/ExpressAdapter.js +7 -2
  84. package/dist/services/http/routing/ExpressAdapter.js.map +1 -1
  85. package/dist/services/http/routing/RouteNode.d.ts +7 -8
  86. package/dist/services/logging/redaction.d.ts +15 -0
  87. package/dist/services/logging/redaction.js +54 -0
  88. package/dist/services/logging/redaction.js.map +1 -0
  89. package/dist/services/validate/ValidateService.js +3 -27
  90. package/dist/services/validate/ValidateService.js.map +1 -1
  91. package/dist/services/validate/ValidationError.d.ts +10 -0
  92. package/dist/services/validate/ValidationError.js +28 -0
  93. package/dist/services/validate/ValidationError.js.map +1 -1
  94. package/dist/services/validate/mergeValidatedOutputs.d.ts +2 -6
  95. package/dist/services/validate/mergeValidatedOutputs.js +5 -12
  96. package/dist/services/validate/mergeValidatedOutputs.js.map +1 -1
  97. package/package.json +3 -3
@@ -1,5 +1,18 @@
1
1
  import mongoose from 'mongoose';
2
+ import { translateWithDefault } from '../../helpers/translate.js';
3
+ import { issuesToPayload, translateIssues, ValidationError, } from '../validate/ValidationError.js';
2
4
  import { HttpError } from './httpErrors.js';
5
+ /** The `message` of every framework 500 response. */
6
+ export const serverErrorMessage = (req) => translateWithDefault(req, 'http.serverError', 'Something went wrong. Please try again later.');
7
+ /** The `message` of every framework field-error (400) response. */
8
+ export const validationFailedMessage = (req) => translateWithDefault(req, 'http.validationFailed', 'Validation failed');
9
+ /** Answer a resolved error: its headers, status and JSON body. */
10
+ export function sendErrorResult(res, { status, body, headers }) {
11
+ for (const [name, value] of Object.entries(headers ?? {})) {
12
+ res.setHeader(name, value);
13
+ }
14
+ return res.status(status).json(body);
15
+ }
3
16
  /** A numeric/Date schema bound (both are constants, never input) → text. */
4
17
  function renderBound(bound) {
5
18
  if (typeof bound === 'number') {
@@ -217,8 +230,9 @@ export function matchedClientCastError(err, req) {
217
230
  /**
218
231
  * Framework built-in registry entries, checked AFTER any consumer-registered
219
232
  * handlers ("yours win"):
220
- * 1. `HttpError` → its own status / `body ?? { message }`; `verbose`
221
- * (deliberate control flow, not a defect).
233
+ * 1. `HttpError` → its own status, headers and
234
+ * `body ?? { error?: code, message }`, message translated via `i18nKey`;
235
+ * `verbose` (deliberate control flow, not a defect).
222
236
  * 2. Escaped Mongoose `ValidationError` → the safety net above; `warn`
223
237
  * (signals a route schema missing a constraint the model enforces).
224
238
  * 3. Standalone Mongoose `CastError` → {@link matchedClientCastError}; `warn`
@@ -232,12 +246,34 @@ export function builtInErrorHandlers() {
232
246
  errorClass: HttpError,
233
247
  // Entries are stored type-erased (`ErrorHandlerFn`); `resolveError`
234
248
  // guarantees `instanceof errorClass` before the call.
235
- handler: (err) => {
249
+ handler: (err, req) => {
236
250
  const httpErr = err;
237
- return {
238
- status: httpErr.status,
239
- body: httpErr.body ?? { message: httpErr.message },
240
- };
251
+ const { status } = httpErr;
252
+ const headers = httpErr.headers && { headers: httpErr.headers };
253
+ if (httpErr.body != null) {
254
+ // Custom `{ message, body }` or the deprecated positional body:
255
+ // answered verbatim.
256
+ return { status, body: httpErr.body, ...headers };
257
+ }
258
+ let { message } = httpErr;
259
+ if (httpErr.i18nKey) {
260
+ // `skipInterpolation`: a missing key falls back to the English text
261
+ // literally — it may embed request data, so i18next must not expand
262
+ // `$t(...)` or `{{…}}` inside it.
263
+ const translated = req.appInfo?.i18n?.t(httpErr.i18nKey, {
264
+ defaultValue: message,
265
+ skipInterpolation: true,
266
+ });
267
+ if (typeof translated === 'string') {
268
+ message = translated;
269
+ }
270
+ }
271
+ const body = httpErr.code ? { error: httpErr.code, message } : { message };
272
+ if (httpErr.issues) {
273
+ const t = req.appInfo?.i18n?.t;
274
+ body.errors = issuesToPayload(t ? translateIssues(httpErr.issues, t) : httpErr.issues);
275
+ }
276
+ return { status, body, ...headers };
241
277
  },
242
278
  logLevel: 'verbose',
243
279
  },
@@ -246,7 +282,13 @@ export function builtInErrorHandlers() {
246
282
  handler: (err, req) => {
247
283
  const clientErrors = matchedClientValidationErrors(err, req);
248
284
  return clientErrors
249
- ? { status: 400, body: { errors: clientErrors } }
285
+ ? {
286
+ status: 400,
287
+ body: {
288
+ message: validationFailedMessage(req),
289
+ errors: new ValidationError(clientErrors).message,
290
+ },
291
+ }
250
292
  : null;
251
293
  },
252
294
  logLevel: 'warn',
@@ -256,7 +298,13 @@ export function builtInErrorHandlers() {
256
298
  handler: (err, req) => {
257
299
  const clientErrors = matchedClientCastError(err, req);
258
300
  return clientErrors
259
- ? { status: 400, body: { errors: clientErrors } }
301
+ ? {
302
+ status: 400,
303
+ body: {
304
+ message: validationFailedMessage(req),
305
+ errors: new ValidationError(clientErrors).message,
306
+ },
307
+ }
260
308
  : null;
261
309
  },
262
310
  logLevel: 'warn',
@@ -1 +1 @@
1
- {"version":3,"file":"builtinErrorHandlers.js","sourceRoot":"","sources":["../../../src/services/http/builtinErrorHandlers.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAEhC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAsD5C,4EAA4E;AAC5E,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAS,qBAAqB,CAAC,KAAyB;IACtD,yEAAyE;IACzE,0EAA0E;IAC1E,yEAAyE;IACzE,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QAC/B,QAAQ,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC;YAClC,KAAK,QAAQ,CAAC;YACd,KAAK,YAAY;gBACf,OAAO,kBAAkB,CAAC;YAC5B,KAAK,MAAM;gBACT,OAAO,sBAAsB,CAAC;YAChC,KAAK,UAAU;gBACb,OAAO,oBAAoB,CAAC;YAC9B,KAAK,SAAS;gBACZ,OAAO,mBAAmB,CAAC;YAC7B,KAAK,QAAQ;gBACX,OAAO,kBAAkB,CAAC;YAC5B,KAAK,QAAQ;gBACX,OAAO,8BAA8B,CAAC;YACxC;gBACE,OAAO,eAAe,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAG,KAAK,CAAC,UAA2C,CAAC;IAChE,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,UAAU;YACb,OAAO,UAAU,CAAC;QACpB,KAAK,MAAM,EAAE,CAAC;YACZ,0EAA0E;YAC1E,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC;YAChC,OAAO,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;gBAChC,CAAC,CAAC,mBAAmB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACpD,CAAC,CAAC,eAAe,CAAC;QACtB,CAAC;QACD,KAAK,KAAK,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACrC,OAAO,KAAK,KAAK,SAAS;gBACxB,CAAC,CAAC,oBAAoB;gBACtB,CAAC,CAAC,oBAAoB,KAAK,EAAE,CAAC;QAClC,CAAC;QACD,KAAK,KAAK,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACrC,OAAO,KAAK,KAAK,SAAS;gBACxB,CAAC,CAAC,oBAAoB;gBACtB,CAAC,CAAC,mBAAmB,KAAK,EAAE,CAAC;QACjC,CAAC;QACD,KAAK,WAAW;YACd,OAAO,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ;gBACxC,CAAC,CAAC,oBAAoB,KAAK,CAAC,SAAS,aAAa;gBAClD,CAAC,CAAC,WAAW,CAAC;QAClB,KAAK,WAAW;YACd,OAAO,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ;gBACxC,CAAC,CAAC,mBAAmB,KAAK,CAAC,SAAS,aAAa;gBACjD,CAAC,CAAC,UAAU,CAAC;QACjB,KAAK,QAAQ;YACX,OAAO,gBAAgB,CAAC;QAC1B;YACE,sEAAsE;YACtE,oDAAoD;YACpD,OAAO,eAAe,CAAC;IAC3B,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAAC,GAAY;IAC1C,6EAA6E;IAC7E,+EAA+E;IAC/E,2EAA2E;IAC3E,8EAA8E;IAC9E,4EAA4E;IAC5E,kEAAkE;IAClE,IAAI,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;QAC5C,MAAM,SAAS,GAAG,IAAI,KAAK,CACzB,wBAAwB,GAAG,CAAC,IAAI,8BAA8B,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAC3F,CAAC;QACF,SAAS,CAAC,IAAI,GAAG,WAAW,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC,CAAC,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;QACrD,OAAO,GAAG,CAAC;IACb,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAC1C,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,KAAK,qBAAqB,CAAC,UAAU,CAAC,EAAE,CACxE,CAAC;IACF,wEAAwE;IACxE,qEAAqE;IACrE,MAAM,SAAS,GAAI,GAA8B,CAAC,QAAQ,CAAC;IAC3D,MAAM,MAAM,GACV,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC;IAClE,MAAM,SAAS,GAAG,IAAI,KAAK,CACzB,GAAG,MAAM,6BAA6B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACzD,CAAC;IACF,SAAS,CAAC,IAAI,GAAG,iBAAiB,CAAC;IACnC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,6BAA6B,CAC3C,GAAmC,EACnC,GAAqB;IAErB,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7C,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IACpC,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9D,IAAI,MAAM,EAAE,CAAC;YACX,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBACtC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IACD,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAEhC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,CAAC,WAAW,CAAC,GAAG,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;0EAE0E;AAC1E,SAAS,qBAAqB,CAAC,KAAc;IAC3C,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAC5E,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,GAAqB;IAC/C,MAAM,GAAG,GAAwB,EAAE,CAAC;IACpC,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;QAC5E,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,SAAS;QACX,CAAC;QACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;gBAC1B,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,sBAAsB,CACpC,GAA6B,EAC7B,GAAqB;IAErB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACnC,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;QACvD,IAAI,qBAAqB,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE,CAAC;YACvE,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,oBAAoB;IAClC,OAAO;QACL;YACE,UAAU,EAAE,SAAS;YACrB,oEAAoE;YACpE,sDAAsD;YACtD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACf,MAAM,OAAO,GAAG,GAAgB,CAAC;gBACjC,OAAO;oBACL,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE;iBACnD,CAAC;YACJ,CAAC;YACD,QAAQ,EAAE,SAAS;SACpB;QACD;YACE,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,eAAe;YAC1C,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACpB,MAAM,YAAY,GAAG,6BAA6B,CAChD,GAAqC,EACrC,GAAG,CACJ,CAAC;gBACF,OAAO,YAAY;oBACjB,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE;oBACjD,CAAC,CAAC,IAAI,CAAC;YACX,CAAC;YACD,QAAQ,EAAE,MAAM;SACjB;QACD;YACE,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS;YACpC,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACpB,MAAM,YAAY,GAAG,sBAAsB,CACzC,GAA+B,EAC/B,GAAG,CACJ,CAAC;gBACF,OAAO,YAAY;oBACjB,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE;oBACjD,CAAC,CAAC,IAAI,CAAC;YACX,CAAC;YACD,QAAQ,EAAE,MAAM;SACjB;KACF,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"builtinErrorHandlers.js","sourceRoot":"","sources":["../../../src/services/http/builtinErrorHandlers.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EACL,eAAe,EACf,eAAe,EACf,eAAe,GAChB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,qDAAqD;AACrD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,GAAqB,EAAE,EAAE,CAC1D,oBAAoB,CAClB,GAAG,EACH,kBAAkB,EAClB,+CAA+C,CAChD,CAAC;AAEJ,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,GAAqB,EAAE,EAAE,CAC/D,oBAAoB,CAAC,GAAG,EAAE,uBAAuB,EAAE,mBAAmB,CAAC,CAAC;AAoB1E,kEAAkE;AAClE,MAAM,UAAU,eAAe,CAC7B,GAAa,EACb,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAsB;IAE7C,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;QAC1D,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC;AAsCD,4EAA4E;AAC5E,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAS,qBAAqB,CAAC,KAAyB;IACtD,yEAAyE;IACzE,0EAA0E;IAC1E,yEAAyE;IACzE,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QAC/B,QAAQ,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC;YAClC,KAAK,QAAQ,CAAC;YACd,KAAK,YAAY;gBACf,OAAO,kBAAkB,CAAC;YAC5B,KAAK,MAAM;gBACT,OAAO,sBAAsB,CAAC;YAChC,KAAK,UAAU;gBACb,OAAO,oBAAoB,CAAC;YAC9B,KAAK,SAAS;gBACZ,OAAO,mBAAmB,CAAC;YAC7B,KAAK,QAAQ;gBACX,OAAO,kBAAkB,CAAC;YAC5B,KAAK,QAAQ;gBACX,OAAO,8BAA8B,CAAC;YACxC;gBACE,OAAO,eAAe,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAG,KAAK,CAAC,UAA2C,CAAC;IAChE,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,UAAU;YACb,OAAO,UAAU,CAAC;QACpB,KAAK,MAAM,EAAE,CAAC;YACZ,0EAA0E;YAC1E,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC;YAChC,OAAO,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;gBAChC,CAAC,CAAC,mBAAmB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACpD,CAAC,CAAC,eAAe,CAAC;QACtB,CAAC;QACD,KAAK,KAAK,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACrC,OAAO,KAAK,KAAK,SAAS;gBACxB,CAAC,CAAC,oBAAoB;gBACtB,CAAC,CAAC,oBAAoB,KAAK,EAAE,CAAC;QAClC,CAAC;QACD,KAAK,KAAK,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACrC,OAAO,KAAK,KAAK,SAAS;gBACxB,CAAC,CAAC,oBAAoB;gBACtB,CAAC,CAAC,mBAAmB,KAAK,EAAE,CAAC;QACjC,CAAC;QACD,KAAK,WAAW;YACd,OAAO,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ;gBACxC,CAAC,CAAC,oBAAoB,KAAK,CAAC,SAAS,aAAa;gBAClD,CAAC,CAAC,WAAW,CAAC;QAClB,KAAK,WAAW;YACd,OAAO,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ;gBACxC,CAAC,CAAC,mBAAmB,KAAK,CAAC,SAAS,aAAa;gBACjD,CAAC,CAAC,UAAU,CAAC;QACjB,KAAK,QAAQ;YACX,OAAO,gBAAgB,CAAC;QAC1B;YACE,sEAAsE;YACtE,oDAAoD;YACpD,OAAO,eAAe,CAAC;IAC3B,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAAC,GAAY;IAC1C,6EAA6E;IAC7E,+EAA+E;IAC/E,2EAA2E;IAC3E,8EAA8E;IAC9E,4EAA4E;IAC5E,kEAAkE;IAClE,IAAI,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;QAC5C,MAAM,SAAS,GAAG,IAAI,KAAK,CACzB,wBAAwB,GAAG,CAAC,IAAI,8BAA8B,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAC3F,CAAC;QACF,SAAS,CAAC,IAAI,GAAG,WAAW,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC,CAAC,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;QACrD,OAAO,GAAG,CAAC;IACb,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAC1C,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,KAAK,qBAAqB,CAAC,UAAU,CAAC,EAAE,CACxE,CAAC;IACF,wEAAwE;IACxE,qEAAqE;IACrE,MAAM,SAAS,GAAI,GAA8B,CAAC,QAAQ,CAAC;IAC3D,MAAM,MAAM,GACV,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC;IAClE,MAAM,SAAS,GAAG,IAAI,KAAK,CACzB,GAAG,MAAM,6BAA6B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACzD,CAAC;IACF,SAAS,CAAC,IAAI,GAAG,iBAAiB,CAAC;IACnC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,6BAA6B,CAC3C,GAAmC,EACnC,GAAqB;IAErB,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7C,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IACpC,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9D,IAAI,MAAM,EAAE,CAAC;YACX,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBACtC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IACD,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAEhC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,CAAC,WAAW,CAAC,GAAG,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;0EAE0E;AAC1E,SAAS,qBAAqB,CAAC,KAAc;IAC3C,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAC5E,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,GAAqB;IAC/C,MAAM,GAAG,GAAwB,EAAE,CAAC;IACpC,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;QAC5E,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,SAAS;QACX,CAAC;QACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;gBAC1B,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,sBAAsB,CACpC,GAA6B,EAC7B,GAAqB;IAErB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACnC,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;QACvD,IAAI,qBAAqB,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE,CAAC;YACvE,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,oBAAoB;IAClC,OAAO;QACL;YACE,UAAU,EAAE,SAAS;YACrB,oEAAoE;YACpE,sDAAsD;YACtD,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACpB,MAAM,OAAO,GAAG,GAAgB,CAAC;gBACjC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;gBAC3B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;gBAChE,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACzB,gEAAgE;oBAChE,qBAAqB;oBACrB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC;gBACpD,CAAC;gBACD,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;gBAC1B,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;oBACpB,oEAAoE;oBACpE,oEAAoE;oBACpE,kCAAkC;oBAClC,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE;wBACvD,YAAY,EAAE,OAAO;wBACrB,iBAAiB,EAAE,IAAI;qBACxB,CAAC,CAAC;oBACH,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;wBACnC,OAAO,GAAG,UAAU,CAAC;oBACvB,CAAC;gBACH,CAAC;gBACD,MAAM,IAAI,GACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;gBAChE,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;oBACnB,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC/B,IAAI,CAAC,MAAM,GAAG,eAAe,CAC3B,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CACxD,CAAC;gBACJ,CAAC;gBACD,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC;YACtC,CAAC;YACD,QAAQ,EAAE,SAAS;SACpB;QACD;YACE,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,eAAe;YAC1C,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACpB,MAAM,YAAY,GAAG,6BAA6B,CAChD,GAAqC,EACrC,GAAG,CACJ,CAAC;gBACF,OAAO,YAAY;oBACjB,CAAC,CAAC;wBACE,MAAM,EAAE,GAAG;wBACX,IAAI,EAAE;4BACJ,OAAO,EAAE,uBAAuB,CAAC,GAAG,CAAC;4BACrC,MAAM,EAAE,IAAI,eAAe,CAAC,YAAY,CAAC,CAAC,OAAO;yBAClD;qBACF;oBACH,CAAC,CAAC,IAAI,CAAC;YACX,CAAC;YACD,QAAQ,EAAE,MAAM;SACjB;QACD;YACE,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS;YACpC,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACpB,MAAM,YAAY,GAAG,sBAAsB,CACzC,GAA+B,EAC/B,GAAG,CACJ,CAAC;gBACF,OAAO,YAAY;oBACjB,CAAC,CAAC;wBACE,MAAM,EAAE,GAAG;wBACX,IAAI,EAAE;4BACJ,OAAO,EAAE,uBAAuB,CAAC,GAAG,CAAC;4BACrC,MAAM,EAAE,IAAI,eAAe,CAAC,YAAY,CAAC,CAAC,OAAO;yBAClD;qBACF;oBACH,CAAC,CAAC,IAAI,CAAC;YACX,CAAC;YACD,QAAQ,EAAE,MAAM;SACjB;KACF,CAAC;AACJ,CAAC"}
@@ -1,30 +1,83 @@
1
+ import type { ValidationIssue } from '../validate/types.ts';
2
+ import { type ValidationErrorPayload } from '../validate/ValidationError.ts';
3
+ /** Contract form: answered as `{ error?: code, message, errors? }`; `i18nKey` stays on the server. */
4
+ export interface HttpErrorContractDetails {
5
+ /** English text: the log line, and the response message unless `i18nKey` translates it. */
6
+ message: string;
7
+ /** Machine-readable code, answered as `{ error: code, message }`. */
8
+ code?: string;
9
+ /** Translation key for the response message; stays on the server. */
10
+ i18nKey?: string;
11
+ /**
12
+ * Field errors, the same shape as request validation: `{ field: msg | [msg] }`
13
+ * or validation issues (with `params` for interpolation). Answered as
14
+ * `errors: { field: [msg] }`; i18n-key messages are translated.
15
+ */
16
+ errors?: ValidationErrorPayload | ReadonlyArray<ValidationIssue>;
17
+ /** Response headers, e.g. `{ 'Retry-After': '30' }` on a 429. */
18
+ headers?: Record<string, string>;
19
+ body?: never;
20
+ }
21
+ /** Custom form: `body` IS the response — the contract fields cannot be combined with it. */
22
+ export interface HttpErrorBodyDetails {
23
+ /** English text for the log line; not sent. */
24
+ message: string;
25
+ /** The whole response body, sent as-is (no `error`/`message`/`errors` added). */
26
+ body: unknown;
27
+ /** Response headers, e.g. `{ 'Retry-After': '30' }` on a 429. */
28
+ headers?: Record<string, string>;
29
+ code?: never;
30
+ i18nKey?: never;
31
+ errors?: never;
32
+ }
33
+ export type HttpErrorDetails = HttpErrorContractDetails | HttpErrorBodyDetails;
1
34
  /**
2
35
  * Throwable HTTP errors — the deliberate way to produce a status from deep
3
- * business logic without threading `res`. Thrown under a route handler, they
4
- * resolve through the error-handler registry
36
+ * business logic without threading `res`. Thrown from a route handler or a
37
+ * middleware, they resolve through the error-handler registry
5
38
  * (`HttpServer.registerErrorHandler`) via a built-in mapper:
6
- * `status` + `body ?? { message }`, logged at `verbose` (control flow, not a
7
- * defect). Subclass for other statuses, or construct the base directly:
39
+ * `status` + `{ error?: code, message, errors? }` (message translated via
40
+ * `i18nKey`, field errors like request validation) or a custom `body`, logged
41
+ * at `verbose` (control flow, not a defect).
42
+ * Subclass for other statuses, or construct the base directly:
8
43
  * `new HttpError(422, 'Unprocessable')`.
9
44
  */
10
45
  export declare class HttpError extends Error {
11
46
  readonly status: number;
12
- /** Optional response-body override; the mapper falls back to `{ message }`. */
47
+ /** Custom response body (`{ message, body }`); when set, the contract fields are unused. */
13
48
  readonly body?: unknown;
14
- constructor(status: number, message: string, body?: unknown);
49
+ readonly code?: string;
50
+ readonly i18nKey?: string;
51
+ /** Field errors from `details.errors`, normalized to validation issues. */
52
+ readonly issues?: ReadonlyArray<ValidationIssue>;
53
+ /** Response headers from `details.headers`. */
54
+ readonly headers?: Record<string, string>;
55
+ constructor(status: number, message: string | HttpErrorDetails);
56
+ /** @deprecated Use `{ message, errors }` for field errors, or `{ message, body }` for a custom body. Removed in v6. */
57
+ constructor(status: number, message: string | HttpErrorDetails, body: unknown);
15
58
  }
16
59
  export declare class BadRequestError extends HttpError {
17
- constructor(message?: string, body?: unknown);
60
+ constructor(message?: string | HttpErrorDetails);
61
+ /** @deprecated Use `{ message, errors }` for field errors, or `{ message, body }` for a custom body. Removed in v6. */
62
+ constructor(message: string | HttpErrorDetails | undefined, body: unknown);
18
63
  }
19
64
  export declare class UnauthorizedError extends HttpError {
20
- constructor(message?: string, body?: unknown);
65
+ constructor(message?: string | HttpErrorDetails);
66
+ /** @deprecated Use `{ message, errors }` for field errors, or `{ message, body }` for a custom body. Removed in v6. */
67
+ constructor(message: string | HttpErrorDetails | undefined, body: unknown);
21
68
  }
22
69
  export declare class ForbiddenError extends HttpError {
23
- constructor(message?: string, body?: unknown);
70
+ constructor(message?: string | HttpErrorDetails);
71
+ /** @deprecated Use `{ message, errors }` for field errors, or `{ message, body }` for a custom body. Removed in v6. */
72
+ constructor(message: string | HttpErrorDetails | undefined, body: unknown);
24
73
  }
25
74
  export declare class NotFoundError extends HttpError {
26
- constructor(message?: string, body?: unknown);
75
+ constructor(message?: string | HttpErrorDetails);
76
+ /** @deprecated Use `{ message, errors }` for field errors, or `{ message, body }` for a custom body. Removed in v6. */
77
+ constructor(message: string | HttpErrorDetails | undefined, body: unknown);
27
78
  }
28
79
  export declare class ConflictError extends HttpError {
29
- constructor(message?: string, body?: unknown);
80
+ constructor(message?: string | HttpErrorDetails);
81
+ /** @deprecated Use `{ message, errors }` for field errors, or `{ message, body }` for a custom body. Removed in v6. */
82
+ constructor(message: string | HttpErrorDetails | undefined, body: unknown);
30
83
  }
@@ -1,21 +1,57 @@
1
+ import { makeOncePerClassWarner } from '../../helpers/deprecation.js';
2
+ import { ValidationError, } from '../validate/ValidationError.js';
3
+ const CONTRACT_FIELDS = ['code', 'i18nKey', 'errors'];
4
+ const warnBodyMixed = makeOncePerClassWarner('ASF_HTTP_ERROR_BODY_MIXED', (name, ignored) => `${name} received body together with ${String(ignored)}. body replaces the whole response, so those are ignored. Pass body alone, or drop it to answer { error?, message, errors? }.`, 'Warning');
5
+ const warnBodyArgument = makeOncePerClassWarner('ASF_DEP_HTTP_ERROR_BODY', (name) => `${name} received the positional body argument, which is deprecated. Use the details object instead: { message, errors } for field errors, or { message, body } for a custom body. The argument will be removed in v6.`);
1
6
  /**
2
7
  * Throwable HTTP errors — the deliberate way to produce a status from deep
3
- * business logic without threading `res`. Thrown under a route handler, they
4
- * resolve through the error-handler registry
8
+ * business logic without threading `res`. Thrown from a route handler or a
9
+ * middleware, they resolve through the error-handler registry
5
10
  * (`HttpServer.registerErrorHandler`) via a built-in mapper:
6
- * `status` + `body ?? { message }`, logged at `verbose` (control flow, not a
7
- * defect). Subclass for other statuses, or construct the base directly:
11
+ * `status` + `{ error?: code, message, errors? }` (message translated via
12
+ * `i18nKey`, field errors like request validation) or a custom `body`, logged
13
+ * at `verbose` (control flow, not a defect).
14
+ * Subclass for other statuses, or construct the base directly:
8
15
  * `new HttpError(422, 'Unprocessable')`.
9
16
  */
10
17
  export class HttpError extends Error {
11
18
  status;
12
- /** Optional response-body override; the mapper falls back to `{ message }`. */
19
+ /** Custom response body (`{ message, body }`); when set, the contract fields are unused. */
13
20
  body;
21
+ code;
22
+ i18nKey;
23
+ /** Field errors from `details.errors`, normalized to validation issues. */
24
+ issues;
25
+ /** Response headers from `details.headers`. */
26
+ headers;
14
27
  constructor(status, message, body) {
15
- super(message);
28
+ const details = typeof message === 'string' ? { message } : message;
29
+ super(details.message);
30
+ if (body !== undefined) {
31
+ warnBodyArgument(new.target);
32
+ }
16
33
  this.name = new.target.name;
17
34
  this.status = status;
35
+ this.headers = details.headers;
36
+ if (details.body !== undefined) {
37
+ // Custom form: the body is the response, so the contract fields are
38
+ // dropped. Types forbid mixing; this guards plain-JS / cast callers.
39
+ const ignored = CONTRACT_FIELDS.filter((k) => details[k] !== undefined);
40
+ if (ignored.length) {
41
+ warnBodyMixed(new.target, ignored.join(', '));
42
+ }
43
+ this.body = details.body;
44
+ return;
45
+ }
18
46
  this.body = body;
47
+ this.code = details.code;
48
+ this.i18nKey = details.i18nKey;
49
+ if (details.errors) {
50
+ const { issues } = new ValidationError(details.errors);
51
+ if (issues.length) {
52
+ this.issues = issues;
53
+ }
54
+ }
19
55
  }
20
56
  }
21
57
  export class BadRequestError extends HttpError {
@@ -1 +1 @@
1
- {"version":3,"file":"httpErrors.js","sourceRoot":"","sources":["../../../src/services/http/httpErrors.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IACzB,MAAM,CAAS;IAExB,+EAA+E;IACtE,IAAI,CAAW;IAExB,YAAY,MAAc,EAAE,OAAe,EAAE,IAAc;QACzD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C,YAAY,OAAO,GAAG,aAAa,EAAE,IAAc;QACjD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAC9C,YAAY,OAAO,GAAG,cAAc,EAAE,IAAc;QAClD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,SAAS;IAC3C,YAAY,OAAO,GAAG,WAAW,EAAE,IAAc;QAC/C,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC1C,YAAY,OAAO,GAAG,WAAW,EAAE,IAAc;QAC/C,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC1C,YAAY,OAAO,GAAG,UAAU,EAAE,IAAc;QAC9C,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF"}
1
+ {"version":3,"file":"httpErrors.js","sourceRoot":"","sources":["../../../src/services/http/httpErrors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAEtE,OAAO,EACL,eAAe,GAEhB,MAAM,gCAAgC,CAAC;AAoCxC,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAC;AAE/D,MAAM,aAAa,GAAG,sBAAsB,CAC1C,2BAA2B,EAC3B,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAChB,GAAG,IAAI,gCAAgC,MAAM,CAAC,OAAO,CAAC,+HAA+H,EACvL,SAAS,CACV,CAAC;AAEF,MAAM,gBAAgB,GAAG,sBAAsB,CAC7C,yBAAyB,EACzB,CAAC,IAAI,EAAE,EAAE,CACP,GAAG,IAAI,gNAAgN,CAC1N,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IACzB,MAAM,CAAS;IAExB,4FAA4F;IACnF,IAAI,CAAW;IAEf,IAAI,CAAU;IAEd,OAAO,CAAU;IAE1B,2EAA2E;IAClE,MAAM,CAAkC;IACjD,+CAA+C;IACtC,OAAO,CAA0B;IAS1C,YACE,MAAc,EACd,OAAkC,EAClC,IAAc;QAEd,MAAM,OAAO,GACX,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;QACtD,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,gBAAgB,CAAC,IAAI,MAAM,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,oEAAoE;YACpE,qEAAqE;YACrE,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;YACxE,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,aAAa,CAAC,IAAI,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAChD,CAAC;YACD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YACzB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACvD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAI5C,YACE,OAAO,GAA8B,aAAa,EAClD,IAAc;QAEd,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAI9C,YACE,OAAO,GAA8B,cAAc,EACnD,IAAc;QAEd,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,SAAS;IAI3C,YACE,OAAO,GAA8B,WAAW,EAChD,IAAc;QAEd,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,SAAS;IAI1C,YACE,OAAO,GAA8B,WAAW,EAChD,IAAc;QAEd,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,SAAS;IAI1C,YAAY,OAAO,GAA8B,UAAU,EAAE,IAAc;QACzE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF"}
@@ -20,16 +20,24 @@ declare class AbstractMiddleware extends Base {
20
20
  constructor(app: IApp, params?: Record<string, unknown>);
21
21
  static get description(): string;
22
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).
23
+ * How requests send the credentials this middleware reads (a bearer token,
24
+ * an API-key header, …), as OpenAPI security schemes. Declared
25
+ * **statically** so the generator reads them off the class with zero
26
+ * instantiation. Default `[]`. Reading alone documents auth as optional;
27
+ * see {@link requiresAuth}.
27
28
  */
29
+ static get authSchemes(): AuthParameter[];
30
+ /** @deprecated Renamed to {@link authSchemes}; removed in v6. */
28
31
  static get usedAuthParameters(): AuthParameter[];
32
+ /**
33
+ * Whether this middleware rejects requests without an authenticated user
34
+ * (`Auth`, `Role`). One such middleware anywhere in a route's chain makes
35
+ * the route's OpenAPI security required; without one it is optional.
36
+ */
37
+ static get requiresAuth(): boolean;
29
38
  /**
30
39
  * @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.
40
+ * (`static get authSchemes()`). The instance form will be removed in v6.
33
41
  */
34
42
  get usedAuthParameters(): AuthParameter[];
35
43
  /**
@@ -10,18 +10,31 @@ class AbstractMiddleware extends Base {
10
10
  return 'Middleware description. Please provide own';
11
11
  }
12
12
  /**
13
- * Security schemes this middleware enforces, declared **statically** so the
14
- * OpenAPI generator can read them off the class with zero instantiation.
15
- * Default `[]` (the middleware contributes no auth requirement). Override on
16
- * subclasses that gate requests (e.g. token/bearer auth).
13
+ * How requests send the credentials this middleware reads (a bearer token,
14
+ * an API-key header, …), as OpenAPI security schemes. Declared
15
+ * **statically** so the generator reads them off the class with zero
16
+ * instantiation. Default `[]`. Reading alone documents auth as optional;
17
+ * see {@link requiresAuth}.
17
18
  */
18
- static get usedAuthParameters() {
19
+ static get authSchemes() {
19
20
  return [];
20
21
  }
22
+ /** @deprecated Renamed to {@link authSchemes}; removed in v6. */
23
+ static get usedAuthParameters() {
24
+ // `this` is the concrete subclass, so its `authSchemes` override answers.
25
+ return this.authSchemes;
26
+ }
27
+ /**
28
+ * Whether this middleware rejects requests without an authenticated user
29
+ * (`Auth`, `Role`). One such middleware anywhere in a route's chain makes
30
+ * the route's OpenAPI security required; without one it is optional.
31
+ */
32
+ static get requiresAuth() {
33
+ return false;
34
+ }
21
35
  /**
22
36
  * @deprecated Since 5.0.0 — declare auth schemes **statically**
23
- * (`static get usedAuthParameters()`). The instance form is read only as a
24
- * fallback and will be removed in v6.
37
+ * (`static get authSchemes()`). The instance form will be removed in v6.
25
38
  */
26
39
  get usedAuthParameters() {
27
40
  return [];
@@ -1 +1 @@
1
- {"version":3,"file":"AbstractMiddleware.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/AbstractMiddleware.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,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;;;;;;OAMG;IACO,SAAS,CACjB,GAAqB,EACrB,GAAW,EACX,YAAoB;QAEpB,OAAO,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IACtD,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,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,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;;;;;;OAMG;IACH,MAAM,KAAK,WAAW;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,iEAAiE;IACjE,MAAM,KAAK,kBAAkB;QAC3B,0EAA0E;QAC1E,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,MAAM,KAAK,YAAY;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;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;;;;;;OAMG;IACO,SAAS,CACjB,GAAqB,EACrB,GAAW,EACX,YAAoB;QAEpB,OAAO,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IACtD,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"}
@@ -5,6 +5,7 @@ import type { GetUserByTokenAppInfo } from '../middleware/GetUserByToken.ts';
5
5
  import AbstractMiddleware from './AbstractMiddleware.ts';
6
6
  declare class AuthMiddleware extends AbstractMiddleware {
7
7
  static get description(): string;
8
+ static get requiresAuth(): boolean;
8
9
  /**
9
10
  * Type-only phantom (codegen reads it; runtime ignores it — see
10
11
  * `GetUserByToken.provides`). Auth rejects unauthenticated requests at
@@ -17,6 +18,6 @@ declare class AuthMiddleware extends AbstractMiddleware {
17
18
  static get provides(): {
18
19
  user: AppUser;
19
20
  };
20
- middleware(req: FrameworkRequest & GetUserByTokenAppInfo, res: Response, next: NextFunction): Promise<void | Response<any, Record<string, any>>>;
21
+ middleware(req: FrameworkRequest & GetUserByTokenAppInfo, _res: Response, next: NextFunction): Promise<void | Response>;
21
22
  }
22
23
  export default AuthMiddleware;
@@ -1,8 +1,12 @@
1
+ import { UnauthorizedError } from '../httpErrors.js';
1
2
  import AbstractMiddleware from './AbstractMiddleware.js';
2
3
  class AuthMiddleware extends AbstractMiddleware {
3
4
  static get description() {
4
5
  return 'Allow to pass only if the user provided. Please use any middleware that provide user instance before';
5
6
  }
7
+ static get requiresAuth() {
8
+ return true;
9
+ }
6
10
  /**
7
11
  * Type-only phantom (codegen reads it; runtime ignores it — see
8
12
  * `GetUserByToken.provides`). Auth rejects unauthenticated requests at
@@ -15,12 +19,13 @@ class AuthMiddleware extends AbstractMiddleware {
15
19
  static get provides() {
16
20
  return {};
17
21
  }
18
- async middleware(req, res, next) {
22
+ async middleware(req, _res, next) {
19
23
  if (!req.appInfo.user) {
20
24
  this.logger?.info('User try to access resource without credentials');
21
- return res.status(401).json({
22
- error: 'AUTH001',
23
- message: this.translate(req, 'middleware.auth.notLoggedIn', 'Please login to application'),
25
+ throw new UnauthorizedError({
26
+ code: 'AUTH001',
27
+ i18nKey: 'middleware.auth.notLoggedIn',
28
+ message: 'Please login to application',
24
29
  });
25
30
  }
26
31
  return next();
@@ -1 +1 @@
1
- {"version":3,"file":"Auth.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/Auth.ts"],"names":[],"mappings":"AAIA,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAEzD,MAAM,cAAe,SAAQ,kBAAkB;IAC7C,MAAM,KAAK,WAAW;QACpB,OAAO,sGAAsG,CAAC;IAChH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,KAAK,QAAQ;QACjB,OAAO,EAAuB,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,UAAU,CACd,GAA6C,EAC7C,GAAa,EACb,IAAkB;QAElB,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,iDAAiD,CAAC,CAAC;YACrE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,KAAK,EAAE,SAAS;gBAChB,OAAO,EAAE,IAAI,CAAC,SAAS,CACrB,GAAG,EACH,6BAA6B,EAC7B,6BAA6B,CAC9B;aACF,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;CACF;AAED,eAAe,cAAc,CAAC"}
1
+ {"version":3,"file":"Auth.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/Auth.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAEzD,MAAM,cAAe,SAAQ,kBAAkB;IAC7C,MAAM,KAAK,WAAW;QACpB,OAAO,sGAAsG,CAAC;IAChH,CAAC;IAED,MAAM,KAAK,YAAY;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,KAAK,QAAQ;QACjB,OAAO,EAAuB,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,UAAU,CACd,GAA6C,EAC7C,IAAc,EACd,IAAkB;QAIlB,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,iDAAiD,CAAC,CAAC;YACrE,MAAM,IAAI,iBAAiB,CAAC;gBAC1B,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,6BAA6B;gBACtC,OAAO,EAAE,6BAA6B;aACvC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;CACF;AAED,eAAe,cAAc,CAAC"}
@@ -5,6 +5,8 @@ import AbstractMiddleware from './AbstractMiddleware.ts';
5
5
  declare class Cors extends AbstractMiddleware {
6
6
  constructor(app: IApp, params: {
7
7
  origins: (string | RegExp)[];
8
+ /** Response headers browser code may read, e.g. `Retry-After`. */
9
+ exposedHeaders?: string[];
8
10
  });
9
11
  static get description(): string;
10
12
  middleware(req: FrameworkRequest, res: Response, next: NextFunction): Promise<void | Response<any, Record<string, any>>>;
@@ -42,6 +42,11 @@ class Cors extends AbstractMiddleware {
42
42
  res.status(204);
43
43
  return res.end();
44
44
  }
45
+ // Only the actual response needs it; a preflight ignores it.
46
+ const exposedHeaders = this.params?.exposedHeaders;
47
+ if (exposedHeaders?.length) {
48
+ res.set('Access-Control-Expose-Headers', exposedHeaders.join(', '));
49
+ }
45
50
  }
46
51
  }
47
52
  return next();
@@ -1 +1 @@
1
- {"version":3,"file":"Cors.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/Cors.ts"],"names":[],"mappings":"AAGA,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAEzD,MAAM,IAAK,SAAQ,kBAAkB;IACnC,YACE,GAAS,EACT,MAEC;QAED,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,yEAAyE;QACzE,0EAA0E;QAC1E,sBAAsB;QACtB,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACpC,IACE,MAAM,YAAY,MAAM;gBACxB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAChE,CAAC;gBACD,IAAI,CAAC,MAAM,EAAE,IAAI,CACf,eAAe,MAAM,CAAC,MAAM,kGAAkG,CAC/H,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,KAAK,WAAW;QACpB,OAAO,6BAA6B,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAqB,EAAE,GAAa,EAAE,IAAkB;QACvE,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC;QACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QACD,sEAAsE;QACtE,2EAA2E;QAC3E,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,OAA8B,EAAE,CAAC;YAClD,IACE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC;gBACzD,CAAC,IAAI,YAAY,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,EAC/D,CAAC;gBACD,GAAG,CAAC,GAAG,CAAC,6BAA6B,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAE3D,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;oBAC7B,GAAG,CAAC,GAAG,CACL,8BAA8B,EAC9B,gCAAgC,CACjC,CAAC;oBACF,GAAG,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;oBAE3C,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC;oBACrE,IAAI,cAAc,EAAE,CAAC;wBACnB,GAAG,CAAC,GAAG,CAAC,8BAA8B,EAAE,cAAc,CAAC,CAAC;oBAC1D,CAAC;oBACD,GAAG,CAAC,GAAG,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;oBAC/B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBAChB,OAAO,GAAG,CAAC,GAAG,EAAE,CAAC;gBACnB,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;CACF;AAED,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"Cors.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/Cors.ts"],"names":[],"mappings":"AAGA,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAEzD,MAAM,IAAK,SAAQ,kBAAkB;IACnC,YACE,GAAS,EACT,MAIC;QAED,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,yEAAyE;QACzE,0EAA0E;QAC1E,sBAAsB;QACtB,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACpC,IACE,MAAM,YAAY,MAAM;gBACxB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAChE,CAAC;gBACD,IAAI,CAAC,MAAM,EAAE,IAAI,CACf,eAAe,MAAM,CAAC,MAAM,kGAAkG,CAC/H,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,KAAK,WAAW;QACpB,OAAO,6BAA6B,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAqB,EAAE,GAAa,EAAE,IAAkB;QACvE,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC;QACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QACD,sEAAsE;QACtE,2EAA2E;QAC3E,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,OAA8B,EAAE,CAAC;YAClD,IACE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC;gBACzD,CAAC,IAAI,YAAY,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,EAC/D,CAAC;gBACD,GAAG,CAAC,GAAG,CAAC,6BAA6B,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAE3D,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;oBAC7B,GAAG,CAAC,GAAG,CACL,8BAA8B,EAC9B,gCAAgC,CACjC,CAAC;oBACF,GAAG,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;oBAE3C,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC;oBACrE,IAAI,cAAc,EAAE,CAAC;wBACnB,GAAG,CAAC,GAAG,CAAC,8BAA8B,EAAE,cAAc,CAAC,CAAC;oBAC1D,CAAC;oBACD,GAAG,CAAC,GAAG,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;oBAC/B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBAChB,OAAO,GAAG,CAAC,GAAG,EAAE,CAAC;gBACnB,CAAC;gBAED,6DAA6D;gBAC7D,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,EAAE,cAEvB,CAAC;gBACd,IAAI,cAAc,EAAE,MAAM,EAAE,CAAC;oBAC3B,GAAG,CAAC,GAAG,CAAC,+BAA+B,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBACtE,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;CACF;AAED,eAAe,IAAI,CAAC"}
@@ -18,7 +18,7 @@ declare class GetUserByToken extends AbstractMiddleware {
18
18
  static get provides(): {
19
19
  user?: AppUser;
20
20
  };
21
- static get usedAuthParameters(): ({
21
+ static get authSchemes(): ({
22
22
  name: string;
23
23
  type: string;
24
24
  in: string;
@@ -12,7 +12,7 @@ class GetUserByToken extends AbstractMiddleware {
12
12
  static get provides() {
13
13
  return {};
14
14
  }
15
- static get usedAuthParameters() {
15
+ static get authSchemes() {
16
16
  return [
17
17
  {
18
18
  name: 'Authorization',
@@ -30,7 +30,7 @@ class GetUserByToken extends AbstractMiddleware {
30
30
  }
31
31
  // Back-compat for any runtime reader of the instance form (removed in v6).
32
32
  get usedAuthParameters() {
33
- return GetUserByToken.usedAuthParameters;
33
+ return GetUserByToken.authSchemes;
34
34
  }
35
35
  /**
36
36
  * Resolve the bearer token a request presents, applying the auth precedence:
@@ -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,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;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAC,GAAqB;QACvC,MAAM,SAAS,GAAI,GAAG,CAAC,IAAwC,EAAE,KAAK,CAAC;QACvE,wEAAwE;QACxE,qEAAqE;QACrE,sDAAsD;QACtD,IAAI,KAAK,GAAG,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,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,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACjD,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,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QACjC,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,MAAM,QAAQ,GAAG,cAAc,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAqB,CAAC;QAC3D,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CACrC,QAAQ,CACT,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,WAAW;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,2EAA2E;IAC3E,IAAI,kBAAkB;QACpB,OAAO,cAAc,CAAC,WAAW,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAC,GAAqB;QACvC,MAAM,SAAS,GAAI,GAAG,CAAC,IAAwC,EAAE,KAAK,CAAC;QACvE,wEAAwE;QACxE,qEAAqE;QACrE,sDAAsD;QACtD,IAAI,KAAK,GAAG,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,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,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACjD,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,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QACjC,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,MAAM,QAAQ,GAAG,cAAc,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAqB,CAAC;QAC3D,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CACrC,QAAQ,CACT,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"}
@@ -18,6 +18,8 @@ declare class RateLimiter extends AbstractMiddleware {
18
18
  whenReady: Promise<void>;
19
19
  constructor(app: IApp, params?: Record<string, unknown>);
20
20
  initRedisLimiter(): Promise<void>;
21
+ generateConsumeKey(req: FrameworkRequest & GetUserByTokenAppInfo): string;
22
+ /** @deprecated Misspelled; use {@link generateConsumeKey}. Removed in v6. */
21
23
  gerenateConsumeKey(req: FrameworkRequest & GetUserByTokenAppInfo): string;
22
24
  consumeResult(consumeKey: string, consumePoints?: number): Promise<{
23
25
  msBeforeNext: number;
@@ -1,7 +1,11 @@
1
+ import { createHash } from 'node:crypto';
1
2
  import merge from 'deepmerge';
2
3
  import mongoose from 'mongoose';
3
4
  import { RateLimiterMemory, RateLimiterMongo, RateLimiterRedis, } from 'rate-limiter-flexible';
5
+ import { makeOncePerClassWarner } from '../../../helpers/deprecation.js';
6
+ import { HttpError } from '../httpErrors.js';
4
7
  import AbstractMiddleware from './AbstractMiddleware.js';
8
+ const warnMisspelledKeyOverride = makeOncePerClassWarner('ASF_DEP_RATE_LIMITER_KEY_METHOD', (name) => `Middleware "${name}" overrides RateLimiter.gerenateConsumeKey, which is renamed to generateConsumeKey. Rename the override — the old name will be removed in v6.`);
5
9
  class RateLimiter extends AbstractMiddleware {
6
10
  static get description() {
7
11
  return 'Rate limiter middleware. Limit amount of request. Please refer to documentation';
@@ -68,7 +72,7 @@ class RateLimiter extends AbstractMiddleware {
68
72
  this.logger?.error(`RateLimiter redis init failed (is '@redis/client' installed?): ${e}`);
69
73
  }
70
74
  }
71
- gerenateConsumeKey(req) {
75
+ generateConsumeKey(req) {
72
76
  const { ip, route, user, request } = this.finalOptions.consumeKeyComponents;
73
77
  const key = [];
74
78
  if (ip) {
@@ -94,14 +98,32 @@ class RateLimiter extends AbstractMiddleware {
94
98
  key.push(req.appInfo?.user.id);
95
99
  }
96
100
  if (request?.length) {
97
- request.forEach((val) => {
98
- if (req.body?.[val]) {
99
- key.push(req.body[val]);
101
+ // Raw body, before validation: fold the spellings a normalizing lookup
102
+ // treats as one account (case, surrounding spaces, compatibility forms),
103
+ // or each variant gets a fresh budget.
104
+ const fields = [];
105
+ for (const field of request) {
106
+ const value = req.body?.[field];
107
+ if (typeof value !== 'string' && typeof value !== 'number') {
108
+ continue;
100
109
  }
101
- });
110
+ const normalized = String(value).normalize('NFKC').trim().toLowerCase();
111
+ if (normalized) {
112
+ fields.push([field, normalized]);
113
+ }
114
+ }
115
+ // Hashed: bounds the key size and keeps request values (often e-mails)
116
+ // out of stored keys and the 429 log line.
117
+ if (fields.length) {
118
+ key.push(createHash('sha256').update(JSON.stringify(fields)).digest('hex'));
119
+ }
102
120
  }
103
121
  return key.join('_');
104
122
  }
123
+ /** @deprecated Misspelled; use {@link generateConsumeKey}. Removed in v6. */
124
+ gerenateConsumeKey(req) {
125
+ return this.generateConsumeKey(req);
126
+ }
105
127
  async consumeResult(consumeKey, consumePoints = 0) {
106
128
  try {
107
129
  const result = await this.limiter.consume(consumeKey, consumePoints || this.finalOptions.consumePoints);
@@ -136,16 +158,25 @@ class RateLimiter extends AbstractMiddleware {
136
158
  // (memory/mongo too) — intentional, so keys stay stable across a driver
137
159
  // switch. Not a redis dependency; don't "fix" it to be redis-only.
138
160
  const { namespace } = this.app.getConfig('redis');
139
- const consumeKey = `${namespace}-${this.gerenateConsumeKey(req)}`;
161
+ // A subclass still overriding the misspelled name keeps its custom key.
162
+ let key;
163
+ if (this.gerenateConsumeKey !== RateLimiter.prototype.gerenateConsumeKey) {
164
+ warnMisspelledKeyOverride(this.constructor);
165
+ key = this.gerenateConsumeKey(req);
166
+ }
167
+ else {
168
+ key = this.generateConsumeKey(req);
169
+ }
170
+ const consumeKey = `${namespace}-${key}`;
140
171
  const consumeResult = await this.consumeResult(consumeKey);
141
172
  if (consumeResult.isAllowed) {
142
173
  return next();
143
174
  }
144
- return res
145
- .status(429)
146
- .setHeader('Retry-After', String(consumeResult.retryAfter))
147
- .json({
148
- message: this.translate(req, 'middleware.rateLimiter.tooManyRequests', 'Too Many Requests'),
175
+ throw new HttpError(429, {
176
+ code: 'TOO_MANY_REQUESTS',
177
+ i18nKey: 'middleware.rateLimiter.tooManyRequests',
178
+ message: 'Too Many Requests',
179
+ headers: { 'Retry-After': String(consumeResult.retryAfter) },
149
180
  });
150
181
  }
151
182
  }