feat(cat-voices): proposal template models

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/proposal_schema/dtos/proposal_schema_dto.dart

@@ -0,0 +1,298 @@
+import 'package:catalyst_voices_models/src/proposal_schema/dtos/proposal_definitions_dto.dart';
+import 'package:catalyst_voices_models/src/proposal_schema/proposal_definitions.dart';
+import 'package:catalyst_voices_models/src/proposal_schema/proposal_schema.dart';
+import 'package:catalyst_voices_shared/catalyst_voices_shared.dart';
+import 'package:equatable/equatable.dart';
+import 'package:json_annotation/json_annotation.dart';
+
+part 'proposal_schema_dto.g.dart';
+
+@JsonSerializable()
+class ProposalSchemaDTO extends Equatable {
+  @JsonKey(name: r'$schema')
+  final String schema;
+  final String title;
+  final String description;
+  final ProposalDefinitionsDTO definitions;
+  final String type;
+  final bool additionalProperties;
+  @JsonKey(toJson: _toJsonProperties)
+  final List<ProposalSchemaSegmentDTO> properties;
+  @JsonKey(name: 'x-order')
+  final List<String> order;
+
+  const ProposalSchemaDTO({
+    required this.schema,
+    required this.title,
+    required this.description,
+    required this.definitions,
+    this.type = 'object',
+    this.additionalProperties = false,
+    required this.properties,
+    required this.order,
+  });
+
+  factory ProposalSchemaDTO.fromJson(Map<String, dynamic> json) {
+    final segmentsMap = json['properties'] as Map<String, dynamic>;
+    json['properties'] = segmentsMap.convertMapToListWithIds();
+
+    return _$ProposalSchemaDTOFromJson(json);
+  }
+
+  Map<String, dynamic> toJson() => _$ProposalSchemaDTOToJson(this);
+
+  ProposalSchema toModel() {
+    return ProposalSchema(
+      schema: '',
+      title: '',
+      description: '',
+      definitions: definitions.toModel(),
+      type: DefinitionsObjectTypes.fromString(type),
+      additionalProperties: false,
+      properties: [],
+      order: [],
+    );
+  }
+
+  @override
+  List<Object?> get props => [
+        schema,
+        title,
+        description,
+        definitions,
+        type,
+        additionalProperties,
+        properties,
+        order,
+      ];
+
+  static Map<String, dynamic> _toJsonProperties(
+    List<ProposalSchemaSegmentDTO> properties,
+  ) {
+    final map = <String, dynamic>{};
+    for (final property in properties) {
+      map[property.id] = property.toJson();
+    }
+    return map;
+  }
+}
+
+@JsonSerializable()
+class ProposalSchemaSegmentDTO extends Equatable {
+  @JsonKey(name: r'$ref')
+  final String ref;
+  final String id;
+  final String title;
+  final String description;
+  @JsonKey(toJson: _toJsonProperties)
+  final List<ProposalSectionDto> properties;
+  final List<String> required;
+  @JsonKey(name: 'x-order')
+  final List<String> order;
+
+  const ProposalSchemaSegmentDTO({
+    required this.ref,
+    required this.id,
+    this.title = '',
+    this.description = '',
+    required this.properties,
+    this.required = const <String>[],
+    this.order = const <String>[],
+  });
+
+  factory ProposalSchemaSegmentDTO.fromJson(Map<String, dynamic> json) {
+    final segmentsMap = json['properties'] as Map<String, dynamic>;
+    json['properties'] = segmentsMap.convertMapToListWithIds();
+
+    return _$ProposalSchemaSegmentDTOFromJson(json);
+  }
+
+  Map<String, dynamic> toJson() => _$ProposalSchemaSegmentDTOToJson(this);
+
+  ProposalSchemaSegment toModel(ProposalDefinitions definitions) {
+    final properties =
+        this.properties.map((e) => e.toModel(definitions)).toList();
+    return ProposalSchemaSegment(
+      ref: definitions.getDefinition(ref),
+      id: id,
+      title: title,
+      description: description,
+      properties: properties,
+      required: required,
+      order: order,
+    );
+  }
+
+  @override
+  List<Object?> get props => [
+        ref,
+        id,
+        title,
+        description,
+        properties,
+        required,
+        order,
+      ];
+
+  static Map<String, dynamic> _toJsonProperties(
+    List<ProposalSectionDto> properties,
+  ) {
+    final map = <String, dynamic>{};
+    for (final property in properties) {
+      map[property.id] = property.toJson();
+    }
+    return map;
+  }
+}
+
+@JsonSerializable()
+class ProposalSectionDto extends Equatable {
+  @JsonKey(name: r'$ref')
+  final String ref;
+  final String id;
+  final String title;
+  final String description;
+  final List<ProposalSchemaElementDTO> properties;
+  final List<String> required;
+  @JsonKey(name: 'x-order')
+  final List<String> order;
+  final Map<String, dynamic> dependencies; // Return to this
+  @JsonKey(name: 'if')
+  final Map<String, dynamic> ifs;
+  final Map<String, dynamic> then; // Return to this
+  @JsonKey(name: 'open_source')
+  final Map<String, dynamic> openSource; // Return to this
+
+  const ProposalSectionDto({
+    required this.ref,
+    required this.id,
+    this.title = '',
+    this.description = '',
+    required this.properties,
+    this.required = const <String>[],
+    this.order = const <String>[],
+    this.dependencies = const <String, dynamic>{},
+    this.ifs = const <String, dynamic>{},
+    this.then = const <String, dynamic>{},
+    this.openSource = const <String, dynamic>{},
+  });
+
+  factory ProposalSectionDto.fromJson(Map<String, dynamic> json) {
+    final segmentsMap = json['properties'] as Map<String, dynamic>;
+    json['properties'] = segmentsMap.convertMapToListWithIds();
+
+    return _$ProposalSectionDtoFromJson(json);
+  }
+
+  Map<String, dynamic> toJson() => _$ProposalSectionDtoToJson(this);
+
+  ProposalSchemaSection toModel(ProposalDefinitions definitions) {
+    final properties =
+        this.properties.map((e) => e.toModel(definitions)).toList();
+    return ProposalSchemaSection(
+      ref: definitions.getDefinition(ref),
+      id: id,
+      title: title,
+      description: description,
+      properties: properties,
+      required: required,
+      order: order,
+    );
+  }
+
+  @override
+  List<Object?> get props => [
+        ref,
+        id,
+        title,
+        description,
+        properties,
+        required,
+        order,
+        dependencies,
+        ifs,
+        then,
+      ];
+}
+
+@JsonSerializable()
+class ProposalSchemaElementDTO extends Equatable {
+  @JsonKey(name: r'$ref')
+  final String ref;
+  final String id;
+  final String title;
+  final String description;
+  final int? minLength;
+  final int? maxLength;
+  @JsonKey(name: 'default')
+  final String defaultValue;
+  @JsonKey(name: 'x-guidance')
+  final String guidance;
+  @JsonKey(name: 'enum')
+  final List<String> enumValues;
+  final int? maxItems;
+  final int? minItems;
+  final int? minimum;
+  final int? maximum;
+  final List<String> examples;
+  final Map<String, dynamic> items; // TODO(ryszard-shossler): return to this
+
+  const ProposalSchemaElementDTO({
+    required this.ref,
+    required this.id,
+    required this.title,
+    required this.description,
+    required this.minLength,
+    required this.maxLength,
+    this.defaultValue = '',
+    required this.guidance,
+    this.enumValues = const <String>[],
+    required this.maxItems,
+    required this.minItems,
+    required this.minimum,
+    required this.maximum,
+    this.examples = const <String>[],
+    this.items = const <String, dynamic>{},
+  });
+
+  factory ProposalSchemaElementDTO.fromJson(Map<String, dynamic> json) =>
+      _$ProposalSchemaElementDTOFromJson(json);
+
+  Map<String, dynamic> toJson() => _$ProposalSchemaElementDTOToJson(this);
+
+  ProposalSchemaElement toModel(ProposalDefinitions definitions) =>
+      ProposalSchemaElement(
+        ref: definitions.getDefinition(ref),
+        id: id,
+        title: title,
+        description: description,
+        minLength: minLength,
+        maxLength: maxLength,
+        defaultValue: defaultValue,
+        guidance: guidance,
+        enumValues: enumValues,
+        maxItems: maxItems,
+        minItems: minItems,
+        minimum: minimum,
+        maximum: maximum,
+        examples: examples,
+      );
+
+  @override
+  List<Object?> get props => [
+        ref,
+        id,
+        title,
+        description,
+        minLength,
+        maxLength,
+        defaultValue,
+        guidance,
+        enumValues,
+        maxItems,
+        minItems,
+        minimum,
+        maximum,
+        examples,
+      ];
+}