Add sound page (#51)

* Add basic implementation of the SoundEventModel

* Add related parts to manage SoundModelEvents in the app state

* Add more state management related code for sounds

* Add client api to handle data manipulation for sounds

# Conflicts:
#	lib/api/api_service.dart

* Rename some actions to reflect their context

* Improve sound state classes

* Improve some SoundActions

* Add route for the sound page

* Add SoundFileSource file

* Add basic implementation to view data for a sound

* Improve base layout for sounds

* Add mockup dialog for the sound file editing

* Update SoundFileSource class

* Work on the sound modal page

* Remove Expanded usage to avoid a stacktrace

* Add new methods to the SelectedSoundView class

* Add FolderIcon widget implementation

* Add SmallFileCard widget

* Improve widget structure

* Add stateless widget for the view button on a SoundCard

* Add SoundCardButton usage

* Remove Padding and update EdgeInsets value

* Update api calls

* Update hasFiles getter to hasNoFiles

* Include SoundFileSource list to the SoundEventModel

* Add client api to handle data manipulation for sounds

* Add optional SoundFileSource variable to the event model

* Update hasFiles to hasNoFiles

* Remove fontWeight usage

* Improve TextInputCard creation

* Add sound enum entry for the navigation

* Add input formatters

* Add VolumeSection class

* Add SoundSlider class

* Update slider usage

* Improve widget structure

* Add pagination to the SoundEventModel

* Update Sound api handling

* Improve sound related redux actions

* Improve vm state for the selected sound

* Improve paginated list

* Update imports

* Work on pagination

* Rebuild some freezed files to avoid future conflicts

* Fix some lint commits

* Use initialValue instead of the deprecated value parameter

* Add base section widget

* Update section widgets

* Add input section widget for strings

* Update widget usage

* Update parameter list for a function

* Store SoundEvent in a PaginatedResult instead of a list

* Update sound vm state

* Add static access methods

* Update item access in the sound actions

* Update action calls

* Switch root widget to PaginatedBaseModelViewTabs

* Improve validator usage

* Add unit test for the folder icon

* Add constant value for a magic number

* Add missing query parameters for a pageable request

* Remove as call

* Add lazy load to the sound files page

* Add keep file

* Improve state handling

* Adjust min, max and division values to align them with the sound protocol specification from Minecraft

* Add custom value formatter to deal better with minimal default values

* Add test cases for the min value formatter

* Improve input formatting handling

* Improve widget handling

* Update imports

* Improve dialog usage

* Update logic to link a source file with an event

* Improve dialog handling to allow the update of existing sound sources

* Add endpoint and redux action to update a SoundFileSource

* Improve dialog handling when a existing model should be updated

* Retrieve given id from the old model before creating a new one without an id

* Fix cancel button usage

* Add api and redux action to delete a sound file source

* Implement test wise the delete logic

* Update delete endpoint usage for SoundSourceFiles

* Add generic tooltip message

* Fix file naming

---------

Co-authored-by: theEvilReaper <[email protected]>
Co-authored-by: Joltras <[email protected]>

Author: theEvilReaper

lib/api/api_service.dart

@@ -1,6 +1,8 @@
 import 'package:stelaris/api/api_client.dart';
 import 'package:stelaris/api/base_api.dart';
+import 'package:stelaris/api/service/client/sound_client_api.dart';
 import 'package:stelaris/api/client_api.dart';
+import 'package:stelaris/api/model/sound/sound_event_model.dart';
 import 'package:stelaris/api/model/attribute_model.dart';
 import 'package:stelaris/api/model/notification_model.dart';
 import 'package:stelaris/api/service/font_api.dart';
@@ -40,6 +42,10 @@ class ApiService {
     toJson: (model) => model.toJson(),
   );
 
+  late final ClientAPI<SoundEventModel> soundApi = SoundClientApi(
+    apiClient: _apiClient,
+  );
+
   /// Creates an instance of [ApiClient] with the backend URL.
   ApiClient _createApiClient() => ApiClient(Environment.backendURl);
 

lib/api/model/sound/sound_event_model.dart

@@ -0,0 +1,42 @@
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:stelaris/api/model/data_model.dart';
+import 'package:stelaris/api/model/sound/sound_file_source.dart';
+import 'package:stelaris/api/paginated_result.dart';
+
+part 'sound_event_model.freezed.dart';
+
+part 'sound_event_model.g.dart';
+
+SoundEventModel soundEventFromJson(dynamic json) =>
+    SoundEventModel.fromJson(json);
+
+Map<String, dynamic> soundEventToJson(SoundEventModel model) => model.toJson();
+
+@freezed
+abstract class SoundEventModel with _$SoundEventModel, DataModel {
+  const SoundEventModel._();
+
+  // Define the specific const default directly within the class that uses it.
+  // This is well-encapsulated.
+  static const PaginatedResult<SoundFileSource> _defaultFiles = PaginatedResult(
+    items: <SoundFileSource>[],
+    totalItems: 0,
+    totalPages: 0,
+    currentPage: 1,
+    pageSize: 0,
+  );
+
+  factory SoundEventModel({
+    required String uiName,
+    String? id,
+    String? variableName,
+    String? keyName,
+    String? subTitle,
+    @Default(SoundEventModel._defaultFiles)
+    PaginatedResult<SoundFileSource> files,
+    @Default(false) @JsonKey(includeToJson: false) bool isLoading,
+  }) = _SoundEventModel;
+
+  factory SoundEventModel.fromJson(Map<String, dynamic> json) =>
+      _$SoundEventModelFromJson(json);
+}