npm - @breautek/storm - Versions diffs - 4.3.0 → 4.4.0 - Mend

@breautek/storm 4.3.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 (74) hide show

package/CHANGELOG.md +8 -0
package/docs/README.md +28 -20
package/docs/classes/Application.md +158 -76
package/docs/classes/BackendAuthenticationMiddleware.md +3 -3
package/docs/classes/CORSMiddleware.md +8 -8
package/docs/classes/ConfigLoader.md +1 -1
package/docs/classes/Database.md +12 -12
package/docs/classes/DatabaseConnection.md +42 -40
package/docs/classes/DatabaseQueryError.md +22 -18
package/docs/classes/DeadLockError.md +349 -0
package/docs/classes/DiskSpaceError.md +20 -18
package/docs/classes/DropTemporaryTableQuery.md +8 -8
package/docs/classes/DumpStream.md +1 -1
package/docs/classes/DuplicateEntryError.md +20 -18
package/docs/classes/EntityNotFoundError.md +20 -18
package/docs/classes/ExpiredTokenError.md +20 -18
package/docs/classes/Handler.md +14 -14
package/docs/classes/InternalError.md +20 -18
package/docs/classes/InvalidCredentialsError.md +20 -18
package/docs/classes/InvalidValueError.md +20 -18
package/docs/classes/ManagedDatabaseConnection.md +19 -19
package/docs/classes/Middleware.md +3 -3
package/docs/classes/MissingConfigError.md +20 -18
package/docs/classes/MissingParameterError.md +20 -18
package/docs/classes/MySQLConnection.md +73 -43
package/docs/classes/MySQLDatabase.md +13 -13
package/docs/classes/NotImplementedError.md +20 -18
package/docs/classes/Query.md +8 -8
package/docs/classes/RawError.md +20 -20
package/docs/classes/RawQuery.md +8 -8
package/docs/classes/Request.md +18 -18
package/docs/classes/Response.md +11 -11
package/docs/classes/ResponseData.md +7 -7
package/docs/classes/ServiceProvider.md +15 -15
package/docs/classes/ServiceResponse.md +4 -4
package/docs/classes/SetSessionVariableQuery.md +8 -8
package/docs/classes/StormError.md +20 -18
package/docs/classes/TemporaryTableQuery.md +8 -8
package/docs/classes/Token.md +2 -2
package/docs/classes/TokenManager.md +4 -4
package/docs/classes/UnauthorizedAccessError.md +20 -18
package/docs/enums/ErrorCode.md +18 -18
package/docs/enums/ExitCode.md +4 -4
package/docs/enums/HTTPMethod.md +8 -8
package/docs/enums/JWTError.md +4 -4
package/docs/enums/StatusCode.md +96 -96
package/docs/interfaces/IConfig.md +8 -8
package/docs/interfaces/IDatabaseConfig.md +6 -6
package/docs/interfaces/IDatabaseConnection.md +14 -14
package/docs/interfaces/IErrorResponse.md +5 -5
package/docs/interfaces/IFormData.md +2 -2
package/docs/interfaces/IHandler.md +1 -1
package/docs/interfaces/IInsertQueryResult.md +3 -3
package/docs/interfaces/IJWTVerifyOptions.md +1 -1
package/docs/interfaces/IRequestResponse.md +2 -2
package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
package/docs/interfaces/IUpdateQueryResult.md +2 -2
package/docs/interfaces/formidable.File.md +3 -1
package/docs/interfaces/formidable.FileJSON.md +3 -1
package/docs/interfaces/formidable.Options.md +33 -11
package/docs/interfaces/formidable.Part.md +65 -35
package/lib/DeadLockError.d.ts +6 -0
package/lib/DeadLockError.js +26 -0
package/lib/DeadLockError.js.map +1 -0
package/lib/MySQLConnection.js +9 -1
package/lib/MySQLConnection.js.map +1 -1
package/lib/api.d.ts +1 -0
package/lib/api.js +3 -1
package/lib/api.js.map +1 -1
package/package.json +19 -18
package/src/DeadLockError.ts +22 -0
package/src/MySQLConnection.ts +11 -1
package/src/api.ts +1 -0

package/docs/classes/MySQLDatabase.md CHANGED Viewed

@@ -41,7 +41,7 @@
 #### Defined in
-[src/MySQLDatabase.ts:27](https://github.com/breautek/storm/blob/4ac2f44/src/MySQLDatabase.ts#L27)
+[src/MySQLDatabase.ts:27](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L27)
 ## Methods
@@ -66,7 +66,7 @@
 #### Defined in
-[src/MySQLDatabase.ts:49](https://github.com/breautek/storm/blob/4ac2f44/src/MySQLDatabase.ts#L49)
+[src/MySQLDatabase.ts:49](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L49)
 ___
@@ -84,7 +84,7 @@ ___
 #### Defined in
-[src/MySQLDatabase.ts:59](https://github.com/breautek/storm/blob/4ac2f44/src/MySQLDatabase.ts#L59)
+[src/MySQLDatabase.ts:59](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L59)
 ___
@@ -109,7 +109,7 @@ ___
 #### Defined in
-[src/MySQLDatabase.ts:72](https://github.com/breautek/storm/blob/4ac2f44/src/MySQLDatabase.ts#L72)
+[src/MySQLDatabase.ts:72](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L72)
 ___
@@ -133,7 +133,7 @@ ___
 #### Defined in
-[src/MySQLDatabase.ts:54](https://github.com/breautek/storm/blob/4ac2f44/src/MySQLDatabase.ts#L54)
+[src/MySQLDatabase.ts:54](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L54)
 ___
@@ -157,7 +157,7 @@ ___
 #### Defined in
-[src/Database.ts:31](https://github.com/breautek/storm/blob/4ac2f44/src/Database.ts#L31)
+[src/Database.ts:31](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L31)
 ___
@@ -182,7 +182,7 @@ ___
 #### Defined in
-[src/Database.ts:45](https://github.com/breautek/storm/blob/4ac2f44/src/Database.ts#L45)
+[src/Database.ts:45](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L45)
 ___
@@ -200,7 +200,7 @@ ___
 #### Defined in
-[src/Database.ts:77](https://github.com/breautek/storm/blob/4ac2f44/src/Database.ts#L77)
+[src/Database.ts:77](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L77)
 ___
@@ -224,7 +224,7 @@ ___
 #### Defined in
-[src/MySQLDatabase.ts:40](https://github.com/breautek/storm/blob/4ac2f44/src/MySQLDatabase.ts#L40)
+[src/MySQLDatabase.ts:40](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L40)
 ___
@@ -249,7 +249,7 @@ ___
 #### Defined in
-[src/Database.ts:64](https://github.com/breautek/storm/blob/4ac2f44/src/Database.ts#L64)
+[src/Database.ts:64](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L64)
 ___
@@ -267,7 +267,7 @@ ___
 #### Defined in
-[src/Database.ts:40](https://github.com/breautek/storm/blob/4ac2f44/src/Database.ts#L40)
+[src/Database.ts:40](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L40)
 ___
@@ -291,7 +291,7 @@ ___
 #### Defined in
-[src/Database.ts:54](https://github.com/breautek/storm/blob/4ac2f44/src/Database.ts#L54)
+[src/Database.ts:54](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L54)
 ___
@@ -311,4 +311,4 @@ ___
 #### Defined in
-[src/MySQLDatabase.ts:45](https://github.com/breautek/storm/blob/4ac2f44/src/MySQLDatabase.ts#L45)
+[src/MySQLDatabase.ts:45](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L45)

package/docs/classes/NotImplementedError.md CHANGED Viewed

@@ -53,7 +53,7 @@
 #### Defined in
-[src/NotImplementedError.ts:27](https://github.com/breautek/storm/blob/4ac2f44/src/NotImplementedError.ts#L27)
+[src/NotImplementedError.ts:27](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L27)
 ## Properties
@@ -67,7 +67,7 @@
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1029
+node_modules/typescript/lib/lib.es5.d.ts:1041
 ___
@@ -81,7 +81,7 @@ ___
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1028
+node_modules/typescript/lib/lib.es5.d.ts:1040
 ___
@@ -95,7 +95,7 @@ ___
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1030
+node_modules/typescript/lib/lib.es5.d.ts:1042
 ___
@@ -109,7 +109,9 @@ ___
 Optional override for formatting stack traces
-**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+**`See`**
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 ##### Parameters
@@ -128,7 +130,7 @@ Optional override for formatting stack traces
 #### Defined in
-node_modules/@types/node/globals.d.ts:11
+node_modules/@types/node/ts4.8/globals.d.ts:11
 ___
@@ -142,7 +144,7 @@ ___
 #### Defined in
-node_modules/@types/node/globals.d.ts:13
+node_modules/@types/node/ts4.8/globals.d.ts:13
 ## Methods
@@ -160,7 +162,7 @@ node_modules/@types/node/globals.d.ts:13
 #### Defined in
-[src/NotImplementedError.ts:38](https://github.com/breautek/storm/blob/4ac2f44/src/NotImplementedError.ts#L38)
+[src/NotImplementedError.ts:38](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L38)
 ___
@@ -178,7 +180,7 @@ ___
 #### Defined in
-[src/StormError.ts:76](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L76)
+[src/StormError.ts:76](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L76)
 ___
@@ -196,7 +198,7 @@ ___
 #### Defined in
-[src/StormError.ts:97](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L97)
+[src/StormError.ts:97](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L97)
 ___
@@ -214,7 +216,7 @@ ___
 #### Defined in
-[src/NotImplementedError.ts:42](https://github.com/breautek/storm/blob/4ac2f44/src/NotImplementedError.ts#L42)
+[src/NotImplementedError.ts:42](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L42)
 ___
@@ -232,7 +234,7 @@ ___
 #### Defined in
-[src/NotImplementedError.ts:46](https://github.com/breautek/storm/blob/4ac2f44/src/NotImplementedError.ts#L46)
+[src/NotImplementedError.ts:46](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L46)
 ___
@@ -250,7 +252,7 @@ ___
 #### Defined in
-[src/NotImplementedError.ts:50](https://github.com/breautek/storm/blob/4ac2f44/src/NotImplementedError.ts#L50)
+[src/NotImplementedError.ts:50](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L50)
 ___
@@ -268,7 +270,7 @@ ___
 #### Defined in
-[src/NotImplementedError.ts:33](https://github.com/breautek/storm/blob/4ac2f44/src/NotImplementedError.ts#L33)
+[src/NotImplementedError.ts:33](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L33)
 ___
@@ -276,7 +278,7 @@ ___
 ▸ **getPrivateDetails**(): `INotImplementedErrorOptions`
-Private details are only logged to the server log.
+Private details are only logged to the server log.
 They are kept secret from the client.
 #### Returns
@@ -289,7 +291,7 @@ They are kept secret from the client.
 #### Defined in
-[src/StormError.ts:68](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L68)
+[src/StormError.ts:68](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L68)
 ___
@@ -309,7 +311,7 @@ Sends details to the client.
 #### Defined in
-[src/StormError.ts:60](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L60)
+[src/StormError.ts:60](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L60)
 ___
@@ -336,4 +338,4 @@ Create .stack property on a target object
 #### Defined in
-node_modules/@types/node/globals.d.ts:4
+node_modules/@types/node/ts4.8/globals.d.ts:4

package/docs/classes/Query.md CHANGED Viewed

@@ -60,7 +60,7 @@
 #### Defined in
-[src/Query.ts:22](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L22)
+[src/Query.ts:22](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L22)
 ## Methods
@@ -80,7 +80,7 @@
 #### Defined in
-[src/Query.ts:42](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L42)
+[src/Query.ts:42](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L42)
 ___
@@ -100,7 +100,7 @@ ___
 #### Defined in
-[src/Query.ts:70](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L70)
+[src/Query.ts:70](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L70)
 ___
@@ -116,7 +116,7 @@ parameters that was passed into the constructor.
 #### Defined in
-[src/Query.ts:29](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L29)
+[src/Query.ts:29](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L29)
 ___
@@ -134,7 +134,7 @@ parameters that will be used when this query is ran.
 #### Defined in
-[src/Query.ts:38](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L38)
+[src/Query.ts:38](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L38)
 ___
@@ -154,7 +154,7 @@ ___
 #### Defined in
-[src/Query.ts:44](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L44)
+[src/Query.ts:44](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L44)
 ___
@@ -177,7 +177,7 @@ Override to augment/manipulate the returned result set.
 #### Defined in
-[src/Query.ts:65](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L65)
+[src/Query.ts:65](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L65)
 ___
@@ -200,4 +200,4 @@ Can be used to set session variables or create temporary tables, etc.
 #### Defined in
-[src/Query.ts:55](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L55)
+[src/Query.ts:55](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L55)

package/docs/classes/RawError.md CHANGED Viewed

@@ -58,7 +58,7 @@ tag name.
 #### Defined in
-[src/RawError.ts:25](https://github.com/breautek/storm/blob/4ac2f44/src/RawError.ts#L25)
+[src/RawError.ts:25](https://github.com/breautek/storm/blob/0875c73/src/RawError.ts#L25)
 ## Properties
@@ -72,7 +72,7 @@ tag name.
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1029
+node_modules/typescript/lib/lib.es5.d.ts:1041
 ___
@@ -86,7 +86,7 @@ ___
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1028
+node_modules/typescript/lib/lib.es5.d.ts:1040
 ___
@@ -100,7 +100,7 @@ ___
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1030
+node_modules/typescript/lib/lib.es5.d.ts:1042
 ___
@@ -108,15 +108,15 @@ ___
 ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
-Optional override for formatting stack traces
 #### Type declaration
 ▸ (`err`, `stackTraces`): `any`
 Optional override for formatting stack traces
-**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+**`See`**
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 ##### Parameters
@@ -135,7 +135,7 @@ Optional override for formatting stack traces
 #### Defined in
-node_modules/@types/node/globals.d.ts:11
+node_modules/@types/node/ts4.8/globals.d.ts:11
 ___
@@ -149,7 +149,7 @@ ___
 #### Defined in
-node_modules/@types/node/globals.d.ts:13
+node_modules/@types/node/ts4.8/globals.d.ts:13
 ## Methods
@@ -167,7 +167,7 @@ node_modules/@types/node/globals.d.ts:13
 #### Defined in
-[src/RawError.ts:32](https://github.com/breautek/storm/blob/4ac2f44/src/RawError.ts#L32)
+[src/RawError.ts:32](https://github.com/breautek/storm/blob/0875c73/src/RawError.ts#L32)
 ___
@@ -185,7 +185,7 @@ ___
 #### Defined in
-[src/StormError.ts:76](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L76)
+[src/StormError.ts:76](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L76)
 ___
@@ -203,7 +203,7 @@ ___
 #### Defined in
-[src/StormError.ts:97](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L97)
+[src/StormError.ts:97](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L97)
 ___
@@ -221,7 +221,7 @@ ___
 #### Defined in
-[src/StormError.ts:72](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L72)
+[src/StormError.ts:72](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L72)
 ___
@@ -239,7 +239,7 @@ ___
 #### Defined in
-[src/StormError.ts:89](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L89)
+[src/StormError.ts:89](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L89)
 ___
@@ -257,7 +257,7 @@ ___
 #### Defined in
-[src/StormError.ts:93](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L93)
+[src/StormError.ts:93](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L93)
 ___
@@ -275,7 +275,7 @@ ___
 #### Defined in
-[src/RawError.ts:36](https://github.com/breautek/storm/blob/4ac2f44/src/RawError.ts#L36)
+[src/RawError.ts:36](https://github.com/breautek/storm/blob/0875c73/src/RawError.ts#L36)
 ___
@@ -283,7 +283,7 @@ ___
 ▸ **getPrivateDetails**(): `Object`
-Private details are only logged to the server log.
+Private details are only logged to the server log.
 They are kept secret from the client.
 #### Returns
@@ -301,7 +301,7 @@ They are kept secret from the client.
 #### Defined in
-[src/StormError.ts:68](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L68)
+[src/StormError.ts:68](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L68)
 ___
@@ -321,7 +321,7 @@ Sends details to the client.
 #### Defined in
-[src/StormError.ts:60](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L60)
+[src/StormError.ts:60](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L60)
 ___
@@ -348,4 +348,4 @@ Create .stack property on a target object
 #### Defined in
-node_modules/@types/node/globals.d.ts:4
+node_modules/@types/node/ts4.8/globals.d.ts:4

package/docs/classes/RawQuery.md CHANGED Viewed

@@ -59,7 +59,7 @@
 #### Defined in
-[src/RawQuery.ts:22](https://github.com/breautek/storm/blob/4ac2f44/src/RawQuery.ts#L22)
+[src/RawQuery.ts:22](https://github.com/breautek/storm/blob/0875c73/src/RawQuery.ts#L22)
 ## Methods
@@ -77,7 +77,7 @@
 #### Defined in
-[src/RawQuery.ts:27](https://github.com/breautek/storm/blob/4ac2f44/src/RawQuery.ts#L27)
+[src/RawQuery.ts:27](https://github.com/breautek/storm/blob/0875c73/src/RawQuery.ts#L27)
 ___
@@ -101,7 +101,7 @@ ___
 #### Defined in
-[src/Query.ts:70](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L70)
+[src/Query.ts:70](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L70)
 ___
@@ -121,7 +121,7 @@ parameters that was passed into the constructor.
 #### Defined in
-[src/Query.ts:29](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L29)
+[src/Query.ts:29](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L29)
 ___
@@ -143,7 +143,7 @@ parameters that will be used when this query is ran.
 #### Defined in
-[src/Query.ts:38](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L38)
+[src/Query.ts:38](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L38)
 ___
@@ -167,7 +167,7 @@ ___
 #### Defined in
-[src/Query.ts:44](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L44)
+[src/Query.ts:44](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L44)
 ___
@@ -194,7 +194,7 @@ Override to augment/manipulate the returned result set.
 #### Defined in
-[src/Query.ts:65](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L65)
+[src/Query.ts:65](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L65)
 ___
@@ -221,4 +221,4 @@ Can be used to set session variables or create temporary tables, etc.
 #### Defined in
-[src/Query.ts:55](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L55)
+[src/Query.ts:55](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L55)