@rapidrest/service-core 1.0.0-beta.3 → 1.0.0-beta.5

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.
Files changed (158) hide show
  1. package/dist/lib/Server.js +10 -10
  2. package/dist/lib/Server.js.map +1 -1
  3. package/dist/lib/auth/JWTStrategy.js +2 -1
  4. package/dist/lib/auth/JWTStrategy.js.map +1 -1
  5. package/dist/lib/http/Adapters.js +31 -20
  6. package/dist/lib/http/Adapters.js.map +1 -1
  7. package/dist/lib/http/Router.js +11 -4
  8. package/dist/lib/http/Router.js.map +1 -1
  9. package/dist/lib/models/RepoUtils.js +2 -2
  10. package/dist/lib/models/RepoUtils.js.map +1 -1
  11. package/dist/lib/routes/RouteUtils.js +10 -12
  12. package/dist/lib/routes/RouteUtils.js.map +1 -1
  13. package/dist/lib/security/ACLUtils.js +19 -3
  14. package/dist/lib/security/ACLUtils.js.map +1 -1
  15. package/dist/types/auth/JWTStrategy.d.ts +1 -0
  16. package/dist/types/models/RepoUtils.d.ts +2 -1
  17. package/dist/types/security/ACLUtils.d.ts +1 -1
  18. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md +1 -1
  19. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md +1 -1
  20. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md +1 -1
  21. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md +1 -1
  22. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md +1 -1
  23. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md +1 -1
  24. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md +1 -1
  25. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md +1 -1
  26. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md +1 -1
  27. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md +1 -1
  28. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md +1 -1
  29. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md +1 -1
  30. package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md +7 -7
  31. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md +1 -1
  32. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md +1 -1
  33. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md +1 -1
  34. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md +1 -1
  35. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md +1 -1
  36. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md +1 -1
  37. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md +1 -1
  38. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md +1 -1
  39. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md +1 -1
  40. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md +1 -1
  41. package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +5 -5
  42. package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +1 -1
  43. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +1 -1
  44. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +1 -1
  45. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md +3 -3
  46. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md +1 -1
  47. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md +3 -3
  48. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md +1 -1
  49. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md +1 -1
  50. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md +1 -1
  51. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md +4 -4
  52. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +5 -5
  53. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +4 -4
  54. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +5 -5
  55. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md +1 -1
  56. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md +1 -1
  57. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md +1 -1
  58. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md +1 -1
  59. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md +1 -1
  60. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md +1 -1
  61. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md +1 -1
  62. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md +1 -1
  63. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md +1 -1
  64. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md +1 -1
  65. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md +1 -1
  66. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md +1 -1
  67. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md +1 -1
  68. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md +1 -1
  69. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md +1 -1
  70. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md +1 -1
  71. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md +1 -1
  72. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md +1 -1
  73. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md +1 -1
  74. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md +1 -1
  75. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md +1 -1
  76. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md +1 -1
  77. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md +1 -1
  78. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md +1 -1
  79. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md +1 -1
  80. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md +1 -1
  81. package/docs/reference/classes/ACLUtils.md +14 -10
  82. package/docs/reference/classes/AdminRoute.md +3 -3
  83. package/docs/reference/classes/AuthMiddleware.md +6 -6
  84. package/docs/reference/classes/BackgroundService.md +8 -8
  85. package/docs/reference/classes/BackgroundServiceManager.md +7 -7
  86. package/docs/reference/classes/BaseEntity.md +6 -6
  87. package/docs/reference/classes/BaseMongoEntity.md +7 -7
  88. package/docs/reference/classes/BasicStrategy.md +5 -5
  89. package/docs/reference/classes/BasicStrategyOptions.md +7 -7
  90. package/docs/reference/classes/BulkError.md +3 -3
  91. package/docs/reference/classes/ConnectionManager.md +4 -4
  92. package/docs/reference/classes/EventListenerManager.md +5 -5
  93. package/docs/reference/classes/HttpRouter.md +16 -16
  94. package/docs/reference/classes/JWTStrategy.md +10 -10
  95. package/docs/reference/classes/JWTStrategyOptions.md +10 -10
  96. package/docs/reference/classes/MetricsRoute.md +2 -2
  97. package/docs/reference/classes/ModelRoute.md +26 -26
  98. package/docs/reference/classes/ModelUtils.md +10 -10
  99. package/docs/reference/classes/MongoConnection.md +12 -12
  100. package/docs/reference/classes/MongoRepository.md +17 -17
  101. package/docs/reference/classes/MongoSchemaSync.md +3 -3
  102. package/docs/reference/classes/NetUtils.md +3 -3
  103. package/docs/reference/classes/NotificationUtils.md +3 -3
  104. package/docs/reference/classes/ObjectFactory.md +3 -3
  105. package/docs/reference/classes/OpenAPIRoute.md +5 -5
  106. package/docs/reference/classes/OpenApiSpec.md +45 -45
  107. package/docs/reference/classes/RecoverableBaseEntity.md +7 -7
  108. package/docs/reference/classes/RecoverableBaseMongoEntity.md +8 -8
  109. package/docs/reference/classes/RedisTransport.md +4 -4
  110. package/docs/reference/classes/RepoUtils.md +28 -28
  111. package/docs/reference/classes/RouteUtils.md +9 -9
  112. package/docs/reference/classes/Server.md +89 -89
  113. package/docs/reference/classes/SimpleEntity.md +3 -3
  114. package/docs/reference/classes/SimpleMongoEntity.md +4 -4
  115. package/docs/reference/classes/StatusExtraData.md +4 -4
  116. package/docs/reference/classes/StatusRoute.md +1 -1
  117. package/docs/reference/classes/UWSRequest.md +17 -17
  118. package/docs/reference/classes/UWSResponse.md +15 -15
  119. package/docs/reference/classes/UWSWebSocketShim.md +5 -5
  120. package/docs/reference/enumerations/ACLAction.md +7 -7
  121. package/docs/reference/enumerations/ApiErrorMessages.md +15 -15
  122. package/docs/reference/enumerations/ApiErrors.md +15 -15
  123. package/docs/reference/functions/createWebSocketStream.md +1 -1
  124. package/docs/reference/functions/isSqlDataSource.md +1 -1
  125. package/docs/reference/functions/readBody.md +3 -3
  126. package/docs/reference/functions/resolveCollectionName.md +1 -1
  127. package/docs/reference/functions/runChain.md +1 -1
  128. package/docs/reference/functions/snakeCase.md +1 -1
  129. package/docs/reference/interfaces/ACLRecord.md +8 -8
  130. package/docs/reference/interfaces/AccessControlList.md +5 -5
  131. package/docs/reference/interfaces/AuthResult.md +5 -5
  132. package/docs/reference/interfaces/AuthStrategy.md +4 -4
  133. package/docs/reference/interfaces/CreateRequestOptions.md +9 -9
  134. package/docs/reference/interfaces/DeleteRequestOptions.md +11 -11
  135. package/docs/reference/interfaces/FindRequestOptions.md +10 -10
  136. package/docs/reference/interfaces/HttpRequest.md +15 -15
  137. package/docs/reference/interfaces/HttpResponse.md +11 -11
  138. package/docs/reference/interfaces/JWTAuthResult.md +9 -9
  139. package/docs/reference/interfaces/RepoCreateOptions.md +7 -7
  140. package/docs/reference/interfaces/RepoDeleteOptions.md +9 -9
  141. package/docs/reference/interfaces/RepoFindOptions.md +11 -11
  142. package/docs/reference/interfaces/RepoOperationOptions.md +6 -6
  143. package/docs/reference/interfaces/RepoUpdateOptions.md +8 -8
  144. package/docs/reference/interfaces/RequestOptions.md +8 -8
  145. package/docs/reference/interfaces/RequestWS.md +17 -17
  146. package/docs/reference/interfaces/TruncateRequestOptions.md +13 -13
  147. package/docs/reference/interfaces/UpdateRequestOptions.md +11 -11
  148. package/docs/reference/type-aliases/ErrorHandler.md +1 -1
  149. package/docs/reference/type-aliases/NextFunction.md +1 -1
  150. package/docs/reference/type-aliases/OneOrMany.md +1 -1
  151. package/docs/reference/type-aliases/OneOrNull.md +1 -1
  152. package/docs/reference/type-aliases/PartialBaseEntity.md +1 -1
  153. package/docs/reference/type-aliases/PartialSimpleEntity.md +1 -1
  154. package/docs/reference/type-aliases/RequestHandler.md +1 -1
  155. package/docs/reference/type-aliases/UpdateObject.md +1 -1
  156. package/docs/reference/type-aliases/WsUpgradeAuth.md +1 -1
  157. package/docs/reference/type-aliases/WsUpgradeAuthResult.md +5 -5
  158. package/package.json +129 -125
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ColumnInfo
8
8
 
9
- Defined in: [src/decorators/PersistenceDecorators.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L38)
9
+ Defined in: [src/decorators/PersistenceDecorators.ts:38](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L38)
10
10
 
11
11
  Describes a single persisted column/property of a model class.
12
12
 
@@ -16,7 +16,7 @@ Describes a single persisted column/property of a model class.
16
16
 
17
17
  > `optional` **designType?**: `any`
18
18
 
19
- Defined in: [src/decorators/PersistenceDecorators.ts:42](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L42)
19
+ Defined in: [src/decorators/PersistenceDecorators.ts:42](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L42)
20
20
 
21
21
  The design type of the property as captured at decoration time.
22
22
 
@@ -26,7 +26,7 @@ The design type of the property as captured at decoration time.
26
26
 
27
27
  > **options**: [`ColumnOptions`](ColumnOptions.md)
28
28
 
29
- Defined in: [src/decorators/PersistenceDecorators.ts:44](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L44)
29
+ Defined in: [src/decorators/PersistenceDecorators.ts:44](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L44)
30
30
 
31
31
  The options that the column was declared with.
32
32
 
@@ -36,6 +36,6 @@ The options that the column was declared with.
36
36
 
37
37
  > **propertyName**: `string`
38
38
 
39
- Defined in: [src/decorators/PersistenceDecorators.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L40)
39
+ Defined in: [src/decorators/PersistenceDecorators.ts:40](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L40)
40
40
 
41
41
  The name of the class property.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ColumnOptions
8
8
 
9
- Defined in: [src/decorators/PersistenceDecorators.ts:10](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L10)
9
+ Defined in: [src/decorators/PersistenceDecorators.ts:10](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L10)
10
10
 
11
11
  The set of options available when declaring a persisted column/property via the `@Column` decorator.
12
12
 
@@ -16,7 +16,7 @@ The set of options available when declaring a persisted column/property via the
16
16
 
17
17
  > `optional` **isObjectId?**: `boolean`
18
18
 
19
- Defined in: [src/decorators/PersistenceDecorators.ts:18](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L18)
19
+ Defined in: [src/decorators/PersistenceDecorators.ts:18](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L18)
20
20
 
21
21
  Set to `true` if the column stores a MongoDB `ObjectId` value.
22
22
 
@@ -26,7 +26,7 @@ Set to `true` if the column stores a MongoDB `ObjectId` value.
26
26
 
27
27
  > `optional` **name?**: `string`
28
28
 
29
- Defined in: [src/decorators/PersistenceDecorators.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L12)
29
+ Defined in: [src/decorators/PersistenceDecorators.ts:12](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L12)
30
30
 
31
31
  The name of the column in the datastore. Defaults to the property name.
32
32
 
@@ -36,7 +36,7 @@ The name of the column in the datastore. Defaults to the property name.
36
36
 
37
37
  > `optional` **nullable?**: `boolean`
38
38
 
39
- Defined in: [src/decorators/PersistenceDecorators.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L14)
39
+ Defined in: [src/decorators/PersistenceDecorators.ts:14](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L14)
40
40
 
41
41
  Set to `true` if the column may store `null`/`undefined` values.
42
42
 
@@ -46,6 +46,6 @@ Set to `true` if the column may store `null`/`undefined` values.
46
46
 
47
47
  > `optional` **primary?**: `boolean`
48
48
 
49
- Defined in: [src/decorators/PersistenceDecorators.ts:16](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L16)
49
+ Defined in: [src/decorators/PersistenceDecorators.ts:16](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L16)
50
50
 
51
51
  Set to `true` if the column is a primary key.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: IndexInfo
8
8
 
9
- Defined in: [src/decorators/PersistenceDecorators.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L50)
9
+ Defined in: [src/decorators/PersistenceDecorators.ts:50](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L50)
10
10
 
11
11
  Describes a single database index of a model class.
12
12
 
@@ -16,7 +16,7 @@ Describes a single database index of a model class.
16
16
 
17
17
  > **columns**: `string`[]
18
18
 
19
- Defined in: [src/decorators/PersistenceDecorators.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L54)
19
+ Defined in: [src/decorators/PersistenceDecorators.ts:54](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L54)
20
20
 
21
21
  The list of class properties that make up the index.
22
22
 
@@ -26,7 +26,7 @@ The list of class properties that make up the index.
26
26
 
27
27
  > `optional` **name?**: `string`
28
28
 
29
- Defined in: [src/decorators/PersistenceDecorators.ts:52](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L52)
29
+ Defined in: [src/decorators/PersistenceDecorators.ts:52](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L52)
30
30
 
31
31
  The explicit name of the index, if any.
32
32
 
@@ -36,6 +36,6 @@ The explicit name of the index, if any.
36
36
 
37
37
  > **options**: [`IndexOptions`](IndexOptions.md)
38
38
 
39
- Defined in: [src/decorators/PersistenceDecorators.ts:56](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L56)
39
+ Defined in: [src/decorators/PersistenceDecorators.ts:56](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L56)
40
40
 
41
41
  The options that the index was declared with.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: IndexOptions
8
8
 
9
- Defined in: [src/decorators/PersistenceDecorators.ts:24](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L24)
9
+ Defined in: [src/decorators/PersistenceDecorators.ts:24](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L24)
10
10
 
11
11
  The set of options available when declaring a database index via the `@Index` decorator.
12
12
 
@@ -16,7 +16,7 @@ The set of options available when declaring a database index via the `@Index` de
16
16
 
17
17
  > `optional` **background?**: `boolean`
18
18
 
19
- Defined in: [src/decorators/PersistenceDecorators.ts:30](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L30)
19
+ Defined in: [src/decorators/PersistenceDecorators.ts:30](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L30)
20
20
 
21
21
  Set to `true` to build the index in the background. (MongoDB only)
22
22
 
@@ -26,7 +26,7 @@ Set to `true` to build the index in the background. (MongoDB only)
26
26
 
27
27
  > `optional` **expireAfterSeconds?**: `number`
28
28
 
29
- Defined in: [src/decorators/PersistenceDecorators.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L32)
29
+ Defined in: [src/decorators/PersistenceDecorators.ts:32](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L32)
30
30
 
31
31
  The time, in seconds, after which indexed documents will be automatically deleted. (MongoDB only)
32
32
 
@@ -36,7 +36,7 @@ The time, in seconds, after which indexed documents will be automatically delete
36
36
 
37
37
  > `optional` **sparse?**: `boolean`
38
38
 
39
- Defined in: [src/decorators/PersistenceDecorators.ts:28](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L28)
39
+ Defined in: [src/decorators/PersistenceDecorators.ts:28](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L28)
40
40
 
41
41
  Set to `true` to only index documents in which the indexed properties exist. (MongoDB only)
42
42
 
@@ -46,6 +46,6 @@ Set to `true` to only index documents in which the indexed properties exist. (Mo
46
46
 
47
47
  > `optional` **unique?**: `boolean`
48
48
 
49
- Defined in: [src/decorators/PersistenceDecorators.ts:26](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/PersistenceDecorators.ts#L26)
49
+ Defined in: [src/decorators/PersistenceDecorators.ts:26](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/PersistenceDecorators.ts#L26)
50
50
 
51
51
  Set to `true` to enforce that all values of the indexed properties are unique.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **After**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:13](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L13)
11
+ Defined in: [src/decorators/RouteDecorators.ts:13](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L13)
12
12
 
13
13
  Indicates a provided function or list of functions to execute *after* the decorated function and before the response
14
14
  is sent to a client. Note that the function must call `next()` in order for this decorator to work.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Auth**(`strategies`, `require?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:33](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L33)
11
+ Defined in: [src/decorators/RouteDecorators.ts:33](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L33)
12
12
 
13
13
  Applies PassportJS authentication to the decorated route or method for the provided strategy or list of strategies
14
14
  should be attempted before processing the route.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **AuthResult**(`target`, `propertyKey`, `index`): `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:45](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L45)
11
+ Defined in: [src/decorators/RouteDecorators.ts:45](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L45)
12
12
 
13
13
  Injects the authenticated authentication result as the value of the decorated argument.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Before**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:56](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L56)
11
+ Defined in: [src/decorators/RouteDecorators.ts:56](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L56)
12
12
 
13
13
  Indicates a provided function or list of functions to execute *before* the decorated function.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **ContentType**(`type`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:73](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L73)
11
+ Defined in: [src/decorators/RouteDecorators.ts:73](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L73)
12
12
 
13
13
  Indicates that the decorated function will return content encoded with the specified content type.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Delete**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:86](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L86)
11
+ Defined in: [src/decorators/RouteDecorators.ts:86](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L86)
12
12
 
13
13
  Indicates that the decorated function handles incoming `DELETE` requests at the given sub-path.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Get**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:95](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L95)
11
+ Defined in: [src/decorators/RouteDecorators.ts:95](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L95)
12
12
 
13
13
  Indicates that the decorated function handles incoming `GET` requests at the given sub-path.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Head**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:104](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L104)
11
+ Defined in: [src/decorators/RouteDecorators.ts:104](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L104)
12
12
 
13
13
  Indicates that the decorated function handles incoming `HEAD` requests at the given sub-path.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Header**(`name`): (`target`, `propertyKey`, `index`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:113](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L113)
11
+ Defined in: [src/decorators/RouteDecorators.ts:113](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L113)
12
12
 
13
13
  Injects the value of the specified request header with the given name as the value of the decorated argument.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Method**(`method`, `path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:127](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L127)
11
+ Defined in: [src/decorators/RouteDecorators.ts:127](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L127)
12
12
 
13
13
  Indicates that the decorated function handles incoming HTTP requests for the specified HTTP method(s) at the given sub-path.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Model**(`type`): \<`T`\>(`constructor`) => \{(...`args`): `(Anonymous class)`\<`T`\>; `modelClass`: `any`; `prototype`: `(Anonymous class)`\<`any`\>; \} & `T`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:150](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L150)
11
+ Defined in: [src/decorators/RouteDecorators.ts:150](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L150)
12
12
 
13
13
  Indicates that the class utilizes is a manager for the specified class type.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Options**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:164](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L164)
11
+ Defined in: [src/decorators/RouteDecorators.ts:164](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L164)
12
12
 
13
13
  Indicates that the decorated function handles incoming `OPTIONS` requests at the given sub-path.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Param**(`name?`): (`target`, `propertyKey`, `index`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:174](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L174)
11
+ Defined in: [src/decorators/RouteDecorators.ts:174](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L174)
12
12
 
13
13
  Injects the value of the specified URI parameter with the given name as the value of the decorated argument. If no
14
14
  name is specified the entire request parameter will be injected.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Patch**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:187](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L187)
11
+ Defined in: [src/decorators/RouteDecorators.ts:187](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L187)
12
12
 
13
13
  Indicates that the decorated function handles incoming `PATCH` requests at the given sub-path.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Post**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:196](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L196)
11
+ Defined in: [src/decorators/RouteDecorators.ts:196](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L196)
12
12
 
13
13
  Indicates that the decorated function handles incoming `POST` requests at the given sub-path.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Protect**(`acl?`): (`target`, `propertyKey?`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:222](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L222)
11
+ Defined in: [src/decorators/RouteDecorators.ts:222](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L222)
12
12
 
13
13
  Apply this to any route handler class or an individual route handler function to indicate that it should be
14
14
  protected by the AccessControlList security system. The `acl` parameter specifies the ACL governing access
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Put**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:205](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L205)
11
+ Defined in: [src/decorators/RouteDecorators.ts:205](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L205)
12
12
 
13
13
  Indicates that the decorated function handles incoming `PUT` requests at the given sub-path.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Query**(`name?`): (`target`, `propertyKey`, `index`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:265](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L265)
11
+ Defined in: [src/decorators/RouteDecorators.ts:265](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L265)
12
12
 
13
13
  Injects the value of the specified query parameter with the given name as the value of the decorated argument. If
14
14
  no name is specified the entire request query will be injected.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Request**(`target`, `propertyKey`, `index`): `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:276](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L276)
11
+ Defined in: [src/decorators/RouteDecorators.ts:276](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L276)
12
12
 
13
13
  Injects the Express request object as the value of the decorated argument.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **RequiresRole**(`roles`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:297](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L297)
11
+ Defined in: [src/decorators/RouteDecorators.ts:297](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L297)
12
12
 
13
13
  Indicates that the client must be an authenticated user with at least one of the specified role(s) to process the
14
14
  request.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Response**(`target`, `propertyKey`, `index`): `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:285](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L285)
11
+ Defined in: [src/decorators/RouteDecorators.ts:285](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L285)
12
12
 
13
13
  Injects the Express response object as the value of the decorated argument.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Route**(`paths`): (`target`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:310](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L310)
11
+ Defined in: [src/decorators/RouteDecorators.ts:310](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L310)
12
12
 
13
13
  Indicates that the decorated class contains Express route definitions.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Socket**(`target`, `propertyKey`, `index`): `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:323](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L323)
11
+ Defined in: [src/decorators/RouteDecorators.ts:323](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L323)
12
12
 
13
13
  Injects the underlying Socket object associated with the request as the value of the decorated argument.
14
14
  When the handler function is for a WebSocket request, the returned socket will be the newly established
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **User**(`target`, `propertyKey`, `index`): `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:332](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L332)
11
+ Defined in: [src/decorators/RouteDecorators.ts:332](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L332)
12
12
 
13
13
  Injects the authenticated user object as the value of the decorated argument.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **Validate**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:343](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L343)
11
+ Defined in: [src/decorators/RouteDecorators.ts:343](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L343)
12
12
 
13
13
  Indicates a validation function to execute in order to verify an incoming requests payload.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **WebSocket**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
10
 
11
- Defined in: [src/decorators/RouteDecorators.ts:356](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/decorators/RouteDecorators.ts#L356)
11
+ Defined in: [src/decorators/RouteDecorators.ts:356](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/decorators/RouteDecorators.ts#L356)
12
12
 
13
13
  Indicates that the decorated function handles incoming `WebSocket` upgrade requests at the given sub-path.
14
14
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ACLUtils
8
8
 
9
- Defined in: [src/security/ACLUtils.ts:22](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L22)
9
+ Defined in: [src/security/ACLUtils.ts:22](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/ACLUtils.ts#L22)
10
10
 
11
11
  Common utility functions for working with `AccessControlList` objects and validating user permissions.
12
12
 
@@ -26,7 +26,7 @@ Common utility functions for working with `AccessControlList` objects and valida
26
26
 
27
27
  > **checkRequestPerms**(`uid`, `user`, `req`): `Promise`\<`boolean`\>
28
28
 
29
- Defined in: [src/security/ACLUtils.ts:73](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L73)
29
+ Defined in: [src/security/ACLUtils.ts:73](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/ACLUtils.ts#L73)
30
30
 
31
31
  Validates that the user has permission to perform the request operation against the URL path for the
32
32
  provided request. If ACLUtils has not been initialized or the `acl` datastore has not been configured
@@ -60,9 +60,9 @@ The request whose URL path and method will be verified.
60
60
 
61
61
  ### findACL()
62
62
 
63
- > **findACL**(`entityId`, `parentUids?`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
63
+ > **findACL**(`entityId`, `parentUids?`, `reqCache?`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
64
64
 
65
- Defined in: [src/security/ACLUtils.ts:195](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L195)
65
+ Defined in: [src/security/ACLUtils.ts:202](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/ACLUtils.ts#L202)
66
66
 
67
67
  Retrieves the access control list with the associated identifier and populates the parent(s).
68
68
 
@@ -80,6 +80,10 @@ The unique identifier of the ACL to retrieve.
80
80
 
81
81
  The list of already found parent UIDs. This is used to break circular dependencies.
82
82
 
83
+ ##### reqCache?
84
+
85
+ `Map`\<`string`, [`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
86
+
83
87
  #### Returns
84
88
 
85
89
  `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
@@ -90,7 +94,7 @@ The list of already found parent UIDs. This is used to break circular dependenci
90
94
 
91
95
  > **getRecord**(`acl`, `user`): [`ACLRecord`](../interfaces/ACLRecord.md) \| `null`
92
96
 
93
- Defined in: [src/security/ACLUtils.ts:459](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L459)
97
+ Defined in: [src/security/ACLUtils.ts:482](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/ACLUtils.ts#L482)
94
98
 
95
99
  Retrieves the first available record in the provided ACL associated with the provided user.
96
100
 
@@ -120,7 +124,7 @@ The ACL record associated with the given user if found, otherwise `undefined`.
120
124
 
121
125
  > **hasPermission**(`user`, `acl`, `action`): `Promise`\<`boolean`\>
122
126
 
123
- Defined in: [src/security/ACLUtils.ts:127](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L127)
127
+ Defined in: [src/security/ACLUtils.ts:134](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/ACLUtils.ts#L134)
124
128
 
125
129
  Validates that the user has permission to perform the provided action using the given access control list.
126
130
 
@@ -156,7 +160,7 @@ The action that the user desires permission for.
156
160
 
157
161
  > **populateParent**(`acl`, `parentUids?`): `Promise`\<`void`\>
158
162
 
159
- Defined in: [src/security/ACLUtils.ts:479](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L479)
163
+ Defined in: [src/security/ACLUtils.ts:502](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/ACLUtils.ts#L502)
160
164
 
161
165
  Attempts to retrieve the parent access control list for the given ACL object.
162
166
 
@@ -184,7 +188,7 @@ The list of already found parent UIDs. This is used to break circular dependenci
184
188
 
185
189
  > **removeACL**(`uid`): `Promise`\<`void`\>
186
190
 
187
- Defined in: [src/security/ACLUtils.ts:247](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L247)
191
+ Defined in: [src/security/ACLUtils.ts:270](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/ACLUtils.ts#L270)
188
192
 
189
193
  Deletes the ACL with the given identifier from the database.
190
194
 
@@ -206,7 +210,7 @@ The unique identifier of the ACL to remove.
206
210
 
207
211
  > **saveACL**(`acl`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
208
212
 
209
- Defined in: [src/security/ACLUtils.ts:333](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L333)
213
+ Defined in: [src/security/ACLUtils.ts:356](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/ACLUtils.ts#L356)
210
214
 
211
215
  Stores the given access control list into the ACL database.
212
216
 
@@ -230,7 +234,7 @@ Returns the ACL that was stored in the database.
230
234
 
231
235
  > **saveDefaultACL**(`acl`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
232
236
 
233
- Defined in: [src/security/ACLUtils.ts:399](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/ACLUtils.ts#L399)
237
+ Defined in: [src/security/ACLUtils.ts:422](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/security/ACLUtils.ts#L422)
234
238
 
235
239
  Stores the given default access control list into the ACL database. A default ACL is a special type of ACL
236
240
  that is primarily defined and maintained within the code but allows for user-specific overrides. To accomplish
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: AdminRoute
8
8
 
9
- Defined in: [src/routes/AdminRoute.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/AdminRoute.ts#L50)
9
+ Defined in: [src/routes/AdminRoute.ts:50](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/AdminRoute.ts#L50)
10
10
 
11
11
  The `AdminRoute` provides a default `/admin` endpoint that gives trusted users the following abilities:
12
12
 
@@ -26,7 +26,7 @@ Jean-Philippe Steinmetz
26
26
 
27
27
  > **new AdminRoute**(`releaseNotes`): `AdminRoute`
28
28
 
29
- Defined in: [src/routes/AdminRoute.ts:82](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/AdminRoute.ts#L82)
29
+ Defined in: [src/routes/AdminRoute.ts:82](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/AdminRoute.ts#L82)
30
30
 
31
31
  Constructs a new `ReleaseNotesRoute` object with the specified defaults.
32
32
 
@@ -48,4 +48,4 @@ The ReleaseNotes specification object to serve.
48
48
 
49
49
  > `protected` `optional` **cacheClient?**: `Redis`
50
50
 
51
- Defined in: [src/routes/AdminRoute.ts:55](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/AdminRoute.ts#L55)
51
+ Defined in: [src/routes/AdminRoute.ts:55](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/routes/AdminRoute.ts#L55)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: AuthMiddleware
8
8
 
9
- Defined in: [src/auth/AuthMiddleware.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthMiddleware.ts#L19)
9
+ Defined in: [src/auth/AuthMiddleware.ts:19](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthMiddleware.ts#L19)
10
10
 
11
11
  A set of common utilities for performing authentication using one or more strategies.
12
12
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
30
30
 
31
31
  > `readonly` **strategies**: `Map`\<`string`, [`AuthStrategy`](../interfaces/AuthStrategy.md)\>
32
32
 
33
- Defined in: [src/auth/AuthMiddleware.ts:30](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthMiddleware.ts#L30)
33
+ Defined in: [src/auth/AuthMiddleware.ts:30](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthMiddleware.ts#L30)
34
34
 
35
35
  The authentication strategies that have been registered.
36
36
 
@@ -40,7 +40,7 @@ The authentication strategies that have been registered.
40
40
 
41
41
  > **authenticate**(`strategies`, `req`, `res?`, `required?`): `Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
42
42
 
43
- Defined in: [src/auth/AuthMiddleware.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthMiddleware.ts#L54)
43
+ Defined in: [src/auth/AuthMiddleware.ts:54](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthMiddleware.ts#L54)
44
44
 
45
45
  Performs authentication of the given request using one of the provided strategies.
46
46
 
@@ -80,7 +80,7 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
80
80
 
81
81
  > **authenticateSync**(`strategies`, `req`, `res?`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
82
82
 
83
- Defined in: [src/auth/AuthMiddleware.ts:92](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthMiddleware.ts#L92)
83
+ Defined in: [src/auth/AuthMiddleware.ts:92](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthMiddleware.ts#L92)
84
84
 
85
85
  Performs authentication of the given request using one of the provided strategies.
86
86
 
@@ -122,7 +122,7 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
122
122
 
123
123
  > **authWebSocket**(`required`): [`RequestHandler`](../type-aliases/RequestHandler.md)
124
124
 
125
- Defined in: [src/auth/AuthMiddleware.ts:133](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthMiddleware.ts#L133)
125
+ Defined in: [src/auth/AuthMiddleware.ts:133](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthMiddleware.ts#L133)
126
126
 
127
127
  Returns a request handler function that will perform authentication of a websocket connection. Authentication
128
128
  can be handled in two ways:
@@ -150,7 +150,7 @@ Set to `true` to indicate that auth is required, otherwise `false`.
150
150
 
151
151
  > **register**(`name`, `strategy`): `void`
152
152
 
153
- Defined in: [src/auth/AuthMiddleware.ts:277](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthMiddleware.ts#L277)
153
+ Defined in: [src/auth/AuthMiddleware.ts:277](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/auth/AuthMiddleware.ts#L277)
154
154
 
155
155
  Registers the provided authentication strategy to be used
156
156