@rapidrest/core 1.3.1 → 1.3.2

package/docs/reference/classes/FileUtils.md

@@ -1,193 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / FileUtils
-
-# Class: FileUtils
-
-Defined in: [src/FileUtils.ts:17](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/FileUtils.ts#L17)
-
-Utility functions for working with files.
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Constructors
-
-### Constructor
-
-> **new FileUtils**(): `FileUtils`
-
-#### Returns
-
-`FileUtils`
-
-## Methods
-
-### copyBinaryFile()
-
-> `static` **copyBinaryFile**(`srcPath`, `outPath`, `variables?`): `Promise`\<`void`\>
-
-Defined in: [src/FileUtils.ts:159](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/FileUtils.ts#L159)
-
-Generates a copy of the source file at the desired output destination using binary copy mode.
-
-#### Parameters
-
-##### srcPath
-
-`string`
-
-The source file to copy.
-
-##### outPath
-
-`string`
-
-The destination file to generate.
-
-##### variables?
-
-`any` = `{}`
-
-The map of variable names to values to swap. Applies to outPath only.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### copyDirectory()
-
-> `static` **copyDirectory**(`srcPath`, `outPath`, `vars?`, `excludeFilters?`, `binaryFilters?`, `force?`): `Promise`\<`void`\>
-
-Defined in: [src/FileUtils.ts:187](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/FileUtils.ts#L187)
-
-Performs a deep copy of a directory tree at the given srcPath to the specified output directory. Performs
-template replacement for all variables given and skips any files in the specified filter.
-
-#### Parameters
-
-##### srcPath
-
-`string`
-
-The path to the source directory to copy files from.
-
-##### outPath
-
-`string`
-
-The path to the destination directory to copy files to.
-
-##### vars?
-
-`any` = `{}`
-
-The map of template variables to perform replacement on.
-
-##### excludeFilters?
-
-`string`[] = `[]`
-
-The list of file extension filters to exclude during the copy process.
-
-##### binaryFilters?
-
-`string`[] = `[]`
-
-The list of file extension filters to copy as binary only.
-
-##### force?
-
-`boolean` = `false`
-
-Set to `true` to force writing over any existing files.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### copyFile()
-
-> `static` **copyFile**(`srcPath`, `outPath`, `variables?`, `overwrite?`): `Promise`\<`void`\>
-
-Defined in: [src/FileUtils.ts:123](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/FileUtils.ts#L123)
-
-Generates a copy of the source file at the desired output destination and performs a swap of all values of the
-variables specified.
-
-#### Parameters
-
-##### srcPath
-
-`string`
-
-The source file to copy.
-
-##### outPath
-
-`string`
-
-The destination file to generate.
-
-##### variables?
-
-`any` = `{}`
-
-The map of variable names to values to swap.
-
-##### overwrite?
-
-`boolean` = `false`
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### writeFile()
-
-> `static` **writeFile**(`srcPath`, `outPath`, `contents`, `overwrite?`): `Promise`\<`void`\>
-
-Defined in: [src/FileUtils.ts:28](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/FileUtils.ts#L28)
-
-Attempts to write the provided contents to the file path given. If a file already exists the user is prompted to
-allow the file to be overwritten or merged. In the case of a merge, srcPath is used as a baseline in order to
-perform a 3-way merge.
-
-#### Parameters
-
-##### srcPath
-
-`string`
-
-The baseline template file to use during a merge.
-
-##### outPath
-
-`string`
-
-The destination file path to be written.
-
-##### contents
-
-`any`
-
-The contents of the file to write.
-
-##### overwrite?
-
-`boolean` = `false`
-
-Set to `true` to overwite the file and not perform a merge.
-
-#### Returns
-
-`Promise`\<`void`\>

package/docs/reference/classes/JWTUtils.md

@@ -1,139 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / JWTUtils
-
-# Class: JWTUtils
-
-Defined in: [src/JWTUtils.ts:145](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L145)
-
-Utility class for working with Json Web Token (JWT) authentication tokens.
-
-## Author
-
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-
-## Constructors
-
-### Constructor
-
-> **new JWTUtils**(): `JWTUtils`
-
-#### Returns
-
-`JWTUtils`
-
-## Methods
-
-### createToken()
-
-> `static` **createToken**(`config`, `user`, `data?`): `Promise`\<`string`\>
-
-Defined in: [src/JWTUtils.ts:172](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L172)
-
-#### Parameters
-
-##### config
-
-[`JWTUtilsConfig`](../interfaces/JWTUtilsConfig.md)
-
-##### user
-
-[`JWTUser`](../interfaces/JWTUser.md)
-
-##### data?
-
-`any`
-
-#### Returns
-
-`Promise`\<`string`\>
-
-***
-
-### createTokenSync()
-
-> `static` **createTokenSync**(`config`, `user`, `data?`): `string`
-
-Defined in: [src/JWTUtils.ts:218](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L218)
-
-#### Parameters
-
-##### config
-
-[`JWTUtilsConfig`](../interfaces/JWTUtilsConfig.md)
-
-##### user
-
-[`JWTUser`](../interfaces/JWTUser.md)
-
-##### data?
-
-`any`
-
-#### Returns
-
-`string`
-
-***
-
-### decodeToken()
-
-> `static` **decodeToken**(`config`, `token`): `Promise`\<[`JWTPayload`](../interfaces/JWTPayload.md)\>
-
-Defined in: [src/JWTUtils.ts:272](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L272)
-
-Decodes the given JWT authentication token using the provided configuration. If the token is not valid an
-error is thrown with the reason. Returns the encoded user object payload upon success.
-
-#### Parameters
-
-##### config
-
-[`JWTUtilsConfig`](../interfaces/JWTUtilsConfig.md)
-
-The JWT configuration to use when validating the token.
-
-##### token
-
-`string`
-
-The JWT token to validate.
-
-#### Returns
-
-`Promise`\<[`JWTPayload`](../interfaces/JWTPayload.md)\>
-
-The data encoded in the token's payload.
-
-***
-
-### decodeTokenSync()
-
-> `static` **decodeTokenSync**(`config`, `token`): [`JWTPayload`](../interfaces/JWTPayload.md)
-
-Defined in: [src/JWTUtils.ts:322](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L322)
-
-Decodes the given JWT authentication token using the provided configuration. If the token is not valid an
-error is thrown with the reason. Returns the encoded user object payload upon success.
-
-#### Parameters
-
-##### config
-
-[`JWTUtilsConfig`](../interfaces/JWTUtilsConfig.md)
-
-The JWT configuration to use when validating the token.
-
-##### token
-
-`string`
-
-The JWT token to validate.
-
-#### Returns
-
-[`JWTPayload`](../interfaces/JWTPayload.md)
-
-The data encoded in the token's payload.

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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L76)
-
-***
-
-### slackConfigs
-
-> `protected` **slackConfigs**: `any`[] = `[]`
-
-Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L78)
-
-## Methods
-
-### init()
-
-> **init**(): `Promise`\<`void`\>
-
-Defined in: [src/MessagingUtils.ts:96](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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.