@rapidrest/core 1.0.1

package/docs/reference/interfaces/Alert.md

@@ -0,0 +1,101 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / Alert
+
+# Interface: Alert
+
+Defined in: src/AlertUtils.ts:40
+
+Describes a single system failure or other similar critical event that requires immediate attention.
+
+## Properties
+
+### alias
+
+> **alias**: `string`
+
+Defined in: src/AlertUtils.ts:42
+
+The name of the alert that uniquely identifies the report for purposes of de-duplication.
+
+***
+
+### description
+
+> **description**: `string`
+
+Defined in: src/AlertUtils.ts:44
+
+The detailed information about the event that has occurred.
+
+***
+
+### details?
+
+> `optional` **details**: `any`
+
+Defined in: src/AlertUtils.ts:46
+
+A key-value map of custom information about the alert.
+
+***
+
+### entity?
+
+> `optional` **entity**: `string`
+
+Defined in: src/AlertUtils.ts:48
+
+Used to specify a category or problem domain for filtering.
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: src/AlertUtils.ts:50
+
+The basic summary of the alert that describes the event.
+
+***
+
+### note?
+
+> `optional` **note**: `string`
+
+Defined in: src/AlertUtils.ts:52
+
+Additional detail about the event.
+
+***
+
+### priority
+
+> **priority**: [`AlertPriority`](../enumerations/AlertPriority.md)
+
+Defined in: src/AlertUtils.ts:54
+
+The priority level of the alert.
+
+***
+
+### source
+
+> **source**: `string`
+
+Defined in: src/AlertUtils.ts:56
+
+The source of the alert. Can be a pod/service name, IP address or other unique identifier.
+
+***
+
+### tags?
+
+> `optional` **tags**: `string`[]
+
+Defined in: src/AlertUtils.ts:58
+
+A list of unique tags to associate with the event.

package/docs/reference/interfaces/AlertAttachment.md

@@ -0,0 +1,51 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / AlertAttachment
+
+# Interface: AlertAttachment
+
+Defined in: src/AlertUtils.ts:64
+
+Describes a single attachment that can be added to an alert.
+
+## Properties
+
+### contentType
+
+> **contentType**: `string`
+
+Defined in: src/AlertUtils.ts:66
+
+The content-type of the attachment.
+
+***
+
+### data
+
+> **data**: `Buffer`\<`ArrayBufferLike`\> \| `ReadStream`
+
+Defined in: src/AlertUtils.ts:68
+
+The contents of the attachment.
+
+***
+
+### filename
+
+> **filename**: `string`
+
+Defined in: src/AlertUtils.ts:70
+
+The name of the attachment.
+
+***
+
+### size?
+
+> `optional` **size**: `number`
+
+Defined in: src/AlertUtils.ts:72
+
+The size of the attachment.

package/docs/reference/interfaces/AlertClose.md

@@ -0,0 +1,31 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / AlertClose
+
+# Interface: AlertClose
+
+Defined in: src/AlertUtils.ts:78
+
+Describes a request to close an alert.
+
+## Properties
+
+### note?
+
+> `optional` **note**: `string`
+
+Defined in: src/AlertUtils.ts:82
+
+Additional alert note to add.
+
+***
+
+### source?
+
+> `optional` **source**: `string`
+
+Defined in: src/AlertUtils.ts:80
+
+Display name of the request source.

package/docs/reference/interfaces/AlertUtilsAttachmentOptions.md

@@ -0,0 +1,42 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / AlertUtilsAttachmentOptions
+
+# Interface: AlertUtilsAttachmentOptions
+
+Defined in: src/AlertUtils.ts:100
+
+Describes the alert attachment options to use when creating an alert.
+
+## Properties
+
+### files
+
+> **files**: [`AlertAttachment`](AlertAttachment.md)[]
+
+Defined in: src/AlertUtils.ts:102
+
+The attachment files to upload with the alert.
+
+***
+
+### indexFile?
+
+> `optional` **indexFile**: `string`
+
+Defined in: src/AlertUtils.ts:104
+
+The name of the index file when the attachment is a zip file.
+
+***
+
+### zip?
+
+> `optional` **zip**: `boolean`
+
+Defined in: src/AlertUtils.ts:109
+
+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

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

package/docs/reference/interfaces/InstanceOptions.md

@@ -0,0 +1,35 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / InstanceOptions
+
+# Interface: InstanceOptions
+
+Defined in: src/ObjectFactory.ts:11
+
+The set of options to use when creating new instances of objects.
+
+## Properties
+
+### args?
+
+> `optional` **args**: `any`[]
+
+Defined in: src/ObjectFactory.ts:12
+
+***
+
+### initialize?
+
+> `optional` **initialize**: `boolean`
+
+Defined in: src/ObjectFactory.ts:14
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: src/ObjectFactory.ts:13

package/docs/reference/interfaces/JWTPayload.md

@@ -0,0 +1,143 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / JWTPayload
+
+# Interface: JWTPayload
+
+Defined in: src/JWTUtils.ts:38
+
+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
+
+Indicates if the payload profile has been compressed and with what method.
+
+***
+
+### encryption?
+
+> `optional` **encryption**: `boolean`
+
+Defined in: src/JWTUtils.ts:43
+
+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
+
+The user profile of the authenticated user the token is valid for.
+
+***
+
+### sessionUid
+
+> **sessionUid**: `string`
+
+Defined in: src/JWTUtils.ts:49
+
+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

@@ -0,0 +1,55 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / JWTUser
+
+# Interface: JWTUser
+
+Defined in: src/JWTUtils.ts:13
+
+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
+
+The unique name of the user.
+
+***
+
+### roles
+
+> **roles**: `string`[]
+
+Defined in: src/JWTUtils.ts:27
+
+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
+
+The universally unique identifier of the user.
+
+***
+
+### verified?
+
+> `optional` **verified**: `boolean`
+
+Defined in: src/JWTUtils.ts:32
+
+Indicates if the user's e-mail address has been verified.

package/docs/reference/interfaces/JWTUtilsConfig.md

@@ -0,0 +1,45 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / JWTUtilsConfig
+
+# Interface: JWTUtilsConfig
+
+Defined in: src/JWTUtils.ts:123
+
+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
+
+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
+
+The options that determine how JWT token payloads will be handled.
+
+***
+
+### secret
+
+> **secret**: `Secret`
+
+Defined in: src/JWTUtils.ts:127
+
+The secret to use for signing and verifying JWT tokens.

package/docs/reference/interfaces/JWTUtilsPayloadKeyOptions.md

@@ -0,0 +1,68 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / JWTUtilsPayloadKeyOptions
+
+# Interface: JWTUtilsPayloadKeyOptions
+
+Defined in: src/JWTUtils.ts:106
+
+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
+
+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
+
+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
+
+The private key used to encrypt JWT token payloads.
+
+***
+
+### public\_key
+
+> **public\_key**: `string`
+
+Defined in: src/JWTUtils.ts:115
+
+The public key used to decrypt JWT token payloads.

package/docs/reference/interfaces/JWTUtilsPayloadOptions.md

@@ -0,0 +1,40 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / JWTUtilsPayloadOptions
+
+# Interface: JWTUtilsPayloadOptions
+
+Defined in: src/JWTUtils.ts:65
+
+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
+
+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
+
+Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.