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

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 (149) hide show
  1. package/dist/lib/OpenApiSpec.js +1 -1
  2. package/dist/lib/OpenApiSpec.js.map +1 -1
  3. package/dist/lib/models/ModelUtils.js +1 -1
  4. package/dist/lib/models/ModelUtils.js.map +1 -1
  5. package/dist/lib/routes/MetricsRoute.js +1 -1
  6. package/dist/lib/routes/MetricsRoute.js.map +1 -1
  7. package/dist/lib/routes/RouteUtils.js +1 -1
  8. package/dist/lib/routes/RouteUtils.js.map +1 -1
  9. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md +1 -1
  10. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md +1 -1
  11. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md +1 -1
  12. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md +1 -1
  13. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md +1 -1
  14. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md +1 -1
  15. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md +1 -1
  16. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md +1 -1
  17. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md +1 -1
  18. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md +1 -1
  19. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md +1 -1
  20. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md +1 -1
  21. package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md +7 -7
  22. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md +1 -1
  23. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md +1 -1
  24. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md +1 -1
  25. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md +1 -1
  26. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md +1 -1
  27. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md +1 -1
  28. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md +1 -1
  29. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md +1 -1
  30. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md +1 -1
  31. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md +1 -1
  32. package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +5 -5
  33. package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +1 -1
  34. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +1 -1
  35. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +1 -1
  36. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md +3 -3
  37. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md +1 -1
  38. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md +3 -3
  39. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md +1 -1
  40. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md +1 -1
  41. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md +1 -1
  42. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md +4 -4
  43. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +5 -5
  44. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +4 -4
  45. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +5 -5
  46. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md +1 -1
  47. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md +1 -1
  48. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md +1 -1
  49. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md +1 -1
  50. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md +1 -1
  51. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md +1 -1
  52. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md +1 -1
  53. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md +1 -1
  54. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md +1 -1
  55. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md +1 -1
  56. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md +1 -1
  57. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md +1 -1
  58. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md +1 -1
  59. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md +1 -1
  60. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md +1 -1
  61. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md +1 -1
  62. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md +1 -1
  63. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md +1 -1
  64. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md +1 -1
  65. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md +1 -1
  66. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md +1 -1
  67. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md +1 -1
  68. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md +1 -1
  69. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md +1 -1
  70. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md +1 -1
  71. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md +1 -1
  72. package/docs/reference/classes/ACLUtils.md +9 -9
  73. package/docs/reference/classes/AdminRoute.md +3 -3
  74. package/docs/reference/classes/AuthMiddleware.md +6 -6
  75. package/docs/reference/classes/BackgroundService.md +8 -8
  76. package/docs/reference/classes/BackgroundServiceManager.md +7 -7
  77. package/docs/reference/classes/BaseEntity.md +6 -6
  78. package/docs/reference/classes/BaseMongoEntity.md +7 -7
  79. package/docs/reference/classes/BasicStrategy.md +5 -5
  80. package/docs/reference/classes/BasicStrategyOptions.md +7 -7
  81. package/docs/reference/classes/BulkError.md +3 -3
  82. package/docs/reference/classes/ConnectionManager.md +4 -4
  83. package/docs/reference/classes/EventListenerManager.md +5 -5
  84. package/docs/reference/classes/HttpRouter.md +16 -16
  85. package/docs/reference/classes/JWTStrategy.md +5 -5
  86. package/docs/reference/classes/JWTStrategyOptions.md +8 -8
  87. package/docs/reference/classes/MetricsRoute.md +4 -4
  88. package/docs/reference/classes/ModelRoute.md +26 -26
  89. package/docs/reference/classes/ModelUtils.md +50 -50
  90. package/docs/reference/classes/MongoConnection.md +12 -12
  91. package/docs/reference/classes/MongoRepository.md +17 -17
  92. package/docs/reference/classes/MongoSchemaSync.md +3 -3
  93. package/docs/reference/classes/NetUtils.md +3 -3
  94. package/docs/reference/classes/NotificationUtils.md +3 -3
  95. package/docs/reference/classes/ObjectFactory.md +3 -3
  96. package/docs/reference/classes/OpenAPIRoute.md +5 -5
  97. package/docs/reference/classes/OpenApiSpec.md +45 -45
  98. package/docs/reference/classes/RecoverableBaseEntity.md +7 -7
  99. package/docs/reference/classes/RecoverableBaseMongoEntity.md +8 -8
  100. package/docs/reference/classes/RedisTransport.md +4 -4
  101. package/docs/reference/classes/RepoUtils.md +28 -28
  102. package/docs/reference/classes/RouteUtils.md +7 -7
  103. package/docs/reference/classes/Server.md +26 -26
  104. package/docs/reference/classes/SimpleEntity.md +3 -3
  105. package/docs/reference/classes/SimpleMongoEntity.md +4 -4
  106. package/docs/reference/classes/StatusExtraData.md +4 -4
  107. package/docs/reference/classes/StatusRoute.md +1 -1
  108. package/docs/reference/classes/UWSRequest.md +16 -16
  109. package/docs/reference/classes/UWSResponse.md +13 -13
  110. package/docs/reference/classes/UWSWebSocketShim.md +5 -5
  111. package/docs/reference/enumerations/ACLAction.md +7 -7
  112. package/docs/reference/enumerations/ApiErrorMessages.md +15 -15
  113. package/docs/reference/enumerations/ApiErrors.md +15 -15
  114. package/docs/reference/functions/createWebSocketStream.md +1 -1
  115. package/docs/reference/functions/isSqlDataSource.md +1 -1
  116. package/docs/reference/functions/readBody.md +1 -1
  117. package/docs/reference/functions/resolveCollectionName.md +1 -1
  118. package/docs/reference/functions/runChain.md +1 -1
  119. package/docs/reference/functions/snakeCase.md +1 -1
  120. package/docs/reference/interfaces/ACLRecord.md +8 -8
  121. package/docs/reference/interfaces/AccessControlList.md +5 -5
  122. package/docs/reference/interfaces/AuthResult.md +5 -5
  123. package/docs/reference/interfaces/AuthStrategy.md +4 -4
  124. package/docs/reference/interfaces/CreateRequestOptions.md +9 -9
  125. package/docs/reference/interfaces/DeleteRequestOptions.md +11 -11
  126. package/docs/reference/interfaces/FindRequestOptions.md +10 -10
  127. package/docs/reference/interfaces/HttpRequest.md +15 -15
  128. package/docs/reference/interfaces/HttpResponse.md +11 -11
  129. package/docs/reference/interfaces/JWTAuthResult.md +6 -6
  130. package/docs/reference/interfaces/RepoCreateOptions.md +7 -7
  131. package/docs/reference/interfaces/RepoDeleteOptions.md +9 -9
  132. package/docs/reference/interfaces/RepoFindOptions.md +11 -11
  133. package/docs/reference/interfaces/RepoOperationOptions.md +6 -6
  134. package/docs/reference/interfaces/RepoUpdateOptions.md +8 -8
  135. package/docs/reference/interfaces/RequestOptions.md +8 -8
  136. package/docs/reference/interfaces/RequestWS.md +17 -17
  137. package/docs/reference/interfaces/TruncateRequestOptions.md +13 -13
  138. package/docs/reference/interfaces/UpdateRequestOptions.md +11 -11
  139. package/docs/reference/type-aliases/ErrorHandler.md +1 -1
  140. package/docs/reference/type-aliases/NextFunction.md +1 -1
  141. package/docs/reference/type-aliases/OneOrMany.md +1 -1
  142. package/docs/reference/type-aliases/OneOrNull.md +1 -1
  143. package/docs/reference/type-aliases/PartialBaseEntity.md +1 -1
  144. package/docs/reference/type-aliases/PartialSimpleEntity.md +1 -1
  145. package/docs/reference/type-aliases/RequestHandler.md +1 -1
  146. package/docs/reference/type-aliases/UpdateObject.md +1 -1
  147. package/docs/reference/type-aliases/WsUpgradeAuth.md +1 -1
  148. package/docs/reference/type-aliases/WsUpgradeAuthResult.md +5 -5
  149. package/package.json +3 -3
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: HttpRequest
8
8
 
9
- Defined in: [src/http/types.ts:10](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L10)
9
+ Defined in: [src/http/types.ts:10](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L10)
10
10
 
11
11
  Framework-agnostic HTTP request interface. Mirrors the Express `Request` surface used throughout
12
12
  this codebase so that route handlers, middleware, and utilities require no changes when the
@@ -28,7 +28,7 @@ Allow arbitrary per-request properties (e.g. req.websocket, req.wsHandled).
28
28
 
29
29
  > `optional` **authPayload?**: `any`
30
30
 
31
- Defined in: [src/http/types.ts:26](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L26)
31
+ Defined in: [src/http/types.ts:26](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L26)
32
32
 
33
33
  Full decoded JWT payload, set by JWT auth middleware.
34
34
 
@@ -38,7 +38,7 @@ Full decoded JWT payload, set by JWT auth middleware.
38
38
 
39
39
  > `optional` **authToken?**: `string`
40
40
 
41
- Defined in: [src/http/types.ts:28](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L28)
41
+ Defined in: [src/http/types.ts:28](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L28)
42
42
 
43
43
  Raw JWT token string, set by JWT auth middleware.
44
44
 
@@ -48,7 +48,7 @@ Raw JWT token string, set by JWT auth middleware.
48
48
 
49
49
  > **body**: `any`
50
50
 
51
- Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L17)
51
+ Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L17)
52
52
 
53
53
  ***
54
54
 
@@ -56,7 +56,7 @@ Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blo
56
56
 
57
57
  > **cookies**: `Record`\<`string`, `string`\>
58
58
 
59
- Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L19)
59
+ Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L19)
60
60
 
61
61
  ***
62
62
 
@@ -64,7 +64,7 @@ Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blo
64
64
 
65
65
  > **headers**: `Record`\<`string`, `string` \| `string`[] \| `undefined`\>
66
66
 
67
- Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L14)
67
+ Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L14)
68
68
 
69
69
  ***
70
70
 
@@ -72,7 +72,7 @@ Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blo
72
72
 
73
73
  > **method**: `string`
74
74
 
75
- Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L11)
75
+ Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L11)
76
76
 
77
77
  ***
78
78
 
@@ -80,7 +80,7 @@ Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blo
80
80
 
81
81
  > **params**: `Record`\<`string`, `string`\>
82
82
 
83
- Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L15)
83
+ Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L15)
84
84
 
85
85
  ***
86
86
 
@@ -88,7 +88,7 @@ Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blo
88
88
 
89
89
  > **path**: `string`
90
90
 
91
- Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L12)
91
+ Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L12)
92
92
 
93
93
  ***
94
94
 
@@ -96,7 +96,7 @@ Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blo
96
96
 
97
97
  > **query**: `Record`\<`string`, `string` \| `string`[]\>
98
98
 
99
- Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L16)
99
+ Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L16)
100
100
 
101
101
  ***
102
102
 
@@ -104,7 +104,7 @@ Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blo
104
104
 
105
105
  > `optional` **rawBody?**: `Buffer`\<`ArrayBufferLike`\>
106
106
 
107
- Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L18)
107
+ Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L18)
108
108
 
109
109
  ***
110
110
 
@@ -112,7 +112,7 @@ Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blo
112
112
 
113
113
  > **signedCookies**: `Record`\<`string`, `string`\>
114
114
 
115
- Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L20)
115
+ Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L20)
116
116
 
117
117
  ***
118
118
 
@@ -120,7 +120,7 @@ Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blo
120
120
 
121
121
  > **socket**: `object`
122
122
 
123
- Defined in: [src/http/types.ts:22](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L22)
123
+ Defined in: [src/http/types.ts:22](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L22)
124
124
 
125
125
  Minimal socket interface; populated with remote address for IP extraction.
126
126
 
@@ -134,7 +134,7 @@ Minimal socket interface; populated with remote address for IP extraction.
134
134
 
135
135
  > **url**: `string`
136
136
 
137
- Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L13)
137
+ Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L13)
138
138
 
139
139
  ***
140
140
 
@@ -142,6 +142,6 @@ Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blo
142
142
 
143
143
  > `optional` **user?**: `any`
144
144
 
145
- Defined in: [src/http/types.ts:24](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L24)
145
+ Defined in: [src/http/types.ts:24](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L24)
146
146
 
147
147
  Set by JWT auth middleware after successful token verification.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: HttpResponse
8
8
 
9
- Defined in: [src/http/types.ts:37](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L37)
9
+ Defined in: [src/http/types.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L37)
10
10
 
11
11
  Framework-agnostic HTTP response interface. Mirrors the Express `Response` surface used
12
12
  throughout this codebase.
@@ -23,7 +23,7 @@ Allow arbitrary per-response properties.
23
23
 
24
24
  > **headersSent**: `boolean`
25
25
 
26
- Defined in: [src/http/types.ts:39](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L39)
26
+ Defined in: [src/http/types.ts:39](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L39)
27
27
 
28
28
  ***
29
29
 
@@ -31,7 +31,7 @@ Defined in: [src/http/types.ts:39](https://github.com/rapidrest/service-core/blo
31
31
 
32
32
  > `optional` **result?**: `any`
33
33
 
34
- Defined in: [src/http/types.ts:42](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L42)
34
+ Defined in: [src/http/types.ts:42](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L42)
35
35
 
36
36
  Intermediate result passed between middleware via res.result.
37
37
 
@@ -41,7 +41,7 @@ Intermediate result passed between middleware via res.result.
41
41
 
42
42
  > **statusCode**: `number`
43
43
 
44
- Defined in: [src/http/types.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L38)
44
+ Defined in: [src/http/types.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L38)
45
45
 
46
46
  ***
47
47
 
@@ -49,7 +49,7 @@ Defined in: [src/http/types.ts:38](https://github.com/rapidrest/service-core/blo
49
49
 
50
50
  > **writableEnded**: `boolean`
51
51
 
52
- Defined in: [src/http/types.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L40)
52
+ Defined in: [src/http/types.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L40)
53
53
 
54
54
  ## Methods
55
55
 
@@ -57,7 +57,7 @@ Defined in: [src/http/types.ts:40](https://github.com/rapidrest/service-core/blo
57
57
 
58
58
  > **end**(`data?`): `void`
59
59
 
60
- Defined in: [src/http/types.ts:48](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L48)
60
+ Defined in: [src/http/types.ts:48](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L48)
61
61
 
62
62
  #### Parameters
63
63
 
@@ -75,7 +75,7 @@ Defined in: [src/http/types.ts:48](https://github.com/rapidrest/service-core/blo
75
75
 
76
76
  > **getHeader**(`key`): `string` \| `undefined`
77
77
 
78
- Defined in: [src/http/types.ts:45](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L45)
78
+ Defined in: [src/http/types.ts:45](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L45)
79
79
 
80
80
  #### Parameters
81
81
 
@@ -93,7 +93,7 @@ Defined in: [src/http/types.ts:45](https://github.com/rapidrest/service-core/blo
93
93
 
94
94
  > **json**(`data`): `void`
95
95
 
96
- Defined in: [src/http/types.ts:46](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L46)
96
+ Defined in: [src/http/types.ts:46](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L46)
97
97
 
98
98
  #### Parameters
99
99
 
@@ -111,7 +111,7 @@ Defined in: [src/http/types.ts:46](https://github.com/rapidrest/service-core/blo
111
111
 
112
112
  > **send**(`data?`): `void`
113
113
 
114
- Defined in: [src/http/types.ts:47](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L47)
114
+ Defined in: [src/http/types.ts:47](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L47)
115
115
 
116
116
  #### Parameters
117
117
 
@@ -129,7 +129,7 @@ Defined in: [src/http/types.ts:47](https://github.com/rapidrest/service-core/blo
129
129
 
130
130
  > **setHeader**(`key`, `value`): `this`
131
131
 
132
- Defined in: [src/http/types.ts:44](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L44)
132
+ Defined in: [src/http/types.ts:44](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L44)
133
133
 
134
134
  #### Parameters
135
135
 
@@ -151,7 +151,7 @@ Defined in: [src/http/types.ts:44](https://github.com/rapidrest/service-core/blo
151
151
 
152
152
  > **status**(`code`): `this`
153
153
 
154
- Defined in: [src/http/types.ts:43](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/types.ts#L43)
154
+ Defined in: [src/http/types.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/types.ts#L43)
155
155
 
156
156
  #### Parameters
157
157
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: JWTAuthResult
8
8
 
9
- Defined in: [src/auth/JWTStrategy.ts:41](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L41)
9
+ Defined in: [src/auth/JWTStrategy.ts:41](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L41)
10
10
 
11
11
  Result returned by `JWTStrategy.authenticate()`.
12
12
 
@@ -20,7 +20,7 @@ Result returned by `JWTStrategy.authenticate()`.
20
20
 
21
21
  > `optional` **data?**: `string`
22
22
 
23
- Defined in: [src/auth/AuthStrategy.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthStrategy.ts#L12)
23
+ Defined in: [src/auth/AuthStrategy.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L12)
24
24
 
25
25
  The raw auth data that was verified.
26
26
 
@@ -34,7 +34,7 @@ The raw auth data that was verified.
34
34
 
35
35
  > **method**: `string`
36
36
 
37
- Defined in: [src/auth/AuthStrategy.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthStrategy.ts#L14)
37
+ Defined in: [src/auth/AuthStrategy.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L14)
38
38
 
39
39
  The name of the auth strategy that produced this result.
40
40
 
@@ -48,7 +48,7 @@ The name of the auth strategy that produced this result.
48
48
 
49
49
  > `optional` **payload?**: `any`
50
50
 
51
- Defined in: [src/auth/AuthStrategy.ts:16](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthStrategy.ts#L16)
51
+ Defined in: [src/auth/AuthStrategy.ts:16](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L16)
52
52
 
53
53
  The fully decoded payload from the auth data.
54
54
 
@@ -62,7 +62,7 @@ The fully decoded payload from the auth data.
62
62
 
63
63
  > `optional` **tokenFound?**: `boolean`
64
64
 
65
- Defined in: [src/auth/JWTStrategy.ts:48](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L48)
65
+ Defined in: [src/auth/JWTStrategy.ts:48](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L48)
66
66
 
67
67
  `true` when at least one credential (header, query param, or cookie) was present in
68
68
  the request, even if it was ultimately invalid. Distinguishes "no token submitted" from
@@ -75,7 +75,7 @@ an alternative auth path (e.g. WebSocket message-based LOGIN).
75
75
 
76
76
  > `optional` **user?**: `JWTUser`
77
77
 
78
- Defined in: [src/auth/AuthStrategy.ts:18](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthStrategy.ts#L18)
78
+ Defined in: [src/auth/AuthStrategy.ts:18](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L18)
79
79
 
80
80
  The authenticated user profile, or `undefined` if authentication failed.
81
81
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: RepoCreateOptions
8
8
 
9
- Defined in: [src/models/RepoUtils.ts:46](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L46)
9
+ Defined in: [src/models/RepoUtils.ts:46](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L46)
10
10
 
11
11
  The available options for the `RepoUtils.create()` operation.
12
12
 
@@ -20,7 +20,7 @@ The available options for the `RepoUtils.create()` operation.
20
20
 
21
21
  > `optional` **acl?**: [`AccessControlList`](AccessControlList.md)
22
22
 
23
- Defined in: [src/models/RepoUtils.ts:48](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L48)
23
+ Defined in: [src/models/RepoUtils.ts:48](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L48)
24
24
 
25
25
  The AccessControlList to use when creating a new object.
26
26
 
@@ -30,7 +30,7 @@ The AccessControlList to use when creating a new object.
30
30
 
31
31
  > `optional` **ignoreACL?**: `boolean`
32
32
 
33
- Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
33
+ Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L32)
34
34
 
35
35
  Set to `true` to ignore the ACL permissions check.
36
36
 
@@ -44,7 +44,7 @@ Set to `true` to ignore the ACL permissions check.
44
44
 
45
45
  > `optional` **pushChannels?**: `string`[]
46
46
 
47
- Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
47
+ Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L34)
48
48
 
49
49
  An additional list of channel names to send push notifications to.
50
50
 
@@ -58,7 +58,7 @@ An additional list of channel names to send push notifications to.
58
58
 
59
59
  > `optional` **recordEvent?**: `boolean`
60
60
 
61
- Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
61
+ Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L36)
62
62
 
63
63
  Indicates if a telemetry event should be broadcast for the request.
64
64
 
@@ -72,7 +72,7 @@ Indicates if a telemetry event should be broadcast for the request.
72
72
 
73
73
  > `optional` **skipPush?**: `boolean`
74
74
 
75
- Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
75
+ Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L38)
76
76
 
77
77
  Set to `true` to not send a push notification.
78
78
 
@@ -86,7 +86,7 @@ Set to `true` to not send a push notification.
86
86
 
87
87
  > `optional` **user?**: `JWTUser`
88
88
 
89
- Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
89
+ Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
90
90
 
91
91
  The authenticated user making the request.
92
92
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: RepoDeleteOptions
8
8
 
9
- Defined in: [src/models/RepoUtils.ts:54](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L54)
9
+ Defined in: [src/models/RepoUtils.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L54)
10
10
 
11
11
  The available options for the `RepoUtils.delete()` operation.
12
12
 
@@ -20,7 +20,7 @@ The available options for the `RepoUtils.delete()` operation.
20
20
 
21
21
  > `optional` **ignoreACL?**: `boolean`
22
22
 
23
- Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
23
+ Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L32)
24
24
 
25
25
  Set to `true` to ignore the ACL permissions check.
26
26
 
@@ -34,7 +34,7 @@ Set to `true` to ignore the ACL permissions check.
34
34
 
35
35
  > `optional` **productUid?**: `string`
36
36
 
37
- Defined in: [src/models/RepoUtils.ts:56](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L56)
37
+ Defined in: [src/models/RepoUtils.ts:56](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L56)
38
38
 
39
39
  The desired product uid of the resource to delete.
40
40
 
@@ -44,7 +44,7 @@ The desired product uid of the resource to delete.
44
44
 
45
45
  > `optional` **purge?**: `boolean`
46
46
 
47
- Defined in: [src/models/RepoUtils.ts:58](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L58)
47
+ Defined in: [src/models/RepoUtils.ts:58](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L58)
48
48
 
49
49
  Set to true to permanently remove the object from the database (if applicable).
50
50
 
@@ -54,7 +54,7 @@ Set to true to permanently remove the object from the database (if applicable).
54
54
 
55
55
  > `optional` **pushChannels?**: `string`[]
56
56
 
57
- Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
57
+ Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L34)
58
58
 
59
59
  An additional list of channel names to send push notifications to.
60
60
 
@@ -68,7 +68,7 @@ An additional list of channel names to send push notifications to.
68
68
 
69
69
  > `optional` **recordEvent?**: `boolean`
70
70
 
71
- Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
71
+ Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L36)
72
72
 
73
73
  Indicates if a telemetry event should be broadcast for the request.
74
74
 
@@ -82,7 +82,7 @@ Indicates if a telemetry event should be broadcast for the request.
82
82
 
83
83
  > `optional` **skipPush?**: `boolean`
84
84
 
85
- Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
85
+ Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L38)
86
86
 
87
87
  Set to `true` to not send a push notification.
88
88
 
@@ -96,7 +96,7 @@ Set to `true` to not send a push notification.
96
96
 
97
97
  > `optional` **user?**: `JWTUser`
98
98
 
99
- Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
99
+ Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
100
100
 
101
101
  The authenticated user making the request.
102
102
 
@@ -110,6 +110,6 @@ The authenticated user making the request.
110
110
 
111
111
  > `optional` **version?**: `string` \| `number`
112
112
 
113
- Defined in: [src/models/RepoUtils.ts:60](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L60)
113
+ Defined in: [src/models/RepoUtils.ts:60](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L60)
114
114
 
115
115
  The desired version number of the resource to delete.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: RepoFindOptions
8
8
 
9
- Defined in: [src/models/RepoUtils.ts:63](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L63)
9
+ Defined in: [src/models/RepoUtils.ts:63](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L63)
10
10
 
11
11
  The available options used for `RepoUtils` operations.
12
12
 
@@ -20,7 +20,7 @@ The available options used for `RepoUtils` operations.
20
20
 
21
21
  > `optional` **ignoreACL?**: `boolean`
22
22
 
23
- Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
23
+ Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L32)
24
24
 
25
25
  Set to `true` to ignore the ACL permissions check.
26
26
 
@@ -34,7 +34,7 @@ Set to `true` to ignore the ACL permissions check.
34
34
 
35
35
  > `optional` **limit?**: `number`
36
36
 
37
- Defined in: [src/models/RepoUtils.ts:65](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L65)
37
+ Defined in: [src/models/RepoUtils.ts:65](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L65)
38
38
 
39
39
  The total number of resources to retrieve.
40
40
 
@@ -44,7 +44,7 @@ The total number of resources to retrieve.
44
44
 
45
45
  > `optional` **page?**: `number`
46
46
 
47
- Defined in: [src/models/RepoUtils.ts:67](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L67)
47
+ Defined in: [src/models/RepoUtils.ts:67](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L67)
48
48
 
49
49
  The page number of the paginated results to retrieve.
50
50
 
@@ -54,7 +54,7 @@ The page number of the paginated results to retrieve.
54
54
 
55
55
  > `optional` **productUid?**: `string`
56
56
 
57
- Defined in: [src/models/RepoUtils.ts:69](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L69)
57
+ Defined in: [src/models/RepoUtils.ts:69](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L69)
58
58
 
59
59
  The desired product uid of the resources to retrieve.
60
60
 
@@ -64,7 +64,7 @@ The desired product uid of the resources to retrieve.
64
64
 
65
65
  > `optional` **pushChannels?**: `string`[]
66
66
 
67
- Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
67
+ Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L34)
68
68
 
69
69
  An additional list of channel names to send push notifications to.
70
70
 
@@ -78,7 +78,7 @@ An additional list of channel names to send push notifications to.
78
78
 
79
79
  > `optional` **recordEvent?**: `boolean`
80
80
 
81
- Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
81
+ Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L36)
82
82
 
83
83
  Indicates if a telemetry event should be broadcast for the request.
84
84
 
@@ -92,7 +92,7 @@ Indicates if a telemetry event should be broadcast for the request.
92
92
 
93
93
  > `optional` **skipCache?**: `boolean`
94
94
 
95
- Defined in: [src/models/RepoUtils.ts:71](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L71)
95
+ Defined in: [src/models/RepoUtils.ts:71](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L71)
96
96
 
97
97
  Set to `true` to skip retrieval from the cache. Default is `false`.
98
98
 
@@ -102,7 +102,7 @@ Set to `true` to skip retrieval from the cache. Default is `false`.
102
102
 
103
103
  > `optional` **skipPush?**: `boolean`
104
104
 
105
- Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
105
+ Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L38)
106
106
 
107
107
  Set to `true` to not send a push notification.
108
108
 
@@ -116,7 +116,7 @@ Set to `true` to not send a push notification.
116
116
 
117
117
  > `optional` **user?**: `JWTUser`
118
118
 
119
- Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
119
+ Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
120
120
 
121
121
  The authenticated user making the request.
122
122
 
@@ -130,6 +130,6 @@ The authenticated user making the request.
130
130
 
131
131
  > `optional` **version?**: `string` \| `number`
132
132
 
133
- Defined in: [src/models/RepoUtils.ts:73](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L73)
133
+ Defined in: [src/models/RepoUtils.ts:73](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L73)
134
134
 
135
135
  The desired version number of the resources to retrieve.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: RepoOperationOptions
8
8
 
9
- Defined in: [src/models/RepoUtils.ts:30](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L30)
9
+ Defined in: [src/models/RepoUtils.ts:30](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L30)
10
10
 
11
11
  The available options used for `RepoUtils` operations.
12
12
 
@@ -24,7 +24,7 @@ The available options used for `RepoUtils` operations.
24
24
 
25
25
  > `optional` **ignoreACL?**: `boolean`
26
26
 
27
- Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
27
+ Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L32)
28
28
 
29
29
  Set to `true` to ignore the ACL permissions check.
30
30
 
@@ -34,7 +34,7 @@ Set to `true` to ignore the ACL permissions check.
34
34
 
35
35
  > `optional` **pushChannels?**: `string`[]
36
36
 
37
- Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
37
+ Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L34)
38
38
 
39
39
  An additional list of channel names to send push notifications to.
40
40
 
@@ -44,7 +44,7 @@ An additional list of channel names to send push notifications to.
44
44
 
45
45
  > `optional` **recordEvent?**: `boolean`
46
46
 
47
- Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
47
+ Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L36)
48
48
 
49
49
  Indicates if a telemetry event should be broadcast for the request.
50
50
 
@@ -54,7 +54,7 @@ Indicates if a telemetry event should be broadcast for the request.
54
54
 
55
55
  > `optional` **skipPush?**: `boolean`
56
56
 
57
- Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
57
+ Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L38)
58
58
 
59
59
  Set to `true` to not send a push notification.
60
60
 
@@ -64,6 +64,6 @@ Set to `true` to not send a push notification.
64
64
 
65
65
  > `optional` **user?**: `JWTUser`
66
66
 
67
- Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
67
+ Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
68
68
 
69
69
  The authenticated user making the request.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: RepoUpdateOptions\<T\>
8
8
 
9
- Defined in: [src/models/RepoUtils.ts:79](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L79)
9
+ Defined in: [src/models/RepoUtils.ts:79](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L79)
10
10
 
11
11
  The available options for the `RepoUtils.update()` operation.
12
12
 
@@ -26,7 +26,7 @@ The available options for the `RepoUtils.update()` operation.
26
26
 
27
27
  > `optional` **ignoreACL?**: `boolean`
28
28
 
29
- Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L32)
29
+ Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L32)
30
30
 
31
31
  Set to `true` to ignore the ACL permissions check.
32
32
 
@@ -40,7 +40,7 @@ Set to `true` to ignore the ACL permissions check.
40
40
 
41
41
  > `optional` **productUid?**: `string`
42
42
 
43
- Defined in: [src/models/RepoUtils.ts:81](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L81)
43
+ Defined in: [src/models/RepoUtils.ts:81](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L81)
44
44
 
45
45
  The desired product uid of the resource to update.
46
46
 
@@ -50,7 +50,7 @@ The desired product uid of the resource to update.
50
50
 
51
51
  > `optional` **pushChannels?**: `string`[]
52
52
 
53
- Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L34)
53
+ Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L34)
54
54
 
55
55
  An additional list of channel names to send push notifications to.
56
56
 
@@ -64,7 +64,7 @@ An additional list of channel names to send push notifications to.
64
64
 
65
65
  > `optional` **recordEvent?**: `boolean`
66
66
 
67
- Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L36)
67
+ Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L36)
68
68
 
69
69
  Indicates if a telemetry event should be broadcast for the request.
70
70
 
@@ -78,7 +78,7 @@ Indicates if a telemetry event should be broadcast for the request.
78
78
 
79
79
  > `optional` **skipPush?**: `boolean`
80
80
 
81
- Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L38)
81
+ Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L38)
82
82
 
83
83
  Set to `true` to not send a push notification.
84
84
 
@@ -92,7 +92,7 @@ Set to `true` to not send a push notification.
92
92
 
93
93
  > `optional` **user?**: `JWTUser`
94
94
 
95
- Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L40)
95
+ Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
96
96
 
97
97
  The authenticated user making the request.
98
98
 
@@ -106,6 +106,6 @@ The authenticated user making the request.
106
106
 
107
107
  > `optional` **version?**: `string` \| `number`
108
108
 
109
- Defined in: [src/models/RepoUtils.ts:83](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RepoUtils.ts#L83)
109
+ Defined in: [src/models/RepoUtils.ts:83](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L83)
110
110
 
111
111
  The desired version number of the resource to update.