@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.
Files changed (158) hide show
  1. package/dist/api-router.js +0 -1
  2. package/dist/app-utils.js +0 -1
  3. package/dist/app.js +0 -1
  4. package/dist/common/api-router-utils.js +0 -1
  5. package/dist/common/api-router.js +0 -1
  6. package/dist/common/config/config.js +0 -1
  7. package/dist/common/config/featuretoggle.js +0 -1
  8. package/dist/common/config/index.js +0 -1
  9. package/dist/common/config/loader.js +0 -1
  10. package/dist/common/context.js +0 -1
  11. package/dist/common/error/badrequesterror.js +0 -1
  12. package/dist/common/error/configfilenotfound.js +0 -1
  13. package/dist/common/error/forbiddenerror.js +0 -1
  14. package/dist/common/error/index.js +0 -1
  15. package/dist/common/error/notfound.js +0 -1
  16. package/dist/common/error/notimplemented.js +0 -1
  17. package/dist/common/error/unauthorizederror.js +0 -1
  18. package/dist/common/helpers.js +0 -1
  19. package/dist/common/index.js +0 -1
  20. package/dist/common/logger/constants.js +0 -1
  21. package/dist/common/logger/factory.js +0 -1
  22. package/dist/common/logger/index.js +0 -1
  23. package/dist/common/logger/interfaces.js +0 -1
  24. package/dist/common/logger/logger.js +0 -1
  25. package/dist/common/logger/transport/console.js +0 -1
  26. package/dist/common/logger/transport/file.js +0 -1
  27. package/dist/common/router-handler.js +0 -1
  28. package/dist/common/router-helpers.js +0 -1
  29. package/dist/common/router-utils.js +0 -1
  30. package/dist/common/session/common.js +0 -1
  31. package/dist/common/session/index.js +0 -1
  32. package/dist/common/session/service.js +0 -1
  33. package/dist/common/tokenize-match.js +0 -1
  34. package/dist/index.js +0 -1
  35. package/dist/middleware/buffer.js +0 -1
  36. package/dist/middleware/cookie.js +0 -1
  37. package/dist/middleware/cors.js +0 -1
  38. package/dist/middleware/form.js +0 -1
  39. package/dist/middleware/group.js +0 -1
  40. package/dist/middleware/index.js +0 -1
  41. package/dist/middleware/json.js +0 -1
  42. package/dist/middleware/logger.js +0 -1
  43. package/dist/middleware/parse.js +0 -1
  44. package/dist/middleware/result.js +0 -1
  45. package/dist/middleware/session.js +0 -1
  46. package/dist/middleware/tag.js +0 -1
  47. package/dist/middleware/text.js +0 -1
  48. package/dist/proxy.js +0 -1
  49. package/dist/router.js +0 -1
  50. package/dist/static.js +0 -1
  51. package/package.json +6 -6
  52. package/dist/api-router.js.map +0 -1
  53. package/dist/app-utils.js.map +0 -1
  54. package/dist/app.js.map +0 -1
  55. package/dist/common/api-router-utils.js.map +0 -1
  56. package/dist/common/api-router.js.map +0 -1
  57. package/dist/common/config/config.js.map +0 -1
  58. package/dist/common/config/featuretoggle.js.map +0 -1
  59. package/dist/common/config/index.js.map +0 -1
  60. package/dist/common/config/loader.js.map +0 -1
  61. package/dist/common/context.js.map +0 -1
  62. package/dist/common/error/badrequesterror.js.map +0 -1
  63. package/dist/common/error/configfilenotfound.js.map +0 -1
  64. package/dist/common/error/forbiddenerror.js.map +0 -1
  65. package/dist/common/error/index.js.map +0 -1
  66. package/dist/common/error/notfound.js.map +0 -1
  67. package/dist/common/error/notimplemented.js.map +0 -1
  68. package/dist/common/error/unauthorizederror.js.map +0 -1
  69. package/dist/common/helpers.js.map +0 -1
  70. package/dist/common/index.js.map +0 -1
  71. package/dist/common/logger/constants.js.map +0 -1
  72. package/dist/common/logger/factory.js.map +0 -1
  73. package/dist/common/logger/index.js.map +0 -1
  74. package/dist/common/logger/interfaces.js.map +0 -1
  75. package/dist/common/logger/logger.js.map +0 -1
  76. package/dist/common/logger/transport/console.js.map +0 -1
  77. package/dist/common/logger/transport/file.js.map +0 -1
  78. package/dist/common/router-handler.js.map +0 -1
  79. package/dist/common/router-helpers.js.map +0 -1
  80. package/dist/common/router-utils.js.map +0 -1
  81. package/dist/common/session/common.js.map +0 -1
  82. package/dist/common/session/index.js.map +0 -1
  83. package/dist/common/session/service.js.map +0 -1
  84. package/dist/common/tokenize-match.js.map +0 -1
  85. package/dist/index.js.map +0 -1
  86. package/dist/middleware/buffer.js.map +0 -1
  87. package/dist/middleware/cookie.js.map +0 -1
  88. package/dist/middleware/cors.js.map +0 -1
  89. package/dist/middleware/form.js.map +0 -1
  90. package/dist/middleware/group.js.map +0 -1
  91. package/dist/middleware/index.js.map +0 -1
  92. package/dist/middleware/json.js.map +0 -1
  93. package/dist/middleware/logger.js.map +0 -1
  94. package/dist/middleware/parse.js.map +0 -1
  95. package/dist/middleware/result.js.map +0 -1
  96. package/dist/middleware/session.js.map +0 -1
  97. package/dist/middleware/tag.js.map +0 -1
  98. package/dist/middleware/text.js.map +0 -1
  99. package/dist/proxy.js.map +0 -1
  100. package/dist/router.js.map +0 -1
  101. package/dist/static.js.map +0 -1
  102. package/src/api-router.ts +0 -60
  103. package/src/api-router.unit.test.js +0 -273
  104. package/src/app-utils.ts +0 -82
  105. package/src/app-utils.unit.test.js +0 -100
  106. package/src/app.ts +0 -51
  107. package/src/app.unit.test.js +0 -333
  108. package/src/common/api-router-utils.ts +0 -193
  109. package/src/common/api-router.ts +0 -19
  110. package/src/common/config/config.ts +0 -111
  111. package/src/common/config/featuretoggle.ts +0 -6
  112. package/src/common/config/index.ts +0 -3
  113. package/src/common/config/loader.ts +0 -80
  114. package/src/common/context.ts +0 -167
  115. package/src/common/context.unit.test.js +0 -288
  116. package/src/common/error/badrequesterror.ts +0 -6
  117. package/src/common/error/configfilenotfound.ts +0 -6
  118. package/src/common/error/forbiddenerror.ts +0 -6
  119. package/src/common/error/index.ts +0 -6
  120. package/src/common/error/notfound.ts +0 -6
  121. package/src/common/error/notimplemented.ts +0 -6
  122. package/src/common/error/unauthorizederror.ts +0 -6
  123. package/src/common/helpers.ts +0 -11
  124. package/src/common/index.ts +0 -7
  125. package/src/common/logger/constants.ts +0 -27
  126. package/src/common/logger/factory.ts +0 -53
  127. package/src/common/logger/index.ts +0 -6
  128. package/src/common/logger/interfaces.ts +0 -19
  129. package/src/common/logger/logger.ts +0 -136
  130. package/src/common/logger/transport/console.ts +0 -34
  131. package/src/common/logger/transport/file.ts +0 -26
  132. package/src/common/router-handler.ts +0 -159
  133. package/src/common/router-helpers.ts +0 -20
  134. package/src/common/router-utils.ts +0 -95
  135. package/src/common/session/common.ts +0 -40
  136. package/src/common/session/index.ts +0 -2
  137. package/src/common/session/service.ts +0 -160
  138. package/src/common/tokenize-match.ts +0 -130
  139. package/src/index.ts +0 -7
  140. package/src/middleware/buffer.ts +0 -80
  141. package/src/middleware/cookie.ts +0 -20
  142. package/src/middleware/cors.ts +0 -96
  143. package/src/middleware/form.ts +0 -59
  144. package/src/middleware/group.ts +0 -70
  145. package/src/middleware/index.ts +0 -48
  146. package/src/middleware/json.ts +0 -55
  147. package/src/middleware/logger.ts +0 -18
  148. package/src/middleware/parse.ts +0 -93
  149. package/src/middleware/result.ts +0 -43
  150. package/src/middleware/session.ts +0 -136
  151. package/src/middleware/tag.ts +0 -15
  152. package/src/middleware/text.ts +0 -45
  153. package/src/proxy.ts +0 -77
  154. package/src/proxy.unit.test.js +0 -159
  155. package/src/router.ts +0 -112
  156. package/src/router.unit.test.js +0 -396
  157. package/src/setup-test.js +0 -5
  158. package/src/static.ts +0 -238
package/src/app.ts DELETED
@@ -1,51 +0,0 @@
1
- import {createServer, RequestListener, Server} from "http";
2
- import { randomUUID } from 'crypto'
3
- import {Context, defaultLoggerFactory} from "./common";
4
- import {Router, RouterOptions} from "./router";
5
- import {defaultAppErrorHandler, HTML_HEADERS, STATUS} from "./app-utils";
6
-
7
- export class App extends Router {
8
- public readonly listener: RequestListener;
9
-
10
- constructor(config?: RouterOptions) {
11
- super(config);
12
- const errorHandler = defaultAppErrorHandler();
13
- const loggerFactory = this.config && this.config.loggerFactory ? this.config.loggerFactory : defaultLoggerFactory;
14
- this.listener = async (req, res) => {
15
- const uuid = randomUUID();
16
- const logger = loggerFactory(uuid, req);
17
- const ctx = new Context(uuid, req, res, logger);
18
- ctx.logger.trace(`request received`);
19
- try {
20
- await this.run(ctx);
21
- if (!ctx.res.headersSent) {
22
- await ctx.end({
23
- headers: HTML_HEADERS,
24
- status: STATUS.NOT_FOUND,
25
- body: "NOT FOUND"
26
- });
27
- }
28
- } catch (e: any) {
29
- try {
30
- if (!ctx.res.headersSent) {
31
- await errorHandler(e, ctx);
32
- if (!ctx.res.headersSent) {
33
- ctx.logger.error(e);
34
- await ctx.end({
35
- headers: HTML_HEADERS,
36
- status: STATUS.ERROR,
37
- body: "SERVER ERROR"
38
- });
39
- }
40
- }
41
- } catch (e3) {
42
- ctx.logger.error(e3);
43
- }
44
- }
45
- };
46
- }
47
-
48
- public listen(...args: any[]): Server {
49
- return createServer(this.listener).listen(...args)
50
- }
51
- }
@@ -1,333 +0,0 @@
1
- const {fake, requireMock} = require("@miqro/test");
2
- const {resolve} = require("path");
3
- const {strictEqual} = require("assert");
4
- const {distPath} = require("./setup-test.js");
5
-
6
- const testFilePath = resolve(distPath, "app.js");
7
-
8
- describe("app unit tests", () => {
9
- describe("this.listen", () => {
10
- it("happy path", () => {
11
- const defaultAppErrorHandler = fake(() => {
12
- });
13
- const fakeServer = {
14
- listen: fake(() => {
15
-
16
- })
17
- };
18
- const createServer = fake(() => {
19
- return fakeServer;
20
- });
21
- const {App} = requireMock(testFilePath, {
22
- "http": {
23
- createServer
24
- },
25
- "./common": {},
26
- "./router": {
27
- Router: class {
28
-
29
- }
30
- },
31
- "./app-utils": {
32
- defaultAppErrorHandler
33
- }
34
- }, distPath);
35
- const app = new App();
36
- strictEqual(defaultAppErrorHandler.callCount, 1);
37
- strictEqual(createServer.callCount, 0);
38
- app.listen(8080);
39
- strictEqual(createServer.callCount, 1);
40
- strictEqual(createServer.callArgs[0][0], app.listener);
41
- strictEqual(fakeServer.listen.callCount, 1);
42
- strictEqual(fakeServer.listen.callArgs[0][0], 8080);
43
- });
44
- });
45
- describe("this.listener", () => {
46
- it("run doesnt send response should send 404", async () => {
47
-
48
- const v4Ret = "v4Ret";
49
-
50
- const fakeLogger = {
51
- trace: fake(() => {
52
-
53
- })
54
- };
55
-
56
- const fakeReq = {};
57
-
58
- const fakeRes = {}
59
-
60
- const defaultAppErrorHandler = fake(() => {
61
- });
62
-
63
- const v4 = fake(() => {
64
- return v4Ret;
65
- });
66
-
67
- const defaultLoggerFactory = fake(() => {
68
- return fakeLogger;
69
- });
70
-
71
- const routerRun = fake(() => {
72
- });
73
-
74
- const ctxEnd = fake(() => {
75
-
76
- });
77
-
78
- class Context {
79
- constructor(uuid, req, res, logger) {
80
- this.uuid = uuid;
81
- this.req = req;
82
- this.res = res;
83
- this.logger = logger;
84
- }
85
-
86
- end() {
87
- if (this.res.headersSent) {
88
- throw new Error("cannot double end res");
89
- }
90
- this.res.headersSent = true;
91
- return ctxEnd(...arguments);
92
- }
93
- }
94
-
95
- const {App} = requireMock(testFilePath, {
96
- "http": {},
97
- "crypto": {
98
- randomUUID: v4
99
- },
100
- "./common": {
101
- defaultLoggerFactory,
102
- Context
103
- },
104
- "./router": {
105
- Router: class {
106
- run() {
107
- return routerRun(...arguments);
108
- }
109
- }
110
- },
111
- "./app-utils": {
112
- defaultAppErrorHandler,
113
- HTML_HEADERS: "HTML_HEADERS",
114
- STATUS: {
115
- NOT_FOUND: "NOT_FOUND"
116
- }
117
- }
118
- }, distPath);
119
- const app = new App();
120
- strictEqual(defaultAppErrorHandler.callCount, 1);
121
- const ret = await app.listener(fakeReq, fakeRes);
122
- strictEqual(ret, undefined);
123
- strictEqual(routerRun.callCount, 1);
124
- strictEqual(routerRun.callArgs[0][0] instanceof Context, true);
125
- strictEqual(routerRun.callArgs[0][0].res, fakeRes);
126
- strictEqual(routerRun.callArgs[0][0].req, fakeReq);
127
- strictEqual(routerRun.callArgs[0][0].uuid, v4Ret);
128
- strictEqual(routerRun.callArgs[0][0].logger, fakeLogger);
129
- strictEqual(ctxEnd.callCount, 1);
130
- strictEqual(ctxEnd.callArgs[0][0].status, "NOT_FOUND");
131
- strictEqual(ctxEnd.callArgs[0][0].body, "NOT FOUND");
132
- strictEqual(ctxEnd.callArgs[0][0].headers, "HTML_HEADERS");
133
- });
134
-
135
- it("run throws and defaultErrorHandler send response", async () => {
136
- const v4Ret = "v4Ret";
137
-
138
- const fakeLogger = {
139
- trace: fake(() => {
140
-
141
- })
142
- };
143
-
144
- const fakeReq = {};
145
-
146
- const fakeRes = {}
147
-
148
- const errorHandler = fake(async (e, ctx) => {
149
- await ctx.end("fakeEnd");
150
- });
151
-
152
- const defaultAppErrorHandler = fake(() => {
153
- return errorHandler;
154
- });
155
-
156
- const v4 = fake(() => {
157
- return v4Ret;
158
- });
159
-
160
- const defaultLoggerFactory = fake(() => {
161
- return fakeLogger;
162
- });
163
-
164
- const routerRun = fake(() => {
165
- throw new Error("routerRunError");
166
- });
167
-
168
- const ctxEnd = fake(() => {
169
-
170
- });
171
-
172
- class Context {
173
- constructor(uuid, req, res, logger) {
174
- this.uuid = uuid;
175
- this.req = req;
176
- this.res = res;
177
- this.logger = logger;
178
- }
179
-
180
- end() {
181
- if (this.res.headersSent) {
182
- throw new Error("cannot double end res");
183
- }
184
- this.res.headersSent = true;
185
- return ctxEnd(...arguments);
186
- }
187
- }
188
-
189
- const {App} = requireMock(testFilePath, {
190
- "http": {},
191
- "crypto": {
192
- randomUUID: v4
193
- },
194
- "./common": {
195
- defaultLoggerFactory,
196
- Context
197
- },
198
- "./router": {
199
- Router: class {
200
- run() {
201
- return routerRun(...arguments);
202
- }
203
- }
204
- },
205
- "./app-utils": {
206
- defaultAppErrorHandler
207
- }
208
- }, distPath);
209
- const app = new App();
210
- strictEqual(defaultAppErrorHandler.callCount, 1);
211
- const ret = await app.listener(fakeReq, fakeRes);
212
- strictEqual(errorHandler.callCount, 1);
213
- strictEqual(errorHandler.callArgs[0][0].message, "routerRunError");
214
- strictEqual(errorHandler.callArgs[0][1] instanceof Context, true);
215
- strictEqual(errorHandler.callArgs[0][1].res, fakeRes);
216
- strictEqual(errorHandler.callArgs[0][1].req, fakeReq);
217
- strictEqual(errorHandler.callArgs[0][1].uuid, v4Ret);
218
- strictEqual(errorHandler.callArgs[0][1].logger, fakeLogger);
219
- strictEqual(ret, undefined);
220
- strictEqual(routerRun.callCount, 1);
221
- strictEqual(routerRun.callArgs[0][0] instanceof Context, true);
222
- strictEqual(routerRun.callArgs[0][0].res, fakeRes);
223
- strictEqual(routerRun.callArgs[0][0].req, fakeReq);
224
- strictEqual(routerRun.callArgs[0][0].uuid, v4Ret);
225
- strictEqual(routerRun.callArgs[0][0].logger, fakeLogger);
226
- strictEqual(ctxEnd.callCount, 1);
227
- strictEqual(ctxEnd.callArgs[0][0], "fakeEnd");
228
- });
229
-
230
- it("run throws and defaultErrorHandler doesn't send response", async () => {
231
- const v4Ret = "v4Ret";
232
-
233
- const fakeLogger = {
234
- trace: fake(() => {
235
-
236
- }),
237
- error: fake(() => {
238
-
239
- })
240
- };
241
-
242
- const fakeReq = {};
243
-
244
- const fakeRes = {}
245
-
246
- const errorHandler = fake(async (e, ctx) => {
247
- });
248
-
249
- const defaultAppErrorHandler = fake(() => {
250
- return errorHandler;
251
- });
252
-
253
- const v4 = fake(() => {
254
- return v4Ret;
255
- });
256
-
257
- const defaultLoggerFactory = fake(() => {
258
- return fakeLogger;
259
- });
260
-
261
- const routerRun = fake(() => {
262
- throw new Error("routerRunError");
263
- });
264
-
265
- const ctxEnd = fake(() => {
266
-
267
- });
268
-
269
- class Context {
270
- constructor(uuid, req, res, logger) {
271
- this.uuid = uuid;
272
- this.req = req;
273
- this.res = res;
274
- this.logger = logger;
275
- }
276
-
277
- end() {
278
- if (this.res.headersSent) {
279
- throw new Error("cannot double end res");
280
- }
281
- this.res.headersSent = true;
282
- return ctxEnd(...arguments);
283
- }
284
- }
285
-
286
- const {App} = requireMock(testFilePath, {
287
- "http": {},
288
- "crypto": {
289
- randomUUID: v4
290
- },
291
- "./common": {
292
- defaultLoggerFactory,
293
- Context
294
- },
295
- "./router": {
296
- Router: class {
297
- run() {
298
- return routerRun(...arguments);
299
- }
300
- }
301
- },
302
- "./app-utils": {
303
- defaultAppErrorHandler,
304
- HTML_HEADERS: "HTML_HEADERS",
305
- STATUS: {
306
- ERROR: "ERROR"
307
- }
308
- }
309
- }, distPath);
310
- const app = new App();
311
- strictEqual(defaultAppErrorHandler.callCount, 1);
312
- const ret = await app.listener(fakeReq, fakeRes);
313
- strictEqual(errorHandler.callCount, 1);
314
- strictEqual(errorHandler.callArgs[0][0].message, "routerRunError");
315
- strictEqual(errorHandler.callArgs[0][1] instanceof Context, true);
316
- strictEqual(errorHandler.callArgs[0][1].res, fakeRes);
317
- strictEqual(errorHandler.callArgs[0][1].req, fakeReq);
318
- strictEqual(errorHandler.callArgs[0][1].uuid, v4Ret);
319
- strictEqual(errorHandler.callArgs[0][1].logger, fakeLogger);
320
- strictEqual(ret, undefined);
321
- strictEqual(routerRun.callCount, 1);
322
- strictEqual(routerRun.callArgs[0][0] instanceof Context, true);
323
- strictEqual(routerRun.callArgs[0][0].res, fakeRes);
324
- strictEqual(routerRun.callArgs[0][0].req, fakeReq);
325
- strictEqual(routerRun.callArgs[0][0].uuid, v4Ret);
326
- strictEqual(routerRun.callArgs[0][0].logger, fakeLogger);
327
- strictEqual(ctxEnd.callCount, 1);
328
- strictEqual(ctxEnd.callArgs[0][0].status, "ERROR");
329
- strictEqual(ctxEnd.callArgs[0][0].headers, "HTML_HEADERS");
330
- strictEqual(ctxEnd.callArgs[0][0].body, "SERVER ERROR");
331
- });
332
- });
333
- });
@@ -1,193 +0,0 @@
1
- import { lstatSync, readdirSync } from "fs";
2
- import { join, parse as pathParse, resolve } from "path";
3
- import { Logger } from "./logger/index.js";
4
- import { APIRoute } from "./api-router";
5
- import { normalizePath } from "./tokenize-match";
6
- import { isFeatureEnabled } from "./config";
7
- import { Router } from "../router";
8
- import { Handler, Method } from "./context";
9
- import { handlerWithOptionsParseOptions, RouterHandlerOptions } from "./router-utils";
10
- import { parse, ParseOptionMap } from "@miqro/parser";
11
-
12
- export const APIRouteValidator: ParseOptionMap = {
13
- ...handlerWithOptionsParseOptions,
14
- method: "string?|string[]?",
15
- path: "string?|string[]?"
16
- };
17
-
18
- export function traverseAPIRouteDir(
19
- featureName: string,
20
- dirname: string,
21
- basePath = "/",
22
- features: FeatureRouterOptions = {}, logger?: Logger): FeatureRouterOptions {
23
- if (logger) {
24
- logger.trace("loading routes from [%s]", dirname);
25
- }
26
- const files = readdirSync(dirname);
27
- const dirs = files.filter(f => lstatSync(join(dirname, f)).isDirectory());
28
- const methods = files.filter(f => !lstatSync(join(dirname, f)).isDirectory());
29
- for (const f of dirs) {
30
- const { name } = pathParse(f);
31
- features = traverseAPIRouteDir(`${featureName}_${name}`.toUpperCase(), join(dirname, f), `${basePath}/${name}`, features, logger);
32
- }
33
- for (const f of methods) {
34
- const { name, ext } = pathParse(f);
35
- if (name !== "index" && ((ext === ".ts" || ext === ".js") && name.slice(-2) !== ".d")) {
36
- const filePath = join(dirname, name);
37
- // eslint-disable-next-line @typescript-eslint/no-var-requires
38
- let route: APIRoute = require(filePath);
39
- if ((route as any).default && (route as any).__esModule === true) {
40
- route = (route as any).default;
41
- }
42
- const ___filePath = filePath + ext;
43
- let routeMethods: Method[] = [name] as Method[];
44
- if (typeof route === "function") {
45
- route = {
46
- handler: route
47
- } as any;
48
- } else {
49
- if (typeof route.method !== "undefined" && (!(route.method instanceof Array) && (typeof route.method !== "string"))) {
50
- throw new Error(`${resolve(dirname, name)} doesnt export method as a string or string array`);
51
- } else if (typeof route.method !== "undefined") {
52
- routeMethods = route.method instanceof Array ? route.method : [route.method];
53
- }
54
- if (typeof route.path !== "string" && typeof route.path !== "undefined" && !(route.path instanceof Array)) {
55
- throw new Error(`${resolve(dirname, name)} doesnt export path as a string or a string array`);
56
- }
57
- if ((!(route.handler instanceof Array) && typeof route.handler !== "function") || typeof route.handler === "undefined") {
58
- throw new Error(`${resolve(dirname, name)} doesnt export handler as a function or an array`);
59
- }
60
- if (typeof route.name !== "string" && typeof route.name !== "undefined") {
61
- throw new Error(`${resolve(dirname, name)} doesnt export name as a string`);
62
- }
63
- }
64
- route = parse(route, APIRouteValidator, "no_extra", ___filePath) as APIRoute;
65
- const paths = route.path instanceof Array ? route.path : route.path === undefined ? [route.method && route.method.indexOf(name as Method) === -1 ? `/${name}` : "/"] : [route.path];
66
- for (let i = 0; i < paths.length; i++) {
67
- const p = paths[i];
68
- if (typeof p !== "string" || !p) {
69
- throw new Error(`${resolve(dirname, name)} doesnt export path as a string or a string array`);
70
- }
71
- const path = normalizePath(`${basePath}${p && p !== "/" ? `${p}` : ""}`)
72
-
73
- const subName = (p.charAt(0) === "/" ? p.substring(1) : p).replace(/[^a-z0-9+]+/gi, '_');
74
- const routeName = route.name ? route.name : name;
75
-
76
- let newFeatureSubPath = `${featureName}_${route.name ? route.name : name}${routeName !== subName ? `_${subName}` : ""}`.toUpperCase();
77
-
78
- newFeatureSubPath = newFeatureSubPath.length > 1 && newFeatureSubPath.charAt(newFeatureSubPath.length - 1) === "_" ? newFeatureSubPath.substring(0, newFeatureSubPath.length - 1) : newFeatureSubPath;
79
- if (features[newFeatureSubPath]) {
80
- throw new Error(`${___filePath} feature name collides with ${(features[newFeatureSubPath] as any).___filePath}`)
81
- }
82
- if (newFeatureSubPath === "__prototype__" || newFeatureSubPath === "__proto__") {
83
- throw new Error(`invalid feature name ${newFeatureSubPath}`);
84
- }
85
- features[newFeatureSubPath] = {
86
- options: {
87
- name: route.name,
88
- description: route.description,
89
- parser: route.parser,
90
- middleware: route.middleware,
91
- session: route.session,
92
- policy: route.policy,
93
- request: route.request,
94
- response: {
95
- body: route.response && route.response.body ? route.response.body : true
96
- }
97
- },
98
- path,
99
- method: routeMethods,
100
- handler: route.handler
101
- };
102
- (features[newFeatureSubPath] as any).___filePath = ___filePath;
103
- }
104
- }
105
- }
106
- return features;
107
- };
108
-
109
- export interface FeatureRouterPathOptions {
110
- path: string | string[];
111
- method: Method | Method[];
112
- handler: Array<Handler> | Handler;
113
- options?: RouterHandlerOptions;
114
- }
115
-
116
- export type FeatureRouterOptions = { [name: string]: FeatureRouterPathOptions };
117
-
118
- const FEATURE_ROUTER_METHODS: Method[] = ["get", "post", "put", "delete", "patch", "options"];
119
-
120
- export const FeatureRouter = (options: FeatureRouterOptions, logger?: Logger): Router => {
121
- const router: Router = new Router();
122
- const toSetup = Object.keys(options);
123
- const enabled: string[] = [];
124
- const disabled: string[] = [];
125
- const enabledPaths: { [name: string]: string } = {};
126
- for (const featureName of toSetup) {
127
- const handlerOptions = options[featureName];
128
- if (!handlerOptions) {
129
- throw new Error(`no handler options for feature [${featureName}]`);
130
- } else {
131
- const { path, handler: implementation, method } = handlerOptions;
132
- if (!method) {
133
- throw new Error(`no methods for feature [${featureName}]`);
134
- } else if (!implementation) {
135
- throw new Error(`no implementation for feature [${featureName}]`);
136
- } else if (!path) {
137
- throw new Error(`no path for feature [${featureName}]`);
138
- } else {
139
- if (method instanceof Array) {
140
- for (const m of method) {
141
- if (FEATURE_ROUTER_METHODS.indexOf(m.toLowerCase() as Method) === -1) {
142
- throw new Error(`feature [${featureName}] method [${m.toUpperCase()}] not defined! use only [${FEATURE_ROUTER_METHODS.join(",")}]`);
143
- }
144
- }
145
- } else if (FEATURE_ROUTER_METHODS.indexOf(method.toLowerCase() as Method) === -1) {
146
- throw new Error(`feature [${featureName}] method [${method.toUpperCase()}] not defined! use only [${FEATURE_ROUTER_METHODS.join(",")}]`);
147
- }
148
- const methods = method instanceof Array ? method : [method];
149
- if (isFeatureEnabled(featureName)) {
150
- if (logger) {
151
- logger.trace(`feature [${featureName}] enabled`);
152
- }
153
- enabled.push(featureName);
154
- const paths = path instanceof Array ? path : [path];
155
- for (const nnP of paths) {
156
- const p = normalizePath(nnP);
157
- for (const m of methods) {
158
- if (logger) {
159
- logger.info("%s", featureName);
160
- logger.info("\t%s:%s", m.toUpperCase(), p);
161
- if ((handlerOptions as any).___filePath) {
162
- logger.info("\t%s", (handlerOptions as any).___filePath);
163
- }
164
- }
165
- if (enabledPaths[`${p}${m}`] !== undefined) {
166
- throw new Error(`${featureName} collides with feature ${enabledPaths[`${p}${m}`]} on path ${p} method ${m}`)
167
- }
168
- enabledPaths[`${p}${m}`] = featureName;
169
- router.use(implementation, p, m.toLocaleLowerCase() as Method, handlerOptions.options);
170
- }
171
- }
172
- } else {
173
- if (logger) {
174
- logger.debug("feature [%s] disabled", featureName);
175
- }
176
- disabled.push(featureName);
177
- }
178
- }
179
- }
180
- }
181
- if (logger && enabled.length > 0) {
182
- logger.debug("enabled features [%s]", enabled.join(","));
183
- }
184
- if (logger) {
185
- if (disabled.length > 0) {
186
- logger.warn("disabled features [%s]", disabled.join(","));
187
- logger.warn(`to enable them just add the env var <feature>=true`);
188
- } else {
189
- logger.debug(`no features disabled`);
190
- }
191
- }
192
- return router;
193
- }
@@ -1,19 +0,0 @@
1
- import { Method } from "./context";
2
- import { HandlerWithOptions } from "./router-utils";
3
-
4
- /**
5
- * # APIRoute
6
- *
7
- * src/api/comment/get.js
8
- * ```typescript
9
- *import { APIRouter } from "@miqro/core";
10
- *const route: APIRoute = {
11
- * ...
12
- *};
13
- *export default route;
14
- * ```
15
- */
16
- export interface APIRoute extends HandlerWithOptions{
17
- method?: Method | Method[];
18
- path?: string | string[];
19
- }
@@ -1,111 +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`, `${ConfigStore.getConfig("NODE_ENV", "development")}`);
13
- }
14
-
15
- public static getBaseDirname(): string {
16
- const envVar = ConfigStore.getConfig("APP_BASE_DIRNAME");
17
- if (envVar) {
18
- return envVar;
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
- const processEnvDefined = (typeof process !== "undefined" && typeof process.env !== "undefined");
33
-
34
- export abstract class ConfigStore {
35
-
36
- public static putConfig(key: string, value: string): ConfigStore {
37
- if (key === "__proto__" || key === "__prototype__") {
38
- throw new Error("invalid key " + key);
39
- }
40
- if (processEnvDefined) {
41
- Object.defineProperty(process.env, key, {
42
- writable: true,
43
- enumerable: true,
44
- configurable: true,
45
- value
46
- }); // this is for webpack
47
- } else {
48
- /* eslint-disable @typescript-eslint/ban-ts-comment */
49
- // @ts-ignore
50
- localStorage.setItem(key, value);
51
- }
52
- return this;
53
- }
54
-
55
- public static clear(key: string): ConfigStore {
56
- if (key === "__proto__" || key === "__prototype__") {
57
- throw new Error("invalid key " + key);
58
- }
59
- if (processEnvDefined) {
60
- delete process.env[key];
61
- } else {
62
- /* eslint-disable @typescript-eslint/ban-ts-comment */
63
- // @ts-ignore
64
- localStorage.removeItem(key);
65
- }
66
- return this;
67
- }
68
-
69
- public static keys(): string[] {
70
- if (processEnvDefined) {
71
- return Object.keys(process.env);
72
- } else {
73
- const keys: string[] = [];
74
- /* eslint-disable @typescript-eslint/ban-ts-comment */
75
- // @ts-ignore
76
- for (let i = 0; i < localStorage.length; i++) {
77
- /* eslint-disable @typescript-eslint/ban-ts-comment */
78
- // @ts-ignore
79
- const key = localStorage.key(i) as string;
80
- keys.push(key);
81
- }
82
- return keys;
83
- }
84
- }
85
-
86
- public static getConfig(key: string, defaultValue?: string): string | null {
87
- if (key === "__proto__" || key === "__prototype__") {
88
- throw new Error("invalid key " + key);
89
- }
90
- if (processEnvDefined) {
91
- return process.env[key] !== undefined ? process.env[key] as string : (defaultValue !== undefined ? defaultValue : null);
92
- } else {
93
- /* eslint-disable @typescript-eslint/ban-ts-comment */
94
- // @ts-ignore
95
- return localStorage.getItem(key) ? localStorage.getItem(key) : (defaultValue !== undefined ? defaultValue : null);
96
- }
97
- }
98
- }
99
-
100
- export const checkEnvVariables = (requiredEnvVariables: string[], defaults?: string[]): string[] => {
101
- if (defaults && defaults.length !== requiredEnvVariables.length) {
102
- throw new Error(`defaults cannot be a different length of requiredEnvVariables`);
103
- }
104
- return requiredEnvVariables.map((envName, index) => {
105
- const value = ConfigStore.getConfig(envName, defaults && defaults[index] ? defaults && defaults[index] as string : undefined);
106
- if (!value) {
107
- throw new Error(`Env variable [${envName}!] not defined.`);
108
- }
109
- return value;
110
- });
111
- };