@rapidrest/service-core 1.0.0-rc.14 → 1.0.0-rc.16
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/routes/CRUDRoute.js +13 -10
- package/dist/lib/routes/CRUDRoute.js.map +1 -1
- package/dist/lib/security/BaseACLRoute.js +11 -3
- package/dist/lib/security/BaseACLRoute.js.map +1 -1
- package/dist/types/routes/CRUDRoute.d.ts +13 -10
- package/dist/types/security/BaseACLRoute.d.ts +11 -3
- package/package.json +1 -3
- package/docs/Makefile +0 -20
- package/docs/conf.py +0 -58
- package/docs/index.rst +0 -17
- package/docs/make.bat +0 -35
- package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/README.md +0 -13
- package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md +0 -25
- package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md +0 -25
- package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md +0 -25
- package/docs/reference/@rapidrest/namespaces/DocDecorators/README.md +0 -23
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md +0 -25
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md +0 -25
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md +0 -25
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md +0 -25
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md +0 -25
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md +0 -28
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md +0 -25
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md +0 -25
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md +0 -28
- package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md +0 -57
- package/docs/reference/@rapidrest/namespaces/EventDecorators/README.md +0 -12
- package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md +0 -17
- package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md +0 -26
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/README.md +0 -26
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md +0 -25
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md +0 -18
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md +0 -25
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md +0 -27
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md +0 -35
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md +0 -25
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md +0 -27
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md +0 -26
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +0 -45
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +0 -14
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/README.md +0 -27
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +0 -25
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +0 -25
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md +0 -119
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md +0 -25
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md +0 -68
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md +0 -26
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md +0 -26
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md +0 -27
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/CollationOptions.md +0 -79
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md +0 -41
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +0 -51
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/EntityOptions.md +0 -32
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +0 -41
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +0 -61
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/README.md +0 -36
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md +0 -26
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md +0 -33
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md +0 -31
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md +0 -31
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md +0 -26
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md +0 -31
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md +0 -26
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md +0 -31
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md +0 -26
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md +0 -31
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md +0 -33
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md +0 -31
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md +0 -25
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md +0 -25
- package/docs/reference/README.md +0 -20
- package/docs/reference/classes/ACLUtils.md +0 -263
- package/docs/reference/classes/AdminRoute.md +0 -51
- package/docs/reference/classes/AuthMiddleware.md +0 -173
- package/docs/reference/classes/BackgroundService.md +0 -117
- package/docs/reference/classes/BackgroundServiceManager.md +0 -172
- package/docs/reference/classes/BaseEntity.md +0 -82
- package/docs/reference/classes/BaseMongoEntity.md +0 -107
- package/docs/reference/classes/BasicStrategy.md +0 -131
- package/docs/reference/classes/BasicStrategyOptions.md +0 -115
- package/docs/reference/classes/BulkError.md +0 -271
- package/docs/reference/classes/ConnectionManager.md +0 -75
- package/docs/reference/classes/EventListenerManager.md +0 -88
- package/docs/reference/classes/HttpRouter.md +0 -343
- package/docs/reference/classes/JWTStrategy.md +0 -100
- package/docs/reference/classes/JWTStrategyOptions.md +0 -97
- package/docs/reference/classes/MetricsRoute.md +0 -27
- package/docs/reference/classes/ModelRoute.md +0 -534
- package/docs/reference/classes/ModelUtils.md +0 -446
- package/docs/reference/classes/MongoConnection.md +0 -218
- package/docs/reference/classes/MongoRepository.md +0 -390
- package/docs/reference/classes/MongoSchemaSync.md +0 -97
- package/docs/reference/classes/NetUtils.md +0 -90
- package/docs/reference/classes/NotificationUtils.md +0 -77
- package/docs/reference/classes/ObjectFactory.md +0 -336
- package/docs/reference/classes/OpenAPIRoute.md +0 -77
- package/docs/reference/classes/OpenApiSpec.md +0 -892
- package/docs/reference/classes/RecoverableBaseEntity.md +0 -114
- package/docs/reference/classes/RecoverableBaseMongoEntity.md +0 -124
- package/docs/reference/classes/RedisTransport.md +0 -2202
- package/docs/reference/classes/RepoUtils.md +0 -482
- package/docs/reference/classes/RouteUtils.md +0 -191
- package/docs/reference/classes/Server.md +0 -408
- package/docs/reference/classes/SimpleEntity.md +0 -48
- package/docs/reference/classes/SimpleMongoEntity.md +0 -66
- package/docs/reference/classes/StatusExtraData.md +0 -57
- package/docs/reference/classes/StatusRoute.md +0 -26
- package/docs/reference/classes/UWSRequest.md +0 -226
- package/docs/reference/classes/UWSResponse.md +0 -257
- package/docs/reference/classes/UWSWebSocketShim.md +0 -958
- package/docs/reference/enumerations/ACLAction.md +0 -63
- package/docs/reference/enumerations/ApiErrorMessages.md +0 -123
- package/docs/reference/enumerations/ApiErrors.md +0 -123
- package/docs/reference/functions/createWebSocketStream.md +0 -27
- package/docs/reference/functions/isSqlDataSource.md +0 -26
- package/docs/reference/functions/readBody.md +0 -29
- package/docs/reference/functions/resolveCollectionName.md +0 -33
- package/docs/reference/functions/runChain.md +0 -40
- package/docs/reference/functions/snakeCase.md +0 -28
- package/docs/reference/globals.md +0 -106
- package/docs/reference/interfaces/ACLRecord.md +0 -96
- package/docs/reference/interfaces/AccessControlList.md +0 -76
- package/docs/reference/interfaces/AuthResult.md +0 -55
- package/docs/reference/interfaces/AuthStrategy.md +0 -95
- package/docs/reference/interfaces/CreateRequestOptions.md +0 -121
- package/docs/reference/interfaces/DeleteRequestOptions.md +0 -137
- package/docs/reference/interfaces/FindRequestOptions.md +0 -133
- package/docs/reference/interfaces/HttpRequest.md +0 -147
- package/docs/reference/interfaces/HttpResponse.md +0 -164
- package/docs/reference/interfaces/JWTAuthResult.md +0 -84
- package/docs/reference/interfaces/RepoCreateOptions.md +0 -95
- package/docs/reference/interfaces/RepoDeleteOptions.md +0 -105
- package/docs/reference/interfaces/RepoFindOptions.md +0 -125
- package/docs/reference/interfaces/RepoOperationOptions.md +0 -69
- package/docs/reference/interfaces/RepoUpdateOptions.md +0 -101
- package/docs/reference/interfaces/RequestOptions.md +0 -112
- package/docs/reference/interfaces/RequestWS.md +0 -225
- package/docs/reference/interfaces/TruncateRequestOptions.md +0 -161
- package/docs/reference/interfaces/UpdateRequestOptions.md +0 -139
- package/docs/reference/type-aliases/ErrorHandler.md +0 -35
- package/docs/reference/type-aliases/NextFunction.md +0 -23
- package/docs/reference/type-aliases/OneOrMany.md +0 -19
- package/docs/reference/type-aliases/OneOrNull.md +0 -19
- package/docs/reference/type-aliases/PartialBaseEntity.md +0 -17
- package/docs/reference/type-aliases/PartialSimpleEntity.md +0 -17
- package/docs/reference/type-aliases/RequestHandler.md +0 -31
- package/docs/reference/type-aliases/UpdateObject.md +0 -19
- package/docs/reference/type-aliases/WsUpgradeAuth.md +0 -27
- package/docs/reference/type-aliases/WsUpgradeAuthResult.md +0 -47
|
@@ -27,16 +27,19 @@ import { ModelRoute } from "./ModelRoute.js";
|
|
|
27
27
|
* is enabled these handlers will still validate permissions appropriately.
|
|
28
28
|
*
|
|
29
29
|
* Included Endpoints:
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
30
|
+
*
|
|
31
|
+
* | Name | HTTP Method | What it does |
|
|
32
|
+
* | --- | --- | --- |
|
|
33
|
+
* | `count` | `HEAD /` | Counts the number of objects matching the provided set of criteria in the request's query parameters. Returns the count as the value of the `Content-Length` header. |
|
|
34
|
+
* | `create` | `POST /` | Adds one or more new objects to the datastore. |
|
|
35
|
+
* | `delete` | `DELETE /:id` | Removes an existing object from the datastore. |
|
|
36
|
+
* | `exists` | `HEAD /:id` | Checks if the object with the given ID exists in the datastore. Sets `Content-Length` header to `1` if the object exists, otherwise `0`. |
|
|
37
|
+
* | `find` | `GET /` | Returns all objects matching the provided set of criteria in the request's query parameters. |
|
|
38
|
+
* | `findById` | `GET /:id` | Returns a single object with a specified unique identifier. |
|
|
39
|
+
* | `truncate` | `DELETE /` | Removes all objects from the datastore. |
|
|
40
|
+
* | `update` | `PUT /:id` | Modifies an existing object in the datastore. |
|
|
41
|
+
* | `updateBulk` | `PUT /` | Modifies multiple existing objects in the datastore. |
|
|
42
|
+
* | `updateProperty` | `PUT /:id/:property` | Modifies an single property of the given name of an existing object in the datastore. |
|
|
40
43
|
*
|
|
41
44
|
* @author Jean-Philippe Steinmetz
|
|
42
45
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CRUDRoute.js","sourceRoot":"","sources":["../../../src/routes/CRUDRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAKnD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AACzF,OAAO,EACH,MAAM,EACN,GAAG,EACH,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,GAAG,EACH,KAAK,EACL,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,QAAQ,GACX,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAgB,MAAM,iBAAiB,CAAC;AAE3D
|
|
1
|
+
{"version":3,"file":"CRUDRoute.js","sourceRoot":"","sources":["../../../src/routes/CRUDRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAKnD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AACzF,OAAO,EACH,MAAM,EACN,GAAG,EACH,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,GAAG,EACH,KAAK,EACL,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,QAAQ,GACX,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAgB,MAAM,iBAAiB,CAAC;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAgB,SAA+C,SAAQ,UAAa;IAA1F;;QACuB,mBAAc,GAAQ,SAAS,CAAC;IAiIvD,CAAC;IAxHgB,AAAN,KAAK,CAAC,KAAK,CACL,MAAW,EACX,KAAU,EACT,GAAiB,EACrB,IAAc;QAEpB,OAAO,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IACvD,CAAC;IAES,cAAc,CAAC,GAA8B,EAAQ,IAAc;QACzE,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAOM,MAAM,CAAC,GAAY,EAAW,GAAgB,EAAQ,IAAc;QACvE,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;IAMY,AAAN,KAAK,CAAC,MAAM,CACF,EAAU,EACL,OAA2B,EAC7B,KAAyB,EAChC,GAAgB,EACnB,IAAc;QAEpB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,KAAK,MAAM,EAAE,CAAC,CAAC;IAC/E,CAAC;IASY,AAAN,KAAK,CAAC,MAAM,CACF,EAAU,EACd,KAAU,EACT,GAAiB,EACrB,IAAc;QAEpB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IACpD,CAAC;IAMY,AAAN,KAAK,CAAC,IAAI,CAAU,MAAW,EAAW,KAAU,EAAQ,IAAc;QAC7E,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAMY,AAAN,KAAK,CAAC,QAAQ,CAAc,EAAU,EAAW,KAAU,EAAQ,IAAc;QACpF,OAAO,KAAK,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAMY,AAAN,KAAK,CAAC,QAAQ,CAAU,MAAW,EAAW,KAAU,EAAQ,IAAc;QACjF,OAAO,KAAK,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACrD,CAAC;IAEe,AAAN,KAAK,CAAC,cAAc,CAAc,EAAU,EAAE,GAAoB,EAAQ,IAAc;QAC9F,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACxC,CAAC;IAOY,AAAN,KAAK,CAAC,MAAM,CACF,EAAU,EACvB,GAAoB,EACX,GAAgB,EACnB,IAAc;QAEpB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEe,AAAN,KAAK,CAAC,kBAAkB,CAAC,IAAuB,EAAQ,IAAc;QAC5E,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;IAOY,AAAN,KAAK,CAAC,UAAU,CAAC,GAAsB,EAAW,GAAgB,EAAQ,IAAc;QAC3F,OAAO,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;IAClD,CAAC;IAOM,cAAc,CACJ,EAAU,EACJ,YAAoB,EACvC,GAAQ,EACF,IAAc;QAEpB,OAAO,KAAK,CAAC,gBAAgB,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACnE,CAAC;CACJ;AAxHgB;IAPZ,OAAO,CAAC,iBAAiB,CAAC;IAC1B,WAAW,CACR,oFAAoF;QAChF,oCAAoC,CAC3C;IACA,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACf,IAAI,EAAE;IAEF,WAAA,KAAK,EAAE,CAAA;IACP,WAAA,KAAK,EAAE,CAAA;IACP,WAAA,QAAQ,CAAA;IACR,WAAA,IAAI,CAAA;;;;sCAGR;AAES;IAAgD,WAAA,IAAI,CAAA;;;;+CAE7D;AAOM;IALN,OAAO,CAAC,qBAAqB,CAAC;IAC9B,WAAW,CAAC,yBAAyB,CAAC;IACtC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IACjB,IAAI,EAAE;IACN,QAAQ,CAAC,gBAAgB,CAAC;IACE,WAAA,OAAO,CAAA;IAAoB,WAAA,IAAI,CAAA;;;;uCAE3D;AAMY;IAJZ,OAAO,CAAC,uBAAuB,CAAC;IAChC,WAAW,CAAC,wCAAwC,CAAC;IACrD,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACf,MAAM,CAAC,MAAM,CAAC;IAEV,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IACX,WAAA,KAAK,CAAC,SAAS,CAAC,CAAA;IAChB,WAAA,KAAK,CAAC,OAAO,CAAC,CAAA;IACd,WAAA,OAAO,CAAA;IACP,WAAA,IAAI,CAAA;;;;uCAGR;AASY;IAPZ,OAAO,CAAC,QAAQ,CAAC;IACjB,WAAW,CACR,oFAAoF;QAChF,oCAAoC,CAC3C;IACA,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACf,IAAI,CAAC,MAAM,CAAC;IAER,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IACX,WAAA,KAAK,EAAE,CAAA;IACP,WAAA,QAAQ,CAAA;IACR,WAAA,IAAI,CAAA;;;;uCAGR;AAMY;IAJZ,OAAO,CAAC,qBAAqB,CAAC;IAC9B,WAAW,CAAC,qEAAqE,CAAC;IAClF,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1B,GAAG,EAAE;IACa,WAAA,KAAK,EAAE,CAAA;IAAe,WAAA,KAAK,EAAE,CAAA;IAAc,WAAA,IAAI,CAAA;;;;qCAEjE;AAMY;IAJZ,OAAO,CAAC,sBAAsB,CAAC;IAC/B,WAAW,CAAC,yEAAyE,CAAC;IACtF,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IACjB,GAAG,CAAC,MAAM,CAAC;IACW,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IAAc,WAAA,KAAK,EAAE,CAAA;IAAc,WAAA,IAAI,CAAA;;;;yCAExE;AAMY;IAJZ,OAAO,CAAC,qBAAqB,CAAC;IAC9B,WAAW,CAAC,wEAAwE,CAAC;IACrF,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACf,MAAM,EAAE;IACc,WAAA,KAAK,EAAE,CAAA;IAAe,WAAA,KAAK,EAAE,CAAA;IAAc,WAAA,IAAI,CAAA;;;;yCAErE;AAEe;IAAgB,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IAAoC,WAAA,IAAI,CAAA;;;;+CAElF;AAOY;IALZ,OAAO,CAAC,wBAAwB,CAAC;IACjC,WAAW,CAAC,6BAA6B,CAAC;IAC1C,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IACjB,GAAG,CAAC,MAAM,CAAC;IACX,QAAQ,CAAC,gBAAgB,CAAC;IAEtB,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IAEX,WAAA,OAAO,CAAA;IACP,WAAA,IAAI,CAAA;;;;uCAGR;AAEe;IAA6C,WAAA,IAAI,CAAA;;;;mDAEhE;AAOY;IALZ,OAAO,CAAC,2BAA2B,CAAC;IACpC,WAAW,CAAC,8CAA8C,CAAC;IAC3D,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1B,GAAG,EAAE;IACL,QAAQ,CAAC,oBAAoB,CAAC;IACkB,WAAA,OAAO,CAAA;IAAoB,WAAA,IAAI,CAAA;;;;2CAE/E;AAOM;IALN,OAAO,CAAC,qCAAqC,CAAC;IAC9C,GAAG,CAAC,eAAe,CAAC;IACpB,WAAW,CAAC,qDAAqD,CAAC;IAClE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;IAClB,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IAEb,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IACX,WAAA,KAAK,CAAC,UAAU,CAAC,CAAA;IAEjB,WAAA,IAAI,CAAA;;;;+CAGR"}
|
|
@@ -22,11 +22,19 @@ import { CRUDRoute } from "../routes/CRUDRoute.js";
|
|
|
22
22
|
*
|
|
23
23
|
* | Name | HTTP Method | What it does |
|
|
24
24
|
* | --- | --- | --- |
|
|
25
|
-
* | `
|
|
26
|
-
* | `
|
|
25
|
+
* | `count` | `HEAD /` | Counts the number of ACLs matching the provided set of criteria in the request's query parameters. Returns the count as the value of the `Content-Length` header. |
|
|
26
|
+
* | `create` | `POST /` | Adds one or more new ACLs to the datastore. |
|
|
27
|
+
* | `delete` | `DELETE /:id` | Removes an existing ACL from the datastore. |
|
|
28
|
+
* | `exists` | `HEAD /:id` | Checks if the ACL with the given ID exists in the datastore. Sets `Content-Length` header to `1` if the ACL exists, otherwise `0`. |
|
|
29
|
+
* | `find` | `GET /` | Returns all ACLs matching the provided set of criteria in the request's query parameters. |
|
|
30
|
+
* | `findById` | `GET /:id` | Returns a single ACL with a specified unique identifier. |
|
|
31
|
+
* | `truncate` | `DELETE /` | Removes all ACLs from the datastore. |
|
|
32
|
+
* | `update` | `PUT /:id` | Modifies an existing ACL in the datastore. |
|
|
33
|
+
* | `updateBulk` | `PUT /` | Modifies multiple existing ACLs in the datastore. |
|
|
34
|
+
* | `updateProperty` | `PUT /:id/:property` | Modifies an single property of the given name of an existing ACL in the datastore. |
|
|
27
35
|
*
|
|
28
36
|
* !!Note!! that the `BaseACLRoute` is not automatically registered with a server by default. You must create
|
|
29
|
-
* your own class that extends `
|
|
37
|
+
* your own class that extends `BaseACLRoute` and apply the desired base path with `@Route()`.
|
|
30
38
|
*
|
|
31
39
|
* @example
|
|
32
40
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseACLRoute.js","sourceRoot":"","sources":["../../../src/security/BaseACLRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,OAAO,EAAqB,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAW,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,kCAAkC,CAAC;AACjG,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD
|
|
1
|
+
{"version":3,"file":"BaseACLRoute.js","sourceRoot":"","sources":["../../../src/security/BaseACLRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,OAAO,EAAqB,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAW,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,kCAAkC,CAAC;AACjG,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,OAAgB,YAA0C,SAAQ,SAAY;IAChE,AAAN,KAAK,CAAC,UAAU,CAAU,MAAW,EAAQ,IAAa;QAChE,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,MAAM,IAAI,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,GAAG,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC5F,CAAC;QACD,IACI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC3D,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EACvF,CAAC;YACC,MAAM,IAAI,QAAQ,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QAChH,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACO,eAAe,CAAc,EAAU;QAC7C,IAAI,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,QAAQ,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QAChH,CAAC;IACL,CAAC;IAED;;;;OAIG;IACO,cAAc,CAAC,IAAuB,EAAQ,IAAa;QACjE,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,MAAM,IAAI,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,GAAG,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC5F,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,QAAQ,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QAChH,CAAC;QACD,IAAI,IAAI,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YACjE,MAAM,IAAI,QAAQ,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QAChH,CAAC;IACL,CAAC;IAGM,KAAK,CACC,MAAW,EACX,KAAU,EACT,GAAiB,EACrB,IAAc;QAEpB,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAGM,MAAM,CAAC,GAAY,EAAW,GAAgB,EAAQ,IAAc;QACvE,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAGM,MAAM,CACI,EAAU,EACL,OAA2B,EAC7B,KAAyB,EAChC,GAAgB,EACnB,IAAc;QAEpB,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAGM,MAAM,CACI,EAAU,EACd,KAAU,EACT,GAAiB,EACrB,IAAc;QAEpB,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAGM,IAAI,CAAU,MAAW,EAAW,KAAU,EAAQ,IAAc;QACvE,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAGY,AAAN,KAAK,CAAC,QAAQ,CAAc,EAAU,EAAW,KAAU,EAAQ,IAAc;QACpF,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAGM,QAAQ,CAAU,MAAW,EAAW,KAAU,EAAQ,IAAc;QAC3E,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAGM,MAAM,CACI,EAAU,EACvB,GAAoB,EACX,GAAgB,EACnB,IAAc;QAEpB,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAGM,cAAc,CACJ,EAAU,EACJ,YAAoB,EACvC,GAAQ,EACF,IAAc;QAEpB,OAAO,KAAK,CAAC,cAAc,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAGM,UAAU,CAAC,GAAsB,EAAW,GAAgB,EAAQ,IAAc;QACrF,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;CACJ;AApHmB;IAAY,WAAA,KAAK,EAAE,CAAA;IAAe,WAAA,IAAI,CAAA;;;;8CAUrD;AAQS;IAAiB,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;;;;mDAIrC;AAOS;IAAyC,WAAA,IAAI,CAAA;;;;kDAUtD;AAGM;IADN,MAAM,CAAC,YAAY,CAAC;IAEhB,WAAA,KAAK,EAAE,CAAA;IACP,WAAA,KAAK,EAAE,CAAA;IACP,WAAA,QAAQ,CAAA;IACR,WAAA,IAAI,CAAA;;;;yCAGR;AAGM;IADN,MAAM,CAAC,YAAY,CAAC;IACQ,WAAA,OAAO,CAAA;IAAoB,WAAA,IAAI,CAAA;;;;0CAE3D;AAGM;IADN,MAAM,CAAC,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IAErC,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IACX,WAAA,KAAK,CAAC,SAAS,CAAC,CAAA;IAChB,WAAA,KAAK,CAAC,OAAO,CAAC,CAAA;IACd,WAAA,OAAO,CAAA;IACP,WAAA,IAAI,CAAA;;;;0CAGR;AAGM;IADN,MAAM,CAAC,YAAY,CAAC;IAEhB,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IACX,WAAA,KAAK,EAAE,CAAA;IACP,WAAA,QAAQ,CAAA;IACR,WAAA,IAAI,CAAA;;;;0CAGR;AAGM;IADN,MAAM,CAAC,YAAY,CAAC;IACR,WAAA,KAAK,EAAE,CAAA;IAAe,WAAA,KAAK,EAAE,CAAA;IAAc,WAAA,IAAI,CAAA;;;;wCAE3D;AAGY;IADZ,MAAM,CAAC,YAAY,CAAC;IACE,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IAAc,WAAA,KAAK,EAAE,CAAA;IAAc,WAAA,IAAI,CAAA;;;;4CAExE;AAGM;IADN,MAAM,CAAC,YAAY,CAAC;IACJ,WAAA,KAAK,EAAE,CAAA;IAAe,WAAA,KAAK,EAAE,CAAA;IAAc,WAAA,IAAI,CAAA;;;;4CAE/D;AAGM;IADN,MAAM,CAAC,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IAErC,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IAEX,WAAA,OAAO,CAAA;IACP,WAAA,IAAI,CAAA;;;;0CAGR;AAGM;IADN,MAAM,CAAC,YAAY,CAAC;IAEhB,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IACX,WAAA,KAAK,CAAC,UAAU,CAAC,CAAA;IAEjB,WAAA,IAAI,CAAA;;;;kDAGR;AAGM;IADN,MAAM,CAAC,gBAAgB,CAAC;IACkB,WAAA,OAAO,CAAA;IAAoB,WAAA,IAAI,CAAA;;;;8CAEzE"}
|
|
@@ -13,16 +13,19 @@ import { ModelRoute, UpdateObject } from "./ModelRoute.js";
|
|
|
13
13
|
* is enabled these handlers will still validate permissions appropriately.
|
|
14
14
|
*
|
|
15
15
|
* Included Endpoints:
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
16
|
+
*
|
|
17
|
+
* | Name | HTTP Method | What it does |
|
|
18
|
+
* | --- | --- | --- |
|
|
19
|
+
* | `count` | `HEAD /` | Counts the number of objects matching the provided set of criteria in the request's query parameters. Returns the count as the value of the `Content-Length` header. |
|
|
20
|
+
* | `create` | `POST /` | Adds one or more new objects to the datastore. |
|
|
21
|
+
* | `delete` | `DELETE /:id` | Removes an existing object from the datastore. |
|
|
22
|
+
* | `exists` | `HEAD /:id` | Checks if the object with the given ID exists in the datastore. Sets `Content-Length` header to `1` if the object exists, otherwise `0`. |
|
|
23
|
+
* | `find` | `GET /` | Returns all objects matching the provided set of criteria in the request's query parameters. |
|
|
24
|
+
* | `findById` | `GET /:id` | Returns a single object with a specified unique identifier. |
|
|
25
|
+
* | `truncate` | `DELETE /` | Removes all objects from the datastore. |
|
|
26
|
+
* | `update` | `PUT /:id` | Modifies an existing object in the datastore. |
|
|
27
|
+
* | `updateBulk` | `PUT /` | Modifies multiple existing objects in the datastore. |
|
|
28
|
+
* | `updateProperty` | `PUT /:id/:property` | Modifies an single property of the given name of an existing object in the datastore. |
|
|
26
29
|
*
|
|
27
30
|
* @author Jean-Philippe Steinmetz
|
|
28
31
|
*/
|
|
@@ -10,11 +10,19 @@ import { CRUDRoute } from "../routes/CRUDRoute.js";
|
|
|
10
10
|
*
|
|
11
11
|
* | Name | HTTP Method | What it does |
|
|
12
12
|
* | --- | --- | --- |
|
|
13
|
-
* | `
|
|
14
|
-
* | `
|
|
13
|
+
* | `count` | `HEAD /` | Counts the number of ACLs matching the provided set of criteria in the request's query parameters. Returns the count as the value of the `Content-Length` header. |
|
|
14
|
+
* | `create` | `POST /` | Adds one or more new ACLs to the datastore. |
|
|
15
|
+
* | `delete` | `DELETE /:id` | Removes an existing ACL from the datastore. |
|
|
16
|
+
* | `exists` | `HEAD /:id` | Checks if the ACL with the given ID exists in the datastore. Sets `Content-Length` header to `1` if the ACL exists, otherwise `0`. |
|
|
17
|
+
* | `find` | `GET /` | Returns all ACLs matching the provided set of criteria in the request's query parameters. |
|
|
18
|
+
* | `findById` | `GET /:id` | Returns a single ACL with a specified unique identifier. |
|
|
19
|
+
* | `truncate` | `DELETE /` | Removes all ACLs from the datastore. |
|
|
20
|
+
* | `update` | `PUT /:id` | Modifies an existing ACL in the datastore. |
|
|
21
|
+
* | `updateBulk` | `PUT /` | Modifies multiple existing ACLs in the datastore. |
|
|
22
|
+
* | `updateProperty` | `PUT /:id/:property` | Modifies an single property of the given name of an existing ACL in the datastore. |
|
|
15
23
|
*
|
|
16
24
|
* !!Note!! that the `BaseACLRoute` is not automatically registered with a server by default. You must create
|
|
17
|
-
* your own class that extends `
|
|
25
|
+
* your own class that extends `BaseACLRoute` and apply the desired base path with `@Route()`.
|
|
18
26
|
*
|
|
19
27
|
* @example
|
|
20
28
|
* ```ts
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rapidrest/service-core",
|
|
3
|
-
"version": "1.0.0-rc.
|
|
3
|
+
"version": "1.0.0-rc.16",
|
|
4
4
|
"description": "Provides all core functionality for RapidREST based backend services.",
|
|
5
5
|
"repository": "https://github.com/rapidrest/service-core.git",
|
|
6
6
|
"author": "RapidREST <rapidrests@gmail.com>",
|
|
@@ -12,8 +12,6 @@
|
|
|
12
12
|
],
|
|
13
13
|
"scripts": {
|
|
14
14
|
"build": "yarn lint && rimraf dist && tsc",
|
|
15
|
-
"deploy-docs": "ts-node tools/gh-pages-publish",
|
|
16
|
-
"docs": "typedoc --plugin typedoc-plugin-markdown --out docs/reference src",
|
|
17
15
|
"lint": "eslint ./src ./test",
|
|
18
16
|
"local-audit": "yarn install && yarn npm audit -A -R \"$@\"",
|
|
19
17
|
"checkup": "yarn dlx @yarnpkg/doctor \"$@\"",
|
package/docs/Makefile
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# Minimal makefile for Sphinx documentation
|
|
2
|
-
#
|
|
3
|
-
|
|
4
|
-
# You can set these variables from the command line, and also
|
|
5
|
-
# from the environment for the first two.
|
|
6
|
-
SPHINXOPTS ?=
|
|
7
|
-
SPHINXBUILD ?= sphinx-build
|
|
8
|
-
SOURCEDIR = .
|
|
9
|
-
BUILDDIR = _build
|
|
10
|
-
|
|
11
|
-
# Put it first so that "make" without argument is like "make help".
|
|
12
|
-
help:
|
|
13
|
-
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
14
|
-
|
|
15
|
-
.PHONY: help Makefile
|
|
16
|
-
|
|
17
|
-
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
18
|
-
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
19
|
-
%: Makefile
|
|
20
|
-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
package/docs/conf.py
DELETED
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
# Configuration file for the Sphinx documentation builder.
|
|
2
|
-
#
|
|
3
|
-
# This file only contains a selection of the most common options. For a full
|
|
4
|
-
# list see the documentation:
|
|
5
|
-
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
6
|
-
|
|
7
|
-
# -- Path setup --------------------------------------------------------------
|
|
8
|
-
|
|
9
|
-
# If extensions (or modules to document with autodoc) are in another directory,
|
|
10
|
-
# add these directories to sys.path here. If the directory is relative to the
|
|
11
|
-
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
12
|
-
#
|
|
13
|
-
# import os
|
|
14
|
-
# import sys
|
|
15
|
-
# sys.path.insert(0, os.path.abspath('.'))
|
|
16
|
-
import recommonmark
|
|
17
|
-
from recommonmark.transform import AutoStructify
|
|
18
|
-
|
|
19
|
-
source_suffix = ['.rst', '.md']
|
|
20
|
-
|
|
21
|
-
# -- Project information -----------------------------------------------------
|
|
22
|
-
|
|
23
|
-
project = 'Core Library'
|
|
24
|
-
copyright = 'RapidREST All rights reserved.'
|
|
25
|
-
author = 'RapidREST'
|
|
26
|
-
|
|
27
|
-
# -- General configuration ---------------------------------------------------
|
|
28
|
-
|
|
29
|
-
# Add any Sphinx extension module names here, as strings. They can be
|
|
30
|
-
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
31
|
-
# ones.
|
|
32
|
-
extensions = [
|
|
33
|
-
'recommonmark',
|
|
34
|
-
'sphinx.ext.autodoc',
|
|
35
|
-
]
|
|
36
|
-
|
|
37
|
-
# List of patterns, relative to source directory, that match files and
|
|
38
|
-
# directories to ignore when looking for source files.
|
|
39
|
-
# This pattern also affects html_static_path and html_extra_path.
|
|
40
|
-
exclude_patterns = []
|
|
41
|
-
|
|
42
|
-
master_doc = 'index'
|
|
43
|
-
|
|
44
|
-
# Add any paths that contain custom static files (such as style sheets) here,
|
|
45
|
-
# relative to this directory. They are copied after the builtin static files,
|
|
46
|
-
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
47
|
-
html_static_path = ['_static']
|
|
48
|
-
|
|
49
|
-
# app setup hook
|
|
50
|
-
def setup(app):
|
|
51
|
-
app.add_config_value('recommonmark_config', {
|
|
52
|
-
'auto_toc_tree_section': 'Contents',
|
|
53
|
-
'enable_math': False,
|
|
54
|
-
'enable_inline_math': False,
|
|
55
|
-
'enable_eval_rst': True,
|
|
56
|
-
'enable_auto_doc_ref': True,
|
|
57
|
-
}, True)
|
|
58
|
-
app.add_transform(AutoStructify)
|
package/docs/index.rst
DELETED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
===============================================================================
|
|
2
|
-
Services Core Library
|
|
3
|
-
===============================================================================
|
|
4
|
-
|
|
5
|
-
Repository: ``git clone https://github.com/rapidrest/service-core.git``
|
|
6
|
-
|
|
7
|
-
Provides all core functionality for RapidREST based backend services.
|
|
8
|
-
|
|
9
|
-
.. toctree::
|
|
10
|
-
:caption: Project Info
|
|
11
|
-
|
|
12
|
-
reference/README
|
|
13
|
-
|
|
14
|
-
.. toctree::
|
|
15
|
-
:caption: API Reference
|
|
16
|
-
|
|
17
|
-
reference/globals
|
package/docs/make.bat
DELETED
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
@ECHO OFF
|
|
2
|
-
|
|
3
|
-
pushd %~dp0
|
|
4
|
-
|
|
5
|
-
REM Command file for Sphinx documentation
|
|
6
|
-
|
|
7
|
-
if "%SPHINXBUILD%" == "" (
|
|
8
|
-
set SPHINXBUILD=sphinx-build
|
|
9
|
-
)
|
|
10
|
-
set SOURCEDIR=.
|
|
11
|
-
set BUILDDIR=_build
|
|
12
|
-
|
|
13
|
-
if "%1" == "" goto help
|
|
14
|
-
|
|
15
|
-
%SPHINXBUILD% >NUL 2>NUL
|
|
16
|
-
if errorlevel 9009 (
|
|
17
|
-
echo.
|
|
18
|
-
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
|
19
|
-
echo.installed, then set the SPHINXBUILD environment variable to point
|
|
20
|
-
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
|
21
|
-
echo.may add the Sphinx directory to PATH.
|
|
22
|
-
echo.
|
|
23
|
-
echo.If you don't have Sphinx installed, grab it from
|
|
24
|
-
echo.http://sphinx-doc.org/
|
|
25
|
-
exit /b 1
|
|
26
|
-
)
|
|
27
|
-
|
|
28
|
-
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
29
|
-
goto end
|
|
30
|
-
|
|
31
|
-
:help
|
|
32
|
-
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
33
|
-
|
|
34
|
-
:end
|
|
35
|
-
popd
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../globals.md) / DatabaseDecorators
|
|
6
|
-
|
|
7
|
-
# DatabaseDecorators
|
|
8
|
-
|
|
9
|
-
## Functions
|
|
10
|
-
|
|
11
|
-
- [MongoRepository](functions/MongoRepository.md)
|
|
12
|
-
- [RedisConnection](functions/RedisConnection.md)
|
|
13
|
-
- [Repository](functions/Repository.md)
|
package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../../globals.md) / [DatabaseDecorators](../README.md) / MongoRepository
|
|
6
|
-
|
|
7
|
-
# Function: MongoRepository()
|
|
8
|
-
|
|
9
|
-
> **MongoRepository**(`type`): (`target`, `propertyKey`) => `void`
|
|
10
|
-
|
|
11
|
-
Defined in: [src/decorators/DatabaseDecorators.ts:10](https://github.com/rapidrest/service-core/blob/c7e3b662fbab3a8018f8efc7ffae5fdf8bc663ac/src/decorators/DatabaseDecorators.ts#L10)
|
|
12
|
-
|
|
13
|
-
Apply this to a property to have the TypeORM `MongoRepository` for the given entity type injected at instantiation.
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### type
|
|
18
|
-
|
|
19
|
-
`any`
|
|
20
|
-
|
|
21
|
-
The entity type whose repository will be injected.
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
(`target`, `propertyKey`) => `void`
|
package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../../globals.md) / [DatabaseDecorators](../README.md) / RedisConnection
|
|
6
|
-
|
|
7
|
-
# Function: RedisConnection()
|
|
8
|
-
|
|
9
|
-
> **RedisConnection**(`name`): (`target`, `propertyKey`) => `void`
|
|
10
|
-
|
|
11
|
-
Defined in: [src/decorators/DatabaseDecorators.ts:44](https://github.com/rapidrest/service-core/blob/c7e3b662fbab3a8018f8efc7ffae5fdf8bc663ac/src/decorators/DatabaseDecorators.ts#L44)
|
|
12
|
-
|
|
13
|
-
Apply this to a property to have the `Redis` connection injected at instantiation.
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### name
|
|
18
|
-
|
|
19
|
-
`string`
|
|
20
|
-
|
|
21
|
-
The name of the database connection to inject.
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
(`target`, `propertyKey`) => `void`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../../globals.md) / [DatabaseDecorators](../README.md) / Repository
|
|
6
|
-
|
|
7
|
-
# Function: Repository()
|
|
8
|
-
|
|
9
|
-
> **Repository**(`type`): (`target`, `propertyKey`) => `void`
|
|
10
|
-
|
|
11
|
-
Defined in: [src/decorators/DatabaseDecorators.ts:27](https://github.com/rapidrest/service-core/blob/c7e3b662fbab3a8018f8efc7ffae5fdf8bc663ac/src/decorators/DatabaseDecorators.ts#L27)
|
|
12
|
-
|
|
13
|
-
Apply this to a property to have the TypeORM `Repository` for the given entity type injected at instantiation.
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### type
|
|
18
|
-
|
|
19
|
-
`any`
|
|
20
|
-
|
|
21
|
-
The entity type whose repository will be injected.
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
(`target`, `propertyKey`) => `void`
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../globals.md) / DocDecorators
|
|
6
|
-
|
|
7
|
-
# DocDecorators
|
|
8
|
-
|
|
9
|
-
## Interfaces
|
|
10
|
-
|
|
11
|
-
- [DocumentsData](interfaces/DocumentsData.md)
|
|
12
|
-
|
|
13
|
-
## Functions
|
|
14
|
-
|
|
15
|
-
- [Default](functions/Default.md)
|
|
16
|
-
- [Description](functions/Description.md)
|
|
17
|
-
- [Document](functions/Document.md)
|
|
18
|
-
- [Example](functions/Example.md)
|
|
19
|
-
- [Format](functions/Format.md)
|
|
20
|
-
- [Returns](functions/Returns.md)
|
|
21
|
-
- [Summary](functions/Summary.md)
|
|
22
|
-
- [Tags](functions/Tags.md)
|
|
23
|
-
- [TypeInfo](functions/TypeInfo.md)
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Default
|
|
6
|
-
|
|
7
|
-
# Function: Default()
|
|
8
|
-
|
|
9
|
-
> **Default**(`value`): (`target`, `propertyKey?`) => `void`
|
|
10
|
-
|
|
11
|
-
Defined in: [src/decorators/DocDecorators.ts:40](https://github.com/rapidrest/service-core/blob/c7e3b662fbab3a8018f8efc7ffae5fdf8bc663ac/src/decorators/DocDecorators.ts#L40)
|
|
12
|
-
|
|
13
|
-
Provides a default value for property of a class.
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### value
|
|
18
|
-
|
|
19
|
-
`string`
|
|
20
|
-
|
|
21
|
-
The default value.
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
(`target`, `propertyKey?`) => `void`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Description
|
|
6
|
-
|
|
7
|
-
# Function: Description()
|
|
8
|
-
|
|
9
|
-
> **Description**(`value`): (`target`, `propertyKey?`) => `void`
|
|
10
|
-
|
|
11
|
-
Defined in: [src/decorators/DocDecorators.ts:51](https://github.com/rapidrest/service-core/blob/c7e3b662fbab3a8018f8efc7ffae5fdf8bc663ac/src/decorators/DocDecorators.ts#L51)
|
|
12
|
-
|
|
13
|
-
Provides a detailed describing the class, property or function.
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### value
|
|
18
|
-
|
|
19
|
-
`string`
|
|
20
|
-
|
|
21
|
-
The description of the class, property or function.
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
(`target`, `propertyKey?`) => `void`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Document
|
|
6
|
-
|
|
7
|
-
# Function: Document()
|
|
8
|
-
|
|
9
|
-
> **Document**(`value`): (`target`, `propertyKey?`) => `void`
|
|
10
|
-
|
|
11
|
-
Defined in: [src/decorators/DocDecorators.ts:20](https://github.com/rapidrest/service-core/blob/c7e3b662fbab3a8018f8efc7ffae5fdf8bc663ac/src/decorators/DocDecorators.ts#L20)
|
|
12
|
-
|
|
13
|
-
Provides a set of documentation data for a given class, property or function.
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### value
|
|
18
|
-
|
|
19
|
-
[`DocumentsData`](../interfaces/DocumentsData.md)
|
|
20
|
-
|
|
21
|
-
The default value.
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
(`target`, `propertyKey?`) => `void`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Example
|
|
6
|
-
|
|
7
|
-
# Function: Example()
|
|
8
|
-
|
|
9
|
-
> **Example**(`value`): (`target`, `propertyKey?`) => `void`
|
|
10
|
-
|
|
11
|
-
Defined in: [src/decorators/DocDecorators.ts:62](https://github.com/rapidrest/service-core/blob/c7e3b662fbab3a8018f8efc7ffae5fdf8bc663ac/src/decorators/DocDecorators.ts#L62)
|
|
12
|
-
|
|
13
|
-
Provides a example representation of the property or function return value.
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### value
|
|
18
|
-
|
|
19
|
-
`any`
|
|
20
|
-
|
|
21
|
-
The example value.
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
(`target`, `propertyKey?`) => `void`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Format
|
|
6
|
-
|
|
7
|
-
# Function: Format()
|
|
8
|
-
|
|
9
|
-
> **Format**(`value`): (`target`, `propertyKey?`) => `void`
|
|
10
|
-
|
|
11
|
-
Defined in: [src/decorators/DocDecorators.ts:73](https://github.com/rapidrest/service-core/blob/c7e3b662fbab3a8018f8efc7ffae5fdf8bc663ac/src/decorators/DocDecorators.ts#L73)
|
|
12
|
-
|
|
13
|
-
Describes the underlying format of a class's property.
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### value
|
|
18
|
-
|
|
19
|
-
`string`
|
|
20
|
-
|
|
21
|
-
The format of the property's property.
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
(`target`, `propertyKey?`) => `void`
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Returns
|
|
6
|
-
|
|
7
|
-
# Function: Returns()
|
|
8
|
-
|
|
9
|
-
> **Returns**(`types?`): (`target`, `propertyKey`) => `void`
|
|
10
|
-
|
|
11
|
-
Defined in: [src/decorators/DocDecorators.ts:109](https://github.com/rapidrest/service-core/blob/c7e3b662fbab3a8018f8efc7ffae5fdf8bc663ac/src/decorators/DocDecorators.ts#L109)
|
|
12
|
-
|
|
13
|
-
Stores runtime metadata about the typing information of a function's return value.
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### types?
|
|
18
|
-
|
|
19
|
-
`any`
|
|
20
|
-
|
|
21
|
-
The optional return type(s) of the function. Can represent a single type (e.g. `MyClass`) or a union
|
|
22
|
-
of types (e.g. `string | number | null`). When describing a generic type such as a collection this
|
|
23
|
-
should be encoded as an array with the templated type as additional elements (e.g. `Array<MyClass>`
|
|
24
|
-
becomes `[[Array, MyClass]]`).
|
|
25
|
-
|
|
26
|
-
## Returns
|
|
27
|
-
|
|
28
|
-
(`target`, `propertyKey`) => `void`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@rapidrest/service-core**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Summary
|
|
6
|
-
|
|
7
|
-
# Function: Summary()
|
|
8
|
-
|
|
9
|
-
> **Summary**(`value`): (`target`, `propertyKey?`) => `void`
|
|
10
|
-
|
|
11
|
-
Defined in: [src/decorators/DocDecorators.ts:84](https://github.com/rapidrest/service-core/blob/c7e3b662fbab3a8018f8efc7ffae5fdf8bc663ac/src/decorators/DocDecorators.ts#L84)
|
|
12
|
-
|
|
13
|
-
Provides a brief summary about the class, property or function.
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### value
|
|
18
|
-
|
|
19
|
-
`string`
|
|
20
|
-
|
|
21
|
-
The summary of the class, property or function.
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
(`target`, `propertyKey?`) => `void`
|