@rapidrest/core 1.2.0 → 1.3.1

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Validator.md

@@ -8,7 +8,7 @@
 
 > **Validator**(`func`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/ObjectDecorators.ts:108](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/decorators/ObjectDecorators.ts#L108)
+Defined in: [src/decorators/ObjectDecorators.ts:108](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/decorators/ObjectDecorators.ts#L108)
 
 Apply this to a property to specify the function that will be used to perform validation of the value.
 

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/type-aliases/ValidatorFunction.md

@@ -8,7 +8,7 @@
 
 > **ValidatorFunction** = (`value`) => `any`
 
-Defined in: [src/decorators/ObjectDecorators.ts:101](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/decorators/ObjectDecorators.ts#L101)
+Defined in: [src/decorators/ObjectDecorators.ts:101](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/decorators/ObjectDecorators.ts#L101)
 
 A function used to validate a property value.
 

package/docs/reference/classes/AlertUtils.md

@@ -6,7 +6,7 @@
 
 # Class: AlertUtils
 
-Defined in: [src/AlertUtils.ts:116](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L116)
+Defined in: [src/AlertUtils.ts:116](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L116)
 
 The `AlertUtils` class is used to send alerts about important system events that have occurred
 and require further monitoring or intervention.
@@ -17,7 +17,7 @@ and require further monitoring or intervention.
 
 > **new AlertUtils**(`options`): `AlertUtils`
 
-Defined in: [src/AlertUtils.ts:128](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L128)
+Defined in: [src/AlertUtils.ts:128](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L128)
 
 Creates a new instance of `AuthUtils` with the provided defaults.
 
@@ -39,7 +39,7 @@ The configuration options to use.
 
 > **addAttachment**(`id`, `attachment`, `indexFile?`): `Promise`\<`boolean`\>
 
-Defined in: [src/AlertUtils.ts:298](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L298)
+Defined in: [src/AlertUtils.ts:298](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L298)
 
 Uploads a single attachment to the alert with the given unique identifier.
 
@@ -75,7 +75,7 @@ True if the operation was successful, otherwise false.
 
 > **close**(`id`, `data?`): `Promise`\<`boolean`\>
 
-Defined in: [src/AlertUtils.ts:139](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L139)
+Defined in: [src/AlertUtils.ts:139](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L139)
 
 Attempts to close the existing alert with the given identifier.
 
@@ -103,7 +103,7 @@ True if the operation was successful, otherwise false.
 
 > **get**(`id`): `Promise`\<[`Alert`](../interfaces/Alert.md) \| `null`\>
 
-Defined in: [src/AlertUtils.ts:167](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L167)
+Defined in: [src/AlertUtils.ts:167](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L167)
 
 Attempts to retrieve the existing alert with the given identifier.
 
@@ -127,7 +127,7 @@ The retrieved alert if successful, otherwise `null`.
 
 > **send**(`alert`, `vars?`, `attachments?`): `Promise`\<`string` \| `null`\>
 
-Defined in: [src/AlertUtils.ts:191](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L191)
+Defined in: [src/AlertUtils.ts:191](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L191)
 
 Sends the provided alert to the configured monitoring service.
 

package/docs/reference/classes/ApiError.md

@@ -6,7 +6,7 @@
 
 # Class: ApiError
 
-Defined in: [src/ApiError.ts:8](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ApiError.ts#L8)
+Defined in: [src/ApiError.ts:8](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ApiError.ts#L8)
 
 Describes an error that originates from a API service. This class extends the standard `Error` class to include
 a unique code that can be used to trace an error to source code as well as the HTTP response status returned with
@@ -22,7 +22,7 @@ the error.
 
 > **new ApiError**(`code`, `status`, `message?`, `templateVariables?`): `ApiError`
 
-Defined in: [src/ApiError.ts:24](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ApiError.ts#L24)
+Defined in: [src/ApiError.ts:24](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ApiError.ts#L24)
 
 #### Parameters
 
@@ -56,7 +56,7 @@ Defined in: [src/ApiError.ts:24](https://github.com/rapidrest/core/blob/0eb0ed11
 
 > **code**: `string`
 
-Defined in: [src/ApiError.ts:10](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ApiError.ts#L10)
+Defined in: [src/ApiError.ts:10](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ApiError.ts#L10)
 
 The unique code of the error.
 
@@ -102,7 +102,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
 
 > **status**: `number`
 
-Defined in: [src/ApiError.ts:12](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ApiError.ts#L12)
+Defined in: [src/ApiError.ts:12](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ApiError.ts#L12)
 
 The HTTP status associated with the error.
 
@@ -134,7 +134,7 @@ not capture any frames.
 
 > **ApiMessageTemplate**(`message`, `templateVariables?`): `string`
 
-Defined in: [src/ApiError.ts:14](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ApiError.ts#L14)
+Defined in: [src/ApiError.ts:14](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ApiError.ts#L14)
 
 #### Parameters
 

package/docs/reference/classes/ClassLoader.md

@@ -6,45 +6,45 @@
 
 # Class: ClassLoader
 
-Defined in: [src/ClassLoader.ts:48](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L48)
+Defined in: [src/ClassLoader.ts:51](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L51)
 
-The *ClassLoader* provides a container for dynamically loading classes at runtime using C#/Java style namespaces.
+The *ClassLoader* provides a container for dynamically loading classes at runtime using C#/Java style namespaces.
 Namespaces are determined from the folder structure relative to the root.
 
-Class names are derived either directly from the modules export name or inferred from the module's file path when
+Class names are derived either directly from the modules export name or inferred from the module's file path when
 the `default` export is used.
 
-For example, given the following example TypeScript module at relative path `com/company/MyClass.ts` would register
+For example, given the following example TypeScript module at relative path `com/company/MyClass.ts` would register
 a class with fully qualified name `com.company.MyClass`.
 
-```javascript
-export default class MyClass {
-    // ...
-}
+```javascript
+export default class MyClass {
+    // ...
+}
 ```
 
-In the event that multiple exports are defined, the fully qualified name will take on the export name instead of the
-module name. Thus, the following example module at relative path `com/company/MyClasses.ts` would register the following
-classes.
-- `com.company.MyClass`
+In the event that multiple exports are defined, the fully qualified name will take on the export name instead of the
+module name. Thus, the following example module at relative path `com/company/MyClasses.ts` would register the following
+classes.
+- `com.company.MyClass`
 - `com.company.MyEnum`
 
-```javascript
-export class MyClass {
-    // ...
+```javascript
+export class MyClass {
+    // ...
 }
 
-export enum MyEnum {
-    // ...
-}
+export enum MyEnum {
+    // ...
+}
 ```
 
-**IMPORTANT**: If you use *ClassLoader* to dynamically load TypeScript files (.ts, .cts, .mts, etc.) at runtime using
-an ESM-only project you must use the `ts-node/esm` module loader. This can be specified by passing the `--loader` to
+**IMPORTANT**: If you use *ClassLoader* to dynamically load TypeScript files (.ts, .cts, .mts, etc.) at runtime using
+an ESM-only project you must use the `ts-node/esm` module loader. This can be specified by passing the `--loader` to
 node at runtime.
 
-```
-node --loader ts-node/esm <module>
+```
+node --loader ts-node/esm <module>
 ```
 
 ## Author
@@ -57,7 +57,7 @@ Jean-Philippe Steinmetz
 
 > **new ClassLoader**(`rootDir`, `includeJavaScript?`, `includeTypeScript?`, `ignore?`): `ClassLoader`
 
-Defined in: [src/ClassLoader.ts:67](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L67)
+Defined in: [src/ClassLoader.ts:70](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L70)
 
 Creates a new instance of `ClassLoader` with the specified defaults.
 
@@ -73,7 +73,7 @@ The root directory to load all classes from.
 
 `boolean` = `true`
 
-Set to `true` to load all TypeScript classes from the given `rootDir`, otherwise set to `false.
+Set to `true` to load all TypeScript classes from the given `rootDir`, otherwise set to `false.
 @param includeTypeScript Set to `true` to load all JavaScript classes from the given `rootDir`, otherwise set to `false.
 
 ##### includeTypeScript?
@@ -96,7 +96,7 @@ A list of regex pattern of file paths to ignore.
 
 > `protected` **classes**: `Map`\<`string`, `any`\>
 
-Defined in: [src/ClassLoader.ts:50](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L50)
+Defined in: [src/ClassLoader.ts:53](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L53)
 
 The map containnig all loaded classes.
 
@@ -106,7 +106,7 @@ The map containnig all loaded classes.
 
 > `protected` **ignore**: (`string` \| `RegExp`)[] = `[]`
 
-Defined in: [src/ClassLoader.ts:51](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L51)
+Defined in: [src/ClassLoader.ts:54](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L54)
 
 ***
 
@@ -114,7 +114,7 @@ Defined in: [src/ClassLoader.ts:51](https://github.com/rapidrest/core/blob/0eb0e
 
 > `protected` **includeJavaScript**: `boolean` = `true`
 
-Defined in: [src/ClassLoader.ts:55](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L55)
+Defined in: [src/ClassLoader.ts:58](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L58)
 
 Indicates if JavaScript classes should be loaded.
 
@@ -124,7 +124,7 @@ Indicates if JavaScript classes should be loaded.
 
 > `protected` **includeTypeScript**: `boolean` = `true`
 
-Defined in: [src/ClassLoader.ts:53](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L53)
+Defined in: [src/ClassLoader.ts:56](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L56)
 
 Indicates if TypeScript classes should be loaded.
 
@@ -134,7 +134,7 @@ Indicates if TypeScript classes should be loaded.
 
 > `protected` **rootDir**: `string` = `"."`
 
-Defined in: [src/ClassLoader.ts:57](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L57)
+Defined in: [src/ClassLoader.ts:60](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L60)
 
 The path to the root directory containing all classes on disk.
 
@@ -144,7 +144,7 @@ The path to the root directory containing all classes on disk.
 
 > **getClass**(`fqn`): `any`
 
-Defined in: [src/ClassLoader.ts:80](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L80)
+Defined in: [src/ClassLoader.ts:83](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L83)
 
 Returns the class with the specified fully qualified name.
 
@@ -168,7 +168,7 @@ The class definition for the given fully qualified name if found, otherwise `und
 
 > **getClasses**(): `Map`\<`string`, `any`\>
 
-Defined in: [src/ClassLoader.ts:87](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L87)
+Defined in: [src/ClassLoader.ts:90](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L90)
 
 Returns the map containing all classes that have been loaded.
 
@@ -182,7 +182,7 @@ Returns the map containing all classes that have been loaded.
 
 > **hasClass**(`fqn`): `any`
 
-Defined in: [src/ClassLoader.ts:97](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L97)
+Defined in: [src/ClassLoader.ts:100](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L100)
 
 Returns `true` if a class exists with the specified fully qualified name.
 
@@ -206,9 +206,9 @@ The fully qualified name of the class to search.
 
 > **load**(`dir?`): `Promise`\<`void`\>
 
-Defined in: [src/ClassLoader.ts:107](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L107)
+Defined in: [src/ClassLoader.ts:110](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L110)
 
-Loads all modules exports contained in the directory specified. The folder must be a child
+Loads all modules exports contained in the directory specified. The folder must be a child
 directory to the `rootDir` parameter passed in to the constructor.
 
 #### Parameters

package/docs/reference/classes/Event.md

@@ -6,7 +6,7 @@
 
 # Class: Event
 
-Defined in: [src/TelemetryUtils.ts:23](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L23)
+Defined in: [src/TelemetryUtils.ts:23](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L23)
 
 Describes a single telemetry event. A telemetry event is when something occurs in the system.
 
@@ -24,7 +24,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new Event**(`config`, `userId`, `data`): `Event`
 
-Defined in: [src/TelemetryUtils.ts:54](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L54)
+Defined in: [src/TelemetryUtils.ts:54](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L54)
 
 #### Parameters
 
@@ -50,7 +50,7 @@ Defined in: [src/TelemetryUtils.ts:54](https://github.com/rapidrest/core/blob/0e
 
 > `readonly` **environment**: `string`
 
-Defined in: [src/TelemetryUtils.ts:32](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L32)
+Defined in: [src/TelemetryUtils.ts:32](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L32)
 
 The name of the environment that the event originated from. This is typically `dev` or `prod`.
 
@@ -60,7 +60,7 @@ The name of the environment that the event originated from. This is typically `d
 
 > `readonly` **origin**: `string`
 
-Defined in: [src/TelemetryUtils.ts:37](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L37)
+Defined in: [src/TelemetryUtils.ts:37](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L37)
 
 The unique name of the service or client that the event originated from.
 
@@ -70,7 +70,7 @@ The unique name of the service or client that the event originated from.
 
 > `readonly` **timestamp**: `Date`
 
-Defined in: [src/TelemetryUtils.ts:42](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L42)
+Defined in: [src/TelemetryUtils.ts:42](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L42)
 
 The date and time that the event occured.
 
@@ -80,7 +80,7 @@ The date and time that the event occured.
 
 > `readonly` **type**: `string`
 
-Defined in: [src/TelemetryUtils.ts:47](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L47)
+Defined in: [src/TelemetryUtils.ts:47](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L47)
 
 The type of event being recorded.
 
@@ -94,7 +94,7 @@ The type of event being recorded.
 
 > `readonly` **uid**: `string`
 
-Defined in: [src/TelemetryUtils.ts:27](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L27)
+Defined in: [src/TelemetryUtils.ts:27](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L27)
 
 The universally unique identifier of the event.
 
@@ -104,6 +104,6 @@ The universally unique identifier of the event.
 
 > `readonly` **userId**: `string`
 
-Defined in: [src/TelemetryUtils.ts:52](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L52)
+Defined in: [src/TelemetryUtils.ts:52](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L52)
 
 The universally unique identifer of the user that sent the event.

package/docs/reference/classes/EventUtils.md

@@ -6,7 +6,7 @@
 
 # Class: EventUtils
 
-Defined in: [src/TelemetryUtils.ts:84](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L84)
+Defined in: [src/TelemetryUtils.ts:84](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L84)
 
 Provides a common set of static functions for recording and working with telemetry `Event` instances.
 
@@ -35,9 +35,9 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 ### init()
 
-> `static` **init**(`config`, `logger`, `jwtToken`): `void`
+> `static` **init**(`config`, `logger`, `jwtToken`): `Promise`\<`void`\>
 
-Defined in: [src/TelemetryUtils.ts:99](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L99)
+Defined in: [src/TelemetryUtils.ts:99](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L99)
 
 Initializes `EventUtils` with the provided defaults.
 
@@ -63,7 +63,7 @@ The user's JWT token to send telemetry events on behalf of.
 
 #### Returns
 
-`void`
+`Promise`\<`void`\>
 
 ***
 
@@ -71,7 +71,7 @@ The user's JWT token to send telemetry events on behalf of.
 
 > `static` **on**(`type`, `callback`): `void`
 
-Defined in: [src/TelemetryUtils.ts:173](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L173)
+Defined in: [src/TelemetryUtils.ts:173](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L173)
 
 Registers a `callback` function to receive notifications of recorded events of the given `type`. Note that only
 events originating from the same application or service will be notified.
@@ -100,7 +100,7 @@ The function to call when an event is recorded.
 
 > `static` **record**(`evt`, `type?`): `Promise`\<`void`\>
 
-Defined in: [src/TelemetryUtils.ts:118](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L118)
+Defined in: [src/TelemetryUtils.ts:118](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L118)
 
 Sends the given event to the telemetry service for permanent recording.
 

package/docs/reference/classes/FileUtils.md

@@ -6,7 +6,7 @@
 
 # Class: FileUtils
 
-Defined in: [src/FileUtils.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/FileUtils.ts#L17)
+Defined in: [src/FileUtils.ts:17](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/FileUtils.ts#L17)
 
 Utility functions for working with files.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz
 
 > `static` **copyBinaryFile**(`srcPath`, `outPath`, `variables?`): `Promise`\<`void`\>
 
-Defined in: [src/FileUtils.ts:159](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/FileUtils.ts#L159)
+Defined in: [src/FileUtils.ts:159](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/FileUtils.ts#L159)
 
 Generates a copy of the source file at the desired output destination using binary copy mode.
 
@@ -64,7 +64,7 @@ The map of variable names to values to swap. Applies to outPath only.
 
 > `static` **copyDirectory**(`srcPath`, `outPath`, `vars?`, `excludeFilters?`, `binaryFilters?`, `force?`): `Promise`\<`void`\>
 
-Defined in: [src/FileUtils.ts:187](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/FileUtils.ts#L187)
+Defined in: [src/FileUtils.ts:187](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/FileUtils.ts#L187)
 
 Performs a deep copy of a directory tree at the given srcPath to the specified output directory. Performs
 template replacement for all variables given and skips any files in the specified filter.
@@ -117,7 +117,7 @@ Set to `true` to force writing over any existing files.
 
 > `static` **copyFile**(`srcPath`, `outPath`, `variables?`, `overwrite?`): `Promise`\<`void`\>
 
-Defined in: [src/FileUtils.ts:123](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/FileUtils.ts#L123)
+Defined in: [src/FileUtils.ts:123](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/FileUtils.ts#L123)
 
 Generates a copy of the source file at the desired output destination and performs a swap of all values of the
 variables specified.
@@ -156,7 +156,7 @@ The map of variable names to values to swap.
 
 > `static` **writeFile**(`srcPath`, `outPath`, `contents`, `overwrite?`): `Promise`\<`void`\>
 
-Defined in: [src/FileUtils.ts:28](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/FileUtils.ts#L28)
+Defined in: [src/FileUtils.ts:28](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/FileUtils.ts#L28)
 
 Attempts to write the provided contents to the file path given. If a file already exists the user is prompted to
 allow the file to be overwritten or merged. In the case of a merge, srcPath is used as a baseline in order to

package/docs/reference/classes/JWTUtils.md

@@ -6,7 +6,7 @@
 
 # Class: JWTUtils
 
-Defined in: [src/JWTUtils.ts:145](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L145)
+Defined in: [src/JWTUtils.ts:145](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L145)
 
 Utility class for working with Json Web Token (JWT) authentication tokens.
 
@@ -28,12 +28,9 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 ### createToken()
 
-> `static` **createToken**(`config`, `user`, `data?`): `string`
+> `static` **createToken**(`config`, `user`, `data?`): `Promise`\<`string`\>
 
-Defined in: [src/JWTUtils.ts:154](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L154)
-
-Generates a new JWT token for the given config and user object. The user object must be a valid RapidREST
-user.
+Defined in: [src/JWTUtils.ts:172](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L172)
 
 #### Parameters
 
@@ -41,19 +38,39 @@ user.
 
 [`JWTUtilsConfig`](../interfaces/JWTUtilsConfig.md)
 
-The JWT configuration to use when generating the token.
-
 ##### user
 
 [`JWTUser`](../interfaces/JWTUser.md)
 
-The user to encode into the token's payload.
-
 ##### data?
 
 `any`
 
-Additional data to include the token's payload.
+#### Returns
+
+`Promise`\<`string`\>
+
+***
+
+### createTokenSync()
+
+> `static` **createTokenSync**(`config`, `user`, `data?`): `string`
+
+Defined in: [src/JWTUtils.ts:218](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L218)
+
+#### Parameters
+
+##### config
+
+[`JWTUtilsConfig`](../interfaces/JWTUtilsConfig.md)
+
+##### user
+
+[`JWTUser`](../interfaces/JWTUser.md)
+
+##### data?
+
+`any`
 
 #### Returns
 
@@ -63,9 +80,40 @@ Additional data to include the token's payload.
 
 ### decodeToken()
 
-> `static` **decodeToken**(`config`, `token`): [`JWTPayload`](../interfaces/JWTPayload.md)
+> `static` **decodeToken**(`config`, `token`): `Promise`\<[`JWTPayload`](../interfaces/JWTPayload.md)\>
+
+Defined in: [src/JWTUtils.ts:272](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L272)
+
+Decodes the given JWT authentication token using the provided configuration. If the token is not valid an
+error is thrown with the reason. Returns the encoded user object payload upon success.
+
+#### Parameters
+
+##### config
+
+[`JWTUtilsConfig`](../interfaces/JWTUtilsConfig.md)
+
+The JWT configuration to use when validating the token.
+
+##### token
+
+`string`
+
+The JWT token to validate.
+
+#### Returns
+
+`Promise`\<[`JWTPayload`](../interfaces/JWTPayload.md)\>
+
+The data encoded in the token's payload.
+
+***
+
+### decodeTokenSync()
+
+> `static` **decodeTokenSync**(`config`, `token`): [`JWTPayload`](../interfaces/JWTPayload.md)
 
-Defined in: [src/JWTUtils.ts:208](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L208)
+Defined in: [src/JWTUtils.ts:322](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L322)
 
 Decodes the given JWT authentication token using the provided configuration. If the token is not valid an
 error is thrown with the reason. Returns the encoded user object payload upon success.

package/docs/reference/classes/MessagingUtils.md

@@ -6,7 +6,7 @@
 
 # Class: MessagingUtils
 
-Defined in: [src/MessagingUtils.ts:75](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L75)
+Defined in: [src/MessagingUtils.ts:75](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L75)
 
 Simple utility class for sending templated messages via e-mail, SMS and more.
 
@@ -26,7 +26,7 @@ Simple utility class for sending templated messages via e-mail, SMS and more.
 
 > `protected` **slackApps**: `any`[] = `[]`
 
-Defined in: [src/MessagingUtils.ts:76](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L76)
+Defined in: [src/MessagingUtils.ts:76](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L76)
 
 ***
 
@@ -34,7 +34,7 @@ Defined in: [src/MessagingUtils.ts:76](https://github.com/rapidrest/core/blob/0e
 
 > `protected` **slackConfigs**: `any`[] = `[]`
 
-Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L78)
+Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L78)
 
 ## Methods
 
@@ -42,7 +42,7 @@ Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/0e
 
 > **init**(): `Promise`\<`void`\>
 
-Defined in: [src/MessagingUtils.ts:90](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L90)
+Defined in: [src/MessagingUtils.ts:96](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L96)
 
 #### Returns
 
@@ -54,7 +54,7 @@ Defined in: [src/MessagingUtils.ts:90](https://github.com/rapidrest/core/blob/0e
 
 > **loadTemplate**(`name`): [`Template`](../interfaces/Template.md)
 
-Defined in: [src/MessagingUtils.ts:152](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L152)
+Defined in: [src/MessagingUtils.ts:160](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L160)
 
 Loads the template with the given name and returns its contents as a string.
 
@@ -76,7 +76,7 @@ The name of the template to load.
 
 > **sendEmail**(`templateName`, `templateVars`, `options?`): `Promise`\<`any`\>
 
-Defined in: [src/MessagingUtils.ts:184](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L184)
+Defined in: [src/MessagingUtils.ts:199](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L199)
 
 Sends an email using the given template name and variables.
 
@@ -110,7 +110,7 @@ The map of additional options to pass into the sendMail function.
 
 > **sendSlack**(`templateName`, `templateVars`): `Promise`\<`any`[] \| `undefined`\>
 
-Defined in: [src/MessagingUtils.ts:236](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L236)
+Defined in: [src/MessagingUtils.ts:243](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L243)
 
 Sends an Slack message using the given template name and variables.
 
@@ -138,7 +138,7 @@ The map of variables to inject into the template.
 
 > **sendSMS**(`templateName`, `templateVars`, `options?`): `Promise`\<`any`\>
 
-Defined in: [src/MessagingUtils.ts:270](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L270)
+Defined in: [src/MessagingUtils.ts:276](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L276)
 
 Sends an SMS using the given template name and variables.