@rapidrest/core 1.3.0 → 1.3.2

package/docs/reference/classes/AlertUtils.md

@@ -1,158 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / AlertUtils
-
-# Class: AlertUtils
-
-Defined in: [src/AlertUtils.ts:116](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L116)
-
-The `AlertUtils` class is used to send alerts about important system events that have occurred
-and require further monitoring or intervention.
-
-## Constructors
-
-### Constructor
-
-> **new AlertUtils**(`options`): `AlertUtils`
-
-Defined in: [src/AlertUtils.ts:128](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L128)
-
-Creates a new instance of `AuthUtils` with the provided defaults.
-
-#### Parameters
-
-##### options
-
-[`AlertUtilsOptions`](../interfaces/AlertUtilsOptions.md)
-
-The configuration options to use.
-
-#### Returns
-
-`AlertUtils`
-
-## Methods
-
-### addAttachment()
-
-> **addAttachment**(`id`, `attachment`, `indexFile?`): `Promise`\<`boolean`\>
-
-Defined in: [src/AlertUtils.ts:298](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L298)
-
-Uploads a single attachment to the alert with the given unique identifier.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the alert to add an attachment for.
-
-##### attachment
-
-[`AlertAttachment`](../interfaces/AlertAttachment.md)
-
-The file to upload as an attachment.
-
-##### indexFile?
-
-`string`
-
-Sets the indexFile parameter of the request.
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-True if the operation was successful, otherwise false.
-
-***
-
-### close()
-
-> **close**(`id`, `data?`): `Promise`\<`boolean`\>
-
-Defined in: [src/AlertUtils.ts:139](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L139)
-
-Attempts to close the existing alert with the given identifier.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the alert to close.
-
-##### data?
-
-[`AlertClose`](../interfaces/AlertClose.md) = `{}`
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-True if the operation was successful, otherwise false.
-
-***
-
-### get()
-
-> **get**(`id`): `Promise`\<[`Alert`](../interfaces/Alert.md) \| `null`\>
-
-Defined in: [src/AlertUtils.ts:167](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L167)
-
-Attempts to retrieve the existing alert with the given identifier.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the alert to retrieve.
-
-#### Returns
-
-`Promise`\<[`Alert`](../interfaces/Alert.md) \| `null`\>
-
-The retrieved alert if successful, otherwise `null`.
-
-***
-
-### send()
-
-> **send**(`alert`, `vars?`, `attachments?`): `Promise`\<`string` \| `null`\>
-
-Defined in: [src/AlertUtils.ts:191](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L191)
-
-Sends the provided alert to the configured monitoring service.
-
-#### Parameters
-
-##### alert
-
-[`Alert`](../interfaces/Alert.md)
-
-The alert to send.
-
-##### vars?
-
-`any` = `{}`
-
-A map of vars to perform replacement on for the alert's various properties.
-
-##### attachments?
-
-[`AlertUtilsAttachmentOptions`](../interfaces/AlertUtilsAttachmentOptions.md)
-
-The attachments to upload along with the alert.
-
-#### Returns
-
-`Promise`\<`string` \| `null`\>
-
-The unique identifier of the created alert if the operation was successful, otherwise `null`.

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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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:50](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L50)
-
-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:69](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L69)
-
-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:52](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L52)
-
-The map containnig all loaded classes.
-
-***
-
-### ignore
-
-> `protected` **ignore**: (`string` \| `RegExp`)[] = `[]`
-
-Defined in: [src/ClassLoader.ts:53](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L53)
-
-***
-
-### includeJavaScript
-
-> `protected` **includeJavaScript**: `boolean` = `true`
-
-Defined in: [src/ClassLoader.ts:57](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L57)
-
-Indicates if JavaScript classes should be loaded.
-
-***
-
-### includeTypeScript
-
-> `protected` **includeTypeScript**: `boolean` = `true`
-
-Defined in: [src/ClassLoader.ts:55](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L55)
-
-Indicates if TypeScript classes should be loaded.
-
-***
-
-### rootDir
-
-> `protected` **rootDir**: `string` = `"."`
-
-Defined in: [src/ClassLoader.ts:59](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L59)
-
-The path to the root directory containing all classes on disk.
-
-## Methods
-
-### getClass()
-
-> **getClass**(`fqn`): `any`
-
-Defined in: [src/ClassLoader.ts:82](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L82)
-
-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:89](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L89)
-
-Returns the map containing all classes that have been loaded.
-
-#### Returns
-
-`Map`\<`string`, `any`\>
-
-***
-
-### hasClass()
-
-> **hasClass**(`fqn`): `any`
-
-Defined in: [src/ClassLoader.ts:99](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L99)
-
-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:109](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ClassLoader.ts#L109)
-
-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`\>