@breautek/storm 4.0.0 → 4.1.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 (81) hide show
  1. package/CHANGELOG.md +11 -1
  2. package/bt-config-sample.jsonc +1 -1
  3. package/docs/README.md +6 -6
  4. package/docs/classes/Application.md +30 -30
  5. package/docs/classes/BackendAuthenticationMiddleware.md +2 -2
  6. package/docs/classes/CORSMiddleware.md +6 -6
  7. package/docs/classes/ConfigLoader.md +1 -1
  8. package/docs/classes/Database.md +12 -12
  9. package/docs/classes/DatabaseConnection.md +19 -19
  10. package/docs/classes/DatabaseQueryError.md +11 -11
  11. package/docs/classes/DiskSpaceError.md +11 -11
  12. package/docs/classes/DropTemporaryTableQuery.md +10 -10
  13. package/docs/classes/DumpStream.md +1 -1
  14. package/docs/classes/DuplicateEntryError.md +11 -11
  15. package/docs/classes/EntityNotFoundError.md +11 -11
  16. package/docs/classes/ExpiredTokenError.md +11 -11
  17. package/docs/classes/Handler.md +14 -14
  18. package/docs/classes/InternalError.md +11 -11
  19. package/docs/classes/InvalidCredentialsError.md +11 -11
  20. package/docs/classes/InvalidValueError.md +11 -11
  21. package/docs/classes/ManagedDatabaseConnection.md +19 -19
  22. package/docs/classes/Middleware.md +3 -3
  23. package/docs/classes/MissingConfigError.md +11 -11
  24. package/docs/classes/MissingParameterError.md +11 -11
  25. package/docs/classes/MySQLConnection.md +20 -20
  26. package/docs/classes/MySQLDatabase.md +14 -14
  27. package/docs/classes/Query.md +10 -10
  28. package/docs/classes/RawQuery.md +19 -17
  29. package/docs/classes/Request.md +18 -18
  30. package/docs/classes/Response.md +12 -12
  31. package/docs/classes/ResponseData.md +7 -7
  32. package/docs/classes/ServiceProvider.md +16 -16
  33. package/docs/classes/ServiceResponse.md +4 -4
  34. package/docs/classes/SetSessionVariableQuery.md +10 -10
  35. package/docs/classes/StormError.md +11 -11
  36. package/docs/classes/TemporaryTableQuery.md +10 -10
  37. package/docs/classes/Token.md +2 -2
  38. package/docs/classes/TokenManager.md +4 -4
  39. package/docs/classes/UnauthorizedAccessError.md +11 -11
  40. package/docs/enums/ErrorCode.md +20 -20
  41. package/docs/enums/ExitCode.md +6 -6
  42. package/docs/enums/HTTPMethod.md +10 -10
  43. package/docs/enums/JWTError.md +6 -6
  44. package/docs/enums/StatusCode.md +98 -98
  45. package/docs/interfaces/IConfig.md +8 -8
  46. package/docs/interfaces/IDatabaseConfig.md +6 -6
  47. package/docs/interfaces/IDatabaseConnection.md +15 -15
  48. package/docs/interfaces/IErrorResponse.md +4 -4
  49. package/docs/interfaces/IFormData.md +2 -2
  50. package/docs/interfaces/IHandler.md +1 -1
  51. package/docs/interfaces/IInsertQueryResult.md +3 -3
  52. package/docs/interfaces/IJWTVerifyOptions.md +1 -1
  53. package/docs/interfaces/IRequestResponse.md +2 -2
  54. package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
  55. package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
  56. package/docs/interfaces/IUpdateQueryResult.md +2 -2
  57. package/docs/interfaces/formidable.EmitData.md +1 -1
  58. package/docs/modules/formidable.md +2 -2
  59. package/lib/Database.js.map +1 -1
  60. package/lib/DatabaseConnection.js.map +1 -1
  61. package/lib/Query.d.ts +1 -2
  62. package/lib/Query.js.map +1 -1
  63. package/lib/RawQuery.d.ts +1 -1
  64. package/lib/RawQuery.js.map +1 -1
  65. package/lib/Request.d.ts +1 -0
  66. package/lib/Response.d.ts +1 -0
  67. package/lib/ServiceProvider.d.ts +1 -2
  68. package/lib/ServiceProvider.js.map +1 -1
  69. package/lib/ServiceResponse.d.ts +1 -0
  70. package/lib/SetSessionVariableQuery.d.ts +1 -2
  71. package/lib/SetSessionVariableQuery.js.map +1 -1
  72. package/lib/TemporaryTableQuery.d.ts +1 -2
  73. package/lib/TemporaryTableQuery.js.map +1 -1
  74. package/package.json +15 -16
  75. package/src/Database.ts +1 -2
  76. package/src/DatabaseConnection.ts +2 -3
  77. package/src/Query.ts +1 -2
  78. package/src/RawQuery.ts +1 -1
  79. package/src/ServiceProvider.ts +1 -2
  80. package/src/SetSessionVariableQuery.ts +1 -2
  81. package/src/TemporaryTableQuery.ts +2 -3
package/docs/classes/UnauthorizedAccessError.md CHANGED
@@ -51,7 +51,7 @@
51
51
 
52
52
  #### Defined in
53
53
 
54
- [src/UnauthorizedAccessError.ts:22](https://github.com/breautek/storm/blob/186ee78/src/UnauthorizedAccessError.ts#L22)
54
+ [src/UnauthorizedAccessError.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L22)
55
55
 
56
56
  ## Properties
57
57
 
@@ -65,7 +65,7 @@
65
65
 
66
66
  #### Defined in
67
67
 
68
- node_modules/typescript/lib/lib.es5.d.ts:1023
68
+ node_modules/typescript/lib/lib.es5.d.ts:1029
69
69
 
70
70
  ___
71
71
 
@@ -79,7 +79,7 @@ ___
79
79
 
80
80
  #### Defined in
81
81
 
82
- node_modules/typescript/lib/lib.es5.d.ts:1022
82
+ node_modules/typescript/lib/lib.es5.d.ts:1028
83
83
 
84
84
  ___
85
85
 
@@ -93,7 +93,7 @@ ___
93
93
 
94
94
  #### Defined in
95
95
 
96
- node_modules/typescript/lib/lib.es5.d.ts:1024
96
+ node_modules/typescript/lib/lib.es5.d.ts:1030
97
97
 
98
98
  ___
99
99
 
@@ -158,7 +158,7 @@ node_modules/@types/node/globals.d.ts:13
158
158
 
159
159
  #### Defined in
160
160
 
161
- [src/UnauthorizedAccessError.ts:30](https://github.com/breautek/storm/blob/186ee78/src/UnauthorizedAccessError.ts#L30)
161
+ [src/UnauthorizedAccessError.ts:30](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L30)
162
162
 
163
163
  ___
164
164
 
@@ -176,7 +176,7 @@ ___
176
176
 
177
177
  #### Defined in
178
178
 
179
- [src/StormError.ts:70](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L70)
179
+ [src/StormError.ts:70](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L70)
180
180
 
181
181
  ___
182
182
 
@@ -194,7 +194,7 @@ ___
194
194
 
195
195
  #### Defined in
196
196
 
197
- [src/StormError.ts:79](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L79)
197
+ [src/StormError.ts:79](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L79)
198
198
 
199
199
  ___
200
200
 
@@ -212,7 +212,7 @@ ___
212
212
 
213
213
  #### Defined in
214
214
 
215
- [src/UnauthorizedAccessError.ts:34](https://github.com/breautek/storm/blob/186ee78/src/UnauthorizedAccessError.ts#L34)
215
+ [src/UnauthorizedAccessError.ts:34](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L34)
216
216
 
217
217
  ___
218
218
 
@@ -230,7 +230,7 @@ ___
230
230
 
231
231
  #### Defined in
232
232
 
233
- [src/UnauthorizedAccessError.ts:26](https://github.com/breautek/storm/blob/186ee78/src/UnauthorizedAccessError.ts#L26)
233
+ [src/UnauthorizedAccessError.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L26)
234
234
 
235
235
  ___
236
236
 
@@ -251,7 +251,7 @@ They are kept secret from the client.
251
251
 
252
252
  #### Defined in
253
253
 
254
- [src/StormError.ts:62](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L62)
254
+ [src/StormError.ts:62](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L62)
255
255
 
256
256
  ___
257
257
 
@@ -271,7 +271,7 @@ Sends details to the client.
271
271
 
272
272
  #### Defined in
273
273
 
274
- [src/StormError.ts:54](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L54)
274
+ [src/StormError.ts:54](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L54)
275
275
 
276
276
  ___
277
277
 
package/docs/enums/ErrorCode.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Enumeration members
7
+ ### Enumeration Members
8
8
 
9
9
  - [DUPLICATE\_ENTRY](ErrorCode.md#duplicate_entry)
10
10
  - [EXPIRED\_TOKEN](ErrorCode.md#expired_token)
@@ -16,92 +16,92 @@
16
16
  - [MISSING\_PARAMETER](ErrorCode.md#missing_parameter)
17
17
  - [UNAUTHORIZED\_ACCESS](ErrorCode.md#unauthorized_access)
18
18
 
19
- ## Enumeration members
19
+ ## Enumeration Members
20
20
 
21
21
  ### DUPLICATE\_ENTRY
22
22
 
23
- • **DUPLICATE\_ENTRY** = `5`
23
+ • **DUPLICATE\_ENTRY**
24
24
 
25
25
  #### Defined in
26
26
 
27
- [src/ErrorCode.ts:23](https://github.com/breautek/storm/blob/186ee78/src/ErrorCode.ts#L23)
27
+ [src/ErrorCode.ts:23](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L23)
28
28
 
29
29
  ___
30
30
 
31
31
  ### EXPIRED\_TOKEN
32
32
 
33
- • **EXPIRED\_TOKEN** = `2`
33
+ • **EXPIRED\_TOKEN**
34
34
 
35
35
  #### Defined in
36
36
 
37
- [src/ErrorCode.ts:20](https://github.com/breautek/storm/blob/186ee78/src/ErrorCode.ts#L20)
37
+ [src/ErrorCode.ts:20](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L20)
38
38
 
39
39
  ___
40
40
 
41
41
  ### INSUFFICIENT\_DISK\_SPACE
42
42
 
43
- • **INSUFFICIENT\_DISK\_SPACE** = `7`
43
+ • **INSUFFICIENT\_DISK\_SPACE**
44
44
 
45
45
  #### Defined in
46
46
 
47
- [src/ErrorCode.ts:25](https://github.com/breautek/storm/blob/186ee78/src/ErrorCode.ts#L25)
47
+ [src/ErrorCode.ts:25](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L25)
48
48
 
49
49
  ___
50
50
 
51
51
  ### INTERNAL
52
52
 
53
- • **INTERNAL** = `0`
53
+ • **INTERNAL**
54
54
 
55
55
  #### Defined in
56
56
 
57
- [src/ErrorCode.ts:18](https://github.com/breautek/storm/blob/186ee78/src/ErrorCode.ts#L18)
57
+ [src/ErrorCode.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L18)
58
58
 
59
59
  ___
60
60
 
61
61
  ### INVALID\_CONFIG
62
62
 
63
- • **INVALID\_CONFIG** = `8`
63
+ • **INVALID\_CONFIG**
64
64
 
65
65
  #### Defined in
66
66
 
67
- [src/ErrorCode.ts:26](https://github.com/breautek/storm/blob/186ee78/src/ErrorCode.ts#L26)
67
+ [src/ErrorCode.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L26)
68
68
 
69
69
  ___
70
70
 
71
71
  ### INVALID\_CREDENTIALS
72
72
 
73
- • **INVALID\_CREDENTIALS** = `3`
73
+ • **INVALID\_CREDENTIALS**
74
74
 
75
75
  #### Defined in
76
76
 
77
- [src/ErrorCode.ts:21](https://github.com/breautek/storm/blob/186ee78/src/ErrorCode.ts#L21)
77
+ [src/ErrorCode.ts:21](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L21)
78
78
 
79
79
  ___
80
80
 
81
81
  ### INVALID\_VALUE
82
82
 
83
- • **INVALID\_VALUE** = `4`
83
+ • **INVALID\_VALUE**
84
84
 
85
85
  #### Defined in
86
86
 
87
- [src/ErrorCode.ts:22](https://github.com/breautek/storm/blob/186ee78/src/ErrorCode.ts#L22)
87
+ [src/ErrorCode.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L22)
88
88
 
89
89
  ___
90
90
 
91
91
  ### MISSING\_PARAMETER
92
92
 
93
- • **MISSING\_PARAMETER** = `1`
93
+ • **MISSING\_PARAMETER**
94
94
 
95
95
  #### Defined in
96
96
 
97
- [src/ErrorCode.ts:19](https://github.com/breautek/storm/blob/186ee78/src/ErrorCode.ts#L19)
97
+ [src/ErrorCode.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L19)
98
98
 
99
99
  ___
100
100
 
101
101
  ### UNAUTHORIZED\_ACCESS
102
102
 
103
- • **UNAUTHORIZED\_ACCESS** = `6`
103
+ • **UNAUTHORIZED\_ACCESS**
104
104
 
105
105
  #### Defined in
106
106
 
107
- [src/ErrorCode.ts:24](https://github.com/breautek/storm/blob/186ee78/src/ErrorCode.ts#L24)
107
+ [src/ErrorCode.ts:24](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L24)
package/docs/enums/ExitCode.md CHANGED
@@ -4,27 +4,27 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Enumeration members
7
+ ### Enumeration Members
8
8
 
9
9
  - [INVALID\_CONFIG](ExitCode.md#invalid_config)
10
10
  - [MISSING\_CONFIG](ExitCode.md#missing_config)
11
11
 
12
- ## Enumeration members
12
+ ## Enumeration Members
13
13
 
14
14
  ### INVALID\_CONFIG
15
15
 
16
- • **INVALID\_CONFIG** = `2`
16
+ • **INVALID\_CONFIG**
17
17
 
18
18
  #### Defined in
19
19
 
20
- [src/ExitCode.ts:19](https://github.com/breautek/storm/blob/186ee78/src/ExitCode.ts#L19)
20
+ [src/ExitCode.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/ExitCode.ts#L19)
21
21
 
22
22
  ___
23
23
 
24
24
  ### MISSING\_CONFIG
25
25
 
26
- • **MISSING\_CONFIG** = `1`
26
+ • **MISSING\_CONFIG**
27
27
 
28
28
  #### Defined in
29
29
 
30
- [src/ExitCode.ts:18](https://github.com/breautek/storm/blob/186ee78/src/ExitCode.ts#L18)
30
+ [src/ExitCode.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/ExitCode.ts#L18)
package/docs/enums/HTTPMethod.md CHANGED
@@ -4,49 +4,49 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Enumeration members
7
+ ### Enumeration Members
8
8
 
9
9
  - [DELETE](HTTPMethod.md#delete)
10
10
  - [GET](HTTPMethod.md#get)
11
11
  - [POST](HTTPMethod.md#post)
12
12
  - [PUT](HTTPMethod.md#put)
13
13
 
14
- ## Enumeration members
14
+ ## Enumeration Members
15
15
 
16
16
  ### DELETE
17
17
 
18
- • **DELETE** = `"DELETE"`
18
+ • **DELETE**
19
19
 
20
20
  #### Defined in
21
21
 
22
- [src/HTTPMethod.ts:21](https://github.com/breautek/storm/blob/186ee78/src/HTTPMethod.ts#L21)
22
+ [src/HTTPMethod.ts:21](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L21)
23
23
 
24
24
  ___
25
25
 
26
26
  ### GET
27
27
 
28
- • **GET** = `"GET"`
28
+ • **GET**
29
29
 
30
30
  #### Defined in
31
31
 
32
- [src/HTTPMethod.ts:18](https://github.com/breautek/storm/blob/186ee78/src/HTTPMethod.ts#L18)
32
+ [src/HTTPMethod.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L18)
33
33
 
34
34
  ___
35
35
 
36
36
  ### POST
37
37
 
38
- • **POST** = `"POST"`
38
+ • **POST**
39
39
 
40
40
  #### Defined in
41
41
 
42
- [src/HTTPMethod.ts:19](https://github.com/breautek/storm/blob/186ee78/src/HTTPMethod.ts#L19)
42
+ [src/HTTPMethod.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L19)
43
43
 
44
44
  ___
45
45
 
46
46
  ### PUT
47
47
 
48
- • **PUT** = `"PUT"`
48
+ • **PUT**
49
49
 
50
50
  #### Defined in
51
51
 
52
- [src/HTTPMethod.ts:20](https://github.com/breautek/storm/blob/186ee78/src/HTTPMethod.ts#L20)
52
+ [src/HTTPMethod.ts:20](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L20)
package/docs/enums/JWTError.md CHANGED
@@ -4,27 +4,27 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Enumeration members
7
+ ### Enumeration Members
8
8
 
9
9
  - [ERR\_EXPIRED](JWTError.md#err_expired)
10
10
  - [ERR\_GENERIC](JWTError.md#err_generic)
11
11
 
12
- ## Enumeration members
12
+ ## Enumeration Members
13
13
 
14
14
  ### ERR\_EXPIRED
15
15
 
16
- • **ERR\_EXPIRED** = `"TokenExpiredError"`
16
+ • **ERR\_EXPIRED**
17
17
 
18
18
  #### Defined in
19
19
 
20
- [src/JWTError.ts:18](https://github.com/breautek/storm/blob/186ee78/src/JWTError.ts#L18)
20
+ [src/JWTError.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/JWTError.ts#L18)
21
21
 
22
22
  ___
23
23
 
24
24
  ### ERR\_GENERIC
25
25
 
26
- • **ERR\_GENERIC** = `"JsonWebTokenError"`
26
+ • **ERR\_GENERIC**
27
27
 
28
28
  #### Defined in
29
29
 
30
- [src/JWTError.ts:19](https://github.com/breautek/storm/blob/186ee78/src/JWTError.ts#L19)
30
+ [src/JWTError.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/JWTError.ts#L19)