refactor(firestore): remove the QueryDocumentSnapshot interface (#570)

capawesome-team · Feb 28, 2024 · eb15c5e · eb15c5e
1 parent 3cd502a
commit eb15c5e
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 26 deletions.
diff --git a/.changeset/purple-jobs-roll.md b/.changeset/purple-jobs-roll.md
@@ -0,0 +1,5 @@
+---
+'@capacitor-firebase/firestore': major
+---
+
+refactor: remove the `QueryDocumentSnapshot` interface
diff --git a/packages/firestore/BREAKING.md b/packages/firestore/BREAKING.md
@@ -1,3 +1,13 @@
 # Breaking Changes
 
 This is a comprehensive list of the breaking changes introduced in the major version releases of Capacitor Firebase Firestore plugin.
+
+## Versions
+
+- [Version 6.x.x](#version-6xx)
+
+## Version 6.x.x
+
+### `QueryDocumentSnapshot` interface
+
+The `QueryDocumentSnapshot` interface has been replaced with the `DocumentSnapshot` interface.
diff --git a/packages/firestore/src/definitions.ts b/packages/firestore/src/definitions.ts
@@ -246,7 +246,7 @@ export interface GetCollectionResult<T> {
    *
    * @since 5.2.0
    */
-  snapshots: QueryDocumentSnapshot<T>[];
+  snapshots: DocumentSnapshot<T>[];
 }
 
 /**
@@ -282,7 +282,7 @@ export interface GetCollectionGroupResult<T> {
    *
    * @since 5.2.0
    */
-  snapshots: QueryDocumentSnapshot<T>[];
+  snapshots: DocumentSnapshot<T>[];
 }
 
 /**
@@ -409,30 +409,6 @@ export interface DocumentSnapshot<T> {
   data: T | null;
 }
 
-/**
- * @since 5.2.0
- */
-export interface QueryDocumentSnapshot<T> {
-  /**
-   * The document's identifier within its collection.
-   *
-   * @since 5.2.0
-   */
-  id: string;
-  /**
-   * The path of the document.
-   *
-   * @since 5.2.0
-   */
-  path: string;
-  /**
-   * An object containing the data for the document.
-   *
-   * @since 5.2.0
-   */
-  data: T;
-}
-
 /**
  * @since 5.2.0
  */