@rapidrest/core 1.3.1 → 1.4.0

package/docs/reference/interfaces/AlertUtilsAttachmentOptions.md

@@ -1,42 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / AlertUtilsAttachmentOptions
-
-# Interface: AlertUtilsAttachmentOptions
-
-Defined in: [src/AlertUtils.ts:100](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L100)
-
-Describes the alert attachment options to use when creating an alert.
-
-## Properties
-
-### files
-
-> **files**: [`AlertAttachment`](AlertAttachment.md)[]
-
-Defined in: [src/AlertUtils.ts:102](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L102)
-
-The attachment files to upload with the alert.
-
-***
-
-### indexFile?
-
-> `optional` **indexFile?**: `string`
-
-Defined in: [src/AlertUtils.ts:104](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L104)
-
-The name of the index file when the attachment is a zip file.
-
-***
-
-### zip?
-
-> `optional` **zip?**: `boolean`
-
-Defined in: [src/AlertUtils.ts:109](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L109)
-
-Set to `true` to to package all files into a single zip before being uploaded, otherwise set to `false` to
-upload each file individually.

package/docs/reference/interfaces/AlertUtilsOptions.md

@@ -1,41 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / AlertUtilsOptions
-
-# Interface: AlertUtilsOptions
-
-Defined in: [src/AlertUtils.ts:88](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L88)
-
-The set of configuration options to pass to AlertUtils when creating an instance.
-
-## Properties
-
-### auth
-
-> **auth**: `string`
-
-Defined in: [src/AlertUtils.ts:90](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L90)
-
-The value of the Authorization header to apply to all outgoing HTTP requests.
-
-***
-
-### logger?
-
-> `optional` **logger?**: `any`
-
-Defined in: [src/AlertUtils.ts:94](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L94)
-
-The logging utility to use.
-
-***
-
-### serviceUrl
-
-> **serviceUrl**: `string`
-
-Defined in: [src/AlertUtils.ts:92](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L92)
-
-The full url of the REST API service that alerts will be sent to.

package/docs/reference/interfaces/InstanceOptions.md

@@ -1,41 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / InstanceOptions
-
-# Interface: InstanceOptions
-
-Defined in: [src/ObjectFactory.ts:11](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L11)
-
-The set of options to use when creating new instances of objects.
-
-## Properties
-
-### args?
-
-> `optional` **args?**: `any`[]
-
-Defined in: [src/ObjectFactory.ts:13](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L13)
-
-The list of arguments to pass to the class constructor.
-
-***
-
-### initialize?
-
-> `optional` **initialize?**: `boolean`
-
-Defined in: [src/ObjectFactory.ts:17](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L17)
-
-Set to `true` to perform initialization of the object after creation, otherwise set to `false`. Default is `true`.
-
-***
-
-### name?
-
-> `optional` **name?**: `string`
-
-Defined in: [src/ObjectFactory.ts:15](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L15)
-
-The unique name of the object instance.

package/docs/reference/interfaces/JWTPayload.md

@@ -1,143 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / JWTPayload
-
-# Interface: JWTPayload
-
-Defined in: [src/JWTUtils.ts:38](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L38)
-
-Describes the payload data structure of signed JWT tokens.
-
-## Extends
-
-- `JwtPayload`
-
-## Indexable
-
-> \[`key`: `string`\]: `any`
-
-## Properties
-
-### aud?
-
-> `optional` **aud?**: `string` \| `string`[]
-
-Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:115
-
-#### Inherited from
-
-`jwt.JwtPayload.aud`
-
-***
-
-### compression?
-
-> `optional` **compression?**: `"zlib"`
-
-Defined in: [src/JWTUtils.ts:40](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L40)
-
-Indicates if the payload profile has been compressed and with what method.
-
-***
-
-### encryption?
-
-> `optional` **encryption?**: `boolean`
-
-Defined in: [src/JWTUtils.ts:43](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L43)
-
-Indicates if the payload profile has been encrypted.
-
-***
-
-### exp?
-
-> `optional` **exp?**: `number`
-
-Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:116
-
-#### Inherited from
-
-`jwt.JwtPayload.exp`
-
-***
-
-### iat?
-
-> `optional` **iat?**: `number`
-
-Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:118
-
-#### Inherited from
-
-`jwt.JwtPayload.iat`
-
-***
-
-### iss?
-
-> `optional` **iss?**: `string`
-
-Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:113
-
-#### Inherited from
-
-`jwt.JwtPayload.iss`
-
-***
-
-### jti?
-
-> `optional` **jti?**: `string`
-
-Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:119
-
-#### Inherited from
-
-`jwt.JwtPayload.jti`
-
-***
-
-### nbf?
-
-> `optional` **nbf?**: `number`
-
-Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:117
-
-#### Inherited from
-
-`jwt.JwtPayload.nbf`
-
-***
-
-### profile
-
-> **profile**: `string` \| [`JWTUser`](JWTUser.md)
-
-Defined in: [src/JWTUtils.ts:46](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L46)
-
-The user profile of the authenticated user the token is valid for.
-
-***
-
-### sessionUid
-
-> **sessionUid**: `string`
-
-Defined in: [src/JWTUtils.ts:49](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L49)
-
-The unique identifier of the user's authentication session.
-
-***
-
-### sub?
-
-> `optional` **sub?**: `string`
-
-Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:114
-
-#### Inherited from
-
-`jwt.JwtPayload.sub`

package/docs/reference/interfaces/JWTUser.md

@@ -1,55 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / JWTUser
-
-# Interface: JWTUser
-
-Defined in: [src/JWTUtils.ts:13](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L13)
-
-Describes user data that is encoded in the payload of a JWT token.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Properties
-
-### name
-
-> **name**: `string`
-
-Defined in: [src/JWTUtils.ts:22](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L22)
-
-The unique name of the user.
-
-***
-
-### roles
-
-> **roles**: `string`[]
-
-Defined in: [src/JWTUtils.ts:27](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L27)
-
-The list of roles (by name) that the user is apart of and will assume privileges for.
-
-***
-
-### uid
-
-> **uid**: `string`
-
-Defined in: [src/JWTUtils.ts:17](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L17)
-
-The universally unique identifier of the user.
-
-***
-
-### verified?
-
-> `optional` **verified?**: `boolean`
-
-Defined in: [src/JWTUtils.ts:32](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L32)
-
-Indicates if the user's e-mail address has been verified.

package/docs/reference/interfaces/JWTUtilsConfig.md

@@ -1,45 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / JWTUtilsConfig
-
-# Interface: JWTUtilsConfig
-
-Defined in: [src/JWTUtils.ts:123](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L123)
-
-Describes the configuration options to be used with `JWTUtils` functions.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Properties
-
-### options?
-
-> `optional` **options?**: `VerifyOptions`
-
-Defined in: [src/JWTUtils.ts:132](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L132)
-
-The options to use when performing JWT signing or verification.
-
-***
-
-### payload?
-
-> `optional` **payload?**: [`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md) \| [`JWTUtilsPayloadPasswordOptions`](JWTUtilsPayloadPasswordOptions.md) \| [`JWTUtilsPayloadKeyOptions`](JWTUtilsPayloadKeyOptions.md)
-
-Defined in: [src/JWTUtils.ts:137](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L137)
-
-The options that determine how JWT token payloads will be handled.
-
-***
-
-### secret
-
-> **secret**: `Secret`
-
-Defined in: [src/JWTUtils.ts:127](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L127)
-
-The secret to use for signing and verifying JWT tokens.

package/docs/reference/interfaces/JWTUtilsPayloadKeyOptions.md

@@ -1,68 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / JWTUtilsPayloadKeyOptions
-
-# Interface: JWTUtilsPayloadKeyOptions
-
-Defined in: [src/JWTUtils.ts:106](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L106)
-
-Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing
-key-based encryption.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Extends
-
-- [`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md)
-
-## Properties
-
-### compress?
-
-> `optional` **compress?**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
-
-Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L69)
-
-Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
-
-#### Inherited from
-
-[`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md).[`compress`](JWTUtilsPayloadOptions.md#compress)
-
-***
-
-### encrypt?
-
-> `optional` **encrypt?**: `boolean`
-
-Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L74)
-
-Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.
-
-#### Inherited from
-
-[`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md).[`encrypt`](JWTUtilsPayloadOptions.md#encrypt)
-
-***
-
-### private\_key
-
-> **private\_key**: `string`
-
-Defined in: [src/JWTUtils.ts:110](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L110)
-
-The private key used to encrypt JWT token payloads.
-
-***
-
-### public\_key
-
-> **public\_key**: `string`
-
-Defined in: [src/JWTUtils.ts:115](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L115)
-
-The public key used to decrypt JWT token payloads.

package/docs/reference/interfaces/JWTUtilsPayloadOptions.md

@@ -1,40 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / JWTUtilsPayloadOptions
-
-# Interface: JWTUtilsPayloadOptions
-
-Defined in: [src/JWTUtils.ts:65](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L65)
-
-Describes the configuration options to be used with the `JWTUtilsConfig.payload` property.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Extended by
-
-- [`JWTUtilsPayloadPasswordOptions`](JWTUtilsPayloadPasswordOptions.md)
-- [`JWTUtilsPayloadKeyOptions`](JWTUtilsPayloadKeyOptions.md)
-
-## Properties
-
-### compress?
-
-> `optional` **compress?**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
-
-Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L69)
-
-Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
-
-***
-
-### encrypt?
-
-> `optional` **encrypt?**: `boolean`
-
-Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L74)
-
-Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.

package/docs/reference/interfaces/JWTUtilsPayloadPasswordOptions.md

@@ -1,78 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / JWTUtilsPayloadPasswordOptions
-
-# Interface: JWTUtilsPayloadPasswordOptions
-
-Defined in: [src/JWTUtils.ts:83](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L83)
-
-Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing password
-based encryption.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Extends
-
-- [`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md)
-
-## Properties
-
-### algorithm
-
-> **algorithm**: `string`
-
-Defined in: [src/JWTUtils.ts:87](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L87)
-
-The cryptographic cipher algorithm to use during encryption/decryption of a JWT token payload.
-
-***
-
-### compress?
-
-> `optional` **compress?**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
-
-Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L69)
-
-Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
-
-#### Inherited from
-
-[`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md).[`compress`](JWTUtilsPayloadOptions.md#compress)
-
-***
-
-### encrypt?
-
-> `optional` **encrypt?**: `boolean`
-
-Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L74)
-
-Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.
-
-#### Inherited from
-
-[`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md).[`encrypt`](JWTUtilsPayloadOptions.md#encrypt)
-
-***
-
-### iv
-
-> **iv**: `Buffer`
-
-Defined in: [src/JWTUtils.ts:92](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L92)
-
-The initialization vector to use during encryption and decryption.
-
-***
-
-### password
-
-> **password**: `string`
-
-Defined in: [src/JWTUtils.ts:97](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L97)
-
-The password to use when encrypting or decrypting JWT token payloads.

package/docs/reference/interfaces/NewEvent.md

@@ -1,25 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / NewEvent
-
-# Interface: NewEvent
-
-Defined in: [src/TelemetryUtils.ts:13](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L13)
-
-Describes the required fields when creating a new telemetry event.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Properties
-
-### type
-
-> **type**: `string`
-
-Defined in: [src/TelemetryUtils.ts:15](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L15)
-
-The type of event begin recorded.

package/docs/reference/interfaces/OriginSettings.md

@@ -1,25 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / OriginSettings
-
-# Interface: OriginSettings
-
-Defined in: [src/MessagingUtils.ts:8](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L8)
-
-## Properties
-
-### email
-
-> **email**: `string`
-
-Defined in: [src/MessagingUtils.ts:9](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L9)
-
-***
-
-### sms
-
-> **sms**: `string`
-
-Defined in: [src/MessagingUtils.ts:10](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L10)

package/docs/reference/interfaces/SlackConfig.md

@@ -1,33 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / SlackConfig
-
-# Interface: SlackConfig
-
-Defined in: [src/MessagingUtils.ts:48](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L48)
-
-## Properties
-
-### name
-
-> **name**: `string`
-
-Defined in: [src/MessagingUtils.ts:49](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L49)
-
-***
-
-### signingSecret
-
-> **signingSecret**: `string`
-
-Defined in: [src/MessagingUtils.ts:51](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L51)
-
-***
-
-### token
-
-> **token**: `string`
-
-Defined in: [src/MessagingUtils.ts:50](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L50)

package/docs/reference/interfaces/SmtpAuth.md

@@ -1,25 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / SmtpAuth
-
-# Interface: SmtpAuth
-
-Defined in: [src/MessagingUtils.ts:54](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L54)
-
-## Properties
-
-### pass
-
-> **pass**: `string`
-
-Defined in: [src/MessagingUtils.ts:56](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L56)
-
-***
-
-### user
-
-> **user**: `string`
-
-Defined in: [src/MessagingUtils.ts:55](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L55)