@rapidrest/service-core 1.0.0-beta.1

package/docs/reference/classes/AuthMiddleware.md

@@ -0,0 +1,131 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / AuthMiddleware
+
+# Class: AuthMiddleware
+
+Defined in: [src/auth/AuthMiddleware.ts:19](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L19)
+
+A set of common utilities for performing authentication using one or more strategies.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Constructors
+
+### Constructor
+
+> **new AuthMiddleware**(): `AuthMiddleware`
+
+#### Returns
+
+`AuthMiddleware`
+
+## Properties
+
+### strategies
+
+> `readonly` **strategies**: `Map`\<`string`, [`AuthStrategy`](../interfaces/AuthStrategy.md)\>
+
+Defined in: [src/auth/AuthMiddleware.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L30)
+
+The authentication strategies that have been registered.
+
+## Methods
+
+### authenticate()
+
+> **authenticate**(`strategies`, `req`, `res?`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `Promise`\<[`AuthResult`](../interfaces/AuthResult.md)\> \| `undefined`
+
+Defined in: [src/auth/AuthMiddleware.ts:54](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L54)
+
+Performs authentication of the given request using one of the provided strategies.
+
+#### Parameters
+
+##### strategies
+
+`string`[]
+
+The list of strategy names to attempt authentication with.
+
+##### req
+
+`HttpRequest`
+
+The request containing data to perform authenticate with.
+
+##### res?
+
+`HttpResponse`
+
+The response to use when writing back directly to the client.
+
+##### required?
+
+`boolean`
+
+Set to `true` to if authentication is required to pass, otherwise set to `false`.
+
+#### Returns
+
+[`AuthResult`](../interfaces/AuthResult.md) \| `Promise`\<[`AuthResult`](../interfaces/AuthResult.md)\> \| `undefined`
+
+***
+
+### authWebSocket()
+
+> **authWebSocket**(`required`): `RequestHandler`
+
+Defined in: [src/auth/AuthMiddleware.ts:95](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L95)
+
+Returns a request handler function that will perform authentication of a websocket connection. Authentication
+can be handled in two ways:
+
+1. Authorization header
+2. Negotiation via handshake
+
+This middleware function primarily provides the implementation for item 2 above.
+
+#### Parameters
+
+##### required
+
+`boolean`
+
+Set to `true` to indicate that auth is required, otherwise `false`.
+
+#### Returns
+
+`RequestHandler`
+
+***
+
+### register()
+
+> **register**(`name`, `strategy`): `void`
+
+Defined in: [src/auth/AuthMiddleware.ts:239](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L239)
+
+Registers the provided authentication strategy to be used
+
+#### Parameters
+
+##### name
+
+`string`
+
+The name of the authentication type to associate the given strategy with
+
+##### strategy
+
+[`AuthStrategy`](../interfaces/AuthStrategy.md)
+
+The strategy to register
+
+#### Returns
+
+`void`

package/docs/reference/classes/BackgroundService.md

@@ -0,0 +1,117 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / BackgroundService
+
+# Abstract Class: BackgroundService
+
+Defined in: [src/BackgroundService.ts:10](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L10)
+
+The `BackgroundService` is an abstract base class for defining scheduled background services. A background service
+executes in the background once on startup or on a set schedule (like a cron job) and performs additional processing.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Constructors
+
+### Constructor
+
+> **new BackgroundService**(`config`, `logger`): `BackgroundService`
+
+Defined in: [src/BackgroundService.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L16)
+
+#### Parameters
+
+##### config
+
+`any`
+
+##### logger
+
+`any`
+
+#### Returns
+
+`BackgroundService`
+
+## Properties
+
+### config
+
+> `protected` **config**: `any`
+
+Defined in: [src/BackgroundService.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L12)
+
+The global application configuration that the service can reference.
+
+***
+
+### logger
+
+> `protected` **logger**: `any`
+
+Defined in: [src/BackgroundService.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L14)
+
+The logging utility to use.
+
+## Accessors
+
+### schedule
+
+#### Get Signature
+
+> **get** `abstract` **schedule**(): `string` \| `undefined`
+
+Defined in: [src/BackgroundService.ts:25](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L25)
+
+Returns the desired execution interval that this service should be scheduled with. If `undefined` is returned
+the service is executed only once.
+
+##### Returns
+
+`string` \| `undefined`
+
+## Methods
+
+### run()
+
+> `abstract` **run**(): `void` \| `Promise`\<`void`\>
+
+Defined in: [src/BackgroundService.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L30)
+
+The processing function to execute at each scheduled interval.
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### start()
+
+> `abstract` **start**(): `void` \| `Promise`\<`void`\>
+
+Defined in: [src/BackgroundService.ts:35](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L35)
+
+Initializes the background service with any defaults.
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### stop()
+
+> `abstract` **stop**(): `void` \| `Promise`\<`void`\>
+
+Defined in: [src/BackgroundService.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundService.ts#L40)
+
+Shuts down the background allowing the service to complete any outstanding tasks.
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>

package/docs/reference/classes/BackgroundServiceManager.md

@@ -0,0 +1,172 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / BackgroundServiceManager
+
+# Class: BackgroundServiceManager
+
+Defined in: [src/BackgroundServiceManager.ts:35](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L35)
+
+The `BackgroundServiceManager` manages all configured background services in the application. It is responsible for
+initializing the jobs, scheduling them and performing any related shutdown tasks. See the `BackgroundService`
+class for details on how to create a background service class to be used by this manager.
+
+## Usage
+To use the manager instantiate a new object and provide the required constructor arguments. Then simply call the
+`startAll` function. When shutting your application down you should call the `stopAll` function.
+
+```
+import { BackgroundServiceManager } from "@rapidrest/service-core";
+
+const manager: BackgroundServiceManager = new BackgroundServiceManager(objectFactory, serviceClasses, config, logger);
+await manager.startAll();
+...
+await manager.stopAll();
+```
+
+You may optionally start and stop individual services using the `start` and `stop` functions respectively.
+
+```
+await manager.start("MyService");
+...
+await manger.stop("MyService");
+```
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Constructors
+
+### Constructor
+
+> **new BackgroundServiceManager**(`objectFactory`, `classes`, `config`, `logger`): `BackgroundServiceManager`
+
+Defined in: [src/BackgroundServiceManager.ts:43](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L43)
+
+#### Parameters
+
+##### objectFactory
+
+[`ObjectFactory`](ObjectFactory.md)
+
+##### classes
+
+##### config
+
+`any`
+
+##### logger
+
+`any`
+
+#### Returns
+
+`BackgroundServiceManager`
+
+## Methods
+
+### getService()
+
+> **getService**(`name`): [`BackgroundService`](BackgroundService.md) \| `undefined`
+
+Defined in: [src/BackgroundServiceManager.ts:55](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L55)
+
+Returns the service instance with the given name.
+
+#### Parameters
+
+##### name
+
+`string`
+
+The name of the background service to retrieve.
+
+#### Returns
+
+[`BackgroundService`](BackgroundService.md) \| `undefined`
+
+***
+
+### start()
+
+> **start**(`serviceName`, `clazz?`, ...`args`): `Promise`\<`void`\>
+
+Defined in: [src/BackgroundServiceManager.ts:81](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L81)
+
+Starts the background service with the given name.
+
+#### Parameters
+
+##### serviceName
+
+`string`
+
+The name of the background service to start.
+
+##### clazz?
+
+`any`
+
+The class type of the service to start. If not specified the name is used to lookup the class type.
+
+##### args
+
+...`any`
+
+The list of arguments to pass into the service constructor
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### startAll()
+
+> **startAll**(): `Promise`\<`void`\>
+
+Defined in: [src/BackgroundServiceManager.ts:62](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L62)
+
+Starts all configured background services.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### stop()
+
+> **stop**(`serviceName`): `Promise`\<`void`\>
+
+Defined in: [src/BackgroundServiceManager.ts:139](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L139)
+
+Stops the background service with the given name.
+
+#### Parameters
+
+##### serviceName
+
+`string`
+
+The name of the background service to stop.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### stopAll()
+
+> **stopAll**(): `Promise`\<`void`\>
+
+Defined in: [src/BackgroundServiceManager.ts:124](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/BackgroundServiceManager.ts#L124)
+
+Stops all currently active background services that are owned by the manager.
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/reference/classes/BaseEntity.md

@@ -0,0 +1,82 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / BaseEntity
+
+# Abstract Class: BaseEntity
+
+Defined in: [src/models/BaseEntity.ts:18](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L18)
+
+Provides a common base class for all entity's that will be persisted to a datastore.
+
+Note that the `@CreateDateColumn`, `@UpdateDateColumn`, and `@VersionColumn` decorators from TypeORM are not supported
+because they are not implemented in TypeORM's MongoDB support. They are instead implemented directly by this
+library as part of `ModelRoute`.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Extended by
+
+- [`BaseMongoEntity`](BaseMongoEntity.md)
+- [`RecoverableBaseEntity`](RecoverableBaseEntity.md)
+
+## Constructors
+
+### Constructor
+
+> **new BaseEntity**(`other?`): `BaseEntity`
+
+Defined in: [src/models/BaseEntity.ts:52](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L52)
+
+#### Parameters
+
+##### other?
+
+`Partial`\<`BaseEntity`\>
+
+#### Returns
+
+`BaseEntity`
+
+## Properties
+
+### dateCreated
+
+> **dateCreated**: `Date`
+
+Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L35)
+
+The date and time that the entity was created.
+
+***
+
+### dateModified
+
+> **dateModified**: `Date`
+
+Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L43)
+
+The date and time that the entity was last modified.
+
+***
+
+### uid
+
+> **uid**: `string`
+
+Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L27)
+
+The universally unique identifier of the entity.
+
+***
+
+### version
+
+> **version**: `number` = `0`
+
+Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L50)
+
+The optimistic lock version.

package/docs/reference/classes/BaseMongoEntity.md

@@ -0,0 +1,107 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / BaseMongoEntity
+
+# Abstract Class: BaseMongoEntity
+
+Defined in: [src/models/BaseMongoEntity.ts:15](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseMongoEntity.ts#L15)
+
+Provides a common base class for all entity's that will be persisted in a MongoDB database.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Extends
+
+- [`BaseEntity`](BaseEntity.md)
+
+## Constructors
+
+### Constructor
+
+> **new BaseMongoEntity**(`other?`): `BaseMongoEntity`
+
+Defined in: [src/models/BaseMongoEntity.ts:23](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseMongoEntity.ts#L23)
+
+#### Parameters
+
+##### other?
+
+`Partial`\<`BaseMongoEntity`\>
+
+#### Returns
+
+`BaseMongoEntity`
+
+#### Overrides
+
+[`BaseEntity`](BaseEntity.md).[`constructor`](BaseEntity.md#constructor)
+
+## Properties
+
+### \_id?
+
+> `optional` **\_id?**: `any`
+
+Defined in: [src/models/BaseMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseMongoEntity.ts#L21)
+
+The internal unique identifier used by MongoDB.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `Date`
+
+Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L35)
+
+The date and time that the entity was created.
+
+#### Inherited from
+
+[`BaseEntity`](BaseEntity.md).[`dateCreated`](BaseEntity.md#datecreated)
+
+***
+
+### dateModified
+
+> **dateModified**: `Date`
+
+Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L43)
+
+The date and time that the entity was last modified.
+
+#### Inherited from
+
+[`BaseEntity`](BaseEntity.md).[`dateModified`](BaseEntity.md#datemodified)
+
+***
+
+### uid
+
+> **uid**: `string`
+
+Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L27)
+
+The universally unique identifier of the entity.
+
+#### Inherited from
+
+[`BaseEntity`](BaseEntity.md).[`uid`](BaseEntity.md#uid)
+
+***
+
+### version
+
+> **version**: `number` = `0`
+
+Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L50)
+
+The optimistic lock version.
+
+#### Inherited from
+
+[`BaseEntity`](BaseEntity.md).[`version`](BaseEntity.md#version)

package/docs/reference/classes/BasicStrategy.md

@@ -0,0 +1,89 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / BasicStrategy
+
+# Class: BasicStrategy
+
+Defined in: [src/auth/BasicStrategy.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L36)
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Implements
+
+- [`AuthStrategy`](../interfaces/AuthStrategy.md)
+
+## Constructors
+
+### Constructor
+
+> **new BasicStrategy**(`options?`): `BasicStrategy`
+
+Defined in: [src/auth/BasicStrategy.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L40)
+
+#### Parameters
+
+##### options?
+
+[`BasicStrategyOptions`](BasicStrategyOptions.md) = `...`
+
+#### Returns
+
+`BasicStrategy`
+
+## Properties
+
+### name
+
+> `readonly` **name**: `string` = `"basic"`
+
+Defined in: [src/auth/BasicStrategy.ts:37](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L37)
+
+The unique name of the strategy used to register with the `AuthMiddleware`.
+
+#### Implementation of
+
+[`AuthStrategy`](../interfaces/AuthStrategy.md).[`name`](../interfaces/AuthStrategy.md#name)
+
+## Methods
+
+### authenticate()
+
+> **authenticate**(`req`, `res`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `Promise`\<[`AuthResult`](../interfaces/AuthResult.md)\> \| `undefined`
+
+Defined in: [src/auth/BasicStrategy.ts:44](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L44)
+
+Attempts to perform authentication with the given request data. If authentication was successful, returns an
+`AuthResult` containing the authentication details. If authentication fails and `required` is set to `true`
+throws an error, otherwise returns `undefined`.
+
+#### Parameters
+
+##### req
+
+`HttpRequest`
+
+The request containing data to attempt authentication with.
+
+##### res
+
+`HttpResponse`
+
+The response to use when writing back directly to the client.
+
+##### required?
+
+`boolean`
+
+Set to `true` to if authentication is required to pass, otherwise set to `false`.
+
+#### Returns
+
+[`AuthResult`](../interfaces/AuthResult.md) \| `Promise`\<[`AuthResult`](../interfaces/AuthResult.md)\> \| `undefined`
+
+#### Implementation of
+
+[`AuthStrategy`](../interfaces/AuthStrategy.md).[`authenticate`](../interfaces/AuthStrategy.md#authenticate)