@miqro/core 1.7.1 → 1.7.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/dist/api-router.js +0 -1
- package/dist/app-utils.js +0 -1
- package/dist/app.js +0 -1
- package/dist/common/api-router-utils.js +0 -1
- package/dist/common/api-router.js +0 -1
- package/dist/common/config/config.js +0 -1
- package/dist/common/config/featuretoggle.js +0 -1
- package/dist/common/config/index.js +0 -1
- package/dist/common/config/loader.js +0 -1
- package/dist/common/context.js +0 -1
- package/dist/common/error/badrequesterror.js +0 -1
- package/dist/common/error/configfilenotfound.js +0 -1
- package/dist/common/error/forbiddenerror.js +0 -1
- package/dist/common/error/index.js +0 -1
- package/dist/common/error/notfound.js +0 -1
- package/dist/common/error/notimplemented.js +0 -1
- package/dist/common/error/unauthorizederror.js +0 -1
- package/dist/common/helpers.js +0 -1
- package/dist/common/index.js +0 -1
- package/dist/common/logger/constants.js +0 -1
- package/dist/common/logger/factory.js +0 -1
- package/dist/common/logger/index.js +0 -1
- package/dist/common/logger/interfaces.js +0 -1
- package/dist/common/logger/logger.js +0 -1
- package/dist/common/logger/transport/console.js +0 -1
- package/dist/common/logger/transport/file.js +0 -1
- package/dist/common/router-handler.js +0 -1
- package/dist/common/router-helpers.js +0 -1
- package/dist/common/router-utils.js +0 -1
- package/dist/common/session/common.js +0 -1
- package/dist/common/session/index.js +0 -1
- package/dist/common/session/service.js +0 -1
- package/dist/common/tokenize-match.js +0 -1
- package/dist/index.js +0 -1
- package/dist/middleware/buffer.js +0 -1
- package/dist/middleware/cookie.js +0 -1
- package/dist/middleware/cors.js +0 -1
- package/dist/middleware/form.js +0 -1
- package/dist/middleware/group.js +0 -1
- package/dist/middleware/index.js +0 -1
- package/dist/middleware/json.js +0 -1
- package/dist/middleware/logger.js +0 -1
- package/dist/middleware/parse.js +0 -1
- package/dist/middleware/result.js +0 -1
- package/dist/middleware/session.js +0 -1
- package/dist/middleware/tag.js +0 -1
- package/dist/middleware/text.js +0 -1
- package/dist/proxy.js +0 -1
- package/dist/router.js +0 -1
- package/dist/static.js +0 -1
- package/package.json +6 -6
- package/dist/api-router.js.map +0 -1
- package/dist/app-utils.js.map +0 -1
- package/dist/app.js.map +0 -1
- package/dist/common/api-router-utils.js.map +0 -1
- package/dist/common/api-router.js.map +0 -1
- package/dist/common/config/config.js.map +0 -1
- package/dist/common/config/featuretoggle.js.map +0 -1
- package/dist/common/config/index.js.map +0 -1
- package/dist/common/config/loader.js.map +0 -1
- package/dist/common/context.js.map +0 -1
- package/dist/common/error/badrequesterror.js.map +0 -1
- package/dist/common/error/configfilenotfound.js.map +0 -1
- package/dist/common/error/forbiddenerror.js.map +0 -1
- package/dist/common/error/index.js.map +0 -1
- package/dist/common/error/notfound.js.map +0 -1
- package/dist/common/error/notimplemented.js.map +0 -1
- package/dist/common/error/unauthorizederror.js.map +0 -1
- package/dist/common/helpers.js.map +0 -1
- package/dist/common/index.js.map +0 -1
- package/dist/common/logger/constants.js.map +0 -1
- package/dist/common/logger/factory.js.map +0 -1
- package/dist/common/logger/index.js.map +0 -1
- package/dist/common/logger/interfaces.js.map +0 -1
- package/dist/common/logger/logger.js.map +0 -1
- package/dist/common/logger/transport/console.js.map +0 -1
- package/dist/common/logger/transport/file.js.map +0 -1
- package/dist/common/router-handler.js.map +0 -1
- package/dist/common/router-helpers.js.map +0 -1
- package/dist/common/router-utils.js.map +0 -1
- package/dist/common/session/common.js.map +0 -1
- package/dist/common/session/index.js.map +0 -1
- package/dist/common/session/service.js.map +0 -1
- package/dist/common/tokenize-match.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/middleware/buffer.js.map +0 -1
- package/dist/middleware/cookie.js.map +0 -1
- package/dist/middleware/cors.js.map +0 -1
- package/dist/middleware/form.js.map +0 -1
- package/dist/middleware/group.js.map +0 -1
- package/dist/middleware/index.js.map +0 -1
- package/dist/middleware/json.js.map +0 -1
- package/dist/middleware/logger.js.map +0 -1
- package/dist/middleware/parse.js.map +0 -1
- package/dist/middleware/result.js.map +0 -1
- package/dist/middleware/session.js.map +0 -1
- package/dist/middleware/tag.js.map +0 -1
- package/dist/middleware/text.js.map +0 -1
- package/dist/proxy.js.map +0 -1
- package/dist/router.js.map +0 -1
- package/dist/static.js.map +0 -1
- package/src/api-router.ts +0 -60
- package/src/api-router.unit.test.js +0 -273
- package/src/app-utils.ts +0 -82
- package/src/app-utils.unit.test.js +0 -100
- package/src/app.ts +0 -51
- package/src/app.unit.test.js +0 -333
- package/src/common/api-router-utils.ts +0 -193
- package/src/common/api-router.ts +0 -19
- package/src/common/config/config.ts +0 -111
- package/src/common/config/featuretoggle.ts +0 -6
- package/src/common/config/index.ts +0 -3
- package/src/common/config/loader.ts +0 -80
- package/src/common/context.ts +0 -167
- package/src/common/context.unit.test.js +0 -288
- package/src/common/error/badrequesterror.ts +0 -6
- package/src/common/error/configfilenotfound.ts +0 -6
- package/src/common/error/forbiddenerror.ts +0 -6
- package/src/common/error/index.ts +0 -6
- package/src/common/error/notfound.ts +0 -6
- package/src/common/error/notimplemented.ts +0 -6
- package/src/common/error/unauthorizederror.ts +0 -6
- package/src/common/helpers.ts +0 -11
- package/src/common/index.ts +0 -7
- package/src/common/logger/constants.ts +0 -27
- package/src/common/logger/factory.ts +0 -53
- package/src/common/logger/index.ts +0 -6
- package/src/common/logger/interfaces.ts +0 -19
- package/src/common/logger/logger.ts +0 -136
- package/src/common/logger/transport/console.ts +0 -34
- package/src/common/logger/transport/file.ts +0 -26
- package/src/common/router-handler.ts +0 -159
- package/src/common/router-helpers.ts +0 -20
- package/src/common/router-utils.ts +0 -95
- package/src/common/session/common.ts +0 -40
- package/src/common/session/index.ts +0 -2
- package/src/common/session/service.ts +0 -160
- package/src/common/tokenize-match.ts +0 -130
- package/src/index.ts +0 -7
- package/src/middleware/buffer.ts +0 -80
- package/src/middleware/cookie.ts +0 -20
- package/src/middleware/cors.ts +0 -96
- package/src/middleware/form.ts +0 -59
- package/src/middleware/group.ts +0 -70
- package/src/middleware/index.ts +0 -48
- package/src/middleware/json.ts +0 -55
- package/src/middleware/logger.ts +0 -18
- package/src/middleware/parse.ts +0 -93
- package/src/middleware/result.ts +0 -43
- package/src/middleware/session.ts +0 -136
- package/src/middleware/tag.ts +0 -15
- package/src/middleware/text.ts +0 -45
- package/src/proxy.ts +0 -77
- package/src/proxy.unit.test.js +0 -159
- package/src/router.ts +0 -112
- package/src/router.unit.test.js +0 -396
- package/src/setup-test.js +0 -5
- package/src/static.ts +0 -238
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
import { LoggerFormatter, LoggerTransport, LogLevel } from "./interfaces";
|
|
2
|
-
import { ConfigStore } from "../config";
|
|
3
|
-
import {Logger} from "./logger.js";
|
|
4
|
-
import {DEFAULT_LOGGER_FORMATTER, DEFAULT_LOGGER_TRANSPORTS} from "./constants.js";
|
|
5
|
-
|
|
6
|
-
const loggerContainer: Map<string, Logger> = new Map<string, Logger>();
|
|
7
|
-
const DEFAULT_ENV_NAME = "LOG_LEVEL";
|
|
8
|
-
|
|
9
|
-
export const getLogger = (identifier: string, options?: { formatter?: LoggerFormatter, transports?: LoggerTransport[] }, useCache = true): Logger => {
|
|
10
|
-
if (typeof identifier !== "string" && typeof identifier !== "undefined") {
|
|
11
|
-
throw new Error("Bad log identifier");
|
|
12
|
-
}
|
|
13
|
-
if (useCache && loggerContainer.has(identifier)) {
|
|
14
|
-
return loggerContainer.get(identifier) as Logger;
|
|
15
|
-
} else {
|
|
16
|
-
const envVarName = `LOG_LEVEL_${identifier}`;
|
|
17
|
-
const level = ConfigStore.getConfig(envVarName) ? ConfigStore.getConfig(envVarName) as LogLevel : ConfigStore.getConfig(DEFAULT_ENV_NAME, "info") as LogLevel;
|
|
18
|
-
const factory = getLoggerFactory();
|
|
19
|
-
const logger = factory({ identifier, level, options });
|
|
20
|
-
if (useCache) {
|
|
21
|
-
loggerContainer.set(identifier, logger);
|
|
22
|
-
}
|
|
23
|
-
return logger;
|
|
24
|
-
}
|
|
25
|
-
};
|
|
26
|
-
|
|
27
|
-
export type LoggerFactory = (args: { identifier: string, level: LogLevel; options?: { transports?: LoggerTransport[]; formatter?: LoggerFormatter; } }) => Logger;
|
|
28
|
-
|
|
29
|
-
const defaultLoggerFactory: LoggerFactory = ({ identifier, options, level }): Logger => {
|
|
30
|
-
return new Logger(identifier, level, {
|
|
31
|
-
formatter: options && options.formatter ? options.formatter : DEFAULT_LOGGER_FORMATTER,
|
|
32
|
-
transports: options && options.transports ? options.transports : DEFAULT_LOGGER_TRANSPORTS()
|
|
33
|
-
});
|
|
34
|
-
};
|
|
35
|
-
|
|
36
|
-
let customLoggerFactory: LoggerFactory | undefined = undefined;
|
|
37
|
-
|
|
38
|
-
export const setLoggerFactory = (factory: LoggerFactory): LoggerFactory => {
|
|
39
|
-
if (customLoggerFactory !== undefined) {
|
|
40
|
-
throw new Error("cannot change logger factory after it has been used.");
|
|
41
|
-
}
|
|
42
|
-
customLoggerFactory = factory;
|
|
43
|
-
return customLoggerFactory;
|
|
44
|
-
};
|
|
45
|
-
|
|
46
|
-
export const getLoggerFactory = (): LoggerFactory => {
|
|
47
|
-
if (customLoggerFactory) {
|
|
48
|
-
return customLoggerFactory;
|
|
49
|
-
} else {
|
|
50
|
-
customLoggerFactory = defaultLoggerFactory;
|
|
51
|
-
return defaultLoggerFactory;
|
|
52
|
-
}
|
|
53
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
export type LogLevel = "error" | "warn" | "info" | "debug" | "trace";
|
|
2
|
-
|
|
3
|
-
export interface WriteArgs {
|
|
4
|
-
level: LogLevel;
|
|
5
|
-
message?: any;
|
|
6
|
-
optionalParams: any[]
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
export interface LoggerTransportWriteArgs extends WriteArgs {
|
|
10
|
-
out: string;
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
export interface LoggerTransport {
|
|
14
|
-
level?: LogLevel;
|
|
15
|
-
|
|
16
|
-
write(args: LoggerTransportWriteArgs): Promise<void> | void;
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
export type LoggerFormatter = (args: { identifier: string, level: LogLevel, message: string }) => string;
|
|
@@ -1,136 +0,0 @@
|
|
|
1
|
-
import {format} from "util";
|
|
2
|
-
import {LoggerFormatter, LoggerTransport, LoggerTransportWriteArgs, LogLevel, WriteArgs} from "./interfaces.js";
|
|
3
|
-
import {LoggerEvents, DEFAULT_LOGGER_FORMATTER, DEFAULT_LOGGER_TRANSPORTS, LOG_LEVEL_MAP} from "./constants.js";
|
|
4
|
-
|
|
5
|
-
export interface LoggerErrorEventInit {
|
|
6
|
-
error: any;
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
// @types/node doesnt include Event and EventTarget
|
|
10
|
-
declare var Event: any;
|
|
11
|
-
declare var EventTarget: any;
|
|
12
|
-
|
|
13
|
-
export class LoggerErrorEvent extends Event {
|
|
14
|
-
public error: any;
|
|
15
|
-
|
|
16
|
-
constructor(event: string, init: LoggerErrorEventInit) {
|
|
17
|
-
super(event, init);
|
|
18
|
-
this.error = init.error;
|
|
19
|
-
}
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
export interface Logger {
|
|
23
|
-
log(message?: any, ...optionalParams: any[]): void;
|
|
24
|
-
|
|
25
|
-
info(message?: any, ...optionalParams: any[]): void;
|
|
26
|
-
|
|
27
|
-
trace(message?: any, ...optionalParams: any[]): void;
|
|
28
|
-
|
|
29
|
-
debug(message?: any, ...optionalParams: any[]): void;
|
|
30
|
-
|
|
31
|
-
warn(message?: any, ...optionalParams: any[]): void;
|
|
32
|
-
|
|
33
|
-
error(message?: any, ...optionalParams: any[]): void;
|
|
34
|
-
|
|
35
|
-
addTransport(transport: LoggerTransport): void;
|
|
36
|
-
|
|
37
|
-
setLevel(level: LogLevel): void;
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
export class Logger extends EventTarget implements Logger {
|
|
41
|
-
|
|
42
|
-
protected readonly options: { transports: LoggerTransport[]; formatter: LoggerFormatter; };
|
|
43
|
-
|
|
44
|
-
constructor(protected readonly identifier: string, protected level: LogLevel = "info", options?: { transports?: LoggerTransport[]; formatter?: LoggerFormatter; }) {
|
|
45
|
-
super();
|
|
46
|
-
if (!LOG_LEVEL_MAP[level]) {
|
|
47
|
-
throw new Error(`Unknown level [${level}]`);
|
|
48
|
-
}
|
|
49
|
-
this.addEventListener(LoggerEvents.error, (ev: any) => {
|
|
50
|
-
console.error((ev as LoggerErrorEvent).error);
|
|
51
|
-
});
|
|
52
|
-
this.options = {
|
|
53
|
-
transports: options && options.transports !== undefined ? options.transports : DEFAULT_LOGGER_TRANSPORTS(),
|
|
54
|
-
formatter: options && options.formatter !== undefined ? options.formatter : DEFAULT_LOGGER_FORMATTER,
|
|
55
|
-
};
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
public setLevel(level: LogLevel): void {
|
|
59
|
-
if (!LOG_LEVEL_MAP[level]) {
|
|
60
|
-
throw new Error(`Unknown level [${level}]`);
|
|
61
|
-
}
|
|
62
|
-
this.level = level;
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
public addTransport(transport: LoggerTransport): void {
|
|
66
|
-
this.options.transports.push(transport);
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
protected write(args: WriteArgs): void {
|
|
70
|
-
try {
|
|
71
|
-
let eventArgs: LoggerTransportWriteArgs | undefined = undefined;
|
|
72
|
-
const tR = [];
|
|
73
|
-
for (const transport of this.options.transports) {
|
|
74
|
-
if (LOG_LEVEL_MAP[transport.level ? transport.level : this.level] >= LOG_LEVEL_MAP[args.level]) {
|
|
75
|
-
try {
|
|
76
|
-
eventArgs = eventArgs ? eventArgs : {
|
|
77
|
-
out: this.options.formatter({
|
|
78
|
-
identifier: this.identifier,
|
|
79
|
-
level: args.level,
|
|
80
|
-
message: format(args.message, ...args.optionalParams)
|
|
81
|
-
}),
|
|
82
|
-
...args
|
|
83
|
-
};
|
|
84
|
-
tR.push(transport.write(eventArgs));
|
|
85
|
-
} catch (e2: any) {
|
|
86
|
-
this.dispatchEvent(new LoggerErrorEvent(LoggerEvents.error, {
|
|
87
|
-
error: e2
|
|
88
|
-
}));
|
|
89
|
-
}
|
|
90
|
-
}
|
|
91
|
-
}
|
|
92
|
-
Promise.allSettled(tR).catch((e) => {
|
|
93
|
-
this.dispatchEvent(new LoggerErrorEvent(LoggerEvents.error, {
|
|
94
|
-
error: e
|
|
95
|
-
}));
|
|
96
|
-
});
|
|
97
|
-
} catch (e: any) {
|
|
98
|
-
this.dispatchEvent(new LoggerErrorEvent(LoggerEvents.error, {
|
|
99
|
-
error: e
|
|
100
|
-
}));
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
105
|
-
public debug(message?: any, ...optionalParams: any[]): void {
|
|
106
|
-
return this.write({level: "debug", message, optionalParams});
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
110
|
-
public error(message?: any, ...optionalParams: any[]): void {
|
|
111
|
-
return this.write({level: "error", message, optionalParams});
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
115
|
-
public info(message?: any, ...optionalParams: any[]): void {
|
|
116
|
-
return this.write({level: "info", message, optionalParams});
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
120
|
-
public log(message?: any, ...optionalParams: any[]): void {
|
|
121
|
-
return this.write({level: "info", message, optionalParams});
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
125
|
-
public trace(message?: any, ...optionalParams: any[]): void {
|
|
126
|
-
return this.write({level: "trace", message, optionalParams});
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
130
|
-
public warn(message?: any, ...optionalParams: any[]): void {
|
|
131
|
-
return this.write({level: "warn", message, optionalParams});
|
|
132
|
-
}
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
import {LoggerTransportWriteArgs, LogLevel} from "../interfaces.js";
|
|
2
|
-
|
|
3
|
-
export function Console(color: boolean = true, level?: LogLevel) {
|
|
4
|
-
return {
|
|
5
|
-
level,
|
|
6
|
-
write: async ({level, out}: LoggerTransportWriteArgs): Promise<void> => {
|
|
7
|
-
if (color) {
|
|
8
|
-
switch (level) {
|
|
9
|
-
case "warn":
|
|
10
|
-
console.warn("\x1b[33m%s\x1b[0m", out);
|
|
11
|
-
break;
|
|
12
|
-
case "error":
|
|
13
|
-
console.error("\x1b[31m%s\x1b[0m", out);
|
|
14
|
-
break;
|
|
15
|
-
case "trace":
|
|
16
|
-
console.log("\x1b[34m%s\x1b[0m", out);
|
|
17
|
-
break;
|
|
18
|
-
case "debug":
|
|
19
|
-
console.log("\x1b[36m%s\x1b[0m", out);
|
|
20
|
-
break;
|
|
21
|
-
default:
|
|
22
|
-
console[level](out);
|
|
23
|
-
break;
|
|
24
|
-
}
|
|
25
|
-
} else {
|
|
26
|
-
if(level === "trace" || level === "debug") {
|
|
27
|
-
console.log(out);
|
|
28
|
-
} else {
|
|
29
|
-
console[level](out);
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
};
|
|
34
|
-
}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import {createWriteStream} from "fs";
|
|
2
|
-
import {resolve} from "path";
|
|
3
|
-
import {LoggerTransport, LoggerTransportWriteArgs, LogLevel} from "../interfaces.js";
|
|
4
|
-
|
|
5
|
-
const FILE_TRANSPORT_ENVVAR = "LOG_FILE";
|
|
6
|
-
|
|
7
|
-
export const File: (filePath?: string | null, level?: LogLevel) => LoggerTransport = (filePath = process.env[FILE_TRANSPORT_ENVVAR] ? process.env[FILE_TRANSPORT_ENVVAR] : null, level?: LogLevel) => {
|
|
8
|
-
const fileHandler = filePath ? createWriteStream(resolve(filePath), {flags: "a"}) : null;
|
|
9
|
-
return {
|
|
10
|
-
level,
|
|
11
|
-
write: async ({out}: LoggerTransportWriteArgs): Promise<void> => {
|
|
12
|
-
if (fileHandler) {
|
|
13
|
-
return new Promise((resolve, reject) => {
|
|
14
|
-
fileHandler.write(`${out}\n`, (err) => {
|
|
15
|
-
if (err) {
|
|
16
|
-
reject(err);
|
|
17
|
-
} else {
|
|
18
|
-
resolve();
|
|
19
|
-
}
|
|
20
|
-
});
|
|
21
|
-
});
|
|
22
|
-
}
|
|
23
|
-
return;
|
|
24
|
-
}
|
|
25
|
-
};
|
|
26
|
-
};
|
|
@@ -1,159 +0,0 @@
|
|
|
1
|
-
import {matchTokenizePath, PathPart, PathParams, PathPartToken, tokenizePath} from "./tokenize-match";
|
|
2
|
-
import {Context, Handler, Method} from "./context";
|
|
3
|
-
import {Router} from "../router";
|
|
4
|
-
import {parse} from "@miqro/parser";
|
|
5
|
-
import {GroupPolicyHandler, ParseRequest, SessionHandler, ResultParser} from "../middleware";
|
|
6
|
-
import {
|
|
7
|
-
HandlerWithOptions,
|
|
8
|
-
handlerWithOptionsParseOptions, ResponseHandler,
|
|
9
|
-
RouterHandlerOptions,
|
|
10
|
-
routerHandlerParseOptions, RouterJSONDoc
|
|
11
|
-
} from "./router-utils";
|
|
12
|
-
|
|
13
|
-
export class RouterHandler {
|
|
14
|
-
|
|
15
|
-
private readonly tokens: PathPartToken[];
|
|
16
|
-
private readonly handler: Array<Handler | Router>;
|
|
17
|
-
private readonly isRouter: boolean;
|
|
18
|
-
private readonly options?: RouterHandlerOptions;
|
|
19
|
-
|
|
20
|
-
public constructor(
|
|
21
|
-
handler: Array<Handler> | HandlerWithOptions | Handler | Router,
|
|
22
|
-
private readonly path: string | undefined,
|
|
23
|
-
private readonly method: Method | undefined,
|
|
24
|
-
options?: RouterHandlerOptions) {
|
|
25
|
-
this.tokens = tokenizePath(path);
|
|
26
|
-
|
|
27
|
-
if (options) {
|
|
28
|
-
options = parse(options, routerHandlerParseOptions, "no_extra", "options");
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
let handlers: Array<Handler | Router> = []
|
|
32
|
-
this.isRouter = handler instanceof Router;
|
|
33
|
-
|
|
34
|
-
if (!this.isRouter && !(handler instanceof Array) && typeof handler === "object") {
|
|
35
|
-
// HandlerWithOptions
|
|
36
|
-
if (options) {
|
|
37
|
-
throw new Error("bad arguments. cannot send options with HandlerWithOptions");
|
|
38
|
-
}
|
|
39
|
-
handler = parse(handler, handlerWithOptionsParseOptions, "no_extra", "handler");
|
|
40
|
-
const realHandler = (handler as HandlerWithOptions).handler;
|
|
41
|
-
const newOptions = {
|
|
42
|
-
...(handler as HandlerWithOptions)
|
|
43
|
-
};
|
|
44
|
-
delete (newOptions as any).handler;
|
|
45
|
-
handler = realHandler;
|
|
46
|
-
this.options = newOptions;
|
|
47
|
-
} else {
|
|
48
|
-
this.options = options;
|
|
49
|
-
}
|
|
50
|
-
const routeHandlers = handler instanceof Array ? handler : [handler] as Array<Handler | Router>;
|
|
51
|
-
|
|
52
|
-
if ((!this.isRouter && routeHandlers.length !== routeHandlers.filter(h => typeof h === "function").length) || (this.isRouter && this.options)) {
|
|
53
|
-
throw new Error("bad arguments");
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
if (this.options && this.options.middleware) {
|
|
57
|
-
handlers = handlers.concat(this.options.middleware);
|
|
58
|
-
}
|
|
59
|
-
if (this.options && this.options.session) {
|
|
60
|
-
handlers.push(typeof this.options.session !== "function" ? SessionHandler(this.options.session) : this.options.session);
|
|
61
|
-
}
|
|
62
|
-
if (this.options && this.options.policy) {
|
|
63
|
-
handlers.push(GroupPolicyHandler(this.options.policy));
|
|
64
|
-
}
|
|
65
|
-
if (this.options && this.options.request) {
|
|
66
|
-
handlers.push(ParseRequest(this.options.request, this.options.parser));
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
handlers = handlers.concat(routeHandlers);
|
|
70
|
-
|
|
71
|
-
if (this.options && this.options.response) {
|
|
72
|
-
if (typeof this.options.response.body === "boolean" && this.options.response.body) {
|
|
73
|
-
(handlers as Handler[]).push(ResponseHandler());
|
|
74
|
-
} else if (this.options.response.body) {
|
|
75
|
-
(handlers as Handler[]).push(ResultParser(this.options.response.body, this.options.parser));
|
|
76
|
-
(handlers as Handler[]).push(ResponseHandler());
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
this.handler = handlers;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
public getJSONDoc(doc: RouterJSONDoc = {}, prePath = "/"): RouterJSONDoc {
|
|
83
|
-
const nPath = this.path && this.path.length > 1 ? this.path.substring(1) : "";
|
|
84
|
-
const nMethod = this.method ? this.method : "";
|
|
85
|
-
|
|
86
|
-
if (this.isRouter) {
|
|
87
|
-
const router: Router = this.handler[0] as Router;
|
|
88
|
-
router.getJSONDoc(doc, `${prePath}${nPath}`);
|
|
89
|
-
} else if (this.options) {
|
|
90
|
-
if (!doc[`${prePath}${nPath}`]) {
|
|
91
|
-
doc[`${prePath}${nPath}`] = Object.create(null);
|
|
92
|
-
}
|
|
93
|
-
if (doc[`${prePath}${nPath}`][nMethod]) {
|
|
94
|
-
throw new Error("cannot create doc routes override each other");
|
|
95
|
-
}
|
|
96
|
-
doc[`${prePath}${nPath}`][nMethod] = {
|
|
97
|
-
description: this.options.description,
|
|
98
|
-
name: this.options.name,
|
|
99
|
-
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(),
|
|
100
|
-
policy: this.options.policy,
|
|
101
|
-
request: this.options.request ? {
|
|
102
|
-
body: this.options.request.body,
|
|
103
|
-
headers: this.options.request.headers,
|
|
104
|
-
params: this.options.request.params,
|
|
105
|
-
query: this.options.request.query,
|
|
106
|
-
} : undefined,
|
|
107
|
-
response: this.options.response
|
|
108
|
-
};
|
|
109
|
-
}
|
|
110
|
-
return doc;
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
public async invoke(ctx: Context, pathTokens: PathPart[], prePathTokens: PathPartToken[]): Promise<boolean> {
|
|
114
|
-
for (let i = 0; i < this.handler.length; i++) {
|
|
115
|
-
const h = this.handler[i];
|
|
116
|
-
if (h instanceof Router) {
|
|
117
|
-
if (!RouterHandler.pushResults(await h.run(ctx, pathTokens, prePathTokens.concat(this.tokens)), ctx)) {
|
|
118
|
-
return false;
|
|
119
|
-
}
|
|
120
|
-
} else {
|
|
121
|
-
if (!RouterHandler.pushResults(await h(ctx), ctx)) {
|
|
122
|
-
return false;
|
|
123
|
-
}
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
return true;
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
public isMatch(
|
|
130
|
-
method: string,
|
|
131
|
-
requestParts: PathPart[],
|
|
132
|
-
prePathTokens: PathPartToken[]): {
|
|
133
|
-
match: boolean;
|
|
134
|
-
params?: PathParams
|
|
135
|
-
} {
|
|
136
|
-
if ((this.method === undefined || this.method === method)) {
|
|
137
|
-
if (this.path === undefined) {
|
|
138
|
-
return {
|
|
139
|
-
match: true
|
|
140
|
-
};
|
|
141
|
-
}
|
|
142
|
-
return matchTokenizePath(this.isRouter, prePathTokens.concat(this.tokens), requestParts);
|
|
143
|
-
}
|
|
144
|
-
return {
|
|
145
|
-
match: false
|
|
146
|
-
};
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
private static pushResults(result: any, ctx: Context): boolean {
|
|
150
|
-
if (result === false) {
|
|
151
|
-
// ctx.logger.debug(`avoiding next handlers because handler returned false.`);
|
|
152
|
-
return false;
|
|
153
|
-
} else if (result !== true && result !== undefined) {
|
|
154
|
-
ctx.logger.trace("pushing to results [%o]", result);
|
|
155
|
-
ctx.results.push(result);
|
|
156
|
-
}
|
|
157
|
-
return true;
|
|
158
|
-
}
|
|
159
|
-
}
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import {IncomingMessage} from "http";
|
|
2
|
-
import {URL} from "url";
|
|
3
|
-
import {newURL} from "./helpers";
|
|
4
|
-
import {normalizePath} from "./tokenize-match";
|
|
5
|
-
import {DEFAULT_LOGGER_FORMATTER, getLogger, Logger} from "./logger/index.js";
|
|
6
|
-
|
|
7
|
-
export const defaultLoggerFactory = (uuid: string, req: IncomingMessage): Logger => {
|
|
8
|
-
const url = newURL(req.url ? req.url : "/", `http://${req.headers.host}`) as URL;
|
|
9
|
-
const method = req.method ? req.method.toUpperCase() as string : "GET";
|
|
10
|
-
const path = normalizePath(url.pathname); // normalized path
|
|
11
|
-
const pathToEnv = path.replace(/\//ig, "_").toUpperCase();
|
|
12
|
-
const identifier = `${pathToEnv === "_" ? "" : pathToEnv.substring(1)}${method.toUpperCase()}`;
|
|
13
|
-
const remoteAddress = req.socket.remoteAddress;
|
|
14
|
-
return getLogger(identifier, {
|
|
15
|
-
formatter: (args) => {
|
|
16
|
-
args.message = `${method} ${url}${uuid ? ` [${uuid}]` : ""}${remoteAddress ? ` (${remoteAddress})` : ""} ${args.message}`;
|
|
17
|
-
return DEFAULT_LOGGER_FORMATTER(args);
|
|
18
|
-
}
|
|
19
|
-
}, false);
|
|
20
|
-
}
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
import {Context, Handler} from "./context";
|
|
2
|
-
import {ParseOptionMap, ParseOptions, ParserInterface} from "@miqro/parser";
|
|
3
|
-
import {GroupPolicy, SessionHandlerOptions} from "./session";
|
|
4
|
-
|
|
5
|
-
export const ResponseHandler = (): Handler<void> => async (ctx: Context): Promise<void> => {
|
|
6
|
-
ctx.logger.trace("results [%o]", ctx.results);
|
|
7
|
-
if (!ctx.results || ctx.results.length === 0) {
|
|
8
|
-
throw new Error(`no response to send. Is your handler returning a value differente than boolean 'true|false' ?`);
|
|
9
|
-
} else {
|
|
10
|
-
const lastResult = ctx.results[ctx.results.length - 1];
|
|
11
|
-
ctx.logger.debug("response [%o]", lastResult);
|
|
12
|
-
if (lastResult !== undefined) {
|
|
13
|
-
await ctx.json(lastResult);
|
|
14
|
-
} else {
|
|
15
|
-
throw new Error(`no response to send. Is your handler returning a value differente than boolean 'true|false' ?`);
|
|
16
|
-
}
|
|
17
|
-
}
|
|
18
|
-
};
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
export const routeParseOptions: ParseOptionMap = {
|
|
22
|
-
name: "string?",
|
|
23
|
-
description: "string?",
|
|
24
|
-
policy: "GroupPolicy?",
|
|
25
|
-
response: {
|
|
26
|
-
type: "nested?",
|
|
27
|
-
nestedOptions: {
|
|
28
|
-
options: {
|
|
29
|
-
body: "boolean?|ParseOptions[]!?|string?"
|
|
30
|
-
},
|
|
31
|
-
mode: "no_extra"
|
|
32
|
-
}
|
|
33
|
-
},
|
|
34
|
-
request: {
|
|
35
|
-
type: "nested?",
|
|
36
|
-
nestedOptions: {
|
|
37
|
-
options: {
|
|
38
|
-
headers: "ParseOptions[]!?",
|
|
39
|
-
query: "boolean?|ParseOptions[]!?|string?",
|
|
40
|
-
params: "boolean?|ParseOptions[]!?|string?",
|
|
41
|
-
body: "boolean?|ParseOptions[]!?|string?"
|
|
42
|
-
},
|
|
43
|
-
mode: "no_extra"
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
};
|
|
47
|
-
|
|
48
|
-
export interface RouteOptions {
|
|
49
|
-
name?: string;
|
|
50
|
-
description?: string;
|
|
51
|
-
policy?: GroupPolicy;
|
|
52
|
-
request?: {
|
|
53
|
-
headers?: ParseOptions | ParseOptions[];
|
|
54
|
-
query?: ParseOptions | boolean | ParseOptions[] | string;
|
|
55
|
-
params?: ParseOptions | boolean | ParseOptions[] | string;
|
|
56
|
-
body?: ParseOptions | boolean | ParseOptions[] | string;
|
|
57
|
-
};
|
|
58
|
-
response?: {
|
|
59
|
-
body?: boolean | ParseOptions | ParseOptions[] | string;
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
export interface RouteJSONDoc extends RouteOptions {
|
|
64
|
-
identifier: string;
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
export interface RouterJSONDoc {
|
|
68
|
-
[path: string]: {
|
|
69
|
-
[method: string]: RouteJSONDoc
|
|
70
|
-
}
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
export const routerHandlerParseOptions: ParseOptionMap = {
|
|
74
|
-
...routeParseOptions,
|
|
75
|
-
parser: "ParserInterface?",
|
|
76
|
-
middleware: "function[]!?",
|
|
77
|
-
session: "SessionHandlerOptions?|function?"
|
|
78
|
-
};
|
|
79
|
-
|
|
80
|
-
export interface RouterHandlerOptions extends RouteOptions {
|
|
81
|
-
parser?: ParserInterface;
|
|
82
|
-
middleware?: Handler | Handler[];
|
|
83
|
-
session?: SessionHandlerOptions | Handler;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
export const handlerWithOptionsParseOptions: ParseOptionMap = {
|
|
87
|
-
...routerHandlerParseOptions,
|
|
88
|
-
handler: "function[]!",
|
|
89
|
-
};
|
|
90
|
-
|
|
91
|
-
export interface HandlerWithOptions extends RouterHandlerOptions {
|
|
92
|
-
handler: Handler | Array<Handler>;
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
import {Context} from "../context";
|
|
2
|
-
|
|
3
|
-
export interface SessionHandlerOptions {
|
|
4
|
-
authService: {
|
|
5
|
-
verify(args: { token: string; ctx: Context }): Promise<Session | null>;
|
|
6
|
-
};
|
|
7
|
-
options?: {
|
|
8
|
-
tokenLocation: "header" | "query" | "cookie";
|
|
9
|
-
tokenLocationName: string | ((ctx: Context) => Promise<string>);
|
|
10
|
-
setCookieOptions?: {
|
|
11
|
-
httpOnly: boolean;
|
|
12
|
-
secure: boolean;
|
|
13
|
-
path: string | ((ctx: Context) => Promise<string>);
|
|
14
|
-
sameSite: "lax" | "strict" | "none";
|
|
15
|
-
}
|
|
16
|
-
}
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
type Dict<T = any> = {
|
|
20
|
-
[key: string]: T
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
export interface NoTokenSession extends Dict {
|
|
24
|
-
account: string;
|
|
25
|
-
username: string;
|
|
26
|
-
groups: string[];
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
export interface Session extends NoTokenSession {
|
|
30
|
-
token: string;
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
export type GroupPolicyType = "at_least_one" | "all";
|
|
34
|
-
|
|
35
|
-
export type GroupPolicyGroups = string | string[];
|
|
36
|
-
|
|
37
|
-
export interface GroupPolicy {
|
|
38
|
-
groups: GroupPolicyGroups[];
|
|
39
|
-
groupPolicy: GroupPolicyType;
|
|
40
|
-
}
|