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

package/docs/reference/enumerations/ACLAction.md

@@ -6,7 +6,7 @@
 
 # Enumeration: ACLAction
 
-Defined in: [src/security/AccessControlList.ts:10](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L10)
+Defined in: [src/security/AccessControlList.ts:10](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L10)
 
 Describes the various permission actions that can be performed against an entity.
 
@@ -20,7 +20,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **CREATE**: `"CREATE"`
 
-Defined in: [src/security/AccessControlList.ts:11](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L11)
+Defined in: [src/security/AccessControlList.ts:11](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L11)
 
 ***
 
@@ -28,7 +28,7 @@ Defined in: [src/security/AccessControlList.ts:11](https://github.com/rapidrest/
 
 > **DELETE**: `"DELETE"`
 
-Defined in: [src/security/AccessControlList.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L12)
+Defined in: [src/security/AccessControlList.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L12)
 
 ***
 
@@ -36,7 +36,7 @@ Defined in: [src/security/AccessControlList.ts:12](https://github.com/rapidrest/
 
 > **FULL**: `"FULL"`
 
-Defined in: [src/security/AccessControlList.ts:13](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L13)
+Defined in: [src/security/AccessControlList.ts:13](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L13)
 
 ***
 
@@ -44,7 +44,7 @@ Defined in: [src/security/AccessControlList.ts:13](https://github.com/rapidrest/
 
 > **READ**: `"READ"`
 
-Defined in: [src/security/AccessControlList.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L14)
+Defined in: [src/security/AccessControlList.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L14)
 
 ***
 
@@ -52,7 +52,7 @@ Defined in: [src/security/AccessControlList.ts:14](https://github.com/rapidrest/
 
 > **SPECIAL**: `"SPECIAL"`
 
-Defined in: [src/security/AccessControlList.ts:15](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L15)
+Defined in: [src/security/AccessControlList.ts:15](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L15)
 
 ***
 
@@ -60,4 +60,4 @@ Defined in: [src/security/AccessControlList.ts:15](https://github.com/rapidrest/
 
 > **UPDATE**: `"UPDATE"`
 
-Defined in: [src/security/AccessControlList.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L16)
+Defined in: [src/security/AccessControlList.ts:16](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L16)

package/docs/reference/enumerations/ApiErrorMessages.md

@@ -6,7 +6,7 @@
 
 # Enumeration: ApiErrorMessages
 
-Defined in: [src/ApiErrors.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L24)
+Defined in: [src/ApiErrors.ts:24](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L24)
 
 Defines the default message of all common API errors.
 
@@ -16,7 +16,7 @@ Defines the default message of all common API errors.
 
 > **AUTH\_FAILED**: `"Invalid or missing authentication token."`
 
-Defined in: [src/ApiErrors.ts:37](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L37)
+Defined in: [src/ApiErrors.ts:37](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L37)
 
 ***
 
@@ -24,7 +24,7 @@ Defined in: [src/ApiErrors.ts:37](https://github.com/rapidrest/service-core/blob
 
 > **AUTH\_PERMISSION\_FAILURE**: `"User does not have permission to perform this action."`
 
-Defined in: [src/ApiErrors.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L38)
+Defined in: [src/ApiErrors.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L38)
 
 ***
 
@@ -32,7 +32,7 @@ Defined in: [src/ApiErrors.ts:38](https://github.com/rapidrest/service-core/blob
 
 > **AUTH\_REQUIRED**: `"Authorization is required to access this resource."`
 
-Defined in: [src/ApiErrors.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L36)
+Defined in: [src/ApiErrors.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L36)
 
 ***
 
@@ -40,7 +40,7 @@ Defined in: [src/ApiErrors.ts:36](https://github.com/rapidrest/service-core/blob
 
 > **BULK\_CREATE\_FAILURE**: `"Failed to create one or more objects."`
 
-Defined in: [src/ApiErrors.ts:34](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L34)
+Defined in: [src/ApiErrors.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L34)
 
 ***
 
@@ -48,7 +48,7 @@ Defined in: [src/ApiErrors.ts:34](https://github.com/rapidrest/service-core/blob
 
 > **BULK\_UPDATE\_FAILURE**: `"Failed to update one or more objects."`
 
-Defined in: [src/ApiErrors.ts:35](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L35)
+Defined in: [src/ApiErrors.ts:35](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L35)
 
 ***
 
@@ -56,7 +56,7 @@ Defined in: [src/ApiErrors.ts:35](https://github.com/rapidrest/service-core/blob
 
 > **IDENTIFIER\_EXISTS**: `"A resource with that identifier already exists."`
 
-Defined in: [src/ApiErrors.ts:29](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L29)
+Defined in: [src/ApiErrors.ts:29](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L29)
 
 ***
 
@@ -64,7 +64,7 @@ Defined in: [src/ApiErrors.ts:29](https://github.com/rapidrest/service-core/blob
 
 > **INTERNAL\_ERROR**: `"An internal error has occurred. Please contact the adminstrator."`
 
-Defined in: [src/ApiErrors.ts:26](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L26)
+Defined in: [src/ApiErrors.ts:26](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L26)
 
 ***
 
@@ -72,7 +72,7 @@ Defined in: [src/ApiErrors.ts:26](https://github.com/rapidrest/service-core/blob
 
 > **INVALID\_OBJECT\_VERSION**: `"Invalid object version. Do you have the latest version?"`
 
-Defined in: [src/ApiErrors.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L30)
+Defined in: [src/ApiErrors.ts:30](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L30)
 
 ***
 
@@ -80,7 +80,7 @@ Defined in: [src/ApiErrors.ts:30](https://github.com/rapidrest/service-core/blob
 
 > **INVALID\_REQUEST**: `"Invalid message or request."`
 
-Defined in: [src/ApiErrors.ts:27](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L27)
+Defined in: [src/ApiErrors.ts:27](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L27)
 
 ***
 
@@ -88,7 +88,7 @@ Defined in: [src/ApiErrors.ts:27](https://github.com/rapidrest/service-core/blob
 
 > **NOT\_FOUND**: `"No resource could be found with the specified identifier."`
 
-Defined in: [src/ApiErrors.ts:28](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L28)
+Defined in: [src/ApiErrors.ts:28](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L28)
 
 ***
 
@@ -96,7 +96,7 @@ Defined in: [src/ApiErrors.ts:28](https://github.com/rapidrest/service-core/blob
 
 > **OBJECT\_ID\_MISMATCH**: `"The object provided does not match the identifier given."`
 
-Defined in: [src/ApiErrors.ts:31](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L31)
+Defined in: [src/ApiErrors.ts:31](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L31)
 
 ***
 
@@ -104,7 +104,7 @@ Defined in: [src/ApiErrors.ts:31](https://github.com/rapidrest/service-core/blob
 
 > **SEARCH\_INVALID\_ME\_REFERENCE**: `` "Use of the `me` reference requires authentication." ``
 
-Defined in: [src/ApiErrors.ts:33](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L33)
+Defined in: [src/ApiErrors.ts:33](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L33)
 
 ***
 
@@ -112,7 +112,7 @@ Defined in: [src/ApiErrors.ts:33](https://github.com/rapidrest/service-core/blob
 
 > **SEARCH\_INVALID\_RANGE**: `"Invalid range value: '{{value}}'. Expected 2 arguments, got {{length}}"`
 
-Defined in: [src/ApiErrors.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L32)
+Defined in: [src/ApiErrors.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L32)
 
 ***
 
@@ -120,4 +120,4 @@ Defined in: [src/ApiErrors.ts:32](https://github.com/rapidrest/service-core/blob
 
 > **UNKNOWN**: `"An unknown error has occurred. Please try again."`
 
-Defined in: [src/ApiErrors.ts:25](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L25)
+Defined in: [src/ApiErrors.ts:25](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L25)

package/docs/reference/enumerations/ApiErrors.md

@@ -6,7 +6,7 @@
 
 # Enumeration: ApiErrors
 
-Defined in: [src/ApiErrors.ts:4](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L4)
+Defined in: [src/ApiErrors.ts:4](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L4)
 
 Defines the unique codes for all common API errors.
 
@@ -16,7 +16,7 @@ Defines the unique codes for all common API errors.
 
 > **AUTH\_FAILED**: `"api-101"`
 
-Defined in: [src/ApiErrors.ts:17](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L17)
+Defined in: [src/ApiErrors.ts:17](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L17)
 
 ***
 
@@ -24,7 +24,7 @@ Defined in: [src/ApiErrors.ts:17](https://github.com/rapidrest/service-core/blob
 
 > **AUTH\_PERMISSION\_FAILURE**: `"api-102"`
 
-Defined in: [src/ApiErrors.ts:18](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L18)
+Defined in: [src/ApiErrors.ts:18](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L18)
 
 ***
 
@@ -32,7 +32,7 @@ Defined in: [src/ApiErrors.ts:18](https://github.com/rapidrest/service-core/blob
 
 > **AUTH\_REQUIRED**: `"api-100"`
 
-Defined in: [src/ApiErrors.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L16)
+Defined in: [src/ApiErrors.ts:16](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L16)
 
 ***
 
@@ -40,7 +40,7 @@ Defined in: [src/ApiErrors.ts:16](https://github.com/rapidrest/service-core/blob
 
 > **BULK\_CREATE\_FAILURE**: `"api-021"`
 
-Defined in: [src/ApiErrors.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L14)
+Defined in: [src/ApiErrors.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L14)
 
 ***
 
@@ -48,7 +48,7 @@ Defined in: [src/ApiErrors.ts:14](https://github.com/rapidrest/service-core/blob
 
 > **BULK\_UPDATE\_FAILURE**: `"api-022"`
 
-Defined in: [src/ApiErrors.ts:15](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L15)
+Defined in: [src/ApiErrors.ts:15](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L15)
 
 ***
 
@@ -56,7 +56,7 @@ Defined in: [src/ApiErrors.ts:15](https://github.com/rapidrest/service-core/blob
 
 > **IDENTIFIER\_EXISTS**: `"api-011"`
 
-Defined in: [src/ApiErrors.ts:9](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L9)
+Defined in: [src/ApiErrors.ts:9](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L9)
 
 ***
 
@@ -64,7 +64,7 @@ Defined in: [src/ApiErrors.ts:9](https://github.com/rapidrest/service-core/blob/
 
 > **INTERNAL\_ERROR**: `"api-002"`
 
-Defined in: [src/ApiErrors.ts:6](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L6)
+Defined in: [src/ApiErrors.ts:6](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L6)
 
 ***
 
@@ -72,7 +72,7 @@ Defined in: [src/ApiErrors.ts:6](https://github.com/rapidrest/service-core/blob/
 
 > **INVALID\_OBJECT\_VERSION**: `"api-012"`
 
-Defined in: [src/ApiErrors.ts:10](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L10)
+Defined in: [src/ApiErrors.ts:10](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L10)
 
 ***
 
@@ -80,7 +80,7 @@ Defined in: [src/ApiErrors.ts:10](https://github.com/rapidrest/service-core/blob
 
 > **INVALID\_REQUEST**: `"api-003"`
 
-Defined in: [src/ApiErrors.ts:7](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L7)
+Defined in: [src/ApiErrors.ts:7](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L7)
 
 ***
 
@@ -88,7 +88,7 @@ Defined in: [src/ApiErrors.ts:7](https://github.com/rapidrest/service-core/blob/
 
 > **NOT\_FOUND**: `"api-010"`
 
-Defined in: [src/ApiErrors.ts:8](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L8)
+Defined in: [src/ApiErrors.ts:8](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L8)
 
 ***
 
@@ -96,7 +96,7 @@ Defined in: [src/ApiErrors.ts:8](https://github.com/rapidrest/service-core/blob/
 
 > **OBJECT\_ID\_MISMATCH**: `"api-013"`
 
-Defined in: [src/ApiErrors.ts:11](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L11)
+Defined in: [src/ApiErrors.ts:11](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L11)
 
 ***
 
@@ -104,7 +104,7 @@ Defined in: [src/ApiErrors.ts:11](https://github.com/rapidrest/service-core/blob
 
 > **SEARCH\_INVALID\_ME\_REFERENCE**: `"api-015"`
 
-Defined in: [src/ApiErrors.ts:13](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L13)
+Defined in: [src/ApiErrors.ts:13](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L13)
 
 ***
 
@@ -112,7 +112,7 @@ Defined in: [src/ApiErrors.ts:13](https://github.com/rapidrest/service-core/blob
 
 > **SEARCH\_INVALID\_RANGE**: `"api-014"`
 
-Defined in: [src/ApiErrors.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L12)
+Defined in: [src/ApiErrors.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L12)
 
 ***
 
@@ -120,4 +120,4 @@ Defined in: [src/ApiErrors.ts:12](https://github.com/rapidrest/service-core/blob
 
 > **UNKNOWN**: `"api-001"`
 
-Defined in: [src/ApiErrors.ts:5](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L5)
+Defined in: [src/ApiErrors.ts:5](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ApiErrors.ts#L5)

package/docs/reference/functions/createWebSocketStream.md

@@ -0,0 +1,27 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / createWebSocketStream
+
+# Function: createWebSocketStream()
+
+> **createWebSocketStream**(`shim`): `Duplex`
+
+Defined in: [src/http/WebSocket.ts:85](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/WebSocket.ts#L85)
+
+Creates a Node.js `Duplex` stream from a `UWSWebSocketShim`, compatible with the
+`createWebSocketStream` API from the `ws` library.
+
+Incoming WebSocket messages are pushed as readable data; writes to the stream are
+forwarded as WebSocket messages.
+
+## Parameters
+
+### shim
+
+[`UWSWebSocketShim`](../classes/UWSWebSocketShim.md)
+
+## Returns
+
+`Duplex`

package/docs/reference/functions/isSqlDataSource.md

@@ -8,7 +8,7 @@
 
 > **isSqlDataSource**(`conn`): `boolean`
 
-Defined in: [src/database/ConnectionKinds.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/database/ConnectionKinds.ts#L12)
+Defined in: [src/database/ConnectionKinds.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/ConnectionKinds.ts#L12)
 
 Determines whether the given connection object is a TypeORM `DataSource` for a SQL database. This check is
 performed without importing the optional `typeorm` package by duck-typing the connection object.

package/docs/reference/functions/readBody.md

@@ -0,0 +1,29 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / readBody
+
+# Function: readBody()
+
+> **readBody**(`uwsRes`, `req`): `Promise`\<`void`\>
+
+Defined in: [src/http/Adapters.ts:224](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L224)
+
+Reads the full request body from a uWS response object as a Buffer.
+Body parsing (JSON / URL-encoded) is applied based on content-type and the result
+is cached on `req.body` / `req.rawBody`.
+
+## Parameters
+
+### uwsRes
+
+`HttpResponse`
+
+### req
+
+[`UWSRequest`](../classes/UWSRequest.md)
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/resolveCollectionName.md

@@ -8,7 +8,7 @@
 
 > **resolveCollectionName**(`clazz`): `string`
 
-Defined in: [src/database/NamingUtils.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/database/NamingUtils.ts#L38)
+Defined in: [src/database/NamingUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/NamingUtils.ts#L38)
 
 Resolves the name of the database collection (or table) that records of the given model class are stored in.
 

package/docs/reference/functions/runChain.md

@@ -0,0 +1,40 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / runChain
+
+# Function: runChain()
+
+> **runChain**(`handlers`, `req`, `res`): `Promise`\<`void`\>
+
+Defined in: [src/http/Router.ts:43](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L43)
+
+Runs an ordered array of middleware handlers sequentially, Express-style.
+Supports both 3-param `(req, res, next)` handlers and 4-param `(err, req, res, next)`
+error handlers. On error, execution skips to the next error handler.
+
+Each handler is awaited via a Promise that resolves when next() is called, not when
+the handler's return value resolves. This correctly handles: (1) sync handlers that
+call next() synchronously, (2) async handlers that return next() or await before
+calling it, and (3) sync handlers that schedule next() via callbacks such as
+setTimeout or socket.once. The chain terminates early when a handler ends the
+response without calling next().
+
+## Parameters
+
+### handlers
+
+[`RequestHandler`](../type-aliases/RequestHandler.md)[]
+
+### req
+
+[`HttpRequest`](../interfaces/HttpRequest.md)
+
+### res
+
+[`HttpResponse`](../interfaces/HttpResponse.md)
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/snakeCase.md

@@ -8,7 +8,7 @@
 
 > **snakeCase**(`str`): `string`
 
-Defined in: [src/database/NamingUtils.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/database/NamingUtils.ts#L14)
+Defined in: [src/database/NamingUtils.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/NamingUtils.ts#L14)
 
 Converts a string into snake_case.
 

package/docs/reference/globals.md

@@ -33,6 +33,7 @@
 - [BulkError](classes/BulkError.md)
 - [ConnectionManager](classes/ConnectionManager.md)
 - [EventListenerManager](classes/EventListenerManager.md)
+- [HttpRouter](classes/HttpRouter.md)
 - [JWTStrategy](classes/JWTStrategy.md)
 - [JWTStrategyOptions](classes/JWTStrategyOptions.md)
 - [MetricsRoute](classes/MetricsRoute.md)
@@ -56,6 +57,9 @@
 - [SimpleMongoEntity](classes/SimpleMongoEntity.md)
 - [StatusExtraData](classes/StatusExtraData.md)
 - [StatusRoute](classes/StatusRoute.md)
+- [UWSRequest](classes/UWSRequest.md)
+- [UWSResponse](classes/UWSResponse.md)
+- [UWSWebSocketShim](classes/UWSWebSocketShim.md)
 
 ## Interfaces
 
@@ -66,6 +70,8 @@
 - [CreateRequestOptions](interfaces/CreateRequestOptions.md)
 - [DeleteRequestOptions](interfaces/DeleteRequestOptions.md)
 - [FindRequestOptions](interfaces/FindRequestOptions.md)
+- [HttpRequest](interfaces/HttpRequest.md)
+- [HttpResponse](interfaces/HttpResponse.md)
 - [JWTAuthResult](interfaces/JWTAuthResult.md)
 - [RepoCreateOptions](interfaces/RepoCreateOptions.md)
 - [RepoDeleteOptions](interfaces/RepoDeleteOptions.md)
@@ -73,19 +79,28 @@
 - [RepoOperationOptions](interfaces/RepoOperationOptions.md)
 - [RepoUpdateOptions](interfaces/RepoUpdateOptions.md)
 - [RequestOptions](interfaces/RequestOptions.md)
+- [RequestWS](interfaces/RequestWS.md)
 - [TruncateRequestOptions](interfaces/TruncateRequestOptions.md)
 - [UpdateRequestOptions](interfaces/UpdateRequestOptions.md)
 
 ## Type Aliases
 
+- [ErrorHandler](type-aliases/ErrorHandler.md)
+- [NextFunction](type-aliases/NextFunction.md)
 - [OneOrMany](type-aliases/OneOrMany.md)
 - [OneOrNull](type-aliases/OneOrNull.md)
 - [PartialBaseEntity](type-aliases/PartialBaseEntity.md)
 - [PartialSimpleEntity](type-aliases/PartialSimpleEntity.md)
+- [RequestHandler](type-aliases/RequestHandler.md)
 - [UpdateObject](type-aliases/UpdateObject.md)
+- [WsUpgradeAuth](type-aliases/WsUpgradeAuth.md)
+- [WsUpgradeAuthResult](type-aliases/WsUpgradeAuthResult.md)
 
 ## Functions
 
+- [createWebSocketStream](functions/createWebSocketStream.md)
 - [isSqlDataSource](functions/isSqlDataSource.md)
+- [readBody](functions/readBody.md)
 - [resolveCollectionName](functions/resolveCollectionName.md)
+- [runChain](functions/runChain.md)
 - [snakeCase](functions/snakeCase.md)

package/docs/reference/interfaces/ACLRecord.md

@@ -6,7 +6,7 @@
 
 # Interface: ACLRecord
 
-Defined in: [src/security/AccessControlList.ts:33](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L33)
+Defined in: [src/security/AccessControlList.ts:33](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L33)
 
 The `ACLRecord` interface describes a single permissions entry in an `AccessControlList` that grants or denies
 a set of permissions to a single user or role.
@@ -29,7 +29,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **create**: `boolean` \| `null`
 
-Defined in: [src/security/AccessControlList.ts:42](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L42)
+Defined in: [src/security/AccessControlList.ts:42](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L42)
 
 Indicates that the user or role has permission to create new records of the entity.
 
@@ -39,7 +39,7 @@ Indicates that the user or role has permission to create new records of the enti
 
 > **delete**: `boolean` \| `null`
 
-Defined in: [src/security/AccessControlList.ts:57](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L57)
+Defined in: [src/security/AccessControlList.ts:57](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L57)
 
 Indicates that the user or role has permission to delete existing records of the entity.
 
@@ -49,7 +49,7 @@ Indicates that the user or role has permission to delete existing records of the
 
 > **full**: `boolean` \| `null`
 
-Defined in: [src/security/AccessControlList.ts:69](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L69)
+Defined in: [src/security/AccessControlList.ts:69](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L69)
 
 Indicates that the user or role has total control over records of the entity. This supersedes all of the above
 permissions.
@@ -60,7 +60,7 @@ permissions.
 
 > **read**: `boolean` \| `null`
 
-Defined in: [src/security/AccessControlList.ts:47](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L47)
+Defined in: [src/security/AccessControlList.ts:47](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L47)
 
 Indicates that the user or role has permission to read records of the entity.
 
@@ -70,7 +70,7 @@ Indicates that the user or role has permission to read records of the entity.
 
 > **special**: `boolean` \| `null`
 
-Defined in: [src/security/AccessControlList.ts:63](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L63)
+Defined in: [src/security/AccessControlList.ts:63](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L63)
 
 Indicates that the user or role has special permission over records of the entity. The exact meaning of this
 may vary by service.
@@ -81,7 +81,7 @@ may vary by service.
 
 > **update**: `boolean` \| `null`
 
-Defined in: [src/security/AccessControlList.ts:52](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L52)
+Defined in: [src/security/AccessControlList.ts:52](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L52)
 
 Indicates that the user or role has permission to modify existing records of the entity.
 
@@ -91,6 +91,6 @@ Indicates that the user or role has permission to modify existing records of the
 
 > **userOrRoleId**: `string`
 
-Defined in: [src/security/AccessControlList.ts:37](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L37)
+Defined in: [src/security/AccessControlList.ts:37](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L37)
 
 The unique identifier of the user or role that the record belongs to.

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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L97)
+Defined in: [src/security/AccessControlList.ts:97](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L106)
+Defined in: [src/security/AccessControlList.ts:106](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L112)
+Defined in: [src/security/AccessControlList.ts:112](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L117)
+Defined in: [src/security/AccessControlList.ts:117](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L101)
+Defined in: [src/security/AccessControlList.ts:101](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/AccessControlList.ts#L101)
 
 The universally unique identifier (`uuid`) of the entity that the access control list belongs to.