Files
supabase/apps/studio/data/database-policies/database-policies-query.ts
T
Joshen Lim cab0585533 Fe 1799/consolidate to useselectedprojectquery and (#37684)
* Replace all usage of useProjectContext with useSelectedProjectQuery

* Replace all usage of useSelectedProject with useSelectedProjectQuery

* Replace all usage of useProjectByRef with useProjectByRefQuery

* Replace all usage of useSelectedOrganization with useSelectedOrganizationQuery

* Deprecate useSelectedProject, useSelectedOrganization, and useProjectByRef hooks

* Deprecate ProjecContext
2025-08-06 10:53:10 +07:00

68 lines
2.1 KiB
TypeScript

import { UseQueryOptions, useQuery } from '@tanstack/react-query'
import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
import { get, handleError } from 'data/fetchers'
import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
import { PROJECT_STATUS } from 'lib/constants'
import type { ResponseError } from 'types'
import { databasePoliciesKeys } from './keys'
export type DatabasePoliciesVariables = {
projectRef?: string
connectionString?: string | null
schema?: string
}
export async function getDatabasePolicies(
{ projectRef, connectionString, schema }: DatabasePoliciesVariables,
signal?: AbortSignal,
headersInit?: HeadersInit
) {
if (!projectRef) throw new Error('projectRef is required')
let headers = new Headers(headersInit)
if (connectionString) headers.set('x-connection-encrypted', connectionString)
const { data, error } = await get('/platform/pg-meta/{ref}/policies', {
params: {
header: {
'x-connection-encrypted': connectionString!,
'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
},
path: { ref: projectRef },
query: {
included_schemas: schema || '',
excluded_schemas: '',
},
},
headers,
signal,
})
if (error) handleError(error)
return data
}
export type DatabasePoliciesData = Awaited<ReturnType<typeof getDatabasePolicies>>
export type DatabasePoliciesError = ResponseError
export const useDatabasePoliciesQuery = <TData = DatabasePoliciesData>(
{ projectRef, connectionString, schema }: DatabasePoliciesVariables,
{
enabled = true,
...options
}: UseQueryOptions<DatabasePoliciesData, DatabasePoliciesError, TData> = {}
) => {
const { data: project } = useSelectedProjectQuery()
const isActive = project?.status === PROJECT_STATUS.ACTIVE_HEALTHY
return useQuery<DatabasePoliciesData, DatabasePoliciesError, TData>(
databasePoliciesKeys.list(projectRef, schema),
({ signal }) => getDatabasePolicies({ projectRef, connectionString, schema }, signal),
{
enabled: enabled && typeof projectRef !== 'undefined' && isActive,
...options,
}
)
}