Merge pull request #3 from ShishkinDaniil/feature/add-stream-sync-sta…

…te-info

Add new class for getting info about sync

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [1.3.0] - 2023-12-12
+
+* Added class `SyncStateInfo` describing the current synchronization state and errors.
+* Add `state` getter.
+
 ## [1.2.1] - 2023-03-01
 
 * Add `debugDoNotSendChanges()` method.

lib/in_sync_interface.dart

@@ -1,3 +1,4 @@
 library in_sync_interface;
 
 export 'src/sync_repository.dart';
+export 'src/sync_state_info.dart';

lib/src/sync_repository.dart

@@ -1,3 +1,5 @@
+import 'package:in_sync_interface/src/sync_state_info.dart';
+
 /// The reposotory for work with synchronization.
 ///
 /// By default the synchronization is off (see. [isEnabled]),
@@ -56,4 +58,7 @@ abstract class SyncRepository {
 
   /// Used to release the memory allocated to variables when the repository is no longer in use.
   Future<void> dispose();
+
+  /// Returns the synchronization job status stream.
+  Stream<SyncStateInfo> get state;
 }

lib/src/sync_state_info.dart

@@ -0,0 +1,111 @@
+/// Synchronization status information, including errors.
+class SyncStateInfo {
+  final SyncState state;
+  final SyncError? syncError;
+
+  const SyncStateInfo(
+    this.state, {
+    this.syncError,
+  });
+
+  /// Fatal error.
+  bool get isFatalError =>
+      syncError == SyncError.authIncorrectCriticalVersion ||
+      syncError == SyncError.syncIncorrectData ||
+      syncError == SyncError.syncFieldNotFound ||
+      syncError == SyncError.syncEmptyFile;
+
+  /// Temporary error.
+  bool get isTemporaryError =>
+      syncError == SyncError.syncBlocked ||
+      syncError == SyncError.syncTemporarilyImpossible ||
+      syncError == SyncError.networkError ||
+      syncError == SyncError.syncInternalSyncError ||
+      syncError == SyncError.temporaryServerError;
+}
+
+/// Synchronization error name.
+enum SyncError {
+  /// Unsupported client version.
+  authIncorrectCriticalVersion,
+
+  /// The transmitted data is incorrect.
+  syncIncorrectData,
+
+  /// Synchronization is blocked.
+  ///
+  /// Another client is synchronizing.
+  syncBlocked,
+
+  /// Error while saving data.
+  ///
+  /// Internal error when saving on the server.
+  syncNotSaved,
+
+  /// The entity could not be found.
+  ///
+  /// The creation event was not processed on the server
+  /// this entity, so it can't update.
+  syncEntityNotFound,
+
+  /// Could not find the field.
+  ///
+  /// An entity field update was sent that the server does not know about.
+  syncFieldNotFound,
+
+  /// An empty file was transferred.
+  ///
+  /// An attempt was made to load a file of zero size.
+  syncEmptyFile,
+
+  /// Internal synchronization error on the server.
+  syncInternalSyncError,
+
+  /// Synchronization is temporarily unavailable.
+  syncTemporarilyImpossible,
+
+  /// Error updating entities.
+  updateEntityError,
+
+  /// Error downloading files.
+  downloadFilesError,
+
+  /// Network error.
+  networkError,
+
+  /// Authorisation error.
+  authError,
+
+  /// Temporary server error.
+  temporaryServerError,
+
+  /// Internal error.
+  internalError,
+
+  /// Error updating links.
+  updateLinksExeption,
+
+  /// Unknown error.
+  unknown,
+}
+
+/// Sync status.
+enum SyncState {
+  /// Initialization.
+  initializing,
+
+  /// Synchronization was completed successfully.
+  ok,
+
+  /// The last synchronization attempt failed with an error.
+  failed,
+
+  /// Synchronization is disabled.
+  disabled,
+
+  /// Synchronization in progress.
+  pending,
+
+  /// Waiting for first synchronization.
+  waiting,
+}