@rapidrest/service-core 1.0.0-beta.1

package/docs/reference/classes/BasicStrategyOptions.md

@@ -0,0 +1,91 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / BasicStrategyOptions
+
+# Class: BasicStrategyOptions
+
+Defined in: [src/auth/BasicStrategy.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L14)
+
+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:26](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L26)
+
+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:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L16)
+
+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:18](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L18)
+
+The authorization scheme type when using header based authentication. Default value is `jwt`.
+
+***
+
+### queryKey
+
+> **queryKey**: `string` = `"auth_basic"`
+
+Defined in: [src/auth/BasicStrategy.ts:20](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L20)
+
+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`
+
+Defined in: [src/auth/BasicStrategy.ts:28](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/BasicStrategy.ts#L28)
+
+You must override this function to perform verification of the login information.
+
+#### Parameters
+
+##### uid
+
+`string`
+
+##### secret
+
+`string`
+
+#### Returns
+
+`JWTUser` \| `Promise`\<`JWTUser`\> \| `undefined`

package/docs/reference/classes/BulkError.md

@@ -0,0 +1,271 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,75 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/database/ConnectionManager.ts#L136)
+
+Attempts to disconnect all active database connections.
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/reference/classes/EventListenerManager.md

@@ -0,0 +1,88 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/EventListenerManager.ts#L77)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### init()
+
+> **init**(): `Promise`\<`void`\>
+
+Defined in: [src/EventListenerManager.ts:33](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/EventListenerManager.ts#L33)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### register()
+
+> **register**(`obj`): `void`
+
+Defined in: [src/EventListenerManager.ts:128](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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`

package/docs/reference/classes/JWTStrategy.md

@@ -0,0 +1,77 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / JWTStrategy
+
+# Class: JWTStrategy
+
+Defined in: [src/auth/JWTStrategy.ts:64](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L64)
+
+JWT authentication strategy. Performs JWT verification and searches for a token by one of the
+following methods (in order of precedence):
+* Query Parameter
+* Authorization Header
+* Cookie
+
+This class no longer extends `passport-strategy`; it is used directly by route middleware
+and returns a plain result object instead of calling Passport callbacks.
+
+## Author
+
+Jean-Philippe Steinmetz
+
+## Constructors
+
+### Constructor
+
+> **new JWTStrategy**(`options?`): `JWTStrategy`
+
+Defined in: [src/auth/JWTStrategy.ts:72](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L72)
+
+#### Parameters
+
+##### options?
+
+[`JWTStrategyOptions`](JWTStrategyOptions.md) = `...`
+
+#### Returns
+
+`JWTStrategy`
+
+## Properties
+
+### name
+
+> `readonly` **name**: `string` = `"jwt"`
+
+Defined in: [src/auth/JWTStrategy.ts:68](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L68)
+
+## Methods
+
+### authenticate()
+
+> **authenticate**(`req`, `res`, `required?`): [`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`
+
+Defined in: [src/auth/JWTStrategy.ts:81](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L81)
+
+Attempts to authenticate the incoming request by extracting and verifying a JWT token.
+Returns a `JWTAuthResult` describing the outcome.
+
+#### Parameters
+
+##### req
+
+`HttpRequest`
+
+##### res
+
+`HttpResponse`
+
+##### required?
+
+`boolean`
+
+#### Returns
+
+[`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`

package/docs/reference/classes/JWTStrategyOptions.md

@@ -0,0 +1,97 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / JWTStrategyOptions
+
+# Class: JWTStrategyOptions
+
+Defined in: [src/auth/JWTStrategy.ts:20](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L20)
+
+Describes the configuration options that can be used to initialize JWTStrategy.
+
+## Author
+
+Jean-Philippe Steinmetz
+
+## Constructors
+
+### Constructor
+
+> **new JWTStrategyOptions**(): `JWTStrategyOptions`
+
+#### Returns
+
+`JWTStrategyOptions`
+
+## Properties
+
+### allowQueryParam
+
+> **allowQueryParam**: `boolean` = `false`
+
+Defined in: [src/auth/JWTStrategy.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L38)
+
+Set to `true` to allow tokens 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 tokens outside the application.
+
+***
+
+### config?
+
+> `optional` **config?**: `JWTUtilsConfig`
+
+Defined in: [src/auth/JWTStrategy.ts:22](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L22)
+
+The configuration options to pass to the JWTUtils library during token verification.
+
+***
+
+### cookieName
+
+> **cookieName**: `string` = `"jwt"`
+
+Defined in: [src/auth/JWTStrategy.ts:28](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L28)
+
+The name of the cookie to retrieve the token from when using cookie based authentication. Default value is `jwt`.
+
+***
+
+### cookieSecure
+
+> **cookieSecure**: `boolean` = `false`
+
+Defined in: [src/auth/JWTStrategy.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L30)
+
+The name of the secured cookie to retreive the token from when using cookie based authentication.
+
+***
+
+### headerKey
+
+> **headerKey**: `string` = `"authorization"`
+
+Defined in: [src/auth/JWTStrategy.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L24)
+
+The name of the header to look for when performing header based authentication. Default value is `Authorization`.
+
+***
+
+### headerScheme
+
+> **headerScheme**: `string` = "(jwt\|bearer)"
+
+Defined in: [src/auth/JWTStrategy.ts:26](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L26)
+
+The authorization scheme type when using header based authentication. Default value is `jwt`.
+
+***
+
+### queryKey
+
+> **queryKey**: `string` = `"auth_token"`
+
+Defined in: [src/auth/JWTStrategy.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L32)
+
+The name of the request query parameter to retrieve the token from when using query based authentication. Default value is `auth_token`.