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

package/docs/reference/classes/ModelRoute.md

@@ -1,527 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / ModelRoute
-
-# Abstract Class: ModelRoute\<T\>
-
-Defined in: [src/routes/ModelRoute.ts:113](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L113)
-
-The `ModelRoute` is an abstract base class that provides a set of built-in route behavior functions for handling
-requests for a given data model that is managed by a persistent datastore.
-
-Provided behaviors:
-* `count` - Counts the number of objects matching the provided set of criteria in the request's query parameters.
-* `create` - Adds a new object to the datastore.
-* `delete` - Removes an existing object from the datastore.
-* `find` - Finds all objects matching the provided set of criteria in the request's query parameters.
-* `findById` - Finds a single object with a specified unique identifier.
-* `truncate` - Removes all objects from the datastore.
-* `update` - Modifies an existing object in the datastore.
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`BaseEntity`](BaseEntity.md) \| [`SimpleEntity`](SimpleEntity.md)
-
-## Constructors
-
-### Constructor
-
-> **new ModelRoute**\<`T`\>(): `ModelRoute`\<`T`\>
-
-#### Returns
-
-`ModelRoute`\<`T`\>
-
-## Properties
-
-### aclUtils?
-
-> `protected` `optional` **aclUtils?**: [`ACLUtils`](ACLUtils.md)
-
-Defined in: [src/routes/ModelRoute.ts:115](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L115)
-
-***
-
-### cacheClient?
-
-> `protected` `optional` **cacheClient?**: `Redis`
-
-Defined in: [src/routes/ModelRoute.ts:119](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L119)
-
-The redis client that will be used as a 2nd level cache for all cacheable models.
-
-***
-
-### config?
-
-> `protected` `optional` **config?**: `any`
-
-Defined in: [src/routes/ModelRoute.ts:123](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L123)
-
-The global application configuration.
-
-***
-
-### defaultACLUid
-
-> `protected` **defaultACLUid**: `string` = `""`
-
-Defined in: [src/routes/ModelRoute.ts:126](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L126)
-
-The unique identifier of the default ACL for the model type.
-
-***
-
-### logger
-
-> `protected` **logger**: `any`
-
-Defined in: [src/routes/ModelRoute.ts:129](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L129)
-
-***
-
-### notificationUtils?
-
-> `protected` `optional` **notificationUtils?**: [`NotificationUtils`](NotificationUtils.md)
-
-Defined in: [src/routes/ModelRoute.ts:132](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L132)
-
-***
-
-### objectFactory?
-
-> `protected` `optional` **objectFactory?**: [`ObjectFactory`](ObjectFactory.md)
-
-Defined in: [src/routes/ModelRoute.ts:135](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L135)
-
-***
-
-### repoUtils?
-
-> `protected` `optional` **repoUtils?**: [`RepoUtils`](RepoUtils.md)\<`T`\>
-
-Defined in: [src/routes/ModelRoute.ts:141](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L141)
-
-The repository utility class to use for common operations.
-
-***
-
-### repoUtilsClass
-
-> `abstract` `protected` `readonly` **repoUtilsClass**: `any`
-
-Defined in: [src/routes/ModelRoute.ts:138](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L138)
-
-The class of the RepoUtils to use when instantiating the utility.
-
-***
-
-### trackChanges
-
-> `protected` **trackChanges**: `number` = `0`
-
-Defined in: [src/routes/ModelRoute.ts:147](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L147)
-
-The number of previous document versions to store in the database. A negative value indicates storing all
-versions, a value of `0` stores no versions.
-
-***
-
-### trustedRoles
-
-> `protected` **trustedRoles**: `string`[]
-
-Defined in: [src/routes/ModelRoute.ts:150](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L150)
-
-## Accessors
-
-### modelClass
-
-#### Get Signature
-
-> **get** **modelClass**(): `any`
-
-Defined in: [src/routes/ModelRoute.ts:155](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L155)
-
-The class type of the model this route is associated with.
-
-##### Returns
-
-`any`
-
-## Methods
-
-### doBulkCreate()
-
-> **doBulkCreate**(`objs`, `options`): `Promise`\<`T`[]\>
-
-Defined in: [src/routes/ModelRoute.ts:253](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L253)
-
-Attempts to store a collection of objects provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
-object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
-client.
-
-#### Parameters
-
-##### objs
-
-`Partial`\<`T`\>[]
-
-The object(s) to store in the database.
-
-##### options
-
-[`CreateRequestOptions`](../interfaces/CreateRequestOptions.md)
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`T`[]\>
-
-***
-
-### doBulkUpdate()
-
-> **doBulkUpdate**(`objs`, `options`): `Promise`\<`T`[]\>
-
-Defined in: [src/routes/ModelRoute.ts:511](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L511)
-
-Attempts to modify a collection of existing data model objects.
-
-#### Parameters
-
-##### objs
-
-[`UpdateObject`](../type-aliases/UpdateObject.md)\<`T`\>[]
-
-The object(s) to bulk update in the database.
-
-##### options
-
-[`UpdateRequestOptions`](../interfaces/UpdateRequestOptions.md)\<`T`\>
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`T`[]\>
-
-***
-
-### doCount()
-
-> **doCount**(`options`): `Promise`\<[`HttpResponse`](../interfaces/HttpResponse.md)\>
-
-Defined in: [src/routes/ModelRoute.ts:187](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L187)
-
-Attempts to retrieve the number of data model objects matching the given set of criteria as specified in the
-request `query`. Any results that have been found are set to the `content-length` header of the `res` argument.
-
-#### Parameters
-
-##### options
-
-[`FindRequestOptions`](../interfaces/FindRequestOptions.md)
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<[`HttpResponse`](../interfaces/HttpResponse.md)\>
-
-***
-
-### doCreate()
-
-> **doCreate**(`obj`, `options`): `Promise`\<`T` \| `T`[]\>
-
-Defined in: [src/routes/ModelRoute.ts:283](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L283)
-
-Attempts to store one or more objects provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
-object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
-client.
-
-#### Parameters
-
-##### obj
-
-`Partial`\<`T`\> \| `Partial`\<`T`\>[]
-
-The object(s) to store in the database.
-
-##### options
-
-[`CreateRequestOptions`](../interfaces/CreateRequestOptions.md)
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`T` \| `T`[]\>
-
-***
-
-### doCreateObject()
-
-> **doCreateObject**(`obj`, `options`): `Promise`\<`T`\>
-
-Defined in: [src/routes/ModelRoute.ts:223](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L223)
-
-Attempts to store an object provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
-object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
-client.
-
-#### Parameters
-
-##### obj
-
-`Partial`\<`T`\>
-
-The object to store in the database.
-
-##### options
-
-[`CreateRequestOptions`](../interfaces/CreateRequestOptions.md)
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`T`\>
-
-***
-
-### doDelete()
-
-> **doDelete**(`id`, `options`): `Promise`\<`void`\>
-
-Defined in: [src/routes/ModelRoute.ts:311](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L311)
-
-Attempts to delete an existing data model object with a given unique identifier encoded by the URI parameter
-`id`.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the object to delete.
-
-##### options
-
-[`DeleteRequestOptions`](../interfaces/DeleteRequestOptions.md)
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### doExists()
-
-> **doExists**(`id`, `options`): `Promise`\<`any`\>
-
-Defined in: [src/routes/ModelRoute.ts:356](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L356)
-
-Attempts to determine if an existing object with the given unique identifier exists.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the object to verify exists.
-
-##### options
-
-[`FindRequestOptions`](../interfaces/FindRequestOptions.md)
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`any`\>
-
-***
-
-### doFindAll()
-
-> **doFindAll**(`options`): `Promise`\<`T`[]\>
-
-Defined in: [src/routes/ModelRoute.ts:397](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L397)
-
-Attempts to retrieve all data model objects matching the given set of criteria as specified in the request
-`query`. Any results that have been found are set to the `result` property of the `res` argument. `result` is
-never null.
-
-#### Parameters
-
-##### options
-
-[`FindRequestOptions`](../interfaces/FindRequestOptions.md)
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`T`[]\>
-
-***
-
-### doFindById()
-
-> **doFindById**(`id`, `options`): `Promise`\<`T` \| `null`\>
-
-Defined in: [src/routes/ModelRoute.ts:431](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L431)
-
-Attempts to retrieve a single data model object as identified by the `id` parameter in the URI.
-
-#### Parameters
-
-##### id
-
-`string`
-
-##### options
-
-[`FindRequestOptions`](../interfaces/FindRequestOptions.md)
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`T` \| `null`\>
-
-***
-
-### doTruncate()
-
-> **doTruncate**(`options`): `Promise`\<`void`\>
-
-Defined in: [src/routes/ModelRoute.ts:472](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L472)
-
-Attempts to remove all entries of the data model type from the datastore matching the given
-parameters and query.
-
-#### Parameters
-
-##### options
-
-[`TruncateRequestOptions`](../interfaces/TruncateRequestOptions.md)
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### doUpdate()
-
-> **doUpdate**(`id`, `obj`, `options`): `Promise`\<`T`\>
-
-Defined in: [src/routes/ModelRoute.ts:539](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L539)
-
-Attempts to modify an existing data model object as identified by the `id` parameter in the URI.
-
-#### Parameters
-
-##### id
-
-`string`
-
-##### obj
-
-[`UpdateObject`](../type-aliases/UpdateObject.md)\<`T`\>
-
-The object to update in the database
-
-##### options
-
-[`UpdateRequestOptions`](../interfaces/UpdateRequestOptions.md)\<`T`\>
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`T`\>
-
-***
-
-### doUpdateProperty()
-
-> **doUpdateProperty**(`id`, `propertyName`, `value`, `options`): `Promise`\<`T`\>
-
-Defined in: [src/routes/ModelRoute.ts:589](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L589)
-
-Attempts to modify a single property of an existing data model object as identified by the `id` parameter in the URI.
-
-Note that this effectively bypasses optimistic locking and can cause unexpected data overwrites. Use with care.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the object to update.
-
-##### propertyName
-
-`string`
-
-The name of the property to update.
-
-##### value
-
-`any`
-
-The value of the property to set.
-
-##### options
-
-[`UpdateRequestOptions`](../interfaces/UpdateRequestOptions.md)\<`T`\>
-
-The options to process the request using.
-
-#### Returns
-
-`Promise`\<`T`\>
-
-***
-
-### doValidate()
-
-> **doValidate**(`objs`, `options?`): `Promise`\<`void`\>
-
-Defined in: [src/routes/ModelRoute.ts:630](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L630)
-
-Calls `repoUtils.validate()` to validate the object(s) provided.
-
-#### Parameters
-
-##### objs
-
-`Partial`\<`T`\> \| `Partial`\<`T`\>[]
-
-##### options?
-
-[`CreateRequestOptions`](../interfaces/CreateRequestOptions.md) \| [`UpdateRequestOptions`](../interfaces/UpdateRequestOptions.md)\<`T`\>
-
-#### Returns
-
-`Promise`\<`void`\>