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

package/docs/reference/classes/MongoRepository.md

@@ -6,7 +6,7 @@
 
 # Class: MongoRepository\<T\>
 
-Defined in: [src/database/MongoRepository.ts:22](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L22)
+Defined in: [src/database/MongoRepository.ts:22](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L22)
 
 Provides a lightweight repository for performing common operations against a single MongoDB collection using the
 native `mongodb` driver. Instances of this class are obtained via `MongoConnection.getRepository`.
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new MongoRepository**\<`T`\>(`db`, `collection`, `modelClass?`): `MongoRepository`\<`T`\>
 
-Defined in: [src/database/MongoRepository.ts:30](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L30)
+Defined in: [src/database/MongoRepository.ts:30](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L30)
 
 #### Parameters
 
@@ -56,7 +56,7 @@ Defined in: [src/database/MongoRepository.ts:30](https://github.com/rapidrest/se
 
 > `readonly` **collection**: `Collection`\<`T`\>
 
-Defined in: [src/database/MongoRepository.ts:26](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L26)
+Defined in: [src/database/MongoRepository.ts:26](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L26)
 
 The underlying MongoDB collection that operations are performed against.
 
@@ -66,7 +66,7 @@ The underlying MongoDB collection that operations are performed against.
 
 > `readonly` **db**: `Db`
 
-Defined in: [src/database/MongoRepository.ts:24](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L24)
+Defined in: [src/database/MongoRepository.ts:24](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L24)
 
 The database that the underlying collection belongs to.
 
@@ -76,7 +76,7 @@ The database that the underlying collection belongs to.
 
 > `readonly` **modelClass**: `any`
 
-Defined in: [src/database/MongoRepository.ts:28](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L28)
+Defined in: [src/database/MongoRepository.ts:28](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L28)
 
 The model class associated with this repository.
 
@@ -88,7 +88,7 @@ The model class associated with this repository.
 
 > **get** **collectionName**(): `string`
 
-Defined in: [src/database/MongoRepository.ts:37](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L37)
+Defined in: [src/database/MongoRepository.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L37)
 
 The name of the underlying MongoDB collection.
 
@@ -102,7 +102,7 @@ The name of the underlying MongoDB collection.
 
 > **aggregate**(`pipeline`): `AggregationCursor`\<`any`\>
 
-Defined in: [src/database/MongoRepository.ts:46](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L46)
+Defined in: [src/database/MongoRepository.ts:46](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L46)
 
 Executes the given aggregation pipeline against the collection and returns the resulting cursor.
 
@@ -124,7 +124,7 @@ The aggregation pipeline stages to execute.
 
 > **clear**(): `Promise`\<`void`\>
 
-Defined in: [src/database/MongoRepository.ts:54](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L54)
+Defined in: [src/database/MongoRepository.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L54)
 
 Drops the entire collection from the database, removing all documents and indexes. Does nothing if the
 collection does not exist.
@@ -139,7 +139,7 @@ collection does not exist.
 
 > **count**(`filter?`): `Promise`\<`number`\>
 
-Defined in: [src/database/MongoRepository.ts:70](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L70)
+Defined in: [src/database/MongoRepository.ts:70](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L70)
 
 Returns the number of documents matching the given filter.
 
@@ -161,7 +161,7 @@ The query filter to match documents against.
 
 > **deleteMany**(`filter`): `Promise`\<`DeleteResult`\>
 
-Defined in: [src/database/MongoRepository.ts:79](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L79)
+Defined in: [src/database/MongoRepository.ts:79](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L79)
 
 Deletes all documents matching the given filter.
 
@@ -183,7 +183,7 @@ The query filter to match documents against.
 
 > **deleteOne**(`filter`): `Promise`\<`DeleteResult`\>
 
-Defined in: [src/database/MongoRepository.ts:88](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L88)
+Defined in: [src/database/MongoRepository.ts:88](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L88)
 
 Deletes the first document matching the given filter.
 
@@ -205,7 +205,7 @@ The query filter to match documents against.
 
 > **distinct**(`field`, `filter?`): `Promise`\<`any`[]\>
 
-Defined in: [src/database/MongoRepository.ts:98](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L98)
+Defined in: [src/database/MongoRepository.ts:98](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L98)
 
 Returns the list of distinct values of the given field for all documents matching the given filter.
 
@@ -233,7 +233,7 @@ The query filter to match documents against.
 
 > **find**(`filter?`): `Promise`\<`any`[]\>
 
-Defined in: [src/database/MongoRepository.ts:107](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L107)
+Defined in: [src/database/MongoRepository.ts:107](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L107)
 
 Returns all documents matching the given filter.
 
@@ -255,7 +255,7 @@ The query filter to match documents against.
 
 > **findOne**(`filter`): `Promise`\<`any`\>
 
-Defined in: [src/database/MongoRepository.ts:116](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L116)
+Defined in: [src/database/MongoRepository.ts:116](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L116)
 
 Returns the first document matching the given filter.
 
@@ -277,7 +277,7 @@ The query filter to match documents against.
 
 > **save**(`doc`): `Promise`\<`any`\>
 
-Defined in: [src/database/MongoRepository.ts:128](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L128)
+Defined in: [src/database/MongoRepository.ts:128](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L128)
 
 Saves the given document to the collection. If the document has an existing `_id` the stored document is
 replaced (inserting if missing), otherwise the document is inserted and its newly assigned `_id` is set on
@@ -303,7 +303,7 @@ The saved document.
 
 > **updateMany**(`filter`, `update`): `Promise`\<`UpdateResult`\<`Document`\>\>
 
-Defined in: [src/database/MongoRepository.ts:153](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L153)
+Defined in: [src/database/MongoRepository.ts:153](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L153)
 
 Updates all documents matching the given filter with the provided update operations.
 
@@ -331,7 +331,7 @@ The update operations (e.g. `$set`) to apply.
 
 > **updateOne**(`filter`, `update`): `Promise`\<`UpdateResult`\<`Document`\>\>
 
-Defined in: [src/database/MongoRepository.ts:163](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoRepository.ts#L163)
+Defined in: [src/database/MongoRepository.ts:163](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoRepository.ts#L163)
 
 Updates the first document matching the given filter with the provided update operations.
 

package/docs/reference/classes/MongoSchemaSync.md

@@ -6,7 +6,7 @@
 
 # Class: MongoSchemaSync
 
-Defined in: [src/database/MongoSchemaSync.ts:33](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoSchemaSync.ts#L33)
+Defined in: [src/database/MongoSchemaSync.ts:33](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoSchemaSync.ts#L33)
 
 Performs structure synchronization of MongoDB collections based on the persistence metadata of model classes.
 
@@ -28,7 +28,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new MongoSchemaSync**(`db`, `logger?`): `MongoSchemaSync`
 
-Defined in: [src/database/MongoSchemaSync.ts:37](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoSchemaSync.ts#L37)
+Defined in: [src/database/MongoSchemaSync.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoSchemaSync.ts#L37)
 
 #### Parameters
 
@@ -50,7 +50,7 @@ Defined in: [src/database/MongoSchemaSync.ts:37](https://github.com/rapidrest/se
 
 > **synchronize**(`entities`): `Promise`\<`void`\>
 
-Defined in: [src/database/MongoSchemaSync.ts:47](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/MongoSchemaSync.ts#L47)
+Defined in: [src/database/MongoSchemaSync.ts:47](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/MongoSchemaSync.ts#L47)
 
 Synchronizes the structure of all collections associated with the given model classes.
 

package/docs/reference/classes/NetUtils.md

@@ -6,7 +6,7 @@
 
 # Class: NetUtils
 
-Defined in: [src/NetUtils.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NetUtils.ts#L12)
+Defined in: [src/NetUtils.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/NetUtils.ts#L12)
 
 Provides common utilities and functions for working with networking related problems.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `static` **getIPAddress**(`urlOrRequest`, `trustedProxies?`): `string` \| `undefined`
 
-Defined in: [src/NetUtils.ts:57](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NetUtils.ts#L57)
+Defined in: [src/NetUtils.ts:57](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/NetUtils.ts#L57)
 
 Extracts the IP address from a given url or HTTP request.
 
@@ -65,7 +65,7 @@ A `string` containing the IP address if found, otherwise `undefined`.
 
 > `static` **lookupIPAddress**(`url`, `family?`): `Promise`\<`string` \| `undefined`\>
 
-Defined in: [src/NetUtils.ts:20](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NetUtils.ts#L20)
+Defined in: [src/NetUtils.ts:20](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/NetUtils.ts#L20)
 
 Performs DNS lookup of the IP address from a given url.
 

package/docs/reference/classes/NotificationUtils.md

@@ -6,7 +6,7 @@
 
 # Class: NotificationUtils
 
-Defined in: [src/NotificationUtils.ts:11](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NotificationUtils.ts#L11)
+Defined in: [src/NotificationUtils.ts:11](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/NotificationUtils.ts#L11)
 
 Utility functions for sending push notifications to registered clients.
 
@@ -20,7 +20,7 @@ Jean-Philippe Steinmetz
 
 > **new NotificationUtils**(`redis`): `NotificationUtils`
 
-Defined in: [src/NotificationUtils.ts:20](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NotificationUtils.ts#L20)
+Defined in: [src/NotificationUtils.ts:20](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/NotificationUtils.ts#L20)
 
 Initializes the utility using the given redis connection.
 
@@ -42,7 +42,7 @@ The redis connection to publish to.
 
 > **sendMessage**(`uids`, `type`, `action`, `data`): `void`
 
-Defined in: [src/NotificationUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NotificationUtils.ts#L32)
+Defined in: [src/NotificationUtils.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/NotificationUtils.ts#L32)
 
 Sends a given message to the room or user with the specified uid(s).
 

package/docs/reference/classes/ObjectFactory.md

@@ -6,7 +6,7 @@
 
 # Class: ObjectFactory
 
-Defined in: [src/ObjectFactory.ts:21](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ObjectFactory.ts#L21)
+Defined in: [src/ObjectFactory.ts:21](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ObjectFactory.ts#L21)
 
 The `ObjectFactory` is a manager for creating objects based on registered
 class types. This allows for the tracking of multiple instances of objects
@@ -26,7 +26,7 @@ Jean-Philippe Steinmetz
 
 > **new ObjectFactory**(`config?`, `logger?`): `ObjectFactory`
 
-Defined in: [src/ObjectFactory.ts:22](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ObjectFactory.ts#L22)
+Defined in: [src/ObjectFactory.ts:22](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ObjectFactory.ts#L22)
 
 #### Parameters
 
@@ -232,7 +232,7 @@ The object instance associated with the given name if found, otherwise `undefine
 
 > **initialize**\<`T`\>(`obj`): `Promise`\<`T`\>
 
-Defined in: [src/ObjectFactory.ts:30](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ObjectFactory.ts#L30)
+Defined in: [src/ObjectFactory.ts:30](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ObjectFactory.ts#L30)
 
 Scans the given object for any properties with the
 

package/docs/reference/classes/OpenAPIRoute.md

@@ -6,7 +6,7 @@
 
 # Class: OpenAPIRoute
 
-Defined in: [src/routes/OpenAPIRoute.ts:44](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/OpenAPIRoute.ts#L44)
+Defined in: [src/routes/OpenAPIRoute.ts:44](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/OpenAPIRoute.ts#L44)
 
 The `OpenAPIRoute` provides default routes to expose the service's OpenAPI specification.
 
@@ -34,7 +34,7 @@ Jean-Philippe Steinmetz
 
 > **getAPIDocs**(): `string`
 
-Defined in: [src/routes/OpenAPIRoute.ts:63](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/OpenAPIRoute.ts#L63)
+Defined in: [src/routes/OpenAPIRoute.ts:63](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/OpenAPIRoute.ts#L63)
 
 #### Returns
 
@@ -46,7 +46,7 @@ Defined in: [src/routes/OpenAPIRoute.ts:63](https://github.com/rapidrest/service
 
 > **getHTML**(): `string`
 
-Defined in: [src/routes/OpenAPIRoute.ts:54](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/OpenAPIRoute.ts#L54)
+Defined in: [src/routes/OpenAPIRoute.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/OpenAPIRoute.ts#L54)
 
 #### Returns
 
@@ -58,7 +58,7 @@ Defined in: [src/routes/OpenAPIRoute.ts:54](https://github.com/rapidrest/service
 
 > **getJSON**(): `any`
 
-Defined in: [src/routes/OpenAPIRoute.ts:71](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/OpenAPIRoute.ts#L71)
+Defined in: [src/routes/OpenAPIRoute.ts:71](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/OpenAPIRoute.ts#L71)
 
 #### Returns
 
@@ -70,7 +70,7 @@ Defined in: [src/routes/OpenAPIRoute.ts:71](https://github.com/rapidrest/service
 
 > **getYAML**(): `string`
 
-Defined in: [src/routes/OpenAPIRoute.ts:80](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/OpenAPIRoute.ts#L80)
+Defined in: [src/routes/OpenAPIRoute.ts:80](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/OpenAPIRoute.ts#L80)
 
 #### Returns