xcally-nest-library 0.0.24 → 0.0.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xcally-nest-library",
-  "version": "0.0.24",
+  "version": "0.0.25",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/modules/logger/pino/logger.service.ts

@@ -1,33 +1,44 @@
 import { Injectable } from '@nestjs/common';
 import { PinoLogger } from 'nestjs-pino';
 import api from '@opentelemetry/api';
-
+/**
+ * @interface LoggerMeta
+ * @description Interface representing metadata for logging purposes.
+ *
+ * @property {any} [payload] - Optional payload data to be logged.
+ *
+ * @property {any} [ctx] - Optional context information to be logged. Used for audit logging.
+ */
+interface LoggerMeta {
+  payload?: any;
+  ctx?: any;
+}
 @Injectable()
 export class LoggerService {
   constructor(private readonly logger: PinoLogger) {}
 
-  debug(msg: string, meta?: any): void {
+  debug(msg: string, meta?: LoggerMeta): void {
     const activeSpan = api.trace.getSpan(api.context.active());
     activeSpan.addEvent(msg);
     this.logger.debug({ meta }, msg);
   }
-  warn(msg: string, meta?: any): void {
+  warn(msg: string, meta?: LoggerMeta): void {
     const activeSpan = api.trace.getSpan(api.context.active());
     activeSpan.addEvent(msg);
     this.logger.warn({ meta }, msg);
   }
-  error(msg: string, meta?: any): void {
+  error(msg: string, meta?: LoggerMeta): void {
     const activeSpan = api.trace.getSpan(api.context.active());
     activeSpan.addEvent(msg);
     this.logger.error({ meta }, msg);
   }
-  fatal(msg: string, meta?: any): void {
+  fatal(msg: string, meta?: LoggerMeta): void {
     const activeSpan = api.trace.getSpan(api.context.active());
     activeSpan.addEvent(msg);
     this.logger.fatal({ meta }, msg);
   }
 
-  info(msg: string, meta?: any): void {
+  info(msg: string, meta?: LoggerMeta): void {
     // LOG EVENTS
     const activeSpan = api.trace.getSpan(api.context.active());
     activeSpan.addEvent(msg);
@@ -42,7 +53,7 @@ export class LoggerService {
     this.logger.info({ meta }, msg);
   }
 
-  trace(msg: string, meta?: any): void {
+  trace(msg: string, meta?: LoggerMeta): void {
     const activeSpan = api.trace.getSpan(api.context.active());
     activeSpan.addEvent(msg);
     this.logger.trace({ meta }, msg);