feat: make MJML enabled flag translatable per language

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
+vendor/
 .idea/
 *.log
 .vite/

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "frosh/mjml",
     "description": "Compiles MJML email templates to HTML for Shopware mail sending",
-    "version": "1.0.3",
+    "version": "1.1.0",
     "type": "shopware-platform-plugin",
     "license": "MIT",
     "authors": [

src/Entity/MailTemplate/FroshMjmlMailTemplateDefinition.php

@@ -4,7 +4,6 @@
 
 use Shopware\Core\Content\MailTemplate\MailTemplateDefinition;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityDefinition;
-use Shopware\Core\Framework\DataAbstractionLayer\Field\BoolField;
 use Shopware\Core\Framework\DataAbstractionLayer\Field\FkField;
 use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\ApiAware;
 use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\PrimaryKey;
@@ -39,7 +38,7 @@ protected function defineFields(): FieldCollection
         return new FieldCollection([
             (new IdField('id', 'id'))->addFlags(new PrimaryKey(), new Required(), new ApiAware()),
             (new FkField('mail_template_id', 'mailTemplateId', MailTemplateDefinition::class))->addFlags(new Required(), new ApiAware()),
-            (new BoolField('enabled', 'enabled'))->addFlags(new ApiAware()),
+            (new TranslatedField('enabled'))->addFlags(new ApiAware()),
             (new TranslatedField('mjmlContent'))->addFlags(new ApiAware()),
             (new TranslationsAssociationField(FroshMjmlMailTemplateTranslationDefinition::class, 'frosh_mjml_mail_template_id'))->addFlags(new ApiAware(), new Required()),
             (new OneToOneAssociationField('mailTemplate', 'mail_template_id', 'id', MailTemplateDefinition::class, false))->addFlags(new ApiAware()),

src/Entity/MailTemplate/FroshMjmlMailTemplateEntity.php

@@ -12,7 +12,7 @@ class FroshMjmlMailTemplateEntity extends Entity
 
     protected string $mailTemplateId;
 
-    protected bool $enabled = false;
+    protected ?bool $enabled = null;
 
     protected ?string $mjmlContent = null;
 
@@ -30,12 +30,12 @@ public function setMailTemplateId(string $mailTemplateId): void
         $this->mailTemplateId = $mailTemplateId;
     }
 
-    public function isEnabled(): bool
+    public function getEnabled(): ?bool
     {
         return $this->enabled;
     }
 
-    public function setEnabled(bool $enabled): void
+    public function setEnabled(?bool $enabled): void
     {
         $this->enabled = $enabled;
     }

src/Entity/MailTemplate/FroshMjmlMailTemplateTranslationDefinition.php

@@ -3,6 +3,7 @@
 namespace Frosh\Mjml\Entity\MailTemplate;
 
 use Shopware\Core\Framework\DataAbstractionLayer\EntityTranslationDefinition;
+use Shopware\Core\Framework\DataAbstractionLayer\Field\BoolField;
 use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\AllowHtml;
 use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\ApiAware;
 use Shopware\Core\Framework\DataAbstractionLayer\Field\LongTextField;
@@ -37,6 +38,7 @@ protected function getParentDefinitionClass(): string
     protected function defineFields(): FieldCollection
     {
         return new FieldCollection([
+            (new BoolField('enabled', 'enabled'))->addFlags(new ApiAware()),
             (new LongTextField('mjml_content', 'mjmlContent'))->addFlags(new ApiAware(), new AllowHtml(false)),
         ]);
     }

src/Entity/MailTemplate/FroshMjmlMailTemplateTranslationEntity.php

@@ -10,6 +10,8 @@ class FroshMjmlMailTemplateTranslationEntity extends TranslationEntity
 
     protected ?FroshMjmlMailTemplateEntity $froshMjmlMailTemplate = null;
 
+    protected ?bool $enabled = null;
+
     protected ?string $mjmlContent = null;
 
     public function getFroshMjmlMailTemplateId(): string
@@ -32,6 +34,16 @@ public function setFroshMjmlMailTemplate(?FroshMjmlMailTemplateEntity $froshMjml
         $this->froshMjmlMailTemplate = $froshMjmlMailTemplate;
     }
 
+    public function getEnabled(): ?bool
+    {
+        return $this->enabled;
+    }
+
+    public function setEnabled(?bool $enabled): void
+    {
+        $this->enabled = $enabled;
+    }
+
     public function getMjmlContent(): ?string
     {
         return $this->mjmlContent;

src/Listener/MailBeforeValidateListener.php

@@ -42,7 +42,7 @@ public function onMailBeforeValidate(MailBeforeValidateEvent $event): void
 
         /** @var FroshMjmlMailTemplateEntity|null $config */
         $config = $mailTemplate?->getExtension('froshMjml');
-        if ($config === null || !$config->isEnabled()) {
+        if ($config === null || $config->getTranslation('enabled') !== true) {
             return;
         }
 

src/Migration/Migration1784619412TranslatableEnabled.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types=1);
+
+namespace Frosh\Mjml\Migration;
+
+use Doctrine\DBAL\Connection;
+use Shopware\Core\Defaults;
+use Shopware\Core\Framework\Migration\MigrationStep;
+use Shopware\Core\Framework\Uuid\Uuid;
+
+class Migration1784619412TranslatableEnabled extends MigrationStep
+{
+    public function getCreationTimestamp(): int
+    {
+        return 1784619412;
+    }
+
+    public function update(Connection $connection): void
+    {
+        $connection->executeStatement('
+            ALTER TABLE `frosh_mjml_mail_template_translation`
+            ADD COLUMN `enabled` TINYINT(1) NULL AFTER `language_id`
+        ');
+
+        $connection->executeStatement('
+            INSERT INTO `frosh_mjml_mail_template_translation`
+                (`frosh_mjml_mail_template_id`, `language_id`, `enabled`, `created_at`)
+            SELECT `id`, :languageId, `enabled`, NOW(3)
+            FROM `frosh_mjml_mail_template`
+            WHERE `enabled` = 1
+            ON DUPLICATE KEY UPDATE `enabled` = VALUES(`enabled`)
+        ', ['languageId' => Uuid::fromHexToBytes(Defaults::LANGUAGE_SYSTEM)]);
+    }
+
+    public function updateDestructive(Connection $connection): void
+    {
+        $columns = $connection->fetchAllAssociative('SHOW COLUMNS FROM `frosh_mjml_mail_template` LIKE \'enabled\'');
+        if ($columns === []) {
+            return;
+        }
+
+        $connection->executeStatement('ALTER TABLE `frosh_mjml_mail_template` DROP COLUMN `enabled`');
+    }
+}

src/Resources/app/administration/src/overrides/sw-mail-template-detail/index.js

@@ -11,28 +11,65 @@ const { Criteria } = Shopware.Data;
 Component.override('sw-mail-template-detail', {
     template,
 
+    data() {
+        return {
+            froshMjmlHasParentLanguage: false,
+            froshMjmlInheritedEnabled: null,
+        };
+    },
+
+    computed: {
+        froshMjmlConfig() {
+            return this.mailTemplate?.extensions?.froshMjml ?? null;
+        },
+
+        froshMjmlEnabled() {
+            const config = this.froshMjmlConfig;
+            if (!config) {
+                return false;
+            }
+
+            if (config.enabled !== null && config.enabled !== undefined) {
+                return config.enabled;
+            }
+
+            return (
+                this.froshMjmlInheritedEnabled ??
+                config.translated?.enabled ??
+                false
+            );
+        },
+    },
+
     watch: {
-        'mailTemplate.id': {
+        mailTemplate: {
             immediate: true,
             handler() {
-                if (
-                    this.mailTemplate &&
-                    !this.mailTemplate.extensions.froshMjml
-                ) {
+                if (!this.mailTemplate?.id) {
+                    return;
+                }
+
+                if (!this.mailTemplate.extensions.froshMjml) {
                     const config = this.repositoryFactory
                         .create('frosh_mjml_mail_template')
                         .create(Shopware.Context.api);
-                    config.enabled = false;
                     config.mjmlContent = '';
                     this.mailTemplate.extensions.froshMjml = config;
                 }
+
+                this.loadFroshMjmlInheritance();
             },
         },
 
         async 'mailTemplate.extensions.froshMjml.enabled'(enabled) {
-            const config = this.mailTemplate?.extensions?.froshMjml;
+            const config = this.froshMjmlConfig;
 
-            if (!enabled || !config || config.mjmlContent) {
+            if (
+                !enabled ||
+                !config ||
+                config.mjmlContent ||
+                config.translated?.mjmlContent
+            ) {
                 return;
             }
 
@@ -41,11 +78,37 @@ Component.override('sw-mail-template-detail', {
     },
 
     methods: {
-        onMjmlToggle(value) {
-            const config = this.mailTemplate?.extensions?.froshMjml;
-            if (config) {
-                config.enabled = value;
+        async loadFroshMjmlInheritance() {
+            const { languageId, systemLanguageId } = Shopware.Context.api;
+            this.froshMjmlHasParentLanguage = languageId !== systemLanguageId;
+
+            if (!this.froshMjmlHasParentLanguage) {
+                this.froshMjmlInheritedEnabled = null;
+                return;
             }
+
+            const language = await this.repositoryFactory
+                .create('language')
+                .get(languageId, Shopware.Context.api);
+
+            const criteria = new Criteria(1, 1);
+            criteria.addFilter(
+                Criteria.equals('mailTemplateId', this.mailTemplate.id)
+            );
+
+            const inheritedLanguageContext = {
+                ...Shopware.Context.api,
+                languageId: language?.parentId ?? systemLanguageId,
+            };
+
+            const config = (
+                await this.repositoryFactory
+                    .create('frosh_mjml_mail_template')
+                    .search(criteria, inheritedLanguageContext)
+            ).first();
+
+            this.froshMjmlInheritedEnabled =
+                config?.translated?.enabled ?? config?.enabled ?? false;
         },
 
         async buildInitialMjmlContent() {

src/Resources/app/administration/src/overrides/sw-mail-template-detail/sw-mail-template-detail.html.twig

@@ -1,15 +1,28 @@
 {% block sw_mail_template_mail_text_form_content_html_field %}
-<mt-switch
+<sw-inherit-wrapper
     v-if="mailTemplate.extensions.froshMjml"
+    v-model:value="mailTemplate.extensions.froshMjml.enabled"
     class="sw-mail-template-detail__mjml-toggle"
-    :label="$tc('frosh-mjml-component.editor.useMjml')"
-    :checked="mailTemplate.extensions.froshMjml.enabled"
-    :disabled="!acl.can('mail_templates.editor')"
-    @change="onMjmlToggle"
-/>
+    :has-parent="froshMjmlHasParentLanguage"
+    :inherited-value="froshMjmlInheritedEnabled"
+>
+    <template #content="props">
+        <mt-switch
+            :label="$tc('frosh-mjml-component.editor.useMjml')"
+            :is-inheritance-field="props.isInheritField"
+            :is-inherited="props.isInherited"
+            :inherited-value="!!froshMjmlInheritedEnabled"
+            :disabled="!acl.can('mail_templates.editor')"
+            :model-value="!!props.currentValue"
+            @update:model-value="props.updateCurrentValue"
+            @inheritance-restore="props.restoreInheritance"
+            @inheritance-remove="props.removeInheritance"
+        />
+    </template>
+</sw-inherit-wrapper>
 
 <frosh-mjml-editor
-    v-if="mailTemplate.extensions.froshMjml && mailTemplate.extensions.froshMjml.enabled"
+    v-if="mailTemplate.extensions.froshMjml && froshMjmlEnabled"
     :key="`${mailTemplate.mailTemplateTypeId}mjml`"
     v-model:value="mailTemplate.extensions.froshMjml.mjmlContent"
     class="sw-mail-template-detail__html-editor"
@@ -20,9 +33,7 @@
     :editor-config="editorConfig"
 />
 
-<div
-    v-show="!mailTemplate.extensions.froshMjml || !mailTemplate.extensions.froshMjml.enabled"
->
+<div v-show="!mailTemplate.extensions.froshMjml || !froshMjmlEnabled">
     {% parent() %}
 </div>
 {% endblock %}