@rapidrest/core 1.0.1

package/docs/reference/classes/UserUtils.md

@@ -0,0 +1,239 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / UserUtils
+
+# Class: UserUtils
+
+Defined in: src/UserUtils.ts:16
+
+Utilities for working with authenticated user objects. An user object is expected to have the following
+properties.
+
+* `uid` - Universally unique identifier for the user
+* `email` - Unique e-mail address for the user
+* `roles` - A list of unique names indicating the permissions of the user.
+* `verified` - Indicates if the user's e-mail address has been verified.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Constructors
+
+### Constructor
+
+> **new UserUtils**(): `UserUtils`
+
+#### Returns
+
+`UserUtils`
+
+## Methods
+
+### getExternalId()
+
+> `static` **getExternalId**(`user`, `type`): `string` \| `undefined`
+
+Defined in: src/UserUtils.ts:96
+
+Returns the unique identifier of the specified type associated with the given user.
+
+#### Parameters
+
+##### user
+
+`any`
+
+The user to retrieve the external id from.
+
+##### type
+
+`string`
+
+The type of external provider to retrieve.
+
+#### Returns
+
+`string` \| `undefined`
+
+The unique id of the external provider for the given type if found, otherwise `undefined`.
+
+***
+
+### hasOrganization()
+
+> `static` **hasOrganization**(`user`, `organizationUid`): `boolean`
+
+Defined in: src/UserUtils.ts:22
+
+Returns `true` if the given user object is a member of the organization with the specified uid, otherwise returns `false`.
+
+#### Parameters
+
+##### user
+
+`any`
+
+The user object to inspect.
+
+##### organizationUid
+
+`string`
+
+The universally unique identifier of the persona to search for.
+
+#### Returns
+
+`boolean`
+
+***
+
+### hasOrganizations()
+
+> `static` **hasOrganizations**(`user`, `organizationUids?`): `boolean`
+
+Defined in: src/UserUtils.ts:39
+
+Returns `true` if the given user object contains is a member of an organization matching one of the uids in the specified list, otherwise returns `false`.
+
+#### Parameters
+
+##### user
+
+`any`
+
+The user object to inspect.
+
+##### organizationUids?
+
+`string`[]
+
+The list of universally unique identifiers to search for.
+
+#### Returns
+
+`boolean`
+
+***
+
+### hasPersona()
+
+> `static` **hasPersona**(`user`, `personaUid?`): `boolean`
+
+Defined in: src/UserUtils.ts:58
+
+Returns `true` if the given user object contains a `Persona` object with the specified uid, otherwise returns `false`.
+
+#### Parameters
+
+##### user
+
+`any`
+
+The user object to inspect.
+
+##### personaUid?
+
+`string`
+
+The universally unique identifier of the persona to search for.
+
+#### Returns
+
+`boolean`
+
+***
+
+### hasPersonas()
+
+> `static` **hasPersonas**(`user`, `personaUids?`): `boolean`
+
+Defined in: src/UserUtils.ts:75
+
+Returns `true` if the given user object contains a `Persona` object matching one of the uids in the specified list, otherwise returns `false`.
+
+#### Parameters
+
+##### user
+
+`any`
+
+The user object to inspect.
+
+##### personaUids?
+
+`string`[]
+
+#### Returns
+
+`boolean`
+
+***
+
+### hasRole()
+
+> `static` **hasRole**(`user`, `role?`, `orgUid?`): `boolean`
+
+Defined in: src/UserUtils.ts:118
+
+Returns `true` if the given user object has a role with the specified name, otherwise returns `false`.
+
+#### Parameters
+
+##### user
+
+`any`
+
+The user object to inspect.
+
+##### role?
+
+`string`
+
+The unique name of the role to search for.
+
+##### orgUid?
+
+`string`
+
+The unique identifier of an organization whose role will be verified.
+
+#### Returns
+
+`boolean`
+
+***
+
+### hasRoles()
+
+> `static` **hasRoles**(`user`, `roles?`, `orgUid?`): `boolean`
+
+Defined in: src/UserUtils.ts:143
+
+Returns `true` if the given user object has at least one role from the specified list of names, otherwise returns `false`.
+
+#### Parameters
+
+##### user
+
+`any`
+
+The user object to inspect.
+
+##### roles?
+
+`string`[]
+
+A list of unique names of the roles to search for.
+
+##### orgUid?
+
+`string`
+
+The unique identifier of an organization whose role will be verified.
+
+#### Returns
+
+`boolean`

package/docs/reference/classes/ValidationUtils.md

@@ -0,0 +1,294 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / ValidationUtils
+
+# Class: ValidationUtils
+
+Defined in: src/ValidationUtils.ts:14
+
+A collection of validation functions to use with the `@Validator()` decorator.
+
+## Constructors
+
+### Constructor
+
+> **new ValidationUtils**(): `ValidationUtils`
+
+#### Returns
+
+`ValidationUtils`
+
+## Methods
+
+### check()
+
+> `static` **check**(`val`, `func`): `any`
+
+Defined in: src/ValidationUtils.ts:23
+
+A simple wrapper that calls the specified boolean validation function with the given value and returns the
+value as a result if the validation function passes. Otherwise throws an error.
+
+#### Parameters
+
+##### val
+
+`any`
+
+The value to validate.
+
+##### func
+
+[`BooleanFunc`](../type-aliases/BooleanFunc.md)
+
+The boolean validation function to check the value.
+
+#### Returns
+
+`any`
+
+#### Throws
+
+Throws an error if the value fails the boolean validation test.
+
+***
+
+### checkDate()
+
+> `static` **checkDate**(`val`): `string`
+
+Defined in: src/ValidationUtils.ts:33
+
+Validates that the provided string represents a ISO, RFC or UTC date or timestamp.
+
+#### Parameters
+
+##### val
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### checkEmail()
+
+> `static` **checkEmail**(`val`): `string`
+
+Defined in: src/ValidationUtils.ts:43
+
+Validates that the provided string represents a valid e-mail address.
+
+#### Parameters
+
+##### val
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### checkEmpty()
+
+> `static` **checkEmpty**(`val`): `any`[]
+
+Defined in: src/ValidationUtils.ts:53
+
+Validates that the provided array is not empty.
+
+#### Parameters
+
+##### val
+
+`any`[]
+
+#### Returns
+
+`any`[]
+
+***
+
+### checkIP()
+
+> `static` **checkIP**(`val`): `string`
+
+Defined in: src/ValidationUtils.ts:63
+
+Validates that the provided string is a valid IP address.
+
+#### Parameters
+
+##### val
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### checkJSON()
+
+> `static` **checkJSON**(`val`): `string`
+
+Defined in: src/ValidationUtils.ts:73
+
+Validates that the provided string is valid JSON (note: uses `JSON.parse`).
+
+#### Parameters
+
+##### val
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### checkName()
+
+> `static` **checkName**(`val`): `string`
+
+Defined in: src/ValidationUtils.ts:83
+
+Validates that the provided string matches the regexp pattern /[a-zA-Z0-9_\-\.@:\+]+/.
+
+#### Parameters
+
+##### val
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### checkNull()
+
+> `static` **checkNull**(`val`): `any`
+
+Defined in: src/ValidationUtils.ts:93
+
+Validates that the provided object is not null or empty.
+
+#### Parameters
+
+##### val
+
+`any`
+
+#### Returns
+
+`any`
+
+***
+
+### checkPhone()
+
+> `static` **checkPhone**(`val`): `string`
+
+Defined in: src/ValidationUtils.ts:103
+
+Validates that the provided string represents a valid phone number.
+
+#### Parameters
+
+##### val
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### checkSemVer()
+
+> `static` **checkSemVer**(`val`): `string`
+
+Defined in: src/ValidationUtils.ts:113
+
+Validates that the provided string represents a semantic version.
+
+#### Parameters
+
+##### val
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### checkURL()
+
+> `static` **checkURL**(`val`): `string`
+
+Defined in: src/ValidationUtils.ts:123
+
+Validates that the provided string is a valid URL.
+
+#### Parameters
+
+##### val
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### checkUUID()
+
+> `static` **checkUUID**(`val`): `string`
+
+Defined in: src/ValidationUtils.ts:133
+
+Validates that the provided string is a valid UUID.
+
+#### Parameters
+
+##### val
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### checkVersion()
+
+> `static` **checkVersion**(`val`): `number`
+
+Defined in: src/ValidationUtils.ts:143
+
+Validates that the provided value is an entity `version` number (e.g. `value > 0`).
+
+#### Parameters
+
+##### val
+
+`any`
+
+#### Returns
+
+`number`

package/docs/reference/enumerations/AlertPriority.md

@@ -0,0 +1,61 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / AlertPriority
+
+# Enumeration: AlertPriority
+
+Defined in: src/AlertUtils.ts:24
+
+Describes the level of priority for a given alert and an importance for triaging the problem.
+
+## Enumeration Members
+
+### Critical
+
+> **Critical**: `"P1"`
+
+Defined in: src/AlertUtils.ts:26
+
+Describes an alert that affects critical operating functionality or infrastructure.
+
+***
+
+### Important
+
+> **Important**: `"P3"`
+
+Defined in: src/AlertUtils.ts:30
+
+Describes an alert that affects basic systems that may create a poor end-user experience.
+
+***
+
+### Notice
+
+> **Notice**: `"P5"`
+
+Defined in: src/AlertUtils.ts:34
+
+Describes an alert that has no material affect on end-user experience and no potential for escalation.
+
+***
+
+### Severe
+
+> **Severe**: `"P2"`
+
+Defined in: src/AlertUtils.ts:28
+
+Describes an alert that affects key systems that have great impact on end-user experiences.
+
+***
+
+### Warning
+
+> **Warning**: `"P4"`
+
+Defined in: src/AlertUtils.ts:32
+
+Describes an alert that has no material affect on the end-user experience but with potential to escalate.

package/docs/reference/enumerations/JWTUtilsCompressionMethods.md

@@ -0,0 +1,21 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / JWTUtilsCompressionMethods
+
+# Enumeration: JWTUtilsCompressionMethods
+
+Defined in: src/JWTUtils.ts:55
+
+Describes the different types of support compression methods for JWT payloads.
+
+## Enumeration Members
+
+### ZLIB
+
+> **ZLIB**: `"zlib"`
+
+Defined in: src/JWTUtils.ts:57
+
+Uses the zlib compression method.

package/docs/reference/enumerations/WorkerMessageType.md

@@ -0,0 +1,43 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / WorkerMessageType
+
+# Enumeration: WorkerMessageType
+
+Defined in: src/threads/ThreadWorker.ts:7
+
+Describes the types of messages passed between the parent thread pool manager and a worker thread.
+
+## Enumeration Members
+
+### ERROR
+
+> **ERROR**: `"_WorkerError"`
+
+Defined in: src/threads/ThreadWorker.ts:8
+
+***
+
+### LOG
+
+> **LOG**: `"_WorkerLog"`
+
+Defined in: src/threads/ThreadWorker.ts:9
+
+***
+
+### ONLINE
+
+> **ONLINE**: `"_WorkerOnline"`
+
+Defined in: src/threads/ThreadWorker.ts:10
+
+***
+
+### STOP
+
+> **STOP**: `"_StopWorker"`
+
+Defined in: src/threads/ThreadWorker.ts:11

package/docs/reference/functions/sleep.md

@@ -0,0 +1,25 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / sleep
+
+# Function: sleep()
+
+> **sleep**(`ms`): `Promise`\<`void`\>
+
+Defined in: src/sleep.ts:8
+
+Starts a timer to suspend execution for a given number of milliseconds.
+
+## Parameters
+
+### ms
+
+`number` = `1`
+
+The number of milliseconds to suspend. Default is `1`.
+
+## Returns
+
+`Promise`\<`void`\>