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

package/docs/reference/interfaces/HttpResponse.md

@@ -0,0 +1,164 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / HttpResponse
+
+# Interface: HttpResponse
+
+Defined in: [src/http/types.ts:37](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L37)
+
+Framework-agnostic HTTP response interface. Mirrors the Express `Response` surface used
+throughout this codebase.
+
+## Indexable
+
+> \[`key`: `string`\]: `any`
+
+Allow arbitrary per-response properties.
+
+## Properties
+
+### headersSent
+
+> **headersSent**: `boolean`
+
+Defined in: [src/http/types.ts:39](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L39)
+
+***
+
+### result?
+
+> `optional` **result?**: `any`
+
+Defined in: [src/http/types.ts:42](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L42)
+
+Intermediate result passed between middleware via res.result.
+
+***
+
+### statusCode
+
+> **statusCode**: `number`
+
+Defined in: [src/http/types.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L38)
+
+***
+
+### writableEnded
+
+> **writableEnded**: `boolean`
+
+Defined in: [src/http/types.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L40)
+
+## Methods
+
+### end()
+
+> **end**(`data?`): `void`
+
+Defined in: [src/http/types.ts:48](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L48)
+
+#### Parameters
+
+##### data?
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### getHeader()
+
+> **getHeader**(`key`): `string` \| `undefined`
+
+Defined in: [src/http/types.ts:45](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L45)
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`string` \| `undefined`
+
+***
+
+### json()
+
+> **json**(`data`): `void`
+
+Defined in: [src/http/types.ts:46](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L46)
+
+#### Parameters
+
+##### data
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### send()
+
+> **send**(`data?`): `void`
+
+Defined in: [src/http/types.ts:47](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L47)
+
+#### Parameters
+
+##### data?
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### setHeader()
+
+> **setHeader**(`key`, `value`): `this`
+
+Defined in: [src/http/types.ts:44](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L44)
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### value
+
+`string` \| `number`
+
+#### Returns
+
+`this`
+
+***
+
+### status()
+
+> **status**(`code`): `this`
+
+Defined in: [src/http/types.ts:43](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L43)
+
+#### Parameters
+
+##### code
+
+`number`
+
+#### Returns
+
+`this`

package/docs/reference/interfaces/JWTAuthResult.md

@@ -6,7 +6,7 @@
 
 # Interface: JWTAuthResult
 
-Defined in: [src/auth/JWTStrategy.ts:42](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L42)
+Defined in: [src/auth/JWTStrategy.ts:41](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L41)
 
 Result returned by `JWTStrategy.authenticate()`.
 
@@ -20,7 +20,7 @@ Result returned by `JWTStrategy.authenticate()`.
 
 > `optional` **data?**: `string`
 
-Defined in: [src/auth/AuthStrategy.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L12)
+Defined in: [src/auth/AuthStrategy.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthStrategy.ts#L12)
 
 The raw auth data that was verified.
 
@@ -34,7 +34,7 @@ The raw auth data that was verified.
 
 > **method**: `string`
 
-Defined in: [src/auth/AuthStrategy.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L14)
+Defined in: [src/auth/AuthStrategy.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthStrategy.ts#L14)
 
 The name of the auth strategy that produced this result.
 
@@ -48,7 +48,7 @@ The name of the auth strategy that produced this result.
 
 > `optional` **payload?**: `any`
 
-Defined in: [src/auth/AuthStrategy.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L16)
+Defined in: [src/auth/AuthStrategy.ts:16](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthStrategy.ts#L16)
 
 The fully decoded payload from the auth data.
 
@@ -62,11 +62,11 @@ The fully decoded payload from the auth data.
 
 > `optional` **tokenFound?**: `boolean`
 
-Defined in: [src/auth/JWTStrategy.ts:49](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L49)
+Defined in: [src/auth/JWTStrategy.ts:48](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L48)
 
-`true` when at least one credential (header, query param, or cookie) was present in
-the request, even if it was ultimately invalid. Distinguishes "no token submitted" from
-"bad token submitted" — useful for deciding whether to reject early vs. fall through to
+`true` when at least one credential (header, query param, or cookie) was present in
+the request, even if it was ultimately invalid. Distinguishes "no token submitted" from
+"bad token submitted" — useful for deciding whether to reject early vs. fall through to
 an alternative auth path (e.g. WebSocket message-based LOGIN).
 
 ***
@@ -75,7 +75,7 @@ an alternative auth path (e.g. WebSocket message-based LOGIN).
 
 > `optional` **user?**: `JWTUser`
 
-Defined in: [src/auth/AuthStrategy.ts:18](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L18)
+Defined in: [src/auth/AuthStrategy.ts:18](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthStrategy.ts#L18)
 
 The authenticated user profile, or `undefined` if authentication failed.
 

package/docs/reference/interfaces/RepoCreateOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: RepoCreateOptions
 
-Defined in: [src/models/RepoUtils.ts:46](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L46)
+Defined in: [src/models/RepoUtils.ts:46](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L46)
 
 The available options for the `RepoUtils.create()` operation.
 
@@ -20,7 +20,7 @@ The available options for the `RepoUtils.create()` operation.
 
 > `optional` **acl?**: [`AccessControlList`](AccessControlList.md)
 
-Defined in: [src/models/RepoUtils.ts:48](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L48)
+Defined in: [src/models/RepoUtils.ts:48](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L48)
 
 The AccessControlList to use when creating a new object.
 
@@ -30,7 +30,7 @@ The AccessControlList to use when creating a new object.
 
 > `optional` **ignoreACL?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
 
 Set to `true` to ignore the ACL permissions check.
 
@@ -44,7 +44,7 @@ Set to `true` to ignore the ACL permissions check.
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L34)
+Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
 
 An additional list of channel names to send push notifications to.
 
@@ -58,7 +58,7 @@ An additional list of channel names to send push notifications to.
 
 > `optional` **recordEvent?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
 
 Indicates if a telemetry event should be broadcast for the request.
 
@@ -72,7 +72,7 @@ Indicates if a telemetry event should be broadcast for the request.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L38)
+Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
 
 Set to `true` to not send a push notification.
 
@@ -86,7 +86,7 @@ Set to `true` to not send a push notification.
 
 > `optional` **user?**: `JWTUser`
 
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
 
 The authenticated user making the request.
 

package/docs/reference/interfaces/RepoDeleteOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: RepoDeleteOptions
 
-Defined in: [src/models/RepoUtils.ts:54](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L54)
+Defined in: [src/models/RepoUtils.ts:54](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L54)
 
 The available options for the `RepoUtils.delete()` operation.
 
@@ -20,7 +20,7 @@ The available options for the `RepoUtils.delete()` operation.
 
 > `optional` **ignoreACL?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
 
 Set to `true` to ignore the ACL permissions check.
 
@@ -34,7 +34,7 @@ Set to `true` to ignore the ACL permissions check.
 
 > `optional` **productUid?**: `string`
 
-Defined in: [src/models/RepoUtils.ts:56](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L56)
+Defined in: [src/models/RepoUtils.ts:56](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L56)
 
 The desired product uid of the resource to delete.
 
@@ -44,7 +44,7 @@ The desired product uid of the resource to delete.
 
 > `optional` **purge?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:58](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L58)
+Defined in: [src/models/RepoUtils.ts:58](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L58)
 
 Set to true to permanently remove the object from the database (if applicable).
 
@@ -54,7 +54,7 @@ Set to true to permanently remove the object from the database (if applicable).
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L34)
+Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
 
 An additional list of channel names to send push notifications to.
 
@@ -68,7 +68,7 @@ An additional list of channel names to send push notifications to.
 
 > `optional` **recordEvent?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
 
 Indicates if a telemetry event should be broadcast for the request.
 
@@ -82,7 +82,7 @@ Indicates if a telemetry event should be broadcast for the request.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L38)
+Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
 
 Set to `true` to not send a push notification.
 
@@ -96,7 +96,7 @@ Set to `true` to not send a push notification.
 
 > `optional` **user?**: `JWTUser`
 
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
 
 The authenticated user making the request.
 
@@ -110,6 +110,6 @@ The authenticated user making the request.
 
 > `optional` **version?**: `string` \| `number`
 
-Defined in: [src/models/RepoUtils.ts:60](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L60)
+Defined in: [src/models/RepoUtils.ts:60](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L60)
 
 The desired version number of the resource to delete.

package/docs/reference/interfaces/RepoFindOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: RepoFindOptions
 
-Defined in: [src/models/RepoUtils.ts:63](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L63)
+Defined in: [src/models/RepoUtils.ts:63](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L63)
 
 The available options used for `RepoUtils` operations.
 
@@ -20,7 +20,7 @@ The available options used for `RepoUtils` operations.
 
 > `optional` **ignoreACL?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
 
 Set to `true` to ignore the ACL permissions check.
 
@@ -34,7 +34,7 @@ Set to `true` to ignore the ACL permissions check.
 
 > `optional` **limit?**: `number`
 
-Defined in: [src/models/RepoUtils.ts:65](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L65)
+Defined in: [src/models/RepoUtils.ts:65](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L65)
 
 The total number of resources to retrieve.
 
@@ -44,7 +44,7 @@ The total number of resources to retrieve.
 
 > `optional` **page?**: `number`
 
-Defined in: [src/models/RepoUtils.ts:67](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L67)
+Defined in: [src/models/RepoUtils.ts:67](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L67)
 
 The page number of the paginated results to retrieve.
 
@@ -54,7 +54,7 @@ The page number of the paginated results to retrieve.
 
 > `optional` **productUid?**: `string`
 
-Defined in: [src/models/RepoUtils.ts:69](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L69)
+Defined in: [src/models/RepoUtils.ts:69](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L69)
 
 The desired product uid of the resources to retrieve.
 
@@ -64,7 +64,7 @@ The desired product uid of the resources to retrieve.
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L34)
+Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
 
 An additional list of channel names to send push notifications to.
 
@@ -78,7 +78,7 @@ An additional list of channel names to send push notifications to.
 
 > `optional` **recordEvent?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
 
 Indicates if a telemetry event should be broadcast for the request.
 
@@ -92,7 +92,7 @@ Indicates if a telemetry event should be broadcast for the request.
 
 > `optional` **skipCache?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:71](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L71)
+Defined in: [src/models/RepoUtils.ts:71](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L71)
 
 Set to `true` to skip retrieval from the cache. Default is `false`.
 
@@ -102,7 +102,7 @@ Set to `true` to skip retrieval from the cache. Default is `false`.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L38)
+Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
 
 Set to `true` to not send a push notification.
 
@@ -116,7 +116,7 @@ Set to `true` to not send a push notification.
 
 > `optional` **user?**: `JWTUser`
 
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
 
 The authenticated user making the request.
 
@@ -130,6 +130,6 @@ The authenticated user making the request.
 
 > `optional` **version?**: `string` \| `number`
 
-Defined in: [src/models/RepoUtils.ts:73](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L73)
+Defined in: [src/models/RepoUtils.ts:73](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L73)
 
 The desired version number of the resources to retrieve.

package/docs/reference/interfaces/RepoOperationOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: RepoOperationOptions
 
-Defined in: [src/models/RepoUtils.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L30)
+Defined in: [src/models/RepoUtils.ts:30](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L30)
 
 The available options used for `RepoUtils` operations.
 
@@ -24,7 +24,7 @@ The available options used for `RepoUtils` operations.
 
 > `optional` **ignoreACL?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
 
 Set to `true` to ignore the ACL permissions check.
 
@@ -34,7 +34,7 @@ Set to `true` to ignore the ACL permissions check.
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L34)
+Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
 
 An additional list of channel names to send push notifications to.
 
@@ -44,7 +44,7 @@ An additional list of channel names to send push notifications to.
 
 > `optional` **recordEvent?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
 
 Indicates if a telemetry event should be broadcast for the request.
 
@@ -54,7 +54,7 @@ Indicates if a telemetry event should be broadcast for the request.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L38)
+Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
 
 Set to `true` to not send a push notification.
 
@@ -64,6 +64,6 @@ Set to `true` to not send a push notification.
 
 > `optional` **user?**: `JWTUser`
 
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
 
 The authenticated user making the request.

package/docs/reference/interfaces/RepoUpdateOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: RepoUpdateOptions\<T\>
 
-Defined in: [src/models/RepoUtils.ts:79](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L79)
+Defined in: [src/models/RepoUtils.ts:79](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L79)
 
 The available options for the `RepoUtils.update()` operation.
 
@@ -26,7 +26,7 @@ The available options for the `RepoUtils.update()` operation.
 
 > `optional` **ignoreACL?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
 
 Set to `true` to ignore the ACL permissions check.
 
@@ -40,7 +40,7 @@ Set to `true` to ignore the ACL permissions check.
 
 > `optional` **productUid?**: `string`
 
-Defined in: [src/models/RepoUtils.ts:81](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L81)
+Defined in: [src/models/RepoUtils.ts:81](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L81)
 
 The desired product uid of the resource to update.
 
@@ -50,7 +50,7 @@ The desired product uid of the resource to update.
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L34)
+Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
 
 An additional list of channel names to send push notifications to.
 
@@ -64,7 +64,7 @@ An additional list of channel names to send push notifications to.
 
 > `optional` **recordEvent?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
 
 Indicates if a telemetry event should be broadcast for the request.
 
@@ -78,7 +78,7 @@ Indicates if a telemetry event should be broadcast for the request.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L38)
+Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
 
 Set to `true` to not send a push notification.
 
@@ -92,7 +92,7 @@ Set to `true` to not send a push notification.
 
 > `optional` **user?**: `JWTUser`
 
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
 
 The authenticated user making the request.
 
@@ -106,6 +106,6 @@ The authenticated user making the request.
 
 > `optional` **version?**: `string` \| `number`
 
-Defined in: [src/models/RepoUtils.ts:83](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L83)
+Defined in: [src/models/RepoUtils.ts:83](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L83)
 
 The desired version number of the resource to update.

package/docs/reference/interfaces/RequestOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: RequestOptions
 
-Defined in: [src/routes/ModelRoute.ts:25](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L25)
+Defined in: [src/routes/ModelRoute.ts:25](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L25)
 
 The set of options required by all request handlers.
 
@@ -27,7 +27,7 @@ The set of options required by all request handlers.
 
 > `optional` **ignoreACL?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
 
 Set to `true` to ignore the ACL permissions check.
 
@@ -41,7 +41,7 @@ Set to `true` to ignore the ACL permissions check.
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L34)
+Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
 
 An additional list of channel names to send push notifications to.
 
@@ -55,7 +55,7 @@ An additional list of channel names to send push notifications to.
 
 > `optional` **recordEvent?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
 
 Indicates if a telemetry event should be broadcast for the request.
 
@@ -67,9 +67,9 @@ Indicates if a telemetry event should be broadcast for the request.
 
 ### req?
 
-> `optional` **req?**: `HttpRequest`
+> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
 
-Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L27)
+Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L27)
 
 The originating client request.
 
@@ -77,9 +77,9 @@ The originating client request.
 
 ### res?
 
-> `optional` **res?**: `HttpResponse`
+> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
 
-Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L29)
+Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L29)
 
 The outgoing client response.
 
@@ -89,7 +89,7 @@ The outgoing client response.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L38)
+Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
 
 Set to `true` to not send a push notification.
 
@@ -103,7 +103,7 @@ Set to `true` to not send a push notification.
 
 > `optional` **user?**: `JWTUser`
 
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
 
 The authenticated user making the request.