react-query-firebase 2.0.3 → 2.1.1

package/package.json

@@ -57,6 +57,7 @@
     "files": [
         "./web/",
         "./react-native/",
+        "./types",
         "package.json",
         "package-lock.json",
         "README.md",
@@ -68,10 +69,10 @@
         "lint:fix": "eslint  --fix",
         "lint:staged": "lint-staged",
         "prepare": "husky",
-        "docs:generate": "mv docs/.vitepress .vitepress && rm -rf docs && typedoc --plugin typedoc-plugin-markdown --plugin typedoc-vitepress-theme && mv .vitepress docs/.vitepress",
+        "docs:generate": "./.github/scripts/build.sh",
         "docs:dev": "vitepress dev docs",
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.0.3"
+    "version": "2.1.1"
 }

package/react-native/firestore/index.ts

@@ -14,3 +14,4 @@ export * from "./useRunTransaction";
 export * from "./useSetDocMutation";
 export * from "./useUpdateDocMutation";
 export * from "./useGetRealtimeDocData";
+export * from "./useQueryConstraints";

package/react-native/firestore/useCompositeFilter.ts

@@ -28,11 +28,11 @@ export type UseCompositeFilter<DbModelType extends CompositeFilterDocumentData =
  * @returns {QueryFieldFilterConstraint | null} A constructed query filter constraint based on the input query, or null if no valid constraints can be derived.
  */
 
-const buildCompositeQuery = <DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData>(
+export const buildCompositeFilter = <DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData>(
     query: QueryElement<DbModelType>
 ): FirebaseFirestoreTypes.QueryFilterConstraint | null => {
     if (query.children) {
-        const queryConstraints = query.children.map(buildCompositeQuery).filter((constraint) => !!constraint);
+        const queryConstraints = query.children.map(buildCompositeFilter).filter((constraint) => !!constraint);
 
         if (queryConstraints.length <= 0) {
             return null;
@@ -67,7 +67,7 @@ export const useCompositeFilter = <DbModelType extends CompositeFilterDocumentDa
 }: UseCompositeFilter<DbModelType>) => {
     return useMemo(() => {
         const queryConstraints =
-            query?.children?.map?.((subQuery) => buildCompositeQuery(subQuery))
+            query?.children?.map?.((subQuery) => buildCompositeFilter(subQuery))
                 ?.filter<FirebaseFirestoreTypes.QueryFilterConstraint>?.((constraint) => !!constraint) ?? [];
 
         if (queryConstraints.length <= 0) {

package/react-native/firestore/useQueryConstraints.ts

@@ -0,0 +1,84 @@
+import { startAt, orderBy, limit, limitToLast, startAfter, endAt, endBefore } from "@react-native-firebase/firestore";
+import { useMemo } from "react";
+import { AppModel } from "../../types/AppModel";
+import { type NonFilterQueryConstraint } from "../../types/QueryConstraints";
+
+/**
+ * @inline
+ */
+export type UseQueryConstraints<AppModelType extends AppModel = AppModel> = {
+    /**
+     * A list of constraints such as limit, order, offset.
+     */
+    constraints: NonFilterQueryConstraint<AppModelType>[];
+};
+
+/**
+ * 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>
+) => {
+    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);
+    }
+};
+
+/**
+ * A hook to build a list of non-filter query constraints for firebase queries.
+ * It uses buildQueryConstraint method and useMemo hook.
+ *
+ * @group Hook
+ *
+ * @param {UseQueryConstraints<AppModelType>} options
+ *
+ * @returns {FirebaseFirestoreTypes.QueryNonFilterConstraint}
+ *
+ * @example
+ * ```jsx
+ * const firebaseConfig = {};
+ * export const constraint = useQueryConstraints([
+ *  {
+ *      type: 'limit',
+ *      limit: 1
+ *  }
+ * ]};
+ * ```
+ */
+export const useQueryConstraints = <AppModelType extends AppModel = AppModel>({
+    constraints
+}: UseQueryConstraints<AppModelType>) => {
+    return useMemo(() => {
+        return constraints.map(buildQueryConstraint);
+    }, [constraints]);
+};

package/react-native/index.d.ts

@@ -1,5 +1 @@
-export * from "./analytics";
-export * from "./auth";
 export * from "./context";
-export * from "./firestore";
-export * from "./remoteConfig";

package/react-native/index.js

@@ -1,5 +1 @@
-export * from "./analytics";
-export * from "./auth";
 export * from "./context";
-export * from "./firestore";
-export * from "./remoteConfig";

package/react-native/index.ts

@@ -1,5 +1 @@
-export * from "./analytics";
-export * from "./auth";
 export * from "./context";
-export * from "./firestore";
-export * from "./remoteConfig";

package/types/AppModel.ts

@@ -0,0 +1,7 @@
+/**
+ * Generic definition for a data model
+ * @group Models
+ */
+export type AppModel = {
+    [key: string]: unknown;
+};

package/types/QueryConstraints.ts

@@ -0,0 +1,58 @@
+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";
+    value: number | string | boolean | null;
+    key?: string;
+};
+
+/**
+ * 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.ts

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

package/web/firestore/index.ts

@@ -14,3 +14,4 @@ export * from "./useRunTransaction";
 export * from "./useSetDocMutation";
 export * from "./useUpdateDocMutation";
 export * from "./useGetRealtimeDocData";
+export * from "./useQueryConstraints";

package/web/firestore/useCompositeFilter.ts

@@ -28,11 +28,11 @@ export type UseCompositeFilter<DbModelType extends CompositeFilterDocumentData =
  * @returns {QueryFieldFilterConstraint | null} A constructed query filter constraint based on the input query, or null if no valid constraints can be derived.
  */
 
-const buildCompositeQuery = <DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData>(
+export const buildCompositeFilter = <DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData>(
     query: QueryElement<DbModelType>
 ): QueryFilterConstraint | null => {
     if (query.children) {
-        const queryConstraints = query.children.map(buildCompositeQuery).filter((constraint) => !!constraint);
+        const queryConstraints = query.children.map(buildCompositeFilter).filter((constraint) => !!constraint);
 
         if (queryConstraints.length <= 0) {
             return null;
@@ -63,7 +63,7 @@ export const useCompositeFilter = <DbModelType extends CompositeFilterDocumentDa
 }: UseCompositeFilter<DbModelType>) => {
     return useMemo(() => {
         const queryConstraints =
-            query?.children?.map?.((subQuery) => buildCompositeQuery(subQuery))?.filter<QueryFilterConstraint>?.(
+            query?.children?.map?.((subQuery) => buildCompositeFilter(subQuery))?.filter<QueryFilterConstraint>?.(
                 (constraint) => !!constraint
             ) ?? [];
 

package/web/firestore/useQueryConstraints.ts

@@ -0,0 +1,93 @@
+import {
+    QueryNonFilterConstraint,
+    startAt,
+    orderBy,
+    limit,
+    limitToLast,
+    startAfter,
+    endAt,
+    endBefore
+} from "firebase/firestore";
+import { AppModel } from "../../types/AppModel";
+import { NonFilterQueryConstraint } from "../../types/QueryConstraints";
+import { useMemo } from "react";
+
+/**
+ * @inline
+ */
+export type UseQueryConstraints<AppModelType extends AppModel = AppModel> = {
+    /**
+     * A list of constraints such as limit, order, offset.
+     */
+    constraints: NonFilterQueryConstraint<AppModelType>[];
+};
+
+/**
+ * A generic mothod to build query constraints for firebase
+ *
+ * @group Utility
+ *
+ * @param {NonFilterQueryConstraint<AppModelType>} constraint
+ *
+ * @returns {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);
+    }
+};
+
+/**
+ * A hook to build a list of non-filter query constraints for firebase queries.
+ * It uses buildQueryConstraint method and useMemo hook.
+ *
+ * @group Hook
+ *
+ * @param {UseQueryConstraints<AppModelType>} constraints
+ *
+ * @returns {QueryNonFilterConstraint[]}
+ *
+ * @example
+ * ```jsx
+ * const firebaseConfig = {};
+ * export const constraint = useQueryConstraints([
+ *  {
+ *      type: 'limit',
+ *      limit: 1
+ *  }
+ * ]};
+ * ```
+ */
+export const useQueryConstraints = <AppModelType extends AppModel = AppModel>({
+    constraints
+}: UseQueryConstraints<AppModelType>): QueryNonFilterConstraint[] => {
+    return useMemo(() => {
+        return constraints.map(buildQueryConstraint);
+    }, [constraints]);
+};

package/web/index.d.ts

@@ -1,5 +1 @@
-export * from "./analytics";
-export * from "./auth";
 export * from "./context";
-export * from "./firestore";
-export * from "./remoteConfig";

package/web/index.js

@@ -1,5 +1 @@
-export * from "./analytics";
-export * from "./auth";
 export * from "./context";
-export * from "./firestore";
-export * from "./remoteConfig";

package/web/index.ts

@@ -1,5 +1 @@
-export * from "./analytics";
-export * from "./auth";
 export * from "./context";
-export * from "./firestore";
-export * from "./remoteConfig";

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

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

package/react-native/analytics/index.js

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

package/react-native/analytics/useAnalytics.d.ts

@@ -1,5 +0,0 @@
-/**
- * Hook to access Firebase analytics from the Firebase context.
- * @returns {any} The analytics object from the Firebase context.
- */
-export declare const useAnalytics: () => import("@react-native-firebase/analytics").FirebaseAnalyticsTypes.Module;

package/react-native/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;
-};

package/react-native/analytics/useLogEvent.d.ts

@@ -1,17 +0,0 @@
-type UseLogEventOptions = {
-    eventName: string;
-    eventParams?: {
-        [key: string]: unknown;
-    };
-};
-/**
- * Custom hook to create a log event function that logs an analytics event with specified parameters.
- * @param {Object}  options - The options for the log event.
- * @param {string}  options.eventName - The name of the event to be logged.
- * @param {Object}  options.eventParams - The parameters to be sent along with the event.
- * @returns {Object} An object containing a `logEvent` function that, when called, logs the event.
- */
-export declare const useLogEvent: ({ eventName, eventParams }: UseLogEventOptions) => {
-    logEvent: () => void;
-};
-export {};

package/react-native/analytics/useLogEvent.js

@@ -1,21 +0,0 @@
-import { logEvent } from "@react-native-firebase/analytics";
-import { useAnalytics } from "./useAnalytics";
-import { useCallback, useMemo } from "react";
-/**
- * Custom hook to create a log event function that logs an analytics event with specified parameters.
- * @param {Object}  options - The options for the log event.
- * @param {string}  options.eventName - The name of the event to be logged.
- * @param {Object}  options.eventParams - The parameters to be sent along with the event.
- * @returns {Object} An object containing a `logEvent` function that, when called, logs the event.
- */
-export const useLogEvent = ({ eventName, eventParams }) => {
-    const analytics = useAnalytics();
-    const logEventCallback = useCallback(() => {
-        if (analytics) {
-            logEvent(analytics, eventName, eventParams);
-        }
-    }, [eventName, eventParams, analytics]);
-    return useMemo(() => ({
-        logEvent: logEventCallback
-    }), [logEventCallback]);
-};

package/react-native/analytics/useSetAnalyticsCollectionEnabled.d.ts

@@ -1,10 +0,0 @@
-type UseSetAnalyticsCollectionEnabledOptions = {
-    enabled?: boolean;
-};
-/**
- * Custom hook to enable or disable analytics collection
- * @param {Object}  options - The options for hook.
- * @param {string}  options.enabled - Flag that identifies if analytics collection is enabled.
- */
-export declare const useSetAnalyticsCollectionEnabled: ({ enabled }: UseSetAnalyticsCollectionEnabledOptions) => void;
-export {};

package/react-native/analytics/useSetAnalyticsCollectionEnabled.js

@@ -1,16 +0,0 @@
-import { setAnalyticsCollectionEnabled } from "@react-native-firebase/analytics";
-import { useAnalytics } from "./useAnalytics";
-import { useEffect } from "react";
-/**
- * Custom hook to enable or disable analytics collection
- * @param {Object}  options - The options for hook.
- * @param {string}  options.enabled - Flag that identifies if analytics collection is enabled.
- */
-export const useSetAnalyticsCollectionEnabled = ({ enabled = false }) => {
-    const analytics = useAnalytics();
-    useEffect(() => {
-        if (analytics) {
-            setAnalyticsCollectionEnabled(analytics, enabled);
-        }
-    }, [analytics, enabled]);
-};

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

@@ -1,12 +0,0 @@
-export * from "./mutation-keys";
-export * from "./useAuth";
-export * from "./useCreateUserWitEmailAndPasswordMutation";
-export * from "./useSendEmailVerificationMutation";
-export * from "./useSignInWitEmailAndPasswordMutation";
-export * from "./useCurrentUser";
-export * from "./useSignInWitRedirectMutation";
-export * from "./useUpdateProfileMutation";
-export * from "./useSignOutMutation";
-export * from "./useIdToken";
-export * from "./useReauthenticateWitCredentialMutation";
-export * from "./useReauthenticateWitRedirectMutation";

package/react-native/auth/index.js

@@ -1,12 +0,0 @@
-export * from "./mutation-keys";
-export * from "./useAuth";
-export * from "./useCreateUserWitEmailAndPasswordMutation";
-export * from "./useSendEmailVerificationMutation";
-export * from "./useSignInWitEmailAndPasswordMutation";
-export * from "./useCurrentUser";
-export * from "./useSignInWitRedirectMutation";
-export * from "./useUpdateProfileMutation";
-export * from "./useSignOutMutation";
-export * from "./useIdToken";
-export * from "./useReauthenticateWitCredentialMutation";
-export * from "./useReauthenticateWitRedirectMutation";

package/react-native/auth/mutation-keys.d.ts

@@ -1,7 +0,0 @@
-export declare const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"];
-export declare const SEND_EMAIL_VERIFICATION_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"];
-export declare const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"];
-export declare const SIGN_IN_WITH_REDIRECT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_WITH_REDIRECT_MUTATION"];
-export declare const SIGN_OUT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_OUT"];
-export declare const REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_REDIRECT"];
-export declare const REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_CREDENTIAL"];

package/react-native/auth/mutation-keys.js

@@ -1,19 +0,0 @@
-export const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
-    "FIREBASE",
-    "AUTH",
-    "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"
-];
-export const SEND_EMAIL_VERIFICATION_MUTATION_KEY = ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"];
-export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
-    "FIREBASE",
-    "AUTH",
-    "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"
-];
-export const SIGN_IN_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_WITH_REDIRECT_MUTATION"];
-export const SIGN_OUT_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_OUT"];
-export const REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_REDIRECT"];
-export const REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY = [
-    "FIREBASE",
-    "AUTH",
-    "REAUTHENTICATE_WITH_CREDENTIAL"
-];

package/react-native/auth/useAuth.d.ts

@@ -1,5 +0,0 @@
-/**
- * Custom hook to retrieve the authentication object from the Firebase context.
- * @returns {Auth} The authentication object from the Firebase context.
- */
-export declare const useAuth: () => import("@react-native-firebase/auth").FirebaseAuthTypes.Module;

package/react-native/auth/useAuth.js

@@ -1,10 +0,0 @@
-import { useContext } from "react";
-import { FirebaseContext } from "../context/FirebaseContext";
-/**
- * Custom hook to retrieve the authentication object from the Firebase context.
- * @returns {Auth} The authentication object from the Firebase context.
- */
-export const useAuth = () => {
-    const { auth } = useContext(FirebaseContext);
-    return auth;
-};

package/react-native/auth/useCreateUserWitEmailAndPasswordMutation.d.ts

@@ -1,15 +0,0 @@
-import { UseMutationOptions } from "@tanstack/react-query";
-import { FirebaseAuthTypes } from "@react-native-firebase/auth";
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-export type UseCreateUserWitEmailAndPasswordMutationVariables = {
-    email: string;
-    password: string;
-};
-/**
- * Custom hook to initiate a user creation process using email and password with Firebase authentication.
- * This hook utilizes the `useMutation` functionality to support creating new user credentials asynchronously.
- *
- * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional settings to customize the mutation behavior, excluding `mutationKey` and `mutationFn`.
- * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>} The result of the mutation which includes status, user credentials, and error information if any.
- */
-export declare const useCreateUserWitEmailAndPasswordMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>;

package/react-native/auth/useCreateUserWitEmailAndPasswordMutation.js

@@ -1,19 +0,0 @@
-import { useMutation } from "@tanstack/react-query";
-import { createUserWithEmailAndPassword } from "@react-native-firebase/auth";
-import { useAuth } from "./useAuth";
-import { CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
-/**
- * Custom hook to initiate a user creation process using email and password with Firebase authentication.
- * This hook utilizes the `useMutation` functionality to support creating new user credentials asynchronously.
- *
- * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional settings to customize the mutation behavior, excluding `mutationKey` and `mutationFn`.
- * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>} The result of the mutation which includes status, user credentials, and error information if any.
- */
-export const useCreateUserWitEmailAndPasswordMutation = (options = {}) => {
-    const firebaseAuth = useAuth();
-    return useMutation({
-        ...options,
-        mutationFn: async ({ email, password }) => await createUserWithEmailAndPassword(firebaseAuth, email, password),
-        mutationKey: CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY
-    });
-};

package/react-native/auth/useCurrentUser.d.ts

@@ -1,6 +0,0 @@
-/**
- * Hook that provides the current authenticated user from Firebase Auth.
- * It listens for changes in the authentication state and updates the user accordingly.
- * @returns {Object|null} The current authenticated user object or null if no user is authenticated.
- */
-export declare const useCurrentUser: () => import("@react-native-firebase/auth").FirebaseAuthTypes.User | null;

package/react-native/auth/useCurrentUser.js

@@ -1,20 +0,0 @@
-import { useAuth } from "./useAuth";
-import { useEffect, useState } from "react";
-/**
- * Hook that provides the current authenticated user from Firebase Auth.
- * It listens for changes in the authentication state and updates the user accordingly.
- * @returns {Object|null} The current authenticated user object or null if no user is authenticated.
- */
-export const useCurrentUser = () => {
-    const { onAuthStateChanged, currentUser: fbCurrentUser } = useAuth();
-    const [currentUser, setCurrentUser] = useState(fbCurrentUser);
-    useEffect(() => {
-        const unsubscribe = onAuthStateChanged((user) => {
-            setCurrentUser(user);
-        });
-        return () => {
-            unsubscribe();
-        };
-    }, [currentUser?.uid, onAuthStateChanged]);
-    return currentUser;
-};

package/react-native/auth/useIdToken.d.ts

@@ -1,30 +0,0 @@
-/**
- * @inline
- */
-export type UseIdTokenResult = {
-    idToken: string;
-    refresh: () => Promise<string | undefined>;
-};
-/**
- * A hook to manage the ID token.
- * It monitors changes to the ID token and provides the token itself along with a refresh method to update the token when needed.
- *
- * @group Hook
- *
- * @returns {UseIdTokenResult}
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const result = useIdToken();
- *  useEffect(() => {
- *      const timeout = setTimeout(() => {
- *          result.refresh();
- *      }, 5000);
- *      return () => clearTimeout();
- *  }, [])
- *  console.log(resilt.idToken);
- * };
- * ```
- */
-export declare const useIdToken: () => UseIdTokenResult;