feat(firestore): implement withCoverter

docs/migrating-to-v23.md

@@ -2,7 +2,7 @@
 title: Migrating to v23
 description: Migrate to React Native Firebase v23.
 previous: /migrate-to-v22
-next: /typescript
+next: /migrate-to-v24
 ---
 
 # Firebase Crashlytics

docs/migrating-to-v24.md

@@ -0,0 +1,41 @@
+---
+title: Migrating to v24
+description: Migrate to React Native Firebase v24.
+previous: /migrate-to-v23
+---
+
+# Firestore
+
+Version 24 introduces `withConverter` functionality from Firebase JS SDK. Due to the differences in types between references and queries in namespace vs modular API, you will need to make the following changes:
+
+### modular API
+
+Modular reference and query types have been updated to support input of two generic types (`AppModelType`, `DbModelType`). Additionally, to match the JS SDK, they are now exported separately at the root, instead of through `FirebaseFirestoreTypes`.
+
+Most commonly these types will be affected: `CollectionReference`, `DocumentReference`, `DocumentSnapshot`, `QueryDocumentSnapshot`, `QuerySnapshot`, `Query`.
+
+```js
+// Previously
+import { doc, getFirestore, onSnapshot, FirebaseFirestoreTypes } from '@react-native-firebase/firestore';
+
+onSnapshot(doc(getFirestore(), 'foo', 'foo'), {
+  next: (snapshot: FirebaseFirestoreTypes.DocumentSnapshot) => {
+    console.log(snapshot.get('foo'));
+  },
+});
+```
+
+```js
+// Now
+import { doc, getFirestore, onSnapshot, DocumentSnapshot } from '@react-native-firebase/firestore';
+
+onSnapshot(doc(getFirestore(), 'foo', 'foo'), {
+  next: (snapshot: DocumentSnapshot) => {
+    console.log(snapshot.get('foo'));
+  },
+});
+```
+
+### namespace API
+
+No changes required for older namespace API.

docs/sidebar.yaml

@@ -5,6 +5,8 @@
   - '/migrating-to-v22'
 - - Migration Guide to v23
   - '/migrating-to-v23'
+- - Migration Guide to v24
+  - '/migrating-to-v24'
 - - TypeScript
   - '/typescript'
 - - Platforms

docs/typescript.md

@@ -2,7 +2,7 @@
 title: TypeScript
 description: Using TypeScript with React Native Firebase
 next: /other-platforms
-previous: /migrating-to-v22
+previous: /migrating-to-v24
 ---
 
 The React Native Firebase project comes with support for TypeScript. The project provides

packages/firestore/__tests__/firestore.test.ts

@@ -946,6 +946,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => getCountFromServer(query),
+          // @ts-expect-error Combines modular and namespace API
           () => query.count(),
           'count',
         );
@@ -958,6 +959,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => getCountFromServer(query),
+          // @ts-expect-error Combines modular and namespace API
           () => query.countFromServer(),
           'countFromServer',
         );
@@ -970,6 +972,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => endAt('foo'),
+          // @ts-expect-error Combines modular and namespace API
           () => query.endAt('foo'),
           'endAt',
         );
@@ -982,6 +985,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => endBefore('foo'),
+          // @ts-expect-error Combines modular and namespace API
           () => query.endBefore('foo'),
           'endBefore',
         );
@@ -994,6 +998,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => getDocs(query),
+          // @ts-expect-error Combines modular and namespace API
           () => query.get(),
           'get',
         );
@@ -1007,6 +1012,7 @@ describe('Firestore', function () {
         collectionRefV9Deprecation(
           // no equivalent method
           () => {},
+          // @ts-expect-error Combines modular and namespace API
           () => query.isEqual(query),
           'isEqual',
         );
@@ -1019,6 +1025,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => limit(9),
+          // @ts-expect-error Combines modular and namespace API
           () => query.limit(9),
           'limit',
         );
@@ -1031,6 +1038,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => limitToLast(9),
+          // @ts-expect-error Combines modular and namespace API
           () => query.limitToLast(9),
           'limitToLast',
         );
@@ -1043,6 +1051,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => onSnapshot(query, () => {}),
+          // @ts-expect-error Combines modular and namespace API
           () => query.onSnapshot(() => {}),
           'onSnapshot',
         );
@@ -1055,6 +1064,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => orderBy('foo', 'asc'),
+          // @ts-expect-error Combines modular and namespace API
           () => query.orderBy('foo', 'asc'),
           'orderBy',
         );
@@ -1067,6 +1077,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => startAfter('foo'),
+          // @ts-expect-error Combines modular and namespace API
           () => query.startAfter('foo'),
           'startAfter',
         );
@@ -1079,6 +1090,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => startAt('foo'),
+          // @ts-expect-error Combines modular and namespace API
           () => query.startAt('foo'),
           'startAt',
         );
@@ -1091,6 +1103,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => where('foo', '==', 'bar'),
+          // @ts-expect-error Combines modular and namespace API
           () => query.where('foo', '==', 'bar'),
           'where',
         );
@@ -1103,6 +1116,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => addDoc(query, { foo: 'bar' }),
+          // @ts-expect-error Combines modular and namespace API
           () => query.add({ foo: 'bar' }),
           'add',
         );
@@ -1115,6 +1129,7 @@ describe('Firestore', function () {
 
         collectionRefV9Deprecation(
           () => doc(query, 'bar'),
+          // @ts-expect-error Combines modular and namespace API
           () => query.doc('foo'),
           'doc',
         );
@@ -1140,6 +1155,7 @@ describe('Firestore', function () {
         const docRef = firestore.doc('some/foo');
 
         docRefV9Deprecation(
+          // @ts-expect-error Combines modular and namespace API
           () => deleteDoc(docRef),
           () => docRef.delete(),
           'delete',
@@ -1152,6 +1168,7 @@ describe('Firestore', function () {
         const docRef = firestore.doc('some/foo');
 
         docRefV9Deprecation(
+          // @ts-expect-error Combines modular and namespace API
           () => getDoc(docRef),
           () => docRef.get(),
           'get',
@@ -1177,6 +1194,7 @@ describe('Firestore', function () {
         const docRef = firestore.doc('some/foo');
 
         docRefV9Deprecation(
+          // @ts-expect-error Combines modular and namespace API
           () => onSnapshot(docRef, () => {}),
           () => docRef.onSnapshot(() => {}),
           'onSnapshot',
@@ -1189,6 +1207,7 @@ describe('Firestore', function () {
         const docRef = firestore.doc('some/foo');
 
         docRefV9Deprecation(
+          // @ts-expect-error Combines modular and namespace API
           () => setDoc(docRef, { foo: 'bar' }),
           () => docRef.set({ foo: 'bar' }),
           'set',
@@ -1201,6 +1220,7 @@ describe('Firestore', function () {
         const docRef = firestore.doc('some/foo');
 
         docRefV9Deprecation(
+          // @ts-expect-error Combines modular and namespace API
           () => updateDoc(docRef, { foo: 'bar' }),
           () => docRef.update({ foo: 'bar' }),
           'update',