@react-native-firebase/firestore 21.10.0 → 21.11.0

package/CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [21.11.0](https://github.com/invertase/react-native-firebase/compare/v21.10.1...v21.11.0) (2025-02-20)
+
+### Bug Fixes
+
+- **firestore, bytes:** return Bytes for modular API usage, fix deprecation ([5a29425](https://github.com/invertase/react-native-firebase/commit/5a2942517b071141306d675a8501f7d23d87af55))
+
+## [21.10.1](https://github.com/invertase/react-native-firebase/compare/v21.10.0...v21.10.1) (2025-02-18)
+
+### Bug Fixes
+
+- **firestore:** implement queryEqual modular API ([2f855a6](https://github.com/invertase/react-native-firebase/commit/2f855a6150cc02d9d55873e63320c01424ce6434))
+- **firestore:** implement refEqual modular API ([f30a4fb](https://github.com/invertase/react-native-firebase/commit/f30a4fb87e8d65ed2ad94bf40d6f83c6bd271580))
+- **firestore:** implement snapshotEqual in modular API ([6da740f](https://github.com/invertase/react-native-firebase/commit/6da740f4b4fca988dcfcad52206af0695f3efe4f))
+- **firestore:** spread args into query to quiet deprecation ([1cf9f50](https://github.com/invertase/react-native-firebase/commit/1cf9f508832b2907e13f31d1a2fa2204ba75996c))
+
 ## [21.10.0](https://github.com/invertase/react-native-firebase/compare/v21.9.0...v21.10.0) (2025-02-11)
 
 **Note:** Version bump only for package @react-native-firebase/firestore

package/lib/FirestoreBlob.js

@@ -18,7 +18,7 @@
 import { Base64, isString } from '@react-native-firebase/app/lib/common';
 
 export default class FirestoreBlob {
-  constructor(internal = false, binaryString) {
+  constructor(internal = false, binaryString = undefined) {
     if (internal === false) {
       throw new Error(
         'firebase.firestore.Blob constructor is private, use Blob.<field>() instead.',

package/lib/FirestoreQuerySnapshot.js

@@ -112,7 +112,8 @@ export default class FirestoreQuerySnapshot {
     }
   }
 
-  isEqual(other) {
+  // send '...args' through as it may contain our namespace deprecation marker
+  isEqual(other, ...args) {
     if (!(other instanceof FirestoreQuerySnapshot)) {
       throw new Error(
         "firebase.firestore() QuerySnapshot.isEqual(*) 'other' expected a QuerySnapshot instance.",
@@ -134,7 +135,8 @@ export default class FirestoreQuerySnapshot {
       const thisDoc = this.docs[i];
       const otherDoc = other.docs[i];
 
-      if (!thisDoc.isEqual(otherDoc)) {
+      // send '...args' through as it may contain our namespace deprecation marker
+      if (!thisDoc.isEqual(otherDoc, ...args)) {
         return false;
       }
     }

package/lib/modular/Bytes.d.ts

@@ -1,4 +1,4 @@
-export declare class Bytes {
+export declare class Bytes extends FirestoreBlob {
   static fromBase64String(base64: string): Bytes;
 
   static fromUint8Array(array: Uint8Array): Bytes;

package/lib/modular/Bytes.js

@@ -1,15 +1,18 @@
-import { firebase } from '../index';
+import FirestoreBlob from '../FirestoreBlob';
 
 /**
  * An immutable object representing an array of bytes.
  */
-export class Bytes {
+export class Bytes extends FirestoreBlob {
   /**
    * @hideconstructor
    * @param {firebase.firestore.Blob} blob
    */
   constructor(blob) {
-    this._blob = blob;
+    super(true);
+    // binary string was already parsed and created, potentially expensive
+    // don't parse it again, just set it into the new FirebaseBlob
+    this._binaryString = blob._binaryString;
   }
 
   /**
@@ -17,7 +20,7 @@ export class Bytes {
    * @returns {Bytes}
    */
   static fromBase64String(base64) {
-    return new Bytes(firebase.firestore.Blob.fromBase64String(base64));
+    return new Bytes(FirestoreBlob.fromBase64String(base64));
   }
 
   /**
@@ -25,21 +28,21 @@ export class Bytes {
    * @returns {Bytes}
    */
   static fromUint8Array(array) {
-    return new Bytes(firebase.firestore.Blob.fromUint8Array(array));
+    return new Bytes(FirestoreBlob.fromUint8Array(array));
   }
 
   /**
    * @returns {string}
    */
   toBase64() {
-    return this._blob.toBase64();
+    return super.toBase64();
   }
 
   /**
    * @returns {Uint8Array}
    */
   toUint8Array() {
-    return this._blob.toUint8Array();
+    return super.toUint8Array();
   }
 
   /**
@@ -54,6 +57,6 @@ export class Bytes {
    * @returns {boolean}
    */
   isEqual(other) {
-    return this._blob.isEqual(other._blob);
+    return super.isEqual(other);
   }
 }

package/lib/modular/index.d.ts

@@ -275,6 +275,22 @@ export function collection(
   ...pathSegments: string[]
 ): CollectionReference<DocumentData>;
 
+/**
+ *Returns true if the provided references are equal.
+ *
+ * @param left	DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>	A reference to compare.
+ * @param right	DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>	A reference to compare.
+ * @return boolean true if the references point to the same location in the same Firestore database.
+ */
+export declare function refEqual<AppModelType, DbModelType extends DocumentData>(
+  left:
+    | DocumentReference<AppModelType, DbModelType>
+    | CollectionReference<AppModelType, DbModelType>,
+  right:
+    | DocumentReference<AppModelType, DbModelType>
+    | CollectionReference<AppModelType, DbModelType>,
+): boolean;
+
 /**
  * Creates and returns a new `Query` instance that includes all documents in the
  * database that are contained in a collection or subcollection with the

package/lib/modular/index.js

@@ -71,6 +71,15 @@ export function collection(parent, path, ...pathSegments) {
   return parent.collection.call(parent, path, MODULAR_DEPRECATION_ARG);
 }
 
+/**
+ * @param {DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>} left
+ * @param {DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>} right
+ * @return boolean true if the two references are equal
+ */
+export function refEqual(left, right) {
+  return left.isEqual.call(left, right, MODULAR_DEPRECATION_ARG);
+}
+
 /**
  * @param {Firestore} firestore
  * @param {string} collectionId

package/lib/modular/query.js

@@ -28,7 +28,7 @@ class QueryConstraint {
   }
 
   _apply(query) {
-    return query[this.type].apply(query, this._args, MODULAR_DEPRECATION_ARG);
+    return query[this.type].call(query, ...this._args, MODULAR_DEPRECATION_ARG);
   }
 }
 
@@ -224,3 +224,12 @@ export function getDocsFromServer(query) {
 export function deleteDoc(reference) {
   return reference.delete.call(reference, MODULAR_DEPRECATION_ARG);
 }
+
+/**
+ * @param {Query} left
+ * @param {Query} right
+ * @returns boolean true if left equals right
+ */
+export function queryEqual(left, right) {
+  return left.isEqual.call(left, right, MODULAR_DEPRECATION_ARG);
+}

package/lib/modular/snapshot.d.ts

@@ -201,3 +201,29 @@ export function onSnapshot<T>(
   onError?: (error: FirestoreError) => void,
   onCompletion?: () => void,
 ): Unsubscribe;
+
+/**
+ * Returns true if the provided snapshots are equal.
+ *
+ * @param left	DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>	A snapshot to compare.
+ * @param right	DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>	A snapshot to compare.
+ *
+ * @returns boolean true if the snapshots are equal.
+ */
+export function snapshotEqual<AppModelType, DbModelType extends DocumentData>(
+  left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>,
+  right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>,
+): boolean;
+
+/**
+ * Returns true if the provided queries point to the same collection and apply the same constraints.
+ *
+ * @param left	Query<AppModelType, DbModelType> A Query to compare.
+ * @param right	Query<AppModelType, DbModelType> A Query to compare.
+ *
+ * @return boolean true if the references point to the same location in the same Firestore database.
+ */
+export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(
+  left: Query<AppModelType, DbModelType>,
+  right: Query<AppModelType, DbModelType>,
+): boolean;

package/lib/modular/snapshot.js

@@ -14,3 +14,7 @@ import { MODULAR_DEPRECATION_ARG } from '../../../app/lib/common';
 export function onSnapshot(reference, ...args) {
   return reference.onSnapshot.call(reference, ...args, MODULAR_DEPRECATION_ARG);
 }
+
+export function snapshotEqual(left, right) {
+  return left.isEqual.call(left, right, MODULAR_DEPRECATION_ARG);
+}

package/lib/utils/serialize.js

@@ -31,6 +31,7 @@ import FirestoreGeoPoint from '../FirestoreGeoPoint';
 import FirestorePath from '../FirestorePath';
 import FirestoreTimestamp from '../FirestoreTimestamp';
 import { getTypeMapInt, getTypeMapName } from './typemap';
+import { Bytes } from '../modular/Bytes';
 
 // To avoid React Native require cycle warnings
 let FirestoreDocumentReference = null;
@@ -179,7 +180,8 @@ export function generateNativeData(value, ignoreUndefined) {
       return getTypeMapInt('timestamp', [value.seconds, value.nanoseconds]);
     }
 
-    if (value instanceof FirestoreBlob) {
+    // Modular API uses Bytes instead of Blob
+    if (value instanceof FirestoreBlob || value instanceof Bytes) {
       return getTypeMapInt('blob', value.toBase64());
     }
 
@@ -276,7 +278,7 @@ export function parseNativeData(firestore, nativeArray) {
     case 'timestamp':
       return new FirestoreTimestamp(value[0], value[1]);
     case 'blob':
-      return FirestoreBlob.fromBase64String(value);
+      return Bytes.fromBase64String(value);
     default:
       // eslint-disable-next-line no-console
       console.warn(`Unknown data type received from native channel: ${type}`);

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '21.10.0';
+module.exports = '21.11.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/firestore",
-  "version": "21.10.0",
+  "version": "21.11.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - Cloud Firestore is a NoSQL cloud database to store and sync data between your React Native application and Firebase's database. The API matches the Firebase Web SDK whilst taking advantage of the native SDKs performance and offline capabilities.",
   "main": "lib/index.js",
@@ -27,10 +27,10 @@
     "firestore"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "21.10.0"
+    "@react-native-firebase/app": "21.11.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3fd30c09b2eb7d60a6ac7f6f906673a12b7bc1a7"
+  "gitHead": "082a1e496cb1f8496f53869d9ab9e6f88ecbdc00"
 }