mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
Gildas Garcia
c6067a1a19
## Problem We currently have 2 libraries for schema validation: `yup` that was used with `formik` and `zod` which is now the preferred one. ## Solution - Migrate to `zod` - Fix validation isn't applied on email template form - Fix `react-hook-form` form state usage No visual changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Refactor** * Switched form validation to a unified Zod-based approach across authentication UIs. * **Improvements** * Template editor and email templates now validate via provided Zod schemas. * SMTP and captcha settings receive conditional validation, improved numeric handling, and clearer required-field behavior. * Validation import/style consistency tidied. * **Bug Fixes** * Consistent dirty-state detection so Save/Cancel visibility and enabled/disabled behavior are reliable across auth forms. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
437 lines
13 KiB
TypeScript
437 lines
13 KiB
TypeScript
import * as z from 'zod'
|
|
|
|
import type { FormSchema } from '@/types'
|
|
|
|
const JSON_SCHEMA_VERSION = 'http://json-schema.org/draft-07/schema#'
|
|
|
|
const CONFIRMATION: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'CONFIRMATION',
|
|
type: 'object',
|
|
title: 'Confirm sign up',
|
|
purpose: 'Ask users to confirm their email address after signing up',
|
|
properties: {
|
|
MAILER_SUBJECTS_CONFIRMATION: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_CONFIRMATION_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .ConfirmationURL }}\` : URL to confirm the email address for the new account
|
|
- \`{{ .Token }}\` : The 6-digit numeric email OTP
|
|
- \`{{ .TokenHash }}\` : The hashed token used in the URL
|
|
- \`{{ .SiteURL }}\` : The URL of the site
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
- \`{{ .RedirectTo }}\` : The URL of \`emailRedirectTo\` passed in options
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_CONFIRMATION: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'authentication',
|
|
},
|
|
}
|
|
|
|
const INVITE: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'INVITE',
|
|
type: 'object',
|
|
title: 'Invite user',
|
|
purpose: "Invite users who don't yet have an account to sign up",
|
|
properties: {
|
|
MAILER_SUBJECTS_INVITE: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_INVITE_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .ConfirmationURL }}\` : URL to accept the invitation to create an account
|
|
- \`{{ .Token }}\` : The 6-digit numeric email OTP
|
|
- \`{{ .TokenHash }}\` : The hashed token used in the URL
|
|
- \`{{ .SiteURL }}\` : The URL of the site
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
- \`{{ .RedirectTo }}\` : The URL of \`redirectTo\` passed in options
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_INVITE: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'authentication',
|
|
},
|
|
}
|
|
|
|
const MAGIC_LINK: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'MAGIC_LINK',
|
|
type: 'object',
|
|
title: 'Magic link',
|
|
purpose: 'Allow users to sign in via a one-time link sent to their email',
|
|
properties: {
|
|
MAILER_SUBJECTS_MAGIC_LINK: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_MAGIC_LINK_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .ConfirmationURL }}\` : URL for a one-time login to the user's account
|
|
- \`{{ .Token }}\` : The 6-digit numeric email OTP
|
|
- \`{{ .TokenHash }}\` : The hashed token used in the URL
|
|
- \`{{ .SiteURL }}\` : The URL of the site
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
- \`{{ .RedirectTo }}\` : The URL of \`emailRedirectTo\` passed in options
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_MAGIC_LINK: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'authentication',
|
|
},
|
|
}
|
|
|
|
const EMAIL_CHANGE: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'EMAIL_CHANGE',
|
|
type: 'object',
|
|
title: 'Change email address',
|
|
purpose: 'Ask users to verify their new email address after changing it',
|
|
properties: {
|
|
MAILER_SUBJECTS_EMAIL_CHANGE: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .ConfirmationURL }}\` : URL to confirm the email change
|
|
- \`{{ .Token }}\` : The 6-digit numeric email OTP
|
|
- \`{{ .TokenHash }}\` : The hashed token used in the URL
|
|
- \`{{ .SiteURL }}\` : The URL of the site
|
|
- \`{{ .Email }}\` : The original user's email address
|
|
- \`{{ .NewEmail }}\` : The user's new email address
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
- \`{{ .RedirectTo }}\` : The URL of \`emailRedirectTo\` passed in options
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_EMAIL_CHANGE: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'authentication',
|
|
},
|
|
}
|
|
|
|
const RECOVERY: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'RECOVERY',
|
|
type: 'object',
|
|
title: 'Reset password',
|
|
purpose: 'Allow users to reset their password if they forget it',
|
|
properties: {
|
|
MAILER_SUBJECTS_RECOVERY: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_RECOVERY_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .ConfirmationURL }}\` : URL to confirm the password reset
|
|
- \`{{ .Token }}\` : The 6-digit numeric email OTP
|
|
- \`{{ .TokenHash }}\` : The hashed token used in the URL
|
|
- \`{{ .SiteURL }}\` : The URL of the site
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
- \`{{ .RedirectTo }}\` : The URL of \`redirectTo\` passed in options
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_RECOVERY: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'authentication',
|
|
},
|
|
}
|
|
const REAUTHENTICATION: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'REAUTHENTICATION',
|
|
type: 'object',
|
|
title: 'Reauthentication',
|
|
purpose: 'Ask users to re-authenticate before performing a sensitive action',
|
|
properties: {
|
|
MAILER_SUBJECTS_REAUTHENTICATION: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_REAUTHENTICATION_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .Token }}\` : The 6-digit numeric email OTP
|
|
- \`{{ .SiteURL }}\` : The URL of the site
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_REAUTHENTICATION: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'authentication',
|
|
},
|
|
}
|
|
|
|
// Notifications
|
|
const PASSWORD_CHANGED_NOTIFICATION: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'PASSWORD_CHANGED_NOTIFICATION',
|
|
type: 'object',
|
|
title: 'Password changed',
|
|
purpose: 'Notify users when their password has changed',
|
|
properties: {
|
|
MAILER_SUBJECTS_PASSWORD_CHANGED_NOTIFICATION: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_PASSWORD_CHANGED_NOTIFICATION_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_PASSWORD_CHANGED_NOTIFICATION: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'security',
|
|
},
|
|
}
|
|
|
|
const EMAIL_CHANGED_NOTIFICATION: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'EMAIL_CHANGED_NOTIFICATION',
|
|
type: 'object',
|
|
title: 'Email address changed',
|
|
purpose: 'Notify users when their email address has changed',
|
|
properties: {
|
|
MAILER_SUBJECTS_EMAIL_CHANGED_NOTIFICATION: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_EMAIL_CHANGED_NOTIFICATION_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .Email }}\` : The user's new email address
|
|
- \`{{ .OldEmail }}\` : The user's old email address
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_EMAIL_CHANGED_NOTIFICATION: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'security',
|
|
},
|
|
}
|
|
|
|
const PHONE_CHANGED_NOTIFICATION: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'PHONE_CHANGED_NOTIFICATION',
|
|
type: 'object',
|
|
title: 'Phone number changed',
|
|
purpose: 'Notify users when their phone number has changed',
|
|
properties: {
|
|
MAILER_SUBJECTS_PHONE_CHANGED_NOTIFICATION: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_PHONE_CHANGED_NOTIFICATION_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .Phone }}\` : The user's new phone number
|
|
- \`{{ .OldPhone }}\` : The user's old phone number
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_PHONE_CHANGED_NOTIFICATION: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'security',
|
|
},
|
|
}
|
|
|
|
const IDENTITY_LINKED_NOTIFICATION: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'IDENTITY_LINKED_NOTIFICATION',
|
|
type: 'object',
|
|
title: 'Identity linked',
|
|
purpose: 'Notify users when a new identity has been linked to their account',
|
|
properties: {
|
|
MAILER_SUBJECTS_IDENTITY_LINKED_NOTIFICATION: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_IDENTITY_LINKED_NOTIFICATION_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .Provider }}\` : The provider of the newly linked identity
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_IDENTITY_LINKED_NOTIFICATION: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'security',
|
|
},
|
|
}
|
|
|
|
const IDENTITY_UNLINKED_NOTIFICATION: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'IDENTITY_UNLINKED_NOTIFICATION',
|
|
type: 'object',
|
|
title: 'Identity unlinked',
|
|
purpose: 'Notify users when an identity has been unlinked from their account',
|
|
properties: {
|
|
MAILER_SUBJECTS_IDENTITY_UNLINKED_NOTIFICATION: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_IDENTITY_UNLINKED_NOTIFICATION_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .Provider }}\` : The provider of the unlinked identity
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_IDENTITY_UNLINKED_NOTIFICATION: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'security',
|
|
},
|
|
}
|
|
|
|
const MFA_FACTOR_ENROLLED_NOTIFICATION: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'MFA_FACTOR_ENROLLED_NOTIFICATION',
|
|
type: 'object',
|
|
title: 'Multi-factor authentication method added',
|
|
purpose:
|
|
'Notify users when a new multi-factor authentication method has been added to their account',
|
|
properties: {
|
|
MAILER_SUBJECTS_MFA_FACTOR_ENROLLED_NOTIFICATION: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_MFA_FACTOR_ENROLLED_NOTIFICATION_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .FactorType }}\` : The type of the newly enrolled MFA factor
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_MFA_FACTOR_ENROLLED_NOTIFICATION: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'security',
|
|
},
|
|
}
|
|
|
|
const MFA_FACTOR_UNENROLLED_NOTIFICATION: FormSchema = {
|
|
$schema: JSON_SCHEMA_VERSION,
|
|
id: 'MFA_FACTOR_UNENROLLED_NOTIFICATION',
|
|
type: 'object',
|
|
title: 'Multi-factor authentication method removed',
|
|
purpose:
|
|
'Notify users when a multi-factor authentication method has been removed from their account',
|
|
properties: {
|
|
MAILER_SUBJECTS_MFA_FACTOR_UNENROLLED_NOTIFICATION: {
|
|
title: 'Subject',
|
|
type: 'string',
|
|
},
|
|
MAILER_TEMPLATES_MFA_FACTOR_UNENROLLED_NOTIFICATION_CONTENT: {
|
|
title: 'Body',
|
|
descriptionOptional: 'HTML body of your email',
|
|
type: 'code',
|
|
description: `
|
|
- \`{{ .Email }}\` : The user's email address
|
|
- \`{{ .FactorType }}\` : The type of the newly enrolled MFA factor
|
|
- \`{{ .Data }}\` : The user's \`user_metadata\`
|
|
`,
|
|
},
|
|
},
|
|
validationSchema: z.object({
|
|
MAILER_SUBJECTS_MFA_FACTOR_UNENROLLED_NOTIFICATION: z.string().min(1, 'Subject is required.'),
|
|
}),
|
|
misc: {
|
|
emailTemplateType: 'security',
|
|
},
|
|
}
|
|
|
|
export const TEMPLATES_SCHEMAS = [
|
|
CONFIRMATION,
|
|
INVITE,
|
|
MAGIC_LINK,
|
|
EMAIL_CHANGE,
|
|
RECOVERY,
|
|
REAUTHENTICATION,
|
|
// Notifications
|
|
PASSWORD_CHANGED_NOTIFICATION,
|
|
EMAIL_CHANGED_NOTIFICATION,
|
|
PHONE_CHANGED_NOTIFICATION,
|
|
IDENTITY_LINKED_NOTIFICATION,
|
|
IDENTITY_UNLINKED_NOTIFICATION,
|
|
MFA_FACTOR_ENROLLED_NOTIFICATION,
|
|
MFA_FACTOR_UNENROLLED_NOTIFICATION,
|
|
]
|