supabase/apps/studio/data/replication/publications-query.ts

import { useQuery } from '@tanstack/react-query'
import { components } from 'api-types'

import { replicationKeys } from './keys'
import { get, handleError } from '@/data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from '@/types'

type ReplicationPublicationsParams = { projectRef?: string; sourceId?: number }

export type ReplicationPublication =
  components['schemas']['ReplicationPublicationsResponse']['publications'][number]

async function fetchReplicationPublications(
  { projectRef, sourceId }: ReplicationPublicationsParams,
  signal?: AbortSignal
) {
  if (!projectRef) throw new Error('projectRef is required')

  if (!sourceId) throw new Error('sourceId is required')

  const { data, error } = await get(
    '/platform/replication/{ref}/sources/{source_id}/publications',
    {
      params: { path: { ref: projectRef, source_id: sourceId } },
      signal,
    }
  )
  if (error) {
    handleError(error)
  }

  // Filter out:
  // 1. supabase_realtime (internal publication)
  // 2. Publications with no tables (would cause validation to fail)
  const filteredPublications = data.publications.filter(
    (pub) => pub.name !== 'supabase_realtime' && pub.tables.length > 0
  )

  // Sort publications alphabetically by name
  return filteredPublications.sort((a, b) => a.name.localeCompare(b.name))
}

export type ReplicationPublicationsData = Awaited<ReturnType<typeof fetchReplicationPublications>>

export const useReplicationPublicationsQuery = <TData = ReplicationPublicationsData>(
  { projectRef, sourceId }: ReplicationPublicationsParams,
  {
    enabled = true,
    ...options
  }: UseCustomQueryOptions<ReplicationPublicationsData, ResponseError, TData> = {}
) =>
  useQuery<ReplicationPublicationsData, ResponseError, TData>({
    queryKey: replicationKeys.publications(projectRef, sourceId),
    queryFn: ({ signal }) => fetchReplicationPublications({ projectRef, sourceId }, signal),
    enabled: enabled && typeof projectRef !== 'undefined' && typeof sourceId !== 'undefined',
    ...options,
  })