@globalart/nestjs-logger 1.0.10 → 1.0.11

package/dist/index.d.mts

@@ -0,0 +1,240 @@
+import * as _nestjs_common0 from "@nestjs/common";
+import { CallHandler, DynamicModule, ExecutionContext, LoggerService as LoggerService$1, NestInterceptor, RequestMethod } from "@nestjs/common";
+import { Reflector } from "@nestjs/core";
+import { Observable } from "rxjs";
+
+//#region src/types/index.d.ts
+type LogLevel = "error" | "warn" | "info" | "debug" | "verbose";
+type LogFormat = "json" | "text" | "pino";
+declare const LOG_LEVELS: Record<LogLevel, number>;
+declare const PINO_LEVELS: Record<number, string>;
+interface LogEntry {
+  readonly level: LogLevel;
+  readonly message: string;
+  readonly timestamp: Date;
+  readonly context?: string;
+  readonly metadata?: Record<string, unknown>;
+  readonly trace?: string;
+}
+interface LogOptions {
+  message: any;
+  context?: string;
+  metadata?: any;
+  trace?: string;
+}
+interface HttpRequest {
+  readonly id: string;
+  readonly method: string;
+  readonly url: string;
+  readonly query: Record<string, unknown>;
+  readonly params: Record<string, unknown>;
+  readonly headers: Record<string, string>;
+  readonly remoteAddress: string;
+  readonly remotePort?: number;
+  readonly body?: unknown;
+}
+interface HttpResponse {
+  readonly statusCode: number;
+  readonly headers: Record<string, string>;
+}
+interface HttpRequestLogEntry {
+  readonly level: number;
+  readonly time: number;
+  readonly pid: number;
+  readonly hostname: string;
+  readonly req: HttpRequest;
+  readonly res: HttpResponse;
+  readonly responseTime: number;
+  readonly msg: string;
+}
+interface ExcludeOption {
+  method: RequestMethod;
+  path: string;
+}
+interface LoggerConfiguration {
+  readonly level: LogLevel;
+  readonly timestamp: boolean;
+  readonly colors: boolean;
+  readonly context?: string;
+  readonly format: LogFormat;
+  readonly sensitiveFields: readonly string[];
+  readonly exclude: readonly ExcludeOption[];
+}
+interface FormatterOptions {
+  readonly colors: boolean;
+  readonly timestamp: boolean;
+  readonly context?: string;
+}
+interface LoggerOptions {
+  level?: LogLevel;
+  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 {
+  log(options: LogOptions): void;
+  error(options: LogOptions): void;
+  warn(options: LogOptions): void;
+  debug(options: LogOptions): void;
+  verbose(options: LogOptions): void;
+  logHttpRequest(entry: HttpRequestLogEntry): void;
+}
+interface ILogFormatter {
+  format(entry: LogEntry): string;
+  formatHttpRequest(entry: HttpRequestLogEntry): string;
+}
+interface ILogWriter {
+  write(formattedLog: string): void;
+}
+interface IContextResolver {
+  resolve(): string;
+}
+interface IDataSanitizer {
+  sanitize(data: unknown): unknown;
+}
+interface IRequestIdGenerator {
+  generate(): string;
+}
+//#endregion
+//#region src/core/logger.service.d.ts
+declare class LoggerService implements LoggerService$1, ILogger {
+  private readonly config;
+  private readonly formatter;
+  private readonly writer;
+  private readonly contextResolver;
+  private context?;
+  constructor(config: LoggerConfiguration, formatter: ILogFormatter, writer: ILogWriter, contextResolver: IContextResolver);
+  setContext(context: string): void;
+  log(options: LogOptions): void;
+  error(options: LogOptions): void;
+  warn(options: LogOptions): void;
+  debug(options: LogOptions): void;
+  verbose(options: LogOptions): void;
+  logHttpRequest(entry: HttpRequestLogEntry): void;
+  private writeLog;
+}
+//#endregion
+//#region src/core/http-logger.interceptor.d.ts
+declare class HttpLoggerInterceptor implements NestInterceptor {
+  private readonly logger;
+  private readonly dataSanitizer;
+  private readonly requestIdGenerator;
+  private readonly config;
+  private readonly reflector;
+  private readonly hostname;
+  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;
+}
+//#endregion
+//#region src/core/logger.di-tokens.d.ts
+declare const InjectLogger: (context?: string) => PropertyDecorator & ParameterDecorator;
+//#endregion
+//#region src/core/logger.module.d.ts
+interface LoggerModuleOptions {
+  level?: "error" | "warn" | "info" | "debug" | "verbose";
+  timestamp?: boolean;
+  colors?: boolean;
+  context?: string;
+  format?: "json" | "text" | "pino";
+  sensitiveFields?: string[];
+  exclude?: ExcludeOption[];
+}
+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;
+  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): 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;
+}
+//#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 { DynamicContextLoggerFactory, ExcludeLogging, ExcludeOption, FormatterOptions, HttpLoggerInterceptor, HttpRequest, HttpRequestLogEntry, HttpResponse, IContextResolver, IDataSanitizer, ILogFormatter, ILogWriter, ILogger, IRequestIdGenerator, InjectLogger, LOG_LEVELS, LogContext, LogEntry, LogFormat, LogLevel, LogMetadata, LogOptions, LoggerConfiguration, LoggerMetadata, LoggerModule, type LoggerModuleAsyncOptions, type LoggerModuleOptions, LoggerOptions, LoggerService, LoggerTransport, PINO_LEVELS, PinoOptions };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.ts

@@ -1,8 +1,240 @@
-export { LoggerModule, LoggerModuleOptions, LoggerModuleAsyncOptions, } from "./core/logger.module";
-export { InjectLogger } from "./core/logger.di-tokens";
-export { LoggerService } from "./core/logger.service";
-export { HttpLoggerInterceptor } from "./core/http-logger.interceptor";
-export { DynamicContextLoggerFactory } from "./factories/dynamic-context-logger.factory";
-export { LogContext, LogMetadata, ExcludeLogging } from "./decorators";
-export * from "./types";
-export * from "./contracts";
+import * as _nestjs_common0 from "@nestjs/common";
+import { CallHandler, DynamicModule, ExecutionContext, LoggerService as LoggerService$1, NestInterceptor, RequestMethod } from "@nestjs/common";
+import { Reflector } from "@nestjs/core";
+import { Observable } from "rxjs";
+
+//#region src/types/index.d.ts
+type LogLevel = "error" | "warn" | "info" | "debug" | "verbose";
+type LogFormat = "json" | "text" | "pino";
+declare const LOG_LEVELS: Record<LogLevel, number>;
+declare const PINO_LEVELS: Record<number, string>;
+interface LogEntry {
+  readonly level: LogLevel;
+  readonly message: string;
+  readonly timestamp: Date;
+  readonly context?: string;
+  readonly metadata?: Record<string, unknown>;
+  readonly trace?: string;
+}
+interface LogOptions {
+  message: any;
+  context?: string;
+  metadata?: any;
+  trace?: string;
+}
+interface HttpRequest {
+  readonly id: string;
+  readonly method: string;
+  readonly url: string;
+  readonly query: Record<string, unknown>;
+  readonly params: Record<string, unknown>;
+  readonly headers: Record<string, string>;
+  readonly remoteAddress: string;
+  readonly remotePort?: number;
+  readonly body?: unknown;
+}
+interface HttpResponse {
+  readonly statusCode: number;
+  readonly headers: Record<string, string>;
+}
+interface HttpRequestLogEntry {
+  readonly level: number;
+  readonly time: number;
+  readonly pid: number;
+  readonly hostname: string;
+  readonly req: HttpRequest;
+  readonly res: HttpResponse;
+  readonly responseTime: number;
+  readonly msg: string;
+}
+interface ExcludeOption {
+  method: RequestMethod;
+  path: string;
+}
+interface LoggerConfiguration {
+  readonly level: LogLevel;
+  readonly timestamp: boolean;
+  readonly colors: boolean;
+  readonly context?: string;
+  readonly format: LogFormat;
+  readonly sensitiveFields: readonly string[];
+  readonly exclude: readonly ExcludeOption[];
+}
+interface FormatterOptions {
+  readonly colors: boolean;
+  readonly timestamp: boolean;
+  readonly context?: string;
+}
+interface LoggerOptions {
+  level?: LogLevel;
+  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 {
+  log(options: LogOptions): void;
+  error(options: LogOptions): void;
+  warn(options: LogOptions): void;
+  debug(options: LogOptions): void;
+  verbose(options: LogOptions): void;
+  logHttpRequest(entry: HttpRequestLogEntry): void;
+}
+interface ILogFormatter {
+  format(entry: LogEntry): string;
+  formatHttpRequest(entry: HttpRequestLogEntry): string;
+}
+interface ILogWriter {
+  write(formattedLog: string): void;
+}
+interface IContextResolver {
+  resolve(): string;
+}
+interface IDataSanitizer {
+  sanitize(data: unknown): unknown;
+}
+interface IRequestIdGenerator {
+  generate(): string;
+}
+//#endregion
+//#region src/core/logger.service.d.ts
+declare class LoggerService implements LoggerService$1, ILogger {
+  private readonly config;
+  private readonly formatter;
+  private readonly writer;
+  private readonly contextResolver;
+  private context?;
+  constructor(config: LoggerConfiguration, formatter: ILogFormatter, writer: ILogWriter, contextResolver: IContextResolver);
+  setContext(context: string): void;
+  log(options: LogOptions): void;
+  error(options: LogOptions): void;
+  warn(options: LogOptions): void;
+  debug(options: LogOptions): void;
+  verbose(options: LogOptions): void;
+  logHttpRequest(entry: HttpRequestLogEntry): void;
+  private writeLog;
+}
+//#endregion
+//#region src/core/http-logger.interceptor.d.ts
+declare class HttpLoggerInterceptor implements NestInterceptor {
+  private readonly logger;
+  private readonly dataSanitizer;
+  private readonly requestIdGenerator;
+  private readonly config;
+  private readonly reflector;
+  private readonly hostname;
+  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;
+}
+//#endregion
+//#region src/core/logger.di-tokens.d.ts
+declare const InjectLogger: (context?: string) => PropertyDecorator & ParameterDecorator;
+//#endregion
+//#region src/core/logger.module.d.ts
+interface LoggerModuleOptions {
+  level?: "error" | "warn" | "info" | "debug" | "verbose";
+  timestamp?: boolean;
+  colors?: boolean;
+  context?: string;
+  format?: "json" | "text" | "pino";
+  sensitiveFields?: string[];
+  exclude?: ExcludeOption[];
+}
+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;
+  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): 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;
+}
+//#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 { DynamicContextLoggerFactory, ExcludeLogging, ExcludeOption, FormatterOptions, HttpLoggerInterceptor, HttpRequest, HttpRequestLogEntry, HttpResponse, IContextResolver, IDataSanitizer, ILogFormatter, ILogWriter, ILogger, IRequestIdGenerator, InjectLogger, LOG_LEVELS, LogContext, LogEntry, LogFormat, LogLevel, LogMetadata, LogOptions, LoggerConfiguration, LoggerMetadata, LoggerModule, type LoggerModuleAsyncOptions, type LoggerModuleOptions, LoggerOptions, LoggerService, LoggerTransport, PINO_LEVELS, PinoOptions };
+//# sourceMappingURL=index.d.ts.map