Merge remote-tracking branch 'origin/master' into BloomFilterTestRunsWithMemoryLruGc [skip actions]

Author: dconeybe

.changeset/rude-terms-remain.md

@@ -0,0 +1,6 @@
+---
+'@firebase/firestore': major
+'firebase': major
+---
+
+Fixed updateDoc() typing issue by adding a 2nd type parameter to FirestoreDataConverter

common/api-review/firestore-lite.api.md

@@ -15,14 +15,14 @@ The results of executing an aggregation query.
 <b>Signature:</b>
 
 ```typescript
-export declare class AggregateQuerySnapshot<T extends AggregateSpec> 
+export declare class AggregateQuerySnapshot<AggregateSpecType extends AggregateSpec, AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 
 ```
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [query](./firestore_.aggregatequerysnapshot.md#aggregatequerysnapshotquery) |  | [Query](./firestore_.query.md#query_class)<!-- -->&lt;unknown&gt; | The underlying query over which the aggregations recorded in this <code>AggregateQuerySnapshot</code> were performed. |
+|  [query](./firestore_.aggregatequerysnapshot.md#aggregatequerysnapshotquery) |  | [Query](./firestore_.query.md#query_class)<!-- -->&lt;AppModelType, DbModelType&gt; | The underlying query over which the aggregations recorded in this <code>AggregateQuerySnapshot</code> were performed. |
 |  [type](./firestore_.aggregatequerysnapshot.md#aggregatequerysnapshottype) |  | (not declared) | A type string to uniquely identify instances of this class. |
 
 ## Methods
@@ -38,7 +38,7 @@ The underlying query over which the aggregations recorded in this `AggregateQuer
 <b>Signature:</b>
 
 ```typescript
-readonly query: Query<unknown>;
+readonly query: Query<AppModelType, DbModelType>;
 ```
 
 ## AggregateQuerySnapshot.type
@@ -60,11 +60,11 @@ The keys of the returned object will be the same as those of the `AggregateSpec`
 <b>Signature:</b>
 
 ```typescript
-data(): AggregateSpecData<T>;
+data(): AggregateSpecData<AggregateSpecType>;
 ```
 <b>Returns:</b>
 
-[AggregateSpecData](./firestore_.md#aggregatespecdata)<!-- -->&lt;T&gt;
+[AggregateSpecData](./firestore_.md#aggregatespecdata)<!-- -->&lt;AggregateSpecType&gt;
 
 The results of the aggregations performed over the underlying query.
 

common/api-review/firestore.api.md

@@ -15,24 +15,24 @@ A `CollectionReference` object can be used for adding documents, getting documen
 <b>Signature:</b>
 
 ```typescript
-export declare class CollectionReference<T = DocumentData> extends Query<T> 
+export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType> 
 ```
-<b>Extends:</b> [Query](./firestore_.query.md#query_class)<!-- -->&lt;T&gt;
+<b>Extends:</b> [Query](./firestore_.query.md#query_class)<!-- -->&lt;AppModelType, DbModelType&gt;
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [id](./firestore_.collectionreference.md#collectionreferenceid) |  | string | The collection's identifier. |
-|  [parent](./firestore_.collectionreference.md#collectionreferenceparent) |  | [DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->&gt; \| null | A reference to the containing <code>DocumentReference</code> if this is a subcollection. If this isn't a subcollection, the reference is null. |
+|  [parent](./firestore_.collectionreference.md#collectionreferenceparent) |  | [DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->, [DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->&gt; \| null | A reference to the containing <code>DocumentReference</code> if this is a subcollection. If this isn't a subcollection, the reference is null. |
 |  [path](./firestore_.collectionreference.md#collectionreferencepath) |  | string | A string representing the path of the referenced collection (relative to the root of the database). |
 |  [type](./firestore_.collectionreference.md#collectionreferencetype) |  | (not declared) | The type of this Firestore reference. |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [withConverter(converter)](./firestore_.collectionreference.md#collectionreferencewithconverter) |  | Applies a custom data converter to this <code>CollectionReference</code>, allowing you to use your own custom model objects with Firestore. When you call [addDoc()](./firestore_.md#adddoc) with the returned <code>CollectionReference</code> instance, the provided converter will convert between Firestore data and your custom type <code>U</code>. |
+|  [withConverter(converter)](./firestore_.collectionreference.md#collectionreferencewithconverter) |  | Applies a custom data converter to this <code>CollectionReference</code>, allowing you to use your own custom model objects with Firestore. When you call [addDoc()](./firestore_.md#adddoc) with the returned <code>CollectionReference</code> instance, the provided converter will convert between Firestore data of type <code>NewDbModelType</code> and your custom type <code>NewAppModelType</code>. |
 |  [withConverter(converter)](./firestore_.collectionreference.md#collectionreferencewithconverter) |  | Removes the current converter. |
 
 ## CollectionReference.id
@@ -52,7 +52,7 @@ A reference to the containing `DocumentReference` if this is a subcollection. If
 <b>Signature:</b>
 
 ```typescript
-get parent(): DocumentReference<DocumentData> | null;
+get parent(): DocumentReference<DocumentData, DocumentData> | null;
 ```
 
 ## CollectionReference.path
@@ -77,25 +77,25 @@ readonly type = "collection";
 
 ## CollectionReference.withConverter()
 
-Applies a custom data converter to this `CollectionReference`<!-- -->, allowing you to use your own custom model objects with Firestore. When you call [addDoc()](./firestore_.md#adddoc) with the returned `CollectionReference` instance, the provided converter will convert between Firestore data and your custom type `U`<!-- -->.
+Applies a custom data converter to this `CollectionReference`<!-- -->, allowing you to use your own custom model objects with Firestore. When you call [addDoc()](./firestore_.md#adddoc) with the returned `CollectionReference` instance, the provided converter will convert between Firestore data of type `NewDbModelType` and your custom type `NewAppModelType`<!-- -->.
 
 <b>Signature:</b>
 
 ```typescript
-withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
+withConverter<NewAppModelType, NewDbModelType extends DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;
 ```
 
 ### Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;U&gt; | Converts objects to and from Firestore. |
+|  converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;NewAppModelType, NewDbModelType&gt; | Converts objects to and from Firestore. |
 
 <b>Returns:</b>
 
-[CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;U&gt;
+[CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;NewAppModelType, NewDbModelType&gt;
 
-A `CollectionReference<U>` that uses the provided converter.
+A `CollectionReference` that uses the provided converter.
 
 ## CollectionReference.withConverter()
 
@@ -104,7 +104,7 @@ Removes the current converter.
 <b>Signature:</b>
 
 ```typescript
-withConverter(converter: null): CollectionReference<DocumentData>;
+withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
 ```
 
 ### Parameters
@@ -115,7 +115,7 @@ withConverter(converter: null): CollectionReference<DocumentData>;
 
 <b>Returns:</b>
 
-[CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->&gt;
+[CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->, [DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->&gt;
 
-A `CollectionReference<DocumentData>` that does not use a converter.
+A `CollectionReference<DocumentData, DocumentData>` that does not use a converter.
 

docs-devsite/firestore_.aggregatequerysnapshot.md

@@ -15,14 +15,14 @@ A `DocumentChange` represents a change to the documents matching a query. It con
 <b>Signature:</b>
 
 ```typescript
-export declare interface DocumentChange<T = DocumentData> 
+export declare interface DocumentChange<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 
 ```
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [doc](./firestore_.documentchange.md#documentchangedoc) | [QueryDocumentSnapshot](./firestore_.querydocumentsnapshot.md#querydocumentsnapshot_class)<!-- -->&lt;T&gt; | The document affected by this change. |
+|  [doc](./firestore_.documentchange.md#documentchangedoc) | [QueryDocumentSnapshot](./firestore_.querydocumentsnapshot.md#querydocumentsnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt; | The document affected by this change. |
 |  [newIndex](./firestore_.documentchange.md#documentchangenewindex) | number | The index of the changed document in the result set immediately after this <code>DocumentChange</code> (i.e. supposing that all prior <code>DocumentChange</code> objects and the current <code>DocumentChange</code> object have been applied). Is -1 for 'removed' events. |
 |  [oldIndex](./firestore_.documentchange.md#documentchangeoldindex) | number | The index of the changed document in the result set immediately prior to this <code>DocumentChange</code> (i.e. supposing that all prior <code>DocumentChange</code> objects have been applied). Is <code>-1</code> for 'added' events. |
 |  [type](./firestore_.documentchange.md#documentchangetype) | [DocumentChangeType](./firestore_.md#documentchangetype) | The type of change ('added', 'modified', or 'removed'). |
@@ -34,7 +34,7 @@ The document affected by this change.
 <b>Signature:</b>
 
 ```typescript
-readonly doc: QueryDocumentSnapshot<T>;
+readonly doc: QueryDocumentSnapshot<AppModelType, DbModelType>;
 ```
 
 ## DocumentChange.newIndex

docs-devsite/firestore_.collectionreference.md

@@ -15,25 +15,25 @@ A `DocumentReference` refers to a document location in a Firestore database and
 <b>Signature:</b>
 
 ```typescript
-export declare class DocumentReference<T = DocumentData> 
+export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 
 ```
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [converter](./firestore_.documentreference.md#documentreferenceconverter) |  | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;T&gt; \| null | If provided, the <code>FirestoreDataConverter</code> associated with this instance. |
+|  [converter](./firestore_.documentreference.md#documentreferenceconverter) |  | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;AppModelType, DbModelType&gt; \| null | If provided, the <code>FirestoreDataConverter</code> associated with this instance. |
 |  [firestore](./firestore_.documentreference.md#documentreferencefirestore) |  | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance the document is in. This is useful for performing transactions, for example. |
 |  [id](./firestore_.documentreference.md#documentreferenceid) |  | string | The document's identifier within its collection. |
-|  [parent](./firestore_.documentreference.md#documentreferenceparent) |  | [CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;T&gt; | The collection this <code>DocumentReference</code> belongs to. |
+|  [parent](./firestore_.documentreference.md#documentreferenceparent) |  | [CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;AppModelType, DbModelType&gt; | The collection this <code>DocumentReference</code> belongs to. |
 |  [path](./firestore_.documentreference.md#documentreferencepath) |  | string | A string representing the path of the referenced document (relative to the root of the database). |
 |  [type](./firestore_.documentreference.md#documentreferencetype) |  | (not declared) | The type of this Firestore reference. |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [withConverter(converter)](./firestore_.documentreference.md#documentreferencewithconverter) |  | Applies a custom data converter to this <code>DocumentReference</code>, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.md#setdoc)<!-- -->, [getDoc()](./firestore_lite.md#getdoc)<!-- -->, etc. with the returned <code>DocumentReference</code> instance, the provided converter will convert between Firestore data and your custom type <code>U</code>. |
+|  [withConverter(converter)](./firestore_.documentreference.md#documentreferencewithconverter) |  | Applies a custom data converter to this <code>DocumentReference</code>, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.md#setdoc)<!-- -->, [getDoc()](./firestore_lite.md#getdoc)<!-- -->, etc. with the returned <code>DocumentReference</code> instance, the provided converter will convert between Firestore data of type <code>NewDbModelType</code> and your custom type <code>NewAppModelType</code>. |
 |  [withConverter(converter)](./firestore_.documentreference.md#documentreferencewithconverter) |  | Removes the current converter. |
 
 ## DocumentReference.converter
@@ -43,7 +43,7 @@ If provided, the `FirestoreDataConverter` associated with this instance.
 <b>Signature:</b>
 
 ```typescript
-readonly converter: FirestoreDataConverter<T> | null;
+readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
 ```
 
 ## DocumentReference.firestore
@@ -73,7 +73,7 @@ The collection this `DocumentReference` belongs to.
 <b>Signature:</b>
 
 ```typescript
-get parent(): CollectionReference<T>;
+get parent(): CollectionReference<AppModelType, DbModelType>;
 ```
 
 ## DocumentReference.path
@@ -98,25 +98,25 @@ readonly type = "document";
 
 ## DocumentReference.withConverter()
 
-Applies a custom data converter to this `DocumentReference`<!-- -->, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.md#setdoc)<!-- -->, [getDoc()](./firestore_lite.md#getdoc)<!-- -->, etc. with the returned `DocumentReference` instance, the provided converter will convert between Firestore data and your custom type `U`<!-- -->.
+Applies a custom data converter to this `DocumentReference`<!-- -->, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.md#setdoc)<!-- -->, [getDoc()](./firestore_lite.md#getdoc)<!-- -->, etc. with the returned `DocumentReference` instance, the provided converter will convert between Firestore data of type `NewDbModelType` and your custom type `NewAppModelType`<!-- -->.
 
 <b>Signature:</b>
 
 ```typescript
-withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
+withConverter<NewAppModelType, NewDbModelType extends DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
 ```
 
 ### Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;U&gt; | Converts objects to and from Firestore. |
+|  converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;NewAppModelType, NewDbModelType&gt; | Converts objects to and from Firestore. |
 
 <b>Returns:</b>
 
-[DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;U&gt;
+[DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;NewAppModelType, NewDbModelType&gt;
 
-A `DocumentReference<U>` that uses the provided converter.
+A `DocumentReference` that uses the provided converter.
 
 ## DocumentReference.withConverter()
 
@@ -125,7 +125,7 @@ Removes the current converter.
 <b>Signature:</b>
 
 ```typescript
-withConverter(converter: null): DocumentReference<DocumentData>;
+withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
 ```
 
 ### Parameters
@@ -136,7 +136,7 @@ withConverter(converter: null): DocumentReference<DocumentData>;
 
 <b>Returns:</b>
 
-[DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->&gt;
+[DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->, [DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->&gt;
 
-A `DocumentReference<DocumentData>` that does not use a converter.
+A `DocumentReference<DocumentData, DocumentData>` that does not use a converter.
 

docs-devsite/firestore_.documentchange.md

@@ -17,7 +17,7 @@ For a `DocumentSnapshot` that points to a non-existing document, any data access
 <b>Signature:</b>
 
 ```typescript
-export declare class DocumentSnapshot<T = DocumentData> 
+export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 
 ```
 
 ## Constructors
@@ -32,7 +32,7 @@ export declare class DocumentSnapshot<T = DocumentData>
 |  --- | --- | --- | --- |
 |  [id](./firestore_.documentsnapshot.md#documentsnapshotid) |  | string | Property of the <code>DocumentSnapshot</code> that provides the document's ID. |
 |  [metadata](./firestore_.documentsnapshot.md#documentsnapshotmetadata) |  | [SnapshotMetadata](./firestore_.snapshotmetadata.md#snapshotmetadata_class) | Metadata about the <code>DocumentSnapshot</code>, including information about its source and local modifications. |
-|  [ref](./firestore_.documentsnapshot.md#documentsnapshotref) |  | [DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;T&gt; | The <code>DocumentReference</code> for the document included in the <code>DocumentSnapshot</code>. |
+|  [ref](./firestore_.documentsnapshot.md#documentsnapshotref) |  | [DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;AppModelType, DbModelType&gt; | The <code>DocumentReference</code> for the document included in the <code>DocumentSnapshot</code>. |
 
 ## Methods
 
@@ -79,7 +79,7 @@ The `DocumentReference` for the document included in the `DocumentSnapshot`<!--
 <b>Signature:</b>
 
 ```typescript
-get ref(): DocumentReference<T>;
+get ref(): DocumentReference<AppModelType, DbModelType>;
 ```
 
 ## DocumentSnapshot.data()
@@ -91,7 +91,7 @@ By default, `serverTimestamp()` values that have not yet been set to their final
 <b>Signature:</b>
 
 ```typescript
-data(options?: SnapshotOptions): T | undefined;
+data(options?: SnapshotOptions): AppModelType | undefined;
 ```
 
 ### Parameters
@@ -102,7 +102,7 @@ data(options?: SnapshotOptions): T | undefined;
 
 <b>Returns:</b>
 
-T \| undefined
+AppModelType \| undefined
 
 An `Object` containing all fields in the document or `undefined` if the document doesn't exist.
 
@@ -113,11 +113,11 @@ Returns whether or not the data exists. True if the document exists.
 <b>Signature:</b>
 
 ```typescript
-exists(): this is QueryDocumentSnapshot<T>;
+exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
 ```
 <b>Returns:</b>
 
-this is [QueryDocumentSnapshot](./firestore_.querydocumentsnapshot.md#querydocumentsnapshot_class)<!-- -->&lt;T&gt;
+this is [QueryDocumentSnapshot](./firestore_.querydocumentsnapshot.md#querydocumentsnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;
 
 ## DocumentSnapshot.get()