@rapidrest/core 1.3.1 → 1.3.2

package/docs/reference/classes/ApiError.md

@@ -1,251 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / ApiError
-
-# Class: ApiError
-
-Defined in: [src/ApiError.ts:8](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ApiError.ts#L8)
-
-Describes an error that originates from a API service. This class extends the standard `Error` class to include
-a unique code that can be used to trace an error to source code as well as the HTTP response status returned with
-the error.
-
-## Extends
-
-- `Error`
-
-## Constructors
-
-### Constructor
-
-> **new ApiError**(`code`, `status`, `message?`, `templateVariables?`): `ApiError`
-
-Defined in: [src/ApiError.ts:24](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ApiError.ts#L24)
-
-#### Parameters
-
-##### code
-
-`string`
-
-##### status
-
-`number`
-
-##### message?
-
-`string`
-
-##### templateVariables?
-
-`any`
-
-#### Returns
-
-`ApiError`
-
-#### Overrides
-
-`Error.constructor`
-
-## Properties
-
-### code
-
-> **code**: `string`
-
-Defined in: [src/ApiError.ts:10](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ApiError.ts#L10)
-
-The unique code of the error.
-
-***
-
-### message
-
-> **message**: `string`
-
-Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1075
-
-#### Inherited from
-
-`Error.message`
-
-***
-
-### name
-
-> **name**: `string`
-
-Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1074
-
-#### Inherited from
-
-`Error.name`
-
-***
-
-### stack?
-
-> `optional` **stack?**: `string`
-
-Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
-
-#### Inherited from
-
-`Error.stack`
-
-***
-
-### status
-
-> **status**: `number`
-
-Defined in: [src/ApiError.ts:12](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ApiError.ts#L12)
-
-The HTTP status associated with the error.
-
-***
-
-### 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
-
-`Error.stackTraceLimit`
-
-## Methods
-
-### ApiMessageTemplate()
-
-> **ApiMessageTemplate**(`message`, `templateVariables?`): `string`
-
-Defined in: [src/ApiError.ts:14](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ApiError.ts#L14)
-
-#### Parameters
-
-##### message
-
-`string` \| `undefined`
-
-##### templateVariables?
-
-`any`
-
-#### Returns
-
-`string`
-
-***
-
-### 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
-
-`Error.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
-
-`Error.prepareStackTrace`

package/docs/reference/classes/ClassLoader.md

@@ -1,224 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / ClassLoader
-
-# Class: ClassLoader
-
-Defined in: [src/ClassLoader.ts:51](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L51)
-
-The *ClassLoader* provides a container for dynamically loading classes at runtime using C#/Java style namespaces.
-Namespaces are determined from the folder structure relative to the root.
-
-Class names are derived either directly from the modules export name or inferred from the module's file path when
-the `default` export is used.
-
-For example, given the following example TypeScript module at relative path `com/company/MyClass.ts` would register
-a class with fully qualified name `com.company.MyClass`.
-
-```javascript
-export default class MyClass {
-    // ...
-}
-```
-
-In the event that multiple exports are defined, the fully qualified name will take on the export name instead of the
-module name. Thus, the following example module at relative path `com/company/MyClasses.ts` would register the following
-classes.
-- `com.company.MyClass`
-- `com.company.MyEnum`
-
-```javascript
-export class MyClass {
-    // ...
-}
-
-export enum MyEnum {
-    // ...
-}
-```
-
-**IMPORTANT**: If you use *ClassLoader* to dynamically load TypeScript files (.ts, .cts, .mts, etc.) at runtime using
-an ESM-only project you must use the `ts-node/esm` module loader. This can be specified by passing the `--loader` to
-node at runtime.
-
-```
-node --loader ts-node/esm <module>
-```
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Constructors
-
-### Constructor
-
-> **new ClassLoader**(`rootDir`, `includeJavaScript?`, `includeTypeScript?`, `ignore?`): `ClassLoader`
-
-Defined in: [src/ClassLoader.ts:70](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L70)
-
-Creates a new instance of `ClassLoader` with the specified defaults.
-
-#### Parameters
-
-##### rootDir
-
-`string`
-
-The root directory to load all classes from.
-
-##### includeJavaScript?
-
-`boolean` = `true`
-
-Set to `true` to load all TypeScript classes from the given `rootDir`, otherwise set to `false.
-@param includeTypeScript Set to `true` to load all JavaScript classes from the given `rootDir`, otherwise set to `false.
-
-##### includeTypeScript?
-
-`boolean` = `true`
-
-##### ignore?
-
-(`string` \| `RegExp`)[] = `[]`
-
-A list of regex pattern of file paths to ignore.
-
-#### Returns
-
-`ClassLoader`
-
-## Properties
-
-### classes
-
-> `protected` **classes**: `Map`\<`string`, `any`\>
-
-Defined in: [src/ClassLoader.ts:53](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L53)
-
-The map containnig all loaded classes.
-
-***
-
-### ignore
-
-> `protected` **ignore**: (`string` \| `RegExp`)[] = `[]`
-
-Defined in: [src/ClassLoader.ts:54](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L54)
-
-***
-
-### includeJavaScript
-
-> `protected` **includeJavaScript**: `boolean` = `true`
-
-Defined in: [src/ClassLoader.ts:58](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L58)
-
-Indicates if JavaScript classes should be loaded.
-
-***
-
-### includeTypeScript
-
-> `protected` **includeTypeScript**: `boolean` = `true`
-
-Defined in: [src/ClassLoader.ts:56](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L56)
-
-Indicates if TypeScript classes should be loaded.
-
-***
-
-### rootDir
-
-> `protected` **rootDir**: `string` = `"."`
-
-Defined in: [src/ClassLoader.ts:60](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L60)
-
-The path to the root directory containing all classes on disk.
-
-## Methods
-
-### getClass()
-
-> **getClass**(`fqn`): `any`
-
-Defined in: [src/ClassLoader.ts:83](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L83)
-
-Returns the class with the specified fully qualified name.
-
-#### Parameters
-
-##### fqn
-
-`string`
-
-The fully qualified name of the class to return.
-
-#### Returns
-
-`any`
-
-The class definition for the given fully qualified name if found, otherwise `undefined`.
-
-***
-
-### getClasses()
-
-> **getClasses**(): `Map`\<`string`, `any`\>
-
-Defined in: [src/ClassLoader.ts:90](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L90)
-
-Returns the map containing all classes that have been loaded.
-
-#### Returns
-
-`Map`\<`string`, `any`\>
-
-***
-
-### hasClass()
-
-> **hasClass**(`fqn`): `any`
-
-Defined in: [src/ClassLoader.ts:100](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L100)
-
-Returns `true` if a class exists with the specified fully qualified name.
-
-#### Parameters
-
-##### fqn
-
-`string`
-
-The fully qualified name of the class to search.
-
-#### Returns
-
-`any`
-
-`true` if a class definition exists for the given fully qualified name, otherwise `false`.
-
-***
-
-### load()
-
-> **load**(`dir?`): `Promise`\<`void`\>
-
-Defined in: [src/ClassLoader.ts:110](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ClassLoader.ts#L110)
-
-Loads all modules exports contained in the directory specified. The folder must be a child
-directory to the `rootDir` parameter passed in to the constructor.
-
-#### Parameters
-
-##### dir?
-
-`string` = `""`
-
-The directory, relative to `rootDir`, containing modules to load.
-
-#### Returns
-
-`Promise`\<`void`\>

package/docs/reference/classes/Event.md

@@ -1,109 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / Event
-
-# Class: Event
-
-Defined in: [src/TelemetryUtils.ts:23](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L23)
-
-Describes a single telemetry event. A telemetry event is when something occurs in the system.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Implements
-
-- [`NewEvent`](../interfaces/NewEvent.md)
-
-## Constructors
-
-### Constructor
-
-> **new Event**(`config`, `userId`, `data`): `Event`
-
-Defined in: [src/TelemetryUtils.ts:54](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L54)
-
-#### Parameters
-
-##### config
-
-`any`
-
-##### userId
-
-`string`
-
-##### data
-
-[`NewEvent`](../interfaces/NewEvent.md)
-
-#### Returns
-
-`Event`
-
-## Properties
-
-### environment
-
-> `readonly` **environment**: `string`
-
-Defined in: [src/TelemetryUtils.ts:32](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L32)
-
-The name of the environment that the event originated from. This is typically `dev` or `prod`.
-
-***
-
-### origin
-
-> `readonly` **origin**: `string`
-
-Defined in: [src/TelemetryUtils.ts:37](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L37)
-
-The unique name of the service or client that the event originated from.
-
-***
-
-### timestamp
-
-> `readonly` **timestamp**: `Date`
-
-Defined in: [src/TelemetryUtils.ts:42](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L42)
-
-The date and time that the event occured.
-
-***
-
-### type
-
-> `readonly` **type**: `string`
-
-Defined in: [src/TelemetryUtils.ts:47](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L47)
-
-The type of event being recorded.
-
-#### Implementation of
-
-[`NewEvent`](../interfaces/NewEvent.md).[`type`](../interfaces/NewEvent.md#type)
-
-***
-
-### uid
-
-> `readonly` **uid**: `string`
-
-Defined in: [src/TelemetryUtils.ts:27](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L27)
-
-The universally unique identifier of the event.
-
-***
-
-### userId
-
-> `readonly` **userId**: `string`
-
-Defined in: [src/TelemetryUtils.ts:52](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L52)
-
-The universally unique identifer of the user that sent the event.

package/docs/reference/classes/EventUtils.md

@@ -1,123 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / EventUtils
-
-# Class: EventUtils
-
-Defined in: [src/TelemetryUtils.ts:84](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L84)
-
-Provides a common set of static functions for recording and working with telemetry `Event` instances.
-
-The `init` function must be called before any other function can be called.
-
-The `record` function is used to send an event to a configured `telemetry_services` service for permanent storage.
-
-The `on` function allows code within the same application or service to listen for outgoing events that have been
-sent via the `record` function.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Constructors
-
-### Constructor
-
-> **new EventUtils**(): `EventUtils`
-
-#### Returns
-
-`EventUtils`
-
-## Methods
-
-### init()
-
-> `static` **init**(`config`, `logger`, `jwtToken`): `Promise`\<`void`\>
-
-Defined in: [src/TelemetryUtils.ts:99](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L99)
-
-Initializes `EventUtils` with the provided defaults.
-
-#### Parameters
-
-##### config
-
-`any`
-
-The application configuration to use.
-
-##### logger
-
-`any`
-
-The logging utility to use.
-
-##### jwtToken
-
-`string`
-
-The user's JWT token to send telemetry events on behalf of.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### on()
-
-> `static` **on**(`type`, `callback`): `void`
-
-Defined in: [src/TelemetryUtils.ts:173](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L173)
-
-Registers a `callback` function to receive notifications of recorded events of the given `type`. Note that only
-events originating from the same application or service will be notified.
-
-#### Parameters
-
-##### type
-
-`string`
-
-The type of event to be notified of.
-
-##### callback
-
-`Function`
-
-The function to call when an event is recorded.
-
-#### Returns
-
-`void`
-
-***
-
-### record()
-
-> `static` **record**(`evt`, `type?`): `Promise`\<`void`\>
-
-Defined in: [src/TelemetryUtils.ts:118](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/TelemetryUtils.ts#L118)
-
-Sends the given event to the telemetry service for permanent recording.
-
-#### Parameters
-
-##### evt
-
-`any`
-
-The event to send and record.
-
-##### type?
-
-`string`
-
-The type of event to record. Overrides any `type` value set in `evt`.
-
-#### Returns
-
-`Promise`\<`void`\>