Files
Alaister YoungandAlaister 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

103 lines
3.8 KiB
TypeScript

import { AnimatePresence, motion } from 'framer-motion'
import { ExternalLink } from 'lucide-react'
import Link from 'next/link'
import { Button } from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
import { useIncidentStatusQuery } from '@/data/platform/incident-status-query'
import { processIncidentData } from '@/data/platform/incident-status-utils'
interface IncidentAdmonitionProps {
isActive: boolean
className?: string
}
const STATUS_DESCRIPTION_SIGN_OFF = 'Follow the status page for updates.'
const capitalizeFirstLetter = (str: string) => str.charAt(0).toUpperCase() + str.slice(1)
const getStatusDescription = (
status: string,
hasMultipleIncidents: boolean,
allSameStatus: boolean
): string => {
const isPlural = hasMultipleIncidents
const issueTerm = isPlural ? 'these issues' : 'this issue'
switch (status) {
case 'investigating':
if (hasMultipleIncidents && !allSameStatus) {
return `We are aware of multiple ongoing issues and are investigating. ${STATUS_DESCRIPTION_SIGN_OFF}`
}
return `We are investigating ${issueTerm}. ${STATUS_DESCRIPTION_SIGN_OFF}`
case 'identified':
if (hasMultipleIncidents && !allSameStatus) {
return `We have identified the cause of some of ${issueTerm} and are working on fixes. ${STATUS_DESCRIPTION_SIGN_OFF}`
}
return `We have identified the cause of ${issueTerm} and are working on a fix. ${STATUS_DESCRIPTION_SIGN_OFF}`
case 'monitoring':
if (hasMultipleIncidents && !allSameStatus) {
return `Fixes have been deployed for some of ${issueTerm} and we are monitoring the results. ${STATUS_DESCRIPTION_SIGN_OFF}`
}
return `A fix has been deployed and we are monitoring the results. ${STATUS_DESCRIPTION_SIGN_OFF}`
case 'resolved':
if (hasMultipleIncidents && !allSameStatus) {
return `Some of ${issueTerm} have been resolved, but others may still be ongoing. ${STATUS_DESCRIPTION_SIGN_OFF}`
}
return `${capitalizeFirstLetter(issueTerm)} ${isPlural ? 'have' : 'has'} been resolved but may take some time to fully recover. ${STATUS_DESCRIPTION_SIGN_OFF}`
default:
return `We are investigating ${issueTerm}. ${STATUS_DESCRIPTION_SIGN_OFF}`
}
}
export function IncidentAdmonition({ isActive, className }: IncidentAdmonitionProps) {
const { data: allStatusPageEvents, isLoading, isError } = useIncidentStatusQuery()
const { incidents = [] } = allStatusPageEvents ?? {}
// Don't render anything while loading, on error, or if no incidents
if (isLoading || isError || !incidents || incidents.length === 0) {
return null
}
const { hasMultipleIncidents, mostCriticalIncident, overallStatus, allSameStatus } =
processIncidentData(incidents)
// Show most recent incident name + count if multiple incidents
const statusTitle =
(mostCriticalIncident?.name ?? '') +
(hasMultipleIncidents
? ` and ${incidents.length - 1} other issue${incidents.length > 2 ? 's' : ''}`
: '')
return (
<AnimatePresence>
{isActive && (
<motion.aside
initial={{ height: 0, opacity: 0 }}
animate={{ height: 'auto', opacity: 1 }}
exit={{ height: 0, opacity: 0 }}
>
<Admonition
type="warning"
layout="horizontal"
className={className}
title={statusTitle}
description={getStatusDescription(overallStatus, hasMultipleIncidents, allSameStatus)}
actions={
<Button asChild variant="default" icon={<ExternalLink strokeWidth={1.5} />}>
<Link href="https://status.supabase.com/" target="_blank" rel="noreferrer">
Status page
</Link>
</Button>
}
/>
</motion.aside>
)}
</AnimatePresence>
)
}