nightingale-web-processor 15.0.0 → 16.0.0
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/CHANGELOG.md +13 -0
- package/README.md +11 -11
- package/dist/definitions/index.d.ts +2 -3
- package/dist/definitions/index.d.ts.map +1 -1
- package/dist/{index-node18.mjs → index-node20.mjs} +2 -2
- package/dist/index-node20.mjs.map +1 -0
- package/package.json +18 -17
- package/src/index.ts +3 -4
- package/dist/index-node18.mjs.map +0 -1
- package/src/.eslintrc.json +0 -30
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,19 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [16.0.0](https://github.com/christophehurpeau/nightingale/compare/v15.0.0...v16.0.0) (2025-03-30)
|
|
7
|
+
|
|
8
|
+
### ⚠ BREAKING CHANGES
|
|
9
|
+
|
|
10
|
+
* drop node 18
|
|
11
|
+
|
|
12
|
+
### Features
|
|
13
|
+
|
|
14
|
+
* drop node 18 ([1b11a55](https://github.com/christophehurpeau/nightingale/commit/1b11a55dd24c9435be50519a748316079f554414))
|
|
15
|
+
|
|
16
|
+
Version bump for dependency: nightingale-types
|
|
17
|
+
|
|
18
|
+
|
|
6
19
|
## [15.0.0](https://github.com/christophehurpeau/nightingale/compare/v14.2.1...v15.0.0) (2023-12-25)
|
|
7
20
|
|
|
8
21
|
|
package/README.md
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
<
|
|
1
|
+
<h1 align="center">
|
|
2
2
|
nightingale-web-processor
|
|
3
|
-
</
|
|
3
|
+
</h1>
|
|
4
4
|
|
|
5
5
|
<p align="center">
|
|
6
6
|
Nightingale web processor
|
|
7
7
|
</p>
|
|
8
8
|
|
|
9
9
|
<p align="center">
|
|
10
|
-
<a href="https://npmjs.org/package/nightingale-web-processor"><img src="https://img.shields.io/npm/v/nightingale-web-processor.svg?style=flat-square"></a>
|
|
11
|
-
<a href="https://npmjs.org/package/nightingale-web-processor"><img src="https://img.shields.io/npm/dw/nightingale-web-processor.svg?style=flat-square"></a>
|
|
12
|
-
<a href="https://npmjs.org/package/nightingale-web-processor"><img src="https://img.shields.io/node/v/nightingale-web-processor.svg?style=flat-square"></a>
|
|
13
|
-
<a href="https://npmjs.org/package/nightingale-web-processor"><img src="https://img.shields.io/npm/types/nightingale-web-processor.svg?style=flat-square"></a>
|
|
10
|
+
<a href="https://npmjs.org/package/nightingale-web-processor"><img src="https://img.shields.io/npm/v/nightingale-web-processor.svg?style=flat-square" alt="npm version"></a>
|
|
11
|
+
<a href="https://npmjs.org/package/nightingale-web-processor"><img src="https://img.shields.io/npm/dw/nightingale-web-processor.svg?style=flat-square" alt="npm downloads"></a>
|
|
12
|
+
<a href="https://npmjs.org/package/nightingale-web-processor"><img src="https://img.shields.io/node/v/nightingale-web-processor.svg?style=flat-square" alt="node version"></a>
|
|
13
|
+
<a href="https://npmjs.org/package/nightingale-web-processor"><img src="https://img.shields.io/npm/types/nightingale-web-processor.svg?style=flat-square" alt="types"></a>
|
|
14
14
|
</p>
|
|
15
15
|
|
|
16
16
|
## Install
|
|
@@ -22,12 +22,12 @@ npm install --save nightingale-web-processor
|
|
|
22
22
|
## Usage
|
|
23
23
|
|
|
24
24
|
```js
|
|
25
|
-
import Koa from
|
|
26
|
-
import webProcessor from
|
|
25
|
+
import Koa from "koa";
|
|
26
|
+
import webProcessor from "nightingale-web-processor";
|
|
27
27
|
|
|
28
28
|
configure([
|
|
29
29
|
{
|
|
30
|
-
key:
|
|
30
|
+
key: "app",
|
|
31
31
|
handlers: [new ConsoleHandler(Level.ALL)],
|
|
32
32
|
processors: [webProcessor],
|
|
33
33
|
},
|
|
@@ -41,7 +41,7 @@ app.use((ctx, next) => {
|
|
|
41
41
|
});
|
|
42
42
|
|
|
43
43
|
app.use(async (ctx) => {
|
|
44
|
-
ctx.logger.info(
|
|
45
|
-
ctx.body =
|
|
44
|
+
ctx.logger.info("got request !");
|
|
45
|
+
ctx.body = "ok";
|
|
46
46
|
});
|
|
47
47
|
```
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
import type {
|
|
3
|
-
import type { LogRecord, Metadata } from 'nightingale-types';
|
|
1
|
+
import type { IncomingMessage } from "node:http";
|
|
2
|
+
import type { LogRecord, Metadata } from "nightingale-types";
|
|
4
3
|
export interface ContextWithOptionalRequest {
|
|
5
4
|
request?: IncomingMessage;
|
|
6
5
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7D,MAAM,WAAW,0BAA0B;IACzC,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAC,SAAS,QAAQ,EACrD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EACpB,OAAO,CAAC,EAAE,0BAA0B,GACnC,IAAI,CAWN"}
|
|
@@ -6,10 +6,10 @@ function webProcessor(record, context) {
|
|
|
6
6
|
url: request.url,
|
|
7
7
|
method: request.method,
|
|
8
8
|
server: request.headers.host,
|
|
9
|
-
ip: request.headers[
|
|
9
|
+
ip: request.headers["x-forwarded-for"] || request.socket.remoteAddress
|
|
10
10
|
});
|
|
11
11
|
}
|
|
12
12
|
}
|
|
13
13
|
|
|
14
14
|
export { webProcessor as default };
|
|
15
|
-
//# sourceMappingURL=index-
|
|
15
|
+
//# sourceMappingURL=index-node20.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index-node20.mjs","sources":["../src/index.ts"],"sourcesContent":["import type { IncomingMessage } from \"node:http\";\nimport type { LogRecord, Metadata } from \"nightingale-types\";\n\nexport interface ContextWithOptionalRequest {\n request?: IncomingMessage;\n}\n\nexport default function webProcessor<T extends Metadata>(\n record: LogRecord<T>,\n context?: ContextWithOptionalRequest,\n): void {\n const request = context?.request;\n if (request) {\n record.extra = record.extra || {};\n Object.assign(record.extra, {\n url: request.url,\n method: request.method,\n server: request.headers.host,\n ip: request.headers[\"x-forwarded-for\"] || request.socket.remoteAddress,\n });\n }\n}\n"],"names":["webProcessor","record","context","request","extra","Object","assign","url","method","server","headers","host","ip","socket","remoteAddress"],"mappings":"AAOe,SAASA,YAAYA,CAClCC,MAAoB,EACpBC,OAAoC,EAC9B;AACN,EAAA,MAAMC,OAAO,GAAGD,OAAO,EAAEC,OAAO;AAChC,EAAA,IAAIA,OAAO,EAAE;IACXF,MAAM,CAACG,KAAK,GAAGH,MAAM,CAACG,KAAK,IAAI,EAAE;AACjCC,IAAAA,MAAM,CAACC,MAAM,CAACL,MAAM,CAACG,KAAK,EAAE;MAC1BG,GAAG,EAAEJ,OAAO,CAACI,GAAG;MAChBC,MAAM,EAAEL,OAAO,CAACK,MAAM;AACtBC,MAAAA,MAAM,EAAEN,OAAO,CAACO,OAAO,CAACC,IAAI;MAC5BC,EAAE,EAAET,OAAO,CAACO,OAAO,CAAC,iBAAiB,CAAC,IAAIP,OAAO,CAACU,MAAM,CAACC;AAC3D,KAAC,CAAC;AACJ;AACF;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "nightingale-web-processor",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "16.0.0",
|
|
4
4
|
"description": "Nightingale web processor",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"nightingale",
|
|
@@ -16,20 +16,20 @@
|
|
|
16
16
|
"homepage": "https://github.com/christophehurpeau/nightingale",
|
|
17
17
|
"type": "module",
|
|
18
18
|
"engines": {
|
|
19
|
-
"node": ">=
|
|
19
|
+
"node": ">=20.9.0"
|
|
20
20
|
},
|
|
21
|
-
"
|
|
21
|
+
"sideEffects": false,
|
|
22
|
+
"main": "./dist/index-node20.mjs",
|
|
22
23
|
"types": "./dist/definitions/index.d.ts",
|
|
23
24
|
"exports": {
|
|
24
25
|
"./package.json": "./package.json",
|
|
25
26
|
".": {
|
|
26
27
|
"types": "./dist/definitions/index.d.ts",
|
|
27
28
|
"node": {
|
|
28
|
-
"import": "./dist/index-
|
|
29
|
+
"import": "./dist/index-node20.mjs"
|
|
29
30
|
}
|
|
30
31
|
}
|
|
31
32
|
},
|
|
32
|
-
"sideEffects": false,
|
|
33
33
|
"files": [
|
|
34
34
|
"src",
|
|
35
35
|
"dist"
|
|
@@ -40,28 +40,29 @@
|
|
|
40
40
|
"clean": "yarn clean:build",
|
|
41
41
|
"clean:build": "pob-babel-clean-out dist",
|
|
42
42
|
"lint": "yarn run lint:eslint",
|
|
43
|
-
"lint:eslint": "yarn ../.. run eslint --
|
|
43
|
+
"lint:eslint": "yarn ../.. run eslint --quiet packages/nightingale-web-processor",
|
|
44
44
|
"watch": "yarn clean:build && rollup --config rollup.config.mjs --watch"
|
|
45
45
|
},
|
|
46
|
-
"prettier": "@pob/root/prettier-config",
|
|
47
46
|
"pob": {
|
|
48
|
-
"
|
|
47
|
+
"bundler": "rollup-babel",
|
|
48
|
+
"entries": [
|
|
49
|
+
"index"
|
|
50
|
+
],
|
|
51
|
+
"envs": [
|
|
49
52
|
{
|
|
50
53
|
"target": "node",
|
|
51
|
-
"version": "
|
|
54
|
+
"version": "20"
|
|
52
55
|
}
|
|
53
|
-
],
|
|
54
|
-
"entries": [
|
|
55
|
-
"index"
|
|
56
56
|
]
|
|
57
57
|
},
|
|
58
|
+
"prettier": "@pob/root/prettier-config",
|
|
58
59
|
"dependencies": {
|
|
59
|
-
"@types/node": ">=
|
|
60
|
-
"nightingale-types": "
|
|
60
|
+
"@types/node": ">=20.0.0",
|
|
61
|
+
"nightingale-types": "16.0.0"
|
|
61
62
|
},
|
|
62
63
|
"devDependencies": {
|
|
63
|
-
"@babel/core": "7.
|
|
64
|
-
"pob-babel": "
|
|
65
|
-
"typescript": "5.
|
|
64
|
+
"@babel/core": "7.26.10",
|
|
65
|
+
"pob-babel": "43.4.0",
|
|
66
|
+
"typescript": "5.8.2"
|
|
66
67
|
}
|
|
67
68
|
}
|
package/src/index.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { IncomingMessage } from
|
|
2
|
-
import type { LogRecord, Metadata } from
|
|
1
|
+
import type { IncomingMessage } from "node:http";
|
|
2
|
+
import type { LogRecord, Metadata } from "nightingale-types";
|
|
3
3
|
|
|
4
4
|
export interface ContextWithOptionalRequest {
|
|
5
5
|
request?: IncomingMessage;
|
|
@@ -16,8 +16,7 @@ export default function webProcessor<T extends Metadata>(
|
|
|
16
16
|
url: request.url,
|
|
17
17
|
method: request.method,
|
|
18
18
|
server: request.headers.host,
|
|
19
|
-
ip:
|
|
20
|
-
request.headers['x-forwarded-for'] || request.connection.remoteAddress,
|
|
19
|
+
ip: request.headers["x-forwarded-for"] || request.socket.remoteAddress,
|
|
21
20
|
});
|
|
22
21
|
}
|
|
23
22
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index-node18.mjs","sources":["../src/index.ts"],"sourcesContent":["import type { IncomingMessage } from 'node:http';\nimport type { LogRecord, Metadata } from 'nightingale-types';\n\nexport interface ContextWithOptionalRequest {\n request?: IncomingMessage;\n}\n\nexport default function webProcessor<T extends Metadata>(\n record: LogRecord<T>,\n context?: ContextWithOptionalRequest,\n): void {\n const request = context?.request;\n if (request) {\n record.extra = record.extra || {};\n Object.assign(record.extra, {\n url: request.url,\n method: request.method,\n server: request.headers.host,\n ip:\n request.headers['x-forwarded-for'] || request.connection.remoteAddress,\n });\n }\n}\n"],"names":["webProcessor","record","context","request","extra","Object","assign","url","method","server","headers","host","ip","connection","remoteAddress"],"mappings":"AAOe,SAASA,YAAYA,CAClCC,MAAoB,EACpBC,OAAoC,EAC9B;AACN,EAAA,MAAMC,OAAO,GAAGD,OAAO,EAAEC,OAAO,CAAA;AAChC,EAAA,IAAIA,OAAO,EAAE;IACXF,MAAM,CAACG,KAAK,GAAGH,MAAM,CAACG,KAAK,IAAI,EAAE,CAAA;AACjCC,IAAAA,MAAM,CAACC,MAAM,CAACL,MAAM,CAACG,KAAK,EAAE;MAC1BG,GAAG,EAAEJ,OAAO,CAACI,GAAG;MAChBC,MAAM,EAAEL,OAAO,CAACK,MAAM;AACtBC,MAAAA,MAAM,EAAEN,OAAO,CAACO,OAAO,CAACC,IAAI;MAC5BC,EAAE,EACAT,OAAO,CAACO,OAAO,CAAC,iBAAiB,CAAC,IAAIP,OAAO,CAACU,UAAU,CAACC,aAAAA;AAC7D,KAAC,CAAC,CAAA;AACJ,GAAA;AACF;;;;"}
|
package/src/.eslintrc.json
DELETED
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"root": true,
|
|
3
|
-
"parser": "@typescript-eslint/parser",
|
|
4
|
-
"parserOptions": {
|
|
5
|
-
"project": "packages/nightingale-web-processor/tsconfig.json"
|
|
6
|
-
},
|
|
7
|
-
"plugins": ["@typescript-eslint"],
|
|
8
|
-
"extends": [
|
|
9
|
-
"@pob/eslint-config-typescript",
|
|
10
|
-
"@pob/eslint-config-typescript/node"
|
|
11
|
-
],
|
|
12
|
-
"ignorePatterns": ["*.d.ts"],
|
|
13
|
-
"overrides": [
|
|
14
|
-
{
|
|
15
|
-
"files": ["**/*.test.ts", "__tests__/**/*.ts"],
|
|
16
|
-
"extends": ["@pob/eslint-config-typescript/test"],
|
|
17
|
-
"env": {
|
|
18
|
-
"jest": true
|
|
19
|
-
},
|
|
20
|
-
"rules": {
|
|
21
|
-
"import/no-extraneous-dependencies": [
|
|
22
|
-
"error",
|
|
23
|
-
{
|
|
24
|
-
"devDependencies": true
|
|
25
|
-
}
|
|
26
|
-
]
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
]
|
|
30
|
-
}
|