@adaptivestone/framework 5.0.0-beta.9 → 5.0.0-rc.1

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 (370) hide show
  1. package/LICENCE +1 -1
  2. package/README.md +66 -2
  3. package/dist/Cli.d.ts +7 -0
  4. package/dist/Cli.js +19 -0
  5. package/dist/Cli.js.map +1 -0
  6. package/dist/cluster.d.ts +1 -0
  7. package/dist/cluster.js +67 -0
  8. package/dist/cluster.js.map +1 -0
  9. package/dist/codegen/appTypes.d.ts +19 -0
  10. package/dist/codegen/appTypes.js +126 -0
  11. package/dist/codegen/appTypes.js.map +1 -0
  12. package/dist/codegen/astEmit.d.ts +53 -0
  13. package/dist/codegen/astEmit.js +242 -0
  14. package/dist/codegen/astEmit.js.map +1 -0
  15. package/dist/codegen/astExtract.d.ts +78 -0
  16. package/dist/codegen/astExtract.js +539 -0
  17. package/dist/codegen/astExtract.js.map +1 -0
  18. package/dist/codegen/astModel.d.ts +14 -0
  19. package/dist/codegen/astModel.js +73 -0
  20. package/dist/codegen/astModel.js.map +1 -0
  21. package/dist/codegen/astResolve.d.ts +53 -0
  22. package/dist/codegen/astResolve.js +276 -0
  23. package/dist/codegen/astResolve.js.map +1 -0
  24. package/dist/codegen/astSpec.d.ts +25 -0
  25. package/dist/codegen/astSpec.js +63 -0
  26. package/dist/codegen/astSpec.js.map +1 -0
  27. package/dist/codegen/collectMetadata.d.ts +39 -0
  28. package/dist/codegen/collectMetadata.js +7 -0
  29. package/dist/codegen/collectMetadata.js.map +1 -0
  30. package/dist/codegen/emit.d.ts +30 -0
  31. package/dist/codegen/emit.js +213 -0
  32. package/dist/codegen/emit.js.map +1 -0
  33. package/dist/codegen/index.d.ts +30 -0
  34. package/dist/codegen/index.js +76 -0
  35. package/dist/codegen/index.js.map +1 -0
  36. package/dist/codegen/paths.d.ts +9 -0
  37. package/dist/codegen/paths.js +25 -0
  38. package/dist/codegen/paths.js.map +1 -0
  39. package/dist/commands/CreateUser.d.ts +32 -0
  40. package/dist/commands/CreateUser.js +85 -0
  41. package/dist/commands/CreateUser.js.map +1 -0
  42. package/dist/commands/DropIndex.d.ts +16 -0
  43. package/dist/commands/DropIndex.js +30 -0
  44. package/dist/commands/DropIndex.js.map +1 -0
  45. package/dist/commands/GenerateRandomBytes.d.ts +7 -0
  46. package/dist/commands/GenerateRandomBytes.js +18 -0
  47. package/dist/commands/GenerateRandomBytes.js.map +1 -0
  48. package/dist/commands/GenerateTypes.d.ts +13 -0
  49. package/dist/commands/GenerateTypes.js +34 -0
  50. package/dist/commands/GenerateTypes.js.map +1 -0
  51. package/dist/commands/SyncIndexes.d.ts +6 -0
  52. package/dist/commands/SyncIndexes.js +31 -0
  53. package/dist/commands/SyncIndexes.js.map +1 -0
  54. package/dist/commands/migration/Create.d.ts +18 -0
  55. package/dist/commands/migration/Create.js +57 -0
  56. package/dist/commands/migration/Create.js.map +1 -0
  57. package/dist/commands/migration/Migrate.d.ts +6 -0
  58. package/dist/commands/migration/Migrate.js +73 -0
  59. package/dist/commands/migration/Migrate.js.map +1 -0
  60. package/dist/config/auth.d.ts +11 -0
  61. package/dist/config/auth.js +18 -0
  62. package/dist/config/auth.js.map +1 -0
  63. package/dist/config/http.d.ts +22 -0
  64. package/dist/config/http.js +40 -0
  65. package/dist/config/http.js.map +1 -0
  66. package/dist/config/i18n.d.ts +13 -0
  67. package/dist/config/i18n.js +13 -0
  68. package/dist/config/i18n.js.map +1 -0
  69. package/dist/config/ipDetector.d.ts +5 -0
  70. package/dist/config/ipDetector.js +15 -0
  71. package/dist/config/ipDetector.js.map +1 -0
  72. package/dist/config/log.d.ts +11 -0
  73. package/dist/config/log.js +21 -0
  74. package/dist/config/log.js.map +1 -0
  75. package/dist/config/mongo.d.ts +4 -0
  76. package/dist/config/mongo.js +4 -0
  77. package/dist/config/mongo.js.map +1 -0
  78. package/dist/config/rateLimiter.d.ts +13 -0
  79. package/dist/config/rateLimiter.js +17 -0
  80. package/dist/config/rateLimiter.js.map +1 -0
  81. package/dist/config/redis.d.ts +5 -0
  82. package/dist/config/redis.js +5 -0
  83. package/dist/config/redis.js.map +1 -0
  84. package/dist/controllers/Auth.d.ts +59 -0
  85. package/dist/controllers/Auth.js +356 -0
  86. package/dist/controllers/Auth.js.map +1 -0
  87. package/dist/controllers/Auth.routes.gen.d.ts +57 -0
  88. package/dist/controllers/Auth.routes.gen.js +10 -0
  89. package/dist/controllers/Auth.routes.gen.js.map +1 -0
  90. package/dist/controllers/Home.d.ts +14 -0
  91. package/dist/controllers/Home.js +26 -0
  92. package/dist/controllers/Home.js.map +1 -0
  93. package/dist/controllers/Home.routes.gen.d.ts +13 -0
  94. package/dist/controllers/Home.routes.gen.js +10 -0
  95. package/dist/controllers/Home.routes.gen.js.map +1 -0
  96. package/dist/controllers/index.d.ts +107 -0
  97. package/dist/controllers/index.js +548 -0
  98. package/dist/controllers/index.js.map +1 -0
  99. package/dist/folderConfig.d.ts +34 -0
  100. package/dist/folderConfig.js +14 -0
  101. package/dist/folderConfig.js.map +1 -0
  102. package/dist/helpers/appInstance.d.ts +10 -0
  103. package/dist/helpers/appInstance.js +19 -0
  104. package/dist/helpers/appInstance.js.map +1 -0
  105. package/dist/helpers/crypto.d.ts +26 -0
  106. package/dist/helpers/crypto.js +160 -0
  107. package/dist/helpers/crypto.js.map +1 -0
  108. package/dist/helpers/deprecation.d.ts +8 -0
  109. package/dist/helpers/deprecation.js +19 -0
  110. package/dist/helpers/deprecation.js.map +1 -0
  111. package/dist/helpers/env.d.ts +8 -0
  112. package/dist/helpers/env.js +15 -0
  113. package/dist/helpers/env.js.map +1 -0
  114. package/dist/helpers/files.d.ts +16 -0
  115. package/dist/helpers/files.js +83 -0
  116. package/dist/helpers/files.js.map +1 -0
  117. package/dist/helpers/logger.d.ts +6 -0
  118. package/dist/helpers/logger.js +34 -0
  119. package/dist/helpers/logger.js.map +1 -0
  120. package/dist/helpers/redis/clearNamespace.d.ts +10 -0
  121. package/dist/helpers/redis/clearNamespace.js +31 -0
  122. package/dist/helpers/redis/clearNamespace.js.map +1 -0
  123. package/dist/helpers/redis/redisConnection.d.ts +8 -0
  124. package/dist/helpers/redis/redisConnection.js +63 -0
  125. package/dist/helpers/redis/redisConnection.js.map +1 -0
  126. package/dist/helpers/yup.d.ts +22 -0
  127. package/dist/helpers/yup.js +39 -0
  128. package/dist/helpers/yup.js.map +1 -0
  129. package/dist/index.d.ts +1 -0
  130. package/dist/index.js +8 -0
  131. package/dist/index.js.map +1 -0
  132. package/{locales → dist/locales}/en/translation.json +5 -0
  133. package/{locales → dist/locales}/ru/translation.json +5 -0
  134. package/dist/models/KeyValue.d.ts +22 -0
  135. package/dist/models/KeyValue.js +17 -0
  136. package/dist/models/KeyValue.js.map +1 -0
  137. package/dist/models/Lock.d.ts +99 -0
  138. package/dist/models/Lock.js +123 -0
  139. package/dist/models/Lock.js.map +1 -0
  140. package/dist/models/Migration.d.ts +13 -0
  141. package/dist/models/Migration.js +14 -0
  142. package/dist/models/Migration.js.map +1 -0
  143. package/dist/models/Sequence.d.ts +28 -0
  144. package/dist/models/Sequence.js +31 -0
  145. package/dist/models/Sequence.js.map +1 -0
  146. package/dist/models/User.d.ts +769 -0
  147. package/dist/models/User.js +336 -0
  148. package/dist/models/User.js.map +1 -0
  149. package/dist/models/UserOld.d.ts +191 -0
  150. package/dist/models/UserOld.js +231 -0
  151. package/dist/models/UserOld.js.map +1 -0
  152. package/dist/modules/AbstractCommand.d.ts +51 -0
  153. package/dist/modules/AbstractCommand.js +60 -0
  154. package/dist/modules/AbstractCommand.js.map +1 -0
  155. package/dist/modules/AbstractConnector.d.ts +5 -0
  156. package/dist/modules/AbstractConnector.js +8 -0
  157. package/dist/modules/AbstractConnector.js.map +1 -0
  158. package/dist/modules/AbstractController.d.ts +99 -0
  159. package/dist/modules/AbstractController.js +83 -0
  160. package/dist/modules/AbstractController.js.map +1 -0
  161. package/dist/modules/AbstractModel.d.ts +29 -0
  162. package/dist/modules/AbstractModel.js +42 -0
  163. package/dist/modules/AbstractModel.js.map +1 -0
  164. package/dist/modules/Base.d.ts +29 -0
  165. package/dist/modules/Base.js +62 -0
  166. package/dist/modules/Base.js.map +1 -0
  167. package/dist/modules/BaseCli.d.ts +25 -0
  168. package/dist/modules/BaseCli.js +159 -0
  169. package/dist/modules/BaseCli.js.map +1 -0
  170. package/dist/modules/BaseModel.d.ts +57 -0
  171. package/dist/modules/BaseModel.js +37 -0
  172. package/dist/modules/BaseModel.js.map +1 -0
  173. package/dist/server.d.ts +130 -0
  174. package/dist/server.js +603 -0
  175. package/dist/server.js.map +1 -0
  176. package/dist/services/cache/Cache.d.ts +31 -0
  177. package/dist/services/cache/Cache.js +146 -0
  178. package/dist/services/cache/Cache.js.map +1 -0
  179. package/dist/services/http/HttpServer.d.ts +46 -0
  180. package/dist/services/http/HttpServer.js +114 -0
  181. package/dist/services/http/HttpServer.js.map +1 -0
  182. package/dist/services/http/files.d.ts +18 -0
  183. package/dist/services/http/files.js +19 -0
  184. package/dist/services/http/files.js.map +1 -0
  185. package/dist/services/http/middleware/AbstractMiddleware.d.ts +58 -0
  186. package/dist/services/http/middleware/AbstractMiddleware.js +73 -0
  187. package/dist/services/http/middleware/AbstractMiddleware.js.map +1 -0
  188. package/dist/services/http/middleware/Auth.d.ts +22 -0
  189. package/dist/services/http/middleware/Auth.js +30 -0
  190. package/dist/services/http/middleware/Auth.js.map +1 -0
  191. package/dist/services/http/middleware/Cors.d.ts +12 -0
  192. package/dist/services/http/middleware/Cors.js +45 -0
  193. package/dist/services/http/middleware/Cors.js.map +1 -0
  194. package/dist/services/http/middleware/GetUserByToken.d.ts +36 -0
  195. package/dist/services/http/middleware/GetUserByToken.js +59 -0
  196. package/dist/services/http/middleware/GetUserByToken.js.map +1 -0
  197. package/dist/services/http/middleware/I18n.d.ts +23 -0
  198. package/dist/services/http/middleware/I18n.js +61 -0
  199. package/dist/services/http/middleware/I18n.js.map +1 -0
  200. package/dist/services/http/middleware/IpDetector.d.ts +14 -0
  201. package/dist/services/http/middleware/IpDetector.js +80 -0
  202. package/dist/services/http/middleware/IpDetector.js.map +1 -0
  203. package/dist/services/http/middleware/Pagination.d.ts +26 -0
  204. package/dist/services/http/middleware/Pagination.js +70 -0
  205. package/dist/services/http/middleware/Pagination.js.map +1 -0
  206. package/dist/services/http/middleware/PrepareAppInfo.d.ts +8 -0
  207. package/dist/services/http/middleware/PrepareAppInfo.js +17 -0
  208. package/dist/services/http/middleware/PrepareAppInfo.js.map +1 -0
  209. package/dist/services/http/middleware/RateLimiter.d.ts +31 -0
  210. package/dist/services/http/middleware/RateLimiter.js +118 -0
  211. package/dist/services/http/middleware/RateLimiter.js.map +1 -0
  212. package/dist/services/http/middleware/RequestLogger.d.ts +8 -0
  213. package/dist/services/http/middleware/RequestLogger.js +20 -0
  214. package/dist/services/http/middleware/RequestLogger.js.map +1 -0
  215. package/dist/services/http/middleware/RequestParser.d.ts +15 -0
  216. package/dist/services/http/middleware/RequestParser.js +112 -0
  217. package/dist/services/http/middleware/RequestParser.js.map +1 -0
  218. package/dist/services/http/middleware/Role.d.ts +12 -0
  219. package/dist/services/http/middleware/Role.js +27 -0
  220. package/dist/services/http/middleware/Role.js.map +1 -0
  221. package/dist/services/http/routing/ExpressAdapter.d.ts +12 -0
  222. package/dist/services/http/routing/ExpressAdapter.js +95 -0
  223. package/dist/services/http/routing/ExpressAdapter.js.map +1 -0
  224. package/dist/services/http/routing/RouteNode.d.ts +105 -0
  225. package/dist/services/http/routing/RouteNode.js +21 -0
  226. package/dist/services/http/routing/RouteNode.js.map +1 -0
  227. package/dist/services/http/routing/RouteRegistry.d.ts +37 -0
  228. package/dist/services/http/routing/RouteRegistry.js +244 -0
  229. package/dist/services/http/routing/RouteRegistry.js.map +1 -0
  230. package/dist/services/http/routing/formatTree.d.ts +23 -0
  231. package/dist/services/http/routing/formatTree.js +159 -0
  232. package/dist/services/http/routing/formatTree.js.map +1 -0
  233. package/dist/services/http/routing/match.d.ts +31 -0
  234. package/dist/services/http/routing/match.js +164 -0
  235. package/dist/services/http/routing/match.js.map +1 -0
  236. package/dist/services/http/routing/middlewareNormalization.d.ts +11 -0
  237. package/dist/services/http/routing/middlewareNormalization.js +23 -0
  238. package/dist/services/http/routing/middlewareNormalization.js.map +1 -0
  239. package/dist/services/http/types.d.ts +74 -0
  240. package/dist/services/http/types.js +8 -0
  241. package/dist/services/http/types.js.map +1 -0
  242. package/dist/services/i18n/I18n.d.ts +15 -0
  243. package/dist/services/i18n/I18n.js +58 -0
  244. package/dist/services/i18n/I18n.js.map +1 -0
  245. package/dist/services/logging/SentryTransport.d.ts +13 -0
  246. package/dist/services/logging/SentryTransport.js +134 -0
  247. package/dist/services/logging/SentryTransport.js.map +1 -0
  248. package/dist/services/validate/ValidateService.d.ts +54 -0
  249. package/dist/services/validate/ValidateService.js +144 -0
  250. package/dist/services/validate/ValidateService.js.map +1 -0
  251. package/dist/services/validate/ValidationError.d.ts +35 -0
  252. package/dist/services/validate/ValidationError.js +90 -0
  253. package/dist/services/validate/ValidationError.js.map +1 -0
  254. package/dist/services/validate/contentType.d.ts +18 -0
  255. package/dist/services/validate/contentType.js +30 -0
  256. package/dist/services/validate/contentType.js.map +1 -0
  257. package/dist/services/validate/defineSchema.d.ts +23 -0
  258. package/dist/services/validate/defineSchema.js +25 -0
  259. package/dist/services/validate/defineSchema.js.map +1 -0
  260. package/dist/services/validate/drivers/StandardSchemaDriver.d.ts +15 -0
  261. package/dist/services/validate/drivers/StandardSchemaDriver.js +38 -0
  262. package/dist/services/validate/drivers/StandardSchemaDriver.js.map +1 -0
  263. package/dist/services/validate/drivers/YupDriver.d.ts +21 -0
  264. package/dist/services/validate/drivers/YupDriver.js +81 -0
  265. package/dist/services/validate/drivers/YupDriver.js.map +1 -0
  266. package/dist/services/validate/types.d.ts +104 -0
  267. package/dist/services/validate/types.js +11 -0
  268. package/dist/services/validate/types.js.map +1 -0
  269. package/dist/tests/frameworkVitestSetup.d.ts +1 -0
  270. package/dist/tests/frameworkVitestSetup.js +9 -0
  271. package/dist/tests/frameworkVitestSetup.js.map +1 -0
  272. package/dist/tests/globalSetupVitest.d.ts +3 -0
  273. package/dist/tests/globalSetupVitest.js +29 -0
  274. package/dist/tests/globalSetupVitest.js.map +1 -0
  275. package/dist/tests/setupVitest.d.ts +1 -0
  276. package/dist/tests/setupVitest.js +101 -0
  277. package/dist/tests/setupVitest.js.map +1 -0
  278. package/dist/tests/testHelpers.d.ts +361 -0
  279. package/dist/tests/testHelpers.js +48 -0
  280. package/dist/tests/testHelpers.js.map +1 -0
  281. package/dist/types.d.ts +4 -0
  282. package/dist/types.js +5 -0
  283. package/dist/types.js.map +1 -0
  284. package/package.json +83 -39
  285. package/.env.example +0 -18
  286. package/CHANGELOG.md +0 -956
  287. package/Cli.js +0 -21
  288. package/cluster.js +0 -25
  289. package/commands/CreateUser.js +0 -106
  290. package/commands/Documentation.js +0 -17
  291. package/commands/DropIndex.js +0 -38
  292. package/commands/GenerateRandomBytes.js +0 -21
  293. package/commands/GetOpenApiJson.js +0 -336
  294. package/commands/SyncIndexes.js +0 -40
  295. package/commands/migration/Create.js +0 -72
  296. package/commands/migration/Migrate.js +0 -56
  297. package/config/auth.js +0 -9
  298. package/config/http.js +0 -9
  299. package/config/i18n.js +0 -12
  300. package/config/ipDetector.js +0 -14
  301. package/config/log.js +0 -22
  302. package/config/mongo.js +0 -3
  303. package/config/rateLimiter.js +0 -16
  304. package/config/redis.js +0 -4
  305. package/config/validate.js +0 -3
  306. package/controllers/Auth.js +0 -201
  307. package/controllers/Home.js +0 -28
  308. package/controllers/index.js +0 -60
  309. package/eslint.config.js +0 -68
  310. package/folderConfig.js +0 -13
  311. package/helpers/files.js +0 -76
  312. package/helpers/logger.js +0 -16
  313. package/helpers/redis/clearNamespace.js +0 -14
  314. package/helpers/yup.js +0 -22
  315. package/index.js +0 -8
  316. package/jsconfig.json +0 -9
  317. package/models/Lock.js +0 -107
  318. package/models/Migration.js +0 -15
  319. package/models/Sequence.js +0 -22
  320. package/models/User.js +0 -280
  321. package/modules/AbstractCommand.js +0 -52
  322. package/modules/AbstractConnector.js +0 -9
  323. package/modules/AbstractController.js +0 -406
  324. package/modules/AbstractModel.d.ts +0 -48
  325. package/modules/AbstractModel.js +0 -92
  326. package/modules/Base.d.ts +0 -37
  327. package/modules/Base.js +0 -64
  328. package/modules/BaseCli.js +0 -157
  329. package/server.d.ts +0 -100
  330. package/server.js +0 -439
  331. package/services/cache/Cache.d.ts +0 -35
  332. package/services/cache/Cache.js +0 -124
  333. package/services/documentation/DocumentationGenerator.js +0 -169
  334. package/services/http/HttpServer.js +0 -89
  335. package/services/http/middleware/AbstractMiddleware.js +0 -51
  336. package/services/http/middleware/Auth.js +0 -20
  337. package/services/http/middleware/Cors.js +0 -46
  338. package/services/http/middleware/GetUserByToken.js +0 -47
  339. package/services/http/middleware/I18n.js +0 -117
  340. package/services/http/middleware/IpDetector.js +0 -59
  341. package/services/http/middleware/Pagination.js +0 -57
  342. package/services/http/middleware/PrepareAppInfo.js +0 -18
  343. package/services/http/middleware/RateLimiter.js +0 -134
  344. package/services/http/middleware/RequestLogger.js +0 -22
  345. package/services/http/middleware/RequestParser.js +0 -40
  346. package/services/http/middleware/Role.js +0 -29
  347. package/services/messaging/email/templates/.gitkeep +0 -0
  348. package/services/validate/ValidateService.js +0 -157
  349. package/services/validate/drivers/AbstractValidator.js +0 -37
  350. package/services/validate/drivers/CustomValidator.js +0 -51
  351. package/services/validate/drivers/YupValidator.js +0 -103
  352. package/tests/globalSetupVitest.js +0 -35
  353. package/tests/setup.js +0 -120
  354. package/tests/setupVitest.js +0 -111
  355. package/types/Expand.d.ts +0 -11
  356. package/types/ICommandArguments.d.ts +0 -41
  357. package/types/TFoldersConfig.d.ts +0 -20
  358. package/views/404.pug +0 -3
  359. package/views/home.pug +0 -3
  360. package/views/layouts/base.pug +0 -39
  361. package/vitest.config.js +0 -17
  362. /package/{commands → dist/migrations}/.gitkeep +0 -0
  363. /package/{services → dist/services}/messaging/email/resources/.gitkeep +0 -0
  364. /package/{migrations → dist/services/messaging/email/templates}/.gitkeep +0 -0
  365. /package/{services → dist/services}/messaging/email/templates/recovery/html.pug +0 -0
  366. /package/{services → dist/services}/messaging/email/templates/recovery/subject.pug +0 -0
  367. /package/{services → dist/services}/messaging/email/templates/recovery/text.pug +0 -0
  368. /package/{services → dist/services}/messaging/email/templates/verification/html.pug +0 -0
  369. /package/{services → dist/services}/messaging/email/templates/verification/subject.pug +0 -0
  370. /package/{services → dist/services}/messaging/email/templates/verification/text.pug +0 -0
@@ -1,406 +0,0 @@
1
- import express from 'express';
2
-
3
- import Base from './Base.js';
4
- import GetUserByToken from '../services/http/middleware/GetUserByToken.js';
5
- import Auth from '../services/http/middleware/Auth.js';
6
- import ValidateService from '../services/validate/ValidateService.js';
7
- import DocumentationGenerator from '../services/documentation/DocumentationGenerator.js';
8
- /**
9
- * Abstract controller. You should extend any controller from them.
10
- * Place you cintroller into controller folder and it be inited in auto way.
11
- * By default name of route will be controller name not file name. But please name it in same ways.
12
- * You can overwrite base controllers byt creating controllers with tha same file name (yes file name, not class name)
13
- * In most cases you will want to have a 'home' route that not include controller name. For this case please check ' getHttpPath'
14
- */
15
- class AbstractController extends Base {
16
- constructor(app, prefix, isExpressMergeParams = false) {
17
- const time = Date.now();
18
- super(app);
19
- this.prefix = prefix;
20
- this.router = express.Router({
21
- mergeParams: isExpressMergeParams,
22
- });
23
- const { routes } = this;
24
- let httpPath = this.getHttpPath();
25
-
26
- // @ts-ignore
27
- if (this.getExpressPath) {
28
- this.logger.warn(
29
- `getExpressPath deprecated. Please use getHttpPath instead. Will be removed on v5`,
30
- );
31
- // @ts-ignore
32
- httpPath = this.getExpressPath();
33
- }
34
-
35
- /**
36
- * Grab route middleware onlo one Map
37
- */
38
- const routeMiddlewares = new Map();
39
- Object.entries(routes).forEach(([method, methodRoutes]) => {
40
- Object.entries(methodRoutes).forEach(([route, routeParam]) => {
41
- if (routeParam?.middleware) {
42
- const fullRoute = method.toUpperCase() + route;
43
-
44
- if (!routeMiddlewares.has(fullRoute)) {
45
- routeMiddlewares.set(fullRoute, []);
46
- }
47
-
48
- routeMiddlewares.set(fullRoute, [
49
- ...routeMiddlewares.get(fullRoute),
50
- ...routeParam.middleware,
51
- ]);
52
- }
53
- });
54
- });
55
-
56
- const routeMiddlewaresReg = this.parseMiddlewares(
57
- routeMiddlewares,
58
- httpPath,
59
- );
60
- const middlewaresInfo = this.parseMiddlewares(
61
- // @ts-ignore
62
- this.constructor.middleware,
63
- httpPath,
64
- );
65
-
66
- const routesInfo = [];
67
-
68
- /**
69
- * Register controller middleware
70
- */
71
- for (const middleware of middlewaresInfo) {
72
- this.router[middleware.method](
73
- middleware.path,
74
- new middleware.MiddlewareFunction(
75
- this.app,
76
- middleware.params,
77
- ).getMiddleware(),
78
- );
79
- }
80
-
81
- /**
82
- * Register routes itself
83
- */
84
- for (const verb in routes) {
85
- if (typeof this.router[verb] !== 'function') {
86
- this.logger.error(
87
- `Method ${verb} not exist for router. Please check your codebase`,
88
- );
89
- continue;
90
- }
91
- for (const path in routes[verb]) {
92
- const routeAdditionalMiddlewares = routeMiddlewaresReg.filter(
93
- (middleware) =>
94
- middleware.path === path && middleware.method === verb,
95
- );
96
-
97
- let routeObject = routes[verb][path];
98
- if (Object.prototype.toString.call(routeObject) !== '[object Object]') {
99
- routeObject = {
100
- handler: routeObject,
101
- request: null,
102
- query: null,
103
- middleware: null,
104
- };
105
-
106
- if (typeof routeObject.handler !== 'function') {
107
- this.logger.error(
108
- `Can't resolve function '${
109
- routeObject.handler
110
- }' for controller '${this.getConstructorName()}'`,
111
- );
112
- continue;
113
- }
114
- }
115
-
116
- let fnName = routeObject.handler;
117
- if (typeof fnName === 'function') {
118
- fnName = fnName.name;
119
- }
120
-
121
- const fullPath = `/${httpPath}/${path}`
122
- .split('//')
123
- .join('/')
124
- .split('//')
125
- .join('/');
126
-
127
- routesInfo.push({
128
- name: fnName,
129
- description: routeObject?.description,
130
- method: verb.toUpperCase(),
131
- fields: routeObject?.request?.fields,
132
- queryFields: routeObject?.query?.fields,
133
- path,
134
- fullPath,
135
- });
136
- // this.logger.verbose(
137
- // `Controller '${this.getConstructorName()}' register function '${fnName}' for method '${verb}' and path '${path}' Full path '${fullPath}'`,
138
- // );
139
-
140
- let additionalMiddlewares;
141
-
142
- if (routeAdditionalMiddlewares.length > 0) {
143
- additionalMiddlewares = Array.from(
144
- routeAdditionalMiddlewares,
145
- ({ MiddlewareFunction, params }) =>
146
- new MiddlewareFunction(this.app, params).getMiddleware(),
147
- );
148
- }
149
-
150
- this.router[verb](
151
- path,
152
- additionalMiddlewares || [],
153
- async (req, res, next) => {
154
- const requestObj = {
155
- query: req.query,
156
- body: req.body,
157
- appInfo: req.appInfo,
158
- };
159
- try {
160
- req.appInfo.request = await new ValidateService(
161
- this.app,
162
- routeObject?.request,
163
- ).validateReqData(requestObj, {
164
- selectedReqData: req.body,
165
- additionalMiddlewareFieldsData: {
166
- middlewaresInfo,
167
- routeMiddlewaresReg,
168
- options: {
169
- method: verb,
170
- path: fullPath,
171
- prefix: 'request',
172
- },
173
- },
174
- });
175
- req.appInfo.query = await new ValidateService(
176
- this.app,
177
- routeObject?.query,
178
- ).validateReqData(requestObj, {
179
- selectedReqData: req.query,
180
- additionalMiddlewareFieldsData: {
181
- middlewaresInfo,
182
- routeMiddlewaresReg,
183
- options: {
184
- method: verb,
185
- path: fullPath,
186
- prefix: 'query',
187
- },
188
- },
189
- });
190
- } catch (err) {
191
- return res.status(400).json({
192
- errors: err.message,
193
- });
194
- }
195
- // req.body = new Proxy(req.body, {
196
- // get: (target, prop) => {
197
- // this.logger.warn(
198
- // 'Please not use "req.body" directly. Implement "request" and use "req.appInfo.request" ',
199
- // );
200
- // return target[prop];
201
- // },
202
- // });
203
- // req.query = new Proxy(req.query, {
204
- // get: (target, prop) => {
205
- // this.logger.warn(
206
- // 'Please not use "req.query" directly. Implement "query" and use "req.appInfo.query" ',
207
- // );
208
- // return target[prop];
209
- // },
210
- // });
211
-
212
- if (!routeObject.handler) {
213
- this.logger.error(`Route object have no handler defined`);
214
- return res.status(500).json({
215
- message:
216
- 'Platform error 2. Please check later or contact support',
217
- });
218
- }
219
-
220
- if (routeObject.handler.constructor.name !== 'AsyncFunction') {
221
- const error =
222
- "Handler should be AsyncFunction. Perhabs you miss 'async' of function declaration?";
223
- this.logger.error(error);
224
- return res.status(500).json({
225
- message:
226
- 'Platform error. Please check later or contact support',
227
- });
228
- }
229
- return routeObject.handler.call(this, req, res, next).catch((e) => {
230
- this.logger.error(e);
231
- return res.status(500).json({
232
- message:
233
- 'Platform error. Please check later or contact support',
234
- });
235
- });
236
- },
237
- );
238
- }
239
- }
240
-
241
- /**
242
- * Generate text info
243
- */
244
- const text = ['', `Controller '${this.getConstructorName()}' registered.`];
245
-
246
- const reports = {
247
- 'Middlewares:': middlewaresInfo,
248
- 'Route middlewares:': routeMiddlewaresReg,
249
- 'Callbacks:': routesInfo,
250
- };
251
- for (const key in reports) {
252
- text.push(`${key}`);
253
- for (const item of reports[key]) {
254
- text.push(
255
- `Path:'${item.path}'. Full path: '${
256
- item.fullPath
257
- }'. Method: '${item.method.toUpperCase()}'. Function: '${item.name}'`,
258
- );
259
- }
260
- }
261
-
262
- text.push(`Time: ${Date.now() - time} ms`);
263
-
264
- this.logger.verbose(text.join('\n'));
265
- this.loadedTime = Date.now() - time;
266
-
267
- /**
268
- * Generate documentation
269
- */
270
- if (!this.app.httpServer) {
271
- this.app.documentation.push(
272
- new DocumentationGenerator(this.app).convertDataToDocumentationElement(
273
- this.getConstructorName(),
274
- routesInfo,
275
- middlewaresInfo,
276
- routeMiddlewaresReg,
277
- ),
278
- );
279
- } else {
280
- this.app.httpServer.express.use(httpPath, this.router);
281
- }
282
- }
283
-
284
- /**
285
- * Parse middlewares to be an object.
286
- */
287
- parseMiddlewares(middlewareMap, httpPath) {
288
- const middlewaresInfo = [];
289
- // eslint-disable-next-line prefer-const
290
- for (let [path, middleware] of middlewareMap) {
291
- if (!Array.isArray(middleware)) {
292
- middleware = [middleware];
293
- }
294
- for (const M of middleware) {
295
- let method = 'all';
296
- let realPath = path;
297
- if (typeof realPath !== 'string') {
298
- this.logger.error(`Path not a string ${realPath}. Please check it`);
299
- continue;
300
- }
301
- if (!realPath.startsWith('/')) {
302
- method = realPath.split('/')[0]?.toLowerCase();
303
- if (!method) {
304
- this.logger.error(`Method not found for ${realPath}`);
305
- continue;
306
- }
307
- realPath = realPath.substring(method.length);
308
- }
309
- if (typeof this.router[method] !== 'function') {
310
- this.logger.error(
311
- `Method ${method} not exist for middleware. Please check your codebase`,
312
- );
313
- continue;
314
- }
315
- const fullPath = `/${httpPath}/${realPath.toUpperCase()}`
316
- .split('//')
317
- .join('/')
318
- .split('//')
319
- .join('/');
320
- let MiddlewareFunction = M;
321
- let middlewareParams = {};
322
- if (Array.isArray(M)) {
323
- [MiddlewareFunction, middlewareParams] = M;
324
- }
325
-
326
- middlewaresInfo.push({
327
- name: MiddlewareFunction.name,
328
- method,
329
- path: realPath,
330
- fullPath,
331
- params: middlewareParams,
332
- relatedQueryParameters: new MiddlewareFunction(
333
- this.app,
334
- middlewareParams,
335
- )?.relatedQueryParameters,
336
- authParams: new MiddlewareFunction(this.app, middlewareParams)
337
- ?.usedAuthParameters,
338
- MiddlewareFunction,
339
- });
340
- }
341
- }
342
- return middlewaresInfo;
343
- }
344
-
345
- /**
346
- * Object with routes. Routes relative to controller
347
- * @example
348
- * return {
349
- * post: {
350
- * "/someUrl": {
351
- * handler: this.postSomeUrl,
352
- * request: yup.object().shape({
353
- * count: yup.number().max(100)required(),
354
- * })
355
- * }
356
- * },
357
- * };
358
- */
359
- get routes() {
360
- this.logger.warn('Please implement "routes" method on controller.');
361
- return {};
362
- }
363
-
364
- /**
365
- * Array of middlewares to append for route
366
- * You should provide path relative to controller and then array of middlewares to apply.
367
- * Order is matter.
368
- * Be default path apply to ANY' method, but you can preattach 'METHOD' into patch to scope patch to this METHOD
369
- * @returns {Map<string, Array<typeof import('../services/http/middleware/AbstractMiddleware.js').default | [Function, ...any]>>}
370
- * @example
371
- * return new Map([
372
- * ['/{*splat}', [GetUserByToken]] // for any method for this controller
373
- * ['POST/', [Auth]] // for POST method
374
- * ['/superSecretMethod', [OnlySuperSecretUsers]] // route with ANY method
375
- * ['PUT/superSecretMathod', [OnlySuperSecretAdmin]] // route with PUT method
376
- * ]);
377
- */
378
- static get middleware() {
379
- return new Map([['/{*splat}', [GetUserByToken, Auth]]]);
380
- }
381
-
382
- /**
383
- * Get constructor name that can include preix
384
- */
385
- getConstructorName() {
386
- if (this.prefix) {
387
- return `${this.prefix.charAt(0).toUpperCase()}${this.prefix.slice(1)}/${
388
- this.constructor.name
389
- }`;
390
- }
391
- return this.constructor.name;
392
- }
393
-
394
- /**
395
- * Get http path with inheritance of path
396
- */
397
- getHttpPath() {
398
- return `/${this.getConstructorName().toLowerCase()}`.replace('//', '/');
399
- }
400
-
401
- static get loggerGroup() {
402
- return 'controller';
403
- }
404
- }
405
-
406
- export default AbstractController;
@@ -1,48 +0,0 @@
1
- import type Base from './Base.js';
2
- import { Model, Schema } from 'mongoose';
3
- import type Server from '../server.js';
4
-
5
- interface AbstractModel<T extends Document> extends Model, Base {
6
- constructor(app: Server['app'], callback?: () => void);
7
-
8
- /**
9
- * Return itself for internal methods.
10
- */
11
- getSuper(): this;
12
-
13
- /**
14
- * Model schema in Js object (not a mongoose schema).
15
- */
16
- get modelSchema(): Object;
17
-
18
- /**
19
- * Mongoose schema.
20
- */
21
- mongooseSchema: Schema<T>;
22
-
23
- /**
24
- * Acces to mongoose model too
25
- */
26
- mongooseModel: Model<T>;
27
-
28
- /**
29
- * Init custom hooks before model
30
- */
31
- initHooks(): void;
32
- }
33
-
34
- abstract class AbstractModel<T extends Document>
35
- extends Model
36
- implements AbstractModel
37
- {
38
- abstract get modelSchema(): Object;
39
-
40
- /**
41
- * Return itself for internal methods.
42
- */
43
- static abstract getSuper(): this;
44
-
45
- mongooseSchema: Schema<T> = new Schema<T>(this.modelSchema);
46
- }
47
-
48
- export default AbstractModel;
@@ -1,92 +0,0 @@
1
- import mongoose from 'mongoose';
2
- import Base from './Base.js';
3
-
4
- class AbstractModel extends Base {
5
- mongooseSchema = null;
6
-
7
- mongooseModel = null;
8
-
9
- /**
10
- * @param {import('../server.js').default['app']} app //TODO change to *.d.ts as this is a Server, not app
11
- * @param function callback optional callback when connection ready
12
- */
13
- constructor(app, callback = () => {}) {
14
- super(app);
15
- this.mongooseSchema = new mongoose.Schema(
16
- this.modelSchema,
17
- this.modelSchemaOptions,
18
- );
19
- mongoose.set('strictQuery', true);
20
- this.mongooseSchema.set('timestamps', true);
21
- this.mongooseSchema.set('minimize', false);
22
- this.mongooseSchema.loadClass(this.constructor);
23
- this.mongooseSchema.statics.getSuper = () => this;
24
- this.mongooseSchema.methods.getSuper = () => this;
25
- this.initHooks();
26
- this.mongooseModel = mongoose.model(
27
- this.constructor.name,
28
- this.mongooseSchema,
29
- );
30
- if (!mongoose.connection.readyState) {
31
- this.app.events.on('shutdown', async () => {
32
- this.logger.verbose(
33
- 'Shutdown was called. Closing all mongoose connections',
34
- );
35
- for (const c of mongoose.connections) {
36
- c.close(true);
37
- }
38
- // await mongoose.disconnect(); // TODO it have problems with replica-set
39
- });
40
- const connectionParams = {};
41
- if (process.env.MONGO_APP_NAME) {
42
- connectionParams.appName = process.env.MONGO_APP_NAME;
43
- }
44
- // do not connect on test
45
- mongoose
46
- .connect(this.app.getConfig('mongo').connectionString, connectionParams)
47
- .then(
48
- () => {
49
- this.logger.info(
50
- `Mongo connection success ${connectionParams.appName}`,
51
- );
52
- mongoose.connection.on('error', (err) => {
53
- this.logger.error('Mongo connection error', err);
54
- console.error(err);
55
- });
56
-
57
- callback();
58
- },
59
- (error) => {
60
- this.logger.error("Can't install mongodb connection", error);
61
- },
62
- );
63
- } else {
64
- callback();
65
- }
66
- }
67
-
68
- /**
69
- * Mongoose schema
70
- */
71
- get modelSchema() {
72
- this.logger.warn('You should provide modelSchema');
73
- return {};
74
- }
75
-
76
- /**
77
- * Mongoose schema options
78
- */
79
- // eslint-disable-next-line class-methods-use-this
80
- get modelSchemaOptions() {
81
- return {};
82
- }
83
-
84
- static get loggerGroup() {
85
- return 'model';
86
- }
87
-
88
- initHooks() {
89
- this.logger.verbose('Model have no hooks');
90
- }
91
- }
92
- export default AbstractModel;
package/modules/Base.d.ts DELETED
@@ -1,37 +0,0 @@
1
- import type winston from 'winston';
2
- import type Server from '../server.js';
3
- import type { Dirent } from 'node.fs';
4
-
5
- declare class Base {
6
- app: Server['app'];
7
- #realLogger: null;
8
-
9
- constructor(app: Server['app']);
10
-
11
- /**
12
- * In case of logging sometimes we might need to replace name
13
- */
14
- getConstructorName(): string;
15
-
16
- /**
17
- * Optimzation to lazy load logger. It will be inited only on request
18
- */
19
- get logger(): winston.Logger;
20
-
21
- /**
22
- * Get winston loger for given label
23
- * @param label name of logger
24
- */
25
- getLogger(label: string): winston.Logger;
26
-
27
- getFilesPathWithInheritance(
28
- internalFolder: string,
29
- externalFolder: string,
30
- ): Promise<{ path: string; file: string }[]>;
31
-
32
- /**
33
- * Return logger group. Just to have all logs groupped logically
34
- */
35
- static get loggerGroup(): string;
36
- }
37
- export default Base;
package/modules/Base.js DELETED
@@ -1,64 +0,0 @@
1
- import { getFilesPathWithInheritance } from '../helpers/files.js';
2
-
3
- class Base {
4
- #realLogger = null;
5
-
6
- constructor(app) {
7
- this.app = app;
8
- }
9
-
10
- /**
11
- * In case of logging sometimes we might need to replace name
12
- */
13
- getConstructorName() {
14
- return this.constructor.name;
15
- }
16
-
17
- /**
18
- * Optimzation to lazy load logger. It will be inited only on request
19
- */
20
- get logger() {
21
- let l;
22
- try {
23
- l = this.#realLogger;
24
- } catch {
25
- console.warn(
26
- `You try to accees logger not from class. that can be ok in case of models.`,
27
- );
28
- return null;
29
- }
30
-
31
- if (!l) {
32
- const { loggerGroup } = /** @type {typeof Base} */ (this.constructor);
33
- this.#realLogger = this.getLogger(
34
- loggerGroup + this.getConstructorName(),
35
- );
36
- }
37
- return this.#realLogger;
38
- }
39
-
40
- /**
41
- * Get winston loger for given label
42
- * @param {string} label name of logger
43
- */
44
- getLogger(label) {
45
- return this.app.logger.child({ label });
46
- }
47
-
48
- async getFilesPathWithInheritance(internalFolder, externalFolder) {
49
- return getFilesPathWithInheritance({
50
- internalFolder,
51
- externalFolder,
52
- logger: (text) => this.logger.verbose(text),
53
- });
54
- }
55
-
56
- /**
57
- * Return logger group. Just to have all logs groupped logically
58
- */
59
- static get loggerGroup() {
60
- return 'Base_please_overwrite_';
61
- }
62
- }
63
-
64
- export default Base;