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/BackgroundServiceManager.md DELETED Viewed

@@ -1,172 +0,0 @@
-[**@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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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 DELETED Viewed

@@ -1,82 +0,0 @@
-[**@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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/BaseEntity.ts#L50)
-The optimistic lock version.

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

@@ -1,107 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / BaseMongoEntity
-# Abstract Class: BaseMongoEntity
-Defined in: [src/models/BaseMongoEntity.ts:18](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/BaseMongoEntity.ts#L18)
-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:26](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/BaseMongoEntity.ts#L26)
-#### 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:24](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/BaseMongoEntity.ts#L24)
-The internal unique identifier used by MongoDB.
-***
-### dateCreated
-> **dateCreated**: `Date`
-Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/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/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/BaseEntity.ts#L50)
-The optimistic lock version.
-#### Inherited from
-[`BaseEntity`](BaseEntity.md).[`version`](BaseEntity.md#version)

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

@@ -1,131 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / BasicStrategy
-# Class: BasicStrategy
-Defined in: [src/auth/BasicStrategy.ts:39](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L39)
-## Author
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-## Implements
-- [`AuthStrategy`](../interfaces/AuthStrategy.md)
-## Constructors
-### Constructor
-> **new BasicStrategy**(`options?`): `BasicStrategy`
-Defined in: [src/auth/BasicStrategy.ts:43](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L43)
-#### Parameters
-##### options?
-[`BasicStrategyOptions`](BasicStrategyOptions.md) = `...`
-#### Returns
-`BasicStrategy`
-## Properties
-### name
-> `readonly` **name**: `string` = `"basic"`
-Defined in: [src/auth/BasicStrategy.ts:40](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L40)
-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?`): `Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
-Defined in: [src/auth/BasicStrategy.ts:80](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L80)
-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`](../interfaces/HttpRequest.md)
-The request containing data to attempt authentication with.
-##### res
-[`HttpResponse`](../interfaces/HttpResponse.md)
-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
-`Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
-#### Implementation of
-[`AuthStrategy`](../interfaces/AuthStrategy.md).[`authenticate`](../interfaces/AuthStrategy.md#authenticate)
-***
-### authenticateSync()
-> **authenticateSync**(`req`, `res`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
-Defined in: [src/auth/BasicStrategy.ts:112](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L112)
-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`.
-This is the synchronous version of `authenticate` that performs blocking based authentication.
-#### Parameters
-##### req
-[`HttpRequest`](../interfaces/HttpRequest.md)
-The request containing data to attempt authentication with.
-##### res
-[`HttpResponse`](../interfaces/HttpResponse.md)
-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) \| `undefined`
-#### Implementation of
-[`AuthStrategy`](../interfaces/AuthStrategy.md).[`authenticateSync`](../interfaces/AuthStrategy.md#authenticatesync)

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

@@ -1,115 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / BasicStrategyOptions
-# Class: BasicStrategyOptions
-Defined in: [src/auth/BasicStrategy.ts:13](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L13)
-Describes the configuration options that can be used to initialize BasicStrategy.
-## Author
-Jean-Philippe Steinmetz
-## Constructors
-### Constructor
-> **new BasicStrategyOptions**(): `BasicStrategyOptions`
-#### Returns
-`BasicStrategyOptions`
-## Properties
-### allowQueryParam
-> **allowQueryParam**: `boolean` = `false`
-Defined in: [src/auth/BasicStrategy.ts:25](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L25)
-Set to `true` to allow credentials to be supplied via the `queryKey` URL parameter.
-Disabled by default — query parameters appear in server logs, browser history, and
-Referer headers, which permanently exposes credentials outside the application.
-***
-### headerKey
-> **headerKey**: `string` = `"authorization"`
-Defined in: [src/auth/BasicStrategy.ts:15](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L15)
-The name of the header to look for when performing header based authentication. Default value is `Authorization`.
-***
-### headerScheme
-> **headerScheme**: `string` = `"basic"`
-Defined in: [src/auth/BasicStrategy.ts:17](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L17)
-The authorization scheme type when using header based authentication. Default value is `jwt`.
-***
-### queryKey
-> **queryKey**: `string` = `"auth_basic"`
-Defined in: [src/auth/BasicStrategy.ts:19](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L19)
-The name of the request query parameter to retrieve the token from when using query based authentication. Default value is `auth_basic`.
-## Methods
-### verify()
-> **verify**(`uid`, `secret`): `JWTUser` \| `Promise`\<`JWTUser` \| `undefined`\> \| `undefined`
-Defined in: [src/auth/BasicStrategy.ts:27](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L27)
-Override this function to handle asynchronous (non-blocking) verification of the login info.
-#### Parameters
-##### uid
-`string`
-##### secret
-`string`
-#### Returns
-`JWTUser` \| `Promise`\<`JWTUser` \| `undefined`\> \| `undefined`
-***
-### verifySync()
-> **verifySync**(`uid`, `secret`): `JWTUser` \| `undefined`
-Defined in: [src/auth/BasicStrategy.ts:31](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/BasicStrategy.ts#L31)
-Override this function to handle synchronous (blocking) verification of the login info.
-#### Parameters
-##### uid
-`string`
-##### secret
-`string`
-#### Returns
-`JWTUser` \| `undefined`