@rapidrest/service-core 1.0.0-rc.7 → 1.0.0

package/docs/reference/interfaces/RequestWS.md

@@ -1,225 +0,0 @@
-[**@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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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

@@ -1,161 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / TruncateRequestOptions
-
-# Interface: TruncateRequestOptions
-
-Defined in: [src/routes/ModelRoute.ts:70](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L70)
-
-The set of options required by truncate request handlers.
-
-## Extends
-
-- [`DeleteRequestOptions`](DeleteRequestOptions.md)
-
-## Properties
-
-### ignoreACL?
-
-> `optional` **ignoreACL?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L32)
-
-Set to `true` to ignore the ACL permissions check.
-
-#### Inherited from
-
-[`DeleteRequestOptions`](DeleteRequestOptions.md).[`ignoreACL`](DeleteRequestOptions.md#ignoreacl)
-
-***
-
-### params
-
-> **params**: `any`
-
-Defined in: [src/routes/ModelRoute.ts:72](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L72)
-
-The list of URL parameters to use in the search.
-
-***
-
-### purge?
-
-> `optional` **purge?**: `boolean`
-
-Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L48)
-
-Set to true to permanently remove the object from the database (if applicable).
-
-#### Inherited from
-
-[`DeleteRequestOptions`](DeleteRequestOptions.md).[`purge`](DeleteRequestOptions.md#purge)
-
-***
-
-### pushChannels?
-
-> `optional` **pushChannels?**: `string`[]
-
-Defined in: [src/routes/ModelRoute.ts:74](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L74)
-
-An additional list of channel names to send push notifications to.
-
-#### Overrides
-
-[`DeleteRequestOptions`](DeleteRequestOptions.md).[`pushChannels`](DeleteRequestOptions.md#pushchannels)
-
-***
-
-### query
-
-> **query**: `any`
-
-Defined in: [src/routes/ModelRoute.ts:76](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L76)
-
-The list of query parameters to use in the search.
-
-***
-
-### recordEvent?
-
-> `optional` **recordEvent?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L36)
-
-Indicates if a telemetry event should be broadcast for the request.
-
-#### Inherited from
-
-[`DeleteRequestOptions`](DeleteRequestOptions.md).[`recordEvent`](DeleteRequestOptions.md#recordevent)
-
-***
-
-### req?
-
-> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
-
-Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L27)
-
-The originating client request.
-
-#### Inherited from
-
-[`DeleteRequestOptions`](DeleteRequestOptions.md).[`req`](DeleteRequestOptions.md#req)
-
-***
-
-### res?
-
-> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
-
-Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L29)
-
-The outgoing client response.
-
-#### Inherited from
-
-[`DeleteRequestOptions`](DeleteRequestOptions.md).[`res`](DeleteRequestOptions.md#res)
-
-***
-
-### skipPush?
-
-> `optional` **skipPush?**: `boolean`
-
-Defined in: [src/routes/ModelRoute.ts:78](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L78)
-
-Set to `true` to not send a push notification.
-
-#### Overrides
-
-[`DeleteRequestOptions`](DeleteRequestOptions.md).[`skipPush`](DeleteRequestOptions.md#skippush)
-
-***
-
-### user?
-
-> `optional` **user?**: `JWTUser`
-
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L40)
-
-The authenticated user making the request.
-
-#### Inherited from
-
-[`DeleteRequestOptions`](DeleteRequestOptions.md).[`user`](DeleteRequestOptions.md#user)
-
-***
-
-### version?
-
-> `optional` **version?**: `string` \| `number`
-
-Defined in: [src/routes/ModelRoute.ts:54](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L54)
-
-The desired version number of the resource to delete.
-
-#### Inherited from
-
-[`DeleteRequestOptions`](DeleteRequestOptions.md).[`version`](DeleteRequestOptions.md#version)

package/docs/reference/interfaces/UpdateRequestOptions.md

@@ -1,139 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / UpdateRequestOptions
-
-# Interface: UpdateRequestOptions\<T\>
-
-Defined in: [src/routes/ModelRoute.ts:87](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L87)
-
-The set of options required by update request handlers.
-
-## Extends
-
-- [`RequestOptions`](RequestOptions.md)
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`BaseEntity`](../classes/BaseEntity.md) \| [`SimpleEntity`](../classes/SimpleEntity.md)
-
-## Properties
-
-### existing?
-
-> `optional` **existing?**: `T` \| `null`
-
-Defined in: [src/routes/ModelRoute.ts:89](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L89)
-
-The existing object that has already been recently pulled from the datastore.
-
-***
-
-### ignoreACL?
-
-> `optional` **ignoreACL?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L32)
-
-Set to `true` to ignore the ACL permissions check.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`ignoreACL`](RequestOptions.md#ignoreacl)
-
-***
-
-### pushChannels?
-
-> `optional` **pushChannels?**: `string`[]
-
-Defined in: [src/routes/ModelRoute.ts:91](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L91)
-
-An additional list of channel names to send push notifications to.
-
-#### Overrides
-
-[`RequestOptions`](RequestOptions.md).[`pushChannels`](RequestOptions.md#pushchannels)
-
-***
-
-### recordEvent?
-
-> `optional` **recordEvent?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L36)
-
-Indicates if a telemetry event should be broadcast for the request.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`recordEvent`](RequestOptions.md#recordevent)
-
-***
-
-### req?
-
-> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
-
-Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L27)
-
-The originating client request.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`req`](RequestOptions.md#req)
-
-***
-
-### res?
-
-> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
-
-Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L29)
-
-The outgoing client response.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`res`](RequestOptions.md#res)
-
-***
-
-### skipPush?
-
-> `optional` **skipPush?**: `boolean`
-
-Defined in: [src/routes/ModelRoute.ts:93](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L93)
-
-Set to `true` to not send a push notification.
-
-#### Overrides
-
-[`RequestOptions`](RequestOptions.md).[`skipPush`](RequestOptions.md#skippush)
-
-***
-
-### user?
-
-> `optional` **user?**: `JWTUser`
-
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L40)
-
-The authenticated user making the request.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`user`](RequestOptions.md#user)
-
-***
-
-### version?
-
-> `optional` **version?**: `string` \| `number`
-
-Defined in: [src/routes/ModelRoute.ts:95](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L95)
-
-The desired version number of the resource to update.

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

@@ -1,35 +0,0 @@
-[**@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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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

@@ -1,23 +0,0 @@
-[**@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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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

@@ -1,19 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / OneOrMany
-
-# Type Alias: OneOrMany\<T\>
-
-> **OneOrMany**\<`T`\> = `T` \| `T`[]
-
-Defined in: [src/Types.ts:4](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/Types.ts#L4)
-
-Provides an explicit type declaration for `T | T[]`.
-
-## Type Parameters
-
-### T
-
-`T`

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

@@ -1,19 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / OneOrNull
-
-# Type Alias: OneOrNull\<T\>
-
-> **OneOrNull**\<`T`\> = `T` \| `null`
-
-Defined in: [src/Types.ts:9](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/Types.ts#L9)
-
-Provides an explicit type declaration for `T | null`.
-
-## Type Parameters
-
-### T
-
-`T`

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

@@ -1,17 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / PartialBaseEntity
-
-# Type Alias: PartialBaseEntity\<T\>
-
-> **PartialBaseEntity**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\> & `Pick`\<`T`, `"version"`\>
-
-Defined in: [src/models/BaseEntity.ts:68](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/BaseEntity.ts#L68)
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`BaseEntity`](../classes/BaseEntity.md)

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

@@ -1,17 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / PartialSimpleEntity
-
-# Type Alias: PartialSimpleEntity\<T\>
-
-> **PartialSimpleEntity**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\>
-
-Defined in: [src/models/SimpleEntity.ts:33](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/SimpleEntity.ts#L33)
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`SimpleEntity`](../classes/SimpleEntity.md)

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

@@ -1,31 +0,0 @@
-[**@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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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`\>