@expressots/core 1.8.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/lib/CHANGELOG.md +141 -134
  2. package/lib/cjs/application/application.js +3 -2
  3. package/lib/cjs/common/color-service.provider.js +46 -0
  4. package/lib/cjs/common/package-resolver.provider.js +35 -0
  5. package/lib/cjs/console/console.js +10 -33
  6. package/lib/cjs/controller/base-controller.js +0 -2
  7. package/lib/cjs/error/app-error.js +26 -0
  8. package/lib/cjs/error/error-handler-middleware.js +16 -5
  9. package/lib/cjs/error/index.js +3 -1
  10. package/lib/cjs/error/report.js +17 -24
  11. package/lib/cjs/index.js +1 -2
  12. package/lib/cjs/provider/dto-validator/dto-validator.provider.js +62 -0
  13. package/lib/cjs/{environment/env-validator.js → provider/environment/env-validator.provider.js} +16 -10
  14. package/lib/cjs/provider/index.js +11 -0
  15. package/lib/cjs/provider/logger/logger-service.js +114 -0
  16. package/lib/cjs/provider/provider-service.js +36 -0
  17. package/lib/cjs/types/application/application.d.ts.map +1 -1
  18. package/lib/cjs/types/common/color-service.provider.d.ts +30 -0
  19. package/lib/cjs/types/common/color-service.provider.d.ts.map +1 -0
  20. package/lib/cjs/types/common/package-resolver.provider.d.ts +9 -0
  21. package/lib/cjs/types/common/package-resolver.provider.d.ts.map +1 -0
  22. package/lib/cjs/types/console/console.d.ts +1 -1
  23. package/lib/cjs/types/console/console.d.ts.map +1 -1
  24. package/lib/cjs/types/controller/base-controller.d.ts.map +1 -1
  25. package/lib/cjs/types/error/app-error.d.ts +30 -0
  26. package/lib/cjs/types/error/app-error.d.ts.map +1 -0
  27. package/lib/cjs/types/error/error-handler-middleware.d.ts +3 -4
  28. package/lib/cjs/types/error/error-handler-middleware.d.ts.map +1 -1
  29. package/lib/cjs/types/error/index.d.ts +1 -0
  30. package/lib/cjs/types/error/index.d.ts.map +1 -1
  31. package/lib/cjs/types/error/report.d.ts +7 -11
  32. package/lib/cjs/types/error/report.d.ts.map +1 -1
  33. package/lib/cjs/types/index.d.ts +1 -2
  34. package/lib/cjs/types/index.d.ts.map +1 -1
  35. package/lib/cjs/types/provider/dto-validator/dto-validator.provider.d.ts +12 -0
  36. package/lib/cjs/types/provider/dto-validator/dto-validator.provider.d.ts.map +1 -0
  37. package/lib/cjs/types/{environment/env-validator.d.ts → provider/environment/env-validator.provider.d.ts} +7 -4
  38. package/lib/cjs/types/provider/environment/env-validator.provider.d.ts.map +1 -0
  39. package/lib/cjs/types/provider/index.d.ts +5 -0
  40. package/lib/cjs/types/provider/index.d.ts.map +1 -0
  41. package/lib/cjs/types/provider/logger/logger-service.d.ts +50 -0
  42. package/lib/cjs/types/provider/logger/logger-service.d.ts.map +1 -0
  43. package/lib/cjs/types/{logger/general-logger.d.ts → provider/logger/winston-logger.d.ts} +1 -1
  44. package/lib/cjs/types/provider/logger/winston-logger.d.ts.map +1 -0
  45. package/lib/cjs/types/provider/provider-service.d.ts +31 -0
  46. package/lib/cjs/types/provider/provider-service.d.ts.map +1 -0
  47. package/lib/esm/application/application.js +3 -2
  48. package/lib/esm/common/color-service.provider.js +46 -0
  49. package/lib/esm/common/package-resolver.provider.js +35 -0
  50. package/lib/esm/console/console.js +10 -33
  51. package/lib/esm/controller/base-controller.js +0 -2
  52. package/lib/esm/error/app-error.js +37 -0
  53. package/lib/esm/error/error-handler-middleware.js +16 -5
  54. package/lib/esm/error/index.js +3 -1
  55. package/lib/esm/error/report.js +18 -23
  56. package/lib/esm/index.mjs +1 -2
  57. package/lib/esm/provider/dto-validator/dto-validator.provider.js +53 -0
  58. package/lib/esm/{environment/env-validator.js → provider/environment/env-validator.provider.js} +17 -10
  59. package/lib/esm/provider/index.js +11 -0
  60. package/lib/esm/provider/logger/logger-service.js +115 -0
  61. package/lib/esm/provider/provider-service.js +38 -0
  62. package/lib/esm/types/application/application.d.ts.map +1 -1
  63. package/lib/esm/types/common/color-service.provider.d.ts +30 -0
  64. package/lib/esm/types/common/color-service.provider.d.ts.map +1 -0
  65. package/lib/esm/types/common/package-resolver.provider.d.ts +9 -0
  66. package/lib/esm/types/common/package-resolver.provider.d.ts.map +1 -0
  67. package/lib/esm/types/console/console.d.ts +1 -1
  68. package/lib/esm/types/console/console.d.ts.map +1 -1
  69. package/lib/esm/types/controller/base-controller.d.ts.map +1 -1
  70. package/lib/esm/types/error/app-error.d.ts +30 -0
  71. package/lib/esm/types/error/app-error.d.ts.map +1 -0
  72. package/lib/esm/types/error/error-handler-middleware.d.ts +3 -4
  73. package/lib/esm/types/error/error-handler-middleware.d.ts.map +1 -1
  74. package/lib/esm/types/error/index.d.ts +1 -0
  75. package/lib/esm/types/error/index.d.ts.map +1 -1
  76. package/lib/esm/types/error/report.d.ts +7 -11
  77. package/lib/esm/types/error/report.d.ts.map +1 -1
  78. package/lib/esm/types/index.d.ts +1 -2
  79. package/lib/esm/types/index.d.ts.map +1 -1
  80. package/lib/esm/types/provider/dto-validator/dto-validator.provider.d.ts +12 -0
  81. package/lib/esm/types/provider/dto-validator/dto-validator.provider.d.ts.map +1 -0
  82. package/lib/esm/types/{environment/env-validator.d.ts → provider/environment/env-validator.provider.d.ts} +7 -4
  83. package/lib/esm/types/provider/environment/env-validator.provider.d.ts.map +1 -0
  84. package/lib/esm/types/provider/index.d.ts +5 -0
  85. package/lib/esm/types/provider/index.d.ts.map +1 -0
  86. package/lib/esm/types/provider/logger/logger-service.d.ts +50 -0
  87. package/lib/esm/types/provider/logger/logger-service.d.ts.map +1 -0
  88. package/lib/esm/types/{logger/general-logger.d.ts → provider/logger/winston-logger.d.ts} +1 -1
  89. package/lib/esm/types/provider/logger/winston-logger.d.ts.map +1 -0
  90. package/lib/esm/types/provider/provider-service.d.ts +31 -0
  91. package/lib/esm/types/provider/provider-service.d.ts.map +1 -0
  92. package/lib/package.json +7 -6
  93. package/package.json +7 -6
  94. package/lib/cjs/environment/index.js +0 -5
  95. package/lib/cjs/logger/index.js +0 -7
  96. package/lib/cjs/types/environment/env-validator.d.ts.map +0 -1
  97. package/lib/cjs/types/environment/index.d.ts +0 -2
  98. package/lib/cjs/types/environment/index.d.ts.map +0 -1
  99. package/lib/cjs/types/logger/general-logger.d.ts.map +0 -1
  100. package/lib/cjs/types/logger/index.d.ts +0 -2
  101. package/lib/cjs/types/logger/index.d.ts.map +0 -1
  102. package/lib/esm/environment/index.js +0 -5
  103. package/lib/esm/logger/index.js +0 -7
  104. package/lib/esm/types/environment/env-validator.d.ts.map +0 -1
  105. package/lib/esm/types/environment/index.d.ts +0 -2
  106. package/lib/esm/types/environment/index.d.ts.map +0 -1
  107. package/lib/esm/types/logger/general-logger.d.ts.map +0 -1
  108. package/lib/esm/types/logger/index.d.ts +0 -2
  109. package/lib/esm/types/logger/index.d.ts.map +0 -1
  110. /package/lib/cjs/{logger/general-logger.js → provider/logger/winston-logger.js} +0 -0
  111. /package/lib/esm/{logger/general-logger.js → provider/logger/winston-logger.js} +0 -0
@@ -1,10 +1,4 @@
1
- interface IAppError {
2
- statusCode: number;
3
- message: string;
4
- service?: string;
5
- name: string;
6
- stack?: string;
7
- }
1
+ import { AppError } from "./app-error";
8
2
  /**
9
3
  * Report class is a utility class to manage and log errors within the application.
10
4
  * It is responsible for creating a standardized error object, logging it,
@@ -12,19 +6,21 @@ interface IAppError {
12
6
  */
13
7
  declare class Report {
14
8
  static stack: string;
9
+ private logger;
10
+ constructor();
15
11
  /**
16
12
  * The Error method is responsible for generating a standardized error object,
17
13
  * logging the error, and then throwing it for further handling.
18
- * The error thrown is of the custom type IAppError, which extends the built-in Error class.
14
+ * The error thrown is of the custom type AppError, which extends the built-in Error class.
19
15
  *
20
16
  * @param error - An instance of Error or a string that describes the error.
21
17
  * @param statusCode - The HTTP status code associated with the error (default is 500).
22
18
  * @param service - The service name associated with the error. If not specified,
23
19
  * it defaults to the name of the calling function.
24
20
  *
25
- * @throws An object of the custom type IAppError, which includes details about the error.
21
+ * @throws An object of the custom type AppError, which includes details about the error.
26
22
  */
27
- static Error(error: Error | string, statusCode?: number, service?: string): void;
23
+ error(error: Error | string, statusCode?: number, service?: string): AppError;
28
24
  }
29
- export { Report, IAppError };
25
+ export { Report };
30
26
  //# sourceMappingURL=report.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/error/report.ts"],"names":[],"mappings":"AAGA,UAAU,SAAS;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,cACM,MAAM;IACV,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;OAWG;WACW,KAAK,CACjB,KAAK,EAAE,KAAK,GAAG,MAAM,EACrB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,GACf,IAAI;CA6BR;AAED,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC"}
1
+ {"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/error/report.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC;;;;GAIG;AACH,cACM,MAAM;IACV,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,MAAM,CAAS;;IAMvB;;;;;;;;;;;OAWG;IACI,KAAK,CACV,KAAK,EAAE,KAAK,GAAG,MAAM,EACrB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,GACf,QAAQ;CAgBZ;AAED,OAAO,EAAE,MAAM,EAAE,CAAC"}
@@ -4,8 +4,7 @@ export * from "./console";
4
4
  export * from "./container-module";
5
5
  export * from "./controller";
6
6
  export * from "./decorator";
7
- export * from "./environment";
8
7
  export * from "./error";
9
- export * from "./logger";
8
+ export * from "./provider";
10
9
  export * from "./render";
11
10
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/core/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/core/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}
@@ -0,0 +1,12 @@
1
+ import "reflect-metadata";
2
+ import { RequestHandler } from "express";
3
+ /**
4
+ * Validate the DTO using class-validator and class-transformer.
5
+ * @param type - The type of the DTO to validate.
6
+ * @returns A RequestHandler function.
7
+ * @throws An exception if the DTO is invalid.
8
+ *
9
+ */
10
+ declare function ValidateDTO<T extends object>(type: new () => T): RequestHandler;
11
+ export { ValidateDTO };
12
+ //# sourceMappingURL=dto-validator.provider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dto-validator.provider.d.ts","sourceRoot":"","sources":["../../../../../packages/core/src/provider/dto-validator/dto-validator.provider.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAmC,cAAc,EAAE,MAAM,SAAS,CAAC;AAK1E;;;;;;GAMG;AACH,iBAAS,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,UAAU,CAAC,GAAG,cAAc,CA8CxE;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}
@@ -1,21 +1,24 @@
1
+ type DefaultValueType = string | number | boolean | undefined;
1
2
  /**
2
3
  * The EnvValidatorProvider class provides utility methods for working with environment variables.
3
4
  * It validates, loads, and retrieves environment variables from the .env file.
4
5
  * @provide EnvValidatorProvider
5
6
  */
6
7
  declare class EnvValidatorProvider {
8
+ private logger;
9
+ constructor();
7
10
  /**
8
11
  * Retrieves the value of an environment variable, or a default value if the variable is not set.
9
12
  * @param key - The key of the environment variable.
10
13
  * @param defaultValue - The default value to return if the environment variable is not set.
11
14
  * @returns The value of the environment variable, or the default value if not set.
12
15
  */
13
- static get(key: string, defaultValue?: any): any;
16
+ get(key: string, defaultValue?: DefaultValueType): DefaultValueType;
14
17
  /**
15
18
  * Validates and loads all environment variables from the .env file.
16
19
  * If the .env file does not exist or any environment variables are not set, the process will exit with an error.
17
20
  */
18
- static checkAll(): void;
21
+ checkAll(): void;
19
22
  }
20
23
  declare global {
21
24
  interface String {
@@ -24,5 +27,5 @@ declare global {
24
27
  AsString(): string | undefined;
25
28
  }
26
29
  }
27
- export { EnvValidatorProvider as Environments };
28
- //# sourceMappingURL=env-validator.d.ts.map
30
+ export { EnvValidatorProvider };
31
+ //# sourceMappingURL=env-validator.provider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"env-validator.provider.d.ts","sourceRoot":"","sources":["../../../../../packages/core/src/provider/environment/env-validator.provider.ts"],"names":[],"mappings":"AAMA,KAAK,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAE9D;;;;GAIG;AACH,cACM,oBAAoB;IACxB,OAAO,CAAC,MAAM,CAAS;;IAMvB;;;;;OAKG;IACI,GAAG,CACR,GAAG,EAAE,MAAM,EACX,YAAY,GAAE,gBAA4B,GACzC,gBAAgB;IAInB;;;OAGG;IACI,QAAQ,IAAI,IAAI;CAoCxB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,SAAS,IAAI,OAAO,GAAG,SAAS,CAAC;QACjC,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;QAC/B,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;KAChC;CACF;AAyBD,OAAO,EAAE,oBAAoB,EAAE,CAAC"}
@@ -0,0 +1,5 @@
1
+ export { Provider, IProvider } from "./provider-service";
2
+ export { Logger } from "./logger/logger-service";
3
+ export { EnvValidatorProvider } from "./environment/env-validator.provider";
4
+ export { ValidateDTO } from "./dto-validator/dto-validator.provider";
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/provider/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC"}
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Represents the different logging levels.
3
+ */
4
+ type LogLevel = "INFO" | "WARN" | "ERROR" | "NONE";
5
+ /**
6
+ * Class that provides logging functionality with colorized text.
7
+ */
8
+ declare class Logger {
9
+ private pid;
10
+ constructor();
11
+ /**
12
+ * Formats the log message with color, timestamps, and log levels.
13
+ *
14
+ * @param logLevel - The level of the log (e.g. INFO, WARN).
15
+ * @param message - The main log message.
16
+ * @param module - Optional module name.
17
+ * @returns The formatted log message.
18
+ */
19
+ protected formatMessage(logLevel: LogLevel, message: string, module?: string): string;
20
+ /**
21
+ * Logs a generic message.
22
+ *
23
+ * @param message - The message to log.
24
+ * @param module - Optional module name.
25
+ */
26
+ msg(message: string, module?: string): void;
27
+ /**
28
+ * Logs an informational message.
29
+ *
30
+ * @param message - The message to log.
31
+ * @param module - Optional module name.
32
+ */
33
+ info(message: string, module?: string): void;
34
+ /**
35
+ * Logs a warning message.
36
+ *
37
+ * @param message - The message to log.
38
+ * @param module - Optional module name.
39
+ */
40
+ warn(message: string, module?: string): void;
41
+ /**
42
+ * Logs an error message.
43
+ *
44
+ * @param message - The message to log.
45
+ * @param module - Optional module name.
46
+ */
47
+ error(message: string, module?: string): void;
48
+ }
49
+ export { Logger, LogLevel };
50
+ //# sourceMappingURL=logger-service.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logger-service.d.ts","sourceRoot":"","sources":["../../../../../packages/core/src/provider/logger/logger-service.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,KAAK,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAanD;;GAEG;AACH,cACM,MAAM;IACV,OAAO,CAAC,GAAG,CAAS;;IAMpB;;;;;;;OAOG;IACH,SAAS,CAAC,aAAa,CACrB,QAAQ,EAAE,QAAiB,EAC3B,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,GACd,MAAM;IAqDT;;;;;OAKG;IACI,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAIlD;;;;;OAKG;IACI,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAInD;;;;;OAKG;IACI,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAInD;;;;;OAKG;IACI,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;CAGrD;AAED,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC"}
@@ -43,4 +43,4 @@ declare class GeneralLogger {
43
43
  }
44
44
  declare const log: (logLevel: LogLevel, content: Error | string, service?: string) => void;
45
45
  export { LogLevel, GeneralLogger, log };
46
- //# sourceMappingURL=general-logger.d.ts.map
46
+ //# sourceMappingURL=winston-logger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"winston-logger.d.ts","sourceRoot":"","sources":["../../../../../packages/core/src/provider/logger/winston-logger.ts"],"names":[],"mappings":"AAUA;;GAEG;AACH,aAAK,QAAQ;IACX,KAAK,IAAA;IACL,KAAK,IAAA;IACL,IAAI,IAAA;CACL;AAED;;GAEG;AACH,cACM,aAAa;IACjB,OAAO,CAAC,MAAM,CAAS;;IAMvB;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAY9B;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAcrC;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAoB3B;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAYtB;;;;;OAKG;IACI,GAAG,CACR,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,KAAK,GAAG,MAAM,EACvB,OAAO,CAAC,EAAE,MAAM,GACf,IAAI;CAyBR;AAGD,QAAA,MAAM,GAAG,aA/BK,QAAQ,WACT,KAAK,GAAG,MAAM,YACb,MAAM,KACf,IA4BwB,CAAC;AAE9B,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC"}
@@ -0,0 +1,31 @@
1
+ import { Logger } from "./logger/logger-service";
2
+ import { EnvValidatorProvider } from "./environment/env-validator.provider";
3
+ /**
4
+ * Interface defining the methods for the Provider class.
5
+ */
6
+ interface IProvider {
7
+ /**
8
+ * Returns an instance of the `EnvValidatorProvider`.
9
+ */
10
+ envValidator: EnvValidatorProvider;
11
+ /**
12
+ * Returns an instance of the `Logger`.
13
+ */
14
+ logger: Logger;
15
+ }
16
+ /**
17
+ * Class responsible for providing singleton instances of various services.
18
+ *
19
+ * This class implements the IProvider interface and is decorated with a
20
+ * singleton provider to ensure a single instance is reused.
21
+ */
22
+ declare class Provider implements IProvider {
23
+ envValidator: EnvValidatorProvider;
24
+ logger: Logger;
25
+ /**
26
+ * Initializes the instances of the various providers.
27
+ */
28
+ constructor();
29
+ }
30
+ export { IProvider, Provider };
31
+ //# sourceMappingURL=provider-service.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"provider-service.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/provider/provider-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAE5E;;GAEG;AACH,UAAU,SAAS;IACjB;;OAEG;IACH,YAAY,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,cACM,QAAS,YAAW,SAAS;IACjC,YAAY,EAAE,oBAAoB,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;;CAKJ;AAED,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC"}
@@ -86,9 +86,10 @@ let Application = Application_1 = class Application {
86
86
  app.use(middleware);
87
87
  });
88
88
  });
89
+ expressServer.setErrorConfig((app) => {
90
+ app.use(error_handler_middleware_1.default);
91
+ });
89
92
  this.app = expressServer.build();
90
- /* Add the error handler middleware */
91
- this.app.use(error_handler_middleware_1.default);
92
93
  return this;
93
94
  }
94
95
  /**
@@ -0,0 +1,46 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.bgColorCodes = exports.colorCodes = exports.ColorStyle = void 0;
4
+ /**
5
+ * Mapping of text color codes.
6
+ *
7
+ * @remarks
8
+ * Defines the ANSI escape codes for the corresponding colors in the terminal.
9
+ */
10
+ const colorCodes = {
11
+ red: "\x1b[31m",
12
+ green: "\x1b[32m",
13
+ yellow: "\x1b[33m",
14
+ blue: "\x1b[34m",
15
+ white: "\x1b[37m",
16
+ black: "\x1b[30m",
17
+ none: "\x1b[0m",
18
+ };
19
+ exports.colorCodes = colorCodes;
20
+ /**
21
+ * ANSI escape color codes mapping for different background colors.
22
+ */
23
+ const bgColorCodes = {
24
+ red: "\x1b[41m",
25
+ green: "\x1b[42m",
26
+ yellow: "\x1b[43m",
27
+ blue: "\x1b[44m",
28
+ white: "\x1b[47m",
29
+ black: "\x1b[40m",
30
+ none: "\x1b[0m",
31
+ };
32
+ exports.bgColorCodes = bgColorCodes;
33
+ /**
34
+ * Enum representing possible color styles for console output.
35
+ *
36
+ * @remarks
37
+ * Enum values correspond to the string representations of colors.
38
+ */
39
+ var ColorStyle;
40
+ (function (ColorStyle) {
41
+ ColorStyle["None"] = "none";
42
+ ColorStyle["Yellow"] = "yellow";
43
+ ColorStyle["Blue"] = "blue";
44
+ ColorStyle["Green"] = "green";
45
+ ColorStyle["Red"] = "red";
46
+ })(ColorStyle || (exports.ColorStyle = ColorStyle = {}));
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.packageResolver = void 0;
4
+ /* eslint-disable @typescript-eslint/no-explicit-any */
5
+ const logger_service_1 = require("../provider/logger/logger-service");
6
+ /**
7
+ * Resolve package from the current working directory.
8
+ * @param packageName
9
+ * @param options
10
+ * @returns
11
+ */
12
+ function packageResolver(packageName, ...options) {
13
+ const logger = new logger_service_1.Logger();
14
+ try {
15
+ const hasPackage = require.resolve(packageName, {
16
+ paths: [process.cwd()],
17
+ });
18
+ if (hasPackage) {
19
+ // eslint-disable-next-line @typescript-eslint/no-var-requires
20
+ const packageResolved = require(hasPackage);
21
+ if (typeof packageResolved === "function") {
22
+ return packageResolved(...options);
23
+ }
24
+ if (packageResolved.default &&
25
+ typeof packageResolved.default === "function") {
26
+ return packageResolved.default(...options);
27
+ }
28
+ return packageResolved;
29
+ }
30
+ }
31
+ catch (error) {
32
+ logger.warn(`Package [${packageName}] not installed. Please install it using your package manager.`, "package-resolver");
33
+ }
34
+ }
35
+ exports.packageResolver = packageResolver;
@@ -5,25 +5,11 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
5
5
  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
6
  return c > 3 && r && Object.defineProperty(target, key, r), r;
7
7
  };
8
- var __importDefault = (this && this.__importDefault) || function (mod) {
9
- return (mod && mod.__esModule) ? mod : { "default": mod };
10
- };
11
8
  var Console_1;
12
9
  Object.defineProperty(exports, "__esModule", { value: true });
13
10
  exports.Console = void 0;
14
- const chalk_1 = __importDefault(require("chalk"));
15
11
  const inversify_binding_decorators_1 = require("inversify-binding-decorators");
16
- /**
17
- * Enum representing possible color styles for console output.
18
- */
19
- var ColorStyle;
20
- (function (ColorStyle) {
21
- ColorStyle[ColorStyle["None"] = 0] = "None";
22
- ColorStyle[ColorStyle["Yellow"] = 1] = "Yellow";
23
- ColorStyle[ColorStyle["Blue"] = 2] = "Blue";
24
- ColorStyle[ColorStyle["Green"] = 3] = "Green";
25
- ColorStyle[ColorStyle["Red"] = 4] = "Red";
26
- })(ColorStyle || (ColorStyle = {}));
12
+ const color_service_provider_1 = require("../common/color-service.provider");
27
13
  /**
28
14
  * The Console class provides methods for displaying styled messages in the console.
29
15
  * @provide Console
@@ -35,16 +21,9 @@ let Console = Console_1 = class Console {
35
21
  * @param colorStyle - The color style for the message.
36
22
  */
37
23
  async printColor(message, colorStyle) {
38
- switch (colorStyle) {
39
- case ColorStyle.Yellow:
40
- return console.log(chalk_1.default.bgYellow.black(message));
41
- case ColorStyle.Blue:
42
- return console.log(chalk_1.default.bgBlue.black(message));
43
- case ColorStyle.Green:
44
- return console.log(chalk_1.default.bgGreen.black(message));
45
- case ColorStyle.Red:
46
- return console.log(chalk_1.default.bgRed.black(message));
47
- }
24
+ const textColor = "black";
25
+ const bgColor = colorStyle;
26
+ console.log(`${color_service_provider_1.bgColorCodes[bgColor]}${color_service_provider_1.colorCodes[textColor]}${message}\x1b[0m`);
48
27
  }
49
28
  /**
50
29
  * Display a message in the console with details about the running server.
@@ -52,26 +31,24 @@ let Console = Console_1 = class Console {
52
31
  * @param environment - The server environment.
53
32
  * @param consoleMessage - Optional application message details for console output.
54
33
  */
55
- async messageServer(
56
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
57
- port, environment, consoleMessage) {
34
+ async messageServer(port, environment, consoleMessage) {
58
35
  const appConsoleMessage = {
59
36
  appName: consoleMessage?.appName || "Application",
60
37
  appVersion: consoleMessage?.appVersion || "not provided",
61
38
  };
62
- let terminalColor = ColorStyle.None;
39
+ let terminalColor = color_service_provider_1.ColorStyle.None;
63
40
  switch (environment.toLowerCase()) {
64
41
  case "development":
65
- terminalColor = ColorStyle.Yellow;
42
+ terminalColor = color_service_provider_1.ColorStyle.Yellow;
66
43
  break;
67
44
  case "staging":
68
- terminalColor = ColorStyle.Blue;
45
+ terminalColor = color_service_provider_1.ColorStyle.Blue;
69
46
  break;
70
47
  case "production":
71
- terminalColor = ColorStyle.Green;
48
+ terminalColor = color_service_provider_1.ColorStyle.Green;
72
49
  break;
73
50
  default:
74
- terminalColor = ColorStyle.Red;
51
+ terminalColor = color_service_provider_1.ColorStyle.Red;
75
52
  break;
76
53
  }
77
54
  this.printColor(`${appConsoleMessage.appName} version ${appConsoleMessage.appVersion} is running on ` +
@@ -12,7 +12,6 @@ var BaseController_1;
12
12
  Object.defineProperty(exports, "__esModule", { value: true });
13
13
  exports.BaseController = void 0;
14
14
  const inversify_binding_decorators_1 = require("inversify-binding-decorators");
15
- const logger_1 = require("../logger");
16
15
  /**
17
16
  * The BaseController class is an abstract base class for controllers.
18
17
  * It provides methods for handling use case calls and sending appropriate responses.
@@ -74,7 +73,6 @@ let BaseController = BaseController_1 = class BaseController {
74
73
  return new Promise((resolve, reject) => {
75
74
  res.render(template, options, (err, compiled) => {
76
75
  if (err) {
77
- (0, logger_1.log)(logger_1.LogLevel.Error, err.message, "base-controller");
78
76
  reject(err);
79
77
  }
80
78
  resolve(compiled);
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AppError = void 0;
4
+ /**
5
+ * The AppError class extends the built-in Error class in JavaScript,
6
+ * providing additional properties to manage custom application errors.
7
+ * It captures detailed information about the error, including a status code
8
+ * and an optional service identifier, which can be useful for error handling
9
+ * and logging within the application.
10
+ *
11
+ * @extends {Error}
12
+ */
13
+ class AppError extends Error {
14
+ /**
15
+ * The HTTP status code associated with the error.
16
+ * Commonly used to define the HTTP response status code.
17
+ */
18
+ statusCode;
19
+ /**
20
+ * The service identifier associated with the error.
21
+ * This property can be used to trace the origin of the error in the application.
22
+ * It is optional and can be left undefined.
23
+ */
24
+ service;
25
+ /**
26
+ * @param {string} message - The error message to be displayed.
27
+ * @param {number} [statusCode=500] - The HTTP status code associated with the error (default: 500).
28
+ * @param {string} [service] - The service identifier associated with the error.
29
+ */
30
+ constructor(message, statusCode = 500, service) {
31
+ super(message);
32
+ this.statusCode = statusCode;
33
+ this.service = service;
34
+ Error.captureStackTrace(this, this.constructor);
35
+ }
36
+ }
37
+ exports.AppError = AppError;
@@ -1,5 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ const app_error_1 = require("./app-error");
3
4
  const status_code_1 = require("./status-code");
4
5
  /**
5
6
  * errorHandler is a custom Express error-handling middleware function.
@@ -9,9 +10,19 @@ const status_code_1 = require("./status-code");
9
10
  * @param res - The Express response object.
10
11
  * @param next - The Express next function for passing control to the next middleware function.
11
12
  */
12
- function errorHandler(error, req, res) {
13
- res
14
- .status(error.statusCode || status_code_1.StatusCode.InternalServerError)
15
- .json({ statusCode: error.statusCode, error: error.message });
13
+ function defaultErrorHandler(error, req, res,
14
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
15
+ next) {
16
+ if (error instanceof app_error_1.AppError) {
17
+ res
18
+ .status(error.statusCode)
19
+ .json({ statusCode: error.statusCode, error: error.message });
20
+ }
21
+ else {
22
+ res.status(status_code_1.StatusCode.InternalServerError).json({
23
+ statusCode: status_code_1.StatusCode.InternalServerError,
24
+ error: "An unexpected error occurred.",
25
+ });
26
+ }
16
27
  }
17
- exports.default = errorHandler;
28
+ exports.default = defaultErrorHandler;
@@ -1,7 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Report = exports.StatusCode = void 0;
3
+ exports.AppError = exports.Report = exports.StatusCode = void 0;
4
4
  var status_code_1 = require("./status-code");
5
5
  Object.defineProperty(exports, "StatusCode", { enumerable: true, get: function () { return status_code_1.StatusCode; } });
6
6
  var report_1 = require("./report");
7
7
  Object.defineProperty(exports, "Report", { enumerable: true, get: function () { return report_1.Report; } });
8
+ var app_error_1 = require("./app-error");
9
+ Object.defineProperty(exports, "AppError", { enumerable: true, get: function () { return app_error_1.AppError; } });
@@ -5,11 +5,15 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
5
5
  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
6
  return c > 3 && r && Object.defineProperty(target, key, r), r;
7
7
  };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
8
11
  var Report_1;
9
12
  Object.defineProperty(exports, "__esModule", { value: true });
10
13
  exports.Report = void 0;
11
14
  const inversify_binding_decorators_1 = require("inversify-binding-decorators");
12
- const logger_1 = require("../logger");
15
+ const logger_service_1 = require("../provider/logger/logger-service");
16
+ const app_error_1 = require("./app-error");
13
17
  /**
14
18
  * Report class is a utility class to manage and log errors within the application.
15
19
  * It is responsible for creating a standardized error object, logging it,
@@ -18,45 +22,36 @@ const logger_1 = require("../logger");
18
22
  let Report = class Report {
19
23
  static { Report_1 = this; }
20
24
  static stack;
25
+ logger;
26
+ constructor() {
27
+ this.logger = new logger_service_1.Logger();
28
+ }
21
29
  /**
22
30
  * The Error method is responsible for generating a standardized error object,
23
31
  * logging the error, and then throwing it for further handling.
24
- * The error thrown is of the custom type IAppError, which extends the built-in Error class.
32
+ * The error thrown is of the custom type AppError, which extends the built-in Error class.
25
33
  *
26
34
  * @param error - An instance of Error or a string that describes the error.
27
35
  * @param statusCode - The HTTP status code associated with the error (default is 500).
28
36
  * @param service - The service name associated with the error. If not specified,
29
37
  * it defaults to the name of the calling function.
30
38
  *
31
- * @throws An object of the custom type IAppError, which includes details about the error.
39
+ * @throws An object of the custom type AppError, which includes details about the error.
32
40
  */
33
- static Error(error, statusCode, service) {
41
+ error(error, statusCode, service) {
34
42
  let appError = {};
35
- Error.captureStackTrace(this, this.Error);
36
- const callerName = this.stack.split("\n")[1]?.trim()?.split(" ")[1];
37
43
  if (error instanceof Error) {
38
- appError = {
39
- statusCode: statusCode ?? 500,
40
- message: error.message,
41
- service: service ?? callerName,
42
- name: error.name,
43
- stack: error.stack,
44
- };
44
+ appError = new app_error_1.AppError(error.message, statusCode, service);
45
45
  }
46
46
  else {
47
- appError = {
48
- statusCode: statusCode ?? 500,
49
- message: error,
50
- service: service ?? callerName,
51
- name: this.Error.name,
52
- stack: this.stack,
53
- };
47
+ appError = new app_error_1.AppError(error, statusCode, service);
54
48
  }
55
- (0, logger_1.log)(logger_1.LogLevel.Error, appError, appError.service || "service-undefined");
56
- throw appError;
49
+ this.logger.error(appError.message, appError.service || "service-undefined");
50
+ return appError;
57
51
  }
58
52
  };
59
53
  exports.Report = Report;
60
54
  exports.Report = Report = Report_1 = __decorate([
61
- (0, inversify_binding_decorators_1.provide)(Report_1)
55
+ (0, inversify_binding_decorators_1.provide)(Report_1),
56
+ __metadata("design:paramtypes", [])
62
57
  ], Report);
package/lib/esm/index.mjs CHANGED
@@ -20,7 +20,6 @@ __exportStar(require("./console"), exports);
20
20
  __exportStar(require("./container-module"), exports);
21
21
  __exportStar(require("./controller"), exports);
22
22
  __exportStar(require("./decorator"), exports);
23
- __exportStar(require("./environment"), exports);
24
23
  __exportStar(require("./error"), exports);
25
- __exportStar(require("./logger"), exports);
24
+ __exportStar(require("./provider"), exports);
26
25
  __exportStar(require("./render"), exports);
@@ -0,0 +1,53 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ValidateDTO = void 0;
4
+ require("reflect-metadata");
5
+ const status_code_1 = require("../../error/status-code");
6
+ const package_resolver_provider_1 = require("../../common/package-resolver.provider");
7
+ const logger_service_1 = require("../logger/logger-service");
8
+ /**
9
+ * Validate the DTO using class-validator and class-transformer.
10
+ * @param type - The type of the DTO to validate.
11
+ * @returns A RequestHandler function.
12
+ * @throws An exception if the DTO is invalid.
13
+ *
14
+ */
15
+ function ValidateDTO(type) {
16
+ return async (req, res, next) => {
17
+ const logger = new logger_service_1.Logger();
18
+ const classValidator = (0, package_resolver_provider_1.packageResolver)("class-validator");
19
+ const classTransformer = (0, package_resolver_provider_1.packageResolver)("class-transformer");
20
+ if (!classValidator || !classTransformer) {
21
+ return next();
22
+ }
23
+ try {
24
+ const errors = await classValidator.validate(classTransformer.plainToClass(type, req.body));
25
+ if (errors.length > 0) {
26
+ const DTO = errors.reduce((acc, error) => {
27
+ if (error.constraints) {
28
+ const propertyName = error.property;
29
+ if (!acc.some((e) => e.property === propertyName)) {
30
+ acc.push({ property: propertyName, messages: [] });
31
+ }
32
+ const target = acc.find((e) => e.property === propertyName);
33
+ target.messages.push(...Object.values(error.constraints));
34
+ }
35
+ return acc;
36
+ }, []);
37
+ res.status(status_code_1.StatusCode.BadRequest).json({
38
+ errorCode: status_code_1.StatusCode.BadRequest,
39
+ errorMessage: "Bad Request",
40
+ DTO,
41
+ });
42
+ }
43
+ else {
44
+ next();
45
+ }
46
+ }
47
+ catch (error) {
48
+ logger.error(`An exception occurred while validating the DTO: ${error}`, "validate-dto-provider");
49
+ next(error);
50
+ }
51
+ };
52
+ }
53
+ exports.ValidateDTO = ValidateDTO;