Add support for Typescript Custom Mapping

packages/firebase/index.d.ts

@@ -7088,8 +7088,8 @@ declare namespace firebase.firestore {
   export function setLogLevel(logLevel: LogLevel): void;
 
   /**
-   * Converter used by `withConverter()` to transform user objects into
-   * Firestore data.
+   * 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.
@@ -7142,7 +7142,7 @@ declare namespace firebase.firestore {
      * 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().
+     * @param options The SnapshotOptions from the initial call to `data()`.
      */
     fromFirestore(snapshot: QueryDocumentSnapshot, options: SnapshotOptions): T;
   }
@@ -7594,7 +7594,7 @@ declare namespace firebase.firestore {
      * @return This `Transaction` instance. Used for chaining method calls.
      */
     update(
-      documentRef: DocumentReference<unknown>,
+      documentRef: DocumentReference<any>,
       data: UpdateData
     ): Transaction;
 
@@ -7614,7 +7614,7 @@ declare namespace firebase.firestore {
      * to the backend (Note that it won't resolve while you're offline).
      */
     update(
-      documentRef: DocumentReference<unknown>,
+      documentRef: DocumentReference<any>,
       field: string | FieldPath,
       value: any,
       ...moreFieldsAndValues: any[]
@@ -7626,7 +7626,7 @@ declare namespace firebase.firestore {
      * @param documentRef A reference to the document to be deleted.
      * @return This `Transaction` instance. Used for chaining method calls.
      */
-    delete(documentRef: DocumentReference<unknown>): Transaction;
+    delete(documentRef: DocumentReference<any>): Transaction;
   }
 
   /**
@@ -7671,7 +7671,7 @@ declare namespace firebase.firestore {
      * @return This `WriteBatch` instance. Used for chaining method calls.
      */
     update(
-      documentRef: DocumentReference<unknown>,
+      documentRef: DocumentReference<any>,
       data: UpdateData
     ): WriteBatch;
 
@@ -7690,7 +7690,7 @@ declare namespace firebase.firestore {
      * to the backend (Note that it won't resolve while you're offline).
      */
     update(
-      documentRef: DocumentReference<unknown>,
+      documentRef: DocumentReference<any>,
       field: string | FieldPath,
       value: any,
       ...moreFieldsAndValues: any[]
@@ -7702,7 +7702,7 @@ declare namespace firebase.firestore {
      * @param documentRef A reference to the document to be deleted.
      * @return This `WriteBatch` instance. Used for chaining method calls.
      */
-    delete(documentRef: DocumentReference<unknown>): WriteBatch;
+    delete(documentRef: DocumentReference<any>): WriteBatch;
 
     /**
      * Commits all of the writes in this write batch as a single atomic unit.
@@ -7980,9 +7980,9 @@ declare namespace firebase.firestore {
     /**
      * Applies a custom data converter to this DocumentReference, allowing you
      * to use your own custom model objects with Firestore. When you call
-     * set(), get(), etc. on the returned DocumentReference instance, it will
-     * use the provided converter to convert data to/from type U (your custom
-     * model object type).
+     * set(), get(), etc. on the returned DocumentReference instance, the
+     * provided converter will convert between Firestore data and your custom
+     * type U.
      *
      * @param converter Converts objects to and from Firestore.
      * @return A DocumentReference<U> that uses the provided converter.
@@ -8246,7 +8246,7 @@ declare namespace firebase.firestore {
      * @param snapshot The snapshot of the document to start at.
      * @return The created Query.
      */
-    startAt(snapshot: DocumentSnapshot<unknown>): Query<T>;
+    startAt(snapshot: DocumentSnapshot<any>): Query<T>;
 
     /**
      * Creates and returns a new Query that starts at the provided fields
@@ -8268,7 +8268,7 @@ declare namespace firebase.firestore {
      * @param snapshot The snapshot of the document to start after.
      * @return The created Query.
      */
-    startAfter(snapshot: DocumentSnapshot<unknown>): Query<T>;
+    startAfter(snapshot: DocumentSnapshot<any>): Query<T>;
 
     /**
      * Creates and returns a new Query that starts after the provided fields
@@ -8290,7 +8290,7 @@ declare namespace firebase.firestore {
      * @param snapshot The snapshot of the document to end before.
      * @return The created Query.
      */
-    endBefore(snapshot: DocumentSnapshot<unknown>): Query<T>;
+    endBefore(snapshot: DocumentSnapshot<any>): Query<T>;
 
     /**
      * Creates and returns a new Query that ends before the provided fields
@@ -8312,7 +8312,7 @@ declare namespace firebase.firestore {
      * @param snapshot The snapshot of the document to end at.
      * @return The created Query.
      */
-    endAt(snapshot: DocumentSnapshot<unknown>): Query<T>;
+    endAt(snapshot: DocumentSnapshot<any>): Query<T>;
 
     /**
      * Creates and returns a new Query that ends at the provided fields
@@ -8434,8 +8434,8 @@ declare namespace firebase.firestore {
     /**
      * 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, it will use the provided converter to convert data
-     * to/from type U (your custom model object type).
+     * returned Query, the provided converter will convert between Firestore
+     * data and your custom type U.
      *
      * @param converter Converts objects to and from Firestore.
      * @return A Query<U> that uses the provided converter.
@@ -8590,8 +8590,8 @@ declare namespace firebase.firestore {
     /**
      * 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, it will use the provided
-     * converter to convert data to/from type U (your custom model object type).
+     * on the returned CollectionReference instance, the provided converter will
+     * convert between Firestore data and your custom type U.
      *
      * @param converter Converts objects to and from Firestore.
      * @return A CollectionReference<U> that uses the provided converter.

packages/firestore-types/index.d.ts

@@ -141,17 +141,17 @@ export class Transaction {
   ): Transaction;
 
   update(
-    documentRef: DocumentReference<unknown>,
+    documentRef: DocumentReference<any>,
     data: UpdateData
   ): Transaction;
   update(
-    documentRef: DocumentReference<unknown>,
+    documentRef: DocumentReference<any>,
     field: string | FieldPath,
     value: any,
     ...moreFieldsAndValues: any[]
   ): Transaction;
 
-  delete(documentRef: DocumentReference<unknown>): Transaction;
+  delete(documentRef: DocumentReference<any>): Transaction;
 }
 
 export class WriteBatch {
@@ -163,15 +163,15 @@ export class WriteBatch {
     options?: SetOptions
   ): WriteBatch;
 
-  update(documentRef: DocumentReference<unknown>, data: UpdateData): WriteBatch;
+  update(documentRef: DocumentReference<any>, data: UpdateData): WriteBatch;
   update(
-    documentRef: DocumentReference<unknown>,
+    documentRef: DocumentReference<any>,
     field: string | FieldPath,
     value: any,
     ...moreFieldsAndValues: any[]
   ): WriteBatch;
 
-  delete(documentRef: DocumentReference<unknown>): WriteBatch;
+  delete(documentRef: DocumentReference<any>): WriteBatch;
 
   commit(): Promise<void>;
 }
@@ -308,16 +308,16 @@ export class Query<T = DocumentData> {
 
   limitToLast(limit: number): Query<T>;
 
-  startAt(snapshot: DocumentSnapshot<unknown>): Query<T>;
+  startAt(snapshot: DocumentSnapshot<any>): Query<T>;
   startAt(...fieldValues: any[]): Query<T>;
 
-  startAfter(snapshot: DocumentSnapshot<unknown>): Query<T>;
+  startAfter(snapshot: DocumentSnapshot<any>): Query<T>;
   startAfter(...fieldValues: any[]): Query<T>;
 
-  endBefore(snapshot: DocumentSnapshot<unknown>): Query<T>;
+  endBefore(snapshot: DocumentSnapshot<any>): Query<T>;
   endBefore(...fieldValues: any[]): Query<T>;
 
-  endAt(snapshot: DocumentSnapshot<unknown>): Query<T>;
+  endAt(snapshot: DocumentSnapshot<any>): Query<T>;
   endAt(...fieldValues: any[]): Query<T>;
 
   isEqual(other: Query<T>): boolean;

packages/firestore/src/api/database.ts

@@ -772,17 +772,20 @@ export class Transaction implements firestore.Transaction {
   }
 
   update(
-    documentRef: firestore.DocumentReference<unknown>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    documentRef: firestore.DocumentReference<any>,
     value: firestore.UpdateData
   ): Transaction;
   update(
-    documentRef: firestore.DocumentReference<unknown>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    documentRef: firestore.DocumentReference<any>,
     field: string | ExternalFieldPath,
     value: unknown,
     ...moreFieldsAndValues: unknown[]
   ): Transaction;
   update(
-    documentRef: firestore.DocumentReference<unknown>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    documentRef: firestore.DocumentReference<any>,
     fieldOrUpdateData: string | ExternalFieldPath | firestore.UpdateData,
     value?: unknown,
     ...moreFieldsAndValues: unknown[]
@@ -823,7 +826,8 @@ export class Transaction implements firestore.Transaction {
     return this;
   }
 
-  delete(documentRef: firestore.DocumentReference<unknown>): Transaction {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  delete(documentRef: firestore.DocumentReference<any>): Transaction {
     validateExactNumberOfArgs('Transaction.delete', arguments, 1);
     const ref = validateReference(
       'Transaction.delete',
@@ -877,17 +881,20 @@ export class WriteBatch implements firestore.WriteBatch {
   }
 
   update(
-    documentRef: firestore.DocumentReference<unknown>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    documentRef: firestore.DocumentReference<any>,
     value: firestore.UpdateData
   ): WriteBatch;
   update(
-    documentRef: firestore.DocumentReference<unknown>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    documentRef: firestore.DocumentReference<any>,
     field: string | ExternalFieldPath,
     value: unknown,
     ...moreFieldsAndValues: unknown[]
   ): WriteBatch;
   update(
-    documentRef: firestore.DocumentReference<unknown>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    documentRef: firestore.DocumentReference<any>,
     fieldOrUpdateData: string | ExternalFieldPath | firestore.UpdateData,
     value?: unknown,
     ...moreFieldsAndValues: unknown[]
@@ -932,7 +939,8 @@ export class WriteBatch implements firestore.WriteBatch {
     return this;
   }
 
-  delete(documentRef: firestore.DocumentReference<unknown>): WriteBatch {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  delete(documentRef: firestore.DocumentReference<any>): WriteBatch {
     validateExactNumberOfArgs('WriteBatch.delete', arguments, 1);
     this.verifyNotCommitted();
     const ref = validateReference(
@@ -1652,7 +1660,8 @@ export class Query<T = firestore.DocumentData> implements firestore.Query<T> {
   }
 
   startAt(
-    docOrField: unknown | firestore.DocumentSnapshot<unknown>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    docOrField: unknown | firestore.DocumentSnapshot<any>,
     ...fields: unknown[]
   ): firestore.Query<T> {
     validateAtLeastNumberOfArgs('Query.startAt', arguments, 1);
@@ -1670,7 +1679,8 @@ export class Query<T = firestore.DocumentData> implements firestore.Query<T> {
   }
 
   startAfter(
-    docOrField: unknown | firestore.DocumentSnapshot<unknown>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    docOrField: unknown | firestore.DocumentSnapshot<any>,
     ...fields: unknown[]
   ): firestore.Query<T> {
     validateAtLeastNumberOfArgs('Query.startAfter', arguments, 1);
@@ -1688,7 +1698,8 @@ export class Query<T = firestore.DocumentData> implements firestore.Query<T> {
   }
 
   endBefore(
-    docOrField: unknown | firestore.DocumentSnapshot<unknown>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    docOrField: unknown | firestore.DocumentSnapshot<any>,
     ...fields: unknown[]
   ): firestore.Query<T> {
     validateAtLeastNumberOfArgs('Query.endBefore', arguments, 1);
@@ -1706,7 +1717,8 @@ export class Query<T = firestore.DocumentData> implements firestore.Query<T> {
   }
 
   endAt(
-    docOrField: unknown | firestore.DocumentSnapshot<unknown>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    docOrField: unknown | firestore.DocumentSnapshot<any>,
     ...fields: unknown[]
   ): firestore.Query<T> {
     validateAtLeastNumberOfArgs('Query.endAt', arguments, 1);
@@ -2663,7 +2675,7 @@ function applyFirestoreDataConverter<T>(
   let convertedValue;
   if (converter) {
     convertedValue = converter.toFirestore(value);
-    functionName = 'toFirestore() in Transaction.set';
+    functionName = 'toFirestore() in ' + functionName;
   } else {
     convertedValue = value as firestore.DocumentData;
   }