react-query-firebase 2.4.0 → 2.5.0

package/package.json

@@ -74,5 +74,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.4.0"
+    "version": "2.5.0"
 }

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

@@ -11,3 +11,4 @@ export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
 export * from "./useAuthStateReady";
+export * from "./useSignInAnonymouslyMutation";

package/react-native/auth/index.js

@@ -11,3 +11,4 @@ export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
 export * from "./useAuthStateReady";
+export * from "./useSignInAnonymouslyMutation";

package/react-native/auth/index.ts

@@ -11,3 +11,4 @@ export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
 export * from "./useAuthStateReady";
+export * from "./useSignInAnonymouslyMutation";

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

@@ -1,5 +1,6 @@
 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_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 SIGN_OUT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_OUT"];

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

@@ -4,6 +4,7 @@ export const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"
 ];
 export const SEND_EMAIL_VERIFICATION_MUTATION_KEY = ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"];
+export const SIGN_IN_ANONYMOUSLY_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_ANONYMOUSLY_MUTATION"];
 export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "FIREBASE",
     "AUTH",

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

@@ -4,6 +4,7 @@ export const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"
 ] as const;
 export const SEND_EMAIL_VERIFICATION_MUTATION_KEY = ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"] as const;
+export const SIGN_IN_ANONYMOUSLY_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_ANONYMOUSLY_MUTATION"] as const;
 export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "FIREBASE",
     "AUTH",

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

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

package/react-native/auth/useSignInAnonymouslyMutation.js

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

package/react-native/auth/useSignInAnonymouslyMutation.ts

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

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

@@ -25,4 +25,4 @@ export type UseDocReferencesOptions<AppModelType extends AppModel = AppModel> =
  * };
  * ```
  */
-export declare const useDocReferences: <AppModelType extends AppModel = AppModel>({ references }: UseDocReferencesOptions<AppModelType>) => import("@react-native-firebase/firestore").FirebaseFirestoreTypes.DocumentReference<AppModelType>[];
+export declare const useDocReferences: <AppModelType extends AppModel = AppModel>({ references }: UseDocReferencesOptions<AppModelType>) => (import("@react-native-firebase/firestore").FirebaseFirestoreTypes.DocumentReference<AppModelType> | null)[];

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

@@ -19,4 +19,4 @@ export type GetDocRefOptions<AppModelType extends AppModel = AppModel> = {
  *
  * @returns {DocumentReference<AppModelType, AppModelType>} Returns a document reference
  */
-export declare const getDocRef: <AppModelType extends AppModel = AppModel>({ db, reference, path, pathSegments }: GetDocRefOptions<AppModelType>) => FirebaseFirestoreTypes.DocumentReference<AppModelType>;
+export declare const getDocRef: <AppModelType extends AppModel = AppModel>({ db, reference, path, pathSegments }: GetDocRefOptions<AppModelType>) => FirebaseFirestoreTypes.DocumentReference<AppModelType> | null;

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

@@ -10,8 +10,8 @@ import { doc } from "@react-native-firebase/firestore";
  * @returns {DocumentReference<AppModelType, AppModelType>} Returns a document reference
  */
 export const getDocRef = ({ db, reference, path, pathSegments }) => {
-    if (!reference && !path) {
-        throw new Error("One of the options must be provided: path or reference.");
+    if ((!reference && !path) || (reference && !path)) {
+        return null;
     }
     const docRef = !reference
         ? doc(db, path, ...(pathSegments || []))

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

@@ -29,8 +29,8 @@ export const getDocRef = <AppModelType extends AppModel = AppModel>({
     path,
     pathSegments
 }: GetDocRefOptions<AppModelType>) => {
-    if (!reference && !path) {
-        throw new Error("One of the options must be provided: path or reference.");
+    if ((!reference && !path) || (reference && !path)) {
+        return null;
     }
 
     const docRef = !reference

package/web/auth/index.d.ts

@@ -11,3 +11,4 @@ export * from "./useSignOutMutation";
 export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
+export * from "./useSignInAnonymouslyMutation";

package/web/auth/index.js

@@ -11,3 +11,4 @@ export * from "./useSignOutMutation";
 export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
+export * from "./useSignInAnonymouslyMutation";

package/web/auth/index.ts

@@ -11,3 +11,4 @@ export * from "./useSignOutMutation";
 export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
+export * from "./useSignInAnonymouslyMutation";

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

@@ -1,5 +1,6 @@
 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_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 SIGN_OUT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_OUT"];

package/web/auth/mutation-keys.js

@@ -4,6 +4,7 @@ export const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"
 ];
 export const SEND_EMAIL_VERIFICATION_MUTATION_KEY = ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"];
+export const SIGN_IN_ANONYMOUSLY_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_ANONYMOUSLY_MUTATION"];
 export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "FIREBASE",
     "AUTH",

package/web/auth/mutation-keys.ts

@@ -4,6 +4,7 @@ export const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"
 ] as const;
 export const SEND_EMAIL_VERIFICATION_MUTATION_KEY = ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"] as const;
+export const SIGN_IN_ANONYMOUSLY_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_ANONYMOUSLY_MUTATION"] as const;
 export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "FIREBASE",
     "AUTH",

package/web/auth/useSignInAnonymouslyMutation.d.ts

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

package/web/auth/useSignInAnonymouslyMutation.js

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

package/web/auth/useSignInAnonymouslyMutation.ts

@@ -0,0 +1,49 @@
+import { useMutation, UseMutationOptions } from "@tanstack/react-query";
+import { signInAnonymously, UserCredential } from "firebase/auth";
+
+import { useAuth } from "./useAuth";
+import { SIGN_IN_ANONYMOUSLY_MUTATION_KEY } from "./mutation-keys";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+
+/**
+ * @inline
+ */
+export type UseSignInAnonymouslyMutationOptions = {
+    /**
+     * Options for useMutation hook excluding mutationFn. MutationKey will be equal to reference.path by default.
+     */
+    options?: Omit<UseMutationOptions<UserCredential, ReactNativeFirebase.NativeFirebaseError, void>, "mutationFn">;
+};
+
+/**
+ * Executes a mutation and returns users credentials
+ *
+ * @group Hook
+ *
+ * @param {useSignInAnonymouslyMutation} options - Configuration options for the mutation.
+ *
+ * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const {mutate} = useSignInAnonymouslyMutation({
+ *      options: {
+ *      },
+ *  });
+ *
+ *  // ....
+ *  mutate();
+ *  // ....
+ * };
+ * ```
+ */
+export const useSignInAnonymouslyMutation = ({ options = {} }: UseSignInAnonymouslyMutationOptions = {}) => {
+    const firebaseAuth = useAuth();
+
+    return useMutation({
+        ...options,
+        mutationKey: SIGN_IN_ANONYMOUSLY_MUTATION_KEY,
+        mutationFn: async () => signInAnonymously(firebaseAuth)
+    });
+};

package/web/firestore/useDocReferences.d.ts

@@ -25,4 +25,4 @@ export type UseDocReferencesOptions<AppModelType extends AppModel = AppModel> =
  * };
  * ```
  */
-export declare const useDocReferences: <AppModelType extends AppModel = AppModel>({ references }: UseDocReferencesOptions<AppModelType>) => import("@firebase/firestore").DocumentReference<AppModelType, AppModelType>[];
+export declare const useDocReferences: <AppModelType extends AppModel = AppModel>({ references }: UseDocReferencesOptions<AppModelType>) => (import("@firebase/firestore").DocumentReference<AppModelType, AppModelType> | null)[];

package/web/firestore/utils/getDocRef.d.ts

@@ -19,4 +19,4 @@ export type GetDocRefOptions<AppModelType extends AppModel = AppModel> = {
  *
  * @returns {DocumentReference<AppModelType, AppModelType>} Returns a document reference
  */
-export declare const getDocRef: <AppModelType extends AppModel = AppModel>({ db, reference, path, pathSegments }: GetDocRefOptions<AppModelType>) => DocumentReference<AppModelType, AppModelType>;
+export declare const getDocRef: <AppModelType extends AppModel = AppModel>({ db, reference, path, pathSegments }: GetDocRefOptions<AppModelType>) => DocumentReference<AppModelType, AppModelType> | null;

package/web/firestore/utils/getDocRef.js

@@ -10,8 +10,8 @@ import { doc } from "firebase/firestore";
  * @returns {DocumentReference<AppModelType, AppModelType>} Returns a document reference
  */
 export const getDocRef = ({ db, reference, path, pathSegments }) => {
-    if (!reference && !path) {
-        throw new Error("One of the options must be provided: path or reference.");
+    if ((!reference && !path) || (reference && !path)) {
+        return null;
     }
     const docRef = !reference
         ? doc(db, path, ...(pathSegments || []))

package/web/firestore/utils/getDocRef.ts

@@ -27,17 +27,17 @@ export const getDocRef = <AppModelType extends AppModel = AppModel>({
     path,
     pathSegments
 }: GetDocRefOptions<AppModelType>) => {
-    if (!reference && !path) {
-        throw new Error("One of the options must be provided: path or reference.");
+    if ((!reference && !path) || (reference && !path)) {
+        return null;
     }
 
     const docRef = !reference
-        ? doc(db, path as string, ...(pathSegments || []))
+        ? (doc(db, path as string, ...(pathSegments || [])) as DocumentReference<AppModelType, AppModelType>)
         : reference.type === "collection"
-          ? doc(reference, path, ...(pathSegments || []))
+          ? (doc(reference, path, ...(pathSegments || [])) as DocumentReference<AppModelType, AppModelType>)
           : reference.type === "document"
-            ? doc(reference, path as string, ...(pathSegments || []))
+            ? (doc(reference, path as string, ...(pathSegments || [])) as DocumentReference<AppModelType, AppModelType>)
             : null;
 
-    return docRef as DocumentReference<AppModelType, AppModelType>;
+    return docRef;
 };