@miqro/core 1.7.3 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -15
- package/dist/common/api-router-utils.d.ts +1 -1
- package/dist/common/api-router-utils.js +4 -1
- package/dist/common/config/config.d.ts +1 -1
- package/dist/common/context.d.ts +9 -4
- package/dist/common/context.js +1 -1
- package/dist/common/index.d.ts +1 -0
- package/dist/common/index.js +4 -0
- package/dist/common/logger/factory.d.ts +1 -1
- package/dist/common/logger/interfaces.d.ts +2 -2
- package/dist/common/router-handler.js +13 -5
- package/dist/common/router-utils.d.ts +17 -6
- package/dist/common/router-utils.js +51 -7
- package/dist/common/session/common.d.ts +3 -3
- package/dist/common/session/service.js +14 -11
- package/dist/middleware/parse.d.ts +9 -5
- package/dist/middleware/parse.js +16 -20
- package/dist/middleware/result.d.ts +7 -2
- package/dist/middleware/result.js +35 -28
- package/dist/middleware/session.js +25 -13
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -54,21 +54,15 @@ router.get("/add/:a/:b", {
|
|
|
54
54
|
request: {
|
|
55
55
|
body: false, // do not allow body
|
|
56
56
|
params: {
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
b: "number", // parse param :b to a number if posible if not throw
|
|
60
|
-
}
|
|
61
|
-
//,mode: "no_extra" // defaults to no_extra
|
|
57
|
+
a: "number", // parse param :a to a number if posible if not throw
|
|
58
|
+
b: "number", // parse param :b to a number if posible if not throw
|
|
62
59
|
},
|
|
63
60
|
query: {
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
defaultValue: "number"
|
|
70
|
-
},
|
|
71
|
-
mode: "add_extra"
|
|
61
|
+
decimals: "boolean?|number?", // two optional posible parsing types
|
|
62
|
+
format: {
|
|
63
|
+
type: "enum?", // optional enum
|
|
64
|
+
enumValues: ["number", "text"],
|
|
65
|
+
defaultValue: "number"
|
|
72
66
|
}
|
|
73
67
|
}
|
|
74
68
|
},
|
|
@@ -205,8 +199,8 @@ console.dir(router.getJSONDoc());
|
|
|
205
199
|
...
|
|
206
200
|
```
|
|
207
201
|
|
|
208
|
-
or generate a
|
|
202
|
+
or generate a json
|
|
209
203
|
|
|
210
|
-
```npx miqro doc
|
|
204
|
+
```npx miqro doc build/api /api```
|
|
211
205
|
|
|
212
206
|
where ```build/api``` is the APIRouter directory
|
|
@@ -11,7 +11,7 @@ export interface FeatureRouterPathOptions {
|
|
|
11
11
|
handler: Array<Handler> | Handler;
|
|
12
12
|
options?: RouterHandlerOptions;
|
|
13
13
|
}
|
|
14
|
-
export
|
|
14
|
+
export type FeatureRouterOptions = {
|
|
15
15
|
[name: string]: FeatureRouterPathOptions;
|
|
16
16
|
};
|
|
17
17
|
export declare const FeatureRouter: (options: FeatureRouterOptions, logger?: Logger) => Router;
|
|
@@ -77,6 +77,8 @@ function traverseAPIRouteDir(featureName, dirname, basePath = "/", features = {}
|
|
|
77
77
|
}
|
|
78
78
|
features[newFeatureSubPath] = {
|
|
79
79
|
options: {
|
|
80
|
+
identifier: newFeatureSubPath,
|
|
81
|
+
apiName: route.apiName,
|
|
80
82
|
name: route.name,
|
|
81
83
|
description: route.description,
|
|
82
84
|
parser: route.parser,
|
|
@@ -85,7 +87,8 @@ function traverseAPIRouteDir(featureName, dirname, basePath = "/", features = {}
|
|
|
85
87
|
policy: route.policy,
|
|
86
88
|
request: route.request,
|
|
87
89
|
response: {
|
|
88
|
-
body: route.response && route.response.body ? route.response.body : true
|
|
90
|
+
body: route.response && route.response.body ? route.response.body : true,
|
|
91
|
+
middleware: route.response && route.response.middleware ? route.response.middleware : undefined
|
|
89
92
|
}
|
|
90
93
|
},
|
|
91
94
|
path,
|
package/dist/common/context.d.ts
CHANGED
|
@@ -6,10 +6,15 @@ import { Session } from "./session";
|
|
|
6
6
|
import { IncomingHttpHeaders, IncomingMessage, OutgoingHttpHeaders, ServerResponse } from "http";
|
|
7
7
|
import { URL } from "url";
|
|
8
8
|
import { CookieSerializeOptions } from "cookie";
|
|
9
|
-
export
|
|
9
|
+
export type Method = "get" | "post" | "put" | "delete" | "patch" | "options" | "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
|
|
10
10
|
export declare const IGNORE_HEADER: string[];
|
|
11
|
-
export
|
|
12
|
-
|
|
11
|
+
export interface HandlerResponse {
|
|
12
|
+
status?: number;
|
|
13
|
+
headers?: OutgoingHttpHeaders;
|
|
14
|
+
body?: any;
|
|
15
|
+
}
|
|
16
|
+
export type Handler<T = boolean | void | HandlerResponse> = ((ctx: Context) => Promise<T>) | ((ctx: Context) => T);
|
|
17
|
+
export type ErrorHandler<T = boolean | void | any> = ((e: unknown, ctx: Context) => Promise<T>) | ((e: unknown, ctx: Context) => T);
|
|
13
18
|
export declare class Context {
|
|
14
19
|
readonly uuid: string;
|
|
15
20
|
readonly req: IncomingMessage;
|
|
@@ -43,7 +48,7 @@ export declare class Context {
|
|
|
43
48
|
write(chunk: any): Promise<void>;
|
|
44
49
|
end(args?: {
|
|
45
50
|
body?: any;
|
|
46
|
-
status
|
|
51
|
+
status?: number;
|
|
47
52
|
headers: OutgoingHttpHeaders;
|
|
48
53
|
}): Promise<void>;
|
|
49
54
|
json(body: any, headers?: OutgoingHttpHeaders, status?: number): Promise<void>;
|
package/dist/common/context.js
CHANGED
|
@@ -72,7 +72,7 @@ class Context {
|
|
|
72
72
|
const body = args ? args.body : undefined;
|
|
73
73
|
if (args !== undefined) {
|
|
74
74
|
const { status, headers } = args;
|
|
75
|
-
this.res.statusCode = status;
|
|
75
|
+
this.res.statusCode = status !== undefined ? status : 200;
|
|
76
76
|
const keys = Object.keys(headers);
|
|
77
77
|
for (const key of keys) {
|
|
78
78
|
if (exports.IGNORE_HEADER.indexOf(key.toLocaleLowerCase()) !== -1) {
|
package/dist/common/index.d.ts
CHANGED
package/dist/common/index.js
CHANGED
|
@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
exports.ResponseHandler = exports.OldResponseHandler = void 0;
|
|
17
18
|
__exportStar(require("./context"), exports);
|
|
18
19
|
__exportStar(require("./router-helpers"), exports);
|
|
19
20
|
__exportStar(require("./api-router"), exports);
|
|
@@ -21,3 +22,6 @@ __exportStar(require("./session"), exports);
|
|
|
21
22
|
__exportStar(require("./error"), exports);
|
|
22
23
|
__exportStar(require("./config"), exports);
|
|
23
24
|
__exportStar(require("./logger"), exports);
|
|
25
|
+
var router_utils_1 = require("./router-utils");
|
|
26
|
+
Object.defineProperty(exports, "OldResponseHandler", { enumerable: true, get: function () { return router_utils_1.OldResponseHandler; } });
|
|
27
|
+
Object.defineProperty(exports, "ResponseHandler", { enumerable: true, get: function () { return router_utils_1.ResponseHandler; } });
|
|
@@ -4,7 +4,7 @@ export declare const getLogger: (identifier: string, options?: {
|
|
|
4
4
|
formatter?: LoggerFormatter;
|
|
5
5
|
transports?: LoggerTransport[];
|
|
6
6
|
}, useCache?: boolean) => Logger;
|
|
7
|
-
export
|
|
7
|
+
export type LoggerFactory = (args: {
|
|
8
8
|
identifier: string;
|
|
9
9
|
level: LogLevel;
|
|
10
10
|
options?: {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type LogLevel = "error" | "warn" | "info" | "debug" | "trace";
|
|
2
2
|
export interface WriteArgs {
|
|
3
3
|
level: LogLevel;
|
|
4
4
|
message?: any;
|
|
@@ -11,7 +11,7 @@ export interface LoggerTransport {
|
|
|
11
11
|
level?: LogLevel;
|
|
12
12
|
write(args: LoggerTransportWriteArgs): Promise<void> | void;
|
|
13
13
|
}
|
|
14
|
-
export
|
|
14
|
+
export type LoggerFormatter = (args: {
|
|
15
15
|
identifier: string;
|
|
16
16
|
level: LogLevel;
|
|
17
17
|
message: string;
|
|
@@ -51,12 +51,18 @@ class RouterHandler {
|
|
|
51
51
|
}
|
|
52
52
|
handlers = handlers.concat(routeHandlers);
|
|
53
53
|
if (this.options && this.options.response) {
|
|
54
|
+
const responseMiddleware = this.options.response.middleware ? (this.options.response.middleware instanceof Array ?
|
|
55
|
+
this.options.response.middleware :
|
|
56
|
+
[this.options.response.middleware]) :
|
|
57
|
+
[(0, router_utils_1.ResponseHandler)()];
|
|
54
58
|
if (typeof this.options.response.body === "boolean" && this.options.response.body) {
|
|
55
|
-
handlers.push(
|
|
59
|
+
//(handlers as Handler[]).push(ResponseHandler());
|
|
60
|
+
handlers = handlers.concat(responseMiddleware);
|
|
56
61
|
}
|
|
57
62
|
else if (this.options.response.body) {
|
|
58
|
-
handlers.push((0, middleware_1.ResultParser)(this.options.response
|
|
59
|
-
handlers.push(
|
|
63
|
+
handlers.push((0, middleware_1.ResultParser)(this.options.response, this.options.parser));
|
|
64
|
+
//(handlers as Handler[]).push(ResponseHandler());
|
|
65
|
+
handlers = handlers.concat(responseMiddleware);
|
|
60
66
|
}
|
|
61
67
|
}
|
|
62
68
|
this.handler = handlers;
|
|
@@ -78,7 +84,7 @@ class RouterHandler {
|
|
|
78
84
|
doc[`${prePath}${nPath}`][nMethod] = {
|
|
79
85
|
description: this.options.description,
|
|
80
86
|
name: this.options.name,
|
|
81
|
-
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(),
|
|
87
|
+
identifier: this.options.identifier ? this.options.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(),
|
|
82
88
|
policy: this.options.policy,
|
|
83
89
|
request: this.options.request ? {
|
|
84
90
|
body: this.options.request.body,
|
|
@@ -86,7 +92,9 @@ class RouterHandler {
|
|
|
86
92
|
params: this.options.request.params,
|
|
87
93
|
query: this.options.request.query,
|
|
88
94
|
} : undefined,
|
|
89
|
-
response: this.options.response
|
|
95
|
+
response: this.options.response ? {
|
|
96
|
+
body: this.options.response.body
|
|
97
|
+
} : undefined
|
|
90
98
|
};
|
|
91
99
|
}
|
|
92
100
|
return doc;
|
|
@@ -1,20 +1,31 @@
|
|
|
1
1
|
import { Handler } from "./context";
|
|
2
|
-
import { ParseOptionMap,
|
|
2
|
+
import { ParseOptionMap, ParserArgs, ParserInterface, ParserMode } from "@miqro/parser";
|
|
3
3
|
import { GroupPolicy, SessionHandlerOptions } from "./session";
|
|
4
|
+
export declare const OldResponseHandler: () => Handler<void>;
|
|
4
5
|
export declare const ResponseHandler: () => Handler<void>;
|
|
5
6
|
export declare const routeParseOptions: ParseOptionMap;
|
|
6
7
|
export interface RouteOptions {
|
|
7
8
|
name?: string;
|
|
9
|
+
identifier?: string;
|
|
10
|
+
apiName?: string;
|
|
8
11
|
description?: string;
|
|
9
12
|
policy?: GroupPolicy;
|
|
10
13
|
request?: {
|
|
11
|
-
headers?:
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
14
|
+
headers?: ParserArgs | ParserArgs[];
|
|
15
|
+
headersMode?: ParserMode;
|
|
16
|
+
query?: ParserArgs | boolean | ParserArgs[];
|
|
17
|
+
queryMode?: ParserMode;
|
|
18
|
+
params?: ParserArgs | boolean | ParserArgs[];
|
|
19
|
+
paramsMode?: ParserMode;
|
|
20
|
+
body?: ParserArgs | boolean | ParserArgs[];
|
|
21
|
+
bodyMode?: ParserMode;
|
|
15
22
|
};
|
|
16
23
|
response?: {
|
|
17
|
-
|
|
24
|
+
headers?: ParserArgs | ParserArgs[];
|
|
25
|
+
headersMode?: ParserMode;
|
|
26
|
+
body?: boolean | ParserArgs | ParserArgs[];
|
|
27
|
+
bodyMode?: ParserMode;
|
|
28
|
+
middleware?: Handler | Handler[];
|
|
18
29
|
};
|
|
19
30
|
}
|
|
20
31
|
export interface RouteJSONDoc extends RouteOptions {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.handlerWithOptionsParseOptions = exports.routerHandlerParseOptions = exports.routeParseOptions = exports.ResponseHandler = void 0;
|
|
4
|
-
const
|
|
3
|
+
exports.handlerWithOptionsParseOptions = exports.routerHandlerParseOptions = exports.routeParseOptions = exports.ResponseHandler = exports.OldResponseHandler = void 0;
|
|
4
|
+
const OldResponseHandler = () => async (ctx) => {
|
|
5
5
|
ctx.logger.trace("results [%o]", ctx.results);
|
|
6
6
|
if (!ctx.results || ctx.results.length === 0) {
|
|
7
7
|
throw new Error(`no response to send. Is your handler returning a value differente than boolean 'true|false' ?`);
|
|
@@ -17,16 +17,52 @@ const ResponseHandler = () => async (ctx) => {
|
|
|
17
17
|
}
|
|
18
18
|
}
|
|
19
19
|
};
|
|
20
|
+
exports.OldResponseHandler = OldResponseHandler;
|
|
21
|
+
const ResponseHandler = () => async (ctx) => {
|
|
22
|
+
ctx.logger.trace("results [%o]", ctx.results);
|
|
23
|
+
if (!ctx.results || ctx.results.length === 0) {
|
|
24
|
+
throw new Error(`no response to send. Is your handler returning a value differente than boolean 'true|false' ?`);
|
|
25
|
+
}
|
|
26
|
+
else {
|
|
27
|
+
const lastResult = ctx.results[ctx.results.length - 1];
|
|
28
|
+
ctx.logger.debug("response [%o]", lastResult);
|
|
29
|
+
if (lastResult !== undefined) {
|
|
30
|
+
const headers = lastResult.headers;
|
|
31
|
+
const body = lastResult.body;
|
|
32
|
+
const status = lastResult.status;
|
|
33
|
+
const noContentType = (headers && !headers["Content-Type"]) || !headers;
|
|
34
|
+
if (noContentType) {
|
|
35
|
+
await ctx.json(body, headers, status);
|
|
36
|
+
}
|
|
37
|
+
else {
|
|
38
|
+
ctx.end({
|
|
39
|
+
body,
|
|
40
|
+
headers,
|
|
41
|
+
status
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
else {
|
|
46
|
+
throw new Error(`no response to send. Is your handler returning a value differente than boolean 'true|false' ?`);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
};
|
|
20
50
|
exports.ResponseHandler = ResponseHandler;
|
|
21
51
|
exports.routeParseOptions = {
|
|
22
52
|
name: "string?",
|
|
23
53
|
description: "string?",
|
|
54
|
+
identifier: "string?",
|
|
55
|
+
apiName: "string?",
|
|
24
56
|
policy: "GroupPolicy?",
|
|
25
57
|
response: {
|
|
26
58
|
type: "nested?",
|
|
27
59
|
nestedOptions: {
|
|
28
60
|
options: {
|
|
29
|
-
|
|
61
|
+
headers: "ParserArgs[]!?",
|
|
62
|
+
headersMode: "ParserMode?",
|
|
63
|
+
body: "boolean?|ParserArgs[]!?",
|
|
64
|
+
bodyMode: "ParserMode?",
|
|
65
|
+
middleware: "function[]!?"
|
|
30
66
|
},
|
|
31
67
|
mode: "no_extra"
|
|
32
68
|
}
|
|
@@ -35,10 +71,18 @@ exports.routeParseOptions = {
|
|
|
35
71
|
type: "nested?",
|
|
36
72
|
nestedOptions: {
|
|
37
73
|
options: {
|
|
38
|
-
headers: "
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
74
|
+
headers: "ParserArgs[]!?",
|
|
75
|
+
headersMode: {
|
|
76
|
+
type: "ParserMode",
|
|
77
|
+
required: false,
|
|
78
|
+
defaultValue: "add_extra"
|
|
79
|
+
},
|
|
80
|
+
query: "boolean?|ParserArgs[]!?",
|
|
81
|
+
queryMode: "ParserMode?",
|
|
82
|
+
params: "boolean?|ParserArgs[]!?",
|
|
83
|
+
paramsMode: "ParserMode?",
|
|
84
|
+
body: "boolean?|ParserArgs[]!?",
|
|
85
|
+
bodyMode: "ParserMode?",
|
|
42
86
|
},
|
|
43
87
|
mode: "no_extra"
|
|
44
88
|
}
|
|
@@ -17,7 +17,7 @@ export interface SessionHandlerOptions {
|
|
|
17
17
|
};
|
|
18
18
|
};
|
|
19
19
|
}
|
|
20
|
-
|
|
20
|
+
type Dict<T = any> = {
|
|
21
21
|
[key: string]: T;
|
|
22
22
|
};
|
|
23
23
|
export interface NoTokenSession extends Dict {
|
|
@@ -28,8 +28,8 @@ export interface NoTokenSession extends Dict {
|
|
|
28
28
|
export interface Session extends NoTokenSession {
|
|
29
29
|
token: string;
|
|
30
30
|
}
|
|
31
|
-
export
|
|
32
|
-
export
|
|
31
|
+
export type GroupPolicyType = "at_least_one" | "all";
|
|
32
|
+
export type GroupPolicyGroups = string | string[];
|
|
33
33
|
export interface GroupPolicy {
|
|
34
34
|
groups: GroupPolicyGroups[];
|
|
35
35
|
groupPolicy: GroupPolicyType;
|
|
@@ -36,12 +36,15 @@ class VerifyEndpointService {
|
|
|
36
36
|
};
|
|
37
37
|
}
|
|
38
38
|
else {
|
|
39
|
-
this.options = (0, parser_1.parse)(options,
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
39
|
+
this.options = (0, parser_1.parse)(options, {
|
|
40
|
+
url: "string1",
|
|
41
|
+
method: "string1",
|
|
42
|
+
tokenLocation: {
|
|
43
|
+
type: "enum",
|
|
44
|
+
enumValues: ["header", "query", "cookie"]
|
|
45
|
+
},
|
|
46
|
+
tokenLocationName: "string1"
|
|
47
|
+
}, "no_extra", "options");
|
|
45
48
|
}
|
|
46
49
|
if (this.options.tokenLocationName && (this.options.tokenLocationName === "__proto__" || this.options.tokenLocationName === "__prototype__")) {
|
|
47
50
|
throw new Error(`invalid tokenLocationName ${this.options.tokenLocationName}`);
|
|
@@ -129,11 +132,11 @@ class VerifyEndpointService {
|
|
|
129
132
|
}
|
|
130
133
|
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
131
134
|
checkSession(session, ctx) {
|
|
132
|
-
(0, parser_1.parse)(session,
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
135
|
+
(0, parser_1.parse)(session, {
|
|
136
|
+
username: "string",
|
|
137
|
+
account: "string",
|
|
138
|
+
groups: "string[]"
|
|
139
|
+
}, "add_extra", "session");
|
|
137
140
|
return true;
|
|
138
141
|
}
|
|
139
142
|
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
@@ -1,9 +1,13 @@
|
|
|
1
1
|
import { Handler } from "../common";
|
|
2
|
-
import {
|
|
2
|
+
import { ParserArgs, ParserInterface, ParserMode } from "@miqro/parser";
|
|
3
3
|
export interface ParseRequestOptions {
|
|
4
|
-
headers?:
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
4
|
+
headers?: ParserArgs | ParserArgs[];
|
|
5
|
+
headersMode?: ParserMode;
|
|
6
|
+
query?: ParserArgs | boolean | ParserArgs[];
|
|
7
|
+
queryMode?: ParserMode;
|
|
8
|
+
params?: ParserArgs | boolean | ParserArgs[];
|
|
9
|
+
paramsMode?: ParserMode;
|
|
10
|
+
body?: ParserArgs | boolean | ParserArgs[];
|
|
11
|
+
bodyMode?: ParserMode;
|
|
8
12
|
}
|
|
9
13
|
export declare const ParseRequest: (options: ParseRequestOptions, parser?: ParserInterface) => Handler<void>;
|
package/dist/middleware/parse.js
CHANGED
|
@@ -2,26 +2,22 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ParseRequest = void 0;
|
|
4
4
|
const parser_1 = require("@miqro/parser");
|
|
5
|
-
const NO_OPTIONS = [{
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
5
|
+
const NO_OPTIONS = [{}];
|
|
6
|
+
const ADD_EXTRA = ["any"];
|
|
7
|
+
const normalizeParseOptions = (option) => option !== undefined && typeof option !== "string" && typeof option !== "boolean" ?
|
|
8
|
+
(option instanceof Array ? option : [option]) :
|
|
9
|
+
(typeof option === "boolean" ?
|
|
10
|
+
(option ? ADD_EXTRA : NO_OPTIONS) :
|
|
11
|
+
(typeof option === "string" ? [option] : ADD_EXTRA));
|
|
12
|
+
const parseRequestPart = (part, ctx, option, mode, parser) => {
|
|
13
|
+
if (part === "headers" && mode === undefined) {
|
|
14
|
+
mode = "add_extra";
|
|
15
|
+
}
|
|
15
16
|
const value = ctx[part] === undefined ? {} : ctx[part];
|
|
16
17
|
for (let i = 0; i < option.length; i++) {
|
|
17
18
|
const o = option[i];
|
|
18
19
|
try {
|
|
19
|
-
|
|
20
|
-
ctx[part] = (parser ? parser : { parse: parser_1.parse }).parse(value, o.options, o.mode, `${part}`);
|
|
21
|
-
}
|
|
22
|
-
else {
|
|
23
|
-
ctx[part] = (parser ? parser : { parse: parser_1.parse }).parse(value, o, "no_extra", `${part}`);
|
|
24
|
-
}
|
|
20
|
+
ctx[part] = (parser ? parser : { parse: parser_1.parse }).parse(value, o, mode, `${part}`);
|
|
25
21
|
ctx.logger.debug("req.%s parsed to [%o]", part, ctx[part]);
|
|
26
22
|
return;
|
|
27
23
|
}
|
|
@@ -41,7 +37,7 @@ const ParseRequest = (options, parser) => {
|
|
|
41
37
|
try {
|
|
42
38
|
try {
|
|
43
39
|
if (options.headers !== undefined) {
|
|
44
|
-
parseRequestPart("headers", ctx, headers, parser);
|
|
40
|
+
parseRequestPart("headers", ctx, headers, options.headersMode, parser);
|
|
45
41
|
}
|
|
46
42
|
}
|
|
47
43
|
catch (e) {
|
|
@@ -50,7 +46,7 @@ const ParseRequest = (options, parser) => {
|
|
|
50
46
|
}
|
|
51
47
|
try {
|
|
52
48
|
if (options.query !== undefined) {
|
|
53
|
-
parseRequestPart("query", ctx, query, parser);
|
|
49
|
+
parseRequestPart("query", ctx, query, options.queryMode, parser);
|
|
54
50
|
}
|
|
55
51
|
}
|
|
56
52
|
catch (e) {
|
|
@@ -59,7 +55,7 @@ const ParseRequest = (options, parser) => {
|
|
|
59
55
|
}
|
|
60
56
|
try {
|
|
61
57
|
if (options.params !== undefined) {
|
|
62
|
-
parseRequestPart("params", ctx, params, parser);
|
|
58
|
+
parseRequestPart("params", ctx, params, options.paramsMode, parser);
|
|
63
59
|
}
|
|
64
60
|
}
|
|
65
61
|
catch (e) {
|
|
@@ -68,7 +64,7 @@ const ParseRequest = (options, parser) => {
|
|
|
68
64
|
}
|
|
69
65
|
try {
|
|
70
66
|
if (options.body !== undefined) {
|
|
71
|
-
parseRequestPart("body", ctx, body, parser);
|
|
67
|
+
parseRequestPart("body", ctx, body, options.bodyMode, parser);
|
|
72
68
|
}
|
|
73
69
|
}
|
|
74
70
|
catch (e) {
|
|
@@ -1,3 +1,8 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ParserArgs, ParserInterface, ParserMode } from "@miqro/parser";
|
|
2
2
|
import { Handler } from "../common/context";
|
|
3
|
-
export declare const ResultParser: (options:
|
|
3
|
+
export declare const ResultParser: (options: {
|
|
4
|
+
headers?: ParserArgs | ParserArgs[];
|
|
5
|
+
headersMode?: ParserMode;
|
|
6
|
+
body?: boolean | ParserArgs | ParserArgs[];
|
|
7
|
+
bodyMode?: ParserMode;
|
|
8
|
+
}, parser?: ParserInterface) => Handler;
|
|
@@ -3,7 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.ResultParser = void 0;
|
|
4
4
|
const parser_1 = require("@miqro/parser");
|
|
5
5
|
const ResultParser = (options, parser) => {
|
|
6
|
-
options =
|
|
6
|
+
//options = parse(options, "ParserArgs[]!", undefined, "options");
|
|
7
|
+
const bodyParser = options.body instanceof Array ?
|
|
8
|
+
options.body :
|
|
9
|
+
typeof options.body === "boolean" ?
|
|
10
|
+
options.body === true ?
|
|
11
|
+
["any"] : [] : (options.body ? [options.body] : []);
|
|
12
|
+
const headersParser = options.headers instanceof Array ?
|
|
13
|
+
options.headers :
|
|
14
|
+
typeof options.headers === "boolean" ?
|
|
15
|
+
options.headers === true ?
|
|
16
|
+
["any"] : [] : (options.headers ? [options.headers] : []);
|
|
7
17
|
return async function ResultParser(ctx) {
|
|
8
18
|
if (!ctx.results || ctx.results.length === 0) {
|
|
9
19
|
ctx.logger.debug(`not parsing results`);
|
|
@@ -11,40 +21,37 @@ const ResultParser = (options, parser) => {
|
|
|
11
21
|
}
|
|
12
22
|
else {
|
|
13
23
|
const index = ctx.results.length - 1;
|
|
14
|
-
const lastResult = ctx.results[index];
|
|
15
|
-
ctx.logger.trace(`parsing lastResult[%o]`, lastResult);
|
|
24
|
+
const lastResult = ctx.results[index] ? ctx.results[index] : undefined;
|
|
25
|
+
ctx.logger.trace(`parsing lastResult.body[%o]`, lastResult);
|
|
16
26
|
try {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
return mappedResults;
|
|
24
|
-
}
|
|
25
|
-
catch (e) {
|
|
26
|
-
if (i === options.length - 1) {
|
|
27
|
-
throw e;
|
|
28
|
-
}
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
else if (typeof options !== "string") {
|
|
33
|
-
const mappedResults = (parser ? parser : { parse: parser_1.parse }).parse(lastResult, options.options, options.mode, `ctx.results[${index}]`);
|
|
34
|
-
ctx.logger.trace(`ctx.results[%s] mapped to %o`, index, mappedResults);
|
|
35
|
-
return mappedResults;
|
|
36
|
-
}
|
|
37
|
-
else {
|
|
38
|
-
const mappedResults = (parser ? parser : { parse: parser_1.parse }).parse(lastResult, options, "no_extra", `ctx.results[${index}]`);
|
|
39
|
-
ctx.logger.trace(`ctx.results[%s] mapped to %o`, index, mappedResults);
|
|
40
|
-
return mappedResults;
|
|
41
|
-
}
|
|
27
|
+
const mappedLastResult = {
|
|
28
|
+
...lastResult
|
|
29
|
+
};
|
|
30
|
+
mappedLastResult.body = parsePart(ctx, "body", lastResult.body, bodyParser, options.bodyMode, parser);
|
|
31
|
+
mappedLastResult.headers = parsePart(ctx, "headers", lastResult.headers, headersParser, options.headersMode, parser);
|
|
32
|
+
return mappedLastResult;
|
|
42
33
|
}
|
|
43
34
|
catch (e) {
|
|
44
35
|
ctx.logger.error(`error parsing lastResult[%o]`, lastResult);
|
|
36
|
+
ctx.logger.error(e);
|
|
45
37
|
throw e;
|
|
46
38
|
}
|
|
47
39
|
}
|
|
48
40
|
};
|
|
49
41
|
};
|
|
50
42
|
exports.ResultParser = ResultParser;
|
|
43
|
+
function parsePart(ctx, part, value, args, mode, parser) {
|
|
44
|
+
for (let i = 0; i < args.length; i++) {
|
|
45
|
+
const o = args[i];
|
|
46
|
+
try {
|
|
47
|
+
const mappedResultBody = (parser ? parser : { parse: parser_1.parse }).parse(value, o, mode, `ctx.results.${part}`);
|
|
48
|
+
ctx.logger.trace(`ctx.results.%s mapped to %o`, part, mappedResultBody);
|
|
49
|
+
return mappedResultBody;
|
|
50
|
+
}
|
|
51
|
+
catch (e) {
|
|
52
|
+
if (i === args.length - 1) {
|
|
53
|
+
throw e;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
@@ -46,26 +46,38 @@ const SessionHandler = (config) => {
|
|
|
46
46
|
}
|
|
47
47
|
}
|
|
48
48
|
else {
|
|
49
|
-
config.options = (0, parser_1.parse)(config.options,
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
49
|
+
config.options = (0, parser_1.parse)(config.options, {
|
|
50
|
+
tokenLocation: {
|
|
51
|
+
required: true,
|
|
52
|
+
type: "enum",
|
|
53
|
+
enumValues: ["header", "query", "cookie"]
|
|
54
|
+
},
|
|
55
|
+
tokenLocationName: {
|
|
56
|
+
required: true,
|
|
57
|
+
type: "any"
|
|
58
|
+
},
|
|
59
|
+
setCookieOptions: {
|
|
60
|
+
required: false,
|
|
61
|
+
type: "nested",
|
|
62
|
+
defaultValue: {
|
|
54
63
|
httpOnly: DEFAULT_TOKEN_SET_COOKIE_HTTP_ONLY === "true",
|
|
55
64
|
secure: DEFAULT_TOKEN_SET_COOKIE_SECURE === "true",
|
|
56
65
|
path: DEFAULT_TOKEN_SET_COOKIE_PATH,
|
|
57
66
|
sameSite: DEFAULT_TOKEN_SET_COOKIE_SAME_SITE,
|
|
58
|
-
},
|
|
67
|
+
},
|
|
68
|
+
nestedOptions: {
|
|
59
69
|
mode: "no_extra",
|
|
60
|
-
options:
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
70
|
+
options: {
|
|
71
|
+
httpOnly: "boolean",
|
|
72
|
+
secure: "boolean",
|
|
73
|
+
path: "any",
|
|
74
|
+
sameSite: {
|
|
75
|
+
required: true, type: "enum", enumValues: ["lax", "strict", "none"]
|
|
76
|
+
}
|
|
77
|
+
}
|
|
66
78
|
}
|
|
67
79
|
}
|
|
68
|
-
|
|
80
|
+
}, "no_extra", "options");
|
|
69
81
|
}
|
|
70
82
|
if (!config.authService) {
|
|
71
83
|
throw new Error("authService must be provided!");
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@miqro/core",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.2",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -15,10 +15,10 @@
|
|
|
15
15
|
"author": "claukers",
|
|
16
16
|
"license": "ISC",
|
|
17
17
|
"devDependencies": {
|
|
18
|
-
"@miqro/test": "0.2.
|
|
18
|
+
"@miqro/test": "0.2.9",
|
|
19
19
|
"@miqro/test-http": "0.0.9",
|
|
20
20
|
"@types/node": "18.6.1",
|
|
21
|
-
"typescript": "
|
|
21
|
+
"typescript": "5.0.4",
|
|
22
22
|
"@types/cookie": "0.5.1"
|
|
23
23
|
},
|
|
24
24
|
"engines": {
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"npm": ">=6.0.0"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@miqro/parser": "^0.1
|
|
29
|
+
"@miqro/parser": "^1.0.1",
|
|
30
30
|
"@miqro/request": "^0.1.3",
|
|
31
31
|
"cookie": "0.5.0"
|
|
32
32
|
}
|