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

package/docs/reference/classes/JWTStrategy.md

@@ -6,15 +6,15 @@
 
 # Class: JWTStrategy
 
-Defined in: [src/auth/JWTStrategy.ts:63](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L63)
+Defined in: [src/auth/JWTStrategy.ts:63](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L63)
 
-JWT authentication strategy. Performs JWT verification and searches for a token by one of the
-following methods (in order of precedence):
-* Query Parameter
-* Authorization Header
+JWT authentication strategy. Performs JWT verification and searches for a token by one of the
+following methods (in order of precedence):
+* Query Parameter
+* Authorization Header
 * Cookie
 
-This class no longer extends `passport-strategy`; it is used directly by route middleware
+This class no longer extends `passport-strategy`; it is used directly by route middleware
 and returns a plain result object instead of calling Passport callbacks.
 
 ## Author
@@ -27,7 +27,7 @@ Jean-Philippe Steinmetz
 
 > **new JWTStrategy**(`options?`): `JWTStrategy`
 
-Defined in: [src/auth/JWTStrategy.ts:71](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L71)
+Defined in: [src/auth/JWTStrategy.ts:72](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L72)
 
 #### Parameters
 
@@ -45,7 +45,7 @@ Defined in: [src/auth/JWTStrategy.ts:71](https://github.com/rapidrest/service-co
 
 > `readonly` **name**: `string` = `"jwt"`
 
-Defined in: [src/auth/JWTStrategy.ts:67](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L67)
+Defined in: [src/auth/JWTStrategy.ts:67](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L67)
 
 ## Methods
 
@@ -53,7 +53,7 @@ Defined in: [src/auth/JWTStrategy.ts:67](https://github.com/rapidrest/service-co
 
 > **authenticate**(`req`, `res`, `required?`): `Promise`\<[`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`\>
 
-Defined in: [src/auth/JWTStrategy.ts:134](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L134)
+Defined in: [src/auth/JWTStrategy.ts:136](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L136)
 
 #### Parameters
 
@@ -79,7 +79,7 @@ Defined in: [src/auth/JWTStrategy.ts:134](https://github.com/rapidrest/service-c
 
 > **authenticateSync**(`req`, `res`, `required?`): [`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`
 
-Defined in: [src/auth/JWTStrategy.ts:169](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L169)
+Defined in: [src/auth/JWTStrategy.ts:171](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L171)
 
 #### Parameters
 

package/docs/reference/classes/JWTStrategyOptions.md

@@ -6,7 +6,7 @@
 
 # Class: JWTStrategyOptions
 
-Defined in: [src/auth/JWTStrategy.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L19)
+Defined in: [src/auth/JWTStrategy.ts:19](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L19)
 
 Describes the configuration options that can be used to initialize JWTStrategy.
 
@@ -30,10 +30,10 @@ Jean-Philippe Steinmetz
 
 > **allowQueryParam**: `boolean` = `false`
 
-Defined in: [src/auth/JWTStrategy.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L37)
+Defined in: [src/auth/JWTStrategy.ts:37](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L37)
 
-Set to `true` to allow tokens to be supplied via the `queryKey` URL parameter.
-Disabled by default — query parameters appear in server logs, browser history, and
+Set to `true` to allow tokens to be supplied via the `queryKey` URL parameter.
+Disabled by default — query parameters appear in server logs, browser history, and
 Referer headers, which permanently exposes tokens outside the application.
 
 ***
@@ -42,7 +42,7 @@ Referer headers, which permanently exposes tokens outside the application.
 
 > `optional` **config?**: `JWTUtilsConfig`
 
-Defined in: [src/auth/JWTStrategy.ts:21](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L21)
+Defined in: [src/auth/JWTStrategy.ts:21](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L21)
 
 The configuration options to pass to the JWTUtils library during token verification.
 
@@ -52,7 +52,7 @@ The configuration options to pass to the JWTUtils library during token verificat
 
 > **cookieName**: `string` = `"jwt"`
 
-Defined in: [src/auth/JWTStrategy.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L27)
+Defined in: [src/auth/JWTStrategy.ts:27](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L27)
 
 The name of the cookie to retrieve the token from when using cookie based authentication. Default value is `jwt`.
 
@@ -62,7 +62,7 @@ The name of the cookie to retrieve the token from when using cookie based authen
 
 > **cookieSecure**: `boolean` = `false`
 
-Defined in: [src/auth/JWTStrategy.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L29)
+Defined in: [src/auth/JWTStrategy.ts:29](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L29)
 
 The name of the secured cookie to retreive the token from when using cookie based authentication.
 
@@ -72,7 +72,7 @@ The name of the secured cookie to retreive the token from when using cookie base
 
 > **headerKey**: `string` = `"authorization"`
 
-Defined in: [src/auth/JWTStrategy.ts:23](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L23)
+Defined in: [src/auth/JWTStrategy.ts:23](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L23)
 
 The name of the header to look for when performing header based authentication. Default value is `Authorization`.
 
@@ -82,7 +82,7 @@ The name of the header to look for when performing header based authentication.
 
 > **headerScheme**: `string` = "(jwt\|bearer)"
 
-Defined in: [src/auth/JWTStrategy.ts:25](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L25)
+Defined in: [src/auth/JWTStrategy.ts:25](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L25)
 
 The authorization scheme type when using header based authentication. Default value is `jwt`.
 
@@ -92,6 +92,6 @@ The authorization scheme type when using header based authentication. Default va
 
 > **queryKey**: `string` = `"auth_token"`
 
-Defined in: [src/auth/JWTStrategy.ts:31](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L31)
+Defined in: [src/auth/JWTStrategy.ts:31](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/JWTStrategy.ts#L31)
 
 The name of the request query parameter to retrieve the token from when using query based authentication. Default value is `auth_token`.

package/docs/reference/classes/MetricsRoute.md

@@ -6,7 +6,7 @@
 
 # Class: MetricsRoute
 
-Defined in: [src/routes/MetricsRoute.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/MetricsRoute.ts#L19)
+Defined in: [src/routes/MetricsRoute.ts:19](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/MetricsRoute.ts#L19)
 
 Handles all REST API requests for the endpoint `/metrics'. This route handler produces Prometheus compatible metrics
 for use with a Prometheus based server.
@@ -20,7 +20,7 @@ from the provided `prom-client` dependency. See the `prom-client` documentation
 
 > **new MetricsRoute**(): `MetricsRoute`
 
-Defined in: [src/routes/MetricsRoute.ts:30](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/MetricsRoute.ts#L30)
+Defined in: [src/routes/MetricsRoute.ts:30](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/MetricsRoute.ts#L30)
 
 #### Returns
 

package/docs/reference/classes/ModelRoute.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: ModelRoute\<T\>
 
-Defined in: [src/routes/ModelRoute.ts:117](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L117)
+Defined in: [src/routes/ModelRoute.ts:117](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L117)
 
 The `ModelRoute` is an abstract base class that provides a set of built-in route behavior functions for handling
 requests for a given data model that is managed by a persistent datastore.
@@ -46,7 +46,7 @@ Jean-Philippe Steinmetz
 
 > `protected` `optional` **aclUtils?**: [`ACLUtils`](ACLUtils.md)
 
-Defined in: [src/routes/ModelRoute.ts:119](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L119)
+Defined in: [src/routes/ModelRoute.ts:119](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L119)
 
 ***
 
@@ -54,7 +54,7 @@ Defined in: [src/routes/ModelRoute.ts:119](https://github.com/rapidrest/service-
 
 > `protected` `optional` **cacheClient?**: `Redis`
 
-Defined in: [src/routes/ModelRoute.ts:123](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L123)
+Defined in: [src/routes/ModelRoute.ts:123](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L123)
 
 The redis client that will be used as a 2nd level cache for all cacheable models.
 
@@ -64,7 +64,7 @@ The redis client that will be used as a 2nd level cache for all cacheable models
 
 > `protected` `optional` **config?**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:127](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L127)
+Defined in: [src/routes/ModelRoute.ts:127](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L127)
 
 The global application configuration.
 
@@ -74,7 +74,7 @@ The global application configuration.
 
 > `protected` **defaultACLUid**: `string` = `""`
 
-Defined in: [src/routes/ModelRoute.ts:130](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L130)
+Defined in: [src/routes/ModelRoute.ts:130](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L130)
 
 The unique identifier of the default ACL for the model type.
 
@@ -84,7 +84,7 @@ The unique identifier of the default ACL for the model type.
 
 > `protected` **logger**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:133](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L133)
+Defined in: [src/routes/ModelRoute.ts:133](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L133)
 
 ***
 
@@ -92,7 +92,7 @@ Defined in: [src/routes/ModelRoute.ts:133](https://github.com/rapidrest/service-
 
 > `protected` `optional` **notificationUtils?**: [`NotificationUtils`](NotificationUtils.md)
 
-Defined in: [src/routes/ModelRoute.ts:136](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L136)
+Defined in: [src/routes/ModelRoute.ts:136](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L136)
 
 ***
 
@@ -100,7 +100,7 @@ Defined in: [src/routes/ModelRoute.ts:136](https://github.com/rapidrest/service-
 
 > `protected` `optional` **objectFactory?**: [`ObjectFactory`](ObjectFactory.md)
 
-Defined in: [src/routes/ModelRoute.ts:139](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L139)
+Defined in: [src/routes/ModelRoute.ts:139](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L139)
 
 ***
 
@@ -108,7 +108,7 @@ Defined in: [src/routes/ModelRoute.ts:139](https://github.com/rapidrest/service-
 
 > `protected` `optional` **repoUtils?**: [`RepoUtils`](RepoUtils.md)\<`T`\>
 
-Defined in: [src/routes/ModelRoute.ts:145](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L145)
+Defined in: [src/routes/ModelRoute.ts:145](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L145)
 
 The repository utility class to use for common operations.
 
@@ -118,7 +118,7 @@ The repository utility class to use for common operations.
 
 > `abstract` `protected` `readonly` **repoUtilsClass**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:142](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L142)
+Defined in: [src/routes/ModelRoute.ts:142](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L142)
 
 The class of the RepoUtils to use when instantiating the utility.
 
@@ -128,7 +128,7 @@ The class of the RepoUtils to use when instantiating the utility.
 
 > `protected` **trackChanges**: `number` = `0`
 
-Defined in: [src/routes/ModelRoute.ts:151](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L151)
+Defined in: [src/routes/ModelRoute.ts:151](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L151)
 
 The number of previous document versions to store in the database. A negative value indicates storing all
 versions, a value of `0` stores no versions.
@@ -139,7 +139,7 @@ versions, a value of `0` stores no versions.
 
 > `protected` **trustedRoles**: `string`[]
 
-Defined in: [src/routes/ModelRoute.ts:154](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L154)
+Defined in: [src/routes/ModelRoute.ts:154](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L154)
 
 ## Accessors
 
@@ -149,7 +149,7 @@ Defined in: [src/routes/ModelRoute.ts:154](https://github.com/rapidrest/service-
 
 > **get** `protected` **modelClass**(): `any`
 
-Defined in: [src/routes/ModelRoute.ts:159](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L159)
+Defined in: [src/routes/ModelRoute.ts:159](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L159)
 
 The class type of the model this route is associated with.
 
@@ -163,7 +163,7 @@ The class type of the model this route is associated with.
 
 > `protected` **doBulkCreate**(`objs`, `options`): `Promise`\<`T`[]\>
 
-Defined in: [src/routes/ModelRoute.ts:258](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L258)
+Defined in: [src/routes/ModelRoute.ts:258](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L258)
 
 Attempts to store a collection of objects provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
 object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
@@ -193,7 +193,7 @@ The options to process the request using.
 
 > `protected` **doBulkUpdate**(`objs`, `options`): `Promise`\<`T`[]\>
 
-Defined in: [src/routes/ModelRoute.ts:517](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L517)
+Defined in: [src/routes/ModelRoute.ts:517](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L517)
 
 Attempts to modify a collection of existing data model objects.
 
@@ -221,7 +221,7 @@ The options to process the request using.
 
 > `protected` **doCount**(`options`): `Promise`\<[`HttpResponse`](../interfaces/HttpResponse.md)\>
 
-Defined in: [src/routes/ModelRoute.ts:191](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L191)
+Defined in: [src/routes/ModelRoute.ts:191](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L191)
 
 Attempts to retrieve the number of data model objects matching the given set of criteria as specified in the
 request `query`. Any results that have been found are set to the `content-length` header of the `res` argument.
@@ -244,7 +244,7 @@ The options to process the request using.
 
 > `protected` **doCreate**(`obj`, `options`): `Promise`\<`T` \| `T`[]\>
 
-Defined in: [src/routes/ModelRoute.ts:288](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L288)
+Defined in: [src/routes/ModelRoute.ts:288](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L288)
 
 Attempts to store one or more objects provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
 object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
@@ -274,7 +274,7 @@ The options to process the request using.
 
 > `protected` **doCreateObject**(`obj`, `options`): `Promise`\<`T`\>
 
-Defined in: [src/routes/ModelRoute.ts:228](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L228)
+Defined in: [src/routes/ModelRoute.ts:228](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L228)
 
 Attempts to store an object provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
 object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
@@ -304,7 +304,7 @@ The options to process the request using.
 
 > `protected` **doDelete**(`id`, `options`): `Promise`\<`void`\>
 
-Defined in: [src/routes/ModelRoute.ts:313](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L313)
+Defined in: [src/routes/ModelRoute.ts:313](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L313)
 
 Attempts to delete an existing data model object with a given unique identifier encoded by the URI parameter
 `id`.
@@ -333,7 +333,7 @@ The options to process the request using.
 
 > `protected` **doExists**(`id`, `options`): `Promise`\<`any`\>
 
-Defined in: [src/routes/ModelRoute.ts:359](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L359)
+Defined in: [src/routes/ModelRoute.ts:359](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L359)
 
 Attempts to determine if an existing object with the given unique identifier exists.
 
@@ -361,7 +361,7 @@ The options to process the request using.
 
 > `protected` **doFindAll**(`options`): `Promise`\<`T`[]\>
 
-Defined in: [src/routes/ModelRoute.ts:400](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L400)
+Defined in: [src/routes/ModelRoute.ts:400](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L400)
 
 Attempts to retrieve all data model objects matching the given set of criteria as specified in the request
 `query`. Any results that have been found are set to the `result` property of the `res` argument. `result` is
@@ -385,7 +385,7 @@ The options to process the request using.
 
 > `protected` **doFindById**(`id`, `options`): `Promise`\<`T` \| `null`\>
 
-Defined in: [src/routes/ModelRoute.ts:435](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L435)
+Defined in: [src/routes/ModelRoute.ts:435](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L435)
 
 Attempts to retrieve a single data model object as identified by the `id` parameter in the URI.
 
@@ -411,7 +411,7 @@ The options to process the request using.
 
 > `protected` **doTruncate**(`options`): `Promise`\<`void`\>
 
-Defined in: [src/routes/ModelRoute.ts:477](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L477)
+Defined in: [src/routes/ModelRoute.ts:477](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L477)
 
 Attempts to remove all entries of the data model type from the datastore matching the given
 parameters and query.
@@ -434,7 +434,7 @@ The options to process the request using.
 
 > `protected` **doUpdate**(`id`, `obj`, `options`): `Promise`\<`T`\>
 
-Defined in: [src/routes/ModelRoute.ts:545](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L545)
+Defined in: [src/routes/ModelRoute.ts:545](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L545)
 
 Attempts to modify an existing data model object as identified by the `id` parameter in the URI.
 
@@ -466,7 +466,7 @@ The options to process the request using.
 
 > `protected` **doUpdateProperty**(`id`, `propertyName`, `value`, `options`): `Promise`\<`T`\>
 
-Defined in: [src/routes/ModelRoute.ts:596](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L596)
+Defined in: [src/routes/ModelRoute.ts:596](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L596)
 
 Attempts to modify a single property of an existing data model object as identified by the `id` parameter in the URI.
 
@@ -508,7 +508,7 @@ The options to process the request using.
 
 > `protected` **doValidate**(`objs`, `options?`): `Promise`\<`void`\>
 
-Defined in: [src/routes/ModelRoute.ts:642](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L642)
+Defined in: [src/routes/ModelRoute.ts:642](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L642)
 
 Calls `repoUtils.validate()` to validate the object(s) provided.
 

package/docs/reference/classes/ModelUtils.md

@@ -6,7 +6,7 @@
 
 # Class: ModelUtils
 
-Defined in: [src/models/ModelUtils.ts:24](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/ModelUtils.ts#L24)
+Defined in: [src/models/ModelUtils.ts:24](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/ModelUtils.ts#L24)
 
 Utility class for working with data model classes.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz
 
 > `static` **buildIdSearchQuery**\<`T`\>(`repo`, `modelClass`, `id`, `version?`, `productUid?`): `any`
 
-Defined in: [src/models/ModelUtils.ts:88](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/ModelUtils.ts#L88)
+Defined in: [src/models/ModelUtils.ts:88](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/ModelUtils.ts#L88)
 
 Builds a query object for use with `find` functions of the given repository for retrieving objects matching the
 specified unique identifier.
@@ -85,7 +85,7 @@ An object that can be passed to a TypeORM `find` function.
 
 > `static` **buildIdSearchQueryMongo**(`modelClass`, `id`, `version?`, `productUid?`): `any`
 
-Defined in: [src/models/ModelUtils.ts:145](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/ModelUtils.ts#L145)
+Defined in: [src/models/ModelUtils.ts:145](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/ModelUtils.ts#L145)
 
 Builds a MongoDB compatible query object for use in `find` functions for retrieving objects matching the
 specified unique identifier.
@@ -128,7 +128,7 @@ An object that can be passed to a MongoDB `find` function.
 
 > `static` **buildIdSearchQuerySQL**(`modelClass`, `id`, `version?`, `productUid?`): `any`
 
-Defined in: [src/models/ModelUtils.ts:112](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/ModelUtils.ts#L112)
+Defined in: [src/models/ModelUtils.ts:112](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/ModelUtils.ts#L112)
 
 Builds a TypeORM compatible query object for use in `find` functions for retrieving objects matching the
 specified unique identifier.
@@ -171,7 +171,7 @@ An object that can be passed to a TypeORM `find` function.
 
 > `static` **buildSearchQuery**\<`T`\>(`modelClass`, `repo`, `params?`, `queryParams?`, `exactMatch?`, `user?`): `any`
 
-Defined in: [src/models/ModelUtils.ts:380](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/ModelUtils.ts#L380)
+Defined in: [src/models/ModelUtils.ts:380](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/ModelUtils.ts#L380)
 
 Builds a query object for the given criteria and repository. Query params can have a value containing a
 conditional operator to apply for the search. The operator is encoded with the format `op(value)`. The following
@@ -246,7 +246,7 @@ The TypeORM compatible query object.
 
 > `static` **buildSearchQueryMongo**(`modelClass`, `params?`, `queryParams?`, `exactMatch?`, `user?`): `any`
 
-Defined in: [src/models/ModelUtils.ts:570](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/ModelUtils.ts#L570)
+Defined in: [src/models/ModelUtils.ts:570](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/ModelUtils.ts#L570)
 
 Builds a MongoDB compatible query object for the given criteria. Query params can have a value containing a
 conditional operator to apply for the search. The operator is encoded with the format `op(value)`. The following
@@ -309,7 +309,7 @@ The TypeORM compatible query object.
 
 > `static` **buildSearchQuerySQL**(`modelClass`, `params?`, `queryParams?`, `exactMatch?`, `user?`): `any`
 
-Defined in: [src/models/ModelUtils.ts:426](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/ModelUtils.ts#L426)
+Defined in: [src/models/ModelUtils.ts:426](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/ModelUtils.ts#L426)
 
 Builds a TypeORM compatible query object for the given criteria. Query params can have a value containing a
 conditional operator to apply for the search. The operator is encoded with the format `op(value)`. The following
@@ -370,7 +370,7 @@ The TypeORM compatible query object.
 
 > `static` **getIdPropertyNames**(`modelClass`): `string`[]
 
-Defined in: [src/models/ModelUtils.ts:56](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/ModelUtils.ts#L56)
+Defined in: [src/models/ModelUtils.ts:56](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/ModelUtils.ts#L56)
 
 Retrieves a list of all of the specified class's properties that have the
 
@@ -402,7 +402,7 @@ decorator applied.
 
 > `static` **loadModels**(`src`, `result?`): `Promise`\<`Map`\<`string`, `any`\>\>
 
-Defined in: [src/models/ModelUtils.ts:710](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/ModelUtils.ts#L710)
+Defined in: [src/models/ModelUtils.ts:710](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/ModelUtils.ts#L710)
 
 Loads all model schema files from the specified path and returns a map containing all the definitions.
 
@@ -430,7 +430,7 @@ A map containing of all loaded model names to their class definitions.
 
 > `static` **setTypeOrm**(`module`): `void`
 
-Defined in: [src/models/ModelUtils.ts:34](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/ModelUtils.ts#L34)
+Defined in: [src/models/ModelUtils.ts:34](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/ModelUtils.ts#L34)
 
 Provides the `typeorm` module to use when building SQL queries. This is called automatically when a SQL
 datastore connection is established.

package/docs/reference/classes/MongoConnection.md

@@ -6,7 +6,7 @@
 
 # Class: MongoConnection
 
-Defined in: [src/database/MongoConnection.ts:17](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L17)
+Defined in: [src/database/MongoConnection.ts:17](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L17)
 
 Represents a single named connection to a MongoDB database using the native `mongodb` driver, including the
 registry of all model classes assigned to the connection's datastore.
@@ -24,7 +24,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new MongoConnection**(`name`, `client`, `db`, `entities?`): `MongoConnection`
 
-Defined in: [src/database/MongoConnection.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L29)
+Defined in: [src/database/MongoConnection.ts:29](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L29)
 
 #### Parameters
 
@@ -54,7 +54,7 @@ Defined in: [src/database/MongoConnection.ts:29](https://github.com/rapidrest/se
 
 > `readonly` **client**: `MongoClient`
 
-Defined in: [src/database/MongoConnection.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L19)
+Defined in: [src/database/MongoConnection.ts:19](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L19)
 
 The underlying MongoDB client.
 
@@ -64,7 +64,7 @@ The underlying MongoDB client.
 
 > `readonly` **db**: `Db`
 
-Defined in: [src/database/MongoConnection.ts:21](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L21)
+Defined in: [src/database/MongoConnection.ts:21](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L21)
 
 The database that this connection is bound to.
 
@@ -74,7 +74,7 @@ The database that this connection is bound to.
 
 > `readonly` **name**: `string`
 
-Defined in: [src/database/MongoConnection.ts:23](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L23)
+Defined in: [src/database/MongoConnection.ts:23](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L23)
 
 The name of the datastore that this connection was created for.
 
@@ -86,7 +86,7 @@ The name of the datastore that this connection was created for.
 
 > **get** **entityClasses**(): `any`[]
 
-Defined in: [src/database/MongoConnection.ts:71](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L71)
+Defined in: [src/database/MongoConnection.ts:71](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L71)
 
 Returns the list of all model classes registered with this connection.
 
@@ -102,7 +102,7 @@ Returns the list of all model classes registered with this connection.
 
 > **get** **isConnected**(): `boolean`
 
-Defined in: [src/database/MongoConnection.ts:42](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L42)
+Defined in: [src/database/MongoConnection.ts:42](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L42)
 
 Indicates whether or not the connection is currently active.
 
@@ -116,7 +116,7 @@ Indicates whether or not the connection is currently active.
 
 > **admin**(): `Admin`
 
-Defined in: [src/database/MongoConnection.ts:47](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L47)
+Defined in: [src/database/MongoConnection.ts:47](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L47)
 
 Returns the admin interface of the underlying database.
 
@@ -130,7 +130,7 @@ Returns the admin interface of the underlying database.
 
 > **close**(): `Promise`\<`void`\>
 
-Defined in: [src/database/MongoConnection.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L54)
+Defined in: [src/database/MongoConnection.ts:54](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L54)
 
 Closes the connection to the database server.
 
@@ -144,7 +144,7 @@ Closes the connection to the database server.
 
 > **collectionNameFor**(`clazz`): `string`
 
-Defined in: [src/database/MongoConnection.ts:64](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L64)
+Defined in: [src/database/MongoConnection.ts:64](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L64)
 
 Returns the name of the collection that records of the given model class are stored in.
 
@@ -166,7 +166,7 @@ The model class to resolve the collection name for.
 
 > **getMongoRepository**\<`T`\>(`classOrName`): [`MongoRepository`](MongoRepository.md)\<`T`\>
 
-Defined in: [src/database/MongoConnection.ts:105](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L105)
+Defined in: [src/database/MongoConnection.ts:105](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L105)
 
 Returns a repository for performing operations against the collection associated with the given model class.
 This is an alias of `getRepository` provided for compatibility with TypeORM's `DataSource` interface.
@@ -195,7 +195,7 @@ The model class, or the name of a registered model class, to retrieve a reposito
 
 > **getRepository**\<`T`\>(`classOrName`): [`MongoRepository`](MongoRepository.md)\<`T`\>
 
-Defined in: [src/database/MongoConnection.ts:80](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoConnection.ts#L80)
+Defined in: [src/database/MongoConnection.ts:80](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/MongoConnection.ts#L80)
 
 Returns a repository for performing operations against the collection associated with the given model class.