Changes on Reports and new datasource

PHKenny · PHKenny · commit 1486c1f8d028 · 2025-12-02T23:49:36.000-06:00
diff --git a/.flutter-plugins-dependencies b/.flutter-plugins-dependencies
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 3.5.1
+
+- Renamed `ReportTemplateSource` to `ReportSource` enum, also, added `ReportTemplateSource` as typedef to avoid breaking changes.
+- Renamed `ReportTemplateAlgorithm` to `ReportAlgorithm` enum, also, added `ReportTemplateAlgorithm` as typedef to avoid breaking changes.
+
 ## 3.5.0+1
 
 - Modified `ApiResponse<T>` generic class to also include a second generic type `Q` for error representation.
diff --git a/lib/src/api/src/response.dart b/lib/src/api/src/response.dart
@@ -12,5 +12,9 @@ abstract class ApiResponse<T, Q> with _$ApiResponse<T, Q> {
     Map<String, dynamic> json,
     T Function(Object?) fromJsonT,
     Q Function(Object?) fromJsonQ,
-  ) => _$ApiResponseFromJson(json, fromJsonT, fromJsonQ);
+  ) => _$ApiResponseFromJson(
+    json,
+    fromJsonT,
+    fromJsonQ,
+  );
 }
diff --git a/lib/src/charts/charts.g.dart b/lib/src/charts/charts.g.dart
diff --git a/lib/src/charts/src/chart_data_source.dart b/lib/src/charts/src/chart_data_source.dart
@@ -13,7 +13,10 @@ enum ChartDataSource {
   @JsonValue('ATS_OPERATIONS')
   atsOperations,
   @JsonValue('ATS_PURCHASEORDERS')
-  atsPurchaseOrders;
+  atsPurchaseOrders,
+  @JsonValue('LAST_MESSAGES')
+  lastMessages,
+  ;
 
   @override
   String toString() => toJson();
@@ -39,6 +42,8 @@ enum ChartDataSource {
         return "ATS_OPERATIONS";
       case ChartDataSource.atsPurchaseOrders:
         return "ATS_PURCHASEORDERS";
+      case ChartDataSource.lastMessages:
+        return "LAST_MESSAGES";
     }
   }
 }
diff --git a/lib/src/reports/reports.freezed.dart b/lib/src/reports/reports.freezed.dart
diff --git a/lib/src/reports/reports.g.dart b/lib/src/reports/reports.g.dart
diff --git a/lib/src/reports/src/enums/algorithm.dart b/lib/src/reports/src/enums/algorithm.dart
@@ -1,22 +1,26 @@
 part of '../../reports.dart';
 
+@Deprecated('Use ReportAlgorithm instead')
+typedef ReportTemplateAlgorithm = ReportAlgorithm;
+
 @JsonEnum(alwaysCreate: true)
-enum ReportTemplateAlgorithm {
+enum ReportAlgorithm {
   /// Is the report template algorithm for AUTO
   @JsonValue('AUTO')
   auto,
 
   /// Is the report template algorithm for PYTHON
   @JsonValue('PYTHON')
-  python;
+  python
+  ;
 
   @override
   String toString() => toJson();
 
-  String toJson() => _$ReportTemplateAlgorithmEnumMap[this] ?? 'AUTO';
+  String toJson() => _$ReportAlgorithmEnumMap[this] ?? 'AUTO';
 
-  static ReportTemplateAlgorithm fromJson(String json) {
-    return _$ReportTemplateAlgorithmEnumMap.entries.firstWhereOrNull((element) => element.value == json)?.key ??
-        ReportTemplateAlgorithm.auto;
+  static ReportAlgorithm fromJson(String json) {
+    return _$ReportAlgorithmEnumMap.entries.firstWhereOrNull((element) => element.value == json)?.key ??
+        ReportAlgorithm.auto;
   }
 }
diff --git a/lib/src/reports/src/enums/source.dart b/lib/src/reports/src/enums/source.dart
@@ -1,34 +1,42 @@
 part of '../../reports.dart';
 
+@Deprecated('Use ReportSource instead')
+typedef ReportTemplateSource = ReportSource;
+
 @JsonEnum(alwaysCreate: true)
-enum ReportTemplateSource {
-  /// Is the report template source for messages
+enum ReportSource {
+  /// Is the source for messages
   @JsonValue('MESSAGES')
   messages,
 
-  /// Is the report template source for cases
+  /// Is the source for cases
   @JsonValue('CASES')
   cases,
 
-  /// Is the report template source for checkpoints
+  /// Is the source for checkpoints
   @JsonValue('CHECKPOINTS')
   checkpoints,
 
-  /// Is the report template source for events
+  /// Is the source for events
   @JsonValue('EVENTS')
   events,
 
-  /// Is the report template source for outbound services' broadcast
+  /// Is the source for outbound services' broadcast
   @JsonValue('BROADCASTS')
-  broadcast;
+  broadcast,
+
+  /// Is the source for Last Messages, similar to [messages] but only the latest message per asset
+  @JsonValue('LAST_MESSAGES')
+  lastMessages,
+  ;
 
   @override
   String toString() => toJson();
 
-  String toJson() => _$ReportTemplateSourceEnumMap[this] ?? 'MESSAGES';
+  String toJson() => _$ReportSourceEnumMap[this] ?? 'MESSAGES';
 
-  static ReportTemplateSource fromJson(String json) {
-    return _$ReportTemplateSourceEnumMap.entries.firstWhereOrNull((element) => element.value == json)?.key ??
-        ReportTemplateSource.messages;
+  static ReportSource fromJson(String json) {
+    return _$ReportSourceEnumMap.entries.firstWhereOrNull((element) => element.value == json)?.key ??
+        ReportSource.messages;
   }
 }
diff --git a/lib/src/reports/src/page.dart b/lib/src/reports/src/page.dart
@@ -9,17 +9,15 @@ abstract class ReportTemplatePage with _$ReportTemplatePage {
     required String title,
 
     /// Is the page source
-    @JsonKey(unknownEnumValue: ReportTemplateSource.messages) required ReportTemplateSource source,
+    @JsonKey(unknownEnumValue: ReportSource.messages) required ReportSource source,
 
     /// Is the algorithm used to generate the page data.
-    @JsonKey(unknownEnumValue: ReportTemplateAlgorithm.auto)
-    @Default(ReportTemplateAlgorithm.auto)
-    ReportTemplateAlgorithm algorithm,
+    @JsonKey(unknownEnumValue: ReportAlgorithm.auto) @Default(ReportAlgorithm.auto) ReportAlgorithm algorithm,
 
-    /// Is the page data, aka, the cols. Only used when [algorithm] is [ReportTemplateAlgorithm.auto]
+    /// Is the page data, aka, the cols. Only used when [algorithm] is [ReportAlgorithm.auto]
     List<ReportTemplateCol>? cols,
 
-    /// Is the script in Python to generate the page data. Only used when [algorithm] is [ReportTemplateAlgorithm.python]
+    /// Is the script in Python to generate the page data. Only used when [algorithm] is [ReportAlgorithm.python]
     String? script,
   }) = _ReportTemplatePage;
 
@@ -31,12 +29,8 @@ abstract class ReportTemplatePageInput with _$ReportTemplatePageInput {
   const ReportTemplatePageInput._();
   factory ReportTemplatePageInput({
     @Default('Page') String title,
-    @JsonKey(unknownEnumValue: ReportTemplateSource.messages)
-    @Default(ReportTemplateSource.messages)
-    ReportTemplateSource source,
-    @JsonKey(unknownEnumValue: ReportTemplateAlgorithm.auto)
-    @Default(ReportTemplateAlgorithm.auto)
-    ReportTemplateAlgorithm algorithm,
+    @JsonKey(unknownEnumValue: ReportSource.messages) @Default(ReportSource.messages) ReportSource source,
+    @JsonKey(unknownEnumValue: ReportAlgorithm.auto) @Default(ReportAlgorithm.auto) ReportAlgorithm algorithm,
     @Default([]) List<ReportTemplateColInput> cols,
     @Default('') String script,
   }) = _ReportTemplatePageInput;
diff --git a/lib/src/reports/src/report.dart b/lib/src/reports/src/report.dart
@@ -13,12 +13,16 @@ abstract class ReportTemplate with _$ReportTemplate {
     /// Structure
     List<ReportTemplatePage>? structure,
 
-    /// Is the report template linked assets or assets' IDs
+    /// Is the report template linked assets or assets
     List<Asset>? assets,
+
+    /// Is the report template linked assets or assets' IDs
     List<String>? assetsIds,
 
-    /// Is the report template linked outbound services or outbound services' IDs
+    /// Is the report template linked outbound services or outbound services
     List<OutboundService>? outboundServices,
+
+    /// Is the report template linked outbound services or outbound services' IDs
     List<String>? outboundServicesIds,
 
     /// Controls the access of this entity.
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 description: Layrz API models for Dart/Flutter. This package contains the models used by the Layrz API.
 name: layrz_models
-version: "3.5.0+1"
+version: "3.5.1"
 repository: https://github.com/goldenm-software/layrz_models
 
 environment:
@@ -17,17 +17,17 @@ dependencies:
   recase: ^4.1.0
   latlong2: ^0.9.1
   layrz_icons: ^1.0.3
-  freezed_annotation: ^3.0.0
+  freezed_annotation: ^3.1.0
   json_annotation: ^4.9.0
   layrz_logging: ^1.2.1
 
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  flutter_lints: ^5.0.0
-  build_runner: ^2.4.15
-  freezed: ^3.2.0
-  json_serializable: ^6.9.5
+  flutter_lints: ^6.0.0
+  build_runner: ^2.10.4
+  freezed: ^3.2.3
+  json_serializable: ^6.11.0
   test: ^1.26.2
 
 flutter:
diff --git a/test/api_test.dart b/test/api_test.dart
@@ -12,9 +12,10 @@ void main() {
     };
 
     // Deserialize
-    final apiResponse = ApiResponse<List<Model>>.fromJson(
+    final apiResponse = ApiResponse<List<Model>, Map<String, dynamic>>.fromJson(
       json,
       (json) => (json as List<dynamic>).map((e) => Model.fromJson(e as Map<String, dynamic>)).toList(),
+      (json) => (json as Map<String, dynamic>),
     );
 
     debugPrint("apiResponse=$apiResponse");
@@ -28,7 +29,10 @@ void main() {
     debugPrint("--------------");
 
     // Serialize
-    final serialized = apiResponse.toJson((value) => value.map((e) => e.toJson()).toList());
+    final serialized = apiResponse.toJson(
+      (value) => value.map((e) => e.toJson()).toList(),
+      (value) => value,
+    );
     debugPrint("serialized=$serialized");
   });
 }

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,10 @@ enum ChartDataSource {`
`13`	`13`	`@JsonValue('ATS_OPERATIONS')`
`14`	`14`	`atsOperations,`
`15`	`15`	`@JsonValue('ATS_PURCHASEORDERS')`
`16`		`- atsPurchaseOrders;`
	`16`	`+ atsPurchaseOrders,`
	`17`	`+ @JsonValue('LAST_MESSAGES')`
	`18`	`+ lastMessages,`
	`19`	`+ ;`
`17`	`20`
`18`	`21`	`@override`
`19`	`22`	`String toString() => toJson();`
`@@ -39,6 +42,8 @@ enum ChartDataSource {`
`39`	`42`	`return "ATS_OPERATIONS";`
`40`	`43`	`case ChartDataSource.atsPurchaseOrders:`
`41`	`44`	`return "ATS_PURCHASEORDERS";`
	`45`	`+ case ChartDataSource.lastMessages:`
	`46`	`+ return "LAST_MESSAGES";`
`42`	`47`	`}`
`43`	`48`	`}`
`44`	`49`	`}`