supabase/apps/studio/data/auth/user-search-indexes-query.ts

import { getIndexStatusesSQL } from '@supabase/pg-meta'
import { useQuery } from '@tanstack/react-query'

import { authKeys } from './keys'
import { executeSql } from '@/data/sql/execute-sql-mutation'
import { ResponseError, UseCustomQueryOptions } from '@/types'

type UsersIndexStatusesVariables = {
  projectRef?: string
  connectionString?: string | null
}
type UsersIndexStatusesData = {
  index_name: string
  is_valid: boolean
  is_ready: boolean
}[]
export type UsersIndexStatusesError = ResponseError

export async function getUserIndexStatuses(
  { projectRef, connectionString }: UsersIndexStatusesVariables,
  signal?: AbortSignal
): Promise<UsersIndexStatusesData> {
  const sql = getIndexStatusesSQL()

  const { result } = await executeSql<UsersIndexStatusesData>(
    {
      projectRef,
      connectionString,
      sql,
      queryKey: ['index-statuses'],
    },
    signal
  )

  return result
}

export const useUserIndexStatusesQuery = <TData = UsersIndexStatusesData>(
  { projectRef, connectionString }: UsersIndexStatusesVariables,
  {
    enabled = true,
    ...options
  }: UseCustomQueryOptions<UsersIndexStatusesData, UsersIndexStatusesError, TData> = {}
) =>
  useQuery<UsersIndexStatusesData, UsersIndexStatusesError, TData>({
    queryKey: authKeys.usersIndexStatuses(projectRef),
    queryFn: ({ signal }) =>
      getUserIndexStatuses(
        {
          projectRef,
          connectionString,
        },
        signal
      ),
    enabled: enabled && typeof projectRef !== 'undefined',
    ...options,
  })