@react-native-firebase/firestore 23.8.8 → 24.0.0

package/lib/{index.d.ts → types/namespaced.ts}

@@ -47,31 +47,34 @@ import { ReactNativeFirebase } from '@react-native-firebase/app';
  *
  * @firebase firestore
  */
+// eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace FirebaseFirestoreTypes {
-  import FirebaseModule = ReactNativeFirebase.FirebaseModule;
+  type _FirebaseModule = ReactNativeFirebase.FirebaseModule;
   /**
    * An instance of Filter used to generate Firestore Filter queries.
    */
 
   export type QueryFilterType = 'OR' | 'AND';
 
-  export interface QueryFieldFilterConstraint {
+  export interface QueryFieldFilterConstraint<T extends DocumentData = DocumentData> {
     fieldPath: keyof T | FieldPath;
     operator: WhereFilterOp;
     value: any;
   }
 
-  export interface QueryCompositeFilterConstraint {
+  export interface QueryCompositeFilterConstraint<T extends DocumentData = DocumentData> {
     operator: QueryFilterType;
-    queries: QueryFieldFilterConstraint[];
+    queries: QueryFieldFilterConstraint<T>[];
   }
 
-  export type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;
+  export type QueryFilterConstraint<T extends DocumentData = DocumentData> =
+    | QueryFieldFilterConstraint<T>
+    | QueryCompositeFilterConstraint<T>;
 
   /**
    * The Filter functions used to generate an instance of Filter.
    */
-  export interface FilterFunction {
+  export interface FilterFunction<T extends DocumentData = DocumentData> {
     /**
      * The Filter function used to generate an instance of Filter.
      * e.g. Filter('name', '==', 'Ada')
@@ -80,28 +83,28 @@ export namespace FirebaseFirestoreTypes {
       fieldPath: keyof T | FieldPath,
       operator: WhereFilterOp,
       value: any,
-    ): QueryFieldFilterConstraint;
+    ): QueryFieldFilterConstraint<T>;
     /**
      * The Filter.or() static function used to generate a logical OR query using multiple Filter instances.
      * e.g. Filter.or(Filter('name', '==', 'Ada'), Filter('name', '==', 'Bob'))
      */
-    or(...queries: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
+    or(...queries: QueryFilterConstraint<T>[]): QueryCompositeFilterConstraint<T>;
     /**
      * The Filter.and() static function used to generate a logical AND query using multiple Filter instances.
      * e.g. Filter.and(Filter('name', '==', 'Ada'), Filter('name', '==', 'Bob'))
      */
-    and(...queries: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
+    and(...queries: QueryFilterConstraint<T>[]): QueryCompositeFilterConstraint<T>;
   }
   /**
    * The Filter function used to generate an instance of Filter.
    * e.g. Filter('name', '==', 'Ada')
    */
-  export const Filter: FilterFunction;
+  export declare const Filter: FilterFunction;
 
   /**
    * An immutable object representing an array of bytes.
    */
-  export class Blob {
+  export declare class Blob {
     /**
      * Creates a new Blob from the given Base64 string, converting it to bytes.
      *
@@ -145,7 +148,10 @@ export namespace FirebaseFirestoreTypes {
    * A `CollectionReference` object can be used for adding documents, getting document references, and querying for
    * documents (using the methods inherited from `Query`).
    */
-  export interface CollectionReference<T extends DocumentData = DocumentData> extends Query<T> {
+  export declare class CollectionReference<
+    AppModelType extends DocumentData = DocumentData,
+    DbModelType extends DocumentData = DocumentData,
+  > extends Query<AppModelType, DbModelType> {
     /**
      * The collection's identifier.
      */
@@ -155,7 +161,7 @@ export namespace FirebaseFirestoreTypes {
      * A reference to the containing `DocumentReference` if this is a subcollection. If this isn't a
      * subcollection, the reference is null.
      */
-    parent: DocumentReference | null;
+    parent: DocumentReference<DocumentData, DocumentData> | null;
 
     /**
      * A string representing the path of the referenced collection (relative to the root of the database).
@@ -176,7 +182,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param data An Object containing the data for the new document.
      */
-    add(data: T): Promise<DocumentReference<T>>;
+    add(data: AppModelType): Promise<DocumentReference<AppModelType, DbModelType>>;
 
     /**
      * Get a DocumentReference for the document within the collection at the specified path. If no
@@ -193,18 +199,56 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param documentPath A slash-separated path to a document.
      */
-    doc(documentPath?: string): DocumentReference<T>;
+    doc(documentPath?: string): DocumentReference<AppModelType, DbModelType>;
+
+    /**
+     * Applies a custom data converter to this CollectionReference, allowing you
+     * to use your own custom model objects with Firestore. When you call add()
+     * on the returned CollectionReference instance, the provided converter will
+     * convert between Firestore data and your custom type U.
+     *
+     * Passing in `null` as the converter parameter removes the current
+     * converter.
+     *
+     * @param converter Converts objects to and from Firestore. Passing in
+     * `null` removes the current converter.
+     * @return A CollectionReference<U> that uses the provided converter.
+     */
+    withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
+
+    /**
+     * Applies a custom data converter to this CollectionReference, allowing you
+     * to use your own custom model objects with Firestore. When you call add()
+     * on the returned CollectionReference instance, the provided converter will
+     * convert between Firestore data and your custom type U.
+     *
+     * Passing in `null` as the converter parameter removes the current
+     * converter.
+     *
+     * @param converter Converts objects to and from Firestore. Passing in
+     * `null` removes the current converter.
+     * @return A CollectionReference<U> that uses the provided converter.
+     */
+    withConverter<
+      NewAppModelType extends DocumentData,
+      NewDbModelType extends DocumentData = DocumentData,
+    >(
+      converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>,
+    ): CollectionReference<NewAppModelType, NewDbModelType>;
   }
 
   /**
    * A DocumentChange represents a change to the documents matching a query. It contains the document affected and the
    * type of change that occurred.
    */
-  export interface DocumentChange<T extends DocumentData = DocumentData> {
+  export interface DocumentChange<
+    AppModelType extends DocumentData = DocumentData,
+    DbModelType extends DocumentData = DocumentData,
+  > {
     /**
      * The document affected by this change.
      */
-    doc: QueryDocumentSnapshot<T>;
+    doc: QueryDocumentSnapshot<AppModelType, DbModelType>;
 
     /**
      * The index of the changed document in the result set immediately after this `DocumentChange`
@@ -230,6 +274,13 @@ export namespace FirebaseFirestoreTypes {
    */
   export type DocumentChangeType = 'added' | 'removed' | 'modified';
 
+  /**
+   * An options object that configures how document snapshot data is returned (e.g. server timestamps).
+   */
+  export type SnapshotOptions = {
+    readonly serverTimestamps?: 'estimate' | 'previous' | 'none';
+  };
+
   /**
    * The types for a DocumentSnapshot field that are supported by Firestore.
    */
@@ -245,15 +296,18 @@ export namespace FirebaseFirestoreTypes {
     | Blob
     | FieldPath
     | FieldValue
-    | DocumentReference
-    | CollectionReference;
+    | DocumentReference<DocumentData, DocumentData>
+    | CollectionReference<DocumentData, DocumentData>;
 
   /**
    * A `DocumentReference` refers to a document location in a Firestore database and can be used to write, read, or listen
    * to the location. The document at the referenced location may or may not exist. A `DocumentReference` can also be used
    * to create a `CollectionReference` to a subcollection.
    */
-  export interface DocumentReference<T extends DocumentData = DocumentData> {
+  export declare class DocumentReference<
+    AppModelType extends DocumentData = DocumentData,
+    DbModelType extends DocumentData = DocumentData,
+  > {
     /**
      * The Firestore instance the document is in. This is useful for performing transactions, for example.
      */
@@ -267,7 +321,7 @@ export namespace FirebaseFirestoreTypes {
     /**
      * The Collection this `DocumentReference` belongs to.
      */
-    parent: CollectionReference<T>;
+    parent: CollectionReference<AppModelType, DbModelType>;
 
     /**
      * A string representing the path of the referenced document (relative to the root of the database).
@@ -285,7 +339,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param collectionPath A slash-separated path to a collection.
      */
-    collection(collectionPath: string): CollectionReference;
+    collection(collectionPath: string): CollectionReference<DocumentData, DocumentData>;
 
     /**
      * Deletes the document referred to by this DocumentReference.
@@ -318,7 +372,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param options An object to configure the get behavior.
      */
-    get(options?: GetOptions): Promise<DocumentSnapshot<T>>;
+    get(options?: GetOptions): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
 
     /**
      * Returns true if this DocumentReference is equal to the provided one.
@@ -335,7 +389,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param other The `DocumentReference` to compare against.
      */
-    isEqual(other: DocumentReference): boolean;
+    isEqual(other: DocumentReference<AppModelType, DbModelType>): boolean;
 
     /**
      * Attaches a listener for DocumentSnapshot events.
@@ -361,7 +415,7 @@ export namespace FirebaseFirestoreTypes {
     onSnapshot(observer: {
       complete?: () => void;
       error?: (error: Error) => void;
-      next?: (snapshot: DocumentSnapshot<T>) => void;
+      next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
     }): () => void;
 
     /**
@@ -393,7 +447,7 @@ export namespace FirebaseFirestoreTypes {
       observer: {
         complete?: () => void;
         error?: (error: Error) => void;
-        next?: (snapshot: DocumentSnapshot<T>) => void;
+        next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
       },
     ): () => void;
 
@@ -420,7 +474,7 @@ export namespace FirebaseFirestoreTypes {
      * @param onCompletion An optional function which will never be called.
      */
     onSnapshot(
-      onNext: (snapshot: DocumentSnapshot<T>) => void,
+      onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void,
       onError?: (error: Error) => void,
       onCompletion?: () => void,
     ): () => void;
@@ -451,7 +505,7 @@ export namespace FirebaseFirestoreTypes {
      */
     onSnapshot(
       options: SnapshotListenOptions,
-      onNext: (snapshot: DocumentSnapshot<T>) => void,
+      onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void,
       onError?: (error: Error) => void,
       onCompletion?: () => void,
     ): () => void;
@@ -477,7 +531,7 @@ export namespace FirebaseFirestoreTypes {
      * @param data A map of the fields and values for the document.
      * @param options An object to configure the set behavior.
      */
-    set(data: SetValue<T>, options?: SetOptions): Promise<void>;
+    set(data: SetValue<AppModelType>, options?: SetOptions): Promise<void>;
 
     /**
      * Updates fields in the document referred to by this `DocumentReference`. The update will fail
@@ -496,7 +550,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param data An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.
      */
-    update(data: Partial<SetValue<T>>): Promise<void>;
+    update(data: Partial<SetValue<DbModelType>>): Promise<void>;
 
     /**
      * Updates fields in the document referred to by this DocumentReference. The update will fail if
@@ -515,7 +569,36 @@ export namespace FirebaseFirestoreTypes {
      * @param value The first value.
      * @param moreFieldsAndValues Additional key value pairs.
      */
-    update(field: keyof T | FieldPath, value: any, ...moreFieldsAndValues: any[]): Promise<void>;
+    update(
+      field: keyof DbModelType | FieldPath,
+      value: any,
+      ...moreFieldsAndValues: any[]
+    ): Promise<void>;
+
+    /**
+     * Removes the current converter.
+     *
+     * @param converter Passing in `null` removes the current converter.
+     * @return A DocumentReference<U> that uses the provided converter.
+     */
+    withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
+
+    /**
+     * Applies a custom data converter to this `DocumentReference`, allowing you
+     * to use your own custom model objects with Firestore. When you call setDoc
+     * getDoc, etc. with the returned `DocumentReference`
+     * instance, the provided converter will convert between Firestore data of
+     * type `NewDbModelType` and your custom type `NewAppModelType`.
+     *
+     * @param converter - Converts objects to and from Firestore.
+     * @returns A `DocumentReference` that uses the provided converter.
+     */
+    withConverter<
+      NewAppModelType extends DocumentData,
+      NewDbModelType extends DocumentData = DocumentData,
+    >(
+      converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>,
+    ): DocumentReference<NewAppModelType, NewDbModelType>;
   }
 
   /**
@@ -525,7 +608,10 @@ export namespace FirebaseFirestoreTypes {
    * For a DocumentSnapshot that points to a non-existing document, any data access will return 'undefined'.
    * You can use the `exists()` method to explicitly verify a document's existence.
    */
-  export interface DocumentSnapshot<T extends DocumentData = DocumentData> {
+  export interface DocumentSnapshot<
+    AppModelType extends DocumentData = DocumentData,
+    DbModelType extends DocumentData = DocumentData,
+  > {
     /**
      * Method of the `DocumentSnapshot` that signals whether or not the data exists. True if the document exists.
      */
@@ -544,7 +630,7 @@ export namespace FirebaseFirestoreTypes {
     /**
      * The `DocumentReference` for the document included in the `DocumentSnapshot`.
      */
-    ref: DocumentReference<T>;
+    ref: DocumentReference<AppModelType, DbModelType>;
 
     /**
      * Retrieves all fields in the document as an Object. Returns 'undefined' if the document doesn't exist.
@@ -557,7 +643,7 @@ export namespace FirebaseFirestoreTypes {
      * console.log('User', user.data());
      * ```
      */
-    data(): T | undefined;
+    data(): AppModelType | undefined;
 
     /**
      * Retrieves the field specified by fieldPath. Returns undefined if the document or field doesn't exist.
@@ -572,7 +658,9 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param fieldPath The path (e.g. 'foo' or 'foo.bar') to a specific field.
      */
-    get<fieldType extends DocumentFieldType>(fieldPath: keyof T | string | FieldPath): fieldType;
+    get<fieldType extends DocumentFieldType>(
+      fieldPath: keyof AppModelType | string | FieldPath,
+    ): fieldType;
 
     /**
      * Returns true if this `DocumentSnapshot` is equal to the provided one.
@@ -589,7 +677,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param other The `DocumentSnapshot` to compare against.
      */
-    isEqual(other: DocumentSnapshot): boolean;
+    isEqual(other: DocumentSnapshot<AppModelType, DbModelType>): boolean;
   }
 
   /**
@@ -600,8 +688,9 @@ export namespace FirebaseFirestoreTypes {
    * Since query results contain only existing documents, the exists() method will always be true and data() will never return 'undefined'.
    */
   export interface QueryDocumentSnapshot<
-    T extends DocumentData = DocumentData,
-  > extends DocumentSnapshot<T> {
+    AppModelType extends DocumentData = DocumentData,
+    DbModelType extends DocumentData = DocumentData,
+  > extends DocumentSnapshot<AppModelType, DbModelType> {
     /**
      * A QueryDocumentSnapshot is always guaranteed to exist.
      */
@@ -620,7 +709,7 @@ export namespace FirebaseFirestoreTypes {
      * }
      * ```
      */
-    data(): T;
+    data(): AppModelType;
   }
 
   /**
@@ -640,7 +729,7 @@ export namespace FirebaseFirestoreTypes {
    * console.log('Address ZIP Code', user.get(fieldPath));
    * ```
    */
-  export class FieldPath {
+  export declare class FieldPath {
     /**
      * Returns a special sentinel `FieldPath` to refer to the ID of a document. It can be used in queries to sort or filter by the document ID.
      */
@@ -690,7 +779,7 @@ export namespace FirebaseFirestoreTypes {
    * });
    * ```
    */
-  export class FieldValue {
+  export declare class FieldValue {
     /**
      * Returns a special value that can be used with `set()` or `update()` that tells the server to remove the given elements
      * from any array value that already exists on the server. All instances of each element specified will be removed from
@@ -816,7 +905,7 @@ export namespace FirebaseFirestoreTypes {
    *
    * Latitude values are in the range of [-90, 90]. Longitude values are in the range of [-180, 180].
    */
-  export class GeoPoint {
+  export declare class GeoPoint {
     /**
      * Creates a new immutable GeoPoint object with the provided latitude and longitude values.
      *
@@ -892,8 +981,7 @@ export namespace FirebaseFirestoreTypes {
   /**
    * Represents an aggregation that can be performed by Firestore.
    */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  export class AggregateField<T> {
+  export class AggregateField<_T> {
     /** A type string to uniquely identify instances of this class. */
     type = 'AggregateField';
   }
@@ -924,7 +1012,7 @@ export namespace FirebaseFirestoreTypes {
    */
   export interface AggregateQuerySnapshot<
     AggregateSpecType extends AggregateSpec,
-    AppModelType = DocumentData,
+    AppModelType extends DocumentData = DocumentData,
     DbModelType extends DocumentData = DocumentData,
   > {
     /**
@@ -954,7 +1042,7 @@ export namespace FirebaseFirestoreTypes {
     /**
      * The underlying query for this instance.
      */
-    get query(): Query<unknown>;
+    get query(): Query<DocumentData, DocumentData>;
 
     /**
      * Executes the query and returns the results as a AggregateQuerySnapshot.
@@ -978,7 +1066,10 @@ export namespace FirebaseFirestoreTypes {
    * A Query refers to a `Query` which you can read or listen to. You can also construct refined `Query` objects by
    * adding filters and ordering.
    */
-  export interface Query<T extends DocumentData = DocumentData> {
+  export declare class Query<
+    AppModelType extends DocumentData = DocumentData,
+    DbModelType extends DocumentData = DocumentData,
+  > {
     /**
      * Calculates the number of documents in the result set of the given query, without actually downloading
      * the documents.
@@ -1020,7 +1111,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param snapshot The snapshot of the document to end at.
      */
-    endAt(snapshot: DocumentSnapshot<T>): Query<T>;
+    endAt(snapshot: DocumentSnapshot<AppModelType, DbModelType>): Query<AppModelType, DbModelType>;
 
     /**
      * Creates and returns a new Query that ends at the provided fields relative to the order of the query.
@@ -1038,7 +1129,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param fieldValues The field values to end this query at, in order of the query's order by.
      */
-    endAt(...fieldValues: any[]): Query<T>;
+    endAt(...fieldValues: any[]): Query<AppModelType, DbModelType>;
 
     /**
      * Creates and returns a new Query that ends before the provided document (exclusive). The end
@@ -1061,7 +1152,9 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param snapshot The snapshot of the document to end before.
      */
-    endBefore(snapshot: DocumentSnapshot<T>): Query<T>;
+    endBefore(
+      snapshot: DocumentSnapshot<AppModelType, DbModelType>,
+    ): Query<AppModelType, DbModelType>;
 
     /**
      * Creates and returns a new Query that ends before the provided fields relative to the order of
@@ -1079,7 +1172,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param fieldValues The field values to end this query before, in order of the query's order by.
      */
-    endBefore(...fieldValues: any[]): Query<T>;
+    endBefore(...fieldValues: any[]): Query<AppModelType, DbModelType>;
 
     /**
      * Executes the query and returns the results as a QuerySnapshot.
@@ -1101,7 +1194,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param options An object to configure the get behavior.
      */
-    get(options?: GetOptions): Promise<QuerySnapshot<T>>;
+    get(options?: GetOptions): Promise<QuerySnapshot<AppModelType, DbModelType>>;
 
     /**
      * Returns true if this Query is equal to the provided one.
@@ -1141,7 +1234,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param limit The maximum number of items to return.
      */
-    limit(limit: number): Query<T>;
+    limit(limit: number): Query<AppModelType, DbModelType>;
 
     /**
      * Creates and returns a new Query where the results are limited to the specified number of documents
@@ -1161,7 +1254,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param limitToLast The maximum number of items to return.
      */
-    limitToLast(limitToLast: number): Query<T>;
+    limitToLast(limitToLast: number): Query<AppModelType, DbModelType>;
 
     /**
      * Attaches a listener for `QuerySnapshot` events.
@@ -1187,7 +1280,7 @@ export namespace FirebaseFirestoreTypes {
     onSnapshot(observer: {
       complete?: () => void;
       error?: (error: Error) => void;
-      next?: (snapshot: QuerySnapshot<T>) => void;
+      next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
     }): () => void;
 
     /**
@@ -1219,7 +1312,7 @@ export namespace FirebaseFirestoreTypes {
       observer: {
         complete?: () => void;
         error?: (error: Error) => void;
-        next?: (snapshot: QuerySnapshot<T>) => void;
+        next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
       },
     ): () => void;
 
@@ -1246,7 +1339,7 @@ export namespace FirebaseFirestoreTypes {
      * @param onCompletion An optional function which will never be called.
      */
     onSnapshot(
-      onNext: (snapshot: QuerySnapshot<T>) => void,
+      onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void,
       onError?: (error: Error) => void,
       onCompletion?: () => void,
     ): () => void;
@@ -1277,7 +1370,7 @@ export namespace FirebaseFirestoreTypes {
      */
     onSnapshot(
       options: SnapshotListenOptions,
-      onNext: (snapshot: QuerySnapshot<T>) => void,
+      onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void,
       onError?: (error: Error) => void,
       onCompletion?: () => void,
     ): () => void;
@@ -1300,7 +1393,10 @@ export namespace FirebaseFirestoreTypes {
      * @param fieldPath The field to sort by. Either a string or FieldPath instance.
      * @param directionStr Optional direction to sort by (`asc` or `desc`). If not specified, order will be ascending.
      */
-    orderBy(fieldPath: keyof T | string | FieldPath, directionStr?: 'asc' | 'desc'): Query<T>;
+    orderBy(
+      fieldPath: string | FieldPath,
+      directionStr?: 'asc' | 'desc',
+    ): Query<AppModelType, DbModelType>;
 
     /**
      * Creates and returns a new Query that starts after the provided document (exclusive). The start
@@ -1324,7 +1420,9 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param snapshot The snapshot of the document to start after.
      */
-    startAfter(snapshot: DocumentSnapshot<T>): Query<T>;
+    startAfter(
+      snapshot: DocumentSnapshot<AppModelType, DbModelType>,
+    ): Query<AppModelType, DbModelType>;
 
     /**
      * Creates and returns a new Query that starts after the provided fields relative to the order of
@@ -1343,7 +1441,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param fieldValues The field values to start this query after, in order of the query's order by.
      */
-    startAfter(...fieldValues: any[]): Query<T>;
+    startAfter(...fieldValues: any[]): Query<AppModelType, DbModelType>;
 
     /**
      * Creates and returns a new Query that starts at the provided document (inclusive). The start
@@ -1367,7 +1465,9 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param snapshot The snapshot of the document to start at.
      */
-    startAt(snapshot: DocumentSnapshot<T>): Query<T>;
+    startAt(
+      snapshot: DocumentSnapshot<AppModelType, DbModelType>,
+    ): Query<AppModelType, DbModelType>;
 
     /**
      * Creates and returns a new Query that starts at the provided fields relative to the order of the query.
@@ -1386,7 +1486,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param fieldValues The field values to start this query at, in order of the query's order by.
      */
-    startAt(...fieldValues: any[]): Query<T>;
+    startAt(...fieldValues: any[]): Query<AppModelType, DbModelType>;
 
     /**
      * Creates and returns a new Query with the additional filter that documents must contain the specified field and
@@ -1406,7 +1506,11 @@ export namespace FirebaseFirestoreTypes {
      * @param opStr The operation string (e.g "<", "<=", "==", ">", ">=", "!=", "array-contains", "array-contains-any", "in", "not-in").
      * @param value The comparison value.
      */
-    where(fieldPath: keyof T | FieldPath, opStr: WhereFilterOp, value: any): Query<T>;
+    where(
+      fieldPath: string | FieldPath,
+      opStr: WhereFilterOp,
+      value: any,
+    ): Query<AppModelType, DbModelType>;
 
     /**
      * Creates and returns a new Query with the additional filter that documents must contain the specified field and
@@ -1424,7 +1528,35 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param filter The filter to apply to the query.
      */
-    where(filter: QueryFilterConstraint): Query<T>;
+    where(filter: QueryFilterConstraint): Query<AppModelType, DbModelType>;
+
+    /**
+     * Removes the current converter.
+     *
+     * @param converter `null` removes the current converter.
+     * @return A Query that uses the provided converter.
+     */
+    withConverter(converter: null): Query<DocumentData, DocumentData>;
+
+    /**
+     * Applies a custom data converter to this Query, allowing you to use your
+     * own custom model objects with Firestore. When you call get() on the
+     * returned Query, the provided converter will convert between Firestore
+     * data and your custom type U.
+     *
+     * Passing in `null` as the converter parameter removes the current
+     * converter.
+     *
+     * @param converter Converts objects to and from Firestore. Passing in
+     * `null` removes the current converter.
+     * @return A Query<U> that uses the provided converter.
+     */
+    withConverter<
+      NewAppModelType extends DocumentData,
+      NewDbModelType extends DocumentData = DocumentData,
+    >(
+      converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>,
+    ): Query<NewAppModelType, NewDbModelType>;
   }
 
   /**
@@ -1447,11 +1579,14 @@ export namespace FirebaseFirestoreTypes {
    * can be accessed as an array via the `docs` property or enumerated using the `forEach` method. The number of documents
    * can be determined via the `empty` and `size` properties.
    */
-  export interface QuerySnapshot<T extends DocumentData = DocumentData> {
+  export interface QuerySnapshot<
+    AppModelType extends DocumentData = DocumentData,
+    DbModelType extends DocumentData = DocumentData,
+  > {
     /**
      * An array of all the documents in the `QuerySnapshot`.
      */
-    docs: QueryDocumentSnapshot<T>[];
+    docs: Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
 
     /**
      * True if there are no documents in the `QuerySnapshot`.
@@ -1466,7 +1601,7 @@ export namespace FirebaseFirestoreTypes {
     /**
      * The query on which you called get or `onSnapshot` in order to `get` this `QuerySnapshot`.
      */
-    query: Query<T>;
+    query: Query<AppModelType, DbModelType>;
 
     /**
      * The number of documents in the `QuerySnapshot`.
@@ -1501,7 +1636,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param options `SnapshotListenOptions` that control whether metadata-only changes (i.e. only `DocumentSnapshot.metadata` changed) should trigger snapshot events.
      */
-    docChanges(options?: SnapshotListenOptions): DocumentChange<T>[];
+    docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;
 
     /**
      * Enumerates all of the documents in the `QuerySnapshot`.
@@ -1519,10 +1654,9 @@ export namespace FirebaseFirestoreTypes {
      * @param callback A callback to be called with a `QueryDocumentSnapshot` for each document in the snapshot.
      * @param thisArg The `this` binding for the callback.
      */
-
     forEach(
-      callback: (result: QueryDocumentSnapshot<T>, index: number) => void,
-      thisArg?: any,
+      callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void,
+      thisArg?: unknown,
     ): void;
 
     /**
@@ -1667,7 +1801,7 @@ export namespace FirebaseFirestoreTypes {
    * It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table
    * is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
    */
-  export class Timestamp {
+  export declare class Timestamp {
     /**
      * Creates a new timestamp from the given JavaScript [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date).
      *
@@ -2130,6 +2264,74 @@ export namespace FirebaseFirestoreTypes {
     SDK_VERSION: string;
   }
 
+  /**
+   * Converter used by `withConverter()` to transform user objects of type T
+   * into Firestore data.
+   *
+   * Using the converter allows you to specify generic type arguments when
+   * storing and retrieving objects from Firestore.
+   *
+   * @example
+   * ```typescript
+   * class Post {
+   *   constructor(readonly title: string, readonly author: string) {}
+   *
+   *   toString(): string {
+   *     return this.title + ', by ' + this.author;
+   *   }
+   * }
+   *
+   * const postConverter = {
+   *   toFirestore(post: Post): firebase.firestore.DocumentData {
+   *     return {title: post.title, author: post.author};
+   *   },
+   *   fromFirestore(
+   *     snapshot: firebase.firestore.QueryDocumentSnapshot,
+   *     options: firebase.firestore.SnapshotOptions
+   *   ): Post {
+   *     const data = snapshot.data(options)!;
+   *     return new Post(data.title, data.author);
+   *   }
+   * };
+   *
+   * const postSnap = await firebase.firestore()
+   *   .collection('posts')
+   *   .withConverter(postConverter)
+   *   .doc().get();
+   * const post = postSnap.data();
+   * if (post !== undefined) {
+   *   post.title; // string
+   *   post.toString(); // Should be defined
+   *   post.someNonExistentProperty; // TS error
+   * }
+   * ```
+   */
+  export interface FirestoreDataConverter<
+    AppModelType,
+    DbModelType extends DocumentData = DocumentData,
+  > {
+    /**
+     * Called by the Firestore SDK to convert a custom model object of type T
+     * into a plain JavaScript object (suitable for writing directly to the
+     * Firestore database). To use `set()` with `merge` and `mergeFields`,
+     * `toFirestore()` must be defined with `Partial<T>`.
+     */
+    toFirestore(modelObject: AppModelType): DocumentData;
+    toFirestore(modelObject: Partial<AppModelType>, options: SetOptions): DocumentData;
+
+    /**
+     * Called by the Firestore SDK to convert Firestore data into an object of
+     * type T. You can access your data by calling: `snapshot.data(options)`.
+     *
+     * @param snapshot A QueryDocumentSnapshot containing your data and metadata.
+     * @param options The SnapshotOptions from the initial call to `data()`.
+     */
+    fromFirestore(
+      snapshot: QueryDocumentSnapshot<DocumentData, DbModelType>,
+      options: SnapshotOptions,
+    ): AppModelType;
+  }
+
   /**
    * The Firebase Cloud Firestore service is available for the default app or a given app.
    *
@@ -2147,7 +2349,7 @@ export namespace FirebaseFirestoreTypes {
    * ```
    *
    */
-  export class Module extends FirebaseModule {
+  export declare class Module implements _FirebaseModule {
     /**
      * The current `FirebaseApp` instance for this Firebase service.
      */
@@ -2223,7 +2425,7 @@ export namespace FirebaseFirestoreTypes {
      *
      * @param documentPath A slash-separated path to a document.
      */
-    doc<T extends DocumentData = DocumentData>(documentPath: string): DocumentReference<T>;
+    doc<T extends DocumentData = DocumentData>(documentPath: string): DocumentReference<T, T>;
 
     /**
      * Re-enables use of the network for this Firestore instance after a prior call to `disableNetwork()`.
@@ -2391,16 +2593,14 @@ type FirestoreNamespace = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<
 
 declare const defaultExport: FirestoreNamespace;
 
-export const firebase: ReactNativeFirebase.Module & {
+export declare const firebase: ReactNativeFirebase.Module & {
   firestore: typeof defaultExport;
   app(
     name?: string,
   ): ReactNativeFirebase.FirebaseApp & { firestore(): FirebaseFirestoreTypes.Module };
 };
 
-export * from './modular';
-
-export const Filter: FirebaseFirestoreTypes.FilterFunction;
+export declare const Filter: FirebaseFirestoreTypes.FilterFunction;
 
 export default defaultExport;
 
@@ -2408,6 +2608,7 @@ export default defaultExport;
  * Attach namespace to `firebase.` and `FirebaseApp.`.
  */
 declare module '@react-native-firebase/app' {
+  // eslint-disable-next-line @typescript-eslint/no-namespace -- module augmentation uses namespace
   namespace ReactNativeFirebase {
     import FirebaseModuleWithStaticsAndApp = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp;
     interface Module {