npm - @breautek/storm - Versions diffs - 5.0.1 → 5.0.2 - Mend

@breautek/storm 5.0.1 → 5.0.2

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 (183) hide show

package/CHANGELOG.md +10 -2
package/docs/assets/highlight.css +85 -0
package/docs/assets/main.js +58 -0
package/docs/assets/search.js +1 -0
package/docs/assets/style.css +1367 -0
package/docs/classes/Application.html +1235 -0
package/docs/classes/BackendAuthenticationMiddleware.html +191 -0
package/docs/classes/CORSMiddleware.html +257 -0
package/docs/classes/ConfigLoader.html +166 -0
package/docs/classes/Database.html +340 -0
package/docs/classes/DatabaseCastObject.html +203 -0
package/docs/classes/DatabaseConnection.html +550 -0
package/docs/classes/DatabaseQueryError.html +372 -0
package/docs/classes/DeadLockError.html +372 -0
package/docs/classes/DiskSpaceError.html +362 -0
package/docs/classes/DropTemporaryTableQuery.html +285 -0
package/docs/classes/DumpStream.html +161 -0
package/docs/classes/DuplicateEntryError.html +366 -0
package/docs/classes/EntityNotFoundError.html +362 -0
package/docs/classes/ExpiredTokenError.html +362 -0
package/docs/classes/Handler.html +395 -0
package/docs/classes/InternalError.html +362 -0
package/docs/classes/InvalidCredentialsError.html +362 -0
package/docs/classes/InvalidValueError.html +373 -0
package/docs/classes/LineString.html +212 -0
package/docs/classes/LockWaitTimeoutError.html +372 -0
package/docs/classes/ManagedDatabaseConnection.html +410 -0
package/docs/classes/Middleware.html +202 -0
package/docs/classes/MissingConfigError.html +362 -0
package/docs/classes/MissingParameterError.html +362 -0
package/docs/classes/MySQLConnection.html +546 -0
package/docs/classes/MySQLDatabase.html +353 -0
package/docs/classes/NotImplementedError.html +362 -0
package/docs/classes/Point.html +214 -0
package/docs/classes/Polygon.html +212 -0
package/docs/classes/Query.html +312 -0
package/docs/classes/RawError.html +374 -0
package/docs/classes/RawQuery.html +305 -0
package/docs/classes/Request.html +375 -0
package/docs/classes/Response.html +329 -0
package/docs/classes/ResponseData.html +255 -0
package/docs/classes/ServiceProvider.html +385 -0
package/docs/classes/ServiceResponse.html +213 -0
package/docs/classes/SetSessionVariableQuery.html +285 -0
package/docs/classes/StormError.html +377 -0
package/docs/classes/TemporaryTableQuery.html +290 -0
package/docs/classes/Token.html +181 -0
package/docs/classes/TokenManager.html +233 -0
package/docs/classes/Transaction.html +267 -0
package/docs/classes/UnauthorizedAccessError.html +362 -0
package/docs/enums/ErrorCode.html +210 -0
package/docs/enums/ExitCode.html +161 -0
package/docs/enums/HTTPMethod.html +175 -0
package/docs/enums/IsolationLevel.html +175 -0
package/docs/enums/JWTError.html +161 -0
package/docs/enums/StatusCode.html +483 -0
package/docs/functions/formidable-1.html +143 -0
package/docs/functions/getInstance.html +138 -0
package/docs/index.html +224 -0
package/docs/interfaces/IAdditionalErrorDetails.html +140 -0
package/docs/interfaces/IAuthTokenData.html +172 -0
package/docs/interfaces/IConfig.html +225 -0
package/docs/interfaces/IDatabaseConfig.html +198 -0
package/docs/interfaces/IDatabaseConnection.html +332 -0
package/docs/interfaces/IErrorResponse.html +186 -0
package/docs/interfaces/IFormData.html +165 -0
package/docs/interfaces/IHandler.html +171 -0
package/docs/interfaces/IInsertQueryResult.html +172 -0
package/docs/interfaces/IJWTVerifyOptions.html +158 -0
package/docs/interfaces/IParameterMap.html +140 -0
package/docs/interfaces/IQueryable.html +233 -0
package/docs/interfaces/IRequestResponse.html +172 -0
package/docs/interfaces/IServiceHeaders.html +140 -0
package/docs/interfaces/ISetSessionVariableQueryInput.html +165 -0
package/docs/interfaces/ITemporaryTableQueryInput.html +165 -0
package/docs/interfaces/IUpdateQueryResult.html +165 -0
package/docs/interfaces/formidable.EmitData.html +180 -0
package/docs/interfaces/formidable.EventData.html +201 -0
package/docs/interfaces/formidable.Fields.html +141 -0
package/docs/interfaces/formidable.File.html +239 -0
package/docs/interfaces/formidable.FileJSON.html +238 -0
package/docs/interfaces/formidable.Files.html +141 -0
package/docs/interfaces/formidable.Options.html +308 -0
package/docs/interfaces/formidable.Part.html +691 -0
package/docs/modules/formidable.html +159 -0
package/docs/types/IDeleteQueryResult.html +134 -0
package/docs/types/IHandlerError.html +139 -0
package/docs/types/IHandlerResponse.html +145 -0
package/docs/types/TCoordinate.html +134 -0
package/docs/types/formidable.BufferEncoding.html +135 -0
package/docs/types/formidable.DefaultOptions.html +135 -0
package/docs/types/formidable.EnabledPlugins.html +135 -0
package/docs/types/formidable.EventNames.html +135 -0
package/docs/types/formidable.MappedParsers.html +135 -0
package/docs/types/formidable.Plugin.html +135 -0
package/docs/types/formidable.PluginFunction.html +150 -0
package/docs/types/formidable.Plugins.html +135 -0
package/lib/StatusCode.d.ts +1 -1
package/lib/StatusCode.js +1 -1
package/lib/Transaction.d.ts +4 -0
package/lib/Transaction.js +4 -0
package/lib/Transaction.js.map +1 -1
package/package.json +14 -14
package/src/StatusCode.ts +1 -1
package/src/Transaction.ts +4 -0
package/docs/README.md +0 -188
package/docs/classes/Application.md +0 -1648
package/docs/classes/BackendAuthenticationMiddleware.md +0 -49
package/docs/classes/CORSMiddleware.md +0 -143
package/docs/classes/ConfigLoader.md +0 -29
package/docs/classes/Database.md +0 -259
package/docs/classes/DatabaseCastObject.md +0 -79
package/docs/classes/DatabaseConnection.md +0 -556
package/docs/classes/DatabaseQueryError.md +0 -351
package/docs/classes/DeadLockError.md +0 -349
package/docs/classes/DiskSpaceError.md +0 -341
package/docs/classes/DropTemporaryTableQuery.md +0 -207
package/docs/classes/DumpStream.md +0 -23
package/docs/classes/DuplicateEntryError.md +0 -343
package/docs/classes/EntityNotFoundError.md +0 -341
package/docs/classes/ExpiredTokenError.md +0 -341
package/docs/classes/Handler.md +0 -302
package/docs/classes/InternalError.md +0 -341
package/docs/classes/InvalidCredentialsError.md +0 -341
package/docs/classes/InvalidValueError.md +0 -349
package/docs/classes/LineString.md +0 -101
package/docs/classes/LockWaitTimeoutError.md +0 -349
package/docs/classes/ManagedDatabaseConnection.md +0 -403
package/docs/classes/Middleware.md +0 -72
package/docs/classes/MissingConfigError.md +0 -341
package/docs/classes/MissingParameterError.md +0 -341
package/docs/classes/MySQLConnection.md +0 -569
package/docs/classes/MySQLDatabase.md +0 -314
package/docs/classes/NotImplementedError.md +0 -341
package/docs/classes/Point.md +0 -102
package/docs/classes/Polygon.md +0 -101
package/docs/classes/Query.md +0 -227
package/docs/classes/RawError.md +0 -351
package/docs/classes/RawQuery.md +0 -224
package/docs/classes/Request.md +0 -321
package/docs/classes/Response.md +0 -242
package/docs/classes/ResponseData.md +0 -144
package/docs/classes/ServiceProvider.md +0 -296
package/docs/classes/ServiceResponse.md +0 -89
package/docs/classes/SetSessionVariableQuery.md +0 -207
package/docs/classes/StormError.md +0 -343
package/docs/classes/TemporaryTableQuery.md +0 -213
package/docs/classes/Token.md +0 -43
package/docs/classes/TokenManager.md +0 -105
package/docs/classes/Transaction.md +0 -161
package/docs/classes/UnauthorizedAccessError.md +0 -341
package/docs/enums/ErrorCode.md +0 -107
package/docs/enums/ExitCode.md +0 -30
package/docs/enums/HTTPMethod.md +0 -52
package/docs/enums/IsolationLevel.md +0 -52
package/docs/enums/JWTError.md +0 -30
package/docs/enums/StatusCode.md +0 -536
package/docs/interfaces/IAdditionalErrorDetails.md +0 -7
package/docs/interfaces/IAuthTokenData.md +0 -41
package/docs/interfaces/IConfig.md +0 -112
package/docs/interfaces/IDatabaseConfig.md +0 -80
package/docs/interfaces/IDatabaseConnection.md +0 -262
package/docs/interfaces/IErrorResponse.md +0 -63
package/docs/interfaces/IFormData.md +0 -30
package/docs/interfaces/IHandler.md +0 -31
package/docs/interfaces/IInsertQueryResult.md +0 -41
package/docs/interfaces/IJWTVerifyOptions.md +0 -19
package/docs/interfaces/IParameterMap.md +0 -7
package/docs/interfaces/IQueryable.md +0 -119
package/docs/interfaces/IRequestResponse.md +0 -37
package/docs/interfaces/IServiceHeaders.md +0 -7
package/docs/interfaces/ISetSessionVariableQueryInput.md +0 -30
package/docs/interfaces/ITemporaryTableQueryInput.md +0 -30
package/docs/interfaces/IUpdateQueryResult.md +0 -30
package/docs/interfaces/formidable.EmitData.md +0 -54
package/docs/interfaces/formidable.EventData.md +0 -87
package/docs/interfaces/formidable.Fields.md +0 -9
package/docs/interfaces/formidable.File.md +0 -131
package/docs/interfaces/formidable.FileJSON.md +0 -151
package/docs/interfaces/formidable.Files.md +0 -9
package/docs/interfaces/formidable.Options.md +0 -225
package/docs/interfaces/formidable.Part.md +0 -793
package/docs/modules/formidable.md +0 -122

package/docs/classes/ManagedDatabaseConnection.md DELETED Viewed

@@ -1,403 +0,0 @@
-[@breautek/storm](../README.md) / ManagedDatabaseConnection
-# Class: ManagedDatabaseConnection
-## Implements
-- [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md)
-## Table of contents
-### Constructors
-- [constructor](ManagedDatabaseConnection.md#constructor)
-### Methods
-- [close](ManagedDatabaseConnection.md#close)
-- [commit](ManagedDatabaseConnection.md#commit)
-- [getAPI](ManagedDatabaseConnection.md#getapi)
-- [getInstantiationStack](ManagedDatabaseConnection.md#getinstantiationstack)
-- [getTimeout](ManagedDatabaseConnection.md#gettimeout)
-- [hasConnection](ManagedDatabaseConnection.md#hasconnection)
-- [isClosed](ManagedDatabaseConnection.md#isclosed)
-- [isManaged](ManagedDatabaseConnection.md#ismanaged)
-- [isReadOnly](ManagedDatabaseConnection.md#isreadonly)
-- [isTransaction](ManagedDatabaseConnection.md#istransaction)
-- [isWriteRequired](ManagedDatabaseConnection.md#iswriterequired)
-- [query](ManagedDatabaseConnection.md#query)
-- [rollback](ManagedDatabaseConnection.md#rollback)
-- [setConnection](ManagedDatabaseConnection.md#setconnection)
-- [setInstantiationStack](ManagedDatabaseConnection.md#setinstantiationstack)
-- [setTimeout](ManagedDatabaseConnection.md#settimeout)
-- [startTransaction](ManagedDatabaseConnection.md#starttransaction)
-- [stream](ManagedDatabaseConnection.md#stream)
-## Constructors
-### constructor
-• **new ManagedDatabaseConnection**(`requiresWrite?`)
-#### Parameters
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `requiresWrite` | `boolean` | `false` |
-#### Defined in
-[src/ManagedDatabaseConnection.ts:38](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L38)
-## Methods
-### close
-▸ **close**(`forceClose?`): `Promise`<`void`\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `forceClose?` | `boolean` |
-#### Returns
-`Promise`<`void`\>
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[close](../interfaces/IDatabaseConnection.md#close)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:153](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L153)
-___
-### commit
-▸ **commit**(): `Promise`<`void`\>
-#### Returns
-`Promise`<`void`\>
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[commit](../interfaces/IDatabaseConnection.md#commit)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:190](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L190)
-___
-### getAPI
-▸ **getAPI**(): `any`
-#### Returns
-`any`
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[getAPI](../interfaces/IDatabaseConnection.md#getapi)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:238](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L238)
-___
-### getInstantiationStack
-▸ **getInstantiationStack**(): `string`
-#### Returns
-`string`
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[getInstantiationStack](../interfaces/IDatabaseConnection.md#getinstantiationstack)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:105](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L105)
-___
-### getTimeout
-▸ **getTimeout**(): `number`
-#### Returns
-`number`
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[getTimeout](../interfaces/IDatabaseConnection.md#gettimeout)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:130](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L130)
-___
-### hasConnection
-▸ **hasConnection**(): `boolean`
-#### Returns
-`boolean`
-#### Defined in
-[src/ManagedDatabaseConnection.ts:92](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L92)
-___
-### isClosed
-▸ **isClosed**(): `boolean`
-#### Returns
-`boolean`
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[isClosed](../interfaces/IDatabaseConnection.md#isclosed)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:75](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L75)
-___
-### isManaged
-▸ **isManaged**(): `boolean`
-#### Returns
-`boolean`
-#### Defined in
-[src/ManagedDatabaseConnection.ts:88](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L88)
-___
-### isReadOnly
-▸ **isReadOnly**(): `boolean`
-#### Returns
-`boolean`
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[isReadOnly](../interfaces/IDatabaseConnection.md#isreadonly)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:114](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L114)
-___
-### isTransaction
-▸ **isTransaction**(): `boolean`
-#### Returns
-`boolean`
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[isTransaction](../interfaces/IDatabaseConnection.md#istransaction)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:181](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L181)
-___
-### isWriteRequired
-▸ **isWriteRequired**(): `boolean`
-#### Returns
-`boolean`
-#### Defined in
-[src/ManagedDatabaseConnection.ts:84](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L84)
-___
-### query
-▸ **query**(`query`, `params?`): `Promise`<`any`\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `query` | [`Query`](Query.md)<`any`, `any`, `any`\> |
-| `params?` | `any` |
-#### Returns
-`Promise`<`any`\>
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[query](../interfaces/IDatabaseConnection.md#query)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:140](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L140)
-___
-### rollback
-▸ **rollback**(): `Promise`<`void`\>
-#### Returns
-`Promise`<`void`\>
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[rollback](../interfaces/IDatabaseConnection.md#rollback)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:203](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L203)
-___
-### setConnection
-▸ **setConnection**(`connection`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-#### Returns
-`void`
-#### Defined in
-[src/ManagedDatabaseConnection.ts:45](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L45)
-___
-### setInstantiationStack
-▸ **setInstantiationStack**(`stack`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `stack` | `string` |
-#### Returns
-`void`
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[setInstantiationStack](../interfaces/IDatabaseConnection.md#setinstantiationstack)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:96](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L96)
-___
-### setTimeout
-▸ **setTimeout**(`timeout`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `timeout` | `number` |
-#### Returns
-`void`
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[setTimeout](../interfaces/IDatabaseConnection.md#settimeout)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:124](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L124)
-___
-### startTransaction
-▸ **startTransaction**(`isolationLevel?`): `Promise`<`void`\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `isolationLevel?` | [`IsolationLevel`](../enums/IsolationLevel.md) |
-#### Returns
-`Promise`<`void`\>
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[startTransaction](../interfaces/IDatabaseConnection.md#starttransaction)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:168](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L168)
-___
-### stream
-▸ **stream**(`query`, `params?`, `streamOptions?`): `Readable`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `query` | [`Query`](Query.md)<`any`, `any`, `any`\> |
-| `params?` | `any` |
-| `streamOptions?` | `any` |
-#### Returns
-`Readable`
-#### Implementation of
-[IDatabaseConnection](../interfaces/IDatabaseConnection.md).[stream](../interfaces/IDatabaseConnection.md#stream)
-#### Defined in
-[src/ManagedDatabaseConnection.ts:149](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L149)

package/docs/classes/Middleware.md DELETED Viewed

@@ -1,72 +0,0 @@
-[@breautek/storm](../README.md) / Middleware
-# Class: Middleware
-## Hierarchy
-- **`Middleware`**
-  ↳ [`CORSMiddleware`](CORSMiddleware.md)
-## Table of contents
-### Constructors
-- [constructor](Middleware.md#constructor)
-### Methods
-- [\_execute](Middleware.md#_execute)
-- [execute](Middleware.md#execute)
-## Constructors
-### constructor
-• **new Middleware**()
-#### Defined in
-[src/Middleware.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/Middleware.ts#L23)
-## Methods
-### \_execute
-▸ `Protected` `Abstract` **_execute**(`request`, `response`): `Promise`<[`IRequestResponse`](../interfaces/IRequestResponse.md)<`any`, `any`\>\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `request` | [`Request`](Request.md)<`any`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
-| `response` | [`Response`](Response.md)<`any`, `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md)\> |
-#### Returns
-`Promise`<[`IRequestResponse`](../interfaces/IRequestResponse.md)<`any`, `any`\>\>
-#### Defined in
-[src/Middleware.ts:25](https://github.com/breautek/storm/blob/3dcafe4/src/Middleware.ts#L25)
-___
-### execute
-▸ **execute**(`request`, `response`): `Promise`<[`IRequestResponse`](../interfaces/IRequestResponse.md)<`any`, `any`\>\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `request` | [`Request`](Request.md)<`any`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
-| `response` | [`Response`](Response.md)<`any`, `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md)\> |
-#### Returns
-`Promise`<[`IRequestResponse`](../interfaces/IRequestResponse.md)<`any`, `any`\>\>
-#### Defined in
-[src/Middleware.ts:27](https://github.com/breautek/storm/blob/3dcafe4/src/Middleware.ts#L27)