Files
supabase/apps/studio/components/interfaces/Database/ProtectedSchemaWarning.tsx
Alaister Young ca2b50a0a7 chore(ui-patterns): collapse the admonition shim into ui-patterns/Admonition (#48377)
Follow-up to #48344: collapses the two resolution paths for the
Admonition module into one.

`src/admonition.tsx` was a back-compat shim re-exporting
`src/Admonition/`. Two ways to resolve one module is exactly what
produced the macOS self-import bug fixed in #48344, and the local
typecheck errors that #48374 worked around. This removes the shim and
standardizes on the PascalCase subpath, matching every other export in
the package.

**Changed:**

- Codemodded all 246 `ui-patterns/admonition` imports to
`ui-patterns/Admonition` (240 `.tsx`, 5 `.mdx`, 1 `.ts` across studio,
docs, www, design-system, and lite-studio)
- Pointed the 5 internal `'../admonition'` imports back at the
`'../Admonition'` directory

**Removed:**

- `packages/ui-patterns/src/admonition.tsx`, and its `./admonition`
entry in the exports map (regenerated with `pnpm gen:exports`)

## To test

- `grep -r "ui-patterns/admonition" --include='*.ts*'` → no hits
- `pnpm test:case-hazards` → passes
- `pnpm typecheck` → all 15 tasks green
- `pnpm --filter studio run lint:ratchet` → passes
- `pnpm --filter ui-patterns vitest run src/Admonition` → 11 tests pass

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
* Standardized Admonition component imports across the application and
documentation.
* Improved compatibility with case-sensitive environments by using the
canonical component path.
  * Removed the legacy Admonition import entry point.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
2026-07-29 00:48:56 +08:00

116 lines
3.5 KiB
TypeScript

import { useState } from 'react'
import {
Button,
Dialog,
DialogContent,
DialogFooter,
DialogHeader,
DialogSection,
DialogSectionSeparator,
DialogTitle,
DialogTrigger,
} from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
import { INTERNAL_SCHEMAS, useIsProtectedSchema } from '@/hooks/useProtectedSchemas'
export const ProtectedSchemaDialog = ({ onClose }: { onClose: () => void }) => {
return (
<>
<DialogHeader>
<DialogTitle>Schemas managed by Supabase</DialogTitle>
</DialogHeader>
<DialogSectionSeparator />
<DialogSection className="space-y-2 prose">
<p className="text-sm">
The following schemas are managed by Supabase and are currently protected from write
access through the dashboard.
</p>
<div className="flex flex-wrap gap-1">
{INTERNAL_SCHEMAS.map((schema) => (
<code key={schema} className="text-xs">
{schema}
</code>
))}
</div>
<p className="text-sm mt-4!">
These schemas are critical to the functionality of your Supabase project and hence we
highly recommend not altering them.
</p>
<p className="text-sm">
You can, however, still interact with those schemas through the SQL Editor although we
advise you only do so if you know what you are doing.
</p>
</DialogSection>
<DialogFooter>
<div className="flex items-center justify-end space-x-2">
<Button variant="default" onClick={onClose}>
Understood
</Button>
</div>
</DialogFooter>
</>
)
}
export const ProtectedSchemaWarning = ({
size = 'md',
schema,
entity,
}: {
size?: 'sm' | 'md'
schema: string
entity: string
}) => {
const [showModal, setShowModal] = useState(false)
const { isSchemaLocked, reason, fdwType } = useIsProtectedSchema({ schema })
if (!isSchemaLocked) return null
const showLearnMoreDialog =
reason !== 'fdw' || (fdwType !== 'iceberg' && fdwType !== 's3_vectors')
return (
<Admonition
showIcon={size === 'sm' ? false : true}
layout={size === 'sm' ? 'vertical' : 'horizontal'}
type="note"
title={
size === 'sm' ? `Viewing protected schema` : `Viewing ${entity} from a protected schema`
}
description={
reason === 'fdw' && fdwType === 'iceberg' ? (
<p>
The <code className="text-code-inline">{schema}</code> schema is used by Supabase to
connect to analytics buckets and is read-only through the dashboard.
</p>
) : reason === 'fdw' && fdwType === 's3_vectors' ? (
<p>
The <code className="text-code-inline">{schema}</code> schema is used by Supabase to
connect to vector buckets and is read-only through the dashboard.
</p>
) : (
<p>
The <code className="text-code-inline">{schema}</code> schema is managed by Supabase and
is read-only through the dashboard.
</p>
)
}
actions={
showLearnMoreDialog && (
<Dialog open={showModal} onOpenChange={setShowModal}>
<DialogTrigger asChild>
<Button variant="default" size="tiny" onClick={() => setShowModal(true)}>
Learn more
</Button>
</DialogTrigger>
<DialogContent>
<ProtectedSchemaDialog onClose={() => setShowModal(false)} />
</DialogContent>
</Dialog>
)
}
/>
)
}