@miqro/core 1.6.1 → 1.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +101 -41
- package/dist/api-router.d.ts +1 -1
- package/dist/api-router.js +0 -1
- package/dist/app-utils.js +0 -1
- package/dist/app.js +2 -3
- package/dist/common/api-router-utils.d.ts +1 -1
- package/dist/common/api-router-utils.js +6 -22
- package/dist/common/api-router.d.ts +3 -16
- package/dist/common/api-router.js +0 -1
- package/dist/common/config/config.js +0 -1
- package/dist/common/config/featuretoggle.js +0 -1
- package/dist/common/config/index.js +0 -1
- package/dist/common/config/loader.js +0 -1
- package/dist/common/context.d.ts +1 -1
- package/dist/common/context.js +0 -1
- package/dist/common/error/badrequesterror.js +0 -1
- package/dist/common/error/configfilenotfound.js +0 -1
- package/dist/common/error/forbiddenerror.js +0 -1
- package/dist/common/error/index.js +0 -1
- package/dist/common/error/notfound.js +0 -1
- package/dist/common/error/notimplemented.js +0 -1
- package/dist/common/error/unauthorizederror.js +0 -1
- package/dist/common/helpers.js +0 -1
- package/dist/common/index.js +0 -1
- package/dist/common/logger/constants.d.ts +13 -0
- package/dist/common/logger/constants.js +25 -0
- package/dist/common/logger/factory.d.ts +2 -4
- package/dist/common/logger/factory.js +7 -4
- package/dist/common/logger/index.d.ts +5 -5
- package/dist/common/logger/index.js +5 -5
- package/dist/common/logger/{transport.d.ts → interfaces.d.ts} +6 -3
- package/dist/common/logger/interfaces.js +2 -0
- package/dist/common/logger/logger.d.ts +15 -7
- package/dist/common/logger/logger.js +35 -28
- package/dist/common/logger/transport/console.d.ts +5 -0
- package/dist/common/logger/transport/console.js +38 -0
- package/dist/common/logger/transport/file.d.ts +2 -0
- package/dist/common/logger/transport/file.js +28 -0
- package/dist/common/router-handler.js +0 -1
- package/dist/common/router-helpers.d.ts +1 -1
- package/dist/common/router-helpers.js +3 -4
- package/dist/common/router-utils.js +0 -1
- package/dist/common/session/common.js +0 -1
- package/dist/common/session/index.js +0 -1
- package/dist/common/session/service.js +0 -1
- package/dist/common/tokenize-match.js +0 -1
- package/dist/index.js +0 -1
- package/dist/middleware/buffer.js +0 -1
- package/dist/middleware/cookie.js +0 -1
- package/dist/middleware/cors.js +0 -1
- package/dist/middleware/form.js +0 -1
- package/dist/middleware/group.js +0 -1
- package/dist/middleware/index.js +0 -1
- package/dist/middleware/json.js +0 -1
- package/dist/middleware/logger.js +0 -1
- package/dist/middleware/parse.js +0 -1
- package/dist/middleware/result.js +0 -1
- package/dist/middleware/session.js +0 -1
- package/dist/middleware/tag.js +0 -1
- package/dist/middleware/text.js +0 -1
- package/dist/proxy.js +0 -1
- package/dist/router.d.ts +1 -1
- package/dist/router.js +2 -3
- package/dist/static.js +0 -1
- package/package.json +8 -10
- package/dist/api-router.js.map +0 -1
- package/dist/app-utils.js.map +0 -1
- package/dist/app.js.map +0 -1
- package/dist/common/api-router-utils.js.map +0 -1
- package/dist/common/api-router.js.map +0 -1
- package/dist/common/config/config.js.map +0 -1
- package/dist/common/config/featuretoggle.js.map +0 -1
- package/dist/common/config/index.js.map +0 -1
- package/dist/common/config/loader.js.map +0 -1
- package/dist/common/context.js.map +0 -1
- package/dist/common/error/badrequesterror.js.map +0 -1
- package/dist/common/error/configfilenotfound.js.map +0 -1
- package/dist/common/error/forbiddenerror.js.map +0 -1
- package/dist/common/error/index.js.map +0 -1
- package/dist/common/error/notfound.js.map +0 -1
- package/dist/common/error/notimplemented.js.map +0 -1
- package/dist/common/error/unauthorizederror.js.map +0 -1
- package/dist/common/helpers.js.map +0 -1
- package/dist/common/index.js.map +0 -1
- package/dist/common/logger/common.d.ts +0 -4
- package/dist/common/logger/common.js +0 -7
- package/dist/common/logger/common.js.map +0 -1
- package/dist/common/logger/factory.js.map +0 -1
- package/dist/common/logger/formatter.d.ts +0 -7
- package/dist/common/logger/formatter.js +0 -9
- package/dist/common/logger/formatter.js.map +0 -1
- package/dist/common/logger/index.js.map +0 -1
- package/dist/common/logger/logger.js.map +0 -1
- package/dist/common/logger/transport.js +0 -59
- package/dist/common/logger/transport.js.map +0 -1
- package/dist/common/router-handler.js.map +0 -1
- package/dist/common/router-helpers.js.map +0 -1
- package/dist/common/router-utils.js.map +0 -1
- package/dist/common/session/common.js.map +0 -1
- package/dist/common/session/index.js.map +0 -1
- package/dist/common/session/service.js.map +0 -1
- package/dist/common/tokenize-match.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/middleware/buffer.js.map +0 -1
- package/dist/middleware/cookie.js.map +0 -1
- package/dist/middleware/cors.js.map +0 -1
- package/dist/middleware/form.js.map +0 -1
- package/dist/middleware/group.js.map +0 -1
- package/dist/middleware/index.js.map +0 -1
- package/dist/middleware/json.js.map +0 -1
- package/dist/middleware/logger.js.map +0 -1
- package/dist/middleware/parse.js.map +0 -1
- package/dist/middleware/result.js.map +0 -1
- package/dist/middleware/session.js.map +0 -1
- package/dist/middleware/tag.js.map +0 -1
- package/dist/middleware/text.js.map +0 -1
- package/dist/proxy.js.map +0 -1
- package/dist/router.js.map +0 -1
- package/dist/static.js.map +0 -1
- package/src/api-router.ts +0 -60
- package/src/api-router.unit.test.js +0 -273
- package/src/app-utils.ts +0 -82
- package/src/app-utils.unit.test.js +0 -100
- package/src/app.ts +0 -51
- package/src/app.unit.test.js +0 -334
- package/src/common/api-router-utils.ts +0 -209
- package/src/common/api-router.ts +0 -32
- package/src/common/config/config.ts +0 -111
- package/src/common/config/featuretoggle.ts +0 -6
- package/src/common/config/index.ts +0 -3
- package/src/common/config/loader.ts +0 -80
- package/src/common/context.ts +0 -167
- package/src/common/context.unit.test.js +0 -288
- package/src/common/error/badrequesterror.ts +0 -6
- package/src/common/error/configfilenotfound.ts +0 -6
- package/src/common/error/forbiddenerror.ts +0 -6
- package/src/common/error/index.ts +0 -6
- package/src/common/error/notfound.ts +0 -6
- package/src/common/error/notimplemented.ts +0 -6
- package/src/common/error/unauthorizederror.ts +0 -6
- package/src/common/helpers.ts +0 -11
- package/src/common/index.ts +0 -7
- package/src/common/logger/common.ts +0 -6
- package/src/common/logger/factory.ts +0 -51
- package/src/common/logger/formatter.ts +0 -9
- package/src/common/logger/index.ts +0 -6
- package/src/common/logger/logger.ts +0 -114
- package/src/common/logger/transport.ts +0 -71
- package/src/common/router-handler.ts +0 -159
- package/src/common/router-helpers.ts +0 -20
- package/src/common/router-utils.ts +0 -95
- package/src/common/session/common.ts +0 -40
- package/src/common/session/index.ts +0 -2
- package/src/common/session/service.ts +0 -160
- package/src/common/tokenize-match.ts +0 -130
- package/src/index.ts +0 -7
- package/src/middleware/buffer.ts +0 -80
- package/src/middleware/cookie.ts +0 -20
- package/src/middleware/cors.ts +0 -96
- package/src/middleware/form.ts +0 -59
- package/src/middleware/group.ts +0 -70
- package/src/middleware/index.ts +0 -48
- package/src/middleware/json.ts +0 -55
- package/src/middleware/logger.ts +0 -18
- package/src/middleware/parse.ts +0 -93
- package/src/middleware/result.ts +0 -43
- package/src/middleware/session.ts +0 -136
- package/src/middleware/tag.ts +0 -15
- package/src/middleware/text.ts +0 -45
- package/src/proxy.ts +0 -77
- package/src/proxy.unit.test.js +0 -159
- package/src/router.ts +0 -112
- package/src/router.unit.test.js +0 -397
- package/src/setup-test.js +0 -5
- package/src/static.ts +0 -238
package/README.md
CHANGED
|
@@ -1,6 +1,17 @@
|
|
|
1
1
|
# @miqro/core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
promise based router
|
|
4
|
+
|
|
5
|
+
- [router](#router)
|
|
6
|
+
- [request parsing](#request-parsing)
|
|
7
|
+
- [custom types](#custom-types)
|
|
8
|
+
- [static files](#static-files)
|
|
9
|
+
- [proxy router](#proxy-router)
|
|
10
|
+
- [error handling](#error-handling)
|
|
11
|
+
- [apirouter](#apirouter)
|
|
12
|
+
- [auto documentation](#auto-documentation)
|
|
13
|
+
|
|
14
|
+
## router
|
|
4
15
|
|
|
5
16
|
```typescript
|
|
6
17
|
import {createServer} from "http";
|
|
@@ -32,14 +43,9 @@ router.use(async (ctx) => {
|
|
|
32
43
|
});
|
|
33
44
|
|
|
34
45
|
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);
|
|
38
|
-
// or
|
|
39
|
-
// const server = app.listen(8080);
|
|
40
46
|
```
|
|
41
47
|
|
|
42
|
-
|
|
48
|
+
### request parsing
|
|
43
49
|
|
|
44
50
|
for more examples of parsing see [@miqro/parser](https://www.npmjs.com/package/@miqro/parser)
|
|
45
51
|
|
|
@@ -49,8 +55,8 @@ router.get("/add/:a/:b", {
|
|
|
49
55
|
body: false, // do not allow body
|
|
50
56
|
params: {
|
|
51
57
|
options: {
|
|
52
|
-
a: "number", // parse param :a to a number if posible if not throw
|
|
53
|
-
b: "number", // parse param :b to a number if posible if not throw
|
|
58
|
+
a: "number", // parse param :a to a number if posible if not throw
|
|
59
|
+
b: "number", // parse param :b to a number if posible if not throw
|
|
54
60
|
}
|
|
55
61
|
//,mode: "no_extra" // defaults to no_extra
|
|
56
62
|
},
|
|
@@ -66,9 +72,6 @@ router.get("/add/:a/:b", {
|
|
|
66
72
|
}
|
|
67
73
|
}
|
|
68
74
|
},
|
|
69
|
-
response: {
|
|
70
|
-
body: "number|string"
|
|
71
|
-
},
|
|
72
75
|
handler: async (ctx) => {
|
|
73
76
|
// ctx.params.a and ctx.params.b are numbers and not strings
|
|
74
77
|
const result = ctx.params.a + ctx.params.b;
|
|
@@ -92,54 +95,43 @@ router.get("/add/:a/:b", {
|
|
|
92
95
|
});
|
|
93
96
|
```
|
|
94
97
|
|
|
95
|
-
|
|
98
|
+
#### custom types
|
|
96
99
|
|
|
97
100
|
```typescript
|
|
98
101
|
import {Parser} from "@miqro/parser";
|
|
99
102
|
|
|
100
103
|
const parser = new Parser();
|
|
101
|
-
parser.registerType("
|
|
102
|
-
|
|
103
|
-
b: "number", // parse param :b to a number if posible if not throw 400
|
|
104
|
+
parser.registerType("CustomType", {
|
|
105
|
+
//...
|
|
104
106
|
});
|
|
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
107
|
router.get("/add/:a/:b", {
|
|
115
108
|
parser,
|
|
116
|
-
|
|
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
|
-
}
|
|
109
|
+
//...
|
|
127
110
|
});
|
|
128
111
|
```
|
|
129
112
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
## serving static files
|
|
113
|
+
### static files
|
|
133
114
|
|
|
134
115
|
```typescript
|
|
135
116
|
import {Static} from "@miqro/core";
|
|
136
117
|
|
|
137
118
|
router.use(Static({
|
|
138
|
-
directory: resolve(__dirname, "
|
|
119
|
+
directory: resolve(__dirname, "static")
|
|
139
120
|
}), "/content/public");
|
|
140
121
|
```
|
|
141
122
|
|
|
142
|
-
|
|
123
|
+
### proxy router
|
|
124
|
+
|
|
125
|
+
```typescript
|
|
126
|
+
import {Proxy} from "@miqro/core";
|
|
127
|
+
|
|
128
|
+
router.use(Proxy({
|
|
129
|
+
url: "http://otherhost/api/somepath/";
|
|
130
|
+
//rejectUnauthorized: false;
|
|
131
|
+
}), "/proxy/");
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### error handling
|
|
143
135
|
|
|
144
136
|
```typescript
|
|
145
137
|
router.catch(myFallBackerrorHandler1) // this will catch all throws
|
|
@@ -150,3 +142,71 @@ router.use(async (ctx) => {
|
|
|
150
142
|
});
|
|
151
143
|
```
|
|
152
144
|
|
|
145
|
+
## apirouter
|
|
146
|
+
|
|
147
|
+
for loading full directories with the folders acting as path's
|
|
148
|
+
|
|
149
|
+
consider the following directory structure
|
|
150
|
+
|
|
151
|
+
```
|
|
152
|
+
api/
|
|
153
|
+
v1/
|
|
154
|
+
user/
|
|
155
|
+
:userId/
|
|
156
|
+
get.ts
|
|
157
|
+
delete.ts
|
|
158
|
+
patch.ts
|
|
159
|
+
post.ts
|
|
160
|
+
post/
|
|
161
|
+
:postId/
|
|
162
|
+
get.ts
|
|
163
|
+
post.ts
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
this will producte the following routes.
|
|
167
|
+
|
|
168
|
+
- [GET] /api/v1/user/:userId/
|
|
169
|
+
- [DELETE] /api/v1/user/:userId/
|
|
170
|
+
- [PATCH] /api/v1/user/:userId/
|
|
171
|
+
- [POST] /api/v1/user/
|
|
172
|
+
|
|
173
|
+
- [GET] /api/v1/post/
|
|
174
|
+
- [POST] /api/v1/post/:postId/
|
|
175
|
+
|
|
176
|
+
each file has to implement the ```APIRoute``` interface.
|
|
177
|
+
|
|
178
|
+
example
|
|
179
|
+
|
|
180
|
+
```typescript
|
|
181
|
+
import {APIRoute} from "@miqro/core";
|
|
182
|
+
|
|
183
|
+
export default {
|
|
184
|
+
handler: async (ctx) => {
|
|
185
|
+
|
|
186
|
+
}
|
|
187
|
+
} as APIRoute;
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
to load the routes
|
|
191
|
+
|
|
192
|
+
```typescript
|
|
193
|
+
import {APIRouter} from "@miqro/core";
|
|
194
|
+
|
|
195
|
+
const api = APIRouter({ dirname: resolve(__dirname, "api") });
|
|
196
|
+
|
|
197
|
+
app.use(api);
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### auto documentation
|
|
201
|
+
|
|
202
|
+
```typescript
|
|
203
|
+
...
|
|
204
|
+
console.dir(router.getJSONDoc());
|
|
205
|
+
...
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
or generate a markdown
|
|
209
|
+
|
|
210
|
+
```npx miqro doc:md build/api /api API.md```
|
|
211
|
+
|
|
212
|
+
where ```build/api``` is the APIRouter directory
|
package/dist/api-router.d.ts
CHANGED
package/dist/api-router.js
CHANGED
|
@@ -53,4 +53,3 @@ function APIRouter(options, logger) {
|
|
|
53
53
|
return (0, api_router_utils_1.FeatureRouter)((0, api_router_utils_1.traverseAPIRouteDir)(apiName.toUpperCase(), dirname, apiPath, undefined, logger), logger);
|
|
54
54
|
}
|
|
55
55
|
exports.APIRouter = APIRouter;
|
|
56
|
-
//# sourceMappingURL=api-router.js.map
|
package/dist/app-utils.js
CHANGED
package/dist/app.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.App = void 0;
|
|
4
4
|
const http_1 = require("http");
|
|
5
|
-
const
|
|
5
|
+
const crypto_1 = require("crypto");
|
|
6
6
|
const common_1 = require("./common");
|
|
7
7
|
const router_1 = require("./router");
|
|
8
8
|
const app_utils_1 = require("./app-utils");
|
|
@@ -12,7 +12,7 @@ class App extends router_1.Router {
|
|
|
12
12
|
const errorHandler = (0, app_utils_1.defaultAppErrorHandler)();
|
|
13
13
|
const loggerFactory = this.config && this.config.loggerFactory ? this.config.loggerFactory : common_1.defaultLoggerFactory;
|
|
14
14
|
this.listener = async (req, res) => {
|
|
15
|
-
const uuid = (0,
|
|
15
|
+
const uuid = (0, crypto_1.randomUUID)();
|
|
16
16
|
const logger = loggerFactory(uuid, req);
|
|
17
17
|
const ctx = new common_1.Context(uuid, req, res, logger);
|
|
18
18
|
ctx.logger.trace(`request received`);
|
|
@@ -51,4 +51,3 @@ class App extends router_1.Router {
|
|
|
51
51
|
}
|
|
52
52
|
}
|
|
53
53
|
exports.App = App;
|
|
54
|
-
//# sourceMappingURL=app.js.map
|
|
@@ -6,22 +6,12 @@ const path_1 = require("path");
|
|
|
6
6
|
const tokenize_match_1 = require("./tokenize-match");
|
|
7
7
|
const config_1 = require("./config");
|
|
8
8
|
const router_1 = require("../router");
|
|
9
|
+
const router_utils_1 = require("./router-utils");
|
|
9
10
|
const parser_1 = require("@miqro/parser");
|
|
10
11
|
exports.APIRouteValidator = {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
path: "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
|
-
handler: "function[]!",
|
|
22
|
-
middleware: "function[]!?",
|
|
23
|
-
session: "function?|SessionHandlerOptions?",
|
|
24
|
-
policy: "GroupPolicy?"
|
|
12
|
+
...router_utils_1.handlerWithOptionsParseOptions,
|
|
13
|
+
method: "string?|string[]?",
|
|
14
|
+
path: "string?|string[]?"
|
|
25
15
|
};
|
|
26
16
|
function traverseAPIRouteDir(featureName, dirname, basePath = "/", features = {}, logger) {
|
|
27
17
|
if (logger) {
|
|
@@ -93,14 +83,9 @@ function traverseAPIRouteDir(featureName, dirname, basePath = "/", features = {}
|
|
|
93
83
|
middleware: route.middleware,
|
|
94
84
|
session: route.session,
|
|
95
85
|
policy: route.policy,
|
|
96
|
-
request:
|
|
97
|
-
headers: route.headers,
|
|
98
|
-
query: route.query,
|
|
99
|
-
body: route.body,
|
|
100
|
-
params: route.params,
|
|
101
|
-
},
|
|
86
|
+
request: route.request,
|
|
102
87
|
response: {
|
|
103
|
-
body: route.response ? route.response : true
|
|
88
|
+
body: route.response && route.response.body ? route.response.body : true
|
|
104
89
|
}
|
|
105
90
|
},
|
|
106
91
|
path,
|
|
@@ -198,4 +183,3 @@ const FeatureRouter = (options, logger) => {
|
|
|
198
183
|
return router;
|
|
199
184
|
};
|
|
200
185
|
exports.FeatureRouter = FeatureRouter;
|
|
201
|
-
//# sourceMappingURL=api-router-utils.js.map
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { Handler, Method } from "./context";
|
|
1
|
+
import { Method } from "./context";
|
|
2
|
+
import { HandlerWithOptions } from "./router-utils";
|
|
4
3
|
/**
|
|
5
4
|
* # APIRoute
|
|
6
5
|
*
|
|
@@ -13,19 +12,7 @@ import { Handler, Method } from "./context";
|
|
|
13
12
|
*export default route;
|
|
14
13
|
* ```
|
|
15
14
|
*/
|
|
16
|
-
export interface APIRoute {
|
|
17
|
-
name?: string;
|
|
18
|
-
description?: string;
|
|
15
|
+
export interface APIRoute extends HandlerWithOptions {
|
|
19
16
|
method?: Method | Method[];
|
|
20
17
|
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
18
|
}
|
package/dist/common/context.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
2
|
/// <reference types="node" />
|
|
3
3
|
/// <reference types="node" />
|
|
4
|
-
import { Logger } from "./logger";
|
|
4
|
+
import { Logger } from "./logger/index.js";
|
|
5
5
|
import { Session } from "./session";
|
|
6
6
|
import { IncomingHttpHeaders, IncomingMessage, OutgoingHttpHeaders, ServerResponse } from "http";
|
|
7
7
|
import { URL } from "url";
|
package/dist/common/context.js
CHANGED
package/dist/common/helpers.js
CHANGED
package/dist/common/index.js
CHANGED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { LoggerFormatter, LoggerTransport } from "./interfaces.js";
|
|
2
|
+
export declare const DEFAULT_LOGGER_TRANSPORTS: () => LoggerTransport[];
|
|
3
|
+
export declare const DEFAULT_LOGGER_FORMATTER: LoggerFormatter;
|
|
4
|
+
export declare const LOG_LEVEL_MAP: {
|
|
5
|
+
error: number;
|
|
6
|
+
warn: number;
|
|
7
|
+
info: number;
|
|
8
|
+
debug: number;
|
|
9
|
+
trace: number;
|
|
10
|
+
};
|
|
11
|
+
export declare const LoggerEvents: {
|
|
12
|
+
error: string;
|
|
13
|
+
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.LoggerEvents = exports.LOG_LEVEL_MAP = exports.DEFAULT_LOGGER_FORMATTER = exports.DEFAULT_LOGGER_TRANSPORTS = void 0;
|
|
4
|
+
const file_js_1 = require("./transport/file.js");
|
|
5
|
+
const console_js_1 = require("./transport/console.js");
|
|
6
|
+
const DEFAULT_LOGGER_TRANSPORTS = () => [
|
|
7
|
+
(0, console_js_1.Console)(),
|
|
8
|
+
(0, file_js_1.File)()
|
|
9
|
+
];
|
|
10
|
+
exports.DEFAULT_LOGGER_TRANSPORTS = DEFAULT_LOGGER_TRANSPORTS;
|
|
11
|
+
const DEFAULT_LOGGER_FORMATTER = ({ identifier, level, message }) => `${new Date().toISOString()} ${process.pid} ` +
|
|
12
|
+
`${identifier ? `[${identifier}] ` : ""}` +
|
|
13
|
+
`${level !== "info" ? (level === "error" || level === "warn" ? `[${level.toUpperCase()}] ` : `[${level}] `) : ""}` +
|
|
14
|
+
`${message}`;
|
|
15
|
+
exports.DEFAULT_LOGGER_FORMATTER = DEFAULT_LOGGER_FORMATTER;
|
|
16
|
+
exports.LOG_LEVEL_MAP = {
|
|
17
|
+
"error": 1,
|
|
18
|
+
"warn": 2,
|
|
19
|
+
"info": 3,
|
|
20
|
+
"debug": 4,
|
|
21
|
+
"trace": 5,
|
|
22
|
+
};
|
|
23
|
+
exports.LoggerEvents = {
|
|
24
|
+
error: "error"
|
|
25
|
+
};
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { LoggerTransport } from "./transport";
|
|
4
|
-
import { LogLevel } from "./common";
|
|
1
|
+
import { LoggerFormatter, LoggerTransport, LogLevel } from "./interfaces";
|
|
2
|
+
import { Logger } from "./logger.js";
|
|
5
3
|
export declare const getLogger: (identifier: string, options?: {
|
|
6
4
|
formatter?: LoggerFormatter;
|
|
7
5
|
transports?: LoggerTransport[];
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.getLoggerFactory = exports.setLoggerFactory = exports.getLogger = void 0;
|
|
4
|
-
const logger_1 = require("./logger");
|
|
5
4
|
const config_1 = require("../config");
|
|
5
|
+
const logger_js_1 = require("./logger.js");
|
|
6
|
+
const constants_js_1 = require("./constants.js");
|
|
6
7
|
const loggerContainer = new Map();
|
|
7
8
|
const DEFAULT_ENV_NAME = "LOG_LEVEL";
|
|
8
9
|
const getLogger = (identifier, options, useCache = true) => {
|
|
@@ -25,12 +26,15 @@ const getLogger = (identifier, options, useCache = true) => {
|
|
|
25
26
|
};
|
|
26
27
|
exports.getLogger = getLogger;
|
|
27
28
|
const defaultLoggerFactory = ({ identifier, options, level }) => {
|
|
28
|
-
return new
|
|
29
|
+
return new logger_js_1.Logger(identifier, level, {
|
|
30
|
+
formatter: options && options.formatter ? options.formatter : constants_js_1.DEFAULT_LOGGER_FORMATTER,
|
|
31
|
+
transports: options && options.transports ? options.transports : (0, constants_js_1.DEFAULT_LOGGER_TRANSPORTS)()
|
|
32
|
+
});
|
|
29
33
|
};
|
|
30
34
|
let customLoggerFactory = undefined;
|
|
31
35
|
const setLoggerFactory = (factory) => {
|
|
32
36
|
if (customLoggerFactory !== undefined) {
|
|
33
|
-
throw new Error("cannot change logger factory
|
|
37
|
+
throw new Error("cannot change logger factory after it has been used.");
|
|
34
38
|
}
|
|
35
39
|
customLoggerFactory = factory;
|
|
36
40
|
return customLoggerFactory;
|
|
@@ -46,4 +50,3 @@ const getLoggerFactory = () => {
|
|
|
46
50
|
}
|
|
47
51
|
};
|
|
48
52
|
exports.getLoggerFactory = getLoggerFactory;
|
|
49
|
-
//# sourceMappingURL=factory.js.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export
|
|
2
|
-
export * from "./
|
|
3
|
-
export * from "./
|
|
4
|
-
export * from "./
|
|
5
|
-
export * from "./transport";
|
|
1
|
+
export * from "./constants.js";
|
|
2
|
+
export * from "./logger.js";
|
|
3
|
+
export * from "./factory.js";
|
|
4
|
+
export * from "./interfaces.js";
|
|
5
|
+
export * from "./transport/console.js";
|
|
@@ -14,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./
|
|
18
|
-
__exportStar(require("./
|
|
19
|
-
__exportStar(require("./
|
|
20
|
-
__exportStar(require("./
|
|
21
|
-
|
|
17
|
+
__exportStar(require("./constants.js"), exports);
|
|
18
|
+
__exportStar(require("./logger.js"), exports);
|
|
19
|
+
__exportStar(require("./factory.js"), exports);
|
|
20
|
+
__exportStar(require("./interfaces.js"), exports);
|
|
21
|
+
__exportStar(require("./transport/console.js"), exports);
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
export declare type LogLevel = "error" | "warn" | "info" | "debug" | "trace";
|
|
2
2
|
export interface WriteArgs {
|
|
3
3
|
level: LogLevel;
|
|
4
4
|
message?: any;
|
|
@@ -11,5 +11,8 @@ export interface LoggerTransport {
|
|
|
11
11
|
level?: LogLevel;
|
|
12
12
|
write(args: LoggerTransportWriteArgs): Promise<void> | void;
|
|
13
13
|
}
|
|
14
|
-
export declare
|
|
15
|
-
|
|
14
|
+
export declare type LoggerFormatter = (args: {
|
|
15
|
+
identifier: string;
|
|
16
|
+
level: LogLevel;
|
|
17
|
+
message: string;
|
|
18
|
+
}) => string;
|
|
@@ -1,8 +1,13 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
import { LoggerFormatter, LoggerTransport, LogLevel, WriteArgs } from "./interfaces.js";
|
|
2
|
+
export interface LoggerErrorEventInit {
|
|
3
|
+
error: any;
|
|
4
|
+
}
|
|
5
|
+
declare var Event: any;
|
|
6
|
+
declare var EventTarget: any;
|
|
7
|
+
export declare class LoggerErrorEvent extends Event {
|
|
8
|
+
error: any;
|
|
9
|
+
constructor(event: string, init: LoggerErrorEventInit);
|
|
10
|
+
}
|
|
6
11
|
export interface Logger {
|
|
7
12
|
log(message?: any, ...optionalParams: any[]): void;
|
|
8
13
|
info(message?: any, ...optionalParams: any[]): void;
|
|
@@ -10,10 +15,12 @@ export interface Logger {
|
|
|
10
15
|
debug(message?: any, ...optionalParams: any[]): void;
|
|
11
16
|
warn(message?: any, ...optionalParams: any[]): void;
|
|
12
17
|
error(message?: any, ...optionalParams: any[]): void;
|
|
18
|
+
addTransport(transport: LoggerTransport): void;
|
|
19
|
+
setLevel(level: LogLevel): void;
|
|
13
20
|
}
|
|
14
|
-
export declare class Logger extends
|
|
21
|
+
export declare class Logger extends EventTarget implements Logger {
|
|
15
22
|
protected readonly identifier: string;
|
|
16
|
-
protected
|
|
23
|
+
protected level: LogLevel;
|
|
17
24
|
protected readonly options: {
|
|
18
25
|
transports: LoggerTransport[];
|
|
19
26
|
formatter: LoggerFormatter;
|
|
@@ -24,3 +31,4 @@ export declare class Logger extends EventEmitter implements Logger {
|
|
|
24
31
|
});
|
|
25
32
|
protected write(args: WriteArgs): void;
|
|
26
33
|
}
|
|
34
|
+
export {};
|