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

package/docs/reference/interfaces/AccessControlList.md

@@ -6,7 +6,7 @@
 
 # Interface: AccessControlList
 
-Defined in: [src/security/AccessControlList.ts:97](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L97)
+Defined in: [src/security/AccessControlList.ts:97](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/AccessControlList.ts#L97)
 
 The access control list provides a generic interface for the storage of user and roles permissions. Each ACL object
 represents the permission set for a single entity within the system. The entity is identified generically by its
@@ -40,7 +40,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `optional` **parent?**: `AccessControlList` \| `null`
 
-Defined in: [src/security/AccessControlList.ts:106](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L106)
+Defined in: [src/security/AccessControlList.ts:106](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/AccessControlList.ts#L106)
 
 The parent access control list that this instance inherits permissions from.
 
@@ -50,7 +50,7 @@ The parent access control list that this instance inherits permissions from.
 
 > `optional` **parentUid?**: `string`
 
-Defined in: [src/security/AccessControlList.ts:112](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L112)
+Defined in: [src/security/AccessControlList.ts:112](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/AccessControlList.ts#L112)
 
 The universally unique identifier of the parent `AccessControlList` that this object will inherit permissions
 from.
@@ -61,7 +61,7 @@ from.
 
 > **records**: [`ACLRecord`](ACLRecord.md)[]
 
-Defined in: [src/security/AccessControlList.ts:117](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L117)
+Defined in: [src/security/AccessControlList.ts:117](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/AccessControlList.ts#L117)
 
 The list of all permission records associated with this access control list.
 
@@ -71,6 +71,6 @@ The list of all permission records associated with this access control list.
 
 > **uid**: `string`
 
-Defined in: [src/security/AccessControlList.ts:101](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L101)
+Defined in: [src/security/AccessControlList.ts:101](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/AccessControlList.ts#L101)
 
 The universally unique identifier (`uuid`) of the entity that the access control list belongs to.

package/docs/reference/interfaces/AuthResult.md

@@ -6,7 +6,7 @@
 
 # Interface: AuthResult
 
-Defined in: [src/auth/AuthStrategy.ts:10](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L10)
+Defined in: [src/auth/AuthStrategy.ts:10](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthStrategy.ts#L10)
 
 Result returned by `AuthStrategy.authenticate()`.
 
@@ -20,7 +20,7 @@ Result returned by `AuthStrategy.authenticate()`.
 
 > `optional` **data?**: `string`
 
-Defined in: [src/auth/AuthStrategy.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L12)
+Defined in: [src/auth/AuthStrategy.ts:12](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthStrategy.ts#L12)
 
 The raw auth data that was verified.
 
@@ -30,7 +30,7 @@ The raw auth data that was verified.
 
 > **method**: `string`
 
-Defined in: [src/auth/AuthStrategy.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L14)
+Defined in: [src/auth/AuthStrategy.ts:14](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthStrategy.ts#L14)
 
 The name of the auth strategy that produced this result.
 
@@ -40,7 +40,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/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L16)
+Defined in: [src/auth/AuthStrategy.ts:16](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthStrategy.ts#L16)
 
 The fully decoded payload from the auth data.
 
@@ -50,6 +50,6 @@ The fully decoded payload from the auth data.
 
 > `optional` **user?**: `JWTUser`
 
-Defined in: [src/auth/AuthStrategy.ts:18](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L18)
+Defined in: [src/auth/AuthStrategy.ts:18](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthStrategy.ts#L18)
 
 The authenticated user profile, or `undefined` if authentication failed.

package/docs/reference/interfaces/AuthStrategy.md

@@ -6,7 +6,7 @@
 
 # Interface: AuthStrategy
 
-Defined in: [src/auth/AuthStrategy.ts:24](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L24)
+Defined in: [src/auth/AuthStrategy.ts:24](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthStrategy.ts#L24)
 
 Describes an interface for implementing strategies that will perform authentication.
 
@@ -16,7 +16,7 @@ Describes an interface for implementing strategies that will perform authenticat
 
 > `readonly` **name**: `string`
 
-Defined in: [src/auth/AuthStrategy.ts:26](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L26)
+Defined in: [src/auth/AuthStrategy.ts:26](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthStrategy.ts#L26)
 
 The unique name of the strategy used to register with the `AuthMiddleware`.
 
@@ -26,7 +26,7 @@ The unique name of the strategy used to register with the `AuthMiddleware`.
 
 > **authenticate**(`req`, `res?`, `required?`): `Promise`\<[`AuthResult`](AuthResult.md) \| `undefined`\>
 
-Defined in: [src/auth/AuthStrategy.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L37)
+Defined in: [src/auth/AuthStrategy.ts:37](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthStrategy.ts#L37)
 
 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`
@@ -62,7 +62,7 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
 
 > **authenticateSync**(`req`, `res?`, `required?`): [`AuthResult`](AuthResult.md) \| `undefined`
 
-Defined in: [src/auth/AuthStrategy.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L50)
+Defined in: [src/auth/AuthStrategy.ts:50](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthStrategy.ts#L50)
 
 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`

package/docs/reference/interfaces/CreateRequestOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: CreateRequestOptions
 
-Defined in: [src/routes/ModelRoute.ts:35](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L35)
+Defined in: [src/routes/ModelRoute.ts:35](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L35)
 
 The set of options required by create request handlers.
 
@@ -20,7 +20,7 @@ The set of options required by create request handlers.
 
 > `optional` **acl?**: [`AccessControlList`](AccessControlList.md) \| [`AccessControlList`](AccessControlList.md)[]
 
-Defined in: [src/routes/ModelRoute.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L36)
+Defined in: [src/routes/ModelRoute.ts:36](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L36)
 
 ***
 
@@ -28,7 +28,7 @@ Defined in: [src/routes/ModelRoute.ts:36](https://github.com/rapidrest/service-c
 
 > `optional` **ignoreACL?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L32)
+Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L33)
 
 Set to `true` to ignore the ACL permissions check.
 
@@ -42,7 +42,7 @@ Set to `true` to ignore the ACL permissions check.
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/routes/ModelRoute.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L38)
+Defined in: [src/routes/ModelRoute.ts:38](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L38)
 
 An additional list of channel names to send push notifications to.
 
@@ -56,7 +56,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/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L36)
+Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L37)
 
 Indicates if a telemetry event should be broadcast for the request.
 
@@ -70,7 +70,7 @@ Indicates if a telemetry event should be broadcast for the request.
 
 > `optional` **req?**: [`HttpRequest`](HttpRequest.md)
 
-Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L27)
+Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L27)
 
 The originating client request.
 
@@ -84,7 +84,7 @@ The originating client request.
 
 > `optional` **res?**: [`HttpResponse`](HttpResponse.md)
 
-Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L29)
+Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L29)
 
 The outgoing client response.
 
@@ -98,7 +98,7 @@ The outgoing client response.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/routes/ModelRoute.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L40)
+Defined in: [src/routes/ModelRoute.ts:40](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L40)
 
 Set to `true` to not send a push notification.
 
@@ -112,7 +112,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/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
+Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L41)
 
 The authenticated user making the request.
 

package/docs/reference/interfaces/DeleteRequestOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: DeleteRequestOptions
 
-Defined in: [src/routes/ModelRoute.ts:46](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L46)
+Defined in: [src/routes/ModelRoute.ts:46](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L46)
 
 The set of options required by delete request handlers.
 
@@ -24,7 +24,7 @@ The set of options required by delete request handlers.
 
 > `optional` **ignoreACL?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L32)
+Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L33)
 
 Set to `true` to ignore the ACL permissions check.
 
@@ -38,7 +38,7 @@ Set to `true` to ignore the ACL permissions check.
 
 > `optional` **productUid?**: `string`
 
-Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L48)
+Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L48)
 
 The desired product uid of the resource to delete.
 
@@ -48,7 +48,7 @@ The desired product uid of the resource to delete.
 
 > `optional` **purge?**: `boolean`
 
-Defined in: [src/routes/ModelRoute.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L50)
+Defined in: [src/routes/ModelRoute.ts:50](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L50)
 
 Set to true to permanently remove the object from the database (if applicable).
 
@@ -58,7 +58,7 @@ Set to true to permanently remove the object from the database (if applicable).
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/routes/ModelRoute.ts:52](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L52)
+Defined in: [src/routes/ModelRoute.ts:52](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L52)
 
 An additional list of channel names to send push notifications to.
 
@@ -72,7 +72,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/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L36)
+Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L37)
 
 Indicates if a telemetry event should be broadcast for the request.
 
@@ -86,7 +86,7 @@ Indicates if a telemetry event should be broadcast for the request.
 
 > `optional` **req?**: [`HttpRequest`](HttpRequest.md)
 
-Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L27)
+Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L27)
 
 The originating client request.
 
@@ -100,7 +100,7 @@ The originating client request.
 
 > `optional` **res?**: [`HttpResponse`](HttpResponse.md)
 
-Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L29)
+Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L29)
 
 The outgoing client response.
 
@@ -114,7 +114,7 @@ The outgoing client response.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/routes/ModelRoute.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L54)
+Defined in: [src/routes/ModelRoute.ts:54](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L54)
 
 Set to `true` to not send a push notification.
 
@@ -128,7 +128,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/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
+Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L41)
 
 The authenticated user making the request.
 
@@ -142,6 +142,6 @@ The authenticated user making the request.
 
 > `optional` **version?**: `string` \| `number`
 
-Defined in: [src/routes/ModelRoute.ts:56](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L56)
+Defined in: [src/routes/ModelRoute.ts:56](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L56)
 
 The desired version number of the resource to delete.

package/docs/reference/interfaces/FindRequestOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: FindRequestOptions
 
-Defined in: [src/routes/ModelRoute.ts:62](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L62)
+Defined in: [src/routes/ModelRoute.ts:62](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L62)
 
 The set of options required by search request handlers.
 
@@ -20,7 +20,7 @@ The set of options required by search request handlers.
 
 > `optional` **ignoreACL?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L32)
+Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L33)
 
 Set to `true` to ignore the ACL permissions check.
 
@@ -34,7 +34,7 @@ Set to `true` to ignore the ACL permissions check.
 
 > `optional` **params?**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:64](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L64)
+Defined in: [src/routes/ModelRoute.ts:64](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L64)
 
 The list of URL parameters to use in the search.
 
@@ -44,7 +44,7 @@ The list of URL parameters to use in the search.
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L34)
+Defined in: [src/models/RepoUtils.ts:35](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L35)
 
 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.
 
 > **query**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:66](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L66)
+Defined in: [src/routes/ModelRoute.ts:66](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L66)
 
 The list of query parameters to use in the search.
 
@@ -68,7 +68,7 @@ The list of query parameters to use in the search.
 
 > `optional` **recordEvent?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L36)
+Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L37)
 
 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` **req?**: [`HttpRequest`](HttpRequest.md)
 
-Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L27)
+Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L27)
 
 The originating client request.
 
@@ -96,7 +96,7 @@ The originating client request.
 
 > `optional` **res?**: [`HttpResponse`](HttpResponse.md)
 
-Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L29)
+Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/ModelRoute.ts#L29)
 
 The outgoing client response.
 
@@ -110,7 +110,7 @@ The outgoing client response.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L38)
+Defined in: [src/models/RepoUtils.ts:39](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L39)
 
 Set to `true` to not send a push notification.
 
@@ -124,7 +124,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/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
+Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/models/RepoUtils.ts#L41)
 
 The authenticated user making the request.
 

package/docs/reference/interfaces/HttpRequest.md

@@ -6,7 +6,7 @@
 
 # Interface: HttpRequest
 
-Defined in: [src/http/types.ts:10](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L10)
+Defined in: [src/http/types.ts:10](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L10)
 
 Framework-agnostic HTTP request interface. Mirrors the Express `Request` surface used throughout
 this codebase so that route handlers, middleware, and utilities require no changes when the
@@ -28,7 +28,7 @@ Allow arbitrary per-request properties (e.g. req.websocket, req.wsHandled).
 
 > `optional` **authPayload?**: `any`
 
-Defined in: [src/http/types.ts:26](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L26)
+Defined in: [src/http/types.ts:26](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L26)
 
 Full decoded JWT payload, set by JWT auth middleware.
 
@@ -38,7 +38,7 @@ Full decoded JWT payload, set by JWT auth middleware.
 
 > `optional` **authToken?**: `string`
 
-Defined in: [src/http/types.ts:28](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L28)
+Defined in: [src/http/types.ts:28](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L28)
 
 Raw JWT token string, set by JWT auth middleware.
 
@@ -48,7 +48,7 @@ Raw JWT token string, set by JWT auth middleware.
 
 > **body**: `any`
 
-Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L17)
+Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L17)
 
 ***
 
@@ -56,7 +56,7 @@ Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blo
 
 > **cookies**: `Record`\<`string`, `string`\>
 
-Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L19)
+Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L19)
 
 ***
 
@@ -64,7 +64,7 @@ Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blo
 
 > **headers**: `Record`\<`string`, `string` \| `string`[] \| `undefined`\>
 
-Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L14)
+Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L14)
 
 ***
 
@@ -72,7 +72,7 @@ Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blo
 
 > **method**: `string`
 
-Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L11)
+Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L11)
 
 ***
 
@@ -80,7 +80,7 @@ Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blo
 
 > **params**: `Record`\<`string`, `string`\>
 
-Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L15)
+Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L15)
 
 ***
 
@@ -88,7 +88,7 @@ Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blo
 
 > **path**: `string`
 
-Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L12)
+Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L12)
 
 ***
 
@@ -96,7 +96,7 @@ Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blo
 
 > **query**: `Record`\<`string`, `string` \| `string`[]\>
 
-Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L16)
+Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L16)
 
 ***
 
@@ -104,7 +104,7 @@ Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blo
 
 > `optional` **rawBody?**: `Buffer`\<`ArrayBufferLike`\>
 
-Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L18)
+Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L18)
 
 ***
 
@@ -112,7 +112,7 @@ Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blo
 
 > **signedCookies**: `Record`\<`string`, `string`\>
 
-Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L20)
+Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L20)
 
 ***
 
@@ -120,7 +120,7 @@ Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blo
 
 > **socket**: `object`
 
-Defined in: [src/http/types.ts:22](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L22)
+Defined in: [src/http/types.ts:22](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L22)
 
 Minimal socket interface; populated with remote address for IP extraction.
 
@@ -134,7 +134,7 @@ Minimal socket interface; populated with remote address for IP extraction.
 
 > **url**: `string`
 
-Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L13)
+Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L13)
 
 ***
 
@@ -142,6 +142,6 @@ Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blo
 
 > `optional` **user?**: `any`
 
-Defined in: [src/http/types.ts:24](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L24)
+Defined in: [src/http/types.ts:24](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L24)
 
 Set by JWT auth middleware after successful token verification.

package/docs/reference/interfaces/HttpResponse.md

@@ -6,7 +6,7 @@
 
 # Interface: HttpResponse
 
-Defined in: [src/http/types.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L37)
+Defined in: [src/http/types.ts:37](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L37)
 
 Framework-agnostic HTTP response interface. Mirrors the Express `Response` surface used
 throughout this codebase.
@@ -23,7 +23,7 @@ Allow arbitrary per-response properties.
 
 > **headersSent**: `boolean`
 
-Defined in: [src/http/types.ts:39](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L39)
+Defined in: [src/http/types.ts:39](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L39)
 
 ***
 
@@ -31,7 +31,7 @@ Defined in: [src/http/types.ts:39](https://github.com/rapidrest/service-core/blo
 
 > `optional` **result?**: `any`
 
-Defined in: [src/http/types.ts:42](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L42)
+Defined in: [src/http/types.ts:42](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L42)
 
 Intermediate result passed between middleware via res.result.
 
@@ -41,7 +41,7 @@ Intermediate result passed between middleware via res.result.
 
 > **statusCode**: `number`
 
-Defined in: [src/http/types.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L38)
+Defined in: [src/http/types.ts:38](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L38)
 
 ***
 
@@ -49,7 +49,7 @@ Defined in: [src/http/types.ts:38](https://github.com/rapidrest/service-core/blo
 
 > **writableEnded**: `boolean`
 
-Defined in: [src/http/types.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L40)
+Defined in: [src/http/types.ts:40](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L40)
 
 ## Methods
 
@@ -57,7 +57,7 @@ Defined in: [src/http/types.ts:40](https://github.com/rapidrest/service-core/blo
 
 > **end**(`data?`): `void`
 
-Defined in: [src/http/types.ts:48](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L48)
+Defined in: [src/http/types.ts:48](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L48)
 
 #### Parameters
 
@@ -75,7 +75,7 @@ Defined in: [src/http/types.ts:48](https://github.com/rapidrest/service-core/blo
 
 > **getHeader**(`key`): `string` \| `undefined`
 
-Defined in: [src/http/types.ts:45](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L45)
+Defined in: [src/http/types.ts:45](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L45)
 
 #### Parameters
 
@@ -93,7 +93,7 @@ Defined in: [src/http/types.ts:45](https://github.com/rapidrest/service-core/blo
 
 > **json**(`data`): `void`
 
-Defined in: [src/http/types.ts:46](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L46)
+Defined in: [src/http/types.ts:46](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L46)
 
 #### Parameters
 
@@ -111,7 +111,7 @@ Defined in: [src/http/types.ts:46](https://github.com/rapidrest/service-core/blo
 
 > **send**(`data?`): `void`
 
-Defined in: [src/http/types.ts:47](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L47)
+Defined in: [src/http/types.ts:47](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L47)
 
 #### Parameters
 
@@ -129,7 +129,7 @@ Defined in: [src/http/types.ts:47](https://github.com/rapidrest/service-core/blo
 
 > **setHeader**(`key`, `value`): `this`
 
-Defined in: [src/http/types.ts:44](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L44)
+Defined in: [src/http/types.ts:44](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L44)
 
 #### Parameters
 
@@ -151,7 +151,7 @@ Defined in: [src/http/types.ts:44](https://github.com/rapidrest/service-core/blo
 
 > **status**(`code`): `this`
 
-Defined in: [src/http/types.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L43)
+Defined in: [src/http/types.ts:43](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/types.ts#L43)
 
 #### Parameters