@breautek/storm 3.3.1 → 4.1.0

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

@@ -1,18 +1,16 @@
-[@breautek/storm](../README.md) / [Token](../modules/Token.md) / Token
+[@breautek/storm](../README.md) / Token
 
 # Class: Token
 
-[Token](../modules/Token.md).Token
-
 ## Table of contents
 
 ### Constructors
 
-- [constructor](Token.Token-1.md#constructor)
+- [constructor](Token.md#constructor)
 
 ### Methods
 
-- [getSignature](Token.Token-1.md#getsignature)
+- [getSignature](Token.md#getsignature)
 
 ## Constructors
 
@@ -28,7 +26,7 @@
 
 #### Defined in
 
-[src/Token.ts:20](https://github.com/breautek/storm/blob/8c3a317/src/Token.ts#L20)
+[src/Token.ts:20](https://github.com/breautek/storm/blob/3ad3438/src/Token.ts#L20)
 
 ## Methods
 
@@ -42,4 +40,4 @@
 
 #### Defined in
 
-[src/Token.ts:24](https://github.com/breautek/storm/blob/8c3a317/src/Token.ts#L24)
+[src/Token.ts:24](https://github.com/breautek/storm/blob/3ad3438/src/Token.ts#L24)

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

@@ -1,26 +1,24 @@
-[@breautek/storm](../README.md) / [TokenManager](../modules/TokenManager.md) / TokenManager
+[@breautek/storm](../README.md) / TokenManager
 
 # Class: TokenManager<TAuthToken\>
 
-[TokenManager](../modules/TokenManager.md).TokenManager
-
 ## Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md)[`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md) |
+| `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.md) = [`IAuthTokenData`](../interfaces/IAuthTokenData.md) |
 
 ## Table of contents
 
 ### Constructors
 
-- [constructor](TokenManager.TokenManager-1.md#constructor)
+- [constructor](TokenManager.md#constructor)
 
 ### Methods
 
-- [decode](TokenManager.TokenManager-1.md#decode)
-- [sign](TokenManager.TokenManager-1.md#sign)
-- [verify](TokenManager.TokenManager-1.md#verify)
+- [decode](TokenManager.md#decode)
+- [sign](TokenManager.md#sign)
+- [verify](TokenManager.md#verify)
 
 ## Constructors
 
@@ -32,7 +30,7 @@
 
 | Name | Type |
 | :------ | :------ |
-| `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md)[`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md) |
+| `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.md) = [`IAuthTokenData`](../interfaces/IAuthTokenData.md) |
 
 #### Parameters
 
@@ -42,7 +40,7 @@
 
 #### Defined in
 
-[src/TokenManager.ts:29](https://github.com/breautek/storm/blob/8c3a317/src/TokenManager.ts#L29)
+[src/TokenManager.ts:29](https://github.com/breautek/storm/blob/3ad3438/src/TokenManager.ts#L29)
 
 ## Methods
 
@@ -54,7 +52,7 @@
 
 | Name | Type |
 | :------ | :------ |
-| `token` | [`Token`](Token.Token-1.md) |
+| `token` | [`Token`](Token.md) |
 
 #### Returns
 
@@ -62,13 +60,13 @@
 
 #### Defined in
 
-[src/TokenManager.ts:78](https://github.com/breautek/storm/blob/8c3a317/src/TokenManager.ts#L78)
+[src/TokenManager.ts:78](https://github.com/breautek/storm/blob/3ad3438/src/TokenManager.ts#L78)
 
 ___
 
 ### sign
 
-▸ **sign**(`payload`, `expiresIn`): `Promise`<[`Token`](Token.Token-1.md)\>
+▸ **sign**(`payload`, `expiresIn`): `Promise`<[`Token`](Token.md)\>
 
 #### Parameters
 
@@ -79,11 +77,11 @@ ___
 
 #### Returns
 
-`Promise`<[`Token`](Token.Token-1.md)\>
+`Promise`<[`Token`](Token.md)\>
 
 #### Defined in
 
-[src/TokenManager.ts:33](https://github.com/breautek/storm/blob/8c3a317/src/TokenManager.ts#L33)
+[src/TokenManager.ts:33](https://github.com/breautek/storm/blob/3ad3438/src/TokenManager.ts#L33)
 
 ___
 
@@ -95,8 +93,8 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `token` | [`Token`](Token.Token-1.md) |
-| `options?` | [`IJWTVerifyOptions`](../interfaces/IJWTVerifyOptions.IJWTVerifyOptions-1.md) |
+| `token` | [`Token`](Token.md) |
+| `options?` | [`IJWTVerifyOptions`](../interfaces/IJWTVerifyOptions.md) |
 
 #### Returns
 
@@ -104,4 +102,4 @@ ___
 
 #### Defined in
 
-[src/TokenManager.ts:56](https://github.com/breautek/storm/blob/8c3a317/src/TokenManager.ts#L56)
+[src/TokenManager.ts:56](https://github.com/breautek/storm/blob/3ad3438/src/TokenManager.ts#L56)

package/docs/classes/UnauthorizedAccessError.md

@@ -0,0 +1,301 @@
+[@breautek/storm](../README.md) / UnauthorizedAccessError
+
+# Class: UnauthorizedAccessError
+
+## Hierarchy
+
+- [`StormError`](StormError.md)
+
+  ↳ **`UnauthorizedAccessError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](UnauthorizedAccessError.md#constructor)
+
+### Properties
+
+- [message](UnauthorizedAccessError.md#message)
+- [name](UnauthorizedAccessError.md#name)
+- [stack](UnauthorizedAccessError.md#stack)
+- [prepareStackTrace](UnauthorizedAccessError.md#preparestacktrace)
+- [stackTraceLimit](UnauthorizedAccessError.md#stacktracelimit)
+
+### Methods
+
+- [getCode](UnauthorizedAccessError.md#getcode)
+- [getErrorResponse](UnauthorizedAccessError.md#geterrorresponse)
+- [getExitCode](UnauthorizedAccessError.md#getexitcode)
+- [getHTTPCode](UnauthorizedAccessError.md#gethttpcode)
+- [getMessage](UnauthorizedAccessError.md#getmessage)
+- [getPrivateDetails](UnauthorizedAccessError.md#getprivatedetails)
+- [getPublicDetails](UnauthorizedAccessError.md#getpublicdetails)
+- [captureStackTrace](UnauthorizedAccessError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new UnauthorizedAccessError**(`userToken`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `userToken` | `string` |
+
+#### Overrides
+
+[StormError](StormError.md).[constructor](StormError.md#constructor)
+
+#### Defined in
+
+[src/UnauthorizedAccessError.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L22)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[message](StormError.md#message)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1029
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[name](StormError.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1028
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[stack](StormError.md#stack)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1030
+
+___
+
+### 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/UnauthorizedAccessError.ts:30](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L30)
+
+___
+
+### 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/3ad3438/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/3ad3438/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/UnauthorizedAccessError.ts:34](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L34)
+
+___
+
+### getMessage
+
+▸ **getMessage**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[StormError](StormError.md).[getMessage](StormError.md#getmessage)
+
+#### Defined in
+
+[src/UnauthorizedAccessError.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L26)
+
+___
+
+### 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/3ad3438/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/3ad3438/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

package/docs/enums/ErrorCode.md

@@ -0,0 +1,107 @@
+[@breautek/storm](../README.md) / ErrorCode
+
+# Enumeration: ErrorCode
+
+## Table of contents
+
+### Enumeration Members
+
+- [DUPLICATE\_ENTRY](ErrorCode.md#duplicate_entry)
+- [EXPIRED\_TOKEN](ErrorCode.md#expired_token)
+- [INSUFFICIENT\_DISK\_SPACE](ErrorCode.md#insufficient_disk_space)
+- [INTERNAL](ErrorCode.md#internal)
+- [INVALID\_CONFIG](ErrorCode.md#invalid_config)
+- [INVALID\_CREDENTIALS](ErrorCode.md#invalid_credentials)
+- [INVALID\_VALUE](ErrorCode.md#invalid_value)
+- [MISSING\_PARAMETER](ErrorCode.md#missing_parameter)
+- [UNAUTHORIZED\_ACCESS](ErrorCode.md#unauthorized_access)
+
+## Enumeration Members
+
+### DUPLICATE\_ENTRY
+
+• **DUPLICATE\_ENTRY**
+
+#### Defined in
+
+[src/ErrorCode.ts:23](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L23)
+
+___
+
+### EXPIRED\_TOKEN
+
+• **EXPIRED\_TOKEN**
+
+#### Defined in
+
+[src/ErrorCode.ts:20](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L20)
+
+___
+
+### INSUFFICIENT\_DISK\_SPACE
+
+• **INSUFFICIENT\_DISK\_SPACE**
+
+#### Defined in
+
+[src/ErrorCode.ts:25](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L25)
+
+___
+
+### INTERNAL
+
+• **INTERNAL**
+
+#### Defined in
+
+[src/ErrorCode.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L18)
+
+___
+
+### INVALID\_CONFIG
+
+• **INVALID\_CONFIG**
+
+#### Defined in
+
+[src/ErrorCode.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L26)
+
+___
+
+### INVALID\_CREDENTIALS
+
+• **INVALID\_CREDENTIALS**
+
+#### Defined in
+
+[src/ErrorCode.ts:21](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L21)
+
+___
+
+### INVALID\_VALUE
+
+• **INVALID\_VALUE**
+
+#### Defined in
+
+[src/ErrorCode.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L22)
+
+___
+
+### MISSING\_PARAMETER
+
+• **MISSING\_PARAMETER**
+
+#### Defined in
+
+[src/ErrorCode.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L19)
+
+___
+
+### UNAUTHORIZED\_ACCESS
+
+• **UNAUTHORIZED\_ACCESS**
+
+#### Defined in
+
+[src/ErrorCode.ts:24](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L24)

package/docs/enums/ExitCode.md

@@ -0,0 +1,30 @@
+[@breautek/storm](../README.md) / ExitCode
+
+# Enumeration: ExitCode
+
+## Table of contents
+
+### Enumeration Members
+
+- [INVALID\_CONFIG](ExitCode.md#invalid_config)
+- [MISSING\_CONFIG](ExitCode.md#missing_config)
+
+## Enumeration Members
+
+### INVALID\_CONFIG
+
+• **INVALID\_CONFIG**
+
+#### Defined in
+
+[src/ExitCode.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/ExitCode.ts#L19)
+
+___
+
+### MISSING\_CONFIG
+
+• **MISSING\_CONFIG**
+
+#### Defined in
+
+[src/ExitCode.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/ExitCode.ts#L18)

package/docs/enums/HTTPMethod.md

@@ -0,0 +1,52 @@
+[@breautek/storm](../README.md) / HTTPMethod
+
+# Enumeration: HTTPMethod
+
+## Table of contents
+
+### Enumeration Members
+
+- [DELETE](HTTPMethod.md#delete)
+- [GET](HTTPMethod.md#get)
+- [POST](HTTPMethod.md#post)
+- [PUT](HTTPMethod.md#put)
+
+## Enumeration Members
+
+### DELETE
+
+• **DELETE**
+
+#### Defined in
+
+[src/HTTPMethod.ts:21](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L21)
+
+___
+
+### GET
+
+• **GET**
+
+#### Defined in
+
+[src/HTTPMethod.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L18)
+
+___
+
+### POST
+
+• **POST**
+
+#### Defined in
+
+[src/HTTPMethod.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L19)
+
+___
+
+### PUT
+
+• **PUT**
+
+#### Defined in
+
+[src/HTTPMethod.ts:20](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L20)

package/docs/enums/JWTError.md

@@ -0,0 +1,30 @@
+[@breautek/storm](../README.md) / JWTError
+
+# Enumeration: JWTError
+
+## Table of contents
+
+### Enumeration Members
+
+- [ERR\_EXPIRED](JWTError.md#err_expired)
+- [ERR\_GENERIC](JWTError.md#err_generic)
+
+## Enumeration Members
+
+### ERR\_EXPIRED
+
+• **ERR\_EXPIRED**
+
+#### Defined in
+
+[src/JWTError.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/JWTError.ts#L18)
+
+___
+
+### ERR\_GENERIC
+
+• **ERR\_GENERIC**
+
+#### Defined in
+
+[src/JWTError.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/JWTError.ts#L19)