react-query-firebase 2.12.1 → 2.13.1

package/package.json

@@ -21,25 +21,25 @@
     },
     "description": "This module offers react hooks to work with Firebase on react-native and web platforms",
     "devDependencies": {
-        "@laverve/eslint-utils": "^5.3.1",
-        "@react-native-firebase/analytics": "^23.0.1",
-        "@react-native-firebase/app": "23.0.1",
-        "@react-native-firebase/auth": "^23.0.1",
-        "@react-native-firebase/crashlytics": "^23.0.1",
-        "@react-native-firebase/firestore": "^23.0.1",
-        "@react-native-firebase/installations": "^23.0.1",
-        "@react-native-firebase/remote-config": "^23.0.1",
-        "@tanstack/react-query": "^5.85.3",
-        "@types/react": "^19.1.10",
-        "firebase": "^12.1.0",
+        "@laverve/eslint-utils": "^5.3.7",
+        "@react-native-firebase/analytics": "^23.4.1",
+        "@react-native-firebase/app": "^23.4.1",
+        "@react-native-firebase/auth": "^23.4.1",
+        "@react-native-firebase/crashlytics": "^23.4.1",
+        "@react-native-firebase/firestore": "^23.4.1",
+        "@react-native-firebase/installations": "^23.4.1",
+        "@react-native-firebase/remote-config": "^23.4.1",
+        "@tanstack/react-query": "^5.90.5",
+        "@types/react": "^19.2.2",
+        "firebase": "^12.4.0",
         "husky": "^9.1.7",
-        "lint-staged": "^16.1.5",
+        "lint-staged": "^16.2.6",
         "prettier": "^3.6.2",
-        "react": "^19.1.1",
-        "typedoc": "^0.28.10",
-        "typedoc-plugin-markdown": "^4.8.1",
+        "react": "^19.2.0",
+        "typedoc": "^0.28.14",
+        "typedoc-plugin-markdown": "^4.9.0",
         "typedoc-vitepress-theme": "^1.1.2",
-        "typescript": "^5.9.2",
+        "typescript": "^5.9.3",
         "vitepress": "^1.6.4"
     },
     "homepage": "https://github.com/vpishuk/react-query-firebase",
@@ -75,5 +75,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.12.1"
+    "version": "2.13.1"
 }

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

@@ -117,6 +117,12 @@ export type FirebaseContextProviderProps = PropsWithChildren & {
      * @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.

package/react-native/context/FirebaseContextProvider.tsx

@@ -128,6 +128,12 @@ export type FirebaseContextProviderProps = PropsWithChildren & {
      * @defaultValue `true`
      */
     remoteConfigEnabled?: boolean;
+    /**
+     * Firebase persistence type
+     * Applicable only for web version. Unsupported in native.
+     * @defaultValue 'LOCAL'
+     */
+    authPersistenceType?: "SESSION" | "LOCAL" | "NONE" | "COOKIE";
 };
 
 /**

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

@@ -28,9 +28,9 @@ export const buildQueryConstraint = (constraint) => {
         case "startAfter":
             return startAfter(...constraint.arguments);
         case "endAt":
-            return endAt(constraint.value, constraint.key);
+            return endAt(...constraint.arguments);
         case "endBefore":
-            return endBefore(constraint.value, constraint.key);
+            return endBefore(...constraint.arguments);
         case "limit":
             return limit(constraint.limit);
         case "limitToLast":

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

@@ -41,9 +41,9 @@ export const buildQueryConstraint = <AppModelType extends AppModel = AppModel>(
         case "startAfter":
             return startAfter(...constraint.arguments);
         case "endAt":
-            return endAt(constraint.value, constraint.key);
+            return endAt(...constraint.arguments);
         case "endBefore":
-            return endBefore(constraint.value, constraint.key);
+            return endBefore(...constraint.arguments);
         case "limit":
             return limit(constraint.limit);
         case "limitToLast":

package/types/QueryConstraints.d.ts

@@ -31,8 +31,7 @@ export type StartConstraint = {
  */
 export type EndConstraint = {
     type: "endAt" | "endBefore";
-    value: number | string | boolean | null;
-    key?: string;
+    arguments: unknown[];
 };
 /**
  * Limit constraint

package/types/QueryConstraints.ts

@@ -34,8 +34,7 @@ export type StartConstraint = {
  */
 export type EndConstraint = {
     type: "endAt" | "endBefore";
-    value: number | string | boolean | null;
-    key?: string;
+    arguments: unknown[];
 };
 
 /**

package/web/context/FirebaseContextProvider.d.ts

@@ -100,6 +100,11 @@ export type FirebaseContextProviderProps = PropsWithChildren & {
      * @defaultValue `true`
      */
     remoteConfigEnabled?: boolean;
+    /**
+     * Firebase persistence type
+     * @defaultValue 'LOCAL'
+     */
+    authPersistenceType?: "SESSION" | "LOCAL" | "NONE" | "COOKIE";
 };
 /**
  * FirebaseContextProvider component configures and provides Firebase services to its children.

package/web/context/FirebaseContextProvider.js

@@ -1,6 +1,6 @@
 import React, { useEffect, useMemo } from "react";
 import { FirebaseContext } from "./FirebaseContext";
-import { connectAuthEmulator, getAuth } from "firebase/auth";
+import { browserLocalPersistence, browserSessionPersistence, connectAuthEmulator, getAuth, setPersistence } from "firebase/auth";
 import { getAnalytics, setAnalyticsCollectionEnabled, setConsent } from "firebase/analytics";
 import { getRemoteConfig } from "firebase/remote-config";
 import { connectFirestoreEmulator, initializeFirestore } from "firebase/firestore";
@@ -28,7 +28,7 @@ import { initializeApp } from "firebase/app";
  * };
  * ```
  */
-export const FirebaseContextProvider = ({ emulators, options, children, authEnabled = true, firestoreEnabled = true, analyticsEnabled = true, consentSettings = {}, remoteConfigEnabled = true, remoteConfigSettings, remoteConfigDefaults = {}, firestoreSettings }) => {
+export const FirebaseContextProvider = ({ emulators, options, children, authEnabled = true, firestoreEnabled = true, analyticsEnabled = true, consentSettings = {}, remoteConfigEnabled = true, remoteConfigSettings, remoteConfigDefaults = {}, firestoreSettings, authPersistenceType }) => {
     const firebase = useMemo(() => {
         return initializeApp(options);
     }, [options]);
@@ -54,6 +54,18 @@ export const FirebaseContextProvider = ({ emulators, options, children, authEnab
         }
         return null;
     }, [firestoreSettings, emulators?.firestore, firestoreEnabled, firebase]);
+    const authPersistence = useMemo(() => {
+        switch (authPersistenceType) {
+            case "NONE":
+            case "COOKIE":
+                return { type: "NONE" };
+            case "SESSION":
+                return browserSessionPersistence;
+            default:
+            case "LOCAL":
+                return browserLocalPersistence;
+        }
+    }, [authPersistenceType]);
     const auth = useMemo(() => {
         if (authEnabled) {
             const localAuth = getAuth(firebase);
@@ -66,6 +78,11 @@ export const FirebaseContextProvider = ({ emulators, options, children, authEnab
         }
         return null;
     }, [emulators?.auth, authEnabled, firebase]);
+    useEffect(() => {
+        if (authPersistence && auth) {
+            setPersistence(auth, authPersistence);
+        }
+    }, [auth, authPersistence]);
     const analytics = useMemo(() => {
         if (analyticsEnabled && options.measurementId && typeof window !== "undefined") {
             return getAnalytics(firebase);

package/web/context/FirebaseContextProvider.tsx

@@ -1,6 +1,13 @@
 import React, { PropsWithChildren, useEffect, useMemo } from "react";
 import { FirebaseContext } from "./FirebaseContext";
-import { connectAuthEmulator, getAuth } from "firebase/auth";
+import {
+    browserLocalPersistence,
+    browserSessionPersistence,
+    connectAuthEmulator,
+    getAuth,
+    Persistence,
+    setPersistence
+} from "firebase/auth";
 import { ConsentSettings, getAnalytics, setAnalyticsCollectionEnabled, setConsent } from "firebase/analytics";
 import { getRemoteConfig, RemoteConfigSettings } from "firebase/remote-config";
 import { connectFirestoreEmulator, FirestoreSettings, initializeFirestore } from "firebase/firestore";
@@ -104,6 +111,11 @@ export type FirebaseContextProviderProps = PropsWithChildren & {
      * @defaultValue `true`
      */
     remoteConfigEnabled?: boolean;
+    /**
+     * Firebase persistence type
+     * @defaultValue 'LOCAL'
+     */
+    authPersistenceType?: "SESSION" | "LOCAL" | "NONE" | "COOKIE";
 };
 
 /**
@@ -140,7 +152,8 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
     remoteConfigEnabled = true,
     remoteConfigSettings,
     remoteConfigDefaults = {},
-    firestoreSettings
+    firestoreSettings,
+    authPersistenceType
 }) => {
     const firebase = useMemo(() => {
         return initializeApp(options);
@@ -173,6 +186,19 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
         return null;
     }, [firestoreSettings, emulators?.firestore, firestoreEnabled, firebase]);
 
+    const authPersistence = useMemo(() => {
+        switch (authPersistenceType) {
+            case "NONE":
+            case "COOKIE":
+                return { type: "NONE" } as Persistence;
+            case "SESSION":
+                return browserSessionPersistence;
+            default:
+            case "LOCAL":
+                return browserLocalPersistence;
+        }
+    }, [authPersistenceType]);
+
     const auth = useMemo(() => {
         if (authEnabled) {
             const localAuth = getAuth(firebase);
@@ -186,6 +212,12 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
         return null;
     }, [emulators?.auth, authEnabled, firebase]);
 
+    useEffect(() => {
+        if (authPersistence && auth) {
+            setPersistence(auth, authPersistence);
+        }
+    }, [auth, authPersistence]);
+
     const analytics = useMemo(() => {
         if (analyticsEnabled && options.measurementId && typeof window !== "undefined") {
             return getAnalytics(firebase);

package/web/firestore/useCompositeFilter.d.ts

@@ -34,4 +34,4 @@ export type UseCompositeFilter<AppModelType extends AppModel = AppModel> = {
  * };
  * ```
  */
-export declare const useCompositeFilter: <AppModelType extends AppModel = AppModel>({ query }: UseCompositeFilter<AppModelType>) => import("@firebase/firestore").QueryCompositeFilterConstraint | undefined;
+export declare const useCompositeFilter: <AppModelType extends AppModel = AppModel>({ query }: UseCompositeFilter<AppModelType>) => import("firebase/firestore").QueryCompositeFilterConstraint | undefined;

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> | null)[];
+export declare const useDocReferences: <AppModelType extends AppModel = AppModel>({ references }: UseDocReferencesOptions<AppModelType>) => (import("firebase/firestore").DocumentReference<AppModelType, AppModelType> | null)[];

package/web/firestore/useFirestore.d.ts

@@ -5,4 +5,4 @@
  *
  * @returns {Firestore}
  */
-export declare const useFirestore: () => import("@firebase/firestore").Firestore;
+export declare const useFirestore: () => import("firebase/firestore").Firestore;

package/web/firestore/utils/buildQueryConstraint.js

@@ -28,9 +28,9 @@ export const buildQueryConstraint = (constraint) => {
         case "startAfter":
             return startAfter(...constraint.arguments);
         case "endAt":
-            return endAt(constraint.value, constraint.key);
+            return endAt(...constraint.arguments);
         case "endBefore":
-            return endBefore(constraint.value, constraint.key);
+            return endBefore(...constraint.arguments);
         case "limit":
             return limit(constraint.limit);
         case "limitToLast":

package/web/firestore/utils/buildQueryConstraint.ts

@@ -42,9 +42,9 @@ export const buildQueryConstraint = <AppModelType extends AppModel = AppModel>(
         case "startAfter":
             return startAfter(...constraint.arguments);
         case "endAt":
-            return endAt(constraint.value, constraint.key);
+            return endAt(...constraint.arguments);
         case "endBefore":
-            return endBefore(constraint.value, constraint.key);
+            return endBefore(...constraint.arguments);
         case "limit":
             return limit(constraint.limit);
         case "limitToLast":

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

@@ -15,4 +15,4 @@ export type GetDocSnapOptions<AppModelType extends AppModel = AppModel> = GetDoc
  *
  * @returns {Promise<DocumentSnapshot<AppModelType, AppModelType> | null>} Returns a document reference
  */
-export declare const getDocSnap: <AppModelType extends AppModel = AppModel>({ db, reference, path, pathSegments }: GetDocSnapOptions<AppModelType>) => Promise<import("@firebase/firestore").DocumentSnapshot<AppModelType, AppModelType> | null>;
+export declare const getDocSnap: <AppModelType extends AppModel = AppModel>({ db, reference, path, pathSegments }: GetDocSnapOptions<AppModelType>) => Promise<import("firebase/firestore").DocumentSnapshot<AppModelType, AppModelType> | null>;

package/web/remoteConfig/useGetValue.d.ts

@@ -4,4 +4,4 @@
  * @param {string} key - The key for which the corresponding value is to be fetched from the remote configuration.
  * @returns {any | null} The value associated with the specified key if available, otherwise null.
  */
-export declare const useGetValue: (key: string) => import("@firebase/remote-config").Value | null;
+export declare const useGetValue: (key: string) => import("firebase/remote-config").Value | null;

package/web/remoteConfig/useRemoteConfig.d.ts

@@ -2,4 +2,4 @@
  * Hook to access the Firebase Remote Config instance from the context.
  * @returns {RemoteConfig} The remoteConfig object from the Firebase context.
  */
-export declare const useRemoteConfig: () => import("@firebase/remote-config").RemoteConfig;
+export declare const useRemoteConfig: () => import("firebase/remote-config").RemoteConfig;