@rapidrest/service-core 1.0.0-rc.7 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (380) hide show
  1. package/LICENSE +382 -23
  2. package/README.md +79 -5
  3. package/dist/lib/ApiErrors.js +10 -0
  4. package/dist/lib/ApiErrors.js.map +1 -1
  5. package/dist/lib/BackgroundService.js +1 -4
  6. package/dist/lib/BackgroundService.js.map +1 -1
  7. package/dist/lib/BackgroundServiceManager.js +47 -6
  8. package/dist/lib/BackgroundServiceManager.js.map +1 -1
  9. package/dist/lib/BulkError.js +4 -0
  10. package/dist/lib/BulkError.js.map +1 -1
  11. package/dist/lib/EventListenerManager.js +53 -18
  12. package/dist/lib/EventListenerManager.js.map +1 -1
  13. package/dist/lib/NetUtils.js +1 -0
  14. package/dist/lib/NetUtils.js.map +1 -1
  15. package/dist/lib/NotificationUtils.js +27 -8
  16. package/dist/lib/NotificationUtils.js.map +1 -1
  17. package/dist/lib/ObjectFactory.js +25 -44
  18. package/dist/lib/ObjectFactory.js.map +1 -1
  19. package/dist/lib/OpenApiSpec.js +31 -11
  20. package/dist/lib/OpenApiSpec.js.map +1 -1
  21. package/dist/lib/Server.js +74 -110
  22. package/dist/lib/Server.js.map +1 -1
  23. package/dist/lib/auth/AuthMiddleware.js +11 -16
  24. package/dist/lib/auth/AuthMiddleware.js.map +1 -1
  25. package/dist/lib/auth/JWTStrategy.js +68 -17
  26. package/dist/lib/auth/JWTStrategy.js.map +1 -1
  27. package/dist/lib/auth/index.js +0 -1
  28. package/dist/lib/auth/index.js.map +1 -1
  29. package/dist/lib/database/ConnectionKinds.js +15 -0
  30. package/dist/lib/database/ConnectionKinds.js.map +1 -1
  31. package/dist/lib/database/ConnectionManager.js +140 -61
  32. package/dist/lib/database/ConnectionManager.js.map +1 -1
  33. package/dist/lib/database/MongoConnection.js +13 -3
  34. package/dist/lib/database/MongoConnection.js.map +1 -1
  35. package/dist/lib/database/MongoRepository.js +61 -15
  36. package/dist/lib/database/MongoRepository.js.map +1 -1
  37. package/dist/lib/database/MongoSchemaSync.js +3 -3
  38. package/dist/lib/database/MongoSchemaSync.js.map +1 -1
  39. package/dist/lib/database/NamingUtils.js +3 -2
  40. package/dist/lib/database/NamingUtils.js.map +1 -1
  41. package/dist/lib/database/RedisCache.js +64 -0
  42. package/dist/lib/database/RedisCache.js.map +1 -0
  43. package/dist/lib/database/TypeOrmSupport.js +53 -13
  44. package/dist/lib/database/TypeOrmSupport.js.map +1 -1
  45. package/dist/lib/database/index.js +1 -0
  46. package/dist/lib/database/index.js.map +1 -1
  47. package/dist/lib/decorators/DatabaseDecorators.js +264 -20
  48. package/dist/lib/decorators/DatabaseDecorators.js.map +1 -1
  49. package/dist/lib/decorators/DocDecorators.js +30 -9
  50. package/dist/lib/decorators/DocDecorators.js.map +1 -1
  51. package/dist/lib/decorators/EventDecorators.js +1 -0
  52. package/dist/lib/decorators/EventDecorators.js.map +1 -1
  53. package/dist/lib/decorators/ModelDecorators.js +39 -23
  54. package/dist/lib/decorators/ModelDecorators.js.map +1 -1
  55. package/dist/lib/decorators/PersistenceDecorators.js +4 -3
  56. package/dist/lib/decorators/PersistenceDecorators.js.map +1 -1
  57. package/dist/lib/decorators/RouteDecorators.js +139 -36
  58. package/dist/lib/decorators/RouteDecorators.js.map +1 -1
  59. package/dist/lib/http/IWebSocketShim.js +2 -0
  60. package/dist/lib/http/IWebSocketShim.js.map +1 -0
  61. package/dist/lib/http/MiddlewareChain.js +167 -0
  62. package/dist/lib/http/MiddlewareChain.js.map +1 -0
  63. package/dist/lib/http/RuntimeDetect.js +9 -0
  64. package/dist/lib/http/RuntimeDetect.js.map +1 -0
  65. package/dist/lib/http/bun/BunAdapters.js +326 -0
  66. package/dist/lib/http/bun/BunAdapters.js.map +1 -0
  67. package/dist/lib/http/bun/BunRouter.js +391 -0
  68. package/dist/lib/http/bun/BunRouter.js.map +1 -0
  69. package/dist/lib/http/bun/BunWebSocket.js +49 -0
  70. package/dist/lib/http/bun/BunWebSocket.js.map +1 -0
  71. package/dist/lib/http/index.js +16 -3
  72. package/dist/lib/http/index.js.map +1 -1
  73. package/dist/lib/http/session/RedisSessionStore.js +30 -0
  74. package/dist/lib/http/session/RedisSessionStore.js.map +1 -0
  75. package/dist/lib/http/session/SessionManager.js +113 -0
  76. package/dist/lib/http/session/SessionManager.js.map +1 -0
  77. package/dist/lib/http/session/SessionStore.js +6 -0
  78. package/dist/lib/http/session/SessionStore.js.map +1 -0
  79. package/dist/lib/http/session/sessionMiddleware.js +42 -0
  80. package/dist/lib/http/session/sessionMiddleware.js.map +1 -0
  81. package/dist/lib/http/types.js +0 -3
  82. package/dist/lib/http/types.js.map +1 -1
  83. package/dist/lib/http/uWS/Adapters.js +421 -0
  84. package/dist/lib/http/uWS/Adapters.js.map +1 -0
  85. package/dist/lib/http/{Router.js → uWS/Router.js} +73 -173
  86. package/dist/lib/http/uWS/Router.js.map +1 -0
  87. package/dist/lib/http/{WebSocket.js → uWS/WebSocket.js} +4 -1
  88. package/dist/lib/http/uWS/WebSocket.js.map +1 -0
  89. package/dist/lib/models/BaseEntity.js +2 -1
  90. package/dist/lib/models/BaseEntity.js.map +1 -1
  91. package/dist/lib/models/BaseMongoEntity.js +2 -2
  92. package/dist/lib/models/BaseMongoEntity.js.map +1 -1
  93. package/dist/lib/models/ModelUtils.js +248 -101
  94. package/dist/lib/models/ModelUtils.js.map +1 -1
  95. package/dist/lib/models/RecoverableBaseEntity.js +6 -1
  96. package/dist/lib/models/RecoverableBaseEntity.js.map +1 -1
  97. package/dist/lib/models/RecoverableBaseMongoEntity.js +1 -0
  98. package/dist/lib/models/RecoverableBaseMongoEntity.js.map +1 -1
  99. package/dist/lib/models/RepoUtils.js +641 -203
  100. package/dist/lib/models/RepoUtils.js.map +1 -1
  101. package/dist/lib/models/SimpleEntity.js +1 -0
  102. package/dist/lib/models/SimpleEntity.js.map +1 -1
  103. package/dist/lib/models/SimpleMongoEntity.js +2 -1
  104. package/dist/lib/models/SimpleMongoEntity.js.map +1 -1
  105. package/dist/lib/models/StatusExtraData.js +4 -0
  106. package/dist/lib/models/StatusExtraData.js.map +1 -1
  107. package/dist/lib/routes/{AdminRoute.js → BaseAdminRoute.js} +98 -80
  108. package/dist/lib/routes/BaseAdminRoute.js.map +1 -0
  109. package/dist/lib/routes/{MetricsRoute.js → BaseMetricsRoute.js} +29 -15
  110. package/dist/lib/routes/BaseMetricsRoute.js.map +1 -0
  111. package/dist/lib/routes/{OpenAPIRoute.js → BaseOpenAPIRoute.js} +32 -32
  112. package/dist/lib/routes/BaseOpenAPIRoute.js.map +1 -0
  113. package/dist/lib/routes/BasePushRoute.js +305 -0
  114. package/dist/lib/routes/BasePushRoute.js.map +1 -0
  115. package/dist/lib/routes/BaseStaticRoute.js +153 -0
  116. package/dist/lib/routes/BaseStaticRoute.js.map +1 -0
  117. package/dist/lib/routes/BaseStatusRoute.js +80 -0
  118. package/dist/lib/routes/BaseStatusRoute.js.map +1 -0
  119. package/dist/lib/routes/CRUDRoute.js +284 -0
  120. package/dist/lib/routes/CRUDRoute.js.map +1 -0
  121. package/dist/lib/routes/ModelRoute.js +84 -57
  122. package/dist/lib/routes/ModelRoute.js.map +1 -1
  123. package/dist/lib/routes/RouteUtils.js +108 -20
  124. package/dist/lib/routes/RouteUtils.js.map +1 -1
  125. package/dist/lib/routes/index.js +7 -4
  126. package/dist/lib/routes/index.js.map +1 -1
  127. package/dist/lib/security/ACLUtils.js +297 -170
  128. package/dist/lib/security/ACLUtils.js.map +1 -1
  129. package/dist/lib/security/AccessControlList.js +18 -10
  130. package/dist/lib/security/AccessControlList.js.map +1 -1
  131. package/dist/lib/security/AccessControlListMongo.js +19 -68
  132. package/dist/lib/security/AccessControlListMongo.js.map +1 -1
  133. package/dist/lib/security/AccessControlListSQL.js +21 -70
  134. package/dist/lib/security/AccessControlListSQL.js.map +1 -1
  135. package/dist/lib/security/BaseACLRoute.js +239 -0
  136. package/dist/lib/security/BaseACLRoute.js.map +1 -0
  137. package/dist/lib/security/index.js +3 -0
  138. package/dist/lib/security/index.js.map +1 -1
  139. package/dist/lib/test/request.js +62 -5
  140. package/dist/lib/test/request.js.map +1 -1
  141. package/dist/lib/test/requestws.js +34 -10
  142. package/dist/lib/test/requestws.js.map +1 -1
  143. package/dist/types/ApiErrors.d.ts +8 -2
  144. package/dist/types/BackgroundService.d.ts +0 -5
  145. package/dist/types/BackgroundServiceManager.d.ts +2 -1
  146. package/dist/types/EventListenerManager.d.ts +7 -6
  147. package/dist/types/NotificationUtils.d.ts +5 -3
  148. package/dist/types/OpenApiSpec.d.ts +2 -2
  149. package/dist/types/Server.d.ts +28 -10
  150. package/dist/types/auth/AuthMiddleware.d.ts +3 -3
  151. package/dist/types/auth/AuthStrategy.d.ts +10 -7
  152. package/dist/types/auth/JWTStrategy.d.ts +6 -4
  153. package/dist/types/auth/index.d.ts +0 -1
  154. package/dist/types/database/ConnectionKinds.d.ts +7 -0
  155. package/dist/types/database/ConnectionManager.d.ts +29 -4
  156. package/dist/types/database/MongoConnection.d.ts +16 -4
  157. package/dist/types/database/MongoRepository.d.ts +32 -11
  158. package/dist/types/database/RedisCache.d.ts +23 -0
  159. package/dist/types/database/TypeOrmSupport.d.ts +4 -4
  160. package/dist/types/database/index.d.ts +1 -0
  161. package/dist/types/decorators/DatabaseDecorators.d.ts +139 -8
  162. package/dist/types/decorators/DocDecorators.d.ts +11 -2
  163. package/dist/types/decorators/ModelDecorators.d.ts +12 -5
  164. package/dist/types/decorators/PersistenceDecorators.d.ts +11 -4
  165. package/dist/types/decorators/RouteDecorators.d.ts +36 -6
  166. package/dist/types/http/IWebSocketShim.d.ts +11 -0
  167. package/dist/types/http/MiddlewareChain.d.ts +47 -0
  168. package/dist/types/http/RuntimeDetect.d.ts +2 -0
  169. package/dist/types/http/bun/BunAdapters.d.ts +139 -0
  170. package/dist/types/http/bun/BunRouter.d.ts +79 -0
  171. package/dist/types/http/bun/BunWebSocket.d.ts +35 -0
  172. package/dist/types/http/index.d.ts +16 -6
  173. package/dist/types/http/session/RedisSessionStore.d.ts +15 -0
  174. package/dist/types/http/session/SessionManager.d.ts +35 -0
  175. package/dist/types/http/session/SessionStore.d.ts +12 -0
  176. package/dist/types/http/session/sessionMiddleware.d.ts +10 -0
  177. package/dist/types/http/types.d.ts +42 -3
  178. package/dist/types/http/uWS/Adapters.d.ts +129 -0
  179. package/dist/types/http/{Router.d.ts → uWS/Router.d.ts} +14 -38
  180. package/dist/types/http/{WebSocket.d.ts → uWS/WebSocket.d.ts} +6 -5
  181. package/dist/types/models/BaseEntity.d.ts +1 -1
  182. package/dist/types/models/ModelUtils.d.ts +47 -14
  183. package/dist/types/models/RecoverableBaseEntity.d.ts +3 -1
  184. package/dist/types/models/RepoUtils.d.ts +84 -14
  185. package/dist/types/routes/BaseAdminRoute.d.ts +65 -0
  186. package/dist/types/routes/BaseMetricsRoute.d.ts +37 -0
  187. package/dist/types/routes/BaseOpenAPIRoute.d.ts +33 -0
  188. package/dist/types/routes/BasePushRoute.d.ts +53 -0
  189. package/dist/types/routes/BaseStaticRoute.d.ts +44 -0
  190. package/dist/types/routes/BaseStatusRoute.d.ts +37 -0
  191. package/dist/types/routes/CRUDRoute.d.ts +57 -0
  192. package/dist/types/routes/ModelRoute.d.ts +39 -36
  193. package/dist/types/routes/RouteUtils.d.ts +19 -0
  194. package/dist/types/routes/index.d.ts +7 -4
  195. package/dist/types/security/ACLUtils.d.ts +94 -18
  196. package/dist/types/security/AccessControlList.d.ts +37 -59
  197. package/dist/types/security/AccessControlListMongo.d.ts +3 -8
  198. package/dist/types/security/AccessControlListSQL.d.ts +3 -8
  199. package/dist/types/security/BaseACLRoute.d.ts +73 -0
  200. package/dist/types/security/index.d.ts +3 -0
  201. package/dist/types/test/request.d.ts +18 -1
  202. package/package.json +135 -129
  203. package/tsconfig.export.json +17 -0
  204. package/dist/lib/auth/BasicStrategy.js +0 -113
  205. package/dist/lib/auth/BasicStrategy.js.map +0 -1
  206. package/dist/lib/http/Adapters.js +0 -241
  207. package/dist/lib/http/Adapters.js.map +0 -1
  208. package/dist/lib/http/Router.js.map +0 -1
  209. package/dist/lib/http/WebSocket.js.map +0 -1
  210. package/dist/lib/routes/AdminRoute.js.map +0 -1
  211. package/dist/lib/routes/MetricsRoute.js.map +0 -1
  212. package/dist/lib/routes/OpenAPIRoute.js.map +0 -1
  213. package/dist/lib/routes/StatusRoute.js +0 -55
  214. package/dist/lib/routes/StatusRoute.js.map +0 -1
  215. package/dist/lib/security/ACLRouteMongo.js +0 -194
  216. package/dist/lib/security/ACLRouteMongo.js.map +0 -1
  217. package/dist/lib/security/ACLRouteSQL.js +0 -193
  218. package/dist/lib/security/ACLRouteSQL.js.map +0 -1
  219. package/dist/types/auth/BasicStrategy.d.ts +0 -37
  220. package/dist/types/http/Adapters.d.ts +0 -68
  221. package/dist/types/routes/AdminRoute.d.ts +0 -47
  222. package/dist/types/routes/MetricsRoute.d.ts +0 -15
  223. package/dist/types/routes/OpenAPIRoute.d.ts +0 -17
  224. package/dist/types/routes/StatusRoute.d.ts +0 -11
  225. package/dist/types/security/ACLRouteMongo.d.ts +0 -19
  226. package/dist/types/security/ACLRouteSQL.d.ts +0 -19
  227. package/docs/Makefile +0 -20
  228. package/docs/conf.py +0 -58
  229. package/docs/index.rst +0 -17
  230. package/docs/make.bat +0 -35
  231. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/README.md +0 -13
  232. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md +0 -25
  233. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md +0 -25
  234. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md +0 -25
  235. package/docs/reference/@rapidrest/namespaces/DocDecorators/README.md +0 -23
  236. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md +0 -25
  237. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md +0 -25
  238. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md +0 -25
  239. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md +0 -25
  240. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md +0 -25
  241. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md +0 -28
  242. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md +0 -25
  243. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md +0 -25
  244. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md +0 -28
  245. package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md +0 -57
  246. package/docs/reference/@rapidrest/namespaces/EventDecorators/README.md +0 -12
  247. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md +0 -17
  248. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md +0 -26
  249. package/docs/reference/@rapidrest/namespaces/ModelDecorators/README.md +0 -26
  250. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md +0 -25
  251. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md +0 -18
  252. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md +0 -25
  253. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md +0 -27
  254. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md +0 -35
  255. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md +0 -25
  256. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md +0 -27
  257. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md +0 -26
  258. package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +0 -45
  259. package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +0 -14
  260. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/README.md +0 -27
  261. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +0 -25
  262. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +0 -25
  263. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md +0 -119
  264. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md +0 -25
  265. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md +0 -68
  266. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md +0 -26
  267. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md +0 -26
  268. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md +0 -27
  269. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/CollationOptions.md +0 -79
  270. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md +0 -41
  271. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +0 -51
  272. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/EntityOptions.md +0 -32
  273. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +0 -41
  274. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +0 -61
  275. package/docs/reference/@rapidrest/namespaces/RouteDecorators/README.md +0 -36
  276. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md +0 -26
  277. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md +0 -33
  278. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md +0 -31
  279. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md +0 -25
  280. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md +0 -25
  281. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md +0 -25
  282. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md +0 -25
  283. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md +0 -25
  284. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md +0 -25
  285. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md +0 -31
  286. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md +0 -25
  287. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md +0 -25
  288. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md +0 -26
  289. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md +0 -25
  290. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md +0 -25
  291. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md +0 -31
  292. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md +0 -25
  293. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md +0 -26
  294. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md +0 -31
  295. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md +0 -26
  296. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md +0 -31
  297. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md +0 -25
  298. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md +0 -33
  299. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md +0 -31
  300. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md +0 -25
  301. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md +0 -25
  302. package/docs/reference/README.md +0 -20
  303. package/docs/reference/classes/ACLUtils.md +0 -263
  304. package/docs/reference/classes/AdminRoute.md +0 -51
  305. package/docs/reference/classes/AuthMiddleware.md +0 -173
  306. package/docs/reference/classes/BackgroundService.md +0 -117
  307. package/docs/reference/classes/BackgroundServiceManager.md +0 -172
  308. package/docs/reference/classes/BaseEntity.md +0 -82
  309. package/docs/reference/classes/BaseMongoEntity.md +0 -107
  310. package/docs/reference/classes/BasicStrategy.md +0 -131
  311. package/docs/reference/classes/BasicStrategyOptions.md +0 -115
  312. package/docs/reference/classes/BulkError.md +0 -271
  313. package/docs/reference/classes/ConnectionManager.md +0 -75
  314. package/docs/reference/classes/EventListenerManager.md +0 -88
  315. package/docs/reference/classes/HttpRouter.md +0 -343
  316. package/docs/reference/classes/JWTStrategy.md +0 -100
  317. package/docs/reference/classes/JWTStrategyOptions.md +0 -97
  318. package/docs/reference/classes/MetricsRoute.md +0 -27
  319. package/docs/reference/classes/ModelRoute.md +0 -527
  320. package/docs/reference/classes/ModelUtils.md +0 -446
  321. package/docs/reference/classes/MongoConnection.md +0 -218
  322. package/docs/reference/classes/MongoRepository.md +0 -390
  323. package/docs/reference/classes/MongoSchemaSync.md +0 -97
  324. package/docs/reference/classes/NetUtils.md +0 -90
  325. package/docs/reference/classes/NotificationUtils.md +0 -77
  326. package/docs/reference/classes/ObjectFactory.md +0 -336
  327. package/docs/reference/classes/OpenAPIRoute.md +0 -77
  328. package/docs/reference/classes/OpenApiSpec.md +0 -892
  329. package/docs/reference/classes/RecoverableBaseEntity.md +0 -114
  330. package/docs/reference/classes/RecoverableBaseMongoEntity.md +0 -124
  331. package/docs/reference/classes/RedisTransport.md +0 -2202
  332. package/docs/reference/classes/RepoUtils.md +0 -482
  333. package/docs/reference/classes/RouteUtils.md +0 -191
  334. package/docs/reference/classes/Server.md +0 -408
  335. package/docs/reference/classes/SimpleEntity.md +0 -48
  336. package/docs/reference/classes/SimpleMongoEntity.md +0 -66
  337. package/docs/reference/classes/StatusExtraData.md +0 -57
  338. package/docs/reference/classes/StatusRoute.md +0 -26
  339. package/docs/reference/classes/UWSRequest.md +0 -226
  340. package/docs/reference/classes/UWSResponse.md +0 -257
  341. package/docs/reference/classes/UWSWebSocketShim.md +0 -958
  342. package/docs/reference/enumerations/ACLAction.md +0 -63
  343. package/docs/reference/enumerations/ApiErrorMessages.md +0 -123
  344. package/docs/reference/enumerations/ApiErrors.md +0 -123
  345. package/docs/reference/functions/createWebSocketStream.md +0 -27
  346. package/docs/reference/functions/isSqlDataSource.md +0 -26
  347. package/docs/reference/functions/readBody.md +0 -29
  348. package/docs/reference/functions/resolveCollectionName.md +0 -33
  349. package/docs/reference/functions/runChain.md +0 -40
  350. package/docs/reference/functions/snakeCase.md +0 -28
  351. package/docs/reference/globals.md +0 -106
  352. package/docs/reference/interfaces/ACLRecord.md +0 -96
  353. package/docs/reference/interfaces/AccessControlList.md +0 -76
  354. package/docs/reference/interfaces/AuthResult.md +0 -55
  355. package/docs/reference/interfaces/AuthStrategy.md +0 -95
  356. package/docs/reference/interfaces/CreateRequestOptions.md +0 -121
  357. package/docs/reference/interfaces/DeleteRequestOptions.md +0 -137
  358. package/docs/reference/interfaces/FindRequestOptions.md +0 -133
  359. package/docs/reference/interfaces/HttpRequest.md +0 -147
  360. package/docs/reference/interfaces/HttpResponse.md +0 -164
  361. package/docs/reference/interfaces/JWTAuthResult.md +0 -84
  362. package/docs/reference/interfaces/RepoCreateOptions.md +0 -95
  363. package/docs/reference/interfaces/RepoDeleteOptions.md +0 -105
  364. package/docs/reference/interfaces/RepoFindOptions.md +0 -125
  365. package/docs/reference/interfaces/RepoOperationOptions.md +0 -69
  366. package/docs/reference/interfaces/RepoUpdateOptions.md +0 -101
  367. package/docs/reference/interfaces/RequestOptions.md +0 -112
  368. package/docs/reference/interfaces/RequestWS.md +0 -225
  369. package/docs/reference/interfaces/TruncateRequestOptions.md +0 -161
  370. package/docs/reference/interfaces/UpdateRequestOptions.md +0 -139
  371. package/docs/reference/type-aliases/ErrorHandler.md +0 -35
  372. package/docs/reference/type-aliases/NextFunction.md +0 -23
  373. package/docs/reference/type-aliases/OneOrMany.md +0 -19
  374. package/docs/reference/type-aliases/OneOrNull.md +0 -19
  375. package/docs/reference/type-aliases/PartialBaseEntity.md +0 -17
  376. package/docs/reference/type-aliases/PartialSimpleEntity.md +0 -17
  377. package/docs/reference/type-aliases/RequestHandler.md +0 -31
  378. package/docs/reference/type-aliases/UpdateObject.md +0 -19
  379. package/docs/reference/type-aliases/WsUpgradeAuth.md +0 -27
  380. package/docs/reference/type-aliases/WsUpgradeAuthResult.md +0 -47
@@ -1,68 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / Unique
6
-
7
- # Function: Unique()
8
-
9
- ## Call Signature
10
-
11
- > **Unique**(`name?`): `PropertyDecorator`
12
-
13
- Defined in: [src/decorators/PersistenceDecorators.ts:208](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L208)
14
-
15
- Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
16
- applied to a property (single-column constraint) or a class (compound constraint).
17
-
18
- ### Parameters
19
-
20
- #### name?
21
-
22
- `string`
23
-
24
- ### Returns
25
-
26
- `PropertyDecorator`
27
-
28
- ## Call Signature
29
-
30
- > **Unique**(`fields`): `ClassDecorator`
31
-
32
- Defined in: [src/decorators/PersistenceDecorators.ts:209](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L209)
33
-
34
- Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
35
- applied to a property (single-column constraint) or a class (compound constraint).
36
-
37
- ### Parameters
38
-
39
- #### fields
40
-
41
- `string`[]
42
-
43
- ### Returns
44
-
45
- `ClassDecorator`
46
-
47
- ## Call Signature
48
-
49
- > **Unique**(`name`, `fields`): `ClassDecorator`
50
-
51
- Defined in: [src/decorators/PersistenceDecorators.ts:210](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L210)
52
-
53
- Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
54
- applied to a property (single-column constraint) or a class (compound constraint).
55
-
56
- ### Parameters
57
-
58
- #### name
59
-
60
- `string`
61
-
62
- #### fields
63
-
64
- `string`[]
65
-
66
- ### Returns
67
-
68
- `ClassDecorator`
@@ -1,26 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / getColumnMetadata
6
-
7
- # Function: getColumnMetadata()
8
-
9
- > **getColumnMetadata**(`clazz`): [`ColumnInfo`](../interfaces/ColumnInfo.md)[]
10
-
11
- Defined in: [src/decorators/PersistenceDecorators.ts:242](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L242)
12
-
13
- Returns the merged list of persisted columns declared across the entire class hierarchy of the given model
14
- class. Columns declared in subclasses override columns of the same property name declared in parent classes.
15
-
16
- ## Parameters
17
-
18
- ### clazz
19
-
20
- `any`
21
-
22
- The model class to retrieve column metadata for.
23
-
24
- ## Returns
25
-
26
- [`ColumnInfo`](../interfaces/ColumnInfo.md)[]
@@ -1,26 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / getEntityName
6
-
7
- # Function: getEntityName()
8
-
9
- > **getEntityName**(`clazz`): `string` \| `undefined`
10
-
11
- Defined in: [src/decorators/PersistenceDecorators.ts:291](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L291)
12
-
13
- Returns the explicit entity name declared via `@Entity(name)` on the given class or the nearest ancestor that
14
- declares one, otherwise `undefined`.
15
-
16
- ## Parameters
17
-
18
- ### clazz
19
-
20
- `any`
21
-
22
- The model class to retrieve the entity name for.
23
-
24
- ## Returns
25
-
26
- `string` \| `undefined`
@@ -1,27 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / getIndexMetadata
6
-
7
- # Function: getIndexMetadata()
8
-
9
- > **getIndexMetadata**(`clazz`): [`IndexInfo`](../interfaces/IndexInfo.md)[]
10
-
11
- Defined in: [src/decorators/PersistenceDecorators.ts:262](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L262)
12
-
13
- Returns the merged list of indexes declared across the entire class hierarchy of the given model class,
14
- including both property-level and class-level (compound) indexes. Indexes declared in subclasses override
15
- indexes with the same identity (name, or column set when unnamed) declared in parent classes.
16
-
17
- ## Parameters
18
-
19
- ### clazz
20
-
21
- `any`
22
-
23
- The model class to retrieve index metadata for.
24
-
25
- ## Returns
26
-
27
- [`IndexInfo`](../interfaces/IndexInfo.md)[]
@@ -1,79 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / CollationOptions
6
-
7
- # Interface: CollationOptions
8
-
9
- Defined in: [src/decorators/PersistenceDecorators.ts:12](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L12)
10
-
11
- The language-specific rules to use for string comparison in MongoDB collections.
12
-
13
- ## See
14
-
15
- https://www.mongodb.com/docs/v7.0/reference/collation/#std-label-collation
16
-
17
- ## Properties
18
-
19
- ### alternate?
20
-
21
- > `optional` **alternate?**: `string`
22
-
23
- Defined in: [src/decorators/PersistenceDecorators.ts:18](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L18)
24
-
25
- ***
26
-
27
- ### backwards?
28
-
29
- > `optional` **backwards?**: `boolean`
30
-
31
- Defined in: [src/decorators/PersistenceDecorators.ts:20](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L20)
32
-
33
- ***
34
-
35
- ### caseFirst?
36
-
37
- > `optional` **caseFirst?**: `string`
38
-
39
- Defined in: [src/decorators/PersistenceDecorators.ts:15](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L15)
40
-
41
- ***
42
-
43
- ### caseLevel?
44
-
45
- > `optional` **caseLevel?**: `boolean`
46
-
47
- Defined in: [src/decorators/PersistenceDecorators.ts:14](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L14)
48
-
49
- ***
50
-
51
- ### locale
52
-
53
- > **locale**: `string`
54
-
55
- Defined in: [src/decorators/PersistenceDecorators.ts:13](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L13)
56
-
57
- ***
58
-
59
- ### maxVariable?
60
-
61
- > `optional` **maxVariable?**: `string`
62
-
63
- Defined in: [src/decorators/PersistenceDecorators.ts:19](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L19)
64
-
65
- ***
66
-
67
- ### numericOrdering?
68
-
69
- > `optional` **numericOrdering?**: `boolean`
70
-
71
- Defined in: [src/decorators/PersistenceDecorators.ts:17](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L17)
72
-
73
- ***
74
-
75
- ### strength?
76
-
77
- > `optional` **strength?**: `number`
78
-
79
- Defined in: [src/decorators/PersistenceDecorators.ts:16](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L16)
@@ -1,41 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / ColumnInfo
6
-
7
- # Interface: ColumnInfo
8
-
9
- Defined in: [src/decorators/PersistenceDecorators.ts:67](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L67)
10
-
11
- Describes a single persisted column/property of a model class.
12
-
13
- ## Properties
14
-
15
- ### designType?
16
-
17
- > `optional` **designType?**: `any`
18
-
19
- Defined in: [src/decorators/PersistenceDecorators.ts:71](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L71)
20
-
21
- The design type of the property as captured at decoration time.
22
-
23
- ***
24
-
25
- ### options
26
-
27
- > **options**: [`ColumnOptions`](ColumnOptions.md)
28
-
29
- Defined in: [src/decorators/PersistenceDecorators.ts:73](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L73)
30
-
31
- The options that the column was declared with.
32
-
33
- ***
34
-
35
- ### propertyName
36
-
37
- > **propertyName**: `string`
38
-
39
- Defined in: [src/decorators/PersistenceDecorators.ts:69](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L69)
40
-
41
- The name of the class property.
@@ -1,51 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / ColumnOptions
6
-
7
- # Interface: ColumnOptions
8
-
9
- Defined in: [src/decorators/PersistenceDecorators.ts:26](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L26)
10
-
11
- The set of options available when declaring a persisted column/property via the `@Column` decorator.
12
-
13
- ## Properties
14
-
15
- ### isObjectId?
16
-
17
- > `optional` **isObjectId?**: `boolean`
18
-
19
- Defined in: [src/decorators/PersistenceDecorators.ts:34](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L34)
20
-
21
- Set to `true` if the column stores a MongoDB `ObjectId` value.
22
-
23
- ***
24
-
25
- ### name?
26
-
27
- > `optional` **name?**: `string`
28
-
29
- Defined in: [src/decorators/PersistenceDecorators.ts:28](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L28)
30
-
31
- The name of the column in the datastore. Defaults to the property name.
32
-
33
- ***
34
-
35
- ### nullable?
36
-
37
- > `optional` **nullable?**: `boolean`
38
-
39
- Defined in: [src/decorators/PersistenceDecorators.ts:30](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L30)
40
-
41
- Set to `true` if the column may store `null`/`undefined` values.
42
-
43
- ***
44
-
45
- ### primary?
46
-
47
- > `optional` **primary?**: `boolean`
48
-
49
- Defined in: [src/decorators/PersistenceDecorators.ts:32](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L32)
50
-
51
- Set to `true` if the column is a primary key.
@@ -1,32 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / EntityOptions
6
-
7
- # Interface: EntityOptions
8
-
9
- Defined in: [src/decorators/PersistenceDecorators.ts:40](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L40)
10
-
11
- The set of options to use when declaring a persistent class type via the `@Entity` decorator.
12
-
13
- ## Properties
14
-
15
- ### collation?
16
-
17
- > `optional` **collation?**: [`CollationOptions`](CollationOptions.md)
18
-
19
- Defined in: [src/decorators/PersistenceDecorators.ts:45](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L45)
20
-
21
- The language-specific collation rules to apply to the collection. (MongoDB only)
22
-
23
- ***
24
-
25
- ### name?
26
-
27
- > `optional` **name?**: `string`
28
-
29
- Defined in: [src/decorators/PersistenceDecorators.ts:43](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L43)
30
-
31
- The name of the collection (or table) that records will be stored in. Defaults to the snake_case
32
- form of the class name.
@@ -1,41 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / IndexInfo
6
-
7
- # Interface: IndexInfo
8
-
9
- Defined in: [src/decorators/PersistenceDecorators.ts:79](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L79)
10
-
11
- Describes a single database index of a model class.
12
-
13
- ## Properties
14
-
15
- ### columns
16
-
17
- > **columns**: `string`[]
18
-
19
- Defined in: [src/decorators/PersistenceDecorators.ts:83](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L83)
20
-
21
- The list of class properties that make up the index.
22
-
23
- ***
24
-
25
- ### name?
26
-
27
- > `optional` **name?**: `string`
28
-
29
- Defined in: [src/decorators/PersistenceDecorators.ts:81](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L81)
30
-
31
- The explicit name of the index, if any.
32
-
33
- ***
34
-
35
- ### options
36
-
37
- > **options**: [`IndexOptions`](IndexOptions.md)
38
-
39
- Defined in: [src/decorators/PersistenceDecorators.ts:85](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L85)
40
-
41
- The options that the index was declared with.
@@ -1,61 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / IndexOptions
6
-
7
- # Interface: IndexOptions
8
-
9
- Defined in: [src/decorators/PersistenceDecorators.ts:51](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L51)
10
-
11
- The set of options available when declaring a database index via the `@Index` decorator.
12
-
13
- ## Properties
14
-
15
- ### background?
16
-
17
- > `optional` **background?**: `boolean`
18
-
19
- Defined in: [src/decorators/PersistenceDecorators.ts:57](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L57)
20
-
21
- Set to `true` to build the index in the background. (MongoDB only)
22
-
23
- ***
24
-
25
- ### collation?
26
-
27
- > `optional` **collation?**: [`CollationOptions`](CollationOptions.md)
28
-
29
- Defined in: [src/decorators/PersistenceDecorators.ts:61](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L61)
30
-
31
- The language-specific collation rules to apply to the index. (MongoDB only)
32
-
33
- ***
34
-
35
- ### expireAfterSeconds?
36
-
37
- > `optional` **expireAfterSeconds?**: `number`
38
-
39
- Defined in: [src/decorators/PersistenceDecorators.ts:59](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L59)
40
-
41
- The time, in seconds, after which indexed documents will be automatically deleted. (MongoDB only)
42
-
43
- ***
44
-
45
- ### sparse?
46
-
47
- > `optional` **sparse?**: `boolean`
48
-
49
- Defined in: [src/decorators/PersistenceDecorators.ts:55](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L55)
50
-
51
- Set to `true` to only index documents in which the indexed properties exist. (MongoDB only)
52
-
53
- ***
54
-
55
- ### unique?
56
-
57
- > `optional` **unique?**: `boolean`
58
-
59
- Defined in: [src/decorators/PersistenceDecorators.ts:53](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L53)
60
-
61
- Set to `true` to enforce that all values of the indexed properties are unique.
@@ -1,36 +0,0 @@
1
- [**@rapidrest/service-core**](../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../globals.md) / RouteDecorators
6
-
7
- # RouteDecorators
8
-
9
- ## Functions
10
-
11
- - [After](functions/After.md)
12
- - [Auth](functions/Auth.md)
13
- - [AuthResult](functions/AuthResult.md)
14
- - [Before](functions/Before.md)
15
- - [ContentType](functions/ContentType.md)
16
- - [Delete](functions/Delete.md)
17
- - [Get](functions/Get.md)
18
- - [Head](functions/Head.md)
19
- - [Header](functions/Header.md)
20
- - [Method](functions/Method.md)
21
- - [Model](functions/Model.md)
22
- - [Options](functions/Options.md)
23
- - [Param](functions/Param.md)
24
- - [Patch](functions/Patch.md)
25
- - [Post](functions/Post.md)
26
- - [Protect](functions/Protect.md)
27
- - [Put](functions/Put.md)
28
- - [Query](functions/Query.md)
29
- - [Request](functions/Request.md)
30
- - [RequiresRole](functions/RequiresRole.md)
31
- - [Response](functions/Response.md)
32
- - [Route](functions/Route.md)
33
- - [Socket](functions/Socket.md)
34
- - [User](functions/User.md)
35
- - [Validate](functions/Validate.md)
36
- - [WebSocket](functions/WebSocket.md)
@@ -1,26 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / After
6
-
7
- # Function: After()
8
-
9
- > **After**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
10
-
11
- Defined in: [src/decorators/RouteDecorators.ts:13](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L13)
12
-
13
- Indicates a provided function or list of functions to execute *after* the decorated function and before the response
14
- is sent to a client. Note that the function must call `next()` in order for this decorator to work.
15
-
16
- ## Parameters
17
-
18
- ### func
19
-
20
- `string` \| `Function` \| (`string` \| `Function`)[]
21
-
22
- The function or list of functions to execute *after* the decorated function.
23
-
24
- ## Returns
25
-
26
- (`target`, `propertyKey`, `descriptor`) => `void`
@@ -1,33 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Auth
6
-
7
- # Function: Auth()
8
-
9
- > **Auth**(`strategies`, `require?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
-
11
- Defined in: [src/decorators/RouteDecorators.ts:33](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L33)
12
-
13
- Applies PassportJS authentication to the decorated route or method for the provided strategy or list of strategies
14
- should be attempted before processing the route.
15
-
16
- ## Parameters
17
-
18
- ### strategies
19
-
20
- `string` \| `string`[]
21
-
22
- The PassportJS strategies that will be applied when incoming requests are processed.
23
-
24
- ### require?
25
-
26
- `boolean` = `true`
27
-
28
- Set to `true` to indicate that at least one of the specified authentication strategies must pass to
29
- proceed, otherwise set to `false`. Default is `true`.
30
-
31
- ## Returns
32
-
33
- (`target`, `propertyKey`, `descriptor`) => `void`
@@ -1,31 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / AuthResult
6
-
7
- # Function: AuthResult()
8
-
9
- > **AuthResult**(`target`, `propertyKey`, `index`): `void`
10
-
11
- Defined in: [src/decorators/RouteDecorators.ts:45](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L45)
12
-
13
- Injects the authenticated authentication result as the value of the decorated argument.
14
-
15
- ## Parameters
16
-
17
- ### target
18
-
19
- `any`
20
-
21
- ### propertyKey
22
-
23
- `string`
24
-
25
- ### index
26
-
27
- `number`
28
-
29
- ## Returns
30
-
31
- `void`
@@ -1,25 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Before
6
-
7
- # Function: Before()
8
-
9
- > **Before**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
10
-
11
- Defined in: [src/decorators/RouteDecorators.ts:56](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L56)
12
-
13
- Indicates a provided function or list of functions to execute *before* the decorated function.
14
-
15
- ## Parameters
16
-
17
- ### func
18
-
19
- `string` \| `Function` \| (`string` \| `Function`)[]
20
-
21
- The function or list of functions to execute *before* the decorated function.
22
-
23
- ## Returns
24
-
25
- (`target`, `propertyKey`, `descriptor`) => `void`
@@ -1,25 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / ContentType
6
-
7
- # Function: ContentType()
8
-
9
- > **ContentType**(`type`): (`target`, `propertyKey`, `descriptor`) => `void`
10
-
11
- Defined in: [src/decorators/RouteDecorators.ts:73](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L73)
12
-
13
- Indicates that the decorated function will return content encoded with the specified content type.
14
-
15
- ## Parameters
16
-
17
- ### type
18
-
19
- `string`
20
-
21
- The content type that the function will return.
22
-
23
- ## Returns
24
-
25
- (`target`, `propertyKey`, `descriptor`) => `void`
@@ -1,25 +0,0 @@
1
- [**@rapidrest/service-core**](../../../../README.md)
2
-
3
- ***
4
-
5
- [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Delete
6
-
7
- # Function: Delete()
8
-
9
- > **Delete**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
-
11
- Defined in: [src/decorators/RouteDecorators.ts:86](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L86)
12
-
13
- Indicates that the decorated function handles incoming `DELETE` requests at the given sub-path.
14
-
15
- ## Parameters
16
-
17
- ### path?
18
-
19
- `string`
20
-
21
- The sub-path that the route will handle requests for.
22
-
23
- ## Returns
24
-
25
- (`target`, `propertyKey`, `descriptor`) => `void`