mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
## What kind of change does this PR introduce? Feature. Resolves AUTH-879. ## What is the current behavior? Studio does not provide a way to reset an Auth email template back to the default subject and body once it has been customised. ## What is the new behavior? Studio shows a `Reset template` action when Platform reports that the selected Auth email template subject or body has been customised. The action opens a confirmation dialog, calls the dedicated Platform reset endpoint, and refreshes the editor with the default subject and body returned by the API. The Auth config save/reset mutations now run their user-facing success handling before refreshing Auth lint data, so the success toast and local editor cleanup are not delayed by lint refetches. ## Additional context Depends on supabase/platform#32417. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Reset email templates to defaults via a confirmation dialog; button appears when custom content is detected and respects update permissions. * Typed email-template definitions and improved template variable display and descriptions. * **Tests** * Added tests covering template reset visibility, confirmation flow, state updates, permission handling, and toast notifications. * **Documentation** * Example email template placeholders updated for internationalization and provider snippets. <!-- review_stack_entry_start --> [](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/45572) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
90 lines
2.8 KiB
TypeScript
90 lines
2.8 KiB
TypeScript
import { PermissionAction } from '@supabase/shared-types/out/constants'
|
|
import { useParams } from 'common'
|
|
import { useState } from 'react'
|
|
import { toast } from 'sonner'
|
|
import {
|
|
AlertDialog,
|
|
AlertDialogCancel,
|
|
AlertDialogContent,
|
|
AlertDialogDescription,
|
|
AlertDialogFooter,
|
|
AlertDialogHeader,
|
|
AlertDialogTitle,
|
|
AlertDialogTrigger,
|
|
Button,
|
|
} from 'ui'
|
|
|
|
import { type AuthTemplate } from './EmailTemplates.types'
|
|
import { getAuthTemplateType } from './EmailTemplates.utils'
|
|
import { AuthConfigResponse } from '@/data/auth/auth-config-query'
|
|
import { useAuthTemplateResetMutation } from '@/data/auth/auth-template-reset-mutation'
|
|
import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
|
|
|
|
export const ResetTemplateDialog = ({
|
|
template,
|
|
hasUnsavedChanges,
|
|
onResetSuccess,
|
|
}: {
|
|
template: AuthTemplate
|
|
hasUnsavedChanges: boolean
|
|
onResetSuccess: (config: AuthConfigResponse) => void
|
|
}) => {
|
|
const { ref: projectRef } = useParams()
|
|
const [open, setOpen] = useState(false)
|
|
const { can: canUpdateConfig } = useAsyncCheckPermissions(
|
|
PermissionAction.UPDATE,
|
|
'custom_config_gotrue'
|
|
)
|
|
|
|
const { id } = template
|
|
const templateType = getAuthTemplateType(id)
|
|
|
|
const { mutate: resetAuthTemplate, isPending: isResettingTemplate } =
|
|
useAuthTemplateResetMutation()
|
|
|
|
const resetTemplateToDefault = () => {
|
|
if (!projectRef) return console.error('Project ref is required')
|
|
if (!templateType) return console.error('Template type is required')
|
|
|
|
resetAuthTemplate(
|
|
{
|
|
projectRef,
|
|
template: templateType,
|
|
},
|
|
{
|
|
onSuccess: (config) => {
|
|
toast.success('Email template reset to default')
|
|
onResetSuccess(config)
|
|
setOpen(false)
|
|
},
|
|
}
|
|
)
|
|
}
|
|
|
|
return (
|
|
<AlertDialog open={open} onOpenChange={setOpen}>
|
|
<AlertDialogTrigger asChild>
|
|
<Button type="default" htmlType="button" disabled={!canUpdateConfig || isResettingTemplate}>
|
|
Reset template
|
|
</Button>
|
|
</AlertDialogTrigger>
|
|
<AlertDialogContent>
|
|
<AlertDialogHeader>
|
|
<AlertDialogTitle>Reset template to default</AlertDialogTitle>
|
|
<AlertDialogDescription>
|
|
{hasUnsavedChanges
|
|
? 'This will discard your unsaved changes and use the default subject line and email body content.'
|
|
: 'This will remove your custom subject line and email body content. The default values will be used instead.'}
|
|
</AlertDialogDescription>
|
|
</AlertDialogHeader>
|
|
<AlertDialogFooter>
|
|
<AlertDialogCancel disabled={isResettingTemplate}>Cancel</AlertDialogCancel>
|
|
<Button type="warning" onClick={resetTemplateToDefault} loading={isResettingTemplate}>
|
|
Reset
|
|
</Button>
|
|
</AlertDialogFooter>
|
|
</AlertDialogContent>
|
|
</AlertDialog>
|
|
)
|
|
}
|