Chore/download types schemas (supabase#29480)

Read which schemas to download types for

Author: saltcod

apps/studio/components/interfaces/Docs/GeneratingTypes.tsx

@@ -1,7 +1,7 @@
 import Link from 'next/link'
 import { useState } from 'react'
 import { toast } from 'sonner'
-
+import { useProjectPostgrestConfigQuery } from 'data/config/project-postgrest-config-query'
 import { useParams } from 'common'
 import CodeSnippet from 'components/interfaces/Docs/CodeSnippet'
 import { generateTypes } from 'data/projects/project-type-generation-query'
@@ -16,10 +16,12 @@ export default function GeneratingTypes({ selectedLang }: Props) {
  const { ref } = useParams()
  const [isGeneratingTypes, setIsGeneratingTypes] = useState(false)
 
+ const { data: config } = useProjectPostgrestConfigQuery({ projectRef: ref })
+
  const onClickGenerateTypes = async () => {
  try {
  setIsGeneratingTypes(true)
- const res = await generateTypes({ ref })
+ const res = await generateTypes({ ref, included_schemas: config?.db_schema })
  let element = document.createElement('a')
  element.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(res.types))
  element.setAttribute('download', 'supabase.ts')

apps/studio/components/interfaces/ProjectAPIDocs/Content/Entities.tsx

@@ -9,15 +9,18 @@ import ContentSnippet from '../ContentSnippet'
 import { DOCS_CONTENT } from '../ProjectAPIDocs.constants'
 import type { ContentProps } from './Content.types'
 import { ExternalLink, Download } from 'lucide-react'
+import { useProjectPostgrestConfigQuery } from 'data/config/project-postgrest-config-query'
 
 const Entities = ({ language }: ContentProps) => {
  const { ref } = useParams()
  const [isGeneratingTypes, setIsGeneratingTypes] = useState(false)
 
+ const { data: config } = useProjectPostgrestConfigQuery({ projectRef: ref })
+
  const onClickGenerateTypes = async () => {
  try {
  setIsGeneratingTypes(true)
- const res = await generateTypes({ ref })
+ const res = await generateTypes({ ref, included_schemas: config?.db_schema })
  let element = document.createElement('a')
  element.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(res.types))
  element.setAttribute('download', 'supabase.ts')

apps/studio/data/projects/project-type-generation-query.ts

@@ -4,13 +4,16 @@ import { get, handleError } from 'data/fetchers'
 import type { ResponseError } from 'types'
 import { projectKeys } from './keys'
 
-export type GenerateTypesVariables = { ref?: string }
+export type GenerateTypesVariables = { ref?: string; included_schemas?: string }
 
-export async function generateTypes({ ref }: GenerateTypesVariables, signal?: AbortSignal) {
+export async function generateTypes(
+ { ref, included_schemas }: GenerateTypesVariables,
+ signal?: AbortSignal
+) {
  if (!ref) throw new Error('Project ref is required')
 
  const { data, error } = await get(`/v1/projects/{ref}/types/typescript`, {
- params: { path: { ref } },
+ params: { path: { ref }, query: { included_schemas } },
  signal,
  })
 
@@ -22,11 +25,11 @@ export type GenerateTypesData = Awaited<ReturnType<typeof generateTypes>>
 export type GenerateTypesError = ResponseError
 
 export const useGenerateTypesQuery = <TData = GenerateTypesData>(
- { ref }: GenerateTypesVariables,
+ { ref, included_schemas }: GenerateTypesVariables,
  { enabled = true, ...options }: UseQueryOptions<GenerateTypesData, GenerateTypesError, TData> = {}
 ) =>
  useQuery<GenerateTypesData, GenerateTypesError, TData>(
  projectKeys.types(ref),
- ({ signal }) => generateTypes({ ref }, signal),
+ ({ signal }) => generateTypes({ ref, included_schemas }, signal),
  { enabled: enabled && typeof ref !== 'undefined', ...options }
  )