feat: 1072 - Add Nutri-Score details

lib/openfoodfacts.dart

@@ -26,6 +26,12 @@ export 'src/model/nutrient_modifier.dart';
 export 'src/model/nutrient.dart';
 export 'src/model/nutrient_levels.dart';
 export 'src/model/nutriments.dart';
+export 'src/model/nutriscore/nutriscore.dart';
+export 'src/model/nutriscore/nutriscore_data_2021.dart';
+export 'src/model/nutriscore/nutriscore_data_2023.dart';
+export 'src/model/nutriscore/nutriscore_detail_2021.dart';
+export 'src/model/nutriscore/nutriscore_detail_2023.dart';
+export 'src/model/nutriscore/nutriscore_details.dart';
 
 // export 'src/model/product_list.dart'; // not needed
 export 'src/model/ocr_ingredients_result.dart';

lib/src/model/nutriscore/nutriscore.dart

@@ -0,0 +1,135 @@
+import 'package:openfoodfacts/openfoodfacts.dart';
+
+enum NutriScoreCategory2021 {
+  general,
+  cheese,
+  fat,
+  beverage,
+  water,
+}
+
+enum NutriScoreCategory2023 {
+  general,
+  cheese,
+  redMeatProduct,
+  fatOilNutsSeeds,
+  beverage,
+  water,
+}
+
+enum NutriScoreGrade { A, B, C, D, E }
+
+enum NutriScoreInput { category, nutrients, ingredients }
+
+typedef NutriScore2021 = _NutriScore<NutriScoreCategory2021>;
+typedef NutriScore2023 = _NutriScore<NutriScoreCategory2023>;
+
+/// Private base class for NutriScore.
+/// It is used to define the common properties and methods for both
+/// NutriScore 2021 and NutriScore 2023.
+class _NutriScore<T extends Enum> {
+  final NutriScoreGrade? grade;
+  final int? score;
+  final String? notApplicableCategory;
+  final List<NutriScoreInput> missingData;
+  final T? category;
+
+  _NutriScore({
+    this.grade,
+    this.category,
+    this.score,
+    this.notApplicableCategory,
+    this.missingData = const [],
+  }) : assert(
+          (grade != null && score != null && category != null) ||
+              (grade == null && (notApplicableCategory?.isNotEmpty ?? false)) ||
+              (grade == null && missingData.isNotEmpty),
+          'Either NutriScore is computed or not applicable or unknown',
+        );
+
+  bool get isComputed => grade != null;
+  bool get isNotApplicable => notApplicableCategory?.isNotEmpty ?? false;
+  bool get isUnknown => missingData.isNotEmpty;
+}
+
+NutriScoreGrade? _parseGrade(String? grade) {
+  switch (grade?.toLowerCase()) {
+    case 'a':
+      return NutriScoreGrade.A;
+    case 'b':
+      return NutriScoreGrade.B;
+    case 'c':
+      return NutriScoreGrade.C;
+    case 'd':
+      return NutriScoreGrade.D;
+    case 'e':
+      return NutriScoreGrade.E;
+    default:
+      return null;
+  }
+}
+
+List<NutriScoreInput> _missingData(bool? hasCategory, bool? hasNutrients) => [
+      if (hasCategory != true) NutriScoreInput.category,
+      if (hasNutrients != true) NutriScoreInput.nutrients,
+    ];
+
+extension NutriScoreDetails2021Ext on NutriScoreDetails {
+  /// Returns the NutriScore 2021 as domain model.
+  NutriScore2021? get2021() {
+    if (nutriScore2021 == null) return null;
+
+    return NutriScore2021(
+      category: nutriScore2021?.data?.category,
+      grade: _parseGrade(nutriScore2021?.grade),
+      score: nutriScore2021?.score,
+      notApplicableCategory: nutriScore2021?.notApplicableCategory,
+      missingData: _missingData(
+        nutriScore2021?.categoryAvailable,
+        nutriScore2021?.nutrientsAvailable,
+      ),
+    );
+  }
+
+  /// Returns the NutriScore 2023 as domain model.
+  NutriScore2023? get2023() {
+    if (nutriScore2023 == null) return null;
+
+    return NutriScore2023(
+      category: nutriScore2023?.data?.category,
+      grade: _parseGrade(nutriScore2023?.grade),
+      score: nutriScore2023?.score,
+      notApplicableCategory: nutriScore2023?.notApplicableCategory,
+      missingData: _missingData(
+        nutriScore2023?.categoryAvailable,
+        nutriScore2023?.nutrientsAvailable,
+      ),
+    );
+  }
+}
+
+/// Extension to infer [NutriScoreCategory2021] from boolean flags.
+extension NutriScoreData2021Ext on NutriScoreData2021 {
+  NutriScoreCategory2021 get category {
+    // water must be checked first to avoid beverage+water conflict
+    if (isWater == true) return NutriScoreCategory2021.water;
+    if (isBeverage == true) return NutriScoreCategory2021.beverage;
+    if (isFat == true) return NutriScoreCategory2021.fat;
+    if (isCheese == true) return NutriScoreCategory2021.cheese;
+    return NutriScoreCategory2021.general;
+  }
+}
+
+/// Extension to infer [NutriScoreCategory2023] from boolean flags.
+extension NutriScoreData2023Ext on NutriScoreData2023 {
+  NutriScoreCategory2023 get category {
+    // water must be checked first to avoid beverage+water conflict
+    if (isWater == true) return NutriScoreCategory2023.water;
+    if (isBeverage == true) return NutriScoreCategory2023.beverage;
+    if (isFatOilNutsSeeds == true)
+      return NutriScoreCategory2023.fatOilNutsSeeds;
+    if (isCheese == true) return NutriScoreCategory2023.cheese;
+    if (isRedMeatProduct == true) return NutriScoreCategory2023.redMeatProduct;
+    return NutriScoreCategory2023.general;
+  }
+}

lib/src/model/nutriscore/nutriscore_data_2021.dart

@@ -0,0 +1,51 @@
+import 'package:json_annotation/json_annotation.dart';
+import '../../interface/json_object.dart';
+import '../../utils/json_helper.dart';
+
+part 'nutriscore_data_2021.g.dart';
+
+/// Detailed data of NutriScore version 2021.
+@JsonSerializable()
+class NutriScoreData2021 extends JsonObject {
+  @JsonKey(
+    name: 'is_beverage',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonObject.parseBool,
+  )
+  bool? isBeverage;
+
+  @JsonKey(
+    name: 'is_cheese',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonObject.parseBool,
+  )
+  bool? isCheese;
+
+  @JsonKey(
+    name: 'is_fat',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonObject.parseBool,
+  )
+  bool? isFat;
+
+  @JsonKey(
+    name: 'is_water',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonObject.parseBool,
+  )
+  bool? isWater;
+
+  @JsonKey(name: 'negative_points')
+  int? negativePoints;
+
+  @JsonKey(name: 'positive_points')
+  int? positivePoints;
+
+  NutriScoreData2021();
+
+  factory NutriScoreData2021.fromJson(Map<String, dynamic> json) =>
+      _$NutriScoreData2021FromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$NutriScoreData2021ToJson(this);
+}

lib/src/model/nutriscore/nutriscore_data_2023.dart

@@ -0,0 +1,74 @@
+import 'package:json_annotation/json_annotation.dart';
+import '../../interface/json_object.dart';
+import '../../utils/json_helper.dart';
+
+part 'nutriscore_data_2023.g.dart';
+
+/// Detailed data of NutriScore version 2023.
+@JsonSerializable()
+class NutriScoreData2023 extends JsonObject {
+  @JsonKey(
+    name: 'count_proteins',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonHelper.boolFromJSON,
+  )
+  bool? countProteins;
+
+  @JsonKey(name: 'count_proteins_reason')
+  String? countProteinsReason;
+
+  @JsonKey(
+    name: 'is_beverage',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonObject.parseBool,
+  )
+  bool? isBeverage;
+
+  @JsonKey(
+    name: 'is_cheese',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonObject.parseBool,
+  )
+  bool? isCheese;
+
+  @JsonKey(
+    name: 'is_fat_oil_nuts_seeds',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonObject.parseBool,
+  )
+  bool? isFatOilNutsSeeds;
+
+  @JsonKey(
+    name: 'is_red_meat_product',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonObject.parseBool,
+  )
+  bool? isRedMeatProduct;
+
+  @JsonKey(
+    name: 'is_water',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonObject.parseBool,
+  )
+  bool? isWater;
+
+  @JsonKey(name: 'negative_points')
+  int? negativePoints;
+
+  @JsonKey(name: 'negative_points_max')
+  int? negativePointsMax;
+
+  @JsonKey(name: 'positive_points')
+  int? positivePoints;
+
+  @JsonKey(name: 'positive_points_max')
+  int? positivePointsMax;
+
+  NutriScoreData2023();
+
+  factory NutriScoreData2023.fromJson(Map<String, dynamic> json) =>
+      _$NutriScoreData2023FromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$NutriScoreData2023ToJson(this);
+}

lib/src/model/nutriscore/nutriscore_detail_2021.dart

@@ -0,0 +1,58 @@
+import 'package:json_annotation/json_annotation.dart';
+import '../../interface/json_object.dart';
+import '../../utils/json_helper.dart';
+import 'nutriscore_data_2021.dart';
+
+part 'nutriscore_detail_2021.g.dart';
+
+/// Data of NutriScore version 2021.
+@JsonSerializable(explicitToJson: true)
+class NutriScoreDetail2021 extends JsonObject {
+  @JsonKey()
+  String? grade;
+
+  @JsonKey()
+  int? score;
+
+  @JsonKey()
+  NutriScoreData2021? data;
+
+  @JsonKey(name: 'not_applicable_category')
+  String? notApplicableCategory;
+
+  @JsonKey(
+    name: 'category_available',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonHelper.boolFromJSON,
+  )
+  bool? categoryAvailable;
+
+  @JsonKey(
+    name: 'nutrients_available',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonHelper.boolFromJSON,
+  )
+  bool? nutrientsAvailable;
+
+  @JsonKey(
+    name: 'nutriscore_applicable',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonHelper.boolFromJSON,
+  )
+  bool? nutriScoreApplicable;
+
+  @JsonKey(
+    name: 'nutriscore_computed',
+    toJson: JsonHelper.boolToJSON,
+    fromJson: JsonHelper.boolFromJSON,
+  )
+  bool? nutriScoreComputed;
+
+  NutriScoreDetail2021();
+
+  factory NutriScoreDetail2021.fromJson(Map<String, dynamic> json) =>
+      _$NutriScoreDetail2021FromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$NutriScoreDetail2021ToJson(this);
+}