react-query-firebase 3.0.0 → 3.1.0

package/dist/react-native/firestore/index.d.ts

@@ -21,3 +21,4 @@ export * from "./utils/getDocRef.js";
 export * from "./utils/buildQueryConstraint.js";
 export * from "./utils/buildCompositeFilter.js";
 export * from "./useEnsureDoc.js";
+export * from "./useFirestoreQueryEngine.js";

package/dist/react-native/firestore/index.js

@@ -21,3 +21,4 @@ export * from "./utils/getDocRef.js";
 export * from "./utils/buildQueryConstraint.js";
 export * from "./utils/buildCompositeFilter.js";
 export * from "./useEnsureDoc.js";
+export * from "./useFirestoreQueryEngine.js";

package/dist/react-native/firestore/useFirestoreQueryEngine.d.ts

@@ -0,0 +1,44 @@
+import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
+import { AppModel } from "../../types/index.js";
+import { type NonFilterQueryConstraint } from "../../types/QueryConstraints.js";
+import { type CompositeFilter } from "./utils/buildCompositeFilter.js";
+/**
+ * @inline
+ */
+type UseFirestoreQueryEngineOptions<AppModelType extends AppModel = AppModel> = {
+    /**
+     * Reference to a Firestore collection
+     */
+    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
+    /**
+     * Non composite filter constraints such as limit, order, where
+     */
+    queryConstraints?: NonFilterQueryConstraint<AppModelType>[];
+    /**
+     * Composite filter
+     */
+    compositeFilter?: CompositeFilter<AppModelType>;
+};
+/**
+ * Returns an async wrapper around native firestore query engine.
+ *
+ * @group Hook
+ *
+ * @returns {(options: UseFirestoreQueryEngineOptions<AppModelType>): Promise<AppModelType[]>} A function to execute firestore query
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const query = useFirestoreQueryEngine();
+ *  const callback = useCallback(async () => {
+ *      const docs = await query({
+ *          collectionReference: collection(),
+ *          queryConstraints: [],
+ *      });
+ *      // do something with docs
+ *  });
+ * };
+ * ```
+ */
+export declare const useFirestoreQueryEngine: <AppModelType extends AppModel = AppModel>() => ((options: UseFirestoreQueryEngineOptions<AppModelType>) => Promise<AppModelType[]>);
+export {};

package/dist/react-native/firestore/useFirestoreQueryEngine.js

@@ -0,0 +1,47 @@
+import { getDocs, query, or, and } from "@react-native-firebase/firestore";
+import { useCallback } from "react";
+import { buildCompositeFilter } from "./utils/buildCompositeFilter.js";
+import { buildQueryConstraint } from "./utils/buildQueryConstraint.js";
+/**
+ * Returns an async wrapper around native firestore query engine.
+ *
+ * @group Hook
+ *
+ * @returns {(options: UseFirestoreQueryEngineOptions<AppModelType>): Promise<AppModelType[]>} A function to execute firestore query
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const query = useFirestoreQueryEngine();
+ *  const callback = useCallback(async () => {
+ *      const docs = await query({
+ *          collectionReference: collection(),
+ *          queryConstraints: [],
+ *      });
+ *      // do something with docs
+ *  });
+ * };
+ * ```
+ */
+export const useFirestoreQueryEngine = () => {
+    return useCallback(async ({ collectionReference, queryConstraints = [], compositeFilter: inputCompositeFilter }) => {
+        const compositeFilter = (inputCompositeFilter?.children?.map?.((subQuery) => buildCompositeFilter(subQuery))
+            ?.filter)?.((constraint) => !!constraint) ?? [];
+        const finalCompositeFilter = compositeFilter.length > 0
+            ? inputCompositeFilter?.operator === "OR"
+                ? or(...compositeFilter)
+                : and(...compositeFilter)
+            : undefined;
+        const queryToExecute = finalCompositeFilter
+            ? query(collectionReference, finalCompositeFilter, ...queryConstraints.map(buildQueryConstraint))
+            : query(collectionReference, ...queryConstraints.map(buildQueryConstraint));
+        const querySnapshot = await getDocs(queryToExecute);
+        const docs = [];
+        if (querySnapshot) {
+            querySnapshot.forEach((doc) => {
+                docs.push({ ...doc.data(), uid: doc.id });
+            });
+        }
+        return docs;
+    }, []);
+};

package/dist/web/firestore/index.d.ts

@@ -21,3 +21,4 @@ export * from "./utils/getDocSnap.js";
 export * from "./utils/getDocRef.js";
 export * from "./utils/buildQueryConstraint.js";
 export * from "./utils/buildCompositeFilter.js";
+export * from "./useFirestoreQueryEngine.js";

package/dist/web/firestore/index.js

@@ -21,3 +21,4 @@ export * from "./utils/getDocSnap.js";
 export * from "./utils/getDocRef.js";
 export * from "./utils/buildQueryConstraint.js";
 export * from "./utils/buildCompositeFilter.js";
+export * from "./useFirestoreQueryEngine.js";

package/dist/web/firestore/useFirestoreQueryEngine.d.ts

@@ -0,0 +1,44 @@
+import { CollectionReference } from "firebase/firestore";
+import { NonFilterQueryConstraint } from "../../types/QueryConstraints.js";
+import { AppModel } from "../../types/index.js";
+import { CompositeFilter } from "./utils/buildCompositeFilter.js";
+/**
+ * @inline
+ */
+type UseFirestoreQueryEngineOptions<AppModelType extends AppModel = AppModel> = {
+    /**
+     * Reference to a Firestore collection
+     */
+    collectionReference: CollectionReference<AppModelType, AppModelType>;
+    /**
+     * Non composite filter constraints such as limit, order, where
+     */
+    queryConstraints: NonFilterQueryConstraint<AppModelType>[];
+    /**
+     * Composite filter
+     */
+    compositeFilter?: CompositeFilter;
+};
+/**
+ * Returns an async wrapper around native firestore query engine.
+ *
+ * @group Hook
+ *
+ * @returns {(options: UseFirestoreQueryEngineOptions<AppModelType>): Promise<AppModelType[]>} A function to execute firestore query
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const query = useFirestoreQueryEngine();
+ *  const callback = useCallback(async () => {
+ *      const docs = await query({
+ *          collectionReference: collection(),
+ *          queryConstraints: [],
+ *      });
+ *      // do something with docs
+ *  });
+ * };
+ * ```
+ */
+export declare const useFirestoreQueryEngine: <AppModelType extends AppModel = AppModel>() => ((options: UseFirestoreQueryEngineOptions<AppModelType>) => Promise<AppModelType[]>);
+export {};

package/dist/web/firestore/useFirestoreQueryEngine.js

@@ -0,0 +1,47 @@
+import { getDocs, query, or, and } from "firebase/firestore";
+import { useCallback } from "react";
+import { buildCompositeFilter } from "./utils/buildCompositeFilter.js";
+import { buildQueryConstraint } from "./utils/buildQueryConstraint.js";
+/**
+ * Returns an async wrapper around native firestore query engine.
+ *
+ * @group Hook
+ *
+ * @returns {(options: UseFirestoreQueryEngineOptions<AppModelType>): Promise<AppModelType[]>} A function to execute firestore query
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const query = useFirestoreQueryEngine();
+ *  const callback = useCallback(async () => {
+ *      const docs = await query({
+ *          collectionReference: collection(),
+ *          queryConstraints: [],
+ *      });
+ *      // do something with docs
+ *  });
+ * };
+ * ```
+ */
+export const useFirestoreQueryEngine = () => {
+    return useCallback(async ({ collectionReference, queryConstraints = [], compositeFilter: inputCompositeFilter }) => {
+        const compositeFilter = (inputCompositeFilter?.children?.map?.((subQuery) => buildCompositeFilter(subQuery))
+            ?.filter)?.((constraint) => !!constraint) ?? [];
+        const finalCompositeFilter = compositeFilter.length > 0
+            ? inputCompositeFilter?.operator === "OR"
+                ? or(...compositeFilter)
+                : and(...compositeFilter)
+            : undefined;
+        const queryToExecute = finalCompositeFilter
+            ? query(collectionReference, finalCompositeFilter, ...queryConstraints.map(buildQueryConstraint))
+            : query(collectionReference, ...queryConstraints);
+        const querySnapshot = await getDocs(queryToExecute);
+        const docs = [];
+        if (querySnapshot) {
+            querySnapshot.forEach((doc) => {
+                docs.push({ ...doc.data(), uid: doc.id });
+            });
+        }
+        return docs;
+    }, []);
+};

package/package.json

@@ -91,5 +91,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "3.0.0"
+    "version": "3.1.0"
 }