@tatsuokaniwa/swr-firestore 1.0.1 → 1.1.0

package/README.md

@@ -2,6 +2,7 @@
 
 [![npm version](https://badge.fury.io/js/@tatsuokaniwa%2Fswr-firestore.svg)](https://badge.fury.io/js/@tatsuokaniwa%2Fswr-firestore)
 [![Node.js CI](https://github.com/t-k/swr-firestore/actions/workflows/test.yaml/badge.svg)](https://github.com/t-k/swr-firestore/actions/workflows/test.yaml)
+[![codecov](https://codecov.io/gh/t-k/swr-firestore/branch/main/graph/badge.svg?token=6WREEC5HKZ)](https://codecov.io/gh/t-k/swr-firestore)
 
 React Hooks library for Firestore, built using the Firebase v9 modular SDK. It utilizes the [`useSWRSubscription`](https://swr.vercel.app/ja/docs/subscription) function from SWR library to enable subscription-based data fetching and caching.
 
@@ -39,7 +40,7 @@ export default function App() {
   const { data } = useCollection<Post>(
     isLogin
       ? {
-          path: "Posts",
+          path: "posts",
           where: [["status", "==", "published"]],
           orderBy: [["createdAt", "desc"]],
           parseDates: ["createdAt"],
@@ -47,7 +48,7 @@ export default function App() {
       : null
   );
   const { data: postCount } = useCollectionCount<Post>({
-    path: "Posts",
+    path: "posts",
     where: [["status", "==", "published"]],
   });
   return (
@@ -64,6 +65,29 @@ export default function App() {
 }
 ```
 
+### For more complex queries
+To perform complex queries like using `OR` queries or raw `QueryConstraint`, use the `queryConstraints` parameter.
+However, this method does not provide input completion for field names from type definitions.
+
+```tsx
+import {
+  or,
+  orderBy,
+  where,
+} from "firebase/firestore";
+
+useCollection<City>({
+  path: "cities",
+  queryConstraints: [
+    or(
+      where('capital', '==', true),
+      where('population', '>=', 1000000)
+    ),
+    orderBy("createdAt", "desc"),
+  ],
+})
+```
+
 ## API
 
 ```ts
@@ -74,7 +98,7 @@ import {
   useCollectionGroupCount, // Wrapper for getCountFromServer for collectionGroup
   useDoc, // Subscription for document
   useGetDocs, // Fetch documents with firestore's getDocs
-  useGetDoc, // Fetch documents with firestore's getDoc
+  useGetDoc, // Fetch document with firestore's getDoc
 } from "@tatsuokaniwa/swr-firestore";
 ```
 
@@ -83,16 +107,29 @@ import {
 ```ts
 import type { orderBy, where } from "firebase/firestore";
 // First argument of hook, specifies options to firestore, and is also used as a key for SWR.
-type KeyParams<T> = {
-  // The path to the collection or document of Firestore.
-  path: string;
-  // `Paths` means object's property path, including nested object
-  where?: [Paths<T>, Parameters<typeof where>[1], ValueOf<T> | unknown][];
-  orderBy?: [Paths<T>, Parameters<typeof orderBy>[1]][];
-  limit?: number;
-  // Array of field names that should be parsed as dates.
-  parseDates?: Paths<T>[];
-};
+type KeyParams<T> =
+  | {
+      // The path to the collection or document of Firestore.
+      path: string
+      // `Paths` means object's property path, including nested object
+      where?: [Paths<T>, Parameters<typeof where>[1], ValueOf<T> | unknown][]
+      orderBy?: [Paths<T>, Parameters<typeof orderBy>[1]][]
+      limit?: number
+      // Array of field names that should be parsed as dates.
+      parseDates?: Paths<T>[]
+    }
+  // OR for more complex query
+  | {
+      // The path to the collection or document of Firestore.
+      path: string
+      // raw query constraints from `firebase/firestore`
+      queryConstraints?:
+        | [QueryCompositeFilterConstraint, ...Array<QueryNonFilterConstraint>]
+        | QueryConstraint[]
+      // Array of field names that should be parsed as dates.
+      parseDates?: Paths<T>[]
+    }
+
 ```
 
 ### Type definitions for return data
@@ -114,7 +151,7 @@ Subscription for collection
 #### Return values
 
 - `data`: data for given path's collection
-- `error`: FirestoreError | Error
+- `error`: FirestoreError
 
 ```ts
 import { useCollection } from "@tatsuokaniwa/swr-firestore";
@@ -138,7 +175,7 @@ Wrapper for getCountFromServer for collection
 Returns [`SWRResponse`](https://swr.vercel.app/docs/api#return-values)
 
 - `data`: number for given path's collection count result
-- `error`: FirestoreError | Error
+- `error`: FirestoreError
 - `isLoading`: if there's an ongoing request and no "loaded data". Fallback data and previous data are not considered "loaded data"
 - `isValidating`: if there's a request or revalidation loading
 - `mutate(data?, options?)`: function to mutate the cached data (details)
@@ -166,7 +203,7 @@ Subscription for collectionGroup
 #### Return values
 
 - `data`: data for given path's collectionGroup
-- `error`: FirestoreError | Error
+- `error`: FirestoreError
 
 ### `useCollectionGroupCount(params, swrOptions)`
 
@@ -182,7 +219,7 @@ Wrapper for getCountFromServer for collectionGroup
 Returns [`SWRResponse`](https://swr.vercel.app/docs/api#return-values)
 
 - `data`: number for given path's collectionGroup count result
-- `error`: FirestoreError | Error
+- `error`: FirestoreError
 - `isLoading`: if there's an ongoing request and no "loaded data". Fallback data and previous data are not considered "loaded data"
 - `isValidating`: if there's a request or revalidation loading
 - `mutate(data?, options?)`: function to mutate the cached data (details)
@@ -198,7 +235,7 @@ Subscription for document
 #### Return values
 
 - `data`: data for given path's document
-- `error`: FirestoreError | Error
+- `error`: FirestoreError
 
 ```ts
 import { useDoc } from "@tatsuokaniwa/swr-firestore";
@@ -222,7 +259,7 @@ Fetch documents with firestore's [getDocs](https://firebase.google.com/docs/refe
 Returns [`SWRResponse`](https://swr.vercel.app/docs/api#return-values)
 
 - `data`: data for given path's collection
-- `error`: FirestoreError | Error
+- `error`: FirestoreError
 - `isLoading`: if there's an ongoing request and no "loaded data". Fallback data and previous data are not considered "loaded data"
 - `isValidating`: if there's a request or revalidation loading
 - `mutate(data?, options?)`: function to mutate the cached data (details)
@@ -249,7 +286,7 @@ Fetch the document with firestore's [getDoc](https://firebase.google.com/docs/re
 Returns [`SWRResponse`](https://swr.vercel.app/docs/api#return-values)
 
 - `data`: data for given path's document
-- `error`: FirestoreError | Error
+- `error`: FirestoreError
 - `isLoading`: if there's an ongoing request and no "loaded data". Fallback data and previous data are not considered "loaded data"
 - `isValidating`: if there's a request or revalidation loading
 - `mutate(data?, options?)`: function to mutate the cached data (details)

package/dist/hooks/useCollection.d.ts

@@ -1,5 +1,5 @@
 import type { SWRSubscriptionResponse } from "swr/subscription";
 import type { FirestoreError } from "firebase/firestore";
 import type { DocumentData, KeyParams } from "../util/type";
-declare const useCollection: <T>(params: KeyParams<T> | null) => SWRSubscriptionResponse<DocumentData<T>[], FirestoreError | Error>;
+declare const useCollection: <T>(params: KeyParams<T> | null) => SWRSubscriptionResponse<DocumentData<T>[], FirestoreError>;
 export default useCollection;

package/dist/hooks/useCollectionCount.d.ts

@@ -1,4 +1,4 @@
 import type { SWRHook } from "swr";
-import type { KeyParams } from "../util/type";
-declare const useCollectionCount: <T>(params: Omit<KeyParams<T>, "orderBy" | "parseDates"> | null, swrOptions?: Omit<Parameters<SWRHook>[2], "fetcher">) => import("swr/_internal").SWRResponse<number, any, Required<Omit<Partial<import("swr/_internal").PublicConfiguration<unknown, unknown, import("swr/_internal").BareFetcher<unknown>>> | undefined, "fetcher">>>;
+import type { KeyParamsForCount } from "../util/type";
+declare const useCollectionCount: <T>(params: KeyParamsForCount<T> | null, swrOptions?: Omit<Parameters<SWRHook>[2], "fetcher">) => import("swr/_internal").SWRResponse<number | undefined, any, Omit<Partial<import("swr/_internal").PublicConfiguration<unknown, unknown, import("swr/_internal").BareFetcher<unknown>>> | undefined, "fetcher"> | undefined>;
 export default useCollectionCount;

package/dist/hooks/useCollectionGroupCount.d.ts

@@ -1,4 +1,4 @@
 import type { SWRHook } from "swr";
-import type { KeyParams } from "../util/type";
-declare const useCollectionGroupCount: <T>(params: Omit<KeyParams<T>, "orderBy" | "parseDates"> | null, swrOptions?: Omit<Parameters<SWRHook>[2], "fetcher">) => import("swr/_internal").SWRResponse<number, any, Required<Omit<Partial<import("swr/_internal").PublicConfiguration<unknown, unknown, import("swr/_internal").BareFetcher<unknown>>> | undefined, "fetcher">>>;
+import type { KeyParamsForCount } from "../util/type";
+declare const useCollectionGroupCount: <T>(params: KeyParamsForCount<T> | null, swrOptions?: Omit<Parameters<SWRHook>[2], "fetcher">) => import("swr/_internal").SWRResponse<number | undefined, any, Omit<Partial<import("swr/_internal").PublicConfiguration<unknown, unknown, import("swr/_internal").BareFetcher<unknown>>> | undefined, "fetcher"> | undefined>;
 export default useCollectionGroupCount;

package/dist/hooks/useDoc.d.ts

@@ -1,5 +1,5 @@
-import { FirestoreError } from "firebase/firestore";
+import type { FirestoreError } from "firebase/firestore";
 import type { SWRSubscriptionResponse } from "swr/subscription";
 import type { DocumentData, KeyParams } from "../util/type";
-declare const useDoc: <T>(params: Omit<KeyParams<T>, "where" | "orderBy" | "limit"> | null) => SWRSubscriptionResponse<DocumentData<T>, FirestoreError>;
+declare const useDoc: <T>(params: Omit<KeyParams<T>, "orderBy" | "where" | "limit"> | null) => SWRSubscriptionResponse<DocumentData<T>, FirestoreError>;
 export default useDoc;

package/dist/hooks/useGetDoc.d.ts

@@ -1,4 +1,4 @@
 import type { SWRHook } from "swr";
 import type { DocumentData, GetDocKeyParams } from "../util/type";
-declare const useGetDoc: <T>(params: Omit<GetDocKeyParams<T>, "where" | "orderBy" | "limit"> | null, swrOptions?: Omit<Parameters<SWRHook>[2], "fetcher">) => import("swr/_internal").SWRResponse<DocumentData<T> | undefined, any, Required<Omit<Partial<import("swr/_internal").PublicConfiguration<unknown, unknown, import("swr/_internal").BareFetcher<unknown>>> | undefined, "fetcher">>>;
+declare const useGetDoc: <T>(params: Omit<GetDocKeyParams<T>, "orderBy" | "where" | "limit"> | null, swrOptions?: Omit<Parameters<SWRHook>[2], "fetcher">) => import("swr/_internal").SWRResponse<DocumentData<T> | undefined, any, Omit<Partial<import("swr/_internal").PublicConfiguration<unknown, unknown, import("swr/_internal").BareFetcher<unknown>>> | undefined, "fetcher"> | undefined>;
 export default useGetDoc;

package/dist/hooks/useGetDocs.d.ts

@@ -1,4 +1,4 @@
 import type { SWRHook } from "swr";
 import type { DocumentData, GetDocKeyParams } from "../util/type";
-declare const useGetDocs: <T>(params: GetDocKeyParams<T> | null, swrOptions?: Omit<Parameters<SWRHook>[2], "fetcher">) => import("swr/_internal").SWRResponse<DocumentData<T>[] | undefined, any, Required<Omit<Partial<import("swr/_internal").PublicConfiguration<unknown, unknown, import("swr/_internal").BareFetcher<unknown>>> | undefined, "fetcher">>>;
+declare const useGetDocs: <T>(params: GetDocKeyParams<T> | null, swrOptions?: Omit<Parameters<SWRHook>[2], "fetcher">) => import("swr/_internal").SWRResponse<DocumentData<T>[] | undefined, any, Omit<Partial<import("swr/_internal").PublicConfiguration<unknown, unknown, import("swr/_internal").BareFetcher<unknown>>> | undefined, "fetcher"> | undefined>;
 export default useGetDocs;

package/dist/index.js

@@ -24,21 +24,30 @@ const getFirestoreConverter = (parseDates) => ({
     return model;
   }
 });
+const isQueryConstraintParams = (params) => {
+  return params.queryConstraints != null;
+};
 const useCollection = (params) => {
-  return useSWRSubscription(params, (_, { next }) => {
+  let swrKey = params;
+  if (params != null && isQueryConstraintParams(params)) {
+    swrKey = JSON.parse(JSON.stringify(params));
+  }
+  return useSWRSubscription(swrKey, (_, { next }) => {
     if (params == null) {
       return () => {
       };
     }
-    const { path, ...options } = params;
-    const converter = getFirestoreConverter(options == null ? void 0 : options.parseDates);
+    const { path, parseDates } = params;
+    const converter = getFirestoreConverter(parseDates);
     const ref = collection(getFirestore(), path);
     let q;
-    if (options != null) {
-      const { where: w, orderBy: o, limit: l } = options;
+    if (isQueryConstraintParams(params)) {
+      q = query(ref, ...params.queryConstraints);
+    } else {
+      const { where: w, orderBy: o, limit: l } = params;
       q = query(ref, ...(w ? w : []).map((q2) => where(...q2)), ...(o ? o : []).map((q2) => orderBy(...q2)), ...l ? [limit(l)] : []);
     }
-    const unsub = onSnapshot((q ?? ref).withConverter(converter), (qs) => {
+    const unsub = onSnapshot(q.withConverter(converter), (qs) => {
       next(null, qs.docs.map((x) => x.data()));
     }, (error) => {
       next(error);
@@ -47,34 +56,49 @@ const useCollection = (params) => {
   });
 };
 const useCollectionCount = (params, swrOptions) => {
-  const fetcher = async (key) => {
-    const { path, ...option } = key;
+  let swrKey = params;
+  if (params != null && isQueryConstraintParams(params)) {
+    swrKey = JSON.parse(JSON.stringify(params));
+  }
+  const fetcher = async () => {
+    if (params == null) {
+      return;
+    }
+    const { path } = params;
     const ref = collection(getFirestore(), path);
     let q;
-    if (option) {
-      const { where: w, orderBy: o, limit: l } = option;
-      q = query(ref, ...(w ? w : []).map((q2) => where(...q2)), ...(o ? o : []).map((q2) => orderBy(...q2)), ...l ? [limit(l)] : []);
+    if (isQueryConstraintParams(params)) {
+      q = query(ref, ...params.queryConstraints);
+    } else {
+      const { where: w, limit: l } = params;
+      q = query(ref, ...(w ? w : []).map((q2) => where(...q2)), ...l ? [limit(l)] : []);
     }
-    const sn = await getCountFromServer(q ?? ref);
+    const sn = await getCountFromServer(q);
     return sn.data().count;
   };
-  return useSWR(params, fetcher, swrOptions);
+  return useSWR(swrKey, fetcher, swrOptions);
 };
 const useCollectionGroup = (params) => {
-  return useSWRSubscription(params, (_, { next }) => {
+  let swrKey = params;
+  if (params != null && isQueryConstraintParams(params)) {
+    swrKey = JSON.parse(JSON.stringify(params));
+  }
+  return useSWRSubscription(swrKey, (_, { next }) => {
     if (params == null) {
       return () => {
       };
     }
-    const { path, ...options } = params;
-    const converter = getFirestoreConverter(options == null ? void 0 : options.parseDates);
+    const { path, parseDates } = params;
+    const converter = getFirestoreConverter(parseDates);
     const ref = collectionGroup(getFirestore(), path);
     let q;
-    if (options != null) {
-      const { where: w, orderBy: o, limit: l } = options;
+    if (isQueryConstraintParams(params)) {
+      q = query(ref, ...params.queryConstraints);
+    } else {
+      const { where: w, orderBy: o, limit: l } = params;
       q = query(ref, ...(w ? w : []).map((q2) => where(...q2)), ...(o ? o : []).map((q2) => orderBy(...q2)), ...l ? [limit(l)] : []);
     }
-    const unsub = onSnapshot((q ?? ref).withConverter(converter), (qs) => {
+    const unsub = onSnapshot(q.withConverter(converter), (qs) => {
       next(null, qs.docs.map((x) => x.data()));
     }, (error) => {
       next(error);
@@ -83,18 +107,27 @@ const useCollectionGroup = (params) => {
   });
 };
 const useCollectionGroupCount = (params, swrOptions) => {
-  const fetcher = async (key) => {
-    const { path, ...option } = key;
+  let swrKey = params;
+  if (params != null && isQueryConstraintParams(params)) {
+    swrKey = JSON.parse(JSON.stringify(params));
+  }
+  const fetcher = async () => {
+    if (params == null) {
+      return;
+    }
+    const { path } = params;
     const ref = collectionGroup(getFirestore(), path);
     let q;
-    if (option) {
-      const { where: w, orderBy: o, limit: l } = option;
-      q = query(ref, ...(w ? w : []).map((q2) => where(...q2)), ...(o ? o : []).map((q2) => orderBy(...q2)), ...l ? [limit(l)] : []);
+    if (isQueryConstraintParams(params)) {
+      q = query(ref, ...params.queryConstraints);
+    } else {
+      const { where: w, limit: l } = params;
+      q = query(ref, ...(w ? w : []).map((q2) => where(...q2)), ...l ? [limit(l)] : []);
     }
-    const sn = await getCountFromServer(q ?? ref);
+    const sn = await getCountFromServer(q);
     return sn.data().count;
   };
-  return useSWR(params, fetcher, swrOptions);
+  return useSWR(swrKey, fetcher, swrOptions);
 };
 const useDoc = (params) => {
   return useSWRSubscription(params, (_, { next }) => {
@@ -114,31 +147,43 @@ const useDoc = (params) => {
   });
 };
 const useGetDoc = (params, swrOptions) => {
-  const fetcher = async (key) => {
-    const { path, ...option } = key;
-    const converter = getFirestoreConverter(option == null ? void 0 : option.parseDates);
+  const fetcher = async () => {
+    if (params == null) {
+      return;
+    }
+    const { path, parseDates, ...options } = params;
+    const converter = getFirestoreConverter(parseDates);
     const ref = doc(getFirestore(), path);
-    const getFn = option.useOfflineCache ? getDocFromCache : getDoc;
+    const getFn = options.useOfflineCache ? getDocFromCache : getDoc;
     const sn = await getFn(ref.withConverter(converter));
     return sn.data();
   };
   return useSWR(params, fetcher, swrOptions);
 };
 const useGetDocs = (params, swrOptions) => {
-  const fetcher = async (key) => {
-    const { path, ...option } = key;
-    const converter = getFirestoreConverter(option == null ? void 0 : option.parseDates);
+  let swrKey = params;
+  if (params != null && isQueryConstraintParams(params)) {
+    swrKey = JSON.parse(JSON.stringify(params));
+  }
+  const fetcher = async () => {
+    if (params == null) {
+      return;
+    }
+    const { path, parseDates } = params;
+    const converter = getFirestoreConverter(parseDates);
     const ref = collection(getFirestore(), path);
     let q;
-    if (option) {
-      const { where: w, orderBy: o, limit: l } = option;
+    if (isQueryConstraintParams(params)) {
+      q = query(ref, ...params.queryConstraints);
+    } else {
+      const { where: w, orderBy: o, limit: l } = params;
       q = query(ref, ...(w ? w : []).map((q2) => where(...q2)), ...(o ? o : []).map((q2) => orderBy(...q2)), ...l ? [limit(l)] : []);
     }
-    const getFn = option.useOfflineCache ? getDocsFromCache : getDocs;
-    const sn = await getFn((q ?? ref).withConverter(converter));
+    const getFn = params.useOfflineCache ? getDocsFromCache : getDocs;
+    const sn = await getFn(q.withConverter(converter));
     return sn.docs.map((x) => x.data());
   };
-  return useSWR(params, fetcher, swrOptions);
+  return useSWR(swrKey, fetcher, swrOptions);
 };
 export {
   useCollection,

package/dist/index.umd.cjs

@@ -24,21 +24,30 @@
       return model;
     }
   });
+  const isQueryConstraintParams = (params) => {
+    return params.queryConstraints != null;
+  };
   const useCollection = (params) => {
-    return useSWRSubscription(params, (_, { next }) => {
+    let swrKey = params;
+    if (params != null && isQueryConstraintParams(params)) {
+      swrKey = JSON.parse(JSON.stringify(params));
+    }
+    return useSWRSubscription(swrKey, (_, { next }) => {
       if (params == null) {
         return () => {
         };
       }
-      const { path, ...options } = params;
-      const converter = getFirestoreConverter(options == null ? void 0 : options.parseDates);
+      const { path, parseDates } = params;
+      const converter = getFirestoreConverter(parseDates);
       const ref = firestore.collection(firestore.getFirestore(), path);
       let q;
-      if (options != null) {
-        const { where: w, orderBy: o, limit: l } = options;
+      if (isQueryConstraintParams(params)) {
+        q = firestore.query(ref, ...params.queryConstraints);
+      } else {
+        const { where: w, orderBy: o, limit: l } = params;
         q = firestore.query(ref, ...(w ? w : []).map((q2) => firestore.where(...q2)), ...(o ? o : []).map((q2) => firestore.orderBy(...q2)), ...l ? [firestore.limit(l)] : []);
       }
-      const unsub = firestore.onSnapshot((q ?? ref).withConverter(converter), (qs) => {
+      const unsub = firestore.onSnapshot(q.withConverter(converter), (qs) => {
         next(null, qs.docs.map((x) => x.data()));
       }, (error) => {
         next(error);
@@ -47,34 +56,49 @@
     });
   };
   const useCollectionCount = (params, swrOptions) => {
-    const fetcher = async (key) => {
-      const { path, ...option } = key;
+    let swrKey = params;
+    if (params != null && isQueryConstraintParams(params)) {
+      swrKey = JSON.parse(JSON.stringify(params));
+    }
+    const fetcher = async () => {
+      if (params == null) {
+        return;
+      }
+      const { path } = params;
       const ref = firestore.collection(firestore.getFirestore(), path);
       let q;
-      if (option) {
-        const { where: w, orderBy: o, limit: l } = option;
-        q = firestore.query(ref, ...(w ? w : []).map((q2) => firestore.where(...q2)), ...(o ? o : []).map((q2) => firestore.orderBy(...q2)), ...l ? [firestore.limit(l)] : []);
+      if (isQueryConstraintParams(params)) {
+        q = firestore.query(ref, ...params.queryConstraints);
+      } else {
+        const { where: w, limit: l } = params;
+        q = firestore.query(ref, ...(w ? w : []).map((q2) => firestore.where(...q2)), ...l ? [firestore.limit(l)] : []);
       }
-      const sn = await firestore.getCountFromServer(q ?? ref);
+      const sn = await firestore.getCountFromServer(q);
       return sn.data().count;
     };
-    return useSWR(params, fetcher, swrOptions);
+    return useSWR(swrKey, fetcher, swrOptions);
   };
   const useCollectionGroup = (params) => {
-    return useSWRSubscription(params, (_, { next }) => {
+    let swrKey = params;
+    if (params != null && isQueryConstraintParams(params)) {
+      swrKey = JSON.parse(JSON.stringify(params));
+    }
+    return useSWRSubscription(swrKey, (_, { next }) => {
       if (params == null) {
         return () => {
         };
       }
-      const { path, ...options } = params;
-      const converter = getFirestoreConverter(options == null ? void 0 : options.parseDates);
+      const { path, parseDates } = params;
+      const converter = getFirestoreConverter(parseDates);
       const ref = firestore.collectionGroup(firestore.getFirestore(), path);
       let q;
-      if (options != null) {
-        const { where: w, orderBy: o, limit: l } = options;
+      if (isQueryConstraintParams(params)) {
+        q = firestore.query(ref, ...params.queryConstraints);
+      } else {
+        const { where: w, orderBy: o, limit: l } = params;
         q = firestore.query(ref, ...(w ? w : []).map((q2) => firestore.where(...q2)), ...(o ? o : []).map((q2) => firestore.orderBy(...q2)), ...l ? [firestore.limit(l)] : []);
       }
-      const unsub = firestore.onSnapshot((q ?? ref).withConverter(converter), (qs) => {
+      const unsub = firestore.onSnapshot(q.withConverter(converter), (qs) => {
         next(null, qs.docs.map((x) => x.data()));
       }, (error) => {
         next(error);
@@ -83,18 +107,27 @@
     });
   };
   const useCollectionGroupCount = (params, swrOptions) => {
-    const fetcher = async (key) => {
-      const { path, ...option } = key;
+    let swrKey = params;
+    if (params != null && isQueryConstraintParams(params)) {
+      swrKey = JSON.parse(JSON.stringify(params));
+    }
+    const fetcher = async () => {
+      if (params == null) {
+        return;
+      }
+      const { path } = params;
       const ref = firestore.collectionGroup(firestore.getFirestore(), path);
       let q;
-      if (option) {
-        const { where: w, orderBy: o, limit: l } = option;
-        q = firestore.query(ref, ...(w ? w : []).map((q2) => firestore.where(...q2)), ...(o ? o : []).map((q2) => firestore.orderBy(...q2)), ...l ? [firestore.limit(l)] : []);
+      if (isQueryConstraintParams(params)) {
+        q = firestore.query(ref, ...params.queryConstraints);
+      } else {
+        const { where: w, limit: l } = params;
+        q = firestore.query(ref, ...(w ? w : []).map((q2) => firestore.where(...q2)), ...l ? [firestore.limit(l)] : []);
       }
-      const sn = await firestore.getCountFromServer(q ?? ref);
+      const sn = await firestore.getCountFromServer(q);
       return sn.data().count;
     };
-    return useSWR(params, fetcher, swrOptions);
+    return useSWR(swrKey, fetcher, swrOptions);
   };
   const useDoc = (params) => {
     return useSWRSubscription(params, (_, { next }) => {
@@ -114,31 +147,43 @@
     });
   };
   const useGetDoc = (params, swrOptions) => {
-    const fetcher = async (key) => {
-      const { path, ...option } = key;
-      const converter = getFirestoreConverter(option == null ? void 0 : option.parseDates);
+    const fetcher = async () => {
+      if (params == null) {
+        return;
+      }
+      const { path, parseDates, ...options } = params;
+      const converter = getFirestoreConverter(parseDates);
       const ref = firestore.doc(firestore.getFirestore(), path);
-      const getFn = option.useOfflineCache ? firestore.getDocFromCache : firestore.getDoc;
+      const getFn = options.useOfflineCache ? firestore.getDocFromCache : firestore.getDoc;
       const sn = await getFn(ref.withConverter(converter));
       return sn.data();
     };
     return useSWR(params, fetcher, swrOptions);
   };
   const useGetDocs = (params, swrOptions) => {
-    const fetcher = async (key) => {
-      const { path, ...option } = key;
-      const converter = getFirestoreConverter(option == null ? void 0 : option.parseDates);
+    let swrKey = params;
+    if (params != null && isQueryConstraintParams(params)) {
+      swrKey = JSON.parse(JSON.stringify(params));
+    }
+    const fetcher = async () => {
+      if (params == null) {
+        return;
+      }
+      const { path, parseDates } = params;
+      const converter = getFirestoreConverter(parseDates);
       const ref = firestore.collection(firestore.getFirestore(), path);
       let q;
-      if (option) {
-        const { where: w, orderBy: o, limit: l } = option;
+      if (isQueryConstraintParams(params)) {
+        q = firestore.query(ref, ...params.queryConstraints);
+      } else {
+        const { where: w, orderBy: o, limit: l } = params;
         q = firestore.query(ref, ...(w ? w : []).map((q2) => firestore.where(...q2)), ...(o ? o : []).map((q2) => firestore.orderBy(...q2)), ...l ? [firestore.limit(l)] : []);
       }
-      const getFn = option.useOfflineCache ? firestore.getDocsFromCache : firestore.getDocs;
-      const sn = await getFn((q ?? ref).withConverter(converter));
+      const getFn = params.useOfflineCache ? firestore.getDocsFromCache : firestore.getDocs;
+      const sn = await getFn(q.withConverter(converter));
       return sn.docs.map((x) => x.data());
     };
-    return useSWR(params, fetcher, swrOptions);
+    return useSWR(swrKey, fetcher, swrOptions);
   };
   exports2.useCollection = useCollection;
   exports2.useCollectionCount = useCollectionCount;

package/dist/util/type.d.ts

@@ -1,4 +1,4 @@
-import type { orderBy, where } from "firebase/firestore";
+import type { orderBy, QueryCompositeFilterConstraint, QueryConstraint, QueryNonFilterConstraint, where } from "firebase/firestore";
 import type { QueryDocumentSnapshot } from "firebase/firestore";
 type Join<K, P> = K extends string | number ? P extends string | number ? `${K}${"" extends P ? "" : "."}${P}` : never : never;
 type Prev = [
@@ -30,13 +30,20 @@ export type Paths<T, D extends number = 3> = [D] extends [never] ? never : T ext
     [K in keyof T]-?: K extends string | number ? `${K}` | Join<K, Paths<T[K], Prev[D]>> : never;
 }[keyof T] : "";
 export type ValueOf<T> = T[keyof T];
-export type KeyParams<T> = {
-    path: string;
+export type QueryParams<T> = {
     where?: [Paths<T>, Parameters<typeof where>[1], ValueOf<T> | unknown][];
     orderBy?: [Paths<T>, Parameters<typeof orderBy>[1]][];
     limit?: number;
+};
+export type QueryConstraintParams = {
+    queryConstraints?: [QueryCompositeFilterConstraint, ...Array<QueryNonFilterConstraint>] | QueryConstraint[];
+};
+type BaseParams<T> = {
+    path: string;
     parseDates?: Paths<T>[];
 };
+export type KeyParams<T> = BaseParams<T> & (QueryParams<T> | QueryConstraintParams);
+export type KeyParamsForCount<T> = BaseParams<T> & (Omit<QueryParams<T>, "orderBy" | "parseDates"> | QueryConstraintParams);
 export type GetDocKeyParams<T> = KeyParams<T> & {
     useOfflineCache?: boolean;
 };

package/dist/util/typeGuard.d.ts

@@ -0,0 +1,5 @@
+import type { KeyParams, QueryConstraintParams } from "./type";
+export declare const isQueryConstraintParams: <T>(params: KeyParams<T>) => params is {
+    path: string;
+    parseDates?: (T extends object ? (T extends infer T_1 extends object ? { [K in keyof T_1]-?: K extends string | number ? `${K}` | (K extends infer T_2 ? T_2 extends K ? T_2 extends string | number ? (T[K] extends infer T_3 ? T_3 extends T[K] ? T_3 extends object ? (T_3 extends infer T_4 extends object ? { [K_1 in keyof T_4]-?: K_1 extends string | number ? `${K_1}` | (K_1 extends infer T_5 ? T_5 extends K_1 ? T_5 extends string | number ? (T_3[K_1] extends infer T_6 ? T_6 extends T_3[K_1] ? T_6 extends object ? (T_6 extends infer T_7 extends object ? { [K_2 in keyof T_7]-?: K_2 extends string | number ? `${K_2}` | (K_2 extends infer T_8 ? T_8 extends K_2 ? T_8 extends string | number ? (T_6[K_2] extends infer T_9 ? T_9 extends T_6[K_2] ? T_9 extends object ? (T_9 extends infer T_10 extends object ? { [K_3 in keyof T_10]-?: K_3 extends string | number ? `${K_3}` | (K_3 extends infer T_11 ? T_11 extends K_3 ? T_11 extends string | number ? never : never : never : never) : never; } : never)[keyof T_9] : "" : never : never) extends infer T_12 ? T_12 extends (T_6[K_2] extends infer T_9 ? T_9 extends T_6[K_2] ? T_9 extends object ? (T_9 extends infer T_10 extends object ? { [K_3 in keyof T_10]-?: K_3 extends string | number ? `${K_3}` | (K_3 extends infer T_11 ? T_11 extends K_3 ? T_11 extends string | number ? never : never : never : never) : never; } : never)[keyof T_9] : "" : never : never) ? T_12 extends string | number ? `${T_8}${"" extends T_12 ? T_12 & "" : "."}${T_12}` : never : never : never : never : never : never) : never; } : never)[keyof T_6] : "" : never : never) extends infer T_13 ? T_13 extends (T_3[K_1] extends infer T_6 ? T_6 extends T_3[K_1] ? T_6 extends object ? (T_6 extends infer T_7 extends object ? { [K_2 in keyof T_7]-?: K_2 extends string | number ? `${K_2}` | (K_2 extends infer T_8 ? T_8 extends K_2 ? T_8 extends string | number ? (T_6[K_2] extends infer T_9 ? T_9 extends T_6[K_2] ? T_9 extends object ? (T_9 extends infer T_10 extends object ? { [K_3 in keyof T_10]-?: K_3 extends string | number ? `${K_3}` | (K_3 extends infer T_11 ? T_11 extends K_3 ? T_11 extends string | number ? never : never : never : never) : never; } : never)[keyof T_9] : "" : never : never) extends infer T_12 ? T_12 extends (T_6[K_2] extends infer T_9 ? T_9 extends T_6[K_2] ? T_9 extends object ? (T_9 extends infer T_10 extends object ? { [K_3 in keyof T_10]-?: K_3 extends string | number ? `${K_3}` | (K_3 extends infer T_11 ? T_11 extends K_3 ? T_11 extends string | number ? never : never : never : never) : never; } : never)[keyof T_9] : "" : never : never) ? T_12 extends string | number ? `${T_8}${"" extends T_12 ? T_12 & "" : "."}${T_12}` : never : never : never : never : never : never) : never; } : never)[keyof T_6] : "" : never : never) ? T_13 extends string | number ? `${T_5}${"" extends T_13 ? T_13 & "" : "."}${T_13}` : never : never : never : never : never : never) : never; } : never)[keyof T_3] : "" : never : never) extends infer T_14 ? T_14 extends (T[K] extends infer T_3 ? T_3 extends T[K] ? T_3 extends object ? (T_3 extends infer T_4 extends object ? { [K_1 in keyof T_4]-?: K_1 extends string | number ? `${K_1}` | (K_1 extends infer T_5 ? T_5 extends K_1 ? T_5 extends string | number ? (T_3[K_1] extends infer T_6 ? T_6 extends T_3[K_1] ? T_6 extends object ? (T_6 extends infer T_7 extends object ? { [K_2 in keyof T_7]-?: K_2 extends string | number ? `${K_2}` | (K_2 extends infer T_8 ? T_8 extends K_2 ? T_8 extends string | number ? (T_6[K_2] extends infer T_9 ? T_9 extends T_6[K_2] ? T_9 extends object ? (T_9 extends infer T_10 extends object ? { [K_3 in keyof T_10]-?: K_3 extends string | number ? `${K_3}` | (K_3 extends infer T_11 ? T_11 extends K_3 ? T_11 extends string | number ? never : never : never : never) : never; } : never)[keyof T_9] : "" : never : never) extends infer T_12 ? T_12 extends (T_6[K_2] extends infer T_9 ? T_9 extends T_6[K_2] ? T_9 extends object ? (T_9 extends infer T_10 extends object ? { [K_3 in keyof T_10]-?: K_3 extends string | number ? `${K_3}` | (K_3 extends infer T_11 ? T_11 extends K_3 ? T_11 extends string | number ? never : never : never : never) : never; } : never)[keyof T_9] : "" : never : never) ? T_12 extends string | number ? `${T_8}${"" extends T_12 ? T_12 & "" : "."}${T_12}` : never : never : never : never : never : never) : never; } : never)[keyof T_6] : "" : never : never) extends infer T_13 ? T_13 extends (T_3[K_1] extends infer T_6 ? T_6 extends T_3[K_1] ? T_6 extends object ? (T_6 extends infer T_7 extends object ? { [K_2 in keyof T_7]-?: K_2 extends string | number ? `${K_2}` | (K_2 extends infer T_8 ? T_8 extends K_2 ? T_8 extends string | number ? (T_6[K_2] extends infer T_9 ? T_9 extends T_6[K_2] ? T_9 extends object ? (T_9 extends infer T_10 extends object ? { [K_3 in keyof T_10]-?: K_3 extends string | number ? `${K_3}` | (K_3 extends infer T_11 ? T_11 extends K_3 ? T_11 extends string | number ? never : never : never : never) : never; } : never)[keyof T_9] : "" : never : never) extends infer T_12 ? T_12 extends (T_6[K_2] extends infer T_9 ? T_9 extends T_6[K_2] ? T_9 extends object ? (T_9 extends infer T_10 extends object ? { [K_3 in keyof T_10]-?: K_3 extends string | number ? `${K_3}` | (K_3 extends infer T_11 ? T_11 extends K_3 ? T_11 extends string | number ? never : never : never : never) : never; } : never)[keyof T_9] : "" : never : never) ? T_12 extends string | number ? `${T_8}${"" extends T_12 ? T_12 & "" : "."}${T_12}` : never : never : never : never : never : never) : never; } : never)[keyof T_6] : "" : never : never) ? T_13 extends string | number ? `${T_5}${"" extends T_13 ? T_13 & "" : "."}${T_13}` : never : never : never : never : never : never) : never; } : never)[keyof T_3] : "" : never : never) ? T_14 extends string | number ? `${T_2}${"" extends T_14 ? T_14 & "" : "."}${T_14}` : never : never : never : never : never : never) : never; } : never)[keyof T] : "")[] | undefined;
+} & QueryConstraintParams;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tatsuokaniwa/swr-firestore",
   "description": "React Hooks library for Firestore using SWR's subscription feature.",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/t-k/swr-firestore.git"
@@ -34,7 +34,7 @@
     "build": "tsc --noEmit && vite build",
     "emulator": "firebase emulators:start --project swr-firestore-project --only firestore",
     "test": "vitest",
-    "test:ci": "firebase emulators:exec --only auth,firestore,storage 'vitest run'",
+    "test:ci": "firebase emulators:exec --only auth,firestore,storage 'vitest run --coverage'",
     "coverage": "vitest run --coverage",
     "eslint": "eslint --fix --ext .ts,.tsx .",
     "prettier": "prettier --check --write .",
@@ -60,6 +60,7 @@
     "eslint": "^8.36.0",
     "eslint-plugin-react": "^7.32.2",
     "firebase": "^9.11.0 < 10.0.0",
+    "firebase-admin": "^11.5.0",
     "jsdom": "^21.1.1",
     "prettier": "^2.8.5",
     "react": "^18.2.0",