Files
supabase/apps/studio/components/interfaces/Settings/API/ExposedSchemaSelector.tsx
T
Joshen Lim 09a1f431bc Mass update for all lucide icon imports to use the component with Icon suffix (#51659)
## Context

This is largely just a mechanical change here:
Opting to use lucide icons with the `Icon` suffix across all icon
imports within `studio`
- so that it’s clearer which components are icons + reduces the
possibility of name collision with our own components
- e.g <User /> vs <UserIcon />

Also added a eslint rule for this:
<img width="1069" height="167" alt="image"
src="https://github.com/user-attachments/assets/7f36f443-5ca2-4bf6-8d22-86e774513bfc"
/>

And updated `AGENTS.md` as such:
```
Icons come from `lucide-react`, always imported with the `Icon` suffix (`import { CheckIcon, Trash2Icon } from 'lucide-react'`) — never the bare names (`Check`) or `Check as CheckIcon` aliases (lint-enforced).
```
2026-10-14 12:56:55 +02:00

227 lines
8.0 KiB
TypeScript

import { CheckIcon, ChevronsUpDownIcon } from 'lucide-react'
import { useMemo, useState } from 'react'
import {
Button,
cn,
Command,
CommandEmpty,
CommandGroup,
CommandInput,
CommandItem,
CommandList,
Popover,
PopoverContent,
PopoverTrigger,
ScrollArea,
Tooltip,
TooltipContent,
TooltipTrigger,
} from 'ui'
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
import { getExposedSchemaCounts } from './ExposedSchemaSelector.utils'
import { useSchemasQuery } from '@/data/database/schemas-query'
import {
MULTIGRES_SCHEMA_NAME,
useHighAvailability,
useSchemasFilteredForHighAvailability,
} from '@/hooks/misc/useHighAvailability'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { INTERNAL_SCHEMAS } from '@/hooks/useProtectedSchemas'
import { pluralize } from '@/lib/helpers'
/**
* [Joshen] This would only affect graphql_public and pgmq_public, given that they're intended
* to be public, we can let users expose them via the API, but not let them adjust the schema via the dashboard
* */
export const internalSchemasCannotExpose = new Set(
INTERNAL_SCHEMAS.filter((x) => !x.endsWith('_public'))
)
interface ExposedSchemaSelectorProps {
/**
* When true the dropdown can still be opened to inspect which schemas are exposed (e.g.
* self-hosted, where schemas are managed via PGRST_DB_SCHEMAS), but schemas can't be toggled.
*/
readOnly?: boolean
selectedSchemas: string[]
onToggleSchema: (schema: string) => void
}
export const ExposedSchemaSelector = ({
readOnly = false,
selectedSchemas,
onToggleSchema,
}: ExposedSchemaSelectorProps) => {
const [open, setOpen] = useState(false)
const { data: project } = useSelectedProjectQuery()
const { isHighAvailability } = useHighAvailability()
const {
data: allSchemas,
isPending,
isError,
isSuccess,
} = useSchemasQuery({
projectRef: project?.ref,
connectionString: project?.connectionString,
})
const visibleSchemas = useSchemasFilteredForHighAvailability(allSchemas)
const schemas = useMemo(
() =>
visibleSchemas
.filter((s) => !internalSchemasCannotExpose.has(s.name))
.sort((a, b) => a.name.localeCompare(b.name)),
[visibleSchemas]
)
// Persisted selections go through the same HA filtering as the schema list, so a
// multigres schema exposed in the config doesn't render as a "missing" schema row.
const visibleSelectedSchemas = useMemo(
() =>
isHighAvailability
? selectedSchemas.filter((schema) => schema !== MULTIGRES_SCHEMA_NAME)
: selectedSchemas,
[selectedSchemas, isHighAvailability]
)
const missingExposedSchema = useMemo(
() => visibleSelectedSchemas.filter((schema) => !schemas.some((s) => s.name === schema)),
[schemas, visibleSelectedSchemas]
)
const selectedSet = useMemo(() => new Set(visibleSelectedSchemas), [visibleSelectedSchemas])
const { selectedCount, totalCount } = getExposedSchemaCounts({
visibleSchemas: schemas.map((s) => s.name),
selectedSchemas: visibleSelectedSchemas,
protectedSchemas: internalSchemasCannotExpose,
})
let schemasSummary: string
if (isSuccess) {
schemasSummary = `${selectedCount} of ${totalCount} ${pluralize(totalCount, 'schema')} exposed`
} else {
schemasSummary = 'Loading schemas...'
}
return (
<Popover open={open} onOpenChange={setOpen} modal={false}>
<Tooltip>
<TooltipTrigger asChild>
<PopoverTrigger asChild>
<Button
size="small"
className="w-full [&>span]:w-full pr-1! space-x-1"
iconRight={
<ChevronsUpDownIcon className="text-foreground-muted" strokeWidth={2} size={14} />
}
aria-label="Select schemas"
// Tooltip repeats the label; the description would read the name twice
aria-describedby={undefined}
>
<div className="w-full flex gap-1">
<p className="text-foreground-lighter" aria-live="polite">
{schemasSummary}
</p>
</div>
</Button>
</PopoverTrigger>
</TooltipTrigger>
<TooltipContent side="bottom" align="end">
Select schemas
</TooltipContent>
</Tooltip>
<PopoverContent
className="p-0 min-w-[200px] pointer-events-auto"
side="bottom"
align="start"
sameWidthAsTrigger
>
<Command>
<CommandInput className="text-xs" placeholder="Find schema..." />
<CommandList>
<CommandGroup>
{isPending ? (
<>
<div className="px-2 py-1">
<ShimmeringLoader className="py-2" />
</div>
<div className="px-2 py-1 w-4/5">
<ShimmeringLoader className="py-2" />
</div>
</>
) : isError ? (
<div className="flex items-center py-3 justify-center">
<p className="text-xs text-foreground-lighter">Failed to retrieve schemas</p>
</div>
) : (
<>
<CommandEmpty>
<p className="text-xs text-center text-foreground-lighter py-3">
No schemas found
</p>
</CommandEmpty>
<ScrollArea className={schemas.length > 7 ? 'h-[210px]' : ''}>
{missingExposedSchema.map((schema) => (
<CommandItem
key={schema}
value={schema}
className={cn('w-full', readOnly ? 'cursor-default' : 'cursor-pointer')}
onSelect={() => {
if (readOnly) return
onToggleSchema(schema)
}}
>
<div className="w-full flex flex-col">
<div className="w-full flex items-center gap-x-2">
<CheckIcon size={16} className="text-primary shrink-0" />
<span className="truncate">{schema}</span>
</div>
{internalSchemasCannotExpose.has(schema) ? (
<span className="pl-6 text-warning text-xs tracking-tight">
This schema is protected and should not be exposed
</span>
) : (
<span className="pl-6 text-foreground-lighter text-xs tracking-tight">
This schema does not exist and can be safely removed
</span>
)}
</div>
</CommandItem>
))}
{schemas.map((schema) => {
const isExposed = selectedSet.has(schema.name)
return (
<CommandItem
key={schema.id}
value={schema.name}
className={cn('w-full', readOnly ? 'cursor-default' : 'cursor-pointer')}
onSelect={() => {
if (readOnly) return
onToggleSchema(schema.name)
}}
>
<div
className={cn('w-full flex items-center gap-x-2', !isExposed && 'ml-6')}
>
{isExposed && <CheckIcon size={16} className="text-primary shrink-0" />}
<span className="truncate">{schema.name}</span>
</div>
</CommandItem>
)
})}
</ScrollArea>
</>
)}
</CommandGroup>
</CommandList>
</Command>
</PopoverContent>
</Popover>
)
}