@breautek/storm 4.0.0 → 4.2.0

package/CHANGELOG.md

@@ -4,7 +4,24 @@ 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)
+#### [v4.2.0](https://github.com/breautek/storm/compare/v4.1.0...v4.2.0)
+
+- 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)
+- Added NotImplementedError. [`#52`](https://github.com/breautek/storm/pull/52)
+- Clarify getParameters and getParametersForQuery [`#51`](https://github.com/breautek/storm/pull/51)
+- feat: RawError [`f198938`](https://github.com/breautek/storm/commit/f1989383a0b498f4db78d838edba52d133dd89b7)
+
+#### [v4.1.0](https://github.com/breautek/storm/compare/v4.0.0...v4.1.0)
+
+> 1 June 2022
+
+- deproll [`f0208fc`](https://github.com/breautek/storm/commit/f0208fc0b4c165ddc29fa65e406c5b8088fed743)
+- deproll [`57c440e`](https://github.com/breautek/storm/commit/57c440e7e204086371f716dc475fd6ee8a5b2f8c)
+- refactor: Replaced usages of IDictionary with typescript's builtin Record interface [`fb28f03`](https://github.com/breautek/storm/commit/fb28f03915c0ef46e9d1d5c7eaff3dd4561b5905)
+
+### [v4.0.0](https://github.com/breautek/storm/compare/v3.4.0...v4.0.0)
+
+> 8 March 2022
 
 - deproll [`be5e524`](https://github.com/breautek/storm/commit/be5e52417c668db959ac21ff05dabebf93820e73)
 - typescript-eslint upgrade [`186ee78`](https://github.com/breautek/storm/commit/186ee78c4529426d136804dcd6282553680478dc)

package/bt-config-sample.jsonc

@@ -96,7 +96,7 @@
     },
 
     /*
-    @type IDictionary
+    @type Record<any, any>
     @description    Arbitruary object for application-specific parameters
     @default        {}
     */

package/docs/README.md

@@ -41,7 +41,9 @@
 - [MissingParameterError](classes/MissingParameterError.md)
 - [MySQLConnection](classes/MySQLConnection.md)
 - [MySQLDatabase](classes/MySQLDatabase.md)
+- [NotImplementedError](classes/NotImplementedError.md)
 - [Query](classes/Query.md)
+- [RawError](classes/RawError.md)
 - [RawQuery](classes/RawQuery.md)
 - [Request](classes/Request.md)
 - [Response](classes/Response.md)
@@ -74,7 +76,7 @@
 - [ITemporaryTableQueryInput](interfaces/ITemporaryTableQueryInput.md)
 - [IUpdateQueryResult](interfaces/IUpdateQueryResult.md)
 
-### Type aliases
+### Type Aliases
 
 - [IDeleteQueryResult](README.md#ideletequeryresult)
 - [IHandlerError](README.md#ihandlererror)
@@ -88,7 +90,7 @@
 
 - [getInstance](README.md#getinstance)
 
-## Type aliases
+## Type Aliases
 
 ### IDeleteQueryResult
 
@@ -96,7 +98,7 @@
 
 #### Defined in
 
-[src/IDeleteQueryResult.ts:19](https://github.com/breautek/storm/blob/186ee78/src/IDeleteQueryResult.ts#L19)
+[src/IDeleteQueryResult.ts:19](https://github.com/breautek/storm/blob/f198938/src/IDeleteQueryResult.ts#L19)
 
 ___
 
@@ -112,7 +114,7 @@ This is to avoid accidental leakage of privilege data (e.g. snippets of database
 
 #### Defined in
 
-[src/Handler.ts:54](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L54)
+[src/Handler.ts:55](https://github.com/breautek/storm/blob/f198938/src/Handler.ts#L55)
 
 ___
 
@@ -132,7 +134,7 @@ certain things depending on the type of object it receives.
 
 #### Defined in
 
-[src/Handler.ts:45](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L45)
+[src/Handler.ts:46](https://github.com/breautek/storm/blob/f198938/src/Handler.ts#L46)
 
 ## Variables
 
@@ -156,4 +158,4 @@ node_modules/@types/formidable/index.d.ts:281
 
 #### Defined in
 
-[src/instance.ts:28](https://github.com/breautek/storm/blob/186ee78/src/instance.ts#L28)
+[src/instance.ts:28](https://github.com/breautek/storm/blob/f198938/src/instance.ts#L28)

package/docs/classes/Application.md

@@ -75,9 +75,9 @@ Main entry point for the Application. Should be extended and have the abstract m
 - [setTokenManager](Application.md#settokenmanager)
 - [shouldListen](Application.md#shouldlisten)
 - [getEventListeners](Application.md#geteventlisteners)
-- [listenerCount](Application.md#listenercount)
-- [on](Application.md#on)
-- [once](Application.md#once)
+- [listenerCount](Application.md#listenercount-1)
+- [on](Application.md#on-1)
+- [once](Application.md#once-1)
 
 ## Constructors
 
@@ -107,7 +107,7 @@ EventEmitter.constructor
 
 #### Defined in
 
-[src/Application.ts:64](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L64)
+[src/Application.ts:64](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L64)
 
 ## Properties
 
@@ -191,7 +191,7 @@ Promise<void>
 
 #### Defined in
 
-[src/Application.ts:272](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L272)
+[src/Application.ts:272](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L272)
 
 ___
 
@@ -211,7 +211,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:202](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L202)
+[src/Application.ts:202](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L202)
 
 ___
 
@@ -225,7 +225,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:249](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L249)
+[src/Application.ts:249](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L249)
 
 ___
 
@@ -239,7 +239,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:255](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L255)
+[src/Application.ts:255](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L255)
 
 ___
 
@@ -261,7 +261,7 @@ Subclasses are expected to override this to configure their database setup, if t
 
 #### Defined in
 
-[src/Application.ts:381](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L381)
+[src/Application.ts:381](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L381)
 
 ___
 
@@ -281,7 +281,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:165](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L165)
+[src/Application.ts:165](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L165)
 
 ___
 
@@ -301,7 +301,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:161](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L161)
+[src/Application.ts:161](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L161)
 
 ___
 
@@ -315,7 +315,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:385](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L385)
+[src/Application.ts:385](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L385)
 
 ___
 
@@ -337,7 +337,7 @@ Invoked once the config has been loaded and ready to be used.
 
 #### Defined in
 
-[src/Application.ts:325](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L325)
+[src/Application.ts:325](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L325)
 
 ___
 
@@ -353,7 +353,7 @@ Invoked when the application is considered ready for operation.
 
 #### Defined in
 
-[src/Application.ts:390](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L390)
+[src/Application.ts:390](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L390)
 
 ___
 
@@ -403,7 +403,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:221](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L221)
+[src/Application.ts:221](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L221)
 
 ___
 
@@ -424,7 +424,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:226](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L226)
+[src/Application.ts:226](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L226)
 
 ___
 
@@ -438,7 +438,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:245](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L245)
+[src/Application.ts:245](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L245)
 
 ___
 
@@ -555,7 +555,7 @@ command line arguments
 
 #### Defined in
 
-[src/Application.ts:352](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L352)
+[src/Application.ts:352](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L352)
 
 ___
 
@@ -571,7 +571,7 @@ the config object.
 
 #### Defined in
 
-[src/Application.ts:309](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L309)
+[src/Application.ts:309](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L309)
 
 ___
 
@@ -587,7 +587,7 @@ the database pool. This will need to be casted based on your preferred database
 
 #### Defined in
 
-[src/Application.ts:345](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L345)
+[src/Application.ts:345](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L345)
 
 ___
 
@@ -601,7 +601,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:169](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L169)
+[src/Application.ts:169](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L169)
 
 ___
 
@@ -640,7 +640,7 @@ the application name
 
 #### Defined in
 
-[src/Application.ts:298](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L298)
+[src/Application.ts:298](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L298)
 
 ___
 
@@ -654,7 +654,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:173](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L173)
+[src/Application.ts:173](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L173)
 
 ___
 
@@ -668,7 +668,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:204](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L204)
+[src/Application.ts:204](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L204)
 
 ___
 
@@ -684,7 +684,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/186ee78/src/Application.ts#L211)
+[src/Application.ts:211](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L211)
 
 ___
 
@@ -700,7 +700,7 @@ the token manager
 
 #### Defined in
 
-[src/Application.ts:338](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L338)
+[src/Application.ts:338](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L338)
 
 ___
 
@@ -784,7 +784,7 @@ ___
 
 #### Defined in
 
-[src/Application.ts:278](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L278)
+[src/Application.ts:278](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L278)
 
 ___
 
@@ -1241,7 +1241,7 @@ Sets the TokenManager to be used for authentication.
 
 #### Defined in
 
-[src/Application.ts:331](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L331)
+[src/Application.ts:331](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L331)
 
 ___
 
@@ -1257,7 +1257,7 @@ true if the Application should bind to an IP address
 
 #### Defined in
 
-[src/Application.ts:316](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L316)
+[src/Application.ts:316](https://github.com/breautek/storm/blob/f198938/src/Application.ts#L316)
 
 ___
 
@@ -1296,7 +1296,7 @@ const { getEventListeners, EventEmitter } = require('events');
 
 | Name | Type |
 | :------ | :------ |
-| `emitter` | `DOMEventTarget` \| `EventEmitter` |
+| `emitter` | `EventEmitter` \| `DOMEventTarget` |
 | `name` | `string` \| `symbol` |
 
 #### Returns

package/docs/classes/BackendAuthenticationMiddleware.md

@@ -25,7 +25,7 @@ for their specific use cases.
 
 #### Defined in
 
-[src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/186ee78/src/BackendAuthenticationMiddleware.ts#L35)
+[src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/f198938/src/BackendAuthenticationMiddleware.ts#L35)
 
 ## Methods
 
@@ -46,4 +46,4 @@ for their specific use cases.
 
 #### Defined in
 
-[src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/186ee78/src/BackendAuthenticationMiddleware.ts#L46)
+[src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/f198938/src/BackendAuthenticationMiddleware.ts#L46)

package/docs/classes/CORSMiddleware.md

@@ -46,7 +46,7 @@ communicate with CORS enabled clients.
 
 #### Defined in
 
-[src/CORSMiddleware.ts:39](https://github.com/breautek/storm/blob/186ee78/src/CORSMiddleware.ts#L39)
+[src/CORSMiddleware.ts:39](https://github.com/breautek/storm/blob/f198938/src/CORSMiddleware.ts#L39)
 
 ## Methods
 
@@ -71,7 +71,7 @@ communicate with CORS enabled clients.
 
 #### Defined in
 
-[src/CORSMiddleware.ts:75](https://github.com/breautek/storm/blob/186ee78/src/CORSMiddleware.ts#L75)
+[src/CORSMiddleware.ts:75](https://github.com/breautek/storm/blob/f198938/src/CORSMiddleware.ts#L75)
 
 ___
 
@@ -96,7 +96,7 @@ ___
 
 #### Defined in
 
-[src/Middleware.ts:27](https://github.com/breautek/storm/blob/186ee78/src/Middleware.ts#L27)
+[src/Middleware.ts:27](https://github.com/breautek/storm/blob/f198938/src/Middleware.ts#L27)
 
 ___
 
@@ -110,7 +110,7 @@ ___
 
 #### Defined in
 
-[src/CORSMiddleware.ts:54](https://github.com/breautek/storm/blob/186ee78/src/CORSMiddleware.ts#L54)
+[src/CORSMiddleware.ts:54](https://github.com/breautek/storm/blob/f198938/src/CORSMiddleware.ts#L54)
 
 ___
 
@@ -124,7 +124,7 @@ ___
 
 #### Defined in
 
-[src/CORSMiddleware.ts:64](https://github.com/breautek/storm/blob/186ee78/src/CORSMiddleware.ts#L64)
+[src/CORSMiddleware.ts:64](https://github.com/breautek/storm/blob/f198938/src/CORSMiddleware.ts#L64)
 
 ___
 
@@ -140,4 +140,4 @@ Sets the allowed origin. By default,
 
 #### Defined in
 
-[src/CORSMiddleware.ts:50](https://github.com/breautek/storm/blob/186ee78/src/CORSMiddleware.ts#L50)
+[src/CORSMiddleware.ts:50](https://github.com/breautek/storm/blob/f198938/src/CORSMiddleware.ts#L50)

package/docs/classes/ConfigLoader.md

@@ -26,4 +26,4 @@
 
 #### Defined in
 
-[src/ConfigLoader.ts:34](https://github.com/breautek/storm/blob/186ee78/src/ConfigLoader.ts#L34)
+[src/ConfigLoader.ts:34](https://github.com/breautek/storm/blob/f198938/src/ConfigLoader.ts#L34)

package/docs/classes/Database.md

@@ -50,7 +50,7 @@
 
 #### Defined in
 
-[src/Database.ts:28](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L28)
+[src/Database.ts:27](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L27)
 
 ## Methods
 
@@ -71,7 +71,7 @@
 
 #### Defined in
 
-[src/Database.ts:83](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L83)
+[src/Database.ts:82](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L82)
 
 ___
 
@@ -85,7 +85,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:82](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L82)
+[src/Database.ts:81](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L81)
 
 ___
 
@@ -106,7 +106,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:85](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L85)
+[src/Database.ts:84](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L84)
 
 ___
 
@@ -126,7 +126,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:84](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L84)
+[src/Database.ts:83](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L83)
 
 ___
 
@@ -146,7 +146,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:32](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L32)
+[src/Database.ts:31](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L31)
 
 ___
 
@@ -167,7 +167,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:46](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L46)
+[src/Database.ts:45](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L45)
 
 ___
 
@@ -181,7 +181,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:78](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L78)
+[src/Database.ts:77](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L77)
 
 ___
 
@@ -201,7 +201,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:86](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L86)
+[src/Database.ts:85](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L85)
 
 ___
 
@@ -222,7 +222,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:65](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L65)
+[src/Database.ts:64](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L64)
 
 ___
 
@@ -236,7 +236,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:41](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L41)
+[src/Database.ts:40](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L40)
 
 ___
 
@@ -256,4 +256,4 @@ ___
 
 #### Defined in
 
-[src/Database.ts:55](https://github.com/breautek/storm/blob/186ee78/src/Database.ts#L55)
+[src/Database.ts:54](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L54)