@miqro/core 1.3.3 → 1.3.8

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 (132) hide show
  1. package/README.md +81 -253
  2. package/dist/handler/api-router-utils.d.ts +11 -7
  3. package/dist/handler/api-router-utils.js +102 -15
  4. package/dist/handler/api-router-utils.js.map +1 -1
  5. package/dist/handler/api-router.d.ts +29 -2
  6. package/dist/handler/api-router.js +2 -2
  7. package/dist/handler/api-router.js.map +1 -1
  8. package/dist/handler/app.d.ts +4 -9
  9. package/dist/handler/app.js +10 -9
  10. package/dist/handler/app.js.map +1 -1
  11. package/dist/handler/common/context.d.ts +1 -1
  12. package/dist/handler/common/context.js +14 -9
  13. package/dist/handler/common/context.js.map +1 -1
  14. package/dist/handler/common/router-utils.d.ts +34 -1
  15. package/dist/handler/common/router-utils.js +139 -9
  16. package/dist/handler/common/router-utils.js.map +1 -1
  17. package/dist/handler/common/router.d.ts +19 -8
  18. package/dist/handler/common/router.js +32 -15
  19. package/dist/handler/common/router.js.map +1 -1
  20. package/dist/handler/index.d.ts +0 -3
  21. package/dist/handler/index.js +0 -3
  22. package/dist/handler/index.js.map +1 -1
  23. package/dist/handler/middleware/form.js +7 -1
  24. package/dist/handler/middleware/form.js.map +1 -1
  25. package/dist/handler/middleware/group.js +44 -2
  26. package/dist/handler/middleware/group.js.map +1 -1
  27. package/dist/handler/middleware/index.js +2 -6
  28. package/dist/handler/middleware/index.js.map +1 -1
  29. package/dist/handler/middleware/json.js +8 -2
  30. package/dist/handler/middleware/json.js.map +1 -1
  31. package/dist/handler/middleware/text.js +8 -1
  32. package/dist/handler/middleware/text.js.map +1 -1
  33. package/dist/handler/proxy.d.ts +2 -5
  34. package/dist/handler/proxy.js +2 -3
  35. package/dist/handler/proxy.js.map +1 -1
  36. package/dist/index.d.ts +1 -0
  37. package/dist/index.js +1 -0
  38. package/dist/index.js.map +1 -1
  39. package/dist/{util/test → test/common}/app.d.ts +2 -2
  40. package/dist/{util/test → test/common}/app.js +3 -2
  41. package/dist/test/common/app.js.map +1 -0
  42. package/dist/{util/test → test/common}/common.d.ts +0 -0
  43. package/dist/{util/test → test/common}/common.js +0 -0
  44. package/dist/test/common/common.js.map +1 -0
  45. package/dist/{util/test → test/common}/index.d.ts +1 -0
  46. package/dist/{util/test → test/common}/index.js +1 -0
  47. package/dist/test/common/index.js.map +1 -0
  48. package/dist/test/common/runner.d.ts +13 -0
  49. package/dist/test/common/runner.js +92 -0
  50. package/dist/test/common/runner.js.map +1 -0
  51. package/dist/test/index.d.ts +1 -0
  52. package/dist/{handler/response → test}/index.js +1 -3
  53. package/dist/test/index.js.map +1 -0
  54. package/dist/test/main.d.ts +1 -0
  55. package/dist/test/main.js +19 -0
  56. package/dist/test/main.js.map +1 -0
  57. package/dist/util/cli/index.d.ts +1 -1
  58. package/dist/util/cookie/cookie.d.ts +0 -1
  59. package/dist/util/error/parsererror.d.ts +2 -1
  60. package/dist/util/error/parsererror.js +5 -1
  61. package/dist/util/error/parsererror.js.map +1 -1
  62. package/dist/util/index.d.ts +0 -1
  63. package/dist/util/index.js +0 -1
  64. package/dist/util/index.js.map +1 -1
  65. package/dist/util/loader/index.d.ts +0 -3
  66. package/dist/util/loader/index.js +2 -9
  67. package/dist/util/loader/index.js.map +1 -1
  68. package/dist/util/parser/get.js +3 -6
  69. package/dist/util/parser/get.js.map +1 -1
  70. package/dist/util/request/common.d.ts +0 -1
  71. package/dist/util/request/index.d.ts +1 -1
  72. package/dist/util/request/index.js +1 -3
  73. package/dist/util/request/index.js.map +1 -1
  74. package/dist/util/session/common.d.ts +0 -1
  75. package/dist/util/session/common.js +0 -46
  76. package/dist/util/session/common.js.map +1 -1
  77. package/package.json +6 -12
  78. package/src/handler/api-router-utils.ts +108 -22
  79. package/src/handler/api-router.ts +30 -4
  80. package/src/handler/app.ts +10 -15
  81. package/src/handler/common/context.ts +14 -10
  82. package/src/handler/common/router-utils.ts +221 -49
  83. package/src/handler/common/router.ts +43 -15
  84. package/src/handler/index.ts +0 -3
  85. package/src/handler/middleware/form.ts +8 -2
  86. package/src/handler/middleware/group.ts +44 -2
  87. package/src/handler/middleware/index.ts +0 -4
  88. package/src/handler/middleware/json.ts +9 -3
  89. package/src/handler/middleware/text.ts +8 -1
  90. package/src/handler/proxy.ts +3 -8
  91. package/src/index.ts +1 -0
  92. package/src/{util/test → test/common}/app.ts +6 -5
  93. package/src/{util/test → test/common}/common.ts +0 -0
  94. package/src/{util/test → test/common}/index.ts +1 -0
  95. package/src/test/common/runner.ts +97 -0
  96. package/src/test/index.ts +1 -0
  97. package/src/test/main.ts +17 -0
  98. package/src/util/cli/index.ts +1 -1
  99. package/src/util/error/parsererror.ts +6 -1
  100. package/src/util/index.ts +0 -1
  101. package/src/util/loader/index.ts +1 -7
  102. package/src/util/parser/get.ts +3 -5
  103. package/src/util/request/index.ts +1 -1
  104. package/src/util/session/common.ts +0 -43
  105. package/tsconfig-test.json +13 -0
  106. package/tsconfig.json +2 -2
  107. package/dist/handler/api-handler.d.ts +0 -30
  108. package/dist/handler/api-handler.js +0 -42
  109. package/dist/handler/api-handler.js.map +0 -1
  110. package/dist/handler/feature-router.d.ts +0 -10
  111. package/dist/handler/feature-router.js +0 -90
  112. package/dist/handler/feature-router.js.map +0 -1
  113. package/dist/handler/response/html.d.ts +0 -10
  114. package/dist/handler/response/html.js +0 -34
  115. package/dist/handler/response/html.js.map +0 -1
  116. package/dist/handler/response/index.d.ts +0 -3
  117. package/dist/handler/response/index.js.map +0 -1
  118. package/dist/handler/response/json.d.ts +0 -2
  119. package/dist/handler/response/json.js +0 -21
  120. package/dist/handler/response/json.js.map +0 -1
  121. package/dist/handler/response/result.d.ts +0 -4
  122. package/dist/handler/response/result.js +0 -46
  123. package/dist/handler/response/result.js.map +0 -1
  124. package/dist/util/test/app.js.map +0 -1
  125. package/dist/util/test/common.js.map +0 -1
  126. package/dist/util/test/index.js.map +0 -1
  127. package/src/handler/api-handler.ts +0 -56
  128. package/src/handler/feature-router.ts +0 -90
  129. package/src/handler/response/html.ts +0 -36
  130. package/src/handler/response/index.ts +0 -3
  131. package/src/handler/response/json.ts +0 -19
  132. package/src/handler/response/result.ts +0 -40
@@ -1,56 +0,0 @@
1
- import { GroupPolicy } from "../util/session";
2
- import { SessionHandler, SessionHandlerOptions } from "./middleware/session";
3
- import { GroupPolicyHandler } from "./middleware/group";
4
- import { Parser } from "../util/parser";
5
- import { ParseOptions } from "../util/parser/common";
6
- import { Handler } from "./common";
7
- import { ParseRequest } from "./middleware/parse";
8
- import { ResponseHandler } from "./response/json";
9
- import { ResultParser } from "./response/result";
10
-
11
- export interface APIHandlerOptions {
12
- parser?: Parser;
13
- headers?: ParseOptions | ParseOptions[];
14
- query?: ParseOptions | false | ParseOptions[];
15
- params?: ParseOptions | false | ParseOptions[];
16
- body?: ParseOptions | false | ParseOptions[];
17
- result?: ParseOptions | ParseOptions[];
18
- handler: Array<Handler> | Handler;
19
- middleware?: Handler[];
20
- session?: SessionHandlerOptions | Handler;
21
- policy?: GroupPolicy;
22
- responseHandler?: Handler;
23
- }
24
-
25
- /**
26
- * APIHandler
27
- *
28
- * ```typescript
29
- *app.use(APIHandler({
30
- * query: { ... },
31
- * body: { ... },
32
- * result: { ... }
33
- *}));
34
- * ```
35
- */
36
- export const APIHandler = (options: APIHandlerOptions): Array<Handler> =>
37
- // setup options.middleware
38
- (options.middleware ? options.middleware : [])
39
- // setup session
40
- .concat(options.session ? typeof options.session === "function" ? [options.session] : [SessionHandler(options.session)] : [])
41
- // setup policy
42
- .concat(options.policy ? [GroupPolicyHandler(options.policy)] : [])
43
- // setup request parse
44
- .concat([ParseRequest({
45
- headers: options.headers,
46
- query: options.query,
47
- params: options.params,
48
- body: options.body,
49
- parser: options.parser
50
- })])
51
- // setup options.handler
52
- .concat(options.handler instanceof Array ? options.handler : [options.handler])
53
- // setup response parse
54
- .concat(options.result ? ResultParser(options.result, options.parser) : [])
55
- // setup response handler
56
- .concat([options.responseHandler ? options.responseHandler : ResponseHandler()]);
@@ -1,90 +0,0 @@
1
- import { SimpleMap } from "../util/parser/common";
2
- import { Logger } from "../util/logger";
3
- import { isFeatureEnabled } from "../util/config/featuretoggle";
4
- import { normalizePath } from "./common/tokenize-match";
5
- import { Router, Handler, Method } from "./common";
6
-
7
- export interface FeatureRouterPathOptions {
8
- path: string | string[];
9
- method: Method | Method[];
10
- handler: Array<Handler> | Handler;
11
- }
12
-
13
- export type FeatureRouterOptions<T extends FeatureRouterPathOptions = FeatureRouterPathOptions> = SimpleMap<T>;
14
-
15
- const FEATURE_ROUTER_METHODS: Method[] = ["get", "post", "put", "delete", "patch", "options"];
16
-
17
- export const FeatureRouter = (options: FeatureRouterOptions, logger?: Logger): Router => {
18
- const router: Router = new Router();
19
- const toSetup = Object.keys(options);
20
- const enabled: string[] = [];
21
- const disabled: string[] = [];
22
- const enabledPaths: SimpleMap<string> = {};
23
- for (const featureName of toSetup) {
24
- const handlerOptions = options[featureName];
25
- if (!handlerOptions) {
26
- throw new Error(`no handler options for feature [${featureName}]`);
27
- } else {
28
- const { path, handler: implementation, method } = handlerOptions;
29
- if (!method) {
30
- throw new Error(`no methods for feature [${featureName}]`);
31
- } else if (!implementation) {
32
- throw new Error(`no implementation for feature [${featureName}]`);
33
- } else if (!path) {
34
- throw new Error(`no path for feature [${featureName}]`);
35
- } else {
36
- if (method instanceof Array) {
37
- for (const m of method) {
38
- if (FEATURE_ROUTER_METHODS.indexOf(m.toLowerCase() as Method) === -1) {
39
- throw new Error(`feature [${featureName}] method [${m.toUpperCase()}] not defined! use only [${FEATURE_ROUTER_METHODS.join(",")}]`);
40
- }
41
- }
42
- } else if (FEATURE_ROUTER_METHODS.indexOf(method.toLowerCase() as Method) === -1) {
43
- throw new Error(`feature [${featureName}] method [${method.toUpperCase()}] not defined! use only [${FEATURE_ROUTER_METHODS.join(",")}]`);
44
- }
45
- const methods = method instanceof Array ? method : [method];
46
- if (isFeatureEnabled(featureName)) {
47
- if (logger) {
48
- logger.trace(`feature [${featureName}] enabled`);
49
- }
50
- enabled.push(featureName);
51
- const paths = path instanceof Array ? path : [path];
52
- for (const nnP of paths) {
53
- const p = normalizePath(nnP);
54
- for (const m of methods) {
55
- if (logger) {
56
- logger.info("%s", featureName);
57
- logger.info("\t%s:%s", m.toUpperCase(), p);
58
- if ((handlerOptions as any).___filePath) {
59
- logger.info("\t%s", (handlerOptions as any).___filePath);
60
- }
61
- }
62
- if (enabledPaths[`${p}${m}`] !== undefined) {
63
- throw new Error(`${featureName} collides with feature ${enabledPaths[`${p}${m}`]} on path ${p} method ${m}`)
64
- }
65
- enabledPaths[`${p}${m}`] = featureName;
66
- router.use(implementation, p, m.toLocaleLowerCase() as Method);
67
- }
68
- }
69
- } else {
70
- if (logger) {
71
- logger.debug("feature [%s] disabled", featureName);
72
- }
73
- disabled.push(featureName);
74
- }
75
- }
76
- }
77
- }
78
- if (logger && enabled.length > 0) {
79
- logger.debug("enabled features [%s]", enabled.join(","));
80
- }
81
- if (logger) {
82
- if (disabled.length > 0) {
83
- logger.warn("disabled features [%s]", disabled.join(","));
84
- logger.warn(`to enable them just add the env var <feature>=true`);
85
- } else {
86
- logger.debug(`no features disabled`);
87
- }
88
- }
89
- return router;
90
- };
@@ -1,36 +0,0 @@
1
- import { OutgoingHttpHeaders } from "http";
2
- import { Context, Handler } from "../common";
3
-
4
- export type HTMLResponseResult = string | { status?: number; headers?: OutgoingHttpHeaders, body?: string; template: (ctx: Context) => Promise<string>; }
5
-
6
- export const HTMLResponseHandler = (): Handler<void> =>
7
- async (ctx: Context): Promise<void> => {
8
- const results = ctx.results;
9
- const lastResult = results[results.length - 1];
10
- ctx.logger.trace(`last result is [${lastResult}]`);
11
- if (lastResult && typeof lastResult === "string" ||
12
- (
13
- (typeof lastResult.headers === "object" || lastResult.headers === undefined) &&
14
- (typeof lastResult.status === "number" || lastResult.status === undefined) &&
15
- (typeof lastResult.body === "string" || typeof lastResult.template === "function")
16
- )
17
- ) {
18
- const status = typeof lastResult.status === "number" ? lastResult.status : 200;
19
- const headers = typeof lastResult.headers === "object" ? lastResult.headers : {
20
- "content-type": "text/html; charset=utf-8"
21
- };
22
- const toSend = lastResult.template ? await lastResult.template(ctx) : (typeof lastResult.body === "string" ? lastResult.body : lastResult);
23
- if (typeof toSend === "string") {
24
- ctx.logger.debug(`sending [${toSend}]`);
25
- await ctx.end({
26
- status,
27
- headers,
28
- body: toSend
29
- });
30
- } else {
31
- throw new Error("html result from HTMLResponseResult not string so last result not valid");
32
- }
33
- } else {
34
- throw new Error("html result from HTMLResponseResult not string so last result not valid");
35
- }
36
- }
@@ -1,3 +0,0 @@
1
- export * from "./html";
2
- export * from "./json";
3
- export * from "./result";
@@ -1,19 +0,0 @@
1
- import { Context, Handler } from "../common";
2
-
3
- export const ResponseHandler = (): Handler<void> =>
4
- async (ctx: Context): Promise<void> => {
5
- ctx.logger.trace("results [%o]", ctx.results);
6
- if (!ctx.results || ctx.results.length === 0) {
7
- throw new Error(`no response to send. Is your handler returning a value differente than boolean 'true|false' ?`);
8
- } else {
9
- const lastResult = ctx.results[ctx.results.length - 1];
10
- ctx.logger.debug("response [%o]", lastResult);
11
- if (lastResult !== undefined) {
12
- await ctx.json(lastResult);
13
- } else {
14
- throw new Error(`no response to send. Is your handler returning a value differente than boolean 'true|false' ?`);
15
- }
16
- }
17
- };
18
-
19
-
@@ -1,40 +0,0 @@
1
- import { parse, Parser } from "../../util";
2
- import { ParseOptions } from "../../util/parser/common";
3
- import { Context, Handler } from "../common";
4
-
5
- export const ResultParser = (options: ParseOptions | ParseOptions[], parser?: Parser): Handler<any> =>
6
- async (ctx: Context): Promise<any> => {
7
- if (!ctx.results || ctx.results.length === 0) {
8
- ctx.logger.debug(`not parsing results`);
9
- return undefined;
10
- } else {
11
- const index = ctx.results.length - 1;
12
- const lastResult = ctx.results[index];
13
- ctx.logger.trace(`parsing lastResult[%o]`, lastResult);
14
- try {
15
- if (options instanceof Array) {
16
- for (let i = 0; i < options.length; i++) {
17
- const o = options[i];
18
- try {
19
- const mappedResults = (parser ? parser.parse : parse)(`ctx.results[${index}]`, lastResult, o.options, o.mode, o.ignoreUndefined);
20
- ctx.logger.trace(`ctx.results[%s] mapped to %o`, index, mappedResults);
21
- return mappedResults;
22
- } catch (e) {
23
- if (i === options.length - 1) {
24
- throw e;
25
- } else {
26
- continue;
27
- }
28
- }
29
- }
30
- } else {
31
- const mappedResults = (parser ? parser.parse : parse)(`ctx.results[${index}]`, lastResult, options.options, options.mode, options.ignoreUndefined);
32
- ctx.logger.trace(`ctx.results[%s] mapped to %o`, index, mappedResults);
33
- return mappedResults;
34
- }
35
- } catch (e) {
36
- ctx.logger.error(`error parsing lastResult[%o]`, lastResult);
37
- throw e;
38
- }
39
- }
40
- };