Files
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

201 lines
7.5 KiB
TypeScript

import { useParams } from 'common'
import { AlertCircle, RefreshCw } from 'lucide-react'
import { useEffect } from 'react'
import { toast } from 'sonner'
import { Alert, AlertDescription, AlertTitle, Button, WarningIcon } from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
import { DNSRecord } from './DNSRecord'
import { DNSTableHeaders } from './DNSTableHeaders'
import { DocsButton } from '@/components/ui/DocsButton'
import { InlineLink } from '@/components/ui/InlineLink'
import Panel from '@/components/ui/Panel'
import { useProjectSettingsV2Query } from '@/data/config/project-settings-v2-query'
import { useCustomDomainDeleteMutation } from '@/data/custom-domains/custom-domains-delete-mutation'
import { useCustomDomainsQuery } from '@/data/custom-domains/custom-domains-query'
import { useCustomDomainReverifyQuery } from '@/data/custom-domains/custom-domains-reverify-query'
import { DOCS_URL } from '@/lib/constants'
export const CustomDomainVerify = () => {
const { ref: projectRef } = useParams()
const { data: settings } = useProjectSettingsV2Query({ projectRef })
const { data: customDomainData } = useCustomDomainsQuery({ projectRef })
const customDomain = customDomainData?.customDomain
const isSSLCertificateDeploying =
customDomain?.ssl.status !== undefined && customDomain.ssl.txt_name === undefined
const { mutate: deleteCustomDomain, isPending: isDeleting } = useCustomDomainDeleteMutation({
onSuccess: () => {
toast.success(
'Custom domain setup cancelled successfully. It may take a few seconds before your custom domain is fully removed, so you may need to refresh your browser.'
)
},
})
const {
data: reverifyData,
refetch: refetchReverify,
isFetching: isReverifyLoading,
isError: isReverifyError,
error: reverifyError,
} = useCustomDomainReverifyQuery(
{ projectRef },
{
// Poll every 10 seconds if the SSL certificate is being deployed
refetchInterval: isSSLCertificateDeploying && !isDeleting ? 10000 : false,
}
)
useEffect(() => {
if (isReverifyError) {
toast.error(reverifyError?.message)
}
}, [isReverifyError, reverifyError])
const isNotVerifiedYet = reverifyData?.status === '2_initiated'
const hasCAAErrors = customDomain?.ssl.validation_errors?.reduce(
(acc, error) => acc || error.message.includes('caa_error'),
false
)
const isValidating = (customDomain?.ssl.txt_name ?? '') === ''
const onReverifyCustomDomain = () => {
if (!projectRef) return console.error('Project ref is required')
refetchReverify()
}
const onCancelCustomDomain = async () => {
if (!projectRef) return console.error('Project ref is required')
deleteCustomDomain({ projectRef })
}
return (
<>
<Panel.Content className="space-y-6">
<div>
<h4 className="text-foreground mb-2">
Configure TXT verification for your custom domain{' '}
<code className="text-code-inline">{customDomain?.hostname}</code>
</h4>
<p className="text-sm text-foreground-light">
Set the following TXT record(s) in your DNS provider, then click verify to confirm your
control over the domain. Records which have been successfully verified will be removed
from this list below.
</p>
{!isValidating && (
<div className="mt-4 mb-2">
<Admonition
type="note"
title={
isNotVerifiedYet
? 'Unable to verify records from DNS provider yet.'
: 'Please note that it may take up to 24 hours for the DNS records to propagate.'
}
>
<p>
You may also visit{' '}
<InlineLink href={`https://whatsmydns.net/#TXT/${customDomain?.ssl.txt_name}`}>
here
</InlineLink>{' '}
to check if your DNS has been propagated successfully before clicking verify.
</p>
{isNotVerifiedYet && (
<p className="mt-1">
Some registrars will require you to remove the domain name when creating DNS
records. As an example, to create a record for{' '}
<code className="text-code-inline">foo.app.example.com</code>, you would need to
create an entry for <code className="text-code-inline">foo.app</code>.
</p>
)}
</Admonition>
</div>
)}
</div>
{hasCAAErrors && (
<Alert>
<WarningIcon />
<AlertTitle>Certificate Authority Authentication (CAA) error</AlertTitle>
<AlertDescription>
Please add a CAA record allowing "digicert.com" to issue certificates for{' '}
<code className="text-code-inline">{customDomain?.hostname}</code>. For example:{' '}
<code className="text-code-inline">0 issue "digicert.com"</code>
</AlertDescription>
</Alert>
)}
{customDomain?.ssl.status === 'validation_timed_out' ? (
<Alert>
<WarningIcon />
<AlertTitle>Validation timed out</AlertTitle>
<AlertDescription>
Please click "Verify" again to retry the validation of the records
</AlertDescription>
</Alert>
) : (
<div className="space-y-2">
<DNSTableHeaders display={customDomain?.ssl.txt_name ?? ''} />
{customDomain?.verification_errors?.includes(
'custom hostname does not CNAME to this zone.'
) && (
<DNSRecord
type="CNAME"
name={customDomain?.hostname}
value={settings?.app_config?.endpoint ?? 'Loading...'}
/>
)}
{!isValidating && customDomain?.ssl.status === 'pending_validation' && (
<DNSRecord
type="TXT"
name={customDomain?.ssl.txt_name ?? 'Loading...'}
value={customDomain?.ssl.txt_value ?? 'Loading...'}
/>
)}
{customDomain?.ssl.status === 'pending_deployment' && (
<div className="flex items-center justify-center space-x-2 py-8">
<AlertCircle size={16} strokeWidth={1.5} />
<p className="text-sm text-foreground-light">
SSL certificate is being deployed. Please wait a few minutes and try again.
</p>
</div>
)}
</div>
)}
</Panel.Content>
<div className="border-t border-muted" />
<Panel.Content>
<div className="flex items-center justify-between">
<DocsButton href={`${DOCS_URL}/guides/platform/custom-domains`} />
<div className="flex items-center space-x-2">
<Button
variant="default"
onClick={onCancelCustomDomain}
loading={isDeleting}
className="self-end"
>
Cancel
</Button>
<Button
icon={<RefreshCw />}
onClick={onReverifyCustomDomain}
loading={!isValidating && isReverifyLoading}
disabled={isDeleting || isReverifyLoading || isValidating}
className="self-end"
>
Verify
</Button>
</div>
</div>
</Panel.Content>
</>
)
}