@meghjs/core 0.5.3 → 0.5.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -12
- package/dist/common/exceptions/http-exceptions.d.ts +1 -50
- package/dist/common/exceptions/http-exceptions.js +15 -80
- package/dist/common/exceptions/http-exceptions.js.map +1 -1
- package/dist/common/utils/compiled-validation.d.ts +43 -0
- package/dist/common/utils/compiled-validation.js +298 -0
- package/dist/common/utils/compiled-validation.js.map +1 -0
- package/dist/common/utils/object-utils.d.ts +4 -0
- package/dist/common/utils/object-utils.js +44 -7
- package/dist/common/utils/object-utils.js.map +1 -1
- package/dist/common/utils/path-utils.d.ts +7 -0
- package/dist/common/utils/path-utils.js +15 -0
- package/dist/common/utils/path-utils.js.map +1 -1
- package/dist/config/environment-variables.d.ts +2 -0
- package/dist/config/environment-variables.js +23 -12
- package/dist/config/environment-variables.js.map +1 -1
- package/dist/core/application.d.ts +89 -6
- package/dist/core/application.js +151 -73
- package/dist/core/application.js.map +1 -1
- package/dist/core/interfaces.d.ts +48 -1
- package/dist/core/router.d.ts +59 -5
- package/dist/core/router.js +238 -118
- package/dist/core/router.js.map +1 -1
- package/dist/core/testing.js +2 -12
- package/dist/core/testing.js.map +1 -1
- package/dist/core/types.d.ts +6 -0
- package/dist/errors/error-handler.d.ts +56 -0
- package/dist/errors/error-handler.js +206 -0
- package/dist/errors/error-handler.js.map +1 -0
- package/dist/errors/exception-filter.d.ts +96 -0
- package/dist/errors/exception-filter.js +68 -0
- package/dist/errors/exception-filter.js.map +1 -0
- package/dist/errors/http-exceptions.d.ts +413 -0
- package/dist/errors/http-exceptions.js +155 -0
- package/dist/errors/http-exceptions.js.map +1 -0
- package/dist/errors/index.d.ts +4 -0
- package/dist/errors/index.js +24 -0
- package/dist/errors/index.js.map +1 -0
- package/dist/events/event-subscriber.js +14 -3
- package/dist/events/event-subscriber.js.map +1 -1
- package/dist/events/socket-dispatcher.d.ts +1 -1
- package/dist/events/socket-dispatcher.js +1 -1
- package/dist/events/socket-dispatcher.js.map +1 -1
- package/dist/http/params.js +3 -1
- package/dist/http/params.js.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +4 -1
- package/dist/index.js.map +1 -1
- package/dist/observability/health.d.ts +45 -0
- package/dist/observability/health.js +74 -0
- package/dist/observability/health.js.map +1 -0
- package/dist/observability/index.d.ts +3 -0
- package/dist/observability/index.js +5 -0
- package/dist/observability/index.js.map +1 -1
- package/dist/observability/logger.js +8 -1
- package/dist/observability/logger.js.map +1 -1
- package/dist/observability/request-context.d.ts +29 -0
- package/dist/observability/request-context.js +54 -0
- package/dist/observability/request-context.js.map +1 -0
- package/dist/openapi/query-params.d.ts +36 -0
- package/dist/openapi/query-params.js +96 -0
- package/dist/openapi/query-params.js.map +1 -0
- package/dist/openapi/swagger-schema.js +21 -2
- package/dist/openapi/swagger-schema.js.map +1 -1
- package/dist/orm/connect.d.ts +2 -0
- package/dist/orm/connect.js +6 -1
- package/dist/orm/connect.js.map +1 -1
- package/dist/orm/plugin.js +2 -0
- package/dist/orm/plugin.js.map +1 -1
- package/dist/plugins/plugin.d.ts +3 -0
- package/dist/plugins/plugin.js.map +1 -1
- package/dist/plugins/registry.js +1 -0
- package/dist/plugins/registry.js.map +1 -1
- package/dist/validator/compat.d.ts +5 -0
- package/dist/validator/compat.js +42 -0
- package/dist/validator/compat.js.map +1 -0
- package/dist/validator/compiler.d.ts +20 -0
- package/dist/validator/compiler.js +219 -0
- package/dist/validator/compiler.js.map +1 -0
- package/dist/validator/decorators.d.ts +81 -0
- package/dist/validator/decorators.js +377 -0
- package/dist/validator/decorators.js.map +1 -0
- package/dist/validator/index.d.ts +16 -0
- package/dist/validator/index.js +36 -0
- package/dist/validator/index.js.map +1 -0
- package/dist/validator/is-email.d.ts +25 -0
- package/dist/validator/is-email.js +204 -0
- package/dist/validator/is-email.js.map +1 -0
- package/dist/validator/messages.d.ts +20 -0
- package/dist/validator/messages.js +186 -0
- package/dist/validator/messages.js.map +1 -0
- package/dist/validator/metadata.d.ts +118 -0
- package/dist/validator/metadata.js +153 -0
- package/dist/validator/metadata.js.map +1 -0
- package/dist/validator/transform.d.ts +29 -0
- package/dist/validator/transform.js +210 -0
- package/dist/validator/transform.js.map +1 -0
- package/package.json +26 -6
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { Socket } from "socket.io";
|
|
2
2
|
export declare class SocketContextService {
|
|
3
3
|
private readonly storage;
|
|
4
|
-
run(socket: Socket, fn: () => void | Promise<void>): void
|
|
4
|
+
run(socket: Socket, fn: () => void | Promise<void>): void | Promise<void>;
|
|
5
5
|
getSocket(): Socket | undefined;
|
|
6
6
|
}
|
|
7
7
|
export type DispatchOptions = {
|
|
@@ -18,7 +18,7 @@ const helpers_1 = require("../common/helpers");
|
|
|
18
18
|
let SocketContextService = class SocketContextService {
|
|
19
19
|
storage = new node_async_hooks_1.AsyncLocalStorage();
|
|
20
20
|
run(socket, fn) {
|
|
21
|
-
this.storage.run({ socket }, fn);
|
|
21
|
+
return this.storage.run({ socket }, fn);
|
|
22
22
|
}
|
|
23
23
|
getSocket() {
|
|
24
24
|
return this.storage.getStore()?.socket;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"socket-dispatcher.js","sourceRoot":"","sources":["../../src/events/socket-dispatcher.ts"],"names":[],"mappings":";;;;;;;;;;;;AAiFA,kCAsBC;AAvGD,8BAA8C;AAE9C,qDAAuD;AACvD,uDAAqD;AACrD,+CAA0C;AAGnC,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IACd,OAAO,GAAG,IAAI,oCAAiB,EAAsB,CAAC;IAEvE,GAAG,CAAC,MAAc,EAAE,EAA8B;QAChD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"socket-dispatcher.js","sourceRoot":"","sources":["../../src/events/socket-dispatcher.ts"],"names":[],"mappings":";;;;;;;;;;;;AAiFA,kCAsBC;AAvGD,8BAA8C;AAE9C,qDAAuD;AACvD,uDAAqD;AACrD,+CAA0C;AAGnC,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IACd,OAAO,GAAG,IAAI,oCAAiB,EAAsB,CAAC;IAEvE,GAAG,CAAC,MAAc,EAAE,EAA8B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC;IACzC,CAAC;CACF,CAAA;AAVY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,eAAU,GAAE;GACA,oBAAoB,CAUhC;AAWM,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IACH;IAA7B,YAA6B,QAA8B;QAA9B,aAAQ,GAAR,QAAQ,CAAsB;IAAG,CAAC;IAE/D,KAAK,CAAC,QAAQ,CACZ,KAAa,EACb,IAAO,EACP,UAA2B,EAAE;QAE7B,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,IAAI,GAAG,CAAC;QAExC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC;YACvD,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBACtD,MAAM;YACR,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,OAAO,KAAK,UAAU;oBAAE,MAAM,GAAG,CAAC;gBACtC,MAAM,IAAA,eAAK,EAAC,KAAK,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAChC,KAAa,EACb,IAAS,EACT,OAAwB;QAExB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEpD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;gBAC3B,MAAM,EAAE,GAAG,cAAS,CAAC,GAAG,CAAC,0BAAc,CAAC,CAAC;gBACzC,MAAM,OAAO,GAAG,cAAS,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;gBACpD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;gBAEnC,IAAI,OAAO,CAAC,SAAS,IAAI,MAAM,EAAE,CAAC;oBAChC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;wBACjB,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBACtD,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBACrC,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;wBACjB,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBACxC,CAAC;yBAAM,CAAC;wBACN,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBACvB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAA;AAnDY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,eAAU,GAAE;qCAE4B,oBAAoB;GADhD,qBAAqB,CAmDjC;AAED,SAAgB,WAAW,CACzB,KAAa,EACb,OAEC;IAED,OAAO,UACL,MAAW,EACX,WAAmB,EACnB,UAA8B;QAE9B,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC;QAElC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAG,IAAW;YAC/C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEhD,MAAM,UAAU,GAAG,cAAS,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YACxD,MAAM,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YAElD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}
|
package/dist/http/params.js
CHANGED
|
@@ -9,6 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
9
9
|
exports.AuthUser = exports.Header = exports.Body = exports.Query = exports.Param = void 0;
|
|
10
10
|
const container_1 = require("../common/container");
|
|
11
11
|
const helpers_1 = require("../common/helpers");
|
|
12
|
+
const metadata_1 = require("../validator/metadata");
|
|
12
13
|
/**
|
|
13
14
|
* Best-effort parameter names from the function source. Only used for
|
|
14
15
|
* diagnostics, so any failure yields an empty list.
|
|
@@ -100,7 +101,8 @@ function createParamDecorator(type) {
|
|
|
100
101
|
// parameter as untyped instead of crashing.
|
|
101
102
|
const parameterTypes = Reflect.getMetadata("design:paramtypes", target, propertyKey) || [];
|
|
102
103
|
const paramDataType = options.type ?? parameterTypes[parameterIndex];
|
|
103
|
-
const validatorClass = (0, helpers_1.isClassValidatorClass)(paramDataType)
|
|
104
|
+
const validatorClass = (0, helpers_1.isClassValidatorClass)(paramDataType) ||
|
|
105
|
+
(0, metadata_1.isMeghValidatorClass)(paramDataType);
|
|
104
106
|
existingParams.push({
|
|
105
107
|
index: parameterIndex,
|
|
106
108
|
key: typeof key === "string" ? key : "all",
|
package/dist/http/params.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"params.js","sourceRoot":"","sources":["../../src/http/params.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,mDAM6B;AAC7B,+CAAuE;
|
|
1
|
+
{"version":3,"file":"params.js","sourceRoot":"","sources":["../../src/http/params.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,mDAM6B;AAC7B,+CAAuE;AACvE,oDAA6D;AAY7D;;;GAGG;AACH,SAAS,kBAAkB,CAAC,EAAW;IACrC,IAAI,CAAC;QACH,IAAI,OAAO,EAAE,KAAK,UAAU;YAAE,OAAO,EAAE,CAAC;QACxC,MAAM,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjD,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,IAAI,KAAK,CAAC,CAAC;YAAE,OAAO,EAAE,CAAC;QAC3B,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;QACf,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;YAClB,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG;gBAAE,KAAK,EAAE,CAAC;iBAC/C,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;gBAChD,KAAK,EAAE,CAAC;gBACR,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBAChB,KAAK,GAAG,CAAC,CAAC;oBACV,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,KAAK,KAAK,CAAC,CAAC;YAAE,OAAO,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,KAAK,GAAG,CAAC,CAAC;QACV,KAAK,MAAM,EAAE,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;YAC5C,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG;gBAAE,KAAK,EAAE,CAAC;YACpD,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG;gBAAE,KAAK,EAAE,CAAC;YACpD,IAAI,EAAE,KAAK,GAAG,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBAC9B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACpB,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;QACH,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACrB,MAAM,CAAC,GAAG,CAAC;iBACR,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;iBAC5B,IAAI,EAAE;iBACN,KAAK,CAAC,mCAAmC,CAAC,CAAC;YAC9C,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAC3B,IAAqB;IAKrB,OAAO,UACL,GAA+B,EAC/B,UAA4B,EAAE;QAE9B,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5C,OAAO,GAAG,GAAG,CAAC;YACd,GAAG,GAAG,SAAS,CAAC;QAClB,CAAC;QACD,OAAO,UAAU,MAAW,EAAE,WAAgB,EAAE,cAAsB;YACpE,IAAI,OAAwB,CAAC;YAC7B,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,aAAa;oBAChB,OAAO,GAAG,0BAAc,CAAC;oBACzB,MAAM;gBACR,KAAK,aAAa;oBAChB,OAAO,GAAG,0BAAc,CAAC;oBACzB,MAAM;gBACR,KAAK,YAAY;oBACf,OAAO,GAAG,iCAAqB,CAAC;oBAChC,MAAM;gBACR,KAAK,YAAY;oBACf,OAAO,GAAG,iCAAqB,CAAC;oBAChC,MAAM;gBACR,KAAK,cAAc;oBACjB,OAAO,GAAG,mCAAuB,CAAC;oBAClC,MAAM;gBACR;oBACE,MAAM,IAAI,KAAK,CAAC,iCAAiC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrE,CAAC;YAED,MAAM,cAAc,GAClB,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;YAE1D,MAAM,UAAU,GAAG,kBAAkB,CACnC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAC3D,CAAC;YACF,oEAAoE;YACpE,4CAA4C;YAC5C,MAAM,cAAc,GAClB,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;YACtE,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,IAAI,cAAc,CAAC,cAAc,CAAC,CAAC;YACrE,MAAM,cAAc,GAClB,IAAA,+BAAqB,EAAC,aAAoB,CAAC;gBAC3C,IAAA,+BAAoB,EAAC,aAAa,CAAC,CAAC;YACtC,cAAc,CAAC,IAAI,CAAC;gBAClB,KAAK,EAAE,cAAc;gBACrB,GAAG,EAAE,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK;gBAC1C,IAAI,EAAE,UAAU,CAAC,cAAc,CAAC;gBAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI;gBAClC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI;gBAClC,QAAQ,EAAE,IAAA,qBAAW,EAAC,aAAa,CAAC;gBACpC,cAAc;gBACd,mEAAmE;gBACnE,+BAA+B;gBAC/B,MAAM,EAAE,IAAI;gBACZ,IAAI;aACL,CAAC,CAAC;YACH,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QACvE,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAEY,QAAA,KAAK,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAC5C,QAAA,KAAK,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAC5C,QAAA,IAAI,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAC;AAC1C,QAAA,MAAM,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;AAC9C,QAAA,QAAQ,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ export * from "./core/interfaces";
|
|
|
11
11
|
export * from "./core/types";
|
|
12
12
|
export * from "./core/testing";
|
|
13
13
|
export * from "./http";
|
|
14
|
+
export * from "./validator";
|
|
14
15
|
export * from "./openapi";
|
|
15
16
|
export * from "./collection";
|
|
16
17
|
export * from "./orm";
|
|
@@ -23,10 +24,10 @@ export * from "./security";
|
|
|
23
24
|
export * from "./storage";
|
|
24
25
|
export * from "./realtime";
|
|
25
26
|
export * from "./observability";
|
|
27
|
+
export * from "./errors";
|
|
26
28
|
export * from "./common/decorators";
|
|
27
29
|
export * from "./common/helpers";
|
|
28
30
|
export * from "./common/container";
|
|
29
|
-
export * from "./common/exceptions";
|
|
30
31
|
export declare const GetSchema: typeof sw.generateSwaggerSchema;
|
|
31
32
|
export declare const GetObjectSchema: typeof sw.generateClassSchema;
|
|
32
33
|
export declare const OpenApiOk: (args1: any) => {
|
package/dist/index.js
CHANGED
|
@@ -52,6 +52,8 @@ __exportStar(require("./core/types"), exports);
|
|
|
52
52
|
__exportStar(require("./core/testing"), exports);
|
|
53
53
|
// ─── HTTP ────────────────────────────────────────────────────────────────────
|
|
54
54
|
__exportStar(require("./http"), exports);
|
|
55
|
+
// ─── Validation (class-validator / class-transformer compatible) ─────────────
|
|
56
|
+
__exportStar(require("./validator"), exports);
|
|
55
57
|
// ─── OpenAPI ─────────────────────────────────────────────────────────────────
|
|
56
58
|
__exportStar(require("./openapi"), exports);
|
|
57
59
|
// ─── Collections and pagination ──────────────────────────────────────────────
|
|
@@ -72,11 +74,12 @@ __exportStar(require("./security"), exports);
|
|
|
72
74
|
__exportStar(require("./storage"), exports);
|
|
73
75
|
__exportStar(require("./realtime"), exports);
|
|
74
76
|
__exportStar(require("./observability"), exports);
|
|
77
|
+
// ─── Errors ─────────────────────────────────────────────────────────────────
|
|
78
|
+
__exportStar(require("./errors"), exports);
|
|
75
79
|
// ─── Common ──────────────────────────────────────────────────────────────────
|
|
76
80
|
__exportStar(require("./common/decorators"), exports);
|
|
77
81
|
__exportStar(require("./common/helpers"), exports);
|
|
78
82
|
__exportStar(require("./common/container"), exports);
|
|
79
|
-
__exportStar(require("./common/exceptions"), exports);
|
|
80
83
|
// ─── Convenience aliases ─────────────────────────────────────────────────────
|
|
81
84
|
exports.GetSchema = sw.generateSwaggerSchema;
|
|
82
85
|
exports.GetObjectSchema = sw.CreateSwaggerObjectSchema;
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;GAKG;AACH,4BAA0B;AAC1B,6DAA+C;AAE/C,gFAAgF;AAChF,qDAAmC;AACnC,oDAAkC;AAClC,+CAA6B;AAC7B,iDAA+B;AAE/B,gFAAgF;AAChF,yCAAuB;AAEvB,gFAAgF;AAChF,4CAA0B;AAE1B,gFAAgF;AAChF,+CAA6B;AAE7B,gFAAgF;AAChF,wCAAsB;AAEtB,gFAAgF;AAChF,2CAAyB;AAEzB,gFAAgF;AAChF,2CAAyB;AAEzB,gFAAgF;AAChF,0CAAwB;AAKxB,gFAAgF;AAChF,iEAA+C;AAE/C,gFAAgF;AAChF,6CAA2B;AAE3B,gFAAgF;AAChF,4CAA0B;AAC1B,6CAA2B;AAC3B,kDAAgC;AAEhC,gFAAgF;AAChF,sDAAoC;AACpC,mDAAiC;AACjC,qDAAmC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;GAKG;AACH,4BAA0B;AAC1B,6DAA+C;AAE/C,gFAAgF;AAChF,qDAAmC;AACnC,oDAAkC;AAClC,+CAA6B;AAC7B,iDAA+B;AAE/B,gFAAgF;AAChF,yCAAuB;AAEvB,gFAAgF;AAChF,8CAA4B;AAE5B,gFAAgF;AAChF,4CAA0B;AAE1B,gFAAgF;AAChF,+CAA6B;AAE7B,gFAAgF;AAChF,wCAAsB;AAEtB,gFAAgF;AAChF,2CAAyB;AAEzB,gFAAgF;AAChF,2CAAyB;AAEzB,gFAAgF;AAChF,0CAAwB;AAKxB,gFAAgF;AAChF,iEAA+C;AAE/C,gFAAgF;AAChF,6CAA2B;AAE3B,gFAAgF;AAChF,4CAA0B;AAC1B,6CAA2B;AAC3B,kDAAgC;AAEhC,+EAA+E;AAC/E,2CAAyB;AAEzB,gFAAgF;AAChF,sDAAoC;AACpC,mDAAiC;AACjC,qDAAmC;AAEnC,gFAAgF;AACnE,QAAA,SAAS,GAAG,EAAE,CAAC,qBAAqB,CAAC;AACrC,QAAA,eAAe,GAAG,EAAE,CAAC,yBAAyB,CAAC;AACrD,MAAM,SAAS,GAAG,CAAC,KAAU,EAAE,EAAE;IACtC,OAAO,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;AACnD,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB;AACW,QAAA,eAAe,GAAG,EAAE,CAAC,eAAe,CAAC;AACrC,QAAA,eAAe,GAAG,EAAE,CAAC,eAAe,CAAC;AAElD,iFAAiF;AACjF,4CAA0B;AAE1B,gFAAgF;AAChF,2BAOc;AANZ,mGAAA,SAAS,OAAiB;AAC1B,oGAAA,cAAc,OAAA;AACd,2FAAA,KAAK,OAAA;AACL,gGAAA,UAAU,OAAA;AACV,2GAAA,qBAAqB,OAAA;AACrB,4FAAA,MAAM,OAAA"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @copyright 2024
|
|
3
|
+
* @author Tareq Hossain
|
|
4
|
+
* @email xtrinsic96@gmail.com
|
|
5
|
+
* @url https://github.com/xtareq
|
|
6
|
+
*/
|
|
7
|
+
import type { FastifyInstance } from "fastify";
|
|
8
|
+
/**
|
|
9
|
+
* A readiness check. It passes unless it throws, rejects or returns `false`.
|
|
10
|
+
*
|
|
11
|
+
* app.addHealthCheck("redis", () => redis.ping())
|
|
12
|
+
*/
|
|
13
|
+
export type HealthCheck = () => unknown | Promise<unknown>;
|
|
14
|
+
export interface HealthOptions {
|
|
15
|
+
/** Liveness route: answers 200 while the process can serve requests. Defaults to `/health`. */
|
|
16
|
+
path?: string;
|
|
17
|
+
/** Readiness route: runs every check, 503 if any fails. Defaults to `/ready`. */
|
|
18
|
+
readyPath?: string;
|
|
19
|
+
/** Extra checks, in addition to the ones plugins register. */
|
|
20
|
+
checks?: Record<string, HealthCheck>;
|
|
21
|
+
/** Milliseconds before a check counts as failed. Defaults to 5000. */
|
|
22
|
+
timeout?: number;
|
|
23
|
+
}
|
|
24
|
+
export interface HealthCheckResult {
|
|
25
|
+
status: "up" | "down";
|
|
26
|
+
durationMs: number;
|
|
27
|
+
/** Why the check failed. Development only, since it can describe internals. */
|
|
28
|
+
error?: string;
|
|
29
|
+
}
|
|
30
|
+
export interface ReadinessReport {
|
|
31
|
+
status: "ok" | "error";
|
|
32
|
+
checks: Record<string, HealthCheckResult>;
|
|
33
|
+
}
|
|
34
|
+
/** Route config flag that makes global `useMiddlewares` skip a route. */
|
|
35
|
+
export declare const SKIP_GLOBAL_MIDDLEWARE = "meghSkipGlobalMiddleware";
|
|
36
|
+
/** Runs readiness checks and serves the health routes. */
|
|
37
|
+
export declare class HealthRegistry {
|
|
38
|
+
private readonly checks;
|
|
39
|
+
add(name: string, check: HealthCheck): void;
|
|
40
|
+
names(): string[];
|
|
41
|
+
/** Run every check concurrently. */
|
|
42
|
+
run(timeout?: number, exposeErrors?: boolean): Promise<ReadinessReport>;
|
|
43
|
+
/** Register the liveness and readiness routes. */
|
|
44
|
+
install(app: FastifyInstance, options: HealthOptions, isDevelopment: () => boolean): void;
|
|
45
|
+
}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.HealthRegistry = exports.SKIP_GLOBAL_MIDDLEWARE = void 0;
|
|
4
|
+
/** Route config flag that makes global `useMiddlewares` skip a route. */
|
|
5
|
+
exports.SKIP_GLOBAL_MIDDLEWARE = "meghSkipGlobalMiddleware";
|
|
6
|
+
/** Runs readiness checks and serves the health routes. */
|
|
7
|
+
class HealthRegistry {
|
|
8
|
+
checks = new Map();
|
|
9
|
+
add(name, check) {
|
|
10
|
+
if (typeof check !== "function") {
|
|
11
|
+
throw new TypeError(`[Megh] Health check "${name}" must be a function.`);
|
|
12
|
+
}
|
|
13
|
+
if (this.checks.has(name)) {
|
|
14
|
+
throw new Error(`[Megh] A health check named "${name}" is already registered.`);
|
|
15
|
+
}
|
|
16
|
+
this.checks.set(name, check);
|
|
17
|
+
}
|
|
18
|
+
names() {
|
|
19
|
+
return [...this.checks.keys()];
|
|
20
|
+
}
|
|
21
|
+
/** Run every check concurrently. */
|
|
22
|
+
async run(timeout = 5000, exposeErrors = false) {
|
|
23
|
+
const entries = await Promise.all([...this.checks].map(async ([name, check]) => {
|
|
24
|
+
const started = performance.now();
|
|
25
|
+
let error;
|
|
26
|
+
try {
|
|
27
|
+
const passed = await withTimeout(Promise.resolve().then(check), timeout);
|
|
28
|
+
if (passed === false)
|
|
29
|
+
error = new Error("check returned false");
|
|
30
|
+
}
|
|
31
|
+
catch (err) {
|
|
32
|
+
error = err;
|
|
33
|
+
}
|
|
34
|
+
const result = {
|
|
35
|
+
status: error === undefined ? "up" : "down",
|
|
36
|
+
durationMs: Math.round(performance.now() - started),
|
|
37
|
+
};
|
|
38
|
+
if (error !== undefined && exposeErrors) {
|
|
39
|
+
result.error = String(error?.message ?? error);
|
|
40
|
+
}
|
|
41
|
+
return [name, result];
|
|
42
|
+
}));
|
|
43
|
+
const checks = Object.fromEntries(entries);
|
|
44
|
+
const ok = entries.every(([, r]) => r.status === "up");
|
|
45
|
+
return { status: ok ? "ok" : "error", checks };
|
|
46
|
+
}
|
|
47
|
+
/** Register the liveness and readiness routes. */
|
|
48
|
+
install(app, options, isDevelopment) {
|
|
49
|
+
const timeout = options.timeout ?? 5000;
|
|
50
|
+
// Hidden from the OpenAPI document; not behind authentication, since
|
|
51
|
+
// they are registered on Fastify directly rather than through a controller.
|
|
52
|
+
const schema = { hide: true };
|
|
53
|
+
const config = { [exports.SKIP_GLOBAL_MIDDLEWARE]: true };
|
|
54
|
+
app.get(options.path ?? "/health", { schema, config }, async () => ({
|
|
55
|
+
status: "ok",
|
|
56
|
+
}));
|
|
57
|
+
app.get(options.readyPath ?? "/ready", { schema, config }, async (_req, reply) => {
|
|
58
|
+
const report = await this.run(timeout, isDevelopment());
|
|
59
|
+
return reply.code(report.status === "ok" ? 200 : 503).send(report);
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
exports.HealthRegistry = HealthRegistry;
|
|
64
|
+
function withTimeout(promise, ms) {
|
|
65
|
+
let timer;
|
|
66
|
+
return Promise.race([
|
|
67
|
+
promise,
|
|
68
|
+
new Promise((_, reject) => {
|
|
69
|
+
timer = setTimeout(() => reject(new Error(`timed out after ${ms}ms`)), ms);
|
|
70
|
+
timer.unref();
|
|
71
|
+
}),
|
|
72
|
+
]).finally(() => clearTimeout(timer));
|
|
73
|
+
}
|
|
74
|
+
//# sourceMappingURL=health.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"health.js","sourceRoot":"","sources":["../../src/observability/health.ts"],"names":[],"mappings":";;;AAsCA,yEAAyE;AAC5D,QAAA,sBAAsB,GAAG,0BAA0B,CAAC;AAEjE,0DAA0D;AAC1D,MAAa,cAAc;IACR,MAAM,GAAG,IAAI,GAAG,EAAuB,CAAC;IAEzD,GAAG,CAAC,IAAY,EAAE,KAAkB;QAClC,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YAChC,MAAM,IAAI,SAAS,CAAC,wBAAwB,IAAI,uBAAuB,CAAC,CAAC;QAC3E,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,gCAAgC,IAAI,0BAA0B,CAC/D,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK;QACH,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,oCAAoC;IACpC,KAAK,CAAC,GAAG,CAAC,OAAO,GAAG,IAAI,EAAE,YAAY,GAAG,KAAK;QAC5C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;YAC3C,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAClC,IAAI,KAAc,CAAC;YACnB,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,WAAW,CAC9B,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAC7B,OAAO,CACR,CAAC;gBACF,IAAI,MAAM,KAAK,KAAK;oBAAE,KAAK,GAAG,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAClE,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,KAAK,GAAG,GAAG,CAAC;YACd,CAAC;YACD,MAAM,MAAM,GAAsB;gBAChC,MAAM,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;gBAC3C,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC;aACpD,CAAC;YACF,IAAI,KAAK,KAAK,SAAS,IAAI,YAAY,EAAE,CAAC;gBACxC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAE,KAAa,EAAE,OAAO,IAAI,KAAK,CAAC,CAAC;YAC1D,CAAC;YACD,OAAO,CAAC,IAAI,EAAE,MAAM,CAAU,CAAC;QACjC,CAAC,CAAC,CACH,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC;QACvD,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IACjD,CAAC;IAED,kDAAkD;IAClD,OAAO,CACL,GAAoB,EACpB,OAAsB,EACtB,aAA4B;QAE5B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC;QACxC,qEAAqE;QACrE,4EAA4E;QAC5E,MAAM,MAAM,GAAG,EAAE,IAAI,EAAE,IAAI,EAAS,CAAC;QAErC,MAAM,MAAM,GAAG,EAAE,CAAC,8BAAsB,CAAC,EAAE,IAAI,EAAE,CAAC;QAElD,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,SAAS,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;YAClE,MAAM,EAAE,IAAI;SACb,CAAC,CAAC,CAAC;QAEJ,GAAG,CAAC,GAAG,CACL,OAAO,CAAC,SAAS,IAAI,QAAQ,EAC7B,EAAE,MAAM,EAAE,MAAM,EAAE,EAClB,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;YACpB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;YACxD,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrE,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AA3ED,wCA2EC;AAED,SAAS,WAAW,CAAI,OAAmB,EAAE,EAAU;IACrD,IAAI,KAAqB,CAAC;IAC1B,OAAO,OAAO,CAAC,IAAI,CAAC;QAClB,OAAO;QACP,IAAI,OAAO,CAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;YAC/B,KAAK,GAAG,UAAU,CAChB,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,EAClD,EAAE,CACH,CAAC;YACF,KAAK,CAAC,KAAK,EAAE,CAAC;QAChB,CAAC,CAAC;KACH,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AACxC,CAAC"}
|
|
@@ -14,6 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
exports.DEFAULT_REQUEST_ID_HEADER = exports.getRequestId = void 0;
|
|
17
18
|
__exportStar(require("./logger"), exports);
|
|
18
19
|
__exportStar(require("./cache"), exports);
|
|
20
|
+
var request_context_1 = require("./request-context");
|
|
21
|
+
Object.defineProperty(exports, "getRequestId", { enumerable: true, get: function () { return request_context_1.getRequestId; } });
|
|
22
|
+
Object.defineProperty(exports, "DEFAULT_REQUEST_ID_HEADER", { enumerable: true, get: function () { return request_context_1.DEFAULT_REQUEST_ID_HEADER; } });
|
|
23
|
+
__exportStar(require("./health"), exports);
|
|
19
24
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/observability/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/observability/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,0CAAwB;AACxB,qDAA4E;AAAnE,+GAAA,YAAY,OAAA;AAAE,4HAAA,yBAAyB,OAAA;AAEhD,2CAAyB"}
|
|
@@ -17,6 +17,7 @@ exports.LoggerService = void 0;
|
|
|
17
17
|
exports.buildLoggerOptions = buildLoggerOptions;
|
|
18
18
|
const pino_1 = __importDefault(require("pino"));
|
|
19
19
|
const decorators_1 = require("../common/decorators");
|
|
20
|
+
const request_context_1 = require("./request-context");
|
|
20
21
|
function isPinoPrettyInstalled() {
|
|
21
22
|
try {
|
|
22
23
|
require.resolve("pino-pretty", { paths: [process.cwd(), __dirname] });
|
|
@@ -26,6 +27,11 @@ function isPinoPrettyInstalled() {
|
|
|
26
27
|
return false;
|
|
27
28
|
}
|
|
28
29
|
}
|
|
30
|
+
/** Adds `reqId` to every log line written while a request is handled. */
|
|
31
|
+
function requestIdMixin() {
|
|
32
|
+
const reqId = (0, request_context_1.getRequestId)();
|
|
33
|
+
return reqId ? { reqId } : {};
|
|
34
|
+
}
|
|
29
35
|
/**
|
|
30
36
|
* The pino options Megh uses: structured JSON everywhere, except in
|
|
31
37
|
* development (`NODE_ENV === "development"`) when pino-pretty is installed.
|
|
@@ -35,9 +41,10 @@ function buildLoggerOptions(config = {}, env = process.env) {
|
|
|
35
41
|
const pretty = config.pretty ??
|
|
36
42
|
(env.NODE_ENV === "development" && isPinoPrettyInstalled());
|
|
37
43
|
if (!pretty)
|
|
38
|
-
return { level };
|
|
44
|
+
return { level, mixin: requestIdMixin };
|
|
39
45
|
return {
|
|
40
46
|
level,
|
|
47
|
+
mixin: requestIdMixin,
|
|
41
48
|
transport: {
|
|
42
49
|
target: "pino-pretty",
|
|
43
50
|
options: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/observability/logger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/observability/logger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAmCA,gDAsBC;AAzDD,gDAAwB;AACxB,qDAAkD;AAClD,uDAAiD;AAcjD,SAAS,qBAAqB;IAC5B,IAAI,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,yEAAyE;AACzE,SAAS,cAAc;IACrB,MAAM,KAAK,GAAG,IAAA,8BAAY,GAAE,CAAC;IAC7B,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAChC,SAAiD,EAAE,EACnD,MAAyB,OAAO,CAAC,GAAG;IAEpC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,GAAG,CAAC,SAAS,IAAI,MAAM,CAAC;IACtD,MAAM,MAAM,GACV,MAAM,CAAC,MAAM;QACb,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,IAAI,qBAAqB,EAAE,CAAC,CAAC;IAE9D,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;IAErD,OAAO;QACL,KAAK;QACL,KAAK,EAAE,cAAc;QACrB,SAAS,EAAE;YACT,MAAM,EAAE,aAAa;YACrB,OAAO,EAAE;gBACP,aAAa,EAAE,cAAc;gBAC7B,MAAM,EAAE,cAAc;aACvB;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AAEI,IAAM,aAAa,GAAnB,MAAM,aAAa;;IAChB,MAAM,CAAC,IAAI,CAA0B;IAE7C,sDAAsD;IACtD,MAAM,CAAC,OAAO;QACZ,IAAI,CAAC,eAAa,CAAC,IAAI;YAAE,eAAa,CAAC,IAAI,GAAG,eAAa,CAAC,MAAM,EAAE,CAAC;QACrE,OAAO,eAAa,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED,2FAA2F;IAC3F,MAAM,CAAC,SAAS,CAAC,SAAuB,EAAE;QACxC,eAAa,CAAC,IAAI,GAAG,eAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAClD,OAAO,eAAa,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED,2FAA2F;IAC3F,MAAM,CAAC,KAAK,CAAC,QAAuB;QAClC,OAAO,eAAa,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAEO,MAAM,CAAC,MAAM,CAAC,SAAuB,EAAE;QAC7C,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YAC7C,OAAO,IAAA,cAAI,EAAC,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,IAAA,cAAI,EAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAEO,MAAM,CAAc;IAE5B;QACE,IAAI,CAAC,MAAM,GAAG,eAAa,CAAC,OAAO,EAAE,CAAC;IACxC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,GAAS;QAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAS;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,GAAS;QAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAS;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAS;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAS;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAEO,KAAK,CAAC,KAAiB,EAAE,OAAe,EAAE,GAAS;QACzD,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;aAAM,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;CACF,CAAA;AAzEY,sCAAa;wBAAb,aAAa;IADzB,uBAAU;;GACE,aAAa,CAyEzB"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { FastifyInstance } from "fastify";
|
|
2
|
+
import type { IncomingMessage } from "http";
|
|
3
|
+
/** The default header that carries the request ID in and out. */
|
|
4
|
+
export declare const DEFAULT_REQUEST_ID_HEADER = "x-request-id";
|
|
5
|
+
/**
|
|
6
|
+
* The ID of the request being handled, or `undefined` outside a request.
|
|
7
|
+
* Works anywhere in the request's async call chain: services, repositories,
|
|
8
|
+
* event listeners.
|
|
9
|
+
*
|
|
10
|
+
* logger.info({ requestId: getRequestId() }, "charging card");
|
|
11
|
+
*/
|
|
12
|
+
export declare function getRequestId(): string | undefined;
|
|
13
|
+
/** Options for request IDs: `false` turns them off. */
|
|
14
|
+
export type RequestIdOptions = false | {
|
|
15
|
+
/** Header read from the request and set on the response. Defaults to `x-request-id`. */
|
|
16
|
+
header?: string;
|
|
17
|
+
/** Make an ID when the request has none. Defaults to `crypto.randomUUID`. */
|
|
18
|
+
generate?: () => string;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* A Fastify `genReqId` that reuses a safe incoming header (so an ID set by a
|
|
22
|
+
* proxy or the calling service carries through) or generates a new one.
|
|
23
|
+
*/
|
|
24
|
+
export declare function createRequestIdGenerator(header?: string, generate?: () => string): (req: IncomingMessage) => string;
|
|
25
|
+
/**
|
|
26
|
+
* Echo the request ID on the response and make it available through
|
|
27
|
+
* {@link getRequestId} for the rest of the request.
|
|
28
|
+
*/
|
|
29
|
+
export declare function installRequestContext(app: FastifyInstance, header?: string): void;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DEFAULT_REQUEST_ID_HEADER = void 0;
|
|
4
|
+
exports.getRequestId = getRequestId;
|
|
5
|
+
exports.createRequestIdGenerator = createRequestIdGenerator;
|
|
6
|
+
exports.installRequestContext = installRequestContext;
|
|
7
|
+
/**
|
|
8
|
+
* @copyright 2024
|
|
9
|
+
* @author Tareq Hossain
|
|
10
|
+
* @email xtrinsic96@gmail.com
|
|
11
|
+
* @url https://github.com/xtareq
|
|
12
|
+
*/
|
|
13
|
+
const async_hooks_1 = require("async_hooks");
|
|
14
|
+
const crypto_1 = require("crypto");
|
|
15
|
+
const storage = new async_hooks_1.AsyncLocalStorage();
|
|
16
|
+
/** The default header that carries the request ID in and out. */
|
|
17
|
+
exports.DEFAULT_REQUEST_ID_HEADER = "x-request-id";
|
|
18
|
+
/** Accept a client-sent ID only if it is short and log-safe. */
|
|
19
|
+
const SAFE_ID = /^[\w.:-]{1,128}$/;
|
|
20
|
+
/**
|
|
21
|
+
* The ID of the request being handled, or `undefined` outside a request.
|
|
22
|
+
* Works anywhere in the request's async call chain: services, repositories,
|
|
23
|
+
* event listeners.
|
|
24
|
+
*
|
|
25
|
+
* logger.info({ requestId: getRequestId() }, "charging card");
|
|
26
|
+
*/
|
|
27
|
+
function getRequestId() {
|
|
28
|
+
return storage.getStore()?.requestId;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* A Fastify `genReqId` that reuses a safe incoming header (so an ID set by a
|
|
32
|
+
* proxy or the calling service carries through) or generates a new one.
|
|
33
|
+
*/
|
|
34
|
+
function createRequestIdGenerator(header = exports.DEFAULT_REQUEST_ID_HEADER, generate = crypto_1.randomUUID) {
|
|
35
|
+
const name = header.toLowerCase();
|
|
36
|
+
return (req) => {
|
|
37
|
+
const incoming = req.headers[name];
|
|
38
|
+
const value = Array.isArray(incoming) ? incoming[0] : incoming;
|
|
39
|
+
return value && SAFE_ID.test(value) ? value : generate();
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Echo the request ID on the response and make it available through
|
|
44
|
+
* {@link getRequestId} for the rest of the request.
|
|
45
|
+
*/
|
|
46
|
+
function installRequestContext(app, header = exports.DEFAULT_REQUEST_ID_HEADER) {
|
|
47
|
+
// A callback hook with `run(…, done)`: everything Fastify does after
|
|
48
|
+
// `done()` (the remaining hooks, the handler) runs inside the store.
|
|
49
|
+
app.addHook("onRequest", (request, reply, done) => {
|
|
50
|
+
reply.header(header, request.id);
|
|
51
|
+
storage.run({ requestId: String(request.id) }, done);
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=request-context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"request-context.js","sourceRoot":"","sources":["../../src/observability/request-context.ts"],"names":[],"mappings":";;;AA8BA,oCAEC;AAgBD,4DAUC;AAMD,sDAUC;AA1ED;;;;;GAKG;AACH,6CAAgD;AAChD,mCAAoC;AAQpC,MAAM,OAAO,GAAG,IAAI,+BAAiB,EAAgB,CAAC;AAEtD,iEAAiE;AACpD,QAAA,yBAAyB,GAAG,cAAc,CAAC;AAExD,gEAAgE;AAChE,MAAM,OAAO,GAAG,kBAAkB,CAAC;AAEnC;;;;;;GAMG;AACH,SAAgB,YAAY;IAC1B,OAAO,OAAO,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC;AACvC,CAAC;AAYD;;;GAGG;AACH,SAAgB,wBAAwB,CACtC,SAAiB,iCAAyB,EAC1C,WAAyB,mBAAU;IAEnC,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IAClC,OAAO,CAAC,GAAG,EAAE,EAAE;QACb,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC/D,OAAO,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC3D,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CACnC,GAAoB,EACpB,SAAiB,iCAAyB;IAE1C,qEAAqE;IACrE,qEAAqE;IACrE,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAChD,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @copyright 2024
|
|
3
|
+
* @author Tareq Hossain
|
|
4
|
+
* @email xtrinsic96@gmail.com
|
|
5
|
+
* @url https://github.com/xtareq
|
|
6
|
+
*
|
|
7
|
+
* Internal: documenting `@Query()` parameters as OpenAPI query parameters.
|
|
8
|
+
*
|
|
9
|
+
* Megh validates query DTOs itself, so routes get no Fastify `querystring`
|
|
10
|
+
* schema (that would add a second validator with different errors). The
|
|
11
|
+
* parameters ride on the route schema under {@link QUERY_PARAMS_EXTENSION}
|
|
12
|
+
* and {@link applyQueryParamExtensions} moves them into place once the
|
|
13
|
+
* document is generated.
|
|
14
|
+
*/
|
|
15
|
+
import type { ParameterObject } from "./openapi";
|
|
16
|
+
export declare const QUERY_PARAMS_EXTENSION = "x-megh-query-parameters";
|
|
17
|
+
type QueryMeta = {
|
|
18
|
+
index: number;
|
|
19
|
+
key: string;
|
|
20
|
+
required?: boolean;
|
|
21
|
+
dataType?: unknown;
|
|
22
|
+
validatorClass?: boolean;
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* Query parameters for a route's `@Query()` metadata: a whole-query DTO
|
|
26
|
+
* (`@Query() q: Dto`) becomes one parameter per property, `@Query('key')`
|
|
27
|
+
* one parameter.
|
|
28
|
+
*/
|
|
29
|
+
export declare function buildQueryParameters(query: QueryMeta[]): ParameterObject[];
|
|
30
|
+
/**
|
|
31
|
+
* `@fastify/swagger` `transformObject` hook: add every route's
|
|
32
|
+
* {@link QUERY_PARAMS_EXTENSION} to the operation's `parameters`. A query
|
|
33
|
+
* parameter already documented (e.g. through `@OpenApi({ query })`) wins.
|
|
34
|
+
*/
|
|
35
|
+
export declare function applyQueryParamExtensions<T = any>(document: T): T;
|
|
36
|
+
export {};
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.QUERY_PARAMS_EXTENSION = void 0;
|
|
4
|
+
exports.buildQueryParameters = buildQueryParameters;
|
|
5
|
+
exports.applyQueryParamExtensions = applyQueryParamExtensions;
|
|
6
|
+
const swagger_schema_1 = require("./swagger-schema");
|
|
7
|
+
exports.QUERY_PARAMS_EXTENSION = "x-megh-query-parameters";
|
|
8
|
+
const PRIMITIVES = new Set(["string", "number", "integer", "boolean"]);
|
|
9
|
+
function isClass(value) {
|
|
10
|
+
return typeof value === "function" && !!value.prototype;
|
|
11
|
+
}
|
|
12
|
+
/** A property schema as a Parameter Object; `description`/`example` move up a level. */
|
|
13
|
+
function toParameter(name, schema, required) {
|
|
14
|
+
const { description, example, ...rest } = schema ?? {};
|
|
15
|
+
const param = { name, in: "query", required, schema: rest };
|
|
16
|
+
if (description !== undefined)
|
|
17
|
+
param.description = description;
|
|
18
|
+
if (example !== undefined)
|
|
19
|
+
param.example = example;
|
|
20
|
+
return param;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Query parameters for a route's `@Query()` metadata: a whole-query DTO
|
|
24
|
+
* (`@Query() q: Dto`) becomes one parameter per property, `@Query('key')`
|
|
25
|
+
* one parameter.
|
|
26
|
+
*/
|
|
27
|
+
function buildQueryParameters(query) {
|
|
28
|
+
const out = [];
|
|
29
|
+
const seen = new Set();
|
|
30
|
+
const add = (p) => {
|
|
31
|
+
if (seen.has(p.name))
|
|
32
|
+
return;
|
|
33
|
+
seen.add(p.name);
|
|
34
|
+
out.push(p);
|
|
35
|
+
};
|
|
36
|
+
// Parameter decorators run last to first; list them in signature order.
|
|
37
|
+
const ordered = [...query].sort((a, b) => a.index - b.index);
|
|
38
|
+
for (const q of ordered) {
|
|
39
|
+
const type = q.dataType;
|
|
40
|
+
if (q.key === "all") {
|
|
41
|
+
if (!q.validatorClass || !isClass(type))
|
|
42
|
+
continue;
|
|
43
|
+
const schema = (0, swagger_schema_1.generateClassSchema)(type, { inline: true });
|
|
44
|
+
const required = schema.required ?? [];
|
|
45
|
+
for (const [name, prop] of Object.entries(schema.properties ?? {}))
|
|
46
|
+
add(toParameter(name, prop, required.includes(name)));
|
|
47
|
+
continue;
|
|
48
|
+
}
|
|
49
|
+
let schema;
|
|
50
|
+
if (typeof type === "string" && PRIMITIVES.has(type))
|
|
51
|
+
schema = { type };
|
|
52
|
+
else if (type === "array")
|
|
53
|
+
schema = { type: "array", items: { type: "string" } };
|
|
54
|
+
else if (q.validatorClass && isClass(type))
|
|
55
|
+
schema = (0, swagger_schema_1.generateClassSchema)(type, { inline: true });
|
|
56
|
+
else
|
|
57
|
+
schema = { type: "string" };
|
|
58
|
+
const param = toParameter(q.key, schema, q.required ?? true);
|
|
59
|
+
if (schema.type === "object") {
|
|
60
|
+
param.style = "deepObject";
|
|
61
|
+
param.explode = true;
|
|
62
|
+
}
|
|
63
|
+
add(param);
|
|
64
|
+
}
|
|
65
|
+
return out;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* `@fastify/swagger` `transformObject` hook: add every route's
|
|
69
|
+
* {@link QUERY_PARAMS_EXTENSION} to the operation's `parameters`. A query
|
|
70
|
+
* parameter already documented (e.g. through `@OpenApi({ query })`) wins.
|
|
71
|
+
*/
|
|
72
|
+
function applyQueryParamExtensions(document) {
|
|
73
|
+
const paths = document?.paths;
|
|
74
|
+
if (!paths || typeof paths !== "object")
|
|
75
|
+
return document;
|
|
76
|
+
for (const pathItem of Object.values(paths)) {
|
|
77
|
+
if (!pathItem || typeof pathItem !== "object")
|
|
78
|
+
continue;
|
|
79
|
+
for (const operation of Object.values(pathItem)) {
|
|
80
|
+
if (!operation || typeof operation !== "object")
|
|
81
|
+
continue;
|
|
82
|
+
const ext = operation[exports.QUERY_PARAMS_EXTENSION];
|
|
83
|
+
if (!ext)
|
|
84
|
+
continue;
|
|
85
|
+
delete operation[exports.QUERY_PARAMS_EXTENSION];
|
|
86
|
+
const params = (operation.parameters ??= []);
|
|
87
|
+
const documented = new Set(params.filter((p) => p?.in === "query").map((p) => p.name));
|
|
88
|
+
for (const p of ext) {
|
|
89
|
+
if (!documented.has(p.name))
|
|
90
|
+
params.push(structuredClone(p));
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
return document;
|
|
95
|
+
}
|
|
96
|
+
//# sourceMappingURL=query-params.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"query-params.js","sourceRoot":"","sources":["../../src/openapi/query-params.ts"],"names":[],"mappings":";;;AAmDA,oDAsCC;AAOD,8DAuBC;AAxGD,qDAAuD;AAE1C,QAAA,sBAAsB,GAAG,yBAAyB,CAAC;AAUhE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAEvE,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,OAAO,KAAK,KAAK,UAAU,IAAI,CAAC,CAAE,KAAkB,CAAC,SAAS,CAAC;AACxE,CAAC;AAED,wFAAwF;AACxF,SAAS,WAAW,CAClB,IAAY,EACZ,MAAW,EACX,QAAiB;IAEjB,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;IACvD,MAAM,KAAK,GAAoB,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAC7E,IAAI,WAAW,KAAK,SAAS;QAAE,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IAC/D,IAAI,OAAO,KAAK,SAAS;QAAE,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;IACnD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,KAAkB;IACrD,MAAM,GAAG,GAAsB,EAAE,CAAC;IAClC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,GAAG,GAAG,CAAC,CAAkB,EAAE,EAAE;QACjC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;YAAE,OAAO;QAC7B,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACjB,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACd,CAAC,CAAC;IAEF,wEAAwE;IACxE,MAAM,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;IAC7D,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC;QACxB,IAAI,CAAC,CAAC,GAAG,KAAK,KAAK,EAAE,CAAC;YACpB,IAAI,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;gBAAE,SAAS;YAClD,MAAM,MAAM,GAAG,IAAA,oCAAmB,EAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3D,MAAM,QAAQ,GAAa,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;YACjD,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAM,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;gBACrE,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACxD,SAAS;QACX,CAAC;QAED,IAAI,MAAW,CAAC;QAChB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,MAAM,GAAG,EAAE,IAAI,EAAE,CAAC;aACnE,IAAI,IAAI,KAAK,OAAO;YACvB,MAAM,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC;aACnD,IAAI,CAAC,CAAC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;YACxC,MAAM,GAAG,IAAA,oCAAmB,EAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;;YAClD,MAAM,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAEjC,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC;QAC7D,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,KAAK,CAAC,KAAK,GAAG,YAAY,CAAC;YAC3B,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,CAAC;QACD,GAAG,CAAC,KAAK,CAAC,CAAC;IACb,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,SAAgB,yBAAyB,CAAU,QAAW;IAC5D,MAAM,KAAK,GAAI,QAAgB,EAAE,KAAK,CAAC;IACvC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAEzD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAM,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAAE,SAAS;QACxD,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAM,QAAQ,CAAC,EAAE,CAAC;YACrD,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ;gBAAE,SAAS;YAC1D,MAAM,GAAG,GACP,SAAS,CAAC,8BAAsB,CAAC,CAAC;YACpC,IAAI,CAAC,GAAG;gBAAE,SAAS;YACnB,OAAO,SAAS,CAAC,8BAAsB,CAAC,CAAC;YAEzC,MAAM,MAAM,GAAU,CAAC,SAAS,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC;YACpD,MAAM,UAAU,GAAG,IAAI,GAAG,CACxB,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAC3D,CAAC;YACF,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;gBACpB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;oBAAE,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}
|
|
@@ -15,6 +15,7 @@ exports.OpenApiResponse = OpenApiResponse;
|
|
|
15
15
|
const class_validator_1 = require("class-validator");
|
|
16
16
|
const container_1 = require("../common/container");
|
|
17
17
|
const schema_properties_1 = require("./schema-properties");
|
|
18
|
+
const metadata_1 = require("../validator/metadata");
|
|
18
19
|
// Decorator to add OpenAPI metadata to properties
|
|
19
20
|
function OpenApiProperty(options) {
|
|
20
21
|
return function (target, propertyKey) {
|
|
@@ -138,6 +139,17 @@ function nestedSchema(type, options, stack) {
|
|
|
138
139
|
}
|
|
139
140
|
return { $ref: `#/components/schemas/${name}` };
|
|
140
141
|
}
|
|
142
|
+
/** The class given with Megh's `@Type(() => X)`, if any. */
|
|
143
|
+
function getMeghType(classType, key) {
|
|
144
|
+
try {
|
|
145
|
+
const rule = (0, metadata_1.findTypeRule)(classType, key);
|
|
146
|
+
const t = rule?.typeFunction?.();
|
|
147
|
+
return typeof t === "function" ? t : undefined;
|
|
148
|
+
}
|
|
149
|
+
catch {
|
|
150
|
+
return undefined;
|
|
151
|
+
}
|
|
152
|
+
}
|
|
141
153
|
function collectPropertyNames(classType, validationMetadata) {
|
|
142
154
|
const names = new Set();
|
|
143
155
|
for (const key of (0, schema_properties_1.getRegisteredSchemaProperties)(classType))
|
|
@@ -148,6 +160,8 @@ function collectPropertyNames(classType, validationMetadata) {
|
|
|
148
160
|
}
|
|
149
161
|
for (const key of (0, schema_properties_1.getTransformerProperties)(classType))
|
|
150
162
|
names.add(key);
|
|
163
|
+
for (const key of (0, metadata_1.getTransformedProperties)(classType))
|
|
164
|
+
names.add(key);
|
|
151
165
|
names.delete("constructor");
|
|
152
166
|
names.delete("");
|
|
153
167
|
return [...names];
|
|
@@ -157,14 +171,19 @@ function buildClassSchema(classType, options, stack) {
|
|
|
157
171
|
if (!classType || !classType.prototype)
|
|
158
172
|
return schema;
|
|
159
173
|
const innerStack = new Set(stack).add(classType);
|
|
160
|
-
const validationMetadata =
|
|
174
|
+
const validationMetadata = [
|
|
175
|
+
...((0, class_validator_1.getMetadataStorage)().getTargetValidationMetadatas(classType, "", true, false) ?? []),
|
|
176
|
+
// Megh's decorators: same names and constraints as class-validator's.
|
|
177
|
+
...(0, metadata_1.getValidationRules)(classType),
|
|
178
|
+
];
|
|
161
179
|
const prototype = classType.prototype;
|
|
162
180
|
for (const propertyName of collectPropertyNames(classType, validationMetadata)) {
|
|
163
181
|
const openApiMeta = Reflect.getMetadata("property:openapi", prototype, propertyName);
|
|
164
182
|
if (openApiMeta?.exclude)
|
|
165
183
|
continue;
|
|
166
184
|
const propertyType = Reflect.getMetadata("design:type", prototype, propertyName);
|
|
167
|
-
const elementType = (0, schema_properties_1.getTransformerType)(classType, propertyName)
|
|
185
|
+
const elementType = (0, schema_properties_1.getTransformerType)(classType, propertyName) ??
|
|
186
|
+
getMeghType(classType, propertyName);
|
|
168
187
|
let swaggerProperty = {};
|
|
169
188
|
switch (propertyType) {
|
|
170
189
|
case String:
|