Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/react/src/firestore/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ export { useDocumentQuery } from "./useDocumentQuery";
export { useCollectionQuery } from "./useCollectionQuery";
// useGetCountFromServerQuery
// useGetAggregateFromServerQuery
// useNamedQuery
export { useNamedQuery } from "./useNamedQuery";
35 changes: 35 additions & 0 deletions packages/react/src/firestore/useNamedQuery.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import React, { type ReactNode } from "react";
import { describe, expect, test, beforeEach } from "vitest";
import { useNamedQuery } from "./useNamedQuery";
import { renderHook, waitFor } from "@testing-library/react";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";

import { firestore, wipeFirestore } from "~/testing-utils";

const queryClient = new QueryClient({
defaultOptions: {
queries: {
retry: false,
},
},
});

const wrapper = ({ children }: { children: ReactNode }) => (
<QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
);

describe("useNamedQuery", () => {
beforeEach(async () => await wipeFirestore());

test("returns correct data for an existing named query", async () => {
const { result } = renderHook(
() =>
useNamedQuery(firestore, "emptyCollectionQuery", {
queryKey: ["named", "empty"],
}),
{ wrapper }
);

await waitFor(async () => {});
});
});
27 changes: 27 additions & 0 deletions packages/react/src/firestore/useNamedQuery.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { useQuery, type UseQueryOptions } from "@tanstack/react-query";
import {
type FirestoreError,
type Query,
type DocumentData,
namedQuery,
type Firestore,
} from "firebase/firestore";

type FirestoreUseQueryOptions<TData = unknown, TError = Error> = Omit<
UseQueryOptions<TData, TError>,
"queryFn"
>;

export function useNamedQuery<
AppModelType = DocumentData,
DbModelType extends DocumentData = DocumentData
>(
firestore: Firestore,
name: string,
options: FirestoreUseQueryOptions<Query | null, FirestoreError>
) {
return useQuery<Query | null, FirestoreError>({
...options,
queryFn: () => namedQuery(firestore, name),
});
}