Merge master into release

Author: google-oss-bot

.changeset/empty-boats-dream.md

@@ -0,0 +1,6 @@
+---
+'@firebase/firestore-types': major
+'firebase': major
+---
+
+Update to be consistent with the FirestoreDataConverter changes from #7310

.changeset/soft-grapes-occur.md

@@ -0,0 +1,5 @@
+---
+'firebase': patch
+---
+
+Fix typings for v10

docs-devsite/database.datasnapshot.md

@@ -38,7 +38,7 @@ export declare class DataSnapshot
 |  [child(path)](./database.datasnapshot.md#datasnapshotchild) |  | Gets another <code>DataSnapshot</code> for the location at the specified relative path.<!-- -->Passing a relative path to the <code>child()</code> method of a DataSnapshot returns another <code>DataSnapshot</code> for the location at the specified relative path. The relative path can either be a simple child name (for example, "ada") or a deeper, slash-separated path (for example, "ada/name/first"). If the child location has no data, an empty <code>DataSnapshot</code> (that is, a <code>DataSnapshot</code> whose value is <code>null</code>) is returned. |
 |  [exists()](./database.datasnapshot.md#datasnapshotexists) |  | Returns true if this <code>DataSnapshot</code> contains any data. It is slightly more efficient than using <code>snapshot.val() !== null</code>. |
 |  [exportVal()](./database.datasnapshot.md#datasnapshotexportval) |  | Exports the entire contents of the DataSnapshot as a JavaScript object.<!-- -->The <code>exportVal()</code> method is similar to <code>val()</code>, except priority information is included (if available), making it suitable for backing up your data. |
-|  [forEach(action)](./database.datasnapshot.md#datasnapshotforeach) |  | Enumerates the top-level children in the <code>DataSnapshot</code>.<!-- -->Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by <code>val()</code> is not guaranteed to match the ordering on the server nor the ordering of <code>onChildAdded()</code> events. That is where <code>forEach()</code> comes in handy. It guarantees the children of a <code>DataSnapshot</code> will be iterated in their query order.<!-- -->If no explicit <code>orderBy*()</code> method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority). |
+|  [forEach(action)](./database.datasnapshot.md#datasnapshotforeach) |  | Enumerates the top-level children in the <code>IteratedDataSnapshot</code>.<!-- -->Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by <code>val()</code> is not guaranteed to match the ordering on the server nor the ordering of <code>onChildAdded()</code> events. That is where <code>forEach()</code> comes in handy. It guarantees the children of a <code>DataSnapshot</code> will be iterated in their query order.<!-- -->If no explicit <code>orderBy*()</code> method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority). |
 |  [hasChild(path)](./database.datasnapshot.md#datasnapshothaschild) |  | Returns true if the specified child path has (non-null) data. |
 |  [hasChildren()](./database.datasnapshot.md#datasnapshothaschildren) |  | Returns whether or not the <code>DataSnapshot</code> has any non-<code>null</code> child properties.<!-- -->You can use <code>hasChildren()</code> to determine if a <code>DataSnapshot</code> has any children. If it does, you can enumerate them using <code>forEach()</code>. If it doesn't, then either this snapshot contains a primitive value (which can be retrieved with <code>val()</code>) or it is empty (in which case, <code>val()</code> will return <code>null</code>). |
 |  [toJSON()](./database.datasnapshot.md#datasnapshottojson) |  | Returns a JSON-serializable representation of this object. |
@@ -142,7 +142,7 @@ The DataSnapshot's contents as a JavaScript value (Object, Array, string, number
 
 ## DataSnapshot.forEach()
 
-Enumerates the top-level children in the `DataSnapshot`<!-- -->.
+Enumerates the top-level children in the `IteratedDataSnapshot`<!-- -->.
 
 Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by `val()` is not guaranteed to match the ordering on the server nor the ordering of `onChildAdded()` events. That is where `forEach()` comes in handy. It guarantees the children of a `DataSnapshot` will be iterated in their query order.
 
@@ -151,14 +151,14 @@ If no explicit `orderBy*()` method is used, results are returned ordered by key
 <b>Signature:</b>
 
 ```typescript
-forEach(action: (child: DataSnapshot) => boolean | void): boolean;
+forEach(action: (child: IteratedDataSnapshot) => boolean | void): boolean;
 ```
 
 ### Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  action | (child: [DataSnapshot](./database.datasnapshot.md#datasnapshot_class)<!-- -->) =&gt; boolean \| void | A function that will be called for each child DataSnapshot. The callback can return true to cancel further enumeration. |
+|  action | (child: [IteratedDataSnapshot](./database.iterateddatasnapshot.md#iterateddatasnapshot_interface)<!-- -->) =&gt; boolean \| void | A function that will be called for each child DataSnapshot. The callback can return true to cancel further enumeration. |
 
 <b>Returns:</b>
 

docs-devsite/database.iterateddatasnapshot.md

@@ -0,0 +1,34 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# IteratedDataSnapshot interface
+Represents a child snapshot of a `Reference` that is being iterated over. The key will never be undefined.
+
+<b>Signature:</b>
+
+```typescript
+export declare interface IteratedDataSnapshot extends DataSnapshot 
+```
+<b>Extends:</b> [DataSnapshot](./database.datasnapshot.md#datasnapshot_class)
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [key](./database.iterateddatasnapshot.md#iterateddatasnapshotkey) | string |  |
+
+## IteratedDataSnapshot.key
+
+<b>Signature:</b>
+
+```typescript
+key: string;
+```

docs-devsite/database.md

@@ -94,6 +94,7 @@ Firebase Realtime Database
 |  Interface | Description |
 |  --- | --- |
 |  [DatabaseReference](./database.databasereference.md#databasereference_interface) | A <code>DatabaseReference</code> represents a specific location in your Database and can be used for reading or writing data to that Database location.<!-- -->You can reference the root or child location in your Database by calling <code>ref()</code> or <code>ref(&quot;child/path&quot;)</code>.<!-- -->Writing is done with the <code>set()</code> method and reading can be done with the <code>on*()</code> method. See [https://firebase.google.com/docs/database/web/read-and-write](https://firebase.google.com/docs/database/web/read-and-write) |
+|  [IteratedDataSnapshot](./database.iterateddatasnapshot.md#iterateddatasnapshot_interface) | Represents a child snapshot of a <code>Reference</code> that is being iterated over. The key will never be undefined. |
 |  [ListenOptions](./database.listenoptions.md#listenoptions_interface) | An options objects that can be used to customize a listener. |
 |  [Query](./database.query.md#query_interface) | A <code>Query</code> sorts and filters the data at a Database location so only a subset of the child data is included. This can be used to order a collection of data by some attribute (for example, height of dinosaurs) as well as to restrict a large list of items (for example, chat messages) down to a number suitable for synchronizing to the client. Queries are created by chaining together one or more of the filter methods defined here.<!-- -->Just as with a <code>DatabaseReference</code>, you can receive data from a <code>Query</code> by using the <code>on*()</code> methods. You will only receive events and <code>DataSnapshot</code>s for the subset of the data that matches your query.<!-- -->See [https://firebase.google.com/docs/database/web/lists-of-data\#sorting\_and\_filtering\_data](https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data) for more information. |
 |  [ThenableReference](./database.thenablereference.md#thenablereference_interface) | A <code>Promise</code> that can also act as a <code>DatabaseReference</code> when returned by [push()](./database.md#push)<!-- -->. The reference is available immediately and the <code>Promise</code> resolves as the write to the backend completes. |

packages/firebase/compat/index.d.ts

@@ -5819,7 +5819,7 @@ declare namespace firebase.database {
      *   returning true.
      */
     forEach(
-      action: (a: firebase.database.IteratorDataSnapshot) => boolean | void
+      action: (a: firebase.database.IteratedDataSnapshot) => boolean | void
     ): boolean;
     /**
      * Gets the priority value of the data in this `DataSnapshot`.
@@ -5998,6 +5998,10 @@ declare namespace firebase.database {
     toJSON(): Object | null;
   }
 
+  interface IteratedDataSnapshot extends DataSnapshot {
+    key: string; // key of the location of this snapshot.
+  }
+
   /**
    * The Firebase Database service interface.
    *

packages/firestore-types/index.d.ts

@@ -241,7 +241,10 @@ export interface GetOptions {
   readonly source?: 'default' | 'server' | 'cache';
 }
 
-export class DocumentReference<T = DocumentData> {
+export class DocumentReference<
+  T = DocumentData,
+  T2 extends DocumentData = DocumentData
+> {
   private constructor();
 
   readonly id: string;
@@ -307,7 +310,10 @@ export interface SnapshotMetadata {
   isEqual(other: SnapshotMetadata): boolean;
 }
 
-export class DocumentSnapshot<T = DocumentData> {
+export class DocumentSnapshot<
+  T = DocumentData,
+  T2 extends DocumentData = DocumentData
+> {
   protected constructor();
 
   readonly exists: boolean;
@@ -323,8 +329,9 @@ export class DocumentSnapshot<T = DocumentData> {
 }
 
 export class QueryDocumentSnapshot<
-  T = DocumentData
-> extends DocumentSnapshot<T> {
+  T = DocumentData,
+  T2 extends DocumentData = DocumentData
+> extends DocumentSnapshot<T, T2> {
   private constructor();
 
   data(options?: SnapshotOptions): T;
@@ -344,7 +351,7 @@ export type WhereFilterOp =
   | 'array-contains-any'
   | 'not-in';
 
-export class Query<T = DocumentData> {
+export class Query<T = DocumentData, T2 extends DocumentData = DocumentData> {
   protected constructor();
 
   readonly firestore: FirebaseFirestore;
@@ -409,7 +416,10 @@ export class Query<T = DocumentData> {
   withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
 }
 
-export class QuerySnapshot<T = DocumentData> {
+export class QuerySnapshot<
+  T = DocumentData,
+  T2 extends DocumentData = DocumentData
+> {
   private constructor();
 
   readonly query: Query<T>;
@@ -430,14 +440,20 @@ export class QuerySnapshot<T = DocumentData> {
 
 export type DocumentChangeType = 'added' | 'removed' | 'modified';
 
-export interface DocumentChange<T = DocumentData> {
+export interface DocumentChange<
+  T = DocumentData,
+  T2 extends DocumentData = DocumentData
+> {
   readonly type: DocumentChangeType;
   readonly doc: QueryDocumentSnapshot<T>;
   readonly oldIndex: number;
   readonly newIndex: number;
 }
 
-export class CollectionReference<T = DocumentData> extends Query<T> {
+export class CollectionReference<
+  T = DocumentData,
+  T2 extends DocumentData = DocumentData
+> extends Query<T, T2> {
   private constructor();
 
   readonly id: string;