@rapidrest/service-core 1.0.0-beta.1 → 1.0.0-beta.3

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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L22)
+Defined in: [src/security/ACLUtils.ts:22](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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
 
 > **checkRequestPerms**(`uid`, `user`, `req`): `Promise`\<`boolean`\>
 
-Defined in: [src/security/ACLUtils.ts:73](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L73)
+Defined in: [src/security/ACLUtils.ts:73](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L73)
 
 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
@@ -48,7 +48,7 @@ The user to validate.
 
 ##### req
 
-`HttpRequest`
+[`HttpRequest`](../interfaces/HttpRequest.md)
 
 The request whose URL path and method will be verified.
 
@@ -62,7 +62,7 @@ The request whose URL path and method will be verified.
 
 > **findACL**(`entityId`, `parentUids?`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
 
-Defined in: [src/security/ACLUtils.ts:195](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L195)
+Defined in: [src/security/ACLUtils.ts:195](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L195)
 
 Retrieves the access control list with the associated identifier and populates the parent(s).
 
@@ -90,7 +90,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:459](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L459)
+Defined in: [src/security/ACLUtils.ts:459](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L459)
 
 Retrieves the first available record in the provided ACL associated with the provided user.
 
@@ -120,7 +120,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:127](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L127)
+Defined in: [src/security/ACLUtils.ts:127](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L127)
 
 Validates that the user has permission to perform the provided action using the given access control list.
 
@@ -156,7 +156,7 @@ The action that the user desires permission for.
 
 > **populateParent**(`acl`, `parentUids?`): `Promise`\<`void`\>
 
-Defined in: [src/security/ACLUtils.ts:479](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L479)
+Defined in: [src/security/ACLUtils.ts:479](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L479)
 
 Attempts to retrieve the parent access control list for the given ACL object.
 
@@ -184,7 +184,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:247](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L247)
+Defined in: [src/security/ACLUtils.ts:247](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L247)
 
 Deletes the ACL with the given identifier from the database.
 
@@ -206,7 +206,7 @@ The unique identifier of the ACL to remove.
 
 > **saveACL**(`acl`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
 
-Defined in: [src/security/ACLUtils.ts:333](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L333)
+Defined in: [src/security/ACLUtils.ts:333](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L333)
 
 Stores the given access control list into the ACL database.
 
@@ -230,7 +230,7 @@ Returns the ACL that was stored in the database.
 
 > **saveDefaultACL**(`acl`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
 
-Defined in: [src/security/ACLUtils.ts:399](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L399)
+Defined in: [src/security/ACLUtils.ts:399](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L399)
 
 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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/AdminRoute.ts#L50)
+Defined in: [src/routes/AdminRoute.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/AdminRoute.ts#L82)
+Defined in: [src/routes/AdminRoute.ts:82](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/AdminRoute.ts#L55)
+Defined in: [src/routes/AdminRoute.ts:55](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L19)
+Defined in: [src/auth/AuthMiddleware.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L30)
+Defined in: [src/auth/AuthMiddleware.ts:30](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthMiddleware.ts#L30)
 
 The authentication strategies that have been registered.
 
@@ -38,9 +38,9 @@ The authentication strategies that have been registered.
 
 ### authenticate()
 
-> **authenticate**(`strategies`, `req`, `res?`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `Promise`\<[`AuthResult`](../interfaces/AuthResult.md)\> \| `undefined`
+> **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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L54)
+Defined in: [src/auth/AuthMiddleware.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthMiddleware.ts#L54)
 
 Performs authentication of the given request using one of the provided strategies.
 
@@ -54,13 +54,13 @@ The list of strategy names to attempt authentication with.
 
 ##### req
 
-`HttpRequest`
+[`HttpRequest`](../interfaces/HttpRequest.md)
 
 The request containing data to perform authenticate with.
 
 ##### res?
 
-`HttpResponse`
+[`HttpResponse`](../interfaces/HttpResponse.md)
 
 The response to use when writing back directly to the client.
 
@@ -72,20 +72,62 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
 
 #### Returns
 
-[`AuthResult`](../interfaces/AuthResult.md) \| `Promise`\<[`AuthResult`](../interfaces/AuthResult.md)\> \| `undefined`
+`Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
+
+***
+
+### authenticateSync()
+
+> **authenticateSync**(`strategies`, `req`, `res?`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
+
+Defined in: [src/auth/AuthMiddleware.ts:92](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthMiddleware.ts#L92)
+
+Performs authentication of the given request using one of the provided strategies.
+
+This is the synchronous version of `authenticate` that performs blocking based authentication.
+
+#### Parameters
+
+##### strategies
+
+`string`[]
+
+The list of strategy names to attempt authentication with.
+
+##### req
+
+[`HttpRequest`](../interfaces/HttpRequest.md)
+
+The request containing data to perform authenticate with.
+
+##### res?
+
+[`HttpResponse`](../interfaces/HttpResponse.md)
+
+The response to use when writing back directly to the client.
+
+##### required?
+
+`boolean`
+
+Set to `true` to if authentication is required to pass, otherwise set to `false`.
+
+#### Returns
+
+[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
 
 ***
 
 ### authWebSocket()
 
-> **authWebSocket**(`required`): `RequestHandler`
+> **authWebSocket**(`required`): [`RequestHandler`](../type-aliases/RequestHandler.md)
 
-Defined in: [src/auth/AuthMiddleware.ts:95](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L95)
+Defined in: [src/auth/AuthMiddleware.ts:133](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthMiddleware.ts#L133)
 
-Returns a request handler function that will perform authentication of a websocket connection. Authentication
+Returns a request handler function that will perform authentication of a websocket connection. Authentication
 can be handled in two ways:
 
-1. Authorization header
+1. Authorization header
 2. Negotiation via handshake
 
 This middleware function primarily provides the implementation for item 2 above.
@@ -100,7 +142,7 @@ Set to `true` to indicate that auth is required, otherwise `false`.
 
 #### Returns
 
-`RequestHandler`
+[`RequestHandler`](../type-aliases/RequestHandler.md)
 
 ***
 
@@ -108,7 +150,7 @@ Set to `true` to indicate that auth is required, otherwise `false`.
 
 > **register**(`name`, `strategy`): `void`
 
-Defined in: [src/auth/AuthMiddleware.ts:239](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L239)
+Defined in: [src/auth/AuthMiddleware.ts:277](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L10)
+Defined in: [src/BackgroundService.ts:10](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L16)
+Defined in: [src/BackgroundService.ts:16](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L12)
+Defined in: [src/BackgroundService.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L14)
+Defined in: [src/BackgroundService.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L25)
+Defined in: [src/BackgroundService.ts:25](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L30)
+Defined in: [src/BackgroundService.ts:30](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L35)
+Defined in: [src/BackgroundService.ts:35](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L40)
+Defined in: [src/BackgroundService.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L35)
+Defined in: [src/BackgroundServiceManager.ts:35](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L43)
+Defined in: [src/BackgroundServiceManager.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L55)
+Defined in: [src/BackgroundServiceManager.ts:55](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L81)
+Defined in: [src/BackgroundServiceManager.ts:81](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L62)
+Defined in: [src/BackgroundServiceManager.ts:62](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L139)
+Defined in: [src/BackgroundServiceManager.ts:139](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L124)
+Defined in: [src/BackgroundServiceManager.ts:124](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L18)
+Defined in: [src/models/BaseEntity.ts:18](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L52)
+Defined in: [src/models/BaseEntity.ts:52](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L35)
+Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L43)
+Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L27)
+Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L50)
+Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseMongoEntity.ts#L15)
+Defined in: [src/models/BaseMongoEntity.ts:15](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseMongoEntity.ts#L15)
 
 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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseMongoEntity.ts#L23)
+Defined in: [src/models/BaseMongoEntity.ts:23](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseMongoEntity.ts#L23)
 
 #### 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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseMongoEntity.ts#L21)
+Defined in: [src/models/BaseMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseMongoEntity.ts#L21)
 
 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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L35)
+Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L43)
+Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L27)
+Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L50)
+Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L36)
+Defined in: [src/auth/BasicStrategy.ts:39](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L40)
+Defined in: [src/auth/BasicStrategy.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/BasicStrategy.ts#L43)
 
 #### Parameters
 
@@ -40,7 +40,7 @@ Defined in: [src/auth/BasicStrategy.ts:40](https://github.com/rapidrest/service-
 
 > `readonly` **name**: `string` = `"basic"`
 
-Defined in: [src/auth/BasicStrategy.ts:37](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L37)
+Defined in: [src/auth/BasicStrategy.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/BasicStrategy.ts#L40)
 
 The unique name of the strategy used to register with the `AuthMiddleware`.
 
@@ -52,25 +52,25 @@ The unique name of the strategy used to register with the `AuthMiddleware`.
 
 ### authenticate()
 
-> **authenticate**(`req`, `res`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `Promise`\<[`AuthResult`](../interfaces/AuthResult.md)\> \| `undefined`
+> **authenticate**(`req`, `res`, `required?`): `Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
 
-Defined in: [src/auth/BasicStrategy.ts:44](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L44)
+Defined in: [src/auth/BasicStrategy.ts:80](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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`
+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`
 throws an error, otherwise returns `undefined`.
 
 #### Parameters
 
 ##### req
 
-`HttpRequest`
+[`HttpRequest`](../interfaces/HttpRequest.md)
 
 The request containing data to attempt authentication with.
 
 ##### res
 
-`HttpResponse`
+[`HttpResponse`](../interfaces/HttpResponse.md)
 
 The response to use when writing back directly to the client.
 
@@ -82,8 +82,50 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
 
 #### Returns
 
-[`AuthResult`](../interfaces/AuthResult.md) \| `Promise`\<[`AuthResult`](../interfaces/AuthResult.md)\> \| `undefined`
+`Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
 
 #### Implementation of
 
 [`AuthStrategy`](../interfaces/AuthStrategy.md).[`authenticate`](../interfaces/AuthStrategy.md#authenticate)
+
+***
+
+### authenticateSync()
+
+> **authenticateSync**(`req`, `res`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
+
+Defined in: [src/auth/BasicStrategy.ts:112](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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`
+throws an error, otherwise returns `undefined`.
+
+This is the synchronous version of `authenticate` that performs blocking based authentication.
+
+#### Parameters
+
+##### req
+
+[`HttpRequest`](../interfaces/HttpRequest.md)
+
+The request containing data to attempt authentication with.
+
+##### res
+
+[`HttpResponse`](../interfaces/HttpResponse.md)
+
+The response to use when writing back directly to the client.
+
+##### required?
+
+`boolean`
+
+Set to `true` to if authentication is required to pass, otherwise set to `false`.
+
+#### Returns
+
+[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
+
+#### Implementation of
+
+[`AuthStrategy`](../interfaces/AuthStrategy.md).[`authenticateSync`](../interfaces/AuthStrategy.md#authenticatesync)