@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.
- package/dist/lib/OpenApiSpec.js +1 -1
- package/dist/lib/OpenApiSpec.js.map +1 -1
- package/dist/lib/models/ModelUtils.js +1 -1
- package/dist/lib/models/ModelUtils.js.map +1 -1
- package/dist/lib/routes/MetricsRoute.js +1 -1
- package/dist/lib/routes/MetricsRoute.js.map +1 -1
- package/dist/lib/routes/RouteUtils.js +1 -1
- package/dist/lib/routes/RouteUtils.js.map +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +5 -5
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +1 -1
- 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/ColumnInfo.md +4 -4
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +5 -5
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +4 -4
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +5 -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 +9 -9
- 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 +4 -4
- package/docs/reference/classes/ModelRoute.md +26 -26
- package/docs/reference/classes/ModelUtils.md +50 -50
- package/docs/reference/classes/MongoConnection.md +12 -12
- package/docs/reference/classes/MongoRepository.md +17 -17
- package/docs/reference/classes/MongoSchemaSync.md +3 -3
- 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 +28 -28
- 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 +1 -1
- 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 +11 -11
- 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 +9 -9
- package/docs/reference/interfaces/RepoFindOptions.md +11 -11
- package/docs/reference/interfaces/RepoOperationOptions.md +6 -6
- package/docs/reference/interfaces/RepoUpdateOptions.md +8 -8
- package/docs/reference/interfaces/RequestOptions.md +8 -8
- package/docs/reference/interfaces/RequestWS.md +17 -17
- package/docs/reference/interfaces/TruncateRequestOptions.md +13 -13
- package/docs/reference/interfaces/UpdateRequestOptions.md +11 -11
- 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 +3 -3
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isSqlDataSource**(`conn`): `boolean`
|
|
10
10
|
|
|
11
|
-
Defined in: [src/database/ConnectionKinds.ts:12](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/database/ConnectionKinds.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/ConnectionKinds.ts#L12)
|
|
12
12
|
|
|
13
13
|
Determines whether the given connection object is a TypeORM `DataSource` for a SQL database. This check is
|
|
14
14
|
performed without importing the optional `typeorm` package by duck-typing the connection object.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **readBody**(`uwsRes`, `req`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [src/http/Adapters.ts:224](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/http/Adapters.ts:224](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L224)
|
|
12
12
|
|
|
13
13
|
Reads the full request body from a uWS response object as a Buffer.
|
|
14
14
|
Body parsing (JSON / URL-encoded) is applied based on content-type and the result
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **resolveCollectionName**(`clazz`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [src/database/NamingUtils.ts:38](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/database/NamingUtils.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/NamingUtils.ts#L38)
|
|
12
12
|
|
|
13
13
|
Resolves the name of the database collection (or table) that records of the given model class are stored in.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **runChain**(`handlers`, `req`, `res`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [src/http/Router.ts:43](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/http/Router.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L43)
|
|
12
12
|
|
|
13
13
|
Runs an ordered array of middleware handlers sequentially, Express-style.
|
|
14
14
|
Supports both 3-param `(req, res, next)` handlers and 4-param `(err, req, res, next)`
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **snakeCase**(`str`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [src/database/NamingUtils.ts:14](https://github.com/rapidrest/service-core/blob/
|
|
11
|
+
Defined in: [src/database/NamingUtils.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/NamingUtils.ts#L14)
|
|
12
12
|
|
|
13
13
|
Converts a string into snake_case.
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ACLRecord
|
|
8
8
|
|
|
9
|
-
Defined in: [src/security/AccessControlList.ts:33](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/security/AccessControlList.ts:33](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L33)
|
|
10
10
|
|
|
11
11
|
The `ACLRecord` interface describes a single permissions entry in an `AccessControlList` that grants or denies
|
|
12
12
|
a set of permissions to a single user or role.
|
|
@@ -29,7 +29,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
29
29
|
|
|
30
30
|
> **create**: `boolean` \| `null`
|
|
31
31
|
|
|
32
|
-
Defined in: [src/security/AccessControlList.ts:42](https://github.com/rapidrest/service-core/blob/
|
|
32
|
+
Defined in: [src/security/AccessControlList.ts:42](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L42)
|
|
33
33
|
|
|
34
34
|
Indicates that the user or role has permission to create new records of the entity.
|
|
35
35
|
|
|
@@ -39,7 +39,7 @@ Indicates that the user or role has permission to create new records of the enti
|
|
|
39
39
|
|
|
40
40
|
> **delete**: `boolean` \| `null`
|
|
41
41
|
|
|
42
|
-
Defined in: [src/security/AccessControlList.ts:57](https://github.com/rapidrest/service-core/blob/
|
|
42
|
+
Defined in: [src/security/AccessControlList.ts:57](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L57)
|
|
43
43
|
|
|
44
44
|
Indicates that the user or role has permission to delete existing records of the entity.
|
|
45
45
|
|
|
@@ -49,7 +49,7 @@ Indicates that the user or role has permission to delete existing records of the
|
|
|
49
49
|
|
|
50
50
|
> **full**: `boolean` \| `null`
|
|
51
51
|
|
|
52
|
-
Defined in: [src/security/AccessControlList.ts:69](https://github.com/rapidrest/service-core/blob/
|
|
52
|
+
Defined in: [src/security/AccessControlList.ts:69](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L69)
|
|
53
53
|
|
|
54
54
|
Indicates that the user or role has total control over records of the entity. This supersedes all of the above
|
|
55
55
|
permissions.
|
|
@@ -60,7 +60,7 @@ permissions.
|
|
|
60
60
|
|
|
61
61
|
> **read**: `boolean` \| `null`
|
|
62
62
|
|
|
63
|
-
Defined in: [src/security/AccessControlList.ts:47](https://github.com/rapidrest/service-core/blob/
|
|
63
|
+
Defined in: [src/security/AccessControlList.ts:47](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L47)
|
|
64
64
|
|
|
65
65
|
Indicates that the user or role has permission to read records of the entity.
|
|
66
66
|
|
|
@@ -70,7 +70,7 @@ Indicates that the user or role has permission to read records of the entity.
|
|
|
70
70
|
|
|
71
71
|
> **special**: `boolean` \| `null`
|
|
72
72
|
|
|
73
|
-
Defined in: [src/security/AccessControlList.ts:63](https://github.com/rapidrest/service-core/blob/
|
|
73
|
+
Defined in: [src/security/AccessControlList.ts:63](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L63)
|
|
74
74
|
|
|
75
75
|
Indicates that the user or role has special permission over records of the entity. The exact meaning of this
|
|
76
76
|
may vary by service.
|
|
@@ -81,7 +81,7 @@ may vary by service.
|
|
|
81
81
|
|
|
82
82
|
> **update**: `boolean` \| `null`
|
|
83
83
|
|
|
84
|
-
Defined in: [src/security/AccessControlList.ts:52](https://github.com/rapidrest/service-core/blob/
|
|
84
|
+
Defined in: [src/security/AccessControlList.ts:52](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L52)
|
|
85
85
|
|
|
86
86
|
Indicates that the user or role has permission to modify existing records of the entity.
|
|
87
87
|
|
|
@@ -91,6 +91,6 @@ Indicates that the user or role has permission to modify existing records of the
|
|
|
91
91
|
|
|
92
92
|
> **userOrRoleId**: `string`
|
|
93
93
|
|
|
94
|
-
Defined in: [src/security/AccessControlList.ts:37](https://github.com/rapidrest/service-core/blob/
|
|
94
|
+
Defined in: [src/security/AccessControlList.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L37)
|
|
95
95
|
|
|
96
96
|
The unique identifier of the user or role that the record belongs to.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: AccessControlList
|
|
8
8
|
|
|
9
|
-
Defined in: [src/security/AccessControlList.ts:97](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/security/AccessControlList.ts:97](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L97)
|
|
10
10
|
|
|
11
11
|
The access control list provides a generic interface for the storage of user and roles permissions. Each ACL object
|
|
12
12
|
represents the permission set for a single entity within the system. The entity is identified generically by its
|
|
@@ -40,7 +40,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
40
40
|
|
|
41
41
|
> `optional` **parent?**: `AccessControlList` \| `null`
|
|
42
42
|
|
|
43
|
-
Defined in: [src/security/AccessControlList.ts:106](https://github.com/rapidrest/service-core/blob/
|
|
43
|
+
Defined in: [src/security/AccessControlList.ts:106](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L106)
|
|
44
44
|
|
|
45
45
|
The parent access control list that this instance inherits permissions from.
|
|
46
46
|
|
|
@@ -50,7 +50,7 @@ The parent access control list that this instance inherits permissions from.
|
|
|
50
50
|
|
|
51
51
|
> `optional` **parentUid?**: `string`
|
|
52
52
|
|
|
53
|
-
Defined in: [src/security/AccessControlList.ts:112](https://github.com/rapidrest/service-core/blob/
|
|
53
|
+
Defined in: [src/security/AccessControlList.ts:112](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L112)
|
|
54
54
|
|
|
55
55
|
The universally unique identifier of the parent `AccessControlList` that this object will inherit permissions
|
|
56
56
|
from.
|
|
@@ -61,7 +61,7 @@ from.
|
|
|
61
61
|
|
|
62
62
|
> **records**: [`ACLRecord`](ACLRecord.md)[]
|
|
63
63
|
|
|
64
|
-
Defined in: [src/security/AccessControlList.ts:117](https://github.com/rapidrest/service-core/blob/
|
|
64
|
+
Defined in: [src/security/AccessControlList.ts:117](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L117)
|
|
65
65
|
|
|
66
66
|
The list of all permission records associated with this access control list.
|
|
67
67
|
|
|
@@ -71,6 +71,6 @@ The list of all permission records associated with this access control list.
|
|
|
71
71
|
|
|
72
72
|
> **uid**: `string`
|
|
73
73
|
|
|
74
|
-
Defined in: [src/security/AccessControlList.ts:101](https://github.com/rapidrest/service-core/blob/
|
|
74
|
+
Defined in: [src/security/AccessControlList.ts:101](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L101)
|
|
75
75
|
|
|
76
76
|
The universally unique identifier (`uuid`) of the entity that the access control list belongs to.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: AuthResult
|
|
8
8
|
|
|
9
|
-
Defined in: [src/auth/AuthStrategy.ts:10](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/auth/AuthStrategy.ts:10](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L10)
|
|
10
10
|
|
|
11
11
|
Result returned by `AuthStrategy.authenticate()`.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Result returned by `AuthStrategy.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/
|
|
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
|
|
|
@@ -30,7 +30,7 @@ The raw auth data that was verified.
|
|
|
30
30
|
|
|
31
31
|
> **method**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [src/auth/AuthStrategy.ts:14](https://github.com/rapidrest/service-core/blob/
|
|
33
|
+
Defined in: [src/auth/AuthStrategy.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L14)
|
|
34
34
|
|
|
35
35
|
The name of the auth strategy that produced this result.
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@ The name of the auth strategy that produced this result.
|
|
|
40
40
|
|
|
41
41
|
> `optional` **payload?**: `any`
|
|
42
42
|
|
|
43
|
-
Defined in: [src/auth/AuthStrategy.ts:16](https://github.com/rapidrest/service-core/blob/
|
|
43
|
+
Defined in: [src/auth/AuthStrategy.ts:16](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L16)
|
|
44
44
|
|
|
45
45
|
The fully decoded payload from the auth data.
|
|
46
46
|
|
|
@@ -50,6 +50,6 @@ The fully decoded payload from the auth data.
|
|
|
50
50
|
|
|
51
51
|
> `optional` **user?**: `JWTUser`
|
|
52
52
|
|
|
53
|
-
Defined in: [src/auth/AuthStrategy.ts:18](https://github.com/rapidrest/service-core/blob/
|
|
53
|
+
Defined in: [src/auth/AuthStrategy.ts:18](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L18)
|
|
54
54
|
|
|
55
55
|
The authenticated user profile, or `undefined` if authentication failed.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: AuthStrategy
|
|
8
8
|
|
|
9
|
-
Defined in: [src/auth/AuthStrategy.ts:24](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/auth/AuthStrategy.ts:24](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L24)
|
|
10
10
|
|
|
11
11
|
Describes an interface for implementing strategies that will perform authentication.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Describes an interface for implementing strategies that will perform authenticat
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **name**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [src/auth/AuthStrategy.ts:26](https://github.com/rapidrest/service-core/blob/
|
|
19
|
+
Defined in: [src/auth/AuthStrategy.ts:26](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L26)
|
|
20
20
|
|
|
21
21
|
The unique name of the strategy used to register with the `AuthMiddleware`.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The unique name of the strategy used to register with the `AuthMiddleware`.
|
|
|
26
26
|
|
|
27
27
|
> **authenticate**(`req`, `res?`, `required?`): `Promise`\<[`AuthResult`](AuthResult.md) \| `undefined`\>
|
|
28
28
|
|
|
29
|
-
Defined in: [src/auth/AuthStrategy.ts:37](https://github.com/rapidrest/service-core/blob/
|
|
29
|
+
Defined in: [src/auth/AuthStrategy.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L37)
|
|
30
30
|
|
|
31
31
|
Attempts to perform authentication with the given request data. If authentication was successful, returns an
|
|
32
32
|
`AuthResult` containing the authentication details. If authentication fails and `required` is set to `true`
|
|
@@ -62,7 +62,7 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
|
|
|
62
62
|
|
|
63
63
|
> **authenticateSync**(`req`, `res?`, `required?`): [`AuthResult`](AuthResult.md) \| `undefined`
|
|
64
64
|
|
|
65
|
-
Defined in: [src/auth/AuthStrategy.ts:50](https://github.com/rapidrest/service-core/blob/
|
|
65
|
+
Defined in: [src/auth/AuthStrategy.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/AuthStrategy.ts#L50)
|
|
66
66
|
|
|
67
67
|
Attempts to perform authentication with the given request data. If authentication was successful, returns an
|
|
68
68
|
`AuthResult` containing the authentication details. If authentication fails and `required` is set to `true`
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: CreateRequestOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [src/routes/ModelRoute.ts:35](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/routes/ModelRoute.ts:35](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L35)
|
|
10
10
|
|
|
11
11
|
The set of options required by create request handlers.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ The set of options required by create request handlers.
|
|
|
20
20
|
|
|
21
21
|
> `optional` **acl?**: [`AccessControlList`](AccessControlList.md) \| [`AccessControlList`](AccessControlList.md)[]
|
|
22
22
|
|
|
23
|
-
Defined in: [src/routes/ModelRoute.ts:36](https://github.com/rapidrest/service-core/blob/
|
|
23
|
+
Defined in: [src/routes/ModelRoute.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L36)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [src/routes/ModelRoute.ts:36](https://github.com/rapidrest/service-c
|
|
|
28
28
|
|
|
29
29
|
> `optional` **ignoreACL?**: `boolean`
|
|
30
30
|
|
|
31
|
-
Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/
|
|
31
|
+
Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L32)
|
|
32
32
|
|
|
33
33
|
Set to `true` to ignore the ACL permissions check.
|
|
34
34
|
|
|
@@ -42,7 +42,7 @@ Set to `true` to ignore the ACL permissions check.
|
|
|
42
42
|
|
|
43
43
|
> `optional` **pushChannels?**: `string`[]
|
|
44
44
|
|
|
45
|
-
Defined in: [src/routes/ModelRoute.ts:38](https://github.com/rapidrest/service-core/blob/
|
|
45
|
+
Defined in: [src/routes/ModelRoute.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L38)
|
|
46
46
|
|
|
47
47
|
An additional list of channel names to send push notifications to.
|
|
48
48
|
|
|
@@ -56,7 +56,7 @@ An additional list of channel names to send push notifications to.
|
|
|
56
56
|
|
|
57
57
|
> `optional` **recordEvent?**: `boolean`
|
|
58
58
|
|
|
59
|
-
Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/
|
|
59
|
+
Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L36)
|
|
60
60
|
|
|
61
61
|
Indicates if a telemetry event should be broadcast for the request.
|
|
62
62
|
|
|
@@ -70,7 +70,7 @@ Indicates if a telemetry event should be broadcast for the request.
|
|
|
70
70
|
|
|
71
71
|
> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
|
|
72
72
|
|
|
73
|
-
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/
|
|
73
|
+
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L27)
|
|
74
74
|
|
|
75
75
|
The originating client request.
|
|
76
76
|
|
|
@@ -84,7 +84,7 @@ The originating client request.
|
|
|
84
84
|
|
|
85
85
|
> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
|
|
86
86
|
|
|
87
|
-
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/
|
|
87
|
+
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L29)
|
|
88
88
|
|
|
89
89
|
The outgoing client response.
|
|
90
90
|
|
|
@@ -98,7 +98,7 @@ The outgoing client response.
|
|
|
98
98
|
|
|
99
99
|
> `optional` **skipPush?**: `boolean`
|
|
100
100
|
|
|
101
|
-
Defined in: [src/routes/ModelRoute.ts:40](https://github.com/rapidrest/service-core/blob/
|
|
101
|
+
Defined in: [src/routes/ModelRoute.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L40)
|
|
102
102
|
|
|
103
103
|
Set to `true` to not send a push notification.
|
|
104
104
|
|
|
@@ -112,7 +112,7 @@ Set to `true` to not send a push notification.
|
|
|
112
112
|
|
|
113
113
|
> `optional` **user?**: `JWTUser`
|
|
114
114
|
|
|
115
|
-
Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/
|
|
115
|
+
Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
|
|
116
116
|
|
|
117
117
|
The authenticated user making the request.
|
|
118
118
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DeleteRequestOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [src/routes/ModelRoute.ts:46](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/routes/ModelRoute.ts:46](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L46)
|
|
10
10
|
|
|
11
11
|
The set of options required by delete request handlers.
|
|
12
12
|
|
|
@@ -24,7 +24,7 @@ The set of options required by delete request handlers.
|
|
|
24
24
|
|
|
25
25
|
> `optional` **ignoreACL?**: `boolean`
|
|
26
26
|
|
|
27
|
-
Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/
|
|
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
|
|
|
@@ -38,7 +38,7 @@ Set to `true` to ignore the ACL permissions check.
|
|
|
38
38
|
|
|
39
39
|
> `optional` **productUid?**: `string`
|
|
40
40
|
|
|
41
|
-
Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/
|
|
41
|
+
Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L48)
|
|
42
42
|
|
|
43
43
|
The desired product uid of the resource to delete.
|
|
44
44
|
|
|
@@ -48,7 +48,7 @@ The desired product uid of the resource to delete.
|
|
|
48
48
|
|
|
49
49
|
> `optional` **purge?**: `boolean`
|
|
50
50
|
|
|
51
|
-
Defined in: [src/routes/ModelRoute.ts:50](https://github.com/rapidrest/service-core/blob/
|
|
51
|
+
Defined in: [src/routes/ModelRoute.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L50)
|
|
52
52
|
|
|
53
53
|
Set to true to permanently remove the object from the database (if applicable).
|
|
54
54
|
|
|
@@ -58,7 +58,7 @@ Set to true to permanently remove the object from the database (if applicable).
|
|
|
58
58
|
|
|
59
59
|
> `optional` **pushChannels?**: `string`[]
|
|
60
60
|
|
|
61
|
-
Defined in: [src/routes/ModelRoute.ts:52](https://github.com/rapidrest/service-core/blob/
|
|
61
|
+
Defined in: [src/routes/ModelRoute.ts:52](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L52)
|
|
62
62
|
|
|
63
63
|
An additional list of channel names to send push notifications to.
|
|
64
64
|
|
|
@@ -72,7 +72,7 @@ An additional list of channel names to send push notifications to.
|
|
|
72
72
|
|
|
73
73
|
> `optional` **recordEvent?**: `boolean`
|
|
74
74
|
|
|
75
|
-
Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/
|
|
75
|
+
Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L36)
|
|
76
76
|
|
|
77
77
|
Indicates if a telemetry event should be broadcast for the request.
|
|
78
78
|
|
|
@@ -86,7 +86,7 @@ Indicates if a telemetry event should be broadcast for the request.
|
|
|
86
86
|
|
|
87
87
|
> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
|
|
88
88
|
|
|
89
|
-
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/
|
|
89
|
+
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L27)
|
|
90
90
|
|
|
91
91
|
The originating client request.
|
|
92
92
|
|
|
@@ -100,7 +100,7 @@ The originating client request.
|
|
|
100
100
|
|
|
101
101
|
> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
|
|
102
102
|
|
|
103
|
-
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/
|
|
103
|
+
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L29)
|
|
104
104
|
|
|
105
105
|
The outgoing client response.
|
|
106
106
|
|
|
@@ -114,7 +114,7 @@ The outgoing client response.
|
|
|
114
114
|
|
|
115
115
|
> `optional` **skipPush?**: `boolean`
|
|
116
116
|
|
|
117
|
-
Defined in: [src/routes/ModelRoute.ts:54](https://github.com/rapidrest/service-core/blob/
|
|
117
|
+
Defined in: [src/routes/ModelRoute.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L54)
|
|
118
118
|
|
|
119
119
|
Set to `true` to not send a push notification.
|
|
120
120
|
|
|
@@ -128,7 +128,7 @@ Set to `true` to not send a push notification.
|
|
|
128
128
|
|
|
129
129
|
> `optional` **user?**: `JWTUser`
|
|
130
130
|
|
|
131
|
-
Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/
|
|
131
|
+
Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
|
|
132
132
|
|
|
133
133
|
The authenticated user making the request.
|
|
134
134
|
|
|
@@ -142,6 +142,6 @@ The authenticated user making the request.
|
|
|
142
142
|
|
|
143
143
|
> `optional` **version?**: `string` \| `number`
|
|
144
144
|
|
|
145
|
-
Defined in: [src/routes/ModelRoute.ts:56](https://github.com/rapidrest/service-core/blob/
|
|
145
|
+
Defined in: [src/routes/ModelRoute.ts:56](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L56)
|
|
146
146
|
|
|
147
147
|
The desired version number of the resource to delete.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FindRequestOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [src/routes/ModelRoute.ts:62](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/routes/ModelRoute.ts:62](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L62)
|
|
10
10
|
|
|
11
11
|
The set of options required by search request handlers.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ The set of options required by search request handlers.
|
|
|
20
20
|
|
|
21
21
|
> `optional` **ignoreACL?**: `boolean`
|
|
22
22
|
|
|
23
|
-
Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/
|
|
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` **params?**: `any`
|
|
36
36
|
|
|
37
|
-
Defined in: [src/routes/ModelRoute.ts:64](https://github.com/rapidrest/service-core/blob/
|
|
37
|
+
Defined in: [src/routes/ModelRoute.ts:64](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L64)
|
|
38
38
|
|
|
39
39
|
The list of URL parameters to use in the search.
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ The list of URL parameters to use in the search.
|
|
|
44
44
|
|
|
45
45
|
> `optional` **pushChannels?**: `string`[]
|
|
46
46
|
|
|
47
|
-
Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/
|
|
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
|
> **query**: `any`
|
|
60
60
|
|
|
61
|
-
Defined in: [src/routes/ModelRoute.ts:66](https://github.com/rapidrest/service-core/blob/
|
|
61
|
+
Defined in: [src/routes/ModelRoute.ts:66](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L66)
|
|
62
62
|
|
|
63
63
|
The list of query parameters to use in the search.
|
|
64
64
|
|
|
@@ -68,7 +68,7 @@ The list of query parameters to use in the search.
|
|
|
68
68
|
|
|
69
69
|
> `optional` **recordEvent?**: `boolean`
|
|
70
70
|
|
|
71
|
-
Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/
|
|
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` **req?**: [`HttpRequest`](HttpRequest.md)
|
|
84
84
|
|
|
85
|
-
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/
|
|
85
|
+
Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L27)
|
|
86
86
|
|
|
87
87
|
The originating client request.
|
|
88
88
|
|
|
@@ -96,7 +96,7 @@ The originating client request.
|
|
|
96
96
|
|
|
97
97
|
> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
|
|
98
98
|
|
|
99
|
-
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/
|
|
99
|
+
Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L29)
|
|
100
100
|
|
|
101
101
|
The outgoing client response.
|
|
102
102
|
|
|
@@ -110,7 +110,7 @@ The outgoing client response.
|
|
|
110
110
|
|
|
111
111
|
> `optional` **skipPush?**: `boolean`
|
|
112
112
|
|
|
113
|
-
Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/
|
|
113
|
+
Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L38)
|
|
114
114
|
|
|
115
115
|
Set to `true` to not send a push notification.
|
|
116
116
|
|
|
@@ -124,7 +124,7 @@ Set to `true` to not send a push notification.
|
|
|
124
124
|
|
|
125
125
|
> `optional` **user?**: `JWTUser`
|
|
126
126
|
|
|
127
|
-
Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/
|
|
127
|
+
Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RepoUtils.ts#L40)
|
|
128
128
|
|
|
129
129
|
The authenticated user making the request.
|
|
130
130
|
|