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

package/docs/reference/enumerations/ACLAction.md

@@ -1,63 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / ACLAction
-
-# Enumeration: ACLAction
-
-Defined in: [src/security/AccessControlList.ts:10](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/security/AccessControlList.ts#L10)
-
-Describes the various permission actions that can be performed against an entity.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Enumeration Members
-
-### CREATE
-
-> **CREATE**: `"CREATE"`
-
-Defined in: [src/security/AccessControlList.ts:11](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/security/AccessControlList.ts#L11)
-
-***
-
-### DELETE
-
-> **DELETE**: `"DELETE"`
-
-Defined in: [src/security/AccessControlList.ts:12](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/security/AccessControlList.ts#L12)
-
-***
-
-### FULL
-
-> **FULL**: `"FULL"`
-
-Defined in: [src/security/AccessControlList.ts:13](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/security/AccessControlList.ts#L13)
-
-***
-
-### READ
-
-> **READ**: `"READ"`
-
-Defined in: [src/security/AccessControlList.ts:14](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/security/AccessControlList.ts#L14)
-
-***
-
-### SPECIAL
-
-> **SPECIAL**: `"SPECIAL"`
-
-Defined in: [src/security/AccessControlList.ts:15](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/security/AccessControlList.ts#L15)
-
-***
-
-### UPDATE
-
-> **UPDATE**: `"UPDATE"`
-
-Defined in: [src/security/AccessControlList.ts:16](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/security/AccessControlList.ts#L16)

package/docs/reference/enumerations/ApiErrorMessages.md

@@ -1,123 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / ApiErrorMessages
-
-# Enumeration: ApiErrorMessages
-
-Defined in: [src/ApiErrors.ts:24](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L24)
-
-Defines the default message of all common API errors.
-
-## Enumeration Members
-
-### AUTH\_FAILED
-
-> **AUTH\_FAILED**: `"Invalid or missing authentication token."`
-
-Defined in: [src/ApiErrors.ts:37](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L37)
-
-***
-
-### AUTH\_PERMISSION\_FAILURE
-
-> **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/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L38)
-
-***
-
-### AUTH\_REQUIRED
-
-> **AUTH\_REQUIRED**: `"Authorization is required to access this resource."`
-
-Defined in: [src/ApiErrors.ts:36](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L36)
-
-***
-
-### BULK\_CREATE\_FAILURE
-
-> **BULK\_CREATE\_FAILURE**: `"Failed to create one or more objects."`
-
-Defined in: [src/ApiErrors.ts:34](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L34)
-
-***
-
-### BULK\_UPDATE\_FAILURE
-
-> **BULK\_UPDATE\_FAILURE**: `"Failed to update one or more objects."`
-
-Defined in: [src/ApiErrors.ts:35](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L35)
-
-***
-
-### IDENTIFIER\_EXISTS
-
-> **IDENTIFIER\_EXISTS**: `"A resource with that identifier already exists."`
-
-Defined in: [src/ApiErrors.ts:29](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L29)
-
-***
-
-### INTERNAL\_ERROR
-
-> **INTERNAL\_ERROR**: `"An internal error has occurred. Please contact the adminstrator."`
-
-Defined in: [src/ApiErrors.ts:26](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L26)
-
-***
-
-### INVALID\_OBJECT\_VERSION
-
-> **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/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L30)
-
-***
-
-### INVALID\_REQUEST
-
-> **INVALID\_REQUEST**: `"Invalid message or request."`
-
-Defined in: [src/ApiErrors.ts:27](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L27)
-
-***
-
-### NOT\_FOUND
-
-> **NOT\_FOUND**: `"No resource could be found with the specified identifier."`
-
-Defined in: [src/ApiErrors.ts:28](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L28)
-
-***
-
-### OBJECT\_ID\_MISMATCH
-
-> **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/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L31)
-
-***
-
-### SEARCH\_INVALID\_ME\_REFERENCE
-
-> **SEARCH\_INVALID\_ME\_REFERENCE**: `` "Use of the `me` reference requires authentication." ``
-
-Defined in: [src/ApiErrors.ts:33](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L33)
-
-***
-
-### SEARCH\_INVALID\_RANGE
-
-> **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/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L32)
-
-***
-
-### UNKNOWN
-
-> **UNKNOWN**: `"An unknown error has occurred. Please try again."`
-
-Defined in: [src/ApiErrors.ts:25](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/ApiErrors.ts#L25)

package/docs/reference/enumerations/ApiErrors.md

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

package/docs/reference/functions/createWebSocketStream.md

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

@@ -1,26 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / isSqlDataSource
-
-# Function: isSqlDataSource()
-
-> **isSqlDataSource**(`conn`): `boolean`
-
-Defined in: [src/database/ConnectionKinds.ts:12](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/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.
-
-## Parameters
-
-### conn
-
-`any`
-
-The connection object to inspect.
-
-## Returns
-
-`boolean`

package/docs/reference/functions/readBody.md

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

@@ -1,33 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / resolveCollectionName
-
-# Function: resolveCollectionName()
-
-> **resolveCollectionName**(`clazz`): `string`
-
-Defined in: [src/database/NamingUtils.ts:39](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/NamingUtils.ts#L39)
-
-Resolves the name of the database collection (or table) that records of the given model class are stored in.
-
-The name is resolved using the following rules:
-1. The nearest class in the inheritance chain (starting with `clazz` itself) that specifies an explicit
-entity name via the `@Entity(options)` decorator.
-2. Otherwise, the most ancestral class in the inheritance chain that declares its own `@DataStore` binding.
-This ensures that `@ChildEntity` subclasses are stored in the same collection as their parent entity
-(single collection inheritance).
-3. Otherwise, the snake_case form of the class name.
-
-## Parameters
-
-### clazz
-
-`any`
-
-The model class to resolve the collection name for.
-
-## Returns
-
-`string`

package/docs/reference/functions/runChain.md

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

@@ -1,28 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / snakeCase
-
-# Function: snakeCase()
-
-> **snakeCase**(`str`): `string`
-
-Defined in: [src/database/NamingUtils.ts:15](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/NamingUtils.ts#L15)
-
-Converts a string into snake_case.
-
-Note: This function is intentionally identical in behavior to TypeORM's `snakeCase` utility so that
-collection/table names derived from class names remain stable for existing deployments.
-
-## Parameters
-
-### str
-
-`string`
-
-The string to convert.
-
-## Returns
-
-`string`

package/docs/reference/globals.md

@@ -1,106 +0,0 @@
-[**@rapidrest/service-core**](README.md)
-
-***
-
-# @rapidrest/service-core
-
-## Namespaces
-
-- [DatabaseDecorators](@rapidrest/namespaces/DatabaseDecorators/README.md)
-- [DocDecorators](@rapidrest/namespaces/DocDecorators/README.md)
-- [EventDecorators](@rapidrest/namespaces/EventDecorators/README.md)
-- [ModelDecorators](@rapidrest/namespaces/ModelDecorators/README.md)
-- [PersistenceDecorators](@rapidrest/namespaces/PersistenceDecorators/README.md)
-- [RouteDecorators](@rapidrest/namespaces/RouteDecorators/README.md)
-
-## Enumerations
-
-- [ACLAction](enumerations/ACLAction.md)
-- [ApiErrorMessages](enumerations/ApiErrorMessages.md)
-- [ApiErrors](enumerations/ApiErrors.md)
-
-## Classes
-
-- [ACLUtils](classes/ACLUtils.md)
-- [AdminRoute](classes/AdminRoute.md)
-- [AuthMiddleware](classes/AuthMiddleware.md)
-- [BackgroundService](classes/BackgroundService.md)
-- [BackgroundServiceManager](classes/BackgroundServiceManager.md)
-- [BaseEntity](classes/BaseEntity.md)
-- [BaseMongoEntity](classes/BaseMongoEntity.md)
-- [BasicStrategy](classes/BasicStrategy.md)
-- [BasicStrategyOptions](classes/BasicStrategyOptions.md)
-- [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)
-- [ModelRoute](classes/ModelRoute.md)
-- [ModelUtils](classes/ModelUtils.md)
-- [MongoConnection](classes/MongoConnection.md)
-- [MongoRepository](classes/MongoRepository.md)
-- [MongoSchemaSync](classes/MongoSchemaSync.md)
-- [NetUtils](classes/NetUtils.md)
-- [NotificationUtils](classes/NotificationUtils.md)
-- [ObjectFactory](classes/ObjectFactory.md)
-- [OpenAPIRoute](classes/OpenAPIRoute.md)
-- [OpenApiSpec](classes/OpenApiSpec.md)
-- [RecoverableBaseEntity](classes/RecoverableBaseEntity.md)
-- [RecoverableBaseMongoEntity](classes/RecoverableBaseMongoEntity.md)
-- [RedisTransport](classes/RedisTransport.md)
-- [RepoUtils](classes/RepoUtils.md)
-- [RouteUtils](classes/RouteUtils.md)
-- [Server](classes/Server.md)
-- [SimpleEntity](classes/SimpleEntity.md)
-- [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
-
-- [AccessControlList](interfaces/AccessControlList.md)
-- [ACLRecord](interfaces/ACLRecord.md)
-- [AuthResult](interfaces/AuthResult.md)
-- [AuthStrategy](interfaces/AuthStrategy.md)
-- [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)
-- [RepoFindOptions](interfaces/RepoFindOptions.md)
-- [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)