@miqro/core 1.3.11 → 1.5.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 (317) hide show
  1. package/README.md +16 -61
  2. package/dist/api-router.d.ts +36 -0
  3. package/dist/{handler/api-router.js → api-router.js} +1 -2
  4. package/dist/{handler/app.d.ts → app.d.ts} +1 -2
  5. package/dist/{handler/app.js → app.js} +10 -11
  6. package/dist/common/api-router-helpers.d.ts +31 -0
  7. package/dist/common/api-router-helpers.js +2 -0
  8. package/dist/{handler → common}/api-router-utils.d.ts +7 -6
  9. package/dist/{handler → common}/api-router-utils.js +4 -5
  10. package/dist/{util → common}/config/config.d.ts +4 -4
  11. package/dist/{util → common}/config/config.js +31 -29
  12. package/dist/{util → common}/config/featuretoggle.d.ts +0 -0
  13. package/dist/{util → common}/config/featuretoggle.js +0 -1
  14. package/dist/{util → common}/config/index.d.ts +1 -1
  15. package/dist/{util → common}/config/index.js +1 -2
  16. package/dist/common/config/loader.d.ts +13 -0
  17. package/dist/{util/loader/index.js → common/config/loader.js} +11 -6
  18. package/dist/{handler/common → common}/context.d.ts +5 -5
  19. package/dist/{handler/common → common}/context.js +3 -17
  20. package/dist/common/error/badrequesterror.d.ts +3 -0
  21. package/dist/common/error/badrequesterror.js +10 -0
  22. package/dist/common/error/configfilenotfound.d.ts +3 -0
  23. package/dist/{util → common}/error/configfilenotfound.js +1 -3
  24. package/dist/common/error/forbiddenerror.d.ts +3 -0
  25. package/dist/{util → common}/error/forbiddenerror.js +1 -3
  26. package/dist/{util → common}/error/index.d.ts +1 -1
  27. package/dist/{util → common}/error/index.js +1 -2
  28. package/dist/common/error/notfound.d.ts +3 -0
  29. package/dist/{util → common}/error/notfound.js +1 -3
  30. package/dist/common/error/notimplemented.d.ts +3 -0
  31. package/dist/{util → common}/error/notimplemented.js +1 -3
  32. package/dist/common/error/unauthorizederror.d.ts +3 -0
  33. package/dist/{util → common}/error/unauthorizederror.js +1 -3
  34. package/dist/{handler/common → common}/helpers.d.ts +0 -0
  35. package/dist/{handler/common → common}/helpers.js +0 -1
  36. package/dist/{util → common}/index.d.ts +5 -5
  37. package/dist/{util → common}/index.js +5 -6
  38. package/dist/{util → common}/logger/common.d.ts +0 -0
  39. package/dist/{util → common}/logger/common.js +0 -1
  40. package/dist/{util → common}/logger/factory.d.ts +0 -0
  41. package/dist/{util → common}/logger/factory.js +8 -3
  42. package/dist/{util → common}/logger/formatter.d.ts +0 -0
  43. package/dist/{util → common}/logger/formatter.js +0 -1
  44. package/dist/{util → common}/logger/index.d.ts +1 -1
  45. package/dist/{util → common}/logger/index.js +1 -1
  46. package/dist/{util → common}/logger/logger.d.ts +0 -0
  47. package/dist/{util → common}/logger/logger.js +0 -1
  48. package/dist/{util → common}/logger/transport.d.ts +0 -0
  49. package/dist/{util → common}/logger/transport.js +2 -3
  50. package/dist/{util → common}/parser/common.d.ts +0 -0
  51. package/dist/{util/session → common/parser}/common.js +0 -1
  52. package/dist/common/parser/error.d.ts +4 -0
  53. package/dist/common/parser/error.js +11 -0
  54. package/dist/{util → common}/parser/get.d.ts +0 -0
  55. package/dist/{util → common}/parser/get.js +1 -2
  56. package/dist/common/parser/helpers.d.ts +1 -0
  57. package/dist/common/parser/helpers.js +9 -0
  58. package/dist/{util → common}/parser/index.d.ts +1 -0
  59. package/dist/{util → common}/parser/index.js +1 -1
  60. package/dist/{util → common}/parser/parser.d.ts +0 -0
  61. package/dist/{util → common}/parser/parser.js +1 -2
  62. package/dist/{util → common}/parser/types/any.d.ts +0 -0
  63. package/dist/{util → common}/parser/types/any.js +0 -1
  64. package/dist/{util → common}/parser/types/array.d.ts +0 -0
  65. package/dist/{util → common}/parser/types/array.js +0 -1
  66. package/dist/{util → common}/parser/types/boolean.d.ts +0 -0
  67. package/dist/{util → common}/parser/types/boolean.js +0 -1
  68. package/dist/{util → common}/parser/types/email.d.ts +0 -0
  69. package/dist/{util → common}/parser/types/email.js +0 -1
  70. package/dist/{util → common}/parser/types/enum.d.ts +0 -0
  71. package/dist/{util → common}/parser/types/enum.js +1 -2
  72. package/dist/{util → common}/parser/types/index.d.ts +0 -0
  73. package/dist/{util → common}/parser/types/index.js +0 -1
  74. package/dist/{util → common}/parser/types/multiple.d.ts +0 -0
  75. package/dist/{util → common}/parser/types/multiple.js +1 -2
  76. package/dist/{util → common}/parser/types/nested.d.ts +0 -0
  77. package/dist/{util → common}/parser/types/nested.js +1 -2
  78. package/dist/{util → common}/parser/types/number.d.ts +0 -0
  79. package/dist/{util → common}/parser/types/number.js +0 -1
  80. package/dist/{util → common}/parser/types/object.d.ts +0 -0
  81. package/dist/{util → common}/parser/types/object.js +0 -1
  82. package/dist/{util → common}/parser/types/regex.d.ts +0 -0
  83. package/dist/{util → common}/parser/types/regex.js +1 -2
  84. package/dist/{util → common}/parser/types/string.d.ts +0 -0
  85. package/dist/{util → common}/parser/types/string.js +0 -1
  86. package/dist/{util → common}/parser/types/url.d.ts +0 -0
  87. package/dist/{util → common}/parser/types/url.js +1 -2
  88. package/dist/common/router-helpers.d.ts +3 -0
  89. package/dist/common/router-helpers.js +21 -0
  90. package/dist/common/router-utils.d.ts +33 -0
  91. package/dist/common/router-utils.js +62 -0
  92. package/dist/{handler/middleware/session.d.ts → common/session/common.d.ts} +16 -3
  93. package/dist/{util/parser → common/session}/common.js +0 -1
  94. package/dist/{util → common}/session/index.d.ts +0 -0
  95. package/dist/{util → common}/session/index.js +0 -1
  96. package/dist/{util → common}/session/service.d.ts +2 -2
  97. package/dist/{util → common}/session/service.js +2 -3
  98. package/dist/{handler/common → common}/tokenize-match.d.ts +0 -0
  99. package/dist/{handler/common → common}/tokenize-match.js +0 -1
  100. package/dist/index.d.ts +6 -3
  101. package/dist/index.js +6 -4
  102. package/dist/{handler/middleware → middleware}/buffer.d.ts +0 -0
  103. package/dist/middleware/buffer.js +79 -0
  104. package/dist/{handler/middleware → middleware}/cookie.d.ts +0 -0
  105. package/dist/{handler/middleware → middleware}/cookie.js +1 -2
  106. package/dist/{handler/middleware → middleware}/cors.d.ts +0 -0
  107. package/dist/{handler/middleware → middleware}/cors.js +4 -6
  108. package/dist/{handler/middleware → middleware}/form.d.ts +0 -0
  109. package/dist/{handler/middleware → middleware}/form.js +5 -7
  110. package/dist/middleware/group.d.ts +2 -0
  111. package/dist/{handler/middleware → middleware}/group.js +7 -8
  112. package/dist/{handler/middleware → middleware}/index.d.ts +0 -0
  113. package/dist/{handler/middleware → middleware}/index.js +8 -9
  114. package/dist/{handler/middleware → middleware}/json.d.ts +0 -0
  115. package/dist/{handler/middleware → middleware}/json.js +6 -8
  116. package/dist/{handler/middleware → middleware}/logger.d.ts +0 -0
  117. package/dist/{handler/middleware → middleware}/logger.js +1 -2
  118. package/dist/{handler/middleware → middleware}/parse.d.ts +1 -3
  119. package/dist/{handler/middleware → middleware}/parse.js +3 -4
  120. package/dist/middleware/session.d.ts +2 -0
  121. package/dist/{handler/middleware → middleware}/session.js +11 -14
  122. package/dist/{handler/middleware → middleware}/tag.d.ts +0 -0
  123. package/dist/{handler/middleware → middleware}/tag.js +1 -2
  124. package/dist/{handler/middleware → middleware}/text.d.ts +0 -0
  125. package/dist/{handler/middleware → middleware}/text.js +5 -7
  126. package/dist/{handler/proxy.d.ts → proxy.d.ts} +1 -1
  127. package/dist/{handler/proxy.js → proxy.js} +3 -4
  128. package/dist/{handler/common/router.d.ts → router.d.ts} +31 -7
  129. package/dist/{handler/common/router-utils.js → router.js} +101 -73
  130. package/package.json +11 -15
  131. package/dist/handler/api-router-utils.js.map +0 -1
  132. package/dist/handler/api-router.d.ts +0 -70
  133. package/dist/handler/api-router.js.map +0 -1
  134. package/dist/handler/app.js.map +0 -1
  135. package/dist/handler/common/context.js.map +0 -1
  136. package/dist/handler/common/helpers.js.map +0 -1
  137. package/dist/handler/common/index.d.ts +0 -2
  138. package/dist/handler/common/index.js +0 -15
  139. package/dist/handler/common/index.js.map +0 -1
  140. package/dist/handler/common/router-utils.d.ts +0 -59
  141. package/dist/handler/common/router-utils.js.map +0 -1
  142. package/dist/handler/common/router.js +0 -93
  143. package/dist/handler/common/router.js.map +0 -1
  144. package/dist/handler/common/tokenize-match.js.map +0 -1
  145. package/dist/handler/index.d.ts +0 -5
  146. package/dist/handler/index.js +0 -18
  147. package/dist/handler/index.js.map +0 -1
  148. package/dist/handler/middleware/buffer.js +0 -79
  149. package/dist/handler/middleware/buffer.js.map +0 -1
  150. package/dist/handler/middleware/cookie.js.map +0 -1
  151. package/dist/handler/middleware/cors.js.map +0 -1
  152. package/dist/handler/middleware/form.js.map +0 -1
  153. package/dist/handler/middleware/group.d.ts +0 -3
  154. package/dist/handler/middleware/group.js.map +0 -1
  155. package/dist/handler/middleware/index.js.map +0 -1
  156. package/dist/handler/middleware/json.js.map +0 -1
  157. package/dist/handler/middleware/logger.js.map +0 -1
  158. package/dist/handler/middleware/parse.js.map +0 -1
  159. package/dist/handler/middleware/session.js.map +0 -1
  160. package/dist/handler/middleware/tag.js.map +0 -1
  161. package/dist/handler/middleware/text.js.map +0 -1
  162. package/dist/handler/proxy.js.map +0 -1
  163. package/dist/index.js.map +0 -1
  164. package/dist/test/common/app.d.ts +0 -3
  165. package/dist/test/common/app.js +0 -51
  166. package/dist/test/common/app.js.map +0 -1
  167. package/dist/test/common/common.d.ts +0 -6
  168. package/dist/test/common/common.js +0 -15
  169. package/dist/test/common/common.js.map +0 -1
  170. package/dist/test/common/index.d.ts +0 -3
  171. package/dist/test/common/index.js +0 -16
  172. package/dist/test/common/index.js.map +0 -1
  173. package/dist/test/common/runner.d.ts +0 -28
  174. package/dist/test/common/runner.js +0 -88
  175. package/dist/test/common/runner.js.map +0 -1
  176. package/dist/test/index.d.ts +0 -1
  177. package/dist/test/index.js +0 -14
  178. package/dist/test/index.js.map +0 -1
  179. package/dist/test/main.d.ts +0 -1
  180. package/dist/test/main.js +0 -31
  181. package/dist/test/main.js.map +0 -1
  182. package/dist/util/cli/index.d.ts +0 -16
  183. package/dist/util/cli/index.js +0 -84
  184. package/dist/util/cli/index.js.map +0 -1
  185. package/dist/util/config/browser.d.ts +0 -1
  186. package/dist/util/config/browser.js +0 -10
  187. package/dist/util/config/browser.js.map +0 -1
  188. package/dist/util/config/config.js.map +0 -1
  189. package/dist/util/config/featuretoggle.js.map +0 -1
  190. package/dist/util/config/index.js.map +0 -1
  191. package/dist/util/error/configfilenotfound.d.ts +0 -4
  192. package/dist/util/error/configfilenotfound.js.map +0 -1
  193. package/dist/util/error/forbiddenerror.d.ts +0 -4
  194. package/dist/util/error/forbiddenerror.js.map +0 -1
  195. package/dist/util/error/index.js.map +0 -1
  196. package/dist/util/error/named.d.ts +0 -3
  197. package/dist/util/error/named.js +0 -11
  198. package/dist/util/error/named.js.map +0 -1
  199. package/dist/util/error/notfound.d.ts +0 -4
  200. package/dist/util/error/notfound.js.map +0 -1
  201. package/dist/util/error/notimplemented.d.ts +0 -4
  202. package/dist/util/error/notimplemented.js.map +0 -1
  203. package/dist/util/error/parsererror.d.ts +0 -8
  204. package/dist/util/error/parsererror.js +0 -20
  205. package/dist/util/error/parsererror.js.map +0 -1
  206. package/dist/util/error/unauthorizederror.d.ts +0 -4
  207. package/dist/util/error/unauthorizederror.js.map +0 -1
  208. package/dist/util/index.js.map +0 -1
  209. package/dist/util/loader/index.d.ts +0 -4
  210. package/dist/util/loader/index.js.map +0 -1
  211. package/dist/util/logger/common.js.map +0 -1
  212. package/dist/util/logger/factory.js.map +0 -1
  213. package/dist/util/logger/formatter.js.map +0 -1
  214. package/dist/util/logger/index.js.map +0 -1
  215. package/dist/util/logger/logger.js.map +0 -1
  216. package/dist/util/logger/transport.js.map +0 -1
  217. package/dist/util/parser/common.js.map +0 -1
  218. package/dist/util/parser/get.js.map +0 -1
  219. package/dist/util/parser/index.js.map +0 -1
  220. package/dist/util/parser/parser.js.map +0 -1
  221. package/dist/util/parser/types/any.js.map +0 -1
  222. package/dist/util/parser/types/array.js.map +0 -1
  223. package/dist/util/parser/types/boolean.js.map +0 -1
  224. package/dist/util/parser/types/email.js.map +0 -1
  225. package/dist/util/parser/types/enum.js.map +0 -1
  226. package/dist/util/parser/types/index.js.map +0 -1
  227. package/dist/util/parser/types/multiple.js.map +0 -1
  228. package/dist/util/parser/types/nested.js.map +0 -1
  229. package/dist/util/parser/types/number.js.map +0 -1
  230. package/dist/util/parser/types/object.js.map +0 -1
  231. package/dist/util/parser/types/regex.js.map +0 -1
  232. package/dist/util/parser/types/string.js.map +0 -1
  233. package/dist/util/parser/types/url.js.map +0 -1
  234. package/dist/util/request/common.d.ts +0 -57
  235. package/dist/util/request/common.js +0 -146
  236. package/dist/util/request/common.js.map +0 -1
  237. package/dist/util/request/index.d.ts +0 -4
  238. package/dist/util/request/index.js +0 -231
  239. package/dist/util/request/index.js.map +0 -1
  240. package/dist/util/session/common.d.ts +0 -15
  241. package/dist/util/session/common.js.map +0 -1
  242. package/dist/util/session/index.js.map +0 -1
  243. package/dist/util/session/service.js.map +0 -1
  244. package/src/handler/api-router-utils.ts +0 -187
  245. package/src/handler/api-router.ts +0 -86
  246. package/src/handler/app.ts +0 -133
  247. package/src/handler/common/context.ts +0 -156
  248. package/src/handler/common/helpers.ts +0 -11
  249. package/src/handler/common/index.ts +0 -3
  250. package/src/handler/common/router-utils.ts +0 -239
  251. package/src/handler/common/router.ts +0 -98
  252. package/src/handler/common/tokenize-match.ts +0 -152
  253. package/src/handler/index.ts +0 -5
  254. package/src/handler/middleware/buffer.ts +0 -79
  255. package/src/handler/middleware/cookie.ts +0 -19
  256. package/src/handler/middleware/cors.ts +0 -98
  257. package/src/handler/middleware/form.ts +0 -59
  258. package/src/handler/middleware/group.ts +0 -70
  259. package/src/handler/middleware/index.ts +0 -48
  260. package/src/handler/middleware/json.ts +0 -56
  261. package/src/handler/middleware/logger.ts +0 -18
  262. package/src/handler/middleware/parse.ts +0 -93
  263. package/src/handler/middleware/session.ts +0 -155
  264. package/src/handler/middleware/tag.ts +0 -15
  265. package/src/handler/middleware/text.ts +0 -47
  266. package/src/handler/proxy.ts +0 -39
  267. package/src/index.ts +0 -3
  268. package/src/test/common/app.ts +0 -45
  269. package/src/test/common/common.ts +0 -17
  270. package/src/test/common/index.ts +0 -3
  271. package/src/test/common/runner.ts +0 -116
  272. package/src/test/index.ts +0 -1
  273. package/src/test/main.ts +0 -32
  274. package/src/util/cli/index.ts +0 -80
  275. package/src/util/config/browser.ts +0 -5
  276. package/src/util/config/config.ts +0 -93
  277. package/src/util/config/featuretoggle.ts +0 -6
  278. package/src/util/config/index.ts +0 -3
  279. package/src/util/error/configfilenotfound.ts +0 -8
  280. package/src/util/error/forbiddenerror.ts +0 -8
  281. package/src/util/error/index.ts +0 -6
  282. package/src/util/error/named.ts +0 -3
  283. package/src/util/error/notfound.ts +0 -8
  284. package/src/util/error/notimplemented.ts +0 -8
  285. package/src/util/error/parsererror.ts +0 -15
  286. package/src/util/error/unauthorizederror.ts +0 -8
  287. package/src/util/index.ts +0 -8
  288. package/src/util/loader/index.ts +0 -61
  289. package/src/util/logger/common.ts +0 -6
  290. package/src/util/logger/factory.ts +0 -45
  291. package/src/util/logger/formatter.ts +0 -9
  292. package/src/util/logger/index.ts +0 -6
  293. package/src/util/logger/logger.ts +0 -114
  294. package/src/util/logger/transport.ts +0 -69
  295. package/src/util/parser/common.ts +0 -81
  296. package/src/util/parser/get.ts +0 -40
  297. package/src/util/parser/index.ts +0 -6
  298. package/src/util/parser/parser.ts +0 -235
  299. package/src/util/parser/types/any.ts +0 -8
  300. package/src/util/parser/types/array.ts +0 -73
  301. package/src/util/parser/types/boolean.ts +0 -13
  302. package/src/util/parser/types/email.ts +0 -26
  303. package/src/util/parser/types/enum.ts +0 -29
  304. package/src/util/parser/types/index.ts +0 -12
  305. package/src/util/parser/types/multiple.ts +0 -36
  306. package/src/util/parser/types/nested.ts +0 -19
  307. package/src/util/parser/types/number.ts +0 -34
  308. package/src/util/parser/types/object.ts +0 -10
  309. package/src/util/parser/types/regex.ts +0 -17
  310. package/src/util/parser/types/string.ts +0 -23
  311. package/src/util/parser/types/url.ts +0 -35
  312. package/src/util/request/common.ts +0 -193
  313. package/src/util/request/index.ts +0 -230
  314. package/src/util/session/common.ts +0 -20
  315. package/src/util/session/index.ts +0 -2
  316. package/src/util/session/service.ts +0 -154
  317. package/tsconfig.json +0 -32
@@ -1,133 +0,0 @@
1
- import { createServer, RequestListener, Server } from "http";
2
- import { Router, Context, ErrorHandler, RouterOptions } from "./common";
3
-
4
- export class App extends Router {
5
- public readonly listener: RequestListener;
6
-
7
- constructor(config?: RouterOptions) {
8
- super(config);
9
- const errorHandler = DefaultErrorHandler();
10
- this.listener = async (req, res) => {
11
- const ctx = this.config && this.config.newContext ?
12
- this.config.newContext(req, res) :
13
- new Context(
14
- req,
15
- res,
16
- this.config && this.config.newRequestLogger ?
17
- this.config.newRequestLogger(req) :
18
- undefined);
19
- ctx.logger.trace(`request received`);
20
- try {
21
- await this.run(ctx);
22
- if (!ctx.res.headersSent) {
23
- ctx.end({
24
- headers: TEXT_HEADERS,
25
- status: STATUS.NOT_FOUND,
26
- body: "NOT FOUND"
27
- });
28
- }
29
- } catch (e: any) {
30
- try {
31
- if (!ctx.res.headersSent) {
32
- await errorHandler(e, ctx);
33
- if (!ctx.res.headersSent) {
34
- ctx.logger.error(e);
35
- ctx.end({
36
- headers: TEXT_HEADERS,
37
- status: STATUS.ERROR,
38
- body: "SERVER ERROR"
39
- });
40
- }
41
- }
42
- } catch (e3) {
43
- ctx.logger.error(e3);
44
- }
45
- }
46
- };
47
- }
48
- public listen(...args: any[]): Server {
49
- return createServer(this.listener).listen(...args)
50
- }
51
- }
52
-
53
- const TEXT_HEADERS = {
54
- ["Content-Type"]: "plain/text; charset=utf-8"
55
- }
56
-
57
- const STATUS = {
58
- ERROR: 503,
59
- BAD_REQUEST: 400,
60
- NOT_FOUND: 404,
61
- NOT_IMPLEMENTED: 501,
62
- FORBIDDEN: 403,
63
- UNAUTHORIZED: 401,
64
- };
65
-
66
- export const DefaultErrorHandler = (): ErrorHandler<boolean> => {
67
- return async (e: any, ctx: Context): Promise<boolean> => {
68
- if (!e || !e.name || e.name === "Error") {
69
- if (process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test") {
70
- ctx.logger.error(e);
71
- await ctx.end({
72
- headers: TEXT_HEADERS,
73
- status: STATUS.ERROR,
74
- body: `${e && e.message ? e.message : String(e)}. You are seeing this message because NODE_ENV === "development" || NODE_ENV === "test"${e && e.stack ? ` ${e.stack}` : ""}`
75
- });
76
- return false;
77
- }
78
- } else {
79
- ctx.logger.error(e);
80
- const name = e && e.name ? e.name : undefined;
81
- switch (name) {
82
- case "NotFoundError":
83
- await ctx.end({
84
- headers: TEXT_HEADERS,
85
- status: STATUS.NOT_FOUND,
86
- body: e.message ? e.message : "NOT FOUND"
87
- });
88
- break;
89
- case "MethodNotImplementedError":
90
- await ctx.end({
91
- headers: TEXT_HEADERS,
92
- status: STATUS.NOT_IMPLEMENTED,
93
- body: e.message ? e.message : "NOT IMPLEMENTED"
94
- });
95
- break;
96
- case "ForbiddenError":
97
- await ctx.end({
98
- headers: TEXT_HEADERS,
99
- status: STATUS.FORBIDDEN,
100
- body: e.message ? e.message : "FORBIDDEN"
101
- });
102
- break;
103
- case "UnAuthorizedError":
104
- await ctx.end({
105
- headers: TEXT_HEADERS,
106
- status: STATUS.UNAUTHORIZED,
107
- body: e.message ? e.message : "UNAUTHORIZED"
108
- });
109
- break;
110
- case "ParseOptionsError":
111
- case "BadRequestError":
112
- case "SequelizeValidationError":
113
- case "SequelizeEagerLoadingError":
114
- case "SequelizeUniqueConstraintError":
115
- await ctx.end({
116
- headers: TEXT_HEADERS,
117
- status: STATUS.BAD_REQUEST,
118
- body: e.message ? e.message : "BAD REQUEST"
119
- });
120
- break;
121
- default:
122
- await ctx.end({
123
- headers: TEXT_HEADERS,
124
- status: STATUS.ERROR,
125
- body: e.message ? e.message : "SERVER ERROR"
126
- });
127
- break;
128
- }
129
- return false;
130
- }
131
- return true;
132
- };
133
- };
@@ -1,156 +0,0 @@
1
- import { getLogger, Logger } from "../../util/logger";
2
- import { Session } from "../../util/session";
3
- import { IncomingHttpHeaders, IncomingMessage, OutgoingHttpHeaders, ServerResponse } from "http";
4
- import { normalizePath, parseSearchParams } from "./tokenize-match";
5
- import { URL } from "url";
6
- import { defaultLoggerFormatter } from "../../util/logger/formatter";
7
- import { newURL } from "./helpers";
8
- import { v4 } from "uuid";
9
- import { CookieSerializeOptions, serialize } from "cookie";
10
-
11
- export type Method = "get" | "post" | "put" | "delete" | "patch" | "options" | "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
12
-
13
- //export { BAD_REQUEST, METHOD_NOT_IMPLEMENTED, NOT_FOUND, ERROR_RESPONSE, FORBIDDEN, Response, UNAUTHORIZED } from "./response";
14
-
15
- export type Handler<T = boolean | void | any> = ((ctx: Context) => Promise<T>) | ((ctx: Context) => T);
16
-
17
- export type ErrorHandler<T = boolean | void | any> = ((e: unknown, ctx: Context) => Promise<T>) | ((e: unknown, ctx: Context) => T);
18
-
19
- export class Context {
20
- public readonly url: URL; // new URL(req.url ? req.url : "/", `http://${req.headers.host}`)
21
- public readonly logger: Logger; // new Logger(...)
22
- public readonly startMS: number; // Date.now()
23
- public uuid: string; // a middleware will fill this
24
- public session?: Session; // a middleware will fill this
25
- public results: any[]; // handlers will fill this
26
- public readonly path: string; // normalized path
27
- public readonly hash: string; // from this.url.hash
28
- public readonly method: string; // from this.url.method
29
- public headers: IncomingHttpHeaders; // from this.req.headers
30
- public readonly cookies: { [name: string]: string }; // a middleware will fill this
31
- public query: { [name: string]: string | string[] }; // parseSearchParams will fill this with this.url.searchParams
32
- public params: { [name: string]: string | undefined } = {}; // the router will fill this
33
- public buffer?: Buffer; // empty buffer. middleware must read it
34
- public readonly remoteAddress?: string;
35
- public body: any; // a middleware will fill this reading the buffer
36
- constructor(public readonly req: IncomingMessage, public readonly res: ServerResponse, logger?: Logger) {
37
- this.body = undefined as any;
38
- this.res.removeHeader("Date");
39
- this.url = newURL(req.url ? req.url : "/", `http://${req.headers.host}`) as URL;
40
- this.method = req.method ? req.method.toUpperCase() as string : "GET";
41
- this.path = normalizePath(this.url.pathname); // normalized path
42
- this.hash = this.url.hash;
43
- this.query = parseSearchParams(this.url.searchParams);
44
- //this.buffer = Buffer.from("");
45
- this.remoteAddress = req.socket.remoteAddress;
46
- this.cookies = {}; // a middleware will fill
47
- this.headers = req.headers;
48
- this.startMS = Date.now();
49
- this.uuid = v4().toString();
50
- this.results = []; // handlers will fill this
51
- const pathToEnv = this.path.replace(/\//ig, "_").toUpperCase();
52
- const identifier = `${pathToEnv === "_" ? "" : pathToEnv.substring(1)}${this.method.toUpperCase()}`;
53
- this.logger = logger ? logger : getLogger(identifier, {
54
- formatter: ({
55
- identifier,
56
- level,
57
- message,
58
- }) => defaultLoggerFormatter({
59
- identifier,
60
- level,
61
- message: `${this.method} ${this.url}${this.uuid ? ` [${this.uuid}]` : ""}${this.remoteAddress ? ` (${this.remoteAddress})` : ""}${this.session ?
62
- ` session[${this.session.username}:${this.session.account}]` :
63
- ""
64
- } ${message}`
65
- })
66
- }, false);
67
- }
68
- public async close(): Promise<void> {
69
- return this.end({
70
- status: 400,
71
- headers: {
72
- connection: "close"
73
- }
74
- });
75
- }
76
- public addVaryHeader(value: number | string | ReadonlyArray<string>): ServerResponse {
77
- const c = this.res.getHeader("Vary");
78
- const current = c ? c instanceof Array ? c.join(", ") : String(c) : "";
79
- const nV = value instanceof Array ? value.join(", ") : String(value);
80
- const newValue = current ? `${current}, ${nV}` : nV;
81
- return this.res.setHeader("Vary", newValue.indexOf("*") !== -1 ? "*" : newValue);
82
- }
83
- public setHeader(name: string, value: number | string | ReadonlyArray<string>): ServerResponse {
84
- return this.res.setHeader(name, value);
85
- }
86
- public setCookie(name: string, value: string, options?: CookieSerializeOptions): ServerResponse {
87
- return this.setHeader('Set-Cookie', serialize(name, String(value), options));
88
- }
89
- public async end({ status, headers, body }: {
90
- body?: any;
91
- status: number;
92
- headers: OutgoingHttpHeaders;
93
- }): Promise<void> {
94
- return new Promise<void>((resolve, reject) => {
95
- try {
96
- if (this.res.headersSent) {
97
- reject(new Error("already ended"));
98
- } else {
99
- this.res.statusCode = status;
100
- const keys = Object.keys(headers);
101
- for (const key of keys) {
102
- if (headers[key] !== undefined) {
103
- this.res.setHeader(key, headers[key] as any);
104
- }
105
- }
106
- this.res.end(body !== undefined ? String(body) : undefined, () => {
107
- resolve();
108
- });
109
- }
110
- } catch (e) {
111
- reject(e);
112
- }
113
- });
114
- }
115
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
116
- public async json(body: any, headers?: OutgoingHttpHeaders, status?: number): Promise<void> {
117
- return this.end({
118
- status: status !== undefined ? status : 200,
119
- headers: {
120
- ['Content-Type']: 'application/json; charset=utf-8',
121
- ...headers,
122
- },
123
- body: JSON.stringify(body)
124
- })
125
- }
126
- public async text(text: string, headers?: OutgoingHttpHeaders, status?: number): Promise<void> {
127
- return this.end({
128
- status: status !== undefined ? status : 200,
129
- headers: {
130
- ['Content-Type']: 'plain/text; charset=utf-8',
131
- ...headers
132
- },
133
- body: text
134
- });
135
- }
136
- public async html(html: string, headers?: OutgoingHttpHeaders, status?: number): Promise<void> {
137
- return this.end({
138
- status: status !== undefined ? status : 200,
139
- headers: {
140
- ['Content-Type']: 'text/html; charset=utf-8',
141
- ...headers
142
- },
143
- body: html
144
- })
145
- }
146
- public async redirect(url: string, headers?: OutgoingHttpHeaders, status?: number): Promise<void> {
147
- return this.end({
148
- status: status !== undefined ? status : 302,
149
- headers: {
150
- ['Location']: url,
151
- ...headers
152
- }
153
- })
154
- }
155
- }
156
-
@@ -1,11 +0,0 @@
1
- export const newURL = (input: string, base?: string | any): any => {
2
- /* eslint-disable @typescript-eslint/ban-ts-comment */
3
- // @ts-ignore
4
- return new URL(input, base)
5
- }
6
-
7
- export const newURLSearchParams = (arg?: string | any): any => {
8
- /* eslint-disable @typescript-eslint/ban-ts-comment */
9
- // @ts-ignore
10
- return new URLSearchParams(arg);
11
- }
@@ -1,3 +0,0 @@
1
-
2
- export * from "./router";
3
- export * from "./context";
@@ -1,239 +0,0 @@
1
- import { Router } from "./router";
2
- import { Context, Handler } from "./context";
3
- import { Method } from "./context";
4
- import { matchTokenizePath, PathPartToken, tokenizePath } from "./tokenize-match"
5
- import { ParseRequest } from "../middleware/parse";
6
- import { Parser, ParseOptions, parse } from "../../util/parser";
7
- import { SessionHandler, SessionHandlerOptions } from "../middleware/session";
8
- import { GroupPolicyHandler } from "../middleware/group";
9
- import { GroupPolicy } from "../../util/session";
10
-
11
- const ResultParser = (options: ParseOptions | ParseOptions[], parser?: Parser): Handler<any> =>
12
- async (ctx: Context): Promise<any> => {
13
- if (!ctx.results || ctx.results.length === 0) {
14
- ctx.logger.debug(`not parsing results`);
15
- return undefined;
16
- } else {
17
- const index = ctx.results.length - 1;
18
- const lastResult = ctx.results[index];
19
- ctx.logger.trace(`parsing lastResult[%o]`, lastResult);
20
- try {
21
- if (options instanceof Array) {
22
- for (let i = 0; i < options.length; i++) {
23
- const o = options[i];
24
- try {
25
- const mappedResults = (parser ? parser.parse : parse)(`ctx.results[${index}]`, lastResult, o.options, o.mode, o.ignoreUndefined);
26
- ctx.logger.trace(`ctx.results[%s] mapped to %o`, index, mappedResults);
27
- return mappedResults;
28
- } catch (e) {
29
- if (i === options.length - 1) {
30
- throw e;
31
- } else {
32
- continue;
33
- }
34
- }
35
- }
36
- } else {
37
- const mappedResults = (parser ? parser.parse : parse)(`ctx.results[${index}]`, lastResult, options.options, options.mode, options.ignoreUndefined);
38
- ctx.logger.trace(`ctx.results[%s] mapped to %o`, index, mappedResults);
39
- return mappedResults;
40
- }
41
- } catch (e) {
42
- ctx.logger.error(`error parsing lastResult[%o]`, lastResult);
43
- throw e;
44
- }
45
- }
46
- };
47
-
48
-
49
- const ResponseHandler = (): Handler<void> =>
50
- async (ctx: Context): Promise<void> => {
51
- ctx.logger.trace("results [%o]", ctx.results);
52
- if (!ctx.results || ctx.results.length === 0) {
53
- throw new Error(`no response to send. Is your handler returning a value differente than boolean 'true|false' ?`);
54
- } else {
55
- const lastResult = ctx.results[ctx.results.length - 1];
56
- ctx.logger.debug("response [%o]", lastResult);
57
- if (lastResult !== undefined) {
58
- await ctx.json(lastResult);
59
- } else {
60
- throw new Error(`no response to send. Is your handler returning a value differente than boolean 'true|false' ?`);
61
- }
62
- }
63
- };
64
-
65
-
66
-
67
-
68
- export interface HandlerWithOptions extends RouterHandlerOptions {
69
- handler: Handler | Array<Handler>;
70
- }
71
-
72
- export interface RouteOptions {
73
- name?: string;
74
- description?: string;
75
- policy?: GroupPolicy;
76
- request?: {
77
- headers?: ParseOptions | ParseOptions[];
78
- query?: ParseOptions | false | ParseOptions[];
79
- params?: ParseOptions | false | ParseOptions[];
80
- body?: ParseOptions | false | ParseOptions[];
81
- };
82
- response?: true | ParseOptions | ParseOptions[];
83
- }
84
-
85
- export interface RouteJSONDoc extends RouteOptions {
86
- identifier: string;
87
- }
88
-
89
- export interface RouterJSONDoc {
90
- [path: string]: {
91
- [method: string]: RouteJSONDoc
92
- }
93
- }
94
-
95
- export interface RouterHandlerOptions extends RouteOptions {
96
- parser?: Parser;
97
- middleware?: Handler | Handler[];
98
- session?: SessionHandlerOptions | Handler;
99
- }
100
-
101
- export class RouterHandler {
102
-
103
- private readonly tokens: PathPartToken[];
104
- private readonly handler: Array<Handler | Handler | Router>;
105
- private readonly isRouter: boolean;
106
- private readonly options?: RouterHandlerOptions;
107
-
108
- public constructor(handler: Array<Handler> | HandlerWithOptions | Handler | Router, private readonly path: string | undefined, private readonly method: Method | undefined, options?: RouterHandlerOptions) {
109
- this.tokens = tokenizePath(path);
110
-
111
- let handlers: Array<Handler | Router> = []
112
- this.isRouter = handler instanceof Router;
113
-
114
- if (!this.isRouter && !(handler instanceof Array) && typeof handler === "object") {
115
- // HandlerWithOptions
116
- if (options) {
117
- throw new Error("bad arguments. cannot send options with HandlerWithOptions");
118
- }
119
- const realHandler = (handler as HandlerWithOptions).handler;
120
- const newOptions = {
121
- ...(handler as HandlerWithOptions)
122
- };
123
- delete (newOptions as any).handler;
124
- handler = realHandler;
125
- this.options = newOptions;
126
- } else {
127
- this.options = options;
128
- }
129
- const routeHandlers = handler instanceof Array ? handler : [handler] as Array<Handler | Router>;
130
-
131
- if ((!this.isRouter && routeHandlers.length !== routeHandlers.filter(h => typeof h === "function").length) || (this.isRouter && this.options)) {
132
- throw new Error("bad arguments");
133
- }
134
-
135
-
136
- if (this.options && this.options.middleware) {
137
- handlers = handlers.concat(this.options.middleware);
138
- }
139
- if (this.options && this.options.session) {
140
- handlers.push(typeof this.options.session !== "function" ? SessionHandler(this.options.session) : this.options.session);
141
- }
142
- if (this.options && this.options.policy) {
143
- handlers.push(GroupPolicyHandler(this.options.policy));
144
- }
145
- if (this.options && this.options.request) {
146
- handlers.push(ParseRequest(this.options.request));
147
- }
148
-
149
- handlers = handlers.concat(routeHandlers);
150
-
151
- if (this.options && this.options.response) {
152
- if (typeof this.options.response === "boolean") {
153
- (handlers as Handler[]).push(ResponseHandler());
154
- } else {
155
- (handlers as Handler[]).push(ResultParser(this.options.response, this.options.parser));
156
- (handlers as Handler[]).push(ResponseHandler());
157
- }
158
- }
159
- this.handler = handlers;
160
- }
161
-
162
- public getJSONDoc(doc: RouterJSONDoc = {}, prePath = "/"): RouterJSONDoc {
163
- const nPath = this.path && this.path.length > 1 ? this.path.substring(1) : "";
164
- const nMethod = this.method ? this.method : "";
165
-
166
- if (this.isRouter) {
167
- const router: Router = this.handler[0] as Router;
168
- router.getJSONDoc(doc, `${prePath}${nPath}`);
169
- } else if (this.options) {
170
- if (!doc[`${prePath}${nPath}`]) {
171
- doc[`${prePath}${nPath}`] = {};
172
- }
173
- if (doc[`${prePath}${nPath}`][nMethod]) {
174
- throw new Error("cannot create doc routes override each other");
175
- }
176
- doc[`${prePath}${nPath}`][nMethod] = {
177
- description: this.options.description,
178
- name: this.options.name,
179
- identifier: `${prePath}${nPath}${this.options.name ? this.options.name : ""}${nMethod ? `_${nMethod}` : ""}`.replace(/[^a-z0-9+]+/gi, '_').split("_").map(s => s.trim()).filter(s => s).join("_").toUpperCase(),
180
- policy: this.options.policy,
181
- request: this.options.request ? {
182
- body: this.options.request.body,
183
- headers: this.options.request.headers,
184
- params: this.options.request.params,
185
- query: this.options.request.query,
186
- } : undefined,
187
- response: this.options.response
188
- };
189
- }
190
- return doc;
191
- }
192
-
193
- public async invoke(ctx: Context, pathTokens: { value: string; lower: string; }[], prePathTokens: PathPartToken[]): Promise<boolean> {
194
- for (let i = 0; i < this.handler.length; i++) {
195
- const h = this.handler[i];
196
- if (h instanceof Router) {
197
- if (!this.pushResults(await h.run(ctx, pathTokens, prePathTokens.concat(this.tokens)), ctx)) {
198
- return false;
199
- }
200
- } else {
201
- if (!this.pushResults(await h(ctx), ctx)) {
202
- return false;
203
- }
204
- }
205
- }
206
- return true;
207
- }
208
-
209
- public isMatch(
210
- method: string,
211
- pathTokens: { value: string; lower: string; }[],
212
- prePathTokens: PathPartToken[]): {
213
- match: boolean;
214
- params?: { [name: string]: string | undefined }
215
- } {
216
- if ((this.method === undefined || this.method === method)) {
217
- if (this.path === undefined) {
218
- return {
219
- match: true
220
- };
221
- }
222
- return matchTokenizePath(this.isRouter, prePathTokens.concat(this.tokens), pathTokens);
223
- }
224
- return {
225
- match: false
226
- };
227
- }
228
-
229
- private pushResults(result: boolean, ctx: Context): boolean {
230
- if (result === false) {
231
- // ctx.logger.debug(`avoiding next handlers because handler returned false.`);
232
- return false;
233
- } else if (result !== true && result !== undefined) {
234
- ctx.logger.trace("pushing to results [%o]", result);
235
- ctx.results.push(result);
236
- }
237
- return true;
238
- }
239
- }
@@ -1,98 +0,0 @@
1
- import { IncomingMessage, RequestListener, ServerResponse } from "http";
2
- import { Logger } from "../../util/logger";
3
- import { Method, Handler, Context, ErrorHandler } from "./context";
4
- import { RouterHandler, RouterJSONDoc, RouterHandlerOptions, HandlerWithOptions } from "./router-utils";
5
- import { normalizePath, PathPartToken, splitPath } from "./tokenize-match";
6
-
7
- export interface RouterOptions {
8
- newRequestLogger?: (req: IncomingMessage) => Logger;
9
- newContext?: (req: IncomingMessage, res: ServerResponse) => Context;
10
- }
11
-
12
- export class Router {
13
- protected readonly handlers: RouterHandler[] = [];
14
- protected readonly errorHandlers: ErrorHandler[] = [];
15
- public readonly listener: RequestListener;
16
- constructor(protected config?: RouterOptions) {
17
- this.listener = async (req, res) => {
18
- const ctx = this.config && this.config.newContext ?
19
- this.config.newContext(req, res) :
20
- new Context(
21
- req,
22
- res,
23
- this.config && this.config.newRequestLogger ?
24
- this.config.newRequestLogger(req) :
25
- undefined);
26
- ctx.logger.trace(`request received`);
27
- await this.run(ctx);
28
- };
29
- }
30
- public get(path: string, handler: Array<Handler> | Handler | Router | HandlerWithOptions, options?: RouterHandlerOptions): Router {
31
- return this.use(handler, path, "get", options);
32
- }
33
- public post(path: string, handler: Array<Handler> | Handler | Router | HandlerWithOptions, options?: RouterHandlerOptions): Router {
34
- return this.use(handler, path, "post", options);
35
- }
36
- public patch(path: string, handler: Array<Handler> | Handler | Router | HandlerWithOptions, options?: RouterHandlerOptions): Router {
37
- return this.use(handler, path, "patch", options);
38
- }
39
- public delete(path: string, handler: Array<Handler> | Handler | Router | HandlerWithOptions, options?: RouterHandlerOptions): Router {
40
- return this.use(handler, path, "delete", options);
41
- }
42
- public put(path: string, handler: Array<Handler> | Handler | Router | HandlerWithOptions, options?: RouterHandlerOptions): Router {
43
- return this.use(handler, path, "put", options);
44
- }
45
- public options(path: string, handler: Array<Handler> | Handler | Router | HandlerWithOptions, options?: RouterHandlerOptions): Router {
46
- return this.use(handler, path, "options", options);
47
- }
48
- public use(handler: Array<Handler> | HandlerWithOptions | Handler | Router, path?: string, method?: Method, options?: RouterHandlerOptions): Router {
49
- const nPath = path !== undefined ? normalizePath(path) : undefined;
50
- const nMethod = method ? method.toUpperCase() as Method : method;
51
- this.handlers.push(new RouterHandler(handler, nPath, nMethod, options));
52
- return this;
53
- }
54
- public catch(errorHandler: Array<ErrorHandler> | ErrorHandler): Router {
55
- const errorHandlers = errorHandler instanceof Array ? errorHandler : [errorHandler];
56
- for (const e of errorHandlers) {
57
- this.errorHandlers.push(e);
58
- }
59
- return this;
60
- }
61
- public async run(ctx: Context, pathTokens?: { value: string; lower: string; }[], prePathTokens: PathPartToken[] = []): Promise<boolean> {
62
- pathTokens = pathTokens ? pathTokens : splitPath(ctx.path);
63
- try {
64
- let shouldContinue = true;
65
- for (const h of this.handlers) {
66
- if (!shouldContinue || ctx.res.headersSent) {
67
- shouldContinue = false;
68
- break;
69
- }
70
- const isMatch = h.isMatch(ctx.method, pathTokens, prePathTokens);
71
- if (isMatch.match) {
72
- if (isMatch.params) {
73
- ctx.params = ctx.params ? {
74
- ...ctx.params,
75
- ...isMatch.params
76
- } : isMatch.params;
77
- }
78
- shouldContinue = await h.invoke(ctx, pathTokens, prePathTokens);
79
- }
80
- }
81
- return !ctx.res.headersSent;
82
- } catch (e: any) {
83
- for (const eH of this.errorHandlers) {
84
- const ret = await eH(e, ctx);
85
- if (ret === false || ctx.res.headersSent) {
86
- return false;
87
- }
88
- }
89
- throw e; // pass the error along
90
- }
91
- }
92
- public getJSONDoc(doc: RouterJSONDoc = {}, prePath = "/"): RouterJSONDoc {
93
- for (const h of this.handlers) {
94
- doc = h.getJSONDoc(doc, prePath);
95
- }
96
- return doc;
97
- }
98
- }