react-query-firebase 2.3.3 → 2.4.0

package/react-native/firestore/utils/buildQueryConstraint.js

@@ -0,0 +1,41 @@
+import { orderBy, startAt, startAfter, endAt, endBefore, limit, limitToLast } from "@react-native-firebase/firestore";
+/**
+ * A generic mothod to build query constraints for firebase
+ *
+ * @group Utility
+ *
+ * @param {NonFilterQueryConstraint<AppModelType>} constraint
+ *
+ * @returns {FirebaseFirestoreTypes.QueryNonFilterConstraint}
+ *
+ * @example
+ * ```jsx
+ * const firebaseConfig = {};
+ * export const constraint = useMemo(() => {
+ *  return buildQueryConstraint({
+ *      type: 'limit',
+ *      limit: 1
+ *  });
+ * };
+ * ```
+ */
+export const buildQueryConstraint = (constraint) => {
+    switch (constraint.type) {
+        case "orderBy":
+            return orderBy(constraint.fieldPath, constraint.directionStr);
+        case "startAt":
+            return startAt(...constraint.arguments);
+        case "startAfter":
+            return startAfter(...constraint.arguments);
+        case "endAt":
+            return endAt(constraint.value, constraint.key);
+        case "endBefore":
+            return endBefore(constraint.value, constraint.key);
+        case "limit":
+            return limit(constraint.limit);
+        case "limitToLast":
+            return limitToLast(constraint.limit);
+        default:
+            throw new Error(`Unsupported constaint ${JSON.stringify(constraint)}`);
+    }
+};

package/react-native/firestore/utils/buildQueryConstraint.ts

@@ -0,0 +1,54 @@
+import {
+    type QueryNonFilterConstraint,
+    orderBy,
+    startAt,
+    startAfter,
+    endAt,
+    endBefore,
+    limit,
+    limitToLast
+} from "@react-native-firebase/firestore";
+import { AppModel, type NonFilterQueryConstraint } from "../../../types";
+
+/**
+ * A generic mothod to build query constraints for firebase
+ *
+ * @group Utility
+ *
+ * @param {NonFilterQueryConstraint<AppModelType>} constraint
+ *
+ * @returns {FirebaseFirestoreTypes.QueryNonFilterConstraint}
+ *
+ * @example
+ * ```jsx
+ * const firebaseConfig = {};
+ * export const constraint = useMemo(() => {
+ *  return buildQueryConstraint({
+ *      type: 'limit',
+ *      limit: 1
+ *  });
+ * };
+ * ```
+ */
+export const buildQueryConstraint = <AppModelType extends AppModel = AppModel>(
+    constraint: NonFilterQueryConstraint<AppModelType>
+): QueryNonFilterConstraint => {
+    switch (constraint.type) {
+        case "orderBy":
+            return orderBy(constraint.fieldPath as string, constraint.directionStr);
+        case "startAt":
+            return startAt(...constraint.arguments);
+        case "startAfter":
+            return startAfter(...constraint.arguments);
+        case "endAt":
+            return endAt(constraint.value, constraint.key);
+        case "endBefore":
+            return endBefore(constraint.value, constraint.key);
+        case "limit":
+            return limit(constraint.limit);
+        case "limitToLast":
+            return limitToLast(constraint.limit);
+        default:
+            throw new Error(`Unsupported constaint ${JSON.stringify(constraint)}`);
+    }
+};

package/react-native/firestore/utils/getDocData.d.ts

@@ -1,18 +1,18 @@
-import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
 import { GetDocSnapOptions } from "./getDocSnap";
-export type GetDocDataOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData> = GetDocSnapOptions<AppModelType>;
+import { AppModel } from "../../../types";
 /**
- * Asynchronously retrieves document data from a specified database and reference.
+ * @inline
+ */
+export type GetDocDataOptions<AppModelType extends AppModel = AppModel> = GetDocSnapOptions<AppModelType>;
+/**
+ * Asynchronously retrieves document data from a specified database reference.
  * Utilizes the helper function `getDocSnap` to fetch the document snapshot and
  * checks if the document exists before returning its data.
  *
- * @param {Object} options - The options for fetching document data.
- * @param {FirebaseFirestore} options.db - The Firestore database instance.
- * @param {DocumentReference=} options.reference - The document reference. This is an optional parameter.
- * @param {string=} options.path - The path to the document in the database. This is an optional parameter.
- * @param {Array<string>=} options.pathSegments - The path segments for the document's path. This is an optional parameter.
+ * @group Utility
+ *
+ * @param {GetDocDataOptions<AppModelType>} options - The options for fetching document data.
  *
- * @returns {Promise<AppModelType | null>} Returns a promise that resolves to the document data if it exists,
- * or null if the document does not exist.
+ * @returns {Promise<AppModelType | null>} Returns a promise that resolves to the document data if it exists, or null if the document does not exist.
  */
-export declare const getDocData: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ db, reference, path, pathSegments }: GetDocDataOptions<AppModelType>) => Promise<AppModelType | null | undefined>;
+export declare const getDocData: <AppModelType extends AppModel = AppModel>({ db, reference, path, pathSegments }: GetDocDataOptions<AppModelType>) => Promise<AppModelType | null>;

package/react-native/firestore/utils/getDocData.js

@@ -1,17 +1,14 @@
 import { getDocSnap } from "./getDocSnap";
 /**
- * Asynchronously retrieves document data from a specified database and reference.
+ * Asynchronously retrieves document data from a specified database reference.
  * Utilizes the helper function `getDocSnap` to fetch the document snapshot and
  * checks if the document exists before returning its data.
  *
- * @param {Object} options - The options for fetching document data.
- * @param {FirebaseFirestore} options.db - The Firestore database instance.
- * @param {DocumentReference=} options.reference - The document reference. This is an optional parameter.
- * @param {string=} options.path - The path to the document in the database. This is an optional parameter.
- * @param {Array<string>=} options.pathSegments - The path segments for the document's path. This is an optional parameter.
+ * @group Utility
  *
- * @returns {Promise<AppModelType | null>} Returns a promise that resolves to the document data if it exists,
- * or null if the document does not exist.
+ * @param {GetDocDataOptions<AppModelType>} options - The options for fetching document data.
+ *
+ * @returns {Promise<AppModelType | null>} Returns a promise that resolves to the document data if it exists, or null if the document does not exist.
  */
 export const getDocData = async ({ db, reference, path, pathSegments }) => {
     const docSnap = await getDocSnap({ db, reference, path, pathSegments });

package/react-native/firestore/utils/getDocData.ts

@@ -1,27 +1,23 @@
-import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
 import { getDocSnap, GetDocSnapOptions } from "./getDocSnap";
+import { AppModel } from "../../../types";
 
-export type GetDocDataOptions<
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
-> = GetDocSnapOptions<AppModelType>;
+/**
+ * @inline
+ */
+export type GetDocDataOptions<AppModelType extends AppModel = AppModel> = GetDocSnapOptions<AppModelType>;
 
 /**
- * Asynchronously retrieves document data from a specified database and reference.
+ * Asynchronously retrieves document data from a specified database reference.
  * Utilizes the helper function `getDocSnap` to fetch the document snapshot and
  * checks if the document exists before returning its data.
  *
- * @param {Object} options - The options for fetching document data.
- * @param {FirebaseFirestore} options.db - The Firestore database instance.
- * @param {DocumentReference=} options.reference - The document reference. This is an optional parameter.
- * @param {string=} options.path - The path to the document in the database. This is an optional parameter.
- * @param {Array<string>=} options.pathSegments - The path segments for the document's path. This is an optional parameter.
+ * @group Utility
+ *
+ * @param {GetDocDataOptions<AppModelType>} options - The options for fetching document data.
  *
- * @returns {Promise<AppModelType | null>} Returns a promise that resolves to the document data if it exists,
- * or null if the document does not exist.
+ * @returns {Promise<AppModelType | null>} Returns a promise that resolves to the document data if it exists, or null if the document does not exist.
  */
-export const getDocData = async <
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
->({
+export const getDocData = async <AppModelType extends AppModel = AppModel>({
     db,
     reference,
     path,
@@ -30,7 +26,7 @@ export const getDocData = async <
     const docSnap = await getDocSnap<AppModelType>({ db, reference, path, pathSegments });
 
     if (docSnap && docSnap?.exists) {
-        return docSnap.data();
+        return docSnap.data() as AppModelType;
     }
 
     return null;

package/react-native/firestore/utils/getDocRef.d.ts

@@ -1,5 +1,9 @@
 import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
-export type GetDocRefOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData> = {
+import { AppModel } from "../../../types";
+/**
+ * @inline
+ */
+export type GetDocRefOptions<AppModelType extends AppModel = AppModel> = {
     db: FirebaseFirestoreTypes.Module;
     reference?: FirebaseFirestoreTypes.CollectionReference<AppModelType> | FirebaseFirestoreTypes.DocumentReference<AppModelType>;
     path?: string;
@@ -7,13 +11,12 @@ export type GetDocRefOptions<AppModelType extends FirebaseFirestoreTypes.Documen
 };
 /**
  * Retrieves a document reference based on provided database options.
- * Either `reference` or `path` must be provided, not both.
+ * Either `reference` or `path`.
+ *
+ * @group Utility
+ *
+ * @param {GetDocRefOptions<AppModelType>} options - The options for building doc reference.
  *
- * @param {Object} options - The options for getting a document reference.
- * @param {FirebaseFirestoreTypes.Module} options.db - The Firestore database instance.
- * @param {FirebaseFirestoreTypes.DocumentReference | FirebaseFirestoreTypes.CollectionReference | null} [options.reference] - Reference to a document or collection.
- * @param {string | null} [options.path] - Path to the document.
- * @param {string[] | null} [options.pathSegments] - Additional path segments if any.
- * @returns {FirebaseFirestoreTypes.DocumentReference<AppModelType>} The document reference.
+ * @returns {DocumentReference<AppModelType, AppModelType>} Returns a document reference
  */
-export declare const getDocRef: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ db, reference, path, pathSegments }: GetDocRefOptions<AppModelType>) => Promise<FirebaseFirestoreTypes.DocumentReference<AppModelType>>;
+export declare const getDocRef: <AppModelType extends AppModel = AppModel>({ db, reference, path, pathSegments }: GetDocRefOptions<AppModelType>) => FirebaseFirestoreTypes.DocumentReference<AppModelType>;

package/react-native/firestore/utils/getDocRef.js

@@ -1,16 +1,15 @@
 import { doc } from "@react-native-firebase/firestore";
 /**
  * Retrieves a document reference based on provided database options.
- * Either `reference` or `path` must be provided, not both.
+ * Either `reference` or `path`.
  *
- * @param {Object} options - The options for getting a document reference.
- * @param {FirebaseFirestoreTypes.Module} options.db - The Firestore database instance.
- * @param {FirebaseFirestoreTypes.DocumentReference | FirebaseFirestoreTypes.CollectionReference | null} [options.reference] - Reference to a document or collection.
- * @param {string | null} [options.path] - Path to the document.
- * @param {string[] | null} [options.pathSegments] - Additional path segments if any.
- * @returns {FirebaseFirestoreTypes.DocumentReference<AppModelType>} The document reference.
+ * @group Utility
+ *
+ * @param {GetDocRefOptions<AppModelType>} options - The options for building doc reference.
+ *
+ * @returns {DocumentReference<AppModelType, AppModelType>} Returns a document reference
  */
-export const getDocRef = async ({ db, reference, path, pathSegments }) => {
+export const getDocRef = ({ db, reference, path, pathSegments }) => {
     if (!reference && !path) {
         throw new Error("One of the options must be provided: path or reference.");
     }

package/react-native/firestore/utils/getDocRef.ts

@@ -1,8 +1,10 @@
 import { doc, FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
+import { AppModel } from "../../../types";
 
-export type GetDocRefOptions<
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
-> = {
+/**
+ * @inline
+ */
+export type GetDocRefOptions<AppModelType extends AppModel = AppModel> = {
     db: FirebaseFirestoreTypes.Module;
     reference?:
         | FirebaseFirestoreTypes.CollectionReference<AppModelType>
@@ -13,18 +15,15 @@ export type GetDocRefOptions<
 
 /**
  * Retrieves a document reference based on provided database options.
- * Either `reference` or `path` must be provided, not both.
+ * Either `reference` or `path`.
+ *
+ * @group Utility
+ *
+ * @param {GetDocRefOptions<AppModelType>} options - The options for building doc reference.
  *
- * @param {Object} options - The options for getting a document reference.
- * @param {FirebaseFirestoreTypes.Module} options.db - The Firestore database instance.
- * @param {FirebaseFirestoreTypes.DocumentReference | FirebaseFirestoreTypes.CollectionReference | null} [options.reference] - Reference to a document or collection.
- * @param {string | null} [options.path] - Path to the document.
- * @param {string[] | null} [options.pathSegments] - Additional path segments if any.
- * @returns {FirebaseFirestoreTypes.DocumentReference<AppModelType>} The document reference.
+ * @returns {DocumentReference<AppModelType, AppModelType>} Returns a document reference
  */
-export const getDocRef = async <
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
->({
+export const getDocRef = <AppModelType extends AppModel = AppModel>({
     db,
     reference,
     path,

package/react-native/firestore/utils/getDocSnap.d.ts

@@ -1,20 +1,18 @@
-import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
 import { GetDocRefOptions } from "./getDocRef";
-export type GetDocSnapOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData> = GetDocRefOptions<AppModelType>;
+import { AppModel } from "../../../types";
+/**
+ * @inline
+ */
+export type GetDocSnapOptions<AppModelType extends AppModel = AppModel> = GetDocRefOptions<AppModelType>;
 /**
  * Asynchronously retrieves a document snapshot from Firestore using a specified document reference
  * or path information. This function handles getting the appropriate document reference based on
  * the parameters provided, and then fetches the document data from Firestore.
  *
- * @param {GetDocSnapOptions<AppModelType, DbModelType>} options - An object containing options
- *                                                                for retrieving the document
- *                                                                snapshot.
- * @param {DocumentData} options.db - The Firestore database instance to perform the operation on.
- * @param {string} options.reference - A string representing a direct Firestore document reference.
- * @param {string} options.path - A Firestore path string leading to the document.
- * @param {string[]} options.pathSegments - An array of path segments to build the Firestore path.
- * @returns {Promise<FirebaseFirestoreTypes.DocumentData | null>} A promise that resolves to the document data if the
- *                                         document exists, or `null` if the document does not exist
- *                                         or if the reference could not be obtained.
+ * @group Utility
+ *
+ * @param {GetDocSnapOptions<AppModelType>} options - The options for retrieving the document snapshot
+ *
+ * @returns {Promise<DocumentSnapshot<AppModelType, AppModelType> | null>} Returns a document reference
  */
-export declare const getDocSnap: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ db, reference, path, pathSegments }: GetDocSnapOptions<AppModelType>) => Promise<FirebaseFirestoreTypes.DocumentSnapshot<AppModelType> | null>;
+export declare const getDocSnap: <AppModelType extends AppModel = AppModel>({ db, reference, path, pathSegments }: GetDocSnapOptions<AppModelType>) => Promise<import("@react-native-firebase/firestore").FirebaseFirestoreTypes.DocumentSnapshot<AppModelType> | null>;

package/react-native/firestore/utils/getDocSnap.js

@@ -5,16 +5,11 @@ import { getDocRef } from "./getDocRef";
  * or path information. This function handles getting the appropriate document reference based on
  * the parameters provided, and then fetches the document data from Firestore.
  *
- * @param {GetDocSnapOptions<AppModelType, DbModelType>} options - An object containing options
- *                                                                for retrieving the document
- *                                                                snapshot.
- * @param {DocumentData} options.db - The Firestore database instance to perform the operation on.
- * @param {string} options.reference - A string representing a direct Firestore document reference.
- * @param {string} options.path - A Firestore path string leading to the document.
- * @param {string[]} options.pathSegments - An array of path segments to build the Firestore path.
- * @returns {Promise<FirebaseFirestoreTypes.DocumentData | null>} A promise that resolves to the document data if the
- *                                         document exists, or `null` if the document does not exist
- *                                         or if the reference could not be obtained.
+ * @group Utility
+ *
+ * @param {GetDocSnapOptions<AppModelType>} options - The options for retrieving the document snapshot
+ *
+ * @returns {Promise<DocumentSnapshot<AppModelType, AppModelType> | null>} Returns a document reference
  */
 export const getDocSnap = async ({ db, reference, path, pathSegments }) => {
     const docRef = await getDocRef({ db, reference, path, pathSegments });

package/react-native/firestore/utils/getDocSnap.ts

@@ -1,29 +1,24 @@
-import { FirebaseFirestoreTypes, getDoc as firestoreGetDoc } from "@react-native-firebase/firestore";
+import { getDoc as firestoreGetDoc } from "@react-native-firebase/firestore";
 import { getDocRef, GetDocRefOptions } from "./getDocRef";
+import { AppModel } from "../../../types";
 
-export type GetDocSnapOptions<
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
-> = GetDocRefOptions<AppModelType>;
+/**
+ * @inline
+ */
+export type GetDocSnapOptions<AppModelType extends AppModel = AppModel> = GetDocRefOptions<AppModelType>;
 
 /**
  * Asynchronously retrieves a document snapshot from Firestore using a specified document reference
  * or path information. This function handles getting the appropriate document reference based on
  * the parameters provided, and then fetches the document data from Firestore.
  *
- * @param {GetDocSnapOptions<AppModelType, DbModelType>} options - An object containing options
- *                                                                for retrieving the document
- *                                                                snapshot.
- * @param {DocumentData} options.db - The Firestore database instance to perform the operation on.
- * @param {string} options.reference - A string representing a direct Firestore document reference.
- * @param {string} options.path - A Firestore path string leading to the document.
- * @param {string[]} options.pathSegments - An array of path segments to build the Firestore path.
- * @returns {Promise<FirebaseFirestoreTypes.DocumentData | null>} A promise that resolves to the document data if the
- *                                         document exists, or `null` if the document does not exist
- *                                         or if the reference could not be obtained.
+ * @group Utility
+ *
+ * @param {GetDocSnapOptions<AppModelType>} options - The options for retrieving the document snapshot
+ *
+ * @returns {Promise<DocumentSnapshot<AppModelType, AppModelType> | null>} Returns a document reference
  */
-export const getDocSnap = async <
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
->({
+export const getDocSnap = async <AppModelType extends AppModel = AppModel>({
     db,
     reference,
     path,

package/types/AppModel.d.ts

@@ -1,7 +1,10 @@
 /**
  * Generic definition for a data model
- * @group Models
  */
 export type AppModel = {
+    /**
+     * Unique identifier equl to documentId() from Firestore
+     */
+    uid?: string;
     [key: string]: unknown;
 };

package/types/AppModel.ts

@@ -1,7 +1,10 @@
 /**
  * Generic definition for a data model
- * @group Models
  */
 export type AppModel = {
+    /**
+     * Unique identifier equl to documentId() from Firestore
+     */
+    uid?: string;
     [key: string]: unknown;
 };

package/web/firestore/index.d.ts

@@ -15,3 +15,8 @@ export * from "./useSetDocMutation";
 export * from "./useUpdateDocMutation";
 export * from "./useGetRealtimeDocData";
 export * from "./useQueryConstraints";
+export * from "./utils/getDocData";
+export * from "./utils/getDocSnap";
+export * from "./utils/getDocRef";
+export * from "./utils/buildQueryConstraint";
+export * from "./utils/buildCompositeFilter";

package/web/firestore/index.js

@@ -15,3 +15,8 @@ export * from "./useSetDocMutation";
 export * from "./useUpdateDocMutation";
 export * from "./useGetRealtimeDocData";
 export * from "./useQueryConstraints";
+export * from "./utils/getDocData";
+export * from "./utils/getDocSnap";
+export * from "./utils/getDocRef";
+export * from "./utils/buildQueryConstraint";
+export * from "./utils/buildCompositeFilter";

package/web/firestore/index.ts

@@ -15,3 +15,8 @@ export * from "./useSetDocMutation";
 export * from "./useUpdateDocMutation";
 export * from "./useGetRealtimeDocData";
 export * from "./useQueryConstraints";
+export * from "./utils/getDocData";
+export * from "./utils/getDocSnap";
+export * from "./utils/getDocRef";
+export * from "./utils/buildQueryConstraint";
+export * from "./utils/buildCompositeFilter";

package/web/firestore/useAddDocMutation.d.ts

@@ -1,23 +1,51 @@
 import { UseMutationOptions } from "@tanstack/react-query";
-import { DocumentData, WithFieldValue, CollectionReference, FirestoreDataConverter } from "firebase/firestore";
+import { WithFieldValue, CollectionReference } from "firebase/firestore";
 import { FirebaseError } from "firebase/app";
+import { AppModel } from "../../types";
+/**
+ * @inline
+ */
 export type UseAddDocMutationValues<AppModelType> = {
+    /**
+     * Data to write
+     */
     data: WithFieldValue<AppModelType>;
 };
-export type UseAddDocMutationOptions<AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData, TContext = unknown> = {
-    reference: CollectionReference<AppModelType, DbModelType>;
-    converter?: FirestoreDataConverter<AppModelType, DbModelType>;
-    options?: Omit<UseMutationOptions<AppModelType, FirebaseError, UseAddDocMutationValues<AppModelType>, TContext>, "mutationFn" | "mutationKey">;
+/**
+ * @inline
+ */
+export type UseAddDocMutationOptions<AppModelType extends AppModel = AppModel, TContext = unknown> = {
+    /**
+     * Reference to a collection where document must be added
+     */
+    collectionReference: CollectionReference<AppModelType, AppModelType>;
+    /**
+     * Options for useMutation hook excluding mutationFn. MutationKey will be equal to reference.path by default.
+     */
+    options?: Omit<UseMutationOptions<AppModelType, FirebaseError, UseAddDocMutationValues<AppModelType>, TContext>, "mutationFn">;
 };
 /**
- * Provides a mutation hook to add a document to a Firestore collection utilizing React Query's `useMutation`.
- * It handles addition and optional conversion of the document data in Firestore.
+ * Executes a mutation and returns added document
+ *
+ * @group Hook
+ *
+ * @param {UseAddDocMutationOptions<AppModelType>} options - Configuration options for the mutation.
+ *
+ * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
  *
- * @param {Object} options - Options for the mutation hook
- * @param {FirebaseFirestore.CollectionReference<AppModelType>} options.reference - Firestore collection reference where the document should be added.
- * @param {FirebaseFirestore.FirestoreDataConverter<DbModelType>} [options.converter] - Optional data converter for reading and writing Firestore documents.
- * @param {UseMutationOptions<AppModelType, Error, { data: DbModelType }, TContext>} [options.options={}] - Optional configuration for the mutation.
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const {mutate} = useAddDocMutation({
+ *      options: {
+ *      },
+ *      reference: collection(),
+ *  });
  *
- * @returns {UseMutationResult<AppModelType, Error, { data: DbModelType }, TContext>} The mutation hook result containing status, error, and data of the mutation process.
+ *  // ....
+ *  mutate({data: {test: 'value'}});
+ *  // ....
+ * };
+ * ```
  */
-export declare const useAddDocMutation: <AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData, TContext = unknown>({ reference, converter, options }: UseAddDocMutationOptions<AppModelType, DbModelType, TContext>) => import("@tanstack/react-query").UseMutationResult<AppModelType, FirebaseError, UseAddDocMutationValues<AppModelType>, TContext>;
+export declare const useAddDocMutation: <AppModelType extends AppModel = AppModel, TContext = unknown>({ collectionReference, options }: UseAddDocMutationOptions<AppModelType, TContext>) => import("@tanstack/react-query").UseMutationResult<AppModelType, FirebaseError, UseAddDocMutationValues<AppModelType>, TContext>;

package/web/firestore/useAddDocMutation.js

@@ -2,25 +2,38 @@ import { useMutation } from "@tanstack/react-query";
 import { addDoc, getDoc } from "firebase/firestore";
 import { useMemo } from "react";
 /**
- * Provides a mutation hook to add a document to a Firestore collection utilizing React Query's `useMutation`.
- * It handles addition and optional conversion of the document data in Firestore.
+ * Executes a mutation and returns added document
  *
- * @param {Object} options - Options for the mutation hook
- * @param {FirebaseFirestore.CollectionReference<AppModelType>} options.reference - Firestore collection reference where the document should be added.
- * @param {FirebaseFirestore.FirestoreDataConverter<DbModelType>} [options.converter] - Optional data converter for reading and writing Firestore documents.
- * @param {UseMutationOptions<AppModelType, Error, { data: DbModelType }, TContext>} [options.options={}] - Optional configuration for the mutation.
+ * @group Hook
  *
- * @returns {UseMutationResult<AppModelType, Error, { data: DbModelType }, TContext>} The mutation hook result containing status, error, and data of the mutation process.
+ * @param {UseAddDocMutationOptions<AppModelType>} options - Configuration options for the mutation.
+ *
+ * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const {mutate} = useAddDocMutation({
+ *      options: {
+ *      },
+ *      reference: collection(),
+ *  });
+ *
+ *  // ....
+ *  mutate({data: {test: 'value'}});
+ *  // ....
+ * };
+ * ```
  */
-export const useAddDocMutation = ({ reference, converter, options = {} }) => {
-    const mutationKey = useMemo(() => [reference.path], [reference.path]);
+export const useAddDocMutation = ({ collectionReference, options = {} }) => {
+    const mutationKey = useMemo(() => [collectionReference.path], [collectionReference.path]);
     return useMutation({
+        mutationKey,
         ...options,
         mutationFn: async ({ data }) => {
-            const docRef = await addDoc(reference, data);
-            const docSnap = await getDoc(converter ? docRef.withConverter(converter) : docRef);
-            return docSnap.data();
-        },
-        mutationKey
+            const docRef = await addDoc(collectionReference, data);
+            const docSnap = await getDoc(docRef);
+            return { ...docSnap.data(), uid: docSnap.id };
+        }
     });
 };