@meghjs/core 0.5.4 → 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 +32 -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 +149 -72
- 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 +233 -109
- 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/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 +8 -3
|
@@ -53,6 +53,25 @@ function exclude(obj, paths) {
|
|
|
53
53
|
}
|
|
54
54
|
return clone;
|
|
55
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* The scalar type a hint names. The router passes `"string"`, `"number"` and
|
|
58
|
+
* `"boolean"` (from `getDataType`); nested casting passes the constructors.
|
|
59
|
+
*/
|
|
60
|
+
function scalarHint(typeHint) {
|
|
61
|
+
if (typeHint === String || typeHint === "string")
|
|
62
|
+
return "string";
|
|
63
|
+
if (typeHint === Number || typeHint === "number")
|
|
64
|
+
return "number";
|
|
65
|
+
if (typeHint === Boolean || typeHint === "boolean")
|
|
66
|
+
return "boolean";
|
|
67
|
+
if (typeHint === Date)
|
|
68
|
+
return "date";
|
|
69
|
+
return undefined;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Cast a raw path or query value. With a scalar type hint, only that type is
|
|
73
|
+
* produced; without one, numbers, booleans, dates and JSON are inferred.
|
|
74
|
+
*/
|
|
56
75
|
function autoCast(value, typeHint, schema) {
|
|
57
76
|
if (value === null || value === undefined)
|
|
58
77
|
return value;
|
|
@@ -83,15 +102,34 @@ function autoCast(value, typeHint, schema) {
|
|
|
83
102
|
}
|
|
84
103
|
if (typeof value !== "string")
|
|
85
104
|
return value;
|
|
105
|
+
// A declared scalar type wins over guessing. Values that don't fit are
|
|
106
|
+
// returned as-is so the validator can reject them.
|
|
107
|
+
const scalar = scalarHint(typeHint);
|
|
108
|
+
if (scalar === "string")
|
|
109
|
+
return value;
|
|
86
110
|
const trimmed = value.trim();
|
|
87
|
-
if (
|
|
111
|
+
if (scalar === "number") {
|
|
112
|
+
const n = trimmed === "" ? NaN : Number(trimmed);
|
|
113
|
+
return Number.isNaN(n) ? value : n;
|
|
114
|
+
}
|
|
115
|
+
if (scalar === "boolean") {
|
|
116
|
+
const lower = trimmed.toLowerCase();
|
|
117
|
+
if (lower === "true" || lower === "1")
|
|
118
|
+
return true;
|
|
119
|
+
if (lower === "false" || lower === "0")
|
|
120
|
+
return false;
|
|
121
|
+
return value;
|
|
122
|
+
}
|
|
123
|
+
if (scalar === "date") {
|
|
124
|
+
const d = new Date(trimmed);
|
|
125
|
+
return Number.isNaN(d.getTime()) ? value : d;
|
|
126
|
+
}
|
|
127
|
+
if (trimmed.toLowerCase() === "true")
|
|
88
128
|
return true;
|
|
89
129
|
if (trimmed.toLowerCase() === "false")
|
|
90
130
|
return false;
|
|
91
|
-
if (
|
|
92
|
-
|
|
93
|
-
if (!isNaN(n))
|
|
94
|
-
return n;
|
|
131
|
+
if (trimmed !== "" && !isNaN(Number(trimmed))) {
|
|
132
|
+
return Number(trimmed);
|
|
95
133
|
}
|
|
96
134
|
if ((trimmed.startsWith("{") && trimmed.endsWith("}")) ||
|
|
97
135
|
(trimmed.startsWith("[") && trimmed.endsWith("]"))) {
|
|
@@ -103,8 +141,7 @@ function autoCast(value, typeHint, schema) {
|
|
|
103
141
|
return trimmed;
|
|
104
142
|
}
|
|
105
143
|
}
|
|
106
|
-
if (
|
|
107
|
-
/^\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2})?/.test(trimmed)) {
|
|
144
|
+
if (/^\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2})?/.test(trimmed)) {
|
|
108
145
|
const d = new Date(trimmed);
|
|
109
146
|
if (!isNaN(d.getTime()))
|
|
110
147
|
return d;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"object-utils.js","sourceRoot":"","sources":["../../../src/common/utils/object-utils.ts"],"names":[],"mappings":";;AASA,oBAwBC;AAED,0BAsBC;
|
|
1
|
+
{"version":3,"file":"object-utils.js","sourceRoot":"","sources":["../../../src/common/utils/object-utils.ts"],"names":[],"mappings":";;AASA,oBAwBC;AAED,0BAsBC;AAoBD,4BAiFC;AAKD,gDAuDC;AAED,8EAQC;AAED,4BAMC;AAED,wCAOC;AArPD;;;;;GAKG;AACH,yDAAqE;AAGrE,SAAgB,IAAI,CAAmB,GAAM,EAAE,KAAe;IAC5D,MAAM,MAAM,GAAQ,EAAE,CAAC;IAEvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,MAAM,GAAQ,GAAG,CAAC;QACtB,IAAI,MAAM,GAAQ,MAAM,CAAC;QAEzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAEpB,IAAI,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC;gBAAE,MAAM;YAE5B,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBACrB,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;gBAChC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,OAAO,CACrB,GAAY,EACZ,KAAe;IAEf,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAe,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,KAAK,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,0BAA0B;IAC9D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,MAAM,GAAQ,KAAK,CAAC;QAExB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC;gBAAE,MAAM;YAChC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;QAED,OAAO,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAID;;;GAGG;AACH,SAAS,UAAU,CAAC,QAAa;IAC/B,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAClE,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAClE,IAAI,QAAQ,KAAK,OAAO,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACrE,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IACrC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CAAC,KAAU,EAAE,QAAc,EAAE,MAAY;IAC/D,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,EAAE,CAAC;QAC1D,MAAM,MAAM,GAAwB,EAAE,CAAC;QACvC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,IAAI,SAAS,GAAQ,SAAS,CAAC;YAE/B,IAAI,MAAM,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;gBACpC,MAAM,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACtC,SAAS;oBACP,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,QAAQ;wBAC/B,CAAC,CAAC,MAAM;wBACR,CAAC,CAAC,CAAC,KAAK,SAAS;4BACf,CAAC,CAAC,OAAO;4BACT,CAAC,CAAC,CAAC,KAAK,OAAO;gCACb,CAAC,CAAC,KAAK;gCACP,CAAC,CAAC,CAAC,KAAK,QAAQ;oCACd,CAAC,CAAC,MAAM;oCACR,CAAC,CAAC,MAAM,CAAC;YACrB,CAAC;YAED,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5C,uEAAuE;IACvE,mDAAmD;IACnD,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;IACpC,IAAI,MAAM,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAEtC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAE7B,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACjD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACpC,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,GAAG;YAAE,OAAO,IAAI,CAAC;QACnD,IAAI,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,GAAG;YAAE,OAAO,KAAK,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,OAAO,CAAC,WAAW,EAAE,KAAK,MAAM;QAAE,OAAO,IAAI,CAAC;IAClD,IAAI,OAAO,CAAC,WAAW,EAAE,KAAK,OAAO;QAAE,OAAO,KAAK,CAAC;IAEpD,IAAI,OAAO,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAC9C,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;IAED,IACE,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAClD,CAAC;QACD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnC,OAAO,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC5C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IAED,IAAI,sCAAsC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAAE,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAChC,KAA0B;IAE1B,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,MAAM,OAAO,GAAG,CAAC,GAAQ,EAAE,IAAc,EAAE,KAAU,EAAE,EAAE;QACvD,IAAI,OAAO,GAAG,GAAG,CAAC;QAElB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAE5B,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;oBACf,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;wBAAE,OAAO,GAAG,EAAE,CAAC;oBAC1C,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACtB,CAAC;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;oBACvC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC3B,CAAC;qBAAM,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;oBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBACvB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBAClB,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,KAAK,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnE,CAAC;gBACD,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEF,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,MAAM,KAAK,GAAG,oBAAoB,CAAC;QACnC,IAAI,KAA6B,CAAC;QAElC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YAC7C,IAAI,KAAK,CAAC,CAAC,CAAC;gBAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;iBAC7B,IAAI,KAAK,CAAC,CAAC,CAAC;gBAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnC,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAAE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;;oBAC5D,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;YAC5B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,iCAAiC,CAC/C,QAAqB,EACrB,KAAa;IAEb,OAAO,IAAA,mCAAe,EAAC,IAAA,mCAAe,EAAC,QAAQ,EAAE,KAAK,CAAC,EAAE;QACvD,uBAAuB,EAAE,IAAI;QAC7B,iBAAiB,EAAE,IAAI;KACxB,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,QAAQ,CAAC,KAAa;IACpC,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAgB,cAAc,CAAC,KAAa,EAAE,QAAqB;IACjE,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACtC,OAAO,IAAA,mCAAe,EAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}
|
|
@@ -25,3 +25,10 @@ export declare function randomFilename(ext: string): string;
|
|
|
25
25
|
* the RFC 5987 `filename*` parameter.
|
|
26
26
|
*/
|
|
27
27
|
export declare function contentDisposition(filename: string): string;
|
|
28
|
+
/**
|
|
29
|
+
* Absolute directory for a project-relative source path such as
|
|
30
|
+
* `src/controllers`. Outside ts-node the compiled output is read instead, so
|
|
31
|
+
* a leading `src` segment becomes `dist`. Only that segment changes: a `src`
|
|
32
|
+
* elsewhere in the absolute path (`/home/me/src/app`) is left alone.
|
|
33
|
+
*/
|
|
34
|
+
export declare function resolveSourceDir(dir: string, isTsNode: boolean): string;
|
|
@@ -9,6 +9,7 @@ exports.isSafeFilename = isSafeFilename;
|
|
|
9
9
|
exports.fileExtension = fileExtension;
|
|
10
10
|
exports.randomFilename = randomFilename;
|
|
11
11
|
exports.contentDisposition = contentDisposition;
|
|
12
|
+
exports.resolveSourceDir = resolveSourceDir;
|
|
12
13
|
/**
|
|
13
14
|
* @copyright 2024
|
|
14
15
|
* @author Tareq Hossain
|
|
@@ -103,4 +104,18 @@ function contentDisposition(filename) {
|
|
|
103
104
|
const encoded = encodeURIComponent(name).replace(/['()*]/g, (c) => "%" + c.charCodeAt(0).toString(16).toUpperCase());
|
|
104
105
|
return `attachment; filename="${ascii}"; filename*=UTF-8''${encoded}`;
|
|
105
106
|
}
|
|
107
|
+
/**
|
|
108
|
+
* Absolute directory for a project-relative source path such as
|
|
109
|
+
* `src/controllers`. Outside ts-node the compiled output is read instead, so
|
|
110
|
+
* a leading `src` segment becomes `dist`. Only that segment changes: a `src`
|
|
111
|
+
* elsewhere in the absolute path (`/home/me/src/app`) is left alone.
|
|
112
|
+
*/
|
|
113
|
+
function resolveSourceDir(dir, isTsNode) {
|
|
114
|
+
if (isTsNode || path_1.default.isAbsolute(dir))
|
|
115
|
+
return path_1.default.resolve(process.cwd(), dir);
|
|
116
|
+
const segments = path_1.default.normalize(dir).split(path_1.default.sep);
|
|
117
|
+
if (segments[0] === "src")
|
|
118
|
+
segments[0] = "dist";
|
|
119
|
+
return path_1.default.join(process.cwd(), ...segments);
|
|
120
|
+
}
|
|
106
121
|
//# sourceMappingURL=path-utils.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"path-utils.js","sourceRoot":"","sources":["../../../src/common/utils/path-utils.ts"],"names":[],"mappings":";;;;;;AA8CA,sCAcC;AAMD,wCAUC;AAGD,sCAEC;AAGD,wCAEC;AAOD,gDAeC;
|
|
1
|
+
{"version":3,"file":"path-utils.js","sourceRoot":"","sources":["../../../src/common/utils/path-utils.ts"],"names":[],"mappings":";;;;;;AA8CA,sCAcC;AAMD,wCAUC;AAGD,sCAEC;AAGD,wCAEC;AAOD,gDAeC;AAQD,4CAKC;AAzHD;;;;;GAKG;AACH,gDAAwB;AACxB,mCAAoC;AAEpC;;;;GAIG;AACU,QAAA,iCAAiC,GAAsB;IAClE,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,OAAO;IACP,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;CACP,CAAC;AAEF;;;;GAIG;AACH,SAAgB,aAAa,CAC3B,OAAe,EACf,MAAc,EACd,SAAS,GAAG,KAAK;IAEjB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACrE,MAAM,IAAI,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,IAAI,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxC,MAAM,GAAG,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACtC,IAAI,GAAG,KAAK,EAAE;QAAE,OAAO,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/C,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,cAAI,CAAC,GAAG,CAAC,IAAI,cAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5E,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,SAAgB,cAAc,CAAC,QAAiB;IAC9C,OAAO,CACL,OAAO,QAAQ,KAAK,QAAQ;QAC5B,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE;QACtB,QAAQ,KAAK,GAAG;QAChB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;QACxB,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC;QACvB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;QACxB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CACzB,CAAC;AACJ,CAAC;AAED,6EAA6E;AAC7E,SAAgB,aAAa,CAAC,QAAgB;IAC5C,OAAO,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;AAC9C,CAAC;AAED,0DAA0D;AAC1D,SAAgB,cAAc,CAAC,GAAW;IACxC,OAAO,IAAA,mBAAU,GAAE,GAAG,GAAG,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,QAAgB;IACjD,MAAM,IAAI,GACR,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;SACnB,KAAK,CAAC,QAAQ,CAAC;SACf,GAAG,EAAE,IAAI,MAAM,CAAC;IACrB,MAAM,KAAK,GACT,IAAI;SACD,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC;SAC7B,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,IAAI,EAAE,IAAI,MAAM,CAAC;IACtB,MAAM,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,CAC9C,SAAS,EACT,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CACxD,CAAC;IACF,OAAO,yBAAyB,KAAK,uBAAuB,OAAO,EAAE,CAAC;AACxE,CAAC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,GAAW,EAAE,QAAiB;IAC7D,IAAI,QAAQ,IAAI,cAAI,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC;IAC9E,MAAM,QAAQ,GAAG,cAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,cAAI,CAAC,GAAG,CAAC,CAAC;IACrD,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,KAAK;QAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;IAChD,OAAO,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,QAAQ,CAAC,CAAC;AAC/C,CAAC"}
|
|
@@ -20,6 +20,8 @@ export declare class Environment {
|
|
|
20
20
|
* @returns A dictionary of merged environment variables.
|
|
21
21
|
*/
|
|
22
22
|
private parseEnvFile;
|
|
23
|
+
/** Forget the cached `.env` contents so the next read loads the file again. */
|
|
24
|
+
static reload(): void;
|
|
23
25
|
/**
|
|
24
26
|
* Retrieves the value of the specified environment variable.
|
|
25
27
|
*
|
|
@@ -54,7 +54,13 @@ const path_1 = __importDefault(require("path"));
|
|
|
54
54
|
const fs_1 = __importStar(require("fs"));
|
|
55
55
|
const di_1 = require("../di");
|
|
56
56
|
const system_exception_1 = require("../common/exceptions/system-exception");
|
|
57
|
-
|
|
57
|
+
// Load `.env` into process.env on import, so module-level code can read it.
|
|
58
|
+
// Set MEGH_DOTENV=false to skip this and manage the environment yourself.
|
|
59
|
+
if (process.env.MEGH_DOTENV !== "false") {
|
|
60
|
+
dotenv_1.default.config({ path: path_1.default.join(process.cwd(), ".env"), quiet: true });
|
|
61
|
+
}
|
|
62
|
+
/** Parsed `.env` files by path. Read once; see `Environment.reload()`. */
|
|
63
|
+
const fileCache = new Map();
|
|
58
64
|
/**
|
|
59
65
|
* @class Environment
|
|
60
66
|
* @description A service class to manage access to environment variables.
|
|
@@ -71,19 +77,24 @@ let Environment = class Environment {
|
|
|
71
77
|
* @returns A dictionary of merged environment variables.
|
|
72
78
|
*/
|
|
73
79
|
parseEnvFile(filePath) {
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
80
|
+
if (!fileCache.has(filePath)) {
|
|
81
|
+
try {
|
|
82
|
+
fileCache.set(filePath, (0, fs_1.existsSync)(filePath)
|
|
83
|
+
? dotenv_1.default.parse(fs_1.default.readFileSync(filePath, "utf8"))
|
|
84
|
+
: {});
|
|
85
|
+
}
|
|
86
|
+
catch (error) {
|
|
87
|
+
console.error(`Error parsing .env file: ${error}`);
|
|
88
|
+
fileCache.set(filePath, null);
|
|
78
89
|
}
|
|
79
|
-
const fileContent = fs_1.default.readFileSync(filePath, "utf8");
|
|
80
|
-
const parsedEnv = dotenv_1.default.parse(fileContent);
|
|
81
|
-
return { ...parsedEnv, ...process.env };
|
|
82
|
-
}
|
|
83
|
-
catch (error) {
|
|
84
|
-
console.error(`Error parsing .env file: ${error}`);
|
|
85
|
-
return {};
|
|
86
90
|
}
|
|
91
|
+
const parsed = fileCache.get(filePath);
|
|
92
|
+
// process.env is read on every call, so runtime changes still show.
|
|
93
|
+
return parsed === null ? {} : { ...parsed, ...process.env };
|
|
94
|
+
}
|
|
95
|
+
/** Forget the cached `.env` contents so the next read loads the file again. */
|
|
96
|
+
static reload() {
|
|
97
|
+
fileCache.clear();
|
|
87
98
|
}
|
|
88
99
|
/**
|
|
89
100
|
* Retrieves the value of the specified environment variable.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"environment-variables.js","sourceRoot":"","sources":["../../src/config/environment-variables.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,oDAA4B;AAC5B,gDAAwB;AACxB,yCAAoC;AACpC,8BAAmC;AACnC,4EAG+C;AAE/C,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"environment-variables.js","sourceRoot":"","sources":["../../src/config/environment-variables.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,oDAA4B;AAC5B,gDAAwB;AACxB,yCAAoC;AACpC,8BAAmC;AACnC,4EAG+C;AAE/C,4EAA4E;AAC5E,0EAA0E;AAC1E,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,OAAO,EAAE,CAAC;IACxC,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACzE,CAAC;AAED,0EAA0E;AAC1E,MAAM,SAAS,GAAG,IAAI,GAAG,EAAyC,CAAC;AACnE;;;;;GAKG;AAEI,IAAM,WAAW,GAAjB,MAAM,WAAW;IACtB;;;;;;;OAOG;IACK,YAAY,CAAC,QAAgB;QACnC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACH,SAAS,CAAC,GAAG,CACX,QAAQ,EACR,IAAA,eAAU,EAAC,QAAQ,CAAC;oBAClB,CAAC,CAAC,gBAAM,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBACjD,CAAC,CAAC,EAAE,CACP,CAAC;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,4BAA4B,KAAK,EAAE,CAAC,CAAC;gBACnD,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QACD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACvC,oEAAoE;QACpE,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC9D,CAAC;IAED,+EAA+E;IAC/E,MAAM,CAAC,MAAM;QACX,SAAS,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAU,GAAW;QACtB,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;QACtE,OAAO,SAAS,CAAC,GAAG,CAAM,CAAC;IAC7B,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CAAU,GAAW;QAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,8CAA2B,CAAC,GAAG,CAAC,CAAC;QAC7C,CAAC;QACD,OAAO,SAAS,CAAC,GAAG,CAAM,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,MAAM;QACJ,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;QACtE,OAAO,SAAc,CAAC;IACxB,CAAC;CACF,CAAA;AAzEY,kCAAW;sBAAX,WAAW;IADvB,IAAA,eAAU,GAAE;GACA,WAAW,CAyEvB"}
|
|
@@ -5,11 +5,13 @@
|
|
|
5
5
|
* @url https://github.com/xtareq
|
|
6
6
|
*/
|
|
7
7
|
import { FastifyInstance } from "fastify";
|
|
8
|
-
import { IMeghApplication, MeghApplicationOptions, CorsOptions, GlobalOptions, CacheOptions, LifecycleHook } from "./interfaces";
|
|
8
|
+
import { IMeghApplication, MeghApplicationOptions, CorsOptions, GlobalOptions, CacheOptions, LifecycleHook, RunOptions } from "./interfaces";
|
|
9
|
+
import { ErrorLogger, ExceptionFilterLike, ErrorHandlerFunction } from "../errors";
|
|
9
10
|
import { Constructor } from "../common/helpers";
|
|
10
11
|
import { OpenApiUiOptions } from "../openapi/openapi";
|
|
11
12
|
import { MeghMiddleware } from "../http/middleware";
|
|
12
13
|
import { AutoControllerOptions } from "./types";
|
|
14
|
+
import { HealthCheck, HealthOptions } from "../observability/health";
|
|
13
15
|
import { MeghConfig } from "../config/config";
|
|
14
16
|
import { MeghAuthentication } from "../security/authentication";
|
|
15
17
|
export declare class MeghApplication implements IMeghApplication {
|
|
@@ -32,7 +34,11 @@ export declare class MeghApplication implements IMeghApplication {
|
|
|
32
34
|
private _workers;
|
|
33
35
|
private lifecycleHooks;
|
|
34
36
|
private closing;
|
|
37
|
+
private signalHandler;
|
|
35
38
|
private pluginNames;
|
|
39
|
+
private usesCache;
|
|
40
|
+
private health;
|
|
41
|
+
private errorHandler;
|
|
36
42
|
private constructor();
|
|
37
43
|
/** Names of the registered plugins, in registration order. */
|
|
38
44
|
getPlugins(): readonly string[];
|
|
@@ -72,6 +78,50 @@ export declare class MeghApplication implements IMeghApplication {
|
|
|
72
78
|
* @Authorized({ name: "oauth" }) // uses the "oauth" handler
|
|
73
79
|
*/
|
|
74
80
|
useAuthorization(authorization: Constructor<any> | Record<string, Constructor<any>>): this;
|
|
81
|
+
/**
|
|
82
|
+
* Register global exception filters. They run in order, after any
|
|
83
|
+
* `@UseFilters` on the route or controller, and before Megh's default
|
|
84
|
+
* error response.
|
|
85
|
+
*
|
|
86
|
+
* app.useExceptionFilters([EntityNotFoundFilter, ProblemJsonFilter])
|
|
87
|
+
*
|
|
88
|
+
* Each entry can be a filter class (resolved through DI), a filter
|
|
89
|
+
* instance or a function `(error, ctx) => ...`.
|
|
90
|
+
*
|
|
91
|
+
* @see ExceptionFilter
|
|
92
|
+
*/
|
|
93
|
+
useExceptionFilters(filters: ExceptionFilterLike | ExceptionFilterLike[]): this;
|
|
94
|
+
/**
|
|
95
|
+
* Register a function that handles request errors. It is a global filter
|
|
96
|
+
* that sees every error: return a body to send it, return an `Error` to
|
|
97
|
+
* hand it on, or return nothing to fall back to the default response.
|
|
98
|
+
*
|
|
99
|
+
* app.useErrorHandler((error, { response }) => ({
|
|
100
|
+
* ok: false,
|
|
101
|
+
* message: response.body.message,
|
|
102
|
+
* }))
|
|
103
|
+
*/
|
|
104
|
+
useErrorHandler(handler: ErrorHandlerFunction): this;
|
|
105
|
+
/**
|
|
106
|
+
* Replace how errors answered with the default response are logged, or
|
|
107
|
+
* pass `false` to stop logging them.
|
|
108
|
+
*/
|
|
109
|
+
useErrorLogger(logger: ErrorLogger | false): this;
|
|
110
|
+
/** Install the error and not-found handlers on the Fastify instance. @internal */
|
|
111
|
+
installErrorHandling(): void;
|
|
112
|
+
/**
|
|
113
|
+
* Serve health routes: `GET /health` (liveness, always 200) and
|
|
114
|
+
* `GET /ready` (readiness: runs every health check, 503 if one fails).
|
|
115
|
+
* Plugins register their own checks, such as Megh ORM's `database`.
|
|
116
|
+
*
|
|
117
|
+
* app.useHealth({ checks: { redis: () => redis.ping() } })
|
|
118
|
+
*/
|
|
119
|
+
useHealth(options?: HealthOptions): this;
|
|
120
|
+
/**
|
|
121
|
+
* Add a readiness check, reported by `GET /ready` once `useHealth()` is on.
|
|
122
|
+
* It passes unless it throws, rejects or returns `false`.
|
|
123
|
+
*/
|
|
124
|
+
addHealthCheck(name: string, check: HealthCheck): this;
|
|
75
125
|
useSerialization(): this;
|
|
76
126
|
/**
|
|
77
127
|
* Register scheduled task classes.
|
|
@@ -117,19 +167,43 @@ export declare class MeghApplication implements IMeghApplication {
|
|
|
117
167
|
private _mapFeatures;
|
|
118
168
|
private handleSocket;
|
|
119
169
|
mapGet<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
|
|
120
|
-
useMiddleware:
|
|
170
|
+
useMiddleware: (middlewares: MeghMiddleware | Constructor<MeghMiddleware> | (MeghMiddleware | Constructor<MeghMiddleware>)[]) => /*elided*/ any;
|
|
171
|
+
authorized: (options?: string | {
|
|
172
|
+
[key: string]: unknown;
|
|
173
|
+
name?: string;
|
|
174
|
+
} | undefined) => /*elided*/ any;
|
|
121
175
|
useOpenApi: (options: import("../openapi/openapi").OpenApiOptions) => /*elided*/ any;
|
|
122
176
|
};
|
|
123
177
|
mapPost<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
|
|
124
|
-
useMiddleware:
|
|
178
|
+
useMiddleware: (middlewares: MeghMiddleware | Constructor<MeghMiddleware> | (MeghMiddleware | Constructor<MeghMiddleware>)[]) => /*elided*/ any;
|
|
179
|
+
authorized: (options?: string | {
|
|
180
|
+
[key: string]: unknown;
|
|
181
|
+
name?: string;
|
|
182
|
+
} | undefined) => /*elided*/ any;
|
|
125
183
|
useOpenApi: (options: import("../openapi/openapi").OpenApiOptions) => /*elided*/ any;
|
|
126
184
|
};
|
|
127
185
|
mapPut<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
|
|
128
|
-
useMiddleware:
|
|
186
|
+
useMiddleware: (middlewares: MeghMiddleware | Constructor<MeghMiddleware> | (MeghMiddleware | Constructor<MeghMiddleware>)[]) => /*elided*/ any;
|
|
187
|
+
authorized: (options?: string | {
|
|
188
|
+
[key: string]: unknown;
|
|
189
|
+
name?: string;
|
|
190
|
+
} | undefined) => /*elided*/ any;
|
|
191
|
+
useOpenApi: (options: import("../openapi/openapi").OpenApiOptions) => /*elided*/ any;
|
|
192
|
+
};
|
|
193
|
+
mapPatch<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
|
|
194
|
+
useMiddleware: (middlewares: MeghMiddleware | Constructor<MeghMiddleware> | (MeghMiddleware | Constructor<MeghMiddleware>)[]) => /*elided*/ any;
|
|
195
|
+
authorized: (options?: string | {
|
|
196
|
+
[key: string]: unknown;
|
|
197
|
+
name?: string;
|
|
198
|
+
} | undefined) => /*elided*/ any;
|
|
129
199
|
useOpenApi: (options: import("../openapi/openapi").OpenApiOptions) => /*elided*/ any;
|
|
130
200
|
};
|
|
131
201
|
mapDelete<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
|
|
132
|
-
useMiddleware:
|
|
202
|
+
useMiddleware: (middlewares: MeghMiddleware | Constructor<MeghMiddleware> | (MeghMiddleware | Constructor<MeghMiddleware>)[]) => /*elided*/ any;
|
|
203
|
+
authorized: (options?: string | {
|
|
204
|
+
[key: string]: unknown;
|
|
205
|
+
name?: string;
|
|
206
|
+
} | undefined) => /*elided*/ any;
|
|
133
207
|
useOpenApi: (options: import("../openapi/openapi").OpenApiOptions) => /*elided*/ any;
|
|
134
208
|
};
|
|
135
209
|
/**
|
|
@@ -155,5 +229,14 @@ export declare class MeghApplication implements IMeghApplication {
|
|
|
155
229
|
private assertNotStarted;
|
|
156
230
|
private runHooks;
|
|
157
231
|
private _autoSchedulerTasks;
|
|
158
|
-
|
|
232
|
+
/**
|
|
233
|
+
* Start the server.
|
|
234
|
+
*
|
|
235
|
+
* await app.run(3000)
|
|
236
|
+
* await app.run(3000, { host: "127.0.0.1" })
|
|
237
|
+
*
|
|
238
|
+
* The host defaults to the `HOST` environment variable, else `0.0.0.0`
|
|
239
|
+
* so the app is reachable inside containers.
|
|
240
|
+
*/
|
|
241
|
+
run(port?: number, options?: RunOptions | CallableFunction): Promise<void>;
|
|
159
242
|
}
|