synckit 0.3.13

synckit: ^0.3.13 copied to clipboard

New Features #

• [History]: Made History object immutable and added updateLastSyncWithNetworkFetchTime() method that returns a new History instance.
• [SyncConfig]: Added onHistoryUpdate callback that is triggered whenever the history is updated in SyncedState.
• [SyncedState]: Updated to use the immutable History pattern and invoke onHistoryUpdate callback.
• [SyncManager]: Updated to use the immutable History pattern and added onHistoryUpdate callback.

New Features #

• [History]: Added a new History object with lastSyncWithNetworkFetchTime and updateLastSyncWithNetworkFetchTime() to track the latest successful network fetch sync time.
• [SyncManager]: Added history to track lastSyncWithNetworkFetchTime whenever network fetch/listen/query operations sync data to local storage.
• [SyncedState]: Added history updates in refresh, keepAllInSync, keepQueryInSync, and getQueryFromNetwork after network data is applied to state.

• [NetworkStorage]: Fixed a bug in writeRules where on executing writeRuels it was throwing error, instead now it will only log.

• [NetworkStorage]: Added writeRules parameter to NetworkStorage. Allowing users to apply custom rules, to filter out records, that should not be synced to Network Storage.

Bug Fixes #

• [SyncedState]: Fixed a bug in SyncedState where subscriptions were not being added to the _subscriptions list, causing them to not be properly disposed and leading to potential memory leaks.

New Features #

• [NetworkStorage]: Added streamAll and streamQuery methods to support real-time data synchronization from Firestore.
• [SyncManager]: Added listenAllFromNetwork and listenQueryFromNetwork methods to subscribe to network changes and automatically synchronize with local storage.
• [SyncedState]: Added keepAllInSync and keepQueryInSync methods to simplify real-time UI updates from your state notifier.
• [SyncedState]: Added dispose method to cancel all active subscriptions and prevent memory leaks.

• [SyncedState] Added stateOnly option for remove and clear function, if set to true, the update will not be applied to local and network storage.

• [SyncedState] Added stateOnly option for update function, if set to true, the update will not be applied to local and network storage.

New Features #

• [LocalStorage]: Added LocalStorage.disabled() constructor and disabled parameter, mirroring NetworkStorage.disabled. When disabled, read operations (getAll) throw PlatformException with code SYNC_OBJ_LOCAL_DISABLED, and write operations (update, delete, clear) and initialize() are no-ops. Use this for network-only sync with no local persistence.

• [SyncedState]: refresh() now handles local read failure (e.g. when local storage is disabled) in the same way as network failure: a try/catch around allFromStorage sets state to empty on throw, then the existing try/catch around fetchAndSyncFromNetwork runs. Network-only setups work without special-casing in SyncManager.

New Features #

• [LocalStorage]: Added initializeCallback parameter that accepts an optional Future<void> Function() to be called after Hive box initialization.
• The initialize() method now calls the provided callback after completing the default initialization process.

New Features #

Custom Query Fetch Support

Added getQueryFromNetwork method for fetching data from network using custom Firestore queries.

• [NetworkStorage]: Enhanced getQuery method with optional maxGetAllDocs parameter to override the default limit per call.

• [SyncManager]: Added getQueryFromNetwork(QueryFn<T> queryFn, [int? maxGetAllDocs]) method that fetches data using a custom query and optionally syncs with local storage.

• [SyncedState]: Added getQueryFromNetwork(QueryFn<T> queryFn, {int? maxGetAllDocs}) method that fetches data using a custom query and updates state with new entries.

Added method isInitialized to both [SyncManager] and [LocalStorage] to check if they have been initialized.

New Features #

Batch Clear Support

Added batchClear method to perform clear operations within a Firestore write batch, complementing the existing batchUpdate and batchRemove operations.

• [NetworkStorage]: Added writeBatchClear(WriteBatch batch, [String? docPath]) method:

  • For collection-based storage: fetches all documents and adds delete operations for each to the batch.
  • For non-collection-based storage: adds a delete operation for the document at the given path.
  • Note: This method is async as collection-based mode requires fetching document references.

• [SyncManager]: Added batchClear(SyncBatch syncBatch) method that queues clear operations on the network batch, waits for batch commit, then clears local storage.

• [SyncedState]: Added batchClear(SyncBatch batch) method that queues a clear operation in the batch and clears local state. Note: Call batch.commit() after all batch operations.

New Features #

Batch Operations Support

Added support for batch operations to perform multiple updates/deletes in a single Firestore write batch, improving performance and ensuring atomicity.

• [SyncBatch]: New class wrapping Firestore WriteBatch with a Completer<void> for async completion tracking.

  • batch: The underlying Firestore WriteBatch.
  • completer: A Completer<void> that completes when the batch is committed.
  • commit(): Commits the batch and completes the completer.

• [SyncManager]: Added batch operation methods:

  • batchUpdate(Dataset<T> data, SyncBatch syncBatch): Performs a batch update operation using the provided SyncBatch. Updates network first, waits for batch commit, then updates local storage.
  • batchRemove(Dataset<T> data, SyncBatch syncBatch): Performs a batch remove operation using the provided SyncBatch. Deletes from network first, waits for batch commit, then deletes from local storage.

• [SyncedState]: Added batch operation methods:

  • batchUpdate(T value, SyncBatch batch): Queues a value update in the batch and updates local state immediately. Note: Call batch.commit() after all batch operations.
  • batchRemoveAll(Iterable<String> ids, SyncBatch batch): Queues removal of multiple items by IDs in the batch and updates local state immediately.

Fixed bug of syncLocalWithNetworkOnFetch not working.

Breaking Changes #

• [NetworkStorage]: Renamed defaultDocPath parameter to path for better clarity and consistency.

New Features #

Collection-Based Storage Mode

Added support for collection-based storage in NetworkStorage, where each record is stored as a separate Firestore document instead of all records in a single document. This is useful for larger datasets or when you need to query individual records.

• New collectionBased parameter in NetworkStorage constructor to enable collection-based mode.
• New NetworkStorageCollectionBasedConfig<T> class for configuring collection-based storage:
  • getAllEnabled: Controls whether getAll is allowed for collection-based storage (default: true).
  • maxGetAllDocs: Maximum number of documents to fetch in getAll operations (default: 10).
  • defaultQuery: Default query function (QueryFn<T>) for filtering/ordering documents.
• New QueryFn<T> typedef: Query<T> Function(Query<T> colRef) for custom query builders.
• New getQuery method in NetworkStorage for querying collection-based storage with custom Firestore queries.

Sync Improvements

• [SyncManager]: Added syncLocalWithNetworkOnFetch parameter (default: true) to control whether local storage should be synchronized with network data on fetch operations.
• [SyncManager]: Added new fetchAndSyncFromNetwork getter that fetches data from the network and optionally clears and updates local storage to match.
• [SyncedState]: The refresh method now uses fetchAndSyncFromNetwork instead of allFromNetwork, ensuring local storage stays in sync with network data.
• [SyncedState]: Changed _params from late final to late to allow reassignment/reconfiguration.

Bug Fixes #

• [NetworkStorage.getAll]: Now returns an empty IMap<String, T> if the Firestore document doesn't exist, instead of throwing a null error.
• [NetworkStorage.writeBatchDelete]: Fixed return type to properly return void instead of an unintended value.

Internal Changes #

• All NetworkStorage methods (update, transactionUpdate, writeBatchUpdate, delete, transactionDelete, writeBatchDelete, clear) now fully support collection-based mode.
• Collection-based operations use WriteBatch for efficient bulk operations.
• Added Firestore withConverter support for type-safe document operations in collection-based mode.

Updated dependencies

Added new copyWith method to [StdObjParams].

Removed flutter_riverpod dependency. This should not be a Breaking Change, since none of the functionality actually depended on flutter_riverpod.

Added new refresh method in [SyncedState].

Fixed bug in [SyncedState]'s clear method, which now clears the state as well.

Fixed a bug in [SyncedState]'s update method, with sorting enabled, causing the newly added last element in the sorted dataset, to not be visible in state.

Fixed a bug in [SyncedState]'s update method, with sorting enabled.

[Breaking Change]: Replaced [hive_flutter] with [hive_ce_flutter].

[Breaking Change]: Replaced Ref<Dataset<T>> in NotifierProviderRef<Dataset<T>> in [SyncedState].

Contain important classes like [LocalStorage], [NetworkStorage], [StdObj], [StdObjParams], [SyncManager], [Synced] etc.