react-query-firebase 1.0.2 → 1.0.4

package/src/remoteConfig/useGetValue.ts

@@ -1,7 +1,13 @@
 import { getValue } from "firebase/remote-config";
-import { useRemoteConfig } from "../useRemoteConfig";
+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: string) => {
     const remoteConfig = useRemoteConfig();
     return useMemo(() => {

package/src/remoteConfig/useRemoteConfig.ts

@@ -0,0 +1,11 @@
+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;
+};

package/dist/src/FirebaseContext.js

@@ -1,3 +0,0 @@
-"use client";
-import { createContext } from "react";
-export const FirebaseContext = createContext({});

package/dist/src/FirebaseContextProvider.d.ts

@@ -1,28 +0,0 @@
-import React, { PropsWithChildren } from "react";
-import { RemoteConfigSettings } from "firebase/remote-config";
-import { FirebaseOptions } from "firebase/app";
-type FirestorEmulatorConfig = {
-    host: string;
-    port: number;
-};
-type AuthEmulatorConfig = {
-    host: string;
-};
-type Emulators = {
-    firestore?: FirestorEmulatorConfig;
-    auth?: AuthEmulatorConfig;
-};
-type FirebaseContextProvider = PropsWithChildren & {
-    emulators?: Emulators;
-    options: FirebaseOptions;
-    authEnabled?: boolean;
-    analyticsEnabled?: boolean;
-    firestoreEnabled?: boolean;
-    remoteConfigSettings?: RemoteConfigSettings;
-    remoteConfigDefaults?: {
-        [key: string]: string | number | boolean;
-    };
-    remoteConfigEnabled?: boolean;
-};
-export declare const FirebaseContextProvider: React.FC<FirebaseContextProvider>;
-export {};

package/dist/src/useAnalytics.d.ts

@@ -1 +0,0 @@
-export declare const useAnalytics: () => import("@firebase/analytics").Analytics;

package/dist/src/useAnalytics.js

@@ -1,6 +0,0 @@
-import { useContext } from "react";
-import { FirebaseContext } from "./FirebaseContext";
-export const useAnalytics = () => {
-    const { analytics } = useContext(FirebaseContext);
-    return analytics;
-};

package/dist/src/useAuth.d.ts

@@ -1 +0,0 @@
-export declare const useAuth: () => import("firebase/auth").Auth;

package/dist/src/useAuth.js

@@ -1,6 +0,0 @@
-import { useContext } from "react";
-import { FirebaseContext } from "./FirebaseContext";
-export const useAuth = () => {
-    const { auth } = useContext(FirebaseContext);
-    return auth;
-};

package/dist/src/useFirebase.d.ts

@@ -1 +0,0 @@
-export declare const useFirebase: () => import("@firebase/app").FirebaseApp;

package/dist/src/useFirebase.js

@@ -1,6 +0,0 @@
-import { useContext } from "react";
-import { FirebaseContext } from "./FirebaseContext";
-export const useFirebase = () => {
-    const { firebase } = useContext(FirebaseContext);
-    return firebase;
-};

package/dist/src/useFirestore.d.ts

@@ -1 +0,0 @@
-export declare const useFirestore: () => import("@firebase/firestore").Firestore;

package/dist/src/useFirestore.js

@@ -1,6 +0,0 @@
-import { useContext } from "react";
-import { FirebaseContext } from "./FirebaseContext";
-export const useFirestore = () => {
-    const { firestore } = useContext(FirebaseContext);
-    return firestore;
-};

package/dist/src/useRemoteConfig.d.ts

@@ -1 +0,0 @@
-export declare const useRemoteConfig: () => import("@firebase/remote-config").RemoteConfig;

package/dist/src/useRemoteConfig.js

@@ -1,6 +0,0 @@
-import { useContext } from "react";
-import { FirebaseContext } from "./FirebaseContext";
-export const useRemoteConfig = () => {
-    const { remoteConfig } = useContext(FirebaseContext);
-    return remoteConfig;
-};

package/src/FirebaseContextProvider.tsx

@@ -1,91 +0,0 @@
-import React, { PropsWithChildren, useMemo } from "react";
-import { FirebaseContext, FirebaseContextValue } from "./FirebaseContext";
-import { connectAuthEmulator, getAuth } from "firebase/auth";
-import { getAnalytics } from "firebase/analytics";
-import { getRemoteConfig, RemoteConfigSettings } from "firebase/remote-config";
-import { connectFirestoreEmulator, getFirestore } from "firebase/firestore";
-import { FirebaseOptions, initializeApp } from "firebase/app";
-
-type FirestorEmulatorConfig = {
-    host: string;
-    port: number;
-};
-
-type AuthEmulatorConfig = {
-    host: string;
-};
-
-type Emulators = {
-    firestore?: FirestorEmulatorConfig;
-    auth?: AuthEmulatorConfig;
-};
-
-type FirebaseContextProvider = PropsWithChildren & {
-    emulators?: Emulators;
-    options: FirebaseOptions;
-    authEnabled?: boolean;
-    analyticsEnabled?: boolean;
-    firestoreEnabled?: boolean;
-    remoteConfigSettings?: RemoteConfigSettings;
-    remoteConfigDefaults?: { [key: string]: string | number | boolean };
-    remoteConfigEnabled?: boolean;
-};
-
-export const FirebaseContextProvider: React.FC<FirebaseContextProvider> = ({
-    emulators,
-    options,
-    children,
-    authEnabled = true,
-    firestoreEnabled = true,
-    analyticsEnabled = true,
-    remoteConfigEnabled = true,
-    remoteConfigSettings,
-    remoteConfigDefaults = {}
-}) => {
-    const firebase = useMemo(() => {
-        return initializeApp(options);
-    }, [options]);
-
-    const contextValue = useMemo(() => {
-        const value: Partial<FirebaseContextValue> = {};
-
-        if (firestoreEnabled) {
-            const firestore = getFirestore(firebase);
-
-            if (emulators?.firestore?.host && emulators?.firestore?.port) {
-                connectFirestoreEmulator(firestore, emulators.firestore.host, emulators.firestore.port);
-            }
-
-            value.firestore = firestore;
-        }
-
-        if (authEnabled) {
-            const auth = getAuth(firebase);
-            if (emulators?.auth?.host) {
-                connectAuthEmulator(auth, emulators?.auth?.host, {
-                    disableWarnings: true
-                });
-            }
-            value.auth = auth;
-        }
-
-        if (analyticsEnabled && options.measurementId && typeof window !== "undefined") {
-            const analytics = getAnalytics(firebase);
-            value.analytics = analytics;
-        }
-
-        if (remoteConfigEnabled && typeof window !== "undefined") {
-            const remoteConfig = getRemoteConfig(firebase);
-            if (remoteConfigSettings) {
-                remoteConfig.settings.fetchTimeoutMillis = remoteConfigSettings.fetchTimeoutMillis;
-                remoteConfig.settings.minimumFetchIntervalMillis = remoteConfigSettings.minimumFetchIntervalMillis;
-                remoteConfig.defaultConfig = remoteConfigDefaults;
-            }
-            value.remoteConfig = remoteConfig;
-        }
-
-        return { firebase, ...value };
-    }, [firebase]);
-
-    return <FirebaseContext.Provider value={contextValue}>{children}</FirebaseContext.Provider>;
-};

package/src/firestore/useUpdateDocMutation copy.ts

@@ -1,51 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import {
-    DocumentData,
-    updateDoc,
-    getDoc,
-    FirestoreDataConverter,
-    DocumentReference,
-    UpdateData
-} from "firebase/firestore";
-
-import { FirebaseError } from "firebase/app";
-import { useMemo } from "react";
-
-export type UseUpdateDocMutationValues<DbModelType> = {
-    data: UpdateData<DbModelType>;
-};
-
-export type UseUpdateDocMutationOptions<
-    AppModelType extends DocumentData = DocumentData,
-    DbModelType extends DocumentData = DocumentData,
-    TContext = unknown
-> = {
-    reference: DocumentReference<AppModelType, DbModelType>;
-    converter?: FirestoreDataConverter<AppModelType, DbModelType>;
-    options?: Omit<
-        UseMutationOptions<AppModelType, FirebaseError, UseUpdateDocMutationValues<DbModelType>, TContext>,
-        "mutationFn" | "mutationKey"
-    >;
-};
-
-export const useUpdateDocMutation = <
-    AppModelType extends DocumentData = DocumentData,
-    DbModelType extends DocumentData = DocumentData,
-    TContext = unknown
->({
-    reference,
-    converter,
-    options = {}
-}: UseUpdateDocMutationOptions<AppModelType, DbModelType, TContext>) => {
-    const mutationKey = useMemo(() => [reference.path], [reference.path]);
-
-    return useMutation({
-        ...options,
-        mutationFn: async ({ data }) => {
-            await updateDoc<AppModelType, DbModelType>(reference, data);
-            const docSnap = await getDoc(converter ? reference.withConverter(converter) : reference);
-            return docSnap.data() as AppModelType;
-        },
-        mutationKey
-    });
-};

package/src/useAnalytics.ts

@@ -1,8 +0,0 @@
-import { Context, useContext } from "react";
-
-import { FirebaseContext, FirebaseContextValue } from "./FirebaseContext";
-
-export const useAnalytics = () => {
-    const { analytics } = useContext<FirebaseContextValue>(FirebaseContext as Context<FirebaseContextValue>);
-    return analytics;
-};

package/src/useAuth.ts

@@ -1,8 +0,0 @@
-import { useContext, Context } from "react";
-
-import { FirebaseContext, FirebaseContextValue } from "./FirebaseContext";
-
-export const useAuth = () => {
-    const { auth } = useContext<FirebaseContextValue>(FirebaseContext as Context<FirebaseContextValue>);
-    return auth;
-};

package/src/useFirebase.ts

@@ -1,8 +0,0 @@
-import { Context, useContext } from "react";
-
-import { FirebaseContext, FirebaseContextValue } from "./FirebaseContext";
-
-export const useFirebase = () => {
-    const { firebase } = useContext<FirebaseContextValue>(FirebaseContext as Context<FirebaseContextValue>);
-    return firebase;
-};

package/src/useFirestore.ts

@@ -1,7 +0,0 @@
-import { Context, useContext } from "react";
-import { FirebaseContext, FirebaseContextValue } from "./FirebaseContext";
-
-export const useFirestore = () => {
-    const { firestore } = useContext<FirebaseContextValue>(FirebaseContext as Context<FirebaseContextValue>);
-    return firestore;
-};

package/src/useRemoteConfig.ts

@@ -1,7 +0,0 @@
-import { Context, useContext } from "react";
-import { FirebaseContext, FirebaseContextValue } from "./FirebaseContext";
-
-export const useRemoteConfig = () => {
-    const { remoteConfig } = useContext<FirebaseContextValue>(FirebaseContext as Context<FirebaseContextValue>);
-    return remoteConfig;
-};