• Fixed issue #3210 (Query.orderBy(FieldPath.documentId) throws exception).
• Fixed issue #3237 (DocumentReference not being parsed correctly).
• Bump cloud_firestore_web dependency.
• Bump cloud_firestore_platform_interface dependency to fix 2 race conditions. (#3251)

• Added missing deprecated Firestore static methods.

Along with the below changes, the plugin has undergone a quality of life update to better support exceptions thrown. Any Firestore specific errors now return a FirebaseException, allowing you to directly access the code (e.g. permission-denied) and message.

Firestore:

• BREAKING: settings() is now a synchronous setter that accepts a Settings instance.
  • NEW: This change allows us to support changing Firestore settings (such as using the Firestore emulator) without having to quit the application, e.g. Hot Restarts.
• BREAKING: enablePersistence() is now a Web only method, use [Settings.persistenceEnabled] instead for other platforms.
• DEPRECATED: Calling document() is deprecated in favor of doc().
• DEPRECATED: Class Firestore is now deprecated. Use FirebaseFirestore instead.
• DEPRECATED: Calling Firestore(app: app) is now deprecated. Use FirebaseFirestore.instance or FirebaseFirestore.instanceFor(app: app) instead.
• NEW: Added clearPersistence() support.
• NEW: Added disableNetwork() support.
• NEW: Added enableNetwork() support.
• NEW: Added snapshotInSync() listener support.
• NEW: Added terminate() support.
• NEW: Added waitForPendingWrites() support.
• FIX: All document/query listeners & currently in progress transactions are now correctly torn down between Hot Restarts.

CollectionReference:

• BREAKING: Getting a collection parent document via parent() has been changed to a getter parent.
• BREAKING: Getting the collection path now always returns the path without leading and trailing slashes.
• DEPRECATED: Calling document() is deprecated in favor of doc().
• FIX: Equality checking of CollectionReference now does not depend on the original path used to create the CollectionReference.

Query:

• BREAKING: The internal query logic has been overhauled to better assert invalid queries locally.
• DEPRECATED: Calling getDocuments() is deprecated in favor of get().
• BREAKING: getDocuments/get has been updated to accept an instance of GetOptions (see below).
• NEW: Query methods can now be chained.
• NEW: It is now possible to call same-point cursor based queries without throwing (e.g. calling endAt() and then endBefore() will replace the "end" cursor query with the endBefore).
• NEW: Added support for the limitToLast query modifier.

QuerySnapshot:

• DEPRECATED: documents has been deprecated in favor of docs.
• DEPRECATED: documentChanges has been deprecated in favor of docChanges.
• NEW: docs now returns a List<QueryDocumentSnapshot> vs List<DocumentSnapshot>. This doesn't break existing functionality.

DocumentReference:

• BREAKING: setData/set has been updated to accept an instance of SetOptions (see below, supports mergeFields).
• BREAKING: get() has been updated to accept an instance of GetOptions (see below).
• BREAKING: Getting a document parent collection via parent() has been changed to a getter parent.
• BREAKING: Getting the document path now always returns the path without leading and trailing slashes.
• DEPRECATED: documentID has been deprecated in favor of id.
• DEPRECATED: setData() has been deprecated in favor of set().
• DEPRECATED: updateData() has been deprecated in favor of update().
• FIX: Equality checking of DocumentReference now does not depend on the original path used to create the DocumentReference.

DocumentChange:

• DEPRECATED: Calling document() is deprecated in favor of doc().

DocumentSnapshot:

• BREAKING: The get data getter is now a data() method instead.
• DEPRECATED: documentID has been deprecated in favor of id.
• NEW: Added support for fetching nested snapshot data via the get() method. If no data exists at the given path, a StateError will be thrown.
• FIX: NaN values stored in your Firestore instance are now correctly parsed when reading & writing data.
• FIX: INFINITY values stored in your Firestore instance are now correctly parsed when reading & writing data.
• FIX: -INFINITY values stored in your Firestore instance are now correctly parsed when reading & writing data.

WriteBatch:

• DEPRECATED: setData() has been deprecated in favor of set().
• DEPRECATED: updateData() has been deprecated in favor of update().
• BREAKING: setData/set now supports SetOptions to merge data/fields (previously this accepted a Map).

Transaction:

• BREAKING: Transactions have been overhauled to address a number of critical issues:
  • Values returned from the transaction will now be returned from the Future. Previously, only JSON serializable values were supported. It is now possible to return any value from your transaction handler, e.g. a DocumentSnapshot.
  • When manually throwing an exception, the context was lost and a generic PlatformException was thrown. You can now throw & catch on any exceptions.
  • The modify methods on a transaction (set, delete, update) were previously Futures. These have been updated to better reflect how transactions should behave - they are now synchronous and are executed atomically once the transaction handler block has finished executing.
• FIX: Timeouts will now function correctly.
• FIX: iOS: transaction completion block incorrectly resolving a FlutterResult multiple times.

See the new transactions documentation to learn more.

FieldPath:

• NEW: The constructor has now been made public to accept a List of String values. Previously field paths were accessible only via a dot-notated string path. This meant attempting to access a field in a document with a . in the name (e.g. foo.bar@gmail.com) was impossible.

GetOptions: New class created to support how data is fetched from Firestore (server, cache, serverAndCache).

SetOptions: New class created to both merge and mergeFields when setting data on documents.

GeoPoint:

• BREAKING: Add latitude and longitude validation when constructing a new GeoPoint instance.

• Clean up snapshot listeners when Android Activity is destroyed.

• Update lower bound of dart dependency to 2.0.0.

• Migrate cloud_firestore to android v2 embedding.

• Fix crash with pagination with DocumentReference (#2044)
• Minor tweaks to integ tests.

• Fix for missing UserAgent.h compilation failures.

• Support equality comparison on FieldValue instances.
• Updated version of endorsed web implementation.

• Add macOS support

• Add Web integration documentation to README.

• Fixed crashes when using FieldValue.arrayUnion & FieldValue.arrayRemove with DocumentReference objects

• Fixed decoding & encoding platform interface instances in nested maps

• Add web support by default.
• Require Flutter SDK 1.12.13+hotfix.4 or later
• Add web support to the example app.

• Fixed crashes when using Query#where with DocumentReference objects

• Migrate to cloud_firestore_platform_interface.

• Remove the deprecated author: field from pubspec.yaml
• Migrate the plugin to the pubspec platforms manifest.
• Bump the minimum Flutter version to 1.10.0.

• Added support for in and array-contains-any query operators.

• Fixed analyzer warnings about unused fields.

• Added FieldPath class and FieldPath.documentId to refer to the document id in queries.
• Added assertions and exceptions that help you building correct queries.

• Update documentation to reflect new repository location.
• Update unit tests to call TestWidgetsFlutterBinding.ensureInitialized.
• Remove executable bit on LICENSE file.

• Fix flaky integration test for includeMetadataChanges.

• Updated error handling on Android for transactions to prevent crashes.

• Fix integer conversion warnings on iOS.

• Fixes a crash on Android when running a transaction without an internet connection.

• Cast error.code to long to avoid using NSInteger as %ld format warnings.

• Updated README instructions for contributing for consistency with other Flutterfire plugins.

• New optional includeMetadataChanges parameter added to DocumentReference.snapshots() and Query.snapshots()
• Fix example app crash when the message field was not a string
• Internal renaming of method names.

• Add metadata to QuerySnapshot.

• Updated how document ids are generated to more closely match native implementations.

• Update google-services Android gradle plugin to 4.3.0 in documentation and examples.

• Methods of Transaction no longer require await.
• Added documentation to methods of Transaction.
• Removed an unnecessary log on Android.
• Added an integration test for rapidly incrementing field value.

• Support for orderBy on map fields (e.g. orderBy('cake.flavor')) for startAtDocument, startAfterDocument, endAtDocument, and endBeforeDocument added.

• Added support for combining any of Query.startAtDocument and Query.startAfterDocument with any of Query.endAtDocument and Query.endBeforeDocument.

• Automatically use version from pubspec.yaml when reporting usage to Firebase.

• Makes startAtDocument, startAfterDocument, endAtDocument and endBeforeDocument work with Query.collectionGroup queries.
• Fixes startAtDocument, startAfterDocument, endAtDocument and endBeforeDocument to also work with a descending order as the last explicit sort order.
• Fixed an integration test by increasing the value of cacheSizeBytes to a valid value.

• Added support for cacheSizeBytes to Firestore.settings.

• Ensure that all channel calls to the Dart side from the Java side are done on the UI thread. This change allows Transactions to work with upcoming Engine restrictions, which require channel calls be made on the UI thread. Note this is an Android only change, the iOS implementation was not impacted.
• Updated the Firebase reporting string to flutter-fire-fst to be consistent with other reporting libraries.

• Added support for Source to Query.getDocuments() and DocumentReference.get().

• Send user agent to Firebase.

• Bump the minimum Flutter version to 1.5.
• Replace invokeMethod with invokeMapMethod wherever necessary.

• Breaking change. Fixed CollectionReference.parent to correctly return a DocumentReference. If you were using the method previously to obtain the parent document's id via collectionReference.parent().id, you will have to use collectionReference.parent().documentID now.
• Added DocumentReference.parent.

• Update iOS CocoaPod dependencies to '~> 6.0' to ensure support for FieldValue.increment.

• REFACTOR: remove deprecated Flutter Android v1 Embedding usages, including in example app (#7158).
• STYLE: macOS & iOS; explicitly include header that defines TARGET_OS_OSX (#7116).

• BREAKING FEAT: bump iOS SDK to version 12.0.0 (#17549). (b2619e68)
• BREAKING FEAT: bump Android SDK to version 34.0.0 (#17554). (a5bdc051)

• FEAT(perf): Swift Package Manager support (#16849). (9231dd0c)

• BREAKING REFACTOR: android plugins require minSdk 21, auth requires minSdk 23 ahead of android BOM >=33.0.0 (#12873). (52accfc6)
• BREAKING REFACTOR: bump all iOS deployment targets to iOS 13 ahead of Firebase iOS SDK v11 breaking change (#12872). (de0cea2c)

• Added an integration test for transactions.

• Remove Gradle BoM to avoid Gradle version issues.

• Bump Android dependencies to latest.

0.9.10

• Support for cloud_firestore running in the background on Android.
• Fixed a bug in cleanup for DocumentReference.snapshots().
• Additional integration testing.

• Remove invokeMapMethod calls to prevent crash.

• Add metadata field to DocumentSnapshot.

• Fixes a NoSuchMethodError when using getDocuments on iOS (introduced in 0.9.6).
• Adds a driver test for getDocuments.

• Bump the minimum Flutter version to 1.2.0.
• Add template type parameter to invokeMethod calls.

• On iOS, update null checking to match the recommended pattern usage in the Firebase documentation.
• Fixes a case where snapshot errors might result in plugin crash.