pkg/dart_runtime_service/lib/src/dart_runtime_service_options.dart

// Copyright (c) 2026, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'dart_runtime_service.dart';

/// Used to configure the [DartRuntimeService].
class DartRuntimeServiceOptions {
  const DartRuntimeServiceOptions({
    this.enableLogging = false,
    this.port = 0,
    this.disableAuthCodes = false,
    this.disableOriginCheck = false,
    this.sseHandlerPath,
    this.autoStart = true,
    this.serveDevTools = false,
    this.enableServicePortFallback = false,
    this.host,
  });

  /// If true, enables log output for the service.
  final bool enableLogging;

  /// The port the service should attempt to bind to.
  ///
  /// Defaults to 0, which will result in the service binding to a random port.
  final int port;

  /// If true, clients will not be required to provide authentication codes to
  /// communicate with the service.
  ///
  /// Defaults to false.
  final bool disableAuthCodes;

  /// If true, CORS requests to the service will be accepted.
  ///
  /// Defaults to false.
  final bool disableOriginCheck;

  /// If non-null, allow for SSE connections to be established at
  /// [sseHandlerPath].
  ///
  /// Defaults to null.
  final String? sseHandlerPath;

  /// If true, the HTTP server will be started on initialization.
  final bool autoStart;

  /// If true, Dart DevTools should be made available via the HTTP server.
  final bool serveDevTools;

  /// If true, the service should attempt to bind to a different port if [port]
  /// is unavailable.
  final bool enableServicePortFallback;

  /// The host the service should attempt to bind to.
  ///
  /// If null, defaults to loopback IPv4 address.
  final String? host;

  DartRuntimeServiceOptions copyWith({
    bool? enableLogging,
    int? port,
    bool? disableAuthCodes,
    bool? disableOriginCheck,
    String? sseHandlerPath,
    bool? autoStart,
    bool? serveDevTools,
    bool? enableServicePortFallback,
    String? host,
  }) {
    return DartRuntimeServiceOptions(
      enableLogging: enableLogging ?? this.enableLogging,
      port: port ?? this.port,
      disableAuthCodes: disableAuthCodes ?? this.disableAuthCodes,
      disableOriginCheck: disableOriginCheck ?? this.disableOriginCheck,
      sseHandlerPath: sseHandlerPath ?? this.sseHandlerPath,
      autoStart: autoStart ?? this.autoStart,
      serveDevTools: serveDevTools ?? this.serveDevTools,
      enableServicePortFallback:
          enableServicePortFallback ?? this.enableServicePortFallback,
      host: host ?? this.host,
    );
  }
}