react-query-firebase 2.7.1 → 2.9.0

package/package.json

@@ -12,7 +12,7 @@
         "@react-native-firebase/firestore": "^22.x.x",
         "@react-native-firebase/installations": "^22.x.x",
         "@react-native-firebase/remote-config": "^22.x.x",
-        "@tanstack/react-query": "^5.x.x",
+        "@tanstack/react-query": "^5.83.0",
         "firebase": "^11.x.x",
         "react": "^18.x.x || ^19.x.x"
     },
@@ -24,22 +24,22 @@
         "@laverve/eslint-utils": "^5.3.1",
         "@react-native-firebase/analytics": "^22.2.1",
         "@react-native-firebase/app": "^22.2.1",
-        "@react-native-firebase/auth": "^22.2.1",
-        "@react-native-firebase/crashlytics": "^22.2.1",
-        "@react-native-firebase/firestore": "^22.2.1",
-        "@react-native-firebase/installations": "^22.2.1",
-        "@react-native-firebase/remote-config": "^22.2.1",
-        "@types/react": "^19.1.7",
+        "@react-native-firebase/auth": "^22.4.0",
+        "@react-native-firebase/crashlytics": "^22.4.0",
+        "@react-native-firebase/firestore": "^22.4.0",
+        "@react-native-firebase/installations": "^22.4.0",
+        "@react-native-firebase/remote-config": "^22.4.0",
+        "@types/react": "^19.1.8",
+        "firebase": "^11.9.0",
         "husky": "^9.1.7",
-        "lint-staged": "^16.1.0",
-        "prettier": "^3.5.3",
+        "lint-staged": "^16.1.2",
+        "prettier": "^3.6.2",
         "react": "^19.1.0",
-        "typedoc": "^0.28.5",
-        "typedoc-plugin-markdown": "^4.6.4",
+        "typedoc": "^0.28.7",
+        "typedoc-plugin-markdown": "^4.7.1",
         "typedoc-vitepress-theme": "^1.1.2",
         "typescript": "^5.8.3",
-        "vitepress": "^1.6.3",
-        "firebase": "^11.9.0"
+        "vitepress": "^1.6.3"
     },
     "homepage": "https://github.com/vpishuk/react-query-firebase",
     "keywords": [
@@ -74,5 +74,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.7.1"
+    "version": "2.9.0"
 }

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

@@ -12,5 +12,7 @@ export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
 export * from "./useAuthStateReady";
 export * from "./useSignInAnonymouslyMutation";
-export * from "./useAuthProvider";
-export * from "./useLinkWithRedirect";
+export * from "./useEmailAuthProviderCredential";
+export * from "./useFacebookAuthProviderCredential";
+export * from "./useAppleAuthProviderCredential";
+export * from "./useLinkWithCredentialMutation";

package/react-native/auth/index.js

@@ -12,5 +12,7 @@ export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
 export * from "./useAuthStateReady";
 export * from "./useSignInAnonymouslyMutation";
-export * from "./useAuthProvider";
-export * from "./useLinkWithRedirect";
+export * from "./useEmailAuthProviderCredential";
+export * from "./useFacebookAuthProviderCredential";
+export * from "./useAppleAuthProviderCredential";
+export * from "./useLinkWithCredentialMutation";

package/react-native/auth/index.ts

@@ -12,5 +12,7 @@ export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
 export * from "./useAuthStateReady";
 export * from "./useSignInAnonymouslyMutation";
-export * from "./useAuthProvider";
-export * from "./useLinkWithRedirect";
+export * from "./useEmailAuthProviderCredential";
+export * from "./useFacebookAuthProviderCredential";
+export * from "./useAppleAuthProviderCredential";
+export * from "./useLinkWithCredentialMutation";

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

@@ -3,7 +3,7 @@ export declare const SEND_EMAIL_VERIFICATION_MUTATION_KEY: readonly ["FIREBASE",
 export declare const SIGN_IN_ANONYMOUSLY_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_ANONYMOUSLY_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 LINK_WITH_REDIRECT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "LINK_WITH_REDIRECT_MUTATION"];
+export declare const LINK_WITH_CREDENTIAL_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "LINK_WITH_CREDENTIAL_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

@@ -11,7 +11,7 @@ export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"
 ];
 export const SIGN_IN_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_WITH_REDIRECT_MUTATION"];
-export const LINK_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "LINK_WITH_REDIRECT_MUTATION"];
+export const LINK_WITH_CREDENTIAL_MUTATION_KEY = ["FIREBASE", "AUTH", "LINK_WITH_CREDENTIAL_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 = [

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

@@ -11,7 +11,7 @@ export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"
 ] as const;
 export const SIGN_IN_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_WITH_REDIRECT_MUTATION"] as const;
-export const LINK_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "LINK_WITH_REDIRECT_MUTATION"] as const;
+export const LINK_WITH_CREDENTIAL_MUTATION_KEY = ["FIREBASE", "AUTH", "LINK_WITH_CREDENTIAL_MUTATION"] as const;
 export const SIGN_OUT_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_OUT"] as const;
 export const REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_REDIRECT"] as const;
 export const REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY = [

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

@@ -0,0 +1,24 @@
+import { FirebaseAuthTypes } from "@react-native-firebase/auth";
+type Credential = {
+    token: string;
+    nonce: string;
+};
+/**
+ * A custom hook that returns an auth credential for facebook.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useAppleAuthProviderCredential();
+ *  // ...
+ *  getCredential({token, nonce: ''})
+ * };
+ * ```
+ */
+export declare const useAppleAuthProviderCredential: () => (credential: Credential) => FirebaseAuthTypes.AuthCredential;
+export {};

package/react-native/auth/useAppleAuthProviderCredential.js

@@ -0,0 +1,24 @@
+import { AppleAuthProvider } from "@react-native-firebase/auth";
+import { useCallback } from "react";
+/**
+ * A custom hook that returns an auth credential for facebook.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useAppleAuthProviderCredential();
+ *  // ...
+ *  getCredential({token, nonce: ''})
+ * };
+ * ```
+ */
+export const useAppleAuthProviderCredential = () => {
+    return useCallback((credential) => {
+        return AppleAuthProvider.credential(credential.token, credential.nonce);
+    }, []);
+};

package/react-native/auth/useAppleAuthProviderCredential.ts

@@ -0,0 +1,31 @@
+import { AppleAuthProvider, FirebaseAuthTypes } from "@react-native-firebase/auth";
+import { useCallback } from "react";
+
+type Credential = {
+    token: string;
+    nonce: string;
+};
+
+/**
+ * A custom hook that returns an auth credential for facebook.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useAppleAuthProviderCredential();
+ *  // ...
+ *  getCredential({token, nonce: ''})
+ * };
+ * ```
+ */
+
+export const useAppleAuthProviderCredential = () => {
+    return useCallback((credential: Credential): FirebaseAuthTypes.AuthCredential => {
+        return AppleAuthProvider.credential(credential.token, credential.nonce);
+    }, []);
+};

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

@@ -0,0 +1,25 @@
+import { FirebaseAuthTypes } from "@react-native-firebase/auth";
+type Credential = {
+    email: string;
+    password?: string;
+    emailLink?: string;
+};
+/**
+ * A custom hook that returns an auth credential for email.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useEmailAuthProviderCredential();
+ *  // ...
+ *  getCredential({email, password})
+ * };
+ * ```
+ */
+export declare const useEmailAuthProviderCredential: () => (credential: Credential) => FirebaseAuthTypes.AuthCredential;
+export {};

package/react-native/auth/useEmailAuthProviderCredential.js

@@ -0,0 +1,30 @@
+import { EmailAuthProvider } from "@react-native-firebase/auth";
+import { useCallback } from "react";
+/**
+ * A custom hook that returns an auth credential for email.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useEmailAuthProviderCredential();
+ *  // ...
+ *  getCredential({email, password})
+ * };
+ * ```
+ */
+export const useEmailAuthProviderCredential = () => {
+    return useCallback((credential) => {
+        if (credential.password) {
+            return EmailAuthProvider.credential(credential.email, credential.password);
+        }
+        if (credential.emailLink) {
+            return EmailAuthProvider.credentialWithLink(credential.email, credential.emailLink);
+        }
+        throw new Error("One of: password or emailLink must be provided");
+    }, []);
+};

package/react-native/auth/useEmailAuthProviderCredential.ts

@@ -0,0 +1,38 @@
+import { EmailAuthProvider, FirebaseAuthTypes } from "@react-native-firebase/auth";
+import { useCallback } from "react";
+
+type Credential = {
+    email: string;
+    password?: string;
+    emailLink?: string;
+};
+
+/**
+ * A custom hook that returns an auth credential for email.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useEmailAuthProviderCredential();
+ *  // ...
+ *  getCredential({email, password})
+ * };
+ * ```
+ */
+
+export const useEmailAuthProviderCredential = () => {
+    return useCallback((credential: Credential): FirebaseAuthTypes.AuthCredential => {
+        if (credential.password) {
+            return EmailAuthProvider.credential(credential.email, credential.password);
+        }
+        if (credential.emailLink) {
+            return EmailAuthProvider.credentialWithLink(credential.email, credential.emailLink);
+        }
+        throw new Error("One of: password or emailLink must be provided");
+    }, []);
+};

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

@@ -0,0 +1,24 @@
+import { FirebaseAuthTypes } from "@react-native-firebase/auth";
+type Credential = {
+    token: string;
+    nonce: string;
+};
+/**
+ * A custom hook that returns an auth credential for facebook.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useFacebookAuthProviderCredential();
+ *  // ...
+ *  getCredential({token, nonce})
+ * };
+ * ```
+ */
+export declare const useFacebookAuthProviderCredential: () => (credential: Credential) => FirebaseAuthTypes.AuthCredential;
+export {};

package/react-native/auth/useFacebookAuthProviderCredential.js

@@ -0,0 +1,24 @@
+import { FacebookAuthProvider } from "@react-native-firebase/auth";
+import { useCallback } from "react";
+/**
+ * A custom hook that returns an auth credential for facebook.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useFacebookAuthProviderCredential();
+ *  // ...
+ *  getCredential({token, nonce})
+ * };
+ * ```
+ */
+export const useFacebookAuthProviderCredential = () => {
+    return useCallback((credential) => {
+        return FacebookAuthProvider.credential(credential.token, credential.nonce);
+    }, []);
+};

package/react-native/auth/useFacebookAuthProviderCredential.ts

@@ -0,0 +1,31 @@
+import { FacebookAuthProvider, FirebaseAuthTypes } from "@react-native-firebase/auth";
+import { useCallback } from "react";
+
+type Credential = {
+    token: string;
+    nonce: string;
+};
+
+/**
+ * A custom hook that returns an auth credential for facebook.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useFacebookAuthProviderCredential();
+ *  // ...
+ *  getCredential({token, nonce})
+ * };
+ * ```
+ */
+
+export const useFacebookAuthProviderCredential = () => {
+    return useCallback((credential: Credential): FirebaseAuthTypes.AuthCredential => {
+        return FacebookAuthProvider.credential(credential.token, credential.nonce);
+    }, []);
+};

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

@@ -0,0 +1,14 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { FirebaseAuthTypes } from "@react-native-firebase/auth";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+export type UseLinkWitRedirectMutationVariables = {
+    user: FirebaseAuthTypes.User;
+    credential: FirebaseAuthTypes.AuthCredential;
+};
+/**
+ * Custom hook for handling linking of Firebase account to auth provider using credential
+ * This hook utilizes the `useMutation` mechanism to perform the sign-in operation.
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseLinkWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
+ * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseLinkWitRedirectMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
+ */
+export declare const useLinkWithCredentialMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseLinkWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseLinkWitRedirectMutationVariables, TContext>;

package/react-native/auth/useLinkWithCredentialMutation.js

@@ -0,0 +1,16 @@
+import { useMutation } from "@tanstack/react-query";
+import { linkWithCredential } from "@react-native-firebase/auth";
+import { LINK_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
+/**
+ * Custom hook for handling linking of Firebase account to auth provider using credential
+ * This hook utilizes the `useMutation` mechanism to perform the sign-in operation.
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseLinkWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
+ * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseLinkWitRedirectMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
+ */
+export const useLinkWithCredentialMutation = (options = {}) => {
+    return useMutation({
+        ...options,
+        mutationFn: async ({ user, credential }) => linkWithCredential(user, credential),
+        mutationKey: LINK_WITH_CREDENTIAL_MUTATION_KEY
+    });
+};

package/react-native/auth/useLinkWithCredentialMutation.ts

@@ -0,0 +1,35 @@
+import { useMutation, UseMutationOptions } from "@tanstack/react-query";
+import { linkWithCredential, FirebaseAuthTypes } from "@react-native-firebase/auth";
+
+import { LINK_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+
+export type UseLinkWitRedirectMutationVariables = {
+    user: FirebaseAuthTypes.User;
+    credential: FirebaseAuthTypes.AuthCredential;
+};
+
+/**
+ * Custom hook for handling linking of Firebase account to auth provider using credential
+ * This hook utilizes the `useMutation` mechanism to perform the sign-in operation.
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseLinkWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
+ * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseLinkWitRedirectMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
+ */
+export const useLinkWithCredentialMutation = <TContext = unknown>(
+    options: Omit<
+        UseMutationOptions<
+            FirebaseAuthTypes.UserCredential,
+            ReactNativeFirebase.NativeFirebaseError,
+            UseLinkWitRedirectMutationVariables,
+            TContext
+        >,
+        "mutationKey" | "mutationFn"
+    > = {}
+) => {
+    return useMutation({
+        ...options,
+        mutationFn: async ({ user, credential }: UseLinkWitRedirectMutationVariables) =>
+            linkWithCredential(user, credential),
+        mutationKey: LINK_WITH_CREDENTIAL_MUTATION_KEY
+    });
+};

package/react-native/firestore/useAddDocMutation.ts

@@ -72,9 +72,9 @@ export const useAddDocMutation = <AppModelType extends AppModel = AppModel, TCon
         mutationKey,
         ...options,
         mutationFn: async ({ data }) => {
-            const docRef = await addDoc<AppModelType>(collectionReference, data);
+            const docRef = await addDoc<AppModelType, AppModelType>(collectionReference, data);
             const docSnap = await getDoc(docRef);
-            return { ...docSnap.data(), uid: docRef.id } as AppModelType;
+            return { ...(docSnap.data() as AppModelType), uid: docRef.id } as AppModelType;
         }
     });
 };

package/react-native/firestore/useCountQuery.ts

@@ -73,7 +73,7 @@ export const useCountQuery = <AppModelType extends AppModel = AppModel>({
         queryFn: async () => {
             const queryToExecute = compositeFilter
                 ? query(collectionReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
-                : query(collectionReference, ...queryConstraints);
+                : query(collectionReference, ...(queryConstraints as QueryConstraint[]));
 
             const querySnapshot = await getCountFromServer(queryToExecute);
             if (querySnapshot) {

package/react-native/firestore/useInfiniteQuery.ts

@@ -96,9 +96,12 @@ export const useInfiniteQuery = <AppModelType extends AppModel = AppModel, TQuer
             const allQueryConstraints = [...queryConstraints, ...(pageParam ? [pageParam] : [])];
             const queryToExecute = compositeFilter
                 ? query(collectionReference, compositeFilter, ...(allQueryConstraints as QueryNonFilterConstraint[]))
-                : query(collectionReference, ...allQueryConstraints);
+                : query(collectionReference, ...(allQueryConstraints as QueryConstraint[]));
 
-            const querySnapshot = await getDocs(queryToExecute);
+            const querySnapshot: FirebaseFirestoreTypes.QuerySnapshot<AppModelType> = await getDocs<
+                AppModelType,
+                AppModelType
+            >(queryToExecute);
             const docs: AppModelType[] = [];
 
             if (querySnapshot) {

package/react-native/firestore/useQuery.ts

@@ -73,9 +73,9 @@ export const useQuery = <AppModelType extends AppModel = AppModel>({
         queryFn: async () => {
             const queryToExecute = compositeFilter
                 ? query(collectionReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
-                : query(collectionReference, ...queryConstraints);
+                : query(collectionReference, ...(queryConstraints as QueryConstraint[]));
 
-            const querySnapshot = await getDocs(queryToExecute);
+            const querySnapshot: FirebaseFirestoreTypes.QuerySnapshot<AppModelType> = await getDocs(queryToExecute);
             const docs: AppModelType[] = [];
 
             if (querySnapshot) {

package/web/auth/index.d.ts

@@ -12,5 +12,7 @@ export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
 export * from "./useSignInAnonymouslyMutation";
-export * from "./useAuthProvider";
-export * from "./useLinkWithRedirect";
+export * from "./useEmailAuthProviderCredential";
+export * from "./useFacebookAuthProviderCredential";
+export * from "./useAppleAuthProviderCredential";
+export * from "./useLinkWithCredentialMutation";

package/web/auth/index.js

@@ -12,5 +12,7 @@ export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
 export * from "./useSignInAnonymouslyMutation";
-export * from "./useAuthProvider";
-export * from "./useLinkWithRedirect";
+export * from "./useEmailAuthProviderCredential";
+export * from "./useFacebookAuthProviderCredential";
+export * from "./useAppleAuthProviderCredential";
+export * from "./useLinkWithCredentialMutation";

package/web/auth/index.ts

@@ -12,5 +12,7 @@ export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
 export * from "./useSignInAnonymouslyMutation";
-export * from "./useAuthProvider";
-export * from "./useLinkWithRedirect";
+export * from "./useEmailAuthProviderCredential";
+export * from "./useFacebookAuthProviderCredential";
+export * from "./useAppleAuthProviderCredential";
+export * from "./useLinkWithCredentialMutation";

package/web/auth/mutation-keys.d.ts

@@ -3,7 +3,7 @@ export declare const SEND_EMAIL_VERIFICATION_MUTATION_KEY: readonly ["FIREBASE",
 export declare const SIGN_IN_ANONYMOUSLY_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_ANONYMOUSLY_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 LINK_WITH_REDIRECT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "LINK_WITH_REDIRECT_MUTATION"];
+export declare const LINK_WITH_CREDENTIAL_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "LINK_WITH_CREDENTIAL_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/web/auth/mutation-keys.js

@@ -11,7 +11,7 @@ export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"
 ];
 export const SIGN_IN_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_WITH_REDIRECT_MUTATION"];
-export const LINK_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "LINK_WITH_REDIRECT_MUTATION"];
+export const LINK_WITH_CREDENTIAL_MUTATION_KEY = ["FIREBASE", "AUTH", "LINK_WITH_CREDENTIAL_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 = [

package/web/auth/mutation-keys.ts

@@ -11,7 +11,7 @@ export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"
 ] as const;
 export const SIGN_IN_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_WITH_REDIRECT_MUTATION"] as const;
-export const LINK_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "LINK_WITH_REDIRECT_MUTATION"] as const;
+export const LINK_WITH_CREDENTIAL_MUTATION_KEY = ["FIREBASE", "AUTH", "LINK_WITH_CREDENTIAL_MUTATION"] as const;
 export const SIGN_OUT_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_OUT"] as const;
 export const REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_REDIRECT"] as const;
 export const REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY = [

package/web/auth/useAppleAuthProviderCredential.d.ts

@@ -0,0 +1,24 @@
+import { AuthCredential } from "firebase/auth";
+type Credential = {
+    token: string;
+    nonce: string;
+};
+/**
+ * A custom hook that returns an auth credential for facebook.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useAppleAuthProviderCredential();
+ *  // ...
+ *  getCredential({token, nonce: ''})
+ * };
+ * ```
+ */
+export declare const useAppleAuthProviderCredential: () => (credential: Credential) => AuthCredential;
+export {};

package/web/auth/useAppleAuthProviderCredential.js

@@ -0,0 +1,25 @@
+import { OAuthProvider } from "firebase/auth";
+import { useCallback } from "react";
+/**
+ * A custom hook that returns an auth credential for facebook.
+ *
+ * @group Hook
+ * @param {AuthProvider} provider alas of a provider
+ *
+ * @returns {AuthCredential}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const getCredential = useAppleAuthProviderCredential();
+ *  // ...
+ *  getCredential({token, nonce: ''})
+ * };
+ * ```
+ */
+export const useAppleAuthProviderCredential = () => {
+    return useCallback((credential) => {
+        const authProvider = new OAuthProvider("apple.com");
+        return authProvider.credential({ accessToken: credential.token, rawNonce: credential.nonce });
+    }, []);
+};