@rapidrest/service-core 1.0.0-rc.2 → 1.0.0-rc.21

package/docs/reference/classes/BasicStrategy.md

@@ -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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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

@@ -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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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`

package/docs/reference/classes/BulkError.md

@@ -1,271 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / BulkError
-
-# Class: BulkError
-
-Defined in: [src/BulkError.ts:6](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BulkError.ts#L6)
-
-An error take that takes an array of other errors.
-
-## Extends
-
-- `ApiError`
-
-## Constructors
-
-### Constructor
-
-> **new BulkError**(`errs`, `code`, `defaultStatus`, `message?`): `BulkError`
-
-Defined in: [src/BulkError.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BulkError.ts#L12)
-
-#### Parameters
-
-##### errs
-
-(`Error` \| `null`)[]
-
-##### code
-
-`string`
-
-##### defaultStatus
-
-`number`
-
-##### message?
-
-`string`
-
-#### Returns
-
-`BulkError`
-
-#### Overrides
-
-`ApiError.constructor`
-
-## Properties
-
-### code
-
-> **code**: `string`
-
-Defined in: node\_modules/@rapidrest/core/dist/types/ApiError.d.ts:8
-
-The unique code of the error.
-
-#### Inherited from
-
-`ApiError.code`
-
-***
-
-### errors
-
-> `readonly` **errors**: (`Error` \| `null`)[] = `[]`
-
-Defined in: [src/BulkError.ts:10](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/BulkError.ts#L10)
-
-The list of errors that have been thrown.
-
-***
-
-### message
-
-> **message**: `string`
-
-Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1075
-
-#### Inherited from
-
-`ApiError.message`
-
-***
-
-### name
-
-> **name**: `string`
-
-Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1074
-
-#### Inherited from
-
-`ApiError.name`
-
-***
-
-### stack?
-
-> `optional` **stack?**: `string`
-
-Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
-
-#### Inherited from
-
-`ApiError.stack`
-
-***
-
-### status
-
-> **status**: `number`
-
-Defined in: node\_modules/@rapidrest/core/dist/types/ApiError.d.ts:10
-
-The HTTP status associated with the error.
-
-#### Inherited from
-
-`ApiError.status`
-
-***
-
-### stackTraceLimit
-
-> `static` **stackTraceLimit**: `number`
-
-Defined in: node\_modules/@types/node/globals.d.ts:67
-
-The `Error.stackTraceLimit` property specifies the number of stack frames
-collected by a stack trace (whether generated by `new Error().stack` or
-`Error.captureStackTrace(obj)`).
-
-The default value is `10` but may be set to any valid JavaScript number. Changes
-will affect any stack trace captured _after_ the value has been changed.
-
-If set to a non-number value, or set to a negative number, stack traces will
-not capture any frames.
-
-#### Inherited from
-
-`ApiError.stackTraceLimit`
-
-## Methods
-
-### ApiMessageTemplate()
-
-> **ApiMessageTemplate**(`message`, `templateVariables?`): `string`
-
-Defined in: node\_modules/@rapidrest/core/dist/types/ApiError.d.ts:11
-
-#### Parameters
-
-##### message
-
-`string` \| `undefined`
-
-##### templateVariables?
-
-`any`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-`ApiError.ApiMessageTemplate`
-
-***
-
-### captureStackTrace()
-
-> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
-
-Defined in: node\_modules/@types/node/globals.d.ts:51
-
-Creates a `.stack` property on `targetObject`, which when accessed returns
-a string representing the location in the code at which
-`Error.captureStackTrace()` was called.
-
-```js
-const myObject = {};
-Error.captureStackTrace(myObject);
-myObject.stack;  // Similar to `new Error().stack`
-```
-
-The first line of the trace will be prefixed with
-`${myObject.name}: ${myObject.message}`.
-
-The optional `constructorOpt` argument accepts a function. If given, all frames
-above `constructorOpt`, including `constructorOpt`, will be omitted from the
-generated stack trace.
-
-The `constructorOpt` argument is useful for hiding implementation
-details of error generation from the user. For instance:
-
-```js
-function a() {
-  b();
-}
-
-function b() {
-  c();
-}
-
-function c() {
-  // Create an error without stack trace to avoid calculating the stack trace twice.
-  const { stackTraceLimit } = Error;
-  Error.stackTraceLimit = 0;
-  const error = new Error();
-  Error.stackTraceLimit = stackTraceLimit;
-
-  // Capture the stack trace above function b
-  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
-  throw error;
-}
-
-a();
-```
-
-#### Parameters
-
-##### targetObject
-
-`object`
-
-##### constructorOpt?
-
-`Function`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`ApiError.captureStackTrace`
-
-***
-
-### prepareStackTrace()
-
-> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
-
-Defined in: node\_modules/@types/node/globals.d.ts:55
-
-#### Parameters
-
-##### err
-
-`Error`
-
-##### stackTraces
-
-`CallSite`[]
-
-#### Returns
-
-`any`
-
-#### See
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
-#### Inherited from
-
-`ApiError.prepareStackTrace`

package/docs/reference/classes/ConnectionManager.md

@@ -1,75 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / ConnectionManager
-
-# Class: ConnectionManager
-
-Defined in: [src/database/ConnectionManager.ts:17](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/ConnectionManager.ts#L17)
-
-Provides database connection management.
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Constructors
-
-### Constructor
-
-> **new ConnectionManager**(): `ConnectionManager`
-
-#### Returns
-
-`ConnectionManager`
-
-## Properties
-
-### connections
-
-> **connections**: `Map`\<`string`, `Redis` \| `DataSource` \| [`MongoConnection`](MongoConnection.md)\>
-
-Defined in: [src/database/ConnectionManager.ts:18](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/ConnectionManager.ts#L18)
-
-## Methods
-
-### connect()
-
-> **connect**(`datastores`, `models`): `Promise`\<`void`\>
-
-Defined in: [src/database/ConnectionManager.ts:60](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/ConnectionManager.ts#L60)
-
-Attempts to initiate all database connections as defined in the config.
-
-#### Parameters
-
-##### datastores
-
-`any`
-
-A map of configured datastores to be passed to the underlying engine.
-
-##### models
-
-`Map`\<`string`, `any`\>
-
-A map of model names and associated class definitions to establish database connections for.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### disconnect()
-
-> **disconnect**(): `Promise`\<`void`\>
-
-Defined in: [src/database/ConnectionManager.ts:136](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/database/ConnectionManager.ts#L136)
-
-Attempts to disconnect all active database connections.
-
-#### Returns
-
-`Promise`\<`void`\>

package/docs/reference/classes/EventListenerManager.md

@@ -1,88 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / EventListenerManager
-
-# Class: EventListenerManager
-
-Defined in: [src/EventListenerManager.ts:18](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/EventListenerManager.ts#L18)
-
-The `EventListenerManager` is responsible for managing event handlers and processing of incoming
-events from the configured redis pubsub channels. An event handler is any function that has been
-decorated with the `@OnEvent` decorator and registered with this manager. Once registered, any event
-that is received corresponding to the list of types specified in the decorator arguments will be
-sent to the designated function(s). If no type is specified, the handler function will be called
-for any event that is received.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Constructors
-
-### Constructor
-
-> **new EventListenerManager**(`objectFactory`, `redis`): `EventListenerManager`
-
-Defined in: [src/EventListenerManager.ts:27](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/EventListenerManager.ts#L27)
-
-#### Parameters
-
-##### objectFactory
-
-[`ObjectFactory`](ObjectFactory.md)
-
-##### redis
-
-`Redis`
-
-#### Returns
-
-`EventListenerManager`
-
-## Methods
-
-### destroy()
-
-> **destroy**(): `Promise`\<`void`\>
-
-Defined in: [src/EventListenerManager.ts:77](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/EventListenerManager.ts#L77)
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### init()
-
-> **init**(): `Promise`\<`void`\>
-
-Defined in: [src/EventListenerManager.ts:33](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/EventListenerManager.ts#L33)
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### register()
-
-> **register**(`obj`): `void`
-
-Defined in: [src/EventListenerManager.ts:128](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/EventListenerManager.ts#L128)
-
-Registers the given object to be notified of events that arrive.
-
-#### Parameters
-
-##### obj
-
-`any`
-
-The object to register for event handling.
-
-#### Returns
-
-`void`