@miqro/core 1.4.2 → 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 (293) hide show
  1. package/README.md +16 -43
  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 -1
  5. package/dist/{handler/app.js → app.js} +8 -8
  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 → 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 → 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 -2
  101. package/dist/index.js +6 -3
  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 -16
  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/util/cli/index.d.ts +0 -17
  165. package/dist/util/cli/index.js +0 -84
  166. package/dist/util/cli/index.js.map +0 -1
  167. package/dist/util/config/browser.d.ts +0 -1
  168. package/dist/util/config/browser.js +0 -10
  169. package/dist/util/config/browser.js.map +0 -1
  170. package/dist/util/config/config.js.map +0 -1
  171. package/dist/util/config/featuretoggle.js.map +0 -1
  172. package/dist/util/config/index.js.map +0 -1
  173. package/dist/util/error/configfilenotfound.d.ts +0 -4
  174. package/dist/util/error/configfilenotfound.js.map +0 -1
  175. package/dist/util/error/forbiddenerror.d.ts +0 -4
  176. package/dist/util/error/forbiddenerror.js.map +0 -1
  177. package/dist/util/error/index.js.map +0 -1
  178. package/dist/util/error/named.d.ts +0 -3
  179. package/dist/util/error/named.js +0 -11
  180. package/dist/util/error/named.js.map +0 -1
  181. package/dist/util/error/notfound.d.ts +0 -4
  182. package/dist/util/error/notfound.js.map +0 -1
  183. package/dist/util/error/notimplemented.d.ts +0 -4
  184. package/dist/util/error/notimplemented.js.map +0 -1
  185. package/dist/util/error/parsererror.d.ts +0 -8
  186. package/dist/util/error/parsererror.js +0 -20
  187. package/dist/util/error/parsererror.js.map +0 -1
  188. package/dist/util/error/unauthorizederror.d.ts +0 -4
  189. package/dist/util/error/unauthorizederror.js.map +0 -1
  190. package/dist/util/index.js.map +0 -1
  191. package/dist/util/loader/index.d.ts +0 -4
  192. package/dist/util/loader/index.js.map +0 -1
  193. package/dist/util/logger/common.js.map +0 -1
  194. package/dist/util/logger/factory.js.map +0 -1
  195. package/dist/util/logger/formatter.js.map +0 -1
  196. package/dist/util/logger/index.js.map +0 -1
  197. package/dist/util/logger/logger.js.map +0 -1
  198. package/dist/util/logger/transport.js.map +0 -1
  199. package/dist/util/parser/common.js.map +0 -1
  200. package/dist/util/parser/get.js.map +0 -1
  201. package/dist/util/parser/index.js.map +0 -1
  202. package/dist/util/parser/parser.js.map +0 -1
  203. package/dist/util/parser/types/any.js.map +0 -1
  204. package/dist/util/parser/types/array.js.map +0 -1
  205. package/dist/util/parser/types/boolean.js.map +0 -1
  206. package/dist/util/parser/types/email.js.map +0 -1
  207. package/dist/util/parser/types/enum.js.map +0 -1
  208. package/dist/util/parser/types/index.js.map +0 -1
  209. package/dist/util/parser/types/multiple.js.map +0 -1
  210. package/dist/util/parser/types/nested.js.map +0 -1
  211. package/dist/util/parser/types/number.js.map +0 -1
  212. package/dist/util/parser/types/object.js.map +0 -1
  213. package/dist/util/parser/types/regex.js.map +0 -1
  214. package/dist/util/parser/types/string.js.map +0 -1
  215. package/dist/util/parser/types/url.js.map +0 -1
  216. package/dist/util/request/common.d.ts +0 -57
  217. package/dist/util/request/common.js +0 -146
  218. package/dist/util/request/common.js.map +0 -1
  219. package/dist/util/request/index.d.ts +0 -4
  220. package/dist/util/request/index.js +0 -231
  221. package/dist/util/request/index.js.map +0 -1
  222. package/dist/util/session/common.d.ts +0 -15
  223. package/dist/util/session/common.js.map +0 -1
  224. package/dist/util/session/index.js.map +0 -1
  225. package/dist/util/session/service.js.map +0 -1
  226. package/src/handler/api-router-utils.ts +0 -187
  227. package/src/handler/api-router.ts +0 -86
  228. package/src/handler/app.ts +0 -133
  229. package/src/handler/common/context.ts +0 -156
  230. package/src/handler/common/helpers.ts +0 -11
  231. package/src/handler/common/index.ts +0 -2
  232. package/src/handler/common/router-utils.ts +0 -232
  233. package/src/handler/common/router.ts +0 -98
  234. package/src/handler/common/tokenize-match.ts +0 -152
  235. package/src/handler/index.ts +0 -5
  236. package/src/handler/middleware/buffer.ts +0 -79
  237. package/src/handler/middleware/cookie.ts +0 -19
  238. package/src/handler/middleware/cors.ts +0 -98
  239. package/src/handler/middleware/form.ts +0 -59
  240. package/src/handler/middleware/group.ts +0 -70
  241. package/src/handler/middleware/index.ts +0 -48
  242. package/src/handler/middleware/json.ts +0 -56
  243. package/src/handler/middleware/logger.ts +0 -18
  244. package/src/handler/middleware/parse.ts +0 -93
  245. package/src/handler/middleware/session.ts +0 -155
  246. package/src/handler/middleware/tag.ts +0 -15
  247. package/src/handler/middleware/text.ts +0 -47
  248. package/src/handler/proxy.ts +0 -39
  249. package/src/index.ts +0 -2
  250. package/src/util/cli/index.ts +0 -81
  251. package/src/util/config/browser.ts +0 -5
  252. package/src/util/config/config.ts +0 -93
  253. package/src/util/config/featuretoggle.ts +0 -6
  254. package/src/util/config/index.ts +0 -3
  255. package/src/util/error/configfilenotfound.ts +0 -8
  256. package/src/util/error/forbiddenerror.ts +0 -8
  257. package/src/util/error/index.ts +0 -6
  258. package/src/util/error/named.ts +0 -3
  259. package/src/util/error/notfound.ts +0 -8
  260. package/src/util/error/notimplemented.ts +0 -8
  261. package/src/util/error/parsererror.ts +0 -15
  262. package/src/util/error/unauthorizederror.ts +0 -8
  263. package/src/util/index.ts +0 -8
  264. package/src/util/loader/index.ts +0 -61
  265. package/src/util/logger/common.ts +0 -6
  266. package/src/util/logger/factory.ts +0 -45
  267. package/src/util/logger/formatter.ts +0 -9
  268. package/src/util/logger/index.ts +0 -6
  269. package/src/util/logger/logger.ts +0 -114
  270. package/src/util/logger/transport.ts +0 -69
  271. package/src/util/parser/common.ts +0 -81
  272. package/src/util/parser/get.ts +0 -40
  273. package/src/util/parser/index.ts +0 -3
  274. package/src/util/parser/parser.ts +0 -235
  275. package/src/util/parser/types/any.ts +0 -8
  276. package/src/util/parser/types/array.ts +0 -73
  277. package/src/util/parser/types/boolean.ts +0 -13
  278. package/src/util/parser/types/email.ts +0 -26
  279. package/src/util/parser/types/enum.ts +0 -29
  280. package/src/util/parser/types/index.ts +0 -12
  281. package/src/util/parser/types/multiple.ts +0 -36
  282. package/src/util/parser/types/nested.ts +0 -19
  283. package/src/util/parser/types/number.ts +0 -34
  284. package/src/util/parser/types/object.ts +0 -10
  285. package/src/util/parser/types/regex.ts +0 -17
  286. package/src/util/parser/types/string.ts +0 -23
  287. package/src/util/parser/types/url.ts +0 -35
  288. package/src/util/request/common.ts +0 -193
  289. package/src/util/request/index.ts +0 -230
  290. package/src/util/session/common.ts +0 -20
  291. package/src/util/session/index.ts +0 -2
  292. package/src/util/session/service.ts +0 -154
  293. package/tsconfig.json +0 -32
@@ -1,187 +0,0 @@
1
- import { lstatSync, readdirSync } from "fs";
2
- import { join, parse, resolve } from "path";
3
- import { Logger } from "../util/logger";
4
- import { APIRoute } from "./api-router";
5
- import { normalizePath } from "./common/tokenize-match";
6
- import { SimpleMap } from "../util/parser/common";
7
- import { isFeatureEnabled } from "../util/config/featuretoggle";
8
- import { Router } from "./common/router";
9
- import { Handler, Method } from "./common/context";
10
- import { RouterHandlerOptions } from "./common/router-utils";
11
-
12
- export const traverseAPIRouteDir = (
13
- featureName: string,
14
- dirname: string,
15
- basePath = "/",
16
- features: FeatureRouterOptions = {}, logger?: Logger): FeatureRouterOptions => {
17
- if (logger) {
18
- logger.trace("loading routes from [%s]", dirname);
19
- }
20
- const files = readdirSync(dirname);
21
- const dirs = files.filter(f => lstatSync(join(dirname, f)).isDirectory());
22
- const methods = files.filter(f => !lstatSync(join(dirname, f)).isDirectory());
23
- for (const f of dirs) {
24
- const { name } = parse(f);
25
- features = traverseAPIRouteDir(`${featureName}_${name}`.toUpperCase(), join(dirname, f), `${basePath}/${name}`, features, logger);
26
- }
27
- for (const f of methods) {
28
- const { name, ext } = parse(f);
29
- if (name !== "index" && ((ext === ".ts" || ext === ".js") && name.slice(-2) !== ".d")) {
30
- const filePath = join(dirname, name);
31
- // eslint-disable-next-line @typescript-eslint/no-var-requires
32
- let route: APIRoute = require(filePath);
33
- if ((route as any).default && (route as any).__esModule === true) {
34
- route = (route as any).default;
35
- }
36
- const ___filePath = filePath + ext;
37
- let routeMethods: Method[] = [name] as Method[];
38
- if (typeof route === "function") {
39
- route = {
40
- handler: route
41
- } as any;
42
- } else {
43
- if (typeof route.method !== "undefined" && (!(route.method instanceof Array) && (typeof route.method !== "string"))) {
44
- throw new Error(`${resolve(dirname, name)} doesnt export method as a string or string array`);
45
- } else if (typeof route.method !== "undefined") {
46
- routeMethods = route.method instanceof Array ? route.method : [route.method];
47
- }
48
- if (typeof route.path !== "string" && typeof route.path !== "undefined" && !(route.path instanceof Array)) {
49
- throw new Error(`${resolve(dirname, name)} doesnt export path as a string or a string array`);
50
- }
51
- if ((!(route.handler instanceof Array) && typeof route.handler !== "function") || typeof route.handler === "undefined") {
52
- throw new Error(`${resolve(dirname, name)} doesnt export handler as a function or an array`);
53
- }
54
- if (typeof route.name !== "string" && typeof route.name !== "undefined") {
55
- throw new Error(`${resolve(dirname, name)} doesnt export name as a string`);
56
- }
57
- }
58
-
59
- const paths = route.path instanceof Array ? route.path : route.path === undefined ? [route.method && route.method.indexOf(name as Method) === -1 ? `/${name}` : "/"] : [route.path];
60
- for (let i = 0; i < paths.length; i++) {
61
- const p = paths[i];
62
- if (typeof p !== "string" || !p) {
63
- throw new Error(`${resolve(dirname, name)} doesnt export path as a string or a string array`);
64
- }
65
- const path = normalizePath(`${basePath}${p && p !== "/" ? `${p}` : ""}`)
66
-
67
- const subName = (p.charAt(0) === "/" ? p.substring(1) : p).replace(/[^a-z0-9+]+/gi, '_');
68
- const routeName = route.name ? route.name : name;
69
-
70
- let newFeatureSubPath = `${featureName}_${route.name ? route.name : name}${routeName !== subName ? `_${subName}` : ""}`.toUpperCase();
71
-
72
- newFeatureSubPath = newFeatureSubPath.length > 1 && newFeatureSubPath.charAt(newFeatureSubPath.length - 1) === "_" ? newFeatureSubPath.substring(0, newFeatureSubPath.length - 1) : newFeatureSubPath;
73
- if (features[newFeatureSubPath]) {
74
- throw new Error(`${___filePath} feature name collides with ${(features[newFeatureSubPath] as any).___filePath}`)
75
- }
76
- features[newFeatureSubPath] = {
77
- options: {
78
- name: route.name,
79
- description: route.description,
80
- parser: route.parser,
81
- middleware: route.middleware,
82
- session: route.session,
83
- policy: route.policy,
84
- request: {
85
- headers: route.headers,
86
- query: route.query,
87
- body: route.body,
88
- params: route.params,
89
- },
90
- response: route.result ? route.result : true
91
- },
92
- path,
93
- method: routeMethods,
94
- handler: route.handler
95
- };
96
- (features[newFeatureSubPath] as any).___filePath = ___filePath;
97
- }
98
- }
99
- }
100
- return features;
101
- };
102
-
103
- export interface FeatureRouterPathOptions {
104
- path: string | string[];
105
- method: Method | Method[];
106
- handler: Array<Handler> | Handler;
107
- options?: RouterHandlerOptions;
108
- }
109
-
110
- export type FeatureRouterOptions = SimpleMap<FeatureRouterPathOptions>;
111
-
112
- const FEATURE_ROUTER_METHODS: Method[] = ["get", "post", "put", "delete", "patch", "options"];
113
-
114
- export const FeatureRouter = (options: FeatureRouterOptions, logger?: Logger): Router => {
115
- const router: Router = new Router();
116
- const toSetup = Object.keys(options);
117
- const enabled: string[] = [];
118
- const disabled: string[] = [];
119
- const enabledPaths: SimpleMap<string> = {};
120
- for (const featureName of toSetup) {
121
- const handlerOptions = options[featureName];
122
- if (!handlerOptions) {
123
- throw new Error(`no handler options for feature [${featureName}]`);
124
- } else {
125
- const { path, handler: implementation, method } = handlerOptions;
126
- if (!method) {
127
- throw new Error(`no methods for feature [${featureName}]`);
128
- } else if (!implementation) {
129
- throw new Error(`no implementation for feature [${featureName}]`);
130
- } else if (!path) {
131
- throw new Error(`no path for feature [${featureName}]`);
132
- } else {
133
- if (method instanceof Array) {
134
- for (const m of method) {
135
- if (FEATURE_ROUTER_METHODS.indexOf(m.toLowerCase() as Method) === -1) {
136
- throw new Error(`feature [${featureName}] method [${m.toUpperCase()}] not defined! use only [${FEATURE_ROUTER_METHODS.join(",")}]`);
137
- }
138
- }
139
- } else if (FEATURE_ROUTER_METHODS.indexOf(method.toLowerCase() as Method) === -1) {
140
- throw new Error(`feature [${featureName}] method [${method.toUpperCase()}] not defined! use only [${FEATURE_ROUTER_METHODS.join(",")}]`);
141
- }
142
- const methods = method instanceof Array ? method : [method];
143
- if (isFeatureEnabled(featureName)) {
144
- if (logger) {
145
- logger.trace(`feature [${featureName}] enabled`);
146
- }
147
- enabled.push(featureName);
148
- const paths = path instanceof Array ? path : [path];
149
- for (const nnP of paths) {
150
- const p = normalizePath(nnP);
151
- for (const m of methods) {
152
- if (logger) {
153
- logger.info("%s", featureName);
154
- logger.info("\t%s:%s", m.toUpperCase(), p);
155
- if ((handlerOptions as any).___filePath) {
156
- logger.info("\t%s", (handlerOptions as any).___filePath);
157
- }
158
- }
159
- if (enabledPaths[`${p}${m}`] !== undefined) {
160
- throw new Error(`${featureName} collides with feature ${enabledPaths[`${p}${m}`]} on path ${p} method ${m}`)
161
- }
162
- enabledPaths[`${p}${m}`] = featureName;
163
- router.use(implementation, p, m.toLocaleLowerCase() as Method, handlerOptions.options);
164
- }
165
- }
166
- } else {
167
- if (logger) {
168
- logger.debug("feature [%s] disabled", featureName);
169
- }
170
- disabled.push(featureName);
171
- }
172
- }
173
- }
174
- }
175
- if (logger && enabled.length > 0) {
176
- logger.debug("enabled features [%s]", enabled.join(","));
177
- }
178
- if (logger) {
179
- if (disabled.length > 0) {
180
- logger.warn("disabled features [%s]", disabled.join(","));
181
- logger.warn(`to enable them just add the env var <feature>=true`);
182
- } else {
183
- logger.debug(`no features disabled`);
184
- }
185
- }
186
- return router;
187
- };
@@ -1,86 +0,0 @@
1
- import { existsSync, lstatSync } from "fs";
2
- import { basename } from "path";
3
- import { Logger } from "../util";
4
- import { traverseAPIRouteDir, FeatureRouter } from "./api-router-utils";
5
- import { Router, Method } from "./common";
6
- import { GroupPolicy } from "../util/session";
7
- import { SessionHandlerOptions } from "./middleware/session";
8
- import { Parser } from "../util/parser";
9
- import { ParseOptions } from "../util/parser/common";
10
- import { Handler } from "./common";
11
-
12
- /**
13
- * # APIRoute
14
- *
15
- * src/api/comment/get.js
16
- * ```typescript
17
- *import { APIRouter } from "@miqro/core";
18
- *const route: APIRoute = {
19
- * ...
20
- *};
21
- *export default route;
22
- * ```
23
- */
24
- export interface APIRoute {
25
- name?: string;
26
- description?: string;
27
- method?: Method | Method[];
28
- path?: string | string[];
29
- parser?: Parser;
30
- headers?: ParseOptions | ParseOptions[];
31
- query?: ParseOptions | false | ParseOptions[];
32
- params?: ParseOptions | false | ParseOptions[];
33
- body?: ParseOptions | false | ParseOptions[];
34
- result?: ParseOptions | ParseOptions[];
35
- handler: Array<Handler> | Handler;
36
- middleware?: Handler[];
37
- session?: SessionHandlerOptions | Handler;
38
- policy?: GroupPolicy;
39
- }
40
-
41
- /**
42
- * # APIRouter
43
- *
44
- * src/server.js
45
- * ```typescript
46
- *import { App, APIRouter } from "@miqro/core";
47
- *const app = new App();
48
- *app.use(APIRouter({ dirname: resolve(__dirname, "api") }));
49
- *app.listen(8080);
50
- * ```
51
- *
52
- * src/api/user/post.js
53
- *
54
- * ```typescript
55
- *import { ReadBuffer, JSONParser, APIRoute } from "@miqro/core";
56
- *
57
- *const route: APIRoute = {
58
- * middleware: [ReadBuffer(), JSONParser()]
59
- * query: { ... },
60
- * body: { ... },
61
- * result: { ... },
62
- * handler: async (ctx: Context) => {
63
- * return {
64
- * status: "OK"
65
- * };
66
- * }
67
- *}
68
- *export default route;
69
- * ```
70
- */
71
- export const APIRouter = (options: {
72
- dirname: string;
73
- apiName?: string;
74
- path?: string;
75
- }, logger?: Logger): Router => {
76
- const { dirname } = options;
77
- if (typeof dirname !== "string") {
78
- throw new Error(`options.dirname must be defined!`);
79
- }
80
- if (!existsSync(dirname) || !lstatSync(dirname).isDirectory()) {
81
- throw new Error(`${dirname} not a directory!`);
82
- }
83
- const apiName = options.apiName !== undefined ? options.apiName : basename(dirname);
84
- const apiPath = options.path !== undefined ? options.path : `/${apiName}`;
85
- return FeatureRouter(traverseAPIRouteDir(apiName.toUpperCase(), dirname, apiPath, undefined, logger), logger);
86
- };
@@ -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
- 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,2 +0,0 @@
1
- export * from "./router";
2
- export * from "./context";