@tatsuokaniwa/swr-firestore 0.2.2 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Tatsuo Kaniwa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -66,6 +66,18 @@ export default function App() {
 
 ## API
 
+```ts
+import {
+  useCollection, // Subscription for collection
+  useCollectionCount, // Wrapper for getCountFromServer for collection
+  useCollectionGroup, // Subscription for collectionGroup
+  useCollectionGroupCount, // Wrapper for getCountFromServer for collectionGroup
+  useDoc, // Subscription for document
+  useGetDocs, // Fetch documents with firestore's getDocs
+  useGetDoc, // Fetch documents with firestore's getDoc
+} from "@tatsuokaniwa/swr-firestore";
+```
+
 ### Type definitions for parameters
 
 ```ts
@@ -74,11 +86,12 @@ import type { orderBy, where } from "firebase/firestore";
 type KeyParams<T> = {
   // The path to the collection or document of Firestore.
   path: string;
-  where?: [Extract<keyof T, string>, Parameters<typeof where>[1], ValueOf<T>][];
-  orderBy?: [Extract<keyof T, string>, Parameters<typeof orderBy>[1]][];
+  // `Paths` means object's property path, including nested object
+  where?: [Paths<T>, Parameters<typeof where>[1], ValueOf<T>][];
+  orderBy?: [Paths<T>, Parameters<typeof orderBy>[1]][];
   limit?: number;
   // Array of field names that should be parsed as dates.
-  parseDates?: Extract<keyof T, string>[];
+  parseDates?: Paths<T>[];
 };
 ```
 
@@ -214,7 +227,6 @@ Returns [`SWRResponse`](https://swr.vercel.app/docs/api#return-values)
 - `isValidating`: if there's a request or revalidation loading
 - `mutate(data?, options?)`: function to mutate the cached data (details)
 
-
 ```ts
 import { useGetDocs } from "@tatsuokaniwa/swr-firestore";
 
@@ -222,6 +234,7 @@ const { data, error } = useGetDocs<Post>({
   path: `Posts`,
 });
 ```
+
 ### `useGetDoc(params, swrOptions)`
 
 Fetch the document with firestore's [getDoc](https://firebase.google.com/docs/reference/js/firestore_.md#getdoc) function