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

package/docs/reference/interfaces/RequestWS.md

@@ -0,0 +1,225 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / RequestWS
+
+# Interface: RequestWS
+
+Defined in: [src/http/WebSocket.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/WebSocket.ts#L14)
+
+HTTP request type for handling WebSocket upgrade requests.
+Extends `HttpRequest` with WebSocket-specific properties set by the router
+after the uWS WebSocket connection is opened.
+
+## Extends
+
+- [`HttpRequest`](HttpRequest.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.
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`authPayload`](HttpRequest.md#authpayload)
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`authToken`](HttpRequest.md#authtoken)
+
+***
+
+### body
+
+> **body**: `any`
+
+Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L17)
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`body`](HttpRequest.md#body)
+
+***
+
+### 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)
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`cookies`](HttpRequest.md#cookies)
+
+***
+
+### 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)
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`headers`](HttpRequest.md#headers)
+
+***
+
+### method
+
+> **method**: `string`
+
+Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L11)
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`method`](HttpRequest.md#method)
+
+***
+
+### 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)
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`params`](HttpRequest.md#params)
+
+***
+
+### path
+
+> **path**: `string`
+
+Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L12)
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`path`](HttpRequest.md#path)
+
+***
+
+### 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)
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`query`](HttpRequest.md#query)
+
+***
+
+### 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)
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`rawBody`](HttpRequest.md#rawbody)
+
+***
+
+### 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)
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`signedCookies`](HttpRequest.md#signedcookies)
+
+***
+
+### 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`
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`socket`](HttpRequest.md#socket)
+
+***
+
+### url
+
+> **url**: `string`
+
+Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L13)
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`url`](HttpRequest.md#url)
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`HttpRequest`](HttpRequest.md).[`user`](HttpRequest.md#user)
+
+***
+
+### websocket
+
+> **websocket**: [`UWSWebSocketShim`](../classes/UWSWebSocketShim.md) \| `undefined`
+
+Defined in: [src/http/WebSocket.ts:18](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/WebSocket.ts#L18)
+
+The uWS WebSocket shim for this connection. Set on `open` after the upgrade.
+
+***
+
+### wsHandled
+
+> **wsHandled**: `boolean`
+
+Defined in: [src/http/WebSocket.ts:25](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/WebSocket.ts#L25)
+
+Indicates that the WebSocket handler has processed this connection and the
+connection should remain open. Set to `true` by `wrapMiddleware` when a
+decorated handler returns successfully.

package/docs/reference/interfaces/TruncateRequestOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: TruncateRequestOptions
 
-Defined in: [src/routes/ModelRoute.ts:72](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L72)
+Defined in: [src/routes/ModelRoute.ts:72](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L72)
 
 The set of options required by truncate request handlers.
 
@@ -20,7 +20,7 @@ The set of options required by truncate 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.
 
 > **params**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:74](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L74)
+Defined in: [src/routes/ModelRoute.ts:74](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L74)
 
 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` **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.
 
@@ -58,7 +58,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).
 
@@ -72,7 +72,7 @@ Set to true to permanently remove the object from the database (if applicable).
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/routes/ModelRoute.ts:76](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L76)
+Defined in: [src/routes/ModelRoute.ts:76](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L76)
 
 An additional list of channel names to send push notifications to.
 
@@ -86,7 +86,7 @@ An additional list of channel names to send push notifications to.
 
 > **query**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:78](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L78)
+Defined in: [src/routes/ModelRoute.ts:78](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L78)
 
 The list of query parameters to use in the search.
 
@@ -96,7 +96,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.
 
@@ -108,9 +108,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.
 
@@ -122,9 +122,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.
 
@@ -138,7 +138,7 @@ The outgoing client response.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/routes/ModelRoute.ts:80](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L80)
+Defined in: [src/routes/ModelRoute.ts:80](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L80)
 
 Set to `true` to not send a push notification.
 
@@ -152,7 +152,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.
 
@@ -166,7 +166,7 @@ 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/UpdateRequestOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: UpdateRequestOptions\<T\>
 
-Defined in: [src/routes/ModelRoute.ts:89](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L89)
+Defined in: [src/routes/ModelRoute.ts:89](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L89)
 
 The set of options required by update request handlers.
 
@@ -26,7 +26,7 @@ The set of options required by update request handlers.
 
 > `optional` **existing?**: `T` \| `null`
 
-Defined in: [src/routes/ModelRoute.ts:91](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L91)
+Defined in: [src/routes/ModelRoute.ts:91](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L91)
 
 The existing object that has already been recently pulled from the datastore.
 
@@ -36,7 +36,7 @@ The existing object that has already been recently pulled from the datastore.
 
 > `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.
 
@@ -50,7 +50,7 @@ Set to `true` to ignore the ACL permissions check.
 
 > `optional` **productUid?**: `string`
 
-Defined in: [src/routes/ModelRoute.ts:93](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L93)
+Defined in: [src/routes/ModelRoute.ts:93](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L93)
 
 The desired product uid of the resource to update.
 
@@ -60,7 +60,7 @@ The desired product uid of the resource to update.
 
 > `optional` **pushChannels?**: `string`[]
 
-Defined in: [src/routes/ModelRoute.ts:95](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L95)
+Defined in: [src/routes/ModelRoute.ts:95](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L95)
 
 An additional list of channel names to send push notifications to.
 
@@ -74,7 +74,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.
 
@@ -86,9 +86,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.
 
@@ -100,9 +100,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.
 
@@ -116,7 +116,7 @@ The outgoing client response.
 
 > `optional` **skipPush?**: `boolean`
 
-Defined in: [src/routes/ModelRoute.ts:97](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L97)
+Defined in: [src/routes/ModelRoute.ts:97](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L97)
 
 Set to `true` to not send a push notification.
 
@@ -130,7 +130,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.
 
@@ -144,6 +144,6 @@ The authenticated user making the request.
 
 > `optional` **version?**: `string` \| `number`
 
-Defined in: [src/routes/ModelRoute.ts:99](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L99)
+Defined in: [src/routes/ModelRoute.ts:99](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L99)
 
 The desired version number of the resource to update.

package/docs/reference/type-aliases/ErrorHandler.md

@@ -0,0 +1,35 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / ErrorHandler
+
+# Type Alias: ErrorHandler
+
+> **ErrorHandler** = (`err`, `req`, `res`, `next`) => `void` \| `Promise`\<`void`\>
+
+Defined in: [src/http/types.ts:60](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L60)
+
+Standard 4-param error-handling middleware function.
+
+## Parameters
+
+### err
+
+`any`
+
+### req
+
+[`HttpRequest`](../interfaces/HttpRequest.md)
+
+### res
+
+[`HttpResponse`](../interfaces/HttpResponse.md)
+
+### next
+
+[`NextFunction`](NextFunction.md)
+
+## Returns
+
+`void` \| `Promise`\<`void`\>

package/docs/reference/type-aliases/NextFunction.md

@@ -0,0 +1,23 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / NextFunction
+
+# Type Alias: NextFunction
+
+> **NextFunction** = (`err?`) => `void`
+
+Defined in: [src/http/types.ts:54](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L54)
+
+Standard Express-style next callback. Pass an error to trigger error handlers.
+
+## Parameters
+
+### err?
+
+`any`
+
+## Returns
+
+`void`

package/docs/reference/type-aliases/OneOrMany.md

@@ -8,7 +8,7 @@
 
 > **OneOrMany**\<`T`\> = `T` \| `T`[]
 
-Defined in: [src/Types.ts:4](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Types.ts#L4)
+Defined in: [src/Types.ts:4](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Types.ts#L4)
 
 Provides an explicit type declaration for `T | T[]`.
 

package/docs/reference/type-aliases/OneOrNull.md

@@ -8,7 +8,7 @@
 
 > **OneOrNull**\<`T`\> = `T` \| `null`
 
-Defined in: [src/Types.ts:9](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Types.ts#L9)
+Defined in: [src/Types.ts:9](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Types.ts#L9)
 
 Provides an explicit type declaration for `T | null`.
 

package/docs/reference/type-aliases/PartialBaseEntity.md

@@ -8,7 +8,7 @@
 
 > **PartialBaseEntity**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\> & `Pick`\<`T`, `"version"`\>
 
-Defined in: [src/models/BaseEntity.ts:68](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L68)
+Defined in: [src/models/BaseEntity.ts:68](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/BaseEntity.ts#L68)
 
 ## Type Parameters
 

package/docs/reference/type-aliases/PartialSimpleEntity.md

@@ -8,7 +8,7 @@
 
 > **PartialSimpleEntity**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\>
 
-Defined in: [src/models/SimpleEntity.ts:33](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L33)
+Defined in: [src/models/SimpleEntity.ts:33](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/SimpleEntity.ts#L33)
 
 ## Type Parameters
 

package/docs/reference/type-aliases/RequestHandler.md

@@ -0,0 +1,31 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / RequestHandler
+
+# Type Alias: RequestHandler
+
+> **RequestHandler** = (`req`, `res`, `next`) => `void` \| `Promise`\<`void`\>
+
+Defined in: [src/http/types.ts:57](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L57)
+
+Standard 3-param middleware function.
+
+## Parameters
+
+### req
+
+[`HttpRequest`](../interfaces/HttpRequest.md)
+
+### res
+
+[`HttpResponse`](../interfaces/HttpResponse.md)
+
+### next
+
+[`NextFunction`](NextFunction.md)
+
+## Returns
+
+`void` \| `Promise`\<`void`\>

package/docs/reference/type-aliases/UpdateObject.md

@@ -8,7 +8,7 @@
 
 > **UpdateObject**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\>
 
-Defined in: [src/routes/ModelRoute.ts:84](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L84)
+Defined in: [src/routes/ModelRoute.ts:84](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L84)
 
 A Partial type for a BaseEntity or SimpleEntity.
 

package/docs/reference/type-aliases/WsUpgradeAuth.md

@@ -0,0 +1,27 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / WsUpgradeAuth
+
+# Type Alias: WsUpgradeAuth
+
+> **WsUpgradeAuth** = (`req`) => [`WsUpgradeAuthResult`](WsUpgradeAuthResult.md)
+
+Defined in: [src/http/Router.ts:142](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L142)
+
+Optional pre-upgrade auth function for WebSocket routes. Called synchronously inside the uWS
+`upgrade` callback — before the WebSocket handshake completes. Returning `{ reject: true }`
+sends an HTTP 401 and skips the upgrade entirely. Returning `{}` falls through to the
+post-upgrade message-based LOGIN flow. Returning `{ user, ... }` pre-authenticates the
+connection so clients that can send an Authorization header skip the LOGIN step.
+
+## Parameters
+
+### req
+
+[`HttpRequest`](../interfaces/HttpRequest.md)
+
+## Returns
+
+[`WsUpgradeAuthResult`](WsUpgradeAuthResult.md)

package/docs/reference/type-aliases/WsUpgradeAuthResult.md

@@ -0,0 +1,47 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / WsUpgradeAuthResult
+
+# Type Alias: WsUpgradeAuthResult
+
+> **WsUpgradeAuthResult** = `object`
+
+Defined in: [src/http/Router.ts:127](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L127)
+
+Result returned by a pre-upgrade WebSocket auth function.
+
+## Properties
+
+### authPayload?
+
+> `optional` **authPayload?**: `any`
+
+Defined in: [src/http/Router.ts:129](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L129)
+
+***
+
+### authToken?
+
+> `optional` **authToken?**: `string`
+
+Defined in: [src/http/Router.ts:130](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L130)
+
+***
+
+### reject?
+
+> `optional` **reject?**: `boolean`
+
+Defined in: [src/http/Router.ts:132](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L132)
+
+Set to `true` to reject the connection with HTTP 401 before the WebSocket handshake.
+
+***
+
+### user?
+
+> `optional` **user?**: `any`
+
+Defined in: [src/http/Router.ts:128](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L128)