@nestjs-labs/nestjs-pino-extra 1.0.1 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs-labs/nestjs-pino-extra",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Enhanced nestjs-pino with OpenTelemetry, Loki, file rotation and enterprise features",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -9,20 +9,16 @@
     ".": {
       "import": "./dist/index.js",
       "require": "./dist/index.js"
+    },
+    "./module-option": {
+      "import": "./dist/module-option.js",
+      "require": "./dist/module-option.js"
     }
   },
-  "scripts": {
-    "build": "tsc",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix && prettier --write .",
-    "format": "prettier --write .",
-    "dry-run": "npm publish --dry-run",
-    "prepublishOnly": "npm run build",
-    "semantic-release": "semantic-release"
-  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/nestjs-labs/nestjs-pino-extra.git"
+    "url": "git+https://github.com/nestjs-labs/nestjs-pino-extra.git",
+    "directory": "packages/nestjs-pino-extra"
   },
   "keywords": [
     "nestjs",
@@ -37,27 +33,18 @@
   "bugs": {
     "url": "https://github.com/nestjs-labs/nestjs-pino-extra/issues"
   },
-  "homepage": "https://github.com/nestjs-labs/nestjs-pino-extra#readme",
+  "homepage": "https://nestjs-labs.github.io/nestjs-pino-extra",
+  "docs": "https://nestjs-labs.github.io/nestjs-pino-extra",
   "files": [
     "dist"
   ],
-  "dependencies": {
-    "@opentelemetry/api": "^1.9.0",
-    "nestjs-pino": "^4.4.0",
-    "pino": "^9.7.0",
-    "pino-http": "^10.5.0",
-    "pino-loki": "^2.6.0",
-    "pino-pretty": "^13.0.0",
-    "pino-std-serializers": "^7.0.0",
-    "rotating-file-stream": "^3.2.6"
-  },
   "devDependencies": {
     "@commitlint/cli": "^19.4.1",
     "@commitlint/config-conventional": "^19.4.1",
     "@nestjs-labs/eslint-config": "^1.0.1",
-    "@nestjs/config": "^4.0.2",
+    "@nestjs/config": "^4.0.0",
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^11.0.3",
     "@semantic-release/npm": "^12.0.2",
@@ -67,10 +54,27 @@
     "semantic-release": "^24.2.7",
     "tslib": "^2.8.0",
     "typedoc": "^0.28.7",
-    "typescript": "^5.5.4"
+    "typescript": "^5.5.4",
+    "@nestjs-labs/pino-http-extra": "1.0.2"
   },
   "peerDependencies": {
-    "@nestjs/config": "^4.0.2"
+    "@nestjs/config": "^4.0.0",
+    "nestjs-pino": "^4.4.0",
+    "@nestjs-labs/pino-http-extra": "1.0.2"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/config": {
+      "optional": false,
+      "description": "Required for configuration management"
+    },
+    "@nestjs-labs/pino-http-extra": {
+      "optional": false,
+      "description": "Required for enhanced pino-http functionality"
+    },
+    "nestjs-pino": {
+      "optional": false,
+      "description": "Required for NestJS Pino integration"
+    }
   },
   "config": {
     "commitizen": {
@@ -81,5 +85,16 @@
     "extends": [
       "@commitlint/config-conventional"
     ]
+  },
+  "dependencies": {
+    "@anolilab/semantic-release-pnpm": "^2.0.2"
+  },
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix && prettier --write .",
+    "format": "prettier --write .",
+    "dry-run": "npm publish --dry-run",
+    "semantic-release": "semantic-release"
   }
-}
+}

package/dist/formatters.d.ts

@@ -1,6 +0,0 @@
-export declare function getOtelFormatters(spanIdKey?: string, traceIdKey?: string): {
-    level: (label: string) => {
-        level: string;
-    };
-    log(object: Record<string, unknown>): Record<string, unknown>;
-};

package/dist/formatters.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOtelFormatters = getOtelFormatters;
-const api_1 = require("@opentelemetry/api");
-function getOtelFormatters(spanIdKey = 'spanId', traceIdKey = 'traceId') {
-    return {
-        level: (label) => {
-            return { level: label };
-        },
-        log(object) {
-            const span = api_1.trace.getSpan(api_1.context.active());
-            if (!span)
-                return object;
-            const spanContext = api_1.trace.getSpan(api_1.context.active())?.spanContext();
-            if (!spanContext)
-                return object;
-            const { spanId, traceId } = spanContext;
-            return { ...object, [spanIdKey]: spanId, [traceIdKey]: traceId };
-        },
-    };
-}
-//# sourceMappingURL=formatters.js.map

package/dist/formatters.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatters.js","sourceRoot":"","sources":["../src/formatters.ts"],"names":[],"mappings":";;AAMA,8CAsBC;AA5BD,4CAAoD;AAMpD,SAAgB,iBAAiB,CAC/B,SAAS,GAAG,QAAQ,EACpB,UAAU,GAAG,SAAS;IAEtB,OAAO;QACL,KAAK,EAAE,CAAC,KAAa,EAAE,EAAE;YACvB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QAC1B,CAAC;QAED,GAAG,CAAC,MAA+B;YACjC,MAAM,IAAI,GAAG,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAE7C,IAAI,CAAC,IAAI;gBAAE,OAAO,MAAM,CAAC;YACzB,MAAM,WAAW,GAAG,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC;YAEnE,IAAI,CAAC,WAAW;gBAAE,OAAO,MAAM,CAAC;YAEhC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;YAExC,OAAO,EAAE,GAAG,MAAM,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;QACnE,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/options.d.ts

@@ -1,2 +0,0 @@
-import type { Options } from 'pino-http';
-export declare function getPinoHttpOption(level?: string, spanIdKey?: string, traceIdKey?: string): Options;

package/dist/options.js

@@ -1,54 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPinoHttpOption = getPinoHttpOption;
-const node_crypto_1 = require("node:crypto");
-const pino_1 = __importDefault(require("pino"));
-const formatters_js_1 = require("./formatters.js");
-const serializers_js_1 = require("./serializers.js");
-function getPinoHttpOption(level = 'info', spanIdKey = 'spanId', traceIdKey = 'traceId') {
-    return {
-        level,
-        quietReqLogger: false,
-        timestamp: pino_1.default.stdTimeFunctions.isoTime,
-        customAttributeKeys: {
-            req: 'req',
-            res: 'res',
-            err: 'err',
-            responseTime: 'taken(ms)',
-        },
-        formatters: (0, formatters_js_1.getOtelFormatters)(spanIdKey, traceIdKey),
-        serializers: (0, serializers_js_1.getSerializers)(),
-        redact: {
-            paths: [
-                'password',
-                'reqBody.password',
-                'user.password',
-                'reqBody.user.password',
-            ],
-        },
-        genReqId: function (req, res) {
-            const reqId = req.id ?? req.headers['x-request-id'];
-            if (reqId)
-                return reqId;
-            const id = (0, node_crypto_1.randomUUID)();
-            res.setHeader('X-Request-Id', id);
-            return id;
-        },
-        customLogLevel(_, res, err) {
-            if (res.statusCode >= 400 && res.statusCode < 500) {
-                return 'warn';
-            }
-            else if (res.statusCode >= 500 || err) {
-                return 'error';
-            }
-            else if (res.statusCode >= 300 && res.statusCode < 400) {
-                return 'silent';
-            }
-            return 'info';
-        },
-    };
-}
-//# sourceMappingURL=options.js.map

package/dist/options.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";;;;;AAcA,8CAuDC;AApED,6CAAyC;AAKzC,gDAAwB;AAExB,mDAAoD;AACpD,qDAAkD;AAKlD,SAAgB,iBAAiB,CAC/B,KAAK,GAAG,MAAM,EACd,SAAS,GAAG,QAAQ,EACpB,UAAU,GAAG,SAAS;IAEtB,OAAO;QAIL,KAAK;QACL,cAAc,EAAE,KAAK;QACrB,SAAS,EAAE,cAAI,CAAC,gBAAgB,CAAC,OAAO;QACxC,mBAAmB,EAAE;YACnB,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;YACV,YAAY,EAAE,WAAW;SAC1B;QACD,UAAU,EAAE,IAAA,iCAAiB,EAAC,SAAS,EAAE,UAAU,CAAC;QACpD,WAAW,EAAE,IAAA,+BAAc,GAAE;QAC7B,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,UAAU;gBACV,kBAAkB;gBAClB,eAAe;gBACf,uBAAuB;aACxB;SACF;QACD,QAAQ,EAAE,UAAU,GAAG,EAAE,GAAG;YAC1B,MAAM,KAAK,GAAG,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAEpD,IAAI,KAAK;gBAAE,OAAO,KAAK,CAAC;YACxB,MAAM,EAAE,GAAG,IAAA,wBAAU,GAAE,CAAC;YAExB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YAElC,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,cAAc,CACZ,CAAkB,EAClB,GAAoC,EACpC,GAAW;YAEX,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;gBAClD,OAAO,MAAM,CAAC;YAChB,CAAC;iBAAM,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;gBACxC,OAAO,OAAO,CAAC;YACjB,CAAC;iBAAM,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;gBACzD,OAAO,QAAQ,CAAC;YAClB,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/serializers.d.ts

@@ -1,2 +0,0 @@
-import type { SerializerFn } from 'pino';
-export declare function getSerializers(): Record<string, SerializerFn>;

package/dist/serializers.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSerializers = getSerializers;
-function getSerializers() {
-    return {
-        req(req) {
-            const request = req.raw;
-            return {
-                id: req.id,
-                method: req.method,
-                url: req.url,
-                headers: request.headers,
-                query: request.query,
-                body: request.body,
-            };
-        },
-        res(response) {
-            const { statusCode: status, ...serialized } = response;
-            return Object.assign({ status }, serialized);
-        },
-        err(err) {
-            return err;
-        },
-    };
-}
-//# sourceMappingURL=serializers.js.map

package/dist/serializers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializers.js","sourceRoot":"","sources":["../src/serializers.ts"],"names":[],"mappings":";;AAYA,wCAyBC;AAzBD,SAAgB,cAAc;IAC5B,OAAO;QACL,GAAG,CAAC,GAAsB;YACxB,MAAM,OAAO,GAAG,GAAG,CAAC,GAEnB,CAAC;YAEF,OAAO;gBACL,EAAE,EAAE,GAAG,CAAC,EAAE;gBACV,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,GAAG,EAAE,GAAG,CAAC,GAAG;gBACZ,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB,CAAC;QACJ,CAAC;QACD,GAAG,CAAC,QAA4B;YAC9B,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,QAAQ,CAAC;YAEvD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;QAC/C,CAAC;QACD,GAAG,CAAC,GAAoB;YACtB,OAAO,GAAG,CAAC;QACb,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/streams.d.ts

@@ -1,5 +0,0 @@
-import pino from 'pino';
-export declare function createPrettyStreamEntry(_app: string, level: pino.Level): pino.StreamEntry;
-export declare function createLokiStreamEntry(app: string, level: pino.Level, host: string): pino.StreamEntry;
-export declare function createFileStreamEntry(_app: string, level: pino.Level, filepath: string): pino.StreamEntry;
-export declare function getMultiDestinationStream(app: string, level?: pino.Level, filepath?: string, loki?: string): pino.MultiStreamRes;

package/dist/streams.js

@@ -1,51 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPrettyStreamEntry = createPrettyStreamEntry;
-exports.createLokiStreamEntry = createLokiStreamEntry;
-exports.createFileStreamEntry = createFileStreamEntry;
-exports.getMultiDestinationStream = getMultiDestinationStream;
-const node_path_1 = __importDefault(require("node:path"));
-const pino_1 = __importDefault(require("pino"));
-const pino_loki_1 = require("pino-loki");
-const pino_pretty_1 = __importDefault(require("pino-pretty"));
-const rotating_file_stream_1 = require("rotating-file-stream");
-function createPrettyStreamEntry(_app, level) {
-    const stream = (0, pino_pretty_1.default)({
-        translateTime: false,
-        hideObject: false,
-        colorize: true,
-    });
-    return { level, stream };
-}
-function createLokiStreamEntry(app, level, host) {
-    const stream = (0, pino_loki_1.pinoLoki)({
-        replaceTimestamp: true,
-        batching: true,
-        interval: 5,
-        host,
-        labels: { app },
-    });
-    return { level, stream };
-}
-function createFileStreamEntry(_app, level, filepath) {
-    const { base, dir } = node_path_1.default.parse(filepath);
-    const stream = (0, rotating_file_stream_1.createStream)(base, {
-        size: '1G',
-        interval: '1d',
-        compress: 'gzip',
-        path: dir,
-    });
-    return { level, stream };
-}
-function getMultiDestinationStream(app, level = 'info', filepath, loki) {
-    const entries = [createPrettyStreamEntry(app, level)];
-    if (filepath)
-        entries.push(createFileStreamEntry(app, level, filepath));
-    if (loki)
-        entries.push(createLokiStreamEntry(app, level, loki));
-    return pino_1.default.multistream(entries);
-}
-//# sourceMappingURL=streams.js.map

package/dist/streams.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"streams.js","sourceRoot":"","sources":["../src/streams.ts"],"names":[],"mappings":";;;;;AAWA,0DAWC;AAMD,sDAcC;AAMD,sDAeC;AAMD,8DAYC;AAhFD,0DAA6B;AAE7B,gDAAwB;AACxB,yCAAqC;AACrC,8DAAqC;AACrC,+DAAoD;AAKpD,SAAgB,uBAAuB,CACrC,IAAY,EACZ,KAAiB;IAEjB,MAAM,MAAM,GAAG,IAAA,qBAAU,EAAC;QACxB,aAAa,EAAE,KAAK;QACpB,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;IAEH,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC;AAMD,SAAgB,qBAAqB,CACnC,GAAW,EACX,KAAiB,EACjB,IAAY;IAEZ,MAAM,MAAM,GAAG,IAAA,oBAAQ,EAAC;QACtB,gBAAgB,EAAE,IAAI;QACtB,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,CAAC;QACX,IAAI;QACJ,MAAM,EAAE,EAAE,GAAG,EAAE;KAChB,CAAC,CAAC;IAEH,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC;AAMD,SAAgB,qBAAqB,CACnC,IAAY,EACZ,KAAiB,EACjB,QAAgB;IAEhB,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,mBAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE3C,MAAM,MAAM,GAAG,IAAA,mCAAY,EAAC,IAAI,EAAE;QAChC,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IAEH,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC;AAMD,SAAgB,yBAAyB,CACvC,GAAW,EACX,QAAoB,MAAM,EAC1B,QAAiB,EACjB,IAAa;IAEb,MAAM,OAAO,GAAuB,CAAC,uBAAuB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAE1E,IAAI,QAAQ;QAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IACxE,IAAI,IAAI;QAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAEhE,OAAO,cAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC"}