talker_dio_logger_settings.dart

import 'package:dio/dio.dart';
import 'package:talker/talker.dart';

/// [TalkerDioLogger] settings and customization
class TalkerDioLoggerSettings {
  const TalkerDioLoggerSettings({
    this.enabled = true,
    this.logLevel = LogLevel.debug,
    this.printResponseData = true,
    this.printResponseHeaders = false,
    this.printResponseMessage = true,
    this.printResponseRedirects = false,
    this.printResponseTime = false,
    this.printErrorData = true,
    this.printErrorHeaders = true,
    this.printErrorMessage = true,
    this.printRequestData = true,
    this.printRequestHeaders = false,
    this.printRequestExtra = false,
    this.logTimestamp = false,
    this.timestampFormat = TimeFormat.yearMonthDayAndTime,
    this.timestampLabel = 'Date',
    this.hiddenHeaders = const <String>{},
    this.responseDataConverter,
    this.requestPen,
    this.responsePen,
    this.errorPen,
    this.requestFilter,
    this.responseFilter,
    this.errorFilter,
  });

  // Print Dio logger if true
  final bool enabled;

  // LogLevel of all dio logs. By default set as debug
  final LogLevel logLevel;

  /// Print [response.data] if true
  final bool printResponseData;

  /// Print [response.headers] if true
  final bool printResponseHeaders;

  /// Print [response.statusMessage] if true
  final bool printResponseMessage;

  /// Print [response.redirects] if true
  final bool printResponseRedirects;

  /// Print response time if true
  final bool printResponseTime;

  /// Print [error.response.data] if true
  final bool printErrorData;

  /// Print [error.response.headers] if true
  final bool printErrorHeaders;

  /// Print [error.message] if true
  final bool printErrorMessage;

  /// Print [request.data] if true
  final bool printRequestData;

  /// Print [request.headers] if true
  final bool printRequestHeaders;

  /// Print [request.extra] if true
  final bool printRequestExtra;

  /// Print timestamp in logs if true
  final bool logTimestamp;

  /// The [TimeFormat] used when [logTimestamp] is enabled.
  /// Defaults to [TimeFormat.yearMonthDayAndTime].
  final TimeFormat timestampFormat;

  /// The label printed before the timestamp value when [logTimestamp] is enabled.
  /// Defaults to `'Date'`.
  final String timestampLabel;

  /// Field to set custom http request console logs color
  ///```
  ///// Red color
  ///final redPen = AnsiPen()..red();
  ///
  ///// Blue color
  ///final redPen = AnsiPen()..blue();
  ///```
  /// More details in [AnsiPen] docs
  final AnsiPen? requestPen;

  /// Field to set custom http response console logs color
  ///```
  ///// Red color
  ///final redPen = AnsiPen()..red();
  ///
  ///// Blue color
  ///final redPen = AnsiPen()..blue();
  ///```
  /// More details in [AnsiPen] docs
  final AnsiPen? responsePen;

  /// Field to set custom http error console logs color
  ///```
  ///// Red color
  ///final redPen = AnsiPen()..red();
  ///
  ///// Blue color
  ///final redPen = AnsiPen()..blue();
  ///```
  /// More details in [AnsiPen] docs
  final AnsiPen? errorPen;

  /// For request filtering.
  /// You can add your custom logic to log only specific HTTP requests [RequestOptions].
  final bool Function(RequestOptions requestOptions)? requestFilter;

  /// For response filtering.
  /// You can add your custom logic to log only specific HTTP responses [Response].
  final bool Function(Response response)? responseFilter;

  /// response data converter.
  final String Function(Response response)? responseDataConverter;

  /// For error filtering.
  /// You can add your custom logic to log only specific Dio error [DioException].
  final bool Function(DioException response)? errorFilter;

  /// Header values for the specified keys in the Set will be replaced with *****.
  /// Case insensitive
  final Set<String> hiddenHeaders;

  TalkerDioLoggerSettings copyWith({
    bool? printResponseData,
    bool? printResponseHeaders,
    bool? printResponseMessage,
    bool? printResponseTime,
    bool? printErrorData,
    bool? printErrorHeaders,
    bool? printErrorMessage,
    bool? printRequestData,
    bool? printRequestHeaders,
    bool? printRequestExtra,
    bool? logTimestamp,
    TimeFormat? timestampFormat,
    String? timestampLabel,
    AnsiPen? requestPen,
    AnsiPen? responsePen,
    AnsiPen? errorPen,
    bool Function(RequestOptions requestOptions)? requestFilter,
    bool Function(Response response)? responseFilter,
    String Function(Response response)? responseDataConverter,
    bool Function(DioException response)? errorFilter,
    Set<String>? hiddenHeaders,
    LogLevel? logLevel,
  }) {
    return TalkerDioLoggerSettings(
      printResponseData: printResponseData ?? this.printResponseData,
      printResponseHeaders: printResponseHeaders ?? this.printResponseHeaders,
      printResponseMessage: printResponseMessage ?? this.printResponseMessage,
      printResponseTime: printResponseTime ?? this.printResponseTime,
      printErrorData: printErrorData ?? this.printErrorData,
      printErrorHeaders: printErrorHeaders ?? this.printErrorHeaders,
      printErrorMessage: printErrorMessage ?? this.printErrorMessage,
      printRequestData: printRequestData ?? this.printRequestData,
      printRequestHeaders: printRequestHeaders ?? this.printRequestHeaders,
      printRequestExtra: printRequestExtra ?? this.printRequestExtra,
      logTimestamp: logTimestamp ?? this.logTimestamp,
      timestampFormat: timestampFormat ?? this.timestampFormat,
      timestampLabel: timestampLabel ?? this.timestampLabel,
      requestPen: requestPen ?? this.requestPen,
      responsePen: responsePen ?? this.responsePen,
      errorPen: errorPen ?? this.errorPen,
      requestFilter: requestFilter ?? this.requestFilter,
      responseFilter: responseFilter ?? this.responseFilter,
      responseDataConverter:
          responseDataConverter ?? this.responseDataConverter,
      errorFilter: errorFilter ?? this.errorFilter,
      hiddenHeaders: hiddenHeaders ?? this.hiddenHeaders,
      logLevel: logLevel ?? this.logLevel,
    );
  }
}