@breautek/storm 4.2.0 → 4.4.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 (126) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/docs/README.md +28 -20
  3. package/docs/classes/Application.md +158 -76
  4. package/docs/classes/BackendAuthenticationMiddleware.md +3 -3
  5. package/docs/classes/CORSMiddleware.md +8 -8
  6. package/docs/classes/ConfigLoader.md +1 -1
  7. package/docs/classes/Database.md +12 -12
  8. package/docs/classes/DatabaseConnection.md +42 -40
  9. package/docs/classes/DatabaseQueryError.md +58 -16
  10. package/docs/classes/DeadLockError.md +349 -0
  11. package/docs/classes/DiskSpaceError.md +56 -16
  12. package/docs/classes/DropTemporaryTableQuery.md +8 -8
  13. package/docs/classes/DumpStream.md +1 -1
  14. package/docs/classes/DuplicateEntryError.md +56 -16
  15. package/docs/classes/EntityNotFoundError.md +56 -16
  16. package/docs/classes/ExpiredTokenError.md +56 -16
  17. package/docs/classes/Handler.md +14 -14
  18. package/docs/classes/InternalError.md +56 -16
  19. package/docs/classes/InvalidCredentialsError.md +56 -16
  20. package/docs/classes/InvalidValueError.md +56 -16
  21. package/docs/classes/ManagedDatabaseConnection.md +19 -19
  22. package/docs/classes/Middleware.md +3 -3
  23. package/docs/classes/MissingConfigError.md +56 -16
  24. package/docs/classes/MissingParameterError.md +56 -16
  25. package/docs/classes/MySQLConnection.md +73 -43
  26. package/docs/classes/MySQLDatabase.md +13 -13
  27. package/docs/classes/NotImplementedError.md +56 -16
  28. package/docs/classes/Query.md +8 -8
  29. package/docs/classes/RawError.md +56 -18
  30. package/docs/classes/RawQuery.md +8 -8
  31. package/docs/classes/Request.md +18 -18
  32. package/docs/classes/Response.md +11 -11
  33. package/docs/classes/ResponseData.md +7 -7
  34. package/docs/classes/ServiceProvider.md +15 -15
  35. package/docs/classes/ServiceResponse.md +4 -4
  36. package/docs/classes/SetSessionVariableQuery.md +8 -8
  37. package/docs/classes/StormError.md +48 -16
  38. package/docs/classes/TemporaryTableQuery.md +8 -8
  39. package/docs/classes/Token.md +2 -2
  40. package/docs/classes/TokenManager.md +4 -4
  41. package/docs/classes/UnauthorizedAccessError.md +56 -16
  42. package/docs/enums/ErrorCode.md +18 -18
  43. package/docs/enums/ExitCode.md +4 -4
  44. package/docs/enums/HTTPMethod.md +8 -8
  45. package/docs/enums/JWTError.md +4 -4
  46. package/docs/enums/StatusCode.md +96 -96
  47. package/docs/interfaces/IConfig.md +8 -8
  48. package/docs/interfaces/IDatabaseConfig.md +6 -6
  49. package/docs/interfaces/IDatabaseConnection.md +14 -14
  50. package/docs/interfaces/IErrorResponse.md +15 -4
  51. package/docs/interfaces/IFormData.md +2 -2
  52. package/docs/interfaces/IHandler.md +1 -1
  53. package/docs/interfaces/IInsertQueryResult.md +3 -3
  54. package/docs/interfaces/IJWTVerifyOptions.md +1 -1
  55. package/docs/interfaces/IRequestResponse.md +2 -2
  56. package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
  57. package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
  58. package/docs/interfaces/IUpdateQueryResult.md +2 -2
  59. package/docs/interfaces/formidable.File.md +3 -1
  60. package/docs/interfaces/formidable.FileJSON.md +3 -1
  61. package/docs/interfaces/formidable.Options.md +33 -11
  62. package/docs/interfaces/formidable.Part.md +65 -35
  63. package/lib/DatabaseQueryError.d.ts +1 -0
  64. package/lib/DatabaseQueryError.js +3 -0
  65. package/lib/DatabaseQueryError.js.map +1 -1
  66. package/lib/DeadLockError.d.ts +6 -0
  67. package/lib/DeadLockError.js +26 -0
  68. package/lib/DeadLockError.js.map +1 -0
  69. package/lib/DiskSpaceError.d.ts +1 -0
  70. package/lib/DiskSpaceError.js +3 -0
  71. package/lib/DiskSpaceError.js.map +1 -1
  72. package/lib/DuplicateEntryError.d.ts +2 -0
  73. package/lib/DuplicateEntryError.js +11 -0
  74. package/lib/DuplicateEntryError.js.map +1 -1
  75. package/lib/EntityNotFoundError.d.ts +2 -0
  76. package/lib/EntityNotFoundError.js +8 -0
  77. package/lib/EntityNotFoundError.js.map +1 -1
  78. package/lib/ExpiredTokenError.d.ts +1 -0
  79. package/lib/ExpiredTokenError.js +3 -0
  80. package/lib/ExpiredTokenError.js.map +1 -1
  81. package/lib/InternalError.d.ts +1 -0
  82. package/lib/InternalError.js +3 -0
  83. package/lib/InternalError.js.map +1 -1
  84. package/lib/InvalidCredentialsError.d.ts +1 -0
  85. package/lib/InvalidCredentialsError.js +3 -0
  86. package/lib/InvalidCredentialsError.js.map +1 -1
  87. package/lib/InvalidValueError.d.ts +2 -0
  88. package/lib/InvalidValueError.js +11 -0
  89. package/lib/InvalidValueError.js.map +1 -1
  90. package/lib/MissingConfigError.d.ts +2 -0
  91. package/lib/MissingConfigError.js +8 -0
  92. package/lib/MissingConfigError.js.map +1 -1
  93. package/lib/MissingParameterError.d.ts +2 -0
  94. package/lib/MissingParameterError.js +8 -0
  95. package/lib/MissingParameterError.js.map +1 -1
  96. package/lib/MySQLConnection.js +9 -1
  97. package/lib/MySQLConnection.js.map +1 -1
  98. package/lib/NotImplementedError.d.ts +2 -0
  99. package/lib/NotImplementedError.js +8 -0
  100. package/lib/NotImplementedError.js.map +1 -1
  101. package/lib/StormError.d.ts +7 -0
  102. package/lib/StormError.js +10 -0
  103. package/lib/StormError.js.map +1 -1
  104. package/lib/UnauthorizedAccessError.d.ts +1 -0
  105. package/lib/UnauthorizedAccessError.js +3 -0
  106. package/lib/UnauthorizedAccessError.js.map +1 -1
  107. package/lib/api.d.ts +1 -0
  108. package/lib/api.js +3 -1
  109. package/lib/api.js.map +1 -1
  110. package/package.json +19 -18
  111. package/src/DatabaseQueryError.ts +4 -0
  112. package/src/DeadLockError.ts +22 -0
  113. package/src/DiskSpaceError.ts +4 -0
  114. package/src/DuplicateEntryError.ts +13 -0
  115. package/src/EntityNotFoundError.ts +10 -0
  116. package/src/ExpiredTokenError.ts +4 -0
  117. package/src/InternalError.ts +4 -0
  118. package/src/InvalidCredentialsError.ts +4 -0
  119. package/src/InvalidValueError.ts +13 -0
  120. package/src/MissingConfigError.ts +10 -0
  121. package/src/MissingParameterError.ts +10 -0
  122. package/src/MySQLConnection.ts +11 -1
  123. package/src/NotImplementedError.ts +10 -0
  124. package/src/StormError.ts +18 -0
  125. package/src/UnauthorizedAccessError.ts +4 -0
  126. package/src/api.ts +1 -0
@@ -28,6 +28,8 @@
28
28
  - [getErrorResponse](UnauthorizedAccessError.md#geterrorresponse)
29
29
  - [getExitCode](UnauthorizedAccessError.md#getexitcode)
30
30
  - [getHTTPCode](UnauthorizedAccessError.md#gethttpcode)
31
+ - [getLocaleCode](UnauthorizedAccessError.md#getlocalecode)
32
+ - [getLocaleParameters](UnauthorizedAccessError.md#getlocaleparameters)
31
33
  - [getMessage](UnauthorizedAccessError.md#getmessage)
32
34
  - [getPrivateDetails](UnauthorizedAccessError.md#getprivatedetails)
33
35
  - [getPublicDetails](UnauthorizedAccessError.md#getpublicdetails)
@@ -51,7 +53,7 @@
51
53
 
52
54
  #### Defined in
53
55
 
54
- [src/UnauthorizedAccessError.ts:22](https://github.com/breautek/storm/blob/f198938/src/UnauthorizedAccessError.ts#L22)
56
+ [src/UnauthorizedAccessError.ts:22](https://github.com/breautek/storm/blob/0875c73/src/UnauthorizedAccessError.ts#L22)
55
57
 
56
58
  ## Properties
57
59
 
@@ -65,7 +67,7 @@
65
67
 
66
68
  #### Defined in
67
69
 
68
- node_modules/typescript/lib/lib.es5.d.ts:1029
70
+ node_modules/typescript/lib/lib.es5.d.ts:1041
69
71
 
70
72
  ___
71
73
 
@@ -79,7 +81,7 @@ ___
79
81
 
80
82
  #### Defined in
81
83
 
82
- node_modules/typescript/lib/lib.es5.d.ts:1028
84
+ node_modules/typescript/lib/lib.es5.d.ts:1040
83
85
 
84
86
  ___
85
87
 
@@ -93,7 +95,7 @@ ___
93
95
 
94
96
  #### Defined in
95
97
 
96
- node_modules/typescript/lib/lib.es5.d.ts:1030
98
+ node_modules/typescript/lib/lib.es5.d.ts:1042
97
99
 
98
100
  ___
99
101
 
@@ -107,7 +109,9 @@ ___
107
109
 
108
110
  Optional override for formatting stack traces
109
111
 
110
- **`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
112
+ **`See`**
113
+
114
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
111
115
 
112
116
  ##### Parameters
113
117
 
@@ -126,7 +130,7 @@ Optional override for formatting stack traces
126
130
 
127
131
  #### Defined in
128
132
 
129
- node_modules/@types/node/globals.d.ts:11
133
+ node_modules/@types/node/ts4.8/globals.d.ts:11
130
134
 
131
135
  ___
132
136
 
@@ -140,7 +144,7 @@ ___
140
144
 
141
145
  #### Defined in
142
146
 
143
- node_modules/@types/node/globals.d.ts:13
147
+ node_modules/@types/node/ts4.8/globals.d.ts:13
144
148
 
145
149
  ## Methods
146
150
 
@@ -158,7 +162,7 @@ node_modules/@types/node/globals.d.ts:13
158
162
 
159
163
  #### Defined in
160
164
 
161
- [src/UnauthorizedAccessError.ts:30](https://github.com/breautek/storm/blob/f198938/src/UnauthorizedAccessError.ts#L30)
165
+ [src/UnauthorizedAccessError.ts:30](https://github.com/breautek/storm/blob/0875c73/src/UnauthorizedAccessError.ts#L30)
162
166
 
163
167
  ___
164
168
 
@@ -176,7 +180,7 @@ ___
176
180
 
177
181
  #### Defined in
178
182
 
179
- [src/StormError.ts:70](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L70)
183
+ [src/StormError.ts:76](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L76)
180
184
 
181
185
  ___
182
186
 
@@ -194,7 +198,7 @@ ___
194
198
 
195
199
  #### Defined in
196
200
 
197
- [src/StormError.ts:79](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L79)
201
+ [src/StormError.ts:97](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L97)
198
202
 
199
203
  ___
200
204
 
@@ -212,7 +216,43 @@ ___
212
216
 
213
217
  #### Defined in
214
218
 
215
- [src/UnauthorizedAccessError.ts:34](https://github.com/breautek/storm/blob/f198938/src/UnauthorizedAccessError.ts#L34)
219
+ [src/UnauthorizedAccessError.ts:34](https://github.com/breautek/storm/blob/0875c73/src/UnauthorizedAccessError.ts#L34)
220
+
221
+ ___
222
+
223
+ ### getLocaleCode
224
+
225
+ ▸ **getLocaleCode**(): `string`
226
+
227
+ #### Returns
228
+
229
+ `string`
230
+
231
+ #### Overrides
232
+
233
+ [StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
234
+
235
+ #### Defined in
236
+
237
+ [src/UnauthorizedAccessError.ts:38](https://github.com/breautek/storm/blob/0875c73/src/UnauthorizedAccessError.ts#L38)
238
+
239
+ ___
240
+
241
+ ### getLocaleParameters
242
+
243
+ ▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
244
+
245
+ #### Returns
246
+
247
+ `Record`<`string`, `string`\>
248
+
249
+ #### Inherited from
250
+
251
+ [StormError](StormError.md).[getLocaleParameters](StormError.md#getlocaleparameters)
252
+
253
+ #### Defined in
254
+
255
+ [src/StormError.ts:93](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L93)
216
256
 
217
257
  ___
218
258
 
@@ -230,7 +270,7 @@ ___
230
270
 
231
271
  #### Defined in
232
272
 
233
- [src/UnauthorizedAccessError.ts:26](https://github.com/breautek/storm/blob/f198938/src/UnauthorizedAccessError.ts#L26)
273
+ [src/UnauthorizedAccessError.ts:26](https://github.com/breautek/storm/blob/0875c73/src/UnauthorizedAccessError.ts#L26)
234
274
 
235
275
  ___
236
276
 
@@ -238,7 +278,7 @@ ___
238
278
 
239
279
  ▸ **getPrivateDetails**(): `any`
240
280
 
241
- Private details are only logged to the server log.
281
+ Private details are only logged to the server log.
242
282
  They are kept secret from the client.
243
283
 
244
284
  #### Returns
@@ -251,7 +291,7 @@ They are kept secret from the client.
251
291
 
252
292
  #### Defined in
253
293
 
254
- [src/StormError.ts:62](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L62)
294
+ [src/StormError.ts:68](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L68)
255
295
 
256
296
  ___
257
297
 
@@ -271,7 +311,7 @@ Sends details to the client.
271
311
 
272
312
  #### Defined in
273
313
 
274
- [src/StormError.ts:54](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L54)
314
+ [src/StormError.ts:60](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L60)
275
315
 
276
316
  ___
277
317
 
@@ -298,4 +338,4 @@ Create .stack property on a target object
298
338
 
299
339
  #### Defined in
300
340
 
301
- node_modules/@types/node/globals.d.ts:4
341
+ node_modules/@types/node/ts4.8/globals.d.ts:4
@@ -20,88 +20,88 @@
20
20
 
21
21
  ### DUPLICATE\_ENTRY
22
22
 
23
- • **DUPLICATE\_ENTRY**
23
+ • **DUPLICATE\_ENTRY** = ``5``
24
24
 
25
25
  #### Defined in
26
26
 
27
- [src/ErrorCode.ts:23](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L23)
27
+ [src/ErrorCode.ts:23](https://github.com/breautek/storm/blob/0875c73/src/ErrorCode.ts#L23)
28
28
 
29
29
  ___
30
30
 
31
31
  ### EXPIRED\_TOKEN
32
32
 
33
- • **EXPIRED\_TOKEN**
33
+ • **EXPIRED\_TOKEN** = ``2``
34
34
 
35
35
  #### Defined in
36
36
 
37
- [src/ErrorCode.ts:20](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L20)
37
+ [src/ErrorCode.ts:20](https://github.com/breautek/storm/blob/0875c73/src/ErrorCode.ts#L20)
38
38
 
39
39
  ___
40
40
 
41
41
  ### INSUFFICIENT\_DISK\_SPACE
42
42
 
43
- • **INSUFFICIENT\_DISK\_SPACE**
43
+ • **INSUFFICIENT\_DISK\_SPACE** = ``7``
44
44
 
45
45
  #### Defined in
46
46
 
47
- [src/ErrorCode.ts:25](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L25)
47
+ [src/ErrorCode.ts:25](https://github.com/breautek/storm/blob/0875c73/src/ErrorCode.ts#L25)
48
48
 
49
49
  ___
50
50
 
51
51
  ### INTERNAL
52
52
 
53
- • **INTERNAL**
53
+ • **INTERNAL** = ``0``
54
54
 
55
55
  #### Defined in
56
56
 
57
- [src/ErrorCode.ts:18](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L18)
57
+ [src/ErrorCode.ts:18](https://github.com/breautek/storm/blob/0875c73/src/ErrorCode.ts#L18)
58
58
 
59
59
  ___
60
60
 
61
61
  ### INVALID\_CONFIG
62
62
 
63
- • **INVALID\_CONFIG**
63
+ • **INVALID\_CONFIG** = ``8``
64
64
 
65
65
  #### Defined in
66
66
 
67
- [src/ErrorCode.ts:26](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L26)
67
+ [src/ErrorCode.ts:26](https://github.com/breautek/storm/blob/0875c73/src/ErrorCode.ts#L26)
68
68
 
69
69
  ___
70
70
 
71
71
  ### INVALID\_CREDENTIALS
72
72
 
73
- • **INVALID\_CREDENTIALS**
73
+ • **INVALID\_CREDENTIALS** = ``3``
74
74
 
75
75
  #### Defined in
76
76
 
77
- [src/ErrorCode.ts:21](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L21)
77
+ [src/ErrorCode.ts:21](https://github.com/breautek/storm/blob/0875c73/src/ErrorCode.ts#L21)
78
78
 
79
79
  ___
80
80
 
81
81
  ### INVALID\_VALUE
82
82
 
83
- • **INVALID\_VALUE**
83
+ • **INVALID\_VALUE** = ``4``
84
84
 
85
85
  #### Defined in
86
86
 
87
- [src/ErrorCode.ts:22](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L22)
87
+ [src/ErrorCode.ts:22](https://github.com/breautek/storm/blob/0875c73/src/ErrorCode.ts#L22)
88
88
 
89
89
  ___
90
90
 
91
91
  ### MISSING\_PARAMETER
92
92
 
93
- • **MISSING\_PARAMETER**
93
+ • **MISSING\_PARAMETER** = ``1``
94
94
 
95
95
  #### Defined in
96
96
 
97
- [src/ErrorCode.ts:19](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L19)
97
+ [src/ErrorCode.ts:19](https://github.com/breautek/storm/blob/0875c73/src/ErrorCode.ts#L19)
98
98
 
99
99
  ___
100
100
 
101
101
  ### UNAUTHORIZED\_ACCESS
102
102
 
103
- • **UNAUTHORIZED\_ACCESS**
103
+ • **UNAUTHORIZED\_ACCESS** = ``6``
104
104
 
105
105
  #### Defined in
106
106
 
107
- [src/ErrorCode.ts:24](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L24)
107
+ [src/ErrorCode.ts:24](https://github.com/breautek/storm/blob/0875c73/src/ErrorCode.ts#L24)
@@ -13,18 +13,18 @@
13
13
 
14
14
  ### INVALID\_CONFIG
15
15
 
16
- • **INVALID\_CONFIG**
16
+ • **INVALID\_CONFIG** = ``2``
17
17
 
18
18
  #### Defined in
19
19
 
20
- [src/ExitCode.ts:19](https://github.com/breautek/storm/blob/f198938/src/ExitCode.ts#L19)
20
+ [src/ExitCode.ts:19](https://github.com/breautek/storm/blob/0875c73/src/ExitCode.ts#L19)
21
21
 
22
22
  ___
23
23
 
24
24
  ### MISSING\_CONFIG
25
25
 
26
- • **MISSING\_CONFIG**
26
+ • **MISSING\_CONFIG** = ``1``
27
27
 
28
28
  #### Defined in
29
29
 
30
- [src/ExitCode.ts:18](https://github.com/breautek/storm/blob/f198938/src/ExitCode.ts#L18)
30
+ [src/ExitCode.ts:18](https://github.com/breautek/storm/blob/0875c73/src/ExitCode.ts#L18)
@@ -15,38 +15,38 @@
15
15
 
16
16
  ### DELETE
17
17
 
18
- • **DELETE**
18
+ • **DELETE** = ``"DELETE"``
19
19
 
20
20
  #### Defined in
21
21
 
22
- [src/HTTPMethod.ts:21](https://github.com/breautek/storm/blob/f198938/src/HTTPMethod.ts#L21)
22
+ [src/HTTPMethod.ts:21](https://github.com/breautek/storm/blob/0875c73/src/HTTPMethod.ts#L21)
23
23
 
24
24
  ___
25
25
 
26
26
  ### GET
27
27
 
28
- • **GET**
28
+ • **GET** = ``"GET"``
29
29
 
30
30
  #### Defined in
31
31
 
32
- [src/HTTPMethod.ts:18](https://github.com/breautek/storm/blob/f198938/src/HTTPMethod.ts#L18)
32
+ [src/HTTPMethod.ts:18](https://github.com/breautek/storm/blob/0875c73/src/HTTPMethod.ts#L18)
33
33
 
34
34
  ___
35
35
 
36
36
  ### POST
37
37
 
38
- • **POST**
38
+ • **POST** = ``"POST"``
39
39
 
40
40
  #### Defined in
41
41
 
42
- [src/HTTPMethod.ts:19](https://github.com/breautek/storm/blob/f198938/src/HTTPMethod.ts#L19)
42
+ [src/HTTPMethod.ts:19](https://github.com/breautek/storm/blob/0875c73/src/HTTPMethod.ts#L19)
43
43
 
44
44
  ___
45
45
 
46
46
  ### PUT
47
47
 
48
- • **PUT**
48
+ • **PUT** = ``"PUT"``
49
49
 
50
50
  #### Defined in
51
51
 
52
- [src/HTTPMethod.ts:20](https://github.com/breautek/storm/blob/f198938/src/HTTPMethod.ts#L20)
52
+ [src/HTTPMethod.ts:20](https://github.com/breautek/storm/blob/0875c73/src/HTTPMethod.ts#L20)
@@ -13,18 +13,18 @@
13
13
 
14
14
  ### ERR\_EXPIRED
15
15
 
16
- • **ERR\_EXPIRED**
16
+ • **ERR\_EXPIRED** = ``"TokenExpiredError"``
17
17
 
18
18
  #### Defined in
19
19
 
20
- [src/JWTError.ts:18](https://github.com/breautek/storm/blob/f198938/src/JWTError.ts#L18)
20
+ [src/JWTError.ts:18](https://github.com/breautek/storm/blob/0875c73/src/JWTError.ts#L18)
21
21
 
22
22
  ___
23
23
 
24
24
  ### ERR\_GENERIC
25
25
 
26
- • **ERR\_GENERIC**
26
+ • **ERR\_GENERIC** = ``"JsonWebTokenError"``
27
27
 
28
28
  #### Defined in
29
29
 
30
- [src/JWTError.ts:19](https://github.com/breautek/storm/blob/f198938/src/JWTError.ts#L19)
30
+ [src/JWTError.ts:19](https://github.com/breautek/storm/blob/0875c73/src/JWTError.ts#L19)