@globalart/nestjs-logger 2.3.0 → 2.4.0

package/dist/index.d.cts

@@ -3,7 +3,6 @@
 import * as _nestjs_common0 from "@nestjs/common";
 import { CallHandler, DynamicModule, ExecutionContext, LoggerService as LoggerService$1, MiddlewareConsumer, NestInterceptor, NestModule, RequestMethod } from "@nestjs/common";
 import { Reflector } from "@nestjs/core";
-import { ClsService } from "nestjs-cls";
 
 //#region ../../node_modules/.pnpm/rxjs@7.8.2/node_modules/rxjs/dist/types/internal/Subscription.d.ts
 /**
@@ -353,10 +352,10 @@ declare class Observable<T> implements Subscribable<T> {
 }
 //#endregion
 //#region src/types/index.d.ts
-type LogLevel$1 = "error" | "warn" | "info" | "debug" | "verbose";
+type LogLevel = "error" | "warn" | "info" | "debug" | "verbose";
 type LogFormat = "json" | "text" | "pino";
 interface LogEntry {
-  readonly level: LogLevel$1;
+  readonly level: LogLevel;
   readonly message: string;
   readonly timestamp: Date;
   readonly context?: string;
@@ -405,7 +404,7 @@ interface ExcludeOption {
   path: string;
 }
 interface LoggerConfiguration {
-  readonly level: LogLevel$1;
+  readonly level: LogLevel;
   readonly timestamp: boolean;
   readonly colors: boolean;
   readonly context?: string;
@@ -428,7 +427,6 @@ interface ILogFormatter {
   format(entry: LogEntry): string;
   formatHttpRequest(entry: HttpRequestLogEntry): string;
 }
-type LogLevel = "error" | "warn" | "info" | "debug" | "verbose";
 interface ILogWriter {
   write(formattedLog: string, level?: LogLevel): void;
 }
@@ -448,9 +446,8 @@ declare class LoggerService implements LoggerService$1, ILogger {
   private readonly formatter;
   private readonly writer;
   private readonly contextResolver;
-  private readonly clsService;
   private context?;
-  constructor(config: LoggerConfiguration, formatter: ILogFormatter, writer: ILogWriter, contextResolver: IContextResolver, clsService: ClsService);
+  constructor(config: LoggerConfiguration, formatter: ILogFormatter, writer: ILogWriter, contextResolver: IContextResolver);
   setContext(context: string): void;
   log(options: LogOptions): void;
   error(options: LogOptions): void;
@@ -479,8 +476,6 @@ declare class HttpLoggerInterceptor implements NestInterceptor {
   private sanitizeHeaders;
   private getRequestMethod;
   private shouldExcludeRequest;
-  private sanitizeGraphQLArgs;
-  private getGraphQLResultSize;
   private extractErrorMessage;
   private extractErrorTrace;
 }
@@ -510,28 +505,39 @@ declare class LoggerModule extends ConfigurableModuleClass implements NestModule
   configure(consumer: MiddlewareConsumer): void;
   static forRoot(options?: typeof OPTIONS_TYPE): DynamicModule;
   static forRootAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
+  private static readonly BASE_EXPORTS;
+  private static createConfigProvider;
   private static createCoreProviders;
   private static createDynamicContextProviders;
 }
 //#endregion
+//#region src/core/trace-context.service.d.ts
+declare class TraceContextService {
+  /**
+   * Sets trace-id for the current async context.
+   * Affects all subsequent logs within the same request/async scope.
+   */
+  setTraceId(traceId: string): void;
+  /**
+   * Returns the current trace-id from the async context.
+   */
+  getTraceId(): string | undefined;
+  /**
+   * Runs a callback in a new isolated async context with the given trace-id.
+   * Does not affect the parent context.
+   */
+  runWithTraceId<T>(traceId: string, fn: () => T): T;
+}
+//#endregion
 //#region src/constants/index.d.ts
 declare const LOGGER_CONTEXT_METADATA: unique symbol;
 declare const LOGGER_METADATA_METADATA: unique symbol;
 declare const LOGGER_EXCLUDE_METADATA: unique symbol;
 //#endregion
 //#region src/decorators/index.d.ts
-/**
- * Decorator to set logging context for a class or method
- */
 declare const LogContext: (context: string) => _nestjs_common0.CustomDecorator<typeof LOGGER_CONTEXT_METADATA>;
-/**
- * Decorator to add metadata to logs
- */
 declare const LogMetadata: (metadata: Record<string, unknown>) => _nestjs_common0.CustomDecorator<typeof LOGGER_METADATA_METADATA>;
-/**
- * Decorator to exclude logging for a controller or method
- */
 declare const ExcludeLogging: () => _nestjs_common0.CustomDecorator<typeof LOGGER_EXCLUDE_METADATA>;
 //#endregion
-export { ExcludeLogging, HttpLoggerInterceptor, InjectLogger, LogContext, LogMetadata, LoggerModule, LoggerService };
+export { ExcludeLogging, HttpLoggerInterceptor, InjectLogger, LogContext, LogMetadata, LoggerModule, LoggerService, TraceContextService };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -3,7 +3,6 @@
 import * as _nestjs_common0 from "@nestjs/common";
 import { CallHandler, DynamicModule, ExecutionContext, LoggerService as LoggerService$1, MiddlewareConsumer, NestInterceptor, NestModule, RequestMethod } from "@nestjs/common";
 import { Reflector } from "@nestjs/core";
-import { ClsService } from "nestjs-cls";
 
 //#region ../../node_modules/.pnpm/rxjs@7.8.2/node_modules/rxjs/dist/types/internal/Subscription.d.ts
 /**
@@ -353,10 +352,10 @@ declare class Observable<T> implements Subscribable<T> {
 }
 //#endregion
 //#region src/types/index.d.ts
-type LogLevel$1 = "error" | "warn" | "info" | "debug" | "verbose";
+type LogLevel = "error" | "warn" | "info" | "debug" | "verbose";
 type LogFormat = "json" | "text" | "pino";
 interface LogEntry {
-  readonly level: LogLevel$1;
+  readonly level: LogLevel;
   readonly message: string;
   readonly timestamp: Date;
   readonly context?: string;
@@ -405,7 +404,7 @@ interface ExcludeOption {
   path: string;
 }
 interface LoggerConfiguration {
-  readonly level: LogLevel$1;
+  readonly level: LogLevel;
   readonly timestamp: boolean;
   readonly colors: boolean;
   readonly context?: string;
@@ -428,7 +427,6 @@ interface ILogFormatter {
   format(entry: LogEntry): string;
   formatHttpRequest(entry: HttpRequestLogEntry): string;
 }
-type LogLevel = "error" | "warn" | "info" | "debug" | "verbose";
 interface ILogWriter {
   write(formattedLog: string, level?: LogLevel): void;
 }
@@ -448,9 +446,8 @@ declare class LoggerService implements LoggerService$1, ILogger {
   private readonly formatter;
   private readonly writer;
   private readonly contextResolver;
-  private readonly clsService;
   private context?;
-  constructor(config: LoggerConfiguration, formatter: ILogFormatter, writer: ILogWriter, contextResolver: IContextResolver, clsService: ClsService);
+  constructor(config: LoggerConfiguration, formatter: ILogFormatter, writer: ILogWriter, contextResolver: IContextResolver);
   setContext(context: string): void;
   log(options: LogOptions): void;
   error(options: LogOptions): void;
@@ -479,8 +476,6 @@ declare class HttpLoggerInterceptor implements NestInterceptor {
   private sanitizeHeaders;
   private getRequestMethod;
   private shouldExcludeRequest;
-  private sanitizeGraphQLArgs;
-  private getGraphQLResultSize;
   private extractErrorMessage;
   private extractErrorTrace;
 }
@@ -510,28 +505,39 @@ declare class LoggerModule extends ConfigurableModuleClass implements NestModule
   configure(consumer: MiddlewareConsumer): void;
   static forRoot(options?: typeof OPTIONS_TYPE): DynamicModule;
   static forRootAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
+  private static readonly BASE_EXPORTS;
+  private static createConfigProvider;
   private static createCoreProviders;
   private static createDynamicContextProviders;
 }
 //#endregion
+//#region src/core/trace-context.service.d.ts
+declare class TraceContextService {
+  /**
+   * Sets trace-id for the current async context.
+   * Affects all subsequent logs within the same request/async scope.
+   */
+  setTraceId(traceId: string): void;
+  /**
+   * Returns the current trace-id from the async context.
+   */
+  getTraceId(): string | undefined;
+  /**
+   * Runs a callback in a new isolated async context with the given trace-id.
+   * Does not affect the parent context.
+   */
+  runWithTraceId<T>(traceId: string, fn: () => T): T;
+}
+//#endregion
 //#region src/constants/index.d.ts
 declare const LOGGER_CONTEXT_METADATA: unique symbol;
 declare const LOGGER_METADATA_METADATA: unique symbol;
 declare const LOGGER_EXCLUDE_METADATA: unique symbol;
 //#endregion
 //#region src/decorators/index.d.ts
-/**
- * Decorator to set logging context for a class or method
- */
 declare const LogContext: (context: string) => _nestjs_common0.CustomDecorator<typeof LOGGER_CONTEXT_METADATA>;
-/**
- * Decorator to add metadata to logs
- */
 declare const LogMetadata: (metadata: Record<string, unknown>) => _nestjs_common0.CustomDecorator<typeof LOGGER_METADATA_METADATA>;
-/**
- * Decorator to exclude logging for a controller or method
- */
 declare const ExcludeLogging: () => _nestjs_common0.CustomDecorator<typeof LOGGER_EXCLUDE_METADATA>;
 //#endregion
-export { ExcludeLogging, HttpLoggerInterceptor, InjectLogger, LogContext, LogMetadata, LoggerModule, LoggerService };
+export { ExcludeLogging, HttpLoggerInterceptor, InjectLogger, LogContext, LogMetadata, LoggerModule, LoggerService, TraceContextService };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -2,7 +2,6 @@ import { createRequire } from "node:module";
 import { ConfigurableModuleBuilder, Inject, Injectable, Module, RequestMethod, SetMetadata } from "@nestjs/common";
 import { APP_INTERCEPTOR, Reflector } from "@nestjs/core";
 import { hostname } from "os";
-import { ClsService } from "nestjs-cls";
 import { AsyncLocalStorage } from "async_hooks";
 import { nanoid } from "nanoid";
 import { randomBytes, randomUUID } from "crypto";
@@ -7089,7 +7088,6 @@ function __decorate(decorators, target, key, desc) {
 }
 //#endregion
 //#region src/core/logger.service.ts
-var _ref$2;
 const PINO_LEVEL_TO_LOG_LEVEL = {
 	60: "error",
 	50: "error",
@@ -7100,12 +7098,11 @@ const PINO_LEVEL_TO_LOG_LEVEL = {
 };
 let LoggerService = class LoggerService {
 	context;
-	constructor(config, formatter, writer, contextResolver, clsService) {
+	constructor(config, formatter, writer, contextResolver) {
 		this.config = config;
 		this.formatter = formatter;
 		this.writer = writer;
 		this.contextResolver = contextResolver;
-		this.clsService = clsService;
 	}
 	setContext(context) {
 		this.context = context;
@@ -7167,8 +7164,7 @@ LoggerService = __decorate([Injectable(), __decorateMetadata("design:paramtypes"
 	Object,
 	Object,
 	Object,
-	Object,
-	typeof (_ref$2 = typeof ClsService !== "undefined" && ClsService) === "function" ? _ref$2 : Object
+	Object
 ])], LoggerService);
 //#endregion
 //#region \0@oxc-project+runtime@0.115.0/helpers/decorateParam.js
@@ -7180,9 +7176,6 @@ function __decorateParam(paramIndex, decorator) {
 //#endregion
 //#region src/core/http-logger.interceptor.ts
 var _ref$1, _ref2$1;
-try {
-	__require("@nestjs/graphql").GqlExecutionContext;
-} catch {}
 let HttpLoggerInterceptor = class HttpLoggerInterceptor {
 	hostname = hostname();
 	pid = process.pid;
@@ -7194,6 +7187,7 @@ let HttpLoggerInterceptor = class HttpLoggerInterceptor {
 		this.reflector = reflector;
 	}
 	intercept(context, next) {
+		if (!this.config.logRequests) return next.handle();
 		const request = context.switchToHttp().getRequest();
 		const response = context.switchToHttp().getResponse();
 		if (!request || !request.method) return next.handle();
@@ -7305,20 +7299,6 @@ let HttpLoggerInterceptor = class HttpLoggerInterceptor {
 			return path === excludeOption.path;
 		});
 	}
-	sanitizeGraphQLArgs(args) {
-		if (!args || typeof args !== "object") return args;
-		const sanitized = { ...args };
-		if (sanitized.input && sanitized.input.password) sanitized.input = {
-			...sanitized.input,
-			password: "[HIDDEN]"
-		};
-		return this.dataSanitizer.sanitize(sanitized);
-	}
-	getGraphQLResultSize(result) {
-		if (Array.isArray(result)) return `${result.length} items`;
-		if (result && typeof result === "object") return "1 object";
-		return "primitive";
-	}
 	extractErrorMessage(error) {
 		if (!error) return void 0;
 		if (typeof error.getResponse === "function") {
@@ -7500,20 +7480,17 @@ let PinoFormatter = class PinoFormatter extends BaseFormatter {
 		const obj = {
 			level: entry.level,
 			message: entry.message,
-			timestamp: entry.timestamp,
-			context: entry.context,
-			metadata: entry.metadata,
-			trace: entry.trace
+			timestamp: entry.timestamp
 		};
+		if (entry.context) obj.context = entry.context;
+		if (entry.metadata) obj.metadata = entry.metadata;
+		if (entry.trace) obj.trace = entry.trace;
 		if (entry.traceId) obj.traceId = entry.traceId;
 		if (entry.spanId) obj.spanId = entry.spanId;
 		return JSON.stringify(obj);
 	}
 	formatHttpRequest(entry) {
-		const obj = { ...entry };
-		if (entry.traceId) obj.traceId = entry.traceId;
-		if (entry.spanId) obj.spanId = entry.spanId;
-		const jsonString = JSON.stringify(obj);
+		const jsonString = JSON.stringify(entry);
 		return this.options.colors ? this.colorize(jsonString, this.getColorForLevel(entry.level)) : jsonString;
 	}
 };
@@ -7680,6 +7657,32 @@ let TraceContextMiddleware = class TraceContextMiddleware {
 };
 TraceContextMiddleware = __decorate([Injectable()], TraceContextMiddleware);
 //#endregion
+//#region src/core/trace-context.service.ts
+let TraceContextService = class TraceContextService {
+	/**
+	* Sets trace-id for the current async context.
+	* Affects all subsequent logs within the same request/async scope.
+	*/
+	setTraceId(traceId) {
+		const store = traceContextStorage.getStore();
+		if (store) store.correlationId = traceId;
+	}
+	/**
+	* Returns the current trace-id from the async context.
+	*/
+	getTraceId() {
+		return traceContextStorage.getStore()?.correlationId;
+	}
+	/**
+	* Runs a callback in a new isolated async context with the given trace-id.
+	* Does not affect the parent context.
+	*/
+	runWithTraceId(traceId, fn) {
+		return traceContextStorage.run({ correlationId: traceId }, fn);
+	}
+};
+TraceContextService = __decorate([Injectable()], TraceContextService);
+//#endregion
 //#region src/core/logger.module.ts
 const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE, ASYNC_OPTIONS_TYPE } = new ConfigurableModuleBuilder().setClassMethodName("forRoot").setExtras({ global: true }, (definition, extras) => ({
 	...definition,
@@ -7698,27 +7701,11 @@ let LoggerModule = class LoggerModule extends ConfigurableModuleClass {
 				...parent.providers ?? [],
 				...this.createCoreProviders(),
 				...contextProviders,
-				{
-					provide: LOGGER_CONFIG_TOKEN,
-					useFactory: (opts) => ({
-						...DEFAULT_LOGGER_CONFIG,
-						...opts,
-						sensitiveFields: opts.sensitiveFields ?? DEFAULT_LOGGER_CONFIG.sensitiveFields,
-						exclude: opts.exclude ?? DEFAULT_LOGGER_CONFIG.exclude
-					}),
-					inject: [MODULE_OPTIONS_TOKEN]
-				},
-				...options.logRequests ? [{
-					provide: APP_INTERCEPTOR,
-					useExisting: HttpLoggerInterceptor
-				}] : []
+				this.createConfigProvider()
 			],
 			exports: [
 				...parent.exports ?? [],
-				LOGGER_SERVICE_TOKEN,
-				HttpLoggerInterceptor,
-				DYNAMIC_CONTEXT_LOGGER_FACTORY_TOKEN,
-				TraceContextMiddleware,
+				...this.BASE_EXPORTS,
 				...contextProviders.map((p) => p.provide)
 			]
 		};
@@ -7732,35 +7719,38 @@ let LoggerModule = class LoggerModule extends ConfigurableModuleClass {
 				...parent.providers ?? [],
 				...this.createCoreProviders(),
 				...contextProviders,
-				{
-					provide: LOGGER_CONFIG_TOKEN,
-					useFactory: (opts) => ({
-						...DEFAULT_LOGGER_CONFIG,
-						...opts,
-						sensitiveFields: opts.sensitiveFields ?? DEFAULT_LOGGER_CONFIG.sensitiveFields,
-						exclude: opts.exclude ?? DEFAULT_LOGGER_CONFIG.exclude
-					}),
-					inject: [MODULE_OPTIONS_TOKEN]
-				},
-				{
-					provide: APP_INTERCEPTOR,
-					useFactory: (config, interceptor) => config.logRequests ? interceptor : null,
-					inject: [LOGGER_CONFIG_TOKEN, HttpLoggerInterceptor]
-				}
+				this.createConfigProvider()
 			],
 			exports: [
 				...parent.exports ?? [],
-				LOGGER_SERVICE_TOKEN,
-				HttpLoggerInterceptor,
-				DYNAMIC_CONTEXT_LOGGER_FACTORY_TOKEN,
-				TraceContextMiddleware,
+				...this.BASE_EXPORTS,
 				...contextProviders.map((p) => p.provide)
 			]
 		};
 	}
+	static BASE_EXPORTS = [
+		LOGGER_SERVICE_TOKEN,
+		HttpLoggerInterceptor,
+		DYNAMIC_CONTEXT_LOGGER_FACTORY_TOKEN,
+		TraceContextMiddleware,
+		TraceContextService
+	];
+	static createConfigProvider() {
+		return {
+			provide: LOGGER_CONFIG_TOKEN,
+			useFactory: (opts) => ({
+				...DEFAULT_LOGGER_CONFIG,
+				...opts,
+				sensitiveFields: opts.sensitiveFields ?? DEFAULT_LOGGER_CONFIG.sensitiveFields,
+				exclude: opts.exclude ?? DEFAULT_LOGGER_CONFIG.exclude
+			}),
+			inject: [MODULE_OPTIONS_TOKEN]
+		};
+	}
 	static createCoreProviders() {
 		return [
 			TraceContextMiddleware,
+			TraceContextService,
 			FormatterFactory,
 			ConsoleWriter,
 			ContextResolver,
@@ -7799,6 +7789,10 @@ let LoggerModule = class LoggerModule extends ConfigurableModuleClass {
 					RequestIdGenerator,
 					LOGGER_CONFIG_TOKEN
 				]
+			},
+			{
+				provide: APP_INTERCEPTOR,
+				useExisting: HttpLoggerInterceptor
 			}
 		];
 	}
@@ -7813,19 +7807,10 @@ let LoggerModule = class LoggerModule extends ConfigurableModuleClass {
 LoggerModule = __decorate([Module({})], LoggerModule);
 //#endregion
 //#region src/decorators/index.ts
-/**
-* Decorator to set logging context for a class or method
-*/
 const LogContext = (context) => SetMetadata(LOGGER_CONTEXT_METADATA, context);
-/**
-* Decorator to add metadata to logs
-*/
 const LogMetadata = (metadata) => SetMetadata(LOGGER_METADATA_METADATA, metadata);
-/**
-* Decorator to exclude logging for a controller or method
-*/
 const ExcludeLogging = () => SetMetadata(LOGGER_EXCLUDE_METADATA, true);
 //#endregion
-export { ExcludeLogging, HttpLoggerInterceptor, InjectLogger, LogContext, LogMetadata, LoggerModule, LoggerService };
+export { ExcludeLogging, HttpLoggerInterceptor, InjectLogger, LogContext, LogMetadata, LoggerModule, LoggerService, TraceContextService };
 
 //# sourceMappingURL=index.mjs.map