react-query-firebase 2.13.3 → 2.14.0

package/react-native/context/FirebaseContextProvider.tsx

@@ -1,264 +0,0 @@
-import React, { PropsWithChildren, useEffect, useMemo } from "react";
-import { connectAuthEmulator, getAuth } from "@react-native-firebase/auth";
-import {
-    FirebaseAnalyticsTypes,
-    setAnalyticsCollectionEnabled,
-    setConsent,
-    getAnalytics
-} from "@react-native-firebase/analytics";
-import { FirebaseRemoteConfigTypes, getRemoteConfig } from "@react-native-firebase/remote-config";
-import { connectFirestoreEmulator, getFirestore } from "@react-native-firebase/firestore";
-import { ReactNativeFirebase, getApp } from "@react-native-firebase/app";
-import { FirebaseContext, FirebaseContextValue } from "./FirebaseContext";
-
-/**
- * @inline
- * @see https://firebase.google.com/docs/reference/js/firestore_.firestoresettings
- */
-export type FirestoreSettings = {
-    cacheSizeBytes?: number;
-    experimentalAutoDetectLongPolling?: boolean;
-    experimentalForceLongPolling?: boolean;
-    experimentalLongPollingOptions?: {
-        timeoutSeconds: number;
-    };
-    host?: string;
-    ignoreUndefinedProperties?: boolean;
-    localCache?: {
-        kind: "memory" | "persistent";
-    };
-    ssl?: boolean;
-};
-
-/**
- * @inline
- */
-export type FirebaseContextProviderFirestoreEmulatorConfig = {
-    /**
-     * Host to connect to Firebase Firestore Emulator
-     */
-    host: string;
-    /**
-     * Port to connect to Firebase Firestore Emulator
-     */
-    port: number;
-};
-
-/**
- * @inline
- */
-export type FirebaseContextProviderAuthEmulatorConfig = {
-    /**
-     * Host to connect to Firebase Auth Emulator
-     */
-    host: string;
-};
-
-/**
- * @inline
- */
-export type FirebaseContextProviderEmulators = {
-    /**
-     * Defines configuration for Firebase Firestore emulator. Optional.
-     */
-    firestore?: FirebaseContextProviderFirestoreEmulatorConfig;
-    /**
-     * Defines configuration for Firebase Auth emulator. Optional
-     */
-    auth?: FirebaseContextProviderAuthEmulatorConfig;
-};
-
-/**
- * @inline
- */
-export type FirebaseContextProviderProps = PropsWithChildren & {
-    /**
-     * Defines configuration for firebase emulators
-     */
-    emulators?: FirebaseContextProviderEmulators;
-    /**
-     * Configuration options for Firebase initialization. {@link https://firebase.google.com/docs/web/setup#config-object | Learn about the Firebase config object}
-     */
-    options?: ReactNativeFirebase.FirebaseAppOptions;
-    /**
-     * Flag indicating whether Firebase Auth should be enabled.
-     */
-    authEnabled?: boolean;
-    /**
-     * Flag indicating whether Firebase Analytics should be enabled.
-     * @defaultValue `true`
-     */
-    analyticsEnabled?: boolean;
-    /**
-     * Default user consent settings. Make sure to either use a consent platform or install custom consent form for a certain regions.
-     * @defaultValue {
-     *                  ad_personalization: "denied",
-     *                  ad_storage: "denied",
-     *                  ad_user_data: "denied",
-     *                  analytics_storage: "denied",
-     *                  functionality_storage: "denied",
-     *                  personalization_storage: "denied",
-     *                  security_storage: "denied"
-     *              }
-     */
-    consentSettings?: FirebaseAnalyticsTypes.ConsentSettings;
-    /**
-     * Specifies custom configurations for your Cloud Firestore instance.
-     * You must set these before invoking any other methods.
-     * {@link https://firebase.google.com/docs/reference/js/firestore_.firestoresettings}
-     * @defaultValue {}
-     */
-    firestoreSettings?: FirestoreSettings;
-    /**
-     * Flag indicating whether Firebase Firestore should be enabled.
-     * @defaultValue `true`
-     */
-    firestoreEnabled?: boolean;
-    /**
-     * Configuration options for Firebase Remote Config Settings. {@link https://firebase.google.com/docs/reference/js/remote-config.remoteconfigsettings | Learn about the Firebase Remote COnfig Settings object}
-     * @defaultValue `true`
-     */
-    remoteConfigSettings?: FirebaseRemoteConfigTypes.ConfigSettings;
-    /**
-     * Configuration options for Firebase Remote Config Defaults.
-     */
-    remoteConfigDefaults?: { [key: string]: string | number | boolean };
-    /**
-     * Flag indicating whether Firebase Remote Config should be enabled.
-     * @defaultValue `true`
-     */
-    remoteConfigEnabled?: boolean;
-    /**
-     * Firebase persistence type
-     * Applicable only for web version. Unsupported in native.
-     * @defaultValue 'LOCAL'
-     */
-    authPersistenceType?: "SESSION" | "LOCAL" | "NONE" | "COOKIE";
-};
-
-/**
- * FirebaseContextProvider component configures and provides Firebase services to its children.
- * Initializes Firebase app and enables optional Firebase services such as Firestore, Auth, Analytics,
- * and Remote Config based on the provided configuration and parameters.
- *
- * @group Component
- *
- * @param {FirebaseContextProviderProps} props
- *
- * @returns {FirebaseContextProvider<FirebaseContextProviderProps>}
- *
- * @example
- * ```jsx
- * const firebaseConfig = {};
- * export const App = () => {
- *  return (
- *      <FirebaseContextProvider options={firebaseConfig}>
- *          <ChildComponent />
- *      </FirebaseContextProvider>
- *  );
- * };
- * ```
- */
-export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = ({
-    emulators,
-    children,
-    authEnabled = true,
-    firestoreEnabled = true,
-    analyticsEnabled = true,
-    consentSettings = {},
-    remoteConfigEnabled = true,
-    remoteConfigSettings,
-    remoteConfigDefaults = {},
-    firestoreSettings
-}) => {
-    const internalFirebase = useMemo(() => getApp(), []);
-
-    useEffect(() => {
-        setConsent(getAnalytics(internalFirebase), {
-            ad_personalization: false,
-            ad_storage: false,
-            ad_user_data: false,
-            analytics_storage: false,
-            functionality_storage: false,
-            personalization_storage: false,
-            security_storage: false,
-            ...consentSettings
-        });
-    }, [consentSettings, internalFirebase]);
-
-    const internalFirestore = useMemo(() => {
-        if (firestoreEnabled) {
-            if (emulators?.firestore?.host && emulators?.firestore?.port) {
-                connectFirestoreEmulator(
-                    getFirestore(internalFirebase),
-                    emulators.firestore.host,
-                    emulators.firestore.port
-                );
-            }
-
-            const localFirestore = getFirestore(internalFirebase);
-            if (firestoreSettings) {
-                localFirestore.settings(firestoreSettings);
-            }
-            return localFirestore;
-        }
-
-        return null;
-    }, [emulators, firestoreEnabled, internalFirebase, firestoreSettings]);
-
-    const internalAuth = useMemo(() => {
-        if (authEnabled) {
-            const localAuth = getAuth(internalFirebase);
-            if (emulators?.auth?.host) {
-                connectAuthEmulator(localAuth, emulators?.auth?.host, {
-                    disableWarnings: true
-                });
-            }
-            return localAuth;
-        }
-        return null;
-    }, [emulators?.auth, authEnabled, internalFirebase]);
-
-    const internalAnalytics = useMemo(() => {
-        if (analyticsEnabled) {
-            return getAnalytics(internalFirebase);
-        }
-        return null;
-    }, [analyticsEnabled, internalFirebase]);
-
-    const internalRemoteConfig = useMemo(() => {
-        if (remoteConfigEnabled) {
-            const localRemoteConfig = getRemoteConfig(internalFirebase);
-            if (remoteConfigSettings) {
-                localRemoteConfig.settings.fetchTimeMillis = remoteConfigSettings.fetchTimeMillis;
-                localRemoteConfig.settings.minimumFetchIntervalMillis = remoteConfigSettings.minimumFetchIntervalMillis;
-                localRemoteConfig.defaultConfig = remoteConfigDefaults;
-            }
-            return localRemoteConfig;
-        }
-        return null;
-    }, [remoteConfigEnabled, remoteConfigSettings, remoteConfigDefaults, internalFirebase]);
-
-    const contextValue = useMemo(
-        () => ({
-            firebase: internalFirebase,
-            auth: internalAuth,
-            analytics: internalAnalytics,
-            firestore: internalFirestore,
-            remoteConfig: internalRemoteConfig
-        }),
-        [internalFirebase, internalAuth, internalAnalytics, internalFirestore, internalRemoteConfig]
-    );
-
-    useEffect(() => {
-        if (contextValue.analytics) {
-            setAnalyticsCollectionEnabled(contextValue.analytics, !!consentSettings?.analytics_storage);
-        }
-    }, [consentSettings, contextValue.analytics]);
-
-    return (
-        <FirebaseContext.Provider value={contextValue as unknown as FirebaseContextValue}>
-            {children}
-        </FirebaseContext.Provider>
-    );
-};

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

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

package/react-native/context/index.js

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

package/react-native/context/index.ts

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

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

@@ -1,23 +0,0 @@
-export * from "./useFirestore";
-export * from "./useAddDocMutation";
-export * from "./useBatchWrite";
-export * from "./useCollectionReference";
-export * from "./useCompositeFilter";
-export * from "./useCountQuery";
-export * from "./useDeleteDocMutation";
-export * from "./useDocReference";
-export * from "./useDocReferences";
-export * from "./useGetDocData";
-export * from "./useInfiniteQuery";
-export * from "./useQuery";
-export * from "./useRunTransaction";
-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";
-export * from "./useEnsureDoc";

package/react-native/firestore/index.js

@@ -1,23 +0,0 @@
-export * from "./useFirestore";
-export * from "./useAddDocMutation";
-export * from "./useBatchWrite";
-export * from "./useCollectionReference";
-export * from "./useCompositeFilter";
-export * from "./useCountQuery";
-export * from "./useDeleteDocMutation";
-export * from "./useDocReference";
-export * from "./useDocReferences";
-export * from "./useGetDocData";
-export * from "./useInfiniteQuery";
-export * from "./useQuery";
-export * from "./useRunTransaction";
-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";
-export * from "./useEnsureDoc";

package/react-native/firestore/index.ts

@@ -1,23 +0,0 @@
-export * from "./useFirestore";
-export * from "./useAddDocMutation";
-export * from "./useBatchWrite";
-export * from "./useCollectionReference";
-export * from "./useCompositeFilter";
-export * from "./useCountQuery";
-export * from "./useDeleteDocMutation";
-export * from "./useDocReference";
-export * from "./useDocReferences";
-export * from "./useGetDocData";
-export * from "./useInfiniteQuery";
-export * from "./useQuery";
-export * from "./useRunTransaction";
-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";
-export * from "./useEnsureDoc";

package/react-native/firestore/useAddDocMutation.ts

@@ -1,80 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { FirebaseFirestoreTypes, addDoc, WithFieldValue, getDoc } from "@react-native-firebase/firestore";
-
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { useMemo } from "react";
-import { AppModel } from "../../types";
-
-/**
- * @inline
- */
-export type UseAddDocMutationValues<AppModelType> = {
-    /**
-     * Data to write
-     */
-    data: WithFieldValue<AppModelType>;
-};
-
-/**
- * @inline
- */
-export type UseAddDocMutationOptions<AppModelType extends AppModel = AppModel, TContext = unknown> = {
-    /**
-     * 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"
-    >;
-};
-
-/**
- * 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
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const {mutate} = useAddDocMutation({
- *      options: {
- *      },
- *      reference: collection(),
- *  });
- *
- *  // ....
- *  mutate({data: {test: 'value'}});
- *  // ....
- * };
- * ```
- */
-export const useAddDocMutation = <AppModelType extends AppModel = AppModel, TContext = unknown>({
-    collectionReference,
-    options = {}
-}: UseAddDocMutationOptions<AppModelType, TContext>) => {
-    const mutationKey = useMemo(() => [collectionReference.path], [collectionReference.path]);
-
-    return useMutation({
-        mutationKey,
-        ...options,
-        mutationFn: async ({ data }) => {
-            const docRef = await addDoc<AppModelType, AppModelType>(collectionReference, data);
-            const docSnap = await getDoc(docRef);
-            return { ...(docSnap.data() as AppModelType), uid: docRef.id } as AppModelType;
-        }
-    });
-};

package/react-native/firestore/useBatchWrite.ts

@@ -1,58 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { writeBatch, FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
-
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { useFirestore } from "./useFirestore";
-
-/**
- * @inline
- */
-export type UseBatchWriteVariables = (batch: FirebaseFirestoreTypes.WriteBatch) => Promise<void> | void;
-
-/**
- * @inline
- */
-export type UseBatchWriteOptions = {
-    options?: Omit<
-        UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseBatchWriteVariables>,
-        "mutationFn"
-    >;
-};
-
-/**
- * Custom hook to perform batch write operations using Firestore.
- *
- * @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 = {} }: UseBatchWriteOptions = {}) => {
-    const db = useFirestore();
-
-    return useMutation({
-        ...options,
-        mutationFn: async (batchWriteFn) => {
-            const batch = writeBatch(db);
-            await batchWriteFn(batch);
-            return batch.commit();
-        }
-    });
-};

package/react-native/firestore/useCollectionReference.ts

@@ -1,58 +0,0 @@
-import { collection, FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
-
-import { useMemo } from "react";
-import { AppModel } from "../../types";
-import { useFirestore } from "./useFirestore";
-
-/**
- * @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[];
-};
-
-/**
- * Gets a `CollectionReference` instance that refers to a subcollection of
- * `reference` at the specified relative path.
- *
- * @group Hook
- *
- * @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 = <AppModelType extends AppModel = AppModel>({
-    path,
-    reference,
-    pathSegments
-}: UseCollectionReferenceOptions<AppModelType>) => {
-    const db = useFirestore();
-
-    return useMemo(() => {
-        return !reference
-            ? collection(db, path || "", ...(pathSegments || []))
-            : collection(reference, path, ...(pathSegments || []));
-    }, [db, reference, path, pathSegments]) as FirebaseFirestoreTypes.CollectionReference<AppModelType>;
-};

package/react-native/firestore/useCompositeFilter.ts

@@ -1,60 +0,0 @@
-import { and, or } from "@react-native-firebase/firestore";
-import { useMemo } from "react";
-import { AppModel } from "../../types";
-import { buildCompositeFilter, CompositeFilter, QueryFilterConstraint } from "./utils/buildCompositeFilter";
-
-/**
- * @inline
- */
-export type UseCompositeFilter<AppModelType extends AppModel = AppModel> = {
-    query?: CompositeFilter<AppModelType>;
-};
-
-/**
- * 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.
- *
- * @group Hook
- *
- * @param {QueryElement<AppModelType>} query
- *
- * @returns {QueryFilterConstraint | null}
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const filter = useCompositeFilter({
- *      operator: "AND",
- *      children: [
- *          {
- *              field: "field",
- *              value: "value",
- *              op: "=="
- *          },
- *          ...(query ? [query] : [])
- *      ]
- *  });
- *  console.log(filter);
- * };
- * ```
- */
-export const useCompositeFilter = <AppModelType extends AppModel = AppModel>({
-    query
-}: UseCompositeFilter<AppModelType>): QueryFilterConstraint | undefined => {
-    return useMemo(() => {
-        const queryConstraints =
-            query?.children
-                ?.map?.((subQuery) => buildCompositeFilter(subQuery))
-                ?.filter?.((constraint) => !!constraint) ?? [];
-
-        if (queryConstraints.length <= 0) {
-            return undefined;
-        }
-
-        if (queryConstraints.length <= 1) {
-            return queryConstraints[0];
-        }
-
-        return query?.operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
-    }, [query]);
-};

package/react-native/firestore/useCountQuery.ts

@@ -1,85 +0,0 @@
-import {
-    FirebaseFirestoreTypes,
-    getCountFromServer,
-    query,
-    QueryConstraint,
-    QueryNonFilterConstraint
-} from "@react-native-firebase/firestore";
-
-import {
-    UseQueryResult,
-    useQuery as useReactQuery,
-    UseQueryOptions as UseReactQueryOptions
-} from "@tanstack/react-query";
-import { AppModel } from "../../types";
-import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
-
-/**
- * @inline
- */
-type UseCountQueryOptions<AppModelType extends AppModel = AppModel> = {
-    /**
-     * Reqct-query options that must include queryKey and shall not define queryFn
-     */
-    options: Omit<UseReactQueryOptions<number, Error, number>, "queryFn"> &
-        Required<Pick<UseReactQueryOptions<number, Error, number>, "queryKey">>;
-
-    /**
-     * Reference to a Firestore collection
-     */
-    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
-
-    /**
-     * Non composite filter constraints such as limit, order, where
-     */
-    queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
-
-    /**
-     * Composite filter
-     */
-    compositeFilter?: QueryFilterConstraint;
-};
-
-/**
- * Executes a query with specified constraints and returns the count of matched documents.
- *
- * @group Hook
- *
- * @param {UseCountQueryOptions<AppModelType>} options - Configuration options for the query.
- *
- * @returns {UseQueryResult<number>} An object containing the number of documents that match the query.
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const count = useCountQuery({
- *      options: {
- *          queryKey: ['key']
- *      },
- *      collectionReference: collection(),
- *  });
- *  console.log(count);
- * };
- * ```
- */
-export const useCountQuery = <AppModelType extends AppModel = AppModel>({
-    options,
-    collectionReference,
-    queryConstraints = [],
-    compositeFilter
-}: UseCountQueryOptions<AppModelType>): UseQueryResult<number> => {
-    return useReactQuery({
-        ...options,
-        queryFn: async () => {
-            const queryToExecute = compositeFilter
-                ? query(collectionReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
-                : query(collectionReference, ...(queryConstraints as QueryConstraint[]));
-
-            const querySnapshot = await getCountFromServer(queryToExecute);
-            if (querySnapshot) {
-                return querySnapshot.data().count;
-            }
-            return 0;
-        }
-    });
-};