Add QuerySnapshot.fromJSON converter variant.

Author: DellaBitta

common/api-review/firestore.api.md

@@ -655,7 +655,8 @@ export class QuerySnapshot<AppModelType = DocumentData, DbModelType extends Docu
     get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
     get empty(): boolean;
     forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
-    static fromJSON<AppModelType, DbModelType extends DocumentData = DocumentData>(db: Firestore, json: object): QuerySnapshot<AppModelType, DbModelType>;
+    static fromJSON(db: Firestore, json: object): QuerySnapshot;
+    static fromJSONUsingConverter<AppModelType, DbModelType extends DocumentData = DocumentData>(db: Firestore, json: object, converter: FirestoreDataConverter<AppModelType, DbModelType>): QuerySnapshot<AppModelType, DbModelType>;
     readonly metadata: SnapshotMetadata;
     readonly query: Query<AppModelType, DbModelType>;
     get size(): number;

docs-devsite/firestore_.querysnapshot.md

@@ -35,6 +35,7 @@ export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType exte
 |  [docChanges(options)](./firestore_.querysnapshot.md#querysnapshotdocchanges) |  | Returns an array of the documents changes since the last snapshot. If this is the first snapshot, all documents will be in the list as 'added' changes. |
 |  [forEach(callback, thisArg)](./firestore_.querysnapshot.md#querysnapshotforeach) |  | Enumerates all of the documents in the <code>QuerySnapshot</code>. |
 |  [fromJSON(db, json)](./firestore_.querysnapshot.md#querysnapshotfromjson) | <code>static</code> | Builds a <code>QuerySnapshot</code> instance from a JSON object created by [QuerySnapshot.toJSON()](./firestore_.querysnapshot.md#querysnapshottojson)<!-- -->. |
+|  [fromJSONUsingConverter(db, json, converter)](./firestore_.querysnapshot.md#querysnapshotfromjsonusingconverter) | <code>static</code> | Builds a <code>QuerySnapshot</code> instance from a JSON object created by [QuerySnapshot.toJSON()](./firestore_.querysnapshot.md#querysnapshottojson)<!-- -->. |
 |  [toJSON()](./firestore_.querysnapshot.md#querysnapshottojson) |  | Returns a JSON-serializable representation of this <code>QuerySnapshot</code> instance. |
 
 ## QuerySnapshot.docs
@@ -135,7 +136,7 @@ Builds a `QuerySnapshot` instance from a JSON object created by [QuerySnapshot.t
 <b>Signature:</b>
 
 ```typescript
-static fromJSON<AppModelType, DbModelType extends DocumentData = DocumentData>(db: Firestore, json: object): QuerySnapshot<AppModelType, DbModelType>;
+static fromJSON(db: Firestore, json: object): QuerySnapshot;
 ```
 
 #### Parameters
@@ -147,6 +148,30 @@ static fromJSON<AppModelType, DbModelType extends DocumentData = DocumentData>(d
 
 <b>Returns:</b>
 
+[QuerySnapshot](./firestore_.querysnapshot.md#querysnapshot_class)
+
+an instance of [QuerySnapshot](./firestore_.querysnapshot.md#querysnapshot_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.
+
+## QuerySnapshot.fromJSONUsingConverter()
+
+Builds a `QuerySnapshot` instance from a JSON object created by [QuerySnapshot.toJSON()](./firestore_.querysnapshot.md#querysnapshottojson)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+static fromJSONUsingConverter<AppModelType, DbModelType extends DocumentData = DocumentData>(db: Firestore, json: object, converter: FirestoreDataConverter<AppModelType, DbModelType>): QuerySnapshot<AppModelType, DbModelType>;
+```
+
+#### Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  db | [Firestore](./firestore_.firestore.md#firestore_class) |  |
+|  json | object | a JSON object represention of a <code>QuerySnapshot</code> instance. |
+|  converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;AppModelType, DbModelType&gt; | Converts objects to and from Firestore. |
+
+<b>Returns:</b>
+
 [QuerySnapshot](./firestore_.querysnapshot.md#querysnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;
 
 an instance of [QuerySnapshot](./firestore_.querysnapshot.md#querysnapshot_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.

packages/firestore/src/api/snapshot.ts

@@ -862,10 +862,44 @@ export class QuerySnapshot<
    * @returns an instance of {@link QuerySnapshot} if the JSON object could be
    * parsed. Throws a {@link FirestoreError} if an error occurs.
    */
-  static fromJSON<
+  static fromJSON(db: Firestore, json: object): QuerySnapshot {
+    return QuerySnapshot.fromJSONInternal(db, json, /* converter = */ null);
+  }
+
+  /**
+   * Builds a `QuerySnapshot` instance from a JSON object created by
+   * {@link QuerySnapshot.toJSON}.
+   *
+   * @param firestore - The {@link Firestore} instance the snapshot should be loaded for.
+   * @param json - a JSON object represention of a `QuerySnapshot` instance.
+   * @param converter - Converts objects to and from Firestore.
+   * @returns an instance of {@link QuerySnapshot} if the JSON object could be
+   * parsed. Throws a {@link FirestoreError} if an error occurs.
+   */
+  static fromJSONUsingConverter<
     AppModelType,
     DbModelType extends DocumentData = DocumentData
-  >(db: Firestore, json: object): QuerySnapshot<AppModelType, DbModelType> {
+  >(
+    db: Firestore,
+    json: object,
+    converter: FirestoreDataConverter<AppModelType, DbModelType>
+  ): QuerySnapshot<AppModelType, DbModelType> {
+    return QuerySnapshot.fromJSONInternal(db, json, converter);
+  }
+
+  /**
+   * Internal implementation for 'fromJSON' and 'fromJSONUsingCoverter'.
+   * @internal
+   * @private
+   */
+  private static fromJSONInternal<
+    AppModelType,
+    DbModelType extends DocumentData = DocumentData
+  >(
+    db: Firestore,
+    json: object,
+    converter: FirestoreDataConverter<AppModelType, DbModelType> | null
+  ): QuerySnapshot<AppModelType, DbModelType> {
     if (validateJSON(json, QuerySnapshot._jsonSchema)) {
       // Parse the bundle data.
       const serializer = newSerializer(db._databaseId);
@@ -914,7 +948,7 @@ export class QuerySnapshot<
       // Create an external Query object, required to construct the QuerySnapshot.
       const externalQuery = new Query<AppModelType, DbModelType>(
         db,
-        null,
+        converter,
         query
       );