@breautek/storm 3.1.1 → 3.3.0

package/CHANGELOG.md

@@ -4,8 +4,36 @@ 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).
 
+#### [v3.3.0](https://github.com/breautek/storm/compare/v3.2.1...v3.3.0)
+
+- feat: Allow accepting instances of Handlers for attachment [`621aeec`](https://github.com/breautek/storm/commit/621aeecc1929beee959d186467ef5f0ef326a56d)
+
+#### [v3.2.1](https://github.com/breautek/storm/compare/v3.2.0...v3.2.1)
+
+> 22 November 2021
+
+- deproll [`8a65682`](https://github.com/breautek/storm/commit/8a656821743454af66978aae441d61242b8adb15)
+- replaced merge-change with my own fork that contains vulnerability patches [`72412c9`](https://github.com/breautek/storm/commit/72412c9d391e4728bbd3af10ed5108cb2373b64e)
+
+#### [v3.2.0](https://github.com/breautek/storm/compare/v3.1.2...v3.2.0)
+
+> 3 October 2021
+
+- deproll [`477d756`](https://github.com/breautek/storm/commit/477d7569db92758cec31c8a80a6ae53c5198d33a)
+- breaking: Added _destroy abstract api to Database, intended for destroying connection pools [`a5c8a97`](https://github.com/breautek/storm/commit/a5c8a9708bc469a7191eb06d7a68289b1372543a)
+
+#### [v3.1.2](https://github.com/breautek/storm/compare/v3.1.1...v3.1.2)
+
+> 8 September 2021
+
+- deproll [`012dd73`](https://github.com/breautek/storm/commit/012dd73e505c0ffaa91a18f2575c411fe7ed8579)
+- Breaking changes docs [`824e19f`](https://github.com/breautek/storm/commit/824e19f1c6e50aadd7a4974c89892300b180b008)
+- fix: BackendAuthenticationMiddleware from requiring the Request object, it was never actually used anyway [`6b087c5`](https://github.com/breautek/storm/commit/6b087c59033c9b8e607ea0e6e37d06f13c7ae28e)
+
 #### [v3.1.1](https://github.com/breautek/storm/compare/v3.1.0...v3.1.1)
 
+> 3 September 2021
+
 - fix: middleware rejection handling (it was being handled twice) [`3845ece`](https://github.com/breautek/storm/commit/3845ecefe5bedef8b20d704e16ba88a866335e90)
 
 #### [v3.1.0](https://github.com/breautek/storm/compare/v3.0.3...v3.1.0)

package/docs/classes/Application.Application-1.md

@@ -38,6 +38,8 @@ Main entry point for the Application. Should be extended and have the abstract m
 
 - [\_attachHandlers](Application.Application-1.md#_attachhandlers)
 - [\_buildArgOptions](Application.Application-1.md#_buildargoptions)
+- [\_closeDatabase](Application.Application-1.md#_closedatabase)
+- [\_closeSocket](Application.Application-1.md#_closesocket)
 - [\_initDB](Application.Application-1.md#_initdb)
 - [\_initLogger](Application.Application-1.md#_initlogger)
 - [\_initialize](Application.Application-1.md#_initialize)
@@ -46,6 +48,7 @@ Main entry point for the Application. Should be extended and have the abstract m
 - [\_onReady](Application.Application-1.md#_onready)
 - [addListener](Application.Application-1.md#addlistener)
 - [attachHandler](Application.Application-1.md#attachhandler)
+- [attachHandlerInstance](Application.Application-1.md#attachhandlerinstance)
 - [close](Application.Application-1.md#close)
 - [emit](Application.Application-1.md#emit)
 - [eventNames](Application.Application-1.md#eventnames)
@@ -106,7 +109,7 @@ EventEmitter.constructor
 
 #### Defined in
 
-[src/Application.ts:64](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L64)
+[src/Application.ts:64](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L64)
 
 ## Properties
 
@@ -190,7 +193,7 @@ Promise<void>
 
 #### Defined in
 
-[src/Application.ts:258](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L258)
+[src/Application.ts:272](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L272)
 
 ___
 
@@ -210,7 +213,35 @@ ___
 
 #### Defined in
 
-[src/Application.ts:202](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L202)
+[src/Application.ts:202](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L202)
+
+___
+
+### \_closeDatabase
+
+▸ `Protected` **_closeDatabase**(): `Promise`<`void`\>
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[src/Application.ts:249](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L249)
+
+___
+
+### \_closeSocket
+
+▸ `Protected` **_closeSocket**(): `Promise`<`void`\>
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[src/Application.ts:255](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L255)
 
 ___
 
@@ -232,7 +263,7 @@ Subclasses are expected to override this to configure their database setup, if t
 
 #### Defined in
 
-[src/Application.ts:367](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L367)
+[src/Application.ts:381](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L381)
 
 ___
 
@@ -252,7 +283,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:165](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L165)
+[src/Application.ts:165](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L165)
 
 ___
 
@@ -272,7 +303,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:161](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L161)
+[src/Application.ts:161](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L161)
 
 ___
 
@@ -286,7 +317,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:371](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L371)
+[src/Application.ts:385](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L385)
 
 ___
 
@@ -308,7 +339,7 @@ Invoked once the config has been loaded and ready to be used.
 
 #### Defined in
 
-[src/Application.ts:311](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L311)
+[src/Application.ts:325](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L325)
 
 ___
 
@@ -324,7 +355,7 @@ Invoked when the application is considered ready for operation.
 
 #### Defined in
 
-[src/Application.ts:376](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L376)
+[src/Application.ts:390](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L390)
 
 ___
 
@@ -374,7 +405,28 @@ ___
 
 #### Defined in
 
-[src/Application.ts:221](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L221)
+[src/Application.ts:221](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L221)
+
+___
+
+### attachHandlerInstance
+
+▸ **attachHandlerInstance**(`path`, `handler`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `handler` | [`Handler`](Handler.Handler-1.md)<[`Application`](Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Application.ts:226](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L226)
 
 ___
 
@@ -388,7 +440,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:241](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L241)
+[src/Application.ts:245](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L245)
 
 ___
 
@@ -505,7 +557,7 @@ command line arguments
 
 #### Defined in
 
-[src/Application.ts:338](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L338)
+[src/Application.ts:352](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L352)
 
 ___
 
@@ -521,7 +573,7 @@ the config object.
 
 #### Defined in
 
-[src/Application.ts:295](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L295)
+[src/Application.ts:309](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L309)
 
 ___
 
@@ -537,7 +589,7 @@ the database pool. This will need to be casted based on your preferred database
 
 #### Defined in
 
-[src/Application.ts:331](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L331)
+[src/Application.ts:345](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L345)
 
 ___
 
@@ -551,7 +603,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:169](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L169)
+[src/Application.ts:169](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L169)
 
 ___
 
@@ -590,7 +642,7 @@ the application name
 
 #### Defined in
 
-[src/Application.ts:284](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L284)
+[src/Application.ts:298](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L298)
 
 ___
 
@@ -604,7 +656,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:173](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L173)
+[src/Application.ts:173](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L173)
 
 ___
 
@@ -618,7 +670,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:204](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L204)
+[src/Application.ts:204](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L204)
 
 ___
 
@@ -634,7 +686,7 @@ The maximum size limit for incoming requests that this service needs to handle.
 
 #### Defined in
 
-[src/Application.ts:211](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L211)
+[src/Application.ts:211](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L211)
 
 ___
 
@@ -650,7 +702,7 @@ the token manager
 
 #### Defined in
 
-[src/Application.ts:324](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L324)
+[src/Application.ts:338](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L338)
 
 ___
 
@@ -734,7 +786,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:264](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L264)
+[src/Application.ts:278](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L278)
 
 ___
 
@@ -1191,7 +1243,7 @@ Sets the TokenManager to be used for authentication.
 
 #### Defined in
 
-[src/Application.ts:317](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L317)
+[src/Application.ts:331](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L331)
 
 ___
 
@@ -1207,7 +1259,7 @@ true if the Application should bind to an IP address
 
 #### Defined in
 
-[src/Application.ts:302](https://github.com/breautek/storm/blob/3845ece/src/Application.ts#L302)
+[src/Application.ts:316](https://github.com/breautek/storm/blob/621aeec/src/Application.ts#L316)
 
 ___
 
@@ -1396,7 +1448,7 @@ event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
 The `Promise` will resolve with an array of all the arguments emitted to the
 given event.
 
-This method is intentionally generic and works with the web platform[EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event
+This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event
 semantics and does not listen to the `'error'` event.
 
 ```js

package/docs/classes/BackendAuthenticationMiddleware.BackendAuthenticationMiddleware-1.md

@@ -27,20 +27,19 @@ for their specific use cases.
 
 #### Defined in
 
-[src/BackendAuthenticationMiddleware.ts:36](https://github.com/breautek/storm/blob/3845ece/src/BackendAuthenticationMiddleware.ts#L36)
+[src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/621aeec/src/BackendAuthenticationMiddleware.ts#L35)
 
 ## Methods
 
 ### execute
 
-▸ **execute**(`request`, `response`, `options?`): `Promise`<`any`\>
+▸ **execute**(`request`, `options?`): `Promise`<`any`\>
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `request` | [`Request`](Request.Request-1.md)<`any`, [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md)\> |  |
-| `response` | [`Response`](Response.Response-1.md)<`any`, `string` \| `Error` \| [`IErrorResponse`](../interfaces/StormError.IErrorResponse.md)\> |  |
 | `options?` | `any` | Arbituary object containing any relevant information used for authentication. |
 
 #### Returns
@@ -49,4 +48,4 @@ for their specific use cases.
 
 #### Defined in
 
-[src/BackendAuthenticationMiddleware.ts:47](https://github.com/breautek/storm/blob/3845ece/src/BackendAuthenticationMiddleware.ts#L47)
+[src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/621aeec/src/BackendAuthenticationMiddleware.ts#L46)

package/docs/classes/CORSMiddleware.CORSMiddleware-1.md

@@ -48,7 +48,7 @@ communicate with CORS enabled clients.
 
 #### Defined in
 
-[src/CORSMiddleware.ts:39](https://github.com/breautek/storm/blob/3845ece/src/CORSMiddleware.ts#L39)
+[src/CORSMiddleware.ts:39](https://github.com/breautek/storm/blob/621aeec/src/CORSMiddleware.ts#L39)
 
 ## Methods
 
@@ -73,7 +73,7 @@ communicate with CORS enabled clients.
 
 #### Defined in
 
-[src/CORSMiddleware.ts:75](https://github.com/breautek/storm/blob/3845ece/src/CORSMiddleware.ts#L75)
+[src/CORSMiddleware.ts:75](https://github.com/breautek/storm/blob/621aeec/src/CORSMiddleware.ts#L75)
 
 ___
 
@@ -98,7 +98,7 @@ ___
 
 #### Defined in
 
-[src/Middleware.ts:27](https://github.com/breautek/storm/blob/3845ece/src/Middleware.ts#L27)
+[src/Middleware.ts:27](https://github.com/breautek/storm/blob/621aeec/src/Middleware.ts#L27)
 
 ___
 
@@ -112,7 +112,7 @@ ___
 
 #### Defined in
 
-[src/CORSMiddleware.ts:54](https://github.com/breautek/storm/blob/3845ece/src/CORSMiddleware.ts#L54)
+[src/CORSMiddleware.ts:54](https://github.com/breautek/storm/blob/621aeec/src/CORSMiddleware.ts#L54)
 
 ___
 
@@ -126,7 +126,7 @@ ___
 
 #### Defined in
 
-[src/CORSMiddleware.ts:64](https://github.com/breautek/storm/blob/3845ece/src/CORSMiddleware.ts#L64)
+[src/CORSMiddleware.ts:64](https://github.com/breautek/storm/blob/621aeec/src/CORSMiddleware.ts#L64)
 
 ___
 
@@ -142,4 +142,4 @@ Sets the allowed origin. By default,
 
 #### Defined in
 
-[src/CORSMiddleware.ts:50](https://github.com/breautek/storm/blob/3845ece/src/CORSMiddleware.ts#L50)
+[src/CORSMiddleware.ts:50](https://github.com/breautek/storm/blob/621aeec/src/CORSMiddleware.ts#L50)

package/docs/classes/ConfigLoader.ConfigLoader-1.md

@@ -28,4 +28,4 @@
 
 #### Defined in
 
-[src/ConfigLoader.ts:34](https://github.com/breautek/storm/blob/3845ece/src/ConfigLoader.ts#L34)
+[src/ConfigLoader.ts:34](https://github.com/breautek/storm/blob/621aeec/src/ConfigLoader.ts#L34)

package/docs/classes/Database.Database-1.md

@@ -26,10 +26,12 @@
 ### Methods
 
 - [\_addNode](Database.Database-1.md#_addnode)
+- [\_destroy](Database.Database-1.md#_destroy)
 - [\_getConnection](Database.Database-1.md#_getconnection)
 - [\_removeNode](Database.Database-1.md#_removenode)
 - [addMaster](Database.Database-1.md#addmaster)
 - [addSlave](Database.Database-1.md#addslave)
+- [destroy](Database.Database-1.md#destroy)
 - [escape](Database.Database-1.md#escape)
 - [getConnection](Database.Database-1.md#getconnection)
 - [removeMaster](Database.Database-1.md#removemaster)
@@ -50,7 +52,7 @@
 
 #### Defined in
 
-[src/Database.ts:28](https://github.com/breautek/storm/blob/3845ece/src/Database.ts#L28)
+[src/Database.ts:28](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L28)
 
 ## Methods
 
@@ -71,7 +73,21 @@
 
 #### Defined in
 
-[src/Database.ts:78](https://github.com/breautek/storm/blob/3845ece/src/Database.ts#L78)
+[src/Database.ts:83](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L83)
+
+___
+
+### \_destroy
+
+▸ `Protected` `Abstract` **_destroy**(): `Promise`<`void`\>
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[src/Database.ts:82](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L82)
 
 ___
 
@@ -92,7 +108,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:80](https://github.com/breautek/storm/blob/3845ece/src/Database.ts#L80)
+[src/Database.ts:85](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L85)
 
 ___
 
@@ -112,7 +128,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:79](https://github.com/breautek/storm/blob/3845ece/src/Database.ts#L79)
+[src/Database.ts:84](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L84)
 
 ___
 
@@ -132,7 +148,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:32](https://github.com/breautek/storm/blob/3845ece/src/Database.ts#L32)
+[src/Database.ts:32](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L32)
 
 ___
 
@@ -153,7 +169,21 @@ ___
 
 #### Defined in
 
-[src/Database.ts:46](https://github.com/breautek/storm/blob/3845ece/src/Database.ts#L46)
+[src/Database.ts:46](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L46)
+
+___
+
+### destroy
+
+▸ **destroy**(): `Promise`<`void`\>
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[src/Database.ts:78](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L78)
 
 ___
 
@@ -173,7 +203,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:81](https://github.com/breautek/storm/blob/3845ece/src/Database.ts#L81)
+[src/Database.ts:86](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L86)
 
 ___
 
@@ -194,7 +224,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:65](https://github.com/breautek/storm/blob/3845ece/src/Database.ts#L65)
+[src/Database.ts:65](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L65)
 
 ___
 
@@ -208,7 +238,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:41](https://github.com/breautek/storm/blob/3845ece/src/Database.ts#L41)
+[src/Database.ts:41](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L41)
 
 ___
 
@@ -228,4 +258,4 @@ ___
 
 #### Defined in
 
-[src/Database.ts:55](https://github.com/breautek/storm/blob/3845ece/src/Database.ts#L55)
+[src/Database.ts:55](https://github.com/breautek/storm/blob/621aeec/src/Database.ts#L55)