Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Changed the email template editor to edit one language at a time

Damian Legawiec89bac75999e2
diff --git a/packages/dashboard/src/components/spree/email-templates/preview-card.tsx b/packages/dashboard/src/components/spree/email-templates/preview-card.tsx
index 2cdfed3ab1..a182e38766 100644
--- a/packages/dashboard/src/components/spree/email-templates/preview-card.tsx
+++ b/packages/dashboard/src/components/spree/email-templates/preview-card.tsx
@@ -199,7 +199,8 @@ export function EmailTemplatePreviewCard({
/** Which email a layout or partial is previewed inside. */
function ShownInField({ preview }: { preview: LivePreview }) {
const { t } = useTranslation()
- const { data: templates } = useEmailTemplates()
+ const { defaultLocale } = useStore()
+ const { data: templates } = useEmailTemplates(defaultLocale)
const emailOptions = (templates?.data ?? [])
.filter((entry) => entry.kind === 'email')
.map((entry) => ({ value: entry.id, label: emailTemplateName(t, entry.key) }))
diff --git a/packages/dashboard/src/hooks/use-email-templates.ts b/packages/dashboard/src/hooks/use-email-templates.ts
index b762068d18..922d3def18 100644
--- a/packages/dashboard/src/hooks/use-email-templates.ts
+++ b/packages/dashboard/src/hooks/use-email-templates.ts
@@ -26,7 +26,7 @@ export function templateProblems(error: unknown): EmailTemplateProblem[] {
return problems ?? [{ email: '', message: error.message }]
}
-export function useEmailTemplates(language = 'any') {
+export function useEmailTemplates(language: string) {
return useQuery({
queryKey: useResourceKey(RESOURCE, 'list', language),
queryFn: () => adminClient.emailTemplates.list({ language }),
diff --git a/packages/dashboard/src/locales/ar.json b/packages/dashboard/src/locales/ar.json
index f5821e6ee9..218867cbab 100644
--- a/packages/dashboard/src/locales/ar.json
+++ b/packages/dashboard/src/locales/ar.json
@@ -6218,7 +6218,8 @@
"restore_message": "تحل هذه النسخة محل المسودة. انشرها ليتلقاها العملاء.",
"leave_title": "المغادرة دون حفظ؟",
"leave_message": "ستفقد تغييراتك غير المحفوظة على هذا القالب.",
- "leave": "مغادرة"
+ "leave": "مغادرة",
+ "revert_every_language_message": "سيتلقى العملاء بكل اللغات من الآن رسالة Spree الافتراضية وستُحذف المسودة. تبقى النسخ المنشورة في السجل لتتمكن من استعادة إحداها لاحقًا."
},
"editor": {
"title": "القالب",
@@ -6226,9 +6227,6 @@
"body": "شيفرة القالب",
"language": "اللغة"
},
- "languages": {
- "any": "كل اللغات"
- },
"preview": {
"title": "معاينة",
"frame_title": "معاينة الرسالة",
@@ -6305,6 +6303,9 @@
"load_failed": "تعذر تحميل قوالب الرسائل",
"not_allowed": "ليست لديك صلاحية عرض قوالب الرسائل",
"test_email_failed": "تعذر إرسال الرسالة التجريبية"
+ },
+ "every_language": {
+ "notice": "يتلقى العملاء بكل اللغات هذه النسخة حتى تنشر نسخة باللغة {{language}}."
}
}
}
diff --git a/packages/dashboard/src/locales/de.json b/packages/dashboard/src/locales/de.json
index 2dd5ccfcc2..13238804fe 100644
--- a/packages/dashboard/src/locales/de.json
+++ b/packages/dashboard/src/locales/de.json
@@ -6178,7 +6178,8 @@
"restore_message": "Diese Version ersetzt den Entwurf. Veröffentlichen Sie sie, damit Kunden sie erhalten.",
"leave_title": "Ohne Speichern verlassen?",
"leave_message": "Ihre ungespeicherten Änderungen an dieser Vorlage gehen verloren.",
- "leave": "Verlassen"
+ "leave": "Verlassen",
+ "revert_every_language_message": "Kunden in allen Sprachen erhalten ab sofort die Standard-E-Mail von Spree und der Entwurf wird gelöscht. Veröffentlichte Versionen bleiben im Verlauf, sodass Sie eine später wiederherstellen können."
},
"editor": {
"title": "Vorlage",
@@ -6186,9 +6187,6 @@
"body": "Vorlagencode",
"language": "Sprache"
},
- "languages": {
- "any": "Alle Sprachen"
- },
"preview": {
"title": "Vorschau",
"frame_title": "E-Mail-Vorschau",
@@ -6265,6 +6263,9 @@
"load_failed": "E-Mail-Vorlagen konnten nicht geladen werden",
"not_allowed": "Sie dürfen E-Mail-Vorlagen nicht ansehen",
"test_email_failed": "Die Test-E-Mail konnte nicht gesendet werden"
+ },
+ "every_language": {
+ "notice": "Kunden in allen Sprachen erhalten diese Version, bis Sie eine für {{language}} veröffentlichen."
}
}
}
diff --git a/packages/dashboard/src/locales/en.json b/packages/dashboard/src/locales/en.json
index 56d44a93c6..80348b11b0 100644
--- a/packages/dashboard/src/locales/en.json
+++ b/packages/dashboard/src/locales/en.json
@@ -6178,7 +6178,8 @@
"restore_message": "This version replaces the draft. Publish it for customers to receive it.",
"leave_title": "Leave without saving?",
"leave_message": "Your unsaved changes to this template will be lost.",
- "leave": "Leave"
+ "leave": "Leave",
+ "revert_every_language_message": "Customers in every language receive Spree's default email from now on and the draft is deleted. Published versions stay in the history, so you can restore one later."
},
"editor": {
"title": "Template",
@@ -6186,9 +6187,6 @@
"body": "Template code",
"language": "Language"
},
- "languages": {
- "any": "All languages"
- },
"preview": {
"title": "Preview",
"frame_title": "Email preview",
@@ -6265,6 +6263,9 @@
"load_failed": "Couldn't load email templates",
"not_allowed": "You don't have permission to view email templates",
"test_email_failed": "Couldn't send the test email"
+ },
+ "every_language": {
+ "notice": "Customers in every language receive this version until you publish one for {{language}}."
}
}
}
diff --git a/packages/dashboard/src/locales/es.json b/packages/dashboard/src/locales/es.json
index 37ce3b3af9..689f08252b 100644
--- a/packages/dashboard/src/locales/es.json
+++ b/packages/dashboard/src/locales/es.json
@@ -6178,7 +6178,8 @@
"restore_message": "Esta versión reemplaza el borrador. Publícala para que la reciban los clientes.",
"leave_title": "¿Salir sin guardar?",
"leave_message": "Se perderán los cambios sin guardar de esta plantilla.",
- "leave": "Salir"
+ "leave": "Salir",
+ "revert_every_language_message": "A partir de ahora los clientes de todos los idiomas reciben el correo predeterminado de Spree y se elimina el borrador. Las versiones publicadas quedan en el historial para restaurarlas más tarde."
},
"editor": {
"title": "Plantilla",
@@ -6186,9 +6187,6 @@
"body": "Código de la plantilla",
"language": "Idioma"
},
- "languages": {
- "any": "Todos los idiomas"
- },
"preview": {
"title": "Vista previa",
"frame_title": "Vista previa del correo",
@@ -6265,6 +6263,9 @@
"load_failed": "No se pudieron cargar las plantillas de correo",
"not_allowed": "No tienes permiso para ver las plantillas de correo",
"test_email_failed": "No se pudo enviar el correo de prueba"
+ },
+ "every_language": {
+ "notice": "Los clientes de todos los idiomas reciben esta versión hasta que publiques una para {{language}}."
}
}
}
diff --git a/packages/dashboard/src/locales/fr.json b/packages/dashboard/src/locales/fr.json
index aeea710f2a..57f2a29ad1 100644
--- a/packages/dashboard/src/locales/fr.json
+++ b/packages/dashboard/src/locales/fr.json
@@ -6178,7 +6178,8 @@
"restore_message": "Cette version remplace le brouillon. Publiez-la pour que les clients la reçoivent.",
"leave_title": "Quitter sans enregistrer ?",
"leave_message": "Vos modifications non enregistrées de ce modèle seront perdues.",
- "leave": "Quitter"
+ "leave": "Quitter",
+ "revert_every_language_message": "Les clients de toutes les langues reçoivent désormais l'e-mail par défaut de Spree et le brouillon est supprimé. Les versions publiées restent dans l'historique pour être restaurées plus tard."
},
"editor": {
"title": "Modèle",
@@ -6186,9 +6187,6 @@
"body": "Code du modèle",
"language": "Langue"
},
- "languages": {
- "any": "Toutes les langues"
- },
"preview": {
"title": "Aperçu",
"frame_title": "Aperçu de l'e-mail",
@@ -6265,6 +6263,9 @@
"load_failed": "Impossible de charger les modèles d'e-mail",
"not_allowed": "Vous n'avez pas l'autorisation de voir les modèles d'e-mail",
"test_email_failed": "Impossible d'envoyer l'e-mail de test"
+ },
+ "every_language": {
+ "notice": "Les clients de toutes les langues reçoivent cette version jusqu'à ce que vous en publiiez une pour {{language}}."
}
}
}
diff --git a/packages/dashboard/src/locales/pl.json b/packages/dashboard/src/locales/pl.json
index 894ba3c633..08eb22dddb 100644
--- a/packages/dashboard/src/locales/pl.json
+++ b/packages/dashboard/src/locales/pl.json
@@ -6246,7 +6246,8 @@
"restore_message": "Ta wersja zastąpi szkic. Opublikuj ją, aby otrzymali ją klienci.",
"leave_title": "Wyjść bez zapisywania?",
"leave_message": "Niezapisane zmiany w tym szablonie zostaną utracone.",
- "leave": "Wyjdź"
+ "leave": "Wyjdź",
+ "revert_every_language_message": "Od teraz klienci we wszystkich językach otrzymują domyślny e-mail Spree, a szkic zostanie usunięty. Opublikowane wersje zostają w historii, więc możesz później przywrócić jedną z nich."
},
"editor": {
"title": "Szablon",
@@ -6254,9 +6255,6 @@
"body": "Kod szablonu",
"language": "Język"
},
- "languages": {
- "any": "Wszystkie języki"
- },
"preview": {
"title": "Podgląd",
"frame_title": "Podgląd e-maila",
@@ -6333,6 +6331,9 @@
"load_failed": "Nie udało się wczytać szablonów e-maili",
"not_allowed": "Nie masz uprawnień do przeglądania szablonów e-maili",
"test_email_failed": "Nie udało się wysłać testowego e-maila"
+ },
+ "every_language": {
+ "notice": "Klienci we wszystkich językach otrzymują tę wersję, dopóki nie opublikujesz wersji dla języka {{language}}."
}
}
}
diff --git a/packages/dashboard/src/locales/zh-CN.json b/packages/dashboard/src/locales/zh-CN.json
index f05bdbf871..8d198fe26b 100644
--- a/packages/dashboard/src/locales/zh-CN.json
+++ b/packages/dashboard/src/locales/zh-CN.json
@@ -6165,7 +6165,8 @@
"restore_message": "此版本将替换草稿。发布后客户才会收到。",
"leave_title": "不保存就离开?",
"leave_message": "您对此模板未保存的更改将会丢失。",
- "leave": "离开"
+ "leave": "离开",
+ "revert_every_language_message": "从现在起所有语言的客户都将收到 Spree 的默认邮件,草稿将被删除。已发布的版本保留在历史记录中,以后可以恢复。"
},
"editor": {
"title": "模板",
@@ -6173,9 +6174,6 @@
"body": "模板代码",
"language": "语言"
},
- "languages": {
- "any": "所有语言"
- },
"preview": {
"title": "预览",
"frame_title": "邮件预览",
@@ -6252,6 +6250,9 @@
"load_failed": "无法加载邮件模板",
"not_allowed": "您没有查看邮件模板的权限",
"test_email_failed": "无法发送测试邮件"
+ },
+ "every_language": {
+ "notice": "在您为{{language}}发布版本之前,所有语言的客户都会收到此版本。"
}
}
}
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/$templateId.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/$templateId.tsx
index d86b8320c8..97da1492b2 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/$templateId.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/$templateId.tsx
@@ -71,14 +71,16 @@ export const Route = createFileRoute(
component: EmailTemplateEditorPage,
})
-const ANY_LANGUAGE = 'any'
+/** A version an earlier store published for every language at once. */
+const EVERY_LANGUAGE = 'any'
function EmailTemplateEditorPage() {
const { t } = useTranslation()
const { templateId } = Route.useParams()
const { permissions } = usePermissions()
const canRead = permissions.can('read', Subject.EmailTemplate)
- const [language, setLanguage] = useState(ANY_LANGUAGE)
+ const { defaultLocale } = useStore()
+ const [language, setLanguage] = useState(defaultLocale)
const [reloads, setReloads] = useState(0)
const {
data: template,
@@ -196,7 +198,11 @@ function EmailTemplateEditor({
const revert = useRevertEmailTemplate(template.id)
const restore = useRestoreEmailTemplateRevision(template.id)
const sendTest = useSendTestEmail(template.id)
- const revisions = useEmailTemplateRevisions(template.id, language, historyOpen)
+ // Until this language has its own version, revert and history act on the
+ // one published for every language, which is what customers receive.
+ const forEveryLanguage = template.published_language === EVERY_LANGUAGE
+ const versionLanguage = forEveryLanguage ? EVERY_LANGUAGE : language
+ const revisions = useEmailTemplateRevisions(template.id, versionLanguage, historyOpen)
/**
* Takes the server's version after a write. With `sent`, text typed while
@@ -288,11 +294,13 @@ function EmailTemplateEditor({
confirmAndApply(
{
title: t('admin.email_templates.confirm.revert_title'),
- message: t('admin.email_templates.confirm.revert_message'),
+ message: forEveryLanguage
+ ? t('admin.email_templates.confirm.revert_every_language_message')
+ : t('admin.email_templates.confirm.revert_message'),
confirmLabel: t('admin.email_templates.actions.revert'),
variant: 'destructive',
},
- () => revert.mutateAsync({ language, lock_version: lockVersion }),
+ () => revert.mutateAsync({ language: versionLanguage, lock_version: lockVersion }),
)
const handleRestore = async (revisionId: string) => {
@@ -303,7 +311,8 @@ function EmailTemplateEditor({
confirmLabel: t('admin.email_templates.history.restore'),
variant: dirty ? 'destructive' : 'default',
},
- () => restore.mutateAsync({ revisionId, language, lock_version: lockVersion }),
+ () =>
+ restore.mutateAsync({ revisionId, language: versionLanguage, lock_version: lockVersion }),
)
if (restored) setHistoryOpen(false)
}
@@ -439,6 +448,8 @@ function EmailTemplateEditor({
</Alert>
)}
+ {forEveryLanguage && <EveryLanguageNotice language={language} />}
+
{shownProblems.length > 0 && <EmailTemplateProblemsAlert problems={shownProblems} />}
<div className="grid gap-4 xl:grid-cols-2">
@@ -555,10 +566,7 @@ function LanguageSelect({
const { t } = useTranslation()
const { locales } = useStore()
const languageName = useDisplayName('language')
- const options = [
- { value: ANY_LANGUAGE, label: t('admin.email_templates.languages.any') },
- ...locales.map((code) => ({ value: code, label: languageName(code) ?? code })),
- ]
+ const options = locales.map((code) => ({ value: code, label: languageName(code) ?? code }))
return (
<Select
@@ -580,3 +588,18 @@ function LanguageSelect({
</Select>
)
}
+
+function EveryLanguageNotice({ language }: { language: string }) {
+ const { t } = useTranslation()
+ const languageName = useDisplayName('language')
+
+ return (
+ <Alert variant="info">
+ <AlertDescription>
+ {t('admin.email_templates.every_language.notice', {
+ language: languageName(language) ?? language,
+ })}
+ </AlertDescription>
+ </Alert>
+ )
+}
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/index.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/index.tsx
index 0c0b481bc7..2dbd9feef7 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/index.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/index.tsx
@@ -1,5 +1,5 @@
import type { EmailTemplate } from '@spree/admin-sdk'
-import { PageHeader, Subject, usePermissions } from '@spree/dashboard-core'
+import { PageHeader, Subject, usePermissions, useStore } from '@spree/dashboard-core'
import {
Badge,
Card,
@@ -27,7 +27,8 @@ const GROUPS = ['email', 'layout', 'partial'] as const
function EmailTemplatesPage() {
const { t } = useTranslation()
const { permissions } = usePermissions()
- const { data, isLoading, error, refetch } = useEmailTemplates()
+ const { defaultLocale } = useStore()
+ const { data, isLoading, error, refetch } = useEmailTemplates(defaultLocale)
if (!permissions.can('read', Subject.EmailTemplate)) {
return <ErrorState title={t('admin.email_templates.errors.not_allowed')} />
@@ -130,7 +131,7 @@ function TemplateBadges({ template }: { template: EmailTemplate }) {
<Badge variant="warning">{t('admin.email_templates.badges.default_updated')}</Badge>
)}
{template.draft && <Badge variant="info">{t('admin.email_templates.badges.draft')}</Badge>}
- {template.customized_languages.length > 0 ? (
+ {template.customized ? (
<Badge variant="success">{t('admin.email_templates.badges.customized')}</Badge>
) : (
<Badge variant="outline">{t('admin.email_templates.badges.default')}</Badge>