react-query-firebase 2.0.3 → 2.1.1

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

@@ -1,20 +0,0 @@
-import { DocumentData } from "firebase/firestore";
-import { GetDocRefOptions } from "./getDocRef";
-export type GetDocSnapOptions<AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData> = GetDocRefOptions<AppModelType, DbModelType>;
-/**
- * Asynchronously retrieves a document snapshot from Firestore using a specified document reference
- * or path information. This function handles getting the appropriate document reference based on
- * the parameters provided, and then fetches the document data from Firestore.
- *
- * @param {GetDocSnapOptions<AppModelType, DbModelType>} options - An object containing options
- *                                                                for retrieving the document
- *                                                                snapshot.
- * @param {DocumentData} options.db - The Firestore database instance to perform the operation on.
- * @param {string} options.reference - A string representing a direct Firestore document reference.
- * @param {string} options.path - A Firestore path string leading to the document.
- * @param {string[]} options.pathSegments - An array of path segments to build the Firestore path.
- * @returns {Promise<DocumentData | null>} A promise that resolves to the document data if the
- *                                         document exists, or `null` if the document does not exist
- *                                         or if the reference could not be obtained.
- */
-export declare const getDocSnap: <AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData>({ db, reference, path, pathSegments }: GetDocSnapOptions<AppModelType, DbModelType>) => Promise<import("@firebase/firestore").DocumentSnapshot<AppModelType, DbModelType> | null>;

package/web/firestore/utils/getDocSnap.js

@@ -1,25 +0,0 @@
-import { getDoc as firestoreGetDoc } from "firebase/firestore";
-import { getDocRef } from "./getDocRef";
-/**
- * Asynchronously retrieves a document snapshot from Firestore using a specified document reference
- * or path information. This function handles getting the appropriate document reference based on
- * the parameters provided, and then fetches the document data from Firestore.
- *
- * @param {GetDocSnapOptions<AppModelType, DbModelType>} options - An object containing options
- *                                                                for retrieving the document
- *                                                                snapshot.
- * @param {DocumentData} options.db - The Firestore database instance to perform the operation on.
- * @param {string} options.reference - A string representing a direct Firestore document reference.
- * @param {string} options.path - A Firestore path string leading to the document.
- * @param {string[]} options.pathSegments - An array of path segments to build the Firestore path.
- * @returns {Promise<DocumentData | null>} A promise that resolves to the document data if the
- *                                         document exists, or `null` if the document does not exist
- *                                         or if the reference could not be obtained.
- */
-export const getDocSnap = async ({ db, reference, path, pathSegments }) => {
-    const docRef = await getDocRef({ db, reference, path, pathSegments });
-    if (docRef) {
-        return await firestoreGetDoc(docRef);
-    }
-    return null;
-};

package/web/remoteConfig/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./useFetchAndActivate";
-export * from "./useGetValue";
-export * from "./useRemoteConfig";

package/web/remoteConfig/index.js

@@ -1,3 +0,0 @@
-export * from "./useFetchAndActivate";
-export * from "./useGetValue";
-export * from "./useRemoteConfig";

package/web/remoteConfig/useFetchAndActivate.d.ts

@@ -1,11 +0,0 @@
-/**
- * Custom hook to fetch and activate remote configuration settings.
- * Initializes remote configuration, fetches, activates it, and tracks the fetch status.
- * @returns {Object} An object containing:
- * - {Function} fetchAndActivate - Callback function to fetch and activate remote configuration.
- * - {Boolean} isFetched - Boolean representing whether the fetch-and-activate process completed.
- */
-export declare const useFetchAndActivate: () => {
-    fetchAndActivate: () => Promise<void>;
-    isFetched: boolean;
-};

package/web/remoteConfig/useFetchAndActivate.js

@@ -1,31 +0,0 @@
-import { useRemoteConfig } from "./useRemoteConfig";
-import { ensureInitialized, fetchAndActivate } from "firebase/remote-config";
-import { useCallback, useMemo, useState } from "react";
-/**
- * Custom hook to fetch and activate remote configuration settings.
- * Initializes remote configuration, fetches, activates it, and tracks the fetch status.
- * @returns {Object} An object containing:
- * - {Function} fetchAndActivate - Callback function to fetch and activate remote configuration.
- * - {Boolean} isFetched - Boolean representing whether the fetch-and-activate process completed.
- */
-export const useFetchAndActivate = () => {
-    const remoteConfig = useRemoteConfig();
-    const [isFetched, setIsFetched] = useState(false);
-    const fetchAndActivateCallback = useCallback(async () => {
-        try {
-            if (remoteConfig) {
-                await ensureInitialized(remoteConfig);
-                await fetchAndActivate(remoteConfig);
-                setIsFetched(true);
-            }
-        }
-        catch (e) {
-            setIsFetched(true);
-            console.log(`Cannot read remote config: ${e?.message}`);
-        }
-    }, [remoteConfig]);
-    return useMemo(() => ({
-        fetchAndActivate: fetchAndActivateCallback,
-        isFetched
-    }), [isFetched, fetchAndActivateCallback]);
-};

package/web/remoteConfig/useGetValue.d.ts

@@ -1,7 +0,0 @@
-/**
- * Custom hook to retrieve a value associated with a specified key from remote configuration.
- * Utilizes memoization to optimize performance by recalculating the result only if dependencies change.
- * @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;

package/web/remoteConfig/useGetValue.js

@@ -1,15 +0,0 @@
-import { getValue } from "firebase/remote-config";
-import { useRemoteConfig } from "./useRemoteConfig";
-import { useMemo } from "react";
-/**
- * Custom hook to retrieve a value associated with a specified key from remote configuration.
- * Utilizes memoization to optimize performance by recalculating the result only if dependencies change.
- * @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 const useGetValue = (key) => {
-    const remoteConfig = useRemoteConfig();
-    return useMemo(() => {
-        return remoteConfig ? getValue(remoteConfig, key) : null;
-    }, [key, remoteConfig]);
-};

package/web/remoteConfig/useRemoteConfig.d.ts

@@ -1,5 +0,0 @@
-/**
- * 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;

package/web/remoteConfig/useRemoteConfig.js

@@ -1,10 +0,0 @@
-import { useContext } from "react";
-import { FirebaseContext } from "../context/FirebaseContext";
-/**
- * Hook to access the Firebase Remote Config instance from the context.
- * @returns {RemoteConfig} The remoteConfig object from the Firebase context.
- */
-export const useRemoteConfig = () => {
-    const { remoteConfig } = useContext(FirebaseContext);
-    return remoteConfig;
-};