@breautek/storm 3.4.0 → 4.0.0

package/CHANGELOG.md

@@ -4,8 +4,16 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v4.0.0](https://github.com/breautek/storm/compare/v3.4.0...v4.0.0)
+
+- deproll [`be5e524`](https://github.com/breautek/storm/commit/be5e52417c668db959ac21ff05dabebf93820e73)
+- typescript-eslint upgrade [`186ee78`](https://github.com/breautek/storm/commit/186ee78c4529426d136804dcd6282553680478dc)
+- Breaking: pass IDatabaseConnection to getQuery [`0b9afe1`](https://github.com/breautek/storm/commit/0b9afe15f9a5317bc309fa1fd3578b5ae1fe22d4)
+
 #### [v3.4.0](https://github.com/breautek/storm/compare/v3.3.1...v3.4.0)
 
+> 14 January 2022
+
 - feat: SetSessionVariableQuery [`6ea3887`](https://github.com/breautek/storm/commit/6ea388780032fb1b785859d82b1090ac157eb7d8)
 
 #### [v3.3.1](https://github.com/breautek/storm/compare/v3.3.0...v3.3.1)

package/docs/README.md

@@ -4,66 +4,156 @@
 
 ## Table of contents
 
-### Modules
-
-- [Application](modules/Application.md)
-- [ApplicationEvent](modules/ApplicationEvent.md)
-- [BackendAuthenticationMiddleware](modules/BackendAuthenticationMiddleware.md)
-- [CORSMiddleware](modules/CORSMiddleware.md)
-- [ConfigLoader](modules/ConfigLoader.md)
-- [Database](modules/Database.md)
-- [DatabaseConnection](modules/DatabaseConnection.md)
-- [DatabaseQueryError](modules/DatabaseQueryError.md)
-- [DiskSpaceError](modules/DiskSpaceError.md)
-- [DropTemporaryTableQuery](modules/DropTemporaryTableQuery.md)
-- [DumpStream](modules/DumpStream.md)
-- [DuplicateEntryError](modules/DuplicateEntryError.md)
-- [EntityNotFoundError](modules/EntityNotFoundError.md)
-- [ErrorCode](modules/ErrorCode.md)
-- [ExitCode](modules/ExitCode.md)
-- [ExpiredTokenError](modules/ExpiredTokenError.md)
-- [HTTPMethod](modules/HTTPMethod.md)
-- [Handler](modules/Handler.md)
-- [IAuthTokenData](modules/IAuthTokenData.md)
-- [IConfig](modules/IConfig.md)
-- [IDatabaseConfig](modules/IDatabaseConfig.md)
-- [IDatabaseConnection](modules/IDatabaseConnection.md)
-- [IDeleteQueryResult](modules/IDeleteQueryResult.md)
-- [IFormData](modules/IFormData.md)
-- [IHandler](modules/IHandler.md)
-- [IInsertQueryResult](modules/IInsertQueryResult.md)
-- [IJWTVerifyOptions](modules/IJWTVerifyOptions.md)
-- [IRequestResponse](modules/IRequestResponse.md)
-- [IServiceHeaders](modules/IServiceHeaders.md)
-- [IUpdateQueryResult](modules/IUpdateQueryResult.md)
-- [InternalError](modules/InternalError.md)
-- [InvalidConfigError](modules/InvalidConfigError.md)
-- [InvalidCredentialsError](modules/InvalidCredentialsError.md)
-- [InvalidValueError](modules/InvalidValueError.md)
-- [JWTError](modules/JWTError.md)
-- [JWTVerifyOptionsParser](modules/JWTVerifyOptionsParser.md)
-- [ManagedDatabaseConnection](modules/ManagedDatabaseConnection.md)
-- [Middleware](modules/Middleware.md)
-- [MissingConfigError](modules/MissingConfigError.md)
-- [MissingParameterError](modules/MissingParameterError.md)
-- [MySQLConnection](modules/MySQLConnection.md)
-- [MySQLDatabase](modules/MySQLDatabase.md)
-- [Query](modules/Query.md)
-- [RawQuery](modules/RawQuery.md)
-- [Request](modules/Request.md)
-- [Response](modules/Response.md)
-- [ResponseData](modules/ResponseData.md)
-- [ServiceProvider](modules/ServiceProvider.md)
-- [ServiceResponse](modules/ServiceResponse.md)
-- [SetSessionVariableQuery](modules/SetSessionVariableQuery.md)
-- [StatusCode](modules/StatusCode.md)
-- [StormError](modules/StormError.md)
-- [TemporaryTableQuery](modules/TemporaryTableQuery.md)
-- [Token](modules/Token.md)
-- [TokenManager](modules/TokenManager.md)
-- [UnauthorizedAccessError](modules/UnauthorizedAccessError.md)
-- [api](modules/api.md)
-- [instance](modules/instance.md)
-- [private/CommitQuery](modules/private_CommitQuery.md)
-- [private/RollbackQuery](modules/private_RollbackQuery.md)
-- [private/StartTransactionQuery](modules/private_StartTransactionQuery.md)
+### Namespaces
+
+- [formidable](modules/formidable.md)
+
+### Enumerations
+
+- [ErrorCode](enums/ErrorCode.md)
+- [ExitCode](enums/ExitCode.md)
+- [HTTPMethod](enums/HTTPMethod.md)
+- [JWTError](enums/JWTError.md)
+- [StatusCode](enums/StatusCode.md)
+
+### Classes
+
+- [Application](classes/Application.md)
+- [BackendAuthenticationMiddleware](classes/BackendAuthenticationMiddleware.md)
+- [CORSMiddleware](classes/CORSMiddleware.md)
+- [ConfigLoader](classes/ConfigLoader.md)
+- [Database](classes/Database.md)
+- [DatabaseConnection](classes/DatabaseConnection.md)
+- [DatabaseQueryError](classes/DatabaseQueryError.md)
+- [DiskSpaceError](classes/DiskSpaceError.md)
+- [DropTemporaryTableQuery](classes/DropTemporaryTableQuery.md)
+- [DumpStream](classes/DumpStream.md)
+- [DuplicateEntryError](classes/DuplicateEntryError.md)
+- [EntityNotFoundError](classes/EntityNotFoundError.md)
+- [ExpiredTokenError](classes/ExpiredTokenError.md)
+- [Handler](classes/Handler.md)
+- [InternalError](classes/InternalError.md)
+- [InvalidCredentialsError](classes/InvalidCredentialsError.md)
+- [InvalidValueError](classes/InvalidValueError.md)
+- [ManagedDatabaseConnection](classes/ManagedDatabaseConnection.md)
+- [Middleware](classes/Middleware.md)
+- [MissingConfigError](classes/MissingConfigError.md)
+- [MissingParameterError](classes/MissingParameterError.md)
+- [MySQLConnection](classes/MySQLConnection.md)
+- [MySQLDatabase](classes/MySQLDatabase.md)
+- [Query](classes/Query.md)
+- [RawQuery](classes/RawQuery.md)
+- [Request](classes/Request.md)
+- [Response](classes/Response.md)
+- [ResponseData](classes/ResponseData.md)
+- [ServiceProvider](classes/ServiceProvider.md)
+- [ServiceResponse](classes/ServiceResponse.md)
+- [SetSessionVariableQuery](classes/SetSessionVariableQuery.md)
+- [StormError](classes/StormError.md)
+- [TemporaryTableQuery](classes/TemporaryTableQuery.md)
+- [Token](classes/Token.md)
+- [TokenManager](classes/TokenManager.md)
+- [UnauthorizedAccessError](classes/UnauthorizedAccessError.md)
+
+### Interfaces
+
+- [IAdditionalErrorDetails](interfaces/IAdditionalErrorDetails.md)
+- [IAuthTokenData](interfaces/IAuthTokenData.md)
+- [IConfig](interfaces/IConfig.md)
+- [IDatabaseConfig](interfaces/IDatabaseConfig.md)
+- [IDatabaseConnection](interfaces/IDatabaseConnection.md)
+- [IErrorResponse](interfaces/IErrorResponse.md)
+- [IFormData](interfaces/IFormData.md)
+- [IHandler](interfaces/IHandler.md)
+- [IInsertQueryResult](interfaces/IInsertQueryResult.md)
+- [IJWTVerifyOptions](interfaces/IJWTVerifyOptions.md)
+- [IParameterMap](interfaces/IParameterMap.md)
+- [IRequestResponse](interfaces/IRequestResponse.md)
+- [IServiceHeaders](interfaces/IServiceHeaders.md)
+- [ISetSessionVariableQueryInput](interfaces/ISetSessionVariableQueryInput.md)
+- [ITemporaryTableQueryInput](interfaces/ITemporaryTableQueryInput.md)
+- [IUpdateQueryResult](interfaces/IUpdateQueryResult.md)
+
+### Type aliases
+
+- [IDeleteQueryResult](README.md#ideletequeryresult)
+- [IHandlerError](README.md#ihandlererror)
+- [IHandlerResponse](README.md#ihandlerresponse)
+
+### Variables
+
+- [formidable](README.md#formidable)
+
+### Functions
+
+- [getInstance](README.md#getinstance)
+
+## Type aliases
+
+### IDeleteQueryResult
+
+Ƭ **IDeleteQueryResult**: [`IUpdateQueryResult`](interfaces/IUpdateQueryResult.md)
+
+#### Defined in
+
+[src/IDeleteQueryResult.ts:19](https://github.com/breautek/storm/blob/186ee78/src/IDeleteQueryResult.ts#L19)
+
+___
+
+### IHandlerError
+
+Ƭ **IHandlerError**: [`StormError`](classes/StormError.md) \| `Error` \| `any`
+
+Like IHandlerResponse, an IHandlerError can be any arbitrary type of object,
+however it's recommended that the type be of a StormError.
+
+If the type is not a StormError, the error will be wrapped in an InternalError object.
+This is to avoid accidental leakage of privilege data (e.g. snippets of database queries with sensitive information)
+
+#### Defined in
+
+[src/Handler.ts:54](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L54)
+
+___
+
+### IHandlerResponse
+
+Ƭ **IHandlerResponse**: [`ResponseData`](classes/ResponseData.md) \| `ReadableStream` \| `ReadStream` \| `any` \| `void`
+
+IHandlerResponse can actually accept any arbitrary object, however it may do
+certain things depending on the type of object it receives.
+
+- If the response object is a stream, it will pipe the stream to stream the HTTP response.
+- If the response is ResponseData, the status code and response data will be passed as the HTTP response.
+- Passing nothing/undefined will return a status code of 204 with no body content
+- Primitive data types will be passed as is
+- Buffers will be passed through
+- Any other object will be passed through JSON.stringify
+
+#### Defined in
+
+[src/Handler.ts:45](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L45)
+
+## Variables
+
+### formidable
+
+• **formidable**: (`options?`: [`Options`](interfaces/formidable.Options.md)) => `IncomingForm` & [`MappedParsers`](modules/formidable.md#mappedparsers)
+
+#### Defined in
+
+node_modules/@types/formidable/index.d.ts:281
+
+## Functions
+
+### getInstance
+
+▸ **getInstance**(): [`Application`](classes/Application.md)<[`IConfig`](interfaces/IConfig.md), [`IAuthTokenData`](interfaces/IAuthTokenData.md), `any`, `any`\>
+
+#### Returns
+
+[`Application`](classes/Application.md)<[`IConfig`](interfaces/IConfig.md), [`IAuthTokenData`](interfaces/IAuthTokenData.md), `any`, `any`\>
+
+#### Defined in
+
+[src/instance.ts:28](https://github.com/breautek/storm/blob/186ee78/src/instance.ts#L28)