@miqro/core 1.4.2 → 1.5.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +100 -53
- package/dist/api-router.d.ts +36 -0
- package/dist/{handler/api-router.js → api-router.js} +1 -1
- package/dist/api-router.js.map +1 -0
- package/dist/{handler/app.d.ts → app.d.ts} +1 -1
- package/dist/{handler/app.js → app.js} +19 -15
- package/dist/app.js.map +1 -0
- package/dist/common/api-router-helpers.d.ts +31 -0
- package/dist/{util/session/common.js → common/api-router-helpers.js} +1 -1
- package/dist/common/api-router-helpers.js.map +1 -0
- package/dist/{handler → common}/api-router-utils.d.ts +9 -6
- package/dist/{handler → common}/api-router-utils.js +26 -6
- package/dist/common/api-router-utils.js.map +1 -0
- package/dist/{util → common}/config/config.d.ts +4 -4
- package/dist/{util → common}/config/config.js +31 -28
- package/dist/common/config/config.js.map +1 -0
- package/dist/{util → common}/config/featuretoggle.d.ts +0 -0
- package/dist/{util → common}/config/featuretoggle.js +0 -0
- package/dist/common/config/featuretoggle.js.map +1 -0
- package/dist/{util → common}/config/index.d.ts +1 -1
- package/dist/{util → common}/config/index.js +1 -1
- package/dist/common/config/index.js.map +1 -0
- package/dist/common/config/loader.d.ts +13 -0
- package/dist/{util/loader/index.js → common/config/loader.js} +14 -9
- package/dist/common/config/loader.js.map +1 -0
- package/dist/{handler/common → common}/context.d.ts +5 -5
- package/dist/{handler/common → common}/context.js +4 -17
- package/dist/common/context.js.map +1 -0
- package/dist/common/error/badrequesterror.d.ts +3 -0
- package/dist/common/error/badrequesterror.js +11 -0
- package/dist/common/error/badrequesterror.js.map +1 -0
- package/dist/common/error/configfilenotfound.d.ts +3 -0
- package/dist/{util → common}/error/configfilenotfound.js +1 -2
- package/dist/common/error/configfilenotfound.js.map +1 -0
- package/dist/common/error/forbiddenerror.d.ts +3 -0
- package/dist/{util → common}/error/forbiddenerror.js +1 -2
- package/dist/common/error/forbiddenerror.js.map +1 -0
- package/dist/{util → common}/error/index.d.ts +1 -1
- package/dist/{util → common}/error/index.js +1 -1
- package/dist/common/error/index.js.map +1 -0
- package/dist/common/error/notfound.d.ts +3 -0
- package/dist/{util → common}/error/notfound.js +1 -2
- package/dist/common/error/notfound.js.map +1 -0
- package/dist/common/error/notimplemented.d.ts +3 -0
- package/dist/{util → common}/error/notimplemented.js +1 -2
- package/dist/common/error/notimplemented.js.map +1 -0
- package/dist/common/error/unauthorizederror.d.ts +3 -0
- package/dist/{util → common}/error/unauthorizederror.js +1 -2
- package/dist/common/error/unauthorizederror.js.map +1 -0
- package/dist/{handler/common → common}/helpers.d.ts +0 -0
- package/dist/{handler/common → common}/helpers.js +0 -0
- package/dist/common/helpers.js.map +1 -0
- package/dist/{util → common}/index.d.ts +4 -5
- package/dist/{util → common}/index.js +4 -5
- package/dist/common/index.js.map +1 -0
- package/dist/{util → common}/logger/common.d.ts +0 -0
- package/dist/{util → common}/logger/common.js +0 -0
- package/dist/common/logger/common.js.map +1 -0
- package/dist/{util → common}/logger/factory.d.ts +0 -0
- package/dist/{util → common}/logger/factory.js +8 -2
- package/dist/common/logger/factory.js.map +1 -0
- package/dist/{util → common}/logger/formatter.d.ts +0 -0
- package/dist/{util → common}/logger/formatter.js +0 -0
- package/dist/common/logger/formatter.js.map +1 -0
- package/dist/{util → common}/logger/index.d.ts +1 -1
- package/dist/{util → common}/logger/index.js +1 -0
- package/dist/common/logger/index.js.map +1 -0
- package/dist/{util → common}/logger/logger.d.ts +0 -0
- package/dist/{util → common}/logger/logger.js +0 -0
- package/dist/common/logger/logger.js.map +1 -0
- package/dist/{util → common}/logger/transport.d.ts +0 -0
- package/dist/{util → common}/logger/transport.js +2 -2
- package/dist/common/logger/transport.js.map +1 -0
- package/dist/common/router-helpers.d.ts +3 -0
- package/dist/common/router-helpers.js +22 -0
- package/dist/common/router-helpers.js.map +1 -0
- package/dist/common/router-utils.d.ts +35 -0
- package/dist/common/router-utils.js +67 -0
- package/dist/common/router-utils.js.map +1 -0
- package/dist/{handler/middleware/session.d.ts → common/session/common.d.ts} +16 -3
- package/dist/{util/parser → common/session}/common.js +0 -0
- package/dist/{util/parser → common/session}/common.js.map +1 -1
- package/dist/{util → common}/session/index.d.ts +0 -0
- package/dist/{util → common}/session/index.js +0 -0
- package/dist/common/session/index.js.map +1 -0
- package/dist/{util → common}/session/service.d.ts +3 -3
- package/dist/{util → common}/session/service.js +7 -7
- package/dist/common/session/service.js.map +1 -0
- package/dist/{handler/common → common}/tokenize-match.d.ts +0 -0
- package/dist/{handler/common → common}/tokenize-match.js +0 -0
- package/dist/common/tokenize-match.js.map +1 -0
- package/dist/index.d.ts +7 -2
- package/dist/index.js +7 -2
- package/dist/index.js.map +1 -1
- package/dist/{handler/middleware → middleware}/buffer.d.ts +0 -0
- package/dist/middleware/buffer.js +81 -0
- package/dist/middleware/buffer.js.map +1 -0
- package/dist/{handler/middleware → middleware}/cookie.d.ts +0 -0
- package/dist/{handler/middleware → middleware}/cookie.js +2 -1
- package/dist/middleware/cookie.js.map +1 -0
- package/dist/{handler/middleware → middleware}/cors.d.ts +0 -0
- package/dist/{handler/middleware → middleware}/cors.js +6 -7
- package/dist/middleware/cors.js.map +1 -0
- package/dist/{handler/middleware → middleware}/form.d.ts +0 -0
- package/dist/{handler/middleware → middleware}/form.js +8 -7
- package/dist/middleware/form.js.map +1 -0
- package/dist/middleware/group.d.ts +2 -0
- package/dist/{handler/middleware → middleware}/group.js +7 -7
- package/dist/middleware/group.js.map +1 -0
- package/dist/{handler/middleware → middleware}/index.d.ts +0 -0
- package/dist/{handler/middleware → middleware}/index.js +8 -8
- package/dist/middleware/index.js.map +1 -0
- package/dist/{handler/middleware → middleware}/json.d.ts +0 -0
- package/dist/{handler/middleware → middleware}/json.js +7 -7
- package/dist/middleware/json.js.map +1 -0
- package/dist/{handler/middleware → middleware}/logger.d.ts +0 -0
- package/dist/{handler/middleware → middleware}/logger.js +1 -1
- package/dist/middleware/logger.js.map +1 -0
- package/dist/middleware/parse.d.ts +9 -0
- package/dist/{handler/middleware → middleware}/parse.js +14 -13
- package/dist/middleware/parse.js.map +1 -0
- package/dist/middleware/session.d.ts +2 -0
- package/dist/{handler/middleware → middleware}/session.js +13 -14
- package/dist/middleware/session.js.map +1 -0
- package/dist/{handler/middleware → middleware}/tag.d.ts +0 -0
- package/dist/{handler/middleware → middleware}/tag.js +1 -1
- package/dist/middleware/tag.js.map +1 -0
- package/dist/{handler/middleware → middleware}/text.d.ts +0 -0
- package/dist/{handler/middleware → middleware}/text.js +7 -8
- package/dist/middleware/text.js.map +1 -0
- package/dist/{handler/proxy.d.ts → proxy.d.ts} +1 -1
- package/dist/{handler/proxy.js → proxy.js} +3 -3
- package/dist/proxy.js.map +1 -0
- package/dist/{handler/common/router.d.ts → router.d.ts} +31 -7
- package/dist/router.js +260 -0
- package/dist/router.js.map +1 -0
- package/dist/static.d.ts +11 -0
- package/dist/static.js +192 -0
- package/dist/static.js.map +1 -0
- package/package.json +11 -14
- package/dist/handler/api-router-utils.js.map +0 -1
- package/dist/handler/api-router.d.ts +0 -70
- package/dist/handler/api-router.js.map +0 -1
- package/dist/handler/app.js.map +0 -1
- package/dist/handler/common/context.js.map +0 -1
- package/dist/handler/common/helpers.js.map +0 -1
- package/dist/handler/common/index.d.ts +0 -2
- package/dist/handler/common/index.js +0 -15
- package/dist/handler/common/index.js.map +0 -1
- package/dist/handler/common/router-utils.d.ts +0 -59
- package/dist/handler/common/router-utils.js +0 -189
- package/dist/handler/common/router-utils.js.map +0 -1
- package/dist/handler/common/router.js +0 -93
- package/dist/handler/common/router.js.map +0 -1
- package/dist/handler/common/tokenize-match.js.map +0 -1
- package/dist/handler/index.d.ts +0 -5
- package/dist/handler/index.js +0 -18
- package/dist/handler/index.js.map +0 -1
- package/dist/handler/middleware/buffer.js +0 -79
- package/dist/handler/middleware/buffer.js.map +0 -1
- package/dist/handler/middleware/cookie.js.map +0 -1
- package/dist/handler/middleware/cors.js.map +0 -1
- package/dist/handler/middleware/form.js.map +0 -1
- package/dist/handler/middleware/group.d.ts +0 -3
- package/dist/handler/middleware/group.js.map +0 -1
- package/dist/handler/middleware/index.js.map +0 -1
- package/dist/handler/middleware/json.js.map +0 -1
- package/dist/handler/middleware/logger.js.map +0 -1
- package/dist/handler/middleware/parse.d.ts +0 -11
- package/dist/handler/middleware/parse.js.map +0 -1
- package/dist/handler/middleware/session.js.map +0 -1
- package/dist/handler/middleware/tag.js.map +0 -1
- package/dist/handler/middleware/text.js.map +0 -1
- package/dist/handler/proxy.js.map +0 -1
- package/dist/util/cli/index.d.ts +0 -17
- package/dist/util/cli/index.js +0 -84
- package/dist/util/cli/index.js.map +0 -1
- package/dist/util/config/browser.d.ts +0 -1
- package/dist/util/config/browser.js +0 -10
- package/dist/util/config/browser.js.map +0 -1
- package/dist/util/config/config.js.map +0 -1
- package/dist/util/config/featuretoggle.js.map +0 -1
- package/dist/util/config/index.js.map +0 -1
- package/dist/util/error/configfilenotfound.d.ts +0 -4
- package/dist/util/error/configfilenotfound.js.map +0 -1
- package/dist/util/error/forbiddenerror.d.ts +0 -4
- package/dist/util/error/forbiddenerror.js.map +0 -1
- package/dist/util/error/index.js.map +0 -1
- package/dist/util/error/named.d.ts +0 -3
- package/dist/util/error/named.js +0 -11
- package/dist/util/error/named.js.map +0 -1
- package/dist/util/error/notfound.d.ts +0 -4
- package/dist/util/error/notfound.js.map +0 -1
- package/dist/util/error/notimplemented.d.ts +0 -4
- package/dist/util/error/notimplemented.js.map +0 -1
- package/dist/util/error/parsererror.d.ts +0 -8
- package/dist/util/error/parsererror.js +0 -20
- package/dist/util/error/parsererror.js.map +0 -1
- package/dist/util/error/unauthorizederror.d.ts +0 -4
- package/dist/util/error/unauthorizederror.js.map +0 -1
- package/dist/util/index.js.map +0 -1
- package/dist/util/loader/index.d.ts +0 -4
- package/dist/util/loader/index.js.map +0 -1
- package/dist/util/logger/common.js.map +0 -1
- package/dist/util/logger/factory.js.map +0 -1
- package/dist/util/logger/formatter.js.map +0 -1
- package/dist/util/logger/index.js.map +0 -1
- package/dist/util/logger/logger.js.map +0 -1
- package/dist/util/logger/transport.js.map +0 -1
- package/dist/util/parser/common.d.ts +0 -69
- package/dist/util/parser/get.d.ts +0 -3
- package/dist/util/parser/get.js +0 -44
- package/dist/util/parser/get.js.map +0 -1
- package/dist/util/parser/index.d.ts +0 -3
- package/dist/util/parser/index.js +0 -16
- package/dist/util/parser/index.js.map +0 -1
- package/dist/util/parser/parser.d.ts +0 -35
- package/dist/util/parser/parser.js +0 -198
- package/dist/util/parser/parser.js.map +0 -1
- package/dist/util/parser/types/any.d.ts +0 -2
- package/dist/util/parser/types/any.js +0 -11
- package/dist/util/parser/types/any.js.map +0 -1
- package/dist/util/parser/types/array.d.ts +0 -2
- package/dist/util/parser/types/array.js +0 -59
- package/dist/util/parser/types/array.js.map +0 -1
- package/dist/util/parser/types/boolean.d.ts +0 -2
- package/dist/util/parser/types/boolean.js +0 -12
- package/dist/util/parser/types/boolean.js.map +0 -1
- package/dist/util/parser/types/email.d.ts +0 -2
- package/dist/util/parser/types/email.js +0 -23
- package/dist/util/parser/types/email.js.map +0 -1
- package/dist/util/parser/types/enum.d.ts +0 -2
- package/dist/util/parser/types/enum.js +0 -26
- package/dist/util/parser/types/enum.js.map +0 -1
- package/dist/util/parser/types/index.d.ts +0 -12
- package/dist/util/parser/types/index.js +0 -25
- package/dist/util/parser/types/index.js.map +0 -1
- package/dist/util/parser/types/multiple.d.ts +0 -2
- package/dist/util/parser/types/multiple.js +0 -33
- package/dist/util/parser/types/multiple.js.map +0 -1
- package/dist/util/parser/types/nested.d.ts +0 -2
- package/dist/util/parser/types/nested.js +0 -16
- package/dist/util/parser/types/nested.js.map +0 -1
- package/dist/util/parser/types/number.d.ts +0 -2
- package/dist/util/parser/types/number.js +0 -29
- package/dist/util/parser/types/number.js.map +0 -1
- package/dist/util/parser/types/object.d.ts +0 -2
- package/dist/util/parser/types/object.js +0 -11
- package/dist/util/parser/types/object.js.map +0 -1
- package/dist/util/parser/types/regex.d.ts +0 -2
- package/dist/util/parser/types/regex.js +0 -16
- package/dist/util/parser/types/regex.js.map +0 -1
- package/dist/util/parser/types/string.d.ts +0 -2
- package/dist/util/parser/types/string.js +0 -19
- package/dist/util/parser/types/string.js.map +0 -1
- package/dist/util/parser/types/url.d.ts +0 -2
- package/dist/util/parser/types/url.js +0 -35
- package/dist/util/parser/types/url.js.map +0 -1
- package/dist/util/request/common.d.ts +0 -57
- package/dist/util/request/common.js +0 -146
- package/dist/util/request/common.js.map +0 -1
- package/dist/util/request/index.d.ts +0 -4
- package/dist/util/request/index.js +0 -231
- package/dist/util/request/index.js.map +0 -1
- package/dist/util/session/common.d.ts +0 -15
- package/dist/util/session/common.js.map +0 -1
- package/dist/util/session/index.js.map +0 -1
- package/dist/util/session/service.js.map +0 -1
- package/src/handler/api-router-utils.ts +0 -187
- package/src/handler/api-router.ts +0 -86
- package/src/handler/app.ts +0 -133
- package/src/handler/common/context.ts +0 -156
- package/src/handler/common/helpers.ts +0 -11
- package/src/handler/common/index.ts +0 -2
- package/src/handler/common/router-utils.ts +0 -232
- package/src/handler/common/router.ts +0 -98
- package/src/handler/common/tokenize-match.ts +0 -152
- package/src/handler/index.ts +0 -5
- package/src/handler/middleware/buffer.ts +0 -79
- package/src/handler/middleware/cookie.ts +0 -19
- package/src/handler/middleware/cors.ts +0 -98
- package/src/handler/middleware/form.ts +0 -59
- package/src/handler/middleware/group.ts +0 -70
- package/src/handler/middleware/index.ts +0 -48
- package/src/handler/middleware/json.ts +0 -56
- package/src/handler/middleware/logger.ts +0 -18
- package/src/handler/middleware/parse.ts +0 -93
- package/src/handler/middleware/session.ts +0 -155
- package/src/handler/middleware/tag.ts +0 -15
- package/src/handler/middleware/text.ts +0 -47
- package/src/handler/proxy.ts +0 -39
- package/src/index.ts +0 -2
- package/src/util/cli/index.ts +0 -81
- package/src/util/config/browser.ts +0 -5
- package/src/util/config/config.ts +0 -93
- package/src/util/config/featuretoggle.ts +0 -6
- package/src/util/config/index.ts +0 -3
- package/src/util/error/configfilenotfound.ts +0 -8
- package/src/util/error/forbiddenerror.ts +0 -8
- package/src/util/error/index.ts +0 -6
- package/src/util/error/named.ts +0 -3
- package/src/util/error/notfound.ts +0 -8
- package/src/util/error/notimplemented.ts +0 -8
- package/src/util/error/parsererror.ts +0 -15
- package/src/util/error/unauthorizederror.ts +0 -8
- package/src/util/index.ts +0 -8
- package/src/util/loader/index.ts +0 -61
- package/src/util/logger/common.ts +0 -6
- package/src/util/logger/factory.ts +0 -45
- package/src/util/logger/formatter.ts +0 -9
- package/src/util/logger/index.ts +0 -6
- package/src/util/logger/logger.ts +0 -114
- package/src/util/logger/transport.ts +0 -69
- package/src/util/parser/common.ts +0 -81
- package/src/util/parser/get.ts +0 -40
- package/src/util/parser/index.ts +0 -3
- package/src/util/parser/parser.ts +0 -235
- package/src/util/parser/types/any.ts +0 -8
- package/src/util/parser/types/array.ts +0 -73
- package/src/util/parser/types/boolean.ts +0 -13
- package/src/util/parser/types/email.ts +0 -26
- package/src/util/parser/types/enum.ts +0 -29
- package/src/util/parser/types/index.ts +0 -12
- package/src/util/parser/types/multiple.ts +0 -36
- package/src/util/parser/types/nested.ts +0 -19
- package/src/util/parser/types/number.ts +0 -34
- package/src/util/parser/types/object.ts +0 -10
- package/src/util/parser/types/regex.ts +0 -17
- package/src/util/parser/types/string.ts +0 -23
- package/src/util/parser/types/url.ts +0 -35
- package/src/util/request/common.ts +0 -193
- package/src/util/request/index.ts +0 -230
- package/src/util/session/common.ts +0 -20
- package/src/util/session/index.ts +0 -2
- package/src/util/session/service.ts +0 -154
- package/tsconfig.json +0 -32
package/README.md
CHANGED
|
@@ -1,97 +1,144 @@
|
|
|
1
1
|
# @miqro/core
|
|
2
2
|
|
|
3
|
-
## async wrapper for http.request
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { request } from "@miqro/core";
|
|
7
|
-
|
|
8
|
-
const response = await request({
|
|
9
|
-
url: "https://hostname/path",
|
|
10
|
-
followRedirect: true, // defaults to false
|
|
11
|
-
query: {
|
|
12
|
-
category: "some category"
|
|
13
|
-
},
|
|
14
|
-
method: "POST",
|
|
15
|
-
data: {
|
|
16
|
-
some: "text"
|
|
17
|
-
}
|
|
18
|
-
});
|
|
19
|
-
console.log(response.status)
|
|
20
|
-
console.dir(response.headers)
|
|
21
|
-
console.dir(response.data)
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
## get attr from object with default value
|
|
25
|
-
|
|
26
|
-
```typescript
|
|
27
|
-
import { get } from "@miqro/core";
|
|
28
|
-
|
|
29
|
-
const data = {
|
|
30
|
-
user: {
|
|
31
|
-
details: {
|
|
32
|
-
name: "name"
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
|
-
};
|
|
36
|
-
|
|
37
|
-
const name = get(data, "user.details.name", "NO_NAME");
|
|
38
|
-
const loginCount = get(data, "user.details.meta.loginCount", 0); // 0 default
|
|
39
|
-
```
|
|
40
|
-
|
|
41
3
|
## promise based router for native http module
|
|
42
4
|
|
|
43
5
|
```typescript
|
|
44
|
-
import
|
|
45
|
-
import {
|
|
6
|
+
import {createServer} from "http";
|
|
7
|
+
import {Router, JSONParser} from "@miqro/core";
|
|
46
8
|
|
|
47
9
|
const router = new Router();
|
|
48
10
|
|
|
49
11
|
router.post("/echo", [JSONParser(), async (ctx) => {
|
|
50
|
-
// the
|
|
12
|
+
// the IncomingMessage is in ctx.req
|
|
51
13
|
// the ServerResponse is in ctx.res
|
|
52
14
|
ctx.logger.info("we got a echo request hit with query: %o params: %o body: %o", ctx.query, ctx.params, ctx.body);
|
|
53
15
|
await ctx.json({
|
|
54
16
|
body: ctx.body
|
|
55
|
-
})
|
|
17
|
+
});
|
|
56
18
|
}]);
|
|
57
19
|
router.get("/user/:userId", async (ctx) => {
|
|
58
20
|
await ctx.json({
|
|
59
21
|
userId: ctx.params.userId
|
|
60
|
-
})
|
|
22
|
+
});
|
|
61
23
|
});
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
24
|
+
router.use(async (ctx) => {
|
|
25
|
+
await ctx.end({
|
|
26
|
+
headers: {
|
|
27
|
+
["Content-Type"]: "plain/text; charset=utf-8"
|
|
28
|
+
},
|
|
29
|
+
status: 404,
|
|
30
|
+
body: "NOT FOUND"
|
|
31
|
+
});
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
const server = createServer(router.listener).listen(8080);
|
|
35
|
+
// or to handle 404 and default errors
|
|
36
|
+
// import { App } from "@miqro/core";
|
|
37
|
+
// const server = createServer(new App().use(router, "/api").listener).listen(8080);
|
|
65
38
|
// or
|
|
66
39
|
// const server = app.listen(8080);
|
|
67
40
|
```
|
|
68
41
|
|
|
69
|
-
|
|
70
42
|
## router.use extended options for request parsing
|
|
71
43
|
|
|
44
|
+
for more examples of parsing see [@miqro/parser](https://www.npmjs.com/package/@miqro/parser)
|
|
45
|
+
|
|
72
46
|
```typescript
|
|
73
47
|
router.get("/add/:a/:b", {
|
|
74
48
|
request: {
|
|
75
|
-
query: false, // do not allow query params
|
|
76
49
|
body: false, // do not allow body
|
|
77
50
|
params: {
|
|
78
51
|
options: {
|
|
79
52
|
a: "number", // parse param :a to a number if posible if not throw 400
|
|
80
|
-
b: "number" // parse param :b to a number if posible if not throw 400
|
|
53
|
+
b: "number", // parse param :b to a number if posible if not throw 400
|
|
54
|
+
}
|
|
55
|
+
//,mode: "no_extra" // defaults to no_extra
|
|
56
|
+
},
|
|
57
|
+
query: {
|
|
58
|
+
options: {
|
|
59
|
+
decimals: "boolean?|number?", // two optional posible parsing types
|
|
60
|
+
format: {
|
|
61
|
+
type: "enum?", // optional enum
|
|
62
|
+
enumValues: ["number", "text"],
|
|
63
|
+
defaultValue: "number"
|
|
64
|
+
},
|
|
65
|
+
mode: "add_extra"
|
|
81
66
|
}
|
|
82
67
|
}
|
|
83
68
|
},
|
|
69
|
+
response: {
|
|
70
|
+
body: "number|string"
|
|
71
|
+
},
|
|
84
72
|
handler: async (ctx) => {
|
|
85
73
|
// ctx.params.a and ctx.params.b are numbers and not strings
|
|
86
74
|
const result = ctx.params.a + ctx.params.b;
|
|
87
75
|
ctx.logger.info("adding %s + %s = %s", ctx.params.a, ctx.params.b, result);
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
76
|
+
|
|
77
|
+
const decimals = ctx.query.decimals;
|
|
78
|
+
|
|
79
|
+
ctx.info("decimals set on query %s", decimals);
|
|
80
|
+
|
|
81
|
+
switch (ctx.query.format) {
|
|
82
|
+
case "number":
|
|
83
|
+
await ctx.text(result);
|
|
84
|
+
break;
|
|
85
|
+
case "text":
|
|
86
|
+
await ctx.text("the result is " + result);
|
|
87
|
+
break;
|
|
88
|
+
default:
|
|
89
|
+
throw new BadRequest("unsupported format");
|
|
90
|
+
}
|
|
91
91
|
}
|
|
92
92
|
});
|
|
93
93
|
```
|
|
94
94
|
|
|
95
|
+
using custom parser with custom types with router.use(...)
|
|
96
|
+
|
|
97
|
+
```typescript
|
|
98
|
+
import {Parser} from "@miqro/parser";
|
|
99
|
+
|
|
100
|
+
const parser = new Parser();
|
|
101
|
+
parser.registerType("AddParams", {
|
|
102
|
+
a: "number", // parse param :a to a number if posible if not throw 400
|
|
103
|
+
b: "number", // parse param :b to a number if posible if not throw 400
|
|
104
|
+
});
|
|
105
|
+
parser.registerType("AddQuery", {
|
|
106
|
+
decimals: "boolean?|number?", // two optional posible parsing types
|
|
107
|
+
format: {
|
|
108
|
+
type: "enum?", // optional enum
|
|
109
|
+
enumValues: ["number", "text"],
|
|
110
|
+
defaultValue: "number"
|
|
111
|
+
}
|
|
112
|
+
}, "add_extra");
|
|
113
|
+
|
|
114
|
+
router.get("/add/:a/:b", {
|
|
115
|
+
parser,
|
|
116
|
+
request: {
|
|
117
|
+
body: false, // do not allow body
|
|
118
|
+
params: "AddParams",
|
|
119
|
+
query: "AddQuery"
|
|
120
|
+
},
|
|
121
|
+
response: {
|
|
122
|
+
body: "number|string"
|
|
123
|
+
},
|
|
124
|
+
handler: async (ctx) => {
|
|
125
|
+
// ...
|
|
126
|
+
}
|
|
127
|
+
});
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
for more information on the parser see [@miqro/parser](https://www.npmjs.com/package/@miqro/parser)
|
|
131
|
+
|
|
132
|
+
## serving static files
|
|
133
|
+
|
|
134
|
+
```typescript
|
|
135
|
+
import {Static} from "@miqro/core";
|
|
136
|
+
|
|
137
|
+
router.use(Static({
|
|
138
|
+
directory: resolve(__dirname, "test-data", "static1")
|
|
139
|
+
}), "/content/public");
|
|
140
|
+
```
|
|
141
|
+
|
|
95
142
|
## error handling
|
|
96
143
|
|
|
97
144
|
```typescript
|
|
@@ -99,7 +146,7 @@ router.catch(myFallBackerrorHandler1) // this will catch all throws
|
|
|
99
146
|
router.catch(myFallBackerrorHandler2) // if myFallBackerrorHandler1 didnt ended the request myFallBackerrorHandler2 will be called
|
|
100
147
|
|
|
101
148
|
router.use(async (ctx) => {
|
|
102
|
-
|
|
149
|
+
throw new Error("");
|
|
103
150
|
});
|
|
104
151
|
```
|
|
105
152
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Logger } from "./common/logger";
|
|
2
|
+
/**
|
|
3
|
+
* # APIRouter
|
|
4
|
+
*
|
|
5
|
+
* src/server.js
|
|
6
|
+
* ```typescript
|
|
7
|
+
*import { App, APIRouter } from "@miqro/core";
|
|
8
|
+
*const app = new App();
|
|
9
|
+
*app.use(APIRouter({ dirname: resolve(__dirname, "api") }));
|
|
10
|
+
*app.listen(8080);
|
|
11
|
+
* ```
|
|
12
|
+
*
|
|
13
|
+
* src/api/user/post.js
|
|
14
|
+
*
|
|
15
|
+
* ```typescript
|
|
16
|
+
*import { ReadBuffer, JSONParser, APIRoute } from "@miqro/core";
|
|
17
|
+
*
|
|
18
|
+
*const route: APIRoute = {
|
|
19
|
+
* middleware: [ReadBuffer(), JSONParser()]
|
|
20
|
+
* query: { ... },
|
|
21
|
+
* body: { ... },
|
|
22
|
+
* result: { ... },
|
|
23
|
+
* handler: async (ctx: Context) => {
|
|
24
|
+
* return {
|
|
25
|
+
* status: "OK"
|
|
26
|
+
* };
|
|
27
|
+
* }
|
|
28
|
+
*}
|
|
29
|
+
*export default route;
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
export declare const APIRouter: (options: {
|
|
33
|
+
dirname: string;
|
|
34
|
+
apiName?: string;
|
|
35
|
+
path?: string;
|
|
36
|
+
}, logger?: Logger | undefined) => import("./router").Router;
|
|
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.APIRouter = void 0;
|
|
4
4
|
const fs_1 = require("fs");
|
|
5
5
|
const path_1 = require("path");
|
|
6
|
-
const api_router_utils_1 = require("./api-router-utils");
|
|
6
|
+
const api_router_utils_1 = require("./common/api-router-utils");
|
|
7
7
|
/**
|
|
8
8
|
* # APIRouter
|
|
9
9
|
*
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-router.js","sourceRoot":"","sources":["../src/api-router.ts"],"names":[],"mappings":";;;AAAA,2BAAyC;AACzC,+BAA8B;AAC9B,gEAA6E;AAG7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,MAAM,SAAS,GAAG,CAAC,OAIzB,EAAE,MAAe,EAAE,EAAE;IACpB,MAAM,EAAC,OAAO,EAAC,GAAG,OAAO,CAAC;IAC1B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;KACrD;IACD,IAAI,CAAC,IAAA,eAAU,EAAC,OAAO,CAAC,IAAI,CAAC,IAAA,cAAS,EAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;QAC7D,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,mBAAmB,CAAC,CAAC;KAChD;IACD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAA,eAAQ,EAAC,OAAO,CAAC,CAAC;IACpF,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC;IAC1E,OAAO,IAAA,gCAAa,EAAC,IAAA,sCAAmB,EAAC,OAAO,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;AAChH,CAAC,CAAC;AAfW,QAAA,SAAS,aAepB"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
2
|
import { RequestListener, Server } from "http";
|
|
3
|
-
import { Router, RouterOptions } from "./
|
|
3
|
+
import { Router, RouterOptions } from "./router";
|
|
4
4
|
export declare class App extends Router {
|
|
5
5
|
readonly listener: RequestListener;
|
|
6
6
|
constructor(config?: RouterOptions);
|
|
@@ -2,23 +2,24 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.App = void 0;
|
|
4
4
|
const http_1 = require("http");
|
|
5
|
+
const uuid_1 = require("uuid");
|
|
5
6
|
const common_1 = require("./common");
|
|
6
|
-
|
|
7
|
+
const router_1 = require("./router");
|
|
8
|
+
class App extends router_1.Router {
|
|
7
9
|
constructor(config) {
|
|
8
10
|
super(config);
|
|
9
11
|
const errorHandler = DefaultErrorHandler();
|
|
12
|
+
const loggerFactory = this.config && this.config.loggerFactory ? this.config.loggerFactory : common_1.defaultLoggerFactory;
|
|
10
13
|
this.listener = async (req, res) => {
|
|
11
|
-
const
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
this.config.newRequestLogger(req) :
|
|
15
|
-
undefined);
|
|
14
|
+
const uuid = (0, uuid_1.v4)().toString();
|
|
15
|
+
const logger = loggerFactory(uuid, req);
|
|
16
|
+
const ctx = new common_1.Context(uuid, req, res, logger);
|
|
16
17
|
ctx.logger.trace(`request received`);
|
|
17
18
|
try {
|
|
18
19
|
await this.run(ctx);
|
|
19
20
|
if (!ctx.res.headersSent) {
|
|
20
|
-
ctx.end({
|
|
21
|
-
headers:
|
|
21
|
+
await ctx.end({
|
|
22
|
+
headers: HTML_HEADERS,
|
|
22
23
|
status: STATUS.NOT_FOUND,
|
|
23
24
|
body: "NOT FOUND"
|
|
24
25
|
});
|
|
@@ -30,7 +31,7 @@ class App extends common_1.Router {
|
|
|
30
31
|
await errorHandler(e, ctx);
|
|
31
32
|
if (!ctx.res.headersSent) {
|
|
32
33
|
ctx.logger.error(e);
|
|
33
|
-
ctx.end({
|
|
34
|
+
await ctx.end({
|
|
34
35
|
headers: TEXT_HEADERS,
|
|
35
36
|
status: STATUS.ERROR,
|
|
36
37
|
body: "SERVER ERROR"
|
|
@@ -52,6 +53,9 @@ exports.App = App;
|
|
|
52
53
|
const TEXT_HEADERS = {
|
|
53
54
|
["Content-Type"]: "plain/text; charset=utf-8"
|
|
54
55
|
};
|
|
56
|
+
const HTML_HEADERS = {
|
|
57
|
+
["Content-Type"]: "text/html; charset=utf-8"
|
|
58
|
+
};
|
|
55
59
|
const STATUS = {
|
|
56
60
|
ERROR: 503,
|
|
57
61
|
BAD_REQUEST: 400,
|
|
@@ -79,28 +83,28 @@ const DefaultErrorHandler = () => {
|
|
|
79
83
|
switch (name) {
|
|
80
84
|
case "NotFoundError":
|
|
81
85
|
await ctx.end({
|
|
82
|
-
headers:
|
|
86
|
+
headers: HTML_HEADERS,
|
|
83
87
|
status: STATUS.NOT_FOUND,
|
|
84
88
|
body: e.message ? e.message : "NOT FOUND"
|
|
85
89
|
});
|
|
86
90
|
break;
|
|
87
91
|
case "MethodNotImplementedError":
|
|
88
92
|
await ctx.end({
|
|
89
|
-
headers:
|
|
93
|
+
headers: HTML_HEADERS,
|
|
90
94
|
status: STATUS.NOT_IMPLEMENTED,
|
|
91
95
|
body: e.message ? e.message : "NOT IMPLEMENTED"
|
|
92
96
|
});
|
|
93
97
|
break;
|
|
94
98
|
case "ForbiddenError":
|
|
95
99
|
await ctx.end({
|
|
96
|
-
headers:
|
|
100
|
+
headers: HTML_HEADERS,
|
|
97
101
|
status: STATUS.FORBIDDEN,
|
|
98
102
|
body: e.message ? e.message : "FORBIDDEN"
|
|
99
103
|
});
|
|
100
104
|
break;
|
|
101
105
|
case "UnAuthorizedError":
|
|
102
106
|
await ctx.end({
|
|
103
|
-
headers:
|
|
107
|
+
headers: HTML_HEADERS,
|
|
104
108
|
status: STATUS.UNAUTHORIZED,
|
|
105
109
|
body: e.message ? e.message : "UNAUTHORIZED"
|
|
106
110
|
});
|
|
@@ -111,14 +115,14 @@ const DefaultErrorHandler = () => {
|
|
|
111
115
|
case "SequelizeEagerLoadingError":
|
|
112
116
|
case "SequelizeUniqueConstraintError":
|
|
113
117
|
await ctx.end({
|
|
114
|
-
headers:
|
|
118
|
+
headers: HTML_HEADERS,
|
|
115
119
|
status: STATUS.BAD_REQUEST,
|
|
116
120
|
body: e.message ? e.message : "BAD REQUEST"
|
|
117
121
|
});
|
|
118
122
|
break;
|
|
119
123
|
default:
|
|
120
124
|
await ctx.end({
|
|
121
|
-
headers:
|
|
125
|
+
headers: HTML_HEADERS,
|
|
122
126
|
status: STATUS.ERROR,
|
|
123
127
|
body: e.message ? e.message : "SERVER ERROR"
|
|
124
128
|
});
|
package/dist/app.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":";;;AAAA,+BAA2D;AAC3D,+BAAwB;AACxB,qCAAqE;AACrE,qCAA+C;AAE/C,MAAa,GAAI,SAAQ,eAAM;IAG7B,YAAY,MAAsB;QAChC,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,MAAM,YAAY,GAAG,mBAAmB,EAAE,CAAC;QAC3C,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,6BAAoB,CAAC;QAClH,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;YACjC,MAAM,IAAI,GAAG,IAAA,SAAE,GAAE,CAAC,QAAQ,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YACxC,MAAM,GAAG,GAAG,IAAI,gBAAO,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;YAChD,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACrC,IAAI;gBACF,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACpB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE;oBACxB,MAAM,GAAG,CAAC,GAAG,CAAC;wBACZ,OAAO,EAAE,YAAY;wBACrB,MAAM,EAAE,MAAM,CAAC,SAAS;wBACxB,IAAI,EAAE,WAAW;qBAClB,CAAC,CAAC;iBACJ;aACF;YAAC,OAAO,CAAM,EAAE;gBACf,IAAI;oBACF,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE;wBACxB,MAAM,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;wBAC3B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE;4BACxB,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;4BACpB,MAAM,GAAG,CAAC,GAAG,CAAC;gCACZ,OAAO,EAAE,YAAY;gCACrB,MAAM,EAAE,MAAM,CAAC,KAAK;gCACpB,IAAI,EAAE,cAAc;6BACrB,CAAC,CAAC;yBACJ;qBACF;iBACF;gBAAC,OAAO,EAAE,EAAE;oBACX,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;iBACtB;aACF;QACH,CAAC,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,GAAG,IAAW;QAC1B,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAA;IACpD,CAAC;CACF;AA5CD,kBA4CC;AAED,MAAM,YAAY,GAAG;IACnB,CAAC,cAAc,CAAC,EAAE,2BAA2B;CAC9C,CAAA;AAED,MAAM,YAAY,GAAG;IACnB,CAAC,cAAc,CAAC,EAAE,0BAA0B;CAC7C,CAAA;AAED,MAAM,MAAM,GAAG;IACb,KAAK,EAAE,GAAG;IACV,WAAW,EAAE,GAAG;IAChB,SAAS,EAAE,GAAG;IACd,eAAe,EAAE,GAAG;IACpB,SAAS,EAAE,GAAG;IACd,YAAY,EAAE,GAAG;CAClB,CAAC;AAEF,MAAM,mBAAmB,GAAG,GAA0B,EAAE;IACtD,OAAO,KAAK,EAAE,CAAM,EAAE,GAAY,EAAoB,EAAE;QACtD,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO,EAAE;YACvC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE;gBAC7E,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACpB,MAAM,GAAG,CAAC,GAAG,CAAC;oBACZ,OAAO,EAAE,YAAY;oBACrB,MAAM,EAAE,MAAM,CAAC,KAAK;oBACpB,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,0FAA0F,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;iBAC7K,CAAC,CAAC;gBACH,OAAO,KAAK,CAAC;aACd;SACF;aAAM;YACL,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACpB,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9C,QAAQ,IAAI,EAAE;gBACZ,KAAK,eAAe;oBAClB,MAAM,GAAG,CAAC,GAAG,CAAC;wBACZ,OAAO,EAAE,YAAY;wBACrB,MAAM,EAAE,MAAM,CAAC,SAAS;wBACxB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW;qBAC1C,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,2BAA2B;oBAC9B,MAAM,GAAG,CAAC,GAAG,CAAC;wBACZ,OAAO,EAAE,YAAY;wBACrB,MAAM,EAAE,MAAM,CAAC,eAAe;wBAC9B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,iBAAiB;qBAChD,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,gBAAgB;oBACnB,MAAM,GAAG,CAAC,GAAG,CAAC;wBACZ,OAAO,EAAE,YAAY;wBACrB,MAAM,EAAE,MAAM,CAAC,SAAS;wBACxB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW;qBAC1C,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,mBAAmB;oBACtB,MAAM,GAAG,CAAC,GAAG,CAAC;wBACZ,OAAO,EAAE,YAAY;wBACrB,MAAM,EAAE,MAAM,CAAC,YAAY;wBAC3B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc;qBAC7C,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,mBAAmB,CAAC;gBACzB,KAAK,iBAAiB,CAAC;gBACvB,KAAK,0BAA0B,CAAC;gBAChC,KAAK,4BAA4B,CAAC;gBAClC,KAAK,gCAAgC;oBACnC,MAAM,GAAG,CAAC,GAAG,CAAC;wBACZ,OAAO,EAAE,YAAY;wBACrB,MAAM,EAAE,MAAM,CAAC,WAAW;wBAC1B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa;qBAC5C,CAAC,CAAC;oBACH,MAAM;gBACR;oBACE,MAAM,GAAG,CAAC,GAAG,CAAC;wBACZ,OAAO,EAAE,YAAY;wBACrB,MAAM,EAAE,MAAM,CAAC,KAAK;wBACpB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc;qBAC7C,CAAC,CAAC;oBACH,MAAM;aACT;YACD,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC,CAAC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { ParseOptions, ParserInterface } from "@miqro/parser";
|
|
2
|
+
import { GroupPolicy, SessionHandlerOptions } from "./session";
|
|
3
|
+
import { Handler, Method } from "./context";
|
|
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 {
|
|
17
|
+
name?: string;
|
|
18
|
+
description?: string;
|
|
19
|
+
method?: Method | Method[];
|
|
20
|
+
path?: string | string[];
|
|
21
|
+
parser?: ParserInterface;
|
|
22
|
+
headers?: ParseOptions | ParseOptions[];
|
|
23
|
+
query?: ParseOptions | boolean | ParseOptions[] | string;
|
|
24
|
+
params?: ParseOptions | boolean | ParseOptions[] | string;
|
|
25
|
+
body?: ParseOptions | boolean | ParseOptions[] | string;
|
|
26
|
+
response?: ParseOptions | ParseOptions[] | string;
|
|
27
|
+
handler: Array<Handler> | Handler;
|
|
28
|
+
middleware?: Handler[];
|
|
29
|
+
session?: SessionHandlerOptions | Handler;
|
|
30
|
+
policy?: GroupPolicy;
|
|
31
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-router-helpers.js","sourceRoot":"","sources":["../../src/common/api-router-helpers.ts"],"names":[],"mappings":""}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import { Logger } from "
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
1
|
+
import { Logger } from "./logger";
|
|
2
|
+
import { Router } from "../router";
|
|
3
|
+
import { Handler, Method } from "./context";
|
|
4
|
+
import { RouterHandlerOptions } from "./router-utils";
|
|
5
|
+
import { ParseOptionMap } from "@miqro/parser";
|
|
6
|
+
export declare const APIRouteValidator: ParseOptionMap;
|
|
6
7
|
export declare const traverseAPIRouteDir: (featureName: string, dirname: string, basePath?: string, features?: FeatureRouterOptions, logger?: Logger | undefined) => FeatureRouterOptions;
|
|
7
8
|
export interface FeatureRouterPathOptions {
|
|
8
9
|
path: string | string[];
|
|
@@ -10,5 +11,7 @@ export interface FeatureRouterPathOptions {
|
|
|
10
11
|
handler: Array<Handler> | Handler;
|
|
11
12
|
options?: RouterHandlerOptions;
|
|
12
13
|
}
|
|
13
|
-
export declare type FeatureRouterOptions =
|
|
14
|
+
export declare type FeatureRouterOptions = {
|
|
15
|
+
[name: string]: FeatureRouterPathOptions;
|
|
16
|
+
};
|
|
14
17
|
export declare const FeatureRouter: (options: FeatureRouterOptions, logger?: Logger | undefined) => Router;
|
|
@@ -1,11 +1,28 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.FeatureRouter = exports.traverseAPIRouteDir = void 0;
|
|
3
|
+
exports.FeatureRouter = exports.traverseAPIRouteDir = exports.APIRouteValidator = void 0;
|
|
4
4
|
const fs_1 = require("fs");
|
|
5
5
|
const path_1 = require("path");
|
|
6
|
-
const tokenize_match_1 = require("./
|
|
7
|
-
const
|
|
8
|
-
const router_1 = require("
|
|
6
|
+
const tokenize_match_1 = require("./tokenize-match");
|
|
7
|
+
const config_1 = require("./config");
|
|
8
|
+
const router_1 = require("../router");
|
|
9
|
+
const parser_1 = require("@miqro/parser");
|
|
10
|
+
exports.APIRouteValidator = {
|
|
11
|
+
name: "string?",
|
|
12
|
+
description: "string?",
|
|
13
|
+
path: "string[]!?",
|
|
14
|
+
method: "string[]!?",
|
|
15
|
+
parser: "ParserInterface?",
|
|
16
|
+
headers: "ParseOptions[]!?",
|
|
17
|
+
query: "boolean?|ParseOptions[]!?|string?",
|
|
18
|
+
params: "boolean?|ParseOptions[]!?|string?",
|
|
19
|
+
body: "boolean?|ParseOptions[]!?|string?",
|
|
20
|
+
response: "ParseOptions[]!?|string?",
|
|
21
|
+
middleware: "function[]!?",
|
|
22
|
+
session: "function?|SessionHandlerOptions?",
|
|
23
|
+
group: "GroupPolicy?",
|
|
24
|
+
handler: "function[]!"
|
|
25
|
+
};
|
|
9
26
|
const traverseAPIRouteDir = (featureName, dirname, basePath = "/", features = {}, logger) => {
|
|
10
27
|
if (logger) {
|
|
11
28
|
logger.trace("loading routes from [%s]", dirname);
|
|
@@ -50,6 +67,7 @@ const traverseAPIRouteDir = (featureName, dirname, basePath = "/", features = {}
|
|
|
50
67
|
throw new Error(`${(0, path_1.resolve)(dirname, name)} doesnt export name as a string`);
|
|
51
68
|
}
|
|
52
69
|
}
|
|
70
|
+
route = (0, parser_1.parse)(route, exports.APIRouteValidator, "no_extra", ___filePath);
|
|
53
71
|
const paths = route.path instanceof Array ? route.path : route.path === undefined ? [route.method && route.method.indexOf(name) === -1 ? `/${name}` : "/"] : [route.path];
|
|
54
72
|
for (let i = 0; i < paths.length; i++) {
|
|
55
73
|
const p = paths[i];
|
|
@@ -78,7 +96,9 @@ const traverseAPIRouteDir = (featureName, dirname, basePath = "/", features = {}
|
|
|
78
96
|
body: route.body,
|
|
79
97
|
params: route.params,
|
|
80
98
|
},
|
|
81
|
-
response:
|
|
99
|
+
response: {
|
|
100
|
+
body: route.response ? route.response : true
|
|
101
|
+
}
|
|
82
102
|
},
|
|
83
103
|
path,
|
|
84
104
|
method: routeMethods,
|
|
@@ -126,7 +146,7 @@ const FeatureRouter = (options, logger) => {
|
|
|
126
146
|
throw new Error(`feature [${featureName}] method [${method.toUpperCase()}] not defined! use only [${FEATURE_ROUTER_METHODS.join(",")}]`);
|
|
127
147
|
}
|
|
128
148
|
const methods = method instanceof Array ? method : [method];
|
|
129
|
-
if ((0,
|
|
149
|
+
if ((0, config_1.isFeatureEnabled)(featureName)) {
|
|
130
150
|
if (logger) {
|
|
131
151
|
logger.trace(`feature [${featureName}] enabled`);
|
|
132
152
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-router-utils.js","sourceRoot":"","sources":["../../src/common/api-router-utils.ts"],"names":[],"mappings":";;;AAAA,2BAA0C;AAC1C,+BAAuD;AAGvD,qDAA+C;AAC/C,qCAA0C;AAC1C,sCAAiC;AAGjC,0CAAoD;AAEvC,QAAA,iBAAiB,GAAmB;IAC/C,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,SAAS;IACtB,IAAI,EAAE,YAAY;IAClB,MAAM,EAAE,YAAY;IACpB,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE,kBAAkB;IAC3B,KAAK,EAAE,mCAAmC;IAC1C,MAAM,EAAE,mCAAmC;IAC3C,IAAI,EAAE,mCAAmC;IACzC,QAAQ,EAAE,0BAA0B;IACpC,UAAU,EAAE,cAAc;IAC1B,OAAO,EAAE,kCAAkC;IAC3C,KAAK,EAAE,cAAc;IACrB,OAAO,EAAE,aAAa;CACvB,CAAC;AAEK,MAAM,mBAAmB,GAAG,CACjC,WAAmB,EACnB,OAAe,EACf,QAAQ,GAAG,GAAG,EACd,WAAiC,EAAE,EAAE,MAAe,EAAwB,EAAE;IAC9E,IAAI,MAAM,EAAE;QACV,MAAM,CAAC,KAAK,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;KACnD;IACD,MAAM,KAAK,GAAG,IAAA,gBAAW,EAAC,OAAO,CAAC,CAAC;IACnC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,cAAS,EAAC,IAAA,WAAI,EAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1E,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAA,cAAS,EAAC,IAAA,WAAI,EAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAC9E,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;QACpB,MAAM,EAAC,IAAI,EAAC,GAAG,IAAA,YAAS,EAAC,CAAC,CAAC,CAAC;QAC5B,QAAQ,GAAG,IAAA,2BAAmB,EAAC,GAAG,WAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,IAAA,WAAI,EAAC,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,QAAQ,IAAI,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;KACnI;IACD,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE;QACvB,MAAM,EAAC,IAAI,EAAE,GAAG,EAAC,GAAG,IAAA,YAAS,EAAC,CAAC,CAAC,CAAC;QACjC,IAAI,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,GAAG,KAAK,KAAK,IAAI,GAAG,KAAK,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,EAAE;YACrF,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACrC,8DAA8D;YAC9D,IAAI,KAAK,GAAa,OAAO,CAAC,QAAQ,CAAC,CAAC;YACxC,IAAK,KAAa,CAAC,OAAO,IAAK,KAAa,CAAC,UAAU,KAAK,IAAI,EAAE;gBAChE,KAAK,GAAI,KAAa,CAAC,OAAO,CAAC;aAChC;YACD,MAAM,WAAW,GAAG,QAAQ,GAAG,GAAG,CAAC;YACnC,IAAI,YAAY,GAAa,CAAC,IAAI,CAAa,CAAC;YAChD,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;gBAC/B,KAAK,GAAG;oBACN,OAAO,EAAE,KAAK;iBACR,CAAC;aACV;iBAAM;gBACL,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,WAAW,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,YAAY,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,EAAE;oBACnH,MAAM,IAAI,KAAK,CAAC,GAAG,IAAA,cAAO,EAAC,OAAO,EAAE,IAAI,CAAC,mDAAmD,CAAC,CAAC;iBAC/F;qBAAM,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,WAAW,EAAE;oBAC9C,YAAY,GAAG,KAAK,CAAC,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;iBAC9E;gBACD,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,YAAY,KAAK,CAAC,EAAE;oBACzG,MAAM,IAAI,KAAK,CAAC,GAAG,IAAA,cAAO,EAAC,OAAO,EAAE,IAAI,CAAC,mDAAmD,CAAC,CAAC;iBAC/F;gBACD,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,UAAU,CAAC,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,WAAW,EAAE;oBACtH,MAAM,IAAI,KAAK,CAAC,GAAG,IAAA,cAAO,EAAC,OAAO,EAAE,IAAI,CAAC,kDAAkD,CAAC,CAAC;iBAC9F;gBACD,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE;oBACvE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAA,cAAO,EAAC,OAAO,EAAE,IAAI,CAAC,iCAAiC,CAAC,CAAC;iBAC7E;aACF;YACD,KAAK,GAAG,IAAA,cAAK,EAAC,KAAK,EAAE,yBAAiB,EAAE,UAAU,EAAE,WAAW,CAAa,CAAC;YAC7E,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,IAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACpL,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACrC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBACnB,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,EAAE;oBAC/B,MAAM,IAAI,KAAK,CAAC,GAAG,IAAA,cAAO,EAAC,OAAO,EAAE,IAAI,CAAC,mDAAmD,CAAC,CAAC;iBAC/F;gBACD,MAAM,IAAI,GAAG,IAAA,8BAAa,EAAC,GAAG,QAAQ,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;gBAExE,MAAM,OAAO,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;gBACzF,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;gBAEjD,IAAI,iBAAiB,GAAG,GAAG,WAAW,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,EAAE,CAAC;gBAEtI,iBAAiB,GAAG,iBAAiB,CAAC,MAAM,GAAG,CAAC,IAAI,iBAAiB,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,EAAE,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC;gBACtM,IAAI,QAAQ,CAAC,iBAAiB,CAAC,EAAE;oBAC/B,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,+BAAgC,QAAQ,CAAC,iBAAiB,CAAS,CAAC,WAAW,EAAE,CAAC,CAAA;iBACjH;gBACD,QAAQ,CAAC,iBAAiB,CAAC,GAAG;oBAC5B,OAAO,EAAE;wBACP,IAAI,EAAE,KAAK,CAAC,IAAI;wBAChB,WAAW,EAAE,KAAK,CAAC,WAAW;wBAC9B,MAAM,EAAE,KAAK,CAAC,MAAM;wBACpB,UAAU,EAAE,KAAK,CAAC,UAAU;wBAC5B,OAAO,EAAE,KAAK,CAAC,OAAO;wBACtB,MAAM,EAAE,KAAK,CAAC,MAAM;wBACpB,OAAO,EAAE;4BACP,OAAO,EAAE,KAAK,CAAC,OAAO;4BACtB,KAAK,EAAE,KAAK,CAAC,KAAK;4BAClB,IAAI,EAAE,KAAK,CAAC,IAAI;4BAChB,MAAM,EAAE,KAAK,CAAC,MAAM;yBACrB;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI;yBAC7C;qBACF;oBACD,IAAI;oBACJ,MAAM,EAAE,YAAY;oBACpB,OAAO,EAAE,KAAK,CAAC,OAAO;iBACvB,CAAC;gBACD,QAAQ,CAAC,iBAAiB,CAAS,CAAC,WAAW,GAAG,WAAW,CAAC;aAChE;SACF;KACF;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AA3FW,QAAA,mBAAmB,uBA2F9B;AAWF,MAAM,sBAAsB,GAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;AAEvF,MAAM,aAAa,GAAG,CAAC,OAA6B,EAAE,MAAe,EAAU,EAAE;IACtF,MAAM,MAAM,GAAW,IAAI,eAAM,EAAE,CAAC;IACpC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,YAAY,GAA+B,EAAE,CAAC;IACpD,KAAK,MAAM,WAAW,IAAI,OAAO,EAAE;QACjC,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;QAC5C,IAAI,CAAC,cAAc,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,mCAAmC,WAAW,GAAG,CAAC,CAAC;SACpE;aAAM;YACL,MAAM,EAAC,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAC,GAAG,cAAc,CAAC;YAC/D,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,2BAA2B,WAAW,GAAG,CAAC,CAAC;aAC5D;iBAAM,IAAI,CAAC,cAAc,EAAE;gBAC1B,MAAM,IAAI,KAAK,CAAC,kCAAkC,WAAW,GAAG,CAAC,CAAC;aACnE;iBAAM,IAAI,CAAC,IAAI,EAAE;gBAChB,MAAM,IAAI,KAAK,CAAC,wBAAwB,WAAW,GAAG,CAAC,CAAC;aACzD;iBAAM;gBACL,IAAI,MAAM,YAAY,KAAK,EAAE;oBAC3B,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE;wBACtB,IAAI,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,EAAY,CAAC,KAAK,CAAC,CAAC,EAAE;4BACpE,MAAM,IAAI,KAAK,CAAC,YAAY,WAAW,aAAa,CAAC,CAAC,WAAW,EAAE,4BAA4B,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;yBACrI;qBACF;iBACF;qBAAM,IAAI,sBAAsB,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,EAAY,CAAC,KAAK,CAAC,CAAC,EAAE;oBAChF,MAAM,IAAI,KAAK,CAAC,YAAY,WAAW,aAAa,MAAM,CAAC,WAAW,EAAE,4BAA4B,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;iBAC1I;gBACD,MAAM,OAAO,GAAG,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;gBAC5D,IAAI,IAAA,yBAAgB,EAAC,WAAW,CAAC,EAAE;oBACjC,IAAI,MAAM,EAAE;wBACV,MAAM,CAAC,KAAK,CAAC,YAAY,WAAW,WAAW,CAAC,CAAC;qBAClD;oBACD,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBAC1B,MAAM,KAAK,GAAG,IAAI,YAAY,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;oBACpD,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE;wBACvB,MAAM,CAAC,GAAG,IAAA,8BAAa,EAAC,GAAG,CAAC,CAAC;wBAC7B,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE;4BACvB,IAAI,MAAM,EAAE;gCACV,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;gCAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;gCAC3C,IAAK,cAAsB,CAAC,WAAW,EAAE;oCACvC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAG,cAAsB,CAAC,WAAW,CAAC,CAAC;iCAC1D;6BACF;4BACD,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,SAAS,EAAE;gCAC1C,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,0BAA0B,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;6BAC7G;4BACD,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC;4BACvC,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC,iBAAiB,EAAY,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;yBACxF;qBACF;iBACF;qBAAM;oBACL,IAAI,MAAM,EAAE;wBACV,MAAM,CAAC,KAAK,CAAC,uBAAuB,EAAE,WAAW,CAAC,CAAC;qBACpD;oBACD,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;iBAC5B;aACF;SACF;KACF;IACD,IAAI,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QAChC,MAAM,CAAC,KAAK,CAAC,uBAAuB,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;KAC1D;IACD,IAAI,MAAM,EAAE;QACV,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACvB,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1D,MAAM,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;SACnE;aAAM;YACL,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACtC;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAzEW,QAAA,aAAa,iBAyExB"}
|
|
@@ -11,9 +11,9 @@ export interface LoadConfigOut {
|
|
|
11
11
|
outputs: ConfigOutput[];
|
|
12
12
|
}
|
|
13
13
|
export declare abstract class ConfigStore {
|
|
14
|
-
static putConfig(key: string, value: string
|
|
15
|
-
static clear(key: string
|
|
16
|
-
static keys(
|
|
17
|
-
static getConfig(key: string, defaultValue?: string
|
|
14
|
+
static putConfig(key: string, value: string): ConfigStore;
|
|
15
|
+
static clear(key: string): ConfigStore;
|
|
16
|
+
static keys(): string[];
|
|
17
|
+
static getConfig(key: string, defaultValue?: string): string | null;
|
|
18
18
|
}
|
|
19
19
|
export declare const checkEnvVariables: (requiredEnvVariables: string[], defaults?: string[] | undefined) => string[];
|
|
@@ -10,7 +10,7 @@ class ConfigPathResolver {
|
|
|
10
10
|
return (0, path_1.resolve)(ConfigPathResolver.getBaseDirname(), `config`, `${ConfigStore.getConfig("NODE_ENV", "development")}`);
|
|
11
11
|
}
|
|
12
12
|
static getBaseDirname() {
|
|
13
|
-
const envVar = ConfigStore.getConfig("
|
|
13
|
+
const envVar = ConfigStore.getConfig("APP_BASE_DIRNAME");
|
|
14
14
|
if (envVar) {
|
|
15
15
|
return envVar;
|
|
16
16
|
}
|
|
@@ -23,47 +23,57 @@ class ConfigPathResolver {
|
|
|
23
23
|
}
|
|
24
24
|
}
|
|
25
25
|
exports.ConfigPathResolver = ConfigPathResolver;
|
|
26
|
-
const memoryProvider = {};
|
|
27
26
|
const processEnvDefined = (typeof process !== "undefined" && typeof process.env !== "undefined");
|
|
28
27
|
class ConfigStore {
|
|
29
|
-
static putConfig(key, value
|
|
30
|
-
if (processEnvDefined
|
|
28
|
+
static putConfig(key, value) {
|
|
29
|
+
if (processEnvDefined) {
|
|
31
30
|
Object.defineProperty(process.env, key, {
|
|
32
31
|
value
|
|
33
32
|
}); // this is for webpack
|
|
34
33
|
}
|
|
35
34
|
else {
|
|
36
|
-
|
|
37
|
-
|
|
35
|
+
/* eslint-disable @typescript-eslint/ban-ts-comment */
|
|
36
|
+
// @ts-ignore
|
|
37
|
+
localStorage.setItem(key, value);
|
|
38
38
|
}
|
|
39
39
|
return this;
|
|
40
40
|
}
|
|
41
|
-
static clear(key
|
|
42
|
-
if (processEnvDefined
|
|
41
|
+
static clear(key) {
|
|
42
|
+
if (processEnvDefined) {
|
|
43
43
|
delete process.env[key];
|
|
44
44
|
}
|
|
45
45
|
else {
|
|
46
|
-
|
|
47
|
-
|
|
46
|
+
/* eslint-disable @typescript-eslint/ban-ts-comment */
|
|
47
|
+
// @ts-ignore
|
|
48
|
+
localStorage.removeItem(key);
|
|
48
49
|
}
|
|
49
50
|
return this;
|
|
50
51
|
}
|
|
51
|
-
static keys(
|
|
52
|
-
if (processEnvDefined
|
|
52
|
+
static keys() {
|
|
53
|
+
if (processEnvDefined) {
|
|
53
54
|
return Object.keys(process.env);
|
|
54
55
|
}
|
|
55
56
|
else {
|
|
56
|
-
|
|
57
|
-
|
|
57
|
+
const keys = [];
|
|
58
|
+
/* eslint-disable @typescript-eslint/ban-ts-comment */
|
|
59
|
+
// @ts-ignore
|
|
60
|
+
for (let i = 0; i < localStorage.length; i++) {
|
|
61
|
+
/* eslint-disable @typescript-eslint/ban-ts-comment */
|
|
62
|
+
// @ts-ignore
|
|
63
|
+
const key = localStorage.key(i);
|
|
64
|
+
keys.push(key);
|
|
65
|
+
}
|
|
66
|
+
return keys;
|
|
58
67
|
}
|
|
59
68
|
}
|
|
60
|
-
static getConfig(key, defaultValue
|
|
61
|
-
if (processEnvDefined
|
|
69
|
+
static getConfig(key, defaultValue) {
|
|
70
|
+
if (processEnvDefined) {
|
|
62
71
|
return process.env[key] !== undefined ? process.env[key] : (defaultValue !== undefined ? defaultValue : null);
|
|
63
72
|
}
|
|
64
73
|
else {
|
|
65
|
-
|
|
66
|
-
|
|
74
|
+
/* eslint-disable @typescript-eslint/ban-ts-comment */
|
|
75
|
+
// @ts-ignore
|
|
76
|
+
return localStorage.getItem(key) ? localStorage.getItem(key) : (defaultValue !== undefined ? defaultValue : null);
|
|
67
77
|
}
|
|
68
78
|
}
|
|
69
79
|
}
|
|
@@ -73,18 +83,11 @@ const checkEnvVariables = (requiredEnvVariables, defaults) => {
|
|
|
73
83
|
throw new Error(`defaults cannot be a different length of requiredEnvVariables`);
|
|
74
84
|
}
|
|
75
85
|
return requiredEnvVariables.map((envName, index) => {
|
|
76
|
-
|
|
86
|
+
const value = ConfigStore.getConfig(envName, defaults && defaults[index] ? defaults && defaults[index] : undefined);
|
|
87
|
+
if (!value) {
|
|
77
88
|
throw new Error(`Env variable [${envName}!] not defined.`);
|
|
78
89
|
}
|
|
79
|
-
|
|
80
|
-
return defaults[index];
|
|
81
|
-
}
|
|
82
|
-
else if (!processEnvDefined) {
|
|
83
|
-
throw new Error(`Env variable [${envName}!] not defined.`);
|
|
84
|
-
}
|
|
85
|
-
else {
|
|
86
|
-
return process.env[envName];
|
|
87
|
-
}
|
|
90
|
+
return value;
|
|
88
91
|
});
|
|
89
92
|
};
|
|
90
93
|
exports.checkEnvVariables = checkEnvVariables;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/common/config/config.ts"],"names":[],"mappings":";;;AAAA,+BAA6B;AAI7B,MAAsB,kBAAkB;IAE/B,MAAM,CAAC,sBAAsB;QAClC,OAAO,IAAA,cAAO,EAAC,kBAAkB,CAAC,cAAc,EAAE,EAAE,cAAc,CAAC,CAAC;IACtE,CAAC;IAEM,MAAM,CAAC,gBAAgB;QAC5B,OAAO,IAAA,cAAO,EAAC,kBAAkB,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;IACvH,CAAC;IAEM,MAAM,CAAC,cAAc;QAC1B,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACzD,IAAI,MAAM,EAAE;YACV,OAAO,MAAM,CAAC;SACf;aAAM,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE;YACzC,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC;SACtB;aAAM;YACL,OAAO,EAAE,CAAC;SACX;IACH,CAAC;CACF;AApBD,gDAoBC;AAOD,MAAM,iBAAiB,GAAG,CAAC,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,WAAW,CAAC,CAAC;AAEjG,MAAsB,WAAW;IAExB,MAAM,CAAC,SAAS,CAAC,GAAW,EAAE,KAAa;QAChD,IAAI,iBAAiB,EAAE;YACrB,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE;gBACtC,KAAK;aACN,CAAC,CAAC,CAAC,sBAAsB;SAC3B;aAAM;YACL,uDAAuD;YACvD,aAAa;YACb,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SAClC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,GAAW;QAC7B,IAAI,iBAAiB,EAAE;YACrB,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACzB;aAAM;YACL,uDAAuD;YACvD,aAAa;YACb,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM,CAAC,IAAI;QAChB,IAAI,iBAAiB,EAAE;YACrB,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;SACjC;aAAM;YACL,MAAM,IAAI,GAAa,EAAE,CAAC;YAC1B,uDAAuD;YACvD,aAAa;YACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC5C,uDAAuD;gBACvD,aAAa;gBACb,MAAM,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAW,CAAC;gBAC1C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAChB;YACD,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,GAAW,EAAE,YAAqB;QACxD,IAAI,iBAAiB,EAAE;YACrB,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAW,CAAC,CAAC,CAAC,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACzH;aAAM;YACL,uDAAuD;YACvD,aAAa;YACb,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACnH;IACH,CAAC;CACF;AApDD,kCAoDC;AAEM,MAAM,iBAAiB,GAAG,CAAC,oBAA8B,EAAE,QAAmB,EAAY,EAAE;IACjG,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,oBAAoB,CAAC,MAAM,EAAE;QAC/D,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;KAClF;IACD,OAAO,oBAAoB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;QACjD,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,KAAK,CAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC9H,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,OAAO,iBAAiB,CAAC,CAAC;SAC5D;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAXW,QAAA,iBAAiB,qBAW5B"}
|
|
File without changes
|
|
File without changes
|