@globalart/nestjs-logger 1.4.2 → 2.4.0

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 /// <reference path="operators/index.d.ts" />
 /// <reference path="testing/index.d.ts" />
 import * as _nestjs_common0 from "@nestjs/common";
-import { CallHandler, DynamicModule, ExecutionContext, LoggerService as LoggerService$1, NestInterceptor, RequestMethod } from "@nestjs/common";
+import { CallHandler, DynamicModule, ExecutionContext, LoggerService as LoggerService$1, MiddlewareConsumer, NestInterceptor, NestModule, RequestMethod } from "@nestjs/common";
 import { Reflector } from "@nestjs/core";
 
 //#region ../../node_modules/.pnpm/rxjs@7.8.2/node_modules/rxjs/dist/types/internal/Subscription.d.ts
@@ -352,12 +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";
-declare const LOG_LEVELS: Record<LogLevel$1, number>;
-declare const PINO_LEVELS: Record<number, string>;
 interface LogEntry {
-  readonly level: LogLevel$1;
+  readonly level: LogLevel;
   readonly message: string;
   readonly timestamp: Date;
   readonly context?: string;
@@ -406,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;
@@ -415,39 +413,6 @@ interface LoggerConfiguration {
   readonly exclude: readonly ExcludeOption[];
   readonly logRequests?: boolean;
 }
-interface FormatterOptions {
-  readonly colors: boolean;
-  readonly timestamp: boolean;
-  readonly context?: string;
-}
-interface LoggerOptions {
-  level?: LogLevel$1;
-  timestamp?: boolean;
-  colors?: boolean;
-  context?: string;
-  format?: LogFormat;
-  transports?: LoggerTransport[];
-  pino?: PinoOptions;
-}
-interface PinoOptions {
-  level?: string;
-  timestamp?: boolean;
-  base?: boolean;
-  name?: string;
-  enabled?: boolean;
-}
-interface LoggerTransport {
-  name: string;
-  level?: string;
-  format?: unknown;
-  filename?: string;
-  dirname?: string;
-  maxsize?: number;
-  maxFiles?: number;
-}
-interface LoggerMetadata {
-  [key: string]: unknown;
-}
 //#endregion
 //#region src/contracts/index.d.ts
 interface ILogger {
@@ -462,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;
 }
@@ -493,7 +457,6 @@ declare class LoggerService implements LoggerService$1, ILogger {
   logHttpRequest(entry: HttpRequestLogEntry): void;
   private writeLog;
   private resolveTraceIds;
-  private enrichWithTraceIds;
 }
 //#endregion
 //#region src/core/http-logger.interceptor.d.ts
@@ -507,15 +470,12 @@ declare class HttpLoggerInterceptor implements NestInterceptor {
   private readonly pid;
   constructor(logger: LoggerService, dataSanitizer: IDataSanitizer, requestIdGenerator: IRequestIdGenerator, config: LoggerConfiguration, reflector: Reflector);
   intercept(context: ExecutionContext, next: CallHandler): Observable<unknown>;
-  private handleGraphQLRequest;
   private createHttpLogEntry;
   private createLogEntry;
   private getClientIp;
   private sanitizeHeaders;
   private getRequestMethod;
   private shouldExcludeRequest;
-  private sanitizeGraphQLArgs;
-  private getGraphQLResultSize;
   private extractErrorMessage;
   private extractErrorTrace;
 }
@@ -534,46 +494,39 @@ interface LoggerModuleOptions {
   exclude?: ExcludeOption[];
   logRequests?: boolean;
 }
-interface LoggerModuleAsyncOptions {
-  useFactory: (...args: any[]) => LoggerModuleOptions | Promise<LoggerModuleOptions>;
-  inject?: any[];
-}
-declare class LoggerModule {
-  static forRoot(options?: LoggerModuleOptions): DynamicModule;
-  static forRootAsync(options: LoggerModuleAsyncOptions): DynamicModule;
-  private static createConfiguration;
-  private static createProviders;
+declare const ConfigurableModuleClass: _nestjs_common0.ConfigurableModuleCls<LoggerModuleOptions, "forRoot", "create", {
+    global: boolean;
+  }>, MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: LoggerModuleOptions & Partial<{
+    global: boolean;
+  }>, ASYNC_OPTIONS_TYPE: _nestjs_common0.ConfigurableModuleAsyncOptions<LoggerModuleOptions, "create"> & Partial<{
+    global: boolean;
+  }>;
+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/utils/context-resolver.d.ts
-declare class ContextResolver implements IContextResolver {
-  resolve(): string;
-  private shouldSkipLine;
-  private extractClassName;
-  private isValidClassName;
-}
-//#endregion
-//#region src/writers/console-writer.d.ts
-declare class ConsoleWriter implements ILogWriter {
-  write(formattedLog: string, level?: LogLevel): void;
-}
-//#endregion
-//#region src/factories/formatter.factory.d.ts
-declare class FormatterFactory {
-  create(format: LogFormat, options: FormatterOptions): ILogFormatter;
-}
-//#endregion
-//#region src/factories/dynamic-context-logger.factory.d.ts
-declare class DynamicContextLoggerFactory {
-  private readonly config;
-  private readonly formatterFactory;
-  private readonly writer;
-  private readonly contextResolver;
-  private readonly loggerCache;
-  constructor(config: LoggerConfiguration, formatterFactory: FormatterFactory, writer: ConsoleWriter, contextResolver: ContextResolver);
-  createLogger(context: string): LoggerService;
+//#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
@@ -582,18 +535,9 @@ 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 { DynamicContextLoggerFactory, ExcludeLogging, ExcludeOption, FormatterOptions, HttpLoggerInterceptor, HttpRequest, HttpRequestLogEntry, HttpResponse, IContextResolver, IDataSanitizer, ILogFormatter, ILogWriter, ILogger, IRequestIdGenerator, InjectLogger, LOG_LEVELS, LogContext, LogEntry, LogFormat, LogMetadata, LogOptions, LoggerConfiguration, LoggerMetadata, LoggerModule, type LoggerModuleAsyncOptions, type LoggerModuleOptions, LoggerOptions, LoggerService, LoggerTransport, PINO_LEVELS, PinoOptions };
+export { ExcludeLogging, HttpLoggerInterceptor, InjectLogger, LogContext, LogMetadata, LoggerModule, LoggerService, TraceContextService };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 /// <reference path="operators/index.d.ts" />
 /// <reference path="testing/index.d.ts" />
 import * as _nestjs_common0 from "@nestjs/common";
-import { CallHandler, DynamicModule, ExecutionContext, LoggerService as LoggerService$1, NestInterceptor, RequestMethod } from "@nestjs/common";
+import { CallHandler, DynamicModule, ExecutionContext, LoggerService as LoggerService$1, MiddlewareConsumer, NestInterceptor, NestModule, RequestMethod } from "@nestjs/common";
 import { Reflector } from "@nestjs/core";
 
 //#region ../../node_modules/.pnpm/rxjs@7.8.2/node_modules/rxjs/dist/types/internal/Subscription.d.ts
@@ -352,12 +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";
-declare const LOG_LEVELS: Record<LogLevel$1, number>;
-declare const PINO_LEVELS: Record<number, string>;
 interface LogEntry {
-  readonly level: LogLevel$1;
+  readonly level: LogLevel;
   readonly message: string;
   readonly timestamp: Date;
   readonly context?: string;
@@ -406,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;
@@ -415,39 +413,6 @@ interface LoggerConfiguration {
   readonly exclude: readonly ExcludeOption[];
   readonly logRequests?: boolean;
 }
-interface FormatterOptions {
-  readonly colors: boolean;
-  readonly timestamp: boolean;
-  readonly context?: string;
-}
-interface LoggerOptions {
-  level?: LogLevel$1;
-  timestamp?: boolean;
-  colors?: boolean;
-  context?: string;
-  format?: LogFormat;
-  transports?: LoggerTransport[];
-  pino?: PinoOptions;
-}
-interface PinoOptions {
-  level?: string;
-  timestamp?: boolean;
-  base?: boolean;
-  name?: string;
-  enabled?: boolean;
-}
-interface LoggerTransport {
-  name: string;
-  level?: string;
-  format?: unknown;
-  filename?: string;
-  dirname?: string;
-  maxsize?: number;
-  maxFiles?: number;
-}
-interface LoggerMetadata {
-  [key: string]: unknown;
-}
 //#endregion
 //#region src/contracts/index.d.ts
 interface ILogger {
@@ -462,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;
 }
@@ -493,7 +457,6 @@ declare class LoggerService implements LoggerService$1, ILogger {
   logHttpRequest(entry: HttpRequestLogEntry): void;
   private writeLog;
   private resolveTraceIds;
-  private enrichWithTraceIds;
 }
 //#endregion
 //#region src/core/http-logger.interceptor.d.ts
@@ -507,15 +470,12 @@ declare class HttpLoggerInterceptor implements NestInterceptor {
   private readonly pid;
   constructor(logger: LoggerService, dataSanitizer: IDataSanitizer, requestIdGenerator: IRequestIdGenerator, config: LoggerConfiguration, reflector: Reflector);
   intercept(context: ExecutionContext, next: CallHandler): Observable<unknown>;
-  private handleGraphQLRequest;
   private createHttpLogEntry;
   private createLogEntry;
   private getClientIp;
   private sanitizeHeaders;
   private getRequestMethod;
   private shouldExcludeRequest;
-  private sanitizeGraphQLArgs;
-  private getGraphQLResultSize;
   private extractErrorMessage;
   private extractErrorTrace;
 }
@@ -534,46 +494,39 @@ interface LoggerModuleOptions {
   exclude?: ExcludeOption[];
   logRequests?: boolean;
 }
-interface LoggerModuleAsyncOptions {
-  useFactory: (...args: any[]) => LoggerModuleOptions | Promise<LoggerModuleOptions>;
-  inject?: any[];
-}
-declare class LoggerModule {
-  static forRoot(options?: LoggerModuleOptions): DynamicModule;
-  static forRootAsync(options: LoggerModuleAsyncOptions): DynamicModule;
-  private static createConfiguration;
-  private static createProviders;
+declare const ConfigurableModuleClass: _nestjs_common0.ConfigurableModuleCls<LoggerModuleOptions, "forRoot", "create", {
+    global: boolean;
+  }>, MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: LoggerModuleOptions & Partial<{
+    global: boolean;
+  }>, ASYNC_OPTIONS_TYPE: _nestjs_common0.ConfigurableModuleAsyncOptions<LoggerModuleOptions, "create"> & Partial<{
+    global: boolean;
+  }>;
+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/utils/context-resolver.d.ts
-declare class ContextResolver implements IContextResolver {
-  resolve(): string;
-  private shouldSkipLine;
-  private extractClassName;
-  private isValidClassName;
-}
-//#endregion
-//#region src/writers/console-writer.d.ts
-declare class ConsoleWriter implements ILogWriter {
-  write(formattedLog: string, level?: LogLevel): void;
-}
-//#endregion
-//#region src/factories/formatter.factory.d.ts
-declare class FormatterFactory {
-  create(format: LogFormat, options: FormatterOptions): ILogFormatter;
-}
-//#endregion
-//#region src/factories/dynamic-context-logger.factory.d.ts
-declare class DynamicContextLoggerFactory {
-  private readonly config;
-  private readonly formatterFactory;
-  private readonly writer;
-  private readonly contextResolver;
-  private readonly loggerCache;
-  constructor(config: LoggerConfiguration, formatterFactory: FormatterFactory, writer: ConsoleWriter, contextResolver: ContextResolver);
-  createLogger(context: string): LoggerService;
+//#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
@@ -582,18 +535,9 @@ 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 { DynamicContextLoggerFactory, ExcludeLogging, ExcludeOption, FormatterOptions, HttpLoggerInterceptor, HttpRequest, HttpRequestLogEntry, HttpResponse, IContextResolver, IDataSanitizer, ILogFormatter, ILogWriter, ILogger, IRequestIdGenerator, InjectLogger, LOG_LEVELS, LogContext, LogEntry, LogFormat, LogMetadata, LogOptions, LoggerConfiguration, LoggerMetadata, LoggerModule, type LoggerModuleAsyncOptions, type LoggerModuleOptions, LoggerOptions, LoggerService, LoggerTransport, PINO_LEVELS, PinoOptions };
+export { ExcludeLogging, HttpLoggerInterceptor, InjectLogger, LogContext, LogMetadata, LoggerModule, LoggerService, TraceContextService };
 //# sourceMappingURL=index.d.mts.map