@adaptivestone/framework 5.4.2 → 5.5.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.
- package/CHANGELOG.md +35 -0
- package/README.md +28 -0
- package/dist/codegen/appTypes.d.ts +4 -5
- package/dist/codegen/appTypes.js +31 -22
- package/dist/codegen/appTypes.js.map +1 -1
- package/dist/codegen/index.d.ts +2 -2
- package/dist/codegen/index.js +3 -3
- package/dist/codegen/index.js.map +1 -1
- package/dist/commands/CreateEnv.d.ts +7 -0
- package/dist/commands/CreateEnv.js +36 -0
- package/dist/commands/CreateEnv.js.map +1 -0
- package/dist/config/health.d.ts +4 -0
- package/dist/config/health.js +8 -0
- package/dist/config/health.js.map +1 -0
- package/dist/config/http.d.ts +1 -0
- package/dist/config/http.js +4 -0
- package/dist/config/http.js.map +1 -1
- package/dist/config/log.d.ts +2 -0
- package/dist/config/log.js +5 -0
- package/dist/config/log.js.map +1 -1
- package/dist/config/rateLimiter.js +1 -1
- package/dist/config/rateLimiter.js.map +1 -1
- package/dist/controllers/Auth.js +15 -36
- package/dist/controllers/Auth.js.map +1 -1
- package/dist/controllers/Health.d.ts +24 -0
- package/dist/controllers/Health.js +83 -0
- package/dist/controllers/Health.js.map +1 -0
- package/dist/controllers/Health.routes.gen.d.ts +13 -0
- package/dist/controllers/Health.routes.gen.js +10 -0
- package/dist/controllers/Health.routes.gen.js.map +1 -0
- package/dist/controllers/index.js +11 -7
- package/dist/controllers/index.js.map +1 -1
- package/dist/helpers/crypto.d.ts +19 -0
- package/dist/helpers/crypto.js +32 -1
- package/dist/helpers/crypto.js.map +1 -1
- package/dist/helpers/deprecation.d.ts +4 -3
- package/dist/helpers/deprecation.js +5 -4
- package/dist/helpers/deprecation.js.map +1 -1
- package/dist/helpers/files.d.ts +6 -1
- package/dist/helpers/files.js +2 -1
- package/dist/helpers/files.js.map +1 -1
- package/dist/helpers/objects.d.ts +5 -0
- package/dist/helpers/objects.js +12 -0
- package/dist/helpers/objects.js.map +1 -0
- package/dist/modules/AbstractController.d.ts +3 -3
- package/dist/server.d.ts +4 -0
- package/dist/server.js +16 -2
- package/dist/server.js.map +1 -1
- package/dist/services/documentation/OpenApiGenerator.js +21 -3
- package/dist/services/documentation/OpenApiGenerator.js.map +1 -1
- package/dist/services/http/HttpServer.d.ts +13 -11
- package/dist/services/http/HttpServer.js +27 -18
- package/dist/services/http/HttpServer.js.map +1 -1
- package/dist/services/http/builtinErrorHandlers.d.ts +12 -2
- package/dist/services/http/builtinErrorHandlers.js +57 -9
- package/dist/services/http/builtinErrorHandlers.js.map +1 -1
- package/dist/services/http/httpErrors.d.ts +64 -11
- package/dist/services/http/httpErrors.js +42 -6
- package/dist/services/http/httpErrors.js.map +1 -1
- package/dist/services/http/middleware/AbstractMiddleware.d.ts +14 -6
- package/dist/services/http/middleware/AbstractMiddleware.js +20 -7
- package/dist/services/http/middleware/AbstractMiddleware.js.map +1 -1
- package/dist/services/http/middleware/Auth.d.ts +2 -1
- package/dist/services/http/middleware/Auth.js +9 -4
- package/dist/services/http/middleware/Auth.js.map +1 -1
- package/dist/services/http/middleware/Cors.d.ts +2 -0
- package/dist/services/http/middleware/Cors.js +5 -0
- package/dist/services/http/middleware/Cors.js.map +1 -1
- package/dist/services/http/middleware/GetUserByToken.d.ts +1 -1
- package/dist/services/http/middleware/GetUserByToken.js +2 -2
- package/dist/services/http/middleware/GetUserByToken.js.map +1 -1
- package/dist/services/http/middleware/RateLimiter.d.ts +2 -0
- package/dist/services/http/middleware/RateLimiter.js +42 -11
- package/dist/services/http/middleware/RateLimiter.js.map +1 -1
- package/dist/services/http/middleware/RequestLogger.js +10 -2
- package/dist/services/http/middleware/RequestLogger.js.map +1 -1
- package/dist/services/http/middleware/Role.d.ts +2 -1
- package/dist/services/http/middleware/Role.js +14 -5
- package/dist/services/http/middleware/Role.js.map +1 -1
- package/dist/services/http/routing/ExpressAdapter.js +7 -2
- package/dist/services/http/routing/ExpressAdapter.js.map +1 -1
- package/dist/services/http/routing/RouteNode.d.ts +7 -8
- package/dist/services/logging/redaction.d.ts +15 -0
- package/dist/services/logging/redaction.js +54 -0
- package/dist/services/logging/redaction.js.map +1 -0
- package/dist/services/validate/ValidateService.js +3 -27
- package/dist/services/validate/ValidateService.js.map +1 -1
- package/dist/services/validate/ValidationError.d.ts +10 -0
- package/dist/services/validate/ValidationError.js +28 -0
- package/dist/services/validate/ValidationError.js.map +1 -1
- package/dist/services/validate/mergeValidatedOutputs.d.ts +2 -6
- package/dist/services/validate/mergeValidatedOutputs.js +5 -12
- package/dist/services/validate/mergeValidatedOutputs.js.map +1 -1
- package/package.json +1 -1
|
@@ -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
|
|
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` + `
|
|
7
|
-
*
|
|
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
|
-
/**
|
|
47
|
+
/** Custom response body (`{ message, body }`); when set, the contract fields are unused. */
|
|
13
48
|
readonly body?: unknown;
|
|
14
|
-
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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` + `
|
|
7
|
-
*
|
|
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
|
-
/**
|
|
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
|
-
|
|
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
|
|
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
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
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
|
|
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
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
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
|
|
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
|
|
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
|
|
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,
|
|
21
|
+
middleware(req: FrameworkRequest & GetUserByTokenAppInfo, _res: Response, next: NextFunction): Promise<void>;
|
|
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,
|
|
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
|
-
|
|
22
|
-
|
|
23
|
-
|
|
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":"
|
|
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;QAElB,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,
|
|
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"}
|
|
@@ -12,7 +12,7 @@ class GetUserByToken extends AbstractMiddleware {
|
|
|
12
12
|
static get provides() {
|
|
13
13
|
return {};
|
|
14
14
|
}
|
|
15
|
-
static get
|
|
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.
|
|
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,
|
|
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
|
-
|
|
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
|
-
|
|
98
|
-
|
|
99
|
-
|
|
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
|
-
|
|
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
|
-
|
|
145
|
-
|
|
146
|
-
.
|
|
147
|
-
|
|
148
|
-
|
|
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
|
}
|
|
@@ -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;
|
|
1
|
+
{"version":3,"file":"RateLimiter.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/RateLimiter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,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,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAGzE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAGzD,MAAM,yBAAyB,GAAG,sBAAsB,CACtD,iCAAiC,EACjC,CAAC,IAAI,EAAE,EAAE,CACP,eAAe,IAAI,+IAA+I,CACrK,CAAC;AAEF,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,mEAAmE;YACnE,yEAAyE;YACzE,kEAAkE;YAClE,MAAM,MAAM,GACV,GAAG,CAAC,MAAM,KAAK,MAAM;gBACrB,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG;gBACvB,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI;gBACvB,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;YAC5B,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,IAAI,IAAI,WAAW,EAAE,CAAC,CAAC;QAC1D,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,uEAAuE;YACvE,yEAAyE;YACzE,uCAAuC;YACvC,MAAM,MAAM,GAAuB,EAAE,CAAC;YACtC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;gBAC5B,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;gBAChC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC3D,SAAS;gBACX,CAAC;gBACD,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;gBACxE,IAAI,UAAU,EAAE,CAAC;oBACf,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;YACD,uEAAuE;YACvE,2CAA2C;YAC3C,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,GAAG,CAAC,IAAI,CACN,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAClE,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,6EAA6E;IAC7E,kBAAkB,CAAC,GAA6C;QAC9D,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;IACtC,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,wEAAwE;QACxE,IAAI,GAAW,CAAC;QAChB,IAAI,IAAI,CAAC,kBAAkB,KAAK,WAAW,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;YACzE,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC5C,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;QACD,MAAM,UAAU,GAAG,GAAG,SAAS,IAAI,GAAG,EAAE,CAAC;QAEzC,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,MAAM,IAAI,SAAS,CAAC,GAAG,EAAE;YACvB,IAAI,EAAE,mBAAmB;YACzB,OAAO,EAAE,wCAAwC;YACjD,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,EAAE,aAAa,EAAE,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAED,eAAe,WAAW,CAAC"}
|
|
@@ -8,10 +8,18 @@ class RequestLogger extends AbstractMiddleware {
|
|
|
8
8
|
// Log the path only, not `req.url` — the query string can carry secrets
|
|
9
9
|
// (e.g. `/auth/verify?verification_token=…`).
|
|
10
10
|
const text = `Request is [${req.method}] ${req.path}`;
|
|
11
|
-
|
|
11
|
+
// Probes hit the built-in Health controller (default mount) every few
|
|
12
|
+
// seconds: log them only when they fail.
|
|
13
|
+
const isProbe = req.path.startsWith('/health/');
|
|
14
|
+
if (!isProbe) {
|
|
15
|
+
this.logger?.info(text);
|
|
16
|
+
}
|
|
12
17
|
res.on('finish', () => {
|
|
18
|
+
if (isProbe && res.statusCode < 400) {
|
|
19
|
+
return;
|
|
20
|
+
}
|
|
13
21
|
const end = performance.now();
|
|
14
|
-
this.logger?.info(`Finished ${text}. Status: ${res.statusCode}. [${(end - startTime).toFixed(2)} ms]`);
|
|
22
|
+
this.logger?.[isProbe ? 'warn' : 'info'](`Finished ${text}. Status: ${res.statusCode}. [${(end - startTime).toFixed(2)} ms]`);
|
|
15
23
|
});
|
|
16
24
|
next();
|
|
17
25
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RequestLogger.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/RequestLogger.ts"],"names":[],"mappings":"AAEA,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAEzD,MAAM,aAAc,SAAQ,kBAAkB;IAC5C,MAAM,KAAK,WAAW;QACpB,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAqB,EAAE,GAAa,EAAE,IAAkB;QACvE,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACpC,wEAAwE;QACxE,8CAA8C;QAC9C,MAAM,IAAI,GAAG,gBAAgB,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;QACvD,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"RequestLogger.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/RequestLogger.ts"],"names":[],"mappings":"AAEA,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAEzD,MAAM,aAAc,SAAQ,kBAAkB;IAC5C,MAAM,KAAK,WAAW;QACpB,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAqB,EAAE,GAAa,EAAE,IAAkB;QACvE,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACpC,wEAAwE;QACxE,8CAA8C;QAC9C,MAAM,IAAI,GAAG,gBAAgB,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;QACvD,sEAAsE;QACtE,yCAAyC;QACzC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;YACpB,IAAI,OAAO,IAAI,GAAG,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;gBACpC,OAAO;YACT,CAAC;YACD,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CACtC,YAAY,IAAI,aAAa,GAAG,CAAC,UAAU,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CACrF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,IAAI,EAAE,CAAC;IACT,CAAC;CACF;AAED,eAAe,aAAa,CAAC"}
|
|
@@ -5,8 +5,9 @@ import AbstractMiddleware from './AbstractMiddleware.ts';
|
|
|
5
5
|
import type { GetUserByTokenAppInfo } from './GetUserByToken.ts';
|
|
6
6
|
declare class RoleMiddleware extends AbstractMiddleware {
|
|
7
7
|
static get description(): string;
|
|
8
|
+
static get requiresAuth(): boolean;
|
|
8
9
|
middleware(req: FrameworkRequest & GetUserByTokenAppInfo & {
|
|
9
10
|
user: InstanceType<TUser>;
|
|
10
|
-
},
|
|
11
|
+
}, _res: Response, next: NextFunction): Promise<void>;
|
|
11
12
|
}
|
|
12
13
|
export default RoleMiddleware;
|
|
@@ -1,13 +1,20 @@
|
|
|
1
|
+
import { ForbiddenError, UnauthorizedError } from '../httpErrors.js';
|
|
1
2
|
import AbstractMiddleware from './AbstractMiddleware.js';
|
|
2
3
|
class RoleMiddleware extends AbstractMiddleware {
|
|
3
4
|
static get description() {
|
|
4
5
|
return 'Check user role (user.roles property). If the user has no role then stop request and return error. OR logic (any role will pass user)';
|
|
5
6
|
}
|
|
6
|
-
|
|
7
|
+
static get requiresAuth() {
|
|
8
|
+
return true;
|
|
9
|
+
}
|
|
10
|
+
async middleware(req, _res, next) {
|
|
7
11
|
const { user } = req.appInfo;
|
|
8
12
|
if (!user) {
|
|
9
|
-
|
|
10
|
-
|
|
13
|
+
// Same meaning for the client as the Auth 401: log in first.
|
|
14
|
+
throw new UnauthorizedError({
|
|
15
|
+
code: 'AUTH001',
|
|
16
|
+
i18nKey: 'middleware.role.userRequired',
|
|
17
|
+
message: 'User should be provided',
|
|
11
18
|
});
|
|
12
19
|
}
|
|
13
20
|
// Guard against `Role` being mounted without a `roles` param: treat a
|
|
@@ -20,8 +27,10 @@ class RoleMiddleware extends AbstractMiddleware {
|
|
|
20
27
|
}
|
|
21
28
|
});
|
|
22
29
|
if (!hasRole) {
|
|
23
|
-
|
|
24
|
-
|
|
30
|
+
throw new ForbiddenError({
|
|
31
|
+
code: 'NO_ACCESS',
|
|
32
|
+
i18nKey: 'middleware.role.noAccess',
|
|
33
|
+
message: 'You do not have access',
|
|
25
34
|
});
|
|
26
35
|
}
|
|
27
36
|
return next();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Role.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/Role.ts"],"names":[],"mappings":"AAGA,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAGzD,MAAM,cAAe,SAAQ,kBAAkB;IAC7C,MAAM,KAAK,WAAW;QACpB,OAAO,uIAAuI,CAAC;IACjJ,CAAC;IAED,KAAK,CAAC,UAAU,CACd,GACuD,EACvD,
|
|
1
|
+
{"version":3,"file":"Role.js","sourceRoot":"","sources":["../../../../src/services/http/middleware/Role.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AAGzD,MAAM,cAAe,SAAQ,kBAAkB;IAC7C,MAAM,KAAK,WAAW;QACpB,OAAO,uIAAuI,CAAC;IACjJ,CAAC;IAED,MAAM,KAAK,YAAY;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,UAAU,CACd,GACuD,EACvD,IAAc,EACd,IAAkB;QAElB,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC;QAE7B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,6DAA6D;YAC7D,MAAM,IAAI,iBAAiB,CAAC;gBAC1B,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,8BAA8B;gBACvC,OAAO,EAAE,yBAAyB;aACnC,CAAC,CAAC;QACL,CAAC;QAED,sEAAsE;QACtE,6EAA6E;QAC7E,MAAM,YAAY,GAAI,IAAI,CAAC,MAAM,EAAE,KAAuB,IAAI,EAAE,CAAC;QACjE,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE;YACnC,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChC,OAAO,GAAG,IAAI,CAAC;YACjB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,cAAc,CAAC;gBACvB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,0BAA0B;gBACnC,OAAO,EAAE,wBAAwB;aAClC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;CACF;AAED,eAAe,cAAc,CAAC"}
|