@miqro/core 3.0.6 → 5.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (395) hide show
  1. package/README.md +0 -204
  2. package/build/app.d.ts +23 -0
  3. package/build/app.js +101 -0
  4. package/build/app.js.map +1 -0
  5. package/build/common.d.ts +106 -0
  6. package/build/common.js +477 -0
  7. package/build/common.js.map +1 -0
  8. package/build/lib.d.ts +7 -0
  9. package/build/lib.js +8 -0
  10. package/build/lib.js.map +1 -0
  11. package/build/middleware/body-parser.d.ts +78 -0
  12. package/build/middleware/body-parser.js +552 -0
  13. package/build/middleware/body-parser.js.map +1 -0
  14. package/build/middleware/router.d.ts +114 -0
  15. package/build/middleware/router.js +704 -0
  16. package/build/middleware/router.js.map +1 -0
  17. package/build/{esm/common/session/service.d.ts → middleware/session.d.ts} +10 -9
  18. package/build/middleware/session.js +369 -0
  19. package/build/middleware/session.js.map +1 -0
  20. package/build/types.d.ts +309 -0
  21. package/build/types.js +455 -0
  22. package/build/types.js.map +1 -0
  23. package/build/websocket.d.ts +31 -0
  24. package/build/websocket.js +316 -0
  25. package/build/websocket.js.map +1 -0
  26. package/package.json +13 -14
  27. package/src/app.ts +64 -29
  28. package/src/common.ts +528 -0
  29. package/src/lib.ts +82 -0
  30. package/src/middleware/body-parser.ts +597 -0
  31. package/src/middleware/router.ts +840 -0
  32. package/src/middleware/session.ts +271 -37
  33. package/src/types.ts +785 -0
  34. package/src/websocket.ts +356 -0
  35. package/build/cjs/api-router.d.ts +0 -34
  36. package/build/cjs/api-router.js +0 -52
  37. package/build/cjs/api-router.js.map +0 -1
  38. package/build/cjs/app-utils.d.ts +0 -13
  39. package/build/cjs/app-utils.js +0 -82
  40. package/build/cjs/app-utils.js.map +0 -1
  41. package/build/cjs/app.d.ts +0 -12
  42. package/build/cjs/app.js +0 -79
  43. package/build/cjs/app.js.map +0 -1
  44. package/build/cjs/common/api-router-types.d.ts +0 -28
  45. package/build/cjs/common/api-router-types.js +0 -17
  46. package/build/cjs/common/api-router-types.js.map +0 -1
  47. package/build/cjs/common/api-router-utils.d.ts +0 -3
  48. package/build/cjs/common/api-router-utils.js +0 -115
  49. package/build/cjs/common/api-router-utils.js.map +0 -1
  50. package/build/cjs/common/config/config.d.ts +0 -15
  51. package/build/cjs/common/config/config.js +0 -45
  52. package/build/cjs/common/config/config.js.map +0 -1
  53. package/build/cjs/common/config/featuretoggle.d.ts +0 -1
  54. package/build/cjs/common/config/featuretoggle.js +0 -10
  55. package/build/cjs/common/config/featuretoggle.js.map +0 -1
  56. package/build/cjs/common/config/index.d.ts +0 -3
  57. package/build/cjs/common/config/index.js +0 -20
  58. package/build/cjs/common/config/index.js.map +0 -1
  59. package/build/cjs/common/config/loader.d.ts +0 -13
  60. package/build/cjs/common/config/loader.js +0 -70
  61. package/build/cjs/common/config/loader.js.map +0 -1
  62. package/build/cjs/common/context.d.ts +0 -57
  63. package/build/cjs/common/context.js +0 -141
  64. package/build/cjs/common/context.js.map +0 -1
  65. package/build/cjs/common/error/badrequesterror.d.ts +0 -3
  66. package/build/cjs/common/error/badrequesterror.js +0 -11
  67. package/build/cjs/common/error/badrequesterror.js.map +0 -1
  68. package/build/cjs/common/error/configfilenotfound.d.ts +0 -3
  69. package/build/cjs/common/error/configfilenotfound.js +0 -11
  70. package/build/cjs/common/error/configfilenotfound.js.map +0 -1
  71. package/build/cjs/common/error/forbiddenerror.d.ts +0 -3
  72. package/build/cjs/common/error/forbiddenerror.js +0 -11
  73. package/build/cjs/common/error/forbiddenerror.js.map +0 -1
  74. package/build/cjs/common/error/index.d.ts +0 -6
  75. package/build/cjs/common/error/index.js +0 -23
  76. package/build/cjs/common/error/index.js.map +0 -1
  77. package/build/cjs/common/error/notfound.d.ts +0 -3
  78. package/build/cjs/common/error/notfound.js +0 -11
  79. package/build/cjs/common/error/notfound.js.map +0 -1
  80. package/build/cjs/common/error/notimplemented.d.ts +0 -3
  81. package/build/cjs/common/error/notimplemented.js +0 -11
  82. package/build/cjs/common/error/notimplemented.js.map +0 -1
  83. package/build/cjs/common/error/unauthorizederror.d.ts +0 -3
  84. package/build/cjs/common/error/unauthorizederror.js +0 -11
  85. package/build/cjs/common/error/unauthorizederror.js.map +0 -1
  86. package/build/cjs/common/index.d.ts +0 -11
  87. package/build/cjs/common/index.js +0 -34
  88. package/build/cjs/common/index.js.map +0 -1
  89. package/build/cjs/common/logger/constants.d.ts +0 -14
  90. package/build/cjs/common/logger/constants.js +0 -27
  91. package/build/cjs/common/logger/constants.js.map +0 -1
  92. package/build/cjs/common/logger/factory.d.ts +0 -16
  93. package/build/cjs/common/logger/factory.js +0 -53
  94. package/build/cjs/common/logger/factory.js.map +0 -1
  95. package/build/cjs/common/logger/index.d.ts +0 -5
  96. package/build/cjs/common/logger/index.js +0 -22
  97. package/build/cjs/common/logger/index.js.map +0 -1
  98. package/build/cjs/common/logger/interfaces.d.ts +0 -18
  99. package/build/cjs/common/logger/interfaces.js +0 -3
  100. package/build/cjs/common/logger/interfaces.js.map +0 -1
  101. package/build/cjs/common/logger/logger.d.ts +0 -35
  102. package/build/cjs/common/logger/logger.js +0 -100
  103. package/build/cjs/common/logger/logger.js.map +0 -1
  104. package/build/cjs/common/logger/transport/console.d.ts +0 -5
  105. package/build/cjs/common/logger/transport/console.js +0 -41
  106. package/build/cjs/common/logger/transport/console.js.map +0 -1
  107. package/build/cjs/common/logger/transport/file.d.ts +0 -2
  108. package/build/cjs/common/logger/transport/file.js +0 -29
  109. package/build/cjs/common/logger/transport/file.js.map +0 -1
  110. package/build/cjs/common/router-default-logger-factory.d.ts +0 -4
  111. package/build/cjs/common/router-default-logger-factory.js +0 -42
  112. package/build/cjs/common/router-default-logger-factory.js.map +0 -1
  113. package/build/cjs/common/router-handler.d.ts +0 -21
  114. package/build/cjs/common/router-handler.js +0 -161
  115. package/build/cjs/common/router-handler.js.map +0 -1
  116. package/build/cjs/common/router-types.d.ts +0 -58
  117. package/build/cjs/common/router-types.js +0 -58
  118. package/build/cjs/common/router-types.js.map +0 -1
  119. package/build/cjs/common/router-utils.d.ts +0 -3
  120. package/build/cjs/common/router-utils.js +0 -51
  121. package/build/cjs/common/router-utils.js.map +0 -1
  122. package/build/cjs/common/session/common.d.ts +0 -37
  123. package/build/cjs/common/session/common.js +0 -3
  124. package/build/cjs/common/session/common.js.map +0 -1
  125. package/build/cjs/common/session/index.d.ts +0 -2
  126. package/build/cjs/common/session/index.js +0 -19
  127. package/build/cjs/common/session/index.js.map +0 -1
  128. package/build/cjs/common/session/service.d.ts +0 -26
  129. package/build/cjs/common/session/service.js +0 -149
  130. package/build/cjs/common/session/service.js.map +0 -1
  131. package/build/cjs/common/tokenize-match.d.ts +0 -19
  132. package/build/cjs/common/tokenize-match.js +0 -79
  133. package/build/cjs/common/tokenize-match.js.map +0 -1
  134. package/build/cjs/common/url-utils.d.ts +0 -6
  135. package/build/cjs/common/url-utils.js +0 -54
  136. package/build/cjs/common/url-utils.js.map +0 -1
  137. package/build/cjs/index.d.ts +0 -7
  138. package/build/cjs/index.js +0 -24
  139. package/build/cjs/index.js.map +0 -1
  140. package/build/cjs/middleware/buffer.d.ts +0 -6
  141. package/build/cjs/middleware/buffer.js +0 -81
  142. package/build/cjs/middleware/buffer.js.map +0 -1
  143. package/build/cjs/middleware/cookie.d.ts +0 -4
  144. package/build/cjs/middleware/cookie.js +0 -19
  145. package/build/cjs/middleware/cookie.js.map +0 -1
  146. package/build/cjs/middleware/cors.d.ts +0 -8
  147. package/build/cjs/middleware/cors.js +0 -92
  148. package/build/cjs/middleware/cors.js.map +0 -1
  149. package/build/cjs/middleware/form.d.ts +0 -6
  150. package/build/cjs/middleware/form.js +0 -61
  151. package/build/cjs/middleware/form.js.map +0 -1
  152. package/build/cjs/middleware/group.d.ts +0 -2
  153. package/build/cjs/middleware/group.js +0 -79
  154. package/build/cjs/middleware/group.js.map +0 -1
  155. package/build/cjs/middleware/index.d.ts +0 -14
  156. package/build/cjs/middleware/index.js +0 -65
  157. package/build/cjs/middleware/index.js.map +0 -1
  158. package/build/cjs/middleware/json.d.ts +0 -6
  159. package/build/cjs/middleware/json.js +0 -58
  160. package/build/cjs/middleware/json.js.map +0 -1
  161. package/build/cjs/middleware/logger.d.ts +0 -4
  162. package/build/cjs/middleware/logger.js +0 -20
  163. package/build/cjs/middleware/logger.js.map +0 -1
  164. package/build/cjs/middleware/parse.d.ts +0 -13
  165. package/build/cjs/middleware/parse.js +0 -82
  166. package/build/cjs/middleware/parse.js.map +0 -1
  167. package/build/cjs/middleware/result.d.ts +0 -8
  168. package/build/cjs/middleware/result.js +0 -58
  169. package/build/cjs/middleware/result.js.map +0 -1
  170. package/build/cjs/middleware/session.d.ts +0 -2
  171. package/build/cjs/middleware/session.js +0 -151
  172. package/build/cjs/middleware/session.js.map +0 -1
  173. package/build/cjs/middleware/tag.d.ts +0 -4
  174. package/build/cjs/middleware/tag.js +0 -14
  175. package/build/cjs/middleware/tag.js.map +0 -1
  176. package/build/cjs/middleware/text.d.ts +0 -5
  177. package/build/cjs/middleware/text.js +0 -49
  178. package/build/cjs/middleware/text.js.map +0 -1
  179. package/build/cjs/proxy.d.ts +0 -19
  180. package/build/cjs/proxy.js +0 -78
  181. package/build/cjs/proxy.js.map +0 -1
  182. package/build/cjs/router.d.ts +0 -26
  183. package/build/cjs/router.js +0 -120
  184. package/build/cjs/router.js.map +0 -1
  185. package/build/cjs/static.d.ts +0 -14
  186. package/build/cjs/static.js +0 -212
  187. package/build/cjs/static.js.map +0 -1
  188. package/build/esm/api-router.d.ts +0 -34
  189. package/build/esm/api-router.js +0 -48
  190. package/build/esm/api-router.js.map +0 -1
  191. package/build/esm/app-utils.d.ts +0 -13
  192. package/build/esm/app-utils.js +0 -78
  193. package/build/esm/app-utils.js.map +0 -1
  194. package/build/esm/app.d.ts +0 -12
  195. package/build/esm/app.js +0 -74
  196. package/build/esm/app.js.map +0 -1
  197. package/build/esm/common/api-router-types.d.ts +0 -28
  198. package/build/esm/common/api-router-types.js +0 -14
  199. package/build/esm/common/api-router-types.js.map +0 -1
  200. package/build/esm/common/api-router-utils.d.ts +0 -3
  201. package/build/esm/common/api-router-utils.js +0 -111
  202. package/build/esm/common/api-router-utils.js.map +0 -1
  203. package/build/esm/common/config/config.d.ts +0 -15
  204. package/build/esm/common/config/config.js +0 -38
  205. package/build/esm/common/config/config.js.map +0 -1
  206. package/build/esm/common/config/featuretoggle.d.ts +0 -1
  207. package/build/esm/common/config/featuretoggle.js +0 -6
  208. package/build/esm/common/config/featuretoggle.js.map +0 -1
  209. package/build/esm/common/config/index.d.ts +0 -3
  210. package/build/esm/common/config/index.js +0 -4
  211. package/build/esm/common/config/index.js.map +0 -1
  212. package/build/esm/common/config/loader.d.ts +0 -13
  213. package/build/esm/common/config/loader.js +0 -64
  214. package/build/esm/common/config/loader.js.map +0 -1
  215. package/build/esm/common/context.d.ts +0 -57
  216. package/build/esm/common/context.js +0 -137
  217. package/build/esm/common/context.js.map +0 -1
  218. package/build/esm/common/error/badrequesterror.d.ts +0 -3
  219. package/build/esm/common/error/badrequesterror.js +0 -7
  220. package/build/esm/common/error/badrequesterror.js.map +0 -1
  221. package/build/esm/common/error/configfilenotfound.d.ts +0 -3
  222. package/build/esm/common/error/configfilenotfound.js +0 -7
  223. package/build/esm/common/error/configfilenotfound.js.map +0 -1
  224. package/build/esm/common/error/forbiddenerror.d.ts +0 -3
  225. package/build/esm/common/error/forbiddenerror.js +0 -7
  226. package/build/esm/common/error/forbiddenerror.js.map +0 -1
  227. package/build/esm/common/error/index.d.ts +0 -6
  228. package/build/esm/common/error/index.js +0 -7
  229. package/build/esm/common/error/index.js.map +0 -1
  230. package/build/esm/common/error/notfound.d.ts +0 -3
  231. package/build/esm/common/error/notfound.js +0 -7
  232. package/build/esm/common/error/notfound.js.map +0 -1
  233. package/build/esm/common/error/notimplemented.d.ts +0 -3
  234. package/build/esm/common/error/notimplemented.js +0 -7
  235. package/build/esm/common/error/notimplemented.js.map +0 -1
  236. package/build/esm/common/error/unauthorizederror.d.ts +0 -3
  237. package/build/esm/common/error/unauthorizederror.js +0 -7
  238. package/build/esm/common/error/unauthorizederror.js.map +0 -1
  239. package/build/esm/common/index.d.ts +0 -11
  240. package/build/esm/common/index.js +0 -12
  241. package/build/esm/common/index.js.map +0 -1
  242. package/build/esm/common/logger/constants.d.ts +0 -14
  243. package/build/esm/common/logger/constants.js +0 -22
  244. package/build/esm/common/logger/constants.js.map +0 -1
  245. package/build/esm/common/logger/factory.d.ts +0 -16
  246. package/build/esm/common/logger/factory.js +0 -47
  247. package/build/esm/common/logger/factory.js.map +0 -1
  248. package/build/esm/common/logger/index.d.ts +0 -5
  249. package/build/esm/common/logger/index.js +0 -6
  250. package/build/esm/common/logger/index.js.map +0 -1
  251. package/build/esm/common/logger/interfaces.d.ts +0 -18
  252. package/build/esm/common/logger/interfaces.js +0 -2
  253. package/build/esm/common/logger/interfaces.js.map +0 -1
  254. package/build/esm/common/logger/logger.d.ts +0 -35
  255. package/build/esm/common/logger/logger.js +0 -95
  256. package/build/esm/common/logger/logger.js.map +0 -1
  257. package/build/esm/common/logger/transport/console.d.ts +0 -5
  258. package/build/esm/common/logger/transport/console.js +0 -37
  259. package/build/esm/common/logger/transport/console.js.map +0 -1
  260. package/build/esm/common/logger/transport/file.d.ts +0 -2
  261. package/build/esm/common/logger/transport/file.js +0 -25
  262. package/build/esm/common/logger/transport/file.js.map +0 -1
  263. package/build/esm/common/router-default-logger-factory.d.ts +0 -4
  264. package/build/esm/common/router-default-logger-factory.js +0 -37
  265. package/build/esm/common/router-default-logger-factory.js.map +0 -1
  266. package/build/esm/common/router-handler.d.ts +0 -21
  267. package/build/esm/common/router-handler.js +0 -157
  268. package/build/esm/common/router-handler.js.map +0 -1
  269. package/build/esm/common/router-types.d.ts +0 -58
  270. package/build/esm/common/router-types.js +0 -54
  271. package/build/esm/common/router-types.js.map +0 -1
  272. package/build/esm/common/router-utils.d.ts +0 -3
  273. package/build/esm/common/router-utils.js +0 -46
  274. package/build/esm/common/router-utils.js.map +0 -1
  275. package/build/esm/common/session/common.d.ts +0 -37
  276. package/build/esm/common/session/common.js +0 -2
  277. package/build/esm/common/session/common.js.map +0 -1
  278. package/build/esm/common/session/index.d.ts +0 -2
  279. package/build/esm/common/session/index.js +0 -3
  280. package/build/esm/common/session/index.js.map +0 -1
  281. package/build/esm/common/session/service.js +0 -145
  282. package/build/esm/common/session/service.js.map +0 -1
  283. package/build/esm/common/tokenize-match.d.ts +0 -19
  284. package/build/esm/common/tokenize-match.js +0 -73
  285. package/build/esm/common/tokenize-match.js.map +0 -1
  286. package/build/esm/common/url-utils.d.ts +0 -6
  287. package/build/esm/common/url-utils.js +0 -48
  288. package/build/esm/common/url-utils.js.map +0 -1
  289. package/build/esm/index.d.ts +0 -7
  290. package/build/esm/index.js +0 -8
  291. package/build/esm/index.js.map +0 -1
  292. package/build/esm/middleware/buffer.d.ts +0 -6
  293. package/build/esm/middleware/buffer.js +0 -77
  294. package/build/esm/middleware/buffer.js.map +0 -1
  295. package/build/esm/middleware/cookie.d.ts +0 -4
  296. package/build/esm/middleware/cookie.js +0 -15
  297. package/build/esm/middleware/cookie.js.map +0 -1
  298. package/build/esm/middleware/cors.d.ts +0 -8
  299. package/build/esm/middleware/cors.js +0 -88
  300. package/build/esm/middleware/cors.js.map +0 -1
  301. package/build/esm/middleware/form.d.ts +0 -6
  302. package/build/esm/middleware/form.js +0 -57
  303. package/build/esm/middleware/form.js.map +0 -1
  304. package/build/esm/middleware/group.d.ts +0 -2
  305. package/build/esm/middleware/group.js +0 -75
  306. package/build/esm/middleware/group.js.map +0 -1
  307. package/build/esm/middleware/index.d.ts +0 -14
  308. package/build/esm/middleware/index.js +0 -46
  309. package/build/esm/middleware/index.js.map +0 -1
  310. package/build/esm/middleware/json.d.ts +0 -6
  311. package/build/esm/middleware/json.js +0 -54
  312. package/build/esm/middleware/json.js.map +0 -1
  313. package/build/esm/middleware/logger.d.ts +0 -4
  314. package/build/esm/middleware/logger.js +0 -16
  315. package/build/esm/middleware/logger.js.map +0 -1
  316. package/build/esm/middleware/parse.d.ts +0 -13
  317. package/build/esm/middleware/parse.js +0 -78
  318. package/build/esm/middleware/parse.js.map +0 -1
  319. package/build/esm/middleware/result.d.ts +0 -8
  320. package/build/esm/middleware/result.js +0 -54
  321. package/build/esm/middleware/result.js.map +0 -1
  322. package/build/esm/middleware/session.d.ts +0 -2
  323. package/build/esm/middleware/session.js +0 -147
  324. package/build/esm/middleware/session.js.map +0 -1
  325. package/build/esm/middleware/tag.d.ts +0 -4
  326. package/build/esm/middleware/tag.js +0 -10
  327. package/build/esm/middleware/tag.js.map +0 -1
  328. package/build/esm/middleware/text.d.ts +0 -5
  329. package/build/esm/middleware/text.js +0 -45
  330. package/build/esm/middleware/text.js.map +0 -1
  331. package/build/esm/proxy.d.ts +0 -19
  332. package/build/esm/proxy.js +0 -74
  333. package/build/esm/proxy.js.map +0 -1
  334. package/build/esm/router.d.ts +0 -26
  335. package/build/esm/router.js +0 -116
  336. package/build/esm/router.js.map +0 -1
  337. package/build/esm/static.d.ts +0 -14
  338. package/build/esm/static.js +0 -208
  339. package/build/esm/static.js.map +0 -1
  340. package/src/api-router.ts +0 -50
  341. package/src/app-utils.ts +0 -82
  342. package/src/app-utils.unit.test.js +0 -101
  343. package/src/app.unit.test.js +0 -334
  344. package/src/common/api-router-types.ts +0 -42
  345. package/src/common/api-router-utils.ts +0 -121
  346. package/src/common/config/config.ts +0 -49
  347. package/src/common/config/featuretoggle.ts +0 -6
  348. package/src/common/config/index.ts +0 -3
  349. package/src/common/config/loader.ts +0 -81
  350. package/src/common/context.ts +0 -192
  351. package/src/common/context.unit.test.js +0 -295
  352. package/src/common/error/badrequesterror.ts +0 -6
  353. package/src/common/error/configfilenotfound.ts +0 -6
  354. package/src/common/error/forbiddenerror.ts +0 -6
  355. package/src/common/error/index.ts +0 -6
  356. package/src/common/error/notfound.ts +0 -6
  357. package/src/common/error/notimplemented.ts +0 -6
  358. package/src/common/error/unauthorizederror.ts +0 -6
  359. package/src/common/index.ts +0 -11
  360. package/src/common/logger/constants.ts +0 -28
  361. package/src/common/logger/factory.ts +0 -53
  362. package/src/common/logger/index.ts +0 -6
  363. package/src/common/logger/interfaces.ts +0 -19
  364. package/src/common/logger/logger.ts +0 -136
  365. package/src/common/logger/transport/console.ts +0 -36
  366. package/src/common/logger/transport/file.ts +0 -26
  367. package/src/common/router-default-logger-factory.ts +0 -42
  368. package/src/common/router-handler.ts +0 -186
  369. package/src/common/router-types.ts +0 -117
  370. package/src/common/router-utils.ts +0 -47
  371. package/src/common/session/common.ts +0 -40
  372. package/src/common/session/index.ts +0 -2
  373. package/src/common/session/service.ts +0 -163
  374. package/src/common/tokenize-match.ts +0 -98
  375. package/src/common/url-utils.ts +0 -46
  376. package/src/index.ts +0 -7
  377. package/src/middleware/buffer.ts +0 -80
  378. package/src/middleware/cookie.ts +0 -20
  379. package/src/middleware/cors.ts +0 -96
  380. package/src/middleware/form.ts +0 -59
  381. package/src/middleware/group.ts +0 -70
  382. package/src/middleware/index.ts +0 -48
  383. package/src/middleware/json.ts +0 -55
  384. package/src/middleware/logger.ts +0 -18
  385. package/src/middleware/parse.ts +0 -94
  386. package/src/middleware/result.ts +0 -63
  387. package/src/middleware/tag.ts +0 -15
  388. package/src/middleware/text.ts +0 -45
  389. package/src/proxy.ts +0 -99
  390. package/src/proxy.unit.test.js +0 -160
  391. package/src/router.ts +0 -134
  392. package/src/router.unit.test.js +0 -412
  393. package/src/static.ts +0 -239
  394. package/test.out.txt +0 -3535
  395. package/tsconfig-esm.json +0 -26
package/README.md CHANGED
@@ -1,207 +1,3 @@
1
1
  # @miqro/core
2
2
 
3
3
  promise based router
4
-
5
- - [router](#router)
6
- - [request parsing](#request-parsing)
7
- - [custom types](#custom-types)
8
- - [static files](#static-files)
9
- - [proxy router](#proxy-router)
10
- - [error handling](#error-handling)
11
- - [apirouter](#apirouter)
12
- - [auto documentation](#auto-documentation)
13
-
14
- ## router
15
-
16
- ```typescript
17
- import {createServer} from "http";
18
- import {Router, JSONParser} from "@miqro/core";
19
-
20
- const router = new Router();
21
-
22
- router.post("/echo", [JSONParser(), async (ctx) => {
23
- // the IncomingMessage is in ctx.req
24
- // the ServerResponse is in ctx.res
25
- ctx.logger.info("we got a echo request hit with query: %o params: %o body: %o", ctx.query, ctx.params, ctx.body);
26
- await ctx.json({
27
- body: ctx.body
28
- });
29
- }]);
30
- router.get("/user/:userId", async (ctx) => {
31
- await ctx.json({
32
- userId: ctx.params.userId
33
- });
34
- });
35
- router.use(async (ctx) => {
36
- await ctx.end({
37
- headers: {
38
- ["Content-Type"]: "plain/text; charset=utf-8"
39
- },
40
- status: 404,
41
- body: "NOT FOUND"
42
- });
43
- });
44
-
45
- const server = createServer(router.listener).listen(8080);
46
- ```
47
-
48
- ### request parsing
49
-
50
- for more examples of parsing see [@miqro/parser](https://www.npmjs.com/package/@miqro/parser)
51
-
52
- ```typescript
53
- router.get("/add/:a/:b", {
54
- request: {
55
- body: false, // do not allow body
56
- params: {
57
- a: "number", // parse param :a to a number if posible if not throw
58
- b: "number", // parse param :b to a number if posible if not throw
59
- },
60
- query: {
61
- decimals: "boolean?|number?", // two optional posible parsing types
62
- format: {
63
- type: "enum?", // optional enum
64
- enumValues: ["number", "text"],
65
- defaultValue: "number"
66
- }
67
- }
68
- },
69
- handler: async (ctx) => {
70
- // ctx.params.a and ctx.params.b are numbers and not strings
71
- const result = ctx.params.a + ctx.params.b;
72
- ctx.logger.info("adding %s + %s = %s", ctx.params.a, ctx.params.b, result);
73
-
74
- const decimals = ctx.query.decimals;
75
-
76
- ctx.info("decimals set on query %s", decimals);
77
-
78
- switch (ctx.query.format) {
79
- case "number":
80
- await ctx.text(result);
81
- break;
82
- case "text":
83
- await ctx.text("the result is " + result);
84
- break;
85
- default:
86
- throw new BadRequest("unsupported format");
87
- }
88
- }
89
- });
90
- ```
91
-
92
- #### custom types
93
-
94
- ```typescript
95
- import {Parser} from "@miqro/parser";
96
-
97
- const parser = new Parser();
98
- parser.registerType("CustomType", {
99
- //...
100
- });
101
- router.get("/add/:a/:b", {
102
- parser,
103
- //...
104
- });
105
- ```
106
-
107
- ### static files
108
-
109
- ```typescript
110
- import {Static} from "@miqro/core";
111
-
112
- router.use(Static({
113
- directory: resolve(__dirname, "static")
114
- }), "/content/public");
115
- ```
116
-
117
- ### proxy router
118
-
119
- ```typescript
120
- import {Proxy} from "@miqro/core";
121
-
122
- router.use(Proxy({
123
- url: "http://otherhost/api/somepath/";
124
- //rejectUnauthorized: false;
125
- }), "/proxy/");
126
- ```
127
-
128
- ### error handling
129
-
130
- ```typescript
131
- router.catch(myFallBackerrorHandler1) // this will catch all throws
132
- router.catch(myFallBackerrorHandler2) // if myFallBackerrorHandler1 didnt ended the request myFallBackerrorHandler2 will be called
133
-
134
- router.use(async (ctx) => {
135
- throw new Error("");
136
- });
137
- ```
138
-
139
- ## apirouter
140
-
141
- for loading full directories with the folders acting as path's
142
-
143
- consider the following directory structure
144
-
145
- ```
146
- api/
147
- v1/
148
- user/
149
- :userId/
150
- get.ts
151
- delete.ts
152
- patch.ts
153
- post.ts
154
- post/
155
- :postId/
156
- get.ts
157
- post.ts
158
- ```
159
-
160
- this will producte the following routes.
161
-
162
- - [GET] /api/v1/user/:userId/
163
- - [DELETE] /api/v1/user/:userId/
164
- - [PATCH] /api/v1/user/:userId/
165
- - [POST] /api/v1/user/
166
-
167
- - [GET] /api/v1/post/
168
- - [POST] /api/v1/post/:postId/
169
-
170
- each file has to implement the ```APIRoute``` interface.
171
-
172
- example
173
-
174
- ```typescript
175
- import {APIRoute} from "@miqro/core";
176
-
177
- export default {
178
- handler: async (ctx) => {
179
-
180
- }
181
- } as APIRoute;
182
- ```
183
-
184
- to load the routes
185
-
186
- ```typescript
187
- import {APIRouter} from "@miqro/core";
188
- import {resolve} from "path";
189
-
190
- const api = await APIRouter({ dirname: resolve("api") });
191
-
192
- app.use(api);
193
- ```
194
-
195
- ### auto documentation
196
-
197
- ```typescript
198
- ...
199
- console.dir(router.getJSONDoc());
200
- ...
201
- ```
202
-
203
- or generate a json
204
-
205
- ```npx miqro doc build/api /api```
206
-
207
- where ```build/api``` is the APIRouter directory
package/build/app.d.ts ADDED
@@ -0,0 +1,23 @@
1
+ /// <reference types="node" resolution-mode="require"/>
2
+ /// <reference types="node" resolution-mode="require"/>
3
+ /// <reference types="node" resolution-mode="require"/>
4
+ import { RequestListener, Server as HttpServer } from "http";
5
+ import { Router } from "./middleware/router.js";
6
+ import { Request, Response, RouterOptions } from "./types.js";
7
+ import { ServerOptions } from "http";
8
+ import { Duplex } from "stream";
9
+ export interface AppOptions extends RouterOptions {
10
+ onUpgrade?: (req: Request, socket: Duplex, head: Buffer) => Promise<void> | void;
11
+ serverOptions: ServerOptions<typeof Request, typeof Response>;
12
+ }
13
+ export declare class App extends Router {
14
+ readonly listener: RequestListener<typeof Request, typeof Response>;
15
+ readonly httpServer: HttpServer<typeof Request, typeof Response>;
16
+ constructor(config?: AppOptions);
17
+ listenSync(...args: any[]): HttpServer<typeof Request, typeof Response>;
18
+ listen(...args: any[]): Promise<HttpServer<typeof Request, typeof Response>>;
19
+ close(): Promise<HttpServer<typeof Request, typeof Response>>;
20
+ closeSync(cb: (err: Error | undefined) => void): void;
21
+ }
22
+ export declare class Server extends App {
23
+ }
package/build/app.js ADDED
@@ -0,0 +1,101 @@
1
+ import { createServer } from "http";
2
+ import { Router } from "./middleware/router.js";
3
+ import { routerDefaultLoggerFactory, defaultAppErrorHandler, HTML_HEADERS, STATUS } from "./common.js";
4
+ export class App extends Router {
5
+ constructor(config) {
6
+ super(config);
7
+ if (config?.serverOptions) {
8
+ this.serverOptions = {
9
+ ...this.serverOptions,
10
+ ...config.serverOptions
11
+ };
12
+ }
13
+ const errorHandler = defaultAppErrorHandler();
14
+ const loggerFactory = this.config && this.config.loggerFactory ? this.config.loggerFactory : routerDefaultLoggerFactory;
15
+ this.listener = async (req, res) => {
16
+ try {
17
+ const logger = loggerFactory(req.uuid, req);
18
+ try {
19
+ req.logger = logger;
20
+ try {
21
+ req.logger.trace(`request received for [%s]`, req.path);
22
+ await this.run(req, res);
23
+ if (!res.headersSent) {
24
+ await res.asyncEnd({
25
+ headers: HTML_HEADERS,
26
+ status: STATUS.NOT_FOUND,
27
+ body: "NOT FOUND"
28
+ });
29
+ }
30
+ }
31
+ catch (e) {
32
+ try {
33
+ if (!res.headersSent) {
34
+ await errorHandler(e, req, res);
35
+ if (!res.headersSent) {
36
+ req.logger.error(e);
37
+ await res.asyncEnd({
38
+ headers: HTML_HEADERS,
39
+ status: STATUS.ERROR,
40
+ body: "SERVER ERROR"
41
+ });
42
+ }
43
+ }
44
+ }
45
+ catch (e3) {
46
+ req.logger.error(e3);
47
+ }
48
+ }
49
+ }
50
+ catch (errorCtx) {
51
+ logger.error(errorCtx);
52
+ }
53
+ }
54
+ catch (loggerError) {
55
+ console.error(loggerError);
56
+ }
57
+ };
58
+ this.httpServer = createServer(this.serverOptions, this.listener);
59
+ if (config?.onUpgrade) {
60
+ this.httpServer.on("upgrade", config.onUpgrade);
61
+ }
62
+ }
63
+ listenSync(...args) {
64
+ return this.httpServer.listen(...args);
65
+ }
66
+ async listen(...args) {
67
+ return new Promise((resolve, reject) => {
68
+ try {
69
+ this.httpServer.listen(...args, () => {
70
+ resolve(this.httpServer);
71
+ });
72
+ }
73
+ catch (e) {
74
+ reject(e);
75
+ }
76
+ });
77
+ }
78
+ async close() {
79
+ return new Promise((resolve, reject) => {
80
+ try {
81
+ this.httpServer.close((err) => {
82
+ if (err) {
83
+ reject(err);
84
+ }
85
+ else {
86
+ resolve(this.httpServer);
87
+ }
88
+ });
89
+ }
90
+ catch (e) {
91
+ reject(e);
92
+ }
93
+ });
94
+ }
95
+ closeSync(cb) {
96
+ this.httpServer.close(cb);
97
+ }
98
+ }
99
+ export class Server extends App {
100
+ }
101
+ //# sourceMappingURL=app.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAyC,MAAM,MAAM,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,0BAA0B,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAUvG,MAAM,OAAO,GAAI,SAAQ,MAAM;IAI7B,YAAY,MAAmB;QAC7B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,MAAM,EAAE,aAAa,EAAE,CAAC;YAC1B,IAAI,CAAC,aAAa,GAAG;gBACnB,GAAG,IAAI,CAAC,aAAa;gBACrB,GAAG,MAAM,CAAC,aAAa;aACxB,CAAC;QACJ,CAAC;QACD,MAAM,YAAY,GAAG,sBAAsB,EAAE,CAAC;QAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,0BAA0B,CAAC;QACxH,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;YACpD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC5C,IAAI,CAAC;oBACH,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;oBACpB,IAAI,CAAC;wBACH,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;wBACxD,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;wBACzB,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;4BACrB,MAAM,GAAG,CAAC,QAAQ,CAAC;gCACjB,OAAO,EAAE,YAAY;gCACrB,MAAM,EAAE,MAAM,CAAC,SAAS;gCACxB,IAAI,EAAE,WAAW;6BAClB,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;oBAAC,OAAO,CAAM,EAAE,CAAC;wBAChB,IAAI,CAAC;4BACH,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;gCACrB,MAAM,YAAY,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;gCAChC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;oCACrB,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oCACpB,MAAM,GAAG,CAAC,QAAQ,CAAC;wCACjB,OAAO,EAAE,YAAY;wCACrB,MAAM,EAAE,MAAM,CAAC,KAAK;wCACpB,IAAI,EAAE,cAAc;qCACrB,CAAC,CAAC;gCACL,CAAC;4BACH,CAAC;wBACH,CAAC;wBAAC,OAAO,EAAE,EAAE,CAAC;4BACZ,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;wBACvB,CAAC;oBACH,CAAC;gBACH,CAAC;gBAAC,OAAO,QAAQ,EAAE,CAAC;oBAClB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACzB,CAAC;YACH,CAAC;YAAC,OAAO,WAAW,EAAE,CAAC;gBACrB,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,YAAY,CAAkC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnG,IAAI,MAAM,EAAE,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAEM,UAAU,CAAC,GAAG,IAAW;QAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAA;IACxC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAG,IAAW;QAChC,OAAO,IAAI,OAAO,CAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACjD,IAAI,CAAC;gBACH,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE;oBACnC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAC3B,CAAC,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,CAAC,CAAC,CAAC,CAAC;YACZ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,OAAO,IAAI,OAAO,CAA8C,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAClF,IAAI,CAAC;gBACH,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;oBAC5B,IAAI,GAAG,EAAE,CAAC;wBACR,MAAM,CAAC,GAAG,CAAC,CAAC;oBACd,CAAC;yBAAM,CAAC;wBACN,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBAC3B,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,CAAC,CAAC,CAAC,CAAC;YACZ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,SAAS,CAAC,EAAoC;QACnD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,MAAO,SAAQ,GAAG;CAC9B"}
@@ -0,0 +1,106 @@
1
+ /// <reference types="node" resolution-mode="require"/>
2
+ /// <reference types="node" resolution-mode="require"/>
3
+ import { IncomingMessage } from "http";
4
+ import { ConfigOutput, ErrorHandler, Handler, LoadConfigOut, LogLevel, LoggerFactory, LoggerFormatter, LoggerTransport, LoggerTransportWriteArgs, MinimalLogger, Request, WriteArgs } from "./types.js";
5
+ /**
6
+ * Logger
7
+ */
8
+ export declare function LoggerHandler(options?: {
9
+ formatter: (req: Request) => string;
10
+ }): Handler<void>;
11
+ export interface Logger extends MinimalLogger {
12
+ addTransport(transport: LoggerTransport): void;
13
+ setLevel(level: LogLevel): void;
14
+ }
15
+ export declare class Logger extends EventTarget implements Logger {
16
+ protected readonly identifier: string;
17
+ protected level: LogLevel;
18
+ protected readonly options: {
19
+ transports: LoggerTransport[];
20
+ formatter: LoggerFormatter;
21
+ };
22
+ constructor(identifier: string, level?: LogLevel, options?: {
23
+ transports?: LoggerTransport[];
24
+ formatter?: LoggerFormatter;
25
+ });
26
+ protected write(args: WriteArgs): void;
27
+ debug(message?: any, ...optionalParams: any[]): void;
28
+ error(message?: any, ...optionalParams: any[]): void;
29
+ info(message?: any, ...optionalParams: any[]): void;
30
+ log(message?: any, ...optionalParams: any[]): void;
31
+ trace(message?: any, ...optionalParams: any[]): void;
32
+ warn(message?: any, ...optionalParams: any[]): void;
33
+ }
34
+ export declare const FileTransport: (filePath?: string | null, level?: LogLevel) => LoggerTransport;
35
+ export declare function ConsoleTransport(color?: boolean, level?: LogLevel): {
36
+ level: LogLevel | undefined;
37
+ write: ({ level, out }: LoggerTransportWriteArgs) => Promise<void>;
38
+ };
39
+ export declare const DEFAULT_LOGGER_TRANSPORTS: () => LoggerTransport[];
40
+ export declare const DEFAULT_LOGGER_FORMATTER: LoggerFormatter;
41
+ export declare const LOG_LEVEL_MAP: {
42
+ none: number;
43
+ error: number;
44
+ warn: number;
45
+ info: number;
46
+ debug: number;
47
+ trace: number;
48
+ };
49
+ export declare const LoggerEvents: {
50
+ error: string;
51
+ };
52
+ export declare function getLogger(identifier: string, options?: {
53
+ formatter?: LoggerFormatter;
54
+ transports?: LoggerTransport[];
55
+ }, useCache?: boolean): MinimalLogger;
56
+ export declare function setLoggerFactory(factory: LoggerFactory): LoggerFactory;
57
+ export declare function getLoggerFactory(): LoggerFactory;
58
+ export declare function routerDefaultLoggerFactory(uuid: string, req: IncomingMessage): MinimalLogger;
59
+ /**
60
+ * Error
61
+ */
62
+ export declare class BadRequestError extends Error {
63
+ constructor(message?: string);
64
+ }
65
+ export declare class ConfigFileNotFoundError extends Error {
66
+ constructor(message?: string);
67
+ }
68
+ export declare class ForbiddenError extends Error {
69
+ constructor(message?: string);
70
+ }
71
+ export declare class NotFoundError extends Error {
72
+ constructor(message?: string);
73
+ }
74
+ export declare class MethodNotImplementedError extends Error {
75
+ constructor(message?: string);
76
+ }
77
+ export declare class UnAuthorizedError extends Error {
78
+ constructor(message?: string);
79
+ }
80
+ export declare const HTML_HEADERS: {
81
+ "Content-Type": string;
82
+ };
83
+ export declare const STATUS: {
84
+ ERROR: number;
85
+ BAD_REQUEST: number;
86
+ NOT_FOUND: number;
87
+ NOT_IMPLEMENTED: number;
88
+ FORBIDDEN: number;
89
+ UNAUTHORIZED: number;
90
+ };
91
+ export declare function defaultAppErrorHandler(): ErrorHandler<void>;
92
+ /**
93
+ * config loading
94
+ */
95
+ export declare abstract class ConfigPathResolver {
96
+ static getSequelizeRCFilePath(): string;
97
+ static getConfigDirname(): string;
98
+ static getBaseDirname(): string;
99
+ }
100
+ export declare const checkEnvVariables: (requiredEnvVariables: string[], defaults?: string[]) => string[];
101
+ export declare const checkEnvVariable: (envName: string, defaults?: string) => string;
102
+ export declare const getEnvVariable: (envName: string, defaults?: string) => string | undefined;
103
+ export declare const isFeatureEnabled: (feature: string, defaults?: boolean) => boolean;
104
+ export declare const loadConfigString: (envFileContent: string, combined?: ConfigOutput) => ConfigOutput;
105
+ export declare const loadConfigFile: (envFilePath: string, combined?: ConfigOutput, logger?: Logger) => ConfigOutput;
106
+ export declare const loadConfig: (configDirname?: string, logger?: Logger) => LoadConfigOut;