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

package/docs/reference/classes/SimpleMongoEntity.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: SimpleMongoEntity
 
-Defined in: [src/models/SimpleMongoEntity.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleMongoEntity.ts#L14)
+Defined in: [src/models/SimpleMongoEntity.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleMongoEntity.ts#L14)
 
 Provides a simple base class for all entity's that will be persisted in a MongoDB database. Unlike
 `BaseMongoEntity` this class does not provide optimistic locking or date created and modified tracking.
@@ -25,7 +25,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new SimpleMongoEntity**(`other?`): `SimpleMongoEntity`
 
-Defined in: [src/models/SimpleMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleMongoEntity.ts#L21)
+Defined in: [src/models/SimpleMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleMongoEntity.ts#L21)
 
 #### Parameters
 
@@ -47,7 +47,7 @@ Defined in: [src/models/SimpleMongoEntity.ts:21](https://github.com/rapidrest/se
 
 > `optional` **\_id?**: `ObjectId`
 
-Defined in: [src/models/SimpleMongoEntity.ts:19](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleMongoEntity.ts#L19)
+Defined in: [src/models/SimpleMongoEntity.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleMongoEntity.ts#L19)
 
 The internal unique identifier used by MongoDB.
 
@@ -57,7 +57,7 @@ The internal unique identifier used by MongoDB.
 
 > **uid**: `string`
 
-Defined in: [src/models/SimpleEntity.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L24)
+Defined in: [src/models/SimpleEntity.ts:24](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleEntity.ts#L24)
 
 The universally unique identifier of the entity.
 

package/docs/reference/classes/StatusExtraData.md

@@ -6,7 +6,7 @@
 
 # Class: StatusExtraData
 
-Defined in: [src/models/StatusExtraData.ts:1](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L1)
+Defined in: [src/models/StatusExtraData.ts:1](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/StatusExtraData.ts#L1)
 
 ## Constructors
 
@@ -14,7 +14,7 @@ Defined in: [src/models/StatusExtraData.ts:1](https://github.com/rapidrest/servi
 
 > **new StatusExtraData**(`other`): `StatusExtraData`
 
-Defined in: [src/models/StatusExtraData.ts:9](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L9)
+Defined in: [src/models/StatusExtraData.ts:9](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/StatusExtraData.ts#L9)
 
 #### Parameters
 
@@ -34,7 +34,7 @@ Defined in: [src/models/StatusExtraData.ts:9](https://github.com/rapidrest/servi
 
 > **get** **data**(): `any`
 
-Defined in: [src/models/StatusExtraData.ts:3](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L3)
+Defined in: [src/models/StatusExtraData.ts:3](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/StatusExtraData.ts#L3)
 
 ##### Returns
 
@@ -44,7 +44,7 @@ Defined in: [src/models/StatusExtraData.ts:3](https://github.com/rapidrest/servi
 
 > **set** **data**(`data`): `void`
 
-Defined in: [src/models/StatusExtraData.ts:6](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L6)
+Defined in: [src/models/StatusExtraData.ts:6](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/StatusExtraData.ts#L6)
 
 ##### Parameters
 

package/docs/reference/classes/StatusRoute.md

@@ -6,7 +6,7 @@
 
 # Class: StatusRoute
 
-Defined in: [src/routes/StatusRoute.ts:17](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/StatusRoute.ts#L17)
+Defined in: [src/routes/StatusRoute.ts:17](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/StatusRoute.ts#L17)
 
 The `StatusRoute` provides a default `/status` endpoint the returns metadata information about the service such as
 name, version.

package/docs/reference/classes/UWSRequest.md

@@ -0,0 +1,226 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / UWSRequest
+
+# Class: UWSRequest
+
+Defined in: [src/http/Adapters.ts:58](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L58)
+
+Adapts a uWS `HttpRequest` to the framework-agnostic `HttpRequest` interface.
+
+IMPORTANT: uWS HttpRequest is stack-allocated and only valid during the synchronous portion of
+the handler. All request data MUST be captured in the constructor before any `await`.
+
+## Implements
+
+- [`HttpRequest`](../interfaces/HttpRequest.md)
+
+## Indexable
+
+> \[`key`: `string`\]: `any`
+
+Allow arbitrary per-request properties (websocket, wsHandled, etc.)
+
+## Constructors
+
+### Constructor
+
+> **new UWSRequest**(`uwsReq`, `remoteAddress?`): `UWSRequest`
+
+Defined in: [src/http/Adapters.ts:76](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L76)
+
+#### Parameters
+
+##### uwsReq
+
+`HttpRequest`
+
+##### remoteAddress?
+
+`string`
+
+#### Returns
+
+`UWSRequest`
+
+## Properties
+
+### authPayload?
+
+> `optional` **authPayload?**: `any`
+
+Defined in: [src/http/Adapters.ts:71](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L71)
+
+Full decoded JWT payload, set by JWT auth middleware.
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`authPayload`](../interfaces/HttpRequest.md#authpayload)
+
+***
+
+### authToken?
+
+> `optional` **authToken?**: `string`
+
+Defined in: [src/http/Adapters.ts:72](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L72)
+
+Raw JWT token string, set by JWT auth middleware.
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`authToken`](../interfaces/HttpRequest.md#authtoken)
+
+***
+
+### body
+
+> **body**: `any` = `undefined`
+
+Defined in: [src/http/Adapters.ts:65](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L65)
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`body`](../interfaces/HttpRequest.md#body)
+
+***
+
+### cookies
+
+> `readonly` **cookies**: `Record`\<`string`, `string`\>
+
+Defined in: [src/http/Adapters.ts:67](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L67)
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`cookies`](../interfaces/HttpRequest.md#cookies)
+
+***
+
+### headers
+
+> `readonly` **headers**: `Record`\<`string`, `string`\>
+
+Defined in: [src/http/Adapters.ts:62](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L62)
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`headers`](../interfaces/HttpRequest.md#headers)
+
+***
+
+### method
+
+> `readonly` **method**: `string`
+
+Defined in: [src/http/Adapters.ts:59](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L59)
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`method`](../interfaces/HttpRequest.md#method)
+
+***
+
+### params
+
+> **params**: `Record`\<`string`, `string`\> = `{}`
+
+Defined in: [src/http/Adapters.ts:63](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L63)
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`params`](../interfaces/HttpRequest.md#params)
+
+***
+
+### path
+
+> `readonly` **path**: `string`
+
+Defined in: [src/http/Adapters.ts:61](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L61)
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`path`](../interfaces/HttpRequest.md#path)
+
+***
+
+### query
+
+> `readonly` **query**: `Record`\<`string`, `string` \| `string`[]\>
+
+Defined in: [src/http/Adapters.ts:64](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L64)
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`query`](../interfaces/HttpRequest.md#query)
+
+***
+
+### rawBody?
+
+> `optional` **rawBody?**: `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [src/http/Adapters.ts:66](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L66)
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`rawBody`](../interfaces/HttpRequest.md#rawbody)
+
+***
+
+### signedCookies
+
+> `readonly` **signedCookies**: `Record`\<`string`, `string`\> = `{}`
+
+Defined in: [src/http/Adapters.ts:68](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L68)
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`signedCookies`](../interfaces/HttpRequest.md#signedcookies)
+
+***
+
+### socket
+
+> `readonly` **socket**: `object`
+
+Defined in: [src/http/Adapters.ts:69](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L69)
+
+Minimal socket interface; populated with remote address for IP extraction.
+
+#### remoteAddress?
+
+> `optional` **remoteAddress?**: `string`
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`socket`](../interfaces/HttpRequest.md#socket)
+
+***
+
+### url
+
+> `readonly` **url**: `string`
+
+Defined in: [src/http/Adapters.ts:60](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L60)
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`url`](../interfaces/HttpRequest.md#url)
+
+***
+
+### user?
+
+> `optional` **user?**: `any`
+
+Defined in: [src/http/Adapters.ts:70](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L70)
+
+Set by JWT auth middleware after successful token verification.
+
+#### Implementation of
+
+[`HttpRequest`](../interfaces/HttpRequest.md).[`user`](../interfaces/HttpRequest.md#user)

package/docs/reference/classes/UWSResponse.md

@@ -0,0 +1,257 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / UWSResponse
+
+# Class: UWSResponse
+
+Defined in: [src/http/Adapters.ts:109](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/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
+optimal performance.
+
+## Implements
+
+- [`HttpResponse`](../interfaces/HttpResponse.md)
+
+## Indexable
+
+> \[`key`: `string`\]: `any`
+
+Allow arbitrary per-response properties.
+
+## Constructors
+
+### Constructor
+
+> **new UWSResponse**(`uwsRes`): `UWSResponse`
+
+Defined in: [src/http/Adapters.ts:123](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L123)
+
+#### Parameters
+
+##### uwsRes
+
+`HttpResponse`
+
+#### Returns
+
+`UWSResponse`
+
+## Properties
+
+### isHead
+
+> **isHead**: `boolean` = `false`
+
+Defined in: [src/http/Adapters.ts:117](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L117)
+
+Set to true for HEAD requests — body bytes must not be sent.
+
+***
+
+### result?
+
+> `optional` **result?**: `any`
+
+Defined in: [src/http/Adapters.ts:119](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L119)
+
+Intermediate result passed between middleware.
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`result`](../interfaces/HttpResponse.md#result)
+
+## Accessors
+
+### headersSent
+
+#### Get Signature
+
+> **get** **headersSent**(): `boolean`
+
+Defined in: [src/http/Adapters.ts:135](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L135)
+
+##### Returns
+
+`boolean`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`headersSent`](../interfaces/HttpResponse.md#headerssent)
+
+***
+
+### statusCode
+
+#### Get Signature
+
+> **get** **statusCode**(): `number`
+
+Defined in: [src/http/Adapters.ts:131](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L131)
+
+##### Returns
+
+`number`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`statusCode`](../interfaces/HttpResponse.md#statuscode)
+
+***
+
+### writableEnded
+
+#### Get Signature
+
+> **get** **writableEnded**(): `boolean`
+
+Defined in: [src/http/Adapters.ts:139](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L139)
+
+##### Returns
+
+`boolean`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`writableEnded`](../interfaces/HttpResponse.md#writableended)
+
+## Methods
+
+### end()
+
+> **end**(`data?`): `void`
+
+Defined in: [src/http/Adapters.ts:172](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L172)
+
+#### Parameters
+
+##### data?
+
+`any`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`end`](../interfaces/HttpResponse.md#end)
+
+***
+
+### getHeader()
+
+> **getHeader**(`key`): `string` \| `undefined`
+
+Defined in: [src/http/Adapters.ts:153](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L153)
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`string` \| `undefined`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`getHeader`](../interfaces/HttpResponse.md#getheader)
+
+***
+
+### json()
+
+> **json**(`data`): `void`
+
+Defined in: [src/http/Adapters.ts:157](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L157)
+
+#### Parameters
+
+##### data
+
+`any`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`json`](../interfaces/HttpResponse.md#json)
+
+***
+
+### send()
+
+> **send**(`data?`): `void`
+
+Defined in: [src/http/Adapters.ts:162](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L162)
+
+#### Parameters
+
+##### data?
+
+`any`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`send`](../interfaces/HttpResponse.md#send)
+
+***
+
+### setHeader()
+
+> **setHeader**(`key`, `value`): `this`
+
+Defined in: [src/http/Adapters.ts:148](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L148)
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### value
+
+`string` \| `number`
+
+#### Returns
+
+`this`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`setHeader`](../interfaces/HttpResponse.md#setheader)
+
+***
+
+### status()
+
+> **status**(`code`): `this`
+
+Defined in: [src/http/Adapters.ts:143](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L143)
+
+#### Parameters
+
+##### code
+
+`number`
+
+#### Returns
+
+`this`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`status`](../interfaces/HttpResponse.md#status)