feat!: Fix the UpdateData incorrect parameter type issue

dev/src/bulk-writer.ts

@@ -737,9 +737,9 @@ export class BulkWriter {
    * });
    * ```
    */
-  update<T>(
-    documentRef: firestore.DocumentReference<T>,
-    dataOrField: firestore.UpdateData<T> | string | FieldPath,
+  update<AppModelType, DbModelType>(
+    documentRef: firestore.DocumentReference<AppModelType, DbModelType>,
+    dataOrField: firestore.UpdateData<DbModelType> | string | FieldPath,
     ...preconditionOrValues: Array<
       {lastUpdateTime?: Timestamp} | unknown | string | FieldPath
     >

dev/src/collection-group.ts

@@ -35,15 +35,20 @@ import {compareArrays} from './order';
  *
  * @class CollectionGroup
  */
-export class CollectionGroup<T = firestore.DocumentData>
-  extends Query<T>
-  implements firestore.CollectionGroup<T>
+export class CollectionGroup<
+    AppModelType = firestore.DocumentData,
+    DbModelType extends firestore.DocumentData = firestore.DocumentData
+  >
+  extends Query<AppModelType, DbModelType>
+  implements firestore.CollectionGroup<AppModelType, DbModelType>
 {
   /** @private */
   constructor(
     firestore: Firestore,
     collectionId: string,
-    converter: firestore.FirestoreDataConverter<T> | undefined
+    converter:
+      | firestore.FirestoreDataConverter<AppModelType, DbModelType>
+      | undefined
   ) {
     super(
       firestore,
@@ -74,7 +79,7 @@ export class CollectionGroup<T = firestore.DocumentData>
    */
   async *getPartitions(
     desiredPartitionCount: number
-  ): AsyncIterable<QueryPartition<T>> {
+  ): AsyncIterable<QueryPartition<AppModelType, DbModelType>> {
     validateInteger('desiredPartitionCount', desiredPartitionCount, {
       minValue: 1,
     });
@@ -141,7 +146,8 @@ export class CollectionGroup<T = firestore.DocumentData>
    * Applies a custom data converter to this `CollectionGroup`, allowing you
    * to use your own custom model objects with Firestore. When you call get()
    * on the returned `CollectionGroup`, the provided converter will convert
-   * between Firestore data and your custom type U.
+   * between Firestore data of type `NewDbModelType` and your custom type
+   * `NewAppModelType`.
    *
    * Using the converter allows you to specify generic type arguments when
    * storing and retrieving objects from Firestore.
@@ -185,17 +191,20 @@ export class CollectionGroup<T = firestore.DocumentData>
    * ```
    * @param {FirestoreDataConverter | null} converter Converts objects to and
    * from Firestore. Passing in `null` removes the current converter.
-   * @return {CollectionGroup} A `CollectionGroup<U>` that uses the provided
+   * @return {CollectionGroup} A `CollectionGroup` that uses the provided
    * converter.
    */
-  withConverter(converter: null): CollectionGroup<firestore.DocumentData>;
-  withConverter<U>(
-    converter: firestore.FirestoreDataConverter<U>
-  ): CollectionGroup<U>;
-  withConverter<U>(
-    converter: firestore.FirestoreDataConverter<U> | null
-  ): CollectionGroup<U> {
-    return new CollectionGroup<U>(
+  withConverter(converter: null): CollectionGroup;
+  withConverter<AppModelType, DbModelType>(
+    converter: firestore.FirestoreDataConverter<AppModelType, DbModelType>
+  ): CollectionGroup<AppModelType, DbModelType>;
+  withConverter<AppModelType, DbModelType>(
+    converter: firestore.FirestoreDataConverter<
+      AppModelType,
+      DbModelType
+    > | null
+  ): CollectionGroup<AppModelType, DbModelType> {
+    return new CollectionGroup<AppModelType, DbModelType>(
       this.firestore,
       this._queryOptions.collectionId,
       converter ?? defaultConverter()

dev/src/document-change.ts

@@ -26,11 +26,13 @@ export type DocumentChangeType = 'added' | 'removed' | 'modified';
  *
  * @class DocumentChange
  */
-export class DocumentChange<T = firestore.DocumentData>
-  implements firestore.DocumentChange<T>
+export class DocumentChange<
+  AppModelType = firestore.DocumentData,
+  DbModelType extends firestore.DocumentData = firestore.DocumentData
+> implements firestore.DocumentChange<AppModelType, DbModelType>
 {
   private readonly _type: DocumentChangeType;
-  private readonly _document: QueryDocumentSnapshot<T>;
+  private readonly _document: QueryDocumentSnapshot<AppModelType, DbModelType>;
   private readonly _oldIndex: number;
   private readonly _newIndex: number;
 
@@ -46,7 +48,7 @@ export class DocumentChange<T = firestore.DocumentData>
    */
   constructor(
     type: DocumentChangeType,
-    document: QueryDocumentSnapshot<T>,
+    document: QueryDocumentSnapshot<AppModelType, DbModelType>,
     oldIndex: number,
     newIndex: number
   ) {
@@ -103,7 +105,7 @@ export class DocumentChange<T = firestore.DocumentData>
    * unsubscribe();
    * ```
    */
-  get doc(): QueryDocumentSnapshot<T> {
+  get doc(): QueryDocumentSnapshot<AppModelType, DbModelType> {
     return this._document;
   }
 
@@ -181,7 +183,7 @@ export class DocumentChange<T = firestore.DocumentData>
    * @param {*} other The value to compare against.
    * @return true if this `DocumentChange` is equal to the provided value.
    */
-  isEqual(other: firestore.DocumentChange<T>): boolean {
+  isEqual(other: firestore.DocumentChange<AppModelType, DbModelType>): boolean {
     if (this === other) {
       return true;
     }

dev/src/document-reader.ts

@@ -31,7 +31,10 @@ import api = google.firestore.v1;
  * @private
  * @internal
  */
-export class DocumentReader<T> {
+export class DocumentReader<
+  AppModelType,
+  DbModelType extends DocumentData = DocumentData
+> {
   /** An optional field mask to apply to this read. */
   fieldMask?: FieldPath[];
   /** An optional transaction ID to use for this read. */
@@ -49,7 +52,7 @@ export class DocumentReader<T> {
    */
   constructor(
     private firestore: Firestore,
-    private allDocuments: Array<DocumentReference<T>>
+    private allDocuments: Array<DocumentReference<AppModelType, DbModelType>>
   ) {
     for (const docRef of this.allDocuments) {
       this.outstandingDocuments.add(docRef.formattedName);
@@ -61,20 +64,23 @@ export class DocumentReader<T> {
    *
    * @param requestTag A unique client-assigned identifier for this request.
    */
-  async get(requestTag: string): Promise<Array<DocumentSnapshot<T>>> {
+  async get(
+    requestTag: string
+  ): Promise<Array<DocumentSnapshot<AppModelType, DbModelType>>> {
     await this.fetchDocuments(requestTag);
 
     // BatchGetDocuments doesn't preserve document order. We use the request
     // order to sort the resulting documents.
-    const orderedDocuments: Array<DocumentSnapshot<T>> = [];
+    const orderedDocuments: Array<DocumentSnapshot<AppModelType, DbModelType>> =
+      [];
 
     for (const docRef of this.allDocuments) {
       const document = this.retrievedDocuments.get(docRef.formattedName);
       if (document !== undefined) {
         // Recreate the DocumentSnapshot with the DocumentReference
         // containing the original converter.
         const finalDoc = new DocumentSnapshotBuilder(
-          docRef as DocumentReference<T>
+          docRef as DocumentReference<AppModelType, DbModelType>
         );
         finalDoc.fieldsProto = document._fieldsProto;
         finalDoc.readTime = document.readTime;

dev/src/document.ts

@@ -38,7 +38,10 @@ import api = google.firestore.v1;
  * @private
  * @internal
  */
-export class DocumentSnapshotBuilder<T = firestore.DocumentData> {
+export class DocumentSnapshotBuilder<
+  AppModelType = firestore.DocumentData,
+  DbModelType extends firestore.DocumentData = firestore.DocumentData
+> {
   /** The fields of the Firestore `Document` Protobuf backing this document. */
   fieldsProto?: ApiMapValue;
 
@@ -53,7 +56,7 @@ export class DocumentSnapshotBuilder<T = firestore.DocumentData> {
 
   // We include the DocumentReference in the constructor in order to allow the
   // DocumentSnapshotBuilder to be typed with <T> when it is constructed.
-  constructor(readonly ref: DocumentReference<T>) {}
+  constructor(readonly ref: DocumentReference<AppModelType, DbModelType>) {}
 
   /**
    * Builds the DocumentSnapshot.
@@ -63,7 +66,9 @@ export class DocumentSnapshotBuilder<T = firestore.DocumentData> {
    * @returns Returns either a QueryDocumentSnapshot (if `fieldsProto` was
    * provided) or a DocumentSnapshot.
    */
-  build(): QueryDocumentSnapshot<T> | DocumentSnapshot<T> {
+  build():
+    | QueryDocumentSnapshot<AppModelType, DbModelType>
+    | DocumentSnapshot<AppModelType, DbModelType> {
     assert(
       (this.fieldsProto !== undefined) === (this.createTime !== undefined),
       'Create time should be set iff document exists.'
@@ -98,10 +103,12 @@ export class DocumentSnapshotBuilder<T = firestore.DocumentData> {
  *
  * @class DocumentSnapshot
  */
-export class DocumentSnapshot<T = firestore.DocumentData>
-  implements firestore.DocumentSnapshot<T>
+export class DocumentSnapshot<
+  AppModelType = firestore.DocumentData,
+  DbModelType extends firestore.DocumentData = firestore.DocumentData
+> implements firestore.DocumentSnapshot<AppModelType, DbModelType>
 {
-  private _ref: DocumentReference<T>;
+  private _ref: DocumentReference<AppModelType, DbModelType>;
   private _serializer: Serializer;
   private _readTime: Timestamp | undefined;
   private _createTime: Timestamp | undefined;
@@ -121,7 +128,7 @@ export class DocumentSnapshot<T = firestore.DocumentData>
    * if the document does not exist).
    */
   constructor(
-    ref: DocumentReference<T>,
+    ref: DocumentReference<AppModelType, DbModelType>,
     /** @private */
     readonly _fieldsProto?: ApiMapValue,
     readTime?: Timestamp,
@@ -144,13 +151,14 @@ export class DocumentSnapshot<T = firestore.DocumentData>
    * @param obj The object to store in the DocumentSnapshot.
    * @return The created DocumentSnapshot.
    */
-  static fromObject<U>(
-    ref: firestore.DocumentReference<U>,
-    obj: firestore.DocumentData
-  ): DocumentSnapshot<U> {
-    const serializer = (ref as DocumentReference<U>).firestore._serializer!;
+  static fromObject<AppModelType, DbModelType>(
+    ref: firestore.DocumentReference<AppModelType, DbModelType>,
+    obj: DbModelType
+  ): DocumentSnapshot<AppModelType, DbModelType> {
+    const serializer = (ref as DocumentReference<AppModelType, DbModelType>)
+      .firestore._serializer!;
     return new DocumentSnapshot(
-      ref as DocumentReference<U>,
+      ref as DocumentReference<AppModelType, DbModelType>,
       serializer.encodeFields(obj)
     );
   }
@@ -166,11 +174,12 @@ export class DocumentSnapshot<T = firestore.DocumentData>
    * @param data The field/value map to expand.
    * @return The created DocumentSnapshot.
    */
-  static fromUpdateMap<U>(
-    ref: firestore.DocumentReference<U>,
+  static fromUpdateMap<AppModelType, DbModelType>(
+    ref: firestore.DocumentReference<AppModelType, DbModelType>,
     data: UpdateMap
-  ): DocumentSnapshot<U> {
-    const serializer = (ref as DocumentReference<U>).firestore._serializer!;
+  ): DocumentSnapshot<AppModelType, DbModelType> {
+    const serializer = (ref as DocumentReference<AppModelType, DbModelType>)
+      .firestore._serializer!;
 
     /**
      * Merges 'value' at the field path specified by the path array into
@@ -240,7 +249,10 @@ export class DocumentSnapshot<T = firestore.DocumentData>
       merge(res, value, path, 0);
     }
 
-    return new DocumentSnapshot(ref as DocumentReference<U>, res);
+    return new DocumentSnapshot(
+      ref as DocumentReference<AppModelType, DbModelType>,
+      res
+    );
   }
 
   /**
@@ -284,7 +296,7 @@ export class DocumentSnapshot<T = firestore.DocumentData>
    * });
    * ```
    */
-  get ref(): DocumentReference<T> {
+  get ref(): DocumentReference<AppModelType, DbModelType> {
     return this._ref;
   }
 
@@ -399,7 +411,7 @@ export class DocumentSnapshot<T = firestore.DocumentData>
    * });
    * ```
    */
-  data(): T | undefined {
+  data(): AppModelType | undefined {
     const fields = this._fieldsProto;
 
     if (fields === undefined) {
@@ -414,7 +426,7 @@ export class DocumentSnapshot<T = firestore.DocumentData>
         this.ref._path
       );
       return this.ref._converter.fromFirestore(
-        new QueryDocumentSnapshot<firestore.DocumentData>(
+        new QueryDocumentSnapshot(
           untypedReference,
           this._fieldsProto!,
           this.readTime,
@@ -427,7 +439,7 @@ export class DocumentSnapshot<T = firestore.DocumentData>
       for (const prop of Object.keys(fields)) {
         obj[prop] = this._serializer.decodeValue(fields[prop]);
       }
-      return obj as T;
+      return obj as AppModelType;
     }
   }
 
@@ -535,13 +547,17 @@ export class DocumentSnapshot<T = firestore.DocumentData>
    * @return {boolean} true if this `DocumentSnapshot` is equal to the provided
    * value.
    */
-  isEqual(other: firestore.DocumentSnapshot<T>): boolean {
+  isEqual(
+    other: firestore.DocumentSnapshot<AppModelType, DbModelType>
+  ): boolean {
     // Since the read time is different on every document read, we explicitly
     // ignore all document metadata in this comparison.
     return (
       this === other ||
       (other instanceof DocumentSnapshot &&
-        this._ref.isEqual((other as DocumentSnapshot<T>)._ref) &&
+        this._ref.isEqual(
+          (other as DocumentSnapshot<AppModelType, DbModelType>)._ref
+        ) &&
         deepEqual(this._fieldsProto, other._fieldsProto))
     );
   }
@@ -562,9 +578,12 @@ export class DocumentSnapshot<T = firestore.DocumentData>
  * @class QueryDocumentSnapshot
  * @extends DocumentSnapshot
  */
-export class QueryDocumentSnapshot<T = firestore.DocumentData>
-  extends DocumentSnapshot<T>
-  implements firestore.QueryDocumentSnapshot<T>
+export class QueryDocumentSnapshot<
+    AppModelType = firestore.DocumentData,
+    DbModelType extends firestore.DocumentData = firestore.DocumentData
+  >
+  extends DocumentSnapshot<AppModelType, DbModelType>
+  implements firestore.QueryDocumentSnapshot<AppModelType, DbModelType>
 {
   /**
    * The time the document was created.
@@ -626,7 +645,7 @@ export class QueryDocumentSnapshot<T = firestore.DocumentData>
    * });
    * ```
    */
-  data(): T {
+  data(): AppModelType {
     const data = super.data();
     if (!data) {
       throw new Error(