Merge pull request #383 from psteinroe/feat/build-query-opts

feat: export buildQueryOptions and fetchQuery wrapper

.changeset/stupid-grapes-exist.md

@@ -0,0 +1,5 @@
+---
+"@supabase-cache-helpers/postgrest-react-query": minor
+---
+
+feat: export buildQueryOptions and fetchQuery wrapper

packages/postgrest-react-query/src/query/build-query-opts.ts

@@ -0,0 +1,27 @@
+import { PostgrestError } from '@supabase/postgrest-js';
+import {
+  AnyPostgrestResponse,
+  isPostgrestBuilder,
+} from '@supabase-cache-helpers/postgrest-core';
+import { UseQueryOptions as UseReactQueryOptions } from '@tanstack/react-query';
+
+import { encode } from '../lib/key';
+
+export function buildQueryOpts<Result>(
+  query: PromiseLike<AnyPostgrestResponse<Result>>,
+  config?: Omit<
+    UseReactQueryOptions<AnyPostgrestResponse<Result>, PostgrestError>,
+    'queryKey' | 'queryFn'
+  >,
+): UseReactQueryOptions<AnyPostgrestResponse<Result>, PostgrestError> {
+  return {
+    queryKey: encode<Result>(query, false),
+    queryFn: async () => {
+      if (isPostgrestBuilder(query)) {
+        query = query.throwOnError();
+      }
+      return await query;
+    },
+    ...config,
+  };
+}

packages/postgrest-react-query/src/query/fetch.ts

@@ -0,0 +1,50 @@
+import {
+  PostgrestError,
+  PostgrestMaybeSingleResponse,
+  PostgrestResponse,
+  PostgrestSingleResponse,
+} from '@supabase/postgrest-js';
+import { AnyPostgrestResponse } from '@supabase-cache-helpers/postgrest-core';
+import { FetchQueryOptions, QueryClient } from '@tanstack/react-query';
+
+import { buildQueryOpts } from './build-query-opts';
+
+function fetchQuery<Result>(
+  queryClient: QueryClient,
+  query: PromiseLike<PostgrestSingleResponse<Result>>,
+  config?: Omit<
+    FetchQueryOptions<PostgrestSingleResponse<Result>, PostgrestError>,
+    'queryKey' | 'queryFn'
+  >,
+): Promise<void>;
+function fetchQuery<Result>(
+  queryClient: QueryClient,
+  query: PromiseLike<PostgrestMaybeSingleResponse<Result>>,
+  config?: Omit<
+    FetchQueryOptions<PostgrestMaybeSingleResponse<Result>, PostgrestError>,
+    'queryKey' | 'queryFn'
+  >,
+): Promise<void>;
+function fetchQuery<Result>(
+  queryClient: QueryClient,
+  query: PromiseLike<PostgrestResponse<Result>>,
+  config?: Omit<
+    FetchQueryOptions<PostgrestResponse<Result>, PostgrestError>,
+    'queryKey' | 'queryFn'
+  >,
+): Promise<void>;
+
+async function fetchQuery<Result>(
+  queryClient: QueryClient,
+  query: PromiseLike<AnyPostgrestResponse<Result>>,
+  config?: Omit<
+    FetchQueryOptions<AnyPostgrestResponse<Result>, PostgrestError>,
+    'queryKey' | 'queryFn'
+  >,
+) {
+  await queryClient.fetchQuery<AnyPostgrestResponse<Result>, PostgrestError>(
+    buildQueryOpts(query, config),
+  );
+}
+
+export { fetchQuery };

packages/postgrest-react-query/src/query/index.ts

@@ -1,2 +1,4 @@
+export * from './build-query-opts';
+export * from './fetch';
 export * from './prefetch';
 export * from './use-query';

packages/postgrest-react-query/src/query/prefetch.ts

@@ -10,6 +10,7 @@ import {
 } from '@supabase-cache-helpers/postgrest-core';
 import { FetchQueryOptions, QueryClient } from '@tanstack/react-query';
 
+import { buildQueryOpts } from './build-query-opts';
 import { encode } from '../lib';
 
 function prefetchQuery<Result>(
@@ -46,17 +47,7 @@ async function prefetchQuery<Result>(
   >,
 ) {
   await queryClient.prefetchQuery<AnyPostgrestResponse<Result>, PostgrestError>(
-    {
-      queryKey: encode<Result>(query, false),
-      queryFn: async () => {
-        if (!isPostgrestBuilder<Result>(query)) {
-          throw new Error('Query is not a PostgrestBuilder');
-        }
-
-        return await query.throwOnError();
-      },
-      ...config,
-    },
+    buildQueryOpts(query, config),
   );
 }
 

packages/postgrest-react-query/src/query/use-query.ts

@@ -4,17 +4,14 @@ import {
   PostgrestSingleResponse,
   PostgrestMaybeSingleResponse,
 } from '@supabase/postgrest-js';
-import {
-  AnyPostgrestResponse,
-  isPostgrestBuilder,
-} from '@supabase-cache-helpers/postgrest-core';
+import { AnyPostgrestResponse } from '@supabase-cache-helpers/postgrest-core';
 import {
   useQuery as useReactQuery,
   UseQueryResult as UseReactQueryResult,
   UseQueryOptions as UseReactQueryOptions,
 } from '@tanstack/react-query';
 
-import { encode } from '../lib/key';
+import { buildQueryOpts } from './build-query-opts';
 
 /**
  * Represents the return value of the `useQuery` hook when `query` is expected to return
@@ -118,6 +115,7 @@ function useQuery<Result>(
     'queryKey' | 'queryFn'
   >,
 ): UseQueryReturn<Result>;
+
 /**
  * React hook to execute a PostgREST query.
  *
@@ -136,16 +134,7 @@ function useQuery<Result>(
   const { data, ...rest } = useReactQuery<
     AnyPostgrestResponse<Result>,
     PostgrestError
-  >({
-    queryKey: encode<Result>(query, false),
-    queryFn: async () => {
-      if (isPostgrestBuilder(query)) {
-        query = query.throwOnError();
-      }
-      return await query;
-    },
-    ...config,
-  });
+  >(buildQueryOpts<Result>(query, config));
 
   return { data: data?.data, count: data?.count ?? null, ...rest };
 }