@rapidrest/core 1.1.4 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/JWTUtils.js +11 -8
- package/dist/lib/JWTUtils.js.map +1 -1
- package/dist/lib/ObjectFactory.js +5 -5
- package/dist/lib/ObjectFactory.js.map +1 -1
- package/dist/lib/UserUtils.js +0 -32
- package/dist/lib/UserUtils.js.map +1 -1
- package/dist/lib/decorators/ObjectDecorators.js +1 -5
- package/dist/lib/decorators/ObjectDecorators.js.map +1 -1
- package/dist/lib/threads/ThreadPool.js +0 -1
- package/dist/lib/threads/ThreadPool.js.map +1 -1
- package/dist/types/ObjectFactory.d.ts +4 -3
- package/dist/types/UserUtils.d.ts +0 -12
- package/dist/types/decorators/ObjectDecorators.d.ts +1 -5
- package/dist/types/threads/ThreadPool.d.ts +0 -1
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Config.md +4 -18
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Destroy.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Init.md +3 -3
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Inject.md +6 -18
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Logger.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Nullable.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Validator.md +2 -16
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/type-aliases/ValidatorFunction.md +2 -2
- package/docs/reference/classes/AlertUtils.md +10 -10
- package/docs/reference/classes/ApiError.md +10 -22
- package/docs/reference/classes/ClassLoader.md +17 -17
- package/docs/reference/classes/Event.md +8 -8
- package/docs/reference/classes/EventUtils.md +4 -4
- package/docs/reference/classes/FileUtils.md +17 -17
- package/docs/reference/classes/JWTUtils.md +5 -5
- package/docs/reference/classes/MessagingUtils.md +12 -12
- package/docs/reference/classes/OASUtils.md +8 -8
- package/docs/reference/classes/ObjectFactory.md +25 -23
- package/docs/reference/classes/ObjectUtils.md +2 -2
- package/docs/reference/classes/StringUtils.md +8 -8
- package/docs/reference/classes/ThreadPool.md +25 -25
- package/docs/reference/classes/ThreadWorker.md +6 -6
- package/docs/reference/classes/UserUtils.md +10 -64
- package/docs/reference/classes/ValidationUtils.md +14 -14
- package/docs/reference/enumerations/AlertPriority.md +6 -6
- package/docs/reference/enumerations/JWTUtilsCompressionMethods.md +2 -2
- package/docs/reference/enumerations/WorkerMessageType.md +5 -5
- package/docs/reference/functions/sleep.md +3 -3
- package/docs/reference/interfaces/Alert.md +14 -14
- package/docs/reference/interfaces/AlertAttachment.md +6 -6
- package/docs/reference/interfaces/AlertClose.md +5 -5
- package/docs/reference/interfaces/AlertUtilsAttachmentOptions.md +6 -6
- package/docs/reference/interfaces/AlertUtilsOptions.md +5 -5
- package/docs/reference/interfaces/InstanceOptions.md +13 -7
- package/docs/reference/interfaces/JWTPayload.md +15 -15
- package/docs/reference/interfaces/JWTUser.md +6 -6
- package/docs/reference/interfaces/JWTUtilsConfig.md +6 -6
- package/docs/reference/interfaces/JWTUtilsPayloadKeyOptions.md +8 -8
- package/docs/reference/interfaces/JWTUtilsPayloadOptions.md +5 -5
- package/docs/reference/interfaces/JWTUtilsPayloadPasswordOptions.md +9 -9
- package/docs/reference/interfaces/NewEvent.md +2 -2
- package/docs/reference/interfaces/OriginSettings.md +3 -3
- package/docs/reference/interfaces/SlackConfig.md +4 -4
- package/docs/reference/interfaces/SmtpAuth.md +3 -3
- package/docs/reference/interfaces/SmtpConfig.md +6 -6
- package/docs/reference/interfaces/Template.md +24 -24
- package/docs/reference/interfaces/TemplateMapBase.md +2 -2
- package/docs/reference/interfaces/TwilioConfig.md +5 -5
- package/docs/reference/interfaces/WorkerMessage.md +4 -4
- package/docs/reference/interfaces/WorkerOptions.md +11 -11
- package/docs/reference/type-aliases/BooleanFunc.md +2 -2
- package/docs/reference/type-aliases/TemplateMap.md +1 -1
- package/docs/reference/type-aliases/WorkerCallback.md +2 -2
- package/docs/reference/variables/Logger.md +5 -1
- package/package.json +96 -96
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: JWTPayload
|
|
8
8
|
|
|
9
|
-
Defined in: [src/JWTUtils.ts:38](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/JWTUtils.ts:38](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L38)
|
|
10
10
|
|
|
11
11
|
Describes the payload data structure of signed JWT tokens.
|
|
12
12
|
|
|
@@ -16,13 +16,13 @@ Describes the payload data structure of signed JWT tokens.
|
|
|
16
16
|
|
|
17
17
|
## Indexable
|
|
18
18
|
|
|
19
|
-
\[`key`: `string`\]: `any`
|
|
19
|
+
> \[`key`: `string`\]: `any`
|
|
20
20
|
|
|
21
21
|
## Properties
|
|
22
22
|
|
|
23
23
|
### aud?
|
|
24
24
|
|
|
25
|
-
> `optional` **aud
|
|
25
|
+
> `optional` **aud?**: `string` \| `string`[]
|
|
26
26
|
|
|
27
27
|
Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:115
|
|
28
28
|
|
|
@@ -34,9 +34,9 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:115
|
|
|
34
34
|
|
|
35
35
|
### compression?
|
|
36
36
|
|
|
37
|
-
> `optional` **compression
|
|
37
|
+
> `optional` **compression?**: `"zlib"`
|
|
38
38
|
|
|
39
|
-
Defined in: [src/JWTUtils.ts:40](https://github.com/rapidrest/core/blob/
|
|
39
|
+
Defined in: [src/JWTUtils.ts:40](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L40)
|
|
40
40
|
|
|
41
41
|
Indicates if the payload profile has been compressed and with what method.
|
|
42
42
|
|
|
@@ -44,9 +44,9 @@ Indicates if the payload profile has been compressed and with what method.
|
|
|
44
44
|
|
|
45
45
|
### encryption?
|
|
46
46
|
|
|
47
|
-
> `optional` **encryption
|
|
47
|
+
> `optional` **encryption?**: `boolean`
|
|
48
48
|
|
|
49
|
-
Defined in: [src/JWTUtils.ts:43](https://github.com/rapidrest/core/blob/
|
|
49
|
+
Defined in: [src/JWTUtils.ts:43](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L43)
|
|
50
50
|
|
|
51
51
|
Indicates if the payload profile has been encrypted.
|
|
52
52
|
|
|
@@ -54,7 +54,7 @@ Indicates if the payload profile has been encrypted.
|
|
|
54
54
|
|
|
55
55
|
### exp?
|
|
56
56
|
|
|
57
|
-
> `optional` **exp
|
|
57
|
+
> `optional` **exp?**: `number`
|
|
58
58
|
|
|
59
59
|
Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:116
|
|
60
60
|
|
|
@@ -66,7 +66,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:116
|
|
|
66
66
|
|
|
67
67
|
### iat?
|
|
68
68
|
|
|
69
|
-
> `optional` **iat
|
|
69
|
+
> `optional` **iat?**: `number`
|
|
70
70
|
|
|
71
71
|
Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:118
|
|
72
72
|
|
|
@@ -78,7 +78,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:118
|
|
|
78
78
|
|
|
79
79
|
### iss?
|
|
80
80
|
|
|
81
|
-
> `optional` **iss
|
|
81
|
+
> `optional` **iss?**: `string`
|
|
82
82
|
|
|
83
83
|
Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:113
|
|
84
84
|
|
|
@@ -90,7 +90,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:113
|
|
|
90
90
|
|
|
91
91
|
### jti?
|
|
92
92
|
|
|
93
|
-
> `optional` **jti
|
|
93
|
+
> `optional` **jti?**: `string`
|
|
94
94
|
|
|
95
95
|
Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:119
|
|
96
96
|
|
|
@@ -102,7 +102,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:119
|
|
|
102
102
|
|
|
103
103
|
### nbf?
|
|
104
104
|
|
|
105
|
-
> `optional` **nbf
|
|
105
|
+
> `optional` **nbf?**: `number`
|
|
106
106
|
|
|
107
107
|
Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:117
|
|
108
108
|
|
|
@@ -116,7 +116,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:117
|
|
|
116
116
|
|
|
117
117
|
> **profile**: `string` \| [`JWTUser`](JWTUser.md)
|
|
118
118
|
|
|
119
|
-
Defined in: [src/JWTUtils.ts:46](https://github.com/rapidrest/core/blob/
|
|
119
|
+
Defined in: [src/JWTUtils.ts:46](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L46)
|
|
120
120
|
|
|
121
121
|
The user profile of the authenticated user the token is valid for.
|
|
122
122
|
|
|
@@ -126,7 +126,7 @@ The user profile of the authenticated user the token is valid for.
|
|
|
126
126
|
|
|
127
127
|
> **sessionUid**: `string`
|
|
128
128
|
|
|
129
|
-
Defined in: [src/JWTUtils.ts:49](https://github.com/rapidrest/core/blob/
|
|
129
|
+
Defined in: [src/JWTUtils.ts:49](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L49)
|
|
130
130
|
|
|
131
131
|
The unique identifier of the user's authentication session.
|
|
132
132
|
|
|
@@ -134,7 +134,7 @@ The unique identifier of the user's authentication session.
|
|
|
134
134
|
|
|
135
135
|
### sub?
|
|
136
136
|
|
|
137
|
-
> `optional` **sub
|
|
137
|
+
> `optional` **sub?**: `string`
|
|
138
138
|
|
|
139
139
|
Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:114
|
|
140
140
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: JWTUser
|
|
8
8
|
|
|
9
|
-
Defined in: [src/JWTUtils.ts:13](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/JWTUtils.ts:13](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L13)
|
|
10
10
|
|
|
11
11
|
Describes user data that is encoded in the payload of a JWT token.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
20
20
|
|
|
21
21
|
> **name**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [src/JWTUtils.ts:22](https://github.com/rapidrest/core/blob/
|
|
23
|
+
Defined in: [src/JWTUtils.ts:22](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L22)
|
|
24
24
|
|
|
25
25
|
The unique name of the user.
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ The unique name of the user.
|
|
|
30
30
|
|
|
31
31
|
> **roles**: `string`[]
|
|
32
32
|
|
|
33
|
-
Defined in: [src/JWTUtils.ts:27](https://github.com/rapidrest/core/blob/
|
|
33
|
+
Defined in: [src/JWTUtils.ts:27](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L27)
|
|
34
34
|
|
|
35
35
|
The list of roles (by name) that the user is apart of and will assume privileges for.
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@ The list of roles (by name) that the user is apart of and will assume privileges
|
|
|
40
40
|
|
|
41
41
|
> **uid**: `string`
|
|
42
42
|
|
|
43
|
-
Defined in: [src/JWTUtils.ts:17](https://github.com/rapidrest/core/blob/
|
|
43
|
+
Defined in: [src/JWTUtils.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L17)
|
|
44
44
|
|
|
45
45
|
The universally unique identifier of the user.
|
|
46
46
|
|
|
@@ -48,8 +48,8 @@ The universally unique identifier of the user.
|
|
|
48
48
|
|
|
49
49
|
### verified?
|
|
50
50
|
|
|
51
|
-
> `optional` **verified
|
|
51
|
+
> `optional` **verified?**: `boolean`
|
|
52
52
|
|
|
53
|
-
Defined in: [src/JWTUtils.ts:32](https://github.com/rapidrest/core/blob/
|
|
53
|
+
Defined in: [src/JWTUtils.ts:32](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L32)
|
|
54
54
|
|
|
55
55
|
Indicates if the user's e-mail address has been verified.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: JWTUtilsConfig
|
|
8
8
|
|
|
9
|
-
Defined in: [src/JWTUtils.ts:123](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/JWTUtils.ts:123](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L123)
|
|
10
10
|
|
|
11
11
|
Describes the configuration options to be used with `JWTUtils` functions.
|
|
12
12
|
|
|
@@ -18,9 +18,9 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
18
18
|
|
|
19
19
|
### options?
|
|
20
20
|
|
|
21
|
-
> `optional` **options
|
|
21
|
+
> `optional` **options?**: `VerifyOptions`
|
|
22
22
|
|
|
23
|
-
Defined in: [src/JWTUtils.ts:132](https://github.com/rapidrest/core/blob/
|
|
23
|
+
Defined in: [src/JWTUtils.ts:132](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L132)
|
|
24
24
|
|
|
25
25
|
The options to use when performing JWT signing or verification.
|
|
26
26
|
|
|
@@ -28,9 +28,9 @@ The options to use when performing JWT signing or verification.
|
|
|
28
28
|
|
|
29
29
|
### payload?
|
|
30
30
|
|
|
31
|
-
> `optional` **payload
|
|
31
|
+
> `optional` **payload?**: [`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md) \| [`JWTUtilsPayloadPasswordOptions`](JWTUtilsPayloadPasswordOptions.md) \| [`JWTUtilsPayloadKeyOptions`](JWTUtilsPayloadKeyOptions.md)
|
|
32
32
|
|
|
33
|
-
Defined in: [src/JWTUtils.ts:137](https://github.com/rapidrest/core/blob/
|
|
33
|
+
Defined in: [src/JWTUtils.ts:137](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L137)
|
|
34
34
|
|
|
35
35
|
The options that determine how JWT token payloads will be handled.
|
|
36
36
|
|
|
@@ -40,6 +40,6 @@ The options that determine how JWT token payloads will be handled.
|
|
|
40
40
|
|
|
41
41
|
> **secret**: `Secret`
|
|
42
42
|
|
|
43
|
-
Defined in: [src/JWTUtils.ts:127](https://github.com/rapidrest/core/blob/
|
|
43
|
+
Defined in: [src/JWTUtils.ts:127](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L127)
|
|
44
44
|
|
|
45
45
|
The secret to use for signing and verifying JWT tokens.
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: JWTUtilsPayloadKeyOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [src/JWTUtils.ts:106](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/JWTUtils.ts:106](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L106)
|
|
10
10
|
|
|
11
|
-
Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing
|
|
11
|
+
Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing
|
|
12
12
|
key-based encryption.
|
|
13
13
|
|
|
14
14
|
## Author
|
|
@@ -23,9 +23,9 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
23
23
|
|
|
24
24
|
### compress?
|
|
25
25
|
|
|
26
|
-
> `optional` **compress
|
|
26
|
+
> `optional` **compress?**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
|
|
27
27
|
|
|
28
|
-
Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/
|
|
28
|
+
Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L69)
|
|
29
29
|
|
|
30
30
|
Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
|
|
31
31
|
|
|
@@ -37,9 +37,9 @@ Set the method to use for compressing the payload profile, otherwise set to `nul
|
|
|
37
37
|
|
|
38
38
|
### encrypt?
|
|
39
39
|
|
|
40
|
-
> `optional` **encrypt
|
|
40
|
+
> `optional` **encrypt?**: `boolean`
|
|
41
41
|
|
|
42
|
-
Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/
|
|
42
|
+
Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L74)
|
|
43
43
|
|
|
44
44
|
Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.
|
|
45
45
|
|
|
@@ -53,7 +53,7 @@ Set to `true` to indicate that the JWT token payload is encrypted, otherwise set
|
|
|
53
53
|
|
|
54
54
|
> **private\_key**: `string`
|
|
55
55
|
|
|
56
|
-
Defined in: [src/JWTUtils.ts:110](https://github.com/rapidrest/core/blob/
|
|
56
|
+
Defined in: [src/JWTUtils.ts:110](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L110)
|
|
57
57
|
|
|
58
58
|
The private key used to encrypt JWT token payloads.
|
|
59
59
|
|
|
@@ -63,6 +63,6 @@ The private key used to encrypt JWT token payloads.
|
|
|
63
63
|
|
|
64
64
|
> **public\_key**: `string`
|
|
65
65
|
|
|
66
|
-
Defined in: [src/JWTUtils.ts:115](https://github.com/rapidrest/core/blob/
|
|
66
|
+
Defined in: [src/JWTUtils.ts:115](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L115)
|
|
67
67
|
|
|
68
68
|
The public key used to decrypt JWT token payloads.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: JWTUtilsPayloadOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [src/JWTUtils.ts:65](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/JWTUtils.ts:65](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L65)
|
|
10
10
|
|
|
11
11
|
Describes the configuration options to be used with the `JWTUtilsConfig.payload` property.
|
|
12
12
|
|
|
@@ -23,9 +23,9 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
23
23
|
|
|
24
24
|
### compress?
|
|
25
25
|
|
|
26
|
-
> `optional` **compress
|
|
26
|
+
> `optional` **compress?**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
|
|
27
27
|
|
|
28
|
-
Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/
|
|
28
|
+
Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L69)
|
|
29
29
|
|
|
30
30
|
Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
|
|
31
31
|
|
|
@@ -33,8 +33,8 @@ Set the method to use for compressing the payload profile, otherwise set to `nul
|
|
|
33
33
|
|
|
34
34
|
### encrypt?
|
|
35
35
|
|
|
36
|
-
> `optional` **encrypt
|
|
36
|
+
> `optional` **encrypt?**: `boolean`
|
|
37
37
|
|
|
38
|
-
Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/
|
|
38
|
+
Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L74)
|
|
39
39
|
|
|
40
40
|
Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: JWTUtilsPayloadPasswordOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [src/JWTUtils.ts:83](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/JWTUtils.ts:83](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L83)
|
|
10
10
|
|
|
11
|
-
Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing password
|
|
11
|
+
Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing password
|
|
12
12
|
based encryption.
|
|
13
13
|
|
|
14
14
|
## Author
|
|
@@ -25,7 +25,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
25
25
|
|
|
26
26
|
> **algorithm**: `string`
|
|
27
27
|
|
|
28
|
-
Defined in: [src/JWTUtils.ts:87](https://github.com/rapidrest/core/blob/
|
|
28
|
+
Defined in: [src/JWTUtils.ts:87](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L87)
|
|
29
29
|
|
|
30
30
|
The cryptographic cipher algorithm to use during encryption/decryption of a JWT token payload.
|
|
31
31
|
|
|
@@ -33,9 +33,9 @@ The cryptographic cipher algorithm to use during encryption/decryption of a JWT
|
|
|
33
33
|
|
|
34
34
|
### compress?
|
|
35
35
|
|
|
36
|
-
> `optional` **compress
|
|
36
|
+
> `optional` **compress?**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
|
|
37
37
|
|
|
38
|
-
Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/
|
|
38
|
+
Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L69)
|
|
39
39
|
|
|
40
40
|
Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
|
|
41
41
|
|
|
@@ -47,9 +47,9 @@ Set the method to use for compressing the payload profile, otherwise set to `nul
|
|
|
47
47
|
|
|
48
48
|
### encrypt?
|
|
49
49
|
|
|
50
|
-
> `optional` **encrypt
|
|
50
|
+
> `optional` **encrypt?**: `boolean`
|
|
51
51
|
|
|
52
|
-
Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/
|
|
52
|
+
Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L74)
|
|
53
53
|
|
|
54
54
|
Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.
|
|
55
55
|
|
|
@@ -63,7 +63,7 @@ Set to `true` to indicate that the JWT token payload is encrypted, otherwise set
|
|
|
63
63
|
|
|
64
64
|
> **iv**: `Buffer`
|
|
65
65
|
|
|
66
|
-
Defined in: [src/JWTUtils.ts:92](https://github.com/rapidrest/core/blob/
|
|
66
|
+
Defined in: [src/JWTUtils.ts:92](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L92)
|
|
67
67
|
|
|
68
68
|
The initialization vector to use during encryption and decryption.
|
|
69
69
|
|
|
@@ -73,6 +73,6 @@ The initialization vector to use during encryption and decryption.
|
|
|
73
73
|
|
|
74
74
|
> **password**: `string`
|
|
75
75
|
|
|
76
|
-
Defined in: [src/JWTUtils.ts:97](https://github.com/rapidrest/core/blob/
|
|
76
|
+
Defined in: [src/JWTUtils.ts:97](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L97)
|
|
77
77
|
|
|
78
78
|
The password to use when encrypting or decrypting JWT token payloads.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: NewEvent
|
|
8
8
|
|
|
9
|
-
Defined in: [src/TelemetryUtils.ts:13](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/TelemetryUtils.ts:13](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L13)
|
|
10
10
|
|
|
11
11
|
Describes the required fields when creating a new telemetry event.
|
|
12
12
|
|
|
@@ -20,6 +20,6 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
20
20
|
|
|
21
21
|
> **type**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [src/TelemetryUtils.ts:15](https://github.com/rapidrest/core/blob/
|
|
23
|
+
Defined in: [src/TelemetryUtils.ts:15](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L15)
|
|
24
24
|
|
|
25
25
|
The type of event begin recorded.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: OriginSettings
|
|
8
8
|
|
|
9
|
-
Defined in: [src/MessagingUtils.ts:8](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:8](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L8)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [src/MessagingUtils.ts:8](https://github.com/rapidrest/core/blob/23a
|
|
|
14
14
|
|
|
15
15
|
> **email**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: [src/MessagingUtils.ts:9](https://github.com/rapidrest/core/blob/
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:9](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L9)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,4 +22,4 @@ Defined in: [src/MessagingUtils.ts:9](https://github.com/rapidrest/core/blob/23a
|
|
|
22
22
|
|
|
23
23
|
> **sms**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: [src/MessagingUtils.ts:10](https://github.com/rapidrest/core/blob/
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:10](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L10)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: SlackConfig
|
|
8
8
|
|
|
9
|
-
Defined in: [src/MessagingUtils.ts:48](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:48](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L48)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [src/MessagingUtils.ts:48](https://github.com/rapidrest/core/blob/23
|
|
|
14
14
|
|
|
15
15
|
> **name**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: [src/MessagingUtils.ts:49](https://github.com/rapidrest/core/blob/
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:49](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L49)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [src/MessagingUtils.ts:49](https://github.com/rapidrest/core/blob/23
|
|
|
22
22
|
|
|
23
23
|
> **signingSecret**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: [src/MessagingUtils.ts:51](https://github.com/rapidrest/core/blob/
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:51](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L51)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,4 +30,4 @@ Defined in: [src/MessagingUtils.ts:51](https://github.com/rapidrest/core/blob/23
|
|
|
30
30
|
|
|
31
31
|
> **token**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [src/MessagingUtils.ts:50](https://github.com/rapidrest/core/blob/
|
|
33
|
+
Defined in: [src/MessagingUtils.ts:50](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L50)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: SmtpAuth
|
|
8
8
|
|
|
9
|
-
Defined in: [src/MessagingUtils.ts:54](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:54](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L54)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [src/MessagingUtils.ts:54](https://github.com/rapidrest/core/blob/23
|
|
|
14
14
|
|
|
15
15
|
> **pass**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: [src/MessagingUtils.ts:56](https://github.com/rapidrest/core/blob/
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:56](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L56)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,4 +22,4 @@ Defined in: [src/MessagingUtils.ts:56](https://github.com/rapidrest/core/blob/23
|
|
|
22
22
|
|
|
23
23
|
> **user**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: [src/MessagingUtils.ts:55](https://github.com/rapidrest/core/blob/
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:55](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L55)
|
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: SmtpConfig
|
|
8
8
|
|
|
9
|
-
Defined in: [src/MessagingUtils.ts:59](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:59](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L59)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
13
13
|
### auth?
|
|
14
14
|
|
|
15
|
-
> `optional` **auth
|
|
15
|
+
> `optional` **auth?**: [`SmtpAuth`](SmtpAuth.md)
|
|
16
16
|
|
|
17
|
-
Defined in: [src/MessagingUtils.ts:63](https://github.com/rapidrest/core/blob/
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:63](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L63)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [src/MessagingUtils.ts:63](https://github.com/rapidrest/core/blob/23
|
|
|
22
22
|
|
|
23
23
|
> **host**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: [src/MessagingUtils.ts:60](https://github.com/rapidrest/core/blob/
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:60](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L60)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [src/MessagingUtils.ts:60](https://github.com/rapidrest/core/blob/23
|
|
|
30
30
|
|
|
31
31
|
> **port**: `number`
|
|
32
32
|
|
|
33
|
-
Defined in: [src/MessagingUtils.ts:61](https://github.com/rapidrest/core/blob/
|
|
33
|
+
Defined in: [src/MessagingUtils.ts:61](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L61)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,4 +38,4 @@ Defined in: [src/MessagingUtils.ts:61](https://github.com/rapidrest/core/blob/23
|
|
|
38
38
|
|
|
39
39
|
> **secure**: `boolean`
|
|
40
40
|
|
|
41
|
-
Defined in: [src/MessagingUtils.ts:62](https://github.com/rapidrest/core/blob/
|
|
41
|
+
Defined in: [src/MessagingUtils.ts:62](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L62)
|
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Template
|
|
8
8
|
|
|
9
|
-
Defined in: [src/MessagingUtils.ts:21](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:21](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L21)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
13
13
|
### email\_options?
|
|
14
14
|
|
|
15
|
-
> `optional` **email\_options
|
|
15
|
+
> `optional` **email\_options?**: `any`
|
|
16
16
|
|
|
17
|
-
Defined in: [src/MessagingUtils.ts:27](https://github.com/rapidrest/core/blob/
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:27](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L27)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,84 +22,84 @@ Defined in: [src/MessagingUtils.ts:27](https://github.com/rapidrest/core/blob/23
|
|
|
22
22
|
|
|
23
23
|
> **enabled**: `boolean`
|
|
24
24
|
|
|
25
|
-
Defined in: [src/MessagingUtils.ts:23](https://github.com/rapidrest/core/blob/
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:23](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L23)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
29
29
|
### html?
|
|
30
30
|
|
|
31
|
-
> `optional` **html
|
|
31
|
+
> `optional` **html?**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [src/MessagingUtils.ts:31](https://github.com/rapidrest/core/blob/
|
|
33
|
+
Defined in: [src/MessagingUtils.ts:31](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L31)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
37
37
|
### htmlPath?
|
|
38
38
|
|
|
39
|
-
> `optional` **htmlPath
|
|
39
|
+
> `optional` **htmlPath?**: `string`
|
|
40
40
|
|
|
41
|
-
Defined in: [src/MessagingUtils.ts:33](https://github.com/rapidrest/core/blob/
|
|
41
|
+
Defined in: [src/MessagingUtils.ts:33](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L33)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
45
45
|
### loaded?
|
|
46
46
|
|
|
47
|
-
> `optional` **loaded
|
|
47
|
+
> `optional` **loaded?**: `boolean`
|
|
48
48
|
|
|
49
|
-
Defined in: [src/MessagingUtils.ts:25](https://github.com/rapidrest/core/blob/
|
|
49
|
+
Defined in: [src/MessagingUtils.ts:25](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L25)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
53
53
|
### slack\_channel?
|
|
54
54
|
|
|
55
|
-
> `optional` **slack\_channel
|
|
55
|
+
> `optional` **slack\_channel?**: `string`
|
|
56
56
|
|
|
57
|
-
Defined in: [src/MessagingUtils.ts:35](https://github.com/rapidrest/core/blob/
|
|
57
|
+
Defined in: [src/MessagingUtils.ts:35](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L35)
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
61
61
|
### slack\_text?
|
|
62
62
|
|
|
63
|
-
> `optional` **slack\_text
|
|
63
|
+
> `optional` **slack\_text?**: `string`
|
|
64
64
|
|
|
65
|
-
Defined in: [src/MessagingUtils.ts:37](https://github.com/rapidrest/core/blob/
|
|
65
|
+
Defined in: [src/MessagingUtils.ts:37](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L37)
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
69
69
|
### sms?
|
|
70
70
|
|
|
71
|
-
> `optional` **sms
|
|
71
|
+
> `optional` **sms?**: `string`
|
|
72
72
|
|
|
73
|
-
Defined in: [src/MessagingUtils.ts:39](https://github.com/rapidrest/core/blob/
|
|
73
|
+
Defined in: [src/MessagingUtils.ts:39](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L39)
|
|
74
74
|
|
|
75
75
|
***
|
|
76
76
|
|
|
77
77
|
### sms\_options?
|
|
78
78
|
|
|
79
|
-
> `optional` **sms\_options
|
|
79
|
+
> `optional` **sms\_options?**: `any`
|
|
80
80
|
|
|
81
|
-
Defined in: [src/MessagingUtils.ts:41](https://github.com/rapidrest/core/blob/
|
|
81
|
+
Defined in: [src/MessagingUtils.ts:41](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L41)
|
|
82
82
|
|
|
83
83
|
***
|
|
84
84
|
|
|
85
85
|
### subject?
|
|
86
86
|
|
|
87
|
-
> `optional` **subject
|
|
87
|
+
> `optional` **subject?**: `string`
|
|
88
88
|
|
|
89
|
-
Defined in: [src/MessagingUtils.ts:29](https://github.com/rapidrest/core/blob/
|
|
89
|
+
Defined in: [src/MessagingUtils.ts:29](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L29)
|
|
90
90
|
|
|
91
91
|
***
|
|
92
92
|
|
|
93
93
|
### text?
|
|
94
94
|
|
|
95
|
-
> `optional` **text
|
|
95
|
+
> `optional` **text?**: `string`
|
|
96
96
|
|
|
97
|
-
Defined in: [src/MessagingUtils.ts:43](https://github.com/rapidrest/core/blob/
|
|
97
|
+
Defined in: [src/MessagingUtils.ts:43](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L43)
|
|
98
98
|
|
|
99
99
|
***
|
|
100
100
|
|
|
101
101
|
### textPath?
|
|
102
102
|
|
|
103
|
-
> `optional` **textPath
|
|
103
|
+
> `optional` **textPath?**: `string`
|
|
104
104
|
|
|
105
|
-
Defined in: [src/MessagingUtils.ts:45](https://github.com/rapidrest/core/blob/
|
|
105
|
+
Defined in: [src/MessagingUtils.ts:45](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L45)
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: TemplateMapBase
|
|
8
8
|
|
|
9
|
-
Defined in: [src/MessagingUtils.ts:13](https://github.com/rapidrest/core/blob/
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:13](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L13)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
13
|
-
\[`name`: `string`\]: [`Template`](Template.md)
|
|
13
|
+
> \[`name`: `string`\]: [`Template`](Template.md)
|