react-query-firebase 2.3.2 → 2.4.0

package/package.json

@@ -74,5 +74,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.3.2"
+    "version": "2.4.0"
 }

package/react-native/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/react-native/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/react-native/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/react-native/firestore/useAddDocMutation.d.ts

@@ -1,21 +1,50 @@
 import { UseMutationOptions } from "@tanstack/react-query";
 import { FirebaseFirestoreTypes, WithFieldValue } from "@react-native-firebase/firestore";
 import { ReactNativeFirebase } from "@react-native-firebase/app";
+/**
+ * @inline
+ */
 export type UseAddDocMutationValues<AppModelType> = {
+    /**
+     * Data to write
+     */
     data: WithFieldValue<AppModelType>;
 };
+/**
+ * @inline
+ */
 export type UseAddDocMutationOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData, TContext = unknown> = {
-    reference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
-    options?: Omit<UseMutationOptions<AppModelType, ReactNativeFirebase.NativeFirebaseError, UseAddDocMutationValues<AppModelType>, TContext>, "mutationFn" | "mutationKey">;
+    /**
+     * Reference to a collection where document must be added
+     */
+    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
+    /**
+     * Options for useMutation hook excluding mutationFn. MutationKey will be equal to reference.path by default.
+     */
+    options?: Omit<UseMutationOptions<AppModelType, ReactNativeFirebase.NativeFirebaseError, 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.FirebaseFirestoreTypes.CollectionReference<AppModelType>} options.reference - Firestore collection reference where the document should be added.
- * @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 FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData, TContext = unknown>({ reference, options }: UseAddDocMutationOptions<AppModelType, TContext>) => import("@tanstack/react-query").UseMutationResult<AppModelType, ReactNativeFirebase.NativeFirebaseError, UseAddDocMutationValues<AppModelType>, TContext>;
+export declare const useAddDocMutation: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData, TContext = unknown>({ collectionReference, options }: UseAddDocMutationOptions<AppModelType, TContext>) => import("@tanstack/react-query").UseMutationResult<AppModelType, ReactNativeFirebase.NativeFirebaseError, UseAddDocMutationValues<AppModelType>, TContext>;

package/react-native/firestore/useAddDocMutation.js

@@ -2,24 +2,38 @@ import { useMutation } from "@tanstack/react-query";
 import { addDoc, getDoc } from "@react-native-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.FirebaseFirestoreTypes.CollectionReference<AppModelType>} options.reference - Firestore collection reference where the document should be added.
- * @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, 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 docRef = await addDoc(collectionReference, data);
             const docSnap = await getDoc(docRef);
             return docSnap.data();
-        },
-        mutationKey
+        }
     });
 };

package/react-native/firestore/useAddDocMutation.ts

@@ -4,15 +4,31 @@ import { FirebaseFirestoreTypes, addDoc, WithFieldValue, getDoc } from "@react-n
 import { ReactNativeFirebase } from "@react-native-firebase/app";
 import { useMemo } from "react";
 
+/**
+ * @inline
+ */
 export type UseAddDocMutationValues<AppModelType> = {
+    /**
+     * Data to write
+     */
     data: WithFieldValue<AppModelType>;
 };
 
+/**
+ * @inline
+ */
 export type UseAddDocMutationOptions<
     AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData,
     TContext = unknown
 > = {
-    reference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
+    /**
+     * Reference to a collection where document must be added
+     */
+    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
+
+    /**
+     * Options for useMutation hook excluding mutationFn. MutationKey will be equal to reference.path by default.
+     */
     options?: Omit<
         UseMutationOptions<
             AppModelType,
@@ -20,36 +36,50 @@ export type UseAddDocMutationOptions<
             UseAddDocMutationValues<AppModelType>,
             TContext
         >,
-        "mutationFn" | "mutationKey"
+        "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.FirebaseFirestoreTypes.CollectionReference<AppModelType>} options.reference - Firestore collection reference where the document should be added.
- * @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 const useAddDocMutation = <
     AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData,
     TContext = unknown
 >({
-    reference,
+    collectionReference,
     options = {}
 }: UseAddDocMutationOptions<AppModelType, TContext>) => {
-    const mutationKey = useMemo(() => [reference.path], [reference.path]);
+    const mutationKey = useMemo(() => [collectionReference.path], [collectionReference.path]);
 
     return useMutation({
+        mutationKey,
         ...options,
         mutationFn: async ({ data }) => {
-            const docRef = await addDoc<AppModelType>(reference, data);
+            const docRef = await addDoc<AppModelType>(collectionReference, data);
             const docSnap = await getDoc(docRef);
             return docSnap.data() as AppModelType;
-        },
-        mutationKey
+        }
     });
 };

package/react-native/firestore/useBatchWrite.d.ts

@@ -1,15 +1,39 @@
 import { UseMutationOptions } from "@tanstack/react-query";
 import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
 import { ReactNativeFirebase } from "@react-native-firebase/app";
+/**
+ * @inline
+ */
 export type UseBatchWriteVariables = (batch: FirebaseFirestoreTypes.WriteBatch) => Promise<void> | void;
-export type UseBatchWriteOptions<TContext = unknown> = {
-    options?: Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseBatchWriteVariables, TContext>, "mutationFn">;
+/**
+ * @inline
+ */
+export type UseBatchWriteOptions = {
+    options?: Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseBatchWriteVariables>, "mutationFn">;
 };
 /**
  * Custom hook to perform batch write operations using Firestore.
- * Utilizes a mutation to carry out the batch write transaction.
- * @template TContext - The type of context that can be passed into the hook, defaults to unknown.
- * @param {Object} options - The configuration options for the mutation operation.
- * @returns {Object} Returns an object composed of elements returned by useMutation, including properties such as status, and functions to trigger and control the mutation process.
+ *
+ * @group Hook
+ *
+ * @param {UseBatchWriteOptions} options - Configuration options for the query.
+ *
+ * @returns {UseMutationResult<void, Error, UseAddDocMutationValues<AppModelType>>}  A mutation result
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const {mutate} = useBatchWrite({
+ *      options: {
+ *      },
+ *  });
+ *
+ *  // ....
+ *  mutate(() => {
+ *      ref.update({...})
+ *  });
+ *  // ....
+ * };
+ * ```
  */
-export declare const useBatchWrite: <TContext = unknown>({ options }?: UseBatchWriteOptions<TContext>) => import("@tanstack/react-query").UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseBatchWriteVariables, TContext>;
+export declare const useBatchWrite: ({ options }?: UseBatchWriteOptions) => import("@tanstack/react-query").UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseBatchWriteVariables, unknown>;

package/react-native/firestore/useBatchWrite.js

@@ -3,10 +3,28 @@ import { writeBatch } from "@react-native-firebase/firestore";
 import { useFirestore } from "./useFirestore";
 /**
  * Custom hook to perform batch write operations using Firestore.
- * Utilizes a mutation to carry out the batch write transaction.
- * @template TContext - The type of context that can be passed into the hook, defaults to unknown.
- * @param {Object} options - The configuration options for the mutation operation.
- * @returns {Object} Returns an object composed of elements returned by useMutation, including properties such as status, and functions to trigger and control the mutation process.
+ *
+ * @group Hook
+ *
+ * @param {UseBatchWriteOptions} options - Configuration options for the query.
+ *
+ * @returns {UseMutationResult<void, Error, UseAddDocMutationValues<AppModelType>>}  A mutation result
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const {mutate} = useBatchWrite({
+ *      options: {
+ *      },
+ *  });
+ *
+ *  // ....
+ *  mutate(() => {
+ *      ref.update({...})
+ *  });
+ *  // ....
+ * };
+ * ```
  */
 export const useBatchWrite = ({ options = {} } = {}) => {
     const db = useFirestore();

package/react-native/firestore/useBatchWrite.ts

@@ -4,23 +4,47 @@ import { writeBatch, FirebaseFirestoreTypes } from "@react-native-firebase/fires
 import { ReactNativeFirebase } from "@react-native-firebase/app";
 import { useFirestore } from "./useFirestore";
 
+/**
+ * @inline
+ */
 export type UseBatchWriteVariables = (batch: FirebaseFirestoreTypes.WriteBatch) => Promise<void> | void;
 
-export type UseBatchWriteOptions<TContext = unknown> = {
+/**
+ * @inline
+ */
+export type UseBatchWriteOptions = {
     options?: Omit<
-        UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseBatchWriteVariables, TContext>,
+        UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseBatchWriteVariables>,
         "mutationFn"
     >;
 };
 
 /**
  * Custom hook to perform batch write operations using Firestore.
- * Utilizes a mutation to carry out the batch write transaction.
- * @template TContext - The type of context that can be passed into the hook, defaults to unknown.
- * @param {Object} options - The configuration options for the mutation operation.
- * @returns {Object} Returns an object composed of elements returned by useMutation, including properties such as status, and functions to trigger and control the mutation process.
+ *
+ * @group Hook
+ *
+ * @param {UseBatchWriteOptions} options - Configuration options for the query.
+ *
+ * @returns {UseMutationResult<void, Error, UseAddDocMutationValues<AppModelType>>}  A mutation result
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const {mutate} = useBatchWrite({
+ *      options: {
+ *      },
+ *  });
+ *
+ *  // ....
+ *  mutate(() => {
+ *      ref.update({...})
+ *  });
+ *  // ....
+ * };
+ * ```
  */
-export const useBatchWrite = <TContext = unknown>({ options = {} }: UseBatchWriteOptions<TContext> = {}) => {
+export const useBatchWrite = ({ options = {} }: UseBatchWriteOptions = {}) => {
     const db = useFirestore();
 
     return useMutation({

package/react-native/firestore/useCollectionReference.d.ts

@@ -1,18 +1,39 @@
 import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
-export type UseCollectionReferenceOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData> = {
+import { AppModel } from "../../types";
+/**
+ * @inline
+ */
+export type UseCollectionReferenceOptions<AppModelType extends AppModel = AppModel> = {
+    /**
+     * CollectionReference or DocumentReference that is used as a root to lookup a sub-collection
+     */
     reference?: FirebaseFirestoreTypes.CollectionReference<AppModelType> | FirebaseFirestoreTypes.DocumentReference<AppModelType>;
+    /**
+     * A slash-separated path to a collection.
+     */
     path: string;
+    /**
+     * Additional path segments that will be applied relative
+     */
     pathSegments?: string[];
 };
 /**
- * Creates a reference to a Firestore collection based on the provided path, reference, and path segments.
+ * Gets a `CollectionReference` instance that refers to a subcollection of
+ * `reference` at the specified relative path.
+ *
+ * @group Hook
+ *
+ * @param {UseCollectionReferenceOptions<AppModelType>} options - Options
  *
- * This hook utilizes useMemo for optimization, ensuring the collection reference is recalculated only when its dependencies change.
+ * @returns {FirebaseFirestoreTypes.CollectionReference<AppModelType, AppModelType>} A reference to a Firestore collection
  *
- * @param {UseCollectionReferenceOptions<AppModelType>} options - The options including path, reference, and pathSegments to construct the Firestore collection reference.
- * @param {string} options.path - The base path for the collection.
- * @param {FirestoreReference} options.reference - An optional Firestore reference object that should be of type "collection".
- * @param {string[]} options.pathSegments - Additional path segments to append to the base path.
- * @returns {CollectionReference} A Firestore collection reference constructed using the specified path, reference, and path segments.
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const ref = useCollectionReference({
+ *      path: 'todos'
+ *  });
+ * };
+ * ```
  */
-export declare const useCollectionReference: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ path, reference, pathSegments }: UseCollectionReferenceOptions<AppModelType>) => FirebaseFirestoreTypes.CollectionReference<AppModelType>;
+export declare const useCollectionReference: <AppModelType extends AppModel = AppModel>({ path, reference, pathSegments }: UseCollectionReferenceOptions<AppModelType>) => FirebaseFirestoreTypes.CollectionReference<AppModelType>;

package/react-native/firestore/useCollectionReference.js

@@ -2,15 +2,23 @@ import { collection } from "@react-native-firebase/firestore";
 import { useMemo } from "react";
 import { useFirestore } from "./useFirestore";
 /**
- * Creates a reference to a Firestore collection based on the provided path, reference, and path segments.
+ * Gets a `CollectionReference` instance that refers to a subcollection of
+ * `reference` at the specified relative path.
  *
- * This hook utilizes useMemo for optimization, ensuring the collection reference is recalculated only when its dependencies change.
+ * @group Hook
  *
- * @param {UseCollectionReferenceOptions<AppModelType>} options - The options including path, reference, and pathSegments to construct the Firestore collection reference.
- * @param {string} options.path - The base path for the collection.
- * @param {FirestoreReference} options.reference - An optional Firestore reference object that should be of type "collection".
- * @param {string[]} options.pathSegments - Additional path segments to append to the base path.
- * @returns {CollectionReference} A Firestore collection reference constructed using the specified path, reference, and path segments.
+ * @param {UseCollectionReferenceOptions<AppModelType>} options - Options
+ *
+ * @returns {FirebaseFirestoreTypes.CollectionReference<AppModelType, AppModelType>} A reference to a Firestore collection
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const ref = useCollectionReference({
+ *      path: 'todos'
+ *  });
+ * };
+ * ```
  */
 export const useCollectionReference = ({ path, reference, pathSegments }) => {
     const db = useFirestore();

package/react-native/firestore/useCollectionReference.ts

@@ -2,48 +2,57 @@ import { collection, FirebaseFirestoreTypes } from "@react-native-firebase/fires
 
 import { useMemo } from "react";
 import { useFirestore } from "./useFirestore";
+import { AppModel } from "../../types";
 
-export type UseCollectionReferenceOptions<
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
-> = {
+/**
+ * @inline
+ */
+export type UseCollectionReferenceOptions<AppModelType extends AppModel = AppModel> = {
+    /**
+     * CollectionReference or DocumentReference that is used as a root to lookup a sub-collection
+     */
     reference?:
         | FirebaseFirestoreTypes.CollectionReference<AppModelType>
         | FirebaseFirestoreTypes.DocumentReference<AppModelType>;
+    /**
+     * A slash-separated path to a collection.
+     */
     path: string;
+    /**
+     * Additional path segments that will be applied relative
+     */
     pathSegments?: string[];
 };
 
 /**
- * Creates a reference to a Firestore collection based on the provided path, reference, and path segments.
+ * Gets a `CollectionReference` instance that refers to a subcollection of
+ * `reference` at the specified relative path.
+ *
+ * @group Hook
+ *
+ * @param {UseCollectionReferenceOptions<AppModelType>} options - Options
  *
- * This hook utilizes useMemo for optimization, ensuring the collection reference is recalculated only when its dependencies change.
+ * @returns {FirebaseFirestoreTypes.CollectionReference<AppModelType, AppModelType>} A reference to a Firestore collection
  *
- * @param {UseCollectionReferenceOptions<AppModelType>} options - The options including path, reference, and pathSegments to construct the Firestore collection reference.
- * @param {string} options.path - The base path for the collection.
- * @param {FirestoreReference} options.reference - An optional Firestore reference object that should be of type "collection".
- * @param {string[]} options.pathSegments - Additional path segments to append to the base path.
- * @returns {CollectionReference} A Firestore collection reference constructed using the specified path, reference, and path segments.
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const ref = useCollectionReference({
+ *      path: 'todos'
+ *  });
+ * };
+ * ```
  */
-export const useCollectionReference = <
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
->({
+export const useCollectionReference = <AppModelType extends AppModel = AppModel>({
     path,
     reference,
     pathSegments
-}: UseCollectionReferenceOptions<AppModelType>): FirebaseFirestoreTypes.CollectionReference<AppModelType> => {
+}: UseCollectionReferenceOptions<AppModelType>) => {
     const db = useFirestore();
 
     return useMemo(() => {
         return !reference
-            ? (collection(
-                  db,
-                  path || "",
-                  ...(pathSegments || [])
-              ) as FirebaseFirestoreTypes.CollectionReference<AppModelType>)
-            : (collection(
-                  reference,
-                  path,
-                  ...(pathSegments || [])
-              ) as FirebaseFirestoreTypes.CollectionReference<AppModelType>);
-    }, [db, reference, path, pathSegments]);
+            ? collection(db, path || "", ...(pathSegments || []))
+            : collection(reference, path, ...(pathSegments || []));
+    }, [db, reference, path, pathSegments]) as FirebaseFirestoreTypes.CollectionReference<AppModelType>;
 };

package/react-native/firestore/useCompositeFilter.d.ts

@@ -1,56 +1,11 @@
-import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
 import { AppModel } from "../../types";
-export type QueryFilterConstraint = FirebaseFirestoreTypes.QueryCompositeFilterConstraint | FirebaseFirestoreTypes.QueryFilterConstraint;
-export type QueryElement<AppModelType extends AppModel = AppModel> = {
-    operator?: "OR" | "AND";
-    children?: QueryElement[];
-    field?: keyof (AppModelType & {
-        documentId?: string[];
-    });
-    value?: AppModelType[keyof AppModelType];
-    op?: FirebaseFirestoreTypes.WhereFilterOp;
-};
-export type CompositeFilter<AppModelType extends AppModel = AppModel> = {
-    operator: "OR" | "AND";
-    children: QueryElement<AppModelType & {
-        documentId?: string[];
-    }>[];
-};
+import { CompositeFilter, QueryFilterConstraint } from "./utils/buildCompositeFilter";
 /**
  * @inline
  */
 export type UseCompositeFilter<AppModelType extends AppModel = AppModel> = {
     query?: CompositeFilter<AppModelType>;
 };
-/**
- * Constructs a composite or where query filter based on the provided query structure.
- * It recursively builds query constraints using logical "or" or "and" operators.
- *
- * @group Utility
- *
- * @param {QueryElement<AppModelType>} query
- *
- * @returns {QueryFilterConstraint | null}
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const filter = buildCompositeFilter({
- *      operator: "AND",
- *      children: [
- *          {
- *              field: "field",
- *              value: "value",
- *              op: "=="
- *          },
- *          ...(query ? [query] : [])
- *      ]
- *  });
- *  console.log(filter);
- * };
- * ```
- */
-export declare const buildCompositeFilter: <AppModelType extends AppModel = AppModel>(query: QueryElement<AppModelType>) => QueryFilterConstraint | null;
 /**
  * A custom hook that constructs a composite or where query filter based on the provided query structure.
  * It recursively builds query constraints using logical "or" or "and" operators.