npm - @rapidrest/service-core - Versions diffs - 1.0.0-rc.7 → 1.0.0 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (380) hide show

package/docs/reference/classes/ModelUtils.md DELETED Viewed

@@ -1,446 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / ModelUtils
-# Class: ModelUtils
-Defined in: [src/models/ModelUtils.ts:28](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L28)
-Utility class for working with data model classes.
-## Author
-Jean-Philippe Steinmetz
-## Constructors
-### Constructor
-> **new ModelUtils**(): `ModelUtils`
-#### Returns
-`ModelUtils`
-## Accessors
-### orm
-#### Get Signature
-> **get** `static` **orm**(): `any`
-Defined in: [src/models/ModelUtils.ts:46](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L46)
-Returns the `typeorm` module, throwing an error if it has not been provided.
-##### Returns
-`any`
-## Methods
-### buildIdSearchQuery()
-> `static` **buildIdSearchQuery**\<`T`\>(`repo`, `modelClass`, `id`, `version?`): `any`
-Defined in: [src/models/ModelUtils.ts:99](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L99)
-Builds a query object for use with `find` functions of the given repository for retrieving objects matching the
-specified unique identifier.
-#### Type Parameters
-##### T
-`T` *extends* `object`
-#### Parameters
-##### repo
-`Repository`\<`T`\> \| [`MongoRepository`](MongoRepository.md)\<`T`\> \| `undefined`
-The repository to build the query for.
-##### modelClass
-`any`
-The class definition of the data model to build a search query for.
-##### id
-`any`
-The unique identifier to search for.
-##### version?
-`number`
-The version number of the document to search for.
-#### Returns
-`any`
-An object that can be passed to a TypeORM `find` function.
-***
-### buildIdSearchQueryMongo()
-> `static` **buildIdSearchQueryMongo**(`modelClass`, `id`, `version?`): `any`
-Defined in: [src/models/ModelUtils.ts:147](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L147)
-Builds a MongoDB compatible query object for use in `find` functions for retrieving objects matching the
-specified unique identifier.
-#### Parameters
-##### modelClass
-`any`
-The class definition of the data model to build a search query for.
-##### id
-`any`
-The unique identifier to search for.
-##### version?
-`number`
-The version number of the document to search for.
-#### Returns
-`any`
-An object that can be passed to a MongoDB `find` function.
-***
-### buildIdSearchQuerySQL()
-> `static` **buildIdSearchQuerySQL**(`modelClass`, `id`, `version?`): `any`
-Defined in: [src/models/ModelUtils.ts:121](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L121)
-Builds a TypeORM compatible query object for use in `find` functions for retrieving objects matching the
-specified unique identifier.
-#### Parameters
-##### modelClass
-`any`
-The class definition of the data model to build a search query for.
-##### id
-`any`
-The unique identifier to search for.
-##### version?
-`number`
-The version number of the document to search for.
-#### Returns
-`any`
-An object that can be passed to a TypeORM `find` function.
-***
-### buildSearchQuery()
-> `static` **buildSearchQuery**\<`T`\>(`modelClass`, `repo`, `params?`, `queryParams?`, `exactMatch?`, `user?`): `any`
-Defined in: [src/models/ModelUtils.ts:374](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L374)
-Builds a query object for the given criteria and repository. Query params can have a value containing a
-conditional operator to apply for the search. The operator is encoded with the format `op(value)`. The following
-operators are supported:
-* `eq` - Returns matches whose parameter exactly matches of the given value. e.g. `param = value`
-* `gt` - Returns matches whose parameter is greater than the given value. e.g. `param > value`
-* `gte` - Returns matches whose parameter is greater than or equal to the given value. e.g. `param >= value`
-* `in` - Returns matches whose parameter includes one of the given values. e.g. `param in ('value1', 'value2', 'value3', ...)`
-* `like` - Returns matches whose parameter is lexographically similar to the given value. `param like value`
-* `lt` -  Returns matches whose parameter is less than the given value. e.g. `param < value`
-* `lte` - Returns matches whose parameter is less than or equal to than the given value. e.g. `param < value`
-* `not` - Returns matches whose parameter is not equal to the given value. e.g. `param not value`
-* `range` - Returns matches whose parameter is greater than or equal to first given value and less than or equal to the second. e.g. `param between(1,100)`
-When no operator is provided the comparison will always be evaluated as `eq`.
-NOTE: The result of this function is only compatible with the `aggregate()` function when MongoDB is used.
-#### Type Parameters
-##### T
-`T` *extends* `object`
-#### Parameters
-##### modelClass
-`any`
-The class definition of the data model to build a search query for.
-##### repo
-`Repository`\<`T`\> \| [`MongoRepository`](MongoRepository.md)\<`T`\> \| `undefined`
-The repository to build a search query for.
-##### params?
-`any`
-The URI parameters for the endpoint that was requested.
-##### queryParams?
-`any`
-The URI query parameters that were included in the request.
-##### exactMatch?
-`boolean` = `false`
-Set to true to create a query where parameters are to be matched exactly, otherwise set to false to use a 'contains' search.
-##### user?
-`any`
-The user that is performing the request.
-#### Returns
-`any`
-The TypeORM compatible query object.
-***
-### buildSearchQueryMongo()
-> `static` **buildSearchQueryMongo**(`modelClass`, `params?`, `queryParams?`, `exactMatch?`, `user?`): `any`
-Defined in: [src/models/ModelUtils.ts:564](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L564)
-Builds a MongoDB compatible query object for the given criteria. Query params can have a value containing a
-conditional operator to apply for the search. The operator is encoded with the format `op(value)`. The following
-operators are supported:
-* `eq` - Returns matches whose parameter exactly matches of the given value. e.g. `param = value`
-* `gt` - Returns matches whose parameter is greater than the given value. e.g. `param > value`
-* `gte` - Returns matches whose parameter is greater than or equal to the given value. e.g. `param >= value`
-* `in` - Returns matches whose parameter includes one of the given values. e.g. `param in ('value1', 'value2', 'value3', ...)`
-* `like` - Returns matches whose parameter is lexographically similar to the given value. `param like value`
-* `lt` -  Returns matches whose parameter is less than the given value. e.g. `param < value`
-* `lte` - Returns matches whose parameter is less than or equal to than the given value. e.g. `param < value`
-* `not` - Returns matches whose parameter is not equal to the given value. e.g. `param not value`
-* `range` - Returns matches whose parameter is greater than or equal to first given value and less than or equal to the second. e.g. `param between(1,100)`
-When no operator is provided the comparison will always be evaluated as `eq`.
-NOTE: The result of this function is only compatible with the `aggregate()` function.
-#### Parameters
-##### modelClass
-`any`
-The class definition of the data model to build a search query for.
-##### params?
-`any`
-The URI parameters for the endpoint that was requested.
-##### queryParams?
-`any`
-The URI query parameters that were included in the request.
-##### exactMatch?
-`boolean` = `false`
-Set to true to create a query where parameters are to be matched exactly, otherwise set to false to use a 'contains' search.
-##### user?
-`any`
-The user that is performing the request.
-#### Returns
-`any`
-The TypeORM compatible query object.
-***
-### buildSearchQuerySQL()
-> `static` **buildSearchQuerySQL**(`modelClass`, `params?`, `queryParams?`, `exactMatch?`, `user?`): `any`
-Defined in: [src/models/ModelUtils.ts:420](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L420)
-Builds a TypeORM compatible query object for the given criteria. Query params can have a value containing a
-conditional operator to apply for the search. The operator is encoded with the format `op(value)`. The following
-operators are supported:
-* `eq` - Returns matches whose parameter exactly matches of the given value. e.g. `param = value`
-* `gt` - Returns matches whose parameter is greater than the given value. e.g. `param > value`
-* `gte` - Returns matches whose parameter is greater than or equal to the given value. e.g. `param >= value`
-* `in` - Returns matches whose parameter includes one of the given values. e.g. `param in ('value1', 'value2', 'value3', ...)`
-* `like` - Returns matches whose parameter is lexographically similar to the given value. `param like value`
-* `lt` -  Returns matches whose parameter is less than the given value. e.g. `param < value`
-* `lte` - Returns matches whose parameter is less than or equal to than the given value. e.g. `param < value`
-* `not` - Returns matches whose parameter is not equal to the given value. e.g. `param not value`
-* `range` - Returns matches whose parameter is greater than or equal to first given value and less than or equal to the second. e.g. `param between(1,100)`
-When no operator is provided the comparison will always be evaluated as `eq`.
-#### Parameters
-##### modelClass
-`any`
-The class definition of the data model to build a search query for.
-##### params?
-`any`
-The URI parameters for the endpoint that was requested.
-##### queryParams?
-`any`
-The URI query parameters that were included in the request.
-##### exactMatch?
-`boolean` = `false`
-Set to true to create a query where parameters are to be matched exactly, otherwise set to false to use a 'contains' search.
-##### user?
-`any`
-The user that is performing the request.
-#### Returns
-`any`
-The TypeORM compatible query object.
-***
-### getIdPropertyNames()
-> `static` **getIdPropertyNames**(`modelClass`): `string`[]
-Defined in: [src/models/ModelUtils.ts:61](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L61)
-Retrieves a list of all of the specified class's properties that have the
-#### Parameters
-##### modelClass
-`any`
-The class definition to search for identifiers from.
-#### Returns
-`string`[]
-The list of all property names that have the
-#### Identifier
-decorator applied.
-#### Identifier
-decorator applied.
-***
-### loadModels()
-> `static` **loadModels**(`src`, `result?`): `Promise`\<`Map`\<`string`, `any`\>\>
-Defined in: [src/models/ModelUtils.ts:716](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L716)
-Loads all model schema files from the specified path and returns a map containing all the definitions.
-#### Parameters
-##### src
-`string`
-The path to the model files to load.
-##### result?
-`Map`\<`string`, `any`\> = `...`
-#### Returns
-`Promise`\<`Map`\<`string`, `any`\>\>
-A map containing of all loaded model names to their class definitions.
-***
-### setTypeOrm()
-> `static` **setTypeOrm**(`module`): `void`
-Defined in: [src/models/ModelUtils.ts:39](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/ModelUtils.ts#L39)
-Provides the `typeorm` module to use when building SQL queries. This is called automatically when a SQL
-datastore connection is established.
-#### Parameters
-##### module
-`any`
-The `typeorm` module.
-#### Returns
-`void`

package/docs/reference/classes/MongoConnection.md DELETED Viewed

@@ -1,218 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / MongoConnection
-# Class: MongoConnection
-Defined in: [src/database/MongoConnection.ts:17](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L17)
-Represents a single named connection to a MongoDB database using the native `mongodb` driver, including the
-registry of all model classes assigned to the connection's datastore.
-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>
-## Constructors
-### Constructor
-> **new MongoConnection**(`name`, `client`, `db`, `entities?`): `MongoConnection`
-Defined in: [src/database/MongoConnection.ts:29](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L29)
-#### Parameters
-##### name
-`string`
-##### client
-`MongoClient`
-##### db
-`Db`
-##### entities?
-`Iterable`\<`any`, `any`, `any`\>
-#### Returns
-`MongoConnection`
-## Properties
-### client
-> `readonly` **client**: `MongoClient`
-Defined in: [src/database/MongoConnection.ts:19](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L19)
-The underlying MongoDB client.
-***
-### db
-> `readonly` **db**: `Db`
-Defined in: [src/database/MongoConnection.ts:21](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L21)
-The database that this connection is bound to.
-***
-### name
-> `readonly` **name**: `string`
-Defined in: [src/database/MongoConnection.ts:23](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L23)
-The name of the datastore that this connection was created for.
-## Accessors
-### entityClasses
-#### Get Signature
-> **get** **entityClasses**(): `any`[]
-Defined in: [src/database/MongoConnection.ts:71](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L71)
-Returns the list of all model classes registered with this connection.
-##### Returns
-`any`[]
-***
-### isConnected
-#### Get Signature
-> **get** **isConnected**(): `boolean`
-Defined in: [src/database/MongoConnection.ts:42](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L42)
-Indicates whether or not the connection is currently active.
-##### Returns
-`boolean`
-## Methods
-### admin()
-> **admin**(): `Admin`
-Defined in: [src/database/MongoConnection.ts:47](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L47)
-Returns the admin interface of the underlying database.
-#### Returns
-`Admin`
-***
-### close()
-> **close**(): `Promise`\<`void`\>
-Defined in: [src/database/MongoConnection.ts:54](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L54)
-Closes the connection to the database server.
-#### Returns
-`Promise`\<`void`\>
-***
-### collectionNameFor()
-> **collectionNameFor**(`clazz`): `string`
-Defined in: [src/database/MongoConnection.ts:64](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L64)
-Returns the name of the collection that records of the given model class are stored in.
-#### Parameters
-##### clazz
-`any`
-The model class to resolve the collection name for.
-#### Returns
-`string`
-***
-### getMongoRepository()
-> **getMongoRepository**\<`T`\>(`classOrName`): [`MongoRepository`](MongoRepository.md)\<`T`\>
-Defined in: [src/database/MongoConnection.ts:105](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L105)
-Returns a repository for performing operations against the collection associated with the given model class.
-This is an alias of `getRepository` provided for compatibility with TypeORM's `DataSource` interface.
-#### Type Parameters
-##### T
-`T` *extends* `object` = `any`
-#### Parameters
-##### classOrName
-`any`
-The model class, or the name of a registered model class, to retrieve a repository for.
-#### Returns
-[`MongoRepository`](MongoRepository.md)\<`T`\>
-***
-### getRepository()
-> **getRepository**\<`T`\>(`classOrName`): [`MongoRepository`](MongoRepository.md)\<`T`\>
-Defined in: [src/database/MongoConnection.ts:80](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/database/MongoConnection.ts#L80)
-Returns a repository for performing operations against the collection associated with the given model class.
-#### Type Parameters
-##### T
-`T` *extends* `object` = `any`
-#### Parameters
-##### classOrName
-`any`
-The model class, or the name of a registered model class, to retrieve a repository for.
-#### Returns
-[`MongoRepository`](MongoRepository.md)\<`T`\>