@rapidrest/service-core 1.0.0-rc.2 → 1.0.0-rc.21

package/docs/reference/classes/MongoRepository.md

@@ -1,390 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / MongoRepository
-
-# Class: MongoRepository\<T\>
-
-Defined in: [src/database/MongoRepository.ts:28](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L28)
-
-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`.
-
-Note that this class only references the `mongodb` package via type-only imports and is therefore safe to load
-when the optional `mongodb` peer dependency is not installed.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Type Parameters
-
-### T
-
-`T` *extends* `Document` = `any`
-
-## Constructors
-
-### Constructor
-
-> **new MongoRepository**\<`T`\>(`db`, `collection`, `modelClass?`): `MongoRepository`\<`T`\>
-
-Defined in: [src/database/MongoRepository.ts:36](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L36)
-
-#### Parameters
-
-##### db
-
-`Db`
-
-##### collection
-
-`Collection`\<`T`\>
-
-##### modelClass?
-
-`any`
-
-#### Returns
-
-`MongoRepository`\<`T`\>
-
-## Properties
-
-### collection
-
-> `readonly` **collection**: `Collection`\<`T`\>
-
-Defined in: [src/database/MongoRepository.ts:32](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L32)
-
-The underlying MongoDB collection that operations are performed against.
-
-***
-
-### db
-
-> `readonly` **db**: `Db`
-
-Defined in: [src/database/MongoRepository.ts:30](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L30)
-
-The database that the underlying collection belongs to.
-
-***
-
-### modelClass
-
-> `readonly` **modelClass**: `any`
-
-Defined in: [src/database/MongoRepository.ts:34](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L34)
-
-The model class associated with this repository.
-
-## Accessors
-
-### collectionName
-
-#### Get Signature
-
-> **get** **collectionName**(): `string`
-
-Defined in: [src/database/MongoRepository.ts:43](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L43)
-
-The name of the underlying MongoDB collection.
-
-##### Returns
-
-`string`
-
-## Methods
-
-### aggregate()
-
-> **aggregate**(`pipeline`): `AggregationCursor`\<`any`\>
-
-Defined in: [src/database/MongoRepository.ts:52](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L52)
-
-Executes the given aggregation pipeline against the collection and returns the resulting cursor.
-
-#### Parameters
-
-##### pipeline
-
-`Document`[]
-
-The aggregation pipeline stages to execute.
-
-#### Returns
-
-`AggregationCursor`\<`any`\>
-
-***
-
-### clear()
-
-> **clear**(): `Promise`\<`void`\>
-
-Defined in: [src/database/MongoRepository.ts:60](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L60)
-
-Drops the entire collection from the database, removing all documents and indexes. Does nothing if the
-collection does not exist.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### count()
-
-> **count**(`filter?`, `options?`): `Promise`\<`number`\>
-
-Defined in: [src/database/MongoRepository.ts:70](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L70)
-
-Returns the number of documents matching the given filter.
-
-#### Parameters
-
-##### filter?
-
-`Filter`\<`T`\>
-
-The filter for the count
-
-##### options?
-
-`CountDocumentsOptions`
-
-Optional settings for the command
-
-#### Returns
-
-`Promise`\<`number`\>
-
-***
-
-### deleteMany()
-
-> **deleteMany**(`filter`, `options?`): `Promise`\<`DeleteResult`\>
-
-Defined in: [src/database/MongoRepository.ts:80](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L80)
-
-Deletes all documents matching the given filter.
-
-#### Parameters
-
-##### filter
-
-`Filter`\<`T`\>
-
-The query filter to match documents against.
-
-##### options?
-
-`DeleteOptions`
-
-Optional settings for the command
-
-#### Returns
-
-`Promise`\<`DeleteResult`\>
-
-***
-
-### deleteOne()
-
-> **deleteOne**(`filter?`, `options?`): `Promise`\<`DeleteResult`\>
-
-Defined in: [src/database/MongoRepository.ts:90](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L90)
-
-Deletes the first document matching the given filter.
-
-#### Parameters
-
-##### filter?
-
-`Filter`\<`T`\>
-
-The query filter to match documents against.
-
-##### options?
-
-`DeleteOptions`
-
-Optional settings for the command
-
-#### Returns
-
-`Promise`\<`DeleteResult`\>
-
-***
-
-### distinct()
-
-> **distinct**(`field`, `filter?`): `Promise`\<`any`[]\>
-
-Defined in: [src/database/MongoRepository.ts:100](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L100)
-
-Returns the list of distinct values of the given field for all documents matching the given filter.
-
-#### Parameters
-
-##### field
-
-`string`
-
-The name of the document field to return distinct values of.
-
-##### filter?
-
-`Filter`\<`T`\>
-
-The query filter to match documents against.
-
-#### Returns
-
-`Promise`\<`any`[]\>
-
-***
-
-### find()
-
-> **find**(`filter?`, `options?`): `FindCursor`\<`T`\>
-
-Defined in: [src/database/MongoRepository.ts:110](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L110)
-
-Returns all documents matching the given filter.
-
-#### Parameters
-
-##### filter?
-
-`Filter`\<`T`\>
-
-The query filter to match documents against.
-
-##### options?
-
-`FindOptions`
-
-Optional settings for the command
-
-#### Returns
-
-`FindCursor`\<`T`\>
-
-***
-
-### findOne()
-
-> **findOne**(`filter`): `Promise`\<`T` \| `null`\>
-
-Defined in: [src/database/MongoRepository.ts:119](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L119)
-
-Returns the first document matching the given filter.
-
-#### Parameters
-
-##### filter
-
-`any`
-
-The query filter to match documents against.
-
-#### Returns
-
-`Promise`\<`T` \| `null`\>
-
-***
-
-### save()
-
-> **save**(`doc`): `Promise`\<`T`\>
-
-Defined in: [src/database/MongoRepository.ts:131](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L131)
-
-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
-the returned object.
-
-#### Parameters
-
-##### doc
-
-`any`
-
-The document to save.
-
-#### Returns
-
-`Promise`\<`T`\>
-
-The saved document.
-
-***
-
-### updateMany()
-
-> **updateMany**(`filter`, `update`, `options?`): `Promise`\<`UpdateResult`\<`T`\>\>
-
-Defined in: [src/database/MongoRepository.ts:157](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L157)
-
-Updates all documents matching the given filter with the provided update operations.
-
-#### Parameters
-
-##### filter
-
-`any`
-
-The query filter to match documents against.
-
-##### update
-
-`any`
-
-The update operations (e.g. `$set`) to apply.
-
-##### options?
-
-`UpdateOptions`
-
-Optional settings for the command
-
-#### Returns
-
-`Promise`\<`UpdateResult`\<`T`\>\>
-
-***
-
-### updateOne()
-
-> **updateOne**(`filter`, `update`, `options?`): `Promise`\<`UpdateResult`\<`T`\>\>
-
-Defined in: [src/database/MongoRepository.ts:168](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoRepository.ts#L168)
-
-Updates the first document matching the given filter with the provided update operations.
-
-#### Parameters
-
-##### filter
-
-`any`
-
-The query filter to match documents against.
-
-##### update
-
-`any`
-
-The update operations (e.g. `$set`) to apply.
-
-##### options?
-
-`UpdateOptions`
-
-Optional settings for the command
-
-#### Returns
-
-`Promise`\<`UpdateResult`\<`T`\>\>

package/docs/reference/classes/MongoSchemaSync.md

@@ -1,97 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / MongoSchemaSync
-
-# Class: MongoSchemaSync
-
-Defined in: [src/database/MongoSchemaSync.ts:40](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoSchemaSync.ts#L40)
-
-Performs structure synchronization of MongoDB collections based on the persistence metadata of model classes.
-
-For each collection associated with a model class the following operations are performed:
-- The collection is created if it does not already exist.
-- Indexes declared via the `@Index` and `@Unique` decorators are created if missing.
-- Existing declared indexes whose definition has changed are dropped and re-created.
-
-The synchronization process never drops collections or data, never modifies the built-in `_id_` index, and never
-drops indexes that are not declared by the model class (e.g. shard keys or manually created indexes).
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Constructors
-
-### Constructor
-
-> **new MongoSchemaSync**(`db`, `logger?`): `MongoSchemaSync`
-
-Defined in: [src/database/MongoSchemaSync.ts:44](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoSchemaSync.ts#L44)
-
-#### Parameters
-
-##### db
-
-`Db`
-
-##### logger?
-
-`any`
-
-#### Returns
-
-`MongoSchemaSync`
-
-## Methods
-
-### resolveCollectionInfo()
-
-> **resolveCollectionInfo**(`clazz`): `CollectionInfo`
-
-Defined in: [src/database/MongoSchemaSync.ts:62](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoSchemaSync.ts#L62)
-
-Resolves the entity info of the database collection (or table) that records of the given model class are stored in.
-
-The entity info is resolved using the following rules:
-1. The nearest class in the inheritance chain (starting with `clazz` itself) that specifies an explicit
-entity info via the `@Entity(info)` 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, a new info object containing the snake_case form of the class name.
-
-#### Parameters
-
-##### clazz
-
-`any`
-
-The model class to resolve the collection name for.
-
-#### Returns
-
-`CollectionInfo`
-
-***
-
-### synchronize()
-
-> **synchronize**(`entities`): `Promise`\<`void`\>
-
-Defined in: [src/database/MongoSchemaSync.ts:98](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/MongoSchemaSync.ts#L98)
-
-Synchronizes the structure of all collections associated with the given model classes.
-
-#### Parameters
-
-##### entities
-
-`Iterable`\<`any`\>
-
-The list of model classes to synchronize collections for.
-
-#### Returns
-
-`Promise`\<`void`\>

package/docs/reference/classes/NetUtils.md

@@ -1,90 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / NetUtils
-
-# Class: NetUtils
-
-Defined in: [src/NetUtils.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/NetUtils.ts#L12)
-
-Provides common utilities and functions for working with networking related problems.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Constructors
-
-### Constructor
-
-> **new NetUtils**(): `NetUtils`
-
-#### Returns
-
-`NetUtils`
-
-## Methods
-
-### getIPAddress()
-
-> `static` **getIPAddress**(`urlOrRequest`, `trustedProxies?`): `string` \| `undefined`
-
-Defined in: [src/NetUtils.ts:57](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/NetUtils.ts#L57)
-
-Extracts the IP address from a given url or HTTP request.
-
-When `trustedProxies` is provided, forwarding headers (`X-Forwarded-For`, etc.) are
-only trusted when the direct connection's `remoteAddress` is in that list. Without a
-trusted-proxy list the headers are ignored and the socket address is returned directly,
-preventing clients from spoofing their IP in audit logs.
-
-#### Parameters
-
-##### urlOrRequest
-
-`string` \| [`HttpRequest`](../interfaces/HttpRequest.md)
-
-The url or HTTP request to extract the IP from.
-
-##### trustedProxies?
-
-`string`[]
-
-Optional list of proxy IP addresses whose forwarding headers should be trusted.
-
-#### Returns
-
-`string` \| `undefined`
-
-A `string` containing the IP address if found, otherwise `undefined`.
-
-***
-
-### lookupIPAddress()
-
-> `static` **lookupIPAddress**(`url`, `family?`): `Promise`\<`string` \| `undefined`\>
-
-Defined in: [src/NetUtils.ts:20](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/NetUtils.ts#L20)
-
-Performs DNS lookup of the IP address from a given url.
-
-#### Parameters
-
-##### url
-
-`string`
-
-The url to lookup the IP from.
-
-##### family?
-
-`number` = `4`
-
-ip family used for dns lookup
-
-#### Returns
-
-`Promise`\<`string` \| `undefined`\>
-
-A `string` containing the IP address if found, otherwise `undefined`.

package/docs/reference/classes/NotificationUtils.md

@@ -1,77 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / NotificationUtils
-
-# Class: NotificationUtils
-
-Defined in: [src/NotificationUtils.ts:11](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/NotificationUtils.ts#L11)
-
-Utility functions for sending push notifications to registered clients.
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Constructors
-
-### Constructor
-
-> **new NotificationUtils**(`redis`): `NotificationUtils`
-
-Defined in: [src/NotificationUtils.ts:20](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/NotificationUtils.ts#L20)
-
-Initializes the utility using the given redis connection.
-
-#### Parameters
-
-##### redis
-
-`Redis`
-
-The redis connection to publish to.
-
-#### Returns
-
-`NotificationUtils`
-
-## Methods
-
-### sendMessage()
-
-> **sendMessage**(`uids`, `type`, `action`, `data`): `void`
-
-Defined in: [src/NotificationUtils.ts:32](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/NotificationUtils.ts#L32)
-
-Sends a given message to the room or user with the specified uid(s).
-
-#### Parameters
-
-##### uids
-
-`string` \| `string`[]
-
-The universally unique identifier of the room or user to send the message to.
-
-##### type
-
-`string`
-
-The type of message being sent.
-
-##### action
-
-`string`
-
-The action performed on the data (if applicable).
-
-##### data
-
-`any`
-
-The contents of the message to send to the room or user.
-
-#### Returns
-
-`void`