@tatsuokaniwa/swr-firestore 2.0.2 → 2.0.3

package/README.md

@@ -161,14 +161,20 @@ import type {
   startAt,
   where,
 } from "firebase/firestore";
+
+type DocumentId = "id";
 // 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]][];
+      where?: [
+        Paths<T> | DocumentId,
+        Parameters<typeof where>[1],
+        ValueOf<T> | unknown
+      ][];
+      orderBy?: [Paths<T> | DocumentId, Parameters<typeof orderBy>[1]][];
       startAt?: Parameters<typeof startAt>;
       startAfter?: Parameters<typeof startAfter>;
       endAt?: Parameters<typeof endAt>;

package/dist/server/util/type.d.ts

@@ -1,8 +1,9 @@
 import type { OrderByDirection, Query, QueryDocumentSnapshot, WhereFilterOp } from "firebase-admin/firestore";
 import type { Paths, ValueOf } from "../../util/type.js";
+export type DocumentId = "id";
 export type QueryParams<T> = {
-    where?: [Paths<T>, WhereFilterOp, ValueOf<T> | unknown][];
-    orderBy?: [Paths<T>, OrderByDirection][];
+    where?: [Paths<T> | DocumentId, WhereFilterOp, ValueOf<T> | unknown][];
+    orderBy?: [Paths<T> | DocumentId, OrderByDirection][];
     startAt?: Parameters<Query["startAt"]>;
     startAfter?: Parameters<Query["startAfter"]>;
     endAt?: Parameters<Query["endAt"]>;

package/dist/util/type.d.ts

@@ -26,13 +26,18 @@ type Prev = [
     20,
     ...0[]
 ];
+export type DocumentId = "id";
 export type Paths<T, D extends number = 3> = [D] extends [never] ? never : T extends object ? {
     [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 QueryParams<T> = {
-    where?: [Paths<T>, Parameters<typeof where>[1], ValueOf<T> | unknown][];
-    orderBy?: [Paths<T>, Parameters<typeof orderBy>[1]][];
+    where?: [
+        Paths<T> | DocumentId,
+        Parameters<typeof where>[1],
+        ValueOf<T> | unknown
+    ][];
+    orderBy?: [Paths<T> | DocumentId, Parameters<typeof orderBy>[1]][];
     startAt?: Parameters<typeof startAt>;
     startAfter?: Parameters<typeof startAfter>;
     endAt?: Parameters<typeof endAt>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tatsuokaniwa/swr-firestore",
   "description": "React Hooks library for Firestore using SWR's subscription feature.",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/t-k/swr-firestore.git"
@@ -66,7 +66,7 @@
     "@types/react-dom": "^18.0.11",
     "@typescript-eslint/eslint-plugin": "^5.56.0",
     "@vitejs/plugin-react": "^4.0.0",
-    "@vitest/coverage-c8": "^0.31.0",
+    "@vitest/coverage-c8": "^0.32.0",
     "c8": "^7.13.0",
     "eslint": "^8.36.0",
     "eslint-plugin-react": "^7.32.2",
@@ -79,7 +79,7 @@
     "swr": "^2.1.0 <3.0.0",
     "typescript": "^5.0.2",
     "vite-tsconfig-paths": "^4.0.7",
-    "vitest": "^0.31.0"
+    "vitest": "^0.32.0"
   },
   "peerDependencies": {
     "firebase": "^9.11.0 < 10.0.0",