react-query-firebase 2.14.0 → 2.15.1

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

@@ -11,6 +11,7 @@ export * from "./useIdToken.js";
 export * from "./useReauthenticateWitCredentialMutation.js";
 export * from "./useReauthenticateWitRedirectMutation.js";
 export * from "./useAuthStateReady.js";
+export * from "./useSignInWithCustomToken.js";
 export * from "./useSignInAnonymouslyMutation.js";
 export * from "./useEmailAuthProviderCredential.js";
 export * from "./useFacebookAuthProviderCredential.js";

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

@@ -11,6 +11,7 @@ export * from "./useIdToken.js";
 export * from "./useReauthenticateWitCredentialMutation.js";
 export * from "./useReauthenticateWitRedirectMutation.js";
 export * from "./useAuthStateReady.js";
+export * from "./useSignInWithCustomToken.js";
 export * from "./useSignInAnonymouslyMutation.js";
 export * from "./useEmailAuthProviderCredential.js";
 export * from "./useFacebookAuthProviderCredential.js";

package/dist/react-native/auth/useSignInWithCredentialMutation.d.ts

@@ -7,7 +7,7 @@ export type UseSignInWithCredentialMutationVariables = {
 /**
  * Custom hook for handling sign in using credential
  * This hook utilizes the `useMutation` mechanism to perform the sign-in operation.
- * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, FirebaseError, UseSignInWithCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
- * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, FirebaseError, UseSignInWithCredentialMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseSignInWithCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
+ * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseSignInWithCredentialMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
  */
 export declare const useSignInWithCredentialMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseSignInWithCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseSignInWithCredentialMutationVariables, TContext>;

package/dist/react-native/auth/useSignInWithCredentialMutation.js

@@ -5,8 +5,8 @@ import { useAuth } from "./useAuth.js";
 /**
  * Custom hook for handling sign in using credential
  * This hook utilizes the `useMutation` mechanism to perform the sign-in operation.
- * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, FirebaseError, UseSignInWithCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
- * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, FirebaseError, UseSignInWithCredentialMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseSignInWithCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
+ * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseSignInWithCredentialMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
  */
 export const useSignInWithCredentialMutation = (options = {}) => {
     const auth = useAuth();

package/dist/react-native/auth/useSignInWithCustomToken.d.ts

@@ -0,0 +1,40 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { FirebaseAuthTypes } from "@react-native-firebase/auth";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+/**
+ * @inline
+ */
+export type UseSignInWithCustomTokenMutationOptions = {
+    /**
+     * Options for useMutation hook excluding mutationFn. MutationKey will be equal to reference.path by default.
+     */
+    options?: Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, {
+        customToken: string;
+    }>, "mutationFn">;
+};
+/**
+ * Executes a mutation and returns users credentials
+ *
+ * @group Hook
+ *
+ * @param {useSignInWithCustomTokenMutation} options - Configuration options for the mutation.
+ *
+ * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const {mutate} = useSignInWithCustomTokenMutation({
+ *      options: {
+ *      },
+ *  });
+ *
+ *  // ....
+ *  mutate();
+ *  // ....
+ * };
+ * ```
+ */
+export declare const useSignInWithCustomTokenMutation: ({ options }?: UseSignInWithCustomTokenMutationOptions) => import("@tanstack/react-query").UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, {
+    customToken: string;
+}, unknown>;

package/dist/react-native/auth/useSignInWithCustomToken.js

@@ -0,0 +1,35 @@
+import { useMutation } from "@tanstack/react-query";
+import { signInWithCustomToken } from "@react-native-firebase/auth";
+import { useAuth } from "./useAuth.js";
+import { SIGN_IN_ANONYMOUSLY_MUTATION_KEY } from "./mutation-keys.js";
+/**
+ * Executes a mutation and returns users credentials
+ *
+ * @group Hook
+ *
+ * @param {useSignInWithCustomTokenMutation} options - Configuration options for the mutation.
+ *
+ * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const {mutate} = useSignInWithCustomTokenMutation({
+ *      options: {
+ *      },
+ *  });
+ *
+ *  // ....
+ *  mutate();
+ *  // ....
+ * };
+ * ```
+ */
+export const useSignInWithCustomTokenMutation = ({ options = {} } = {}) => {
+    const firebaseAuth = useAuth();
+    return useMutation({
+        ...options,
+        mutationKey: SIGN_IN_ANONYMOUSLY_MUTATION_KEY,
+        mutationFn: async ({ customToken }) => signInWithCustomToken(firebaseAuth, customToken)
+    });
+};

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

@@ -12,6 +12,7 @@ export * from "./useIdToken.js";
 export * from "./useReauthenticateWitCredentialMutation.js";
 export * from "./useReauthenticateWitRedirectMutation.js";
 export * from "./useSignInAnonymouslyMutation.js";
+export * from "./useSignInWithCustomToken.js";
 export * from "./useEmailAuthProviderCredential.js";
 export * from "./useFacebookAuthProviderCredential.js";
 export * from "./useAppleAuthProviderCredential.js";

package/dist/web/auth/index.js

@@ -12,6 +12,7 @@ export * from "./useIdToken.js";
 export * from "./useReauthenticateWitCredentialMutation.js";
 export * from "./useReauthenticateWitRedirectMutation.js";
 export * from "./useSignInAnonymouslyMutation.js";
+export * from "./useSignInWithCustomToken.js";
 export * from "./useEmailAuthProviderCredential.js";
 export * from "./useFacebookAuthProviderCredential.js";
 export * from "./useAppleAuthProviderCredential.js";

package/dist/web/auth/useSignInWithCustomToken.d.ts

@@ -0,0 +1,40 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { UserCredential } from "firebase/auth";
+import { FirebaseError } from "firebase/app";
+/**
+ * @inline
+ */
+export type UseSignInWithCustomTokenMutationOptions = {
+    /**
+     * Options for useMutation hook excluding mutationFn. MutationKey will be equal to reference.path by default.
+     */
+    options?: Omit<UseMutationOptions<UserCredential, FirebaseError, {
+        customToken: string;
+    }>, "mutationFn">;
+};
+/**
+ * Executes a mutation and returns users credentials
+ *
+ * @group Hook
+ *
+ * @param {useSignInWithCustomTokenMutation} options - Configuration options for the mutation.
+ *
+ * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const {mutate} = useSignInWithCustomTokenMutation({
+ *      options: {
+ *      },
+ *  });
+ *
+ *  // ....
+ *  mutate();
+ *  // ....
+ * };
+ * ```
+ */
+export declare const useSignInWithCustomTokenMutation: ({ options }?: UseSignInWithCustomTokenMutationOptions) => import("@tanstack/react-query").UseMutationResult<UserCredential, FirebaseError, {
+    customToken: string;
+}, unknown>;

package/dist/web/auth/useSignInWithCustomToken.js

@@ -0,0 +1,35 @@
+import { useMutation } from "@tanstack/react-query";
+import { signInWithCustomToken } from "firebase/auth";
+import { useAuth } from "./useAuth.js";
+import { SIGN_IN_ANONYMOUSLY_MUTATION_KEY } from "./mutation-keys.js";
+/**
+ * Executes a mutation and returns users credentials
+ *
+ * @group Hook
+ *
+ * @param {useSignInWithCustomTokenMutation} options - Configuration options for the mutation.
+ *
+ * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const {mutate} = useSignInWithCustomTokenMutation({
+ *      options: {
+ *      },
+ *  });
+ *
+ *  // ....
+ *  mutate();
+ *  // ....
+ * };
+ * ```
+ */
+export const useSignInWithCustomTokenMutation = ({ options = {} } = {}) => {
+    const firebaseAuth = useAuth();
+    return useMutation({
+        ...options,
+        mutationKey: SIGN_IN_ANONYMOUSLY_MUTATION_KEY,
+        mutationFn: async ({ customToken }) => signInWithCustomToken(firebaseAuth, customToken)
+    });
+};

package/package.json

@@ -31,15 +31,15 @@
         "@react-native-firebase/remote-config": "^23.7.0",
         "@tanstack/react-query": "^5.90.12",
         "@types/react": "^19.2.7",
-        "eslint": "^9.39.1",
+        "eslint": "^9.39.2",
         "eslint-config-prettier": "^10.1.8",
         "eslint-plugin-import": "^2.32.0",
-        "eslint-plugin-jest": "^29.2.1",
+        "eslint-plugin-jest": "^29.5.0",
         "eslint-plugin-jsonc": "^2.21.0",
         "eslint-plugin-prettier": "^5.5.4",
         "eslint-plugin-react": "^7.37.5",
         "eslint-plugin-react-hooks": "^7.0.1",
-        "firebase": "^12.5.0",
+        "firebase": "^12.7.0",
         "husky": "^9.1.7",
         "lint-staged": "^16.2.7",
         "prettier": "^3.7.4",
@@ -48,7 +48,7 @@
         "typedoc-plugin-markdown": "^4.9.0",
         "typedoc-vitepress-theme": "^1.1.2",
         "typescript": "^5.9.3",
-        "typescript-eslint": "^8.49.0",
+        "typescript-eslint": "^8.50.0",
         "vitepress": "^1.6.4"
     },
     "homepage": "https://github.com/vpishuk/react-query-firebase",
@@ -104,5 +104,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.14.0"
+    "version": "2.15.1"
 }