nestjs-pino 1.2.0 → 1.4.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.
@@ -0,0 +1,3 @@
1
+ {
2
+ "typescript.tsdk": "node_modules/typescript/lib"
3
+ }
package/README.md CHANGED
@@ -249,6 +249,7 @@ import { LoggerModule } from 'nestjs-pino';
249
249
  {
250
250
  name: 'add some name to every JSON line',
251
251
  level: process.env.NODE_ENV !== 'production' ? 'debug' : 'info',
252
+ // install 'pino-pretty' package in order to use the following option
252
253
  prettyPrint: process.env.NODE_ENV !== 'production',
253
254
  useLevelLabels: true,
254
255
  // and all the others...
@@ -435,6 +436,52 @@ import { Logger } from "nestjs-pino";
435
436
  const app = await NestFactory.create(MyModule, { logger: false });
436
437
  app.useLogger(app.get(Logger));
437
438
  ```
439
+ ## Extend the Logger class
440
+
441
+ You can extend the Logger class to add your own business logic.
442
+
443
+ ```ts
444
+ // logger.service.ts
445
+ import { Logger, PinoLogger, Params, PARAMS_PROVIDER_TOKEN } from "nestjs-pino";
446
+
447
+ @Injectable()
448
+ class LoggerService extends Logger() {
449
+ // regular injecting
450
+ constructor(
451
+ logger: PinoLogger,
452
+ @Inject(PARAMS_PROVIDER_TOKEN) params: Params
453
+ ) {
454
+ ...
455
+ }
456
+
457
+ // extended method
458
+ myMethod(): any {}
459
+ }
460
+
461
+ import { PinoLogger, Params, PARAMS_PROVIDER_TOKEN } from "nestjs-pino";
462
+
463
+ @Injectable()
464
+ class LoggerService extends PinoLogger() {
465
+ // regular injecting
466
+ constructor(
467
+ @Inject(PARAMS_PROVIDER_TOKEN) params: Params
468
+ ) {
469
+ ...
470
+ }
471
+
472
+ // extended method
473
+ myMethod(): any {}
474
+ }
475
+
476
+
477
+ // logger.module.ts
478
+ @Module({
479
+ providers: [LoggerService],
480
+ exports: [LoggerService],
481
+ imports: [LoggerModule.forRoot()],
482
+ })
483
+ class LoggerModule {}
484
+ ```
438
485
 
439
486
  ## Migrating
440
487
 
@@ -1,5 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getLoggerToken = exports.createProvidersForDecorated = exports.InjectPinoLogger = void 0;
3
4
  const common_1 = require("@nestjs/common");
4
5
  const PinoLogger_1 = require("./PinoLogger");
5
6
  const decoratedTokenPrefix = "PinoLogger:";
package/dist/Logger.d.ts CHANGED
@@ -2,7 +2,7 @@ import { LoggerService } from "@nestjs/common";
2
2
  import { PinoLogger } from "./PinoLogger";
3
3
  import { Params } from "./params";
4
4
  export declare class Logger implements LoggerService {
5
- private readonly logger;
5
+ protected readonly logger: PinoLogger;
6
6
  private readonly contextName;
7
7
  constructor(logger: PinoLogger, { renameContext }: Params);
8
8
  verbose(message: any, context?: string, ...args: any[]): void;
package/dist/Logger.js CHANGED
@@ -12,6 +12,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
12
12
  return function (target, key) { decorator(target, key, paramIndex); }
13
13
  };
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.Logger = void 0;
15
16
  const common_1 = require("@nestjs/common");
16
17
  const PinoLogger_1 = require("./PinoLogger");
17
18
  const constants_1 = require("./constants");
@@ -13,6 +13,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
13
13
  };
14
14
  var LoggerCoreModule_1;
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.LoggerCoreModule = void 0;
16
17
  const common_1 = require("@nestjs/common");
17
18
  const pinoHttp = require("pino-http");
18
19
  const express_ctx_1 = require("express-ctx");
@@ -34,7 +35,7 @@ let LoggerCoreModule = LoggerCoreModule_1 = class LoggerCoreModule {
34
35
  return {
35
36
  module: LoggerCoreModule_1,
36
37
  providers: [Logger_1.Logger, ...decorated, PinoLogger_1.PinoLogger, paramsProvider],
37
- exports: [Logger_1.Logger, ...decorated, PinoLogger_1.PinoLogger]
38
+ exports: [Logger_1.Logger, ...decorated, PinoLogger_1.PinoLogger, paramsProvider]
38
39
  };
39
40
  }
40
41
  static forRootAsync(params) {
@@ -55,7 +56,7 @@ let LoggerCoreModule = LoggerCoreModule_1 = class LoggerCoreModule {
55
56
  module: LoggerCoreModule_1,
56
57
  imports: params.imports,
57
58
  providers,
58
- exports: [Logger_1.Logger, ...decorated, PinoLogger_1.PinoLogger]
59
+ exports: [Logger_1.Logger, ...decorated, PinoLogger_1.PinoLogger, paramsProvider]
59
60
  };
60
61
  }
61
62
  configure(consumer) {
@@ -7,6 +7,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
7
7
  };
8
8
  var LoggerModule_1;
9
9
  Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.LoggerModule = void 0;
10
11
  const common_1 = require("@nestjs/common");
11
12
  const LoggerCoreModule_1 = require("./LoggerCoreModule");
12
13
  let LoggerModule = LoggerModule_1 = class LoggerModule {
@@ -21,6 +21,6 @@ export declare class PinoLogger implements PinoMethods {
21
21
  fatal(obj: object, msg?: string, ...args: any[]): void;
22
22
  setContext(value: string): void;
23
23
  private call;
24
- private get logger();
24
+ get logger(): pino.Logger;
25
25
  }
26
26
  export {};
@@ -12,6 +12,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
12
12
  return function (target, key) { decorator(target, key, paramIndex); }
13
13
  };
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.PinoLogger = exports.__resetOutOfContextForTests = void 0;
15
16
  const common_1 = require("@nestjs/common");
16
17
  const pino = require("pino");
17
18
  const express_ctx_1 = require("express-ctx");
@@ -66,10 +67,18 @@ let PinoLogger = class PinoLogger {
66
67
  if (context) {
67
68
  const firstArg = args[0];
68
69
  if (typeof firstArg === "object") {
69
- args = [
70
- Object.assign({ [this.contextName]: context }, firstArg),
71
- ...args.slice(1)
72
- ];
70
+ if (firstArg instanceof Error) {
71
+ args = [
72
+ Object.assign({ [this.contextName]: context }, { err: firstArg }),
73
+ ...args.slice(1)
74
+ ];
75
+ }
76
+ else {
77
+ args = [
78
+ Object.assign({ [this.contextName]: context }, firstArg),
79
+ ...args.slice(1)
80
+ ];
81
+ }
73
82
  }
74
83
  else {
75
84
  args = [{ [this.contextName]: context }, ...args];
package/dist/constants.js CHANGED
@@ -1,5 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PARAMS_PROVIDER_TOKEN = exports.LOGGER_KEY = void 0;
3
4
  exports.LOGGER_KEY = "logger";
4
5
  exports.PARAMS_PROVIDER_TOKEN = "pino-params";
5
6
  //# sourceMappingURL=constants.js.map
package/dist/index.d.ts CHANGED
@@ -3,3 +3,4 @@ export { Params, LoggerModuleAsyncParams } from "./params";
3
3
  export { Logger } from "./Logger";
4
4
  export { PinoLogger } from "./PinoLogger";
5
5
  export { InjectPinoLogger, getLoggerToken } from "./InjectPinoLogger";
6
+ export { PARAMS_PROVIDER_TOKEN } from './constants';
package/dist/index.js CHANGED
@@ -1,12 +1,14 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  var LoggerModule_1 = require("./LoggerModule");
4
- exports.LoggerModule = LoggerModule_1.LoggerModule;
4
+ Object.defineProperty(exports, "LoggerModule", { enumerable: true, get: function () { return LoggerModule_1.LoggerModule; } });
5
5
  var Logger_1 = require("./Logger");
6
- exports.Logger = Logger_1.Logger;
6
+ Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return Logger_1.Logger; } });
7
7
  var PinoLogger_1 = require("./PinoLogger");
8
- exports.PinoLogger = PinoLogger_1.PinoLogger;
8
+ Object.defineProperty(exports, "PinoLogger", { enumerable: true, get: function () { return PinoLogger_1.PinoLogger; } });
9
9
  var InjectPinoLogger_1 = require("./InjectPinoLogger");
10
- exports.InjectPinoLogger = InjectPinoLogger_1.InjectPinoLogger;
11
- exports.getLoggerToken = InjectPinoLogger_1.getLoggerToken;
10
+ Object.defineProperty(exports, "InjectPinoLogger", { enumerable: true, get: function () { return InjectPinoLogger_1.InjectPinoLogger; } });
11
+ Object.defineProperty(exports, "getLoggerToken", { enumerable: true, get: function () { return InjectPinoLogger_1.getLoggerToken; } });
12
+ var constants_1 = require("./constants");
13
+ Object.defineProperty(exports, "PARAMS_PROVIDER_TOKEN", { enumerable: true, get: function () { return constants_1.PARAMS_PROVIDER_TOKEN; } });
12
14
  //# sourceMappingURL=index.js.map
package/dist/params.js CHANGED
@@ -1,5 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.isPassedLogger = void 0;
3
4
  function isPassedLogger(pinoHttpProp) {
4
5
  return !!pinoHttpProp && "logger" in pinoHttpProp;
5
6
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nestjs-pino",
3
- "version": "1.2.0",
3
+ "version": "1.4.0",
4
4
  "description": "Pino logger for NestJS",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
@@ -40,11 +40,11 @@
40
40
  "@nestjs/core": "^6.6.7",
41
41
  "@nestjs/platform-express": "^7.0.0",
42
42
  "@nestjs/platform-fastify": "^7.0.0",
43
- "@nestjs/testing": "^6.6.7",
43
+ "@nestjs/testing": "^7.0.0",
44
44
  "@types/express": "^4.17.1",
45
- "@types/jest": "^25.1.0",
45
+ "@types/jest": "^26.0.0",
46
46
  "@types/memorystream": "^0.3.0",
47
- "@types/node": "^13.1.0",
47
+ "@types/node": "^14.0.1",
48
48
  "@types/supertest": "^2.0.8",
49
49
  "coveralls": "^3.0.6",
50
50
  "express": "^4.17.1",