Merge pull request #700 from seamapi/return-query-key

Return queryKey from hooks

Author: razor-x

src/lib/seam/use-seam-infinite-query.ts

@@ -10,6 +10,7 @@ import type {
 } from '@seamapi/http/connect'
 import type { ActionAttempt } from '@seamapi/types/connect'
 import {
+  type QueryKey,
   useInfiniteQuery,
   type UseInfiniteQueryOptions,
   type UseInfiniteQueryResult,
@@ -29,19 +30,25 @@ export function useSeamInfiniteQuery<
   T extends SeamHttpEndpointPaginatedQueryPaths,
 >(
   endpointPath: T,
-  parameters?: UseSeamInfiniteQueryParameters<T>,
+  parameters: UseSeamInfiniteQueryParameters<T> = {},
   options: Parameters<SeamHttpEndpoints[T]>[1] &
     QueryOptions<QueryData<T>, QueryError<T>> = {}
-): UseSeamInfiniteQueryResult<T> {
+): UseSeamInfiniteQueryResult<T> & { queryKey: QueryKey } {
   const { endpointClient: client, queryKeyPrefixes } = useSeamClient()
-  return useInfiniteQuery({
+
+  if ('page_cursor' in (parameters ?? {})) {
+    throw new Error('Cannot use page_cursor with useSeamInfiniteQuery')
+  }
+
+  const queryKey = [
+    ...queryKeyPrefixes,
+    ...endpointPath.split('/').filter((v) => v !== ''),
+    parameters ?? {},
+  ]
+  const result = useInfiniteQuery({
     enabled: client != null,
     ...options,
-    queryKey: [
-      ...queryKeyPrefixes,
-      ...endpointPath.split('/').filter((v) => v !== ''),
-      parameters,
-    ],
+    queryKey,
     initialPageParam: null,
     getNextPageParam: (lastPage) => lastPage.nextPageCursor,
     queryFn: async ({ pageParam }) => {
@@ -72,6 +79,7 @@ export function useSeamInfiniteQuery<
       }
     },
   })
+  return { ...result, queryKey }
 }
 
 interface QueryData<T extends SeamHttpEndpointPaginatedQueryPaths> {

src/lib/seam/use-seam-query-without-workspace.ts

@@ -5,6 +5,7 @@ import type {
   SeamHttpInvalidInputError,
 } from '@seamapi/http/connect'
 import {
+  type QueryKey,
   useQuery,
   type UseQueryOptions,
   type UseQueryResult,
@@ -24,19 +25,20 @@ export function useSeamQueryWithoutWorkspace<
   T extends SeamHttpEndpointWithoutWorkspaceQueryPaths,
 >(
   endpointPath: T,
-  parameters?: UseSeamQueryWithoutWorkspaceParameters<T>,
+  parameters: UseSeamQueryWithoutWorkspaceParameters<T> = {},
   options: Parameters<SeamHttpEndpointsWithoutWorkspace[T]>[1] &
     QueryOptions<QueryData<T>, QueryError> = {}
-): UseSeamQueryWithoutWorkspaceResult<T> {
+): UseSeamQueryWithoutWorkspaceResult<T> & { queryKey: QueryKey } {
   const { endpointClient: client, queryKeyPrefixes } = useSeamClient()
-  return useQuery({
+  const queryKey = [
+    ...queryKeyPrefixes,
+    ...endpointPath.split('/').filter((v) => v !== ''),
+    parameters ?? {},
+  ]
+  const result = useQuery({
     enabled: client != null,
     ...options,
-    queryKey: [
-      ...queryKeyPrefixes,
-      ...endpointPath.split('/').filter((v) => v !== ''),
-      parameters,
-    ],
+    queryKey,
     queryFn: async () => {
       if (client == null) return null
       // Using @ts-expect-error over any is preferred, but not possible here because TypeScript will run out of memory.
@@ -45,6 +47,7 @@ export function useSeamQueryWithoutWorkspace<
       return await endpoint(parameters, options)
     },
   })
+  return { ...result, queryKey }
 }
 
 type QueryData<T extends SeamHttpEndpointWithoutWorkspaceQueryPaths> = Awaited<

src/lib/seam/use-seam-query.ts

@@ -8,6 +8,7 @@ import type {
 } from '@seamapi/http/connect'
 import type { ActionAttempt } from '@seamapi/types/connect'
 import {
+  type QueryKey,
   useQuery,
   type UseQueryOptions,
   type UseQueryResult,
@@ -23,19 +24,20 @@ export type UseSeamQueryResult<T extends SeamHttpEndpointQueryPaths> =
 
 export function useSeamQuery<T extends SeamHttpEndpointQueryPaths>(
   endpointPath: T,
-  parameters?: UseSeamQueryParameters<T>,
+  parameters: UseSeamQueryParameters<T> = {},
   options: Parameters<SeamHttpEndpoints[T]>[1] &
     QueryOptions<QueryData<T>, SeamHttpApiError> = {}
-): UseSeamQueryResult<T> {
+): UseSeamQueryResult<T> & { queryKey: QueryKey } {
   const { endpointClient: client, queryKeyPrefixes } = useSeamClient()
-  return useQuery({
+  const queryKey = [
+    ...queryKeyPrefixes,
+    ...endpointPath.split('/').filter((v) => v !== ''),
+    parameters ?? {},
+  ]
+  const result = useQuery({
     enabled: client != null,
     ...options,
-    queryKey: [
-      ...queryKeyPrefixes,
-      ...endpointPath.split('/').filter((v) => v !== ''),
-      parameters,
-    ],
+    queryKey,
     queryFn: async () => {
       if (client == null) return null
       // Using @ts-expect-error over any is preferred, but not possible here because TypeScript will run out of memory.
@@ -44,6 +46,7 @@ export function useSeamQuery<T extends SeamHttpEndpointQueryPaths>(
       return await endpoint(parameters, options)
     },
   })
+  return { ...result, queryKey }
 }
 
 type QueryData<T extends SeamHttpEndpointQueryPaths> = Awaited<