@miqro/core 4.0.1 → 5.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.
Files changed (220) hide show
  1. package/build/app.d.ts +15 -11
  2. package/build/app.js +22 -20
  3. package/build/app.js.map +1 -1
  4. package/build/common.d.ts +106 -0
  5. package/build/common.js +477 -0
  6. package/build/common.js.map +1 -0
  7. package/build/lib.d.ts +7 -38
  8. package/build/lib.js +6 -33
  9. package/build/lib.js.map +1 -1
  10. package/build/middleware/body-parser.d.ts +78 -0
  11. package/build/middleware/body-parser.js +552 -0
  12. package/build/middleware/body-parser.js.map +1 -0
  13. package/build/middleware/router.d.ts +114 -0
  14. package/build/middleware/router.js +704 -0
  15. package/build/middleware/router.js.map +1 -0
  16. package/build/middleware/session.d.ts +27 -3
  17. package/build/middleware/session.js +238 -18
  18. package/build/middleware/session.js.map +1 -1
  19. package/build/types.d.ts +309 -0
  20. package/build/types.js +455 -0
  21. package/build/types.js.map +1 -0
  22. package/build/{websocket/cluster.d.ts → websocket.d.ts} +13 -2
  23. package/build/websocket.js +316 -0
  24. package/build/websocket.js.map +1 -0
  25. package/package.json +7 -7
  26. package/src/app.ts +36 -32
  27. package/src/common.ts +528 -0
  28. package/src/lib.ts +63 -101
  29. package/src/middleware/body-parser.ts +597 -0
  30. package/src/middleware/router.ts +840 -0
  31. package/src/middleware/session.ts +249 -19
  32. package/src/types.ts +785 -0
  33. package/src/websocket.ts +356 -0
  34. package/build/api-router.d.ts +0 -34
  35. package/build/api-router.js +0 -48
  36. package/build/api-router.js.map +0 -1
  37. package/build/app-utils.d.ts +0 -13
  38. package/build/app-utils.js +0 -78
  39. package/build/app-utils.js.map +0 -1
  40. package/build/common/api-router-types.d.ts +0 -28
  41. package/build/common/api-router-types.js +0 -24
  42. package/build/common/api-router-types.js.map +0 -1
  43. package/build/common/api-router-utils.d.ts +0 -3
  44. package/build/common/api-router-utils.js +0 -118
  45. package/build/common/api-router-utils.js.map +0 -1
  46. package/build/common/config/config.d.ts +0 -15
  47. package/build/common/config/config.js +0 -38
  48. package/build/common/config/config.js.map +0 -1
  49. package/build/common/config/featuretoggle.d.ts +0 -1
  50. package/build/common/config/featuretoggle.js +0 -6
  51. package/build/common/config/featuretoggle.js.map +0 -1
  52. package/build/common/config/loader.d.ts +0 -13
  53. package/build/common/config/loader.js +0 -64
  54. package/build/common/config/loader.js.map +0 -1
  55. package/build/common/context.d.ts +0 -57
  56. package/build/common/context.js +0 -137
  57. package/build/common/context.js.map +0 -1
  58. package/build/common/error/badrequesterror.d.ts +0 -3
  59. package/build/common/error/badrequesterror.js +0 -7
  60. package/build/common/error/badrequesterror.js.map +0 -1
  61. package/build/common/error/configfilenotfound.d.ts +0 -3
  62. package/build/common/error/configfilenotfound.js +0 -7
  63. package/build/common/error/configfilenotfound.js.map +0 -1
  64. package/build/common/error/forbiddenerror.d.ts +0 -3
  65. package/build/common/error/forbiddenerror.js +0 -7
  66. package/build/common/error/forbiddenerror.js.map +0 -1
  67. package/build/common/error/notfound.d.ts +0 -3
  68. package/build/common/error/notfound.js +0 -7
  69. package/build/common/error/notfound.js.map +0 -1
  70. package/build/common/error/notimplemented.d.ts +0 -3
  71. package/build/common/error/notimplemented.js +0 -7
  72. package/build/common/error/notimplemented.js.map +0 -1
  73. package/build/common/error/unauthorizederror.d.ts +0 -3
  74. package/build/common/error/unauthorizederror.js +0 -7
  75. package/build/common/error/unauthorizederror.js.map +0 -1
  76. package/build/common/logger/constants.d.ts +0 -14
  77. package/build/common/logger/constants.js +0 -22
  78. package/build/common/logger/constants.js.map +0 -1
  79. package/build/common/logger/factory.d.ts +0 -16
  80. package/build/common/logger/factory.js +0 -47
  81. package/build/common/logger/factory.js.map +0 -1
  82. package/build/common/logger/interfaces.d.ts +0 -18
  83. package/build/common/logger/interfaces.js +0 -2
  84. package/build/common/logger/interfaces.js.map +0 -1
  85. package/build/common/logger/logger.d.ts +0 -35
  86. package/build/common/logger/logger.js +0 -95
  87. package/build/common/logger/logger.js.map +0 -1
  88. package/build/common/logger/transport/console.d.ts +0 -5
  89. package/build/common/logger/transport/console.js +0 -37
  90. package/build/common/logger/transport/console.js.map +0 -1
  91. package/build/common/logger/transport/file.d.ts +0 -2
  92. package/build/common/logger/transport/file.js +0 -25
  93. package/build/common/logger/transport/file.js.map +0 -1
  94. package/build/common/parser.d.ts +0 -7
  95. package/build/common/parser.js +0 -44
  96. package/build/common/parser.js.map +0 -1
  97. package/build/common/router-default-logger-factory.d.ts +0 -4
  98. package/build/common/router-default-logger-factory.js +0 -38
  99. package/build/common/router-default-logger-factory.js.map +0 -1
  100. package/build/common/router-handler.d.ts +0 -20
  101. package/build/common/router-handler.js +0 -154
  102. package/build/common/router-handler.js.map +0 -1
  103. package/build/common/router-types.d.ts +0 -63
  104. package/build/common/router-types.js +0 -86
  105. package/build/common/router-types.js.map +0 -1
  106. package/build/common/router-utils.d.ts +0 -3
  107. package/build/common/router-utils.js +0 -46
  108. package/build/common/router-utils.js.map +0 -1
  109. package/build/common/session/common.d.ts +0 -37
  110. package/build/common/session/common.js +0 -2
  111. package/build/common/session/common.js.map +0 -1
  112. package/build/common/session/service.d.ts +0 -26
  113. package/build/common/session/service.js +0 -154
  114. package/build/common/session/service.js.map +0 -1
  115. package/build/common/tokenize-match.d.ts +0 -19
  116. package/build/common/tokenize-match.js +0 -73
  117. package/build/common/tokenize-match.js.map +0 -1
  118. package/build/common/url-utils.d.ts +0 -6
  119. package/build/common/url-utils.js +0 -48
  120. package/build/common/url-utils.js.map +0 -1
  121. package/build/middleware/buffer.d.ts +0 -6
  122. package/build/middleware/buffer.js +0 -78
  123. package/build/middleware/buffer.js.map +0 -1
  124. package/build/middleware/cookie.d.ts +0 -4
  125. package/build/middleware/cookie.js +0 -15
  126. package/build/middleware/cookie.js.map +0 -1
  127. package/build/middleware/cors.d.ts +0 -8
  128. package/build/middleware/cors.js +0 -89
  129. package/build/middleware/cors.js.map +0 -1
  130. package/build/middleware/form.d.ts +0 -6
  131. package/build/middleware/form.js +0 -58
  132. package/build/middleware/form.js.map +0 -1
  133. package/build/middleware/group.d.ts +0 -3
  134. package/build/middleware/group.js +0 -77
  135. package/build/middleware/group.js.map +0 -1
  136. package/build/middleware/json.d.ts +0 -6
  137. package/build/middleware/json.js +0 -55
  138. package/build/middleware/json.js.map +0 -1
  139. package/build/middleware/logger.d.ts +0 -4
  140. package/build/middleware/logger.js +0 -16
  141. package/build/middleware/logger.js.map +0 -1
  142. package/build/middleware/parse.d.ts +0 -14
  143. package/build/middleware/parse.js +0 -88
  144. package/build/middleware/parse.js.map +0 -1
  145. package/build/middleware/result.d.ts +0 -9
  146. package/build/middleware/result.js +0 -62
  147. package/build/middleware/result.js.map +0 -1
  148. package/build/middleware/tag.d.ts +0 -4
  149. package/build/middleware/tag.js +0 -10
  150. package/build/middleware/tag.js.map +0 -1
  151. package/build/middleware/text.d.ts +0 -5
  152. package/build/middleware/text.js +0 -46
  153. package/build/middleware/text.js.map +0 -1
  154. package/build/proxy.d.ts +0 -19
  155. package/build/proxy.js +0 -74
  156. package/build/proxy.js.map +0 -1
  157. package/build/router.d.ts +0 -26
  158. package/build/router.js +0 -116
  159. package/build/router.js.map +0 -1
  160. package/build/static.d.ts +0 -14
  161. package/build/static.js +0 -211
  162. package/build/static.js.map +0 -1
  163. package/build/websocket/cluster.js +0 -114
  164. package/build/websocket/cluster.js.map +0 -1
  165. package/build/websocket/server.d.ts +0 -15
  166. package/build/websocket/server.js +0 -127
  167. package/build/websocket/server.js.map +0 -1
  168. package/build/websocket/types.d.ts +0 -39
  169. package/build/websocket/types.js +0 -2
  170. package/build/websocket/types.js.map +0 -1
  171. package/build/websocket/utils.d.ts +0 -8
  172. package/build/websocket/utils.js +0 -77
  173. package/build/websocket/utils.js.map +0 -1
  174. package/src/api-router.ts +0 -50
  175. package/src/app-utils.ts +0 -82
  176. package/src/common/api-router-types.ts +0 -52
  177. package/src/common/api-router-utils.ts +0 -126
  178. package/src/common/config/config.ts +0 -49
  179. package/src/common/config/featuretoggle.ts +0 -6
  180. package/src/common/config/loader.ts +0 -81
  181. package/src/common/context.ts +0 -192
  182. package/src/common/error/badrequesterror.ts +0 -6
  183. package/src/common/error/configfilenotfound.ts +0 -6
  184. package/src/common/error/forbiddenerror.ts +0 -6
  185. package/src/common/error/notfound.ts +0 -6
  186. package/src/common/error/notimplemented.ts +0 -6
  187. package/src/common/error/unauthorizederror.ts +0 -6
  188. package/src/common/logger/constants.ts +0 -28
  189. package/src/common/logger/factory.ts +0 -53
  190. package/src/common/logger/interfaces.ts +0 -19
  191. package/src/common/logger/logger.ts +0 -136
  192. package/src/common/logger/transport/console.ts +0 -36
  193. package/src/common/logger/transport/file.ts +0 -26
  194. package/src/common/parser.ts +0 -50
  195. package/src/common/router-default-logger-factory.ts +0 -44
  196. package/src/common/router-handler.ts +0 -186
  197. package/src/common/router-types.ts +0 -153
  198. package/src/common/router-utils.ts +0 -47
  199. package/src/common/session/common.ts +0 -40
  200. package/src/common/session/service.ts +0 -175
  201. package/src/common/tokenize-match.ts +0 -98
  202. package/src/common/url-utils.ts +0 -46
  203. package/src/middleware/buffer.ts +0 -82
  204. package/src/middleware/cookie.ts +0 -20
  205. package/src/middleware/cors.ts +0 -98
  206. package/src/middleware/form.ts +0 -61
  207. package/src/middleware/group.ts +0 -74
  208. package/src/middleware/json.ts +0 -57
  209. package/src/middleware/logger.ts +0 -18
  210. package/src/middleware/parse.ts +0 -105
  211. package/src/middleware/result.ts +0 -73
  212. package/src/middleware/tag.ts +0 -15
  213. package/src/middleware/text.ts +0 -47
  214. package/src/proxy.ts +0 -99
  215. package/src/router.ts +0 -140
  216. package/src/static.ts +0 -242
  217. package/src/websocket/cluster.ts +0 -128
  218. package/src/websocket/server.ts +0 -135
  219. package/src/websocket/types.ts +0 -41
  220. package/src/websocket/utils.ts +0 -95
@@ -1,126 +0,0 @@
1
- import { lstatSync, readdirSync } from "fs";
2
- import { join, parse as pathParse, resolve } from "path";
3
- import { Logger } from "./logger/logger.js";
4
- import { APIRoute, APIRouteSchema } from "./api-router-types.js";
5
- import { Handler, Method } from "./context.js";
6
- import { normalizePath } from "./url-utils.js";
7
- import { Router } from "../router.js";
8
- import { isMinimalRouter, MinimalRouter, RouterHandlerOptions } from "./router-types.js";
9
- import { DEFAULT_PARSER, assertNotUndefined } from "./parser.js";
10
-
11
- type UseCallArg = [Handler | Handler[] | MinimalRouter, string | undefined, Method | undefined, RouterHandlerOptions];
12
-
13
- export async function traverseAPIRouteDir(
14
- featureName: string,
15
- dirname: string,
16
- basePath = "/",
17
- router: Router = new Router(), logger?: Logger): Promise<Router> {
18
- if (logger) {
19
- logger.trace("loading routes from [%s]", dirname);
20
- }
21
- const files = readdirSync(dirname);
22
- const dirs = files.filter(f => lstatSync(join(dirname, f)).isDirectory());
23
- const methods = files.filter(f => !lstatSync(join(dirname, f)).isDirectory());
24
-
25
- const postFolder: UseCallArg[] = [];
26
-
27
- for (const f of methods) {
28
- const { name, ext } = pathParse(f);
29
- if (name !== "index" && ((ext === ".ts" || ext === ".js") && name.slice(-2) !== ".d")) {
30
- const filePath = join(dirname, f);
31
- //console.log("dirname=%s f=%s", dirname, f);
32
- let route: APIRoute = await import(filePath);
33
- //if ((route as any).default && (route as any).__esModule === true) {
34
- if ((route as any).default) {
35
- route = (route as any).default;
36
- // ugly hack when import is importing a commonjs that exports default
37
- if ((route as any).default) {
38
- route = (route as any).default;
39
- }
40
- }
41
- //const ___filePath = filePath + ext;
42
- const ___filePath = filePath;
43
- //let routeMethods: Method[] = [name] as Method[];
44
- let routeMethod: Method | "use" | "USE" = name as Method;
45
- if (typeof route === "function") {
46
- route = {
47
- handler: route
48
- } as any;
49
- } else {
50
- if (typeof route.method !== "undefined" && (/*!(route.method instanceof Array) &&*/ (typeof route.method !== "string"))) {
51
- //throw new Error(`${resolve(dirname, name)} doesn't export method as a string or string array`);
52
- throw new Error(`${resolve(dirname, name)} doesnt export method as a string`);
53
- } else if (typeof route.method !== "undefined") {
54
- routeMethod = route.method;//route.method instanceof Array ? route.method : [route.method];
55
- }
56
- if (typeof route.path !== "string" && typeof route.path !== "undefined"/* && !(route.path instanceof Array)*/) {
57
- //throw new Error(`${resolve(dirname, name)} doesn't export path as a string or a string array`);
58
- throw new Error(`${resolve(dirname, name)} doesnt export path as a string`);
59
- }
60
- if ((!(route.handler instanceof Array) && typeof route.handler !== "function" && !isMinimalRouter(route.handler)) || typeof route.handler === "undefined") {
61
- throw new Error(`${resolve(dirname, name)} doesnt export handler as a function or an array`);
62
- }
63
- if (typeof route.name !== "string" && typeof route.name !== "undefined") {
64
- throw new Error(`${resolve(dirname, name)} doesnt export name as a string`);
65
- }
66
- }
67
- try {
68
- route = assertNotUndefined(DEFAULT_PARSER.parse(route, APIRouteSchema, ___filePath), `error parsing [${___filePath}]`);
69
- } catch (e) {
70
- console.error("error parsing " + ___filePath);
71
- throw e;
72
- }
73
- //const paths = route.path instanceof Array ? route.path : route.path === undefined ? [route.method && route.method.indexOf(name as Method) === -1 ? `/${name}` : "/"] : [route.path];
74
- const p = route.path === undefined ? route.method && route.method.indexOf(name as Method) === -1 ? `/${name}` : "/" : route.path;
75
- //for (let i = 0; i < paths.length; i++) {
76
- //const p = paths[i];
77
- if (typeof p !== "string" || !p) {
78
- throw new Error(`${resolve(dirname, name)} doesnt export path as a string or a string array`);
79
- }
80
- const path = normalizePath(`${basePath}${p && p !== "/" ? `${p}` : p}`)
81
-
82
- const subName = (p.charAt(0) === "/" ? p.substring(1) : p).replace(/[^a-z0-9+]+/gi, '_');
83
- const routeName = route.name ? route.name : name;
84
-
85
- //const identifier = route.identifier ? route.identifier : getPathIdentifier(path, routeMethod);
86
-
87
- /*let newFeatureSubPath = `${featureName}_${route.name ? route.name : name}${routeName !== subName ? `_${subName}` : ""}`.toUpperCase();
88
-
89
- newFeatureSubPath = newFeatureSubPath.length > 1 && newFeatureSubPath.charAt(newFeatureSubPath.length - 1) === "_" ? newFeatureSubPath.substring(0, newFeatureSubPath.length - 1) : newFeatureSubPath;*/
90
- /*if (features[identifier]) {
91
- throw new Error(`${___filePath} feature name collides with ${(features[identifier] as any).___filePath}`)
92
- }*/
93
- if (route.identifier && route.identifier === "__prototype__" || route.identifier === "__proto__") {
94
- throw new Error(`invalid feature name ${route.identifier}`);
95
- }
96
- const useCallArgs: UseCallArg = [route.handler, path, routeMethod !== "use" && routeMethod !== "USE" ? routeMethod : undefined, {
97
- identifier: route.identifier,
98
- apiName: route.apiName,
99
- name: route.name,
100
- description: route.description,
101
- parser: route.parser,
102
- middleware: route.middleware,
103
- session: route.session,
104
- policy: route.policy,
105
- request: route.request,
106
- response: {
107
- body: route.response && route.response.body !== undefined ? route.response.body : !isMinimalRouter(route.handler),
108
- middleware: route.response && route.response.middleware !== undefined ? route.response.middleware : undefined
109
- }
110
- }];
111
- if (route.postFolder) {
112
- postFolder.push(useCallArgs);
113
- } else {
114
- router.use(...useCallArgs);
115
- }
116
- }
117
- }
118
- for (const f of dirs) {
119
- const { name } = pathParse(f);
120
- router = await traverseAPIRouteDir(`${featureName}_${name}`.toUpperCase(), join(dirname, f), `${basePath}/${name}`, router, logger);
121
- }
122
- for (const post of postFolder) {
123
- router.use(...post);
124
- }
125
- return router;
126
- };
@@ -1,49 +0,0 @@
1
- import { resolve } from "path";
2
-
3
- export type ConfigOutput = { [name: string]: string };
4
-
5
- export abstract class ConfigPathResolver {
6
-
7
- public static getSequelizeRCFilePath(): string {
8
- return resolve(ConfigPathResolver.getBaseDirname(), `.sequelizerc`);
9
- }
10
-
11
- public static getConfigDirname(): string {
12
- return resolve(ConfigPathResolver.getBaseDirname(), `config`, checkEnvVariable("NODE_ENV", "development"));
13
- }
14
-
15
- public static getBaseDirname(): string {
16
- const appBaseDirname = getEnvVariable("APP_BASE_DIRNAME");
17
- if (appBaseDirname) {
18
- return appBaseDirname;
19
- } else if (typeof process !== "undefined") {
20
- return process.cwd();
21
- } else {
22
- return "";
23
- }
24
- }
25
- }
26
-
27
- export interface LoadConfigOut {
28
- combined: ConfigOutput;
29
- outputs: ConfigOutput[]
30
- }
31
-
32
- export const checkEnvVariables = (requiredEnvVariables: string[], defaults?: string[]): string[] => {
33
- if (defaults && defaults.length !== requiredEnvVariables.length) {
34
- throw new Error(`defaults cannot be a different length of requiredEnvVariables`);
35
- }
36
- return requiredEnvVariables.map((envName, index) => checkEnvVariable(envName, defaults && defaults[index] ? defaults[index] : undefined));
37
- };
38
-
39
- export const checkEnvVariable = (envName: string, defaults?: string): string => {
40
- const value = getEnvVariable(envName, defaults);
41
- if (!value) {
42
- throw new Error(`Env variable [${envName}!] not defined.`);
43
- }
44
- return value;
45
- };
46
-
47
- export const getEnvVariable = (envName: string, defaults?: string): string| undefined => {
48
- return process.env[envName] ? process.env[envName] : defaults ? defaults as string : undefined;
49
- };
@@ -1,6 +0,0 @@
1
- import { checkEnvVariable } from "./config.js";
2
-
3
- export const isFeatureEnabled = (feature: string, defaults = true): boolean => {
4
- const featureToggleName = `${feature.toUpperCase()}`;
5
- return checkEnvVariable(featureToggleName, String(defaults)) === "true";
6
- };
@@ -1,81 +0,0 @@
1
- import { extname, resolve } from "path";
2
- import { existsSync, readdirSync, readFileSync } from "fs";
3
- import { ConfigOutput, ConfigPathResolver, LoadConfigOut } from "./config.js";
4
-
5
- interface Logger {
6
- log(message?: any, ...optionalParams: any[]): void;
7
-
8
- info(message?: any, ...optionalParams: any[]): void;
9
-
10
- trace(message?: any, ...optionalParams: any[]): void;
11
-
12
- debug(message?: any, ...optionalParams: any[]): void;
13
-
14
- warn(message?: any, ...optionalParams: any[]): void;
15
-
16
- error(message?: any, ...optionalParams: any[]): void;
17
- }
18
-
19
-
20
- class ConfigFileNotFoundError extends Error {
21
- constructor(args: any) {
22
- super(args);
23
- this.name = "ConfigFileNotFoundError";
24
- }
25
- }
26
-
27
- export const loadConfigString = (envFileContent: string, combined?: ConfigOutput): ConfigOutput => {
28
- const ret: ConfigOutput = Object.create(null);
29
- envFileContent.split("\n")
30
- .filter(value => value && value.length > 0 && value.substring(0, 1) !== "#")
31
- .forEach((line) => {
32
- const separator = line.indexOf("=");
33
- if (separator === -1) {
34
- throw new Error(`cannot read ${line}`);
35
- }
36
- ret[line.substring(0, separator)] = line.substring(separator + 1);
37
- });
38
- const keys = Object.keys(ret);
39
- for (const key of keys) {
40
- if (combined) {
41
- combined[key] = ret[key];
42
- }
43
- process.env[key] = ret[key];
44
- }
45
- return ret;
46
- }
47
-
48
- export const loadConfigFile = (envFilePath: string, combined?: ConfigOutput, logger?: Logger): ConfigOutput => {
49
- if (!existsSync(envFilePath)) {
50
- throw new ConfigFileNotFoundError(`config file [${envFilePath}] doesnt exists!`);
51
- } else {
52
- if (logger) {
53
- logger.trace(`loading config from [${envFilePath}].`);
54
- }
55
- return loadConfigString(readFileSync(envFilePath).toString(), combined);
56
- }
57
- };
58
-
59
- const MISSED_TO_RUNMIQRO_INIT = (configDirname: string): string => `no config loaded. env files in [${configDirname}] doesnt exist!.`;
60
-
61
- export const loadConfig = (configDirname: string = ConfigPathResolver.getConfigDirname(), logger?: Logger): LoadConfigOut => {
62
- const outputs: ConfigOutput[] = [];
63
- const combined = Object.create(null);
64
- //console.log(configDirname);
65
- if (existsSync(configDirname)) {
66
- const configFiles = readdirSync(configDirname);
67
- for (const configFile of configFiles) {
68
- const configFilePath = resolve(configDirname, configFile);
69
- const ext = extname(configFilePath);
70
- if (ext === ".env") {
71
- outputs.push(loadConfigFile(configFilePath, combined, logger));
72
- }
73
- }
74
- if (logger && configFiles.length === 0) {
75
- logger.debug(MISSED_TO_RUNMIQRO_INIT(configDirname));
76
- }
77
- } else if (logger) {
78
- logger.debug(MISSED_TO_RUNMIQRO_INIT(configDirname));
79
- }
80
- return {combined, outputs};
81
- };
@@ -1,192 +0,0 @@
1
- import { Logger } from "./logger/logger.js";
2
- import { Session } from "./session/common.js";
3
- import { IncomingHttpHeaders, IncomingMessage, OutgoingHttpHeaders, ServerResponse } from "http";
4
- import { URL } from "url";
5
- import { newURL, normalizePath, parseSearchParams } from "./url-utils.js";
6
- import { CookieSerializeOptions, serialize } from "cookie";
7
-
8
- export type Method =
9
- "get"
10
- | "post"
11
- | "put"
12
- | "delete"
13
- | "patch"
14
- | "options"
15
- | "GET"
16
- | "POST"
17
- | "PUT"
18
- | "DELETE"
19
- | "PATCH"
20
- | "OPTIONS";
21
-
22
- //export const IGNORE_HEADER = ["keep-alive", "connection"];
23
-
24
- export interface HandlerResponse {
25
- status?: number;
26
- headers?: OutgoingHttpHeaders;
27
- body?: any;
28
- }
29
-
30
- export type Handler<T = boolean | void | HandlerResponse> = ((ctx: Context) => Promise<T>) | ((ctx: Context) => T);
31
-
32
- export type ErrorHandler<T = boolean | void | any> =
33
- ((e: unknown, ctx: Context) => Promise<T>)
34
- | ((e: unknown, ctx: Context) => T);
35
-
36
- export class Context {
37
- public static IGNORE_HEADER = ["keep-alive", "connection"];
38
- //public readonly url: URL; // new URL(req.url ? req.url : "/", `http://${req.headers.host}`)
39
- public readonly startMS: number; // Date.now()
40
- public session?: Session; // a middleware will fill this
41
- public results: any[]; // handlers will fill this
42
- public readonly path: string; // normalized path
43
- public readonly hash: string; // from this.url.hash
44
- public readonly method: string; // from this.url.method
45
- public headers: IncomingHttpHeaders; // from this.req.headers
46
- public readonly cookies: { [name: string]: string }; // a middleware will fill this
47
- public query: { [name: string]: string | string[] }; // parseSearchParams will fill this with this.url.searchParams
48
- public readonly searchParams: URLSearchParams;
49
- public params: { [name: string]: string | undefined }; // the router will fill this
50
- public buffer?: Buffer; // empty buffer. middleware must read it
51
- public readonly remoteAddress?: string;
52
- public body: any; // a middleware will fill this reading the buffer
53
- constructor(public readonly uuid: string, public readonly req: IncomingMessage, public readonly res: ServerResponse, public readonly logger: Logger) {
54
- this.body = undefined as any;
55
- this.res.removeHeader("Date");
56
- //this.url = newURL(req.url ? req.url : "/", `http://${}`) as URL;
57
- const url = newURL(req.url ? req.url : "/") as URL;
58
- this.searchParams = url.searchParams;
59
- this.method = req.method ? req.method.toUpperCase() as string : "GET";
60
- this.path = normalizePath(url.pathname); // normalized path
61
- this.hash = url.hash;
62
- this.params = Object.create(null);
63
- this.query = parseSearchParams(url.searchParams);
64
- //this.buffer = Buffer.from("");
65
- this.remoteAddress = req.socket.remoteAddress;
66
- this.cookies = Object.create(null); // a middleware will fill
67
- this.headers = req.headers;
68
- this.startMS = Date.now();
69
- this.results = []; // handlers will fill this
70
- }
71
-
72
- public async close(): Promise<void> {
73
- return this.end({
74
- status: 400,
75
- headers: {
76
- connection: "close"
77
- }
78
- });
79
- }
80
-
81
- public addVaryHeader(value: number | string | ReadonlyArray<string>): ServerResponse {
82
- const c = this.res.getHeader("Vary");
83
- const current = c ? c instanceof Array ? c.join(", ") : String(c) : "";
84
- const nV = value instanceof Array ? value.join(", ") : String(value);
85
- const newValue = current ? `${current}, ${nV}` : nV;
86
- return this.setHeader("Vary", newValue.indexOf("*") !== -1 ? "*" : newValue);
87
- }
88
-
89
- public setHeader(name: string, value: number | string | ReadonlyArray<string>): ServerResponse {
90
- return this.res.setHeader(name, value);
91
- }
92
-
93
- public setCookie(name: string, value: string, options?: CookieSerializeOptions): ServerResponse {
94
- return this.setHeader('Set-Cookie', serialize(name, String(value), options));
95
- }
96
-
97
- public async write(chunk: any): Promise<void> {
98
- return new Promise((resolve, reject) => {
99
- this.res.write(chunk, function (error?: Error | null) {
100
- if (error) {
101
- reject(error);
102
- } else {
103
- resolve();
104
- }
105
- });
106
- });
107
- }
108
-
109
- public async end(args?: {
110
- body?: any;
111
- status?: number;
112
- headers: OutgoingHttpHeaders;
113
- }): Promise<void> {
114
- if (this.res.headersSent) {
115
- return Promise.reject(new Error("already ended"));
116
- }
117
- return new Promise<void>((resolve, reject) => {
118
- try {
119
- if (this.res.headersSent) {
120
- reject(new Error("already ended"));
121
- } else {
122
- const body = args ? args.body : undefined;
123
- if (args !== undefined) {
124
- const { status, headers } = args;
125
- this.res.statusCode = status !== undefined ? status : 200;
126
- const keys = Object.keys(headers);
127
- for (const key of keys) {
128
- if (Context.IGNORE_HEADER.indexOf(key.toLocaleLowerCase()) !== -1) {
129
- this.logger.warn("ignoring " + key);
130
- continue;
131
- }
132
- if (headers[key] !== undefined) {
133
- this.res.setHeader(key, headers[key] as any);
134
- }
135
- }
136
- }
137
- this.res.setHeader("connection", "close");
138
- this.res.end(body !== undefined ? (body instanceof Buffer ? body : String(body)) : null, () => {
139
- resolve();
140
- });
141
- }
142
- } catch (e) {
143
- reject(e);
144
- }
145
- });
146
- }
147
-
148
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
149
- public async json(body: any, headers?: OutgoingHttpHeaders, status?: number): Promise<void> {
150
- return this.end({
151
- status: status !== undefined ? status : 200,
152
- headers: {
153
- ['Content-Type']: 'application/json; charset=utf-8',
154
- ...headers,
155
- },
156
- body: JSON.stringify(body)
157
- })
158
- }
159
-
160
- public async text(text: string, headers?: OutgoingHttpHeaders, status?: number): Promise<void> {
161
- return this.end({
162
- status: status !== undefined ? status : 200,
163
- headers: {
164
- ['Content-Type']: 'plain/text; charset=utf-8',
165
- ...headers
166
- },
167
- body: text
168
- });
169
- }
170
-
171
- public async html(html: string, headers?: OutgoingHttpHeaders, status?: number): Promise<void> {
172
- return this.end({
173
- status: status !== undefined ? status : 200,
174
- headers: {
175
- ['Content-Type']: 'text/html; charset=utf-8',
176
- ...headers
177
- },
178
- body: html
179
- })
180
- }
181
-
182
- public async redirect(url: string, headers?: OutgoingHttpHeaders, status?: number): Promise<void> {
183
- return this.end({
184
- status: status !== undefined ? status : 302,
185
- headers: {
186
- ['Location']: url,
187
- ...headers
188
- }
189
- })
190
- }
191
- }
192
-
@@ -1,6 +0,0 @@
1
- export class BadRequestError extends Error {
2
- constructor(message = "BAD REQUEST") {
3
- super(message);
4
- this.name = "BadRequestError";
5
- }
6
- }
@@ -1,6 +0,0 @@
1
- export class ConfigFileNotFoundError extends Error {
2
- constructor(message = "NOT FOUND") {
3
- super(message);
4
- this.name = "ConfigFileNotFoundError";
5
- }
6
- }
@@ -1,6 +0,0 @@
1
- export class ForbiddenError extends Error {
2
- constructor(message = "FORBIDDEN") {
3
- super(message);
4
- this.name = "ForbiddenError";
5
- }
6
- }
@@ -1,6 +0,0 @@
1
- export class NotFoundError extends Error {
2
- constructor(message = "NOT FOUND") {
3
- super(message);
4
- this.name = "NotFoundError";
5
- }
6
- }
@@ -1,6 +0,0 @@
1
- export class MethodNotImplementedError extends Error {
2
- constructor(message = "NOT IMPLEMENTED") {
3
- super(message);
4
- this.name = "MethodNotImplementedError";
5
- }
6
- }
@@ -1,6 +0,0 @@
1
- export class UnAuthorizedError extends Error {
2
- constructor(message = "UNAUTHORIZED") {
3
- super(message);
4
- this.name = "UnAuthorizedError";
5
- }
6
- }
@@ -1,28 +0,0 @@
1
- import { LoggerFormatter, LoggerTransport } from "./interfaces.js";
2
- import { FileTransport } from "./transport/file.js";
3
- import { ConsoleTransport } from "./transport/console.js";
4
-
5
- export const DEFAULT_LOGGER_TRANSPORTS: () => LoggerTransport[] = () => [
6
- ConsoleTransport(),
7
- FileTransport()
8
- ];
9
-
10
- export const DEFAULT_LOGGER_FORMATTER: LoggerFormatter =
11
- ({identifier, level, message}) => `${new Date().toISOString()} ${process.pid} ` +
12
- `${identifier ? `[${identifier}] ` : ""}` +
13
- `${level !== "info" ? (level === "error" || level === "warn" ? `[${level.toUpperCase()}] ` : `[${level}] `) : ""}` +
14
- `${message}`;
15
-
16
- export const LOG_LEVEL_MAP =
17
- {
18
- "none": 0,
19
- "error": 1,
20
- "warn": 2,
21
- "info": 3,
22
- "debug": 4,
23
- "trace": 5,
24
- };
25
-
26
- export const LoggerEvents = {
27
- error: "error"
28
- };
@@ -1,53 +0,0 @@
1
- import { LoggerFormatter, LoggerTransport, LogLevel } from "./interfaces.js";
2
- import { getEnvVariable } from "../config/config.js";
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 = getEnvVariable(envVarName) ? getEnvVariable(envVarName) as LogLevel : getEnvVariable(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" | "none";
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;