@rapidrest/service-core 1.0.0-beta.6 → 1.0.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/database/MongoRepository.js +22 -24
- package/dist/lib/database/MongoRepository.js.map +1 -1
- package/dist/lib/database/MongoSchemaSync.js +80 -21
- package/dist/lib/database/MongoSchemaSync.js.map +1 -1
- package/dist/lib/database/NamingUtils.js +4 -4
- package/dist/lib/database/NamingUtils.js.map +1 -1
- package/dist/lib/decorators/PersistenceDecorators.js +17 -17
- package/dist/lib/decorators/PersistenceDecorators.js.map +1 -1
- package/dist/lib/models/BaseMongoEntity.js +10 -3
- package/dist/lib/models/BaseMongoEntity.js.map +1 -1
- package/dist/lib/models/ModelUtils.js +31 -34
- package/dist/lib/models/ModelUtils.js.map +1 -1
- package/dist/lib/models/RecoverableBaseMongoEntity.js +11 -3
- package/dist/lib/models/RecoverableBaseMongoEntity.js.map +1 -1
- package/dist/lib/models/RepoUtils.js +37 -45
- package/dist/lib/models/RepoUtils.js.map +1 -1
- package/dist/lib/models/SimpleEntity.js +1 -1
- package/dist/lib/models/SimpleEntity.js.map +1 -1
- package/dist/lib/routes/ModelRoute.js +1 -11
- package/dist/lib/routes/ModelRoute.js.map +1 -1
- package/dist/types/database/MongoRepository.d.ts +17 -11
- package/dist/types/database/MongoSchemaSync.d.ts +25 -3
- package/dist/types/database/NamingUtils.d.ts +1 -1
- package/dist/types/decorators/PersistenceDecorators.d.ts +29 -3
- package/dist/types/models/ModelUtils.d.ts +3 -6
- package/dist/types/models/RepoUtils.d.ts +1 -7
- package/dist/types/routes/ModelRoute.d.ts +0 -4
- package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md +7 -7
- package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md +1 -1
- package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md +5 -5
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +7 -7
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +2 -2
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/README.md +2 -0
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +5 -6
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md +3 -3
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md +3 -3
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/CollationOptions.md +79 -0
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md +4 -4
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +5 -5
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/EntityOptions.md +32 -0
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +4 -4
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +15 -5
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md +1 -1
- package/docs/reference/classes/ACLUtils.md +10 -10
- package/docs/reference/classes/AdminRoute.md +3 -3
- package/docs/reference/classes/AuthMiddleware.md +6 -6
- package/docs/reference/classes/BackgroundService.md +8 -8
- package/docs/reference/classes/BackgroundServiceManager.md +7 -7
- package/docs/reference/classes/BaseEntity.md +6 -6
- package/docs/reference/classes/BaseMongoEntity.md +7 -7
- package/docs/reference/classes/BasicStrategy.md +5 -5
- package/docs/reference/classes/BasicStrategyOptions.md +7 -7
- package/docs/reference/classes/BulkError.md +3 -3
- package/docs/reference/classes/ConnectionManager.md +4 -4
- package/docs/reference/classes/EventListenerManager.md +5 -5
- package/docs/reference/classes/HttpRouter.md +16 -16
- package/docs/reference/classes/JWTStrategy.md +5 -5
- package/docs/reference/classes/JWTStrategyOptions.md +8 -8
- package/docs/reference/classes/MetricsRoute.md +2 -2
- package/docs/reference/classes/ModelRoute.md +46 -46
- package/docs/reference/classes/ModelUtils.md +13 -31
- package/docs/reference/classes/MongoConnection.md +12 -12
- package/docs/reference/classes/MongoRepository.md +73 -37
- package/docs/reference/classes/MongoSchemaSync.md +37 -7
- package/docs/reference/classes/NetUtils.md +3 -3
- package/docs/reference/classes/NotificationUtils.md +3 -3
- package/docs/reference/classes/ObjectFactory.md +3 -3
- package/docs/reference/classes/OpenAPIRoute.md +5 -5
- package/docs/reference/classes/OpenApiSpec.md +45 -45
- package/docs/reference/classes/RecoverableBaseEntity.md +7 -7
- package/docs/reference/classes/RecoverableBaseMongoEntity.md +8 -8
- package/docs/reference/classes/RedisTransport.md +4 -4
- package/docs/reference/classes/RepoUtils.md +36 -40
- package/docs/reference/classes/RouteUtils.md +7 -7
- package/docs/reference/classes/Server.md +26 -26
- package/docs/reference/classes/SimpleEntity.md +3 -3
- package/docs/reference/classes/SimpleMongoEntity.md +4 -4
- package/docs/reference/classes/StatusExtraData.md +4 -4
- package/docs/reference/classes/StatusRoute.md +1 -1
- package/docs/reference/classes/UWSRequest.md +16 -16
- package/docs/reference/classes/UWSResponse.md +13 -13
- package/docs/reference/classes/UWSWebSocketShim.md +5 -5
- package/docs/reference/enumerations/ACLAction.md +7 -7
- package/docs/reference/enumerations/ApiErrorMessages.md +15 -15
- package/docs/reference/enumerations/ApiErrors.md +15 -15
- package/docs/reference/functions/createWebSocketStream.md +1 -1
- package/docs/reference/functions/isSqlDataSource.md +1 -1
- package/docs/reference/functions/readBody.md +1 -1
- package/docs/reference/functions/resolveCollectionName.md +2 -2
- package/docs/reference/functions/runChain.md +1 -1
- package/docs/reference/functions/snakeCase.md +1 -1
- package/docs/reference/interfaces/ACLRecord.md +8 -8
- package/docs/reference/interfaces/AccessControlList.md +5 -5
- package/docs/reference/interfaces/AuthResult.md +5 -5
- package/docs/reference/interfaces/AuthStrategy.md +4 -4
- package/docs/reference/interfaces/CreateRequestOptions.md +9 -9
- package/docs/reference/interfaces/DeleteRequestOptions.md +10 -20
- package/docs/reference/interfaces/FindRequestOptions.md +10 -10
- package/docs/reference/interfaces/HttpRequest.md +15 -15
- package/docs/reference/interfaces/HttpResponse.md +11 -11
- package/docs/reference/interfaces/JWTAuthResult.md +6 -6
- package/docs/reference/interfaces/RepoCreateOptions.md +7 -7
- package/docs/reference/interfaces/RepoDeleteOptions.md +8 -18
- package/docs/reference/interfaces/RepoFindOptions.md +10 -20
- package/docs/reference/interfaces/RepoOperationOptions.md +6 -6
- package/docs/reference/interfaces/RepoUpdateOptions.md +7 -17
- package/docs/reference/interfaces/RequestOptions.md +8 -8
- package/docs/reference/interfaces/RequestWS.md +17 -17
- package/docs/reference/interfaces/TruncateRequestOptions.md +12 -26
- package/docs/reference/interfaces/UpdateRequestOptions.md +10 -20
- package/docs/reference/type-aliases/ErrorHandler.md +1 -1
- package/docs/reference/type-aliases/NextFunction.md +1 -1
- package/docs/reference/type-aliases/OneOrMany.md +1 -1
- package/docs/reference/type-aliases/OneOrNull.md +1 -1
- package/docs/reference/type-aliases/PartialBaseEntity.md +1 -1
- package/docs/reference/type-aliases/PartialSimpleEntity.md +1 -1
- package/docs/reference/type-aliases/RequestHandler.md +1 -1
- package/docs/reference/type-aliases/UpdateObject.md +1 -1
- package/docs/reference/type-aliases/WsUpgradeAuth.md +1 -1
- package/docs/reference/type-aliases/WsUpgradeAuthResult.md +5 -5
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: RepoOperationOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [src/models/RepoUtils.ts:31](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/models/RepoUtils.ts:31](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L31)
|
|
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:33](https://github.com/rapidrest/service-core/blob/
|
|
27
|
+
Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L33)
|
|
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:35](https://github.com/rapidrest/service-core/blob/
|
|
37
|
+
Defined in: [src/models/RepoUtils.ts:35](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L35)
|
|
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:37](https://github.com/rapidrest/service-core/blob/
|
|
47
|
+
Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L37)
|
|
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:39](https://github.com/rapidrest/service-core/blob/
|
|
57
|
+
Defined in: [src/models/RepoUtils.ts:39](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L39)
|
|
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:41](https://github.com/rapidrest/service-core/blob/
|
|
67
|
+
Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L41)
|
|
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:
|
|
9
|
+
Defined in: [src/models/RepoUtils.ts:76](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L76)
|
|
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:33](https://github.com/rapidrest/service-core/blob/
|
|
29
|
+
Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L33)
|
|
30
30
|
|
|
31
31
|
Set to `true` to ignore the ACL permissions check.
|
|
32
32
|
|
|
@@ -36,21 +36,11 @@ Set to `true` to ignore the ACL permissions check.
|
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
39
|
-
### productUid?
|
|
40
|
-
|
|
41
|
-
> `optional` **productUid?**: `string`
|
|
42
|
-
|
|
43
|
-
Defined in: [src/models/RepoUtils.ts:82](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/RepoUtils.ts#L82)
|
|
44
|
-
|
|
45
|
-
The desired product uid of the resource to update.
|
|
46
|
-
|
|
47
|
-
***
|
|
48
|
-
|
|
49
39
|
### pushChannels?
|
|
50
40
|
|
|
51
41
|
> `optional` **pushChannels?**: `string`[]
|
|
52
42
|
|
|
53
|
-
Defined in: [src/models/RepoUtils.ts:35](https://github.com/rapidrest/service-core/blob/
|
|
43
|
+
Defined in: [src/models/RepoUtils.ts:35](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L35)
|
|
54
44
|
|
|
55
45
|
An additional list of channel names to send push notifications to.
|
|
56
46
|
|
|
@@ -64,7 +54,7 @@ An additional list of channel names to send push notifications to.
|
|
|
64
54
|
|
|
65
55
|
> `optional` **recordEvent?**: `boolean`
|
|
66
56
|
|
|
67
|
-
Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/
|
|
57
|
+
Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L37)
|
|
68
58
|
|
|
69
59
|
Indicates if a telemetry event should be broadcast for the request.
|
|
70
60
|
|
|
@@ -78,7 +68,7 @@ Indicates if a telemetry event should be broadcast for the request.
|
|
|
78
68
|
|
|
79
69
|
> `optional` **skipPush?**: `boolean`
|
|
80
70
|
|
|
81
|
-
Defined in: [src/models/RepoUtils.ts:39](https://github.com/rapidrest/service-core/blob/
|
|
71
|
+
Defined in: [src/models/RepoUtils.ts:39](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L39)
|
|
82
72
|
|
|
83
73
|
Set to `true` to not send a push notification.
|
|
84
74
|
|
|
@@ -92,7 +82,7 @@ Set to `true` to not send a push notification.
|
|
|
92
82
|
|
|
93
83
|
> `optional` **user?**: `JWTUser`
|
|
94
84
|
|
|
95
|
-
Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/
|
|
85
|
+
Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L41)
|
|
96
86
|
|
|
97
87
|
The authenticated user making the request.
|
|
98
88
|
|
|
@@ -106,6 +96,6 @@ The authenticated user making the request.
|
|
|
106
96
|
|
|
107
97
|
> `optional` **version?**: `string` \| `number`
|
|
108
98
|
|
|
109
|
-
Defined in: [src/models/RepoUtils.ts:
|
|
99
|
+
Defined in: [src/models/RepoUtils.ts:78](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L78)
|
|
110
100
|
|
|
111
101
|
The desired version number of the resource to update.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: RequestOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [src/routes/ModelRoute.ts:25](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/routes/ModelRoute.ts:25](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L25)
|
|
10
10
|
|
|
11
11
|
The set of options required by all request handlers.
|
|
12
12
|
|
|
@@ -27,7 +27,7 @@ The set of options required by all request handlers.
|
|
|
27
27
|
|
|
28
28
|
> `optional` **ignoreACL?**: `boolean`
|
|
29
29
|
|
|
30
|
-
Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/
|
|
30
|
+
Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L33)
|
|
31
31
|
|
|
32
32
|
Set to `true` to ignore the ACL permissions check.
|
|
33
33
|
|
|
@@ -41,7 +41,7 @@ Set to `true` to ignore the ACL permissions check.
|
|
|
41
41
|
|
|
42
42
|
> `optional` **pushChannels?**: `string`[]
|
|
43
43
|
|
|
44
|
-
Defined in: [src/models/RepoUtils.ts:35](https://github.com/rapidrest/service-core/blob/
|
|
44
|
+
Defined in: [src/models/RepoUtils.ts:35](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L35)
|
|
45
45
|
|
|
46
46
|
An additional list of channel names to send push notifications to.
|
|
47
47
|
|
|
@@ -55,7 +55,7 @@ An additional list of channel names to send push notifications to.
|
|
|
55
55
|
|
|
56
56
|
> `optional` **recordEvent?**: `boolean`
|
|
57
57
|
|
|
58
|
-
Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/
|
|
58
|
+
Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L37)
|
|
59
59
|
|
|
60
60
|
Indicates if a telemetry event should be broadcast for the request.
|
|
61
61
|
|
|
@@ -69,7 +69,7 @@ Indicates if a telemetry event should be broadcast for the request.
|
|
|
69
69
|
|
|
70
70
|
> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
|
|
71
71
|
|
|
72
|
-
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/
|
|
72
|
+
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L27)
|
|
73
73
|
|
|
74
74
|
The originating client request.
|
|
75
75
|
|
|
@@ -79,7 +79,7 @@ The originating client request.
|
|
|
79
79
|
|
|
80
80
|
> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
|
|
81
81
|
|
|
82
|
-
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/
|
|
82
|
+
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L29)
|
|
83
83
|
|
|
84
84
|
The outgoing client response.
|
|
85
85
|
|
|
@@ -89,7 +89,7 @@ The outgoing client response.
|
|
|
89
89
|
|
|
90
90
|
> `optional` **skipPush?**: `boolean`
|
|
91
91
|
|
|
92
|
-
Defined in: [src/models/RepoUtils.ts:39](https://github.com/rapidrest/service-core/blob/
|
|
92
|
+
Defined in: [src/models/RepoUtils.ts:39](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L39)
|
|
93
93
|
|
|
94
94
|
Set to `true` to not send a push notification.
|
|
95
95
|
|
|
@@ -103,7 +103,7 @@ Set to `true` to not send a push notification.
|
|
|
103
103
|
|
|
104
104
|
> `optional` **user?**: `JWTUser`
|
|
105
105
|
|
|
106
|
-
Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/
|
|
106
|
+
Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L41)
|
|
107
107
|
|
|
108
108
|
The authenticated user making the request.
|
|
109
109
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: RequestWS
|
|
8
8
|
|
|
9
|
-
Defined in: [src/http/WebSocket.ts:14](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/http/WebSocket.ts:14](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/WebSocket.ts#L14)
|
|
10
10
|
|
|
11
11
|
HTTP request type for handling WebSocket upgrade requests.
|
|
12
12
|
Extends `HttpRequest` with WebSocket-specific properties set by the router
|
|
@@ -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/
|
|
31
|
+
Defined in: [src/http/types.ts:26](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L26)
|
|
32
32
|
|
|
33
33
|
Full decoded JWT payload, set by JWT auth middleware.
|
|
34
34
|
|
|
@@ -42,7 +42,7 @@ Full decoded JWT payload, set by JWT auth middleware.
|
|
|
42
42
|
|
|
43
43
|
> `optional` **authToken?**: `string`
|
|
44
44
|
|
|
45
|
-
Defined in: [src/http/types.ts:28](https://github.com/rapidrest/service-core/blob/
|
|
45
|
+
Defined in: [src/http/types.ts:28](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L28)
|
|
46
46
|
|
|
47
47
|
Raw JWT token string, set by JWT auth middleware.
|
|
48
48
|
|
|
@@ -56,7 +56,7 @@ Raw JWT token string, set by JWT auth middleware.
|
|
|
56
56
|
|
|
57
57
|
> **body**: `any`
|
|
58
58
|
|
|
59
|
-
Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blob/
|
|
59
|
+
Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L17)
|
|
60
60
|
|
|
61
61
|
#### Inherited from
|
|
62
62
|
|
|
@@ -68,7 +68,7 @@ Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blo
|
|
|
68
68
|
|
|
69
69
|
> **cookies**: `Record`\<`string`, `string`\>
|
|
70
70
|
|
|
71
|
-
Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blob/
|
|
71
|
+
Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L19)
|
|
72
72
|
|
|
73
73
|
#### Inherited from
|
|
74
74
|
|
|
@@ -80,7 +80,7 @@ Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blo
|
|
|
80
80
|
|
|
81
81
|
> **headers**: `Record`\<`string`, `string` \| `string`[] \| `undefined`\>
|
|
82
82
|
|
|
83
|
-
Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blob/
|
|
83
|
+
Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L14)
|
|
84
84
|
|
|
85
85
|
#### Inherited from
|
|
86
86
|
|
|
@@ -92,7 +92,7 @@ Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blo
|
|
|
92
92
|
|
|
93
93
|
> **method**: `string`
|
|
94
94
|
|
|
95
|
-
Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blob/
|
|
95
|
+
Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L11)
|
|
96
96
|
|
|
97
97
|
#### Inherited from
|
|
98
98
|
|
|
@@ -104,7 +104,7 @@ Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blo
|
|
|
104
104
|
|
|
105
105
|
> **params**: `Record`\<`string`, `string`\>
|
|
106
106
|
|
|
107
|
-
Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blob/
|
|
107
|
+
Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L15)
|
|
108
108
|
|
|
109
109
|
#### Inherited from
|
|
110
110
|
|
|
@@ -116,7 +116,7 @@ Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blo
|
|
|
116
116
|
|
|
117
117
|
> **path**: `string`
|
|
118
118
|
|
|
119
|
-
Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blob/
|
|
119
|
+
Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L12)
|
|
120
120
|
|
|
121
121
|
#### Inherited from
|
|
122
122
|
|
|
@@ -128,7 +128,7 @@ Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blo
|
|
|
128
128
|
|
|
129
129
|
> **query**: `Record`\<`string`, `string` \| `string`[]\>
|
|
130
130
|
|
|
131
|
-
Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blob/
|
|
131
|
+
Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L16)
|
|
132
132
|
|
|
133
133
|
#### Inherited from
|
|
134
134
|
|
|
@@ -140,7 +140,7 @@ Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blo
|
|
|
140
140
|
|
|
141
141
|
> `optional` **rawBody?**: `Buffer`\<`ArrayBufferLike`\>
|
|
142
142
|
|
|
143
|
-
Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blob/
|
|
143
|
+
Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L18)
|
|
144
144
|
|
|
145
145
|
#### Inherited from
|
|
146
146
|
|
|
@@ -152,7 +152,7 @@ Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blo
|
|
|
152
152
|
|
|
153
153
|
> **signedCookies**: `Record`\<`string`, `string`\>
|
|
154
154
|
|
|
155
|
-
Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blob/
|
|
155
|
+
Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L20)
|
|
156
156
|
|
|
157
157
|
#### Inherited from
|
|
158
158
|
|
|
@@ -164,7 +164,7 @@ Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blo
|
|
|
164
164
|
|
|
165
165
|
> **socket**: `object`
|
|
166
166
|
|
|
167
|
-
Defined in: [src/http/types.ts:22](https://github.com/rapidrest/service-core/blob/
|
|
167
|
+
Defined in: [src/http/types.ts:22](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L22)
|
|
168
168
|
|
|
169
169
|
Minimal socket interface; populated with remote address for IP extraction.
|
|
170
170
|
|
|
@@ -182,7 +182,7 @@ Minimal socket interface; populated with remote address for IP extraction.
|
|
|
182
182
|
|
|
183
183
|
> **url**: `string`
|
|
184
184
|
|
|
185
|
-
Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blob/
|
|
185
|
+
Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L13)
|
|
186
186
|
|
|
187
187
|
#### Inherited from
|
|
188
188
|
|
|
@@ -194,7 +194,7 @@ Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blo
|
|
|
194
194
|
|
|
195
195
|
> `optional` **user?**: `any`
|
|
196
196
|
|
|
197
|
-
Defined in: [src/http/types.ts:24](https://github.com/rapidrest/service-core/blob/
|
|
197
|
+
Defined in: [src/http/types.ts:24](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L24)
|
|
198
198
|
|
|
199
199
|
Set by JWT auth middleware after successful token verification.
|
|
200
200
|
|
|
@@ -208,7 +208,7 @@ Set by JWT auth middleware after successful token verification.
|
|
|
208
208
|
|
|
209
209
|
> **websocket**: [`UWSWebSocketShim`](../classes/UWSWebSocketShim.md) \| `undefined`
|
|
210
210
|
|
|
211
|
-
Defined in: [src/http/WebSocket.ts:18](https://github.com/rapidrest/service-core/blob/
|
|
211
|
+
Defined in: [src/http/WebSocket.ts:18](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/WebSocket.ts#L18)
|
|
212
212
|
|
|
213
213
|
The uWS WebSocket shim for this connection. Set on `open` after the upgrade.
|
|
214
214
|
|
|
@@ -218,7 +218,7 @@ The uWS WebSocket shim for this connection. Set on `open` after the upgrade.
|
|
|
218
218
|
|
|
219
219
|
> **wsHandled**: `boolean`
|
|
220
220
|
|
|
221
|
-
Defined in: [src/http/WebSocket.ts:25](https://github.com/rapidrest/service-core/blob/
|
|
221
|
+
Defined in: [src/http/WebSocket.ts:25](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/WebSocket.ts#L25)
|
|
222
222
|
|
|
223
223
|
Indicates that the WebSocket handler has processed this connection and the
|
|
224
224
|
connection should remain open. Set to `true` by `wrapMiddleware` when a
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: TruncateRequestOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
9
|
+
Defined in: [src/routes/ModelRoute.ts:70](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L70)
|
|
10
10
|
|
|
11
11
|
The set of options required by truncate request handlers.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ The set of options required by truncate request handlers.
|
|
|
20
20
|
|
|
21
21
|
> `optional` **ignoreACL?**: `boolean`
|
|
22
22
|
|
|
23
|
-
Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/
|
|
23
|
+
Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L33)
|
|
24
24
|
|
|
25
25
|
Set to `true` to ignore the ACL permissions check.
|
|
26
26
|
|
|
@@ -34,31 +34,17 @@ Set to `true` to ignore the ACL permissions check.
|
|
|
34
34
|
|
|
35
35
|
> **params**: `any`
|
|
36
36
|
|
|
37
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
37
|
+
Defined in: [src/routes/ModelRoute.ts:72](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L72)
|
|
38
38
|
|
|
39
39
|
The list of URL parameters to use in the search.
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
43
|
-
### productUid?
|
|
44
|
-
|
|
45
|
-
> `optional` **productUid?**: `string`
|
|
46
|
-
|
|
47
|
-
Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/routes/ModelRoute.ts#L48)
|
|
48
|
-
|
|
49
|
-
The desired product uid of the resource to delete.
|
|
50
|
-
|
|
51
|
-
#### Inherited from
|
|
52
|
-
|
|
53
|
-
[`DeleteRequestOptions`](DeleteRequestOptions.md).[`productUid`](DeleteRequestOptions.md#productuid)
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
43
|
### purge?
|
|
58
44
|
|
|
59
45
|
> `optional` **purge?**: `boolean`
|
|
60
46
|
|
|
61
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
47
|
+
Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L48)
|
|
62
48
|
|
|
63
49
|
Set to true to permanently remove the object from the database (if applicable).
|
|
64
50
|
|
|
@@ -72,7 +58,7 @@ Set to true to permanently remove the object from the database (if applicable).
|
|
|
72
58
|
|
|
73
59
|
> `optional` **pushChannels?**: `string`[]
|
|
74
60
|
|
|
75
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
61
|
+
Defined in: [src/routes/ModelRoute.ts:74](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L74)
|
|
76
62
|
|
|
77
63
|
An additional list of channel names to send push notifications to.
|
|
78
64
|
|
|
@@ -86,7 +72,7 @@ An additional list of channel names to send push notifications to.
|
|
|
86
72
|
|
|
87
73
|
> **query**: `any`
|
|
88
74
|
|
|
89
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
75
|
+
Defined in: [src/routes/ModelRoute.ts:76](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L76)
|
|
90
76
|
|
|
91
77
|
The list of query parameters to use in the search.
|
|
92
78
|
|
|
@@ -96,7 +82,7 @@ The list of query parameters to use in the search.
|
|
|
96
82
|
|
|
97
83
|
> `optional` **recordEvent?**: `boolean`
|
|
98
84
|
|
|
99
|
-
Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/
|
|
85
|
+
Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L37)
|
|
100
86
|
|
|
101
87
|
Indicates if a telemetry event should be broadcast for the request.
|
|
102
88
|
|
|
@@ -110,7 +96,7 @@ Indicates if a telemetry event should be broadcast for the request.
|
|
|
110
96
|
|
|
111
97
|
> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
|
|
112
98
|
|
|
113
|
-
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/
|
|
99
|
+
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L27)
|
|
114
100
|
|
|
115
101
|
The originating client request.
|
|
116
102
|
|
|
@@ -124,7 +110,7 @@ The originating client request.
|
|
|
124
110
|
|
|
125
111
|
> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
|
|
126
112
|
|
|
127
|
-
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/
|
|
113
|
+
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L29)
|
|
128
114
|
|
|
129
115
|
The outgoing client response.
|
|
130
116
|
|
|
@@ -138,7 +124,7 @@ The outgoing client response.
|
|
|
138
124
|
|
|
139
125
|
> `optional` **skipPush?**: `boolean`
|
|
140
126
|
|
|
141
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
127
|
+
Defined in: [src/routes/ModelRoute.ts:78](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L78)
|
|
142
128
|
|
|
143
129
|
Set to `true` to not send a push notification.
|
|
144
130
|
|
|
@@ -152,7 +138,7 @@ Set to `true` to not send a push notification.
|
|
|
152
138
|
|
|
153
139
|
> `optional` **user?**: `JWTUser`
|
|
154
140
|
|
|
155
|
-
Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/
|
|
141
|
+
Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L41)
|
|
156
142
|
|
|
157
143
|
The authenticated user making the request.
|
|
158
144
|
|
|
@@ -166,7 +152,7 @@ The authenticated user making the request.
|
|
|
166
152
|
|
|
167
153
|
> `optional` **version?**: `string` \| `number`
|
|
168
154
|
|
|
169
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
155
|
+
Defined in: [src/routes/ModelRoute.ts:54](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L54)
|
|
170
156
|
|
|
171
157
|
The desired version number of the resource to delete.
|
|
172
158
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: UpdateRequestOptions\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
9
|
+
Defined in: [src/routes/ModelRoute.ts:87](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L87)
|
|
10
10
|
|
|
11
11
|
The set of options required by update request handlers.
|
|
12
12
|
|
|
@@ -26,7 +26,7 @@ The set of options required by update request handlers.
|
|
|
26
26
|
|
|
27
27
|
> `optional` **existing?**: `T` \| `null`
|
|
28
28
|
|
|
29
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
29
|
+
Defined in: [src/routes/ModelRoute.ts:89](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L89)
|
|
30
30
|
|
|
31
31
|
The existing object that has already been recently pulled from the datastore.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The existing object that has already been recently pulled from the datastore.
|
|
|
36
36
|
|
|
37
37
|
> `optional` **ignoreACL?**: `boolean`
|
|
38
38
|
|
|
39
|
-
Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/
|
|
39
|
+
Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L33)
|
|
40
40
|
|
|
41
41
|
Set to `true` to ignore the ACL permissions check.
|
|
42
42
|
|
|
@@ -46,21 +46,11 @@ Set to `true` to ignore the ACL permissions check.
|
|
|
46
46
|
|
|
47
47
|
***
|
|
48
48
|
|
|
49
|
-
### productUid?
|
|
50
|
-
|
|
51
|
-
> `optional` **productUid?**: `string`
|
|
52
|
-
|
|
53
|
-
Defined in: [src/routes/ModelRoute.ts:93](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/routes/ModelRoute.ts#L93)
|
|
54
|
-
|
|
55
|
-
The desired product uid of the resource to update.
|
|
56
|
-
|
|
57
|
-
***
|
|
58
|
-
|
|
59
49
|
### pushChannels?
|
|
60
50
|
|
|
61
51
|
> `optional` **pushChannels?**: `string`[]
|
|
62
52
|
|
|
63
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
53
|
+
Defined in: [src/routes/ModelRoute.ts:91](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L91)
|
|
64
54
|
|
|
65
55
|
An additional list of channel names to send push notifications to.
|
|
66
56
|
|
|
@@ -74,7 +64,7 @@ An additional list of channel names to send push notifications to.
|
|
|
74
64
|
|
|
75
65
|
> `optional` **recordEvent?**: `boolean`
|
|
76
66
|
|
|
77
|
-
Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/
|
|
67
|
+
Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L37)
|
|
78
68
|
|
|
79
69
|
Indicates if a telemetry event should be broadcast for the request.
|
|
80
70
|
|
|
@@ -88,7 +78,7 @@ Indicates if a telemetry event should be broadcast for the request.
|
|
|
88
78
|
|
|
89
79
|
> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
|
|
90
80
|
|
|
91
|
-
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/
|
|
81
|
+
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L27)
|
|
92
82
|
|
|
93
83
|
The originating client request.
|
|
94
84
|
|
|
@@ -102,7 +92,7 @@ The originating client request.
|
|
|
102
92
|
|
|
103
93
|
> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
|
|
104
94
|
|
|
105
|
-
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/
|
|
95
|
+
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L29)
|
|
106
96
|
|
|
107
97
|
The outgoing client response.
|
|
108
98
|
|
|
@@ -116,7 +106,7 @@ The outgoing client response.
|
|
|
116
106
|
|
|
117
107
|
> `optional` **skipPush?**: `boolean`
|
|
118
108
|
|
|
119
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
109
|
+
Defined in: [src/routes/ModelRoute.ts:93](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L93)
|
|
120
110
|
|
|
121
111
|
Set to `true` to not send a push notification.
|
|
122
112
|
|
|
@@ -130,7 +120,7 @@ Set to `true` to not send a push notification.
|
|
|
130
120
|
|
|
131
121
|
> `optional` **user?**: `JWTUser`
|
|
132
122
|
|
|
133
|
-
Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/
|
|
123
|
+
Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L41)
|
|
134
124
|
|
|
135
125
|
The authenticated user making the request.
|
|
136
126
|
|
|
@@ -144,6 +134,6 @@ The authenticated user making the request.
|
|
|
144
134
|
|
|
145
135
|
> `optional` **version?**: `string` \| `number`
|
|
146
136
|
|
|
147
|
-
Defined in: [src/routes/ModelRoute.ts:
|
|
137
|
+
Defined in: [src/routes/ModelRoute.ts:95](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L95)
|
|
148
138
|
|
|
149
139
|
The desired version number of the resource to update.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **ErrorHandler** = (`err`, `req`, `res`, `next`) => `void` \| `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [src/http/types.ts:60](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/http/types.ts:60](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L60)
|
|
12
12
|
|
|
13
13
|
Standard 4-param error-handling middleware function.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **NextFunction** = (`err?`) => `void`
|
|
10
10
|
|
|
11
|
-
Defined in: [src/http/types.ts:54](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/http/types.ts:54](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L54)
|
|
12
12
|
|
|
13
13
|
Standard Express-style next callback. Pass an error to trigger error handlers.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **OneOrMany**\<`T`\> = `T` \| `T`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [src/Types.ts:4](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/Types.ts:4](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/Types.ts#L4)
|
|
12
12
|
|
|
13
13
|
Provides an explicit type declaration for `T | T[]`.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **OneOrNull**\<`T`\> = `T` \| `null`
|
|
10
10
|
|
|
11
|
-
Defined in: [src/Types.ts:9](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/Types.ts:9](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/Types.ts#L9)
|
|
12
12
|
|
|
13
13
|
Provides an explicit type declaration for `T | null`.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **PartialBaseEntity**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\> & `Pick`\<`T`, `"version"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [src/models/BaseEntity.ts:68](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/models/BaseEntity.ts:68](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/BaseEntity.ts#L68)
|
|
12
12
|
|
|
13
13
|
## Type Parameters
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **PartialSimpleEntity**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [src/models/SimpleEntity.ts:33](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/models/SimpleEntity.ts:33](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/SimpleEntity.ts#L33)
|
|
12
12
|
|
|
13
13
|
## Type Parameters
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **RequestHandler** = (`req`, `res`, `next`) => `void` \| `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [src/http/types.ts:57](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/http/types.ts:57](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L57)
|
|
12
12
|
|
|
13
13
|
Standard 3-param middleware function.
|
|
14
14
|
|