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

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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L10)
+Defined in: [src/auth/AuthStrategy.ts:10](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/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.
 
@@ -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/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.
 
@@ -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/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.
 
@@ -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/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/AuthStrategy.md

@@ -6,7 +6,7 @@
 
 # Interface: AuthStrategy
 
-Defined in: [src/auth/AuthStrategy.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L24)
+Defined in: [src/auth/AuthStrategy.ts:24](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L26)
+Defined in: [src/auth/AuthStrategy.ts:26](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthStrategy.ts#L26)
 
 The unique name of the strategy used to register with the `AuthMiddleware`.
 
@@ -24,25 +24,25 @@ The unique name of the strategy used to register with the `AuthMiddleware`.
 
 ### authenticate()
 
-> **authenticate**(`req`, `res?`, `required?`): [`AuthResult`](AuthResult.md) \| `Promise`\<[`AuthResult`](AuthResult.md)\> \| `undefined`
+> **authenticate**(`req`, `res?`, `required?`): `Promise`\<[`AuthResult`](AuthResult.md) \| `undefined`\>
 
-Defined in: [src/auth/AuthStrategy.ts:37](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L37)
+Defined in: [src/auth/AuthStrategy.ts:37](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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`
+Attempts to perform authentication with the given request data. If authentication was successful, returns an
+`AuthResult` containing the authentication details. If authentication fails and `required` is set to `true`
 throws an error, otherwise returns `undefined`.
 
 #### Parameters
 
 ##### req
 
-`HttpRequest`
+[`HttpRequest`](HttpRequest.md)
 
 The request containing data to attempt authentication with.
 
 ##### res?
 
-`HttpResponse`
+[`HttpResponse`](HttpResponse.md)
 
 The response to use when writing back directly to the client.
 
@@ -54,4 +54,42 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
 
 #### Returns
 
-[`AuthResult`](AuthResult.md) \| `Promise`\<[`AuthResult`](AuthResult.md)\> \| `undefined`
+`Promise`\<[`AuthResult`](AuthResult.md) \| `undefined`\>
+
+***
+
+### authenticateSync()
+
+> **authenticateSync**(`req`, `res?`, `required?`): [`AuthResult`](AuthResult.md) \| `undefined`
+
+Defined in: [src/auth/AuthStrategy.ts:50](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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`
+throws an error, otherwise returns `undefined`.
+
+This is the synchronous version of `authenticate` that performs blocking based authentication.
+
+#### Parameters
+
+##### req
+
+[`HttpRequest`](HttpRequest.md)
+
+The request containing data to attempt authentication with.
+
+##### res?
+
+[`HttpResponse`](HttpResponse.md)
+
+The response to use when writing back directly to the client.
+
+##### required?
+
+`boolean`
+
+Set to `true` to if authentication is required to pass, otherwise set to `false`.
+
+#### Returns
+
+[`AuthResult`](AuthResult.md) \| `undefined`

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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L35)
+Defined in: [src/routes/ModelRoute.ts:35](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L36)
+Defined in: [src/routes/ModelRoute.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/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.
 
@@ -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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L38)
+Defined in: [src/routes/ModelRoute.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/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.
 
@@ -68,9 +68,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.
 
@@ -82,9 +82,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.
 
@@ -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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L40)
+Defined in: [src/routes/ModelRoute.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/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/DeleteRequestOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: DeleteRequestOptions
 
-Defined in: [src/routes/ModelRoute.ts:46](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L46)
+Defined in: [src/routes/ModelRoute.ts:46](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/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.
 
@@ -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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L48)
+Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L50)
+Defined in: [src/routes/ModelRoute.ts:50](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L52)
+Defined in: [src/routes/ModelRoute.ts:52](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/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.
 
@@ -84,9 +84,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.
 
@@ -98,9 +98,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.
 
@@ -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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L54)
+Defined in: [src/routes/ModelRoute.ts:54](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/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.
 
@@ -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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L56)
+Defined in: [src/routes/ModelRoute.ts:56](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L62)
+Defined in: [src/routes/ModelRoute.ts:62](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/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` **params?**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:64](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L64)
+Defined in: [src/routes/ModelRoute.ts:64](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/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.
 
 > **query**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:66](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L66)
+Defined in: [src/routes/ModelRoute.ts:66](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/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.
 
@@ -80,9 +80,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.
 
@@ -94,9 +94,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.
 
@@ -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/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.
 
@@ -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/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/HttpRequest.md

@@ -0,0 +1,147 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / HttpRequest
+
+# Interface: HttpRequest
+
+Defined in: [src/http/types.ts:10](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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
+underlying HTTP server changes.
+
+## Extended by
+
+- [`RequestWS`](RequestWS.md)
+
+## Indexable
+
+> \[`key`: `string`\]: `any`
+
+Allow arbitrary per-request properties (e.g. req.websocket, req.wsHandled).
+
+## Properties
+
+### authPayload?
+
+> `optional` **authPayload?**: `any`
+
+Defined in: [src/http/types.ts:26](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L26)
+
+Full decoded JWT payload, set by JWT auth middleware.
+
+***
+
+### authToken?
+
+> `optional` **authToken?**: `string`
+
+Defined in: [src/http/types.ts:28](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L28)
+
+Raw JWT token string, set by JWT auth middleware.
+
+***
+
+### body
+
+> **body**: `any`
+
+Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L17)
+
+***
+
+### cookies
+
+> **cookies**: `Record`\<`string`, `string`\>
+
+Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L19)
+
+***
+
+### headers
+
+> **headers**: `Record`\<`string`, `string` \| `string`[] \| `undefined`\>
+
+Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L14)
+
+***
+
+### method
+
+> **method**: `string`
+
+Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L11)
+
+***
+
+### params
+
+> **params**: `Record`\<`string`, `string`\>
+
+Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L15)
+
+***
+
+### path
+
+> **path**: `string`
+
+Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L12)
+
+***
+
+### query
+
+> **query**: `Record`\<`string`, `string` \| `string`[]\>
+
+Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L16)
+
+***
+
+### rawBody?
+
+> `optional` **rawBody?**: `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L18)
+
+***
+
+### signedCookies
+
+> **signedCookies**: `Record`\<`string`, `string`\>
+
+Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L20)
+
+***
+
+### socket
+
+> **socket**: `object`
+
+Defined in: [src/http/types.ts:22](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L22)
+
+Minimal socket interface; populated with remote address for IP extraction.
+
+#### remoteAddress?
+
+> `optional` **remoteAddress?**: `string`
+
+***
+
+### url
+
+> **url**: `string`
+
+Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L13)
+
+***
+
+### user?
+
+> `optional` **user?**: `any`
+
+Defined in: [src/http/types.ts:24](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L24)
+
+Set by JWT auth middleware after successful token verification.