Files
supabase/apps/studio/data/database/supavisor-configuration-query.ts
Ivan Vasilov 8b657165b5 chore: Migrate to use custom type for ReactQuery queries and mutations (#40073)
* Add custom types for queries, mutations and infinite queries.

* Migrate all queries to use the new type.

* Migrate all infinite queries to useCustomInfiniteQueryOptions.

* Migrate all mutations to use useCustomMutationOptions.

* Add type to all imports in `types` folder.
2025-11-03 13:18:13 +01:00

42 lines
1.4 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import { get, handleError } from 'data/fetchers'
import { IS_PLATFORM } from 'lib/constants'
import type { ResponseError, UseCustomQueryOptions } from 'types'
import { databaseKeys } from './keys'
type SupavisorConfigurationVariables = {
projectRef?: string
}
export async function getSupavisorConfiguration(
{ projectRef }: SupavisorConfigurationVariables,
signal?: AbortSignal
) {
if (!projectRef) throw new Error('Project ref is required')
const { data, error } = await get(`/platform/projects/{ref}/config/supavisor`, {
params: { path: { ref: projectRef } },
signal,
})
if (error) handleError(error)
return data
}
export type SupavisorConfigurationData = Awaited<ReturnType<typeof getSupavisorConfiguration>>
export type SupavisorConfigurationError = ResponseError
export const useSupavisorConfigurationQuery = <TData = SupavisorConfigurationData>(
{ projectRef }: SupavisorConfigurationVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<SupavisorConfigurationData, SupavisorConfigurationError, TData> = {}
) =>
useQuery<SupavisorConfigurationData, SupavisorConfigurationError, TData>({
queryKey: databaseKeys.poolingConfiguration(projectRef),
queryFn: ({ signal }) => getSupavisorConfiguration({ projectRef }, signal),
enabled: enabled && typeof projectRef !== 'undefined' && IS_PLATFORM,
...options,
})