@rapidrest/core 1.0.1

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Inject.md

@@ -0,0 +1,45 @@
+[**@rapidrest/core**](../../../../README.md)
+
+***
+
+[@rapidrest/core](../../../../README.md) / [ObjectDecorators](../README.md) / Inject
+
+# Function: Inject()
+
+> **Inject**(`type`, `options?`): (`target`, `propertyKey`) => `void`
+
+Defined in: src/decorators/ObjectDecorators.ts:23
+
+Injects an object instance to the decorated property of the given name and type using the provided arguments
+if no object has been created yet.
+
+## Parameters
+
+### type
+
+`any`
+
+The fully qualified name or type of the class to instantiate. If a type is given it's class name will be inferred
+via the constructor name.
+
+### options?
+
+[`InstanceOptions`](../../../../interfaces/InstanceOptions.md)
+
+## Returns
+
+> (`target`, `propertyKey`): `void`
+
+### Parameters
+
+#### target
+
+`any`
+
+#### propertyKey
+
+`string` | `symbol`
+
+### Returns
+
+`void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Logger.md

@@ -0,0 +1,27 @@
+[**@rapidrest/core**](../../../../README.md)
+
+***
+
+[@rapidrest/core](../../../../README.md) / [ObjectDecorators](../README.md) / Logger
+
+# Function: Logger()
+
+> **Logger**(`target`, `propertyKey`): `void`
+
+Defined in: src/decorators/ObjectDecorators.ts:79
+
+Apply this to a property to have the logger utility injected at instantiation.
+
+## Parameters
+
+### target
+
+`any`
+
+### propertyKey
+
+`string` | `symbol`
+
+## Returns
+
+`void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Nullable.md

@@ -0,0 +1,27 @@
+[**@rapidrest/core**](../../../../README.md)
+
+***
+
+[@rapidrest/core](../../../../README.md) / [ObjectDecorators](../README.md) / Nullable
+
+# Function: Nullable()
+
+> **Nullable**(`target`, `propertyKey`): `void`
+
+Defined in: src/decorators/ObjectDecorators.ts:94
+
+Apply this to a property to indicate that the value can be `null` or `undefined.`
+
+## Parameters
+
+### target
+
+`any`
+
+### propertyKey
+
+`string` | `symbol`
+
+## Returns
+
+`void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Validator.md

@@ -0,0 +1,39 @@
+[**@rapidrest/core**](../../../../README.md)
+
+***
+
+[@rapidrest/core](../../../../README.md) / [ObjectDecorators](../README.md) / Validator
+
+# Function: Validator()
+
+> **Validator**(`func`): (`target`, `propertyKey`) => `void`
+
+Defined in: src/decorators/ObjectDecorators.ts:112
+
+Apply this to a property to specify the function that will be used to perform validation of the value.
+
+## Parameters
+
+### func
+
+[`ValidatorFunction`](../type-aliases/ValidatorFunction.md)
+
+The validation function to use for the given property.
+
+## Returns
+
+> (`target`, `propertyKey`): `void`
+
+### Parameters
+
+#### target
+
+`any`
+
+#### propertyKey
+
+`string` | `symbol`
+
+### Returns
+
+`void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/type-aliases/ValidatorFunction.md

@@ -0,0 +1,31 @@
+[**@rapidrest/core**](../../../../README.md)
+
+***
+
+[@rapidrest/core](../../../../README.md) / [ObjectDecorators](../README.md) / ValidatorFunction
+
+# Type Alias: ValidatorFunction()
+
+> **ValidatorFunction** = (`value`) => `any`
+
+Defined in: src/decorators/ObjectDecorators.ts:105
+
+A function used to validate a property value.
+
+## Parameters
+
+### value
+
+`any`
+
+The value to validate.
+
+## Returns
+
+`any`
+
+The validated value to assign to the property.
+
+## Throws
+
+An exception if the value cannot be validated.

package/docs/reference/README.md

@@ -0,0 +1,73 @@
+**@rapidrest/core**
+
+***
+
+# @rapidrest/core
+
+## Namespaces
+
+- [ObjectDecorators](@rapidrest/namespaces/ObjectDecorators/README.md)
+
+## Enumerations
+
+- [AlertPriority](enumerations/AlertPriority.md)
+- [JWTUtilsCompressionMethods](enumerations/JWTUtilsCompressionMethods.md)
+- [WorkerMessageType](enumerations/WorkerMessageType.md)
+
+## Classes
+
+- [AlertUtils](classes/AlertUtils.md)
+- [ApiError](classes/ApiError.md)
+- [ClassLoader](classes/ClassLoader.md)
+- [Event](classes/Event.md)
+- [EventUtils](classes/EventUtils.md)
+- [FileUtils](classes/FileUtils.md)
+- [JWTUtils](classes/JWTUtils.md)
+- [MessagingUtils](classes/MessagingUtils.md)
+- [OASUtils](classes/OASUtils.md)
+- [ObjectFactory](classes/ObjectFactory.md)
+- [ObjectUtils](classes/ObjectUtils.md)
+- [StringUtils](classes/StringUtils.md)
+- [ThreadPool](classes/ThreadPool.md)
+- [ThreadWorker](classes/ThreadWorker.md)
+- [UserUtils](classes/UserUtils.md)
+- [ValidationUtils](classes/ValidationUtils.md)
+
+## Interfaces
+
+- [Alert](interfaces/Alert.md)
+- [AlertAttachment](interfaces/AlertAttachment.md)
+- [AlertClose](interfaces/AlertClose.md)
+- [AlertUtilsAttachmentOptions](interfaces/AlertUtilsAttachmentOptions.md)
+- [AlertUtilsOptions](interfaces/AlertUtilsOptions.md)
+- [InstanceOptions](interfaces/InstanceOptions.md)
+- [JWTPayload](interfaces/JWTPayload.md)
+- [JWTUser](interfaces/JWTUser.md)
+- [JWTUtilsConfig](interfaces/JWTUtilsConfig.md)
+- [JWTUtilsPayloadKeyOptions](interfaces/JWTUtilsPayloadKeyOptions.md)
+- [JWTUtilsPayloadOptions](interfaces/JWTUtilsPayloadOptions.md)
+- [JWTUtilsPayloadPasswordOptions](interfaces/JWTUtilsPayloadPasswordOptions.md)
+- [NewEvent](interfaces/NewEvent.md)
+- [OriginSettings](interfaces/OriginSettings.md)
+- [SlackConfig](interfaces/SlackConfig.md)
+- [SmtpAuth](interfaces/SmtpAuth.md)
+- [SmtpConfig](interfaces/SmtpConfig.md)
+- [Template](interfaces/Template.md)
+- [TemplateMapBase](interfaces/TemplateMapBase.md)
+- [TwilioConfig](interfaces/TwilioConfig.md)
+- [WorkerMessage](interfaces/WorkerMessage.md)
+- [WorkerOptions](interfaces/WorkerOptions.md)
+
+## Type Aliases
+
+- [BooleanFunc](type-aliases/BooleanFunc.md)
+- [TemplateMap](type-aliases/TemplateMap.md)
+- [WorkerCallback](type-aliases/WorkerCallback.md)
+
+## Variables
+
+- [Logger](variables/Logger.md)
+
+## Functions
+
+- [sleep](functions/sleep.md)

package/docs/reference/classes/AlertUtils.md

@@ -0,0 +1,158 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / AlertUtils
+
+# Class: AlertUtils
+
+Defined in: src/AlertUtils.ts:116
+
+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
+
+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
+
+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
+
+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
+
+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
+
+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

@@ -0,0 +1,263 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / ApiError
+
+# Class: ApiError
+
+Defined in: src/ApiError.ts:8
+
+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
+
+#### Parameters
+
+##### code
+
+`string`
+
+##### status
+
+`number`
+
+##### message?
+
+`string`
+
+##### templateVariables?
+
+`any`
+
+#### Returns
+
+`ApiError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+#### Inherited from
+
+`Error.cause`
+
+***
+
+### code
+
+> **code**: `string`
+
+Defined in: src/ApiError.ts:10
+
+The unique code of the error.
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
+
+#### Inherited from
+
+`Error.message`
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
+
+#### Inherited from
+
+`Error.name`
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
+
+#### Inherited from
+
+`Error.stack`
+
+***
+
+### status
+
+> **status**: `number`
+
+Defined in: src/ApiError.ts:12
+
+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
+
+#### 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`