@rapidrest/core 1.3.0 → 1.3.2

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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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`\>

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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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/df82e91f4c858ef61526c7f35789a4199b84d999/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:170](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L170)
-
-#### 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:216](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L216)
-
-#### 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:270](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L270)
-
-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:320](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L320)
-
-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.