Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

2.2 KB
Raw Blame
import { queryOptions, useQuery } from '@tanstack/react-query'

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

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

async function fetchReplicationPublicationNames(
  { projectRef, sourceId }: ReplicationPublicationNamesParams,
  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/v2/{ref}/sources/{source_id}/publications',
    {
      params: { path: { ref: projectRef, source_id: sourceId } },
      signal,
    }
  )
  if (error) handleError(error)

  return data.publications
    .filter(({ name }) => name !== 'supabase_realtime')
    .sort((a, b) => a.name.localeCompare(b.name))
}

export type ReplicationPublicationNamesData = Awaited<
  ReturnType<typeof fetchReplicationPublicationNames>
>

type ReplicationPublicationNamesQueryOptions<TData> = Omit<
  UseCustomQueryOptions<ReplicationPublicationNamesData, ResponseError, TData>,
  'enabled'
> & { enabled?: boolean }

export const replicationPublicationNamesQueryOptions = <TData = ReplicationPublicationNamesData>(
  { projectRef, sourceId }: ReplicationPublicationNamesParams,
  { enabled = true, ...options }: ReplicationPublicationNamesQueryOptions<TData> = {}
) =>
  queryOptions<ReplicationPublicationNamesData, ResponseError, TData>({
    queryKey: replicationKeys.publicationNames(projectRef, sourceId),
    queryFn: ({ signal }) => fetchReplicationPublicationNames({ projectRef, sourceId }, signal),
    enabled: enabled && typeof projectRef !== 'undefined' && typeof sourceId !== 'undefined',
    staleTime: REPLICATION_METADATA_FRESHNESS_MS,
    ...options,
  })

export const useReplicationPublicationNamesQuery = <TData = ReplicationPublicationNamesData>(
  { projectRef, sourceId }: ReplicationPublicationNamesParams,
  options: ReplicationPublicationNamesQueryOptions<TData> = {}
) => useQuery(replicationPublicationNamesQueryOptions({ projectRef, sourceId }, options))