@breautek/storm 3.3.1 → 4.1.0

package/docs/classes/Response.md

@@ -0,0 +1,242 @@
+[@breautek/storm](../README.md) / Response
+
+# Class: Response<TResponse, TErrorResponse\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TResponse` | `SendableData` |
+| `TErrorResponse` | `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md) \| `string` |
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Response.md#constructor)
+
+### Methods
+
+- [error](Response.md#error)
+- [getStatus](Response.md#getstatus)
+- [isHeadersSent](Response.md#isheaderssent)
+- [pipe](Response.md#pipe)
+- [redirect](Response.md#redirect)
+- [send](Response.md#send)
+- [setHeader](Response.md#setheader)
+- [setHeaders](Response.md#setheaders)
+- [setStatus](Response.md#setstatus)
+- [success](Response.md#success)
+
+## Constructors
+
+### constructor
+
+• **new Response**<`TResponse`, `TErrorResponse`\>(`response`, `requestURL`)
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TResponse` | `any` |
+| `TErrorResponse` | `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md) |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `response` | `Response`<`any`, `Record`<`string`, `any`\>\> |
+| `requestURL` | `string` |
+
+#### Defined in
+
+[src/Response.ts:38](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L38)
+
+## Methods
+
+### error
+
+▸ **error**(`error?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `error?` | `TErrorResponse` \| [`ResponseData`](ResponseData.md)<`TErrorResponse`\> |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Response.ts:130](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L130)
+
+___
+
+### getStatus
+
+▸ **getStatus**(): [`StatusCode`](../enums/StatusCode.md)
+
+#### Returns
+
+[`StatusCode`](../enums/StatusCode.md)
+
+#### Defined in
+
+[src/Response.ts:49](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L49)
+
+___
+
+### isHeadersSent
+
+▸ **isHeadersSent**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/Response.ts:126](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L126)
+
+___
+
+### pipe
+
+▸ **pipe**(`stream`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `stream` | `ReadableStream` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Response.ts:99](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L99)
+
+___
+
+### redirect
+
+▸ **redirect**(`url`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Response.ts:53](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L53)
+
+___
+
+### send
+
+▸ **send**(`data?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data?` | `Buffer` \| [`IErrorResponse`](../interfaces/IErrorResponse.md) \| [`StormError`](StormError.md)<`any`\> \| `TResponse` \| `TErrorResponse` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Response.ts:94](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L94)
+
+___
+
+### setHeader
+
+▸ **setHeader**(`key`, `value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `string` |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Response.ts:118](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L118)
+
+___
+
+### setHeaders
+
+▸ **setHeaders**(`keyValuePair`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `keyValuePair` | `IHeaderKeyValuePair` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Response.ts:122](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L122)
+
+___
+
+### setStatus
+
+▸ **setStatus**(`status`): [`Response`](Response.md)<`TResponse`, `TErrorResponse`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `status` | [`StatusCode`](../enums/StatusCode.md) |
+
+#### Returns
+
+[`Response`](Response.md)<`TResponse`, `TErrorResponse`\>
+
+#### Defined in
+
+[src/Response.ts:44](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L44)
+
+___
+
+### success
+
+▸ **success**(`data?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data?` | `TResponse` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Response.ts:107](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L107)

package/docs/classes/{ResponseData.ResponseData-1.md → ResponseData.md}

@@ -1,9 +1,7 @@
-[@breautek/storm](../README.md) / [ResponseData](../modules/ResponseData.md) / ResponseData
+[@breautek/storm](../README.md) / ResponseData
 
 # Class: ResponseData<TData\>
 
-[ResponseData](../modules/ResponseData.md).ResponseData
-
 ## Type parameters
 
 | Name | Type |
@@ -14,16 +12,16 @@
 
 ### Constructors
 
-- [constructor](ResponseData.ResponseData-1.md#constructor)
+- [constructor](ResponseData.md#constructor)
 
 ### Methods
 
-- [getData](ResponseData.ResponseData-1.md#getdata)
-- [getHeaders](ResponseData.ResponseData-1.md#getheaders)
-- [getRedirect](ResponseData.ResponseData-1.md#getredirect)
-- [getStatus](ResponseData.ResponseData-1.md#getstatus)
-- [redirect](ResponseData.ResponseData-1.md#redirect)
-- [setHeader](ResponseData.ResponseData-1.md#setheader)
+- [getData](ResponseData.md#getdata)
+- [getHeaders](ResponseData.md#getheaders)
+- [getRedirect](ResponseData.md#getredirect)
+- [getStatus](ResponseData.md#getstatus)
+- [redirect](ResponseData.md#redirect)
+- [setHeader](ResponseData.md#setheader)
 
 ## Constructors
 
@@ -41,12 +39,12 @@
 
 | Name | Type |
 | :------ | :------ |
-| `status` | [`StatusCode`](../enums/StatusCode.StatusCode-1.md) |
+| `status` | [`StatusCode`](../enums/StatusCode.md) |
 | `data?` | `TData` |
 
 #### Defined in
 
-[src/ResponseData.ts:25](https://github.com/breautek/storm/blob/8c3a317/src/ResponseData.ts#L25)
+[src/ResponseData.ts:25](https://github.com/breautek/storm/blob/3ad3438/src/ResponseData.ts#L25)
 
 ## Methods
 
@@ -60,7 +58,7 @@
 
 #### Defined in
 
-[src/ResponseData.ts:44](https://github.com/breautek/storm/blob/8c3a317/src/ResponseData.ts#L44)
+[src/ResponseData.ts:44](https://github.com/breautek/storm/blob/3ad3438/src/ResponseData.ts#L44)
 
 ___
 
@@ -74,7 +72,7 @@ ___
 
 #### Defined in
 
-[src/ResponseData.ts:36](https://github.com/breautek/storm/blob/8c3a317/src/ResponseData.ts#L36)
+[src/ResponseData.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/ResponseData.ts#L36)
 
 ___
 
@@ -88,21 +86,21 @@ ___
 
 #### Defined in
 
-[src/ResponseData.ts:52](https://github.com/breautek/storm/blob/8c3a317/src/ResponseData.ts#L52)
+[src/ResponseData.ts:52](https://github.com/breautek/storm/blob/3ad3438/src/ResponseData.ts#L52)
 
 ___
 
 ### getStatus
 
-▸ **getStatus**(): [`StatusCode`](../enums/StatusCode.StatusCode-1.md)
+▸ **getStatus**(): [`StatusCode`](../enums/StatusCode.md)
 
 #### Returns
 
-[`StatusCode`](../enums/StatusCode.StatusCode-1.md)
+[`StatusCode`](../enums/StatusCode.md)
 
 #### Defined in
 
-[src/ResponseData.ts:40](https://github.com/breautek/storm/blob/8c3a317/src/ResponseData.ts#L40)
+[src/ResponseData.ts:40](https://github.com/breautek/storm/blob/3ad3438/src/ResponseData.ts#L40)
 
 ___
 
@@ -122,7 +120,7 @@ ___
 
 #### Defined in
 
-[src/ResponseData.ts:48](https://github.com/breautek/storm/blob/8c3a317/src/ResponseData.ts#L48)
+[src/ResponseData.ts:48](https://github.com/breautek/storm/blob/3ad3438/src/ResponseData.ts#L48)
 
 ___
 
@@ -143,4 +141,4 @@ ___
 
 #### Defined in
 
-[src/ResponseData.ts:32](https://github.com/breautek/storm/blob/8c3a317/src/ResponseData.ts#L32)
+[src/ResponseData.ts:32](https://github.com/breautek/storm/blob/3ad3438/src/ResponseData.ts#L32)

package/docs/classes/ServiceProvider.md

@@ -0,0 +1,296 @@
+[@breautek/storm](../README.md) / ServiceProvider
+
+# Class: ServiceProvider
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ServiceProvider.md#constructor)
+
+### Methods
+
+- [\_createURL](ServiceProvider.md#_createurl)
+- [\_getApp](ServiceProvider.md#_getapp)
+- [\_getBase](ServiceProvider.md#_getbase)
+- [\_getDomain](ServiceProvider.md#_getdomain)
+- [\_getPort](ServiceProvider.md#_getport)
+- [\_getProtocol](ServiceProvider.md#_getprotocol)
+- [delete](ServiceProvider.md#delete)
+- [get](ServiceProvider.md#get)
+- [getApp](ServiceProvider.md#getapp)
+- [getVersion](ServiceProvider.md#getversion)
+- [post](ServiceProvider.md#post)
+- [put](ServiceProvider.md#put)
+- [request](ServiceProvider.md#request)
+- [urlSuffix](ServiceProvider.md#urlsuffix)
+
+## Constructors
+
+### constructor
+
+• **new ServiceProvider**(`app`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `app` | [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\> |
+
+#### Defined in
+
+[src/ServiceProvider.ts:29](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L29)
+
+## Methods
+
+### \_createURL
+
+▸ `Protected` **_createURL**(`url`, `queryParams?`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+| `queryParams?` | `Record`<`any`, `any`\> |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/ServiceProvider.ts:64](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L64)
+
+___
+
+### \_getApp
+
+▸ `Protected` **_getApp**(): [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\>
+
+#### Returns
+
+[`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\>
+
+#### Defined in
+
+[src/ServiceProvider.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L36)
+
+___
+
+### \_getBase
+
+▸ `Protected` `Abstract` **_getBase**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/ServiceProvider.ts:33](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L33)
+
+___
+
+### \_getDomain
+
+▸ `Protected` **_getDomain**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/ServiceProvider.ts:44](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L44)
+
+___
+
+### \_getPort
+
+▸ `Protected` `Abstract` **_getPort**(): `number`
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[src/ServiceProvider.ts:34](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L34)
+
+___
+
+### \_getProtocol
+
+▸ `Protected` **_getProtocol**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/ServiceProvider.ts:56](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L56)
+
+___
+
+### delete
+
+▸ **delete**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+| `accessToken` | `string` |
+| `data?` | `any` |
+| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.md) |
+| `additionalOptions?` | `any` |
+
+#### Returns
+
+`Promise`<[`ServiceResponse`](ServiceResponse.md)\>
+
+#### Defined in
+
+[src/ServiceProvider.ts:157](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L157)
+
+___
+
+### get
+
+▸ **get**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+| `accessToken` | `string` |
+| `data?` | `any` |
+| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.md) |
+| `additionalOptions?` | `any` |
+
+#### Returns
+
+`Promise`<[`ServiceResponse`](ServiceResponse.md)\>
+
+#### Defined in
+
+[src/ServiceProvider.ts:142](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L142)
+
+___
+
+### getApp
+
+▸ **getApp**(): [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\>
+
+#### Returns
+
+[`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\>
+
+#### Defined in
+
+[src/ServiceProvider.ts:40](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L40)
+
+___
+
+### getVersion
+
+▸ **getVersion**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/ServiceProvider.ts:60](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L60)
+
+___
+
+### post
+
+▸ **post**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+| `accessToken` | `string` |
+| `data?` | `any` |
+| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.md) |
+| `additionalOptions?` | `any` |
+
+#### Returns
+
+`Promise`<[`ServiceResponse`](ServiceResponse.md)\>
+
+#### Defined in
+
+[src/ServiceProvider.ts:147](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L147)
+
+___
+
+### put
+
+▸ **put**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+| `accessToken` | `string` |
+| `data?` | `any` |
+| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.md) |
+| `additionalOptions?` | `any` |
+
+#### Returns
+
+`Promise`<[`ServiceResponse`](ServiceResponse.md)\>
+
+#### Defined in
+
+[src/ServiceProvider.ts:152](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L152)
+
+___
+
+### request
+
+▸ **request**(`method`, `url`, `accessToken`, `data`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `method` | [`HTTPMethod`](../enums/HTTPMethod.md) |
+| `url` | `string` |
+| `accessToken` | `string` |
+| `data` | `any` |
+| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.md) |
+| `additionalOptions?` | `any` |
+
+#### Returns
+
+`Promise`<[`ServiceResponse`](ServiceResponse.md)\>
+
+#### Defined in
+
+[src/ServiceProvider.ts:82](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L82)
+
+___
+
+### urlSuffix
+
+▸ **urlSuffix**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/ServiceProvider.ts:52](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L52)

package/docs/classes/{ServiceResponse.ServiceResponse-1.md → ServiceResponse.md}

@@ -1,20 +1,18 @@
-[@breautek/storm](../README.md) / [ServiceResponse](../modules/ServiceResponse.md) / ServiceResponse
+[@breautek/storm](../README.md) / ServiceResponse
 
 # Class: ServiceResponse
 
-[ServiceResponse](../modules/ServiceResponse.md).ServiceResponse
-
 ## Table of contents
 
 ### Constructors
 
-- [constructor](ServiceResponse.ServiceResponse-1.md#constructor)
+- [constructor](ServiceResponse.md#constructor)
 
 ### Methods
 
-- [getJSON](ServiceResponse.ServiceResponse-1.md#getjson)
-- [getRaw](ServiceResponse.ServiceResponse-1.md#getraw)
-- [getUTF8](ServiceResponse.ServiceResponse-1.md#getutf8)
+- [getJSON](ServiceResponse.md#getjson)
+- [getRaw](ServiceResponse.md#getraw)
+- [getUTF8](ServiceResponse.md#getutf8)
 
 ## Constructors
 
@@ -31,7 +29,7 @@
 
 #### Defined in
 
-[src/ServiceResponse.ts:23](https://github.com/breautek/storm/blob/8c3a317/src/ServiceResponse.ts#L23)
+[src/ServiceResponse.ts:23](https://github.com/breautek/storm/blob/3ad3438/src/ServiceResponse.ts#L23)
 
 ## Methods
 
@@ -45,7 +43,7 @@
 
 #### Defined in
 
-[src/ServiceResponse.ts:36](https://github.com/breautek/storm/blob/8c3a317/src/ServiceResponse.ts#L36)
+[src/ServiceResponse.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/ServiceResponse.ts#L36)
 
 ___
 
@@ -59,7 +57,7 @@ ___
 
 #### Defined in
 
-[src/ServiceResponse.ts:28](https://github.com/breautek/storm/blob/8c3a317/src/ServiceResponse.ts#L28)
+[src/ServiceResponse.ts:28](https://github.com/breautek/storm/blob/3ad3438/src/ServiceResponse.ts#L28)
 
 ___
 
@@ -73,4 +71,4 @@ ___
 
 #### Defined in
 
-[src/ServiceResponse.ts:32](https://github.com/breautek/storm/blob/8c3a317/src/ServiceResponse.ts#L32)
+[src/ServiceResponse.ts:32](https://github.com/breautek/storm/blob/3ad3438/src/ServiceResponse.ts#L32)