@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
package/CHANGELOG.md CHANGED
@@ -4,8 +4,22 @@ All notable changes to this project will be documented in this file. Dates are d
4
4
 
5
5
  Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
6
6
 
7
+ #### [v4.4.0](https://github.com/breautek/storm/compare/v4.3.0...v4.4.0)
8
+
9
+ - deproll [`907ede4`](https://github.com/breautek/storm/commit/907ede443ad3c264f4f1a119ad4a0a2589c5e834)
10
+ - deproll [`0875c73`](https://github.com/breautek/storm/commit/0875c7303e19fc1b1d69afb292d72a7bbedcdfd3)
11
+ - feat: DeadLockError [`8535a1e`](https://github.com/breautek/storm/commit/8535a1e15fd11f095aed64f79dab2245bae0e92b)
12
+
13
+ #### [v4.3.0](https://github.com/breautek/storm/compare/v4.2.0...v4.3.0)
14
+
15
+ > 14 October 2022
16
+
17
+ - feat Error locale keys [`4ac2f44`](https://github.com/breautek/storm/commit/4ac2f44a5f2e5bec81f049e7ea90e91159e8c9d1)
18
+
7
19
  #### [v4.2.0](https://github.com/breautek/storm/compare/v4.1.0...v4.2.0)
8
20
 
21
+ > 3 October 2022
22
+
9
23
  - Undid debug code making its way into master from PR #52, https://github.com/breautek/storm/pull/52. [`#54`](https://github.com/breautek/storm/pull/54)
10
24
  - Added NotImplementedError. [`#52`](https://github.com/breautek/storm/pull/52)
11
25
  - Clarify getParameters and getParametersForQuery [`#51`](https://github.com/breautek/storm/pull/51)
package/docs/README.md CHANGED
@@ -25,6 +25,7 @@
25
25
  - [Database](classes/Database.md)
26
26
  - [DatabaseConnection](classes/DatabaseConnection.md)
27
27
  - [DatabaseQueryError](classes/DatabaseQueryError.md)
28
+ - [DeadLockError](classes/DeadLockError.md)
28
29
  - [DiskSpaceError](classes/DiskSpaceError.md)
29
30
  - [DropTemporaryTableQuery](classes/DropTemporaryTableQuery.md)
30
31
  - [DumpStream](classes/DumpStream.md)
@@ -82,12 +83,9 @@
82
83
  - [IHandlerError](README.md#ihandlererror)
83
84
  - [IHandlerResponse](README.md#ihandlerresponse)
84
85
 
85
- ### Variables
86
-
87
- - [formidable](README.md#formidable)
88
-
89
86
  ### Functions
90
87
 
88
+ - [formidable](README.md#formidable)
91
89
  - [getInstance](README.md#getinstance)
92
90
 
93
91
  ## Type Aliases
@@ -98,7 +96,7 @@
98
96
 
99
97
  #### Defined in
100
98
 
101
- [src/IDeleteQueryResult.ts:19](https://github.com/breautek/storm/blob/f198938/src/IDeleteQueryResult.ts#L19)
99
+ [src/IDeleteQueryResult.ts:19](https://github.com/breautek/storm/blob/0875c73/src/IDeleteQueryResult.ts#L19)
102
100
 
103
101
  ___
104
102
 
@@ -106,15 +104,15 @@ ___
106
104
 
107
105
  Ƭ **IHandlerError**: [`StormError`](classes/StormError.md) \| `Error` \| `any`
108
106
 
109
- Like IHandlerResponse, an IHandlerError can be any arbitrary type of object,
107
+ Like IHandlerResponse, an IHandlerError can be any arbitrary type of object,
110
108
  however it's recommended that the type be of a StormError.
111
109
 
112
- If the type is not a StormError, the error will be wrapped in an InternalError object.
110
+ If the type is not a StormError, the error will be wrapped in an InternalError object.
113
111
  This is to avoid accidental leakage of privilege data (e.g. snippets of database queries with sensitive information)
114
112
 
115
113
  #### Defined in
116
114
 
117
- [src/Handler.ts:55](https://github.com/breautek/storm/blob/f198938/src/Handler.ts#L55)
115
+ [src/Handler.ts:55](https://github.com/breautek/storm/blob/0875c73/src/Handler.ts#L55)
118
116
 
119
117
  ___
120
118
 
@@ -122,31 +120,41 @@ ___
122
120
 
123
121
  Ƭ **IHandlerResponse**: [`ResponseData`](classes/ResponseData.md) \| `ReadableStream` \| `ReadStream` \| `any` \| `void`
124
122
 
125
- IHandlerResponse can actually accept any arbitrary object, however it may do
123
+ IHandlerResponse can actually accept any arbitrary object, however it may do
126
124
  certain things depending on the type of object it receives.
127
125
 
128
- - If the response object is a stream, it will pipe the stream to stream the HTTP response.
129
- - If the response is ResponseData, the status code and response data will be passed as the HTTP response.
130
- - Passing nothing/undefined will return a status code of 204 with no body content
131
- - Primitive data types will be passed as is
132
- - Buffers will be passed through
126
+ - If the response object is a stream, it will pipe the stream to stream the HTTP response.
127
+ - If the response is ResponseData, the status code and response data will be passed as the HTTP response.
128
+ - Passing nothing/undefined will return a status code of 204 with no body content
129
+ - Primitive data types will be passed as is
130
+ - Buffers will be passed through
133
131
  - Any other object will be passed through JSON.stringify
134
132
 
135
133
  #### Defined in
136
134
 
137
- [src/Handler.ts:46](https://github.com/breautek/storm/blob/f198938/src/Handler.ts#L46)
135
+ [src/Handler.ts:46](https://github.com/breautek/storm/blob/0875c73/src/Handler.ts#L46)
138
136
 
139
- ## Variables
137
+ ## Functions
140
138
 
141
139
  ### formidable
142
140
 
143
- **formidable**: (`options?`: [`Options`](interfaces/formidable.Options.md)) => `IncomingForm` & [`MappedParsers`](modules/formidable.md#mappedparsers)
141
+ **formidable**(`options?`): `IncomingForm`
142
+
143
+ #### Parameters
144
+
145
+ | Name | Type |
146
+ | :------ | :------ |
147
+ | `options?` | [`Options`](interfaces/formidable.Options.md) |
148
+
149
+ #### Returns
150
+
151
+ `IncomingForm`
144
152
 
145
153
  #### Defined in
146
154
 
147
- node_modules/@types/formidable/index.d.ts:281
155
+ node_modules/@types/formidable/index.d.ts:282
148
156
 
149
- ## Functions
157
+ ___
150
158
 
151
159
  ### getInstance
152
160
 
@@ -158,4 +166,4 @@ node_modules/@types/formidable/index.d.ts:281
158
166
 
159
167
  #### Defined in
160
168
 
161
- [src/instance.ts:28](https://github.com/breautek/storm/blob/f198938/src/instance.ts#L28)
169
+ [src/instance.ts:28](https://github.com/breautek/storm/blob/0875c73/src/instance.ts#L28)