@rapidrest/core 1.3.0 → 1.3.2

package/docs/reference/classes/MessagingUtils.md

@@ -1,167 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / MessagingUtils
-
-# Class: MessagingUtils
-
-Defined in: [src/MessagingUtils.ts:75](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L75)
-
-Simple utility class for sending templated messages via e-mail, SMS and more.
-
-## Constructors
-
-### Constructor
-
-> **new MessagingUtils**(): `MessagingUtils`
-
-#### Returns
-
-`MessagingUtils`
-
-## Properties
-
-### slackApps
-
-> `protected` **slackApps**: `any`[] = `[]`
-
-Defined in: [src/MessagingUtils.ts:76](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L76)
-
-***
-
-### slackConfigs
-
-> `protected` **slackConfigs**: `any`[] = `[]`
-
-Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L78)
-
-## Methods
-
-### init()
-
-> **init**(): `Promise`\<`void`\>
-
-Defined in: [src/MessagingUtils.ts:96](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L96)
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### loadTemplate()
-
-> **loadTemplate**(`name`): [`Template`](../interfaces/Template.md)
-
-Defined in: [src/MessagingUtils.ts:160](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L160)
-
-Loads the template with the given name and returns its contents as a string.
-
-#### Parameters
-
-##### name
-
-`string`
-
-The name of the template to load.
-
-#### Returns
-
-[`Template`](../interfaces/Template.md)
-
-***
-
-### sendEmail()
-
-> **sendEmail**(`templateName`, `templateVars`, `options?`): `Promise`\<`any`\>
-
-Defined in: [src/MessagingUtils.ts:199](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L199)
-
-Sends an email using the given template name and variables.
-
-#### Parameters
-
-##### templateName
-
-`string`
-
-The name of the email template to send.
-
-##### templateVars
-
-`any`
-
-The map of variables to inject into the template.
-
-##### options?
-
-`any` = `{}`
-
-The map of additional options to pass into the sendMail function.
-
-#### Returns
-
-`Promise`\<`any`\>
-
-***
-
-### sendSlack()
-
-> **sendSlack**(`templateName`, `templateVars`): `Promise`\<`any`[] \| `undefined`\>
-
-Defined in: [src/MessagingUtils.ts:243](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L243)
-
-Sends an Slack message using the given template name and variables.
-
-#### Parameters
-
-##### templateName
-
-`string`
-
-The name of the Slack template to send.
-
-##### templateVars
-
-`any`
-
-The map of variables to inject into the template.
-
-#### Returns
-
-`Promise`\<`any`[] \| `undefined`\>
-
-***
-
-### sendSMS()
-
-> **sendSMS**(`templateName`, `templateVars`, `options?`): `Promise`\<`any`\>
-
-Defined in: [src/MessagingUtils.ts:276](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L276)
-
-Sends an SMS using the given template name and variables.
-
-#### Parameters
-
-##### templateName
-
-`string`
-
-The name of the SMS template to send.
-
-##### templateVars
-
-`any`
-
-The map of variables to inject into the template.
-
-##### options?
-
-`any` = `{}`
-
-The map of additional options to pass into the sendMail function.
-
-#### Returns
-
-`Promise`\<`any`\>

package/docs/reference/classes/OASUtils.md

@@ -1,227 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / OASUtils
-
-# Class: OASUtils
-
-Defined in: [src/OASUtils.ts:17](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L17)
-
-## Constructors
-
-### Constructor
-
-> **new OASUtils**(): `OASUtils`
-
-#### Returns
-
-`OASUtils`
-
-## Methods
-
-### clearSpecCache()
-
-> `static` **clearSpecCache**(): `void`
-
-Defined in: [src/OASUtils.ts:230](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L230)
-
-Clears the spec parse cache. Useful in tests to force re-loading of specs.
-
-#### Returns
-
-`void`
-
-***
-
-### getDatastore()
-
-> `static` **getDatastore**(`spec`, `name`): `any`
-
-Defined in: [src/OASUtils.ts:25](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L25)
-
-Gets the datastore definition with the specified name.
-
-#### Parameters
-
-##### spec
-
-`any`
-
-The OpenAPI specification to search.
-
-##### name
-
-`string`
-
-The name of the datastore to retrieve.
-
-#### Returns
-
-`any`
-
-The definition for the datastore with the given name if found, otherwise `undefined`.
-
-***
-
-### getObject()
-
-> `static` **getObject**(`spec`, `path`): `any`
-
-Defined in: [src/OASUtils.ts:42](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L42)
-
-Gets the specification object at the specified path.
-
-#### Parameters
-
-##### spec
-
-`any`
-
-The OpenAPI specification to reference.
-
-##### path
-
-`string`
-
-The path of the object to retrieve.
-
-#### Returns
-
-`any`
-
-The object at the specified path if found, otherwise `undefined`.
-
-***
-
-### getResponse()
-
-> `static` **getResponse**(`obj`): `any`
-
-Defined in: [src/OASUtils.ts:69](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L69)
-
-Returns the first available response object for a 2XX response as defined by the provided Operation schema object.
-
-#### Parameters
-
-##### obj
-
-`any`
-
-The Operation schema object to search.
-
-#### Returns
-
-`any`
-
-***
-
-### getResponseContent()
-
-> `static` **getResponseContent**(`obj`): `any`
-
-Defined in: [src/OASUtils.ts:88](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L88)
-
-Returns the first available response content object for a 2XX response as defined by the provided Operation schema object.
-
-#### Parameters
-
-##### obj
-
-`any`
-
-The Operation schema object to search.
-
-#### Returns
-
-`any`
-
-***
-
-### getSchema()
-
-> `static` **getSchema**(`spec`, `name`): `any`
-
-Defined in: [src/OASUtils.ts:100](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L100)
-
-Retrieves the schema definition with the given name.
-
-#### Parameters
-
-##### spec
-
-`any`
-
-The OpenAPI specification object to reference.
-
-##### name
-
-`string`
-
-The name of the schema to retrieve.
-
-#### Returns
-
-`any`
-
-The schema definition with the given name.
-
-***
-
-### getTypeInfo()
-
-> `static` **getTypeInfo**(`schemaDef`, `spec`, `convertDataType`): `any`
-
-Defined in: [src/OASUtils.ts:124](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L124)
-
-Extracts the type information for a given schema Object definition.
-
-#### Parameters
-
-##### schemaDef
-
-`any`
-
-The schema definition object to extract type information from.
-
-##### spec
-
-`any`
-
-The entire OpenAPI specification object.
-
-##### convertDataType
-
-`Function`
-
-The function that converts OpenAPI Specification types to native types.
-
-#### Returns
-
-`any`
-
-A tuple containing the type, subType and subSchemaRef information.
-
-***
-
-### loadSpec()
-
-> `static` **loadSpec**(`file`): `Promise`\<`any`\>
-
-Defined in: [src/OASUtils.ts:179](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L179)
-
-Attempts to load the Open API specification at the given path or URL.
-
-#### Parameters
-
-##### file
-
-`string`
-
-The path or URL of the OpenAPI Specification file to load.
-
-#### Returns
-
-`Promise`\<`any`\>
-
-A promise whose result will be the loaded OpenAPI Specification as an object.

package/docs/reference/classes/ObjectFactory.md

@@ -1,276 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / ObjectFactory
-
-# Class: ObjectFactory
-
-Defined in: [src/ObjectFactory.ts:36](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L36)
-
-The `ObjectFactory` is a manager for creating objects based on registered
-class types. This allows for the tracking of multiple instances of objects
-so that references can be referenced by unique name.
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Constructors
-
-### Constructor
-
-> **new ObjectFactory**(`config?`, `logger?`): `ObjectFactory`
-
-Defined in: [src/ObjectFactory.ts:55](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L55)
-
-#### Parameters
-
-##### config?
-
-`any`
-
-##### logger?
-
-`any`
-
-#### Returns
-
-`ObjectFactory`
-
-## Properties
-
-### classes
-
-> `readonly` **classes**: `Map`\<`string`, `any`\>
-
-Defined in: [src/ObjectFactory.ts:38](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L38)
-
-A map for string fully qualified class names to their class types.
-
-***
-
-### config
-
-> `protected` **config**: `any`
-
-Defined in: [src/ObjectFactory.ts:41](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L41)
-
-The global application configuration object.
-
-***
-
-### instances
-
-> `readonly` **instances**: `Map`\<`string`, `any`\>
-
-Defined in: [src/ObjectFactory.ts:44](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L44)
-
-A map for the unique name to the intance of a particular class type.
-
-***
-
-### logger
-
-> `protected` **logger**: `any`
-
-Defined in: [src/ObjectFactory.ts:47](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L47)
-
-The application logging utility.
-
-## Methods
-
-### clear()
-
-> **clear**(): `void`
-
-Defined in: [src/ObjectFactory.ts:158](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L158)
-
-Deletes all instantiated objects.
-
-#### Returns
-
-`void`
-
-***
-
-### clearAll()
-
-> **clearAll**(): `void`
-
-Defined in: [src/ObjectFactory.ts:166](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L166)
-
-Deletes all instantiated objects and registered class types.
-
-#### Returns
-
-`void`
-
-***
-
-### destroy()
-
-> **destroy**(`objs?`): `Promise`\<`void`\>
-
-Defined in: [src/ObjectFactory.ts:117](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L117)
-
-Destroys the specified objects. If `undefined` is passed in, all objects managed by the factory are destroyed.
-
-#### Parameters
-
-##### objs?
-
-`any`
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### getInitMethods()
-
-> **getInitMethods**(`obj`): `Function`[]
-
-Defined in: [src/ObjectFactory.ts:248](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L248)
-
-Searches an object for one or more functions that implement a `@Init` decorator.
-
-#### Parameters
-
-##### obj
-
-`any`
-
-The object to search.
-
-#### Returns
-
-`Function`[]
-
-The list of functions that implements the `@Init` decorator if found, otherwise undefined.
-
-***
-
-### getInstance()
-
-> **getInstance**\<`T`\>(`nameOrType`): `T` \| `undefined`
-
-Defined in: [src/ObjectFactory.ts:282](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L282)
-
-Returns the object instance with the given unique name. Unique names take the form `<ClassName>:<InstanceName>`.
-It is possible to only specifiy the `<ClassName>`, doing so will automatically look for the `<ClassName>:default`
-instance or the first found instance of the given type.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### nameOrType
-
-`any`
-
-The unique name or class type of the object to retrieve.
-
-#### Returns
-
-`T` \| `undefined`
-
-The object instance associated with the given name if found, otherwise `undefined`.
-
-***
-
-### initialize()
-
-> **initialize**\<`T`\>(`obj`): `T` \| `Promise`\<`T`\>
-
-Defined in: [src/ObjectFactory.ts:175](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L175)
-
-Scans the given object for any properties with the `@Inject` decorator and assigns the correct values.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### obj
-
-`any`
-
-The object to initialize with injected defaults
-
-#### Returns
-
-`T` \| `Promise`\<`T`\>
-
-***
-
-### newInstance()
-
-> **newInstance**\<`T`\>(`type`, `options?`): `T` \| `Promise`\<`T`\>
-
-Defined in: [src/ObjectFactory.ts:323](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L323)
-
-Creates a new instance of the class specified with the provided unique name or type and constructor arguments. If an existing
-object has already been created with the given name, that instance is returned, otherwise a new instance is created
-using the provided arguments.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### 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)
-
-The options to use when instantiating the new class object.
-
-#### Returns
-
-`T` \| `Promise`\<`T`\>
-
-***
-
-### register()
-
-> **register**(`clazz`, `fqn?`): `void`
-
-Defined in: [src/ObjectFactory.ts:399](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L399)
-
-Registers the given class type for the provided fully qualified name.
-
-#### Parameters
-
-##### clazz
-
-`any`
-
-The class type to register.
-
-##### fqn?
-
-`string`
-
-The fully qualified name of the class to register. If not specified, the class name will be used.
-
-#### Returns
-
-`void`

package/docs/reference/classes/ObjectUtils.md

@@ -1,60 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / ObjectUtils
-
-# Class: ObjectUtils
-
-Defined in: [src/ObjectUtils.ts:12](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectUtils.ts#L12)
-
-Utility class for working with objects.
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Constructors
-
-### Constructor
-
-> **new ObjectUtils**(): `ObjectUtils`
-
-#### Returns
-
-`ObjectUtils`
-
-## Methods
-
-### validate()
-
-> `static` **validate**(`obj`, `clazz?`, `recurse?`): `void`
-
-Defined in: [src/ObjectUtils.ts:21](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectUtils.ts#L21)
-
-Performs validation of the given object or array. Validation is performed by scanning the object class for properties
-decorated with `@Validator` and executing the provided validation function.
-
-#### Parameters
-
-##### obj
-
-`any`
-
-The object or array of objects to validate.
-
-##### clazz?
-
-`any`
-
-The class type that contains the validation metadata.
-
-##### recurse?
-
-`boolean`
-
-Set to `true` to validate all child objects.
-
-#### Returns
-
-`void`