@breautek/storm 5.0.1 → 6.0.1

package/docs/classes/BackendAuthenticationMiddleware.md

@@ -1,49 +0,0 @@
-[@breautek/storm](../README.md) / BackendAuthenticationMiddleware
-
-# Class: BackendAuthenticationMiddleware
-
-A base authentication strategy that handles 90% of the authentication process.
-This will verify that the token hasn't been manipulated or tainted.
-The authenticate API must be implemented by subclasses to further validate the token data 
-for their specific use cases.
-
-## Table of contents
-
-### Constructors
-
-- [constructor](BackendAuthenticationMiddleware.md#constructor)
-
-### Methods
-
-- [execute](BackendAuthenticationMiddleware.md#execute)
-
-## Constructors
-
-### constructor
-
-• **new BackendAuthenticationMiddleware**()
-
-#### Defined in
-
-[src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/3dcafe4/src/BackendAuthenticationMiddleware.ts#L35)
-
-## Methods
-
-### execute
-
-▸ **execute**(`request`, `options?`): `Promise`<`any`\>
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `request` | [`Request`](Request.md)<`any`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |  |
-| `options?` | `any` | Arbituary object containing any relevant information used for authentication. |
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Defined in
-
-[src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/3dcafe4/src/BackendAuthenticationMiddleware.ts#L46)

package/docs/classes/CORSMiddleware.md

@@ -1,143 +0,0 @@
-[@breautek/storm](../README.md) / CORSMiddleware
-
-# Class: CORSMiddleware
-
-CORSMiddleware is used to enable CORS on APIs. 
-It will automatically add the necessary headers necessary to
-communicate with CORS enabled clients.
-
-## Hierarchy
-
-- [`Middleware`](Middleware.md)
-
-  ↳ **`CORSMiddleware`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](CORSMiddleware.md#constructor)
-
-### Methods
-
-- [\_execute](CORSMiddleware.md#_execute)
-- [execute](CORSMiddleware.md#execute)
-- [getDefaultAllowedHeaders](CORSMiddleware.md#getdefaultallowedheaders)
-- [getDefaultAllowedMethods](CORSMiddleware.md#getdefaultallowedmethods)
-- [getDefaultAllowedOrigin](CORSMiddleware.md#getdefaultallowedorigin)
-
-## Constructors
-
-### constructor
-
-• **new CORSMiddleware**(`allowedOrigin?`, `allowedHeaders?`, `allowedMethods?`)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `allowedOrigin?` | `string` | The allowed origin. By default it will use the request origin. |
-| `allowedHeaders?` | `string`[] | Array of allowed headers. |
-| `allowedMethods?` | `string`[] | Array of allowed HTTP methods. |
-
-#### Overrides
-
-[Middleware](Middleware.md).[constructor](Middleware.md#constructor)
-
-#### Defined in
-
-[src/CORSMiddleware.ts:39](https://github.com/breautek/storm/blob/3dcafe4/src/CORSMiddleware.ts#L39)
-
-## Methods
-
-### \_execute
-
-▸ `Protected` **_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`\>\>
-
-#### Overrides
-
-[Middleware](Middleware.md).[_execute](Middleware.md#_execute)
-
-#### Defined in
-
-[src/CORSMiddleware.ts:75](https://github.com/breautek/storm/blob/3dcafe4/src/CORSMiddleware.ts#L75)
-
-___
-
-### 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`\>\>
-
-#### Inherited from
-
-[Middleware](Middleware.md).[execute](Middleware.md#execute)
-
-#### Defined in
-
-[src/Middleware.ts:27](https://github.com/breautek/storm/blob/3dcafe4/src/Middleware.ts#L27)
-
-___
-
-### getDefaultAllowedHeaders
-
-▸ **getDefaultAllowedHeaders**(): `string`[]
-
-#### Returns
-
-`string`[]
-
-#### Defined in
-
-[src/CORSMiddleware.ts:54](https://github.com/breautek/storm/blob/3dcafe4/src/CORSMiddleware.ts#L54)
-
-___
-
-### getDefaultAllowedMethods
-
-▸ **getDefaultAllowedMethods**(): `string`[]
-
-#### Returns
-
-`string`[]
-
-#### Defined in
-
-[src/CORSMiddleware.ts:64](https://github.com/breautek/storm/blob/3dcafe4/src/CORSMiddleware.ts#L64)
-
-___
-
-### getDefaultAllowedOrigin
-
-▸ **getDefaultAllowedOrigin**(): `string`
-
-Sets the allowed origin. By default,
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/CORSMiddleware.ts:50](https://github.com/breautek/storm/blob/3dcafe4/src/CORSMiddleware.ts#L50)

package/docs/classes/ConfigLoader.md

@@ -1,29 +0,0 @@
-[@breautek/storm](../README.md) / ConfigLoader
-
-# Class: ConfigLoader
-
-## Table of contents
-
-### Methods
-
-- [load](ConfigLoader.md#load)
-
-## Methods
-
-### load
-
-▸ `Static` **load**(`path`): `Promise`<[`IConfig`](../interfaces/IConfig.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-
-#### Returns
-
-`Promise`<[`IConfig`](../interfaces/IConfig.md)\>
-
-#### Defined in
-
-[src/ConfigLoader.ts:34](https://github.com/breautek/storm/blob/3dcafe4/src/ConfigLoader.ts#L34)

package/docs/classes/Database.md

@@ -1,259 +0,0 @@
-[@breautek/storm](../README.md) / Database
-
-# Class: Database<TDatabaseConfig, TConnectionAPI\>
-
-## Type parameters
-
-| Name |
-| :------ |
-| `TDatabaseConfig` |
-| `TConnectionAPI` |
-
-## Hierarchy
-
-- **`Database`**
-
-  ↳ [`MySQLDatabase`](MySQLDatabase.md)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Database.md#constructor)
-
-### Methods
-
-- [\_addNode](Database.md#_addnode)
-- [\_destroy](Database.md#_destroy)
-- [\_getConnection](Database.md#_getconnection)
-- [\_removeNode](Database.md#_removenode)
-- [addMaster](Database.md#addmaster)
-- [addSlave](Database.md#addslave)
-- [destroy](Database.md#destroy)
-- [escape](Database.md#escape)
-- [getConnection](Database.md#getconnection)
-- [removeMaster](Database.md#removemaster)
-- [removeSlave](Database.md#removeslave)
-
-## Constructors
-
-### constructor
-
-• **new Database**<`TDatabaseConfig`, `TConnectionAPI`\>()
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `TDatabaseConfig` |
-| `TConnectionAPI` |
-
-#### Defined in
-
-[src/Database.ts:27](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L27)
-
-## Methods
-
-### \_addNode
-
-▸ `Protected` `Abstract` **_addNode**(`name`, `config`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-| `config` | `TDatabaseConfig` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/Database.ts:82](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L82)
-
-___
-
-### \_destroy
-
-▸ `Protected` `Abstract` **_destroy**(): `Promise`<`void`\>
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[src/Database.ts:81](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L81)
-
-___
-
-### \_getConnection
-
-▸ `Protected` `Abstract` **_getConnection**(`query`, `requireWriteAccess`): `Promise`<[`DatabaseConnection`](DatabaseConnection.md)<`TConnectionAPI`\>\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `requireWriteAccess` | `boolean` |
-
-#### Returns
-
-`Promise`<[`DatabaseConnection`](DatabaseConnection.md)<`TConnectionAPI`\>\>
-
-#### Defined in
-
-[src/Database.ts:84](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L84)
-
-___
-
-### \_removeNode
-
-▸ `Protected` `Abstract` **_removeNode**(`name`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/Database.ts:83](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L83)
-
-___
-
-### addMaster
-
-▸ **addMaster**(`config`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `config` | `TDatabaseConfig` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/Database.ts:31](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L31)
-
-___
-
-### addSlave
-
-▸ **addSlave**(`slaveID`, `config`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `slaveID` | `string` |
-| `config` | `TDatabaseConfig` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/Database.ts:45](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L45)
-
-___
-
-### destroy
-
-▸ **destroy**(): `Promise`<`void`\>
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[src/Database.ts:77](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L77)
-
-___
-
-### escape
-
-▸ `Abstract` **escape**(`query`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/Database.ts:85](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L85)
-
-___
-
-### getConnection
-
-▸ **getConnection**(`requireWriteAccess?`, `nodeID?`): `Promise`<[`DatabaseConnection`](DatabaseConnection.md)<`TConnectionAPI`\>\>
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `requireWriteAccess` | `boolean` | `false` |
-| `nodeID?` | `string` | `undefined` |
-
-#### Returns
-
-`Promise`<[`DatabaseConnection`](DatabaseConnection.md)<`TConnectionAPI`\>\>
-
-#### Defined in
-
-[src/Database.ts:64](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L64)
-
-___
-
-### removeMaster
-
-▸ **removeMaster**(): `void`
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/Database.ts:40](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L40)
-
-___
-
-### removeSlave
-
-▸ **removeSlave**(`slaveID`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `slaveID` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/Database.ts:54](https://github.com/breautek/storm/blob/3dcafe4/src/Database.ts#L54)

package/docs/classes/DatabaseCastObject.md

@@ -1,79 +0,0 @@
-[@breautek/storm](../README.md) / DatabaseCastObject
-
-# Class: DatabaseCastObject
-
-## Hierarchy
-
-- **`DatabaseCastObject`**
-
-  ↳ [`Point`](Point.md)
-
-  ↳ [`LineString`](LineString.md)
-
-  ↳ [`Polygon`](Polygon.md)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](DatabaseCastObject.md#constructor)
-
-### Methods
-
-- [\_toSQLString](DatabaseCastObject.md#_tosqlstring)
-- [escape](DatabaseCastObject.md#escape)
-- [toSqlString](DatabaseCastObject.md#tosqlstring)
-
-## Constructors
-
-### constructor
-
-• **new DatabaseCastObject**()
-
-## Methods
-
-### \_toSQLString
-
-▸ `Protected` `Abstract` **_toSQLString**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/DatabaseCastObject.ts:28](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseCastObject.ts#L28)
-
-___
-
-### escape
-
-▸ **escape**(`value`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/DatabaseCastObject.ts:24](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseCastObject.ts#L24)
-
-___
-
-### toSqlString
-
-▸ **toSqlString**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/DatabaseCastObject.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseCastObject.ts#L20)