pkgs/json_syntax_generator/lib/src/model/class_info.dart

// Copyright (c) 2025, 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 'property_info.dart';
import 'utils.dart';

sealed class ClassInfo {
  /// The Dart class name.
  final String name;

  String get className => '${name}Syntax';

  ClassInfo({required this.name});
}

class NormalClassInfo extends ClassInfo {
  /// Reference to the super class.
  final NormalClassInfo? superclass;

  /// References to all subclasses.
  ///
  /// Constructed lazily on instantiating sub classes.
  final List<NormalClassInfo> subclasses = [];

  /// The properties of this class.
  ///
  /// Includes properties that override properties in a super class. Does not
  /// include properties not overridden in the super class.
  final List<PropertyInfo> properties;

  PropertyInfo? getProperty(String name) =>
      properties.where((e) => e.name == name).firstOrNull;

  /// The Dart property identifying a tagged union.
  ///
  /// Only set in the parent class.
  final String? taggedUnionProperty;

  /// The String value identifying the subtype in a tagged union.
  ///
  /// Only set in the sub classes.
  final String? taggedUnionValue;

  /// If the tagged union tags are available in the generated API.
  ///
  /// Only set in the parent class.
  final bool visibleTaggedUnion;

  bool get isTaggedUnion =>
      taggedUnionProperty != null || taggedUnionValue != null;

  final List<ConditionallyRequired> extraValidation;

  NormalClassInfo({
    required super.name,
    this.superclass,
    required this.properties,
    this.taggedUnionProperty,
    this.taggedUnionValue,
    this.extraValidation = const [],
    this.visibleTaggedUnion = false,
  }) : super() {
    superclass?.subclasses.add(this);
    if (taggedUnionValue != null) {
      assert(superclass != null);
    }
  }

  @override
  String toString() {
    final propertiesString = properties
        .map((p) => indentLines(p.toString(), level: 2))
        .join(',\n');
    final extraValidationString = extraValidation
        .map((p) => indentLines(p.toString(), level: 2))
        .join('\n');
    return '''
$runtimeType(
  name: $name,
  superclassName: ${superclass?.name},
  subclassNames: [ ${subclasses.map((e) => e.name).join(', ')} ],
  properties: [
$propertiesString
  ],
  taggedUnionProperty: $taggedUnionProperty,
  taggedUnionValue: $taggedUnionValue,
  visibleTaggedUnion: $visibleTaggedUnion,
  extraValidation: [
$extraValidationString
  ],
)''';
  }
}

/// The property [requiredPath] is required if some [conditionPath] has a value
/// in [conditionValues].
///
/// This class is special cased to cover the uses cases seen so far. If
/// different types of conditionals are needed, this class should probably be
/// extended to cover some arbitrary expression.
class ConditionallyRequired {
  final List<String> conditionPath;
  final List<String> conditionValues;
  final List<String> requiredPath;

  const ConditionallyRequired({
    required this.conditionPath,
    required this.conditionValues,
    required this.requiredPath,
  });

  @override
  String toString() =>
      '''
ConditionallyRequired(
  path: $conditionPath,
  values: $conditionValues,
  required: $requiredPath,
)''';
}

class EnumClassInfo extends ClassInfo {
  final List<EnumValue> enumValues;
  final bool isOpen;

  EnumClassInfo({
    required super.name,
    required this.enumValues,
    required this.isOpen,
  }) : super();

  @override
  String toString() {
    final enumValuesString = enumValues
        .map((p) => indentLines(p.toString(), level: 2))
        .join(',\n');
    return '''
$runtimeType(
  name: $name,
  enumValues: [
$enumValuesString
  ],
  isOpen: $isOpen
)''';
  }
}

class EnumValue {
  final String jsonValue;
  final String name;

  EnumValue({required this.jsonValue, required this.name});

  @override
  String toString() =>
      '''
$runtimeType(
  name: $name,
  jsonValue: $jsonValue
)''';
}