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

package/docs/reference/classes/UWSResponse.md

@@ -6,12 +6,12 @@
 
 # Class: UWSResponse
 
-Defined in: [src/http/Adapters.ts:109](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L109)
+Defined in: [src/http/Adapters.ts:109](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L109)
 
 Adapts a uWS `HttpResponse` to the framework-agnostic `HttpResponse` interface.
 
-Buffers headers and status code until the first write. Tracks abort state to safely
-skip writes on aborted connections. All uWS writes are wrapped in `res.cork()` for
+Buffers headers and status code until the first write. Tracks abort state to safely
+skip writes on aborted connections. All uWS writes are wrapped in `res.cork()` for
 optimal performance.
 
 ## Implements
@@ -30,7 +30,7 @@ Allow arbitrary per-response properties.
 
 > **new UWSResponse**(`uwsRes`): `UWSResponse`
 
-Defined in: [src/http/Adapters.ts:123](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L123)
+Defined in: [src/http/Adapters.ts:123](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L123)
 
 #### Parameters
 
@@ -48,7 +48,7 @@ Defined in: [src/http/Adapters.ts:123](https://github.com/rapidrest/service-core
 
 > **isHead**: `boolean` = `false`
 
-Defined in: [src/http/Adapters.ts:117](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L117)
+Defined in: [src/http/Adapters.ts:117](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L117)
 
 Set to true for HEAD requests — body bytes must not be sent.
 
@@ -58,7 +58,7 @@ Set to true for HEAD requests — body bytes must not be sent.
 
 > `optional` **result?**: `any`
 
-Defined in: [src/http/Adapters.ts:119](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L119)
+Defined in: [src/http/Adapters.ts:119](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L119)
 
 Intermediate result passed between middleware.
 
@@ -74,7 +74,7 @@ Intermediate result passed between middleware.
 
 > **get** **headersSent**(): `boolean`
 
-Defined in: [src/http/Adapters.ts:135](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L135)
+Defined in: [src/http/Adapters.ts:135](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L135)
 
 ##### Returns
 
@@ -92,7 +92,7 @@ Defined in: [src/http/Adapters.ts:135](https://github.com/rapidrest/service-core
 
 > **get** **statusCode**(): `number`
 
-Defined in: [src/http/Adapters.ts:131](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L131)
+Defined in: [src/http/Adapters.ts:131](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L131)
 
 ##### Returns
 
@@ -110,7 +110,7 @@ Defined in: [src/http/Adapters.ts:131](https://github.com/rapidrest/service-core
 
 > **get** **writableEnded**(): `boolean`
 
-Defined in: [src/http/Adapters.ts:139](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L139)
+Defined in: [src/http/Adapters.ts:139](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L139)
 
 ##### Returns
 
@@ -126,7 +126,7 @@ Defined in: [src/http/Adapters.ts:139](https://github.com/rapidrest/service-core
 
 > **end**(`data?`): `void`
 
-Defined in: [src/http/Adapters.ts:172](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L172)
+Defined in: [src/http/Adapters.ts:172](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L172)
 
 #### Parameters
 
@@ -148,7 +148,7 @@ Defined in: [src/http/Adapters.ts:172](https://github.com/rapidrest/service-core
 
 > **getHeader**(`key`): `string` \| `undefined`
 
-Defined in: [src/http/Adapters.ts:153](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L153)
+Defined in: [src/http/Adapters.ts:153](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L153)
 
 #### Parameters
 
@@ -170,7 +170,7 @@ Defined in: [src/http/Adapters.ts:153](https://github.com/rapidrest/service-core
 
 > **json**(`data`): `void`
 
-Defined in: [src/http/Adapters.ts:157](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L157)
+Defined in: [src/http/Adapters.ts:157](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L157)
 
 #### Parameters
 
@@ -192,7 +192,7 @@ Defined in: [src/http/Adapters.ts:157](https://github.com/rapidrest/service-core
 
 > **send**(`data?`): `void`
 
-Defined in: [src/http/Adapters.ts:162](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L162)
+Defined in: [src/http/Adapters.ts:162](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L162)
 
 #### Parameters
 
@@ -214,7 +214,7 @@ Defined in: [src/http/Adapters.ts:162](https://github.com/rapidrest/service-core
 
 > **setHeader**(`key`, `value`): `this`
 
-Defined in: [src/http/Adapters.ts:148](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L148)
+Defined in: [src/http/Adapters.ts:148](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L148)
 
 #### Parameters
 
@@ -240,7 +240,7 @@ Defined in: [src/http/Adapters.ts:148](https://github.com/rapidrest/service-core
 
 > **status**(`code`): `this`
 
-Defined in: [src/http/Adapters.ts:143](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L143)
+Defined in: [src/http/Adapters.ts:143](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L143)
 
 #### Parameters
 

package/docs/reference/classes/UWSWebSocketShim.md

@@ -6,7 +6,7 @@
 
 # Class: UWSWebSocketShim
 
-Defined in: [src/http/WebSocket.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L40)
+Defined in: [src/http/WebSocket.ts:40](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/WebSocket.ts#L40)
 
 Wraps a uWS `WebSocket` handle and exposes an EventEmitter-based API compatible
 with what route handlers (e.g. `AdminRoute`) expect.
@@ -29,7 +29,7 @@ behavior callbacks can call `shim.emit(...)`.
 
 > **new UWSWebSocketShim**(`ws`): `UWSWebSocketShim`
 
-Defined in: [src/http/WebSocket.ts:44](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L44)
+Defined in: [src/http/WebSocket.ts:44](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/WebSocket.ts#L44)
 
 #### Parameters
 
@@ -51,7 +51,7 @@ Defined in: [src/http/WebSocket.ts:44](https://github.com/rapidrest/service-core
 
 > **readyState**: `number` = `1`
 
-Defined in: [src/http/WebSocket.ts:42](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L42)
+Defined in: [src/http/WebSocket.ts:42](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/WebSocket.ts#L42)
 
 ## Methods
 
@@ -156,7 +156,7 @@ v0.1.26
 
 > **close**(`code?`, `reason?`): `void`
 
-Defined in: [src/http/WebSocket.ts:69](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L69)
+Defined in: [src/http/WebSocket.ts:69](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/WebSocket.ts#L69)
 
 Closes the WebSocket connection with an optional code and reason.
 
@@ -901,7 +901,7 @@ v0.1.26
 
 > **send**(`data`, `cb?`): `void`
 
-Defined in: [src/http/WebSocket.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L54)
+Defined in: [src/http/WebSocket.ts:54](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/WebSocket.ts#L54)
 
 Sends data over the WebSocket connection.
 

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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L10)
+Defined in: [src/security/AccessControlList.ts:10](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L11)
+Defined in: [src/security/AccessControlList.ts:11](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L12)
+Defined in: [src/security/AccessControlList.ts:12](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L13)
+Defined in: [src/security/AccessControlList.ts:13](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L14)
+Defined in: [src/security/AccessControlList.ts:14](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L15)
+Defined in: [src/security/AccessControlList.ts:15](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L16)
+Defined in: [src/security/AccessControlList.ts:16](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L24)
+Defined in: [src/ApiErrors.ts:24](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L37)
+Defined in: [src/ApiErrors.ts:37](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L38)
+Defined in: [src/ApiErrors.ts:38](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L36)
+Defined in: [src/ApiErrors.ts:36](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L34)
+Defined in: [src/ApiErrors.ts:34](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L35)
+Defined in: [src/ApiErrors.ts:35](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L29)
+Defined in: [src/ApiErrors.ts:29](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L26)
+Defined in: [src/ApiErrors.ts:26](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L30)
+Defined in: [src/ApiErrors.ts:30](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L27)
+Defined in: [src/ApiErrors.ts:27](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L28)
+Defined in: [src/ApiErrors.ts:28](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L31)
+Defined in: [src/ApiErrors.ts:31](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L33)
+Defined in: [src/ApiErrors.ts:33](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L32)
+Defined in: [src/ApiErrors.ts:32](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L25)
+Defined in: [src/ApiErrors.ts:25](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L4)
+Defined in: [src/ApiErrors.ts:4](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L17)
+Defined in: [src/ApiErrors.ts:17](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L18)
+Defined in: [src/ApiErrors.ts:18](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L16)
+Defined in: [src/ApiErrors.ts:16](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L14)
+Defined in: [src/ApiErrors.ts:14](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L15)
+Defined in: [src/ApiErrors.ts:15](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L9)
+Defined in: [src/ApiErrors.ts:9](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L6)
+Defined in: [src/ApiErrors.ts:6](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L10)
+Defined in: [src/ApiErrors.ts:10](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L7)
+Defined in: [src/ApiErrors.ts:7](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L8)
+Defined in: [src/ApiErrors.ts:8](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L11)
+Defined in: [src/ApiErrors.ts:11](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L13)
+Defined in: [src/ApiErrors.ts:13](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L12)
+Defined in: [src/ApiErrors.ts:12](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L5)
+Defined in: [src/ApiErrors.ts:5](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/ApiErrors.ts#L5)

package/docs/reference/functions/createWebSocketStream.md

@@ -8,7 +8,7 @@
 
 > **createWebSocketStream**(`shim`): `Duplex`
 
-Defined in: [src/http/WebSocket.ts:85](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L85)
+Defined in: [src/http/WebSocket.ts:85](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/WebSocket.ts#L85)
 
 Creates a Node.js `Duplex` stream from a `UWSWebSocketShim`, compatible with the
 `createWebSocketStream` API from the `ws` library.

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/ab54834688bebfbea1d8258c626822205861b919/src/database/ConnectionKinds.ts#L12)
+Defined in: [src/database/ConnectionKinds.ts:12](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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

@@ -8,10 +8,10 @@
 
 > **readBody**(`uwsRes`, `req`): `Promise`\<`void`\>
 
-Defined in: [src/http/Adapters.ts:224](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L224)
+Defined in: [src/http/Adapters.ts:224](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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
+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

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/ab54834688bebfbea1d8258c626822205861b919/src/database/NamingUtils.ts#L38)
+Defined in: [src/database/NamingUtils.ts:38](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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

@@ -8,7 +8,7 @@
 
 > **runChain**(`handlers`, `req`, `res`): `Promise`\<`void`\>
 
-Defined in: [src/http/Router.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L43)
+Defined in: [src/http/Router.ts:43](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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)`

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/ab54834688bebfbea1d8258c626822205861b919/src/database/NamingUtils.ts#L14)
+Defined in: [src/database/NamingUtils.ts:14](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/database/NamingUtils.ts#L14)
 
 Converts a string into snake_case.
 

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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L33)
+Defined in: [src/security/AccessControlList.ts:33](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L42)
+Defined in: [src/security/AccessControlList.ts:42](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L57)
+Defined in: [src/security/AccessControlList.ts:57](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L69)
+Defined in: [src/security/AccessControlList.ts:69](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L47)
+Defined in: [src/security/AccessControlList.ts:47](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L63)
+Defined in: [src/security/AccessControlList.ts:63](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L52)
+Defined in: [src/security/AccessControlList.ts:52](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L37)
+Defined in: [src/security/AccessControlList.ts:37](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/AccessControlList.ts#L37)
 
 The unique identifier of the user or role that the record belongs to.