@breautek/storm 4.1.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 (224) hide show
  1. package/CHANGELOG.md +14 -1
  2. package/docs/README.md +6 -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 +14 -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 +22 -22
  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 +339 -0
  27. package/docs/classes/Query.md +14 -8
  28. package/docs/classes/RawError.md +351 -0
  29. package/docs/classes/RawQuery.md +14 -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 +14 -8
  36. package/docs/classes/StormError.md +42 -8
  37. package/docs/classes/TemporaryTableQuery.md +14 -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/Application.d.ts +58 -0
  59. package/lib/Application.js +73 -0
  60. package/lib/Application.js.map +1 -1
  61. package/lib/ApplicationEvent.js +15 -0
  62. package/lib/ApplicationEvent.js.map +1 -1
  63. package/lib/BackendAuthenticationMiddleware.d.ts +12 -0
  64. package/lib/BackendAuthenticationMiddleware.js +28 -0
  65. package/lib/BackendAuthenticationMiddleware.js.map +1 -1
  66. package/lib/CORSMiddleware.d.ts +14 -0
  67. package/lib/CORSMiddleware.js +29 -0
  68. package/lib/CORSMiddleware.js.map +1 -1
  69. package/lib/ConfigLoader.js +16 -0
  70. package/lib/ConfigLoader.js.map +1 -1
  71. package/lib/Database.js +15 -0
  72. package/lib/Database.js.map +1 -1
  73. package/lib/DatabaseConnection.d.ts +115 -0
  74. package/lib/DatabaseConnection.js +71 -0
  75. package/lib/DatabaseConnection.js.map +1 -1
  76. package/lib/DatabaseQueryError.d.ts +1 -0
  77. package/lib/DatabaseQueryError.js +19 -0
  78. package/lib/DatabaseQueryError.js.map +1 -1
  79. package/lib/DiskSpaceError.d.ts +1 -0
  80. package/lib/DiskSpaceError.js +18 -0
  81. package/lib/DiskSpaceError.js.map +1 -1
  82. package/lib/DropTemporaryTableQuery.js +15 -0
  83. package/lib/DropTemporaryTableQuery.js.map +1 -1
  84. package/lib/DumpStream.js +16 -0
  85. package/lib/DumpStream.js.map +1 -1
  86. package/lib/DuplicateEntryError.d.ts +2 -0
  87. package/lib/DuplicateEntryError.js +26 -0
  88. package/lib/DuplicateEntryError.js.map +1 -1
  89. package/lib/EntityNotFoundError.d.ts +2 -0
  90. package/lib/EntityNotFoundError.js +23 -0
  91. package/lib/EntityNotFoundError.js.map +1 -1
  92. package/lib/ErrorCode.js +15 -0
  93. package/lib/ErrorCode.js.map +1 -1
  94. package/lib/ExitCode.js +15 -0
  95. package/lib/ExitCode.js.map +1 -1
  96. package/lib/ExpiredTokenError.d.ts +1 -0
  97. package/lib/ExpiredTokenError.js +19 -0
  98. package/lib/ExpiredTokenError.js.map +1 -1
  99. package/lib/HTTPMethod.js +15 -0
  100. package/lib/HTTPMethod.js.map +1 -1
  101. package/lib/Handler.d.ts +22 -4
  102. package/lib/Handler.js +22 -6
  103. package/lib/Handler.js.map +1 -1
  104. package/lib/IAuthTokenData.js +15 -0
  105. package/lib/IAuthTokenData.js.map +1 -1
  106. package/lib/IConfig.js +15 -0
  107. package/lib/IConfig.js.map +1 -1
  108. package/lib/IDatabaseConfig.js +15 -0
  109. package/lib/IDatabaseConfig.js.map +1 -1
  110. package/lib/IDatabaseConnection.js +15 -0
  111. package/lib/IDatabaseConnection.js.map +1 -1
  112. package/lib/IDeleteQueryResult.js +15 -0
  113. package/lib/IDeleteQueryResult.js.map +1 -1
  114. package/lib/IFormData.js +15 -0
  115. package/lib/IFormData.js.map +1 -1
  116. package/lib/IHandler.js +15 -0
  117. package/lib/IHandler.js.map +1 -1
  118. package/lib/IInsertQueryResult.js +15 -0
  119. package/lib/IInsertQueryResult.js.map +1 -1
  120. package/lib/IJWTVerifyOptions.js +15 -0
  121. package/lib/IJWTVerifyOptions.js.map +1 -1
  122. package/lib/IRequestResponse.js +15 -0
  123. package/lib/IRequestResponse.js.map +1 -1
  124. package/lib/IServiceHeaders.js +15 -0
  125. package/lib/IServiceHeaders.js.map +1 -1
  126. package/lib/IUpdateQueryResult.js +15 -0
  127. package/lib/IUpdateQueryResult.js.map +1 -1
  128. package/lib/InternalError.d.ts +1 -0
  129. package/lib/InternalError.js +19 -0
  130. package/lib/InternalError.js.map +1 -1
  131. package/lib/InvalidConfigError.js +15 -0
  132. package/lib/InvalidConfigError.js.map +1 -1
  133. package/lib/InvalidCredentialsError.d.ts +1 -0
  134. package/lib/InvalidCredentialsError.js +19 -0
  135. package/lib/InvalidCredentialsError.js.map +1 -1
  136. package/lib/InvalidValueError.d.ts +2 -0
  137. package/lib/InvalidValueError.js +27 -0
  138. package/lib/InvalidValueError.js.map +1 -1
  139. package/lib/JWTError.js +15 -0
  140. package/lib/JWTError.js.map +1 -1
  141. package/lib/JWTVerifyOptionsParser.js +16 -0
  142. package/lib/JWTVerifyOptionsParser.js.map +1 -1
  143. package/lib/ManagedDatabaseConnection.d.ts +5 -0
  144. package/lib/ManagedDatabaseConnection.js +26 -0
  145. package/lib/ManagedDatabaseConnection.js.map +1 -1
  146. package/lib/Middleware.js +16 -0
  147. package/lib/Middleware.js.map +1 -1
  148. package/lib/MissingConfigError.d.ts +2 -0
  149. package/lib/MissingConfigError.js +23 -0
  150. package/lib/MissingConfigError.js.map +1 -1
  151. package/lib/MissingParameterError.d.ts +2 -0
  152. package/lib/MissingParameterError.js +23 -0
  153. package/lib/MissingParameterError.js.map +1 -1
  154. package/lib/MySQLConnection.js +24 -1
  155. package/lib/MySQLConnection.js.map +1 -1
  156. package/lib/MySQLDatabase.js +18 -0
  157. package/lib/MySQLDatabase.js.map +1 -1
  158. package/lib/NotImplementedError.d.ts +16 -0
  159. package/lib/NotImplementedError.js +48 -0
  160. package/lib/NotImplementedError.js.map +1 -0
  161. package/lib/Query.d.ts +21 -0
  162. package/lib/Query.js +37 -0
  163. package/lib/Query.js.map +1 -1
  164. package/lib/RawError.d.ts +14 -0
  165. package/lib/RawError.js +40 -0
  166. package/lib/RawError.js.map +1 -0
  167. package/lib/RawQuery.js +15 -0
  168. package/lib/RawQuery.js.map +1 -1
  169. package/lib/Request.js +15 -0
  170. package/lib/Request.js.map +1 -1
  171. package/lib/Response.js +17 -0
  172. package/lib/Response.js.map +1 -1
  173. package/lib/ResponseData.js +15 -0
  174. package/lib/ResponseData.js.map +1 -1
  175. package/lib/ServiceProvider.js +20 -0
  176. package/lib/ServiceProvider.js.map +1 -1
  177. package/lib/ServiceResponse.js +15 -0
  178. package/lib/ServiceResponse.js.map +1 -1
  179. package/lib/SetSessionVariableQuery.js +1 -0
  180. package/lib/SetSessionVariableQuery.js.map +1 -1
  181. package/lib/StatusCode.js +15 -0
  182. package/lib/StatusCode.js.map +1 -1
  183. package/lib/StormError.d.ts +14 -0
  184. package/lib/StormError.js +32 -0
  185. package/lib/StormError.js.map +1 -1
  186. package/lib/TemporaryTableQuery.js +15 -0
  187. package/lib/TemporaryTableQuery.js.map +1 -1
  188. package/lib/Token.js +15 -0
  189. package/lib/Token.js.map +1 -1
  190. package/lib/TokenManager.js +17 -0
  191. package/lib/TokenManager.js.map +1 -1
  192. package/lib/UnauthorizedAccessError.d.ts +1 -0
  193. package/lib/UnauthorizedAccessError.js +18 -0
  194. package/lib/UnauthorizedAccessError.js.map +1 -1
  195. package/lib/api.d.ts +2 -0
  196. package/lib/api.js +28 -1
  197. package/lib/api.js.map +1 -1
  198. package/lib/instance.js +15 -0
  199. package/lib/instance.js.map +1 -1
  200. package/lib/private/CommitQuery.js +15 -0
  201. package/lib/private/CommitQuery.js.map +1 -1
  202. package/lib/private/RollbackQuery.js +15 -0
  203. package/lib/private/RollbackQuery.js.map +1 -1
  204. package/lib/private/StartTransactionQuery.js +15 -0
  205. package/lib/private/StartTransactionQuery.js.map +1 -1
  206. package/package.json +1 -1
  207. package/src/DatabaseQueryError.ts +4 -0
  208. package/src/DiskSpaceError.ts +4 -0
  209. package/src/DuplicateEntryError.ts +13 -0
  210. package/src/EntityNotFoundError.ts +10 -0
  211. package/src/ExpiredTokenError.ts +4 -0
  212. package/src/Handler.ts +10 -9
  213. package/src/InternalError.ts +4 -0
  214. package/src/InvalidCredentialsError.ts +4 -0
  215. package/src/InvalidValueError.ts +13 -0
  216. package/src/MissingConfigError.ts +10 -0
  217. package/src/MissingParameterError.ts +10 -0
  218. package/src/NotImplementedError.ts +55 -0
  219. package/src/Query.ts +8 -0
  220. package/src/RawError.ts +39 -0
  221. package/src/StormError.ts +18 -0
  222. package/src/UnauthorizedAccessError.ts +4 -0
  223. package/src/api.ts +2 -0
  224. package/tsconfig.json +0 -1
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
  }
package/src/api.ts CHANGED
@@ -38,6 +38,7 @@ export {SetSessionVariableQuery, ISetSessionVariableQueryInput} from './SetSessi
38
38
 
39
39
  // Errors
40
40
  export {ErrorCode} from './ErrorCode';
41
+ export {RawError} from './RawError';
41
42
  export {
42
43
  StormError,
43
44
  IErrorResponse,
@@ -55,6 +56,7 @@ export {DiskSpaceError} from './DiskSpaceError';
55
56
  export {DuplicateEntryError} from './DuplicateEntryError';
56
57
  export {MissingConfigError} from './MissingConfigError';
57
58
  export {DatabaseQueryError} from './DatabaseQueryError';
59
+ export {NotImplementedError} from './NotImplementedError';
58
60
 
59
61
  // HTTP
60
62
  export {StatusCode} from './StatusCode';
package/tsconfig.json CHANGED
@@ -5,7 +5,6 @@
5
5
  "declaration": true,
6
6
  "sourceMap": true,
7
7
  "outDir": "./lib/",
8
- "removeComments": true,
9
8
  "importHelpers": true,
10
9
  "noImplicitAny": true,
11
10
  "noImplicitThis": true,