react-firebase-ql 4.1.7 → 4.2.0

package/dist/client/useCountdown.hooks.d.ts

@@ -0,0 +1,4 @@
+export declare const useCountdown: (key: string) => {
+    isActive: boolean;
+    seconds: number;
+};

package/dist/client/useCountdown.hooks.js

@@ -0,0 +1,37 @@
+"use strict";
+'use client';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCountdown = void 0;
+const react_1 = require("react");
+const useCountdown = (key) => {
+    const [remaining, setRemaining] = (0, react_1.useState)(0);
+    const [endTime, setEndTime] = (0, react_1.useState)(null);
+    (0, react_1.useEffect)(() => {
+        if (typeof window === 'undefined')
+            return;
+        const stored = window.localStorage.getItem(key);
+        setEndTime(stored ? Number(stored) : null);
+    }, [key]);
+    (0, react_1.useEffect)(() => {
+        if (!endTime) {
+            setRemaining(0);
+            return;
+        }
+        const tick = () => {
+            const diff = Math.max(0, endTime - Date.now());
+            setRemaining(diff);
+            if (diff === 0) {
+                localStorage.removeItem(key);
+            }
+        };
+        tick();
+        const interval = setInterval(tick, 1000);
+        return () => clearInterval(interval);
+    }, [endTime, key]);
+    return {
+        isActive: remaining > 0,
+        seconds: Math.ceil(remaining / 1000),
+    };
+};
+exports.useCountdown = useCountdown;
+//# sourceMappingURL=useCountdown.hooks.js.map

package/dist/client/useCountdown.hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCountdown.hooks.js","sourceRoot":"","sources":["../../src/client/useCountdown.hooks.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAC;;;AAEb,iCAA4C;AAErC,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,EAAE;IAC1C,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,IAAA,gBAAQ,EAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,IAAA,gBAAQ,EAAgB,IAAI,CAAC,CAAC;IAG5D,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,IAAI,OAAO,MAAM,KAAK,WAAW;YAAE,OAAO;QAE1C,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAChD,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAEV,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,YAAY,CAAC,CAAC,CAAC,CAAC;YAChB,OAAO;QACT,CAAC;QAED,MAAM,IAAI,GAAG,GAAG,EAAE;YAChB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAC/C,YAAY,CAAC,IAAI,CAAC,CAAC;YAEnB,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC,CAAC;QAEF,IAAI,EAAE,CAAC;QACP,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEzC,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAEnB,OAAO;QACL,QAAQ,EAAE,SAAS,GAAG,CAAC;QACvB,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;KACrC,CAAC;AACJ,CAAC,CAAC;AArCW,QAAA,YAAY,gBAqCvB"}

package/esm/client/useCountdown.hooks.js

@@ -0,0 +1,33 @@
+'use client';
+import { useEffect, useState } from "react";
+export const useCountdown = (key) => {
+    const [remaining, setRemaining] = useState(0);
+    const [endTime, setEndTime] = useState(null);
+    useEffect(() => {
+        if (typeof window === 'undefined')
+            return;
+        const stored = window.localStorage.getItem(key);
+        setEndTime(stored ? Number(stored) : null);
+    }, [key]);
+    useEffect(() => {
+        if (!endTime) {
+            setRemaining(0);
+            return;
+        }
+        const tick = () => {
+            const diff = Math.max(0, endTime - Date.now());
+            setRemaining(diff);
+            if (diff === 0) {
+                localStorage.removeItem(key);
+            }
+        };
+        tick();
+        const interval = setInterval(tick, 1000);
+        return () => clearInterval(interval);
+    }, [endTime, key]);
+    return {
+        isActive: remaining > 0,
+        seconds: Math.ceil(remaining / 1000),
+    };
+};
+//# sourceMappingURL=useCountdown.hooks.js.map

package/esm/client/useCountdown.hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCountdown.hooks.js","sourceRoot":"","sources":["../../src/client/useCountdown.hooks.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,EAAE;IAC1C,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IAG5D,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,OAAO,MAAM,KAAK,WAAW;YAAE,OAAO;QAE1C,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAChD,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAEV,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,YAAY,CAAC,CAAC,CAAC,CAAC;YAChB,OAAO;QACT,CAAC;QAED,MAAM,IAAI,GAAG,GAAG,EAAE;YAChB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAC/C,YAAY,CAAC,IAAI,CAAC,CAAC;YAEnB,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC,CAAC;QAEF,IAAI,EAAE,CAAC;QACP,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEzC,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAEnB,OAAO;QACL,QAAQ,EAAE,SAAS,GAAG,CAAC;QACvB,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;KACrC,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-firebase-ql",
-  "version": "4.1.7",
+  "version": "4.2.0",
   "description": "A React helper library that simplifies using Firebase with side effects and live queries.",
   "main": "dist/index.js",
   "module": "esm/index.js",

package/src/client/AuthProvider.provider.tsx

@@ -1,96 +1,96 @@
-'use client';
-
-import {
-  Dispatch,
-  ReactNode,
-  useReducer,
-  Context,
-  createContext,
-  useEffect,
-} from 'react';
-
-import { Auth, onAuthStateChanged } from 'firebase/auth';
-
-enum AUTHACTIONTYPE {
-    SETUID = "SETFBUSER",
-}
-
-/**
- * AUTH state maintained accross
- * all components
- */
-interface AUTHSTATE {
-    UID?: string
-}
-
-interface AUTHACTION {
-    type: AUTHACTIONTYPE,
-    payload: string | undefined
-}
-
-
-const initialAUTHState: AUTHSTATE = {}
-
-const AUTHReducer = (state: AUTHSTATE, action: AUTHACTION): AUTHSTATE => {
-  switch (action.type) {
-    case AUTHACTIONTYPE.SETUID: {
-      const nextUser = action.payload;
-
-      if (state.UID === nextUser) {
-        return state;
-      }
-
-      return {
-        ...state,
-        UID: nextUser,
-      };
-    }
-
-    default:
-      return state;
-  }
-};
-
-
-
-const initialDispatch: Dispatch<AUTHACTION> = () => {};
-
-export const AUTHContext: Context<AUTHSTATE> =
-  createContext(initialAUTHState);
-
-const AUTHDispatch: Context<Dispatch<AUTHACTION>> =
-  createContext(initialDispatch);
-
-type AUTHProviderProps = {
-  children: ReactNode;
-  auth: Auth;
-};
-
-export const AUTHProvider = ({ children, auth }: AUTHProviderProps) => {
-  const [AUTHState, dispatch] = useReducer(
-    AUTHReducer,
-    initialAUTHState
-  );
-
-  useEffect(() => {
-    const unsubscribe = onAuthStateChanged(auth, (authUser) => {
-
-      if(!authUser) return;
-
-      dispatch({
-          type: AUTHACTIONTYPE.SETUID,
-          payload: authUser.uid ?? undefined,
-        });
-      });
-
-    return () => unsubscribe();
-  }, []);
-
-  return (
-    <AUTHContext.Provider value={AUTHState}>
-      <AUTHDispatch.Provider value={dispatch}>
-        {children}
-      </AUTHDispatch.Provider>
-    </AUTHContext.Provider>
-  );
-};
+'use client';
+
+import {
+  Dispatch,
+  ReactNode,
+  useReducer,
+  Context,
+  createContext,
+  useEffect,
+} from 'react';
+
+import { Auth, onAuthStateChanged } from 'firebase/auth';
+
+enum AUTHACTIONTYPE {
+    SETUID = "SETFBUSER",
+}
+
+/**
+ * AUTH state maintained accross
+ * all components
+ */
+interface AUTHSTATE {
+    UID?: string
+}
+
+interface AUTHACTION {
+    type: AUTHACTIONTYPE,
+    payload: string | undefined
+}
+
+
+const initialAUTHState: AUTHSTATE = {}
+
+const AUTHReducer = (state: AUTHSTATE, action: AUTHACTION): AUTHSTATE => {
+  switch (action.type) {
+    case AUTHACTIONTYPE.SETUID: {
+      const nextUser = action.payload;
+
+      if (state.UID === nextUser) {
+        return state;
+      }
+
+      return {
+        ...state,
+        UID: nextUser,
+      };
+    }
+
+    default:
+      return state;
+  }
+};
+
+
+
+const initialDispatch: Dispatch<AUTHACTION> = () => {};
+
+export const AUTHContext: Context<AUTHSTATE> =
+  createContext(initialAUTHState);
+
+const AUTHDispatch: Context<Dispatch<AUTHACTION>> =
+  createContext(initialDispatch);
+
+type AUTHProviderProps = {
+  children: ReactNode;
+  auth: Auth;
+};
+
+export const AUTHProvider = ({ children, auth }: AUTHProviderProps) => {
+  const [AUTHState, dispatch] = useReducer(
+    AUTHReducer,
+    initialAUTHState
+  );
+
+  useEffect(() => {
+    const unsubscribe = onAuthStateChanged(auth, (authUser) => {
+
+      if(!authUser) return;
+
+      dispatch({
+          type: AUTHACTIONTYPE.SETUID,
+          payload: authUser.uid ?? undefined,
+        });
+      });
+
+    return () => unsubscribe();
+  }, []);
+
+  return (
+    <AUTHContext.Provider value={AUTHState}>
+      <AUTHDispatch.Provider value={dispatch}>
+        {children}
+      </AUTHDispatch.Provider>
+    </AUTHContext.Provider>
+  );
+};

package/src/client/useAuth.ts

@@ -1,14 +1,14 @@
-'use client';
-import { useEffect } from 'react';
-import { Auth, onAuthStateChanged, User } from 'firebase/auth';
-
-
-export function useAuth(auth: Auth, callback: (user: User | null)=>void) {
-  useEffect(() => {
-    const unsubscribe = onAuthStateChanged(auth, async (authUser) => {
-     callback(authUser)
-    });
-
-    return () => unsubscribe();
-  }, []);
+'use client';
+import { useEffect } from 'react';
+import { Auth, onAuthStateChanged, User } from 'firebase/auth';
+
+
+export function useAuth(auth: Auth, callback: (user: User | null)=>void) {
+  useEffect(() => {
+    const unsubscribe = onAuthStateChanged(auth, async (authUser) => {
+     callback(authUser)
+    });
+
+    return () => unsubscribe();
+  }, []);
 }

package/src/client/useCountdown.hooks.tsx

@@ -0,0 +1,42 @@
+'use client';
+
+import { useEffect, useState } from "react";
+
+export const useCountdown = (key: string) => {
+  const [remaining, setRemaining] = useState(0);
+  const [endTime, setEndTime] = useState<number | null>(null);
+
+  //  runs only on client after mount
+  useEffect(() => {
+    if (typeof window === 'undefined') return;
+
+    const stored = window.localStorage.getItem(key);
+    setEndTime(stored ? Number(stored) : null);
+  }, [key]);
+
+  useEffect(() => {
+    if (!endTime) {
+      setRemaining(0);
+      return;
+    }
+
+    const tick = () => {
+      const diff = Math.max(0, endTime - Date.now());
+      setRemaining(diff);
+
+      if (diff === 0) {
+        localStorage.removeItem(key);
+      }
+    };
+
+    tick();
+    const interval = setInterval(tick, 1000);
+
+    return () => clearInterval(interval);
+  }, [endTime, key]);
+
+  return {
+    isActive: remaining > 0,
+    seconds: Math.ceil(remaining / 1000),
+  };
+};

package/src/client/useCounter.ts

@@ -1,38 +1,38 @@
-'use client'
-
-import { BaseModel, errorLogger, whereClause } from "firebase-client-ql";
-import { Dispatch, SetStateAction, useCallback, useEffect, useState } from "react"
-
-
-// Count firestore data
-export const useCount = <T extends BaseModel >(param: {
-    model: T | any,
-    where?: whereClause[],
-}): [number, boolean, Dispatch<SetStateAction<boolean>>] => {
-
-    const [data, setData] = useState<number>(0);
-    const [loading, setLoading] = useState(true);
-
-    const fetcher = useCallback(async () => {
-        if ( !param.where) return;
-
-        try {
-            const model = param.model;
-            const found = await model.countData(param.where)
-            setData(found);
-        } catch (error) {
-            errorLogger("useCount: ", error);
-        } finally {
-            setLoading(false);
-        }
-    }, [
-        JSON.stringify(param.where),
-        loading
-    ]);
-
-    useEffect(() => {
-        fetcher();
-    }, [fetcher]);
-
-    return [data, loading, setLoading];
-}
+'use client'
+
+import { BaseModel, errorLogger, whereClause } from "firebase-client-ql";
+import { Dispatch, SetStateAction, useCallback, useEffect, useState } from "react"
+
+
+// Count firestore data
+export const useCount = <T extends BaseModel >(param: {
+    model: T | any,
+    where?: whereClause[],
+}): [number, boolean, Dispatch<SetStateAction<boolean>>] => {
+
+    const [data, setData] = useState<number>(0);
+    const [loading, setLoading] = useState(true);
+
+    const fetcher = useCallback(async () => {
+        if ( !param.where) return;
+
+        try {
+            const model = param.model;
+            const found = await model.countData(param.where)
+            setData(found);
+        } catch (error) {
+            errorLogger("useCount: ", error);
+        } finally {
+            setLoading(false);
+        }
+    }, [
+        JSON.stringify(param.where),
+        loading
+    ]);
+
+    useEffect(() => {
+        fetcher();
+    }, [fetcher]);
+
+    return [data, loading, setLoading];
+}

package/src/client/useFetch.ts

@@ -1,57 +1,57 @@
-'use client'
-
-import { BaseModel, errorLogger, whereClause } from "firebase-client-ql"
-import { Dispatch, SetStateAction, useCallback, useEffect, useState } from "react"
-
-
-// 👇 Hook is now generic
-export const useFetch = <T extends BaseModel >(param: {
-    model: T | any
-    where?: whereClause[],
-    reference?: string,
-    filter?: {
-        orderBy?: { parameter: string, direction?: 'asc' | 'desc' };
-        offset?: string;
-        limit?: number;
-    }
-}): [typeof param.model.data, boolean, Dispatch<SetStateAction<boolean>>] => {
-
-    const [data, setData] = useState<unknown>();
-    const [loading, setLoading] = useState(true);
-
-    const fetcher = useCallback(async () => {
-        if (!param.reference && !param.where) return;
-
-        try {
-            const model = param.model;
-
-            if (param.reference) {
-                const found = await model.find(param.reference);
-                if (found) setData(model.data);
-            } else if (param.where) {
-                const found = await model.findWhere({
-                    wh: param.where,
-                    lim: param.filter?.limit ?? 100,
-                    order: param.filter?.orderBy,
-                    offset: param.filter?.offset
-                });
-                setData(found);
-            }
-        } catch (error) {
-            errorLogger("useFetch: ", error);
-        } finally {
-            setLoading(false);
-        }
-    }, [
-        param.reference,
-        JSON.stringify(param.where),
-        JSON.stringify(param.filter),
-        loading
-    ]);
-
-    useEffect(() => {
-        fetcher();
-    }, [fetcher]);
-
-    return [data, loading, setLoading];
-}
+'use client'
+
+import { BaseModel, errorLogger, whereClause } from "firebase-client-ql"
+import { Dispatch, SetStateAction, useCallback, useEffect, useState } from "react"
+
+
+// 👇 Hook is now generic
+export const useFetch = <T extends BaseModel >(param: {
+    model: T | any
+    where?: whereClause[],
+    reference?: string,
+    filter?: {
+        orderBy?: { parameter: string, direction?: 'asc' | 'desc' };
+        offset?: string;
+        limit?: number;
+    }
+}): [typeof param.model.data, boolean, Dispatch<SetStateAction<boolean>>] => {
+
+    const [data, setData] = useState<unknown>();
+    const [loading, setLoading] = useState(true);
+
+    const fetcher = useCallback(async () => {
+        if (!param.reference && !param.where) return;
+
+        try {
+            const model = param.model;
+
+            if (param.reference) {
+                const found = await model.find(param.reference);
+                if (found) setData(model.data);
+            } else if (param.where) {
+                const found = await model.findWhere({
+                    wh: param.where,
+                    lim: param.filter?.limit ?? 100,
+                    order: param.filter?.orderBy,
+                    offset: param.filter?.offset
+                });
+                setData(found);
+            }
+        } catch (error) {
+            errorLogger("useFetch: ", error);
+        } finally {
+            setLoading(false);
+        }
+    }, [
+        param.reference,
+        JSON.stringify(param.where),
+        JSON.stringify(param.filter),
+        loading
+    ]);
+
+    useEffect(() => {
+        fetcher();
+    }, [fetcher]);
+
+    return [data, loading, setLoading];
+}

package/src/client/useStream.ts

@@ -1,74 +1,74 @@
-'use client';
-
-import { BaseModel, errorLogger, whereClause } from 'firebase-client-ql';
-import { useEffect, useState } from 'react';
-
-type UseStreamResult = {
-  data: any;
-  loading: boolean;
-  error: unknown;
-};
-
-export const useStream = <T extends BaseModel>(
-  param: {
-    model: any;
-    where?: whereClause[];
-    reference?: string;
-    filter?: {
-      orderBy?: { parameter: string; direction?: 'asc' | 'desc' };
-      offset?: string;
-    };
-  }
-): UseStreamResult => {
-  const [data, setData] = useState<any>();
-  const [loading, setLoading] = useState(true);
-  const [error, setError] = useState<unknown>(null);
-
-  useEffect(() => {
-    let unsubscribe: (() => void) | undefined;
-    setLoading(true);
-
-    try {
-      const { model, reference, where, filter } = param;
-
-      if (reference) {
-        unsubscribe = model.stream((result: T) => {
-          setData(result);
-          setLoading(false);
-        }, reference);
-      } 
-      else if (where) {
-        if (where.length > 0 && where.every(w => w.value === undefined)) {
-          setData([]);
-          setLoading(false);
-          return;
-        }
-
-        unsubscribe = model.streamWhere(
-          where,
-          (result: any[]) => {
-            setData(result ?? []);
-            setLoading(false);
-          },
-          100,
-          filter?.orderBy,
-          filter?.offset
-        );
-      }
-    } catch (err) {
-      errorLogger('useStream error:', err);
-      setError(err);
-      setLoading(false);
-    }
-
-    return () => {
-      if (typeof unsubscribe === 'function') unsubscribe();
-    };
-  }, [
-    JSON.stringify(param.where),
-    JSON.stringify(param.filter),
-    param.reference,
-  ]);
-
-  return { data, loading, error };
-};
+'use client';
+
+import { BaseModel, errorLogger, whereClause } from 'firebase-client-ql';
+import { useEffect, useState } from 'react';
+
+type UseStreamResult = {
+  data: any;
+  loading: boolean;
+  error: unknown;
+};
+
+export const useStream = <T extends BaseModel>(
+  param: {
+    model: any;
+    where?: whereClause[];
+    reference?: string;
+    filter?: {
+      orderBy?: { parameter: string; direction?: 'asc' | 'desc' };
+      offset?: string;
+    };
+  }
+): UseStreamResult => {
+  const [data, setData] = useState<any>();
+  const [loading, setLoading] = useState(true);
+  const [error, setError] = useState<unknown>(null);
+
+  useEffect(() => {
+    let unsubscribe: (() => void) | undefined;
+    setLoading(true);
+
+    try {
+      const { model, reference, where, filter } = param;
+
+      if (reference) {
+        unsubscribe = model.stream((result: T) => {
+          setData(result);
+          setLoading(false);
+        }, reference);
+      } 
+      else if (where) {
+        if (where.length > 0 && where.every(w => w.value === undefined)) {
+          setData([]);
+          setLoading(false);
+          return;
+        }
+
+        unsubscribe = model.streamWhere(
+          where,
+          (result: any[]) => {
+            setData(result ?? []);
+            setLoading(false);
+          },
+          100,
+          filter?.orderBy,
+          filter?.offset
+        );
+      }
+    } catch (err) {
+      errorLogger('useStream error:', err);
+      setError(err);
+      setLoading(false);
+    }
+
+    return () => {
+      if (typeof unsubscribe === 'function') unsubscribe();
+    };
+  }, [
+    JSON.stringify(param.where),
+    JSON.stringify(param.filter),
+    param.reference,
+  ]);
+
+  return { data, loading, error };
+};

package/src/index.ts

@@ -1,5 +1,5 @@
-/**
- * ⚠️ Client-only exports
- * These hooks must NOT be imported in Server Components
- */
-export * from './client';
+/**
+ * ⚠️ Client-only exports
+ * These hooks must NOT be imported in Server Components
+ */
+export * from './client';