react-query-firebase 2.13.3 → 2.14.0

package/react-native/firestore/useRunTransaction.ts

@@ -1,55 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { runTransaction, FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
-
-import { useFirestore } from "./useFirestore";
-
-/**
- * @inline
- */
-export type UseRunTransactionValues = <T = unknown>(transaction: FirebaseFirestoreTypes.Transaction) => T;
-
-/**
- * @inline
- */
-export type UseRunTransactionOptions<T = unknown, TContext = unknown> = {
-    /**
-     * Reqct-mutation options that shall omit mutationFn
-     */
-    options?: Omit<UseMutationOptions<T, Error, UseRunTransactionValues, TContext>, "mutationFn">;
-};
-
-/**
- * Executes a Firestore transaction
- *
- * @group Hook
- *
- * @param {UseRunTransactionOptions<T>} options - Configuration options for the mutation.
- *
- * @returns {UseMutationResult<T, Error>} An object representing mutation
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const doc = useGetDocData({
- *      options: {
- *          queryKey: ['key']
- *      },
- *      reference: collection(),
- *      path: 'id'
- *  });
- *  console.log(doc);
- * };
- * ```
- */
-export const useRunTransaction = <T = unknown, TContext = unknown>({
-    options = {}
-}: UseRunTransactionOptions<T, TContext>) => {
-    const db = useFirestore();
-
-    return useMutation({
-        ...options,
-        mutationFn: async (transactionFn) => {
-            return runTransaction<T>(db, transactionFn);
-        }
-    });
-};

package/react-native/firestore/useSetDocMutation.ts

@@ -1,76 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { FirebaseFirestoreTypes, getDoc, setDoc, WithFieldValue } from "@react-native-firebase/firestore";
-
-import { useMemo } from "react";
-import { AppModel } from "../../types";
-
-/**
- * @inline
- */
-export type UseSetDocMutationValues<AppModelType extends AppModel = AppModel> = {
-    /**
-     * Data to write
-     */
-    data: WithFieldValue<AppModelType>;
-};
-
-/**
- * @inline
- */
-export type UseSetDocMutationOptions<AppModelType extends AppModel = AppModel, TContext = unknown> = {
-    /**
-     * Reference to a document that must be written
-     */
-    reference: FirebaseFirestoreTypes.DocumentReference<AppModelType> | null;
-    /**
-     * Options for useMutation hook excluding mutationFn.
-     */
-    options?: Omit<
-        UseMutationOptions<AppModelType, Error, UseSetDocMutationValues<AppModelType>, TContext>,
-        "mutationFn"
-    >;
-};
-
-/**
- * Executes a mutation and returns added document
- *
- * @group Hook
- *
- * @param {UseSetDocMutationOptions<AppModelType>} options - Configuration options for mutation.
- *
- * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const {mutate} = useSetDocMutation({
- *      options: {
- *      },
- *      reference: collection().doc(),
- *  });
- *
- *  // ....
- *  mutate({data: {test: 'value'}});
- *  // ....
- * };
- * ```
- */
-export const useSetDocMutation = <AppModelType extends AppModel = AppModel, TContext = unknown>({
-    reference,
-    options
-}: UseSetDocMutationOptions<AppModelType, TContext>) => {
-    const mutationKey = useMemo(() => [reference?.path], [reference?.path]);
-
-    return useMutation({
-        ...options,
-        mutationKey,
-        mutationFn: async ({ data }) => {
-            if (!reference) {
-                throw new Error("Reference is undefined");
-            }
-            await setDoc<AppModelType>(reference, data);
-            const docSnap = await getDoc(reference);
-            return { ...(docSnap.data() as AppModelType), uid: docSnap.id };
-        }
-    });
-};

package/react-native/firestore/useUpdateDocMutation.ts

@@ -1,77 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { FirebaseFirestoreTypes, updateDoc, getDoc, UpdateData } from "@react-native-firebase/firestore";
-
-import { useMemo } from "react";
-import { AppModel } from "../../types";
-
-/**
- * @inline
- */
-export type UseUpdateDocMutationValues<AppModelType extends AppModel = AppModel> = {
-    /**
-     * Data to write
-     */
-    data: UpdateData<AppModelType>;
-};
-
-/**
- * @inline
- */
-export type UseUpdateDocMutationOptions<AppModelType extends AppModel = AppModel, TContext = unknown> = {
-    /**
-     * Reference to a document that must be updated
-     */
-    reference: FirebaseFirestoreTypes.DocumentReference<AppModelType> | null;
-    /**
-     * Options for useMutation hook excluding mutationFn.
-     */
-    options?: Omit<
-        UseMutationOptions<AppModelType, Error, UseUpdateDocMutationValues<AppModelType>, TContext>,
-        "mutationFn"
-    >;
-};
-
-/**
- * Executes a mutation and returns updated document
- *
- * @group Hook
- *
- * @param {UseUpdateDocMutationOptions<AppModelType>} options - Configuration options for mutation.
- *
- * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const {mutate} = useUpdateDocMutation({
- *      options: {
- *      },
- *      reference: collection().doc(),
- *  });
- *
- *  // ....
- *  mutate({data: {test: 'value'}});
- *  // ....
- * };
- * ```
- */
-export const useUpdateDocMutation = <AppModelType extends AppModel = AppModel, TContext = unknown>({
-    reference,
-    options = {}
-}: UseUpdateDocMutationOptions<AppModelType, TContext>) => {
-    const mutationKey = useMemo(() => [reference?.path], [reference?.path]);
-
-    return useMutation({
-        ...options,
-        mutationFn: async ({ data }) => {
-            if (!reference) {
-                throw new Error("Reference is undefined");
-            }
-
-            await updateDoc<AppModelType>(reference, data);
-            const docSnap = await getDoc(reference);
-            return { ...(docSnap.data() as AppModelType), uid: docSnap.id };
-        },
-        mutationKey
-    });
-};

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

@@ -1,75 +0,0 @@
-import { FirebaseFirestoreTypes, and, or, where, FieldPath } 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[] }>[];
-};
-
-/**
- * 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 const buildCompositeFilter = <AppModelType extends AppModel = AppModel>(
-    query: QueryElement<AppModelType>
-): QueryFilterConstraint | null => {
-    if (query.children) {
-        const queryConstraints = query.children.map(buildCompositeFilter).filter((constraint) => !!constraint);
-
-        if (queryConstraints.length <= 0) {
-            return null;
-        }
-
-        if (queryConstraints.length <= 1) {
-            return queryConstraints[0];
-        }
-
-        return (query as CompositeFilter).operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
-    }
-
-    if (query.field && query.op) {
-        return where(
-            query.field === "documentId" ? new FieldPath("__name__") : (query.field as string),
-            query.op,
-            query.value
-        ) as unknown as FirebaseFirestoreTypes.QueryFilterConstraint;
-    }
-
-    return null;
-};

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

@@ -1,54 +0,0 @@
-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.arguments);
-        case "endBefore":
-            return endBefore(...constraint.arguments);
-        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.ts

@@ -1,33 +0,0 @@
-import { AppModel } from "../../../types";
-import { getDocSnap, GetDocSnapOptions } from "./getDocSnap";
-
-/**
- * @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.
- *
- * @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.
- */
-export const getDocData = async <AppModelType extends AppModel = AppModel>({
-    db,
-    reference,
-    path,
-    pathSegments
-}: GetDocDataOptions<AppModelType>) => {
-    const docSnap = await getDocSnap<AppModelType>({ db, reference, path, pathSegments });
-
-    if (docSnap && docSnap?.exists()) {
-        return { ...docSnap.data(), uid: docSnap.id } as AppModelType;
-    }
-
-    return null;
-};

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

@@ -1,41 +0,0 @@
-import { doc, FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
-import { AppModel } from "../../../types";
-
-/**
- * @inline
- */
-export type GetDocRefOptions<AppModelType extends AppModel = AppModel> = {
-    db: FirebaseFirestoreTypes.Module;
-    reference?:
-        | FirebaseFirestoreTypes.CollectionReference<AppModelType>
-        | FirebaseFirestoreTypes.DocumentReference<AppModelType>;
-    path?: string;
-    pathSegments?: string[];
-};
-
-/**
- * Retrieves a document reference based on provided database options.
- * Either `reference` or `path`.
- *
- * @group Utility
- *
- * @param {GetDocRefOptions<AppModelType>} options - The options for building doc reference.
- *
- * @returns {DocumentReference<AppModelType, AppModelType>} Returns a document reference
- */
-export const getDocRef = <AppModelType extends AppModel = AppModel>({
-    db,
-    reference,
-    path,
-    pathSegments
-}: GetDocRefOptions<AppModelType>) => {
-    if ((!reference && !path) || (reference && !path)) {
-        return null;
-    }
-
-    const docRef = !reference
-        ? doc(db, path as string, ...(pathSegments || []))
-        : doc(reference, path, ...(pathSegments || []));
-
-    return docRef as FirebaseFirestoreTypes.DocumentReference<AppModelType>;
-};

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

@@ -1,34 +0,0 @@
-import { getDoc as firestoreGetDoc } from "@react-native-firebase/firestore";
-import { AppModel } from "../../../types";
-import { getDocRef, GetDocRefOptions } from "./getDocRef";
-
-/**
- * @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.
- *
- * @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 AppModel = AppModel>({
-    db,
-    reference,
-    path,
-    pathSegments
-}: GetDocSnapOptions<AppModelType>) => {
-    const docRef = await getDocRef<AppModelType>({ db, reference, path, pathSegments });
-
-    if (docRef) {
-        return await firestoreGetDoc(docRef);
-    }
-
-    return null;
-};

package/react-native/index.d.ts

@@ -1 +0,0 @@
-export * from "./context";

package/react-native/index.js

@@ -1 +0,0 @@
-export * from "./context";

package/react-native/index.ts

@@ -1 +0,0 @@
-export * from "./context";

package/react-native/remoteConfig/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./useFetchAndActivate";
-export * from "./useGetValue";
-export * from "./useRemoteConfig";

package/react-native/remoteConfig/index.js

@@ -1,3 +0,0 @@
-export * from "./useFetchAndActivate";
-export * from "./useGetValue";
-export * from "./useRemoteConfig";

package/react-native/remoteConfig/index.ts

@@ -1,3 +0,0 @@
-export * from "./useFetchAndActivate";
-export * from "./useGetValue";
-export * from "./useRemoteConfig";

package/react-native/remoteConfig/useFetchAndActivate.ts

@@ -1,36 +0,0 @@
-import { ensureInitialized, fetchAndActivate } from "@react-native-firebase/remote-config";
-import { useCallback, useMemo, useState } from "react";
-import { useRemoteConfig } from "./useRemoteConfig";
-
-/**
- * Custom hook to fetch and activate remote configuration settings.
- * Initializes remote configuration, fetches, activates it, and tracks the fetch status.
- * @returns {Object} An object containing:
- * - {Function} fetchAndActivate - Callback function to fetch and activate remote configuration.
- * - {Boolean} isFetched - Boolean representing whether the fetch-and-activate process completed.
- */
-export const useFetchAndActivate = () => {
-    const remoteConfig = useRemoteConfig();
-    const [isFetched, setIsFetched] = useState(false);
-
-    const fetchAndActivateCallback = useCallback(async () => {
-        try {
-            if (remoteConfig) {
-                await ensureInitialized(remoteConfig);
-                await fetchAndActivate(remoteConfig);
-                setIsFetched(true);
-            }
-        } catch (e) {
-            setIsFetched(true);
-            console.log(`Cannot read remote config: ${(e as Error)?.message}`);
-        }
-    }, [remoteConfig]);
-
-    return useMemo(
-        () => ({
-            fetchAndActivate: fetchAndActivateCallback,
-            isFetched
-        }),
-        [isFetched, fetchAndActivateCallback]
-    );
-};

package/react-native/remoteConfig/useGetValue.ts

@@ -1,16 +0,0 @@
-import { getValue } from "@react-native-firebase/remote-config";
-import { useMemo } from "react";
-import { useRemoteConfig } from "./useRemoteConfig";
-
-/**
- * Custom hook to retrieve a value associated with a specified key from remote configuration.
- * Utilizes memoization to optimize performance by recalculating the result only if dependencies change.
- * @param {string} key - The key for which the corresponding value is to be fetched from the remote configuration.
- * @returns {any | null} The value associated with the specified key if available, otherwise null.
- */
-export const useGetValue = (key: string) => {
-    const remoteConfig = useRemoteConfig();
-    return useMemo(() => {
-        return remoteConfig ? getValue(remoteConfig, key) : null;
-    }, [remoteConfig, key]);
-};

package/react-native/remoteConfig/useRemoteConfig.js

@@ -1,10 +0,0 @@
-import { useContext } from "react";
-import { FirebaseContext } from "../context/FirebaseContext";
-/**
- * Hook to access the Firebase Remote Config instance from the context.
- * @returns {RemoteConfig} The remoteConfig object from the Firebase context.
- */
-export const useRemoteConfig = () => {
-    const { remoteConfig } = useContext(FirebaseContext);
-    return remoteConfig;
-};

package/types/AppModel.ts

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

package/types/QueryConstraints.ts

@@ -1,57 +0,0 @@
-import { AppModel } from "./AppModel";
-
-/**
- * Order by constraint
- * @group Query Constraints
- */
-export type OrderByConstraint<AppModelType extends AppModel = AppModel> = {
-    /**
-     * Type of a constraint
-     */
-    type: "orderBy";
-    /**
-     * Field path to use for ordering
-     */
-    fieldPath: keyof AppModelType;
-    /**
-     * Direction of ordering: asc or desc
-     */
-    directionStr: "asc" | "desc";
-};
-
-/**
- * Start from value constraint
- * @group Query Constraints
- */
-export type StartConstraint = {
-    type: "startAt" | "startAfter";
-    arguments: unknown[];
-};
-
-/**
- * End by value constraint
- * @group Query Constraints
- */
-export type EndConstraint = {
-    type: "endAt" | "endBefore";
-    arguments: unknown[];
-};
-
-/**
- * Limit constraint
- * @group Query Constraints
- */
-export type LimitConstraint = {
-    type: "limitToLast" | "limit";
-    limit: number;
-};
-
-/**
- * Non filtering query constaints
- * @group Query Constraints
- */
-export type NonFilterQueryConstraint<AppModelType extends AppModel = AppModel> =
-    | OrderByConstraint<AppModelType>
-    | StartConstraint
-    | EndConstraint
-    | LimitConstraint;

package/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./AppModel";
-export * from "./QueryConstraints";

package/types/index.js

@@ -1,2 +0,0 @@
-export * from "./AppModel";
-export * from "./QueryConstraints";

package/types/index.ts

@@ -1,2 +0,0 @@
-export * from "./AppModel";
-export * from "./QueryConstraints";

package/web/analytics/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./useLogEvent";
-export * from "./useAnalytics";
-export * from "./useSetAnalyticsCollectionEnabled";

package/web/analytics/index.js

@@ -1,3 +0,0 @@
-export * from "./useLogEvent";
-export * from "./useAnalytics";
-export * from "./useSetAnalyticsCollectionEnabled";

package/web/analytics/index.ts

@@ -1,3 +0,0 @@
-export * from "./useLogEvent";
-export * from "./useAnalytics";
-export * from "./useSetAnalyticsCollectionEnabled";

package/web/analytics/useAnalytics.js

@@ -1,10 +0,0 @@
-import { useContext } from "react";
-import { FirebaseContext } from "../context/FirebaseContext";
-/**
- * Hook to access Firebase analytics from the Firebase context.
- * @returns {any} The analytics object from the Firebase context.
- */
-export const useAnalytics = () => {
-    const { analytics } = useContext(FirebaseContext);
-    return analytics;
-};