@breautek/storm 3.3.0 → 4.0.0

package/docs/classes/Handler.md

@@ -0,0 +1,323 @@
+[@breautek/storm](../README.md) / Handler
+
+# Class: Handler<TApplication, TGetRequest, TGetResponse, TPostRequest, TPostResponse, TPutRequest, TPutResponse, TDeleteRequest, TDeleteResponse\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TApplication` | extends [`Application`](Application.md) = [`Application`](Application.md) |
+| `TGetRequest` | `any` |
+| `TGetResponse` | [`IHandlerResponse`](../README.md#ihandlerresponse) |
+| `TPostRequest` | `any` |
+| `TPostResponse` | [`IHandlerResponse`](../README.md#ihandlerresponse) |
+| `TPutRequest` | `any` |
+| `TPutResponse` | [`IHandlerResponse`](../README.md#ihandlerresponse) |
+| `TDeleteRequest` | `any` |
+| `TDeleteResponse` | [`IHandlerResponse`](../README.md#ihandlerresponse) |
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Handler.md#constructor)
+
+### Methods
+
+- [\_delete](Handler.md#_delete)
+- [\_get](Handler.md#_get)
+- [\_initMiddlewares](Handler.md#_initmiddlewares)
+- [\_onMiddlewareReject](Handler.md#_onmiddlewarereject)
+- [\_post](Handler.md#_post)
+- [\_put](Handler.md#_put)
+- [attach](Handler.md#attach)
+- [delete](Handler.md#delete)
+- [get](Handler.md#get)
+- [getAccessToken](Handler.md#getaccesstoken)
+- [getApplication](Handler.md#getapplication)
+- [post](Handler.md#post)
+- [put](Handler.md#put)
+
+## Constructors
+
+### constructor
+
+• **new Handler**<`TApplication`, `TGetRequest`, `TGetResponse`, `TPostRequest`, `TPostResponse`, `TPutRequest`, `TPutResponse`, `TDeleteRequest`, `TDeleteResponse`\>(`app`)
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TApplication` | extends [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`, `TApplication`\> = [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\> |
+| `TGetRequest` | `any` |
+| `TGetResponse` | `any` |
+| `TPostRequest` | `any` |
+| `TPostResponse` | `any` |
+| `TPutRequest` | `any` |
+| `TPutResponse` | `any` |
+| `TDeleteRequest` | `any` |
+| `TDeleteResponse` | `any` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `app` | `TApplication` |
+
+#### Defined in
+
+[src/Handler.ts:71](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L71)
+
+## Methods
+
+### \_delete
+
+▸ `Protected` **_delete**(`request`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`Request`](Request.md)<`TDeleteRequest`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[src/Handler.ts:214](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L214)
+
+___
+
+### \_get
+
+▸ `Protected` **_get**(`request`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`Request`](Request.md)<`TGetRequest`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[src/Handler.ts:202](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L202)
+
+___
+
+### \_initMiddlewares
+
+▸ `Protected` **_initMiddlewares**(): [`Middleware`](Middleware.md)[]
+
+#### Returns
+
+[`Middleware`](Middleware.md)[]
+
+#### Defined in
+
+[src/Handler.ts:80](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L80)
+
+___
+
+### \_onMiddlewareReject
+
+▸ `Protected` **_onMiddlewareReject**(`request`, `response`, `error`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`Request`](Request.md)<`any`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
+| `response` | [`Response`](Response.md)<`any`, `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md)\> |
+| `error` | [`StormError`](StormError.md)<`any`\> |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Handler.ts:136](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L136)
+
+___
+
+### \_post
+
+▸ `Protected` **_post**(`request`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`Request`](Request.md)<`TPostRequest`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[src/Handler.ts:206](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L206)
+
+___
+
+### \_put
+
+▸ `Protected` **_put**(`request`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`Request`](Request.md)<`TPutRequest`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[src/Handler.ts:210](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L210)
+
+___
+
+### attach
+
+▸ **attach**(`app`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `app` | [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\> |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Handler.ts:146](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L146)
+
+___
+
+### delete
+
+▸ **delete**(`request`, `response`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`Request`](Request.md)<`TDeleteRequest`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
+| `response` | [`Response`](Response.md)<`TDeleteResponse`, `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md)\> |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[src/Handler.ts:189](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L189)
+
+___
+
+### get
+
+▸ **get**(`request`, `response`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`Request`](Request.md)<`TGetRequest`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
+| `response` | [`Response`](Response.md)<`TGetResponse`, `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md)\> |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[src/Handler.ts:150](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L150)
+
+___
+
+### getAccessToken
+
+▸ **getAccessToken**(`request`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`Request`](Request.md)<`any`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/Handler.ts:84](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L84)
+
+___
+
+### getApplication
+
+▸ **getApplication**(): `TApplication`
+
+#### Returns
+
+`TApplication`
+
+#### Defined in
+
+[src/Handler.ts:76](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L76)
+
+___
+
+### post
+
+▸ **post**(`request`, `response`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`Request`](Request.md)<`TPostRequest`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
+| `response` | [`Response`](Response.md)<`TPostResponse`, `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md)\> |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[src/Handler.ts:176](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L176)
+
+___
+
+### put
+
+▸ **put**(`request`, `response`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`Request`](Request.md)<`TPutRequest`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
+| `response` | [`Response`](Response.md)<`TPutResponse`, `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md)\> |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[src/Handler.ts:163](https://github.com/breautek/storm/blob/186ee78/src/Handler.ts#L163)

package/docs/classes/InternalError.md

@@ -0,0 +1,301 @@
+[@breautek/storm](../README.md) / InternalError
+
+# Class: InternalError
+
+## Hierarchy
+
+- [`StormError`](StormError.md)<`any`\>
+
+  ↳ **`InternalError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](InternalError.md#constructor)
+
+### Properties
+
+- [message](InternalError.md#message)
+- [name](InternalError.md#name)
+- [stack](InternalError.md#stack)
+- [prepareStackTrace](InternalError.md#preparestacktrace)
+- [stackTraceLimit](InternalError.md#stacktracelimit)
+
+### Methods
+
+- [getCode](InternalError.md#getcode)
+- [getErrorResponse](InternalError.md#geterrorresponse)
+- [getExitCode](InternalError.md#getexitcode)
+- [getHTTPCode](InternalError.md#gethttpcode)
+- [getMessage](InternalError.md#getmessage)
+- [getPrivateDetails](InternalError.md#getprivatedetails)
+- [getPublicDetails](InternalError.md#getpublicdetails)
+- [captureStackTrace](InternalError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new InternalError**(`details?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `details?` | `any` |
+
+#### Overrides
+
+[StormError](StormError.md).[constructor](StormError.md#constructor)
+
+#### Defined in
+
+[src/InternalError.ts:23](https://github.com/breautek/storm/blob/186ee78/src/InternalError.ts#L23)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[message](StormError.md#message)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1023
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[name](StormError.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[stack](StormError.md#stack)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+[StormError](StormError.md).[prepareStackTrace](StormError.md#preparestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+[StormError](StormError.md).[stackTraceLimit](StormError.md#stacktracelimit)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### getCode
+
+▸ **getCode**(): [`ErrorCode`](../enums/ErrorCode.md)
+
+#### Returns
+
+[`ErrorCode`](../enums/ErrorCode.md)
+
+#### Overrides
+
+[StormError](StormError.md).[getCode](StormError.md#getcode)
+
+#### Defined in
+
+[src/InternalError.ts:31](https://github.com/breautek/storm/blob/186ee78/src/InternalError.ts#L31)
+
+___
+
+### getErrorResponse
+
+▸ **getErrorResponse**(): [`IErrorResponse`](../interfaces/IErrorResponse.md)
+
+#### Returns
+
+[`IErrorResponse`](../interfaces/IErrorResponse.md)
+
+#### Inherited from
+
+[StormError](StormError.md).[getErrorResponse](StormError.md#geterrorresponse)
+
+#### Defined in
+
+[src/StormError.ts:70](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L70)
+
+___
+
+### getExitCode
+
+▸ **getExitCode**(): [`ExitCode`](../enums/ExitCode.md)
+
+#### Returns
+
+[`ExitCode`](../enums/ExitCode.md)
+
+#### Inherited from
+
+[StormError](StormError.md).[getExitCode](StormError.md#getexitcode)
+
+#### Defined in
+
+[src/StormError.ts:79](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L79)
+
+___
+
+### getHTTPCode
+
+▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.md)
+
+#### Returns
+
+[`StatusCode`](../enums/StatusCode.md)
+
+#### Overrides
+
+[StormError](StormError.md).[getHTTPCode](StormError.md#gethttpcode)
+
+#### Defined in
+
+[src/InternalError.ts:35](https://github.com/breautek/storm/blob/186ee78/src/InternalError.ts#L35)
+
+___
+
+### getMessage
+
+▸ **getMessage**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[StormError](StormError.md).[getMessage](StormError.md#getmessage)
+
+#### Defined in
+
+[src/InternalError.ts:27](https://github.com/breautek/storm/blob/186ee78/src/InternalError.ts#L27)
+
+___
+
+### getPrivateDetails
+
+▸ **getPrivateDetails**(): `any`
+
+Private details are only logged to the server log.
+They are kept secret from the client.
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+[StormError](StormError.md).[getPrivateDetails](StormError.md#getprivatedetails)
+
+#### Defined in
+
+[src/StormError.ts:62](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L62)
+
+___
+
+### getPublicDetails
+
+▸ **getPublicDetails**(): [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
+
+Sends details to the client.
+
+#### Returns
+
+[`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
+
+#### Inherited from
+
+[StormError](StormError.md).[getPublicDetails](StormError.md#getpublicdetails)
+
+#### Defined in
+
+[src/StormError.ts:54](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L54)
+
+___
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[StormError](StormError.md).[captureStackTrace](StormError.md#capturestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4