@breautek/storm 5.0.1 → 6.0.1

package/docs/classes/StormError.md

@@ -1,343 +0,0 @@
-[@breautek/storm](../README.md) / StormError
-
-# Class: StormError<TErrorDetails\>
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TErrorDetails` | `any` |
-
-## Hierarchy
-
-- `Error`
-
-  ↳ **`StormError`**
-
-  ↳↳ [`RawError`](RawError.md)
-
-  ↳↳ [`MissingParameterError`](MissingParameterError.md)
-
-  ↳↳ [`InvalidCredentialsError`](InvalidCredentialsError.md)
-
-  ↳↳ [`InternalError`](InternalError.md)
-
-  ↳↳ [`ExpiredTokenError`](ExpiredTokenError.md)
-
-  ↳↳ [`InvalidValueError`](InvalidValueError.md)
-
-  ↳↳ [`UnauthorizedAccessError`](UnauthorizedAccessError.md)
-
-  ↳↳ [`EntityNotFoundError`](EntityNotFoundError.md)
-
-  ↳↳ [`DiskSpaceError`](DiskSpaceError.md)
-
-  ↳↳ [`DuplicateEntryError`](DuplicateEntryError.md)
-
-  ↳↳ [`MissingConfigError`](MissingConfigError.md)
-
-  ↳↳ [`DatabaseQueryError`](DatabaseQueryError.md)
-
-  ↳↳ [`NotImplementedError`](NotImplementedError.md)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](StormError.md#constructor)
-
-### Properties
-
-- [message](StormError.md#message)
-- [name](StormError.md#name)
-- [stack](StormError.md#stack)
-- [prepareStackTrace](StormError.md#preparestacktrace)
-- [stackTraceLimit](StormError.md#stacktracelimit)
-
-### Methods
-
-- [getCode](StormError.md#getcode)
-- [getErrorResponse](StormError.md#geterrorresponse)
-- [getExitCode](StormError.md#getexitcode)
-- [getHTTPCode](StormError.md#gethttpcode)
-- [getLocaleCode](StormError.md#getlocalecode)
-- [getLocaleParameters](StormError.md#getlocaleparameters)
-- [getMessage](StormError.md#getmessage)
-- [getPrivateDetails](StormError.md#getprivatedetails)
-- [getPublicDetails](StormError.md#getpublicdetails)
-- [captureStackTrace](StormError.md#capturestacktrace)
-
-## Constructors
-
-### constructor
-
-• **new StormError**<`TErrorDetails`\>(`details?`)
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TErrorDetails` | `any` |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `details?` | `TErrorDetails` |
-
-#### Overrides
-
-Error.constructor
-
-#### Defined in
-
-[src/StormError.ts:44](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L44)
-
-## Properties
-
-### message
-
-• **message**: `string`
-
-#### Inherited from
-
-Error.message
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1054
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-Error.name
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1053
-
-___
-
-### stack
-
-• `Optional` **stack**: `string`
-
-#### Inherited from
-
-Error.stack
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1055
-
-___
-
-### 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
-
-Error.prepareStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:11
-
-___
-
-### stackTraceLimit
-
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-Error.stackTraceLimit
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:13
-
-## Methods
-
-### getCode
-
-▸ `Abstract` **getCode**(): `number`
-
-#### Returns
-
-`number`
-
-#### Defined in
-
-[src/StormError.ts:55](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L55)
-
-___
-
-### getErrorResponse
-
-▸ **getErrorResponse**(): [`IErrorResponse`](../interfaces/IErrorResponse.md)
-
-#### Returns
-
-[`IErrorResponse`](../interfaces/IErrorResponse.md)
-
-#### Defined in
-
-[src/StormError.ts:76](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L76)
-
-___
-
-### getExitCode
-
-▸ **getExitCode**(): [`ExitCode`](../enums/ExitCode.md)
-
-#### Returns
-
-[`ExitCode`](../enums/ExitCode.md)
-
-#### Defined in
-
-[src/StormError.ts:97](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L97)
-
-___
-
-### getHTTPCode
-
-▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.md)
-
-#### Returns
-
-[`StatusCode`](../enums/StatusCode.md)
-
-#### Defined in
-
-[src/StormError.ts:72](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L72)
-
-___
-
-### getLocaleCode
-
-▸ **getLocaleCode**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/StormError.ts:89](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L89)
-
-___
-
-### getLocaleParameters
-
-▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
-
-#### Returns
-
-`Record`<`string`, `string`\>
-
-#### Defined in
-
-[src/StormError.ts:93](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L93)
-
-___
-
-### getMessage
-
-▸ `Abstract` **getMessage**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/StormError.ts:54](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L54)
-
-___
-
-### getPrivateDetails
-
-▸ **getPrivateDetails**(): `TErrorDetails`
-
-Private details are only logged to the server log.
-They are kept secret from the client.
-
-#### Returns
-
-`TErrorDetails`
-
-#### Defined in
-
-[src/StormError.ts:68](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L68)
-
-___
-
-### getPublicDetails
-
-▸ **getPublicDetails**(): [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
-
-Sends details to the client.
-
-#### Returns
-
-[`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
-
-#### Defined in
-
-[src/StormError.ts:60](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L60)
-
-___
-
-### captureStackTrace
-
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-Error.captureStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:4

package/docs/classes/TemporaryTableQuery.md

@@ -1,213 +0,0 @@
-[@breautek/storm](../README.md) / TemporaryTableQuery
-
-# Class: TemporaryTableQuery
-
-## Hierarchy
-
-- [`Query`](Query.md)<`any`\>
-
-  ↳ **`TemporaryTableQuery`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](TemporaryTableQuery.md#constructor)
-
-### Methods
-
-- [\_getQuery](TemporaryTableQuery.md#_getquery)
-- [execute](TemporaryTableQuery.md#execute)
-- [getParameters](TemporaryTableQuery.md#getparameters)
-- [getParametersForQuery](TemporaryTableQuery.md#getparametersforquery)
-- [getQuery](TemporaryTableQuery.md#getquery)
-- [onPostProcess](TemporaryTableQuery.md#onpostprocess)
-- [onPreQuery](TemporaryTableQuery.md#onprequery)
-
-## Constructors
-
-### constructor
-
-• **new TemporaryTableQuery**(`parameters?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `parameters?` | `any` |
-
-#### Inherited from
-
-[Query](Query.md).[constructor](Query.md#constructor)
-
-#### Defined in
-
-[src/Query.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L23)
-
-## Methods
-
-### \_getQuery
-
-▸ `Protected` **_getQuery**(`connection`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[Query](Query.md).[_getQuery](Query.md#_getquery)
-
-#### Defined in
-
-[src/TemporaryTableQuery.ts:35](https://github.com/breautek/storm/blob/3dcafe4/src/TemporaryTableQuery.ts#L35)
-
-___
-
-### execute
-
-▸ **execute**(`connection`): `Promise`<`any`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Inherited from
-
-[Query](Query.md).[execute](Query.md#execute)
-
-#### Defined in
-
-[src/Query.ts:71](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L71)
-
-___
-
-### getParameters
-
-▸ **getParameters**(): `any`
-
-#### Returns
-
-`any`
-
-parameters that was passed into the constructor.
-
-#### Inherited from
-
-[Query](Query.md).[getParameters](Query.md#getparameters)
-
-#### Defined in
-
-[src/Query.ts:30](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L30)
-
-___
-
-### getParametersForQuery
-
-▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
-
-Query implementations may override this API to augment the parameters.
-
-#### Returns
-
-`Record`<`any`, `any`\>
-
-parameters that will be used when this query is ran.
-
-#### Overrides
-
-[Query](Query.md).[getParametersForQuery](Query.md#getparametersforquery)
-
-#### Defined in
-
-[src/TemporaryTableQuery.ts:27](https://github.com/breautek/storm/blob/3dcafe4/src/TemporaryTableQuery.ts#L27)
-
-___
-
-### getQuery
-
-▸ **getQuery**(`connection`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Query](Query.md).[getQuery](Query.md#getquery)
-
-#### Defined in
-
-[src/Query.ts:45](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L45)
-
-___
-
-### onPostProcess
-
-▸ **onPostProcess**(`connection`, `resultSet`): `Promise`<`any`\>
-
-Override to augment/manipulate the returned result set.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) | The connection object used for this query execution. Useful if further queries are required. |
-| `resultSet` | `any` | - |
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Inherited from
-
-[Query](Query.md).[onPostProcess](Query.md#onpostprocess)
-
-#### Defined in
-
-[src/Query.ts:66](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L66)
-
-___
-
-### onPreQuery
-
-▸ **onPreQuery**(`connection`): `Promise`<`void`\>
-
-Overridable to execute statements before the main query.
-Can be used to set session variables or create temporary tables, etc.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Inherited from
-
-[Query](Query.md).[onPreQuery](Query.md#onprequery)
-
-#### Defined in
-
-[src/Query.ts:56](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L56)

package/docs/classes/Token.md

@@ -1,43 +0,0 @@
-[@breautek/storm](../README.md) / Token
-
-# Class: Token
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Token.md#constructor)
-
-### Methods
-
-- [getSignature](Token.md#getsignature)
-
-## Constructors
-
-### constructor
-
-• **new Token**(`signature`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `signature` | `string` |
-
-#### Defined in
-
-[src/Token.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/Token.ts#L20)
-
-## Methods
-
-### getSignature
-
-▸ **getSignature**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/Token.ts:24](https://github.com/breautek/storm/blob/3dcafe4/src/Token.ts#L24)

package/docs/classes/TokenManager.md

@@ -1,105 +0,0 @@
-[@breautek/storm](../README.md) / TokenManager
-
-# Class: TokenManager<TAuthToken\>
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.md) = [`IAuthTokenData`](../interfaces/IAuthTokenData.md) |
-
-## Table of contents
-
-### Constructors
-
-- [constructor](TokenManager.md#constructor)
-
-### Methods
-
-- [decode](TokenManager.md#decode)
-- [sign](TokenManager.md#sign)
-- [verify](TokenManager.md#verify)
-
-## Constructors
-
-### constructor
-
-• **new TokenManager**<`TAuthToken`\>(`secret`)
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.md) = [`IAuthTokenData`](../interfaces/IAuthTokenData.md) |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `secret` | `string` |
-
-#### Defined in
-
-[src/TokenManager.ts:29](https://github.com/breautek/storm/blob/3dcafe4/src/TokenManager.ts#L29)
-
-## Methods
-
-### decode
-
-▸ **decode**(`token`): `Promise`<`TAuthToken`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `token` | [`Token`](Token.md) |
-
-#### Returns
-
-`Promise`<`TAuthToken`\>
-
-#### Defined in
-
-[src/TokenManager.ts:78](https://github.com/breautek/storm/blob/3dcafe4/src/TokenManager.ts#L78)
-
-___
-
-### sign
-
-▸ **sign**(`payload`, `expiresIn`): `Promise`<[`Token`](Token.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `payload` | `Object` |
-| `expiresIn` | `string` \| `number` |
-
-#### Returns
-
-`Promise`<[`Token`](Token.md)\>
-
-#### Defined in
-
-[src/TokenManager.ts:33](https://github.com/breautek/storm/blob/3dcafe4/src/TokenManager.ts#L33)
-
-___
-
-### verify
-
-▸ **verify**(`token`, `options?`): `Promise`<`TAuthToken`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `token` | [`Token`](Token.md) |
-| `options?` | [`IJWTVerifyOptions`](../interfaces/IJWTVerifyOptions.md) |
-
-#### Returns
-
-`Promise`<`TAuthToken`\>
-
-#### Defined in
-
-[src/TokenManager.ts:56](https://github.com/breautek/storm/blob/3dcafe4/src/TokenManager.ts#L56)