@rapidrest/service-core 1.0.0-beta.1

package/docs/reference/classes/MetricsRoute.md

@@ -0,0 +1,27 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / MetricsRoute
+
+# Class: MetricsRoute
+
+Defined in: [src/routes/MetricsRoute.ts:19](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/MetricsRoute.ts#L19)
+
+Handles all REST API requests for the endpoint `/metrics'. This route handler produces Prometheus compatible metrics
+for use with a Prometheus based server.
+
+Services that wish to provide metrics to be exposed via this route can register them using the global registry
+from the provided `prom-client` dependency. See the `prom-client` documentation for more details.
+
+## Constructors
+
+### Constructor
+
+> **new MetricsRoute**(): `MetricsRoute`
+
+Defined in: [src/routes/MetricsRoute.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/MetricsRoute.ts#L30)
+
+#### Returns
+
+`MetricsRoute`

package/docs/reference/classes/ModelRoute.md

@@ -0,0 +1,527 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / ModelRoute
+
+# Abstract Class: ModelRoute\<T\>
+
+Defined in: [src/routes/ModelRoute.ts:117](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L117)
+
+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:119](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L119)
+
+***
+
+### cacheClient?
+
+> `protected` `optional` **cacheClient?**: `Redis`
+
+Defined in: [src/routes/ModelRoute.ts:123](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L123)
+
+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:127](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L127)
+
+The global application configuration.
+
+***
+
+### defaultACLUid
+
+> `protected` **defaultACLUid**: `string` = `""`
+
+Defined in: [src/routes/ModelRoute.ts:130](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L130)
+
+The unique identifier of the default ACL for the model type.
+
+***
+
+### logger
+
+> `protected` **logger**: `any`
+
+Defined in: [src/routes/ModelRoute.ts:133](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L133)
+
+***
+
+### notificationUtils?
+
+> `protected` `optional` **notificationUtils?**: [`NotificationUtils`](NotificationUtils.md)
+
+Defined in: [src/routes/ModelRoute.ts:136](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L136)
+
+***
+
+### objectFactory?
+
+> `protected` `optional` **objectFactory?**: [`ObjectFactory`](ObjectFactory.md)
+
+Defined in: [src/routes/ModelRoute.ts:139](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L139)
+
+***
+
+### repoUtils?
+
+> `protected` `optional` **repoUtils?**: [`RepoUtils`](RepoUtils.md)\<`T`\>
+
+Defined in: [src/routes/ModelRoute.ts:145](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L145)
+
+The repository utility class to use for common operations.
+
+***
+
+### repoUtilsClass
+
+> `abstract` `protected` `readonly` **repoUtilsClass**: `any`
+
+Defined in: [src/routes/ModelRoute.ts:142](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L142)
+
+The class of the RepoUtils to use when instantiating the utility.
+
+***
+
+### trackChanges
+
+> `protected` **trackChanges**: `number` = `0`
+
+Defined in: [src/routes/ModelRoute.ts:151](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L151)
+
+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:154](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L154)
+
+## Accessors
+
+### modelClass
+
+#### Get Signature
+
+> **get** `protected` **modelClass**(): `any`
+
+Defined in: [src/routes/ModelRoute.ts:159](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L159)
+
+The class type of the model this route is associated with.
+
+##### Returns
+
+`any`
+
+## Methods
+
+### doBulkCreate()
+
+> `protected` **doBulkCreate**(`objs`, `options`): `Promise`\<`T`[]\>
+
+Defined in: [src/routes/ModelRoute.ts:258](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L258)
+
+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()
+
+> `protected` **doBulkUpdate**(`objs`, `options`): `Promise`\<`T`[]\>
+
+Defined in: [src/routes/ModelRoute.ts:517](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L517)
+
+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()
+
+> `protected` **doCount**(`options`): `Promise`\<`HttpResponse`\>
+
+Defined in: [src/routes/ModelRoute.ts:191](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L191)
+
+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`\>
+
+***
+
+### doCreate()
+
+> `protected` **doCreate**(`obj`, `options`): `Promise`\<`T` \| `T`[]\>
+
+Defined in: [src/routes/ModelRoute.ts:288](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L288)
+
+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()
+
+> `protected` **doCreateObject**(`obj`, `options`): `Promise`\<`T`\>
+
+Defined in: [src/routes/ModelRoute.ts:228](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L228)
+
+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()
+
+> `protected` **doDelete**(`id`, `options`): `Promise`\<`void`\>
+
+Defined in: [src/routes/ModelRoute.ts:313](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L313)
+
+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()
+
+> `protected` **doExists**(`id`, `options`): `Promise`\<`any`\>
+
+Defined in: [src/routes/ModelRoute.ts:359](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L359)
+
+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()
+
+> `protected` **doFindAll**(`options`): `Promise`\<`T`[]\>
+
+Defined in: [src/routes/ModelRoute.ts:400](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L400)
+
+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()
+
+> `protected` **doFindById**(`id`, `options`): `Promise`\<`T` \| `null`\>
+
+Defined in: [src/routes/ModelRoute.ts:435](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L435)
+
+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()
+
+> `protected` **doTruncate**(`options`): `Promise`\<`void`\>
+
+Defined in: [src/routes/ModelRoute.ts:477](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L477)
+
+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()
+
+> `protected` **doUpdate**(`id`, `obj`, `options`): `Promise`\<`T`\>
+
+Defined in: [src/routes/ModelRoute.ts:545](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L545)
+
+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()
+
+> `protected` **doUpdateProperty**(`id`, `propertyName`, `value`, `options`): `Promise`\<`T`\>
+
+Defined in: [src/routes/ModelRoute.ts:596](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L596)
+
+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()
+
+> `protected` **doValidate**(`objs`, `options?`): `Promise`\<`void`\>
+
+Defined in: [src/routes/ModelRoute.ts:642](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L642)
+
+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`\>