@rapidrest/service-core 1.0.0-beta.6 → 1.0.0-rc.2

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md

@@ -8,7 +8,7 @@
 
 > **Param**(`name?`): (`target`, `propertyKey`, `index`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:174](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L174)
+Defined in: [src/decorators/RouteDecorators.ts:174](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L174)
 
 Injects the value of the specified URI parameter with the given name as the value of the decorated argument. If no
 name is specified the entire request parameter will be injected.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md

@@ -8,7 +8,7 @@
 
 > **Patch**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:187](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L187)
+Defined in: [src/decorators/RouteDecorators.ts:187](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L187)
 
 Indicates that the decorated function handles incoming `PATCH` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md

@@ -8,7 +8,7 @@
 
 > **Post**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:196](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L196)
+Defined in: [src/decorators/RouteDecorators.ts:196](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L196)
 
 Indicates that the decorated function handles incoming `POST` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md

@@ -8,7 +8,7 @@
 
 > **Protect**(`acl?`): (`target`, `propertyKey?`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:222](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L222)
+Defined in: [src/decorators/RouteDecorators.ts:222](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L222)
 
 Apply this to any route handler class or an individual route handler function to indicate that it should be
 protected by the AccessControlList security system. The `acl` parameter specifies the ACL governing access

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md

@@ -8,7 +8,7 @@
 
 > **Put**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:205](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L205)
+Defined in: [src/decorators/RouteDecorators.ts:205](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L205)
 
 Indicates that the decorated function handles incoming `PUT` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md

@@ -8,7 +8,7 @@
 
 > **Query**(`name?`): (`target`, `propertyKey`, `index`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:265](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L265)
+Defined in: [src/decorators/RouteDecorators.ts:265](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L265)
 
 Injects the value of the specified query parameter with the given name as the value of the decorated argument. If
 no name is specified the entire request query will be injected.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md

@@ -8,7 +8,7 @@
 
 > **Request**(`target`, `propertyKey`, `index`): `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:276](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L276)
+Defined in: [src/decorators/RouteDecorators.ts:276](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L276)
 
 Injects the Express request object as the value of the decorated argument.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md

@@ -8,7 +8,7 @@
 
 > **RequiresRole**(`roles`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:297](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L297)
+Defined in: [src/decorators/RouteDecorators.ts:297](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L297)
 
 Indicates that the client must be an authenticated user with at least one of the specified role(s) to process the
 request.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md

@@ -8,7 +8,7 @@
 
 > **Response**(`target`, `propertyKey`, `index`): `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:285](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L285)
+Defined in: [src/decorators/RouteDecorators.ts:285](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L285)
 
 Injects the Express response object as the value of the decorated argument.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md

@@ -8,7 +8,7 @@
 
 > **Route**(`paths`): (`target`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:310](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L310)
+Defined in: [src/decorators/RouteDecorators.ts:310](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L310)
 
 Indicates that the decorated class contains Express route definitions.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md

@@ -8,7 +8,7 @@
 
 > **Socket**(`target`, `propertyKey`, `index`): `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:323](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L323)
+Defined in: [src/decorators/RouteDecorators.ts:323](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L323)
 
 Injects the underlying Socket object associated with the request as the value of the decorated argument.
 When the handler function is for a WebSocket request, the returned socket will be the newly established

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md

@@ -8,7 +8,7 @@
 
 > **User**(`target`, `propertyKey`, `index`): `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:332](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L332)
+Defined in: [src/decorators/RouteDecorators.ts:332](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L332)
 
 Injects the authenticated user object as the value of the decorated argument.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md

@@ -8,7 +8,7 @@
 
 > **Validate**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:343](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L343)
+Defined in: [src/decorators/RouteDecorators.ts:343](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L343)
 
 Indicates a validation function to execute in order to verify an incoming requests payload.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md

@@ -8,7 +8,7 @@
 
 > **WebSocket**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:356](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L356)
+Defined in: [src/decorators/RouteDecorators.ts:356](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L356)
 
 Indicates that the decorated function handles incoming `WebSocket` upgrade requests at the given sub-path.
 

package/docs/reference/classes/ACLUtils.md

@@ -6,7 +6,7 @@
 
 # Class: ACLUtils
 
-Defined in: [src/security/ACLUtils.ts:22](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/ACLUtils.ts#L22)
+Defined in: [src/security/ACLUtils.ts:22](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/ACLUtils.ts#L22)
 
 Common utility functions for working with `AccessControlList` objects and validating user permissions.
 
@@ -26,7 +26,7 @@ Common utility functions for working with `AccessControlList` objects and valida
 
 > **enabled**: `boolean` = `true`
 
-Defined in: [src/security/ACLUtils.ts:24](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/ACLUtils.ts#L24)
+Defined in: [src/security/ACLUtils.ts:24](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/ACLUtils.ts#L24)
 
 ## Methods
 
@@ -34,7 +34,7 @@ Defined in: [src/security/ACLUtils.ts:24](https://github.com/rapidrest/service-c
 
 > **checkRequestPerms**(`uid`, `user`, `req`): `Promise`\<`boolean`\>
 
-Defined in: [src/security/ACLUtils.ts:90](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/ACLUtils.ts#L90)
+Defined in: [src/security/ACLUtils.ts:90](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/ACLUtils.ts#L90)
 
 Validates that the user has permission to perform the request operation against the URL path for the
 provided request. If ACLUtils has not been initialized or the `acl` datastore has not been configured
@@ -70,7 +70,7 @@ The request whose URL path and method will be verified.
 
 > **findACL**(`entityId`, `parentUids?`, `reqCache?`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
 
-Defined in: [src/security/ACLUtils.ts:219](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/ACLUtils.ts#L219)
+Defined in: [src/security/ACLUtils.ts:219](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/ACLUtils.ts#L219)
 
 Retrieves the access control list with the associated identifier and populates the parent(s).
 
@@ -102,7 +102,7 @@ The list of already found parent UIDs. This is used to break circular dependenci
 
 > **getRecord**(`acl`, `user`): [`ACLRecord`](../interfaces/ACLRecord.md) \| `null`
 
-Defined in: [src/security/ACLUtils.ts:501](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/ACLUtils.ts#L501)
+Defined in: [src/security/ACLUtils.ts:501](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/ACLUtils.ts#L501)
 
 Retrieves the first available record in the provided ACL associated with the provided user.
 
@@ -132,7 +132,7 @@ The ACL record associated with the given user if found, otherwise `undefined`.
 
 > **hasPermission**(`user`, `acl`, `action`): `Promise`\<`boolean`\>
 
-Defined in: [src/security/ACLUtils.ts:151](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/ACLUtils.ts#L151)
+Defined in: [src/security/ACLUtils.ts:151](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/ACLUtils.ts#L151)
 
 Validates that the user has permission to perform the provided action using the given access control list.
 
@@ -168,7 +168,7 @@ The action that the user desires permission for.
 
 > **populateParent**(`acl`, `parentUids?`): `Promise`\<`void`\>
 
-Defined in: [src/security/ACLUtils.ts:521](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/ACLUtils.ts#L521)
+Defined in: [src/security/ACLUtils.ts:521](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/ACLUtils.ts#L521)
 
 Attempts to retrieve the parent access control list for the given ACL object.
 
@@ -196,7 +196,7 @@ The list of already found parent UIDs. This is used to break circular dependenci
 
 > **removeACL**(`uid`): `Promise`\<`void`\>
 
-Defined in: [src/security/ACLUtils.ts:287](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/ACLUtils.ts#L287)
+Defined in: [src/security/ACLUtils.ts:287](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/ACLUtils.ts#L287)
 
 Deletes the ACL with the given identifier from the database.
 
@@ -218,7 +218,7 @@ The unique identifier of the ACL to remove.
 
 > **saveACL**(`acl`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
 
-Defined in: [src/security/ACLUtils.ts:375](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/ACLUtils.ts#L375)
+Defined in: [src/security/ACLUtils.ts:375](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/ACLUtils.ts#L375)
 
 Stores the given access control list into the ACL database.
 
@@ -242,7 +242,7 @@ Returns the ACL that was stored in the database.
 
 > **saveDefaultACL**(`acl`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
 
-Defined in: [src/security/ACLUtils.ts:441](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/ACLUtils.ts#L441)
+Defined in: [src/security/ACLUtils.ts:441](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/ACLUtils.ts#L441)
 
 Stores the given default access control list into the ACL database. A default ACL is a special type of ACL
 that is primarily defined and maintained within the code but allows for user-specific overrides. To accomplish

package/docs/reference/classes/AdminRoute.md

@@ -6,7 +6,7 @@
 
 # Class: AdminRoute
 
-Defined in: [src/routes/AdminRoute.ts:50](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/routes/AdminRoute.ts#L50)
+Defined in: [src/routes/AdminRoute.ts:50](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/AdminRoute.ts#L50)
 
 The `AdminRoute` provides a default `/admin` endpoint that gives trusted users the following abilities:
 
@@ -26,7 +26,7 @@ Jean-Philippe Steinmetz
 
 > **new AdminRoute**(`releaseNotes`): `AdminRoute`
 
-Defined in: [src/routes/AdminRoute.ts:82](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/routes/AdminRoute.ts#L82)
+Defined in: [src/routes/AdminRoute.ts:82](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/AdminRoute.ts#L82)
 
 Constructs a new `ReleaseNotesRoute` object with the specified defaults.
 
@@ -48,4 +48,4 @@ The ReleaseNotes specification object to serve.
 
 > `protected` `optional` **cacheClient?**: `Redis`
 
-Defined in: [src/routes/AdminRoute.ts:55](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/routes/AdminRoute.ts#L55)
+Defined in: [src/routes/AdminRoute.ts:55](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/AdminRoute.ts#L55)

package/docs/reference/classes/AuthMiddleware.md

@@ -6,7 +6,7 @@
 
 # Class: AuthMiddleware
 
-Defined in: [src/auth/AuthMiddleware.ts:19](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/AuthMiddleware.ts#L19)
+Defined in: [src/auth/AuthMiddleware.ts:19](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthMiddleware.ts#L19)
 
 A set of common utilities for performing authentication using one or more strategies.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `readonly` **strategies**: `Map`\<`string`, [`AuthStrategy`](../interfaces/AuthStrategy.md)\>
 
-Defined in: [src/auth/AuthMiddleware.ts:30](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/AuthMiddleware.ts#L30)
+Defined in: [src/auth/AuthMiddleware.ts:30](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthMiddleware.ts#L30)
 
 The authentication strategies that have been registered.
 
@@ -40,7 +40,7 @@ The authentication strategies that have been registered.
 
 > **authenticate**(`strategies`, `req`, `res?`, `required?`): `Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
 
-Defined in: [src/auth/AuthMiddleware.ts:54](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/AuthMiddleware.ts#L54)
+Defined in: [src/auth/AuthMiddleware.ts:54](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthMiddleware.ts#L54)
 
 Performs authentication of the given request using one of the provided strategies.
 
@@ -80,7 +80,7 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
 
 > **authenticateSync**(`strategies`, `req`, `res?`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
 
-Defined in: [src/auth/AuthMiddleware.ts:92](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/AuthMiddleware.ts#L92)
+Defined in: [src/auth/AuthMiddleware.ts:92](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthMiddleware.ts#L92)
 
 Performs authentication of the given request using one of the provided strategies.
 
@@ -122,7 +122,7 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
 
 > **authWebSocket**(`required`): [`RequestHandler`](../type-aliases/RequestHandler.md)
 
-Defined in: [src/auth/AuthMiddleware.ts:133](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/AuthMiddleware.ts#L133)
+Defined in: [src/auth/AuthMiddleware.ts:133](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthMiddleware.ts#L133)
 
 Returns a request handler function that will perform authentication of a websocket connection. Authentication
 can be handled in two ways:
@@ -150,7 +150,7 @@ Set to `true` to indicate that auth is required, otherwise `false`.
 
 > **register**(`name`, `strategy`): `void`
 
-Defined in: [src/auth/AuthMiddleware.ts:277](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/AuthMiddleware.ts#L277)
+Defined in: [src/auth/AuthMiddleware.ts:277](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthMiddleware.ts#L277)
 
 Registers the provided authentication strategy to be used
 

package/docs/reference/classes/BackgroundService.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: BackgroundService
 
-Defined in: [src/BackgroundService.ts:10](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundService.ts#L10)
+Defined in: [src/BackgroundService.ts:10](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundService.ts#L10)
 
 The `BackgroundService` is an abstract base class for defining scheduled background services. A background service
 executes in the background once on startup or on a set schedule (like a cron job) and performs additional processing.
@@ -21,7 +21,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new BackgroundService**(`config`, `logger`): `BackgroundService`
 
-Defined in: [src/BackgroundService.ts:16](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundService.ts#L16)
+Defined in: [src/BackgroundService.ts:16](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundService.ts#L16)
 
 #### Parameters
 
@@ -43,7 +43,7 @@ Defined in: [src/BackgroundService.ts:16](https://github.com/rapidrest/service-c
 
 > `protected` **config**: `any`
 
-Defined in: [src/BackgroundService.ts:12](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundService.ts#L12)
+Defined in: [src/BackgroundService.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundService.ts#L12)
 
 The global application configuration that the service can reference.
 
@@ -53,7 +53,7 @@ The global application configuration that the service can reference.
 
 > `protected` **logger**: `any`
 
-Defined in: [src/BackgroundService.ts:14](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundService.ts#L14)
+Defined in: [src/BackgroundService.ts:14](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundService.ts#L14)
 
 The logging utility to use.
 
@@ -65,7 +65,7 @@ The logging utility to use.
 
 > **get** `abstract` **schedule**(): `string` \| `undefined`
 
-Defined in: [src/BackgroundService.ts:25](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundService.ts#L25)
+Defined in: [src/BackgroundService.ts:25](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundService.ts#L25)
 
 Returns the desired execution interval that this service should be scheduled with. If `undefined` is returned
 the service is executed only once.
@@ -80,7 +80,7 @@ the service is executed only once.
 
 > `abstract` **run**(): `void` \| `Promise`\<`void`\>
 
-Defined in: [src/BackgroundService.ts:30](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundService.ts#L30)
+Defined in: [src/BackgroundService.ts:30](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundService.ts#L30)
 
 The processing function to execute at each scheduled interval.
 
@@ -94,7 +94,7 @@ The processing function to execute at each scheduled interval.
 
 > `abstract` **start**(): `void` \| `Promise`\<`void`\>
 
-Defined in: [src/BackgroundService.ts:35](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundService.ts#L35)
+Defined in: [src/BackgroundService.ts:35](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundService.ts#L35)
 
 Initializes the background service with any defaults.
 
@@ -108,7 +108,7 @@ Initializes the background service with any defaults.
 
 > `abstract` **stop**(): `void` \| `Promise`\<`void`\>
 
-Defined in: [src/BackgroundService.ts:40](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundService.ts#L40)
+Defined in: [src/BackgroundService.ts:40](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundService.ts#L40)
 
 Shuts down the background allowing the service to complete any outstanding tasks.
 

package/docs/reference/classes/BackgroundServiceManager.md

@@ -6,7 +6,7 @@
 
 # Class: BackgroundServiceManager
 
-Defined in: [src/BackgroundServiceManager.ts:35](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L35)
+Defined in: [src/BackgroundServiceManager.ts:35](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundServiceManager.ts#L35)
 
 The `BackgroundServiceManager` manages all configured background services in the application. It is responsible for
 initializing the jobs, scheduling them and performing any related shutdown tasks. See the `BackgroundService`
@@ -43,7 +43,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new BackgroundServiceManager**(`objectFactory`, `classes`, `config`, `logger`): `BackgroundServiceManager`
 
-Defined in: [src/BackgroundServiceManager.ts:43](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L43)
+Defined in: [src/BackgroundServiceManager.ts:43](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundServiceManager.ts#L43)
 
 #### Parameters
 
@@ -71,7 +71,7 @@ Defined in: [src/BackgroundServiceManager.ts:43](https://github.com/rapidrest/se
 
 > **getService**(`name`): [`BackgroundService`](BackgroundService.md) \| `undefined`
 
-Defined in: [src/BackgroundServiceManager.ts:55](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L55)
+Defined in: [src/BackgroundServiceManager.ts:55](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundServiceManager.ts#L55)
 
 Returns the service instance with the given name.
 
@@ -93,7 +93,7 @@ The name of the background service to retrieve.
 
 > **start**(`serviceName`, `clazz?`, ...`args`): `Promise`\<`void`\>
 
-Defined in: [src/BackgroundServiceManager.ts:81](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L81)
+Defined in: [src/BackgroundServiceManager.ts:81](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundServiceManager.ts#L81)
 
 Starts the background service with the given name.
 
@@ -127,7 +127,7 @@ The list of arguments to pass into the service constructor
 
 > **startAll**(): `Promise`\<`void`\>
 
-Defined in: [src/BackgroundServiceManager.ts:62](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L62)
+Defined in: [src/BackgroundServiceManager.ts:62](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundServiceManager.ts#L62)
 
 Starts all configured background services.
 
@@ -141,7 +141,7 @@ Starts all configured background services.
 
 > **stop**(`serviceName`): `Promise`\<`void`\>
 
-Defined in: [src/BackgroundServiceManager.ts:139](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L139)
+Defined in: [src/BackgroundServiceManager.ts:139](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundServiceManager.ts#L139)
 
 Stops the background service with the given name.
 
@@ -163,7 +163,7 @@ The name of the background service to stop.
 
 > **stopAll**(): `Promise`\<`void`\>
 
-Defined in: [src/BackgroundServiceManager.ts:124](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L124)
+Defined in: [src/BackgroundServiceManager.ts:124](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BackgroundServiceManager.ts#L124)
 
 Stops all currently active background services that are owned by the manager.
 

package/docs/reference/classes/BaseEntity.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: BaseEntity
 
-Defined in: [src/models/BaseEntity.ts:18](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L18)
+Defined in: [src/models/BaseEntity.ts:18](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L18)
 
 Provides a common base class for all entity's that will be persisted to a datastore.
 
@@ -29,7 +29,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new BaseEntity**(`other?`): `BaseEntity`
 
-Defined in: [src/models/BaseEntity.ts:52](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L52)
+Defined in: [src/models/BaseEntity.ts:52](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L52)
 
 #### Parameters
 
@@ -47,7 +47,7 @@ Defined in: [src/models/BaseEntity.ts:52](https://github.com/rapidrest/service-c
 
 > **dateCreated**: `Date`
 
-Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L35)
+Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L35)
 
 The date and time that the entity was created.
 
@@ -57,7 +57,7 @@ The date and time that the entity was created.
 
 > **dateModified**: `Date`
 
-Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L43)
+Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L43)
 
 The date and time that the entity was last modified.
 
@@ -67,7 +67,7 @@ The date and time that the entity was last modified.
 
 > **uid**: `string`
 
-Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L27)
+Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L27)
 
 The universally unique identifier of the entity.
 
@@ -77,6 +77,6 @@ The universally unique identifier of the entity.
 
 > **version**: `number` = `0`
 
-Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L50)
+Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L50)
 
 The optimistic lock version.

package/docs/reference/classes/BaseMongoEntity.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: BaseMongoEntity
 
-Defined in: [src/models/BaseMongoEntity.ts:15](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseMongoEntity.ts#L15)
+Defined in: [src/models/BaseMongoEntity.ts:18](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseMongoEntity.ts#L18)
 
 Provides a common base class for all entity's that will be persisted in a MongoDB database.
 
@@ -24,7 +24,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new BaseMongoEntity**(`other?`): `BaseMongoEntity`
 
-Defined in: [src/models/BaseMongoEntity.ts:23](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseMongoEntity.ts#L23)
+Defined in: [src/models/BaseMongoEntity.ts:26](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseMongoEntity.ts#L26)
 
 #### Parameters
 
@@ -46,7 +46,7 @@ Defined in: [src/models/BaseMongoEntity.ts:23](https://github.com/rapidrest/serv
 
 > `optional` **\_id?**: `any`
 
-Defined in: [src/models/BaseMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseMongoEntity.ts#L21)
+Defined in: [src/models/BaseMongoEntity.ts:24](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseMongoEntity.ts#L24)
 
 The internal unique identifier used by MongoDB.
 
@@ -56,7 +56,7 @@ The internal unique identifier used by MongoDB.
 
 > **dateCreated**: `Date`
 
-Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L35)
+Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L35)
 
 The date and time that the entity was created.
 
@@ -70,7 +70,7 @@ The date and time that the entity was created.
 
 > **dateModified**: `Date`
 
-Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L43)
+Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L43)
 
 The date and time that the entity was last modified.
 
@@ -84,7 +84,7 @@ The date and time that the entity was last modified.
 
 > **uid**: `string`
 
-Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L27)
+Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L27)
 
 The universally unique identifier of the entity.
 
@@ -98,7 +98,7 @@ The universally unique identifier of the entity.
 
 > **version**: `number` = `0`
 
-Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L50)
+Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L50)
 
 The optimistic lock version.
 

package/docs/reference/classes/BasicStrategy.md

@@ -6,7 +6,7 @@
 
 # Class: BasicStrategy
 
-Defined in: [src/auth/BasicStrategy.ts:39](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L39)
+Defined in: [src/auth/BasicStrategy.ts:39](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/BasicStrategy.ts#L39)
 
 ## Author
 
@@ -22,7 +22,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new BasicStrategy**(`options?`): `BasicStrategy`
 
-Defined in: [src/auth/BasicStrategy.ts:43](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L43)
+Defined in: [src/auth/BasicStrategy.ts:43](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/BasicStrategy.ts#L43)
 
 #### Parameters
 
@@ -40,7 +40,7 @@ Defined in: [src/auth/BasicStrategy.ts:43](https://github.com/rapidrest/service-
 
 > `readonly` **name**: `string` = `"basic"`
 
-Defined in: [src/auth/BasicStrategy.ts:40](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L40)
+Defined in: [src/auth/BasicStrategy.ts:40](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/BasicStrategy.ts#L40)
 
 The unique name of the strategy used to register with the `AuthMiddleware`.
 
@@ -54,7 +54,7 @@ The unique name of the strategy used to register with the `AuthMiddleware`.
 
 > **authenticate**(`req`, `res`, `required?`): `Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
 
-Defined in: [src/auth/BasicStrategy.ts:80](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L80)
+Defined in: [src/auth/BasicStrategy.ts:80](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/BasicStrategy.ts#L80)
 
 Attempts to perform authentication with the given request data. If authentication was successful, returns an
 `AuthResult` containing the authentication details. If authentication fails and `required` is set to `true`
@@ -94,7 +94,7 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
 
 > **authenticateSync**(`req`, `res`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
 
-Defined in: [src/auth/BasicStrategy.ts:112](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L112)
+Defined in: [src/auth/BasicStrategy.ts:112](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/BasicStrategy.ts#L112)
 
 Attempts to perform authentication with the given request data. If authentication was successful, returns an
 `AuthResult` containing the authentication details. If authentication fails and `required` is set to `true`