@breautek/storm 4.2.0 → 4.3.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 (110) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/docs/README.md +4 -4
  3. package/docs/classes/Application.md +26 -26
  4. package/docs/classes/BackendAuthenticationMiddleware.md +2 -2
  5. package/docs/classes/CORSMiddleware.md +6 -6
  6. package/docs/classes/ConfigLoader.md +1 -1
  7. package/docs/classes/Database.md +12 -12
  8. package/docs/classes/DatabaseConnection.md +19 -19
  9. package/docs/classes/DatabaseQueryError.md +46 -8
  10. package/docs/classes/DiskSpaceError.md +46 -8
  11. package/docs/classes/DropTemporaryTableQuery.md +8 -8
  12. package/docs/classes/DumpStream.md +1 -1
  13. package/docs/classes/DuplicateEntryError.md +46 -8
  14. package/docs/classes/EntityNotFoundError.md +46 -8
  15. package/docs/classes/ExpiredTokenError.md +46 -8
  16. package/docs/classes/Handler.md +14 -14
  17. package/docs/classes/InternalError.md +46 -8
  18. package/docs/classes/InvalidCredentialsError.md +46 -8
  19. package/docs/classes/InvalidValueError.md +46 -8
  20. package/docs/classes/ManagedDatabaseConnection.md +19 -19
  21. package/docs/classes/Middleware.md +3 -3
  22. package/docs/classes/MissingConfigError.md +46 -8
  23. package/docs/classes/MissingParameterError.md +46 -8
  24. package/docs/classes/MySQLConnection.md +20 -20
  25. package/docs/classes/MySQLDatabase.md +13 -13
  26. package/docs/classes/NotImplementedError.md +46 -8
  27. package/docs/classes/Query.md +8 -8
  28. package/docs/classes/RawError.md +46 -8
  29. package/docs/classes/RawQuery.md +8 -8
  30. package/docs/classes/Request.md +18 -18
  31. package/docs/classes/Response.md +11 -11
  32. package/docs/classes/ResponseData.md +7 -7
  33. package/docs/classes/ServiceProvider.md +15 -15
  34. package/docs/classes/ServiceResponse.md +4 -4
  35. package/docs/classes/SetSessionVariableQuery.md +8 -8
  36. package/docs/classes/StormError.md +38 -8
  37. package/docs/classes/TemporaryTableQuery.md +8 -8
  38. package/docs/classes/Token.md +2 -2
  39. package/docs/classes/TokenManager.md +4 -4
  40. package/docs/classes/UnauthorizedAccessError.md +46 -8
  41. package/docs/enums/ErrorCode.md +9 -9
  42. package/docs/enums/ExitCode.md +2 -2
  43. package/docs/enums/HTTPMethod.md +4 -4
  44. package/docs/enums/JWTError.md +2 -2
  45. package/docs/enums/StatusCode.md +48 -48
  46. package/docs/interfaces/IConfig.md +8 -8
  47. package/docs/interfaces/IDatabaseConfig.md +6 -6
  48. package/docs/interfaces/IDatabaseConnection.md +14 -14
  49. package/docs/interfaces/IErrorResponse.md +15 -4
  50. package/docs/interfaces/IFormData.md +2 -2
  51. package/docs/interfaces/IHandler.md +1 -1
  52. package/docs/interfaces/IInsertQueryResult.md +3 -3
  53. package/docs/interfaces/IJWTVerifyOptions.md +1 -1
  54. package/docs/interfaces/IRequestResponse.md +2 -2
  55. package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
  56. package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
  57. package/docs/interfaces/IUpdateQueryResult.md +2 -2
  58. package/lib/DatabaseQueryError.d.ts +1 -0
  59. package/lib/DatabaseQueryError.js +3 -0
  60. package/lib/DatabaseQueryError.js.map +1 -1
  61. package/lib/DiskSpaceError.d.ts +1 -0
  62. package/lib/DiskSpaceError.js +3 -0
  63. package/lib/DiskSpaceError.js.map +1 -1
  64. package/lib/DuplicateEntryError.d.ts +2 -0
  65. package/lib/DuplicateEntryError.js +11 -0
  66. package/lib/DuplicateEntryError.js.map +1 -1
  67. package/lib/EntityNotFoundError.d.ts +2 -0
  68. package/lib/EntityNotFoundError.js +8 -0
  69. package/lib/EntityNotFoundError.js.map +1 -1
  70. package/lib/ExpiredTokenError.d.ts +1 -0
  71. package/lib/ExpiredTokenError.js +3 -0
  72. package/lib/ExpiredTokenError.js.map +1 -1
  73. package/lib/InternalError.d.ts +1 -0
  74. package/lib/InternalError.js +3 -0
  75. package/lib/InternalError.js.map +1 -1
  76. package/lib/InvalidCredentialsError.d.ts +1 -0
  77. package/lib/InvalidCredentialsError.js +3 -0
  78. package/lib/InvalidCredentialsError.js.map +1 -1
  79. package/lib/InvalidValueError.d.ts +2 -0
  80. package/lib/InvalidValueError.js +11 -0
  81. package/lib/InvalidValueError.js.map +1 -1
  82. package/lib/MissingConfigError.d.ts +2 -0
  83. package/lib/MissingConfigError.js +8 -0
  84. package/lib/MissingConfigError.js.map +1 -1
  85. package/lib/MissingParameterError.d.ts +2 -0
  86. package/lib/MissingParameterError.js +8 -0
  87. package/lib/MissingParameterError.js.map +1 -1
  88. package/lib/NotImplementedError.d.ts +2 -0
  89. package/lib/NotImplementedError.js +8 -0
  90. package/lib/NotImplementedError.js.map +1 -1
  91. package/lib/StormError.d.ts +7 -0
  92. package/lib/StormError.js +10 -0
  93. package/lib/StormError.js.map +1 -1
  94. package/lib/UnauthorizedAccessError.d.ts +1 -0
  95. package/lib/UnauthorizedAccessError.js +3 -0
  96. package/lib/UnauthorizedAccessError.js.map +1 -1
  97. package/package.json +1 -1
  98. package/src/DatabaseQueryError.ts +4 -0
  99. package/src/DiskSpaceError.ts +4 -0
  100. package/src/DuplicateEntryError.ts +13 -0
  101. package/src/EntityNotFoundError.ts +10 -0
  102. package/src/ExpiredTokenError.ts +4 -0
  103. package/src/InternalError.ts +4 -0
  104. package/src/InvalidCredentialsError.ts +4 -0
  105. package/src/InvalidValueError.ts +13 -0
  106. package/src/MissingConfigError.ts +10 -0
  107. package/src/MissingParameterError.ts +10 -0
  108. package/src/NotImplementedError.ts +10 -0
  109. package/src/StormError.ts +18 -0
  110. package/src/UnauthorizedAccessError.ts +4 -0
@@ -35,4 +35,8 @@ export class ExpiredTokenError extends StormError<any> {
35
35
  public getHTTPCode(): StatusCode {
36
36
  return StatusCode.ERR_UNAUTHORIZED;
37
37
  }
38
+
39
+ public override getLocaleCode(): string {
40
+ return '@breautek/storm/ExpiredTokenError/message';
41
+ }
38
42
  }
@@ -35,4 +35,8 @@ export class InternalError extends StormError<any> {
35
35
  public getHTTPCode(): StatusCode {
36
36
  return StatusCode.INTERNAL_ERROR;
37
37
  }
38
+
39
+ public override getLocaleCode(): string {
40
+ return '@breautek/storm/InternalError/message';
41
+ }
38
42
  }
@@ -35,4 +35,8 @@ export class InvalidCredentialsError extends StormError<any> {
35
35
  public getHTTPCode(): StatusCode {
36
36
  return StatusCode.ERR_UNAUTHORIZED;
37
37
  }
38
+
39
+ public override getLocaleCode(): string {
40
+ return '@breautek/storm/InvalidCredentialsError/message';
41
+ }
38
42
  }
@@ -44,4 +44,17 @@ export class InvalidValueError extends StormError<{
44
44
  public getHTTPCode(): StatusCode {
45
45
  return StatusCode.ERR_BAD_REQUEST;
46
46
  }
47
+
48
+ public override getLocaleCode(): string {
49
+ return '@breautek/storm/InvalidValueError/message';
50
+ }
51
+
52
+ public override getLocaleParameters(): Record<string, string> {
53
+ let details = this.getPrivateDetails();
54
+ return {
55
+ variable: details.variable,
56
+ expected: details.expected,
57
+ got: details.got
58
+ };
59
+ }
47
60
  }
@@ -45,4 +45,14 @@ export class MissingConfigError extends StormError<IMissingConfigErrorDetails> {
45
45
  public getExitCode(): ExitCode {
46
46
  return ExitCode.MISSING_CONFIG;
47
47
  }
48
+
49
+ public override getLocaleCode(): string {
50
+ return '@breautek/storm/MissingConfigError/message';
51
+ }
52
+
53
+ public override getLocaleParameters(): Record<string, string> {
54
+ return {
55
+ path: this.getPrivateDetails().path
56
+ };
57
+ }
48
58
  }
@@ -34,4 +34,14 @@ export class MissingParameterError extends StormError {
34
34
  public getHTTPCode(): StatusCode {
35
35
  return StatusCode.ERR_BAD_REQUEST;
36
36
  }
37
+
38
+ public override getLocaleCode(): string {
39
+ return '@breautek/storm/MissingParameterError/message';
40
+ }
41
+
42
+ public override getLocaleParameters(): Record<string, string> {
43
+ return {
44
+ parameter: this.getPrivateDetails().parameter
45
+ };
46
+ }
37
47
  }
@@ -42,4 +42,14 @@ export class NotImplementedError extends StormError<INotImplementedErrorOptions>
42
42
  public getHTTPCode(): StatusCode {
43
43
  return StatusCode.INTERNAL_NOT_IMPLEMENTED;
44
44
  }
45
+
46
+ public override getLocaleCode(): string {
47
+ return '@breautek/storm/NotImplementedError/message';
48
+ }
49
+
50
+ public override getLocaleParameters(): Record<string, string> {
51
+ return {
52
+ method: this.getPrivateDetails().method
53
+ };
54
+ }
45
55
  }
package/src/StormError.ts CHANGED
@@ -25,9 +25,15 @@ export interface IAdditionalErrorDetails {
25
25
  [key: string]: any;
26
26
  }
27
27
 
28
+ export interface ILocale {
29
+ code: string;
30
+ parameters: Record<string, string>;
31
+ }
32
+
28
33
  export interface IErrorResponse {
29
34
  name: string;
30
35
  message: string;
36
+ locale: ILocale;
31
37
  code: number;
32
38
  details: IAdditionalErrorDetails;
33
39
  }
@@ -72,10 +78,22 @@ export abstract class StormError<TErrorDetails = any> extends Error {
72
78
  name: this.constructor.name,
73
79
  message : this.getMessage(),
74
80
  code : this.getCode(),
81
+ locale: {
82
+ code: this.getLocaleCode(),
83
+ parameters: this.getLocaleParameters()
84
+ },
75
85
  details: this.getPublicDetails()
76
86
  };
77
87
  }
78
88
 
89
+ public getLocaleCode(): string {
90
+ return null;
91
+ }
92
+
93
+ public getLocaleParameters(): Record<string, string> {
94
+ return null;
95
+ }
96
+
79
97
  public getExitCode(): ExitCode {
80
98
  return null;
81
99
  }
@@ -34,4 +34,8 @@ export class UnauthorizedAccessError extends StormError {
34
34
  public getHTTPCode(): StatusCode {
35
35
  return StatusCode.ERR_FORBIDDEN;
36
36
  }
37
+
38
+ public override getLocaleCode(): string {
39
+ return '@breautek/storm/UnauthorizedAccessError/message';
40
+ }
37
41
  }