Files
supabase/apps/studio/data/banned-ips/banned-ips-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

39 lines
1.2 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import { handleError, post } from 'data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from 'types'
import { BannedIPKeys } from './keys'
export type BannedIPVariables = {
projectRef?: string
}
export type BannedIPsData = BannedIPVariables[]
export type BannedIPsError = ResponseError
export async function getBannedIPs({ projectRef }: BannedIPVariables, signal?: AbortSignal) {
if (!projectRef) throw new Error('projectRef is required')
const { data, error } = await post(`/v1/projects/{ref}/network-bans/retrieve`, {
params: { path: { ref: projectRef } },
signal,
})
if (error) handleError(error)
return data
}
export type IPData = Awaited<ReturnType<typeof getBannedIPs>>
export type IPError = ResponseError
export const useBannedIPsQuery = <TData = IPData>(
{ projectRef }: BannedIPVariables,
{ enabled = true, ...options }: UseCustomQueryOptions<IPData, IPError, TData> = {}
) =>
useQuery<IPData, IPError, TData>({
queryKey: BannedIPKeys.list(projectRef),
queryFn: ({ signal }) => getBannedIPs({ projectRef }, signal),
enabled: enabled && typeof projectRef !== 'undefined',
...options,
})