@tatsuokaniwa/swr-firestore 0.1.0 → 0.2.1

package/README.md

@@ -1,7 +1,23 @@
 # swr-firestore
 
+[![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)
+
 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.
 
+Inspired by [swr-firestore-v9](https://www.npmjs.com/package/swr-firestore-v9)
+
+## Installation
+
+```bash
+# if you use NPM
+npm i --save @tatsuokaniwa/swr-firestore
+# if you use Yarn
+yarn add @tatsuokaniwa/swr-firestore
+# if you use pnpm
+pnpm i @tatsuokaniwa/swr-firestore
+```
+
 ## Usage
 
 ```tsx
@@ -179,6 +195,60 @@ const { data, error } = useDoc<Post>({
 });
 ```
 
+### `useGetDocs(params, swrOptions)`
+
+Fetch documents with firestore's [getDocs](https://firebase.google.com/docs/reference/js/firestore_.md#getdocs) function
+
+#### Parameters
+
+- `params`: KeyParams | null
+- `swrOptions`: [Options for SWR hook](https://swr.vercel.app/docs/api#options) except `fetcher`
+
+#### Return values
+
+Returns [`SWRResponse`](https://swr.vercel.app/docs/api#return-values)
+
+- `data`: data for given path's collection
+- `error`: FirestoreError | Error
+- `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)
+
+
+```ts
+import { useGetDocs } from "@tatsuokaniwa/swr-firestore";
+
+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
+
+#### Parameters
+
+- `params`: KeyParams except `where`, `orderBy`, `limit` | null
+- `swrOptions`: [Options for SWR hook](https://swr.vercel.app/docs/api#options) except `fetcher`
+
+#### Return values
+
+Returns [`SWRResponse`](https://swr.vercel.app/docs/api#return-values)
+
+- `data`: data for given path's document
+- `error`: FirestoreError | Error
+- `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)
+
+```ts
+import { useGetDoc } from "@tatsuokaniwa/swr-firestore";
+
+const { data, error } = useGetDoc<Post>({
+  path: `Posts/${postId}`,
+});
+```
+
 ## Testing
 
 Before running the test, you need to install the [Firebase tools](https://firebase.google.com/docs/cli).

package/dist/hooks/useGetDoc.d.ts

@@ -0,0 +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">>>;
+export default useGetDoc;

package/dist/hooks/useGetDocs.d.ts

@@ -0,0 +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">>>;
+export default useGetDocs;

package/dist/index.d.ts

@@ -4,5 +4,7 @@ import useCollectionCount from "./hooks/useCollectionCount";
 import useCollectionGroup from "./hooks/useCollectionGroup";
 import useCollectionGroupCount from "./hooks/useCollectionGroupCount";
 import useDoc from "./hooks/useDoc";
+import useGetDoc from "./hooks/useGetDoc";
+import useGetDocs from "./hooks/useGetDocs";
 export type { DocumentData, KeyParams };
-export { useCollection, useCollectionCount, useCollectionGroup, useCollectionGroupCount, useDoc, };
+export { useCollection, useCollectionCount, useCollectionGroup, useCollectionGroupCount, useDoc, useGetDoc, useGetDocs, };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { collection, getFirestore, query, where, orderBy, limit, onSnapshot, getCountFromServer, collectionGroup, doc } from "firebase/firestore";
+import { collection, getFirestore, query, where, orderBy, limit, onSnapshot, getCountFromServer, collectionGroup, doc, getDocFromCache, getDoc, getDocsFromCache, getDocs } from "firebase/firestore";
 import React, { createContext, useContext, useEffect, useLayoutEffect, useRef, useMemo, useCallback, useDebugValue } from "react";
 var commonjsGlobal = typeof globalThis !== "undefined" ? globalThis : typeof window !== "undefined" ? window : typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : {};
 var isArray$c = Array.isArray;
@@ -4418,10 +4418,39 @@ const useDoc = (params) => {
     return () => unsub && unsub();
   });
 };
+const useGetDoc = (params, swrOptions) => {
+  const fetcher = async (key) => {
+    const { path, ...option } = key;
+    const converter = getFirestoreConverter(option == null ? void 0 : option.parseDates);
+    const ref = doc(getFirestore(), path);
+    const getFn = option.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);
+    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)] : []);
+    }
+    const getFn = option.useOfflineCache ? getDocsFromCache : getDocs;
+    const sn = await getFn((q ?? ref).withConverter(converter));
+    return sn.docs.map((x) => x.data());
+  };
+  return useSWR(params, fetcher, swrOptions);
+};
 export {
   useCollection,
   useCollectionCount,
   useCollectionGroup,
   useCollectionGroupCount,
-  useDoc
+  useDoc,
+  useGetDoc,
+  useGetDocs
 };

package/dist/index.umd.cjs

@@ -4420,10 +4420,39 @@
       return () => unsub && unsub();
     });
   };
+  const useGetDoc = (params, swrOptions) => {
+    const fetcher = async (key) => {
+      const { path, ...option } = key;
+      const converter = getFirestoreConverter(option == null ? void 0 : option.parseDates);
+      const ref = firestore.doc(firestore.getFirestore(), path);
+      const getFn = option.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);
+      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)] : []);
+      }
+      const getFn = option.useOfflineCache ? firestore.getDocsFromCache : firestore.getDocs;
+      const sn = await getFn((q ?? ref).withConverter(converter));
+      return sn.docs.map((x) => x.data());
+    };
+    return useSWR(params, fetcher, swrOptions);
+  };
   exports2.useCollection = useCollection;
   exports2.useCollectionCount = useCollectionCount;
   exports2.useCollectionGroup = useCollectionGroup;
   exports2.useCollectionGroupCount = useCollectionGroupCount;
   exports2.useDoc = useDoc;
+  exports2.useGetDoc = useGetDoc;
+  exports2.useGetDocs = useGetDocs;
   Object.defineProperty(exports2, Symbol.toStringTag, { value: "Module" });
 });

package/dist/util/type.d.ts

@@ -8,4 +8,7 @@ export type KeyParams<T> = {
     limit?: number;
     parseDates?: Extract<keyof T, string>[];
 };
+export type GetDocKeyParams<T> = KeyParams<T> & {
+    useOfflineCache?: boolean;
+};
 export type DocumentData<T> = T & Pick<QueryDocumentSnapshot, "exists" | "id" | "ref">;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tatsuokaniwa/swr-firestore",
   "description": "React Hooks library for Firestore using SWR's subscription feature.",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/t-k/swr-firestore.git"
@@ -60,7 +60,6 @@
     "eslint": "^8.36.0",
     "eslint-plugin-react": "^7.32.2",
     "firebase": "^9.17.1",
-    "firebase-tools": "^11.24.1",
     "jsdom": "^21.1.1",
     "prettier": "^2.8.5",
     "react": "^18.2.0",